← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Aaron Bentley
  • Date: 2005-07-26 15:25:58 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 1020.
  • Revision ID: abentley@panoramicfeedback.com-20050726152558-c47bb2bd0163e1a8
Replaced popen with subprocess in patch..py

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
# TODO: probably should say which arguments are candidates for glob
19
 
# expansion on windows and do that at the command level.
20
 
 
21
 
# TODO: Help messages for options.
22
 
 
23
 
# TODO: Define arguments by objects, rather than just using names.
24
 
# Those objects can specify the expected type of the argument, which
25
 
# would help with validation and shell completion.
26
 
 
27
 
 
28
 
 
29
 
import sys
30
 
import os
31
 
from warnings import warn
32
 
from inspect import getdoc
 
18
 
 
19
import sys, os
33
20
 
34
21
import bzrlib
35
 
import bzrlib.trace
36
22
from bzrlib.trace import mutter, note, log_error, warning
37
 
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
 
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
24
from bzrlib.branch import find_branch
39
25
from bzrlib import BZRDIR
40
26
 
 
27
 
41
28
plugin_cmds = {}
42
29
 
43
30
 
51
38
        k_unsquished = k
52
39
    if not plugin_cmds.has_key(k_unsquished):
53
40
        plugin_cmds[k_unsquished] = cmd
54
 
        mutter('registered plugin command %s', k_unsquished)      
55
41
    else:
56
42
        log_error('Two plugins defined the same command: %r' % k)
57
43
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
136
122
    return revs
137
123
 
138
124
 
139
 
def get_merge_type(typestring):
140
 
    """Attempt to find the merge class/factory associated with a string."""
141
 
    from merge import merge_types
142
 
    try:
143
 
        return merge_types[typestring][0]
144
 
    except KeyError:
145
 
        templ = '%s%%7s: %%s' % (' '*12)
146
 
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
 
        type_list = '\n'.join(lines)
148
 
        msg = "No known merge type %s. Supported types are:\n%s" %\
149
 
            (typestring, type_list)
150
 
        raise BzrCommandError(msg)
151
 
    
152
 
 
153
 
def get_merge_type(typestring):
154
 
    """Attempt to find the merge class/factory associated with a string."""
155
 
    from merge import merge_types
156
 
    try:
157
 
        return merge_types[typestring][0]
158
 
    except KeyError:
159
 
        templ = '%s%%7s: %%s' % (' '*12)
160
 
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
161
 
        type_list = '\n'.join(lines)
162
 
        msg = "No known merge type %s. Supported types are:\n%s" %\
163
 
            (typestring, type_list)
164
 
        raise BzrCommandError(msg)
165
 
 
166
 
 
167
 
def _builtin_commands():
168
 
    import bzrlib.builtins
169
 
    r = {}
170
 
    builtins = bzrlib.builtins.__dict__
171
 
    for name in builtins:
172
 
        if name.startswith("cmd_"):
173
 
            real_name = _unsquish_command_name(name)        
174
 
            r[real_name] = builtins[name]
175
 
    return r
176
 
 
177
 
            
178
 
 
179
 
def builtin_command_names():
180
 
    """Return list of builtin command names."""
181
 
    return _builtin_commands().keys()
182
 
    
183
 
 
184
 
def plugin_command_names():
185
 
    return plugin_cmds.keys()
186
 
 
187
125
 
188
126
def _get_cmd_dict(plugins_override=True):
189
 
    """Return name->class mapping for all commands."""
190
 
    d = _builtin_commands()
 
127
    d = {}
 
128
    for k, v in globals().iteritems():
 
129
        if k.startswith("cmd_"):
 
130
            d[_unsquish_command_name(k)] = v
 
131
    # If we didn't load plugins, the plugin_cmds dict will be empty
191
132
    if plugins_override:
192
133
        d.update(plugin_cmds)
 
134
    else:
 
135
        d2 = plugin_cmds.copy()
 
136
        d2.update(d)
 
137
        d = d2
193
138
    return d
194
139
 
195
140
    
199
144
        yield k,v
200
145
 
201
146
 
202
 
def get_cmd_object(cmd_name, plugins_override=True):
 
147
def get_cmd_class(cmd, plugins_override=True):
203
148
    """Return the canonical name and command class for a command.
204
 
 
205
 
    plugins_override
206
 
        If true, plugin commands can override builtins.
207
149
    """
208
 
    from bzrlib.externalcommand import ExternalCommand
209
 
 
210
 
    cmd_name = str(cmd_name)            # not unicode
 
150
    cmd = str(cmd)                      # not unicode
211
151
 
212
152
    # first look up this command under the specified name
213
153
    cmds = _get_cmd_dict(plugins_override=plugins_override)
214
154
    try:
215
 
        return cmds[cmd_name]()
 
155
        return cmd, cmds[cmd]
216
156
    except KeyError:
217
157
        pass
218
158
 
219
159
    # look for any command which claims this as an alias
220
 
    for real_cmd_name, cmd_class in cmds.iteritems():
221
 
        if cmd_name in cmd_class.aliases:
222
 
            return cmd_class()
223
 
 
224
 
    cmd_obj = ExternalCommand.find_command(cmd_name)
225
 
    if cmd_obj:
226
 
        return cmd_obj
227
 
 
228
 
    raise BzrCommandError("unknown command %r" % cmd_name)
 
160
    for cmdname, cmdclass in cmds.iteritems():
 
161
        if cmd in cmdclass.aliases:
 
162
            return cmdname, cmdclass
 
163
 
 
164
    cmdclass = ExternalCommand.find_command(cmd)
 
165
    if cmdclass:
 
166
        return cmd, cmdclass
 
167
 
 
168
    raise BzrCommandError("unknown command %r" % cmd)
229
169
 
230
170
 
231
171
class Command(object):
232
172
    """Base class for commands.
233
173
 
234
 
    Commands are the heart of the command-line bzr interface.
235
 
 
236
 
    The command object mostly handles the mapping of command-line
237
 
    parameters into one or more bzrlib operations, and of the results
238
 
    into textual output.
239
 
 
240
 
    Commands normally don't have any state.  All their arguments are
241
 
    passed in to the run method.  (Subclasses may take a different
242
 
    policy if the behaviour of the instance needs to depend on e.g. a
243
 
    shell plugin and not just its Python class.)
244
 
 
245
174
    The docstring for an actual command should give a single-line
246
175
    summary, then a complete description of the command.  A grammar
247
176
    description will be inserted.
248
177
 
249
 
    aliases
250
 
        Other accepted names for this command.
251
 
 
252
178
    takes_args
253
179
        List of argument forms, marked with whether they are optional,
254
180
        repeated, etc.
257
183
        List of options that may be given for this command.
258
184
 
259
185
    hidden
260
 
        If true, this command isn't advertised.  This is typically
261
 
        for commands intended for expert users.
 
186
        If true, this command isn't advertised.
262
187
    """
263
188
    aliases = []
264
189
    
267
192
 
268
193
    hidden = False
269
194
    
270
 
    def __init__(self):
271
 
        """Construct an instance of this command."""
 
195
    def __init__(self, options, arguments):
 
196
        """Construct and run the command.
 
197
 
 
198
        Sets self.status to the return value of run()."""
 
199
        assert isinstance(options, dict)
 
200
        assert isinstance(arguments, dict)
 
201
        cmdargs = options.copy()
 
202
        cmdargs.update(arguments)
272
203
        if self.__doc__ == Command.__doc__:
 
204
            from warnings import warn
273
205
            warn("No help message set for %r" % self)
274
 
 
275
 
 
276
 
    def run_argv(self, argv):
277
 
        """Parse command line and run."""
278
 
        args, opts = parse_args(argv)
279
 
 
280
 
        if 'help' in opts:  # e.g. bzr add --help
281
 
            from bzrlib.help import help_on_command
282
 
            help_on_command(self.name())
283
 
            return 0
284
 
 
285
 
        # check options are reasonable
286
 
        allowed = self.takes_options
287
 
        for oname in opts:
288
 
            if oname not in allowed:
289
 
                raise BzrCommandError("option '--%s' is not allowed for command %r"
290
 
                                      % (oname, self.name()))
291
 
 
292
 
        # mix arguments and options into one dictionary
293
 
        cmdargs = _match_argform(self.name(), self.takes_args, args)
294
 
        cmdopts = {}
295
 
        for k, v in opts.items():
