1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
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
from cStringIO import StringIO
34
from bzrlib.errors import BzrError, PathNotChild, NoSuchFile
35
from bzrlib.trace import mutter
38
def make_readonly(filename):
39
"""Make a filename read-only."""
40
mod = os.stat(filename).st_mode
42
os.chmod(filename, mod)
45
def make_writable(filename):
46
mod = os.stat(filename).st_mode
48
os.chmod(filename, mod)
55
"""Return a quoted filename filename
57
This previously used backslash quoting, but that works poorly on
59
# TODO: I'm not really sure this is the best format either.x
62
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
64
if _QUOTE_RE.search(f):
71
mode = os.lstat(f)[ST_MODE]
90
def kind_marker(kind):
93
elif kind == 'directory':
95
elif kind == 'symlink':
98
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os.path, 'lexists'):
102
return os.path.lexists(f)
104
if hasattr(os, 'lstat'):
110
if e.errno == errno.ENOENT:
113
raise BzrError("lstat/stat of (%r): %r" % (f, e))
115
def fancy_rename(old, new, rename_func, unlink_func):
116
"""A fancy rename, when you don't have atomic rename.
118
:param old: The old path, to rename from
119
:param new: The new path, to rename to
120
:param rename_func: The potentially non-atomic rename function
121
:param unlink_func: A way to delete the target file if the full rename succeeds
124
# sftp rename doesn't allow overwriting, so play tricks:
126
base = os.path.basename(new)
127
dirname = os.path.dirname(new)
128
tmp_name = u'tmp.%s.%.9f.%d.%d' % (base, time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
129
tmp_name = pathjoin(dirname, tmp_name)
131
# Rename the file out of the way, but keep track if it didn't exist
132
# We don't want to grab just any exception
133
# something like EACCES should prevent us from continuing
134
# The downside is that the rename_func has to throw an exception
135
# with an errno = ENOENT, or NoSuchFile
138
rename_func(new, tmp_name)
139
except (NoSuchFile,), e:
142
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
143
# function raises an IOError with errno == None when a rename fails.
144
# This then gets caught here.
145
if e.errno is not None:
148
if (not hasattr(e, 'errno')
149
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
156
# This may throw an exception, in which case success will
158
rename_func(old, new)
162
# If the file used to exist, rename it back into place
163
# otherwise just delete it from the tmp location
165
unlink_func(tmp_name)
167
rename_func(tmp_name, new)
169
# Default is to just use the python builtins
170
abspath = os.path.abspath
171
realpath = os.path.realpath
172
pathjoin = os.path.join
173
normpath = os.path.normpath
175
mkdtemp = tempfile.mkdtemp
177
dirname = os.path.dirname
178
basename = os.path.basename
180
if os.name == "posix":
181
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
182
# choke on a Unicode string containing a relative path if
183
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
185
_fs_enc = sys.getfilesystemencoding()
187
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
190
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
192
if sys.platform == 'win32':
193
# We need to use the Unicode-aware os.path.abspath and
194
# os.path.realpath on Windows systems.
196
return os.path.abspath(path).replace('\\', '/')
199
return os.path.realpath(path).replace('\\', '/')
202
return os.path.join(*args).replace('\\', '/')
205
return os.path.normpath(path).replace('\\', '/')
208
return os.getcwdu().replace('\\', '/')
210
def mkdtemp(*args, **kwargs):
211
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
213
def rename(old, new):
214
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
217
def normalizepath(f):
218
if hasattr(os.path, 'realpath'):
222
[p,e] = os.path.split(f)
223
if e == "" or e == "." or e == "..":
226
return pathjoin(F(p), e)
230
"""Copy a file to a backup.
232
Backups are named in GNU-style, with a ~ suffix.
234
If the file is already a backup, it's not copied.
240
if has_symlinks() and os.path.islink(fn):
241
target = os.readlink(fn)
242
os.symlink(target, bfn)
250
outf = file(bfn, 'wb')
258
"""True if f is an accessible directory."""
260
return S_ISDIR(os.lstat(f)[ST_MODE])
266
"""True if f is a regular file."""
268
return S_ISREG(os.lstat(f)[ST_MODE])
273
"""True if f is a symlink."""
275
return S_ISLNK(os.lstat(f)[ST_MODE])
279
def is_inside(dir, fname):
280
"""True if fname is inside dir.
282
The parameters should typically be passed to osutils.normpath first, so
283
that . and .. and repeated slashes are eliminated, and the separators
284
are canonical for the platform.
286
The empty string as a dir name is taken as top-of-tree and matches
289
>>> is_inside('src', pathjoin('src', 'foo.c'))
291
>>> is_inside('src', 'srccontrol')
293
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
295
>>> is_inside('foo.c', 'foo.c')
297
>>> is_inside('foo.c', '')
299
>>> is_inside('', 'foo.c')
302
# XXX: Most callers of this can actually do something smarter by
303
# looking at the inventory
313
return fname.startswith(dir)
316
def is_inside_any(dir_list, fname):
317
"""True if fname is inside any of given dirs."""
318
for dirname in dir_list:
319
if is_inside(dirname, fname):
325
def pumpfile(fromfile, tofile):
326
"""Copy contents of one file to another."""
329
b = fromfile.read(BUFSIZE)
336
if hasattr(f, 'tell'):
349
def sha_strings(strings):
350
"""Return the sha-1 of concatenation of strings"""
352
map(s.update, strings)
362
def fingerprint_file(f):
367
return {'size': size,
368
'sha1': s.hexdigest()}
371
def compare_files(a, b):
372
"""Returns true if equal in contents"""
383
def local_time_offset(t=None):
384
"""Return offset of local zone from GMT, either at present or at time t."""
385
# python2.3 localtime() can't take None
389
if time.localtime(t).tm_isdst and time.daylight:
392
return -time.timezone
395
def format_date(t, offset=0, timezone='original', date_fmt=None,
397
## TODO: Perhaps a global option to use either universal or local time?
398
## Or perhaps just let people set $TZ?
399
assert isinstance(t, float)
401
if timezone == 'utc':
404
elif timezone == 'original':
407
tt = time.gmtime(t + offset)
408
elif timezone == 'local':
409
tt = time.localtime(t)
410
offset = local_time_offset(t)
412
raise BzrError("unsupported timezone format %r" % timezone,
413
['options are "utc", "original", "local"'])
415
date_fmt = "%a %Y-%m-%d %H:%M:%S"
417
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
420
return (time.strftime(date_fmt, tt) + offset_str)
423
def compact_date(when):
424
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
429
"""Return size of given open file."""
430
return os.fstat(f.fileno())[ST_SIZE]
432
# Define rand_bytes based on platform.
434
# Python 2.4 and later have os.urandom,
435
# but it doesn't work on some arches
437
rand_bytes = os.urandom
438
except (NotImplementedError, AttributeError):
439
# If python doesn't have os.urandom, or it doesn't work,
440
# then try to first pull random data from /dev/urandom
441
if os.path.exists("/dev/urandom"):
442
rand_bytes = file('/dev/urandom', 'rb').read
443
# Otherwise, use this hack as a last resort
445
# not well seeded, but better than nothing
450
s += chr(random.randint(0, 255))
454
## TODO: We could later have path objects that remember their list
455
## decomposition (might be too tricksy though.)
458
"""Turn string into list of parts.
464
>>> splitpath('a/./b')
466
>>> splitpath('a/.b')
468
>>> splitpath('a/../b')
469
Traceback (most recent call last):
471
BzrError: sorry, '..' not allowed in path
473
assert isinstance(p, types.StringTypes)
475
# split on either delimiter because people might use either on
477
ps = re.split(r'[\\/]', p)
482
raise BzrError("sorry, %r not allowed in path" % f)
483
elif (f == '.') or (f == ''):
490
assert isinstance(p, list)
492
if (f == '..') or (f == None) or (f == ''):
493
raise BzrError("sorry, %r not allowed in path" % f)
497
def appendpath(p1, p2):
501
return pathjoin(p1, p2)
505
"""Split s into lines, but without removing the newline characters."""
506
return StringIO(s).readlines()
509
def hardlinks_good():
510
return sys.platform not in ('win32', 'cygwin', 'darwin')
513
def link_or_copy(src, dest):
514
"""Hardlink a file, or copy it if it can't be hardlinked."""
515
if not hardlinks_good():
520
except (OSError, IOError), e:
521
if e.errno != errno.EXDEV:
527
if hasattr(os, 'symlink'):
533
def contains_whitespace(s):
534
"""True if there are any whitespace characters in s."""
535
for ch in string.whitespace:
542
def contains_linebreaks(s):
543
"""True if there is any vertical whitespace in s."""
551
def relpath(base, path):
552
"""Return path relative to base, or raise exception.
554
The path may be either an absolute path or a path relative to the
555
current working directory.
557
os.path.commonprefix (python2.4) has a bad bug that it works just
558
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
559
avoids that problem."""
564
while len(head) >= len(base):
567
head, tail = os.path.split(head)
571
# XXX This should raise a NotChildPath exception, as its not tied
573
raise PathNotChild(rp, base)
581
def terminal_width():
582
"""Return estimated terminal width."""
584
# TODO: Do something smart on Windows?
586
# TODO: Is there anything that gets a better update when the window
587
# is resized while the program is running? We could use the Python termcap
590
return int(os.environ['COLUMNS'])
591
except (IndexError, KeyError, ValueError):
added
removed
bzrlib/osutils.py
