~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-05-30 05:10:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050530051041-151c592d94481593
- better error reporting from smart_add

Show diffs side-by-side

added added

removed removed

Lines of Context:
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, \
 
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
24
from bzrlib.osutils import quotefn
 
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
93
26
     format_date
94
27
 
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):
 
28
 
 
29
def _squish_command_name(cmd):
 
30
    return 'cmd_' + cmd.replace('-', '_')
 
31
 
 
32
 
 
33
def _unsquish_command_name(cmd):
 
34
    assert cmd.startswith("cmd_")
 
35
    return cmd[4:].replace('_','-')
 
36
 
 
37
def _parse_revision_str(revstr):
 
38
    """This handles a revision string -> revno. 
 
39
 
 
40
    There are several possibilities:
 
41
 
 
42
        '234'       -> 234
 
43
        '234:345'   -> [234, 345]
 
44
        ':234'      -> [None, 234]
 
45
        '234:'      -> [234, None]
 
46
 
 
47
    In the future we will also support:
 
48
        'uuid:blah-blah-blah'   -> ?
 
49
        'hash:blahblahblah'     -> ?
 
50
        potentially:
 
51
        'tag:mytag'             -> ?
 
52
    """
 
53
    if revstr.find(':') != -1:
 
54
        revs = revstr.split(':')
 
55
        if len(revs) > 2:
 
56
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
 
57
 
 
58
        if not revs[0]:
 
59
            revs[0] = None
 
60
        else:
 
61
            revs[0] = int(revs[0])
 
62
 
 
63
        if not revs[1]:
 
64
            revs[1] = None
 
65
        else:
 
66
            revs[1] = int(revs[1])
 
67
    else:
 
68
        revs = int(revstr)
 
69
    return revs
 
70
 
 
71
def get_all_cmds():
 
72
    """Return canonical name and class for all registered commands."""
 
73
    for k, v in globals().iteritems():
 
74
        if k.startswith("cmd_"):
 
75
            yield _unsquish_command_name(k), v
 
76
 
 
77
def get_cmd_class(cmd):
 
78
    """Return the canonical name and command class for a command.
 
79
    """
 
80
    cmd = str(cmd)                      # not unicode
 
81
 
 
82
    # first look up this command under the specified name
 
83
    try:
 
84
        return cmd, globals()[_squish_command_name(cmd)]
 
85
    except KeyError:
 
86
        pass
 
87
 
 
88
    # look for any command which claims this as an alias
 
89
    for cmdname, cmdclass in get_all_cmds():
 
90
        if cmd in cmdclass.aliases:
 
91
            return cmdname, cmdclass
 
92
 
 
93
    cmdclass = ExternalCommand.find_command(cmd)
 
94
    if cmdclass:
 
95
        return cmd, cmdclass
 
96
 
 
97
    raise BzrCommandError("unknown command %r" % cmd)
 
98
 
 
99
 
 
100
class Command(object):
 
101
    """Base class for commands.
 
102
 
 
103
    The docstring for an actual command should give a single-line
 
104
    summary, then a complete description of the command.  A grammar
 
105
    description will be inserted.
 
106
 
 
107
    takes_args
 
108
        List of argument forms, marked with whether they are optional,
 
109
        repeated, etc.
 
110
 
 
111
    takes_options
 
112
        List of options that may be given for this command.
 
113
 
 
114
    hidden
 
115
        If true, this command isn't advertised.
 
116
    """
 
117
    aliases = []
 
118
    
 
119
    takes_args = []
 
120
    takes_options = []
 
121
 
 
122
    hidden = False
 
123
    
 
124
    def __init__(self, options, arguments):
 
125
        """Construct and run the command.
 
126
 
 
127
        Sets self.status to the return value of run()."""
 
128
        assert isinstance(options, dict)
 
129
        assert isinstance(arguments, dict)
 
130
        cmdargs = options.copy()
 
131
        cmdargs.update(arguments)
 
132
        assert self.__doc__ != Command.__doc__, \
 
133
               ("No help message set for %r" % self)
 
134
        self.status = self.run(**cmdargs)
 
135
 
 
136
    
 
137
    def run(self):
 
138
        """Override this in sub-classes.
 
139
 
 
140
        This is invoked with the options and arguments bound to
 
141
        keyword parameters.
 
142
 
 
143
        Return 0 or None if the command was successful, or a shell
 
144
        error code if not.
 
145
        """
 
146
        return 0
 
147
 
 
148
 
 
149
class ExternalCommand(Command):
 
150
    """Class to wrap external commands.
 
151
 
 
152
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
153
    an object we construct that has the appropriate path, help, options etc for the
 
154
    specified command.
 
155
 
 
156
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
157
    method, which we override to call the Command.__init__ method. That then calls
 
158
    our run method which is pretty straight forward.
 
159
 
 
160
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
161
    back into command line options and arguments for the script.
 
162
    """
 
163
 
 
164
    def find_command(cls, cmd):
 
165
        import os.path
 
166
        bzrpath = os.environ.get('BZRPATH', '')
 
167
 
 
168
        for dir in bzrpath.split(':'):
 
169
            path = os.path.join(dir, cmd)
 
170
            if os.path.isfile(path):
 
171
                return ExternalCommand(path)
 
172
 
 
173
        return None
 
174
 
 
175
    find_command = classmethod(find_command)
 
176
 
 
177
    def __init__(self, path):
 
178
        self.path = path
 
179
 
 
180
        # TODO: If either of these fail, we should detect that and
 
181
        # assume that path is not really a bzr plugin after all.
 
182
 
 
183
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
184
        self.takes_options = pipe.readline().split()
 
185
        self.takes_args = pipe.readline().split()
 
186
        pipe.close()
 
187
 
 
188
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
189
        self.__doc__ = pipe.read()
 
190
        pipe.close()
 
191
 
 
192
    def __call__(self, options, arguments):
 
193
        Command.__init__(self, options, arguments)
 
194
        return self
 
195
 
 
196
    def run(self, **kargs):
 
197
        opts = []
 
198
        args = []
 
199
 
 
200
        keys = kargs.keys()
 
201
        keys.sort()
 
202
        for name in keys:
 
203
            value = kargs[name]
 
204
            if OPTIONS.has_key(name):
 
205
                # it's an option
 
206
                opts.append('--%s' % name)
 
207
                if value is not None and value is not True:
 
208
                    opts.append(str(value))
 
