summaryrefslogtreecommitdiff
path: root/bzrlib/add.py
diff options
context:
space:
mode:
Diffstat (limited to 'bzrlib/add.py')
-rw-r--r--bzrlib/add.py139
1 files changed, 139 insertions, 0 deletions
diff --git a/bzrlib/add.py b/bzrlib/add.py
new file mode 100644
index 0000000..118dc1e
--- /dev/null
+++ b/bzrlib/add.py
@@ -0,0 +1,139 @@
+# Copyright (C) 2005-2010 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Helper functions for adding files to working trees."""
+
+from __future__ import absolute_import
+
+import sys
+import os
+
+from bzrlib import (
+ osutils,
+ ui,
+ )
+from bzrlib.i18n import gettext
+
+class AddAction(object):
+ """A class which defines what action to take when adding a file."""
+
+ def __init__(self, to_file=None, should_print=None):
+ """Initialize an action which prints added files to an output stream.
+
+ :param to_file: The stream to write into. This is expected to take
+ Unicode paths. If not supplied, it will default to ``sys.stdout``.
+ :param should_print: If False, printing will be suppressed.
+ """
+ self._to_file = to_file
+ if to_file is None:
+ self._to_file = sys.stdout
+ self.should_print = False
+ if should_print is not None:
+ self.should_print = should_print
+
+ def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
+ """Add path to inventory.
+
+ The default action does nothing.
+
+ :param inv: The inventory we are working with.
+ :param path: The FastPath being added
+ :param kind: The kind of the object being added.
+ """
+ if self.should_print:
+ self._to_file.write('adding %s\n' % _quote(path))
+ return None
+
+ def skip_file(self, tree, path, kind, stat_value = None):
+ """Test whether the given file should be skipped or not.
+
+ The default action never skips. Note this is only called during
+ recursive adds
+
+ :param tree: The tree we are working in
+ :param path: The path being added
+ :param kind: The kind of object being added.
+ :param stat: Stat result for this file, if available already
+ :return bool. True if the file should be skipped (not added)
+ """
+ return False
+
+
+class AddWithSkipLargeAction(AddAction):
+ """A class that can decide to skip a file if it's considered too large"""
+
+ _maxSize = None
+
+ def skip_file(self, tree, path, kind, stat_value = None):
+ if kind != 'file':
+ return False
+ opt_name = 'add.maximum_file_size'
+ if self._maxSize is None:
+ config = tree.get_config_stack()
+ self._maxSize = config.get(opt_name)
+ if stat_value is None:
+ file_size = os.path.getsize(path);
+ else:
+ file_size = stat_value.st_size;
+ if self._maxSize > 0 and file_size > self._maxSize:
+ ui.ui_factory.show_warning(gettext(
+ "skipping {0} (larger than {1} of {2} bytes)").format(
+ path, opt_name, self._maxSize))
+ return True
+ return False
+
+
+class AddFromBaseAction(AddAction):
+ """This class will try to extract file ids from another tree."""
+
+ def __init__(self, base_tree, base_path, to_file=None, should_print=None):
+ super(AddFromBaseAction, self).__init__(to_file=to_file,
+ should_print=should_print)
+ self.base_tree = base_tree
+ self.base_path = base_path
+
+ def __call__(self, inv, parent_ie, path, kind):
+ # Place the parent call
+ # Now check to see if we can extract an id for this file
+ file_id, base_path = self._get_base_file_id(path, parent_ie)
+ if file_id is not None:
+ if self.should_print:
+ self._to_file.write('adding %s w/ file id from %s\n'
+ % (path, base_path))
+ else:
+ # we aren't doing anything special, so let the default
+ # reporter happen
+ file_id = super(AddFromBaseAction, self).__call__(
+ inv, parent_ie, path, kind)
+ return file_id
+
+ def _get_base_file_id(self, path, parent_ie):
+ """Look for a file id in the base branch.
+
+ First, if the base tree has the parent directory,
+ we look for a file with the same name in that directory.
+ Else, we look for an entry in the base tree with the same path.
+ """
+ if self.base_tree.has_id(parent_ie.file_id):
+ base_path = osutils.pathjoin(
+ self.base_tree.id2path(parent_ie.file_id),
+ osutils.basename(path))
+ base_id = self.base_tree.path2id(base_path)
+ if base_id is not None:
+ return (base_id, base_path)
+ full_base_path = osutils.pathjoin(self.base_path, path)
+ # This may return None, but it is our last attempt
+ return self.base_tree.path2id(full_base_path), full_base_path