/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-14 23:04:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050614230451-78d47ed6932b5405
- don't doctest modules which don't have tests

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
 
521
    FROM_LOCATION will be used.  In other words,
 
522
    "branch ../foo/bar" will attempt to create ./bar.
 
523
    """
 
524
    takes_args = ['from_location', 'to_location?']
 
525
 
 
526
    def run(self, from_location, to_location=None):
 
527
        import errno
 
528
        from bzrlib.merge import merge
 
529
        from branch import find_branch, DivergedBranches
 
530
        try:
 
531
            br_from = find_branch(from_location)
 
532
        except OSError, e:
 
533
            if e.errno == errno.ENOENT:
 
534
                raise BzrCommandError('Source location "%s" does not exist.' %
 
535
                                      to_location)
 
536
            else:
 
537
                raise
 
538
 
 
539
        if to_location is None:
 
540
            to_location = os.path.basename(from_location)
 
541
            # FIXME: If there's a trailing slash, keep removing them
 
542
            # until we find the right bit
 
543
 
 
544
        try:
 
545
            os.mkdir(to_location)
 
546
        except OSError, e:
 
547
            if e.errno == errno.EEXIST:
 
548
                raise BzrCommandError('Target directory "%s" already exists.' %
 
549
                                      to_location)
 
550
            if e.errno == errno.ENOENT:
 
551
                raise BzrCommandError('Parent of "%s" does not exist.' %
 
552
                                      to_location)
 
553
            else:
 
554
                raise
 
555
        br_to = Branch(to_location, init=True)
 
556
 
 
557
        from_location = pull_loc(br_from)
 
558
        br_to.update_revisions(br_from)
 
559
        merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
560
              check_clean=False)
 
561
        br_to.controlfile("x-pull", "wb").write(from_location + "\n")
 
562
 
 
563
 
 
564
def pull_loc(branch):
 
565
    # TODO: Should perhaps just make attribute be 'base' in
 
566
    # RemoteBranch and Branch?
 
567
    if hasattr(branch, "baseurl"):
 
568
        return branch.baseurl
 
569
    else:
 
570
        return branch.base
 
571
 
 
572
 
 
573
 
 
574
class cmd_renames(Command):
 
575
    """Show list of renamed files.
 
576
 
 
577
    TODO: Option to show renames between two historical versions.
 
578
 
 
579
    TODO: Only show renames under dir, rather than in the whole branch.
 
580
    """
 
581
    takes_args = ['dir?']
 
582
 
 
583
    def run(self, dir='.'):
 
584
        b = Branch(dir)
 
585
        old_inv = b.basis_tree().inventory
 
586
        new_inv = b.read_working_inventory()
 
587
 
 
588
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
589
        renames.sort()
 
590
        for old_name, new_name in renames:
 
591
            print "%s => %s" % (old_name, new_name)        
 
592
 
 
593
 
 
594
class cmd_info(Command):
 
595
    """Show statistical information about a branch."""
 
596
    takes_args = ['branch?']
 
597
    
 
598
    def run(self, branch=None):
 
599
        import info
 
600
 
 
601
        from branch import find_branch
 
602
        b = find_branch(branch)
 
603
        info.show_info(b)
 
604
 
 
605
 
 
606
class cmd_remove(Command):
 
607
    """Make a file unversioned.
 
608
 
 
609
    This makes bzr stop tracking changes to a versioned file.  It does
 
610
    not delete the working copy.
 
611
    """
 
612
    takes_args = ['file+']
 
613
    takes_options = ['verbose']
 
614
    
 
615
    def run(self, file_list, verbose=False):
 
616
        b = Branch(file_list[0])
 
617
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
618
 
 
619
 
 
620
class cmd_file_id(Command):
 
621
    """Print file_id of a particular file or directory.
 
622
 
 
623
    The file_id is assigned when the file is first added and remains the
 
624
    same through all revisions where the file exists, even when it is
 
625
    moved or renamed.
 
626
    """
 
627
    hidden = True
 
628
    takes_args = ['filename']
 
629
    def run(self, filename):
 
630
        b = Branch(filename)
 
631
        i = b.inventory.path2id(b.relpath(filename))
 
632
        if i == None:
 
633
            bailout("%r is not a versioned file" % filename)
 
634
        else:
 
635
            print i
 
636
 
 
637
 
 
638
class cmd_file_path(Command):
 
639
    """Print path of file_ids to a file or directory.
 
640
 
 
641
    This prints one line for each directory down to the target,
 
