/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-02 23:01:56 UTC
  • Revision ID: mbp@sourcefrog.net-20050802230156-e5490541059dd847
todo

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