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 $gLibravatarUriOptions)],
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};
90 use File::Basename qw(dirname);
94 =head1 CONFIGURATION VARIABLES
96 =head2 General Configuration
104 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
105 # This enables us to test things that are -T.
106 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
107 # This causes all sorts of problems for mirrors of debbugs; disable
109 # if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] == $<) {
110 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
111 $ENV{DEBBUGS_CONFIG_FILE} = $1;
114 # die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
117 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
119 =item email_domain $gEmailDomain
121 The email domain of the bts
125 set_default(\%config,'email_domain','bugs.something');
127 =item list_domain $gListDomain
129 The list domain of the bts, defaults to the email domain
133 set_default(\%config,'list_domain',$config{email_domain});
135 =item web_host $gWebHost
137 The web host of the bts; defaults to the email domain
141 set_default(\%config,'web_host',$config{email_domain});
143 =item web_host_bug_dir $gWebHostDir
145 The directory of the web host on which bugs are kept, defaults to C<''>
149 set_default(\%config,'web_host_bug_dir','');
151 =item web_domain $gWebDomain
153 Full path of the web domain where bugs are kept, defaults to the
154 concatenation of L</web_host> and L</web_host_bug_dir>
158 set_default(\%config,'web_domain',$config{web_host}.($config{web_host}=~m{/$}?'':'/').$config{web_host_bug_dir});
160 =item html_suffix $gHTMLSuffix
162 Suffix of html pages, defaults to .html
166 set_default(\%config,'html_suffix','.html');
168 =item cgi_domain $gCGIDomain
170 Full path of the web domain where cgi scripts are kept. Defaults to
171 the concatentation of L</web_host> and cgi.
175 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
177 =item mirrors @gMirrors
179 List of mirrors [What these mirrors are used for, no one knows.]
184 set_default(\%config,'mirrors',[]);
186 =item package_pages $gPackagePages
188 Domain where the package pages are kept; links should work in a
189 package_pages/foopackage manner. Defaults to undef, which means that
190 package links will not be made.
195 set_default(\%config,'package_pages',undef);
197 =item package_pages $gUsertagPackageDomain
199 Domain where where usertags of packages belong; defaults to $gPackagePages
203 set_default(\%config,'usertag_package_domain',$config{package_pages});
206 =item subscription_domain $gSubscriptionDomain
208 Domain where subscriptions to package lists happen
212 set_default(\%config,'subscription_domain',undef);
215 =item cve_tracker $gCVETracker
217 URI to CVE security tracker; in bugreport.cgi, CVE-2001-0002 becomes
218 linked to http://$config{cve_tracker}CVE-2001-002
220 Default: security-tracker.debian.org/tracker/
224 set_default(\%config,'cve_tracker','security-tracker.debian.org/tracker/');
232 =head2 Project Identification
236 =item project $gProject
244 set_default(\%config,'project','Something');
246 =item project_title $gProjectTitle
248 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
250 Default: "$config{project} Debbugs Install"
254 set_default(\%config,'project_title',"$config{project} Debbugs Install");
256 =item maintainer $gMaintainer
258 Name of the maintainer of this debbugs install
260 Default: 'Local DebBugs Owner's
264 set_default(\%config,'maintainer','Local DebBugs Owner');
266 =item maintainer_webpage $gMaintainerWebpage
268 Webpage of the maintainer of this install of debbugs
270 Default: "$config{web_domain}/~owner"
274 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
276 =item maintainer_email $gMaintainerEmail
278 Email address of the maintainer of this Debbugs install
280 Default: 'root@'.$config{email_domain}
284 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
286 =item unknown_maintainer_email
288 Email address where packages with an unknown maintainer will be sent
290 Default: $config{maintainer_email}
294 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
298 The name of the machine that this instance of debbugs is running on
299 (currently used for debbuging purposes and web page output.)
301 Default: qx(hostname --fqdn)
307 my $_old_path = $ENV{PATH};
308 $ENV{PATH} = '/bin:/usr/bin:/usr/local/bin';
309 my $temp_hostname = qx(hostname --fqdn);
310 chomp $temp_hostname;
311 set_default(\%config,'machine_name',$temp_hostname);
312 $ENV{PATH} = $_old_path;
314 =head2 BTS Mailing Lists
341 set_default(\%config, 'submit_list', 'bug-submit-list');
342 set_default(\%config, 'maint_list', 'bug-maint-list');
343 set_default(\%config, 'quiet_list', 'bug-quiet-list');
344 set_default(\%config, 'forward_list', 'bug-forward-list');
345 set_default(\%config, 'done_list', 'bug-done-list');
346 set_default(\%config, 'request_list', 'bug-request-list');
347 set_default(\%config,'submitter_list','bug-submitter-list');
348 set_default(\%config, 'control_list', 'bug-control-list');
349 set_default(\%config, 'summary_list', 'bug-summary-list');
350 set_default(\%config, 'mirror_list', 'bug-mirror-list');
351 set_default(\%config, 'strong_list', 'bug-strong-list');
353 =item bug_subscription_domain
355 Domain of list for messages regarding a single bug; prefixed with
356 bug=${bugnum}@ when bugs are actually sent out. Set to undef or '' to
357 disable sending messages to the bug subscription list.
365 set_default(\%config,'bug_subscription_domain',$config{list_domain});
372 =item libravatar_uri $gLibravatarUri
374 URI to a libravatar configuration. If empty or undefined, libravatar
375 support will be disabled. Defaults to
376 libravatar.cgi, our internal federated libravatar system.
380 set_default(\%config,'libravatar_uri',$config{cgi_domain}.'/libravatar.cgi'.);
382 =item libravatar_uri_options $gLibravatarUriOptions
384 Options to append to the md5_hex of the e-mail. This sets the default
385 avatar used when an avatar isn't available. Currently defaults to
386 '?d=retro', which causes a bitmap-looking avatar to be displayed for
389 Other options which make sense include ?d=404, ?d=wavatar, etc. See
390 the API of libravatar for details.
394 set_default(\%config,'libravatar_uri_options','');
396 =item libravatar_default_image
398 Default image to serve for libravatar if there is no avatar for an
399 e-mail address. By default, this is a 1x1 png. [This will also be the
400 image served if someone specifies avatar=no.]
402 Default: $config{web_dir}/1x1.png
406 set_default(\%config,'libravatar_default_image',$config{web_dir}.'/1x1.png');
408 =item libravatar_cache_dir
410 Directory where cached libravatar images are stored
412 Default: $config{web_dir}/libravatar/
416 set_default(\%config,'libravatar_cache_dir',$config{web_dir}.'/libravatar/');
426 Name of the mailer to use
432 set_default(\%config,'mailer','exim');
441 Default: ucfirst($config{bug});
449 Default: ucfirst($config{ubugs});
453 set_default(\%config,'bug','bug');
454 set_default(\%config,'ubug',ucfirst($config{bug}));
455 set_default(\%config,'bugs','bugs');
456 set_default(\%config,'ubugs',ucfirst($config{bugs}));
460 Age at which bugs are archived/removed
466 set_default(\%config,'remove_age',28);
470 Whether old bugs are saved or deleted
476 set_default(\%config,'save_old_bugs',1);
478 =item distribution_aliases
480 Map of distribution aliases to the distribution name
483 {experimental => 'experimental',
484 unstable => 'unstable',
485 testing => 'testing',
487 oldstable => 'oldstable',
491 sarge => 'oldstable',
496 set_default(\%config,'distribution_aliases',
497 {experimental => 'experimental',
498 unstable => 'unstable',
499 testing => 'testing',
501 oldstable => 'oldstable',
505 sarge => 'oldstable',
513 List of valid distributions
515 Default: The values of the distribution aliases map.
519 my %_distributions_default;
520 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
521 set_default(\%config,'distributions',[keys %_distributions_default]);
524 =item default_architectures
526 List of default architectures to use when architecture(s) are not
529 Default: i386 amd64 arm ppc sparc alpha
533 set_default(\%config,'default_architectures',
534 [qw(i386 amd64 arm powerpc sparc alpha)]
537 =item affects_distribution_tags
539 List of tags which restrict the buggy state to a set of distributions.
541 The set of distributions that are buggy is the intersection of the set
542 of distributions that would be buggy without reference to these tags
543 and the set of these tags that are distributions which are set on a
546 Setting this to [] will remove this feature.
548 Default: @{$config{distributions}}
552 set_default(\%config,'affects_distribution_tags',
553 [@{$config{distributions}}],
556 =item removal_unremovable_tags
558 Bugs which have these tags set cannot be archived
564 set_default(\%config,'removal_unremovable_tags',
568 =item removal_distribution_tags
570 Tags which specifiy distributions to check
572 Default: @{$config{distributions}}
576 set_default(\%config,'removal_distribution_tags',
577 [@{$config{distributions}}]);
579 =item removal_default_distribution_tags
581 For removal/archival purposes, all bugs are assumed to have these tags
584 Default: qw(unstable testing);
588 set_default(\%config,'removal_default_distribution_tags',
589 [qw(unstable testing)]
592 =item removal_strong_severity_default_distribution_tags
594 For removal/archival purposes, all bugs with strong severity are
595 assumed to have these tags set.
597 Default: qw(unstable testing stable);
601 set_default(\%config,'removal_strong_severity_default_distribution_tags',
602 [qw(unstable testing stable)]
606 =item removal_architectures
608 For removal/archival purposes, these architectures are consulted if
609 there is more than one architecture applicable. If the bug is in a
610 package not in any of these architectures, the architecture actually
611 checked is undefined.
613 Default: value of default_architectures
617 set_default(\%config,'removal_architectures',
618 $config{default_architectures},
622 =item package_name_re
624 The regex which will match a package name
626 Default: '[a-z0-9][a-z0-9\.+-]+'
630 set_default(\%config,'package_name_re',
631 '[a-z0-9][a-z0-9\.+-]+');
633 =item package_version_re
635 The regex which will match a package version
637 Default: '[A-Za-z0-9:+\.-]+'
642 set_default(\%config,'package_version_re',
643 '[A-Za-z0-9:+\.~-]+');
646 =item default_package
648 This is the name of the default package. If set, bugs assigned to
649 packages without a maintainer and bugs missing a Package: psuedoheader
650 will be assigned to this package instead.
652 Defaults to unset, which is the traditional debbugs behavoir
656 set_default(\%config,'default_package',
661 =item control_internal_requester
663 This address is used by Debbugs::Control as the request address which
664 sent a control request for faked log messages.
666 Default:"Debbugs Internal Request <$config{maintainer_email}>"
670 set_default(\%config,'control_internal_requester',
671 "Debbugs Internal Request <$config{maintainer_email}>",
674 =item control_internal_request_addr
676 This address is used by Debbugs::Control as the address to which a
677 faked log message request was sent.
679 Default: "internal_control\@$config{email_domain}";
683 set_default(\%config,'control_internal_request_addr',
684 'internal_control@'.$config{email_domain},
688 =item exclude_from_control
690 Addresses which are not allowed to send messages to control
694 set_default(\%config,'exclude_from_control',[]);
698 =item default_severity
700 The default severity of bugs which have no severity set
706 set_default(\%config,'default_severity','normal');
708 =item severity_display
710 A hashref of severities and the informative text which describes them.
714 {critical => "Critical $config{bugs}",
715 grave => "Grave $config{bugs}",
716 normal => "Normal $config{bugs}",
717 wishlist => "Wishlist $config{bugs}",
722 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
723 grave => "Grave $config{bugs}",
724 serious => "Serious $config{bugs}",
725 important=> "Important $config{bugs}",
726 normal => "Normal $config{bugs}",
727 minor => "Minor $config{bugs}",
728 wishlist => "Wishlist $config{bugs}",
731 =item show_severities
733 A scalar list of the severities to show
735 Defaults to the concatenation of the keys of the severity_display
736 hashlist with ', ' above.
740 set_default(\%config,'show_severities',join(', ',keys %{$config{severity_display}}));
742 =item strong_severities
744 An arrayref of the serious severities which shoud be emphasized
746 Default: [qw(critical grave)]
750 set_default(\%config,'strong_severities',[qw(critical grave)]);
754 An arrayref of a list of the severities
756 Defaults to the keys of the severity display hashref
760 set_default(\%config,'severity_list',[keys %{$config{severity_display}}]);
762 =item obsolete_severities
764 A hashref of obsolete severities with the replacing severity
770 set_default(\%config,'obsolete_severities',{});
774 An arrayref of the tags used
776 Default: [qw(patch wontfix moreinfo unreproducible fixed)] and also
777 includes the distributions.
781 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
782 @{$config{distributions}}
785 set_default(\%config,'tags_single_letter',
789 unreproducible => 'R',
794 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
795 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
796 '^mail.*agent|^tcpmail|^bitmail|^mailman');
798 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
799 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
803 Directory which contains the usertags
805 Default: $config{spool_dir}/user
809 set_default(\%config,'usertag_dir',$config{spool_dir}.'/user');
810 set_default(\%config,'incoming_dir','incoming');
812 =item web_dir $gWebDir
814 Directory where base html files are kept. Should normally be the same
815 as the web server's document root.
817 Default: /var/lib/debbugs/www
821 set_default(\%config,'web_dir','/var/lib/debbugs/www');
822 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
823 set_default(\%config,'lib_path','/usr/lib/debbugs');
828 directory of templates; defaults to /usr/share/debbugs/templates.
832 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
835 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
836 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
837 set_default(\%config,'source_maintainer_file',$config{config_dir}.'/Source_maintainers');
838 set_default(\%config,'source_maintainer_file_override',undef);
839 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maintainers');
840 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
841 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
844 =item simple_versioning
846 If true this causes debbugs to ignore version information and just
847 look at whether a bug is done or not done. Primarily of interest for
848 debbugs installs which don't track versions. defaults to false.
852 set_default(\%config,'simple_versioning',0);
855 =item version_packages_dir
857 Location where the version package information is kept; defaults to
858 spool_dir/../versions/pkg
862 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
864 =item version_time_index
866 Location of the version/time index file. Defaults to
867 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
868 exists; otherwise defaults to undef.
873 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
877 Location of the version index file. Defaults to
878 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
879 exists; otherwise defaults to undef.
883 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
885 =item binary_source_map
887 Location of the binary -> source map. Defaults to
888 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
889 exists; otherwise defaults to undef.
893 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
895 =item source_binary_map
897 Location of the source -> binary map. Defaults to
898 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
899 exists; otherwise defaults to undef.
903 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
907 set_default(\%config,'post_processall',[]);
911 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
915 set_default(\%config,'sendmail','/usr/lib/sendmail');
917 =item sendmail_arguments
919 Default arguments to pass to sendmail. Defaults to C<qw(-oem -oi)>.
923 set_default(\%config,'sendmail_arguments',[qw(-oem -oi)]);
927 Whether or not spamscan is being used; defaults to 0 (not being used
931 set_default(\%config,'spam_scan',0);
933 =item spam_crossassassin_db
935 Location of the crosassassin database, defaults to
936 spool_dir/../CrossAssassinDb
940 set_default(\%config,'spam_crossassassin_db',$config{spool_dir}.'/../CrossAssassinDb');
944 Maximum number of cross-posted messages
948 set_default(\%config,'spam_max_cross',6);
951 =item spam_spams_per_thread
953 Number of spams for each thread (on average). Defaults to 200
957 set_default(\%config,'spam_spams_per_thread',200);
959 =item spam_max_threads
961 Maximum number of threads to start. Defaults to 20
965 set_default(\%config,'spam_max_threads',20);
967 =item spam_keep_running
969 Maximum number of seconds to run without restarting. Defaults to 3600.
973 set_default(\%config,'spam_keep_running',3600);
977 Location to store spam messages; is run through strftime to allow for
978 %d,%m,%Y, et al. Defaults to 'spool_dir/../mail/spam/assassinated.%Y-%m-%d'
982 set_default(\%config,'spam_mailbox',$config{spool_dir}.'/../mail/spam/assassinated.%Y-%m-%d');
984 =item spam_crossassassin_mailbox
986 Location to store crossassassinated messages; is run through strftime
987 to allow for %d,%m,%Y, et al. Defaults to
988 'spool_dir/../mail/spam/crossassassinated.%Y-%m-%d'
992 set_default(\%config,'spam_crossassassin_mailbox',$config{spool_dir}.'/../mail/spam/crossassassinated.%Y-%m-%d');
994 =item spam_local_tests_only
996 Whether only local tests are run, defaults to 0
1000 set_default(\%config,'spam_local_tests_only',0);
1002 =item spam_user_prefs
1004 User preferences for spamassassin, defaults to $ENV{HOME}/.spamassassin/user_prefs
1008 set_default(\%config,'spam_user_prefs',"$ENV{HOME}/.spamassassin/user_prefs");
1010 =item spam_rules_dir
1012 Site rules directory for spamassassin, defaults to
1013 '/usr/share/spamassassin'
1017 set_default(\%config,'spam_rules_dir','/usr/share/spamassassin');
1024 The following are the only text fields in general use in the scripts;
1025 a few additional text fields are defined in text.in, but are only used
1026 in db2html and a few other specialty scripts.
1028 Earlier versions of debbugs defined these values in /etc/debbugs/text,
1029 but now they are required to be in the configuration file. [Eventually
1030 the longer ones will move out into a fully fledged template system.]
1036 =item bad_email_prefix
1038 This prefixes the text of all lines in a bad e-mail message ack.
1042 set_default(\%config,'bad_email_prefix','');
1045 =item text_instructions
1047 This gives more information about bad e-mails to receive.in
1051 set_default(\%config,'text_instructions',$config{bad_email_prefix});
1055 This shows up at the end of (most) html pages
1057 In many pages this has been replaced by the html/tail template.
1061 set_default(\%config,'html_tail',<<END);
1062 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
1068 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
1069 Copyright (C) 1999 Darren O. Benham,
1070 1997,2003 nCipher Corporation Ltd,
1071 1994-97 Ian Jackson.
1076 =item html_expire_note
1078 This message explains what happens to archive/remove-able bugs
1082 set_default(\%config,'html_expire_note',
1083 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
1091 my ($conf_file) = @_;
1092 if (not -e $conf_file) {
1093 print STDERR "configuration file '$conf_file' doesn't exist; skipping it\n" if $DEBUG;
1096 # first, figure out what type of file we're reading in.
1097 my $fh = new IO::File $conf_file,'r'
1098 or die "Unable to open configuration file $conf_file for reading: $!";
1099 # A new version configuration file must have a comment as its first line
1100 my $first_line = <$fh>;
1101 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
1102 if (defined $version) {
1103 if ($version == 1) {
1104 # Do something here;
1105 die "Version 1 configuration files not implemented yet";
1108 die "Version $version configuration files are not supported";
1112 # Ugh. Old configuration file
1113 # What we do here is we create a new Safe compartment
1114 # so fucked up crap in the config file doesn't sink us.
1115 my $cpt = new Safe or die "Unable to create safe compartment";
1116 # perldoc Opcode; for details
1117 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
1118 $cpt->reval(qq(require '$conf_file';));
1119 die "Error in configuration file: $@" if $@;
1120 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
1121 # we want to glob in from the configuration file
1122 for my $variable (map {$_ =~ /^(?:config|all)$/ ? () : @{$EXPORT_TAGS{$_}}} keys %EXPORT_TAGS) {
1123 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1124 my $var_glob = $cpt->varglob($glob_name);
1125 my $value; #= $cpt->reval("return $variable");
1126 # print STDERR "$variable $value",qq(\n);
1127 if (defined $var_glob) {{
1129 if ($glob_type eq '%') {
1130 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
1132 elsif ($glob_type eq '@') {
1133 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
1136 $value = ${*{$var_glob}};
1138 # We punt here, because we can't tell if the value was
1139 # defined intentionally, or if it was just left alone;
1140 # this tries to set sane defaults.
1141 set_default(\%config,$hash_name,$value) if defined $value;
1148 my ($variable) = @_;
1149 my $hash_name = $variable;
1150 $hash_name =~ s/^([\$\%\@])g//;
1152 my $glob_name = 'g'.$hash_name;
1153 $hash_name =~ s/(HTML|CGI|CVE)/ucfirst(lc($1))/ge;
1154 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
1155 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
1156 return $hash_name unless wantarray;
1157 return ($hash_name,$glob_name,$glob_type);
1162 # sets the configuration hash to the default value if it's not set,
1163 # otherwise doesn't do anything
1164 # If $USING_GLOBALS, then sets an appropriate global.
1167 my ($config,$option,$value) = @_;
1169 if ($USING_GLOBALS) {
1170 # fix up the variable name
1171 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
1172 # Fix stupid HTML names
1173 $varname =~ s/(Html|Cgi)/uc($1)/ge;
1175 # update the configuration value
1176 if (not $USING_GLOBALS and not exists $config->{$option}) {
1177 $config->{$option} = $value;
1179 elsif ($USING_GLOBALS) {{
1181 # Need to check if a value has already been set in a global
1182 if (defined *{"Debbugs::Config::${varname}"}) {
1183 $config->{$option} = *{"Debbugs::Config::${varname}"};
1186 $config->{$option} = $value;
1189 if ($USING_GLOBALS) {{
1191 *{"Debbugs::Config::${varname}"} = $config->{$option};
1198 # All we care about here is whether we've been called with the globals or text option;
1199 # if so, then we need to export some symbols back up.
1200 # In any event, we call exporter.
1203 if (grep /^:(?:text|globals)$/, @_) {
1205 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
1206 my $tmp = $variable;
1208 # Yes, I don't care if these are only used once
1210 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
1212 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1213 $tmp =~ s/^[\%\$\@]//;
1214 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
1217 Debbugs::Config->export_to_level(1,@_);