~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 04:08:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050309040815-13242001617e4a06
import from baz patch-364

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
20
82
from sets import Set
 
83
from pprint import pprint
 
84
from stat import *
 
85
from glob import glob
 
86
from ElementTree import Element, ElementTree, SubElement
21
87
 
22
88
import bzrlib
 
89
from bzrlib.store import ImmutableStore
23
90
from bzrlib.trace import mutter, note, log_error
24
 
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
91
from bzrlib.errors import bailout, BzrError
25
92
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
26
 
from bzrlib.tree import RevisionTree, EmptyTree, Tree
 
93
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
27
94
from bzrlib.revision import Revision
28
95
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
29
96
     format_date
30
97
 
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):
 
98
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
 
99
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
 
100
 
 
101
## standard representation
 
102
NONE_STRING = '(none)'
 
103
EMPTY = 'empty'
 
104
 
 
105
 
 
106
## TODO: Perhaps a different version of inventory commands that
 
107
## returns iterators...
 
108
 
 
109
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
 
110
 
 
111
## TODO: Some kind of locking on branches.  Perhaps there should be a
 
112
## parameter to the branch object saying whether we want a read or
 
113
## write lock; release it from destructor.  Perhaps don't even need a
 
114
## read lock to look at immutable objects?
 
115
 
 
116
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
 
117
## to compare output?
 
118
 
 
119
## TODO: Is ElementTree really all that much better for our purposes?
 
120
## Perhaps using the standard MiniDOM would be enough?
 
121
 
 
122
 
 
123
 
 
124
 
 
125
 
 
126
 
 
127
######################################################################
 
128
# check status
 
129
 
 
130
 
 
131
def cmd_status(all=False):
190
132
    """Display status summary.
191
133
 
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('.')
 
134
    For each file there is a single line giving its file state and name.
 
135
    The name is that in the current revision unless it is deleted or
 
136
    missing, in which case the old name is shown.
 
137
 
 
138
    :todo: Don't show unchanged files unless ``--all`` is given?
 
139
    """
 
140
    Branch('.').show_status(show_all=all)
 
141
 
 
142
 
 
143
 
 
144
######################################################################
 
145
# examining history
 
146
def cmd_get_revision(revision_id):
 
147
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
148
 
 
149
 
 
150
def cmd_get_inventory(inventory_id):
 
151
    """Return inventory in XML by hash"""
 
152
    Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
 
153
 
 
154
 
 
155
def cmd_get_revision_inventory(revision_id):
 
156
    """Output inventory for a revision."""
 
157
    b = Branch('.')
 
158
    b.get_revision_inventory(revision_id).write_xml(sys.stdout)
 
159
 
 
160
 
 
161
def cmd_get_file_text(text_id):
 
162
    """Get contents of a file by hash."""
 
163
    sf = Branch('.').text_store[text_id]
 
164
    pumpfile(sf, sys.stdout)
 
165
 
 
166
 
 
167
 
 
168
######################################################################
 
169
# commands
 
170
    
 
171
 
 
172
def cmd_revno():
 
173
    """Show number of revisions on this branch"""
 
174
    print Branch('.').revno()
 
175
    
 
176
 
 
177
def cmd_add(file_list, verbose=False):
 
178
    """Add specified files.
 
179
    
 
180
    Fails if the files are already added.
 
181
    """
 
182
    Branch('.').add(file_list, verbose=verbose)
 
183
 
 
184
 
 
185
def cmd_inventory(revision=None):
 
186
    """Show inventory of the current working copy."""
 
187
    ## TODO: Also optionally show a previous inventory
 
188
    ## TODO: Format options
 
189
    b = Branch('.')
 
190
    if revision == None:
532
191
        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):
 
192
    else:
 
193
        inv = b.get_revision_inventory(b.lookup_revision(revision))
 
194
        
 
195
    for path, entry in inv.iter_entries():
 
196
        print '%-50s %s' % (entry.file_id, path)
 
197
 
 
198
 
 
199
 
 
200
def cmd_info():
 
201
    b = Branch('.')
 
202
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
 
203
    print 'revision number:', b.revno()
 
204
    print 'number of versioned files:', len(b.read_working_inventory())
 
