~bzr-pqm/bzr/bzr.dev

2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
2
#
1 by mbp at sourcefrog
import from baz patch-364
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
7
#
1 by mbp at sourcefrog
import from baz patch-364
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
12
#
1 by mbp at sourcefrog
import from baz patch-364
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
1390 by Robert Collins
pair programming worx... merge integration and weave
17
from cStringIO import StringIO
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
18
import os
19
import re
20
import stat
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
22
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
23
import sys
24
import time
25
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
2192.1.1 by Alexander Belchenko
Before actually using encoding need to check that Python has corresponding codec
28
import codecs
2215.6.1 by James Henstridge
Don't rely on time.timezone and time.altzone in local_time_offset(),
29
from datetime import datetime
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
30
import errno
1711.4.5 by John Arbash Meinel
the _posix_* routines should use posixpath not os.path, so tests pass on win32
31
from ntpath import (abspath as _nt_abspath,
32
                    join as _nt_join,
33
                    normpath as _nt_normpath,
34
                    realpath as _nt_realpath,
1711.5.2 by John Arbash Meinel
win32 likes to return lowercase drive letters sometimes, and uppercase at other times. normalize this
35
                    splitdrive as _nt_splitdrive,
1711.4.5 by John Arbash Meinel
the _posix_* routines should use posixpath not os.path, so tests pass on win32
36
                    )
37
import posixpath
1236 by Martin Pool
- fix up imports
38
import sha
1692.7.6 by Martin Pool
[patch] force deletion of trees containing readonly files (alexander)
39
import shutil
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
40
from shutil import (
41
    rmtree,
42
    )
1185.31.40 by John Arbash Meinel
Added osutils.mkdtemp()
43
import tempfile
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
44
from tempfile import (
45
    mkdtemp,
46
    )
1185.85.75 by John Arbash Meinel
Adding bzrlib.osutils.unicode_filename to handle unicode normalization for file paths.
47
import unicodedata
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
48
49
from bzrlib import (
2249.5.16 by John Arbash Meinel
[merge] bzr.dev 2283
50
    cache_utf8,
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
51
    errors,
2245.4.6 by Alexander Belchenko
osutils.py: terminal_width() now use win32utils.get_console_size()
52
    win32utils,
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
53
    )
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
54
""")
1 by mbp at sourcefrog
import from baz patch-364
55
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
56
import bzrlib
2309.4.3 by John Arbash Meinel
(broken) change safe_*_id to emit a warning.
57
from bzrlib import symbol_versioning
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
58
from bzrlib.symbol_versioning import (
59
    deprecated_function,
3123.1.1 by John Arbash Meinel
Update from deprecating 0.93 to 1.0, and add a 1.1 deprecation.
60
    one_zero,
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
61
    )
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
62
from bzrlib.trace import mutter
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
63
1 by mbp at sourcefrog
import from baz patch-364
64
1755.3.7 by John Arbash Meinel
Clean up and write tests for permissions. Now we use fstat which should be cheap, and lets us check the permissions and the file size
65
# On win32, O_BINARY is used to indicate the file should
66
# be opened in binary mode, rather than text mode.
67
# On other platforms, O_BINARY doesn't exist, because
68
# they always open in binary mode, so it is okay to
69
# OR with 0 on those platforms
70
O_BINARY = getattr(os, 'O_BINARY', 0)
71
72
1 by mbp at sourcefrog
import from baz patch-364
73
def make_readonly(filename):
74
    """Make a filename read-only."""
2949.6.1 by Alexander Belchenko
windows python has os.lstat
75
    mod = os.lstat(filename).st_mode
2568.1.1 by John Arbash Meinel
(Elliot Murphy) Use os.lstat rather than os.stat for osutils.make_readonly/make_writeable
76
    if not stat.S_ISLNK(mod):
77
        mod = mod & 0777555
78
        os.chmod(filename, mod)
1 by mbp at sourcefrog
import from baz patch-364
79
80
81
def make_writable(filename):
2949.6.1 by Alexander Belchenko
windows python has os.lstat
82
    mod = os.lstat(filename).st_mode
2568.1.1 by John Arbash Meinel
(Elliot Murphy) Use os.lstat rather than os.stat for osutils.make_readonly/make_writeable
83
    if not stat.S_ISLNK(mod):
84
        mod = mod | 0200
85
        os.chmod(filename, mod)
1 by mbp at sourcefrog
import from baz patch-364
86
87
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
88
def minimum_path_selection(paths):
89
    """Return the smallset subset of paths which are outside paths.
90
2843.1.1 by Ian Clatworthy
Faster partial commits by walking less data (Robert Collins)
91
    :param paths: A container (and hence not None) of paths.
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
92
    :return: A set of paths sufficient to include everything in paths via
93
        is_inside_any, drawn from the paths parameter.
94
    """
95
    search_paths = set()
96
    paths = set(paths)
97
    for path in paths:
2843.1.1 by Ian Clatworthy
Faster partial commits by walking less data (Robert Collins)
98
        other_paths = paths.difference([path])
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
99
        if not is_inside_any(other_paths, path):
100
            # this is a top level path, we must check it.
101
            search_paths.add(path)
102
    return search_paths
103
104
1077 by Martin Pool
- avoid compiling REs at module load time
105
_QUOTE_RE = None
969 by Martin Pool
- Add less-sucky is_within_any
106
107
1 by mbp at sourcefrog
import from baz patch-364
108
def quotefn(f):
779 by Martin Pool
- better quotefn for windows: use doublequotes for strings with
109
    """Return a quoted filename filename
110
111
    This previously used backslash quoting, but that works poorly on
112
    Windows."""
113
    # TODO: I'm not really sure this is the best format either.x
1077 by Martin Pool
- avoid compiling REs at module load time
114
    global _QUOTE_RE
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
115
    if _QUOTE_RE is None:
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
116
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
1077 by Martin Pool
- avoid compiling REs at module load time
117
        
779 by Martin Pool
- better quotefn for windows: use doublequotes for strings with
118
    if _QUOTE_RE.search(f):
119
        return '"' + f + '"'
120
    else:
121
        return f
1 by mbp at sourcefrog
import from baz patch-364
122
123
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
124
_directory_kind = 'directory'
125
1732.1.10 by John Arbash Meinel
Updated version of file_kind. Rather than multiple function calls, one mask + dictionary lookup
126
_formats = {
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
127
    stat.S_IFDIR:_directory_kind,
1732.1.10 by John Arbash Meinel
Updated version of file_kind. Rather than multiple function calls, one mask + dictionary lookup
128
    stat.S_IFCHR:'chardev',
129
    stat.S_IFBLK:'block',
130
    stat.S_IFREG:'file',
131
    stat.S_IFIFO:'fifo',
132
    stat.S_IFLNK:'symlink',
133
    stat.S_IFSOCK:'socket',
134
}
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
135
136
137
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
138
    """Generate a file kind from a stat mode. This is used in walkdirs.
139
140
    Its performance is critical: Do not mutate without careful benchmarking.
141
    """
1732.1.12 by John Arbash Meinel
improve bzrlib.osutils.file_kind performance from 324ms => 275ms
142
    try:
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
143
        return _formats[stat_mode & 0170000]
1732.1.12 by John Arbash Meinel
improve bzrlib.osutils.file_kind performance from 324ms => 275ms
144
    except KeyError:
1732.1.30 by John Arbash Meinel
More file_kind tweaks. Use keyword parameters to make everything a local variable.
145
        return _unknown
488 by Martin Pool
- new helper function kind_marker()
146
147
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
148
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
1757.2.4 by Robert Collins
Teach file_kind about NoSuchFile, reducing duplicate code, and add user files before entering the main loop in smart_add.
149
    try:
150
        return _mapper(_lstat(f).st_mode)
151
    except OSError, e:
152
        if getattr(e, 'errno', None) == errno.ENOENT:
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
153
            raise errors.NoSuchFile(f)
1757.2.4 by Robert Collins
Teach file_kind about NoSuchFile, reducing duplicate code, and add user files before entering the main loop in smart_add.
154
        raise
155
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
156
1755.3.7 by John Arbash Meinel
Clean up and write tests for permissions. Now we use fstat which should be cheap, and lets us check the permissions and the file size
157
def get_umask():
158
    """Return the current umask"""
159
    # Assume that people aren't messing with the umask while running
160
    # XXX: This is not thread safe, but there is no way to get the
161
    #      umask without setting it
162
    umask = os.umask(0)
163
    os.umask(umask)
164
    return umask
165
166
2324.2.1 by Dmitry Vasiliev
kind_marker() optimization
167
_kind_marker_map = {
168
    "file": "",
169
    _directory_kind: "/",
170
    "symlink": "@",
1551.10.30 by Aaron Bentley
Merge from bzr.dev
171
    'tree-reference': '+',
2324.2.1 by Dmitry Vasiliev
kind_marker() optimization
172
}
1551.10.30 by Aaron Bentley
Merge from bzr.dev
173
174
488 by Martin Pool
- new helper function kind_marker()
175
def kind_marker(kind):
2324.2.1 by Dmitry Vasiliev
kind_marker() optimization
176
    try:
177
        return _kind_marker_map[kind]
178
    except KeyError:
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
179
        raise errors.BzrError('invalid file kind %r' % kind)
1 by mbp at sourcefrog
import from baz patch-364
180
2324.2.1 by Dmitry Vasiliev
kind_marker() optimization
181
1732.1.2 by John Arbash Meinel
just use os.path.lexists if it exists
182
lexists = getattr(os.path, 'lexists', None)
183
if lexists is None:
184
    def lexists(f):
185
        try:
2324.2.2 by Dmitry Vasiliev
Fixed lexists() implementation
186
            stat = getattr(os, 'lstat', os.stat)
187
            stat(f)
1732.1.2 by John Arbash Meinel
just use os.path.lexists if it exists
188
            return True
2324.2.2 by Dmitry Vasiliev
Fixed lexists() implementation
189
        except OSError, e:
1732.1.2 by John Arbash Meinel
just use os.path.lexists if it exists
190
            if e.errno == errno.ENOENT:
191
                return False;
192
            else:
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
193
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
1732.1.2 by John Arbash Meinel
just use os.path.lexists if it exists
194
1 by mbp at sourcefrog
import from baz patch-364
195
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
196
def fancy_rename(old, new, rename_func, unlink_func):
197
    """A fancy rename, when you don't have atomic rename.
