~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-23 06:25:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050323062555-5489339018d0c043
- import a subset of elementtree for easier installation

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
 
1
#! /usr/bin/python
 
2
 
 
3
 
 
4
# Copyright (C) 2004, 2005 by Martin Pool
 
5
# Copyright (C) 2005 by Canonical Ltd
 
6
 
2
7
 
3
8
# This program is free software; you can redistribute it and/or modify
4
9
# it under the terms of the GNU General Public License as published by
14
19
# along with this program; if not, write to the Free Software
15
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
21
 
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
 
22
"""Bazaar-NG -- a free distributed version-control tool
 
23
 
 
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
 
25
 
 
26
Current limitation include:
 
27
 
 
28
* Metadata format is not stable yet -- you may need to
 
29
  discard history in the future.
 
30
 
 
31
* No handling of subdirectories, symlinks or any non-text files.
 
32
 
 
33
* Insufficient error handling.
 
34
 
 
35
* Many commands unimplemented or partially implemented.
 
36
 
 
37
* Space-inefficient storage.
 
38
 
 
39
* No merge operators yet.
 
40
 
 
41
Interesting commands::
 
42
 
 
43
  bzr help
 
44
       Show summary help screen
 
45
  bzr version
 
46
       Show software version/licence/non-warranty.
 
47
  bzr init
 
48
       Start versioning the current directory
 
49
  bzr add FILE...
 
50
       Make files versioned.
 
51
  bzr log
 
52
       Show revision history.
 
53
  bzr diff
 
54
       Show changes from last revision to working copy.
 
55
  bzr commit -m 'MESSAGE'
 
56
       Store current state as new revision.
 
57
  bzr export REVNO DESTINATION
 
58
       Export the branch state at a previous version.
 
59
  bzr status
 
60
       Show summary of pending changes.
 
61
  bzr remove FILE...
 
62
       Make a file not versioned.
 
63
"""
 
64
 
 
65
# not currently working:
 
66
#  bzr info
 
67
#       Show some information about this branch.
 
68
 
 
69
 
 
70
 
 
71
__copyright__ = "Copyright 2005 Canonical Development Ltd."
 
72
__author__ = "Martin Pool <mbp@canonical.com>"
 
73
__docformat__ = "restructuredtext en"
 
74
__version__ = '0.0.0'
 
75
 
 
76
 
 
77
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
 
78
import traceback, socket, fnmatch, difflib
 
79
from os import path
 
80
from sets import Set
 
81
from pprint import pprint
 
82
from stat import *
 
83
from glob import glob
25
84
 
26
85
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):
 
86
from bzrlib.store import ImmutableStore
 
87
from bzrlib.trace import mutter, note, log_error
 
88
from bzrlib.errors import bailout, BzrError
 
89
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
90
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
91
from bzrlib.revision import Revision
 
92
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
93
     format_date
 
94
 
 
95
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
 
96
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
 
97
 
 
98
## standard representation
 
99
NONE_STRING = '(none)'
 
100
EMPTY = 'empty'
 
101
 
 
102
 
 
103
## TODO: Perhaps a different version of inventory commands that
 
104
## returns iterators...
 
105
 
 
106
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
 
107
 
 
108
## TODO: Some kind of locking on branches.  Perhaps there should be a
 
109
## parameter to the branch object saying whether we want a read or
 
110
## write lock; release it from destructor.  Perhaps don't even need a
 
111
## read lock to look at immutable objects?
 
112
 
 
113
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
 
114
## to compare output?
 
115
 
 
116
## TODO: Some kind of global code to generate the right Branch object
 
117
## to work on.  Almost, but not quite all, commands need one, and it
 
118
## can be taken either from their parameters or their working
 
119
## directory.
 
120
 
 
121
## TODO: rename command, needed soon: check destination doesn't exist
 
122
## either in working copy or tree; move working copy; update
 
123
## inventory; write out
 
124
 
 
125
## TODO: move command; check destination is a directory and will not
 
126
## clash; move it.
 
127
 
 
128
## TODO: command to show renames, one per line, as to->from
 
129
 
 
130
 
 
131
 
 
132
 
 
133
def cmd_status(all=False):
339
134
    """Display status summary.
340
135
 
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):
 
136
    For each file there is a single line giving its file state and name.
 
137
    The name is that in the current revision unless it is deleted or
 
138
    missing, in which case the old name is shown.
 
139
 
 
140
    :todo: Don't show unchanged files unless ``--all`` is given?
 
141
    """
 
142
    Branch('.').show_status(show_all=all)
 
143
 
 
144
 
 
145
 
 
146
######################################################################
 
147
# examining history
 
148
def cmd_get_revision(revision_id):
 
149
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
150
 
 
151
 
 
152
def cmd_get_file_text(text_id):
 
153
    """Get contents of a file by hash."""
 
154
    sf = Branch('.').text_store[text_id]
 
155
    pumpfile(sf, sys.stdout)
 
156
 
 
157
 
 
158
 
 
159
######################################################################
 
160
# commands
 
161
    
 
162
 
 
163
def cmd_revno():
 
164
    """Show number of revisions on this branch"""
 
165
    print Branch('.').revno()
 
166
    
 
167
 
 
168
    
 
169
def cmd_add(file_list, verbose=False):
438
170
    """Add specified files or directories.
439
171
 
440
172
    In non-recursive mode, all the named items are added, regardless
447
179
    whether already versioned or not, are searched for files or
448
180
    subdirectories that are neither versioned or ignored, and these
449
181
    are added.  This search proceeds recursively into versioned
450
 
    directories.  If no names are given '.' is assumed.
 
182
    directories.
451
183
 
452
 
    Therefore simply saying 'bzr add' will version all files that
 
184
    Therefore simply saying 'bzr add .' will version all files that
453
185
    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):
 
186
    """
 
187
    if True:
 
188
        bzrlib.add.smart_add(file_list, verbose)
 
189
    else:
 
190
        # old way
 
191
        assert file_list
 
192
        b = Branch(file_list[0], find_root=True)
 
193
        b.add([b.relpath(f) for f in file_list], verbose=verbose)
 
194
 
 
195
    
 
196
 
 
197
def cmd_relpath(filename):
 
198
    print Branch(filename).relpath(filename)
 
199
 
 
200
 
 
201
def cmd_inventory(revision=None):
 
202
    """Show inventory of the current working copy."""
 
203
    ## TODO: Also optionally show a previous inventory
 
204
    ## TODO: Format options
 
205
    b = Branch('.')
 
206
    if revision == None:
 
207
        inv = b.read_working_inventory()
 
208
    else:
 
209
        inv = b.get_revision_inventory(b.lookup_revision(revision))
 
210
        
 
211
    for path, entry in inv.iter_entries():
 
212
        print '%-50s %s' % (entry.file_id, path)
 
213
 
 
214
 
 
215
 
 
216
def cmd_info():
 
217
    b = Branch('.')
 
218
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
 
219
 
 
220
    def plural(n, base='', pl=None):
 
221
        if n == 1:
 
222
            return base
 
223
        elif pl is not None:
 
224
            return pl
 
225
        else:
 
226
            return 's'
 
227
 
 
228
    count_version_dirs = 0
 
229
 
 
230
    count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
 
231
    for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
 
232
        fs = st_tup[0]
 
233
        count_status[fs] += 1
 
234
        if fs not in ['I', '?'] and st_tup[4] == 'directory':
 
235
            count_version_dirs += 1
 
236
 
 
237
    print
 
238
    print 'in the working tree:'
 
