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