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($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($gSendmail $gLibPath $gSpamScan @gExcludeFromControl),
  63                                  qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
  64                                  qw(%gTagsSingleLetter),
  65                                  qw(%gSearchEstraier),
  66                                  qw(%gDistributionAliases),
  67                                  qw(%gObsoleteSeverities),
  68                                  qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
  69                                  qw(@gRemovalStrongSeverityDefaultDistributionTags),
  70                                  qw(@gDefaultArchitectures),
  71                                  qw($gTemplateDir),
  72                                  qw($gDefaultPackage),
  73                                  qw($gSpamMaxThreads $gSpamSpamsPerThread $gSpamKeepRunning $gSpamScan $gSpamCrossassassinDb),
  74                                 ],
  75                      text     => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
  76                                  ],
  77                      config   => [qw(%config)],
  78                     );
  79      @EXPORT_OK = ();
  80      Exporter::export_ok_tags(qw(globals text config));
  81      $EXPORT_TAGS{all} = [@EXPORT_OK];
  82      $ENV{HOME} = '' if not defined $ENV{HOME};
  83 }
  84
  85 use File::Basename qw(dirname);
  86 use IO::File;
  87 use Safe;
  88
  89 =head1 CONFIGURATION VARIABLES
  90
  91 =head2 General Configuration
  92
  93 =over
  94
  95 =cut
  96
  97 # read in the files;
  98 %config = ();
  99 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
 100 # This enables us to test things that are -T.
 101 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
 102      if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] = $<) {
 103           $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
 104           $ENV{DEBBUGS_CONFIG_FILE} = $1;
 105      }
 106      else {
 107           die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
 108      }
 109 }
 110 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
 111
 112 =item email_domain $gEmailDomain
 113
 114 The email domain of the bts
 115
 116 =cut
 117
 118 set_default(\%config,'email_domain','bugs.something');
 119
 120 =item list_domain $gListDomain
 121
 122 The list domain of the bts, defaults to the email domain
 123
 124 =cut
 125
 126 set_default(\%config,'list_domain',$config{email_domain});
 127
 128 =item web_host $gWebHost
 129
 130 The web host of the bts; defaults to the email domain
 131
 132 =cut
 133
 134 set_default(\%config,'web_host',$config{email_domain});
 135
 136 =item web_host_bug_dir $gWebHostDir
 137
 138 The directory of the web host on which bugs are kept, defaults to C<''>
 139
 140 =cut
 141
 142 set_default(\%config,'web_host_bug_dir','');
 143
 144 =item web_domain $gWebDomain
 145
 146 Full path of the web domain where bugs are kept, defaults to the
 147 concatenation of L</web_host> and L</web_host_bug_dir>
 148
 149 =cut
 150
 151 set_default(\%config,'web_domain',$config{web_host}.($config{web_host}=~m{/$}?'':'/').$config{web_host_bug_dir});
 152
 153 =item html_suffix $gHTMLSuffix
 154
 155 Suffix of html pages, defaults to .html
 156
 157 =cut
 158
 159 set_default(\%config,'html_suffix','.html');
 160
 161 =item cgi_domain $gCGIDomain
 162
 163 Full path of the web domain where cgi scripts are kept. Defaults to
 164 the concatentation of L</web_host> and cgi.
 165
 166 =cut
 167
 168 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
 169
 170 =item mirrors @gMirrors
 171
 172 List of mirrors [What these mirrors are used for, no one knows.]
 173
 174 =cut
 175
 176
 177 set_default(\%config,'mirrors',[]);
 178
 179 =item package_pages  $gPackagePages
 180
 181 Domain where the package pages are kept; links should work in a
 182 package_pages/foopackage manner. Defaults to undef, which means that
 183 package links will not be made.
 184
 185 =cut
 186
 187
 188 set_default(\%config,'package_pages',undef);
 189
 190 =item package_pages  $gUsertagPackageDomain
 191
 192 Domain where where usertags of packages belong; defaults to $gPackagePages
 193
 194 =cut
 195
 196 set_default(\%config,'usertag_package_domain',$config{package_pages});
 197
 198
 199 =item subscription_domain $gSubscriptionDomain
 200
 201 Domain where subscriptions to package lists happen
 202
 203 =cut
 204
 205
 206 set_default(\%config,'subscription_domain',undef);
 207
 208 =back
 209
 210 =cut
 211
 212
 213 =head2 Project Identification
 214
 215 =over
 216
 217 =item project $gProject
 218
 219 Name of the project
 220
 221 Default: 'Something'
 222
 223 =cut
 224
 225 set_default(\%config,'project','Something');
 226
 227 =item project_title $gProjectTitle
 228
 229 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
 230
 231 Default: "$config{project} Debbugs Install"
 232
 233 =cut
 234
 235 set_default(\%config,'project_title',"$config{project} Debbugs Install");
 236
 237 =item maintainer $gMaintainer
 238
 239 Name of the maintainer of this debbugs install
 240
 241 Default: 'Local DebBugs Owner's
 242
 243 =cut
 244
 245 set_default(\%config,'maintainer','Local DebBugs Owner');
 246
 247 =item maintainer_webpage $gMaintainerWebpage
 248
 249 Webpage of the maintainer of this install of debbugs
 250
 251 Default: "$config{web_domain}/~owner"
 252
 253 =cut
 254
 255 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
 256
 257 =item maintainer_email $gMaintainerEmail
 258
 259 Email address of the maintainer of this Debbugs install
 260
 261 Default: 'root@'.$config{email_domain}
 262
 263 =cut
 264
 265 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
 266
 267 =item unknown_maintainer_email
 268
 269 Email address where packages with an unknown maintainer will be sent
 270
 271 Default: $config{maintainer_email}
 272
 273 =back
 274
 275 =cut
 276
 277 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
 278
 279 =head2 BTS Mailing Lists
 280
 281
 282 =over
 283
 284 =item submit_list
 285
 286 =item maint_list
 287
 288 =item forward_list
 289
 290 =item done_list
 291
 292 =item request_list
 293
 294 =item submitter_list
 295
 296 =item control_list
 297
 298 =item summary_list
 299
 300 =item mirror_list
 301
 302 =cut
 303
 304 set_default(\%config,   'submit_list',   'bug-submit-list');
 305 set_default(\%config,    'maint_list',    'bug-maint-list');
 306 set_default(\%config,    'quiet_list',    'bug-quiet-list');
 307 set_default(\%config,  'forward_list',  'bug-forward-list');
 308 set_default(\%config,     'done_list',     'bug-done-list');
 309 set_default(\%config,  'request_list',  'bug-request-list');
 310 set_default(\%config,'submitter_list','bug-submitter-list');
 311 set_default(\%config,  'control_list',  'bug-control-list');
 312 set_default(\%config,  'summary_list',  'bug-summary-list');
 313 set_default(\%config,   'mirror_list',   'bug-mirror-list');
 314 set_default(\%config,   'strong_list',   'bug-strong-list');
 315
 316 =item bug_subscription_domain
 317
 318 Domain of list for messages regarding a single bug; prefixed with
 319 bug=${bugnum}@ when bugs are actually sent out. Set to undef or '' to
 320 disable sending messages to the bug subscription list.
 321
 322 Default: list_domain
 323
 324 =back
 325
 326 =cut
 327
 328 set_default(\%config,'bug_subscription_domain',$config{list_domain});
 329
 330
 331 =head2 Misc Options
 332
 333 =over
 334
 335 =cut
 336
 337 set_default(\%config,'mailer','exim');
 338 set_default(\%config,'bug','bug');
 339 set_default(\%config,'bugs','bugs');
 340
 341 =item remove_age
 342
 343 Age at which bugs are archived/removed
 344
 345 Default: 28
 346
 347 =cut
 348
 349 set_default(\%config,'remove_age',28);
 350
 351 =item save_old_bugs
 352
 353 Whether old bugs are saved or deleted
 354
 355 Default: 1
 356
 357 =cut
 358
 359 set_default(\%config,'save_old_bugs',1);
 360
 361 =item distribution_aliases
 362
 363 Map of distribution aliases to the distribution name
 364
 365 Default:
 366          {experimental => 'experimental',
 367           unstable     => 'unstable',
 368           testing      => 'testing',
 369           stable       => 'stable',
 370           oldstable    => 'oldstable',
 371           sid          => 'unstable',
 372           lenny        => 'testing',
 373           etch         => 'stable',
 374           sarge        => 'oldstable',
 375          }
 376
 377 =cut
 378
 379 set_default(\%config,'distribution_aliases',
 380             {experimental => 'experimental',
 381              unstable     => 'unstable',
 382              testing      => 'testing',
 383              stable       => 'stable',
 384              oldstable    => 'oldstable',
 385              sid          => 'unstable',
 386              lenny        => 'testing',
 387              etch         => 'stable',
 388              sarge        => 'oldstable',
 389             },
 390            );
 391
 392
 393
 394 =item distributions
 395
 396 List of valid distributions
 397
 398 Default: The values of the distribution aliases map.
 399
 400 =cut
 401
 402 my %_distributions_default;
 403 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
 404 set_default(\%config,'distributions',[keys %_distributions_default]);
 405
 406
 407 =item default_architectures
 408
 409 List of default architectures to use when architecture(s) are not
 410 specified
 411
 412 Default: i386 amd64 arm ppc sparc alpha
 413
 414 =cut
 415
 416 set_default(\%config,'default_architectures',
 417             [qw(i386 amd64 arm powerpc sparc alpha)]
 418            );
 419
 420 =item removal_unremovable_tags
 421
 422 Bugs which have these tags set cannot be archived
 423
 424 Default: []
 425
 426 =cut
 427
 428 set_default(\%config,'removal_unremovable_tags',
 429             [],
 430            );
 431
 432 =item removal_distribution_tags
 433
 434 Tags which specifiy distributions to check
 435
 436 Default: @{$config{distributions}}
 437
 438 =cut
 439
 440 set_default(\%config,'removal_distribution_tags',
 441             [@{$config{distributions}}]);
 442
 443 =item removal_default_distribution_tags
 444
 445 For removal/archival purposes, all bugs are assumed to have these tags
 446 set.
 447
 448 Default: qw(unstable testing);
 449
 450 =cut
 451
 452 set_default(\%config,'removal_default_distribution_tags',
 453             [qw(unstable testing)]
 454            );
 455
 456 =item removal_strong_severity_default_distribution_tags
 457
 458 For removal/archival purposes, all bugs with strong severity are
 459 assumed to have these tags set.
 460
 461 Default: qw(unstable testing stable);
 462
 463 =cut
 464
 465 set_default(\%config,'removal_strong_severity_default_distribution_tags',
 466             [qw(unstable testing stable)]
 467            );
 468
 469
 470 =item removal_architectures
 471
 472 For removal/archival purposes, these architectures are consulted if
 473 there is more than one architecture applicable. If the bug is in a
 474 package not in any of these architectures, the architecture actually
 475 checked is undefined.
 476
 477 Default: value of default_architectures
 478
 479 =cut
 480
 481 set_default(\%config,'removal_architectures',
 482             $config{default_architectures},
 483            );
 484
 485
 486 =item package_name_re
 487
 488 The regex which will match a package name
 489
 490 Default: '[a-z0-9][a-z0-9\.+-]+'
 491
 492 =cut
 493
 494 set_default(\%config,'package_name_re',
 495             '[a-z0-9][a-z0-9\.+-]+');
 496
 497 =item package_version_re
 498
 499 The regex which will match a package version
 500
 501 Default: '[A-Za-z0-9:+\.-]+'
 502
 503 =cut
 504
 505
 506 set_default(\%config,'package_version_re',
 507             '[A-Za-z0-9:+\.~-]+');
 508
 509
 510 =item default_package
 511
 512 This is the name of the default package. If set, bugs assigned to
 513 packages without a maintainer and bugs missing a Package: psuedoheader
 514 will be assigned to this package instead.
 515
 516 Defaults to unset, which is the traditional debbugs behavoir
 517
 518 =cut
 519
 520 set_default(\%config,'default_package',
 521             undef
 522            );
 523
 524
 525 =item control_internal_requester
 526
 527 This address is used by Debbugs::Control as the request address which
 528 sent a control request for faked log messages.
 529
 530 Default:"Debbugs Internal Request <$config{maintainer_email}>"
 531
 532 =cut
 533
 534 set_default(\%config,'control_internal_requester',
 535             "Debbugs Internal Request <$config{maintainer_email}>",
 536            );
 537
 538 =item control_internal_request_addr
 539
 540 This address is used by Debbugs::Control as the address to which a
 541 faked log message request was sent.
 542
 543 Default: "internal_control\@$config{email_domain}";
 544
 545 =cut
 546
 547 set_default(\%config,'control_internal_request_addr',
 548             'internal_control@'.$config{email_domain},
 549            );
 550
 551
 552 =item exclude_from_control
 553
 554 Addresses which are not allowed to send messages to control
 555
 556 =cut
 557
 558 set_default(\%config,'exclude_from_control',[]);
 559
 560
 561
 562 =item default_severity
 563
 564 The default severity of bugs which have no severity set
 565
 566 Default: normal
 567
 568 =cut
 569
 570 set_default(\%config,'default_severity','normal');
 571
 572 =item severity_display
 573
 574 A hashref of severities and the informative text which describes them.
 575
 576 Default:
 577
 578  {critical => "Critical $config{bugs}",
 579   grave    => "Grave $config{bugs}",
 580   normal   => "Normal $config{bugs}",
 581   wishlist => "Wishlist $config{bugs}",
 582  }
 583
 584 =cut
 585
 586 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
 587                                          grave    => "Grave $config{bugs}",
 588                                          normal   => "Normal $config{bugs}",
 589                                          wishlist => "Wishlist $config{bugs}",
 590                                         });
 591
 592 =item show_severities
 593
 594 A scalar list of the severities to show
 595
 596 Defaults to the concatenation of the keys of the severity_display
 597 hashlist with ', ' above.
 598
 599 =cut
 600
 601 set_default(\%config,'show_severities',join(', ',keys %{$config{severity_display}}));
 602
 603 =item strong_severities
 604
 605 An arrayref of the serious severities which shoud be emphasized
 606
 607 Default: [qw(critical grave)]
 608
 609 =cut
 610
 611 set_default(\%config,'strong_severities',[qw(critical grave)]);
 612
 613 =item severity_list
 614
 615 An arrayref of a list of the severities
 616
 617 Defaults to the keys of the severity display hashref
 618
 619 =cut
 620
 621 set_default(\%config,'severity_list',[keys %{$config{severity_display}}]);
 622
 623 =item obsolete_severities
 624
 625 A hashref of obsolete severities with the replacing severity
 626
 627 Default: {}
 628
 629 =cut
 630
 631 set_default(\%config,'obsolete_severities',{});
 632
 633 =item tags
 634
 635 An arrayref of the tags used
 636
 637 Default: [qw(patch wontfix moreinfo unreproducible fixed)] and also
 638 includes the distributions.
 639
 640 =cut
 641
 642 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
 643                              @{$config{distributions}}
 644                             ]);
 645
 646 set_default(\%config,'tags_single_letter',
 647             {patch => '+',
 648              wontfix => '',
 649              moreinfo => 'M',
 650              unreproducible => 'R',
 651              fixed   => 'F',
 652             }
 653            );
 654
 655 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
 656             '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
 657             '^mail.*agent|^tcpmail|^bitmail|^mailman');
 658
 659 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
 660 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
 661
 662 =item usertag_dir
 663
 664 Directory which contains the usertags
 665
 666 Default: $config{spool_dir}/user
 667
 668 =cut
 669
 670 set_default(\%config,'usertag_dir',$config{spool_dir}.'/user');
 671 set_default(\%config,'incoming_dir','incoming');
 672 set_default(\%config,'web_dir','/var/lib/debbugs/www');
 673 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
 674 set_default(\%config,'lib_path','/usr/lib/debbugs');
 675
 676
 677 =item template_dir
 678
 679 directory of templates; defaults to /usr/share/debbugs/templates.
 680
 681 =cut
 682
 683 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
 684
 685
 686 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
 687 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
 688 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maint');
 689 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
 690 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
 691
 692
 693 =item version_packages_dir
 694
 695 Location where the version package information is kept; defaults to
 696 spool_dir/../versions/pkg
 697
 698 =cut
 699
 700 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
 701
 702 =item version_time_index
 703
 704 Location of the version/time index file. Defaults to
 705 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
 706 exists; otherwise defaults to undef.
 707
 708 =cut
 709
 710
 711 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
 712
 713 =item version_index
 714
 715 Location of the version index file. Defaults to
 716 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
 717 exists; otherwise defaults to undef.
 718
 719 =cut
 720
 721 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
 722
 723 =item binary_source_map
 724
 725 Location of the binary -> source map. Defaults to
 726 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
 727 exists; otherwise defaults to undef.
 728
 729 =cut
 730
 731 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
 732
 733 =item source_binary_map
 734
 735 Location of the source -> binary map. Defaults to
 736 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
 737 exists; otherwise defaults to undef.
 738
 739 =cut
 740
 741 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
 742
 743
 744
 745 set_default(\%config,'post_processall',[]);
 746
 747 =item sendmail
 748
 749 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
 750
 751 =cut
 752
 753 set_default(\%config,'sendmail','/usr/lib/sendmail');
 754
 755 =item spam_scan
 756
 757 Whether or not spamscan is being used; defaults to 0 (not being used
 758
 759 =cut
 760
 761 set_default(\%config,'spam_scan',0);
 762
 763 =item spam_crossassassin_db
 764
 765 Location of the crosassassin database, defaults to
 766 spool_dir/../CrossAssassinDb
 767
 768 =cut
 769
 770 set_default(\%config,'spam_crossassassin_db',$config{spool_dir}.'/../CrossAssassinDb');
 771
 772 =item spam_max_cross
 773
 774 Maximum number of cross-posted messages
 775
 776 =cut
 777
 778 set_default(\%config,'spam_max_cross',6);
 779
 780
 781 =item spam_spams_per_thread
 782
 783 Number of spams for each thread (on average). Defaults to 200
 784
 785 =cut
 786
 787 set_default(\%config,'spam_spams_per_thread',200);
 788
 789 =item spam_max_threads
 790
 791 Maximum number of threads to start. Defaults to 20
 792
 793 =cut
 794
 795 set_default(\%config,'spam_max_threads',20);
 796
 797 =item spam_keep_running
 798
 799 Maximum number of seconds to run without restarting. Defaults to 3600.
 800
 801 =cut
 802
 803 set_default(\%config,'spam_keep_running',3600);
 804
 805 =item spam_mailbox
 806
 807 Location to store spam messages; is run through strftime to allow for
 808 %d,%m,%Y, et al. Defaults to 'spool_dir/../mail/spam/assassinated.%Y-%m-%d'
 809
 810 =cut
 811
 812 set_default(\%config,'spam_mailbox',$config{spool_dir}.'/../mail/spam/assassinated.%Y-%m-%d');
 813
 814 =item spam_crossassassin_mailbox
 815
 816 Location to store crossassassinated messages; is run through strftime
 817 to allow for %d,%m,%Y, et al. Defaults to
 818 'spool_dir/../mail/spam/crossassassinated.%Y-%m-%d'
 819
 820 =cut
 821
 822 set_default(\%config,'spam_crossassassin_mailbox',$config{spool_dir}.'/../mail/spam/crossassassinated.%Y-%m-%d');
 823
 824 =item spam_local_tests_only
 825
 826 Whether only local tests are run, defaults to 0
 827
 828 =cut
 829
 830 set_default(\%config,'spam_local_tests_only',0);
 831
 832 =item spam_user_prefs
 833
 834 User preferences for spamassassin, defaults to $ENV{HOME}/.spamassassin/user_prefs
 835
 836 =cut
 837
 838 set_default(\%config,'spam_user_prefs',"$ENV{HOME}/.spamassassin/user_prefs");
 839
 840 =item spam_rules_dir
 841
 842 Site rules directory for spamassassin, defaults to
 843 '/usr/share/spamassassin'
 844
 845 =cut
 846
 847 set_default(\%config,'spam_rules_dir','/usr/share/spamassassin');
 848
 849 =back
 850
 851
 852 =head2 Text Fields
 853
 854 The following are the only text fields in general use in the scripts;
 855 a few additional text fields are defined in text.in, but are only used
 856 in db2html and a few other specialty scripts.
 857
 858 Earlier versions of debbugs defined these values in /etc/debbugs/text,
 859 but now they are required to be in the configuration file. [Eventually
 860 the longer ones will move out into a fully fledged template system.]
 861
 862 =cut
 863
 864 =over
 865
 866 =item bad_email_prefix
 867
 868 This prefixes the text of all lines in a bad e-mail message ack.
 869
 870 =cut
 871
 872 set_default(\%config,'bad_email_prefix','');
 873
 874
 875 =item text_instructions
 876
 877 This gives more information about bad e-mails to receive.in
 878
 879 =cut
 880
 881 set_default(\%config,'text_instructions',$config{bad_email_prefix});
 882
 883 =item html_tail
 884
 885 This shows up at the end of (most) html pages
 886
 887 In many pages this has been replaced by the html/tail template.
 888
 889 =cut
 890
 891 set_default(\%config,'html_tail',<<END);
 892  <ADDRESS>$config{maintainer} &lt;<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>&gt;.
 893  Last modified:
 894  <!--timestamp-->
 895  SUBSTITUTE_DTIME
 896  <!--timestamp-->
 897  <P>
 898  <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
 899  Copyright (C) 1999 Darren O. Benham,
 900  1997,2003 nCipher Corporation Ltd,
 901  1994-97 Ian Jackson.
 902  </ADDRESS>
 903 END
 904
 905
 906 =item html_expire_note
 907
 908 This message explains what happens to archive/remove-able bugs
 909
 910 =cut
 911
 912 set_default(\%config,'html_expire_note',
 913             "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
 914
 915 =back
 916
 917 =cut
 918
 919
 920 sub read_config{
 921      my ($conf_file) = @_;
 922      # first, figure out what type of file we're reading in.
 923      my $fh = new IO::File $conf_file,'r'
 924           or die "Unable to open configuration file $conf_file for reading: $!";
 925      # A new version configuration file must have a comment as its first line
 926      my $first_line = <$fh>;
 927      my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
 928      if (defined $version) {
 929           if ($version == 1) {
 930                # Do something here;
 931                die "Version 1 configuration files not implemented yet";
 932           }
 933           else {
 934                die "Version $version configuration files are not supported";
 935           }
 936      }
 937      else {
 938           # Ugh. Old configuration file
 939           # What we do here is we create a new Safe compartment
 940           # so fucked up crap in the config file doesn't sink us.
 941           my $cpt = new Safe or die "Unable to create safe compartment";
 942           # perldoc Opcode; for details
 943           $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
 944           $cpt->reval(qq(require '$conf_file';));
 945           die "Error in configuration file: $@" if $@;
 946           # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
 947           # we want to glob in from the configuration file
 948           for my $variable (@{$EXPORT_TAGS{globals}}) {
 949                my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
 950                my $var_glob = $cpt->varglob($glob_name);
 951                my $value; #= $cpt->reval("return $variable");
 952                # print STDERR "$variable $value",qq(\n);
 953                if (defined $var_glob) {{
 954                     no strict 'refs';
 955                     if ($glob_type eq '%') {
 956                          $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
 957                     }
 958                     elsif ($glob_type eq '@') {
 959                          $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
 960                     }
 961                     else {
 962                          $value = ${*{$var_glob}};
 963                     }
 964                     # We punt here, because we can't tell if the value was
 965                     # defined intentionally, or if it was just left alone;
 966                     # this tries to set sane defaults.
 967                     set_default(\%config,$hash_name,$value) if defined $value;
 968                }}
 969           }
 970      }
 971 }
 972
 973 sub __convert_name{
 974      my ($variable) = @_;
 975      my $hash_name = $variable;
 976      $hash_name =~ s/^([\$\%\@])g//;
 977      my $glob_type = $1;
 978      my $glob_name = 'g'.$hash_name;
 979      $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
 980      $hash_name =~ s/^([A-Z]+)/lc($1)/e;
 981      $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
 982      return $hash_name unless wantarray;
 983      return ($hash_name,$glob_name,$glob_type);
 984 }
 985
 986 # set_default
 987
 988 # sets the configuration hash to the default value if it's not set,
 989 # otherwise doesn't do anything
 990 # If $USING_GLOBALS, then sets an appropriate global.
 991
 992 sub set_default{
 993      my ($config,$option,$value) = @_;
 994      my $varname;
 995      if ($USING_GLOBALS) {
 996           # fix up the variable name
 997           $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
 998           # Fix stupid HTML names
 999           $varname =~ s/(Html|Cgi)/uc($1)/ge;
1000      }
1001      # update the configuration value
1002      if (not $USING_GLOBALS and not exists $config->{$option}) {
1003           $config->{$option} = $value;
1004      }
1005      elsif ($USING_GLOBALS) {{
1006           no strict 'refs';
1007           # Need to check if a value has already been set in a global
1008           if (defined *{"Debbugs::Config::${varname}"}) {
1009                $config->{$option} = *{"Debbugs::Config::${varname}"};
1010           }
1011           else {
1012                $config->{$option} = $value;
1013           }
1014      }}
1015      if ($USING_GLOBALS) {{
1016           no strict 'refs';
1017           *{"Debbugs::Config::${varname}"} = $config->{$option};
1018      }}
1019 }
1020
1021
1022 ### import magick
1023
1024 # All we care about here is whether we've been called with the globals or text option;
1025 # if so, then we need to export some symbols back up.
1026 # In any event, we call exporter.
1027
1028 sub import {
1029      if (grep /^:(?:text|globals)$/, @_) {
1030           $USING_GLOBALS=1;
1031           for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
1032                my $tmp = $variable;
1033                no strict 'refs';
1034                # Yes, I don't care if these are only used once
1035                no warnings 'once';
1036                # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
1037                no warnings 'misc';
1038                my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1039                $tmp =~ s/^[\%\$\@]//;
1040                *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
1041           }
1042      }
1043      Debbugs::Config->export_to_level(1,@_);
1044 }
1045
1046
1047 1;