13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Helper functions for adding files to working trees."""
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from os.path import dirname
20
import bzrlib.errors as errors
21
from bzrlib.inventory import InventoryEntry
22
from bzrlib.trace import mutter, note, warning
23
from bzrlib.errors import NotBranchError
22
24
import bzrlib.osutils
23
from bzrlib.symbol_versioning import *
25
from bzrlib.workingtree import WorkingTree
28
def glob_expand_for_win32(file_list):
32
expanded_file_list = []
33
for possible_glob in file_list:
34
glob_files = glob.glob(possible_glob)
37
# special case to let the normal code path handle
38
# files that do not exists
39
expanded_file_list.append(possible_glob)
41
expanded_file_list += glob_files
42
return expanded_file_list
45
def _prepare_file_list(file_list):
46
"""Prepare a file list for use by smart_add_*."""
47
if sys.platform == 'win32':
48
file_list = glob_expand_for_win32(file_list)
51
file_list = list(file_list)
26
55
class AddAction(object):
27
56
"""A class which defines what action to take when adding a file."""
29
def __init__(self, to_file=None, should_print=None):
30
"""Initialize an action which prints added files to an output stream.
32
:param to_file: The stream to write into. This is expected to take
33
Unicode paths. If not supplied, it will default to ``sys.stdout``.
34
:param should_print: If False, printing will be suppressed.
58
def __init__(self, to_file=None, should_add=None, should_print=None):
36
59
self._to_file = to_file
37
60
if to_file is None:
38
61
self._to_file = sys.stdout
62
self.should_add = False
63
if should_add is not None:
64
self.should_add = should_add
39
65
self.should_print = False
40
66
if should_print is not None:
41
67
self.should_print = should_print
43
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
69
def __call__(self, inv, parent_ie, path, kind):
44
70
"""Add path to inventory.
46
72
The default action does nothing.
49
75
:param path: The FastPath being added
50
76
:param kind: The kind of the object being added.
79
self._add_to_inv(inv, parent_ie, path, kind)
52
80
if self.should_print:
53
self._to_file.write('adding %s\n' % _quote(path.raw_path))
57
class AddFromBaseAction(AddAction):
58
"""This class will try to extract file ids from another tree."""
60
def __init__(self, base_tree, base_path, to_file=None, should_print=None):
61
super(AddFromBaseAction, self).__init__(to_file=to_file,
62
should_print=should_print)
63
self.base_tree = base_tree
64
self.base_path = base_path
66
def __call__(self, inv, parent_ie, path, kind):
67
# Place the parent call
68
# Now check to see if we can extract an id for this file
69
file_id, base_path = self._get_base_file_id(path, parent_ie)
70
if file_id is not None:
72
self._to_file.write('adding %s w/ file id from %s\n'
73
% (path.raw_path, base_path))
81
self._print(inv, parent_ie, path, kind)
83
def _print(self, inv, parent_ie, path, kind):
84
"""Print a line to self._to_file for each file that would be added."""
85
self._to_file.write('added ')
86
self._to_file.write(bzrlib.osutils.quotefn(path.raw_path))
87
self._to_file.write('\n')
89
def _add_to_inv(self, inv, parent_ie, path, kind):
90
"""Add each file to the given inventory. Produce no output."""
91
if parent_ie is not None:
92
entry = bzrlib.inventory.make_entry(
93
kind, bzrlib.osutils.basename(path.raw_path), parent_ie.file_id)
75
# we aren't doing anything special, so let the default
77
file_id = super(AddFromBaseAction, self).__call__(
78
inv, parent_ie, path, kind)
81
def _get_base_file_id(self, path, parent_ie):
82
"""Look for a file id in the base branch.
84
First, if the base tree has the parent directory,
85
we look for a file with the same name in that directory.
86
Else, we look for an entry in the base tree with the same path.
89
if (parent_ie.file_id in self.base_tree):
90
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
91
base_child_ie = base_parent_ie.children.get(path.base_path)
92
if base_child_ie is not None:
93
return (base_child_ie.file_id,
94
self.base_tree.id2path(base_child_ie.file_id))
95
full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
96
# This may return None, but it is our last attempt
97
return self.base_tree.path2id(full_base_path), full_base_path
96
entry = inv.add_path(path.raw_path, kind=kind)
97
# mutter("added %r kind %r file_id={%s}", path, kind, entry.file_id)
100
100
# TODO: jam 20050105 These could be used for compatibility
102
102
# one which exists at the time they are called, so they
103
103
# don't work for the test suite.
105
add_action_add = AddAction()
106
add_action_null = add_action_add
107
add_action_add_and_print = AddAction(should_print=True)
108
add_action_print = add_action_add_and_print
105
add_action_null = AddAction()
106
add_action_add = AddAction(should_add=True)
107
add_action_print = AddAction(should_print=True)
108
add_action_add_and_print = AddAction(should_add=True, should_print=True)
111
def smart_add(file_list, recurse=True, action=None):
112
"""Add files to version, optionally recursing into directories.
114
This is designed more towards DWIM for humans than API simplicity.
115
For the specific behaviour see the help for cmd_add().
117
Returns the number of files added.
119
file_list = _prepare_file_list(file_list)
120
tree = WorkingTree.open_containing(file_list[0])[0]
121
return smart_add_tree(tree, file_list, recurse, action=action)
124
class FastPath(object):
125
"""A path object with fast accessors for things like basename."""
127
__slots__ = ['raw_path', 'base_path']
129
def __init__(self, path, base_path=None):
130
"""Construct a FastPath from path."""
131
if base_path is None:
132
self.base_path = bzrlib.osutils.basename(path)
134
self.base_path = base_path
138
def smart_add_tree(tree, file_list, recurse=True, action=None):
139
"""Add files to version, optionally recursing into directories.
141
This is designed more towards DWIM for humans than API simplicity.
142
For the specific behaviour see the help for cmd_add().
144
This calls reporter with each (path, kind, file_id) of added files.
146
Returns the number of files added.
149
from bzrlib.errors import BadFileKindError, ForbiddenFileError
150
assert isinstance(recurse, bool)
152
action = AddAction(should_add=True)
154
prepared_list = _prepare_file_list(file_list)
155
mutter("smart add of %r, originally %r", prepared_list, file_list)
156
inv = tree.read_working_inventory()
161
# validate user file paths and convert all paths to tree
162
# relative : its cheaper to make a tree relative path an abspath
163
# than to convert an abspath to tree relative.
164
for filepath in prepared_list:
165
rf = FastPath(tree.relpath(filepath))
166
# validate user parameters. Our recursive code avoids adding new files
167
# that need such validation
168
if tree.is_control_filename(rf.raw_path):
169
raise ForbiddenFileError('cannot add control file %s' % filepath)
171
abspath = tree.abspath(rf.raw_path)
172
kind = bzrlib.osutils.file_kind(abspath)
173
if kind == 'directory':
174
# schedule the dir for later
175
dirs_to_add.append((rf, None))
177
if not InventoryEntry.versionable_kind(kind):
178
raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
179
# we dont have a parent ie known yet.: use the relatively slower inventory
181
versioned = inv.has_filename(rf.raw_path)
184
added.extend(__add_one(tree, inv, None, rf, kind, action))
186
# this will eventually be *just* directories, right now it starts off with
188
for directory, parent_ie in dirs_to_add:
189
# directory is tree-relative
190
abspath = tree.abspath(directory.raw_path)
192
# find the kind of the path being added.
193
kind = bzrlib.osutils.file_kind(abspath)
195
if not InventoryEntry.versionable_kind(kind):
196
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
199
if parent_ie is not None:
200
versioned = directory.base_path in parent_ie.children
202
# without the parent ie, use the relatively slower inventory
204
versioned = inv.has_filename(directory.raw_path)
206
if kind == 'directory':
208
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
210
except NotBranchError:
212
except errors.UnsupportedFormatError:
217
if directory.raw_path == '':
218
# mutter("tree root doesn't need to be added")
222
# mutter("%r is already versioned", abspath)
224
mutter("%r is a nested bzr tree", abspath)
226
added.extend(__add_one(tree, inv, parent_ie, directory, kind, action))
228
if kind == 'directory' and recurse and not sub_tree:
230
if parent_ie is not None:
232
this_ie = parent_ie.children[directory.base_path]
234
# without the parent ie, use the relatively slower inventory
236
this_id = inv.path2id(directory.raw_path)
240
this_ie = inv[this_id]
244
for subf in os.listdir(abspath):
245
# here we could use TreeDirectory rather than
246
# string concatenation.
247
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
248
# TODO: is_control_filename is very slow. Make it faster.
249
# TreeDirectory.is_control_filename could also make this
250
# faster - its impossible for a non root dir to have a
252
if tree.is_control_filename(subp):
253
mutter("skip control directory %r", subp)
255
# ignore while selecting files - if we globbed in the
256
# outer loop we would ignore user files.
257
ignore_glob = tree.is_ignored(subp)
258
if ignore_glob is not None:
259
# mutter("skip ignored sub-file %r", subp)
260
if ignore_glob not in ignored:
261
ignored[ignore_glob] = []
262
ignored[ignore_glob].append(subp)
264
#mutter("queue to add sub-file %r", subp)
265
dirs_to_add.append((FastPath(subp, subf), this_ie))
268
tree._write_inventory(inv)
269
return added, ignored
272
def __add_one(tree, inv, parent_ie, path, kind, action):
273
"""Add a new entry to the inventory and automatically add unversioned parents.
275
Actual adding of the entry is delegated to the action callback.
277
:param inv: Inventory which will receive the new entry.
278
:param parent_ie: Parent inventory entry if known, or None. If
279
None, the parent is looked up by name and used if present, otherwise
280
it is recursively added.
281
:param kind: Kind of new entry (file, directory, etc)
282
:param action: callback(inv, parent_ie, path, kind); return ignored.
283
:returns: A list of paths which have been added.
286
# Nothing to do if path is already versioned.
287
# This is safe from infinite recursion because the tree root is
289
if parent_ie is not None:
290
# we have a parent ie already
293
# slower but does not need parent_ie
294
if inv.has_filename(path.raw_path):
296
# its really not there : add the parent
297
# note that the dirname use leads to some extra str copying etc but as
298
# there are a limited number of dirs we can be nested under, it should
299
# generally find it very fast and not recurse after that.
300
added = __add_one(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
301
parent_id = inv.path2id(dirname(path.raw_path))
302
if parent_id is not None:
303
parent_ie = inv[inv.path2id(dirname(path.raw_path))]
306
action(inv, parent_ie, path, kind)
308
return added + [path.raw_path]
added
removed
bzrlib/add.py
