/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-05 19:23:12 UTC
  • Revision ID: mbp@sourcefrog.net-20050805192312-273968b3145cbcf6
- cleanup re-raise of exception

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