~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-08 05:39:46 UTC
  • Revision ID: mbp@sourcefrog.net-20050408053946-1cb3415e1f8f58493034a5cf
- import lovely urlgrabber library

Show diffs side-by-side

added added

removed removed

Lines of Context:
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, errno, sys
 
19
import os, types, re, time
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
21
 
22
22
from errors import bailout, BzrError
23
23
from trace import mutter
24
 
import bzrlib
25
24
 
26
25
def make_readonly(filename):
27
26
    """Make a filename read-only."""
56
55
    elif S_ISLNK(mode):
57
56
        return 'symlink'
58
57
    else:
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
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
71
59
 
72
60
 
73
61
 
88
76
        return False
89
77
 
90
78
 
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
 
 
110
79
def pumpfile(fromfile, tofile):
111
80
    """Copy contents of one file to another."""
112
81
    tofile.write(fromfile.read())
114
83
 
115
84
def uuid():
116
85
    """Return a new UUID"""
 
86
    
 
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.
117
90
    try:
118
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
 
91
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
119
92
    except IOError:
120
93
        return chomp(os.popen('uuidgen').readline())
121
94
 
122
95
 
 
96
def chomp(s):
 
97
    if s and (s[-1] == '\n'):
 
98
        return s[:-1]
 
99
    else:
 
100
        return s
 
101
 
 
102
 
123
103
def sha_file(f):
124
104
    import sha
 
105
    ## TODO: Maybe read in chunks to handle big files
125
106
    if hasattr(f, 'tell'):
126
107
        assert f.tell() == 0
127
108
    s = sha.new()
128
 
    BUFSIZE = 128<<10
129
 
    while True:
130
 
        b = f.read(BUFSIZE)
131
 
        if not b:
132
 
            break
133
 
        s.update(b)
 
109
    s.update(f.read())
134
110
    return s.hexdigest()
135
111
 
136
112
 
152
128
            'sha1': s.hexdigest()}
153
129
 
154
130
 
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
 
    """
 
131
 
 
132
def username():
 
133
    """Return email-style username.
 
134
 
 
135
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
136
 
 
137
    :todo: Check it's reasonably well-formed.
 
138
 
 
139
    :todo: Allow taking it from a dotfile to help people on windows
 
140
           who can't easily set variables.
 
141
 
 
142
    :todo: Cope without pwd module, which is only on unix. 
 
143
    """
 
144
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
145
    if e: return e
 
146
 
176
147
    import socket
177
 
 
178
 
    # XXX: Any good way to get real user name on win32?
179
 
 
 
148
    
180
149
    try:
181
150
        import pwd
182
151
        uid = os.getuid()
183
152
        w = pwd.getpwuid(uid)
184
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
185
 
        username = w.pw_name.decode(bzrlib.user_encoding)
 
153
        gecos = w.pw_gecos
186
154
        comma = gecos.find(',')
187
155
        if comma == -1:
188
156
            realname = gecos
189
157
        else:
190
158
            realname = gecos[:comma]
191
 
        if not realname:
192
 
            realname = username
193
 
 
 
159
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
194
160
    except ImportError:
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
 
161
        pass
 
162
 
 
163
    import getpass, socket
 
164
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
242
165
 
243
166
 
244
167
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
245
168
def user_email():
246
169
    """Return just the email component of a username."""
247
 
    e = _get_user_id()
 
170
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
248
171
    if e:
249
172
        m = _EMAIL_RE.search(e)
250
173
        if not m:
251
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
174
            bailout('%r is not a reasonable email address' % e)
252
175
        return m.group(0)
253
176
 
254
 
    return _auto_user_id()[1]
 
177
 
 
178
    import getpass, socket
 
179
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
180
 
255
181
    
256
182
 
257
183
 
258
184
def compare_files(a, b):
259
185
    """Returns true if equal in contents"""
 
186
    # TODO: don't read the whole thing in one go.
260
187
    BUFSIZE = 4096
261
188
    while True:
262
189
        ai = a.read(BUFSIZE)
315
242
 
316
243
if hasattr(os, 'urandom'): # python 2.4 and later
317
244
    rand_bytes = os.urandom
318
 
elif sys.platform == 'linux2':
319
 
    rand_bytes = file('/dev/urandom', 'rb').read
320
245
else:
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
 
246
    # FIXME: No good on non-Linux
 
247
    _rand_file = file('/dev/urandom', 'rb')
 
248
    rand_bytes = _rand_file.read
329
249
 
330
250
 
331
251
## TODO: We could later have path objects that remember their list
348
268
    BzrError: ("sorry, '..' not allowed in path", [])
349
269
    """
350
270
    assert isinstance(p, types.StringTypes)
351
 
 
352
 
    # split on either delimiter because people might use either on
353
 
    # Windows
354
 
    ps = re.split(r'[\\/]', p)
355
 
 
356
 
    rps = []
 
271
    ps = [f for f in p.split('/') if (f != '.' and f != '')]
357
272
    for f in ps:
358
273
        if f == '..':
359
274
            bailout("sorry, %r not allowed in path" % f)
360
 
        elif (f == '.') or (f == ''):
361
 
            pass
362
 
        else:
363
 
            rps.append(f)
364
 
    return rps
 
275
    return ps
365
276
 
366
277
def joinpath(p):
367
278
    assert isinstance(p, list)
368
279
    for f in p:
369
280
        if (f == '..') or (f == None) or (f == ''):
370
281
            bailout("sorry, %r not allowed in path" % f)
371
 
    return os.path.join(*p)
 
282
    return '/'.join(p)
372
283
 
373
284
 
374
285
def appendpath(p1, p2):
375
286
    if p1 == '':
376
287
        return p2
377
288
    else:
378
 
        return os.path.join(p1, p2)
 
289
        return p1 + '/' + p2
379
290
    
380
291
 
381
292
def extern_command(cmd, ignore_errors = False):