~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Aaron Bentley
  • Date: 2007-12-12 15:17:13 UTC
  • mto: This revision was merged to the branch mainline in revision 3113.
  • Revision ID: abentley@panoramicfeedback.com-20071212151713-ox5n8rlx8m3nsspy
Add support for reconfiguring repositories into branches or trees

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2007 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
3
#            and others
3
4
#
4
5
# This program is free software; you can redistribute it and/or modify
5
6
# it under the terms of the GNU General Public License as published by
18
19
"""Configuration that affects the behaviour of Bazaar.
19
20
 
20
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
21
 
and ~/.bazaar/branches.conf, which is written to by bzr.
 
22
and ~/.bazaar/locations.conf, which is written to by bzr.
22
23
 
23
24
In bazaar.conf the following options may be set:
24
25
[DEFAULT]
27
28
check_signatures=require|ignore|check-available(default)
28
29
create_signatures=always|never|when-required(default)
29
30
gpg_signing_command=name-of-program
 
31
log_format=name-of-format
30
32
 
31
 
in branches.conf, you specify the url of a branch and options for it.
 
33
in locations.conf, you specify the url of a branch and options for it.
32
34
Wildcards may be used - * and ? as normal in shell completion. Options
33
 
set in both bazaar.conf and branches.conf are overriden by the branches.conf
 
35
set in both bazaar.conf and locations.conf are overridden by the locations.conf
34
36
setting.
35
37
[/home/robertc/source]
36
38
recurse=False|True(default)
37
39
email= as above
38
 
check_signatures= as abive 
 
40
check_signatures= as above 
39
41
create_signatures= as above.
40
42
 
41
43
explanation of options
48
50
create_signatures - this option controls whether bzr will always create 
49
51
                    gpg signatures, never create them, or create them if the
50
52
                    branch is configured to require them.
51
 
                    NB: This option is planned, but not implemented yet.
 
53
log_format - this option sets the default log format.  Possible values are
 
54
             long, short, line, or a plugin can register new formats.
 
55
 
 
56
In bazaar.conf you can also define aliases in the ALIASES sections, example
 
57
 
 
58
[ALIASES]
 
59
lastlog=log --line -r-10..-1
 
60
ll=log --line -r-10..-1
 
61
h=help
 
62
up=pull
52
63
"""
53
64
 
54
 
 
55
 
import errno
56
65
import os
57
66
import sys
 
67
 
 
68
from bzrlib.lazy_import import lazy_import
 
69
lazy_import(globals(), """
 
70
import errno
58
71
from fnmatch import fnmatch
59
72
import re
 
73
from cStringIO import StringIO
60
74
 
61
75
import bzrlib
62
 
import bzrlib.errors as errors
63
 
from bzrlib.osutils import pathjoin
64
 
from bzrlib.trace import mutter
65
 
import bzrlib.util.configobj.configobj as configobj
66
 
from StringIO import StringIO
 
76
from bzrlib import (
 
77
    debug,
 
78
    errors,
 
79
    mail_client,
 
80
    osutils,
 
81
    symbol_versioning,
 
82
    trace,
 
83
    ui,
 
84
    urlutils,
 
85
    win32utils,
 
86
    )
 
87
from bzrlib.util.configobj import configobj
 
88
""")
 
89
 
67
90
 
68
91
CHECK_IF_POSSIBLE=0
69
92
CHECK_ALWAYS=1
70
93
CHECK_NEVER=2
71
94
 
72
95
 
 
96
SIGN_WHEN_REQUIRED=0
 
97
SIGN_ALWAYS=1
 
98
SIGN_NEVER=2
 
99
 
 
100
 
 
101
POLICY_NONE = 0
 
102
POLICY_NORECURSE = 1
 
103
POLICY_APPENDPATH = 2
 
104
 
 
105
_policy_name = {
 
106
    POLICY_NONE: None,
 
107
    POLICY_NORECURSE: 'norecurse',
 
108
    POLICY_APPENDPATH: 'appendpath',
 
109
    }
 
110
_policy_value = {
 
111
    None: POLICY_NONE,
 
112
    'none': POLICY_NONE,
 
113
    'norecurse': POLICY_NORECURSE,
 
114
    'appendpath': POLICY_APPENDPATH,
 
115
    }
 
116
 
 
117
 
 
118
STORE_LOCATION = POLICY_NONE
 
119
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
 
120
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
 
121
STORE_BRANCH = 3
 
122
STORE_GLOBAL = 4
 
123
 
 
124
 
73
125
class ConfigObj(configobj.ConfigObj):
74
126
 
75
127
    def get_bool(self, section, key):
76
 
        val = self[section][key].lower()
77
 
        if val in ('1', 'yes', 'true', 'on'):
78
 
            return True
79
 
        elif val in ('0', 'no', 'false', 'off'):
80
 
            return False
81
 
        else:
82
 
            raise ValueError("Value %r is not boolean" % val)
 
128
        return self[section].as_bool(key)
83
129
 
84
130
    def get_value(self, section, name):
85
131
        # Try [] for the old DEFAULT section.
98
144
        """Get the users pop up editor."""
99
145
        raise NotImplementedError
100
146
 
 
147
    def get_mail_client(self):
 
148
        """Get a mail client to use"""
 
149
        selected_client = self.get_user_option('mail_client')
 
150
        try:
 
