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,
25
splitdrive as _nt_splitdrive,
28
from os import listdir
33
from shutil import copyfile
35
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
36
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
32
from bzrlib.errors import BzrError
45
from bzrlib.errors import (BzrError,
46
BzrBadParameterNotUnicode,
51
from bzrlib.symbol_versioning import (deprecated_function,
33
53
from bzrlib.trace import mutter
56
# On win32, O_BINARY is used to indicate the file should
57
# be opened in binary mode, rather than text mode.
58
# On other platforms, O_BINARY doesn't exist, because
59
# they always open in binary mode, so it is okay to
60
# OR with 0 on those platforms
61
O_BINARY = getattr(os, 'O_BINARY', 0)
36
64
def make_readonly(filename):
37
65
"""Make a filename read-only."""
38
66
mod = os.stat(filename).st_mode
69
mode = os.lstat(f)[ST_MODE]
96
_directory_kind = 'directory'
99
stat.S_IFDIR:_directory_kind,
100
stat.S_IFCHR:'chardev',
101
stat.S_IFBLK:'block',
104
stat.S_IFLNK:'symlink',
105
stat.S_IFSOCK:'socket',
109
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
110
"""Generate a file kind from a stat mode. This is used in walkdirs.
112
Its performance is critical: Do not mutate without careful benchmarking.
115
return _formats[stat_mode & 0170000]
120
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
122
return _mapper(_lstat(f).st_mode)
124
if getattr(e, 'errno', None) == errno.ENOENT:
125
raise bzrlib.errors.NoSuchFile(f)
130
"""Return the current umask"""
131
# Assume that people aren't messing with the umask while running
132
# XXX: This is not thread safe, but there is no way to get the
133
# umask without setting it
88
139
def kind_marker(kind):
89
140
if kind == 'file':
91
elif kind == 'directory':
142
elif kind == _directory_kind:
93
144
elif kind == 'symlink':
96
147
raise BzrError('invalid file kind %r' % kind)
100
if hasattr(os, 'lstat'):
106
if e.errno == errno.ENOENT:
109
raise BzrError("lstat/stat of (%r): %r" % (f, e))
149
lexists = getattr(os.path, 'lexists', None)
153
if hasattr(os, 'lstat'):
159
if e.errno == errno.ENOENT:
162
raise BzrError("lstat/stat of (%r): %r" % (f, e))
165
def fancy_rename(old, new, rename_func, unlink_func):
166
"""A fancy rename, when you don't have atomic rename.
168
:param old: The old path, to rename from
169
:param new: The new path, to rename to
170
:param rename_func: The potentially non-atomic rename function
171
:param unlink_func: A way to delete the target file if the full rename succeeds
174
# sftp rename doesn't allow overwriting, so play tricks:
176
base = os.path.basename(new)
177
dirname = os.path.dirname(new)
178
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
179
tmp_name = pathjoin(dirname, tmp_name)
181
# Rename the file out of the way, but keep track if it didn't exist
182
# We don't want to grab just any exception
183
# something like EACCES should prevent us from continuing
184
# The downside is that the rename_func has to throw an exception
185
# with an errno = ENOENT, or NoSuchFile
188
rename_func(new, tmp_name)
189
except (NoSuchFile,), e:
192
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
193
# function raises an IOError with errno == None when a rename fails.
194
# This then gets caught here.
195
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
198
if (not hasattr(e, 'errno')
199
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
206
# This may throw an exception, in which case success will
208
rename_func(old, new)
212
# If the file used to exist, rename it back into place
213
# otherwise just delete it from the tmp location
215
unlink_func(tmp_name)
217
rename_func(tmp_name, new)
220
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
221
# choke on a Unicode string containing a relative path if
222
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
224
_fs_enc = sys.getfilesystemencoding()
225
def _posix_abspath(path):
226
# jam 20060426 rather than encoding to fsencoding
227
# copy posixpath.abspath, but use os.getcwdu instead
228
if not posixpath.isabs(path):
229
path = posixpath.join(getcwd(), path)
230
return posixpath.normpath(path)
233
def _posix_realpath(path):
234
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
237
def _win32_fixdrive(path):
238
"""Force drive letters to be consistent.
240
win32 is inconsistent whether it returns lower or upper case
241
and even if it was consistent the user might type the other
242
so we force it to uppercase
243
running python.exe under cmd.exe return capital C:\\
244
running win32 python inside a cygwin shell returns lowercase c:\\
246
drive, path = _nt_splitdrive(path)
247
return drive.upper() + path
250
def _win32_abspath(path):
251
# Real _nt_abspath doesn't have a problem with a unicode cwd
252
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
255
def _win32_realpath(path):
256
# Real _nt_realpath doesn't have a problem with a unicode cwd
257
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
260
def _win32_pathjoin(*args):
261
return _nt_join(*args).replace('\\', '/')
264
def _win32_normpath(path):
265
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
269
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
272
def _win32_mkdtemp(*args, **kwargs):
273
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
276
def _win32_rename(old, new):
277
"""We expect to be able to atomically replace 'new' with old.
279
On win32, if new exists, it must be moved out of the way first,
283
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
285
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
286
# If we try to rename a non-existant file onto cwd, we get
287
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
288
# if the old path doesn't exist, sometimes we get EACCES
289
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
295
return unicodedata.normalize('NFKC', os.getcwdu())
298
# Default is to just use the python builtins, but these can be rebound on
299
# particular platforms.
300
abspath = _posix_abspath
301
realpath = _posix_realpath
302
pathjoin = os.path.join
303
normpath = os.path.normpath
305
mkdtemp = tempfile.mkdtemp
307
dirname = os.path.dirname
308
basename = os.path.basename
309
rmtree = shutil.rmtree
311
MIN_ABS_PATHLENGTH = 1
314
if sys.platform == 'win32':
315
abspath = _win32_abspath
316
realpath = _win32_realpath
317
pathjoin = _win32_pathjoin
318
normpath = _win32_normpath
319
getcwd = _win32_getcwd
320
mkdtemp = _win32_mkdtemp
321
rename = _win32_rename
323
MIN_ABS_PATHLENGTH = 3
325
def _win32_delete_readonly(function, path, excinfo):
326
"""Error handler for shutil.rmtree function [for win32]
327
Helps to remove files and dirs marked as read-only.
329
type_, value = excinfo[:2]
330
if function in (os.remove, os.rmdir) \
331
and type_ == OSError \
332
and value.errno == errno.EACCES:
333
bzrlib.osutils.make_writable(path)
338
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
339
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
340
return shutil.rmtree(path, ignore_errors, onerror)
341
elif sys.platform == 'darwin':
345
def get_terminal_encoding():
346
"""Find the best encoding for printing to the screen.
348
This attempts to check both sys.stdout and sys.stdin to see
349
what encoding they are in, and if that fails it falls back to
350
bzrlib.user_encoding.
351
The problem is that on Windows, locale.getpreferredencoding()
352
is not the same encoding as that used by the console:
353
http://mail.python.org/pipermail/python-list/2003-May/162357.html
355
On my standard US Windows XP, the preferred encoding is
356
cp1252, but the console is cp437
358
output_encoding = getattr(sys.stdout, 'encoding', None)
359
if not output_encoding:
360
input_encoding = getattr(sys.stdin, 'encoding', None)
361
if not input_encoding:
362
output_encoding = bzrlib.user_encoding
363
mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
365
output_encoding = input_encoding
366
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
368
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
369
return output_encoding
111
372
def normalizepath(f):
112
373
if hasattr(os.path, 'realpath'):
116
377
[p,e] = os.path.split(f)
117
378
if e == "" or e == "." or e == "..":
120
return os.path.join(F(p), e)
381
return pathjoin(F(p), e)
123
384
def backup_file(fn):
124
385
"""Copy a file to a backup.
259
540
'sha1': s.hexdigest()}
263
"""Return per-user configuration directory.
265
By default this is ~/.bzr.conf/
267
TODO: Global option --config-dir to override this.
269
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
273
"""Calculate automatic user identification.
275
Returns (realname, email).
277
Only used when none is set in the environment or the id file.
279
This previously used the FQDN as the default domain, but that can
280
be very slow on machines where DNS is broken. So now we simply
285
# XXX: Any good way to get real user name on win32?
290
w = pwd.getpwuid(uid)
291
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
292
username = w.pw_name.decode(bzrlib.user_encoding)
293
comma = gecos.find(',')
297
realname = gecos[:comma]
303
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
305
return realname, (username + '@' + socket.gethostname())
308
def _get_user_id(branch):
309
"""Return the full user id from a file or environment variable.
311
e.g. "John Hacker <jhacker@foo.org>"
314
A branch to use for a per-branch configuration, or None.
316
The following are searched in order:
319
2. .bzr/email for this branch.
323
v = os.environ.get('BZREMAIL')
325
return v.decode(bzrlib.user_encoding)
329
return (branch.controlfile("email", "r")
331
.decode(bzrlib.user_encoding)
334
if e.errno != errno.ENOENT:
340
return (open(os.path.join(config_dir(), "email"))
342
.decode(bzrlib.user_encoding)
345
if e.errno != errno.ENOENT:
348
v = os.environ.get('EMAIL')
350
return v.decode(bzrlib.user_encoding)
355
def username(branch):
356
"""Return email-style username.
358
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
360
TODO: Check it's reasonably well-formed.
362
v = _get_user_id(branch)
366
name, email = _auto_user_id()
368
return '%s <%s>' % (name, email)
373
def user_email(branch):
374
"""Return just the email component of a username."""
375
e = _get_user_id(branch)
377
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
379
raise BzrError("%r doesn't seem to contain "
380
"a reasonable email address" % e)
383
return _auto_user_id()[1]
386
543
def compare_files(a, b):
387
544
"""Returns true if equal in contents"""
545
715
copyfile(src, dest)
717
def delete_any(full_path):
718
"""Delete a file or directory."""
722
# We may be renaming a dangling inventory id
723
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
548
728
def has_symlinks():
549
729
if hasattr(os, 'symlink'):
735
def contains_whitespace(s):
736
"""True if there are any whitespace characters in s."""
737
for ch in string.whitespace:
744
def contains_linebreaks(s):
745
"""True if there is any vertical whitespace in s."""
753
def relpath(base, path):
754
"""Return path relative to base, or raise exception.
756
The path may be either an absolute path or a path relative to the
757
current working directory.
759
os.path.commonprefix (python2.4) has a bad bug that it works just
760
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
764
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
765
' exceed the platform minimum length (which is %d)' %
772
while len(head) >= len(base):
775
head, tail = os.path.split(head)
779
raise PathNotChild(rp, base)
787
def safe_unicode(unicode_or_utf8_string):
788
"""Coerce unicode_or_utf8_string into unicode.
790
If it is unicode, it is returned.
791
Otherwise it is decoded from utf-8. If a decoding error
792
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
793
as a BzrBadParameter exception.
795
if isinstance(unicode_or_utf8_string, unicode):
796
return unicode_or_utf8_string
798
return unicode_or_utf8_string.decode('utf8')
799
except UnicodeDecodeError:
800
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
803
_platform_normalizes_filenames = False
804
if sys.platform == 'darwin':
805
_platform_normalizes_filenames = True
808
def normalizes_filenames():
809
"""Return True if this platform normalizes unicode filenames.
811
Mac OSX does, Windows/Linux do not.
813
return _platform_normalizes_filenames
816
def _accessible_normalized_filename(path):
817
"""Get the unicode normalized path, and if you can access the file.
819
On platforms where the system normalizes filenames (Mac OSX),
820
you can access a file by any path which will normalize correctly.
821
On platforms where the system does not normalize filenames
822
(Windows, Linux), you have to access a file by its exact path.
824
Internally, bzr only supports NFC/NFKC normalization, since that is
825
the standard for XML documents.
827
So return the normalized path, and a flag indicating if the file
828
can be accessed by that path.
831
return unicodedata.normalize('NFKC', unicode(path)), True
834
def _inaccessible_normalized_filename(path):
835
__doc__ = _accessible_normalized_filename.__doc__
837
normalized = unicodedata.normalize('NFKC', unicode(path))
838
return normalized, normalized == path
841
if _platform_normalizes_filenames:
842
normalized_filename = _accessible_normalized_filename
844
normalized_filename = _inaccessible_normalized_filename
847
def terminal_width():
848
"""Return estimated terminal width."""
849
if sys.platform == 'win32':
850
import bzrlib.win32console
851
return bzrlib.win32console.get_console_size()[0]
854
import struct, fcntl, termios
855
s = struct.pack('HHHH', 0, 0, 0, 0)
856
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
857
width = struct.unpack('HHHH', x)[1]
862
width = int(os.environ['COLUMNS'])
870
def supports_executable():
871
return sys.platform != "win32"
874
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
877
def check_legal_path(path):
878
"""Check whether the supplied path is legal.
879
This is only required on Windows, so we don't test on other platforms
882
if sys.platform != "win32":
884
if _validWin32PathRE.match(path) is None:
885
raise IllegalPath(path)
888
def walkdirs(top, prefix=""):
889
"""Yield data about all the directories in a tree.
891
This yields all the data about the contents of a directory at a time.
892
After each directory has been yielded, if the caller has mutated the list
893
to exclude some directories, they are then not descended into.
895
The data yielded is of the form:
896
((directory-relpath, directory-path-from-top),
897
[(relpath, basename, kind, lstat), ...]),
898
- directory-relpath is the relative path of the directory being returned
899
with respect to top. prefix is prepended to this.
900
- directory-path-from-root is the path including top for this directory.
901
It is suitable for use with os functions.
902
- relpath is the relative path within the subtree being walked.
903
- basename is the basename of the path
904
- kind is the kind of the file now. If unknown then the file is not
905
present within the tree - but it may be recorded as versioned. See
907
- lstat is the stat data *if* the file was statted.
908
- planned, not implemented:
909
path_from_tree_root is the path from the root of the tree.
911
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
912
allows one to walk a subtree but get paths that are relative to a tree
914
:return: an iterator over the dirs.
916
#TODO there is a bit of a smell where the results of the directory-
917
# summary in this, and the path from the root, may not agree
918
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
919
# potentially confusing output. We should make this more robust - but
920
# not at a speed cost. RBC 20060731
923
_directory = _directory_kind
925
pending = [(prefix, "", _directory, None, top)]
928
currentdir = pending.pop()
929
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
932
relroot = currentdir[0] + '/'
935
for name in sorted(_listdir(top)):
936
abspath = top + '/' + name
937
statvalue = lstat(abspath)
938
dirblock.append((relroot + name, name,
939
file_kind_from_stat_mode(statvalue.st_mode),
941
yield (currentdir[0], top), dirblock
942
# push the user specified dirs from dirblock
943
for dir in reversed(dirblock):
944
if dir[2] == _directory:
948
def copy_tree(from_path, to_path, handlers={}):
949
"""Copy all of the entries in from_path into to_path.
951
:param from_path: The base directory to copy.
952
:param to_path: The target directory. If it does not exist, it will
954
:param handlers: A dictionary of functions, which takes a source and
955
destinations for files, directories, etc.
956
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
957
'file', 'directory', and 'symlink' should always exist.
958
If they are missing, they will be replaced with 'os.mkdir()',
959
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
961
# Now, just copy the existing cached tree to the new location
962
# We use a cheap trick here.
963
# Absolute paths are prefixed with the first parameter
964
# relative paths are prefixed with the second.
965
# So we can get both the source and target returned
966
# without any extra work.
968
def copy_dir(source, dest):
971
def copy_link(source, dest):
972
"""Copy the contents of a symlink"""
973
link_to = os.readlink(source)
974
os.symlink(link_to, dest)
976
real_handlers = {'file':shutil.copy2,
978
'directory':copy_dir,
980
real_handlers.update(handlers)
982
if not os.path.exists(to_path):
983
real_handlers['directory'](from_path, to_path)
985
for dir_info, entries in walkdirs(from_path, prefix=to_path):
986
for relpath, name, kind, st, abspath in entries:
987
real_handlers[kind](abspath, relpath)
990
def path_prefix_key(path):
991
"""Generate a prefix-order path key for path.
993
This can be used to sort paths in the same way that walkdirs does.
995
return (dirname(path) , path)
998
def compare_paths_prefix_order(path_a, path_b):
999
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1000
key_a = path_prefix_key(path_a)
1001
key_b = path_prefix_key(path_b)
1002
return cmp(key_a, key_b)
added
removed
bzrlib/osutils.py
