1 # This module is part of debbugs, and is released
2 # under the terms of the GPL version 2, or any later
3 # version at your option.
4 # See the file README and COPYING for more information.
6 # Copyright 2007 by Don Armstrong <don@donarmstrong.com>.
8 package Debbugs::Config;
12 Debbugs::Config -- Configuration information for debbugs
18 # to get the compatiblity interface
20 use Debbugs::Config qw(:globals);
24 This module provides configuration variables for all of debbugs.
26 =head1 CONFIGURATION FILES
28 The default configuration file location is /etc/debbugs/config; this
29 configuration file location can be set by modifying the
30 DEBBUGS_CONFIG_FILE env variable to point at a different location.
36 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT $USING_GLOBALS %config);
37 use base qw(Exporter);
40 # set the version for version checking
42 $DEBUG = 0 unless defined $DEBUG;
46 %EXPORT_TAGS = (globals => [qw($gEmailDomain $gListDomain $gWebHost $gWebHostBugDir),
47 qw($gWebDomain $gHTMLSuffix $gCGIDomain $gMirrors),
48 qw($gPackagePages $gSubscriptionDomain $gProject $gProjectTitle),
49 qw($gMaintainer $gMaintainerWebpage $gMaintainerEmail $gUnknownMaintainerEmail),
50 qw($gSubmitList $gMaintList $gQuietList $gForwardList),
51 qw($gDoneList $gRequestList $gSubmitterList $gControlList),
53 qw($gBugSubscriptionDomain),
54 qw($gPackageVersionRe),
55 qw($gSummaryList $gMirrorList $gMailer $gBug),
56 qw($gBugs $gRemoveAge $gSaveOldBugs $gDefaultSeverity),
57 qw($gShowSeverities $gBounceFroms $gConfigDir $gSpoolDir),
58 qw($gIncomingDir $gWebDir $gDocDir $gMaintainerFile),
59 qw($gMaintainerFileOverride $gPseudoMaintFile $gPseudoDescFile $gPackageSource),
60 qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
61 qw($gVersionTimeIndex),
62 qw($gSimpleVersioning),
64 qw($gSendmail @gSendmailArguments $gLibPath $gSpamScan @gExcludeFromControl),
65 qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
66 qw(%gTagsSingleLetter),
68 qw(%gDistributionAliases),
69 qw(%gObsoleteSeverities),
70 qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
71 qw(@gRemovalStrongSeverityDefaultDistributionTags),
72 qw(@gAffectsDistributionTags),
73 qw(@gDefaultArchitectures),
77 qw($gSpamMaxThreads $gSpamSpamsPerThread $gSpamKeepRunning $gSpamScan $gSpamCrossassassinDb),
79 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
81 cgi => [qw($gLibravatarUri $gLibravatarCacheDir $gLibravatarUriOptions @gLibravatarBlacklist)],
82 config => [qw(%config)],
85 Exporter::export_ok_tags(keys %EXPORT_TAGS);
86 $EXPORT_TAGS{all} = [@EXPORT_OK];
87 $ENV{HOME} = '' if not defined $ENV{HOME};
91 use File::Basename qw(dirname);
95 =head1 CONFIGURATION VARIABLES
97 =head2 General Configuration
105 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
106 # This enables us to test things that are -T.
107 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
108 # This causes all sorts of problems for mirrors of debbugs; disable
110 # if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] == $<) {
111 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
112 $ENV{DEBBUGS_CONFIG_FILE} = $1;
115 # die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
118 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
120 =item email_domain $gEmailDomain
122 The email domain of the bts
126 set_default(\%config,'email_domain','bugs.something');
128 =item list_domain $gListDomain
130 The list domain of the bts, defaults to the email domain
134 set_default(\%config,'list_domain',$config{email_domain});
136 =item web_host $gWebHost
138 The web host of the bts; defaults to the email domain
142 set_default(\%config,'web_host',$config{email_domain});
144 =item web_host_bug_dir $gWebHostDir
146 The directory of the web host on which bugs are kept, defaults to C<''>
150 set_default(\%config,'web_host_bug_dir','');
152 =item web_domain $gWebDomain
154 Full path of the web domain where bugs are kept, defaults to the
155 concatenation of L</web_host> and L</web_host_bug_dir>
159 set_default(\%config,'web_domain',$config{web_host}.($config{web_host}=~m{/$}?'':'/').$config{web_host_bug_dir});
161 =item html_suffix $gHTMLSuffix
163 Suffix of html pages, defaults to .html
167 set_default(\%config,'html_suffix','.html');
169 =item cgi_domain $gCGIDomain
171 Full path of the web domain where cgi scripts are kept. Defaults to
172 the concatentation of L</web_host> and cgi.
176 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
178 =item mirrors @gMirrors
180 List of mirrors [What these mirrors are used for, no one knows.]
185 set_default(\%config,'mirrors',[]);
187 =item package_pages $gPackagePages
189 Domain where the package pages are kept; links should work in a
190 package_pages/foopackage manner. Defaults to undef, which means that
191 package links will not be made.
196 set_default(\%config,'package_pages',undef);
198 =item package_pages $gUsertagPackageDomain
200 Domain where where usertags of packages belong; defaults to $gPackagePages
204 set_default(\%config,'usertag_package_domain',$config{package_pages});
207 =item subscription_domain $gSubscriptionDomain
209 Domain where subscriptions to package lists happen
213 set_default(\%config,'subscription_domain',undef);
216 =item cve_tracker $gCVETracker
218 URI to CVE security tracker; in bugreport.cgi, CVE-2001-0002 becomes
219 linked to http://$config{cve_tracker}CVE-2001-002
221 Default: security-tracker.debian.org/tracker/
225 set_default(\%config,'cve_tracker','security-tracker.debian.org/tracker/');
233 =head2 Project Identification
237 =item project $gProject
245 set_default(\%config,'project','Something');
247 =item project_title $gProjectTitle
249 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
251 Default: "$config{project} Debbugs Install"
255 set_default(\%config,'project_title',"$config{project} Debbugs Install");
257 =item maintainer $gMaintainer
259 Name of the maintainer of this debbugs install
261 Default: 'Local DebBugs Owner's
265 set_default(\%config,'maintainer','Local DebBugs Owner');
267 =item maintainer_webpage $gMaintainerWebpage
269 Webpage of the maintainer of this install of debbugs
271 Default: "$config{web_domain}/~owner"
275 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
277 =item maintainer_email $gMaintainerEmail
279 Email address of the maintainer of this Debbugs install
281 Default: 'root@'.$config{email_domain}
285 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
287 =item unknown_maintainer_email
289 Email address where packages with an unknown maintainer will be sent
291 Default: $config{maintainer_email}
295 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
299 The name of the machine that this instance of debbugs is running on
300 (currently used for debbuging purposes and web page output.)
302 Default: Sys::Hostname::hostname()
308 set_default(\%config,'machine_name',Sys::Hostname::hostname());
310 =head2 BTS Mailing Lists
337 set_default(\%config, 'submit_list', 'bug-submit-list');
338 set_default(\%config, 'maint_list', 'bug-maint-list');
339 set_default(\%config, 'quiet_list', 'bug-quiet-list');
340 set_default(\%config, 'forward_list', 'bug-forward-list');
341 set_default(\%config, 'done_list', 'bug-done-list');
342 set_default(\%config, 'request_list', 'bug-request-list');
343 set_default(\%config,'submitter_list','bug-submitter-list');
344 set_default(\%config, 'control_list', 'bug-control-list');
345 set_default(\%config, 'summary_list', 'bug-summary-list');
346 set_default(\%config, 'mirror_list', 'bug-mirror-list');
347 set_default(\%config, 'strong_list', 'bug-strong-list');
349 =item bug_subscription_domain
351 Domain of list for messages regarding a single bug; prefixed with
352 bug=${bugnum}@ when bugs are actually sent out. Set to undef or '' to
353 disable sending messages to the bug subscription list.
361 set_default(\%config,'bug_subscription_domain',$config{list_domain});
371 Name of the mailer to use
377 set_default(\%config,'mailer','exim');
386 Default: ucfirst($config{bug});
394 Default: ucfirst($config{ubugs});
398 set_default(\%config,'bug','bug');
399 set_default(\%config,'ubug',ucfirst($config{bug}));
400 set_default(\%config,'bugs','bugs');
401 set_default(\%config,'ubugs',ucfirst($config{bugs}));
405 Age at which bugs are archived/removed
411 set_default(\%config,'remove_age',28);
415 Whether old bugs are saved or deleted
421 set_default(\%config,'save_old_bugs',1);
423 =item distribution_aliases
425 Map of distribution aliases to the distribution name
428 {experimental => 'experimental',
429 unstable => 'unstable',
430 testing => 'testing',
432 oldstable => 'oldstable',
436 sarge => 'oldstable',
441 set_default(\%config,'distribution_aliases',
442 {experimental => 'experimental',
443 unstable => 'unstable',
444 testing => 'testing',
446 oldstable => 'oldstable',
450 sarge => 'oldstable',
458 List of valid distributions
460 Default: The values of the distribution aliases map.
464 my %_distributions_default;
465 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
466 set_default(\%config,'distributions',[keys %_distributions_default]);
469 =item default_architectures
471 List of default architectures to use when architecture(s) are not
474 Default: i386 amd64 arm ppc sparc alpha
478 set_default(\%config,'default_architectures',
479 [qw(i386 amd64 arm powerpc sparc alpha)]
482 =item affects_distribution_tags
484 List of tags which restrict the buggy state to a set of distributions.
486 The set of distributions that are buggy is the intersection of the set
487 of distributions that would be buggy without reference to these tags
488 and the set of these tags that are distributions which are set on a
491 Setting this to [] will remove this feature.
493 Default: @{$config{distributions}}
497 set_default(\%config,'affects_distribution_tags',
498 [@{$config{distributions}}],
501 =item removal_unremovable_tags
503 Bugs which have these tags set cannot be archived
509 set_default(\%config,'removal_unremovable_tags',
513 =item removal_distribution_tags
515 Tags which specifiy distributions to check
517 Default: @{$config{distributions}}
521 set_default(\%config,'removal_distribution_tags',
522 [@{$config{distributions}}]);
524 =item removal_default_distribution_tags
526 For removal/archival purposes, all bugs are assumed to have these tags
529 Default: qw(unstable testing);
533 set_default(\%config,'removal_default_distribution_tags',
534 [qw(unstable testing)]
537 =item removal_strong_severity_default_distribution_tags
539 For removal/archival purposes, all bugs with strong severity are
540 assumed to have these tags set.
542 Default: qw(unstable testing stable);
546 set_default(\%config,'removal_strong_severity_default_distribution_tags',
547 [qw(unstable testing stable)]
551 =item removal_architectures
553 For removal/archival purposes, these architectures are consulted if
554 there is more than one architecture applicable. If the bug is in a
555 package not in any of these architectures, the architecture actually
556 checked is undefined.
558 Default: value of default_architectures
562 set_default(\%config,'removal_architectures',
563 $config{default_architectures},
567 =item package_name_re
569 The regex which will match a package name
571 Default: '[a-z0-9][a-z0-9\.+-]+'
575 set_default(\%config,'package_name_re',
576 '[a-z0-9][a-z0-9\.+-]+');
578 =item package_version_re
580 The regex which will match a package version
582 Default: '[A-Za-z0-9:+\.-]+'
587 set_default(\%config,'package_version_re',
588 '[A-Za-z0-9:+\.~-]+');
591 =item default_package
593 This is the name of the default package. If set, bugs assigned to
594 packages without a maintainer and bugs missing a Package: psuedoheader
595 will be assigned to this package instead.
597 Defaults to unset, which is the traditional debbugs behavoir
601 set_default(\%config,'default_package',
606 =item control_internal_requester
608 This address is used by Debbugs::Control as the request address which
609 sent a control request for faked log messages.
611 Default:"Debbugs Internal Request <$config{maintainer_email}>"
615 set_default(\%config,'control_internal_requester',
616 "Debbugs Internal Request <$config{maintainer_email}>",
619 =item control_internal_request_addr
621 This address is used by Debbugs::Control as the address to which a
622 faked log message request was sent.
624 Default: "internal_control\@$config{email_domain}";
628 set_default(\%config,'control_internal_request_addr',
629 'internal_control@'.$config{email_domain},
633 =item exclude_from_control
635 Addresses which are not allowed to send messages to control
639 set_default(\%config,'exclude_from_control',[]);
643 =item default_severity
645 The default severity of bugs which have no severity set
651 set_default(\%config,'default_severity','normal');
653 =item severity_display
655 A hashref of severities and the informative text which describes them.
659 {critical => "Critical $config{bugs}",
660 grave => "Grave $config{bugs}",
661 normal => "Normal $config{bugs}",
662 wishlist => "Wishlist $config{bugs}",
667 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
668 grave => "Grave $config{bugs}",
669 serious => "Serious $config{bugs}",
670 important=> "Important $config{bugs}",
671 normal => "Normal $config{bugs}",
672 minor => "Minor $config{bugs}",
673 wishlist => "Wishlist $config{bugs}",
676 =item show_severities
678 A scalar list of the severities to show
680 Defaults to the concatenation of the keys of the severity_display
681 hashlist with ', ' above.
685 set_default(\%config,'show_severities',join(', ',keys %{$config{severity_display}}));
687 =item strong_severities
689 An arrayref of the serious severities which shoud be emphasized
691 Default: [qw(critical grave)]
695 set_default(\%config,'strong_severities',[qw(critical grave)]);
699 An arrayref of a list of the severities
701 Defaults to the keys of the severity display hashref
705 set_default(\%config,'severity_list',[keys %{$config{severity_display}}]);
707 =item obsolete_severities
709 A hashref of obsolete severities with the replacing severity
715 set_default(\%config,'obsolete_severities',{});
719 An arrayref of the tags used
721 Default: [qw(patch wontfix moreinfo unreproducible fixed)] and also
722 includes the distributions.
726 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
727 @{$config{distributions}}
730 set_default(\%config,'tags_single_letter',
734 unreproducible => 'R',
739 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
740 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
741 '^mail.*agent|^tcpmail|^bitmail|^mailman');
743 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
744 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
748 Directory which contains the usertags
750 Default: $config{spool_dir}/user
754 set_default(\%config,'usertag_dir',$config{spool_dir}.'/user');
755 set_default(\%config,'incoming_dir','incoming');
757 =item web_dir $gWebDir
759 Directory where base html files are kept. Should normally be the same
760 as the web server's document root.
762 Default: /var/lib/debbugs/www
766 set_default(\%config,'web_dir','/var/lib/debbugs/www');
767 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
768 set_default(\%config,'lib_path','/usr/lib/debbugs');
773 directory of templates; defaults to /usr/share/debbugs/templates.
777 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
780 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
781 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
782 set_default(\%config,'source_maintainer_file',$config{config_dir}.'/Source_maintainers');
783 set_default(\%config,'source_maintainer_file_override',undef);
784 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maintainers');
785 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
786 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
789 =item simple_versioning
791 If true this causes debbugs to ignore version information and just
792 look at whether a bug is done or not done. Primarily of interest for
793 debbugs installs which don't track versions. defaults to false.
797 set_default(\%config,'simple_versioning',0);
800 =item version_packages_dir
802 Location where the version package information is kept; defaults to
803 spool_dir/../versions/pkg
807 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
809 =item version_time_index
811 Location of the version/time index file. Defaults to
812 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
813 exists; otherwise defaults to undef.
818 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
822 Location of the version index file. Defaults to
823 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
824 exists; otherwise defaults to undef.
828 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
830 =item binary_source_map
832 Location of the binary -> source map. Defaults to
833 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
834 exists; otherwise defaults to undef.
838 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
840 =item source_binary_map
842 Location of the source -> binary map. Defaults to
843 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
844 exists; otherwise defaults to undef.
848 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
852 set_default(\%config,'post_processall',[]);
856 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
860 set_default(\%config,'sendmail','/usr/lib/sendmail');
862 =item sendmail_arguments
864 Default arguments to pass to sendmail. Defaults to C<qw(-oem -oi)>.
868 set_default(\%config,'sendmail_arguments',[qw(-oem -oi)]);
872 Whether or not spamscan is being used; defaults to 0 (not being used
876 set_default(\%config,'spam_scan',0);
878 =item spam_crossassassin_db
880 Location of the crosassassin database, defaults to
881 spool_dir/../CrossAssassinDb
885 set_default(\%config,'spam_crossassassin_db',$config{spool_dir}.'/../CrossAssassinDb');
889 Maximum number of cross-posted messages
893 set_default(\%config,'spam_max_cross',6);
896 =item spam_spams_per_thread
898 Number of spams for each thread (on average). Defaults to 200
902 set_default(\%config,'spam_spams_per_thread',200);
904 =item spam_max_threads
906 Maximum number of threads to start. Defaults to 20
910 set_default(\%config,'spam_max_threads',20);
912 =item spam_keep_running
914 Maximum number of seconds to run without restarting. Defaults to 3600.
918 set_default(\%config,'spam_keep_running',3600);
922 Location to store spam messages; is run through strftime to allow for
923 %d,%m,%Y, et al. Defaults to 'spool_dir/../mail/spam/assassinated.%Y-%m-%d'
927 set_default(\%config,'spam_mailbox',$config{spool_dir}.'/../mail/spam/assassinated.%Y-%m-%d');
929 =item spam_crossassassin_mailbox
931 Location to store crossassassinated messages; is run through strftime
932 to allow for %d,%m,%Y, et al. Defaults to
933 'spool_dir/../mail/spam/crossassassinated.%Y-%m-%d'
937 set_default(\%config,'spam_crossassassin_mailbox',$config{spool_dir}.'/../mail/spam/crossassassinated.%Y-%m-%d');
939 =item spam_local_tests_only
941 Whether only local tests are run, defaults to 0
945 set_default(\%config,'spam_local_tests_only',0);
947 =item spam_user_prefs
949 User preferences for spamassassin, defaults to $ENV{HOME}/.spamassassin/user_prefs
953 set_default(\%config,'spam_user_prefs',"$ENV{HOME}/.spamassassin/user_prefs");
957 Site rules directory for spamassassin, defaults to
958 '/usr/share/spamassassin'
962 set_default(\%config,'spam_rules_dir','/usr/share/spamassassin');
970 =item libravatar_uri $gLibravatarUri
972 URI to a libravatar configuration. If empty or undefined, libravatar
973 support will be disabled. Defaults to
974 libravatar.cgi, our internal federated libravatar system.
978 set_default(\%config,'libravatar_uri','http://'.$config{cgi_domain}.'/libravatar.cgi?email=');
980 =item libravatar_uri_options $gLibravatarUriOptions
982 Options to append to the md5_hex of the e-mail. This sets the default
983 avatar used when an avatar isn't available. Currently defaults to
984 '?d=retro', which causes a bitmap-looking avatar to be displayed for
987 Other options which make sense include ?d=404, ?d=wavatar, etc. See
988 the API of libravatar for details.
992 set_default(\%config,'libravatar_uri_options','');
994 =item libravatar_default_image
996 Default image to serve for libravatar if there is no avatar for an
997 e-mail address. By default, this is a 1x1 png. [This will also be the
998 image served if someone specifies avatar=no.]
1000 Default: $config{web_dir}/1x1.png
1004 set_default(\%config,'libravatar_default_image',$config{web_dir}.'/1x1.png');
1006 =item libravatar_cache_dir
1008 Directory where cached libravatar images are stored
1010 Default: $config{web_dir}/libravatar/
1014 set_default(\%config,'libravatar_cache_dir',$config{web_dir}.'/libravatar/');
1016 =item libravatar_blacklist
1018 Array of regular expressions to match against emails, domains, or
1019 images to only show the default image
1021 Default: empty array
1025 set_default(\%config,'libravatar_blacklist',[]);
1031 The following are the only text fields in general use in the scripts;
1032 a few additional text fields are defined in text.in, but are only used
1033 in db2html and a few other specialty scripts.
1035 Earlier versions of debbugs defined these values in /etc/debbugs/text,
1036 but now they are required to be in the configuration file. [Eventually
1037 the longer ones will move out into a fully fledged template system.]
1043 =item bad_email_prefix
1045 This prefixes the text of all lines in a bad e-mail message ack.
1049 set_default(\%config,'bad_email_prefix','');
1052 =item text_instructions
1054 This gives more information about bad e-mails to receive.in
1058 set_default(\%config,'text_instructions',$config{bad_email_prefix});
1062 This shows up at the end of (most) html pages
1064 In many pages this has been replaced by the html/tail template.
1068 set_default(\%config,'html_tail',<<END);
1069 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
1075 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
1076 Copyright (C) 1999 Darren O. Benham,
1077 1997,2003 nCipher Corporation Ltd,
1078 1994-97 Ian Jackson.
1083 =item html_expire_note
1085 This message explains what happens to archive/remove-able bugs
1089 set_default(\%config,'html_expire_note',
1090 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
1098 my ($conf_file) = @_;
1099 if (not -e $conf_file) {
1100 print STDERR "configuration file '$conf_file' doesn't exist; skipping it\n" if $DEBUG;
1103 # first, figure out what type of file we're reading in.
1104 my $fh = new IO::File $conf_file,'r'
1105 or die "Unable to open configuration file $conf_file for reading: $!";
1106 # A new version configuration file must have a comment as its first line
1107 my $first_line = <$fh>;
1108 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
1109 if (defined $version) {
1110 if ($version == 1) {
1111 # Do something here;
1112 die "Version 1 configuration files not implemented yet";
1115 die "Version $version configuration files are not supported";
1119 # Ugh. Old configuration file
1120 # What we do here is we create a new Safe compartment
1121 # so fucked up crap in the config file doesn't sink us.
1122 my $cpt = new Safe or die "Unable to create safe compartment";
1123 # perldoc Opcode; for details
1124 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
1125 $cpt->reval(qq(require '$conf_file';));
1126 die "Error in configuration file: $@" if $@;
1127 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
1128 # we want to glob in from the configuration file
1129 for my $variable (map {$_ =~ /^(?:config|all)$/ ? () : @{$EXPORT_TAGS{$_}}} keys %EXPORT_TAGS) {
1130 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1131 my $var_glob = $cpt->varglob($glob_name);
1132 my $value; #= $cpt->reval("return $variable");
1133 # print STDERR "$variable $value",qq(\n);
1134 if (defined $var_glob) {{
1136 if ($glob_type eq '%') {
1137 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
1139 elsif ($glob_type eq '@') {
1140 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
1143 $value = ${*{$var_glob}};
1145 # We punt here, because we can't tell if the value was
1146 # defined intentionally, or if it was just left alone;
1147 # this tries to set sane defaults.
1148 set_default(\%config,$hash_name,$value) if defined $value;
1155 my ($variable) = @_;
1156 my $hash_name = $variable;
1157 $hash_name =~ s/^([\$\%\@])g//;
1159 my $glob_name = 'g'.$hash_name;
1160 $hash_name =~ s/(HTML|CGI|CVE)/ucfirst(lc($1))/ge;
1161 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
1162 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
1163 return $hash_name unless wantarray;
1164 return ($hash_name,$glob_name,$glob_type);
1169 # sets the configuration hash to the default value if it's not set,
1170 # otherwise doesn't do anything
1171 # If $USING_GLOBALS, then sets an appropriate global.
1174 my ($config,$option,$value) = @_;
1176 if ($USING_GLOBALS) {
1177 # fix up the variable name
1178 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
1179 # Fix stupid HTML names
1180 $varname =~ s/(Html|Cgi)/uc($1)/ge;
1182 # update the configuration value
1183 if (not $USING_GLOBALS and not exists $config->{$option}) {
1184 $config->{$option} = $value;
1186 elsif ($USING_GLOBALS) {{
1188 # Need to check if a value has already been set in a global
1189 if (defined *{"Debbugs::Config::${varname}"}) {
1190 $config->{$option} = *{"Debbugs::Config::${varname}"};
1193 $config->{$option} = $value;
1196 if ($USING_GLOBALS) {{
1198 *{"Debbugs::Config::${varname}"} = $config->{$option};
1205 # All we care about here is whether we've been called with the globals or text option;
1206 # if so, then we need to export some symbols back up.
1207 # In any event, we call exporter.
1210 if (grep /^:(?:text|globals)$/, @_) {
1212 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
1213 my $tmp = $variable;
1215 # Yes, I don't care if these are only used once
1217 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
1219 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1220 $tmp =~ s/^[\%\$\@]//;
1221 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
1224 Debbugs::Config->export_to_level(1,@_);