git-p4

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