642
    starting at the branch root."""
 
643
    hidden = True
 
644
    takes_args = ['filename']
 
645
    def run(self, filename):
 
646
        b = Branch(filename)
 
647
        inv = b.inventory
 
648
        fid = inv.path2id(b.relpath(filename))
 
649
        if fid == None:
 
650
            bailout("%r is not a versioned file" % filename)
 
651
        for fip in inv.get_idpath(fid):
 
652
            print fip
 
653
 
 
654
 
 
655
class cmd_revision_history(Command):
 
656
    """Display list of revision ids on this branch."""
 
657
    hidden = True
 
658
    def run(self):
 
659
        for patchid in Branch('.').revision_history():
 
660
            print patchid
 
661
 
 
662
 
 
663
class cmd_directories(Command):
 
664
    """Display list of versioned directories in this branch."""
 
665
    def run(self):
 
666
        for name, ie in Branch('.').read_working_inventory().directories():
 
667
            if name == '':
 
668
                print '.'
 
669
            else:
 
670
                print name
 
671
 
 
672
 
 
673
class cmd_init(Command):
 
674
    """Make a directory into a versioned branch.
 
675
 
 
676
    Use this to create an empty branch, or before importing an
 
677
    existing project.
 
678
 
 
679
    Recipe for importing a tree of files:
 
680
        cd ~/project
 
681
        bzr init
 
682
        bzr add -v .
 
683
        bzr status
 
684
        bzr commit -m 'imported project'
 
685
    """
 
686
    def run(self):
 
687
        Branch('.', init=True)
 
688
 
 
689
 
 
690
class cmd_diff(Command):
 
691
    """Show differences in working tree.
 
692
    
 
693
    If files are listed, only the changes in those files are listed.
 
694
    Otherwise, all changes for the tree are listed.
 
695
 
 
696
    TODO: Given two revision arguments, show the difference between them.
 
697
 
 
698
    TODO: Allow diff across branches.
 
699
 
 
700
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
701
          or a graphical diff.
 
702
 
 
703
    TODO: Python difflib is not exactly the same as unidiff; should
 
704
          either fix it up or prefer to use an external diff.
 
705
 
 
706
    TODO: If a directory is given, diff everything under that.
 
707
 
 
708
    TODO: Selected-file diff is inefficient and doesn't show you
 
709
          deleted files.
 
710
 
 
711
    TODO: This probably handles non-Unix newlines poorly.
 
712
    """
 
713
    
 
714
    takes_args = ['file*']
 
715
    takes_options = ['revision', 'diff-options']
 
716
    aliases = ['di', 'dif']
 
717
 
 
718
    def run(self, revision=None, file_list=None, diff_options=None):
 
719
        from bzrlib.diff import show_diff
 
720
        from bzrlib import find_branch
 
721
 
 
722
        if file_list:
 
723
            b = find_branch(file_list[0])
 
724
            file_list = [b.relpath(f) for f in file_list]
 
725
            if file_list == ['']:
 
726
                # just pointing to top-of-tree
 
727
                file_list = None
 
728
        else:
 
729
            b = Branch('.')
 
730
    
 
731
        show_diff(b, revision, specific_files=file_list,
 
732
                  external_diff_options=diff_options)
 
733
 
 
734
 
 
735
        
 
736
 
 
737
 
 
738
class cmd_deleted(Command):
 
739
    """List files deleted in the working tree.
 
740
 
 
741
    TODO: Show files deleted since a previous revision, or between two revisions.
 
742
    """
 
743
    def run(self, show_ids=False):
 
744
        b = Branch('.')
 
745
        old = b.basis_tree()
 
746
        new = b.working_tree()
 
747
 
 
748
        ## TODO: Much more efficient way to do this: read in new
 
749
        ## directories with readdir, rather than stating each one.  Same
 
750
        ## level of effort but possibly much less IO.  (Or possibly not,
 
751
        ## if the directories are very large...)
 
752
 
 
753
        for path, ie in old.inventory.iter_entries():
 
754
            if not new.has_id(ie.file_id):
 
755
                if show_ids:
 
756
                    print '%-50s %s' % (path, ie.file_id)
 
757
                else:
 
758
                    print path
 
759
 
 
760
 
 
761
class cmd_modified(Command):
 
762
    """List files modified in working tree."""
 
763
    hidden = True
 
764
    def run(self):
 
765
        import statcache
 
766
        b = Branch('.')
 
767
        inv = b.read_working_inventory()
 
768
        sc = statcache.update_cache(b, inv)
 
769
        basis = b.basis_tree()
 
770
        basis_inv = basis.inventory
 
771
        
 
772
        # We used to do this through iter_entries(), but that's slow
 
773
        # when most of the files are unmodified, as is usually the
 
774
        # case.  So instead we iterate by inventory entry, and only
 
775
        # calculate paths as necessary.
 
776
 
 
777
        for file_id in basis_inv:
 
778
            cacheentry = sc.get(file_id)
 
779
            if not cacheentry:                 # deleted
 
780
                continue
 
781
            ie = basis_inv[file_id]
 
782
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
783
                path = inv.id2path(file_id)
 
784
                print path
 
785
 
 
786
 
 
787
 
 
788
class cmd_added(Command):
 
789
    """List files added in working tree."""
 
790
    hidden = True
 
791
    def run(self):
 
792
        b = Branch('.')
 
793
        wt = b.working_tree()
 
794
        basis_inv = b.basis_tree().inventory
 
795
        inv = wt.inventory
 
796
        for file_id in inv:
 
797
            if file_id in basis_inv:
 
798
                continue
 
799
            path = inv.id2path(file_id)
 
800
            if not os.access(b.abspath(path), os.F_OK):
 
801
                continue
 
802
            print path
 
803
                
 
804
        
 
805
 
 
806
class cmd_root(Command):
 
807
    """Show the tree root directory.
 
