1
# Copyright (C) 2005, 2007, 2008 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
"""Configuration that affects the behaviour of Bazaar.
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
22
and ~/.bazaar/locations.conf, which is written to by bzr.
24
In bazaar.conf the following options may be set:
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
30
gpg_signing_command=name-of-program
31
log_format=name-of-format
33
in locations.conf, you specify the url of a branch and options for it.
34
Wildcards may be used - * and ? as normal in shell completion. Options
35
set in both bazaar.conf and locations.conf are overridden by the locations.conf
37
[/home/robertc/source]
38
recurse=False|True(default)
40
check_signatures= as above
41
create_signatures= as above.
43
explanation of options
44
----------------------
45
editor - this option sets the pop up editor to use during commits.
46
email - this option sets the user id bzr will use when committing.
47
check_signatures - this option controls whether bzr will require good gpg
48
signatures, ignore them, or check them if they are
50
create_signatures - this option controls whether bzr will always create
51
gpg signatures, never create them, or create them if the
52
branch is configured to require them.
53
log_format - this option sets the default log format. Possible values are
54
long, short, line, or a plugin can register new formats.
56
In bazaar.conf you can also define aliases in the ALIASES sections, example
59
lastlog=log --line -r-10..-1
60
ll=log --line -r-10..-1
68
from bzrlib.lazy_import import lazy_import
69
lazy_import(globals(), """
71
from fnmatch import fnmatch
73
from cStringIO import StringIO
88
from bzrlib.util.configobj import configobj
104
POLICY_APPENDPATH = 2
108
POLICY_NORECURSE: 'norecurse',
109
POLICY_APPENDPATH: 'appendpath',
114
'norecurse': POLICY_NORECURSE,
115
'appendpath': POLICY_APPENDPATH,
119
STORE_LOCATION = POLICY_NONE
120
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
121
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
126
def ConfigObj(*args, **kwargs):
128
if _ConfigObj is None:
129
class ConfigObj(configobj.ConfigObj):
131
def get_bool(self, section, key):
132
return self[section].as_bool(key)
134
def get_value(self, section, name):
135
# Try [] for the old DEFAULT section.
136
if section == "DEFAULT":
141
return self[section][name]
142
_ConfigObj = ConfigObj
143
return _ConfigObj(*args, **kwargs)
146
class Config(object):
147
"""A configuration policy - what username, editor, gpg needs etc."""
149
def get_editor(self):
150
"""Get the users pop up editor."""
151
raise NotImplementedError
153
def get_mail_client(self):
154
"""Get a mail client to use"""
155
selected_client = self.get_user_option('mail_client')
156
_registry = mail_client.mail_client_registry
158
mail_client_class = _registry.get(selected_client)
160
raise errors.UnknownMailClient(selected_client)
161
return mail_client_class(self)
163
def _get_signature_checking(self):
164
"""Template method to override signature checking policy."""
166
def _get_signing_policy(self):
167
"""Template method to override signature creation policy."""
169
def _get_user_option(self, option_name):
170
"""Template method to provide a user option."""
173
def get_user_option(self, option_name):
174
"""Get a generic option - no special process, no default."""
175
return self._get_user_option(option_name)
177
def gpg_signing_command(self):
178
"""What program should be used to sign signatures?"""
179
result = self._gpg_signing_command()
184
def _gpg_signing_command(self):
185
"""See gpg_signing_command()."""
188
def log_format(self):
189
"""What log format should be used"""
190
result = self._log_format()
195
def _log_format(self):
196
"""See log_format()."""
200
super(Config, self).__init__()
202
def post_commit(self):
203
"""An ordered list of python functions to call.
205
Each function takes branch, rev_id as parameters.
207
return self._post_commit()
209
def _post_commit(self):
210
"""See Config.post_commit."""
213
def user_email(self):
214
"""Return just the email component of a username."""
215
return extract_email_address(self.username())
218
"""Return email-style username.
220
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
222
$BZR_EMAIL can be set to override this (as well as the
223
deprecated $BZREMAIL), then
224
the concrete policy type is checked, and finally
226
If none is found, a reasonable default is (hopefully)
229
TODO: Check it's reasonably well-formed.
231
v = os.environ.get('BZR_EMAIL')
233
return v.decode(osutils.get_user_encoding())
235
v = self._get_user_id()
239
v = os.environ.get('EMAIL')
241
return v.decode(osutils.get_user_encoding())
243
name, email = _auto_user_id()
245
return '%s <%s>' % (name, email)
249
def signature_checking(self):
250
"""What is the current policy for signature checking?."""
251
policy = self._get_signature_checking()
252
if policy is not None:
254
return CHECK_IF_POSSIBLE
256
def signing_policy(self):
257
"""What is the current policy for signature checking?."""
258
policy = self._get_signing_policy()
259
if policy is not None:
261
return SIGN_WHEN_REQUIRED
263
def signature_needed(self):
264
"""Is a signature needed when committing ?."""
265
policy = self._get_signing_policy()
267
policy = self._get_signature_checking()
268
if policy is not None:
269
trace.warning("Please use create_signatures,"
270
" not check_signatures to set signing policy.")
271
if policy == CHECK_ALWAYS:
273
elif policy == SIGN_ALWAYS:
277
def get_alias(self, value):
278
return self._get_alias(value)
280
def _get_alias(self, value):
283
def get_nickname(self):
284
return self._get_nickname()
286
def _get_nickname(self):
289
def get_bzr_remote_path(self):
291
return os.environ['BZR_REMOTE_PATH']
293
path = self.get_user_option("bzr_remote_path")
299
class IniBasedConfig(Config):
300
"""A configuration policy that draws from ini files."""
302
def _get_parser(self, file=None):
303
if self._parser is not None:
306
input = self._get_filename()
310
self._parser = ConfigObj(input, encoding='utf-8')
311
except configobj.ConfigObjError, e:
312
raise errors.ParseConfigError(e.errors, e.config.filename)
315
def _get_matching_sections(self):
316
"""Return an ordered list of (section_name, extra_path) pairs.
318
If the section contains inherited configuration, extra_path is
319
a string containing the additional path components.
321
section = self._get_section()
322
if section is not None:
323
return [(section, '')]
327
def _get_section(self):
328
"""Override this to define the section used by the config."""
331
def _get_option_policy(self, section, option_name):
332
"""Return the policy for the given (section, option_name) pair."""
335
def _get_signature_checking(self):
336
"""See Config._get_signature_checking."""
337
policy = self._get_user_option('check_signatures')
339
return self._string_to_signature_policy(policy)
341
def _get_signing_policy(self):
342
"""See Config._get_signing_policy"""
343
policy = self._get_user_option('create_signatures')
345
return self._string_to_signing_policy(policy)
347
def _get_user_id(self):
348
"""Get the user id from the 'email' key in the current section."""
349
return self._get_user_option('email')
351
def _get_user_option(self, option_name):
352
"""See Config._get_user_option."""
353
for (section, extra_path) in self._get_matching_sections():
355
value = self._get_parser().get_value(section, option_name)
358
policy = self._get_option_policy(section, option_name)
359
if policy == POLICY_NONE:
361
elif policy == POLICY_NORECURSE:
362
# norecurse items only apply to the exact path
367
elif policy == POLICY_APPENDPATH:
369
value = urlutils.join(value, extra_path)
372
raise AssertionError('Unexpected config policy %r' % policy)
376
def _gpg_signing_command(self):
377
"""See Config.gpg_signing_command."""
378
return self._get_user_option('gpg_signing_command')
380
def _log_format(self):
381
"""See Config.log_format."""
382
return self._get_user_option('log_format')
384
def __init__(self, get_filename):
385
super(IniBasedConfig, self).__init__()
386
self._get_filename = get_filename
389
def _post_commit(self):
390
"""See Config.post_commit."""
391
return self._get_user_option('post_commit')
393
def _string_to_signature_policy(self, signature_string):
394
"""Convert a string to a signing policy."""
395
if signature_string.lower() == 'check-available':
396
return CHECK_IF_POSSIBLE
397
if signature_string.lower() == 'ignore':
399
if signature_string.lower() == 'require':
401
raise errors.BzrError("Invalid signatures policy '%s'"
404
def _string_to_signing_policy(self, signature_string):
405
"""Convert a string to a signing policy."""
406
if signature_string.lower() == 'when-required':
407
return SIGN_WHEN_REQUIRED
408
if signature_string.lower() == 'never':
410
if signature_string.lower() == 'always':
412
raise errors.BzrError("Invalid signing policy '%s'"
415
def _get_alias(self, value):
417
return self._get_parser().get_value("ALIASES",
422
def _get_nickname(self):
423
return self.get_user_option('nickname')
426
class GlobalConfig(IniBasedConfig):
427
"""The configuration that should be used for a specific location."""
429
def get_editor(self):
430
return self._get_user_option('editor')
433
super(GlobalConfig, self).__init__(config_filename)
435
def set_user_option(self, option, value):
436
"""Save option and its value in the configuration."""
437
self._set_option(option, value, 'DEFAULT')
439
def get_aliases(self):
440
"""Return the aliases section."""
441
if 'ALIASES' in self._get_parser():
442
return self._get_parser()['ALIASES']
446
def set_alias(self, alias_name, alias_command):
447
"""Save the alias in the configuration."""
448
self._set_option(alias_name, alias_command, 'ALIASES')
450
def unset_alias(self, alias_name):
451
"""Unset an existing alias."""
452
aliases = self._get_parser().get('ALIASES')
453
if not aliases or alias_name not in aliases:
454
raise errors.NoSuchAlias(alias_name)
455
del aliases[alias_name]
456
self._write_config_file()
458
def _set_option(self, option, value, section):
459
# FIXME: RBC 20051029 This should refresh the parser and also take a
460
# file lock on bazaar.conf.
461
conf_dir = os.path.dirname(self._get_filename())
462
ensure_config_dir_exists(conf_dir)
463
self._get_parser().setdefault(section, {})[option] = value
464
self._write_config_file()
466
def _write_config_file(self):
467
f = open(self._get_filename(), 'wb')
468
self._get_parser().write(f)
472
class LocationConfig(IniBasedConfig):
473
"""A configuration object that gives the policy for a location."""
475
def __init__(self, location):
476
name_generator = locations_config_filename
477
if (not os.path.exists(name_generator()) and
478
os.path.exists(branches_config_filename())):
479
if sys.platform == 'win32':
480
trace.warning('Please rename %s to %s'
481
% (branches_config_filename(),
482
locations_config_filename()))
484
trace.warning('Please rename ~/.bazaar/branches.conf'
485
' to ~/.bazaar/locations.conf')
486
name_generator = branches_config_filename
487
super(LocationConfig, self).__init__(name_generator)
488
# local file locations are looked up by local path, rather than
489
# by file url. This is because the config file is a user
490
# file, and we would rather not expose the user to file urls.
491
if location.startswith('file://'):
492
location = urlutils.local_path_from_url(location)
493
self.location = location
495
def _get_matching_sections(self):
496
"""Return an ordered list of section names matching this location."""
497
sections = self._get_parser()
498
location_names = self.location.split('/')
499
if self.location.endswith('/'):
500
del location_names[-1]
502
for section in sections:
503
# location is a local path if possible, so we need
504
# to convert 'file://' urls to local paths if necessary.
505
# This also avoids having file:///path be a more exact
506
# match than '/path'.
507
if section.startswith('file://'):
508
section_path = urlutils.local_path_from_url(section)
510
section_path = section
511
section_names = section_path.split('/')
512
if section.endswith('/'):
513
del section_names[-1]
514
names = zip(location_names, section_names)
517
if not fnmatch(name[0], name[1]):
522
# so, for the common prefix they matched.
523
# if section is longer, no match.
524
if len(section_names) > len(location_names):
526
matches.append((len(section_names), section,
527
'/'.join(location_names[len(section_names):])))
528
matches.sort(reverse=True)
530
for (length, section, extra_path) in matches:
531
sections.append((section, extra_path))
532
# should we stop looking for parent configs here?
534
if self._get_parser()[section].as_bool('ignore_parents'):
540
def _get_option_policy(self, section, option_name):
541
"""Return the policy for the given (section, option_name) pair."""
542
# check for the old 'recurse=False' flag
544
recurse = self._get_parser()[section].as_bool('recurse')
548
return POLICY_NORECURSE
550
policy_key = option_name + ':policy'
552
policy_name = self._get_parser()[section][policy_key]
556
return _policy_value[policy_name]
558
def _set_option_policy(self, section, option_name, option_policy):
559
"""Set the policy for the given option name in the given section."""
560
# The old recurse=False option affects all options in the
561
# section. To handle multiple policies in the section, we
562
# need to convert it to a policy_norecurse key.
564
recurse = self._get_parser()[section].as_bool('recurse')
568
symbol_versioning.warn(
569
'The recurse option is deprecated as of 0.14. '
570
'The section "%s" has been converted to use policies.'
573
del self._get_parser()[section]['recurse']
575
for key in self._get_parser()[section].keys():
576
if not key.endswith(':policy'):
577
self._get_parser()[section][key +
578
':policy'] = 'norecurse'
580
policy_key = option_name + ':policy'
581
policy_name = _policy_name[option_policy]
582
if policy_name is not None:
583
self._get_parser()[section][policy_key] = policy_name
585
if policy_key in self._get_parser()[section]:
586
del self._get_parser()[section][policy_key]
588
def set_user_option(self, option, value, store=STORE_LOCATION):
589
"""Save option and its value in the configuration."""
590
if store not in [STORE_LOCATION,
591
STORE_LOCATION_NORECURSE,
592
STORE_LOCATION_APPENDPATH]:
593
raise ValueError('bad storage policy %r for %r' %
595
# FIXME: RBC 20051029 This should refresh the parser and also take a
596
# file lock on locations.conf.
597
conf_dir = os.path.dirname(self._get_filename())
598
ensure_config_dir_exists(conf_dir)
599
location = self.location
600
if location.endswith('/'):
601
location = location[:-1]
602
if (not location in self._get_parser() and
603
not location + '/' in self._get_parser()):
604
self._get_parser()[location]={}
605
elif location + '/' in self._get_parser():
606
location = location + '/'
607
self._get_parser()[location][option]=value
608
# the allowed values of store match the config policies
609
self._set_option_policy(location, option, store)
610
self._get_parser().write(file(self._get_filename(), 'wb'))
613
class BranchConfig(Config):
614
"""A configuration object giving the policy for a branch."""
616
def _get_branch_data_config(self):
617
if self._branch_data_config is None:
618
self._branch_data_config = TreeConfig(self.branch)
619
return self._branch_data_config
621
def _get_location_config(self):
622
if self._location_config is None:
623
self._location_config = LocationConfig(self.branch.base)
624
return self._location_config
626
def _get_global_config(self):
627
if self._global_config is None:
628
self._global_config = GlobalConfig()
629
return self._global_config
631
def _get_best_value(self, option_name):
632
"""This returns a user option from local, tree or global config.
634
They are tried in that order. Use get_safe_value if trusted values
637
for source in self.option_sources:
638
value = getattr(source(), option_name)()
639
if value is not None:
643
def _get_safe_value(self, option_name):
644
"""This variant of get_best_value never returns untrusted values.
646
It does not return values from the branch data, because the branch may
647
not be controlled by the user.
649
We may wish to allow locations.conf to control whether branches are
650
trusted in the future.
652
for source in (self._get_location_config, self._get_global_config):
653
value = getattr(source(), option_name)()
654
if value is not None:
658
def _get_user_id(self):
659
"""Return the full user id for the branch.
661
e.g. "John Hacker <jhacker@example.com>"
662
This is looked up in the email controlfile for the branch.
665
return (self.branch._transport.get_bytes("email")
666
.decode(osutils.get_user_encoding())
668
except errors.NoSuchFile, e:
671
return self._get_best_value('_get_user_id')
673
def _get_signature_checking(self):
674
"""See Config._get_signature_checking."""
675
return self._get_best_value('_get_signature_checking')
677
def _get_signing_policy(self):
678
"""See Config._get_signing_policy."""
679
return self._get_best_value('_get_signing_policy')
681
def _get_user_option(self, option_name):
682
"""See Config._get_user_option."""
683
for source in self.option_sources:
684
value = source()._get_user_option(option_name)
685
if value is not None:
689
def set_user_option(self, name, value, store=STORE_BRANCH,
691
if store == STORE_BRANCH:
692
self._get_branch_data_config().set_option(value, name)
693
elif store == STORE_GLOBAL:
694
self._get_global_config().set_user_option(name, value)
696
self._get_location_config().set_user_option(name, value, store)
699
if store in (STORE_GLOBAL, STORE_BRANCH):
700
mask_value = self._get_location_config().get_user_option(name)
701
if mask_value is not None:
702
trace.warning('Value "%s" is masked by "%s" from'
703
' locations.conf', value, mask_value)
705
if store == STORE_GLOBAL:
706
branch_config = self._get_branch_data_config()
707
mask_value = branch_config.get_user_option(name)
708
if mask_value is not None:
709
trace.warning('Value "%s" is masked by "%s" from'
710
' branch.conf', value, mask_value)
712
def _gpg_signing_command(self):
713
"""See Config.gpg_signing_command."""
714
return self._get_safe_value('_gpg_signing_command')
716
def __init__(self, branch):
717
super(BranchConfig, self).__init__()
718
self._location_config = None
719
self._branch_data_config = None
720
self._global_config = None
722
self.option_sources = (self._get_location_config,
723
self._get_branch_data_config,
724
self._get_global_config)
726
def _post_commit(self):
727
"""See Config.post_commit."""
728
return self._get_safe_value('_post_commit')
730
def _get_nickname(self):
731
value = self._get_explicit_nickname()
732
if value is not None:
734
return urlutils.unescape(self.branch.base.split('/')[-2])
736
def has_explicit_nickname(self):
737
"""Return true if a nickname has been explicitly assigned."""
738
return self._get_explicit_nickname() is not None
740
def _get_explicit_nickname(self):
741
return self._get_best_value('_get_nickname')
743
def _log_format(self):
744
"""See Config.log_format."""
745
return self._get_best_value('_log_format')
748
def ensure_config_dir_exists(path=None):
749
"""Make sure a configuration directory exists.
750
This makes sure that the directory exists.
751
On windows, since configuration directories are 2 levels deep,
752
it makes sure both the directory and the parent directory exists.
756
if not os.path.isdir(path):
757
if sys.platform == 'win32':
758
parent_dir = os.path.dirname(path)
759
if not os.path.isdir(parent_dir):
760
trace.mutter('creating config parent directory: %r', parent_dir)
762
trace.mutter('creating config directory: %r', path)
767
"""Return per-user configuration directory.
769
By default this is ~/.bazaar/
771
TODO: Global option --config-dir to override this.
773
base = os.environ.get('BZR_HOME', None)
774
if sys.platform == 'win32':
776
base = win32utils.get_appdata_location_unicode()
778
base = os.environ.get('HOME', None)
780
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
782
return osutils.pathjoin(base, 'bazaar', '2.0')
784
# cygwin, linux, and darwin all have a $HOME directory
786
base = os.path.expanduser("~")
787
return osutils.pathjoin(base, ".bazaar")
790
def config_filename():
791
"""Return per-user configuration ini file filename."""
792
return osutils.pathjoin(config_dir(), 'bazaar.conf')
795
def branches_config_filename():
796
"""Return per-user configuration ini file filename."""
797
return osutils.pathjoin(config_dir(), 'branches.conf')
800
def locations_config_filename():
801
"""Return per-user configuration ini file filename."""
802
return osutils.pathjoin(config_dir(), 'locations.conf')
805
def authentication_config_filename():
806
"""Return per-user authentication ini file filename."""
807
return osutils.pathjoin(config_dir(), 'authentication.conf')
810
def user_ignore_config_filename():
811
"""Return the user default ignore filename"""
812
return osutils.pathjoin(config_dir(), 'ignore')
816
"""Calculate automatic user identification.
818
Returns (realname, email).
820
Only used when none is set in the environment or the id file.
822
This previously used the FQDN as the default domain, but that can
823
be very slow on machines where DNS is broken. So now we simply
828
if sys.platform == 'win32':
829
name = win32utils.get_user_name_unicode()
831
raise errors.BzrError("Cannot autodetect user name.\n"
832
"Please, set your name with command like:\n"
833
'bzr whoami "Your Name <name@domain.com>"')
834
host = win32utils.get_host_name_unicode()
836
host = socket.gethostname()
837
return name, (name + '@' + host)
843
w = pwd.getpwuid(uid)
845
raise errors.BzrCommandError('Unable to determine your name. '
846
'Please use "bzr whoami" to set it.')
848
# we try utf-8 first, because on many variants (like Linux),
849
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
850
# false positives. (many users will have their user encoding set to
851
# latin-1, which cannot raise UnicodeError.)
853
gecos = w.pw_gecos.decode('utf-8')
857
encoding = osutils.get_user_encoding()
858
gecos = w.pw_gecos.decode(encoding)
860
raise errors.BzrCommandError('Unable to determine your name. '
861
'Use "bzr whoami" to set it.')
863
username = w.pw_name.decode(encoding)
865
raise errors.BzrCommandError('Unable to determine your name. '
866
'Use "bzr whoami" to set it.')
868
comma = gecos.find(',')
872
realname = gecos[:comma]
879
user_encoding = osutils.get_user_encoding()
880
realname = username = getpass.getuser().decode(user_encoding)
881
except UnicodeDecodeError:
882
raise errors.BzrError("Can't decode username as %s." % \
885
return realname, (username + '@' + socket.gethostname())
888
def parse_username(username):
889
"""Parse e-mail username and return a (name, address) tuple."""
890
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
892
return (username, '')
894
return (match.group(1), match.group(2))
897
def extract_email_address(e):
898
"""Return just the address part of an email string.
900
That is just the user@domain part, nothing else.
901
This part is required to contain only ascii characters.
902
If it can't be extracted, raises an error.
904
>>> extract_email_address('Jane Tester <jane@test.com>')
907
name, email = parse_username(e)
909
raise errors.NoEmailInUsername(e)
913
class TreeConfig(IniBasedConfig):
914
"""Branch configuration data associated with its contents, not location"""
916
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
918
def __init__(self, branch):
919
self._config = branch._get_config()
922
def _get_parser(self, file=None):
924
return IniBasedConfig._get_parser(file)
925
return self._config._get_configobj()
927
def get_option(self, name, section=None, default=None):
928
self.branch.lock_read()
930
return self._config.get_option(name, section, default)
935
def set_option(self, value, name, section=None):
936
"""Set a per-branch configuration option"""
937
self.branch.lock_write()
939
self._config.set_option(value, name, section)
944
class AuthenticationConfig(object):
945
"""The authentication configuration file based on a ini file.
947
Implements the authentication.conf file described in
948
doc/developers/authentication-ring.txt.
951
def __init__(self, _file=None):
952
self._config = None # The ConfigObj
954
self._filename = authentication_config_filename()
955
self._input = self._filename = authentication_config_filename()
957
# Tests can provide a string as _file
958
self._filename = None
961
def _get_config(self):
962
if self._config is not None:
965
# FIXME: Should we validate something here ? Includes: empty
966
# sections are useless, at least one of
967
# user/password/password_encoding should be defined, etc.
969
# Note: the encoding below declares that the file itself is utf-8
970
# encoded, but the values in the ConfigObj are always Unicode.
971
self._config = ConfigObj(self._input, encoding='utf-8')
972
except configobj.ConfigObjError, e:
973
raise errors.ParseConfigError(e.errors, e.config.filename)
977
"""Save the config file, only tests should use it for now."""
978
conf_dir = os.path.dirname(self._filename)
979
ensure_config_dir_exists(conf_dir)
980
self._get_config().write(file(self._filename, 'wb'))
982
def _set_option(self, section_name, option_name, value):
983
"""Set an authentication configuration option"""
984
conf = self._get_config()
985
section = conf.get(section_name)
988
section = conf[section]
989
section[option_name] = value
992
def get_credentials(self, scheme, host, port=None, user=None, path=None,
994
"""Returns the matching credentials from authentication.conf file.
996
:param scheme: protocol
998
:param host: the server address
1000
:param port: the associated port (optional)
1002
:param user: login (optional)
1004
:param path: the absolute path on the server (optional)
1006
:param realm: the http authentication realm (optional)
1008
:return: A dict containing the matching credentials or None.
1010
- name: the section name of the credentials in the
1011
authentication.conf file,
1012
- user: can't be different from the provided user if any,
1013
- scheme: the server protocol,
1014
- host: the server address,
1015
- port: the server port (can be None),
1016
- path: the absolute server path (can be None),
1017
- realm: the http specific authentication realm (can be None),
1018
- password: the decoded password, could be None if the credential
1019
defines only the user
1020
- verify_certificates: https specific, True if the server
1021
certificate should be verified, False otherwise.
1024
for auth_def_name, auth_def in self._get_config().items():
1025
if type(auth_def) is not configobj.Section:
1026
raise ValueError("%s defined outside a section" % auth_def_name)
1028
a_scheme, a_host, a_user, a_path = map(
1029
auth_def.get, ['scheme', 'host', 'user', 'path'])
1032
a_port = auth_def.as_int('port')
1036
raise ValueError("'port' not numeric in %s" % auth_def_name)
1038
a_verify_certificates = auth_def.as_bool('verify_certificates')
1040
a_verify_certificates = True
1043
"'verify_certificates' not boolean in %s" % auth_def_name)
1046
if a_scheme is not None and scheme != a_scheme:
1048
if a_host is not None:
1049
if not (host == a_host
1050
or (a_host.startswith('.') and host.endswith(a_host))):
1052
if a_port is not None and port != a_port:
1054
if (a_path is not None and path is not None
1055
and not path.startswith(a_path)):
1057
if (a_user is not None and user is not None
1058
and a_user != user):
1059
# Never contradict the caller about the user to be used
1064
# Prepare a credentials dictionary with additional keys
1065
# for the credential providers
1066
credentials = dict(name=auth_def_name,
1073
password=auth_def.get('password', None),
1074
verify_certificates=a_verify_certificates)
1075
# Decode the password in the credentials (or get one)
1076
self.decode_password(credentials,
1077
auth_def.get('password_encoding', None))
1078
if 'auth' in debug.debug_flags:
1079
trace.mutter("Using authentication section: %r", auth_def_name)
1082
if credentials is None:
1083
# No credentials were found in authentication.conf, try the fallback
1084
# credentials stores.
1085
credentials = credential_store_registry.get_fallback_credentials(
1086
scheme, host, port, user, path, realm)
1090
def set_credentials(self, name, host, user, scheme=None, password=None,
1091
port=None, path=None, verify_certificates=None,
1093
"""Set authentication credentials for a host.
1095
Any existing credentials with matching scheme, host, port and path
1096
will be deleted, regardless of name.
1098
:param name: An arbitrary name to describe this set of credentials.
1099
:param host: Name of the host that accepts these credentials.
1100
:param user: The username portion of these credentials.
1101
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1103
:param password: Password portion of these credentials.
1104
:param port: The IP port on the host that these credentials apply to.
1105
:param path: A filesystem path on the host that these credentials
1107
:param verify_certificates: On https, verify server certificates if
1109
:param realm: The http authentication realm (optional).
1111
values = {'host': host, 'user': user}
1112
if password is not None:
1113
values['password'] = password
1114
if scheme is not None:
1115
values['scheme'] = scheme
1116
if port is not None:
1117
values['port'] = '%d' % port
1118
if path is not None:
1119
values['path'] = path
1120
if verify_certificates is not None:
1121
values['verify_certificates'] = str(verify_certificates)
1122
if realm is not None:
1123
values['realm'] = realm
1124
config = self._get_config()
1126
for section, existing_values in config.items():
1127
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1128
if existing_values.get(key) != values.get(key):
1132
config.update({name: values})
1135
def get_user(self, scheme, host, port=None, realm=None, path=None,
1136
prompt=None, ask=False, default=None):
1137
"""Get a user from authentication file.
1139
:param scheme: protocol
1141
:param host: the server address
1143
:param port: the associated port (optional)
1145
:param realm: the realm sent by the server (optional)
1147
:param path: the absolute path on the server (optional)
1149
:param ask: Ask the user if there is no explicitly configured username
1152
:param default: The username returned if none is defined (optional).
1154
:return: The found user.
1156
credentials = self.get_credentials(scheme, host, port, user=None,
1157
path=path, realm=realm)
1158
if credentials is not None:
1159
user = credentials['user']
1165
# Create a default prompt suitable for most cases
1166
prompt = scheme.upper() + ' %(host)s username'
1167
# Special handling for optional fields in the prompt
1168
if port is not None:
1169
prompt_host = '%s:%d' % (host, port)
1172
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1177
def get_password(self, scheme, host, user, port=None,
1178
realm=None, path=None, prompt=None):
1179
"""Get a password from authentication file or prompt the user for one.
1181
:param scheme: protocol
1183
:param host: the server address
1185
:param port: the associated port (optional)
1189
:param realm: the realm sent by the server (optional)
1191
:param path: the absolute path on the server (optional)
1193
:return: The found password or the one entered by the user.
1195
credentials = self.get_credentials(scheme, host, port, user, path,
1197
if credentials is not None:
1198
password = credentials['password']
1199
if password is not None and scheme is 'ssh':
1200
trace.warning('password ignored in section [%s],'
1201
' use an ssh agent instead'
1202
% credentials['name'])
1206
# Prompt user only if we could't find a password
1207
if password is None:
1209
# Create a default prompt suitable for most cases
1210
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1211
# Special handling for optional fields in the prompt
1212
if port is not None:
1213
prompt_host = '%s:%d' % (host, port)
1216
password = ui.ui_factory.get_password(prompt,
1217
host=prompt_host, user=user)
1220
def decode_password(self, credentials, encoding):
1222
cs = credential_store_registry.get_credential_store(encoding)
1224
raise ValueError('%r is not a known password_encoding' % encoding)
1225
credentials['password'] = cs.decode_password(credentials)
1229
class CredentialStoreRegistry(registry.Registry):
1230
"""A class that registers credential stores.
1232
A credential store provides access to credentials via the password_encoding
1233
field in authentication.conf sections.
1235
Except for stores provided by bzr itself, most stores are expected to be
1236
provided by plugins that will therefore use
1237
register_lazy(password_encoding, module_name, member_name, help=help,
1238
fallback=fallback) to install themselves.
1240
A fallback credential store is one that is queried if no credentials can be
1241
found via authentication.conf.
1244
def get_credential_store(self, encoding=None):
1245
cs = self.get(encoding)
1250
def is_fallback(self, name):
1251
"""Check if the named credentials store should be used as fallback."""
1252
return self.get_info(name)
1254
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1255
path=None, realm=None):
1256
"""Request credentials from all fallback credentials stores.
1258
The first credentials store that can provide credentials wins.
1261
for name in self.keys():
1262
if not self.is_fallback(name):
1264
cs = self.get_credential_store(name)
1265
credentials = cs.get_credentials(scheme, host, port, user,
1267
if credentials is not None:
1268
# We found some credentials
1272
def register(self, key, obj, help=None, override_existing=False,
1274
"""Register a new object to a name.
1276
:param key: This is the key to use to request the object later.
1277
:param obj: The object to register.
1278
:param help: Help text for this entry. This may be a string or
1279
a callable. If it is a callable, it should take two
1280
parameters (registry, key): this registry and the key that
1281
the help was registered under.
1282
:param override_existing: Raise KeyErorr if False and something has
1283
already been registered for that key. If True, ignore if there
1284
is an existing key (always register the new value).
1285
:param fallback: Whether this credential store should be
1288
return super(CredentialStoreRegistry,
1289
self).register(key, obj, help, info=fallback,
1290
override_existing=override_existing)
1292
def register_lazy(self, key, module_name, member_name,
1293
help=None, override_existing=False,
1295
"""Register a new credential store to be loaded on request.
1297
:param module_name: The python path to the module. Such as 'os.path'.
1298
:param member_name: The member of the module to return. If empty or
1299
None, get() will return the module itself.
1300
:param help: Help text for this entry. This may be a string or
1302
:param override_existing: If True, replace the existing object
1303
with the new one. If False, if there is already something
1304
registered with the same key, raise a KeyError
1305
:param fallback: Whether this credential store should be
1308
return super(CredentialStoreRegistry, self).register_lazy(
1309
key, module_name, member_name, help,
1310
info=fallback, override_existing=override_existing)
1313
credential_store_registry = CredentialStoreRegistry()
1316
class CredentialStore(object):
1317
"""An abstract class to implement storage for credentials"""
1319
def decode_password(self, credentials):
1320
"""Returns a clear text password for the provided credentials."""
1321
raise NotImplementedError(self.decode_password)
1323
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1325
"""Return the matching credentials from this credential store.
1327
This method is only called on fallback credential stores.
1329
raise NotImplementedError(self.get_credentials)
1333
class PlainTextCredentialStore(CredentialStore):
1334
"""Plain text credential store for the authentication.conf file."""
1336
def decode_password(self, credentials):
1337
"""See CredentialStore.decode_password."""
1338
return credentials['password']
1341
credential_store_registry.register('plain', PlainTextCredentialStore,
1342
help=PlainTextCredentialStore.__doc__)
1343
credential_store_registry.default_key = 'plain'
1346
class BzrDirConfig(object):
1348
def __init__(self, bzrdir):
1349
self._bzrdir = bzrdir
1350
self._config = bzrdir._get_config()
1352
def set_default_stack_on(self, value):
1353
"""Set the default stacking location.
1355
It may be set to a location, or None.
1357
This policy affects all branches contained by this bzrdir, except for
1358
those under repositories.
1360
if self._config is None:
1361
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1363
self._config.set_option('', 'default_stack_on')
1365
self._config.set_option(value, 'default_stack_on')
1367
def get_default_stack_on(self):
1368
"""Return the default stacking location.
1370
This will either be a location, or None.
1372
This policy affects all branches contained by this bzrdir, except for
1373
those under repositories.
1375
if self._config is None:
1377
value = self._config.get_option('default_stack_on')
1383
class TransportConfig(object):
1384
"""A Config that reads/writes a config file on a Transport.
1386
It is a low-level object that considers config data to be name/value pairs
1387
that may be associated with a section. Assigning meaning to the these
1388
values is done at higher levels like TreeConfig.
1391
def __init__(self, transport, filename):
1392
self._transport = transport
1393
self._filename = filename
1395
def get_option(self, name, section=None, default=None):
1396
"""Return the value associated with a named option.
1398
:param name: The name of the value
1399
:param section: The section the option is in (if any)
1400
:param default: The value to return if the value is not set
1401
:return: The value or default value
1403
configobj = self._get_configobj()
1405
section_obj = configobj
1408
section_obj = configobj[section]
1411
return section_obj.get(name, default)
1413
def set_option(self, value, name, section=None):
1414
"""Set the value associated with a named option.
1416
:param value: The value to set
1417
:param name: The name of the value to set
1418
:param section: The section the option is in (if any)
1420
configobj = self._get_configobj()
1422
configobj[name] = value
1424
configobj.setdefault(section, {})[name] = value
1425
self._set_configobj(configobj)
1427
def _get_config_file(self):
1429
return self._transport.get(self._filename)
1430
except errors.NoSuchFile:
1433
def _get_configobj(self):
1434
return ConfigObj(self._get_config_file(), encoding='utf-8')
1436
def _set_configobj(self, configobj):
1437
out_file = StringIO()
1438
configobj.write(out_file)
1440
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
