/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

More work on roundtrip push support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
 
19
 
import sys, os, time, os.path
20
 
 
21
 
import bzrlib
22
 
from bzrlib.trace import mutter, note, log_error
23
 
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
 
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
25
 
from bzrlib.tree import RevisionTree, EmptyTree, Tree
26
 
from bzrlib.revision import Revision
27
 
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
28
 
     format_date
29
 
from bzrlib import merge
30
 
 
31
 
 
32
 
def _squish_command_name(cmd):
33
 
    return 'cmd_' + cmd.replace('-', '_')
34
 
 
35
 
 
36
 
def _unsquish_command_name(cmd):
37
 
    assert cmd.startswith("cmd_")
38
 
    return cmd[4:].replace('_','-')
39
 
 
40
 
def _parse_revision_str(revstr):
41
 
    """This handles a revision string -> revno. 
42
 
 
43
 
    There are several possibilities:
44
 
 
45
 
        '234'       -> 234
46
 
        '234:345'   -> [234, 345]
47
 
        ':234'      -> [None, 234]
48
 
        '234:'      -> [234, None]
49
 
 
50
 
    In the future we will also support:
51
 
        'uuid:blah-blah-blah'   -> ?
52
 
        'hash:blahblahblah'     -> ?
53
 
        potentially:
54
 
        'tag:mytag'             -> ?
55
 
    """
56
 
    if revstr.find(':') != -1:
57
 
        revs = revstr.split(':')
58
 
        if len(revs) > 2:
59
 
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
60
 
 
61
 
        if not revs[0]:
62
 
            revs[0] = None
63
 
        else:
64
 
            revs[0] = int(revs[0])
65
 
 
66
 
        if not revs[1]:
67
 
            revs[1] = None
68
 
        else:
69
 
            revs[1] = int(revs[1])
70
 
    else:
71
 
        revs = int(revstr)
72
 
    return revs
73
 
 
74
 
def get_all_cmds():
75
 
    """Return canonical name and class for all registered commands."""
76
 
    for k, v in globals().iteritems():
77
 
        if k.startswith("cmd_"):
78
 
            yield _unsquish_command_name(k), v
79
 
 
80
 
def get_cmd_class(cmd):
81
 
    """Return the canonical name and command class for a command.
82
 
    """
83
 
    cmd = str(cmd)                      # not unicode
84
 
 
85
 
    # first look up this command under the specified name
86
 
    try:
87
 
        return cmd, globals()[_squish_command_name(cmd)]
88
 
    except KeyError:
89
 
        pass
90
 
 
91
 
    # look for any command which claims this as an alias
92
 
    for cmdname, cmdclass in get_all_cmds():
93
 
        if cmd in cmdclass.aliases:
94
 
            return cmdname, cmdclass
95
 
 
96
 
    cmdclass = ExternalCommand.find_command(cmd)
97
 
    if cmdclass:
98
 
        return cmd, cmdclass
99
 
 
100
 
    raise BzrCommandError("unknown command %r" % cmd)
101
 
 
102
 
 
103
 
class Command(object):
104
 
    """Base class for commands.
105
 
 
106
 
    The docstring for an actual command should give a single-line
107
 
    summary, then a complete description of the command.  A grammar
108
 
    description will be inserted.
109
 
 
110
 
    takes_args
111
 
        List of argument forms, marked with whether they are optional,
112
 
        repeated, etc.
113
 
 
114
 
    takes_options
115
 
        List of options that may be given for this command.
116
 
 
117
 
    hidden
118
 
        If true, this command isn't advertised.
119
 
    """
120
 
    aliases = []
121
 
    
122
 
    takes_args = []
123
 
    takes_options = []
124
 
 
125
 
    hidden = False
126
 
    
127
 
    def __init__(self, options, arguments):
128
 
        """Construct and run the command.
129
 
 
130
 
        Sets self.status to the return value of run()."""
131
 
        assert isinstance(options, dict)
132
 
        assert isinstance(arguments, dict)
133
 
        cmdargs = options.copy()
134
 
        cmdargs.update(arguments)
135
 
        assert self.__doc__ != Command.__doc__, \
136
 
               ("No help message set for %r" % self)
137
 
        self.status = self.run(**cmdargs)
138
 
 
139
 
    
140
 
    def run(self):
141
 
        """Override this in sub-classes.
142
 
 
143
 
        This is invoked with the options and arguments bound to
144
 
        keyword parameters.
145
 
 
146
 
        Return 0 or None if the command was successful, or a shell
147
 
        error code if not.
148
 
        """
149
 
        return 0
150
 
 
151
 
 
152
 
class ExternalCommand(Command):
153
 
    """Class to wrap external commands.
154
 
 
155
 
    We cheat a little here, when get_cmd_class() calls us we actually give it back
156
 
    an object we construct that has the appropriate path, help, options etc for the
157
 
    specified command.
158
 
 
159
 
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
160
 
    method, which we override to call the Command.__init__ method. That then calls
161
 
    our run method which is pretty straight forward.
162
 
 
163
 
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
164
 
    back into command line options and arguments for the script.
165
 
    """
166
 
 
167
 
    def find_command(cls, cmd):
168
 
        bzrpath = os.environ.get('BZRPATH', '')
169
 
 
170
 
        for dir in bzrpath.split(':'):
171
 
            path = os.path.join(dir, cmd)
172
 
            if os.path.isfile(path):
173
 
                return ExternalCommand(path)
174
 
 
175
 
        return None
176
 
 
177
 
    find_command = classmethod(find_command)
178
 
 
179
 
    def __init__(self, path):
180
 
        self.path = path
181
 
 
182
 
        # TODO: If either of these fail, we should detect that and