296
 
            cmdopts[k.replace('-', '_')] = v
297
 
 
298
 
        all_cmd_args = cmdargs.copy()
299
 
        all_cmd_args.update(cmdopts)
300
 
 
301
 
        return self.run(**all_cmd_args)
 
206
        self.status = self.run(**cmdargs)
 
207
        if self.status is None:
 
208
            self.status = 0
302
209
 
303
210
    
304
211
    def run(self):
305
 
        """Actually run the command.
 
212
        """Override this in sub-classes.
306
213
 
307
214
        This is invoked with the options and arguments bound to
308
215
        keyword parameters.
309
216
 
310
 
        Return 0 or None if the command was successful, or a non-zero
311
 
        shell error code if not.  It's OK for this method to allow
312
 
        an exception to raise up.
 
217
        Return 0 or None if the command was successful, or a shell
 
218
        error code if not.
313
219
        """
314
 
        raise NotImplementedError()
315
 
 
316
 
 
317
 
    def help(self):
318
 
        """Return help message for this class."""
319
 
        if self.__doc__ is Command.__doc__:
320
 
            return None
321
 
        return getdoc(self)
322
 
 
323
 
    def name(self):
324
 
        return _unsquish_command_name(self.__class__.__name__)
325
 
 
 
220
        return 0
 
221
 
 
222
 
 
223
class ExternalCommand(Command):
 
224
    """Class to wrap external commands.
 
225
 
 
226
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
227
    an object we construct that has the appropriate path, help, options etc for the
 
228
    specified command.
 
229
 
 
230
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
231
    method, which we override to call the Command.__init__ method. That then calls
 
232
    our run method which is pretty straight forward.
 
233
 
 
234
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
235
    back into command line options and arguments for the script.
 
236
    """
 
237
 
 
238
    def find_command(cls, cmd):
 
239
        import os.path
 
240
        bzrpath = os.environ.get('BZRPATH', '')
 
241
 
 
242
        for dir in bzrpath.split(os.pathsep):
 
243
            path = os.path.join(dir, cmd)
 
244
            if os.path.isfile(path):
 
245
                return ExternalCommand(path)
 
246
 
 
247
        return None
 
248
 
 
249
    find_command = classmethod(find_command)
 
250
 
 
251
    def __init__(self, path):
 
252
        self.path = path
 
253
 
 
254
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
255
        self.takes_options = pipe.readline().split()
 
256
 
 
257
        for opt in self.takes_options:
 
258
            if not opt in OPTIONS:
 
259
                raise BzrError("Unknown option '%s' returned by external command %s"
 
260
                               % (opt, path))
 
261
 
 
262
        # TODO: Is there any way to check takes_args is valid here?
 
263
        self.takes_args = pipe.readline().split()
 
264
 
 
265
        if pipe.close() is not None:
 
266
            raise BzrError("Failed funning '%s --bzr-usage'" % path)
 
267
 
 
268
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
269
        self.__doc__ = pipe.read()
 
270
        if pipe.close() is not None:
 
271
            raise BzrError("Failed funning '%s --bzr-help'" % path)
 
272
 
 
273
    def __call__(self, options, arguments):
 
274
        Command.__init__(self, options, arguments)
 
275
        return self
 
276
 
 
277
    def run(self, **kargs):
 
278
        opts = []
 
279
        args = []
 
280
 
 
281
        keys = kargs.keys()
 
282
        keys.sort()
 
283
        for name in keys:
 
284
            optname = name.replace('_','-')
 
285
            value = kargs[name]
 
286
            if OPTIONS.has_key(optname):
 
287
                # it's an option
 
288
                opts.append('--%s' % optname)
 
289
                if value is not None and value is not True:
 
290
                    opts.append(str(value))
 
291
            else:
 
292
                # it's an arg, or arg list
 
293
                if type(value) is not list:
 
294
                    value = [value]
 
295
                for v in value:
 
296
                    if v is not None:
 
297
                        args.append(str(v))
 
298
 
 
299
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
300
        return self.status
 
301
 
 
302
 
 
303
class cmd_status(Command):
 
304
    """Display status summary.
 
305
 
 
306
    This reports on versioned and unknown files, reporting them
 
307
    grouped by state.  Possible states are:
 
308
 
 
309
    added
 
310
        Versioned in the working copy but not in the previous revision.
 
311
 
 
312
    removed
 
313
        Versioned in the previous revision but removed or deleted
 
314
        in the working copy.
 
315
 
 
316
    renamed
 
317
        Path of this file changed from the previous revision;
 
318
        the text may also have changed.  This includes files whose
 
319
        parent directory was renamed.
 
320
 
 
321
    modified
 
322
        Text has changed since the previous revision.
 
323
 
 
324
    unchanged
 
325
        Nothing about this file has changed since the previous revision.
 
326
        Only shown with --all.
 
327
 
 
328
    unknown
 
329
        Not versioned and not matching an ignore pattern.
 
330
 
 
331
    To see ignored files use 'bzr ignored'.  For details in the
 
332
    changes to file texts, use 'bzr diff'.
 
333
 
 
334
    If no arguments are specified, the status of the entire working
 
335
    directory is shown.  Otherwise, only the status of the specified
 
336
    files or directories is reported.  If a directory is given, status
 
337
    is reported for everything inside that directory.
 
338
 
 
339
    If a revision is specified, the changes since that revision are shown.
 
340
    """
 
341
    takes_args = ['file*']
 
342
    takes_options = ['all', 'show-ids', 'revision']
 
343
    aliases = ['st', 'stat']
 
344
    
 
345
    def run(self, all=False, show_ids=False, file_list=None):
 
346
        if file_list:
 
347
            b = find_branch(file_list[0])
 
348
            file_list = [b.relpath(x) for x in file_list]
 
349
            # special case: only one path was given and it's the root
 
350
            # of the branch
 
351
            if file_list == ['']:
 
352
                file_list = None
 
353
        else:
 
354
            b = find_branch('.')
 
355
            
 
356
        from bzrlib.status import show_status
 
357
        show_status(b, show_unchanged=all, show_ids=show_ids,
 
358
                    specific_files=file_list)
 
359
 
 
360
 
 
361
class cmd_cat_revision(Command):
 
362
    """Write out metadata for a revision."""
 
363
 
 
364
    hidden = True
 
365
    takes_args = ['revision_id']
 
366
    
 
367
    def run(self, revision_id):
 
368
        from bzrlib.xml import pack_xml
 
369
        pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
 
370
 
 
371
 
 
372
class cmd_revno(Command):
 
373
    """Show current revision number.
 
374
 
 
375
    This is equal to the number of revisions on this branch."""
 
376
    def run(self):
 
377
        print find_branch('.').revno()
 
378
 
 
379
class cmd_revision_info(Command):
 
380
    """Show revision number and revision id for a given revision identifier.
 
381
    """
 
382
    hidden = True
 
383
    takes_args = ['revision_info*']
 
384
    takes_options = ['revision']
 
385
    def run(self, revision=None, revision_info_list=None):
 
386
        from bzrlib.branch import find_branch
 
387
 
 
388
        revs = []
 
389
        if revision is not None:
 
390
            revs.extend(revision)
 
391
        if revision_info_list is not None:
 
392
            revs.extend(revision_info_list)
 
393
        if len(revs) == 0:
 
394
            raise BzrCommandError('You must supply a revision identifier')
 
395
 
 
396
        b = find_branch('.')
 
397
 
 
398
        for rev in revs:
 
399
            print '%4d %s' % b.get_revision_info(rev)
 
400
 
 
401
    
 
402
class cmd_add(Command):
 
403
    """Add specified files or directories.
 
404
 
 
405
    In non-recursive mode, all the named items are added, regardless
 
406
    of whether they were previously ignored.  A warning is given if
 
407
    any of the named files are already versioned.
 
408
 
 
409
    In recursive mode (the default), files are treated the same way
 
410
    but the behaviour for directories is different.  Directories that
 
411
    are already versioned do not give a warning.  All directories,
 
412
    whether already versioned or not, are searched for files or
 
413
    subdirectories that are neither versioned or ignored, and these
 
414
    are added.  This search proceeds recursively into versioned
 
415
    directories.  If no names are given '.' is assumed.
 
416
 
 
417
    Therefore simply saying 'bzr add' will version all files that
 
418
    are currently unknown.
 
419
 
 
420
    TODO: Perhaps adding a file whose directly is not versioned should
 
