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