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