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