1 """Basic quilt-like functionality
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
22 from email.Utils import formatdate
24 from stgit.utils import *
25 from stgit.out import *
26 from stgit import git, basedir, templates
27 from stgit.config import config
28 from shutil import copyfile
31 # stack exception class
32 class StackException(Exception):
37 self.should_print = True
38 def __call__(self, x, until_test, prefix):
40 self.should_print = False
42 return x[0:len(prefix)] != prefix
48 __comment_prefix = 'STG:'
49 __patch_prefix = 'STG_PATCH:'
51 def __clean_comments(f):
52 """Removes lines marked for status in a commit file
56 # remove status-prefixed lines
59 patch_filter = FilterUntil()
60 until_test = lambda t: t == (__patch_prefix + '\n')
61 lines = [l for l in lines if patch_filter(l, until_test, __comment_prefix)]
63 # remove empty lines at the end
64 while len(lines) != 0 and lines[-1] == '\n':
67 f.seek(0); f.truncate()
70 # TODO: move this out of the stgit.stack module, it is really for
71 # higher level commands to handle the user interaction
72 def edit_file(series, line, comment, show_patch = True):
73 fname = '.stgitmsg.txt'
74 tmpl = templates.get_template('patchdescr.tmpl')
83 print >> f, __comment_prefix, comment
84 print >> f, __comment_prefix, \
85 'Lines prefixed with "%s" will be automatically removed.' \
87 print >> f, __comment_prefix, \
88 'Trailing empty lines will be automatically removed.'
91 print >> f, __patch_prefix
92 # series.get_patch(series.get_current()).get_top()
93 diff_str = git.diff(rev1 = series.get_patch(series.get_current()).get_bottom())
96 #Vim modeline must be near the end.
97 print >> f, __comment_prefix, 'vi: set textwidth=75 filetype=diff nobackup:'
102 f = file(fname, 'r+')
118 """An object with stgit-like properties stored as files in a directory
120 def _set_dir(self, dir):
125 def create_empty_field(self, name):
126 create_empty_file(os.path.join(self.__dir, name))
128 def _get_field(self, name, multiline = False):
129 id_file = os.path.join(self.__dir, name)
130 if os.path.isfile(id_file):
131 line = read_string(id_file, multiline)
139 def _set_field(self, name, value, multiline = False):
140 fname = os.path.join(self.__dir, name)
141 if value and value != '':
142 write_string(fname, value, multiline)
143 elif os.path.isfile(fname):
147 class Patch(StgitObject):
148 """Basic patch implementation
150 def __init_refs(self):
151 self.__top_ref = self.__refs_base + '/' + self.__name
152 self.__log_ref = self.__top_ref + '.log'
154 def __init__(self, name, series_dir, refs_base):
155 self.__series_dir = series_dir
157 self._set_dir(os.path.join(self.__series_dir, self.__name))
158 self.__refs_base = refs_base
162 os.mkdir(self._dir())
163 self.create_empty_field('bottom')
164 self.create_empty_field('top')
167 for f in os.listdir(self._dir()):
168 os.remove(os.path.join(self._dir(), f))
169 os.rmdir(self._dir())
170 git.delete_ref(self.__top_ref)
171 if git.ref_exists(self.__log_ref):
172 git.delete_ref(self.__log_ref)
177 def rename(self, newname):
179 old_top_ref = self.__top_ref
180 old_log_ref = self.__log_ref
181 self.__name = newname
182 self._set_dir(os.path.join(self.__series_dir, self.__name))
185 git.rename_ref(old_top_ref, self.__top_ref)
186 if git.ref_exists(old_log_ref):
187 git.rename_ref(old_log_ref, self.__log_ref)
188 os.rename(olddir, self._dir())
190 def __update_top_ref(self, ref):
191 git.set_ref(self.__top_ref, ref)
193 def __update_log_ref(self, ref):
194 git.set_ref(self.__log_ref, ref)
196 def update_top_ref(self):
199 self.__update_top_ref(top)
201 def get_old_bottom(self):
202 return self._get_field('bottom.old')
204 def get_bottom(self):
205 return self._get_field('bottom')
207 def set_bottom(self, value, backup = False):
209 curr = self._get_field('bottom')
210 self._set_field('bottom.old', curr)
211 self._set_field('bottom', value)
213 def get_old_top(self):
214 return self._get_field('top.old')
217 return self._get_field('top')
219 def set_top(self, value, backup = False):
221 curr = self._get_field('top')
222 self._set_field('top.old', curr)
223 self._set_field('top', value)
224 self.__update_top_ref(value)
226 def restore_old_boundaries(self):
227 bottom = self._get_field('bottom.old')
228 top = self._get_field('top.old')
231 self._set_field('bottom', bottom)
232 self._set_field('top', top)
233 self.__update_top_ref(top)
238 def get_description(self):
239 return self._get_field('description', True)
241 def set_description(self, line):
242 self._set_field('description', line, True)
244 def get_authname(self):
245 return self._get_field('authname')
247 def set_authname(self, name):
248 self._set_field('authname', name or git.author().name)
250 def get_authemail(self):
251 return self._get_field('authemail')
253 def set_authemail(self, email):
254 self._set_field('authemail', email or git.author().email)
256 def get_authdate(self):
257 date = self._get_field('authdate')
261 if re.match('[0-9]+\s+[+-][0-9]+', date):
262 # Unix time (seconds) + time zone
263 secs_tz = date.split()
264 date = formatdate(int(secs_tz[0]))[:-5] + secs_tz[1]
268 def set_authdate(self, date):
269 self._set_field('authdate', date or git.author().date)
271 def get_commname(self):
272 return self._get_field('commname')
274 def set_commname(self, name):
275 self._set_field('commname', name or git.committer().name)
277 def get_commemail(self):
278 return self._get_field('commemail')
280 def set_commemail(self, email):
281 self._set_field('commemail', email or git.committer().email)
284 return self._get_field('log')
286 def set_log(self, value, backup = False):
287 self._set_field('log', value)
288 self.__update_log_ref(value)
290 # The current StGIT metadata format version.
293 class PatchSet(StgitObject):
294 def __init__(self, name = None):
299 self.set_name (git.get_head_file())
300 self.__base_dir = basedir.get()
301 except git.GitException, ex:
302 raise StackException, 'GIT tree not initialised: %s' % ex
304 self._set_dir(os.path.join(self.__base_dir, 'patches', self.get_name()))
308 def set_name(self, name):
312 return self.__base_dir
315 """Return the head of the branch
317 crt = self.get_current_patch()
321 return self.get_base()
323 def get_protected(self):
324 return os.path.isfile(os.path.join(self._dir(), 'protected'))
327 protect_file = os.path.join(self._dir(), 'protected')
328 if not os.path.isfile(protect_file):
329 create_empty_file(protect_file)
332 protect_file = os.path.join(self._dir(), 'protected')
333 if os.path.isfile(protect_file):
334 os.remove(protect_file)
336 def __branch_descr(self):
337 return 'branch.%s.description' % self.get_name()
339 def get_description(self):
340 return config.get(self.__branch_descr()) or ''
342 def set_description(self, line):
344 config.set(self.__branch_descr(), line)
346 config.unset(self.__branch_descr())
348 def head_top_equal(self):
349 """Return true if the head and the top are the same
351 crt = self.get_current_patch()
353 # we don't care, no patches applied
355 return git.get_head() == crt.get_top()
357 def is_initialised(self):
358 """Checks if series is already initialised
360 return bool(config.get(self.format_version_key()))
363 def shortlog(patches):
364 log = ''.join(Run('git-log', '--pretty=short',
365 p.get_top(), '^%s' % p.get_bottom()).raw_output()
367 return Run('git-shortlog').raw_input(log).raw_output()
369 class Series(PatchSet):
370 """Class including the operations on series
372 def __init__(self, name = None):
373 """Takes a series name as the parameter.
375 PatchSet.__init__(self, name)
377 # Update the branch to the latest format version if it is
378 # initialized, but don't touch it if it isn't.
379 self.update_to_current_format_version()
381 self.__refs_base = 'refs/patches/%s' % self.get_name()
383 self.__applied_file = os.path.join(self._dir(), 'applied')
384 self.__unapplied_file = os.path.join(self._dir(), 'unapplied')
385 self.__hidden_file = os.path.join(self._dir(), 'hidden')
387 # where this series keeps its patches
388 self.__patch_dir = os.path.join(self._dir(), 'patches')
391 self.__trash_dir = os.path.join(self._dir(), 'trash')
393 def format_version_key(self):
394 return 'branch.%s.stgit.stackformatversion' % self.get_name()
396 def update_to_current_format_version(self):
397 """Update a potentially older StGIT directory structure to the
398 latest version. Note: This function should depend as little as
399 possible on external functions that may change during a format
400 version bump, since it must remain able to process older formats."""
402 branch_dir = os.path.join(self._basedir(), 'patches', self.get_name())
403 def get_format_version():
404 """Return the integer format version number, or None if the
405 branch doesn't have any StGIT metadata at all, of any version."""
406 fv = config.get(self.format_version_key())
407 ofv = config.get('branch.%s.stgitformatversion' % self.get_name())
409 # Great, there's an explicitly recorded format version
410 # number, which means that the branch is initialized and
411 # of that exact version.
414 # Old name for the version info, upgrade it
415 config.set(self.format_version_key(), ofv)
416 config.unset('branch.%s.stgitformatversion' % self.get_name())
418 elif os.path.isdir(os.path.join(branch_dir, 'patches')):
419 # There's a .git/patches/<branch>/patches dirctory, which
420 # means this is an initialized version 1 branch.
422 elif os.path.isdir(branch_dir):
423 # There's a .git/patches/<branch> directory, which means
424 # this is an initialized version 0 branch.
427 # The branch doesn't seem to be initialized at all.
429 def set_format_version(v):
430 out.info('Upgraded branch %s to format version %d' % (self.get_name(), v))
431 config.set(self.format_version_key(), '%d' % v)
433 if not os.path.isdir(d):
436 if os.path.exists(f):
439 if git.ref_exists(ref):
443 if get_format_version() == 0:
444 mkdir(os.path.join(branch_dir, 'trash'))
445 patch_dir = os.path.join(branch_dir, 'patches')
447 refs_base = 'refs/patches/%s' % self.get_name()
448 for patch in (file(os.path.join(branch_dir, 'unapplied')).readlines()
449 + file(os.path.join(branch_dir, 'applied')).readlines()):
450 patch = patch.strip()
451 os.rename(os.path.join(branch_dir, patch),
452 os.path.join(patch_dir, patch))
453 Patch(patch, patch_dir, refs_base).update_top_ref()
454 set_format_version(1)
457 if get_format_version() == 1:
458 desc_file = os.path.join(branch_dir, 'description')
459 if os.path.isfile(desc_file):
460 desc = read_string(desc_file)
462 config.set('branch.%s.description' % self.get_name(), desc)
464 rm(os.path.join(branch_dir, 'current'))
465 rm_ref('refs/bases/%s' % self.get_name())
466 set_format_version(2)
468 # Make sure we're at the latest version.
469 if not get_format_version() in [None, FORMAT_VERSION]:
470 raise StackException('Branch %s is at format version %d, expected %d'
471 % (self.get_name(), get_format_version(), FORMAT_VERSION))
473 def __patch_name_valid(self, name):
474 """Raise an exception if the patch name is not valid.
476 if not name or re.search('[^\w.-]', name):
477 raise StackException, 'Invalid patch name: "%s"' % name
479 def get_patch(self, name):
480 """Return a Patch object for the given name
482 return Patch(name, self.__patch_dir, self.__refs_base)
484 def get_current_patch(self):
485 """Return a Patch object representing the topmost patch, or
486 None if there is no such patch."""
487 crt = self.get_current()
490 return self.get_patch(crt)
492 def get_current(self):
493 """Return the name of the topmost patch, or None if there is
496 applied = self.get_applied()
497 except StackException:
498 # No "applied" file: branch is not initialized.
503 # No patches applied.
506 def get_applied(self):
507 if not os.path.isfile(self.__applied_file):
508 raise StackException, 'Branch "%s" not initialised' % self.get_name()
509 return read_strings(self.__applied_file)
511 def get_unapplied(self):
512 if not os.path.isfile(self.__unapplied_file):
513 raise StackException, 'Branch "%s" not initialised' % self.get_name()
514 return read_strings(self.__unapplied_file)
516 def get_hidden(self):
517 if not os.path.isfile(self.__hidden_file):
519 return read_strings(self.__hidden_file)
522 # Return the parent of the bottommost patch, if there is one.
523 if os.path.isfile(self.__applied_file):
524 bottommost = file(self.__applied_file).readline().strip()
526 return self.get_patch(bottommost).get_bottom()
527 # No bottommost patch, so just return HEAD
528 return git.get_head()
530 def get_parent_remote(self):
531 value = config.get('branch.%s.remote' % self.get_name())
534 elif 'origin' in git.remotes_list():
535 out.note(('No parent remote declared for stack "%s",'
536 ' defaulting to "origin".' % self.get_name()),
537 ('Consider setting "branch.%s.remote" and'
538 ' "branch.%s.merge" with "git config".'
539 % (self.get_name(), self.get_name())))
542 raise StackException, 'Cannot find a parent remote for "%s"' % self.get_name()
544 def __set_parent_remote(self, remote):
545 value = config.set('branch.%s.remote' % self.get_name(), remote)
547 def get_parent_branch(self):
548 value = config.get('branch.%s.stgit.parentbranch' % self.get_name())
551 elif git.rev_parse('heads/origin'):
552 out.note(('No parent branch declared for stack "%s",'
553 ' defaulting to "heads/origin".' % self.get_name()),
554 ('Consider setting "branch.%s.stgit.parentbranch"'
555 ' with "git config".' % self.get_name()))
556 return 'heads/origin'
558 raise StackException, 'Cannot find a parent branch for "%s"' % self.get_name()
560 def __set_parent_branch(self, name):
561 if config.get('branch.%s.remote' % self.get_name()):
562 # Never set merge if remote is not set to avoid
563 # possibly-erroneous lookups into 'origin'
564 config.set('branch.%s.merge' % self.get_name(), name)
565 config.set('branch.%s.stgit.parentbranch' % self.get_name(), name)
567 def set_parent(self, remote, localbranch):
570 self.__set_parent_remote(remote)
571 self.__set_parent_branch(localbranch)
572 # We'll enforce this later
574 # raise StackException, 'Parent branch (%s) should be specified for %s' % localbranch, self.get_name()
576 def __patch_is_current(self, patch):
577 return patch.get_name() == self.get_current()
579 def patch_applied(self, name):
580 """Return true if the patch exists in the applied list
582 return name in self.get_applied()
584 def patch_unapplied(self, name):
585 """Return true if the patch exists in the unapplied list
587 return name in self.get_unapplied()
589 def patch_hidden(self, name):
590 """Return true if the patch is hidden.
592 return name in self.get_hidden()
594 def patch_exists(self, name):
595 """Return true if there is a patch with the given name, false
597 return self.patch_applied(name) or self.patch_unapplied(name) \
598 or self.patch_hidden(name)
600 def init(self, create_at=False, parent_remote=None, parent_branch=None):
601 """Initialises the stgit series
603 if self.is_initialised():
604 raise StackException, '%s already initialized' % self.get_name()
605 for d in [self._dir()]:
606 if os.path.exists(d):
607 raise StackException, '%s already exists' % d
609 if (create_at!=False):
610 git.create_branch(self.get_name(), create_at)
612 os.makedirs(self.__patch_dir)
614 self.set_parent(parent_remote, parent_branch)
616 self.create_empty_field('applied')
617 self.create_empty_field('unapplied')
618 self._set_field('orig-base', git.get_head())
620 config.set(self.format_version_key(), str(FORMAT_VERSION))
622 def rename(self, to_name):
625 to_stack = Series(to_name)
627 if to_stack.is_initialised():
628 raise StackException, '"%s" already exists' % to_stack.get_name()
630 patches = self.get_applied() + self.get_unapplied()
632 git.rename_branch(self.get_name(), to_name)
634 for patch in patches:
635 git.rename_ref('refs/patches/%s/%s' % (self.get_name(), patch),
636 'refs/patches/%s/%s' % (to_name, patch))
637 git.rename_ref('refs/patches/%s/%s.log' % (self.get_name(), patch),
638 'refs/patches/%s/%s.log' % (to_name, patch))
639 if os.path.isdir(self._dir()):
640 rename(os.path.join(self._basedir(), 'patches'),
641 self.get_name(), to_stack.get_name())
643 # Rename the config section
644 for k in ['branch.%s', 'branch.%s.stgit']:
645 config.rename_section(k % self.get_name(), k % to_name)
647 self.__init__(to_name)
649 def clone(self, target_series):
653 # allow cloning of branches not under StGIT control
654 base = self.get_base()
656 base = git.get_head()
657 Series(target_series).init(create_at = base)
658 new_series = Series(target_series)
660 # generate an artificial description file
661 new_series.set_description('clone of "%s"' % self.get_name())
663 # clone self's entire series as unapplied patches
665 # allow cloning of branches not under StGIT control
666 applied = self.get_applied()
667 unapplied = self.get_unapplied()
668 patches = applied + unapplied
671 patches = applied = unapplied = []
673 patch = self.get_patch(p)
674 newpatch = new_series.new_patch(p, message = patch.get_description(),
675 can_edit = False, unapplied = True,
676 bottom = patch.get_bottom(),
677 top = patch.get_top(),
678 author_name = patch.get_authname(),
679 author_email = patch.get_authemail(),
680 author_date = patch.get_authdate())
682 out.info('Setting log to %s' % patch.get_log())
683 newpatch.set_log(patch.get_log())
685 out.info('No log for %s' % p)
687 # fast forward the cloned series to self's top
688 new_series.forward_patches(applied)
690 # Clone parent informations
691 value = config.get('branch.%s.remote' % self.get_name())
693 config.set('branch.%s.remote' % target_series, value)
695 value = config.get('branch.%s.merge' % self.get_name())
697 config.set('branch.%s.merge' % target_series, value)
699 value = config.get('branch.%s.stgit.parentbranch' % self.get_name())
701 config.set('branch.%s.stgit.parentbranch' % target_series, value)
703 def delete(self, force = False):
704 """Deletes an stgit series
706 if self.is_initialised():
707 patches = self.get_unapplied() + self.get_applied()
708 if not force and patches:
709 raise StackException, \
710 'Cannot delete: the series still contains patches'
712 self.get_patch(p).delete()
714 # remove the trash directory if any
715 if os.path.exists(self.__trash_dir):
716 for fname in os.listdir(self.__trash_dir):
717 os.remove(os.path.join(self.__trash_dir, fname))
718 os.rmdir(self.__trash_dir)
720 # FIXME: find a way to get rid of those manual removals
721 # (move functionality to StgitObject ?)
722 if os.path.exists(self.__applied_file):
723 os.remove(self.__applied_file)
724 if os.path.exists(self.__unapplied_file):
725 os.remove(self.__unapplied_file)
726 if os.path.exists(self.__hidden_file):
727 os.remove(self.__hidden_file)
728 if os.path.exists(self._dir()+'/orig-base'):
729 os.remove(self._dir()+'/orig-base')
731 if not os.listdir(self.__patch_dir):
732 os.rmdir(self.__patch_dir)
734 out.warn('Patch directory %s is not empty' % self.__patch_dir)
737 os.removedirs(self._dir())
739 raise StackException('Series directory %s is not empty'
743 git.delete_branch(self.get_name())
745 out.warn('Could not delete branch "%s"' % self.get_name())
747 config.remove_section('branch.%s' % self.get_name())
748 config.remove_section('branch.%s.stgit' % self.get_name())
750 def refresh_patch(self, files = None, message = None, edit = False,
753 author_name = None, author_email = None,
755 committer_name = None, committer_email = None,
756 backup = False, sign_str = None, log = 'refresh',
758 """Generates a new commit for the given patch
760 name = self.get_current()
762 raise StackException, 'No patches applied'
764 patch = self.get_patch(name)
766 descr = patch.get_description()
767 if not (message or descr):
773 # TODO: move this out of the stgit.stack module, it is really
774 # for higher level commands to handle the user interaction
775 if not message and edit:
776 descr = edit_file(self, descr.rstrip(), \
777 'Please edit the description for patch "%s" ' \
778 'above.' % name, show_patch)
781 author_name = patch.get_authname()
783 author_email = patch.get_authemail()
785 author_date = patch.get_authdate()
786 if not committer_name:
787 committer_name = patch.get_commname()
788 if not committer_email:
789 committer_email = patch.get_commemail()
791 descr = add_sign_line(descr, sign_str, committer_name, committer_email)
793 bottom = patch.get_bottom()
795 commit_id = git.commit(files = files,
796 message = descr, parents = [bottom],
797 cache_update = cache_update,
799 author_name = author_name,
800 author_email = author_email,
801 author_date = author_date,
802 committer_name = committer_name,
803 committer_email = committer_email)
805 patch.set_bottom(bottom, backup = backup)
806 patch.set_top(commit_id, backup = backup)
807 patch.set_description(descr)
808 patch.set_authname(author_name)
809 patch.set_authemail(author_email)
810 patch.set_authdate(author_date)
811 patch.set_commname(committer_name)
812 patch.set_commemail(committer_email)
815 self.log_patch(patch, log, notes)
819 def undo_refresh(self):
820 """Undo the patch boundaries changes caused by 'refresh'
822 name = self.get_current()
825 patch = self.get_patch(name)
826 old_bottom = patch.get_old_bottom()
827 old_top = patch.get_old_top()
829 # the bottom of the patch is not changed by refresh. If the
830 # old_bottom is different, there wasn't any previous 'refresh'
831 # command (probably only a 'push')
832 if old_bottom != patch.get_bottom() or old_top == patch.get_top():
833 raise StackException, 'No undo information available'
835 git.reset(tree_id = old_top, check_out = False)
836 if patch.restore_old_boundaries():
837 self.log_patch(patch, 'undo')
839 def new_patch(self, name, message = None, can_edit = True,
840 unapplied = False, show_patch = False,
841 top = None, bottom = None, commit = True,
842 author_name = None, author_email = None, author_date = None,
843 committer_name = None, committer_email = None,
844 before_existing = False):
845 """Creates a new patch
849 self.__patch_name_valid(name)
850 if self.patch_exists(name):
851 raise StackException, 'Patch "%s" already exists' % name
853 # TODO: move this out of the stgit.stack module, it is really
854 # for higher level commands to handle the user interaction
855 if not message and can_edit:
858 'Please enter the description for the patch above.',
863 head = git.get_head()
866 name = make_patch_name(descr, self.patch_exists)
868 patch = self.get_patch(name)
876 patch.set_bottom(bottom)
878 patch.set_description(descr)
879 patch.set_authname(author_name)
880 patch.set_authemail(author_email)
881 patch.set_authdate(author_date)
882 patch.set_commname(committer_name)
883 patch.set_commemail(committer_email)
886 insert_string(self.__applied_file, patch.get_name())
887 # no need to commit anything as the object is already
888 # present (mainly used by 'uncommit')
891 patches = [patch.get_name()] + self.get_unapplied()
892 write_strings(self.__unapplied_file, patches)
895 append_string(self.__applied_file, patch.get_name())
899 # create a commit for the patch (may be empty if top == bottom);
900 # only commit on top of the current branch
901 assert(unapplied or bottom == head)
902 top_commit = git.get_commit(top)
903 commit_id = git.commit(message = descr, parents = [bottom],
904 cache_update = False,
905 tree_id = top_commit.get_tree(),
906 allowempty = True, set_head = set_head,
907 author_name = author_name,
908 author_email = author_email,
909 author_date = author_date,
910 committer_name = committer_name,
911 committer_email = committer_email)
912 # set the patch top to the new commit
913 patch.set_top(commit_id)
915 self.log_patch(patch, 'new')
919 def delete_patch(self, name):
922 self.__patch_name_valid(name)
923 patch = self.get_patch(name)
925 if self.__patch_is_current(patch):
927 elif self.patch_applied(name):
928 raise StackException, 'Cannot remove an applied patch, "%s", ' \
929 'which is not current' % name
930 elif not name in self.get_unapplied():
931 raise StackException, 'Unknown patch "%s"' % name
933 # save the commit id to a trash file
934 write_string(os.path.join(self.__trash_dir, name), patch.get_top())
938 unapplied = self.get_unapplied()
939 unapplied.remove(name)
940 write_strings(self.__unapplied_file, unapplied)
942 def forward_patches(self, names):
943 """Try to fast-forward an array of patches.
945 On return, patches in names[0:returned_value] have been pushed on the
946 stack. Apply the rest with push_patch
948 unapplied = self.get_unapplied()
954 assert(name in unapplied)
956 patch = self.get_patch(name)
959 bottom = patch.get_bottom()
960 top = patch.get_top()
962 # top != bottom always since we have a commit for each patch
964 # reset the backup information. No logging since the
965 # patch hasn't changed
966 patch.set_bottom(head, backup = True)
967 patch.set_top(top, backup = True)
970 head_tree = git.get_commit(head).get_tree()
971 bottom_tree = git.get_commit(bottom).get_tree()
972 if head_tree == bottom_tree:
973 # We must just reparent this patch and create a new commit
975 descr = patch.get_description()
976 author_name = patch.get_authname()
977 author_email = patch.get_authemail()
978 author_date = patch.get_authdate()
979 committer_name = patch.get_commname()
980 committer_email = patch.get_commemail()
982 top_tree = git.get_commit(top).get_tree()
984 top = git.commit(message = descr, parents = [head],
985 cache_update = False,
988 author_name = author_name,
989 author_email = author_email,
990 author_date = author_date,
991 committer_name = committer_name,
992 committer_email = committer_email)
994 patch.set_bottom(head, backup = True)
995 patch.set_top(top, backup = True)
997 self.log_patch(patch, 'push(f)')
1000 # stop the fast-forwarding, must do a real merge
1004 unapplied.remove(name)
1011 append_strings(self.__applied_file, names[0:forwarded])
1012 write_strings(self.__unapplied_file, unapplied)
1016 def merged_patches(self, names):
1017 """Test which patches were merged upstream by reverse-applying
1018 them in reverse order. The function returns the list of
1019 patches detected to have been applied. The state of the tree
1020 is restored to the original one
1022 patches = [self.get_patch(name) for name in names]
1027 if git.apply_diff(p.get_top(), p.get_bottom()):
1028 merged.append(p.get_name())
1035 def push_empty_patch(self, name):
1036 """Pushes an empty patch on the stack
1038 unapplied = self.get_unapplied()
1039 assert(name in unapplied)
1041 patch = self.get_patch(name)
1042 head = git.get_head()
1044 # The top is updated by refresh_patch since we need an empty
1046 patch.set_bottom(head, backup = True)
1047 patch.set_top(head, backup = True)
1049 append_string(self.__applied_file, name)
1051 unapplied.remove(name)
1052 write_strings(self.__unapplied_file, unapplied)
1054 self.refresh_patch(cache_update = False, log = 'push(m)')
1056 def push_patch(self, name):
1057 """Pushes a patch on the stack
1059 unapplied = self.get_unapplied()
1060 assert(name in unapplied)
1062 patch = self.get_patch(name)
1064 head = git.get_head()
1065 bottom = patch.get_bottom()
1066 top = patch.get_top()
1071 # top != bottom always since we have a commit for each patch
1073 # reset the backup information. No need for logging
1074 patch.set_bottom(bottom, backup = True)
1075 patch.set_top(top, backup = True)
1079 # new patch needs to be refreshed.
1080 # The current patch is empty after merge.
1081 patch.set_bottom(head, backup = True)
1082 patch.set_top(head, backup = True)
1084 # Try the fast applying first. If this fails, fall back to the
1086 if not git.apply_diff(bottom, top):
1087 # if git.apply_diff() fails, the patch requires a diff3
1088 # merge and can be reported as modified
1091 # merge can fail but the patch needs to be pushed
1093 git.merge(bottom, head, top, recursive = True)
1094 except git.GitException, ex:
1095 out.error('The merge failed during "push".',
1096 'Use "refresh" after fixing the conflicts or'
1097 ' revert the operation with "push --undo".')
1099 append_string(self.__applied_file, name)
1101 unapplied.remove(name)
1102 write_strings(self.__unapplied_file, unapplied)
1104 # head == bottom case doesn't need to refresh the patch
1107 # if the merge was OK and no conflicts, just refresh the patch
1108 # The GIT cache was already updated by the merge operation
1113 self.refresh_patch(cache_update = False, log = log)
1115 # we store the correctly merged files only for
1116 # tracking the conflict history. Note that the
1117 # git.merge() operations should always leave the index
1118 # in a valid state (i.e. only stage 0 files)
1119 self.refresh_patch(cache_update = False, log = 'push(c)')
1120 raise StackException, str(ex)
1124 def undo_push(self):
1125 name = self.get_current()
1128 patch = self.get_patch(name)
1129 old_bottom = patch.get_old_bottom()
1130 old_top = patch.get_old_top()
1132 # the top of the patch is changed by a push operation only
1133 # together with the bottom (otherwise the top was probably
1134 # modified by 'refresh'). If they are both unchanged, there
1135 # was a fast forward
1136 if old_bottom == patch.get_bottom() and old_top != patch.get_top():
1137 raise StackException, 'No undo information available'
1140 self.pop_patch(name)
1141 ret = patch.restore_old_boundaries()
1143 self.log_patch(patch, 'undo')
1147 def pop_patch(self, name, keep = False):
1148 """Pops the top patch from the stack
1150 applied = self.get_applied()
1152 assert(name in applied)
1154 patch = self.get_patch(name)
1156 if git.get_head_file() == self.get_name():
1157 if keep and not git.apply_diff(git.get_head(), patch.get_bottom()):
1158 raise StackException(
1159 'Failed to pop patches while preserving the local changes')
1160 git.switch(patch.get_bottom(), keep)
1162 git.set_branch(self.get_name(), patch.get_bottom())
1164 # save the new applied list
1165 idx = applied.index(name) + 1
1167 popped = applied[:idx]
1169 unapplied = popped + self.get_unapplied()
1170 write_strings(self.__unapplied_file, unapplied)
1174 write_strings(self.__applied_file, applied)
1176 def empty_patch(self, name):
1177 """Returns True if the patch is empty
1179 self.__patch_name_valid(name)
1180 patch = self.get_patch(name)
1181 bottom = patch.get_bottom()
1182 top = patch.get_top()
1186 elif git.get_commit(top).get_tree() \
1187 == git.get_commit(bottom).get_tree():
1192 def rename_patch(self, oldname, newname):
1193 self.__patch_name_valid(newname)
1195 applied = self.get_applied()
1196 unapplied = self.get_unapplied()
1198 if oldname == newname:
1199 raise StackException, '"To" name and "from" name are the same'
1201 if newname in applied or newname in unapplied:
1202 raise StackException, 'Patch "%s" already exists' % newname
1204 if oldname in unapplied:
1205 self.get_patch(oldname).rename(newname)
1206 unapplied[unapplied.index(oldname)] = newname
1207 write_strings(self.__unapplied_file, unapplied)
1208 elif oldname in applied:
1209 self.get_patch(oldname).rename(newname)
1211 applied[applied.index(oldname)] = newname
1212 write_strings(self.__applied_file, applied)
1214 raise StackException, 'Unknown patch "%s"' % oldname
1216 def log_patch(self, patch, message, notes = None):
1217 """Generate a log commit for a patch
1219 top = git.get_commit(patch.get_top())
1220 old_log = patch.get_log()
1223 # replace the current log entry
1225 raise StackException, \
1226 'No log entry to annotate for patch "%s"' \
1229 log_commit = git.get_commit(old_log)
1230 msg = log_commit.get_log().split('\n')[0]
1231 log_parent = log_commit.get_parent()
1233 parents = [log_parent]
1237 # generate a new log entry
1239 msg = '%s\t%s' % (message, top.get_id_hash())
1246 msg += '\n\n' + notes
1248 log = git.commit(message = msg, parents = parents,
1249 cache_update = False, tree_id = top.get_tree(),
1253 def hide_patch(self, name):
1254 """Add the patch to the hidden list.
1256 unapplied = self.get_unapplied()
1257 if name not in unapplied:
1258 # keep the checking order for backward compatibility with
1259 # the old hidden patches functionality
1260 if self.patch_applied(name):
1261 raise StackException, 'Cannot hide applied patch "%s"' % name
1262 elif self.patch_hidden(name):
1263 raise StackException, 'Patch "%s" already hidden' % name
1265 raise StackException, 'Unknown patch "%s"' % name
1267 if not self.patch_hidden(name):
1268 # check needed for backward compatibility with the old
1269 # hidden patches functionality
1270 append_string(self.__hidden_file, name)
1272 unapplied.remove(name)
1273 write_strings(self.__unapplied_file, unapplied)
1275 def unhide_patch(self, name):
1276 """Remove the patch from the hidden list.
1278 hidden = self.get_hidden()
1279 if not name in hidden:
1280 if self.patch_applied(name) or self.patch_unapplied(name):
1281 raise StackException, 'Patch "%s" not hidden' % name
1283 raise StackException, 'Unknown patch "%s"' % name
1286 write_strings(self.__hidden_file, hidden)
1288 if not self.patch_applied(name) and not self.patch_unapplied(name):
1289 # check needed for backward compatibility with the old
1290 # hidden patches functionality
1291 append_string(self.__unapplied_file, name)