209
            else:
 
210
                # it's an arg, or arg list
 
211
                if type(value) is not list:
 
212
                    value = [value]
 
213
                for v in value:
 
214
                    if v is not None:
 
215
                        args.append(str(v))
 
216
 
 
217
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
218
        return self.status
 
219
 
 
220
 
 
221
class cmd_status(Command):
134
222
    """Display status summary.
135
223
 
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:
 
224
    This reports on versioned and unknown files, reporting them
 
225
    grouped by state.  Possible states are:
 
226
 
 
227
    added
 
228
        Versioned in the working copy but not in the previous revision.
 
229
 
 
230
    removed
 
231
        Versioned in the previous revision but removed or deleted
 
232
        in the working copy.
 
233
 
 
234
    renamed
 
235
        Path of this file changed from the previous revision;
 
236
        the text may also have changed.  This includes files whose
 
237
        parent directory was renamed.
 
238
 
 
239
    modified
 
240
        Text has changed since the previous revision.
 
241
 
 
242
    unchanged
 
243
        Nothing about this file has changed since the previous revision.
 
244
        Only shown with --all.
 
245
 
 
246
    unknown
 
247
        Not versioned and not matching an ignore pattern.
 
248
 
 
249
    To see ignored files use 'bzr ignored'.  For details in the
 
250
    changes to file texts, use 'bzr diff'.
 
251
 
 
252
    If no arguments are specified, the status of the entire working
 
253
    directory is shown.  Otherwise, only the status of the specified
 
254
    files or directories is reported.  If a directory is given, status
 
255
    is reported for everything inside that directory.
 
256
    """
 
257
    takes_args = ['file*']
 
258
    takes_options = ['all', 'show-ids']
 
259
    aliases = ['st', 'stat']
 
260
    
 
261
    def run(self, all=False, show_ids=False, file_list=None):
 
262
        if file_list:
 
263
            b = Branch(file_list[0])
 
264
            file_list = [b.relpath(x) for x in file_list]
 
265
            # special case: only one path was given and it's the root
 
266
            # of the branch
 
267
            if file_list == ['']:
 
268
                file_list = None
 
269
        else:
 
270
            b = Branch('.')
 
271
        import status
 
272
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
 
273
                           specific_files=file_list)
 
274
 
 
275
 
 
276
class cmd_cat_revision(Command):
 
277
    """Write out metadata for a revision."""
 
278
 
 
279
    hidden = True
 
280
    takes_args = ['revision_id']
 
281
    
 
282
    def run(self, revision_id):
 
283
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
284
 
 
285
 
 
286
class cmd_revno(Command):
 
287
    """Show current revision number.
 
288
 
 
289
    This is equal to the number of revisions on this branch."""
 
290
    def run(self):
 
291
        print Branch('.').revno()
 
292
 
 
293
    
 
294
class cmd_add(Command):
 
295
    """Add specified files or directories.
 
296
 
 
297
    In non-recursive mode, all the named items are added, regardless
 
298
    of whether they were previously ignored.  A warning is given if
 
299
    any of the named files are already versioned.
 
300
 
 
301
    In recursive mode (the default), files are treated the same way
 
302
    but the behaviour for directories is different.  Directories that
 
303
    are already versioned do not give a warning.  All directories,
 
304
    whether already versioned or not, are searched for files or
 
305
    subdirectories that are neither versioned or ignored, and these
 
306
    are added.  This search proceeds recursively into versioned
 
307
    directories.
 
308
 
 
309
    Therefore simply saying 'bzr add .' will version all files that
 
310
    are currently unknown.
 
311
 
 
312
    TODO: Perhaps adding a file whose directly is not versioned should
 
313
    recursively add that parent, rather than giving an error?
 
314
    """
 
315
    takes_args = ['file+']
 
316
    takes_options = ['verbose', 'no-recurse']
 
317
    
 
318
    def run(self, file_list, verbose=False, no_recurse=False):
 
319
        bzrlib.add.smart_add(file_list, verbose, not no_recurse)
 
320
 
 
321
 
 
322
class cmd_relpath(Command):
 
323
    """Show path of a file relative to root"""
 
324
    takes_args = ['filename']
 
325
    hidden = True
 
326
    
 
327
    def run(self, filename):
 
328
        print Branch(filename).relpath(filename)
 
329
 
 
330
 
 
331
 
 
332
class cmd_inventory(Command):
 
333
    """Show inventory of the current working copy or a revision."""
 
334
    takes_options = ['revision', 'show-ids']
 
335
    
 
336
    def run(self, revision=None, show_ids=False):
 
337
        b = Branch('.')
 
338
        if revision == None:
 
339
            inv = b.read_working_inventory()
 
340
        else:
 
341
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
342
 
 
343
        for path, entry in inv.entries():
 
344
            if show_ids:
 
345
                print '%-50s %s' % (path, entry.file_id)
 
346
            else:
 
347
                print path
 
348
 
 
349
 
 
350
class cmd_move(Command):
 
351
    """Move files to a different directory.
 
352
 
 
353
    examples:
 
354
        bzr move *.txt doc
 
355
 
 
356
    The destination must be a versioned directory in the same branch.
 
357
    """
 
358
    takes_args = ['source$', 'dest']
 
359
    def run(self, source_list, dest):
 
360
        b = Branch('.')
 
361
 
 
362
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
363
 
 
364
 
 
365
class cmd_rename(Command):
 
366
    """Change the name of an entry.
 
367
 
 
368
    examples:
 
369
      bzr rename frob.c frobber.c
 
370
      bzr rename src/frob.c lib/frob.c
 
371
 
 
372
    It is an error if the destination name exists.
 
373
 
 
374
    See also the 'move' command, which moves files into a different
 
375
    directory without changing their name.
 
376
 
 
377
    TODO: Some way to rename multiple files without invoking bzr for each
 
378
    one?"""
 
379
    takes_args = ['from_name', 'to_name']
 
380
    
 
381
    def run(self, from_name, to_name):
 
382
        b = Branch('.')
 
383
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
384
 
 
385
 
 
386
 
 
387
class cmd_renames(Command):
 
388
    """Show list of renamed files.
 
389
 
 
390
    TODO: Option to show renames between two historical versions.
 
391
 
 
392
    TODO: Only show renames under dir, rather than in the whole branch.
 
393
    """
 
394
    takes_args = ['dir?']
 