198
    
199
    :param old: The old path, to rename from
200
    :param new: The new path, to rename to
201
    :param rename_func: The potentially non-atomic rename function
202
    :param unlink_func: A way to delete the target file if the full rename succeeds
203
    """
204
205
    # sftp rename doesn't allow overwriting, so play tricks:
206
    import random
207
    base = os.path.basename(new)
208
    dirname = os.path.dirname(new)
1553.5.22 by Martin Pool
Change fancy_rename to use rand_chars rather than reinvent it.
209
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
210
    tmp_name = pathjoin(dirname, tmp_name)
211
212
    # Rename the file out of the way, but keep track if it didn't exist
213
    # We don't want to grab just any exception
214
    # something like EACCES should prevent us from continuing
215
    # The downside is that the rename_func has to throw an exception
216
    # with an errno = ENOENT, or NoSuchFile
217
    file_existed = False
218
    try:
219
        rename_func(new, tmp_name)
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
220
    except (errors.NoSuchFile,), e:
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
221
        pass
1532 by Robert Collins
Merge in John Meinels integration branch.
222
    except IOError, e:
223
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
224
        # function raises an IOError with errno is None when a rename fails.
1532 by Robert Collins
Merge in John Meinels integration branch.
225
        # This then gets caught here.
1185.50.37 by John Arbash Meinel
Fixed exception handling for fancy_rename
226
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
1532 by Robert Collins
Merge in John Meinels integration branch.
227
            raise
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
228
    except Exception, e:
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
229
        if (getattr(e, 'errno', None) is None
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
230
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
231
            raise
232
    else:
233
        file_existed = True
234
235
    success = False
236
    try:
2978.8.2 by Alexander Belchenko
teach fancy_rename to handle change case renames in possible case-insensitive filesystem
237
        try:
238
            # This may throw an exception, in which case success will
239
            # not be set.
240
            rename_func(old, new)
241
            success = True
242
        except (IOError, OSError), e:
2978.8.3 by Alexander Belchenko
Aaron's review
243
            # source and target may be aliases of each other (e.g. on a
244
            # case-insensitive filesystem), so we may have accidentally renamed
245
            # source by when we tried to rename target
2978.8.4 by Alexander Belchenko
fancy_rename: lower() test removed.
246
            if not (file_existed and e.errno in (None, errno.ENOENT)):
2978.8.2 by Alexander Belchenko
teach fancy_rename to handle change case renames in possible case-insensitive filesystem
247
                raise
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
248
    finally:
249
        if file_existed:
250
            # If the file used to exist, rename it back into place
251
            # otherwise just delete it from the tmp location
252
            if success:
1551.15.4 by Aaron Bentley
Revert now-unnecessary changes
253
                unlink_func(tmp_name)
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
254
            else:
1185.31.49 by John Arbash Meinel
Some corrections using the new osutils.rename. **ALL TESTS PASS**
255
                rename_func(tmp_name, new)
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
256
1685.1.9 by John Arbash Meinel
Updated LocalTransport so that it's base is now a URL rather than a local path. This helps consistency with all other functions. To do so, I added local_abspath() which returns the local path, and local_path_to/from_url
257
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
258
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
259
# choke on a Unicode string containing a relative path if
260
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
261
# string.
2093.1.1 by John Arbash Meinel
(Bart Teeuwisse) if sys.getfilesystemencoding() is None, use 'utf-8'
262
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
263
def _posix_abspath(path):
1711.4.5 by John Arbash Meinel
the _posix_* routines should use posixpath not os.path, so tests pass on win32
264
    # jam 20060426 rather than encoding to fsencoding
265
    # copy posixpath.abspath, but use os.getcwdu instead
266
    if not posixpath.isabs(path):
267
        path = posixpath.join(getcwd(), path)
268
    return posixpath.normpath(path)
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
269
270
271
def _posix_realpath(path):
1711.4.5 by John Arbash Meinel
the _posix_* routines should use posixpath not os.path, so tests pass on win32
272
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
273
274
1711.5.2 by John Arbash Meinel
win32 likes to return lowercase drive letters sometimes, and uppercase at other times. normalize this
275
def _win32_fixdrive(path):
276
    """Force drive letters to be consistent.
277
278
    win32 is inconsistent whether it returns lower or upper case
279
    and even if it was consistent the user might type the other
280
    so we force it to uppercase
281
    running python.exe under cmd.exe return capital C:\\
282
    running win32 python inside a cygwin shell returns lowercase c:\\
283
    """
284
    drive, path = _nt_splitdrive(path)
285
    return drive.upper() + path
286
287
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
288
def _win32_abspath(path):
1711.4.6 by John Arbash Meinel
Removing hacks for _win32_abspath, on real win32 abspath handles unicode just fine, it doesn't handle encoding into 'mbcs'
289
    # Real _nt_abspath doesn't have a problem with a unicode cwd
1711.5.2 by John Arbash Meinel
win32 likes to return lowercase drive letters sometimes, and uppercase at other times. normalize this
290
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
291
292
2279.4.1 by Alexander Belchenko
Reimplementation of ntpath.abspath in Python for Windows98: unicode safe, UNC path safe
293
def _win98_abspath(path):
294
    """Return the absolute version of a path.
295
    Windows 98 safe implementation (python reimplementation
296
    of Win32 API function GetFullPathNameW)
297
    """
298
    # Corner cases:
299
    #   C:\path     => C:/path
300
    #   C:/path     => C:/path
301
    #   \\HOST\path => //HOST/path
302
    #   //HOST/path => //HOST/path
303
    #   path        => C:/cwd/path
304
    #   /path       => C:/path
305
    path = unicode(path)
306
    # check for absolute path
307
    drive = _nt_splitdrive(path)[0]
308
    if drive == '' and path[:2] not in('//','\\\\'):
309
        cwd = os.getcwdu()
310
        # we cannot simply os.path.join cwd and path
311
        # because os.path.join('C:','/path') produce '/path'
312
        # and this is incorrect
313
        if path[:1] in ('/','\\'):
314
            cwd = _nt_splitdrive(cwd)[0]
2279.4.3 by Alexander Belchenko
win98_abspath: support for running in POSIX environment: cwd path has not drive letter
315
            path = path[1:]
2279.4.1 by Alexander Belchenko
Reimplementation of ntpath.abspath in Python for Windows98: unicode safe, UNC path safe
316
        path = cwd + '\\' + path
317
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
318
319
if win32utils.winver == 'Windows 98':
320
    _win32_abspath = _win98_abspath
321
322
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
323
def _win32_realpath(path):
1711.4.6 by John Arbash Meinel
Removing hacks for _win32_abspath, on real win32 abspath handles unicode just fine, it doesn't handle encoding into 'mbcs'
324
    # Real _nt_realpath doesn't have a problem with a unicode cwd
1711.5.2 by John Arbash Meinel
win32 likes to return lowercase drive letters sometimes, and uppercase at other times. normalize this
325
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
326
327
328
def _win32_pathjoin(*args):
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
329
    return _nt_join(*args).replace('\\', '/')
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
330
331
332
def _win32_normpath(path):
1711.5.2 by John Arbash Meinel
win32 likes to return lowercase drive letters sometimes, and uppercase at other times. normalize this
333
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
334
335
336
def _win32_getcwd():
1711.5.2 by John Arbash Meinel
win32 likes to return lowercase drive letters sometimes, and uppercase at other times. normalize this
337
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
338
339
340
def _win32_mkdtemp(*args, **kwargs):
1711.5.2 by John Arbash Meinel
win32 likes to return lowercase drive letters sometimes, and uppercase at other times. normalize this
341
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
342
343
344
def _win32_rename(old, new):
1711.7.6 by John Arbash Meinel
Change _win32_rename() so that it raises ENOENT *before* it tries any renaming.
345
    """We expect to be able to atomically replace 'new' with old.
346
1711.7.17 by John Arbash Meinel
Delay the extra syscall in _win32_rename until we get a failure.
347
    On win32, if new exists, it must be moved out of the way first,
348
    and then deleted. 
