← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-06-08 15:08:04 UTC
  • mfrom: (1740.3.10 commit_builder)
  • Revision ID: pqm@pqm.ubuntu.com-20060608150804-a186fa90bfede9a6
(jrv,rbc,jam) Refactor commit.Commit to use a Repository specific CommitBuilder, enables foreign branch commits

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
69
69
import time
70
70
import pdb
71
71
 
72
 
from binascii import hexlify
73
72
from cStringIO import StringIO
74
73
 
75
74
from bzrlib.atomicfile import AtomicFile
76
 
from bzrlib.osutils import (local_time_offset,
77
 
                            rand_bytes, compact_date,
78
 
                            kind_marker, is_inside_any, quotefn,
79
 
                            sha_file, isdir, isfile,
80
 
                            split_lines)
81
75
import bzrlib.config
82
76
import bzrlib.errors as errors
83
77
from bzrlib.errors import (BzrError, PointlessCommit,
85
79
                           ConflictsInTree,
86
80
                           StrictCommitFailed
87
81
                           )
88
 
from bzrlib.revision import Revision
 
82
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
83
                            is_inside_or_parent_of_any,
 
84
                            quotefn, sha_file, split_lines)
89
85
from bzrlib.testament import Testament
90
86
from bzrlib.trace import mutter, note, warning
91
87
from bzrlib.xml5 import serializer_v5
243
239
        self.local = local
244
240
        self.master_branch = None
245
241
        self.master_locked = False
246
 
        self.rev_id = rev_id
 
242
        self.rev_id = None
247
243
        self.specific_files = specific_files
248
244
        self.allow_pointless = allow_pointless
249
 
        self.revprops = {}
250
 
        if revprops is not None:
251
 
            self.revprops.update(revprops)
252
245
 
253
246
        if reporter is None and self.reporter is None:
254
247
            self.reporter = NullCommitReporter()
275
268
                # raise an exception as soon as we find a single unknown.
276
269
                for unknown in self.work_tree.unknowns():
277
270
                    raise StrictCommitFailed()
278
 
    
279
 
            if timestamp is None:
280
 
                self.timestamp = time.time()
281
 
            else:
282
 
                self.timestamp = long(timestamp)
283
 
                
 
271
                   
284
272
            if self.config is None:
285
273
                self.config = bzrlib.config.BranchConfig(self.branch)
286
 
    
287
 
            if rev_id is None:
288
 
                self.rev_id = _gen_revision_id(self.config, self.timestamp)
289
 
            else:
290
 
                self.rev_id = rev_id
291
 
    
292
 
            if committer is None:
293
 
                self.committer = self.config.username()
294
 
            else:
295
 
                assert isinstance(committer, basestring), type(committer)
296
 
                self.committer = committer
297
 
    
298
 
            if timezone is None:
299
 
                self.timezone = local_time_offset()
300
 
            else:
301
 
                self.timezone = int(timezone)
302
 
    
 
274
      
303
275
            if isinstance(message, str):
304
276
                message = message.decode(bzrlib.user_encoding)
305
277
            assert isinstance(message, unicode), type(message)
314
286
            # note that this estimate is too long when we do a partial tree
315
287
            # commit which excludes some new files from being considered.
316
288
            # The estimate is corrected when we populate the new inv.
317
 
            self.pb_total = len(self.basis_inv) + len(self.work_inv) + 3 - 1
 
289
            self.pb_total = len(self.work_inv) + 5
318
290
            self.pb_count = 0
319
291
 
320
292
            self._gather_parents()
322
294
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
323
295
                        self.specific_files)
324
296
            self._check_parents_present()
 
297
            self.builder = self.branch.get_commit_builder(self.parents, 
 
298
                self.config, timestamp, timezone, committer, revprops, rev_id)
325
299
            
326
300
            self._remove_deleted()
327
301
            self._populate_new_inv()
328
 
            self._store_snapshot()
329
302
            self._report_deletes()
330
303
 
331
304
            if not (self.allow_pointless
332
305
                    or len(self.parents) > 1
333
 
                    or self.new_inv != self.basis_inv):
 
306
                    or self.builder.new_inventory != self.basis_inv):
334
307
                raise PointlessCommit()
335
308
 
336
309
            self._emit_progress_update()
