mdw@git.distorted.org.uk Git - stgit/blob - stgit/git.py

   1 """Python GIT interface
   2 """
   3
   4 __copyright__ = """
   5 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
   6
   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.
  10
  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.
  15
  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
  19 """
  20
  21 import sys, os, glob, popen2
  22
  23 from stgit.utils import *
  24
  25 # git exception class
  26 class GitException(Exception):
  27     pass
  28
  29
  30 # Different start-up variables read from the environment
  31 if 'GIT_DIR' in os.environ:
  32     base_dir = os.environ['GIT_DIR']
  33 else:
  34     base_dir = '.git'
  35
  36 head_link = os.path.join(base_dir, 'HEAD')
  37
  38 #
  39 # Classes
  40 #
  41 class Commit:
  42     """Handle the commit objects
  43     """
  44     def __init__(self, id_hash):
  45         self.__id_hash = id_hash
  46
  47         lines = _output_lines('git-cat-file commit %s' % id_hash)
  48         self.__parents = []
  49         for i in range(len(lines)):
  50             line = lines[i]
  51             if line == '\n':
  52                 break
  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:])
  63
  64     def get_id_hash(self):
  65         return self.__id_hash
  66
  67     def get_tree(self):
  68         return self.__tree
  69
  70     def get_parent(self):
  71         return self.__parents[0]
  72
  73     def get_parents(self):
  74         return self.__parents
  75
  76     def get_author(self):
  77         return self.__author
  78
  79     def get_committer(self):
  80         return self.__committer
  81
  82     def get_log(self):
  83         return self.__log
  84
  85 # dictionary of Commit objects, used to avoid multiple calls to git
  86 __commits = dict()
  87
  88 #
  89 # Functions
  90 #
  91 def get_commit(id_hash):
  92     """Commit objects factory. Save/look-up them in the __commits
  93     dictionary
  94     """
  95     global __commits
  96
  97     if id_hash in __commits:
  98         return __commits[id_hash]
  99     else:
 100         commit = Commit(id_hash)
 101         __commits[id_hash] = commit
 102         return commit
 103
 104 def get_conflicts():
 105     """Return the list of file conflicts
 106     """
 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()]
 111         f.close()
 112         return names
 113     else:
 114         return None
 115
 116 def _input(cmd, file_desc):
 117     p = popen2.Popen3(cmd)
 118     while True:
 119         line = file_desc.readline()
 120         if not line:
 121             break
 122         p.tochild.write(line)
 123     p.tochild.close()
 124     if p.wait():
 125         raise GitException, '%s failed' % str(cmd)
 126
 127 def _output(cmd):
 128     p=popen2.Popen3(cmd)
 129     string = p.fromchild.read()
 130     if p.wait():
 131         raise GitException, '%s failed' % str(cmd)
 132     return string
 133
 134 def _output_one_line(cmd, file_desc = None):
 135     p=popen2.Popen3(cmd)
 136     if file_desc != None:
 137         for line in file_desc:
 138             p.tochild.write(line)
 139         p.tochild.close()
 140     string = p.fromchild.readline().strip()
 141     if p.wait():
 142         raise GitException, '%s failed' % str(cmd)
 143     return string
 144
 145 def _output_lines(cmd):
 146     p=popen2.Popen3(cmd)
 147     lines = p.fromchild.readlines()
 148     if p.wait():
 149         raise GitException, '%s failed' % str(cmd)
 150     return lines
 151
 152 def __run(cmd, args=None):
 153     """__run: runs cmd using spawnvp.
 154
 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.
 160     """
 161
 162     args_l=cmd.split()
 163     if args is None:
 164         args = []
 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))])
 167     if r:
 168         return r
 169     return 0
 170
 171 def __check_base_dir():
 172     return os.path.isdir(base_dir)
 173
 174 def __tree_status(files = [], tree_id = 'HEAD', unknown = False,
 175                   noexclude = True):
 176     """Returns a list of pairs - [status, filename]
 177     """
 178     os.system('git-update-index --refresh > /dev/null')
 179
 180     cache_files = []
 181
 182     # unknown files
 183     if unknown:
 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')
 188
 189         if os.path.exists(exclude_file):
 190             extra_exclude = ['--exclude-from=%s' % exclude_file]
 191         else:
 192             extra_exclude = []
 193         if noexclude:
 194             extra_exclude = base_exclude = []
 195
 196         lines = _output_lines(['git-ls-files', '--others'] + base_exclude
 197                         + extra_exclude)
 198         cache_files += [('?', line.strip()) for line in lines]
 199
 200     # conflicted files
 201     conflicts = get_conflicts()
 202     if not conflicts:
 203         conflicts = []
 204     cache_files += [('C', filename) for filename in conflicts]
 205
 206     # the rest
 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)
 211
 212     return cache_files
 213
 214 def local_changes():
 215     """Return true if there are local changes in the tree
 216     """
 217     return len(__tree_status()) != 0
 218
 219 # HEAD value cached
 220 __head = None
 221
 222 def get_head():
 223     """Verifies the HEAD and returns the SHA1 id that represents it
 224     """
 225     global __head
 226
 227     if not __head:
 228         __head = rev_parse('HEAD')
 229     return __head
 230
 231 def get_head_file():
 232     """Returns the name of the file pointed to by the HEAD link
 233     """
 234     return os.path.basename(_output_one_line('git-symbolic-ref HEAD'))
 235
 236 def set_head_file(ref):
 237     """Resets HEAD to point to a new ref
 238     """
 239     if __run('git-symbolic-ref HEAD', [ref]) != 0:
 240         raise GitException, 'Could not set head to "%s"' % ref
 241
 242 def __set_head(val):
 243     """Sets the HEAD value
 244     """
 245     global __head
 246
 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
 250         __head = val
 251
 252 def __clear_head_cache():
 253     """Sets the __head to None so that a re-read is forced
 254     """
 255     global __head
 256
 257     __head = None
 258
 259 def rev_parse(git_id):
 260     """Parse the string and return a verified SHA1 id
 261     """
 262     try:
 263         return _output_one_line(['git-rev-parse', '--verify', git_id])
 264     except GitException:
 265         raise GitException, 'Unknown revision: %s' % git_id
 266
 267 def branch_exists(branch):
 268     """Existance check for the named branch
 269     """
 270     for line in _output_lines(['git-rev-parse', '--symbolic', '--all']):
 271         if line.strip() == branch:
 272             return True
 273     return False
 274
 275 def create_branch(new_branch, tree_id = None):
 276     """Create a new branch in the git repository
 277     """
 278     new_head = os.path.join('refs', 'heads', new_branch)
 279     if branch_exists(new_head):
 280         raise GitException, 'Branch "%s" already exists' % new_branch
 281
 282     current_head = get_head()
 283     set_head_file(new_head)
 284     __set_head(current_head)
 285
 286     # a checkout isn't needed if new branch points to the current head
 287     if tree_id:
 288         git.switch(tree_id)
 289
 290     if os.path.isfile(os.path.join(base_dir, 'MERGE_HEAD')):
 291         os.remove(os.path.join(base_dir, 'MERGE_HEAD'))
 292
 293 def add(names):
 294     """Add the files or recursively add the directory contents
 295     """
 296     # generate the file list
 297     files = []
 298     for i in names:
 299         if not os.path.exists(i):
 300             raise GitException, 'Unknown file or directory: %s' % i
 301
 302         if os.path.isdir(i):
 303             # recursive search. We only add files
 304             for root, dirs, local_files in os.walk(i):
 305                 for name in [os.path.join(root, f) for f in local_files]:
 306                     if os.path.isfile(name):
 307                         files.append(os.path.normpath(name))
 308         elif os.path.isfile(i):
 309             files.append(os.path.normpath(i))
 310         else:
 311             raise GitException, '%s is not a file or directory' % i
 312
 313     if files:
 314         if __run('git-update-index --add --', files):
 315             raise GitException, 'Unable to add file'
 316
 317 def rm(files, force = False):
 318     """Remove a file from the repository
 319     """
 320     if force:
 321         git_opt = '--force-remove'
 322     else:
 323         git_opt = '--remove'
 324
 325     if not force:
 326         for f in files:
 327             if os.path.exists(f):
 328                 raise GitException, '%s exists. Remove it first' %f
 329         if files:
 330             __run('git-update-index --remove --', files)
 331     else:
 332         if files:
 333             __run('git-update-index --force-remove --', files)
 334
 335 def update_cache(files = [], force = False):
 336     """Update the cache information for the given files
 337     """
 338     cache_files = __tree_status(files)
 339
 340     # everything is up-to-date
 341     if len(cache_files) == 0:
 342         return False
 343
 344     # check for unresolved conflicts
 345     if not force and [x for x in cache_files
 346                       if x[0] not in ['M', 'N', 'A', 'D']]:
 347         raise GitException, 'Updating cache failed: unresolved conflicts'
 348
 349     # update the cache
 350     add_files = [x[1] for x in cache_files if x[0] in ['N', 'A']]
 351     rm_files =  [x[1] for x in cache_files if x[0] in ['D']]
 352     m_files =   [x[1] for x in cache_files if x[0] in ['M']]
 353
 354     if add_files and __run('git-update-index --add --', add_files) != 0:
 355         raise GitException, 'Failed git-update-index --add'
 356     if rm_files and __run('git-update-index --force-remove --', rm_files) != 0:
 357         raise GitException, 'Failed git-update-index --rm'
 358     if m_files and __run('git-update-index --', m_files) != 0:
 359         raise GitException, 'Failed git-update-index'
 360
 361     return True
 362
 363 def commit(message, files = [], parents = [], allowempty = False,
 364            cache_update = True, tree_id = None,
 365            author_name = None, author_email = None, author_date = None,
 366            committer_name = None, committer_email = None):
 367     """Commit the current tree to repository
 368     """
 369     # Get the tree status
 370     if cache_update and parents != []:
 371         changes = update_cache(files)
 372         if not changes and not allowempty:
 373             raise GitException, 'No changes to commit'
 374
 375     # get the commit message
 376     if message[-1:] != '\n':
 377         message += '\n'
 378
 379     must_switch = True
 380     # write the index to repository
 381     if tree_id == None:
 382         tree_id = _output_one_line('git-write-tree')
 383     else:
 384         must_switch = False
 385
 386     # the commit
 387     cmd = ''
 388     if author_name:
 389         cmd += 'GIT_AUTHOR_NAME="%s" ' % author_name
 390     if author_email:
 391         cmd += 'GIT_AUTHOR_EMAIL="%s" ' % author_email
 392     if author_date:
 393         cmd += 'GIT_AUTHOR_DATE="%s" ' % author_date
 394     if committer_name:
 395         cmd += 'GIT_COMMITTER_NAME="%s" ' % committer_name
 396     if committer_email:
 397         cmd += 'GIT_COMMITTER_EMAIL="%s" ' % committer_email
 398     cmd += 'git-commit-tree %s' % tree_id
 399
 400     # get the parents
 401     for p in parents:
 402         cmd += ' -p %s' % p
 403
 404     commit_id = _output_one_line(cmd, message)
 405     if must_switch:
 406         __set_head(commit_id)
 407
 408     return commit_id
 409
 410 def apply_diff(rev1, rev2):
 411     """Apply the diff between rev1 and rev2 onto the current
 412     index. This function doesn't need to raise an exception since it
 413     is only used for fast-pushing a patch. If this operation fails,
 414     the pushing would fall back to the three-way merge.
 415     """
 416     return os.system('git-diff-tree -p %s %s | git-apply --index 2> /dev/null'
 417                      % (rev1, rev2)) == 0
 418
 419 def merge(base, head1, head2):
 420     """Perform a 3-way merge between base, head1 and head2 into the
 421     local tree
 422     """
 423     if __run('git-read-tree -u -m', [base, head1, head2]) != 0:
 424         raise GitException, 'git-read-tree failed (local changes maybe?)'
 425
 426     # this can fail if there are conflicts
 427     if os.system('git-merge-index -o -q gitmergeonefile.py -a') != 0:
 428         raise GitException, 'git-merge-cache failed (possible conflicts)'
 429
 430 def status(files = [], modified = False, new = False, deleted = False,
 431            conflict = False, unknown = False, noexclude = False):
 432     """Show the tree status
 433     """
 434     cache_files = __tree_status(files, unknown = True, noexclude = noexclude)
 435     all = not (modified or new or deleted or conflict or unknown)
 436
 437     if not all:
 438         filestat = []
 439         if modified:
 440             filestat.append('M')
 441         if new:
 442             filestat.append('A')
 443             filestat.append('N')
 444         if deleted:
 445             filestat.append('D')
 446         if conflict:
 447             filestat.append('C')
 448         if unknown:
 449             filestat.append('?')
 450         cache_files = [x for x in cache_files if x[0] in filestat]
 451
 452     for fs in cache_files:
 453         if all:
 454             print '%s %s' % (fs[0], fs[1])
 455         else:
 456             print '%s' % fs[1]
 457
 458 def diff(files = [], rev1 = 'HEAD', rev2 = None, out_fd = None):
 459     """Show the diff between rev1 and rev2
 460     """
 461
 462     if rev2:
 463         diff_str = _output(['git-diff-tree', '-p', rev1, rev2] + files)
 464     else:
 465         os.system('git-update-index --refresh > /dev/null')
 466         diff_str = _output(['git-diff-index', '-p', rev1] + files)
 467
 468     if out_fd:
 469         out_fd.write(diff_str)
 470     else:
 471         return diff_str
 472
 473 def diffstat(files = [], rev1 = 'HEAD', rev2 = None):
 474     """Return the diffstat between rev1 and rev2
 475     """
 476
 477     p=popen2.Popen3('git-apply --stat')
 478     diff(files, rev1, rev2, p.tochild)
 479     p.tochild.close()
 480     str = p.fromchild.read().rstrip()
 481     if p.wait():
 482         raise GitException, 'git.diffstat failed'
 483     return str
 484
 485 def files(rev1, rev2):
 486     """Return the files modified between rev1 and rev2
 487     """
 488
 489     str = ''
 490     for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
 491         str += '%s %s\n' % tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
 492
 493     return str.rstrip()
 494
 495 def barefiles(rev1, rev2):
 496     """Return the files modified between rev1 and rev2, without status info
 497     """
 498
 499     str = ''
 500     for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
 501         str += '%s\n' % line.rstrip().split(' ',4)[-1].split('\t',1)[-1]
 502
 503     return str.rstrip()
 504
 505 def checkout(files = [], tree_id = None, force = False):
 506     """Check out the given or all files
 507     """
 508     if tree_id and __run('git-read-tree -m', [tree_id]) != 0:
 509         raise GitException, 'Failed git-read-tree -m %s' % tree_id
 510
 511     checkout_cmd = 'git-checkout-index -q -u'
 512     if force:
 513         checkout_cmd += ' -f'
 514     if len(files) == 0:
 515         checkout_cmd += ' -a'
 516     else:
 517         checkout_cmd += ' --'
 518
 519     if __run(checkout_cmd, files) != 0:
 520         raise GitException, 'Failed git-checkout-index'
 521
 522 def switch(tree_id):
 523     """Switch the tree to the given id
 524     """
 525     if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
 526         raise GitException, 'git-read-tree failed (local changes maybe?)'
 527
 528     __set_head(tree_id)
 529
 530 def reset(tree_id = None):
 531     """Revert the tree changes relative to the given tree_id. It removes
 532     any local changes
 533     """
 534     if not tree_id:
 535         tree_id = get_head()
 536
 537     cache_files = __tree_status(tree_id = tree_id)
 538     rm_files =  [x[1] for x in cache_files if x[0] in ['D']]
 539
 540     checkout(tree_id = tree_id, force = True)
 541     __set_head(tree_id)
 542
 543     # checkout doesn't remove files
 544     map(os.remove, rm_files)
 545
 546 def pull(repository = 'origin', refspec = None):
 547     """Pull changes from the remote repository. At the moment, just
 548     use the 'git pull' command
 549     """
 550     # 'git pull' updates the HEAD
 551     __clear_head_cache()
 552
 553     args = [repository]
 554     if refspec:
 555         args.append(refspec)
 556
 557     if __run('git pull', args) != 0:
 558         raise GitException, 'Failed "git pull %s"' % repository
 559
 560 def apply_patch(filename = None, base = None):
 561     """Apply a patch onto the current or given index. There must not
 562     be any local changes in the tree, otherwise the command fails
 563     """
 564     def __apply_patch():
 565         if filename:
 566             return __run('git-apply --index', [filename]) == 0
 567         else:
 568             try:
 569                 _input('git-apply --index', sys.stdin)
 570             except GitException:
 571                 return False
 572             return True
 573
 574     os.system('git-update-index --refresh > /dev/null')
 575
 576     if base:
 577         orig_head = get_head()
 578         switch(base)
 579
 580     if not __apply_patch():
 581         if base:
 582             switch(orig_head)
 583         raise GitException, 'Patch does not apply cleanly'
 584     elif base:
 585         top = commit(message = 'temporary commit used for applying a patch',
 586                      parents = [base])
 587         switch(orig_head)
 588         merge(base, orig_head, top)
 589
 590 def clone(repository, local_dir):
 591     """Clone a remote repository. At the moment, just use the
 592     'git clone' script
 593     """
 594     if __run('git clone', [repository, local_dir]) != 0:
 595         raise GitException, 'Failed "git clone %s %s"' \
 596               % (repository, local_dir)