146
150
class Config(object):
147
151
"""A configuration policy - what username, editor, gpg needs etc."""
154
super(Config, self).__init__()
149
156
def get_editor(self):
150
157
"""Get the users pop up editor."""
151
158
raise NotImplementedError
160
def get_change_editor(self, old_tree, new_tree):
161
from bzrlib import diff
162
cmd = self._get_change_editor()
165
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
153
169
def get_mail_client(self):
154
170
"""Get a mail client to use"""
155
171
selected_client = self.get_user_option('mail_client')
174
190
"""Get a generic option - no special process, no default."""
175
191
return self._get_user_option(option_name)
193
def get_user_option_as_bool(self, option_name):
194
"""Get a generic option as a boolean - no special process, no default.
196
:return None if the option doesn't exist or its value can't be
197
interpreted as a boolean. Returns True or False otherwise.
199
s = self._get_user_option(option_name)
201
# The option doesn't exist
203
val = ui.bool_from_string(s)
205
# The value can't be interpreted as a boolean
206
trace.warning('Value "%s" is not a boolean for "%s"',
210
def get_user_option_as_list(self, option_name):
211
"""Get a generic option as a list - no special process, no default.
213
:return None if the option doesn't exist. Returns the value as a list
216
l = self._get_user_option(option_name)
217
if isinstance(l, (str, unicode)):
218
# A single value, most probably the user forgot the final ','
177
222
def gpg_signing_command(self):
178
223
"""What program should be used to sign signatures?"""
179
224
result = self._gpg_signing_command()
341
def suppress_warning(self, warning):
342
"""Should the warning be suppressed or emitted.
344
:param warning: The name of the warning being tested.
346
:returns: True if the warning should be suppressed, False otherwise.
348
warnings = self.get_user_option_as_list('suppress_warnings')
349
if warnings is None or warning not in warnings:
299
355
class IniBasedConfig(Config):
300
356
"""A configuration policy that draws from ini files."""
302
def _get_parser(self, file=None):
358
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
360
"""Base class for configuration files using an ini-like syntax.
362
:param file_name: The configuration file path.
364
super(IniBasedConfig, self).__init__()
365
self.file_name = file_name
366
if symbol_versioning.deprecated_passed(get_filename):
367
symbol_versioning.warn(
368
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
369
' Use file_name instead.',
372
if get_filename is not None:
373
self.file_name = get_filename()
375
self.file_name = file_name
380
def from_string(cls, str_or_unicode, file_name=None, save=False):
381
"""Create a config object from a string.
383
:param str_or_unicode: A string representing the file content. This will
386
:param file_name: The configuration file path.
388
:param _save: Whether the file should be saved upon creation.
390
conf = cls(file_name=file_name)
391
conf._create_from_string(str_or_unicode, save)
394
def _create_from_string(self, str_or_unicode, save):
395
self._content = StringIO(str_or_unicode.encode('utf-8'))
396
# Some tests use in-memory configs, some other always need the config
397
# file to exist on disk.
399
self._write_config_file()
401
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
303
402
if self._parser is not None:
304
403
return self._parser
306
input = self._get_filename()
404
if symbol_versioning.deprecated_passed(file):
405
symbol_versioning.warn(
406
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
407
' Use IniBasedConfig(_content=xxx) instead.',
410
if self._content is not None:
411
co_input = self._content
412
elif self.file_name is None:
413
raise AssertionError('We have no content to create the config')
415
co_input = self.file_name
310
self._parser = ConfigObj(input, encoding='utf-8')
417
self._parser = ConfigObj(co_input, encoding='utf-8')
311
418
except configobj.ConfigObjError, e:
312
419
raise errors.ParseConfigError(e.errors, e.config.filename)
420
# Make sure self.reload() will use the right file name
421
self._parser.filename = self.file_name
313
422
return self._parser
425
"""Reload the config file from disk."""
426
if self.file_name is None:
427
raise AssertionError('We need a file name to reload the config')
428
if self._parser is not None:
429
self._parser.reload()
315
431
def _get_matching_sections(self):
316
432
"""Return an ordered list of (section_name, extra_path) pairs.
422
536
def _get_nickname(self):
423
537
return self.get_user_option('nickname')
426
class GlobalConfig(IniBasedConfig):
539
def _write_config_file(self):
540
if self.file_name is None:
541
raise AssertionError('We cannot save, self.file_name is None')
542
conf_dir = os.path.dirname(self.file_name)
543
ensure_config_dir_exists(conf_dir)
544
atomic_file = atomicfile.AtomicFile(self.file_name)
545
self._get_parser().write(atomic_file)
548
osutils.copy_ownership_from_path(self.file_name)
551
class LockableConfig(IniBasedConfig):
552
"""A configuration needing explicit locking for access.
554
If several processes try to write the config file, the accesses need to be
557
Daughter classes should decorate all methods that update a config with the
558
``@needs_write_lock`` decorator (they call, directly or indirectly, the
559
``_write_config_file()`` method. These methods (typically ``set_option()``
560
and variants must reload the config file from disk before calling
561
``_write_config_file()``), this can be achieved by calling the
562
``self.reload()`` method. Note that the lock scope should cover both the
563
reading and the writing of the config file which is why the decorator can't
564
be applied to ``_write_config_file()`` only.
566
This should be enough to implement the following logic:
567
- lock for exclusive write access,
568
- reload the config file from disk,
572
This logic guarantees that a writer can update a value without erasing an
573
update made by another writer.
578
def __init__(self, file_name):
579
super(LockableConfig, self).__init__(file_name=file_name)
580
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
581
self.transport = transport.get_transport(self.dir)
582
self._lock = lockdir.LockDir(self.transport, 'lock')
584
def _create_from_string(self, unicode_bytes, save):
585
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
587
# We need to handle the saving here (as opposed to IniBasedConfig)
590
self._write_config_file()
593
def lock_write(self, token=None):
594
"""Takes a write lock in the directory containing the config file.
596
If the directory doesn't exist it is created.
598
ensure_config_dir_exists(self.dir)
599
return self._lock.lock_write(token)
604
def break_lock(self):
605
self._lock.break_lock()
607
def _write_config_file(self):
608
if self._lock is None or not self._lock.is_held:
609
# NB: if the following exception is raised it probably means a
610
# missing @needs_write_lock decorator on one of the callers.
611
raise errors.ObjectNotLocked(self)
612
super(LockableConfig, self)._write_config_file()
615
class GlobalConfig(LockableConfig):
427
616
"""The configuration that should be used for a specific location."""
619
super(GlobalConfig, self).__init__(file_name=config_filename())
622
def from_string(cls, str_or_unicode, save=False):
623
"""Create a config object from a string.
625
:param str_or_unicode: A string representing the file content. This
626
will be utf-8 encoded.
628
:param save: Whether the file should be saved upon creation.
631
conf._create_from_string(str_or_unicode, save)
429
634
def get_editor(self):
430
635
return self._get_user_option('editor')
433
super(GlobalConfig, self).__init__(config_filename)
435
638
def set_user_option(self, option, value):
436
639
"""Save option and its value in the configuration."""
437
640
self._set_option(option, value, 'DEFAULT')
456
662
self._write_config_file()
458
664
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
666
self._get_parser().setdefault(section, {})[option] = value
464
667
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):
670
class LocationConfig(LockableConfig):
473
671
"""A configuration object that gives the policy for a location."""
475
673
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)
674
super(LocationConfig, self).__init__(
675
file_name=locations_config_filename())
488
676
# local file locations are looked up by local path, rather than
489
677
# by file url. This is because the config file is a user
490
678
# file, and we would rather not expose the user to file urls.
492
680
location = urlutils.local_path_from_url(location)
493
681
self.location = location
684
def from_string(cls, str_or_unicode, location, save=False):
685
"""Create a config object from a string.
687
:param str_or_unicode: A string representing the file content. This will
690
:param location: The location url to filter the configuration.
692
:param save: Whether the file should be saved upon creation.
695
conf._create_from_string(str_or_unicode, save)
495
698
def _get_matching_sections(self):
496
699
"""Return an ordered list of section names matching this location."""
497
700
sections = self._get_parser()
592
796
STORE_LOCATION_APPENDPATH]:
593
797
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
800
location = self.location
600
801
if location.endswith('/'):
601
802
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():
803
parser = self._get_parser()
804
if not location in parser and not location + '/' in parser:
805
parser[location] = {}
806
elif location + '/' in parser:
606
807
location = location + '/'
607
self._get_parser()[location][option]=value
808
parser[location][option]=value
608
809
# the allowed values of store match the config policies
609
810
self._set_option_policy(location, option, store)
610
self._get_parser().write(file(self._get_filename(), 'wb'))
811
self._write_config_file()
613
814
class BranchConfig(Config):
614
815
"""A configuration object giving the policy for a branch."""
817
def __init__(self, branch):
818
super(BranchConfig, self).__init__()
819
self._location_config = None
820
self._branch_data_config = None
821
self._global_config = None
823
self.option_sources = (self._get_location_config,
824
self._get_branch_data_config,
825
self._get_global_config)
616
827
def _get_branch_data_config(self):
617
828
if self._branch_data_config is None:
618
829
self._branch_data_config = TreeConfig(self.branch)
709
923
trace.warning('Value "%s" is masked by "%s" from'
710
924
' branch.conf', value, mask_value)
713
926
def _gpg_signing_command(self):
714
927
"""See Config.gpg_signing_command."""
715
928
return self._get_safe_value('_gpg_signing_command')
717
def __init__(self, branch):
718
super(BranchConfig, self).__init__()
719
self._location_config = None
720
self._branch_data_config = None
721
self._global_config = None
723
self.option_sources = (self._get_location_config,
724
self._get_branch_data_config,
725
self._get_global_config)
727
930
def _post_commit(self):
728
931
"""See Config.post_commit."""
729
932
return self._get_safe_value('_post_commit')
813
1011
return osutils.pathjoin(config_dir(), 'ignore')
817
"""Calculate automatic user identification.
819
Returns (realname, email).
821
Only used when none is set in the environment or the id file.
823
This previously used the FQDN as the default domain, but that can
824
be very slow on machines where DNS is broken. So now we simply
1015
"""Return the directory name to store crash files.
1017
This doesn't implicitly create it.
1019
On Windows it's in the config directory; elsewhere it's /var/crash
1020
which may be monitored by apport. It can be overridden by
829
1023
if sys.platform == 'win32':
830
name = win32utils.get_user_name_unicode()
832
raise errors.BzrError("Cannot autodetect user name.\n"
833
"Please, set your name with command like:\n"
834
'bzr whoami "Your Name <name@domain.com>"')
835
host = win32utils.get_host_name_unicode()
837
host = socket.gethostname()
838
return name, (name + '@' + host)
844
w = pwd.getpwuid(uid)
846
raise errors.BzrCommandError('Unable to determine your name. '
847
'Please use "bzr whoami" to set it.')
849
# we try utf-8 first, because on many variants (like Linux),
850
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
851
# false positives. (many users will have their user encoding set to
852
# latin-1, which cannot raise UnicodeError.)
854
gecos = w.pw_gecos.decode('utf-8')
858
encoding = osutils.get_user_encoding()
859
gecos = w.pw_gecos.decode(encoding)
861
raise errors.BzrCommandError('Unable to determine your name. '
862
'Use "bzr whoami" to set it.')
864
username = w.pw_name.decode(encoding)
866
raise errors.BzrCommandError('Unable to determine your name. '
867
'Use "bzr whoami" to set it.')
869
comma = gecos.find(',')
873
realname = gecos[:comma]
880
user_encoding = osutils.get_user_encoding()
881
realname = username = getpass.getuser().decode(user_encoding)
882
except UnicodeDecodeError:
883
raise errors.BzrError("Can't decode username as %s." % \
886
return realname, (username + '@' + socket.gethostname())
1024
return osutils.pathjoin(config_dir(), 'Crash')
1026
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1028
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1031
def xdg_cache_dir():
1032
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1033
# Possibly this should be different on Windows?
1034
e = os.environ.get('XDG_CACHE_DIR', None)
1038
return os.path.expanduser('~/.cache')
889
1041
def parse_username(username):
1130
1288
config.update({name: values})
1133
def get_user(self, scheme, host, port=None,
1134
realm=None, path=None, prompt=None):
1291
def get_user(self, scheme, host, port=None, realm=None, path=None,
1292
prompt=None, ask=False, default=None):
1135
1293
"""Get a user from authentication file.
1137
1295
:param scheme: protocol
1212
1388
A credential store provides access to credentials via the password_encoding
1213
1389
field in authentication.conf sections.
1215
Except for stores provided by bzr itself,most stores are expected to be
1391
Except for stores provided by bzr itself, most stores are expected to be
1216
1392
provided by plugins that will therefore use
1217
1393
register_lazy(password_encoding, module_name, member_name, help=help,
1218
info=info) to install themselves.
1394
fallback=fallback) to install themselves.
1396
A fallback credential store is one that is queried if no credentials can be
1397
found via authentication.conf.
1221
1400
def get_credential_store(self, encoding=None):
1406
def is_fallback(self, name):
1407
"""Check if the named credentials store should be used as fallback."""
1408
return self.get_info(name)
1410
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1411
path=None, realm=None):
1412
"""Request credentials from all fallback credentials stores.
1414
The first credentials store that can provide credentials wins.
1417
for name in self.keys():
1418
if not self.is_fallback(name):
1420
cs = self.get_credential_store(name)
1421
credentials = cs.get_credentials(scheme, host, port, user,
1423
if credentials is not None:
1424
# We found some credentials
1428
def register(self, key, obj, help=None, override_existing=False,
1430
"""Register a new object to a name.
1432
:param key: This is the key to use to request the object later.
1433
:param obj: The object to register.
1434
:param help: Help text for this entry. This may be a string or
1435
a callable. If it is a callable, it should take two
1436
parameters (registry, key): this registry and the key that
1437
the help was registered under.
1438
:param override_existing: Raise KeyErorr if False and something has
1439
already been registered for that key. If True, ignore if there
1440
is an existing key (always register the new value).
1441
:param fallback: Whether this credential store should be
1444
return super(CredentialStoreRegistry,
1445
self).register(key, obj, help, info=fallback,
1446
override_existing=override_existing)
1448
def register_lazy(self, key, module_name, member_name,
1449
help=None, override_existing=False,
1451
"""Register a new credential store to be loaded on request.
1453
:param module_name: The python path to the module. Such as 'os.path'.
1454
:param member_name: The member of the module to return. If empty or
1455
None, get() will return the module itself.
1456
:param help: Help text for this entry. This may be a string or
1458
:param override_existing: If True, replace the existing object
1459
with the new one. If False, if there is already something
1460
registered with the same key, raise a KeyError
1461
:param fallback: Whether this credential store should be
1464
return super(CredentialStoreRegistry, self).register_lazy(
1465
key, module_name, member_name, help,
1466
info=fallback, override_existing=override_existing)
1228
1469
credential_store_registry = CredentialStoreRegistry()
1232
1473
"""An abstract class to implement storage for credentials"""
1234
1475
def decode_password(self, credentials):
1235
"""Returns a password for the provided credentials in clear text."""
1476
"""Returns a clear text password for the provided credentials."""
1236
1477
raise NotImplementedError(self.decode_password)
1479
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1481
"""Return the matching credentials from this credential store.
1483
This method is only called on fallback credential stores.
1485
raise NotImplementedError(self.get_credentials)
1239
1489
class PlainTextCredentialStore(CredentialStore):
1240
"""Plain text credential store for the authentication.conf file."""
1490
__doc__ = """Plain text credential store for the authentication.conf file"""
1242
1492
def decode_password(self, credentials):
1243
1493
"""See CredentialStore.decode_password."""
1325
1580
configobj.setdefault(section, {})[name] = value
1326
1581
self._set_configobj(configobj)
1583
def _get_config_file(self):
1585
return StringIO(self._transport.get_bytes(self._filename))
1586
except errors.NoSuchFile:
1328
1589
def _get_configobj(self):
1590
f = self._get_config_file()
1330
return ConfigObj(self._transport.get(self._filename),
1332
except errors.NoSuchFile:
1333
return ConfigObj(encoding='utf-8')
1592
return ConfigObj(f, encoding='utf-8')
1335
1596
def _set_configobj(self, configobj):
1336
1597
out_file = StringIO()
added
removed
bzrlib/config.py