1711.7.6 by John Arbash Meinel
Change _win32_rename() so that it raises ENOENT *before* it tries any renaming.
349
    """
1711.7.17 by John Arbash Meinel
Delay the extra syscall in _win32_rename until we get a failure.
350
    try:
351
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
352
    except OSError, e:
1830.3.15 by John Arbash Meinel
On Mac we get EINVAL when renaming cwd
353
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
354
            # If we try to rename a non-existant file onto cwd, we get 
355
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
356
            # if the old path doesn't exist, sometimes we get EACCES
357
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
1711.7.17 by John Arbash Meinel
Delay the extra syscall in _win32_rename until we get a failure.
358
            os.lstat(old)
359
        raise
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
360
361
1830.3.11 by John Arbash Meinel
Create a mac version of 'getcwd()' which normalizes the path.
362
def _mac_getcwd():
363
    return unicodedata.normalize('NFKC', os.getcwdu())
364
365
1692.7.6 by Martin Pool
[patch] force deletion of trees containing readonly files (alexander)
366
# Default is to just use the python builtins, but these can be rebound on
367
# particular platforms.
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
368
abspath = _posix_abspath
369
realpath = _posix_realpath
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
370
pathjoin = os.path.join
371
normpath = os.path.normpath
372
getcwd = os.getcwdu
373
rename = os.rename
374
dirname = os.path.dirname
375
basename = os.path.basename
2215.4.2 by Alexander Belchenko
split and splitext now the part of osutils
376
split = os.path.split
377
splitext = os.path.splitext
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
378
# These were already imported into local scope
379
# mkdtemp = tempfile.mkdtemp
380
# rmtree = shutil.rmtree
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
381
1551.2.53 by abentley
Strip trailing slashes in a platform-sensible way
382
MIN_ABS_PATHLENGTH = 1
383
1685.1.9 by John Arbash Meinel
Updated LocalTransport so that it's base is now a URL rather than a local path. This helps consistency with all other functions. To do so, I added local_abspath() which returns the local path, and local_path_to/from_url
384
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
385
if sys.platform == 'win32':
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
386
    abspath = _win32_abspath
387
    realpath = _win32_realpath
388
    pathjoin = _win32_pathjoin
389
    normpath = _win32_normpath
390
    getcwd = _win32_getcwd
391
    mkdtemp = _win32_mkdtemp
392
    rename = _win32_rename
393
1551.2.53 by abentley
Strip trailing slashes in a platform-sensible way
394
    MIN_ABS_PATHLENGTH = 3
1532 by Robert Collins
Merge in John Meinels integration branch.
395
1692.7.6 by Martin Pool
[patch] force deletion of trees containing readonly files (alexander)
396
    def _win32_delete_readonly(function, path, excinfo):
397
        """Error handler for shutil.rmtree function [for win32]
398
        Helps to remove files and dirs marked as read-only.
399
        """
2116.5.1 by Henri Wiechers
Fixes osutils.rmtree on Windows with Python 2.5
400
        exception = excinfo[1]
1692.7.6 by Martin Pool
[patch] force deletion of trees containing readonly files (alexander)
401
        if function in (os.remove, os.rmdir) \
2116.5.1 by Henri Wiechers
Fixes osutils.rmtree on Windows with Python 2.5
402
            and isinstance(exception, OSError) \
403
            and exception.errno == errno.EACCES:
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
404
            make_writable(path)
1692.7.6 by Martin Pool
[patch] force deletion of trees containing readonly files (alexander)
405
            function(path)
406
        else:
407
            raise
408
409
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
410
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
411
        return shutil.rmtree(path, ignore_errors, onerror)
1830.3.11 by John Arbash Meinel
Create a mac version of 'getcwd()' which normalizes the path.
412
elif sys.platform == 'darwin':
413
    getcwd = _mac_getcwd
1692.7.6 by Martin Pool
[patch] force deletion of trees containing readonly files (alexander)
414
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
415
1711.4.10 by John Arbash Meinel
Pull out sys.stdout.encoding handling into a separate function so it can be tested, and used elsewhere.
416
def get_terminal_encoding():
417
    """Find the best encoding for printing to the screen.
418
419
    This attempts to check both sys.stdout and sys.stdin to see
420
    what encoding they are in, and if that fails it falls back to
421
    bzrlib.user_encoding.
422
    The problem is that on Windows, locale.getpreferredencoding()
423
    is not the same encoding as that used by the console:
424
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
425
426
    On my standard US Windows XP, the preferred encoding is
427
    cp1252, but the console is cp437
428
    """
429
    output_encoding = getattr(sys.stdout, 'encoding', None)
430
    if not output_encoding:
431
        input_encoding = getattr(sys.stdin, 'encoding', None)
432
        if not input_encoding:
433
            output_encoding = bzrlib.user_encoding
434
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
435
        else:
436
            output_encoding = input_encoding
437
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
438
    else:
439
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
2127.4.1 by Alexander Belchenko
(jam, bialix) Workaround for cp0 console encoding on Windows
440
    if output_encoding == 'cp0':
441
        # invalid encoding (cp0 means 'no codepage' on Windows)
442
        output_encoding = bzrlib.user_encoding
443
        mutter('cp0 is invalid encoding.'
444
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
2192.1.1 by Alexander Belchenko
Before actually using encoding need to check that Python has corresponding codec
445
    # check encoding
446
    try:
447
        codecs.lookup(output_encoding)
448
    except LookupError:
449
        sys.stderr.write('bzr: warning:'
2192.1.9 by Alexander Belchenko
final fix suggested by John Meinel
450
                         ' unknown terminal encoding %s.\n'
2192.1.1 by Alexander Belchenko
Before actually using encoding need to check that Python has corresponding codec
451
                         '  Using encoding %s instead.\n'
452
                         % (output_encoding, bzrlib.user_encoding)
453
                        )
454
        output_encoding = bzrlib.user_encoding
455
1711.4.10 by John Arbash Meinel
Pull out sys.stdout.encoding handling into a separate function so it can be tested, and used elsewhere.
456
    return output_encoding
457
458
1185.31.32 by John Arbash Meinel
Updated the bzr sourcecode to use bzrlib.osutils.pathjoin rather than os.path.join to enforce internal use of / instead of \
459
def normalizepath(f):
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
460
    if getattr(os.path, 'realpath', None) is not None:
1185.31.32 by John Arbash Meinel
Updated the bzr sourcecode to use bzrlib.osutils.pathjoin rather than os.path.join to enforce internal use of / instead of \
461
        F = realpath
462
    else:
463
        F = abspath
464
    [p,e] = os.path.split(f)
465
    if e == "" or e == "." or e == "..":
466
        return F(f)
467
    else:
468
        return pathjoin(F(p), e)
469
1 by mbp at sourcefrog
import from baz patch-364
470
3123.1.1 by John Arbash Meinel
Update from deprecating 0.93 to 1.0, and add a 1.1 deprecation.
471
@deprecated_function(one_zero)
779 by Martin Pool
- better quotefn for windows: use doublequotes for strings with
472
def backup_file(fn):
473
    """Copy a file to a backup.
474
475
    Backups are named in GNU-style, with a ~ suffix.
476
477
    If the file is already a backup, it's not copied.
478
    """
479
    if fn[-1] == '~':
480
        return
481
    bfn = fn + '~'
482
1448 by Robert Collins
revert symlinks correctly
483
    if has_symlinks() and os.path.islink(fn):
484
        target = os.readlink(fn)
485
        os.symlink(target, bfn)
486
        return
779 by Martin Pool
- better quotefn for windows: use doublequotes for strings with
487
    inf = file(fn, 'rb')
488
    try:
489
        content = inf.read()
490
    finally:
491
        inf.close()
492
    
493
    outf = file(bfn, 'wb')
494
    try:
495
        outf.write(content)
496
    finally:
497
        outf.close()
498
499
1 by mbp at sourcefrog
import from baz patch-364
500
def isdir(f):
501
    """True if f is an accessible directory."""
502
    try:
503
        return S_ISDIR(os.lstat(f)[ST_MODE])
504
    except OSError:
505
        return False
506
507
508
def isfile(f):
509
    """True if f is a regular file."""
510
    try:
511
        return S_ISREG(os.lstat(f)[ST_MODE])
512
    except OSError:
513
        return False
514
1092.2.6 by Robert Collins
symlink support updated to work
515
def islink(f):
516
    """True if f is a symlink."""
517
    try:
518
        return S_ISLNK(os.lstat(f)[ST_MODE])
519
    except OSError:
520
        return False
1 by mbp at sourcefrog
import from baz patch-364
521
485 by Martin Pool
- move commit code into its own module
522
def is_inside(dir, fname):
523
    """True if fname is inside dir.
969 by Martin Pool
- Add less-sucky is_within_any
524
    
1185.31.38 by John Arbash Meinel
Changing os.path.normpath to osutils.normpath
525
    The parameters should typically be passed to osutils.normpath first, so
969 by Martin Pool
- Add less-sucky is_within_any
526
    that . and .. and repeated slashes are eliminated, and the separators
527
    are canonical for the platform.
528
    
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
529
    The empty string as a dir name is taken as top-of-tree and matches 
530
    everything.
