~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-05-10 08:15:58 UTC
  • Revision ID: mbp@sourcefrog.net-20050510081558-9a38e2c46ba4ebc4
- Patch from Fredrik Lundh to check Python version and 
  try to find a better one if it's too old.

  Patched to try to prevent infinite loops in wierd configurations,
  and to log to stderr.

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
 
17
 
 
18
 
 
19
import sys, os, time, os.path
80
20
from sets import Set
81
 
from pprint import pprint
82
 
from stat import *
83
 
from glob import glob
84
21
 
85
22
import bzrlib
86
 
from bzrlib.store import ImmutableStore
87
23
from bzrlib.trace import mutter, note, log_error
88
 
from bzrlib.errors import bailout, BzrError
 
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
89
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
90
26
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
91
27
from bzrlib.revision import Revision
92
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
93
29
     format_date
94
30
 
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):
 
31
 
 
32
def _squish_command_name(cmd):
 
33
    return 'cmd_' + cmd.replace('-', '_')
 
34
 
 
35
 
 
36
def _unsquish_command_name(cmd):
 
37
    assert cmd.startswith("cmd_")
 
38
    return cmd[4:].replace('_','-')
 
39
 
 
40
def get_all_cmds():
 
41
    """Return canonical name and class for all registered commands."""
 
42
    for k, v in globals().iteritems():
 
43
        if k.startswith("cmd_"):
 
44
            yield _unsquish_command_name(k), v
 
45
 
 
46
def get_cmd_class(cmd):
 
47
    """Return the canonical name and command class for a command.
 
48
    """
 
49
    cmd = str(cmd)                      # not unicode
 
50
 
 
51
    # first look up this command under the specified name
 
52
    try:
 
53
        return cmd, globals()[_squish_command_name(cmd)]
 
54
    except KeyError:
 
55
        pass
 
56
 
 
57
    # look for any command which claims this as an alias
 
58
    for cmdname, cmdclass in get_all_cmds():
 
59
        if cmd in cmdclass.aliases:
 
60
            return cmdname, cmdclass
 
61
 
 
62
    cmdclass = ExternalCommand.find_command(cmd)
 
63
    if cmdclass:
 
64
        return cmd, cmdclass
 
65
 
 
66
    raise BzrCommandError("unknown command %r" % cmd)
 
67
 
 
68
 
 
69
class Command:
 
70
    """Base class for commands.
 
71
 
 
72
    The docstring for an actual command should give a single-line
 
73
    summary, then a complete description of the command.  A grammar
 
74
    description will be inserted.
 
75
 
 
76
    takes_args
 
77
        List of argument forms, marked with whether they are optional,
 
78
        repeated, etc.
 
79
 
 
80
    takes_options
 
81
        List of options that may be given for this command.
 
82
 
 
83
    hidden
 
84
        If true, this command isn't advertised.
 
85
    """
 
86
    aliases = []
 
87
    
 
88
    takes_args = []
 
89
    takes_options = []
 
90
 
 
91
    hidden = False
 
92
    
 
93
    def __init__(self, options, arguments):
 
94
        """Construct and run the command.
 
95
 
 
96
        Sets self.status to the return value of run()."""
 
97
        assert isinstance(options, dict)
 
98
        assert isinstance(arguments, dict)
 
99
        cmdargs = options.copy()
 
100
        cmdargs.update(arguments)
 
101
        assert self.__doc__ != Command.__doc__, \
 
102
               ("No help message set for %r" % self)
 
103
        self.status = self.run(**cmdargs)
 
104
 
 
105
    
 
106
    def run(self):
 
107
        """Override this in sub-classes.
 
108
 
 
109
        This is invoked with the options and arguments bound to
 
110
        keyword parameters.
 
111
 
 
112
        Return 0 or None if the command was successful, or a shell
 
113
        error code if not.
 
114
        """
 
115
        return 0
 
116
 
 
117
 
 
118
class ExternalCommand(Command):
 
119
    """Class to wrap external commands.
 
120
 
 
121
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
122
    an object we construct that has the appropriate path, help, options etc for the
 
123
    specified command.
 
124
 
 
125
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
126
    method, which we override to call the Command.__init__ method. That then calls
 
127
    our run method which is pretty straight forward.
 
128
 
 
129
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
130
    back into command line options and arguments for the script.
 
131
    """
 
132
 
 
133
    def find_command(cls, cmd):
 
134
        bzrpath = os.environ.get('BZRPATH', '')
 
135
 
 
136
        for dir in bzrpath.split(':'):
 
137
            path = os.path.join(dir, cmd)
 
138
            if os.path.isfile(path):
 
139
                return ExternalCommand(path)
 
140
 
 
141
        return None
 
142
 
 
143
    find_command = classmethod(find_command)
 
144
 
 
145
    def __init__(self, path):
 
146
        self.path = path
 
147
 
 
148
        # TODO: If either of these fail, we should detect that and
 
149
        # assume that path is not really a bzr plugin after all.
 
150
 
 
151
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
152
        self.takes_options = pipe.readline().split()
 
153
        self.takes_args = pipe.readline().split()
 
154
        pipe.close()
 
155
 
 
156
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
157
        self.__doc__ = pipe.read()
 
158
        pipe.close()
 
159
 
 
160
    def __call__(self, options, arguments):
 
161
        Command.__init__(self, options, arguments)
 
162
        return self
 
163
 
 
164
    def run(self, **kargs):
 
165
        opts = []
 
166
        args = []
 
167
 
 
168
        keys = kargs.keys()
 
169
        keys.sort()
 
170
        for name in keys:
 
171
            value = kargs[name]
 
172
            if OPTIONS.has_key(name):
 
173
                # it's an option
 
174
                opts.append('--%s' % name)
 
175
                if value is not None and value is not True:
 
176
                    opts.append(str(value))
 
177
            else:
 
178
                # it's an arg, or arg list
 
179
                if type(value) is not list:
 
180
                    value = [value]
 
181
                for v in value:
 
182
                    if v is not None:
 
183
                        args.append(str(v))
 
184
 
 
185
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
186
        return self.status
 
187
 
 
188
 
 
189
class cmd_status(Command):
134
190
    """Display status summary.
135
191
 
136
192
    For each file there is a single line giving its file state and name.
137
193
    The name is that in the current revision unless it is deleted or
138
194
    missing, in which case the old name is shown.
139
 
 
140
 
    :todo: Don't show unchanged files unless ``--all`` is given?
141
195
    """
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
 
    
169
 
def cmd_add(file_list, verbose=False):
 
196
    takes_args = ['file*']
 
197
    takes_options = ['all']
 
198
    aliases = ['st', 'stat']
 
199
    
 
200
    def run(self, all=False, file_list=None):
 