808
 
 
809
    The root is the nearest enclosing directory with a .bzr control
 
810
    directory."""
 
811
    takes_args = ['filename?']
 
812
    def run(self, filename=None):
 
813
        """Print the branch root."""
 
814
        from branch import find_branch
 
815
        b = find_branch(filename)
 
816
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
817
 
 
818
 
 
819
class cmd_log(Command):
 
820
    """Show log of this branch.
 
821
 
 
822
    To request a range of logs, you can use the command -r begin:end
 
823
    -r revision requests a specific revision, -r :end or -r begin: are
 
824
    also valid.
 
825
 
 
826
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
827
  
 
828
    """
 
829
 
 
830
    takes_args = ['filename?']
 
831
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
 
832
    
 
833
    def run(self, filename=None, timezone='original',
 
834
            verbose=False,
 
835
            show_ids=False,
 
836
            forward=False,
 
837
            revision=None):
 
838
        from bzrlib import show_log, find_branch
 
839
        import codecs
 
840
 
 
841
        direction = (forward and 'forward') or 'reverse'
 
842
        
 
843
        if filename:
 
844
            b = find_branch(filename)
 
845
            fp = b.relpath(filename)
 
846
            if fp:
 
847
                file_id = b.read_working_inventory().path2id(fp)
 
848
            else:
 
849
                file_id = None  # points to branch root
 
850
        else:
 
851
            b = find_branch('.')
 
852
            file_id = None
 
853
 
 
854
        if revision == None:
 
855
            revision = [None, None]
 
856
        elif isinstance(revision, int):
 
857
            revision = [revision, revision]
 
858
        else:
 
859
            # pair of revisions?
 
860
            pass
 
861
            
 
862
        assert len(revision) == 2
 
863
 
 
864
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
865
 
 
866
        # use 'replace' so that we don't abort if trying to write out
 
867
        # in e.g. the default C locale.
 
868
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
869
 
 
870
        show_log(b, file_id,
 
871
                 show_timezone=timezone,
 
872
                 verbose=verbose,
 
873
                 show_ids=show_ids,
 
874
                 to_file=outf,
 
875
                 direction=direction,
 
876
                 start_revision=revision[0],
 
877
                 end_revision=revision[1])
 
878
 
 
879
 
 
880
 
 
881
class cmd_touching_revisions(Command):
 
882
    """Return revision-ids which affected a particular file.
 
883
 
 
884
    A more user-friendly interface is "bzr log FILE"."""
 
885
    hidden = True
 
886
    takes_args = ["filename"]
 
887
    def run(self, filename):
 
888
        b = Branch(filename)
 
889
        inv = b.read_working_inventory()
 
890
        file_id = inv.path2id(b.relpath(filename))
 
891
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
892
            print "%6d %s" % (revno, what)
 
893
 
 
894
 
 
895
class cmd_ls(Command):
 
896
    """List files in a tree.
 
897
 
 
898
    TODO: Take a revision or remote path and list that tree instead.
 
899
    """
 
900
    hidden = True
 
901
    def run(self, revision=None, verbose=False):
 
902
        b = Branch('.')
 
903
        if revision == None:
 
904
            tree = b.working_tree()
 
905
        else:
 
906
            tree = b.revision_tree(b.lookup_revision(revision))
 
907
 
 
908
        for fp, fc, kind, fid in tree.list_files():
 
909
            if verbose:
 
910
                if kind == 'directory':
 
911
                    kindch = '/'
 
912
                elif kind == 'file':
 
913
                    kindch = ''
 
914
                else:
 
915
                    kindch = '???'
 
916
 
 
917
                print '%-8s %s%s' % (fc, fp, kindch)
 
918
            else:
 
919
                print fp
 
920
 
 
921
 
 
922
 
 
923
class cmd_unknowns(Command):
 
924
    """List unknown files."""
 
925
    def run(self):
 
926
        for f in Branch('.').unknowns():
 
927
            print quotefn(f)
 
928
 
 
929
 
 
930
 
 
931
class cmd_ignore(Command):
 
932
    """Ignore a command or pattern.
 
