/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-12 15:24:19 UTC
  • Revision ID: mbp@sourcefrog.net-20050812152419-8f65f048a739f44d
- add revert command to tutorial

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