239
    for name, fs in (('unchanged', '.'),
 
240
                     ('modified', 'M'), ('added', 'A'), ('removed', 'D'),
 
241
                     ('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
 
242
                     ):
 
243
        print '  %5d %s' % (count_status[fs], name)
 
244
    print '  %5d versioned subdirector%s' % (count_version_dirs,
 
245
                                             plural(count_version_dirs, 'y', 'ies'))
 
246
 
 
247
    print
 
248
    print 'branch history:'
 
249
    history = b.revision_history()
 
250
    revno = len(history)
 
251
    print '  %5d revision%s' % (revno, plural(revno))
 
252
    committers = Set()
 
253
    for rev in history:
 
254
        committers.add(b.get_revision(rev).committer)
 
255
    print '  %5d committer%s' % (len(committers), plural(len(committers)))
 
256
    if revno > 0:
 
257
        firstrev = b.get_revision(history[0])
 
258
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
 
259
        print '  %5d day%s old' % (age, plural(age))
 
260
        print '  first revision: %s' % format_date(firstrev.timestamp,
 
261
                                                 firstrev.timezone)
 
262
 
 
263
        lastrev = b.get_revision(history[-1])
 
264
        print '  latest revision: %s' % format_date(lastrev.timestamp,
 
265
                                                    lastrev.timezone)
 
266
        
 
267
    
 
268
 
 
269
 
 
270
def cmd_remove(file_list, verbose=False):
 
271
    b = Branch(file_list[0])
 
272
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
273
 
 
274
 
 
275
 
 
276
def cmd_file_id(filename):
 
277
    b = Branch(filename)
 
278
    i = b.inventory.path2id(b.relpath(filename))
 
279
    if i is None:
 
280
        bailout("%s is not a versioned file" % filename)
 
281
    else:
 
282
        print i
 
283
 
 
284
 
 
285
def cmd_find_filename(fileid):
 
286
    n = find_filename(fileid)
 
287
    if n is None:
 
288
        bailout("%s is not a live file id" % fileid)
 
289
    else:
 
290
        print n
 
291
 
 
292
 
 
293
def cmd_revision_history():
 
294
    for patchid in Branch('.').revision_history():
 
295
        print patchid
 
296
 
 
297
 
 
298
 
 
299
def cmd_init():
 
300
    # TODO: Check we're not already in a working directory?  At the
 
301
    # moment you'll get an ugly error.
 
302
    
 
303
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
304
    # to allow that, but then the parent may need to understand that
 
305
    # the children have disappeared, or should they be versioned in
 
306
    # both?
 
307
 
 
308
    # TODO: Take an argument/option for branch name.
 
309
    Branch('.', init=True)
 
310
 
 
311
 
 
312
def cmd_diff(revision=None):
 
313
    """Show diff from basis to working copy.
 
314
 
 
315
    :todo: Take one or two revision arguments, look up those trees,
 
316
           and diff them.
 
317
 
 
318
    :todo: Allow diff across branches.
 
319
 
 
320
    :todo: Mangle filenames in diff to be more relevant.
 
321
 
 
322
    :todo: Shouldn't be in the cmd function.
 
323
    """
 
324
 
 
325
    b = Branch('.')
 
326
 
 
327
    if revision == None:
 
328
        old_tree = b.basis_tree()
 
329
    else:
 
330
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
331
        
 
332
    new_tree = b.working_tree()
 
333
    old_inv = old_tree.inventory
 
334
    new_inv = new_tree.inventory
 
335
 
 
336
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
337
    old_label = ''
 
338
    new_label = ''
 
339
 
 
340
    DEVNULL = '/dev/null'
 
341
    # Windows users, don't panic about this filename -- it is a
 
342
    # special signal to GNU patch that the file should be created or
 
343
    # deleted respectively.
 
344
 
 
345
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
346
    # be usefully made into a much faster special case.
 
347
 
 
348
    # TODO: Better to return them in sorted order I think.
 
349
    
 
350
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
351
        d = None
 
352
 
 
353
        # Don't show this by default; maybe do it if an option is passed
 
354
        # idlabel = '      {%s}' % fid
 
355
        idlabel = ''
 
356
 
 
357
        # FIXME: Something about the diff format makes patch unhappy
 
358
        # with newly-added files.
 
359
 
 
360
        def diffit(*a, **kw):
 
361
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
 
362
            print
 
363
        
 
364
        if file_state in ['.', '?', 'I']:
 
365
            continue
 
366
        elif file_state == 'A':
 
367
            print '*** added %s %r' % (kind, new_name)
 
368
            if kind == 'file':
 
369
                diffit([],
 
370
                       new_tree.get_file(fid).readlines(),
 
371
                       fromfile=DEVNULL,
 
372
                       tofile=new_label + new_name + idlabel)
 
373
        elif file_state == 'D':
 
374
            assert isinstance(old_name, types.StringTypes)
 
375
            print '*** deleted %s %r' % (kind, old_name)
 
376
            if kind == 'file':
 
377
                diffit(old_tree.get_file(fid).readlines(), [],
 
378
                       fromfile=old_label + old_name + idlabel,
 
379
                       tofile=DEVNULL)
 
380
        elif file_state in ['M', 'R']:
 
381
            if file_state == 'M':
 
382
                assert kind == 'file'
 
383
                assert old_name == new_name
 
384
                print '*** modified %s %r' % (kind, new_name)
 
385
            elif file_state == 'R':
 
386
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
387
 
 
388
            if kind == 'file':
 
389
                diffit(old_tree.get_file(fid).readlines(),
 
390
                       new_tree.get_file(fid).readlines(),
 
391
                       fromfile=old_label + old_name + idlabel,
 
392
                       tofile=new_label + new_name)
 
393
        else:
 
394
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
395
 
 
396
 
 
397
 
 
398
def cmd_root(filename=None):
 
399
    """Print the branch root."""
 
400
    print bzrlib.branch.find_branch_root(filename)
 
401
    
 
402
 
 
403
def cmd_log(timezone='original'):
976
404
    """Show log of this branch.
977
405
 
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
 
  
 
406
    :todo: Options for utc; to show ids; to limit range; etc.
987
407
    """
988
 
 
989
 
    takes_args = ['filename?']
990
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
991
 
                     'long', 'message', 'short',]
992
 
    
993
 
    def run(self, filename=None, timezone='original',
994
 
            verbose=False,
995
 
            show_ids=False,
996
 
            forward=False,
997
 
            revision=None,
998
 
            message=None,
999
 
            long=False,
1000
 
            short=False):
1001
 
        from bzrlib.branch import find_branch
1002
 
        from bzrlib.log import log_formatter, show_log
1003
 
        import codecs
1004
 
 
1005
 
        direction = (forward and 'forward') or 'reverse'
1006
 
        
1007
 
        if filename:
1008
 
            b = find_branch(filename)
1009
 
            fp = b.relpath(filename)
1010
 
            if fp:
1011
 
                file_id = b.read_working_inventory().path2id(fp)
1012
 
            else:
1013
 
                file_id = None  # points to branch root
1014
 
        else:
1015
 
            b = find_branch('.')
1016
 
            file_id = None
1017
 
 
1018
 
        if revision is None:
1019
 
            rev1 = None
1020
 
            rev2 = None
1021
 
        elif len(revision) == 1:
1022
 
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
1023
 
        elif len(revision) == 2:
1024
 
            rev1 = b.get_revision_info(revision[0])[0]
1025
 
            rev2 = b.get_revision_info(revision[1])[0]
1026
 
        else:
1027
 
            raise BzrCommandError('bzr log --revision takes one or two values.')
1028
 
 
1029
 
        if rev1 == 0:
1030
 
            rev1 = None
1031
 
        if rev2 == 0:
1032
 
            rev2 = None
1033
 
 
1034
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
1035
 
 
1036
 
        # use 'replace' so that we don't abort if trying to write out
1037
 
        # in e.g. the default C locale.
1038
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1039
 
 
1040
 
        if not short:
1041
 
            log_format = 'long'
1042
 
        else:
1043
 
            log_format = 'short'
1044
 
        lf = log_formatter(log_format,
1045
 
                           show_ids=show_ids,
1046
 
                           to_file=outf,
1047
 
                           show_timezone=timezone)
1048
 
 
1049
 
        show_log(b,
1050
 
                 lf,
1051
 
                 file_id,
1052
 
                 verbose=verbose,
1053
 
                 direction=direction,
1054
 
                 start_revision=rev1,
1055
 
                 end_revision=rev2,
1056
 
                 search=message)
1057
 
 
1058
 
 
1059
 
 
1060
 
class cmd_touching_revisions(Command):
1061
 
    """Return revision-ids which affected a particular file.
1062
 
 
1063
 
    A more user-friendly interface is "bzr log FILE"."""
1064
 
    hidden = True
1065
 
    takes_args = ["filename"]
1066
 
    def run(self, filename):
1067
 
        b = find_branch(filename)
1068
 
        inv = b.read_working_inventory()
1069
 
        file_id = inv.path2id(b.relpath(filename))
1070
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1071
 
            print "%6d %s" % (revno, what)
1072
 
 
1073
 
 
1074
 
class cmd_ls(Command):
 
408
    Branch('.').write_log(show_timezone=timezone)
 
409
 
 
410
 
 
411
def cmd_ls(revision=None, verbose=False):
1075
412
    """List files in a tree.
1076
413
 
1077
 
    TODO: Take a revision or remote path and list that tree instead.
1078
 
    """
1079
 
    hidden = True
1080
 
    def run(self, revision=None, verbose=False):
1081
 
        b = find_branch('.')
1082
 
        if revision == None:
1083
 
            tree = b.working_tree()
1084
 
        else:
1085
 
            tree = b.revision_tree(b.lookup_revision(revision))
1086
 
 
1087
 
        for fp, fc, kind, fid in tree.list_files():
1088
 
            if verbose:
1089
 
                if kind == 'directory':
1090
 
                    kindch = '/'
1091
 
                elif kind == 'file':
1092
 
                    kindch = ''
1093
 
                else:
1094
 
                    kindch = '???'
1095
 
 
1096
 
                print '%-8s %s%s' % (fc, fp, kindch)
1097
 
            else:
1098
 
                print fp
1099
 
 
1100
 
 
1101
 
 
1102
 
class cmd_unknowns(Command):
1103
 
    """List unknown files."""
1104
 
    def run(self):
1105
 
        from bzrlib.osutils import quotefn
1106
 
        for f in find_branch('.').unknowns():
1107
 
            print quotefn(f)
1108
 
 
1109
 
 
1110
 
 
1111
 
class cmd_ignore(Command):
1112
 
    """Ignore a command or pattern.
1113
 
 
1114
 
    To remove patterns from the ignore list, edit the .bzrignore file.
1115
 
 
1116
 
    If the pattern contains a slash, it is compared to the whole path
1117
 
    from the branch root.  Otherwise, it is comapred to only the last
1118
 
    component of the path.
1119
 
 
1120
 
    Ignore patterns are case-insensitive on case-insensitive systems.
1121
 
 
1122
 
    Note: wildcards must be quoted from the shell on Unix.
1123
 
 
1124
 
    examples:
1125
 
        bzr ignore ./Makefile
1126
 
        bzr ignore '*.class'
1127
 
    """
1128
 
    takes_args = ['name_pattern']
1129
 
    
1130
 
    def run(self, name_pattern):
1131
 
        from bzrlib.atomicfile import AtomicFile
1132
 
        import os.path
1133
 
 
1134
 
        b = find_branch('.')
1135
 
        ifn = b.abspath('.bzrignore')
1136
 
 
1137
 
        if os.path.exists(ifn):
1138
 
            f = open(ifn, 'rt')
1139
 
            try:
1140
 
                igns = f.read().decode('utf-8')
1141
 
            finally:
1142
 
                f.close()
1143
 
        else:
1144
 
            igns = ''
1145
 
 
1146
 
        # TODO: If the file already uses crlf-style termination, maybe
1147
 
        # we should use that for the newly added lines?
1148
 
 
1149
 
        if igns and igns[-1] != '\n':
1150
 
            igns += '\n'
1151
 
        igns += name_pattern + '\n'
1152
 
 
1153
 
        try:
1154
 
            f = AtomicFile(ifn, 'wt')
1155
 
            f.write(igns.encode('utf-8'))
1156
 
            f.commit()
1157
 
        finally:
1158
 
            f.close()
1159
 
 
1160
 
        inv = b.working_tree().inventory
1161
 
        if inv.path2id('.bzrignore'):
1162
 
            mutter('.bzrignore is already versioned')
1163
 
        else:
1164
 
            mutter('need to make new .bzrignore file versioned')
1165
 
            b.add(['.bzrignore'])
1166
 
 
1167
 
 
1168
 
 
1169
 
class cmd_ignored(Command):
1170
 
    """List ignored files and the patterns that matched them.
1171
 
 
1172
 
    See also: bzr ignore"""
1173
 
    def run(self):
1174
 
        tree = find_branch('.').working_tree()
1175
 
        for path, file_class, kind, file_id in tree.list_files():
1176
 
            if file_class != 'I':
1177
 
                continue
1178
 
            ## XXX: Slightly inefficient since this was already calculated
1179
 
            pat = tree.is_ignored(path)
1180
 
            print '%-50s %s' % (path, pat)
1181
 
 
1182
 
 
1183
 
class cmd_lookup_revision(Command):
1184
 
    """Lookup the revision-id from a revision-number
1185
 
 
1186
 
    example:
1187
 
        bzr lookup-revision 33
1188
 
    """
1189
 
    hidden = True
1190
 
    takes_args = ['revno']
1191
 
    
1192
 
    def run(self, revno):
1193
 
        try:
1194
 
            revno = int(revno)
1195
 
        except ValueError:
1196
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
1197
 
 
1198
 
        print find_branch('.').lookup_revision(revno)
1199
 
 
1200
 
 
1201
 
class cmd_export(Command):
1202
 
    """Export past revision to destination directory.
1203
 
 
1204
 
    If no revision is specified this exports the last committed revision.
1205
 
 
1206
 
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
1207
 
    given, try to find the format with the extension. If no extension
1208
 
    is found exports to a directory (equivalent to --format=dir).
1209
 
 
1210
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
1211
 
    is given, the top directory will be the root name of the file."""
1212
 
    # TODO: list known exporters
1213
 
    takes_args = ['dest']
1214
 
    takes_options = ['revision', 'format', 'root']
1215
 
    def run(self, dest, revision=None, format=None, root=None):
1216
 
        import os.path
1217
 
        b = find_branch('.')
1218
 
        if revision is None:
1219
 
            rev_id = b.last_patch()
1220
 
        else:
1221
 
            if len(revision) != 1:
1222
 
                raise BzrError('bzr export --revision takes exactly 1 argument')
1223
 
            revno, rev_id = b.get_revision_info(revision[0])
1224
 
        t = b.revision_tree(rev_id)
1225
 
        root, ext = os.path.splitext(dest)
1226
 
        if not format:
1227
 
            if ext in (".tar",):