933
 
 
934
    To remove patterns from the ignore list, edit the .bzrignore file.
 
935
 
 
936
    If the pattern contains a slash, it is compared to the whole path
 
937
    from the branch root.  Otherwise, it is comapred to only the last
 
938
    component of the path.
 
939
 
 
940
    Ignore patterns are case-insensitive on case-insensitive systems.
 
941
 
 
942
    Note: wildcards must be quoted from the shell on Unix.
 
943
 
 
944
    examples:
 
945
        bzr ignore ./Makefile
 
946
        bzr ignore '*.class'
 
947
    """
 
948
    takes_args = ['name_pattern']
 
949
    
 
950
    def run(self, name_pattern):
 
951
        from bzrlib.atomicfile import AtomicFile
 
952
        import os.path
 
953
 
 
954
        b = Branch('.')
 
955
        ifn = b.abspath('.bzrignore')
 
956
 
 
957
        if os.path.exists(ifn):
 
958
            f = open(ifn, 'rt')
 
959
            try:
 
960
                igns = f.read().decode('utf-8')
 
961
            finally:
 
962
                f.close()
 
963
        else:
 
964
            igns = ''
 
965
 
 
966
        # TODO: If the file already uses crlf-style termination, maybe
 
967
        # we should use that for the newly added lines?
 
968
 
 
969
        if igns and igns[-1] != '\n':
 
970
            igns += '\n'
 
971
        igns += name_pattern + '\n'
 
972
 
 
973
        try:
 
974
            f = AtomicFile(ifn, 'wt')
 
975
            f.write(igns.encode('utf-8'))
 
976
            f.commit()
 
977
        finally:
 
978
            f.close()
 
979
 
 
980
        inv = b.working_tree().inventory
 
981
        if inv.path2id('.bzrignore'):
 
982
            mutter('.bzrignore is already versioned')
 
983
        else:
 
984
            mutter('need to make new .bzrignore file versioned')
 
985
            b.add(['.bzrignore'])
 
986
 
 
987
 
 
988
 
 
989
class cmd_ignored(Command):
 
990
    """List ignored files and the patterns that matched them.
 
991
 
 
992
    See also: bzr ignore"""
 
993
    def run(self):
 
994
        tree = Branch('.').working_tree()
 
995
        for path, file_class, kind, file_id in tree.list_files():
 
996
            if file_class != 'I':
 
997
                continue
 
998
            ## XXX: Slightly inefficient since this was already calculated
 
999
            pat = tree.is_ignored(path)
 
1000
            print '%-50s %s' % (path, pat)
 
1001
 
 
1002
 
 
1003
class cmd_lookup_revision(Command):
 
1004
    """Lookup the revision-id from a revision-number
 
1005
 
 
1006
    example:
 
1007
        bzr lookup-revision 33
 
1008
    """
 
1009
    hidden = True
 
1010
    takes_args = ['revno']
 
1011
    
 
1012
    def run(self, revno):
 
1013
        try:
 
1014
            revno = int(revno)
 
1015
        except ValueError:
 
1016
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1017
 
 
1018
        print Branch('.').lookup_revision(revno)
 
1019
 
 
1020
 
 
1021
class cmd_export(Command):
 
1022
    """Export past revision to destination directory.
 
1023
 
 
1024
    If no revision is specified this exports the last committed revision.
 
1025
 
 
1026
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1027
    given, exports to a directory (equivalent to --format=dir)."""
 
1028
    # TODO: list known exporters
 
1029
    takes_args = ['dest']
 
1030
    takes_options = ['revision', 'format']
 
1031
    def run(self, dest, revision=None, format='dir'):
 
1032
        b = Branch('.')
 
1033
        if revision == None:
 
1034
            rh = b.revision_history()[-1]
 
1035
        else:
 
1036
            rh = b.lookup_revision(int(revision))
 
1037
        t = b.revision_tree(rh)
 
1038
        t.export(dest, format)
 
1039
 
 
1040
 
 
1041
class cmd_cat(Command):
 
1042
    """Write a file's text from a previous revision."""
 
1043
 
 
1044
    takes_options = ['revision']
 
1045
    takes_args = ['filename']
 
1046
 
 
1047
    def run(self, filename, revision=None):
 
