~bzr-pqm/bzr/1.17

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:08:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050309040815-13242001617e4a06
import from baz patch-364

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Bazaar-NG -- distributed version control
 
2
 
 
3
# Copyright (C) 2005 by Canonical Ltd
 
4
 
 
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.
 
9
 
 
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.
 
14
 
 
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
 
18
 
 
19
import os, types, re, time, types
 
20
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
 
21
 
 
22
from errors import bailout
 
23
 
 
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
 
28
    mod = mod & 0777555
 
29
    os.chmod(filename, mod)
 
30
 
 
31
 
 
32
def make_writable(filename):
 
33
    mod = os.stat(filename).st_mode
 
34
    mod = mod | 0200
 
35
    os.chmod(filename, mod)
 
36
 
 
37
 
 
38
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
39
def quotefn(f):
 
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)
 
43
    if f[0] == '~':
 
44
        f[0:1] = r'\~' 
 
45
    return f
 
46
 
 
47
 
 
48
def file_kind(f):
 
49
    mode = os.lstat(f)[ST_MODE]
 
50
    if S_ISREG(mode):
 
51
        return 'file'
 
52
    elif S_ISDIR(mode):
 
53
        return 'directory'
 
54
    else:
 
55
        bailout("can't handle file kind of %r" % fp)
 
56
 
 
57
 
 
58
 
 
59
def isdir(f):
 
60
    """True if f is an accessible directory."""
 
61
    try:
 
62
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
63
    except OSError:
 
64
        return False
 
65
 
 
66
 
 
67
 
 
68
def isfile(f):
 
69
    """True if f is a regular file."""
 
70
    try:
 
71
        return S_ISREG(os.lstat(f)[ST_MODE])
 
72
    except OSError:
 
73
        return False
 
74
 
 
75
 
 
76
def pumpfile(fromfile, tofile):
 
77
    """Copy contents of one file to another."""
 
78
    tofile.write(fromfile.read())
 
79
 
 
80
 
 
81
def uuid():
 
82
    """Return a new UUID"""
 
83
    
 
84
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
85
    ## Linux, but we need something portable for other systems;
 
86
    ## preferably an implementation in Python.
 
87
    bailout('uuids not allowed!')
 
88
    return chomp(os.popen('uuidgen').readline())
 
89
 
 
90
def chomp(s):
 
91
    if s and (s[-1] == '\n'):
 
92
        return s[:-1]
 
93
    else:
 
94
        return s
 
95
 
 
96
 
 
97
def sha_file(f):
 
98
    import sha
 
99
    ## TODO: Maybe read in chunks to handle big files
 
100
    if hasattr(f, 'tell'):
 
101
        assert f.tell() == 0
 
102
    s = sha.new()
 
103
    s.update(f.read())
 
104
    return s.hexdigest()
 
105
 
 
106
 
 
107
def sha_string(f):
 
108
    import sha
 
109
    s = sha.new()
 
110
    s.update(f)
 
111
    return s.hexdigest()
 
112
 
 
113
 
 
114
 
 
115
def username():
 
116
    """Return email-style username.
 
117
 
 
118
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
119
 
 
120
    :todo: Check it's reasonably well-formed.
 
121
 
 
122
    :todo: Allow taking it from a dotfile to help people on windows
 
123
           who can't easily set variables.
 
124
 
 
125
    :todo: Cope without pwd module, which is only on unix. 
 
126
    """
 
127
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
128
    if e: return e
 
129
 
 
130
    import socket
 
131
    
 
132
    try:
 
133
        import pwd
 
134
        uid = os.getuid()
 
135
        w = pwd.getpwuid(uid)
 
136
        realname, junk = w.pw_gecos.split(',', 1)
 
137
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
138
    except ImportError:
 
139
        pass
 
140
 
 
141
    import getpass, socket
 
142
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
143
 
 
144
 
 
145
def user_email():
 
146
    """Return just the email component of a username."""
 
147
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
148
    if e:
 
149
        import re
 
150
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
151
        if not m:
 
152
            bailout('%r is not a reasonable email address' % e)
 
153
        return m.group(0)
 
154
 
 
155
 
 
156
    import getpass, socket
 
157
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
158
 
 
159
    
 
160
 
 
161
 
 
162
def compare_files(a, b):
 
163
    """Returns true if equal in contents"""
 
164
    # TODO: don't read the whole thing in one go.
 
165
    result = a.read() == b.read()
 
166
    return result
 
167
 
 
168
 
 
169
 
 
170
def format_date(t, inutc=False):
 
171
    ## TODO: Perhaps a global option to use either universal or local time?
 
172
    ## Or perhaps just let people set $TZ?
 
173
    import time
 
174
    
 
175
    assert isinstance(t, float)
 
176
    
 
177
    if inutc:
 
178
        tt = time.gmtime(t)
 
179
        zonename = 'UTC'
 
180
        offset = 0
 
181
    else:
 
182
        tt = time.localtime(t)
 
183
        if time.daylight:
 
184
            zonename = time.tzname[1]
 
185
            offset = - time.altzone
 
186
        else:
 
187
            zonename = time.tzname[0]
 
188
            offset = - time.timezone
 
189
            
 
190
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
 
191
            + ' ' + zonename + ' '
 
192
            + '%+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
193
 
 
194
 
 
195
def compact_date(when):
 
196
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
197
    
 
198
 
 
199
 
 
200
def filesize(f):
 
201
    """Return size of given open file."""
 
202
    return os.fstat(f.fileno())[ST_SIZE]
 
203
 
 
204
 
 
205
if hasattr(os, 'urandom'): # python 2.4 and later
 
206
    rand_bytes = os.urandom
 
207
else:
 
208
    # FIXME: No good on non-Linux
 
209
    _rand_file = file('/dev/urandom', 'rb')
 
210
    rand_bytes = _rand_file.read
 
211
 
 
212
 
 
213
## TODO: We could later have path objects that remember their list
 
214
## decomposition (might be too tricksy though.)
 
215
 
 
216
def splitpath(p):
 
217
    """Turn string into list of parts.
 
218
 
 
219
    >>> splitpath('a')
 
220
    ['a']
 
221
    >>> splitpath('a/b')
 
222
    ['a', 'b']
 
223
    >>> splitpath('a/./b')
 
224
    ['a', 'b']
 
225
    >>> splitpath('a/.b')
 
226
    ['a', '.b']
 
227
    >>> splitpath('a/../b')
 
228
    Traceback (most recent call last):
 
229
    ...
 
230
    BzrError: ("sorry, '..' not allowed in path", [])
 
231
    """
 
232
    assert isinstance(p, types.StringTypes)
 
233
    ps = [f for f in p.split('/') if f != '.']
 
234
    for f in ps:
 
235
        if f == '..':
 
236
            bailout("sorry, %r not allowed in path" % f)
 
237
    return ps
 
238
 
 
239
def joinpath(p):
 
240
    assert isinstance(p, list)
 
241
    for f in p:
 
242
        if (f == '..') or (f is None) or (f == ''):
 
243
            bailout("sorry, %r not allowed in path" % f)
 
244
    return '/'.join(p)
 
245
 
 
246
 
 
247
def appendpath(p1, p2):
 
248
    if p1 == '':
 
249
        return p2
 
250
    else:
 
251
        return p1 + '/' + p2
 
252
    
 
253
 
 
254
def extern_command(cmd, ignore_errors = False):
 
255
    mutter('external command: %s' % `cmd`)
 
256
    if os.system(cmd):
 
257
        if not ignore_errors:
 
258
            bailout('command failed')
 
259