/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/mutabletree.py

  • Committer: Robert Collins
  • Date: 2009-03-13 02:25:46 UTC
  • mfrom: (4133 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4183.
  • Revision ID: robertc@robertcollins.net-20090313022546-e7de5zsdkbay5okf
MergeĀ .dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
    add,
29
29
    bzrdir,
30
30
    hooks,
 
31
    symbol_versioning,
31
32
    )
32
33
from bzrlib.osutils import dirname
33
34
from bzrlib.revisiontree import RevisionTree
41
42
    )
42
43
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
44
from bzrlib.osutils import splitpath
44
 
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
45
45
 
46
46
 
47
47
def needs_tree_write_lock(unbound):
69
69
    entirely in memory.
70
70
 
71
71
    For now, we are not treating MutableTree as an interface to provide
72
 
    conformance tests for - rather we are testing MemoryTree specifically, and 
 
72
    conformance tests for - rather we are testing MemoryTree specifically, and
73
73
    interface testing implementations of WorkingTree.
74
74
 
75
75
    A mutable tree always has an associated Branch and BzrDir object - the
76
76
    branch and bzrdir attributes.
77
77
    """
 
78
    def __init__(self, *args, **kw):
 
79
        super(MutableTree, self).__init__(*args, **kw)
 
80
        # Is this tree on a case-insensitive or case-preserving file-system?
 
81
        # Sub-classes may initialize to False if they detect they are being
 
82
        # used on media which doesn't differentiate the case of names.
 
83
        self.case_sensitive = True
78
84
 
79
85
    @needs_tree_write_lock
80
86
    def add(self, files, ids=None, kinds=None):
124
130
            if self.is_control_filename(f):
125
131
                raise errors.ForbiddenControlFileError(filename=f)
126
132
            fp = splitpath(f)
127
 
        # fill out file kinds for all files [not needed when we stop 
 
133
        # fill out file kinds for all files [not needed when we stop
128
134
        # caring about the instantaneous file kind within a uncommmitted tree
129
135
        #
130
136
        self._gather_kinds(files, kinds)
181
187
        from bzrlib import commit
182
188
        if revprops is None:
183
189
            revprops = {}
 
190
        possible_master_transports=[]
184
191
        if not 'branch-nick' in revprops:
185
 
            revprops['branch-nick'] = self.branch.nick
 
192
            revprops['branch-nick'] = self.branch._get_nick(
 
193
                kwargs.get('local', False),
 
194
                possible_master_transports)
 
195
        authors = kwargs.pop('authors', None)
186
196
        author = kwargs.pop('author', None)
 
197
        if authors is not None:
 
198
            if author is not None:
 
199
                raise AssertionError('Specifying both author and authors '
 
200
                        'is not allowed. Specify just authors instead')
 
201
            if 'author' in revprops or 'authors' in revprops:
 
202
                # XXX: maybe we should just accept one of them?
 
203
                raise AssertionError('author property given twice')
 
204
            if authors:
 
205
                for individual in authors:
 
206
                    if '\n' in individual:
 
207
                        raise AssertionError('\\n is not a valid character '
 
208
                                'in an author identity')
 
209
                revprops['authors'] = '\n'.join(authors)
187
210
        if author is not None:
188
 
            if 'author' in revprops:
 
211
            symbol_versioning.warn('The parameter author was deprecated'
 
212
                   ' in version 1.13. Use authors instead',
 
213
                   DeprecationWarning)
 
214
            if 'author' in revprops or 'authors' in revprops:
189
215
                # XXX: maybe we should just accept one of them?
190
216
                raise AssertionError('author property given twice')
191
 
            revprops['author'] = author
 
217
            if '\n' in author:
 
218
                raise AssertionError('\\n is not a valid character '
 
219
                        'in an author identity')
 
220
            revprops['authors'] = author
192
221
        # args for wt.commit start at message from the Commit.commit method,
193
222
        args = (message, ) + args
194
223
        for hook in MutableTree.hooks['start_commit']:
195
224
            hook(self)
196
225
        committed_id = commit.Commit().commit(working_tree=self,
197
 
            revprops=revprops, *args, **kwargs)
 
226
            revprops=revprops,
 
227
            possible_master_transports=possible_master_transports,
 
228
            *args, **kwargs)
198
229
        return committed_id
199
230
 
200
231
    def _gather_kinds(self, files, kinds):
222
253
        In early tree formats the result of last_revision is the same as the
223
254
        branch last_revision, but that is no longer the case for modern tree
224
255
        formats.
225
 
        
 
256
 
226
257
        last_revision returns the left most parent id, or None if there are no
227
258
        parents.
228
259
 
245
276
    def lock_write(self):
246
277
        """Lock the tree and its branch. This allows mutating calls to be made.
