← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-07-04 12:11:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050704121140-fc4ab493bedc2e2f
- Deferred patch that uses Python ndiff format.

  This highlights the changes within a line, which is rather nice.  But it also
  outputs the entire file, which is less good.

Show diffs side-by-side

added added

removed removed

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