1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
11
# GNU General Public License for more details.
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
import os, types, re, time, errno, sys
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from bzrlib.errors import BzrError
17
from cStringIO import StringIO
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
22
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
29
from datetime import datetime
31
from ntpath import (abspath as _nt_abspath,
33
normpath as _nt_normpath,
34
realpath as _nt_realpath,
35
splitdrive as _nt_splitdrive,
44
from tempfile import (
58
from bzrlib import symbol_versioning
59
from bzrlib.symbol_versioning import (
23
62
from bzrlib.trace import mutter
65
# On win32, O_BINARY is used to indicate the file should
66
# be opened in binary mode, rather than text mode.
67
# On other platforms, O_BINARY doesn't exist, because
68
# they always open in binary mode, so it is okay to
69
# OR with 0 on those platforms
70
O_BINARY = getattr(os, 'O_BINARY', 0)
26
73
def make_readonly(filename):
27
74
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
mod = os.stat(filename).st_mode
31
os.chmod(filename, mod)
75
mod = os.lstat(filename).st_mode
76
if not stat.S_ISLNK(mod):
78
os.chmod(filename, mod)
34
81
def make_writable(filename):
35
mod = os.stat(filename).st_mode
37
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
82
mod = os.lstat(filename).st_mode
83
if not stat.S_ISLNK(mod):
85
os.chmod(filename, mod)
88
def minimum_path_selection(paths):
89
"""Return the smallset subset of paths which are outside paths.
91
:param paths: A container (and hence not None) of paths.
92
:return: A set of paths sufficient to include everything in paths via
93
is_inside_any, drawn from the paths parameter.
98
other_paths = paths.difference([path])
99
if not is_inside_any(other_paths, path):
100
# this is a top level path, we must check it.
101
search_paths.add(path)
42
"""Return shell-quoted filename"""
43
## We could be a bit more terse by using double-quotes etc
44
f = _QUOTE_RE.sub(r'\\\1', f)
51
mode = os.lstat(f)[ST_MODE]
109
"""Return a quoted filename filename
111
This previously used backslash quoting, but that works poorly on
113
# TODO: I'm not really sure this is the best format either.x
115
if _QUOTE_RE is None:
116
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
118
if _QUOTE_RE.search(f):
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
124
_directory_kind = 'directory'
127
stat.S_IFDIR:_directory_kind,
128
stat.S_IFCHR:'chardev',
129
stat.S_IFBLK:'block',
132
stat.S_IFLNK:'symlink',
133
stat.S_IFSOCK:'socket',
137
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
138
"""Generate a file kind from a stat mode. This is used in walkdirs.
140
Its performance is critical: Do not mutate without careful benchmarking.
143
return _formats[stat_mode & 0170000]
148
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
150
return _mapper(_lstat(f).st_mode)
152
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
153
raise errors.NoSuchFile(f)
158
"""Return the current umask"""
159
# Assume that people aren't messing with the umask while running
160
# XXX: This is not thread safe, but there is no way to get the
161
# umask without setting it
169
_directory_kind: "/",
171
'tree-reference': '+',
62
175
def kind_marker(kind):
65
elif kind == 'directory':
67
elif kind == 'symlink':
70
raise BzrError('invalid file kind %r' % kind)
177
return _kind_marker_map[kind]
179
raise errors.BzrError('invalid file kind %r' % kind)
182
lexists = getattr(os.path, 'lexists', None)
186
stat = getattr(os, 'lstat', os.stat)
190
if e.errno == errno.ENOENT:
193
raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
196
def fancy_rename(old, new, rename_func, unlink_func):
197
"""A fancy rename, when you don't have atomic rename.
199
:param old: The old path, to rename from
200
:param new: The new path, to rename to
201
:param rename_func: The potentially non-atomic rename function
202
:param unlink_func: A way to delete the target file if the full rename succeeds
205
# sftp rename doesn't allow overwriting, so play tricks:
207
base = os.path.basename(new)
208
dirname = os.path.dirname(new)
209
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
210
tmp_name = pathjoin(dirname, tmp_name)
212
# Rename the file out of the way, but keep track if it didn't exist
213
# We don't want to grab just any exception
214
# something like EACCES should prevent us from continuing
215
# The downside is that the rename_func has to throw an exception
216
# with an errno = ENOENT, or NoSuchFile
219
rename_func(new, tmp_name)
220
except (errors.NoSuchFile,), e:
223
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
224
# function raises an IOError with errno is None when a rename fails.
225
# This then gets caught here.
226
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
229
if (getattr(e, 'errno', None) is None
230
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
238
# This may throw an exception, in which case success will
240
rename_func(old, new)
242
except (IOError, OSError), e:
243
# source and target may be aliases of each other (e.g. on a
244
# case-insensitive filesystem), so we may have accidentally renamed
245
# source by when we tried to rename target
246
if not (file_existed and e.errno in (None, errno.ENOENT)):
250
# If the file used to exist, rename it back into place
251
# otherwise just delete it from the tmp location
253
unlink_func(tmp_name)
255
rename_func(tmp_name, new)
258
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
259
# choke on a Unicode string containing a relative path if
260
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
262
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
263
def _posix_abspath(path):
264
# jam 20060426 rather than encoding to fsencoding
265
# copy posixpath.abspath, but use os.getcwdu instead
266
if not posixpath.isabs(path):
267
path = posixpath.join(getcwd(), path)
268
return posixpath.normpath(path)
271
def _posix_realpath(path):
272
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
275
def _win32_fixdrive(path):
276
"""Force drive letters to be consistent.
278
win32 is inconsistent whether it returns lower or upper case
279
and even if it was consistent the user might type the other
280
so we force it to uppercase
281
running python.exe under cmd.exe return capital C:\\
282
running win32 python inside a cygwin shell returns lowercase c:\\
284
drive, path = _nt_splitdrive(path)
285
return drive.upper() + path
288
def _win32_abspath(path):
289
# Real _nt_abspath doesn't have a problem with a unicode cwd
290
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
293
def _win98_abspath(path):
294
"""Return the absolute version of a path.
295
Windows 98 safe implementation (python reimplementation
296
of Win32 API function GetFullPathNameW)
301
# \\HOST\path => //HOST/path
302
# //HOST/path => //HOST/path
303
# path => C:/cwd/path
306
# check for absolute path
307
drive = _nt_splitdrive(path)[0]
308
if drive == '' and path[:2] not in('//','\\\\'):
310
# we cannot simply os.path.join cwd and path
311
# because os.path.join('C:','/path') produce '/path'
312
# and this is incorrect
313
if path[:1] in ('/','\\'):
314
cwd = _nt_splitdrive(cwd)[0]
316
path = cwd + '\\' + path
317
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
319
if win32utils.winver == 'Windows 98':
320
_win32_abspath = _win98_abspath
323
def _win32_realpath(path):
324
# Real _nt_realpath doesn't have a problem with a unicode cwd
325
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
328
def _win32_pathjoin(*args):
329
return _nt_join(*args).replace('\\', '/')
332
def _win32_normpath(path):
333
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
337
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
340
def _win32_mkdtemp(*args, **kwargs):
341
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
344
def _win32_rename(old, new):
345
"""We expect to be able to atomically replace 'new' with old.
347
On win32, if new exists, it must be moved out of the way first,
351
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
353
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
354
# If we try to rename a non-existant file onto cwd, we get
355
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
356
# if the old path doesn't exist, sometimes we get EACCES
357
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
363
return unicodedata.normalize('NFC', os.getcwdu())
366
# Default is to just use the python builtins, but these can be rebound on
367
# particular platforms.
368
abspath = _posix_abspath
369
realpath = _posix_realpath
370
pathjoin = os.path.join
371
normpath = os.path.normpath
374
dirname = os.path.dirname
375
basename = os.path.basename
376
split = os.path.split
377
splitext = os.path.splitext
378
# These were already imported into local scope
379
# mkdtemp = tempfile.mkdtemp
380
# rmtree = shutil.rmtree
382
MIN_ABS_PATHLENGTH = 1
385
if sys.platform == 'win32':
386
abspath = _win32_abspath
387
realpath = _win32_realpath
388
pathjoin = _win32_pathjoin
389
normpath = _win32_normpath
390
getcwd = _win32_getcwd
391
mkdtemp = _win32_mkdtemp
392
rename = _win32_rename
394
MIN_ABS_PATHLENGTH = 3
396
def _win32_delete_readonly(function, path, excinfo):
397
"""Error handler for shutil.rmtree function [for win32]
398
Helps to remove files and dirs marked as read-only.
400
exception = excinfo[1]
401
if function in (os.remove, os.rmdir) \
402
and isinstance(exception, OSError) \
403
and exception.errno == errno.EACCES:
409
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
410
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
411
return shutil.rmtree(path, ignore_errors, onerror)
412
elif sys.platform == 'darwin':
416
def get_terminal_encoding():
417
"""Find the best encoding for printing to the screen.
419
This attempts to check both sys.stdout and sys.stdin to see
420
what encoding they are in, and if that fails it falls back to
421
bzrlib.user_encoding.
422
The problem is that on Windows, locale.getpreferredencoding()
423
is not the same encoding as that used by the console:
424
http://mail.python.org/pipermail/python-list/2003-May/162357.html
426
On my standard US Windows XP, the preferred encoding is
427
cp1252, but the console is cp437
429
output_encoding = getattr(sys.stdout, 'encoding', None)
430
if not output_encoding:
431
input_encoding = getattr(sys.stdin, 'encoding', None)
432
if not input_encoding:
433
output_encoding = bzrlib.user_encoding
434
mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
436
output_encoding = input_encoding
437
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
439
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
440
if output_encoding == 'cp0':
441
# invalid encoding (cp0 means 'no codepage' on Windows)
442
output_encoding = bzrlib.user_encoding
443
mutter('cp0 is invalid encoding.'
444
' encoding stdout as bzrlib.user_encoding %r', output_encoding)
447
codecs.lookup(output_encoding)
449
sys.stderr.write('bzr: warning:'
450
' unknown terminal encoding %s.\n'
451
' Using encoding %s instead.\n'
452
% (output_encoding, bzrlib.user_encoding)
454
output_encoding = bzrlib.user_encoding
456
return output_encoding
459
def normalizepath(f):
460
if getattr(os.path, 'realpath', None) is not None:
464
[p,e] = os.path.split(f)
465
if e == "" or e == "." or e == "..":
468
return pathjoin(F(p), e)
271
656
def local_time_offset(t=None):
272
657
"""Return offset of local zone from GMT, either at present or at time t."""
273
# python2.3 localtime() can't take None
277
if time.localtime(t).tm_isdst and time.daylight:
280
return -time.timezone
283
def format_date(t, offset=0, timezone='original'):
284
## TODO: Perhaps a global option to use either universal or local time?
285
## Or perhaps just let people set $TZ?
286
assert isinstance(t, float)
660
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
661
return offset.days * 86400 + offset.seconds
663
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
665
def format_date(t, offset=0, timezone='original', date_fmt=None,
667
"""Return a formatted date string.
669
:param t: Seconds since the epoch.
670
:param offset: Timezone offset in seconds east of utc.
671
:param timezone: How to display the time: 'utc', 'original' for the
672
timezone specified by offset, or 'local' for the process's current
674
:param show_offset: Whether to append the timezone.
675
:param date_fmt: strftime format.
288
677
if timezone == 'utc':
289
678
tt = time.gmtime(t)
291
680
elif timezone == 'original':
294
683
tt = time.gmtime(t + offset)
295
684
elif timezone == 'local':
296
685
tt = time.localtime(t)
297
686
offset = local_time_offset(t)
299
raise BzrError("unsupported timezone format %r",
300
['options are "utc", "original", "local"'])
302
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
303
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
688
raise errors.UnsupportedTimezoneFormat(timezone)
690
date_fmt = "%a %Y-%m-%d %H:%M:%S"
692
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
695
# day of week depends on locale, so we do this ourself
696
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
697
return (time.strftime(date_fmt, tt) + offset_str)
306
700
def compact_date(when):
307
701
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
704
def format_delta(delta):
705
"""Get a nice looking string for a time delta.
707
:param delta: The time difference in seconds, can be positive or negative.
708
positive indicates time in the past, negative indicates time in the
709
future. (usually time.time() - stored_time)
710
:return: String formatted to show approximate resolution
716
direction = 'in the future'
720
if seconds < 90: # print seconds up to 90 seconds
722
return '%d second %s' % (seconds, direction,)
724
return '%d seconds %s' % (seconds, direction)
726
minutes = int(seconds / 60)
727
seconds -= 60 * minutes
732
if minutes < 90: # print minutes, seconds up to 90 minutes
734
return '%d minute, %d second%s %s' % (
735
minutes, seconds, plural_seconds, direction)
737
return '%d minutes, %d second%s %s' % (
738
minutes, seconds, plural_seconds, direction)
740
hours = int(minutes / 60)
741
minutes -= 60 * hours
748
return '%d hour, %d minute%s %s' % (hours, minutes,
749
plural_minutes, direction)
750
return '%d hours, %d minute%s %s' % (hours, minutes,
751
plural_minutes, direction)
312
754
"""Return size of given open file."""
313
755
return os.fstat(f.fileno())[ST_SIZE]
316
if hasattr(os, 'urandom'): # python 2.4 and later
758
# Define rand_bytes based on platform.
760
# Python 2.4 and later have os.urandom,
761
# but it doesn't work on some arches
317
763
rand_bytes = os.urandom
318
elif sys.platform == 'linux2':
319
rand_bytes = file('/dev/urandom', 'rb').read
321
# not well seeded, but better than nothing
326
s += chr(random.randint(0, 255))
764
except (NotImplementedError, AttributeError):
765
# If python doesn't have os.urandom, or it doesn't work,
766
# then try to first pull random data from /dev/urandom
768
rand_bytes = file('/dev/urandom', 'rb').read
769
# Otherwise, use this hack as a last resort
770
except (IOError, OSError):
771
# not well seeded, but better than nothing
776
s += chr(random.randint(0, 255))
781
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
783
"""Return a random string of num alphanumeric characters
785
The result only contains lowercase chars because it may be used on
786
case-insensitive filesystems.
789
for raw_byte in rand_bytes(num):
790
s += ALNUM[ord(raw_byte) % 36]
331
794
## TODO: We could later have path objects that remember their list
332
795
## decomposition (might be too tricksy though.)
334
797
def splitpath(p):
335
"""Turn string into list of parts.
341
>>> splitpath('a/./b')
343
>>> splitpath('a/.b')
345
>>> splitpath('a/../b')
346
Traceback (most recent call last):
348
BzrError: sorry, '..' not allowed in path
350
assert isinstance(p, types.StringTypes)
798
"""Turn string into list of parts."""
352
799
# split on either delimiter because people might use either on
354
801
ps = re.split(r'[\\/]', p)
367
assert isinstance(p, list)
369
if (f == '..') or (f == None) or (f == ''):
370
raise BzrError("sorry, %r not allowed in path" % f)
371
return os.path.join(*p)
374
def appendpath(p1, p2):
378
return os.path.join(p1, p2)
381
def extern_command(cmd, ignore_errors = False):
382
mutter('external command: %s' % `cmd`)
384
if not ignore_errors:
385
raise BzrError('command failed')
815
if (f == '..') or (f is None) or (f == ''):
816
raise errors.BzrError("sorry, %r not allowed in path" % f)
821
"""Split s into lines, but without removing the newline characters."""
822
lines = s.split('\n')
823
result = [line + '\n' for line in lines[:-1]]
825
result.append(lines[-1])
829
def hardlinks_good():
830
return sys.platform not in ('win32', 'cygwin', 'darwin')
833
def link_or_copy(src, dest):
834
"""Hardlink a file, or copy it if it can't be hardlinked."""
835
if not hardlinks_good():
836
shutil.copyfile(src, dest)
840
except (OSError, IOError), e:
841
if e.errno != errno.EXDEV:
843
shutil.copyfile(src, dest)
846
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
847
# Forgiveness than Permission (EAFP) because:
848
# - root can damage a solaris file system by using unlink,
849
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
850
# EACCES, OSX: EPERM) when invoked on a directory.
851
def delete_any(path):
852
"""Delete a file or directory."""
853
if isdir(path): # Takes care of symlinks
860
if getattr(os, 'symlink', None) is not None:
867
if getattr(os, 'link', None) is not None:
873
def host_os_dereferences_symlinks():
874
return (has_symlinks()
875
and sys.platform not in ('cygwin', 'win32'))
878
def contains_whitespace(s):
879
"""True if there are any whitespace characters in s."""
880
# string.whitespace can include '\xa0' in certain locales, because it is
881
# considered "non-breaking-space" as part of ISO-8859-1. But it
882
# 1) Isn't a breaking whitespace
883
# 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
885
# 3) '\xa0' isn't unicode safe since it is >128.
887
# This should *not* be a unicode set of characters in case the source
888
# string is not a Unicode string. We can auto-up-cast the characters since
889
# they are ascii, but we don't want to auto-up-cast the string in case it
891
for ch in ' \t\n\r\v\f':
898
def contains_linebreaks(s):
899
"""True if there is any vertical whitespace in s."""
907
def relpath(base, path):
908
"""Return path relative to base, or raise exception.
910
The path may be either an absolute path or a path relative to the
911
current working directory.
913
os.path.commonprefix (python2.4) has a bad bug that it works just
914
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
918
if len(base) < MIN_ABS_PATHLENGTH:
919
# must have space for e.g. a drive letter
920
raise ValueError('%r is too short to calculate a relative path'
927
while len(head) >= len(base):
930
head, tail = os.path.split(head)
934
raise errors.PathNotChild(rp, base)
942
def safe_unicode(unicode_or_utf8_string):
943
"""Coerce unicode_or_utf8_string into unicode.
945
If it is unicode, it is returned.
946
Otherwise it is decoded from utf-8. If a decoding error
947
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
948
as a BzrBadParameter exception.
950
if isinstance(unicode_or_utf8_string, unicode):
951
return unicode_or_utf8_string
953
return unicode_or_utf8_string.decode('utf8')
954
except UnicodeDecodeError:
955
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
958
def safe_utf8(unicode_or_utf8_string):
959
"""Coerce unicode_or_utf8_string to a utf8 string.
961
If it is a str, it is returned.
962
If it is Unicode, it is encoded into a utf-8 string.
964
if isinstance(unicode_or_utf8_string, str):
965
# TODO: jam 20070209 This is overkill, and probably has an impact on
966
# performance if we are dealing with lots of apis that want a
969
# Make sure it is a valid utf-8 string
970
unicode_or_utf8_string.decode('utf-8')
971
except UnicodeDecodeError:
972
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
973
return unicode_or_utf8_string
974
return unicode_or_utf8_string.encode('utf-8')
977
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
978
' Revision id generators should be creating utf8'
982
def safe_revision_id(unicode_or_utf8_string, warn=True):
983
"""Revision ids should now be utf8, but at one point they were unicode.
985
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
987
:param warn: Functions that are sanitizing user data can set warn=False
988
:return: None or a utf8 revision id.
990
if (unicode_or_utf8_string is None
991
or unicode_or_utf8_string.__class__ == str):
992
return unicode_or_utf8_string
994
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
996
return cache_utf8.encode(unicode_or_utf8_string)
999
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1000
' generators should be creating utf8 file ids.')
1003
def safe_file_id(unicode_or_utf8_string, warn=True):
1004
"""File ids should now be utf8, but at one point they were unicode.
1006
This is the same as safe_utf8, except it uses the cached encode functions
1007
to save a little bit of performance.
1009
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1011
:param warn: Functions that are sanitizing user data can set warn=False
1012
:return: None or a utf8 file id.
1014
if (unicode_or_utf8_string is None
1015
or unicode_or_utf8_string.__class__ == str):
1016
return unicode_or_utf8_string
1018
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1020
return cache_utf8.encode(unicode_or_utf8_string)
1023
_platform_normalizes_filenames = False
1024
if sys.platform == 'darwin':
1025
_platform_normalizes_filenames = True
1028
def normalizes_filenames():
1029
"""Return True if this platform normalizes unicode filenames.
1031
Mac OSX does, Windows/Linux do not.
1033
return _platform_normalizes_filenames
1036
def _accessible_normalized_filename(path):
1037
"""Get the unicode normalized path, and if you can access the file.
1039
On platforms where the system normalizes filenames (Mac OSX),
1040
you can access a file by any path which will normalize correctly.
1041
On platforms where the system does not normalize filenames
1042
(Windows, Linux), you have to access a file by its exact path.
1044
Internally, bzr only supports NFC normalization, since that is
1045
the standard for XML documents.
1047
So return the normalized path, and a flag indicating if the file
1048
can be accessed by that path.
1051
return unicodedata.normalize('NFC', unicode(path)), True
1054
def _inaccessible_normalized_filename(path):
1055
__doc__ = _accessible_normalized_filename.__doc__
1057
normalized = unicodedata.normalize('NFC', unicode(path))
1058
return normalized, normalized == path
1061
if _platform_normalizes_filenames:
1062
normalized_filename = _accessible_normalized_filename
1064
normalized_filename = _inaccessible_normalized_filename
1067
def terminal_width():
1068
"""Return estimated terminal width."""
1069
if sys.platform == 'win32':
1070
return win32utils.get_console_size()[0]
1073
import struct, fcntl, termios
1074
s = struct.pack('HHHH', 0, 0, 0, 0)
1075
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1076
width = struct.unpack('HHHH', x)[1]
1081
width = int(os.environ['COLUMNS'])
1090
def supports_executable():
1091
return sys.platform != "win32"
1094
def supports_posix_readonly():
1095
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1097
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1098
directory controls creation/deletion, etc.
1100
And under win32, readonly means that the directory itself cannot be
1101
deleted. The contents of a readonly directory can be changed, unlike POSIX
1102
where files in readonly directories cannot be added, deleted or renamed.
1104
return sys.platform != "win32"
1107
def set_or_unset_env(env_variable, value):
1108
"""Modify the environment, setting or removing the env_variable.
1110
:param env_variable: The environment variable in question
1111
:param value: The value to set the environment to. If None, then
1112
the variable will be removed.
1113
:return: The original value of the environment variable.
1115
orig_val = os.environ.get(env_variable)
1117
if orig_val is not None:
1118
del os.environ[env_variable]
1120
if isinstance(value, unicode):
1121
value = value.encode(bzrlib.user_encoding)
1122
os.environ[env_variable] = value
1126
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1129
def check_legal_path(path):
1130
"""Check whether the supplied path is legal.
1131
This is only required on Windows, so we don't test on other platforms
1134
if sys.platform != "win32":
1136
if _validWin32PathRE.match(path) is None:
1137
raise errors.IllegalPath(path)
1140
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1142
def _is_error_enotdir(e):
1143
"""Check if this exception represents ENOTDIR.
1145
Unfortunately, python is very inconsistent about the exception
1146
here. The cases are:
1147
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1148
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1149
which is the windows error code.
1150
3) Windows, Python2.5 uses errno == EINVAL and
1151
winerror == ERROR_DIRECTORY
1153
:param e: An Exception object (expected to be OSError with an errno
1154
attribute, but we should be able to cope with anything)
1155
:return: True if this represents an ENOTDIR error. False otherwise.
1157
en = getattr(e, 'errno', None)
1158
if (en == errno.ENOTDIR
1159
or (sys.platform == 'win32'
1160
and (en == _WIN32_ERROR_DIRECTORY
1161
or (en == errno.EINVAL
1162
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1168
def walkdirs(top, prefix=""):
1169
"""Yield data about all the directories in a tree.
1171
This yields all the data about the contents of a directory at a time.
1172
After each directory has been yielded, if the caller has mutated the list
1173
to exclude some directories, they are then not descended into.
1175
The data yielded is of the form:
1176
((directory-relpath, directory-path-from-top),
1177
[(relpath, basename, kind, lstat, path-from-top), ...]),
1178
- directory-relpath is the relative path of the directory being returned
1179
with respect to top. prefix is prepended to this.
1180
- directory-path-from-root is the path including top for this directory.
1181
It is suitable for use with os functions.
1182
- relpath is the relative path within the subtree being walked.
1183
- basename is the basename of the path
1184
- kind is the kind of the file now. If unknown then the file is not
1185
present within the tree - but it may be recorded as versioned. See
1187
- lstat is the stat data *if* the file was statted.
1188
- planned, not implemented:
1189
path_from_tree_root is the path from the root of the tree.
1191
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1192
allows one to walk a subtree but get paths that are relative to a tree
1194
:return: an iterator over the dirs.
1196
#TODO there is a bit of a smell where the results of the directory-
1197
# summary in this, and the path from the root, may not agree
1198
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1199
# potentially confusing output. We should make this more robust - but
1200
# not at a speed cost. RBC 20060731
1202
_directory = _directory_kind
1203
_listdir = os.listdir
1204
_kind_from_mode = _formats.get
1205
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1207
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1208
relroot, _, _, _, top = pending.pop()
1210
relprefix = relroot + u'/'
1213
top_slash = top + u'/'
1216
append = dirblock.append
1218
names = sorted(_listdir(top))
1220
if not _is_error_enotdir(e):
1224
abspath = top_slash + name
1225
statvalue = _lstat(abspath)
1226
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1227
append((relprefix + name, name, kind, statvalue, abspath))
1228
yield (relroot, top), dirblock
1230
# push the user specified dirs from dirblock
1231
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1234
_real_walkdirs_utf8 = None
1236
def _walkdirs_utf8(top, prefix=""):
1237
"""Yield data about all the directories in a tree.
1239
This yields the same information as walkdirs() only each entry is yielded
1240
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1241
are returned as exact byte-strings.
1243
:return: yields a tuple of (dir_info, [file_info])
1244
dir_info is (utf8_relpath, path-from-top)
1245
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1246
if top is an absolute path, path-from-top is also an absolute path.
1247
path-from-top might be unicode or utf8, but it is the correct path to
1248
pass to os functions to affect the file in question. (such as os.lstat)
1250
global _real_walkdirs_utf8
1251
if _real_walkdirs_utf8 is None:
1252
fs_encoding = _fs_enc.upper()
1253
if win32utils.winver == 'Windows NT':
1254
# Win98 doesn't have unicode apis like FindFirstFileW
1255
# TODO: We possibly could support Win98 by falling back to the
1256
# original FindFirstFile, and using TCHAR instead of WCHAR,
1257
# but that gets a bit tricky, and requires custom compiling
1260
from bzrlib._walkdirs_win32 import _walkdirs_utf8_win32_find_file
1262
_real_walkdirs_utf8 = _walkdirs_unicode_to_utf8
1264
_real_walkdirs_utf8 = _walkdirs_utf8_win32_find_file
1265
elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1266
# ANSI_X3.4-1968 is a form of ASCII
1267
_real_walkdirs_utf8 = _walkdirs_unicode_to_utf8
1269
_real_walkdirs_utf8 = _walkdirs_fs_utf8
1270
return _real_walkdirs_utf8(top, prefix=prefix)
1273
def _walkdirs_fs_utf8(top, prefix=""):
1274
"""See _walkdirs_utf8.
1276
This sub-function is called when we know the filesystem is already in utf8
1277
encoding. So we don't need to transcode filenames.
1280
_directory = _directory_kind
1281
# Use C accelerated directory listing.
1282
_listdir = _read_dir
1283
_kind_from_mode = _formats.get
1285
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1286
# But we don't actually uses 1-3 in pending, so set them to None
1287
pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1289
relroot, _, _, _, top = pending.pop()
1291
relprefix = relroot + '/'
1294
top_slash = top + '/'
1297
append = dirblock.append
1298
# read_dir supplies in should-stat order.
1299
for _, name in sorted(_listdir(top)):
1300
abspath = top_slash + name
1301
statvalue = _lstat(abspath)
1302
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1303
append((relprefix + name, name, kind, statvalue, abspath))
1305
yield (relroot, top), dirblock
1307
# push the user specified dirs from dirblock
1308
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1311
def _walkdirs_unicode_to_utf8(top, prefix=""):
1312
"""See _walkdirs_utf8
1314
Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1316
This is currently the fallback code path when the filesystem encoding is
1317
not UTF-8. It may be better to implement an alternative so that we can
1318
safely handle paths that are not properly decodable in the current
1321
_utf8_encode = codecs.getencoder('utf8')
1323
_directory = _directory_kind
1324
_listdir = os.listdir
1325
_kind_from_mode = _formats.get
1327
pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1329
relroot, _, _, _, top = pending.pop()
1331
relprefix = relroot + '/'
1334
top_slash = top + u'/'
1337
append = dirblock.append
1338
for name in sorted(_listdir(top)):
1339
name_utf8 = _utf8_encode(name)[0]
1340
abspath = top_slash + name
1341
statvalue = _lstat(abspath)
1342
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1343
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1344
yield (relroot, top), dirblock
1346
# push the user specified dirs from dirblock
1347
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1350
def copy_tree(from_path, to_path, handlers={}):
1351
"""Copy all of the entries in from_path into to_path.
1353
:param from_path: The base directory to copy.
1354
:param to_path: The target directory. If it does not exist, it will
1356
:param handlers: A dictionary of functions, which takes a source and
1357
destinations for files, directories, etc.
1358
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1359
'file', 'directory', and 'symlink' should always exist.
1360
If they are missing, they will be replaced with 'os.mkdir()',
1361
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1363
# Now, just copy the existing cached tree to the new location
1364
# We use a cheap trick here.
1365
# Absolute paths are prefixed with the first parameter
1366
# relative paths are prefixed with the second.
1367
# So we can get both the source and target returned
1368
# without any extra work.
1370
def copy_dir(source, dest):
1373
def copy_link(source, dest):
1374
"""Copy the contents of a symlink"""
1375
link_to = os.readlink(source)
1376
os.symlink(link_to, dest)
1378
real_handlers = {'file':shutil.copy2,
1379
'symlink':copy_link,
1380
'directory':copy_dir,
1382
real_handlers.update(handlers)
1384
if not os.path.exists(to_path):
1385
real_handlers['directory'](from_path, to_path)
1387
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1388
for relpath, name, kind, st, abspath in entries:
1389
real_handlers[kind](abspath, relpath)
1392
def path_prefix_key(path):
1393
"""Generate a prefix-order path key for path.
1395
This can be used to sort paths in the same way that walkdirs does.
1397
return (dirname(path) , path)
1400
def compare_paths_prefix_order(path_a, path_b):
1401
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1402
key_a = path_prefix_key(path_a)
1403
key_b = path_prefix_key(path_b)
1404
return cmp(key_a, key_b)
1407
_cached_user_encoding = None
1410
def get_user_encoding(use_cache=True):
1411
"""Find out what the preferred user encoding is.
1413
This is generally the encoding that is used for command line parameters
1414
and file contents. This may be different from the terminal encoding
1415
or the filesystem encoding.
1417
:param use_cache: Enable cache for detected encoding.
1418
(This parameter is turned on by default,
1419
and required only for selftesting)
1421
:return: A string defining the preferred user encoding
1423
global _cached_user_encoding
1424
if _cached_user_encoding is not None and use_cache:
1425
return _cached_user_encoding
1427
if sys.platform == 'darwin':
1428
# work around egregious python 2.4 bug
1429
sys.platform = 'posix'
1433
sys.platform = 'darwin'
1438
user_encoding = locale.getpreferredencoding()
1439
except locale.Error, e:
1440
sys.stderr.write('bzr: warning: %s\n'
1441
' Could not determine what text encoding to use.\n'
1442
' This error usually means your Python interpreter\n'
1443
' doesn\'t support the locale set by $LANG (%s)\n'
1444
" Continuing with ascii encoding.\n"
1445
% (e, os.environ.get('LANG')))
1446
user_encoding = 'ascii'
1448
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1449
# treat that as ASCII, and not support printing unicode characters to the
1452
# For python scripts run under vim, we get '', so also treat that as ASCII
1453
if user_encoding in (None, 'cp0', ''):
1454
user_encoding = 'ascii'
1458
codecs.lookup(user_encoding)
1460
sys.stderr.write('bzr: warning:'
1461
' unknown encoding %s.'
1462
' Continuing with ascii encoding.\n'
1465
user_encoding = 'ascii'
1468
_cached_user_encoding = user_encoding
1470
return user_encoding
1473
def get_host_name():
1474
"""Return the current unicode host name.
1476
This is meant to be used in place of socket.gethostname() because that
1477
behaves inconsistently on different platforms.
1479
if sys.platform == "win32":
1481
return win32utils.get_host_name()
1484
return socket.gethostname().decode(get_user_encoding())
1487
def recv_all(socket, bytes):
1488
"""Receive an exact number of bytes.
1490
Regular Socket.recv() may return less than the requested number of bytes,
1491
dependning on what's in the OS buffer. MSG_WAITALL is not available
1492
on all platforms, but this should work everywhere. This will return
1493
less than the requested amount if the remote end closes.
1495
This isn't optimized and is intended mostly for use in testing.
1498
while len(b) < bytes:
1499
new = socket.recv(bytes - len(b))
1506
def send_all(socket, bytes):
1507
"""Send all bytes on a socket.
1509
Regular socket.sendall() can give socket error 10053 on Windows. This
1510
implementation sends no more than 64k at a time, which avoids this problem.
1513
for pos in xrange(0, len(bytes), chunk_size):
1514
socket.sendall(bytes[pos:pos+chunk_size])
1517
def dereference_path(path):
1518
"""Determine the real path to a file.
1520
All parent elements are dereferenced. But the file itself is not
1522
:param path: The original path. May be absolute or relative.
1523
:return: the real path *to* the file
1525
parent, base = os.path.split(path)
1526
# The pathjoin for '.' is a workaround for Python bug #1213894.
1527
# (initial path components aren't dereferenced)
1528
return pathjoin(realpath(pathjoin('.', parent)), base)
1531
def supports_mapi():
1532
"""Return True if we can use MAPI to launch a mail client."""
1533
return sys.platform == "win32"
1536
def resource_string(package, resource_name):
1537
"""Load a resource from a package and return it as a string.
1539
Note: Only packages that start with bzrlib are currently supported.
1541
This is designed to be a lightweight implementation of resource
1542
loading in a way which is API compatible with the same API from
1544
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
1545
If and when pkg_resources becomes a standard library, this routine
1548
# Check package name is within bzrlib
1549
if package == "bzrlib":
1550
resource_relpath = resource_name
1551
elif package.startswith("bzrlib."):
1552
package = package[len("bzrlib."):].replace('.', os.sep)
1553
resource_relpath = pathjoin(package, resource_name)
1555
raise errors.BzrError('resource package %s not in bzrlib' % package)
1557
# Map the resource to a file and read its contents
1558
base = dirname(bzrlib.__file__)
1559
if getattr(sys, 'frozen', None): # bzr.exe
1560
base = abspath(pathjoin(base, '..', '..'))
1561
filename = pathjoin(base, resource_relpath)
1562
return open(filename, 'rU').read()
1566
from bzrlib._readdir_pyx import read_dir as _read_dir
1568
from bzrlib._readdir_py import read_dir as _read_dir
added
removed
bzrlib/osutils.py
