From 6991d4986df7fb3a6c7c49b5ae1b3713e87a16c4 Mon Sep 17 00:00:00 2001
From: ivan
FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the
-Freeside ISP billing software. This includes: Freeside perl modules and CLI utilities.
the FS::Conf manpage - Freeside configuration values the FS::ConfItem manpage - Freeside configuration option meta-data. the FS::UID manpage - User class (not yet OO) the FS::CGI manpage - Non OO-subroutines for the web interface. This is
-depriciated. Future development will be focused on the FS::UI user-interface
-classes (see below). the FS::CGI manpage - Non OO-subroutines for the web interface.
the FS::Record manpage - Database record base class the FS::svc_acct_pop manpage - POP (Point of Presence, not Post
Office Protocol) class the FS::part_pop_local manpage - Local calling area class the FS::part_referral manpage - Referral class the FS::cust_main_county manpage - Locale (tax rate) class the FS::svc_Common manpage - Service base class the FS::svc_acct manpage - Account (shell, RADIUS, POP3) class the FS::svc_domain manpage - Domain class the FS::domain_record manpage - DNS zone entries the FS::svc_acct_sm manpage - Vitual mail alias class the FS::svc_forward manpage - Mail forwarding class the FS::svc_acct_sm manpage - (Depreciated) Vitual mail alias class the FS::svc_www manpage - Web virtual host class. the FS::part_svc manpage - Service definition class the FS::part_svc_column manpage - Column constraint class the FS::part_export manpage - External provisioning export class the FS::part_export_option manpage - Export option class the FS::part_pkg manpage - Package (billing item) definition class the FS::pkg_svc manpage - Class linking package (billing item)
definitions (see the FS::part_pkg manpage) with service definitions
@@ -76,16 +84,36 @@ definitions (see the FS::part_pkg manpage) wi
class the FS::cust_bill manpage - Invoice class the FS::cust_bill_pkg manpage - Invoice line item class the FS::part_bill_event manpage - Invoice event definition class the FS::cust_bill_event manpage - Completed invoice event class the FS::cust_pay manpage - Payment class the FS::cust_bill_pay manpage - Payment application class the FS::cust_credit manpage - Credit class the FS::cust_refund manpage - Refund class the FS::cust_credit_refund manpage - Refund application class the FS::cust_credit_bill manpage - Credit invoice application class the FS::cust_pay_batch manpage - Credit card transaction queue class the FS::prepay_credit manpage - Prepaid ``calling card'' credit class. the FS::nas manpage - Network Access Server class the FS::port manpage - NAS port class the FS::session manpage - User login session class the FS::queue manpage - Job queue the FS::queue_arg manpage - Job arguments
- the FS::MailAdminServer manpage
+
+ the FS::UI::Base manpage - User-interface base class the FS::UI::Gtk manpage - Gtk user-interface class the FS::UI::CGI manpage - CGI (HTML) user-interface class
(using other auth types, add each user to your Apache authentication and then run: freeside-adduser username
$ su
-$ freeside-adduser -c -h /usr/local/etc/freeside/htpasswd username
+$ freeside-adduser -c -h /usr/local/etc/freeside/htpasswd username
$ su
-$ freeside-adduser -h /usr/local/etc/freeside/htpasswd username
+$ freeside-adduser -h /usr/local/etc/freeside/htpasswd username
+
+
SYNOPSIS
-Utility classes
Database record classes
User Interface classes (under development; not yet usable)
+
+Remote API modules
+
+
+Command-line utilities
+
+
+
+
+
+User Interface classes (under (stalled) development; not yet usable)
To quote perl(1), ``If you're intending to read these straight through for the first time, the suggested order will tend to reduce the number of forward references.''
+If you've never used OO modules before, +http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
Freeside is a billing and administration package for Internet Service Providers.
The Freeside home page is at <http://www.sisd.com/freeside>.
-The main documentation is in htdocs/docs.
--
$Id: FS.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+The main documentation is in httemplate/docs.
A mailing list for users and developers is available. Send a blank message to +
A mailing list for users is available. Send a blank message to <ivan-freeside-subscribe@sisd.com> to subscribe.
+A mailing list for developers is available. It is intended to be lower volume +and higher SNR than the users list. Send a blank message to +<ivan-freeside-devel-subscribe@sisd.com> to subscribe.
Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.
@@ -126,9 +155,6 @@ list and the individal files for details.
The version number of the FS Perl extension differs from the version of the -Freeside distribution, which are both different from the CVS version tag for -each file, which appears under the VERSION heading.
Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH and Net::SCP...
diff --git a/httemplate/docs/man/FS/CGI.html b/httemplate/docs/man/FS/CGI.html index 05f7823b4..54a0bf39b 100644 --- a/httemplate/docs/man/FS/CGI.html +++ b/httemplate/docs/man/FS/CGI.html @@ -79,12 +79,17 @@ Returns HTML tag for beginning an (invisible) table.
Not OO.
Not complete.
+small_custview sooooo doesn't belong here. i should just switch to Mason.
FS::Conf - Read access to Freeside configuration values
+FS::Conf - Freeside configuration values
+ @config_items = $conf->config_items;
Read access to Freeside configuration values. Keys currently map to filenames, +
Read and write Freeside configuration values. Keys currently map to filenames, but this may change in the future.
Write access (with locking) should be implemented.
+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.
config.html from the base documentation contains a list of configuration files.
+``Configuration'' in the web interface (config/config.cgi).
+httemplate/docs/config.html
diff --git a/httemplate/docs/man/FS/Record.html b/httemplate/docs/man/FS/Record.html index 09304083f..108a84ad7 100644 --- a/httemplate/docs/man/FS/Record.html +++ b/httemplate/docs/man/FS/Record.html @@ -17,7 +17,6 @@$value = $record->unique('column');
- $value = $record->ut_float('column'); - $value = $record->ut_number('column'); - $value = $record->ut_numbern('column'); - $value = $record->ut_money('column'); - $value = $record->ut_text('column'); - $value = $record->ut_textn('column'); - $value = $record->ut_alpha('column'); - $value = $record->ut_alphan('column'); - $value = $record->ut_phonen('column'); - $value = $record->ut_anythingn('column');+ $error = $record->ut_float('column'); + $error = $record->ut_number('column'); + $error = $record->ut_numbern('column'); + $error = $record->ut_money('column'); + $error = $record->ut_text('column'); + $error = $record->ut_textn('column'); + $error = $record->ut_alpha('column'); + $error = $record->ut_alphan('column'); + $error = $record->ut_phonen('column'); + $error = $record->ut_anything('column'); + $error = $record->ut_name('column');
$dbdef = reload_dbdef; $dbdef = reload_dbdef "/non/standard/filename"; @@ -125,6 +125,14 @@ objects. #regular FS::TABLE methods #on it. +
Arguments:
+May not be null.
+ +
$Id: Record.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
--
This module should probably be renamed, since much of the functionality is of general use. It is not completely unlike Adapter::DBI (see below).
@@ -323,7 +346,7 @@ true maps to the database (and WHERE clauses) would also help.A fallback check method should be provided which uses the dbdef.
The ut_money method assumes money has two decimal digits.
The Pg money kludge in the new method only strips `$'.
-The ut_phonen method assumes US-style phone numbers.
+The ut_phonen method only checks US-style phone numbers.
The _quote function should probably use ut_float instead of a regex.
All the subroutines probably should be methods, here or elsewhere.
Probably should borrow/use some dbdef methods where appropriate (like sub @@ -331,6 +354,7 @@ fields)
As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc, or allow it to be set. Working around it is ugly any way around - DBI should be fixed. (only affects RDBMS which return uppercase column names)
+ut_zip should take an optional country like ut_phone.
$Id: SessionClient.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: SessionClient.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
-
-FS::SignupClient - Freeside signup client API - +
FS::SignupClient - Freeside signup client API
-
use FS::SignupClient qw( signup_info new_customer ); --
-
( $locales, $packages, $pops ) = signup_info; --
-
$error = new_customer ( { - 'first' => $first, - 'last' => $last, - 'ss' => $ss, - 'comapny' => $company, - 'address1' => $address1, - 'address2' => $address2, - 'city' => $city, - 'county' => $county, - 'state' => $state, - 'zip' => $zip, - 'country' => $country, - 'daytime' => $daytime, - 'night' => $night, - 'fax' => $fax, - 'payby' => $payby, - 'payinfo' => $payinfo, - 'paydate' => $paydate, - 'payname' => $payname, - 'invoicing_list' => $invoicing_list, - 'pkgpart' => $pkgpart, - 'username' => $username, - '_password' => $password, - 'popnum' => $popnum, - } ); -+
+ use FS::SignupClient qw( signup_info new_customer );+
+ ( $locales, $packages, $pops ) = signup_info;+
+ $error = new_customer ( { + 'first' => $first, + 'last' => $last, + 'ss' => $ss, + 'comapny' => $company, + 'address1' => $address1, + 'address2' => $address2, + 'city' => $city, + 'county' => $county, + 'state' => $state, + 'zip' => $zip, + 'country' => $country, + 'daytime' => $daytime, + 'night' => $night, + 'fax' => $fax, + 'payby' => $payby, + 'payinfo' => $payinfo, + 'paydate' => $paydate, + 'payname' => $payname, + 'invoicing_list' => $invoicing_list, + 'referral_custnum' => $referral_custnum, + 'pkgpart' => $pkgpart, + 'username' => $username, + '_password' => $password, + 'popnum' => $popnum, + } );
-This module provides an API for a remote signup server. - -
-It needs to be run as the freeside user. Because of this, the program which -calls these subroutines should be written very carefully. - +
This module provides an API for a remote signup server.
+It needs to be run as the freeside user. Because of this, the program which +calls these subroutines should be written very carefully.
+
-The first set of hash references is of allowable locales. Each hash -reference has the following keys: taxnum state county country - -
-The second set of hash references is of allowable packages. Each hash -reference has the following keys: pkgpart pkg - -
-The third set of hash references is of allowable POPs (Points Of Presence). -Each hash reference has the following keys: popnum city state ac exch - -
-Adds a customer to the remote Freeside system. Requires a hash reference as -a paramater with the following keys: first last ss comapny address1 -address2 city county state zip country daytime night fax payby payinfo -paydate payname invoicing_list pkgpart username _password popnum - -
-Returns a scalar error message, or the empty string for success. - -
The first set of hash references is of allowable locales. Each hash reference +has the following keys: + taxnum + state + county + country
+The second set of hash references is of allowable packages. Each hash +reference has the following keys: + pkgpart + pkg
+The third set of hash references is of allowable POPs (Points Of Presence). +Each hash reference has the following keys: + popnum + city + state + ac + exch
+ +Returns a scalar error message, or the empty string for success.
+
-$Id: SignupClient.html,v 1.1 2001-07-30 07:36:03 ivan Exp $ - -
-
-fs_signupd, FS::SignupServer, FS::cust_main - - +
fs_signupd, the FS::SignupServer manpage, the FS::cust_main manpage
diff --git a/httemplate/docs/man/FS/UID.html b/httemplate/docs/man/FS/UID.html index 9f4947765..3c28eebfd 100644 --- a/httemplate/docs/man/FS/UID.html +++ b/httemplate/docs/man/FS/UID.html @@ -31,7 +31,7 @@use FS::UID qw(adminsuidsetup cgisuidsetup dbh datasrc getotaker - checkeuid checkruid swapuid);+ checkeuid checkruid);
adminsuidsetup $user;
@@ -100,10 +100,6 @@ Returns true if effective UID is that of the freeside user.
$Id: UID.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: UID.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
@cust_pay_objects = $cust_bill->cust_pay;+
+ $tax_amount = $record->tax;
@lines = $cust_bill->print_text; @lines = $cust_bill->print_text $time;@@ -72,6 +74,8 @@ following fields are currently supported:
+ #Returns a list consisting of the total previous credited (see + #L<FS::cust_credit>) and unapplied for this customer, followed by the previous + #outstanding credits (FS::cust_credit objects).
#Returns all payments (see the FS::cust_pay manpage) for this invoice.
+ +
$Id: cust_bill.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: cust_bill.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
the FS::Record manpage, the FS::cust_main manpage, the FS::cust_pay manpage, the FS::cust_bill_pkg manpage, -the FS::cust_credit manpage, schema.html from the base documentation.
+the FS::Record manpage, the FS::cust_main manpage, the FS::cust_bill_pay manpage, FS:;cust_pay, +the FS::cust_bill_pkg manpage, the FS::cust_bill_credit manpage, schema.html from the base +documentation.
diff --git a/httemplate/docs/man/FS/cust_credit.html b/httemplate/docs/man/FS/cust_credit.html index 16caca60d..f30241371 100644 --- a/httemplate/docs/man/FS/cust_credit.html +++ b/httemplate/docs/man/FS/cust_credit.html @@ -61,6 +61,8 @@ FS::Record. The following fields are currently supported:
#Returns all refunds (see the FS::cust_refund manpage) for this credit.
+ +
$Id: cust_credit.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: cust_credit.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
the FS::Record manpage, the FS::cust_refund manpage, the FS::cust_bill manpage, schema.html from the base +
the FS::Record manpage, the FS::cust_credit_refund manpage, the FS::cust_refund manpage, +the FS::cust_credit_bill manpage the FS::cust_bill manpage, schema.html from the base documentation.