421
    recursively add that parent, rather than giving an error?
 
422
    """
 
423
    takes_args = ['file*']
 
424
    takes_options = ['verbose', 'no-recurse']
 
425
    
 
426
    def run(self, file_list, verbose=False, no_recurse=False):
 
427
        from bzrlib.add import smart_add
 
428
        smart_add(file_list, verbose, not no_recurse)
 
429
 
 
430
 
 
431
 
 
432
class cmd_mkdir(Command):
 
433
    """Create a new versioned directory.
 
434
 
 
435
    This is equivalent to creating the directory and then adding it.
 
436
    """
 
437
    takes_args = ['dir+']
 
438
 
 
439
    def run(self, dir_list):
 
440
        b = None
 
441
        
 
442
        for d in dir_list:
 
443
            os.mkdir(d)
 
444
            if not b:
 
445
                b = find_branch(d)
 
446
            b.add([d], verbose=True)
 
447
 
 
448
 
 
449
class cmd_relpath(Command):
 
450
    """Show path of a file relative to root"""
 
451
    takes_args = ['filename']
 
452
    hidden = True
 
453
    
 
454
    def run(self, filename):
 
455
        print find_branch(filename).relpath(filename)
 
456
 
 
457
 
 
458
 
 
459
class cmd_inventory(Command):
 
460
    """Show inventory of the current working copy or a revision."""
 
461
    takes_options = ['revision', 'show-ids']
 
462
    
 
463
    def run(self, revision=None, show_ids=False):
 
464
        b = find_branch('.')
 
465
        if revision == None:
 
466
            inv = b.read_working_inventory()
 
467
        else:
 
468
            if len(revision) > 1:
 
469
                raise BzrCommandError('bzr inventory --revision takes'
 
470
                    ' exactly one revision identifier')
 
471
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
 
472
 
 
473
        for path, entry in inv.entries():
 
474
            if show_ids:
 
475
                print '%-50s %s' % (path, entry.file_id)
 
476
            else:
 
477
                print path
 
478
 
 
479
 
 
480
class cmd_move(Command):
 
481
    """Move files to a different directory.
 
482
 
 
483
    examples:
 
484
        bzr move *.txt doc
 
485
 
 
486
    The destination must be a versioned directory in the same branch.
 
487
    """
 
488
    takes_args = ['source$', 'dest']
 
489
    def run(self, source_list, dest):
 
490
        b = find_branch('.')
 
491
 
 
492
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
493
 
 
494
 
 
495
class cmd_rename(Command):
 
496
    """Change the name of an entry.
 
497
 
 
498
    examples:
 
499
      bzr rename frob.c frobber.c
 
500
      bzr rename src/frob.c lib/frob.c
 
501
 
 
502
    It is an error if the destination name exists.
 
503
 
 
504
    See also the 'move' command, which moves files into a different
 
505
    directory without changing their name.
 
506
 
 
507
    TODO: Some way to rename multiple files without invoking bzr for each
 
508
    one?"""
 
509
    takes_args = ['from_name', 'to_name']
 
510
    
 
511
    def run(self, from_name, to_name):
 
512
        b = find_branch('.')
 
513
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
514
 
 
515
 
 
516
 
 
517
 
 
518
 
 
519
class cmd_pull(Command):
 
520
    """Pull any changes from another branch into the current one.
 
521
 
 
522
    If the location is omitted, the last-used location will be used.
 
523
    Both the revision history and the working directory will be
 
524
    updated.
 
525
 
 
526
    This command only works on branches that have not diverged.  Branches are
 
527
    considered diverged if both branches have had commits without first
 
528
    pulling from the other.
 
529
 
 
530
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
531
    from one into the other.
 
532
    """
 
533
    takes_args = ['location?']
 
534
 
 
535
    def run(self, location=None):
 
536
        from bzrlib.merge import merge
 
537
        import tempfile
 
538
        from shutil import rmtree
 
539
        import errno
 
540
        
 
541
        br_to = find_branch('.')
 
542
        stored_loc = None
 
543
        try:
 
544
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
 
545
        except IOError, e:
 
546
            if e.errno != errno.ENOENT:
 
547
                raise
 
548
        if location is None:
 
549
            if stored_loc is None:
 
550
                raise BzrCommandError("No pull location known or specified.")
 
551
            else:
 
552
                print "Using last location: %s" % stored_loc
 
553
                location = stored_loc
 
554
        cache_root = tempfile.mkdtemp()
 
555
        from bzrlib.branch import DivergedBranches
 
556
        br_from = find_branch(location)
 
557
        location = pull_loc(br_from)
 
558
        old_revno = br_to.revno()
 
559
        try:
 
560
            from branch import find_cached_branch, DivergedBranches
 
561
            br_from = find_cached_branch(location, cache_root)
 
562
            location = pull_loc(br_from)
 
563
            old_revno = br_to.revno()
 
564
            try:
 
565
                br_to.update_revisions(br_from)
 
566
            except DivergedBranches:
 
567
                raise BzrCommandError("These branches have diverged."
 
568
                    "  Try merge.")
 
569
                
 
570
            merge(('.', -1), ('.', old_revno), check_clean=False)
 
571
            if location != stored_loc:
 
572
                br_to.controlfile("x-pull", "wb").write(location + "\n")
 
573
        finally:
 
574
            rmtree(cache_root)
 
575
 
 
576
 
 
577
 
 
578
class cmd_branch(Command):
 
579
    """Create a new copy of a branch.
 
580
 
 
581
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
582
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
583
 
 
584
    To retrieve the branch as of a particular revision, supply the --revision
 
585
    parameter, as in "branch foo/bar -r 5".
 
586
    """
 
587
    takes_args = ['from_location', 'to_location?']
 
588
    takes_options = ['revision']
 
589
 
 
590
    def run(self, from_location, to_location=None, revision=None):
 
591
        import errno
 
592
        from bzrlib.merge import merge
 
593
        from bzrlib.branch import DivergedBranches, NoSuchRevision, \
 
594
             find_cached_branch, Branch
 
595
        from shutil import rmtree
 
596
        from meta_store import CachedStore
 
597
        import tempfile
 
598
        cache_root = tempfile.mkdtemp()
 
599
 
 
600
        if revision is None:
 
601
            revision = [None]
 
602
        elif len(revision) > 1:
 
603
            raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
 
604
 
 
605
        try:
 
606
            try:
 
607
                br_from = find_cached_branch(from_location, cache_root)
 
608
            except OSError, e:
 
609
                if e.errno == errno.ENOENT:
 
610
                    raise BzrCommandError('Source location "%s" does not'
 
611
                                          ' exist.' % to_location)
 
612
                else:
 
613
                    raise
 
614
 
 
615
            if to_location is None:
 
616
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
617
 
 
618
            try:
 
619
                os.mkdir(to_location)
 
620
            except OSError, e:
 
621
                if e.errno == errno.EEXIST:
 
622
                    raise BzrCommandError('Target directory "%s" already'
 
623
                                          ' exists.' % to_location)
 
624
                if e.errno == errno.ENOENT:
 
625
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
626
                                          to_location)
 
627
                else:
 
628
                    raise
 
629
            br_to = Branch(to_location, init=True)
 
630
 
 
631
            br_to.set_root_id(br_from.get_root_id())
 
632
 
 
633
            if revision:
 
634
                if revision[0] is None:
 
635
                    revno = br_from.revno()
 
636
                else:
 
637
                    revno, rev_id = br_from.get_revision_info(revision[0])
 
638
                try:
 
639
                    br_to.update_revisions(br_from, stop_revision=revno)
 
640
                except NoSuchRevision:
 
641
                    rmtree(to_location)
 
642
                    msg = "The branch %s has no revision %d." % (from_location,
 
643
                                                                 revno)
 
644
                    raise BzrCommandError(msg)
 
645
            
 
646
            merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
647
                  check_clean=False, ignore_zero=True)
 
648
            from_location = pull_loc(br_from)
 
649
            br_to.controlfile("x-pull", "wb").write(from_location + "\n")
 
650
        finally:
 
651
            rmtree(cache_root)
 
652
 
 
653
 
 
654
def pull_loc(branch):
 
655
    # TODO: Should perhaps just make attribute be 'base' in
 
656
    # RemoteBranch and Branch?
 
657
    if hasattr(branch, "baseurl"):
 
658
        return branch.baseurl
 
659
    else:
 
660
        return branch.base
 
661
 
 
662
 
 
663
 
 
664
class cmd_renames(Command):
 
665
    """Show list of renamed files.
 
