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
23 from stgit.utils import *
25 from stgit.config import config
28 # stack exception class
29 class StackException(Exception):
34 self.should_print = True
35 def __call__(self, x, until_test, prefix):
37 self.should_print = False
39 return x[0:len(prefix)] != prefix
45 __comment_prefix = 'STG:'
46 __patch_prefix = 'STG_PATCH:'
48 def __clean_comments(f):
49 """Removes lines marked for status in a commit file
53 # remove status-prefixed lines
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)]
60 # remove empty lines at the end
61 while len(lines) != 0 and lines[-1] == '\n':
64 f.seek(0); f.truncate()
67 def edit_file(series, line, comment, show_patch = True):
69 tmpl = os.path.join(git.get_base_dir(), 'patchdescr.tmpl')
74 elif os.path.isfile(tmpl):
75 print >> f, file(tmpl).read().rstrip()
78 print >> f, __comment_prefix, comment
79 print >> f, __comment_prefix, \
80 'Lines prefixed with "%s" will be automatically removed.' \
82 print >> f, __comment_prefix, \
83 'Trailing empty lines will be automatically removed.'
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)
90 #Vim modeline must be near the end.
91 print >> f, __comment_prefix, 'vi: set textwidth=75 filetype=diff nobackup:'
95 if config.has_option('stgit', 'editor'):
96 editor = config.get('stgit', 'editor')
97 elif 'EDITOR' in os.environ:
98 editor = os.environ['EDITOR']
101 editor += ' %s' % fname
103 print 'Invoking the editor: "%s"...' % editor,
105 print 'done (exit code: %d)' % os.system(editor)
107 f = file(fname, 'r+')
123 """Basic patch implementation
125 def __init__(self, name, patch_dir):
126 self.__patch_dir = patch_dir
128 self.__dir = os.path.join(self.__patch_dir, self.__name)
132 create_empty_file(os.path.join(self.__dir, 'bottom'))
133 create_empty_file(os.path.join(self.__dir, 'top'))
136 for f in os.listdir(self.__dir):
137 os.remove(os.path.join(self.__dir, f))
143 def rename(self, newname):
145 self.__name = newname
146 self.__dir = os.path.join(self.__patch_dir, self.__name)
148 os.rename(olddir, self.__dir)
150 def __get_field(self, name, multiline = False):
151 id_file = os.path.join(self.__dir, name)
152 if os.path.isfile(id_file):
153 line = read_string(id_file, multiline)
161 def __set_field(self, name, value, multiline = False):
162 fname = os.path.join(self.__dir, name)
163 if value and value != '':
164 write_string(fname, value, multiline)
165 elif os.path.isfile(fname):
168 def get_old_bottom(self):
169 return self.__get_field('bottom.old')
171 def get_bottom(self):
172 return self.__get_field('bottom')
174 def set_bottom(self, value, backup = False):
176 curr = self.__get_field('bottom')
178 self.__set_field('bottom.old', curr)
180 self.__set_field('bottom.old', None)
181 self.__set_field('bottom', value)
183 def get_old_top(self):
184 return self.__get_field('top.old')
187 return self.__get_field('top')
189 def set_top(self, value, backup = False):
191 curr = self.__get_field('top')
193 self.__set_field('top.old', curr)
195 self.__set_field('top.old', None)
196 self.__set_field('top', value)
198 def restore_old_boundaries(self):
199 bottom = self.__get_field('bottom.old')
200 top = self.__get_field('top.old')
203 self.__set_field('bottom', bottom)
204 self.__set_field('top', top)
209 def get_description(self):
210 return self.__get_field('description', True)
212 def set_description(self, line):
213 self.__set_field('description', line, True)
215 def get_authname(self):
216 return self.__get_field('authname')
218 def set_authname(self, name):
219 if not name and config.has_option('stgit', 'authname'):
220 name = config.get('stgit', 'authname')
221 self.__set_field('authname', name)
223 def get_authemail(self):
224 return self.__get_field('authemail')
226 def set_authemail(self, address):
227 if not address and config.has_option('stgit', 'authemail'):
228 address = config.get('stgit', 'authemail')
229 self.__set_field('authemail', address)
231 def get_authdate(self):
232 return self.__get_field('authdate')
234 def set_authdate(self, authdate):
235 self.__set_field('authdate', authdate)
237 def get_commname(self):
238 return self.__get_field('commname')
240 def set_commname(self, name):
241 if not name and config.has_option('stgit', 'commname'):
242 name = config.get('stgit', 'commname')
243 self.__set_field('commname', name)
245 def get_commemail(self):
246 return self.__get_field('commemail')
248 def set_commemail(self, address):
249 if not address and config.has_option('stgit', 'commemail'):
250 address = config.get('stgit', 'commemail')
251 self.__set_field('commemail', address)
255 """Class including the operations on series
257 def __init__(self, name = None):
258 """Takes a series name as the parameter.
263 self.__name = git.get_head_file()
266 base_dir = git.get_base_dir()
267 self.__patch_dir = os.path.join(base_dir, 'patches',
269 self.__base_file = os.path.join(base_dir, 'refs', 'bases',
271 self.__applied_file = os.path.join(self.__patch_dir, 'applied')
272 self.__unapplied_file = os.path.join(self.__patch_dir, 'unapplied')
273 self.__current_file = os.path.join(self.__patch_dir, 'current')
274 self.__descr_file = os.path.join(self.__patch_dir, 'description')
276 def get_branch(self):
277 """Return the branch name for the Series object
281 def __set_current(self, name):
282 """Sets the topmost patch
285 write_string(self.__current_file, name)
287 create_empty_file(self.__current_file)
289 def get_patch(self, name):
290 """Return a Patch object for the given name
292 return Patch(name, self.__patch_dir)
294 def get_current(self):
295 """Return a Patch object representing the topmost patch
297 if os.path.isfile(self.__current_file):
298 name = read_string(self.__current_file)
306 def get_applied(self):
307 if not os.path.isfile(self.__applied_file):
308 raise StackException, 'Branch "%s" not initialised' % self.__name
309 f = file(self.__applied_file)
310 names = [line.strip() for line in f.readlines()]
314 def get_unapplied(self):
315 if not os.path.isfile(self.__unapplied_file):
316 raise StackException, 'Branch "%s" not initialised' % self.__name
317 f = file(self.__unapplied_file)
318 names = [line.strip() for line in f.readlines()]
322 def get_base_file(self):
323 return self.__base_file
325 def get_protected(self):
326 return os.path.isfile(os.path.join(self.__patch_dir, 'protected'))
329 protect_file = os.path.join(self.__patch_dir, 'protected')
330 if not os.path.isfile(protect_file):
331 create_empty_file(protect_file)
334 protect_file = os.path.join(self.__patch_dir, 'protected')
335 if os.path.isfile(protect_file):
336 os.remove(protect_file)
338 def get_description(self):
339 if os.path.isfile(self.__descr_file):
340 return read_string(self.__descr_file)
344 def __patch_is_current(self, patch):
345 return patch.get_name() == read_string(self.__current_file)
347 def __patch_applied(self, name):
348 """Return true if the patch exists in the applied list
350 return name in self.get_applied()
352 def __patch_unapplied(self, name):
353 """Return true if the patch exists in the unapplied list
355 return name in self.get_unapplied()
357 def __begin_stack_check(self):
358 """Save the current HEAD into .git/refs/heads/base if the stack
361 if len(self.get_applied()) == 0:
362 head = git.get_head()
363 write_string(self.__base_file, head)
365 def __end_stack_check(self):
366 """Remove .git/refs/heads/base if the stack is empty.
367 This warning should never happen
369 if len(self.get_applied()) == 0 \
370 and read_string(self.__base_file) != git.get_head():
371 print 'Warning: stack empty but the HEAD and base are different'
373 def head_top_equal(self):
374 """Return true if the head and the top are the same
376 crt = self.get_current()
378 # we don't care, no patches applied
380 return git.get_head() == Patch(crt, self.__patch_dir).get_top()
382 def is_initialised(self):
383 """Checks if series is already initialised
385 return os.path.isdir(self.__patch_dir)
388 """Initialises the stgit series
390 bases_dir = os.path.join(git.get_base_dir(), 'refs', 'bases')
392 if self.is_initialised():
393 raise StackException, self.__patch_dir + ' already exists'
394 os.makedirs(self.__patch_dir)
396 if not os.path.isdir(bases_dir):
397 os.makedirs(bases_dir)
399 create_empty_file(self.__applied_file)
400 create_empty_file(self.__unapplied_file)
401 create_empty_file(self.__descr_file)
402 self.__begin_stack_check()
404 def rename(self, to_name):
407 to_stack = Series(to_name)
409 if to_stack.is_initialised():
410 raise StackException, '"%s" already exists' % to_stack.get_branch()
411 if os.path.exists(to_stack.__base_file):
412 os.remove(to_stack.__base_file)
414 git.rename_branch(self.__name, to_name)
416 if os.path.isdir(self.__patch_dir):
417 os.rename(self.__patch_dir, to_stack.__patch_dir)
418 if os.path.exists(self.__base_file):
419 os.rename(self.__base_file, to_stack.__base_file)
421 self.__init__(to_name)
423 def clone(self, target_series):
426 base = read_string(self.get_base_file())
427 git.create_branch(target_series, tree_id = base)
428 Series(target_series).init()
429 new_series = Series(target_series)
431 # generate an artificial description file
432 write_string(new_series.__descr_file, 'clone of "%s"' % self.__name)
434 # clone self's entire series as unapplied patches
435 patches = self.get_applied() + self.get_unapplied()
438 patch = self.get_patch(p)
439 new_series.new_patch(p, message = patch.get_description(),
440 can_edit = False, unapplied = True,
441 bottom = patch.get_bottom(),
442 top = patch.get_top(),
443 author_name = patch.get_authname(),
444 author_email = patch.get_authemail(),
445 author_date = patch.get_authdate())
447 # fast forward the cloned series to self's top
448 new_series.forward_patches(self.get_applied())
450 def delete(self, force = False):
451 """Deletes an stgit series
453 if self.is_initialised():
454 patches = self.get_unapplied() + self.get_applied()
455 if not force and patches:
456 raise StackException, \
457 'Cannot delete: the series still contains patches'
459 Patch(p, self.__patch_dir).delete()
461 if os.path.exists(self.__applied_file):
462 os.remove(self.__applied_file)
463 if os.path.exists(self.__unapplied_file):
464 os.remove(self.__unapplied_file)
465 if os.path.exists(self.__current_file):
466 os.remove(self.__current_file)
467 if os.path.exists(self.__descr_file):
468 os.remove(self.__descr_file)
469 if not os.listdir(self.__patch_dir):
470 os.rmdir(self.__patch_dir)
472 print 'Series directory %s is not empty.' % self.__name
474 if os.path.exists(self.__base_file):
475 os.remove(self.__base_file)
477 def refresh_patch(self, message = None, edit = False, show_patch = False,
479 author_name = None, author_email = None,
481 committer_name = None, committer_email = None):
482 """Generates a new commit for the given patch
484 name = self.get_current()
486 raise StackException, 'No patches applied'
488 patch = Patch(name, self.__patch_dir)
490 descr = patch.get_description()
491 if not (message or descr):
497 if not message and edit:
498 descr = edit_file(self, descr.rstrip(), \
499 'Please edit the description for patch "%s" ' \
500 'above.' % name, show_patch)
503 author_name = patch.get_authname()
505 author_email = patch.get_authemail()
507 author_date = patch.get_authdate()
508 if not committer_name:
509 committer_name = patch.get_commname()
510 if not committer_email:
511 committer_email = patch.get_commemail()
513 commit_id = git.commit(message = descr, parents = [patch.get_bottom()],
514 cache_update = cache_update,
516 author_name = author_name,
517 author_email = author_email,
518 author_date = author_date,
519 committer_name = committer_name,
520 committer_email = committer_email)
522 patch.set_top(commit_id)
523 patch.set_description(descr)
524 patch.set_authname(author_name)
525 patch.set_authemail(author_email)
526 patch.set_authdate(author_date)
527 patch.set_commname(committer_name)
528 patch.set_commemail(committer_email)
532 def new_patch(self, name, message = None, can_edit = True,
533 unapplied = False, show_patch = False,
534 top = None, bottom = None,
535 author_name = None, author_email = None, author_date = None,
536 committer_name = None, committer_email = None):
537 """Creates a new patch
539 if self.__patch_applied(name) or self.__patch_unapplied(name):
540 raise StackException, 'Patch "%s" already exists' % name
542 if not message and can_edit:
543 descr = edit_file(self, None, \
544 'Please enter the description for patch "%s" ' \
545 'above.' % name, show_patch)
549 head = git.get_head()
551 self.__begin_stack_check()
553 patch = Patch(name, self.__patch_dir)
557 patch.set_bottom(bottom)
559 patch.set_bottom(head)
565 patch.set_description(descr)
566 patch.set_authname(author_name)
567 patch.set_authemail(author_email)
568 patch.set_authdate(author_date)
569 patch.set_commname(committer_name)
570 patch.set_commemail(committer_email)
573 patches = [patch.get_name()] + self.get_unapplied()
575 f = file(self.__unapplied_file, 'w+')
576 f.writelines([line + '\n' for line in patches])
579 append_string(self.__applied_file, patch.get_name())
580 self.__set_current(name)
582 def delete_patch(self, name):
585 patch = Patch(name, self.__patch_dir)
587 if self.__patch_is_current(patch):
589 elif self.__patch_applied(name):
590 raise StackException, 'Cannot remove an applied patch, "%s", ' \
591 'which is not current' % name
592 elif not name in self.get_unapplied():
593 raise StackException, 'Unknown patch "%s"' % name
597 unapplied = self.get_unapplied()
598 unapplied.remove(name)
599 f = file(self.__unapplied_file, 'w+')
600 f.writelines([line + '\n' for line in unapplied])
603 def forward_patches(self, names):
604 """Try to fast-forward an array of patches.
606 On return, patches in names[0:returned_value] have been pushed on the
607 stack. Apply the rest with push_patch
609 unapplied = self.get_unapplied()
610 self.__begin_stack_check()
616 assert(name in unapplied)
618 patch = Patch(name, self.__patch_dir)
621 bottom = patch.get_bottom()
622 top = patch.get_top()
624 # top != bottom always since we have a commit for each patch
626 # reset the backup information
627 patch.set_bottom(head, backup = True)
628 patch.set_top(top, backup = True)
631 head_tree = git.get_commit(head).get_tree()
632 bottom_tree = git.get_commit(bottom).get_tree()
633 if head_tree == bottom_tree:
634 # We must just reparent this patch and create a new commit
636 descr = patch.get_description()
637 author_name = patch.get_authname()
638 author_email = patch.get_authemail()
639 author_date = patch.get_authdate()
640 committer_name = patch.get_commname()
641 committer_email = patch.get_commemail()
643 top_tree = git.get_commit(top).get_tree()
645 top = git.commit(message = descr, parents = [head],
646 cache_update = False,
649 author_name = author_name,
650 author_email = author_email,
651 author_date = author_date,
652 committer_name = committer_name,
653 committer_email = committer_email)
655 patch.set_bottom(head, backup = True)
656 patch.set_top(top, backup = True)
659 # stop the fast-forwarding, must do a real merge
663 unapplied.remove(name)
670 append_strings(self.__applied_file, names[0:forwarded])
672 f = file(self.__unapplied_file, 'w+')
673 f.writelines([line + '\n' for line in unapplied])
676 self.__set_current(name)
680 def push_patch(self, name):
681 """Pushes a patch on the stack
683 unapplied = self.get_unapplied()
684 assert(name in unapplied)
686 self.__begin_stack_check()
688 patch = Patch(name, self.__patch_dir)
690 head = git.get_head()
691 bottom = patch.get_bottom()
692 top = patch.get_top()
697 # top != bottom always since we have a commit for each patch
699 # reset the backup information
700 patch.set_bottom(bottom, backup = True)
701 patch.set_top(top, backup = True)
705 # new patch needs to be refreshed.
706 # The current patch is empty after merge.
707 patch.set_bottom(head, backup = True)
708 patch.set_top(head, backup = True)
710 # Try the fast applying first. If this fails, fall back to the
712 if not git.apply_diff(bottom, top):
713 # if git.apply_diff() fails, the patch requires a diff3
714 # merge and can be reported as modified
717 # merge can fail but the patch needs to be pushed
719 git.merge(bottom, head, top)
720 except git.GitException, ex:
721 print >> sys.stderr, \
722 'The merge failed during "push". ' \
723 'Use "refresh" after fixing the conflicts'
725 append_string(self.__applied_file, name)
727 unapplied.remove(name)
728 f = file(self.__unapplied_file, 'w+')
729 f.writelines([line + '\n' for line in unapplied])
732 self.__set_current(name)
734 # head == bottom case doesn't need to refresh the patch
737 # if the merge was OK and no conflicts, just refresh the patch
738 # The GIT cache was already updated by the merge operation
739 self.refresh_patch(cache_update = False)
741 raise StackException, str(ex)
746 name = self.get_current()
749 patch = Patch(name, self.__patch_dir)
752 return patch.restore_old_boundaries()
754 def pop_patch(self, name):
755 """Pops the top patch from the stack
757 applied = self.get_applied()
759 assert(name in applied)
761 patch = Patch(name, self.__patch_dir)
763 git.switch(patch.get_bottom())
765 # save the new applied list
766 idx = applied.index(name) + 1
768 popped = applied[:idx]
770 unapplied = popped + self.get_unapplied()
772 f = file(self.__unapplied_file, 'w+')
773 f.writelines([line + '\n' for line in unapplied])
779 f = file(self.__applied_file, 'w+')
780 f.writelines([line + '\n' for line in applied])
784 self.__set_current(None)
786 self.__set_current(applied[-1])
788 self.__end_stack_check()
790 def empty_patch(self, name):
791 """Returns True if the patch is empty
793 patch = Patch(name, self.__patch_dir)
794 bottom = patch.get_bottom()
795 top = patch.get_top()
799 elif git.get_commit(top).get_tree() \
800 == git.get_commit(bottom).get_tree():
805 def rename_patch(self, oldname, newname):
806 applied = self.get_applied()
807 unapplied = self.get_unapplied()
809 if oldname == newname:
810 raise StackException, '"To" name and "from" name are the same'
812 if newname in applied or newname in unapplied:
813 raise StackException, 'Patch "%s" already exists' % newname
815 if oldname in unapplied:
816 Patch(oldname, self.__patch_dir).rename(newname)
817 unapplied[unapplied.index(oldname)] = newname
819 f = file(self.__unapplied_file, 'w+')
820 f.writelines([line + '\n' for line in unapplied])
822 elif oldname in applied:
823 Patch(oldname, self.__patch_dir).rename(newname)
824 if oldname == self.get_current():
825 self.__set_current(newname)
827 applied[applied.index(oldname)] = newname
829 f = file(self.__applied_file, 'w+')
830 f.writelines([line + '\n' for line in applied])
833 raise StackException, 'Unknown patch "%s"' % oldname