201
        b = Branch('.', lock_mode='r')
 
202
        b.show_status(show_all=all, file_list=file_list)
 
203
 
 
204
 
 
205
class cmd_cat_revision(Command):
 
206
    """Write out metadata for a revision."""
 
207
 
 
208
    hidden = True
 
209
    takes_args = ['revision_id']
 
210
    
 
211
    def run(self, revision_id):
 
212
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
213
 
 
214
 
 
215
class cmd_revno(Command):
 
216
    """Show current revision number.
 
217
 
 
218
    This is equal to the number of revisions on this branch."""
 
219
    def run(self):
 
220
        print Branch('.').revno()
 
221
 
 
222
    
 
223
class cmd_add(Command):
170
224
    """Add specified files or directories.
171
225
 
172
226
    In non-recursive mode, all the named items are added, regardless
183
237
 
184
238
    Therefore simply saying 'bzr add .' will version all files that
185
239
    are currently unknown.
 
240
 
 
241
    TODO: Perhaps adding a file whose directly is not versioned should
 
242
    recursively add that parent, rather than giving an error?
186
243
    """
187
 
    if True:
 
244
    takes_args = ['file+']
 
245
    takes_options = ['verbose']
 
246
    
 
247
    def run(self, file_list, verbose=False):
188
248
        bzrlib.add.smart_add(file_list, verbose)
189
 
    else:
190
 
        # old way
191
 
        assert file_list
192
 
        b = Branch(file_list[0], find_root=True)
193
 
        b.add([b.relpath(f) for f in file_list], verbose=verbose)
194
 
 
195
 
    
196
 
 
197
 
def cmd_relpath(filename):
198
 
    print Branch(filename).relpath(filename)
199
 
 
200
 
 
201
 
def cmd_inventory(revision=None):
202
 
    """Show inventory of the current working copy."""
203
 
    ## TODO: Also optionally show a previous inventory
204
 
    ## TODO: Format options
205
 
    b = Branch('.')
206
 
    if revision == None:
 
249
 
 
250
 
 
251
class cmd_relpath(Command):
 
252
    """Show path of a file relative to root"""
 
253
    takes_args = ['filename']
 
254
    
 
255
    def run(self, filename):
 
256
        print Branch(filename).relpath(filename)
 
257
 
 
258
 
 
259
 
 
260
class cmd_inventory(Command):
 
261
    """Show inventory of the current working copy or a revision."""
 
262
    takes_options = ['revision']
 
263
    
 
264
    def run(self, revision=None):
 
265
        b = Branch('.')
 
266
        if revision == None:
 
267
            inv = b.read_working_inventory()
 
268
        else:
 
269
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
270
 
 
271
        for path, entry in inv.iter_entries():
 
272
            print '%-50s %s' % (entry.file_id, path)
 
273
 
 
274
 
 
275
class cmd_move(Command):
 
276
    """Move files to a different directory.
 
277
 
 
278
    examples:
 
279
        bzr move *.txt doc
 
280
 
 
281
    The destination must be a versioned directory in the same branch.
 
282
    """
 
283
    takes_args = ['source$', 'dest']
 
284
    def run(self, source_list, dest):
 
285
        b = Branch('.')
 
286
 
 
287
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
288
 
 
289
 
 
290
class cmd_rename(Command):
 
291
    """Change the name of an entry.
 
292
 
 
293
    examples:
 
294
      bzr rename frob.c frobber.c
 
295
      bzr rename src/frob.c lib/frob.c
 
296
 
 
297
    It is an error if the destination name exists.
 
298
 
 
299
    See also the 'move' command, which moves files into a different
 
300
    directory without changing their name.
 
301
 
 
302
    TODO: Some way to rename multiple files without invoking bzr for each
 
303
    one?"""
 
304
    takes_args = ['from_name', 'to_name']
 
305
    
 
306
    def run(self, from_name, to_name):
 
307
        b = Branch('.')
 
308
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
309
 
 
310
 
 
311
 
 
312
class cmd_renames(Command):
 
313
    """Show list of renamed files.
 
314
 
 
315
    TODO: Option to show renames between two historical versions.
 
316
 
 
317
    TODO: Only show renames under dir, rather than in the whole branch.
 
318
    """
 
319
    takes_args = ['dir?']
 
320
 
 
321
    def run(self, dir='.'):
 
322
        b = Branch(dir)
 
323
        old_inv = b.basis_tree().inventory
 
324
        new_inv = b.read_working_inventory()
 
325
 
 
326
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
327
        renames.sort()
 
328
        for old_name, new_name in renames:
 
329
            print "%s => %s" % (old_name, new_name)        
 
330
 
 
331
 
 
332
class cmd_info(Command):
 
333
    """Show statistical information for this branch"""
 
334
    def run(self):
 
335
        import info
 
336
        info.show_info(Branch('.'))        
 
337
 
 
338
 
 
339
class cmd_remove(Command):
 
340
    """Make a file unversioned.
 
341
 
 
342
    This makes bzr stop tracking changes to a versioned file.  It does
 
343
    not delete the working copy.
 
344
    """
 
345
    takes_args = ['file+']
 
346
    takes_options = ['verbose']
 
347
    
 
348
    def run(self, file_list, verbose=False):
 
349
        b = Branch(file_list[0])
 
350
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
351
 
 
352
 
 
353
class cmd_file_id(Command):
 
354
    """Print file_id of a particular file or directory.
 
355
 
 
356
    The file_id is assigned when the file is first added and remains the
 
357
    same through all revisions where the file exists, even when it is
 
358
    moved or renamed.
 
359
    """
 
360
    hidden = True
 
361
    takes_args = ['filename']
 
362
    def run(self, filename):
 
363
        b = Branch(filename)
 
364
        i = b.inventory.path2id(b.relpath(filename))
 
365
        if i == None:
 
366
            bailout("%r is not a versioned file" % filename)
 
367
        else:
 
368
            print i
 
369
 
 
370
 
 
371
class cmd_file_path(Command):
 
372
    """Print path of file_ids to a file or directory.
 
373
 
 
374
    This prints one line for each directory down to the target,
 
375
    starting at the branch root."""
 
376
    hidden = True
 
377
    takes_args = ['filename']
 
378
    def run(self, filename):
 
379
        b = Branch(filename)
 
380
        inv = b.inventory
 
381
        fid = inv.path2id(b.relpath(filename))
 
382
        if fid == None:
 
383
            bailout("%r is not a versioned file" % filename)
 
384
        for fip in inv.get_idpath(fid):
 
385
            print fip
 
386
 
 
387
 
 
388
class cmd_revision_history(Command):
 
389
    """Display list of revision ids on this branch."""
 
390
    def run(self):
 
391
        for patchid in Branch('.').revision_history():
 