151
            mail_client_class = {
 
152
                None: mail_client.DefaultMail,
 
153
                # Specific clients
 
154
                'evolution': mail_client.Evolution,
 
155
                'kmail': mail_client.KMail,
 
156
                'mutt': mail_client.Mutt,
 
157
                'thunderbird': mail_client.Thunderbird,
 
158
                # Generic options
 
159
                'default': mail_client.DefaultMail,
 
160
                'editor': mail_client.Editor,
 
161
                'mapi': mail_client.MAPIClient,
 
162
                'xdg-email': mail_client.XDGEmail,
 
163
            }[selected_client]
 
164
        except KeyError:
 
165
            raise errors.UnknownMailClient(selected_client)
 
166
        return mail_client_class(self)
 
167
 
101
168
    def _get_signature_checking(self):
102
169
        """Template method to override signature checking policy."""
103
170
 
 
171
    def _get_signing_policy(self):
 
172
        """Template method to override signature creation policy."""
 
173
 
104
174
    def _get_user_option(self, option_name):
105
175
        """Template method to provide a user option."""
106
176
        return None
120
190
        """See gpg_signing_command()."""
121
191
        return None
122
192
 
 
193
    def log_format(self):
 
194
        """What log format should be used"""
 
195
        result = self._log_format()
 
196
        if result is None:
 
197
            result = "long"
 
198
        return result
 
199
 
 
200
    def _log_format(self):
 
201
        """See log_format()."""
 
202
        return None
 
203
 
123
204
    def __init__(self):
124
205
        super(Config, self).__init__()
125
206
 
143
224
    
144
225
        Something similar to 'Martin Pool <mbp@sourcefrog.net>'
145
226
        
146
 
        $BZREMAIL can be set to override this, then
 
227
        $BZR_EMAIL can be set to override this (as well as the
 
228
        deprecated $BZREMAIL), then
147
229
        the concrete policy type is checked, and finally
148
230
        $EMAIL is examined.
149
231
        If none is found, a reasonable default is (hopefully)
151
233
    
152
234
        TODO: Check it's reasonably well-formed.
153
235
        """
154
 
        v = os.environ.get('BZREMAIL')
 
236
        v = os.environ.get('BZR_EMAIL')
155
237
        if v:
156
238
            return v.decode(bzrlib.user_encoding)
157
 
    
 
239
 
158
240
        v = self._get_user_id()
159
241
        if v:
160
242
            return v
161
 
        
 
243
 
162
244
        v = os.environ.get('EMAIL')
163
245
        if v:
164
246
            return v.decode(bzrlib.user_encoding)
176
258
            return policy
177
259
        return CHECK_IF_POSSIBLE
178
260
 
 
261
    def signing_policy(self):
 
262
        """What is the current policy for signature checking?."""
 
263
        policy = self._get_signing_policy()
 
264
        if policy is not None:
 
265
            return policy
 
266
        return SIGN_WHEN_REQUIRED
 
267
 
179
268
    def signature_needed(self):
180
269
        """Is a signature needed when committing ?."""
181
 
        policy = self._get_signature_checking()
182
 
        if policy == CHECK_ALWAYS:
 
270
        policy = self._get_signing_policy()
 
271
        if policy is None:
 
272
            policy = self._get_signature_checking()
 
273
            if policy is not None:
 
274
                trace.warning("Please use create_signatures,"
 
275
                              " not check_signatures to set signing policy.")
 
276
            if policy == CHECK_ALWAYS:
 
277
                return True
 
278
        elif policy == SIGN_ALWAYS:
183
279
            return True
184
280
        return False
185
281
 
 
282
    def get_alias(self, value):
 
283
        return self._get_alias(value)
 
284
 
 
285
    def _get_alias(self, value):
 
286
        pass
 
287
 
 
288
    def get_nickname(self):
 
289
        return self._get_nickname()
 
290
 
 
291
    def _get_nickname(self):
 
292
        return None
 
293
 
 
294
    def get_bzr_remote_path(self):
 
295
        try:
 
296
            return os.environ['BZR_REMOTE_PATH']
 
297
        except KeyError:
 
298
            path = self.get_user_option("bzr_remote_path")
 
299
            if path is None:
 
300
                path = 'bzr'
 
301
            return path
 
302
 
186
303
 
187
304
class IniBasedConfig(Config):
188
305
    """A configuration policy that draws from ini files."""
195
312
        else:
196
313
            input = file
197
314
        try:
198
 
            self._parser = ConfigObj(input)
 
315
            self._parser = ConfigObj(input, encoding='utf-8')
199
316
        except configobj.ConfigObjError, e:
200
317
            raise errors.ParseConfigError(e.errors, e.config.filename)
201
318
        return self._parser
202
319
 
 
320
    def _get_matching_sections(self):
 
321
        """Return an ordered list of (section_name, extra_path) pairs.
 
322
 
 
323
        If the section contains inherited configuration, extra_path is
 
324
        a string containing the additional path components.
 
