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

   1 __copyright__ = """
   2 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
   3
   4 This program is free software; you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License version 2 as
   6 published by the Free Software Foundation.
   7
   8 This program is distributed in the hope that it will be useful,
   9 but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 GNU General Public License for more details.
  12
  13 You should have received a copy of the GNU General Public License
  14 along with this program; if not, write to the Free Software
  15 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 """
  17
  18 import sys, os, re, email, tarfile
  19 from mailbox import UnixMailbox
  20 from StringIO import StringIO
  21 from stgit.argparse import opt
  22 from stgit.commands.common import *
  23 from stgit.utils import *
  24 from stgit.out import *
  25 from stgit import argparse, stack, git
  26
  27 name = 'import'
  28 help = 'Import a GNU diff file as a new patch'
  29 kind = 'patch'
  30 usage = ['[options] [<file>|<url>]']
  31 description = """
  32 Create a new patch and apply the given GNU diff file (or the standard
  33 input). By default, the file name is used as the patch name but this
  34 can be overridden with the '--name' option. The patch can either be a
  35 normal file with the description at the top or it can have standard
  36 mail format, the Subject, From and Date headers being used for
  37 generating the patch information. The command can also read series and
  38 mbox files.
  39
  40 If a patch does not apply cleanly, the failed diff is written to the
  41 .stgit-failed.patch file and an empty StGIT patch is added to the
  42 stack.
  43
  44 The patch description has to be separated from the data with a '---'
  45 line."""
  46
  47 args = [argparse.files]
  48 options = [
  49     opt('-m', '--mail', action = 'store_true',
  50         short = 'Import the patch from a standard e-mail file'),
  51     opt('-M', '--mbox', action = 'store_true',
  52         short = 'Import a series of patches from an mbox file'),
  53     opt('-s', '--series', action = 'store_true',
  54         short = 'Import a series of patches', long = """
  55         Import a series of patches from a series file or a tar archive."""),
  56     opt('-u', '--url', action = 'store_true',
  57         short = 'Import a patch from a URL'),
  58     opt('-n', '--name',
  59         short = 'Use NAME as the patch name'),
  60     opt('-p', '--strip', type = 'int', metavar = 'N',
  61         short = 'Remove N leading slashes from diff paths (default 1)'),
  62     opt('-t', '--stripname', action = 'store_true',
  63         short = 'Strip numbering and extension from patch name'),
  64     opt('-i', '--ignore', action = 'store_true',
  65         short = 'Ignore the applied patches in the series'),
  66     opt('--replace', action = 'store_true',
  67         short = 'Replace the unapplied patches in the series'),
  68     opt('-b', '--base', args = [argparse.commit],
  69         short = 'Use BASE instead of HEAD for file importing'),
  70     opt('--reject', action = 'store_true',
  71         short = 'Leave the rejected hunks in corresponding *.rej files'),
  72     opt('-e', '--edit', action = 'store_true',
  73         short = 'Invoke an editor for the patch description'),
  74     opt('-d', '--showdiff', action = 'store_true',
  75         short = 'Show the patch content in the editor buffer'),
  76     opt('-a', '--author', metavar = '"NAME <EMAIL>"',
  77         short = 'Use "NAME <EMAIL>" as the author details'),
  78     opt('--authname',
  79         short = 'Use AUTHNAME as the author name'),
  80     opt('--authemail',
  81         short = 'Use AUTHEMAIL as the author e-mail'),
  82     opt('--authdate',
  83         short = 'Use AUTHDATE as the author date'),
  84     ] + argparse.sign_options()
  85
  86 directory = DirectoryHasRepository(log = True)
  87
  88 def __strip_patch_name(name):
  89     stripped = re.sub('^[0-9]+-(.*)$', '\g<1>', name)
  90     stripped = re.sub('^(.*)\.(diff|patch)$', '\g<1>', stripped)
  91
  92     return stripped
  93
  94 def __replace_slashes_with_dashes(name):
  95     stripped = name.replace('/', '-')
  96
  97     return stripped
  98
  99 def __create_patch(filename, message, author_name, author_email,
 100                    author_date, diff, options):
 101     """Create a new patch on the stack
 102     """
 103     if options.name:
 104         patch = options.name
 105     elif filename:
 106         patch = os.path.basename(filename)
 107     else:
 108         patch = ''
 109     if options.stripname:
 110         patch = __strip_patch_name(patch)
 111
 112     if not patch:
 113         if options.ignore or options.replace:
 114             unacceptable_name = lambda name: False
 115         else:
 116             unacceptable_name = crt_series.patch_exists
 117         patch = make_patch_name(message, unacceptable_name)
 118     else:
 119         # fix possible invalid characters in the patch name
 120         patch = re.sub('[^\w.]+', '-', patch).strip('-')
 121
 122     if options.ignore and patch in crt_series.get_applied():
 123         out.info('Ignoring already applied patch "%s"' % patch)
 124         return
 125     if options.replace and patch in crt_series.get_unapplied():
 126         crt_series.delete_patch(patch, keep_log = True)
 127
 128     # refresh_patch() will invoke the editor in this case, with correct
 129     # patch content
 130     if not message:
 131         can_edit = False
 132
 133     if options.author:
 134         options.authname, options.authemail = name_email(options.author)
 135
 136     # override the automatically parsed settings
 137     if options.authname:
 138         author_name = options.authname
 139     if options.authemail:
 140         author_email = options.authemail
 141     if options.authdate:
 142         author_date = options.authdate
 143
 144     sign_str = options.sign_str
 145     if not options.sign_str:
 146         sign_str = config.get('stgit.autosign')
 147
 148     crt_series.new_patch(patch, message = message, can_edit = False,
 149                          author_name = author_name,
 150                          author_email = author_email,
 151                          author_date = author_date, sign_str = sign_str)
 152
 153     if not diff:
 154         out.warn('No diff found, creating empty patch')
 155     else:
 156         out.start('Importing patch "%s"' % patch)
 157         if options.base:
 158             base = git_id(crt_series, options.base)
 159         else:
 160             base = None
 161         try:
 162             git.apply_patch(diff = diff, base = base, reject = options.reject,
 163                             strip = options.strip)
 164         except git.GitException:
 165             if not options.reject:
 166                 crt_series.delete_patch(patch)
 167             raise
 168         crt_series.refresh_patch(edit = options.edit,
 169                                  show_patch = options.showdiff,
 170                                  author_date = author_date,
 171                                  backup = False)
 172         out.done()
 173
 174 def __mkpatchname(name, suffix):
 175     if name.lower().endswith(suffix.lower()):
 176         return name[:-len(suffix)]
 177     return name
 178
 179 def __get_handle_and_name(filename):
 180     """Return a file object and a patch name derived from filename
 181     """
 182     # see if it's a gzip'ed or bzip2'ed patch
 183     import bz2, gzip
 184     for copen, ext in [(gzip.open, '.gz'), (bz2.BZ2File, '.bz2')]:
 185         try:
 186             f = copen(filename)
 187             f.read(1)
 188             f.seek(0)
 189             return (f, __mkpatchname(filename, ext))
 190         except IOError, e:
 191             pass
 192
 193     # plain old file...
 194     return (open(filename), filename)
 195
 196 def __import_file(filename, options, patch = None):
 197     """Import a patch from a file or standard input
 198     """
 199     pname = None
 200     if filename:
 201         (f, pname) = __get_handle_and_name(filename)
 202     else:
 203         f = sys.stdin
 204
 205     if patch:
 206         pname = patch
 207     elif not pname:
 208         pname = filename
 209
 210     if options.mail:
 211         try:
 212             msg = email.message_from_file(f)
 213         except Exception, ex:
 214             raise CmdException, 'error parsing the e-mail file: %s' % str(ex)
 215         message, author_name, author_email, author_date, diff = \
 216                  parse_mail(msg)
 217     else:
 218         message, author_name, author_email, author_date, diff = \
 219                  parse_patch(f.read(), contains_diff = True)
 220
 221     if filename:
 222         f.close()
 223
 224     __create_patch(pname, message, author_name, author_email,
 225                    author_date, diff, options)
 226
 227 def __import_series(filename, options):
 228     """Import a series of patches
 229     """
 230     applied = crt_series.get_applied()
 231
 232     if filename:
 233         if tarfile.is_tarfile(filename):
 234             __import_tarfile(filename, options)
 235             return
 236         f = file(filename)
 237         patchdir = os.path.dirname(filename)
 238     else:
 239         f = sys.stdin
 240         patchdir = ''
 241
 242     for line in f:
 243         patch = re.sub('#.*$', '', line).strip()
 244         if not patch:
 245             continue
 246         patchfile = os.path.join(patchdir, patch)
 247         patch = __replace_slashes_with_dashes(patch);
 248
 249         __import_file(patchfile, options, patch)
 250
 251     if filename:
 252         f.close()
 253
 254 def __import_mbox(filename, options):
 255     """Import a series from an mbox file
 256     """
 257     if filename:
 258         f = file(filename, 'rb')
 259     else:
 260         f = StringIO(sys.stdin.read())
 261
 262     try:
 263         mbox = UnixMailbox(f, email.message_from_file)
 264     except Exception, ex:
 265         raise CmdException, 'error parsing the mbox file: %s' % str(ex)
 266
 267     for msg in mbox:
 268         message, author_name, author_email, author_date, diff = \
 269                  parse_mail(msg)
 270         __create_patch(None, message, author_name, author_email,
 271                        author_date, diff, options)
 272
 273     f.close()
 274
 275 def __import_url(url, options):
 276     """Import a patch from a URL
 277     """
 278     import urllib
 279     import tempfile
 280
 281     if not url:
 282         raise CmdException('URL argument required')
 283
 284     patch = os.path.basename(urllib.unquote(url))
 285     filename = os.path.join(tempfile.gettempdir(), patch)
 286     urllib.urlretrieve(url, filename)
 287     __import_file(filename, options)
 288
 289 def __import_tarfile(tar, options):
 290     """Import patch series from a tar archive
 291     """
 292     import tempfile
 293     import shutil
 294
 295     if not tarfile.is_tarfile(tar):
 296         raise CmdException, "%s is not a tarfile!" % tar
 297
 298     t = tarfile.open(tar, 'r')
 299     names = t.getnames()
 300
 301     # verify paths in the tarfile are safe
 302     for n in names:
 303         if n.startswith('/'):
 304             raise CmdException, "Absolute path found in %s" % tar
 305         if n.find("..") > -1:
 306             raise CmdException, "Relative path found in %s" % tar
 307
 308     # find the series file
 309     seriesfile = '';
 310     for m in names:
 311         if m.endswith('/series') or m == 'series':
 312             seriesfile = m
 313             break
 314     if seriesfile == '':
 315         raise CmdException, "no 'series' file found in %s" % tar
 316
 317     # unpack into a tmp dir
 318     tmpdir = tempfile.mkdtemp('.stg')
 319     t.extractall(tmpdir)
 320
 321     # apply the series
 322     __import_series(os.path.join(tmpdir, seriesfile), options)
 323
 324     # cleanup the tmpdir
 325     shutil.rmtree(tmpdir)
 326
 327 def func(parser, options, args):
 328     """Import a GNU diff file as a new patch
 329     """
 330     if len(args) > 1:
 331         parser.error('incorrect number of arguments')
 332
 333     check_local_changes()
 334     check_conflicts()
 335     check_head_top_equal(crt_series)
 336
 337     if len(args) == 1:
 338         filename = args[0]
 339     else:
 340         filename = None
 341
 342     if not options.url and filename:
 343         filename = os.path.abspath(filename)
 344     directory.cd_to_topdir()
 345
 346     if options.series:
 347         __import_series(filename, options)
 348     elif options.mbox:
 349         __import_mbox(filename, options)
 350     elif options.url:
 351         __import_url(filename, options)
 352     else:
 353         __import_file(filename, options)
 354
 355     print_crt_patch(crt_series)