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. A valid .git/patches/name
253 directory should exist
258 self
.__name
= git
.get_head_file()
261 self
.__patch_dir
= os
.path
.join(git
.base_dir
, 'patches',
263 self
.__base_file
= os
.path
.join(git
.base_dir
, 'refs', 'bases',
265 self
.__applied_file
= os
.path
.join(self
.__patch_dir
, 'applied')
266 self
.__unapplied_file
= os
.path
.join(self
.__patch_dir
, 'unapplied')
267 self
.__current_file
= os
.path
.join(self
.__patch_dir
, 'current')
269 def get_branch(self
):
270 """Return the branch name for the Series object
274 def __set_current(self
, name
):
275 """Sets the topmost patch
278 write_string(self
.__current_file
, name
)
280 create_empty_file(self
.__current_file
)
282 def get_patch(self
, name
):
283 """Return a Patch object for the given name
285 return Patch(name
, self
.__patch_dir
)
287 def get_current(self
):
288 """Return a Patch object representing the topmost patch
290 if os
.path
.isfile(self
.__current_file
):
291 name
= read_string(self
.__current_file
)
299 def get_applied(self
):
300 f
= file(self
.__applied_file
)
301 names
= [line
.strip() for line
in f
.readlines()]
305 def get_unapplied(self
):
306 f
= file(self
.__unapplied_file
)
307 names
= [line
.strip() for line
in f
.readlines()]
311 def get_base_file(self
):
312 return self
.__base_file
314 def __patch_is_current(self
, patch
):
315 return patch
.get_name() == read_string(self
.__current_file
)
317 def __patch_applied(self
, name
):
318 """Return true if the patch exists in the applied list
320 return name
in self
.get_applied()
322 def __patch_unapplied(self
, name
):
323 """Return true if the patch exists in the unapplied list
325 return name
in self
.get_unapplied()
327 def __begin_stack_check(self
):
328 """Save the current HEAD into .git/refs/heads/base if the stack
331 if len(self
.get_applied()) == 0:
332 head
= git
.get_head()
333 write_string(self
.__base_file
, head
)
335 def __end_stack_check(self
):
336 """Remove .git/refs/heads/base if the stack is empty.
337 This warning should never happen
339 if len(self
.get_applied()) == 0 \
340 and read_string(self
.__base_file
) != git
.get_head():
341 print 'Warning: stack empty but the HEAD and base are different'
343 def head_top_equal(self
):
344 """Return true if the head and the top are the same
346 crt
= self
.get_current()
348 # we don't care, no patches applied
350 return git
.get_head() == Patch(crt
, self
.__patch_dir
).get_top()
353 """Initialises the stgit series
355 bases_dir
= os
.path
.join(git
.base_dir
, 'refs', 'bases')
357 if os
.path
.isdir(self
.__patch_dir
):
358 raise StackException
, self
.__patch_dir
+ ' already exists'
359 os
.makedirs(self
.__patch_dir
)
361 if not os
.path
.isdir(bases_dir
):
362 os
.makedirs(bases_dir
)
364 create_empty_file(self
.__applied_file
)
365 create_empty_file(self
.__unapplied_file
)
366 self
.__begin_stack_check()
368 def refresh_patch(self
, message
= None, edit
= False, show_patch
= False,
370 author_name
= None, author_email
= None,
372 committer_name
= None, committer_email
= None,
373 commit_only
= False):
374 """Generates a new commit for the given patch
376 name
= self
.get_current()
378 raise StackException
, 'No patches applied'
380 patch
= Patch(name
, self
.__patch_dir
)
382 descr
= patch
.get_description()
383 if not (message
or descr
):
389 if not message
and edit
:
390 descr
= edit_file(self
, descr
.rstrip(), \
391 'Please edit the description for patch "%s" ' \
392 'above.' % name
, show_patch
)
395 author_name
= patch
.get_authname()
397 author_email
= patch
.get_authemail()
399 author_date
= patch
.get_authdate()
400 if not committer_name
:
401 committer_name
= patch
.get_commname()
402 if not committer_email
:
403 committer_email
= patch
.get_commemail()
405 commit_id
= git
.commit(message
= descr
, parents
= [patch
.get_bottom()],
406 cache_update
= cache_update
,
408 author_name
= author_name
,
409 author_email
= author_email
,
410 author_date
= author_date
,
411 committer_name
= committer_name
,
412 committer_email
= committer_email
)
415 patch
.set_top(commit_id
)
416 patch
.set_description(descr
)
417 patch
.set_authname(author_name
)
418 patch
.set_authemail(author_email
)
419 patch
.set_authdate(author_date
)
420 patch
.set_commname(committer_name
)
421 patch
.set_commemail(committer_email
)
425 def new_patch(self
, name
, message
= None, can_edit
= True,
426 unapplied
= False, show_patch
= False,
427 top
= None, bottom
= None,
428 author_name
= None, author_email
= None, author_date
= None,
429 committer_name
= None, committer_email
= None):
430 """Creates a new patch
432 if self
.__patch_applied(name
) or self
.__patch_unapplied(name
):
433 raise StackException
, 'Patch "%s" already exists' % name
435 if not message
and can_edit
:
436 descr
= edit_file(self
, None, \
437 'Please enter the description for patch "%s" ' \
438 'above.' % name
, show_patch
)
442 head
= git
.get_head()
444 self
.__begin_stack_check()
446 patch
= Patch(name
, self
.__patch_dir
)
450 patch
.set_bottom(bottom
)
452 patch
.set_bottom(head
)
458 patch
.set_description(descr
)
459 patch
.set_authname(author_name
)
460 patch
.set_authemail(author_email
)
461 patch
.set_authdate(author_date
)
462 patch
.set_commname(committer_name
)
463 patch
.set_commemail(committer_email
)
466 patches
= [patch
.get_name()] + self
.get_unapplied()
468 f
= file(self
.__unapplied_file
, 'w+')
469 f
.writelines([line
+ '\n' for line
in patches
])
472 append_string(self
.__applied_file
, patch
.get_name())
473 self
.__set_current(name
)
475 def delete_patch(self
, name
):
478 patch
= Patch(name
, self
.__patch_dir
)
480 if self
.__patch_is_current(patch
):
482 elif self
.__patch_applied(name
):
483 raise StackException
, 'Cannot remove an applied patch, "%s", ' \
484 'which is not current' % name
485 elif not name
in self
.get_unapplied():
486 raise StackException
, 'Unknown patch "%s"' % name
490 unapplied
= self
.get_unapplied()
491 unapplied
.remove(name
)
492 f
= file(self
.__unapplied_file
, 'w+')
493 f
.writelines([line
+ '\n' for line
in unapplied
])
496 def forward_patches(self
, names
):
497 """Try to fast-forward an array of patches.
499 On return, patches in names[0:returned_value] have been pushed on the
500 stack. Apply the rest with push_patch
502 unapplied
= self
.get_unapplied()
503 self
.__begin_stack_check()
509 assert(name
in unapplied
)
511 patch
= Patch(name
, self
.__patch_dir
)
514 bottom
= patch
.get_bottom()
515 top
= patch
.get_top()
517 # top != bottom always since we have a commit for each patch
519 # reset the backup information
520 patch
.set_bottom(head
, backup
= True)
521 patch
.set_top(top
, backup
= True)
524 head_tree
= git
.get_commit(head
).get_tree()
525 bottom_tree
= git
.get_commit(bottom
).get_tree()
526 if head_tree
== bottom_tree
:
527 # We must just reparent this patch and create a new commit
529 descr
= patch
.get_description()
530 author_name
= patch
.get_authname()
531 author_email
= patch
.get_authemail()
532 author_date
= patch
.get_authdate()
533 committer_name
= patch
.get_commname()
534 committer_email
= patch
.get_commemail()
536 top_tree
= git
.get_commit(top
).get_tree()
538 top
= git
.commit(message
= descr
, parents
= [head
],
539 cache_update
= False,
542 author_name
= author_name
,
543 author_email
= author_email
,
544 author_date
= author_date
,
545 committer_name
= committer_name
,
546 committer_email
= committer_email
)
548 patch
.set_bottom(head
, backup
= True)
549 patch
.set_top(top
, backup
= True)
552 # stop the fast-forwarding, must do a real merge
556 unapplied
.remove(name
)
560 append_strings(self
.__applied_file
, names
[0:forwarded
])
562 f
= file(self
.__unapplied_file
, 'w+')
563 f
.writelines([line
+ '\n' for line
in unapplied
])
566 self
.__set_current(name
)
570 def push_patch(self
, name
):
571 """Pushes a patch on the stack
573 unapplied
= self
.get_unapplied()
574 assert(name
in unapplied
)
576 self
.__begin_stack_check()
578 patch
= Patch(name
, self
.__patch_dir
)
580 head
= git
.get_head()
581 bottom
= patch
.get_bottom()
582 top
= patch
.get_top()
586 # top != bottom always since we have a commit for each patch
588 # reset the backup information
589 patch
.set_bottom(bottom
, backup
= True)
590 patch
.set_top(top
, backup
= True)
594 # new patch needs to be refreshed.
595 # The current patch is empty after merge.
596 patch
.set_bottom(head
, backup
= True)
597 patch
.set_top(head
, backup
= True)
598 # merge/refresh can fail but the patch needs to be pushed
600 git
.merge(bottom
, head
, top
)
601 except git
.GitException
, ex
:
602 print >> sys
.stderr
, \
603 'The merge failed during "push". ' \
604 'Use "refresh" after fixing the conflicts'
607 append_string(self
.__applied_file
, name
)
609 unapplied
.remove(name
)
610 f
= file(self
.__unapplied_file
, 'w+')
611 f
.writelines([line
+ '\n' for line
in unapplied
])
614 self
.__set_current(name
)
616 # head == bottom case doesn't need to refresh the patch
619 # if the merge was OK and no conflicts, just refresh the patch
620 # The GIT cache was already updated by the merge operation
621 self
.refresh_patch(cache_update
= False)
623 raise StackException
, str(ex
)
626 name
= self
.get_current()
629 patch
= Patch(name
, self
.__patch_dir
)
632 return patch
.restore_old_boundaries()
634 def pop_patch(self
, name
):
635 """Pops the top patch from the stack
637 applied
= self
.get_applied()
639 assert(name
in applied
)
641 patch
= Patch(name
, self
.__patch_dir
)
643 git
.switch(patch
.get_bottom())
645 # save the new applied list
646 idx
= applied
.index(name
) + 1
648 popped
= applied
[:idx
]
650 unapplied
= popped
+ self
.get_unapplied()
652 f
= file(self
.__unapplied_file
, 'w+')
653 f
.writelines([line
+ '\n' for line
in unapplied
])
659 f
= file(self
.__applied_file
, 'w+')
660 f
.writelines([line
+ '\n' for line
in applied
])
664 self
.__set_current(None)
666 self
.__set_current(applied
[-1])
668 self
.__end_stack_check()
670 def empty_patch(self
, name
):
671 """Returns True if the patch is empty
673 patch
= Patch(name
, self
.__patch_dir
)
674 bottom
= patch
.get_bottom()
675 top
= patch
.get_top()
679 elif git
.get_commit(top
).get_tree() \
680 == git
.get_commit(bottom
).get_tree():
685 def rename_patch(self
, oldname
, newname
):
686 applied
= self
.get_applied()
687 unapplied
= self
.get_unapplied()
689 if newname
in applied
or newname
in unapplied
:
690 raise StackException
, 'Patch "%s" already exists' % newname
692 if oldname
in unapplied
:
693 Patch(oldname
, self
.__patch_dir
).rename(newname
)
694 unapplied
[unapplied
.index(oldname
)] = newname
696 f
= file(self
.__unapplied_file
, 'w+')
697 f
.writelines([line
+ '\n' for line
in unapplied
])
699 elif oldname
in applied
:
700 Patch(oldname
, self
.__patch_dir
).rename(newname
)
701 if oldname
== self
.get_current():
702 self
.__set_current(newname
)
704 applied
[applied
.index(oldname
)] = newname
706 f
= file(self
.__applied_file
, 'w+')
707 f
.writelines([line
+ '\n' for line
in applied
])
710 raise StackException
, 'Unknown patch "%s"' % oldname