325
        """
 
326
        section = self._get_section()
 
327
        if section is not None:
 
328
            return [(section, '')]
 
329
        else:
 
330
            return []
 
331
 
203
332
    def _get_section(self):
204
333
        """Override this to define the section used by the config."""
205
334
        return "DEFAULT"
206
335
 
 
336
    def _get_option_policy(self, section, option_name):
 
337
        """Return the policy for the given (section, option_name) pair."""
 
338
        return POLICY_NONE
 
339
 
207
340
    def _get_signature_checking(self):
208
341
        """See Config._get_signature_checking."""
209
342
        policy = self._get_user_option('check_signatures')
210
343
        if policy:
211
344
            return self._string_to_signature_policy(policy)
212
345
 
 
346
    def _get_signing_policy(self):
 
347
        """See Config._get_signing_policy"""
 
348
        policy = self._get_user_option('create_signatures')
 
349
        if policy:
 
350
            return self._string_to_signing_policy(policy)
 
351
 
213
352
    def _get_user_id(self):
214
353
        """Get the user id from the 'email' key in the current section."""
215
354
        return self._get_user_option('email')
216
355
 
217
356
    def _get_user_option(self, option_name):
218
357
        """See Config._get_user_option."""
219
 
        try:
220
 
            return self._get_parser().get_value(self._get_section(),
221
 
                                                option_name)
222
 
        except KeyError:
223
 
            pass
 
358
        for (section, extra_path) in self._get_matching_sections():
 
359
            try:
 
360
                value = self._get_parser().get_value(section, option_name)
 
361
            except KeyError:
 
362
                continue
 
363
            policy = self._get_option_policy(section, option_name)
 
364
            if policy == POLICY_NONE:
 
365
                return value
 
366
            elif policy == POLICY_NORECURSE:
 
367
                # norecurse items only apply to the exact path
 
368
                if extra_path:
 
369
                    continue
 
370
                else:
 
371
                    return value
 
372
            elif policy == POLICY_APPENDPATH:
 
373
                if extra_path:
 
374
                    value = urlutils.join(value, extra_path)
 
375
                return value
 
376
            else:
 
377
                raise AssertionError('Unexpected config policy %r' % policy)
 
378
        else:
 
379
            return None
224
380
 
225
381
    def _gpg_signing_command(self):
226
382
        """See Config.gpg_signing_command."""
227
383
        return self._get_user_option('gpg_signing_command')
228
384
 
 
385
    def _log_format(self):
 
386
        """See Config.log_format."""
 
387
        return self._get_user_option('log_format')
 
388
 
229
389
    def __init__(self, get_filename):
230
390
        super(IniBasedConfig, self).__init__()
231
391
        self._get_filename = get_filename
246
406
        raise errors.BzrError("Invalid signatures policy '%s'"
247
407
                              % signature_string)
248
408
 
 
409
    def _string_to_signing_policy(self, signature_string):
 
410
        """Convert a string to a signing policy."""
 
411
        if signature_string.lower() == 'when-required':
 
412
            return SIGN_WHEN_REQUIRED
 
413
        if signature_string.lower() == 'never':
 
414
            return SIGN_NEVER
 
415
        if signature_string.lower() == 'always':
 
416
            return SIGN_ALWAYS
 
417
        raise errors.BzrError("Invalid signing policy '%s'"
 
418
                              % signature_string)
 
419
 
 
420
    def _get_alias(self, value):
 
421
        try:
 
422
            return self._get_parser().get_value("ALIASES", 
 
423
                                                value)
 
424
        except KeyError:
 
425
            pass
 
426
 
 
427
    def _get_nickname(self):
 
428
        return self.get_user_option('nickname')
 
429
 
249
430
 
250
431
class GlobalConfig(IniBasedConfig):
251
432
    """The configuration that should be used for a specific location."""
256
437
    def __init__(self):
257
438
        super(GlobalConfig, self).__init__(config_filename)
258
439
 
 
440
    def set_user_option(self, option, value):
 
441
        """Save option and its value in the configuration."""
 
442
        # FIXME: RBC 20051029 This should refresh the parser and also take a
 
443
        # file lock on bazaar.conf.
 
444
        conf_dir = os.path.dirname(self._get_filename())
 
445
        ensure_config_dir_exists(conf_dir)
 
446
        if 'DEFAULT' not in self._get_parser():
 
447
            self._get_parser()['DEFAULT'] = {}
 
448
        self._get_parser()['DEFAULT'][option] = value
 
449
        f = open(self._get_filename(), 'wb')
 
450
        self._get_parser().write(f)
 
451
        f.close()
 
452
 
259
453
 
260
454
class LocationConfig(IniBasedConfig):
261
455
    """A configuration object that gives the policy for a location."""
262
456
 
263
457
    def __init__(self, location):
264
 
        super(LocationConfig, self).__init__(branches_config_filename)
265
 
        self._global_config = None
 
458
        name_generator = locations_config_filename
 
459
        if (not os.path.exists(name_generator()) and
 
460
                os.path.exists(branches_config_filename())):
 
461
            if sys.platform == 'win32':
 
462
                trace.warning('Please rename %s to %s'
 
463
                              % (branches_config_filename(),
 
464
                                 locations_config_filename()))
 
465
            else:
 
466
                trace.warning('Please rename ~/.bazaar/branches.conf'
 
467
                              ' to ~/.bazaar/locations.conf')
 
468
            name_generator = branches_config_filename
 
469
        super(LocationConfig, self).__init__(name_generator)
 
470
        # local file locations are looked up by local path, rather than
 
471
        # by file url. This is because the config file is a user
 
472
        # file, and we would rather not expose the user to file urls.
 
473
        if location.startswith('file://'):
 
474
            location = urlutils.local_path_from_url(location)
266
475
        self.location = location
267
476
 
268
 
    def _get_global_config(self):
269
 
        if self._global_config is None:
270
 
            self._global_config = GlobalConfig()
271
 
        return self._global_config
272
 
 
273
 
    def _get_section(self):
274
 
        """Get the section we should look in for config items.
