/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-28 03:02:31 UTC
  • Revision ID: mbp@sourcefrog.net-20050628030231-d311e4ebcd467ef4
Merge John's import-speedup branch:

                                                                                         
  777 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:20:32 -0500
      revision-id: john@arbash-meinel.com-20050627032031-e82a50db3863b18e
      bzr selftest was not using the correct bzr

  776 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:20:22 -0500
      revision-id: john@arbash-meinel.com-20050627032021-c9f21fde989ddaee
      Add was using an old mutter

  775 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:02:33 -0500
      revision-id: john@arbash-meinel.com-20050627030233-9165cfe98fc63298
      Cleaned up to be less different

  774 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:54:53 -0500
      revision-id: john@arbash-meinel.com-20050627025452-4260d0e744edef43
      Allow BZR_PLUGIN_PATH='' to negate plugin loading.

  773 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:49:34 -0500
      revision-id: john@arbash-meinel.com-20050627024933-b7158f67b7b9eae5
      Finished the previous cleanup (allowing load_plugins to be called twice)

  772 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:45:08 -0500
      revision-id: john@arbash-meinel.com-20050627024508-723b1df510d196fc
      Work on making the tests pass. versioning.py is calling run_cmd directly, but plugins have been loaded.

  771 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:32:29 -0500
      revision-id: john@arbash-meinel.com-20050627023228-79972744d7c53e15
      Got it down a little bit more by removing import of tree and inventory.

  770 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:26:05 -0500
      revision-id: john@arbash-meinel.com-20050627022604-350b9773ef622f95
      Reducing the number of import from bzrlib/__init__.py and bzrlib/branch.py

  769 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:32:25 -0500
      revision-id: john@arbash-meinel.com-20050627013225-32dd044f10d23948
      Updated revision.py and xml.py to include SubElement.

  768 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:03:56 -0500
      revision-id: john@arbash-meinel.com-20050627010356-ee66919e1c377faf
      Minor typo

  767 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:03:13 -0500
      revision-id: john@arbash-meinel.com-20050627010312-40d024007eb85051
      Caching the import

  766 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:51:47 -0500
      revision-id: john@arbash-meinel.com-20050627005147-5281c99e48ed1834
      Created wrapper functions for lazy import of ElementTree

  765 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:46:37 -0500
      revision-id: john@arbash-meinel.com-20050627004636-bf432902004a94c5
      Removed all of the test imports of cElementTree

  764 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:43:59 -0500
      revision-id: john@arbash-meinel.com-20050627004358-d137fbe9570dd71b
      Trying to make bzr startup faster.

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