stgit/stack.py

   1 """Basic quilt-like functionality
   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, re
  22
  23 from stgit.utils import *
  24 from stgit import git, basedir, templates
  25 from stgit.config import config
  26
  27
  28 # stack exception class
  29 class StackException(Exception):
  30     pass
  31
  32 class FilterUntil:
  33     def __init__(self):
  34         self.should_print = True
  35     def __call__(self, x, until_test, prefix):
  36         if until_test(x):
  37             self.should_print = False
  38         if self.should_print:
  39             return x[0:len(prefix)] != prefix
  40         return False
  41
  42 #
  43 # Functions
  44 #
  45 __comment_prefix = 'STG:'
  46 __patch_prefix = 'STG_PATCH:'
  47
  48 def __clean_comments(f):
  49     """Removes lines marked for status in a commit file
  50     """
  51     f.seek(0)
  52
  53     # remove status-prefixed lines
  54     lines = f.readlines()
  55
  56     patch_filter = FilterUntil()
  57     until_test = lambda t: t == (__patch_prefix + '\n')
  58     lines = [l for l in lines if patch_filter(l, until_test, __comment_prefix)]
  59
  60     # remove empty lines at the end
  61     while len(lines) != 0 and lines[-1] == '\n':
  62         del lines[-1]
  63
  64     f.seek(0); f.truncate()
  65     f.writelines(lines)
  66
  67 def edit_file(series, line, comment, show_patch = True):
  68     fname = '.stgitmsg.txt'
  69     tmpl = templates.get_template('patchdescr.tmpl')
  70
  71     f = file(fname, 'w+')
  72     if line:
  73         print >> f, line
  74     elif tmpl:
  75         print >> f, tmpl,
  76     else:
  77         print >> f
  78     print >> f, __comment_prefix, comment
  79     print >> f, __comment_prefix, \
  80           'Lines prefixed with "%s" will be automatically removed.' \
  81           % __comment_prefix
  82     print >> f, __comment_prefix, \
  83           'Trailing empty lines will be automatically removed.'
  84
  85     if show_patch:
  86        print >> f, __patch_prefix
  87        # series.get_patch(series.get_current()).get_top()
  88        git.diff([], series.get_patch(series.get_current()).get_bottom(), None, f)
  89
  90     #Vim modeline must be near the end.
  91     print >> f, __comment_prefix, 'vi: set textwidth=75 filetype=diff nobackup:'
  92     f.close()
  93
  94     call_editor(fname)
  95
  96     f = file(fname, 'r+')
  97
  98     __clean_comments(f)
  99     f.seek(0)
 100     result = f.read()
 101
 102     f.close()
 103     os.remove(fname)
 104
 105     return result
 106
 107 #
 108 # Classes
 109 #
 110
 111 class StgitObject:
 112     """An object with stgit-like properties stored as files in a directory
 113     """
 114     def _set_dir(self, dir):
 115         self.__dir = dir
 116     def _dir(self):
 117         return self.__dir
 118
 119     def create_empty_field(self, name):
 120         create_empty_file(os.path.join(self.__dir, name))
 121
 122     def _get_field(self, name, multiline = False):
 123         id_file = os.path.join(self.__dir, name)
 124         if os.path.isfile(id_file):
 125             line = read_string(id_file, multiline)
 126             if line == '':
 127                 return None
 128             else:
 129                 return line
 130         else:
 131             return None
 132
 133     def _set_field(self, name, value, multiline = False):
 134         fname = os.path.join(self.__dir, name)
 135         if value and value != '':
 136             write_string(fname, value, multiline)
 137         elif os.path.isfile(fname):
 138             os.remove(fname)
 139
 140
 141 class Patch(StgitObject):
 142     """Basic patch implementation
 143     """
 144     def __init__(self, name, series_dir, refs_dir):
 145         self.__series_dir = series_dir
 146         self.__name = name
 147         self._set_dir(os.path.join(self.__series_dir, self.__name))
 148         self.__refs_dir = refs_dir
 149         self.__top_ref_file = os.path.join(self.__refs_dir, self.__name)
 150         self.__log_ref_file = os.path.join(self.__refs_dir,
 151                                            self.__name + '.log')
 152
 153     def create(self):
 154         os.mkdir(self._dir())
 155         self.create_empty_field('bottom')
 156         self.create_empty_field('top')
 157
 158     def delete(self):
 159         for f in os.listdir(self._dir()):
 160             os.remove(os.path.join(self._dir(), f))
 161         os.rmdir(self._dir())
 162         os.remove(self.__top_ref_file)
 163         if os.path.exists(self.__log_ref_file):
 164             os.remove(self.__log_ref_file)
 165
 166     def get_name(self):
 167         return self.__name
 168
 169     def rename(self, newname):
 170         olddir = self._dir()
 171         old_top_ref_file = self.__top_ref_file
 172         old_log_ref_file = self.__log_ref_file
 173         self.__name = newname
 174         self._set_dir(os.path.join(self.__series_dir, self.__name))
 175         self.__top_ref_file = os.path.join(self.__refs_dir, self.__name)
 176         self.__log_ref_file = os.path.join(self.__refs_dir,
 177                                            self.__name + '.log')
 178
 179         os.rename(olddir, self._dir())
 180         os.rename(old_top_ref_file, self.__top_ref_file)
 181         if os.path.exists(old_log_ref_file):
 182             os.rename(old_log_ref_file, self.__log_ref_file)
 183
 184     def __update_top_ref(self, ref):
 185         write_string(self.__top_ref_file, ref)
 186
 187     def __update_log_ref(self, ref):
 188         write_string(self.__log_ref_file, ref)
 189
 190     def update_top_ref(self):
 191         top = self.get_top()
 192         if top:
 193             self.__update_top_ref(top)
 194
 195     def get_old_bottom(self):
 196         return self._get_field('bottom.old')
 197
 198     def get_bottom(self):
 199         return self._get_field('bottom')
 200
 201     def set_bottom(self, value, backup = False):
 202         if backup:
 203             curr = self._get_field('bottom')
 204             self._set_field('bottom.old', curr)
 205         self._set_field('bottom', value)
 206
 207     def get_old_top(self):
 208         return self._get_field('top.old')
 209
 210     def get_top(self):
 211         return self._get_field('top')
 212
 213     def set_top(self, value, backup = False):
 214         if backup:
 215             curr = self._get_field('top')
 216             self._set_field('top.old', curr)
 217         self._set_field('top', value)
 218         self.__update_top_ref(value)
 219
 220     def restore_old_boundaries(self):
 221         bottom = self._get_field('bottom.old')
 222         top = self._get_field('top.old')
 223
 224         if top and bottom:
 225             self._set_field('bottom', bottom)
 226             self._set_field('top', top)
 227             self.__update_top_ref(top)
 228             return True
 229         else:
 230             return False
 231
 232     def get_description(self):
 233         return self._get_field('description', True)
 234
 235     def set_description(self, line):
 236         self._set_field('description', line, True)
 237
 238     def get_authname(self):
 239         return self._get_field('authname')
 240
 241     def set_authname(self, name):
 242         self._set_field('authname', name or git.author().name)
 243
 244     def get_authemail(self):
 245         return self._get_field('authemail')
 246
 247     def set_authemail(self, email):
 248         self._set_field('authemail', email or git.author().email)
 249
 250     def get_authdate(self):
 251         return self._get_field('authdate')
 252
 253     def set_authdate(self, date):
 254         self._set_field('authdate', date or git.author().date)
 255
 256     def get_commname(self):
 257         return self._get_field('commname')
 258
 259     def set_commname(self, name):
 260         self._set_field('commname', name or git.committer().name)
 261
 262     def get_commemail(self):
 263         return self._get_field('commemail')
 264
 265     def set_commemail(self, email):
 266         self._set_field('commemail', email or git.committer().email)
 267
 268     def get_log(self):
 269         return self._get_field('log')
 270
 271     def set_log(self, value, backup = False):
 272         self._set_field('log', value)
 273         self.__update_log_ref(value)
 274
 275
 276 class Series(StgitObject):
 277     """Class including the operations on series
 278     """
 279     def __init__(self, name = None):
 280         """Takes a series name as the parameter.
 281         """
 282         try:
 283             if name:
 284                 self.__name = name
 285             else:
 286                 self.__name = git.get_head_file()
 287             self.__base_dir = basedir.get()
 288         except git.GitException, ex:
 289             raise StackException, 'GIT tree not initialised: %s' % ex
 290
 291         self._set_dir(os.path.join(self.__base_dir, 'patches', self.__name))
 292         self.__refs_dir = os.path.join(self.__base_dir, 'refs', 'patches',
 293                                        self.__name)
 294         self.__base_file = os.path.join(self.__base_dir, 'refs', 'bases',
 295                                         self.__name)
 296
 297         self.__applied_file = os.path.join(self._dir(), 'applied')
 298         self.__unapplied_file = os.path.join(self._dir(), 'unapplied')
 299         self.__hidden_file = os.path.join(self._dir(), 'hidden')
 300         self.__current_file = os.path.join(self._dir(), 'current')
 301         self.__descr_file = os.path.join(self._dir(), 'description')
 302
 303         # where this series keeps its patches
 304         self.__patch_dir = os.path.join(self._dir(), 'patches')
 305         if not os.path.isdir(self.__patch_dir):
 306             self.__patch_dir = self._dir()
 307
 308         # if no __refs_dir, create and populate it (upgrade old repositories)
 309         if self.is_initialised() and not os.path.isdir(self.__refs_dir):
 310             os.makedirs(self.__refs_dir)
 311             for patch in self.get_applied() + self.get_unapplied():
 312                 self.get_patch(patch).update_top_ref()
 313
 314         # trash directory
 315         self.__trash_dir = os.path.join(self._dir(), 'trash')
 316         if self.is_initialised() and not os.path.isdir(self.__trash_dir):
 317             os.makedirs(self.__trash_dir)
 318
 319     def __patch_name_valid(self, name):
 320         """Raise an exception if the patch name is not valid.
 321         """
 322         if not name or re.search('[^\w.-]', name):
 323             raise StackException, 'Invalid patch name: "%s"' % name
 324
 325     def get_branch(self):
 326         """Return the branch name for the Series object
 327         """
 328         return self.__name
 329
 330     def __set_current(self, name):
 331         """Sets the topmost patch
 332         """
 333         self._set_field('current', name)
 334
 335     def get_patch(self, name):
 336         """Return a Patch object for the given name
 337         """
 338         return Patch(name, self.__patch_dir, self.__refs_dir)
 339
 340     def get_current_patch(self):
 341         """Return a Patch object representing the topmost patch, or
 342         None if there is no such patch."""
 343         crt = self.get_current()
 344         if not crt:
 345             return None
 346         return Patch(crt, self.__patch_dir, self.__refs_dir)
 347
 348     def get_current(self):
 349         """Return the name of the topmost patch, or None if there is
 350         no such patch."""
 351         name = self._get_field('current')
 352         if name == '':
 353             return None
 354         else:
 355             return name
 356
 357     def get_applied(self):
 358         if not os.path.isfile(self.__applied_file):
 359             raise StackException, 'Branch "%s" not initialised' % self.__name
 360         f = file(self.__applied_file)
 361         names = [line.strip() for line in f.readlines()]
 362         f.close()
 363         return names
 364
 365     def get_unapplied(self):
 366         if not os.path.isfile(self.__unapplied_file):
 367             raise StackException, 'Branch "%s" not initialised' % self.__name
 368         f = file(self.__unapplied_file)
 369         names = [line.strip() for line in f.readlines()]
 370         f.close()
 371         return names
 372
 373     def get_hidden(self):
 374         if not os.path.isfile(self.__hidden_file):
 375             return []
 376         f = file(self.__hidden_file)
 377         names = [line.strip() for line in f.readlines()]
 378         f.close()
 379         return names
 380
 381     def get_base_file(self):
 382         self.__begin_stack_check()
 383         return self.__base_file
 384
 385     def get_base(self):
 386         return read_string(self.get_base_file())
 387
 388     def get_head(self):
 389         """Return the head of the branch
 390         """
 391         crt = self.get_current_patch()
 392         if crt:
 393             return crt.get_top()
 394         else:
 395             return self.get_base()
 396
 397     def get_protected(self):
 398         return os.path.isfile(os.path.join(self._dir(), 'protected'))
 399
 400     def protect(self):
 401         protect_file = os.path.join(self._dir(), 'protected')
 402         if not os.path.isfile(protect_file):
 403             create_empty_file(protect_file)
 404
 405     def unprotect(self):
 406         protect_file = os.path.join(self._dir(), 'protected')
 407         if os.path.isfile(protect_file):
 408             os.remove(protect_file)
 409
 410     def get_description(self):
 411         return self._get_field('description') or ''
 412
 413     def set_description(self, line):
 414         self._set_field('description', line)
 415
 416     def get_parent_remote(self):
 417         value = config.get('branch.%s.remote' % self.__name)
 418         if value:
 419             return value
 420         elif 'origin' in git.remotes_list():
 421             print 'Notice: no parent remote declared for stack "%s", ' \
 422                   'defaulting to "origin". Consider setting "branch.%s.remote" ' \
 423                   'and "branch.%s.merge" with "git repo-config".' \
 424                   % (self.__name, self.__name, self.__name)
 425             return 'origin'
 426         else:
 427             raise StackException, 'Cannot find a parent remote for "%s"' % self.__name
 428
 429     def __set_parent_remote(self, remote):
 430         value = config.set('branch.%s.remote' % self.__name, remote)
 431
 432     def get_parent_branch(self):
 433         value = config.get('branch.%s.stgit.parentbranch' % self.__name)
 434         if value:
 435             return value
 436         elif git.rev_parse('heads/origin'):
 437             print 'Notice: no parent branch declared for stack "%s", ' \
 438                   'defaulting to "heads/origin". Consider setting ' \
 439                   '"branch.%s.stgit.parentbranch" with "git repo-config".' \
 440                   % (self.__name, self.__name)
 441             return 'heads/origin'
 442         else:
 443             raise StackException, 'Cannot find a parent branch for "%s"' % self.__name
 444
 445     def __set_parent_branch(self, name):
 446         if config.get('branch.%s.remote' % self.__name):
 447             # Never set merge if remote is not set to avoid
 448             # possibly-erroneous lookups into 'origin'
 449             config.set('branch.%s.merge' % self.__name, name)
 450         config.set('branch.%s.stgit.parentbranch' % self.__name, name)
 451
 452     def set_parent(self, remote, localbranch):
 453         # policy: record local branches as remote='.'
 454         recordremote = remote or '.'
 455         if localbranch:
 456             self.__set_parent_remote(recordremote)
 457             self.__set_parent_branch(localbranch)
 458         # We'll enforce this later
 459 #         else:
 460 #             raise StackException, 'Parent branch (%s) should be specified for %s' % localbranch, self.__name
 461
 462     def __patch_is_current(self, patch):
 463         return patch.get_name() == self.get_current()
 464
 465     def patch_applied(self, name):
 466         """Return true if the patch exists in the applied list
 467         """
 468         return name in self.get_applied()
 469
 470     def patch_unapplied(self, name):
 471         """Return true if the patch exists in the unapplied list
 472         """
 473         return name in self.get_unapplied()
 474
 475     def patch_hidden(self, name):
 476         """Return true if the patch is hidden.
 477         """
 478         return name in self.get_hidden()
 479
 480     def patch_exists(self, name):
 481         """Return true if there is a patch with the given name, false
 482         otherwise."""
 483         return self.patch_applied(name) or self.patch_unapplied(name)
 484
 485     def __begin_stack_check(self):
 486         """Save the current HEAD into .git/refs/heads/base if the stack
 487         is empty
 488         """
 489         if len(self.get_applied()) == 0:
 490             head = git.get_head()
 491             write_string(self.__base_file, head)
 492
 493     def __end_stack_check(self):
 494         """Remove .git/refs/heads/base if the stack is empty.
 495         This warning should never happen
 496         """
 497         if len(self.get_applied()) == 0 \
 498            and read_string(self.__base_file) != git.get_head():
 499             print 'Warning: stack empty but the HEAD and base are different'
 500
 501     def head_top_equal(self):
 502         """Return true if the head and the top are the same
 503         """
 504         crt = self.get_current_patch()
 505         if not crt:
 506             # we don't care, no patches applied
 507             return True
 508         return git.get_head() == crt.get_top()
 509
 510     def is_initialised(self):
 511         """Checks if series is already initialised
 512         """
 513         return os.path.isdir(self.__patch_dir)
 514
 515     def init(self, create_at=False, parent_remote=None, parent_branch=None):
 516         """Initialises the stgit series
 517         """
 518         if os.path.exists(self.__patch_dir):
 519             raise StackException, self.__patch_dir + ' already exists'
 520         if os.path.exists(self.__refs_dir):
 521             raise StackException, self.__refs_dir + ' already exists'
 522         if os.path.exists(self.__base_file):
 523             raise StackException, self.__base_file + ' already exists'
 524
 525         if (create_at!=False):
 526             git.create_branch(self.__name, create_at)
 527
 528         os.makedirs(self.__patch_dir)
 529
 530         self.set_parent(parent_remote, parent_branch)
 531
 532         create_dirs(os.path.join(self.__base_dir, 'refs', 'bases'))
 533
 534         self.create_empty_field('applied')
 535         self.create_empty_field('unapplied')
 536         self.create_empty_field('description')
 537         os.makedirs(os.path.join(self._dir(), 'patches'))
 538         os.makedirs(self.__refs_dir)
 539         self.__begin_stack_check()
 540         self._set_field('orig-base', git.get_head())
 541
 542     def convert(self):
 543         """Either convert to use a separate patch directory, or
 544         unconvert to place the patches in the same directory with
 545         series control files
 546         """
 547         if self.__patch_dir == self._dir():
 548             print 'Converting old-style to new-style...',
 549             sys.stdout.flush()
 550
 551             self.__patch_dir = os.path.join(self._dir(), 'patches')
 552             os.makedirs(self.__patch_dir)
 553
 554             for p in self.get_applied() + self.get_unapplied():
 555                 src = os.path.join(self._dir(), p)
 556                 dest = os.path.join(self.__patch_dir, p)
 557                 os.rename(src, dest)
 558
 559             print 'done'
 560
 561         else:
 562             print 'Converting new-style to old-style...',
 563             sys.stdout.flush()
 564
 565             for p in self.get_applied() + self.get_unapplied():
 566                 src = os.path.join(self.__patch_dir, p)
 567                 dest = os.path.join(self._dir(), p)
 568                 os.rename(src, dest)
 569
 570             if not os.listdir(self.__patch_dir):
 571                 os.rmdir(self.__patch_dir)
 572                 print 'done'
 573             else:
 574                 print 'Patch directory %s is not empty.' % self.__patch_dir
 575
 576             self.__patch_dir = self._dir()
 577
 578     def rename(self, to_name):
 579         """Renames a series
 580         """
 581         to_stack = Series(to_name)
 582
 583         if to_stack.is_initialised():
 584             raise StackException, '"%s" already exists' % to_stack.get_branch()
 585         if os.path.exists(to_stack.__base_file):
 586             os.remove(to_stack.__base_file)
 587
 588         git.rename_branch(self.__name, to_name)
 589
 590         if os.path.isdir(self._dir()):
 591             rename(os.path.join(self.__base_dir, 'patches'),
 592                    self.__name, to_stack.__name)
 593         if os.path.exists(self.__base_file):
 594             rename(os.path.join(self.__base_dir, 'refs', 'bases'),
 595                    self.__name, to_stack.__name)
 596         if os.path.exists(self.__refs_dir):
 597             rename(os.path.join(self.__base_dir, 'refs', 'patches'),
 598                    self.__name, to_stack.__name)
 599
 600         # Rename the config section
 601         config.rename_section("branch.%s" % self.__name,
 602                               "branch.%s" % to_name)
 603
 604         self.__init__(to_name)
 605
 606     def clone(self, target_series):
 607         """Clones a series
 608         """
 609         try:
 610             # allow cloning of branches not under StGIT control
 611             base = self.get_base()
 612         except:
 613             base = git.get_head()
 614         Series(target_series).init(create_at = base)
 615         new_series = Series(target_series)
 616
 617         # generate an artificial description file
 618         new_series.set_description('clone of "%s"' % self.__name)
 619
 620         # clone self's entire series as unapplied patches
 621         try:
 622             # allow cloning of branches not under StGIT control
 623             applied = self.get_applied()
 624             unapplied = self.get_unapplied()
 625             patches = applied + unapplied
 626             patches.reverse()
 627         except:
 628             patches = applied = unapplied = []
 629         for p in patches:
 630             patch = self.get_patch(p)
 631             new_series.new_patch(p, message = patch.get_description(),
 632                                  can_edit = False, unapplied = True,
 633                                  bottom = patch.get_bottom(),
 634                                  top = patch.get_top(),
 635                                  author_name = patch.get_authname(),
 636                                  author_email = patch.get_authemail(),
 637                                  author_date = patch.get_authdate())
 638
 639         # fast forward the cloned series to self's top
 640         new_series.forward_patches(applied)
 641
 642         # Clone parent informations
 643         value = config.get('branch.%s.remote' % self.__name)
 644         if value:
 645             config.set('branch.%s.remote' % target_series, value)
 646
 647         value = config.get('branch.%s.merge' % self.__name)
 648         if value:
 649             config.set('branch.%s.merge' % target_series, value)
 650
 651         value = config.get('branch.%s.stgit.parentbranch' % self.__name)
 652         if value:
 653             config.set('branch.%s.stgit.parentbranch' % target_series, value)
 654
 655     def delete(self, force = False):
 656         """Deletes an stgit series
 657         """
 658         if self.is_initialised():
 659             patches = self.get_unapplied() + self.get_applied()
 660             if not force and patches:
 661                 raise StackException, \
 662                       'Cannot delete: the series still contains patches'
 663             for p in patches:
 664                 Patch(p, self.__patch_dir, self.__refs_dir).delete()
 665
 666             # remove the trash directory
 667             for fname in os.listdir(self.__trash_dir):
 668                 os.remove(fname)
 669             os.rmdir(self.__trash_dir)
 670
 671             # FIXME: find a way to get rid of those manual removals
 672             # (move functionality to StgitObject ?)
 673             if os.path.exists(self.__applied_file):
 674                 os.remove(self.__applied_file)
 675             if os.path.exists(self.__unapplied_file):
 676                 os.remove(self.__unapplied_file)
 677             if os.path.exists(self.__hidden_file):
 678                 os.remove(self.__hidden_file)
 679             if os.path.exists(self.__current_file):
 680                 os.remove(self.__current_file)
 681             if os.path.exists(self.__descr_file):
 682                 os.remove(self.__descr_file)
 683             if os.path.exists(self._dir()+'/orig-base'):
 684                 os.remove(self._dir()+'/orig-base')
 685
 686             if not os.listdir(self.__patch_dir):
 687                 os.rmdir(self.__patch_dir)
 688             else:
 689                 print 'Patch directory %s is not empty.' % self.__patch_dir
 690
 691             try:
 692                 os.removedirs(self._dir())
 693             except OSError:
 694                 raise StackException, 'Series directory %s is not empty.' % self._dir()
 695
 696             try:
 697                 os.removedirs(self.__refs_dir)
 698             except OSError:
 699                 print 'Refs directory %s is not empty.' % self.__refs_dir
 700
 701         if os.path.exists(self.__base_file):
 702             remove_file_and_dirs(
 703                 os.path.join(self.__base_dir, 'refs', 'bases'), self.__name)
 704
 705     def refresh_patch(self, files = None, message = None, edit = False,
 706                       show_patch = False,
 707                       cache_update = True,
 708                       author_name = None, author_email = None,
 709                       author_date = None,
 710                       committer_name = None, committer_email = None,
 711                       backup = False, sign_str = None, log = 'refresh'):
 712         """Generates a new commit for the given patch
 713         """
 714         name = self.get_current()
 715         if not name:
 716             raise StackException, 'No patches applied'
 717
 718         patch = Patch(name, self.__patch_dir, self.__refs_dir)
 719
 720         descr = patch.get_description()
 721         if not (message or descr):
 722             edit = True
 723             descr = ''
 724         elif message:
 725             descr = message
 726
 727         if not message and edit:
 728             descr = edit_file(self, descr.rstrip(), \
 729                               'Please edit the description for patch "%s" ' \
 730                               'above.' % name, show_patch)
 731
 732         if not author_name:
 733             author_name = patch.get_authname()
 734         if not author_email:
 735             author_email = patch.get_authemail()
 736         if not author_date:
 737             author_date = patch.get_authdate()
 738         if not committer_name:
 739             committer_name = patch.get_commname()
 740         if not committer_email:
 741             committer_email = patch.get_commemail()
 742
 743         if sign_str:
 744             descr = descr.rstrip()
 745             if descr.find("\nSigned-off-by:") < 0 \
 746                and descr.find("\nAcked-by:") < 0:
 747                 descr = descr + "\n"
 748
 749             descr = '%s\n%s: %s <%s>\n' % (descr, sign_str,
 750                                            committer_name, committer_email)
 751
 752         bottom = patch.get_bottom()
 753
 754         commit_id = git.commit(files = files,
 755                                message = descr, parents = [bottom],
 756                                cache_update = cache_update,
 757                                allowempty = True,
 758                                author_name = author_name,
 759                                author_email = author_email,
 760                                author_date = author_date,
 761                                committer_name = committer_name,
 762                                committer_email = committer_email)
 763
 764         patch.set_bottom(bottom, backup = backup)
 765         patch.set_top(commit_id, backup = backup)
 766         patch.set_description(descr)
 767         patch.set_authname(author_name)
 768         patch.set_authemail(author_email)
 769         patch.set_authdate(author_date)
 770         patch.set_commname(committer_name)
 771         patch.set_commemail(committer_email)
 772
 773         if log:
 774             self.log_patch(patch, log)
 775
 776         return commit_id
 777
 778     def undo_refresh(self):
 779         """Undo the patch boundaries changes caused by 'refresh'
 780         """
 781         name = self.get_current()
 782         assert(name)
 783
 784         patch = Patch(name, self.__patch_dir, self.__refs_dir)
 785         old_bottom = patch.get_old_bottom()
 786         old_top = patch.get_old_top()
 787
 788         # the bottom of the patch is not changed by refresh. If the
 789         # old_bottom is different, there wasn't any previous 'refresh'
 790         # command (probably only a 'push')
 791         if old_bottom != patch.get_bottom() or old_top == patch.get_top():
 792             raise StackException, 'No undo information available'
 793
 794         git.reset(tree_id = old_top, check_out = False)
 795         if patch.restore_old_boundaries():
 796             self.log_patch(patch, 'undo')
 797
 798     def new_patch(self, name, message = None, can_edit = True,
 799                   unapplied = False, show_patch = False,
 800                   top = None, bottom = None,
 801                   author_name = None, author_email = None, author_date = None,
 802                   committer_name = None, committer_email = None,
 803                   before_existing = False, refresh = True):
 804         """Creates a new patch
 805         """
 806         self.__patch_name_valid(name)
 807
 808         if self.patch_applied(name) or self.patch_unapplied(name):
 809             raise StackException, 'Patch "%s" already exists' % name
 810
 811         if not message and can_edit:
 812             descr = edit_file(self, None, \
 813                               'Please enter the description for patch "%s" ' \
 814                               'above.' % name, show_patch)
 815         else:
 816             descr = message
 817
 818         head = git.get_head()
 819
 820         self.__begin_stack_check()
 821
 822         patch = Patch(name, self.__patch_dir, self.__refs_dir)
 823         patch.create()
 824
 825         if bottom:
 826             patch.set_bottom(bottom)
 827         else:
 828             patch.set_bottom(head)
 829         if top:
 830             patch.set_top(top)
 831         else:
 832             patch.set_top(head)
 833
 834         patch.set_description(descr)
 835         patch.set_authname(author_name)
 836         patch.set_authemail(author_email)
 837         patch.set_authdate(author_date)
 838         patch.set_commname(committer_name)
 839         patch.set_commemail(committer_email)
 840
 841         if unapplied:
 842             self.log_patch(patch, 'new')
 843
 844             patches = [patch.get_name()] + self.get_unapplied()
 845
 846             f = file(self.__unapplied_file, 'w+')
 847             f.writelines([line + '\n' for line in patches])
 848             f.close()
 849         elif before_existing:
 850             self.log_patch(patch, 'new')
 851
 852             insert_string(self.__applied_file, patch.get_name())
 853             if not self.get_current():
 854                 self.__set_current(name)
 855         else:
 856             append_string(self.__applied_file, patch.get_name())
 857             self.__set_current(name)
 858             if refresh:
 859                 self.refresh_patch(cache_update = False, log = 'new')
 860
 861     def delete_patch(self, name):
 862         """Deletes a patch
 863         """
 864         self.__patch_name_valid(name)
 865         patch = Patch(name, self.__patch_dir, self.__refs_dir)
 866
 867         if self.__patch_is_current(patch):
 868             self.pop_patch(name)
 869         elif self.patch_applied(name):
 870             raise StackException, 'Cannot remove an applied patch, "%s", ' \
 871                   'which is not current' % name
 872         elif not name in self.get_unapplied():
 873             raise StackException, 'Unknown patch "%s"' % name
 874
 875         # save the commit id to a trash file
 876         write_string(os.path.join(self.__trash_dir, name), patch.get_top())
 877
 878         patch.delete()
 879
 880         unapplied = self.get_unapplied()
 881         unapplied.remove(name)
 882         f = file(self.__unapplied_file, 'w+')
 883         f.writelines([line + '\n' for line in unapplied])
 884         f.close()
 885
 886         if self.patch_hidden(name):
 887             self.unhide_patch(name)
 888
 889         self.__begin_stack_check()
 890
 891     def forward_patches(self, names):
 892         """Try to fast-forward an array of patches.
 893
 894         On return, patches in names[0:returned_value] have been pushed on the
 895         stack. Apply the rest with push_patch
 896         """
 897         unapplied = self.get_unapplied()
 898         self.__begin_stack_check()
 899
 900         forwarded = 0
 901         top = git.get_head()
 902
 903         for name in names:
 904             assert(name in unapplied)
 905
 906             patch = Patch(name, self.__patch_dir, self.__refs_dir)
 907
 908             head = top
 909             bottom = patch.get_bottom()
 910             top = patch.get_top()
 911
 912             # top != bottom always since we have a commit for each patch
 913             if head == bottom:
 914                 # reset the backup information. No logging since the
 915                 # patch hasn't changed
 916                 patch.set_bottom(head, backup = True)
 917                 patch.set_top(top, backup = True)
 918
 919             else:
 920                 head_tree = git.get_commit(head).get_tree()
 921                 bottom_tree = git.get_commit(bottom).get_tree()
 922                 if head_tree == bottom_tree:
 923                     # We must just reparent this patch and create a new commit
 924                     # for it
 925                     descr = patch.get_description()
 926                     author_name = patch.get_authname()
 927                     author_email = patch.get_authemail()
 928                     author_date = patch.get_authdate()
 929                     committer_name = patch.get_commname()
 930                     committer_email = patch.get_commemail()
 931
 932                     top_tree = git.get_commit(top).get_tree()
 933
 934                     top = git.commit(message = descr, parents = [head],
 935                                      cache_update = False,
 936                                      tree_id = top_tree,
 937                                      allowempty = True,
 938                                      author_name = author_name,
 939                                      author_email = author_email,
 940                                      author_date = author_date,
 941                                      committer_name = committer_name,
 942                                      committer_email = committer_email)
 943
 944                     patch.set_bottom(head, backup = True)
 945                     patch.set_top(top, backup = True)
 946
 947                     self.log_patch(patch, 'push(f)')
 948                 else:
 949                     top = head
 950                     # stop the fast-forwarding, must do a real merge
 951                     break
 952
 953             forwarded+=1
 954             unapplied.remove(name)
 955
 956         if forwarded == 0:
 957             return 0
 958
 959         git.switch(top)
 960
 961         append_strings(self.__applied_file, names[0:forwarded])
 962
 963         f = file(self.__unapplied_file, 'w+')
 964         f.writelines([line + '\n' for line in unapplied])
 965         f.close()
 966
 967         self.__set_current(name)
 968
 969         return forwarded
 970
 971     def merged_patches(self, names):
 972         """Test which patches were merged upstream by reverse-applying
 973         them in reverse order. The function returns the list of
 974         patches detected to have been applied. The state of the tree
 975         is restored to the original one
 976         """
 977         patches = [Patch(name, self.__patch_dir, self.__refs_dir)
 978                    for name in names]
 979         patches.reverse()
 980
 981         merged = []
 982         for p in patches:
 983             if git.apply_diff(p.get_top(), p.get_bottom()):
 984                 merged.append(p.get_name())
 985         merged.reverse()
 986
 987         git.reset()
 988
 989         return merged
 990
 991     def push_patch(self, name, empty = False):
 992         """Pushes a patch on the stack
 993         """
 994         unapplied = self.get_unapplied()
 995         assert(name in unapplied)
 996
 997         self.__begin_stack_check()
 998
 999         patch = Patch(name, self.__patch_dir, self.__refs_dir)
1000
1001         head = git.get_head()
1002         bottom = patch.get_bottom()
1003         top = patch.get_top()
1004
1005         ex = None
1006         modified = False
1007
1008         # top != bottom always since we have a commit for each patch
1009         if empty:
1010             # just make an empty patch (top = bottom = HEAD). This
1011             # option is useful to allow undoing already merged
1012             # patches. The top is updated by refresh_patch since we
1013             # need an empty commit
1014             patch.set_bottom(head, backup = True)
1015             patch.set_top(head, backup = True)
1016             modified = True
1017         elif head == bottom:
1018             # reset the backup information. No need for logging
1019             patch.set_bottom(bottom, backup = True)
1020             patch.set_top(top, backup = True)
1021
1022             git.switch(top)
1023         else:
1024             # new patch needs to be refreshed.
1025             # The current patch is empty after merge.
1026             patch.set_bottom(head, backup = True)
1027             patch.set_top(head, backup = True)
1028
1029             # Try the fast applying first. If this fails, fall back to the
1030             # three-way merge
1031             if not git.apply_diff(bottom, top):
1032                 # if git.apply_diff() fails, the patch requires a diff3
1033                 # merge and can be reported as modified
1034                 modified = True
1035
1036                 # merge can fail but the patch needs to be pushed
1037                 try:
1038                     git.merge(bottom, head, top, recursive = True)
1039                 except git.GitException, ex:
1040                     print >> sys.stderr, \
1041                           'The merge failed during "push". ' \
1042                           'Use "refresh" after fixing the conflicts'
1043
1044         append_string(self.__applied_file, name)
1045
1046         unapplied.remove(name)
1047         f = file(self.__unapplied_file, 'w+')
1048         f.writelines([line + '\n' for line in unapplied])
1049         f.close()
1050
1051         self.__set_current(name)
1052
1053         # head == bottom case doesn't need to refresh the patch
1054         if empty or head != bottom:
1055             if not ex:
1056                 # if the merge was OK and no conflicts, just refresh the patch
1057                 # The GIT cache was already updated by the merge operation
1058                 if modified:
1059                     log = 'push(m)'
1060                 else:
1061                     log = 'push'
1062                 self.refresh_patch(cache_update = False, log = log)
1063             else:
1064                 # we store the correctly merged files only for
1065                 # tracking the conflict history. Note that the
1066                 # git.merge() operations should always leave the index
1067                 # in a valid state (i.e. only stage 0 files)
1068                 self.refresh_patch(cache_update = False, log = 'push(c)')
1069                 raise StackException, str(ex)
1070
1071         return modified
1072
1073     def undo_push(self):
1074         name = self.get_current()
1075         assert(name)
1076
1077         patch = Patch(name, self.__patch_dir, self.__refs_dir)
1078         old_bottom = patch.get_old_bottom()
1079         old_top = patch.get_old_top()
1080
1081         # the top of the patch is changed by a push operation only
1082         # together with the bottom (otherwise the top was probably
1083         # modified by 'refresh'). If they are both unchanged, there
1084         # was a fast forward
1085         if old_bottom == patch.get_bottom() and old_top != patch.get_top():
1086             raise StackException, 'No undo information available'
1087
1088         git.reset()
1089         self.pop_patch(name)
1090         ret = patch.restore_old_boundaries()
1091         if ret:
1092             self.log_patch(patch, 'undo')
1093
1094         return ret
1095
1096     def pop_patch(self, name, keep = False):
1097         """Pops the top patch from the stack
1098         """
1099         applied = self.get_applied()
1100         applied.reverse()
1101         assert(name in applied)
1102
1103         patch = Patch(name, self.__patch_dir, self.__refs_dir)
1104
1105         # only keep the local changes
1106         if keep and not git.apply_diff(git.get_head(), patch.get_bottom()):
1107             raise StackException, \
1108                   'Failed to pop patches while preserving the local changes'
1109
1110         git.switch(patch.get_bottom(), keep)
1111
1112         # save the new applied list
1113         idx = applied.index(name) + 1
1114
1115         popped = applied[:idx]
1116         popped.reverse()
1117         unapplied = popped + self.get_unapplied()
1118
1119         f = file(self.__unapplied_file, 'w+')
1120         f.writelines([line + '\n' for line in unapplied])
1121         f.close()
1122
1123         del applied[:idx]
1124         applied.reverse()
1125
1126         f = file(self.__applied_file, 'w+')
1127         f.writelines([line + '\n' for line in applied])
1128         f.close()
1129
1130         if applied == []:
1131             self.__set_current(None)
1132         else:
1133             self.__set_current(applied[-1])
1134
1135         self.__end_stack_check()
1136
1137     def empty_patch(self, name):
1138         """Returns True if the patch is empty
1139         """
1140         self.__patch_name_valid(name)
1141         patch = Patch(name, self.__patch_dir, self.__refs_dir)
1142         bottom = patch.get_bottom()
1143         top = patch.get_top()
1144
1145         if bottom == top:
1146             return True
1147         elif git.get_commit(top).get_tree() \
1148                  == git.get_commit(bottom).get_tree():
1149             return True
1150
1151         return False
1152
1153     def rename_patch(self, oldname, newname):
1154         self.__patch_name_valid(newname)
1155
1156         applied = self.get_applied()
1157         unapplied = self.get_unapplied()
1158
1159         if oldname == newname:
1160             raise StackException, '"To" name and "from" name are the same'
1161
1162         if newname in applied or newname in unapplied:
1163             raise StackException, 'Patch "%s" already exists' % newname
1164
1165         if self.patch_hidden(oldname):
1166             self.unhide_patch(oldname)
1167             self.hide_patch(newname)
1168
1169         if oldname in unapplied:
1170             Patch(oldname, self.__patch_dir, self.__refs_dir).rename(newname)
1171             unapplied[unapplied.index(oldname)] = newname
1172
1173             f = file(self.__unapplied_file, 'w+')
1174             f.writelines([line + '\n' for line in unapplied])
1175             f.close()
1176         elif oldname in applied:
1177             Patch(oldname, self.__patch_dir, self.__refs_dir).rename(newname)
1178             if oldname == self.get_current():
1179                 self.__set_current(newname)
1180
1181             applied[applied.index(oldname)] = newname
1182
1183             f = file(self.__applied_file, 'w+')
1184             f.writelines([line + '\n' for line in applied])
1185             f.close()
1186         else:
1187             raise StackException, 'Unknown patch "%s"' % oldname
1188
1189     def log_patch(self, patch, message):
1190         """Generate a log commit for a patch
1191         """
1192         top = git.get_commit(patch.get_top())
1193         msg = '%s\t%s' % (message, top.get_id_hash())
1194
1195         old_log = patch.get_log()
1196         if old_log:
1197             parents = [old_log]
1198         else:
1199             parents = []
1200
1201         log = git.commit(message = msg, parents = parents,
1202                          cache_update = False, tree_id = top.get_tree(),
1203                          allowempty = True)
1204         patch.set_log(log)
1205
1206     def hide_patch(self, name):
1207         """Add the patch to the hidden list.
1208         """
1209         if not self.patch_exists(name):
1210             raise StackException, 'Unknown patch "%s"' % name
1211         elif self.patch_hidden(name):
1212             raise StackException, 'Patch "%s" already hidden' % name
1213
1214         append_string(self.__hidden_file, name)
1215
1216     def unhide_patch(self, name):
1217         """Add the patch to the hidden list.
1218         """
1219         if not self.patch_exists(name):
1220             raise StackException, 'Unknown patch "%s"' % name
1221         hidden = self.get_hidden()
1222         if not name in hidden:
1223             raise StackException, 'Patch "%s" not hidden' % name
1224
1225         hidden.remove(name)
1226
1227         f = file(self.__hidden_file, 'w+')
1228         f.writelines([line + '\n' for line in hidden])
1229         f.close()