~bzr-pqm/bzr/bzr.dev

70 by mbp at sourcefrog
Prepare for smart recursive add.
1
# Copyright (C) 2005 Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
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
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
17
from os.path import dirname
18
19
import bzrlib.errors as errors
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
20
from bzrlib.inventory import InventoryEntry
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
21
from bzrlib.trace import mutter, note, warning
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
22
from bzrlib.errors import NotBranchError
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
23
from bzrlib.workingtree import is_control_file
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
24
import bzrlib.osutils
25
from bzrlib.workingtree import WorkingTree
70 by mbp at sourcefrog
Prepare for smart recursive add.
26
686 by Martin Pool
- glob expand add arguments on win32
27
def glob_expand_for_win32(file_list):
1185.23.2 by Aaron Bentley
win32 glob expansion fix from Belchenko
28
    if not file_list:
29
        return
686 by Martin Pool
- glob expand add arguments on win32
30
    import glob
31
    expanded_file_list = []
32
    for possible_glob in file_list:
33
        glob_files = glob.glob(possible_glob)
34
       
35
        if glob_files == []:
36
            # special case to let the normal code path handle
37
            # files that do not exists
38
            expanded_file_list.append(possible_glob)
39
        else:
40
            expanded_file_list += glob_files
41
    return expanded_file_list
42
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
43
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
44
def _prepare_file_list(file_list):
45
    """Prepare a file list for use by smart_add_*."""
46
    import sys
47
    if sys.platform == 'win32':
48
        file_list = glob_expand_for_win32(file_list)
49
    if not file_list:
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
50
        file_list = [u'.']
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
51
    file_list = list(file_list)
52
    return file_list
53
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
54
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
55
def add_action_null(inv, path, kind):
56
    """Absorb add actions and do nothing."""
57
    pass
58
59
def add_action_print(inv, path, kind):
60
    """Print a line to stdout for each file that would be added."""
61
    print "added", bzrlib.osutils.quotefn(path)
62
63
def add_action_add(inv, path, kind):
64
    """Add each file to the given inventory. Produce no output."""
65
    entry = inv.add_path(path, kind=kind)
66
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
67
1711.1.2 by Robert Collins
'bzr add' is now less verbose in telling you what ignore globs were
68
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
69
def add_action_add_and_print(inv, path, kind):
70
    """Add each file to the given inventory, and print a line to stdout."""
71
    add_action_add(inv, path, kind)
72
    add_action_print(inv, path, kind)
73
74
75
def smart_add(file_list, recurse=True, action=add_action_add):
598 by Martin Pool
doc
76
    """Add files to version, optionally recursing into directories.
70 by mbp at sourcefrog
Prepare for smart recursive add.
77
78
    This is designed more towards DWIM for humans than API simplicity.
79
    For the specific behaviour see the help for cmd_add().
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
80
81
    Returns the number of files added.
70 by mbp at sourcefrog
Prepare for smart recursive add.
82
    """
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
83
    file_list = _prepare_file_list(file_list)
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
84
    tree = WorkingTree.open_containing(file_list[0])[0]
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
85
    return smart_add_tree(tree, file_list, recurse, action)
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
86
1711.1.2 by Robert Collins
'bzr add' is now less verbose in telling you what ignore globs were
87
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
88
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
89
    """Add files to version, optionally recursing into directories.
90
91
    This is designed more towards DWIM for humans than API simplicity.
92
    For the specific behaviour see the help for cmd_add().
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
93
1508.1.11 by Robert Collins
Documentation.
94
    This calls reporter with each (path, kind, file_id) of added files.
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
95
96
    Returns the number of files added.
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
97
    """
1185.56.2 by Michael Ellerman
Raise NoSuchFile when someone tries to add a non-existant file.
98
    import os, errno
599 by Martin Pool
- better error reporting from smart_add
99
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
100
    assert isinstance(recurse, bool)
101
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
102
    file_list = _prepare_file_list(file_list)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
103
    user_list = file_list[:]
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
104
    inv = tree.read_working_inventory()
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
105
    added = []
106
    ignored = {}
86 by mbp at sourcefrog
first cut at recursive add
107
70 by mbp at sourcefrog
Prepare for smart recursive add.
108
    for f in file_list:
