/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-11 06:07:43 UTC
  • Revision ID: mbp@sourcefrog.net-20050511060743-82c5a87967ad4537
- remove diff_trees from public api

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
from sets import Set
 
21
 
 
22
import bzrlib
 
23
from bzrlib.trace import mutter, note, log_error
 
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
26
from bzrlib.tree import RevisionTree, EmptyTree, Tree
 
27
from bzrlib.revision import Revision
 
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
29
     format_date
 
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
                           file_list=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.iter_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 for this branch"""
 
373
    def run(self):
 
374
        import info
 
375
        info.show_info(Branch('.'))        
 
376
 
 
377
 
 
378
class cmd_remove(Command):
 
379
    """Make a file unversioned.
 
380
 
 
381
    This makes bzr stop tracking changes to a versioned file.  It does
 
382
    not delete the working copy.
 
383
    """
 
384
    takes_args = ['file+']
 
385
    takes_options = ['verbose']
 
386
    
 
387
    def run(self, file_list, verbose=False):
 
388
        b = Branch(file_list[0])
 
389
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
390
 
 
391
 
 
392
class cmd_file_id(Command):
 
393
    """Print file_id of a particular file or directory.
 
394
 
 
395
    The file_id is assigned when the file is first added and remains the
 
396
    same through all revisions where the file exists, even when it is
 
397
    moved or renamed.
 
398
    """
 
399
    hidden = True
 
400
    takes_args = ['filename']
 
401
    def run(self, filename):
 
402
        b = Branch(filename)
 
403
        i = b.inventory.path2id(b.relpath(filename))
 
404
        if i == None:
 
405
            bailout("%r is not a versioned file" % filename)
 
406
        else:
 
407
            print i
 
408
 
 
409
 
 
410
class cmd_file_path(Command):
 
411
    """Print path of file_ids to a file or directory.
 
412
 
 
413
    This prints one line for each directory down to the target,
 
414
    starting at the branch root."""
 
415
    hidden = True
 
416
    takes_args = ['filename']
 
417
    def run(self, filename):
 
418
        b = Branch(filename)
 
419
        inv = b.inventory
 
420
        fid = inv.path2id(b.relpath(filename))
 
421
        if fid == None:
 
422
            bailout("%r is not a versioned file" % filename)
 
423
        for fip in inv.get_idpath(fid):
 
424
            print fip
 
425
 
 
426
 
 
427
class cmd_revision_history(Command):
 
428
    """Display list of revision ids on this branch."""
 
429
    def run(self):
 
430
        for patchid in Branch('.').revision_history():
 
431
            print patchid
 
432
 
 
433
 
 
434
class cmd_directories(Command):
 
435
    """Display list of versioned directories in this branch."""
 
436
    def run(self):
 
437
        for name, ie in Branch('.').read_working_inventory().directories():
 
438
            if name == '':
 
439
                print '.'
 
440
            else:
 
441
                print name
 
442
 
 
443
 
 
444
class cmd_init(Command):
 
445
    """Make a directory into a versioned branch.
 
446
 
 
447
    Use this to create an empty branch, or before importing an
 
448
    existing project.
 
449
 
 
450
    Recipe for importing a tree of files:
 
451
        cd ~/project
 
452
        bzr init
 
453
        bzr add -v .
 
454
        bzr status
 
455
        bzr commit -m 'imported project'
 
456
    """
 
457
    def run(self):
 
458
        Branch('.', init=True)
 
459
 
 
460
 
 
461
class cmd_diff(Command):
 
462
    """Show differences in working tree.
 
463
    
 
464
    If files are listed, only the changes in those files are listed.
 
465
    Otherwise, all changes for the tree are listed.
 
466
 
 
467
    TODO: Given two revision arguments, show the difference between them.
 
468
 
 
469
    TODO: Allow diff across branches.
 
470
 
 
471
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
472
          or a graphical diff.
 
473
 
 
474
    TODO: Python difflib is not exactly the same as unidiff; should
 
475
          either fix it up or prefer to use an external diff.
 
476
 
 
477
    TODO: If a directory is given, diff everything under that.
 
