1 """Function/variables common to all the commands
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
21 import sys
, os
, os
.path
, re
22 from optparse
import OptionParser
, make_option
24 from stgit
.exception
import *
25 from stgit
.utils
import *
26 from stgit
.out
import *
27 from stgit
.run
import *
28 from stgit
import stack
, git
, basedir
29 from stgit
.config
import config
, file_extensions
32 # Command exception class
33 class CmdException(StgException
):
37 class RevParseException(StgException
):
38 """Revision spec parse error."""
42 """Parse a revision specification into its
43 patchname@branchname//patch_id parts. If no branch name has a slash
44 in it, also accept / instead of //."""
45 if '/' in ''.join(git
.get_heads()):
46 # We have branch names with / in them.
47 branch_chars
= r
'[^@]'
50 # No / in branch names.
51 branch_chars
= r
'[^@/]'
52 patch_id_mark
= r
'(/|//)'
53 patch_re
= r
'(?P<patch>[^@/]+)'
54 branch_re
= r
'@(?P<branch>%s+)' % branch_chars
55 patch_id_re
= r
'%s(?P<patch_id>[a-z.]*)' % patch_id_mark
58 m
= re
.match(r
'^%s$' % patch_id_re
, rev
)
60 return None, None, m
.group('patch_id')
62 # Try path[@branch]//patch_id.
63 m
= re
.match(r
'^%s(%s)?%s$' %
(patch_re
, branch_re
, patch_id_re
), rev
)
65 return m
.group('patch'), m
.group('branch'), m
.group('patch_id')
68 m
= re
.match(r
'^%s(%s)?$' %
(patch_re
, branch_re
), rev
)
70 return m
.group('patch'), m
.group('branch'), None
72 # No, we can't parse that.
73 raise RevParseException
75 def git_id(crt_series
, rev
):
81 patch
, branch
, patch_id
= parse_rev(rev
)
85 series
= stack
.Series(branch
)
87 patch
= series
.get_current()
89 raise CmdException
, 'No patches applied'
90 if patch
in series
.get_applied() or patch
in series
.get_unapplied() or \
91 patch
in series
.get_hidden():
92 if patch_id
in ['top', '', None]:
93 return series
.get_patch(patch
).get_top()
94 elif patch_id
== 'bottom':
95 return series
.get_patch(patch
).get_bottom()
96 elif patch_id
== 'top.old':
97 return series
.get_patch(patch
).get_old_top()
98 elif patch_id
== 'bottom.old':
99 return series
.get_patch(patch
).get_old_bottom()
100 elif patch_id
== 'log':
101 return series
.get_patch(patch
).get_log()
102 if patch
== 'base' and patch_id
== None:
103 return series
.get_base()
104 except RevParseException
:
106 return git
.rev_parse(rev
+ '^{commit}')
108 def check_local_changes():
109 if git
.local_changes():
110 raise CmdException
, \
111 'local changes in the tree. Use "refresh" or "status --reset"'
113 def check_head_top_equal(crt_series
):
114 if not crt_series
.head_top_equal():
116 """HEAD and top are not the same. This can happen if you
117 modify a branch with git. The "repair" command can
118 fix this situation.""")
120 def check_conflicts():
121 if os
.path
.exists(os
.path
.join(basedir
.get(), 'conflicts')):
122 raise CmdException
, \
123 'Unsolved conflicts. Please resolve them first or\n' \
124 ' revert the changes with "status --reset"'
126 def print_crt_patch(crt_series
, branch
= None):
128 patch
= crt_series
.get_current()
130 patch
= stack
.Series(branch
).get_current()
133 out
.info('Now at patch "%s"' % patch
)
135 out
.info('No patches applied')
137 def resolved(filename
, reset
= None):
139 reset_file
= filename
+ file_extensions()[reset
]
140 if os
.path
.isfile(reset_file
):
141 if os
.path
.isfile(filename
):
143 os
.rename(reset_file
, filename
)
145 git
.update_cache([filename
], force
= True)
147 for ext
in file_extensions().values():
149 if os
.path
.isfile(fn
):
152 def resolved_all(reset
= None):
153 conflicts
= git
.get_conflicts()
155 for filename
in conflicts
:
156 resolved(filename
, reset
)
157 os
.remove(os
.path
.join(basedir
.get(), 'conflicts'))
159 def push_patches(crt_series
, patches
, check_merged
= False):
160 """Push multiple patches onto the stack. This function is shared
161 between the push and pull commands
163 forwarded
= crt_series
.forward_patches(patches
)
165 out
.info('Fast-forwarded patches "%s" - "%s"'
166 %
(patches
[0], patches
[forwarded
- 1]))
168 out
.info('Fast-forwarded patch "%s"' % patches
[0])
170 names
= patches
[forwarded
:]
172 # check for patches merged upstream
173 if names
and check_merged
:
174 out
.start('Checking for patches merged upstream')
176 merged
= crt_series
.merged_patches(names
)
178 out
.done('%d found' %
len(merged
))
183 out
.start('Pushing patch "%s"' % p
)
186 crt_series
.push_empty_patch(p
)
187 out
.done('merged upstream')
189 modified
= crt_series
.push_patch(p
)
191 if crt_series
.empty_patch(p
):
192 out
.done('empty patch')
198 def pop_patches(crt_series
, patches
, keep
= False):
199 """Pop the patches in the list from the stack. It is assumed that
200 the patches are listed in the stack reverse order.
202 if len(patches
) == 0:
203 out
.info('Nothing to push/pop')
206 if len(patches
) == 1:
207 out
.start('Popping patch "%s"' % p
)
209 out
.start('Popping patches "%s" - "%s"' %
(patches
[0], p
))
210 crt_series
.pop_patch(p
, keep
)
213 def parse_patches(patch_args
, patch_list
, boundary
= 0, ordered
= False):
214 """Parse patch_args list for patch names in patch_list and return
215 a list. The names can be individual patches and/or in the
216 patch1..patch2 format.
220 for name
in patch_args
:
221 pair
= name
.split('..')
223 if p
and not p
in patch_list
:
224 raise CmdException
, 'Unknown patch name: %s' % p
230 # patch range [p1]..[p2]
233 first
= patch_list
.index(pair
[0])
238 last
= patch_list
.index(pair
[1]) + 1
242 # only cross the boundary if explicitly asked
244 boundary
= len(patch_list
)
254 last
= len(patch_list
)
257 pl
= patch_list
[first
:last
]
259 pl
= patch_list
[(last
- 1):(first
+ 1)]
262 raise CmdException
, 'Malformed patch name: %s' % name
266 raise CmdException
, 'Duplicate patch name: %s' % p
271 patches
= [p
for p
in patch_list
if p
in patches
]
275 def name_email(address
):
276 """Return a tuple consisting of the name and email parsed from a
277 standard 'name <email>' or 'email (name)' string
279 address
= re
.sub('[\\\\"]', '\\\\\g<0>', address
)
280 str_list
= re
.findall('^(.*)\s*<(.*)>\s*$', address
)
282 str_list
= re
.findall('^(.*)\s*\((.*)\)\s*$', address
)
284 raise CmdException
, 'Incorrect "name <email>"/"email (name)" string: %s' % address
285 return ( str_list
[0][1], str_list
[0][0] )
289 def name_email_date(address
):
290 """Return a tuple consisting of the name, email and date parsed
291 from a 'name <email> date' string
293 address
= re
.sub('[\\\\"]', '\\\\\g<0>', address
)
294 str_list
= re
.findall('^(.*)\s*<(.*)>\s*(.*)\s*$', address
)
296 raise CmdException
, 'Incorrect "name <email> date" string: %s' % address
300 def address_or_alias(addr_str
):
301 """Return the address if it contains an e-mail address or look up
302 the aliases in the config files.
304 def __address_or_alias(addr
):
307 if addr
.find('@') >= 0:
308 # it's an e-mail address
310 alias
= config
.get('mail.alias.'+addr
)
314 raise CmdException
, 'unknown e-mail alias: %s' % addr
316 addr_list
= [__address_or_alias(addr
.strip())
317 for addr
in addr_str
.split(',')]
318 return ', '.join([addr
for addr
in addr_list
if addr
])
320 def prepare_rebase(crt_series
):
322 applied
= crt_series
.get_applied()
324 out
.start('Popping all applied patches')
325 crt_series
.pop_patch(applied
[0])
329 def rebase(crt_series
, target
):
331 tree_id
= git_id(crt_series
, target
)
333 # it might be that we use a custom rebase command with its own
336 if tree_id
== git
.get_head():
337 out
.info('Already at "%s", no need for rebasing.' % target
)
340 out
.start('Rebasing to "%s"' % target
)
342 out
.start('Rebasing to the default target')
343 git
.rebase(tree_id
= tree_id
)
346 def post_rebase(crt_series
, applied
, nopush
, merged
):
347 # memorize that we rebased to here
348 crt_series
._set_field('orig-base', git
.get_head())
349 # push the patches back
351 push_patches(crt_series
, applied
, merged
)
354 # Patch description/e-mail/diff parsing
356 def __end_descr(line
):
357 return re
.match('---\s*$', line
) or re
.match('diff -', line
) or \
358 re
.match('Index: ', line
)
360 def __split_descr_diff(string
):
361 """Return the description and the diff from the given string
366 for line
in string
.split('\n'):
368 if not __end_descr(line
):
375 return (descr
.rstrip(), diff
)
377 def __parse_description(descr
):
378 """Parse the patch description and return the new description and
379 author information (if any).
382 authname
= authemail
= authdate
= None
384 descr_lines
= [line
.rstrip() for line
in descr
.split('\n')]
386 raise CmdException
, "Empty patch description"
389 end
= len(descr_lines
)
391 # Parse the patch header
392 for pos
in range(0, end
):
393 if not descr_lines
[pos
]:
395 # check for a "From|Author:" line
396 if re
.match('\s*(?:from|author):\s+', descr_lines
[pos
], re
.I
):
397 auth
= re
.findall('^.*?:\s+(.*)$', descr_lines
[pos
])[0]
398 authname
, authemail
= name_email(auth
)
401 # check for a "Date:" line
402 if re
.match('\s*date:\s+', descr_lines
[pos
], re
.I
):
403 authdate
= re
.findall('^.*?:\s+(.*)$', descr_lines
[pos
])[0]
409 subject
= descr_lines
[pos
]
414 body
= reduce(lambda x
, y
: x
+ '\n' + y
, descr_lines
[lasthdr
:], '')
416 return (subject
+ body
, authname
, authemail
, authdate
)
419 """Parse the message object and return (description, authname,
420 authemail, authdate, diff)
422 from email
.Header
import decode_header
, make_header
424 def __decode_header(header
):
425 """Decode a qp-encoded e-mail header as per rfc2047"""
427 words_enc
= decode_header(header
)
428 hobj
= make_header(words_enc
)
429 except Exception, ex
:
430 raise CmdException
, 'header decoding error: %s' % str
(ex
)
431 return unicode(hobj
).encode('utf-8')
434 if msg
.has_key('from'):
435 authname
, authemail
= name_email(__decode_header(msg
['from']))
437 authname
= authemail
= None
439 # '\n\t' can be found on multi-line headers
440 descr
= __decode_header(msg
['subject']).replace('\n\t', ' ')
441 authdate
= msg
['date']
443 # remove the '[*PATCH*]' expression in the subject
445 descr
= re
.findall('^(\[.*?[Pp][Aa][Tt][Cc][Hh].*?\])?\s*(.*)$',
448 raise CmdException
, 'Subject: line not found'
450 # the rest of the message
452 for part
in msg
.walk():
453 if part
.get_content_type() == 'text/plain':
454 msg_text
+= part
.get_payload(decode
= True)
456 rem_descr
, diff
= __split_descr_diff(msg_text
)
458 descr
+= '\n\n' + rem_descr
460 # parse the description for author information
461 descr
, descr_authname
, descr_authemail
, descr_authdate
= \
462 __parse_description(descr
)
464 authname
= descr_authname
466 authemail
= descr_authemail
468 authdate
= descr_authdate
470 return (descr
, authname
, authemail
, authdate
, diff
)
472 def parse_patch(fobj
):
473 """Parse the input file and return (description, authname,
474 authemail, authdate, diff)
476 descr
, diff
= __split_descr_diff(fobj
.read())
477 descr
, authname
, authemail
, authdate
= __parse_description(descr
)
479 # we don't yet have an agreed place for the creation date.
481 return (descr
, authname
, authemail
, authdate
, diff
)
483 def readonly_constant_property(f
):
484 """Decorator that converts a function that computes a value to an
485 attribute that returns the value. The value is computed only once,
486 the first time it is accessed."""
488 n
= '__' + f
.__name__
489 if not hasattr(self
, n
):
490 setattr(self
, n
, f(self
))
491 return getattr(self
, n
)
492 return property(new_f
)
494 class DirectoryException(StgException
):
497 class _Directory(object):
498 def __init__(self
, needs_current_series
= True):
499 self
.needs_current_series
= needs_current_series
500 @readonly_constant_property
503 return Run('git', 'rev-parse', '--git-dir'
504 ).discard_stderr().output_one_line()
506 raise DirectoryException('No git repository found')
507 @readonly_constant_property
508 def __topdir_path(self
):
510 lines
= Run('git', 'rev-parse', '--show-cdup'
511 ).discard_stderr().output_lines()
514 elif len(lines
) == 1:
517 raise RunException('Too much output')
519 raise DirectoryException('No git repository found')
520 @readonly_constant_property
521 def is_inside_git_dir(self
):
522 return { 'true': True, 'false': False
523 }[Run('git', 'rev-parse', '--is-inside-git-dir'
525 @readonly_constant_property
526 def is_inside_worktree(self
):
527 return { 'true': True, 'false': False
528 }[Run('git', 'rev-parse', '--is-inside-work-tree'
530 def cd_to_topdir(self
):
531 os
.chdir(self
.__topdir_path
)
533 class DirectoryAnywhere(_Directory
):
537 class DirectoryHasRepository(_Directory
):
539 self
.git_dir
# might throw an exception
541 class DirectoryInWorktree(DirectoryHasRepository
):
543 DirectoryHasRepository
.setup(self
)
544 if not self
.is_inside_worktree
:
545 raise DirectoryException('Not inside a git worktree')
547 class DirectoryGotoToplevel(DirectoryInWorktree
):
549 DirectoryInWorktree
.setup(self
)