275
 
 
276
 
        Returns None if none exists. 
277
 
        TODO: perhaps return a NullSection that thunks through to the 
278
 
              global config.
279
 
        """
 
477
    def _get_matching_sections(self):
 
478
        """Return an ordered list of section names matching this location."""
280
479
        sections = self._get_parser()
281
480
        location_names = self.location.split('/')
282
481
        if self.location.endswith('/'):
283
482
            del location_names[-1]
284
483
        matches=[]
285
484
        for section in sections:
286
 
            section_names = section.split('/')
 
485
            # location is a local path if possible, so we need
 
486
            # to convert 'file://' urls to local paths if necessary.
 
487
            # This also avoids having file:///path be a more exact
 
488
            # match than '/path'.
 
489
            if section.startswith('file://'):
 
490
                section_path = urlutils.local_path_from_url(section)
 
491
            else:
 
492
                section_path = section
 
493
            section_names = section_path.split('/')
287
494
            if section.endswith('/'):
288
495
                del section_names[-1]
289
496
            names = zip(location_names, section_names)
298
505
            # if section is longer, no match.
299
506
            if len(section_names) > len(location_names):
300
507
                continue
301
 
            # if path is longer, and recurse is not true, no match
302
 
            if len(section_names) < len(location_names):
303
 
                try:
304
 
                    if not self._get_parser().get_bool(section, 'recurse'):
305
 
                        continue
306
 
                except KeyError:
307
 
                    pass
308
 
            matches.append((len(section_names), section))
309
 
        if not len(matches):
310
 
            return None
 
508
            matches.append((len(section_names), section,
 
509
                            '/'.join(location_names[len(section_names):])))
311
510
        matches.sort(reverse=True)
312
 
        return matches[0][1]
313
 
 
314
 
    def _gpg_signing_command(self):
315
 
        """See Config.gpg_signing_command."""
316
 
        command = super(LocationConfig, self)._gpg_signing_command()
317
 
        if command is not None:
318
 
            return command
319
 
        return self._get_global_config()._gpg_signing_command()
320
 
 
321
 
    def _get_user_id(self):
322
 
        user_id = super(LocationConfig, self)._get_user_id()
323
 
        if user_id is not None:
324
 
            return user_id
325
 
        return self._get_global_config()._get_user_id()
326
 
 
327
 
    def _get_user_option(self, option_name):
328
 
        """See Config._get_user_option."""
329
 
        option_value = super(LocationConfig, 
330
 
                             self)._get_user_option(option_name)
331
 
        if option_value is not None:
332
 
            return option_value
333
 
        return self._get_global_config()._get_user_option(option_name)
334
 
 
335
 
    def _get_signature_checking(self):
336
 
        """See Config._get_signature_checking."""
337
 
        check = super(LocationConfig, self)._get_signature_checking()
338
 
        if check is not None:
339
 
            return check
340
 
        return self._get_global_config()._get_signature_checking()
341
 
 
342
 
    def _post_commit(self):
343
 
        """See Config.post_commit."""
344
 
        hook = self._get_user_option('post_commit')
345
 
        if hook is not None:
346
 
            return hook
347
 
        return self._get_global_config()._post_commit()
348
 
 
349
 
    def set_user_option(self, option, value):
 
511
        sections = []
 
512
        for (length, section, extra_path) in matches:
 
513
            sections.append((section, extra_path))
 
514
            # should we stop looking for parent configs here?
 
515
            try:
 
516
                if self._get_parser()[section].as_bool('ignore_parents'):
 
517
                    break
 
518
            except KeyError:
 
519
                pass
 
520
        return sections
 
521
 
 
522
    def _get_option_policy(self, section, option_name):
 
523
        """Return the policy for the given (section, option_name) pair."""
 
524
        # check for the old 'recurse=False' flag
 
525
        try:
 
526
            recurse = self._get_parser()[section].as_bool('recurse')
 
527
        except KeyError:
 
528
            recurse = True
 
529
        if not recurse:
 
530
            return POLICY_NORECURSE
 
531
 
 
532
        policy_key = option_name + ':policy'
 
533
        try:
 
534
            policy_name = self._get_parser()[section][policy_key]
 
535
        except KeyError:
 
536
            policy_name = None
 
537
 
 
538
        return _policy_value[policy_name]
 
539
 
 
540
    def _set_option_policy(self, section, option_name, option_policy):
 
541
        """Set the policy for the given option name in the given section."""
 
542
        # The old recurse=False option affects all options in the
 
543
        # section.  To handle multiple policies in the section, we
 
544
        # need to convert it to a policy_norecurse key.
 
545
        try:
 
546
            recurse = self._get_parser()[section].as_bool('recurse')
 
547
        except KeyError:
 
548
            pass
 
549
        else:
 
550
            symbol_versioning.warn(
 
551
                'The recurse option is deprecated as of 0.14.  '
 
552
                'The section "%s" has been converted to use policies.'
 
553
                % section,
 
554
                DeprecationWarning)
 
555
            del self._get_parser()[section]['recurse']
 
556
            if not recurse:
 
557
                for key in self._get_parser()[section].keys():
 
558
                    if not key.endswith(':policy'):
 
559
                        self._get_parser()[section][key +
 
560
                                                    ':policy'] = 'norecurse'
 
561
 
 
562
        policy_key = option_name + ':policy'
 
563
        policy_name = _policy_name[option_policy]
 
564
        if policy_name is not None:
 
565
            self._get_parser()[section][policy_key] = policy_name
 
566
        else:
 
567
            if policy_key in self._get_parser()[section]:
 
568
                del self._get_parser()[section][policy_key]
 
569
 
 
570
    def set_user_option(self, option, value, store=STORE_LOCATION):
350
571
        """Save option and its value in the configuration."""
 
572
        assert store in [STORE_LOCATION,
 
573
                         STORE_LOCATION_NORECURSE,
 
574
                         STORE_LOCATION_APPENDPATH], 'bad storage policy'
351
575
        # FIXME: RBC 20051029 This should refresh the parser and also take a
352
 
        # file lock on branches.conf.
 
576
        # file lock on locations.conf.
353
577
        conf_dir = os.path.dirname(self._get_filename())
354
578
        ensure_config_dir_exists(conf_dir)
355
579
        location = self.location
361
585
        elif location + '/' in self._get_parser():
362
586
            location = location + '/'
363
587
        self._get_parser()[location][option]=value
364
 
        self._get_parser().write()
 
588
        # the allowed values of store match the config policies
 
589
        self._set_option_policy(location, option, store)
 
590
        self._get_parser().write(file(self._get_filename(), 'wb'))
365
591
 
366
592
 
367
593
class BranchConfig(Config):
368
594
    """A configuration object giving the policy for a branch."""
369
595
 
 
596
    def _get_branch_data_config(self):
 
597
        if self._branch_data_config is None:
 
598
            self._branch_data_config = TreeConfig(self.branch)
 
599
        return self._branch_data_config
 
600
 
370
601
    def _get_location_config(self):
371
602
        if self._location_config is None:
372
603
            self._location_config = LocationConfig(self.branch.base)
373
604
        return self._location_config
374
605
 
 
606
    def _get_global_config(self):
 
607
        if self._global_config is None:
 
608
            self._global_config = GlobalConfig()
 
609
        return self._global_config
 
610
 
 
611
    def _get_best_value(self, option_name):
 
612
        """This returns a user option from local, tree or global config.
 