478
 
 
479
    TODO: Selected-file diff is inefficient and doesn't show you
 
480
          deleted files.
 
481
 
 
482
    TODO: This probably handles non-Unix newlines poorly.
 
483
    """
 
484
    
 
485
    takes_args = ['file*']
 
486
    takes_options = ['revision']
 
487
    aliases = ['di']
 
488
 
 
489
    def run(self, revision=None, file_list=None):
 
490
        from bzrlib.diff import show_diff
 
491
    
 
492
        show_diff(Branch('.'), revision, file_list)
 
493
 
 
494
 
 
495
        
 
496
 
 
497
 
 
498
class cmd_deleted(Command):
 
499
    """List files deleted in the working tree.
 
500
 
 
501
    TODO: Show files deleted since a previous revision, or between two revisions.
 
502
    """
 
503
    def run(self, show_ids=False):
 
504
        b = Branch('.')
 
505
        old = b.basis_tree()
 
506
        new = b.working_tree()
 
507
 
 
508
        ## TODO: Much more efficient way to do this: read in new
 
509
        ## directories with readdir, rather than stating each one.  Same
 
510
        ## level of effort but possibly much less IO.  (Or possibly not,
 
511
        ## if the directories are very large...)
 
512
 
 
513
        for path, ie in old.inventory.iter_entries():
 
514
            if not new.has_id(ie.file_id):
 
515
                if show_ids:
 
516
                    print '%-50s %s' % (path, ie.file_id)
 
517
                else:
 
518
                    print path
 
519
 
 
520
 
 
521
class cmd_modified(Command):
 
522
    """List files modified in working tree."""
 
523
    hidden = True
 
524
    def run(self):
 
525
        import statcache
 
526
        b = Branch('.')
 
527
        inv = b.read_working_inventory()
 
528
        sc = statcache.update_cache(b, inv)
 
529
        basis = b.basis_tree()
 
530
        basis_inv = basis.inventory
 
531
        
 
532
        # We used to do this through iter_entries(), but that's slow
 
533
        # when most of the files are unmodified, as is usually the
 
534
        # case.  So instead we iterate by inventory entry, and only
 
535
        # calculate paths as necessary.
 
536
 
 
537
        for file_id in basis_inv:
 
538
            cacheentry = sc.get(file_id)
 
539
            if not cacheentry:                 # deleted
 
540
                continue
 
541
            ie = basis_inv[file_id]
 
542
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
543
                path = inv.id2path(file_id)
 
544
                print path
 
545
 
 
546
 
 
547
 
 
548
class cmd_added(Command):
 
549
    """List files added in working tree."""
 
550
    hidden = True
 
551
    def run(self):
 
552
        b = Branch('.')
 
553
        wt = b.working_tree()
 
554
        basis_inv = b.basis_tree().inventory
 
555
        inv = wt.inventory
 
556
        for file_id in inv:
 
557
            if file_id in basis_inv:
 
558
                continue
 
559
            path = inv.id2path(file_id)
 
560
            if not os.access(b.abspath(path), os.F_OK):
 
561
                continue
 
562
            print path
 
563
                
 
564
        
 
565
 
 
566
class cmd_root(Command):
 
567
    """Show the tree root directory.
 
568
 
 
569
    The root is the nearest enclosing directory with a .bzr control
 
570
    directory."""
 
571
    takes_args = ['filename?']
 
572
    def run(self, filename=None):
 
573
        """Print the branch root."""
 
574
        from branch import find_branch
 
575
        b = find_branch(filename)
 
576
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
577
 
 
578
 
 
579
class cmd_log(Command):
 
580
    """Show log of this branch.
 
581
 
 
582
    TODO: Option to limit range.
 
583
 
 
584
    TODO: Perhaps show most-recent first with an option for last.
 