205
 
 
206
 
 
207
def cmd_remove(file_list, verbose=False):
 
208
    Branch('.').remove(file_list, verbose=verbose)
 
209
 
 
210
 
 
211
 
 
212
def cmd_file_id(filename):
 
213
    i = Branch('.').read_working_inventory().path2id(filename)
 
214
    if i is None:
 
215
        bailout("%s is not a versioned file" % filename)
 
216
    else:
 
217
        print i
 
218
 
 
219
 
 
220
def cmd_find_filename(fileid):
 
221
    n = find_filename(fileid)
 
222
    if n is None:
 
223
        bailout("%s is not a live file id" % fileid)
 
224
    else:
 
225
        print n
 
226
 
 
227
 
 
228
def cmd_revision_history():
 
229
    for patchid in Branch('.').revision_history():
 
230
        print patchid
 
231
 
 
232
 
 
233
 
 
234
def cmd_init():
 
235
    # TODO: Check we're not already in a working directory?  At the
 
236
    # moment you'll get an ugly error.
 
237
    
 
238
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
239
    # to allow that, but then the parent may need to understand that
 
240
    # the children have disappeared, or should they be versioned in
 
241
    # both?
 
242
 
 
243
    # TODO: Take an argument/option for branch name.
 
244
    Branch('.', init=True)
 
245
 
 
246
 
 
247
def cmd_diff(revision=None):
 
248
    """Show diff from basis to working copy.
 
249
 
 
250
    :todo: Take one or two revision arguments, look up those trees,
 
251
           and diff them.
 
252
 
 
253
    :todo: Allow diff across branches.
 
254
 
 
255
    :todo: Mangle filenames in diff to be more relevant.
 
256
 
 
257
    :todo: Shouldn't be in the cmd function.
 
258
    """
 
259
 
 
260
    b = Branch('.')
 
261
 
 
262
    if revision == None:
 
263
        old_tree = b.basis_tree()
 
264
    else:
 
265
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
266
        
 
267
    new_tree = b.working_tree()
 
268
    old_inv = old_tree.inventory
 
269
    new_inv = new_tree.inventory
 
270
 
 
271
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
272
    old_label = ''
 
273
    new_label = ''
 
274
 
 
275
    DEVNULL = '/dev/null'
 
276
    # Windows users, don't panic about this filename -- it is a
 
277
    # special signal to GNU patch that the file should be created or
 
278
    # deleted respectively.
 
279
 
 
280
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
281
    # be usefully made into a much faster special case.
 
282
 
 
283
    # TODO: Better to return them in sorted order I think.
 
284
    
 
285
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
286
        d = None
 
287
 
 
288
        # Don't show this by default; maybe do it if an option is passed
 
289
        # idlabel = '      {%s}' % fid
 
290
        idlabel = ''
 
291
 
 
292
        # FIXME: Something about the diff format makes patch unhappy
 
293
        # with newly-added files.
 
294
 
 
295
        def diffit(*a, **kw):
 
296
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
 
297
            print
 
298
        
 
299
        if file_state in ['.', '?', 'I']:
 
300
            continue
 
301
        elif file_state == 'A':
 
302
            print '*** added %s %r' % (kind, new_name)
 
303
            if kind == 'file':
 
304
                diffit([],
 
305
                       new_tree.get_file(fid).readlines(),
 
306
                       fromfile=DEVNULL,
 
307
                       tofile=new_label + new_name + idlabel)
 
308
        elif file_state == 'D':
 
309
            assert isinstance(old_name, types.StringTypes)
 
310
            print '*** deleted %s %r' % (kind, old_name)
 
311
            if kind == 'file':
 
312
                diffit(old_tree.get_file(fid).readlines(), [],
 
313
                       fromfile=old_label + old_name + idlabel,
 
314
                       tofile=DEVNULL)
 
315
        elif file_state in ['M', 'R']:
 
316
            if file_state == 'M':
 
317
                assert kind == 'file'
 
318
                assert old_name == new_name
 
319
                print '*** modified %s %r' % (kind, new_name)
 
320
            elif file_state == 'R':
 
321
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
322
 
 
323
            if kind == 'file':
 
