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),
81 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
83 cgi => [qw($gLibravatarUri $gLibravatarCacheDir $gLibravatarUriOptions @gLibravatarBlacklist)],
84 config => [qw(%config)],
87 Exporter::export_ok_tags(keys %EXPORT_TAGS);
88 $EXPORT_TAGS{all} = [@EXPORT_OK];
89 $ENV{HOME} = '' if not defined $ENV{HOME};
93 use File::Basename qw(dirname);
97 =head1 CONFIGURATION VARIABLES
99 =head2 General Configuration
107 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
108 # This enables us to test things that are -T.
109 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
110 # This causes all sorts of problems for mirrors of debbugs; disable
112 # if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] == $<) {
113 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
114 $ENV{DEBBUGS_CONFIG_FILE} = $1;
117 # die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
120 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
122 =item email_domain $gEmailDomain
124 The email domain of the bts
128 set_default(\%config,'email_domain','bugs.something');
130 =item list_domain $gListDomain
132 The list domain of the bts, defaults to the email domain
136 set_default(\%config,'list_domain',$config{email_domain});
138 =item web_host $gWebHost
140 The web host of the bts; defaults to the email domain
144 set_default(\%config,'web_host',$config{email_domain});
146 =item web_host_bug_dir $gWebHostDir
148 The directory of the web host on which bugs are kept, defaults to C<''>
152 set_default(\%config,'web_host_bug_dir','');
154 =item web_domain $gWebDomain
156 Full path of the web domain where bugs are kept including the protocol (http://
157 or https://). Defaults to the concatenation of 'http://', L</web_host> and
162 set_default(\%config,'web_domain','http://'.$config{web_host}.($config{web_host}=~m{/$}?'':'/').$config{web_host_bug_dir});
164 =item html_suffix $gHTMLSuffix
166 Suffix of html pages, defaults to .html
170 set_default(\%config,'html_suffix','.html');
172 =item cgi_domain $gCGIDomain
174 Full path of the web domain where cgi scripts are kept. Defaults to
175 the concatentation of L</web_domain> and cgi.
179 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
181 =item mirrors @gMirrors
183 List of mirrors [What these mirrors are used for, no one knows.]
188 set_default(\%config,'mirrors',[]);
190 =item package_pages $gPackagePages
192 Domain where the package pages are kept; links should work in a
193 package_pages/foopackage manner. Defaults to undef, which means that package
194 links will not be made. Should be prefixed with the appropriate protocol
200 set_default(\%config,'package_pages',undef);
202 =item package_tracking_domain $gPackageTrackingDomain
204 Domain where the package pages are kept; links should work in a
205 package_tracking_domain/foopackage manner. Defaults to undef, which means that
206 package links will not be made. Should be prefixed with the appropriate protocol
211 set_default(\%config,'package_tracking_domain',undef);
213 =item package_pages $gUsertagPackageDomain
215 Domain where where usertags of packages belong; defaults to $gPackagePages
219 set_default(\%config,'usertag_package_domain',map {my $a = $_; defined $a?$a =~ s{https?://}{}:(); $a} $config{package_pages});
222 =item subscription_domain $gSubscriptionDomain
224 Domain where subscriptions to package lists happen
228 set_default(\%config,'subscription_domain',undef);
231 =item cc_all_mails_to_addr $gCcAllMailsToAddr
233 Address to Cc (well, Bcc) all e-mails to
237 set_default(\%config,'cc_all_mails_to_addr',undef);
240 =item cve_tracker $gCVETracker
242 URI to CVE security tracker; in bugreport.cgi, CVE-2001-0002 becomes
243 linked to $config{cve_tracker}CVE-2001-002
245 Default: https://security-tracker.debian.org/tracker/
249 set_default(\%config,'cve_tracker','https://security-tracker.debian.org/tracker/');
257 =head2 Project Identification
261 =item project $gProject
269 set_default(\%config,'project','Something');
271 =item project_title $gProjectTitle
273 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
275 Default: "$config{project} Debbugs Install"
279 set_default(\%config,'project_title',"$config{project} Debbugs Install");
281 =item maintainer $gMaintainer
283 Name of the maintainer of this debbugs install
285 Default: 'Local DebBugs Owner's
289 set_default(\%config,'maintainer','Local DebBugs Owner');
291 =item maintainer_webpage $gMaintainerWebpage
293 Webpage of the maintainer of this install of debbugs
295 Default: "$config{web_domain}/~owner"
299 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
301 =item maintainer_email $gMaintainerEmail
303 Email address of the maintainer of this Debbugs install
305 Default: 'root@'.$config{email_domain}
309 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
311 =item unknown_maintainer_email
313 Email address where packages with an unknown maintainer will be sent
315 Default: $config{maintainer_email}
319 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
323 The name of the machine that this instance of debbugs is running on
324 (currently used for debbuging purposes and web page output.)
326 Default: Sys::Hostname::hostname()
332 set_default(\%config,'machine_name',Sys::Hostname::hostname());
334 =head2 BTS Mailing Lists
361 set_default(\%config, 'submit_list', 'bug-submit-list');
362 set_default(\%config, 'maint_list', 'bug-maint-list');
363 set_default(\%config, 'quiet_list', 'bug-quiet-list');
364 set_default(\%config, 'forward_list', 'bug-forward-list');
365 set_default(\%config, 'done_list', 'bug-done-list');
366 set_default(\%config, 'request_list', 'bug-request-list');
367 set_default(\%config,'submitter_list','bug-submitter-list');
368 set_default(\%config, 'control_list', 'bug-control-list');
369 set_default(\%config, 'summary_list', 'bug-summary-list');
370 set_default(\%config, 'mirror_list', 'bug-mirror-list');
371 set_default(\%config, 'strong_list', 'bug-strong-list');
373 =item bug_subscription_domain
375 Domain of list for messages regarding a single bug; prefixed with
376 bug=${bugnum}@ when bugs are actually sent out. Set to undef or '' to
377 disable sending messages to the bug subscription list.
385 set_default(\%config,'bug_subscription_domain',$config{list_domain});
395 Name of the mailer to use
401 set_default(\%config,'mailer','exim');
410 Default: ucfirst($config{bug});
418 Default: ucfirst($config{ubugs});
422 set_default(\%config,'bug','bug');
423 set_default(\%config,'ubug',ucfirst($config{bug}));
424 set_default(\%config,'bugs','bugs');
425 set_default(\%config,'ubugs',ucfirst($config{bugs}));
429 Age at which bugs are archived/removed
435 set_default(\%config,'remove_age',28);
439 Whether old bugs are saved or deleted
445 set_default(\%config,'save_old_bugs',1);
447 =item distribution_aliases
449 Map of distribution aliases to the distribution name
452 {experimental => 'experimental',
453 unstable => 'unstable',
454 testing => 'testing',
456 oldstable => 'oldstable',
460 sarge => 'oldstable',
465 set_default(\%config,'distribution_aliases',
466 {experimental => 'experimental',
467 unstable => 'unstable',
468 testing => 'testing',
470 oldstable => 'oldstable',
474 sarge => 'oldstable',
482 List of valid distributions
484 Default: The values of the distribution aliases map.
488 my %_distributions_default;
489 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
490 set_default(\%config,'distributions',[keys %_distributions_default]);
493 =item default_architectures
495 List of default architectures to use when architecture(s) are not
498 Default: i386 amd64 arm ppc sparc alpha
502 set_default(\%config,'default_architectures',
503 [qw(i386 amd64 arm powerpc sparc alpha)]
506 =item affects_distribution_tags
508 List of tags which restrict the buggy state to a set of distributions.
510 The set of distributions that are buggy is the intersection of the set
511 of distributions that would be buggy without reference to these tags
512 and the set of these tags that are distributions which are set on a
515 Setting this to [] will remove this feature.
517 Default: @{$config{distributions}}
521 set_default(\%config,'affects_distribution_tags',
522 [@{$config{distributions}}],
525 =item removal_unremovable_tags
527 Bugs which have these tags set cannot be archived
533 set_default(\%config,'removal_unremovable_tags',
537 =item removal_distribution_tags
539 Tags which specifiy distributions to check
541 Default: @{$config{distributions}}
545 set_default(\%config,'removal_distribution_tags',
546 [@{$config{distributions}}]);
548 =item removal_default_distribution_tags
550 For removal/archival purposes, all bugs are assumed to have these tags
553 Default: qw(experimental unstable testing);
557 set_default(\%config,'removal_default_distribution_tags',
558 [qw(experimental unstable testing)]
561 =item removal_strong_severity_default_distribution_tags
563 For removal/archival purposes, all bugs with strong severity are
564 assumed to have these tags set.
566 Default: qw(experimental unstable testing stable);
570 set_default(\%config,'removal_strong_severity_default_distribution_tags',
571 [qw(experimental unstable testing stable)]
575 =item removal_architectures
577 For removal/archival purposes, these architectures are consulted if
578 there is more than one architecture applicable. If the bug is in a
579 package not in any of these architectures, the architecture actually
580 checked is undefined.
582 Default: value of default_architectures
586 set_default(\%config,'removal_architectures',
587 $config{default_architectures},
591 =item package_name_re
593 The regex which will match a package name
595 Default: '[a-z0-9][a-z0-9\.+-]+'
599 set_default(\%config,'package_name_re',
600 '[a-z0-9][a-z0-9\.+-]+');
602 =item package_version_re
604 The regex which will match a package version
606 Default: '[A-Za-z0-9:+\.-]+'
611 set_default(\%config,'package_version_re',
612 '[A-Za-z0-9:+\.~-]+');
615 =item default_package
617 This is the name of the default package. If set, bugs assigned to
618 packages without a maintainer and bugs missing a Package: psuedoheader
619 will be assigned to this package instead.
621 Defaults to unset, which is the traditional debbugs behavoir
625 set_default(\%config,'default_package',
630 =item control_internal_requester
632 This address is used by Debbugs::Control as the request address which
633 sent a control request for faked log messages.
635 Default:"Debbugs Internal Request <$config{maintainer_email}>"
639 set_default(\%config,'control_internal_requester',
640 "Debbugs Internal Request <$config{maintainer_email}>",
643 =item control_internal_request_addr
645 This address is used by Debbugs::Control as the address to which a
646 faked log message request was sent.
648 Default: "internal_control\@$config{email_domain}";
652 set_default(\%config,'control_internal_request_addr',
653 'internal_control@'.$config{email_domain},
657 =item exclude_from_control
659 Addresses which are not allowed to send messages to control
663 set_default(\%config,'exclude_from_control',[]);
667 =item default_severity
669 The default severity of bugs which have no severity set
675 set_default(\%config,'default_severity','normal');
677 =item severity_display
679 A hashref of severities and the informative text which describes them.
683 {critical => "Critical $config{bugs}",
684 grave => "Grave $config{bugs}",
685 normal => "Normal $config{bugs}",
686 wishlist => "Wishlist $config{bugs}",
691 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
692 grave => "Grave $config{bugs}",
693 serious => "Serious $config{bugs}",
694 important=> "Important $config{bugs}",
695 normal => "Normal $config{bugs}",
696 minor => "Minor $config{bugs}",
697 wishlist => "Wishlist $config{bugs}",
700 =item show_severities
702 A scalar list of the severities to show
704 Defaults to the concatenation of the keys of the severity_display
705 hashlist with ', ' above.
709 set_default(\%config,'show_severities',join(', ',keys %{$config{severity_display}}));
711 =item strong_severities
713 An arrayref of the serious severities which shoud be emphasized
715 Default: [qw(critical grave)]
719 set_default(\%config,'strong_severities',[qw(critical grave)]);
723 An arrayref of a list of the severities
725 Defaults to the keys of the severity display hashref
729 set_default(\%config,'severity_list',[keys %{$config{severity_display}}]);
731 =item obsolete_severities
733 A hashref of obsolete severities with the replacing severity
739 set_default(\%config,'obsolete_severities',{});
743 An arrayref of the tags used
745 Default: [qw(patch wontfix moreinfo unreproducible fixed)] and also
746 includes the distributions.
750 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
751 @{$config{distributions}}
754 set_default(\%config,'tags_single_letter',
758 unreproducible => 'R',
763 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
764 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
765 '^mail.*agent|^tcpmail|^bitmail|^mailman');
767 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
768 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
772 Directory which contains the usertags
774 Default: $config{spool_dir}/user
778 set_default(\%config,'usertag_dir',$config{spool_dir}.'/user');
779 set_default(\%config,'incoming_dir','incoming');
781 =item web_dir $gWebDir
783 Directory where base html files are kept. Should normally be the same
784 as the web server's document root.
786 Default: /var/lib/debbugs/www
790 set_default(\%config,'web_dir','/var/lib/debbugs/www');
791 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
792 set_default(\%config,'lib_path','/usr/lib/debbugs');
797 directory of templates; defaults to /usr/share/debbugs/templates.
801 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
804 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
805 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
806 set_default(\%config,'source_maintainer_file',$config{config_dir}.'/Source_maintainers');
807 set_default(\%config,'source_maintainer_file_override',undef);
808 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maintainers');
809 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
810 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
813 =item simple_versioning
815 If true this causes debbugs to ignore version information and just
816 look at whether a bug is done or not done. Primarily of interest for
817 debbugs installs which don't track versions. defaults to false.
821 set_default(\%config,'simple_versioning',0);
824 =item version_packages_dir
826 Location where the version package information is kept; defaults to
827 spool_dir/../versions/pkg
831 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
833 =item version_time_index
835 Location of the version/time index file. Defaults to
836 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
837 exists; otherwise defaults to undef.
842 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
846 Location of the version index file. Defaults to
847 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
848 exists; otherwise defaults to undef.
852 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
854 =item binary_source_map
856 Location of the binary -> source map. Defaults to
857 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
858 exists; otherwise defaults to undef.
862 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
864 =item source_binary_map
866 Location of the source -> binary map. Defaults to
867 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
868 exists; otherwise defaults to undef.
872 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
876 set_default(\%config,'post_processall',[]);
880 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
884 set_default(\%config,'sendmail','/usr/lib/sendmail');
886 =item sendmail_arguments
888 Default arguments to pass to sendmail. Defaults to C<qw(-oem -oi)>.
892 set_default(\%config,'sendmail_arguments',[qw(-oem -oi)]);
896 Envelope from to use for sent messages. If not set, whatever sendmail picks is
901 set_default(\%config,'envelope_from',undef);
905 Whether or not spamscan is being used; defaults to 0 (not being used
909 set_default(\%config,'spam_scan',0);
911 =item spam_crossassassin_db
913 Location of the crosassassin database, defaults to
914 spool_dir/../CrossAssassinDb
918 set_default(\%config,'spam_crossassassin_db',$config{spool_dir}.'/../CrossAssassinDb');
922 Maximum number of cross-posted messages
926 set_default(\%config,'spam_max_cross',6);
929 =item spam_spams_per_thread
931 Number of spams for each thread (on average). Defaults to 200
935 set_default(\%config,'spam_spams_per_thread',200);
937 =item spam_max_threads
939 Maximum number of threads to start. Defaults to 20
943 set_default(\%config,'spam_max_threads',20);
945 =item spam_keep_running
947 Maximum number of seconds to run without restarting. Defaults to 3600.
951 set_default(\%config,'spam_keep_running',3600);
955 Location to store spam messages; is run through strftime to allow for
956 %d,%m,%Y, et al. Defaults to 'spool_dir/../mail/spam/assassinated.%Y-%m-%d'
960 set_default(\%config,'spam_mailbox',$config{spool_dir}.'/../mail/spam/assassinated.%Y-%m-%d');
962 =item spam_crossassassin_mailbox
964 Location to store crossassassinated messages; is run through strftime
965 to allow for %d,%m,%Y, et al. Defaults to
966 'spool_dir/../mail/spam/crossassassinated.%Y-%m-%d'
970 set_default(\%config,'spam_crossassassin_mailbox',$config{spool_dir}.'/../mail/spam/crossassassinated.%Y-%m-%d');
972 =item spam_local_tests_only
974 Whether only local tests are run, defaults to 0
978 set_default(\%config,'spam_local_tests_only',0);
980 =item spam_user_prefs
982 User preferences for spamassassin, defaults to $ENV{HOME}/.spamassassin/user_prefs
986 set_default(\%config,'spam_user_prefs',"$ENV{HOME}/.spamassassin/user_prefs");
990 Site rules directory for spamassassin, defaults to
991 '/usr/share/spamassassin'
995 set_default(\%config,'spam_rules_dir','/usr/share/spamassassin');
1003 =item libravatar_uri $gLibravatarUri
1005 URI to a libravatar configuration. If empty or undefined, libravatar
1006 support will be disabled. Defaults to
1007 libravatar.cgi, our internal federated libravatar system.
1011 set_default(\%config,'libravatar_uri',$config{cgi_domain}.'/libravatar.cgi?email=');
1013 =item libravatar_uri_options $gLibravatarUriOptions
1015 Options to append to the md5_hex of the e-mail. This sets the default
1016 avatar used when an avatar isn't available. Currently defaults to
1017 '?d=retro', which causes a bitmap-looking avatar to be displayed for
1020 Other options which make sense include ?d=404, ?d=wavatar, etc. See
1021 the API of libravatar for details.
1025 set_default(\%config,'libravatar_uri_options','');
1027 =item libravatar_default_image
1029 Default image to serve for libravatar if there is no avatar for an
1030 e-mail address. By default, this is a 1x1 png. [This will also be the
1031 image served if someone specifies avatar=no.]
1033 Default: $config{web_dir}/1x1.png
1037 set_default(\%config,'libravatar_default_image',$config{web_dir}.'/1x1.png');
1039 =item libravatar_cache_dir
1041 Directory where cached libravatar images are stored
1043 Default: $config{web_dir}/libravatar/
1047 set_default(\%config,'libravatar_cache_dir',$config{web_dir}.'/libravatar/');
1049 =item libravatar_blacklist
1051 Array of regular expressions to match against emails, domains, or
1052 images to only show the default image
1054 Default: empty array
1058 set_default(\%config,'libravatar_blacklist',[]);
1068 Name of debbugs PostgreSQL database service. If you wish to not use a service
1069 file, provide a full DBD::Pg compliant data-source, for example:
1070 C<"dbi:Pg:dbname=dbname">
1076 set_default(\%config,'database',undef);
1080 The following are the only text fields in general use in the scripts;
1081 a few additional text fields are defined in text.in, but are only used
1082 in db2html and a few other specialty scripts.
1084 Earlier versions of debbugs defined these values in /etc/debbugs/text,
1085 but now they are required to be in the configuration file. [Eventually
1086 the longer ones will move out into a fully fledged template system.]
1092 =item bad_email_prefix
1094 This prefixes the text of all lines in a bad e-mail message ack.
1098 set_default(\%config,'bad_email_prefix','');
1101 =item text_instructions
1103 This gives more information about bad e-mails to receive.in
1107 set_default(\%config,'text_instructions',$config{bad_email_prefix});
1111 This shows up at the end of (most) html pages
1113 In many pages this has been replaced by the html/tail template.
1117 set_default(\%config,'html_tail',<<END);
1118 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
1124 <A HREF=\"$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
1125 Copyright (C) 1999 Darren O. Benham,
1126 1997,2003 nCipher Corporation Ltd,
1127 1994-97 Ian Jackson.
1133 =item html_expire_note
1135 This message explains what happens to archive/remove-able bugs
1139 set_default(\%config,'html_expire_note',
1140 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
1148 my ($conf_file) = @_;
1149 if (not -e $conf_file) {
1150 print STDERR "configuration file '$conf_file' doesn't exist; skipping it\n" if $DEBUG;
1153 # first, figure out what type of file we're reading in.
1154 my $fh = new IO::File $conf_file,'r'
1155 or die "Unable to open configuration file $conf_file for reading: $!";
1156 # A new version configuration file must have a comment as its first line
1157 my $first_line = <$fh>;
1158 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
1159 if (defined $version) {
1160 if ($version == 1) {
1161 # Do something here;
1162 die "Version 1 configuration files not implemented yet";
1165 die "Version $version configuration files are not supported";
1169 # Ugh. Old configuration file
1170 # What we do here is we create a new Safe compartment
1171 # so fucked up crap in the config file doesn't sink us.
1172 my $cpt = new Safe or die "Unable to create safe compartment";
1173 # perldoc Opcode; for details
1174 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
1175 $cpt->reval(qq(require '$conf_file';));
1176 die "Error in configuration file: $@" if $@;
1177 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
1178 # we want to glob in from the configuration file
1179 for my $variable (map {$_ =~ /^(?:config|all)$/ ? () : @{$EXPORT_TAGS{$_}}} keys %EXPORT_TAGS) {
1180 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1181 my $var_glob = $cpt->varglob($glob_name);
1182 my $value; #= $cpt->reval("return $variable");
1183 # print STDERR "$variable $value",qq(\n);
1184 if (defined $var_glob) {{
1186 if ($glob_type eq '%') {
1187 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
1189 elsif ($glob_type eq '@') {
1190 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
1193 $value = ${*{$var_glob}};
1195 # We punt here, because we can't tell if the value was
1196 # defined intentionally, or if it was just left alone;
1197 # this tries to set sane defaults.
1198 set_default(\%config,$hash_name,$value) if defined $value;
1205 my ($variable) = @_;
1206 my $hash_name = $variable;
1207 $hash_name =~ s/^([\$\%\@])g//;
1209 my $glob_name = 'g'.$hash_name;
1210 $hash_name =~ s/(HTML|CGI|CVE)/ucfirst(lc($1))/ge;
1211 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
1212 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
1213 return $hash_name unless wantarray;
1214 return ($hash_name,$glob_name,$glob_type);
1219 # sets the configuration hash to the default value if it's not set,
1220 # otherwise doesn't do anything
1221 # If $USING_GLOBALS, then sets an appropriate global.
1224 my ($config,$option,$value) = @_;
1226 if ($USING_GLOBALS) {
1227 # fix up the variable name
1228 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
1229 # Fix stupid HTML names
1230 $varname =~ s/(Html|Cgi)/uc($1)/ge;
1232 # update the configuration value
1233 if (not $USING_GLOBALS and not exists $config->{$option}) {
1234 $config->{$option} = $value;
1236 elsif ($USING_GLOBALS) {{
1238 # Need to check if a value has already been set in a global
1239 if (defined *{"Debbugs::Config::${varname}"}) {
1240 $config->{$option} = *{"Debbugs::Config::${varname}"};
1243 $config->{$option} = $value;
1246 if ($USING_GLOBALS) {{
1248 *{"Debbugs::Config::${varname}"} = $config->{$option};
1255 # All we care about here is whether we've been called with the globals or text option;
1256 # if so, then we need to export some symbols back up.
1257 # In any event, we call exporter.
1260 if (grep /^:(?:text|globals)$/, @_) {
1262 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
1263 my $tmp = $variable;
1265 # Yes, I don't care if these are only used once
1267 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
1269 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1270 $tmp =~ s/^[\%\$\@]//;
1271 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
1274 Debbugs::Config->export_to_level(1,@_);