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($gPackageTrackingDomain $gUsertagPackageDomain),
51 qw($gSubmitList $gMaintList $gQuietList $gForwardList),
52 qw($gDoneList $gRequestList $gSubmitterList $gControlList),
54 qw($gBugSubscriptionDomain),
55 qw($gPackageVersionRe),
56 qw($gSummaryList $gMirrorList $gMailer $gBug),
57 qw($gBugs $gRemoveAge $gSaveOldBugs $gDefaultSeverity),
58 qw($gShowSeverities $gBounceFroms $gConfigDir $gSpoolDir),
59 qw($gIncomingDir $gWebDir $gDocDir $gMaintainerFile),
60 qw($gMaintainerFileOverride $gPseudoMaintFile $gPseudoDescFile $gPackageSource),
61 qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
62 qw($gVersionTimeIndex),
63 qw($gSimpleVersioning),
65 qw($gSendmail @gSendmailArguments $gLibPath $gSpamScan @gExcludeFromControl),
66 qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
67 qw(%gTagsSingleLetter),
69 qw(%gDistributionAliases),
70 qw(%gObsoleteSeverities),
71 qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
72 qw(@gRemovalStrongSeverityDefaultDistributionTags),
73 qw(@gAffectsDistributionTags),
74 qw(@gDefaultArchitectures),
78 qw($gSpamMaxThreads $gSpamSpamsPerThread $gSpamKeepRunning $gSpamScan $gSpamCrossassassinDb),
80 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
82 cgi => [qw($gLibravatarUri $gLibravatarCacheDir $gLibravatarUriOptions @gLibravatarBlacklist)],
83 config => [qw(%config)],
86 Exporter::export_ok_tags(keys %EXPORT_TAGS);
87 $EXPORT_TAGS{all} = [@EXPORT_OK];
88 $ENV{HOME} = '' if not defined $ENV{HOME};
92 use File::Basename qw(dirname);
96 =head1 CONFIGURATION VARIABLES
98 =head2 General Configuration
106 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
107 # This enables us to test things that are -T.
108 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
109 # This causes all sorts of problems for mirrors of debbugs; disable
111 # if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] == $<) {
112 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
113 $ENV{DEBBUGS_CONFIG_FILE} = $1;
116 # die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
119 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
121 =item email_domain $gEmailDomain
123 The email domain of the bts
127 set_default(\%config,'email_domain','bugs.something');
129 =item list_domain $gListDomain
131 The list domain of the bts, defaults to the email domain
135 set_default(\%config,'list_domain',$config{email_domain});
137 =item web_host $gWebHost
139 The web host of the bts; defaults to the email domain
143 set_default(\%config,'web_host',$config{email_domain});
145 =item web_host_bug_dir $gWebHostDir
147 The directory of the web host on which bugs are kept, defaults to C<''>
151 set_default(\%config,'web_host_bug_dir','');
153 =item web_domain $gWebDomain
155 Full path of the web domain where bugs are kept including the protocol (http://
156 or https://). Defaults to the concatenation of 'http://', L</web_host> and
161 set_default(\%config,'web_domain','http://'.$config{web_host}.($config{web_host}=~m{/$}?'':'/').$config{web_host_bug_dir});
163 =item html_suffix $gHTMLSuffix
165 Suffix of html pages, defaults to .html
169 set_default(\%config,'html_suffix','.html');
171 =item cgi_domain $gCGIDomain
173 Full path of the web domain where cgi scripts are kept. Defaults to
174 the concatentation of L</web_domain> and cgi.
178 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
180 =item mirrors @gMirrors
182 List of mirrors [What these mirrors are used for, no one knows.]
187 set_default(\%config,'mirrors',[]);
189 =item package_pages $gPackagePages
191 Domain where the package pages are kept; links should work in a
192 package_pages/foopackage manner. Defaults to undef, which means that package
193 links will not be made. Should be prefixed with the appropriate protocol
199 set_default(\%config,'package_pages',undef);
201 =item package_tracking_domain $gPackageTrackingDomain
203 Domain where the package pages are kept; links should work in a
204 package_tracking_domain/foopackage manner. Defaults to undef, which means that
205 package links will not be made. Should be prefixed with the appropriate protocol
210 set_default(\%config,'package_tracking_domain',undef);
212 =item package_pages $gUsertagPackageDomain
214 Domain where where usertags of packages belong; defaults to $gPackagePages
218 set_default(\%config,'usertag_package_domain',map {my $a = $_; defined $a?$a =~ s{https?://}{}:(); $a} $config{package_pages});
221 =item subscription_domain $gSubscriptionDomain
223 Domain where subscriptions to package lists happen
227 set_default(\%config,'subscription_domain',undef);
230 =item cc_all_mails_to_addr $gCcAllMailsToAddr
232 Address to Cc (well, Bcc) all e-mails to
236 set_default(\%config,'cc_all_mails_to_addr',undef);
239 =item cve_tracker $gCVETracker
241 URI to CVE security tracker; in bugreport.cgi, CVE-2001-0002 becomes
242 linked to $config{cve_tracker}CVE-2001-002
244 Default: https://security-tracker.debian.org/tracker/
248 set_default(\%config,'cve_tracker','https://security-tracker.debian.org/tracker/');
256 =head2 Project Identification
260 =item project $gProject
268 set_default(\%config,'project','Something');
270 =item project_title $gProjectTitle
272 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
274 Default: "$config{project} Debbugs Install"
278 set_default(\%config,'project_title',"$config{project} Debbugs Install");
280 =item maintainer $gMaintainer
282 Name of the maintainer of this debbugs install
284 Default: 'Local DebBugs Owner's
288 set_default(\%config,'maintainer','Local DebBugs Owner');
290 =item maintainer_webpage $gMaintainerWebpage
292 Webpage of the maintainer of this install of debbugs
294 Default: "$config{web_domain}/~owner"
298 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
300 =item maintainer_email $gMaintainerEmail
302 Email address of the maintainer of this Debbugs install
304 Default: 'root@'.$config{email_domain}
308 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
310 =item unknown_maintainer_email
312 Email address where packages with an unknown maintainer will be sent
314 Default: $config{maintainer_email}
318 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
322 The name of the machine that this instance of debbugs is running on
323 (currently used for debbuging purposes and web page output.)
325 Default: Sys::Hostname::hostname()
331 set_default(\%config,'machine_name',Sys::Hostname::hostname());
333 =head2 BTS Mailing Lists
360 set_default(\%config, 'submit_list', 'bug-submit-list');
361 set_default(\%config, 'maint_list', 'bug-maint-list');
362 set_default(\%config, 'quiet_list', 'bug-quiet-list');
363 set_default(\%config, 'forward_list', 'bug-forward-list');
364 set_default(\%config, 'done_list', 'bug-done-list');
365 set_default(\%config, 'request_list', 'bug-request-list');
366 set_default(\%config,'submitter_list','bug-submitter-list');
367 set_default(\%config, 'control_list', 'bug-control-list');
368 set_default(\%config, 'summary_list', 'bug-summary-list');
369 set_default(\%config, 'mirror_list', 'bug-mirror-list');
370 set_default(\%config, 'strong_list', 'bug-strong-list');
372 =item bug_subscription_domain
374 Domain of list for messages regarding a single bug; prefixed with
375 bug=${bugnum}@ when bugs are actually sent out. Set to undef or '' to
376 disable sending messages to the bug subscription list.
384 set_default(\%config,'bug_subscription_domain',$config{list_domain});
394 Name of the mailer to use
400 set_default(\%config,'mailer','exim');
409 Default: ucfirst($config{bug});
417 Default: ucfirst($config{ubugs});
421 set_default(\%config,'bug','bug');
422 set_default(\%config,'ubug',ucfirst($config{bug}));
423 set_default(\%config,'bugs','bugs');
424 set_default(\%config,'ubugs',ucfirst($config{bugs}));
428 Age at which bugs are archived/removed
434 set_default(\%config,'remove_age',28);
438 Whether old bugs are saved or deleted
444 set_default(\%config,'save_old_bugs',1);
446 =item distribution_aliases
448 Map of distribution aliases to the distribution name
451 {experimental => 'experimental',
452 unstable => 'unstable',
453 testing => 'testing',
455 oldstable => 'oldstable',
459 sarge => 'oldstable',
464 set_default(\%config,'distribution_aliases',
465 {experimental => 'experimental',
466 unstable => 'unstable',
467 testing => 'testing',
469 oldstable => 'oldstable',
473 sarge => 'oldstable',
481 List of valid distributions
483 Default: The values of the distribution aliases map.
487 my %_distributions_default;
488 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
489 set_default(\%config,'distributions',[keys %_distributions_default]);
492 =item default_architectures
494 List of default architectures to use when architecture(s) are not
497 Default: i386 amd64 arm ppc sparc alpha
501 set_default(\%config,'default_architectures',
502 [qw(i386 amd64 arm powerpc sparc alpha)]
505 =item affects_distribution_tags
507 List of tags which restrict the buggy state to a set of distributions.
509 The set of distributions that are buggy is the intersection of the set
510 of distributions that would be buggy without reference to these tags
511 and the set of these tags that are distributions which are set on a
514 Setting this to [] will remove this feature.
516 Default: @{$config{distributions}}
520 set_default(\%config,'affects_distribution_tags',
521 [@{$config{distributions}}],
524 =item removal_unremovable_tags
526 Bugs which have these tags set cannot be archived
532 set_default(\%config,'removal_unremovable_tags',
536 =item removal_distribution_tags
538 Tags which specifiy distributions to check
540 Default: @{$config{distributions}}
544 set_default(\%config,'removal_distribution_tags',
545 [@{$config{distributions}}]);
547 =item removal_default_distribution_tags
549 For removal/archival purposes, all bugs are assumed to have these tags
552 Default: qw(experimental unstable testing);
556 set_default(\%config,'removal_default_distribution_tags',
557 [qw(experimental unstable testing)]
560 =item removal_strong_severity_default_distribution_tags
562 For removal/archival purposes, all bugs with strong severity are
563 assumed to have these tags set.
565 Default: qw(experimental unstable testing stable);
569 set_default(\%config,'removal_strong_severity_default_distribution_tags',
570 [qw(experimental unstable testing stable)]
574 =item removal_architectures
576 For removal/archival purposes, these architectures are consulted if
577 there is more than one architecture applicable. If the bug is in a
578 package not in any of these architectures, the architecture actually
579 checked is undefined.
581 Default: value of default_architectures
585 set_default(\%config,'removal_architectures',
586 $config{default_architectures},
590 =item package_name_re
592 The regex which will match a package name
594 Default: '[a-z0-9][a-z0-9\.+-]+'
598 set_default(\%config,'package_name_re',
599 '[a-z0-9][a-z0-9\.+-]+');
601 =item package_version_re
603 The regex which will match a package version
605 Default: '[A-Za-z0-9:+\.-]+'
610 set_default(\%config,'package_version_re',
611 '[A-Za-z0-9:+\.~-]+');
614 =item default_package
616 This is the name of the default package. If set, bugs assigned to
617 packages without a maintainer and bugs missing a Package: psuedoheader
618 will be assigned to this package instead.
620 Defaults to unset, which is the traditional debbugs behavoir
624 set_default(\%config,'default_package',
629 =item control_internal_requester
631 This address is used by Debbugs::Control as the request address which
632 sent a control request for faked log messages.
634 Default:"Debbugs Internal Request <$config{maintainer_email}>"
638 set_default(\%config,'control_internal_requester',
639 "Debbugs Internal Request <$config{maintainer_email}>",
642 =item control_internal_request_addr
644 This address is used by Debbugs::Control as the address to which a
645 faked log message request was sent.
647 Default: "internal_control\@$config{email_domain}";
651 set_default(\%config,'control_internal_request_addr',
652 'internal_control@'.$config{email_domain},
656 =item exclude_from_control
658 Addresses which are not allowed to send messages to control
662 set_default(\%config,'exclude_from_control',[]);
666 =item default_severity
668 The default severity of bugs which have no severity set
674 set_default(\%config,'default_severity','normal');
676 =item severity_display
678 A hashref of severities and the informative text which describes them.
682 {critical => "Critical $config{bugs}",
683 grave => "Grave $config{bugs}",
684 normal => "Normal $config{bugs}",
685 wishlist => "Wishlist $config{bugs}",
690 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
691 grave => "Grave $config{bugs}",
692 serious => "Serious $config{bugs}",
693 important=> "Important $config{bugs}",
694 normal => "Normal $config{bugs}",
695 minor => "Minor $config{bugs}",
696 wishlist => "Wishlist $config{bugs}",
699 =item show_severities
701 A scalar list of the severities to show
703 Defaults to the concatenation of the keys of the severity_display
704 hashlist with ', ' above.
708 set_default(\%config,'show_severities',join(', ',keys %{$config{severity_display}}));
710 =item strong_severities
712 An arrayref of the serious severities which shoud be emphasized
714 Default: [qw(critical grave)]
718 set_default(\%config,'strong_severities',[qw(critical grave)]);
722 An arrayref of a list of the severities
724 Defaults to the keys of the severity display hashref
728 set_default(\%config,'severity_list',[keys %{$config{severity_display}}]);
730 =item obsolete_severities
732 A hashref of obsolete severities with the replacing severity
738 set_default(\%config,'obsolete_severities',{});
742 An arrayref of the tags used
744 Default: [qw(patch wontfix moreinfo unreproducible fixed)] and also
745 includes the distributions.
749 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
750 @{$config{distributions}}
753 set_default(\%config,'tags_single_letter',
757 unreproducible => 'R',
762 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
763 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
764 '^mail.*agent|^tcpmail|^bitmail|^mailman');
766 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
767 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
771 Directory which contains the usertags
773 Default: $config{spool_dir}/user
777 set_default(\%config,'usertag_dir',$config{spool_dir}.'/user');
778 set_default(\%config,'incoming_dir','incoming');
780 =item web_dir $gWebDir
782 Directory where base html files are kept. Should normally be the same
783 as the web server's document root.
785 Default: /var/lib/debbugs/www
789 set_default(\%config,'web_dir','/var/lib/debbugs/www');
790 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
791 set_default(\%config,'lib_path','/usr/lib/debbugs');
796 directory of templates; defaults to /usr/share/debbugs/templates.
800 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
803 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
804 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
805 set_default(\%config,'source_maintainer_file',$config{config_dir}.'/Source_maintainers');
806 set_default(\%config,'source_maintainer_file_override',undef);
807 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maintainers');
808 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
809 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
812 =item simple_versioning
814 If true this causes debbugs to ignore version information and just
815 look at whether a bug is done or not done. Primarily of interest for
816 debbugs installs which don't track versions. defaults to false.
820 set_default(\%config,'simple_versioning',0);
823 =item version_packages_dir
825 Location where the version package information is kept; defaults to
826 spool_dir/../versions/pkg
830 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
832 =item version_time_index
834 Location of the version/time index file. Defaults to
835 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
836 exists; otherwise defaults to undef.
841 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
845 Location of the version index file. Defaults to
846 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
847 exists; otherwise defaults to undef.
851 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
853 =item binary_source_map
855 Location of the binary -> source map. Defaults to
856 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
857 exists; otherwise defaults to undef.
861 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
863 =item source_binary_map
865 Location of the source -> binary map. Defaults to
866 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
867 exists; otherwise defaults to undef.
871 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
875 set_default(\%config,'post_processall',[]);
879 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
883 set_default(\%config,'sendmail','/usr/lib/sendmail');
885 =item sendmail_arguments
887 Default arguments to pass to sendmail. Defaults to C<qw(-oem -oi)>.
891 set_default(\%config,'sendmail_arguments',[qw(-oem -oi)]);
895 Envelope from to use for sent messages. If not set, whatever sendmail picks is
900 set_default(\%config,'envelope_from',undef);
904 Whether or not spamscan is being used; defaults to 0 (not being used
908 set_default(\%config,'spam_scan',0);
910 =item spam_crossassassin_db
912 Location of the crosassassin database, defaults to
913 spool_dir/../CrossAssassinDb
917 set_default(\%config,'spam_crossassassin_db',$config{spool_dir}.'/../CrossAssassinDb');
921 Maximum number of cross-posted messages
925 set_default(\%config,'spam_max_cross',6);
928 =item spam_spams_per_thread
930 Number of spams for each thread (on average). Defaults to 200
934 set_default(\%config,'spam_spams_per_thread',200);
936 =item spam_max_threads
938 Maximum number of threads to start. Defaults to 20
942 set_default(\%config,'spam_max_threads',20);
944 =item spam_keep_running
946 Maximum number of seconds to run without restarting. Defaults to 3600.
950 set_default(\%config,'spam_keep_running',3600);
954 Location to store spam messages; is run through strftime to allow for
955 %d,%m,%Y, et al. Defaults to 'spool_dir/../mail/spam/assassinated.%Y-%m-%d'
959 set_default(\%config,'spam_mailbox',$config{spool_dir}.'/../mail/spam/assassinated.%Y-%m-%d');
961 =item spam_crossassassin_mailbox
963 Location to store crossassassinated messages; is run through strftime
964 to allow for %d,%m,%Y, et al. Defaults to
965 'spool_dir/../mail/spam/crossassassinated.%Y-%m-%d'
969 set_default(\%config,'spam_crossassassin_mailbox',$config{spool_dir}.'/../mail/spam/crossassassinated.%Y-%m-%d');
971 =item spam_local_tests_only
973 Whether only local tests are run, defaults to 0
977 set_default(\%config,'spam_local_tests_only',0);
979 =item spam_user_prefs
981 User preferences for spamassassin, defaults to $ENV{HOME}/.spamassassin/user_prefs
985 set_default(\%config,'spam_user_prefs',"$ENV{HOME}/.spamassassin/user_prefs");
989 Site rules directory for spamassassin, defaults to
990 '/usr/share/spamassassin'
994 set_default(\%config,'spam_rules_dir','/usr/share/spamassassin');
1002 =item libravatar_uri $gLibravatarUri
1004 URI to a libravatar configuration. If empty or undefined, libravatar
1005 support will be disabled. Defaults to
1006 libravatar.cgi, our internal federated libravatar system.
1010 set_default(\%config,'libravatar_uri',$config{cgi_domain}.'/libravatar.cgi?email=');
1012 =item libravatar_uri_options $gLibravatarUriOptions
1014 Options to append to the md5_hex of the e-mail. This sets the default
1015 avatar used when an avatar isn't available. Currently defaults to
1016 '?d=retro', which causes a bitmap-looking avatar to be displayed for
1019 Other options which make sense include ?d=404, ?d=wavatar, etc. See
1020 the API of libravatar for details.
1024 set_default(\%config,'libravatar_uri_options','');
1026 =item libravatar_default_image
1028 Default image to serve for libravatar if there is no avatar for an
1029 e-mail address. By default, this is a 1x1 png. [This will also be the
1030 image served if someone specifies avatar=no.]
1032 Default: $config{web_dir}/1x1.png
1036 set_default(\%config,'libravatar_default_image',$config{web_dir}.'/1x1.png');
1038 =item libravatar_cache_dir
1040 Directory where cached libravatar images are stored
1042 Default: $config{web_dir}/libravatar/
1046 set_default(\%config,'libravatar_cache_dir',$config{web_dir}.'/libravatar/');
1048 =item libravatar_blacklist
1050 Array of regular expressions to match against emails, domains, or
1051 images to only show the default image
1053 Default: empty array
1057 set_default(\%config,'libravatar_blacklist',[]);
1063 The following are the only text fields in general use in the scripts;
1064 a few additional text fields are defined in text.in, but are only used
1065 in db2html and a few other specialty scripts.
1067 Earlier versions of debbugs defined these values in /etc/debbugs/text,
1068 but now they are required to be in the configuration file. [Eventually
1069 the longer ones will move out into a fully fledged template system.]
1075 =item bad_email_prefix
1077 This prefixes the text of all lines in a bad e-mail message ack.
1081 set_default(\%config,'bad_email_prefix','');
1084 =item text_instructions
1086 This gives more information about bad e-mails to receive.in
1090 set_default(\%config,'text_instructions',$config{bad_email_prefix});
1094 This shows up at the end of (most) html pages
1096 In many pages this has been replaced by the html/tail template.
1100 set_default(\%config,'html_tail',<<END);
1101 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
1107 <A HREF=\"$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
1108 Copyright (C) 1999 Darren O. Benham,
1109 1997,2003 nCipher Corporation Ltd,
1110 1994-97 Ian Jackson.
1116 =item html_expire_note
1118 This message explains what happens to archive/remove-able bugs
1122 set_default(\%config,'html_expire_note',
1123 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
1131 my ($conf_file) = @_;
1132 if (not -e $conf_file) {
1133 print STDERR "configuration file '$conf_file' doesn't exist; skipping it\n" if $DEBUG;
1136 # first, figure out what type of file we're reading in.
1137 my $fh = new IO::File $conf_file,'r'
1138 or die "Unable to open configuration file $conf_file for reading: $!";
1139 # A new version configuration file must have a comment as its first line
1140 my $first_line = <$fh>;
1141 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
1142 if (defined $version) {
1143 if ($version == 1) {
1144 # Do something here;
1145 die "Version 1 configuration files not implemented yet";
1148 die "Version $version configuration files are not supported";
1152 # Ugh. Old configuration file
1153 # What we do here is we create a new Safe compartment
1154 # so fucked up crap in the config file doesn't sink us.
1155 my $cpt = new Safe or die "Unable to create safe compartment";
1156 # perldoc Opcode; for details
1157 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
1158 $cpt->reval(qq(require '$conf_file';));
1159 die "Error in configuration file: $@" if $@;
1160 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
1161 # we want to glob in from the configuration file
1162 for my $variable (map {$_ =~ /^(?:config|all)$/ ? () : @{$EXPORT_TAGS{$_}}} keys %EXPORT_TAGS) {
1163 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1164 my $var_glob = $cpt->varglob($glob_name);
1165 my $value; #= $cpt->reval("return $variable");
1166 # print STDERR "$variable $value",qq(\n);
1167 if (defined $var_glob) {{
1169 if ($glob_type eq '%') {
1170 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
1172 elsif ($glob_type eq '@') {
1173 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
1176 $value = ${*{$var_glob}};
1178 # We punt here, because we can't tell if the value was
1179 # defined intentionally, or if it was just left alone;
1180 # this tries to set sane defaults.
1181 set_default(\%config,$hash_name,$value) if defined $value;
1188 my ($variable) = @_;
1189 my $hash_name = $variable;
1190 $hash_name =~ s/^([\$\%\@])g//;
1192 my $glob_name = 'g'.$hash_name;
1193 $hash_name =~ s/(HTML|CGI|CVE)/ucfirst(lc($1))/ge;
1194 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
1195 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
1196 return $hash_name unless wantarray;
1197 return ($hash_name,$glob_name,$glob_type);
1202 # sets the configuration hash to the default value if it's not set,
1203 # otherwise doesn't do anything
1204 # If $USING_GLOBALS, then sets an appropriate global.
1207 my ($config,$option,$value) = @_;
1209 if ($USING_GLOBALS) {
1210 # fix up the variable name
1211 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
1212 # Fix stupid HTML names
1213 $varname =~ s/(Html|Cgi)/uc($1)/ge;
1215 # update the configuration value
1216 if (not $USING_GLOBALS and not exists $config->{$option}) {
1217 $config->{$option} = $value;
1219 elsif ($USING_GLOBALS) {{
1221 # Need to check if a value has already been set in a global
1222 if (defined *{"Debbugs::Config::${varname}"}) {
1223 $config->{$option} = *{"Debbugs::Config::${varname}"};
1226 $config->{$option} = $value;
1229 if ($USING_GLOBALS) {{
1231 *{"Debbugs::Config::${varname}"} = $config->{$option};
1238 # All we care about here is whether we've been called with the globals or text option;
1239 # if so, then we need to export some symbols back up.
1240 # In any event, we call exporter.
1243 if (grep /^:(?:text|globals)$/, @_) {
1245 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
1246 my $tmp = $variable;
1248 # Yes, I don't care if these are only used once
1250 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
1252 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1253 $tmp =~ s/^[\%\$\@]//;
1254 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
1257 Debbugs::Config->export_to_level(1,@_);