324
                diffit(old_tree.get_file(fid).readlines(),
 
325
                       new_tree.get_file(fid).readlines(),
 
326
                       fromfile=old_label + old_name + idlabel,
 
327
                       tofile=new_label + new_name)
 
328
        else:
 
329
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
330
 
 
331
 
 
332
 
 
333
def cmd_log():
585
334
    """Show log of this branch.
586
335
 
587
 
    TODO: Option to limit range.
588
 
 
589
 
    TODO: Perhaps show most-recent first with an option for last.
 
336
    :todo: Options for utc; to show ids; to limit range; etc.
590
337
    """
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):
 
338
    Branch('.').write_log()
 
339
 
 
340
 
 
341
def cmd_ls(revision=None, verbose=False):
618
342
    """List files in a tree.
619
343
 
620
 
    TODO: Take a revision or remote path and list that tree instead.
 
344
    :todo: Take a revision or remote path and list that tree instead.
621
345
    """
622
 
    hidden = True
623
 
    def run(self, revision=None, verbose=False):
624
 
        b = Branch('.')
625
 
        if revision == None:
626
 
            tree = b.working_tree()
 
346
    b = Branch('.')
 
347
    if revision == None:
 
348
        tree = b.working_tree()
 
349
    else:
 
350
        tree = b.revision_tree(b.lookup_revision(revision))
 
351
        
 
352
    for fp, fc, kind, fid in tree.list_files():
 
353
        if verbose:
 
354
            if kind == 'directory':
 
355
                kindch = '/'
 
356
            elif kind == 'file':
 
357
                kindch = ''
 
358
            else:
 
359
                kindch = '???'
 
360
                
 
361
            print '%-8s %s%s' % (fc, fp, kindch)
627
362
        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):
 
363
            print fp
 
364
    
 
365
    
 
366
 
 
367
def cmd_unknowns():
646
368
    """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
 
    If selected files are specified, only changes to those files are
778
 
    committed.  If a directory is specified then its contents are also
779
 
    committed.
780
 
 
781
 
    A selected-file commit may fail in some cases where the committed
782
 
    tree would be invalid, such as trying to commit a file in a
783
 
    newly-added directory that is not itself committed.
784
 
 
785
 
    TODO: Run hooks on tree to-be-committed, and after commit.
786
 
 
787
 
    TODO: Strict commit that fails if there are unknown or deleted files.
788
 
    """
789
 
    takes_args = ['selected*']
790
 
    takes_options = ['message', 'file', 'verbose']
791
 
    aliases = ['ci', 'checkin']
792
 
 
793
 
    def run(self, message=None, file=None, verbose=False, selected_list=None):
794
 
        from bzrlib.commit import commit
795
 
 
796
 
        ## Warning: shadows builtin file()
797
 
        if not message and not file:
798
 
            raise BzrCommandError("please specify a commit message",
799
 
                                  ["use either --message or --file"])
800
 
        elif message and file:
801
 
            raise BzrCommandError("please specify either --message or --file")
 
369
    for f in Branch('.').unknowns():
 
370
        print quotefn(f)
 
371
 
 
372
 
 
373
def cmd_lookup_revision(revno):
 
374
    try:
 
375
        revno = int(revno)
 
376
    except ValueError:
 
377
        bailout("usage: lookup-revision REVNO",
 
378
                ["REVNO is a non-negative revision number for this branch"])
 
379
 
 
380
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
381
 
 
382
 
 
383
 
 
384
def cmd_export(revno, dest):
 
385
    """Export past revision to destination directory."""
 
386
    b = Branch('.')
 
387
    rh = b.lookup_revision(int(revno))
 
388
    t = b.revision_tree(rh)
 
389
    t.export(dest)
 
390
 
 
391
 
 
392
 
 
393
######################################################################
 
394
# internal/test commands
 
395
 
 
396
 
 
397
def cmd_uuid():
 
398
    """Print a newly-generated UUID."""
 
399
    print uuid()
 
400
 
 
401
 
 
402
 
 
403
def cmd_commit(message, verbose=False):
 
404
    Branch('.').commit(message, verbose=verbose)
 
405
 
 
406
 
 
407
def cmd_check():
 
408
    """Check consistency of the branch."""
 
