1 """Python GIT interface
5 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License version 2 as
9 published by the Free Software Foundation.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 import sys, os, glob, popen2
23 from stgit.utils import *
26 class GitException(Exception):
30 # Different start-up variables read from the environment
31 if 'GIT_DIR' in os.environ:
32 base_dir = os.environ['GIT_DIR']
36 head_link = os.path.join(base_dir, 'HEAD')
42 """Handle the commit objects
44 def __init__(self, id_hash):
45 self.__id_hash = id_hash
47 lines = _output_lines('git-cat-file commit %s' % id_hash)
49 for i in range(len(lines)):
53 field = line.strip().split(' ', 1)
54 if field[0] == 'tree':
55 self.__tree = field[1]
56 elif field[0] == 'parent':
57 self.__parents.append(field[1])
58 if field[0] == 'author':
59 self.__author = field[1]
60 if field[0] == 'committer':
61 self.__committer = field[1]
62 self.__log = ''.join(lines[i+1:])
64 def get_id_hash(self):
71 return self.__parents[0]
73 def get_parents(self):
79 def get_committer(self):
80 return self.__committer
85 # dictionary of Commit objects, used to avoid multiple calls to git
91 def get_commit(id_hash):
92 """Commit objects factory. Save/look-up them in the __commits
97 if id_hash in __commits:
98 return __commits[id_hash]
100 commit = Commit(id_hash)
101 __commits[id_hash] = commit
105 """Return the list of file conflicts
107 conflicts_file = os.path.join(base_dir, 'conflicts')
108 if os.path.isfile(conflicts_file):
109 f = file(conflicts_file)
110 names = [line.strip() for line in f.readlines()]
116 def _input(cmd, file_desc):
117 p = popen2.Popen3(cmd)
119 line = file_desc.readline()
122 p.tochild.write(line)
125 raise GitException, '%s failed' % str(cmd)
129 string = p.fromchild.read()
131 raise GitException, '%s failed' % str(cmd)
134 def _output_one_line(cmd, file_desc = None):
136 if file_desc != None:
137 for line in file_desc:
138 p.tochild.write(line)
140 string = p.fromchild.readline().strip()
142 raise GitException, '%s failed' % str(cmd)
145 def _output_lines(cmd):
147 lines = p.fromchild.readlines()
149 raise GitException, '%s failed' % str(cmd)
152 def __run(cmd, args=None):
153 """__run: runs cmd using spawnvp.
155 Runs cmd using spawnvp. The shell is avoided so it won't mess up
156 our arguments. If args is very large, the command is run multiple
157 times; args is split xargs style: cmd is passed on each
158 invocation. Unlike xargs, returns immediately if any non-zero
159 return code is received.
165 for i in range(0, len(args)+1, 100):
166 r=os.spawnvp(os.P_WAIT, args_l[0], args_l + args[i:min(i+100, len(args))])
171 def __check_base_dir():
172 return os.path.isdir(base_dir)
174 def __tree_status(files = [], tree_id = 'HEAD', unknown = False,
176 """Returns a list of pairs - [status, filename]
178 os.system('git-update-index --refresh > /dev/null')
184 exclude_file = os.path.join(base_dir, 'info', 'exclude')
185 base_exclude = ['--exclude=%s' % s for s in
186 ['*.[ao]', '*.pyc', '.*', '*~', '#*', 'TAGS', 'tags']]
187 base_exclude.append('--exclude-per-directory=.gitignore')
189 if os.path.exists(exclude_file):
190 extra_exclude = ['--exclude-from=%s' % exclude_file]
194 extra_exclude = base_exclude = []
196 lines = _output_lines(['git-ls-files', '--others'] + base_exclude
198 cache_files += [('?', line.strip()) for line in lines]
201 conflicts = get_conflicts()
204 cache_files += [('C', filename) for filename in conflicts]
207 for line in _output_lines(['git-diff-index', '-r', tree_id] + files):
208 fs = tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
209 if fs[1] not in conflicts:
210 cache_files.append(fs)
215 """Return true if there are local changes in the tree
217 return len(__tree_status()) != 0
223 """Verifies the HEAD and returns the SHA1 id that represents it
228 __head = rev_parse('HEAD')
232 """Returns the name of the file pointed to by the HEAD link
234 return os.path.basename(_output_one_line('git-symbolic-ref HEAD'))
236 def set_head_file(ref):
237 """Resets HEAD to point to a new ref
239 if __run('git-symbolic-ref HEAD', [ref]) != 0:
240 raise GitException, 'Could not set head to "%s"' % ref
243 """Sets the HEAD value
247 if not __head or __head != val:
248 if __run('git-update-ref HEAD', [val]) != 0:
249 raise GitException, 'Could not update HEAD to "%s".' % val
252 def __clear_head_cache():
253 """Sets the __head to None so that a re-read is forced
259 def rev_parse(git_id):
260 """Parse the string and return a verified SHA1 id
263 return _output_one_line(['git-rev-parse', '--verify', git_id])
265 raise GitException, 'Unknown revision: %s' % git_id
268 """Add the files or recursively add the directory contents
270 # generate the file list
273 if not os.path.exists(i):
274 raise GitException, 'Unknown file or directory: %s' % i
277 # recursive search. We only add files
278 for root, dirs, local_files in os.walk(i):
279 for name in [os.path.join(root, f) for f in local_files]:
280 if os.path.isfile(name):
281 files.append(os.path.normpath(name))
282 elif os.path.isfile(i):
283 files.append(os.path.normpath(i))
285 raise GitException, '%s is not a file or directory' % i
288 if __run('git-update-index --add --', files):
289 raise GitException, 'Unable to add file'
291 def rm(files, force = False):
292 """Remove a file from the repository
295 git_opt = '--force-remove'
301 if os.path.exists(f):
302 raise GitException, '%s exists. Remove it first' %f
304 __run('git-update-index --remove --', files)
307 __run('git-update-index --force-remove --', files)
309 def update_cache(files = [], force = False):
310 """Update the cache information for the given files
312 cache_files = __tree_status(files)
314 # everything is up-to-date
315 if len(cache_files) == 0:
318 # check for unresolved conflicts
319 if not force and [x for x in cache_files
320 if x[0] not in ['M', 'N', 'A', 'D']]:
321 raise GitException, 'Updating cache failed: unresolved conflicts'
324 add_files = [x[1] for x in cache_files if x[0] in ['N', 'A']]
325 rm_files = [x[1] for x in cache_files if x[0] in ['D']]
326 m_files = [x[1] for x in cache_files if x[0] in ['M']]
328 if add_files and __run('git-update-index --add --', add_files) != 0:
329 raise GitException, 'Failed git-update-index --add'
330 if rm_files and __run('git-update-index --force-remove --', rm_files) != 0:
331 raise GitException, 'Failed git-update-index --rm'
332 if m_files and __run('git-update-index --', m_files) != 0:
333 raise GitException, 'Failed git-update-index'
337 def commit(message, files = [], parents = [], allowempty = False,
338 cache_update = True, tree_id = None,
339 author_name = None, author_email = None, author_date = None,
340 committer_name = None, committer_email = None):
341 """Commit the current tree to repository
343 # Get the tree status
344 if cache_update and parents != []:
345 changes = update_cache(files)
346 if not changes and not allowempty:
347 raise GitException, 'No changes to commit'
349 # get the commit message
350 if message[-1:] != '\n':
354 # write the index to repository
356 tree_id = _output_one_line('git-write-tree')
363 cmd += 'GIT_AUTHOR_NAME="%s" ' % author_name
365 cmd += 'GIT_AUTHOR_EMAIL="%s" ' % author_email
367 cmd += 'GIT_AUTHOR_DATE="%s" ' % author_date
369 cmd += 'GIT_COMMITTER_NAME="%s" ' % committer_name
371 cmd += 'GIT_COMMITTER_EMAIL="%s" ' % committer_email
372 cmd += 'git-commit-tree %s' % tree_id
378 commit_id = _output_one_line(cmd, message)
380 __set_head(commit_id)
384 def apply_diff(rev1, rev2):
385 """Apply the diff between rev1 and rev2 onto the current
386 index. This function doesn't need to raise an exception since it
387 is only used for fast-pushing a patch. If this operation fails,
388 the pushing would fall back to the three-way merge.
390 return os.system('git-diff-tree -p %s %s | git-apply --index 2> /dev/null'
393 def merge(base, head1, head2):
394 """Perform a 3-way merge between base, head1 and head2 into the
397 if __run('git-read-tree -u -m', [base, head1, head2]) != 0:
398 raise GitException, 'git-read-tree failed (local changes maybe?)'
400 # this can fail if there are conflicts
401 if os.system('git-merge-index -o -q gitmergeonefile.py -a') != 0:
402 raise GitException, 'git-merge-cache failed (possible conflicts)'
404 def status(files = [], modified = False, new = False, deleted = False,
405 conflict = False, unknown = False, noexclude = False):
406 """Show the tree status
408 cache_files = __tree_status(files, unknown = True, noexclude = noexclude)
409 all = not (modified or new or deleted or conflict or unknown)
424 cache_files = [x for x in cache_files if x[0] in filestat]
426 for fs in cache_files:
428 print '%s %s' % (fs[0], fs[1])
432 def diff(files = [], rev1 = 'HEAD', rev2 = None, out_fd = None):
433 """Show the diff between rev1 and rev2
437 diff_str = _output(['git-diff-tree', '-p', rev1, rev2] + files)
439 os.system('git-update-index --refresh > /dev/null')
440 diff_str = _output(['git-diff-index', '-p', rev1] + files)
443 out_fd.write(diff_str)
447 def diffstat(files = [], rev1 = 'HEAD', rev2 = None):
448 """Return the diffstat between rev1 and rev2
451 p=popen2.Popen3('git-apply --stat')
452 diff(files, rev1, rev2, p.tochild)
454 str = p.fromchild.read().rstrip()
456 raise GitException, 'git.diffstat failed'
459 def files(rev1, rev2):
460 """Return the files modified between rev1 and rev2
464 for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
465 str += '%s %s\n' % tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
469 def barefiles(rev1, rev2):
470 """Return the files modified between rev1 and rev2, without status info
474 for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
475 str += '%s\n' % line.rstrip().split(' ',4)[-1].split('\t',1)[-1]
479 def checkout(files = [], tree_id = None, force = False):
480 """Check out the given or all files
482 if tree_id and __run('git-read-tree -m', [tree_id]) != 0:
483 raise GitException, 'Failed git-read-tree -m %s' % tree_id
485 checkout_cmd = 'git-checkout-index -q -u'
487 checkout_cmd += ' -f'
489 checkout_cmd += ' -a'
491 checkout_cmd += ' --'
493 if __run(checkout_cmd, files) != 0:
494 raise GitException, 'Failed git-checkout-index'
497 """Switch the tree to the given id
499 if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
500 raise GitException, 'git-read-tree failed (local changes maybe?)'
504 def reset(tree_id = None):
505 """Revert the tree changes relative to the given tree_id. It removes
511 cache_files = __tree_status(tree_id = tree_id)
512 rm_files = [x[1] for x in cache_files if x[0] in ['D']]
514 checkout(tree_id = tree_id, force = True)
517 # checkout doesn't remove files
518 map(os.remove, rm_files)
520 def pull(repository = 'origin', refspec = None):
521 """Pull changes from the remote repository. At the moment, just
522 use the 'git pull' command
524 # 'git pull' updates the HEAD
531 if __run('git pull', args) != 0:
532 raise GitException, 'Failed "git pull %s"' % repository
534 def apply_patch(filename = None, base = None):
535 """Apply a patch onto the current or given index. There must not
536 be any local changes in the tree, otherwise the command fails
540 return __run('git-apply --index', [filename]) == 0
543 _input('git-apply --index', sys.stdin)
548 os.system('git-update-index --refresh > /dev/null')
551 orig_head = get_head()
554 if not __apply_patch():
557 raise GitException, 'Patch does not apply cleanly'
559 top = commit(message = 'temporary commit used for applying a patch',
562 merge(base, orig_head, top)
564 def clone(repository, local_dir):
565 """Clone a remote repository. At the moment, just use the
568 if __run('git clone', [repository, local_dir]) != 0:
569 raise GitException, 'Failed "git clone %s %s"' \
570 % (repository, local_dir)