]> git.donarmstrong.com Git - debbugs.git/blob - Debbugs/Config.pm
merge changes from dla source tree
[debbugs.git] / Debbugs / Config.pm
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.
5 #
6 # Copyright 2007 by Don Armstrong <don@donarmstrong.com>.
7
8 package Debbugs::Config;
9
10 =head1 NAME
11
12 Debbugs::Config -- Configuration information for debbugs
13
14 =head1 SYNOPSIS
15
16  use Debbugs::Config;
17
18 # to get the compatiblity interface
19
20  use Debbugs::Config qw(:globals);
21
22 =head1 DESCRIPTION
23
24 This module provides configuration variables for all of debbugs.
25
26 =head1 CONFIGURATION FILES
27
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.
31
32 =cut
33
34 use warnings;
35 use strict;
36 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT $USING_GLOBALS %config);
37 use base qw(Exporter);
38
39 BEGIN {
40      # set the version for version checking
41      $VERSION     = 1.00;
42      $DEBUG = 0 unless defined $DEBUG;
43      $USING_GLOBALS = 0;
44
45      @EXPORT = ();
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),
52                                  qw($gStrongList),
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 $gPseudoDescFile $gPackageSource),
59                                  qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
60                                  qw($gVersionTimeIndex),
61                                  qw($gSendmail $gLibPath $gSpamScan @gExcludeFromControl),
62                                  qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
63                                  qw(%gSearchEstraier),
64                                  qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
65                                 ],
66                      text     => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
67                                  ],
68                      config   => [qw(%config)],
69                     );
70      @EXPORT_OK = ();
71      Exporter::export_ok_tags(qw(globals text config));
72      $EXPORT_TAGS{all} = [@EXPORT_OK];
73 }
74
75 use File::Basename qw(dirname);
76 use IO::File;
77 use Safe;
78
79 =head1 CONFIGURATION VARIABLES
80
81 =head2 General Configuration
82
83 =over
84
85 =cut
86
87 # read in the files;
88 %config = ();
89 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
90 # This enables us to test things that are -T.
91 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
92      if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] = $<) {
93           $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
94           $ENV{DEBBUGS_CONFIG_FILE} = $1;
95      }
96      else {
97           die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
98      }
99 }
100 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
101
102 =item email_domain $gEmailDomain
103
104 The email domain of the bts
105
106 =cut
107
108 set_default(\%config,'email_domain','bugs.something');
109
110 =item list_domain $gListDomain
111
112 The list domain of the bts, defaults to the email domain
113
114 =cut
115
116 set_default(\%config,'list_domain',$config{email_domain});
117
118 =item web_host $gWebHost
119
120 The web host of the bts; defaults to the email domain
121
122 =cut
123
124 set_default(\%config,'web_host',$config{email_domain});
125
126 =item web_host_bug_dir $gWebHostDir
127
128 The directory of the web host on which bugs are kept, defaults to C<''>
129
130 =cut
131
132 set_default(\%config,'web_host_bug_dir','');
133
134 =item web_domain $gWebDomain
135
136 Full path of the web domain where bugs are kept, defaults to the
137 concatenation of L</web_host> and L</web_host_bug_dir>
138
139 =cut
140
141 set_default(\%config,'web_domain',$config{web_host}.'/'.$config{web_host_bug_dir});
142
143 =item html_suffix $gHTMLSuffix
144
145 Suffix of html pages, defaults to .html
146
147 =cut
148
149 set_default(\%config,'html_suffix','.html');
150
151 =item cgi_domain $gCGIDomain
152
153 Full path of the web domain where cgi scripts are kept. Defaults to
154 the concatentation of L</web_host> and cgi.
155
156 =cut
157
158 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
159
160 =item mirrors @gMirrors
161
162 List of mirrors [What these mirrors are used for, no one knows.]
163
164 =cut
165
166
167 set_default(\%config,'mirrors',[]);
168
169 =item package_pages  $gPackagePages
170
171 Domain where the package pages are kept; links should work in a
172 package_pages/foopackage manner. Defaults to undef, which means that
173 package links will not be made.
174
175 =cut
176
177
178 set_default(\%config,'package_pages',undef);
179
180 =item subscription_domain $gSubscriptionDomain
181
182 Domain where subscriptions to package lists happen
183
184 =cut
185
186
187 set_default(\%config,'subscription_domain',undef);
188
189 =back
190
191 =cut
192
193
194 =head2 Project Identification
195
196 =over
197
198 =item project $gProject
199
200 Name of the project
201
202 Default: 'Something'
203
204 =cut
205
206 set_default(\%config,'project','Something');
207
208 =item project_title $gProjectTitle
209
210 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
211
212 Default: "$config{project} Debbugs Install"
213
214 =cut
215
216 set_default(\%config,'project_title',"$config{project} Debbugs Install");
217
218 =item maintainer $gMaintainer
219
220 Name of the maintainer of this debbugs install
221
222 Default: 'Local DebBugs Owner's
223
224 =cut
225
226 set_default(\%config,'maintainer','Local DebBugs Owner');
227
228 =item maintainer_webpage $gMaintainerWebpage
229
230 Webpage of the maintainer of this install of debbugs
231
232 Default: "$config{web_domain}/~owner"
233
234 =cut
235
236 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
237
238 =item maintainer_email
239
240 Email address of the maintainer of this Debbugs install
241
242 Default: 'root@'.$config{email_domain}
243
244 =cut
245
246 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
247
248 =item unknown_maintainer_email
249
250 Email address where packages with an unknown maintainer will be sent
251
252 Default: $config{maintainer_email}
253
254 =back
255
256 =cut
257
258 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
259
260 =head2 BTS Mailing Lists
261
262
263 =over
264
265 =item submit_list
266
267 =item maint_list
268
269 =item forward_list
270
271 =item done_list
272
273 =item request_list
274
275 =item submitter_list
276
277 =item control_list
278
279 =item summary_list
280
281 =item mirror_list
282
283 =back
284
285 =cut
286
287 set_default(\%config,   'submit_list',   'bug-submit-list');
288 set_default(\%config,    'maint_list',    'bug-maint-list');
289 set_default(\%config,    'quiet_list',    'bug-quiet-list');
290 set_default(\%config,  'forward_list',  'bug-forward-list');
291 set_default(\%config,     'done_list',     'bug-done-list');
292 set_default(\%config,  'request_list',  'bug-request-list');
293 set_default(\%config,'submitter_list','bug-submitter-list');
294 set_default(\%config,  'control_list',  'bug-control-list');
295 set_default(\%config,  'summary_list',  'bug-summary-list');
296 set_default(\%config,   'mirror_list',   'bug-mirror-list');
297 set_default(\%config,   'strong_list',   'bug-strong-list');
298
299 =head2 Misc Options
300
301 =over
302
303 =cut
304
305 set_default(\%config,'mailer','exim');
306 set_default(\%config,'bug','bug');
307 set_default(\%config,'bugs','bugs');
308
309 =item remove_age
310
311 Age at which bugs are archived/removed
312
313 Default: 28
314
315 =cut
316
317 set_default(\%config,'remove_age',28);
318
319 =item save_old_bugs
320
321 Whether old bugs are saved or deleted
322
323 Default: 1
324
325 =cut
326
327 set_default(\%config,'save_old_bugs',1);
328
329 =item distributions
330
331 List of valid distributions
332
333 Default: qw(experimental unstable testing stable oldstable);
334
335 =cut
336
337 set_default(\%config,'distributions',[qw(experimental unstable testing stable oldstable)]);
338
339 =item removal_distribution_tags
340
341 Tags which specifiy distributions to check
342
343 Default: @{$config{distributions}}
344
345 =cut
346
347 set_default(\%config,'removal_distribution_tags',
348             [@{$config{distributions}}]);
349
350 =item removal_default_distribution_tags
351
352 For removal/archival purposes, all bugs are assumed to have these tags
353 set.
354
355 Default: qw(unstable testing);
356
357 =cut
358
359 set_default(\%config,'removal_default_distribution_tags',
360             [qw(unstable testing)]
361            );
362
363 =item removal_architectures
364
365 For removal/archival purposes, these architectures are consulted if
366 there is more than one architecture applicable. If the bug is in a
367 package not in any of these architectures, the architecture actually
368 checked is undefined.
369
370 Default: qw(i386 amd64 arm ppc sparc alpha);
371
372 =cut
373
374 set_default(\%config,'removal_architectures',
375             [qw(i386 amd64 arm ppc sparc alpha)]
376            );
377
378
379 =item package_name_re
380
381 The regex which will match a package name
382
383 Default: '[a-z0-9][a-z0-9\.+-]+'
384
385 =cut
386
387 set_default(\%config,'package_name_re',
388             '[a-z0-9][a-z0-9\.+-]+');
389
390 =item package_version_re
391
392 The regex which will match a package version
393
394 Default: '[A-Za-z0-9:+\.-]+'
395
396 =cut
397
398 set_default(\%config,'package_version_re',
399             '[A-Za-z0-9:+\.~-]+');
400
401
402 =item control_internal_requester
403
404 This address is used by Debbugs::Control as the request address which
405 sent a control request for faked log messages.
406
407 Default:"Debbugs Internal Request <$config{maintainer_email}>"
408
409 =cut
410
411 set_default(\%config,'control_internal_requester',
412             "Debbugs Internal Request <$config{maintainer_email}>",
413            );
414
415 =item control_internal_request_addr
416
417 This address is used by Debbugs::Control as the address to which a
418 faked log message request was sent.
419
420 Default: "internal_control\@$config{email_domain}";
421
422 =cut
423
424 set_default(\%config,'control_internal_request_addr',
425             'internal_control@'.$config{email_domain},
426            );
427
428
429 =item exclude_from_control
430
431 Addresses which are not allowed to send messages to control
432
433 =cut
434
435 set_default(\%config,'exclude_from_control',[]);
436
437
438
439
440 set_default(\%config,'default_severity','normal');
441 set_default(\%config,'show_severities','critical, grave, normal, minor, wishlist');
442 set_default(\%config,'strong_severities',[qw(critical grave)]);
443 set_default(\%config,'severity_list',[qw(critical grave normal wishlist)]);
444 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
445                                          grave    => "Grave $config{bugs}",
446                                          normal   => "Normal $config{bugs}",
447                                          wishlist => "Wishlist $config{bugs}",
448                                         });
449
450 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
451                              @{$config{distributions}}
452                             ]);
453
454 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
455             '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
456             '^mail.*agent|^tcpmail|^bitmail|^mailman');
457
458 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
459 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
460 set_default(\%config,'incoming_dir','incoming');
461 set_default(\%config,'web_dir','/var/lib/debbugs/www');
462 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
463 set_default(\%config,'lib_path','/usr/lib/debbugs');
464
465 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
466 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
467 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
468 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
469
470
471 =item version_packages_dir
472
473 Location where the version package information is kept; defaults to
474 spool_dir/../versions/pkg
475
476 =cut
477
478 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
479
480 =item version_time_index
481
482 Location of the version/time index file. Defaults to
483 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
484 exists; otherwise defaults to undef.
485
486 =cut
487
488
489 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
490
491 =item version_index
492
493 Location of the version index file. Defaults to
494 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
495 exists; otherwise defaults to undef.
496
497 =cut
498
499 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
500
501 =item binary_source_map
502
503 Location of the binary -> source map. Defaults to
504 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
505 exists; otherwise defaults to undef.
506
507 =cut
508
509 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
510
511 =item source_binary_map
512
513 Location of the source -> binary map. Defaults to
514 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
515 exists; otherwise defaults to undef.
516
517 =cut
518
519 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
520
521
522
523 set_default(\%config,'post_processall',[]);
524
525 =item sendmail
526
527 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
528
529 =cut
530
531 set_default(\%config,'sendmail','/usr/lib/sendmail');
532
533 =item spam_scan
534
535 Whether or not spamscan is being used; defaults to 0 (not being used
536
537 =cut
538
539 set_default(\%config,'spam_scan',0);
540
541
542 =back
543
544
545 =head2 Text Fields
546
547 The following are the only text fields in general use in the scripts;
548 a few additional text fields are defined in text.in, but are only used
549 in db2html and a few other specialty scripts.
550
551 Earlier versions of debbugs defined these values in /etc/debbugs/text,
552 but now they are required to be in the configuration file. [Eventually
553 the longer ones will move out into a fully fledged template system.]
554
555 =cut
556
557 =over
558
559 =item bad_email_prefix
560
561 This prefixes the text of all lines in a bad e-mail message ack.
562
563 =cut
564
565 set_default(\%config,'bad_email_prefix','');
566
567
568 =item text_instructions
569
570 This gives more information about bad e-mails to receive.in
571
572 =cut
573
574 set_default(\%config,'text_instructions',$config{bad_email_prefix});
575
576 =item html_tail
577
578 This shows up at the end of (most) html pages
579
580 =cut
581
582 set_default(\%config,'html_tail',<<END);
583  <ADDRESS>$config{maintainer} &lt;<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>&gt;.
584  Last modified:
585  <!--timestamp-->
586  SUBSTITUTE_DTIME
587  <!--timestamp-->
588  <P>
589  <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
590  Copyright (C) 1999 Darren O. Benham,
591  1997,2003 nCipher Corporation Ltd,
592  1994-97 Ian Jackson.
593  </ADDRESS>
594 END
595
596
597 =item html_expire_note
598
599 This message explains what happens to archive/remove-able bugs
600
601 =cut
602
603 set_default(\%config,'html_expire_note',
604             "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
605
606 =back
607
608 =cut
609
610
611 sub read_config{
612      my ($conf_file) = @_;
613      # first, figure out what type of file we're reading in.
614      my $fh = new IO::File $conf_file,'r'
615           or die "Unable to open configuration file $conf_file for reading: $!";
616      # A new version configuration file must have a comment as its first line
617      my $first_line = <$fh>;
618      my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
619      if (defined $version) {
620           if ($version == 1) {
621                # Do something here;
622                die "Version 1 configuration files not implemented yet";
623           }
624           else {
625                die "Version $version configuration files are not supported";
626           }
627      }
628      else {
629           # Ugh. Old configuration file
630           # What we do here is we create a new Safe compartment
631           # so fucked up crap in the config file doesn't sink us.
632           my $cpt = new Safe or die "Unable to create safe compartment";
633           # perldoc Opcode; for details
634           $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
635           $cpt->reval(qq(require '$conf_file';));
636           die "Error in configuration file: $@" if $@;
637           # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
638           # we want to glob in from the configuration file
639           for my $variable (@{$EXPORT_TAGS{globals}}) {
640                my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
641                my $var_glob = $cpt->varglob($glob_name);
642                my $value; #= $cpt->reval("return $variable");
643                # print STDERR "$variable $value",qq(\n);
644                if (defined $var_glob) {{
645                     no strict 'refs';
646                     if ($glob_type eq '%') {
647                          $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
648                     }
649                     elsif ($glob_type eq '@') {
650                          $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
651                     }
652                     else {
653                          $value = ${*{$var_glob}};
654                     }
655                     # We punt here, because we can't tell if the value was
656                     # defined intentionally, or if it was just left alone;
657                     # this tries to set sane defaults.
658                     set_default(\%config,$hash_name,$value) if defined $value;
659                }}
660           }
661      }
662 }
663
664 sub __convert_name{
665      my ($variable) = @_;
666      my $hash_name = $variable;
667      $hash_name =~ s/^([\$\%\@])g//;
668      my $glob_type = $1;
669      my $glob_name = 'g'.$hash_name;
670      $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
671      $hash_name =~ s/^([A-Z]+)/lc($1)/e;
672      $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
673      return $hash_name unless wantarray;
674      return ($hash_name,$glob_name,$glob_type);
675 }
676
677 # set_default
678
679 # sets the configuration hash to the default value if it's not set,
680 # otherwise doesn't do anything
681 # If $USING_GLOBALS, then sets an appropriate global.
682
683 sub set_default{
684      my ($config,$option,$value) = @_;
685      my $varname;
686      if ($USING_GLOBALS) {
687           # fix up the variable name
688           $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
689           # Fix stupid HTML names
690           $varname =~ s/(Html|Cgi)/uc($1)/ge;
691      }
692      # update the configuration value
693      if (not $USING_GLOBALS and not exists $config->{$option}) {
694           $config->{$option} = $value;
695      }
696      elsif ($USING_GLOBALS) {{
697           no strict 'refs';
698           # Need to check if a value has already been set in a global
699           if (defined *{"Debbugs::Config::${varname}"}) {
700                $config->{$option} = *{"Debbugs::Config::${varname}"};
701           }
702           else {
703                $config->{$option} = $value;
704           }
705      }}
706      if ($USING_GLOBALS) {{
707           no strict 'refs';
708           *{"Debbugs::Config::${varname}"} = $config->{$option};
709      }}
710 }
711
712
713 ### import magick
714
715 # All we care about here is whether we've been called with the globals or text option;
716 # if so, then we need to export some symbols back up.
717 # In any event, we call exporter.
718
719 sub import {
720      if (grep /^:(?:text|globals)$/, @_) {
721           $USING_GLOBALS=1;
722           for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
723                my $tmp = $variable;
724                no strict 'refs';
725                # Yes, I don't care if these are only used once
726                no warnings 'once';
727                # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
728                no warnings 'misc';
729                my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
730                $tmp =~ s/^[\%\$\@]//;
731                *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
732           }
733      }
734      Debbugs::Config->export_to_level(1,@_);
735 }
736
737
738 1;