183
 
        # assume that path is not really a bzr plugin after all.
184
 
 
185
 
        pipe = os.popen('%s --bzr-usage' % path, 'r')
186
 
        self.takes_options = pipe.readline().split()
187
 
        self.takes_args = pipe.readline().split()
188
 
        pipe.close()
189
 
 
190
 
        pipe = os.popen('%s --bzr-help' % path, 'r')
191
 
        self.__doc__ = pipe.read()
192
 
        pipe.close()
193
 
 
194
 
    def __call__(self, options, arguments):
195
 
        Command.__init__(self, options, arguments)
196
 
        return self
197
 
 
198
 
    def run(self, **kargs):
199
 
        opts = []
200
 
        args = []
201
 
 
202
 
        keys = kargs.keys()
203
 
        keys.sort()
204
 
        for name in keys:
205
 
            value = kargs[name]
206
 
            if OPTIONS.has_key(name):
207
 
                # it's an option
208
 
                opts.append('--%s' % name)
209
 
                if value is not None and value is not True:
210
 
                    opts.append(str(value))
211
 
            else:
212
 
                # it's an arg, or arg list
213
 
                if type(value) is not list:
214
 
                    value = [value]
215
 
                for v in value:
216
 
                    if v is not None:
217
 
                        args.append(str(v))
218
 
 
219
 
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
220
 
        return self.status
221
 
 
222
 
 
223
 
class cmd_status(Command):
224
 
    """Display status summary.
225
 
 
226
 
    This reports on versioned and unknown files, reporting them
227
 
    grouped by state.  Possible states are:
228
 
 
229
 
    added
230
 
        Versioned in the working copy but not in the previous revision.
231
 
 
232
 
    removed
233
 
        Versioned in the previous revision but removed or deleted
234
 
        in the working copy.
235
 
 
236
 
    renamed
237
 
        Path of this file changed from the previous revision;
238
 
        the text may also have changed.  This includes files whose
239
 
        parent directory was renamed.
240
 
 
241
 
    modified
242
 
        Text has changed since the previous revision.
243
 
 
244
 
    unchanged
245
 
        Nothing about this file has changed since the previous revision.
246
 
        Only shown with --all.
247
 
 
248
 
    unknown
249
 
        Not versioned and not matching an ignore pattern.
250
 
 
251
 
    To see ignored files use 'bzr ignored'.  For details in the
252
 
    changes to file texts, use 'bzr diff'.
253
 
 
254
 
    If no arguments are specified, the status of the entire working
255
 
    directory is shown.  Otherwise, only the status of the specified
256
 
    files or directories is reported.  If a directory is given, status
257
 
    is reported for everything inside that directory.
258
 
    """
259
 
    takes_args = ['file*']
260
 
    takes_options = ['all', 'show-ids']
261
 
    aliases = ['st', 'stat']
262
 
    
263
 
    def run(self, all=False, show_ids=False, file_list=None):
264
 
        if file_list:
265
 
            b = Branch(file_list[0], lock_mode='r')
266
 
            file_list = [b.relpath(x) for x in file_list]
267
 
            # special case: only one path was given and it's the root
268
 
            # of the branch
269
 
            if file_list == ['']:
270
 
                file_list = None
271
 
        else:
272
 
            b = Branch('.', lock_mode='r')
273
 
        import status
274
 
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
275
 
                           specific_files=file_list)
276
 
 
277
 
 
278
 
class cmd_cat_revision(Command):
279
 
    """Write out metadata for a revision."""
280
 
 
281
 
    hidden = True
282
 
    takes_args = ['revision_id']
283
 
    
284
 
    def run(self, revision_id):
285
 
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
286
 
 
287
 
 
288
 
class cmd_revno(Command):
289
 
    """Show current revision number.
290
 
 
291
 
    This is equal to the number of revisions on this branch."""
292
 
    def run(self):
293
 
        print Branch('.').revno()
294
 
 
295
 
    
296
 
class cmd_add(Command):
297
 
    """Add specified files or directories.
298
 
 
299
 
    In non-recursive mode, all the named items are added, regardless
300
 
    of whether they were previously ignored.  A warning is given if
301
 
    any of the named files are already versioned.
302
 
 
303
 
    In recursive mode (the default), files are treated the same way
304
 
    but the behaviour for directories is different.  Directories that
305
 
    are already versioned do not give a warning.  All directories,
306
 
    whether already versioned or not, are searched for files or
307
 
    subdirectories that are neither versioned or ignored, and these
308
 
    are added.  This search proceeds recursively into versioned
309
 
    directories.
310
 
 
311
 
    Therefore simply saying 'bzr add .' will version all files that
312
 
    are currently unknown.
313
 
 
314
 
    TODO: Perhaps adding a file whose directly is not versioned should
315
 
    recursively add that parent, rather than giving an error?
316
 
    """
317
 
    takes_args = ['file+']
318
 
    takes_options = ['verbose']
319
 
    
320
 
    def run(self, file_list, verbose=False):
321
 
        bzrlib.add.smart_add(file_list, verbose)
322
 
 
323
 
 
324
 
class cmd_relpath(Command):
325
 
    """Show path of a file relative to root"""
326
 
    takes_args = ['filename']
327
 
    
328
 
    def run(self, filename):
329
 
        print Branch(filename).relpath(filename)
330
 
 
331
 
 
332
 
 
333
 
class cmd_inventory(Command):
334
 
    """Show inventory of the current working copy or a revision."""
335
 
    takes_options = ['revision']
336
 
    
337
 
    def run(self, revision=None):
338
 
        b = Branch('.')
339
 
        if revision == None:
