~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-03-14 02:57:37 UTC
  • Revision ID: mbp@sourcefrog.net-20050314025737-55eb441f430ab4ba
make doc index consistent with new web page

Show diffs side-by-side

added added

removed removed

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