| 1 | """Export command |
| 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 |
| 22 | from optparse import OptionParser, make_option |
| 23 | |
| 24 | from stgit.commands.common import * |
| 25 | from stgit.utils import * |
| 26 | from stgit import stack, git |
| 27 | |
| 28 | |
| 29 | help = 'exports a series of patches to <dir> (or patches)' |
| 30 | usage = """%prog [options] [<dir>] |
| 31 | |
| 32 | Export the applied patches into a given directory (defaults to |
| 33 | 'patches') in a standard unified GNU diff format. A template file |
| 34 | (defaulting to '.git/patchexport.tmpl or |
| 35 | /usr/share/stgit/templates/patchexport.tmpl') can be used for the |
| 36 | patch format. The following variables are supported in the template |
| 37 | file: |
| 38 | |
| 39 | %(description)s - patch description |
| 40 | %(diffstat)s - the diff statistics |
| 41 | %(authname)s - author's name |
| 42 | %(authemail)s - author's e-mail |
| 43 | %(authdate)s - patch creation date |
| 44 | %(commname)s - committer's name |
| 45 | %(commemail)s - committer's e-mail |
| 46 | |
| 47 | 'export' can also generate a diff for a range of patches.""" |
| 48 | |
| 49 | options = [make_option('-n', '--numbered', |
| 50 | help = 'prefix the patch names with order numbers', |
| 51 | action = 'store_true'), |
| 52 | make_option('-d', '--diff', |
| 53 | help = 'append .diff to the patch names', |
| 54 | action = 'store_true'), |
| 55 | make_option('-t', '--template', metavar = 'FILE', |
| 56 | help = 'Use FILE as a template'), |
| 57 | make_option('-r', '--range', |
| 58 | metavar = '[PATCH1][:[PATCH2]]', |
| 59 | help = 'export patches between PATCH1 and PATCH2'), |
| 60 | make_option('-b', '--branch', |
| 61 | help = 'use BRANCH instead of the default one')] |
| 62 | |
| 63 | |
| 64 | def func(parser, options, args): |
| 65 | if len(args) == 0: |
| 66 | dirname = 'patches-%s' % crt_series.get_branch() |
| 67 | elif len(args) == 1: |
| 68 | dirname = args[0] |
| 69 | else: |
| 70 | parser.error('incorrect number of arguments') |
| 71 | |
| 72 | if not options.branch and git.local_changes(): |
| 73 | print 'Warning: local changes in the tree. ' \ |
| 74 | 'You might want to commit them first' |
| 75 | |
| 76 | if not os.path.isdir(dirname): |
| 77 | os.makedirs(dirname) |
| 78 | series = file(os.path.join(dirname, 'series'), 'w+') |
| 79 | |
| 80 | applied = crt_series.get_applied() |
| 81 | unapplied = crt_series.get_unapplied() |
| 82 | |
| 83 | if options.range: |
| 84 | boundaries = options.range.split(':') |
| 85 | if len(boundaries) == 1: |
| 86 | start = boundaries[0] |
| 87 | stop = boundaries[0] |
| 88 | elif len(boundaries) == 2: |
| 89 | if boundaries[0] == '': |
| 90 | start = applied[0] |
| 91 | else: |
| 92 | start = boundaries[0] |
| 93 | if boundaries[1] == '': |
| 94 | stop = applied[-1] |
| 95 | else: |
| 96 | stop = boundaries[1] |
| 97 | else: |
| 98 | raise CmdException, 'incorrect parameters to "--range"' |
| 99 | |
| 100 | if start in applied: |
| 101 | start_idx = applied.index(start) |
| 102 | else: |
| 103 | if start in unapplied: |
| 104 | raise CmdException, 'Patch "%s" not applied' % start |
| 105 | else: |
| 106 | raise CmdException, 'Patch "%s" does not exist' % start |
| 107 | |
| 108 | if stop in applied: |
| 109 | stop_idx = applied.index(stop) + 1 |
| 110 | else: |
| 111 | if stop in unapplied: |
| 112 | raise CmdException, 'Patch "%s" not applied' % stop |
| 113 | else: |
| 114 | raise CmdException, 'Patch "%s" does not exist' % stop |
| 115 | |
| 116 | if start_idx >= stop_idx: |
| 117 | raise CmdException, 'Incorrect patch range order' |
| 118 | else: |
| 119 | start_idx = 0 |
| 120 | stop_idx = len(applied) |
| 121 | |
| 122 | patches = applied[start_idx:stop_idx] |
| 123 | |
| 124 | num = len(patches) |
| 125 | zpadding = len(str(num)) |
| 126 | if zpadding < 2: |
| 127 | zpadding = 2 |
| 128 | |
| 129 | # get the template |
| 130 | if options.template: |
| 131 | patch_tmpl_list = [options.template] |
| 132 | else: |
| 133 | patch_tmpl_list = [] |
| 134 | |
| 135 | patch_tmpl_list += [os.path.join(git.get_base_dir(), 'patchexport.tmpl'), |
| 136 | os.path.join(sys.prefix, |
| 137 | 'share/stgit/templates/patchexport.tmpl')] |
| 138 | tmpl = '' |
| 139 | for patch_tmpl in patch_tmpl_list: |
| 140 | if os.path.isfile(patch_tmpl): |
| 141 | tmpl = file(patch_tmpl).read() |
| 142 | break |
| 143 | |
| 144 | patch_no = 1; |
| 145 | for p in patches: |
| 146 | pname = p |
| 147 | if options.diff: |
| 148 | pname = '%s.diff' % pname |
| 149 | if options.numbered: |
| 150 | pname = '%s-%s' % (str(patch_no).zfill(zpadding), pname) |
| 151 | pfile = os.path.join(dirname, pname) |
| 152 | print >> series, pname |
| 153 | |
| 154 | # get the patch description |
| 155 | patch = crt_series.get_patch(p) |
| 156 | |
| 157 | tmpl_dict = {'description': patch.get_description().rstrip(), |
| 158 | 'diffstat': git.diffstat(rev1 = patch.get_bottom(), |
| 159 | rev2 = patch.get_top()), |
| 160 | 'authname': patch.get_authname(), |
| 161 | 'authemail': patch.get_authemail(), |
| 162 | 'authdate': patch.get_authdate(), |
| 163 | 'commname': patch.get_commname(), |
| 164 | 'commemail': patch.get_commemail()} |
| 165 | for key in tmpl_dict: |
| 166 | if not tmpl_dict[key]: |
| 167 | tmpl_dict[key] = '' |
| 168 | |
| 169 | try: |
| 170 | descr = tmpl % tmpl_dict |
| 171 | except KeyError, err: |
| 172 | raise CmdException, 'Unknown patch template variable: %s' \ |
| 173 | % err |
| 174 | except TypeError: |
| 175 | raise CmdException, 'Only "%(name)s" variables are ' \ |
| 176 | 'supported in the patch template' |
| 177 | f = open(pfile, 'w+') |
| 178 | f.write(descr) |
| 179 | |
| 180 | # write the diff |
| 181 | git.diff(rev1 = patch.get_bottom(), |
| 182 | rev2 = patch.get_top(), |
| 183 | out_fd = f) |
| 184 | f.close() |
| 185 | patch_no += 1 |
| 186 | |
| 187 | series.close() |