Code

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