~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
80
 
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):
 
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):
190
120
    """Display status summary.
191
121
 
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.
 
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?
224
127
    """
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
 
                           file_list=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):
 
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):
263
156
    """Add specified files or directories.
264
157
 
265
158
    In non-recursive mode, all the named items are added, regardless
276
169
 
277
170
    Therefore simply saying 'bzr add .' will version all files that
278
171
    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):
 
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):
330
208
    """Change the name of an entry.
331
209
 
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']
 
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))
344
225
    
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):
 
226
 
 
227
 
 
228
 
 
229
def cmd_renames(dir='.'):
352
230
    """Show list of renamed files.
353
231
 
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):
 
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):
398
265
    """Print file_id of a particular file or directory.
399
266
 
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):
 
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):
416
282
    """Print path of file_ids to a file or directory.
417
283
 
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, file_list)
498
 
 
499
 
 
500
 
        
501
 
 
502
 
 
503
 
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):
504
423
    """List files deleted in the working tree.
505
424
 
506
 
    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.
507
426
    """
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('.')
532
 
        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)
 
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:
549
441
                print path
550
442
 
551
443
 
552
444
 
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):
 
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'):
585
485
    """Show log of this branch.
586
486
 
587
 
    TODO: Option to limit range.
588
 
 
589
 
    TODO: Perhaps show most-recent first with an option for last.
 
487
    :todo: Options for utc; to show ids; to limit range; etc.
590
488
    """
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):
 
489
    Branch('.').write_log(show_timezone=timezone)
 
490
 
 
491
 
 
492
def cmd_ls(revision=None, verbose=False):
618
493
    """List files in a tree.
619
494
 
620
 
    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.
621
496
    """
622
 
    hidden = True
623
 
    def run(self, revision=None, verbose=False):
624
 
        b = Branch('.')
625
 
        if revision == None:
626
 
            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)
627
513
        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):
 
514
            print fp
 
515
    
 
516
    
 
517
 
 
518
def cmd_unknowns():
646
519
    """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):
 
520
    for f in Branch('.').unknowns():
 
521
        print quotefn(f)
 
522
 
 
523
 
 
524
 
 
525
def cmd_ignored():
706
526
    """List ignored files and the patterns that matched them.
707
 
 
708
 
    See also: bzr ignore"""
709
 
    def run(self):
710
 
        tree = Branch('.').working_tree()
711
 
        for path, file_class, kind, file_id in tree.list_files():
712
 
            if file_class != 'I':
713
 
                continue
714
 
            ## XXX: Slightly inefficient since this was already calculated
715
 
            pat = tree.is_ignored(path)
716
 
            print '%-50s %s' % (path, pat)
717
 
 
718
 
 
719
 
class cmd_lookup_revision(Command):
720
 
    """Lookup the revision-id from a revision-number
721
 
 
722
 
    example:
723
 
        bzr lookup-revision 33
724
 
    """
725
 
    hidden = True
726
 
    takes_args = ['revno']
727
 
    
728
 
    def run(self, revno):
729
 
        try:
730
 
            revno = int(revno)
731
 
        except ValueError:
732
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
733
 
 
734
 
        print Branch('.').lookup_revision(revno)
735
 
 
736
 
 
737
 
class cmd_export(Command):
738
 
    """Export past revision to destination directory.
739
 
 
740
 
    If no revision is specified this exports the last committed revision."""
741
 
    takes_args = ['dest']
742
 
    takes_options = ['revision']
743
 
    def run(self, dest, revision=None):
744
 
        b = Branch('.')
745
 
        if revision == None:
746
 
            rh = b.revision_history()[-1]
747
 
        else:
748
 
            rh = b.lookup_revision(int(revision))
749
 
        t = b.revision_tree(rh)
750
 
        t.export(dest)
751
 
 
752
 
 
753
 
class cmd_cat(Command):
754
 
    """Write a file's text from a previous revision."""
755
 
 
756
 
    takes_options = ['revision']
757
 
    takes_args = ['filename']
758
 
 
759
 
    def run(self, filename, revision=None):
760
 
        if revision == None:
761
 
            raise BzrCommandError("bzr cat requires a revision number")
762
 
        b = Branch('.')
763
 
        b.print_file(b.relpath(filename), int(revision))
764
 
 
765
 
 
766
 
class cmd_local_time_offset(Command):
767
 
    """Show the offset in seconds from GMT to local time."""
