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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from os.path import dirname
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Helper functions for adding files to working trees."""
22
import bzrlib.errors as errors
23
from bzrlib.inventory import InventoryEntry
24
from bzrlib.trace import mutter, note, warning
25
from bzrlib.errors import NotBranchError
26
22
import bzrlib.osutils
27
from bzrlib.workingtree import WorkingTree
30
def glob_expand_for_win32(file_list):
34
expanded_file_list = []
35
for possible_glob in file_list:
36
glob_files = glob.glob(possible_glob)
39
# special case to let the normal code path handle
40
# files that do not exists
41
expanded_file_list.append(possible_glob)
43
expanded_file_list += glob_files
44
return expanded_file_list
47
def _prepare_file_list(file_list):
48
"""Prepare a file list for use by smart_add_*."""
49
if sys.platform == 'win32':
50
file_list = glob_expand_for_win32(file_list)
53
file_list = list(file_list)
23
from bzrlib.symbol_versioning import *
57
26
class AddAction(object):
58
27
"""A class which defines what action to take when adding a file."""
60
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.
61
36
self._to_file = to_file
62
37
if to_file is None:
63
38
self._to_file = sys.stdout
74
49
:param path: The FastPath being added
75
50
:param kind: The kind of the object being added.
77
if not self.should_print:
79
self._to_file.write('added %s\n' % _quote(path.raw_path))
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))
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
82
100
# TODO: jam 20050105 These could be used for compatibility
88
106
add_action_null = add_action_add
89
107
add_action_add_and_print = AddAction(should_print=True)
90
108
add_action_print = add_action_add_and_print
93
def smart_add(file_list, recurse=True, action=None, save=True):
94
"""Add files to version, optionally recursing into directories.
96
This is designed more towards DWIM for humans than API simplicity.
97
For the specific behaviour see the help for cmd_add().
99
Returns the number of files added.
100
Please see smart_add_tree for more detail.
102
file_list = _prepare_file_list(file_list)
103
tree = WorkingTree.open_containing(file_list[0])[0]
104
return smart_add_tree(tree, file_list, recurse, action=action)
107
class FastPath(object):
108
"""A path object with fast accessors for things like basename."""
110
__slots__ = ['raw_path', 'base_path']
112
def __init__(self, path, base_path=None):
113
"""Construct a FastPath from path."""
114
if base_path is None:
115
self.base_path = bzrlib.osutils.basename(path)
117
self.base_path = base_path
121
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
122
"""Add files to version, optionally recursing into directories.
124
This is designed more towards DWIM for humans than API simplicity.
125
For the specific behaviour see the help for cmd_add().
127
This calls reporter with each (path, kind, file_id) of added files.
129
Returns the number of files added.
131
:param save: Save the inventory after completing the adds. If False this
132
provides dry-run functionality by doing the add and not saving the
133
inventory. Note that the modified inventory is left in place, allowing
134
further dry-run tasks to take place. To restore the original inventory
135
call tree.read_working_inventory().
137
assert isinstance(recurse, bool)
141
prepared_list = _prepare_file_list(file_list)
142
mutter("smart add of %r, originally %r", prepared_list, file_list)
143
inv = tree.read_working_inventory()
149
# validate user file paths and convert all paths to tree
150
# relative : its cheaper to make a tree relative path an abspath
151
# than to convert an abspath to tree relative.
152
for filepath in prepared_list:
153
rf = FastPath(tree.relpath(filepath))
154
# validate user parameters. Our recursive code avoids adding new files
155
# that need such validation
156
if tree.is_control_filename(rf.raw_path):
157
raise errors.ForbiddenControlFileError(filename=rf)
159
abspath = tree.abspath(rf.raw_path)
160
kind = bzrlib.osutils.file_kind(abspath)
161
if kind == 'directory':
162
# schedule the dir for scanning
163
user_dirs.add(rf.raw_path)
165
if not InventoryEntry.versionable_kind(kind):
166
raise errors.BadFileKindError(filename=abspath, kind=kind)
167
# ensure the named path is added, so that ignore rules in the later directory
169
# we dont have a parent ie known yet.: use the relatively slower inventory
171
versioned = inv.has_filename(rf.raw_path)
174
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
177
# no need to walk any directories at all.
178
if len(added) > 0 and save:
179
tree._write_inventory(inv)
180
return added, ignored
182
# only walk the minimal parents needed: we have user_dirs to override
185
for path in sorted(user_dirs):
186
if (prev_dir is None or not
187
bzrlib.osutils.is_inside_or_parent_of_any([prev_dir], path)):
188
dirs_to_add.append((rf, None))
191
# this will eventually be *just* directories, right now it starts off with
193
for directory, parent_ie in dirs_to_add:
194
# directory is tree-relative
195
abspath = tree.abspath(directory.raw_path)
197
# get the contents of this directory.
199
# find the kind of the path being added.
200
kind = bzrlib.osutils.file_kind(abspath)
202
if not InventoryEntry.versionable_kind(kind):
203
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
206
if parent_ie is not None:
207
versioned = directory.base_path in parent_ie.children
209
# without the parent ie, use the relatively slower inventory
211
versioned = inv.has_filename(directory.raw_path)
213
if kind == 'directory':
215
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
217
except NotBranchError:
219
except errors.UnsupportedFormatError:
224
if directory.raw_path == '':
225
# mutter("tree root doesn't need to be added")
229
# mutter("%r is already versioned", abspath)
231
mutter("%r is a nested bzr tree", abspath)
233
__add_one(tree, inv, parent_ie, directory, kind, action)
234
added.append(directory.raw_path)
236
if kind == 'directory' and not sub_tree:
237
if parent_ie is not None:
239
this_ie = parent_ie.children[directory.base_path]
241
# without the parent ie, use the relatively slower inventory
243
this_id = inv.path2id(directory.raw_path)
247
this_ie = inv[this_id]
249
for subf in os.listdir(abspath):
250
# here we could use TreeDirectory rather than
251
# string concatenation.
252
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
253
# TODO: is_control_filename is very slow. Make it faster.
254
# TreeDirectory.is_control_filename could also make this
255
# faster - its impossible for a non root dir to have a
257
if tree.is_control_filename(subp):
258
mutter("skip control directory %r", subp)
259
elif subf in this_ie.children:
260
# recurse into this already versioned subdir.
261
dirs_to_add.append((FastPath(subp, subf), this_ie))
263
# user selection overrides ignoes
264
# ignore while selecting files - if we globbed in the
265
# outer loop we would ignore user files.
266
ignore_glob = tree.is_ignored(subp)
267
if ignore_glob is not None:
268
# mutter("skip ignored sub-file %r", subp)
269
if ignore_glob not in ignored:
270
ignored[ignore_glob] = []
271
ignored[ignore_glob].append(subp)
273
#mutter("queue to add sub-file %r", subp)
274
dirs_to_add.append((FastPath(subp, subf), this_ie))
276
if len(added) > 0 and save:
277
tree._write_inventory(inv)
278
return added, ignored
281
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
282
"""Add a new entry to the inventory and automatically add unversioned parents.
284
:param inv: Inventory which will receive the new entry.
285
:param parent_ie: Parent inventory entry if known, or None. If
286
None, the parent is looked up by name and used if present, otherwise
287
it is recursively added.
288
:param kind: Kind of new entry (file, directory, etc)
289
:param action: callback(inv, parent_ie, path, kind); return ignored.
290
:returns: A list of paths which have been added.
292
# Nothing to do if path is already versioned.
293
# This is safe from infinite recursion because the tree root is
295
if parent_ie is not None:
296
# we have a parent ie already
299
# slower but does not need parent_ie
300
if inv.has_filename(path.raw_path):
302
# its really not there : add the parent
303
# note that the dirname use leads to some extra str copying etc but as
304
# there are a limited number of dirs we can be nested under, it should
305
# generally find it very fast and not recurse after that.
306
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
307
parent_id = inv.path2id(dirname(path.raw_path))
308
parent_ie = inv[parent_id]
309
__add_one(tree, inv, parent_ie, path, kind, action)
310
return added + [path.raw_path]
313
def __add_one(tree, inv, parent_ie, path, kind, action):
314
"""Add a new entry to the inventory.
316
:param inv: Inventory which will receive the new entry.
317
:param parent_ie: Parent inventory entry.
318
:param kind: Kind of new entry (file, directory, etc)
319
:param action: callback(inv, parent_ie, path, kind); return ignored.
322
action(inv, parent_ie, path, kind)
323
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id)
added
removed
bzrlib/add.py
