contrib / fast-import / git-p4on commit Avoid creating non-p4 branches in remotes/p4 off of remotes/origin (65c5f3e)
   1#!/usr/bin/env python
   2#
   3# git-p4.py -- A tool for bidirectional operation between a Perforce depot and git.
   4#
   5# Author: Simon Hausmann <hausmann@kde.org>
   6# Copyright: 2007 Simon Hausmann <hausmann@kde.org>
   7#            2007 Trolltech ASA
   8# License: MIT <http://www.opensource.org/licenses/mit-license.php>
   9#
  10# TODO: * Consider making --with-origin the default, assuming that the git
  11#         protocol is always more efficient. (needs manual testing first :)
  12#
  13
  14import optparse, sys, os, marshal, popen2, subprocess, shelve
  15import tempfile, getopt, sha, os.path, time, platform
  16from sets import Set;
  17
  18gitdir = os.environ.get("GIT_DIR", "")
  19
  20def mypopen(command):
  21    return os.popen(command, "rb");
  22
  23def p4CmdList(cmd):
  24    cmd = "p4 -G %s" % cmd
  25    pipe = os.popen(cmd, "rb")
  26
  27    result = []
  28    try:
  29        while True:
  30            entry = marshal.load(pipe)
  31            result.append(entry)
  32    except EOFError:
  33        pass
  34    exitCode = pipe.close()
  35    if exitCode != None:
  36        entry = {}
  37        entry["p4ExitCode"] = exitCode
  38        result.append(entry)
  39
  40    return result
  41
  42def p4Cmd(cmd):
  43    list = p4CmdList(cmd)
  44    result = {}
  45    for entry in list:
  46        result.update(entry)
  47    return result;
  48
  49def p4Where(depotPath):
  50    if not depotPath.endswith("/"):
  51        depotPath += "/"
  52    output = p4Cmd("where %s..." % depotPath)
  53    if output["code"] == "error":
  54        return ""
  55    clientPath = ""
  56    if "path" in output:
  57        clientPath = output.get("path")
  58    elif "data" in output:
  59        data = output.get("data")
  60        lastSpace = data.rfind(" ")
  61        clientPath = data[lastSpace + 1:]
  62
  63    if clientPath.endswith("..."):
  64        clientPath = clientPath[:-3]
  65    return clientPath
  66
  67def die(msg):
  68    sys.stderr.write(msg + "\n")
  69    sys.exit(1)
  70
  71def currentGitBranch():
  72    return mypopen("git name-rev HEAD").read().split(" ")[1][:-1]
  73
  74def isValidGitDir(path):
  75    if os.path.exists(path + "/HEAD") and os.path.exists(path + "/refs") and os.path.exists(path + "/objects"):
  76        return True;
  77    return False
  78
  79def parseRevision(ref):
  80    return mypopen("git rev-parse %s" % ref).read()[:-1]
  81
  82def system(cmd):
  83    if os.system(cmd) != 0:
  84        die("command failed: %s" % cmd)
  85
  86def extractLogMessageFromGitCommit(commit):
  87    logMessage = ""
  88    foundTitle = False
  89    for log in mypopen("git cat-file commit %s" % commit).readlines():
  90       if not foundTitle:
  91           if len(log) == 1:
  92               foundTitle = True
  93           continue
  94
  95       logMessage += log
  96    return logMessage
  97
  98def extractDepotPathAndChangeFromGitLog(log):
  99    values = {}
 100    for line in log.split("\n"):
 101        line = line.strip()
 102        if line.startswith("[git-p4:") and line.endswith("]"):
 103            line = line[8:-1].strip()
 104            for assignment in line.split(":"):
 105                variable = assignment.strip()
 106                value = ""
 107                equalPos = assignment.find("=")
 108                if equalPos != -1:
 109                    variable = assignment[:equalPos].strip()
 110                    value = assignment[equalPos + 1:].strip()
 111                    if value.startswith("\"") and value.endswith("\""):
 112                        value = value[1:-1]
 113                values[variable] = value
 114
 115    return values.get("depot-path"), values.get("change")
 116
 117def gitBranchExists(branch):
 118    proc = subprocess.Popen(["git", "rev-parse", branch], stderr=subprocess.PIPE, stdout=subprocess.PIPE);
 119    return proc.wait() == 0;
 120
 121class Command:
 122    def __init__(self):
 123        self.usage = "usage: %prog [options]"
 124        self.needsGit = True
 125
 126class P4Debug(Command):
 127    def __init__(self):
 128        Command.__init__(self)
 129        self.options = [
 130        ]
 131        self.description = "A tool to debug the output of p4 -G."
 132        self.needsGit = False
 133
 134    def run(self, args):
 135        for output in p4CmdList(" ".join(args)):
 136            print output
 137        return True
 138
 139class P4RollBack(Command):
 140    def __init__(self):
 141        Command.__init__(self)
 142        self.options = [
 143            optparse.make_option("--verbose", dest="verbose", action="store_true"),
 144            optparse.make_option("--local", dest="rollbackLocalBranches", action="store_true")
 145        ]
 146        self.description = "A tool to debug the multi-branch import. Don't use :)"
 147        self.verbose = False
 148        self.rollbackLocalBranches = False
 149
 150    def run(self, args):
 151        if len(args) != 1:
 152            return False
 153        maxChange = int(args[0])
 154
 155        if "p4ExitCode" in p4Cmd("changes -m 1"):
 156            die("Problems executing p4");
 157
 158        if self.rollbackLocalBranches:
 159            refPrefix = "refs/heads/"
 160            lines = mypopen("git rev-parse --symbolic --branches").readlines()
 161        else:
 162            refPrefix = "refs/remotes/"
 163            lines = mypopen("git rev-parse --symbolic --remotes").readlines()
 164
 165        for line in lines:
 166            if self.rollbackLocalBranches or (line.startswith("p4/") and line != "p4/HEAD\n"):
 167                ref = refPrefix + line[:-1]
 168                log = extractLogMessageFromGitCommit(ref)
 169                depotPath, change = extractDepotPathAndChangeFromGitLog(log)
 170                changed = False
 171
 172                if len(p4Cmd("changes -m 1 %s...@%s" % (depotPath, maxChange))) == 0:
 173                    print "Branch %s did not exist at change %s, deleting." % (ref, maxChange)
 174                    system("git update-ref -d %s `git rev-parse %s`" % (ref, ref))
 175                    continue
 176
 177                while len(change) > 0 and int(change) > maxChange:
 178                    changed = True
 179                    if self.verbose:
 180                        print "%s is at %s ; rewinding towards %s" % (ref, change, maxChange)
 181                    system("git update-ref %s \"%s^\"" % (ref, ref))
 182                    log = extractLogMessageFromGitCommit(ref)
 183                    depotPath, change = extractDepotPathAndChangeFromGitLog(log)
 184
 185                if changed:
 186                    print "%s rewound to %s" % (ref, change)
 187
 188        return True
 189
 190class P4Submit(Command):
 191    def __init__(self):
 192        Command.__init__(self)
 193        self.options = [
 194                optparse.make_option("--continue", action="store_false", dest="firstTime"),
 195                optparse.make_option("--origin", dest="origin"),
 196                optparse.make_option("--reset", action="store_true", dest="reset"),
 197                optparse.make_option("--log-substitutions", dest="substFile"),
 198                optparse.make_option("--noninteractive", action="store_false"),
 199                optparse.make_option("--dry-run", action="store_true"),
 200                optparse.make_option("--direct", dest="directSubmit", action="store_true"),
 201        ]
 202        self.description = "Submit changes from git to the perforce depot."
 203        self.usage += " [name of git branch to submit into perforce depot]"
 204        self.firstTime = True
 205        self.reset = False
 206        self.interactive = True
 207        self.dryRun = False
 208        self.substFile = ""
 209        self.firstTime = True
 210        self.origin = ""
 211        self.directSubmit = False
 212
 213        self.logSubstitutions = {}
 214        self.logSubstitutions["<enter description here>"] = "%log%"
 215        self.logSubstitutions["\tDetails:"] = "\tDetails:  %log%"
 216
 217    def check(self):
 218        if len(p4CmdList("opened ...")) > 0:
 219            die("You have files opened with perforce! Close them before starting the sync.")
 220
 221    def start(self):
 222        if len(self.config) > 0 and not self.reset:
 223            die("Cannot start sync. Previous sync config found at %s\nIf you want to start submitting again from scratch maybe you want to call git-p4 submit --reset" % self.configFile)
 224
 225        commits = []
 226        if self.directSubmit:
 227            commits.append("0")
 228        else:
 229            for line in mypopen("git rev-list --no-merges %s..%s" % (self.origin, self.master)).readlines():
 230                commits.append(line[:-1])
 231            commits.reverse()
 232
 233        self.config["commits"] = commits
 234
 235    def prepareLogMessage(self, template, message):
 236        result = ""
 237
 238        for line in template.split("\n"):
 239            if line.startswith("#"):
 240                result += line + "\n"
 241                continue
 242
 243            substituted = False
 244            for key in self.logSubstitutions.keys():
 245                if line.find(key) != -1:
 246                    value = self.logSubstitutions[key]
 247                    value = value.replace("%log%", message)
 248                    if value != "@remove@":
 249                        result += line.replace(key, value) + "\n"
 250                    substituted = True
 251                    break
 252
 253            if not substituted:
 254                result += line + "\n"
 255
 256        return result
 257
 258    def apply(self, id):
 259        if self.directSubmit:
 260            print "Applying local change in working directory/index"
 261            diff = self.diffStatus
 262        else:
 263            print "Applying %s" % (mypopen("git log --max-count=1 --pretty=oneline %s" % id).read())
 264            diff = mypopen("git diff-tree -r --name-status \"%s^\" \"%s\"" % (id, id)).readlines()
 265        filesToAdd = set()
 266        filesToDelete = set()
 267        editedFiles = set()
 268        for line in diff:
 269            modifier = line[0]
 270            path = line[1:].strip()
 271            if modifier == "M":
 272                system("p4 edit \"%s\"" % path)
 273                editedFiles.add(path)
 274            elif modifier == "A":
 275                filesToAdd.add(path)
 276                if path in filesToDelete:
 277                    filesToDelete.remove(path)
 278            elif modifier == "D":
 279                filesToDelete.add(path)
 280                if path in filesToAdd:
 281                    filesToAdd.remove(path)
 282            else:
 283                die("unknown modifier %s for %s" % (modifier, path))
 284
 285        if self.directSubmit:
 286            diffcmd = "cat \"%s\"" % self.diffFile
 287        else:
 288            diffcmd = "git format-patch -k --stdout \"%s^\"..\"%s\"" % (id, id)
 289        patchcmd = diffcmd + " | git apply "
 290        tryPatchCmd = patchcmd + "--check -"
 291        applyPatchCmd = patchcmd + "--check --apply -"
 292
 293        if os.system(tryPatchCmd) != 0:
 294            print "Unfortunately applying the change failed!"
 295            print "What do you want to do?"
 296            response = "x"
 297            while response != "s" and response != "a" and response != "w":
 298                response = raw_input("[s]kip this patch / [a]pply the patch forcibly and with .rej files / [w]rite the patch to a file (patch.txt) ")
 299            if response == "s":
 300                print "Skipping! Good luck with the next patches..."
 301                return
 302            elif response == "a":
 303                os.system(applyPatchCmd)
 304                if len(filesToAdd) > 0:
 305                    print "You may also want to call p4 add on the following files:"
 306                    print " ".join(filesToAdd)
 307                if len(filesToDelete):
 308                    print "The following files should be scheduled for deletion with p4 delete:"
 309                    print " ".join(filesToDelete)
 310                die("Please resolve and submit the conflict manually and continue afterwards with git-p4 submit --continue")
 311            elif response == "w":
 312                system(diffcmd + " > patch.txt")
 313                print "Patch saved to patch.txt in %s !" % self.clientPath
 314                die("Please resolve and submit the conflict manually and continue afterwards with git-p4 submit --continue")
 315
 316        system(applyPatchCmd)
 317
 318        for f in filesToAdd:
 319            system("p4 add %s" % f)
 320        for f in filesToDelete:
 321            system("p4 revert %s" % f)
 322            system("p4 delete %s" % f)
 323
 324        logMessage = ""
 325        if not self.directSubmit:
 326            logMessage = extractLogMessageFromGitCommit(id)
 327            logMessage = logMessage.replace("\n", "\n\t")
 328            logMessage = logMessage[:-1]
 329
 330        template = mypopen("p4 change -o").read()
 331
 332        if self.interactive:
 333            submitTemplate = self.prepareLogMessage(template, logMessage)
 334            diff = mypopen("p4 diff -du ...").read()
 335
 336            for newFile in filesToAdd:
 337                diff += "==== new file ====\n"
 338                diff += "--- /dev/null\n"
 339                diff += "+++ %s\n" % newFile
 340                f = open(newFile, "r")
 341                for line in f.readlines():
 342                    diff += "+" + line
 343                f.close()
 344
 345            separatorLine = "######## everything below this line is just the diff #######"
 346            if platform.system() == "Windows":
 347                separatorLine += "\r"
 348            separatorLine += "\n"
 349
 350            response = "e"
 351            firstIteration = True
 352            while response == "e":
 353                if not firstIteration:
 354                    response = raw_input("Do you want to submit this change? [y]es/[e]dit/[n]o/[s]kip ")
 355                firstIteration = False
 356                if response == "e":
 357                    [handle, fileName] = tempfile.mkstemp()
 358                    tmpFile = os.fdopen(handle, "w+")
 359                    tmpFile.write(submitTemplate + separatorLine + diff)
 360                    tmpFile.close()
 361                    defaultEditor = "vi"
 362                    if platform.system() == "Windows":
 363                        defaultEditor = "notepad"
 364                    editor = os.environ.get("EDITOR", defaultEditor);
 365                    system(editor + " " + fileName)
 366                    tmpFile = open(fileName, "rb")
 367                    message = tmpFile.read()
 368                    tmpFile.close()
 369                    os.remove(fileName)
 370                    submitTemplate = message[:message.index(separatorLine)]
 371
 372            if response == "y" or response == "yes":
 373               if self.dryRun:
 374                   print submitTemplate
 375                   raw_input("Press return to continue...")
 376               else:
 377                   if self.directSubmit:
 378                       print "Submitting to git first"
 379                       os.chdir(self.oldWorkingDirectory)
 380                       pipe = os.popen("git commit -a -F -", "wb")
 381                       pipe.write(submitTemplate)
 382                       pipe.close()
 383                       os.chdir(self.clientPath)
 384
 385                   pipe = os.popen("p4 submit -i", "wb")
 386                   pipe.write(submitTemplate)
 387                   pipe.close()
 388            elif response == "s":
 389                for f in editedFiles:
 390                    system("p4 revert \"%s\"" % f);
 391                for f in filesToAdd:
 392                    system("p4 revert \"%s\"" % f);
 393                    system("rm %s" %f)
 394                for f in filesToDelete:
 395                    system("p4 delete \"%s\"" % f);
 396                return
 397            else:
 398                print "Not submitting!"
 399                self.interactive = False
 400        else:
 401            fileName = "submit.txt"
 402            file = open(fileName, "w+")
 403            file.write(self.prepareLogMessage(template, logMessage))
 404            file.close()
 405            print "Perforce submit template written as %s. Please review/edit and then use p4 submit -i < %s to submit directly!" % (fileName, fileName)
 406
 407    def run(self, args):
 408        global gitdir
 409        # make gitdir absolute so we can cd out into the perforce checkout
 410        gitdir = os.path.abspath(gitdir)
 411        os.environ["GIT_DIR"] = gitdir
 412
 413        if len(args) == 0:
 414            self.master = currentGitBranch()
 415            if len(self.master) == 0 or not os.path.exists("%s/refs/heads/%s" % (gitdir, self.master)):
 416                die("Detecting current git branch failed!")
 417        elif len(args) == 1:
 418            self.master = args[0]
 419        else:
 420            return False
 421
 422        depotPath = ""
 423        if gitBranchExists("p4"):
 424            [depotPath, dummy] = extractDepotPathAndChangeFromGitLog(extractLogMessageFromGitCommit("p4"))
 425        if len(depotPath) == 0 and gitBranchExists("origin"):
 426            [depotPath, dummy] = extractDepotPathAndChangeFromGitLog(extractLogMessageFromGitCommit("origin"))
 427
 428        if len(depotPath) == 0:
 429            print "Internal error: cannot locate perforce depot path from existing branches"
 430            sys.exit(128)
 431
 432        self.clientPath = p4Where(depotPath)
 433
 434        if len(self.clientPath) == 0:
 435            print "Error: Cannot locate perforce checkout of %s in client view" % depotPath
 436            sys.exit(128)
 437
 438        print "Perforce checkout for depot path %s located at %s" % (depotPath, self.clientPath)
 439        self.oldWorkingDirectory = os.getcwd()
 440
 441        if self.directSubmit:
 442            self.diffStatus = mypopen("git diff -r --name-status HEAD").readlines()
 443            if len(self.diffStatus) == 0:
 444                print "No changes in working directory to submit."
 445                return True
 446            patch = mypopen("git diff -p --binary --diff-filter=ACMRTUXB HEAD").read()
 447            self.diffFile = gitdir + "/p4-git-diff"
 448            f = open(self.diffFile, "wb")
 449            f.write(patch)
 450            f.close();
 451
 452        os.chdir(self.clientPath)
 453        response = raw_input("Do you want to sync %s with p4 sync? [y]es/[n]o " % self.clientPath)
 454        if response == "y" or response == "yes":
 455            system("p4 sync ...")
 456
 457        if len(self.origin) == 0:
 458            if gitBranchExists("p4"):
 459                self.origin = "p4"
 460            else:
 461                self.origin = "origin"
 462
 463        if self.reset:
 464            self.firstTime = True
 465
 466        if len(self.substFile) > 0:
 467            for line in open(self.substFile, "r").readlines():
 468                tokens = line[:-1].split("=")
 469                self.logSubstitutions[tokens[0]] = tokens[1]
 470
 471        self.check()
 472        self.configFile = gitdir + "/p4-git-sync.cfg"
 473        self.config = shelve.open(self.configFile, writeback=True)
 474
 475        if self.firstTime:
 476            self.start()
 477
 478        commits = self.config.get("commits", [])
 479
 480        while len(commits) > 0:
 481            self.firstTime = False
 482            commit = commits[0]
 483            commits = commits[1:]
 484            self.config["commits"] = commits
 485            self.apply(commit)
 486            if not self.interactive:
 487                break
 488
 489        self.config.close()
 490
 491        if self.directSubmit:
 492            os.remove(self.diffFile)
 493
 494        if len(commits) == 0:
 495            if self.firstTime:
 496                print "No changes found to apply between %s and current HEAD" % self.origin
 497            else:
 498                print "All changes applied!"
 499                os.chdir(self.oldWorkingDirectory)
 500                response = raw_input("Do you want to sync from Perforce now using git-p4 rebase? [y]es/[n]o ")
 501                if response == "y" or response == "yes":
 502                    rebase = P4Rebase()
 503                    rebase.run([])
 504            os.remove(self.configFile)
 505
 506        return True
 507
 508class P4Sync(Command):
 509    def __init__(self):
 510        Command.__init__(self)
 511        self.options = [
 512                optparse.make_option("--branch", dest="branch"),
 513                optparse.make_option("--detect-branches", dest="detectBranches", action="store_true"),
 514                optparse.make_option("--changesfile", dest="changesFile"),
 515                optparse.make_option("--silent", dest="silent", action="store_true"),
 516                optparse.make_option("--detect-labels", dest="detectLabels", action="store_true"),
 517                optparse.make_option("--with-origin", dest="syncWithOrigin", action="store_true"),
 518                optparse.make_option("--verbose", dest="verbose", action="store_true"),
 519                optparse.make_option("--import-local", dest="importIntoRemotes", action="store_false"),
 520                optparse.make_option("--max-changes", dest="maxChanges")
 521        ]
 522        self.description = """Imports from Perforce into a git repository.\n
 523    example:
 524    //depot/my/project/ -- to import the current head
 525    //depot/my/project/@all -- to import everything
 526    //depot/my/project/@1,6 -- to import only from revision 1 to 6
 527
 528    (a ... is not needed in the path p4 specification, it's added implicitly)"""
 529
 530        self.usage += " //depot/path[@revRange]"
 531
 532        self.silent = False
 533        self.createdBranches = Set()
 534        self.committedChanges = Set()
 535        self.branch = ""
 536        self.detectBranches = False
 537        self.detectLabels = False
 538        self.changesFile = ""
 539        self.syncWithOrigin = False
 540        self.verbose = False
 541        self.importIntoRemotes = True
 542        self.maxChanges = ""
 543        self.isWindows = (platform.system() == "Windows")
 544
 545    def p4File(self, depotPath):
 546        return os.popen("p4 print -q \"%s\"" % depotPath, "rb").read()
 547
 548    def extractFilesFromCommit(self, commit):
 549        files = []
 550        fnum = 0
 551        while commit.has_key("depotFile%s" % fnum):
 552            path =  commit["depotFile%s" % fnum]
 553            if not path.startswith(self.depotPath):
 554    #            if not self.silent:
 555    #                print "\nchanged files: ignoring path %s outside of %s in change %s" % (path, self.depotPath, change)
 556                fnum = fnum + 1
 557                continue
 558
 559            file = {}
 560            file["path"] = path
 561            file["rev"] = commit["rev%s" % fnum]
 562            file["action"] = commit["action%s" % fnum]
 563            file["type"] = commit["type%s" % fnum]
 564            files.append(file)
 565            fnum = fnum + 1
 566        return files
 567
 568    def splitFilesIntoBranches(self, commit):
 569        branches = {}
 570
 571        fnum = 0
 572        while commit.has_key("depotFile%s" % fnum):
 573            path =  commit["depotFile%s" % fnum]
 574            if not path.startswith(self.depotPath):
 575    #            if not self.silent:
 576    #                print "\nchanged files: ignoring path %s outside of %s in change %s" % (path, self.depotPath, change)
 577                fnum = fnum + 1
 578                continue
 579
 580            file = {}
 581            file["path"] = path
 582            file["rev"] = commit["rev%s" % fnum]
 583            file["action"] = commit["action%s" % fnum]
 584            file["type"] = commit["type%s" % fnum]
 585            fnum = fnum + 1
 586
 587            relPath = path[len(self.depotPath):]
 588
 589            for branch in self.knownBranches.keys():
 590                if relPath.startswith(branch + "/"): # add a trailing slash so that a commit into qt/4.2foo doesn't end up in qt/4.2
 591                    if branch not in branches:
 592                        branches[branch] = []
 593                    branches[branch].append(file)
 594
 595        return branches
 596
 597    def commit(self, details, files, branch, branchPrefix, parent = ""):
 598        epoch = details["time"]
 599        author = details["user"]
 600
 601        if self.verbose:
 602            print "commit into %s" % branch
 603
 604        self.gitStream.write("commit %s\n" % branch)
 605    #    gitStream.write("mark :%s\n" % details["change"])
 606        self.committedChanges.add(int(details["change"]))
 607        committer = ""
 608        if author not in self.users:
 609            self.getUserMapFromPerforceServer()
 610        if author in self.users:
 611            committer = "%s %s %s" % (self.users[author], epoch, self.tz)
 612        else:
 613            committer = "%s <a@b> %s %s" % (author, epoch, self.tz)
 614
 615        self.gitStream.write("committer %s\n" % committer)
 616
 617        self.gitStream.write("data <<EOT\n")
 618        self.gitStream.write(details["desc"])
 619        self.gitStream.write("\n[git-p4: depot-path = \"%s\": change = %s]\n" % (branchPrefix, details["change"]))
 620        self.gitStream.write("EOT\n\n")
 621
 622        if len(parent) > 0:
 623            if self.verbose:
 624                print "parent %s" % parent
 625            self.gitStream.write("from %s\n" % parent)
 626
 627        for file in files:
 628            path = file["path"]
 629            if not path.startswith(branchPrefix):
 630    #            if not silent:
 631    #                print "\nchanged files: ignoring path %s outside of branch prefix %s in change %s" % (path, branchPrefix, details["change"])
 632                continue
 633            rev = file["rev"]
 634            depotPath = path + "#" + rev
 635            relPath = path[len(branchPrefix):]
 636            action = file["action"]
 637
 638            if file["type"] == "apple":
 639                print "\nfile %s is a strange apple file that forks. Ignoring!" % path
 640                continue
 641
 642            if action == "delete":
 643                self.gitStream.write("D %s\n" % relPath)
 644            else:
 645                mode = 644
 646                if file["type"].startswith("x"):
 647                    mode = 755
 648
 649                data = self.p4File(depotPath)
 650
 651                if self.isWindows and file["type"].endswith("text"):
 652                    data = data.replace("\r\n", "\n")
 653
 654                self.gitStream.write("M %s inline %s\n" % (mode, relPath))
 655                self.gitStream.write("data %s\n" % len(data))
 656                self.gitStream.write(data)
 657                self.gitStream.write("\n")
 658
 659        self.gitStream.write("\n")
 660
 661        change = int(details["change"])
 662
 663        if self.labels.has_key(change):
 664            label = self.labels[change]
 665            labelDetails = label[0]
 666            labelRevisions = label[1]
 667            if self.verbose:
 668                print "Change %s is labelled %s" % (change, labelDetails)
 669
 670            files = p4CmdList("files %s...@%s" % (branchPrefix, change))
 671
 672            if len(files) == len(labelRevisions):
 673
 674                cleanedFiles = {}
 675                for info in files:
 676                    if info["action"] == "delete":
 677                        continue
 678                    cleanedFiles[info["depotFile"]] = info["rev"]
 679
 680                if cleanedFiles == labelRevisions:
 681                    self.gitStream.write("tag tag_%s\n" % labelDetails["label"])
 682                    self.gitStream.write("from %s\n" % branch)
 683
 684                    owner = labelDetails["Owner"]
 685                    tagger = ""
 686                    if author in self.users:
 687                        tagger = "%s %s %s" % (self.users[owner], epoch, self.tz)
 688                    else:
 689                        tagger = "%s <a@b> %s %s" % (owner, epoch, self.tz)
 690                    self.gitStream.write("tagger %s\n" % tagger)
 691                    self.gitStream.write("data <<EOT\n")
 692                    self.gitStream.write(labelDetails["Description"])
 693                    self.gitStream.write("EOT\n\n")
 694
 695                else:
 696                    if not self.silent:
 697                        print "Tag %s does not match with change %s: files do not match." % (labelDetails["label"], change)
 698
 699            else:
 700                if not self.silent:
 701                    print "Tag %s does not match with change %s: file count is different." % (labelDetails["label"], change)
 702
 703    def getUserMapFromPerforceServer(self):
 704        if self.userMapFromPerforceServer:
 705            return
 706        self.users = {}
 707
 708        for output in p4CmdList("users"):
 709            if not output.has_key("User"):
 710                continue
 711            self.users[output["User"]] = output["FullName"] + " <" + output["Email"] + ">"
 712
 713        cache = open(gitdir + "/p4-usercache.txt", "wb")
 714        for user in self.users.keys():
 715            cache.write("%s\t%s\n" % (user, self.users[user]))
 716        cache.close();
 717        self.userMapFromPerforceServer = True
 718
 719    def loadUserMapFromCache(self):
 720        self.users = {}
 721        self.userMapFromPerforceServer = False
 722        try:
 723            cache = open(gitdir + "/p4-usercache.txt", "rb")
 724            lines = cache.readlines()
 725            cache.close()
 726            for line in lines:
 727                entry = line[:-1].split("\t")
 728                self.users[entry[0]] = entry[1]
 729        except IOError:
 730            self.getUserMapFromPerforceServer()
 731
 732    def getLabels(self):
 733        self.labels = {}
 734
 735        l = p4CmdList("labels %s..." % self.depotPath)
 736        if len(l) > 0 and not self.silent:
 737            print "Finding files belonging to labels in %s" % self.depotPath
 738
 739        for output in l:
 740            label = output["label"]
 741            revisions = {}
 742            newestChange = 0
 743            if self.verbose:
 744                print "Querying files for label %s" % label
 745            for file in p4CmdList("files %s...@%s" % (self.depotPath, label)):
 746                revisions[file["depotFile"]] = file["rev"]
 747                change = int(file["change"])
 748                if change > newestChange:
 749                    newestChange = change
 750
 751            self.labels[newestChange] = [output, revisions]
 752
 753        if self.verbose:
 754            print "Label changes: %s" % self.labels.keys()
 755
 756    def getBranchMapping(self):
 757        self.projectName = self.depotPath[self.depotPath[:-1].rfind("/") + 1:]
 758
 759        for info in p4CmdList("branches"):
 760            details = p4Cmd("branch -o %s" % info["branch"])
 761            viewIdx = 0
 762            while details.has_key("View%s" % viewIdx):
 763                paths = details["View%s" % viewIdx].split(" ")
 764                viewIdx = viewIdx + 1
 765                # require standard //depot/foo/... //depot/bar/... mapping
 766                if len(paths) != 2 or not paths[0].endswith("/...") or not paths[1].endswith("/..."):
 767                    continue
 768                source = paths[0]
 769                destination = paths[1]
 770                if source.startswith(self.depotPath) and destination.startswith(self.depotPath):
 771                    source = source[len(self.depotPath):-4]
 772                    destination = destination[len(self.depotPath):-4]
 773                    if destination not in self.knownBranches:
 774                        self.knownBranches[destination] = source
 775                    if source not in self.knownBranches:
 776                        self.knownBranches[source] = source
 777
 778    def listExistingP4GitBranches(self):
 779        self.p4BranchesInGit = []
 780
 781        cmdline = "git rev-parse --symbolic "
 782        if self.importIntoRemotes:
 783            cmdline += " --remotes"
 784        else:
 785            cmdline += " --branches"
 786
 787        for line in mypopen(cmdline).readlines():
 788            if self.importIntoRemotes and ((not line.startswith("p4/")) or line == "p4/HEAD\n"):
 789                continue
 790            if self.importIntoRemotes:
 791                # strip off p4
 792                branch = line[3:-1]
 793            else:
 794                branch = line[:-1]
 795            self.p4BranchesInGit.append(branch)
 796            self.initialParents[self.refPrefix + branch] = parseRevision(line[:-1])
 797
 798    def createOrUpdateBranchesFromOrigin(self):
 799        if not self.silent:
 800            print "Creating/updating branch(es) in %s based on origin branch(es)" % self.refPrefix
 801
 802        for line in mypopen("git rev-parse --symbolic --remotes"):
 803            if (not line.startswith("origin/")) or line.endswith("HEAD\n"):
 804                continue
 805
 806            headName = line[len("origin/"):-1]
 807            remoteHead = self.refPrefix + headName
 808            originHead = "origin/" + headName
 809
 810            [originPreviousDepotPath, originP4Change] = extractDepotPathAndChangeFromGitLog(extractLogMessageFromGitCommit(originHead))
 811            if len(originPreviousDepotPath) == 0 or len(originP4Change) == 0:
 812                continue
 813
 814            update = False
 815            if not os.path.exists(gitdir + "/" + remoteHead):
 816                if self.verbose:
 817                    print "creating %s" % remoteHead
 818                update = True
 819            else:
 820                [p4PreviousDepotPath, p4Change] = extractDepotPathAndChangeFromGitLog(extractLogMessageFromGitCommit(remoteHead))
 821                if len(p4Change) > 0:
 822                    if originPreviousDepotPath == p4PreviousDepotPath:
 823                        originP4Change = int(originP4Change)
 824                        p4Change = int(p4Change)
 825                        if originP4Change > p4Change:
 826                            print "%s (%s) is newer than %s (%s). Updating p4 branch from origin." % (originHead, originP4Change, remoteHead, p4Change)
 827                            update = True
 828                    else:
 829                        print "Ignoring: %s was imported from %s while %s was imported from %s" % (originHead, originPreviousDepotPath, remoteHead, p4PreviousDepotPath)
 830
 831            if update:
 832                system("git update-ref %s %s" % (remoteHead, originHead))
 833
 834    def run(self, args):
 835        self.depotPath = ""
 836        self.changeRange = ""
 837        self.initialParent = ""
 838        self.previousDepotPath = ""
 839        # map from branch depot path to parent branch
 840        self.knownBranches = {}
 841        self.initialParents = {}
 842
 843        if self.importIntoRemotes:
 844            self.refPrefix = "refs/remotes/p4/"
 845        else:
 846            self.refPrefix = "refs/heads/"
 847
 848        if self.syncWithOrigin:
 849            print "Syncing with origin first as requested by calling git fetch origin"
 850            system("git fetch origin")
 851
 852        createP4HeadRef = False;
 853
 854        if len(self.branch) == 0:
 855            self.branch = self.refPrefix + "master"
 856            if gitBranchExists("refs/heads/p4") and self.importIntoRemotes:
 857                system("git update-ref %s refs/heads/p4" % self.branch)
 858                system("git branch -D p4");
 859            # create it /after/ importing, when master exists
 860            if not gitBranchExists(self.refPrefix + "HEAD") and self.importIntoRemotes:
 861                createP4HeadRef = True
 862
 863        if len(args) == 0:
 864            self.createOrUpdateBranchesFromOrigin()
 865            self.listExistingP4GitBranches()
 866
 867            if len(self.p4BranchesInGit) > 1:
 868                if not self.silent:
 869                    print "Importing from/into multiple branches"
 870                self.detectBranches = True
 871
 872            if self.verbose:
 873                print "branches: %s" % self.p4BranchesInGit
 874
 875            p4Change = 0
 876            for branch in self.p4BranchesInGit:
 877                depotPath, change = extractDepotPathAndChangeFromGitLog(extractLogMessageFromGitCommit(self.refPrefix + branch))
 878
 879                if self.verbose:
 880                    print "path %s change %s" % (depotPath, change)
 881
 882                if len(depotPath) > 0 and len(change) > 0:
 883                    change = int(change) + 1
 884                    p4Change = max(p4Change, change)
 885
 886                    if len(self.previousDepotPath) == 0:
 887                        self.previousDepotPath = depotPath
 888                    else:
 889                        i = 0
 890                        l = min(len(self.previousDepotPath), len(depotPath))
 891                        while i < l and self.previousDepotPath[i] == depotPath[i]:
 892                            i = i + 1
 893                        self.previousDepotPath = self.previousDepotPath[:i]
 894
 895            if p4Change > 0:
 896                self.depotPath = self.previousDepotPath
 897                self.changeRange = "@%s,#head" % p4Change
 898                self.initialParent = parseRevision(self.branch)
 899                if not self.silent and not self.detectBranches:
 900                    print "Performing incremental import into %s git branch" % self.branch
 901
 902        if not self.branch.startswith("refs/"):
 903            self.branch = "refs/heads/" + self.branch
 904
 905        if len(self.depotPath) != 0:
 906            self.depotPath = self.depotPath[:-1]
 907
 908        if len(args) == 0 and len(self.depotPath) != 0:
 909            if not self.silent:
 910                print "Depot path: %s" % self.depotPath
 911        elif len(args) != 1:
 912            return False
 913        else:
 914            if len(self.depotPath) != 0 and self.depotPath != args[0]:
 915                print "previous import used depot path %s and now %s was specified. this doesn't work!" % (self.depotPath, args[0])
 916                sys.exit(1)
 917            self.depotPath = args[0]
 918
 919        self.revision = ""
 920        self.users = {}
 921
 922        if self.depotPath.find("@") != -1:
 923            atIdx = self.depotPath.index("@")
 924            self.changeRange = self.depotPath[atIdx:]
 925            if self.changeRange == "@all":
 926                self.changeRange = ""
 927            elif self.changeRange.find(",") == -1:
 928                self.revision = self.changeRange
 929                self.changeRange = ""
 930            self.depotPath = self.depotPath[0:atIdx]
 931        elif self.depotPath.find("#") != -1:
 932            hashIdx = self.depotPath.index("#")
 933            self.revision = self.depotPath[hashIdx:]
 934            self.depotPath = self.depotPath[0:hashIdx]
 935        elif len(self.previousDepotPath) == 0:
 936            self.revision = "#head"
 937
 938        if self.depotPath.endswith("..."):
 939            self.depotPath = self.depotPath[:-3]
 940
 941        if not self.depotPath.endswith("/"):
 942            self.depotPath += "/"
 943
 944        self.loadUserMapFromCache()
 945        self.labels = {}
 946        if self.detectLabels:
 947            self.getLabels();
 948
 949        if self.detectBranches:
 950            self.getBranchMapping();
 951            if self.verbose:
 952                print "p4-git branches: %s" % self.p4BranchesInGit
 953                print "initial parents: %s" % self.initialParents
 954            for b in self.p4BranchesInGit:
 955                if b != "master":
 956                    b = b[len(self.projectName):]
 957                self.createdBranches.add(b)
 958
 959        self.tz = "%+03d%02d" % (- time.timezone / 3600, ((- time.timezone % 3600) / 60))
 960
 961        importProcess = subprocess.Popen(["git", "fast-import"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE);
 962        self.gitOutput = importProcess.stdout
 963        self.gitStream = importProcess.stdin
 964        self.gitError = importProcess.stderr
 965
 966        if len(self.revision) > 0:
 967            print "Doing initial import of %s from revision %s" % (self.depotPath, self.revision)
 968
 969            details = { "user" : "git perforce import user", "time" : int(time.time()) }
 970            details["desc"] = "Initial import of %s from the state at revision %s" % (self.depotPath, self.revision)
 971            details["change"] = self.revision
 972            newestRevision = 0
 973
 974            fileCnt = 0
 975            for info in p4CmdList("files %s...%s" % (self.depotPath, self.revision)):
 976                change = int(info["change"])
 977                if change > newestRevision:
 978                    newestRevision = change
 979
 980                if info["action"] == "delete":
 981                    # don't increase the file cnt, otherwise details["depotFile123"] will have gaps!
 982                    #fileCnt = fileCnt + 1
 983                    continue
 984
 985                for prop in [ "depotFile", "rev", "action", "type" ]:
 986                    details["%s%s" % (prop, fileCnt)] = info[prop]
 987
 988                fileCnt = fileCnt + 1
 989
 990            details["change"] = newestRevision
 991
 992            try:
 993                self.commit(details, self.extractFilesFromCommit(details), self.branch, self.depotPath)
 994            except IOError:
 995                print "IO error with git fast-import. Is your git version recent enough?"
 996                print self.gitError.read()
 997
 998        else:
 999            changes = []
1000
1001            if len(self.changesFile) > 0:
1002                output = open(self.changesFile).readlines()
1003                changeSet = Set()
1004                for line in output:
1005                    changeSet.add(int(line))
1006
1007                for change in changeSet:
1008                    changes.append(change)
1009
1010                changes.sort()
1011            else:
1012                if self.verbose:
1013                    print "Getting p4 changes for %s...%s" % (self.depotPath, self.changeRange)
1014                output = mypopen("p4 changes %s...%s" % (self.depotPath, self.changeRange)).readlines()
1015
1016                for line in output:
1017                    changeNum = line.split(" ")[1]
1018                    changes.append(changeNum)
1019
1020                changes.reverse()
1021
1022                if len(self.maxChanges) > 0:
1023                    changes = changes[0:min(int(self.maxChanges), len(changes))]
1024
1025            if len(changes) == 0:
1026                if not self.silent:
1027                    print "No changes to import!"
1028                return True
1029
1030            self.updatedBranches = set()
1031
1032            cnt = 1
1033            for change in changes:
1034                description = p4Cmd("describe %s" % change)
1035
1036                if not self.silent:
1037                    sys.stdout.write("\rImporting revision %s (%s%%)" % (change, cnt * 100 / len(changes)))
1038                    sys.stdout.flush()
1039                cnt = cnt + 1
1040
1041                try:
1042                    if self.detectBranches:
1043                        branches = self.splitFilesIntoBranches(description)
1044                        for branch in branches.keys():
1045                            branchPrefix = self.depotPath + branch + "/"
1046
1047                            parent = ""
1048
1049                            filesForCommit = branches[branch]
1050
1051                            if self.verbose:
1052                                print "branch is %s" % branch
1053
1054                            self.updatedBranches.add(branch)
1055
1056                            if branch not in self.createdBranches:
1057                                self.createdBranches.add(branch)
1058                                parent = self.knownBranches[branch]
1059                                if parent == branch:
1060                                    parent = ""
1061                                elif self.verbose:
1062                                    print "parent determined through known branches: %s" % parent
1063
1064                            # main branch? use master
1065                            if branch == "main":
1066                                branch = "master"
1067                            else:
1068                                branch = self.projectName + branch
1069
1070                            if parent == "main":
1071                                parent = "master"
1072                            elif len(parent) > 0:
1073                                parent = self.projectName + parent
1074
1075                            branch = self.refPrefix + branch
1076                            if len(parent) > 0:
1077                                parent = self.refPrefix + parent
1078
1079                            if self.verbose:
1080                                print "looking for initial parent for %s; current parent is %s" % (branch, parent)
1081
1082                            if len(parent) == 0 and branch in self.initialParents:
1083                                parent = self.initialParents[branch]
1084                                del self.initialParents[branch]
1085
1086                            self.commit(description, filesForCommit, branch, branchPrefix, parent)
1087                    else:
1088                        files = self.extractFilesFromCommit(description)
1089                        self.commit(description, files, self.branch, self.depotPath, self.initialParent)
1090                        self.initialParent = ""
1091                except IOError:
1092                    print self.gitError.read()
1093                    sys.exit(1)
1094
1095            if not self.silent:
1096                print ""
1097                if len(self.updatedBranches) > 0:
1098                    sys.stdout.write("Updated branches: ")
1099                    for b in self.updatedBranches:
1100                        sys.stdout.write("%s " % b)
1101                    sys.stdout.write("\n")
1102
1103
1104        self.gitStream.close()
1105        if importProcess.wait() != 0:
1106            die("fast-import failed: %s" % self.gitError.read())
1107        self.gitOutput.close()
1108        self.gitError.close()
1109
1110        if createP4HeadRef:
1111            system("git symbolic-ref %sHEAD %s" % (self.refPrefix, self.branch))
1112
1113        return True
1114
1115class P4Rebase(Command):
1116    def __init__(self):
1117        Command.__init__(self)
1118        self.options = [ optparse.make_option("--with-origin", dest="syncWithOrigin", action="store_true") ]
1119        self.description = "Fetches the latest revision from perforce and rebases the current work (branch) against it"
1120        self.syncWithOrigin = False
1121
1122    def run(self, args):
1123        sync = P4Sync()
1124        sync.syncWithOrigin = self.syncWithOrigin
1125        sync.run([])
1126        print "Rebasing the current branch"
1127        oldHead = mypopen("git rev-parse HEAD").read()[:-1]
1128        system("git rebase p4")
1129        system("git diff-tree --stat --summary -M %s HEAD" % oldHead)
1130        return True
1131
1132class P4Clone(P4Sync):
1133    def __init__(self):
1134        P4Sync.__init__(self)
1135        self.description = "Creates a new git repository and imports from Perforce into it"
1136        self.usage = "usage: %prog [options] //depot/path[@revRange] [directory]"
1137        self.needsGit = False
1138
1139    def run(self, args):
1140        global gitdir
1141
1142        if len(args) < 1:
1143            return False
1144        depotPath = args[0]
1145        dir = ""
1146        if len(args) == 2:
1147            dir = args[1]
1148        elif len(args) > 2:
1149            return False
1150
1151        if not depotPath.startswith("//"):
1152            return False
1153
1154        if len(dir) == 0:
1155            dir = depotPath
1156            atPos = dir.rfind("@")
1157            if atPos != -1:
1158                dir = dir[0:atPos]
1159            hashPos = dir.rfind("#")
1160            if hashPos != -1:
1161                dir = dir[0:hashPos]
1162
1163            if dir.endswith("..."):
1164                dir = dir[:-3]
1165
1166            if dir.endswith("/"):
1167               dir = dir[:-1]
1168
1169            slashPos = dir.rfind("/")
1170            if slashPos != -1:
1171                dir = dir[slashPos + 1:]
1172
1173        print "Importing from %s into %s" % (depotPath, dir)
1174        os.makedirs(dir)
1175        os.chdir(dir)
1176        system("git init")
1177        gitdir = os.getcwd() + "/.git"
1178        if not P4Sync.run(self, [depotPath]):
1179            return False
1180        if self.branch != "master":
1181            if gitBranchExists("refs/remotes/p4/master"):
1182                system("git branch master refs/remotes/p4/master")
1183                system("git checkout -f")
1184            else:
1185                print "Could not detect main branch. No checkout/master branch created."
1186        return True
1187
1188class HelpFormatter(optparse.IndentedHelpFormatter):
1189    def __init__(self):
1190        optparse.IndentedHelpFormatter.__init__(self)
1191
1192    def format_description(self, description):
1193        if description:
1194            return description + "\n"
1195        else:
1196            return ""
1197
1198def printUsage(commands):
1199    print "usage: %s <command> [options]" % sys.argv[0]
1200    print ""
1201    print "valid commands: %s" % ", ".join(commands)
1202    print ""
1203    print "Try %s <command> --help for command specific help." % sys.argv[0]
1204    print ""
1205
1206commands = {
1207    "debug" : P4Debug(),
1208    "submit" : P4Submit(),
1209    "sync" : P4Sync(),
1210    "rebase" : P4Rebase(),
1211    "clone" : P4Clone(),
1212    "rollback" : P4RollBack()
1213}
1214
1215if len(sys.argv[1:]) == 0:
1216    printUsage(commands.keys())
1217    sys.exit(2)
1218
1219cmd = ""
1220cmdName = sys.argv[1]
1221try:
1222    cmd = commands[cmdName]
1223except KeyError:
1224    print "unknown command %s" % cmdName
1225    print ""
1226    printUsage(commands.keys())
1227    sys.exit(2)
1228
1229options = cmd.options
1230cmd.gitdir = gitdir
1231
1232args = sys.argv[2:]
1233
1234if len(options) > 0:
1235    options.append(optparse.make_option("--git-dir", dest="gitdir"))
1236
1237    parser = optparse.OptionParser(cmd.usage.replace("%prog", "%prog " + cmdName),
1238                                   options,
1239                                   description = cmd.description,
1240                                   formatter = HelpFormatter())
1241
1242    (cmd, args) = parser.parse_args(sys.argv[2:], cmd);
1243
1244if cmd.needsGit:
1245    gitdir = cmd.gitdir
1246    if len(gitdir) == 0:
1247        gitdir = ".git"
1248        if not isValidGitDir(gitdir):
1249            gitdir = mypopen("git rev-parse --git-dir").read()[:-1]
1250            if os.path.exists(gitdir):
1251                cdup = mypopen("git rev-parse --show-cdup").read()[:-1];
1252                if len(cdup) > 0:
1253                    os.chdir(cdup);
1254
1255    if not isValidGitDir(gitdir):
1256        if isValidGitDir(gitdir + "/.git"):
1257            gitdir += "/.git"
1258        else:
1259            die("fatal: cannot locate git repository at %s" % gitdir)
1260
1261    os.environ["GIT_DIR"] = gitdir
1262
1263if not cmd.run(args):
1264    parser.print_help()
1265