340
 
            inv = b.read_working_inventory()
341
 
        else:
342
 
            inv = b.get_revision_inventory(b.lookup_revision(revision))
343
 
 
344
 
        for path, entry in inv.entries():
345
 
            print '%-50s %s' % (entry.file_id, path)
346
 
 
347
 
 
348
 
class cmd_move(Command):
349
 
    """Move files to a different directory.
350
 
 
351
 
    examples:
352
 
        bzr move *.txt doc
353
 
 
354
 
    The destination must be a versioned directory in the same branch.
355
 
    """
356
 
    takes_args = ['source$', 'dest']
357
 
    def run(self, source_list, dest):
358
 
        b = Branch('.')
359
 
 
360
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
361
 
 
362
 
 
363
 
class cmd_rename(Command):
364
 
    """Change the name of an entry.
365
 
 
366
 
    examples:
367
 
      bzr rename frob.c frobber.c
368
 
      bzr rename src/frob.c lib/frob.c
369
 
 
370
 
    It is an error if the destination name exists.
371
 
 
372
 
    See also the 'move' command, which moves files into a different
373
 
    directory without changing their name.
374
 
 
375
 
    TODO: Some way to rename multiple files without invoking bzr for each
376
 
    one?"""
377
 
    takes_args = ['from_name', 'to_name']
378
 
    
379
 
    def run(self, from_name, to_name):
380
 
        b = Branch('.')
381
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
382
 
 
383
 
 
384
 
 
385
 
class cmd_renames(Command):
386
 
    """Show list of renamed files.
387
 
 
388
 
    TODO: Option to show renames between two historical versions.
389
 
 
390
 
    TODO: Only show renames under dir, rather than in the whole branch.
391
 
    """
392
 
    takes_args = ['dir?']
393
 
 
394
 
    def run(self, dir='.'):
395
 
        b = Branch(dir)
396
 
        old_inv = b.basis_tree().inventory
397
 
        new_inv = b.read_working_inventory()
398
 
 
399
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
400
 
        renames.sort()
401
 
        for old_name, new_name in renames:
402
 
            print "%s => %s" % (old_name, new_name)        
403
 
 
404
 
 
405
 
class cmd_info(Command):
406
 
    """Show statistical information about a branch."""
407
 
    takes_args = ['branch?']
408
 
    
409
 
    def run(self, branch=None):
410
 
        import info
411
 
 
412
 
        from branch import find_branch
413
 
        b = find_branch(branch)
414
 
        info.show_info(b)
415
 
 
416
 
 
417
 
class cmd_remove(Command):
418
 
    """Make a file unversioned.
419
 
 
420
 
    This makes bzr stop tracking changes to a versioned file.  It does
421
 
    not delete the working copy.
422
 
    """
423
 
    takes_args = ['file+']
424
 
    takes_options = ['verbose']
425
 
    
426
 
    def run(self, file_list, verbose=False):
427
 
        b = Branch(file_list[0])
428
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
429
 
 
430
 
 
431
 
class cmd_file_id(Command):
432
 
    """Print file_id of a particular file or directory.
433
 
 
434
 
    The file_id is assigned when the file is first added and remains the
435
 
    same through all revisions where the file exists, even when it is
436
 
    moved or renamed.
437
 
    """
438
 
    hidden = True
439
 
    takes_args = ['filename']
440
 
    def run(self, filename):
441
 
        b = Branch(filename)
442
 
        i = b.inventory.path2id(b.relpath(filename))
443
 
        if i == None:
444
 
            bailout("%r is not a versioned file" % filename)
445
 
        else:
446
 
            print i
447
 
 
448
 
 
449
 
class cmd_file_path(Command):
450
 
    """Print path of file_ids to a file or directory.
451
 
 
452
 
    This prints one line for each directory down to the target,
453
 
    starting at the branch root."""
454
 
    hidden = True
455
 
    takes_args = ['filename']
456
 
    def run(self, filename):
457
 
        b = Branch(filename)
458
 
        inv = b.inventory
459
 
        fid = inv.path2id(b.relpath(filename))
460
 
        if fid == None:
461
 
            bailout("%r is not a versioned file" % filename)
462
 
        for fip in inv.get_idpath(fid):
463
 
            print fip
464
 
 
465
 
 
466
 
class cmd_revision_history(Command):
467
 
    """Display list of revision ids on this branch."""
468
 
    def run(self):
469
 
        for patchid in Branch('.').revision_history():
470
 
            print patchid
471
 
 
472
 
 
473
 
class cmd_directories(Command):
474
 
    """Display list of versioned directories in this branch."""
475
 
    def run(self):
476
 
        for name, ie in Branch('.').read_working_inventory().directories():
477
 
            if name == '':
478
 
                print '.'
479
 
            else:
480
 
                print name
481
 
 
482
 
 
483
 
class cmd_init(Command):
484
 
    """Make a directory into a versioned branch.
485
 
 
486
 
    Use this to create an empty branch, or before importing an
487
 
    existing project.
488
 
 
489
 
    Recipe for importing a tree of files:
490
 
        cd ~/project
491
 
        bzr init
492
 
        bzr add -v .
493
 
        bzr status
494
 
        bzr commit -m 'imported project'
495
 
    """
496
 
    def run(self):
497
 
        Branch('.', init=True)
498
 
 
499
 
 
500
 