1457.1.4 by Robert Collins
Branch.relpath has been moved to WorkingTree.relpath.
109
        rf = tree.relpath(f)
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
110
        af = tree.abspath(rf)
510 by Martin Pool
- fix add of files when standing in subdirectory
111
1185.56.2 by Michael Ellerman
Raise NoSuchFile when someone tries to add a non-existant file.
112
        try:
113
            kind = bzrlib.osutils.file_kind(af)
114
        except OSError, e:
115
            if hasattr(e, 'errno') and e.errno == errno.ENOENT:
116
                raise errors.NoSuchFile(rf)
117
            raise
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
118
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
119
        if not InventoryEntry.versionable_kind(kind):
599 by Martin Pool
- better error reporting from smart_add
120
            if f in user_list:
121
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
122
            else:
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
123
                warning("skipping %s (can't add file of kind '%s')", f, kind)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
124
                continue
125
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
126
        mutter("smart add of %r, abs=%r", f, af)
70 by mbp at sourcefrog
Prepare for smart recursive add.
127
        
1534.5.5 by Robert Collins
Move is_control_file into WorkingTree.is_control_filename and test.
128
        if tree.is_control_filename(af):
599 by Martin Pool
- better error reporting from smart_add
129
            raise ForbiddenFileError('cannot add control file %s' % f)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
130
            
86 by mbp at sourcefrog
first cut at recursive add
131
        versioned = (inv.path2id(rf) != None)
132
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
133
        if kind == 'directory':
134
            try:
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
135
                sub_branch = WorkingTree.open(af)
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
136
                sub_tree = True
137
            except NotBranchError:
138
                sub_tree = False
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
139
            except errors.UnsupportedFormatError:
140
                sub_tree = True
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
141
        else:
142
            sub_tree = False
143
91 by mbp at sourcefrog
special handling of root directory for recursive add
144
        if rf == '':
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
145
            mutter("tree root doesn't need to be added")
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
146
            sub_tree = False
91 by mbp at sourcefrog
special handling of root directory for recursive add
147
        elif versioned:
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
148
            mutter("%r is already versioned", f)
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
149
        elif sub_tree:
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
150
            mutter("%r is a bzr tree", f)
70 by mbp at sourcefrog
Prepare for smart recursive add.
151
        else:
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
152
            added.extend(__add_one(tree, inv, rf, kind, action))
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
153
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
154
        if kind == 'directory' and recurse and not sub_tree:
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
155
            for subf in os.listdir(af):
1185.31.32 by John Arbash Meinel
Updated the bzr sourcecode to use bzrlib.osutils.pathjoin rather than os.path.join to enforce internal use of / instead of \
156
                subp = bzrlib.osutils.pathjoin(rf, subf)
1534.5.5 by Robert Collins
Move is_control_file into WorkingTree.is_control_filename and test.
157
                if tree.is_control_filename(subp):
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
158
                    mutter("skip control directory %r", subp)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
159
                else:
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
160
                    ignore_glob = tree.is_ignored(subp)
161
                    if ignore_glob is not None:
162
                        mutter("skip ignored sub-file %r", subp)
163
                        if ignore_glob not in ignored:
164
                            ignored[ignore_glob] = []
165
                        ignored[ignore_glob].append(subp)
166
                    else:
167
                        mutter("queue to add sub-file %r", subp)
168
                        file_list.append(tree.abspath(subp))
169
170
    mutter('added %d entries', len(added))
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
171
    
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
172
    if len(added) > 0:
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
173
        tree._write_inventory(inv)
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
174
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
175
    return added, ignored
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
176
1711.1.2 by Robert Collins
'bzr add' is now less verbose in telling you what ignore globs were
177
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
178
def __add_one(tree, inv, path, kind, action):
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
179
    """Add a file or directory, automatically add unversioned parents."""
180
181
    # Nothing to do if path is already versioned.
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
182
    # This is safe from infinite recursion because the tree root is
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
183
    # always versioned.
184
    if inv.path2id(path) != None:
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
185
        return []
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
186
187
    # add parent
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
188
    added = __add_one(tree, inv, dirname(path), 'directory', action)
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
189
    action(inv, path, kind)
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
190
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
191
    return added + [path]