/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-05-26 01:47:47 UTC
  • Revision ID: mbp@sourcefrog.net-20050526014747-ff75ca198ee02e1e
- Refactor/cleanup Inventory.entries()
- Rewrite Inventory.directories() to return a list rather than recursive 
  generators; simpler and much faster

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