409
    check()
 
410
 
 
411
 
 
412
def cmd_is(pred, *rest):
 
413
    """Test whether PREDICATE is true."""
 
414
    try:
 
415
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
416
    except KeyError:
 
417
        bailout("unknown predicate: %s" % quotefn(pred))
802
418
        
803
 
        if file:
804
 
            import codecs
805
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
806
 
 
807
 
        b = Branch('.')
808
 
        commit(b, message, verbose=verbose, specific_files=selected_list)
809
 
 
810
 
 
811
 
class cmd_check(Command):
812
 
    """Validate consistency of branch history.
813
 
 
814
 
    This command checks various invariants about the branch storage to
815
 
    detect data corruption or bzr bugs.
816
 
    """
817
 
    takes_args = ['dir?']
818
 
    def run(self, dir='.'):
819
 
        import bzrlib.check
820
 
        bzrlib.check.check(Branch(dir, find_root=False))
821
 
 
822
 
 
823
 
 
824
 
class cmd_whoami(Command):
825
 
    """Show bzr user id."""
826
 
    takes_options = ['email']
 
419
    try:
 
420
        cmd_handler(*rest)
 
421
    except BzrCheckError:
 
422
        # by default we don't print the message so that this can
 
423
        # be used from shell scripts without producing noise
 
424
        sys.exit(1)
 
425
 
 
426
 
 
427
def cmd_username():
 
428
    print bzrlib.osutils.username()
 
429
 
 
430
 
 
431
def cmd_user_email():
 
432
    print bzrlib.osutils.user_email()
 
433
 
 
434
 
 
435
def cmd_gen_revision_id():
 
436
    import time
 
437
    print bzrlib.branch._gen_revision_id(time.time())
 
438
 
 
439
 
 
440
def cmd_doctest():
 
441
    """Run internal doctest suite"""
 
442
    ## -v, if present, is seen by doctest; the argument is just here
 
443
    ## so our parser doesn't complain
 
444
 
 
445
    ## TODO: --verbose option
827
446
    
828
 
    def run(self, email=False):
829
 
        if email:
830
 
            print bzrlib.osutils.user_email()
831
 
        else:
832
 
            print bzrlib.osutils.username()
833
 
 
834
 
 
835
 
class cmd_selftest(Command):
836
 
    """Run internal test suite"""
837
 
    hidden = True
838
 
    def run(self):
839
 
        failures, tests = 0, 0
840
 
 
841
 
        import doctest, bzrlib.store, bzrlib.tests
842
 
        bzrlib.trace.verbose = False
843
 
 
844
 
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
845
 
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
846
 
            mf, mt = doctest.testmod(m)
847
 
            failures += mf
848
 
            tests += mt
849
 
            print '%-40s %3d tests' % (m.__name__, mt),
850
 
            if mf:
851
 
                print '%3d FAILED!' % mf
852
 
            else:
853
 
                print
854
 
 
855
 
        print '%-40s %3d tests' % ('total', tests),
856
 
        if failures:
857
 
            print '%3d FAILED!' % failures
858
 
        else:
859
 
            print
860
 
 
861
 
 
862
 
 
863
 
class cmd_version(Command):
864
 
    """Show version of bzr"""
865
 
    def run(self):
866
 
        show_version()
867
 
 
868
 
def show_version():
869
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
870
 
    print bzrlib.__copyright__
 
447
    import bzr, doctest, bzrlib.store
 
448
    bzrlib.trace.verbose = False
 
449
    doctest.testmod(bzr)
 
450
    doctest.testmod(bzrlib.store)
 
451
    doctest.testmod(bzrlib.inventory)
 
452
    doctest.testmod(bzrlib.branch)
 
453
    doctest.testmod(bzrlib.osutils)
 
454
    doctest.testmod(bzrlib.tree)
 
455
 
 
456
    # more strenuous tests;
 
457
    import bzrlib.tests
 
458
    doctest.testmod(bzrlib.tests)
 
459
 
 
460
 
 
461
######################################################################
 
462
# help
 
463
 
 
464
 
 
465
def cmd_help():
 
466
    # TODO: Specific help for particular commands
 
467
    print __doc__
 