666
 
 
667
    TODO: Option to show renames between two historical versions.
 
668
 
 
669
    TODO: Only show renames under dir, rather than in the whole branch.
 
670
    """
 
671
    takes_args = ['dir?']
 
672
 
 
673
    def run(self, dir='.'):
 
674
        b = find_branch(dir)
 
675
        old_inv = b.basis_tree().inventory
 
676
        new_inv = b.read_working_inventory()
 
677
 
 
678
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
679
        renames.sort()
 
680
        for old_name, new_name in renames:
 
681
            print "%s => %s" % (old_name, new_name)        
 
682
 
 
683
 
 
684
class cmd_info(Command):
 
685
    """Show statistical information about a branch."""
 
686
    takes_args = ['branch?']
 
687
    
 
688
    def run(self, branch=None):
 
689
        import info
 
690
 
 
691
        b = find_branch(branch)
 
692
        info.show_info(b)
 
693
 
 
694
 
 
695
class cmd_remove(Command):
 
696
    """Make a file unversioned.
 
697
 
 
698
    This makes bzr stop tracking changes to a versioned file.  It does
 
699
    not delete the working copy.
 
700
    """
 
701
    takes_args = ['file+']
 
702
    takes_options = ['verbose']
 
703
    
 
704
    def run(self, file_list, verbose=False):
 
705
        b = find_branch(file_list[0])
 
706
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
707
 
 
708
 
 
709
class cmd_file_id(Command):
 
710
    """Print file_id of a particular file or directory.
 
711
 
 
712
    The file_id is assigned when the file is first added and remains the
 
713
    same through all revisions where the file exists, even when it is
 
714
    moved or renamed.
 
715
    """
 
716
    hidden = True
 
717
    takes_args = ['filename']
 
718
    def run(self, filename):
 
719
        b = find_branch(filename)
 
720
        i = b.inventory.path2id(b.relpath(filename))
 
721
        if i == None:
 
722
            raise BzrError("%r is not a versioned file" % filename)
 
723
        else:
 
724
            print i
 
725
 
 
726
 
 
727
class cmd_file_path(Command):
 
728
    """Print path of file_ids to a file or directory.
 
729
 
 
730
    This prints one line for each directory down to the target,
 
731
    starting at the branch root."""
 
732
    hidden = True
 
733
    takes_args = ['filename']
 
734
    def run(self, filename):
 
735
        b = find_branch(filename)
 
736
        inv = b.inventory
 
737
        fid = inv.path2id(b.relpath(filename))
 
738
        if fid == None:
 
739
            raise BzrError("%r is not a versioned file" % filename)
 
740
        for fip in inv.get_idpath(fid):
 
741
            print fip
 
742
 
 
743
 
 
744
class cmd_revision_history(Command):
 
745
    """Display list of revision ids on this branch."""
 
746
    hidden = True
 
747
    def run(self):
 
748
        for patchid in find_branch('.').revision_history():
 
749
            print patchid
 
750
 
 
751
 
 
752
class cmd_directories(Command):
 
753
    """Display list of versioned directories in this branch."""
 
754
    def run(self):
 
755
        for name, ie in find_branch('.').read_working_inventory().directories():
 
756
            if name == '':
 
757
                print '.'
 
758
            else:
 
759
                print name
 
760
 
 
761
 
 
762
class cmd_init(Command):
 
763
    """Make a directory into a versioned branch.
 
764
 
 
765
    Use this to create an empty branch, or before importing an
 
766
    existing project.
 
767
 
 
768
    Recipe for importing a tree of files:
 
769
        cd ~/project
 
770
        bzr init
 
771
        bzr add -v .
 
772
        bzr status
 
773
        bzr commit -m 'imported project'
 
774
    """
 
775
    def run(self):
 
776
        from bzrlib.branch import Branch
 
777
        Branch('.', init=True)
 
778
 
 
779
 
 
780
class cmd_diff(Command):
 
781
    """Show differences in working tree.
 
782
    
 
783
    If files are listed, only the changes in those files are listed.
 
784
    Otherwise, all changes for the tree are listed.
 
785
 
 
786
    TODO: Given two revision arguments, show the difference between them.
 
787
 
 
788
    TODO: Allow diff across branches.
 
789
 
 
790
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
791
          or a graphical diff.
 
792
 
 
793
    TODO: Python difflib is not exactly the same as unidiff; should
 
794
          either fix it up or prefer to use an external diff.
 
795
 
 
796
    TODO: If a directory is given, diff everything under that.
 
797
 
 
798
    TODO: Selected-file diff is inefficient and doesn't show you
 
799
          deleted files.
 
800
 
 
801
    TODO: This probably handles non-Unix newlines poorly.
 
802
    """
 
803
    
 
804
    takes_args = ['file*']
 
805
    takes_options = ['revision', 'diff-options']
 
806
    aliases = ['di', 'dif']
 
807
 
 
808
    def run(self, revision=None, file_list=None, diff_options=None):
 
809
        from bzrlib.diff import show_diff
 
810
 
 
811
        if file_list:
 
812
            b = find_branch(file_list[0])
 
813
            file_list = [b.relpath(f) for f in file_list]
 
814
            if file_list == ['']:
 
815
                # just pointing to top-of-tree
 
816
                file_list = None
 
817
        else:
 
818
            b = find_branch('.')
 
819
 
 
820
        # TODO: Make show_diff support taking 2 arguments
 
821
        base_rev = None
 
822
        if revision is not None:
 
823
            if len(revision) != 1:
 
824
                raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
 
825
            base_rev = revision[0]
 
826
    
 
827
        show_diff(b, base_rev, specific_files=file_list,
 
828
                  external_diff_options=diff_options)
 
829
 
 
830
 
 
831
        
 
832
 
 
833
 
 
834
class cmd_deleted(Command):
 
835
    """List files deleted in the working tree.
 
836
 
 
837
    TODO: Show files deleted since a previous revision, or between two revisions.
 
838
    """
 
839
    def run(self, show_ids=False):
 
840
        b = find_branch('.')
 
841
        old = b.basis_tree()
 
842
        new = b.working_tree()
 
843
 
 
844
        ## TODO: Much more efficient way to do this: read in new
 
845
        ## directories with readdir, rather than stating each one.  Same
 
846
        ## level of effort but possibly much less IO.  (Or possibly not,
 
847
        ## if the directories are very large...)
 
848
 
 
849
        for path, ie in old.inventory.iter_entries():
 
850
            if not new.has_id(ie.file_id):
 
851
                if show_ids:
 
852
                    print '%-50s %s' % (path, ie.file_id)
 
853
                else:
 
854
                    print path
 
855
 
 
856
 
 
857
class cmd_modified(Command):
 
858
    """List files modified in working tree."""
 
859
    hidden = True
 
860
    def run(self):
 
861
        from bzrlib.diff import compare_trees
 
862
 
 
863
        b = find_branch('.')
 
864
        td = compare_trees(b.basis_tree(), b.working_tree())
 
865
 
 
866
        for path, id, kind in td.modified:
 
867
            print path
 
868
 
 
869
 
 
870
 
 
871
class cmd_added(Command):
 
872
    """List files added in working tree."""
 
873
    hidden = True
 
874
    def run(self):
 
875
        b = find_branch('.')
 
876
        wt = b.working_tree()
 
877
        basis_inv = b.basis_tree().inventory
 
878
        inv = wt.inventory
 
879
        for file_id in inv:
 
880
            if file_id in basis_inv:
 
881
                continue
 
882
            path = inv.id2path(file_id)
 
883
            if not os.access(b.abspath(path), os.F_OK):
 
884
                continue
 
885
            print path
 
886
                
 
887
        
 
888
 
 
889
class cmd_root(Command):
 
890
    """Show the tree root directory.
 
891
 
 
892
    The root is the nearest enclosing directory with a .bzr control
 
893
    directory."""
 
894
    takes_args = ['filename?']
 
895
    def run(self, filename=None):
 
896
        """Print the branch root."""
 
897
        b = find_branch(filename)
 
898
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
899
 
 
900
 
 
901
class cmd_log(Command):
 
902
    """Show log of this branch.
 
903
 
 
904
    To request a range of logs, you can use the command -r begin:end
 