613
 
 
614
        They are tried in that order.  Use get_safe_value if trusted values
 
615
        are necessary.
 
616
        """
 
617
        for source in self.option_sources:
 
618
            value = getattr(source(), option_name)()
 
619
            if value is not None:
 
620
                return value
 
621
        return None
 
622
 
 
623
    def _get_safe_value(self, option_name):
 
624
        """This variant of get_best_value never returns untrusted values.
 
625
        
 
626
        It does not return values from the branch data, because the branch may
 
627
        not be controlled by the user.
 
628
 
 
629
        We may wish to allow locations.conf to control whether branches are
 
630
        trusted in the future.
 
631
        """
 
632
        for source in (self._get_location_config, self._get_global_config):
 
633
            value = getattr(source(), option_name)()
 
634
            if value is not None:
 
635
                return value
 
636
        return None
 
637
 
375
638
    def _get_user_id(self):
376
639
        """Return the full user id for the branch.
377
640
    
379
642
        This is looked up in the email controlfile for the branch.
380
643
        """
381
644
        try:
382
 
            return (self.branch.controlfile("email", "r") 
 
645
            return (self.branch.control_files.get_utf8("email") 
383
646
                    .read()
384
647
                    .decode(bzrlib.user_encoding)
385
648
                    .rstrip("\r\n"))
386
649
        except errors.NoSuchFile, e:
387
650
            pass
388
651
        
389
 
        return self._get_location_config()._get_user_id()
 
652
        return self._get_best_value('_get_user_id')
390
653
 
391
654
    def _get_signature_checking(self):
392
655
        """See Config._get_signature_checking."""
393
 
        return self._get_location_config()._get_signature_checking()
 
656
        return self._get_best_value('_get_signature_checking')
 
657
 
 
658
    def _get_signing_policy(self):
 
659
        """See Config._get_signing_policy."""
 
660
        return self._get_best_value('_get_signing_policy')
394
661
 
395
662
    def _get_user_option(self, option_name):
396
663
        """See Config._get_user_option."""
397
 
        return self._get_location_config()._get_user_option(option_name)
 
664
        for source in self.option_sources:
 
665
            value = source()._get_user_option(option_name)
 
666
            if value is not None:
 
667
                return value
 
668
        return None
 
669
 
 
670
    def set_user_option(self, name, value, store=STORE_BRANCH,
 
671
        warn_masked=False):
 
672
        if store == STORE_BRANCH:
 
673
            self._get_branch_data_config().set_option(value, name)
 
674
        elif store == STORE_GLOBAL:
 
675
            self._get_global_config().set_user_option(name, value)
 
676
        else:
 
677
            self._get_location_config().set_user_option(name, value, store)
 
678
        if not warn_masked:
 
679
            return
 
680
        if store in (STORE_GLOBAL, STORE_BRANCH):
 
681
            mask_value = self._get_location_config().get_user_option(name)
 
682
            if mask_value is not None:
 
683
                trace.warning('Value "%s" is masked by "%s" from'
 
684
                              ' locations.conf', value, mask_value)
 
685
            else:
 
686
                if store == STORE_GLOBAL:
 
687
                    branch_config = self._get_branch_data_config()
 
688
                    mask_value = branch_config.get_user_option(name)
 
689
                    if mask_value is not None:
 
690
                        trace.warning('Value "%s" is masked by "%s" from'
 
691
                                      ' branch.conf', value, mask_value)
 
692
 
398
693
 
399
694
    def _gpg_signing_command(self):
400
695
        """See Config.gpg_signing_command."""
401
 
        return self._get_location_config()._gpg_signing_command()
 
696
        return self._get_safe_value('_gpg_signing_command')
402
697
        
403
698
    def __init__(self, branch):
404
699
        super(BranchConfig, self).__init__()
405
700
        self._location_config = None
 
701
        self._branch_data_config = None
 
702
        self._global_config = None
406
703
        self.branch = branch
 
704
        self.option_sources = (self._get_location_config, 
 
705
                               self._get_branch_data_config,
 
706
                               self._get_global_config)
407
707
 
408
708
    def _post_commit(self):
409
709
        """See Config.post_commit."""
410
 
        return self._get_location_config()._post_commit()
 
710
        return self._get_safe_value('_post_commit')
 
711
 
 
712
    def _get_nickname(self):
 
713
        value = self._get_explicit_nickname()
 
714
        if value is not None:
 
715
            return value
 
716
        return urlutils.unescape(self.branch.base.split('/')[-2])
 
717
 
 
718
    def has_explicit_nickname(self):
 
719
        """Return true if a nickname has been explicitly assigned."""
 
720
        return self._get_explicit_nickname() is not None
 
721
 
 
722
    def _get_explicit_nickname(self):
 
723
        return self._get_best_value('_get_nickname')
 
724
 
 
725
    def _log_format(self):
 
726
        """See Config.log_format."""
 
727
        return self._get_best_value('_log_format')
411
728
 
412
729
 
413
730
def ensure_config_dir_exists(path=None):
422
739
        if sys.platform == 'win32':
423
740
            parent_dir = os.path.dirname(path)
424
741
            if not os.path.isdir(parent_dir):
425
 
                mutter('creating config parent directory: %r', parent_dir)
 
742
                trace.mutter('creating config parent directory: %r', parent_dir)
426
743
            os.mkdir(parent_dir)
427
 
        mutter('creating config directory: %r', path)
 
744
        trace.mutter('creating config directory: %r', path)
428
745
        os.mkdir(path)
429
746
 
430
747
 
438
755
    base = os.environ.get('BZR_HOME', None)
439
756
    if sys.platform == 'win32':
440
757
        if base is None:
441
 
            base = os.environ.get('APPDATA', None)
 
758
            base = win32utils.get_appdata_location_unicode()
442
759
        if base is None:
443
760
            base = os.environ.get('HOME', None)
444
761
        if base is None:
445
 
            raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
446
 
        return pathjoin(base, 'bazaar', '2.0')
 
762
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
 
763
                                  ' or HOME set')
 
764
        return osutils.pathjoin(base, 'bazaar', '2.0')
447
765
    else:
448
766
        # cygwin, linux, and darwin all have a $HOME directory
449
767
        if base is None:
450
768
            base = os.path.expanduser("~")
451
 
        return pathjoin(base, ".bazaar")
 
769
        return osutils.pathjoin(base, ".bazaar")
452
770
 
453
771
 
454
772
def config_filename():
455
773
    """Return per-user configuration ini file filename."""
456
 
    return pathjoin(config_dir(), 'bazaar.conf')
 
774
    return osutils.pathjoin(config_dir(), 'bazaar.conf')
457
775
 
458
776
 
459
777
def branches_config_filename():
460
778
    """Return per-user configuration ini file filename."""
461
 
    return pathjoin(config_dir(), 'branches.conf')
 
779
    return osutils.pathjoin(config_dir(), 'branches.conf')
 
780
 
 
781
 
 
782
def locations_config_filename():
 
783
    """Return per-user configuration ini file filename."""
 
784
    return osutils.pathjoin(config_dir(), 'locations.conf')
 
785
 
 
786
 
 
787
def authentication_config_filename():
 
788
    """Return per-user authentication ini file filename."""
 
789
    return osutils.pathjoin(config_dir(), 'authentication.conf')
 
790
 
 
791
 
 
792
def user_ignore_config_filename():
 
793
    """Return the user default ignore filename"""
 
794
    return osutils.pathjoin(config_dir(), 'ignore')
462
795
 
463
796
 
464
797
def _auto_user_id():
474
807
    """
