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
import os, types, re, time, errno, sys
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
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
22
from bzrlib.errors import BzrError
33
from bzrlib.errors import BzrError, NotBranchError
23
34
from bzrlib.trace import mutter
26
37
def make_readonly(filename):
27
38
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
39
mod = os.stat(filename).st_mode
30
40
mod = mod & 0777555
31
41
os.chmod(filename, mod)
73
97
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
77
139
def backup_file(fn):
78
140
"""Copy a file to a backup.
189
"""True if f is a symlink."""
191
return S_ISLNK(os.lstat(f)[ST_MODE])
132
195
def is_inside(dir, fname):
133
196
"""True if fname is inside dir.
198
The parameters should typically be passed to os.path.normpath first, so
199
that . and .. and repeated slashes are eliminated, and the separators
200
are canonical for the platform.
202
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'))
207
>>> is_inside('src', 'srccontrol')
209
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
211
>>> is_inside('foo.c', 'foo.c')
213
>>> is_inside('foo.c', '')
215
>>> is_inside('', 'foo.c')
135
return os.path.commonprefix([dir, fname]) == dir
218
# XXX: Most callers of this can actually do something smarter by
219
# looking at the inventory
226
if dir[-1] != os.sep:
229
return fname.startswith(dir)
138
232
def is_inside_any(dir_list, fname):
139
233
"""True if fname is inside any of given dirs."""
140
# quick scan for perfect match
141
if fname in dir_list:
144
234
for dirname in dir_list:
145
235
if is_inside(dirname, fname):
193
279
'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
219
# XXX: Any good way to get real user name on win32?
224
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]
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+.-]+')
287
"""Return just the email component of a username."""
290
m = _EMAIL_RE.search(e)
292
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
295
return _auto_user_id()[1]
299
282
def compare_files(a, b):
300
283
"""Returns true if equal in contents"""
337
320
tt = time.localtime(t)
338
321
offset = local_time_offset(t)
340
raise BzrError("unsupported timezone format %r",
341
['options are "utc", "original", "local"'])
343
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
344
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
323
raise BzrError("unsupported timezone format %r" % timezone,
324
['options are "utc", "original", "local"'])
326
date_fmt = "%a %Y-%m-%d %H:%M:%S"
328
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
331
return (time.strftime(date_fmt, tt) + offset_str)
347
334
def compact_date(when):
353
340
"""Return size of given open file."""
354
341
return os.fstat(f.fileno())[ST_SIZE]
357
if hasattr(os, 'urandom'): # python 2.4 and later
343
# Define rand_bytes based on platform.
345
# Python 2.4 and later have os.urandom,
346
# but it doesn't work on some arches
358
348
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))
349
except (NotImplementedError, AttributeError):
350
# If python doesn't have os.urandom, or it doesn't work,
351
# then try to first pull random data from /dev/urandom
352
if os.path.exists("/dev/urandom"):
353
rand_bytes = file('/dev/urandom', 'rb').read
354
# Otherwise, use this hack as a last resort
356
# not well seeded, but better than nothing
361
s += chr(random.randint(0, 255))
372
365
## TODO: We could later have path objects that remember their list
373
366
## decomposition (might be too tricksy though.)
419
412
return os.path.join(p1, p2)
422
def extern_command(cmd, ignore_errors = False):
423
mutter('external command: %s' % `cmd`)
425
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"""
416
"""Split s into lines, but without removing the newline characters."""
417
return StringIO(s).readlines()
420
def hardlinks_good():
421
return sys.platform not in ('win32', 'cygwin', 'darwin')
424
def link_or_copy(src, dest):
425
"""Hardlink a file, or copy it if it can't be hardlinked."""
426
if not hardlinks_good():
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")
431
except (OSError, IOError), e:
432
if e.errno != errno.EXDEV:
438
if hasattr(os, 'symlink'):
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))
444
def contains_whitespace(s):
445
"""True if there are any whitespace characters in s."""
446
for ch in string.whitespace:
453
def contains_linebreaks(s):
454
"""True if there is any vertical whitespace in s."""
462
def relpath(base, path):
463
"""Return path relative to base, or raise exception.
465
The path may be either an absolute path or a path relative to the
466
current working directory.
468
os.path.commonprefix (python2.4) has a bad bug that it works just
469
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
470
avoids that problem."""
475
while len(head) >= len(base):
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)
478
head, tail = os.path.split(head)
482
# XXX This should raise a NotChildPath exception, as its not tied
484
raise NotBranchError("path %r is not within branch %r" % (rp, base))
486
return os.sep.join(s)
added
removed
bzrlib/osutils.py