395
 
 
396
    def run(self, dir='.'):
 
397
        b = Branch(dir)
 
398
        old_inv = b.basis_tree().inventory
 
399
        new_inv = b.read_working_inventory()
 
400
 
 
401
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
402
        renames.sort()
 
403
        for old_name, new_name in renames:
 
404
            print "%s => %s" % (old_name, new_name)        
 
405
 
 
406
 
 
407
class cmd_info(Command):
 
408
    """Show statistical information about a branch."""
 
409
    takes_args = ['branch?']
 
410
    
 
411
    def run(self, branch=None):
 
412
        import info
 
413
 
 
414
        from branch import find_branch
 
415
        b = find_branch(branch)
 
416
        info.show_info(b)
 
417
 
 
418
 
 
419
class cmd_remove(Command):
 
420
    """Make a file unversioned.
 
421
 
 
422
    This makes bzr stop tracking changes to a versioned file.  It does
 
423
    not delete the working copy.
 
424
    """
 
425
    takes_args = ['file+']
 
426
    takes_options = ['verbose']
 
427
    
 
428
    def run(self, file_list, verbose=False):
 
429
        b = Branch(file_list[0])
 
430
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
431
 
 
432
 
 
433
class cmd_file_id(Command):
 
434
    """Print file_id of a particular file or directory.
 
435
 
 
436
    The file_id is assigned when the file is first added and remains the
 
437
    same through all revisions where the file exists, even when it is
 
438
    moved or renamed.
 
439
    """
 
440
    hidden = True
 
441
    takes_args = ['filename']
 
442
    def run(self, filename):
 
443
        b = Branch(filename)
 
444
        i = b.inventory.path2id(b.relpath(filename))
 
445
        if i == None:
 
446
            bailout("%r is not a versioned file" % filename)
 
447
        else:
 
448
            print i
 
449
 
 
450
 
 
451
class cmd_file_path(Command):
 
452
    """Print path of file_ids to a file or directory.
 
453
 
 
454
    This prints one line for each directory down to the target,
 
455
    starting at the branch root."""
 
456
    hidden = True
 
457
    takes_args = ['filename']
 
458
    def run(self, filename):
 
459
        b = Branch(filename)
 
460
        inv = b.inventory
 
461
        fid = inv.path2id(b.relpath(filename))
 
462
        if fid == None:
 
463
            bailout("%r is not a versioned file" % filename)
 
464
        for fip in inv.get_idpath(fid):
 
465
            print fip
 
466
 
 
467
 
 
468
class cmd_revision_history(Command):
 
469
    """Display list of revision ids on this branch."""
 
470
    hidden = True
 
471
    def run(self):
 
472
        for patchid in Branch('.').revision_history():
 
473
            print patchid
 
474
 
 
475
 
 
476
class cmd_directories(Command):
 
477
    """Display list of versioned directories in this branch."""
 
478
    def run(self):
 
479
        for name, ie in Branch('.').read_working_inventory().directories():
 
480
            if name == '':
 
481
                print '.'
 
482
            else:
 
483
                print name
 
484
 
 
485
 
 
486
class cmd_init(Command):
 
487
    """Make a directory into a versioned branch.
 
488
 
 
489
    Use this to create an empty branch, or before importing an
 
490
    existing project.
 
491
 
 
492
    Recipe for importing a tree of files:
 
493
        cd ~/project
 
494
        bzr init
 
495
        bzr add -v .
 
496
        bzr status
 
497
        bzr commit -m 'imported project'
 
498
    """
 
499
    def run(self):
 
500
        Branch('.', init=True)
 
501
 
 
502
 
 
503
class cmd_diff(Command):
 
504
    """Show differences in working tree.
 
505
    
 
506
    If files are listed, only the changes in those files are listed.
 
507
    Otherwise, all changes for the tree are listed.
 
508
 
 
509
    TODO: Given two revision arguments, show the difference between them.
 
510
 
 
511
    TODO: Allow diff across branches.
 
512
 
 
513
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
514
          or a graphical diff.
 
515
 
 
516
    TODO: Python difflib is not exactly the same as unidiff; should
 
517
          either fix it up or prefer to use an external diff.
 
518
 
 
519
    TODO: If a directory is given, diff everything under that.
 
520
 
 
521
    TODO: Selected-file diff is inefficient and doesn't show you
 
522
          deleted files.
 
523
 
 
524
    TODO: This probably handles non-Unix newlines poorly.
 
525
    """
 
526
    
 
527
    takes_args = ['file*']
 
528
    takes_options = ['revision', 'diff-options']
 
529
    aliases = ['di']
 
530
 
 
531
    def run(self, revision=None, file_list=None, diff_options=None):
 
532
        from bzrlib.diff import show_diff
 
533
        from bzrlib import find_branch
 
534
 
 
535
        if file_list:
 
536
            b = find_branch(file_list[0])
 
537
            file_list = [b.relpath(f) for f in file_list]
 
538
            if file_list == ['']:
 
539
                # just pointing to top-of-tree
 
540
                file_list = None
 
541
        else:
 
542
            b = Branch('.')
 
543
    
 
544
        show_diff(b, revision, specific_files=file_list,
 
545
                  external_diff_options=diff_options)
 
546
 
 
547
 
 
548
        
 
549
 
 
550
 
 
551
class cmd_deleted(Command):
 
552
    """List files deleted in the working tree.
 
553
 
 
554
    TODO: Show files deleted since a previous revision, or between two revisions.
 
555
    """
 
556
    def run(self, show_ids=False):
 
557
        b = Branch('.')
 
558
        old = b.basis_tree()
 
559
        new = b.working_tree()
 
560
 
 
561
        ## TODO: Much more efficient way to do this: read in new
 
562
        ## directories with readdir, rather than stating each one.  Same
 
563
        ## level of effort but possibly much less IO.  (Or possibly not,
 
564
        ## if the directories are very large...)
 
565
 
 
566
        for path, ie in old.inventory.iter_entries():
 
567
            if not new.has_id(ie.file_id):
 
568
                if show_ids:
 
569
                    print '%-50s %s' % (path, ie.file_id)
 
570
                else:
 
571
                    print path
 
572
 
 
573
 
 
574
class cmd_modified(Command):
 
575
    """List files modified in working tree."""
 
576
    hidden = True
 
577
    def run(self):
 
578
        import statcache
 
579
        b = Branch('.')
182
580
        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'):
 
