1
1
# Bazaar-NG -- distributed version control
3
3
# Copyright (C) 2005 by Canonical Ltd
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
13
# GNU General Public License for more details.
15
15
# You should have received a copy of the GNU General Public License
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
from shutil import copyfile
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
from cStringIO import StringIO
19
import os, types, re, time, errno, sys
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
33
from bzrlib.errors import BzrError, PathNotChild
34
from bzrlib.trace import mutter
37
26
def make_readonly(filename):
38
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
39
29
mod = os.stat(filename).st_mode
40
30
mod = mod & 0777555
41
31
os.chmod(filename, mod)
97
79
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os, 'lstat'):
107
if e.errno == errno.ENOENT:
110
raise BzrError("lstat/stat of (%r): %r" % (f, e))
112
def normalizepath(f):
113
if hasattr(os.path, 'realpath'):
117
[p,e] = os.path.split(f)
118
if e == "" or e == "." or e == "..":
121
return os.path.join(F(p), e)
123
if os.name == "posix":
124
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
125
# choke on a Unicode string containing a relative path if
126
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
128
_fs_enc = sys.getfilesystemencoding()
130
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
132
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
134
# We need to use the Unicode-aware os.path.abspath and
135
# os.path.realpath on Windows systems.
136
abspath = os.path.abspath
137
realpath = os.path.realpath
139
83
def backup_file(fn):
140
84
"""Copy a file to a backup.
202
145
The empty string as a dir name is taken as top-of-tree and matches
205
>>> is_inside('src', os.path.join('src', 'foo.c'))
148
>>> is_inside('src', 'src/foo.c')
207
150
>>> is_inside('src', 'srccontrol')
209
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
152
>>> is_inside('src', 'src/a/a/a/foo.c')
211
154
>>> is_inside('foo.c', 'foo.c')
241
184
def pumpfile(fromfile, tofile):
242
185
"""Copy contents of one file to another."""
245
b = fromfile.read(BUFSIZE)
186
tofile.write(fromfile.read())
190
"""Return a new UUID"""
192
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
194
return chomp(os.popen('uuidgen').readline())
252
199
if hasattr(f, 'tell'):
253
200
assert f.tell() == 0
284
226
'sha1': s.hexdigest()}
230
"""Return per-user configuration directory.
232
By default this is ~/.bzr.conf/
234
TODO: Global option --config-dir to override this.
236
return os.path.expanduser("~/.bzr.conf")
240
"""Calculate automatic user identification.
242
Returns (realname, email).
244
Only used when none is set in the environment or the id file.
246
This previously used the FQDN as the default domain, but that can
247
be very slow on machines where DNS is broken. So now we simply
252
# XXX: Any good way to get real user name on win32?
257
w = pwd.getpwuid(uid)
258
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
username = w.pw_name.decode(bzrlib.user_encoding)
260
comma = gecos.find(',')
264
realname = gecos[:comma]
270
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
272
return realname, (username + '@' + socket.gethostname())
275
def _get_user_id(branch):
276
"""Return the full user id from a file or environment variable.
278
e.g. "John Hacker <jhacker@foo.org>"
281
A branch to use for a per-branch configuration, or None.
283
The following are searched in order:
286
2. .bzr/email for this branch.
290
v = os.environ.get('BZREMAIL')
292
return v.decode(bzrlib.user_encoding)
296
return (branch.controlfile("email", "r")
298
.decode(bzrlib.user_encoding)
301
if e.errno != errno.ENOENT:
307
return (open(os.path.join(config_dir(), "email"))
309
.decode(bzrlib.user_encoding)
312
if e.errno != errno.ENOENT:
315
v = os.environ.get('EMAIL')
317
return v.decode(bzrlib.user_encoding)
322
def username(branch):
323
"""Return email-style username.
325
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
327
TODO: Check it's reasonably well-formed.
329
v = _get_user_id(branch)
333
name, email = _auto_user_id()
335
return '%s <%s>' % (name, email)
340
def user_email(branch):
341
"""Return just the email component of a username."""
342
e = _get_user_id(branch)
344
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
346
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
349
return _auto_user_id()[1]
287
353
def compare_files(a, b):
288
354
"""Returns true if equal in contents"""
308
375
return -time.timezone
311
def format_date(t, offset=0, timezone='original', date_fmt=None,
378
def format_date(t, offset=0, timezone='original'):
313
379
## TODO: Perhaps a global option to use either universal or local time?
314
380
## Or perhaps just let people set $TZ?
315
381
assert isinstance(t, float)
328
394
raise BzrError("unsupported timezone format %r" % timezone,
329
395
['options are "utc", "original", "local"'])
331
date_fmt = "%a %Y-%m-%d %H:%M:%S"
333
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
336
return (time.strftime(date_fmt, tt) + offset_str)
397
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
339
401
def compact_date(when):
417
479
return os.path.join(p1, p2)
421
"""Split s into lines, but without removing the newline characters."""
422
return StringIO(s).readlines()
425
def hardlinks_good():
426
return sys.platform not in ('win32', 'cygwin', 'darwin')
429
def link_or_copy(src, dest):
430
"""Hardlink a file, or copy it if it can't be hardlinked."""
431
if not hardlinks_good():
436
except (OSError, IOError), e:
437
if e.errno != errno.EXDEV:
443
if hasattr(os, 'symlink'):
449
def contains_whitespace(s):
450
"""True if there are any whitespace characters in s."""
451
for ch in string.whitespace:
458
def contains_linebreaks(s):
459
"""True if there is any vertical whitespace in s."""
467
def relpath(base, path):
468
"""Return path relative to base, or raise exception.
470
The path may be either an absolute path or a path relative to the
471
current working directory.
473
os.path.commonprefix (python2.4) has a bad bug that it works just
474
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
475
avoids that problem."""
480
while len(head) >= len(base):
483
head, tail = os.path.split(head)
487
# XXX This should raise a NotChildPath exception, as its not tied
489
raise PathNotChild(rp, base)
491
return os.sep.join(s)
495
def terminal_width():
496
"""Return estimated terminal width."""
498
# TODO: Do something smart on Windows?
500
# TODO: Is there anything that gets a better update when the window
501
# is resized while the program is running? We could use the Python termcap
504
return int(os.environ['COLUMNS'])
505
except (IndexError, KeyError, ValueError):
482
def extern_command(cmd, ignore_errors = False):
483
mutter('external command: %s' % `cmd`)
485
if not ignore_errors:
486
raise BzrError('command failed')
489
def _read_config_value(name):
490
"""Read a config value from the file ~/.bzr.conf/<name>
491
Return None if the file does not exist"""
493
f = file(os.path.join(config_dir(), name), "r")
494
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
496
if e.errno == errno.ENOENT:
added
removed
bzrlib/osutils.py