485 by Martin Pool
- move commit code into its own module
531
    """
969 by Martin Pool
- Add less-sucky is_within_any
532
    # XXX: Most callers of this can actually do something smarter by 
533
    # looking at the inventory
972 by Martin Pool
- less dodgy is_inside function
534
    if dir == fname:
535
        return True
536
    
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
537
    if dir == '':
538
        return True
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
539
1185.31.34 by John Arbash Meinel
Removing instances of os.sep
540
    if dir[-1] != '/':
541
        dir += '/'
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
542
972 by Martin Pool
- less dodgy is_inside function
543
    return fname.startswith(dir)
544
485 by Martin Pool
- move commit code into its own module
545
546
def is_inside_any(dir_list, fname):
547
    """True if fname is inside any of given dirs."""
548
    for dirname in dir_list:
549
        if is_inside(dirname, fname):
550
            return True
2324.2.3 by Dmitry Vasiliev
Fixed is_inside_* methods implementation
551
    return False
485 by Martin Pool
- move commit code into its own module
552
553
1740.3.4 by Jelmer Vernooij
Move inventory to commit builder.
554
def is_inside_or_parent_of_any(dir_list, fname):
555
    """True if fname is a child or a parent of any of the given files."""
556
    for dirname in dir_list:
557
        if is_inside(dirname, fname) or is_inside(fname, dirname):
558
            return True
2324.2.3 by Dmitry Vasiliev
Fixed is_inside_* methods implementation
559
    return False
1740.3.4 by Jelmer Vernooij
Move inventory to commit builder.
560
561
1 by mbp at sourcefrog
import from baz patch-364
562
def pumpfile(fromfile, tofile):
2745.5.2 by Robert Collins
* ``bzrlib.transport.Transport.put_file`` now returns the number of bytes
563
    """Copy contents of one file to another.
564
    
565
    :return: The number of bytes copied.
566
    """
1185.49.12 by John Arbash Meinel
Changed pumpfile to work on blocks, rather than reading the entire file at once.
567
    BUFSIZE = 32768
2745.5.2 by Robert Collins
* ``bzrlib.transport.Transport.put_file`` now returns the number of bytes
568
    length = 0
1185.49.12 by John Arbash Meinel
Changed pumpfile to work on blocks, rather than reading the entire file at once.
569
    while True:
570
        b = fromfile.read(BUFSIZE)
571
        if not b:
572
            break
1185.49.13 by John Arbash Meinel
Removed delayed setup, since it broke some tests. Fixed other small bugs. All tests pass.
573
        tofile.write(b)
2745.5.2 by Robert Collins
* ``bzrlib.transport.Transport.put_file`` now returns the number of bytes
574
        length += len(b)
575
    return length
1 by mbp at sourcefrog
import from baz patch-364
576
577
1185.67.7 by Aaron Bentley
Refactored a bit
578
def file_iterator(input_file, readsize=32768):
579
    while True:
580
        b = input_file.read(readsize)
581
        if len(b) == 0:
582
            break
583
        yield b
584
585
1 by mbp at sourcefrog
import from baz patch-364
586
def sha_file(f):
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
587
    if getattr(f, 'tell', None) is not None:
1 by mbp at sourcefrog
import from baz patch-364
588
        assert f.tell() == 0
589
    s = sha.new()
320 by Martin Pool
- Compute SHA-1 of files in chunks
590
    BUFSIZE = 128<<10
591
    while True:
592
        b = f.read(BUFSIZE)
593
        if not b:
594
            break
595
        s.update(b)
1 by mbp at sourcefrog
import from baz patch-364
596
    return s.hexdigest()
597
598
2872.3.1 by Martin Pool
Add -Dhashcache option; clean up dirstate sha1 code
599
def sha_file_by_name(fname):
600
    """Calculate the SHA1 of a file by reading the full text"""
2872.3.2 by Martin Pool
Do sha_file_by_name using raw os files rather than file objects; makes this routine about 12osutils.py faster
601
    s = sha.new()
2922.1.1 by John Arbash Meinel
Fix bug #153493, use O_BINARY when reading files.
602
    f = os.open(fname, os.O_RDONLY | O_BINARY)
2872.3.1 by Martin Pool
Add -Dhashcache option; clean up dirstate sha1 code
603
    try:
2872.3.2 by Martin Pool
Do sha_file_by_name using raw os files rather than file objects; makes this routine about 12osutils.py faster
604
        while True:
605
            b = os.read(f, 1<<16)
606
            if not b:
607
                return s.hexdigest()
608
            s.update(b)
2872.3.1 by Martin Pool
Add -Dhashcache option; clean up dirstate sha1 code
609
    finally:
2872.3.2 by Martin Pool
Do sha_file_by_name using raw os files rather than file objects; makes this routine about 12osutils.py faster
610
        os.close(f)
2872.3.1 by Martin Pool
Add -Dhashcache option; clean up dirstate sha1 code
611
612
2825.2.1 by Robert Collins
Micro-tweaks to sha routines.
613
def sha_strings(strings, _factory=sha.new):
1235 by Martin Pool
- split sha_strings into osutils
614
    """Return the sha-1 of concatenation of strings"""
2825.2.1 by Robert Collins
Micro-tweaks to sha routines.
615
    s = _factory()
1235 by Martin Pool
- split sha_strings into osutils
616
    map(s.update, strings)
617
    return s.hexdigest()
618
619
2825.2.1 by Robert Collins
Micro-tweaks to sha routines.
620
def sha_string(f, _factory=sha.new):
621
    return _factory(f).hexdigest()
1 by mbp at sourcefrog
import from baz patch-364
622
623
124 by mbp at sourcefrog
- check file text for past revisions is correct
624
def fingerprint_file(f):
126 by mbp at sourcefrog
Use just one big read to fingerprint files
625
    b = f.read()
2825.2.1 by Robert Collins
Micro-tweaks to sha routines.
626
    return {'size': len(b),
627
            'sha1': sha.new(b).hexdigest()}
124 by mbp at sourcefrog
- check file text for past revisions is correct
628
629
1 by mbp at sourcefrog
import from baz patch-364
630
def compare_files(a, b):
631
    """Returns true if equal in contents"""
74 by mbp at sourcefrog
compare_files: read in one page at a time rather than
632
    BUFSIZE = 4096
633
    while True:
634
        ai = a.read(BUFSIZE)
635
        bi = b.read(BUFSIZE)
636
        if ai != bi:
637
            return False
638
        if ai == '':
639
            return True
1 by mbp at sourcefrog
import from baz patch-364
640
641
49 by mbp at sourcefrog
fix local-time-offset calculation
642
def local_time_offset(t=None):
643
    """Return offset of local zone from GMT, either at present or at time t."""
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
644
    if t is None:
73 by mbp at sourcefrog
fix time.localtime call for python 2.3
645
        t = time.time()
2215.6.1 by James Henstridge
Don't rely on time.timezone and time.altzone in local_time_offset(),
646
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
647
    return offset.days * 86400 + offset.seconds
8 by mbp at sourcefrog
store committer's timezone in revision and show
648
649
    
2425.6.2 by Martin Pool
Make timestamps use existing format_date; document that function more
650
def format_date(t, offset=0, timezone='original', date_fmt=None,
1185.12.24 by Aaron Bentley
Made format_date more flexible
651
                show_offset=True):
2425.6.2 by Martin Pool
Make timestamps use existing format_date; document that function more
652
    """Return a formatted date string.
653
654
    :param t: Seconds since the epoch.
655
    :param offset: Timezone offset in seconds east of utc.
656
    :param timezone: How to display the time: 'utc', 'original' for the
657
         timezone specified by offset, or 'local' for the process's current
658
         timezone.
659
    :param show_offset: Whether to append the timezone.
660
    :param date_fmt: strftime format.
661
    """
8 by mbp at sourcefrog
store committer's timezone in revision and show
662
    if timezone == 'utc':
1 by mbp at sourcefrog
import from baz patch-364
663
        tt = time.gmtime(t)
664
        offset = 0
8 by mbp at sourcefrog
store committer's timezone in revision and show
665
    elif timezone == 'original':
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
666
        if offset is None:
23 by mbp at sourcefrog
format_date: handle revisions with no timezone offset
667
            offset = 0
16 by mbp at sourcefrog
fix inverted calculation for original timezone -> utc
668
        tt = time.gmtime(t + offset)
12 by mbp at sourcefrog
new --timezone option for bzr log
669
    elif timezone == 'local':
1 by mbp at sourcefrog
import from baz patch-364
670
        tt = time.localtime(t)
49 by mbp at sourcefrog
fix local-time-offset calculation
671
        offset = local_time_offset(t)
12 by mbp at sourcefrog
new --timezone option for bzr log
672
    else:
3144.1.1 by Lukáš Lalinský
Fixed error reporting of unsupported timezone format.
673
        raise errors.UnsupportedTimezoneFormat(timezone)
1185.12.24 by Aaron Bentley
Made format_date more flexible
674
    if date_fmt is None:
675
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
676
    if show_offset:
677
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
678
    else:
679
        offset_str = ''
680
    return (time.strftime(date_fmt, tt) +  offset_str)
1 by mbp at sourcefrog
import from baz patch-364
681
682
683
def compact_date(when):
684
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
685
    
686
1957.1.4 by John Arbash Meinel
create a helper for formatting a time delta
687
def format_delta(delta):
688
    """Get a nice looking string for a time delta.
689
690
    :param delta: The time difference in seconds, can be positive or negative.
691
        positive indicates time in the past, negative indicates time in the
692
        future. (usually time.time() - stored_time)
693
    :return: String formatted to show approximate resolution