1048
        if revision == None:
 
1049
            raise BzrCommandError("bzr cat requires a revision number")
 
1050
        b = Branch('.')
 
1051
        b.print_file(b.relpath(filename), int(revision))
 
1052
 
 
1053
 
 
1054
class cmd_local_time_offset(Command):
 
1055
    """Show the offset in seconds from GMT to local time."""
 
1056
    hidden = True    
 
1057
    def run(self):
 
1058
        print bzrlib.osutils.local_time_offset()
 
1059
 
 
1060
 
 
1061
 
 
1062
class cmd_commit(Command):
 
1063
    """Commit changes into a new revision.
 
1064
 
 
1065
    If selected files are specified, only changes to those files are
 
1066
    committed.  If a directory is specified then its contents are also
 
1067
    committed.
 
1068
 
 
1069
    A selected-file commit may fail in some cases where the committed
 
1070
    tree would be invalid, such as trying to commit a file in a
 
1071
    newly-added directory that is not itself committed.
 
1072
 
 
1073
    TODO: Run hooks on tree to-be-committed, and after commit.
 
1074
 
 
1075
    TODO: Strict commit that fails if there are unknown or deleted files.
 
1076
    """
 
1077
    takes_args = ['selected*']
 
1078
    takes_options = ['message', 'file', 'verbose']
 
1079
    aliases = ['ci', 'checkin']
 
1080
 
 
1081
    def run(self, message=None, file=None, verbose=True, selected_list=None):
 
1082
        from bzrlib.commit import commit
 
1083
 
 
1084
        ## Warning: shadows builtin file()
 
1085
        if not message and not file:
 
1086
            raise BzrCommandError("please specify a commit message",
 
1087
                                  ["use either --message or --file"])
 
1088
        elif message and file:
 
1089
            raise BzrCommandError("please specify either --message or --file")
 
1090
        
 
1091
        if file:
 
1092
            import codecs
 
1093
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1094
 
 
1095
        b = Branch('.')
 
1096
        commit(b, message, verbose=verbose, specific_files=selected_list)
 
1097
 
 
1098
 
 
1099
class cmd_check(Command):
 
1100
    """Validate consistency of branch history.
 
1101
 
 
1102
    This command checks various invariants about the branch storage to
 
1103
    detect data corruption or bzr bugs.
 
1104
 
 
1105
    If given the --update flag, it will update some optional fields
 
1106
    to help ensure data consistency.
 
1107
    """
 
1108
    takes_args = ['dir?']
 
1109
    takes_options = ['update']
 
1110
 
 
1111
    def run(self, dir='.', update=False):
 
1112
        import bzrlib.check
 
1113
        bzrlib.check.check(Branch(dir), update=update)
 
1114
 
 
1115
 
 
1116
 
 
1117
class cmd_whoami(Command):
 
1118
    """Show bzr user id."""
 
1119
    takes_options = ['email']
 
1120
    
 
1121
    def run(self, email=False):
 
1122
        if email:
 
1123
            print bzrlib.osutils.user_email()
 
1124
        else:
 
1125
            print bzrlib.osutils.username()
 
1126
 
 
1127
 
 
1128
class cmd_selftest(Command):
 
1129
    """Run internal test suite"""
 
1130
    hidden = True
 
1131
    def run(self):
 
1132
        from bzrlib.selftest import selftest
 
1133
        if selftest():
 
1134
            return 0
 
1135
        else:
 
1136
            return 1
 
1137
 
 
1138
 
 
1139
 
 
1140
class cmd_version(Command):
 
1141
    """Show version of bzr."""
 
1142
    def run(self):
 
1143
        show_version()
 
1144
 
 
1145
def show_version():
 
1146
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1147
    # is bzrlib itself in a branch?
 
1148
    bzrrev = bzrlib.get_bzr_revision()
 
1149
    if bzrrev:
 
1150
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
1151
    print bzrlib.__copyright__
 
1152
    print "http://bazaar-ng.org/"
 
1153
    print
 
1154
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1155
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1156
    print "General Public License version 2 or later."
 
1157
 
 
1158
 
 
1159
class cmd_rocks(Command):
 
1160
    """Statement of optimism."""
 
1161
    hidden = True
 
1162
    def run(self):
 
1163
        print "it sure does!"
 
1164
 
 
1165
def parse_spec(spec):
 
1166
    """
 
1167
    >>> parse_spec(None)
 
1168
    [None, None]
 
1169
    >>> parse_spec("./")
 
1170
    ['./', None]
 
1171
    >>> parse_spec("../@")
 
1172
    ['..', -1]
 
1173
    >>> parse_spec("../f/@35")
 
1174
    ['../f', 35]
 
1175
    """
 