768
 
    hidden = True    
769
 
    def run(self):
770
 
        print bzrlib.osutils.local_time_offset()
771
 
 
772
 
 
773
 
 
774
 
class cmd_commit(Command):
775
 
    """Commit changes into a new revision.
776
 
 
777
 
    TODO: Commit only selected files.
778
 
 
779
 
    TODO: Run hooks on tree to-be-committed, and after commit.
780
 
 
781
 
    TODO: Strict commit that fails if there are unknown or deleted files.
782
 
    """
783
 
    takes_options = ['message', 'file', 'verbose']
784
 
    aliases = ['ci', 'checkin']
785
 
 
786
 
    def run(self, message=None, file=None, verbose=False):
787
 
        ## Warning: shadows builtin file()
788
 
        if not message and not file:
789
 
            raise BzrCommandError("please specify a commit message",
790
 
                                  ["use either --message or --file"])
791
 
        elif message and file:
792
 
            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))
793
619
        
794
 
        if file:
795
 
            import codecs
796
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
797
 
 
798
 
        Branch('.').commit(message, verbose=verbose)
799
 
 
800
 
 
801
 
class cmd_check(Command):
802
 
    """Validate consistency of branch history.
803
 
 
804
 
    This command checks various invariants about the branch storage to
805
 
    detect data corruption or bzr bugs.
806
 
    """
807
 
    takes_args = ['dir?']
808
 
    def run(self, dir='.'):
809
 
        import bzrlib.check
810
 
        bzrlib.check.check(Branch(dir, find_root=False))
811
 
 
812
 
 
813
 
 
814
 
class cmd_whoami(Command):
815
 
    """Show bzr user id."""
816
 
    takes_options = ['email']
817
 
    
818
 
    def run(self, email=False):
819
 
        if email:
820
 
            print bzrlib.osutils.user_email()
821
 
        else:
822
 
            print bzrlib.osutils.username()
823
 
 
824
 
 
825
 
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():
826
641
    """Run internal test suite"""
827
 
    hidden = True
828
 
    def run(self):
829
 
        failures, tests = 0, 0
830
 
 
831
 
        import doctest, bzrlib.store, bzrlib.tests
832
 
        bzrlib.trace.verbose = False
833
 
 
834
 
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
835
 
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
836
 
            mf, mt = doctest.testmod(m)
837
 
            failures += mf
838
 
            tests += mt
839
 
            print '%-40s %3d tests' % (m.__name__, mt),
840
 
            if mf:
841
 
                print '%3d FAILED!' % mf
842
 
            else:
843
 
                print
844
 
 
845
 
        print '%-40s %3d tests' % ('total', tests),
846
 
        if failures:
847
 
            print '%3d FAILED!' % failures
 
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
848
660
        else:
849
661
            print
850
662
 
851
 
 
852
 
 
853
 
class cmd_version(Command):
854
 
    """Show version of bzr"""
855
 
    def run(self):
856
 
        show_version()
857
 
 
858
 
def show_version():
 
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():
859
700
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
860
701
    print bzrlib.__copyright__
861
702
    print "http://bazaar-ng.org/"
862
703
    print
863
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
864
 
    print "you may use, modify and redistribute it under the terms of the GNU"
865
 
    print "General Public License version 2 or later."
866
 
 
867
 
 
868
 
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():
869
711
    """Statement of optimism."""
870
 
    hidden = True
871
 
    def run(self):
872
 
        print "it sure does!"
873
 
 
874
 
 
875
 
class cmd_assert_fail(Command):
876
 
    """Test reporting of assertion failures"""
877
 
    hidden = True
878
 
    def run(self):
879
 
        assert False, "always fails"
880
 
 
881
 
 
882
 
class cmd_help(Command):
883
 
    """Show help on a command or other topic.
884
 
 
885
 
    For a list of all available commands, say 'bzr help commands'."""
886
 
    takes_args = ['topic?']
887
 
    aliases = ['?']
888
 
    
889
 
    def run(self, topic=None):
890
 
        import help
891
 
        help.help(topic)
892
 
 
893
 
 
894
 
class cmd_update_stat_cache(Command):
895
 
    """Update stat-cache mapping inodes to SHA-1 hashes.
896
 
 
897
 
    For testing only."""
898
 
    hidden = True
899
 
    def run(self):
900
 
        import statcache
901
 
        b = Branch('.')