585
    """
 
586
    takes_args = ['filename?']
 
587
    takes_options = ['timezone', 'verbose', 'show-ids']
 
588
    def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
 
589
        from branch import find_branch
 
590
        b = find_branch((filename or '.'), lock_mode='r')
 
591
        if filename:
 
592
            filename = b.relpath(filename)
 
593
        bzrlib.show_log(b, filename,
 
594
                        show_timezone=timezone,
 
595
                        verbose=verbose,
 
596
                        show_ids=show_ids)
 
597
 
 
598
 
 
599
 
 
600
class cmd_touching_revisions(Command):
 
601
    """Return revision-ids which affected a particular file."""
 
602
    hidden = True
 
603
    takes_args = ["filename"]
 
604
    def run(self, filename):
 
605
        b = Branch(filename, lock_mode='r')
 
606
        inv = b.read_working_inventory()
 
607
        file_id = inv.path2id(b.relpath(filename))
 
608
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
609
            print "%6d %s" % (revno, what)
 
610
 
 
611
 
 
612
class cmd_ls(Command):
 
613
    """List files in a tree.
 
614
 
 
615
    TODO: Take a revision or remote path and list that tree instead.
 
616
    """
 
617
    hidden = True
 
618
    def run(self, revision=None, verbose=False):
 
619
        b = Branch('.')
 
620
        if revision == None:
 
621
            tree = b.working_tree()
 
622
        else:
 
623
            tree = b.revision_tree(b.lookup_revision(revision))
 
624
 
 
625
        for fp, fc, kind, fid in tree.list_files():
 
626
            if verbose:
 
627
                if kind == 'directory':
 
628
                    kindch = '/'
 
629
                elif kind == 'file':
 
630
                    kindch = ''
 
631
                else:
 
632
                    kindch = '???'
 
633
 
 
634
                print '%-8s %s%s' % (fc, fp, kindch)
 
635
            else:
 
636
                print fp
 
637
 
 
638
 
 
639
 
 
640
class cmd_unknowns(Command):
 
641
    """List unknown files"""
 
642
    def run(self):
 
643
        for f in Branch('.').unknowns():
 
644
            print quotefn(f)
 
645
 
 
646
 
 
647
 
 
648
class cmd_ignore(Command):
 
649
    """Ignore a command or pattern
 
650
 
 
651
    To remove patterns from the ignore list, edit the .bzrignore file.
 
652
 
 
653
    If the pattern contains a slash, it is compared to the whole path
 
654
    from the branch root.  Otherwise, it is comapred to only the last
 
655
    component of the path.
 
656
 
 
657
    Ignore patterns are case-insensitive on case-insensitive systems.
 
658
 
 
659
    Note: wildcards must be quoted from the shell on Unix.
 
660
 
 
661
    examples:
 
662
        bzr ignore ./Makefile
 
663
        bzr ignore '*.class'
 
664
    """
 
665
    takes_args = ['name_pattern']
 
666
    
 
667
    def run(self, name_pattern):
 
668
        from bzrlib.atomicfile import AtomicFile
 
669
        import codecs
 
670
 
 
671
        b = Branch('.')
 
672
        ifn = b.abspath('.bzrignore')
 
673
 
 
674
        # FIXME: probably doesn't handle non-ascii patterns
 
675
 
 
676
        if os.path.exists(ifn):
 
677
            f = b.controlfile(ifn, 'rt')
 
678
            igns = f.read()
 
679
            f.close()
 
680
        else:
 
681
            igns = ''
 
682
 
 
683
        if igns and igns[-1] != '\n':
 
684
            igns += '\n'
 
685
        igns += name_pattern + '\n'
 
686
 
 
687
        f = AtomicFile(ifn, 'wt')
 
688
        f.write(igns)
 
689
        f.commit()
 
690
 
 
691
        inv = b.working_tree().inventory
 
692
        if inv.path2id('.bzrignore'):
 
693
            mutter('.bzrignore is already versioned')
 
694
        else:
 
695
            mutter('need to make new .bzrignore file versioned')
 
696
            b.add(['.bzrignore'])
 
697
 
 
698
 
 
699
 
 
700
class cmd_ignored(Command):
 
701
    """List ignored files and the patterns that matched them.
 
702
 
 
703
    See also: bzr ignore"""
 
704
    def run(self):
 
705
        tree = Branch('.').working_tree()
 
706
        for path, file_class, kind, file_id in tree.list_files():
 
707
            if file_class != 'I':
 
708
                continue
 
709
            ## XXX: Slightly inefficient since this was already calculated
 
710
            pat = tree.is_ignored(path)
 
711
            print '%-50s %s' % (path, pat)
 
712
 
 
713
 
 
714
class cmd_lookup_revision(Command):
 
715
    """Lookup the revision-id from a revision-number
 
