Code

cc0b7013dabe75d6b354ff7de9af77fed3847d0f
[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 <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 #
11 import optparse, sys, os, marshal, popen2, subprocess, shelve
12 import tempfile, getopt, sha, os.path, time, platform
13 import re
15 from sets import Set;
17 verbose = False
19 def die(msg):
20     if verbose:
21         raise Exception(msg)
22     else:
23         sys.stderr.write(msg + "\n")
24         sys.exit(1)
26 def write_pipe(c, str):
27     if verbose:
28         sys.stderr.write('Writing pipe: %s\n' % c)
30     pipe = os.popen(c, 'w')
31     val = pipe.write(str)
32     if pipe.close():
33         die('Command failed: %s' % c)
35     return val
37 def read_pipe(c, ignore_error=False):
38     if verbose:
39         sys.stderr.write('Reading pipe: %s\n' % c)
41     pipe = os.popen(c, 'rb')
42     val = pipe.read()
43     if pipe.close() and not ignore_error:
44         die('Command failed: %s' % c)
46     return val
49 def read_pipe_lines(c):
50     if verbose:
51         sys.stderr.write('Reading pipe: %s\n' % c)
52     ## todo: check return status
53     pipe = os.popen(c, 'rb')
54     val = pipe.readlines()
55     if pipe.close():
56         die('Command failed: %s' % c)
58     return val
60 def system(cmd):
61     if verbose:
62         sys.stderr.write("executing %s\n" % cmd)
63     if os.system(cmd) != 0:
64         die("command failed: %s" % cmd)
66 def p4CmdList(cmd):
67     cmd = "p4 -G %s" % cmd
68     if verbose:
69         sys.stderr.write("Opening pipe: %s\n" % cmd)
70     pipe = os.popen(cmd, "rb")
72     result = []
73     try:
74         while True:
75             entry = marshal.load(pipe)
76             result.append(entry)
77     except EOFError:
78         pass
79     exitCode = pipe.close()
80     if exitCode != None:
81         entry = {}
82         entry["p4ExitCode"] = exitCode
83         result.append(entry)
85     return result
87 def p4Cmd(cmd):
88     list = p4CmdList(cmd)
89     result = {}
90     for entry in list:
91         result.update(entry)
92     return result;
94 def p4Where(depotPath):
95     if not depotPath.endswith("/"):
96         depotPath += "/"
97     output = p4Cmd("where %s..." % depotPath)
98     if output["code"] == "error":
99         return ""
100     clientPath = ""
101     if "path" in output:
102         clientPath = output.get("path")
103     elif "data" in output:
104         data = output.get("data")
105         lastSpace = data.rfind(" ")
106         clientPath = data[lastSpace + 1:]
108     if clientPath.endswith("..."):
109         clientPath = clientPath[:-3]
110     return clientPath
112 def currentGitBranch():
113     return read_pipe("git name-rev HEAD").split(" ")[1].strip()
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
121 def parseRevision(ref):
122     return read_pipe("git rev-parse %s" % ref).strip()
124 def extractLogMessageFromGitCommit(commit):
125     logMessage = ""
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
135        logMessage += log
136     return logMessage
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
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]
154             values[key] = val
156     values['depot-paths'] = values.get("depot-paths").split(',')
157     return values
159 def gitBranchExists(branch):
160     proc = subprocess.Popen(["git", "rev-parse", branch],
161                             stderr=subprocess.PIPE, stdout=subprocess.PIPE);
162     return proc.wait() == 0;
164 def gitConfig(key):
165     return read_pipe("git config %s" % key, ignore_error=True).strip()
167 class Command:
168     def __init__(self):
169         self.usage = "usage: %prog [options]"
170         self.needsGit = True
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
181     def run(self, args):
182         for output in p4CmdList(" ".join(args)):
183             print output
184         return True
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
197     def run(self, args):
198         if len(args) != 1:
199             return False
200         maxChange = int(args[0])
202         if "p4ExitCode" in p4Cmd("changes -m 1"):
203             die("Problems executing p4");
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")
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)
219                 depotPaths = settings['depot-paths']
220                 change = settings['change']
222                 changed = False
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
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)
239                     depotPaths = settings['depot-paths']
240                     change = settings['change']
242                 if changed:
243                     print "%s rewound to %s" % (ref, change)
245         return True
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
272         self.logSubstitutions = {}
273         self.logSubstitutions["<enter description here>"] = "%log%"
274         self.logSubstitutions["\tDetails:"] = "\tDetails:  %log%"
276     def check(self):
277         if len(p4CmdList("opened ...")) > 0:
278             die("You have files opened with perforce! Close them before starting the sync.")
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)
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()
294         self.config["commits"] = commits
296     def prepareLogMessage(self, template, message):
297         result = ""
299         for line in template.split("\n"):
300             if line.startswith("#"):
301                 result += line + "\n"
302                 continue
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
314             if not substituted:
315                 result += line + "\n"
317         return result
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))
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 -"
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")
380         system(applyPatchCmd)
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)
388         logMessage = ""
389         if not self.directSubmit:
390             logMessage = extractLogMessageFromGitCommit(id)
391             logMessage = logMessage.replace("\n", "\n\t")
392             logMessage = logMessage.strip()
394         template = read_pipe("p4 change -o")
396         if self.interactive:
397             submitTemplate = self.prepareLogMessage(template, logMessage)
398             diff = read_pipe("p4 diff -du ...")
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()
409             separatorLine = "######## everything below this line is just the diff #######"
410             if platform.system() == "Windows":
411                 separatorLine += "\r"
412             separatorLine += "\n"
414             response = "e"
415             if self.trustMeLikeAFool:
416                 response = "y"
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)]
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)
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))
472     def run(self, args):
473         # make gitdir absolute so we can cd out into the perforce checkout
474         os.environ["GIT_DIR"] = gitdir
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
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']
493         if len(depotPath) == 0:
494             print "Internal error: cannot locate perforce depot path from existing branches"
495             sys.exit(128)
497         self.clientPath = p4Where(depotPath)
499         if len(self.clientPath) == 0:
500             print "Error: Cannot locate perforce checkout of %s in client view" % depotPath
501             sys.exit(128)
503         print "Perforce checkout for depot path %s located at %s" % (depotPath, self.clientPath)
504         self.oldWorkingDirectory = os.getcwd()
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();
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 ...")
522         if len(self.origin) == 0:
523             if gitBranchExists("p4"):
524                 self.origin = "p4"
525             else:
526                 self.origin = "origin"
528         if self.reset:
529             self.firstTime = True
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]
536         self.check()
537         self.configFile = self.gitdir + "/p4-git-sync.cfg"
538         self.config = shelve.open(self.configFile, writeback=True)
540         if self.firstTime:
541             self.start()
543         commits = self.config.get("commits", [])
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
554         self.config.close()
556         if self.directSubmit:
557             os.remove(self.diffFile)
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)
571         return True
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                                      help="Import into refs/heads/ , not refs/remotes"),
585                 optparse.make_option("--max-changes", dest="maxChanges"),
586                 optparse.make_option("--keep-path", dest="keepRepoPath", action='store_true',
587                                      help="Keep entire BRANCH/DIR/SUBDIR prefix during import")
588         ]
589         self.description = """Imports from Perforce into a git repository.\n
590     example:
591     //depot/my/project/ -- to import the current head
592     //depot/my/project/@all -- to import everything
593     //depot/my/project/@1,6 -- to import only from revision 1 to 6
595     (a ... is not needed in the path p4 specification, it's added implicitly)"""
597         self.usage += " //depot/path[@revRange]"
598         self.silent = False
599         self.createdBranches = Set()
600         self.committedChanges = Set()
601         self.branch = ""
602         self.detectBranches = False
603         self.detectLabels = False
604         self.changesFile = ""
605         self.syncWithOrigin = True
606         self.verbose = False
607         self.importIntoRemotes = True
608         self.maxChanges = ""
609         self.isWindows = (platform.system() == "Windows")
610         self.keepRepoPath = False
611         self.depotPaths = None
613         if gitConfig("git-p4.syncFromOrigin") == "false":
614             self.syncWithOrigin = False
616     def extractFilesFromCommit(self, commit):
617         files = []
618         fnum = 0
619         while commit.has_key("depotFile%s" % fnum):
620             path =  commit["depotFile%s" % fnum]
622             found = [p for p in self.depotPaths
623                      if path.startswith (p)]
624             if not found:
625                 fnum = fnum + 1
626                 continue
628             file = {}
629             file["path"] = path
630             file["rev"] = commit["rev%s" % fnum]
631             file["action"] = commit["action%s" % fnum]
632             file["type"] = commit["type%s" % fnum]
633             files.append(file)
634             fnum = fnum + 1
635         return files
637     def stripRepoPath(self, path, prefixes):
638         if self.keepRepoPath:
639             prefixes = [re.sub("^(//[^/]+/).*", r'\1', prefixes[0])]
641         for p in prefixes:
642             if path.startswith(p):
643                 path = path[len(p):]
645         return path
647     def splitFilesIntoBranches(self, commit):
648         branches = {}
649         fnum = 0
650         while commit.has_key("depotFile%s" % fnum):
651             path =  commit["depotFile%s" % fnum]
652             found = [p for p in self.depotPaths
653                      if path.startswith (p)]
654             if not found:
655                 fnum = fnum + 1
656                 continue
658             file = {}
659             file["path"] = path
660             file["rev"] = commit["rev%s" % fnum]
661             file["action"] = commit["action%s" % fnum]
662             file["type"] = commit["type%s" % fnum]
663             fnum = fnum + 1
665             relPath = self.stripRepoPath(path, self.depotPaths)
667             for branch in self.knownBranches.keys():
669                 # add a trailing slash so that a commit into qt/4.2foo doesn't end up in qt/4.2
670                 if relPath.startswith(branch + "/"):
671                     if branch not in branches:
672                         branches[branch] = []
673                     branches[branch].append(file)
675         return branches
677     ## Should move this out, doesn't use SELF.
678     def readP4Files(self, files):
679         specs = [(f['path'] + "#" + f['rev'], f)  for f in files
680                  if f['action'] != 'delete']
682         if not specs:
683             return
685         filedata = p4CmdList('print %s' % ' '.join(['"%s"' % path
686                                                 for (path, info) in specs]))
688         j = 0;
689         contents = {}
690         while filedata[j:]:
691             stat = filedata[j]
692             text = filedata[j+1]
693             j += 2
695             assert stat['code'] == 'stat' and text['code'] == 'text'
696             contents[stat['depotFile']] = text['data']
698         for f in files:
699             assert not f.has_key('data')
700             f['data'] = contents[f['path']]
702     def commit(self, details, files, branch, branchPrefixes, parent = ""):
703         epoch = details["time"]
704         author = details["user"]
706         if self.verbose:
707             print "commit into %s" % branch
709         # start with reading files; if that fails, we should not
710         # create a commit.
711         new_files = []
712         for f in files:
713             if [p for p in branchPrefixes if f['path'].startswith(p)]:
714                 new_files.append (f)
715             else:
716                 sys.stderr.write("Ignoring file outside of prefix: %s\n" % path)
717         files = new_files
718         self.readP4Files(files)
723         self.gitStream.write("commit %s\n" % branch)
724 #        gitStream.write("mark :%s\n" % details["change"])
725         self.committedChanges.add(int(details["change"]))
726         committer = ""
727         if author not in self.users:
728             self.getUserMapFromPerforceServer()
729         if author in self.users:
730             committer = "%s %s %s" % (self.users[author], epoch, self.tz)
731         else:
732             committer = "%s <a@b> %s %s" % (author, epoch, self.tz)
734         self.gitStream.write("committer %s\n" % committer)
736         self.gitStream.write("data <<EOT\n")
737         self.gitStream.write(details["desc"])
738         self.gitStream.write("\n[git-p4: depot-paths = \"%s\": change = %s: "
739                              "options = %s]\n"
740                              % (','.join (branchPrefixes), details["change"],
741                                 details['options']
742                                 ))
743         self.gitStream.write("EOT\n\n")
745         if len(parent) > 0:
746             if self.verbose:
747                 print "parent %s" % parent
748             self.gitStream.write("from %s\n" % parent)
750         for file in files:
751             if file["type"] == "apple":
752                 print "\nfile %s is a strange apple file that forks. Ignoring!" % file['path']
753                 continue
755             relPath = self.stripRepoPath(file['path'], branchPrefixes)
756             if file["action"] == "delete":
757                 self.gitStream.write("D %s\n" % relPath)
758             else:
759                 mode = 644
760                 if file["type"].startswith("x"):
761                     mode = 755
763                 data = file['data']
765                 if self.isWindows and file["type"].endswith("text"):
766                     data = data.replace("\r\n", "\n")
768                 self.gitStream.write("M %s inline %s\n" % (mode, relPath))
769                 self.gitStream.write("data %s\n" % len(data))
770                 self.gitStream.write(data)
771                 self.gitStream.write("\n")
773         self.gitStream.write("\n")
775         change = int(details["change"])
777         if self.labels.has_key(change):
778             label = self.labels[change]
779             labelDetails = label[0]
780             labelRevisions = label[1]
781             if self.verbose:
782                 print "Change %s is labelled %s" % (change, labelDetails)
784             files = p4CmdList("files " + ' '.join (["%s...@%s" % (p, change)
785                                                     for p in branchPrefixes]))
787             if len(files) == len(labelRevisions):
789                 cleanedFiles = {}
790                 for info in files:
791                     if info["action"] == "delete":
792                         continue
793                     cleanedFiles[info["depotFile"]] = info["rev"]
795                 if cleanedFiles == labelRevisions:
796                     self.gitStream.write("tag tag_%s\n" % labelDetails["label"])
797                     self.gitStream.write("from %s\n" % branch)
799                     owner = labelDetails["Owner"]
800                     tagger = ""
801                     if author in self.users:
802                         tagger = "%s %s %s" % (self.users[owner], epoch, self.tz)
803                     else:
804                         tagger = "%s <a@b> %s %s" % (owner, epoch, self.tz)
805                     self.gitStream.write("tagger %s\n" % tagger)
806                     self.gitStream.write("data <<EOT\n")
807                     self.gitStream.write(labelDetails["Description"])
808                     self.gitStream.write("EOT\n\n")
810                 else:
811                     if not self.silent:
812                         print ("Tag %s does not match with change %s: files do not match."
813                                % (labelDetails["label"], change))
815             else:
816                 if not self.silent:
817                     print ("Tag %s does not match with change %s: file count is different."
818                            % (labelDetails["label"], change))
820     def getUserCacheFilename(self):
821         return os.environ["HOME"] + "/.gitp4-usercache.txt"
823     def getUserMapFromPerforceServer(self):
824         if self.userMapFromPerforceServer:
825             return
826         self.users = {}
828         for output in p4CmdList("users"):
829             if not output.has_key("User"):
830                 continue
831             self.users[output["User"]] = output["FullName"] + " <" + output["Email"] + ">"
834         s = ''
835         for (key, val) in self.users.items():
836             s += "%s\t%s\n" % (key, val)
838         open(self.getUserCacheFilename(), "wb").write(s)
839         self.userMapFromPerforceServer = True
841     def loadUserMapFromCache(self):
842         self.users = {}
843         self.userMapFromPerforceServer = False
844         try:
845             cache = open(self.getUserCacheFilename(), "rb")
846             lines = cache.readlines()
847             cache.close()
848             for line in lines:
849                 entry = line.strip().split("\t")
850                 self.users[entry[0]] = entry[1]
851         except IOError:
852             self.getUserMapFromPerforceServer()
854     def getLabels(self):
855         self.labels = {}
857         l = p4CmdList("labels %s..." % ' '.join (self.depotPaths))
858         if len(l) > 0 and not self.silent:
859             print "Finding files belonging to labels in %s" % `self.depotPath`
861         for output in l:
862             label = output["label"]
863             revisions = {}
864             newestChange = 0
865             if self.verbose:
866                 print "Querying files for label %s" % label
867             for file in p4CmdList("files "
868                                   +  ' '.join (["%s...@%s" % (p, label)
869                                                 for p in self.depotPaths])):
870                 revisions[file["depotFile"]] = file["rev"]
871                 change = int(file["change"])
872                 if change > newestChange:
873                     newestChange = change
875             self.labels[newestChange] = [output, revisions]
877         if self.verbose:
878             print "Label changes: %s" % self.labels.keys()
880     def guessProjectName(self):
881         for p in self.depotPaths:
882             return p [p.strip().rfind("/") + 1:]
884     def getBranchMapping(self):
886         ## FIXME - what's a P4 projectName ?
887         self.projectName = self.guessProjectName()
889         for info in p4CmdList("branches"):
890             details = p4Cmd("branch -o %s" % info["branch"])
891             viewIdx = 0
892             while details.has_key("View%s" % viewIdx):
893                 paths = details["View%s" % viewIdx].split(" ")
894                 viewIdx = viewIdx + 1
895                 # require standard //depot/foo/... //depot/bar/... mapping
896                 if len(paths) != 2 or not paths[0].endswith("/...") or not paths[1].endswith("/..."):
897                     continue
898                 source = paths[0]
899                 destination = paths[1]
900                 if source.startswith(self.depotPath) and destination.startswith(self.depotPath):
901                     source = source[len(self.depotPath):-4]
902                     destination = destination[len(self.depotPath):-4]
903                     if destination not in self.knownBranches:
904                         self.knownBranches[destination] = source
905                     if source not in self.knownBranches:
906                         self.knownBranches[source] = source
908     def listExistingP4GitBranches(self):
909         self.p4BranchesInGit = []
911         cmdline = "git rev-parse --symbolic "
912         if self.importIntoRemotes:
913             cmdline += " --remotes"
914         else:
915             cmdline += " --branches"
917         for line in read_pipe_lines(cmdline):
918             line = line.strip()
920             ## only import to p4/
921             if not line.startswith('p4/'):
922                 continue
923             branch = line
924             if self.importIntoRemotes:
925                 # strip off p4
926                 branch = re.sub ("^p4/", "", line)
928             self.p4BranchesInGit.append(branch)
929             self.initialParents[self.refPrefix + branch] = parseRevision(line)
931     def createOrUpdateBranchesFromOrigin(self):
932         if not self.silent:
933             print ("Creating/updating branch(es) in %s based on origin branch(es)"
934                    % self.refPrefix)
936         for line in read_pipe_lines("git rev-parse --symbolic --remotes"):
937             line = line.strip()
938             if (not line.startswith("origin/")) or line.endswith("HEAD\n"):
939                 continue
941             headName = line[len("origin/"):]
942             remoteHead = self.refPrefix + headName
943             originHead = "origin/" + headName
945             original = extractSettingsGitLog(extractLogMessageFromGitCommit(originHead))
946             if (not original.has_key('depot-paths')
947                 or not original.has_key('change')):
948                 continue
950             update = False
951             if not gitBranchExists(remoteHead):
952                 if self.verbose:
953                     print "creating %s" % remoteHead
954                 update = True
955             else:
956                 settings =  extractSettingsGitLog(extractLogMessageFromGitCommit(remoteHead))
957                 if settings.has_key('change') > 0:
958                     if settings['depot-paths'] == original['depot-paths']:
959                         originP4Change = int(original['change'])
960                         p4Change = int(settings['change'])
961                         if originP4Change > p4Change:
962                             print ("%s (%s) is newer than %s (%s). "
963                                    "Updating p4 branch from origin."
964                                    % (originHead, originP4Change,
965                                       remoteHead, p4Change))
966                             update = True
967                     else:
968                         print ("Ignoring: %s was imported from %s while "
969                                "%s was imported from %s"
970                                % (originHead, ','.join(original['depot-paths']),
971                                   remoteHead, ','.join(settings['depot-paths'])))
973             if update:
974                 system("git update-ref %s %s" % (remoteHead, originHead))
976     def updateOptionDict(self, d):
977         option_keys = {}
978         if self.keepRepoPath:
979             option_keys['keepRepoPath'] = 1
981         d["options"] = ' '.join(sorted(option_keys.keys()))
983     def readOptions(self, d):
984         self.keepRepoPath = (d.has_key('options')
985                              and ('keepRepoPath' in d['options']))
987     def run(self, args):
988         self.depotPaths = []
989         self.changeRange = ""
990         self.initialParent = ""
991         self.previousDepotPaths = []
993         # map from branch depot path to parent branch
994         self.knownBranches = {}
995         self.initialParents = {}
996         self.hasOrigin = gitBranchExists("origin")
998         if self.importIntoRemotes:
999             self.refPrefix = "refs/remotes/p4/"
1000         else:
1001             self.refPrefix = "refs/heads/"
1003         if self.syncWithOrigin and self.hasOrigin:
1004             if not self.silent:
1005                 print "Syncing with origin first by calling git fetch origin"
1006             system("git fetch origin")
1008         if len(self.branch) == 0:
1009             self.branch = self.refPrefix + "p4/master"
1010             if gitBranchExists("refs/heads/p4") and self.importIntoRemotes:
1011                 system("git update-ref %s refs/heads/p4" % self.branch)
1012                 system("git branch -D p4");
1013             # create it /after/ importing, when master exists
1014             if not gitBranchExists(self.refPrefix + "HEAD") and self.importIntoRemotes:
1015                 system("git symbolic-ref %sHEAD %s" % (self.refPrefix, self.branch))
1017         # TODO: should always look at previous commits,
1018         # merge with previous imports, if possible.
1019         if args == []:
1020             if self.hasOrigin:
1021                 self.createOrUpdateBranchesFromOrigin()
1022             self.listExistingP4GitBranches()
1024             if len(self.p4BranchesInGit) > 1:
1025                 if not self.silent:
1026                     print "Importing from/into multiple branches"
1027                 self.detectBranches = True
1029             if self.verbose:
1030                 print "branches: %s" % self.p4BranchesInGit
1032             p4Change = 0
1033             for branch in self.p4BranchesInGit:
1034                 print self.p4BranchesInGit
1035                 logMsg =  extractLogMessageFromGitCommit(self.refPrefix + branch)
1037                 settings = extractSettingsGitLog(logMsg)
1039                 self.readOptions(settings)
1040                 if (settings.has_key('depot-paths')
1041                     and settings.has_key ('change')):
1042                     change = int(settings['change']) + 1
1043                     p4Change = max(p4Change, change)
1045                     depotPaths = sorted(settings['depot-paths'])
1046                     if self.previousDepotPaths == []:
1047                         self.previousDepotPaths = depotPaths
1048                     else:
1049                         paths = []
1050                         for (prev, cur) in zip(self.previousDepotPaths, depotPaths):
1051                             for i in range(0, max(len(cur), len(prev))):
1052                                 if cur[i] <> prev[i]:
1053                                     break
1055                             paths.append (cur[:i])
1057                         self.previousDepotPaths = paths
1059             if p4Change > 0:
1060                 self.depotPaths = sorted(self.previousDepotPaths)
1061                 self.changeRange = "@%s,#head" % p4Change
1062                 self.initialParent = parseRevision(self.branch)
1063                 if not self.silent and not self.detectBranches:
1064                     print "Performing incremental import into %s git branch" % self.branch
1066         if not self.branch.startswith("refs/"):
1067             self.branch = "refs/heads/" + self.branch
1069         if len(args) == 0 and self.depotPaths:
1070             if not self.silent:
1071                 print "Depot paths: %s" % ' '.join(self.depotPaths)
1072         else:
1073             if self.depotPaths and self.depotPaths != args:
1074                 print ("previous import used depot path %s and now %s was specified. "
1075                        "This doesn't work!" % (' '.join (self.depotPaths),
1076                                                ' '.join (args)))
1077                 sys.exit(1)
1079             self.depotPaths = sorted(args)
1081         self.revision = ""
1082         self.users = {}
1084         newPaths = []
1085         for p in self.depotPaths:
1086             if p.find("@") != -1:
1087                 atIdx = p.index("@")
1088                 self.changeRange = p[atIdx:]
1089                 if self.changeRange == "@all":
1090                     self.changeRange = ""
1091                 elif ',' not in self.changeRange:
1092                     self.revision = self.changeRange
1093                     self.changeRange = ""
1094                 p = p[0:atIdx]
1095             elif p.find("#") != -1:
1096                 hashIdx = p.index("#")
1097                 self.revision = p[hashIdx:]
1098                 p = p[0:hashIdx]
1099             elif self.previousDepotPaths == []:
1100                 self.revision = "#head"
1102             p = re.sub ("\.\.\.$", "", p)
1103             if not p.endswith("/"):
1104                 p += "/"
1106             newPaths.append(p)
1108         self.depotPaths = newPaths
1111         self.loadUserMapFromCache()
1112         self.labels = {}
1113         if self.detectLabels:
1114             self.getLabels();
1116         if self.detectBranches:
1117             self.getBranchMapping();
1118             if self.verbose:
1119                 print "p4-git branches: %s" % self.p4BranchesInGit
1120                 print "initial parents: %s" % self.initialParents
1121             for b in self.p4BranchesInGit:
1122                 if b != "master":
1124                     ## FIXME
1125                     b = b[len(self.projectName):]
1126                 self.createdBranches.add(b)
1128         self.tz = "%+03d%02d" % (- time.timezone / 3600, ((- time.timezone % 3600) / 60))
1130         importProcess = subprocess.Popen(["git", "fast-import"],
1131                                          stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1132                                          stderr=subprocess.PIPE);
1133         self.gitOutput = importProcess.stdout
1134         self.gitStream = importProcess.stdin
1135         self.gitError = importProcess.stderr
1137         if self.revision:
1138             print "Doing initial import of %s from revision %s" % (' '.join(self.depotPaths), self.revision)
1140             details = { "user" : "git perforce import user", "time" : int(time.time()) }
1141             details["desc"] = ("Initial import of %s from the state at revision %s"
1142                                % (' '.join(self.depotPaths), self.revision))
1143             details["change"] = self.revision
1144             newestRevision = 0
1146             fileCnt = 0
1147             for info in p4CmdList("files "
1148                                   +  ' '.join(["%s...%s"
1149                                                % (p, self.revision)
1150                                                for p in self.depotPaths])):
1152                 if info['code'] == 'error':
1153                     sys.stderr.write("p4 returned an error: %s\n"
1154                                      % info['data'])
1155                     sys.exit(1)
1158                 change = int(info["change"])
1159                 if change > newestRevision:
1160                     newestRevision = change
1162                 if info["action"] == "delete":
1163                     # don't increase the file cnt, otherwise details["depotFile123"] will have gaps!
1164                     #fileCnt = fileCnt + 1
1165                     continue
1167                 for prop in ["depotFile", "rev", "action", "type" ]:
1168                     details["%s%s" % (prop, fileCnt)] = info[prop]
1170                 fileCnt = fileCnt + 1
1172             details["change"] = newestRevision
1173             self.updateOptionDict(details)
1174             try:
1175                 self.commit(details, self.extractFilesFromCommit(details), self.branch, self.depotPaths)
1176             except IOError:
1177                 print "IO error with git fast-import. Is your git version recent enough?"
1178                 print self.gitError.read()
1180         else:
1181             changes = []
1183             if len(self.changesFile) > 0:
1184                 output = open(self.changesFile).readlines()
1185                 changeSet = Set()
1186                 for line in output:
1187                     changeSet.add(int(line))
1189                 for change in changeSet:
1190                     changes.append(change)
1192                 changes.sort()
1193             else:
1194                 if self.verbose:
1195                     print "Getting p4 changes for %s...%s" % (', '.join(self.depotPaths),
1196                                                               self.changeRange)
1197                 assert self.depotPaths
1198                 output = read_pipe_lines("p4 changes " + ' '.join (["%s...%s" % (p, self.changeRange)
1199                                                                     for p in self.depotPaths]))
1201                 for line in output:
1202                     changeNum = line.split(" ")[1]
1203                     changes.append(changeNum)
1205                 changes.reverse()
1207                 if len(self.maxChanges) > 0:
1208                     changes = changes[0:min(int(self.maxChanges), len(changes))]
1210             if len(changes) == 0:
1211                 if not self.silent:
1212                     print "No changes to import!"
1213                 return True
1215             self.updatedBranches = set()
1217             cnt = 1
1218             for change in changes:
1219                 description = p4Cmd("describe %s" % change)
1220                 self.updateOptionDict(description)
1222                 if not self.silent:
1223                     sys.stdout.write("\rImporting revision %s (%s%%)" % (change, cnt * 100 / len(changes)))
1224                     sys.stdout.flush()
1225                 cnt = cnt + 1
1227                 try:
1228                     if self.detectBranches:
1229                         branches = self.splitFilesIntoBranches(description)
1230                         for branch in branches.keys():
1231                             ## HACK  --hwn
1232                             branchPrefix = self.depotPaths[0] + branch + "/"
1234                             parent = ""
1236                             filesForCommit = branches[branch]
1238                             if self.verbose:
1239                                 print "branch is %s" % branch
1241                             self.updatedBranches.add(branch)
1243                             if branch not in self.createdBranches:
1244                                 self.createdBranches.add(branch)
1245                                 parent = self.knownBranches[branch]
1246                                 if parent == branch:
1247                                     parent = ""
1248                                 elif self.verbose:
1249                                     print "parent determined through known branches: %s" % parent
1251                             # main branch? use master
1252                             if branch == "main":
1253                                 branch = "master"
1254                             else:
1256                                 ## FIXME
1257                                 branch = self.projectName + branch
1259                             if parent == "main":
1260                                 parent = "master"
1261                             elif len(parent) > 0:
1262                                 ## FIXME
1263                                 parent = self.projectName + parent
1265                             branch = self.refPrefix + branch
1266                             if len(parent) > 0:
1267                                 parent = self.refPrefix + parent
1269                             if self.verbose:
1270                                 print "looking for initial parent for %s; current parent is %s" % (branch, parent)
1272                             if len(parent) == 0 and branch in self.initialParents:
1273                                 parent = self.initialParents[branch]
1274                                 del self.initialParents[branch]
1276                             self.commit(description, filesForCommit, branch, branchPrefix, parent)
1277                     else:
1278                         files = self.extractFilesFromCommit(description)
1279                         self.commit(description, files, self.branch, self.depotPaths,
1280                                     self.initialParent)
1281                         self.initialParent = ""
1282                 except IOError:
1283                     print self.gitError.read()
1284                     sys.exit(1)
1286             if not self.silent:
1287                 print ""
1288                 if len(self.updatedBranches) > 0:
1289                     sys.stdout.write("Updated branches: ")
1290                     for b in self.updatedBranches:
1291                         sys.stdout.write("%s " % b)
1292                     sys.stdout.write("\n")
1295         self.gitStream.close()
1296         if importProcess.wait() != 0:
1297             die("fast-import failed: %s" % self.gitError.read())
1298         self.gitOutput.close()
1299         self.gitError.close()
1301         return True
1303 class P4Rebase(Command):
1304     def __init__(self):
1305         Command.__init__(self)
1306         self.options = [ ]
1307         self.description = ("Fetches the latest revision from perforce and "
1308                             + "rebases the current work (branch) against it")
1310     def run(self, args):
1311         sync = P4Sync()
1312         sync.run([])
1313         print "Rebasing the current branch"
1314         oldHead = read_pipe("git rev-parse HEAD").strip()
1315         system("git rebase p4")
1316         system("git diff-tree --stat --summary -M %s HEAD" % oldHead)
1317         return True
1319 class P4Clone(P4Sync):
1320     def __init__(self):
1321         P4Sync.__init__(self)
1322         self.description = "Creates a new git repository and imports from Perforce into it"
1323         self.usage = "usage: %prog [options] //depot/path[@revRange]"
1324         self.options.append(
1325             optparse.make_option("--destination", dest="cloneDestination",
1326                                  action='store', default=None,
1327                                  help="where to leave result of the clone"))
1328         self.cloneDestination = None
1329         self.needsGit = False
1331     def defaultDestination(self, args):
1332         ## TODO: use common prefix of args?
1333         depotPath = args[0]
1334         depotDir = re.sub("(@[^@]*)$", "", depotPath)
1335         depotDir = re.sub("(#[^#]*)$", "", depotDir)
1336         depotDir = re.sub(r"\.\.\.$,", "", depotDir)
1337         depotDir = re.sub(r"/$", "", depotDir)
1338         return os.path.split(depotDir)[1]
1340     def run(self, args):
1341         if len(args) < 1:
1342             return False
1344         if self.keepRepoPath and not self.cloneDestination:
1345             sys.stderr.write("Must specify destination for --keep-path\n")
1346             sys.exit(1)
1348         depotPaths = args
1349         for p in depotPaths:
1350             if not p.startswith("//"):
1351                 return False
1353         if not self.cloneDestination:
1354             self.cloneDestination = self.defaultDestination()
1356         print "Importing from %s into %s" % (', '.join(depotPaths), self.cloneDestination)
1357         os.makedirs(self.cloneDestination)
1358         os.chdir(self.cloneDestination)
1359         system("git init")
1360         self.gitdir = os.getcwd() + "/.git"
1361         if not P4Sync.run(self, depotPaths):
1362             return False
1363         if self.branch != "master":
1364             if gitBranchExists("refs/remotes/p4/master"):
1365                 system("git branch master refs/remotes/p4/master")
1366                 system("git checkout -f")
1367             else:
1368                 print "Could not detect main branch. No checkout/master branch created."
1370         return True
1372 class HelpFormatter(optparse.IndentedHelpFormatter):
1373     def __init__(self):
1374         optparse.IndentedHelpFormatter.__init__(self)
1376     def format_description(self, description):
1377         if description:
1378             return description + "\n"
1379         else:
1380             return ""
1382 def printUsage(commands):
1383     print "usage: %s <command> [options]" % sys.argv[0]
1384     print ""
1385     print "valid commands: %s" % ", ".join(commands)
1386     print ""
1387     print "Try %s <command> --help for command specific help." % sys.argv[0]
1388     print ""
1390 commands = {
1391     "debug" : P4Debug,
1392     "submit" : P4Submit,
1393     "sync" : P4Sync,
1394     "rebase" : P4Rebase,
1395     "clone" : P4Clone,
1396     "rollback" : P4RollBack
1400 def main():
1401     if len(sys.argv[1:]) == 0:
1402         printUsage(commands.keys())
1403         sys.exit(2)
1405     cmd = ""
1406     cmdName = sys.argv[1]
1407     try:
1408         klass = commands[cmdName]
1409         cmd = klass()
1410     except KeyError:
1411         print "unknown command %s" % cmdName
1412         print ""
1413         printUsage(commands.keys())
1414         sys.exit(2)
1416     options = cmd.options
1417     cmd.gitdir = os.environ.get("GIT_DIR", None)
1419     args = sys.argv[2:]
1421     if len(options) > 0:
1422         options.append(optparse.make_option("--git-dir", dest="gitdir"))
1424         parser = optparse.OptionParser(cmd.usage.replace("%prog", "%prog " + cmdName),
1425                                        options,
1426                                        description = cmd.description,
1427                                        formatter = HelpFormatter())
1429         (cmd, args) = parser.parse_args(sys.argv[2:], cmd);
1430     global verbose
1431     verbose = cmd.verbose
1432     if cmd.needsGit:
1433         if cmd.gitdir == None:
1434             cmd.gitdir = os.path.abspath(".git")
1435             if not isValidGitDir(cmd.gitdir):
1436                 cmd.gitdir = read_pipe("git rev-parse --git-dir").strip()
1437                 if os.path.exists(cmd.gitdir):
1438                     cdup = read_pipe("git rev-parse --show-cdup").strip()
1439                     if len(cdup) > 0:
1440                         os.chdir(cdup);
1442         if not isValidGitDir(cmd.gitdir):
1443             if isValidGitDir(cmd.gitdir + "/.git"):
1444                 cmd.gitdir += "/.git"
1445             else:
1446                 die("fatal: cannot locate git repository at %s" % cmd.gitdir)
1448         os.environ["GIT_DIR"] = cmd.gitdir
1450     if not cmd.run(args):
1451         parser.print_help()
1454 if __name__ == '__main__':
1455     main()