/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-06-15 04:14:26 UTC
  • Revision ID: mbp@sourcefrog.net-20050615041426-6a94f75bc556be2f
- glob expand add arguments on win32
  patch from Roncaglia Julien

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
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
 
 
19
import sys, os
 
20
 
 
21
import bzrlib
 
22
from bzrlib.trace import mutter, note, log_error
 
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
24
from bzrlib.osutils import quotefn
 
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
 
26
     format_date
 
27
 
 
28
 
 
29
def _squish_command_name(cmd):
 
30
    return 'cmd_' + cmd.replace('-', '_')
 
31
 
 
32
 
 
33
def _unsquish_command_name(cmd):
 
34
    assert cmd.startswith("cmd_")
 
35
    return cmd[4:].replace('_','-')
 
36
 
 
37
def _parse_revision_str(revstr):
 
38
    """This handles a revision string -> revno. 
 
39
 
 
40
    There are several possibilities:
 
41
 
 
42
        '234'       -> 234
 
43
        '234:345'   -> [234, 345]
 
44
        ':234'      -> [None, 234]
 
45
        '234:'      -> [234, None]
 
46
 
 
47
    In the future we will also support:
 
48
        'uuid:blah-blah-blah'   -> ?
 
49
        'hash:blahblahblah'     -> ?
 
50
        potentially:
 
51
        'tag:mytag'             -> ?
 
52
    """
 
53
    if revstr.find(':') != -1:
 
54
        revs = revstr.split(':')
 
55
        if len(revs) > 2:
 
56
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
 
57
 
 
58
        if not revs[0]:
 
59
            revs[0] = None
 
60
        else:
 
61
            revs[0] = int(revs[0])
 
62
 
 
63
        if not revs[1]:
 
64
            revs[1] = None
 
65
        else:
 
66
            revs[1] = int(revs[1])
 
67
    else:
 
68
        revs = int(revstr)
 
69
    return revs
 
70
 
 
71
def _find_plugins():
 
72
    """Find all python files which are plugins, and load their commands
 
73
    to add to the list of "all commands"
 
74
 
 
75
    The environment variable BZRPATH is considered a delimited set of
 
76
    paths to look through. Each entry is searched for *.py files.
 
77
    If a directory is found, it is also searched, but they are 
 
78
    not searched recursively. This allows you to revctl the plugins.
 
79
    
 
80
    Inside the plugin should be a series of cmd_* function, which inherit from
 
81
    the bzrlib.commands.Command class.
 
82
    """
 
83
    bzrpath = os.environ.get('BZRPLUGINPATH', '')
 
84
 
 
85
    plugin_cmds = {} 
 
86
    if not bzrpath:
 
87
        return plugin_cmds
 
88
    _platform_extensions = {
 
89
        'win32':'.pyd',
 
90
        'cygwin':'.dll',
 
91
        'darwin':'.dylib',
 
92
        'linux2':'.so'
 
93
        }
 
94
    if _platform_extensions.has_key(sys.platform):
 
95
        platform_extension = _platform_extensions[sys.platform]
 
96
    else:
 
97
        platform_extension = None
 
98
    for d in bzrpath.split(os.pathsep):
 
99
        plugin_names = {} # This should really be a set rather than a dict
 
100
        for f in os.listdir(d):
 
101
            if f.endswith('.py'):
 
102
                f = f[:-3]
 
103
            elif f.endswith('.pyc') or f.endswith('.pyo'):
 
104
                f = f[:-4]
 
105
            elif platform_extension and f.endswith(platform_extension):
 
106
                f = f[:-len(platform_extension)]
 
107
                if f.endswidth('module'):
 
108
                    f = f[:-len('module')]
 
109
            else:
 
110
                continue
 
111
            if not plugin_names.has_key(f):
 
112
                plugin_names[f] = True
 
113
 
 
114
        plugin_names = plugin_names.keys()
 
115
        plugin_names.sort()
 
116
        try:
 
117
            sys.path.insert(0, d)
 
118
            for name in plugin_names:
 
119
                try:
 
120
                    old_module = None
 
121
                    try:
 
122
                        if sys.modules.has_key(name):
 
123
                            old_module = sys.modules[name]
 
124
                            del sys.modules[name]
 
125
                        plugin = __import__(name, locals())
 
126
                        for k in dir(plugin):
 
127
                            if k.startswith('cmd_'):
 
128
                                k_unsquished = _unsquish_command_name(k)
 
129
                                if not plugin_cmds.has_key(k_unsquished):
 
130
                                    plugin_cmds[k_unsquished] = getattr(plugin, k)
 
131
                                else:
 
132
                                    log_error('Two plugins defined the same command: %r' % k)
 
133
                                    log_error('Not loading the one in %r in dir %r' % (name, d))
 
134
                    finally:
 
135
                        if old_module:
 
136
                            sys.modules[name] = old_module
 
137
                except ImportError, e:
 
138
                    log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
 
139
        finally:
 
140
            sys.path.pop(0)
 
141
    return plugin_cmds
 
142
 
 
143
def _get_cmd_dict(include_plugins=True):
 
144
    d = {}
 
145
    for k, v in globals().iteritems():
 
146
        if k.startswith("cmd_"):
 
147
            d[_unsquish_command_name(k)] = v
 
148
    if include_plugins:
 
149
        d.update(_find_plugins())
 
150
    return d
 
151
    
 
152
def get_all_cmds(include_plugins=True):
 
153
    """Return canonical name and class for all registered commands."""
 
154
    for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
 
155
        yield k,v
 
156
 
 
157
 
 
158
def get_cmd_class(cmd,include_plugins=True):
 
159
    """Return the canonical name and command class for a command.
 
160
    """
 
161
    cmd = str(cmd)                      # not unicode
 
162
 
 
163
    # first look up this command under the specified name
 
164
    cmds = _get_cmd_dict(include_plugins=include_plugins)
 
165
    try:
 
166
        return cmd, cmds[cmd]
 
167
    except KeyError:
 
168
        pass
 
169
 
 
170
    # look for any command which claims this as an alias
 
171
    for cmdname, cmdclass in cmds.iteritems():
 
172
        if cmd in cmdclass.aliases:
 
173
            return cmdname, cmdclass
 
174
 
 
175
    cmdclass = ExternalCommand.find_command(cmd)
 
176
    if cmdclass:
 
177
        return cmd, cmdclass
 
178
 
 
179
    raise BzrCommandError("unknown command %r" % cmd)
 
180
 
 
181
 
 
182
class Command(object):
 
183
    """Base class for commands.
 
184
 
 
185
    The docstring for an actual command should give a single-line
 
186
    summary, then a complete description of the command.  A grammar
 
187
    description will be inserted.
 
188
 
 
189
    takes_args
 
190
        List of argument forms, marked with whether they are optional,
 
191
        repeated, etc.
 
192
 
 
193
    takes_options
 
194
        List of options that may be given for this command.
 
195
 
 
196
    hidden
 
197
        If true, this command isn't advertised.
 
198
    """
 
199
    aliases = []
 
200
    
 
201
    takes_args = []
 
