← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2005-05-12 02:18:48 UTC
  • Revision ID: mbp@sourcefrog.net-20050512021848-d1a727373aee2c85
- WorkingTree loads statcache in constructor and holds
  it permanently

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
 
19
 
import os, types, re, time, types
 
19
import os, types, re, time, errno, sys
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
21
 
22
 
from errors import bailout
 
22
from errors import bailout, BzrError
 
23
from trace import mutter
 
24
import bzrlib
23
25
 
24
26
def make_readonly(filename):
25
27
    """Make a filename read-only."""
54
56
    elif S_ISLNK(mode):
55
57
        return 'symlink'
56
58
    else:
57
 
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
 
59
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
 
60
 
 
61
 
 
62
def kind_marker(kind):
 
63
    if kind == 'file':
 
64
        return ''
 
65
    elif kind == 'directory':
 
66
        return '/'
 
67
    elif kind == 'symlink':
 
68
        return '@'
 
69
    else:
 
70
        raise BzrError('invalid file kind %r' % kind)
58
71
 
59
72
 
60
73
 
75
88
        return False
76
89
 
77
90
 
 
91
def is_inside(dir, fname):
 
92
    """True if fname is inside dir.
 
93
    """
 
94
    return os.path.commonprefix([dir, fname]) == dir
 
95
 
 
96
 
 
97
def is_inside_any(dir_list, fname):
 
98
    """True if fname is inside any of given dirs."""
 
99
    # quick scan for perfect match
 
100
    if fname in dir_list:
 
101
        return True
 
102
    
 
103
    for dirname in dir_list:
 
104
        if is_inside(dirname, fname):
 
105
            return True
 
106
    else:
 
107
        return False
 
108
 
 
109
 
78
110
def pumpfile(fromfile, tofile):
79
111
    """Copy contents of one file to another."""
80
112
    tofile.write(fromfile.read())
82
114
 
83
115
def uuid():
84
116
    """Return a new UUID"""
85
 
    
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
117
    try:
90
 
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
 
118
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
91
119
    except IOError:
92
120
        return chomp(os.popen('uuidgen').readline())
93
121
 
94
122
 
95
 
def chomp(s):
96
 
    if s and (s[-1] == '\n'):
97
 
        return s[:-1]
98
 
    else:
99
 
        return s
100
 
 
101
 
 
102
123
def sha_file(f):
103
124
    import sha
104
 
    ## TODO: Maybe read in chunks to handle big files
105
125
    if hasattr(f, 'tell'):
106
126
        assert f.tell() == 0
107
127
    s = sha.new()
108
 
    s.update(f.read())
 
128
    BUFSIZE = 128<<10
 
129
    while True:
 
130
        b = f.read(BUFSIZE)
 
131
        if not b:
 
132
            break
 
133
        s.update(b)
109
134
    return s.hexdigest()
110
135
 
111
136
 
117
142
 
118
143
 
119
144
 
120
 
def username():
121
 
    """Return email-style username.
122
 
 
123
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
124
 
 
125
 
    :todo: Check it's reasonably well-formed.
126
 
 
127
 
    :todo: Allow taking it from a dotfile to help people on windows
128
 
           who can't easily set variables.
129
 
 
130
 
    :todo: Cope without pwd module, which is only on unix. 
131
 
    """
132
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
133
 
    if e: return e
134
 
 
 
145
def fingerprint_file(f):
 
146
    import sha
 
147
    s = sha.new()
 
148
    b = f.read()
 
149
    s.update(b)
 
150
    size = len(b)
 
151
    return {'size': size,
 
152
            'sha1': s.hexdigest()}
 
153
 
 
154
 
 
155
def config_dir():
 
156
    """Return per-user configuration directory.
 
157
 
 
158
    By default this is ~/.bzr.conf/
 
159
    
 
160
    TODO: Global option --config-dir to override this.
 
161
    """
 
162
    return os.path.expanduser("~/.bzr.conf")
 
163
 
 
164
 
 
165
def _auto_user_id():
 
166
    """Calculate automatic user identification.
 
167
 
 
168
    Returns (realname, email).
 
169
 
 
170
    Only used when none is set in the environment or the id file.
 
171
 
 
172
    This previously used the FQDN as the default domain, but that can
 
173
    be very slow on machines where DNS is broken.  So now we simply
 
174
    use the hostname.
 
175
    """
135
176
    import socket
136
 
    
 
177
 
 
178
    # XXX: Any good way to get real user name on win32?
 
179
 
137
180
    try:
138
181
        import pwd
139
182
        uid = os.getuid()
140
183
        w = pwd.getpwuid(uid)
141
 
        gecos = w.pw_gecos
 
184
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
 
185
        username = w.pw_name.decode(bzrlib.user_encoding)
142
186
        comma = gecos.find(',')
143
187
        if comma == -1:
144
188
            realname = gecos
145
189
        else:
146
190
            realname = gecos[:comma]
147
 
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
191
        if not realname:
 
192
            realname = username
 
193
 
148
194
    except ImportError:
149
 
        pass
150
 
 
151
 
    import getpass, socket
152
 
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
153
 
 
154
 
 
 
195
        import getpass
 