468
 
 
469
 
 
470
def cmd_version():
 
471
    print "bzr (bazaar-ng) %s" % __version__
 
472
    print __copyright__
871
473
    print "http://bazaar-ng.org/"
872
474
    print
873
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
874
 
    print "you may use, modify and redistribute it under the terms of the GNU"
875
 
    print "General Public License version 2 or later."
876
 
 
877
 
 
878
 
class cmd_rocks(Command):
 
475
    print \
 
476
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
477
you may use, modify and redistribute it under the terms of the GNU 
 
478
General Public License version 2 or later."""
 
479
 
 
480
 
 
481
def cmd_rocks():
879
482
    """Statement of optimism."""
880
 
    hidden = True
881
 
    def run(self):
882
 
        print "it sure does!"
883
 
 
884
 
 
885
 
class cmd_assert_fail(Command):
886
 
    """Test reporting of assertion failures"""
887
 
    hidden = True
888
 
    def run(self):
889
 
        assert False, "always fails"
890
 
 
891
 
 
892
 
class cmd_help(Command):
893
 
    """Show help on a command or other topic.
894
 
 
895
 
    For a list of all available commands, say 'bzr help commands'."""
896
 
    takes_args = ['topic?']
897
 
    aliases = ['?']
898
 
    
899
 
    def run(self, topic=None):
900
 
        import help
901
 
        help.help(topic)
902
 
 
903
 
 
904
 
class cmd_update_stat_cache(Command):
905
 
    """Update stat-cache mapping inodes to SHA-1 hashes.
906
 
 
907
 
    For testing only."""
908
 
    hidden = True
909
 
    def run(self):
910
 
        import statcache
911
 
        b = Branch('.')
912
 
        statcache.update_cache(b.base, b.read_working_inventory())
 
483
    print "it sure does!"
 
484
 
913
485
 
914
486
 
915
487
######################################################################
922
494
OPTIONS = {
923
495
    'all':                    None,
924
496
    'help':                   None,
925
 
    'file':                   unicode,
926
497
    'message':                unicode,
927
 
    'profile':                None,
928
498
    'revision':               int,
929
499
    'show-ids':               None,
930
 
    'timezone':               str,
931
500
    'verbose':                None,
932
501
    'version':                None,
933
 
    'email':                  None,
934
502
    }
935
503
 
936
504
SHORT_OPTIONS = {
937
505
    'm':                      'message',
938
 
    'F':                      'file', 
939
506
    'r':                      'revision',
940
507
    'v':                      'verbose',
941
508
}
942
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
    'ls':                     ['revision', 'verbose'],
 
518
    'status':                 ['all'],
 
519
    'log':                    ['show-ids'],
 
520
    'remove':                 ['verbose'],
 
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
 
943
541
 
944
542
def parse_args(argv):
945
543
    """Parse command line.
949
547
    lookup table, something about the available options, what optargs
950
548
    they take, and which commands will accept them.
951
549
 
952
 
    >>> parse_args('--help'.split())
 
550
    >>> parse_args('bzr --help'.split())
953
551
    ([], {'help': True})
954
 
    >>> parse_args('--version'.split())
 
552
    >>> parse_args('bzr --version'.split())
955
553
    ([], {'version': True})
956
 
    >>> parse_args('status --all'.split())
 
554
    >>> parse_args('bzr status --all'.split())
957
555
    (['status'], {'all': True})
958
 
    >>> parse_args('commit --message=biter'.split())
959
 
    (['commit'], {'message': u'biter'})
