1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2009 Canonical Ltd
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
11
# GNU General Public License for more details.
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
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
22
from bzrlib.errors import BzrError
23
from bzrlib.trace import mutter
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
28
from datetime import datetime
30
from ntpath import (abspath as _nt_abspath,
32
normpath as _nt_normpath,
33
realpath as _nt_realpath,
34
splitdrive as _nt_splitdrive,
42
from tempfile import (
54
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
56
if sys.version_info < (2, 5):
57
import md5 as _mod_md5
59
import sha as _mod_sha
69
from bzrlib import symbol_versioning
72
# On win32, O_BINARY is used to indicate the file should
73
# be opened in binary mode, rather than text mode.
74
# On other platforms, O_BINARY doesn't exist, because
75
# they always open in binary mode, so it is okay to
76
# OR with 0 on those platforms
77
O_BINARY = getattr(os, 'O_BINARY', 0)
26
80
def make_readonly(filename):
27
81
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
mod = os.stat(filename).st_mode
31
os.chmod(filename, mod)
82
mod = os.lstat(filename).st_mode
83
if not stat.S_ISLNK(mod):
85
os.chmod(filename, mod)
34
88
def make_writable(filename):
35
mod = os.stat(filename).st_mode
37
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
89
mod = os.lstat(filename).st_mode
90
if not stat.S_ISLNK(mod):
92
os.chmod(filename, mod)
95
def minimum_path_selection(paths):
96
"""Return the smallset subset of paths which are outside paths.
98
:param paths: A container (and hence not None) of paths.
99
:return: A set of paths sufficient to include everything in paths via
100
is_inside_any, drawn from the paths parameter.
105
other_paths = paths.difference([path])
106
if not is_inside_any(other_paths, path):
107
# this is a top level path, we must check it.
108
search_paths.add(path)
42
116
"""Return a quoted filename filename
44
118
This previously used backslash quoting, but that works poorly on
46
120
# TODO: I'm not really sure this is the best format either.x
122
if _QUOTE_RE is None:
123
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
47
125
if _QUOTE_RE.search(f):
48
126
return '"' + f + '"'
54
mode = os.lstat(f)[ST_MODE]
62
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
131
_directory_kind = 'directory'
134
"""Return the current umask"""
135
# Assume that people aren't messing with the umask while running
136
# XXX: This is not thread safe, but there is no way to get the
137
# umask without setting it
145
_directory_kind: "/",
147
'tree-reference': '+',
65
151
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':
153
return _kind_marker_map[kind]
155
raise errors.BzrError('invalid file kind %r' % kind)
158
lexists = getattr(os.path, 'lexists', None)
162
stat = getattr(os, 'lstat', os.stat)
106
165
except OSError, e:
107
if e.errno != e.ENOENT:
166
if e.errno == errno.ENOENT:
169
raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
172
def fancy_rename(old, new, rename_func, unlink_func):
173
"""A fancy rename, when you don't have atomic rename.
175
:param old: The old path, to rename from
176
:param new: The new path, to rename to
177
:param rename_func: The potentially non-atomic rename function
178
:param unlink_func: A way to delete the target file if the full rename succeeds
181
# sftp rename doesn't allow overwriting, so play tricks:
182
base = os.path.basename(new)
183
dirname = os.path.dirname(new)
184
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
185
tmp_name = pathjoin(dirname, tmp_name)
187
# Rename the file out of the way, but keep track if it didn't exist
188
# We don't want to grab just any exception
189
# something like EACCES should prevent us from continuing
190
# The downside is that the rename_func has to throw an exception
191
# with an errno = ENOENT, or NoSuchFile
194
rename_func(new, tmp_name)
195
except (errors.NoSuchFile,), e:
198
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
199
# function raises an IOError with errno is None when a rename fails.
200
# This then gets caught here.
201
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
204
if (getattr(e, 'errno', None) is None
205
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
213
# This may throw an exception, in which case success will
215
rename_func(old, new)
217
except (IOError, OSError), e:
218
# source and target may be aliases of each other (e.g. on a
219
# case-insensitive filesystem), so we may have accidentally renamed
220
# source by when we tried to rename target
221
if not (file_existed and e.errno in (None, errno.ENOENT)):
109
os.rename(path_from, path_to)
225
# If the file used to exist, rename it back into place
226
# otherwise just delete it from the tmp location
228
unlink_func(tmp_name)
230
rename_func(tmp_name, new)
233
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
234
# choke on a Unicode string containing a relative path if
235
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
237
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
238
def _posix_abspath(path):
239
# jam 20060426 rather than encoding to fsencoding
240
# copy posixpath.abspath, but use os.getcwdu instead
241
if not posixpath.isabs(path):
242
path = posixpath.join(getcwd(), path)
243
return posixpath.normpath(path)
246
def _posix_realpath(path):
247
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
250
def _win32_fixdrive(path):
251
"""Force drive letters to be consistent.
253
win32 is inconsistent whether it returns lower or upper case
254
and even if it was consistent the user might type the other
255
so we force it to uppercase
256
running python.exe under cmd.exe return capital C:\\
257
running win32 python inside a cygwin shell returns lowercase c:\\
259
drive, path = _nt_splitdrive(path)
260
return drive.upper() + path
263
def _win32_abspath(path):
264
# Real _nt_abspath doesn't have a problem with a unicode cwd
265
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
268
def _win98_abspath(path):
269
"""Return the absolute version of a path.
270
Windows 98 safe implementation (python reimplementation
271
of Win32 API function GetFullPathNameW)
276
# \\HOST\path => //HOST/path
277
# //HOST/path => //HOST/path
278
# path => C:/cwd/path
281
# check for absolute path
282
drive = _nt_splitdrive(path)[0]
283
if drive == '' and path[:2] not in('//','\\\\'):
285
# we cannot simply os.path.join cwd and path
286
# because os.path.join('C:','/path') produce '/path'
287
# and this is incorrect
288
if path[:1] in ('/','\\'):
289
cwd = _nt_splitdrive(cwd)[0]
291
path = cwd + '\\' + path
292
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
295
def _win32_realpath(path):
296
# Real _nt_realpath doesn't have a problem with a unicode cwd
297
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
300
def _win32_pathjoin(*args):
301
return _nt_join(*args).replace('\\', '/')
304
def _win32_normpath(path):
305
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
309
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
312
def _win32_mkdtemp(*args, **kwargs):
313
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
316
def _win32_rename(old, new):
317
"""We expect to be able to atomically replace 'new' with old.
319
On win32, if new exists, it must be moved out of the way first,
323
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
325
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
326
# If we try to rename a non-existant file onto cwd, we get
327
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
328
# if the old path doesn't exist, sometimes we get EACCES
329
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
335
return unicodedata.normalize('NFC', os.getcwdu())
338
# Default is to just use the python builtins, but these can be rebound on
339
# particular platforms.
340
abspath = _posix_abspath
341
realpath = _posix_realpath
342
pathjoin = os.path.join
343
normpath = os.path.normpath
346
dirname = os.path.dirname
347
basename = os.path.basename
348
split = os.path.split
349
splitext = os.path.splitext
350
# These were already imported into local scope
351
# mkdtemp = tempfile.mkdtemp
352
# rmtree = shutil.rmtree
354
MIN_ABS_PATHLENGTH = 1
357
if sys.platform == 'win32':
358
if win32utils.winver == 'Windows 98':
359
abspath = _win98_abspath
361
abspath = _win32_abspath
362
realpath = _win32_realpath
363
pathjoin = _win32_pathjoin
364
normpath = _win32_normpath
365
getcwd = _win32_getcwd
366
mkdtemp = _win32_mkdtemp
367
rename = _win32_rename
369
MIN_ABS_PATHLENGTH = 3
371
def _win32_delete_readonly(function, path, excinfo):
372
"""Error handler for shutil.rmtree function [for win32]
373
Helps to remove files and dirs marked as read-only.
375
exception = excinfo[1]
376
if function in (os.remove, os.rmdir) \
377
and isinstance(exception, OSError) \
378
and exception.errno == errno.EACCES:
384
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
385
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
386
return shutil.rmtree(path, ignore_errors, onerror)
387
elif sys.platform == 'darwin':
391
def get_terminal_encoding():
392
"""Find the best encoding for printing to the screen.
394
This attempts to check both sys.stdout and sys.stdin to see
395
what encoding they are in, and if that fails it falls back to
396
osutils.get_user_encoding().
397
The problem is that on Windows, locale.getpreferredencoding()
398
is not the same encoding as that used by the console:
399
http://mail.python.org/pipermail/python-list/2003-May/162357.html
401
On my standard US Windows XP, the preferred encoding is
402
cp1252, but the console is cp437
404
from bzrlib.trace import mutter
405
output_encoding = getattr(sys.stdout, 'encoding', None)
406
if not output_encoding:
407
input_encoding = getattr(sys.stdin, 'encoding', None)
408
if not input_encoding:
409
output_encoding = get_user_encoding()
410
mutter('encoding stdout as osutils.get_user_encoding() %r',
413
output_encoding = input_encoding
414
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
416
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
417
if output_encoding == 'cp0':
418
# invalid encoding (cp0 means 'no codepage' on Windows)
419
output_encoding = get_user_encoding()
420
mutter('cp0 is invalid encoding.'
421
' encoding stdout as osutils.get_user_encoding() %r',
425
codecs.lookup(output_encoding)
427
sys.stderr.write('bzr: warning:'
428
' unknown terminal encoding %s.\n'
429
' Using encoding %s instead.\n'
430
% (output_encoding, get_user_encoding())
432
output_encoding = get_user_encoding()
434
return output_encoding
437
def normalizepath(f):
438
if getattr(os.path, 'realpath', None) is not None:
442
[p,e] = os.path.split(f)
443
if e == "" or e == "." or e == "..":
446
return pathjoin(F(p), e)
312
661
def local_time_offset(t=None):
313
662
"""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:
321
return -time.timezone
324
def format_date(t, offset=0, timezone='original'):
325
## TODO: Perhaps a global option to use either universal or local time?
326
## Or perhaps just let people set $TZ?
327
assert isinstance(t, float)
665
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
666
return offset.days * 86400 + offset.seconds
668
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
670
def format_date(t, offset=0, timezone='original', date_fmt=None,
672
"""Return a formatted date string.
674
:param t: Seconds since the epoch.
675
:param offset: Timezone offset in seconds east of utc.
676
:param timezone: How to display the time: 'utc', 'original' for the
677
timezone specified by offset, or 'local' for the process's current
679
:param date_fmt: strftime format.
680
:param show_offset: Whether to append the timezone.
682
(date_fmt, tt, offset_str) = \
683
_format_date(t, offset, timezone, date_fmt, show_offset)
684
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
685
date_str = time.strftime(date_fmt, tt)
686
return date_str + offset_str
688
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
690
"""Return an unicode date string formatted according to the current locale.
692
:param t: Seconds since the epoch.
693
:param offset: Timezone offset in seconds east of utc.
694
:param timezone: How to display the time: 'utc', 'original' for the
695
timezone specified by offset, or 'local' for the process's current
697
:param date_fmt: strftime format.
698
:param show_offset: Whether to append the timezone.
700
(date_fmt, tt, offset_str) = \
701
_format_date(t, offset, timezone, date_fmt, show_offset)
702
date_str = time.strftime(date_fmt, tt)
703
if not isinstance(date_str, unicode):
704
date_str = date_str.decode(bzrlib.user_encoding, 'replace')
705
return date_str + offset_str
707
def _format_date(t, offset, timezone, date_fmt, show_offset):
329
708
if timezone == 'utc':
330
709
tt = time.gmtime(t)
332
711
elif timezone == 'original':
335
714
tt = time.gmtime(t + offset)
336
715
elif timezone == 'local':
337
716
tt = time.localtime(t)
338
717
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))
719
raise errors.UnsupportedTimezoneFormat(timezone)
721
date_fmt = "%a %Y-%m-%d %H:%M:%S"
723
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
726
return (date_fmt, tt, offset_str)
347
729
def compact_date(when):
348
730
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
733
def format_delta(delta):
734
"""Get a nice looking string for a time delta.
736
:param delta: The time difference in seconds, can be positive or negative.
737
positive indicates time in the past, negative indicates time in the
738
future. (usually time.time() - stored_time)
739
:return: String formatted to show approximate resolution
745
direction = 'in the future'
749
if seconds < 90: # print seconds up to 90 seconds
751
return '%d second %s' % (seconds, direction,)
753
return '%d seconds %s' % (seconds, direction)
755
minutes = int(seconds / 60)
756
seconds -= 60 * minutes
761
if minutes < 90: # print minutes, seconds up to 90 minutes
763
return '%d minute, %d second%s %s' % (
764
minutes, seconds, plural_seconds, direction)
766
return '%d minutes, %d second%s %s' % (
767
minutes, seconds, plural_seconds, direction)
769
hours = int(minutes / 60)
770
minutes -= 60 * hours
777
return '%d hour, %d minute%s %s' % (hours, minutes,
778
plural_minutes, direction)
779
return '%d hours, %d minute%s %s' % (hours, minutes,
780
plural_minutes, direction)
353
783
"""Return size of given open file."""
354
784
return os.fstat(f.fileno())[ST_SIZE]
357
if hasattr(os, 'urandom'): # python 2.4 and later
787
# Define rand_bytes based on platform.
789
# Python 2.4 and later have os.urandom,
790
# but it doesn't work on some arches
358
792
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))
793
except (NotImplementedError, AttributeError):
794
# If python doesn't have os.urandom, or it doesn't work,
795
# then try to first pull random data from /dev/urandom
797
rand_bytes = file('/dev/urandom', 'rb').read
798
# Otherwise, use this hack as a last resort
799
except (IOError, OSError):
800
# not well seeded, but better than nothing
805
s += chr(random.randint(0, 255))
810
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
812
"""Return a random string of num alphanumeric characters
814
The result only contains lowercase chars because it may be used on
815
case-insensitive filesystems.
818
for raw_byte in rand_bytes(num):
819
s += ALNUM[ord(raw_byte) % 36]
372
823
## TODO: We could later have path objects that remember their list
373
824
## decomposition (might be too tricksy though.)
375
826
def splitpath(p):
376
"""Turn string into list of parts.
382
>>> splitpath('a/./b')
384
>>> splitpath('a/.b')
386
>>> splitpath('a/../b')
387
Traceback (most recent call last):
389
BzrError: sorry, '..' not allowed in path
391
assert isinstance(p, types.StringTypes)
827
"""Turn string into list of parts."""
393
828
# split on either delimiter because people might use either on
395
830
ps = re.split(r'[\\/]', p)
400
raise BzrError("sorry, %r not allowed in path" % f)
835
raise errors.BzrError("sorry, %r not allowed in path" % f)
401
836
elif (f == '.') or (f == ''):
408
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)
415
def appendpath(p1, p2):
419
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"""
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:
845
if (f == '..') or (f is None) or (f == ''):
846
raise errors.BzrError("sorry, %r not allowed in path" % f)
851
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
853
from bzrlib._chunks_to_lines_py import chunks_to_lines
857
"""Split s into lines, but without removing the newline characters."""
858
# Trivially convert a fulltext into a 'chunked' representation, and let
859
# chunks_to_lines do the heavy lifting.
860
if isinstance(s, str):
861
# chunks_to_lines only supports 8-bit strings
862
return chunks_to_lines([s])
864
return _split_lines(s)
868
"""Split s into lines, but without removing the newline characters.
870
This supports Unicode or plain string objects.
872
lines = s.split('\n')
873
result = [line + '\n' for line in lines[:-1]]
875
result.append(lines[-1])
879
def hardlinks_good():
880
return sys.platform not in ('win32', 'cygwin', 'darwin')
883
def link_or_copy(src, dest):
884
"""Hardlink a file, or copy it if it can't be hardlinked."""
885
if not hardlinks_good():
886
shutil.copyfile(src, dest)
890
except (OSError, IOError), e:
891
if e.errno != errno.EXDEV:
893
shutil.copyfile(src, dest)
896
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
897
# Forgiveness than Permission (EAFP) because:
898
# - root can damage a solaris file system by using unlink,
899
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
900
# EACCES, OSX: EPERM) when invoked on a directory.
901
def delete_any(path):
902
"""Delete a file or directory."""
903
if isdir(path): # Takes care of symlinks
910
if getattr(os, 'symlink', None) is not None:
917
if getattr(os, 'link', None) is not None:
923
def host_os_dereferences_symlinks():
924
return (has_symlinks()
925
and sys.platform not in ('cygwin', 'win32'))
928
def readlink(abspath):
929
"""Return a string representing the path to which the symbolic link points.
931
:param abspath: The link absolute unicode path.
933
This his guaranteed to return the symbolic link in unicode in all python
936
link = abspath.encode(_fs_enc)
937
target = os.readlink(link)
938
target = target.decode(_fs_enc)
942
def contains_whitespace(s):
943
"""True if there are any whitespace characters in s."""
944
# string.whitespace can include '\xa0' in certain locales, because it is
945
# considered "non-breaking-space" as part of ISO-8859-1. But it
946
# 1) Isn't a breaking whitespace
947
# 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
949
# 3) '\xa0' isn't unicode safe since it is >128.
951
# This should *not* be a unicode set of characters in case the source
952
# string is not a Unicode string. We can auto-up-cast the characters since
953
# they are ascii, but we don't want to auto-up-cast the string in case it
955
for ch in ' \t\n\r\v\f':
962
def contains_linebreaks(s):
963
"""True if there is any vertical whitespace in s."""
971
def relpath(base, path):
972
"""Return path relative to base, or raise exception.
974
The path may be either an absolute path or a path relative to the
975
current working directory.
977
os.path.commonprefix (python2.4) has a bad bug that it works just
978
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
982
if len(base) < MIN_ABS_PATHLENGTH:
983
# must have space for e.g. a drive letter
984
raise ValueError('%r is too short to calculate a relative path'
991
while len(head) >= len(base):
994
head, tail = os.path.split(head)
998
raise errors.PathNotChild(rp, base)
1006
def _cicp_canonical_relpath(base, path):
1007
"""Return the canonical path relative to base.
1009
Like relpath, but on case-insensitive-case-preserving file-systems, this
1010
will return the relpath as stored on the file-system rather than in the
1011
case specified in the input string, for all existing portions of the path.
1013
This will cause O(N) behaviour if called for every path in a tree; if you
1014
have a number of paths to convert, you should use canonical_relpaths().
1016
# TODO: it should be possible to optimize this for Windows by using the
1017
# win32 API FindFiles function to look for the specified name - but using
1018
# os.listdir() still gives us the correct, platform agnostic semantics in
1021
rel = relpath(base, path)
1022
# '.' will have been turned into ''
1026
abs_base = abspath(base)
1028
_listdir = os.listdir
1030
# use an explicit iterator so we can easily consume the rest on early exit.
1031
bit_iter = iter(rel.split('/'))
1032
for bit in bit_iter:
1034
for look in _listdir(current):
1035
if lbit == look.lower():
1036
current = pathjoin(current, look)
1039
# got to the end, nothing matched, so we just return the
1040
# non-existing bits as they were specified (the filename may be
1041
# the target of a move, for example).
1042
current = pathjoin(current, bit, *list(bit_iter))
1044
return current[len(abs_base)+1:]
1046
# XXX - TODO - we need better detection/integration of case-insensitive
1047
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1048
# filesystems), for example, so could probably benefit from the same basic
1049
# support there. For now though, only Windows and OSX get that support, and
1050
# they get it for *all* file-systems!
1051
if sys.platform in ('win32', 'darwin'):
1052
canonical_relpath = _cicp_canonical_relpath
1054
canonical_relpath = relpath
1056
def canonical_relpaths(base, paths):
1057
"""Create an iterable to canonicalize a sequence of relative paths.
1059
The intent is for this implementation to use a cache, vastly speeding
1060
up multiple transformations in the same directory.
1062
# but for now, we haven't optimized...
1063
return [canonical_relpath(base, p) for p in paths]
1065
def safe_unicode(unicode_or_utf8_string):
1066
"""Coerce unicode_or_utf8_string into unicode.
1068
If it is unicode, it is returned.
1069
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1070
wrapped in a BzrBadParameterNotUnicode exception.
1072
if isinstance(unicode_or_utf8_string, unicode):
1073
return unicode_or_utf8_string
1075
return unicode_or_utf8_string.decode('utf8')
1076
except UnicodeDecodeError:
1077
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1080
def safe_utf8(unicode_or_utf8_string):
1081
"""Coerce unicode_or_utf8_string to a utf8 string.
1083
If it is a str, it is returned.
1084
If it is Unicode, it is encoded into a utf-8 string.
1086
if isinstance(unicode_or_utf8_string, str):
1087
# TODO: jam 20070209 This is overkill, and probably has an impact on
1088
# performance if we are dealing with lots of apis that want a
1091
# Make sure it is a valid utf-8 string
1092
unicode_or_utf8_string.decode('utf-8')
1093
except UnicodeDecodeError:
1094
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1095
return unicode_or_utf8_string
1096
return unicode_or_utf8_string.encode('utf-8')
1099
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1100
' Revision id generators should be creating utf8'
1104
def safe_revision_id(unicode_or_utf8_string, warn=True):
1105
"""Revision ids should now be utf8, but at one point they were unicode.
1107
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1109
:param warn: Functions that are sanitizing user data can set warn=False
1110
:return: None or a utf8 revision id.
1112
if (unicode_or_utf8_string is None
1113
or unicode_or_utf8_string.__class__ == str):
1114
return unicode_or_utf8_string
1116
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1118
return cache_utf8.encode(unicode_or_utf8_string)
1121
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1122
' generators should be creating utf8 file ids.')
1125
def safe_file_id(unicode_or_utf8_string, warn=True):
1126
"""File ids should now be utf8, but at one point they were unicode.
1128
This is the same as safe_utf8, except it uses the cached encode functions
1129
to save a little bit of performance.
1131
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1133
:param warn: Functions that are sanitizing user data can set warn=False
1134
:return: None or a utf8 file id.
1136
if (unicode_or_utf8_string is None
1137
or unicode_or_utf8_string.__class__ == str):
1138
return unicode_or_utf8_string
1140
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1142
return cache_utf8.encode(unicode_or_utf8_string)
1145
_platform_normalizes_filenames = False
1146
if sys.platform == 'darwin':
1147
_platform_normalizes_filenames = True
1150
def normalizes_filenames():
1151
"""Return True if this platform normalizes unicode filenames.
1153
Mac OSX does, Windows/Linux do not.
1155
return _platform_normalizes_filenames
1158
def _accessible_normalized_filename(path):
1159
"""Get the unicode normalized path, and if you can access the file.
1161
On platforms where the system normalizes filenames (Mac OSX),
1162
you can access a file by any path which will normalize correctly.
1163
On platforms where the system does not normalize filenames
1164
(Windows, Linux), you have to access a file by its exact path.
1166
Internally, bzr only supports NFC normalization, since that is
1167
the standard for XML documents.
1169
So return the normalized path, and a flag indicating if the file
1170
can be accessed by that path.
1173
return unicodedata.normalize('NFC', unicode(path)), True
1176
def _inaccessible_normalized_filename(path):
1177
__doc__ = _accessible_normalized_filename.__doc__
1179
normalized = unicodedata.normalize('NFC', unicode(path))
1180
return normalized, normalized == path
1183
if _platform_normalizes_filenames:
1184
normalized_filename = _accessible_normalized_filename
1186
normalized_filename = _inaccessible_normalized_filename
1189
def terminal_width():
1190
"""Return estimated terminal width."""
1191
if sys.platform == 'win32':
1192
return win32utils.get_console_size()[0]
1195
import struct, fcntl, termios
1196
s = struct.pack('HHHH', 0, 0, 0, 0)
1197
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1198
width = struct.unpack('HHHH', x)[1]
1203
width = int(os.environ['COLUMNS'])
1212
def supports_executable():
1213
return sys.platform != "win32"
1216
def supports_posix_readonly():
1217
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1219
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1220
directory controls creation/deletion, etc.
1222
And under win32, readonly means that the directory itself cannot be
1223
deleted. The contents of a readonly directory can be changed, unlike POSIX
1224
where files in readonly directories cannot be added, deleted or renamed.
1226
return sys.platform != "win32"
1229
def set_or_unset_env(env_variable, value):
1230
"""Modify the environment, setting or removing the env_variable.
1232
:param env_variable: The environment variable in question
1233
:param value: The value to set the environment to. If None, then
1234
the variable will be removed.
1235
:return: The original value of the environment variable.
1237
orig_val = os.environ.get(env_variable)
1239
if orig_val is not None:
1240
del os.environ[env_variable]
1242
if isinstance(value, unicode):
1243
value = value.encode(get_user_encoding())
1244
os.environ[env_variable] = value
1248
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1251
def check_legal_path(path):
1252
"""Check whether the supplied path is legal.
1253
This is only required on Windows, so we don't test on other platforms
1256
if sys.platform != "win32":
1258
if _validWin32PathRE.match(path) is None:
1259
raise errors.IllegalPath(path)
1262
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1264
def _is_error_enotdir(e):
1265
"""Check if this exception represents ENOTDIR.
1267
Unfortunately, python is very inconsistent about the exception
1268
here. The cases are:
1269
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1270
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1271
which is the windows error code.
1272
3) Windows, Python2.5 uses errno == EINVAL and
1273
winerror == ERROR_DIRECTORY
1275
:param e: An Exception object (expected to be OSError with an errno
1276
attribute, but we should be able to cope with anything)
1277
:return: True if this represents an ENOTDIR error. False otherwise.
1279
en = getattr(e, 'errno', None)
1280
if (en == errno.ENOTDIR
1281
or (sys.platform == 'win32'
1282
and (en == _WIN32_ERROR_DIRECTORY
1283
or (en == errno.EINVAL
1284
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1290
def walkdirs(top, prefix=""):
1291
"""Yield data about all the directories in a tree.
1293
This yields all the data about the contents of a directory at a time.
1294
After each directory has been yielded, if the caller has mutated the list
1295
to exclude some directories, they are then not descended into.
1297
The data yielded is of the form:
1298
((directory-relpath, directory-path-from-top),
1299
[(relpath, basename, kind, lstat, path-from-top), ...]),
1300
- directory-relpath is the relative path of the directory being returned
1301
with respect to top. prefix is prepended to this.
1302
- directory-path-from-root is the path including top for this directory.
1303
It is suitable for use with os functions.
1304
- relpath is the relative path within the subtree being walked.
1305
- basename is the basename of the path
1306
- kind is the kind of the file now. If unknown then the file is not
1307
present within the tree - but it may be recorded as versioned. See
1309
- lstat is the stat data *if* the file was statted.
1310
- planned, not implemented:
1311
path_from_tree_root is the path from the root of the tree.
1313
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1314
allows one to walk a subtree but get paths that are relative to a tree
1316
:return: an iterator over the dirs.
1318
#TODO there is a bit of a smell where the results of the directory-
1319
# summary in this, and the path from the root, may not agree
1320
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1321
# potentially confusing output. We should make this more robust - but
1322
# not at a speed cost. RBC 20060731
1324
_directory = _directory_kind
1325
_listdir = os.listdir
1326
_kind_from_mode = file_kind_from_stat_mode
1327
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1329
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1330
relroot, _, _, _, top = pending.pop()
1332
relprefix = relroot + u'/'
1335
top_slash = top + u'/'
1338
append = dirblock.append
1340
names = sorted(_listdir(top))
1342
if not _is_error_enotdir(e):
1346
abspath = top_slash + name
1347
statvalue = _lstat(abspath)
1348
kind = _kind_from_mode(statvalue.st_mode)
1349
append((relprefix + name, name, kind, statvalue, abspath))
1350
yield (relroot, top), dirblock
1352
# push the user specified dirs from dirblock
1353
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1356
class DirReader(object):
1357
"""An interface for reading directories."""
1359
def top_prefix_to_starting_dir(self, top, prefix=""):
1360
"""Converts top and prefix to a starting dir entry
1362
:param top: A utf8 path
1363
:param prefix: An optional utf8 path to prefix output relative paths
1365
:return: A tuple starting with prefix, and ending with the native
1368
raise NotImplementedError(self.top_prefix_to_starting_dir)
1370
def read_dir(self, prefix, top):
1371
"""Read a specific dir.
1373
:param prefix: A utf8 prefix to be preprended to the path basenames.
1374
:param top: A natively encoded path to read.
1375
:return: A list of the directories contents. Each item contains:
1376
(utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1378
raise NotImplementedError(self.read_dir)
1381
_selected_dir_reader = None
1384
def _walkdirs_utf8(top, prefix=""):
1385
"""Yield data about all the directories in a tree.
1387
This yields the same information as walkdirs() only each entry is yielded
1388
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1389
are returned as exact byte-strings.
1391
:return: yields a tuple of (dir_info, [file_info])
1392
dir_info is (utf8_relpath, path-from-top)
1393
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1394
if top is an absolute path, path-from-top is also an absolute path.
1395
path-from-top might be unicode or utf8, but it is the correct path to
1396
pass to os functions to affect the file in question. (such as os.lstat)
1398
global _selected_dir_reader
1399
if _selected_dir_reader is None:
1400
fs_encoding = _fs_enc.upper()
1401
if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1402
# Win98 doesn't have unicode apis like FindFirstFileW
1403
# TODO: We possibly could support Win98 by falling back to the
1404
# original FindFirstFile, and using TCHAR instead of WCHAR,
1405
# but that gets a bit tricky, and requires custom compiling
1408
from bzrlib._walkdirs_win32 import Win32ReadDir
1409
_selected_dir_reader = Win32ReadDir()
1412
elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1413
# ANSI_X3.4-1968 is a form of ASCII
1415
from bzrlib._readdir_pyx import UTF8DirReader
1416
_selected_dir_reader = UTF8DirReader()
1420
if _selected_dir_reader is None:
1421
# Fallback to the python version
1422
_selected_dir_reader = UnicodeDirReader()
1424
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1425
# But we don't actually uses 1-3 in pending, so set them to None
1426
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1427
read_dir = _selected_dir_reader.read_dir
1428
_directory = _directory_kind
1430
relroot, _, _, _, top = pending[-1].pop()
1433
dirblock = sorted(read_dir(relroot, top))
1434
yield (relroot, top), dirblock
1435
# push the user specified dirs from dirblock
1436
next = [d for d in reversed(dirblock) if d[2] == _directory]
1438
pending.append(next)
1441
class UnicodeDirReader(DirReader):
1442
"""A dir reader for non-utf8 file systems, which transcodes."""
1444
__slots__ = ['_utf8_encode']
1447
self._utf8_encode = codecs.getencoder('utf8')
1449
def top_prefix_to_starting_dir(self, top, prefix=""):
1450
"""See DirReader.top_prefix_to_starting_dir."""
1451
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1453
def read_dir(self, prefix, top):
1454
"""Read a single directory from a non-utf8 file system.
1456
top, and the abspath element in the output are unicode, all other paths
1457
are utf8. Local disk IO is done via unicode calls to listdir etc.
1459
This is currently the fallback code path when the filesystem encoding is
1460
not UTF-8. It may be better to implement an alternative so that we can
1461
safely handle paths that are not properly decodable in the current
1464
See DirReader.read_dir for details.
1466
_utf8_encode = self._utf8_encode
1468
_listdir = os.listdir
1469
_kind_from_mode = file_kind_from_stat_mode
1472
relprefix = prefix + '/'
1475
top_slash = top + u'/'
1478
append = dirblock.append
1479
for name in sorted(_listdir(top)):
1481
name_utf8 = _utf8_encode(name)[0]
1482
except UnicodeDecodeError:
1483
raise errors.BadFilenameEncoding(
1484
_utf8_encode(relprefix)[0] + name, _fs_enc)
1485
abspath = top_slash + name
1486
statvalue = _lstat(abspath)
1487
kind = _kind_from_mode(statvalue.st_mode)
1488
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1492
def copy_tree(from_path, to_path, handlers={}):
1493
"""Copy all of the entries in from_path into to_path.
1495
:param from_path: The base directory to copy.
1496
:param to_path: The target directory. If it does not exist, it will
1498
:param handlers: A dictionary of functions, which takes a source and
1499
destinations for files, directories, etc.
1500
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1501
'file', 'directory', and 'symlink' should always exist.
1502
If they are missing, they will be replaced with 'os.mkdir()',
1503
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1505
# Now, just copy the existing cached tree to the new location
1506
# We use a cheap trick here.
1507
# Absolute paths are prefixed with the first parameter
1508
# relative paths are prefixed with the second.
1509
# So we can get both the source and target returned
1510
# without any extra work.
1512
def copy_dir(source, dest):
1515
def copy_link(source, dest):
1516
"""Copy the contents of a symlink"""
1517
link_to = os.readlink(source)
1518
os.symlink(link_to, dest)
1520
real_handlers = {'file':shutil.copy2,
1521
'symlink':copy_link,
1522
'directory':copy_dir,
1524
real_handlers.update(handlers)
1526
if not os.path.exists(to_path):
1527
real_handlers['directory'](from_path, to_path)
1529
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1530
for relpath, name, kind, st, abspath in entries:
1531
real_handlers[kind](abspath, relpath)
1534
def path_prefix_key(path):
1535
"""Generate a prefix-order path key for path.
1537
This can be used to sort paths in the same way that walkdirs does.
1539
return (dirname(path) , path)
1542
def compare_paths_prefix_order(path_a, path_b):
1543
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1544
key_a = path_prefix_key(path_a)
1545
key_b = path_prefix_key(path_b)
1546
return cmp(key_a, key_b)
1549
_cached_user_encoding = None
1552
def get_user_encoding(use_cache=True):
1553
"""Find out what the preferred user encoding is.
1555
This is generally the encoding that is used for command line parameters
1556
and file contents. This may be different from the terminal encoding
1557
or the filesystem encoding.
1559
:param use_cache: Enable cache for detected encoding.
1560
(This parameter is turned on by default,
1561
and required only for selftesting)
1563
:return: A string defining the preferred user encoding
1565
global _cached_user_encoding
1566
if _cached_user_encoding is not None and use_cache:
1567
return _cached_user_encoding
1569
if sys.platform == 'darwin':
1570
# python locale.getpreferredencoding() always return
1571
# 'mac-roman' on darwin. That's a lie.
1572
sys.platform = 'posix'
1574
if os.environ.get('LANG', None) is None:
1575
# If LANG is not set, we end up with 'ascii', which is bad
1576
# ('mac-roman' is more than ascii), so we set a default which
1577
# will give us UTF-8 (which appears to work in all cases on
1578
# OSX). Users are still free to override LANG of course, as
1579
# long as it give us something meaningful. This work-around
1580
# *may* not be needed with python 3k and/or OSX 10.5, but will
1581
# work with them too -- vila 20080908
1582
os.environ['LANG'] = 'en_US.UTF-8'
1585
sys.platform = 'darwin'
1590
user_encoding = locale.getpreferredencoding()
1591
except locale.Error, e:
1592
sys.stderr.write('bzr: warning: %s\n'
1593
' Could not determine what text encoding to use.\n'
1594
' This error usually means your Python interpreter\n'
1595
' doesn\'t support the locale set by $LANG (%s)\n'
1596
" Continuing with ascii encoding.\n"
1597
% (e, os.environ.get('LANG')))
1598
user_encoding = 'ascii'
1600
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1601
# treat that as ASCII, and not support printing unicode characters to the
1604
# For python scripts run under vim, we get '', so also treat that as ASCII
1605
if user_encoding in (None, 'cp0', ''):
1606
user_encoding = 'ascii'
1610
codecs.lookup(user_encoding)
1612
sys.stderr.write('bzr: warning:'
1613
' unknown encoding %s.'
1614
' Continuing with ascii encoding.\n'
1617
user_encoding = 'ascii'
1620
_cached_user_encoding = user_encoding
1622
return user_encoding
1625
def get_host_name():
1626
"""Return the current unicode host name.
1628
This is meant to be used in place of socket.gethostname() because that
1629
behaves inconsistently on different platforms.
1631
if sys.platform == "win32":
1633
return win32utils.get_host_name()
1636
return socket.gethostname().decode(get_user_encoding())
1639
def recv_all(socket, bytes):
1640
"""Receive an exact number of bytes.
1642
Regular Socket.recv() may return less than the requested number of bytes,
1643
dependning on what's in the OS buffer. MSG_WAITALL is not available
1644
on all platforms, but this should work everywhere. This will return
1645
less than the requested amount if the remote end closes.
1647
This isn't optimized and is intended mostly for use in testing.
1650
while len(b) < bytes:
1651
new = until_no_eintr(socket.recv, bytes - len(b))
1658
def send_all(socket, bytes, report_activity=None):
1659
"""Send all bytes on a socket.
1661
Regular socket.sendall() can give socket error 10053 on Windows. This
1662
implementation sends no more than 64k at a time, which avoids this problem.
1664
:param report_activity: Call this as bytes are read, see
1665
Transport._report_activity
1668
for pos in xrange(0, len(bytes), chunk_size):
1669
block = bytes[pos:pos+chunk_size]
1670
if report_activity is not None:
1671
report_activity(len(block), 'write')
1672
until_no_eintr(socket.sendall, block)
1675
def dereference_path(path):
1676
"""Determine the real path to a file.
1678
All parent elements are dereferenced. But the file itself is not
1680
:param path: The original path. May be absolute or relative.
1681
:return: the real path *to* the file
1683
parent, base = os.path.split(path)
1684
# The pathjoin for '.' is a workaround for Python bug #1213894.
1685
# (initial path components aren't dereferenced)
1686
return pathjoin(realpath(pathjoin('.', parent)), base)
1689
def supports_mapi():
1690
"""Return True if we can use MAPI to launch a mail client."""
1691
return sys.platform == "win32"
1694
def resource_string(package, resource_name):
1695
"""Load a resource from a package and return it as a string.
1697
Note: Only packages that start with bzrlib are currently supported.
1699
This is designed to be a lightweight implementation of resource
1700
loading in a way which is API compatible with the same API from
1702
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
1703
If and when pkg_resources becomes a standard library, this routine
1706
# Check package name is within bzrlib
1707
if package == "bzrlib":
1708
resource_relpath = resource_name
1709
elif package.startswith("bzrlib."):
1710
package = package[len("bzrlib."):].replace('.', os.sep)
1711
resource_relpath = pathjoin(package, resource_name)
1713
raise errors.BzrError('resource package %s not in bzrlib' % package)
1715
# Map the resource to a file and read its contents
1716
base = dirname(bzrlib.__file__)
1717
if getattr(sys, 'frozen', None): # bzr.exe
1718
base = abspath(pathjoin(base, '..', '..'))
1719
filename = pathjoin(base, resource_relpath)
1720
return open(filename, 'rU').read()
1723
def file_kind_from_stat_mode_thunk(mode):
1724
global file_kind_from_stat_mode
1725
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
1727
from bzrlib._readdir_pyx import UTF8DirReader
1728
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1730
from bzrlib._readdir_py import (
1731
_kind_from_mode as file_kind_from_stat_mode
1733
return file_kind_from_stat_mode(mode)
1734
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1737
def file_kind(f, _lstat=os.lstat):
1739
return file_kind_from_stat_mode(_lstat(f).st_mode)
1741
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1742
raise errors.NoSuchFile(f)
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":
1746
def until_no_eintr(f, *a, **kw):
1747
"""Run f(*a, **kw), retrying if an EINTR error occurs."""
1748
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
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"):
1752
except (IOError, OSError), e:
1753
if e.errno == errno.EINTR:
1757
def re_compile_checked(re_string, flags=0, where=""):
1758
"""Return a compiled re, or raise a sensible error.
474
if ignoreline == "default":
475
ignoreline = "-- This line and the following will be ignored --"
1760
This should only be used when compiling user-supplied REs.
1762
:param re_string: Text form of regular expression.
1763
:param flags: eg re.IGNORECASE
1764
:param where: Message explaining to the user the context where
1765
it occurred, eg 'log search filter'.
1767
# from https://bugs.launchpad.net/bzr/+bug/251352
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)
1769
re_obj = re.compile(re_string, flags)
1774
where = ' in ' + where
1775
# despite the name 'error' is a type
1776
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
1777
% (where, re_string, e))
1780
if sys.platform == "win32":
1783
return msvcrt.getch()
1788
fd = sys.stdin.fileno()
1789
settings = termios.tcgetattr(fd)
1792
ch = sys.stdin.read(1)
1794
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
added
removed
bzrlib/osutils.py