694
    """
695
    delta = int(delta)
696
    if delta >= 0:
697
        direction = 'ago'
698
    else:
699
        direction = 'in the future'
700
        delta = -delta
701
702
    seconds = delta
703
    if seconds < 90: # print seconds up to 90 seconds
704
        if seconds == 1:
705
            return '%d second %s' % (seconds, direction,)
706
        else:
707
            return '%d seconds %s' % (seconds, direction)
708
709
    minutes = int(seconds / 60)
710
    seconds -= 60 * minutes
711
    if seconds == 1:
712
        plural_seconds = ''
713
    else:
714
        plural_seconds = 's'
715
    if minutes < 90: # print minutes, seconds up to 90 minutes
716
        if minutes == 1:
717
            return '%d minute, %d second%s %s' % (
718
                    minutes, seconds, plural_seconds, direction)
719
        else:
720
            return '%d minutes, %d second%s %s' % (
721
                    minutes, seconds, plural_seconds, direction)
722
723
    hours = int(minutes / 60)
724
    minutes -= 60 * hours
725
    if minutes == 1:
726
        plural_minutes = ''
727
    else:
728
        plural_minutes = 's'
729
730
    if hours == 1:
731
        return '%d hour, %d minute%s %s' % (hours, minutes,
732
                                            plural_minutes, direction)
733
    return '%d hours, %d minute%s %s' % (hours, minutes,
734
                                         plural_minutes, direction)
1 by mbp at sourcefrog
import from baz patch-364
735
736
def filesize(f):
737
    """Return size of given open file."""
738
    return os.fstat(f.fileno())[ST_SIZE]
739
1553.5.5 by Martin Pool
New utility routine rand_chars
740
1185.1.7 by Robert Collins
Nathaniel McCallums patch for urandom friendliness on aix.
741
# Define rand_bytes based on platform.
742
try:
743
    # Python 2.4 and later have os.urandom,
744
    # but it doesn't work on some arches
745
    os.urandom(1)
1 by mbp at sourcefrog
import from baz patch-364
746
    rand_bytes = os.urandom
1185.1.7 by Robert Collins
Nathaniel McCallums patch for urandom friendliness on aix.
747
except (NotImplementedError, AttributeError):
748
    # If python doesn't have os.urandom, or it doesn't work,
749
    # then try to first pull random data from /dev/urandom
2067.1.1 by John Arbash Meinel
Catch an exception while opening /dev/urandom rather than using os.path.exists()
750
    try:
1185.1.7 by Robert Collins
Nathaniel McCallums patch for urandom friendliness on aix.
751
        rand_bytes = file('/dev/urandom', 'rb').read
752
    # Otherwise, use this hack as a last resort
2067.1.1 by John Arbash Meinel
Catch an exception while opening /dev/urandom rather than using os.path.exists()
753
    except (IOError, OSError):
1185.1.7 by Robert Collins
Nathaniel McCallums patch for urandom friendliness on aix.
754
        # not well seeded, but better than nothing
755
        def rand_bytes(n):
756
            import random
757
            s = ''
758
            while n:
759
                s += chr(random.randint(0, 255))
760
                n -= 1
761
            return s
1 by mbp at sourcefrog
import from baz patch-364
762
1553.5.5 by Martin Pool
New utility routine rand_chars
763
764
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
765
def rand_chars(num):
766
    """Return a random string of num alphanumeric characters
767
    
768
    The result only contains lowercase chars because it may be used on 
769
    case-insensitive filesystems.
770
    """
771
    s = ''
772
    for raw_byte in rand_bytes(num):
773
        s += ALNUM[ord(raw_byte) % 36]
774
    return s
775
776
1 by mbp at sourcefrog
import from baz patch-364
777
## TODO: We could later have path objects that remember their list
1759.2.2 by Jelmer Vernooij
Revert some of my spelling fixes and fix some typos after review by Aaron.
778
## decomposition (might be too tricksy though.)
1 by mbp at sourcefrog
import from baz patch-364
779
780
def splitpath(p):
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
781
    """Turn string into list of parts."""
782
    assert isinstance(p, basestring)
271 by Martin Pool
- Windows path fixes
783
784
    # split on either delimiter because people might use either on
785
    # Windows
786
    ps = re.split(r'[\\/]', p)
787
788
    rps = []
1 by mbp at sourcefrog
import from baz patch-364
789
    for f in ps:
790
        if f == '..':
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
791
            raise errors.BzrError("sorry, %r not allowed in path" % f)
271 by Martin Pool
- Windows path fixes
792
        elif (f == '.') or (f == ''):
793
            pass
794
        else:
795
            rps.append(f)
796
    return rps
1 by mbp at sourcefrog
import from baz patch-364
797
798
def joinpath(p):
2255.7.40 by Robert Collins
Tweak pathjoin to be correct in its assertion about parameter types.
799
    assert isinstance(p, (list, tuple))
1 by mbp at sourcefrog
import from baz patch-364
800
    for f in p:
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
801
        if (f == '..') or (f is None) or (f == ''):
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
802
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1185.31.32 by John Arbash Meinel
Updated the bzr sourcecode to use bzrlib.osutils.pathjoin rather than os.path.join to enforce internal use of / instead of \
803
    return pathjoin(*p)
1 by mbp at sourcefrog
import from baz patch-364
804
805
1231 by Martin Pool
- more progress on fetch on top of weaves
806
def split_lines(s):
807
    """Split s into lines, but without removing the newline characters."""
1666.1.6 by Robert Collins
Make knit the default format.
808
    lines = s.split('\n')
809
    result = [line + '\n' for line in lines[:-1]]
810
    if lines[-1]:
811
        result.append(lines[-1])
812
    return result
1391 by Robert Collins
merge from integration
813
814
1185.10.4 by Aaron Bentley
Disabled hardlinks on cygwin, mac OS
815
def hardlinks_good():
1185.10.5 by Aaron Bentley
Fixed hardlinks_good test
816
    return sys.platform not in ('win32', 'cygwin', 'darwin')
1185.10.4 by Aaron Bentley
Disabled hardlinks on cygwin, mac OS
817
1185.1.46 by Robert Collins
Aarons branch --basis patch
818
1185.10.3 by Aaron Bentley
Made copy_multi_immutable create hardlinks opportunistically
819
def link_or_copy(src, dest):
820
    """Hardlink a file, or copy it if it can't be hardlinked."""
1185.10.4 by Aaron Bentley
Disabled hardlinks on cygwin, mac OS
821
    if not hardlinks_good():
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
822
        shutil.copyfile(src, dest)
1185.10.3 by Aaron Bentley
Made copy_multi_immutable create hardlinks opportunistically
823
        return
824
    try:
825
        os.link(src, dest)
826
    except (OSError, IOError), e:
827
        if e.errno != errno.EXDEV:
828
            raise
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
829
        shutil.copyfile(src, dest)
1399.1.4 by Robert Collins
move diff and symlink conditionals into inventory.py from diff.py
830
2831.5.2 by Vincent Ladeuil
Review feedback.
831
832
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
833
# Forgiveness than Permission (EAFP) because:
834
# - root can damage a solaris file system by using unlink,
835
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
836
#   EACCES, OSX: EPERM) when invoked on a directory.
837
def delete_any(path):
1558.12.9 by Aaron Bentley
Handle resolving conflicts with directories properly
838
    """Delete a file or directory."""
2831.5.2 by Vincent Ladeuil
Review feedback.
839
    if isdir(path): # Takes care of symlinks
840
        os.rmdir(path)
841
    else:
842
        os.unlink(path)
1558.12.9 by Aaron Bentley
Handle resolving conflicts with directories properly
843
1399.1.4 by Robert Collins
move diff and symlink conditionals into inventory.py from diff.py
844
845
def has_symlinks():
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
846
    if getattr(os, 'symlink', None) is not None:
1399.1.4 by Robert Collins
move diff and symlink conditionals into inventory.py from diff.py
847
        return True
848
    else:
849
        return False
2831.5.2 by Vincent Ladeuil
Review feedback.
850
1185.16.38 by Martin Pool
- move contains_whitespace and contains_linebreaks to osutils
851
852
def contains_whitespace(s):
853
    """True if there are any whitespace characters in s."""
2249.2.1 by John Arbash Meinel
(John Arbash Meinel) hard-code the whitespace chars to avoid problems in some locales.
854
    # string.whitespace can include '\xa0' in certain locales, because it is
855
    # considered "non-breaking-space" as part of ISO-8859-1. But it
856
    # 1) Isn't a breaking whitespace
857
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
858
    #    separators
859
    # 3) '\xa0' isn't unicode safe since it is >128.
2249.5.16 by John Arbash Meinel
[merge] bzr.dev 2283
860
861
    # This should *not* be a unicode set of characters in case the source
862
    # string is not a Unicode string. We can auto-up-cast the characters since
863
    # they are ascii, but we don't want to auto-up-cast the string in case it
864
    # is utf-8
865
    for ch in ' \t\n\r\v\f':
1185.16.38 by Martin Pool
- move contains_whitespace and contains_linebreaks to osutils
866
        if ch in s:
867
            return True
868
    else:
869
        return False
870
871
872
def contains_linebreaks(s):
873
    """True if there is any vertical whitespace in s."""
874
    for ch in '\f\n\r':
875
        if ch in s:
876
            return True
877
    else:
878
        return False
1457.1.2 by Robert Collins
move branch._relpath into osutils as relpath
879
880
881
def relpath(base, path):
882
    """Return path relative to base, or raise exception.
883
884
    The path may be either an absolute path or a path relative to the
885
    current working directory.
886
887
    os.path.commonprefix (python2.4) has a bad bug that it works just
888
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1636.1.1 by Robert Collins
Fix calling relpath() and abspath() on transports at their root.
889
    avoids that problem.
890
    """