1228
 
                format = "tar"
1229
 
            elif ext in (".gz", ".tgz"):
1230
 
                format = "tgz"
1231
 
            elif ext in (".bz2", ".tbz2"):
1232
 
                format = "tbz2"
1233
 
            else:
1234
 
                format = "dir"
1235
 
        t.export(dest, format, root)
1236
 
 
1237
 
 
1238
 
class cmd_cat(Command):
1239
 
    """Write a file's text from a previous revision."""
1240
 
 
1241
 
    takes_options = ['revision']
1242
 
    takes_args = ['filename']
1243
 
 
1244
 
    def run(self, filename, revision=None):
1245
 
        if revision == None:
1246
 
            raise BzrCommandError("bzr cat requires a revision number")
1247
 
        elif len(revision) != 1:
1248
 
            raise BzrCommandError("bzr cat --revision takes exactly one number")
1249
 
        b = find_branch('.')
1250
 
        b.print_file(b.relpath(filename), revision[0])
1251
 
 
1252
 
 
1253
 
class cmd_local_time_offset(Command):
1254
 
    """Show the offset in seconds from GMT to local time."""
1255
 
    hidden = True    
1256
 
    def run(self):
1257
 
        print bzrlib.osutils.local_time_offset()
1258
 
 
1259
 
 
1260
 
 
1261
 
class cmd_commit(Command):
1262
 
    """Commit changes into a new revision.
1263
 
    
1264
 
    If no arguments are given, the entire tree is committed.
1265
 
 
1266
 
    If selected files are specified, only changes to those files are
1267
 
    committed.  If a directory is specified then the directory and everything 
1268
 
    within it is committed.
1269
 
 
1270
 
    A selected-file commit may fail in some cases where the committed
1271
 
    tree would be invalid, such as trying to commit a file in a
1272
 
    newly-added directory that is not itself committed.
1273
 
 
1274
 
    TODO: Run hooks on tree to-be-committed, and after commit.
1275
 
 
1276
 
    TODO: Strict commit that fails if there are unknown or deleted files.
1277
 
    """
1278
 
    takes_args = ['selected*']
1279
 
    takes_options = ['message', 'file', 'verbose', 'unchanged']
1280
 
    aliases = ['ci', 'checkin']
1281
 
 
1282
 
    # TODO: Give better message for -s, --summary, used by tla people
1283
 
    
1284
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1285
 
            unchanged=False):
1286
 
        from bzrlib.errors import PointlessCommit
1287
 
        from bzrlib.osutils import get_text_message
1288
 
 
1289
 
        ## Warning: shadows builtin file()
1290
 
        if not message and not file:
1291
 
            # FIXME: Ugly; change status code to send to a provided function?
1292
 
            
1293
 
            import cStringIO
1294
 
            stdout = sys.stdout
1295
 
            catcher = cStringIO.StringIO()
1296
 
            sys.stdout = catcher
1297
 
            cmd_status({"file_list":selected_list}, {})
1298
 
            info = catcher.getvalue()
1299
 
            sys.stdout = stdout
1300
 
            message = get_text_message(info)
1301
 
            
1302
 
            if message is None:
1303
 
                raise BzrCommandError("please specify a commit message",
1304
 
                                      ["use either --message or --file"])
1305
 
        elif message and file:
1306
 
            raise BzrCommandError("please specify either --message or --file")
1307
 
        
1308
 
        if file:
1309
 
            import codecs
1310
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1311
 
 
1312
 
        b = find_branch('.')
1313
 
        if selected_list:
1314
 
            selected_list = [b.relpath(s) for s in selected_list]
1315
 
            
1316
 
        try:
1317
 
            b.commit(message, verbose=verbose,
1318
 
                     specific_files=selected_list,
1319
 
                     allow_pointless=unchanged)
1320
 
        except PointlessCommit:
1321
 
            # FIXME: This should really happen before the file is read in;
1322
 
            # perhaps prepare the commit; get the message; then actually commit
1323
 
            raise BzrCommandError("no changes to commit",
1324
 
                                  ["use --unchanged to commit anyhow"])
1325
 
 
1326
 
 
1327
 
class cmd_check(Command):
1328
 
    """Validate consistency of branch history.
1329
 
 
1330
 
    This command checks various invariants about the branch storage to
1331
 
    detect data corruption or bzr bugs.
1332
 
 
1333
 
    If given the --update flag, it will update some optional fields
1334
 
    to help ensure data consistency.
1335
 
    """
1336
 
    takes_args = ['dir?']
1337
 
 
1338
 
    def run(self, dir='.'):
1339
 
        from bzrlib.check import check
1340
 
        check(find_branch(dir))
1341
 
 
1342
 
 
1343
 
 
1344
 
class cmd_scan_cache(Command):
1345
 
    hidden = True
1346
 
    def run(self):
1347
 
        from bzrlib.hashcache import HashCache
1348
 
        import os
1349
 
 
1350
 
        c = HashCache('.')
1351
 
        c.read()
1352
 
        c.scan()
1353
 
            
1354
 
        print '%6d stats' % c.stat_count
1355
 
        print '%6d in hashcache' % len(c._cache)
1356
 
        print '%6d files removed from cache' % c.removed_count
1357
 
        print '%6d hashes updated' % c.update_count
1358
 
        print '%6d files changed too recently to cache' % c.danger_count
1359
 
 
1360
 
        if c.needs_write:
1361
 
            c.write()
1362
 
            
1363
 
 
1364
 
 
1365
 
class cmd_upgrade(Command):
1366
 
    """Upgrade branch storage to current format.
1367
 
 
1368
 
    This should normally be used only after the check command tells
1369
 
    you to run it.
1370
 
    """
1371
 
    takes_args = ['dir?']
1372
 
 
1373
 
    def run(self, dir='.'):
1374
 
        from bzrlib.upgrade import upgrade
1375
 
        upgrade(find_branch(dir))
1376
 
 
1377
 
 
1378
 
 
1379
 
class cmd_whoami(Command):
1380
 
    """Show bzr user id."""
1381
 
    takes_options = ['email']
1382
 
    
1383
 
    def run(self, email=False):
1384
 
        if email:
1385
 
            print bzrlib.osutils.user_email()
1386
 
        else:
1387
 
            print bzrlib.osutils.username()
1388
 
 
1389
 
 
1390
 
class cmd_selftest(Command):
 
414
    :todo: Take a revision or remote path and list that tree instead.
 
