~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Jelmer Vernooij
  • Date: 2012-03-30 18:16:07 UTC
  • mto: This revision was merged to the branch mainline in revision 6535.
  • Revision ID: jelmer@samba.org-20120330181607-xr5s4v7xyr1y0ob6
Add bzrlib.branchfmt.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
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.
7
 
 
 
7
#
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.
12
 
 
 
12
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
import os, sys
18
 
import bzrlib
19
 
 
20
 
from osutils import quotefn, appendpath
21
 
from errors import bailout
22
 
from trace import mutter, note
23
 
 
24
 
def smart_add(file_list, verbose=False, recurse=True):
25
 
    """Add files to version, optionall recursing into directories.
26
 
 
27
 
    This is designed more towards DWIM for humans than API simplicity.
28
 
    For the specific behaviour see the help for cmd_add().
29
 
    """
30
 
    assert file_list
31
 
    assert not isinstance(file_list, basestring)
32
 
    b = bzrlib.branch.Branch(file_list[0], find_root=True)
33
 
    inv = b.read_working_inventory()
34
 
    tree = b.working_tree()
35
 
    count = 0
36
 
 
37
 
    for f in file_list:
38
 
        rf = b.relpath(f)
39
 
        af = b.abspath(rf)
40
 
 
41
 
        ## TODO: It's OK to add root but only in recursive mode
42
 
 
43
 
        bzrlib.mutter("smart add of %r" % f)
44
 
        
45
 
        if bzrlib.branch.is_control_file(af):
46
 
            bailout("cannot add control file %r" % af)
47
 
 
48
 
        kind = bzrlib.osutils.file_kind(f)
49
 
 
50
 
        if kind != 'file' and kind != 'directory':
51
 
            bailout("can't add file of kind %r" % kind)
52
 
            
53
 
        versioned = (inv.path2id(rf) != None)
54
 
 
55
 
        if rf == '':
56
 
            mutter("branch root doesn't need to be added")
57
 
        elif versioned:
58
 
            mutter("%r is already versioned" % f)
59
 
        else:
60
 
            file_id = bzrlib.branch.gen_file_id(rf)
61
 
            inv.add_path(rf, kind=kind, file_id=file_id)
62
 
            bzrlib.mutter("added %r kind %r file_id={%s}" % (rf, kind, file_id))
63
 
            count += 1 
64
 
            if verbose:
65
 
                bzrlib.textui.show_status('A', kind, quotefn(f))
66
 
 
67
 
        if kind == 'directory' and recurse:
68
 
            for subf in os.listdir(af):
69
 
                subp = appendpath(rf, subf)
70
 
                if subf == bzrlib.BZRDIR:
71
 
                    mutter("skip control directory %r" % subp)
72
 
                elif tree.is_ignored(subp):
73
 
                    mutter("skip ignored sub-file %r" % subp)
74
 
                else:
75
 
                    mutter("queue to add sub-file %r" % (subp))
76
 
                    file_list.append(subp)
77
 
 
78
 
    if count > 0:
79
 
        if verbose:
80
 
            note('added %d' % count)
81
 
        b._write_inventory(inv)
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Helper functions for adding files to working trees."""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
import sys
 
22
import os
 
23
 
 
24
from bzrlib import (
 
25
    osutils,
 
26
    ui, 
 
27
    )
 
28
from bzrlib.i18n import gettext
 
29
 
 
30
class AddAction(object):
 
31
    """A class which defines what action to take when adding a file."""
 
32
 
 
33
    def __init__(self, to_file=None, should_print=None):
 
34
        """Initialize an action which prints added files to an output stream.
 
35
 
 
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.
 
39
        """
 
40
        self._to_file = to_file
 
41
        if to_file is None:
 
42
            self._to_file = sys.stdout
 
43
        self.should_print = False
 
44
        if should_print is not None:
 
45
            self.should_print = should_print
 
46
 
 
47
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
 
48
        """Add path to inventory.
 
