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."""
24
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('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
17
from bzrlib.trace import mutter, note, warning
18
from bzrlib.errors import NotBranchError
19
from bzrlib.branch import Branch
20
from bzrlib.osutils import quotefn
22
def glob_expand_for_win32(file_list):
25
expanded_file_list = []
26
for possible_glob in file_list:
27
glob_files = glob.glob(possible_glob)
30
# special case to let the normal code path handle
31
# files that do not exists
32
expanded_file_list.append(possible_glob)
34
expanded_file_list += glob_files
35
return expanded_file_list
38
def _NullAddCallback(path, kind, entry):
41
def _PrintAddCallback(path, kind, entry):
42
print "added", quotefn(path)
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)
52
assert not isinstance(file_list, basestring)
55
def smart_add(file_list, verbose=True, recurse=True, callback=_NullAddCallback):
56
"""Add files to version, optionally recursing into directories.
58
This is designed more towards DWIM for humans than API simplicity.
59
For the specific behaviour see the help for cmd_add().
61
file_list = _prepare_file_list(file_list)
62
b = Branch(file_list[0], find_root=True)
63
return smart_add_branch(b, file_list, verbose, recurse)
65
def smart_add_branch(branch, file_list, verbose=True, recurse=True,
66
callback=_NullAddCallback):
67
"""Add files to version, optionally recursing into directories.
69
This is designed more towards DWIM for humans than API simplicity.
70
For the specific behaviour see the help for cmd_add().
72
This yields a sequence of (path, kind, file_id) for added files.
76
from bzrlib.osutils import quotefn
77
from bzrlib.errors import BadFileKindError, ForbiddenFileError
81
file_list = _prepare_file_list(file_list)
82
user_list = file_list[:]
83
inv = branch.read_working_inventory()
84
tree = branch.working_tree()
88
rf = branch.relpath(f)
89
af = branch.abspath(rf)
91
kind = bzrlib.osutils.file_kind(af)
93
if kind != 'file' and kind != 'directory':
95
raise BadFileKindError("cannot add %s of type %s" % (f, kind))
97
warning("skipping %s (can't add file of kind '%s')", f, kind)
100
mutter("smart add of %r, abs=%r" % (f, af))
102
if bzrlib.branch.is_control_file(af):
103
raise ForbiddenFileError('cannot add control file %s' % f)
105
versioned = (inv.path2id(rf) != None)
107
if kind == 'directory':
109
sub_branch = Branch(af, find_root=False)
111
except NotBranchError:
117
mutter("branch root doesn't need to be added")
120
mutter("%r is already versioned" % f)
122
mutter("%r is a bzr tree" %f)
124
entry = inv.add_path(rf, kind=kind)
125
mutter("added %r kind %r file_id={%s}" % (rf, kind, entry.file_id))
127
callback(rf, kind, entry)
129
if kind == 'directory' and recurse and not sub_tree:
130
for subf in os.listdir(af):
131
subp = os.path.join(rf, subf)
132
if subf == bzrlib.BZRDIR:
133
mutter("skip control directory %r" % subp)
134
elif tree.is_ignored(subp):
135
mutter("skip ignored sub-file %r" % subp)
137
mutter("queue to add sub-file %r" % subp)
138
file_list.append(branch.abspath(subp))
143
note('added %d' % count)
144
branch._write_inventory(inv)
146
note("nothing new to add")
147
# should this return 1 to the shell?
added
removed
bzrlib/add.py