class cmd_diff(Command):
501
 
    """Show differences in working tree.
502
 
    
503
 
    If files are listed, only the changes in those files are listed.
504
 
    Otherwise, all changes for the tree are listed.
505
 
 
506
 
    TODO: Given two revision arguments, show the difference between them.
507
 
 
508
 
    TODO: Allow diff across branches.
509
 
 
510
 
    TODO: Option to use external diff command; could be GNU diff, wdiff,
511
 
          or a graphical diff.
512
 
 
513
 
    TODO: Python difflib is not exactly the same as unidiff; should
514
 
          either fix it up or prefer to use an external diff.
515
 
 
516
 
    TODO: If a directory is given, diff everything under that.
517
 
 
518
 
    TODO: Selected-file diff is inefficient and doesn't show you
519
 
          deleted files.
520
 
 
521
 
    TODO: This probably handles non-Unix newlines poorly.
522
 
    """
523
 
    
524
 
    takes_args = ['file*']
525
 
    takes_options = ['revision', 'diff-options']
526
 
    aliases = ['di']
527
 
 
528
 
    def run(self, revision=None, file_list=None, diff_options=None):
529
 
        from bzrlib.diff import show_diff
530
 
        from bzrlib import find_branch
531
 
 
532
 
        if file_list:
533
 
            b = find_branch(file_list[0], lock_mode='r')
534
 
            file_list = [b.relpath(f) for f in file_list]
535
 
            if file_list == ['']:
536
 
                # just pointing to top-of-tree
537
 
                file_list = None
538
 
        else:
539
 
            b = Branch('.', lock_mode='r')
540
 
    
541
 
        show_diff(b, revision, specific_files=file_list,
542
 
                  external_diff_options=diff_options)
543
 
 
544
 
 
545
 
        
546
 
 
547
 
 
548
 
class cmd_deleted(Command):
549
 
    """List files deleted in the working tree.
550
 
 
551
 
    TODO: Show files deleted since a previous revision, or between two revisions.
552
 
    """
553
 
    def run(self, show_ids=False):
554
 
        b = Branch('.')
555
 
        old = b.basis_tree()
556
 
        new = b.working_tree()
557
 
 
558
 
        ## TODO: Much more efficient way to do this: read in new
559
 
        ## directories with readdir, rather than stating each one.  Same
560
 
        ## level of effort but possibly much less IO.  (Or possibly not,
561
 
        ## if the directories are very large...)
562
 
 
563
 
        for path, ie in old.inventory.iter_entries():
564
 
            if not new.has_id(ie.file_id):
565
 
                if show_ids:
566
 
                    print '%-50s %s' % (path, ie.file_id)
567
 
                else:
568
 
                    print path
569
 
 
570
 
 
571
 
class cmd_modified(Command):
572
 
    """List files modified in working tree."""
573
 
    hidden = True
574
 
    def run(self):
575
 
        import statcache
576
 
        b = Branch('.')
577
 
        inv = b.read_working_inventory()
578
 
        sc = statcache.update_cache(b, inv)
579
 
        basis = b.basis_tree()
580
 
        basis_inv = basis.inventory
581
 
        
582
 
        # We used to do this through iter_entries(), but that's slow
583
 
        # when most of the files are unmodified, as is usually the
584
 
        # case.  So instead we iterate by inventory entry, and only
585
 
        # calculate paths as necessary.
586
 
 
587
 
        for file_id in basis_inv:
588
 
            cacheentry = sc.get(file_id)
589
 
            if not cacheentry:                 # deleted
590
 
                continue
591
 
            ie = basis_inv[file_id]
592
 
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
593
 
                path = inv.id2path(file_id)
594
 
                print path
595
 
 
596
 
 
597
 
 
598
 
class cmd_added(Command):
599
 
    """List files added in working tree."""
600
 
    hidden = True
601
 
    def run(self):
602
 
        b = Branch('.')
603
 
        wt = b.working_tree()
604
 
        basis_inv = b.basis_tree().inventory
605
 
        inv = wt.inventory
606
 
        for file_id in inv:
607
 
            if file_id in basis_inv:
608
 
                continue
609
 
            path = inv.id2path(file_id)
610
 
            if not os.access(b.abspath(path), os.F_OK):
611
 
                continue
612
 
            print path
613
 
                
614
 
        
615
 
 
616
 
class cmd_root(Command):
617
 
    """Show the tree root directory.
618
 
 
619
 
    The root is the nearest enclosing directory with a .bzr control
620
 
    directory."""
621
 
    takes_args = ['filename?']
622
 
    def run(self, filename=None):
623
 
        """Print the branch root."""
624
 
        from branch import find_branch
625
 
        b = find_branch(filename)
626
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
627
 
 
628
 
 
629
 
class cmd_log(Command):
630
 
    """Show log of this branch.
631
 
 
632
 
    To request a range of logs, you can use the command -r begin:end
633
 
    -r revision requests a specific revision, -r :end or -r begin: are
634
 
    also valid.
635
 
 
636
 
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
637
 
  
638
 
    """
639
 
 
640
 
    takes_args = ['filename?']
641
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
642
 
    
643
 
    def run(self, filename=None, timezone='original',
644
 
            verbose=False,
645
 
            show_ids=False,
646
 
            forward=False,
647
 
            revision=None):
648
 
        from bzrlib import show_log, find_branch
649
 
        import codecs
650
 
 
651
 
        direction = (forward and 'forward') or 'reverse'
652
 
        
653
 
        if filename:
654
 
            b = find_branch(filename, lock_mode='r')
655
 
            fp = b.relpath(filename)
656
 
            if fp:
657
 
                file_id = b.read_working_inventory().path2id(fp)
658
 
            else:
659
 
                file_id = None  # points to branch root
660
 
        else:
661
 
            b = find_branch('.', lock_mode='r')
662
 
            file_id = None
663
 
 
664
 
        if revision == None:
665
 
            revision = [None, None]
666
 
        elif isinstance(revision, int):
