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, types
 
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
22
 
from errors import bailout
 
24
 
def make_readonly(filename):
 
25
 
    """Make a filename read-only."""
 
26
 
    # TODO: probably needs to be fixed for windows
 
27
 
    mod = os.stat(filename).st_mode
 
29
 
    os.chmod(filename, mod)
 
32
 
def make_writable(filename):
 
33
 
    mod = os.stat(filename).st_mode
 
35
 
    os.chmod(filename, mod)
 
38
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
40
 
    """Return shell-quoted filename"""
 
41
 
    ## We could be a bit more terse by using double-quotes etc
 
42
 
    f = _QUOTE_RE.sub(r'\\\1', f)
 
49
 
    mode = os.lstat(f)[ST_MODE]
 
57
 
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
 
62
 
    """True if f is an accessible directory."""
 
64
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
71
 
    """True if f is a regular file."""
 
73
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
78
 
def pumpfile(fromfile, tofile):
 
79
 
    """Copy contents of one file to another."""
 
80
 
    tofile.write(fromfile.read())
 
84
 
    """Return a new UUID"""
 
86
 
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
87
 
    ## Linux, but we need something portable for other systems;
 
88
 
    ## preferably an implementation in Python.
 
89
 
    bailout('uuids not allowed!')
 
90
 
    return chomp(os.popen('uuidgen').readline())
 
93
 
    if s and (s[-1] == '\n'):
 
101
 
    ## TODO: Maybe read in chunks to handle big files
 
102
 
    if hasattr(f, 'tell'):
 
118
 
    """Return email-style username.
 
120
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
122
 
    :todo: Check it's reasonably well-formed.
 
124
 
    :todo: Allow taking it from a dotfile to help people on windows
 
125
 
           who can't easily set variables.
 
127
 
    :todo: Cope without pwd module, which is only on unix. 
 
129
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
137
 
        w = pwd.getpwuid(uid)
 
139
 
        comma = gecos.find(',')
 
143
 
            realname = gecos[:comma]
 
144
 
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
148
 
    import getpass, socket
 
149
 
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
153
 
    """Return just the email component of a username."""
 
154
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
157
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
159
 
            bailout('%r is not a reasonable email address' % e)
 
163
 
    import getpass, socket
 
164
 
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
169
 
def compare_files(a, b):
 
170
 
    """Returns true if equal in contents"""
 
171
 
    # TODO: don't read the whole thing in one go.
 
172
 
    result = a.read() == b.read()
 
177
 
def local_time_offset():
 
181
 
        return -time.timezone
 
184
 
def format_date(t, offset=0, timezone='original'):
 
185
 
    ## TODO: Perhaps a global option to use either universal or local time?
 
186
 
    ## Or perhaps just let people set $TZ?
 
189
 
    assert isinstance(t, float)
 
191
 
    if timezone == 'utc':
 
194
 
    elif timezone == 'original':
 
197
 
        tt = time.gmtime(t + offset)
 
198
 
    elif timezone == 'local':
 
199
 
        tt = time.localtime(t)
 
200
 
        offset = local_time_offset()
 
202
 
        bailout("unsupported timezone format %r",
 
203
 
                ['options are "utc", "original", "local"'])
 
205
 
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
 
206
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
209
 
def compact_date(when):
 
210
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
215
 
    """Return size of given open file."""
 
216
 
    return os.fstat(f.fileno())[ST_SIZE]
 
219
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
220
 
    rand_bytes = os.urandom
 
222
 
    # FIXME: No good on non-Linux
 
223
 
    _rand_file = file('/dev/urandom', 'rb')
 
224
 
    rand_bytes = _rand_file.read
 
227
 
## TODO: We could later have path objects that remember their list
 
228
 
## decomposition (might be too tricksy though.)
 
231
 
    """Turn string into list of parts.
 
237
 
    >>> splitpath('a/./b')
 
239
 
    >>> splitpath('a/.b')
 
241
 
    >>> splitpath('a/../b')
 
242
 
    Traceback (most recent call last):
 
244
 
    BzrError: ("sorry, '..' not allowed in path", [])
 
246
 
    assert isinstance(p, types.StringTypes)
 
247
 
    ps = [f for f in p.split('/') if f != '.']
 
250
 
            bailout("sorry, %r not allowed in path" % f)
 
254
 
    assert isinstance(p, list)
 
256
 
        if (f == '..') or (f is None) or (f == ''):
 
257
 
            bailout("sorry, %r not allowed in path" % f)
 
261
 
def appendpath(p1, p2):
 
268
 
def extern_command(cmd, ignore_errors = False):
 
269
 
    mutter('external command: %s' % `cmd`)
 
271
 
        if not ignore_errors:
 
272
 
            bailout('command failed')