1685.1.12 by John Arbash Meinel
Some more work to get LocalTransport to only support URLs
891
1551.2.53 by abentley
Strip trailing slashes in a platform-sensible way
892
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
893
        ' exceed the platform minimum length (which is %d)' % 
894
        MIN_ABS_PATHLENGTH)
1685.1.9 by John Arbash Meinel
Updated LocalTransport so that it's base is now a URL rather than a local path. This helps consistency with all other functions. To do so, I added local_abspath() which returns the local path, and local_path_to/from_url
895
1685.1.12 by John Arbash Meinel
Some more work to get LocalTransport to only support URLs
896
    rp = abspath(path)
1457.1.2 by Robert Collins
move branch._relpath into osutils as relpath
897
898
    s = []
1685.1.12 by John Arbash Meinel
Some more work to get LocalTransport to only support URLs
899
    head = rp
1457.1.2 by Robert Collins
move branch._relpath into osutils as relpath
900
    while len(head) >= len(base):
901
        if head == base:
902
            break
903
        head, tail = os.path.split(head)
904
        if tail:
905
            s.insert(0, tail)
906
    else:
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
907
        raise errors.PathNotChild(rp, base)
1457.1.2 by Robert Collins
move branch._relpath into osutils as relpath
908
1185.31.35 by John Arbash Meinel
Couple small fixes, all tests pass on cygwin.
909
    if s:
910
        return pathjoin(*s)
911
    else:
912
        return ''
1185.33.60 by Martin Pool
Use full terminal width for verbose test output.
913
914
1534.3.1 by Robert Collins
* bzrlib.osutils.safe_unicode now exists to provide parameter coercion
915
def safe_unicode(unicode_or_utf8_string):
916
    """Coerce unicode_or_utf8_string into unicode.
917
918
    If it is unicode, it is returned.
919
    Otherwise it is decoded from utf-8. If a decoding error
920
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
921
    as a BzrBadParameter exception.
922
    """
923
    if isinstance(unicode_or_utf8_string, unicode):
924
        return unicode_or_utf8_string
925
    try:
926
        return unicode_or_utf8_string.decode('utf8')
927
    except UnicodeDecodeError:
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
928
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1534.3.1 by Robert Collins
* bzrlib.osutils.safe_unicode now exists to provide parameter coercion
929
930
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
931
def safe_utf8(unicode_or_utf8_string):
932
    """Coerce unicode_or_utf8_string to a utf8 string.
933
934
    If it is a str, it is returned.
935
    If it is Unicode, it is encoded into a utf-8 string.
936
    """
937
    if isinstance(unicode_or_utf8_string, str):
938
        # TODO: jam 20070209 This is overkill, and probably has an impact on
939
        #       performance if we are dealing with lots of apis that want a
940
        #       utf-8 revision id
941
        try:
942
            # Make sure it is a valid utf-8 string
943
            unicode_or_utf8_string.decode('utf-8')
944
        except UnicodeDecodeError:
945
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
946
        return unicode_or_utf8_string
947
    return unicode_or_utf8_string.encode('utf-8')
948
949
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
950
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
951
                        ' Revision id generators should be creating utf8'
952
                        ' revision ids.')
953
954
955
def safe_revision_id(unicode_or_utf8_string, warn=True):
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
956
    """Revision ids should now be utf8, but at one point they were unicode.
957
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
958
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
959
        utf8 or None).
960
    :param warn: Functions that are sanitizing user data can set warn=False
961
    :return: None or a utf8 revision id.
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
962
    """
2309.4.3 by John Arbash Meinel
(broken) change safe_*_id to emit a warning.
963
    if (unicode_or_utf8_string is None
964
        or unicode_or_utf8_string.__class__ == str):
965
        return unicode_or_utf8_string
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
966
    if warn:
967
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
968
                               stacklevel=2)
2309.4.3 by John Arbash Meinel
(broken) change safe_*_id to emit a warning.
969
    return cache_utf8.encode(unicode_or_utf8_string)
970
971
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
972
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
973
                    ' generators should be creating utf8 file ids.')
974
975
976
def safe_file_id(unicode_or_utf8_string, warn=True):
2309.4.3 by John Arbash Meinel
(broken) change safe_*_id to emit a warning.
977
    """File ids should now be utf8, but at one point they were unicode.
978
979
    This is the same as safe_utf8, except it uses the cached encode functions
980
    to save a little bit of performance.
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
981
982
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
983
        utf8 or None).
984
    :param warn: Functions that are sanitizing user data can set warn=False
985
    :return: None or a utf8 file id.
2309.4.3 by John Arbash Meinel
(broken) change safe_*_id to emit a warning.
986
    """
987
    if (unicode_or_utf8_string is None
988
        or unicode_or_utf8_string.__class__ == str):
989
        return unicode_or_utf8_string
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
990
    if warn:
991
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
992
                               stacklevel=2)
2309.4.3 by John Arbash Meinel
(broken) change safe_*_id to emit a warning.
993
    return cache_utf8.encode(unicode_or_utf8_string)
2294.1.4 by John Arbash Meinel
Add safe_file_id as a helper in osutils.
994
995
1185.85.75 by John Arbash Meinel
Adding bzrlib.osutils.unicode_filename to handle unicode normalization for file paths.
996
_platform_normalizes_filenames = False
997
if sys.platform == 'darwin':
998
    _platform_normalizes_filenames = True
999
1000
1001
def normalizes_filenames():
1002
    """Return True if this platform normalizes unicode filenames.
1003
1004
    Mac OSX does, Windows/Linux do not.
1005
    """
1006
    return _platform_normalizes_filenames
1007
1008
1830.3.2 by John Arbash Meinel
normalized_filename is a much better name
1009
def _accessible_normalized_filename(path):
1830.3.1 by John Arbash Meinel
Change the return value of unicode_filename, and make it testable on all platforms
1010
    """Get the unicode normalized path, and if you can access the file.
1011
1012
    On platforms where the system normalizes filenames (Mac OSX),
1013
    you can access a file by any path which will normalize correctly.
1014
    On platforms where the system does not normalize filenames 
1015
    (Windows, Linux), you have to access a file by its exact path.
1016
1017
    Internally, bzr only supports NFC/NFKC normalization, since that is 
1018
    the standard for XML documents.
1019
1020
    So return the normalized path, and a flag indicating if the file
1021
    can be accessed by that path.
1022
    """
1023
1830.3.8 by John Arbash Meinel
unicodedata.normalize requires unicode strings
1024
    return unicodedata.normalize('NFKC', unicode(path)), True
1830.3.1 by John Arbash Meinel
Change the return value of unicode_filename, and make it testable on all platforms
1025
1026
1830.3.2 by John Arbash Meinel
normalized_filename is a much better name
1027
def _inaccessible_normalized_filename(path):
1028
    __doc__ = _accessible_normalized_filename.__doc__
1830.3.1 by John Arbash Meinel
Change the return value of unicode_filename, and make it testable on all platforms
1029
1830.3.8 by John Arbash Meinel
unicodedata.normalize requires unicode strings
1030
    normalized = unicodedata.normalize('NFKC', unicode(path))
1830.3.1 by John Arbash Meinel
Change the return value of unicode_filename, and make it testable on all platforms
1031
    return normalized, normalized == path
1032
1033
1185.85.75 by John Arbash Meinel
Adding bzrlib.osutils.unicode_filename to handle unicode normalization for file paths.
1034
if _platform_normalizes_filenames:
1830.3.2 by John Arbash Meinel
normalized_filename is a much better name
1035
    normalized_filename = _accessible_normalized_filename
1185.85.75 by John Arbash Meinel
Adding bzrlib.osutils.unicode_filename to handle unicode normalization for file paths.
1036
else:
1830.3.2 by John Arbash Meinel
normalized_filename is a much better name
1037
    normalized_filename = _inaccessible_normalized_filename
1185.85.75 by John Arbash Meinel
Adding bzrlib.osutils.unicode_filename to handle unicode normalization for file paths.
1038
1039
1185.33.60 by Martin Pool
Use full terminal width for verbose test output.
1040
def terminal_width():
1041
    """Return estimated terminal width."""
1704.2.3 by Martin Pool
(win32) Detect terminal width using GetConsoleScreenBufferInfo (Alexander)
1042
    if sys.platform == 'win32':
2245.4.6 by Alexander Belchenko
osutils.py: terminal_width() now use win32utils.get_console_size()
1043
        return win32utils.get_console_size()[0]
1704.2.2 by Martin Pool
Detect terminal width using ioctl
1044
    width = 0
1185.33.60 by Martin Pool
Use full terminal width for verbose test output.
1045
    try:
1704.2.2 by Martin Pool
Detect terminal width using ioctl
1046
        import struct, fcntl, termios
1047
        s = struct.pack('HHHH', 0, 0, 0, 0)
1048
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1049
        width = struct.unpack('HHHH', x)[1]
1050
    except IOError:
1051
        pass
1052
    if width <= 0:
1053
        try:
1054
            width = int(os.environ['COLUMNS'])
1055
        except:
1056
            pass
1057
    if width <= 0:
1058
        width = 80
1059
1060
    return width
1534.7.25 by Aaron Bentley
Added set_executability
1061
1963.1.5 by John Arbash Meinel
Create an osutils helper function for modifying the environment
1062
1534.7.25 by Aaron Bentley
Added set_executability
1063
def supports_executable():
1534.7.160 by Aaron Bentley
Changed implementation of supports_executable
1064
    return sys.platform != "win32"