392
            print patchid
 
393
 
 
394
 
 
395
class cmd_directories(Command):
 
396
    """Display list of versioned directories in this branch."""
 
397
    def run(self):
 
398
        for name, ie in Branch('.').read_working_inventory().directories():
 
399
            if name == '':
 
400
                print '.'
 
401
            else:
 
402
                print name
 
403
 
 
404
 
 
405
class cmd_init(Command):
 
406
    """Make a directory into a versioned branch.
 
407
 
 
408
    Use this to create an empty branch, or before importing an
 
409
    existing project.
 
410
 
 
411
    Recipe for importing a tree of files:
 
412
        cd ~/project
 
413
        bzr init
 
414
        bzr add -v .
 
415
        bzr status
 
416
        bzr commit -m 'imported project'
 
417
    """
 
418
    def run(self):
 
419
        Branch('.', init=True)
 
420
 
 
421
 
 
422
class cmd_diff(Command):
 
423
    """Show differences in working tree.
 
424
    
 
425
    If files are listed, only the changes in those files are listed.
 
426
    Otherwise, all changes for the tree are listed.
 
427
 
 
428
    TODO: Given two revision arguments, show the difference between them.
 
429
 
 
430
    TODO: Allow diff across branches.
 
431
 
 
432
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
433
          or a graphical diff.
 
434
 
 
435
    TODO: Python difflib is not exactly the same as unidiff; should
 
436
          either fix it up or prefer to use an external diff.
 
437
 
 
438
    TODO: If a directory is given, diff everything under that.
 
439
 
 
440
    TODO: Selected-file diff is inefficient and doesn't show you
 
441
          deleted files.
 
442
 
 
443
    TODO: This probably handles non-Unix newlines poorly.
 
444
    """
 
445
    
 
446
    takes_args = ['file*']
 
447
    takes_options = ['revision']
 
448
    aliases = ['di']
 
449
 
 
450
    def run(self, revision=None, file_list=None):
 
451
        from bzrlib.diff import show_diff
 
452
    
 
453
        show_diff(Branch('.'), revision, file_list)
 
454
 
 
455
 
 
456
        
 
457
 
 
458
 
 
459
class cmd_deleted(Command):
 
460
    """List files deleted in the working tree.
 
461
 
 
462
    TODO: Show files deleted since a previous revision, or between two revisions.
 
463
    """
 
464
    def run(self, show_ids=False):
 
465
        b = Branch('.')
 
466
        old = b.basis_tree()
 
467
        new = b.working_tree()
 
468
 
 
469
        ## TODO: Much more efficient way to do this: read in new
 
470
        ## directories with readdir, rather than stating each one.  Same
 
471
        ## level of effort but possibly much less IO.  (Or possibly not,
 
472
        ## if the directories are very large...)
 
473
 
 
474
        for path, ie in old.inventory.iter_entries():
 
475
            if not new.has_id(ie.file_id):
 
476
                if show_ids:
 
477
                    print '%-50s %s' % (path, ie.file_id)
 
478
                else:
 
479
                    print path
 
480
 
 
481
 
 
482
class cmd_modified(Command):
 
483
    """List files modified in working tree."""
 
484
    hidden = True
 
485
    def run(self):
 
486
        import statcache
 
487
        b = Branch('.')
207
488
        inv = b.read_working_inventory()
208
 
    else:
209
 
        inv = b.get_revision_inventory(b.lookup_revision(revision))
210
 
        
211
 
    for path, entry in inv.iter_entries():
212
 
        print '%-50s %s' % (entry.file_id, path)
213
 
 
214
 
 
215
 
 
216
 
def cmd_info():
217
 
    b = Branch('.')
218
 
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
219
 
 
220
 
    def plural(n, base='', pl=None):
221
 
        if n == 1:
222
 
            return base
223
 
        elif pl is not None:
224
 
            return pl
225
 
        else:
226
 
            return 's'
227
 
 
228
 
    count_version_dirs = 0
229
 
 
230
 
    count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
231
 
    for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
232
 
        fs = st_tup[0]
233
 
        count_status[fs] += 1
234
 
        if fs not in ['I', '?'] and st_tup[4] == 'directory':
235
 
            count_version_dirs += 1
236
 
 
237
 
    print
238
 
    print 'in the working tree:'
