Look for templates in ~/.stgit/templates as well

[stgit] / stgit / commands / export.py

"""Export command
"""

__copyright__ = """
Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""

import sys, os
from optparse import OptionParser, make_option

from stgit.commands.common import *
from stgit.utils import *
from stgit import stack, git, basedir


help = 'exports a series of patches to <dir> (or patches)'
usage = """%prog [options] [<dir>]

Export the applied patches into a given directory (defaults to
'patches') in a standard unified GNU diff format. A template file
(defaulting to '.git/patchexport.tmpl' or
'~/.stgit/templates/patchexport.tmpl' or
'/usr/share/stgit/templates/patchexport.tmpl') can be used for the
patch format. The following variables are supported in the template
file:

  %(description)s - patch description
  %(shortdescr)s  - the first line of the patch description
  %(longdescr)s   - the rest of the patch description, after the first line
  %(diffstat)s    - the diff statistics
  %(authname)s    - author's name
  %(authemail)s   - author's e-mail
  %(authdate)s    - patch creation date
  %(commname)s    - committer's name
  %(commemail)s   - committer's e-mail

'export' can also generate a diff for a range of patches."""

options = [make_option('-n', '--numbered',
                       help = 'prefix the patch names with order numbers',
                       action = 'store_true'),
           make_option('-d', '--diff',
                       help = 'append .diff to the patch names',
                       action = 'store_true'),
           make_option('-p', '--patch',
                       help = 'append .patch to the patch names',
                       action = 'store_true'),
           make_option('-t', '--template', metavar = 'FILE',
                       help = 'Use FILE as a template'),
           make_option('-r', '--range',
                       metavar = '[PATCH1][:[PATCH2]]',
                       help = 'export patches between PATCH1 and PATCH2'),
           make_option('-b', '--branch',
                       help = 'use BRANCH instead of the default one'),
           make_option('-s', '--stdout',
                       help = 'dump the patches to the standard output',
                       action = 'store_true')]


def func(parser, options, args):
    if len(args) == 0:
        dirname = 'patches-%s' % crt_series.get_branch()
    elif len(args) == 1:
        dirname = args[0]
    else:
        parser.error('incorrect number of arguments')

    if not options.branch and git.local_changes():
        print 'Warning: local changes in the tree. ' \
              'You might want to commit them first'

    if not options.stdout:
        if not os.path.isdir(dirname):
            os.makedirs(dirname)
        series = file(os.path.join(dirname, 'series'), 'w+')

    applied = crt_series.get_applied()
    unapplied = crt_series.get_unapplied()

    if options.range:
        boundaries = options.range.split(':')
        if len(boundaries) == 1:
            start = boundaries[0]
            stop = boundaries[0]
        elif len(boundaries) == 2:
            if boundaries[0] == '':
                start = applied[0]
            else:
                start = boundaries[0]
            if boundaries[1] == '':
                stop = applied[-1]
            else:
                stop = boundaries[1]
        else:
            raise CmdException, 'incorrect parameters to "--range"'

        if start in applied:
            start_idx = applied.index(start)
        else:
            if start in unapplied:
                raise CmdException, 'Patch "%s" not applied' % start
            else:
                raise CmdException, 'Patch "%s" does not exist' % start

        if stop in applied:
            stop_idx = applied.index(stop) + 1
        else:
            if stop in unapplied:
                raise CmdException, 'Patch "%s" not applied' % stop
            else:
                raise CmdException, 'Patch "%s" does not exist' % stop

        if start_idx >= stop_idx:
            raise CmdException, 'Incorrect patch range order'
    else:
        start_idx = 0
        stop_idx = len(applied)

    patches = applied[start_idx:stop_idx]

    num = len(patches)
    if num == 0:
        raise CmdException, 'No patches applied'

    zpadding = len(str(num))
    if zpadding < 2:
        zpadding = 2

    # get the template
    if options.template:
        patch_tmpl_list = [options.template]
    else:
        patch_tmpl_list = []

    patch_tmpl_list += [os.path.join(basedir.get(), 'patchexport.tmpl'),
                        os.path.join(os.path.expanduser('~'), '.stgit', 'templates',
                                     'patchexport.tmpl'),
                        os.path.join(sys.prefix,
                                     'share', 'stgit', 'templates', 'patchexport.tmpl')]
    tmpl = ''
    for patch_tmpl in patch_tmpl_list:
        if os.path.isfile(patch_tmpl):
            tmpl = file(patch_tmpl).read()
            break

    # note the base commit for this series
    if not options.stdout:
        base_commit = crt_series.get_patch(patches[0]).get_bottom()
        print >> series, '# This series applies on GIT commit %s' % base_commit

    patch_no = 1;
    for p in patches:
        pname = p
        if options.diff:
            pname = '%s.diff' % pname
        elif options.patch:
            pname = '%s.patch' % pname
        if options.numbered:
            pname = '%s-%s' % (str(patch_no).zfill(zpadding), pname)
        pfile = os.path.join(dirname, pname)
        if not options.stdout:
            print >> series, pname

        # get the patch description
        patch = crt_series.get_patch(p)

        descr = patch.get_description().strip()
        descr_lines = descr.split('\n')

        short_descr = descr_lines[0].rstrip()
        long_descr = reduce(lambda x, y: x + '\n' + y,
                            descr_lines[1:], '').strip()

        tmpl_dict = {'description': patch.get_description().rstrip(),
                     'shortdescr': short_descr,
                     'longdescr': long_descr,
                     'diffstat': git.diffstat(rev1 = patch.get_bottom(),
                                              rev2 = patch.get_top()),
                     'authname': patch.get_authname(),
                     'authemail': patch.get_authemail(),
                     'authdate': patch.get_authdate(),
                     'commname': patch.get_commname(),
                     'commemail': patch.get_commemail()}
        for key in tmpl_dict:
            if not tmpl_dict[key]:
                tmpl_dict[key] = ''

        try:
            descr = tmpl % tmpl_dict
        except KeyError, err:
            raise CmdException, 'Unknown patch template variable: %s' \
                  % err
        except TypeError:
            raise CmdException, 'Only "%(name)s" variables are ' \
                  'supported in the patch template'

        if options.stdout:
            f = sys.stdout
        else:
            f = open(pfile, 'w+')

        if options.stdout and num > 1:
            print '-------------------------------------------------------------------------------'
            print patch.get_name()
            print '-------------------------------------------------------------------------------'

        # write description
        f.write(descr)
        # write the diff
        git.diff(rev1 = patch.get_bottom(),
                 rev2 = patch.get_top(),
                 out_fd = f)
        if not options.stdout:
            f.close()
        patch_no += 1

    if not options.stdout:
        series.close()