1551.2.53 by abentley
Strip trailing slashes in a platform-sensible way
1065
1066
1551.10.4 by Aaron Bentley
Update to skip on win32
1067
def supports_posix_readonly():
1068
    """Return True if 'readonly' has POSIX semantics, False otherwise.
1069
1070
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1071
    directory controls creation/deletion, etc.
1072
1073
    And under win32, readonly means that the directory itself cannot be
1074
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
1075
    where files in readonly directories cannot be added, deleted or renamed.
1076
    """
1077
    return sys.platform != "win32"
1078
1079
1963.1.5 by John Arbash Meinel
Create an osutils helper function for modifying the environment
1080
def set_or_unset_env(env_variable, value):
1081
    """Modify the environment, setting or removing the env_variable.
1082
1083
    :param env_variable: The environment variable in question
1084
    :param value: The value to set the environment to. If None, then
1085
        the variable will be removed.
1086
    :return: The original value of the environment variable.
1087
    """
1088
    orig_val = os.environ.get(env_variable)
1089
    if value is None:
1090
        if orig_val is not None:
1091
            del os.environ[env_variable]
1092
    else:
1093
        if isinstance(value, unicode):
1094
            value = value.encode(bzrlib.user_encoding)
1095
        os.environ[env_variable] = value
1096
    return orig_val
1097
1098
1551.2.56 by Aaron Bentley
Better illegal pathname check for Windows
1099
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1100
1101
1102
def check_legal_path(path):
1103
    """Check whether the supplied path is legal.  
1104
    This is only required on Windows, so we don't test on other platforms
1105
    right now.
1106
    """
1107
    if sys.platform != "win32":
1108
        return
1109
    if _validWin32PathRE.match(path) is None:
1996.3.25 by John Arbash Meinel
Make importing errors lazy for osutils
1110
        raise errors.IllegalPath(path)
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1111
1112
1757.2.8 by Robert Collins
Teach walkdirs to walk a subdir of a tree.
1113
def walkdirs(top, prefix=""):
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1114
    """Yield data about all the directories in a tree.
1115
    
1116
    This yields all the data about the contents of a directory at a time.
1117
    After each directory has been yielded, if the caller has mutated the list
1118
    to exclude some directories, they are then not descended into.
1119
    
1120
    The data yielded is of the form:
1897.1.2 by Robert Collins
cleanup osutils.walkdirs changes after review.
1121
    ((directory-relpath, directory-path-from-top),
2694.4.1 by Alexander Belchenko
trivial fix for docstring of osutils.walkdirs()
1122
    [(relpath, basename, kind, lstat, path-from-top), ...]),
1897.1.2 by Robert Collins
cleanup osutils.walkdirs changes after review.
1123
     - directory-relpath is the relative path of the directory being returned
1124
       with respect to top. prefix is prepended to this.
1125
     - directory-path-from-root is the path including top for this directory. 
1126
       It is suitable for use with os functions.
1897.1.1 by Robert Collins
Add some useful summary data to osutils.walkdirs output.
1127
     - relpath is the relative path within the subtree being walked.
1128
     - basename is the basename of the path
1897.1.2 by Robert Collins
cleanup osutils.walkdirs changes after review.
1129
     - kind is the kind of the file now. If unknown then the file is not
1897.1.1 by Robert Collins
Add some useful summary data to osutils.walkdirs output.
1130
       present within the tree - but it may be recorded as versioned. See
1131
       versioned_kind.
1132
     - lstat is the stat data *if* the file was statted.
1133
     - planned, not implemented: 
1134
       path_from_tree_root is the path from the root of the tree.
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1135
1757.2.16 by Robert Collins
Review comments.
1136
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
1137
        allows one to walk a subtree but get paths that are relative to a tree
1138
        rooted higher up.
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1139
    :return: an iterator over the dirs.
1140
    """
1897.1.1 by Robert Collins
Add some useful summary data to osutils.walkdirs output.
1141
    #TODO there is a bit of a smell where the results of the directory-
1142
    # summary in this, and the path from the root, may not agree 
1143
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1144
    # potentially confusing output. We should make this more robust - but
1897.1.2 by Robert Collins
cleanup osutils.walkdirs changes after review.
1145
    # not at a speed cost. RBC 20060731
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1146
    _lstat = os.lstat
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1147
    _directory = _directory_kind
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
1148
    _listdir = os.listdir
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1149
    _kind_from_mode = _formats.get
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1150
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1151
    while pending:
1152
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1153
        relroot, _, _, _, top = pending.pop()
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1154
        if relroot:
1155
            relprefix = relroot + u'/'
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1156
        else:
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1157
            relprefix = ''
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1158
        top_slash = top + u'/'
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1159
1160
        dirblock = []
1161
        append = dirblock.append
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1162
        for name in sorted(_listdir(top)):
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1163
            abspath = top_slash + name
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1164
            statvalue = _lstat(abspath)
1165
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1166
            append((relprefix + name, name, kind, statvalue, abspath))
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1167
        yield (relroot, top), dirblock
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1168
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1169
        # push the user specified dirs from dirblock
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1170
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1773.3.1 by Robert Collins
Add path_prefix_key and compare_paths_prefix_order utility functions.
1171
1172
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1173
def _walkdirs_utf8(top, prefix=""):
1174
    """Yield data about all the directories in a tree.
1175
1176
    This yields the same information as walkdirs() only each entry is yielded
1177
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1178
    are returned as exact byte-strings.
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1179
1180
    :return: yields a tuple of (dir_info, [file_info])
1181
        dir_info is (utf8_relpath, path-from-top)
1182
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1183
        if top is an absolute path, path-from-top is also an absolute path.
1184
        path-from-top might be unicode or utf8, but it is the correct path to
1185
        pass to os functions to affect the file in question. (such as os.lstat)
1186
    """