905
    -r revision requests a specific revision, -r :end or -r begin: are
 
906
    also valid.
 
907
 
 
908
    --message allows you to give a regular expression, which will be evaluated
 
909
    so that only matching entries will be displayed.
 
910
 
 
911
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
912
  
 
913
    """
 
914
 
 
915
    takes_args = ['filename?']
 
916
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
 
917
    
 
918
    def run(self, filename=None, timezone='original',
 
919
            verbose=False,
 
920
            show_ids=False,
 
921
            forward=False,
 
922
            revision=None,
 
923
            message=None,
 
924
            long=False):
 
925
        from bzrlib.branch import find_branch
 
926
        from bzrlib.log import log_formatter, show_log
 
927
        import codecs
 
928
 
 
929
        direction = (forward and 'forward') or 'reverse'
 
930
        
 
931
        if filename:
 
932
            b = find_branch(filename)
 
933
            fp = b.relpath(filename)
 
934
            if fp:
 
935
                file_id = b.read_working_inventory().path2id(fp)
 
936
            else:
 
937
                file_id = None  # points to branch root
 
938
        else:
 
939
            b = find_branch('.')
 
940
            file_id = None
 
941
 
 
942
        if revision is None:
 
943
            rev1 = None
 
944
            rev2 = None
 
945
        elif len(revision) == 1:
 
946
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
 
947
        elif len(revision) == 2:
 
948
            rev1 = b.get_revision_info(revision[0])[0]
 
949
            rev2 = b.get_revision_info(revision[1])[0]
 
950
        else:
 
951
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
952
 
 
953
        if rev1 == 0:
 
954
            rev1 = None
 
955
        if rev2 == 0:
 
956
            rev2 = None
 
957
 
 
958
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
959
 
 
960
        # use 'replace' so that we don't abort if trying to write out
 
961
        # in e.g. the default C locale.
 
962
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
963
 
 
964
        if long:
 
965
            log_format = 'long'
 
966
        else:
 
967
            log_format = 'short'
 
968
        lf = log_formatter(log_format,
 
969
                           show_ids=show_ids,
 
970
                           to_file=outf,
 
971
                           show_timezone=timezone)
 
972
 
 
973
        show_log(b,
 
974
                 lf,
 
975
                 file_id,
 
976
                 verbose=verbose,
 
977
                 direction=direction,
 
978
                 start_revision=rev1,
 
979
                 end_revision=rev2,
 
980
                 search=message)
 
981
 
 
982
 
 
983
 
 
984
class cmd_touching_revisions(Command):
 
985
    """Return revision-ids which affected a particular file.
 
986
 
 
987
    A more user-friendly interface is "bzr log FILE"."""
 
988
    hidden = True
 
989
    takes_args = ["filename"]
 
990
    def run(self, filename):
 
991
        b = find_branch(filename)
 
992
        inv = b.read_working_inventory()
 
993
        file_id = inv.path2id(b.relpath(filename))
 
994
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
995
            print "%6d %s" % (revno, what)
 
996
 
 
997
 
 
998
class cmd_ls(Command):
 
999
    """List files in a tree.
 
1000
 
 
1001
    TODO: Take a revision or remote path and list that tree instead.
 
1002
    """
 
1003
    hidden = True
 
1004
    def run(self, revision=None, verbose=False):
 
1005
        b = find_branch('.')
 
1006
        if revision == None:
 
1007
            tree = b.working_tree()
 
1008
        else:
 
1009
            tree = b.revision_tree(b.lookup_revision(revision))
 
1010
 
 
1011
        for fp, fc, kind, fid in tree.list_files():
 
1012
            if verbose:
 
1013
                if kind == 'directory':
 
1014
                    kindch = '/'
 
1015
                elif kind == 'file':
 
1016
                    kindch = ''
 
1017
                else:
 
1018
                    kindch = '???'
 
1019
 
 
1020
                print '%-8s %s%s' % (fc, fp, kindch)
 
1021
            else:
 
1022
                print fp
 
1023
 
 
1024
 
 
1025
 
 
1026
class cmd_unknowns(Command):
 
1027
    """List unknown files."""
 
1028
    def run(self):
 
1029
        from bzrlib.osutils import quotefn
 
1030
        for f in find_branch('.').unknowns():
 
1031
            print quotefn(f)
 
1032
 
 
1033
 
 
1034
 
 
1035
class cmd_ignore(Command):
 
1036
    """Ignore a command or pattern.
 
1037
 
 
1038
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1039
 
 
1040
    If the pattern contains a slash, it is compared to the whole path
 
1041
    from the branch root.  Otherwise, it is comapred to only the last
 
1042
    component of the path.
 
1043
 
 
1044
    Ignore patterns are case-insensitive on case-insensitive systems.
 
1045
 
 
1046
    Note: wildcards must be quoted from the shell on Unix.
 
1047
 
 
1048
    examples:
 
1049
        bzr ignore ./Makefile
 
1050
        bzr ignore '*.class'
 
1051
    """
 
1052
    takes_args = ['name_pattern']
 
1053
    
 
1054
    def run(self, name_pattern):
 
1055
        from bzrlib.atomicfile import AtomicFile
 
1056
        import os.path
 
1057
 
 
1058
        b = find_branch('.')
 
1059
        ifn = b.abspath('.bzrignore')
 
1060
 
 
1061
        if os.path.exists(ifn):
 
1062
            f = open(ifn, 'rt')
 
1063
            try:
 
1064
                igns = f.read().decode('utf-8')
 
1065
            finally:
 
1066
                f.close()
 
1067
        else:
 
1068
            igns = ''
 
1069
 
 
1070
        # TODO: If the file already uses crlf-style termination, maybe
 
1071
        # we should use that for the newly added lines?
 
1072
 
 
1073
        if igns and igns[-1] != '\n':
 
1074
            igns += '\n'
 
1075
        igns += name_pattern + '\n'
 
1076
 
 
1077
        try:
 
1078
            f = AtomicFile(ifn, 'wt')
 
1079
            f.write(igns.encode('utf-8'))
 
1080
            f.commit()
 
1081
        finally:
 
1082
            f.close()
 
1083
 
 
1084
        inv = b.working_tree().inventory
 
1085
        if inv.path2id('.bzrignore'):
 
1086
            mutter('.bzrignore is already versioned')
 
1087
        else:
 
1088
            mutter('need to make new .bzrignore file versioned')
 
1089
            b.add(['.bzrignore'])
 
1090
 
 
1091
 
 
1092
 
 
1093
class cmd_ignored(Command):
 
1094
    """List ignored files and the patterns that matched them.
 
1095
 
 
1096
    See also: bzr ignore"""
 
1097
    def run(self):
 
1098
        tree = find_branch('.').working_tree()
 
1099
        for path, file_class, kind, file_id in tree.list_files():
 
1100
            if file_class != 'I':
 
1101
                continue
 
1102
            ## XXX: Slightly inefficient since this was already calculated
 
1103
            pat = tree.is_ignored(path)
 
1104
            print '%-50s %s' % (path, pat)
 
1105
 
 
1106
 
 
1107
class cmd_lookup_revision(Command):
 
1108
    """Lookup the revision-id from a revision-number
 
1109
 
 
1110
    example:
 
1111
        bzr lookup-revision 33
 
1112
    """
 
1113
    hidden = True
 
1114
    takes_args = ['revno']
 
1115
    
 
1116
    def run(self, revno):
 
1117
        try:
 
1118
            revno = int(revno)
 
1119
        except ValueError:
 
1120
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1121
 
 
1122
        print find_branch('.').lookup_revision(revno)
 
1123
 
 
1124
 
 
1125
class cmd_export(Command):
 
1126
    """Export past revision to destination directory.
 
1127
 
 
1128
    If no revision is specified this exports the last committed revision.
 
1129
 
 
1130
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1131
    given, try to find the format with the extension. If no extension
 
1132
    is found exports to a directory (equivalent to --format=dir).
 
