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($gPackageVersionRe),
54 qw($gSummaryList $gMirrorList $gMailer $gBug),
55 qw($gBugs $gRemoveAge $gSaveOldBugs $gDefaultSeverity),
56 qw($gShowSeverities $gBounceFroms $gConfigDir $gSpoolDir),
57 qw($gIncomingDir $gWebDir $gDocDir $gMaintainerFile),
58 qw($gMaintainerFileOverride $gPseudoMaintFile $gPseudoDescFile $gPackageSource),
59 qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
60 qw($gVersionTimeIndex),
61 qw($gSendmail $gLibPath $gSpamScan @gExcludeFromControl),
62 qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
64 qw(%gDistributionAliases),
65 qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
66 qw(@gRemovalStrongSeverityDefaultDistributionTags),
67 qw(@gDefaultArchitectures),
70 qw($gSpamMaxThreads $gSpamSpamsPerThread $gSpamKeepRunning $gSpamScan $gSpamCrossassassinDb)
72 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
74 config => [qw(%config)],
77 Exporter::export_ok_tags(qw(globals text config));
78 $EXPORT_TAGS{all} = [@EXPORT_OK];
81 use File::Basename qw(dirname);
85 =head1 CONFIGURATION VARIABLES
87 =head2 General Configuration
95 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
96 # This enables us to test things that are -T.
97 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
98 if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] = $<) {
99 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
100 $ENV{DEBBUGS_CONFIG_FILE} = $1;
103 die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
106 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
108 =item email_domain $gEmailDomain
110 The email domain of the bts
114 set_default(\%config,'email_domain','bugs.something');
116 =item list_domain $gListDomain
118 The list domain of the bts, defaults to the email domain
122 set_default(\%config,'list_domain',$config{email_domain});
124 =item web_host $gWebHost
126 The web host of the bts; defaults to the email domain
130 set_default(\%config,'web_host',$config{email_domain});
132 =item web_host_bug_dir $gWebHostDir
134 The directory of the web host on which bugs are kept, defaults to C<''>
138 set_default(\%config,'web_host_bug_dir','');
140 =item web_domain $gWebDomain
142 Full path of the web domain where bugs are kept, defaults to the
143 concatenation of L</web_host> and L</web_host_bug_dir>
147 set_default(\%config,'web_domain',$config{web_host}.($config{web_host}=~m{/$}?'':'/').$config{web_host_bug_dir});
149 =item html_suffix $gHTMLSuffix
151 Suffix of html pages, defaults to .html
155 set_default(\%config,'html_suffix','.html');
157 =item cgi_domain $gCGIDomain
159 Full path of the web domain where cgi scripts are kept. Defaults to
160 the concatentation of L</web_host> and cgi.
164 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
166 =item mirrors @gMirrors
168 List of mirrors [What these mirrors are used for, no one knows.]
173 set_default(\%config,'mirrors',[]);
175 =item package_pages $gPackagePages
177 Domain where the package pages are kept; links should work in a
178 package_pages/foopackage manner. Defaults to undef, which means that
179 package links will not be made.
184 set_default(\%config,'package_pages',undef);
186 =item package_pages $gUsertagPackageDomain
188 Domain where where usertags of packages belong; defaults to $gPackagePages
192 set_default(\%config,'usertag_package_domain',$config{package_pages});
195 =item subscription_domain $gSubscriptionDomain
197 Domain where subscriptions to package lists happen
202 set_default(\%config,'subscription_domain',undef);
209 =head2 Project Identification
213 =item project $gProject
221 set_default(\%config,'project','Something');
223 =item project_title $gProjectTitle
225 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
227 Default: "$config{project} Debbugs Install"
231 set_default(\%config,'project_title',"$config{project} Debbugs Install");
233 =item maintainer $gMaintainer
235 Name of the maintainer of this debbugs install
237 Default: 'Local DebBugs Owner's
241 set_default(\%config,'maintainer','Local DebBugs Owner');
243 =item maintainer_webpage $gMaintainerWebpage
245 Webpage of the maintainer of this install of debbugs
247 Default: "$config{web_domain}/~owner"
251 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
253 =item maintainer_email $gMaintainerEmail
255 Email address of the maintainer of this Debbugs install
257 Default: 'root@'.$config{email_domain}
261 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
263 =item unknown_maintainer_email
265 Email address where packages with an unknown maintainer will be sent
267 Default: $config{maintainer_email}
273 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
275 =head2 BTS Mailing Lists
302 set_default(\%config, 'submit_list', 'bug-submit-list');
303 set_default(\%config, 'maint_list', 'bug-maint-list');
304 set_default(\%config, 'quiet_list', 'bug-quiet-list');
305 set_default(\%config, 'forward_list', 'bug-forward-list');
306 set_default(\%config, 'done_list', 'bug-done-list');
307 set_default(\%config, 'request_list', 'bug-request-list');
308 set_default(\%config,'submitter_list','bug-submitter-list');
309 set_default(\%config, 'control_list', 'bug-control-list');
310 set_default(\%config, 'summary_list', 'bug-summary-list');
311 set_default(\%config, 'mirror_list', 'bug-mirror-list');
312 set_default(\%config, 'strong_list', 'bug-strong-list');
320 set_default(\%config,'mailer','exim');
321 set_default(\%config,'bug','bug');
322 set_default(\%config,'bugs','bugs');
326 Age at which bugs are archived/removed
332 set_default(\%config,'remove_age',28);
336 Whether old bugs are saved or deleted
342 set_default(\%config,'save_old_bugs',1);
344 =item distribution_aliases
346 Map of distribution aliases to the distribution name
349 {experimental => 'experimental',
350 unstable => 'unstable',
351 testing => 'testing',
353 oldstable => 'oldstable',
357 sarge => 'oldstable',
362 set_default(\%config,'distribution_aliases',
363 {experimental => 'experimental',
364 unstable => 'unstable',
365 testing => 'testing',
367 oldstable => 'oldstable',
371 sarge => 'oldstable',
379 List of valid distributions
381 Default: The values of the distribution aliases map.
385 my %_distributions_default;
386 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
387 set_default(\%config,'distributions',[keys %_distributions_default]);
390 =item default_architectures
392 List of default architectures to use when architecture(s) are not
395 Default: i386 amd64 arm ppc sparc alpha
399 set_default(\%config,'default_architectures',
400 [qw(i386 amd64 arm powerpc sparc alpha)]
403 =item removal_distribution_tags
405 Tags which specifiy distributions to check
407 Default: @{$config{distributions}}
411 set_default(\%config,'removal_distribution_tags',
412 [@{$config{distributions}}]);
414 =item removal_default_distribution_tags
416 For removal/archival purposes, all bugs are assumed to have these tags
419 Default: qw(unstable testing);
423 set_default(\%config,'removal_default_distribution_tags',
424 [qw(unstable testing)]
427 =item removal_strong_severity_default_distribution_tags
429 For removal/archival purposes, all bugs with strong severity are
430 assumed to have these tags set.
432 Default: qw(unstable testing stable);
436 set_default(\%config,'removal_strong_severity_default_distribution_tags',
437 [qw(unstable testing stable)]
441 =item removal_architectures
443 For removal/archival purposes, these architectures are consulted if
444 there is more than one architecture applicable. If the bug is in a
445 package not in any of these architectures, the architecture actually
446 checked is undefined.
448 Default: value of default_architectures
452 set_default(\%config,'removal_architectures',
453 $config{default_architectures},
457 =item package_name_re
459 The regex which will match a package name
461 Default: '[a-z0-9][a-z0-9\.+-]+'
465 set_default(\%config,'package_name_re',
466 '[a-z0-9][a-z0-9\.+-]+');
468 =item package_version_re
470 The regex which will match a package version
472 Default: '[A-Za-z0-9:+\.-]+'
477 set_default(\%config,'package_version_re',
478 '[A-Za-z0-9:+\.~-]+');
481 =item default_package
483 This is the name of the default package. If set, bugs assigned to
484 packages without a maintainer and bugs missing a Package: psuedoheader
485 will be assigned to this package instead.
487 Defaults to unset, which is the traditional debbugs behavoir
491 set_default(\%config,'default_package',
496 =item control_internal_requester
498 This address is used by Debbugs::Control as the request address which
499 sent a control request for faked log messages.
501 Default:"Debbugs Internal Request <$config{maintainer_email}>"
505 set_default(\%config,'control_internal_requester',
506 "Debbugs Internal Request <$config{maintainer_email}>",
509 =item control_internal_request_addr
511 This address is used by Debbugs::Control as the address to which a
512 faked log message request was sent.
514 Default: "internal_control\@$config{email_domain}";
518 set_default(\%config,'control_internal_request_addr',
519 'internal_control@'.$config{email_domain},
523 =item exclude_from_control
525 Addresses which are not allowed to send messages to control
529 set_default(\%config,'exclude_from_control',[]);
534 set_default(\%config,'default_severity','normal');
535 set_default(\%config,'show_severities','critical, grave, normal, minor, wishlist');
536 set_default(\%config,'strong_severities',[qw(critical grave)]);
537 set_default(\%config,'severity_list',[qw(critical grave normal wishlist)]);
538 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
539 grave => "Grave $config{bugs}",
540 normal => "Normal $config{bugs}",
541 wishlist => "Wishlist $config{bugs}",
544 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
545 @{$config{distributions}}
548 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
549 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
550 '^mail.*agent|^tcpmail|^bitmail|^mailman');
552 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
553 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
554 set_default(\%config,'incoming_dir','incoming');
555 set_default(\%config,'web_dir','/var/lib/debbugs/www');
556 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
557 set_default(\%config,'lib_path','/usr/lib/debbugs');
562 directory of templates; defaults to /usr/share/debbugs/templates.
566 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
569 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
570 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
571 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maint');
572 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
573 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
576 =item version_packages_dir
578 Location where the version package information is kept; defaults to
579 spool_dir/../versions/pkg
583 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
585 =item version_time_index
587 Location of the version/time index file. Defaults to
588 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
589 exists; otherwise defaults to undef.
594 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
598 Location of the version index file. Defaults to
599 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
600 exists; otherwise defaults to undef.
604 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
606 =item binary_source_map
608 Location of the binary -> source map. Defaults to
609 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
610 exists; otherwise defaults to undef.
614 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
616 =item source_binary_map
618 Location of the source -> binary map. Defaults to
619 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
620 exists; otherwise defaults to undef.
624 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
628 set_default(\%config,'post_processall',[]);
632 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
636 set_default(\%config,'sendmail','/usr/lib/sendmail');
640 Whether or not spamscan is being used; defaults to 0 (not being used
644 set_default(\%config,'spam_scan',0);
646 =item spam_crossassassin_db
648 Location of the crosassassin database, defaults to
649 spool_dir/../CrossAssassinDb
653 set_default(\%config,'spam_crossassassin_db',$config{spool_dir}.'/../CrossAssassinDb');
657 Maximum number of cross-posted messages
661 set_default(\%config,'spam_max_cross',6);
664 =item spam_spams_per_thread
666 Number of spams for each thread (on average). Defaults to 200
670 set_default(\%config,'spam_spams_per_thread',200);
672 =item spam_max_threads
674 Maximum number of threads to start. Defaults to 20
678 set_default(\%config,'spam_max_threads',20);
680 =item spam_keep_running
682 Maximum number of seconds to run without restarting. Defaults to 3600.
686 set_default(\%config,'spam_keep_running',3600);
690 Location to store spam messages; is run through strftime to allow for
691 %d,%m,%Y, et al. Defaults to 'spool_dir/../mail/spam/assassinated.%Y-%m-%d'
695 set_default(\%config,'spam_mailbox',$config{spool_dir}.'/../mail/spam/assassinated.%Y-%m-%d');
697 =item spam_crossassassin_mailbox
699 Location to store crossassassinated messages; is run through strftime
700 to allow for %d,%m,%Y, et al. Defaults to
701 'spool_dir/../mail/spam/crossassassinated.%Y-%m-%d'
705 set_default(\%config,'spam_crossassassin_mailbox',$config{spool_dir}.'/../mail/spam/crossassassinated.%Y-%m-%d');
707 =item spam_local_tests_only
709 Whether only local tests are run, defaults to 0
713 set_default(\%config,'spam_local_tests_only',0);
715 =item spam_user_prefs
717 User preferences for spamassassin, defaults to $ENV{HOME}/.spamassassin/user_prefs
721 set_default(\%config,'spam_user_prefs',"$ENV{HOME}/.spamassassin/user_prefs");
725 Site rules directory for spamassassin, defaults to
726 '/usr/share/spamassassin'
730 set_default(\%config,'spam_rules_dir','/usr/share/spamassassin');
738 The following are the only text fields in general use in the scripts;
739 a few additional text fields are defined in text.in, but are only used
740 in db2html and a few other specialty scripts.
742 Earlier versions of debbugs defined these values in /etc/debbugs/text,
743 but now they are required to be in the configuration file. [Eventually
744 the longer ones will move out into a fully fledged template system.]
750 =item bad_email_prefix
752 This prefixes the text of all lines in a bad e-mail message ack.
756 set_default(\%config,'bad_email_prefix','');
759 =item text_instructions
761 This gives more information about bad e-mails to receive.in
765 set_default(\%config,'text_instructions',$config{bad_email_prefix});
769 This shows up at the end of (most) html pages
773 set_default(\%config,'html_tail',<<END);
774 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
780 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
781 Copyright (C) 1999 Darren O. Benham,
782 1997,2003 nCipher Corporation Ltd,
788 =item html_expire_note
790 This message explains what happens to archive/remove-able bugs
794 set_default(\%config,'html_expire_note',
795 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
803 my ($conf_file) = @_;
804 # first, figure out what type of file we're reading in.
805 my $fh = new IO::File $conf_file,'r'
806 or die "Unable to open configuration file $conf_file for reading: $!";
807 # A new version configuration file must have a comment as its first line
808 my $first_line = <$fh>;
809 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
810 if (defined $version) {
813 die "Version 1 configuration files not implemented yet";
816 die "Version $version configuration files are not supported";
820 # Ugh. Old configuration file
821 # What we do here is we create a new Safe compartment
822 # so fucked up crap in the config file doesn't sink us.
823 my $cpt = new Safe or die "Unable to create safe compartment";
824 # perldoc Opcode; for details
825 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
826 $cpt->reval(qq(require '$conf_file';));
827 die "Error in configuration file: $@" if $@;
828 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
829 # we want to glob in from the configuration file
830 for my $variable (@{$EXPORT_TAGS{globals}}) {
831 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
832 my $var_glob = $cpt->varglob($glob_name);
833 my $value; #= $cpt->reval("return $variable");
834 # print STDERR "$variable $value",qq(\n);
835 if (defined $var_glob) {{
837 if ($glob_type eq '%') {
838 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
840 elsif ($glob_type eq '@') {
841 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
844 $value = ${*{$var_glob}};
846 # We punt here, because we can't tell if the value was
847 # defined intentionally, or if it was just left alone;
848 # this tries to set sane defaults.
849 set_default(\%config,$hash_name,$value) if defined $value;
857 my $hash_name = $variable;
858 $hash_name =~ s/^([\$\%\@])g//;
860 my $glob_name = 'g'.$hash_name;
861 $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
862 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
863 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
864 return $hash_name unless wantarray;
865 return ($hash_name,$glob_name,$glob_type);
870 # sets the configuration hash to the default value if it's not set,
871 # otherwise doesn't do anything
872 # If $USING_GLOBALS, then sets an appropriate global.
875 my ($config,$option,$value) = @_;
877 if ($USING_GLOBALS) {
878 # fix up the variable name
879 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
880 # Fix stupid HTML names
881 $varname =~ s/(Html|Cgi)/uc($1)/ge;
883 # update the configuration value
884 if (not $USING_GLOBALS and not exists $config->{$option}) {
885 $config->{$option} = $value;
887 elsif ($USING_GLOBALS) {{
889 # Need to check if a value has already been set in a global
890 if (defined *{"Debbugs::Config::${varname}"}) {
891 $config->{$option} = *{"Debbugs::Config::${varname}"};
894 $config->{$option} = $value;
897 if ($USING_GLOBALS) {{
899 *{"Debbugs::Config::${varname}"} = $config->{$option};
906 # All we care about here is whether we've been called with the globals or text option;
907 # if so, then we need to export some symbols back up.
908 # In any event, we call exporter.
911 if (grep /^:(?:text|globals)$/, @_) {
913 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
916 # Yes, I don't care if these are only used once
918 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
920 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
921 $tmp =~ s/^[\%\$\@]//;
922 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
925 Debbugs::Config->export_to_level(1,@_);