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
19
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
20
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
from cStringIO import StringIO
34
from bzrlib.errors import (BzrError,
35
BzrBadParameterNotUnicode,
30
from bzrlib.errors import BzrError
40
31
from bzrlib.trace import mutter
118
107
raise BzrError("lstat/stat of (%r): %r" % (f, e))
120
def fancy_rename(old, new, rename_func, unlink_func):
121
"""A fancy rename, when you don't have atomic rename.
123
:param old: The old path, to rename from
124
:param new: The new path, to rename to
125
:param rename_func: The potentially non-atomic rename function
126
:param unlink_func: A way to delete the target file if the full rename succeeds
129
# sftp rename doesn't allow overwriting, so play tricks:
131
base = os.path.basename(new)
132
dirname = os.path.dirname(new)
133
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
134
tmp_name = pathjoin(dirname, tmp_name)
136
# Rename the file out of the way, but keep track if it didn't exist
137
# We don't want to grab just any exception
138
# something like EACCES should prevent us from continuing
139
# The downside is that the rename_func has to throw an exception
140
# with an errno = ENOENT, or NoSuchFile
143
rename_func(new, tmp_name)
144
except (NoSuchFile,), e:
147
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
148
# function raises an IOError with errno == None when a rename fails.
149
# This then gets caught here.
150
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
153
if (not hasattr(e, 'errno')
154
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
161
# This may throw an exception, in which case success will
163
rename_func(old, new)
167
# If the file used to exist, rename it back into place
168
# otherwise just delete it from the tmp location
170
unlink_func(tmp_name)
172
rename_func(tmp_name, new)
174
# Default is to just use the python builtins
175
abspath = os.path.abspath
176
realpath = os.path.realpath
177
pathjoin = os.path.join
178
normpath = os.path.normpath
180
mkdtemp = tempfile.mkdtemp
182
dirname = os.path.dirname
183
basename = os.path.basename
185
MIN_ABS_PATHLENGTH = 1
187
if os.name == "posix":
188
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
189
# choke on a Unicode string containing a relative path if
190
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
192
_fs_enc = sys.getfilesystemencoding()
194
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
197
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
199
if sys.platform == 'win32':
200
# We need to use the Unicode-aware os.path.abspath and
201
# os.path.realpath on Windows systems.
203
return os.path.abspath(path).replace('\\', '/')
206
return os.path.realpath(path).replace('\\', '/')
209
return os.path.join(*args).replace('\\', '/')
212
return os.path.normpath(path).replace('\\', '/')
215
return os.getcwdu().replace('\\', '/')
217
def mkdtemp(*args, **kwargs):
218
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
220
def rename(old, new):
221
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
223
MIN_ABS_PATHLENGTH = 3
225
109
def normalizepath(f):
226
110
if hasattr(os.path, 'realpath'):
230
114
[p,e] = os.path.split(f)
231
115
if e == "" or e == "." or e == "..":
234
return pathjoin(F(p), e)
118
return os.path.join(F(p), e)
237
121
def backup_file(fn):
238
122
"""Copy a file to a backup.
287
173
def is_inside(dir, fname):
288
174
"""True if fname is inside dir.
290
The parameters should typically be passed to osutils.normpath first, so
176
The parameters should typically be passed to os.path.normpath first, so
291
177
that . and .. and repeated slashes are eliminated, and the separators
292
178
are canonical for the platform.
294
180
The empty string as a dir name is taken as top-of-tree and matches
297
>>> is_inside('src', pathjoin('src', 'foo.c'))
183
>>> is_inside('src', os.path.join('src', 'foo.c'))
299
185
>>> is_inside('src', 'srccontrol')
301
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
187
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
303
189
>>> is_inside('foo.c', 'foo.c')
384
249
'sha1': s.hexdigest()}
253
"""Return per-user configuration directory.
255
By default this is ~/.bzr.conf/
257
TODO: Global option --config-dir to override this.
259
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
263
"""Calculate automatic user identification.
265
Returns (realname, email).
267
Only used when none is set in the environment or the id file.
269
This previously used the FQDN as the default domain, but that can
270
be very slow on machines where DNS is broken. So now we simply
275
# XXX: Any good way to get real user name on win32?
280
w = pwd.getpwuid(uid)
281
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
282
username = w.pw_name.decode(bzrlib.user_encoding)
283
comma = gecos.find(',')
287
realname = gecos[:comma]
293
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
295
return realname, (username + '@' + socket.gethostname())
298
def _get_user_id(branch):
299
"""Return the full user id from a file or environment variable.
301
e.g. "John Hacker <jhacker@foo.org>"
304
A branch to use for a per-branch configuration, or None.
306
The following are searched in order:
309
2. .bzr/email for this branch.
313
v = os.environ.get('BZREMAIL')
315
return v.decode(bzrlib.user_encoding)
319
return (branch.controlfile("email", "r")
321
.decode(bzrlib.user_encoding)
324
if e.errno != errno.ENOENT:
330
return (open(os.path.join(config_dir(), "email"))
332
.decode(bzrlib.user_encoding)
335
if e.errno != errno.ENOENT:
338
v = os.environ.get('EMAIL')
340
return v.decode(bzrlib.user_encoding)
345
def username(branch):
346
"""Return email-style username.
348
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
350
TODO: Check it's reasonably well-formed.
352
v = _get_user_id(branch)
356
name, email = _auto_user_id()
358
return '%s <%s>' % (name, email)
363
def user_email(branch):
364
"""Return just the email component of a username."""
365
e = _get_user_id(branch)
367
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
369
raise BzrError("%r doesn't seem to contain "
370
"a reasonable email address" % e)
373
return _auto_user_id()[1]
387
376
def compare_files(a, b):
388
377
"""Returns true if equal in contents"""
523
492
if (f == '..') or (f == None) or (f == ''):
524
493
raise BzrError("sorry, %r not allowed in path" % f)
494
return os.path.join(*p)
528
497
def appendpath(p1, p2):
532
return pathjoin(p1, p2)
501
return os.path.join(p1, p2)
536
"""Split s into lines, but without removing the newline characters."""
537
lines = s.split('\n')
538
result = [line + '\n' for line in lines[:-1]]
540
result.append(lines[-1])
544
def hardlinks_good():
545
return sys.platform not in ('win32', 'cygwin', 'darwin')
548
def link_or_copy(src, dest):
549
"""Hardlink a file, or copy it if it can't be hardlinked."""
550
if not hardlinks_good():
555
except (OSError, IOError), e:
556
if e.errno != errno.EXDEV:
560
def delete_any(full_path):
561
"""Delete a file or directory."""
565
# We may be renaming a dangling inventory id
566
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
572
if hasattr(os, 'symlink'):
578
def contains_whitespace(s):
579
"""True if there are any whitespace characters in s."""
580
for ch in string.whitespace:
587
def contains_linebreaks(s):
588
"""True if there is any vertical whitespace in s."""
596
def relpath(base, path):
597
"""Return path relative to base, or raise exception.
599
The path may be either an absolute path or a path relative to the
600
current working directory.
602
os.path.commonprefix (python2.4) has a bad bug that it works just
603
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
607
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
608
' exceed the platform minimum length (which is %d)' %
614
while len(head) >= len(base):
617
head, tail = os.path.split(head)
621
# XXX This should raise a NotChildPath exception, as its not tied
623
raise PathNotChild(rp, base)
631
def safe_unicode(unicode_or_utf8_string):
632
"""Coerce unicode_or_utf8_string into unicode.
634
If it is unicode, it is returned.
635
Otherwise it is decoded from utf-8. If a decoding error
636
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
637
as a BzrBadParameter exception.
639
if isinstance(unicode_or_utf8_string, unicode):
640
return unicode_or_utf8_string
642
return unicode_or_utf8_string.decode('utf8')
643
except UnicodeDecodeError:
644
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
647
def terminal_width():
648
"""Return estimated terminal width."""
650
# TODO: Do something smart on Windows?
652
# TODO: Is there anything that gets a better update when the window
653
# is resized while the program is running? We could use the Python termcap
656
return int(os.environ['COLUMNS'])
657
except (IndexError, KeyError, ValueError):
660
def supports_executable():
661
return sys.platform != "win32"
664
def strip_trailing_slash(path):
665
"""Strip trailing slash, except for root paths.
666
The definition of 'root path' is platform-dependent.
668
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
674
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
677
def check_legal_path(path):
678
"""Check whether the supplied path is legal.
679
This is only required on Windows, so we don't test on other platforms
682
if sys.platform != "win32":
684
if _validWin32PathRE.match(path) is None:
685
raise IllegalPath(path)
504
def extern_command(cmd, ignore_errors = False):
505
mutter('external command: %s' % `cmd`)
507
if not ignore_errors:
508
raise BzrError('command failed')
511
def _read_config_value(name):
512
"""Read a config value from the file ~/.bzr.conf/<name>
513
Return None if the file does not exist"""
515
f = file(os.path.join(config_dir(), name), "r")
516
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
518
if e.errno == errno.ENOENT:
added
removed
bzrlib/osutils.py