202
    takes_options = []
 
203
 
 
204
    hidden = False
 
205
    
 
206
    def __init__(self, options, arguments):
 
207
        """Construct and run the command.
 
208
 
 
209
        Sets self.status to the return value of run()."""
 
210
        assert isinstance(options, dict)
 
211
        assert isinstance(arguments, dict)
 
212
        cmdargs = options.copy()
 
213
        cmdargs.update(arguments)
 
214
        assert self.__doc__ != Command.__doc__, \
 
215
               ("No help message set for %r" % self)
 
216
        self.status = self.run(**cmdargs)
 
217
 
 
218
    
 
219
    def run(self):
 
220
        """Override this in sub-classes.
 
221
 
 
222
        This is invoked with the options and arguments bound to
 
223
        keyword parameters.
 
224
 
 
225
        Return 0 or None if the command was successful, or a shell
 
226
        error code if not.
 
227
        """
 
228
        return 0
 
229
 
 
230
 
 
231
class ExternalCommand(Command):
 
232
    """Class to wrap external commands.
 
233
 
 
234
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
235
    an object we construct that has the appropriate path, help, options etc for the
 
236
    specified command.
 
237
 
 
238
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
239
    method, which we override to call the Command.__init__ method. That then calls
 
240
    our run method which is pretty straight forward.
 
241
 
 
242
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
243
    back into command line options and arguments for the script.
 
244
    """
 
245
 
 
246
    def find_command(cls, cmd):
 
247
        import os.path
 
248
        bzrpath = os.environ.get('BZRPATH', '')
 
249
 
 
250
        for dir in bzrpath.split(os.pathsep):
 
251
            path = os.path.join(dir, cmd)
 
252
            if os.path.isfile(path):
 
253
                return ExternalCommand(path)
 
254
 
 
255
        return None
 
256
 
 
257
    find_command = classmethod(find_command)
 
258
 
 
259
    def __init__(self, path):
 
260
        self.path = path
 
261
 
 
262
        # TODO: If either of these fail, we should detect that and
 
263
        # assume that path is not really a bzr plugin after all.
 
264
 
 
265
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
266
        self.takes_options = pipe.readline().split()
 
267
        self.takes_args = pipe.readline().split()
 
268
        pipe.close()
 
269
 
 
270
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
271
        self.__doc__ = pipe.read()
 
272
        pipe.close()
 
273
 
 
274
    def __call__(self, options, arguments):
 
275
        Command.__init__(self, options, arguments)
 
276
        return self
 
277
 
 
278
    def run(self, **kargs):
 
279
        opts = []
 
280
        args = []
 
281
 
 
282
        keys = kargs.keys()
 
283
        keys.sort()
 
284
        for name in keys:
 
285
            value = kargs[name]
 
286
            if OPTIONS.has_key(name):
 
287
                # it's an option
 
288
                opts.append('--%s' % name)
 
289
                if value is not None and value is not True:
 
290
                    opts.append(str(value))
 
291
            else:
 
292
                # it's an arg, or arg list
 
293
                if type(value) is not list:
 
294
                    value = [value]
 
295
                for v in value:
 
296
                    if v is not None:
 
297
                        args.append(str(v))
 
298
 
 
299
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
300
        return self.status
 
301
 
 
302
 
 
303
class cmd_status(Command):
 
304
    """Display status summary.
 
305
 
 
306
    This reports on versioned and unknown files, reporting them
 
307
    grouped by state.  Possible states are:
 
308
 
 
309
    added
 
310
        Versioned in the working copy but not in the previous revision.
 
311
 
 
312
    removed
 
313
        Versioned in the previous revision but removed or deleted
 
314
        in the working copy.
 
315
 
 
316
    renamed
 
317
        Path of this file changed from the previous revision;
 
318
        the text may also have changed.  This includes files whose
 
319
        parent directory was renamed.
 
320
 
 
321
    modified
 
322
        Text has changed since the previous revision.
 
323
 
 
324
    unchanged
 
325
        Nothing about this file has changed since the previous revision.
 
326
        Only shown with --all.
 
327
 
 
328
    unknown
 
329
        Not versioned and not matching an ignore pattern.
 
330
 
 
331
    To see ignored files use 'bzr ignored'.  For details in the
 
332
    changes to file texts, use 'bzr diff'.
 
333
 
 
334
    If no arguments are specified, the status of the entire working
 
335
    directory is shown.  Otherwise, only the status of the specified
 
336
    files or directories is reported.  If a directory is given, status
 
337
    is reported for everything inside that directory.
 
338
    """
 
339
    takes_args = ['file*']
 
340
    takes_options = ['all', 'show-ids']
 
341
    aliases = ['st', 'stat']
 
342
    
 
343
    def run(self, all=False, show_ids=False, file_list=None):
 
344
        if file_list:
 
345
            b = Branch(file_list[0])
 
346
            file_list = [b.relpath(x) for x in file_list]
 
347
            # special case: only one path was given and it's the root
 
348
            # of the branch
 
349
            if file_list == ['']:
 
350
                file_list = None
 
351
        else:
 
352
            b = Branch('.')
 
353
        import status
 
354
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
 
355
                           specific_files=file_list)
 
356
 
 
357
 
 
358
class cmd_cat_revision(Command):
 
359
    """Write out metadata for a revision."""
 
360
 
 
361
    hidden = True
 
362
    takes_args = ['revision_id']
 
363
    
 
364
    def run(self, revision_id):
 
365
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
366
 
 
367
 
 
368
class cmd_revno(Command):
 
369
    """Show current revision number.
 
370
 
 
371
    This is equal to the number of revisions on this branch."""
 
372
    def run(self):
 
373
        print Branch('.').revno()
 
374
 
 
375
    
 
376
class cmd_add(Command):
 
377
    """Add specified files or directories.
 
378
 
 
379
    In non-recursive mode, all the named items are added, regardless
 
380
    of whether they were previously ignored.  A warning is given if
 
381
    any of the named files are already versioned.
 
382
 
 
383
    In recursive mode (the default), files are treated the same way
 
384
    but the behaviour for directories is different.  Directories that
 
385
    are already versioned do not give a warning.  All directories,
 
386
    whether already versioned or not, are searched for files or
 
387
    subdirectories that are neither versioned or ignored, and these
 
388
    are added.  This search proceeds recursively into versioned
 
389
    directories.
 
390
 
 
391
    Therefore simply saying 'bzr add .' will version all files that
 
392
    are currently unknown.
 
393
 
 
394
    TODO: Perhaps adding a file whose directly is not versioned should
 
395
    recursively add that parent, rather than giving an error?
 
396
    """
 
397
    takes_args = ['file+']
 
398
    takes_options = ['verbose', 'no-recurse']
 
399
    
 
400
    def run(self, file_list, verbose=False, no_recurse=False):
 
401
        bzrlib.add.smart_add(file_list, verbose, not no_recurse)
 
402
 
 
403
 
 
404
class cmd_relpath(Command):
 
405
    """Show path of a file relative to root"""
 
406
    takes_args = ['filename']
 
407
    hidden = True
 