902
 
        statcache.update_cache(b.base, b.read_working_inventory())
 
712
    print "it sure does!"
 
713
 
903
714
 
904
715
 
905
716
######################################################################
912
723
OPTIONS = {
913
724
    'all':                    None,
914
725
    'help':                   None,
915
 
    'file':                   unicode,
916
726
    'message':                unicode,
917
727
    'profile':                None,
918
728
    'revision':               int,
920
730
    'timezone':               str,
921
731
    'verbose':                None,
922
732
    'version':                None,
923
 
    'email':                  None,
924
733
    }
925
734
 
926
735
SHORT_OPTIONS = {
927
736
    'm':                      'message',
928
 
    'F':                      'file', 
929
737
    'r':                      'revision',
930
738
    'v':                      'verbose',
931
739
}
932
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
 
933
782
 
934
783
def parse_args(argv):
935
784
    """Parse command line.
956
805
    while argv:
957
806
        a = argv.pop(0)
958
807
        if a[0] == '-':
959
 
            # option names must not be unicode
960
 
            a = str(a)
961
808
            optarg = None
962
809
            if a[1] == '-':
963
810
                mutter("  got option %r" % a)
996
843
 
997
844
 
998
845
 
 
846
def _match_args(cmd, args):
 
847
    """Check non-option arguments match required pattern.
999
848
 
1000
 
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, [])
1001
860
    argdict = {}
 
861
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
862
    # all but one.
1002
863
 
1003
 
    # step through args and takes_args, allowing appropriate 0-many matches
1004
 
    for ap in takes_args:
 
864
    # step through args and argform, allowing appropriate 0-many matches
 
865
    for ap in argform:
1005
866
        argname = ap[:-1]
1006
867
        if ap[-1] == '?':
1007
868
            if args:
1008
869
                argdict[argname] = args.pop(0)
1009
 
        elif ap[-1] == '*': # all remaining arguments
1010
 
            if args:
1011
 
                argdict[argname + '_list'] = args[:]
1012
 
                args = []
1013
 
            else:
1014
 
                argdict[argname + '_list'] = None
 
870
        elif ap[-1] == '*':
 
871
            raise BzrError("arg form %r not implemented yet" % ap)
1015
872
        elif ap[-1] == '+':
1016
873
            if not args:
