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
33
from ntpath import (abspath as _nt_abspath,
35
normpath as _nt_normpath,
36
realpath as _nt_realpath,
22
from bzrlib.errors import BzrError
40
from bzrlib.errors import (BzrError,
41
BzrBadParameterNotUnicode,
23
46
from bzrlib.trace import mutter
26
49
def make_readonly(filename):
27
50
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
51
mod = os.stat(filename).st_mode
30
52
mod = mod & 0777555
31
53
os.chmod(filename, mod)
76
109
raise BzrError('invalid file kind %r' % kind)
112
if hasattr(os.path, 'lexists'):
113
return os.path.lexists(f)
115
if hasattr(os, 'lstat'):
121
if e.errno == errno.ENOENT:
124
raise BzrError("lstat/stat of (%r): %r" % (f, e))
126
def fancy_rename(old, new, rename_func, unlink_func):
127
"""A fancy rename, when you don't have atomic rename.
129
:param old: The old path, to rename from
130
:param new: The new path, to rename to
131
:param rename_func: The potentially non-atomic rename function
132
:param unlink_func: A way to delete the target file if the full rename succeeds
135
# sftp rename doesn't allow overwriting, so play tricks:
137
base = os.path.basename(new)
138
dirname = os.path.dirname(new)
139
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
140
tmp_name = pathjoin(dirname, tmp_name)
142
# Rename the file out of the way, but keep track if it didn't exist
143
# We don't want to grab just any exception
144
# something like EACCES should prevent us from continuing
145
# The downside is that the rename_func has to throw an exception
146
# with an errno = ENOENT, or NoSuchFile
149
rename_func(new, tmp_name)
150
except (NoSuchFile,), e:
153
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
154
# function raises an IOError with errno == None when a rename fails.
155
# This then gets caught here.
156
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
159
if (not hasattr(e, 'errno')
160
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
167
# This may throw an exception, in which case success will
169
rename_func(old, new)
173
# If the file used to exist, rename it back into place
174
# otherwise just delete it from the tmp location
176
unlink_func(tmp_name)
178
rename_func(tmp_name, new)
181
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
182
# choke on a Unicode string containing a relative path if
183
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
185
_fs_enc = sys.getfilesystemencoding()
186
def _posix_abspath(path):
187
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
188
# jam 20060426 This is another possibility which mimics
189
# os.path.abspath, only uses unicode characters instead
190
# if not os.path.isabs(path):
191
# return os.path.join(os.getcwdu(), path)
195
def _posix_realpath(path):
196
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
199
def _win32_abspath(path):
200
return _nt_abspath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
203
def _win32_realpath(path):
204
return _nt_realpath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
207
def _win32_pathjoin(*args):
208
return _nt_join(*args).replace('\\', '/')
211
def _win32_normpath(path):
212
return _nt_normpath(path).replace('\\', '/')
216
return os.getcwdu().replace('\\', '/')
219
def _win32_mkdtemp(*args, **kwargs):
220
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
223
def _win32_rename(old, new):
224
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
227
# Default is to just use the python builtins
228
abspath = _posix_abspath
229
realpath = _posix_realpath
230
pathjoin = os.path.join
231
normpath = os.path.normpath
233
mkdtemp = tempfile.mkdtemp
235
dirname = os.path.dirname
236
basename = os.path.basename
238
MIN_ABS_PATHLENGTH = 1
241
if sys.platform == 'win32':
242
abspath = _win32_abspath
243
realpath = _win32_realpath
244
pathjoin = _win32_pathjoin
245
normpath = _win32_normpath
246
getcwd = _win32_getcwd
247
mkdtemp = _win32_mkdtemp
248
rename = _win32_rename
250
MIN_ABS_PATHLENGTH = 3
253
def normalizepath(f):
254
if hasattr(os.path, 'realpath'):
258
[p,e] = os.path.split(f)
259
if e == "" or e == "." or e == "..":
262
return pathjoin(F(p), e)
80
265
def backup_file(fn):
223
412
'sha1': s.hexdigest()}
227
"""Return per-user configuration directory.
229
By default this is ~/.bzr.conf/
231
TODO: Global option --config-dir to override this.
233
return os.path.expanduser("~/.bzr.conf")
237
"""Calculate automatic user identification.
239
Returns (realname, email).
241
Only used when none is set in the environment or the id file.
243
This previously used the FQDN as the default domain, but that can
244
be very slow on machines where DNS is broken. So now we simply
249
# XXX: Any good way to get real user name on win32?
254
w = pwd.getpwuid(uid)
255
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
256
username = w.pw_name.decode(bzrlib.user_encoding)
257
comma = gecos.find(',')
261
realname = gecos[:comma]
267
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
269
return realname, (username + '@' + socket.gethostname())
273
"""Return the full user id from a file or environment variable.
275
TODO: Allow taking this from a file in the branch directory too
276
for per-branch ids."""
277
v = os.environ.get('BZREMAIL')
279
return v.decode(bzrlib.user_encoding)
282
return (open(os.path.join(config_dir(), "email"))
284
.decode(bzrlib.user_encoding)
287
if e.errno != errno.ENOENT:
290
v = os.environ.get('EMAIL')
292
return v.decode(bzrlib.user_encoding)
298
"""Return email-style username.
300
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
302
TODO: Check it's reasonably well-formed.
308
name, email = _auto_user_id()
310
return '%s <%s>' % (name, email)
315
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
317
"""Return just the email component of a username."""
320
m = _EMAIL_RE.search(e)
322
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
325
return _auto_user_id()[1]
329
415
def compare_files(a, b):
330
416
"""Returns true if equal in contents"""
384
474
return os.fstat(f.fileno())[ST_SIZE]
387
if hasattr(os, 'urandom'): # python 2.4 and later
477
# Define rand_bytes based on platform.
479
# Python 2.4 and later have os.urandom,
480
# but it doesn't work on some arches
388
482
rand_bytes = os.urandom
389
elif sys.platform == 'linux2':
390
rand_bytes = file('/dev/urandom', 'rb').read
392
# not well seeded, but better than nothing
397
s += chr(random.randint(0, 255))
483
except (NotImplementedError, AttributeError):
484
# If python doesn't have os.urandom, or it doesn't work,
485
# then try to first pull random data from /dev/urandom
486
if os.path.exists("/dev/urandom"):
487
rand_bytes = file('/dev/urandom', 'rb').read
488
# Otherwise, use this hack as a last resort
490
# not well seeded, but better than nothing
495
s += chr(random.randint(0, 255))
500
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
502
"""Return a random string of num alphanumeric characters
504
The result only contains lowercase chars because it may be used on
505
case-insensitive filesystems.
508
for raw_byte in rand_bytes(num):
509
s += ALNUM[ord(raw_byte) % 36]
402
513
## TODO: We could later have path objects that remember their list
440
551
if (f == '..') or (f == None) or (f == ''):
441
552
raise BzrError("sorry, %r not allowed in path" % f)
442
return os.path.join(*p)
445
556
def appendpath(p1, p2):
449
return os.path.join(p1, p2)
560
return pathjoin(p1, p2)
452
def extern_command(cmd, ignore_errors = False):
453
mutter('external command: %s' % `cmd`)
455
if not ignore_errors:
456
raise BzrError('command failed')
459
def _read_config_value(name):
460
"""Read a config value from the file ~/.bzr.conf/<name>
461
Return None if the file does not exist"""
463
f = file(os.path.join(config_dir(), name), "r")
464
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
466
if e.errno == errno.ENOENT:
472
"""Return a sequence of possible editor binaries for the current platform"""
473
e = _read_config_value("editor")
564
"""Split s into lines, but without removing the newline characters."""
565
lines = s.split('\n')
566
result = [line + '\n' for line in lines[:-1]]
568
result.append(lines[-1])
572
def hardlinks_good():
573
return sys.platform not in ('win32', 'cygwin', 'darwin')
576
def link_or_copy(src, dest):
577
"""Hardlink a file, or copy it if it can't be hardlinked."""
578
if not hardlinks_good():
583
except (OSError, IOError), e:
584
if e.errno != errno.EXDEV:
588
def delete_any(full_path):
589
"""Delete a file or directory."""
593
# We may be renaming a dangling inventory id
594
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
600
if hasattr(os, 'symlink'):
477
if os.name == "windows":
479
elif os.name == "posix":
481
yield os.environ["EDITOR"]
486
def _run_editor(filename):
487
"""Try to execute an editor to edit the commit message. Returns True on success,
489
for e in _get_editor():
490
x = os.spawnvp(os.P_WAIT, e, (e, filename))
606
def contains_whitespace(s):
607
"""True if there are any whitespace characters in s."""
608
for ch in string.whitespace:
615
def contains_linebreaks(s):
616
"""True if there is any vertical whitespace in s."""
624
def relpath(base, path):
625
"""Return path relative to base, or raise exception.
627
The path may be either an absolute path or a path relative to the
628
current working directory.
630
os.path.commonprefix (python2.4) has a bad bug that it works just
631
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
635
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
636
' exceed the platform minimum length (which is %d)' %
643
while len(head) >= len(base):
497
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
501
def get_text_message(infotext, ignoreline = "default"):
504
if ignoreline == "default":
505
ignoreline = "-- This line and the following will be ignored --"
508
tmp_fileno, msgfilename = tempfile.mkstemp()
509
msgfile = os.close(tmp_fileno)
510
if infotext is not None and infotext != "":
512
msgfile = file(msgfilename, "w")
513
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
518
if not _run_editor(msgfilename):
523
lastline, nlines = 0, 0
524
for line in file(msgfilename, "r"):
525
stripped_line = line.strip()
526
# strip empty line before the log message starts
528
if stripped_line != "":
532
# check for the ignore line only if there
533
# is additional information at the end
534
if hasinfo and stripped_line == ignoreline:
537
# keep track of the last line that had some content
538
if stripped_line != "":
544
# delete empty lines at the end
546
# add a newline at the end, if needed
547
if not msg[-1].endswith("\n"):
548
return "%s%s" % ("".join(msg), "\n")
552
# delete the msg file in any case
553
try: os.unlink(msgfilename)
646
head, tail = os.path.split(head)
650
raise PathNotChild(rp, base)
658
def safe_unicode(unicode_or_utf8_string):
659
"""Coerce unicode_or_utf8_string into unicode.
661
If it is unicode, it is returned.
662
Otherwise it is decoded from utf-8. If a decoding error
663
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
664
as a BzrBadParameter exception.
666
if isinstance(unicode_or_utf8_string, unicode):
667
return unicode_or_utf8_string
669
return unicode_or_utf8_string.decode('utf8')
670
except UnicodeDecodeError:
671
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
674
_platform_normalizes_filenames = False
675
if sys.platform == 'darwin':
676
_platform_normalizes_filenames = True
679
def normalizes_filenames():
680
"""Return True if this platform normalizes unicode filenames.
682
Mac OSX does, Windows/Linux do not.
684
return _platform_normalizes_filenames
687
if _platform_normalizes_filenames:
688
def unicode_filename(path):
689
"""Make sure 'path' is a properly normalized filename.
691
On platforms where the system normalizes filenames (Mac OSX),
692
you can access a file by any path which will normalize
694
Internally, bzr only supports NFC/NFKC normalization, since
695
that is the standard for XML documents.
696
So we return an normalized path, and indicate this has been
699
:return: (path, is_normalized) Return a path which can
700
access the file, and whether or not this path is
703
return unicodedata.normalize('NFKC', path), True
705
def unicode_filename(path):
706
"""Make sure 'path' is a properly normalized filename.
708
On platforms where the system does not normalize filenames
709
(Windows, Linux), you have to access a file by its exact path.
710
Internally, bzr only supports NFC/NFKC normalization, since
711
that is the standard for XML documents.
712
So we return the original path, and indicate if this is
715
:return: (path, is_normalized) Return a path which can
716
access the file, and whether or not this path is
719
return path, unicodedata.normalize('NFKC', path) == path
722
def terminal_width():
723
"""Return estimated terminal width."""
725
# TODO: Do something smart on Windows?
727
# TODO: Is there anything that gets a better update when the window
728
# is resized while the program is running? We could use the Python termcap
731
return int(os.environ['COLUMNS'])
732
except (IndexError, KeyError, ValueError):
735
def supports_executable():
736
return sys.platform != "win32"
739
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
742
def check_legal_path(path):
743
"""Check whether the supplied path is legal.
744
This is only required on Windows, so we don't test on other platforms
747
if sys.platform != "win32":
749
if _validWin32PathRE.match(path) is None:
750
raise IllegalPath(path)
added
removed
bzrlib/osutils.py