408
    
 
409
    def run(self, filename):
 
410
        print Branch(filename).relpath(filename)
 
411
 
 
412
 
 
413
 
 
414
class cmd_inventory(Command):
 
415
    """Show inventory of the current working copy or a revision."""
 
416
    takes_options = ['revision', 'show-ids']
 
417
    
 
418
    def run(self, revision=None, show_ids=False):
 
419
        b = Branch('.')
 
420
        if revision == None:
 
421
            inv = b.read_working_inventory()
 
422
        else:
 
423
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
424
 
 
425
        for path, entry in inv.entries():
 
426
            if show_ids:
 
427
                print '%-50s %s' % (path, entry.file_id)
 
428
            else:
 
429
                print path
 
430
 
 
431
 
 
432
class cmd_move(Command):
 
433
    """Move files to a different directory.
 
434
 
 
435
    examples:
 
436
        bzr move *.txt doc
 
437
 
 
438
    The destination must be a versioned directory in the same branch.
 
439
    """
 
440
    takes_args = ['source$', 'dest']
 
441
    def run(self, source_list, dest):
 
442
        b = Branch('.')
 
443
 
 
444
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
445
 
 
446
 
 
447
class cmd_rename(Command):
 
448
    """Change the name of an entry.
 
449
 
 
450
    examples:
 
451
      bzr rename frob.c frobber.c
 
452
      bzr rename src/frob.c lib/frob.c
 
453
 
 
454
    It is an error if the destination name exists.
 
455
 
 
456
    See also the 'move' command, which moves files into a different
 
457
    directory without changing their name.
 
458
 
 
459
    TODO: Some way to rename multiple files without invoking bzr for each
 
460
    one?"""
 
461
    takes_args = ['from_name', 'to_name']
 
462
    
 
463
    def run(self, from_name, to_name):
 
464
        b = Branch('.')
 
465
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
466
 
 
467
 
 
468
 
 
469
 
 
470
 
 
471
class cmd_pull(Command):
 
472
    """Pull any changes from another branch into the current one.
 
473
 
 
474
    If the location is omitted, the last-used location will be used.
 
475
    Both the revision history and the working directory will be
 
476
    updated.
 
477
 
 
478
    This command only works on branches that have not diverged.  Branches are
 
479
    considered diverged if both branches have had commits without first
 
480
    pulling from the other.
 
481
 
 
482
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
483
    from one into the other.
 
484
    """
 
485
    takes_args = ['location?']
 
486
 
 
487
    def run(self, location=None):
 
488
        from bzrlib.merge import merge
 
489
        import errno
 
490
        
 
491
        br_to = Branch('.')
 
492
        stored_loc = None
 
493
        try:
 
494
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
 
495
        except IOError, e:
 
496
            if errno == errno.ENOENT:
 
497
                raise
 
498
        if location is None:
 
499
            location = stored_loc
 
500
        if location is None:
 
501
            raise BzrCommandError("No pull location known or specified.")
 
502
        from branch import find_branch, DivergedBranches
 
503
        br_from = find_branch(location)
 
504
        location = pull_loc(br_from)
 
505
        old_revno = br_to.revno()
 
506
        try:
 
507
            br_to.update_revisions(br_from)
 
508
        except DivergedBranches:
 
509
            raise BzrCommandError("These branches have diverged.  Try merge.")
 
510
            
 
511
        merge(('.', -1), ('.', old_revno), check_clean=False)
 
512
        if location != stored_loc:
 
513
            br_to.controlfile("x-pull", "wb").write(location + "\n")
 
514
 
 
515
 
 
516
 
 
517
class cmd_branch(Command):
 
518
    """Create a new copy of a branch.
 
519
 
 
520
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
521
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
522
 
 
523
    To retrieve the branch as of a particular revision, supply the --revision
 
524
    parameter, as in "branch foo/bar -r 5".
 
525
    """
 
526
    takes_args = ['from_location', 'to_location?']
 
527
    takes_options = ['revision']
 
528
 
 
529
    def run(self, from_location, to_location=None, revision=None):
 
530
        import errno
 
531
        from bzrlib.merge import merge
 
532
        from branch import find_branch, DivergedBranches, NoSuchRevision
 
533
        from shutil import rmtree
 
534
        try:
 
535
            br_from = find_branch(from_location)
 
536
        except OSError, e:
 
537
            if e.errno == errno.ENOENT:
 
538
                raise BzrCommandError('Source location "%s" does not exist.' %
 
539
                                      to_location)
 
540
            else:
 
541
                raise
 
542
 
 
543
        if to_location is None:
 
544
            to_location = os.path.basename(from_location.rstrip("/\\"))
 
545
 
 
546
        try:
 
547
            os.mkdir(to_location)
 
548
        except OSError, e:
 
549
            if e.errno == errno.EEXIST:
 
550
                raise BzrCommandError('Target directory "%s" already exists.' %
 
551
                                      to_location)
 
552
            if e.errno == errno.ENOENT:
 
553
                raise BzrCommandError('Parent of "%s" does not exist.' %
 
554
                                      to_location)
 
555
            else:
 
556
                raise
 
557
        br_to = Branch(to_location, init=True)
 
558
 
 
559
        try:
 
560
            br_to.update_revisions(br_from, stop_revision=revision)
 
561
        except NoSuchRevision:
 
562
            rmtree(to_location)
 
563
            msg = "The branch %s has no revision %d." % (from_location,
 
564
                                                         revision)
 
565
            raise BzrCommandError(msg)
 
566
        merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
567
              check_clean=False)
 
568
        from_location = pull_loc(br_from)
 
569
        br_to.controlfile("x-pull", "wb").write(from_location + "\n")
 
570
 
 
571
 
 
572
def pull_loc(branch):
 
573
    # TODO: Should perhaps just make attribute be 'base' in
 
574
    # RemoteBranch and Branch?
 
575
    if hasattr(branch, "baseurl"):
 
576
        return branch.baseurl
 
577
    else:
 
578
        return branch.base
 
579
 
 
580
 
 
581
 
 
582
class cmd_renames(Command):
 
583
    """Show list of renamed files.
 
584
 
 
585
    TODO: Option to show renames between two historical versions.
 
586
 
 
587
    TODO: Only show renames under dir, rather than in the whole branch.
 
588
    """
 
589
    takes_args = ['dir?']
 
590
 
 
591
    def run(self, dir='.'):
 
592
        b = Branch(dir)
 
593
        old_inv = b.basis_tree().inventory
 
594
        new_inv = b.read_working_inventory()
 
595
 
 
596
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
597
        renames.sort()
 
598
        for old_name, new_name in renames:
 
599
            print "%s => %s" % (old_name, new_name)        
 
600
 
 
601
 
 
602
class cmd_info(Command):
 
603
    """Show statistical information about a branch."""
 
604
    takes_args = ['branch?']
 
605
    
 
606
    def run(self, branch=None):
 
607
        import info
 
608
 
 
609
        from branch import find_branch
 
610
        b = find_branch(branch)
 
611
        info.show_info(b)
 
612
 
 
613
 
 
614
class cmd_remove(Command):
 