716
 
 
717
    example:
 
718
        bzr lookup-revision 33
 
719
    """
 
720
    hidden = True
 
721
    takes_args = ['revno']
 
722
    
 
723
    def run(self, revno):
 
724
        try:
 
725
            revno = int(revno)
 
726
        except ValueError:
 
727
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
728
 
 
729
        print Branch('.').lookup_revision(revno)
 
730
 
 
731
 
 
732
class cmd_export(Command):
 
733
    """Export past revision to destination directory.
 
734
 
 
735
    If no revision is specified this exports the last committed revision."""
 
736
    takes_args = ['dest']
 
737
    takes_options = ['revision']
 
738
    def run(self, dest, revision=None):
 
739
        b = Branch('.')
 
740
        if revision == None:
 
741
            rh = b.revision_history()[-1]
 
742
        else:
 
743
            rh = b.lookup_revision(int(revision))
 
744
        t = b.revision_tree(rh)
 
745
        t.export(dest)
 
746
 
 
747
 
 
748
class cmd_cat(Command):
 
749
    """Write a file's text from a previous revision."""
 
750
 
 
751
    takes_options = ['revision']
 
752
    takes_args = ['filename']
 
753
 
 
754
    def run(self, filename, revision=None):
 
755
        if revision == None:
 
756
            raise BzrCommandError("bzr cat requires a revision number")
 
757
        b = Branch('.')
 
758
        b.print_file(b.relpath(filename), int(revision))
 
759
 
 
760
 
 
761
class cmd_local_time_offset(Command):
 
762
    """Show the offset in seconds from GMT to local time."""
 
763
    hidden = True    
 
764
    def run(self):
 
765
        print bzrlib.osutils.local_time_offset()
 
766
 
 
767
 
 
768
 
 
769
class cmd_commit(Command):
 
770
    """Commit changes into a new revision.
 
771
 
 
772
    TODO: Commit only selected files.
 
773
 
 
774
    TODO: Run hooks on tree to-be-committed, and after commit.
 
775
 
 
776
    TODO: Strict commit that fails if there are unknown or deleted files.
 
777
    """
 
778
    takes_options = ['message', 'file', 'verbose']
 
779
    aliases = ['ci', 'checkin']
 
780
 
 
781
    def run(self, message=None, file=None, verbose=False):
 
782
        ## Warning: shadows builtin file()
 
783
        if not message and not file:
 
784
            raise BzrCommandError("please specify a commit message",
 
785
                                  ["use either --message or --file"])
 
786
        elif message and file:
 
787
            raise BzrCommandError("please specify either --message or --file")
 
788
        
 
789
        if file:
 
790
            import codecs
 
791
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
792
 
 
793
        Branch('.').commit(message, verbose=verbose)
 
794
 
 
795
 
 
796
class cmd_check(Command):
 
797
    """Validate consistency of branch history.
 
798
 
 
799
    This command checks various invariants about the branch storage to
 
800
    detect data corruption or bzr bugs.
 
801
    """
 
802
    takes_args = ['dir?']
 
803
    def run(self, dir='.'):
 
804
        import bzrlib.check
 
805
        bzrlib.check.check(Branch(dir, find_root=False))
 
806
 
 
807
 
 
808
 
 
809
class cmd_whoami(Command):
 
810
    """Show bzr user id."""
 
811
    takes_options = ['email']
 
812
    
 
813
    def run(self, email=False):
 
814
        if email:
 
815
            print bzrlib.osutils.user_email()
 
816
        else:
 
817
            print bzrlib.osutils.username()
 
818
 
 
819
 
 
820
class cmd_selftest(Command):
 
821
    """Run internal test suite"""
 
822
    hidden = True
 
823
    def run(self):
 
824
        failures, tests = 0, 0
 
825
 
 
826
        import doctest, bzrlib.store, bzrlib.tests
 
827
        bzrlib.trace.verbose = False
 
