← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-13 00:26:41 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101013002641-9tlh9k89mlj1666m
Keep docs-plain working.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
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
 
    user_list = file_list[:]
32
 
    assert not isinstance(file_list, basestring)
33
 
    b = bzrlib.branch.Branch(file_list[0], find_root=True)
34
 
    inv = b.read_working_inventory()
35
 
    tree = b.working_tree()
36
 
    count = 0
37
 
 
38
 
    for f in file_list:
39
 
        rf = b.relpath(f)
40
 
        af = b.abspath(rf)
41
 
 
42
 
        kind = bzrlib.osutils.file_kind(af)
43
 
 
44
 
        if kind != 'file' and kind != 'directory':
45
 
            if f not in user_list:
46
 
                print "Skipping %s (can't add file of kind '%s')" % (f, kind)
47
 
                continue
48
 
            bailout("can't add file of kind %r" % kind)
49
 
 
50
 
        bzrlib.mutter("smart add of %r, abs=%r" % (f, af))
51
 
        
52
 
        if bzrlib.branch.is_control_file(af):
53
 
            bailout("cannot add control file %r" % af)
54
 
            
55
 
        versioned = (inv.path2id(rf) != None)
56
 
 
57
 
        if rf == '':
58
 
            mutter("branch root doesn't need to be added")
59
 
        elif versioned:
60
 
            mutter("%r is already versioned" % f)
 
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
import sys
 
20
 
 
21
import bzrlib.osutils
 
22
 
 
23
 
 
24
class AddAction(object):
 
25
    """A class which defines what action to take when adding a file."""
 
26
 
 
27
    def __init__(self, to_file=None, should_print=None):
 
28
        """Initialize an action which prints added files to an output stream.
 
29
 
 
30
        :param to_file: The stream to write into. This is expected to take
 
31
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
 
32
        :param should_print: If False, printing will be suppressed.
 
33
        """
 
34
        self._to_file = to_file
 
35
        if to_file is None:
 
36
            self._to_file = sys.stdout
 
37
        self.should_print = False
 
38
        if should_print is not None:
 
39
            self.should_print = should_print
 
40
 
 
41
    def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
 
42
        """Add path to inventory.
 
43
 
 
44
        The default action does nothing.
 
45
 
 
46
        :param inv: The inventory we are working with.
 
47
        :param path: The FastPath being added
 
48
        :param kind: The kind of the object being added.
 
49
        """
 
50
        if self.should_print:
 
51
            self._to_file.write('adding %s\n' % _quote(path.raw_path))
 
52
        return None
 
53
 
 
54
 
 
55
class AddFromBaseAction(AddAction):
 
56
    """This class will try to extract file ids from another tree."""
 
57
 
 
58
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
 
59
        super(AddFromBaseAction, self).__init__(to_file=to_file,
 
60
                                                should_print=should_print)
 
61
        self.base_tree = base_tree
 
62
        self.base_path = base_path
 
63
 
 
64
    def __call__(self, inv, parent_ie, path, kind):
 
65
        # Place the parent call
 
66
        # Now check to see if we can extract an id for this file
 
67
        file_id, base_path = self._get_base_file_id(path, parent_ie)
 
68
        if file_id is not None:
 
69
            if self.should_print:
 
70
                self._to_file.write('adding %s w/ file id from %s\n'
 
71
                                    % (path.raw_path, base_path))
61
72
        else:
62
 
            file_id = bzrlib.branch.gen_file_id(rf)
63
 
            inv.add_path(rf, kind=kind, file_id=file_id)
64
 
            bzrlib.mutter("added %r kind %r file_id={%s}" % (rf, kind, file_id))
65
 
            count += 1 
66
 
            if verbose:
67
 
                bzrlib.textui.show_status('A', kind, quotefn(f))
68
 
 
69
 
        if kind == 'directory' and recurse:
70
 
            for subf in os.listdir(af):
71
 
                subp = appendpath(rf, subf)
72
 
                if subf == bzrlib.BZRDIR:
73
 
                    mutter("skip control directory %r" % subp)
74
 
                elif tree.is_ignored(subp):
75
 
                    mutter("skip ignored sub-file %r" % subp)
76
 
                else:
77
 
                    mutter("queue to add sub-file %r" % subp)
78
 
                    file_list.append(b.abspath(subp))
79
 
 
80
 
    if count > 0:
81
 
        if verbose:
82
 
            note('added %d' % count)
83
 
        b._write_inventory(inv)
 
73
            # we aren't doing anything special, so let the default
 
74
            # reporter happen
 
75
            file_id = super(AddFromBaseAction, self).__call__(
 
76
                        inv, parent_ie, path, kind)
 
77
        return file_id
 
78
 
 
79
    def _get_base_file_id(self, path, parent_ie):
 
80
        """Look for a file id in the base branch.
 
81
 
 
82
        First, if the base tree has the parent directory,
 
83
        we look for a file with the same name in that directory.
 
84
        Else, we look for an entry in the base tree with the same path.
 
85
        """
 
86
 
 
87
        if (parent_ie.file_id in self.base_tree):
 
88
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
 
89
            base_child_ie = base_parent_ie.children.get(path.base_path)
 
90
            if base_child_ie is not None:
 
91
                return (base_child_ie.file_id,
 
92
                        self.base_tree.id2path(base_child_ie.file_id))
 
93
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
 
94
        # This may return None, but it is our last attempt
 
95
        return self.base_tree.path2id(full_base_path), full_base_path