~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-08 05:39:46 UTC
  • Revision ID: mbp@sourcefrog.net-20050408053946-1cb3415e1f8f58493034a5cf
- import lovely urlgrabber library

Show diffs side-by-side

added added

removed removed

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