247
278
 
248
 
        Some mutating methods will take out implicit write locks, but in 
 
279
        Some mutating methods will take out implicit write locks, but in
249
280
        general you should always obtain a write lock before calling mutating
250
281
        methods on a tree.
251
282
        """
267
298
        The intent of this function is to allow trees that have a hashcache to
268
299
        update the hashcache during commit. If the observed file is too new
269
300
        (based on the stat_value) to be safely hash-cached the tree will ignore
270
 
        it. 
 
301
        it.
271
302
 
272
303
        The default implementation does nothing.
273
304
 
278
309
        :return: None
279
310
        """
280
311
 
 
312
    def _fix_case_of_inventory_path(self, path):
 
313
        """If our tree isn't case sensitive, return the canonical path"""
 
314
        if not self.case_sensitive:
 
315
            path = self.get_canonical_inventory_path(path)
 
316
        return path
 
317
 
281
318
    @needs_write_lock
282
319
    def put_file_bytes_non_atomic(self, file_id, bytes):
283
320
        """Update the content of a file in the tree.
284
 
        
 
321
 
285
322
        Note that the file is written in-place rather than being
286
323
        written to a temporary location and renamed. As a consequence,
287
324
        readers can potentially see the file half-written.
301
338
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
302
339
        """Set the parents of the working tree.
303
340
 
304
 
        :param parents_list: A list of (revision_id, tree) tuples. 
 
341
        :param parents_list: A list of (revision_id, tree) tuples.
305
342
            If tree is None, then that element is treated as an unreachable
306
343
            parent tree - i.e. a ghost.
