~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
23
from bzrlib.branch import Branch
1139 by Martin Pool
- merge in merge improvements and additional tests
24
from bzrlib.osutils import quotefn
70 by mbp at sourcefrog
Prepare for smart recursive add.
25
686 by Martin Pool
- glob expand add arguments on win32
26
def glob_expand_for_win32(file_list):
27
    import glob
28
    expanded_file_list = []
29
    for possible_glob in file_list:
30
        glob_files = glob.glob(possible_glob)
31
       
32
        if glob_files == []:
33
            # special case to let the normal code path handle
34
            # files that do not exists
35
            expanded_file_list.append(possible_glob)
36
        else:
37
            expanded_file_list += glob_files
38
    return expanded_file_list
39
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
40
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
41
def add_reporter_null(path, kind, entry):
42
    """Absorb add reports and do nothing."""
1092.1.30 by Robert Collins
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry
43
    pass
44
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
45
def add_reporter_print(path, kind, entry):
46
    """Print a line to stdout for each file that's added."""
1139 by Martin Pool
- merge in merge improvements and additional tests
47
    print "added", quotefn(path)
1092.1.30 by Robert Collins
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry
48
    
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
49
def _prepare_file_list(file_list):
50
    """Prepare a file list for use by smart_add_*."""
51
    import sys
52
    if sys.platform == 'win32':
53
        file_list = glob_expand_for_win32(file_list)
54
    if not file_list:
55
        file_list = ['.']
56
    file_list = list(file_list)
57
    return file_list
58
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
59
60
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
598 by Martin Pool
doc
61
    """Add files to version, optionally recursing into directories.
70 by mbp at sourcefrog
Prepare for smart recursive add.
62
63
    This is designed more towards DWIM for humans than API simplicity.
64
    For the specific behaviour see the help for cmd_add().
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
65
66
    Returns the number of files added.
70 by mbp at sourcefrog
Prepare for smart recursive add.
67
    """
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
68
    file_list = _prepare_file_list(file_list)
1442.1.64 by Robert Collins
Branch.open_containing now returns a tuple (Branch, relative-path).
69
    b = Branch.open_containing(file_list[0])[0]
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
70
    return smart_add_branch(b, file_list, recurse, reporter)
71
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
72
        
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
73
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
74
    """Add files to version, optionally recursing into directories.
75
76
    This is designed more towards DWIM for humans than API simplicity.
77
    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
78
79
    This yields a sequence of (path, kind, file_id) for added files.
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
80
81
    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
82
    """
974 by Martin Pool
- start adding tests for commit in subdir
83
    import os
599 by Martin Pool
- better error reporting from smart_add
84
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
974 by Martin Pool
- start adding tests for commit in subdir
85
    import bzrlib.branch
599 by Martin Pool
- better error reporting from smart_add
86
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
87
    assert isinstance(recurse, bool)
88
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
89
    file_list = _prepare_file_list(file_list)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
90
    user_list = file_list[:]
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
91
    inv = branch.read_working_inventory()
92
    tree = branch.working_tree()
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
93
    count = 0
86 by mbp at sourcefrog
first cut at recursive add
94
70 by mbp at sourcefrog
Prepare for smart recursive add.
95
    for f in file_list:
1457.1.4 by Robert Collins
Branch.relpath has been moved to WorkingTree.relpath.
96
        rf = tree.relpath(f)
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
97
        af = branch.abspath(rf)
510 by Martin Pool
- fix add of files when standing in subdirectory
98
99
        kind = bzrlib.osutils.file_kind(af)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
100
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
101
        if not InventoryEntry.versionable_kind(kind):
599 by Martin Pool
- better error reporting from smart_add
102
            if f in user_list:
103
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
104
            else:
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
105
                warning("skipping %s (can't add file of kind '%s')", f, kind)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
106
                continue
107
800 by Martin Pool
Merge John's import-speedup branch:
108
        mutter("smart add of %r, abs=%r" % (f, af))
70 by mbp at sourcefrog
Prepare for smart recursive add.
109
        
110
        if bzrlib.branch.is_control_file(af):
599 by Martin Pool
- better error reporting from smart_add
111
            raise ForbiddenFileError('cannot add control file %s' % f)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
112
            
86 by mbp at sourcefrog
first cut at recursive add
113
        versioned = (inv.path2id(rf) != None)
114
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
115
        if kind == 'directory':
116
            try:
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
117
                sub_branch = Branch.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
118
                sub_tree = True
119
            except NotBranchError:
120
                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
121
            except errors.UnsupportedFormatError:
122
                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
123
        else:
124
            sub_tree = False
125
91 by mbp at sourcefrog
special handling of root directory for recursive add
126
        if rf == '':
127
            mutter("branch 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
128
            sub_tree = False
91 by mbp at sourcefrog
special handling of root directory for recursive add
129
        elif versioned:
88 by mbp at sourcefrog
smart_add: no warning for already-added files
130
            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
131
        elif sub_tree:
132
            mutter("%r is a bzr tree" %f)
70 by mbp at sourcefrog
Prepare for smart recursive add.
133
        else:
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
134
            count += __add_one(branch, inv, rf, kind, reporter)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
135
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
        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
137
            for subf in os.listdir(af):
597 by Martin Pool
- tidy up add code
138
                subp = os.path.join(rf, subf)
103 by mbp at sourcefrog
Skip control directories in recursive add
139
                if subf == bzrlib.BZRDIR:
140
                    mutter("skip control directory %r" % subp)
141
                elif tree.is_ignored(subp):
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
142
                    mutter("skip ignored sub-file %r" % subp)
143
                else:
510 by Martin Pool
- fix add of files when standing in subdirectory
144
                    mutter("queue to add sub-file %r" % subp)
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
145
                    file_list.append(branch.abspath(subp))
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
146
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
147
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
148
    mutter('added %d entries', count)
149
    
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
150
    if count > 0:
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
151
        branch._write_inventory(inv)
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
152
153
    return count
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
154
155
def __add_one(branch, inv, path, kind, reporter):
156
    """Add a file or directory, automatically add unversioned parents."""
157
158
    # Nothing to do if path is already versioned.
159
    # This is safe from infinite recursion because the branch root is
160
    # always versioned.
161
    if inv.path2id(path) != None:
162
        return 0
163
164
    # add parent
165
    count = __add_one(branch, inv, dirname(path), 'directory', reporter)
166
167
    entry = inv.add_path(path, kind=kind)
168
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
169
    reporter(path, kind, entry)
170
171
    return count + 1