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
32
from bzrlib.errors import BzrError
33
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
36
24
def make_readonly(filename):
37
25
"""Make a filename read-only."""
26
# TODO: probably needs to be fixed for windows
38
27
mod = os.stat(filename).st_mode
39
28
mod = mod & 0777555
40
29
os.chmod(filename, mod)
46
35
os.chmod(filename, mod)
38
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
53
"""Return a quoted filename filename
55
This previously used backslash quoting, but that works poorly on
57
# TODO: I'm not really sure this is the best format either.x
60
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
62
if _QUOTE_RE.search(f):
40
"""Return shell-quoted filename"""
41
## We could be a bit more terse by using double-quotes etc
42
f = _QUOTE_RE.sub(r'\\\1', f)
145
def is_inside(dir, fname):
146
"""True if fname is inside dir.
148
The parameters should typically be passed to os.path.normpath first, so
149
that . and .. and repeated slashes are eliminated, and the separators
150
are canonical for the platform.
152
The empty string as a dir name is taken as top-of-tree and matches
155
>>> is_inside('src', os.path.join('src', 'foo.c'))
157
>>> is_inside('src', 'srccontrol')
159
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
161
>>> is_inside('foo.c', 'foo.c')
163
>>> is_inside('foo.c', '')
165
>>> is_inside('', 'foo.c')
168
# XXX: Most callers of this can actually do something smarter by
169
# looking at the inventory
176
if dir[-1] != os.sep:
179
return fname.startswith(dir)
182
def is_inside_any(dir_list, fname):
183
"""True if fname is inside any of given dirs."""
184
for dirname in dir_list:
185
if is_inside(dirname, fname):
191
78
def pumpfile(fromfile, tofile):
192
79
"""Copy contents of one file to another."""
193
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.
90
return chomp(file('/proc/sys/kernel/random/uuid').readline())
92
return chomp(os.popen('uuidgen').readline())
96
if s and (s[-1] == '\n'):
104
## TODO: Maybe read in chunks to handle big files
197
105
if hasattr(f, 'tell'):
198
106
assert f.tell() == 0
210
def sha_strings(strings):
211
"""Return the sha-1 of concatenation of strings"""
213
map(s.update, strings)
214
109
return s.hexdigest()
217
112
def sha_string(f):
220
116
return s.hexdigest()
223
120
def fingerprint_file(f):
229
127
'sha1': s.hexdigest()}
233
"""Return per-user configuration directory.
235
By default this is ~/.bzr.conf/
237
TODO: Global option --config-dir to override this.
239
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
243
"""Calculate automatic user identification.
245
Returns (realname, email).
247
Only used when none is set in the environment or the id file.
249
This previously used the FQDN as the default domain, but that can
250
be very slow on machines where DNS is broken. So now we simply
132
"""Return email-style username.
134
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
136
:todo: Check it's reasonably well-formed.
138
:todo: Allow taking it from a dotfile to help people on windows
139
who can't easily set variables.
141
:todo: Cope without pwd module, which is only on unix.
143
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
255
# XXX: Any good way to get real user name on win32?
259
150
uid = os.getuid()
260
151
w = pwd.getpwuid(uid)
261
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
262
username = w.pw_name.decode(bzrlib.user_encoding)
263
153
comma = gecos.find(',')
267
157
realname = gecos[:comma]
158
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
271
159
except ImportError:
273
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
275
return realname, (username + '@' + socket.gethostname())
278
def _get_user_id(branch):
279
"""Return the full user id from a file or environment variable.
281
e.g. "John Hacker <jhacker@foo.org>"
284
A branch to use for a per-branch configuration, or None.
286
The following are searched in order:
289
2. .bzr/email for this branch.
293
v = os.environ.get('BZREMAIL')
295
return v.decode(bzrlib.user_encoding)
299
return (branch.controlfile("email", "r")
301
.decode(bzrlib.user_encoding)
304
if e.errno != errno.ENOENT:
310
return (open(os.path.join(config_dir(), "email"))
312
.decode(bzrlib.user_encoding)
315
if e.errno != errno.ENOENT:
318
v = os.environ.get('EMAIL')
320
return v.decode(bzrlib.user_encoding)
325
def username(branch):
326
"""Return email-style username.
328
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
330
TODO: Check it's reasonably well-formed.
332
v = _get_user_id(branch)
336
name, email = _auto_user_id()
338
return '%s <%s>' % (name, email)
343
def user_email(branch):
162
import getpass, socket
163
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
344
167
"""Return just the email component of a username."""
345
e = _get_user_id(branch)
168
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
347
171
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
349
raise BzrError("%r doesn't seem to contain "
350
"a reasonable email address" % e)
173
bailout('%r is not a reasonable email address' % e)
351
174
return m.group(0)
353
return _auto_user_id()[1]
177
import getpass, socket
178
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
356
183
def compare_files(a, b):
357
184
"""Returns true if equal in contents"""
185
# TODO: don't read the whole thing in one go.
360
188
ai = a.read(BUFSIZE)
393
224
tt = time.localtime(t)
394
225
offset = local_time_offset(t)
396
raise BzrError("unsupported timezone format %r" % timezone,
397
['options are "utc", "original", "local"'])
227
bailout("unsupported timezone format %r",
228
['options are "utc", "original", "local"'])
399
230
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
400
231
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
409
240
"""Return size of given open file."""
410
241
return os.fstat(f.fileno())[ST_SIZE]
412
# Define rand_bytes based on platform.
414
# Python 2.4 and later have os.urandom,
415
# but it doesn't work on some arches
244
if hasattr(os, 'urandom'): # python 2.4 and later
417
245
rand_bytes = os.urandom
418
except (NotImplementedError, AttributeError):
419
# If python doesn't have os.urandom, or it doesn't work,
420
# then try to first pull random data from /dev/urandom
421
if os.path.exists("/dev/urandom"):
422
rand_bytes = file('/dev/urandom', 'rb').read
423
# Otherwise, use this hack as a last resort
425
# not well seeded, but better than nothing
430
s += chr(random.randint(0, 255))
247
# FIXME: No good on non-Linux
248
_rand_file = file('/dev/urandom', 'rb')
249
rand_bytes = _rand_file.read
434
252
## TODO: We could later have path objects that remember their list
435
253
## decomposition (might be too tricksy though.)
448
266
>>> splitpath('a/../b')
449
267
Traceback (most recent call last):
451
BzrError: sorry, '..' not allowed in path
269
BzrError: ("sorry, '..' not allowed in path", [])
453
271
assert isinstance(p, types.StringTypes)
455
# split on either delimiter because people might use either on
457
ps = re.split(r'[\\/]', p)
272
ps = [f for f in p.split('/') if f != '.']
462
raise BzrError("sorry, %r not allowed in path" % f)
463
elif (f == '.') or (f == ''):
275
bailout("sorry, %r not allowed in path" % f)
470
279
assert isinstance(p, list)
472
if (f == '..') or (f == None) or (f == ''):
473
raise BzrError("sorry, %r not allowed in path" % f)
474
return os.path.join(*p)
281
if (f == '..') or (f is None) or (f == ''):
282
bailout("sorry, %r not allowed in path" % f)
477
286
def appendpath(p1, p2):
481
return os.path.join(p1, p2)
484
def _read_config_value(name):
485
"""Read a config value from the file ~/.bzr.conf/<name>
486
Return None if the file does not exist"""
488
f = file(os.path.join(config_dir(), name), "r")
489
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
491
if e.errno == errno.ENOENT:
497
"""Split s into lines, but without removing the newline characters."""
498
return StringIO(s).readlines()
501
def hardlinks_good():
502
return sys.platform not in ('win32', 'cygwin', 'darwin')
505
def link_or_copy(src, dest):
506
"""Hardlink a file, or copy it if it can't be hardlinked."""
507
if not hardlinks_good():
512
except (OSError, IOError), e:
513
if e.errno != errno.EXDEV:
293
def extern_command(cmd, ignore_errors = False):
294
mutter('external command: %s' % `cmd`)
296
if not ignore_errors:
297
bailout('command failed')
added
removed
bzrlib/osutils.py