828
 
 
829
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
830
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
831
            mf, mt = doctest.testmod(m)
 
832
            failures += mf
 
833
            tests += mt
 
834
            print '%-40s %3d tests' % (m.__name__, mt),
 
835
            if mf:
 
836
                print '%3d FAILED!' % mf
 
837
            else:
 
838
                print
 
839
 
 
840
        print '%-40s %3d tests' % ('total', tests),
 
841
        if failures:
 
842
            print '%3d FAILED!' % failures
 
843
        else:
 
844
            print
 
845
 
 
846
 
 
847
 
 
848
class cmd_version(Command):
 
849
    """Show version of bzr"""
 
850
    def run(self):
 
851
        show_version()
 
852
 
 
853
def show_version():
 
854
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
855
    print bzrlib.__copyright__
 
856
    print "http://bazaar-ng.org/"
 
857
    print
 
858
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
859
    print "you may use, modify and redistribute it under the terms of the GNU"
 
860
    print "General Public License version 2 or later."
 
861
 
 
862
 
 
863
class cmd_rocks(Command):
 
864
    """Statement of optimism."""
 
865
    hidden = True
 
866
    def run(self):
 
867
        print "it sure does!"
 
868
 
 
869
 
 
870
class cmd_assert_fail(Command):
 
871
    """Test reporting of assertion failures"""
 
872
    hidden = True
 
873
    def run(self):
 
874
        assert False, "always fails"
 
875
 
 
876
 
 
877
class cmd_help(Command):
 
878
    """Show help on a command or other topic.
 
879
 
 
880
    For a list of all available commands, say 'bzr help commands'."""
 
881
    takes_args = ['topic?']
 
882
    aliases = ['?']
 
883
    
 
884
    def run(self, topic=None):
 
885
        import help
 
886
        help.help(topic)
 
887
 
 
888
 
 
889
class cmd_update_stat_cache(Command):
 
890
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
891
 
 
892
    For testing only."""
 
893
    hidden = True
 
894
    def run(self):
 
895
        import statcache
 
896
        b = Branch('.')
 
897
        statcache.update_cache(b.base, b.read_working_inventory())
 
898
 
 
899
 
 
900
class cmd_compare_trees(Command):
 
901
    """Show quick calculation of status."""
 
902
    hidden = True
 
903
    def run(self):
 
904
        import diff
 
905
        b = Branch('.')
 
906
        delta = diff.compare_trees(b.basis_tree(), b.working_tree())
 
907
        delta.show(sys.stdout, False)
 
908
 
 
909
 
 
910
######################################################################
 
911
# main routine
 
912
 
 
913
 
 
914
# list of all available options; the rhs can be either None for an
 
915
# option that takes no argument, or a constructor function that checks
 
916
# the type.
 
917
OPTIONS = {
 
918
    'all':                    None,
 
919
    'help':                   None,
 
920
    'file':                   unicode,
 
921
    'message':                unicode,
 
922
    'profile':                None,
 
923
    'revision':               int,
 
924
    'show-ids':               None,
 
925
    'timezone':               str,
 
926
    'verbose':                None,
 
927
    'version':                None,
 
928
    'email':                  None,
 
929
    }
 
930
 
 
931
SHORT_OPTIONS = {
 
932
    'm':                      'message',
 
933
    'F':                      'file', 
 
934
    'r':                      'revision',
 
935
    'v':                      'verbose',
 
936
}
 
937
 
 
938
 
 
939
def parse_args(argv):
 
940
    """Parse command line.
 
941
    
 
942
    Arguments and options are parsed at this level before being passed
 
943
    down to specific command handlers.  This routine knows, from a
 
944
    lookup table, something about the available options, what optargs
 
945
    they take, and which commands will accept them.
 
946
 
 
947
    >>> parse_args('--help'.split())
 
948
    ([], {'help': True})
 
949
    >>> parse_args('--version'.split())
 
950
    ([], {'version': True})
 
951
    >>> parse_args('status --all'.split())
 
952
    (['status'], {'all': True})
 
953
    >>> parse_args('commit --message=biter'.split())
 
954
    (['commit'], {'message': u'biter'})
 