615
    """Make a file unversioned.
 
616
 
 
617
    This makes bzr stop tracking changes to a versioned file.  It does
 
618
    not delete the working copy.
 
619
    """
 
620
    takes_args = ['file+']
 
621
    takes_options = ['verbose']
 
622
    
 
623
    def run(self, file_list, verbose=False):
 
624
        b = Branch(file_list[0])
 
625
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
626
 
 
627
 
 
628
class cmd_file_id(Command):
 
629
    """Print file_id of a particular file or directory.
 
630
 
 
631
    The file_id is assigned when the file is first added and remains the
 
632
    same through all revisions where the file exists, even when it is
 
633
    moved or renamed.
 
634
    """
 
635
    hidden = True
 
636
    takes_args = ['filename']
 
637
    def run(self, filename):
 
638
        b = Branch(filename)
 
639
        i = b.inventory.path2id(b.relpath(filename))
 
640
        if i == None:
 
641
            bailout("%r is not a versioned file" % filename)
 
642
        else:
 
643
            print i
 
644
 
 
645
 
 
646
class cmd_file_path(Command):
 
647
    """Print path of file_ids to a file or directory.
 
648
 
 
649
    This prints one line for each directory down to the target,
 
650
    starting at the branch root."""
 
651
    hidden = True
 
652
    takes_args = ['filename']
 
653
    def run(self, filename):
 
654
        b = Branch(filename)
 
655
        inv = b.inventory
 
656
        fid = inv.path2id(b.relpath(filename))
 
657
        if fid == None:
 
658
            bailout("%r is not a versioned file" % filename)
 
659
        for fip in inv.get_idpath(fid):
 
660
            print fip
 
661
 
 
662
 
 
663
class cmd_revision_history(Command):
 
664
    """Display list of revision ids on this branch."""
 
665
    hidden = True
 
666
    def run(self):
 
667
        for patchid in Branch('.').revision_history():
 
668
            print patchid
 
669
 
 
670
 
 
671
class cmd_directories(Command):
 
672
    """Display list of versioned directories in this branch."""
 
673
    def run(self):
 
674
        for name, ie in Branch('.').read_working_inventory().directories():
 
675
            if name == '':
 
676
                print '.'
 
677
            else:
 
678
                print name
 
679
 
 
680
 
 
681
class cmd_init(Command):
 
682
    """Make a directory into a versioned branch.
 
683
 
 
684
    Use this to create an empty branch, or before importing an
 
685
    existing project.
 
686
 
 
687
    Recipe for importing a tree of files:
 
688
        cd ~/project
 
689
        bzr init
 
690
        bzr add -v .
 
691
        bzr status
 
692
        bzr commit -m 'imported project'
 
693
    """
 
694
    def run(self):
 
695
        Branch('.', init=True)
 
696
 
 
697
 
 
698
class cmd_diff(Command):
 
699
    """Show differences in working tree.
 
700
    
 
701
    If files are listed, only the changes in those files are listed.
 
702
    Otherwise, all changes for the tree are listed.
 
703
 
 
704
    TODO: Given two revision arguments, show the difference between them.
 
705
 
 
706
    TODO: Allow diff across branches.
 
707
 
 
708
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
709
          or a graphical diff.
 
710
 
 
711
    TODO: Python difflib is not exactly the same as unidiff; should
 
712
          either fix it up or prefer to use an external diff.
 
713
 
 
714
    TODO: If a directory is given, diff everything under that.
 
715
 
 
716
    TODO: Selected-file diff is inefficient and doesn't show you
 
717
          deleted files.
 
718
 
 
719
    TODO: This probably handles non-Unix newlines poorly.
 
720
    """
 
721
    
 
722
    takes_args = ['file*']
 
723
    takes_options = ['revision', 'diff-options']
 
724
    aliases = ['di', 'dif']
 
725
 
 
726
    def run(self, revision=None, file_list=None, diff_options=None):
 
727
        from bzrlib.diff import show_diff
 
728
        from bzrlib import find_branch
 
729
 
 
730
        if file_list:
 
731
            b = find_branch(file_list[0])
 
732
            file_list = [b.relpath(f) for f in file_list]
 
733
            if file_list == ['']:
 
734
                # just pointing to top-of-tree
 
735
                file_list = None
 
736
        else:
 
737
            b = Branch('.')
 
738
    
 
739
        show_diff(b, revision, specific_files=file_list,
 
740
                  external_diff_options=diff_options)
 
741
 
 
742
 
 
743
        
 
744
 
 
745
 
 
746
class cmd_deleted(Command):
 
747
    """List files deleted in the working tree.
 
748
 
 
749
    TODO: Show files deleted since a previous revision, or between two revisions.
 
750
    """
 
751
    def run(self, show_ids=False):
 
752
        b = Branch('.')
 
753
        old = b.basis_tree()
 
754
        new = b.working_tree()
 
755
 
 
756
        ## TODO: Much more efficient way to do this: read in new
 
757
        ## directories with readdir, rather than stating each one.  Same
 
758
        ## level of effort but possibly much less IO.  (Or possibly not,
 
759
        ## if the directories are very large...)
 
760
 
 
761
        for path, ie in old.inventory.iter_entries():
 
762
            if not new.has_id(ie.file_id):
 
763
                if show_ids:
 
764
                    print '%-50s %s' % (path, ie.file_id)
 
765
                else:
 
766
                    print path
 
767
 
 
768
 
 
769
class cmd_modified(Command):
 
770
    """List files modified in working tree."""
 
771
    hidden = True
 
772
    def run(self):
 
773
        import statcache
 
774
        b = Branch('.')
 
775
        inv = b.read_working_inventory()
 
776
        sc = statcache.update_cache(b, inv)
 
777
        basis = b.basis_tree()
 
778
        basis_inv = basis.inventory
 
779
        
 
780
        # We used to do this through iter_entries(), but that's slow
 
781
        # when most of the files are unmodified, as is usually the
 
782
        # case.  So instead we iterate by inventory entry, and only
 
783
        # calculate paths as necessary.
 
784
 
 
785
        for file_id in basis_inv:
 
786
            cacheentry = sc.get(file_id)
 
787
            if not cacheentry:                 # deleted
 
788
                continue
 
789
            ie = basis_inv[file_id]
 
790
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
791
                path = inv.id2path(file_id)
 
792
                print path
 
793
 
 
794
 
 
795
 
 
796
class cmd_added(Command):
 
797
    """List files added in working tree."""
 
798
    hidden = True
 
799
    def run(self):
 
800
        b = Branch('.')
 
801
        wt = b.working_tree()
 
802
        basis_inv = b.basis_tree().inventory
 
803
        inv = wt.inventory
 
804
        for file_id in inv:
 
805
            if file_id in basis_inv:
 
806
                continue
 
807
            path = inv.id2path(file_id)
 
808
            if not os.access(b.abspath(path), os.F_OK):
 
809
                continue
 
810
            print path
 
811
                
 
812
        
 
813
 
 
814
class cmd_root(Command):
 
815
    """Show the tree root directory.
 
816
 
 
817
    The root is the nearest enclosing directory with a .bzr control
 
818
    directory."""
 