581
        sc = statcache.update_cache(b, inv)
 
582
        basis = b.basis_tree()
 
583
        basis_inv = basis.inventory
 
584
        
 
585
        # We used to do this through iter_entries(), but that's slow
 
586
        # when most of the files are unmodified, as is usually the
 
587
        # case.  So instead we iterate by inventory entry, and only
 
588
        # calculate paths as necessary.
 
589
 
 
590
        for file_id in basis_inv:
 
591
            cacheentry = sc.get(file_id)
 
592
            if not cacheentry:                 # deleted
 
593
                continue
 
594
            ie = basis_inv[file_id]
 
595
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
596
                path = inv.id2path(file_id)
 
597
                print path
 
598
 
 
599
 
 
600
 
 
601
class cmd_added(Command):
 
602
    """List files added in working tree."""
 
603
    hidden = True
 
604
    def run(self):
 
605
        b = Branch('.')
 
606
        wt = b.working_tree()
 
607
        basis_inv = b.basis_tree().inventory
 
608
        inv = wt.inventory
 
609
        for file_id in inv:
 
610
            if file_id in basis_inv:
 
611
                continue
 
612
            path = inv.id2path(file_id)
 
613
            if not os.access(b.abspath(path), os.F_OK):
 
614
                continue
 
615
            print path
 
616
                
 
617
        
 
618
 
 
619
class cmd_root(Command):
 
620
    """Show the tree root directory.
 
621
 
 
622
    The root is the nearest enclosing directory with a .bzr control
 
623
    directory."""
 
624
    takes_args = ['filename?']
 
625
    def run(self, filename=None):
 
626
        """Print the branch root."""
 
627
        from branch import find_branch
 
628
        b = find_branch(filename)
 
629
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
630
 
 
631
 
 
632
class cmd_log(Command):
372
633
    """Show log of this branch.
373
634
 
374
 
    :todo: Options for utc; to show ids; to limit range; etc.
 
635
    To request a range of logs, you can use the command -r begin:end
 
636
    -r revision requests a specific revision, -r :end or -r begin: are
 
637
    also valid.
 
638
 
 
639
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
640
  
375
641
    """
376
 
    Branch('.').write_log(show_timezone=timezone)
377
 
 
378
 
 
379
 
def cmd_ls(revision=None, verbose=False):
 
642
 
 
643
    takes_args = ['filename?']
 
644
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
 
645
    
 
646
    def run(self, filename=None, timezone='original',
 
647
            verbose=False,
 
648
            show_ids=False,
 
649
            forward=False,
 
650
            revision=None):
 
651
        from bzrlib import show_log, find_branch
 
652
        import codecs
 
653
 
 
654
        direction = (forward and 'forward') or 'reverse'
 
655
        
 
656
        if filename:
 
657
            b = find_branch(filename)
 
658
            fp = b.relpath(filename)
 
659
            if fp:
 
660
                file_id = b.read_working_inventory().path2id(fp)
 
661
            else:
 
662
                file_id = None  # points to branch root
 
663
        else:
 
664
            b = find_branch('.')
 
665
            file_id = None
 
666
 
 
667
        if revision == None:
 
668
            revision = [None, None]
 
669
        elif isinstance(revision, int):
 
670
            revision = [revision, revision]
 
671
        else:
 
672
            # pair of revisions?
 
673
            pass
 
674
            
 
675
        assert len(revision) == 2
 
676
 
 
677
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
678
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout)
 
679
 
 
680
        show_log(b, file_id,
 
681
                 show_timezone=timezone,
 
682
                 verbose=verbose,
 
683
                 show_ids=show_ids,
 
684
                 to_file=outf,
 
685
                 direction=direction,
 
686
                 start_revision=revision[0],
 
687
                 end_revision=revision[1])
 
688
 
 
689
 
 
690
 
 
691
class cmd_touching_revisions(Command):
 
692
    """Return revision-ids which affected a particular file.
 
693
 
 
694
    A more user-friendly interface is "bzr log FILE"."""
 
695
    hidden = True
 
696
    takes_args = ["filename"]
 
697
    def run(self, filename):
 
698
        b = Branch(filename)
 
699
        inv = b.read_working_inventory()
 
700
        file_id = inv.path2id(b.relpath(filename))
 
701
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
702
            print "%6d %s" % (revno, what)
 
703
 
 
704
 
 
705
class cmd_ls(Command):
380
706
    """List files in a tree.
381
707
 
382
 
    :todo: Take a revision or remote path and list that tree instead.
 
708
    TODO: Take a revision or remote path and list that tree instead.
383
709
    """
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 = ''
 
710
    hidden = True
 
711
    def run(self, revision=None, verbose=False):
 
712
        b = Branch('.')
 
713
        if revision == None:
 
714
            tree = b.working_tree()
 
715
        else:
 
716
            tree = b.revision_tree(b.lookup_revision(revision))
 
717
 
 
718
        for fp, fc, kind, fid in tree.list_files():
 
719
            if verbose:
 
720
                if kind == 'directory':
 
721
                    kindch = '/'
 
722
                elif kind == 'file':
 
723
                    kindch = ''
 
724
                else:
 
725
                    kindch = '???'
 
726
 
 
727
                print '%-8s %s%s' % (fc, fp, kindch)
396
728
            else:
397
 
                kindch = '???'
398
 
                
399
 
            print '%-8s %s%s' % (fc, fp, kindch)
400
 
        else:
401
 
            print fp
402
 
    
403
 
    
404
 
 
405
 
def cmd_unknowns():
 
729
                print fp
 
730
 
 
731
 
 
732
 
 
733
class cmd_unknowns(Command):
406
734
    """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, verbose=False):
447
 
    Branch('.').commit(message, verbose=verbose)
448
 
 
449
 
 
450
 
def cmd_check():
451
 
    """Check consistency of the branch."""
452
 
    check()
453
 
 
454
 
 
455
 
def cmd_is(pred, *rest):
456
 
    """Test whether PREDICATE is true."""
457
 
    try:
458
 
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
459
 
    except KeyError:
460
 
        bailout("unknown predicate: %s" % quotefn(pred))
 
735
    def run(self):
 
736
        for f in Branch('.').unknowns():
 
737
            print quotefn(f)
 
738
 
 
739
 
 
740
 
 
741
class cmd_ignore(Command):
 
742
    """Ignore a command or pattern
 
743
 
 
744
    To remove patterns from the ignore list, edit the .bzrignore file.
 
