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.
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(), """
58
71
from fnmatch import fnmatch
73
from cStringIO import StringIO
62
import bzrlib.errors as errors
63
from bzrlib.osutils import pathjoin
64
from bzrlib.trace import mutter
65
87
import bzrlib.util.configobj.configobj as configobj
66
from StringIO import StringIO
68
91
CHECK_IF_POSSIBLE=0
103
POLICY_APPENDPATH = 2
107
POLICY_NORECURSE: 'norecurse',
108
POLICY_APPENDPATH: 'appendpath',
113
'norecurse': POLICY_NORECURSE,
114
'appendpath': POLICY_APPENDPATH,
118
STORE_LOCATION = POLICY_NONE
119
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
120
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
73
125
class ConfigObj(configobj.ConfigObj):
75
127
def get_bool(self, section, key):
76
val = self[section][key].lower()
77
if val in ('1', 'yes', 'true', 'on'):
79
elif val in ('0', 'no', 'false', 'off'):
82
raise ValueError("Value %r is not boolean" % val)
128
return self[section].as_bool(key)
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
147
def get_mail_client(self):
148
"""Get a mail client to use"""
149
selected_client = self.get_user_option('mail_client')
151
mail_client_class = {
152
None: mail_client.DefaultMail,
154
'evolution': mail_client.Evolution,
155
'kmail': mail_client.KMail,
156
'mutt': mail_client.Mutt,
157
'thunderbird': mail_client.Thunderbird,
159
'default': mail_client.DefaultMail,
160
'editor': mail_client.Editor,
161
'mapi': mail_client.MAPIClient,
162
'xdg-email': mail_client.XDGEmail,
165
raise errors.UnknownMailClient(selected_client)
166
return mail_client_class(self)
101
168
def _get_signature_checking(self):
102
169
"""Template method to override signature checking policy."""
171
def _get_signing_policy(self):
172
"""Template method to override signature creation policy."""
104
174
def _get_user_option(self, option_name):
105
175
"""Template method to provide a user option."""
177
259
return CHECK_IF_POSSIBLE
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:
266
return SIGN_WHEN_REQUIRED
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()
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:
278
elif policy == SIGN_ALWAYS:
282
def get_alias(self, value):
283
return self._get_alias(value)
285
def _get_alias(self, value):
288
def get_nickname(self):
289
return self._get_nickname()
291
def _get_nickname(self):
294
def get_bzr_remote_path(self):
296
return os.environ['BZR_REMOTE_PATH']
298
path = self.get_user_option("bzr_remote_path")
187
304
class IniBasedConfig(Config):
188
305
"""A configuration policy that draws from ini files."""
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
320
def _get_matching_sections(self):
321
"""Return an ordered list of (section_name, extra_path) pairs.
323
If the section contains inherited configuration, extra_path is
324
a string containing the additional path components.
326
section = self._get_section()
327
if section is not None:
328
return [(section, '')]
203
332
def _get_section(self):
204
333
"""Override this to define the section used by the config."""
336
def _get_option_policy(self, section, option_name):
337
"""Return the policy for the given (section, option_name) pair."""
207
340
def _get_signature_checking(self):
208
341
"""See Config._get_signature_checking."""
209
342
policy = self._get_user_option('check_signatures')
211
344
return self._string_to_signature_policy(policy)
346
def _get_signing_policy(self):
347
"""See Config._get_signing_policy"""
348
policy = self._get_user_option('create_signatures')
350
return self._string_to_signing_policy(policy)
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')
217
356
def _get_user_option(self, option_name):
218
357
"""See Config._get_user_option."""
220
return self._get_parser().get_value(self._get_section(),
358
for (section, extra_path) in self._get_matching_sections():
360
value = self._get_parser().get_value(section, option_name)
363
policy = self._get_option_policy(section, option_name)
364
if policy == POLICY_NONE:
366
elif policy == POLICY_NORECURSE:
367
# norecurse items only apply to the exact path
372
elif policy == POLICY_APPENDPATH:
374
value = urlutils.join(value, extra_path)
377
raise AssertionError('Unexpected config policy %r' % policy)
225
381
def _gpg_signing_command(self):
226
382
"""See Config.gpg_signing_command."""
227
383
return self._get_user_option('gpg_signing_command')
385
def _log_format(self):
386
"""See Config.log_format."""
387
return self._get_user_option('log_format')
229
389
def __init__(self, get_filename):
230
390
super(IniBasedConfig, self).__init__()
231
391
self._get_filename = get_filename
256
437
def __init__(self):
257
438
super(GlobalConfig, self).__init__(config_filename)
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)
260
454
class LocationConfig(IniBasedConfig):
261
455
"""A configuration object that gives the policy for a location."""
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()))
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
268
def _get_global_config(self):
269
if self._global_config is None:
270
self._global_config = GlobalConfig()
271
return self._global_config
273
def _get_section(self):
274
"""Get the section we should look in for config items.
276
Returns None if none exists.
277
TODO: perhaps return a NullSection that thunks through to the
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]
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)
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):
301
# if path is longer, and recurse is not true, no match
302
if len(section_names) < len(location_names):
304
if not self._get_parser().get_bool(section, 'recurse'):
308
matches.append((len(section_names), section))
508
matches.append((len(section_names), section,
509
'/'.join(location_names[len(section_names):])))
311
510
matches.sort(reverse=True)
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:
319
return self._get_global_config()._gpg_signing_command()
321
def _get_user_id(self):
322
user_id = super(LocationConfig, self)._get_user_id()
323
if user_id is not None:
325
return self._get_global_config()._get_user_id()
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:
333
return self._get_global_config()._get_user_option(option_name)
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:
340
return self._get_global_config()._get_signature_checking()
342
def _post_commit(self):
343
"""See Config.post_commit."""
344
hook = self._get_user_option('post_commit')
347
return self._get_global_config()._post_commit()
349
def set_user_option(self, option, value):
512
for (length, section, extra_path) in matches:
513
sections.append((section, extra_path))
514
# should we stop looking for parent configs here?
516
if self._get_parser()[section].as_bool('ignore_parents'):
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
526
recurse = self._get_parser()[section].as_bool('recurse')
530
return POLICY_NORECURSE
532
policy_key = option_name + ':policy'
534
policy_name = self._get_parser()[section][policy_key]
538
return _policy_value[policy_name]
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.
546
recurse = self._get_parser()[section].as_bool('recurse')
550
symbol_versioning.warn(
551
'The recurse option is deprecated as of 0.14. '
552
'The section "%s" has been converted to use policies.'
555
del self._get_parser()[section]['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'
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
567
if policy_key in self._get_parser()[section]:
568
del self._get_parser()[section][policy_key]
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'))
367
593
class BranchConfig(Config):
368
594
"""A configuration object giving the policy for a branch."""
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
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
606
def _get_global_config(self):
607
if self._global_config is None:
608
self._global_config = GlobalConfig()
609
return self._global_config
611
def _get_best_value(self, option_name):
612
"""This returns a user option from local, tree or global config.
614
They are tried in that order. Use get_safe_value if trusted values
617
for source in self.option_sources:
618
value = getattr(source(), option_name)()
619
if value is not None:
623
def _get_safe_value(self, option_name):
624
"""This variant of get_best_value never returns untrusted values.
626
It does not return values from the branch data, because the branch may
627
not be controlled by the user.
629
We may wish to allow locations.conf to control whether branches are
630
trusted in the future.
632
for source in (self._get_location_config, self._get_global_config):
633
value = getattr(source(), option_name)()
634
if value is not None:
375
638
def _get_user_id(self):
376
639
"""Return the full user id for the branch.
379
642
This is looked up in the email controlfile for the branch.
382
return (self.branch.controlfile("email", "r")
645
return (self.branch.control_files.get_utf8("email")
384
647
.decode(bzrlib.user_encoding)
386
649
except errors.NoSuchFile, e:
389
return self._get_location_config()._get_user_id()
652
return self._get_best_value('_get_user_id')
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')
658
def _get_signing_policy(self):
659
"""See Config._get_signing_policy."""
660
return self._get_best_value('_get_signing_policy')
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:
670
def set_user_option(self, name, value, store=STORE_BRANCH,
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)
677
self._get_location_config().set_user_option(name, value, store)
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)
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)
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')
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)
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')
712
def _get_nickname(self):
713
value = self._get_explicit_nickname()
714
if value is not None:
716
return urlutils.unescape(self.branch.base.split('/')[-2])
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
722
def _get_explicit_nickname(self):
723
return self._get_best_value('_get_nickname')
725
def _log_format(self):
726
"""See Config.log_format."""
727
return self._get_best_value('_log_format')
413
730
def ensure_config_dir_exists(path=None):
438
755
base = os.environ.get('BZR_HOME', None)
439
756
if sys.platform == 'win32':
441
base = os.environ.get('APPDATA', None)
758
base = win32utils.get_appdata_location_unicode()
443
760
base = os.environ.get('HOME', 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, or HOME set')
763
return osutils.pathjoin(base, 'bazaar', '2.0')
448
765
# cygwin, linux, and darwin all have a $HOME directory
450
767
base = os.path.expanduser("~")
451
return pathjoin(base, ".bazaar")
768
return osutils.pathjoin(base, ".bazaar")
454
771
def config_filename():
455
772
"""Return per-user configuration ini file filename."""
456
return pathjoin(config_dir(), 'bazaar.conf')
773
return osutils.pathjoin(config_dir(), 'bazaar.conf')
459
776
def branches_config_filename():
460
777
"""Return per-user configuration ini file filename."""
461
return pathjoin(config_dir(), 'branches.conf')
778
return osutils.pathjoin(config_dir(), 'branches.conf')
781
def locations_config_filename():
782
"""Return per-user configuration ini file filename."""
783
return osutils.pathjoin(config_dir(), 'locations.conf')
786
def authentication_config_filename():
787
"""Return per-user authentication ini file filename."""
788
return osutils.pathjoin(config_dir(), 'authentication.conf')
791
def user_ignore_config_filename():
792
"""Return the user default ignore filename"""
793
return osutils.pathjoin(config_dir(), 'ignore')
464
796
def _auto_user_id():
477
# XXX: Any good way to get real user name on win32?
809
if sys.platform == 'win32':
810
name = win32utils.get_user_name_unicode()
812
raise errors.BzrError("Cannot autodetect user name.\n"
813
"Please, set your name with command like:\n"
814
'bzr whoami "Your Name <name@domain.com>"')
815
host = win32utils.get_host_name_unicode()
817
host = socket.gethostname()
818
return name, (name + '@' + host)
481
822
uid = os.getuid()
482
823
w = pwd.getpwuid(uid)
483
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
484
username = w.pw_name.decode(bzrlib.user_encoding)
825
# we try utf-8 first, because on many variants (like Linux),
826
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
827
# false positives. (many users will have their user encoding set to
828
# latin-1, which cannot raise UnicodeError.)
830
gecos = w.pw_gecos.decode('utf-8')
834
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
835
encoding = bzrlib.user_encoding
837
raise errors.BzrCommandError('Unable to determine your name. '
838
'Use "bzr whoami" to set it.')
840
username = w.pw_name.decode(encoding)
842
raise errors.BzrCommandError('Unable to determine your name. '
843
'Use "bzr whoami" to set it.')
485
845
comma = gecos.find(',')
555
924
cfg_obj[section] = {}
556
925
obj = cfg_obj[section]
557
926
obj[name] = value
558
cfg_obj.encode('UTF-8')
559
out_file = StringIO(''.join([l+'\n' for l in cfg_obj.write()]))
927
out_file = StringIO()
928
cfg_obj.write(out_file)
561
self.branch.put_controlfile('branch.conf', out_file, encode=False)
930
self.branch.control_files.put('branch.conf', out_file)
563
932
self.branch.unlock()
935
class AuthenticationConfig(object):
936
"""The authentication configuration file based on a ini file.
938
Implements the authentication.conf file described in
939
doc/developers/authentication-ring.txt.
942
def __init__(self, _file=None):
943
self._config = None # The ConfigObj
945
self._filename = authentication_config_filename()
946
self._input = self._filename = authentication_config_filename()
948
# Tests can provide a string as _file
949
self._filename = None
952
def _get_config(self):
953
if self._config is not None:
956
# FIXME: Should we validate something here ? Includes: empty
957
# sections are useless, at least one of
958
# user/password/password_encoding should be defined, etc.
960
# Note: the encoding below declares that the file itself is utf-8
961
# encoded, but the values in the ConfigObj are always Unicode.
962
self._config = ConfigObj(self._input, encoding='utf-8')
963
except configobj.ConfigObjError, e:
964
raise errors.ParseConfigError(e.errors, e.config.filename)
968
"""Save the config file, only tests should use it for now."""
969
conf_dir = os.path.dirname(self._filename)
970
ensure_config_dir_exists(conf_dir)
971
self._get_config().write(file(self._filename, 'wb'))
973
def _set_option(self, section_name, option_name, value):
974
"""Set an authentication configuration option"""
975
conf = self._get_config()
976
section = conf.get(section_name)
979
section = conf[section]
980
section[option_name] = value
983
def get_credentials(self, scheme, host, port=None, user=None, path=None):
984
"""Returns the matching credentials from authentication.conf file.
986
:param scheme: protocol
988
:param host: the server address
990
:param port: the associated port (optional)
992
:param user: login (optional)
994
:param path: the absolute path on the server (optional)
996
:return: A dict containing the matching credentials or None.
998
- name: the section name of the credentials in the
999
authentication.conf file,
1000
- user: can't de different from the provided user if any,
1001
- password: the decoded password, could be None if the credential
1002
defines only the user
1003
- verify_certificates: https specific, True if the server
1004
certificate should be verified, False otherwise.
1007
for auth_def_name, auth_def in self._get_config().items():
1008
a_scheme, a_host, a_user, a_path = map(
1009
auth_def.get, ['scheme', 'host', 'user', 'path'])
1012
a_port = auth_def.as_int('port')
1016
raise ValueError("'port' not numeric in %s" % auth_def_name)
1018
a_verify_certificates = auth_def.as_bool('verify_certificates')
1020
a_verify_certificates = True
1023
"'verify_certificates' not boolean in %s" % auth_def_name)
1026
if a_scheme is not None and scheme != a_scheme:
1028
if a_host is not None:
1029
if not (host == a_host
1030
or (a_host.startswith('.') and host.endswith(a_host))):
1032
if a_port is not None and port != a_port:
1034
if (a_path is not None and path is not None
1035
and not path.startswith(a_path)):
1037
if (a_user is not None and user is not None
1038
and a_user != user):
1039
# Never contradict the caller about the user to be used
1044
credentials = dict(name=auth_def_name,
1045
user=a_user, password=auth_def['password'],
1046
verify_certificates=a_verify_certificates)
1047
self.decode_password(credentials,
1048
auth_def.get('password_encoding', None))
1049
if 'auth' in debug.debug_flags:
1050
trace.mutter("Using authentication section: %r", auth_def_name)
1055
def get_user(self, scheme, host, port=None,
1056
realm=None, path=None, prompt=None):
1057
"""Get a user from authentication file.
1059
:param scheme: protocol
1061
:param host: the server address
1063
:param port: the associated port (optional)
1065
:param realm: the realm sent by the server (optional)
1067
:param path: the absolute path on the server (optional)
1069
:return: The found user.
1071
credentials = self.get_credentials(scheme, host, port, user=None,
1073
if credentials is not None:
1074
user = credentials['user']
1079
def get_password(self, scheme, host, user, port=None,
1080
realm=None, path=None, prompt=None):
1081
"""Get a password from authentication file or prompt the user for one.
1083
:param scheme: protocol
1085
:param host: the server address
1087
:param port: the associated port (optional)
1091
:param realm: the realm sent by the server (optional)
1093
:param path: the absolute path on the server (optional)
1095
:return: The found password or the one entered by the user.
1097
credentials = self.get_credentials(scheme, host, port, user, path)
1098
if credentials is not None:
1099
password = credentials['password']
1102
# Prompt user only if we could't find a password
1103
if password is None:
1105
# Create a default prompt suitable for most of the cases
1106
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1107
# Special handling for optional fields in the prompt
1108
if port is not None:
1109
prompt_host = '%s:%d' % (host, port)
1112
password = ui.ui_factory.get_password(prompt,
1113
host=prompt_host, user=user)
1116
def decode_password(self, credentials, encoding):