819
    takes_args = ['filename?']
 
820
    def run(self, filename=None):
 
821
        """Print the branch root."""
 
822
        from branch import find_branch
 
823
        b = find_branch(filename)
 
824
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
825
 
 
826
 
 
827
class cmd_log(Command):
 
828
    """Show log of this branch.
 
829
 
 
830
    To request a range of logs, you can use the command -r begin:end
 
831
    -r revision requests a specific revision, -r :end or -r begin: are
 
832
    also valid.
 
833
 
 
834
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
835
  
 
836
    """
 
837
 
 
838
    takes_args = ['filename?']
 
839
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
 
840
    
 
841
    def run(self, filename=None, timezone='original',
 
842
            verbose=False,
 
843
            show_ids=False,
 
844
            forward=False,
 
845
            revision=None):
 
846
        from bzrlib import show_log, find_branch
 
847
        import codecs
 
848
 
 
849
        direction = (forward and 'forward') or 'reverse'
 
850
        
 
851
        if filename:
 
852
            b = find_branch(filename)
 
853
            fp = b.relpath(filename)
 
854
            if fp:
 
855
                file_id = b.read_working_inventory().path2id(fp)
 
856
            else:
 
857
                file_id = None  # points to branch root
 
858
        else:
 
859
            b = find_branch('.')
 
860
            file_id = None
 
861
 
 
862
        if revision == None:
 
863
            revision = [None, None]
 
864
        elif isinstance(revision, int):
 
865
            revision = [revision, revision]
 
866
        else:
 
867
            # pair of revisions?
 
868
            pass
 
869
            
 
870
        assert len(revision) == 2
 
871
 
 
872
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
873
 
 
874
        # use 'replace' so that we don't abort if trying to write out
 
875
        # in e.g. the default C locale.
 
876
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
877
 
 
878
        show_log(b, file_id,
 
879
                 show_timezone=timezone,
 
880
                 verbose=verbose,
 
881
                 show_ids=show_ids,
 
882
                 to_file=outf,
 
883
                 direction=direction,
 
884
                 start_revision=revision[0],
 
885
                 end_revision=revision[1])
 
886
 
 
887
 
 
888
 
 
889
class cmd_touching_revisions(Command):
 
890
    """Return revision-ids which affected a particular file.
 
891
 
 
892
    A more user-friendly interface is "bzr log FILE"."""
 
893
    hidden = True
 
894
    takes_args = ["filename"]
 
895
    def run(self, filename):
 
896
        b = Branch(filename)
 
897
        inv = b.read_working_inventory()
 
898
        file_id = inv.path2id(b.relpath(filename))
 
899
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
900
            print "%6d %s" % (revno, what)
 
901
 
 
902
 
 
903
class cmd_ls(Command):
 
904
    """List files in a tree.
 
905
 
 
906
    TODO: Take a revision or remote path and list that tree instead.
 
907
    """
 
908
    hidden = True
 
909
    def run(self, revision=None, verbose=False):
 
910
        b = Branch('.')
 
911
        if revision == None:
 
912
            tree = b.working_tree()
 
913
        else:
 
914
            tree = b.revision_tree(b.lookup_revision(revision))
 
915
 
 
916
        for fp, fc, kind, fid in tree.list_files():
 
917
            if verbose:
 
918
                if kind == 'directory':
 
919
                    kindch = '/'
 
920
                elif kind == 'file':
 
921
                    kindch = ''
 
922
                else:
 
923
                    kindch = '???'
 
924
 
 
925
                print '%-8s %s%s' % (fc, fp, kindch)
 
926
            else:
 
927
                print fp
 
928
 
 
929
 
 
930
 
 
931
class cmd_unknowns(Command):
 
932
    """List unknown files."""
 
933
    def run(self):
 
934
        for f in Branch('.').unknowns():
 
935
            print quotefn(f)
 
936
 
 
937
 
 
938
 
 
939
class cmd_ignore(Command):
 
940
    """Ignore a command or pattern.
 
941
 
 
942
    To remove patterns from the ignore list, edit the .bzrignore file.
 
943
 
 
944
    If the pattern contains a slash, it is compared to the whole path
 
945
    from the branch root.  Otherwise, it is comapred to only the last
 
946
    component of the path.
 
947
 
 
948
    Ignore patterns are case-insensitive on case-insensitive systems.
 
949
 
 
950
    Note: wildcards must be quoted from the shell on Unix.
 
951
 
 
952
    examples:
 
953
        bzr ignore ./Makefile
 
954
        bzr ignore '*.class'
 
955
    """
 
956
    takes_args = ['name_pattern']
 
957
    
 
958
    def run(self, name_pattern):
 
959
        from bzrlib.atomicfile import AtomicFile
 
960
        import os.path
 
961
 
 
962
        b = Branch('.')
 
963
        ifn = b.abspath('.bzrignore')
 
964
 
 
965
        if os.path.exists(ifn):
 
966
            f = open(ifn, 'rt')
 
967
            try:
 
968
                igns = f.read().decode('utf-8')
 
969
            finally:
 
970
                f.close()
 
971
        else:
 
972
            igns = ''
 
973
 
 
974
        # TODO: If the file already uses crlf-style termination, maybe
 
975
        # we should use that for the newly added lines?
 
976
 
 
977
        if igns and igns[-1] != '\n':
 
978
            igns += '\n'
 
979
        igns += name_pattern + '\n'
 
980
 
 
981
        try:
 
982
            f = AtomicFile(ifn, 'wt')
 
983
            f.write(igns.encode('utf-8'))
 
984
            f.commit()
 
985
        finally:
 
986
            f.close()
 
987
 
 
988
        inv = b.working_tree().inventory
 
989
        if inv.path2id('.bzrignore'):
 
990
            mutter('.bzrignore is already versioned')
 
991
        else:
 
992
            mutter('need to make new .bzrignore file versioned')
 
993
            b.add(['.bzrignore'])
 
994
 
 
995
 
 
996
 
 
997
class cmd_ignored(Command):
 
998
    """List ignored files and the patterns that matched them.
 
999
 
 
1000
    See also: bzr ignore"""
 
1001
    def run(self):
 
1002
        tree = Branch('.').working_tree()
 
1003
        for path, file_class, kind, file_id in tree.list_files():
 
1004
            if file_class != 'I':
 
1005
                continue
 
1006
            ## XXX: Slightly inefficient since this was already calculated
 
1007
            pat = tree.is_ignored(path)
 
1008
            print '%-50s %s' % (path, pat)
 
1009
 
 
1010
 
 
1011
class cmd_lookup_revision(Command):
 
1012
    """Lookup the revision-id from a revision-number
 
1013
 
 
1014
    example:
 
1015
        bzr lookup-revision 33
 
1016
    """
 
1017
    hidden = True
 
1018
    takes_args = ['revno']
 
1019
    
 
1020
    def run(self, revno):
 
1021
        try:
 
1022
            revno = int(revno)
 
1023
        except ValueError:
 
1024
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1025
 
 
1026
        print Branch('.').lookup_revision(revno)
 
