This commit was manufactured by cvs2svn to create branch
[freeside.git] / 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 touch KEY
112
113 Creates the specified configuration key if it does not exist.
114
115 =cut
116
117 sub touch {
118   my($self, $file) = @_;
119   my $dir = $self->dir;
120   unless ( $self->exists($file) ) {
121     warn "[FS::Conf] TOUCH $file\n" if $DEBUG;
122     system('touch', "$dir/$file");
123   }
124 }
125
126 =item set KEY VALUE
127
128 Sets the specified configuration key to the given value.
129
130 =cut
131
132 sub set {
133   my($self, $file, $value) = @_;
134   my $dir = $self->dir;
135   $value =~ /^(.*)$/s;
136   $value = $1;
137   unless ( join("\n", @{[ $self->config($file) ]}) eq $value ) {
138     warn "[FS::Conf] SET $file\n" if $DEBUG;
139 #    warn "$dir" if is_tainted($dir);
140 #    warn "$dir" if is_tainted($file);
141     chmod 0644, "$dir/$file";
142     my $fh = new IO::File ">$dir/$file" or return;
143     chmod 0644, "$dir/$file";
144     print $fh "$value\n";
145   }
146 }
147 #sub is_tainted {
148 #             return ! eval { join('',@_), kill 0; 1; };
149 #         }
150
151 =item delete KEY
152
153 Deletes the specified configuration key.
154
155 =cut
156
157 sub delete {
158   my($self, $file) = @_;
159   my $dir = $self->dir;
160   if ( $self->exists($file) ) {
161     warn "[FS::Conf] DELETE $file\n";
162     unlink "$dir/$file";
163   }
164 }
165
166 =item config_items
167
168 Returns all of the possible configuration items as FS::ConfItem objects.  See
169 L<FS::ConfItem>.
170
171 =cut
172
173 sub config_items {
174   my $self = shift; 
175   #quelle kludge
176   @config_items,
177   ( map { 
178         my $basename = basename($_);
179         $basename =~ /^(.*)$/;
180         $basename = $1;
181         new FS::ConfItem {
182                            'key'         => $basename,
183                            'section'     => 'billing',
184                            'description' => 'Alternate template file for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
185                            'type'        => 'textarea',
186                          }
187       } glob($self->dir. '/invoice_template_*')
188   ),
189   ( map { 
190         my $basename = basename($_);
191         $basename =~ /^(.*)$/;
192         $basename = $1;
193         new FS::ConfItem {
194                            'key'         => $basename,
195                            'section'     => 'billing',
196                            'description' => 'Alternate LaTeX template for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
197                            'type'        => 'textarea',
198                          }
199       } glob($self->dir. '/invoice_latex_*')
200   );
201 }
202
203 =back
204
205 =head1 BUGS
206
207 If this was more than just crud that will never be useful outside Freeside I'd
208 worry that config_items is freeside-specific and icky.
209
210 =head1 SEE ALSO
211
212 "Configuration" in the web interface (config/config.cgi).
213
214 httemplate/docs/config.html
215
216 =cut
217
218 @config_items = map { new FS::ConfItem $_ } (
219
220   {
221     'key'         => 'address',
222     'section'     => 'deprecated',
223     'description' => 'This configuration option is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
224     'type'        => 'text',
225   },
226
227   {
228     'key'         => 'alerter_template',
229     'section'     => 'billing',
230     'description' => 'Template file for billing method expiration alerts.  See the <a href="../docs/billing.html#invoice_template">billing documentation</a> for details.',
231     'type'        => 'textarea',
232   },
233
234   {
235     'key'         => 'apacheroot',
236     'section'     => 'deprecated',
237     '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',
238     'type'        => 'text',
239   },
240
241   {
242     'key'         => 'apacheip',
243     'section'     => 'deprecated',
244     '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',
245     'type'        => 'text',
246   },
247
248   {
249     'key'         => 'apachemachine',
250     'section'     => 'deprecated',
251     '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.',
252     'type'        => 'text',
253   },
254
255   {
256     'key'         => 'apachemachines',
257     'section'     => 'deprecated',
258     '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.',
259     'type'        => 'textarea',
260   },
261
262   {
263     'key'         => 'bindprimary',
264     'section'     => 'deprecated',
265     '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',
266     'type'        => 'text',
267   },
268
269   {
270     'key'         => 'bindsecondaries',
271     'section'     => 'deprecated',
272     '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',
273     'type'        => 'textarea',
274   },
275
276   {
277     'key'         => 'business-onlinepayment',
278     'section'     => 'billing',
279     '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.',
280     'type'        => 'textarea',
281   },
282
283   {
284     'key'         => 'business-onlinepayment-ach',
285     'section'     => 'billing',
286     '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.',
287     'type'        => 'textarea',
288   },
289
290   {
291     'key'         => 'business-onlinepayment-description',
292     'section'     => 'billing',
293     '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)',
294     'type'        => 'text',
295   },
296
297   {
298     'key'         => 'bsdshellmachines',
299     'section'     => 'deprecated',
300     '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\'.',
301     'type'        => 'textarea',
302   },
303
304   {
305     'key'         => 'countrydefault',
306     'section'     => 'UI',
307     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
308     'type'        => 'text',
309   },
310
311   {
312     'key'         => 'cybercash3.2',
313     'section'     => 'deprecated',
314     'description' => '<b>DEPRECATED</b>, CyberCash no longer exists.  Used to enable <a href="http://www.cybercash.com/cashregister/">CyberCash Cashregister v3.2</a> support.  Two lines: the full path and name of your merchant_conf file, and the transaction type (`mauthonly\' or `mauthcapture\').',
315     'type'        => 'textarea',
316   },
317
318   {
319     'key'         => 'cyrus',
320     'section'     => 'deprecated',
321     '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.',
322     'type'        => 'textarea',
323   },
324
325   {
326     'key'         => 'cp_app',
327     'section'     => 'deprecated',
328     '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).',
329     'type'        => 'textarea',
330   },
331
332   {
333     'key'         => 'deletecustomers',
334     'section'     => 'UI',
335     '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.',
336     'type'        => 'checkbox',
337   },
338
339   {
340     'key'         => 'deletepayments',
341     'section'     => 'UI',
342     '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.',
343     'type'        => [qw( checkbox text )],
344   },
345
346   {
347     'key'         => 'deletecredits',
348     'section'     => 'UI',
349     '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.',
350     'type'        => [qw( checkbox text )],
351   },
352
353   {
354     'key'         => 'unapplypayments',
355     'section'     => 'UI',
356     'description' => 'Enable "unapplication" of unclosed payments.',
357     'type'        => 'checkbox',
358   },
359
360   {
361     'key'         => 'unapplycredits',
362     'section'     => 'UI',
363     'description' => 'Enable "unapplication" of unclosed credits.',
364     'type'        => 'checkbox',
365   },
366
367   {
368     'key'         => 'dirhash',
369     'section'     => 'shell',
370     '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>',
371     'type'        => 'text',
372   },
373
374   {
375     'key'         => 'disable_customer_referrals',
376     'section'     => 'UI',
377     'description' => 'Disable new customer-to-customer referrals in the web interface',
378     'type'        => 'checkbox',
379   },
380
381   {
382     'key'         => 'domain',
383     'section'     => 'deprecated',
384     'description' => 'Your domain name.',
385     'type'        => 'text',
386   },
387
388   {
389     'key'         => 'editreferrals',
390     'section'     => 'UI',
391     'description' => 'Enable advertising source modification for existing customers',
392     'type'       => 'checkbox',
393   },
394
395   {
396     'key'         => 'emailinvoiceonly',
397     'section'     => 'billing',
398     'description' => 'Disables postal mail invoices',
399     'type'       => 'checkbox',
400   },
401
402   {
403     'key'         => 'disablepostalinvoicedefault',
404     'section'     => 'billing',
405     '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>.',
406     'type'       => 'checkbox',
407   },
408
409   {
410     'key'         => 'emailinvoiceauto',
411     'section'     => 'billing',
412     'description' => 'Automatically adds new accounts to the email invoice list',
413     'type'       => 'checkbox',
414   },
415
416   {
417     'key'         => 'erpcdmachines',
418     'section'     => 'deprecated',
419     '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\'',
420     'type'        => 'textarea',
421   },
422
423   {
424     'key'         => 'hidecancelledpackages',
425     'section'     => 'UI',
426     'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
427     'type'        => 'checkbox',
428   },
429
430   {
431     'key'         => 'hidecancelledcustomers',
432     'section'     => 'UI',
433     'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
434     'type'        => 'checkbox',
435   },
436
437   {
438     'key'         => 'home',
439     'section'     => 'required',
440     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
441     'type'        => 'text',
442   },
443
444   {
445     'key'         => 'icradiusmachines',
446     'section'     => 'deprecated',
447     '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>',
448     'type'        => [qw( checkbox textarea )],
449   },
450
451   {
452     'key'         => 'icradius_mysqldest',
453     'section'     => 'deprecated',
454     '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/".',
455     'type'        => 'text',
456   },
457
458   {
459     'key'         => 'icradius_mysqlsource',
460     'section'     => 'deprecated',
461     '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".',
462     'type'        => 'text',
463   },
464
465   {
466     'key'         => 'icradius_secrets',
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 specify a database for ICRADIUS/FreeRADIUS export.  Three lines: DBI data source, username and password.',
469     'type'        => 'textarea',
470   },
471
472   {
473     'key'         => 'invoice_from',
474     'section'     => 'required',
475     'description' => 'Return address on email invoices',
476     'type'        => 'text',
477   },
478
479   {
480     'key'         => 'invoice_template',
481     'section'     => 'required',
482     'description' => 'Required template file for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
483     'type'        => 'textarea',
484   },
485
486   {
487     'key'         => 'invoice_latex',
488     'section'     => 'billing',
489     'description' => 'Optional LaTeX template for typeset PostScript invoices.',
490     'type'        => 'textarea',
491   },
492
493   {
494     'key'         => 'invoice_latexnotes',
495     'section'     => 'billing',
496     'description' => 'Notes section for LaTeX typeset PostScript invoices.',
497     'type'        => 'textarea',
498   },
499
500   {
501     'key'         => 'invoice_latexfooter',
502     'section'     => 'billing',
503     'description' => 'Footer for LaTeX typeset PostScript invoices.',
504     'type'        => 'textarea',
505   },
506
507   {
508     'key'         => 'invoice_latexsmallfooter',
509     'section'     => 'billing',
510     'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
511     'type'        => 'textarea',
512   },
513
514   { 
515     'key'         => 'invoice_default_terms',
516     'section'     => 'billing',
517     'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.',
518     'type'        => 'select',
519     'select_enum' => [ '', 'Payable upon receipt', 'Net 0', 'Net 10', 'Net 15', 'Net 30', 'Net 45', 'Net 60' ],
520   },
521
522   {
523     'key'         => 'invoice_send_receipts',
524     'section'     => 'billing',
525     'description' => 'Send receipts for payments and credits.',
526     'type'        => 'checkbox',
527   },
528
529   {
530     'key'         => 'lpr',
531     'section'     => 'required',
532     'description' => 'Print command for paper invoices, for example `lpr -h\'',
533     'type'        => 'text',
534   },
535
536   {
537     'key'         => 'maildisablecatchall',
538     'section'     => 'deprecated',
539     '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.',
540     'type'        => 'checkbox',
541   },
542
543   {
544     'key'         => 'money_char',
545     'section'     => '',
546     'description' => 'Currency symbol - defaults to `$\'',
547     'type'        => 'text',
548   },
549
550   {
551     'key'         => 'mxmachines',
552     'section'     => 'deprecated',
553     'description' => 'MX entries for new domains, weight and machine, one per line, with trailing `.\'',
554     'type'        => 'textarea',
555   },
556
557   {
558     'key'         => 'nsmachines',
559     'section'     => 'deprecated',
560     'description' => 'NS nameservers for new domains, one per line, with trailing `.\'',
561     'type'        => 'textarea',
562   },
563
564   {
565     'key'         => 'defaultrecords',
566     'section'     => 'BIND',
567     'description' => 'DNS entries to add automatically when creating a domain',
568     'type'        => 'editlist',
569     'editlist_parts' => [ { type=>'text' },
570                           { type=>'immutable', value=>'IN' },
571                           { type=>'select',
572                             select_enum=>{ map { $_=>$_ } qw(A CNAME MX NS)} },
573                           { type=> 'text' }, ],
574   },
575
576   {
577     'key'         => 'arecords',
578     'section'     => 'deprecated',
579     'description' => 'A list of tab seperated CNAME records to add automatically when creating a domain',
580     'type'        => 'textarea',
581   },
582
583   {
584     'key'         => 'cnamerecords',
585     'section'     => 'deprecated',
586     'description' => 'A list of tab seperated CNAME records to add automatically when creating a domain',
587     'type'        => 'textarea',
588   },
589
590   {
591     'key'         => 'nismachines',
592     'section'     => 'deprecated',
593     '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\'.',
594     'type'        => 'textarea',
595   },
596
597   {
598     'key'         => 'passwordmin',
599     'section'     => 'password',
600     'description' => 'Minimum password length (default 6)',
601     'type'        => 'text',
602   },
603
604   {
605     'key'         => 'passwordmax',
606     'section'     => 'password',
607     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
608     'type'        => 'text',
609   },
610
611   {
612     'key'         => 'qmailmachines',
613     'section'     => 'deprecated',
614     '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.',
615     'type'        => [qw( checkbox textarea )],
616   },
617
618   {
619     'key'         => 'radiusmachines',
620     'section'     => 'deprecated',
621     '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\'.',
622     'type'        => 'textarea',
623   },
624
625   {
626     'key'         => 'referraldefault',
627     'section'     => 'UI',
628     'description' => 'Default referral, specified by refnum',
629     'type'        => 'text',
630   },
631
632 #  {
633 #    'key'         => 'registries',
634 #    'section'     => 'required',
635 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
636 #  },
637
638   {
639     'key'         => 'report_template',
640     'section'     => 'required',
641     'description' => 'Required template file for reports.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
642     'type'        => 'textarea',
643   },
644
645
646   {
647     'key'         => 'maxsearchrecordsperpage',
648     'section'     => 'UI',
649     'description' => 'If set, number of search records to return per page.',
650     'type'        => 'text',
651   },
652
653   {
654     'key'         => 'sendmailconfigpath',
655     'section'     => 'deprecated',
656     '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\'.',
657     'type'        => 'text',
658   },
659
660   {
661     'key'         => 'sendmailmachines',
662     'section'     => 'deprecated',
663     '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\'.',
664     'type'        => 'textarea',
665   },
666
667   {
668     'key'         => 'sendmailrestart',
669     'section'     => 'deprecated',
670     '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.',
671     'type'        => 'text',
672   },
673
674   {
675     'key'         => 'session-start',
676     'section'     => 'session',
677     '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.',
678     'type'        => 'text',
679   },
680
681   {
682     'key'         => 'session-stop',
683     'section'     => 'session',
684     '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.',
685     'type'        => 'text',
686   },
687
688   {
689     'key'         => 'shellmachine',
690     'section'     => 'deprecated',
691     '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.',
692     'type'        => 'text',
693   },
694
695   {
696     'key'         => 'shellmachine-useradd',
697     'section'     => 'deprecated',
698     '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>.',
699     'type'        => [qw( checkbox text )],
700   },
701
702   {
703     'key'         => 'shellmachine-userdel',
704     'section'     => 'deprecated',
705     '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>.',
706     'type'        => [qw( checkbox text )],
707   },
708
709   {
710     'key'         => 'shellmachine-usermod',
711     'section'     => 'deprecated',
712     '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>.',
713     #'type'        => [qw( checkbox text )],
714     'type'        => 'text',
715   },
716
717   {
718     'key'         => 'shellmachines',
719     'section'     => 'deprecated',
720     '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.',
721      'type'        => 'textarea',
722  },
723
724   {
725     'key'         => 'shells',
726     'section'     => 'required',
727     '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.',
728     'type'        => 'textarea',
729   },
730
731   {
732     'key'         => 'showpasswords',
733     'section'     => 'UI',
734     'description' => 'Display unencrypted user passwords in the web interface',
735     'type'        => 'checkbox',
736   },
737
738   {
739     'key'         => 'signupurl',
740     'section'     => 'UI',
741     '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',
742     'type'        => 'text',
743   },
744
745   {
746     'key'         => 'smtpmachine',
747     'section'     => 'required',
748     'description' => 'SMTP relay for Freeside\'s outgoing mail',
749     'type'        => 'text',
750   },
751
752   {
753     'key'         => 'soadefaultttl',
754     'section'     => 'BIND',
755     'description' => 'SOA default TTL for new domains.',
756     'type'        => 'text',
757   },
758
759   {
760     'key'         => 'soaemail',
761     'section'     => 'BIND',
762     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
763     'type'        => 'text',
764   },
765
766   {
767     'key'         => 'soaexpire',
768     'section'     => 'BIND',
769     'description' => 'SOA expire for new domains',
770     'type'        => 'text',
771   },
772
773   {
774     'key'         => 'soamachine',
775     'section'     => 'BIND',
776     'description' => 'SOA machine for new domains, with trailing `.\'',
777     'type'        => 'text',
778   },
779
780   {
781     'key'         => 'soarefresh',
782     'section'     => 'BIND',
783     'description' => 'SOA refresh for new domains',
784     'type'        => 'text',
785   },
786
787   {
788     'key'         => 'soaretry',
789     'section'     => 'BIND',
790     'description' => 'SOA retry for new domains',
791     'type'        => 'text',
792   },
793
794   {
795     'key'         => 'statedefault',
796     'section'     => 'UI',
797     'description' => 'Default state or province (if not supplied, the default is `CA\')',
798     'type'        => 'text',
799   },
800
801   {
802     'key'         => 'radiusprepend',
803     'section'     => 'deprecated',
804     '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).',
805     'type'        => 'textarea',
806   },
807
808   {
809     'key'         => 'textradiusprepend',
810     'section'     => 'deprecated',
811     '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.',
812     'type'        => 'text',
813   },
814
815   {
816     'key'         => 'unsuspendauto',
817     'section'     => 'billing',
818     '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',
819     'type'        => 'checkbox',
820   },
821
822   {
823     'key'         => 'usernamemin',
824     'section'     => 'username',
825     'description' => 'Minimum username length (default 2)',
826     'type'        => 'text',
827   },
828
829   {
830     'key'         => 'usernamemax',
831     'section'     => 'username',
832     'description' => 'Maximum username length',
833     'type'        => 'text',
834   },
835
836   {
837     'key'         => 'username-ampersand',
838     'section'     => 'username',
839     '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.',
840     'type'        => 'checkbox',
841   },
842
843   {
844     'key'         => 'username-letter',
845     'section'     => 'username',
846     'description' => 'Usernames must contain at least one letter',
847     'type'        => 'checkbox',
848   },
849
850   {
851     'key'         => 'username-letterfirst',
852     'section'     => 'username',
853     'description' => 'Usernames must start with a letter',
854     'type'        => 'checkbox',
855   },
856
857   {
858     'key'         => 'username-noperiod',
859     'section'     => 'username',
860     'description' => 'Disallow periods in usernames',
861     'type'        => 'checkbox',
862   },
863
864   {
865     'key'         => 'username-nounderscore',
866     'section'     => 'username',
867     'description' => 'Disallow underscores in usernames',
868     'type'        => 'checkbox',
869   },
870
871   {
872     'key'         => 'username-nodash',
873     'section'     => 'username',
874     'description' => 'Disallow dashes in usernames',
875     'type'        => 'checkbox',
876   },
877
878   {
879     'key'         => 'username-uppercase',
880     'section'     => 'username',
881     'description' => 'Allow uppercase characters in usernames',
882     'type'        => 'checkbox',
883   },
884
885   {
886     'key'         => 'username_policy',
887     'section'     => 'deprecated',
888     '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\'',
889     'type'        => 'select',
890     'select_enum' => [ 'prepend domsvc', 'append domsvc', 'append domain', 'append @domain' ],
891     #'type'        => 'text',
892   },
893
894   {
895     'key'         => 'vpopmailmachines',
896     'section'     => 'deprecated',
897     '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',
898     'type'        => 'textarea',
899   },
900
901   {
902     'key'         => 'vpopmailrestart',
903     'section'     => 'deprecated',
904     '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.',
905     'type'        => 'textarea',
906   },
907
908   {
909     'key'         => 'safe-part_pkg',
910     'section'     => 'UI',
911     'description' => 'Validates package definition setup and recur expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
912     'type'        => 'checkbox',
913   },
914
915   {
916     'key'         => 'safe-part_bill_event',
917     'section'     => 'UI',
918     'description' => 'Validates invoice event expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
919     'type'        => 'checkbox',
920   },
921
922   {
923     'key'         => 'show_ss',
924     'section'     => 'UI',
925     'description' => 'Turns on display/collection of SS# in the web interface.',
926     'type'        => 'checkbox',
927   },
928
929   { 
930     'key'         => 'agent_defaultpkg',
931     'section'     => 'UI',
932     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
933     'type'        => 'checkbox',
934   },
935
936   {
937     'key'         => 'legacy_link',
938     'section'     => 'UI',
939     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
940     'type'        => 'checkbox',
941   },
942
943   {
944     'key'         => 'legacy_link-steal',
945     'section'     => 'UI',
946     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
947     'type'        => 'checkbox',
948   },
949
950   {
951     'key'         => 'queue_dangerous_controls',
952     'section'     => 'UI',
953     '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.',
954     'type'        => 'checkbox',
955   },
956
957   {
958     'key'         => 'security_phrase',
959     'section'     => 'password',
960     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
961     'type'        => 'checkbox',
962   },
963
964   {
965     'key'         => 'locale',
966     'section'     => 'UI',
967     'description' => 'Message locale',
968     'type'        => 'select',
969     'select_enum' => [ qw(en_US) ],
970   },
971
972   {
973     'key'         => 'selfservice_server-quiet',
974     'section'     => 'deprecated',
975     '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.',
976     'type'        => 'checkbox',
977   },
978
979   {
980     'key'         => 'signup_server-quiet',
981     'section'     => 'deprecated',
982     '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.',
983     'type'        => 'checkbox',
984   },
985
986   {
987     'key'         => 'signup_server-payby',
988     'section'     => '',
989     'description' => 'Acceptable payment types for the signup server',
990     'type'        => 'selectmultiple',
991     'select_enum' => [ qw(CARD CHEK LECB PREPAY BILL COMP) ],
992   },
993
994   {
995     'key'         => 'signup_server-email',
996     'section'     => 'deprecated',
997     '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.',
998     'type'        => 'text',
999   },
1000
1001   {
1002     'key'         => 'signup_server-default_agentnum',
1003     'section'     => '',
1004     'description' => 'Default agentnum for the signup server',
1005     'type'        => 'text',
1006   },
1007
1008   {
1009     'key'         => 'signup_server-default_refnum',
1010     'section'     => '',
1011     'description' => 'Default advertising source number for the signup server',
1012     'type'        => 'text',
1013   },
1014
1015   {
1016     'key'         => 'show-msgcat-codes',
1017     'section'     => 'UI',
1018     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
1019     'type'        => 'checkbox',
1020   },
1021
1022   {
1023     'key'         => 'signup_server-realtime',
1024     'section'     => '',
1025     'description' => 'Run billing for signup server signups immediately, and suspend accounts which subsequently have a balance.',
1026     'type'        => 'checkbox',
1027   },
1028
1029   {
1030     'key'         => 'declinetemplate',
1031     'section'     => 'billing',
1032     'description' => 'Template file for credit card decline emails.',
1033     'type'        => 'textarea',
1034   },
1035
1036   {
1037     'key'         => 'emaildecline',
1038     'section'     => 'billing',
1039     'description' => 'Enable emailing of credit card decline notices.',
1040     'type'        => 'checkbox',
1041   },
1042
1043   {
1044     'key'         => 'emaildecline-exclude',
1045     'section'     => 'billing',
1046     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
1047     'type'        => 'textarea',
1048   },
1049
1050   {
1051     'key'         => 'cancelmessage',
1052     'section'     => 'billing',
1053     'description' => 'Template file for cancellation emails.',
1054     'type'        => 'textarea',
1055   },
1056
1057   {
1058     'key'         => 'cancelsubject',
1059     'section'     => 'billing',
1060     'description' => 'Subject line for cancellation emails.',
1061     'type'        => 'text',
1062   },
1063
1064   {
1065     'key'         => 'emailcancel',
1066     'section'     => 'billing',
1067     'description' => 'Enable emailing of cancellation notices.',
1068     'type'        => 'checkbox',
1069   },
1070
1071   {
1072     'key'         => 'require_cardname',
1073     'section'     => 'billing',
1074     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
1075     'type'        => 'checkbox',
1076   },
1077
1078   {
1079     'key'         => 'enable_taxclasses',
1080     'section'     => 'billing',
1081     'description' => 'Enable per-package tax classes',
1082     'type'        => 'checkbox',
1083   },
1084
1085   {
1086     'key'         => 'welcome_email',
1087     'section'     => '',
1088     '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>.',
1089     'type'        => 'textarea',
1090   },
1091
1092   {
1093     'key'         => 'welcome_email-from',
1094     'section'     => '',
1095     'description' => 'From: address header for welcome email',
1096     'type'        => 'text',
1097   },
1098
1099   {
1100     'key'         => 'welcome_email-subject',
1101     'section'     => '',
1102     'description' => 'Subject: header for welcome email',
1103     'type'        => 'text',
1104   },
1105   
1106   {
1107     'key'         => 'welcome_email-mimetype',
1108     'section'     => '',
1109     'description' => 'MIME type for welcome email',
1110     'type'        => 'select',
1111     'select_enum' => [ 'text/plain', 'text/html' ],
1112   },
1113
1114   {
1115     'key'         => 'payby-default',
1116     'section'     => 'UI',
1117     'description' => 'Default payment type.  HIDE disables display of billing information and sets customers to BILL.',
1118     'type'        => 'select',
1119     'select_enum' => [ '', qw(CARD CHEK LECB BILL COMP HIDE) ],
1120   },
1121
1122   {
1123     'key'         => 'svc_acct-notes',
1124     'section'     => 'UI',
1125     'description' => 'Extra HTML to be displayed on the Account View screen.',
1126     'type'        => 'textarea',
1127   },
1128
1129   {
1130     'key'         => 'radius-password',
1131     'section'     => '',
1132     'description' => 'RADIUS attribute for plain-text passwords.',
1133     'type'        => 'select',
1134     'select_enum' => [ 'Password', 'User-Password' ],
1135   },
1136
1137   {
1138     'key'         => 'radius-ip',
1139     'section'     => '',
1140     'description' => 'RADIUS attribute for IP addresses.',
1141     'type'        => 'select',
1142     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
1143   },
1144
1145   {
1146     'key'         => 'svc_acct-alldomains',
1147     'section'     => '',
1148     '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.',
1149     'type'        => 'checkbox',
1150   },
1151
1152   {
1153     'key'         => 'dump-scpdest',
1154     'section'     => '',
1155     'description' => 'destination for scp database dumps: user@host:/path',
1156     'type'        => 'text',
1157   },
1158
1159   {
1160     'key'         => 'users-allow_comp',
1161     'section'     => '',
1162     '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.',
1163     'type'        => 'textarea',
1164   },
1165
1166   {
1167     'key'         => 'cvv-save',
1168     'section'     => 'billing',
1169     '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.',
1170     'type'        => 'selectmultiple',
1171     'select_enum' => [ "VISA card",
1172                        "MasterCard",
1173                        "Discover card",
1174                        "American Express card",
1175                        "Diner's Club/Carte Blanche",
1176                        "enRoute",
1177                        "JCB",
1178                        "BankCard",
1179                      ],
1180   },
1181
1182   {
1183     'key'         => 'allow_negative_charges',
1184     'section'     => 'billing',
1185     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
1186     'type'        => 'checkbox',
1187   },
1188
1189   {
1190     'key'         => 'system_usernames',
1191     'section'     => 'username',
1192     '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.',
1193     'type'        => 'textarea',
1194   },
1195 );
1196
1197 1;
1198