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
19
import os, types, re, time, errno
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from errors import bailout, BzrError
23
from trace import mutter
34
from bzrlib.errors import (BzrError,
35
BzrBadParameterNotUnicode,
39
from bzrlib.trace import mutter
42
26
def make_readonly(filename):
43
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
44
29
mod = os.stat(filename).st_mode
45
30
mod = mod & 0777555
46
31
os.chmod(filename, mod)
80
56
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')
59
raise BzrError("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
80
def pumpfile(fromfile, tofile):
330
81
"""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)
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())
348
95
if hasattr(f, 'tell'):
349
96
assert f.tell() == 0
380
122
'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]
383
228
def compare_files(a, b):
384
229
"""Returns true if equal in contents"""
421
266
tt = time.localtime(t)
422
267
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)
269
bailout("unsupported timezone format %r",
270
['options are "utc", "original", "local"'])
272
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
273
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
435
276
def compact_date(when):
442
283
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
286
if hasattr(os, 'urandom'): # python 2.4 and later
450
287
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]
289
# FIXME: No good on non-Linux
290
_rand_file = file('/dev/urandom', 'rb')
291
rand_bytes = _rand_file.read
481
294
## TODO: We could later have path objects that remember their list
517
330
assert isinstance(p, list)
519
332
if (f == '..') or (f == None) or (f == ''):
520
raise BzrError("sorry, %r not allowed in path" % f)
333
bailout("sorry, %r not allowed in path" % f)
334
return os.path.join(*p)
524
337
def appendpath(p1, p2):
528
return pathjoin(p1, p2)
341
return os.path.join(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:
554
if hasattr(os, 'symlink'):
560
def contains_whitespace(s):
561
"""True if there are any whitespace characters in s."""
562
for ch in string.whitespace:
569
def contains_linebreaks(s):
570
"""True if there is any vertical whitespace in s."""
578
def relpath(base, path):
579
"""Return path relative to base, or raise exception.
581
The path may be either an absolute path or a path relative to the
582
current working directory.
584
os.path.commonprefix (python2.4) has a bad bug that it works just
585
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
586
avoids that problem."""
591
while len(head) >= len(base):
594
head, tail = os.path.split(head)
598
# XXX This should raise a NotChildPath exception, as its not tied
600
raise PathNotChild(rp, base)
608
def safe_unicode(unicode_or_utf8_string):
609
"""Coerce unicode_or_utf8_string into unicode.
611
If it is unicode, it is returned.
612
Otherwise it is decoded from utf-8. If a decoding error
613
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
614
as a BzrBadParameter exception.
616
if isinstance(unicode_or_utf8_string, unicode):
617
return unicode_or_utf8_string
619
return unicode_or_utf8_string.decode('utf8')
620
except UnicodeDecodeError:
621
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
624
def terminal_width():
625
"""Return estimated terminal width."""
627
# TODO: Do something smart on Windows?
629
# TODO: Is there anything that gets a better update when the window
630
# is resized while the program is running? We could use the Python termcap
633
return int(os.environ['COLUMNS'])
634
except (IndexError, KeyError, ValueError):
637
def supports_executable():
638
return sys.platform != "win32"
344
def extern_command(cmd, ignore_errors = False):
345
mutter('external command: %s' % `cmd`)
347
if not ignore_errors:
348
bailout('command failed')
added
removed
bzrlib/osutils.py