667
 
            revision = [revision, revision]
668
 
        else:
669
 
            # pair of revisions?
670
 
            pass
671
 
            
672
 
        assert len(revision) == 2
673
 
 
674
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
675
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout)
676
 
 
677
 
        show_log(b, file_id,
678
 
                 show_timezone=timezone,
679
 
                 verbose=verbose,
680
 
                 show_ids=show_ids,
681
 
                 to_file=outf,
682
 
                 direction=direction,
683
 
                 start_revision=revision[0],
684
 
                 end_revision=revision[1])
685
 
 
686
 
 
687
 
 
688
 
class cmd_touching_revisions(Command):
689
 
    """Return revision-ids which affected a particular file.
690
 
 
691
 
    A more user-friendly interface is "bzr log FILE"."""
692
 
    hidden = True
693
 
    takes_args = ["filename"]
694
 
    def run(self, filename):
695
 
        b = Branch(filename, lock_mode='r')
696
 
        inv = b.read_working_inventory()
697
 
        file_id = inv.path2id(b.relpath(filename))
698
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
699
 
            print "%6d %s" % (revno, what)
700
 
 
701
 
 
702
 
class cmd_ls(Command):
703
 
    """List files in a tree.
704
 
 
705
 
    TODO: Take a revision or remote path and list that tree instead.
706
 
    """
707
 
    hidden = True
708
 
    def run(self, revision=None, verbose=False):
709
 
        b = Branch('.')
710
 
        if revision == None:
711
 
            tree = b.working_tree()
712
 
        else:
713
 
            tree = b.revision_tree(b.lookup_revision(revision))
714
 
 
715
 
        for fp, fc, kind, fid in tree.list_files():
716
 
            if verbose:
717
 
                if kind == 'directory':
718
 
                    kindch = '/'
719
 
                elif kind == 'file':
720
 
                    kindch = ''
721
 
                else:
722
 
                    kindch = '???'
723
 
 
724
 
                print '%-8s %s%s' % (fc, fp, kindch)
725
 
            else:
726
 
                print fp
727
 
 
728
 
 
729
 
 
730
 
class cmd_unknowns(Command):
731
 
    """List unknown files"""
732
 
    def run(self):
733
 
        for f in Branch('.').unknowns():
734
 
            print quotefn(f)
735
 
 
736
 
 
737
 
 
738
 
class cmd_ignore(Command):
739
 
    """Ignore a command or pattern
740
 
 
741
 
    To remove patterns from the ignore list, edit the .bzrignore file.
742
 
 
743
 
    If the pattern contains a slash, it is compared to the whole path
744
 
    from the branch root.  Otherwise, it is comapred to only the last
745
 
    component of the path.
746
 
 
747
 
    Ignore patterns are case-insensitive on case-insensitive systems.
748
 
 
749
 
    Note: wildcards must be quoted from the shell on Unix.
750
 
 
751
 
    examples:
752
 
        bzr ignore ./Makefile
753
 
        bzr ignore '*.class'
754
 
    """
755
 
    takes_args = ['name_pattern']
756
 
    
757
 
    def run(self, name_pattern):
758
 
        from bzrlib.atomicfile import AtomicFile
759
 
        import codecs
760
 
 
761
 
        b = Branch('.')
762
 
        ifn = b.abspath('.bzrignore')
763
 
 
764
 
        if os.path.exists(ifn):
765
 
            f = open(ifn, 'rt')
766
 
            try:
767
 
                igns = f.read().decode('utf-8')
768
 
            finally:
769
 
                f.close()
770
 
        else:
771
 
            igns = ''
772
 
 
773
 
        if igns and igns[-1] != '\n':
774
 
            igns += '\n'
775
 
        igns += name_pattern + '\n'
776
 
 
777
 
        try:
778
 
            f = AtomicFile(ifn, 'wt')
779
 
            f.write(igns.encode('utf-8'))
780
 
            f.commit()
781
 
        finally:
782
 
            f.close()
783
 
 
784
 
        inv = b.working_tree().inventory
785
 
        if inv.path2id('.bzrignore'):
786
 
            mutter('.bzrignore is already versioned')
787
 
        else:
788
 
            mutter('need to make new .bzrignore file versioned')
789
 
            b.add(['.bzrignore'])
790
 
 
791
 
 
792
 
 
793
 
class cmd_ignored(Command):
794
 
    """List ignored files and the patterns that matched them.
795
 
 
796
 
    See also: bzr ignore"""
797
 
    def run(self):
798
 
        tree = Branch('.').working_tree()
799
 
        for path, file_class, kind, file_id in tree.list_files():
800
 
            if file_class != 'I':
801
 
                continue
802
 
            ## XXX: Slightly inefficient since this was already calculated
803
 
            pat = tree.is_ignored(path)
804
 
            print '%-50s %s' % (path, pat)
805
 
 
806
 
 
807
 
class cmd_lookup_revision(Command):
808
 
    """Lookup the revision-id from a revision-number
809
 
 
810
 
    example:
811
 
        bzr lookup-revision 33
812
 
    """
813
 
    hidden = True
814
 
    takes_args = ['revno']
815
 
    
816
 
    def run(self, revno):
817
 
        try:
818
 
            revno = int(revno)
819
 
        except ValueError:
820
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
821
 
 
822
 
        print Branch('.').lookup_revision(revno)
823
 
 
824
 
 
825
 
class cmd_export(Command):
826
 
    """Export past revision to destination directory.
827
 
 
828
 
    If no revision is specified this exports the last committed revision."""
829
 
    takes_args = ['dest']
830
 
    takes_options = ['revision']
831
 
    def run(self, dest, revision=None):
832
 
        b = Branch('.')