196
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
197
 
 
198
    return realname, (username + '@' + socket.gethostname())
 
199
 
 
200
 
 
201
def _get_user_id():
 
202
    """Return the full user id from a file or environment variable.
 
203
 
 
204
    TODO: Allow taking this from a file in the branch directory too
 
205
    for per-branch ids."""
 
206
    v = os.environ.get('BZREMAIL')
 
207
    if v:
 
208
        return v.decode(bzrlib.user_encoding)
 
209
    
 
210
    try:
 
211
        return (open(os.path.join(config_dir(), "email"))
 
212
                .read()
 
213
                .decode(bzrlib.user_encoding)
 
214
                .rstrip("\r\n"))
 
215
    except IOError, e:
 
216
        if e.errno != errno.ENOENT:
 
217
            raise e
 
218
 
 
219
    v = os.environ.get('EMAIL')
 
220
    if v:
 
221
        return v.decode(bzrlib.user_encoding)
 
222
    else:    
 
223
        return None
 
224
 
 
225
 
 
226
def username():
 
227
    """Return email-style username.
 
228
 
 
229
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
230
 
 
231
    TODO: Check it's reasonably well-formed.
 
232
    """
 
233
    v = _get_user_id()
 
234
    if v:
 
235
        return v
 
236
    
 
237
    name, email = _auto_user_id()
 
238
    if name:
 
239
        return '%s <%s>' % (name, email)
 
240
    else:
 
241
        return email
 
242
 
 
243
 
 
244
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
155
245
def user_email():
156
246
    """Return just the email component of a username."""
157
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
247
    e = _get_user_id()
158
248
    if e:
159
 
        import re
160
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
249
        m = _EMAIL_RE.search(e)
161
250
        if not m:
162
 
            bailout('%r is not a reasonable email address' % e)
 
251
            bailout("%r doesn't seem to contain a reasonable email address" % e)
163
252
        return m.group(0)
164
253
 
165
 
 
166
 
    import getpass, socket
167
 
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
168
 
 
 
254
    return _auto_user_id()[1]
169
255
    
170
256
 
171
257
 
172
258
def compare_files(a, b):
173
259
    """Returns true if equal in contents"""
174
 
    # TODO: don't read the whole thing in one go.
175
260
    BUFSIZE = 4096
176
261
    while True:
177
262
        ai = a.read(BUFSIZE)
186
271
def local_time_offset(t=None):
187
272
    """Return offset of local zone from GMT, either at present or at time t."""
188
273
    # python2.3 localtime() can't take None
189
 
    if t is None:
 
274
    if t == None:
190
275
        t = time.time()
191
276
        
192
277
    if time.localtime(t).tm_isdst and time.daylight:
198
283
def format_date(t, offset=0, timezone='original'):
199
284
    ## TODO: Perhaps a global option to use either universal or local time?
200
285
    ## Or perhaps just let people set $TZ?
201
 
    import time
202
 
    
203
286
    assert isinstance(t, float)
204
287
    
205
288
    if timezone == 'utc':
232
315
 
233
316
if hasattr(os, 'urandom'): # python 2.4 and later
234
317
    rand_bytes = os.urandom
 
318
elif sys.platform == 'linux2':
 
319
    rand_bytes = file('/dev/urandom', 'rb').read
235
320
else:
236
 
    # FIXME: No good on non-Linux
237
 
    _rand_file = file('/dev/urandom', 'rb')
238
 
    rand_bytes = _rand_file.read
 
321
    # not well seeded, but better than nothing
 
322
    def rand_bytes(n):
 
323
        import random
 
324
        s = ''
 
325
        while n:
 
326
            s += chr(random.randint(0, 255))
 
327
            n -= 1
 
328
        return s
239
329
 
240
330
 
241
331
## TODO: We could later have path objects that remember their list
258
348
    BzrError: ("sorry, '..' not allowed in path", [])
259
349
    """
260
350
    assert isinstance(p, types.StringTypes)
261
 
    ps = [f for f in p.split('/') if f != '.']
 
351
 
 
352
    # split on either delimiter because people might use either on
 
353
    # Windows
 
354
    ps = re.split(r'[\\/]', p)
 
355
 
 
356
    rps = []
262
357
    for f in ps:
263
358
        if f == '..':
264
359
            bailout("sorry, %r not allowed in path" % f)
265
 
    return ps
 
360
        elif (f == '.') or (f == ''):
 
361
            pass
 
362
        else:
 
363
            rps.append(f)
 
364
    return rps
266
365
 
267
366
def joinpath(p):
268
367
    assert isinstance(p, list)
269
368
    for f in p:
270
 
        if (f == '..') or (f is None) or (f == ''):
 
369
        if (f == '..') or (f == None) or (f == ''):
271
370
            bailout("sorry, %r not allowed in path" % f)
272
 
    return '/'.join(p)
 
371
    return os.path.join(*p)
273
372
 
274
373
 
275
374
def appendpath(p1, p2):
276
375
    if p1 == '':
277
376
        return p2
278
377
    else:
279
 
        return p1 + '/' + p2
 
378
        return os.path.join(p1, p2)
280
379
    
281
380
 
282
381
def extern_command(cmd, ignore_errors = False):