1027
 
 
1028
 
 
1029
class cmd_export(Command):
 
1030
    """Export past revision to destination directory.
 
1031
 
 
1032
    If no revision is specified this exports the last committed revision.
 
1033
 
 
1034
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1035
    given, exports to a directory (equivalent to --format=dir)."""
 
1036
    # TODO: list known exporters
 
1037
    takes_args = ['dest']
 
1038
    takes_options = ['revision', 'format']
 
1039
    def run(self, dest, revision=None, format='dir'):
 
1040
        b = Branch('.')
 
1041
        if revision == None:
 
1042
            rh = b.revision_history()[-1]
 
1043
        else:
 
1044
            rh = b.lookup_revision(int(revision))
 
1045
        t = b.revision_tree(rh)
 
1046
        t.export(dest, format)
 
1047
 
 
1048
 
 
1049
class cmd_cat(Command):
 
1050
    """Write a file's text from a previous revision."""
 
1051
 
 
1052
    takes_options = ['revision']
 
1053
    takes_args = ['filename']
 
1054
 
 
1055
    def run(self, filename, revision=None):
 
1056
        if revision == None:
 
1057
            raise BzrCommandError("bzr cat requires a revision number")
 
1058
        b = Branch('.')
 
1059
        b.print_file(b.relpath(filename), int(revision))
 
1060
 
 
1061
 
 
1062
class cmd_local_time_offset(Command):
 
1063
    """Show the offset in seconds from GMT to local time."""
 
1064
    hidden = True    
 
1065
    def run(self):
 
1066
        print bzrlib.osutils.local_time_offset()
 
1067
 
 
1068
 
 
1069
 
 
1070
class cmd_commit(Command):
 
1071
    """Commit changes into a new revision.
 
1072
 
 
1073
    If selected files are specified, only changes to those files are
 
1074
    committed.  If a directory is specified then its contents are also
 
1075
    committed.
 
1076
 
 
1077
    A selected-file commit may fail in some cases where the committed
 
1078
    tree would be invalid, such as trying to commit a file in a
 
1079
    newly-added directory that is not itself committed.
 
1080
 
 
1081
    TODO: Run hooks on tree to-be-committed, and after commit.
 
1082
 
 
1083
    TODO: Strict commit that fails if there are unknown or deleted files.
 
1084
    """
 
1085
    takes_args = ['selected*']
 
1086
    takes_options = ['message', 'file', 'verbose']
 
1087
    aliases = ['ci', 'checkin']
 
1088
 
 
1089
    def run(self, message=None, file=None, verbose=True, selected_list=None):
 
1090
        from bzrlib.commit import commit
 
1091
 
 
1092
        ## Warning: shadows builtin file()
 
1093
        if not message and not file:
 
1094
            raise BzrCommandError("please specify a commit message",
 
1095
                                  ["use either --message or --file"])
 
1096
        elif message and file:
 
1097
            raise BzrCommandError("please specify either --message or --file")
 
1098
        
 
1099
        if file:
 
1100
            import codecs
 
1101
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1102
 
 
1103
        b = Branch('.')
 
1104
        commit(b, message, verbose=verbose, specific_files=selected_list)
 
1105
 
 
1106
 
 
1107
class cmd_check(Command):
 
1108
    """Validate consistency of branch history.
 
1109
 
 
1110
    This command checks various invariants about the branch storage to
 
1111
    detect data corruption or bzr bugs.
 
1112
 
 
1113
    If given the --update flag, it will update some optional fields
 
1114
    to help ensure data consistency.
 
1115
    """
 
1116
    takes_args = ['dir?']
 
1117
    takes_options = ['update']
 
1118
 
 
1119
    def run(self, dir='.', update=False):
 
1120
        import bzrlib.check
 
1121
        bzrlib.check.check(Branch(dir), update=update)
 
1122
 
 
1123
 
 
1124
 
 
1125
class cmd_whoami(Command):
 
1126
    """Show bzr user id."""
 
1127
    takes_options = ['email']
 
1128
    
 
1129
    def run(self, email=False):
 
1130
        if email:
 
1131
            print bzrlib.osutils.user_email()
 
1132
        else:
 
1133
            print bzrlib.osutils.username()
 
1134
 
 
1135
 
 
1136
class cmd_selftest(Command):
 
1137
    """Run internal test suite"""
 
1138
    hidden = True
 
1139
    def run(self):
 
1140
        from bzrlib.selftest import selftest
 
1141
        if selftest():
 
1142
            return 0
 
1143
        else:
 
1144
            return 1
 
1145
 
 
1146
 
 
1147
 
 
1148
class cmd_version(Command):
 
1149
    """Show version of bzr."""
 
1150
    def run(self):
 
1151
        show_version()
 
1152
 
 
1153
def show_version():
 
1154
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1155
    # is bzrlib itself in a branch?
 
1156
    bzrrev = bzrlib.get_bzr_revision()
 
1157
    if bzrrev:
 
1158
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
1159
    print bzrlib.__copyright__
 
1160
    print "http://bazaar-ng.org/"
 
1161
    print
 
1162
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1163
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1164
    print "General Public License version 2 or later."
 
1165
 
 
1166
 
 
1167
class cmd_rocks(Command):
 
1168
    """Statement of optimism."""
 
1169
    hidden = True
 
1170
    def run(self):
 
1171
        print "it sure does!"
 
1172
 
 
1173
def parse_spec(spec):
 
1174
    """
 
1175
    >>> parse_spec(None)
 
1176
    [None, None]
 
1177
    >>> parse_spec("./")
 
1178
    ['./', None]
 
1179
    >>> parse_spec("../@")
 
1180
    ['..', -1]
 
1181
    >>> parse_spec("../f/@35")
 
1182
    ['../f', 35]
 
1183
    """
 
1184
    if spec is None:
 
1185
        return [None, None]
 
1186
    if '/@' in spec:
 
1187
        parsed = spec.split('/@')
 
1188
        assert len(parsed) == 2
 
1189
        if parsed[1] == "":
 
1190
            parsed[1] = -1
 
1191
        else:
 
1192
            parsed[1] = int(parsed[1])
 
1193
            assert parsed[1] >=0
 
1194
    else:
 
1195
        parsed = [spec, None]
 
1196
    return parsed
 
1197
 
 
1198
 
 
1199
 
 
1200
class cmd_merge(Command):
 
1201
    """Perform a three-way merge of trees.
 
1202
    
 
1203
    The SPEC parameters are working tree or revision specifiers.  Working trees
 
1204
    are specified using standard paths or urls.  No component of a directory
 
1205
    path may begin with '@'.
 
1206
    
 
1207
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
 
1208
 
 
1209
    Revisions are specified using a dirname/@revno pair, where dirname is the
 
1210
    branch directory and revno is the revision within that branch.  If no revno
 
1211
    is specified, the latest revision is used.
 
1212
 
 
1213
    Revision examples: './@127', 'foo/@', '../@1'
 
1214
 
 
1215
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
 
1216
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
 
1217
    as the BASE.
 
1218
 
 
1219
    merge refuses to run if there are any uncommitted changes, unless
 
1220
    --force is given.
 
1221
    """
 
