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 http://cdn.libravatar.org/avatar/ which uses a federated Avatar system
377 and falls back to gravatar if necessary.
381 set_default(\%config,'libravatar_uri',"http://cdn.libravatar.org/avatar/");
383 =item libravatar_uri_options $gLibravatarUriOptions
385 Options to append to the md5_hex of the e-mail. This sets the default
386 avatar used when an avatar isn't available. Currently defaults to
387 '?d=retro', which causes a bitmap-looking avatar to be displayed for
390 Other options which make sense include ?d=404, ?d=wavatar, etc. See
391 the API of libravatar for details.
395 set_default(\%config,'libravatar_uri_options','?d=retro');
397 =item libravatar_default_image
399 Default image to serve for libravatar if there is no avatar for an
400 e-mail address. By default, this is a 1x1 png. [This will also be the
401 image served if someone specifies avatar=no.]
403 Default: $config{web_dir}/1x1.png
407 set_default(\%config,'libravatar_default_image',$config{web_dir}.'/1x1.png');
409 =item libravatar_cache_dir
411 Directory where cached libravatar images are stored
413 Default: $config{web_dir}/libravatar/
417 set_default(\%config,'libravatar_cache_dir',$config{web_dir}.'/libravatar/');
427 Name of the mailer to use
433 set_default(\%config,'mailer','exim');
442 Default: ucfirst($config{bug});
450 Default: ucfirst($config{ubugs});
454 set_default(\%config,'bug','bug');
455 set_default(\%config,'ubug',ucfirst($config{bug}));
456 set_default(\%config,'bugs','bugs');
457 set_default(\%config,'ubugs',ucfirst($config{bugs}));
461 Age at which bugs are archived/removed
467 set_default(\%config,'remove_age',28);
471 Whether old bugs are saved or deleted
477 set_default(\%config,'save_old_bugs',1);
479 =item distribution_aliases
481 Map of distribution aliases to the distribution name
484 {experimental => 'experimental',
485 unstable => 'unstable',
486 testing => 'testing',
488 oldstable => 'oldstable',
492 sarge => 'oldstable',
497 set_default(\%config,'distribution_aliases',
498 {experimental => 'experimental',
499 unstable => 'unstable',
500 testing => 'testing',
502 oldstable => 'oldstable',
506 sarge => 'oldstable',
514 List of valid distributions
516 Default: The values of the distribution aliases map.
520 my %_distributions_default;
521 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
522 set_default(\%config,'distributions',[keys %_distributions_default]);
525 =item default_architectures
527 List of default architectures to use when architecture(s) are not
530 Default: i386 amd64 arm ppc sparc alpha
534 set_default(\%config,'default_architectures',
535 [qw(i386 amd64 arm powerpc sparc alpha)]
538 =item affects_distribution_tags
540 List of tags which restrict the buggy state to a set of distributions.
542 The set of distributions that are buggy is the intersection of the set
543 of distributions that would be buggy without reference to these tags
544 and the set of these tags that are distributions which are set on a
547 Setting this to [] will remove this feature.
549 Default: @{$config{distributions}}
553 set_default(\%config,'affects_distribution_tags',
554 [@{$config{distributions}}],
557 =item removal_unremovable_tags
559 Bugs which have these tags set cannot be archived
565 set_default(\%config,'removal_unremovable_tags',
569 =item removal_distribution_tags
571 Tags which specifiy distributions to check
573 Default: @{$config{distributions}}
577 set_default(\%config,'removal_distribution_tags',
578 [@{$config{distributions}}]);
580 =item removal_default_distribution_tags
582 For removal/archival purposes, all bugs are assumed to have these tags
585 Default: qw(unstable testing);
589 set_default(\%config,'removal_default_distribution_tags',
590 [qw(unstable testing)]
593 =item removal_strong_severity_default_distribution_tags
595 For removal/archival purposes, all bugs with strong severity are
596 assumed to have these tags set.
598 Default: qw(unstable testing stable);
602 set_default(\%config,'removal_strong_severity_default_distribution_tags',
603 [qw(unstable testing stable)]
607 =item removal_architectures
609 For removal/archival purposes, these architectures are consulted if
610 there is more than one architecture applicable. If the bug is in a
611 package not in any of these architectures, the architecture actually
612 checked is undefined.
614 Default: value of default_architectures
618 set_default(\%config,'removal_architectures',
619 $config{default_architectures},
623 =item package_name_re
625 The regex which will match a package name
627 Default: '[a-z0-9][a-z0-9\.+-]+'
631 set_default(\%config,'package_name_re',
632 '[a-z0-9][a-z0-9\.+-]+');
634 =item package_version_re
636 The regex which will match a package version
638 Default: '[A-Za-z0-9:+\.-]+'
643 set_default(\%config,'package_version_re',
644 '[A-Za-z0-9:+\.~-]+');
647 =item default_package
649 This is the name of the default package. If set, bugs assigned to
650 packages without a maintainer and bugs missing a Package: psuedoheader
651 will be assigned to this package instead.
653 Defaults to unset, which is the traditional debbugs behavoir
657 set_default(\%config,'default_package',
662 =item control_internal_requester
664 This address is used by Debbugs::Control as the request address which
665 sent a control request for faked log messages.
667 Default:"Debbugs Internal Request <$config{maintainer_email}>"
671 set_default(\%config,'control_internal_requester',
672 "Debbugs Internal Request <$config{maintainer_email}>",
675 =item control_internal_request_addr
677 This address is used by Debbugs::Control as the address to which a
678 faked log message request was sent.
680 Default: "internal_control\@$config{email_domain}";
684 set_default(\%config,'control_internal_request_addr',
685 'internal_control@'.$config{email_domain},
689 =item exclude_from_control
691 Addresses which are not allowed to send messages to control
695 set_default(\%config,'exclude_from_control',[]);
699 =item default_severity
701 The default severity of bugs which have no severity set
707 set_default(\%config,'default_severity','normal');
709 =item severity_display
711 A hashref of severities and the informative text which describes them.
715 {critical => "Critical $config{bugs}",
716 grave => "Grave $config{bugs}",
717 normal => "Normal $config{bugs}",
718 wishlist => "Wishlist $config{bugs}",
723 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
724 grave => "Grave $config{bugs}",
725 serious => "Serious $config{bugs}",
726 important=> "Important $config{bugs}",
727 normal => "Normal $config{bugs}",
728 minor => "Minor $config{bugs}",
729 wishlist => "Wishlist $config{bugs}",
732 =item show_severities
734 A scalar list of the severities to show
736 Defaults to the concatenation of the keys of the severity_display
737 hashlist with ', ' above.
741 set_default(\%config,'show_severities',join(', ',keys %{$config{severity_display}}));
743 =item strong_severities
745 An arrayref of the serious severities which shoud be emphasized
747 Default: [qw(critical grave)]
751 set_default(\%config,'strong_severities',[qw(critical grave)]);
755 An arrayref of a list of the severities
757 Defaults to the keys of the severity display hashref
761 set_default(\%config,'severity_list',[keys %{$config{severity_display}}]);
763 =item obsolete_severities
765 A hashref of obsolete severities with the replacing severity
771 set_default(\%config,'obsolete_severities',{});
775 An arrayref of the tags used
777 Default: [qw(patch wontfix moreinfo unreproducible fixed)] and also
778 includes the distributions.
782 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
783 @{$config{distributions}}
786 set_default(\%config,'tags_single_letter',
790 unreproducible => 'R',
795 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
796 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
797 '^mail.*agent|^tcpmail|^bitmail|^mailman');
799 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
800 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
804 Directory which contains the usertags
806 Default: $config{spool_dir}/user
810 set_default(\%config,'usertag_dir',$config{spool_dir}.'/user');
811 set_default(\%config,'incoming_dir','incoming');
813 =item web_dir $gWebDir
815 Directory where base html files are kept. Should normally be the same
816 as the web server's document root.
818 Default: /var/lib/debbugs/www
822 set_default(\%config,'web_dir','/var/lib/debbugs/www');
823 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
824 set_default(\%config,'lib_path','/usr/lib/debbugs');
829 directory of templates; defaults to /usr/share/debbugs/templates.
833 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
836 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
837 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
838 set_default(\%config,'source_maintainer_file',$config{config_dir}.'/Source_maintainers');
839 set_default(\%config,'source_maintainer_file_override',undef);
840 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maintainers');
841 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
842 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
845 =item simple_versioning
847 If true this causes debbugs to ignore version information and just
848 look at whether a bug is done or not done. Primarily of interest for
849 debbugs installs which don't track versions. defaults to false.
853 set_default(\%config,'simple_versioning',0);
856 =item version_packages_dir
858 Location where the version package information is kept; defaults to
859 spool_dir/../versions/pkg
863 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
865 =item version_time_index
867 Location of the version/time index file. Defaults to
868 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
869 exists; otherwise defaults to undef.
874 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
878 Location of the version index file. Defaults to
879 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
880 exists; otherwise defaults to undef.
884 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
886 =item binary_source_map
888 Location of the binary -> source map. Defaults to
889 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
890 exists; otherwise defaults to undef.
894 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
896 =item source_binary_map
898 Location of the source -> binary map. Defaults to
899 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
900 exists; otherwise defaults to undef.
904 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
908 set_default(\%config,'post_processall',[]);
912 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
916 set_default(\%config,'sendmail','/usr/lib/sendmail');
918 =item sendmail_arguments
920 Default arguments to pass to sendmail. Defaults to C<qw(-oem -oi)>.
924 set_default(\%config,'sendmail_arguments',[qw(-oem -oi)]);
928 Whether or not spamscan is being used; defaults to 0 (not being used
932 set_default(\%config,'spam_scan',0);
934 =item spam_crossassassin_db
936 Location of the crosassassin database, defaults to
937 spool_dir/../CrossAssassinDb
941 set_default(\%config,'spam_crossassassin_db',$config{spool_dir}.'/../CrossAssassinDb');
945 Maximum number of cross-posted messages
949 set_default(\%config,'spam_max_cross',6);
952 =item spam_spams_per_thread
954 Number of spams for each thread (on average). Defaults to 200
958 set_default(\%config,'spam_spams_per_thread',200);
960 =item spam_max_threads
962 Maximum number of threads to start. Defaults to 20
966 set_default(\%config,'spam_max_threads',20);
968 =item spam_keep_running
970 Maximum number of seconds to run without restarting. Defaults to 3600.
974 set_default(\%config,'spam_keep_running',3600);
978 Location to store spam messages; is run through strftime to allow for
979 %d,%m,%Y, et al. Defaults to 'spool_dir/../mail/spam/assassinated.%Y-%m-%d'
983 set_default(\%config,'spam_mailbox',$config{spool_dir}.'/../mail/spam/assassinated.%Y-%m-%d');
985 =item spam_crossassassin_mailbox
987 Location to store crossassassinated messages; is run through strftime
988 to allow for %d,%m,%Y, et al. Defaults to
989 'spool_dir/../mail/spam/crossassassinated.%Y-%m-%d'
993 set_default(\%config,'spam_crossassassin_mailbox',$config{spool_dir}.'/../mail/spam/crossassassinated.%Y-%m-%d');
995 =item spam_local_tests_only
997 Whether only local tests are run, defaults to 0
1001 set_default(\%config,'spam_local_tests_only',0);
1003 =item spam_user_prefs
1005 User preferences for spamassassin, defaults to $ENV{HOME}/.spamassassin/user_prefs
1009 set_default(\%config,'spam_user_prefs',"$ENV{HOME}/.spamassassin/user_prefs");
1011 =item spam_rules_dir
1013 Site rules directory for spamassassin, defaults to
1014 '/usr/share/spamassassin'
1018 set_default(\%config,'spam_rules_dir','/usr/share/spamassassin');
1025 The following are the only text fields in general use in the scripts;
1026 a few additional text fields are defined in text.in, but are only used
1027 in db2html and a few other specialty scripts.
1029 Earlier versions of debbugs defined these values in /etc/debbugs/text,
1030 but now they are required to be in the configuration file. [Eventually
1031 the longer ones will move out into a fully fledged template system.]
1037 =item bad_email_prefix
1039 This prefixes the text of all lines in a bad e-mail message ack.
1043 set_default(\%config,'bad_email_prefix','');
1046 =item text_instructions
1048 This gives more information about bad e-mails to receive.in
1052 set_default(\%config,'text_instructions',$config{bad_email_prefix});
1056 This shows up at the end of (most) html pages
1058 In many pages this has been replaced by the html/tail template.
1062 set_default(\%config,'html_tail',<<END);
1063 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
1069 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
1070 Copyright (C) 1999 Darren O. Benham,
1071 1997,2003 nCipher Corporation Ltd,
1072 1994-97 Ian Jackson.
1077 =item html_expire_note
1079 This message explains what happens to archive/remove-able bugs
1083 set_default(\%config,'html_expire_note',
1084 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
1092 my ($conf_file) = @_;
1093 if (not -e $conf_file) {
1094 print STDERR "configuration file '$conf_file' doesn't exist; skipping it\n" if $DEBUG;
1097 # first, figure out what type of file we're reading in.
1098 my $fh = new IO::File $conf_file,'r'
1099 or die "Unable to open configuration file $conf_file for reading: $!";
1100 # A new version configuration file must have a comment as its first line
1101 my $first_line = <$fh>;
1102 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
1103 if (defined $version) {
1104 if ($version == 1) {
1105 # Do something here;
1106 die "Version 1 configuration files not implemented yet";
1109 die "Version $version configuration files are not supported";
1113 # Ugh. Old configuration file
1114 # What we do here is we create a new Safe compartment
1115 # so fucked up crap in the config file doesn't sink us.
1116 my $cpt = new Safe or die "Unable to create safe compartment";
1117 # perldoc Opcode; for details
1118 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
1119 $cpt->reval(qq(require '$conf_file';));
1120 die "Error in configuration file: $@" if $@;
1121 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
1122 # we want to glob in from the configuration file
1123 for my $variable (map {$_ =~ /^(?:config|all)$/ ? () : @{$EXPORT_TAGS{$_}}} keys %EXPORT_TAGS) {
1124 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1125 my $var_glob = $cpt->varglob($glob_name);
1126 my $value; #= $cpt->reval("return $variable");
1127 # print STDERR "$variable $value",qq(\n);
1128 if (defined $var_glob) {{
1130 if ($glob_type eq '%') {
1131 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
1133 elsif ($glob_type eq '@') {
1134 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
1137 $value = ${*{$var_glob}};
1139 # We punt here, because we can't tell if the value was
1140 # defined intentionally, or if it was just left alone;
1141 # this tries to set sane defaults.
1142 set_default(\%config,$hash_name,$value) if defined $value;
1149 my ($variable) = @_;
1150 my $hash_name = $variable;
1151 $hash_name =~ s/^([\$\%\@])g//;
1153 my $glob_name = 'g'.$hash_name;
1154 $hash_name =~ s/(HTML|CGI|CVE)/ucfirst(lc($1))/ge;
1155 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
1156 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
1157 return $hash_name unless wantarray;
1158 return ($hash_name,$glob_name,$glob_type);
1163 # sets the configuration hash to the default value if it's not set,
1164 # otherwise doesn't do anything
1165 # If $USING_GLOBALS, then sets an appropriate global.
1168 my ($config,$option,$value) = @_;
1170 if ($USING_GLOBALS) {
1171 # fix up the variable name
1172 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
1173 # Fix stupid HTML names
1174 $varname =~ s/(Html|Cgi)/uc($1)/ge;
1176 # update the configuration value
1177 if (not $USING_GLOBALS and not exists $config->{$option}) {
1178 $config->{$option} = $value;
1180 elsif ($USING_GLOBALS) {{
1182 # Need to check if a value has already been set in a global
1183 if (defined *{"Debbugs::Config::${varname}"}) {
1184 $config->{$option} = *{"Debbugs::Config::${varname}"};
1187 $config->{$option} = $value;
1190 if ($USING_GLOBALS) {{
1192 *{"Debbugs::Config::${varname}"} = $config->{$option};
1199 # All we care about here is whether we've been called with the globals or text option;
1200 # if so, then we need to export some symbols back up.
1201 # In any event, we call exporter.
1204 if (grep /^:(?:text|globals)$/, @_) {
1206 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
1207 my $tmp = $variable;
1209 # Yes, I don't care if these are only used once
1211 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
1213 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1214 $tmp =~ s/^[\%\$\@]//;
1215 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
1218 Debbugs::Config->export_to_level(1,@_);