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."""
17
from os.path import dirname
24
19
import bzrlib.errors as errors
20
from bzrlib.inventory import InventoryEntry
21
from bzrlib.trace import mutter, note, warning
22
from bzrlib.errors import NotBranchError
25
23
import bzrlib.osutils
26
from bzrlib.symbol_versioning import *
27
24
from bzrlib.workingtree import WorkingTree
30
class AddAction(object):
31
"""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.
40
self._to_file = to_file
42
self._to_file = sys.stdout
43
self.should_print = False
44
if should_print is not None:
45
self.should_print = should_print
47
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
48
"""Add path to inventory.
50
The default action does nothing.
52
:param inv: The inventory we are working with.
53
:param path: The FastPath being added
54
:param kind: The kind of the object being added.
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))
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
104
# TODO: jam 20050105 These could be used for compatibility
105
# however, they bind against the current stdout, not the
106
# one which exists at the time they are called, so they
107
# 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
26
def glob_expand_for_win32(file_list):
30
expanded_file_list = []
31
for possible_glob in file_list:
32
glob_files = glob.glob(possible_glob)
35
# special case to let the normal code path handle
36
# files that do not exists
37
expanded_file_list.append(possible_glob)
39
expanded_file_list += glob_files
40
return expanded_file_list
43
def _prepare_file_list(file_list):
44
"""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)
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):
82
"""Add files to version, optionally recursing into directories.
84
This is designed more towards DWIM for humans than API simplicity.
85
For the specific behaviour see the help for cmd_add().
87
Returns the number of files added.
89
file_list = _prepare_file_list(file_list)
90
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):
95
"""Add files to version, optionally recursing into directories.
97
This is designed more towards DWIM for humans than API simplicity.
98
For the specific behaviour see the help for cmd_add().
100
This calls reporter with each (path, kind, file_id) of added files.
102
Returns the number of files added.
105
from bzrlib.errors import BadFileKindError, ForbiddenFileError
106
assert isinstance(recurse, bool)
108
prepared_list = _prepare_file_list(file_list)
109
mutter("smart add of %r, originally %r", prepared_list, file_list)
110
inv = tree.read_working_inventory()
116
# validate user file paths and convert all paths to tree
117
# relative : its cheaper to make a tree relative path an abspath
118
# than to convert an abspath to tree relative.
119
for filepath in prepared_list:
120
rf = tree.relpath(filepath)
122
files_to_add.append((rf, None))
123
# validate user parameters. Our recursive code avoids adding new files
124
# 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.
149
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)
156
if parent_ie is not None:
157
versioned = bzrlib.osutils.basename(filepath) in parent_ie.children
159
# without the parent ie, use the relatively slower inventory
161
versioned = inv.has_filename(filepath)
163
if kind == 'directory':
165
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
167
except NotBranchError:
169
except errors.UnsupportedFormatError:
175
# mutter("tree root doesn't need to be added")
179
# mutter("%r is already versioned", abspath)
181
mutter("%r is a nested bzr tree", abspath)
183
added.extend(__add_one(tree, inv, parent_ie, filepath, kind, action))
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)]
191
# without the parent ie, use the relatively slower inventory
193
this_id = inv.path2id(filepath)
197
this_ie = inv[this_id]
201
for subf in os.listdir(abspath):
202
# here we could use TreeDirectory rather than
203
# string concatenation.
204
subp = bzrlib.osutils.pathjoin(filepath, subf)
205
# TODO: is_control_filename is very slow. Make it faster.
206
# TreeDirectory.is_control_filename could also make this
207
# faster - its impossible for a non root dir to have a
209
if tree.is_control_filename(subp):
210
mutter("skip control directory %r", subp)
212
# ignore while selecting files - if we globbed in the
213
# outer loop we would ignore user files.
214
ignore_glob = tree.is_ignored(subp)
215
if ignore_glob is not None:
216
# mutter("skip ignored sub-file %r", subp)
217
if ignore_glob not in ignored:
218
ignored[ignore_glob] = []
219
ignored[ignore_glob].append(subp)
221
#mutter("queue to add sub-file %r", subp)
222
files_to_add.append((subp, this_ie))
225
tree._write_inventory(inv)
226
return added, ignored
229
def __add_one(tree, inv, parent_ie, path, kind, action):
230
"""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
:param inv: Inventory which will receive the new entry.
235
:param parent_ie: Parent inventory entry if known, or None. If
236
None, the parent is looked up by name and used if present, otherwise
237
it is recursively added.
238
:param kind: Kind of new entry (file, directory, etc)
239
:param action: callback(inv, parent_ie, path, kind); return ignored.
240
:returns: A list of paths which have been added.
243
# Nothing to do if path is already versioned.
244
# This is safe from infinite recursion because the tree root is
246
if parent_ie is not None:
247
# we have a parent ie already
250
# slower but does not need parent_ie
251
if inv.has_filename(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))]
260
action(inv, parent_ie, path, kind)
262
return added + [path]
added
removed
bzrlib/add.py