955
    """
 
956
    args = []
 
957
    opts = {}
 
958
 
 
959
    # TODO: Maybe handle '--' to end options?
 
960
 
 
961
    while argv:
 
962
        a = argv.pop(0)
 
963
        if a[0] == '-':
 
964
            # option names must not be unicode
 
965
            a = str(a)
 
966
            optarg = None
 
967
            if a[1] == '-':
 
968
                mutter("  got option %r" % a)
 
969
                if '=' in a:
 
970
                    optname, optarg = a[2:].split('=', 1)
 
971
                else:
 
972
                    optname = a[2:]
 
973
                if optname not in OPTIONS:
 
974
                    bailout('unknown long option %r' % a)
 
975
            else:
 
976
                shortopt = a[1:]
 
977
                if shortopt not in SHORT_OPTIONS:
 
978
                    bailout('unknown short option %r' % a)
 
979
                optname = SHORT_OPTIONS[shortopt]
 
980
            
 
981
            if optname in opts:
 
982
                # XXX: Do we ever want to support this, e.g. for -r?
 
983
                bailout('repeated option %r' % a)
 
984
                
 
985
            optargfn = OPTIONS[optname]
 
986
            if optargfn:
 
987
                if optarg == None:
 
988
                    if not argv:
 
989
                        bailout('option %r needs an argument' % a)
 
990
                    else:
 
991
                        optarg = argv.pop(0)
 
992
                opts[optname] = optargfn(optarg)
 
993
            else:
 
994
                if optarg != None:
 
995
                    bailout('option %r takes no argument' % optname)
 
996
                opts[optname] = True
 
997
        else:
 
998
            args.append(a)
 
999
 
 
1000
    return args, opts
 
1001
 
 
1002
 
 
1003
 
 
1004
 
 
1005
def _match_argform(cmd, takes_args, args):
 
1006
    argdict = {}
 
1007
 
 
1008
    # step through args and takes_args, allowing appropriate 0-many matches
 
1009
    for ap in takes_args:
 
1010
        argname = ap[:-1]
 
1011
        if ap[-1] == '?':
 
1012
            if args:
 
1013
                argdict[argname] = args.pop(0)
 
1014
        elif ap[-1] == '*': # all remaining arguments
 
1015
            if args:
 
1016
                argdict[argname + '_list'] = args[:]
 
1017
                args = []
 
1018
            else:
 
1019
                argdict[argname + '_list'] = None
 
1020
        elif ap[-1] == '+':
 
1021
            if not args:
 
1022
                raise BzrCommandError("command %r needs one or more %s"
 
1023
                        % (cmd, argname.upper()))
 
1024
            else:
 
1025
                argdict[argname + '_list'] = args[:]
 
1026
                args = []
 
1027
        elif ap[-1] == '$': # all but one
 
1028
            if len(args) < 2:
 
1029
                raise BzrCommandError("command %r needs one or more %s"
 
1030
                        % (cmd, argname.upper()))
 
1031
            argdict[argname + '_list'] = args[:-1]
 
1032
            args[:-1] = []                
 
1033
        else:
 
1034
            # just a plain arg
 
1035
            argname = ap
 
1036
            if not args:
 
1037
                raise BzrCommandError("command %r requires argument %s"
 
1038
                        % (cmd, argname.upper()))
 
1039
            else:
 
1040
                argdict[argname] = args.pop(0)
 
1041
            
 
1042
    if args:
 
1043
        raise BzrCommandError("extra argument to command %s: %s"
 
1044
                              % (cmd, args[0]))
 
1045
 
 
1046
    return argdict
 
1047
 
 
1048
 
 
1049
 
 
1050
def run_bzr(argv):
 
1051
    """Execute a command.
 
1052
 
 
1053
    This is similar to main(), but without all the trappings for
 
1054
    logging and error handling.  
 
