FS/FS/Conf.pm

   1 package FS::Conf;
   2
   3 use vars qw($default_dir @config_items $DEBUG );
   4 use IO::File;
   5 use File::Basename;
   6 use FS::ConfItem;
   7
   8 $DEBUG = 0;
   9
  10 =head1 NAME
  11
  12 FS::Conf - Freeside configuration values
  13
  14 =head1 SYNOPSIS
  15
  16   use FS::Conf;
  17
  18   $conf = new FS::Conf "/config/directory";
  19
  20   $FS::Conf::default_dir = "/config/directory";
  21   $conf = new FS::Conf;
  22
  23   $dir = $conf->dir;
  24
  25   $value = $conf->config('key');
  26   @list  = $conf->config('key');
  27   $bool  = $conf->exists('key');
  28
  29   $conf->touch('key');
  30   $conf->set('key' => 'value');
  31   $conf->delete('key');
  32
  33   @config_items = $conf->config_items;
  34
  35 =head1 DESCRIPTION
  36
  37 Read and write Freeside configuration values.  Keys currently map to filenames,
  38 but this may change in the future.
  39
  40 =head1 METHODS
  41
  42 =over 4
  43
  44 =item new [ DIRECTORY ]
  45
  46 Create a new configuration object.  A directory arguement is required if
  47 $FS::Conf::default_dir has not been set.
  48
  49 =cut
  50
  51 sub new {
  52   my($proto,$dir) = @_;
  53   my($class) = ref($proto) || $proto;
  54   my($self) = { 'dir' => $dir || $default_dir } ;
  55   bless ($self, $class);
  56 }
  57
  58 =item dir
  59
  60 Returns the directory.
  61
  62 =cut
  63
  64 sub dir {
  65   my($self) = @_;
  66   my $dir = $self->{dir};
  67   -e $dir or die "FATAL: $dir doesn't exist!";
  68   -d $dir or die "FATAL: $dir isn't a directory!";
  69   -r $dir or die "FATAL: Can't read $dir!";
  70   -x $dir or die "FATAL: $dir not searchable (executable)!";
  71   $dir =~ /^(.*)$/;
  72   $1;
  73 }
  74
  75 =item config KEY
  76
  77 Returns the configuration value or values (depending on context) for key.
  78
  79 =cut
  80
  81 sub config {
  82   my($self,$file)=@_;
  83   my($dir)=$self->dir;
  84   my $fh = new IO::File "<$dir/$file" or return;
  85   if ( wantarray ) {
  86     map {
  87       /^(.*)$/
  88         or die "Illegal line (array context) in $dir/$file:\n$_\n";
  89       $1;
  90     } <$fh>;
  91   } else {
  92     <$fh> =~ /^(.*)$/
  93       or die "Illegal line (scalar context) in $dir/$file:\n$_\n";
  94     $1;
  95   }
  96 }
  97
  98 =item exists KEY
  99
 100 Returns true if the specified key exists, even if the corresponding value
 101 is undefined.
 102
 103 =cut
 104
 105 sub exists {
 106   my($self,$file)=@_;
 107   my($dir) = $self->dir;
 108   -e "$dir/$file";
 109 }
 110
 111 =item config_orbase KEY SUFFIX
 112
 113 Returns the configuration value or values (depending on context) for
 114 KEY_SUFFIX, if it exists, otherwise for KEY
 115
 116 =cut
 117
 118 sub config_orbase {
 119   my( $self, $file, $suffix ) = @_;
 120   if ( $self->exists("${file}_$suffix") ) {
 121     $self->config("${file}_$suffix");
 122   } else {
 123     $self->config($file);
 124   }
 125 }
 126
 127 =item touch KEY
 128
 129 Creates the specified configuration key if it does not exist.
 130
 131 =cut
 132
 133 sub touch {
 134   my($self, $file) = @_;
 135   my $dir = $self->dir;
 136   unless ( $self->exists($file) ) {
 137     warn "[FS::Conf] TOUCH $file\n" if $DEBUG;
 138     system('touch', "$dir/$file");
 139   }
 140 }
 141
 142 =item set KEY VALUE
 143
 144 Sets the specified configuration key to the given value.
 145
 146 =cut
 147
 148 sub set {
 149   my($self, $file, $value) = @_;
 150   my $dir = $self->dir;
 151   $value =~ /^(.*)$/s;
 152   $value = $1;
 153   unless ( join("\n", @{[ $self->config($file) ]}) eq $value ) {
 154     warn "[FS::Conf] SET $file\n" if $DEBUG;
 155 #    warn "$dir" if is_tainted($dir);
 156 #    warn "$dir" if is_tainted($file);
 157     chmod 0644, "$dir/$file";
 158     my $fh = new IO::File ">$dir/$file" or return;
 159     chmod 0644, "$dir/$file";
 160     print $fh "$value\n";
 161   }
 162 }
 163 #sub is_tainted {
 164 #             return ! eval { join('',@_), kill 0; 1; };
 165 #         }
 166
 167 =item delete KEY
 168
 169 Deletes the specified configuration key.
 170
 171 =cut
 172
 173 sub delete {
 174   my($self, $file) = @_;
 175   my $dir = $self->dir;
 176   if ( $self->exists($file) ) {
 177     warn "[FS::Conf] DELETE $file\n";
 178     unlink "$dir/$file";
 179   }
 180 }
 181
 182 =item config_items
 183
 184 Returns all of the possible configuration items as FS::ConfItem objects.  See
 185 L<FS::ConfItem>.
 186
 187 =cut
 188
 189 sub config_items {
 190   my $self = shift;
 191   #quelle kludge
 192   @config_items,
 193   ( map {
 194         my $basename = basename($_);
 195         $basename =~ /^(.*)$/;
 196         $basename = $1;
 197         new FS::ConfItem {
 198                            'key'         => $basename,
 199                            'section'     => 'billing',
 200                            'description' => 'Alternate template file for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 201                            'type'        => 'textarea',
 202                          }
 203       } glob($self->dir. '/invoice_template_*')
 204   ),
 205   ( map {
 206         my $basename = basename($_);
 207         $basename =~ /^(.*)$/;
 208         $basename = $1;
 209         new FS::ConfItem {
 210                            'key'         => $basename,
 211                            'section'     => 'billing',
 212                            'description' => 'Alternate LaTeX template for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 213                            'type'        => 'textarea',
 214                          }
 215       } glob($self->dir. '/invoice_latex_*')
 216   ),
 217   ( map {
 218         my $basename = basename($_);
 219         $basename =~ /^(.*)$/;
 220         $basename = $1;
 221         new FS::ConfItem {
 222                            'key'         => $basename,
 223                            'section'     => 'billing',
 224                            'description' => 'Alternate Notes section for LaTeX typeset PostScript invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 225                            'type'        => 'textarea',
 226                          }
 227       } glob($self->dir. '/invoice_latexnotes_*')
 228   );
 229 }
 230
 231 =back
 232
 233 =head1 BUGS
 234
 235 If this was more than just crud that will never be useful outside Freeside I'd
 236 worry that config_items is freeside-specific and icky.
 237
 238 =head1 SEE ALSO
 239
 240 "Configuration" in the web interface (config/config.cgi).
 241
 242 httemplate/docs/config.html
 243
 244 =cut
 245
 246 @config_items = map { new FS::ConfItem $_ } (
 247
 248   {
 249     'key'         => 'address',
 250     'section'     => 'deprecated',
 251     'description' => 'This configuration option is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
 252     'type'        => 'text',
 253   },
 254
 255   {
 256     'key'         => 'alerter_template',
 257     'section'     => 'billing',
 258     'description' => 'Template file for billing method expiration alerts.  See the <a href="../docs/billing.html#invoice_template">billing documentation</a> for details.',
 259     'type'        => 'textarea',
 260   },
 261
 262   {
 263     'key'         => 'apacheroot',
 264     'section'     => 'deprecated',
 265     'description' => '<b>DEPRECATED</b>, add a <i>www_shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  The directory containing Apache virtual hosts',
 266     'type'        => 'text',
 267   },
 268
 269   {
 270     'key'         => 'apacheip',
 271     'section'     => 'deprecated',
 272     'description' => '<b>DEPRECATED</b>, add an <i>apache</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be the current IP address to assign to new virtual hosts',
 273     'type'        => 'text',
 274   },
 275
 276   {
 277     'key'         => 'apachemachine',
 278     'section'     => 'deprecated',
 279     'description' => '<b>DEPRECATED</b>, add a <i>www_shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  A machine with the apacheroot directory and user home directories.  The existance of this file enables setup of virtual host directories, and, in conjunction with the `home\' configuration file, symlinks into user home directories.',
 280     'type'        => 'text',
 281   },
 282
 283   {
 284     'key'         => 'apachemachines',
 285     'section'     => 'deprecated',
 286     'description' => '<b>DEPRECATED</b>, add an <i>apache</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be Apache machines, one per line.  This enables export of `/etc/apache/vhosts.conf\', which can be included in your Apache configuration via the <a href="http://www.apache.org/docs/mod/core.html#include">Include</a> directive.',
 287     'type'        => 'textarea',
 288   },
 289
 290   {
 291     'key'         => 'bindprimary',
 292     'section'     => 'deprecated',
 293     'description' => '<b>DEPRECATED</b>, add a <i>bind</i> <a href="../browse/part_export.cgi">export</a> instead.  Your BIND primary nameserver.  This enables export of /var/named/named.conf and zone files into /var/named',
 294     'type'        => 'text',
 295   },
 296
 297   {
 298     'key'         => 'bindsecondaries',
 299     'section'     => 'deprecated',
 300     'description' => '<b>DEPRECATED</b>, add a <i>bind_slave</i> <a href="../browse/part_export.cgi">export</a> instead.  Your BIND secondary nameservers, one per line.  This enables export of /var/named/named.conf',
 301     'type'        => 'textarea',
 302   },
 303
 304   {
 305     'key'         => 'business-onlinepayment',
 306     'section'     => 'billing',
 307     'description' => '<a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support, at least three lines: processor, login, and password.  An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\').    Optional additional lines are passed to Business::OnlinePayment as %processor_options.',
 308     'type'        => 'textarea',
 309   },
 310
 311   {
 312     'key'         => 'business-onlinepayment-ach',
 313     'section'     => 'billing',
 314     'description' => 'Alternate <a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support for ACH transactions (defaults to regular <b>business-onlinepayment</b>).  At least three lines: processor, login, and password.  An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\').    Optional additional lines are passed to Business::OnlinePayment as %processor_options.',
 315     'type'        => 'textarea',
 316   },
 317
 318   {
 319     'key'         => 'business-onlinepayment-description',
 320     'section'     => 'billing',
 321     'description' => 'String passed as the description field to <a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a>.  Evaluated as a double-quoted perl string, with the following variables available: <code>$agent</code> (the agent name), and <code>$pkgs</code> (a comma-separated list of packages for which these charges apply)',
 322     'type'        => 'text',
 323   },
 324
 325   {
 326     'key'         => 'bsdshellmachines',
 327     'section'     => 'deprecated',
 328     'description' => '<b>DEPRECATED</b>, add a <i>bsdshell</i> <a href="../browse/part_export.cgi">export</a> instead.  Your BSD flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd\' and `/etc/master.passwd\'.',
 329     'type'        => 'textarea',
 330   },
 331
 332   {
 333     'key'         => 'countrydefault',
 334     'section'     => 'UI',
 335     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
 336     'type'        => 'text',
 337   },
 338
 339   {
 340     'key'         => 'cyrus',
 341     'section'     => 'deprecated',
 342     'description' => '<b>DEPRECATED</b>, add a <i>cyrus</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to integrate with <a href="http://asg.web.cmu.edu/cyrus/imapd/">Cyrus IMAP Server</a>, three lines: IMAP server, admin username, and admin password.  Cyrus::IMAP::Admin should be installed locally and the connection to the server secured.',
 343     'type'        => 'textarea',
 344   },
 345
 346   {
 347     'key'         => 'cp_app',
 348     'section'     => 'deprecated',
 349     'description' => '<b>DEPRECATED</b>, add a <i>cp</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to integrate with <a href="http://www.cp.net/">Critial Path Account Provisioning Protocol</a>, four lines: "host:port", username, password, and workgroup (for new users).',
 350     'type'        => 'textarea',
 351   },
 352
 353   {
 354     'key'         => 'deletecustomers',
 355     'section'     => 'UI',
 356     'description' => 'Enable customer deletions.  Be very careful!  Deleting a customer will remove all traces that this customer ever existed!  It should probably only be used when auditing a legacy database.  Normally, you cancel all of a customers\' packages if they cancel service.',
 357     'type'        => 'checkbox',
 358   },
 359
 360   {
 361     'key'         => 'deletepayments',
 362     'section'     => 'UI',
 363     'description' => 'Enable deletion of unclosed payments.  Be very careful!  Only delete payments that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a payment is deleted.',
 364     'type'        => [qw( checkbox text )],
 365   },
 366
 367   {
 368     'key'         => 'deletecredits',
 369     'section'     => 'UI',
 370     'description' => 'Enable deletion of unclosed credits.  Be very careful!  Only delete credits that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a credit is deleted.',
 371     'type'        => [qw( checkbox text )],
 372   },
 373
 374   {
 375     'key'         => 'unapplypayments',
 376     'section'     => 'UI',
 377     'description' => 'Enable "unapplication" of unclosed payments.',
 378     'type'        => 'checkbox',
 379   },
 380
 381   {
 382     'key'         => 'unapplycredits',
 383     'section'     => 'UI',
 384     'description' => 'Enable "unapplication" of unclosed credits.',
 385     'type'        => 'checkbox',
 386   },
 387
 388   {
 389     'key'         => 'dirhash',
 390     'section'     => 'shell',
 391     'description' => 'Optional numeric value to control directory hashing.  If positive, hashes directories for the specified number of levels from the front of the username.  If negative, hashes directories for the specified number of levels from the end of the username.  Some examples: <ul><li>1: user -> <a href="#home">/home</a>/u/user<li>2: user -> <a href="#home">/home</a>/u/s/user<li>-1: user -> <a href="#home">/home</a>/r/user<li>-2: user -> <a href="#home">home</a>/r/e/user</ul>',
 392     'type'        => 'text',
 393   },
 394
 395   {
 396     'key'         => 'disable_customer_referrals',
 397     'section'     => 'UI',
 398     'description' => 'Disable new customer-to-customer referrals in the web interface',
 399     'type'        => 'checkbox',
 400   },
 401
 402   {
 403     'key'         => 'editreferrals',
 404     'section'     => 'UI',
 405     'description' => 'Enable advertising source modification for existing customers',
 406     'type'       => 'checkbox',
 407   },
 408
 409   {
 410     'key'         => 'emailinvoiceonly',
 411     'section'     => 'billing',
 412     'description' => 'Disables postal mail invoices',
 413     'type'       => 'checkbox',
 414   },
 415
 416   {
 417     'key'         => 'disablepostalinvoicedefault',
 418     'section'     => 'billing',
 419     'description' => 'Disables postal mail invoices as the default option in the UI.  Be careful not to setup customers which are not sent invoices.  See <a href ="#emailinvoiceauto">emailinvoiceauto</a>.',
 420     'type'       => 'checkbox',
 421   },
 422
 423   {
 424     'key'         => 'emailinvoiceauto',
 425     'section'     => 'billing',
 426     'description' => 'Automatically adds new accounts to the email invoice list',
 427     'type'       => 'checkbox',
 428   },
 429
 430   {
 431     'key'         => 'exclude_ip_addr',
 432     'section'     => '',
 433     'description' => 'Exclude these from the list of available broadband service IP addresses. (One per line)',
 434     'type'        => 'textarea',
 435   },
 436
 437   {
 438     'key'         => 'erpcdmachines',
 439     'section'     => 'deprecated',
 440     'description' => '<b>DEPRECATED</b>, ERPCD is no longer supported.  Used to be ERPCD authenticaion machines, one per line.  This enables export of `/usr/annex/acp_passwd\' and `/usr/annex/acp_dialup\'',
 441     'type'        => 'textarea',
 442   },
 443
 444   {
 445     'key'         => 'hidecancelledpackages',
 446     'section'     => 'UI',
 447     'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
 448     'type'        => 'checkbox',
 449   },
 450
 451   {
 452     'key'         => 'hidecancelledcustomers',
 453     'section'     => 'UI',
 454     'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
 455     'type'        => 'checkbox',
 456   },
 457
 458   {
 459     'key'         => 'home',
 460     'section'     => 'required',
 461     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
 462     'type'        => 'text',
 463   },
 464
 465   {
 466     'key'         => 'icradiusmachines',
 467     'section'     => 'deprecated',
 468     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to enable radcheck and radreply table population - by default in the Freeside database, or in the database specified by the <a href="http://rootwood.haze.st/aspside/config/config-view.cgi#icradius_secrets">icradius_secrets</a> config option (the radcheck and radreply tables needs to be created manually).  You do not need to use MySQL for your Freeside database to export to an ICRADIUS/FreeRADIUS MySQL database with this option.  <blockquote><b>ADDITIONAL DEPRECATED FUNCTIONALITY</b> (instead use <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Replication">MySQL replication</a> or point icradius_secrets to the external database) - your <a href="ftp://ftp.cheapnet.net/pub/icradius">ICRADIUS</a> machines or <a href="http://www.freeradius.org/">FreeRADIUS</a> (with MySQL authentication) machines, one per line.  Machines listed in this file will have the radcheck table exported to them.  Each line should contain four items, separted by whitespace: machine name, MySQL database name, MySQL username, and MySQL password.  For example: <CODE>"radius.isp.tld&nbsp;radius_db&nbsp;radius_user&nbsp;passw0rd"</CODE></blockquote>',
 469     'type'        => [qw( checkbox textarea )],
 470   },
 471
 472   {
 473     'key'         => 'icradius_mysqldest',
 474     'section'     => 'deprecated',
 475     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be the destination directory for the MySQL databases, on the ICRADIUS/FreeRADIUS machines.  Defaults to "/usr/local/var/".',
 476     'type'        => 'text',
 477   },
 478
 479   {
 480     'key'         => 'icradius_mysqlsource',
 481     'section'     => 'deprecated',
 482     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be the source directory for for the MySQL radcheck table files, on the Freeside machine.  Defaults to "/usr/local/var/freeside".',
 483     'type'        => 'text',
 484   },
 485
 486   {
 487     'key'         => 'icradius_secrets',
 488     'section'     => 'deprecated',
 489     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to specify a database for ICRADIUS/FreeRADIUS export.  Three lines: DBI data source, username and password.',
 490     'type'        => 'textarea',
 491   },
 492
 493   {
 494     'key'         => 'invoice_from',
 495     'section'     => 'required',
 496     'description' => 'Return address on email invoices',
 497     'type'        => 'text',
 498   },
 499
 500   {
 501     'key'         => 'invoice_template',
 502     'section'     => 'required',
 503     'description' => 'Required template file for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 504     'type'        => 'textarea',
 505   },
 506
 507   {
 508     'key'         => 'invoice_latex',
 509     'section'     => 'billing',
 510     'description' => 'Optional LaTeX template for typeset PostScript invoices.',
 511     'type'        => 'textarea',
 512   },
 513
 514   {
 515     'key'         => 'invoice_latexnotes',
 516     'section'     => 'billing',
 517     'description' => 'Notes section for LaTeX typeset PostScript invoices.',
 518     'type'        => 'textarea',
 519   },
 520
 521   {
 522     'key'         => 'invoice_latexfooter',
 523     'section'     => 'billing',
 524     'description' => 'Footer for LaTeX typeset PostScript invoices.',
 525     'type'        => 'textarea',
 526   },
 527
 528   {
 529     'key'         => 'invoice_latexsmallfooter',
 530     'section'     => 'billing',
 531     'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
 532     'type'        => 'textarea',
 533   },
 534
 535   {
 536     'key'         => 'invoice_default_terms',
 537     'section'     => 'billing',
 538     'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.',
 539     'type'        => 'select',
 540     'select_enum' => [ '', 'Payable upon receipt', 'Net 0', 'Net 10', 'Net 15', 'Net 30', 'Net 45', 'Net 60' ],
 541   },
 542
 543   {
 544     'key'         => 'invoice_send_receipts',
 545     'section'     => 'deprecated',q
 546     'description' => '<b>DEPRECATED</b>, this used to send an invoice copy on payments and credits.  See the payment_receipt_email and XXXX instead.',
 547     'type'        => 'checkbox',
 548   },
 549
 550   {
 551     'key'         => 'payment_receipt_email',
 552     'section'     => 'billing',
 553     'description' => 'Template file for payment receipts.',
 554     'type'        => 'textarea',
 555   },
 556
 557   {
 558     'key'         => 'lpr',
 559     'section'     => 'required',
 560     'description' => 'Print command for paper invoices, for example `lpr -h\'',
 561     'type'        => 'text',
 562   },
 563
 564   {
 565     'key'         => 'maildisablecatchall',
 566     'section'     => 'deprecated',
 567     'description' => '<b>DEPRECATED</b>, now the default.  Turning this option on used to disable the requirement that each virtual domain have a catch-all mailbox.',
 568     'type'        => 'checkbox',
 569   },
 570
 571   {
 572     'key'         => 'money_char',
 573     'section'     => '',
 574     'description' => 'Currency symbol - defaults to `$\'',
 575     'type'        => 'text',
 576   },
 577
 578   {
 579     'key'         => 'mxmachines',
 580     'section'     => 'deprecated',
 581     'description' => 'MX entries for new domains, weight and machine, one per line, with trailing `.\'',
 582     'type'        => 'textarea',
 583   },
 584
 585   {
 586     'key'         => 'nsmachines',
 587     'section'     => 'deprecated',
 588     'description' => 'NS nameservers for new domains, one per line, with trailing `.\'',
 589     'type'        => 'textarea',
 590   },
 591
 592   {
 593     'key'         => 'defaultrecords',
 594     'section'     => 'BIND',
 595     'description' => 'DNS entries to add automatically when creating a domain',
 596     'type'        => 'editlist',
 597     'editlist_parts' => [ { type=>'text' },
 598                           { type=>'immutable', value=>'IN' },
 599                           { type=>'select',
 600                             select_enum=>{ map { $_=>$_ } qw(A CNAME MX NS)} },
 601                           { type=> 'text' }, ],
 602   },
 603
 604   {
 605     'key'         => 'arecords',
 606     'section'     => 'deprecated',
 607     'description' => 'A list of tab seperated CNAME records to add automatically when creating a domain',
 608     'type'        => 'textarea',
 609   },
 610
 611   {
 612     'key'         => 'cnamerecords',
 613     'section'     => 'deprecated',
 614     'description' => 'A list of tab seperated CNAME records to add automatically when creating a domain',
 615     'type'        => 'textarea',
 616   },
 617
 618   {
 619     'key'         => 'nismachines',
 620     'section'     => 'deprecated',
 621     'description' => '<b>DEPRECATED</b>.  Your NIS master (not slave master) machines, one per line.  This enables export of `/etc/global/passwd\' and `/etc/global/shadow\'.',
 622     'type'        => 'textarea',
 623   },
 624
 625   {
 626     'key'         => 'passwordmin',
 627     'section'     => 'password',
 628     'description' => 'Minimum password length (default 6)',
 629     'type'        => 'text',
 630   },
 631
 632   {
 633     'key'         => 'passwordmax',
 634     'section'     => 'password',
 635     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
 636     'type'        => 'text',
 637   },
 638
 639   {
 640     'key' => 'password-noampersand',
 641     'section' => 'password',
 642     'description' => 'Disallow ampersands in passwords',
 643     'type' => 'checkbox',
 644   },
 645
 646   {
 647     'key' => 'password-noexclamation',
 648     'section' => 'password',
 649     'description' => 'Disallow exclamations in passwords (Not setting this could break old text Livingston or Cistron Radius servers)',
 650     'type' => 'checkbox',
 651   },
 652
 653   {
 654     'key'         => 'qmailmachines',
 655     'section'     => 'deprecated',
 656     'description' => '<b>DEPRECATED</b>, add <i>qmail</i> and <i>shellcommands</i> <a href="../browse/part_export.cgi">exports</a> instead.  This option used to export `/var/qmail/control/virtualdomains\', `/var/qmail/control/recipientmap\', and `/var/qmail/control/rcpthosts\'.  Setting this option (even if empty) also turns on user `.qmail-extension\' file maintenance in conjunction with the <b>shellmachine</b> option.',
 657     'type'        => [qw( checkbox textarea )],
 658   },
 659
 660   {
 661     'key'         => 'radiusmachines',
 662     'section'     => 'deprecated',
 663     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to export to be: your RADIUS authentication machines, one per line.  This enables export of `/etc/raddb/users\'.',
 664     'type'        => 'textarea',
 665   },
 666
 667   {
 668     'key'         => 'referraldefault',
 669     'section'     => 'UI',
 670     'description' => 'Default referral, specified by refnum',
 671     'type'        => 'text',
 672   },
 673
 674 #  {
 675 #    'key'         => 'registries',
 676 #    'section'     => 'required',
 677 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
 678 #  },
 679
 680   {
 681     'key'         => 'report_template',
 682     'section'     => 'deprecated',
 683     'description' => 'Deprecated template file for reports.',
 684     'type'        => 'textarea',
 685   },
 686
 687
 688   {
 689     'key'         => 'maxsearchrecordsperpage',
 690     'section'     => 'UI',
 691     'description' => 'If set, number of search records to return per page.',
 692     'type'        => 'text',
 693   },
 694
 695   {
 696     'key'         => 'sendmailconfigpath',
 697     'section'     => 'deprecated',
 698     'description' => '<b>DEPRECATED</b>, add a <i>sendmail</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be sendmail configuration file path.  Defaults to `/etc\'.  Many newer distributions use `/etc/mail\'.',
 699     'type'        => 'text',
 700   },
 701
 702   {
 703     'key'         => 'sendmailmachines',
 704     'section'     => 'deprecated',
 705     'description' => '<b>DEPRECATED</b>, add a <i>sendmail</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be sendmail machines, one per line.  This enables export of `/etc/virtusertable\' and `/etc/sendmail.cw\'.',
 706     'type'        => 'textarea',
 707   },
 708
 709   {
 710     'key'         => 'sendmailrestart',
 711     'section'     => 'deprecated',
 712     'description' => '<b>DEPRECATED</b>, add a <i>sendmail</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to define the command which is run on sendmail machines after files are copied.',
 713     'type'        => 'text',
 714   },
 715
 716   {
 717     'key'         => 'session-start',
 718     'section'     => 'session',
 719     'description' => 'If defined, the command which is executed on the Freeside machine when a session begins.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
 720     'type'        => 'text',
 721   },
 722
 723   {
 724     'key'         => 'session-stop',
 725     'section'     => 'session',
 726     'description' => 'If defined, the command which is executed on the Freeside machine when a session ends.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
 727     'type'        => 'text',
 728   },
 729
 730   {
 731     'key'         => 'shellmachine',
 732     'section'     => 'deprecated',
 733     'description' => '<b>DEPRECATED</b>, add a <i>shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain a single machine with user home directories mounted.  This enables home directory creation, renaming and archiving/deletion.  In conjunction with `qmailmachines\', it also enables `.qmail-extension\' file maintenance.',
 734     'type'        => 'text',
 735   },
 736
 737   {
 738     'key'         => 'shellmachine-useradd',
 739     'section'     => 'deprecated',
 740     'description' => '<b>DEPRECATED</b>, add a <i>shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain command(s) to run on shellmachine when an account is created.  If the <b>shellmachine</b> option is set but this option is not, <code>useradd -d $dir -m -s $shell -u $uid $username</code> is the default.  If this option is set but empty, <code>cp -pr /etc/skel $dir; chown -R $uid.$gid $dir</code> is the default instead.  Otherwise the value is evaluated as a double-quoted perl string, with the following variables available: <code>$username</code>, <code>$uid</code>, <code>$gid</code>, <code>$dir</code>, and <code>$shell</code>.',
 741     'type'        => [qw( checkbox text )],
 742   },
 743
 744   {
 745     'key'         => 'shellmachine-userdel',
 746     'section'     => 'deprecated',
 747     'description' => '<b>DEPRECATED</b>, add a <i>shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain command(s) to run on shellmachine when an account is deleted.  If the <b>shellmachine</b> option is set but this option is not, <code>userdel $username</code> is the default.  If this option is set but empty, <code>rm -rf $dir</code> is the default instead.  Otherwise the value is evaluated as a double-quoted perl string, with the following variables available: <code>$username</code> and <code>$dir</code>.',
 748     'type'        => [qw( checkbox text )],
 749   },
 750
 751   {
 752     'key'         => 'shellmachine-usermod',
 753     'section'     => 'deprecated',
 754     'description' => '<b>DEPRECATED</b>, add a <i>shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain command(s) to run on shellmachine when an account is modified.  If the <b>shellmachine</b> option is set but this option is empty, <code>[ -d $old_dir ] &amp;&amp; mv $old_dir $new_dir || ( chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; find . -depth -print | cpio -pdm $new_dir; chmod u-t $new_dir; chown -R $uid.$gid $new_dir; rm -rf $old_dir )</code> is the default.  Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$old_dir</code>, <code>$new_dir</code>, <code>$uid</code> and <code>$gid</code>.',
 755     #'type'        => [qw( checkbox text )],
 756     'type'        => 'text',
 757   },
 758
 759   {
 760     'key'         => 'shellmachines',
 761     'section'     => 'deprecated',
 762     'description' => '<b>DEPRECATED</b>, add a <i>sysvshell</i> <a href="../browse/part_export.cgi">export</a> instead.  Your Linux and System V flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd\' and `/etc/shadow\' files.',
 763      'type'        => 'textarea',
 764  },
 765
 766   {
 767     'key'         => 'shells',
 768     'section'     => 'required',
 769     'description' => 'Legal shells (think /etc/shells).  You probably want to `cut -d: -f7 /etc/passwd | sort | uniq\' initially so that importing doesn\'t fail with `Illegal shell\' errors, then remove any special entries afterwords.  A blank line specifies that an empty shell is permitted.',
 770     'type'        => 'textarea',
 771   },
 772
 773   {
 774     'key'         => 'showpasswords',
 775     'section'     => 'UI',
 776     'description' => 'Display unencrypted user passwords in the backend (employee) web interface',
 777     'type'        => 'checkbox',
 778   },
 779
 780   {
 781     'key'         => 'signupurl',
 782     'section'     => 'UI',
 783     'description' => 'if you are using customer-to-customer referrals, and you enter the URL of your <a href="../docs/signup.html">signup server CGI</a>, the customer view screen will display a customized link to the signup server with the appropriate customer as referral',
 784     'type'        => 'text',
 785   },
 786
 787   {
 788     'key'         => 'smtpmachine',
 789     'section'     => 'required',
 790     'description' => 'SMTP relay for Freeside\'s outgoing mail',
 791     'type'        => 'text',
 792   },
 793
 794   {
 795     'key'         => 'soadefaultttl',
 796     'section'     => 'BIND',
 797     'description' => 'SOA default TTL for new domains.',
 798     'type'        => 'text',
 799   },
 800
 801   {
 802     'key'         => 'soaemail',
 803     'section'     => 'BIND',
 804     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
 805     'type'        => 'text',
 806   },
 807
 808   {
 809     'key'         => 'soaexpire',
 810     'section'     => 'BIND',
 811     'description' => 'SOA expire for new domains',
 812     'type'        => 'text',
 813   },
 814
 815   {
 816     'key'         => 'soamachine',
 817     'section'     => 'BIND',
 818     'description' => 'SOA machine for new domains, with trailing `.\'',
 819     'type'        => 'text',
 820   },
 821
 822   {
 823     'key'         => 'soarefresh',
 824     'section'     => 'BIND',
 825     'description' => 'SOA refresh for new domains',
 826     'type'        => 'text',
 827   },
 828
 829   {
 830     'key'         => 'soaretry',
 831     'section'     => 'BIND',
 832     'description' => 'SOA retry for new domains',
 833     'type'        => 'text',
 834   },
 835
 836   {
 837     'key'         => 'statedefault',
 838     'section'     => 'UI',
 839     'description' => 'Default state or province (if not supplied, the default is `CA\')',
 840     'type'        => 'text',
 841   },
 842
 843   {
 844     'key'         => 'radiusprepend',
 845     'section'     => 'deprecated',
 846     'description' => '<b>DEPRECATED</b>, real-time text radius now edits an existing file in place - just (turn off freeside-queued and) edit your RADIUS users file directly.  The contents used to be be prepended to the top of the RADIUS users file (text exports only).',
 847     'type'        => 'textarea',
 848   },
 849
 850   {
 851     'key'         => 'textradiusprepend',
 852     'section'     => 'deprecated',
 853     'description' => '<b>DEPRECATED</b>, use RADIUS check attributes instead.  The contents used to be prepended to the first line of a user\'s RADIUS entry in text exports.',
 854     'type'        => 'text',
 855   },
 856
 857   {
 858     'key'         => 'unsuspendauto',
 859     'section'     => 'billing',
 860     'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due changes from positive to zero or negative as the result of a payment or credit',
 861     'type'        => 'checkbox',
 862   },
 863
 864   {
 865     'key'         => 'usernamemin',
 866     'section'     => 'username',
 867     'description' => 'Minimum username length (default 2)',
 868     'type'        => 'text',
 869   },
 870
 871   {
 872     'key'         => 'usernamemax',
 873     'section'     => 'username',
 874     'description' => 'Maximum username length',
 875     'type'        => 'text',
 876   },
 877
 878   {
 879     'key'         => 'username-ampersand',
 880     'section'     => 'username',
 881     'description' => 'Allow the ampersand character (&amp;) in usernames.  Be careful when using this option in conjunction with <a href="../browse/part_export.cgi">exports</a> which execute shell commands, as the ampersand will be interpreted by the shell if not quoted.',
 882     'type'        => 'checkbox',
 883   },
 884
 885   {
 886     'key'         => 'username-letter',
 887     'section'     => 'username',
 888     'description' => 'Usernames must contain at least one letter',
 889     'type'        => 'checkbox',
 890   },
 891
 892   {
 893     'key'         => 'username-letterfirst',
 894     'section'     => 'username',
 895     'description' => 'Usernames must start with a letter',
 896     'type'        => 'checkbox',
 897   },
 898
 899   {
 900     'key'         => 'username-noperiod',
 901     'section'     => 'username',
 902     'description' => 'Disallow periods in usernames',
 903     'type'        => 'checkbox',
 904   },
 905
 906   {
 907     'key'         => 'username-nounderscore',
 908     'section'     => 'username',
 909     'description' => 'Disallow underscores in usernames',
 910     'type'        => 'checkbox',
 911   },
 912
 913   {
 914     'key'         => 'username-nodash',
 915     'section'     => 'username',
 916     'description' => 'Disallow dashes in usernames',
 917     'type'        => 'checkbox',
 918   },
 919
 920   {
 921     'key'         => 'username-uppercase',
 922     'section'     => 'username',
 923     'description' => 'Allow uppercase characters in usernames',
 924     'type'        => 'checkbox',
 925   },
 926
 927   {
 928     'key'         => 'username_policy',
 929     'section'     => 'deprecated',
 930     'description' => 'This file controls the mechanism for preventing duplicate usernames in passwd/radius files exported from svc_accts.  This should be one of \'prepend domsvc\' \'append domsvc\' \'append domain\' or \'append @domain\'',
 931     'type'        => 'select',
 932     'select_enum' => [ 'prepend domsvc', 'append domsvc', 'append domain', 'append @domain' ],
 933     #'type'        => 'text',
 934   },
 935
 936   {
 937     'key'         => 'vpopmailmachines',
 938     'section'     => 'deprecated',
 939     'description' => '<b>DEPRECATED</b>, add a <i>vpopmail</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain your vpopmail pop toasters, one per line.  Each line is of the form "machinename vpopdir vpopuid vpopgid".  For example: <code>poptoaster.domain.tld /home/vpopmail 508 508</code>  Note: vpopuid and vpopgid are values taken from the vpopmail machine\'s /etc/passwd',
 940     'type'        => 'textarea',
 941   },
 942
 943   {
 944     'key'         => 'vpopmailrestart',
 945     'section'     => 'deprecated',
 946     'description' => '<b>DEPRECATED</b>, add a <i>vpopmail</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to define the shell commands to run on vpopmail machines after files are copied.  An example can be found in eg/vpopmailrestart of the source distribution.',
 947     'type'        => 'textarea',
 948   },
 949
 950   {
 951     'key'         => 'safe-part_pkg',
 952     'section'     => 'deprecated',
 953     'description' => '<b>DEPRECATED</b>, obsolete.  Used to validate package definition setup and recur expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
 954     'type'        => 'checkbox',
 955   },
 956
 957   {
 958     'key'         => 'safe-part_bill_event',
 959     'section'     => 'UI',
 960     'description' => 'Validates invoice event expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
 961     'type'        => 'checkbox',
 962   },
 963
 964   {
 965     'key'         => 'show_ss',
 966     'section'     => 'UI',
 967     'description' => 'Turns on display/collection of SS# in the web interface.',
 968     'type'        => 'checkbox',
 969   },
 970
 971   {
 972     'key'         => 'agent_defaultpkg',
 973     'section'     => 'UI',
 974     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
 975     'type'        => 'checkbox',
 976   },
 977
 978   {
 979     'key'         => 'legacy_link',
 980     'section'     => 'UI',
 981     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
 982     'type'        => 'checkbox',
 983   },
 984
 985   {
 986     'key'         => 'legacy_link-steal',
 987     'section'     => 'UI',
 988     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
 989     'type'        => 'checkbox',
 990   },
 991
 992   {
 993     'key'         => 'queue_dangerous_controls',
 994     'section'     => 'UI',
 995     'description' => 'Enable queue modification controls on account pages and for new jobs.  Unless you are a developer working on new export code, you should probably leave this off to avoid causing provisioning problems.',
 996     'type'        => 'checkbox',
 997   },
 998
 999   {
1000     'key'         => 'security_phrase',
1001     'section'     => 'password',
1002     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
1003     'type'        => 'checkbox',
1004   },
1005
1006   {
1007     'key'         => 'locale',
1008     'section'     => 'UI',
1009     'description' => 'Message locale',
1010     'type'        => 'select',
1011     'select_enum' => [ qw(en_US) ],
1012   },
1013
1014   {
1015     'key'         => 'selfservice_server-quiet',
1016     'section'     => 'deprecated',
1017     'description' => '<b>DEPRECATED</b>, the self-service server no longer sends superfluous decline and cancel emails.  Used to disable decline and cancel emails generated by transactions initiated by the selfservice server.',
1018     'type'        => 'checkbox',
1019   },
1020
1021   {
1022     'key'         => 'signup_server-quiet',
1023     'section'     => 'deprecated',
1024     'description' => '<b>DEPRECATED</b>, the signup server is now part of the self-service server and no longer sends superfluous decline and cancel emails.  Used to disable decline and cancel emails generated by transactions initiated by the signup server.  Does not disable welcome emails.',
1025     'type'        => 'checkbox',
1026   },
1027
1028   {
1029     'key'         => 'signup_server-payby',
1030     'section'     => '',
1031     'description' => 'Acceptable payment types for the signup server',
1032     'type'        => 'selectmultiple',
1033     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB PREPAY BILL COMP) ],
1034   },
1035
1036   {
1037     'key'         => 'signup_server-email',
1038     'section'     => 'deprecated',
1039     'description' => '<b>DEPRECATED</b>, this feature is no longer available.  See the ***fill me in*** report instead.  Used to contain a comma-separated list of email addresses to receive notification of signups via the signup server.',
1040     'type'        => 'text',
1041   },
1042
1043   {
1044     'key'         => 'signup_server-default_agentnum',
1045     'section'     => '',
1046     'description' => 'Default agentnum for the signup server',
1047     'type'        => 'text',
1048   },
1049
1050   {
1051     'key'         => 'signup_server-default_refnum',
1052     'section'     => '',
1053     'description' => 'Default advertising source number for the signup server',
1054     'type'        => 'text',
1055   },
1056
1057   {
1058     'key'         => 'show-msgcat-codes',
1059     'section'     => 'UI',
1060     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
1061     'type'        => 'checkbox',
1062   },
1063
1064   {
1065     'key'         => 'signup_server-realtime',
1066     'section'     => '',
1067     'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
1068     'type'        => 'checkbox',
1069   },
1070
1071   {
1072     'key'         => 'declinetemplate',
1073     'section'     => 'billing',
1074     'description' => 'Template file for credit card decline emails.',
1075     'type'        => 'textarea',
1076   },
1077
1078   {
1079     'key'         => 'emaildecline',
1080     'section'     => 'billing',
1081     'description' => 'Enable emailing of credit card decline notices.',
1082     'type'        => 'checkbox',
1083   },
1084
1085   {
1086     'key'         => 'emaildecline-exclude',
1087     'section'     => 'billing',
1088     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
1089     'type'        => 'textarea',
1090   },
1091
1092   {
1093     'key'         => 'cancelmessage',
1094     'section'     => 'billing',
1095     'description' => 'Template file for cancellation emails.',
1096     'type'        => 'textarea',
1097   },
1098
1099   {
1100     'key'         => 'cancelsubject',
1101     'section'     => 'billing',
1102     'description' => 'Subject line for cancellation emails.',
1103     'type'        => 'text',
1104   },
1105
1106   {
1107     'key'         => 'emailcancel',
1108     'section'     => 'billing',
1109     'description' => 'Enable emailing of cancellation notices.',
1110     'type'        => 'checkbox',
1111   },
1112
1113   {
1114     'key'         => 'require_cardname',
1115     'section'     => 'billing',
1116     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
1117     'type'        => 'checkbox',
1118   },
1119
1120   {
1121     'key'         => 'enable_taxclasses',
1122     'section'     => 'billing',
1123     'description' => 'Enable per-package tax classes',
1124     'type'        => 'checkbox',
1125   },
1126
1127   {
1128     'key'         => 'welcome_email',
1129     'section'     => '',
1130     'description' => 'Template file for welcome email.  Welcome emails are sent to the customer email invoice destination(s) each time a svc_acct record is created.  See the <a href="http://search.cpan.org/doc/MJD/Text-Template-1.42/Template.pm">Text::Template</a> documentation for details on the template substitution language.  The following variables are available: <code>$username</code>, <code>$password</code>, <code>$first</code>, <code>$last</code> and <code>$pkg</code>.',
1131     'type'        => 'textarea',
1132   },
1133
1134   {
1135     'key'         => 'welcome_email-from',
1136     'section'     => '',
1137     'description' => 'From: address header for welcome email',
1138     'type'        => 'text',
1139   },
1140
1141   {
1142     'key'         => 'welcome_email-subject',
1143     'section'     => '',
1144     'description' => 'Subject: header for welcome email',
1145     'type'        => 'text',
1146   },
1147
1148   {
1149     'key'         => 'welcome_email-mimetype',
1150     'section'     => '',
1151     'description' => 'MIME type for welcome email',
1152     'type'        => 'select',
1153     'select_enum' => [ 'text/plain', 'text/html' ],
1154   },
1155
1156   {
1157     'key'         => 'payby-default',
1158     'section'     => 'UI',
1159     'description' => 'Default payment type.  HIDE disables display of billing information and sets customers to BILL.',
1160     'type'        => 'select',
1161     'select_enum' => [ '', qw(CARD DCRD CHEK DCHK LECB BILL COMP HIDE) ],
1162   },
1163
1164   {
1165     'key'         => 'svc_acct-notes',
1166     'section'     => 'UI',
1167     'description' => 'Extra HTML to be displayed on the Account View screen.',
1168     'type'        => 'textarea',
1169   },
1170
1171   {
1172     'key'         => 'radius-password',
1173     'section'     => '',
1174     'description' => 'RADIUS attribute for plain-text passwords.',
1175     'type'        => 'select',
1176     'select_enum' => [ 'Password', 'User-Password' ],
1177   },
1178
1179   {
1180     'key'         => 'radius-ip',
1181     'section'     => '',
1182     'description' => 'RADIUS attribute for IP addresses.',
1183     'type'        => 'select',
1184     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
1185   },
1186
1187   {
1188     'key'         => 'svc_acct-alldomains',
1189     'section'     => '',
1190     'description' => 'Allow accounts to select any domain in the database.  Normally accounts can only select from the domain set in the service definition and those purchased by the customer.',
1191     'type'        => 'checkbox',
1192   },
1193
1194   {
1195     'key'         => 'dump-scpdest',
1196     'section'     => '',
1197     'description' => 'destination for scp database dumps: user@host:/path',
1198     'type'        => 'text',
1199   },
1200
1201   {
1202     'key'         => 'dump-pgpid',
1203     'section'     => '',
1204     'description' => "Optional PGP public key user or key id for database dumps.  The public key should exist on the freeside user's public keyring, and the gpg binary and GnuPG perl module should be installed.",
1205     'type'        => 'text',
1206   },
1207
1208   {
1209     'key'         => 'users-allow_comp',
1210     'section'     => '',
1211     'description' => 'Usernames (Freeside users, created with <a href="../docs/man/bin/freeside-adduser.html">freeside-adduser</a>) which can create complimentary customers, one per line.  If no usernames are entered, all users can create complimentary accounts.',
1212     'type'        => 'textarea',
1213   },
1214
1215   {
1216     'key'         => 'cvv-save',
1217     'section'     => 'billing',
1218     'description' => 'Save CVV2 information after the initial transaction for the selected credit card types.  Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option for any credit card types.',
1219     'type'        => 'selectmultiple',
1220     'select_enum' => [ "VISA card",
1221                        "MasterCard",
1222                        "Discover card",
1223                        "American Express card",
1224                        "Diner's Club/Carte Blanche",
1225                        "enRoute",
1226                        "JCB",
1227                        "BankCard",
1228                      ],
1229   },
1230
1231   {
1232     'key'         => 'allow_negative_charges',
1233     'section'     => 'billing',
1234     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
1235     'type'        => 'checkbox',
1236   },
1237   {
1238       'key'         => 'auto_unset_catchall',
1239       'section'     => '',
1240       'description' => 'When canceling a svc_acct that is the email catchall for one or more svc_domains, automatically set their catchall fields to null.  If this option is not set, the attempt will simply fail.',
1241       'type'        => 'checkbox',
1242   },
1243
1244   {
1245     'key'         => 'system_usernames',
1246     'section'     => 'username',
1247     'description' => 'A list of system usernames that cannot be edited or removed, one per line.  Use a bare username to prohibit modification/deletion of the username in any domain, or username@domain to prohibit modification/deletetion of a specific username and domain.',
1248     'type'        => 'textarea',
1249   },
1250
1251   {
1252     'key'         => 'cust_pkg-change_svcpart',
1253     'section'     => '',
1254     'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
1255     'type'        => 'checkbox',
1256   },
1257
1258   {
1259     'key'         => 'disable_autoreverse',
1260     'section'     => 'BIND',
1261     'description' => 'Disable automatic synchronization of reverse-ARPA entries.',
1262     'type'        => 'checkbox',
1263   },
1264
1265   {
1266     'key'         => 'svc_www-enable_subdomains',
1267     'section'     => '',
1268     'description' => 'Enable selection of specific subdomains for virtual host creation.',
1269     'type'        => 'checkbox',
1270   },
1271
1272   {
1273     'key'         => 'svc_www-usersvc_svcpart',
1274     'section'     => '',
1275     'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
1276     'type'        => 'textarea',
1277   },
1278
1279   {
1280     'key'         => 'selfservice_server-primary_only',
1281     'section'     => '',
1282     'description' => 'Only allow primary accounts to access self-service functionality.',
1283     'type'        => 'checkbox',
1284   },
1285
1286   {
1287     'key'         => 'card_refund-days',
1288     'section'     => 'billing',
1289     'description' => 'After a payment, the number of days a refund link will be available for that payment.  Defaults to 120.',
1290     'type'        => 'text',
1291   },
1292
1293   {
1294     'key'         => 'agent-showpasswords',
1295     'section'     => '',
1296     'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
1297     'type'        => 'checkbox',
1298   },
1299
1300   {
1301     'key'         => 'global_unique-username',
1302     'section'     => 'username',
1303     'description' => 'Global username uniqueness control: none (usual setting - check uniqueness per exports), username (all usernames are globally unique, regardless of domain or exports), or username@domain (all username@domain pairs are globally unique, regardless of exports)',
1304     'type'        => 'select',
1305     'select_enum' => [ 'none', 'username', 'username@domain' ],
1306   },
1307
1308   {
1309     'key'         => 'svc_external-skip_manual',
1310     'section'     => 'UI',
1311     'description' => 'When provisioning svc_external services, skip manual entry of id and title fields in the UI.  Usually used in conjunction with an export that populates these fields (i.e. artera_turbo).',
1312     'type'        => 'checkbox',
1313   },
1314
1315   {
1316     'key'         => 'svc_external-display_type',
1317     'section'     => 'UI',
1318     'description' => 'Select a specific svc_external type to enable some UI changes specific to that type (i.e. artera_turbo).',
1319     'type'        => 'select',
1320     'select_enum' => [ 'generic', 'artera_turbo', ],
1321   },
1322
1323   {
1324     'key'         => 'ticket_system',
1325     'section'     => '',
1326     'description' => 'Ticketing system integraiton.  <b>RT_Internal</b> uses the built-in RT ticketing system (use <code>make create-rt</code> to create the necessary tables).  <b>RT_Libs</b> uses the built-in RT libraries to access an RT installation in a separate database (local or remote).  <b>RT_External</b> uses raw SQL access (and eventually RT\'s XML interface and RTx::Atom?) to access an RT installation in a separate database (local or remote).',
1327     'type'        => 'select',
1328     'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
1329   },
1330
1331   {
1332     'key'         => 'ticket_system-default_queueid',
1333     'section'     => '',
1334     'description' => 'Default queue number used when creating new customer tickets.',
1335     'type'        => 'text',
1336   },
1337
1338   {
1339     'key'         => 'ticket_system-custom_priority_field',
1340     'section'     => '',
1341     'description' => 'Custom field from the ticketing system to use as a custom priority classification.',
1342     'type'        => 'text',
1343   },
1344
1345   {
1346     'key'         => 'ticket_system-custom_priority_field-values',
1347     'section'     => '',
1348     'description' => 'Values for the custom field from the ticketing system to break down and sort customer ticket lists.',
1349     'type'        => 'textarea',
1350   },
1351
1352   {
1353     'key'         => 'ticket_system-custom_priority_field_queue',
1354     'section'     => '',
1355     'description' => 'Ticketing system queue in which the custom field specified in ticket_system-custom_priority_field is located.',
1356     'type'        => 'text',
1357   },
1358
1359   {
1360     'key'         => 'company_name',
1361     'section'     => 'required',
1362     'description' => 'Your company name',
1363     'type'        => 'text',
1364   },
1365
1366   {
1367     'key'         => 'echeck-void',
1368     'section'     => 'billing',
1369     'description' => 'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway',
1370     'type'        => 'checkbox',
1371   },
1372
1373   {
1374     'key'         => 'address2-search',
1375     'section'     => 'UI',
1376     'description' => 'Enable a "Unit" search box which searches the second address field',
1377     'type'        => 'checkbox',
1378   },
1379
1380   { 'key'         => 'referral_credit',
1381     'section'     => 'billing',
1382     'description' => "Enables one-time referral credits in the amount of one month <i>referred</i> customer's recurring fee (irregardless of frequency).",
1383     'type'        => 'checkbox',
1384   },
1385
1386   { 'key'         => 'selfservice_server-cache_module',
1387     'section'     => '',
1388     'description' => 'Module used to store self-service session information.  All modules handle any number of self-service servers.  Cache::SharedMemoryCache is appropriate for a single database / single Freeside server.  Cache::FileCache is useful for multiple databases on a single server, or when IPC::ShareLite is not available (i.e. FreeBSD).', #  _Database stores session information in the database and is appropriate for multiple Freeside servers, but may be slower.',
1389     'type'        => 'select',
1390     'select_enum' => [ 'Cache::SharedMemoryCache', 'Cache::FileCache', ], # '_Database' ],
1391   },
1392
1393 );
1394
1395 1;
1396