1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 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
"""Helper functions for adding files to working trees."""
18
from os.path import dirname
24
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
25
24
import bzrlib.osutils
26
from bzrlib.symbol_versioning import *
27
25
from bzrlib.workingtree import WorkingTree
27
def glob_expand_for_win32(file_list):
31
expanded_file_list = []
32
for possible_glob in file_list:
33
glob_files = glob.glob(possible_glob)
36
# special case to let the normal code path handle
37
# files that do not exists
38
expanded_file_list.append(possible_glob)
40
expanded_file_list += glob_files
41
return expanded_file_list
44
def _prepare_file_list(file_list):
45
"""Prepare a file list for use by smart_add_*."""
46
if sys.platform == 'win32':
47
file_list = glob_expand_for_win32(file_list)
50
file_list = list(file_list)
30
54
class AddAction(object):
31
55
"""A class which defines what action to take when adding a file."""
33
def __init__(self, to_file=None, should_print=None):
34
"""Initialize an action which prints added files to an output stream.
36
:param to_file: The stream to write into. This is expected to take
37
Unicode paths. If not supplied, it will default to ``sys.stdout``.
38
:param should_print: If False, printing will be supressed.
57
def __init__(self, to_file=None, should_add=None, should_print=None):
40
58
self._to_file = to_file
41
59
if to_file is None:
42
60
self._to_file = sys.stdout
61
self.should_add = False
62
if should_add is not None:
63
self.should_add = should_add
43
64
self.should_print = False
44
65
if should_print is not None:
45
66
self.should_print = should_print
47
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
68
def __call__(self, inv, parent_ie, path, kind):
48
69
"""Add path to inventory.
50
71
The default action does nothing.
52
73
:param inv: The inventory we are working with.
53
:param path: The FastPath being added
74
:param path: The path being added
54
75
:param kind: The kind of the object being added.
78
self._add_to_inv(inv, parent_ie, path, kind)
56
79
if self.should_print:
57
self._to_file.write('added %s\n' % _quote(path.raw_path))
61
class AddFromBaseAction(AddAction):
62
"""This class will try to extract file ids from another tree."""
64
def __init__(self, base_tree, base_path, to_file=None, should_print=None):
65
super(AddFromBaseAction, self).__init__(to_file=to_file,
66
should_print=should_print)
67
self.base_tree = base_tree
68
self.base_path = base_path
70
def __call__(self, inv, parent_ie, path, kind):
71
# Place the parent call
72
# Now check to see if we can extract an id for this file
73
file_id, base_path = self._get_base_file_id(path, parent_ie)
74
if file_id is not None:
76
self._to_file.write('added %s w/ file id from %s\n'
77
% (path.raw_path, base_path))
80
self._print(inv, parent_ie, path, kind)
82
def _print(self, inv, parent_ie, path, kind):
83
"""Print a line to self._to_file for each file that would be added."""
84
self._to_file.write('added ')
85
self._to_file.write(bzrlib.osutils.quotefn(path))
86
self._to_file.write('\n')
88
def _add_to_inv(self, inv, parent_ie, path, kind):
89
"""Add each file to the given inventory. Produce no output."""
90
if parent_ie is not None:
91
entry = bzrlib.inventory.make_entry(
92
kind, bzrlib.osutils.basename(path), parent_ie.file_id)
79
# we aren't doing anything special, so let the default
81
file_id = super(AddFromBaseAction, self).__call__(
82
inv, parent_ie, path, kind)
85
def _get_base_file_id(self, path, parent_ie):
86
"""Look for a file id in the base branch.
88
First, if the base tree has the parent directory,
89
we look for a file with the same name in that directory.
90
Else, we look for an entry in the base tree with the same path.
93
if (parent_ie.file_id in self.base_tree):
94
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
95
base_child_ie = base_parent_ie.children.get(path.base_path)
96
if base_child_ie is not None:
97
return (base_child_ie.file_id,
98
self.base_tree.id2path(base_child_ie.file_id))
99
full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
100
# This may return None, but it is our last attempt
101
return self.base_tree.path2id(full_base_path), full_base_path
95
entry = inv.add_path(path, kind=kind)
96
# mutter("added %r kind %r file_id={%s}", path, kind, entry.file_id)
104
99
# TODO: jam 20050105 These could be used for compatibility
106
101
# one which exists at the time they are called, so they
107
102
# don't work for the test suite.
109
add_action_add = AddAction()
110
add_action_null = add_action_add
111
add_action_add_and_print = AddAction(should_print=True)
112
add_action_print = add_action_add_and_print
104
add_action_null = AddAction()
105
add_action_add = AddAction(should_add=True)
106
add_action_print = AddAction(should_print=True)
107
add_action_add_and_print = AddAction(should_add=True, should_print=True)
110
def smart_add(file_list, recurse=True, action=None):
111
"""Add files to version, optionally recursing into directories.
113
This is designed more towards DWIM for humans than API simplicity.
114
For the specific behaviour see the help for cmd_add().
116
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
def smart_add_tree(tree, file_list, recurse=True, action=None):
125
"""Add files to version, optionally recursing into directories.
127
This is designed more towards DWIM for humans than API simplicity.
128
For the specific behaviour see the help for cmd_add().
130
This calls reporter with each (path, kind, file_id) of added files.
132
Returns the number of files added.
135
from bzrlib.errors import BadFileKindError, ForbiddenFileError
136
assert isinstance(recurse, bool)
138
action = AddAction(should_add=True)
140
prepared_list = _prepare_file_list(file_list)
141
mutter("smart add of %r, originally %r", prepared_list, file_list)
142
inv = tree.read_working_inventory()
148
# validate user file paths and convert all paths to tree
149
# relative : its cheaper to make a tree relative path an abspath
150
# than to convert an abspath to tree relative.
151
for filepath in prepared_list:
152
rf = tree.relpath(filepath)
154
files_to_add.append((rf, None))
155
# validate user parameters. Our recursive code avoids adding new files
156
# that need such validation
157
if tree.is_control_filename(rf):
158
raise ForbiddenFileError('cannot add control file %s' % filepath)
160
for filepath, parent_ie in files_to_add:
161
# filepath is tree-relative
162
abspath = tree.abspath(filepath)
164
# find the kind of the path being added. This is not
165
# currently determined when we list directories
166
# recursively, but in theory we can determine while
167
# doing the directory listing on *some* platformans.
168
# TODO: a safe, portable, clean interface which will
169
# be faster than os.listdir() + stat. Specifically,
170
# readdir - dirent.d_type supplies the file type when
171
# it is defined. (Apparently Mac OSX has the field but
172
# does not fill it in ?!) Robert C, Martin P.
174
kind = bzrlib.osutils.file_kind(abspath)
176
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
177
raise errors.NoSuchFile(abspath)
180
# we need to call this to determine the inventory kind to create.
181
if not InventoryEntry.versionable_kind(kind):
182
if filepath in user_files:
183
raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
185
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
188
if parent_ie is not None:
189
versioned = bzrlib.osutils.basename(filepath) in parent_ie.children
191
# without the parent ie, use the relatively slower inventory
193
versioned = inv.has_filename(filepath)
195
if kind == 'directory':
197
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
199
except NotBranchError:
201
except errors.UnsupportedFormatError:
207
# mutter("tree root doesn't need to be added")
211
# mutter("%r is already versioned", abspath)
213
mutter("%r is a nested bzr tree", abspath)
215
added.extend(__add_one(tree, inv, parent_ie, filepath, kind, action))
217
if kind == 'directory' and recurse and not sub_tree:
219
if parent_ie is not None:
221
this_ie = parent_ie.children[bzrlib.osutils.basename(filepath)]
223
# without the parent ie, use the relatively slower inventory
225
this_id = inv.path2id(filepath)
229
this_ie = inv[this_id]
233
for subf in os.listdir(abspath):
234
# here we could use TreeDirectory rather than
235
# string concatenation.
236
subp = bzrlib.osutils.pathjoin(filepath, subf)
237
# TODO: is_control_filename is very slow. Make it faster.
238
# TreeDirectory.is_control_filename could also make this
239
# faster - its impossible for a non root dir to have a
241
if tree.is_control_filename(subp):
242
mutter("skip control directory %r", subp)
244
# ignore while selecting files - if we globbed in the
245
# outer loop we would ignore user files.
246
ignore_glob = tree.is_ignored(subp)
247
if ignore_glob is not None:
248
# mutter("skip ignored sub-file %r", subp)
249
if ignore_glob not in ignored:
250
ignored[ignore_glob] = []
251
ignored[ignore_glob].append(subp)
253
#mutter("queue to add sub-file %r", subp)
254
files_to_add.append((subp, this_ie))
257
tree._write_inventory(inv)
258
return added, ignored
260
def __add_one(tree, inv, parent_ie, path, kind, action):
261
"""Add a new entry to the inventory and automatically add unversioned parents.
263
Actual adding of the entry is delegated to the action callback.
265
:param inv: Inventory which will receive the new entry.
266
:param parent_ie: Parent inventory entry if known, or None. If
267
None, the parent is looked up by name and used if present, otherwise
268
it is recursively added.
269
:param kind: Kind of new entry (file, directory, etc)
270
:param action: callback(inv, parent_ie, path, kind); return ignored.
271
:returns: A list of paths which have been added.
274
# Nothing to do if path is already versioned.
275
# This is safe from infinite recursion because the tree root is
277
if parent_ie is not None:
278
# we have a parent ie already
281
# slower but does not need parent_ie
282
if inv.has_filename(path):
285
added = __add_one(tree, inv, None, dirname(path), 'directory', action)
286
parent_id = inv.path2id(dirname(path))
287
if parent_id is not None:
288
parent_ie = inv[inv.path2id(dirname(path))]
291
action(inv, parent_ie, path, kind)
293
return added + [path]
added
removed
bzrlib/add.py