475
808
    import socket
476
809
 
477
 
    # XXX: Any good way to get real user name on win32?
 
810
    if sys.platform == 'win32':
 
811
        name = win32utils.get_user_name_unicode()
 
812
        if name is None:
 
813
            raise errors.BzrError("Cannot autodetect user name.\n"
 
814
                                  "Please, set your name with command like:\n"
 
815
                                  'bzr whoami "Your Name <name@domain.com>"')
 
816
        host = win32utils.get_host_name_unicode()
 
817
        if host is None:
 
818
            host = socket.gethostname()
 
819
        return name, (name + '@' + host)
478
820
 
479
821
    try:
480
822
        import pwd
481
823
        uid = os.getuid()
482
824
        w = pwd.getpwuid(uid)
483
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
484
 
        username = w.pw_name.decode(bzrlib.user_encoding)
 
825
 
 
826
        # we try utf-8 first, because on many variants (like Linux),
 
827
        # /etc/passwd "should" be in utf-8, and because it's unlikely to give
 
828
        # false positives.  (many users will have their user encoding set to
 
829
        # latin-1, which cannot raise UnicodeError.)
 
830
        try:
 
831
            gecos = w.pw_gecos.decode('utf-8')
 
832
            encoding = 'utf-8'
 
833
        except UnicodeError:
 