960
556
    """
961
557
    args = []
962
558
    opts = {}
963
559
 
964
560
    # TODO: Maybe handle '--' to end options?
965
561
 
966
 
    while argv:
967
 
        a = argv.pop(0)
 
562
    it = iter(argv[1:])
 
563
    while it:
 
564
        a = it.next()
968
565
        if a[0] == '-':
969
 
            # option names must not be unicode
970
 
            a = str(a)
971
 
            optarg = None
972
566
            if a[1] == '-':
973
567
                mutter("  got option %r" % a)
974
 
                if '=' in a:
975
 
                    optname, optarg = a[2:].split('=', 1)
976
 
                else:
977
 
                    optname = a[2:]
 
568
                optname = a[2:]
978
569
                if optname not in OPTIONS:
979
570
                    bailout('unknown long option %r' % a)
980
571
            else:
986
577
            if optname in opts:
987
578
                # XXX: Do we ever want to support this, e.g. for -r?
988
579
                bailout('repeated option %r' % a)
989
 
                
990
580
            optargfn = OPTIONS[optname]
991
581
            if optargfn:
992
 
                if optarg == None:
993
 
                    if not argv:
994
 
                        bailout('option %r needs an argument' % a)
995
 
                    else:
996
 
                        optarg = argv.pop(0)
997
 
                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])
998
586
            else:
999
 
                if optarg != None:
1000
 
                    bailout('option %r takes no argument' % optname)
 
587
                # takes no option argument
1001
588
                opts[optname] = True
 
589
        elif a[:1] == '-':
 
590
            bailout('unknown short option %r' % a)
1002
591
        else:
1003
592
            args.append(a)
1004
593
 
1006
595
 
1007
596
 
1008
597
 
 
598
def _match_args(cmd, args):
 
599
    """Check non-option arguments match required pattern.
1009
600
 
1010
 
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, [])
1011
612
    argdict = {}
1012
 
 
1013
 
    # step through args and takes_args, allowing appropriate 0-many matches
1014
 
    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:
1015
616
        argname = ap[:-1]
1016
617
        if ap[-1] == '?':
1017
 
            if args:
1018
 
                argdict[argname] = args.pop(0)
1019
 
        elif ap[-1] == '*': # all remaining arguments
1020
 
            if args:
1021
 
                argdict[argname + '_list'] = args[:]
1022
 
                args = []
1023
 
            else:
1024
 
                argdict[argname + '_list'] = None
 
618
            assert 0
 
619
        elif ap[-1] == '*':
 
620
            assert 0
1025
621
        elif ap[-1] == '+':
1026
622
            if not args:
