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
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
23
from bzrlib.workingtree import is_control_file
22
24
import bzrlib.osutils
23
from bzrlib.symbol_versioning import *
26
class AddAction(object):
27
"""A class which defines what action to take when adding a file."""
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.
36
self._to_file = to_file
38
self._to_file = sys.stdout
39
self.should_print = False
40
if should_print is not None:
41
self.should_print = should_print
43
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
44
"""Add path to inventory.
46
The default action does nothing.
48
:param inv: The inventory we are working with.
49
:param path: The FastPath being added
50
:param kind: The kind of the object being added.
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
100
# TODO: jam 20050105 These could be used for compatibility
101
# however, they bind against the current stdout, not the
102
# one which exists at the time they are called, so they
103
# don't work for the test suite.
105
add_action_add = AddAction()
106
add_action_null = add_action_add
107
add_action_add_and_print = AddAction(should_print=True)
108
add_action_print = add_action_add_and_print
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_*."""
47
if sys.platform == 'win32':
48
file_list = glob_expand_for_win32(file_list)
51
file_list = list(file_list)
55
def add_action_null(inv, path, kind):
56
"""Absorb add actions and do nothing."""
59
def add_action_print(inv, path, kind):
60
"""Print a line to stdout for each file that would be added."""
61
print "added", bzrlib.osutils.quotefn(path)
63
def add_action_add(inv, path, kind):
64
"""Add each file to the given inventory. Produce no output."""
65
entry = inv.add_path(path, kind=kind)
66
mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
69
def add_action_add_and_print(inv, path, kind):
70
"""Add each file to the given inventory, and print a line to stdout."""
71
add_action_add(inv, path, kind)
72
add_action_print(inv, path, kind)
75
def smart_add(file_list, recurse=True, action=add_action_add):
76
"""Add files to version, optionally recursing into directories.
78
This is designed more towards DWIM for humans than API simplicity.
79
For the specific behaviour see the help for cmd_add().
81
Returns the number of files added.
83
file_list = _prepare_file_list(file_list)
84
tree = WorkingTree.open_containing(file_list[0])[0]
85
return smart_add_tree(tree, file_list, recurse, action)
88
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
89
"""Add files to version, optionally recursing into directories.
91
This is designed more towards DWIM for humans than API simplicity.
92
For the specific behaviour see the help for cmd_add().
94
This calls reporter with each (path, kind, file_id) of added files.
96
Returns the number of files added.
99
from bzrlib.errors import BadFileKindError, ForbiddenFileError
100
assert isinstance(recurse, bool)
102
file_list = _prepare_file_list(file_list)
103
user_list = file_list[:]
104
inv = tree.read_working_inventory()
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
if tree.is_control_filename(af):
129
raise ForbiddenFileError('cannot add control file %s' % f)
131
versioned = (inv.path2id(rf) != None)
133
if kind == 'directory':
135
sub_branch = WorkingTree.open(af)
137
except NotBranchError:
139
except errors.UnsupportedFormatError:
145
mutter("tree root doesn't need to be added")
148
mutter("%r is already versioned", f)
150
mutter("%r is a bzr tree", f)
152
added.extend(__add_one(tree, inv, rf, kind, action))
154
if kind == 'directory' and recurse and not sub_tree:
155
for subf in os.listdir(af):
156
subp = bzrlib.osutils.pathjoin(rf, subf)
157
if tree.is_control_filename(subp):
158
mutter("skip control directory %r", subp)
160
ignore_glob = tree.is_ignored(subp)
161
if ignore_glob is not None:
162
mutter("skip ignored sub-file %r", subp)
163
if ignore_glob not in ignored:
164
ignored[ignore_glob] = []
165
ignored[ignore_glob].append(subp)
167
mutter("queue to add sub-file %r", subp)
168
file_list.append(tree.abspath(subp))
170
mutter('added %d entries', len(added))
173
tree._write_inventory(inv)
175
return added, ignored
178
def __add_one(tree, inv, path, kind, action):
179
"""Add a file or directory, automatically add unversioned parents."""
181
# Nothing to do if path is already versioned.
182
# This is safe from infinite recursion because the tree root is
184
if inv.path2id(path) != None:
188
added = __add_one(tree, inv, dirname(path), 'directory', action)
189
action(inv, path, kind)
191
return added + [path]
added
removed
bzrlib/add.py