1055
    """
 
1056
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1057
    
 
1058
    try:
 
1059
        args, opts = parse_args(argv[1:])
 
1060
        if 'help' in opts:
 
1061
            import help
 
1062
            if args:
 
1063
                help.help(args[0])
 
1064
            else:
 
1065
                help.help()
 
1066
            return 0
 
1067
        elif 'version' in opts:
 
1068
            show_version()
 
1069
            return 0
 
1070
        cmd = str(args.pop(0))
 
1071
    except IndexError:
 
1072
        import help
 
1073
        help.help()
 
1074
        return 1
 
1075
          
 
1076
 
 
1077
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
1078
 
 
1079
    # global option
 
1080
    if 'profile' in opts:
 
1081
        profile = True
 
1082
        del opts['profile']
 
1083
    else:
 
1084
        profile = False
 
1085
 
 
1086
    # check options are reasonable
 
1087
    allowed = cmd_class.takes_options
 
1088
    for oname in opts:
 
1089
        if oname not in allowed:
 
1090
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1091
                                  % (oname, cmd))
 
1092
 
 
1093
    # mix arguments and options into one dictionary
 
1094
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1095
    cmdopts = {}
 
1096
    for k, v in opts.items():
 
1097
        cmdopts[k.replace('-', '_')] = v
 
1098
 
 
1099
    if profile:
 
1100
        import hotshot, tempfile
 
1101
        pffileno, pfname = tempfile.mkstemp()
 
1102
        try:
 
1103
            prof = hotshot.Profile(pfname)
 
1104
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1105
            prof.close()
 
1106
 
 
1107
            import hotshot.stats
 
1108
            stats = hotshot.stats.load(pfname)
 
1109
            #stats.strip_dirs()
 
1110
            stats.sort_stats('time')
 
1111
            ## XXX: Might like to write to stderr or the trace file instead but
 
1112
            ## print_stats seems hardcoded to stdout
 
1113
            stats.print_stats(20)
 
1114
            
 
1115
            return ret.status
 
1116
 
 
1117
        finally:
 
1118
            os.close(pffileno)
 
1119
            os.remove(pfname)
 
1120
    else:
 
1121
        cmdobj = cmd_class(cmdopts, cmdargs).status 
 
1122
 
 
1123
 
 
1124
def _report_exception(summary, quiet=False):
 
1125
    import traceback
 
1126
    log_error('bzr: ' + summary)
 
1127
    bzrlib.trace.log_exception()
 
1128
 
 
1129
    if not quiet:
 
1130
        tb = sys.exc_info()[2]
 
1131
        exinfo = traceback.extract_tb(tb)
 
1132
        if exinfo:
 
1133
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1134
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1135
 
 
1136
 
 
1137
 
 
1138
def main(argv):
 
1139
    import errno
 
1140
    
 
1141
    bzrlib.open_tracefile(argv)
 
1142
 
 
1143
    try:
 
1144
        try:
 
1145
            try:
 
1146
                return run_bzr(argv)
 
1147
            finally:
 
1148
                # do this here inside the exception wrappers to catch EPIPE
 
1149
                sys.stdout.flush()
 
1150
        except BzrError, e:
 
1151
            quiet = isinstance(e, (BzrCommandError))
 
1152
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1153
            if len(e.args) > 1:
 
1154
                for h in e.args[1]:
 
1155
                    # some explanation or hints
 
1156
                    log_error('  ' + h)
 
1157
            return 1
 
1158
        except AssertionError, e:
 
1159
            msg = 'assertion failed'
 
1160
            if str(e):
 
1161
                msg += ': ' + str(e)
 
1162
            _report_exception(msg)
 
1163
            return 2
 
1164
        except KeyboardInterrupt, e:
 
1165
            _report_exception('interrupted', quiet=True)
 
1166
            return 2
 
1167
        except Exception, e:
 
1168
            quiet = False
 
1169
            if (isinstance(e, IOError) 
 
1170
                and hasattr(e, 'errno')
 
1171
                and e.errno == errno.EPIPE):
 
1172
                quiet = True
 
1173
                msg = 'broken pipe'
 
1174
            else:
 
1175
                msg = str(e).rstrip('\n')
 
1176
            _report_exception(msg, quiet)
 
1177
            return 2
 
1178
    finally:
 
1179
        bzrlib.trace.close_trace()
 
1180
 
 
1181
 
 
1182
if __name__ == '__main__':
 
1183
    sys.exit(main(sys.argv))