projects / freeside.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
new export! infostreet and sqlradius provisioning switched over
[freeside.git] / FS / FS / Conf.pm
diff --git a/FS/FS/Conf.pm b/FS/FS/Conf.pm
index 18725ce..645dbf1 100644 (file)
--- a/FS/FS/Conf.pm
+++ b/FS/FS/Conf.pm
@@ -2,6 +2,7 @@ package FS::Conf;
 
 use vars qw($default_dir @config_items $DEBUG );
 use IO::File;
 
 use vars qw($default_dir @config_items $DEBUG );
 use IO::File;
+use File::Basename;
 use FS::ConfItem;
 
 $DEBUG = 0;
 use FS::ConfItem;
 
 $DEBUG = 0;
@@ -25,6 +26,10 @@ FS::Conf - Freeside configuration values
   @list  = $conf->config('key');
   $bool  = $conf->exists('key');
 
   @list  = $conf->config('key');
   $bool  = $conf->exists('key');
 
+  $conf->touch('key');
+  $conf->set('key' => 'value');
+  $conf->delete('key');
+
   @config_items = $conf->config_items;
 
 =head1 DESCRIPTION
   @config_items = $conf->config_items;
 
 =head1 DESCRIPTION
@@ -67,7 +72,7 @@ sub dir {
   $1;
 }
 
   $1;
 }
 
-=item config 
+=item config KEY
 
 Returns the configuration value or values (depending on context) for key.
 
 
 Returns the configuration value or values (depending on context) for key.
 
@@ -90,7 +95,7 @@ sub config {
   }
 }
 
   }
 }
 
-=item exists
+=item exists KEY
 
 Returns true if the specified key exists, even if the corresponding value
 is undefined.
 
 Returns true if the specified key exists, even if the corresponding value
 is undefined.
@@ -103,7 +108,9 @@ sub exists {
   -e "$dir/$file";
 }
 
   -e "$dir/$file";
 }
 
-=item touch
+=item touch KEY
+
+Creates the specified configuration key if it does not exist.
 
 =cut
 
 
 =cut
 
@@ -116,7 +123,9 @@ sub touch {
   }
 }
 
   }
 }
 
-=item set
+=item set KEY VALUE
+
+Sets the specified configuration key to the given value.
 
 =cut
 
 
 =cut
 
@@ -139,7 +148,9 @@ sub set {
 #             return ! eval { join('',@_), kill 0; 1; };
 #         }
 
 #             return ! eval { join('',@_), kill 0; 1; };
 #         }
 
-=item delete
+=item delete KEY
+
+Deletes the specified configuration key.
 
 =cut
 
 
 =cut
 
@@ -160,16 +171,27 @@ L<FS::ConfItem>.
 =cut
 
 sub config_items {
 =cut
 
 sub config_items {
-#  my $self = shift; 
-  @config_items;
+  my $self = shift; 
+  #quelle kludge
+  @config_items,
+  map { 
+        my $basename = basename($_);
+        $basename =~ /^(.*)$/;
+        $basename = $1;
+        new FS::ConfItem {
+                           'key'         => $basename,
+                           'section'     => 'billing',
+                           'description' => 'Alternate template file for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
+                           'type'        => 'textarea',
+                         }
+      } glob($self->dir. '/invoice_template_*')
+  ;
 }
 
 =back
 
 =head1 BUGS
 
 }
 
 =back
 
 =head1 BUGS
 
-Write access (touch, set, delete) should be documented.
-
 If this was more than just crud that will never be useful outside Freeside I'd
 worry that config_items is freeside-specific and icky.
 
 If this was more than just crud that will never be useful outside Freeside I'd
 worry that config_items is freeside-specific and icky.
 
@@ -291,8 +313,8 @@ httemplate/docs/config.html
   {
     'key'         => 'deletepayments',
     'section'     => 'UI',
   {
     'key'         => 'deletepayments',
     'section'     => 'UI',
-    'description' => 'Enable deletion of unclosed payments.  Be very careful!  Only delete payments that were data-entry errors, not adjustments.',
-    'type'        => 'checkbox',
+    '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.',
+    'type'        => [qw( checkbox text )],
   },
 
   {
   },
 
   {
@@ -374,29 +396,29 @@ httemplate/docs/config.html
 
   {
     'key'         => 'icradiusmachines',
 
   {
     'key'         => 'icradiusmachines',
-    'section'     => 'radius',
-    'description' => 'Turn this option on 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>',
+    'section'     => 'deprecated',
+    'description' => '<b>DEPRECATED</b>, add <i>sqlradius</i> exports to <a href="../browse/part_svc">Service definitions</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>',
     'type'        => [qw( checkbox textarea )],
   },
 
   {
     'key'         => 'icradius_mysqldest',
     'type'        => [qw( checkbox textarea )],
   },
 
   {
     'key'         => 'icradius_mysqldest',
-    'section'     => 'radius',
+    'section'     => 'deprecated',
     'description' => '<b>DEPRECATED</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) - Destination directory for the MySQL databases, on the ICRADIUS/FreeRADIUS machines.  Defaults to "/usr/local/var/".',
     'type'        => 'text',
   },
 
   {
     'key'         => 'icradius_mysqlsource',
     'description' => '<b>DEPRECATED</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) - Destination directory for the MySQL databases, on the ICRADIUS/FreeRADIUS machines.  Defaults to "/usr/local/var/".',
     'type'        => 'text',
   },
 
   {
     'key'         => 'icradius_mysqlsource',
-    'section'     => 'radius',
+    'section'     => 'deprecated',
     'description' => '<b>DEPRECATED</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) - Source directory for for the MySQL radcheck table files, on the Freeside machine.  Defaults to "/usr/local/var/freeside".',
     'type'        => 'text',
   },
 
   {
     'key'         => 'icradius_secrets',
     'description' => '<b>DEPRECATED</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) - Source directory for for the MySQL radcheck table files, on the Freeside machine.  Defaults to "/usr/local/var/freeside".',
     'type'        => 'text',
   },
 
   {
     'key'         => 'icradius_secrets',
-    'section'     => 'radius',
-    'description' => 'Optionally specifies a database for ICRADIUS/FreeRADIUS export.  Three lines: DBI data source, username and password.',
+    'section'     => 'deprecated',
+    'description' => '<b>DEPRECATED</b>, add <i>sqlradius</i> exports to <a href="../browse/part_svc">Service definitions</a> instead.  This option used to specify a database for ICRADIUS/FreeRADIUS export.  Three lines: DBI data source, username and password.',
     'type'        => 'textarea',
   },
 
     'type'        => 'textarea',
   },
 
Freeside billing, trouble ticketing, network monitoring and provisioning