/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: Martin Pool
  • Date: 2005-08-01 23:14:12 UTC
  • mfrom: (974.1.11)
  • Revision ID: mbp@sourcefrog.net-20050801231412-6a6278d24a7cbb0a
- merge aaron's revert and merge improvements

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