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