1222
    takes_args = ['other_spec', 'base_spec?']
 
1223
    takes_options = ['force']
 
1224
 
 
1225
    def run(self, other_spec, base_spec=None, force=False):
 
1226
        from bzrlib.merge import merge
 
1227
        merge(parse_spec(other_spec), parse_spec(base_spec),
 
1228
              check_clean=(not force))
 
1229
 
 
1230
 
 
1231
class cmd_revert(Command):
 
1232
    """Reverse all changes since the last commit.
 
1233
 
 
1234
    Only versioned files are affected.
 
1235
 
 
1236
    TODO: Store backups of any files that will be reverted, so
 
1237
          that the revert can be undone.          
 
1238
    """
 
1239
    takes_options = ['revision']
 
1240
 
 
1241
    def run(self, revision=-1):
 
1242
        from bzrlib.merge import merge
 
1243
        merge(('.', revision), parse_spec('.'),
 
1244
              check_clean=False,
 
1245
              ignore_zero=True)
 
1246
 
 
1247
 
 
1248
class cmd_assert_fail(Command):
 
1249
    """Test reporting of assertion failures"""
 
1250
    hidden = True
 
1251
    def run(self):
 
1252
        assert False, "always fails"
 
1253
 
 
1254
 
 
1255
class cmd_help(Command):
 
1256
    """Show help on a command or other topic.
 
1257
 
 
1258
    For a list of all available commands, say 'bzr help commands'."""
 
1259
    takes_args = ['topic?']
 
1260
    aliases = ['?']
 
1261
    
 
1262
    def run(self, topic=None):
 
1263
        import help
 
1264
        help.help(topic)
 
1265
 
 
1266
 
 
1267
class cmd_update_stat_cache(Command):
 
1268
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
1269
 
 
1270
    For testing only."""
 
1271
    hidden = True
 
1272
    def run(self):
 
1273
        import statcache
 
1274
        b = Branch('.')
 
1275
        statcache.update_cache(b.base, b.read_working_inventory())
 
1276
 
 
1277
 
 
1278
 
 
1279
# list of all available options; the rhs can be either None for an
 
1280
# option that takes no argument, or a constructor function that checks
 
1281
# the type.
 
1282
OPTIONS = {
 
1283
    'all':                    None,
 
1284
    'diff-options':           str,
 
1285
    'help':                   None,
 
1286
    'file':                   unicode,
 
1287
    'force':                  None,
 
1288
    'format':                 unicode,
 
1289
    'forward':                None,
 
1290
    'message':                unicode,
 
1291
    'no-recurse':             None,
 
1292
    'profile':                None,
 
1293
    'revision':               _parse_revision_str,
 
1294
    'show-ids':               None,
 
1295
    'timezone':               str,
 
1296
    'verbose':                None,
 
1297
    'version':                None,
 
1298
    'email':                  None,
 
1299
    'update':                 None,
 
1300
    }
 
1301
 
 
1302
SHORT_OPTIONS = {
 
1303
    'F':                      'file', 
 
1304
    'h':                      'help',
 
1305
    'm':                      'message',
 
1306
    'r':                      'revision',
 
1307
    'v':                      'verbose',
 
1308
}
 
1309
 
 
1310
 
 
1311
def parse_args(argv):
 
1312
    """Parse command line.
 
1313
    
 
1314
    Arguments and options are parsed at this level before being passed
 
1315
    down to specific command handlers.  This routine knows, from a
 
1316
    lookup table, something about the available options, what optargs
 
1317
    they take, and which commands will accept them.
 
1318
 
 
1319
    >>> parse_args('--help'.split())
 
1320
    ([], {'help': True})
 
1321
    >>> parse_args('--version'.split())
 
1322
    ([], {'version': True})
 
1323
    >>> parse_args('status --all'.split())
 
1324
    (['status'], {'all': True})
 
1325
    >>> parse_args('commit --message=biter'.split())
 
1326
    (['commit'], {'message': u'biter'})
 
1327
    >>> parse_args('log -r 500'.split())
 
1328
    (['log'], {'revision': 500})
 
1329
    >>> parse_args('log -r500:600'.split())
 
1330
    (['log'], {'revision': [500, 600]})
 
1331
    >>> parse_args('log -vr500:600'.split())
 
1332
    (['log'], {'verbose': True, 'revision': [500, 600]})
 
1333
    >>> parse_args('log -rv500:600'.split()) #the r takes an argument
 
1334
    Traceback (most recent call last):
 
1335
    ...
 
1336
    ValueError: invalid literal for int(): v500
 
1337
    """
 
1338
    args = []
 
1339
    opts = {}
 
1340
 
 
1341
    # TODO: Maybe handle '--' to end options?
 
1342
 
 
1343
    while argv:
 
1344
        a = argv.pop(0)
 
1345
        if a[0] == '-':
 
1346
            # option names must not be unicode
 
1347
            a = str(a)
 
1348
            optarg = None
 
1349
            if a[1] == '-':
 
1350
                mutter("  got option %r" % a)
 
1351
                if '=' in a:
 
1352
                    optname, optarg = a[2:].split('=', 1)
 
1353
                else:
 
1354
                    optname = a[2:]
 
1355
                if optname not in OPTIONS:
 
1356
                    bailout('unknown long option %r' % a)
 
1357
            else:
 
1358
                shortopt = a[1:]
 
1359
                if shortopt in SHORT_OPTIONS:
 
1360
                    # Multi-character options must have a space to delimit
 
1361
                    # their value
 
1362
                    optname = SHORT_OPTIONS[shortopt]
 
1363
                else:
 
1364
                    # Single character short options, can be chained,
 
1365
                    # and have their value appended to their name
 
1366
                    shortopt = a[1:2]
 
1367
                    if shortopt not in SHORT_OPTIONS:
 
1368
                        # We didn't find the multi-character name, and we
 
1369
                        # didn't find the single char name
 
1370
                        bailout('unknown short option %r' % a)
 
1371
                    optname = SHORT_OPTIONS[shortopt]
 
1372
 
 
1373
                    if a[2:]:
 
1374
                        # There are extra things on this option
 
1375
                        # see if it is the value, or if it is another
 
1376
                        # short option
 
1377
                        optargfn = OPTIONS[optname]
 
1378
                        if optargfn is None:
 
1379
                            # This option does not take an argument, so the
 
1380
                            # next entry is another short option, pack it back
 
1381
                            # into the list
 
1382
                            argv.insert(0, '-' + a[2:])
 
1383
                        else:
 
1384
                            # This option takes an argument, so pack it
 
1385
                            # into the array
 
1386
                            optarg = a[2:]
 
1387
            
 
1388
            if optname in opts:
 
1389
                # XXX: Do we ever want to support this, e.g. for -r?
 
1390
                bailout('repeated option %r' % a)
 
1391
                
 
1392
            optargfn = OPTIONS[optname]
 
1393
            if optargfn:
 
1394
                if optarg == None:
 
1395
                    if not argv:
 
1396
                        bailout('option %r needs an argument' % a)
 
1397
                    else:
 
1398
                        optarg = argv.pop(0)
 
1399
                opts[optname] = optargfn(optarg)
 
1400
            else:
 
1401
                if optarg != None:
 
1402
                    bailout('option %r takes no argument' % optname)
 
1403
                opts[optname] = True
 
1404
        else:
 
1405
            args.append(a)
 
1406
 
 
1407
    return args, opts
 
1408
 
 
1409
 
 
1410
 
 
1411
 
 
1412
def _match_argform(cmd, takes_args, args):
 
1413
    argdict = {}
 
1414
 
 
1415
    # step through args and takes_args, allowing appropriate 0-many matches
 
1416
    for ap in takes_args:
 
1417
        argname = ap[:-1]
 
1418
        if ap[-1] == '?':
 
1419
            if args:
 
1420
                argdict[argname] = args.pop(0)
 
1421
        elif ap[-1] == '*': # all remaining arguments
 
1422
            if args:
 
1423
                argdict[argname + '_list'] = args[:]
 
1424
                args = []
 
1425
            else:
 
1426
                argdict[argname + '_list'] = None
 
1427
        elif ap[-1] == '+':
 
1428
            if not args:
 
1429
                raise BzrCommandError("command %r needs one or more %s"
 
1430
                        % (cmd, argname.upper()))
 
1431
            else:
 
1432
                argdict[argname + '_list'] = args[:]
 
1433
                args = []
 
1434
        elif ap[-1] == '$': # all but one
 
1435
            if len(args) < 2:
 
1436
                raise BzrCommandError("command %r needs one or more %s"
 
1437
                        % (cmd, argname.upper()))
 
1438
            argdict[argname + '_list'] = args[:-1]
 
1439
            args[:-1] = []                
 
1440
        else:
 
1441
            # just a plain arg
 
1442
            argname = ap
 
1443
            if not args:
 
1444
                raise BzrCommandError("command %r requires argument %s"
 
1445
                        % (cmd, argname.upper()))
 
1446
            else:
 
1447
                argdict[argname] = args.pop(0)
 
1448
            
 
1449
    if args:
 
1450
        raise BzrCommandError("extra argument to command %s: %s"
 
1451
                              % (cmd, args[0]))
 
1452
 
 
1453
    return argdict
 
1454
 
 
1455
 
 
1456
 
 
1457
def run_bzr(argv):
 
1458
    """Execute a command.
 
