~bzr-pqm/bzr/bzr.dev

70 by mbp at sourcefrog
Prepare for smart recursive add.
1
# Copyright (C) 2005 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
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
17
from os.path import dirname
18
19
import bzrlib.errors as errors
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
20
from bzrlib.inventory import InventoryEntry
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
21
from bzrlib.trace import mutter, note, warning
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
22
from bzrlib.errors import NotBranchError
23
from bzrlib.branch import Branch
1139 by Martin Pool
- merge in merge improvements and additional tests
24
from bzrlib.osutils import quotefn
70 by mbp at sourcefrog
Prepare for smart recursive add.
25
686 by Martin Pool
- glob expand add arguments on win32
26
def glob_expand_for_win32(file_list):
1185.23.2 by Aaron Bentley
win32 glob expansion fix from Belchenko
27
    if not file_list:
28
        return
686 by Martin Pool
- glob expand add arguments on win32
29
    import glob
30
    expanded_file_list = []
31
    for possible_glob in file_list:
32
        glob_files = glob.glob(possible_glob)
33
       
34
        if glob_files == []:
35
            # special case to let the normal code path handle
36
            # files that do not exists
37
            expanded_file_list.append(possible_glob)
38
        else:
39
            expanded_file_list += glob_files
40
    return expanded_file_list
41
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
42
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
43
def add_reporter_null(path, kind, entry):
44
    """Absorb add reports and do nothing."""
1092.1.30 by Robert Collins
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry
45
    pass
46
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
47
def add_reporter_print(path, kind, entry):
48
    """Print a line to stdout for each file that's added."""
1139 by Martin Pool
- merge in merge improvements and additional tests
49
    print "added", quotefn(path)
1092.1.30 by Robert Collins
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry
50
    
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
51
def _prepare_file_list(file_list):
52
    """Prepare a file list for use by smart_add_*."""
53
    import sys
54
    if sys.platform == 'win32':
55
        file_list = glob_expand_for_win32(file_list)
56
    if not file_list:
57
        file_list = ['.']
58
    file_list = list(file_list)
59
    return file_list
60
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
61
62
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
598 by Martin Pool
doc
63
    """Add files to version, optionally recursing into directories.
70 by mbp at sourcefrog
Prepare for smart recursive add.
64
65
    This is designed more towards DWIM for humans than API simplicity.
66
    For the specific behaviour see the help for cmd_add().
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
67
68
    Returns the number of files added.
70 by mbp at sourcefrog
Prepare for smart recursive add.
69
    """
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
70
    file_list = _prepare_file_list(file_list)
1442.1.64 by Robert Collins
Branch.open_containing now returns a tuple (Branch, relative-path).
71
    b = Branch.open_containing(file_list[0])[0]
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
72
    return smart_add_branch(b, file_list, recurse, reporter)
73
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
74
        
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
75
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
76
    """Add files to version, optionally recursing into directories.
77
78
    This is designed more towards DWIM for humans than API simplicity.
79
    For the specific behaviour see the help for cmd_add().
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
80
81
    This yields a sequence of (path, kind, file_id) for added files.
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
82
83
    Returns the number of files added.
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
84
    """
974 by Martin Pool
- start adding tests for commit in subdir
85
    import os
599 by Martin Pool
- better error reporting from smart_add
86
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
974 by Martin Pool
- start adding tests for commit in subdir
87
    import bzrlib.branch
599 by Martin Pool
- better error reporting from smart_add
88
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
89
    assert isinstance(recurse, bool)
90
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
91
    file_list = _prepare_file_list(file_list)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
92
    user_list = file_list[:]
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
93
    tree = branch.working_tree()
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
94
    inv = tree.read_working_inventory()
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
95
    count = 0
86 by mbp at sourcefrog
first cut at recursive add
96
70 by mbp at sourcefrog
Prepare for smart recursive add.
97
    for f in file_list:
1457.1.4 by Robert Collins
Branch.relpath has been moved to WorkingTree.relpath.
98
        rf = tree.relpath(f)
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
99
        af = branch.abspath(rf)
510 by Martin Pool
- fix add of files when standing in subdirectory
100
101
        kind = bzrlib.osutils.file_kind(af)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
102
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
103
        if not InventoryEntry.versionable_kind(kind):
599 by Martin Pool
- better error reporting from smart_add
104
            if f in user_list:
105
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
106
            else:
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
107
                warning("skipping %s (can't add file of kind '%s')", f, kind)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
108
                continue
109
800 by Martin Pool
Merge John's import-speedup branch:
110
        mutter("smart add of %r, abs=%r" % (f, af))
70 by mbp at sourcefrog
Prepare for smart recursive add.
111
        
112
        if bzrlib.branch.is_control_file(af):
599 by Martin Pool
- better error reporting from smart_add
113
            raise ForbiddenFileError('cannot add control file %s' % f)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
114
            
86 by mbp at sourcefrog
first cut at recursive add
115
        versioned = (inv.path2id(rf) != None)
116
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
117
        if kind == 'directory':
118
            try:
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
119
                sub_branch = Branch.open(af)
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
120
                sub_tree = True
121
            except NotBranchError:
122
                sub_tree = False
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
123
            except errors.UnsupportedFormatError:
124
                sub_tree = True
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
125
        else:
126
            sub_tree = False
127
91 by mbp at sourcefrog
special handling of root directory for recursive add
128
        if rf == '':
129
            mutter("branch root doesn't need to be added")
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
130
            sub_tree = False
91 by mbp at sourcefrog
special handling of root directory for recursive add
131
        elif versioned:
88 by mbp at sourcefrog
smart_add: no warning for already-added files
132
            mutter("%r is already versioned" % f)
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
133
        elif sub_tree:
134
            mutter("%r is a bzr tree" %f)
70 by mbp at sourcefrog
Prepare for smart recursive add.
135
        else:
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
136
            count += __add_one(branch, inv, rf, kind, reporter)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
137
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
138
        if kind == 'directory' and recurse and not sub_tree:
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
139
            for subf in os.listdir(af):
597 by Martin Pool
- tidy up add code
140
                subp = os.path.join(rf, subf)
103 by mbp at sourcefrog
Skip control directories in recursive add
141
                if subf == bzrlib.BZRDIR:
142
                    mutter("skip control directory %r" % subp)
143
                elif tree.is_ignored(subp):
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
144
                    mutter("skip ignored sub-file %r" % subp)
145
                else:
510 by Martin Pool
- fix add of files when standing in subdirectory
146
                    mutter("queue to add sub-file %r" % subp)
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
147
                    file_list.append(branch.abspath(subp))
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
148
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
149
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
150
    mutter('added %d entries', count)
151
    
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
152
    if count > 0:
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
153
        branch._write_inventory(inv)
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
154
155
    return count
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
156
157
def __add_one(branch, inv, path, kind, reporter):
158
    """Add a file or directory, automatically add unversioned parents."""
159
160
    # Nothing to do if path is already versioned.
161
    # This is safe from infinite recursion because the branch root is
162
    # always versioned.
163
    if inv.path2id(path) != None:
164
        return 0
165
166
    # add parent
167
    count = __add_one(branch, inv, dirname(path), 'directory', reporter)
168
169
    entry = inv.add_path(path, kind=kind)
170
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
171
    reporter(path, kind, entry)
172
173
    return count + 1