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, string, comment, show_patch = True):
69 tmpl = os.path.join(git.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:'
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 string = read_string(id_file, multiline)
161 def __set_field(self, name, string, multiline = False):
162 fname = os.path.join(self.__dir, name)
163 if string and string != '':
164 write_string(fname, string, multiline)
165 elif os.path.isfile(fname):
168 def get_bottom(self):
169 return self.__get_field('bottom')
171 def set_bottom(self, string, backup = False):
173 curr = self.__get_field('bottom')
175 self.__set_field('bottom.old', curr)
177 self.__set_field('bottom.old', None)
178 self.__set_field('bottom', string)
181 return self.__get_field('top')
183 def set_top(self, string, backup = False):
185 curr = self.__get_field('top')
187 self.__set_field('top.old', curr)
189 self.__set_field('top.old', None)
190 self.__set_field('top', string)
192 def restore_old_boundaries(self):
193 bottom = self.__get_field('bottom.old')
194 top = self.__get_field('top.old')
197 self.__set_field('bottom', bottom)
198 self.__set_field('top', top)
203 def get_description(self):
204 return self.__get_field('description', True)
206 def set_description(self, string):
207 self.__set_field('description', string, True)
209 def get_authname(self):
210 return self.__get_field('authname')
212 def set_authname(self, string):
213 if not string and config.has_option('stgit', 'authname'):
214 string = config.get('stgit', 'authname')
215 self.__set_field('authname', string)
217 def get_authemail(self):
218 return self.__get_field('authemail')
220 def set_authemail(self, string):
221 if not string and config.has_option('stgit', 'authemail'):
222 string = config.get('stgit', 'authemail')
223 self.__set_field('authemail', string)
225 def get_authdate(self):
226 return self.__get_field('authdate')
228 def set_authdate(self, string):
229 self.__set_field('authdate', string)
231 def get_commname(self):
232 return self.__get_field('commname')
234 def set_commname(self, string):
235 if not string and config.has_option('stgit', 'commname'):
236 string = config.get('stgit', 'commname')
237 self.__set_field('commname', string)
239 def get_commemail(self):
240 return self.__get_field('commemail')
242 def set_commemail(self, string):
243 if not string and config.has_option('stgit', 'commemail'):
244 string = config.get('stgit', 'commemail')
245 self.__set_field('commemail', string)
249 """Class including the operations on series
251 def __init__(self, name = None):
252 """Takes a series name as the parameter.
257 self.__name = git.get_head_file()
260 self.__patch_dir = os.path.join(git.base_dir, 'patches',
262 self.__base_file = os.path.join(git.base_dir, 'refs', 'bases',
264 self.__applied_file = os.path.join(self.__patch_dir, 'applied')
265 self.__unapplied_file = os.path.join(self.__patch_dir, 'unapplied')
266 self.__current_file = os.path.join(self.__patch_dir, 'current')
268 def get_branch(self):
269 """Return the branch name for the Series object
273 def __set_current(self, name):
274 """Sets the topmost patch
277 write_string(self.__current_file, name)
279 create_empty_file(self.__current_file)
281 def get_patch(self, name):
282 """Return a Patch object for the given name
284 return Patch(name, self.__patch_dir)
286 def get_current(self):
287 """Return a Patch object representing the topmost patch
289 if os.path.isfile(self.__current_file):
290 name = read_string(self.__current_file)
298 def get_applied(self):
299 if not os.path.isfile(self.__applied_file):
300 raise StackException, \
301 'No StGIT metadata found. Try "stg init" first'
302 f = file(self.__applied_file)
303 names = [line.strip() for line in f.readlines()]
307 def get_unapplied(self):
308 if not os.path.isfile(self.__unapplied_file):
309 raise StackException, \
310 'No StGIT metadata found. Try "stg init" first'
311 f = file(self.__unapplied_file)
312 names = [line.strip() for line in f.readlines()]
316 def get_base_file(self):
317 return self.__base_file
319 def __patch_is_current(self, patch):
320 return patch.get_name() == read_string(self.__current_file)
322 def __patch_applied(self, name):
323 """Return true if the patch exists in the applied list
325 return name in self.get_applied()
327 def __patch_unapplied(self, name):
328 """Return true if the patch exists in the unapplied list
330 return name in self.get_unapplied()
332 def __begin_stack_check(self):
333 """Save the current HEAD into .git/refs/heads/base if the stack
336 if len(self.get_applied()) == 0:
337 head = git.get_head()
338 write_string(self.__base_file, head)
340 def __end_stack_check(self):
341 """Remove .git/refs/heads/base if the stack is empty.
342 This warning should never happen
344 if len(self.get_applied()) == 0 \
345 and read_string(self.__base_file) != git.get_head():
346 print 'Warning: stack empty but the HEAD and base are different'
348 def head_top_equal(self):
349 """Return true if the head and the top are the same
351 crt = self.get_current()
353 # we don't care, no patches applied
355 return git.get_head() == Patch(crt, self.__patch_dir).get_top()
358 """Initialises the stgit series
360 bases_dir = os.path.join(git.base_dir, 'refs', 'bases')
362 if os.path.isdir(self.__patch_dir):
363 raise StackException, self.__patch_dir + ' already exists'
364 os.makedirs(self.__patch_dir)
366 if not os.path.isdir(bases_dir):
367 os.makedirs(bases_dir)
369 create_empty_file(self.__applied_file)
370 create_empty_file(self.__unapplied_file)
371 self.__begin_stack_check()
373 def refresh_patch(self, message = None, edit = False, show_patch = False,
375 author_name = None, author_email = None,
377 committer_name = None, committer_email = None,
378 commit_only = False):
379 """Generates a new commit for the given patch
381 name = self.get_current()
383 raise StackException, 'No patches applied'
385 patch = Patch(name, self.__patch_dir)
387 descr = patch.get_description()
388 if not (message or descr):
394 if not message and edit:
395 descr = edit_file(self, descr.rstrip(), \
396 'Please edit the description for patch "%s" ' \
397 'above.' % name, show_patch)
400 author_name = patch.get_authname()
402 author_email = patch.get_authemail()
404 author_date = patch.get_authdate()
405 if not committer_name:
406 committer_name = patch.get_commname()
407 if not committer_email:
408 committer_email = patch.get_commemail()
410 commit_id = git.commit(message = descr, parents = [patch.get_bottom()],
411 cache_update = cache_update,
413 author_name = author_name,
414 author_email = author_email,
415 author_date = author_date,
416 committer_name = committer_name,
417 committer_email = committer_email)
420 patch.set_top(commit_id)
421 patch.set_description(descr)
422 patch.set_authname(author_name)
423 patch.set_authemail(author_email)
424 patch.set_authdate(author_date)
425 patch.set_commname(committer_name)
426 patch.set_commemail(committer_email)
430 def new_patch(self, name, message = None, can_edit = True,
431 unapplied = False, show_patch = False,
432 top = None, bottom = None,
433 author_name = None, author_email = None, author_date = None,
434 committer_name = None, committer_email = None):
435 """Creates a new patch
437 if self.__patch_applied(name) or self.__patch_unapplied(name):
438 raise StackException, 'Patch "%s" already exists' % name
440 if not message and can_edit:
441 descr = edit_file(self, None, \
442 'Please enter the description for patch "%s" ' \
443 'above.' % name, show_patch)
447 head = git.get_head()
449 self.__begin_stack_check()
451 patch = Patch(name, self.__patch_dir)
455 patch.set_bottom(bottom)
457 patch.set_bottom(head)
463 patch.set_description(descr)
464 patch.set_authname(author_name)
465 patch.set_authemail(author_email)
466 patch.set_authdate(author_date)
467 patch.set_commname(committer_name)
468 patch.set_commemail(committer_email)
471 patches = [patch.get_name()] + self.get_unapplied()
473 f = file(self.__unapplied_file, 'w+')
474 f.writelines([line + '\n' for line in patches])
477 append_string(self.__applied_file, patch.get_name())
478 self.__set_current(name)
480 def delete_patch(self, name):
483 patch = Patch(name, self.__patch_dir)
485 if self.__patch_is_current(patch):
487 elif self.__patch_applied(name):
488 raise StackException, 'Cannot remove an applied patch, "%s", ' \
489 'which is not current' % name
490 elif not name in self.get_unapplied():
491 raise StackException, 'Unknown patch "%s"' % name
495 unapplied = self.get_unapplied()
496 unapplied.remove(name)
497 f = file(self.__unapplied_file, 'w+')
498 f.writelines([line + '\n' for line in unapplied])
501 def forward_patches(self, names):
502 """Try to fast-forward an array of patches.
504 On return, patches in names[0:returned_value] have been pushed on the
505 stack. Apply the rest with push_patch
507 unapplied = self.get_unapplied()
508 self.__begin_stack_check()
514 assert(name in unapplied)
516 patch = Patch(name, self.__patch_dir)
519 bottom = patch.get_bottom()
520 top = patch.get_top()
522 # top != bottom always since we have a commit for each patch
524 # reset the backup information
525 patch.set_bottom(head, backup = True)
526 patch.set_top(top, backup = True)
529 head_tree = git.get_commit(head).get_tree()
530 bottom_tree = git.get_commit(bottom).get_tree()
531 if head_tree == bottom_tree:
532 # We must just reparent this patch and create a new commit
534 descr = patch.get_description()
535 author_name = patch.get_authname()
536 author_email = patch.get_authemail()
537 author_date = patch.get_authdate()
538 committer_name = patch.get_commname()
539 committer_email = patch.get_commemail()
541 top_tree = git.get_commit(top).get_tree()
543 top = git.commit(message = descr, parents = [head],
544 cache_update = False,
547 author_name = author_name,
548 author_email = author_email,
549 author_date = author_date,
550 committer_name = committer_name,
551 committer_email = committer_email)
553 patch.set_bottom(head, backup = True)
554 patch.set_top(top, backup = True)
557 # stop the fast-forwarding, must do a real merge
561 unapplied.remove(name)
565 append_strings(self.__applied_file, names[0:forwarded])
567 f = file(self.__unapplied_file, 'w+')
568 f.writelines([line + '\n' for line in unapplied])
571 self.__set_current(name)
575 def push_patch(self, name):
576 """Pushes a patch on the stack
578 unapplied = self.get_unapplied()
579 assert(name in unapplied)
581 self.__begin_stack_check()
583 patch = Patch(name, self.__patch_dir)
585 head = git.get_head()
586 bottom = patch.get_bottom()
587 top = patch.get_top()
591 # top != bottom always since we have a commit for each patch
593 # reset the backup information
594 patch.set_bottom(bottom, backup = True)
595 patch.set_top(top, backup = True)
599 # new patch needs to be refreshed.
600 # The current patch is empty after merge.
601 patch.set_bottom(head, backup = True)
602 patch.set_top(head, backup = True)
603 # merge/refresh can fail but the patch needs to be pushed
605 git.merge(bottom, head, top)
606 except git.GitException, ex:
607 print >> sys.stderr, \
608 'The merge failed during "push". ' \
609 'Use "refresh" after fixing the conflicts'
612 append_string(self.__applied_file, name)
614 unapplied.remove(name)
615 f = file(self.__unapplied_file, 'w+')
616 f.writelines([line + '\n' for line in unapplied])
619 self.__set_current(name)
621 # head == bottom case doesn't need to refresh the patch
624 # if the merge was OK and no conflicts, just refresh the patch
625 # The GIT cache was already updated by the merge operation
626 self.refresh_patch(cache_update = False)
628 raise StackException, str(ex)
631 name = self.get_current()
634 patch = Patch(name, self.__patch_dir)
637 return patch.restore_old_boundaries()
639 def pop_patch(self, name):
640 """Pops the top patch from the stack
642 applied = self.get_applied()
644 assert(name in applied)
646 patch = Patch(name, self.__patch_dir)
648 git.switch(patch.get_bottom())
650 # save the new applied list
651 idx = applied.index(name) + 1
653 popped = applied[:idx]
655 unapplied = popped + self.get_unapplied()
657 f = file(self.__unapplied_file, 'w+')
658 f.writelines([line + '\n' for line in unapplied])
664 f = file(self.__applied_file, 'w+')
665 f.writelines([line + '\n' for line in applied])
669 self.__set_current(None)
671 self.__set_current(applied[-1])
673 self.__end_stack_check()
675 def empty_patch(self, name):
676 """Returns True if the patch is empty
678 patch = Patch(name, self.__patch_dir)
679 bottom = patch.get_bottom()
680 top = patch.get_top()
684 elif git.get_commit(top).get_tree() \
685 == git.get_commit(bottom).get_tree():
690 def rename_patch(self, oldname, newname):
691 applied = self.get_applied()
692 unapplied = self.get_unapplied()
694 if newname in applied or newname in unapplied:
695 raise StackException, 'Patch "%s" already exists' % newname
697 if oldname in unapplied:
698 Patch(oldname, self.__patch_dir).rename(newname)
699 unapplied[unapplied.index(oldname)] = newname
701 f = file(self.__unapplied_file, 'w+')
702 f.writelines([line + '\n' for line in unapplied])
704 elif oldname in applied:
705 Patch(oldname, self.__patch_dir).rename(newname)
706 if oldname == self.get_current():
707 self.__set_current(newname)
709 applied[applied.index(oldname)] = newname
711 f = file(self.__applied_file, 'w+')
712 f.writelines([line + '\n' for line in applied])
715 raise StackException, 'Unknown patch "%s"' % oldname