1176
    if spec is None:
 
1177
        return [None, None]
 
1178
    if '/@' in spec:
 
1179
        parsed = spec.split('/@')
 
1180
        assert len(parsed) == 2
 
1181
        if parsed[1] == "":
 
1182
            parsed[1] = -1
 
1183
        else:
 
1184
            parsed[1] = int(parsed[1])
 
1185
            assert parsed[1] >=0
 
1186
    else:
 
1187
        parsed = [spec, None]
 
1188
    return parsed
 
1189
 
 
1190
 
 
1191
 
 
1192
class cmd_merge(Command):
 
1193
    """Perform a three-way merge of trees.
 
1194
    
 
1195
    The SPEC parameters are working tree or revision specifiers.  Working trees
 
1196
    are specified using standard paths or urls.  No component of a directory
 
1197
    path may begin with '@'.
 
1198
    
 
1199
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
 
1200
 
 
1201
    Revisions are specified using a dirname/@revno pair, where dirname is the
 
1202
    branch directory and revno is the revision within that branch.  If no revno
 
1203
    is specified, the latest revision is used.
 
1204
 
 
1205
    Revision examples: './@127', 'foo/@', '../@1'
 
1206
 
 
1207
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
 
1208
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
 
1209
    as the BASE.
 
1210
 
 
1211
    merge refuses to run if there are any uncommitted changes, unless
 
1212
    --force is given.
 
1213
    """
 
1214
    takes_args = ['other_spec', 'base_spec?']
 
1215
    takes_options = ['force']
 
1216
 
 
1217
    def run(self, other_spec, base_spec=None, force=False):
 
1218
        from bzrlib.merge import merge
 
1219
        merge(parse_spec(other_spec), parse_spec(base_spec),
 
1220
              check_clean=(not force))
 
1221
 
 
1222
 
 
1223
class cmd_revert(Command):
 
1224
    """Reverse all changes since the last commit.
 
1225
 
 
1226
    Only versioned files are affected.
 
1227
 
 
1228
    TODO: Store backups of any files that will be reverted, so
 
1229
          that the revert can be undone.          
 
1230
    """
 
1231
    takes_options = ['revision']
 
1232
 
 
1233
    def run(self, revision=-1):
 
1234
        from bzrlib.merge import merge
 
1235
        merge(('.', revision), parse_spec('.'),
 
1236
              check_clean=False,
 
1237
              ignore_zero=True)
 
1238
 
 
1239
 
 
1240
class cmd_assert_fail(Command):
 
1241
    """Test reporting of assertion failures"""
 
1242
    hidden = True
 
1243
    def run(self):
 
1244
        assert False, "always fails"
 
1245
 
 
1246
 
 
1247
class cmd_help(Command):
 
1248
    """Show help on a command or other topic.
 
1249
 
 
1250
    For a list of all available commands, say 'bzr help commands'."""
 
1251
    takes_args = ['topic?']
 
1252
    aliases = ['?']
 
1253
    
 
1254
    def run(self, topic=None):
 
1255
        import help
 
1256
        help.help(topic)
 
1257
 
 
1258
 
 
1259
class cmd_update_stat_cache(Command):
 
1260
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
1261
 
 
1262
    For testing only."""
 
1263
    hidden = True
 
1264
    def run(self):
 
1265
        import statcache
 
1266
        b = Branch('.')
 
1267
        statcache.update_cache(b.base, b.read_working_inventory())
 
1268
 
 
1269
 
 
1270
 
 
1271
# list of all available options; the rhs can be either None for an
 
1272
# option that takes no argument, or a constructor function that checks
 
1273
# the type.
 
1274
OPTIONS = {
 
1275
    'all':                    None,
 
1276
    'diff-options':           str,
 
1277
    'help':                   None,
 
1278
    'file':                   unicode,
 
1279
    'force':                  None,
 
1280
    'format':                 unicode,
 
1281
    'forward':                None,
 
1282
    'message':                unicode,
 
1283
    'no-recurse':             None,
 
1284
    'profile':                None,
 
1285
    'revision':               _parse_revision_str,
 
1286
    'show-ids':               None,
 
1287
    'timezone':               str,
 
1288
    'verbose':                None,
 
1289
    'version':                None,
 
1290
    'email':                  None,
 
1291
    'update':                 None,
 
1292
    }
 
1293
 
 
1294
SHORT_OPTIONS = {
 
1295
    'F':                      'file', 
 
1296
    'h':                      'help',
 
1297
    'm':                      'message',
 
1298
    'r':                      'revision',
 
1299
    'v':                      'verbose',
 
1300
}
 
1301
 
 
1302
 
 
1303
def parse_args(argv):
 
1304
    """Parse command line.
 
