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
33
from bzrlib.errors import BzrError, NotBranchError
34
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
37
24
def make_readonly(filename):
38
25
"""Make a filename read-only."""
26
# TODO: probably needs to be fixed for windows
39
27
mod = os.stat(filename).st_mode
40
28
mod = mod & 0777555
41
29
os.chmod(filename, mod)
75
54
elif S_ISLNK(mode):
89
def kind_marker(kind):
92
elif kind == 'directory':
94
elif kind == 'symlink':
97
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os, 'lstat'):
107
if e.errno == errno.ENOENT:
110
raise BzrError("lstat/stat of (%r): %r" % (f, e))
112
def normalizepath(f):
113
if hasattr(os.path, 'realpath'):
117
[p,e] = os.path.split(f)
118
if e == "" or e == "." or e == "..":
121
return os.path.join(F(p), e)
123
if os.name == "posix":
124
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
125
# choke on a Unicode string containing a relative path if
126
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
128
_fs_enc = sys.getfilesystemencoding()
130
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
132
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
134
# We need to use the Unicode-aware os.path.abspath and
135
# os.path.realpath on Windows systems.
136
abspath = os.path.abspath
137
realpath = os.path.realpath
140
"""Copy a file to a backup.
142
Backups are named in GNU-style, with a ~ suffix.
144
If the file is already a backup, it's not copied.
150
if has_symlinks() and os.path.islink(fn):
151
target = os.readlink(fn)
152
os.symlink(target, bfn)
160
outf = file(bfn, 'wb')
57
bailout("can't handle file kind with mode %o of %r" % (mode, f))
189
"""True if f is a symlink."""
191
return S_ISLNK(os.lstat(f)[ST_MODE])
195
def is_inside(dir, fname):
196
"""True if fname is inside dir.
198
The parameters should typically be passed to os.path.normpath first, so
199
that . and .. and repeated slashes are eliminated, and the separators
200
are canonical for the platform.
202
The empty string as a dir name is taken as top-of-tree and matches
205
>>> is_inside('src', os.path.join('src', 'foo.c'))
207
>>> is_inside('src', 'srccontrol')
209
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
211
>>> is_inside('foo.c', 'foo.c')
213
>>> is_inside('foo.c', '')
215
>>> is_inside('', 'foo.c')
218
# XXX: Most callers of this can actually do something smarter by
219
# looking at the inventory
226
if dir[-1] != os.sep:
229
return fname.startswith(dir)
232
def is_inside_any(dir_list, fname):
233
"""True if fname is inside any of given dirs."""
234
for dirname in dir_list:
235
if is_inside(dirname, fname):
241
78
def pumpfile(fromfile, tofile):
242
79
"""Copy contents of one file to another."""
243
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
247
102
if hasattr(f, 'tell'):
248
103
assert f.tell() == 0
260
def sha_strings(strings):
261
"""Return the sha-1 of concatenation of strings"""
263
map(s.update, strings)
264
106
return s.hexdigest()
267
109
def sha_string(f):
270
113
return s.hexdigest()
273
def fingerprint_file(f):
278
return {'size': size,
279
'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())
282
169
def compare_files(a, b):
283
170
"""Returns true if equal in contents"""
171
# TODO: don't read the whole thing in one go.
172
result = a.read() == b.read()
294
177
def local_time_offset(t=None):
295
178
"""Return offset of local zone from GMT, either at present or at time t."""
296
# python2.3 localtime() can't take None
300
179
if time.localtime(t).tm_isdst and time.daylight:
301
180
return -time.altzone
303
182
return -time.timezone
306
def format_date(t, offset=0, timezone='original', date_fmt=None,
185
def format_date(t, offset=0, timezone='original'):
308
186
## TODO: Perhaps a global option to use either universal or local time?
309
187
## Or perhaps just let people set $TZ?
310
190
assert isinstance(t, float)
312
192
if timezone == 'utc':
320
200
tt = time.localtime(t)
321
201
offset = local_time_offset(t)
323
raise BzrError("unsupported timezone format %r" % timezone,
324
['options are "utc", "original", "local"'])
326
date_fmt = "%a %Y-%m-%d %H:%M:%S"
328
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
331
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))
334
210
def compact_date(when):
340
216
"""Return size of given open file."""
341
217
return os.fstat(f.fileno())[ST_SIZE]
343
# Define rand_bytes based on platform.
345
# Python 2.4 and later have os.urandom,
346
# but it doesn't work on some arches
220
if hasattr(os, 'urandom'): # python 2.4 and later
348
221
rand_bytes = os.urandom
349
except (NotImplementedError, AttributeError):
350
# If python doesn't have os.urandom, or it doesn't work,
351
# then try to first pull random data from /dev/urandom
352
if os.path.exists("/dev/urandom"):
353
rand_bytes = file('/dev/urandom', 'rb').read
354
# Otherwise, use this hack as a last resort
356
# not well seeded, but better than nothing
361
s += chr(random.randint(0, 255))
223
# FIXME: No good on non-Linux
224
_rand_file = file('/dev/urandom', 'rb')
225
rand_bytes = _rand_file.read
365
228
## TODO: We could later have path objects that remember their list
366
229
## decomposition (might be too tricksy though.)
379
242
>>> splitpath('a/../b')
380
243
Traceback (most recent call last):
382
BzrError: sorry, '..' not allowed in path
245
BzrError: ("sorry, '..' not allowed in path", [])
384
247
assert isinstance(p, types.StringTypes)
386
# split on either delimiter because people might use either on
388
ps = re.split(r'[\\/]', p)
248
ps = [f for f in p.split('/') if f != '.']
393
raise BzrError("sorry, %r not allowed in path" % f)
394
elif (f == '.') or (f == ''):
251
bailout("sorry, %r not allowed in path" % f)
401
255
assert isinstance(p, list)
403
if (f == '..') or (f == None) or (f == ''):
404
raise BzrError("sorry, %r not allowed in path" % f)
405
return os.path.join(*p)
257
if (f == '..') or (f is None) or (f == ''):
258
bailout("sorry, %r not allowed in path" % f)
408
262
def appendpath(p1, p2):
412
return os.path.join(p1, p2)
416
"""Split s into lines, but without removing the newline characters."""
417
return StringIO(s).readlines()
420
def hardlinks_good():
421
return sys.platform not in ('win32', 'cygwin', 'darwin')
424
def link_or_copy(src, dest):
425
"""Hardlink a file, or copy it if it can't be hardlinked."""
426
if not hardlinks_good():
431
except (OSError, IOError), e:
432
if e.errno != errno.EXDEV:
438
if hasattr(os, 'symlink'):
444
def contains_whitespace(s):
445
"""True if there are any whitespace characters in s."""
446
for ch in string.whitespace:
453
def contains_linebreaks(s):
454
"""True if there is any vertical whitespace in s."""
462
def relpath(base, path):
463
"""Return path relative to base, or raise exception.
465
The path may be either an absolute path or a path relative to the
466
current working directory.
468
os.path.commonprefix (python2.4) has a bad bug that it works just
469
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
470
avoids that problem."""
475
while len(head) >= len(base):
478
head, tail = os.path.split(head)
482
# XXX This should raise a NotChildPath exception, as its not tied
484
raise NotBranchError("path %r is not within branch %r" % (rp, base))
486
return os.sep.join(s)
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
