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
, series_dir
):
126 self
.__series_dir
= series_dir
128 self
.__dir
= os
.path
.join(self
.__series_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
.__series_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.
264 self
.__name
= git
.get_head_file()
265 base_dir
= git
.get_base_dir()
266 except git
.GitException
, ex
:
267 raise StackException
, 'GIT tree not initialised: %s' % ex
269 self
.__series_dir
= os
.path
.join(base_dir
, 'patches',
271 self
.__base_file
= os
.path
.join(base_dir
, 'refs', 'bases',
274 self
.__applied_file
= os
.path
.join(self
.__series_dir
, 'applied')
275 self
.__unapplied_file
= os
.path
.join(self
.__series_dir
, 'unapplied')
276 self
.__current_file
= os
.path
.join(self
.__series_dir
, 'current')
277 self
.__descr_file
= os
.path
.join(self
.__series_dir
, 'description')
279 # where this series keeps its patches
280 self
.__patch_dir
= os
.path
.join(self
.__series_dir
, 'patches')
281 if not os
.path
.isdir(self
.__patch_dir
):
282 self
.__patch_dir
= self
.__series_dir
284 def get_branch(self
):
285 """Return the branch name for the Series object
289 def __set_current(self
, name
):
290 """Sets the topmost patch
293 write_string(self
.__current_file
, name
)
295 create_empty_file(self
.__current_file
)
297 def get_patch(self
, name
):
298 """Return a Patch object for the given name
300 return Patch(name
, self
.__patch_dir
)
302 def get_current(self
):
303 """Return a Patch object representing the topmost patch
305 if os
.path
.isfile(self
.__current_file
):
306 name
= read_string(self
.__current_file
)
314 def get_applied(self
):
315 if not os
.path
.isfile(self
.__applied_file
):
316 raise StackException
, 'Branch "%s" not initialised' % self
.__name
317 f
= file(self
.__applied_file
)
318 names
= [line
.strip() for line
in f
.readlines()]
322 def get_unapplied(self
):
323 if not os
.path
.isfile(self
.__unapplied_file
):
324 raise StackException
, 'Branch "%s" not initialised' % self
.__name
325 f
= file(self
.__unapplied_file
)
326 names
= [line
.strip() for line
in f
.readlines()]
330 def get_base_file(self
):
331 return self
.__base_file
333 def get_protected(self
):
334 return os
.path
.isfile(os
.path
.join(self
.__series_dir
, 'protected'))
337 protect_file
= os
.path
.join(self
.__series_dir
, 'protected')
338 if not os
.path
.isfile(protect_file
):
339 create_empty_file(protect_file
)
342 protect_file
= os
.path
.join(self
.__series_dir
, 'protected')
343 if os
.path
.isfile(protect_file
):
344 os
.remove(protect_file
)
346 def get_description(self
):
347 if os
.path
.isfile(self
.__descr_file
):
348 return read_string(self
.__descr_file
)
352 def __patch_is_current(self
, patch
):
353 return patch
.get_name() == read_string(self
.__current_file
)
355 def __patch_applied(self
, name
):
356 """Return true if the patch exists in the applied list
358 return name
in self
.get_applied()
360 def __patch_unapplied(self
, name
):
361 """Return true if the patch exists in the unapplied list
363 return name
in self
.get_unapplied()
365 def __begin_stack_check(self
):
366 """Save the current HEAD into .git/refs/heads/base if the stack
369 if len(self
.get_applied()) == 0:
370 head
= git
.get_head()
371 write_string(self
.__base_file
, head
)
373 def __end_stack_check(self
):
374 """Remove .git/refs/heads/base if the stack is empty.
375 This warning should never happen
377 if len(self
.get_applied()) == 0 \
378 and read_string(self
.__base_file
) != git
.get_head():
379 print 'Warning: stack empty but the HEAD and base are different'
381 def head_top_equal(self
):
382 """Return true if the head and the top are the same
384 crt
= self
.get_current()
386 # we don't care, no patches applied
388 return git
.get_head() == Patch(crt
, self
.__patch_dir
).get_top()
390 def is_initialised(self
):
391 """Checks if series is already initialised
393 return os
.path
.isdir(self
.__patch_dir
)
396 """Initialises the stgit series
398 bases_dir
= os
.path
.join(git
.get_base_dir(), 'refs', 'bases')
400 if self
.is_initialised():
401 raise StackException
, self
.__patch_dir
+ ' already exists'
402 os
.makedirs(self
.__patch_dir
)
404 if not os
.path
.isdir(bases_dir
):
405 os
.makedirs(bases_dir
)
407 create_empty_file(self
.__applied_file
)
408 create_empty_file(self
.__unapplied_file
)
409 create_empty_file(self
.__descr_file
)
410 os
.makedirs(os
.path
.join(self
.__series_dir
, 'patches'))
411 self
.__begin_stack_check()
413 def rename(self
, to_name
):
416 to_stack
= Series(to_name
)
418 if to_stack
.is_initialised():
419 raise StackException
, '"%s" already exists' % to_stack
.get_branch()
420 if os
.path
.exists(to_stack
.__base_file
):
421 os
.remove(to_stack
.__base_file
)
423 git
.rename_branch(self
.__name
, to_name
)
425 if os
.path
.isdir(self
.__series_dir
):
426 os
.rename(self
.__series_dir
, to_stack
.__series_dir
)
427 if os
.path
.exists(self
.__base_file
):
428 os
.rename(self
.__base_file
, to_stack
.__base_file
)
430 self
.__init__(to_name
)
432 def clone(self
, target_series
):
435 base
= read_string(self
.get_base_file())
436 git
.create_branch(target_series
, tree_id
= base
)
437 Series(target_series
).init()
438 new_series
= Series(target_series
)
440 # generate an artificial description file
441 write_string(new_series
.__descr_file
, 'clone of "%s"' % self
.__name
)
443 # clone self's entire series as unapplied patches
444 patches
= self
.get_applied() + self
.get_unapplied()
447 patch
= self
.get_patch(p
)
448 new_series
.new_patch(p
, message
= patch
.get_description(),
449 can_edit
= False, unapplied
= True,
450 bottom
= patch
.get_bottom(),
451 top
= patch
.get_top(),
452 author_name
= patch
.get_authname(),
453 author_email
= patch
.get_authemail(),
454 author_date
= patch
.get_authdate())
456 # fast forward the cloned series to self's top
457 new_series
.forward_patches(self
.get_applied())
459 def delete(self
, force
= False):
460 """Deletes an stgit series
462 if self
.is_initialised():
463 patches
= self
.get_unapplied() + self
.get_applied()
464 if not force
and patches
:
465 raise StackException
, \
466 'Cannot delete: the series still contains patches'
468 Patch(p
, self
.__patch_dir
).delete()
470 if os
.path
.exists(self
.__applied_file
):
471 os
.remove(self
.__applied_file
)
472 if os
.path
.exists(self
.__unapplied_file
):
473 os
.remove(self
.__unapplied_file
)
474 if os
.path
.exists(self
.__current_file
):
475 os
.remove(self
.__current_file
)
476 if os
.path
.exists(self
.__descr_file
):
477 os
.remove(self
.__descr_file
)
478 if not os
.listdir(self
.__patch_dir
):
479 os
.rmdir(self
.__patch_dir
)
481 print 'Patch directory %s is not empty.' % self
.__name
482 if not os
.listdir(self
.__series_dir
):
483 os
.rmdir(self
.__series_dir
)
485 print 'Series directory %s is not empty.' % self
.__name
487 if os
.path
.exists(self
.__base_file
):
488 os
.remove(self
.__base_file
)
490 def refresh_patch(self
, files
= None, message
= None, edit
= False,
493 author_name
= None, author_email
= None,
495 committer_name
= None, committer_email
= None):
496 """Generates a new commit for the given patch
498 name
= self
.get_current()
500 raise StackException
, 'No patches applied'
502 patch
= Patch(name
, self
.__patch_dir
)
504 descr
= patch
.get_description()
505 if not (message
or descr
):
511 if not message
and edit
:
512 descr
= edit_file(self
, descr
.rstrip(), \
513 'Please edit the description for patch "%s" ' \
514 'above.' % name
, show_patch
)
517 author_name
= patch
.get_authname()
519 author_email
= patch
.get_authemail()
521 author_date
= patch
.get_authdate()
522 if not committer_name
:
523 committer_name
= patch
.get_commname()
524 if not committer_email
:
525 committer_email
= patch
.get_commemail()
527 commit_id
= git
.commit(files
= files
,
528 message
= descr
, parents
= [patch
.get_bottom()],
529 cache_update
= cache_update
,
531 author_name
= author_name
,
532 author_email
= author_email
,
533 author_date
= author_date
,
534 committer_name
= committer_name
,
535 committer_email
= committer_email
)
537 patch
.set_top(commit_id
)
538 patch
.set_description(descr
)
539 patch
.set_authname(author_name
)
540 patch
.set_authemail(author_email
)
541 patch
.set_authdate(author_date
)
542 patch
.set_commname(committer_name
)
543 patch
.set_commemail(committer_email
)
547 def new_patch(self
, name
, message
= None, can_edit
= True,
548 unapplied
= False, show_patch
= False,
549 top
= None, bottom
= None,
550 author_name
= None, author_email
= None, author_date
= None,
551 committer_name
= None, committer_email
= None):
552 """Creates a new patch
554 if self
.__patch_applied(name
) or self
.__patch_unapplied(name
):
555 raise StackException
, 'Patch "%s" already exists' % name
557 if not message
and can_edit
:
558 descr
= edit_file(self
, None, \
559 'Please enter the description for patch "%s" ' \
560 'above.' % name
, show_patch
)
564 head
= git
.get_head()
566 self
.__begin_stack_check()
568 patch
= Patch(name
, self
.__patch_dir
)
572 patch
.set_bottom(bottom
)
574 patch
.set_bottom(head
)
580 patch
.set_description(descr
)
581 patch
.set_authname(author_name
)
582 patch
.set_authemail(author_email
)
583 patch
.set_authdate(author_date
)
584 patch
.set_commname(committer_name
)
585 patch
.set_commemail(committer_email
)
588 patches
= [patch
.get_name()] + self
.get_unapplied()
590 f
= file(self
.__unapplied_file
, 'w+')
591 f
.writelines([line
+ '\n' for line
in patches
])
594 append_string(self
.__applied_file
, patch
.get_name())
595 self
.__set_current(name
)
597 def delete_patch(self
, name
):
600 patch
= Patch(name
, self
.__patch_dir
)
602 if self
.__patch_is_current(patch
):
604 elif self
.__patch_applied(name
):
605 raise StackException
, 'Cannot remove an applied patch, "%s", ' \
606 'which is not current' % name
607 elif not name
in self
.get_unapplied():
608 raise StackException
, 'Unknown patch "%s"' % name
612 unapplied
= self
.get_unapplied()
613 unapplied
.remove(name
)
614 f
= file(self
.__unapplied_file
, 'w+')
615 f
.writelines([line
+ '\n' for line
in unapplied
])
618 def forward_patches(self
, names
):
619 """Try to fast-forward an array of patches.
621 On return, patches in names[0:returned_value] have been pushed on the
622 stack. Apply the rest with push_patch
624 unapplied
= self
.get_unapplied()
625 self
.__begin_stack_check()
631 assert(name
in unapplied
)
633 patch
= Patch(name
, self
.__patch_dir
)
636 bottom
= patch
.get_bottom()
637 top
= patch
.get_top()
639 # top != bottom always since we have a commit for each patch
641 # reset the backup information
642 patch
.set_bottom(head
, backup
= True)
643 patch
.set_top(top
, backup
= True)
646 head_tree
= git
.get_commit(head
).get_tree()
647 bottom_tree
= git
.get_commit(bottom
).get_tree()
648 if head_tree
== bottom_tree
:
649 # We must just reparent this patch and create a new commit
651 descr
= patch
.get_description()
652 author_name
= patch
.get_authname()
653 author_email
= patch
.get_authemail()
654 author_date
= patch
.get_authdate()
655 committer_name
= patch
.get_commname()
656 committer_email
= patch
.get_commemail()
658 top_tree
= git
.get_commit(top
).get_tree()
660 top
= git
.commit(message
= descr
, parents
= [head
],
661 cache_update
= False,
664 author_name
= author_name
,
665 author_email
= author_email
,
666 author_date
= author_date
,
667 committer_name
= committer_name
,
668 committer_email
= committer_email
)
670 patch
.set_bottom(head
, backup
= True)
671 patch
.set_top(top
, backup
= True)
674 # stop the fast-forwarding, must do a real merge
678 unapplied
.remove(name
)
685 append_strings(self
.__applied_file
, names
[0:forwarded
])
687 f
= file(self
.__unapplied_file
, 'w+')
688 f
.writelines([line
+ '\n' for line
in unapplied
])
691 self
.__set_current(name
)
695 def push_patch(self
, name
):
696 """Pushes a patch on the stack
698 unapplied
= self
.get_unapplied()
699 assert(name
in unapplied
)
701 self
.__begin_stack_check()
703 patch
= Patch(name
, self
.__patch_dir
)
705 head
= git
.get_head()
706 bottom
= patch
.get_bottom()
707 top
= patch
.get_top()
712 # top != bottom always since we have a commit for each patch
714 # reset the backup information
715 patch
.set_bottom(bottom
, backup
= True)
716 patch
.set_top(top
, backup
= True)
720 # new patch needs to be refreshed.
721 # The current patch is empty after merge.
722 patch
.set_bottom(head
, backup
= True)
723 patch
.set_top(head
, backup
= True)
725 # Try the fast applying first. If this fails, fall back to the
727 if not git
.apply_diff(bottom
, top
):
728 # if git.apply_diff() fails, the patch requires a diff3
729 # merge and can be reported as modified
732 # merge can fail but the patch needs to be pushed
734 git
.merge(bottom
, head
, top
)
735 except git
.GitException
, ex
:
736 print >> sys
.stderr
, \
737 'The merge failed during "push". ' \
738 'Use "refresh" after fixing the conflicts'
740 append_string(self
.__applied_file
, name
)
742 unapplied
.remove(name
)
743 f
= file(self
.__unapplied_file
, 'w+')
744 f
.writelines([line
+ '\n' for line
in unapplied
])
747 self
.__set_current(name
)
749 # head == bottom case doesn't need to refresh the patch
752 # if the merge was OK and no conflicts, just refresh the patch
753 # The GIT cache was already updated by the merge operation
754 self
.refresh_patch(cache_update
= False)
756 raise StackException
, str(ex
)
761 name
= self
.get_current()
764 patch
= Patch(name
, self
.__patch_dir
)
767 return patch
.restore_old_boundaries()
769 def pop_patch(self
, name
):
770 """Pops the top patch from the stack
772 applied
= self
.get_applied()
774 assert(name
in applied
)
776 patch
= Patch(name
, self
.__patch_dir
)
778 git
.switch(patch
.get_bottom())
780 # save the new applied list
781 idx
= applied
.index(name
) + 1
783 popped
= applied
[:idx
]
785 unapplied
= popped
+ self
.get_unapplied()
787 f
= file(self
.__unapplied_file
, 'w+')
788 f
.writelines([line
+ '\n' for line
in unapplied
])
794 f
= file(self
.__applied_file
, 'w+')
795 f
.writelines([line
+ '\n' for line
in applied
])
799 self
.__set_current(None)
801 self
.__set_current(applied
[-1])
803 self
.__end_stack_check()
805 def empty_patch(self
, name
):
806 """Returns True if the patch is empty
808 patch
= Patch(name
, self
.__patch_dir
)
809 bottom
= patch
.get_bottom()
810 top
= patch
.get_top()
814 elif git
.get_commit(top
).get_tree() \
815 == git
.get_commit(bottom
).get_tree():
820 def rename_patch(self
, oldname
, newname
):
821 applied
= self
.get_applied()
822 unapplied
= self
.get_unapplied()
824 if oldname
== newname
:
825 raise StackException
, '"To" name and "from" name are the same'
827 if newname
in applied
or newname
in unapplied
:
828 raise StackException
, 'Patch "%s" already exists' % newname
830 if oldname
in unapplied
:
831 Patch(oldname
, self
.__patch_dir
).rename(newname
)
832 unapplied
[unapplied
.index(oldname
)] = newname
834 f
= file(self
.__unapplied_file
, 'w+')
835 f
.writelines([line
+ '\n' for line
in unapplied
])
837 elif oldname
in applied
:
838 Patch(oldname
, self
.__patch_dir
).rename(newname
)
839 if oldname
== self
.get_current():
840 self
.__set_current(newname
)
842 applied
[applied
.index(oldname
)] = newname
844 f
= file(self
.__applied_file
, 'w+')
845 f
.writelines([line
+ '\n' for line
in applied
])
848 raise StackException
, 'Unknown patch "%s"' % oldname