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
.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 self
.__patch_dir
= os
.path
.join(git
.base_dir
, 'patches',
268 self
.__base_file
= os
.path
.join(git
.base_dir
, 'refs', 'bases',
270 self
.__applied_file
= os
.path
.join(self
.__patch_dir
, 'applied')
271 self
.__unapplied_file
= os
.path
.join(self
.__patch_dir
, 'unapplied')
272 self
.__current_file
= os
.path
.join(self
.__patch_dir
, 'current')
273 self
.__descr_file
= os
.path
.join(self
.__patch_dir
, 'description')
275 def get_branch(self
):
276 """Return the branch name for the Series object
280 def __set_current(self
, name
):
281 """Sets the topmost patch
284 write_string(self
.__current_file
, name
)
286 create_empty_file(self
.__current_file
)
288 def get_patch(self
, name
):
289 """Return a Patch object for the given name
291 return Patch(name
, self
.__patch_dir
)
293 def get_current(self
):
294 """Return a Patch object representing the topmost patch
296 if os
.path
.isfile(self
.__current_file
):
297 name
= read_string(self
.__current_file
)
305 def get_applied(self
):
306 if not os
.path
.isfile(self
.__applied_file
):
307 raise StackException
, 'Branch "%s" not initialised' % self
.__name
308 f
= file(self
.__applied_file
)
309 names
= [line
.strip() for line
in f
.readlines()]
313 def get_unapplied(self
):
314 if not os
.path
.isfile(self
.__unapplied_file
):
315 raise StackException
, 'Branch "%s" not initialised' % self
.__name
316 f
= file(self
.__unapplied_file
)
317 names
= [line
.strip() for line
in f
.readlines()]
321 def get_base_file(self
):
322 return self
.__base_file
324 def get_protected(self
):
325 return os
.path
.isfile(os
.path
.join(self
.__patch_dir
, 'protected'))
328 protect_file
= os
.path
.join(self
.__patch_dir
, 'protected')
329 if not os
.path
.isfile(protect_file
):
330 create_empty_file(protect_file
)
333 protect_file
= os
.path
.join(self
.__patch_dir
, 'protected')
334 if os
.path
.isfile(protect_file
):
335 os
.remove(protect_file
)
337 def get_description(self
):
338 if os
.path
.isfile(self
.__descr_file
):
339 return read_string(self
.__descr_file
)
343 def __patch_is_current(self
, patch
):
344 return patch
.get_name() == read_string(self
.__current_file
)
346 def __patch_applied(self
, name
):
347 """Return true if the patch exists in the applied list
349 return name
in self
.get_applied()
351 def __patch_unapplied(self
, name
):
352 """Return true if the patch exists in the unapplied list
354 return name
in self
.get_unapplied()
356 def __begin_stack_check(self
):
357 """Save the current HEAD into .git/refs/heads/base if the stack
360 if len(self
.get_applied()) == 0:
361 head
= git
.get_head()
362 write_string(self
.__base_file
, head
)
364 def __end_stack_check(self
):
365 """Remove .git/refs/heads/base if the stack is empty.
366 This warning should never happen
368 if len(self
.get_applied()) == 0 \
369 and read_string(self
.__base_file
) != git
.get_head():
370 print 'Warning: stack empty but the HEAD and base are different'
372 def head_top_equal(self
):
373 """Return true if the head and the top are the same
375 crt
= self
.get_current()
377 # we don't care, no patches applied
379 return git
.get_head() == Patch(crt
, self
.__patch_dir
).get_top()
381 def is_initialised(self
):
382 """Checks if series is already initialised
384 return os
.path
.isdir(self
.__patch_dir
)
387 """Initialises the stgit series
389 bases_dir
= os
.path
.join(git
.base_dir
, 'refs', 'bases')
391 if self
.is_initialised():
392 raise StackException
, self
.__patch_dir
+ ' already exists'
393 os
.makedirs(self
.__patch_dir
)
395 if not os
.path
.isdir(bases_dir
):
396 os
.makedirs(bases_dir
)
398 create_empty_file(self
.__applied_file
)
399 create_empty_file(self
.__unapplied_file
)
400 create_empty_file(self
.__descr_file
)
401 self
.__begin_stack_check()
403 def rename(self
, to_name
):
406 to_stack
= Series(to_name
)
408 if to_stack
.is_initialised():
409 raise StackException
, '"%s" already exists' % to_stack
.get_branch()
410 if os
.path
.exists(to_stack
.__base_file
):
411 os
.remove(to_stack
.__base_file
)
413 git
.rename_branch(self
.__name
, to_name
)
415 if os
.path
.isdir(self
.__patch_dir
):
416 os
.rename(self
.__patch_dir
, to_stack
.__patch_dir
)
417 if os
.path
.exists(self
.__base_file
):
418 os
.rename(self
.__base_file
, to_stack
.__base_file
)
420 self
.__init__(to_name
)
422 def delete(self
, force
= False):
423 """Deletes an stgit series
425 if self
.is_initialised():
426 patches
= self
.get_unapplied() + self
.get_applied()
427 if not force
and patches
:
428 raise StackException
, \
429 'Cannot delete: the series still contains patches'
431 Patch(p
, self
.__patch_dir
).delete()
433 if os
.path
.exists(self
.__applied_file
):
434 os
.remove(self
.__applied_file
)
435 if os
.path
.exists(self
.__unapplied_file
):
436 os
.remove(self
.__unapplied_file
)
437 if os
.path
.exists(self
.__current_file
):
438 os
.remove(self
.__current_file
)
439 if os
.path
.exists(self
.__descr_file
):
440 os
.remove(self
.__descr_file
)
441 if not os
.listdir(self
.__patch_dir
):
442 os
.rmdir(self
.__patch_dir
)
444 print 'Series directory %s is not empty.' % self
.__name
446 if os
.path
.exists(self
.__base_file
):
447 os
.remove(self
.__base_file
)
449 def refresh_patch(self
, message
= None, edit
= False, show_patch
= False,
451 author_name
= None, author_email
= None,
453 committer_name
= None, committer_email
= None):
454 """Generates a new commit for the given patch
456 name
= self
.get_current()
458 raise StackException
, 'No patches applied'
460 patch
= Patch(name
, self
.__patch_dir
)
462 descr
= patch
.get_description()
463 if not (message
or descr
):
469 if not message
and edit
:
470 descr
= edit_file(self
, descr
.rstrip(), \
471 'Please edit the description for patch "%s" ' \
472 'above.' % name
, show_patch
)
475 author_name
= patch
.get_authname()
477 author_email
= patch
.get_authemail()
479 author_date
= patch
.get_authdate()
480 if not committer_name
:
481 committer_name
= patch
.get_commname()
482 if not committer_email
:
483 committer_email
= patch
.get_commemail()
485 commit_id
= git
.commit(message
= descr
, parents
= [patch
.get_bottom()],
486 cache_update
= cache_update
,
488 author_name
= author_name
,
489 author_email
= author_email
,
490 author_date
= author_date
,
491 committer_name
= committer_name
,
492 committer_email
= committer_email
)
494 patch
.set_top(commit_id
)
495 patch
.set_description(descr
)
496 patch
.set_authname(author_name
)
497 patch
.set_authemail(author_email
)
498 patch
.set_authdate(author_date
)
499 patch
.set_commname(committer_name
)
500 patch
.set_commemail(committer_email
)
504 def new_patch(self
, name
, message
= None, can_edit
= True,
505 unapplied
= False, show_patch
= False,
506 top
= None, bottom
= None,
507 author_name
= None, author_email
= None, author_date
= None,
508 committer_name
= None, committer_email
= None):
509 """Creates a new patch
511 if self
.__patch_applied(name
) or self
.__patch_unapplied(name
):
512 raise StackException
, 'Patch "%s" already exists' % name
514 if not message
and can_edit
:
515 descr
= edit_file(self
, None, \
516 'Please enter the description for patch "%s" ' \
517 'above.' % name
, show_patch
)
521 head
= git
.get_head()
523 self
.__begin_stack_check()
525 patch
= Patch(name
, self
.__patch_dir
)
529 patch
.set_bottom(bottom
)
531 patch
.set_bottom(head
)
537 patch
.set_description(descr
)
538 patch
.set_authname(author_name
)
539 patch
.set_authemail(author_email
)
540 patch
.set_authdate(author_date
)
541 patch
.set_commname(committer_name
)
542 patch
.set_commemail(committer_email
)
545 patches
= [patch
.get_name()] + self
.get_unapplied()
547 f
= file(self
.__unapplied_file
, 'w+')
548 f
.writelines([line
+ '\n' for line
in patches
])
551 append_string(self
.__applied_file
, patch
.get_name())
552 self
.__set_current(name
)
554 def delete_patch(self
, name
):
557 patch
= Patch(name
, self
.__patch_dir
)
559 if self
.__patch_is_current(patch
):
561 elif self
.__patch_applied(name
):
562 raise StackException
, 'Cannot remove an applied patch, "%s", ' \
563 'which is not current' % name
564 elif not name
in self
.get_unapplied():
565 raise StackException
, 'Unknown patch "%s"' % name
569 unapplied
= self
.get_unapplied()
570 unapplied
.remove(name
)
571 f
= file(self
.__unapplied_file
, 'w+')
572 f
.writelines([line
+ '\n' for line
in unapplied
])
575 def forward_patches(self
, names
):
576 """Try to fast-forward an array of patches.
578 On return, patches in names[0:returned_value] have been pushed on the
579 stack. Apply the rest with push_patch
581 unapplied
= self
.get_unapplied()
582 self
.__begin_stack_check()
588 assert(name
in unapplied
)
590 patch
= Patch(name
, self
.__patch_dir
)
593 bottom
= patch
.get_bottom()
594 top
= patch
.get_top()
596 # top != bottom always since we have a commit for each patch
598 # reset the backup information
599 patch
.set_bottom(head
, backup
= True)
600 patch
.set_top(top
, backup
= True)
603 head_tree
= git
.get_commit(head
).get_tree()
604 bottom_tree
= git
.get_commit(bottom
).get_tree()
605 if head_tree
== bottom_tree
:
606 # We must just reparent this patch and create a new commit
608 descr
= patch
.get_description()
609 author_name
= patch
.get_authname()
610 author_email
= patch
.get_authemail()
611 author_date
= patch
.get_authdate()
612 committer_name
= patch
.get_commname()
613 committer_email
= patch
.get_commemail()
615 top_tree
= git
.get_commit(top
).get_tree()
617 top
= git
.commit(message
= descr
, parents
= [head
],
618 cache_update
= False,
621 author_name
= author_name
,
622 author_email
= author_email
,
623 author_date
= author_date
,
624 committer_name
= committer_name
,
625 committer_email
= committer_email
)
627 patch
.set_bottom(head
, backup
= True)
628 patch
.set_top(top
, backup
= True)
631 # stop the fast-forwarding, must do a real merge
635 unapplied
.remove(name
)
639 append_strings(self
.__applied_file
, names
[0:forwarded
])
641 f
= file(self
.__unapplied_file
, 'w+')
642 f
.writelines([line
+ '\n' for line
in unapplied
])
645 self
.__set_current(name
)
649 def push_patch(self
, name
):
650 """Pushes a patch on the stack
652 unapplied
= self
.get_unapplied()
653 assert(name
in unapplied
)
655 self
.__begin_stack_check()
657 patch
= Patch(name
, self
.__patch_dir
)
659 head
= git
.get_head()
660 bottom
= patch
.get_bottom()
661 top
= patch
.get_top()
666 # top != bottom always since we have a commit for each patch
668 # reset the backup information
669 patch
.set_bottom(bottom
, backup
= True)
670 patch
.set_top(top
, backup
= True)
674 # new patch needs to be refreshed.
675 # The current patch is empty after merge.
676 patch
.set_bottom(head
, backup
= True)
677 patch
.set_top(head
, backup
= True)
679 # Try the fast applying first. If this fails, fall back to the
681 if not git
.apply_diff(bottom
, top
):
682 # if git.apply_diff() fails, the patch requires a diff3
683 # merge and can be reported as modified
686 # merge can fail but the patch needs to be pushed
688 git
.merge(bottom
, head
, top
)
689 except git
.GitException
, ex
:
690 print >> sys
.stderr
, \
691 'The merge failed during "push". ' \
692 'Use "refresh" after fixing the conflicts'
694 append_string(self
.__applied_file
, name
)
696 unapplied
.remove(name
)
697 f
= file(self
.__unapplied_file
, 'w+')
698 f
.writelines([line
+ '\n' for line
in unapplied
])
701 self
.__set_current(name
)
703 # head == bottom case doesn't need to refresh the patch
706 # if the merge was OK and no conflicts, just refresh the patch
707 # The GIT cache was already updated by the merge operation
708 self
.refresh_patch(cache_update
= False)
710 raise StackException
, str(ex
)
715 name
= self
.get_current()
718 patch
= Patch(name
, self
.__patch_dir
)
721 return patch
.restore_old_boundaries()
723 def pop_patch(self
, name
):
724 """Pops the top patch from the stack
726 applied
= self
.get_applied()
728 assert(name
in applied
)
730 patch
= Patch(name
, self
.__patch_dir
)
732 git
.switch(patch
.get_bottom())
734 # save the new applied list
735 idx
= applied
.index(name
) + 1
737 popped
= applied
[:idx
]
739 unapplied
= popped
+ self
.get_unapplied()
741 f
= file(self
.__unapplied_file
, 'w+')
742 f
.writelines([line
+ '\n' for line
in unapplied
])
748 f
= file(self
.__applied_file
, 'w+')
749 f
.writelines([line
+ '\n' for line
in applied
])
753 self
.__set_current(None)
755 self
.__set_current(applied
[-1])
757 self
.__end_stack_check()
759 def empty_patch(self
, name
):
760 """Returns True if the patch is empty
762 patch
= Patch(name
, self
.__patch_dir
)
763 bottom
= patch
.get_bottom()
764 top
= patch
.get_top()
768 elif git
.get_commit(top
).get_tree() \
769 == git
.get_commit(bottom
).get_tree():
774 def rename_patch(self
, oldname
, newname
):
775 applied
= self
.get_applied()
776 unapplied
= self
.get_unapplied()
778 if oldname
== newname
:
779 raise StackException
, '"To" name and "from" name are the same'
781 if newname
in applied
or newname
in unapplied
:
782 raise StackException
, 'Patch "%s" already exists' % newname
784 if oldname
in unapplied
:
785 Patch(oldname
, self
.__patch_dir
).rename(newname
)
786 unapplied
[unapplied
.index(oldname
)] = newname
788 f
= file(self
.__unapplied_file
, 'w+')
789 f
.writelines([line
+ '\n' for line
in unapplied
])
791 elif oldname
in applied
:
792 Patch(oldname
, self
.__patch_dir
).rename(newname
)
793 if oldname
== self
.get_current():
794 self
.__set_current(newname
)
796 applied
[applied
.index(oldname
)] = newname
798 f
= file(self
.__applied_file
, 'w+')
799 f
.writelines([line
+ '\n' for line
in applied
])
802 raise StackException
, 'Unknown patch "%s"' % oldname