337
 
            self.inv_sha1 = self.branch.repository.add_inventory(
338
 
                self.rev_id,
339
 
                self.new_inv,
340
 
                self.present_parents
341
 
                )
342
 
            self._emit_progress_update()
343
 
            self._make_revision()
 
310
            # TODO: Now the new inventory is known, check for conflicts and prompt the 
 
311
            # user for a commit message.
 
312
            self.builder.finish_inventory()
 
313
            self._emit_progress_update()
 
314
            self.rev_id = self.builder.commit(self.message)
 
315
            self._emit_progress_update()
344
316
            # revision data is in the local branch now.
345
317
            
346
318
            # upload revision data to the master.
478
450
 
479
451
    def _gather_parents(self):
480
452
        """Record the parents of a merge for merge detection."""
 
453
        # TODO: Make sure that this list doesn't contain duplicate 
 
454
        # entries and the order is preserved when doing this.
481
455
        pending_merges = self.work_tree.pending_merges()
482
456
        self.parents = []
483
457
        self.parent_invs = []
484
 
        self.present_parents = []
485
458
        precursor_id = self.branch.last_revision()
486
459
        if precursor_id:
487
460
            self.parents.append(precursor_id)
490
463
            if self.branch.repository.has_revision(revision):
491
464
                inventory = self.branch.repository.get_inventory(revision)
492
465
                self.parent_invs.append(inventory)
493
 
                self.present_parents.append(revision)
494
466
 
495
467
    def _check_parents_present(self):
496
468
        for parent_id in self.parents:
502
474
                else:
503
475
                    mutter("commit will ghost revision %r", parent_id)
504
476
            
505
 
    def _make_revision(self):
506
 
        """Record a new revision object for this commit."""
507
 
        rev = Revision(timestamp=self.timestamp,
508
 
                       timezone=self.timezone,
509
 
                       committer=self.committer,
510
 
                       message=self.message,
511
 
                       inventory_sha1=self.inv_sha1,
512
 
                       revision_id=self.rev_id,
513
 
                       properties=self.revprops)
514
 
        rev.parent_ids = self.parents
515
 
        self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
516
 
 
517
477
    def _remove_deleted(self):
518
478
        """Remove deleted files from the working inventories.
519
479
 
539
499
                del self.work_inv[file_id]
540
500
            self.work_tree._write_inventory(self.work_inv)
541
501
 
542
 
    def _store_snapshot(self):
543
 
        """Pass over inventory and record a snapshot.
544
 
 
545
 
        Entries get a new revision when they are modified in 
546
 
        any way, which includes a merge with a new set of
547
 
        parents that have the same entry. 
548
 
        """
549
 
        # XXX: Need to think more here about when the user has
550
 
        # made a specific decision on a particular value -- c.f.
551
 
        # mark-merge.  
552
 
 
553
 
        # iter_entries does not visit the ROOT_ID node so we need to call
554
 
        # self._emit_progress_update once by hand.
555
 
        self._emit_progress_update()
556
 
        for path, ie in self.new_inv.iter_entries():
557
 
            self._emit_progress_update()
558
 
            previous_entries = ie.find_previous_heads(
559
 
                self.parent_invs,
560
 
                self.weave_store,
561
 
                self.branch.repository.get_transaction())
562
 
            if ie.revision is None:
563
 
                # we are creating a new revision for ie in the history store
564
 
                # and inventory.
565
 
                ie.snapshot(self.rev_id, path, previous_entries,
566
 
                    self.work_tree, self.weave_store,
567
 
                    self.branch.repository.get_transaction())
568
 
            # describe the nature of the change that has occured relative to
569
 
            # the basis inventory.
570
 
            if (self.basis_inv.has_id(ie.file_id)):
571
 
                basis_ie = self.basis_inv[ie.file_id]
572
 
            else:
573
 
                basis_ie = None
574
 
            change = ie.describe_change(basis_ie, ie)
575
 
            if change in (InventoryEntry.RENAMED, 
576
 
                InventoryEntry.MODIFIED_AND_RENAMED):
577
 
                old_path = self.basis_inv.id2path(ie.file_id)
578
 
                self.reporter.renamed(change, old_path, path)
579
 
            else:
580
 
                self.reporter.snapshot_change(change, path)
581
 
 
582
502
    def _populate_new_inv(self):
583
503
        """Build revision inventory.
584
504
 
590
510
        revision set to their prior value.
