16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
import os, types, re, time, errno, sys
19
import os, types, re, time, types
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from bzrlib.errors import BzrError
23
from bzrlib.trace import mutter
22
from errors import bailout
26
24
def make_readonly(filename):
27
25
"""Make a filename read-only."""
59
54
elif S_ISLNK(mode):
62
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
65
def kind_marker(kind):
68
elif kind == 'directory':
70
elif kind == 'symlink':
73
raise BzrError('invalid file kind %r' % kind)
78
"""Copy a file to a backup.
80
Backups are named in GNU-style, with a ~ suffix.
82
If the file is already a backup, it's not copied.
95
outf = file(bfn, 'wb')
101
def rename(path_from, path_to):
102
"""Basically the same as os.rename() just special for win32"""
103
if sys.platform == 'win32':
107
if e.errno != e.ENOENT:
109
os.rename(path_from, path_to)
57
bailout("can't handle file kind with mode %o of %r" % (mode, f))
132
def is_inside(dir, fname):
133
"""True if fname is inside dir.
135
return os.path.commonprefix([dir, fname]) == dir
138
def is_inside_any(dir_list, fname):
139
"""True if fname is inside any of given dirs."""
140
# quick scan for perfect match
141
if fname in dir_list:
144
for dirname in dir_list:
145
if is_inside(dirname, fname):
151
78
def pumpfile(fromfile, tofile):
152
79
"""Copy contents of one file to another."""
153
80
tofile.write(fromfile.read())
186
def fingerprint_file(f):
192
return {'size': size,
193
'sha1': s.hexdigest()}
197
"""Return per-user configuration directory.
199
By default this is ~/.bzr.conf/
201
TODO: Global option --config-dir to override this.
203
return os.path.expanduser("~/.bzr.conf")
207
"""Calculate automatic user identification.
209
Returns (realname, email).
211
Only used when none is set in the environment or the id file.
213
This previously used the FQDN as the default domain, but that can
214
be very slow on machines where DNS is broken. So now we simply
118
"""Return email-style username.
120
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
122
:todo: Check it's reasonably well-formed.
124
:todo: Allow taking it from a dotfile to help people on windows
125
who can't easily set variables.
127
:todo: Cope without pwd module, which is only on unix.
129
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
219
# XXX: Any good way to get real user name on win32?
223
136
uid = os.getuid()
224
137
w = pwd.getpwuid(uid)
225
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
226
username = w.pw_name.decode(bzrlib.user_encoding)
227
comma = gecos.find(',')
231
realname = gecos[:comma]
138
realname, junk = w.pw_gecos.split(',', 1)
139
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
235
140
except ImportError:
237
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
239
return realname, (username + '@' + socket.gethostname())
243
"""Return the full user id from a file or environment variable.
245
TODO: Allow taking this from a file in the branch directory too
246
for per-branch ids."""
247
v = os.environ.get('BZREMAIL')
249
return v.decode(bzrlib.user_encoding)
252
return (open(os.path.join(config_dir(), "email"))
254
.decode(bzrlib.user_encoding)
257
if e.errno != errno.ENOENT:
260
v = os.environ.get('EMAIL')
262
return v.decode(bzrlib.user_encoding)
268
"""Return email-style username.
270
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
272
TODO: Check it's reasonably well-formed.
278
name, email = _auto_user_id()
280
return '%s <%s>' % (name, email)
285
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
143
import getpass, socket
144
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
286
147
def user_email():
287
148
"""Return just the email component of a username."""
149
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
290
m = _EMAIL_RE.search(e)
152
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
292
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
154
bailout('%r is not a reasonable email address' % e)
293
155
return m.group(0)
295
return _auto_user_id()[1]
158
import getpass, socket
159
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
299
164
def compare_files(a, b):
300
165
"""Returns true if equal in contents"""
312
def local_time_offset(t=None):
313
"""Return offset of local zone from GMT, either at present or at time t."""
314
# python2.3 localtime() can't take None
318
if time.localtime(t).tm_isdst and time.daylight:
166
# TODO: don't read the whole thing in one go.
167
result = a.read() == b.read()
172
def local_time_offset():
319
174
return -time.altzone
321
176
return -time.timezone
335
192
tt = time.gmtime(t + offset)
336
193
elif timezone == 'local':
337
194
tt = time.localtime(t)
338
offset = local_time_offset(t)
195
offset = local_time_offset()
340
raise BzrError("unsupported timezone format %r",
197
bailout("unsupported timezone format %r",
341
198
['options are "utc", "original", "local"'])
343
200
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
357
214
if hasattr(os, 'urandom'): # python 2.4 and later
358
215
rand_bytes = os.urandom
359
elif sys.platform == 'linux2':
360
rand_bytes = file('/dev/urandom', 'rb').read
362
# not well seeded, but better than nothing
367
s += chr(random.randint(0, 255))
217
# FIXME: No good on non-Linux
218
_rand_file = file('/dev/urandom', 'rb')
219
rand_bytes = _rand_file.read
372
222
## TODO: We could later have path objects that remember their list
386
236
>>> splitpath('a/../b')
387
237
Traceback (most recent call last):
389
BzrError: sorry, '..' not allowed in path
239
BzrError: ("sorry, '..' not allowed in path", [])
391
241
assert isinstance(p, types.StringTypes)
393
# split on either delimiter because people might use either on
395
ps = re.split(r'[\\/]', p)
242
ps = [f for f in p.split('/') if f != '.']
400
raise BzrError("sorry, %r not allowed in path" % f)
401
elif (f == '.') or (f == ''):
245
bailout("sorry, %r not allowed in path" % f)
408
249
assert isinstance(p, list)
410
if (f == '..') or (f == None) or (f == ''):
411
raise BzrError("sorry, %r not allowed in path" % f)
412
return os.path.join(*p)
251
if (f == '..') or (f is None) or (f == ''):
252
bailout("sorry, %r not allowed in path" % f)
415
256
def appendpath(p1, p2):
419
return os.path.join(p1, p2)
422
263
def extern_command(cmd, ignore_errors = False):
423
264
mutter('external command: %s' % `cmd`)
424
265
if os.system(cmd):
425
266
if not ignore_errors:
426
raise BzrError('command failed')
429
def _read_config_value(name):
430
"""Read a config value from the file ~/.bzr.conf/<name>
431
Return None if the file does not exist"""
433
f = file(os.path.join(config_dir(), name), "r")
434
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
436
if e.errno == errno.ENOENT:
442
"""Return a sequence of possible editor binaries for the current platform"""
443
e = _read_config_value("editor")
447
if os.name == "windows":
449
elif os.name == "posix":
451
yield os.environ["EDITOR"]
456
def _run_editor(filename):
457
"""Try to execute an editor to edit the commit message. Returns True on success,
459
for e in _get_editor():
460
x = os.spawnvp(os.P_WAIT, e, (e, filename))
467
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
471
def get_text_message(infotext, ignoreline = "default"):
474
if ignoreline == "default":
475
ignoreline = "-- This line and the following will be ignored --"
478
tmp_fileno, msgfilename = tempfile.mkstemp()
479
msgfile = os.close(tmp_fileno)
480
if infotext is not None and infotext != "":
482
msgfile = file(msgfilename, "w")
483
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
488
if not _run_editor(msgfilename):
493
lastline, nlines = 0, 0
494
for line in file(msgfilename, "r"):
495
stripped_line = line.strip()
496
# strip empty line before the log message starts
498
if stripped_line != "":
502
# check for the ignore line only if there
503
# is additional information at the end
504
if hasinfo and stripped_line == ignoreline:
507
# keep track of the last line that had some content
508
if stripped_line != "":
514
# delete empty lines at the end
516
# add a newline at the end, if needed
517
if not msg[-1].endswith("\n"):
518
return "%s%s" % ("".join(msg), "\n")
522
# delete the msg file in any case
523
try: os.unlink(msgfilename)
267
bailout('command failed')
added
removed
bzrlib/osutils.py
