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
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
## TODO: Maybe read in chunks to handle big files
96
if hasattr(f, 'tell'):
111
def fingerprint_file(f):
117
return {'size': size,
118
'sha1': s.hexdigest()}
122
"""Return per-user configuration directory.
124
By default this is ~/.bzr.conf/
126
TODO: Global option --config-dir to override this.
128
return os.path.expanduser("~/.bzr.conf")
132
"""Calculate automatic user identification.
134
Returns (realname, email).
136
Only used when none is set in the environment or the id file.
138
This previously used the FQDN as the default domain, but that can
139
be very slow on machines where DNS is broken. So now we simply
144
# XXX: Any good way to get real user name on win32?
149
w = pwd.getpwuid(uid)
150
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
151
username = w.pw_name.decode(bzrlib.user_encoding)
152
comma = gecos.find(',')
156
realname = gecos[:comma]
162
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
164
return realname, (username + '@' + socket.gethostname())
168
"""Return the full user id from a file or environment variable.
170
TODO: Allow taking this from a file in the branch directory too
171
for per-branch ids."""
172
v = os.environ.get('BZREMAIL')
174
return v.decode(bzrlib.user_encoding)
177
return (open(os.path.join(config_dir(), "email"))
179
.decode(bzrlib.user_encoding)
182
if e.errno != errno.ENOENT:
185
v = os.environ.get('EMAIL')
187
return v.decode(bzrlib.user_encoding)
193
"""Return email-style username.
195
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
197
TODO: Check it's reasonably well-formed.
203
name, email = _auto_user_id()
205
return '%s <%s>' % (name, email)
210
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
212
"""Return just the email component of a username."""
215
m = _EMAIL_RE.search(e)
217
bailout("%r doesn't seem to contain a reasonable email address" % e)
220
return _auto_user_id()[1]
224
def compare_files(a, b):
225
"""Returns true if equal in contents"""
226
# TODO: don't read the whole thing in one go.
238
def local_time_offset(t=None):
239
"""Return offset of local zone from GMT, either at present or at time t."""
240
# python2.3 localtime() can't take None
244
if time.localtime(t).tm_isdst and time.daylight:
247
return -time.timezone
250
def format_date(t, offset=0, timezone='original'):
251
## TODO: Perhaps a global option to use either universal or local time?
252
## Or perhaps just let people set $TZ?
253
assert isinstance(t, float)
255
if timezone == 'utc':
258
elif timezone == 'original':
261
tt = time.gmtime(t + offset)
262
elif timezone == 'local':
263
tt = time.localtime(t)
264
offset = local_time_offset(t)
266
bailout("unsupported timezone format %r",
267
['options are "utc", "original", "local"'])
269
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
270
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
273
def compact_date(when):
274
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
279
"""Return size of given open file."""
280
return os.fstat(f.fileno())[ST_SIZE]
283
if hasattr(os, 'urandom'): # python 2.4 and later
284
rand_bytes = os.urandom
286
# FIXME: No good on non-Linux
287
_rand_file = file('/dev/urandom', 'rb')
288
rand_bytes = _rand_file.read
291
## TODO: We could later have path objects that remember their list
292
## decomposition (might be too tricksy though.)
295
"""Turn string into list of parts.
301
>>> splitpath('a/./b')
303
>>> splitpath('a/.b')
305
>>> splitpath('a/../b')
306
Traceback (most recent call last):
308
BzrError: ("sorry, '..' not allowed in path", [])
310
assert isinstance(p, types.StringTypes)
312
# split on either delimiter because people might use either on
314
ps = re.split(r'[\\/]', p)
319
bailout("sorry, %r not allowed in path" % f)
320
elif (f == '.') or (f == ''):
327
assert isinstance(p, list)
329
if (f == '..') or (f == None) or (f == ''):
330
bailout("sorry, %r not allowed in path" % f)
331
return os.path.join(*p)
334
def appendpath(p1, p2):
338
return os.path.join(p1, p2)
341
def extern_command(cmd, ignore_errors = False):
342
mutter('external command: %s' % `cmd`)
344
if not ignore_errors:
345
bailout('command failed')