mdw@git.distorted.org.uk Git - stgit/blob - stgit/commands/export.py

   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.out import *
  27 from stgit import stack, git, templates
  28
  29
  30 help = 'exports patches to a directory'
  31 usage = """%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
  32
  33 Export a range of applied patches to a given directory (defaults to
  34 'patches-<branch>') in a standard unified GNU diff format. A template
  35 file (defaulting to '.git/patchexport.tmpl' or
  36 '~/.stgit/templates/patchexport.tmpl' or
  37 '/usr/share/stgit/templates/patchexport.tmpl') can be used for the
  38 patch format. The following variables are supported in the template
  39 file:
  40
  41   %(description)s - patch description
  42   %(shortdescr)s  - the first line of the patch description
  43   %(longdescr)s   - the rest of the patch description, after the first line
  44   %(diffstat)s    - the diff statistics
  45   %(authname)s    - author's name
  46   %(authemail)s   - author's e-mail
  47   %(authdate)s    - patch creation date
  48   %(commname)s    - committer's name
  49   %(commemail)s   - committer's e-mail
  50 """
  51
  52 directory = DirectoryHasRepository()
  53 options = [make_option('-d', '--dir',
  54                        help = 'export patches to DIR instead of the default'),
  55            make_option('-p', '--patch',
  56                        help = 'append .patch to the patch names',
  57                        action = 'store_true'),
  58            make_option('-e', '--extension',
  59                        help = 'append .EXTENSION to the patch names'),
  60            make_option('-n', '--numbered',
  61                        help = 'prefix the patch names with order numbers',
  62                        action = 'store_true'),
  63            make_option('-t', '--template', metavar = 'FILE',
  64                        help = 'Use FILE as a template'),
  65            make_option('-b', '--branch',
  66                        help = 'use BRANCH instead of the default one'),
  67            make_option('-O', '--diff-opts',
  68                        help = 'options to pass to git-diff'),
  69            make_option('-s', '--stdout',
  70                        help = 'dump the patches to the standard output',
  71                        action = 'store_true')]
  72
  73
  74 def func(parser, options, args):
  75     """Export a range of patches.
  76     """
  77     if options.dir:
  78         dirname = options.dir
  79     else:
  80         dirname = 'patches-%s' % crt_series.get_name()
  81         directory.cd_to_topdir()
  82
  83     if not options.branch and git.local_changes():
  84         out.warn('Local changes in the tree;'
  85                  ' you might want to commit them first')
  86
  87     if not options.stdout:
  88         if not os.path.isdir(dirname):
  89             os.makedirs(dirname)
  90         series = file(os.path.join(dirname, 'series'), 'w+')
  91
  92     if options.diff_opts:
  93         diff_flags = options.diff_opts.split()
  94     else:
  95         diff_flags = []
  96
  97     applied = crt_series.get_applied()
  98     unapplied = crt_series.get_unapplied()
  99     if len(args) != 0:
 100         patches = parse_patches(args, applied + unapplied, len(applied))
 101     else:
 102         patches = applied
 103
 104     num = len(patches)
 105     if num == 0:
 106         raise CmdException, 'No patches applied'
 107
 108     zpadding = len(str(num))
 109     if zpadding < 2:
 110         zpadding = 2
 111
 112     # get the template
 113     if options.template:
 114         tmpl = file(options.template).read()
 115     else:
 116         tmpl = templates.get_template('patchexport.tmpl')
 117         if not tmpl:
 118             tmpl = ''
 119
 120     # note the base commit for this series
 121     if not options.stdout:
 122         base_commit = crt_series.get_patch(patches[0]).get_bottom()
 123         print >> series, '# This series applies on GIT commit %s' % base_commit
 124
 125     patch_no = 1;
 126     for p in patches:
 127         pname = p
 128         if options.patch:
 129             pname = '%s.patch' % pname
 130         elif options.extension:
 131             pname = '%s.%s' % (pname, options.extension)
 132         if options.numbered:
 133             pname = '%s-%s' % (str(patch_no).zfill(zpadding), pname)
 134         pfile = os.path.join(dirname, pname)
 135         if not options.stdout:
 136             print >> series, pname
 137
 138         # get the patch description
 139         patch = crt_series.get_patch(p)
 140
 141         descr = patch.get_description().strip()
 142         descr_lines = descr.split('\n')
 143
 144         short_descr = descr_lines[0].rstrip()
 145         long_descr = reduce(lambda x, y: x + '\n' + y,
 146                             descr_lines[1:], '').strip()
 147
 148         tmpl_dict = {'description': patch.get_description().rstrip(),
 149                      'shortdescr': short_descr,
 150                      'longdescr': long_descr,
 151                      'diffstat': git.diffstat(rev1 = patch.get_bottom(),
 152                                               rev2 = patch.get_top()),
 153                      'authname': patch.get_authname(),
 154                      'authemail': patch.get_authemail(),
 155                      'authdate': patch.get_authdate(),
 156                      'commname': patch.get_commname(),
 157                      'commemail': patch.get_commemail()}
 158         for key in tmpl_dict:
 159             if not tmpl_dict[key]:
 160                 tmpl_dict[key] = ''
 161
 162         try:
 163             descr = tmpl % tmpl_dict
 164         except KeyError, err:
 165             raise CmdException, 'Unknown patch template variable: %s' \
 166                   % err
 167         except TypeError:
 168             raise CmdException, 'Only "%(name)s" variables are ' \
 169                   'supported in the patch template'
 170
 171         if options.stdout:
 172             f = sys.stdout
 173         else:
 174             f = open(pfile, 'w+')
 175
 176         if options.stdout and num > 1:
 177             print '-'*79
 178             print patch.get_name()
 179             print '-'*79
 180
 181         f.write(descr)
 182         f.write(git.diff(rev1 = patch.get_bottom(),
 183                          rev2 = patch.get_top(),
 184                          diff_flags = diff_flags))
 185         if not options.stdout:
 186             f.close()
 187         patch_no += 1
 188
 189     if not options.stdout:
 190         series.close()