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
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.
142
# XXX: Any good way to get real user name on win32?
144
# XXX: can the FQDN be non-ascii?
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]
158
return realname, (username + '@' + socket.getfqdn())
162
getpass.getuser().decode(bzrlib.user_encoding)
163
return '', (username + '@' + socket.getfqdn())
168
"""Return email-style username.
170
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
172
:todo: Check it's reasonably well-formed.
174
:todo: Allow taking it from a dotfile to help people on windows
175
who can't easily set variables.
177
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
179
return e.decode(bzrlib.user_encoding)
181
name, email = auto_user_id()
183
return '%s <%s>' % (name, email)
188
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
190
"""Return just the email component of a username."""
191
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
193
e = e.decode(bzrlib.user_encoding)
195
m = _EMAIL_RE.search(e)
197
bailout('%r is not a reasonable email address' % e)
200
return auto_user_id()[1]
204
def compare_files(a, b):
205
"""Returns true if equal in contents"""
206
# TODO: don't read the whole thing in one go.
218
def local_time_offset(t=None):
219
"""Return offset of local zone from GMT, either at present or at time t."""
220
# python2.3 localtime() can't take None
224
if time.localtime(t).tm_isdst and time.daylight:
227
return -time.timezone
230
def format_date(t, offset=0, timezone='original'):
231
## TODO: Perhaps a global option to use either universal or local time?
232
## Or perhaps just let people set $TZ?
233
assert isinstance(t, float)
235
if timezone == 'utc':
238
elif timezone == 'original':
241
tt = time.gmtime(t + offset)
242
elif timezone == 'local':
243
tt = time.localtime(t)
244
offset = local_time_offset(t)
246
bailout("unsupported timezone format %r",
247
['options are "utc", "original", "local"'])
249
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
250
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
253
def compact_date(when):
254
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
259
"""Return size of given open file."""
260
return os.fstat(f.fileno())[ST_SIZE]
263
if hasattr(os, 'urandom'): # python 2.4 and later
264
rand_bytes = os.urandom
266
# FIXME: No good on non-Linux
267
_rand_file = file('/dev/urandom', 'rb')
268
rand_bytes = _rand_file.read
271
## TODO: We could later have path objects that remember their list
272
## decomposition (might be too tricksy though.)
275
"""Turn string into list of parts.
281
>>> splitpath('a/./b')
283
>>> splitpath('a/.b')
285
>>> splitpath('a/../b')
286
Traceback (most recent call last):
288
BzrError: ("sorry, '..' not allowed in path", [])
290
assert isinstance(p, types.StringTypes)
291
ps = [f for f in p.split('/') if (f != '.' and f != '')]
294
bailout("sorry, %r not allowed in path" % f)
298
assert isinstance(p, list)
300
if (f == '..') or (f == None) or (f == ''):
301
bailout("sorry, %r not allowed in path" % f)
305
def appendpath(p1, p2):
312
def extern_command(cmd, ignore_errors = False):
313
mutter('external command: %s' % `cmd`)
315
if not ignore_errors:
316
bailout('command failed')
added
removed
bzrlib/osutils.py
