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
## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
89
## Linux, but we need something portable for other systems;
90
## preferably an implementation in Python.
92
return chomp(file('/proc/sys/kernel/random/uuid').readline())
94
return chomp(os.popen('uuidgen').readline())
98
if s and (s[-1] == '\n'):
106
## TODO: Maybe read in chunks to handle big files
107
if hasattr(f, 'tell'):
122
def fingerprint_file(f):
128
return {'size': size,
129
'sha1': s.hexdigest()}
133
"""Calculate automatic user identification.
135
Returns (realname, email).
137
Only used when none is set in the environment or the id file.
139
This previously used the FQDN as the default domain, but that can
140
be very slow on machines where DNS is broken. So now we simply
145
# XXX: Any good way to get real user name on win32?
150
w = pwd.getpwuid(uid)
151
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
152
username = w.pw_name.decode(bzrlib.user_encoding)
153
comma = gecos.find(',')
157
realname = gecos[:comma]
162
username = getpass.getuser().decode(bzrlib.user_encoding)
164
return realname, (username + '@' + os.gethostname())
168
v = os.environ.get('BZREMAIL')
170
return v.decode(bzrlib.user_encoding)
173
return (open(os.path.expanduser("~/.bzr.email"))
175
.decode(bzrlib.user_encoding)
178
if e.errno != ENOENT:
181
v = os.environ.get('EMAIL')
183
return v.decode(bzrlib.user_encoding)
189
"""Return email-style username.
191
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
193
TODO: Check it's reasonably well-formed.
195
TODO: Allow taking it from a dotfile to help people on windows
196
who can't easily set variables.
202
name, email = _auto_user_id()
204
return '%s <%s>' % (name, email)
209
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
211
"""Return just the email component of a username."""
214
m = _EMAIL_RE.search(e)
216
bailout("%r doesn't seem to contain a reasonable email address" % e)
219
return _auto_user_id()[1]
223
def compare_files(a, b):
224
"""Returns true if equal in contents"""
225
# TODO: don't read the whole thing in one go.
237
def local_time_offset(t=None):
238
"""Return offset of local zone from GMT, either at present or at time t."""
239
# python2.3 localtime() can't take None
243
if time.localtime(t).tm_isdst and time.daylight:
246
return -time.timezone
249
def format_date(t, offset=0, timezone='original'):
250
## TODO: Perhaps a global option to use either universal or local time?
251
## Or perhaps just let people set $TZ?
252
assert isinstance(t, float)
254
if timezone == 'utc':
257
elif timezone == 'original':
260
tt = time.gmtime(t + offset)
261
elif timezone == 'local':
262
tt = time.localtime(t)
263
offset = local_time_offset(t)
265
bailout("unsupported timezone format %r",
266
['options are "utc", "original", "local"'])
268
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
269
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
272
def compact_date(when):
273
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
278
"""Return size of given open file."""
279
return os.fstat(f.fileno())[ST_SIZE]
282
if hasattr(os, 'urandom'): # python 2.4 and later
283
rand_bytes = os.urandom
285
# FIXME: No good on non-Linux
286
_rand_file = file('/dev/urandom', 'rb')
287
rand_bytes = _rand_file.read
290
## TODO: We could later have path objects that remember their list
291
## decomposition (might be too tricksy though.)
294
"""Turn string into list of parts.
300
>>> splitpath('a/./b')
302
>>> splitpath('a/.b')
304
>>> splitpath('a/../b')
305
Traceback (most recent call last):
307
BzrError: ("sorry, '..' not allowed in path", [])
309
assert isinstance(p, types.StringTypes)
310
ps = [f for f in p.split('/') if (f != '.' and f != '')]
313
bailout("sorry, %r not allowed in path" % f)
317
assert isinstance(p, list)
319
if (f == '..') or (f == None) or (f == ''):
320
bailout("sorry, %r not allowed in path" % f)
324
def appendpath(p1, p2):
331
def extern_command(cmd, ignore_errors = False):
332
mutter('external command: %s' % `cmd`)
334
if not ignore_errors:
335
bailout('command failed')
added
removed
bzrlib/osutils.py