1133
 
 
1134
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1135
    is given, the top directory will be the root name of the file."""
 
1136
    # TODO: list known exporters
 
1137
    takes_args = ['dest']
 
1138
    takes_options = ['revision', 'format', 'root']
 
1139
    def run(self, dest, revision=None, format=None, root=None):
 
1140
        import os.path
 
1141
        b = find_branch('.')
 
1142
        if revision is None:
 
1143
            rev_id = b.last_patch()
 
1144
        else:
 
1145
            if len(revision) != 1:
 
1146
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1147
            revno, rev_id = b.get_revision_info(revision[0])
 
1148
        t = b.revision_tree(rev_id)
 
1149
        root, ext = os.path.splitext(dest)
 
1150
        if not format:
 
1151
            if ext in (".tar",):
 
1152
                format = "tar"
 
1153
            elif ext in (".gz", ".tgz"):
 
1154
                format = "tgz"
 
1155
            elif ext in (".bz2", ".tbz2"):
 
1156
                format = "tbz2"
 
1157
            else:
 
1158
                format = "dir"
 
1159
        t.export(dest, format, root)
 
1160
 
 
1161
 
 
1162
class cmd_cat(Command):
 
1163
    """Write a file's text from a previous revision."""
 
1164
 
 
1165
    takes_options = ['revision']
 
1166
    takes_args = ['filename']
 
1167
 
 
1168
    def run(self, filename, revision=None):
 
1169
        if revision == None:
 
1170
            raise BzrCommandError("bzr cat requires a revision number")
 
1171
        elif len(revision) != 1:
 
1172
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1173
        b = find_branch('.')
 
1174
        b.print_file(b.relpath(filename), revision[0])
 
1175
 
 
1176
 
 
1177
class cmd_local_time_offset(Command):
 
1178
    """Show the offset in seconds from GMT to local time."""
 
1179
    hidden = True    
 
1180
    def run(self):
 
1181
        print bzrlib.osutils.local_time_offset()
 
1182
 
 
1183
 
 
1184
 
 
1185
class cmd_commit(Command):
 
1186
    """Commit changes into a new revision.
 
1187
 
 
1188
    If selected files are specified, only changes to those files are
 
1189
    committed.  If a directory is specified then its contents are also
 
1190
    committed.
 
1191
 
 
1192
    A selected-file commit may fail in some cases where the committed
 
1193
    tree would be invalid, such as trying to commit a file in a
 
1194
    newly-added directory that is not itself committed.
 
1195
 
 
1196
    TODO: Run hooks on tree to-be-committed, and after commit.
 
1197
 
 
1198
    TODO: Strict commit that fails if there are unknown or deleted files.
 
1199
    """
 
1200
    takes_args = ['selected*']
 
1201
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
1202
    aliases = ['ci', 'checkin']
 
1203
 
 
1204
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1205
            unchanged=False):
 
1206
        from bzrlib.errors import PointlessCommit
 
1207
        from bzrlib.osutils import get_text_message
 
1208
 
 
1209
        ## Warning: shadows builtin file()
 
1210
        if not message and not file:
 
1211
            import cStringIO
 
1212
            stdout = sys.stdout
 
1213
            catcher = cStringIO.StringIO()
 
1214
            sys.stdout = catcher
 
1215
            cmd_status({"file_list":selected_list}, {})
 
1216
            info = catcher.getvalue()
 
1217
            sys.stdout = stdout
 
1218
            message = get_text_message(info)
 
1219
            
 
1220
            if message is None:
 
1221
                raise BzrCommandError("please specify a commit message",
 
1222
                                      ["use either --message or --file"])
 
1223
        elif message and file:
 
1224
            raise BzrCommandError("please specify either --message or --file")
 
1225
        
 
1226
        if file:
 
1227
            import codecs
 
1228
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1229
 
 
1230
        b = find_branch('.')
 
1231
 
 
1232
        try:
 
1233
            b.commit(message, verbose=verbose,
 
1234
                     specific_files=selected_list,
 
1235
                     allow_pointless=unchanged)
 
1236
        except PointlessCommit:
 
1237
            # FIXME: This should really happen before the file is read in;
 
1238
            # perhaps prepare the commit; get the message; then actually commit
 
1239
            raise BzrCommandError("no changes to commit",
 
1240
                                  ["use --unchanged to commit anyhow"])
 
1241
 
 
1242
 
 
1243
class cmd_check(Command):
 
1244
    """Validate consistency of branch history.
 
1245
 
 
1246
    This command checks various invariants about the branch storage to
 
1247
    detect data corruption or bzr bugs.
 
1248
 
 
1249
    If given the --update flag, it will update some optional fields
 
1250
    to help ensure data consistency.
 
1251
    """
 
1252
    takes_args = ['dir?']
 
1253
 
 
1254
    def run(self, dir='.'):
 
1255
        from bzrlib.check import check
 
1256
        check(find_branch(dir))
 
1257
 
 
1258
 
 
1259
 
 
1260
class cmd_scan_cache(Command):
 
1261
    hidden = True
 
1262
    def run(self):
 
1263
        from bzrlib.hashcache import HashCache
 
1264
        import os
 
1265
 
 
1266
        c = HashCache('.')
 
1267
        c.read()
 
1268
        c.scan()
 
1269
            
 
1270
        print '%6d stats' % c.stat_count
 
1271
        print '%6d in hashcache' % len(c._cache)
 
1272
        print '%6d files removed from cache' % c.removed_count
 
1273
        print '%6d hashes updated' % c.update_count
 
1274
        print '%6d files changed too recently to cache' % c.danger_count
 
1275
 
 
1276
        if c.needs_write:
 
1277
            c.write()
 
1278
            
 
1279
 
 
1280
 
 
1281
class cmd_upgrade(Command):
 
1282
    """Upgrade branch storage to current format.
 
1283
 
 
1284
    This should normally be used only after the check command tells
 
1285
    you to run it.
 
1286
    """
 
1287
    takes_args = ['dir?']
 
1288
 
 
1289
    def run(self, dir='.'):
 
1290
        from bzrlib.upgrade import upgrade
 
1291
        upgrade(find_branch(dir))
 
1292
 
 
1293
 
 
1294
 
 
1295
class cmd_whoami(Command):
 
1296
    """Show bzr user id."""
 
1297
    takes_options = ['email']
 
1298
    
 
1299
    def run(self, email=False):
 
1300
        if email:
 
1301
            print bzrlib.osutils.user_email()
 
1302
        else:
 
1303
            print bzrlib.osutils.username()
 
1304
 
 
1305
 
 
1306
class cmd_selftest(Command):
 
1307
    """Run internal test suite"""
 
1308
    hidden = True
 
1309
    takes_options = ['verbose']
 
1310
    def run(self, verbose=False):
 
1311
        from bzrlib.selftest import selftest
 
1312
        return int(not selftest(verbose=verbose))
 
1313
 
 
1314
 
 
1315
class cmd_version(Command):
 
1316
    """Show version of bzr."""
 
1317
    def run(self):
 
1318
        show_version()
 
1319
 
 
1320
def show_version():
 
1321
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1322
    # is bzrlib itself in a branch?
 
1323
    bzrrev = bzrlib.get_bzr_revision()
 
1324
    if bzrrev:
 
1325
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
1326
    print bzrlib.__copyright__
 
1327
    print "http://bazaar-ng.org/"
 
1328
    print
 
1329
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1330
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1331
    print "General Public License version 2 or later."
 
1332
 
 
1333
 
 
1334
class cmd_rocks(Command):
 
1335
    """Statement of optimism."""
 
1336
    hidden = True
 
1337
    def run(self):
 
1338
        print "it sure does!"
326
1339
 
327
1340
def parse_spec(spec):
328
1341
    """
357
1370
 
358
1371
 
359
1372
 
 
1373
class cmd_merge(Command):
 
1374
    """Perform a three-way merge of trees.
 
1375
    
 
1376
    The SPEC parameters are working tree or revision specifiers.  Working trees
 
1377
    are specified using standard paths or urls.  No component of a directory
 
1378
    path may begin with '@'.
 
1379
    
 
1380
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
 
1381
 
 
1382
    Revisions are specified using a dirname/@revno pair, where dirname is the
 
1383
    branch directory and revno is the revision within that branch.  If no revno
 
1384
    is specified, the latest revision is used.
 
1385
 
 
1386
    Revision examples: './@127', 'foo/@', '../@1'
 
1387
 
 
1388
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
 
1389
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
 
1390
    as the BASE.
 
1391
 
 
1392
    merge refuses to run if there are any uncommitted changes, unless
 
1393
    --force is given.
 