591
511
        """
592
512
        mutter("Selecting files for commit with filter %s", self.specific_files)
593
 
        self.new_inv = Inventory(revision_id=self.rev_id)
594
513
        # iter_entries does not visit the ROOT_ID node so we need to call
595
514
        # self._emit_progress_update once by hand.
596
515
        self._emit_progress_update()
597
516
        for path, new_ie in self.work_inv.iter_entries():
598
517
            self._emit_progress_update()
599
518
            file_id = new_ie.file_id
600
 
            mutter('check %s {%s}', path, new_ie.file_id)
601
 
            if self.specific_files:
602
 
                if not is_inside_any(self.specific_files, path):
603
 
                    mutter('%s not selected for commit', path)
604
 
                    self._carry_entry(file_id)
 
519
            mutter('check %s {%s}', path, file_id)
 
520
            if (not self.specific_files or 
 
521
                is_inside_or_parent_of_any(self.specific_files, path)):
 
522
                    mutter('%s selected for commit', path)
 
523
                    ie = new_ie.copy()
 
524
                    ie.revision = None
 
525
            else:
 
526
                mutter('%s not selected for commit', path)
 
527
                if self.basis_inv.has_id(file_id):
 
528
                    ie = self.basis_inv[file_id].copy()
 
529
                else:
 
530
                    # this entry is new and not being committed
605
531
                    continue
606
 
                else:
607
 
                    # this is selected, ensure its parents are too.
608
 
                    parent_id = new_ie.parent_id
609
 
                    while parent_id != ROOT_ID:
610
 
                        if not self.new_inv.has_id(parent_id):
611
 
                            ie = self._select_entry(self.work_inv[parent_id])
612
 
                            mutter('%s selected for commit because of %s',
613
 
                                   self.new_inv.id2path(parent_id), path)
614
532
 
615
 
                        ie = self.new_inv[parent_id]
616
 
                        if ie.revision is not None:
617
 
                            ie.revision = None
618
 
                            mutter('%s selected for commit because of %s',
619
 
                                   self.new_inv.id2path(parent_id), path)
620
 
                        parent_id = ie.parent_id
621
 
            mutter('%s selected for commit', path)
622
 
            self._select_entry(new_ie)
 
533
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
534
                path, self.work_tree)
 
535
            # describe the nature of the change that has occured relative to
 
536
            # the basis inventory.
 
537
            if (self.basis_inv.has_id(ie.file_id)):
 
538
                basis_ie = self.basis_inv[ie.file_id]
 
539
            else:
 
540
                basis_ie = None
 
541
            change = ie.describe_change(basis_ie, ie)
 
542
            if change in (InventoryEntry.RENAMED, 
 
543
                InventoryEntry.MODIFIED_AND_RENAMED):
 
544
                old_path = self.basis_inv.id2path(ie.file_id)
 
545
                self.reporter.renamed(change, old_path, path)
 
546
            else:
 
547
                self.reporter.snapshot_change(change, path)
623
548
 
624
549
    def _emit_progress_update(self):
625
550
        """Emit an update to the progress bar."""
626
551
        self.pb.update("Committing", self.pb_count, self.pb_total)
627
552
        self.pb_count += 1
628
553
 
629
 
    def _select_entry(self, new_ie):
630
 
        """Make new_ie be considered for committing."""
631
 
        ie = new_ie.copy()
632
 
        ie.revision = None
633
 
        self.new_inv.add(ie)
634
 
        return ie
635
 
 
636
 
    def _carry_entry(self, file_id):
637
 
        """Carry the file unchanged from the basis revision."""
638
 
        if self.basis_inv.has_id(file_id):
639
 
            self.new_inv.add(self.basis_inv[file_id].copy())
640
 
        else:
641
 
            # this entry is new and not being committed
642
 
            self.pb_total -= 1
643
 
 
644
554
    def _report_deletes(self):
645
555
        for path, ie in self.basis_inv.iter_entries():
646
 
            if ie.file_id not in self.new_inv:
 
556
            if ie.file_id not in self.builder.new_inventory:
647
557
                self.reporter.deleted(path)
648
558
 
649
 
def _gen_revision_id(config, when):
650
 
    """Return new revision-id."""
651
 
    s = '%s-%s-' % (config.user_email(), compact_date(when))
652
 
    s += hexlify(rand_bytes(8))
653
 
    return s
 
559