833
 
        if revision == None:
834
 
            rh = b.revision_history()[-1]
835
 
        else:
836
 
            rh = b.lookup_revision(int(revision))
837
 
        t = b.revision_tree(rh)
838
 
        t.export(dest)
839
 
 
840
 
 
841
 
class cmd_cat(Command):
842
 
    """Write a file's text from a previous revision."""
843
 
 
844
 
    takes_options = ['revision']
845
 
    takes_args = ['filename']
846
 
 
847
 
    def run(self, filename, revision=None):
848
 
        if revision == None:
849
 
            raise BzrCommandError("bzr cat requires a revision number")
850
 
        b = Branch('.')
851
 
        b.print_file(b.relpath(filename), int(revision))
852
 
 
853
 
 
854
 
class cmd_local_time_offset(Command):
855
 
    """Show the offset in seconds from GMT to local time."""
856
 
    hidden = True    
857
 
    def run(self):
858
 
        print bzrlib.osutils.local_time_offset()
859
 
 
860
 
 
861
 
 
862
 
class cmd_commit(Command):
863
 
    """Commit changes into a new revision.
864
 
 
865
 
    If selected files are specified, only changes to those files are
866
 
    committed.  If a directory is specified then its contents are also
867
 
    committed.
868
 
 
869
 
    A selected-file commit may fail in some cases where the committed
870
 
    tree would be invalid, such as trying to commit a file in a
871
 
    newly-added directory that is not itself committed.
872
 
 
873
 
    TODO: Run hooks on tree to-be-committed, and after commit.
874
 
 
875
 
    TODO: Strict commit that fails if there are unknown or deleted files.
876
 
    """
877
 
    takes_args = ['selected*']
878
 
    takes_options = ['message', 'file', 'verbose']
879
 
    aliases = ['ci', 'checkin']
880
 
 
881
 
    def run(self, message=None, file=None, verbose=True, selected_list=None):
882
 
        from bzrlib.commit import commit
883
 
 
884
 
        ## Warning: shadows builtin file()
885
 
        if not message and not file:
886
 
            raise BzrCommandError("please specify a commit message",
887
 
                                  ["use either --message or --file"])
888
 
        elif message and file:
889
 
            raise BzrCommandError("please specify either --message or --file")
890
 
        
891
 
        if file:
892
 
            import codecs
893
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
894
 
 
895
 
        b = Branch('.')
896
 
        commit(b, message, verbose=verbose, specific_files=selected_list)
897
 
 
898
 
 
899
 
class cmd_check(Command):
900
 
    """Validate consistency of branch history.
901
 
 
902
 
    This command checks various invariants about the branch storage to
903
 
    detect data corruption or bzr bugs.
904
 
    """
905
 
    takes_args = ['dir?']
906
 
    def run(self, dir='.'):
907
 
        import bzrlib.check
908
 
        bzrlib.check.check(Branch(dir))
909
 
 
910
 
 
911
 
 
912
 
class cmd_whoami(Command):
913
 
    """Show bzr user id."""
914
 
    takes_options = ['email']
915
 
    
916
 
    def run(self, email=False):
917
 
        if email:
918
 
            print bzrlib.osutils.user_email()
919
 
        else:
920
 
            print bzrlib.osutils.username()
921
 
 
922
 
 
923
 
class cmd_selftest(Command):
924
 
    """Run internal test suite"""
925
 
    hidden = True
926
 
    def run(self):
927
 
        failures, tests = 0, 0
928
 
 
929
 
        import doctest, bzrlib.store
930
 
        bzrlib.trace.verbose = False
931
 
 
932
 
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
933
 
            bzrlib.tree, bzrlib.commands, bzrlib.add:
934
 
            mf, mt = doctest.testmod(m)
935
 
            failures += mf
936
 
            tests += mt
937
 
            print '%-40s %3d tests' % (m.__name__, mt),
938
 
            if mf:
939
 
                print '%3d FAILED!' % mf
940
 
            else:
941
 
                print
942
 
 
943
 
        print '%-40s %3d tests' % ('total', tests),
944
 
        if failures:
945
 
            print '%3d FAILED!' % failures
946
 
            return 1
947
 
        else:
948
 
            print
949
 
            return 0
950
 
 
951
 
 
952
 
 
953
 
class cmd_version(Command):
954
 
    """Show version of bzr"""
955
 
    def run(self):
956
 
        show_version()
957
 
 
958
 
def show_version():
959
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
960
 
    print bzrlib.__copyright__
961
 
    print "http://bazaar-ng.org/"
962
 
    print
963
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
964
 
    print "you may use, modify and redistribute it under the terms of the GNU"
965
 
    print "General Public License version 2 or later."
966
 
 
967
 
 
968
 
class cmd_rocks(Command):
969
 
    """Statement of optimism."""
970
 
    hidden = True
971
 
    def run(self):
972
 
        print "it sure does!"
973
 
 
974
 
def parse_spec(spec):
975
 
    if '/@' in spec:
976
 
        parsed = spec.split('/@')
977
 
        assert len(parsed) == 2
978
 
        if parsed[1] == "":
979
 
            parsed[1] = -1
980
 
        else:
981
 
            parsed[1] = int(parsed[1])
982
 
            assert parsed[1] >=0
983
 
    else:
984
 
        parsed = [spec, None]
985
 
    return parsed
986
 
 
987
 
class cmd_merge(Command):
988
 
    """Perform a three-way merge of trees."""
989
 
    takes_args = ['other_spec', 'base_spec']
990
 
 
991
 
    def run(self, other_spec, base_spec):
992
 
        merge.merge(parse_spec(other_spec), parse_spec(base_spec))
