/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: aaron.bentley at utoronto
  • Date: 2005-08-09 02:29:48 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 1110.
  • Revision ID: aaron.bentley@utoronto.ca-20050809022948-8033a55a5b25c705
Fixed bugs in merge optimization

Show diffs side-by-side

added added

removed removed

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