745
 
 
746
    If the pattern contains a slash, it is compared to the whole path
 
747
    from the branch root.  Otherwise, it is comapred to only the last
 
748
    component of the path.
 
749
 
 
750
    Ignore patterns are case-insensitive on case-insensitive systems.
 
751
 
 
752
    Note: wildcards must be quoted from the shell on Unix.
 
753
 
 
754
    examples:
 
755
        bzr ignore ./Makefile
 
756
        bzr ignore '*.class'
 
757
    """
 
758
    takes_args = ['name_pattern']
 
759
    
 
760
    def run(self, name_pattern):
 
761
        from bzrlib.atomicfile import AtomicFile
 
762
        import os.path
 
763
 
 
764
        b = Branch('.')
 
765
        ifn = b.abspath('.bzrignore')
 
766
 
 
767
        if os.path.exists(ifn):
 
768
            f = open(ifn, 'rt')
 
769
            try:
 
770
                igns = f.read().decode('utf-8')
 
771
            finally:
 
772
                f.close()
 
773
        else:
 
774
            igns = ''
 
775
 
 
776
        # TODO: If the file already uses crlf-style termination, maybe
 
777
        # we should use that for the newly added lines?
 
778
 
 
779
        if igns and igns[-1] != '\n':
 
780
            igns += '\n'
 
781
        igns += name_pattern + '\n'
 
782
 
 
783
        try:
 
784
            f = AtomicFile(ifn, 'wt')
 
785
            f.write(igns.encode('utf-8'))
 
786
            f.commit()
 
787
        finally:
 
788
            f.close()
 
789
 
 
790
        inv = b.working_tree().inventory
 
791
        if inv.path2id('.bzrignore'):
 
792
            mutter('.bzrignore is already versioned')
 
793
        else:
 
794
            mutter('need to make new .bzrignore file versioned')
 
795
            b.add(['.bzrignore'])
 
796
 
 
797
 
 
798
 
 
799
class cmd_ignored(Command):
 
800
    """List ignored files and the patterns that matched them.
 
801
 
 
802
    See also: bzr ignore"""
 
803
    def run(self):
 
804
        tree = Branch('.').working_tree()
 
805
        for path, file_class, kind, file_id in tree.list_files():
 
806
            if file_class != 'I':
 
807
                continue
 
808
            ## XXX: Slightly inefficient since this was already calculated
 
809
            pat = tree.is_ignored(path)
 
810
            print '%-50s %s' % (path, pat)
 
811
 
 
812
 
 
813
class cmd_lookup_revision(Command):
 
814
    """Lookup the revision-id from a revision-number
 
815
 
 
816
    example:
 
817
        bzr lookup-revision 33
 
818
    """
 
819
    hidden = True
 
820
    takes_args = ['revno']
 
821
    
 
822
    def run(self, revno):
 
823
        try:
 
824
            revno = int(revno)
 
825
        except ValueError:
 
826
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
827
 
 
828
        print Branch('.').lookup_revision(revno)
 
829
 
 
830
 
 
831
class cmd_export(Command):
 
832
    """Export past revision to destination directory.
 
833
 
 
834
    If no revision is specified this exports the last committed revision."""
 
835
    takes_args = ['dest']
 
836
    takes_options = ['revision']
 
837
    def run(self, dest, revision=None):
 
838
        b = Branch('.')
 
839
        if revision == None:
 
840
            rh = b.revision_history()[-1]
 
841
        else:
 
842
            rh = b.lookup_revision(int(revision))
 
843
        t = b.revision_tree(rh)
 
844
        t.export(dest)
 
845
 
 
846
 
 
847
class cmd_cat(Command):
 
848
    """Write a file's text from a previous revision."""
 
849
 
 
850
    takes_options = ['revision']
 
851
    takes_args = ['filename']
 
852
 
 
853
    def run(self, filename, revision=None):
 
854
        if revision == None:
 
855
            raise BzrCommandError("bzr cat requires a revision number")
 
856
        b = Branch('.')
 
857
        b.print_file(b.relpath(filename), int(revision))
 
858
 
 
859
 
 
860
class cmd_local_time_offset(Command):
 
861
    """Show the offset in seconds from GMT to local time."""
 
862
    hidden = True    
 
863
    def run(self):
 
864
        print bzrlib.osutils.local_time_offset()
 
865
 
 
866
 
 
867
 
 
868
class cmd_commit(Command):
 
869
    """Commit changes into a new revision.
 
870
 
 
871
    If selected files are specified, only changes to those files are
 
872
    committed.  If a directory is specified then its contents are also
 
873
    committed.
 
874
 
 
875
    A selected-file commit may fail in some cases where the committed
 
876
    tree would be invalid, such as trying to commit a file in a
 
877
    newly-added directory that is not itself committed.
 
878
 
 
879
    TODO: Run hooks on tree to-be-committed, and after commit.
 
880
 
 
881
    TODO: Strict commit that fails if there are unknown or deleted files.
 
882
    """
 
883
    takes_args = ['selected*']
 
884
    takes_options = ['message', 'file', 'verbose']
 
885
    aliases = ['ci', 'checkin']
 
886
 
 
887
    def run(self, message=None, file=None, verbose=True, selected_list=None):
 
888
        from bzrlib.commit import commit
 
889
 
 
890
        ## Warning: shadows builtin file()
 
891
        if not message and not file:
 
892
            raise BzrCommandError("please specify a commit message",
 
893
                                  ["use either --message or --file"])
 
894
        elif message and file:
 
895
            raise BzrCommandError("please specify either --message or --file")
461
896
        
462
 
    try:
463
 
        cmd_handler(*rest)
464
 
    except BzrCheckError:
465
 
        # by default we don't print the message so that this can
466
 
        # be used from shell scripts without producing noise
467
 
        sys.exit(1)
468
 
 
469
 
 
470
 
def cmd_username():
471
 
    print bzrlib.osutils.username()
472
 
 
473
 
 
474
 
def cmd_user_email():
475
 
    print bzrlib.osutils.user_email()
476
 
 
477
 
 
478
 
def cmd_gen_revision_id():
479
 
    import time
480
 
    print bzrlib.branch._gen_revision_id(time.time())
481
 
 
482
 
 
483
 
def cmd_doctest():
484
 
    """Run internal doctest suite"""
485
 
    ## -v, if present, is seen by doctest; the argument is just here