1394
    """
 
1395
    takes_args = ['other_spec', 'base_spec?']
 
1396
    takes_options = ['force']
 
1397
 
 
1398
    def run(self, other_spec, base_spec=None, force=False):
 
1399
        from bzrlib.merge import merge
 
1400
        merge(parse_spec(other_spec), parse_spec(base_spec),
 
1401
              check_clean=(not force))
 
1402
 
 
1403
 
 
1404
 
 
1405
class cmd_revert(Command):
 
1406
    """Restore selected files from a previous revision.
 
1407
    """
 
1408
    takes_args = ['file+']
 
1409
    def run(self, file_list):
 
1410
        from bzrlib.branch import find_branch
 
1411
        
 
1412
        if not file_list:
 
1413
            file_list = ['.']
 
1414
            
 
1415
        b = find_branch(file_list[0])
 
1416
 
 
1417
        b.revert([b.relpath(f) for f in file_list])
 
1418
 
 
1419
 
 
1420
class cmd_merge_revert(Command):
 
1421
    """Reverse all changes since the last commit.
 
1422
 
 
1423
    Only versioned files are affected.
 
1424
 
 
1425
    TODO: Store backups of any files that will be reverted, so
 
1426
          that the revert can be undone.          
 
1427
    """
 
1428
    takes_options = ['revision']
 
1429
 
 
1430
    def run(self, revision=None):
 
1431
        from bzrlib.merge import merge
 
1432
        if revision is None:
 
1433
            revision = [-1]
 
1434
        elif len(revision) != 1:
 
1435
            raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
 
1436
        merge(('.', revision[0]), parse_spec('.'),
 
1437
              check_clean=False,
 
1438
              ignore_zero=True)
 
1439
 
 
1440
 
 
1441
class cmd_assert_fail(Command):
 
1442
    """Test reporting of assertion failures"""
 
1443
    hidden = True
 
1444
    def run(self):
 
1445
        assert False, "always fails"
 
1446
 
 
1447
 
 
1448
class cmd_help(Command):
 
1449
    """Show help on a command or other topic.
 
1450
 
 
1451
    For a list of all available commands, say 'bzr help commands'."""
 
1452
    takes_args = ['topic?']
 
1453
    aliases = ['?']
 
1454
    
 
1455
    def run(self, topic=None):
 
1456
        import help
 
1457
        help.help(topic)
 
1458
 
 
1459
 
 
1460
 
 
1461
 
 
1462
class cmd_plugins(Command):
 
1463
    """List plugins"""
 
1464
    hidden = True
 
1465
    def run(self):
 
1466
        import bzrlib.plugin
 
1467
        from inspect import getdoc
 
1468
        from pprint import pprint
 
1469
        for plugin in bzrlib.plugin.all_plugins:
 
1470
            print plugin.__path__[0]
 
1471
            d = getdoc(plugin)
 
1472
            if d:
 
1473
                print '\t', d.split('\n')[0]
 
1474
 
 
1475
        #pprint(bzrlib.plugin.all_plugins)
 
1476
 
 
1477
 
360
1478
 
361
1479
# list of all available options; the rhs can be either None for an
362
1480
# option that takes no argument, or a constructor function that checks
373
1491
    'no-recurse':             None,
374
1492
    'profile':                None,
375
1493
    'revision':               _parse_revision_str,
376
 
    'short':                  None,
377
1494
    'show-ids':               None,
378
1495
    'timezone':               str,
379
1496
    'verbose':                None,
383
1500
    'update':                 None,
384
1501
    'long':                   None,
385
1502
    'root':                   str,
386
 
    'no-backup':              None,
387
 
    'merge-type':             get_merge_type,
388
 
    'pattern':                str,
389
1503
    }
390
1504
 
391
1505
SHORT_OPTIONS = {
408
1522
 
409
1523
    >>> parse_args('--help'.split())
410
1524
    ([], {'help': True})
411
 
    >>> parse_args('help -- --invalidcmd'.split())
412
 
    (['help', '--invalidcmd'], {})
413
1525
    >>> parse_args('--version'.split())
414
1526
    ([], {'version': True})
415
1527
    >>> parse_args('status --all'.split())
428
1540
    args = []
429
1541
    opts = {}
430
1542
 
431
 
    argsover = False
 
1543
    # TODO: Maybe handle '--' to end options?
 
1544
 
432
1545
    while argv:
433
1546
        a = argv.pop(0)
434
 
        if not argsover and a[0] == '-':
 
1547
        if a[0] == '-':
435
1548
            # option names must not be unicode
436
1549
            a = str(a)
437
1550
            optarg = None
438
1551
            if a[1] == '-':
439
 
                if a == '--':
440
 
                    # We've received a standalone -- No more flags
441
 
                    argsover = True
442
 
                    continue
443
1552
                mutter("  got option %r" % a)
444
1553
                if '=' in a:
445
1554
                    optname, optarg = a[2:].split('=', 1)
546
1655
    return argdict
547
1656
 
548
1657
 
549
 
 
550
 
def apply_profiled(the_callable, *args, **kwargs):
551
 
    import hotshot
552
 
    import tempfile
553
 
    pffileno, pfname = tempfile.mkstemp()
554
 
    try:
555
 
        prof = hotshot.Profile(pfname)
556
 
        try:
557
 
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
558
 
        finally:
559
 
            prof.close()
560
 
 
561
 
        import hotshot.stats
562
 
        stats = hotshot.stats.load(pfname)
563
 
        #stats.strip_dirs()
564
 
        stats.sort_stats('time')
565
 
        ## XXX: Might like to write to stderr or the trace file instead but
566
 
        ## print_stats seems hardcoded to stdout
567
 
        stats.print_stats(20)
568
 
 
569
 
        return ret
570
 
    finally:
571
 
        os.close(pffileno)
572
 
        os.remove(pfname)
 
1658
def _parse_master_args(argv):
 
1659
    """Parse the arguments that always go with the original command.
 
1660
    These are things like bzr --no-plugins, etc.
 
1661
 
 
1662
    There are now 2 types of option flags. Ones that come *before* the command,
 
1663
    and ones that come *after* the command.
 
1664
    Ones coming *before* the command are applied against all possible commands.
 
1665
    And are generally applied before plugins are loaded.
 
1666
 
 
1667
    The current list are:
 
1668
        --builtin   Allow plugins to load, but don't let them override builtin commands,
 
1669
                    they will still be allowed if they do not override a builtin.
 
1670
        --no-plugins    Don't load any plugins. This lets you get back to official source
 
1671
                        behavior.
 
1672
        --profile   Enable the hotspot profile before running the command.
 
1673
                    For backwards compatibility, this is also a non-master option.
 
1674
        --version   Spit out the version of bzr that is running and exit.
 
1675
                    This is also a non-master option.
 
1676
        --help      Run help and exit, also a non-master option (I think that should stay, though)
 
1677
 
 
1678
    >>> argv, opts = _parse_master_args(['--test'])
 
1679
    Traceback (most recent call last):
 
1680
    ...
 
1681
    BzrCommandError: Invalid master option: 'test'
 
1682
    >>> argv, opts = _parse_master_args(['--version', 'command'])
 
1683
    >>> print argv
 
1684
    ['command']
 
1685
    >>> print opts['version']
 
1686
    True
 
1687
    >>> argv, opts = _parse_master_args(['--profile', 'command', '--more-options'])
 
1688
    >>> print argv
 
1689
    ['command', '--more-options']
 
1690
    >>> print opts['profile']
 
1691
    True
 
1692
    >>> argv, opts = _parse_master_args(['--no-plugins', 'command'])
 
1693
    >>> print argv
 
1694
    ['command']
 
1695
    >>> print opts['no-plugins']
 
1696
    True
 
1697
    >>> print opts['profile']
 
1698
    False
 
1699
    >>> argv, opts = _parse_master_args(['command', '--profile'])
 
1700
    >>> print argv
 
1701
    ['command', '--profile']
 
1702
    >>> print opts['profile']
 
1703
    False
 