993
 
 
994
 
class cmd_assert_fail(Command):
995
 
    """Test reporting of assertion failures"""
996
 
    hidden = True
997
 
    def run(self):
998
 
        assert False, "always fails"
999
 
 
1000
 
 
1001
 
class cmd_help(Command):
1002
 
    """Show help on a command or other topic.
1003
 
 
1004
 
    For a list of all available commands, say 'bzr help commands'."""
1005
 
    takes_args = ['topic?']
1006
 
    aliases = ['?']
1007
 
    
1008
 
    def run(self, topic=None):
1009
 
        import help
1010
 
        help.help(topic)
1011
 
 
1012
 
 
1013
 
class cmd_update_stat_cache(Command):
1014
 
    """Update stat-cache mapping inodes to SHA-1 hashes.
1015
 
 
1016
 
    For testing only."""
1017
 
    hidden = True
1018
 
    def run(self):
1019
 
        import statcache
1020
 
        b = Branch('.')
1021
 
        statcache.update_cache(b.base, b.read_working_inventory())
1022
 
 
1023
 
 
1024
 
######################################################################
1025
 
# main routine
1026
 
 
1027
 
 
1028
 
# list of all available options; the rhs can be either None for an
1029
 
# option that takes no argument, or a constructor function that checks
1030
 
# the type.
1031
 
OPTIONS = {
1032
 
    'all':                    None,
1033
 
    'diff-options':           str,
1034
 
    'help':                   None,
1035
 
    'file':                   unicode,
1036
 
    'forward':                None,
1037
 
    'message':                unicode,
1038
 
    'profile':                None,
1039
 
    'revision':               _parse_revision_str,
1040
 
    'show-ids':               None,
1041
 
    'timezone':               str,
1042
 
    'verbose':                None,
1043
 
    'version':                None,
1044
 
    'email':                  None,
1045
 
    }
1046
 
 
1047
 
SHORT_OPTIONS = {
1048
 
    'm':                      'message',
1049
 
    'F':                      'file', 
1050
 
    'r':                      'revision',
1051
 
    'v':                      'verbose',
1052
 
}
1053
 
 
1054
 
 
1055
 
def parse_args(argv):
1056
 
    """Parse command line.
1057
 
    
1058
 
    Arguments and options are parsed at this level before being passed
1059
 
    down to specific command handlers.  This routine knows, from a
1060
 
    lookup table, something about the available options, what optargs
1061
 
    they take, and which commands will accept them.
1062
 
 
1063
 
    >>> parse_args('--help'.split())
1064
 
    ([], {'help': True})
1065
 
    >>> parse_args('--version'.split())
1066
 
    ([], {'version': True})
1067
 
    >>> parse_args('status --all'.split())
1068
 
    (['status'], {'all': True})
1069
 
    >>> parse_args('commit --message=biter'.split())
1070
 
    (['commit'], {'message': u'biter'})
1071
 
    """
1072
 
    args = []
1073
 
    opts = {}
1074
 
 
1075
 
    # TODO: Maybe handle '--' to end options?
1076
 
 
1077
 
    while argv:
1078
 
        a = argv.pop(0)
1079
 
        if a[0] == '-':
1080
 
            # option names must not be unicode
1081
 
            a = str(a)
1082
 
            optarg = None
1083
 
            if a[1] == '-':
1084
 
                mutter("  got option %r" % a)
1085
 
                if '=' in a:
1086
 
                    optname, optarg = a[2:].split('=', 1)
1087
 
                else:
1088
 
                    optname = a[2:]
1089
 
                if optname not in OPTIONS:
1090
 
                    bailout('unknown long option %r' % a)
1091
 
            else:
1092
 
                shortopt = a[1:]
1093
 
                if shortopt not in SHORT_OPTIONS:
1094
 
                    bailout('unknown short option %r' % a)
1095
 
                optname = SHORT_OPTIONS[shortopt]
1096
 
            
1097
 
            if optname in opts:
1098
 
                # XXX: Do we ever want to support this, e.g. for -r?
1099
 
                bailout('repeated option %r' % a)
1100
 
                
1101
 
            optargfn = OPTIONS[optname]
1102
 
            if optargfn:
1103
 
                if optarg == None:
1104
 
                    if not argv:
1105
 
                        bailout('option %r needs an argument' % a)
1106
 
                    else:
1107
 
                        optarg = argv.pop(0)
1108
 
                opts[optname] = optargfn(optarg)
1109
 
            else:
1110
 
                if optarg != None:
1111
 
                    bailout('option %r takes no argument' % optname)
1112
 
                opts[optname] = True
1113
 
        else:
1114
 
            args.append(a)
1115
 
 
1116
 
    return args, opts
1117
 
 
1118
 
 
1119
 
 
1120
 
 
1121
 
def _match_argform(cmd, takes_args, args):
1122
 
    argdict = {}
1123
 
 
1124
 
    # step through args and takes_args, allowing appropriate 0-many matches
1125
 
    for ap in takes_args:
1126
 
        argname = ap[:-1]
1127
 
        if ap[-1] == '?':
1128
 
            if args:
1129
 
                argdict[argname] = args.pop(0)
1130
 
        elif ap[-1] == '*': # all remaining arguments
1131
 
            if args:
1132
 
                argdict[argname + '_list'] = args[:]
1133
 
                args = []
1134
 
            else:
1135
 
                argdict[argname + '_list'] = None
1136
 
        elif ap[-1] == '+':
1137
 
            if not args:
1138
 
                raise BzrCommandError("command %r needs one or more %s"
1139
 
                        % (cmd, argname.upper()))
1140
 
            else:
1141
 
                argdict[argname + '_list'] = args[:]
