chiark - git - mdw - stgit/blob - stgit/commands/common.py

   1 """Function/variables common to all the commands
   2 """
   3
   4 __copyright__ = """
   5 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
   6
   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.
  10
  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.
  15
  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
  19 """
  20
  21 import sys, os, os.path, re
  22 from optparse import OptionParser, make_option
  23
  24 from stgit.utils import *
  25 from stgit import stack, git, basedir
  26 from stgit.config import config, file_extensions
  27
  28 crt_series = None
  29
  30
  31 # Command exception class
  32 class CmdException(Exception):
  33     pass
  34
  35
  36 # Utility functions
  37 class RevParseException(Exception):
  38     """Revision spec parse error."""
  39     pass
  40
  41 def parse_rev(rev):
  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     files, dirs = list_files_and_dirs(os.path.join(basedir.get(),
  46                                                    'refs', 'heads'))
  47     if len(dirs) != 0:
  48         # We have branch names with / in them.
  49         branch_chars = r'[^@]'
  50         patch_id_mark = r'//'
  51     else:
  52         # No / in branch names.
  53         branch_chars = r'[^@/]'
  54         patch_id_mark = r'(/|//)'
  55     patch_re = r'(?P<patch>[^@/]+)'
  56     branch_re = r'@(?P<branch>%s+)' % branch_chars
  57     patch_id_re = r'%s(?P<patch_id>[a-z.]*)' % patch_id_mark
  58
  59     # Try //patch_id.
  60     m = re.match(r'^%s$' % patch_id_re, rev)
  61     if m:
  62         return None, None, m.group('patch_id')
  63
  64     # Try path[@branch]//patch_id.
  65     m = re.match(r'^%s(%s)?%s$' % (patch_re, branch_re, patch_id_re), rev)
  66     if m:
  67         return m.group('patch'), m.group('branch'), m.group('patch_id')
  68
  69     # Try patch[@branch].
  70     m = re.match(r'^%s(%s)?$' % (patch_re, branch_re), rev)
  71     if m:
  72         return m.group('patch'), m.group('branch'), None
  73
  74     # No, we can't parse that.
  75     raise RevParseException
  76
  77 def git_id(rev):
  78     """Return the GIT id
  79     """
  80     if not rev:
  81         return None
  82     try:
  83         patch, branch, patch_id = parse_rev(rev)
  84         if branch == None:
  85             series = crt_series
  86         else:
  87             series = stack.Series(branch)
  88         if patch == None:
  89             patch = series.get_current()
  90             if not patch:
  91                 raise CmdException, 'No patches applied'
  92         if patch in series.get_applied() or patch in series.get_unapplied():
  93             if patch_id in ['top', '', None]:
  94                 return series.get_patch(patch).get_top()
  95             elif patch_id == 'bottom':
  96                 return series.get_patch(patch).get_bottom()
  97             elif patch_id == 'top.old':
  98                 return series.get_patch(patch).get_old_top()
  99             elif patch_id == 'bottom.old':
 100                 return series.get_patch(patch).get_old_bottom()
 101             elif patch_id == 'log':
 102                 return series.get_patch(patch).get_log()
 103         if patch == 'base' and patch_id == None:
 104             return read_string(series.get_base_file())
 105     except RevParseException:
 106         pass
 107     return git.rev_parse(rev + '^{commit}')
 108
 109 def check_local_changes():
 110     if git.local_changes():
 111         raise CmdException, \
 112               'local changes in the tree. Use "refresh" to commit them'
 113
 114 def check_head_top_equal():
 115     if not crt_series.head_top_equal():
 116         raise CmdException(
 117             'HEAD and top are not the same. You probably committed\n'
 118             '  changes to the tree outside of StGIT. To bring them\n'
 119             '  into StGIT, use the "assimilate" command')
 120
 121 def check_conflicts():
 122     if os.path.exists(os.path.join(basedir.get(), 'conflicts')):
 123         raise CmdException, 'Unsolved conflicts. Please resolve them first'
 124
 125 def print_crt_patch(branch = None):
 126     if not branch:
 127         patch = crt_series.get_current()
 128     else:
 129         patch = stack.Series(branch).get_current()
 130
 131     if patch:
 132         print 'Now at patch "%s"' % patch
 133     else:
 134         print 'No patches applied'
 135
 136 def resolved(filename, reset = None):
 137     if reset:
 138         reset_file = filename + file_extensions()[reset]
 139         if os.path.isfile(reset_file):
 140             if os.path.isfile(filename):
 141                 os.remove(filename)
 142             os.rename(reset_file, filename)
 143
 144     git.update_cache([filename], force = True)
 145
 146     for ext in file_extensions().values():
 147         fn = filename + ext
 148         if os.path.isfile(fn):
 149             os.remove(fn)
 150
 151 def resolved_all(reset = None):
 152     conflicts = git.get_conflicts()
 153     if conflicts:
 154         for filename in conflicts:
 155             resolved(filename, reset)
 156         os.remove(os.path.join(basedir.get(), 'conflicts'))
 157
 158 def push_patches(patches, check_merged = False):
 159     """Push multiple patches onto the stack. This function is shared
 160     between the push and pull commands
 161     """
 162     forwarded = crt_series.forward_patches(patches)
 163     if forwarded > 1:
 164         print 'Fast-forwarded patches "%s" - "%s"' % (patches[0],
 165                                                       patches[forwarded - 1])
 166     elif forwarded == 1:
 167         print 'Fast-forwarded patch "%s"' % patches[0]
 168
 169     names = patches[forwarded:]
 170
 171     # check for patches merged upstream
 172     if check_merged:
 173         print 'Checking for patches merged upstream...',
 174         sys.stdout.flush()
 175
 176         merged = crt_series.merged_patches(names)
 177
 178         print 'done (%d found)' % len(merged)
 179     else:
 180         merged = []
 181
 182     for p in names:
 183         print 'Pushing patch "%s"...' % p,
 184         sys.stdout.flush()
 185
 186         if p in merged:
 187             crt_series.push_patch(p, empty = True)
 188             print 'done (merged upstream)'
 189         else:
 190             modified = crt_series.push_patch(p)
 191
 192             if crt_series.empty_patch(p):
 193                 print 'done (empty patch)'
 194             elif modified:
 195                 print 'done (modified)'
 196             else:
 197                 print 'done'
 198
 199 def pop_patches(patches, keep = False):
 200     """Pop the patches in the list from the stack. It is assumed that
 201     the patches are listed in the stack reverse order.
 202     """
 203     if len(patches) == 0:
 204         print 'nothing to push/pop'
 205     else:
 206         p = patches[-1]
 207         if len(patches) == 1:
 208             print 'Popping patch "%s"...' % p,
 209         else:
 210             print 'Popping "%s" - "%s" patches...' % (patches[0], p),
 211         sys.stdout.flush()
 212
 213         crt_series.pop_patch(p, keep)
 214
 215         print 'done'
 216
 217 def parse_patches(patch_args, patch_list, boundary = 0):
 218     """Parse patch_args list for patch names in patch_list and return
 219     a list. The names can be individual patches and/or in the
 220     patch1..patch2 format.
 221     """
 222     patches = []
 223
 224     for name in patch_args:
 225         pair = name.split('..')
 226         for p in pair:
 227             if p and not p in patch_list:
 228                 raise CmdException, 'Unknown patch name: %s' % p
 229
 230         if len(pair) == 1:
 231             # single patch name
 232             pl = pair
 233         elif len(pair) == 2:
 234             # patch range [p1]..[p2]
 235             # inclusive boundary
 236             if pair[0]:
 237                 first = patch_list.index(pair[0])
 238             else:
 239                 first = -1
 240             # exclusive boundary
 241             if pair[1]:
 242                 last = patch_list.index(pair[1]) + 1
 243             else:
 244                 last = -1
 245
 246             # only cross the boundary if explicitly asked
 247             if not boundary:
 248                 boundary = len(patch_list)
 249             if first < 0:
 250                 if last <= boundary:
 251                     first = 0
 252                 else:
 253                     first = boundary
 254             if last < 0:
 255                 if first < boundary:
 256                     last = boundary
 257                 else:
 258                     last = len(patch_list)
 259
 260             if last > first:
 261                 pl = patch_list[first:last]
 262             else:
 263                 pl = patch_list[(last - 1):(first + 1)]
 264                 pl.reverse()
 265         else:
 266             raise CmdException, 'Malformed patch name: %s' % name
 267
 268         for p in pl:
 269             if p in patches:
 270                 raise CmdException, 'Duplicate patch name: %s' % p
 271
 272         patches += pl
 273
 274     return patches
 275
 276 def name_email(address):
 277     """Return a tuple consisting of the name and email parsed from a
 278     standard 'name <email>' or 'email (name)' string
 279     """
 280     address = re.sub('[\\\\"]', '\\\\\g<0>', address)
 281     str_list = re.findall('^(.*)\s*<(.*)>\s*$', address)
 282     if not str_list:
 283         str_list = re.findall('^(.*)\s*\((.*)\)\s*$', address)
 284         if not str_list:
 285             raise CmdException, 'Incorrect "name <email>"/"email (name)" string: %s' % address
 286         return ( str_list[0][1], str_list[0][0] )
 287
 288     return str_list[0]
 289
 290 def name_email_date(address):
 291     """Return a tuple consisting of the name, email and date parsed
 292     from a 'name <email> date' string
 293     """
 294     address = re.sub('[\\\\"]', '\\\\\g<0>', address)
 295     str_list = re.findall('^(.*)\s*<(.*)>\s*(.*)\s*$', address)
 296     if not str_list:
 297         raise CmdException, 'Incorrect "name <email> date" string: %s' % address
 298
 299     return str_list[0]
 300
 301 def patch_name_from_msg(msg):
 302     """Return a string to be used as a patch name. This is generated
 303     from the first 30 characters of the top line of the string passed
 304     as argument."""
 305     if not msg:
 306         return None
 307
 308     subject_line = msg[:30].lstrip().split('\n', 1)[0].lower()
 309     return re.sub('[\W]+', '-', subject_line).strip('-')
 310
 311 def make_patch_name(msg, unacceptable, default_name = 'patch',
 312                     alternative = True):
 313     """Return a patch name generated from the given commit message,
 314     guaranteed to make unacceptable(name) be false. If the commit
 315     message is empty, base the name on default_name instead."""
 316     patchname = patch_name_from_msg(msg)
 317     if not patchname:
 318         patchname = default_name
 319     if alternative and unacceptable(patchname):
 320         suffix = 0
 321         while unacceptable('%s-%d' % (patchname, suffix)):
 322             suffix += 1
 323         patchname = '%s-%d' % (patchname, suffix)
 324     return patchname