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
26
from bzrlib.symbol_versioning import *
27
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
115
@deprecated_function(zero_eighteen)
116
def smart_add(file_list, recurse=True, action=None, save=True):
117
"""Add files to version, optionally recursing into directories.
119
This is designed more towards DWIM for humans than API simplicity.
120
For the specific behaviour see the help for cmd_add().
122
Returns the number of files added.
123
Deprecated in 0.18. Please use MutableTree.smart_add.
125
tree = WorkingTree.open_containing(file_list[0])[0]
126
return smart_add_tree(tree, file_list, recurse, action=action, save=save)
129
@deprecated_function(zero_eighteen)
130
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
131
"""Deprecated in 0.18. Please use MutableTree.smart_add."""
132
return tree.smart_add(file_list, recurse, action, save)
20
from bzrlib.inventory import InventoryEntry
21
from bzrlib.trace import mutter, note, warning
22
from bzrlib.errors import NotBranchError
23
from bzrlib.branch import Branch
24
from bzrlib.osutils import quotefn
26
def glob_expand_for_win32(file_list):
28
expanded_file_list = []
29
for possible_glob in file_list:
30
glob_files = glob.glob(possible_glob)
33
# special case to let the normal code path handle
34
# files that do not exists
35
expanded_file_list.append(possible_glob)
37
expanded_file_list += glob_files
38
return expanded_file_list
41
def add_reporter_null(path, kind, entry):
42
"""Absorb add reports and do nothing."""
45
def add_reporter_print(path, kind, entry):
46
"""Print a line to stdout for each file that's added."""
47
print "added", quotefn(path)
49
def _prepare_file_list(file_list):
50
"""Prepare a file list for use by smart_add_*."""
52
if sys.platform == 'win32':
53
file_list = glob_expand_for_win32(file_list)
56
file_list = list(file_list)
60
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
61
"""Add files to version, optionally recursing into directories.
63
This is designed more towards DWIM for humans than API simplicity.
64
For the specific behaviour see the help for cmd_add().
66
Returns the number of files added.
68
file_list = _prepare_file_list(file_list)
69
b = Branch.open_containing(file_list[0])
70
return smart_add_branch(b, file_list, recurse, reporter)
73
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
74
"""Add files to version, optionally recursing into directories.
76
This is designed more towards DWIM for humans than API simplicity.
77
For the specific behaviour see the help for cmd_add().
79
This yields a sequence of (path, kind, file_id) for added files.
81
Returns the number of files added.
84
from bzrlib.errors import BadFileKindError, ForbiddenFileError
87
assert isinstance(recurse, bool)
89
file_list = _prepare_file_list(file_list)
90
user_list = file_list[:]
91
inv = branch.read_working_inventory()
92
tree = branch.working_tree()
96
rf = branch.relpath(f)
97
af = branch.abspath(rf)
99
kind = bzrlib.osutils.file_kind(af)
101
if not InventoryEntry.versionable_kind(kind):
103
raise BadFileKindError("cannot add %s of type %s" % (f, kind))
105
warning("skipping %s (can't add file of kind '%s')", f, kind)
108
mutter("smart add of %r, abs=%r" % (f, af))
110
if bzrlib.branch.is_control_file(af):
111
raise ForbiddenFileError('cannot add control file %s' % f)
113
versioned = (inv.path2id(rf) != None)
115
if kind == 'directory':
117
sub_branch = Branch.open(af)
119
except NotBranchError:
121
except errors.UnsupportedFormatError:
127
mutter("branch root doesn't need to be added")
130
mutter("%r is already versioned" % f)
132
mutter("%r is a bzr tree" %f)
134
count += __add_one(branch, inv, rf, kind, reporter)
136
if kind == 'directory' and recurse and not sub_tree:
137
for subf in os.listdir(af):
138
subp = os.path.join(rf, subf)
139
if subf == bzrlib.BZRDIR:
140
mutter("skip control directory %r" % subp)
141
elif tree.is_ignored(subp):
142
mutter("skip ignored sub-file %r" % subp)
144
mutter("queue to add sub-file %r" % subp)
145
file_list.append(branch.abspath(subp))
148
mutter('added %d entries', count)
151
branch._write_inventory(inv)
155
def __add_one(branch, inv, path, kind, reporter):
156
"""Add a file or directory, automatically add unversioned parents."""
158
# Nothing to do if path is already versioned.
159
# This is safe from infinite recursion because the branch root is
161
if inv.path2id(path) != None:
165
count = __add_one(branch, inv, dirname(path), 'directory', reporter)
167
entry = inv.add_path(path, kind=kind)
168
mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
169
reporter(path, kind, entry)
added
removed
bzrlib/add.py