415
    """
 
416
    b = Branch('.')
 
417
    if revision == None:
 
418
        tree = b.working_tree()
 
419
    else:
 
420
        tree = b.revision_tree(b.lookup_revision(revision))
 
421
        
 
422
    for fp, fc, kind, fid in tree.list_files():
 
423
        if verbose:
 
424
            if kind == 'directory':
 
425
                kindch = '/'
 
426
            elif kind == 'file':
 
427
                kindch = ''
 
428
            else:
 
429
                kindch = '???'
 
430
                
 
431
            print '%-8s %s%s' % (fc, fp, kindch)
 
432
        else:
 
433
            print fp
 
434
    
 
435
    
 
436
 
 
437
def cmd_unknowns():
 
438
    """List unknown files"""
 
439
    for f in Branch('.').unknowns():
 
440
        print quotefn(f)
 
441
 
 
442
 
 
443
def cmd_lookup_revision(revno):
 
444
    try:
 
445
        revno = int(revno)
 
446
    except ValueError:
 
447
        bailout("usage: lookup-revision REVNO",
 
448
                ["REVNO is a non-negative revision number for this branch"])
 
449
 
 
450
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
451
 
 
452
 
 
453
 
 
454
def cmd_export(revno, dest):
 
455
    """Export past revision to destination directory."""
 
456
    b = Branch('.')
 
457
    rh = b.lookup_revision(int(revno))
 
458
    t = b.revision_tree(rh)
 
459
    t.export(dest)
 
460
 
 
461
 
 
462
 
 
463
######################################################################
 
464
# internal/test commands
 
465
 
 
466
 
 
467
def cmd_uuid():
 
468
    """Print a newly-generated UUID."""
 
469
    print bzrlib.osutils.uuid()
 
470
 
 
471
 
 
472
 
 
473
def cmd_local_time_offset():
 
474
    print bzrlib.osutils.local_time_offset()
 
475
 
 
476
 
 
477
 
 
478
def cmd_commit(message=None, verbose=False):
 
479
    if not message:
 
480
        bailout("please specify a commit message")
 
481
    Branch('.').commit(message, verbose=verbose)
 
482
 
 
483
 
 
484
def cmd_check():
 
485
    """Check consistency of the branch."""
 
486
    check()
 
487
 
 
488
 
 
489
def cmd_is(pred, *rest):
 
490
    """Test whether PREDICATE is true."""
 
491
    try:
 
492
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
493
    except KeyError:
 
494
        bailout("unknown predicate: %s" % quotefn(pred))
 
495
        
 
496
    try:
 
497
        cmd_handler(*rest)
 
498
    except BzrCheckError:
 
499
        # by default we don't print the message so that this can
 
500
        # be used from shell scripts without producing noise
 
501
        sys.exit(1)
 
502
 
 
503
 
 
504
def cmd_username():
 
505
    print bzrlib.osutils.username()
 
506
 
 
507
 
 
508
def cmd_user_email():
 
509
    print bzrlib.osutils.user_email()
 
510
 
 
511
 
 
512
def cmd_gen_revision_id():
 
513
    import time
 
514
    print bzrlib.branch._gen_revision_id(time.time())
 
515
 
 
516
 
 
517
def cmd_selftest(verbose=False):
1391
518
    """Run internal test suite"""
1392
 
    hidden = True
1393
 
    takes_options = ['verbose']
1394
 
    def run(self, verbose=False):
1395
 
        from bzrlib.selftest import selftest
1396
 
        return int(not selftest(verbose=verbose))
1397
 
 
1398
 
 
1399
 
class cmd_version(Command):
1400
 
    """Show version of bzr."""
1401
 
    def run(self):
1402
 
        show_version()
1403
 
 
1404
 
def show_version():
1405
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
1406
 
    # is bzrlib itself in a branch?
1407
 
    bzrrev = bzrlib.get_bzr_revision()
1408
 
    if bzrrev:
1409
 
        print "  (bzr checkout, revision %d {%s})" % bzrrev
1410
 
    print bzrlib.__copyright__
 
519
    ## -v, if present, is seen by doctest; the argument is just here
 
520
    ## so our parser doesn't complain
 
521
 
 
522
    ## TODO: --verbose option
 
523
 
 
524
    failures, tests = 0, 0
 
525
    
 
526
    import doctest, bzrlib.store, bzrlib.tests
 
527
    bzrlib.trace.verbose = False
 
528
 
 
529
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
530
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
531
        mf, mt = doctest.testmod(m)
 
532
        failures += mf
 
533
        tests += mt
 
534
        print '%-40s %3d tests' % (m.__name__, mt),
 
535
        if mf:
 
536
            print '%3d FAILED!' % mf
 
537
        else:
 
538
            print
 
539
 
 
540
    print '%-40s %3d tests' % ('total', tests),
 
541
    if failures:
 
542
        print '%3d FAILED!' % failures
 
543
    else:
 
544
        print
 
545
 
 
546
 
 
547
 
 
548
# deprecated
 
549
cmd_doctest = cmd_selftest
 
550
 
 
551
 
 
552
######################################################################
 
553
# help
 
554
 
 
555
 
 
556
def cmd_help():
 
557
    # TODO: Specific help for particular commands
 
558
    print __doc__
 
559
 
 
560
 
 
561
def cmd_version():
 
562
    print "bzr (bazaar-ng) %s" % __version__
 
563
    print __copyright__
1411
564
    print "http://bazaar-ng.org/"
1412
565
    print
1413
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
1414
 
    print "you may use, modify and redistribute it under the terms of the GNU"
1415
 
    print "General Public License version 2 or later."
1416
 
 
1417
 
 
1418
 
class cmd_rocks(Command):
 
566
    print \
 
567
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
568
you may use, modify and redistribute it under the terms of the GNU 
 
569
General Public License version 2 or later."""
 
570
 
 
571
 
 
572
def cmd_rocks():
1419
573
    """Statement of optimism."""
1420
 
    hidden = True
1421
 
    def run(self):
1422
 
        print "it sure does!"
1423
 
 
1424
 
def parse_spec(spec):
1425
 
    """
1426
 
    >>> parse_spec(None)
1427
 
    [None, None]
1428
 
    >>> parse_spec("./")
1429
 
    ['./', None]
1430
 
    >>> parse_spec("../@")
1431
 
    ['..', -1]
1432
 
    >>> parse_spec("../f/@35")
1433
 
    ['../f', 35]
1434
 
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1435
 
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1436
 
    """
1437
 
    if spec is None:
1438
 
        return [None, None]
1439
 
    if '/@' in spec:
1440
 
        parsed = spec.split('/@')
1441
 
        assert len(parsed) == 2
1442
 
        if parsed[1] == "":
1443
 
            parsed[1] = -1
1444
 
        else:
1445
 
            try:
1446
 
                parsed[1] = int(parsed[1])
1447
 
            except ValueError:
1448
 
                pass # We can allow stuff like ./@revid:blahblahblah
1449
 
            else:
1450
 
                assert parsed[1] >=0
1451
 
    else:
1452
 
        parsed = [spec, None]
1453
 
    return parsed
1454
 
 
1455
 
 
1456
 
 
1457
 
class cmd_merge(Command):
1458
 
    """Perform a three-way merge.
1459
 
    
1460
 
    The branch is the branch you will merge from.  By default, it will merge
1461
 
    the latest revision.  If you specify a revision, that revision will be
1462
 
    merged.  If you specify two revisions, the first will be used as a BASE, 
1463
 
    and the second one as OTHER.  Revision numbers are always relative to the
1464
 
    specified branch.
1465
 
    
1466
 
    Examples:
1467
 
 
1468
 
    To merge the latest revision from bzr.dev
1469
 
    bzr merge ../bzr.dev
1470
 
 
1471
 
    To merge changes up to and including revision 82 from bzr.dev
1472
 
    bzr merge -r 82 ../bzr.dev
1473
 
 
1474
 
    To merge the changes introduced by 82, without previous changes:
1475
 
    bzr merge -r 81..82 ../bzr.dev
1476
 
    
1477
 
    merge refuses to run if there are any uncommitted changes, unless
1478
 
    --force is given.
1479
 
    """
1480
 
    takes_args = ['branch?']
1481
 
    takes_options = ['revision', 'force', 'merge-type']
1482
 
 
1483
 
    def run(self, branch='.', revision=None, force=False, 
1484
 
            merge_type=None):
1485
 
        from bzrlib.merge import merge
1486
 
        from bzrlib.merge_core import ApplyMerge3
1487
 
        if merge_type is None:
1488
 
            merge_type = ApplyMerge3
1489
 
 
1490
 
        if revision is None or len(revision) < 1:
1491
 
            base = [None, None]