486
 
    ## so our parser doesn't complain
487
 
 
488
 
    ## TODO: --verbose option
 
897
        if file:
 
898
            import codecs
 
899
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
900
 
 
901
        b = Branch('.')
 
902
        commit(b, message, verbose=verbose, specific_files=selected_list)
 
903
 
 
904
 
 
905
class cmd_check(Command):
 
906
    """Validate consistency of branch history.
 
907
 
 
908
    This command checks various invariants about the branch storage to
 
909
    detect data corruption or bzr bugs.
 
910
    """
 
911
    takes_args = ['dir?']
 
912
    def run(self, dir='.'):
 
913
        import bzrlib.check
 
914
        bzrlib.check.check(Branch(dir))
 
915
 
 
916
 
 
917
 
 
918
class cmd_whoami(Command):
 
919
    """Show bzr user id."""
 
920
    takes_options = ['email']
489
921
    
490
 
    import bzr, doctest, bzrlib.store
491
 
    bzrlib.trace.verbose = False
492
 
    doctest.testmod(bzr)
493
 
    doctest.testmod(bzrlib.store)
494
 
    doctest.testmod(bzrlib.inventory)
495
 
    doctest.testmod(bzrlib.branch)
496
 
    doctest.testmod(bzrlib.osutils)
497
 
    doctest.testmod(bzrlib.tree)
498
 
 
499
 
    # more strenuous tests;
500
 
    import bzrlib.tests
501
 
    doctest.testmod(bzrlib.tests)
502
 
 
503
 
 
504
 
######################################################################
505
 
# help
506
 
 
507
 
 
508
 
def cmd_help():
509
 
    # TODO: Specific help for particular commands
510
 
    print __doc__
511
 
 
512
 
 
513
 
def cmd_version():
514
 
    print "bzr (bazaar-ng) %s" % __version__
515
 
    print __copyright__
 
922
    def run(self, email=False):
 
923
        if email:
 
924
            print bzrlib.osutils.user_email()
 
925
        else:
 
926
            print bzrlib.osutils.username()
 
927
 
 
928
 
 
929
class cmd_selftest(Command):
 
930
    """Run internal test suite"""
 
931
    hidden = True
 
932
    def run(self):
 
933
        failures, tests = 0, 0
 
934
 
 
935
        import doctest, bzrlib.store
 
936
        bzrlib.trace.verbose = False
 
937
 
 
938
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
939
            bzrlib.tree, bzrlib.commands, bzrlib.add:
 
940
            mf, mt = doctest.testmod(m)
 
941
            failures += mf
 
942
            tests += mt
 
943
            print '%-40s %3d tests' % (m.__name__, mt),
 
944
            if mf:
 
945
                print '%3d FAILED!' % mf
 
946
            else:
 
947
                print
 
948
 
 
949
        print '%-40s %3d tests' % ('total', tests),
 
950
        if failures:
 
951
            print '%3d FAILED!' % failures
 
952
            return 1
 
953
        else:
 
954
            print
 
955
            return 0
 
956
 
 
957
 
 
958
 
 
959
class cmd_version(Command):
 
960
    """Show version of bzr"""
 
961
    def run(self):
 
962
        show_version()
 
963
 
 
964
def show_version():
 
965
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
966
    print bzrlib.__copyright__
516
967
    print "http://bazaar-ng.org/"
517
968
    print
518
 
    print \
519
 
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
520
 
you may use, modify and redistribute it under the terms of the GNU 
521
 
General Public License version 2 or later."""
522
 
 
523
 
 
524
 
def cmd_rocks():
 
969
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
970
    print "you may use, modify and redistribute it under the terms of the GNU"
 
971
    print "General Public License version 2 or later."
 
972
 
 
973
 
 
974
class cmd_rocks(Command):
525
975
    """Statement of optimism."""
526
 
    print "it sure does!"
527
 
 
528
 
 
529
 
 
530
 
######################################################################
531
 
# main routine
 
976
    hidden = True
 
977
    def run(self):
 
978
        print "it sure does!"
 
979
 
 
980
def parse_spec(spec):
 
981
    if '/@' in spec:
 
982
        parsed = spec.split('/@')
 
983
        assert len(parsed) == 2
 
984
        if parsed[1] == "":
 
985
            parsed[1] = -1
 
986
        else:
 
987
            parsed[1] = int(parsed[1])
 
988
            assert parsed[1] >=0
 
989
    else:
 
990
        parsed = [spec, None]
 
991
    return parsed
 
992
 
 
993
class cmd_merge(Command):
 
994
    """Perform a three-way merge of trees."""
 
995
    takes_args = ['other_spec', 'base_spec']
 
996
 
 
997
    def run(self, other_spec, base_spec):
 
998
        from bzrlib.merge import merge
 
999
        merge(parse_spec(other_spec), parse_spec(base_spec))
 
1000
 
 
1001
class cmd_assert_fail(Command):
 
1002
    """Test reporting of assertion failures"""
 
1003
    hidden = True
 
1004
    def run(self):
 
1005
        assert False, "always fails"
 
1006
 
 
1007
 
 
1008
class cmd_help(Command):
 
1009
    """Show help on a command or other topic.
 
1010
 
 
1011
    For a list of all available commands, say 'bzr help commands'."""
 
1012
    takes_args = ['topic?']
 
1013
    aliases = ['?']
 
1014
    
 
1015
    def run(self, topic=None):
 
1016
        import help
 
1017
        help.help(topic)
 
1018
 
 
1019
 
 
1020
class cmd_update_stat_cache(Command):
 
1021
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
1022
 
 
1023
    For testing only."""
 
1024
    hidden = True
 
1025
    def run(self):
 
1026
        import statcache
 
1027
        b = Branch('.')
 
1028
        statcache.update_cache(b.base, b.read_working_inventory())
 
1029
 
532
1030
 
533
1031
 
534
1032
# list of all available options; the rhs can be either None for an
536
1034
# the type.
537
1035
OPTIONS = {
538
1036
    'all':                    None,
 
1037
    'diff-options':           str,
539
1038
    'help':                   None,
 
1039
    'file':                   unicode,
 
1040
    'forward':                None,
540
1041
    'message':                unicode,
541
 
    'revision':               int,
 
1042
    'no-recurse':             None,
 
1043
    'profile':                None,
 
1044
    'revision':               _parse_revision_str,
542
1045
    'show-ids':               None,
543
1046
    'timezone':               str,
544
1047
    'verbose':                None,
545
1048
    'version':                None,
 
1049
    'email':                  None,
546
1050
    }