1459
 
 
1460
    This is similar to main(), but without all the trappings for
 
1461
    logging and error handling.  
 
1462
    """
 
1463
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1464
    
 
1465
    include_plugins=True
 
1466
    try:
 
1467
        args, opts = parse_args(argv[1:])
 
1468
        if 'help' in opts:
 
1469
            import help
 
1470
            if args:
 
1471
                help.help(args[0])
 
1472
            else:
 
1473
                help.help()
 
1474
            return 0
 
1475
        elif 'version' in opts:
 
1476
            show_version()
 
1477
            return 0
 
1478
        elif args and args[0] == 'builtin':
 
1479
            include_plugins=False
 
1480
            args = args[1:]
 
1481
        cmd = str(args.pop(0))
 
1482
    except IndexError:
 
1483
        import help
 
1484
        help.help()
 
1485
        return 1
 
1486
          
 
1487
 
 
1488
    canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
 
1489
 
 
1490
    # global option
 
1491
    if 'profile' in opts:
 
1492
        profile = True
 
1493
        del opts['profile']
 
1494
    else:
 
1495
        profile = False
 
1496
 
 
1497
    # check options are reasonable
 
1498
    allowed = cmd_class.takes_options
 
1499
    for oname in opts:
 
1500
        if oname not in allowed:
 
1501
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1502
                                  % (oname, cmd))
 
1503
 
 
1504
    # mix arguments and options into one dictionary
 
1505
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1506
    cmdopts = {}
 
1507
    for k, v in opts.items():
 
1508
        cmdopts[k.replace('-', '_')] = v
 
1509
 
 
1510
    if profile:
 
1511
        import hotshot, tempfile
 
1512
        pffileno, pfname = tempfile.mkstemp()
 
1513
        try:
 
1514
            prof = hotshot.Profile(pfname)
 
1515
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1516
            prof.close()
 
1517
 
 
1518
            import hotshot.stats
 
1519
            stats = hotshot.stats.load(pfname)
 
1520
            #stats.strip_dirs()
 
1521
            stats.sort_stats('time')
 
1522
            ## XXX: Might like to write to stderr or the trace file instead but
 
1523
            ## print_stats seems hardcoded to stdout
 
1524
            stats.print_stats(20)
 
1525
            
 
1526
            return ret.status
 
1527
 
 
1528
        finally:
 
1529
            os.close(pffileno)
 
1530
            os.remove(pfname)
 
1531
    else:
 
1532
        return cmd_class(cmdopts, cmdargs).status 
 
1533
 
 
1534
 
 
1535
def _report_exception(summary, quiet=False):
 
1536
    import traceback
 
1537
    log_error('bzr: ' + summary)
 
1538
    bzrlib.trace.log_exception()
 
1539
 
 
1540
    if not quiet:
 
1541
        tb = sys.exc_info()[2]
 
1542
        exinfo = traceback.extract_tb(tb)
 
1543
        if exinfo:
 
1544
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1545
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1546
 
 
1547
 
 
1548
 
 
1549
def main(argv):
 
1550
    import errno
 
1551
    
 
1552
    bzrlib.open_tracefile(argv)
 
1553
 
 
1554
    try:
 
1555
        try:
 
1556
            try:
 
1557
                return run_bzr(argv)
 
1558
            finally:
 
1559
                # do this here inside the exception wrappers to catch EPIPE
 
1560
                sys.stdout.flush()
 
1561
        except BzrError, e:
 
1562
            quiet = isinstance(e, (BzrCommandError))
 
1563
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1564
            if len(e.args) > 1:
 
1565
                for h in e.args[1]:
 
1566
                    # some explanation or hints
 
1567
                    log_error('  ' + h)
 
1568
            return 1
 
1569
        except AssertionError, e:
 
1570
            msg = 'assertion failed'
 
1571
            if str(e):
 
1572
                msg += ': ' + str(e)
 
1573
            _report_exception(msg)
 
1574
            return 2
 
1575
        except KeyboardInterrupt, e:
 
1576
            _report_exception('interrupted', quiet=True)
 
1577
            return 2
 
1578
        except Exception, e:
 
1579
            quiet = False
 
1580
            if (isinstance(e, IOError) 
 
1581
                and hasattr(e, 'errno')
 
1582
                and e.errno == errno.EPIPE):
 
1583
                quiet = True
 
1584
                msg = 'broken pipe'
 
1585
            else:
 
1586
                msg = str(e).rstrip('\n')
 
1587
            _report_exception(msg, quiet)
 
1588
            return 2
 
1589
    finally:
 
1590
        bzrlib.trace.close_trace()
 
1591
 
 
1592
 
 
1593
if __name__ == '__main__':
 
1594
    sys.exit(main(sys.argv))