834
            try:
 
835
                gecos = w.pw_gecos.decode(bzrlib.user_encoding)
 
836
                encoding = bzrlib.user_encoding
 
837
            except UnicodeError:
 
838
                raise errors.BzrCommandError('Unable to determine your name.  '
 
839
                   'Use "bzr whoami" to set it.')
 
840
        try:
 
841
            username = w.pw_name.decode(encoding)
 
842
        except UnicodeError:
 
843
            raise errors.BzrCommandError('Unable to determine your name.  '
 
844
                'Use "bzr whoami" to set it.')
 
845
 
485
846
        comma = gecos.find(',')
486
847
        if comma == -1:
487
848
            realname = gecos
492
853
 
493
854
    except ImportError:
494
855
        import getpass
495
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
856
        try:
 
857
            realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
858
        except UnicodeDecodeError:
 
859
            raise errors.BzrError("Can't decode username as %s." % \
 
860
                    bzrlib.user_encoding)
496
861
 
497
862
    return realname, (username + '@' + socket.gethostname())
498
863
 
509
874
    """
510
875
    m = re.search(r'[\w+.-]+@[\w+.-]+', e)
511
876
    if not m:
512
 
        raise errors.BzrError("%r doesn't seem to contain "
513
 
                              "a reasonable email address" % e)
 
877
        raise errors.NoEmailInUsername(e)
514
878
    return m.group(0)
515
879
 
516
 
class TreeConfig(object):
 
880
 
 
881
class TreeConfig(IniBasedConfig):
517
882
    """Branch configuration data associated with its contents, not location"""
 
883
 
518
884
    def __init__(self, branch):
519
885
        self.branch = branch
520
886
 
 
887
    def _get_parser(self, file=None):
 
888
        if file is not None:
 
889
            return IniBasedConfig._get_parser(file)
 
890
        return self._get_config()
 
891
 
521
892
    def _get_config(self):
522
893
        try:
523
 
            obj = ConfigObj(self.branch.controlfile('branch.conf',
524
 
                                                    'rb').readlines())
525
 
            obj.decode('UTF-8')
 
894
            obj = ConfigObj(self.branch.control_files.get('branch.conf'),
 
895
                            encoding='utf-8')
526
896
        except errors.NoSuchFile:
527
 
            obj = ConfigObj()
 
897
            obj = ConfigObj(encoding='utf=8')
528
898
        return obj
529
899
 
530
900
    def get_option(self, name, section=None, default=None):
533
903
            obj = self._get_config()
534
904
            try:
535
905
                if section is not None:
536
 
                    obj[section]
 
906
                    obj = obj[section]
537
907
                result = obj[name]
538
908
            except KeyError:
539
909
                result = default
555
925
                    cfg_obj[section] = {}
556
926
                    obj = cfg_obj[section]
557
927
            obj[name] = value
558
 
            cfg_obj.encode('UTF-8')
559
 
            out_file = StringIO(''.join([l+'\n' for l in cfg_obj.write()]))
 
928
            out_file = StringIO()
 
929
            cfg_obj.write(out_file)
560
930
            out_file.seek(0)
561
 
            self.branch.put_controlfile('branch.conf', out_file, encode=False)
 
931
            self.branch.control_files.put('branch.conf', out_file)
562
932
        finally:
563
933
            self.branch.unlock()
 
934
 
 
935
 
 
936
class AuthenticationConfig(object):
 
937
    """The authentication configuration file based on a ini file.
 
938
 
 
939
    Implements the authentication.conf file described in
 
940
    doc/developers/authentication-ring.txt.
 
941
    """
 
942
 
 
943
    def __init__(self, _file=None):
 
944
        self._config = None # The ConfigObj
 
945
        if _file is None:
 
946
            self._filename = authentication_config_filename()
 
947
            self._input = self._filename = authentication_config_filename()
 
948
        else:
 
949
            # Tests can provide a string as _file
 
950
            self._filename = None
 
951
            self._input = _file
 
952
 
 
953
    def _get_config(self):
 
954
        if self._config is not None:
 
955
            return self._config
 
956
        try:
 
957
            # FIXME: Should we validate something here ? Includes: empty
 
958
            # sections are useless, at least one of
 
959
            # user/password/password_encoding should be defined, etc.
 
960
 
 
961
            # Note: the encoding below declares that the file itself is utf-8
 
962
            # encoded, but the values in the ConfigObj are always Unicode.
 
963
            self._config = ConfigObj(self._input, encoding='utf-8')
 
964
        except configobj.ConfigObjError, e:
 
965
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
966
        return self._config
 
967
 
 
968
    def _save(self):
 
969
        """Save the config file, only tests should use it for now."""
 
970
        conf_dir = os.path.dirname(self._filename)
 
971
        ensure_config_dir_exists(conf_dir)
 
972
        self._get_config().write(file(self._filename, 'wb'))
 
973
 
 
974
    def _set_option(self, section_name, option_name, value):
 
975
        """Set an authentication configuration option"""
 
976
        conf = self._get_config()
 
977
        section = conf.get(section_name)
 
978
        if section is None:
 
979
            conf[section] = {}
 
980
            section = conf[section]
 
981
        section[option_name] = value
 
982
        self._save()
 
983
 
 
984
    def get_credentials(self, scheme, host, port=None, user=None, path=None):
 
985
        """Returns the matching credentials from authentication.conf file.
 