547
1051
 
548
1052
SHORT_OPTIONS = {
 
1053
    'F':                      'file', 
 
1054
    'h':                      'help',
549
1055
    'm':                      'message',
550
1056
    'r':                      'revision',
551
1057
    'v':                      'verbose',
552
1058
}
553
1059
 
554
 
# List of options that apply to particular commands; commands not
555
 
# listed take none.
556
 
cmd_options = {
557
 
    'add':                    ['verbose'],
558
 
    'commit':                 ['message', 'verbose'],
559
 
    'diff':                   ['revision'],
560
 
    'inventory':              ['revision'],
561
 
    'log':                    ['show-ids', 'timezone'],
562
 
    'ls':                     ['revision', 'verbose'],
563
 
    'remove':                 ['verbose'],
564
 
    'status':                 ['all'],
565
 
    }
566
 
 
567
 
 
568
 
cmd_args = {
569
 
    'init':                   [],
570
 
    'add':                    ['file+'],
571
 
    'commit':                 [],
572
 
    'diff':                   [],
573
 
    'file-id':                ['filename'],
574
 
    'get-file-text':          ['text_id'],
575
 
    'get-inventory':          ['inventory_id'],
576
 
    'get-revision':           ['revision_id'],
577
 
    'get-revision-inventory': ['revision_id'],
578
 
    'log':                    [],
579
 
    'lookup-revision':        ['revno'],
580
 
    'export':                 ['revno', 'dest'],
581
 
    'remove':                 ['file+'],
582
 
    'status':                 [],
583
 
    }
584
 
 
585
1060
 
586
1061
def parse_args(argv):
587
1062
    """Parse command line.
608
1083
    while argv:
609
1084
        a = argv.pop(0)
610
1085
        if a[0] == '-':
 
1086
            # option names must not be unicode
 
1087
            a = str(a)
611
1088
            optarg = None
612
1089
            if a[1] == '-':
613
1090
                mutter("  got option %r" % a)
635
1112
                    else:
636
1113
                        optarg = argv.pop(0)
637
1114
                opts[optname] = optargfn(optarg)
638
 
                mutter("    option argument %r" % opts[optname])
639
1115
            else:
640
1116
                if optarg != None:
641
1117
                    bailout('option %r takes no argument' % optname)
647
1123
 
648
1124
 
649
1125
 
650
 
def _match_args(cmd, args):
651
 
    """Check non-option arguments match required pattern.
652
1126
 
653
 
    >>> _match_args('status', ['asdasdsadasd'])
654
 
    Traceback (most recent call last):
655
 
    ...
656
 
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
657
 
    >>> _match_args('add', ['asdasdsadasd'])
658
 
    {'file_list': ['asdasdsadasd']}
659
 
    >>> _match_args('add', 'abc def gj'.split())
660
 
    {'file_list': ['abc', 'def', 'gj']}
661
 
    """
662
 
    # match argument pattern
663
 
    argform = cmd_args.get(cmd, [])
 
1127
def _match_argform(cmd, takes_args, args):
664
1128
    argdict = {}
665
 
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
666
 
    # all but one.
667
1129
 
668
 
    for ap in argform:
 
1130
    # step through args and takes_args, allowing appropriate 0-many matches
 
1131
    for ap in takes_args:
669
1132
        argname = ap[:-1]
670
1133
        if ap[-1] == '?':
671
 
            assert 0
672
 
        elif ap[-1] == '*':
673
 
            assert 0
 
1134
            if args:
 
1135
                argdict[argname] = args.pop(0)
 
1136
        elif ap[-1] == '*': # all remaining arguments
 
1137
            if args:
 
1138
                argdict[argname + '_list'] = args[:]
 
1139
                args = []
 
1140
            else:
 
1141
                argdict[argname + '_list'] = None
674
1142
        elif ap[-1] == '+':
675
1143
            if not args:
676
 
                bailout("command %r needs one or more %s"
 
1144
                raise BzrCommandError("command %r needs one or more %s"
677
1145
                        % (cmd, argname.upper()))
678
1146
            else:
679
1147
                argdict[argname + '_list'] = args[:]
680
1148
                args = []
 
1149
        elif ap[-1] == '$': # all but one
 
1150
            if len(args) < 2:
 
1151
                raise BzrCommandError("command %r needs one or more %s"
 
1152
                        % (cmd, argname.upper()))
 
1153
            argdict[argname + '_list'] = args[:-1]
 
1154
            args[:-1] = []                
681
1155
        else:
682
1156
            # just a plain arg
683
1157
            argname = ap
684
1158
            if not args:
685
 
                bailout("command %r requires argument %s"
 
1159
                raise BzrCommandError("command %r requires argument %s"
686
1160
                        % (cmd, argname.upper()))
687
1161
            else:
688
1162
                argdict[argname] = args.pop(0)
689
1163
            
690
1164
    if args:
691
 
        bailout("extra arguments to command %s: %r"
692
 
                % (cmd, args))
 
1165
        raise BzrCommandError("extra argument to command %s: %s"
 
1166
                              % (cmd, args[0]))
693
1167
 
694
1168
    return argdict
695
1169
 
699
1173
    """Execute a command.
700
1174
 
701
1175
    This is similar to main(), but without all the trappings for
702
 
    logging and error handling.
 
1176
    logging and error handling.  
