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
25
def make_readonly(filename):
26
"""Make a filename read-only."""
27
# TODO: probably needs to be fixed for windows
28
mod = os.stat(filename).st_mode
30
os.chmod(filename, mod)
33
def make_writable(filename):
34
mod = os.stat(filename).st_mode
36
os.chmod(filename, mod)
39
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
41
"""Return shell-quoted filename"""
42
## We could be a bit more terse by using double-quotes etc
43
f = _QUOTE_RE.sub(r'\\\1', f)
50
mode = os.lstat(f)[ST_MODE]
58
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
63
"""True if f is an accessible directory."""
65
return S_ISDIR(os.lstat(f)[ST_MODE])
72
"""True if f is a regular file."""
74
return S_ISREG(os.lstat(f)[ST_MODE])
79
def pumpfile(fromfile, tofile):
80
"""Copy contents of one file to another."""
81
tofile.write(fromfile.read())
85
"""Return a new UUID"""
87
## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
88
## Linux, but we need something portable for other systems;
89
## preferably an implementation in Python.
91
return chomp(file('/proc/sys/kernel/random/uuid').readline())
93
return chomp(os.popen('uuidgen').readline())
97
if s and (s[-1] == '\n'):
105
## TODO: Maybe read in chunks to handle big files
106
if hasattr(f, 'tell'):
121
def fingerprint_file(f):
127
return {'size': size,
128
'sha1': s.hexdigest()}
132
"""Calculate automatic user identification.
134
Returns (realname, email).
136
Only used when none is set in the environment.
139
import socket, locale
141
# XXX: Any good way to get real user name on win32?
143
# XXX: can the FQDN be non-ascii?
145
enc = locale.getpreferredencoding()
150
w = pwd.getpwuid(uid)
151
gecos = w.pw_gecos.decode(enc)
152
username = w.pw_name.decode(enc)
153
comma = gecos.find(',')
157
realname = gecos[:comma]
159
return realname, (username + '@' + socket.getfqdn())
163
return '', (getpass.getuser().decode(enc) + '@' + 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.
178
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
180
return e.decode(locale.getpreferredencoding())
182
name, email = auto_user_id()
184
return '%s <%s>' % (name, email)
189
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
191
"""Return just the email component of a username."""
192
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
194
e = e.decode(locale.getpreferredencoding())
196
m = _EMAIL_RE.search(e)
198
bailout('%r is not a reasonable email address' % e)
201
return auto_user_id()[1]
205
def compare_files(a, b):
206
"""Returns true if equal in contents"""
207
# TODO: don't read the whole thing in one go.
219
def local_time_offset(t=None):
220
"""Return offset of local zone from GMT, either at present or at time t."""
221
# python2.3 localtime() can't take None
225
if time.localtime(t).tm_isdst and time.daylight:
228
return -time.timezone
231
def format_date(t, offset=0, timezone='original'):
232
## TODO: Perhaps a global option to use either universal or local time?
233
## Or perhaps just let people set $TZ?
234
assert isinstance(t, float)
236
if timezone == 'utc':
239
elif timezone == 'original':
242
tt = time.gmtime(t + offset)
243
elif timezone == 'local':
244
tt = time.localtime(t)
245
offset = local_time_offset(t)
247
bailout("unsupported timezone format %r",
248
['options are "utc", "original", "local"'])
250
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
251
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
254
def compact_date(when):
255
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
260
"""Return size of given open file."""
261
return os.fstat(f.fileno())[ST_SIZE]
264
if hasattr(os, 'urandom'): # python 2.4 and later
265
rand_bytes = os.urandom
267
# FIXME: No good on non-Linux
268
_rand_file = file('/dev/urandom', 'rb')
269
rand_bytes = _rand_file.read
272
## TODO: We could later have path objects that remember their list
273
## decomposition (might be too tricksy though.)
276
"""Turn string into list of parts.
282
>>> splitpath('a/./b')
284
>>> splitpath('a/.b')
286
>>> splitpath('a/../b')
287
Traceback (most recent call last):
289
BzrError: ("sorry, '..' not allowed in path", [])
291
assert isinstance(p, types.StringTypes)
292
ps = [f for f in p.split('/') if (f != '.' and f != '')]
295
bailout("sorry, %r not allowed in path" % f)
299
assert isinstance(p, list)
301
if (f == '..') or (f == None) or (f == ''):
302
bailout("sorry, %r not allowed in path" % f)
306
def appendpath(p1, p2):
313
def extern_command(cmd, ignore_errors = False):
314
mutter('external command: %s' % `cmd`)
316
if not ignore_errors:
317
bailout('command failed')
added
removed
bzrlib/osutils.py
