/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2005-05-02 04:37:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050502043713-23c8c2663d774e34
- remove trivial chomp() function

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, errno
 
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
21
 
 
22
from errors import bailout, BzrError
 
23
from trace import mutter
 
24
import bzrlib
 
25
 
 
26
def make_readonly(filename):
 
27
    """Make a filename read-only."""
 
28
    # TODO: probably needs to be fixed for windows
 
29
    mod = os.stat(filename).st_mode
 
30
    mod = mod & 0777555
 
31
    os.chmod(filename, mod)
 
32
 
 
33
 
 
34
def make_writable(filename):
 
35
    mod = os.stat(filename).st_mode
 
36
    mod = mod | 0200
 
37
    os.chmod(filename, mod)
 
38
 
 
39
 
 
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
41
def quotefn(f):
 
42
    """Return shell-quoted filename"""
 
43
    ## We could be a bit more terse by using double-quotes etc
 
44
    f = _QUOTE_RE.sub(r'\\\1', f)
 
45
    if f[0] == '~':
 
46
        f[0:1] = r'\~' 
 
47
    return f
 
48
 
 
49
 
 
50
def file_kind(f):
 
51
    mode = os.lstat(f)[ST_MODE]
 
52
    if S_ISREG(mode):
 
53
        return 'file'
 
54
    elif S_ISDIR(mode):
 
55
        return 'directory'
 
56
    elif S_ISLNK(mode):
 
57
        return 'symlink'
 
58
    else:
 
59
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
 
60
 
 
61
 
 
62
 
 
63
def isdir(f):
 
64
    """True if f is an accessible directory."""
 
65
    try:
 
66
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
67
    except OSError:
 
68
        return False
 
69
 
 
70
 
 
71
 
 
72
def isfile(f):
 
73
    """True if f is a regular file."""
 
74
    try:
 
75
        return S_ISREG(os.lstat(f)[ST_MODE])
 
76
    except OSError:
 
77
        return False
 
78
 
 
79
 
 
80
def pumpfile(fromfile, tofile):
 
81
    """Copy contents of one file to another."""
 
82
    tofile.write(fromfile.read())
 
83
 
 
84
 
 
85
def uuid():
 
86
    """Return a new UUID"""
 
87
    try:
 
88
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
 
89
    except IOError:
 
90
        return chomp(os.popen('uuidgen').readline())
 
91
 
 
92
 
 
93
def sha_file(f):
 
94
    import sha
 
95
    ## TODO: Maybe read in chunks to handle big files
 
96
    if hasattr(f, 'tell'):
 
97
        assert f.tell() == 0
 
98
    s = sha.new()
 
99
    s.update(f.read())
 
100
    return s.hexdigest()
 
101
 
 
102
 
 
103
def sha_string(f):
 
104
    import sha
 
105
    s = sha.new()
 
106
    s.update(f)
 
107
    return s.hexdigest()
 
108
 
 
109
 
 
110
 
 
111
def fingerprint_file(f):
 
112
    import sha
 
113
    s = sha.new()
 
114
    b = f.read()
 
115
    s.update(b)
 
116
    size = len(b)
 
117
    return {'size': size,
 
118
            'sha1': s.hexdigest()}
 
119
 
 
120
 
 
121
def config_dir():
 
122
    """Return per-user configuration directory.
 
123
 
 
124
    By default this is ~/.bzr.conf/
 
125
    
 
126
    TODO: Global option --config-dir to override this.
 
127
    """
 
128
    return os.path.expanduser("~/.bzr.conf")
 
129
 
 
130
 
 
131
def _auto_user_id():
 
132
    """Calculate automatic user identification.
 
133
 
 
134
    Returns (realname, email).
 
135
 
 
136
    Only used when none is set in the environment or the id file.
 
137
 
 
138
    This previously used the FQDN as the default domain, but that can
 
139
    be very slow on machines where DNS is broken.  So now we simply
 
140
    use the hostname.
 
141
    """
 
142
    import socket
 
143
 
 
144
    # XXX: Any good way to get real user name on win32?
 
145
 
 
146
    try:
 
147
        import pwd
 
148
        uid = os.getuid()
 
149
        w = pwd.getpwuid(uid)
 
150
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
 
151
        username = w.pw_name.decode(bzrlib.user_encoding)
 
152
        comma = gecos.find(',')
 
153
        if comma == -1:
 
154
            realname = gecos
 
155
        else:
 
156
            realname = gecos[:comma]
 
157
        if not realname:
 
158
            realname = username
 
159
 
 
160
    except ImportError:
 
161
        import getpass
 
162
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
163
 
 
164
    return realname, (username + '@' + socket.gethostname())
 
165
 
 
166
 
 
167
def _get_user_id():
 
168
    """Return the full user id from a file or environment variable.
 
169
 
 
170
    TODO: Allow taking this from a file in the branch directory too
 
171
    for per-branch ids."""
 
172
    v = os.environ.get('BZREMAIL')
 
173
    if v:
 
174
        return v.decode(bzrlib.user_encoding)
 
175
    
 
176
    try:
 
177
        return (open(os.path.join(config_dir(), "email"))
 
178
                .read()
 
179
                .decode(bzrlib.user_encoding)
 
180
                .rstrip("\r\n"))
 
181
    except IOError, e:
 
182
        if e.errno != errno.ENOENT:
 
183
            raise e
 
