← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-07-04 08:06:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050704080651-6ecec49164359e48
- track pending-merges

- unit tests for this

Show diffs side-by-side

added added

removed removed

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