1492
 
            other = (branch, -1)
1493
 
        else:
1494
 
            if len(revision) == 1:
1495
 
                other = (branch, revision[0])
1496
 
                base = (None, None)
1497
 
            else:
1498
 
                assert len(revision) == 2
1499
 
                if None in revision:
1500
 
                    raise BzrCommandError(
1501
 
                        "Merge doesn't permit that revision specifier.")
1502
 
                base = (branch, revision[0])
1503
 
                other = (branch, revision[1])
1504
 
            
1505
 
        merge(other, base, check_clean=(not force), merge_type=merge_type)
1506
 
 
1507
 
 
1508
 
class cmd_revert(Command):
1509
 
    """Reverse all changes since the last commit.
1510
 
 
1511
 
    Only versioned files are affected.  Specify filenames to revert only 
1512
 
    those files.  By default, any files that are changed will be backed up
1513
 
    first.  Backup files have a '~' appended to their name.
1514
 
    """
1515
 
    takes_options = ['revision', 'no-backup']
1516
 
    takes_args = ['file*']
1517
 
    aliases = ['merge-revert']
1518
 
 
1519
 
    def run(self, revision=None, no_backup=False, file_list=None):
1520
 
        from bzrlib.merge import merge
1521
 
        from bzrlib.branch import Branch
1522
 
        if file_list is not None:
1523
 
            if len(file_list) == 0:
1524
 
                raise BzrCommandError("No files specified")
1525
 
        if revision is None:
1526
 
            revision = [-1]
1527
 
        elif len(revision) != 1:
1528
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1529
 
        merge(('.', revision[0]), parse_spec('.'),
1530
 
              check_clean=False,
1531
 
              ignore_zero=True,
1532
 
              backup_files=not no_backup,
1533
 
              file_list=file_list)
1534
 
        if not file_list:
1535
 
            Branch('.').set_pending_merges([])
1536
 
 
1537
 
 
1538
 
class cmd_assert_fail(Command):
1539
 
    """Test reporting of assertion failures"""
1540
 
    hidden = True
1541
 
    def run(self):
1542
 
        assert False, "always fails"
1543
 
 
1544
 
 
1545
 
class cmd_help(Command):
1546
 
    """Show help on a command or other topic.
1547
 
 
1548
 
    For a list of all available commands, say 'bzr help commands'."""
1549
 
    takes_args = ['topic?']
1550
 
    aliases = ['?']
1551
 
    
1552
 
    def run(self, topic=None):
1553
 
        import help
1554
 
        help.help(topic)
1555
 
 
1556
 
 
1557
 
 
1558
 
 
1559
 
class cmd_missing(Command):
1560
 
    """What is missing in this branch relative to other branch.
1561
 
    """
1562
 
    takes_args = ['remote?']
1563
 
    aliases = ['mis', 'miss']
1564
 
    # We don't have to add quiet to the list, because 
1565
 
    # unknown options are parsed as booleans
1566
 
    takes_options = ['verbose', 'quiet']
1567
 
 
1568
 
    def run(self, remote=None, verbose=False, quiet=False):
1569
 
        from bzrlib.branch import find_branch, DivergedBranches
1570
 
        from bzrlib.errors import BzrCommandError
1571
 
        from bzrlib.missing import get_parent, show_missing
1572
 
 
1573
 
        if verbose and quiet:
1574
 
            raise BzrCommandError('Cannot pass both quiet and verbose')
1575
 
 
1576
 
        b = find_branch('.')
1577
 
        parent = get_parent(b)
1578
 
        if remote is None:
1579
 
            if parent is None:
1580
 
                raise BzrCommandError("No missing location known or specified.")
1581
 
            else:
1582
 
                if not quiet:
1583
 
                    print "Using last location: %s" % parent
1584
 
                remote = parent
1585
 
        elif parent is None:
1586
 
            # We only update x-pull if it did not exist, missing should not change the parent
1587
 
            b.controlfile('x-pull', 'wb').write(remote + '\n')
1588
 
        br_remote = find_branch(remote)
1589
 
 
1590
 
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1591
 
 
1592
 
 
1593
 
class cmd_plugins(Command):
1594
 
    """List plugins"""
1595
 
    hidden = True
1596
 
    def run(self):
1597
 
        import bzrlib.plugin
1598
 
        from inspect import getdoc
1599
 
        from pprint import pprint
1600
 
        for plugin in bzrlib.plugin.all_plugins:
1601
 
            print plugin.__path__[0]
1602
 
            d = getdoc(plugin)
1603
 
            if d:
1604
 
                print '\t', d.split('\n')[0]
1605
 
 
1606
 
        #pprint(bzrlib.plugin.all_plugins)
1607
 
 
 
574
    print "it sure does!"
 
575
 
 
576
 
 
577
 
 
578
######################################################################
 
579
# main routine
1608
580
 
1609
581
 
1610
582
# list of all available options; the rhs can be either None for an
1612
584
# the type.
1613
585
OPTIONS = {
1614
586
    'all':                    None,
1615
 
    'diff-options':           str,
1616
587
    'help':                   None,
1617
 
    'file':                   unicode,
1618
 
    'force':                  None,
1619
 
    'format':                 unicode,
1620
 
    'forward':                None,
1621
588
    'message':                unicode,
1622
 
    'no-recurse':             None,
1623
 
    'profile':                None,
1624
 
    'revision':               _parse_revision_str,
1625
 
    'short':                  None,
 
589
    'revision':               int,
1626
590
    'show-ids':               None,
1627
591
    'timezone':               str,
1628
592
    'verbose':                None,
1629
593
    'version':                None,
1630
 
    'email':                  None,
1631
 
    'unchanged':              None,
1632
 
    'update':                 None,
1633
 
    'long':                   None,
1634
 
    'root':                   str,
1635
 
    'no-backup':              None,
1636
 
    'merge-type':             get_merge_type,
1637
594
    }
1638
595
 
1639
596
SHORT_OPTIONS = {
1640
 
    'F':                      'file', 
1641
 
    'h':                      'help',
1642
597
    'm':                      'message',
1643
598
    'r':                      'revision',
1644
599
    'v':                      'verbose',
1645
 
    'l':                      'long',
1646
600
}
1647
601
 
 
602
# List of options that apply to particular commands; commands not
 
603
# listed take none.
 
604
cmd_options = {
 
605
    'add':                    ['verbose'],
 
606
    'commit':                 ['message', 'verbose'],
 
607
    'diff':                   ['revision'],
 
608
    'inventory':              ['revision'],
 
609
    'log':                    ['show-ids', 'timezone'],
 
610
    'ls':                     ['revision', 'verbose'],
 
611
    'remove':                 ['verbose'],
 
612
    'status':                 ['all'],
 
613
    }
 
614
 
 
615
 
 
616
cmd_args = {
 
617
    'init':                   [],
 
618
    'add':                    ['file+'],
 
619
    'commit':                 [],
 
620
    'diff':                   [],
 
621
    'file-id':                ['filename'],
 
622
    'root':                   ['filename?'],
 
623
    'relpath':                ['filename'],
 
624
    'get-file-text':          ['text_id'],
 
625
    'get-inventory':          ['inventory_id'],
 
626
    'get-revision':           ['revision_id'],
 
627
    'get-revision-inventory': ['revision_id'],
 
628
    'log':                    [],
 
629
    'lookup-revision':        ['revno'],
 
630
    'export':                 ['revno', 'dest'],
 
631
    'remove':                 ['file+'],
 
632
    'status':                 [],
 
633
    }
 
634
 
1648
635
 
