| 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 series.get_base() |
| 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" or "status --reset"' |
| 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, \ |
| 124 | 'Unsolved conflicts. Please resolve them first or\n' \ |
| 125 | ' revert the changes with "status --reset"' |
| 126 | |
| 127 | def print_crt_patch(branch = None): |
| 128 | if not branch: |
| 129 | patch = crt_series.get_current() |
| 130 | else: |
| 131 | patch = stack.Series(branch).get_current() |
| 132 | |
| 133 | if patch: |
| 134 | out.info('Now at patch "%s"' % patch) |
| 135 | else: |
| 136 | out.info('No patches applied') |
| 137 | |
| 138 | def resolved(filename, reset = None): |
| 139 | if reset: |
| 140 | reset_file = filename + file_extensions()[reset] |
| 141 | if os.path.isfile(reset_file): |
| 142 | if os.path.isfile(filename): |
| 143 | os.remove(filename) |
| 144 | os.rename(reset_file, filename) |
| 145 | |
| 146 | git.update_cache([filename], force = True) |
| 147 | |
| 148 | for ext in file_extensions().values(): |
| 149 | fn = filename + ext |
| 150 | if os.path.isfile(fn): |
| 151 | os.remove(fn) |
| 152 | |
| 153 | def resolved_all(reset = None): |
| 154 | conflicts = git.get_conflicts() |
| 155 | if conflicts: |
| 156 | for filename in conflicts: |
| 157 | resolved(filename, reset) |
| 158 | os.remove(os.path.join(basedir.get(), 'conflicts')) |
| 159 | |
| 160 | def push_patches(patches, check_merged = False): |
| 161 | """Push multiple patches onto the stack. This function is shared |
| 162 | between the push and pull commands |
| 163 | """ |
| 164 | forwarded = crt_series.forward_patches(patches) |
| 165 | if forwarded > 1: |
| 166 | out.info('Fast-forwarded patches "%s" - "%s"' |
| 167 | % (patches[0], patches[forwarded - 1])) |
| 168 | elif forwarded == 1: |
| 169 | out.info('Fast-forwarded patch "%s"' % patches[0]) |
| 170 | |
| 171 | names = patches[forwarded:] |
| 172 | |
| 173 | # check for patches merged upstream |
| 174 | if names and check_merged: |
| 175 | out.start('Checking for patches merged upstream') |
| 176 | |
| 177 | merged = crt_series.merged_patches(names) |
| 178 | |
| 179 | out.done('%d found' % len(merged)) |
| 180 | else: |
| 181 | merged = [] |
| 182 | |
| 183 | for p in names: |
| 184 | out.start('Pushing patch "%s"' % p) |
| 185 | |
| 186 | if p in merged: |
| 187 | crt_series.push_patch(p, empty = True) |
| 188 | out.done('merged upstream') |
| 189 | else: |
| 190 | modified = crt_series.push_patch(p) |
| 191 | |
| 192 | if crt_series.empty_patch(p): |
| 193 | out.done('empty patch') |
| 194 | elif modified: |
| 195 | out.done('modified') |
| 196 | else: |
| 197 | out.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 | out.info('Nothing to push/pop') |
| 205 | else: |
| 206 | p = patches[-1] |
| 207 | if len(patches) == 1: |
| 208 | out.start('Popping patch "%s"' % p) |
| 209 | else: |
| 210 | out.start('Popping patches "%s" - "%s"' % (patches[0], p)) |
| 211 | crt_series.pop_patch(p, keep) |
| 212 | out.done() |
| 213 | |
| 214 | def parse_patches(patch_args, patch_list, boundary = 0, ordered = False): |
| 215 | """Parse patch_args list for patch names in patch_list and return |
| 216 | a list. The names can be individual patches and/or in the |
| 217 | patch1..patch2 format. |
| 218 | """ |
| 219 | patches = [] |
| 220 | |
| 221 | for name in patch_args: |
| 222 | pair = name.split('..') |
| 223 | for p in pair: |
| 224 | if p and not p in patch_list: |
| 225 | raise CmdException, 'Unknown patch name: %s' % p |
| 226 | |
| 227 | if len(pair) == 1: |
| 228 | # single patch name |
| 229 | pl = pair |
| 230 | elif len(pair) == 2: |
| 231 | # patch range [p1]..[p2] |
| 232 | # inclusive boundary |
| 233 | if pair[0]: |
| 234 | first = patch_list.index(pair[0]) |
| 235 | else: |
| 236 | first = -1 |
| 237 | # exclusive boundary |
| 238 | if pair[1]: |
| 239 | last = patch_list.index(pair[1]) + 1 |
| 240 | else: |
| 241 | last = -1 |
| 242 | |
| 243 | # only cross the boundary if explicitly asked |
| 244 | if not boundary: |
| 245 | boundary = len(patch_list) |
| 246 | if first < 0: |
| 247 | if last <= boundary: |
| 248 | first = 0 |
| 249 | else: |
| 250 | first = boundary |
| 251 | if last < 0: |
| 252 | if first < boundary: |
| 253 | last = boundary |
| 254 | else: |
| 255 | last = len(patch_list) |
| 256 | |
| 257 | if last > first: |
| 258 | pl = patch_list[first:last] |
| 259 | else: |
| 260 | pl = patch_list[(last - 1):(first + 1)] |
| 261 | pl.reverse() |
| 262 | else: |
| 263 | raise CmdException, 'Malformed patch name: %s' % name |
| 264 | |
| 265 | for p in pl: |
| 266 | if p in patches: |
| 267 | raise CmdException, 'Duplicate patch name: %s' % p |
| 268 | |
| 269 | patches += pl |
| 270 | |
| 271 | if ordered: |
| 272 | patches = [p for p in patch_list if p in patches] |
| 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 address_or_alias(addr_str): |
| 302 | """Return the address if it contains an e-mail address or look up |
| 303 | the aliases in the config files. |
| 304 | """ |
| 305 | def __address_or_alias(addr): |
| 306 | if not addr: |
| 307 | return None |
| 308 | if addr.find('@') >= 0: |
| 309 | # it's an e-mail address |
| 310 | return addr |
| 311 | alias = config.get('mail.alias.'+addr) |
| 312 | if alias: |
| 313 | # it's an alias |
| 314 | return alias |
| 315 | raise CmdException, 'unknown e-mail alias: %s' % addr |
| 316 | |
| 317 | addr_list = [__address_or_alias(addr.strip()) |
| 318 | for addr in addr_str.split(',')] |
| 319 | return ', '.join([addr for addr in addr_list if addr]) |
| 320 | |
| 321 | def prepare_rebase(force=None): |
| 322 | if not force: |
| 323 | # Be sure we won't loose results of stg-(un)commit by error. |
| 324 | # Do not require an existing orig-base for compatibility with 0.12 and earlier. |
| 325 | origbase = crt_series._get_field('orig-base') |
| 326 | if origbase and crt_series.get_base() != origbase: |
| 327 | raise CmdException, 'Rebasing would possibly lose data' |
| 328 | |
| 329 | # pop all patches |
| 330 | applied = crt_series.get_applied() |
| 331 | if len(applied) > 0: |
| 332 | out.start('Popping all applied patches') |
| 333 | crt_series.pop_patch(applied[0]) |
| 334 | out.done() |
| 335 | return applied |
| 336 | |
| 337 | def rebase(target): |
| 338 | if target == git.get_head(): |
| 339 | out.info('Already at "%s", no need for rebasing.' % target) |
| 340 | return |
| 341 | out.start('Rebasing to "%s"' % target) |
| 342 | git.reset(tree_id = git_id(target)) |
| 343 | out.done() |
| 344 | |
| 345 | def post_rebase(applied, nopush, merged): |
| 346 | # memorize that we rebased to here |
| 347 | crt_series._set_field('orig-base', git.get_head()) |
| 348 | # push the patches back |
| 349 | if not nopush: |
| 350 | push_patches(applied, merged) |