~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-28 02:40:49 UTC
  • Revision ID: mbp@sourcefrog.net-20050328024049-9e1d1fea5e834ae7
Make fields wider in 'bzr info' output to accomodate big trees

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
from inventory import InventoryEntry, Inventory
29
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
30
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
 
     joinpath, sha_string, file_kind, local_time_offset, appendpath
 
31
     joinpath, sha_string, file_kind, local_time_offset
32
32
from store import ImmutableStore
33
33
from revision import Revision
34
 
from errors import bailout, BzrError
 
34
from errors import bailout
35
35
from textui import show_status
36
36
from diff import diff_trees
37
37
 
47
47
 
48
48
    Basically we keep looking up until we find the control directory or
49
49
    run into the root."""
50
 
    if f == None:
 
50
    if f is None:
51
51
        f = os.getcwd()
52
52
    elif hasattr(os.path, 'realpath'):
53
53
        f = os.path.realpath(f)
56
56
 
57
57
    orig_f = f
58
58
 
 
59
    last_f = f
59
60
    while True:
60
61
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
61
62
            return f
62
63
        head, tail = os.path.split(f)
63
64
        if head == f:
64
65
            # reached the root, whatever that may be
65
 
            raise BzrError('%r is not in a branch' % orig_f)
 
66
            bailout('%r is not in a branch' % orig_f)
66
67
        f = head
67
68
    
68
69
 
73
74
class Branch:
74
75
    """Branch holding a history of revisions.
75
76
 
76
 
    TODO: Perhaps use different stores for different classes of object,
 
77
    :todo: Perhaps use different stores for different classes of object,
77
78
           so that we can keep track of how much space each one uses,
78
79
           or garbage-collect them.
79
80
 
80
 
    TODO: Add a RemoteBranch subclass.  For the basic case of read-only
 
81
    :todo: Add a RemoteBranch subclass.  For the basic case of read-only
81
82
           HTTP access this should be very easy by, 
82
83
           just redirecting controlfile access into HTTP requests.
83
84
           We would need a RemoteStore working similarly.
84
85
 
85
 
    TODO: Keep the on-disk branch locked while the object exists.
 
86
    :todo: Keep the on-disk branch locked while the object exists.
86
87
 
87
 
    TODO: mkdir() method.
 
88
    :todo: mkdir() method.
88
89
    """
89
90
    def __init__(self, base, init=False, find_root=True):
90
91
        """Create new branch object at a particular location.
91
92
 
92
 
        base -- Base directory for the branch.
 
93
        :param base: Base directory for the branch.
93
94
        
94
 
        init -- If True, create new control files in a previously
 
95
        :param init: If True, create new control files in a previously
95
96
             unversioned directory.  If False, the branch must already
96
97
             be versioned.
97
98
 
98
 
        find_root -- If true and init is false, find the root of the
 
99
        :param find_root: If true and init is false, find the root of the
99
100
             existing branch containing base.
100
101
 
101
102
        In the test suite, creation of new trees is tested using the
152
153
 
153
154
 
154
155
    def controlfile(self, file_or_path, mode='r'):
155
 
        """Open a control file for this branch.
156
 
 
157
 
        There are two classes of file in the control directory: text
158
 
        and binary.  binary files are untranslated byte streams.  Text
159
 
        control files are stored with Unix newlines and in UTF-8, even
160
 
        if the platform or locale defaults are different.
161
 
        """
162
 
 
163
 
        fn = self.controlfilename(file_or_path)
164
 
 
165
 
        if mode == 'rb' or mode == 'wb':
166
 
            return file(fn, mode)
167
 
        elif mode == 'r' or mode == 'w':
168
 
            # open in binary mode anyhow so there's no newline translation;
169
 
            # codecs uses line buffering by default; don't want that.
170
 
            import codecs
171
 
            return codecs.open(fn, mode + 'b', 'utf-8',
172
 
                               buffering=60000)
173
 
        else:
174
 
            raise BzrError("invalid controlfile mode %r" % mode)
175
 
 
 
