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 self
.__set_field('bottom.old', self
.__get_field('bottom'))
174 self
.__set_field('bottom', string
)
177 return self
.__get_field('top')
179 def set_top(self
, string
, backup
= False):
181 self
.__set_field('top.old', self
.__get_field('top'))
182 self
.__set_field('top', string
)
184 def restore_old_boundaries(self
):
185 bottom
= self
.__get_field('bottom.old')
186 top
= self
.__get_field('top.old')
189 self
.__set_field('bottom', bottom
)
190 self
.__set_field('top', top
)
192 raise StackException
, 'No patch undo information'
194 def get_description(self
):
195 return self
.__get_field('description', True)
197 def set_description(self
, string
):
198 self
.__set_field('description', string
, True)
200 def get_authname(self
):
201 return self
.__get_field('authname')
203 def set_authname(self
, string
):
204 if not string
and config
.has_option('stgit', 'authname'):
205 string
= config
.get('stgit', 'authname')
206 self
.__set_field('authname', string
)
208 def get_authemail(self
):
209 return self
.__get_field('authemail')
211 def set_authemail(self
, string
):
212 if not string
and config
.has_option('stgit', 'authemail'):
213 string
= config
.get('stgit', 'authemail')
214 self
.__set_field('authemail', string
)
216 def get_authdate(self
):
217 return self
.__get_field('authdate')
219 def set_authdate(self
, string
):
220 self
.__set_field('authdate', string
)
222 def get_commname(self
):
223 return self
.__get_field('commname')
225 def set_commname(self
, string
):
226 if not string
and config
.has_option('stgit', 'commname'):
227 string
= config
.get('stgit', 'commname')
228 self
.__set_field('commname', string
)
230 def get_commemail(self
):
231 return self
.__get_field('commemail')
233 def set_commemail(self
, string
):
234 if not string
and config
.has_option('stgit', 'commemail'):
235 string
= config
.get('stgit', 'commemail')
236 self
.__set_field('commemail', string
)
240 """Class including the operations on series
242 def __init__(self
, name
= None):
243 """Takes a series name as the parameter. A valid .git/patches/name
244 directory should exist
249 self
.__name
= git
.get_head_file()
252 self
.__patch_dir
= os
.path
.join(git
.base_dir
, 'patches',
254 self
.__base_file
= os
.path
.join(git
.base_dir
, 'refs', 'bases',
256 self
.__applied_file
= os
.path
.join(self
.__patch_dir
, 'applied')
257 self
.__unapplied_file
= os
.path
.join(self
.__patch_dir
, 'unapplied')
258 self
.__current_file
= os
.path
.join(self
.__patch_dir
, 'current')
260 def get_branch(self
):
261 """Return the branch name for the Series object
265 def __set_current(self
, name
):
266 """Sets the topmost patch
269 write_string(self
.__current_file
, name
)
271 create_empty_file(self
.__current_file
)
273 def get_patch(self
, name
):
274 """Return a Patch object for the given name
276 return Patch(name
, self
.__patch_dir
)
278 def get_current(self
):
279 """Return a Patch object representing the topmost patch
281 if os
.path
.isfile(self
.__current_file
):
282 name
= read_string(self
.__current_file
)
290 def get_applied(self
):
291 f
= file(self
.__applied_file
)
292 names
= [line
.strip() for line
in f
.readlines()]
296 def get_unapplied(self
):
297 f
= file(self
.__unapplied_file
)
298 names
= [line
.strip() for line
in f
.readlines()]
302 def get_base_file(self
):
303 return self
.__base_file
305 def __patch_is_current(self
, patch
):
306 return patch
.get_name() == read_string(self
.__current_file
)
308 def __patch_applied(self
, name
):
309 """Return true if the patch exists in the applied list
311 return name
in self
.get_applied()
313 def __patch_unapplied(self
, name
):
314 """Return true if the patch exists in the unapplied list
316 return name
in self
.get_unapplied()
318 def __begin_stack_check(self
):
319 """Save the current HEAD into .git/refs/heads/base if the stack
322 if len(self
.get_applied()) == 0:
323 head
= git
.get_head()
324 write_string(self
.__base_file
, head
)
326 def __end_stack_check(self
):
327 """Remove .git/refs/heads/base if the stack is empty.
328 This warning should never happen
330 if len(self
.get_applied()) == 0 \
331 and read_string(self
.__base_file
) != git
.get_head():
332 print 'Warning: stack empty but the HEAD and base are different'
334 def head_top_equal(self
):
335 """Return true if the head and the top are the same
337 crt
= self
.get_current()
339 # we don't care, no patches applied
341 return git
.get_head() == Patch(crt
, self
.__patch_dir
).get_top()
344 """Initialises the stgit series
346 bases_dir
= os
.path
.join(git
.base_dir
, 'refs', 'bases')
348 if os
.path
.isdir(self
.__patch_dir
):
349 raise StackException
, self
.__patch_dir
+ ' already exists'
350 os
.makedirs(self
.__patch_dir
)
352 if not os
.path
.isdir(bases_dir
):
353 os
.makedirs(bases_dir
)
355 create_empty_file(self
.__applied_file
)
356 create_empty_file(self
.__unapplied_file
)
357 self
.__begin_stack_check()
359 def refresh_patch(self
, message
= None, edit
= False, show_patch
= False,
361 author_name
= None, author_email
= None,
363 committer_name
= None, committer_email
= None,
364 commit_only
= False):
365 """Generates a new commit for the given patch
367 name
= self
.get_current()
369 raise StackException
, 'No patches applied'
371 patch
= Patch(name
, self
.__patch_dir
)
373 descr
= patch
.get_description()
374 if not (message
or descr
):
380 if not message
and edit
:
381 descr
= edit_file(self
, descr
.rstrip(), \
382 'Please edit the description for patch "%s" ' \
383 'above.' % name
, show_patch
)
386 author_name
= patch
.get_authname()
388 author_email
= patch
.get_authemail()
390 author_date
= patch
.get_authdate()
391 if not committer_name
:
392 committer_name
= patch
.get_commname()
393 if not committer_email
:
394 committer_email
= patch
.get_commemail()
396 commit_id
= git
.commit(message
= descr
, parents
= [patch
.get_bottom()],
397 cache_update
= cache_update
,
399 author_name
= author_name
,
400 author_email
= author_email
,
401 author_date
= author_date
,
402 committer_name
= committer_name
,
403 committer_email
= committer_email
)
406 patch
.set_top(commit_id
)
407 patch
.set_description(descr
)
408 patch
.set_authname(author_name
)
409 patch
.set_authemail(author_email
)
410 patch
.set_authdate(author_date
)
411 patch
.set_commname(committer_name
)
412 patch
.set_commemail(committer_email
)
416 def new_patch(self
, name
, message
= None, can_edit
= True,
417 unapplied
= False, show_patch
= False,
418 top
= None, bottom
= None,
419 author_name
= None, author_email
= None, author_date
= None,
420 committer_name
= None, committer_email
= None):
421 """Creates a new patch
423 if self
.__patch_applied(name
) or self
.__patch_unapplied(name
):
424 raise StackException
, 'Patch "%s" already exists' % name
426 if not message
and can_edit
:
427 descr
= edit_file(self
, None, \
428 'Please enter the description for patch "%s" ' \
429 'above.' % name
, show_patch
)
433 head
= git
.get_head()
435 self
.__begin_stack_check()
437 patch
= Patch(name
, self
.__patch_dir
)
441 patch
.set_bottom(bottom
)
443 patch
.set_bottom(head
)
449 patch
.set_description(descr
)
450 patch
.set_authname(author_name
)
451 patch
.set_authemail(author_email
)
452 patch
.set_authdate(author_date
)
453 patch
.set_commname(committer_name
)
454 patch
.set_commemail(committer_email
)
457 patches
= [patch
.get_name()] + self
.get_unapplied()
459 f
= file(self
.__unapplied_file
, 'w+')
460 f
.writelines([line
+ '\n' for line
in patches
])
463 append_string(self
.__applied_file
, patch
.get_name())
464 self
.__set_current(name
)
466 def delete_patch(self
, name
):
469 patch
= Patch(name
, self
.__patch_dir
)
471 if self
.__patch_is_current(patch
):
473 elif self
.__patch_applied(name
):
474 raise StackException
, 'Cannot remove an applied patch, "%s", ' \
475 'which is not current' % name
476 elif not name
in self
.get_unapplied():
477 raise StackException
, 'Unknown patch "%s"' % name
481 unapplied
= self
.get_unapplied()
482 unapplied
.remove(name
)
483 f
= file(self
.__unapplied_file
, 'w+')
484 f
.writelines([line
+ '\n' for line
in unapplied
])
487 def forward_patches(self
, names
):
488 """Try to fast-forward an array of patches.
490 On return, patches in names[0:returned_value] have been pushed on the
491 stack. Apply the rest with push_patch
493 unapplied
= self
.get_unapplied()
494 self
.__begin_stack_check()
500 assert(name
in unapplied
)
502 patch
= Patch(name
, self
.__patch_dir
)
505 bottom
= patch
.get_bottom()
506 top
= patch
.get_top()
508 # top != bottom always since we have a commit for each patch
510 # reset the backup information
511 patch
.set_bottom(bottom
, backup
= True)
512 patch
.set_top(top
, backup
= True)
516 # stop the fast-forwarding, must do a real merge
520 unapplied
.remove(name
)
524 append_strings(self
.__applied_file
, names
[0:forwarded
])
526 f
= file(self
.__unapplied_file
, 'w+')
527 f
.writelines([line
+ '\n' for line
in unapplied
])
530 self
.__set_current(name
)
534 def push_patch(self
, name
):
535 """Pushes a patch on the stack
537 unapplied
= self
.get_unapplied()
538 assert(name
in unapplied
)
540 self
.__begin_stack_check()
542 patch
= Patch(name
, self
.__patch_dir
)
544 head
= git
.get_head()
545 bottom
= patch
.get_bottom()
546 top
= patch
.get_top()
550 # top != bottom always since we have a commit for each patch
552 # reset the backup information
553 patch
.set_bottom(bottom
, backup
= True)
554 patch
.set_top(top
, backup
= True)
558 # new patch needs to be refreshed.
559 # The current patch is empty after merge.
560 patch
.set_bottom(head
, backup
= True)
561 patch
.set_top(head
, backup
= True)
562 # merge/refresh can fail but the patch needs to be pushed
564 git
.merge(bottom
, head
, top
)
565 except git
.GitException
, ex
:
566 print >> sys
.stderr
, \
567 'The merge failed during "push". ' \
568 'Use "refresh" after fixing the conflicts'
571 append_string(self
.__applied_file
, name
)
573 unapplied
.remove(name
)
574 f
= file(self
.__unapplied_file
, 'w+')
575 f
.writelines([line
+ '\n' for line
in unapplied
])
578 self
.__set_current(name
)
580 # head == bottom case doesn't need to refresh the patch
583 # if the merge was OK and no conflicts, just refresh the patch
584 # The GIT cache was already updated by the merge operation
585 self
.refresh_patch(cache_update
= False)
587 raise StackException
, str(ex
)
590 name
= self
.get_current()
593 patch
= Patch(name
, self
.__patch_dir
)
596 patch
.restore_old_boundaries()
598 def pop_patch(self
, name
):
599 """Pops the top patch from the stack
601 applied
= self
.get_applied()
603 assert(name
in applied
)
605 patch
= Patch(name
, self
.__patch_dir
)
607 git
.switch(patch
.get_bottom())
609 # save the new applied list
610 idx
= applied
.index(name
) + 1
612 popped
= applied
[:idx
]
614 unapplied
= popped
+ self
.get_unapplied()
616 f
= file(self
.__unapplied_file
, 'w+')
617 f
.writelines([line
+ '\n' for line
in unapplied
])
623 f
= file(self
.__applied_file
, 'w+')
624 f
.writelines([line
+ '\n' for line
in applied
])
628 self
.__set_current(None)
630 self
.__set_current(applied
[-1])
632 self
.__end_stack_check()
634 def empty_patch(self
, name
):
635 """Returns True if the patch is empty
637 patch
= Patch(name
, self
.__patch_dir
)
638 bottom
= patch
.get_bottom()
639 top
= patch
.get_top()
643 elif git
.get_commit(top
).get_tree() \
644 == git
.get_commit(bottom
).get_tree():
649 def rename_patch(self
, oldname
, newname
):
650 applied
= self
.get_applied()
651 unapplied
= self
.get_unapplied()
653 if newname
in applied
or newname
in unapplied
:
654 raise StackException
, 'Patch "%s" already exists' % newname
656 if oldname
in unapplied
:
657 Patch(oldname
, self
.__patch_dir
).rename(newname
)
658 unapplied
[unapplied
.index(oldname
)] = newname
660 f
= file(self
.__unapplied_file
, 'w+')
661 f
.writelines([line
+ '\n' for line
in unapplied
])
663 elif oldname
in applied
:
664 Patch(oldname
, self
.__patch_dir
).rename(newname
)
665 if oldname
== self
.get_current():
666 self
.__set_current(newname
)
668 applied
[applied
.index(oldname
)] = newname
670 f
= file(self
.__applied_file
, 'w+')
671 f
.writelines([line
+ '\n' for line
in applied
])
674 raise StackException
, 'Unknown patch "%s"' % oldname