~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzr.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 07:14:22 UTC
  • Revision ID: mbp@sourcefrog.net-20050309071421-eb5d3514d415bc4c
write inventory to temporary file and atomically replace

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