1649
636
def parse_args(argv):
1650
637
    """Parse command line.
1662
649
    (['status'], {'all': True})
1663
650
    >>> parse_args('commit --message=biter'.split())
1664
651
    (['commit'], {'message': u'biter'})
1665
 
    >>> parse_args('log -r 500'.split())
1666
 
    (['log'], {'revision': [500]})
1667
 
    >>> parse_args('log -r500..600'.split())
1668
 
    (['log'], {'revision': [500, 600]})
1669
 
    >>> parse_args('log -vr500..600'.split())
1670
 
    (['log'], {'verbose': True, 'revision': [500, 600]})
1671
 
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
1672
 
    (['log'], {'revision': ['v500', 600]})
1673
652
    """
1674
653
    args = []
1675
654
    opts = {}
1679
658
    while argv:
1680
659
        a = argv.pop(0)
1681
660
        if a[0] == '-':
1682
 
            # option names must not be unicode
1683
 
            a = str(a)
1684
661
            optarg = None
1685
662
            if a[1] == '-':
1686
663
                mutter("  got option %r" % a)
1689
666
                else:
1690
667
                    optname = a[2:]
1691
668
                if optname not in OPTIONS:
1692
 
                    raise BzrError('unknown long option %r' % a)
 
669
                    bailout('unknown long option %r' % a)
1693
670
            else:
1694
671
                shortopt = a[1:]
1695
 
                if shortopt in SHORT_OPTIONS:
1696
 
                    # Multi-character options must have a space to delimit
1697
 
                    # their value
1698
 
                    optname = SHORT_OPTIONS[shortopt]
1699
 
                else:
1700
 
                    # Single character short options, can be chained,
1701
 
                    # and have their value appended to their name
1702
 
                    shortopt = a[1:2]
1703
 
                    if shortopt not in SHORT_OPTIONS:
1704
 
                        # We didn't find the multi-character name, and we
1705
 
                        # didn't find the single char name
1706
 
                        raise BzrError('unknown short option %r' % a)
1707
 
                    optname = SHORT_OPTIONS[shortopt]
1708
 
 
1709
 
                    if a[2:]:
1710
 
                        # There are extra things on this option
1711
 
                        # see if it is the value, or if it is another
1712
 
                        # short option
1713
 
                        optargfn = OPTIONS[optname]
1714
 
                        if optargfn is None:
1715
 
                            # This option does not take an argument, so the
1716
 
                            # next entry is another short option, pack it back
1717
 
                            # into the list
1718
 
                            argv.insert(0, '-' + a[2:])
1719
 
                        else:
1720
 
                            # This option takes an argument, so pack it
1721
 
                            # into the array
1722
 
                            optarg = a[2:]
 
672
                if shortopt not in SHORT_OPTIONS:
 
673
                    bailout('unknown short option %r' % a)
 
674
                optname = SHORT_OPTIONS[shortopt]
1723
675
            
1724
676
            if optname in opts:
1725
677
                # XXX: Do we ever want to support this, e.g. for -r?
1726
 
                raise BzrError('repeated option %r' % a)
 
678
                bailout('repeated option %r' % a)
1727
679
                
1728
680
            optargfn = OPTIONS[optname]
1729
681
            if optargfn:
1730
682
                if optarg == None:
1731
683
                    if not argv:
1732
 
                        raise BzrError('option %r needs an argument' % a)
 
684
                        bailout('option %r needs an argument' % a)
1733
685
                    else:
1734
686
                        optarg = argv.pop(0)
1735
687
                opts[optname] = optargfn(optarg)
 
688
                mutter("    option argument %r" % opts[optname])
1736
689
            else:
1737
690
                if optarg != None:
1738
 
                    raise BzrError('option %r takes no argument' % optname)
 
691
                    bailout('option %r takes no argument' % optname)
1739
692
                opts[optname] = True
1740
693
        else:
1741
694
            args.append(a)
1744
697
 
1745
698
 
1746
699
 
 
700
def _match_args(cmd, args):
 
701
    """Check non-option arguments match required pattern.
1747
702
 
1748
 
def _match_argform(cmd, takes_args, args):
 
703
    >>> _match_args('status', ['asdasdsadasd'])
 
704
    Traceback (most recent call last):
 
705
    ...
 
706
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
 
707
    >>> _match_args('add', ['asdasdsadasd'])
 
708
    {'file_list': ['asdasdsadasd']}
 
709
    >>> _match_args('add', 'abc def gj'.split())
 
710
    {'file_list': ['abc', 'def', 'gj']}
 
711
    """
 
712
    # match argument pattern
 
713
    argform = cmd_args.get(cmd, [])
1749
714
    argdict = {}
 
715
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
716
    # all but one.
1750
717
 
1751
 
    # step through args and takes_args, allowing appropriate 0-many matches
1752
 
    for ap in takes_args:
 
718
    # step through args and argform, allowing appropriate 0-many matches
 
719
    for ap in argform:
1753
720
        argname = ap[:-1]
1754
721
        if ap[-1] == '?':
1755
722
            if args:
1756
723
                argdict[argname] = args.pop(0)
1757
 
        elif ap[-1] == '*': # all remaining arguments
1758
 
            if args:
1759
 
                argdict[argname + '_list'] = args[:]
1760
 
                args = []
1761
 
            else:
1762
 
                argdict[argname + '_list'] = None
 
724
        elif ap[-1] == '*':
 
725
            assert 0
1763
726
        elif ap[-1] == '+':
1764
727
            if not args:
