1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
19
from os.path import dirname
19
22
import bzrlib.errors as errors
20
23
from bzrlib.inventory import InventoryEntry
54
def add_action_null(inv, parent_ie, path, kind):
55
"""Absorb add actions and do nothing."""
59
def add_action_print(inv, parent_ie, path, kind):
60
"""Print a line to stdout for each file that would be added."""
61
print "added", bzrlib.osutils.quotefn(path)
64
def add_action_add(inv, parent_ie, path, kind):
65
"""Add each file to the given inventory. Produce no output."""
66
if parent_ie is not None:
67
entry = bzrlib.inventory.make_entry(
68
kind, bzrlib.osutils.basename(path), parent_ie.file_id)
71
entry = inv.add_path(path, kind=kind)
72
# mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
75
def add_action_add_and_print(inv, parent_ie, path, kind):
76
"""Add each file to the given inventory, and print a line to stdout."""
77
add_action_add(inv, parent_ie, path, kind)
78
add_action_print(inv, parent_ie, path, kind)
81
def smart_add(file_list, recurse=True, action=add_action_add):
57
class AddAction(object):
58
"""A class which defines what action to take when adding a file."""
60
def __init__(self, to_file=None, should_print=None):
61
self._to_file = to_file
63
self._to_file = sys.stdout
64
self.should_print = False
65
if should_print is not None:
66
self.should_print = should_print
68
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
69
"""Add path to inventory.
71
The default action does nothing.
73
:param inv: The inventory we are working with.
74
:param path: The FastPath being added
75
: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))
82
# TODO: jam 20050105 These could be used for compatibility
83
# however, they bind against the current stdout, not the
84
# one which exists at the time they are called, so they
85
# don't work for the test suite.
87
add_action_add = AddAction()
88
add_action_null = add_action_add
89
add_action_add_and_print = AddAction(should_print=True)
90
add_action_print = add_action_add_and_print
93
def smart_add(file_list, recurse=True, action=None, save=True):
82
94
"""Add files to version, optionally recursing into directories.
84
96
This is designed more towards DWIM for humans than API simplicity.
85
97
For the specific behaviour see the help for cmd_add().
87
99
Returns the number of files added.
100
Please see smart_add_tree for more detail.
89
102
file_list = _prepare_file_list(file_list)
90
103
tree = WorkingTree.open_containing(file_list[0])[0]
91
return smart_add_tree(tree, file_list, recurse, action)
94
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
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):
95
122
"""Add files to version, optionally recursing into directories.
97
124
This is designed more towards DWIM for humans than API simplicity.
100
127
This calls reporter with each (path, kind, file_id) of added files.
102
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().
105
from bzrlib.errors import BadFileKindError, ForbiddenFileError
106
137
assert isinstance(recurse, bool)
108
141
prepared_list = _prepare_file_list(file_list)
109
142
mutter("smart add of %r, originally %r", prepared_list, file_list)
110
143
inv = tree.read_working_inventory()
116
149
# validate user file paths and convert all paths to tree
117
150
# relative : its cheaper to make a tree relative path an abspath
118
151
# than to convert an abspath to tree relative.
119
152
for filepath in prepared_list:
120
rf = tree.relpath(filepath)
122
files_to_add.append((rf, None))
153
rf = FastPath(tree.relpath(filepath))
123
154
# validate user parameters. Our recursive code avoids adding new files
124
155
# that need such validation
125
if tree.is_control_filename(rf):
126
raise ForbiddenFileError('cannot add control file %s' % filepath)
128
for filepath, parent_ie in files_to_add:
129
# filepath is tree-relative
130
abspath = tree.abspath(filepath)
132
# find the kind of the path being added. This is not
133
# currently determined when we list directories
134
# recursively, but in theory we can determine while
135
# doing the directory listing on *some* platformans.
136
# TODO: a safe, portable, clean interface which will
137
# be faster than os.listdir() + stat. Specifically,
138
# readdir - dirent.d_type supplies the file type when
139
# it is defined. (Apparently Mac OSX has the field but
140
# does not fill it in ?!) Robert C, Martin P.
142
kind = bzrlib.osutils.file_kind(abspath)
144
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
145
raise errors.NoSuchFile(abspath)
148
# we need to call this to determine the inventory kind to create.
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)
149
202
if not InventoryEntry.versionable_kind(kind):
150
if filepath in user_files:
151
raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
153
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
203
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
156
206
if parent_ie is not None:
157
versioned = bzrlib.osutils.basename(filepath) in parent_ie.children
207
versioned = directory.base_path in parent_ie.children
159
209
# without the parent ie, use the relatively slower inventory
161
versioned = inv.has_filename(filepath)
211
versioned = inv.has_filename(directory.raw_path)
163
213
if kind == 'directory':
181
231
mutter("%r is a nested bzr tree", abspath)
183
added.extend(__add_one(tree, inv, parent_ie, filepath, kind, action))
233
__add_one(tree, inv, parent_ie, directory, kind, action)
234
added.append(directory.raw_path)
185
if kind == 'directory' and recurse and not sub_tree:
187
if parent_ie is not None:
189
this_ie = parent_ie.children[bzrlib.osutils.basename(filepath)]
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)
191
# without the parent ie, use the relatively slower inventory
193
this_id = inv.path2id(filepath)
197
this_ie = inv[this_id]
247
this_ie = inv[this_id]
201
249
for subf in os.listdir(abspath):
202
250
# here we could use TreeDirectory rather than
203
251
# string concatenation.
204
subp = bzrlib.osutils.pathjoin(filepath, subf)
252
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
205
253
# TODO: is_control_filename is very slow. Make it faster.
206
254
# TreeDirectory.is_control_filename could also make this
207
255
# faster - its impossible for a non root dir to have a
209
257
if tree.is_control_filename(subp):
210
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
212
264
# ignore while selecting files - if we globbed in the
213
265
# outer loop we would ignore user files.
214
266
ignore_glob = tree.is_ignored(subp)
219
271
ignored[ignore_glob].append(subp)
221
273
#mutter("queue to add sub-file %r", subp)
222
files_to_add.append((subp, this_ie))
274
dirs_to_add.append((FastPath(subp, subf), this_ie))
276
if len(added) > 0 and save:
225
277
tree._write_inventory(inv)
226
278
return added, ignored
229
def __add_one(tree, inv, parent_ie, path, kind, action):
281
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
230
282
"""Add a new entry to the inventory and automatically add unversioned parents.
232
Actual adding of the entry is delegated to the action callback.
234
284
:param inv: Inventory which will receive the new entry.
235
285
:param parent_ie: Parent inventory entry if known, or None. If
236
286
None, the parent is looked up by name and used if present, otherwise
250
299
# slower but does not need parent_ie
251
if inv.has_filename(path):
300
if inv.has_filename(path.raw_path):
254
added = __add_one(tree, inv, None, dirname(path), 'directory', action)
255
parent_id = inv.path2id(dirname(path))
256
if parent_id is not None:
257
parent_ie = inv[inv.path2id(dirname(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.
260
322
action(inv, parent_ie, path, kind)
262
return added + [path]
323
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id)
added
removed
bzrlib/add.py
