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)
169
"""True if f is a symlink."""
171
return S_ISLNK(os.lstat(f)[ST_MODE])
175
def is_inside(dir, fname):
176
"""True if fname is inside dir.
178
The parameters should typically be passed to os.path.normpath first, so
179
that . and .. and repeated slashes are eliminated, and the separators
180
are canonical for the platform.
182
The empty string as a dir name is taken as top-of-tree and matches
185
>>> is_inside('src', os.path.join('src', 'foo.c'))
187
>>> is_inside('src', 'srccontrol')
189
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
191
>>> is_inside('foo.c', 'foo.c')
193
>>> is_inside('foo.c', '')
195
>>> is_inside('', 'foo.c')
198
# XXX: Most callers of this can actually do something smarter by
199
# looking at the inventory
206
if dir[-1] != os.sep:
209
return fname.startswith(dir)
212
def is_inside_any(dir_list, fname):
213
"""True if fname is inside any of given dirs."""
214
for dirname in dir_list:
215
if is_inside(dirname, fname):
221
78
def pumpfile(fromfile, tofile):
222
79
"""Copy contents of one file to another."""
223
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
227
102
if hasattr(f, 'tell'):
228
103
assert f.tell() == 0
240
def sha_strings(strings):
241
"""Return the sha-1 of concatenation of strings"""
243
map(s.update, strings)
244
106
return s.hexdigest()
247
109
def sha_string(f):
250
113
return s.hexdigest()
253
def fingerprint_file(f):
258
return {'size': size,
259
'sha1': s.hexdigest()}
263
"""Return per-user configuration directory.
265
By default this is ~/.bzr.conf/
267
TODO: Global option --config-dir to override this.
269
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
273
"""Calculate automatic user identification.
275
Returns (realname, email).
277
Only used when none is set in the environment or the id file.
279
This previously used the FQDN as the default domain, but that can
280
be very slow on machines where DNS is broken. So now we simply
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')
285
# XXX: Any good way to get real user name on win32?
289
136
uid = os.getuid()
290
137
w = pwd.getpwuid(uid)
291
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
292
username = w.pw_name.decode(bzrlib.user_encoding)
293
139
comma = gecos.find(',')
297
143
realname = gecos[:comma]
144
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
301
145
except ImportError:
303
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
305
return realname, (username + '@' + socket.gethostname())
308
def _get_user_id(branch):
309
"""Return the full user id from a file or environment variable.
311
e.g. "John Hacker <jhacker@foo.org>"
314
A branch to use for a per-branch configuration, or None.
316
The following are searched in order:
319
2. .bzr/email for this branch.
323
v = os.environ.get('BZREMAIL')
325
return v.decode(bzrlib.user_encoding)
329
return (branch.controlfile("email", "r")
331
.decode(bzrlib.user_encoding)
334
if e.errno != errno.ENOENT:
340
return (open(os.path.join(config_dir(), "email"))
342
.decode(bzrlib.user_encoding)
345
if e.errno != errno.ENOENT:
348
v = os.environ.get('EMAIL')
350
return v.decode(bzrlib.user_encoding)
355
def username(branch):
356
"""Return email-style username.
358
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
360
TODO: Check it's reasonably well-formed.
362
v = _get_user_id(branch)
366
name, email = _auto_user_id()
368
return '%s <%s>' % (name, email)
373
def user_email(branch):
148
import getpass, socket
149
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
374
153
"""Return just the email component of a username."""
375
e = _get_user_id(branch)
154
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
377
157
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
379
raise BzrError("%r doesn't seem to contain "
380
"a reasonable email address" % e)
159
bailout('%r is not a reasonable email address' % e)
381
160
return m.group(0)
383
return _auto_user_id()[1]
163
import getpass, socket
164
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
386
169
def compare_files(a, b):
387
170
"""Returns true if equal in contents"""
398
def local_time_offset(t=None):
399
"""Return offset of local zone from GMT, either at present or at time t."""
400
# python2.3 localtime() can't take None
404
if time.localtime(t).tm_isdst and time.daylight:
171
# TODO: don't read the whole thing in one go.
172
result = a.read() == b.read()
177
def local_time_offset():
405
179
return -time.altzone
407
181
return -time.timezone
439
215
"""Return size of given open file."""
440
216
return os.fstat(f.fileno())[ST_SIZE]
442
# Define rand_bytes based on platform.
444
# Python 2.4 and later have os.urandom,
445
# but it doesn't work on some arches
219
if hasattr(os, 'urandom'): # python 2.4 and later
447
220
rand_bytes = os.urandom
448
except (NotImplementedError, AttributeError):
449
# If python doesn't have os.urandom, or it doesn't work,
450
# then try to first pull random data from /dev/urandom
451
if os.path.exists("/dev/urandom"):
452
rand_bytes = file('/dev/urandom', 'rb').read
453
# Otherwise, use this hack as a last resort
455
# not well seeded, but better than nothing
460
s += chr(random.randint(0, 255))
222
# FIXME: No good on non-Linux
223
_rand_file = file('/dev/urandom', 'rb')
224
rand_bytes = _rand_file.read
464
227
## TODO: We could later have path objects that remember their list
465
228
## decomposition (might be too tricksy though.)
478
241
>>> splitpath('a/../b')
479
242
Traceback (most recent call last):
481
BzrError: sorry, '..' not allowed in path
244
BzrError: ("sorry, '..' not allowed in path", [])
483
246
assert isinstance(p, types.StringTypes)
485
# split on either delimiter because people might use either on
487
ps = re.split(r'[\\/]', p)
247
ps = [f for f in p.split('/') if f != '.']
492
raise BzrError("sorry, %r not allowed in path" % f)
493
elif (f == '.') or (f == ''):
250
bailout("sorry, %r not allowed in path" % f)
500
254
assert isinstance(p, list)
502
if (f == '..') or (f == None) or (f == ''):
503
raise BzrError("sorry, %r not allowed in path" % f)
504
return os.path.join(*p)
256
if (f == '..') or (f is None) or (f == ''):
257
bailout("sorry, %r not allowed in path" % f)
507
261
def appendpath(p1, p2):
511
return os.path.join(p1, p2)
514
def _read_config_value(name):
515
"""Read a config value from the file ~/.bzr.conf/<name>
516
Return None if the file does not exist"""
518
f = file(os.path.join(config_dir(), name), "r")
519
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
521
if e.errno == errno.ENOENT:
527
"""Split s into lines, but without removing the newline characters."""
528
return StringIO(s).readlines()
531
def hardlinks_good():
532
return sys.platform not in ('win32', 'cygwin', 'darwin')
535
def link_or_copy(src, dest):
536
"""Hardlink a file, or copy it if it can't be hardlinked."""
537
if not hardlinks_good():
542
except (OSError, IOError), e:
543
if e.errno != errno.EXDEV:
549
if hasattr(os, 'symlink'):
268
def extern_command(cmd, ignore_errors = False):
269
mutter('external command: %s' % `cmd`)
271
if not ignore_errors:
272
bailout('command failed')
added
removed
bzrlib/osutils.py