49
 
 
50
        The default action does nothing.
 
51
 
 
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.
 
55
        """
 
56
        if self.should_print:
 
57
            self._to_file.write('adding %s\n' % _quote(path))
 
58
        return None
 
59
 
 
60
    def skip_file(self, tree, path, kind, stat_value = None):
 
61
        """Test whether the given file should be skipped or not.
 
62
        
 
63
        The default action never skips. Note this is only called during
 
64
        recursive adds
 
65
        
 
66
        :param tree: The tree we are working in
 
67
        :param path: The path being added
 
68
        :param kind: The kind of object being added.
 
69
        :param stat: Stat result for this file, if available already
 
70
        :return bool. True if the file should be skipped (not added)
 
71
        """
 
72
        return False
 
73
 
 
74
 
 
75
class AddWithSkipLargeAction(AddAction):
 
76
    """A class that can decide to skip a file if it's considered too large"""
 
77
 
 
78
    _maxSize = None
 
79
 
 
80
    def skip_file(self, tree, path, kind, stat_value = None):
 
81
        if kind != 'file':
 
82
            return False
 
83
        opt_name = 'add.maximum_file_size'
 
84
        if self._maxSize is None:
 
85
            config = tree.get_config_stack()
 
86
            self._maxSize = config.get(opt_name)
 
87
        if stat_value is None:
 
88
            file_size = os.path.getsize(path);
 
89
        else:
 
90
            file_size = stat_value.st_size;
 
91
        if self._maxSize > 0 and file_size > self._maxSize:
 
92
            ui.ui_factory.show_warning(gettext(
 
93
                "skipping {0} (larger than {1} of {2} bytes)").format(
 
94
                path, opt_name,  self._maxSize))
 
95
            return True
 
96
        return False
 
97
 
 
98
 
 
99
class AddFromBaseAction(AddAction):
 
100
    """This class will try to extract file ids from another tree."""
 
101
 
 
102
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
 
103
        super(AddFromBaseAction, self).__init__(to_file=to_file,
 
104
                                                should_print=should_print)
 
105
        self.base_tree = base_tree
 
106
        self.base_path = base_path
 
107
 
 
108
    def __call__(self, inv, parent_ie, path, kind):
 
109
        # Place the parent call
 
110
        # Now check to see if we can extract an id for this file
 
111
        file_id, base_path = self._get_base_file_id(path, parent_ie)
 
112
        if file_id is not None:
 
113
            if self.should_print:
 
114
                self._to_file.write('adding %s w/ file id from %s\n'
 
115
                                    % (path, base_path))
 
116
        else:
 
117
            # we aren't doing anything special, so let the default
 
118
            # reporter happen
 
119
            file_id = super(AddFromBaseAction, self).__call__(
 
120
                        inv, parent_ie, path, kind)
 
121
        return file_id
 
122
 
 
123
    def _get_base_file_id(self, path, parent_ie):
 
124
        """Look for a file id in the base branch.
 
125
 
 
126
        First, if the base tree has the parent directory,
 
127
        we look for a file with the same name in that directory.
 
128
        Else, we look for an entry in the base tree with the same path.
 
129
        """
 
130
 
 
131
        if self.base_tree.has_id(parent_ie.file_id):
 
132
            # FIXME: Handle nested trees
 
133
            base_parent_ie = self.base_tree.root_inventory[parent_ie.file_id]
 
134
            base_child_ie = base_parent_ie.children.get(
 
135
                osutils.basename(path))
 
136
            if base_child_ie is not None:
 
137
                return (base_child_ie.file_id,
 
138
                        self.base_tree.id2path(base_child_ie.file_id))
 
139
        full_base_path = osutils.pathjoin(self.base_path, path)
 
140
        # This may return None, but it is our last attempt
 
141
        return self.base_tree.path2id(full_base_path), full_base_path