1765
 
                raise BzrCommandError("command %r needs one or more %s"
 
728
                bailout("command %r needs one or more %s"
1766
729
                        % (cmd, argname.upper()))
1767
730
            else:
1768
731
                argdict[argname + '_list'] = args[:]
1769
732
                args = []
1770
 
        elif ap[-1] == '$': # all but one
1771
 
            if len(args) < 2:
1772
 
                raise BzrCommandError("command %r needs one or more %s"
1773
 
                        % (cmd, argname.upper()))
1774
 
            argdict[argname + '_list'] = args[:-1]
1775
 
            args[:-1] = []                
1776
733
        else:
1777
734
            # just a plain arg
1778
735
            argname = ap
1779
736
            if not args:
1780
 
                raise BzrCommandError("command %r requires argument %s"
 
737
                bailout("command %r requires argument %s"
1781
738
                        % (cmd, argname.upper()))
1782
739
            else:
1783
740
                argdict[argname] = args.pop(0)
1784
741
            
1785
742
    if args:
1786
 
        raise BzrCommandError("extra argument to command %s: %s"
1787
 
                              % (cmd, args[0]))
 
743
        bailout("extra arguments to command %s: %r"
 
744
                % (cmd, args))
1788
745
 
1789
746
    return argdict
1790
747
 
1794
751
    """Execute a command.
1795
752
 
1796
753
    This is similar to main(), but without all the trappings for
1797
 
    logging and error handling.  
1798
 
    
1799
 
    argv
1800
 
       The command-line arguments, without the program name from argv[0]
1801
 
    
1802
 
    Returns a command status or raises an exception.
1803
 
 
1804
 
    Special master options: these must come before the command because
1805
 
    they control how the command is interpreted.
1806
 
 
1807
 
    --no-plugins
1808
 
        Do not load plugin modules at all
1809
 
 
1810
 
    --builtin
1811
 
        Only use builtin commands.  (Plugins are still allowed to change
1812
 
        other behaviour.)
1813
 
 
1814
 
    --profile
1815
 
        Run under the Python profiler.
 
754
    logging and error handling.
1816
755
    """
1817
 
    
1818
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1819
 
 
1820
 
    opt_profile = opt_no_plugins = opt_builtin = False
1821
 
 
1822
 
    # --no-plugins is handled specially at a very early stage. We need
1823
 
    # to load plugins before doing other command parsing so that they
1824
 
    # can override commands, but this needs to happen first.
1825
 
 
1826
 
    for a in argv[:]:
1827
 
        if a == '--profile':
1828
 
            opt_profile = True
1829
 
        elif a == '--no-plugins':
1830
 
            opt_no_plugins = True
1831
 
        elif a == '--builtin':
1832
 
            opt_builtin = True
1833
 
        else:
1834
 
            break
1835
 
        argv.remove(a)
1836
 
 
1837
 
    if not opt_no_plugins:
1838
 
        from bzrlib.plugin import load_plugins
1839
 
        load_plugins()
1840
 
 
1841
 
    args, opts = parse_args(argv)
1842
 
 
1843
 
    if 'help' in opts:
1844
 
        from bzrlib.help import help
1845
 
        if args:
1846
 
            help(args[0])
1847
 
        else:
1848
 
            help()
1849
 
        return 0            
1850
 
        
1851
 
    if 'version' in opts:
1852
 
        show_version()
1853
 
        return 0
1854
 
    
1855
 
    if not args:
1856
 
        print >>sys.stderr, "please try 'bzr help' for help"
 
756
    try:
 
757
        args, opts = parse_args(argv[1:])
 
758
        if 'help' in opts:
 
759
            # TODO: pass down other arguments in case they asked for
 
760
            # help on a command name?
 
761
            cmd_help()
 
762
            return 0
 
763
        elif 'version' in opts:
 
764
            cmd_version()
 
765
            return 0
 
766
        cmd = args.pop(0)
 
767
    except IndexError:
 
768
        log_error('usage: bzr COMMAND\n')
 
769
        log_error('  try "bzr help"\n')
1857
770
        return 1
1858
 
    
1859
 
    cmd = str(args.pop(0))
 
771
            
 
772
    try:
 
773
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
774
    except KeyError:
 
775
        bailout("unknown command " + `cmd`)
1860
776
 
1861
 
    canonical_cmd, cmd_class = \
1862
 
                   get_cmd_class(cmd, plugins_override=not opt_builtin)
 
777
    # TODO: special --profile option to turn on the Python profiler
1863
778
 
1864
779
    # check options are reasonable
1865
 
    allowed = cmd_class.takes_options
 
780
    allowed = cmd_options.get(cmd, [])
1866
781
    for oname in opts:
1867
782
        if oname not in allowed:
1868
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1869
 
                                  % (oname, cmd))
1870
 
 
1871
 
    # mix arguments and options into one dictionary
1872
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1873
 
    cmdopts = {}
1874
 
    for k, v in opts.items():
1875
 
        cmdopts[k.replace('-', '_')] = v
1876
 
 
1877
 
    if opt_profile:
1878
 
        import hotshot, tempfile
1879
 
        pffileno, pfname = tempfile.mkstemp()
1880
 
        try:
1881
 
            prof = hotshot.Profile(pfname)
1882
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1883
 
            prof.close()
1884
 
 
1885
 
            import hotshot.stats
1886
 
            stats = hotshot.stats.load(pfname)
1887
 
            #stats.strip_dirs()
1888
 
            stats.sort_stats('time')
1889
 
            ## XXX: Might like to write to stderr or the trace file instead but
1890
 
            ## print_stats seems hardcoded to stdout
1891
 
            stats.print_stats(20)
1892
 
            
1893
 
            return ret.status
1894
 
 
1895
 
        finally:
1896
 
            os.close(pffileno)
1897
 
            os.remove(pfname)
1898
 
    else:
1899
 
        return cmd_class(cmdopts, cmdargs).status 
1900
 
 
1901
 
 
1902
 
def _report_exception(summary, quiet=False):
1903
 
    import traceback
1904
 
    
1905
 
    log_error('bzr: ' + summary)
1906
 
    bzrlib.trace.log_exception()
1907
 
 
1908
 
    if os.environ.get('BZR_DEBUG'):
1909
 
        traceback.print_exc()
1910
 
 
1911
 
    if not quiet:
1912
 
        sys.stderr.write('\n')
1913
 
        tb = sys.exc_info()[2]
1914
 
        exinfo = traceback.extract_tb(tb)
1915
 
        if exinfo:
1916
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1917
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
783
            bailout("option %r is not allowed for command %r"
 
784
                    % (oname, cmd))
 
785
 
 
786
    cmdargs = _match_args(cmd, args)
 
787
    cmdargs.update(opts)
 
788
 
 
789
    ret = cmd_handler(**cmdargs) or 0
1918
790
 
1919
791
 
1920
792
 
1921
793
def main(argv):
 
794
    ## TODO: Handle command-line options; probably know what options are valid for
 
795
    ## each command
 
796
 
 
797
    ## TODO: If the arguments are wrong, give a usage message rather
 
798
    ## than just a backtrace.
 
799
 
 
800
    bzrlib.trace.create_tracefile(argv)
1922
801
    
1923
 
    bzrlib.trace.open_tracefile(argv)
1924
 
 
1925
802
    try:
1926
 
        try:
1927
 
            try:
1928
 
                return run_bzr(argv[1:])
1929
 
            finally:
1930
 
                # do this here inside the exception wrappers to catch EPIPE
1931
 
                sys.stdout.flush()
1932
 
        except BzrError, e:
1933
 
            quiet = isinstance(e, (BzrCommandError))
1934
 
            _report_exception('error: ' + str(e), quiet=quiet)
1935
 
            if len(e.args) > 1:
1936
 
                for h in e.args[1]:
1937
 
                    # some explanation or hints
1938
 
                    log_error('  ' + h)
1939
 
            return 1
1940
 
        except AssertionError, e:
1941
 
            msg = 'assertion failed'
1942
 
            if str(e):
1943
 
                msg += ': ' + str(e)
1944
 
            _report_exception(msg)
1945
 
            return 2
1946
 
        except KeyboardInterrupt, e:
1947
 
            _report_exception('interrupted', quiet=True)
1948
 
            return 2
1949
 
        except Exception, e:
1950
 
            import errno
1951
 
            quiet = False
1952
 
            if (isinstance(e, IOError) 
1953
 
                and hasattr(e, 'errno')
1954
 
                and e.errno == errno.EPIPE):
1955
 
                quiet = True
1956
 
                msg = 'broken pipe'
1957
 
            else:
1958
 
                msg = str(e).rstrip('\n')
1959
 
            _report_exception(msg, quiet)
1960
 
            return 2
1961
 
    finally:
1962
 
        bzrlib.trace.close_trace()
 
803
        ret = run_bzr(argv)
 
804
        return ret
 
805
    except BzrError, e:
 
806
        log_error('bzr: error: ' + e.args[0] + '\n')
 
807
        if len(e.args) > 1:
 
808
            for h in e.args[1]:
 
809
                log_error('  ' + h + '\n')
 
810
        return 1
 
811
    except Exception, e:
 
812
        log_error('bzr: exception: %s\n' % e)
 
813
        log_error('    see .bzr.log for details\n')
 
814
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
815
        traceback.print_exc(None, sys.stderr)
 
816
        return 1
 
817
 
 
818
    # TODO: Maybe nicer handling of IOError?
 
819
 
1963
820
 
1964
821
 
1965
822
if __name__ == '__main__':
1966
823
    sys.exit(main(sys.argv))
 
824
    ##import profile
 
825
    ##profile.run('main(sys.argv)')
 
826