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