1305
    
 
1306
    Arguments and options are parsed at this level before being passed
 
1307
    down to specific command handlers.  This routine knows, from a
 
1308
    lookup table, something about the available options, what optargs
 
1309
    they take, and which commands will accept them.
 
1310
 
 
1311
    >>> parse_args('--help'.split())
 
1312
    ([], {'help': True})
 
1313
    >>> parse_args('--version'.split())
 
1314
    ([], {'version': True})
 
1315
    >>> parse_args('status --all'.split())
 
1316
    (['status'], {'all': True})
 
1317
    >>> parse_args('commit --message=biter'.split())
 
1318
    (['commit'], {'message': u'biter'})
 
1319
    """
 
1320
    args = []
 
1321
    opts = {}
 
1322
 
 
1323
    # TODO: Maybe handle '--' to end options?
 
1324
 
 
1325
    while argv:
 
1326
        a = argv.pop(0)
 
1327
        if a[0] == '-':
 
1328
            # option names must not be unicode
 
1329
            a = str(a)
 
1330
            optarg = None
 
1331
            if a[1] == '-':
 
1332
                mutter("  got option %r" % a)
 
1333
                if '=' in a:
 
1334
                    optname, optarg = a[2:].split('=', 1)
 
1335
                else:
 
1336
                    optname = a[2:]
 
1337
                if optname not in OPTIONS:
 
1338
                    bailout('unknown long option %r' % a)
 
1339
            else:
 
1340
                shortopt = a[1:]
 
1341
                if shortopt not in SHORT_OPTIONS:
 
1342
                    bailout('unknown short option %r' % a)
 
1343
                optname = SHORT_OPTIONS[shortopt]
 
1344
            
 
1345
            if optname in opts:
 
1346
                # XXX: Do we ever want to support this, e.g. for -r?
 
1347
                bailout('repeated option %r' % a)
 
1348
                
 
1349
            optargfn = OPTIONS[optname]
 
1350
            if optargfn:
 
1351
                if optarg == None:
 
1352
                    if not argv:
 
1353
                        bailout('option %r needs an argument' % a)
 
1354
                    else:
 
1355
                        optarg = argv.pop(0)
 
1356
                opts[optname] = optargfn(optarg)
 
1357
            else:
 
1358
                if optarg != None:
 
1359
                    bailout('option %r takes no argument' % optname)
 
1360
                opts[optname] = True
 
1361
        else:
 
1362
            args.append(a)
 
1363
 
 
1364
    return args, opts
 
1365
 
 
1366
 
 
1367
 
 
1368
 
 
1369
def _match_argform(cmd, takes_args, args):
 
1370
    argdict = {}
 
1371
 
 
1372
    # step through args and takes_args, allowing appropriate 0-many matches
 
1373
    for ap in takes_args:
 
1374
        argname = ap[:-1]
 
1375
        if ap[-1] == '?':
 
1376
            if args:
 
1377
                argdict[argname] = args.pop(0)
 
1378
        elif ap[-1] == '*': # all remaining arguments
 
1379
            if args:
 
1380
                argdict[argname + '_list'] = args[:]
 
1381
                args = []
 
1382
            else:
 
1383
                argdict[argname + '_list'] = None
 
1384
        elif ap[-1] == '+':
 
1385
            if not args:
 
1386
                raise BzrCommandError("command %r needs one or more %s"
 
1387
                        % (cmd, argname.upper()))
 
1388
            else:
 
1389
                argdict[argname + '_list'] = args[:]
 
1390
                args = []
 
1391
        elif ap[-1] == '$': # all but one
 
1392
            if len(args) < 2:
 
1393
                raise BzrCommandError("command %r needs one or more %s"
 
1394
                        % (cmd, argname.upper()))
 
1395
            argdict[argname + '_list'] = args[:-1]
 
1396
            args[:-1] = []                
 
1397
        else:
 
1398
            # just a plain arg
 
1399
            argname = ap
 
1400
            if not args:
 
1401
                raise BzrCommandError("command %r requires argument %s"
 
1402
                        % (cmd, argname.upper()))
 
1403
            else:
 
1404
                argdict[argname] = args.pop(0)
 
1405
            
 
1406
    if args:
 
1407
        raise BzrCommandError("extra argument to command %s: %s"
 
1408
                              % (cmd, args[0]))
 
1409
 
 
1410
    return argdict
 
1411
 
 
1412
 
 
1413
 
 
1414
def run_bzr(argv):
 
1415
    """Execute a command.
 
1416
 
 
1417
    This is similar to main(), but without all the trappings for
 