156
        """Open a control file for this branch"""
 
157
        return file(self.controlfilename(file_or_path), mode)
176
158
 
177
159
 
178
160
    def _make_control(self):
197
179
 
198
180
        In the future, we might need different in-memory Branch
199
181
        classes to support downlevel branches.  But not yet.
200
 
        """
201
 
        # This ignores newlines so that we can open branches created
202
 
        # on Windows from Linux and so on.  I think it might be better
203
 
        # to always make all internal files in unix format.
204
 
        fmt = self.controlfile('branch-format', 'r').read()
205
 
        fmt.replace('\r\n', '')
 
182
        """        
 
183
        # read in binary mode to detect newline wierdness.
 
184
        fmt = self.controlfile('branch-format', 'rb').read()
206
185
        if fmt != BZR_BRANCH_FORMAT:
207
186
            bailout('sorry, branch format %r not supported' % fmt,
208
187
                    ['use a different bzr version',
212
191
    def read_working_inventory(self):
213
192
        """Read the working inventory."""
214
193
        before = time.time()
215
 
        # ElementTree does its own conversion from UTF-8, so open in
216
 
        # binary.
217
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
194
        inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
218
195
        mutter("loaded inventory of %d items in %f"
219
196
               % (len(inv), time.time() - before))
220
197
        return inv
229
206
        ## TODO: factor out to atomicfile?  is rename safe on windows?
230
207
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
231
208
        tmpfname = self.controlfilename('inventory.tmp')
232
 
        tmpf = file(tmpfname, 'wb')
 
209
        tmpf = file(tmpfname, 'w')
233
210
        inv.write_xml(tmpf)
234
211
        tmpf.close()
235
 
        inv_fname = self.controlfilename('inventory')
236
 
        if sys.platform == 'win32':
237
 
            os.remove(inv_fname)
238
 
        os.rename(tmpfname, inv_fname)
 
212
        os.rename(tmpfname, self.controlfilename('inventory'))
239
213
        mutter('wrote working inventory')
240
214
 
241
215
 
246
220
    def add(self, files, verbose=False):
247
221
        """Make files versioned.
248
222
 
249
 
        Note that the command line normally calls smart_add instead.
250
 
 
251
223
        This puts the files in the Added state, so that they will be
252
224
        recorded by the next commit.
253
225
 
254
 
        TODO: Perhaps have an option to add the ids even if the files do
 
226
        :todo: Perhaps have an option to add the ids even if the files do
255
227
               not (yet) exist.
256
228
 
257
 
        TODO: Perhaps return the ids of the files?  But then again it
 
229
        :todo: Perhaps return the ids of the files?  But then again it
258
230
               is easy to retrieve them if they're needed.
259
231
 
260
 
        TODO: Option to specify file id.
 
232
        :todo: Option to specify file id.
261
233
 
262
 
        TODO: Adding a directory should optionally recurse down and
 
234
        :todo: Adding a directory should optionally recurse down and
263
235
               add all non-ignored children.  Perhaps do that in a
264
236
               higher-level method.
265
237
 
323
295
        self._write_inventory(inv)
324
296
 
325
297
 
326
 
    def print_file(self, file, revno):
327
 
        """Print `file` to stdout."""
328
 
        tree = self.revision_tree(self.lookup_revision(revno))
329
 
        # use inventory as it was in that revision
330
 
        file_id = tree.inventory.path2id(file)
331
 
        if not file_id:
332
 
            bailout("%r is not present in revision %d" % (file, revno))
333
 
        tree.print_file(file_id)
334
 
        
335
298
 
336
299
    def remove(self, files, verbose=False):
337
300
        """Mark nominated files for removal from the inventory.
338
301
 
339
302
        This does not remove their text.  This does not run on 
340
303
 
341
 
        TODO: Refuse to remove modified files unless --force is given?
 
304
        :todo: Refuse to remove modified files unless --force is given?
342
305
 
343
306
        >>> b = ScratchBranch(files=['foo'])
344
307
        >>> b.add('foo')
362
325
        >>> b.working_tree().has_filename('foo') 
363
326
        True
364
327
 
365
 
        TODO: Do something useful with directories.
 
328
        :todo: Do something useful with directories.
366
329
 
367
 
        TODO: Should this remove the text or not?  Tough call; not
 
330
        :todo: Should this remove the text or not?  Tough call; not
368
331
        removing may be useful and the user can just use use rm, and
369
332
        is the opposite of add.  Removing it is consistent with most
370
333
        other tools.  Maybe an option.
434
397
        be robust against files disappearing, moving, etc.  So the
435
398
        whole thing is a bit hard.
436
399
 
437
 
        timestamp -- if not None, seconds-since-epoch for a
 
400
        :param timestamp: if not None, seconds-since-epoch for a
438
401
             postdated/predated commit.
439
402
        """
440
403
 
578
541
        ## TODO: Also calculate and store the inventory SHA1
579
542
        mutter("committing patch r%d" % (self.revno() + 1))
580
543
 
 
544
        mutter("append to revision-history")
 
545
        f = self.controlfile('revision-history', 'at')
 
546
        f.write(rev_id + '\n')
 
547
        f.close()
581
548
 
582
 
        self.append_revision(rev_id)
583
 
        
584
549
        if verbose:
585
550
            note("commited r%d" % self.revno())
586
551
 
587
552
 
588
 
    def append_revision(self, revision_id):
589
 
        mutter("add {%s} to revision-history" % revision_id)
590
 
        rev_history = self.revision_history()
591
 
 
592
 
        tmprhname = self.controlfilename('revision-history.tmp')
593
 
        rhname = self.controlfilename('revision-history')
594
 
        
595
 
        f = file(tmprhname, 'wt')
596
 
        rev_history.append(revision_id)
597
 
        f.write('\n'.join(rev_history))
598
 
        f.write('\n')
599
 
        f.close()
600
 
 
601
 
        if sys.platform == 'win32':
602
 
            os.remove(rhname)
603
 
        os.rename(tmprhname, rhname)
604
 
        
605
 
 
606
 
 
607
553
    def get_revision(self, revision_id):
608
554
        """Return the Revision object for a named revision"""
609
555
        r = Revision.read_xml(self.revision_store[revision_id])
614
560
    def get_inventory(self, inventory_id):
615
561
        """Get Inventory object by hash.
616
562
 
617
 
        TODO: Perhaps for this and similar methods, take a revision
 
563
        :todo: Perhaps for this and similar methods, take a revision
618
564
               parameter which can be either an integer revno or a
619
565
               string hash."""
620
566
        i = Inventory.read_xml(self.inventory_store[inventory_id])
635
581
        >>> ScratchBranch().revision_history()
636
582
        []
637
583
        """
638
 
        return [chomp(l) for l in self.controlfile('revision-history', 'r').readlines()]
 
584
        return [chomp(l) for l in self.controlfile('revision-history').readlines()]
639
585
 
640
586
 
641
587
    def revno(self):
663
609
        ph = self.revision_history()
664
610
        if ph:
665
611
            return ph[-1]
666
 
        else:
667
 
            return None
668
 
        
 
612
 
669
613
 
670
614
    def lookup_revision(self, revno):
671
615
        """Return revision hash for revision number."""
676
620
            # list is 0-based; revisions are 1-based
677
621
            return self.revision_history()[revno-1]
678
622
        except IndexError:
679
 
            raise BzrError("no such revision %s" % revno)
 
623
            bailout("no such revision %s" % revno)
680
624
 
681
625
 
682
626
    def revision_tree(self, revision_id):
720
664
 
721
665
 
722
666
 
723
 
    def write_log(self, show_timezone='original', verbose=False):
 
667
    def write_log(self, show_timezone='original'):
724
668
        """Write out human-readable log of commits to this branch
725
669
 
726
 
        utc -- If true, show dates in universal time, not local time."""
 
670
        :param utc: If true, show dates in universal time, not local time."""
727
671
        ## TODO: Option to choose either original, utc or local timezone
728
672
        revno = 1
729
673
        precursor = None
748
692
                for l in rev.message.split('\n'):
749
693
                    print '  ' + l
750
694
 
751
 
            if verbose == True and precursor != None:
752
 
                print 'changed files:'
753
 
                tree = self.revision_tree(p)
754
 
                prevtree = self.revision_tree(precursor)
755
 
                
756
 
                for file_state, fid, old_name, new_name, kind in \
757
 
                                        diff_trees(prevtree, tree, ):
758
 
                    if file_state == 'A' or file_state == 'M':
759
 
                        show_status(file_state, kind, new_name)
760
 
                    elif file_state == 'D':
761
 
                        show_status(file_state, kind, old_name)
762
 
                    elif file_state == 'R':
763
 
                        show_status(file_state, kind,
764
 
                            old_name + ' => ' + new_name)
765
 
                
766
695
            revno += 1
767
696
            precursor = p
768
697
 
769
698
 
770
 
    def rename_one(self, from_rel, to_rel):
771
 
        tree = self.working_tree()
772
 
        inv = tree.inventory
773
 
        if not tree.has_filename(from_rel):
774
 
            bailout("can't rename: old working file %r does not exist" % from_rel)
775
 
        if tree.has_filename(to_rel):
776
 
            bailout("can't rename: new working file %r already exists" % to_rel)
777
 
            
778
 
        file_id = inv.path2id(from_rel)
779
 
        if file_id == None:
780
 
            bailout("can't rename: old name %r is not versioned" % from_rel)
781
 
 
782
 
        if inv.path2id(to_rel):
783
 
            bailout("can't rename: new name %r is already versioned" % to_rel)
784
 
 
785
 
        to_dir, to_tail = os.path.split(to_rel)
786
 
        to_dir_id = inv.path2id(to_dir)
787
 
        if to_dir_id == None and to_dir != '':
788
 
            bailout("can't determine destination directory id for %r" % to_dir)
789
 
 
790
 
        mutter("rename_one:")
791
 
        mutter("  file_id    {%s}" % file_id)
792
 
        mutter("  from_rel   %r" % from_rel)
793
 
        mutter("  to_rel     %r" % to_rel)
794
 
        mutter("  to_dir     %r" % to_dir)
795
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
796
 
            
797
 
        inv.rename(file_id, to_dir_id, to_tail)
798
 
 
799
 
        print "%s => %s" % (from_rel, to_rel)
800
 
        
801
 
        from_abs = self.abspath(from_rel)
802
 
        to_abs = self.abspath(to_rel)
803
 
        try:
804
 
            os.rename(from_abs, to_abs)
805
 
        except OSError, e:
806
 
            bailout("failed to rename %r to %r: %s"
807
 
                    % (from_abs, to_abs, e[1]),
808
 
                    ["rename rolled back"])
809
 
 
810
 
        self._write_inventory(inv)
811
 
            
812
 
 
813
 
 
814
 
    def move(self, from_paths, to_name):
815
 
        """Rename files.
816
 
 
817
 
        to_name must exist as a versioned directory.
818
 
 
819
 
        If to_name exists and is a directory, the files are moved into
820
 
        it, keeping their old names.  If it is a directory, 
821
 
 
822
 
        Note that to_name is only the last component of the new name;
823
 
        this doesn't change the directory.
824
 
        """
825
 
        ## TODO: Option to move IDs only
826
 
        assert not isinstance(from_paths, basestring)
827
 
        tree = self.working_tree()
828
 
        inv = tree.inventory
829
 
        to_abs = self.abspath(to_name)
830
 
        if not isdir(to_abs):
831
 
            bailout("destination %r is not a directory" % to_abs)
832
 
        if not tree.has_filename(to_name):
833
 
            bailout("destination %r not in working directory" % to_abs)
834
 
        to_dir_id = inv.path2id(to_name)
835
 
        if to_dir_id == None and to_name != '':
836
 
            bailout("destination %r is not a versioned directory" % to_name)
837
 
        to_dir_ie = inv[to_dir_id]
838
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
839
 
            bailout("destination %r is not a directory" % to_abs)
840
 
 
841
 
        to_idpath = Set(inv.get_idpath(to_dir_id))
842
 
 
843
 
        for f in from_paths:
844
 
            if not tree.has_filename(f):
845
 
                bailout("%r does not exist in working tree" % f)
846
 
            f_id = inv.path2id(f)
847
 
            if f_id == None:
848
 
                bailout("%r is not versioned" % f)
849
 
            name_tail = splitpath(f)[-1]
850
 
            dest_path = appendpath(to_name, name_tail)
851
 
            if tree.has_filename(dest_path):
852
 
                bailout("destination %r already exists" % dest_path)
853
 
            if f_id in to_idpath:
854
 
                bailout("can't move %r to a subdirectory of itself" % f)
855
 
 
856
 
        # OK, so there's a race here, it's possible that someone will
857
 
        # create a file in this interval and then the rename might be
858
 
        # left half-done.  But we should have caught most problems.
859
 
 
860
 
        for f in from_paths:
861
 
            name_tail = splitpath(f)[-1]
862
 
            dest_path = appendpath(to_name, name_tail)
863
 
            print "%s => %s" % (f, dest_path)
864
 
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
865
 
            try:
866
 
                os.rename(self.abspath(f), self.abspath(dest_path))
867
 
            except OSError, e:
868
 
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
869
 
                        ["rename rolled back"])
870
 
 
871
 
        self._write_inventory(inv)
872
 
 
873
 
 
874
 
 
875
 
    def show_status(self, show_all=False):
 
699
 
 
700
    def show_status(branch, show_all=False):
876
701
        """Display single-line status for non-ignored working files.
877
702
 
878
703
        The list is show sorted in order by file name.
889
714
        >>> b.show_status()
890
715
        D       foo
891
716
        
892
 
        TODO: Get state for single files.
 
717
 
 
718
        :todo: Get state for single files.
 
719
 
 
720
        :todo: Perhaps show a slash at the end of directory names.        
 
721
 
893
722
        """
894
723
 
895
724
        # We have to build everything into a list first so that it can
901
730
        # Interesting case: the old ID for a file has been removed,
902
731
        # but a new file has been created under that name.
903
732
 
904
 
        old = self.basis_tree()
905
 
        new = self.working_tree()
 
733
        old = branch.basis_tree()
 
734
        old_inv = old.inventory
 
735
        new = branch.working_tree()
 
736
        new_inv = new.inventory
906
737
 
907
738
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
908
739
            if fs == 'R':
921
752
            elif fs == '?':
922
753
                show_status(fs, kind, newname)
923
754
            else:
924
 
                bailout("weird file state %r" % ((fs, fid),))
 
755
                bailout("wierd file state %r" % ((fs, fid),))
925
756
                
926
757
 
927
758
 
953
784
 
954
785
    def __del__(self):
955
786
        """Destroy the test branch, removing the scratch directory."""
956
 
        try:
957
 
            shutil.rmtree(self.base)
958
 
        except OSError:
959
 
            # Work around for shutil.rmtree failing on Windows when
960
 
            # readonly files are encountered
961
 
            for root, dirs, files in os.walk(self.base, topdown=False):
962
 
                for name in files:
963
 
                    os.chmod(os.path.join(root, name), 0700)
964
 
            shutil.rmtree(self.base)
 
787
        shutil.rmtree(self.base)
965
788
 
966
789
    
967
790
 
1000
823
    idx = name.rfind('/')
1001
824
    if idx != -1:
1002
825
        name = name[idx+1 : ]
1003
 
    idx = name.rfind('\\')
1004
 
    if idx != -1:
1005
 
        name = name[idx+1 : ]
1006
826
 
1007
827
    name = name.lstrip('.')
1008
828
 
1009
829
    s = hexlify(rand_bytes(8))
1010
830
    return '-'.join((name, compact_date(time.time()), s))
 
831
 
 
832