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
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,
35
BzrBadParameterNotUnicode,
39
from bzrlib.trace import mutter
19
import os, types, re, time, types
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from errors import bailout
42
24
def make_readonly(filename):
43
25
"""Make a filename read-only."""
26
# TODO: probably needs to be fixed for windows
44
27
mod = os.stat(filename).st_mode
45
28
mod = mod & 0777555
46
29
os.chmod(filename, mod)
80
54
elif S_ISLNK(mode):
94
def kind_marker(kind):
97
elif kind == 'directory':
99
elif kind == 'symlink':
102
raise BzrError('invalid file kind %r' % kind)
105
if hasattr(os.path, 'lexists'):
106
return os.path.lexists(f)
108
if hasattr(os, 'lstat'):
114
if e.errno == errno.ENOENT:
117
raise BzrError("lstat/stat of (%r): %r" % (f, e))
119
def fancy_rename(old, new, rename_func, unlink_func):
120
"""A fancy rename, when you don't have atomic rename.
122
:param old: The old path, to rename from
123
:param new: The new path, to rename to
124
:param rename_func: The potentially non-atomic rename function
125
:param unlink_func: A way to delete the target file if the full rename succeeds
128
# sftp rename doesn't allow overwriting, so play tricks:
130
base = os.path.basename(new)
131
dirname = os.path.dirname(new)
132
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
133
tmp_name = pathjoin(dirname, tmp_name)
135
# Rename the file out of the way, but keep track if it didn't exist
136
# We don't want to grab just any exception
137
# something like EACCES should prevent us from continuing
138
# The downside is that the rename_func has to throw an exception
139
# with an errno = ENOENT, or NoSuchFile
142
rename_func(new, tmp_name)
143
except (NoSuchFile,), e:
146
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
147
# function raises an IOError with errno == None when a rename fails.
148
# This then gets caught here.
149
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
152
if (not hasattr(e, 'errno')
153
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
160
# This may throw an exception, in which case success will
162
rename_func(old, new)
166
# If the file used to exist, rename it back into place
167
# otherwise just delete it from the tmp location
169
unlink_func(tmp_name)
171
rename_func(tmp_name, new)
173
# Default is to just use the python builtins
174
abspath = os.path.abspath
175
realpath = os.path.realpath
176
pathjoin = os.path.join
177
normpath = os.path.normpath
179
mkdtemp = tempfile.mkdtemp
181
dirname = os.path.dirname
182
basename = os.path.basename
184
if os.name == "posix":
185
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
186
# choke on a Unicode string containing a relative path if
187
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
189
_fs_enc = sys.getfilesystemencoding()
191
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
194
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
196
if sys.platform == 'win32':
197
# We need to use the Unicode-aware os.path.abspath and
198
# os.path.realpath on Windows systems.
200
return os.path.abspath(path).replace('\\', '/')
203
return os.path.realpath(path).replace('\\', '/')
206
return os.path.join(*args).replace('\\', '/')
209
return os.path.normpath(path).replace('\\', '/')
212
return os.getcwdu().replace('\\', '/')
214
def mkdtemp(*args, **kwargs):
215
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
217
def rename(old, new):
218
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
221
def normalizepath(f):
222
if hasattr(os.path, 'realpath'):
226
[p,e] = os.path.split(f)
227
if e == "" or e == "." or e == "..":
230
return pathjoin(F(p), e)
234
"""Copy a file to a backup.
236
Backups are named in GNU-style, with a ~ suffix.
238
If the file is already a backup, it's not copied.
244
if has_symlinks() and os.path.islink(fn):
245
target = os.readlink(fn)
246
os.symlink(target, bfn)
254
outf = file(bfn, 'wb')
57
bailout("can't handle file kind with mode %o of %r" % (mode, f))
277
"""True if f is a symlink."""
279
return S_ISLNK(os.lstat(f)[ST_MODE])
283
def is_inside(dir, fname):
284
"""True if fname is inside dir.
286
The parameters should typically be passed to osutils.normpath first, so
287
that . and .. and repeated slashes are eliminated, and the separators
288
are canonical for the platform.
290
The empty string as a dir name is taken as top-of-tree and matches
293
>>> is_inside('src', pathjoin('src', 'foo.c'))
295
>>> is_inside('src', 'srccontrol')
297
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
299
>>> is_inside('foo.c', 'foo.c')
301
>>> is_inside('foo.c', '')
303
>>> is_inside('', 'foo.c')
306
# XXX: Most callers of this can actually do something smarter by
307
# looking at the inventory
317
return fname.startswith(dir)
320
def is_inside_any(dir_list, fname):
321
"""True if fname is inside any of given dirs."""
322
for dirname in dir_list:
323
if is_inside(dirname, fname):
329
78
def pumpfile(fromfile, tofile):
330
79
"""Copy contents of one file to another."""
333
b = fromfile.read(BUFSIZE)
339
def file_iterator(input_file, readsize=32768):
341
b = input_file.read(readsize)
80
tofile.write(fromfile.read())
84
"""Return a new UUID"""
86
## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
87
## Linux, but we need something portable for other systems;
88
## preferably an implementation in Python.
89
bailout('uuids not allowed!')
90
return chomp(os.popen('uuidgen').readline())
93
if s and (s[-1] == '\n'):
101
## TODO: Maybe read in chunks to handle big files
348
102
if hasattr(f, 'tell'):
349
103
assert f.tell() == 0
361
def sha_strings(strings):
362
"""Return the sha-1 of concatenation of strings"""
364
map(s.update, strings)
365
106
return s.hexdigest()
368
109
def sha_string(f):
371
113
return s.hexdigest()
374
def fingerprint_file(f):
379
return {'size': size,
380
'sha1': s.hexdigest()}
118
"""Return email-style username.
120
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
122
:todo: Check it's reasonably well-formed.
124
:todo: Allow taking it from a dotfile to help people on windows
125
who can't easily set variables.
127
:todo: Cope without pwd module, which is only on unix.
129
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
137
w = pwd.getpwuid(uid)
139
comma = gecos.find(',')
143
realname = gecos[:comma]
144
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
148
import getpass, socket
149
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
153
"""Return just the email component of a username."""
154
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
157
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
159
bailout('%r is not a reasonable email address' % e)
163
import getpass, socket
164
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
383
169
def compare_files(a, b):
384
170
"""Returns true if equal in contents"""
171
# TODO: don't read the whole thing in one go.
172
result = a.read() == b.read()
395
177
def local_time_offset(t=None):
396
178
"""Return offset of local zone from GMT, either at present or at time t."""
397
# python2.3 localtime() can't take None
401
179
if time.localtime(t).tm_isdst and time.daylight:
402
180
return -time.altzone
404
182
return -time.timezone
407
def format_date(t, offset=0, timezone='original', date_fmt=None,
185
def format_date(t, offset=0, timezone='original'):
409
186
## TODO: Perhaps a global option to use either universal or local time?
410
187
## Or perhaps just let people set $TZ?
411
190
assert isinstance(t, float)
413
192
if timezone == 'utc':
421
200
tt = time.localtime(t)
422
201
offset = local_time_offset(t)
424
raise BzrError("unsupported timezone format %r" % timezone,
425
['options are "utc", "original", "local"'])
427
date_fmt = "%a %Y-%m-%d %H:%M:%S"
429
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
432
return (time.strftime(date_fmt, tt) + offset_str)
203
bailout("unsupported timezone format %r",
204
['options are "utc", "original", "local"'])
206
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
207
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
435
210
def compact_date(when):
442
217
return os.fstat(f.fileno())[ST_SIZE]
445
# Define rand_bytes based on platform.
447
# Python 2.4 and later have os.urandom,
448
# but it doesn't work on some arches
220
if hasattr(os, 'urandom'): # python 2.4 and later
450
221
rand_bytes = os.urandom
451
except (NotImplementedError, AttributeError):
452
# If python doesn't have os.urandom, or it doesn't work,
453
# then try to first pull random data from /dev/urandom
454
if os.path.exists("/dev/urandom"):
455
rand_bytes = file('/dev/urandom', 'rb').read
456
# Otherwise, use this hack as a last resort
458
# not well seeded, but better than nothing
463
s += chr(random.randint(0, 255))
468
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
470
"""Return a random string of num alphanumeric characters
472
The result only contains lowercase chars because it may be used on
473
case-insensitive filesystems.
476
for raw_byte in rand_bytes(num):
477
s += ALNUM[ord(raw_byte) % 36]
223
# FIXME: No good on non-Linux
224
_rand_file = file('/dev/urandom', 'rb')
225
rand_bytes = _rand_file.read
481
228
## TODO: We could later have path objects that remember their list
495
242
>>> splitpath('a/../b')
496
243
Traceback (most recent call last):
498
BzrError: sorry, '..' not allowed in path
245
BzrError: ("sorry, '..' not allowed in path", [])
500
247
assert isinstance(p, types.StringTypes)
502
# split on either delimiter because people might use either on
504
ps = re.split(r'[\\/]', p)
248
ps = [f for f in p.split('/') if f != '.']
509
raise BzrError("sorry, %r not allowed in path" % f)
510
elif (f == '.') or (f == ''):
251
bailout("sorry, %r not allowed in path" % f)
517
255
assert isinstance(p, list)
519
if (f == '..') or (f == None) or (f == ''):
520
raise BzrError("sorry, %r not allowed in path" % f)
257
if (f == '..') or (f is None) or (f == ''):
258
bailout("sorry, %r not allowed in path" % f)
524
262
def appendpath(p1, p2):
528
return pathjoin(p1, p2)
532
"""Split s into lines, but without removing the newline characters."""
533
return StringIO(s).readlines()
536
def hardlinks_good():
537
return sys.platform not in ('win32', 'cygwin', 'darwin')
540
def link_or_copy(src, dest):
541
"""Hardlink a file, or copy it if it can't be hardlinked."""
542
if not hardlinks_good():
547
except (OSError, IOError), e:
548
if e.errno != errno.EXDEV:
552
def delete_any(full_path):
553
"""Delete a file or directory."""
557
# We may be renaming a dangling inventory id
558
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
564
if hasattr(os, 'symlink'):
570
def contains_whitespace(s):
571
"""True if there are any whitespace characters in s."""
572
for ch in string.whitespace:
579
def contains_linebreaks(s):
580
"""True if there is any vertical whitespace in s."""
588
def relpath(base, path):
589
"""Return path relative to base, or raise exception.
591
The path may be either an absolute path or a path relative to the
592
current working directory.
594
os.path.commonprefix (python2.4) has a bad bug that it works just
595
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
598
if sys.platform != "win32":
602
assert len(base) >= minlength, ('Length of base must be equal or exceed the'
603
' platform minimum length (which is %d)' % minlength)
608
while len(head) >= len(base):
611
head, tail = os.path.split(head)
615
# XXX This should raise a NotChildPath exception, as its not tied
617
raise PathNotChild(rp, base)
625
def safe_unicode(unicode_or_utf8_string):
626
"""Coerce unicode_or_utf8_string into unicode.
628
If it is unicode, it is returned.
629
Otherwise it is decoded from utf-8. If a decoding error
630
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
631
as a BzrBadParameter exception.
633
if isinstance(unicode_or_utf8_string, unicode):
634
return unicode_or_utf8_string
636
return unicode_or_utf8_string.decode('utf8')
637
except UnicodeDecodeError:
638
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
641
def terminal_width():
642
"""Return estimated terminal width."""
644
# TODO: Do something smart on Windows?
646
# TODO: Is there anything that gets a better update when the window
647
# is resized while the program is running? We could use the Python termcap
650
return int(os.environ['COLUMNS'])
651
except (IndexError, KeyError, ValueError):
654
def supports_executable():
655
return sys.platform != "win32"
269
def extern_command(cmd, ignore_errors = False):
270
mutter('external command: %s' % `cmd`)
272
if not ignore_errors:
273
bailout('command failed')
added
removed
bzrlib/osutils.py
