16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from shutil import copyfile
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
19
from cStringIO import StringIO
21
from ntpath import (abspath as _nt_abspath,
23
normpath as _nt_normpath,
24
realpath as _nt_realpath,
27
from os import listdir
32
from shutil import copyfile
34
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
35
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
36
44
from bzrlib.errors import (BzrError,
42
from bzrlib.symbol_versioning import *
50
from bzrlib.symbol_versioning import (deprecated_function,
43
52
from bzrlib.trace import mutter
44
import bzrlib.win32console
47
55
def make_readonly(filename):
85
95
stat.S_IFLNK:'symlink',
86
96
stat.S_IFSOCK:'socket',
88
def file_kind(f, _formats=_formats, _unknown='unknown', _lstat=os.lstat):
100
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
101
"""Generate a file kind from a stat mode. This is used in walkdirs.
103
Its performance is critical: Do not mutate without careful benchmarking.
90
return _formats[_lstat(f).st_mode & 0170000]
106
return _formats[stat_mode & 0170000]
111
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
113
return _mapper(_lstat(f).st_mode)
115
if getattr(e, 'errno', None) == errno.ENOENT:
116
raise bzrlib.errors.NoSuchFile(f)
95
120
def kind_marker(kind):
96
121
if kind == 'file':
98
elif kind == 'directory':
123
elif kind == _directory_kind:
100
125
elif kind == 'symlink':
173
198
rename_func(tmp_name, new)
201
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
202
# choke on a Unicode string containing a relative path if
203
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
205
_fs_enc = sys.getfilesystemencoding()
206
def _posix_abspath(path):
207
# jam 20060426 rather than encoding to fsencoding
208
# copy posixpath.abspath, but use os.getcwdu instead
209
if not posixpath.isabs(path):
210
path = posixpath.join(getcwd(), path)
211
return posixpath.normpath(path)
214
def _posix_realpath(path):
215
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
218
def _win32_abspath(path):
219
# Real _nt_abspath doesn't have a problem with a unicode cwd
220
return _nt_abspath(unicode(path)).replace('\\', '/')
223
def _win32_realpath(path):
224
# Real _nt_realpath doesn't have a problem with a unicode cwd
225
return _nt_realpath(unicode(path)).replace('\\', '/')
228
def _win32_pathjoin(*args):
229
return _nt_join(*args).replace('\\', '/')
232
def _win32_normpath(path):
233
return _nt_normpath(unicode(path)).replace('\\', '/')
237
return os.getcwdu().replace('\\', '/')
240
def _win32_mkdtemp(*args, **kwargs):
241
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
244
def _win32_rename(old, new):
245
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
175
248
# Default is to just use the python builtins, but these can be rebound on
176
249
# particular platforms.
177
abspath = os.path.abspath
178
realpath = os.path.realpath
250
abspath = _posix_abspath
251
realpath = _posix_realpath
179
252
pathjoin = os.path.join
180
253
normpath = os.path.normpath
181
254
getcwd = os.getcwdu
188
261
MIN_ABS_PATHLENGTH = 1
190
if os.name == "posix":
191
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
192
# choke on a Unicode string containing a relative path if
193
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
195
_fs_enc = sys.getfilesystemencoding()
197
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
200
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
202
264
if sys.platform == 'win32':
203
# We need to use the Unicode-aware os.path.abspath and
204
# os.path.realpath on Windows systems.
206
return os.path.abspath(path).replace('\\', '/')
209
return os.path.realpath(path).replace('\\', '/')
212
return os.path.join(*args).replace('\\', '/')
215
return os.path.normpath(path).replace('\\', '/')
218
return os.getcwdu().replace('\\', '/')
220
def mkdtemp(*args, **kwargs):
221
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
223
def rename(old, new):
224
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
265
abspath = _win32_abspath
266
realpath = _win32_realpath
267
pathjoin = _win32_pathjoin
268
normpath = _win32_normpath
269
getcwd = _win32_getcwd
270
mkdtemp = _win32_mkdtemp
271
rename = _win32_rename
226
273
MIN_ABS_PATHLENGTH = 3
243
290
return shutil.rmtree(path, ignore_errors, onerror)
293
def get_terminal_encoding():
294
"""Find the best encoding for printing to the screen.
296
This attempts to check both sys.stdout and sys.stdin to see
297
what encoding they are in, and if that fails it falls back to
298
bzrlib.user_encoding.
299
The problem is that on Windows, locale.getpreferredencoding()
300
is not the same encoding as that used by the console:
301
http://mail.python.org/pipermail/python-list/2003-May/162357.html
303
On my standard US Windows XP, the preferred encoding is
304
cp1252, but the console is cp437
306
output_encoding = getattr(sys.stdout, 'encoding', None)
307
if not output_encoding:
308
input_encoding = getattr(sys.stdin, 'encoding', None)
309
if not input_encoding:
310
output_encoding = bzrlib.user_encoding
311
mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
313
output_encoding = input_encoding
314
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
316
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
317
return output_encoding
246
320
def normalizepath(f):
247
321
if hasattr(os.path, 'realpath'):
428
def is_inside_or_parent_of_any(dir_list, fname):
429
"""True if fname is a child or a parent of any of the given files."""
430
for dirname in dir_list:
431
if is_inside(dirname, fname) or is_inside(fname, dirname):
354
437
def pumpfile(fromfile, tofile):
355
438
"""Copy contents of one file to another."""
666
748
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
751
_platform_normalizes_filenames = False
752
if sys.platform == 'darwin':
753
_platform_normalizes_filenames = True
756
def normalizes_filenames():
757
"""Return True if this platform normalizes unicode filenames.
759
Mac OSX does, Windows/Linux do not.
761
return _platform_normalizes_filenames
764
if _platform_normalizes_filenames:
765
def unicode_filename(path):
766
"""Make sure 'path' is a properly normalized filename.
768
On platforms where the system normalizes filenames (Mac OSX),
769
you can access a file by any path which will normalize
771
Internally, bzr only supports NFC/NFKC normalization, since
772
that is the standard for XML documents.
773
So we return an normalized path, and indicate this has been
776
:return: (path, is_normalized) Return a path which can
777
access the file, and whether or not this path is
780
return unicodedata.normalize('NFKC', path), True
782
def unicode_filename(path):
783
"""Make sure 'path' is a properly normalized filename.
785
On platforms where the system does not normalize filenames
786
(Windows, Linux), you have to access a file by its exact path.
787
Internally, bzr only supports NFC/NFKC normalization, since
788
that is the standard for XML documents.
789
So we return the original path, and indicate if this is
792
:return: (path, is_normalized) Return a path which can
793
access the file, and whether or not this path is
796
return path, unicodedata.normalize('NFKC', path) == path
669
799
def terminal_width():
670
800
"""Return estimated terminal width."""
671
801
if sys.platform == 'win32':
693
823
return sys.platform != "win32"
696
def strip_trailing_slash(path):
697
"""Strip trailing slash, except for root paths.
698
The definition of 'root path' is platform-dependent.
700
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
706
826
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
716
836
if _validWin32PathRE.match(path) is None:
717
837
raise IllegalPath(path)
840
def walkdirs(top, prefix=""):
841
"""Yield data about all the directories in a tree.
843
This yields all the data about the contents of a directory at a time.
844
After each directory has been yielded, if the caller has mutated the list
845
to exclude some directories, they are then not descended into.
847
The data yielded is of the form:
848
[(relpath, basename, kind, lstat, path_from_top), ...]
850
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
851
allows one to walk a subtree but get paths that are relative to a tree
853
:return: an iterator over the dirs.
857
_directory = _directory_kind
859
pending = [(prefix, "", _directory, None, top)]
862
currentdir = pending.pop()
863
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
866
relroot = currentdir[0] + '/'
869
for name in sorted(_listdir(top)):
870
abspath = top + '/' + name
871
statvalue = lstat(abspath)
872
dirblock.append ((relroot + name, name, file_kind_from_stat_mode(statvalue.st_mode), statvalue, abspath))
874
# push the user specified dirs from dirblock
875
for dir in reversed(dirblock):
876
if dir[2] == _directory:
880
def path_prefix_key(path):
881
"""Generate a prefix-order path key for path.
883
This can be used to sort paths in the same way that walkdirs does.
885
return (dirname(path) , path)
888
def compare_paths_prefix_order(path_a, path_b):
889
"""Compare path_a and path_b to generate the same order walkdirs uses."""
890
key_a = path_prefix_key(path_a)
891
key_b = path_prefix_key(path_b)
892
return cmp(key_a, key_b)