703
1177
    """
 
1178
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1179
    
704
1180
    try:
705
1181
        args, opts = parse_args(argv[1:])
706
1182
        if 'help' in opts:
707
 
            # TODO: pass down other arguments in case they asked for
708
 
            # help on a command name?
709
 
            cmd_help()
 
1183
            import help
 
1184
            if args:
 
1185
                help.help(args[0])
 
1186
            else:
 
1187
                help.help()
710
1188
            return 0
711
1189
        elif 'version' in opts:
712
 
            cmd_version()
 
1190
            show_version()
713
1191
            return 0
714
 
        cmd = args.pop(0)
 
1192
        cmd = str(args.pop(0))
715
1193
    except IndexError:
716
 
        log_error('usage: bzr COMMAND\n')
717
 
        log_error('  try "bzr help"\n')
 
1194
        import help
 
1195
        help.help()
718
1196
        return 1
719
 
            
720
 
    try:
721
 
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
722
 
    except KeyError:
723
 
        bailout("unknown command " + `cmd`)
724
 
 
725
 
    # TODO: special --profile option to turn on the Python profiler
 
1197
          
 
1198
 
 
1199
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
1200
 
 
1201
    # global option
 
1202
    if 'profile' in opts:
 
1203
        profile = True
 
1204
        del opts['profile']
 
1205
    else:
 
1206
        profile = False
726
1207
 
727
1208
    # check options are reasonable
728
 
    allowed = cmd_options.get(cmd, [])
 
1209
    allowed = cmd_class.takes_options
729
1210
    for oname in opts:
730
1211
        if oname not in allowed:
731
 
            bailout("option %r is not allowed for command %r"
732
 
                    % (oname, cmd))
733
 
 
734
 
    cmdargs = _match_args(cmd, args)
735
 
    cmdargs.update(opts)
736
 
 
737
 
    ret = cmd_handler(**cmdargs) or 0
 
1212
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1213
                                  % (oname, cmd))
 
1214
 
 
1215
    # mix arguments and options into one dictionary
 
1216
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1217
    cmdopts = {}
 
1218
    for k, v in opts.items():
 
1219
        cmdopts[k.replace('-', '_')] = v
 
1220
 
 
1221
    if profile:
 
1222
        import hotshot, tempfile
 
1223
        pffileno, pfname = tempfile.mkstemp()
 
1224
        try:
 
1225
            prof = hotshot.Profile(pfname)
 
1226
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1227
            prof.close()
 
1228
 
 
1229
            import hotshot.stats
 
1230
            stats = hotshot.stats.load(pfname)
 
1231
            #stats.strip_dirs()
 
1232
            stats.sort_stats('time')
 
1233
            ## XXX: Might like to write to stderr or the trace file instead but
 
1234
            ## print_stats seems hardcoded to stdout
 
1235
            stats.print_stats(20)
 
1236
            
 
1237
            return ret.status
 
1238
 
 
1239
        finally:
 
1240
            os.close(pffileno)
 
1241
            os.remove(pfname)
 
1242
    else:
 
1243
        return cmd_class(cmdopts, cmdargs).status 
 
1244
 
 
1245
 
 
1246
def _report_exception(summary, quiet=False):
 
1247
    import traceback
 
1248
    log_error('bzr: ' + summary)
 
1249
    bzrlib.trace.log_exception()
 
1250
 
 
1251
    if not quiet:
 
1252
        tb = sys.exc_info()[2]
 
1253
        exinfo = traceback.extract_tb(tb)
 
1254
        if exinfo:
 
1255
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1256
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
738
1257
 
739
1258
 
740
1259
 
741
1260
def main(argv):
742
 
    ## TODO: Handle command-line options; probably know what options are valid for
743
 
    ## each command
744
 
 
745
 
    ## TODO: If the arguments are wrong, give a usage message rather
746
 
    ## than just a backtrace.
 
1261
    import errno
 
1262
    
 
1263
    bzrlib.open_tracefile(argv)
747
1264
 
748
1265
    try:
749
 
        # TODO: Lift into separate function in trace.py
750
 
        # TODO: Also show contents of /etc/lsb-release, if it can be parsed.
751
 
        #       Perhaps that should eventually go into the platform library?
752
 
        # TODO: If the file doesn't exist, add a note describing it.
753
 
        t = bzrlib.trace._tracefile
754
 
        t.write('-' * 60 + '\n')
755
 
        t.write('bzr invoked at %s\n' % format_date(time.time()))
756
 
        t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
757
 
        t.write('  arguments: %r\n' % argv)
758
 
 
759
 
        starttime = os.times()[4]
760
 
 
761
 
        import platform
762
 
        t.write('  platform: %s\n' % platform.platform())
763
 
        t.write('  python: %s\n' % platform.python_version())
764
 
 
765
 
        ret = run_bzr(argv)
766
 
        
767
 
        times = os.times()
768
 
        mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
769
 
               % times[:4])
770
 
        mutter("    %.3f elapsed" % (times[4] - starttime))
771
 
 
772
 
        return ret
773
 
    except BzrError, e:
774
 
        log_error('bzr: error: ' + e.args[0] + '\n')
775
 
        if len(e.args) > 1:
776
 
            for h in e.args[1]:
777
 
                log_error('  ' + h + '\n')
778
 
        return 1
779
 
    except Exception, e:
780
 
        log_error('bzr: exception: %s\n' % e)
781
 
        log_error('    see .bzr.log for details\n')
782
 
        traceback.print_exc(None, bzrlib.trace._tracefile)
783
 
        traceback.print_exc(None, sys.stderr)
784
 
        return 1
785
 
 
786
 
    # TODO: Maybe nicer handling of IOError?
787
 
 
 
1266
        try:
 
1267
            try:
 
1268
                return run_bzr(argv)
 
1269
            finally:
 
1270
                # do this here inside the exception wrappers to catch EPIPE
 
1271
                sys.stdout.flush()
 
1272
        except BzrError, e:
 
1273
            quiet = isinstance(e, (BzrCommandError))
 
1274
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1275
            if len(e.args) > 1:
 
1276
                for h in e.args[1]:
 
1277
                    # some explanation or hints
 
1278
                    log_error('  ' + h)
 
1279
            return 1
 
1280
        except AssertionError, e:
 
1281
            msg = 'assertion failed'
 
1282
            if str(e):
 
1283
                msg += ': ' + str(e)
 
1284
            _report_exception(msg)
 
1285
            return 2
 
1286
        except KeyboardInterrupt, e:
 
1287
            _report_exception('interrupted', quiet=True)
 
1288
            return 2
 
1289
        except Exception, e:
 
1290
            quiet = False
 
1291
            if (isinstance(e, IOError) 
 
1292
                and hasattr(e, 'errno')
 
1293
                and e.errno == errno.EPIPE):
 
1294
                quiet = True
 
1295
                msg = 'broken pipe'
 
1296
            else:
 
1297
                msg = str(e).rstrip('\n')
 
1298
            _report_exception(msg, quiet)
 
1299
            return 2
 
1300
    finally:
 
1301
        bzrlib.trace.close_trace()
788
1302
 
789
1303
 
790
1304
if __name__ == '__main__':
791
1305
    sys.exit(main(sys.argv))
792
 
    ##import profile
793
 
    ##profile.run('main(sys.argv)')
794