← 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-07-22 19:44:09 UTC
  • Revision ID: mbp@sourcefrog.net-20050722194409-9f99ffe3d62cf8c0
- tidy up imports to use full module names

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