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
# 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
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 suppressed.
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('adding %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('adding %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, path, kind):
55
"""Absorb add actions and do nothing."""
58
def add_action_print(inv, path, kind):
59
"""Print a line to stdout for each file that would be added."""
60
print "added", bzrlib.osutils.quotefn(path)
62
def add_action_add(inv, path, kind):
63
"""Add each file to the given inventory. Produce no output."""
64
entry = inv.add_path(path, kind=kind)
65
mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
68
def add_action_add_and_print(inv, path, kind):
69
"""Add each file to the given inventory, and print a line to stdout."""
70
add_action_add(inv, path, kind)
71
add_action_print(inv, path, kind)
74
def smart_add(file_list, recurse=True, action=add_action_add):
75
"""Add files to version, optionally recursing into directories.
77
This is designed more towards DWIM for humans than API simplicity.
78
For the specific behaviour see the help for cmd_add().
80
Returns the number of files added.
82
file_list = _prepare_file_list(file_list)
83
tree = WorkingTree.open_containing(file_list[0])[0]
84
return smart_add_tree(tree, file_list, recurse, action)
87
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
88
"""Add files to version, optionally recursing into directories.
90
This is designed more towards DWIM for humans than API simplicity.
91
For the specific behaviour see the help for cmd_add().
93
This calls reporter with each (path, kind, file_id) of added files.
95
Returns the number of files added.
98
from bzrlib.errors import BadFileKindError, ForbiddenFileError
99
assert isinstance(recurse, bool)
101
file_list = _prepare_file_list(file_list)
102
user_list = file_list[:]
103
inv = tree.read_working_inventory()
106
user_files = set(file_list)
110
af = tree.abspath(rf)
113
kind = bzrlib.osutils.file_kind(af)
115
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
116
raise errors.NoSuchFile(rf)
119
if not InventoryEntry.versionable_kind(kind):
121
raise BadFileKindError("cannot add %s of type %s" % (f, kind))
123
warning("skipping %s (can't add file of kind '%s')", f, kind)
126
mutter("smart add of %r, abs=%r", f, af)
128
# validate user parameters. Our recursive code avoids adding new files
129
# that need such validation
130
if f in user_files and tree.is_control_filename(af):
131
raise ForbiddenFileError('cannot add control file %s' % f)
133
versioned = (inv.path2id(rf) != None)
135
if kind == 'directory':
137
sub_branch = WorkingTree.open(af)
139
except NotBranchError:
141
except errors.UnsupportedFormatError:
147
mutter("tree root doesn't need to be added")
150
mutter("%r is already versioned", f)
152
mutter("%r is a bzr tree", f)
154
added.extend(__add_one(tree, inv, rf, kind, action))
156
if kind == 'directory' and recurse and not sub_tree:
157
for subf in os.listdir(af):
158
subp = bzrlib.osutils.pathjoin(rf, subf)
159
if tree.is_control_filename(subp):
160
mutter("skip control directory %r", subp)
162
ignore_glob = tree.is_ignored(subp)
163
if ignore_glob is not None:
164
mutter("skip ignored sub-file %r", subp)
165
if ignore_glob not in ignored:
166
ignored[ignore_glob] = []
167
ignored[ignore_glob].append(subp)
169
mutter("queue to add sub-file %r", subp)
170
file_list.append(tree.abspath(subp))
172
mutter('added %d entries', len(added))
175
tree._write_inventory(inv)
177
return added, ignored
180
def __add_one(tree, inv, path, kind, action):
181
"""Add a file or directory, automatically add unversioned parents."""
183
# Nothing to do if path is already versioned.
184
# This is safe from infinite recursion because the tree root is
186
if inv.path2id(path) != None:
190
added = __add_one(tree, inv, dirname(path), 'directory', action)
191
action(inv, path, kind)
193
return added + [path]
added
removed
bzrlib/add.py