1027
 
                raise BzrCommandError("command %r needs one or more %s"
 
623
                bailout("command %r needs one or more %s"
1028
624
                        % (cmd, argname.upper()))
1029
625
            else:
1030
626
                argdict[argname + '_list'] = args[:]
1031
627
                args = []
1032
 
        elif ap[-1] == '$': # all but one
1033
 
            if len(args) < 2:
1034
 
                raise BzrCommandError("command %r needs one or more %s"
1035
 
                        % (cmd, argname.upper()))
1036
 
            argdict[argname + '_list'] = args[:-1]
1037
 
            args[:-1] = []                
1038
628
        else:
1039
629
            # just a plain arg
1040
630
            argname = ap
1041
631
            if not args:
1042
 
                raise BzrCommandError("command %r requires argument %s"
 
632
                bailout("command %r requires argument %s"
1043
633
                        % (cmd, argname.upper()))
1044
634
            else:
1045
635
                argdict[argname] = args.pop(0)
1046
636
            
1047
637
    if args:
1048
 
        raise BzrCommandError("extra argument to command %s: %s"
1049
 
                              % (cmd, args[0]))
 
638
        bailout("extra arguments to command %s: %r"
 
639
                % (cmd, args))
1050
640
 
1051
641
    return argdict
1052
642
 
1056
646
    """Execute a command.
1057
647
 
1058
648
    This is similar to main(), but without all the trappings for
1059
 
    logging and error handling.  
 
649
    logging and error handling.
1060
650
    """
1061
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1062
 
    
1063
651
    try:
1064
 
        args, opts = parse_args(argv[1:])
 
652
        args, opts = parse_args(argv)
1065
653
        if 'help' in opts:
1066
 
            import help
1067
 
            if args:
1068
 
                help.help(args[0])
1069
 
            else:
1070
 
                help.help()
 
654
            # TODO: pass down other arguments in case they asked for
 
655
            # help on a command name?
 
656
            cmd_help()
1071
657
            return 0
1072
658
        elif 'version' in opts:
1073
 
            show_version()
 
659
            cmd_version()
1074
660
            return 0
1075
 
        cmd = str(args.pop(0))
 
661
        cmd = args.pop(0)
1076
662
    except IndexError:
1077
 
        import help
1078
 
        help.help()
 
663
        log_error('usage: bzr COMMAND\n')
 
664
        log_error('  try "bzr help"\n')
1079
665
        return 1
1080
 
          
1081
 
 
1082
 
    canonical_cmd, cmd_class = get_cmd_class(cmd)
1083
 
 
1084
 
    # global option
1085
 
    if 'profile' in opts:
1086
 
        profile = True
1087
 
        del opts['profile']
1088
 
    else:
1089
 
        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
1090
673
 
1091
674
    # check options are reasonable
1092
 
    allowed = cmd_class.takes_options
 
675
    allowed = cmd_options.get(cmd, [])
1093
676
    for oname in opts:
1094
677
        if oname not in allowed:
1095
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1096
 
                                  % (oname, cmd))
1097
 
 
1098
 
    # mix arguments and options into one dictionary
1099
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1100
 
    cmdopts = {}
1101
 
    for k, v in opts.items():
1102
 
        cmdopts[k.replace('-', '_')] = v
1103
 
 
1104
 
    if profile:
1105
 
        import hotshot, tempfile
1106
 
        pffileno, pfname = tempfile.mkstemp()
1107
 
        try:
1108
 
            prof = hotshot.Profile(pfname)
1109
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1110
 
            prof.close()
1111
 
 
1112
 
            import hotshot.stats
1113
 
            stats = hotshot.stats.load(pfname)
1114
 
            #stats.strip_dirs()
1115
 
            stats.sort_stats('time')
1116
 
            ## XXX: Might like to write to stderr or the trace file instead but
1117
 
            ## print_stats seems hardcoded to stdout
1118
 
            stats.print_stats(20)
1119
 
            
1120
 
            return ret.status
1121
 
 
1122
 
        finally:
1123
 
            os.close(pffileno)
1124
 
            os.remove(pfname)
1125
 
    else:
1126
 
        cmdobj = cmd_class(cmdopts, cmdargs).status 
1127
 
 
1128
 
 
1129
 
def _report_exception(summary, quiet=False):
1130
 
    import traceback
1131
 
    log_error('bzr: ' + summary)
1132
 
    bzrlib.trace.log_exception()
1133
 
 
1134
 
    if not quiet:
1135
 
        tb = sys.exc_info()[2]
1136
 
        exinfo = traceback.extract_tb(tb)
1137
 
        if exinfo:
1138
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1139
 
        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
1140
685
 
1141
686
 
1142
687
 
1143
688
def main(argv):
1144
 
    import errno
1145
 
    
1146
 
    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.
1147
694
 
1148
695
    try:
1149
 
        try:
1150
 
            try:
1151
 
                return run_bzr(argv)
1152
 
            finally:
1153
 
                # do this here inside the exception wrappers to catch EPIPE
1154
 
                sys.stdout.flush()
1155
 
        except BzrError, e:
1156
 
            quiet = isinstance(e, (BzrCommandError))
1157
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
1158
 
            if len(e.args) > 1:
1159
 
                for h in e.args[1]:
1160
 
                    # some explanation or hints
1161
 
                    log_error('  ' + h)
1162
 
            return 1
1163
 
        except AssertionError, e:
1164
 
            msg = 'assertion failed'
1165
 
            if str(e):
1166
 
                msg += ': ' + str(e)
1167
 
            _report_exception(msg)
1168
 
            return 2
1169
 
        except KeyboardInterrupt, e:
1170
 
            _report_exception('interrupted', quiet=True)
1171
 
            return 2
1172
 
        except Exception, e:
1173
 
            quiet = False
1174
 
            if (isinstance(e, IOError) 
1175
 
                and hasattr(e, 'errno')
1176
 
                and e.errno == errno.EPIPE):
1177
 
                quiet = True
1178
 
                msg = 'broken pipe'
1179
 
            else:
1180
 
                msg = str(e).rstrip('\n')
1181
 
            _report_exception(msg, quiet)
1182
 
            return 2
1183
 
    finally:
1184
 
        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
 
1185
731
 
1186
732
 
1187
733
if __name__ == '__main__':
1188
734
    sys.exit(main(sys.argv))
 
735
    ##import profile
 
736
    ##profile.run('main(sys.argv)')
 
737