986
 
 
987
        :param scheme: protocol
 
988
 
 
989
        :param host: the server address
 
990
 
 
991
        :param port: the associated port (optional)
 
992
 
 
993
        :param user: login (optional)
 
994
 
 
995
        :param path: the absolute path on the server (optional)
 
996
 
 
997
        :return: A dict containing the matching credentials or None.
 
998
           This includes:
 
999
           - name: the section name of the credentials in the
 
1000
             authentication.conf file,
 
1001
           - user: can't de different from the provided user if any,
 
1002
           - password: the decoded password, could be None if the credential
 
1003
             defines only the user
 
1004
           - verify_certificates: https specific, True if the server
 
1005
             certificate should be verified, False otherwise.
 
1006
        """
 
1007
        credentials = None
 
1008
        for auth_def_name, auth_def in self._get_config().items():
 
1009
            a_scheme, a_host, a_user, a_path = map(
 
1010
                auth_def.get, ['scheme', 'host', 'user', 'path'])
 
1011
 
 
1012
            try:
 
1013
                a_port = auth_def.as_int('port')
 
1014
            except KeyError:
 
1015
                a_port = None
 
1016
            except ValueError:
 
1017
                raise ValueError("'port' not numeric in %s" % auth_def_name)
 
1018
            try:
 
1019
                a_verify_certificates = auth_def.as_bool('verify_certificates')
 
1020
            except KeyError:
 
1021
                a_verify_certificates = True
 
1022
            except ValueError:
 
1023
                raise ValueError(
 
1024
                    "'verify_certificates' not boolean in %s" % auth_def_name)
 
1025
 
 
1026
            # Attempt matching
 
1027
            if a_scheme is not None and scheme != a_scheme:
 
1028
                continue
 
1029
            if a_host is not None:
 
1030
                if not (host == a_host
 
1031
                        or (a_host.startswith('.') and host.endswith(a_host))):
 
1032
                    continue
 
1033
            if a_port is not None and port != a_port:
 
1034
                continue
 
1035
            if (a_path is not None and path is not None
 
1036
                and not path.startswith(a_path)):
 
1037
                continue
 
1038
            if (a_user is not None and user is not None
 
1039
                and a_user != user):
 
1040
                # Never contradict the caller about the user to be used
 
1041
                continue
 
1042
            if a_user is None:
 
1043
                # Can't find a user
 
1044
                continue
 
1045
            credentials = dict(name=auth_def_name,
 
1046
                               user=a_user, password=auth_def['password'],
 
1047
                               verify_certificates=a_verify_certificates)
 
1048
            self.decode_password(credentials,
 
1049
                                 auth_def.get('password_encoding', None))
 
1050
            if 'auth' in debug.debug_flags:
 
1051
                trace.mutter("Using authentication section: %r", auth_def_name)
 
1052
            break
 
1053
 
 
1054
        return credentials
 
1055
 
 
1056
    def get_user(self, scheme, host, port=None,
 
1057
                 realm=None, path=None, prompt=None):
 
1058
        """Get a user from authentication file.
 
1059
 
 
1060
        :param scheme: protocol
 
1061
 
 
1062
        :param host: the server address
 
1063
 
 
1064
        :param port: the associated port (optional)
 
1065
 
 
1066
        :param realm: the realm sent by the server (optional)
 
1067
 
 
1068
        :param path: the absolute path on the server (optional)
 
1069
 
 
1070
        :return: The found user.
 
1071
        """
 
1072
        credentials = self.get_credentials(scheme, host, port, user=None,
 
1073
                                           path=path)
 
1074
        if credentials is not None:
 
1075
            user = credentials['user']
 
1076
        else:
 
1077
            user = None
 
1078
        return user
 
1079
 
 
1080
    def get_password(self, scheme, host, user, port=None,
 
1081
                     realm=None, path=None, prompt=None):
 
1082
        """Get a password from authentication file or prompt the user for one.
 
1083
 
 
1084
        :param scheme: protocol
 
1085
 
 
1086
        :param host: the server address
 
1087
 
 
1088
        :param port: the associated port (optional)
 
1089
 
 
1090
        :param user: login
 
1091
 
 
1092
        :param realm: the realm sent by the server (optional)
 
1093
 
 
1094
        :param path: the absolute path on the server (optional)
 
1095
 
 
1096
        :return: The found password or the one entered by the user.
 
1097
        """
 
1098
        credentials = self.get_credentials(scheme, host, port, user, path)
 
1099
        if credentials is not None:
 
1100
            password = credentials['password']
 
1101
        else:
 
1102
            password = None
 
1103
        # Prompt user only if we could't find a password
 
1104
        if password is None:
 
1105
            if prompt is None:
 
1106
                # Create a default prompt suitable for most of the cases
 
1107
                prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
 
1108
            # Special handling for optional fields in the prompt
 
1109
            if port is not None:
 
1110
                prompt_host = '%s:%d' % (host, port)
 
1111
            else:
 
1112
                prompt_host = host
 
1113
            password = ui.ui_factory.get_password(prompt,
 
1114
                                                  host=prompt_host, user=user)
 
1115
        return password
 
1116
 
 
1117
    def decode_password(self, credentials, encoding):
 
1118
        return credentials