1142
 
                args = []
1143
 
        elif ap[-1] == '$': # all but one
1144
 
            if len(args) < 2:
1145
 
                raise BzrCommandError("command %r needs one or more %s"
1146
 
                        % (cmd, argname.upper()))
1147
 
            argdict[argname + '_list'] = args[:-1]
1148
 
            args[:-1] = []                
1149
 
        else:
1150
 
            # just a plain arg
1151
 
            argname = ap
1152
 
            if not args:
1153
 
                raise BzrCommandError("command %r requires argument %s"
1154
 
                        % (cmd, argname.upper()))
1155
 
            else:
1156
 
                argdict[argname] = args.pop(0)
1157
 
            
1158
 
    if args:
1159
 
        raise BzrCommandError("extra argument to command %s: %s"
1160
 
                              % (cmd, args[0]))
1161
 
 
1162
 
    return argdict
1163
 
 
1164
 
 
1165
 
 
1166
 
def run_bzr(argv):
1167
 
    """Execute a command.
1168
 
 
1169
 
    This is similar to main(), but without all the trappings for
1170
 
    logging and error handling.  
1171
 
    """
1172
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1173
 
    
1174
 
    try:
1175
 
        args, opts = parse_args(argv[1:])
1176
 
        if 'help' in opts:
1177
 
            import help
1178
 
            if args:
1179
 
                help.help(args[0])
1180
 
            else:
1181
 
                help.help()
1182
 
            return 0
1183
 
        elif 'version' in opts:
1184
 
            show_version()
1185
 
            return 0
1186
 
        cmd = str(args.pop(0))
1187
 
    except IndexError:
1188
 
        import help
1189
 
        help.help()
1190
 
        return 1
1191
 
          
1192
 
 
1193
 
    canonical_cmd, cmd_class = get_cmd_class(cmd)
1194
 
 
1195
 
    # global option
1196
 
    if 'profile' in opts:
1197
 
        profile = True
1198
 
        del opts['profile']
1199
 
    else:
1200
 
        profile = False
1201
 
 
1202
 
    # check options are reasonable
1203
 
    allowed = cmd_class.takes_options
1204
 
    for oname in opts:
1205
 
        if oname not in allowed:
1206
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1207
 
                                  % (oname, cmd))
1208
 
 
1209
 
    # mix arguments and options into one dictionary
1210
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1211
 
    cmdopts = {}
1212
 
    for k, v in opts.items():
1213
 
        cmdopts[k.replace('-', '_')] = v
1214
 
 
1215
 
    if profile:
1216
 
        import hotshot, tempfile
1217
 
        pffileno, pfname = tempfile.mkstemp()
1218
 
        try:
1219
 
            prof = hotshot.Profile(pfname)
1220
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1221
 
            prof.close()
1222
 
 
1223
 
            import hotshot.stats
1224
 
            stats = hotshot.stats.load(pfname)
1225
 
            #stats.strip_dirs()
1226
 
            stats.sort_stats('time')
1227
 
            ## XXX: Might like to write to stderr or the trace file instead but
1228
 
            ## print_stats seems hardcoded to stdout
1229
 
            stats.print_stats(20)
1230
 
            
1231
 
            return ret.status
1232
 
 
1233
 
        finally:
1234
 
            os.close(pffileno)
1235
 
            os.remove(pfname)
1236
 
    else:
1237
 
        return cmd_class(cmdopts, cmdargs).status 
1238
 
 
1239
 
 
1240
 
def _report_exception(summary, quiet=False):
1241
 
    import traceback
1242
 
    log_error('bzr: ' + summary)
1243
 
    bzrlib.trace.log_exception()
1244
 
 
1245
 
    if not quiet:
1246
 
        tb = sys.exc_info()[2]
1247
 
        exinfo = traceback.extract_tb(tb)
1248
 
        if exinfo:
1249
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1250
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
1251
 
 
1252
 
 
1253
 
 
1254
 
def main(argv):
1255
 
    import errno
1256
 
    
1257
 
    bzrlib.open_tracefile(argv)
1258
 
 
1259
 
    try:
1260
 
        try:
1261
 
            try:
1262
 
                return run_bzr(argv)
1263
 
            finally:
1264
 
                # do this here inside the exception wrappers to catch EPIPE
1265
 
                sys.stdout.flush()
1266
 
        except BzrError, e:
1267
 
            quiet = isinstance(e, (BzrCommandError))
1268
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
1269
 
            if len(e.args) > 1:
1270
 
                for h in e.args[1]:
1271
 
                    # some explanation or hints
1272
 
                    log_error('  ' + h)
1273
 
            return 1
1274
 
        except AssertionError, e:
1275
 
            msg = 'assertion failed'
1276
 
            if str(e):
1277
 
                msg += ': ' + str(e)
1278
 
            _report_exception(msg)
1279
 
            return 2
1280
 
        except KeyboardInterrupt, e:
1281
 
            _report_exception('interrupted', quiet=True)
1282
 
            return 2
1283
 
        except Exception, e:
1284
 
            quiet = False
1285
 
            if (isinstance(e, IOError) 
1286
 
                and hasattr(e, 'errno')
1287
 
                and e.errno == errno.EPIPE):
1288
 
                quiet = True
1289
 
                msg = 'broken pipe'
1290
 
            else:
1291
 
                msg = str(e).rstrip('\n')
1292
 
            _report_exception(msg, quiet)
1293
 
            return 2
1294
 
    finally:
1295
 
        bzrlib.trace.close_trace()
1296
 
 
1297
 
 
1298
 
if __name__ == '__main__':
1299
 
    sys.exit(main(sys.argv))