1418
    logging and error handling.  
 
1419
    """
 
1420
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1421
    
 
1422
    include_plugins=True
 
1423
    try:
 
1424
        args, opts = parse_args(argv[1:])
 
1425
        if 'help' in opts:
 
1426
            import help
 
1427
            if args:
 
1428
                help.help(args[0])
 
1429
            else:
 
1430
                help.help()
 
1431
            return 0
 
1432
        elif 'version' in opts:
 
1433
            show_version()
 
1434
            return 0
 
1435
        elif args and args[0] == 'builtin':
 
1436
            include_plugins=False
 
1437
            args = args[1:]
 
1438
        cmd = str(args.pop(0))
 
1439
    except IndexError:
 
1440
        import help
 
1441
        help.help()
 
1442
        return 1
 
1443
          
 
1444
 
 
1445
    canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
 
1446
 
 
1447
    # global option
 
1448
    if 'profile' in opts:
 
1449
        profile = True
 
1450
        del opts['profile']
 
1451
    else:
 
1452
        profile = False
 
1453
 
 
1454
    # check options are reasonable
 
1455
    allowed = cmd_class.takes_options
 
1456
    for oname in opts:
 
1457
        if oname not in allowed:
 
1458
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1459
                                  % (oname, cmd))
 
1460
 
 
1461
    # mix arguments and options into one dictionary
 
1462
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1463
    cmdopts = {}
 
1464
    for k, v in opts.items():
 
1465
        cmdopts[k.replace('-', '_')] = v
 
1466
 
 
1467
    if profile:
 
1468
        import hotshot, tempfile
 
1469
        pffileno, pfname = tempfile.mkstemp()
 
1470
        try:
 
1471
            prof = hotshot.Profile(pfname)
 
1472
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1473
            prof.close()
 
1474
 
 
1475
            import hotshot.stats
 
1476
            stats = hotshot.stats.load(pfname)
 
1477
            #stats.strip_dirs()
 
1478
            stats.sort_stats('time')
 
1479
            ## XXX: Might like to write to stderr or the trace file instead but
 
1480
            ## print_stats seems hardcoded to stdout
 
1481
            stats.print_stats(20)
 
1482
            
 
1483
            return ret.status
 
1484
 
 
1485
        finally:
 
1486
            os.close(pffileno)
 
1487
            os.remove(pfname)
 
1488
    else:
 
1489
        return cmd_class(cmdopts, cmdargs).status 
 
1490
 
 
1491
 
 
1492
def _report_exception(summary, quiet=False):
 
1493
    import traceback
 
1494
    log_error('bzr: ' + summary)
 
1495
    bzrlib.trace.log_exception()
 
1496
 
 
1497
    if not quiet:
 
1498
        tb = sys.exc_info()[2]
 
1499
        exinfo = traceback.extract_tb(tb)
 
1500
        if exinfo:
 
1501
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1502
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1503
 
 
1504
 
 
1505
 
 
1506
def main(argv):
 
1507
    import errno
 
1508
    
 
1509
    bzrlib.open_tracefile(argv)
 
1510
 
 
1511
    try:
 
1512
        try:
 
1513
            try:
 
1514
                return run_bzr(argv)
 
1515
            finally:
 
1516
                # do this here inside the exception wrappers to catch EPIPE
 
1517
                sys.stdout.flush()
 
1518
        except BzrError, e:
 
1519
            quiet = isinstance(e, (BzrCommandError))
 
1520
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1521
            if len(e.args) > 1:
 
1522
                for h in e.args[1]:
 
1523
                    # some explanation or hints
 
1524
                    log_error('  ' + h)
 
1525
            return 1
 
1526
        except AssertionError, e:
 
1527
            msg = 'assertion failed'
 
1528
            if str(e):
 
1529
                msg += ': ' + str(e)
 
1530
            _report_exception(msg)
 
1531
            return 2
 
1532
        except KeyboardInterrupt, e:
 
1533
            _report_exception('interrupted', quiet=True)
 
1534
            return 2
 
1535
        except Exception, e:
 
1536
            quiet = False
 
1537
            if (isinstance(e, IOError) 
 
1538
                and hasattr(e, 'errno')
 
1539
                and e.errno == errno.EPIPE):
 
1540
                quiet = True
 
1541
                msg = 'broken pipe'
 
1542
            else:
 
1543
                msg = str(e).rstrip('\n')
 
1544
            _report_exception(msg, quiet)
 
1545
            return 2
 
1546
    finally:
 
1547
        bzrlib.trace.close_trace()
 
1548
 
 
1549
 
 
1550
if __name__ == '__main__':
 
1551
    sys.exit(main(sys.argv))