1
1
# Bazaar-NG -- distributed version control
3
3
# Copyright (C) 2005 by Canonical Ltd
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
13
# GNU General Public License for more details.
15
15
# You should have received a copy of the GNU General Public License
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
import os, types, re, time, errno
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
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
from cStringIO import StringIO
22
from errors import bailout, BzrError
23
from trace import mutter
36
from bzrlib.errors import (BzrError,
37
BzrBadParameterNotUnicode,
42
from bzrlib.symbol_versioning import *
43
from bzrlib.trace import mutter
44
import bzrlib.win32console
26
47
def make_readonly(filename):
27
48
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
49
mod = os.stat(filename).st_mode
30
50
mod = mod & 0777555
31
51
os.chmod(filename, mod)
37
57
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
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]
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
64
"""Return a quoted filename filename
66
This previously used backslash quoting, but that works poorly on
68
# TODO: I'm not really sure this is the best format either.x
71
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
73
if _QUOTE_RE.search(f):
80
stat.S_IFDIR:'directory',
81
stat.S_IFCHR:'chardev',
85
stat.S_IFLNK:'symlink',
86
stat.S_IFSOCK:'socket',
88
def file_kind(f, _formats=_formats, _unknown='unknown', _lstat=os.lstat):
90
return _formats[_lstat(f).st_mode & 0170000]
95
def kind_marker(kind):
98
elif kind == 'directory':
100
elif kind == 'symlink':
103
raise BzrError('invalid file kind %r' % kind)
105
lexists = getattr(os.path, 'lexists', None)
109
if hasattr(os, 'lstat'):
115
if e.errno == errno.ENOENT:
118
raise BzrError("lstat/stat of (%r): %r" % (f, e))
121
def fancy_rename(old, new, rename_func, unlink_func):
122
"""A fancy rename, when you don't have atomic rename.
124
:param old: The old path, to rename from
125
:param new: The new path, to rename to
126
:param rename_func: The potentially non-atomic rename function
127
:param unlink_func: A way to delete the target file if the full rename succeeds
130
# sftp rename doesn't allow overwriting, so play tricks:
132
base = os.path.basename(new)
133
dirname = os.path.dirname(new)
134
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
135
tmp_name = pathjoin(dirname, tmp_name)
137
# Rename the file out of the way, but keep track if it didn't exist
138
# We don't want to grab just any exception
139
# something like EACCES should prevent us from continuing
140
# The downside is that the rename_func has to throw an exception
141
# with an errno = ENOENT, or NoSuchFile
144
rename_func(new, tmp_name)
145
except (NoSuchFile,), e:
148
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
149
# function raises an IOError with errno == None when a rename fails.
150
# This then gets caught here.
151
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
154
if (not hasattr(e, 'errno')
155
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
162
# This may throw an exception, in which case success will
164
rename_func(old, new)
168
# If the file used to exist, rename it back into place
169
# otherwise just delete it from the tmp location
171
unlink_func(tmp_name)
173
rename_func(tmp_name, new)
175
# Default is to just use the python builtins, but these can be rebound on
176
# particular platforms.
177
abspath = os.path.abspath
178
realpath = os.path.realpath
179
pathjoin = os.path.join
180
normpath = os.path.normpath
182
mkdtemp = tempfile.mkdtemp
184
dirname = os.path.dirname
185
basename = os.path.basename
186
rmtree = shutil.rmtree
188
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
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)
226
MIN_ABS_PATHLENGTH = 3
228
def _win32_delete_readonly(function, path, excinfo):
229
"""Error handler for shutil.rmtree function [for win32]
230
Helps to remove files and dirs marked as read-only.
232
type_, value = excinfo[:2]
233
if function in (os.remove, os.rmdir) \
234
and type_ == OSError \
235
and value.errno == errno.EACCES:
236
bzrlib.osutils.make_writable(path)
241
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
242
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
243
return shutil.rmtree(path, ignore_errors, onerror)
246
def normalizepath(f):
247
if hasattr(os.path, 'realpath'):
251
[p,e] = os.path.split(f)
252
if e == "" or e == "." or e == "..":
255
return pathjoin(F(p), e)
259
"""Copy a file to a backup.
261
Backups are named in GNU-style, with a ~ suffix.
263
If the file is already a backup, it's not copied.
269
if has_symlinks() and os.path.islink(fn):
270
target = os.readlink(fn)
271
os.symlink(target, bfn)
279
outf = file(bfn, 'wb')
302
"""True if f is a symlink."""
304
return S_ISLNK(os.lstat(f)[ST_MODE])
308
def is_inside(dir, fname):
309
"""True if fname is inside dir.
311
The parameters should typically be passed to osutils.normpath first, so
312
that . and .. and repeated slashes are eliminated, and the separators
313
are canonical for the platform.
315
The empty string as a dir name is taken as top-of-tree and matches
318
>>> is_inside('src', pathjoin('src', 'foo.c'))
320
>>> is_inside('src', 'srccontrol')
322
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
324
>>> is_inside('foo.c', 'foo.c')
326
>>> is_inside('foo.c', '')
328
>>> is_inside('', 'foo.c')
331
# XXX: Most callers of this can actually do something smarter by
332
# looking at the inventory
342
return fname.startswith(dir)
345
def is_inside_any(dir_list, fname):
346
"""True if fname is inside any of given dirs."""
347
for dirname in dir_list:
348
if is_inside(dirname, fname):
80
354
def pumpfile(fromfile, tofile):
81
355
"""Copy contents of one file to another."""
82
tofile.write(fromfile.read())
86
"""Return a new UUID"""
88
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
90
return chomp(os.popen('uuidgen').readline())
358
b = fromfile.read(BUFSIZE)
364
def file_iterator(input_file, readsize=32768):
366
b = input_file.read(readsize)
95
373
if hasattr(f, 'tell'):
96
374
assert f.tell() == 0
122
405
'sha1': s.hexdigest()}
126
"""Return per-user configuration directory.
128
By default this is ~/.bzr.conf/
130
TODO: Global option --config-dir to override this.
132
return os.path.expanduser("~/.bzr.conf")
136
"""Calculate automatic user identification.
138
Returns (realname, email).
140
Only used when none is set in the environment or the id file.
142
This previously used the FQDN as the default domain, but that can
143
be very slow on machines where DNS is broken. So now we simply
148
# XXX: Any good way to get real user name on win32?
153
w = pwd.getpwuid(uid)
154
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
155
username = w.pw_name.decode(bzrlib.user_encoding)
156
comma = gecos.find(',')
160
realname = gecos[:comma]
166
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
168
return realname, (username + '@' + socket.gethostname())
172
"""Return the full user id from a file or environment variable.
174
TODO: Allow taking this from a file in the branch directory too
175
for per-branch ids."""
176
v = os.environ.get('BZREMAIL')
178
return v.decode(bzrlib.user_encoding)
181
return (open(os.path.join(config_dir(), "email"))
183
.decode(bzrlib.user_encoding)
186
if e.errno != errno.ENOENT:
189
v = os.environ.get('EMAIL')
191
return v.decode(bzrlib.user_encoding)
197
"""Return email-style username.
199
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
201
TODO: Check it's reasonably well-formed.
207
name, email = _auto_user_id()
209
return '%s <%s>' % (name, email)
214
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
216
"""Return just the email component of a username."""
219
m = _EMAIL_RE.search(e)
221
bailout("%r doesn't seem to contain a reasonable email address" % e)
224
return _auto_user_id()[1]
228
408
def compare_files(a, b):
229
409
"""Returns true if equal in contents"""
283
467
return os.fstat(f.fileno())[ST_SIZE]
286
if hasattr(os, 'urandom'): # python 2.4 and later
470
# Define rand_bytes based on platform.
472
# Python 2.4 and later have os.urandom,
473
# but it doesn't work on some arches
287
475
rand_bytes = os.urandom
289
# FIXME: No good on non-Linux
290
_rand_file = file('/dev/urandom', 'rb')
291
rand_bytes = _rand_file.read
476
except (NotImplementedError, AttributeError):
477
# If python doesn't have os.urandom, or it doesn't work,
478
# then try to first pull random data from /dev/urandom
479
if os.path.exists("/dev/urandom"):
480
rand_bytes = file('/dev/urandom', 'rb').read
481
# Otherwise, use this hack as a last resort
483
# not well seeded, but better than nothing
488
s += chr(random.randint(0, 255))
493
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
495
"""Return a random string of num alphanumeric characters
497
The result only contains lowercase chars because it may be used on
498
case-insensitive filesystems.
501
for raw_byte in rand_bytes(num):
502
s += ALNUM[ord(raw_byte) % 36]
294
506
## TODO: We could later have path objects that remember their list
330
542
assert isinstance(p, list)
332
544
if (f == '..') or (f == None) or (f == ''):
333
bailout("sorry, %r not allowed in path" % f)
334
return os.path.join(*p)
545
raise BzrError("sorry, %r not allowed in path" % f)
549
@deprecated_function(zero_nine)
337
550
def appendpath(p1, p2):
341
return os.path.join(p1, p2)
554
return pathjoin(p1, p2)
344
def extern_command(cmd, ignore_errors = False):
345
mutter('external command: %s' % `cmd`)
347
if not ignore_errors:
348
bailout('command failed')
558
"""Split s into lines, but without removing the newline characters."""
559
lines = s.split('\n')
560
result = [line + '\n' for line in lines[:-1]]
562
result.append(lines[-1])
566
def hardlinks_good():
567
return sys.platform not in ('win32', 'cygwin', 'darwin')
570
def link_or_copy(src, dest):
571
"""Hardlink a file, or copy it if it can't be hardlinked."""
572
if not hardlinks_good():
577
except (OSError, IOError), e:
578
if e.errno != errno.EXDEV:
582
def delete_any(full_path):
583
"""Delete a file or directory."""
587
# We may be renaming a dangling inventory id
588
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
594
if hasattr(os, 'symlink'):
600
def contains_whitespace(s):
601
"""True if there are any whitespace characters in s."""
602
for ch in string.whitespace:
609
def contains_linebreaks(s):
610
"""True if there is any vertical whitespace in s."""
618
def relpath(base, path):
619
"""Return path relative to base, or raise exception.
621
The path may be either an absolute path or a path relative to the
622
current working directory.
624
os.path.commonprefix (python2.4) has a bad bug that it works just
625
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
629
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
630
' exceed the platform minimum length (which is %d)' %
636
while len(head) >= len(base):
639
head, tail = os.path.split(head)
643
# XXX This should raise a NotChildPath exception, as its not tied
645
raise PathNotChild(rp, base)
653
def safe_unicode(unicode_or_utf8_string):
654
"""Coerce unicode_or_utf8_string into unicode.
656
If it is unicode, it is returned.
657
Otherwise it is decoded from utf-8. If a decoding error
658
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
659
as a BzrBadParameter exception.
661
if isinstance(unicode_or_utf8_string, unicode):
662
return unicode_or_utf8_string
664
return unicode_or_utf8_string.decode('utf8')
665
except UnicodeDecodeError:
666
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
669
def terminal_width():
670
"""Return estimated terminal width."""
671
if sys.platform == 'win32':
672
import bzrlib.win32console
673
return bzrlib.win32console.get_console_size()[0]
676
import struct, fcntl, termios
677
s = struct.pack('HHHH', 0, 0, 0, 0)
678
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
679
width = struct.unpack('HHHH', x)[1]
684
width = int(os.environ['COLUMNS'])
692
def supports_executable():
693
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
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
709
def check_legal_path(path):
710
"""Check whether the supplied path is legal.
711
This is only required on Windows, so we don't test on other platforms
714
if sys.platform != "win32":
716
if _validWin32PathRE.match(path) is None:
717
raise IllegalPath(path)
added
removed
bzrlib/osutils.py