184
 
 
185
    v = os.environ.get('EMAIL')
 
186
    if v:
 
187
        return v.decode(bzrlib.user_encoding)
 
188
    else:    
 
189
        return None
 
190
 
 
191
 
 
192
def username():
 
193
    """Return email-style username.
 
194
 
 
195
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
196
 
 
197
    TODO: Check it's reasonably well-formed.
 
198
    """
 
199
    v = _get_user_id()
 
200
    if v:
 
201
        return v
 
202
    
 
203
    name, email = _auto_user_id()
 
204
    if name:
 
205
        return '%s <%s>' % (name, email)
 
206
    else:
 
207
        return email
 
208
 
 
209
 
 
210
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
 
211
def user_email():
 
212
    """Return just the email component of a username."""
 
213
    e = _get_user_id()
 
214
    if e:
 
215
        m = _EMAIL_RE.search(e)
 
216
        if not m:
 
217
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
218
        return m.group(0)
 
219
 
 
220
    return _auto_user_id()[1]
 
221
    
 
222
 
 
223
 
 
224
def compare_files(a, b):
 
225
    """Returns true if equal in contents"""
 
226
    # TODO: don't read the whole thing in one go.
 
227
    BUFSIZE = 4096
 
228
    while True:
 
229
        ai = a.read(BUFSIZE)
 
230
        bi = b.read(BUFSIZE)
 
231
        if ai != bi:
 
232
            return False
 
233
        if ai == '':
 
234
            return True
 
235
 
 
236
 
 
237
 
 
238
def local_time_offset(t=None):
 
239
    """Return offset of local zone from GMT, either at present or at time t."""
 
240
    # python2.3 localtime() can't take None
 
241
    if t == None:
 
242
        t = time.time()
 
243
        
 
244
    if time.localtime(t).tm_isdst and time.daylight:
 
245
        return -time.altzone
 
246
    else:
 
247
        return -time.timezone
 
248
 
 
249
    
 
250
def format_date(t, offset=0, timezone='original'):
 
251
    ## TODO: Perhaps a global option to use either universal or local time?
 
252
    ## Or perhaps just let people set $TZ?
 
253
    assert isinstance(t, float)
 
254
    
 
255
    if timezone == 'utc':
 
256
        tt = time.gmtime(t)
 
257
        offset = 0
 
258
    elif timezone == 'original':
 
259
        if offset == None:
 
260
            offset = 0
 
261
        tt = time.gmtime(t + offset)
 
262
    elif timezone == 'local':
 
263
        tt = time.localtime(t)
 
264
        offset = local_time_offset(t)
 
265
    else:
 
266
        bailout("unsupported timezone format %r",
 
267
                ['options are "utc", "original", "local"'])
 
268
 
 
269
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
 
270
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
271
 
 
272
 
 
273
def compact_date(when):
 
274
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
275
    
 
276
 
 
277
 
 
278
def filesize(f):
 
279
    """Return size of given open file."""
 
280
    return os.fstat(f.fileno())[ST_SIZE]
 
281
 
 
282
 
 
283
if hasattr(os, 'urandom'): # python 2.4 and later
 
284
    rand_bytes = os.urandom
 
285
else:
 
286
    # FIXME: No good on non-Linux
 
287
    _rand_file = file('/dev/urandom', 'rb')
 
288
    rand_bytes = _rand_file.read
 
289
 
 
290
 
 
291
## TODO: We could later have path objects that remember their list
 
292
## decomposition (might be too tricksy though.)
 
293
 
 
294
def splitpath(p):
 
295
    """Turn string into list of parts.
 
296
 
 
297
    >>> splitpath('a')
 
298
    ['a']
 
299
    >>> splitpath('a/b')
 
300
    ['a', 'b']
 
301
    >>> splitpath('a/./b')
 
302
    ['a', 'b']
 
303
    >>> splitpath('a/.b')
 
304
    ['a', '.b']
 
305
    >>> splitpath('a/../b')
 
306
    Traceback (most recent call last):
 
307
    ...
 
308
    BzrError: ("sorry, '..' not allowed in path", [])
 
309
    """
 
310
    assert isinstance(p, types.StringTypes)
 
311
 
 
312
    # split on either delimiter because people might use either on
 
313
    # Windows
 
314
    ps = re.split(r'[\\/]', p)
 
315
 
 
316
    rps = []
 
317
    for f in ps:
 
318
        if f == '..':
 
319
            bailout("sorry, %r not allowed in path" % f)
 
320
        elif (f == '.') or (f == ''):
 
321
            pass
 
322
        else:
 
323
            rps.append(f)
 
324
    return rps
 
325
 
 
326
def joinpath(p):
 
327
    assert isinstance(p, list)
 
328
    for f in p:
 
329
        if (f == '..') or (f == None) or (f == ''):
 
330
            bailout("sorry, %r not allowed in path" % f)
 
331
    return os.path.join(*p)
 
332
 
 
333
 
 
334
def appendpath(p1, p2):
 
335
    if p1 == '':
 
336
        return p2
 
337
    else:
 
338
        return os.path.join(p1, p2)
 
339
    
 
340
 
 
341
def extern_command(cmd, ignore_errors = False):
 
342
    mutter('external command: %s' % `cmd`)
 
343
    if os.system(cmd):
 
344
        if not ignore_errors:
 
345
            bailout('command failed')
 
346