307
344
        """
315
352
        For the specific behaviour see the help for cmd_add().
316
353
 
317
354
        :param action: A reporter to be called with the inventory, parent_ie,
318
 
            path and kind of the path being added. It may return a file_id if 
 
355
            path and kind of the path being added. It may return a file_id if
319
356
            a specific one should be used.
320
357
        :param save: Save the inventory after completing the adds. If False
321
358
            this provides dry-run functionality by doing the add and not saving
329
366
        from bzrlib.inventory import InventoryEntry
330
367
        if action is None:
331
368
            action = add.AddAction()
332
 
        
 
369
 
333
370
        if not file_list:
334
371
            # no paths supplied: add the entire tree.
335
372
            file_list = [u'.']
340
377
        dirs_to_add = []
341
378
        user_dirs = set()
342
379
 
343
 
        # validate user file paths and convert all paths to tree 
 
380
        # validate user file paths and convert all paths to tree
344
381
        # relative : it's cheaper to make a tree relative path an abspath
345
 
        # than to convert an abspath to tree relative.
346
 
        for filepath in file_list:
347
 
            rf = _FastPath(self.relpath(filepath))
 
382
        # than to convert an abspath to tree relative, and it's cheaper to
 
383
        # perform the canonicalization in bulk.
 
384
        for filepath in osutils.canonical_relpaths(self.basedir, file_list):
 
385
            rf = _FastPath(filepath)
348
386
            # validate user parameters. Our recursive code avoids adding new files
349
 
            # that need such validation 
 
387
            # that need such validation
350
388
            if self.is_control_filename(rf.raw_path):
351
389
                raise errors.ForbiddenControlFileError(filename=rf.raw_path)
352
 
            
 
390
 
353
391
            abspath = self.abspath(rf.raw_path)
354
392
            kind = osutils.file_kind(abspath)
355
393
            if kind == 'directory':
360
398
                    raise errors.BadFileKindError(filename=abspath, kind=kind)
361
399
            # ensure the named path is added, so that ignore rules in the later directory
362
400
            # walk dont skip it.
363
 
            # we dont have a parent ie known yet.: use the relatively slower inventory 
 
401
            # we dont have a parent ie known yet.: use the relatively slower inventory
364
402
            # probing method
365
403
            versioned = inv.has_filename(rf.raw_path)
366
404
            if versioned:
403
441
            if parent_ie is not None:
404
442
                versioned = directory.base_path in parent_ie.children
405
443
            else:
406
 
                # without the parent ie, use the relatively slower inventory 
 
444
                # without the parent ie, use the relatively slower inventory
407
445
                # probing method
408
 
                versioned = inv.has_filename(directory.raw_path)
 
446
                versioned = inv.has_filename(
 
447
                        self._fix_case_of_inventory_path(directory.raw_path))
409
448
 
410
449
            if kind == 'directory':
411
450
                try:
426
465
                # mutter("%r is already versioned", abspath)
427
466
            elif sub_tree:
428
467
                # XXX: This is wrong; people *might* reasonably be trying to add
429
 
                # subtrees as subtrees.  This should probably only be done in formats 
 
468
                # subtrees as subtrees.  This should probably only be done in formats
430
469
                # which can represent subtrees, and even then perhaps only when
431
470
                # the user asked to add subtrees.  At the moment you can add them
432
471
                # specially through 'join --reference', which is perhaps
442
481
                    # must be present:
443
482
                    this_ie = parent_ie.children[directory.base_path]
444
483
                else:
445
 
                    # without the parent ie, use the relatively slower inventory 
 
484
                    # without the parent ie, use the relatively slower inventory
446
485
                    # probing method
447
 
                    this_id = inv.path2id(directory.raw_path)
 
486
                    this_id = inv.path2id(
 
487
                            self._fix_case_of_inventory_path(directory.raw_path))
448
488
                    if this_id is None:
449
489
                        this_ie = None
450
490
                    else:
451
491
                        this_ie = inv[this_id]
452
492
 
453
493
                for subf in sorted(os.listdir(abspath)):
454
 
                    # here we could use TreeDirectory rather than 
 
494
                    # here we could use TreeDirectory rather than
455
495
                    # string concatenation.
456
496
                    subp = osutils.pathjoin(directory.raw_path, subf)
457
 
                    # TODO: is_control_filename is very slow. Make it faster. 
458
 
                    # TreeDirectory.is_control_filename could also make this 
459
 
                    # faster - its impossible for a non root dir to have a 
 
497
                    # TODO: is_control_filename is very slow. Make it faster.
 
498
                    # TreeDirectory.is_control_filename could also make this
 
499
                    # faster - its impossible for a non root dir to have a
460
500
                    # control file.
461
501
                    if self.is_control_filename(subp):
462
502
                        mutter("skip control directory %r", subp)
520
560
 
521
561
 
522
562
class MutableTreeHooks(hooks.Hooks):
523
 
    """A dictionary mapping a hook name to a list of callables for mutabletree 
 
563
    """A dictionary mapping a hook name to a list of callables for mutabletree
524
564
    hooks.
525
565
    """
526
566
 
529
569
 
530
570
        """
531
571
        hooks.Hooks.__init__(self)
532
 
        # Invoked before a commit is done in a tree. New in 1.4
533
 
        self['start_commit'] = []
 
572
        self.create_hook(hooks.HookPoint('start_commit',
 
573
            "Called before a commit is performed on a tree. The start commit "
 
574
            "hook is able to change the tree before the commit takes place. "
 
575
            "start_commit is called with the bzrlib.tree.MutableTree that the "
 
576
            "commit is being performed on.", (1, 4), None))
534
577
 
535
578
 
536
579
# install the default hooks into the MutableTree class.
576
619
        added = []
577
620
    else:
578
621
        # slower but does not need parent_ie
579
 
        if inv.has_filename(path.raw_path):
 
622
        if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
580
623
            return []
581
624
        # its really not there : add the parent
582
625
        # note that the dirname use leads to some extra str copying etc but as