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,
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.%d' % (base, time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
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)
82
tofile.write(fromfile.read())
86
"""Return a new UUID"""
88
## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
89
## Linux, but we need something portable for other systems;
90
## preferably an implementation in Python.
92
return chomp(file('/proc/sys/kernel/random/uuid').readline())
94
return chomp(os.popen('uuidgen').readline())
98
if s and (s[-1] == '\n'):
106
## TODO: Maybe read in chunks to handle big files
340
107
if hasattr(f, 'tell'):
341
108
assert f.tell() == 0
353
def sha_strings(strings):
354
"""Return the sha-1 of concatenation of strings"""
356
map(s.update, strings)
357
111
return s.hexdigest()
360
114
def sha_string(f):
363
118
return s.hexdigest()
366
122
def fingerprint_file(f):
372
129
'sha1': s.hexdigest()}
133
"""Return per-user configuration directory.
135
By default this is ~/.bzr.conf/
137
TODO: Global option --config-dir to override this.
139
return os.path.expanduser("~/.bzr.conf")
143
"""Calculate automatic user identification.
145
Returns (realname, email).
147
Only used when none is set in the environment or the id file.
149
This previously used the FQDN as the default domain, but that can
150
be very slow on machines where DNS is broken. So now we simply
155
# XXX: Any good way to get real user name on win32?
160
w = pwd.getpwuid(uid)
161
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
162
username = w.pw_name.decode(bzrlib.user_encoding)
163
comma = gecos.find(',')
167
realname = gecos[:comma]
173
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
175
return realname, (username + '@' + socket.gethostname())
179
"""Return the full user id from a file or environment variable.
181
TODO: Allow taking this from a file in the branch directory too
182
for per-branch ids."""
183
v = os.environ.get('BZREMAIL')
185
return v.decode(bzrlib.user_encoding)
188
return (open(os.path.join(config_dir(), "email"))
190
.decode(bzrlib.user_encoding)
193
if e.errno != errno.ENOENT:
196
v = os.environ.get('EMAIL')
198
return v.decode(bzrlib.user_encoding)
204
"""Return email-style username.
206
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
208
TODO: Check it's reasonably well-formed.
214
name, email = _auto_user_id()
216
return '%s <%s>' % (name, email)
221
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
223
"""Return just the email component of a username."""
226
m = _EMAIL_RE.search(e)
228
bailout("%r doesn't seem to contain a reasonable email address" % e)
231
return _auto_user_id()[1]
375
235
def compare_files(a, b):
376
236
"""Returns true if equal in contents"""
237
# TODO: don't read the whole thing in one go.
379
240
ai = a.read(BUFSIZE)
413
274
tt = time.localtime(t)
414
275
offset = local_time_offset(t)
416
raise BzrError("unsupported timezone format %r" % timezone,
417
['options are "utc", "original", "local"'])
419
date_fmt = "%a %Y-%m-%d %H:%M:%S"
421
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
424
return (time.strftime(date_fmt, tt) + offset_str)
277
bailout("unsupported timezone format %r",
278
['options are "utc", "original", "local"'])
280
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
281
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
427
284
def compact_date(when):
433
290
"""Return size of given open file."""
434
291
return os.fstat(f.fileno())[ST_SIZE]
436
# Define rand_bytes based on platform.
438
# Python 2.4 and later have os.urandom,
439
# but it doesn't work on some arches
294
if hasattr(os, 'urandom'): # python 2.4 and later
441
295
rand_bytes = os.urandom
442
except (NotImplementedError, AttributeError):
443
# If python doesn't have os.urandom, or it doesn't work,
444
# then try to first pull random data from /dev/urandom
445
if os.path.exists("/dev/urandom"):
446
rand_bytes = file('/dev/urandom', 'rb').read
447
# Otherwise, use this hack as a last resort
449
# not well seeded, but better than nothing
454
s += chr(random.randint(0, 255))
297
# FIXME: No good on non-Linux
298
_rand_file = file('/dev/urandom', 'rb')
299
rand_bytes = _rand_file.read
458
302
## TODO: We could later have path objects that remember their list
459
303
## decomposition (might be too tricksy though.)
494
338
assert isinstance(p, list)
496
340
if (f == '..') or (f == None) or (f == ''):
497
raise BzrError("sorry, %r not allowed in path" % f)
341
bailout("sorry, %r not allowed in path" % f)
342
return os.path.join(*p)
501
345
def appendpath(p1, p2):
505
return pathjoin(p1, p2)
349
return os.path.join(p1, p2)
509
"""Split s into lines, but without removing the newline characters."""
510
return StringIO(s).readlines()
513
def hardlinks_good():
514
return sys.platform not in ('win32', 'cygwin', 'darwin')
517
def link_or_copy(src, dest):
518
"""Hardlink a file, or copy it if it can't be hardlinked."""
519
if not hardlinks_good():
524
except (OSError, IOError), e:
525
if e.errno != errno.EXDEV:
531
if hasattr(os, 'symlink'):
537
def contains_whitespace(s):
538
"""True if there are any whitespace characters in s."""
539
for ch in string.whitespace:
546
def contains_linebreaks(s):
547
"""True if there is any vertical whitespace in s."""
555
def relpath(base, path):
556
"""Return path relative to base, or raise exception.
558
The path may be either an absolute path or a path relative to the
559
current working directory.
561
os.path.commonprefix (python2.4) has a bad bug that it works just
562
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
563
avoids that problem."""
568
while len(head) >= len(base):
571
head, tail = os.path.split(head)
575
# XXX This should raise a NotChildPath exception, as its not tied
577
raise PathNotChild(rp, base)
585
def safe_unicode(unicode_or_utf8_string):
586
"""Coerce unicode_or_utf8_string into unicode.
588
If it is unicode, it is returned.
589
Otherwise it is decoded from utf-8. If a decoding error
590
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
591
as a BzrBadParameter exception.
593
if isinstance(unicode_or_utf8_string, unicode):
594
return unicode_or_utf8_string
596
return unicode_or_utf8_string.decode('utf8')
597
except UnicodeDecodeError:
598
raise BzrBadParameter(unicode_or_utf8_string)
601
def terminal_width():
602
"""Return estimated terminal width."""
604
# TODO: Do something smart on Windows?
606
# TODO: Is there anything that gets a better update when the window
607
# is resized while the program is running? We could use the Python termcap
610
return int(os.environ['COLUMNS'])
611
except (IndexError, KeyError, ValueError):
352
def extern_command(cmd, ignore_errors = False):
353
mutter('external command: %s' % `cmd`)
355
if not ignore_errors:
356
bailout('command failed')
added
removed
bzrlib/osutils.py