1017
 
                raise BzrCommandError("command %r needs one or more %s"
 
874
                bailout("command %r needs one or more %s"
1018
875
                        % (cmd, argname.upper()))
1019
876
            else:
1020
877
                argdict[argname + '_list'] = args[:]
1021
878
                args = []
1022
879
        elif ap[-1] == '$': # all but one
1023
880
            if len(args) < 2:
1024
 
                raise BzrCommandError("command %r needs one or more %s"
 
881
                bailout("command %r needs one or more %s"
1025
882
                        % (cmd, argname.upper()))
1026
883
            argdict[argname + '_list'] = args[:-1]
1027
884
            args[:-1] = []                
1029
886
            # just a plain arg
1030
887
            argname = ap
1031
888
            if not args:
1032
 
                raise BzrCommandError("command %r requires argument %s"
 
889
                bailout("command %r requires argument %s"
1033
890
                        % (cmd, argname.upper()))
1034
891
            else:
1035
892
                argdict[argname] = args.pop(0)
1036
893
            
1037
894
    if args:
1038
 
        raise BzrCommandError("extra argument to command %s: %s"
1039
 
                              % (cmd, args[0]))
 
895
        bailout("extra arguments to command %s: %r"
 
896
                % (cmd, args))
1040
897
 
1041
898
    return argdict
1042
899
 
1046
903
    """Execute a command.
1047
904
 
1048
905
    This is similar to main(), but without all the trappings for
1049
 
    logging and error handling.  
 
906
    logging and error handling.
1050
907
    """
1051
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1052
 
    
1053
908
    try:
1054
909
        args, opts = parse_args(argv[1:])
1055
910
        if 'help' in opts:
1056
 
            import help
 
911
            # TODO: pass down other arguments in case they asked for
 
912
            # help on a command name?
1057
913
            if args:
1058
 
                help.help(args[0])
 
914
                cmd_help(args[0])
1059
915
            else:
1060
 
                help.help()
 
916
                cmd_help()
1061
917
            return 0
1062
918
        elif 'version' in opts:
1063
 
            show_version()
 
919
            cmd_version()
1064
920
            return 0
1065
 
        cmd = str(args.pop(0))
 
921
        cmd = args.pop(0)
1066
922
    except IndexError:
1067
 
        import help
1068
 
        help.help()
 
923
        log_error('usage: bzr COMMAND\n')
 
924
        log_error('  try "bzr help"\n')
1069
925
        return 1
1070
 
          
1071
926
 
1072
 
    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`)
1073
931
 
1074
932
    # global option
1075
933
    if 'profile' in opts:
1079
937
        profile = False
1080
938
 
1081
939
    # check options are reasonable
1082
 
    allowed = cmd_class.takes_options
 
940
    allowed = cmd_options.get(cmd, [])
1083
941
    for oname in opts:
1084
942
        if oname not in allowed:
1085
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1086
 
                                  % (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)
1087
949
 
1088
950
    # mix arguments and options into one dictionary
1089
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1090
 
    cmdopts = {}
 
951
    cmdargs = _match_args(cmd, args)
1091
952
    for k, v in opts.items():
1092
 
        cmdopts[k.replace('-', '_')] = v
 
953
        cmdargs[k.replace('-', '_')] = v
1093
954
 
1094
955
    if profile:
1095
 
        import hotshot, tempfile
1096
 
        pffileno, pfname = tempfile.mkstemp()
1097
 
        try:
1098
 
            prof = hotshot.Profile(pfname)
1099
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1100
 
            prof.close()
1101
 
 
1102
 
            import hotshot.stats
1103
 
            stats = hotshot.stats.load(pfname)
1104
 
            #stats.strip_dirs()
1105
 
            stats.sort_stats('time')
1106
 
            ## XXX: Might like to write to stderr or the trace file instead but
1107
 
            ## print_stats seems hardcoded to stdout
1108
 
            stats.print_stats(20)
1109
 
            
1110
 
            return ret.status
1111
 
 
1112
 
        finally:
1113
 
            os.close(pffileno)
1114
 
            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
1115
968
    else:
1116
 
        cmdobj = cmd_class(cmdopts, cmdargs).status 
1117
 
 
1118
 
 
1119
 
def _report_exception(summary, quiet=False):
1120
 
    import traceback
1121
 
    log_error('bzr: ' + summary)
1122
 
    bzrlib.trace.log_exception()
1123
 
 
1124
 
    if not quiet:
1125
 
        tb = sys.exc_info()[2]
1126
 
        exinfo = traceback.extract_tb(tb)
1127
 
        if exinfo:
1128
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1129
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
969
        return cmd_handler(**cmdargs) or 0
1130
970
 
1131
971
 
1132
972
 
1133
973
def main(argv):
1134
 
    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)
1135
981
    
1136
 
    bzrlib.open_tracefile(argv)
1137
 
 
1138
982
    try:
1139
 
        try:
1140
 
            try:
1141
 
                return run_bzr(argv)
1142
 
            finally:
1143
 
                # do this here inside the exception wrappers to catch EPIPE
1144
 
                sys.stdout.flush()
1145
 
        except BzrError, e:
1146
 
            quiet = isinstance(e, (BzrCommandError))
1147
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
1148
 
            if len(e.args) > 1:
1149
 
                for h in e.args[1]:
1150
 
                    # some explanation or hints
1151
 
                    log_error('  ' + h)
1152
 
            return 1
1153
 
        except AssertionError, e:
1154
 
            msg = 'assertion failed'
1155
 
            if str(e):
1156
 
                msg += ': ' + str(e)
1157
 
            _report_exception(msg)
1158
 
            return 2
1159
 
        except KeyboardInterrupt, e:
1160
 
            _report_exception('interrupted', quiet=True)
1161
 
            return 2
1162
 
        except Exception, e:
1163
 
            quiet = False
1164
 
            if (isinstance(e, IOError) 
1165
 
                and hasattr(e, 'errno')
1166
 
                and e.errno == errno.EPIPE):
1167
 
                quiet = True
1168
 
                msg = 'broken pipe'
1169
 
            else:
1170
 
                msg = str(e).rstrip('\n')
1171
 
            _report_exception(msg, quiet)
1172
 
            return 2
1173
 
    finally:
1174
 
        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
 
1175
1002
 
1176
1003
 
1177
1004
if __name__ == '__main__':
1178
1005
    sys.exit(main(sys.argv))
 
1006
    ##import profile
 
1007
    ##profile.run('main(sys.argv)')
 
1008