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