2522.2.2 by Ian Clatworthy
Apply Colin Watson's patch fixing 120647
1187
    fs_encoding = _fs_enc.upper()
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1188
    if (sys.platform == 'win32' or
1189
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1190
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1191
    else:
1192
        return _walkdirs_fs_utf8(top, prefix=prefix)
1193
1194
1195
def _walkdirs_fs_utf8(top, prefix=""):
1196
    """See _walkdirs_utf8.
1197
1198
    This sub-function is called when we know the filesystem is already in utf8
1199
    encoding. So we don't need to transcode filenames.
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1200
    """
1201
    _lstat = os.lstat
1202
    _directory = _directory_kind
1203
    _listdir = os.listdir
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1204
    _kind_from_mode = _formats.get
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1205
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1206
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1207
    # But we don't actually uses 1-3 in pending, so set them to None
1208
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1209
    while pending:
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1210
        relroot, _, _, _, top = pending.pop()
1211
        if relroot:
1212
            relprefix = relroot + '/'
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1213
        else:
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1214
            relprefix = ''
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1215
        top_slash = top + '/'
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1216
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1217
        dirblock = []
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1218
        append = dirblock.append
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1219
        for name in sorted(_listdir(top)):
1220
            abspath = top_slash + name
1221
            statvalue = _lstat(abspath)
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1222
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1223
            append((relprefix + name, name, kind, statvalue, abspath))
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1224
        yield (relroot, top), dirblock
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1225
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1226
        # push the user specified dirs from dirblock
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1227
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1228
1229
1230
def _walkdirs_unicode_to_utf8(top, prefix=""):
1231
    """See _walkdirs_utf8
1232
1233
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1234
    Unicode paths.
1235
    This is currently the fallback code path when the filesystem encoding is
1236
    not UTF-8. It may be better to implement an alternative so that we can
1237
    safely handle paths that are not properly decodable in the current
1238
    encoding.
1239
    """
1240
    _utf8_encode = codecs.getencoder('utf8')
1241
    _lstat = os.lstat
1242
    _directory = _directory_kind
1243
    _listdir = os.listdir
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1244
    _kind_from_mode = _formats.get
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1245
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1246
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1247
    while pending:
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1248
        relroot, _, _, _, top = pending.pop()
1249
        if relroot:
1250
            relprefix = relroot + '/'
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1251
        else:
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1252
            relprefix = ''
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1253
        top_slash = top + u'/'
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1254
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1255
        dirblock = []
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1256
        append = dirblock.append
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1257
        for name in sorted(_listdir(top)):
1258
            name_utf8 = _utf8_encode(name)[0]
1259
            abspath = top_slash + name
1260
            statvalue = _lstat(abspath)
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1261
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1262
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1263
        yield (relroot, top), dirblock
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1264
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1265
        # push the user specified dirs from dirblock
2255.7.33 by John Arbash Meinel
More inner loop tuning of walkdirs, can save as much as 5%
1266
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1267
1268
1907.3.2 by John Arbash Meinel
Updated the copy_tree function to allow overriding functionality.
1269
def copy_tree(from_path, to_path, handlers={}):
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1270
    """Copy all of the entries in from_path into to_path.
1271
1272
    :param from_path: The base directory to copy. 
1273
    :param to_path: The target directory. If it does not exist, it will
1274
        be created.
1907.3.2 by John Arbash Meinel
Updated the copy_tree function to allow overriding functionality.
1275
    :param handlers: A dictionary of functions, which takes a source and
1276
        destinations for files, directories, etc.
1277
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1278
        'file', 'directory', and 'symlink' should always exist.
1279
        If they are missing, they will be replaced with 'os.mkdir()',
1280
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1281
    """
1282
    # Now, just copy the existing cached tree to the new location
1283
    # We use a cheap trick here.
1284
    # Absolute paths are prefixed with the first parameter
1285
    # relative paths are prefixed with the second.
1286
    # So we can get both the source and target returned
1287
    # without any extra work.
1288
1907.3.2 by John Arbash Meinel
Updated the copy_tree function to allow overriding functionality.
1289
    def copy_dir(source, dest):
1290
        os.mkdir(dest)
1291
1292
    def copy_link(source, dest):
1293
        """Copy the contents of a symlink"""
1294
        link_to = os.readlink(source)
1295
        os.symlink(link_to, dest)
1296
1297
    real_handlers = {'file':shutil.copy2,
1298
                     'symlink':copy_link,
1299
                     'directory':copy_dir,
1300
                    }
1301
    real_handlers.update(handlers)
1302
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1303
    if not os.path.exists(to_path):
1907.3.2 by John Arbash Meinel
Updated the copy_tree function to allow overriding functionality.
1304
        real_handlers['directory'](from_path, to_path)
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1305
1306
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
1307
        for relpath, name, kind, st, abspath in entries:
1907.3.2 by John Arbash Meinel
Updated the copy_tree function to allow overriding functionality.
1308
            real_handlers[kind](abspath, relpath)
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1309
1310
1773.3.1 by Robert Collins
Add path_prefix_key and compare_paths_prefix_order utility functions.
1311
def path_prefix_key(path):
1312
    """Generate a prefix-order path key for path.
1313
1314
    This can be used to sort paths in the same way that walkdirs does.
1315
    """
1773.3.2 by Robert Collins
New corner case from John Meinel, showing up the need to check the directory lexographically outside of a single tree's root. Fixed.
1316
    return (dirname(path) , path)
1773.3.1 by Robert Collins
Add path_prefix_key and compare_paths_prefix_order utility functions.
1317
1318
1319
def compare_paths_prefix_order(path_a, path_b):
1320
    """Compare path_a and path_b to generate the same order walkdirs uses."""
1321
    key_a = path_prefix_key(path_a)
1322
    key_b = path_prefix_key(path_b)
1323
    return cmp(key_a, key_b)
1955.2.2 by John Arbash Meinel
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py
1324
1325
1326
_cached_user_encoding = None
1327
1328
2192.1.3 by Alexander Belchenko
Tests for osutils.get_user_encoding
1329
def get_user_encoding(use_cache=True):
1955.2.2 by John Arbash Meinel
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py
1330
    """Find out what the preferred user encoding is.
1331
1332
    This is generally the encoding that is used for command line parameters
1333
    and file contents. This may be different from the terminal encoding
1334
    or the filesystem encoding.
1335
2192.1.3 by Alexander Belchenko
Tests for osutils.get_user_encoding
1336
    :param  use_cache:  Enable cache for detected encoding.
1337
                        (This parameter is turned on by default,
1338
                        and required only for selftesting)
1339
1955.2.2 by John Arbash Meinel
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py
1340
    :return: A string defining the preferred user encoding
1341
    """
1342
    global _cached_user_encoding
2192.1.3 by Alexander Belchenko
Tests for osutils.get_user_encoding
1343
    if _cached_user_encoding is not None and use_cache:
1955.2.2 by John Arbash Meinel
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py
1344
        return _cached_user_encoding
1345
1346
    if sys.platform == 'darwin':
1347
        # work around egregious python 2.4 bug
1348
        sys.platform = 'posix'
1349
        try:
1350
            import locale
1351
        finally:
1352
            sys.platform = 'darwin'
1353
    else:
1354
        import locale
1355
1356
    try:
2192.1.3 by Alexander Belchenko
Tests for osutils.get_user_encoding
1357
        user_encoding = locale.getpreferredencoding()
1955.2.2 by John Arbash Meinel
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py
1358
    except locale.Error, e:
1955.2.3 by John Arbash Meinel
Change error message text
1359
        sys.stderr.write('bzr: warning: %s\n'
2001.2.1 by Jelmer Vernooij
Fix typo in encoding warning.
1360
                         '  Could not determine what text encoding to use.\n'
1955.2.3 by John Arbash Meinel
Change error message text
1361
                         '  This error usually means your Python interpreter\n'
1362
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1363
                         "  Continuing with ascii encoding.\n"
1955.2.2 by John Arbash Meinel
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py
1364
                         % (e, os.environ.get('LANG')))
2192.1.7 by Alexander Belchenko
get_user_encoding: if locale.Error raised we need to set user_encoding to 'ascii' as warning says
1365
        user_encoding = 'ascii'
1955.2.2 by John Arbash Meinel
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py
1366
2127.4.1 by Alexander Belchenko
(jam, bialix) Workaround for cp0 console encoding on Windows
1367
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1368
    # treat that as ASCII, and not support printing unicode characters to the
1369
    # console.
2192.1.3 by Alexander Belchenko
Tests for osutils.get_user_encoding
1370
    if user_encoding in (None, 'cp0'):
1371
        user_encoding = 'ascii'
2192.1.1 by Alexander Belchenko
Before actually using encoding need to check that Python has corresponding codec
1372
    else:
1373
        # check encoding
1374
        try:
2192.1.3 by Alexander Belchenko
Tests for osutils.get_user_encoding
1375
            codecs.lookup(user_encoding)
2192.1.1 by Alexander Belchenko
Before actually using encoding need to check that Python has corresponding codec
1376
        except LookupError:
1377
            sys.stderr.write('bzr: warning:'
1378
                             ' unknown encoding %s.'
1379
                             ' Continuing with ascii encoding.\n'
2192.1.3 by Alexander Belchenko
Tests for osutils.get_user_encoding
1380
                             % user_encoding
2192.1.1 by Alexander Belchenko
Before actually using encoding need to check that Python has corresponding codec
1381
                            )
2192.1.3 by Alexander Belchenko
Tests for osutils.get_user_encoding
1382
            user_encoding = 'ascii'
1383
1384
    if use_cache:
1385
        _cached_user_encoding = user_encoding
1386
1387
    return user_encoding
2091.1.1 by Martin Pool
Avoid MSG_WAITALL as it doesn't work on Windows
1388
1389
1390
def recv_all(socket, bytes):
1391
    """Receive an exact number of bytes.
1392
1393
    Regular Socket.recv() may return less than the requested number of bytes,
1394
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
1395
    on all platforms, but this should work everywhere.  This will return
1396
    less than the requested amount if the remote end closes.
1397
1398
    This isn't optimized and is intended mostly for use in testing.
1399
    """
1400
    b = ''
1401
    while len(b) < bytes:
1402
        new = socket.recv(bytes - len(b))
1403
        if new == '':
1404
            break # eof
1405
        b += new
1406
    return b
1407
3118.2.1 by Andrew Bennetts
(andrew) Fix #115781 by passing no more than 64k at a time to socket.sendall.
1408
1409
def send_all(socket, bytes):
1410
    """Send all bytes on a socket.
1411
1412
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1413
    implementation sends no more than 64k at a time, which avoids this problem.
1414
    """
1415
    chunk_size = 2**16
1416
    for pos in xrange(0, len(bytes), chunk_size):
1417
        socket.sendall(bytes[pos:pos+chunk_size])
1418
1419
2091.3.7 by Aaron Bentley
Rename real_parent to dereferenced_path
1420
def dereference_path(path):
1421
    """Determine the real path to a file.
1422
1423
    All parent elements are dereferenced.  But the file itself is not
1424
    dereferenced.
1425
    :param path: The original path.  May be absolute or relative.
1426
    :return: the real path *to* the file
1427
    """
2091.3.5 by Aaron Bentley
Move realpath functionality into osutils
1428
    parent, base = os.path.split(path)
1429
    # The pathjoin for '.' is a workaround for Python bug #1213894.
1430
    # (initial path components aren't dereferenced)
1431
    return pathjoin(realpath(pathjoin('.', parent)), base)
2681.3.4 by Lukáš Lalinsky
- Rename 'windows' to 'mapi'
1432
1433
1434
def supports_mapi():
1435
    """Return True if we can use MAPI to launch a mail client."""
1436
    return sys.platform == "win32"
3089.3.8 by Ian Clatworthy
move resource loading into a reusable function
1437
1438
1439
def resource_string(package, resource_name):
1440
    """Load a resource from a package and return it as a string.
1441
1442
    Note: Only packages that start with bzrlib are currently supported.
1443
1444
    This is designed to be a lightweight implementation of resource
1445
    loading in a way which is API compatible with the same API from
1446
    pkg_resources. See
1447
    http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
1448
    If and when pkg_resources becomes a standard library, this routine
1449
    can delegate to it.
1450
    """
1451
    # Check package name is within bzrlib
1452
    if package == "bzrlib":
1453
        resource_relpath = resource_name
1454
    elif package.startswith("bzrlib."):
1455
        package = package[len("bzrlib."):].replace('.', os.sep)
1456
        resource_relpath = pathjoin(package, resource_name)
1457
    else:
1458
        raise errors.BzrError('resource package %s not in bzrlib' % package)
1459
1460
    # Map the resource to a file and read its contents
1461
    base = dirname(bzrlib.__file__)
1462
    if getattr(sys, 'frozen', None):    # bzr.exe
1463
        base = abspath(pathjoin(base, '..', '..'))
1464
    filename = pathjoin(base, resource_relpath)
1465
    return open(filename, 'rU').read()