1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
import os, types, re, time, errno, sys
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
26
def make_readonly(filename):
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
mod = os.stat(filename).st_mode
31
os.chmod(filename, mod)
34
def make_writable(filename):
35
mod = os.stat(filename).st_mode
37
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
42
"""Return shell-quoted filename"""
43
## We could be a bit more terse by using double-quotes etc
44
f = _QUOTE_RE.sub(r'\\\1', f)
51
mode = os.lstat(f)[ST_MODE]
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
64
"""True if f is an accessible directory."""
66
return S_ISDIR(os.lstat(f)[ST_MODE])
73
"""True if f is a regular file."""
75
return S_ISREG(os.lstat(f)[ST_MODE])
80
def pumpfile(fromfile, tofile):
81
"""Copy contents of one file to another."""
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())
95
if hasattr(f, 'tell'):
115
def fingerprint_file(f):
121
return {'size': size,
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]
228
def compare_files(a, b):
229
"""Returns true if equal in contents"""
241
def local_time_offset(t=None):
242
"""Return offset of local zone from GMT, either at present or at time t."""
243
# python2.3 localtime() can't take None
247
if time.localtime(t).tm_isdst and time.daylight:
250
return -time.timezone
253
def format_date(t, offset=0, timezone='original'):
254
## TODO: Perhaps a global option to use either universal or local time?
255
## Or perhaps just let people set $TZ?
256
assert isinstance(t, float)
258
if timezone == 'utc':
261
elif timezone == 'original':
264
tt = time.gmtime(t + offset)
265
elif timezone == 'local':
266
tt = time.localtime(t)
267
offset = local_time_offset(t)
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))
276
def compact_date(when):
277
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
282
"""Return size of given open file."""
283
return os.fstat(f.fileno())[ST_SIZE]
286
if hasattr(os, 'urandom'): # python 2.4 and later
287
rand_bytes = os.urandom
288
elif sys.platform == 'linux2':
289
rand_bytes = file('/dev/urandom', 'rb').read
291
# not well seeded, but better than nothing
296
s += chr(random.randint(0, 255))
301
## TODO: We could later have path objects that remember their list
302
## decomposition (might be too tricksy though.)
305
"""Turn string into list of parts.
311
>>> splitpath('a/./b')
313
>>> splitpath('a/.b')
315
>>> splitpath('a/../b')
316
Traceback (most recent call last):
318
BzrError: ("sorry, '..' not allowed in path", [])
320
assert isinstance(p, types.StringTypes)
322
# split on either delimiter because people might use either on
324
ps = re.split(r'[\\/]', p)
329
bailout("sorry, %r not allowed in path" % f)
330
elif (f == '.') or (f == ''):
337
assert isinstance(p, list)
339
if (f == '..') or (f == None) or (f == ''):
340
bailout("sorry, %r not allowed in path" % f)
341
return os.path.join(*p)
344
def appendpath(p1, p2):
348
return os.path.join(p1, p2)
351
def extern_command(cmd, ignore_errors = False):
352
mutter('external command: %s' % `cmd`)
354
if not ignore_errors:
355
bailout('command failed')
added
removed
bzrlib/osutils.py
