← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

Show diffs side-by-side

added added

removed removed

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