1
# Bazaar-NG -- distributed version control
 
 
3
# Copyright (C) 2005 by Canonical Ltd
 
 
5
# This program is free software; you can redistribute it and/or modify
 
 
6
# it under the terms of the GNU General Public License as published by
 
 
7
# the Free Software Foundation; either version 2 of the License, or
 
 
8
# (at your option) any later version.
 
 
10
# This program is distributed in the hope that it will be useful,
 
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
13
# GNU General Public License for more details.
 
 
15
# You should have received a copy of the GNU General Public License
 
 
16
# along with this program; if not, write to the Free Software
 
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
19
import os, types, re, time
 
 
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
 
22
from errors import bailout, BzrError
 
 
23
from trace import mutter
 
 
25
def make_readonly(filename):
 
 
26
    """Make a filename read-only."""
 
 
27
    # TODO: probably needs to be fixed for windows
 
 
28
    mod = os.stat(filename).st_mode
 
 
30
    os.chmod(filename, mod)
 
 
33
def make_writable(filename):
 
 
34
    mod = os.stat(filename).st_mode
 
 
36
    os.chmod(filename, mod)
 
 
39
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
 
41
    """Return shell-quoted filename"""
 
 
42
    ## We could be a bit more terse by using double-quotes etc
 
 
43
    f = _QUOTE_RE.sub(r'\\\1', f)
 
 
50
    mode = os.lstat(f)[ST_MODE]
 
 
58
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
 
 
63
    """True if f is an accessible directory."""
 
 
65
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
 
72
    """True if f is a regular file."""
 
 
74
        return S_ISREG(os.lstat(f)[ST_MODE])
 
 
79
def pumpfile(fromfile, tofile):
 
 
80
    """Copy contents of one file to another."""
 
 
81
    tofile.write(fromfile.read())
 
 
85
    """Return a new UUID"""
 
 
87
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
 
88
    ## Linux, but we need something portable for other systems;
 
 
89
    ## preferably an implementation in Python.
 
 
91
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
 
 
93
        return chomp(os.popen('uuidgen').readline())
 
 
97
    if s and (s[-1] == '\n'):
 
 
105
    ## TODO: Maybe read in chunks to handle big files
 
 
106
    if hasattr(f, 'tell'):
 
 
121
def fingerprint_file(f):
 
 
127
    return {'size': size,
 
 
128
            'sha1': s.hexdigest()}
 
 
133
    """Return email-style username.
 
 
135
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
 
137
    :todo: Check it's reasonably well-formed.
 
 
139
    :todo: Allow taking it from a dotfile to help people on windows
 
 
140
           who can't easily set variables.
 
 
142
    :todo: Cope without pwd module, which is only on unix. 
 
 
144
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
 
152
        w = pwd.getpwuid(uid)
 
 
154
        comma = gecos.find(',')
 
 
158
            realname = gecos[:comma]
 
 
159
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
 
163
    import getpass, socket
 
 
164
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
 
167
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
 
 
169
    """Return just the email component of a username."""
 
 
170
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
 
172
        m = _EMAIL_RE.search(e)
 
 
174
            bailout('%r is not a reasonable email address' % e)
 
 
178
    import getpass, socket
 
 
179
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
 
184
def compare_files(a, b):
 
 
185
    """Returns true if equal in contents"""
 
 
186
    # TODO: don't read the whole thing in one go.
 
 
198
def local_time_offset(t=None):
 
 
199
    """Return offset of local zone from GMT, either at present or at time t."""
 
 
200
    # python2.3 localtime() can't take None
 
 
204
    if time.localtime(t).tm_isdst and time.daylight:
 
 
207
        return -time.timezone
 
 
210
def format_date(t, offset=0, timezone='original'):
 
 
211
    ## TODO: Perhaps a global option to use either universal or local time?
 
 
212
    ## Or perhaps just let people set $TZ?
 
 
213
    assert isinstance(t, float)
 
 
215
    if timezone == 'utc':
 
 
218
    elif timezone == 'original':
 
 
221
        tt = time.gmtime(t + offset)
 
 
222
    elif timezone == 'local':
 
 
223
        tt = time.localtime(t)
 
 
224
        offset = local_time_offset(t)
 
 
226
        bailout("unsupported timezone format %r",
 
 
227
                ['options are "utc", "original", "local"'])
 
 
229
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
 
 
230
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
 
233
def compact_date(when):
 
 
234
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
 
239
    """Return size of given open file."""
 
 
240
    return os.fstat(f.fileno())[ST_SIZE]
 
 
243
if hasattr(os, 'urandom'): # python 2.4 and later
 
 
244
    rand_bytes = os.urandom
 
 
246
    # FIXME: No good on non-Linux
 
 
247
    _rand_file = file('/dev/urandom', 'rb')
 
 
248
    rand_bytes = _rand_file.read
 
 
251
## TODO: We could later have path objects that remember their list
 
 
252
## decomposition (might be too tricksy though.)
 
 
255
    """Turn string into list of parts.
 
 
261
    >>> splitpath('a/./b')
 
 
263
    >>> splitpath('a/.b')
 
 
265
    >>> splitpath('a/../b')
 
 
266
    Traceback (most recent call last):
 
 
268
    BzrError: ("sorry, '..' not allowed in path", [])
 
 
270
    assert isinstance(p, types.StringTypes)
 
 
271
    ps = [f for f in p.split('/') if (f != '.' and f != '')]
 
 
274
            bailout("sorry, %r not allowed in path" % f)
 
 
278
    assert isinstance(p, list)
 
 
280
        if (f == '..') or (f == None) or (f == ''):
 
 
281
            bailout("sorry, %r not allowed in path" % f)
 
 
285
def appendpath(p1, p2):
 
 
292
def extern_command(cmd, ignore_errors = False):
 
 
293
    mutter('external command: %s' % `cmd`)
 
 
295
        if not ignore_errors:
 
 
296
            bailout('command failed')