239
 
    for name, fs in (('unchanged', '.'),
240
 
                     ('modified', 'M'), ('added', 'A'), ('removed', 'D'),
241
 
                     ('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
242
 
                     ):
243
 
        print '  %5d %s' % (count_status[fs], name)
244
 
    print '  %5d versioned subdirector%s' % (count_version_dirs,
245
 
                                             plural(count_version_dirs, 'y', 'ies'))
246
 
 
247
 
    print
248
 
    print 'branch history:'
249
 
    history = b.revision_history()
250
 
    revno = len(history)
251
 
    print '  %5d revision%s' % (revno, plural(revno))
252
 
    committers = Set()
253
 
    for rev in history:
254
 
        committers.add(b.get_revision(rev).committer)
255
 
    print '  %5d committer%s' % (len(committers), plural(len(committers)))
256
 
    if revno > 0:
257
 
        firstrev = b.get_revision(history[0])
258
 
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
259
 
        print '  %5d day%s old' % (age, plural(age))
260
 
        print '  first revision: %s' % format_date(firstrev.timestamp,
261
 
                                                 firstrev.timezone)
262
 
 
263
 
        lastrev = b.get_revision(history[-1])
264
 
        print '  latest revision: %s' % format_date(lastrev.timestamp,
265
 
                                                    lastrev.timezone)
266
 
        
267
 
    
268
 
 
269
 
 
270
 
def cmd_remove(file_list, verbose=False):
271
 
    b = Branch(file_list[0])
272
 
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
273
 
 
274
 
 
275
 
 
276
 
def cmd_file_id(filename):
277
 
    b = Branch(filename)
278
 
    i = b.inventory.path2id(b.relpath(filename))
279
 
    if i is None:
280
 
        bailout("%s is not a versioned file" % filename)
281
 
    else:
282
 
        print i
283
 
 
284
 
 
285
 
def cmd_find_filename(fileid):
286
 
    n = find_filename(fileid)
287
 
    if n is None:
288
 
        bailout("%s is not a live file id" % fileid)
289
 
    else:
290
 
        print n
291
 
 
292
 
 
293
 
def cmd_revision_history():
294
 
    for patchid in Branch('.').revision_history():
295
 
        print patchid
296
 
 
297
 
 
298
 
 
299
 
def cmd_init():
300
 
    # TODO: Check we're not already in a working directory?  At the
301
 
    # moment you'll get an ugly error.
302
 
    
303
 
    # TODO: What if we're in a subdirectory of a branch?  Would like
304
 
    # to allow that, but then the parent may need to understand that
305
 
    # the children have disappeared, or should they be versioned in
306
 
    # both?
307
 
 
308
 
    # TODO: Take an argument/option for branch name.
309
 
    Branch('.', init=True)
310
 
 
311
 
 
312
 
def cmd_diff(revision=None):
313
 
    """Show diff from basis to working copy.
314
 
 
315
 
    :todo: Take one or two revision arguments, look up those trees,
316
 
           and diff them.
317
 
 
318
 
    :todo: Allow diff across branches.
319
 
 
320
 
    :todo: Mangle filenames in diff to be more relevant.
321
 
 
322
 
    :todo: Shouldn't be in the cmd function.
323
 
    """
324
 
 
325
 
    b = Branch('.')
326
 
 
327
 
    if revision == None:
328
 
        old_tree = b.basis_tree()
329
 
    else:
330
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
331
 
        
332
 
    new_tree = b.working_tree()
333
 
    old_inv = old_tree.inventory
334
 
    new_inv = new_tree.inventory
335
 
 
336
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
337
 
    old_label = ''
338
 
    new_label = ''
339
 
 
340
 
    DEVNULL = '/dev/null'
341
 
    # Windows users, don't panic about this filename -- it is a
342
 
    # special signal to GNU patch that the file should be created or
343
 
    # deleted respectively.
344
 
 
345
 
    # TODO: Generation of pseudo-diffs for added/deleted files could
346
 
    # be usefully made into a much faster special case.
347
 
 
348
 
    # TODO: Better to return them in sorted order I think.
349
 
    
350
 
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
351
 
        d = None
352
 
 
353
 
        # Don't show this by default; maybe do it if an option is passed
354
 
        # idlabel = '      {%s}' % fid
355
 
        idlabel = ''
356
 
 
357
 
        # FIXME: Something about the diff format makes patch unhappy
358
 
        # with newly-added files.
359
 
 
360
 
        def diffit(*a, **kw):
361
 
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
362
 
            print
363
 
        
364
 
        if file_state in ['.', '?', 'I']:
365
 
            continue
366
 
        elif file_state == 'A':
367
 
            print '*** added %s %r' % (kind, new_name)
368
 
            if kind == 'file':
369
 
                diffit([],
370
 
                       new_tree.get_file(fid).readlines(),
371
 
                       fromfile=DEVNULL,
372
 
                       tofile=new_label + new_name + idlabel)
373
 
        elif file_state == 'D':
374
 
            assert isinstance(old_name, types.StringTypes)
375
 
            print '*** deleted %s %r' % (kind, old_name)
376
 
            if kind == 'file':
377
 
                diffit(old_tree.get_file(fid).readlines(), [],
378
 
                       fromfile=old_label + old_name + idlabel,
379
 
                       tofile=DEVNULL)
380
 
        elif file_state in ['M', 'R']:
381
 
            if file_state == 'M':
382
 
                assert kind == 'file'
383
 
                assert old_name == new_name
384
 
                print '*** modified %s %r' % (kind, new_name)
385
 
            elif file_state == 'R':
386
 
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
387
 
 
388
 
            if kind == 'file':
389
 
                diffit(old_tree.get_file(fid).readlines(),
390
 
                       new_tree.get_file(fid).readlines(),
391
 
                       fromfile=old_label + old_name + idlabel,
392
 
                       tofile=new_label + new_name)
393
 
        else:
394
 
            bailout("can't represent state %s {%s}" % (file_state, fid))
395
 
 
396
 
 
397
 
 
398
 
def cmd_root(filename=None):
399
 
    """Print the branch root."""
400
 
    print bzrlib.branch.find_branch_root(filename)
401
 
    
402
 
 
403
 
def cmd_log(timezone='original'):
 
489
        sc = statcache.update_cache(b, inv)
 
490
        basis = b.basis_tree()
 
491
        basis_inv = basis.inventory
 
492
        
 
493
        # We used to do this through iter_entries(), but that's slow
 
494
        # when most of the files are unmodified, as is usually the
 
495
        # case.  So instead we iterate by inventory entry, and only
 
496
        # calculate paths as necessary.
 
497
 
 
498
        for file_id in basis_inv:
 
499
            cacheentry = sc.get(file_id)
 
500
            if not cacheentry:                 # deleted
 
501
                continue
 
502
            ie = basis_inv[file_id]
 
503
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
504
                path = inv.id2path(file_id)
 
505
                print path
 
506
 
 
507
 
 
508
 
 
509
class cmd_added(Command):
 
510
    """List files added in working tree."""
 
511
    hidden = True
 
512
    def run(self):
 
513
        b = Branch('.')
 
514
        wt = b.working_tree()
 
515
        basis_inv = b.basis_tree().inventory
 
516
        inv = wt.inventory
 
517
        for file_id in inv:
 
518
            if file_id in basis_inv:
 
519
                continue
 
520
            path = inv.id2path(file_id)
 
521
            if not os.access(b.abspath(path), os.F_OK):
 
522
                continue
 
523
            print path
 
524
                
 
525
        
 
526
 
 
527
class cmd_root(Command):
 
528
    """Show the tree root directory.
 
529
 
 
530
    The root is the nearest enclosing directory with a .bzr control
 
531
    directory."""
 
532
    takes_args = ['filename?']
 
533
    def run(self, filename=None):
 
534
        """Print the branch root."""
 
535
        from branch import find_branch
 
536
        b = find_branch(filename)
 
537
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
538
 
 
539
 
 
540
class cmd_log(Command):
404
541
    """Show log of this branch.
405
542
 
406
 
    :todo: Options for utc; to show ids; to limit range; etc.
 
543
    TODO: Option to limit range.
 
544
 
 
545
    TODO: Perhaps show most-recent first with an option for last.
407
546
    """
408
 
    Branch('.').write_log(show_timezone=timezone)
409
 
 
410
 
 
411
 
def cmd_ls(revision=None, verbose=False):
 
547
    takes_args = ['filename?']
 
548
    takes_options = ['timezone', 'verbose', 'show-ids']
 
549
    def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
 
550
        from branch import find_branch
 
551
        b = find_branch((filename or '.'), lock_mode='r')
 
552
        if filename:
 
553
            filename = b.relpath(filename)
 
554
        bzrlib.show_log(b, filename,
 
555
                        show_timezone=timezone,
 
556
                        verbose=verbose,
 
557
                        show_ids=show_ids)
 
558
 
 
559
 
 
560
 
 
561
class cmd_touching_revisions(Command):
 
562
    """Return revision-ids which affected a particular file."""
 
563
    hidden = True
 
564
    takes_args = ["filename"]
 
565
    def run(self, filename):
 
566
        b = Branch(filename, lock_mode='r')
 
567
        inv = b.read_working_inventory()
 
568
        file_id = inv.path2id(b.relpath(filename))
 
569
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
570
            print "%6d %s" % (revno, what)
 
571
 
 
572
 
 
573
class cmd_ls(Command):
412
574
    """List files in a tree.
413
575
 
414
 
    :todo: Take a revision or remote path and list that tree instead.
 
576
    TODO: Take a revision or remote path and list that tree instead.
415
577
    """
416
 
    b = Branch('.')
417
 
    if revision == None:
418
 
        tree = b.working_tree()
419
 
    else:
420
 
        tree = b.revision_tree(b.lookup_revision(revision))
421
 
        
422
 
    for fp, fc, kind, fid in tree.list_files():
423
 
        if verbose:
424
 
            if kind == 'directory':
425
 
                kindch = '/'
426
 
            elif kind == 'file':
427
 
                kindch = ''
 
578
    hidden = True
 
579
    def run(self, revision=None, verbose=False):
 
580
        b = Branch('.')
 
581
        if revision == None:
 
582
            tree = b.working_tree()
 
583
        else:
 
584
            tree = b.revision_tree(b.lookup_revision(revision))
 
585
 
 
586
        for fp, fc, kind, fid in tree.list_files():
 
587
            if verbose:
 
588
                if kind == 'directory':
 
589
                    kindch = '/'
 
590
                elif kind == 'file':
 
591
                    kindch = ''
 
592
                else:
 
593
                    kindch = '???'
 
594
 
 
595
                print '%-8s %s%s' % (fc, fp, kindch)
428
596
            else:
429
 
                kindch = '???'
430
 
                
431
 
            print '%-8s %s%s' % (fc, fp, kindch)
432
 
        else:
433
 
            print fp
434
 
    
435
 
    
436
 
 
437
 
def cmd_unknowns():
 
597
                print fp
 
598
 
 
599
 
 
600
 
 
601
class cmd_unknowns(Command):
438
602
    """List unknown files"""
439
 
    for f in Branch('.').unknowns():
440
 
        print quotefn(f)
441
 
 
442
 
 
443
 
def cmd_lookup_revision(revno):
444
 
    try:
445
 
        revno = int(revno)
446
 
    except ValueError:
447
 
        bailout("usage: lookup-revision REVNO",
448
 
                ["REVNO is a non-negative revision number for this branch"])
449
 
 
450
 
    print Branch('.').lookup_revision(revno) or NONE_STRING
451
 
 
452
 
 
453
 
 
454
 
def cmd_export(revno, dest):
455
 
    """Export past revision to destination directory."""
456
 
    b = Branch('.')
457
 
    rh = b.lookup_revision(int(revno))
458
 
    t = b.revision_tree(rh)
459
 
    t.export(dest)
460
 
 
461
 
 
462
 
 
463
 
######################################################################
464
 
# internal/test commands
465
 
 
466
 
 
467
 
def cmd_uuid():
468
 
    """Print a newly-generated UUID."""
469
 
    print bzrlib.osutils.uuid()
470
 
 
471
 
 
472
 
 
473
 
def cmd_local_time_offset():
474
 
    print bzrlib.osutils.local_time_offset()
475
 
 
476
 
 
477
 
 
478
 
def cmd_commit(message=None, verbose=False):
479
 
    if not message:
480
 
        bailout("please specify a commit message")
481
 
    Branch('.').commit(message, verbose=verbose)
482
 
 
483
 
 
484
 
def cmd_check():
485
 
    """Check consistency of the branch."""
486
 
    check()
487
 
 
488
 
 
489
 
def cmd_is(pred, *rest):
490
 
    """Test whether PREDICATE is true."""
491
 
    try:
492
 
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
493
 
    except KeyError:
494
 
        bailout("unknown predicate: %s" % quotefn(pred))
 
603
    def run(self):
 
604
        for f in Branch('.').unknowns():
 
605
            print quotefn(f)
 
606
 
 
607
 
 
608
 
 
609
class cmd_ignore(Command):
 
610
    """Ignore a command or pattern
 
611
 
 
612
    To remove patterns from the ignore list, edit the .bzrignore file.
 
613
 
 
614
    If the pattern contains a slash, it is compared to the whole path
 
615
    from the branch root.  Otherwise, it is comapred to only the last
 
616
    component of the path.
 
617
 
 
618
    Ignore patterns are case-insensitive on case-insensitive systems.
 
619
 
 
620
    Note: wildcards must be quoted from the shell on Unix.
 
621
 
 
622
    examples:
 
623
        bzr ignore ./Makefile
 
624
        bzr ignore '*.class'
 
625
    """
 
626
    takes_args = ['name_pattern']
 
627
    
 
628
    def run(self, name_pattern):
 
629
        from bzrlib.atomicfile import AtomicFile
 
630
        import codecs
 
631
 
 
632
        b = Branch('.')
 
633
        ifn = b.abspath('.bzrignore')
 
634
 
 
635
        # FIXME: probably doesn't handle non-ascii patterns
 
636
 
 
637
        if os.path.exists(ifn):
 
638
            f = b.controlfile(ifn, 'rt')
 
639
            igns = f.read()
 
640
            f.close()
 
641
        else:
 
642
            igns = ''
 
643
 
 
644
        if igns and igns[-1] != '\n':
 
645
            igns += '\n'
 
646
        igns += name_pattern + '\n'
 
647
 
 
648
        f = AtomicFile(ifn, 'wt')
 
649
        f.write(igns)
 
650
        f.commit()
 
651
 
 
652
        inv = b.working_tree().inventory
 
653
        if inv.path2id('.bzrignore'):
 
654
            mutter('.bzrignore is already versioned')
 
655
        else:
 
656
            mutter('need to make new .bzrignore file versioned')
 
657
            b.add(['.bzrignore'])
 
658
 
 
659
 
 
660
 
 
661
class cmd_ignored(Command):
 
662
    """List ignored files and the patterns that matched them.
 
663
 
 
664
    See also: bzr ignore"""
 
665
    def run(self):
 
666
        tree = Branch('.').working_tree()
 
667
        for path, file_class, kind, file_id in tree.list_files():
 
668
            if file_class != 'I':
 
669
                continue
 
670
            ## XXX: Slightly inefficient since this was already calculated
 
671
            pat = tree.is_ignored(path)
 
672
            print '%-50s %s' % (path, pat)
 
673
 
 
674
 
 
675
class cmd_lookup_revision(Command):
 
676
    """Lookup the revision-id from a revision-number
 
677
 
 
678
    example:
 
679
        bzr lookup-revision 33
 
680
    """
 
681
    hidden = True
 
682
    takes_args = ['revno']
 
683
    
 
684
    def run(self, revno):
 
685
        try:
 
686
            revno = int(revno)
 
687
        except ValueError:
 
688
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
689
 
 
690
        print Branch('.').lookup_revision(revno)
 
691
 
 
692
 
 
693
class cmd_export(Command):
 
694
    """Export past revision to destination directory.
 
695
 
 
696
    If no revision is specified this exports the last committed revision."""
 
697
    takes_args = ['dest']
 
698
    takes_options = ['revision']
 
699
    def run(self, dest, revision=None):
 
700
        b = Branch('.')
 
701
        if revision == None:
 
702
            rh = b.revision_history()[-1]
 
703
        else:
 
704
            rh = b.lookup_revision(int(revision))
 
705
        t = b.revision_tree(rh)
 
706
        t.export(dest)
 
707
 
 
708
 
 
709
class cmd_cat(Command):
 
710
    """Write a file's text from a previous revision."""
 
711
 
 
712
    takes_options = ['revision']
 
713
    takes_args = ['filename']
 
714
 
 
715
    def run(self, filename, revision=None):
 
716
        if revision == None:
 
717
            raise BzrCommandError("bzr cat requires a revision number")
 
718
        b = Branch('.')
 
719
        b.print_file(b.relpath(filename), int(revision))
 
720
 
 
721
 
 
722
class cmd_local_time_offset(Command):
 
723
    """Show the offset in seconds from GMT to local time."""
 
724
    hidden = True    
 
725
    def run(self):
 
726
        print bzrlib.osutils.local_time_offset()
 
727
 
 
728
 
 
729
 
 
730
class cmd_commit(Command):
 
731
    """Commit changes into a new revision.
 
732
 
 
733
    TODO: Commit only selected files.
 
734
 
 
735
    TODO: Run hooks on tree to-be-committed, and after commit.
 
736
 
 
737
    TODO: Strict commit that fails if there are unknown or deleted files.
 
738
    """
 
739
    takes_options = ['message', 'file', 'verbose']
 
740
    aliases = ['ci', 'checkin']
 
741
 
 
742
    def run(self, message=None, file=None, verbose=False):
 
743
        ## Warning: shadows builtin file()
 
744
        if not message and not file:
 
745
            raise BzrCommandError("please specify a commit message",
 
746
                                  ["use either --message or --file"])
 
747
        elif message and file:
 
748
            raise BzrCommandError("please specify either --message or --file")
495
749
        
496
 
    try:
497
 
        cmd_handler(*rest)
498
 
    except BzrCheckError:
499
 
        # by default we don't print the message so that this can
500
 
        # be used from shell scripts without producing noise
501
 
        sys.exit(1)
502
 
 
503
 
 
504
 
def cmd_username():
505
 
    print bzrlib.osutils.username()
506
 
 
507
 
 
508
 
def cmd_user_email():
509
 
    print bzrlib.osutils.user_email()
510
 
 
511
 
 
512
 
def cmd_gen_revision_id():
513
 
    import time
514
 
    print bzrlib.branch._gen_revision_id(time.time())
515
 
 
516
 
 
517
 
def cmd_selftest(verbose=False):
 
750
        if file:
 
751
            import codecs
 
752
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
753
 
 
754
        Branch('.').commit(message, verbose=verbose)
 
755
 
 
756
 
 
757
class cmd_check(Command):
 
758
    """Validate consistency of branch history.
 
759
 
 
760
    This command checks various invariants about the branch storage to
 
761
    detect data corruption or bzr bugs.
 
762
    """
 
763
    takes_args = ['dir?']
 
764
    def run(self, dir='.'):
 
765
        import bzrlib.check
 
766
        bzrlib.check.check(Branch(dir, find_root=False))
 
767
 
 
768
 
 
769
 
 
770
class cmd_whoami(Command):
 
771
    """Show bzr user id."""
 
772
    takes_options = ['email']
 
773
    
 
774
    def run(self, email=False):
 
775
        if email:
 
776
            print bzrlib.osutils.user_email()
 
777
        else:
 
778
            print bzrlib.osutils.username()
 
779
 
 
780
 
 
781
class cmd_selftest(Command):
518
782
    """Run internal test suite"""
519
 
    ## -v, if present, is seen by doctest; the argument is just here
520
 
    ## so our parser doesn't complain
521
 
 
522
 
    ## TODO: --verbose option
523
 
 
524
 
    failures, tests = 0, 0
525
 
    
526
 
    import doctest, bzrlib.store, bzrlib.tests
527
 
    bzrlib.trace.verbose = False
528
 
 
529
 
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
530
 
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
531
 
        mf, mt = doctest.testmod(m)
532
 
        failures += mf
533
 
        tests += mt
534
 
        print '%-40s %3d tests' % (m.__name__, mt),
535
 
        if mf:
536
 
            print '%3d FAILED!' % mf
 
783
    hidden = True
 
784
    def run(self):
 
785
        failures, tests = 0, 0
 
786
 
 
787
        import doctest, bzrlib.store, bzrlib.tests
 
788
        bzrlib.trace.verbose = False
 
789
 
 
790
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
791
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
792
            mf, mt = doctest.testmod(m)
 
793
            failures += mf
 
794
            tests += mt
 
795
            print '%-40s %3d tests' % (m.__name__, mt),
 
796
            if mf:
 
797
                print '%3d FAILED!' % mf
 
798
            else:
 
799
                print
 
800
 
 
801
        print '%-40s %3d tests' % ('total', tests),
 
802
        if failures:
 
803
            print '%3d FAILED!' % failures
537
804
        else:
538
805
            print
539
806
 
540
 
    print '%-40s %3d tests' % ('total', tests),
541
 
    if failures:
542
 
        print '%3d FAILED!' % failures
543
 
    else:
544
 
        print
545
 
 
546
 
 
547
 
 
548
 
# deprecated
549
 
cmd_doctest = cmd_selftest
550
 
 
551
 
 
552
 
######################################################################
553
 
# help
554
 
 
555
 
 
556
 
def cmd_help():
557
 
    # TODO: Specific help for particular commands
558
 
    print __doc__
559
 
 
560
 
 
561
 
def cmd_version():
562
 
    print "bzr (bazaar-ng) %s" % __version__
563
 
    print __copyright__
 
807
 
 
808
 
 
809
class cmd_version(Command):
 
810
    """Show version of bzr"""
 
811
    def run(self):
 
812
        show_version()
 
813
 
 
814
def show_version():
 
815
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
816
    print bzrlib.__copyright__
564
817
    print "http://bazaar-ng.org/"
565
818
    print
566
 
    print \
567
 
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
568
 
you may use, modify and redistribute it under the terms of the GNU 
569
 
General Public License version 2 or later."""
570
 
 
571
 
 
572
 
def cmd_rocks():
 
819
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
820
    print "you may use, modify and redistribute it under the terms of the GNU"
 
821
    print "General Public License version 2 or later."
 
822
 
 
823
 
 
824
class cmd_rocks(Command):
573
825
    """Statement of optimism."""
574
 
    print "it sure does!"
575
 
 
 
826
    hidden = True
 
827
    def run(self):
 
828
        print "it sure does!"
 
829
 
 
830
 
 
831
class cmd_assert_fail(Command):
 
832
    """Test reporting of assertion failures"""
 
833
    hidden = True
 
834
    def run(self):
 
835
        assert False, "always fails"
 
836
 
 
837
 
 
838
class cmd_help(Command):
 
839
    """Show help on a command or other topic.
 
840
 
 
841
    For a list of all available commands, say 'bzr help commands'."""
 
842
    takes_args = ['topic?']
 
843
    aliases = ['?']
 
844
    
 
845
    def run(self, topic=None):
 
846
        import help
 
847
        help.help(topic)
 
848
 
 
849
 
 
850
class cmd_update_stat_cache(Command):
 
851
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
852
 
 
853
    For testing only."""
 
854
    hidden = True
 
855
    def run(self):
 
856
        import statcache
 
857
        b = Branch('.')
 
858
        statcache.update_cache(b)
576
859
 
577
860
 
578
861
######################################################################
585
868
OPTIONS = {
586
869
    'all':                    None,
587
870
    'help':                   None,
 
871
    'file':                   unicode,
588
872
    'message':                unicode,
 
873
    'profile':                None,
589
874
    'revision':               int,
590
875
    'show-ids':               None,
591
876
    'timezone':               str,
592
877
    'verbose':                None,
593
878
    'version':                None,
 
879
    'email':                  None,
594
880
    }
595
881
 
596
882
SHORT_OPTIONS = {
597
883
    'm':                      'message',
 
884
    'F':                      'file', 
598
885
    'r':                      'revision',
599
886
    'v':                      'verbose',
600
887
}
601
888
 
602
 
# List of options that apply to particular commands; commands not
603
 
# listed take none.
604
 
cmd_options = {
605
 
    'add':                    ['verbose'],
606
 
    'commit':                 ['message', 'verbose'],
607
 
    'diff':                   ['revision'],
608
 
    'inventory':              ['revision'],
609
 
    'log':                    ['show-ids', 'timezone'],
610
 
    'ls':                     ['revision', 'verbose'],
611
 
    'remove':                 ['verbose'],
612
 
    'status':                 ['all'],
613
 
    }
614
 
 
615
 
 
616
 
cmd_args = {
617
 
    'init':                   [],
618
 
    'add':                    ['file+'],
619
 
    'commit':                 [],
620
 
    'diff':                   [],
621
 
    'file-id':                ['filename'],
622
 
    'root':                   ['filename?'],
623
 
    'relpath':                ['filename'],
624
 
    'get-file-text':          ['text_id'],
625
 
    'get-inventory':          ['inventory_id'],
626
 
    'get-revision':           ['revision_id'],
627
 
    'get-revision-inventory': ['revision_id'],
628
 
    'log':                    [],
629
 
    'lookup-revision':        ['revno'],
630
 
    'export':                 ['revno', 'dest'],
631
 
    'remove':                 ['file+'],
632
 
    'status':                 [],
633
 
    }
634
 
 
635
889
 
636
890
def parse_args(argv):
637
891
    """Parse command line.
658
912
    while argv:
659
913
        a = argv.pop(0)
660
914
        if a[0] == '-':
 
915
            # option names must not be unicode
 
916
            a = str(a)
661
917
            optarg = None
662
918
            if a[1] == '-':
663
919
                mutter("  got option %r" % a)
685
941
                    else:
686
942
                        optarg = argv.pop(0)
687
943
                opts[optname] = optargfn(optarg)
688
 
                mutter("    option argument %r" % opts[optname])
689
944
            else:
690
945
                if optarg != None:
691
946
                    bailout('option %r takes no argument' % optname)
697
952
 
698
953
 
699
954
 
700
 
def _match_args(cmd, args):
701
 
    """Check non-option arguments match required pattern.
702
955
 
703
 
    >>> _match_args('status', ['asdasdsadasd'])
704
 
    Traceback (most recent call last):
705
 
    ...
706
 
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
707
 
    >>> _match_args('add', ['asdasdsadasd'])
708
 
    {'file_list': ['asdasdsadasd']}
709
 
    >>> _match_args('add', 'abc def gj'.split())
710
 
    {'file_list': ['abc', 'def', 'gj']}
711
 
    """
712
 
    # match argument pattern
713
 
    argform = cmd_args.get(cmd, [])
 
956
def _match_argform(cmd, takes_args, args):
714
957
    argdict = {}
715
 
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
716
 
    # all but one.
717
958
 
718
 
    # step through args and argform, allowing appropriate 0-many matches
719
 
    for ap in argform:
 
959
    # step through args and takes_args, allowing appropriate 0-many matches
 
960
    for ap in takes_args:
720
961
        argname = ap[:-1]
721
962
        if ap[-1] == '?':
722
963
            if args:
723
964
                argdict[argname] = args.pop(0)
724
 
        elif ap[-1] == '*':
725
 
            assert 0
 
965
        elif ap[-1] == '*': # all remaining arguments
 
966
            if args:
 
967
                argdict[argname + '_list'] = args[:]
 
968
                args = []
 
969
            else:
 
970
                argdict[argname + '_list'] = None
726
971
        elif ap[-1] == '+':
727
972
            if not args:
728
 
                bailout("command %r needs one or more %s"
 
973
                raise BzrCommandError("command %r needs one or more %s"
729
974
                        % (cmd, argname.upper()))
730
975
            else:
731
976
                argdict[argname + '_list'] = args[:]
732
977
                args = []
 
978
        elif ap[-1] == '$': # all but one
 
979
            if len(args) < 2:
 
980
                raise BzrCommandError("command %r needs one or more %s"
 
981
                        % (cmd, argname.upper()))
 
982
            argdict[argname + '_list'] = args[:-1]
 
983
            args[:-1] = []                
733
984
        else:
734
985
            # just a plain arg
735
986
            argname = ap
736
987
            if not args:
737
 
                bailout("command %r requires argument %s"
 
988
                raise BzrCommandError("command %r requires argument %s"
738
989
                        % (cmd, argname.upper()))
739
990
            else:
740
991
                argdict[argname] = args.pop(0)
741
992
            
742
993
    if args:
743
 
        bailout("extra arguments to command %s: %r"
744
 
                % (cmd, args))
 
994
        raise BzrCommandError("extra argument to command %s: %s"
 
995
                              % (cmd, args[0]))
745
996
 
746
997
    return argdict
747
998
 
751
1002
    """Execute a command.
752
1003
 
753
1004
    This is similar to main(), but without all the trappings for
754
 
    logging and error handling.
 
1005
    logging and error handling.  
755
1006
    """
 
1007
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1008
    
756
1009
    try:
757
1010
        args, opts = parse_args(argv[1:])
758
1011
        if 'help' in opts:
759
 
            # TODO: pass down other arguments in case they asked for
760
 
            # help on a command name?
761
 
            cmd_help()
 
1012
            import help
 
1013
            if args:
 
1014
                help.help(args[0])
 
1015
            else:
 
1016
                help.help()
762
1017
            return 0
763
1018
        elif 'version' in opts:
764
 
            cmd_version()
 
1019
            show_version()
765
1020
            return 0
766
 
        cmd = args.pop(0)
 
1021
        cmd = str(args.pop(0))
767
1022
    except IndexError:
768
 
        log_error('usage: bzr COMMAND\n')
769
 
        log_error('  try "bzr help"\n')
 
1023
        log_error('usage: bzr COMMAND')
 
1024
        log_error('  try "bzr help"')
770
1025
        return 1
771
 
            
772
 
    try:
773
 
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
774
 
    except KeyError:
775
 
        bailout("unknown command " + `cmd`)
776
 
 
777
 
    # TODO: special --profile option to turn on the Python profiler
 
1026
 
 
1027
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
1028
 
 
1029
    # global option
 
1030
    if 'profile' in opts:
 
1031
        profile = True
 
1032
        del opts['profile']
 
1033
    else:
 
1034
        profile = False
778
1035
 
779
1036
    # check options are reasonable
780
 
    allowed = cmd_options.get(cmd, [])
 
1037
    allowed = cmd_class.takes_options
781
1038
    for oname in opts:
782
1039
        if oname not in allowed:
783
 
            bailout("option %r is not allowed for command %r"
784
 
                    % (oname, cmd))
785
 
 
786
 
    cmdargs = _match_args(cmd, args)
787
 
    cmdargs.update(opts)
788
 
 
789
 
    ret = cmd_handler(**cmdargs) or 0
 
1040
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1041
                                  % (oname, cmd))
 
1042
 
 
1043
    # mix arguments and options into one dictionary
 
1044
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1045
    cmdopts = {}
 
1046
    for k, v in opts.items():
 
1047
        cmdopts[k.replace('-', '_')] = v
 
1048
 
 
1049
    if profile:
 
1050
        import hotshot, tempfile
 
1051
        pffileno, pfname = tempfile.mkstemp()
 
1052
        try:
 
1053
            prof = hotshot.Profile(pfname)
 
1054
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1055
            prof.close()
 
1056
 
 
1057
            import hotshot.stats
 
1058
            stats = hotshot.stats.load(pfname)
 
1059
            #stats.strip_dirs()
 
1060
            stats.sort_stats('time')
 
1061
            ## XXX: Might like to write to stderr or the trace file instead but
 
1062
            ## print_stats seems hardcoded to stdout
 
1063
            stats.print_stats(20)
 
1064
            
 
1065
            return ret.status
 
1066
 
 
1067
        finally:
 
1068
            os.close(pffileno)
 
1069
            os.remove(pfname)
 
1070
    else:
 
1071
        cmdobj = cmd_class(cmdopts, cmdargs).status 
 
1072
 
 
1073
 
 
1074
def _report_exception(summary, quiet=False):
 
1075
    import traceback
 
1076
    log_error('bzr: ' + summary)
 
1077
    bzrlib.trace.log_exception()
 
1078
 
 
1079
    if not quiet:
 
1080
        tb = sys.exc_info()[2]
 
1081
        exinfo = traceback.extract_tb(tb)
 
1082
        if exinfo:
 
1083
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1084
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
790
1085
 
791
1086
 
792
1087
 
793
1088
def main(argv):
794
 
    ## TODO: Handle command-line options; probably know what options are valid for
795
 
    ## each command
796
 
 
797
 
    ## TODO: If the arguments are wrong, give a usage message rather
798
 
    ## than just a backtrace.
799
 
 
800
 
    bzrlib.trace.create_tracefile(argv)
 
1089
    import errno
801
1090
    
 
1091
    bzrlib.open_tracefile(argv)
 
1092
 
802
1093
    try:
803
 
        ret = run_bzr(argv)
804
 
        return ret
805
 
    except BzrError, e:
806
 
        log_error('bzr: error: ' + e.args[0] + '\n')
807
 
        if len(e.args) > 1:
808
 
            for h in e.args[1]:
809
 
                log_error('  ' + h + '\n')
810
 
        return 1
811
 
    except Exception, e:
812
 
        log_error('bzr: exception: %s\n' % e)
813
 
        log_error('    see .bzr.log for details\n')
814
 
        traceback.print_exc(None, bzrlib.trace._tracefile)
815
 
        traceback.print_exc(None, sys.stderr)
816
 
        return 1
817
 
 
818
 
    # TODO: Maybe nicer handling of IOError?
819
 
 
 
1094
        try:
 
1095
            try:
 
1096
                return run_bzr(argv)
 
1097
            finally:
 
1098
                # do this here inside the exception wrappers to catch EPIPE
 
1099
                sys.stdout.flush()
 
1100
        except BzrError, e:
 
1101
            quiet = isinstance(e, (BzrCommandError))
 
1102
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1103
            if len(e.args) > 1:
 
1104
                for h in e.args[1]:
 
1105
                    # some explanation or hints
 
1106
                    log_error('  ' + h)
 
1107
            return 1
 
1108
        except AssertionError, e:
 
1109
            msg = 'assertion failed'
 
1110
            if str(e):
 
1111
                msg += ': ' + str(e)
 
1112
            _report_exception(msg)
 
1113
            return 2
 
1114
        except KeyboardInterrupt, e:
 
1115
            _report_exception('interrupted', quiet=True)
 
1116
            return 2
 
1117
        except Exception, e:
 
1118
            quiet = False
 
1119
            if (isinstance(e, IOError) 
 
1120
                and hasattr(e, 'errno')
 
1121
                and e.errno == errno.EPIPE):
 
1122
                quiet = True
 
1123
                msg = 'broken pipe'
 
1124
            else:
 
1125
                msg = str(e).rstrip('\n')
 
1126
            _report_exception(msg, quiet)
 
1127
            return 2
 
1128
    finally:
 
1129
        bzrlib.trace.close_trace()
820
1130
 
821
1131
 
822
1132
if __name__ == '__main__':
823
1133
    sys.exit(main(sys.argv))
824
 
    ##import profile
825
 
    ##profile.run('main(sys.argv)')
826