1704
    """
 
1705
    master_opts = {'builtin':False,
 
1706
        'no-plugins':False,
 
1707
        'version':False,
 
1708
        'profile':False,
 
1709
        'help':False
 
1710
    }
 
1711
 
 
1712
    for arg in argv[:]:
 
1713
        if arg[:2] != '--': # at the first non-option, we return the rest
 
1714
            break
 
1715
        arg = arg[2:] # Remove '--'
 
1716
        if arg not in master_opts:
 
1717
            # We could say that this is not an error, that we should
 
1718
            # just let it be handled by the main section instead
 
1719
            raise BzrCommandError('Invalid master option: %r' % arg)
 
1720
        argv.pop(0) # We are consuming this entry
 
1721
        master_opts[arg] = True
 
1722
    return argv, master_opts
 
1723
 
573
1724
 
574
1725
 
575
1726
def run_bzr(argv):
579
1730
    logging and error handling.  
580
1731
    
581
1732
    argv
582
 
       The command-line arguments, without the program name from argv[0]
 
1733
       The command-line arguments, without the program name.
583
1734
    
584
1735
    Returns a command status or raises an exception.
585
 
 
586
 
    Special master options: these must come before the command because
587
 
    they control how the command is interpreted.
588
 
 
589
 
    --no-plugins
590
 
        Do not load plugin modules at all
591
 
 
592
 
    --builtin
593
 
        Only use builtin commands.  (Plugins are still allowed to change
594
 
        other behaviour.)
595
 
 
596
 
    --profile
597
 
        Run under the Python profiler.
598
1736
    """
599
 
    
600
1737
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
601
1738
 
602
 
    opt_profile = opt_no_plugins = opt_builtin = False
603
 
 
604
 
    # --no-plugins is handled specially at a very early stage. We need
605
 
    # to load plugins before doing other command parsing so that they
606
 
    # can override commands, but this needs to happen first.
607
 
 
608
 
    for a in argv:
609
 
        if a == '--profile':
610
 
            opt_profile = True
611
 
        elif a == '--no-plugins':
612
 
            opt_no_plugins = True
613
 
        elif a == '--builtin':
614
 
            opt_builtin = True
615
 
        else:
616
 
            break
617
 
        argv.remove(a)
618
 
 
619
 
    if (not argv) or (argv[0] == '--help'):
 
1739
    # some options like --builtin and --no-plugins have special effects
 
1740
    argv, master_opts = _parse_master_args(argv)
 
1741
    if not master_opts['no-plugins']:
 
1742
        from bzrlib.plugin import load_plugins
 
1743
        load_plugins()
 
1744
 
 
1745
    args, opts = parse_args(argv)
 
1746
 
 
1747
    if master_opts.get('help') or 'help' in opts:
620
1748
        from bzrlib.help import help
621
 
        if len(argv) > 1:
622
 
            help(argv[1])
 
1749
        if argv:
 
1750
            help(argv[0])
623
1751
        else:
624
1752
            help()
625
 
        return 0
626
 
 
627
 
    if argv[0] == '--version':
628
 
        from bzrlib.builtins import show_version
 
1753
        return 0            
 
1754
        
 
1755
    if 'version' in opts:
629
1756
        show_version()
630
1757
        return 0
631
 
        
632
 
    if not opt_no_plugins:
633
 
        from bzrlib.plugin import load_plugins
634
 
        load_plugins()
635
 
 
636
 
    cmd = str(argv.pop(0))
637
 
 
638
 
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
639
 
 
640
 
    if opt_profile:
641
 
        ret = apply_profiled(cmd_obj.run_argv, argv)
 
1758
    
 
1759
    if args and args[0] == 'builtin':
 
1760
        include_plugins=False
 
1761
        args = args[1:]
 
1762
    
 
1763
    try:
 
1764
        cmd = str(args.pop(0))
 
1765
    except IndexError:
 
1766
        print >>sys.stderr, "please try 'bzr help' for help"
 
1767
        return 1
 
1768
 
 
1769
    plugins_override = not (master_opts['builtin'])
 
1770
    canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
 
1771
 
 
1772
    profile = master_opts['profile']
 
1773
    # For backwards compatibility, I would rather stick with --profile being a
 
1774
    # master/global option
 
1775
    if 'profile' in opts:
 
1776
        profile = True
 
1777
        del opts['profile']
 
1778
 
 
1779
    # check options are reasonable
 
1780
    allowed = cmd_class.takes_options
 
1781
    for oname in opts:
 
1782
        if oname not in allowed:
 
1783
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1784
                                  % (oname, cmd))
 
1785
 
 
1786
    # mix arguments and options into one dictionary
 
1787
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1788
    cmdopts = {}
 
1789
    for k, v in opts.items():
 
1790
        cmdopts[k.replace('-', '_')] = v
 
1791
 
 
1792
    if profile:
 
1793
        import hotshot, tempfile
 
1794
        pffileno, pfname = tempfile.mkstemp()
 
1795
        try:
 
1796
            prof = hotshot.Profile(pfname)
 
1797
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1798
            prof.close()
 
1799
 
 
1800
            import hotshot.stats
 
1801
            stats = hotshot.stats.load(pfname)
 
1802
            #stats.strip_dirs()
 
1803
            stats.sort_stats('time')
 
1804
            ## XXX: Might like to write to stderr or the trace file instead but
 
1805
            ## print_stats seems hardcoded to stdout
 
1806
            stats.print_stats(20)
 
1807
            
 
1808
            return ret.status
 
1809
 
 
1810
        finally:
 
1811
            os.close(pffileno)
 
1812
            os.remove(pfname)
642
1813
    else:
643
 
        ret = cmd_obj.run_argv(argv)
644
 
    return ret or 0
 
1814
        return cmd_class(cmdopts, cmdargs).status 
 
1815
 
 
1816
 
 
1817
def _report_exception(summary, quiet=False):
 
1818
    import traceback
 
1819
    log_error('bzr: ' + summary)
 
1820
    bzrlib.trace.log_exception()
 
1821
 
 
1822
    if not quiet:
 
1823
        tb = sys.exc_info()[2]
 
1824
        exinfo = traceback.extract_tb(tb)
 
1825
        if exinfo:
 
1826
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1827
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1828
 
645
1829
 
646
1830
 
647
1831
def main(argv):
648
 
    import bzrlib.ui
649
 
    bzrlib.trace.log_startup(argv)
650
 
    bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
 
1832
    
 
1833
    bzrlib.trace.open_tracefile(argv)
651
1834
 
652
1835
    try:
653
1836
        try:
656
1839
            finally:
657
1840
                # do this here inside the exception wrappers to catch EPIPE
658
1841
                sys.stdout.flush()
659
 
        #wrap common errors as CommandErrors.
660
 
        except (NotBranchError,), e:
661
 
            raise BzrCommandError(str(e))
662
 
    except BzrCommandError, e:
663
 
        # command line syntax error, etc
664
 
        log_error(str(e))
665
 
        return 1
666
 
    except BzrError, e:
667
 
        bzrlib.trace.log_exception()
668
 
        return 1
669
 
    except AssertionError, e:
670
 
        bzrlib.trace.log_exception('assertion failed: ' + str(e))
671
 
        return 3
672
 
    except KeyboardInterrupt, e:
673
 
        bzrlib.trace.note('interrupted')
674
 
        return 2
675
 
    except Exception, e:
676
 
        import errno
677
 
        if (isinstance(e, IOError) 
678
 
            and hasattr(e, 'errno')
679
 
            and e.errno == errno.EPIPE):
680
 
            bzrlib.trace.note('broken pipe')
681
 
            return 2
682
 
        else:
683
 
            bzrlib.trace.log_exception()
684
 
            return 2
 
1842
        except BzrError, e:
 
1843
            quiet = isinstance(e, (BzrCommandError))
 
1844
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1845
            if len(e.args) > 1:
 
1846
                for h in e.args[1]:
 
1847
                    # some explanation or hints
 
1848
                    log_error('  ' + h)
 
1849
            return 1
 
1850
        except AssertionError, e:
 
1851
            msg = 'assertion failed'
 
1852
            if str(e):
 
1853
                msg += ': ' + str(e)
 
1854
            _report_exception(msg)
 
1855
            return 2
 
1856
        except KeyboardInterrupt, e:
 
1857
            _report_exception('interrupted', quiet=True)
 
1858
            return 2
 
1859
        except Exception, e:
 
1860
            import errno
 
1861
            quiet = False
 
1862
            if (isinstance(e, IOError) 
 
1863
                and hasattr(e, 'errno')
 
1864
                and e.errno == errno.EPIPE):
 
1865
                quiet = True
 
1866
                msg = 'broken pipe'
 
1867
            else:
 
1868
                msg = str(e).rstrip('\n')
 
1869
            _report_exception(msg, quiet)
 
1870
            return 2
 
1871
    finally:
 
1872
        bzrlib.trace.close_trace()
685
1873
 
686
1874
 
687
1875
if __name__ == '__main__':