From 1d758388ce3b17b8de1ae1d3a8ec39c1026baefc Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 13 Aug 2001 01:09:02 +0000 Subject: removing --- htdocs/docs/admin.html | 59 ------ htdocs/docs/billing.html | 67 ------ htdocs/docs/config.html | 107 ---------- htdocs/docs/export.html | 41 ---- htdocs/docs/index.html | 31 --- htdocs/docs/install.html | 86 -------- htdocs/docs/legacy.html | 34 --- htdocs/docs/man/FS.html | 138 ------------ htdocs/docs/man/FS/Bill.html | 32 --- htdocs/docs/man/FS/CGI.html | 95 --------- htdocs/docs/man/FS/CGIwrapper.html | 16 -- htdocs/docs/man/FS/Conf.html | 81 ------- htdocs/docs/man/FS/Invoice.html | 32 --- htdocs/docs/man/FS/Record.html | 342 ------------------------------ htdocs/docs/man/FS/SSH.html | 104 --------- htdocs/docs/man/FS/SessionClient.html | 97 --------- htdocs/docs/man/FS/SignupClient.html | 125 ----------- htdocs/docs/man/FS/UI/Base.html | 100 --------- htdocs/docs/man/FS/UI/CGI.html | 94 -------- htdocs/docs/man/FS/UI/Gtk.html | 91 -------- htdocs/docs/man/FS/UI/agent.html | 16 -- htdocs/docs/man/FS/UID.html | 142 ------------- htdocs/docs/man/FS/agent.html | 121 ----------- htdocs/docs/man/FS/agent_type.html | 126 ----------- htdocs/docs/man/FS/cust_bill.html | 161 -------------- htdocs/docs/man/FS/cust_bill_pkg.html | 112 ---------- htdocs/docs/man/FS/cust_credit.html | 118 ----------- htdocs/docs/man/FS/cust_main.html | 252 ---------------------- htdocs/docs/man/FS/cust_main_county.html | 106 --------- htdocs/docs/man/FS/cust_main_invoice.html | 111 ---------- htdocs/docs/man/FS/cust_pay.html | 108 ---------- htdocs/docs/man/FS/cust_pay_batch.html | 132 ------------ htdocs/docs/man/FS/cust_pkg.html | 205 ------------------ htdocs/docs/man/FS/cust_refund.html | 108 ---------- htdocs/docs/man/FS/cust_svc.html | 118 ----------- htdocs/docs/man/FS/dbdef.html | 97 --------- htdocs/docs/man/FS/dbdef_colgroup.html | 86 -------- htdocs/docs/man/FS/dbdef_column.html | 118 ----------- htdocs/docs/man/FS/dbdef_index.html | 58 ----- htdocs/docs/man/FS/dbdef_table.html | 144 ------------- htdocs/docs/man/FS/dbdef_unique.html | 58 ----- htdocs/docs/man/FS/domain_record.html | 122 ----------- htdocs/docs/man/FS/nas.html | 117 ---------- htdocs/docs/man/FS/part_pkg.html | 138 ------------ htdocs/docs/man/FS/part_referral.html | 100 --------- htdocs/docs/man/FS/part_svc.html | 110 ---------- htdocs/docs/man/FS/pkg_svc.html | 115 ---------- htdocs/docs/man/FS/port.html | 120 ----------- htdocs/docs/man/FS/prepay_credit.html | 118 ----------- htdocs/docs/man/FS/session.html | 129 ----------- htdocs/docs/man/FS/svc_Common.html | 94 -------- htdocs/docs/man/FS/svc_acct.html | 219 ------------------- htdocs/docs/man/FS/svc_acct_pop.html | 107 ---------- htdocs/docs/man/FS/svc_acct_sm.html | 141 ------------ htdocs/docs/man/FS/svc_domain.html | 162 -------------- htdocs/docs/man/FS/svc_www.html | 150 ------------- htdocs/docs/man/FS/type_pkgs.html | 100 --------- htdocs/docs/overview.dia | Bin 2800 -> 0 bytes htdocs/docs/overview.png | Bin 13064 -> 0 bytes htdocs/docs/passwd.html | 16 -- htdocs/docs/postgresql.html | 23 -- htdocs/docs/schema.html | 264 ----------------------- htdocs/docs/session.html | 54 ----- htdocs/docs/signup.html | 57 ----- htdocs/docs/trouble.html | 26 --- htdocs/docs/upgrade.html | 24 --- htdocs/docs/upgrade2.html | 11 - htdocs/docs/upgrade3.html | 40 ---- htdocs/docs/upgrade4.html | 27 --- htdocs/docs/upgrade5.html | 34 --- htdocs/docs/upgrade6.html | 66 ------ htdocs/docs/upgrade7.html | 24 --- 72 files changed, 6977 deletions(-) delete mode 100644 htdocs/docs/admin.html delete mode 100644 htdocs/docs/billing.html delete mode 100644 htdocs/docs/config.html delete mode 100644 htdocs/docs/export.html delete mode 100644 htdocs/docs/index.html delete mode 100644 htdocs/docs/install.html delete mode 100644 htdocs/docs/legacy.html delete mode 100644 htdocs/docs/man/FS.html delete mode 100644 htdocs/docs/man/FS/Bill.html delete mode 100644 htdocs/docs/man/FS/CGI.html delete mode 100644 htdocs/docs/man/FS/CGIwrapper.html delete mode 100644 htdocs/docs/man/FS/Conf.html delete mode 100644 htdocs/docs/man/FS/Invoice.html delete mode 100644 htdocs/docs/man/FS/Record.html delete mode 100644 htdocs/docs/man/FS/SSH.html delete mode 100644 htdocs/docs/man/FS/SessionClient.html delete mode 100644 htdocs/docs/man/FS/SignupClient.html delete mode 100644 htdocs/docs/man/FS/UI/Base.html delete mode 100644 htdocs/docs/man/FS/UI/CGI.html delete mode 100644 htdocs/docs/man/FS/UI/Gtk.html delete mode 100644 htdocs/docs/man/FS/UI/agent.html delete mode 100644 htdocs/docs/man/FS/UID.html delete mode 100644 htdocs/docs/man/FS/agent.html delete mode 100644 htdocs/docs/man/FS/agent_type.html delete mode 100644 htdocs/docs/man/FS/cust_bill.html delete mode 100644 htdocs/docs/man/FS/cust_bill_pkg.html delete mode 100644 htdocs/docs/man/FS/cust_credit.html delete mode 100644 htdocs/docs/man/FS/cust_main.html delete mode 100644 htdocs/docs/man/FS/cust_main_county.html delete mode 100644 htdocs/docs/man/FS/cust_main_invoice.html delete mode 100644 htdocs/docs/man/FS/cust_pay.html delete mode 100644 htdocs/docs/man/FS/cust_pay_batch.html delete mode 100644 htdocs/docs/man/FS/cust_pkg.html delete mode 100644 htdocs/docs/man/FS/cust_refund.html delete mode 100644 htdocs/docs/man/FS/cust_svc.html delete mode 100644 htdocs/docs/man/FS/dbdef.html delete mode 100644 htdocs/docs/man/FS/dbdef_colgroup.html delete mode 100644 htdocs/docs/man/FS/dbdef_column.html delete mode 100644 htdocs/docs/man/FS/dbdef_index.html delete mode 100644 htdocs/docs/man/FS/dbdef_table.html delete mode 100644 htdocs/docs/man/FS/dbdef_unique.html delete mode 100644 htdocs/docs/man/FS/domain_record.html delete mode 100644 htdocs/docs/man/FS/nas.html delete mode 100644 htdocs/docs/man/FS/part_pkg.html delete mode 100644 htdocs/docs/man/FS/part_referral.html delete mode 100644 htdocs/docs/man/FS/part_svc.html delete mode 100644 htdocs/docs/man/FS/pkg_svc.html delete mode 100644 htdocs/docs/man/FS/port.html delete mode 100644 htdocs/docs/man/FS/prepay_credit.html delete mode 100644 htdocs/docs/man/FS/session.html delete mode 100644 htdocs/docs/man/FS/svc_Common.html delete mode 100644 htdocs/docs/man/FS/svc_acct.html delete mode 100644 htdocs/docs/man/FS/svc_acct_pop.html delete mode 100644 htdocs/docs/man/FS/svc_acct_sm.html delete mode 100644 htdocs/docs/man/FS/svc_domain.html delete mode 100644 htdocs/docs/man/FS/svc_www.html delete mode 100644 htdocs/docs/man/FS/type_pkgs.html delete mode 100644 htdocs/docs/overview.dia delete mode 100644 htdocs/docs/overview.png delete mode 100644 htdocs/docs/passwd.html delete mode 100755 htdocs/docs/postgresql.html delete mode 100644 htdocs/docs/schema.html delete mode 100644 htdocs/docs/session.html delete mode 100644 htdocs/docs/signup.html delete mode 100644 htdocs/docs/trouble.html delete mode 100644 htdocs/docs/upgrade.html delete mode 100644 htdocs/docs/upgrade2.html delete mode 100644 htdocs/docs/upgrade3.html delete mode 100644 htdocs/docs/upgrade4.html delete mode 100644 htdocs/docs/upgrade5.html delete mode 100644 htdocs/docs/upgrade6.html delete mode 100644 htdocs/docs/upgrade7.html (limited to 'htdocs/docs') diff --git a/htdocs/docs/admin.html b/htdocs/docs/admin.html deleted file mode 100644 index be53c0950..000000000 --- a/htdocs/docs/admin.html +++ /dev/null @@ -1,59 +0,0 @@ - - Administration - - -

Administration

- -

Open up the root of the Freeside document tree in your web - browser. For example, if you created the Freeside document tree in - /home/httpd/html/freeside, and your web browser's DocumentRoot is - /home/httpd/html, open http://your_host/freeside/. Replace - "your_host" with the name or network address of your web server. - -
Once in the Freeside web interface, you must first create a - service. An example of a service would be a dial-up account or a - hosted virtual domain. - -
After you create your first service or services, you must then - create a package of that service or services which you will sell to - your customer. To allow flexibility in changing your service - offerings, Freeside requires that you bundle your services into a - package before customers may purchase them. For instance, you could - create a leased line package which would consist of a one-time - charge for the customer premise equipment, the monthly service fee - for the leased line, a backup dial-up account, and a support - contract. You could also create a leased line package which omits - the support contract simply by adding a new package that does not - include the support contract. - -
After you create your first package, then you must define who is - able to sell that package by creating an agent type. An example of - an agent type would be an internal sales representitive which sells - regular and promotional packages, as opposed to an external sales - representitive which would only sell regular packages of services. - -
After creating a new agent type, you must create an agent, and - assign the the agent type you just created to it. - -
If the service you created was of type svc_acct, you may have to - create a POP from the main menu before you can create your first new - customer. - -
If you are using Freeside to keep track of sales taxes, you must - define tax information for your locale by clicking on the "View/Edit - locales and tax rates" link on the Freeside main menu. - -
Finally, set up at least one referral by clicking on the - "View/Edit referrals" link in the Freeside main menu. Referrals - will help you keep track of how effective your advertising is, by - helping you keep track of where customers heard of your service - offerings. You must create at least one referral. If you do not wish to - use the referral functionality, simply create a single referral only. - -
You should now be ready to sign up your first customer by - clicking on the "New Customer" link at the top of the Freeside main - menu. -

- - diff --git a/htdocs/docs/billing.html b/htdocs/docs/billing.html deleted file mode 100644 index ecb5e1799..000000000 --- a/htdocs/docs/billing.html +++ /dev/null @@ -1,67 +0,0 @@ - - Billing - - -

Billing

To enable billing, you must create an invoice_template configuration file. An example file is available in the conf/ directory of the distribution. You also need to create an lpr configuration file to enable postal invoices. -
- Optional: Invoice template customization -
  - See the Text::Template documentation for details on the substitution language. -
  - You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. -
  - In addition, the following variables are available: -
    - $invnum - invoice number -
    - $date - as a UNIX timestamp (see Date::Format for conversion functions). -
    - $page - current page -
    - $total_pages - total pages -
    - @address - A six-element array containing the customer name, company, and address. -
    - $overdue - true if this invoice is overdue -
    -
  -
-
You can bill individual customers by clicking on the Bill now link on the main customer view. -
The freeside-bill script can be run daily to bill all customers. Usage:
```
freeside-bill [ -c [ i ] ] [ -d date ] [ -b ] user
```
-
- -c: Turn on collecting (you probably want this). -
- -i: Real-time billing (as opposed to bacth billing). Only relevant for credit cards. -
- -d: Pretend it is date (parsed by Date::Parse) -
- -b: N/A -
-

Batch credit card processing -
- After this script is run, a credit card batch will be in the cust_pay_batch table. Export this table to your credit card batching. -
- When your batch completes, erase the cust_pay_batch records in that batch and add any necessary paymants to the cust_pay table. Example code to add payments is: -
```
use FS::cust_pay;
-
-# loop over all records in batch
-
-my $payment=create FS::cust_pay (
-  'invnum' => $invnum,
-  'paid' => $paid,
-  '_date' => $_date,
-  'payby' => $payby,
-  'payinfo' => $payinfo,
-  'paybatch' => $paybatch,
-);
-
-my $error=$payment->insert;
-if ( $error ) {
-  #process error
-}
-
-# end loop
-
```
  -All fields except paybatch are contained in the cust_pay_batch table. You can use paybatch field to track particular batches and/or particular transactions within a batch.
  
  -
- The freeside-print-batch script can print or email pending credit card batches for manual entry. Usage: freeside-print-batch [-v] [-p] [-e] [-a] [-d] user -
  - -v: Verbose - Prints records to STDOUT. -
  - -p: Print to printer lpr as found in the conf directory. -
  - -e: Email output to user found in the Conf email file. -
  - -a: Automatically pays all records in cust_pay_batch. Use -d with this option usually. -
  - -d: Delete - Pays account and deletes record from cust_pay_batch. -
  -
-

- diff --git a/htdocs/docs/config.html b/htdocs/docs/config.html deleted file mode 100644 index 532a826be..000000000 --- a/htdocs/docs/config.html +++ /dev/null @@ -1,107 +0,0 @@ - - Configuration files - - -

Configuration files

Create the /usr/local/etc/freeside directory to hold your configuration. -
Setting up Apache user authetication is mandatory. -
Create the /usr/local/etc/freeside/mapsecrets file, which maps Apache users to a secrets file which contains a DBI data source, username and password. Every -line in /usr/local/etc/freeside/mapsecrets should contain a username and -filename, separated by whitespace. Note that these are not local usernames - -they are passed from Apache. -Apache user authetication is mandatory. For example, if you had the Apache users admin, -john, and sam, -you mapsecrets file might look like: -
```
-admin secretfile
-john secretfile
-sam secretfile
-
```
-
Next, the filename(s) referenced in /usr/local/etc/freeside/mapsecrets file should be created in the /usr/local/etc/freeside/ directory. Each file contains three lines: DBI data source (for example, - DBI:mysql:freeside or DBI:Pg:host=localhost;dbname=freeside), database username, and database password. - These files should not be world readable. See the DBI manpage and the manpage for your DBD for the exact syntax of a DBI data source. In a normal installation such as the example above, a single file /usr/local/etc/freeside/secretfile would be created - for example: -
```
-DBI:Pg:host=localhost;dbname=freeside
-dbusername
-dbpassword
-
```
-

-All further configuration files and directories are located in -/usr/local/etc/freeside/conf.datasource, for example, -/usr/local/etc/freeside/conf.DBI:Pg:host=localhost;dbname=freeside (remember to backslash-escape the ; character when creating directories in the shell: mkdir /usr/local/etc/freeside/conf.DBI:Pg:host=localhost\;dbname=freeside). -

address - This configuration file is no longer used. See invoice_template instead. -
apacheroot - The directory containing Apache virtual hosts -
apachemachine - 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. -
apachemachines - Your Apache machines, one per line. This enables export of `/etc/apache/vhosts.conf', which can be included in your Apache configuration via the Include directive. -
bindprimary - Your BIND primary nameserver. This enables export of /var/named/named.conf and zone files into /var/named -
bindsecondaries - Your BIND secondary nameservers, one per line. This enables export of /var/named/named.conf -
bsdshellmachines - Your BSD flavored shell (and mail) machines, one per line. This enables export of `/etc/passwd' and `/etc/master.passwd'. -
countrydefault - Default two-letter country code (if not supplied, the default is `US') -
cybercash2 - CyberCash v2 support, four lines: paymentserverhost, paymentserverport, paymentserversecret, and transaction type (`mauthonly' or `mauthcapture'). CCLib.pm is required. -
cybercash3.2 - CyberCash v3.2 support. Two lines: the full path and name of your merchant_conf file, and the transaction type (`mauthonly' or `mauthcapture'). CCMckLib3_2.pm, CCMckDirectLib3_2.pm and CCMckErrno3_2 are required. -
deletecustomers - The existance of this file will 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. -
domain - Your domain name. -
editreferrals - The existance of this file will allow you to change the referral of existing customers. -
erpcdmachines - Your ERPCD authenticaion machines, one per line. This enables export of `/usr/annex/acp_passwd' and `/usr/annex/acp_dialup'. -
hidecancelledpackages - The existance of this file will prevent cancelled packages from showing up in listings (though they will still be in the database) -
hidecancelledcustomers - The existance of this file will prevent customers with only cancelled packages from showing up in listings (though they will still be in the database) -
home - For new users, prefixed to usrename to create a directory name. Should have a leading but not a trailing slash. -
icradiusmachines - Your ICRADIUS machines, one per line. The existance of this file (even if empty) turns on radcheck table creation (in the freeside database - the radcheck table needs to be created manually). Machines listed in this file will have the radcheck table exported to them. Each line of this file should contain four items, separted by whitespace: machine name, MySQL database name, MySQL username, and MySQL password. For example: "radius.isp.tld radius_db radius_user passw0rd". Note that to use ICRADIUS export you need to be using MySQL. -
icradius_mysqldest - Destination directory for the MySQL databases, on the ICRADIUS machines. Defaults to "/usr/local/var/". -
icradius_mysqlsource - Source directory for for the MySQL radcheck table files, on the Freeside machine. Defaults to "/usr/local/var/freeside". -
icradius_secrets - Optionally specifies a MySQL database for ICRADIUS export, if you're not running MySQL for your Freeside database. The database should be on the Freeside machine and store data in the icradius_mysqlsource directory. Three lines: DBI data source, username and password. This file should not be world readable. -
invoice_from - Return address on email invoices. -
invoice_template - Required template file for invoices. See the section on billing for details. -
lpr - Print command for paper invoices, for example `lpr -h'. -
maildisablecatchall - The existance of this file will disable the requirement that each virtual domain have a catch-all mailbox. -
money_char - Currency symbol - defaults to `$'. -
mxmachines - MX entries for new domains, weight and machine, one per line, with trailing `.' -
nsmachines - NS nameservers for new domains, one per line, with trailing `.' -
nismachines - Your NIS master (not slave master) machines, one per line. This enables export of `/etc/global/passwd' and `/etc/global/shadow'. -
passwordmin - Minimum password length (default 6); -
qmailmachines - Your qmail machines, one per line. This enables export of `/var/qmail/control/virtualdomains', `/var/qmail/control/recipientmap', and `/var/qmail/control/rcpthosts'. The existance of this file (even if empty) also turns on user `.qmail-extension' file maintenance in conjunction with `shellmachine'. -
radiusmachines - Your RADIUS authentication machines, one per line. This enables export of `/etc/raddb/users'. -
referraldefault - Default referral, specified by refnum. -
registries - Directory which contains domain registry information. Each registry is a directory. -
- registries/internic - Currently the only supported registry -
  - registries/internic/from - Email address from which InterNIC domain registrations are sent. -
  - regestries/internic/nameservers - The nameservers for InterNIC domain registrations, one per line. Each line contains an IP address and hostname, separated by whitespace. -
  - registries/internic/tech_contact - Technical contact NIC handle for domain registrations. -
  - registries/internic/template - Template for InterNIC domain registrations with special markup. A suitable copy of the InterNIC domain template v4.0 is in `fs-x.y.z/etc/domain-template.txt'. -
  - registries/internic/to - Email address to which InterNIC domain registrations are sent. -
  -
-
sendmailconfigpath - Sendmail configuration file path - defaults to `/etc'. Many newer distributions use `/etc/mail'. -
sendmailmachines - Your sendmail machines, one per line. This enables export of `/etc/virtusertable' and `/etc/sendmail.cw'. -
sendmailrestart - If defined, the command which is run on sendmail machines after files are copied. -
session-start - 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: $ip, $nasip and $nasfqdn, 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. -
session-stop - 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: $ip, $nasip and $nasfqdn, 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. -
shellmachine - 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. -
shellmachine-useradd - The command(s) to run on shellmachine when an account is created. If this file does not exist, useradd -d $dir -m -s $shell -u $uid $username is the default. If the file exists but is empty, cp -pr /etc/skel $dir; chown -R $uid.$gid $dir is the default instead. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $username, $uid, $gid, $dir, and $shell. -
shellmachine-userdel - The command(s) to run on shellmachine when an account is deleted. If this file does not exist, userdel $username is the default. If the file exists but is empty, rm -rf $dir is the default instead. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $username and $dir. -
shellmachine-usermod - The command(s) to run on shellmachine when an account is modified. If this file does not exist or is empty, [ -d $old_dir ] && 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 ) is the default. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $old_dir, $new_dir, $uid and $gid. -
shellmachines - Your Linux and System V flavored shell (and mail) machines, one per line. This enables export of `/etc/passwd' and `/etc/shadow' files. -
shells - 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. -
showpasswords - The existance of this file will allow unencrypted user passwords to be displayed. -
smtpmachine - SMTP relay for Freeside's outgoing mail. -
soadefaultttl - SOA default TTL for new domains. -
soaemail - SOA email for new domains, in BIND form (`.' instead of `@'), with trailing `.' -
soaexpire - SOA expire for new domains -
soamachine - SOA machine for new domains, with trailing `.' -
soarefresh - SOA refresh for new domains -
soaretry - SOA retry for new domains -
statedefault - Default state or province (if not supplied, the default is `CA') -
textradiusprepend - The contents of this file will be prepended to the first line of a user's RADIUS entry in text exports. If necessary, usually `Auth-Type = Local, '. -
usernamemin - Minimum username length (default 2); -
usernamemax - Maximum username length (default is the size of the SQL column, probably specified when fs-setup was run) -
username-letter - The existance of this file will turn on the requirement that usernames contain at least one letter. -
username-letterfirst - The existance of this file will turn on the requirement that usernames start with a letter. -
username_policy - 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' or 'append domain' -
vpopmailmachines - Your vpopmail pop toasters, one per line. Each line is of the form "machinename vpopdir vpopuid vpopgid". Eg: poptoaster.domain.tld /home/vpopmail 508 508 Note: vpopuid and vpopgid are values taken from the vpopmail machine's /etc/passwd -

- - diff --git a/htdocs/docs/export.html b/htdocs/docs/export.html deleted file mode 100644 index d92eec346..000000000 --- a/htdocs/docs/export.html +++ /dev/null @@ -1,41 +0,0 @@ - - File exporting - - -

File exporting

bin/svc_acct.export will create UNIX passwd, shadow and master.passwd files, ERPCD acp_passwd and acp_dialup files and a RADIUS users file in the /usr/local/etc/freeside/export.datasrc directory. Some RADIUS servers (such as Radiator and ICRADIUS) will authenticate directly out of an SQL database. In these cases, -it is reccommended that you replicate the data to an external RADIUS machine rather than running the RADIUS server on your Freeside machine. Using the appropriate configuration files, you can export these files to your remote machines unattended: -
- shellmachines - passwd and shadow are copied to the remote machine as /etc/passwd.new and /etc/shadow.new and then moved to /etc/passwd and /etc/shadow if no errors occur. -
- bsdshellmachines - passwd and master.passwd are copied to the remote machine as /etc/passwd.new and /etc/master.passwd.new and moved to /etc/passwd and /etc/master.passwd if no errors occur. -
- nismachines - passwd and shadow are copied to the /etc/global directory on the remote machine. If no errors occur, the command ( cd /var/yp; make; ) is executed on the remote machine. -
- erpcdmachines - acp_passwd and acp_dialup are copied to the /usr/annex directory on the remote machine. If no errors occur, the command ( kill -USR1 `cat /usr/annex/erpcd.pid` ) is executed on the remote machine. -
- radiusmachines - users is copied to the /etc/raddb directory on the remote machine. If no errors occur, the command ( builddbm ) is executed on the remote machine. -
- icradiusmachines - Local radcheck and radreply tables will be created. If any machines are specified, the remote MySQL database will be locked and the radcheck table will be copied to the those machines. You may also need to set the icradius_mysqlsource and/or icradius_mysqldest configuration files. Currently you need to be running MySQL for your Freeside database to use this feature. -
-
site_perl/svc_acct.pm - If a shellmachine is defined, users can be created, modified and deleted remotely; see below. -
- Account creation - If the username, uid and dir fields are defined for a new user, the command(s) specified in the shellmachine-useradd configuration file are executed on shellmachine via ssh. If this file does not exist, useradd -d $dir -m -s $shell -u $uid $username is the default. If the file exists but is empty, cp -pr /etc/skel $dir; chown -R $uid.$gid $dir is the default instead. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $username, $uid, $gid, $dir, and $shell. -
- Account deletion - The command(s) specified in the shellmachine-userdel configuration file are executed on shellmachine via ssh. If this file does not exist, userdel $username is the default. If the file exists but is empty, rm -rf $dir is the default instead. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $username and $dir. -
- Account modification - If a user's home directory changes, the command(s) specified in the shellmachine-usermod configuration file are execute on shellmachine via ssh. If this file does not exist or is empty, [ -d $old_dir ] && 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 ) is the default. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $old_dir, $new_dir, $uid and $gid. -
-
bin/svc_acct_sm.export will create Qmail rcpthosts, recipientmap and virtualdomains files and Sendmail virtusertable and sendmail.cw files in the /usr/local/etc/freeside/export.datasrc directory. Using the appropriate configuration files, you can export these files to your remote machines unattemded: -
- qmailmachines - recipientmap, virtualdomains and rcpthosts are copied to the /var/qmail/control directory on the remote machine. Note: If you imported qmail configuration files, run the generated /usr/local/etc/freeside/export.datasrc/virtualdomains.FIX on a machine with your user home directories before exporting qmail configuration files. -
- shellmachine - The command [ -e homedir/.qmail-default ] || { touch homedir/.qmail-default; chown uid.gid homedir/.qmail-default; } will be run on this machine for users in the virtualdomains file. -
- sendmailmachines - sendmail.cw and virtusertable are copied to the remote machine as /etc/sendmail.cw.new and /etc/virtusertable.new. If no errors occur, they are moved to /etc/sendmail.cw and /etc/virtusertable and the command specified in the sendmailrestart configuration file is executed. (The path can be changed from the default /etc with the sendmailconfigpath configuration file.) -
-
site_perl/svc_acct_sm.pm - If the qmailmachines configuration file exists and a shellmachine is defined, user .qmail- files can be updated. -
- The command [ -e homedir/.qmail-domain-default ] || { touch homedir/.qmail-domain-default; chown uid.gid homedir/.qmail-domain-default; } is run. -
-

-
Unattended remote login - Freeside can login to remote machines unattended using SSH. This can pose a security risk if not configured correctly, and will allow an intruder who breaks into your freeside machine full access to your remote machines. Do not use this feature unless you understand what you are doing! -

As the freeside user (on your freeside machine), generate an authentication key using ssh-keygen. Since this is for unattended operation, you need to use a blank passphrase. -
Append the newly-created identity.pub file to root's authorized_keys on the remote machine(s). -

- - - diff --git a/htdocs/docs/index.html b/htdocs/docs/index.html deleted file mode 100644 index 83e3b3e02..000000000 --- a/htdocs/docs/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - Documentation - - -

Documentation

- diff --git a/htdocs/docs/install.html b/htdocs/docs/install.html deleted file mode 100644 index 8fadc1088..000000000 --- a/htdocs/docs/install.html +++ /dev/null @@ -1,86 +0,0 @@ - - Installation - - -

Installation

-Before installing, you need: -

A web server, such as Apache-SSL or Apache -
SSH -
Perl Don't enable experimental features like threads or the PerlIO abstraction layer. -
A transactional database engine supported by Perl's DBI. PostgreSQL is recommended. (see the PostgreSQL notes) MySQL's default MyISAM and ISAM table types are not supported. If you really want to use MySQL, you need to use one of the new transaction-safe table types such as BDB. -
Perl modules (CPAN will query, download and build perl modules automatically) -
- Array-PrintCols -
- Term-Query (make test broken; install manually) -
- MIME-Base64 -
- Digest-MD5 -
- URI -
- HTML-Tagset -
- HTML-Parser -
- libnet -
- Locale-Codes -
- Net-Whois -
- libwww-perl -
- Business-CreditCard -
- Data-ShowTable -
- MailTools -
- TimeDate -
- DateManip -
- File-CounterFile -
- FreezeThaw -
- String-Approx -
- Text-Template -
- DBI -
- DBD for your database engine -
- DBIx-DBSchema -
- Net-SSH -
- String-ShellQuote -
- Net-SCP -
-

-Install the Freeside distribution: -

Add the user `freeside' to your system. -

Allow the freeside user full access to the freeside database. -

with MySQL:

$ mysqladmin -u root password 'set_a_root_database_password'
-$ mysql -u root -p
-mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* TO freeside@localhost IDENTIFIED BY 'set_a_freeside_database_password';

with PostgreSQL -

Add the freeside database to your database engine. (with MySQL) (with PostgreSQL) -
Unpack the tarball:
```
gunzip -c fs-x.y.z.tar.gz | tar xvf -
```
-

Build and install the Perl libraries: -

-$ cd FS/
-$ perl Makefile.PL
-$ make
-$ su
-# make install UNINST=1

Copy or link fs-x.y.z/htdocs to your web server's document space.

mkdir /usr/local/apache/htdocs/freeside
-cp -r fs-x.y.z/htdocs/* /usr/local/apache/htdocs/freeside

ln -s /full/path/to/fs-x.y.z/htdocs /usr/local/apache/htdocs/freeside

Restrict access to this web interface. (with Apache) -
Enable CGI execution for files with the `.cgi' extension. (with Apache) -
Set ownership and permissions for the web interface. The web interface needs to run as the freeside user - there are several ways to do this. -
- Use Perl's setuid emulation: see the Security Bugs section of the perlsec manpage. -
```
cd /usr/local/apache/htdocs/freeside
-chown -R freeside .
-chmod 4755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi
```
  -
- Use Apache's suEXEC. -
```
cd /usr/local/apache/htdocs/freeside
-chown -R freeside .
-chmod 755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi
```
  -
- Use mod_perl. You should run a separate iteration of Apache[-SSL] as the freeside user. (Warning: The redirect method of CGI.pm 2.36 [as distributed with Perl 5.004_04] is broken under mod_perl. Downlaod the current version from CPAN. Apache 1.3.6 is also highly recommended because of signal handling problems in earlier versions.) -
```
cd /usr/local/apache/htdocs/freeside
-chown -R root .
-chmod 755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi
```
  -
-
Create the necessary configuration files. -
Create the `/usr/local/etc/freeside/counters.datasrc', and - `/usr/local/etc/freeside/export.datasrc' directories for each datasrc (owned by the freeside user). -
As the freeside user, run bin/fs-setup to create the database tables. -
Now proceed to the initial administration of your installation. -

- diff --git a/htdocs/docs/legacy.html b/htdocs/docs/legacy.html deleted file mode 100644 index 3ab21dab2..000000000 --- a/htdocs/docs/legacy.html +++ /dev/null @@ -1,34 +0,0 @@ - - Importing legacy data - - -

Importing legacy data

bin/svc_acct.import - Import `passwd', ( `shadow' or `master.passwd' ) and RADIUS `users'. Before running bin/svc_acct.import, you need services (with table svc_acct) as follows: -
- Most accounts probably have entries in passwd and users (with Port-Limit nonexistant or 1) -
- Some accounts have entries in passwd and users, but with Port-Limit 2 (or more) -
- Some accounts might have entries in users only (Port-Limit 1) -
- Some accounts might have entries in users only (Port-Limit >= 2) -
- POP mail accounts have entries in passwd only, and have a particular shell. -
- Everything else in passwd is a shell account. -
-
bin/svc_acct_sm.import - Import qmail ( `virtualdomains' and `rcpthosts' ), or sendmail ( `virtusertable' and `sendmail.cw' ) files. Before running bin/svc_acct_sm.import, you need services as follows: -
- Domain (table svc_acct) -
- Mail alias (table svc_acct_sm) -
-
Importing customer data -
- Manually -
  - Add a new customer -
  - Add one or more packages for this customer -
  - Enter a package by clicking on the package number -
  - Pick the `Link to existing' option -
  -
- Batch - You will need to write a script to import your particular legacy data. You can use eg/TEMPLATE_cust_main.import as a starting point. -
-

- - diff --git a/htdocs/docs/man/FS.html b/htdocs/docs/man/FS.html deleted file mode 100644 index 3d07462af..000000000 --- a/htdocs/docs/man/FS.html +++ /dev/null @@ -1,138 +0,0 @@ - - -FS - Freeside Perl modules - - - - - - - - -

NAME
SYNOPSIS

Utility classes
Database record classes
User Interface classes (under development; not yet usable)
Notes

DESCRIPTION
VERSION
SUPPORT
AUTHOR
SEE ALSO
BUGS

- - -

NAME

FS - Freeside Perl modules

SYNOPSIS

FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the -Freeside ISP billing software. This includes:

Utility classes

the FS::Conf manpage - Freeside configuration values

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).

Database record classes

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_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_www manpage - Web virtual host class.

the FS::part_svc manpage - Service definition 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 -(see the FS::part_svc manpage)

the FS::agent manpage - Agent (reseller) class

the FS::agent_type manpage - Agent type class

the FS::type_pkgs manpage - Class linking agent types (see -the FS::agent_type manpage) with package (billing item) definitions -(see the FS::part_pkg manpage)

the FS::cust_svc manpage - Service class

the FS::cust_pkg manpage - Package (billing item) class

the FS::cust_main manpage - Customer class

the FS::cust_main_invoice manpage - Invoice destination -class

the FS::cust_bill manpage - Invoice class

the FS::cust_bill_pkg manpage - Invoice line item class

the FS::cust_pay manpage - Payment class

the FS::cust_credit manpage - Credit class

the FS::cust_refund manpage - Refund 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

User Interface classes (under development; not yet usable)

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

the FS::UI::agent manpage - agent table user-interface class

Notes

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.''

DESCRIPTION

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.

VERSION

$Id: FS.html,v 1.3 2001-04-23 12:40:30 ivan Exp $

SUPPORT

A mailing list for users and developers is available. Send a blank message to -<ivan-freeside-subscribe@sisd.com> to subscribe.

Commercial support is available; see -<http://www.sisd.com/freeside/commercial.html>.

AUTHOR

Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.

See the CREDITS file in the Freeside distribution for a (hopefully) complete -list and the individal files for details.

BUGS

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/htdocs/docs/man/FS/Bill.html b/htdocs/docs/man/FS/Bill.html deleted file mode 100644 index cf996ae80..000000000 --- a/htdocs/docs/man/FS/Bill.html +++ /dev/null @@ -1,32 +0,0 @@ - - -FS::Bill - Legacy stub - - - - - - - -

NAME -
SYNOPSIS -

- - -

NAME

-FS::Bill - Legacy stub - -

SYNOPSIS

-The functionality of FS::Bill has been integrated into FS::cust_main. - - - - diff --git a/htdocs/docs/man/FS/CGI.html b/htdocs/docs/man/FS/CGI.html deleted file mode 100644 index 05f7823b4..000000000 --- a/htdocs/docs/man/FS/CGI.html +++ /dev/null @@ -1,95 +0,0 @@ - - -FS::CGI - Subroutines for the web interface - - - - - - - - -

NAME
SYNOPSIS
DESCRIPTION
SUBROUTINES
BUGS
SEE ALSO

- - -

NAME

FS::CGI - Subroutines for the web interface

SYNOPSIS

-  use FS::CGI qw(header menubar idiot eidiot popurl);

-  print header( 'Title', '' );
-  print header( 'Title', menubar('item', 'URL', ... ) );

-  idiot "error message"; 
-  eidiot "error message";

-  $url = popurl; #returns current url
-  $url = popurl(3); #three levels up

DESCRIPTION

Provides a few common subroutines for the web interface.

SUBROUTINES

header TITLE, MENUBAR
-

-Returns an HTML header. -

menubar ITEM, URL, ...
-

-Returns an HTML menubar. -

idiot ERROR
-

-This is depriciated. Don't use it. -

Sends headers and an HTML error message.

eidiot ERROR
-

-This is depriciated. Don't use it. -

Sends headers and an HTML error message, then exits.

popurl LEVEL
-

-Returns current URL with LEVEL levels of path removed from the end (default 0). -

table
-

-Returns HTML tag for beginning a table. -

itable
-

-Returns HTML tag for beginning an (invisible) table. -

ntable
-

-This is getting silly. -

BUGS

Not OO.

Not complete.

NAME

FS::Conf - Read access to Freeside configuration values

SYNOPSIS

-  use FS::Conf;

-  $conf = new FS::Conf "/config/directory";

-  $FS::Conf::default_dir = "/config/directory";
-  $conf = new FS::Conf;

-  $dir = $conf->dir;

-  $value = $conf->config('key');
-  @list  = $conf->config('key');
-  $bool  = $conf->exists('key');

DESCRIPTION

Read access to Freeside configuration values. Keys currently map to filenames, -but this may change in the future.

METHODS

new [ DIRECTORY ]
-: -Create a new configuration object. A directory arguement is required if -$FS::Conf::default_dir has not been set. -
-
dir
-: -Returns the directory. -
-
config
-: -Returns the configuration value or values (depending on context) for key. -
-
exists
-: -Returns true if the specified key exists, even if the corresponding value -is undefined. -

BUGS

Write access (with locking) should be implemented.

NAME

-FS::Invoice - Legacy stub - -

SYNOPSIS

-The functionality of FS::Invoice has been integrated in FS::cust_bill. - - - - diff --git a/htdocs/docs/man/FS/Record.html b/htdocs/docs/man/FS/Record.html deleted file mode 100644 index cc3d37795..000000000 --- a/htdocs/docs/man/FS/Record.html +++ /dev/null @@ -1,342 +0,0 @@ - - -FS::Record - Database record objects - - - - - - - - -

NAME
SYNOPSIS
DESCRIPTION
CONSTRUCTORS
METHODS
SUBROUTINES
VERSION
BUGS
SEE ALSO

- - -

NAME

FS::Record - Database record objects

SYNOPSIS

-    use FS::Record;
-    use FS::Record qw(dbh fields qsearch qsearchs dbdef);

-    $record = new FS::Record 'table', \%hash;
-    $record = new FS::Record 'table', { 'column' => 'value', ... };

-    $record  = qsearchs FS::Record 'table', \%hash;
-    $record  = qsearchs FS::Record 'table', { 'column' => 'value', ... };
-    @records = qsearch  FS::Record 'table', \%hash; 
-    @records = qsearch  FS::Record 'table', { 'column' => 'value', ... };

-    $table = $record->table;
-    $dbdef_table = $record->dbdef_table;

-    $value = $record->get('column');
-    $value = $record->getfield('column');
-    $value = $record->column;

-    $record->set( 'column' => 'value' );
-    $record->setfield( 'column' => 'value' );
-    $record->column('value');

-    %hash = $record->hash;

-    $hashref = $record->hashref;

-    $error = $record->insert;
-    #$error = $record->add; #depriciated

-    $error = $record->delete;
-    #$error = $record->del; #depriciated

-    $error = $new_record->replace($old_record);
-    #$error = $new_record->rep($old_record); #depriciated

-    $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');

-    $dbdef = reload_dbdef;
-    $dbdef = reload_dbdef "/non/standard/filename";
-    $dbdef = dbdef;

-    $quoted_value = _quote($value,'table','field');

-    #depriciated
-    $fields = hfields('table');
-    if ( $fields->{Field} ) { # etc.

-    @fields = fields 'table'; #as a subroutine
-    @fields = $record->fields; #as a method call

DESCRIPTION

(Mostly) object-oriented interface to database records. Records are currently -implemented on top of DBI. FS::Record is intended as a base class for -table-specific classes to inherit from, i.e. FS::cust_main.

CONSTRUCTORS

new [ TABLE, ] HASHREF
-

-Creates a new record. It doesn't store it in the database, though. See -insert for that. -

Note that the object stores this hash reference, not a distinct copy of the -hash it points to. You can ask the object for a copy with the hash -method.

TABLE can only be omitted when a dervived class overrides the table method.

qsearch TABLE, HASHREF, SELECT, EXTRA_SQL
-

-Searches the database for all records matching (at least) the key/value pairs -in HASHREF. Returns all the records found as `FS::TABLE' objects if that -module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record -objects. -

###oops, argh, FS::Record::new only lets us create database fields. -#Normal behaviour if SELECT is not specified is `*', as in -#SELECT * FROM table WHERE .... However, there is an experimental new -#feature where you can specify SELECT - remember, the objects returned, -#although blessed into the appropriate `FS::TABLE' package, will only have the -#fields you specify. This might have unwanted results if you then go calling -#regular FS::TABLE methods -#on it.

qsearchs TABLE, HASHREF
-

-Same as qsearch, except that if more than one record matches, it carps but -returns the first. If this happens, you either made a logic error in asking -for a single item, or your data is corrupted. -

METHODS

table
-

-Returns the table name. -

dbdef_table
-

-Returns the FS::dbdef_table object for the table. -

get, getfield COLUMN
-

-Returns the value of the column/field/key COLUMN. -

set, setfield COLUMN, VALUE
-

-Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE. -

AUTLOADED METHODS
-

-$record->column is a synonym for $record->get('column'); -

$record->column('value') is a synonym for $record->set('column','value');

hash
-

-Returns a list of the column/value pairs, usually for assigning to a new hash. -

To make a distinct duplicate of an FS::Record object, you can do:

-    $new = new FS::Record ( $old->table, { $old->hash } );

hashref
-

-Returns a reference to the column/value hash. -

insert
-

-Inserts this record to the database. If there is an error, returns the error, -otherwise returns false. -

add
-

-Depriciated (use insert instead). -

delete
-

-Delete this record from the database. If there is an error, returns the error, -otherwise returns false. -

del
-

-Depriciated (use delete instead). -

replace OLD_RECORD
-

-Replace the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

rep
-

-Depriciated (use replace instead). -

check
-

-Not yet implemented, croaks. Derived classes should provide a check method. -

unique COLUMN
-

-Replaces COLUMN in record with a unique number. Called by the add method -on primary keys and single-field unique columns (see the DBIx::DBSchema::Table manpage). -Returns the new value. -

ut_float COLUMN
-

-Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be -null. If there is an error, returns the error, otherwise returns false. -

ut_number COLUMN
-

-Check/untaint simple numeric data (whole numbers). May not be null. If there -is an error, returns the error, otherwise returns false. -

ut_numbern COLUMN
-

-Check/untaint simple numeric data (whole numbers). May be null. If there is -an error, returns the error, otherwise returns false. -

ut_money COLUMN
-

-Check/untaint monetary numbers. May be negative. Set to 0 if null. If there -is an error, returns the error, otherwise returns false. -

ut_text COLUMN
-

-Check/untaint text. Alphanumerics, spaces, and the following punctuation -symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? / -May not be null. If there is an error, returns the error, otherwise returns -false. -

ut_textn COLUMN
-

-Check/untaint text. Alphanumerics, spaces, and the following punctuation -symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? / -May be null. If there is an error, returns the error, otherwise returns false. -

ut_alpha COLUMN
-

-Check/untaint alphanumeric strings (no spaces). May not be null. If there is -an error, returns the error, otherwise returns false. -

ut_alpha COLUMN
-

-Check/untaint alphanumeric strings (no spaces). May be null. If there is an -error, returns the error, otherwise returns false. -

ut_phonen COLUMN [ COUNTRY ]
-

-Check/untaint phone numbers. May be null. If there is an error, returns -the error, otherwise returns false. -

Takes an optional two-letter ISO country code; without it or with unsupported -countries, ut_phonen simply calls ut_alphan.

ut_ip COLUMN
-

-Check/untaint ip addresses. IPv4 only for now. -

ut_ipn COLUMN
-

-Check/untaint ip addresses. IPv4 only for now. May be null. -

ut_domain COLUMN
-

-Check/untaint host and domain names. -

ut_anything COLUMN
-

-Untaints arbitrary data. Be careful. -

fields [ TABLE ]
-

-This can be used as both a subroutine and a method call. It returns a list -of the columns in this record's table, or an explicitly specified table. -(See the DBIx::DBSchema::Table manpage). -

SUBROUTINES

reload_dbdef([FILENAME])
-

-Load a database definition (see the DBIx::DBSchema manpage), optionally from a -non-default filename. This command is executed at startup unless -$FS::Record::setup_hack is true. Returns a DBIx::DBSchema object. -

dbdef
-

-Returns the current database definition. See the FS::dbdef manpage. -

_quote VALUE, TABLE, COLUMN
-

-This is an internal function used to construct SQL statements. It returns -VALUE DBI-quoted (see DBI/``quote'') unless VALUE is a number and the column -type (see the FS::dbdef_column manpage) does not end in `char' or `binary'. -

hfields TABLE
-

-This is depriciated. Don't use it. -

It returns a hash-type list with the fields of this record's table set true.

VERSION

$Id: Record.html,v 1.3 2001-04-23 12:40:30 ivan Exp $

BUGS

This module should probably be renamed, since much of the functionality is -of general use. It is not completely unlike Adapter::DBI (see below).

Exported qsearch and qsearchs should be depriciated in favor of method calls -(against an FS::Record object like the old search and searchs that qsearch -and qsearchs were on top of.)

The whole fields / hfields mess should be removed.

The various WHERE clauses should be subroutined.

table string should be depriciated in favor of FS::dbdef_table.

No doubt we could benefit from a Tied hash. Documenting how exists / defined -true maps to the database (and WHERE clauses) would also help.

The ut_ methods should ask the dbdef for a default length.

ut_sqltype (like ut_varchar) should all be defined

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 _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 -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)

NAME

-FS::SSH - Subroutines to call ssh and scp - -

SYNOPSIS

  use FS::SSH qw(ssh scp issh iscp sshopen2 sshopen3);
-

  ssh($host, $command);
-

  issh($host, $command);
-

  scp($source, $destination);
-

  iscp($source, $destination);
-

  sshopen2($host, $reader, $writer, $command);
-

  sshopen3($host, $reader, $writer, $error, $command);
-

DESCRIPTION

  Simple wrappers around ssh and scp commands.
-

SUBROUTINES

ssh HOST, COMMAND

-Calls ssh in batch mode. - -

issh HOST, COMMAND

-Prints the ssh command to be executed, waits for the user to confirm, and -(optionally) executes the command. - -

scp SOURCE, DESTINATION

-Calls scp in batch mode. - -

iscp SOURCE, DESTINATION

-Prints the scp command to be executed, waits for the user to confirm, and -(optionally) executes the command. - -

sshopen2 HOST, READER, WRITER, COMMAND

-Connects the supplied filehandles to the ssh process (in batch mode). - -

sshopen3 HOST, WRITER, READER, ERROR, COMMAND

-Connects the supplied filehandles to the ssh process (in batch mode). - -

BUGS

-Not OO. - -

-scp stuff should transparantly use rsync-over-ssh instead. - -

NAME

FS::SessionClient - Freeside session client API

SYNOPSIS

-  use FS::SessionClient qw( login portnum logout );

-  $error = login ( {
-    'username' => $username,
-    'password' => $password,
-    'login'    => $timestamp,
-    'portnum'  => $portnum,
-  } );

-  $portnum = portnum( { 'ip' => $ip } ) or die "unknown ip!"
-  $portnum = portnum( { 'nasnum' => $nasnum, 'nasport' => $nasport } )
-    or die "unknown nasnum/nasport";

-  $error = logout ( {
-    'username' => $username,
-    'password' => $password,
-    'logout'   => $timestamp,
-    'portnum'  => $portnum,
-  } );

DESCRIPTION

This modules provides an API for a remote session application.

It needs to be run as the freeside user. Because of this, the program which -calls these subroutines should be written very carefully.

SUBROUTINES

login HASHREF
-

-HASHREF should have the following keys: username, password, login and portnum. -login is a UNIX timestamp; if not specified, will default to the current time. -Starts a new session for the specified user and portnum. The password is -optional, but must be correct if specified. -

Returns a scalar error message, or the empty string for success.

portnum
-

-HASHREF should contain a single key: ip, or the two keys: nasnum and nasport. -Returns a portnum suitable for the login and logout subroutines, or false -on error. -

logout HASHREF
-

-HASHREF should have the following keys: usrename, password, logout and portnum. -logout is a UNIX timestamp; if not specified, will default to the current time. -Starts a new session for the specified user and portnum. The password is -optional, but must be correct if specified. -

Returns a scalar error message, or the empty string for success.

VERSION

$Id: SessionClient.html,v 1.1 2001-04-25 01:06:09 ivan Exp $

BUGS

NAME

-FS::SignupClient - Freeside signup client API - -

SYNOPSIS

  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,
-  } );
-

DESCRIPTION

-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. - -

SUBROUTINES

signup_info

-Returns three array references of hash references. - -

-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 - -

new_customer HASHREF

-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. - -

VERSION

-$Id: SignupClient.html,v 1.1 2001-04-23 12:41:57 ivan Exp $ - -

BUGS

NAME

FS::UI::Base - Base class for all user-interface objects

SYNOPSIS

-  use FS::UI::SomeInterface;
-  use FS::UI::some_table;

-  $interface = new FS::UI::some_table;

-  $error = $interface->browse;
-  $error = $interface->search;
-  $error = $interface->view;
-  $error = $interface->edit;
-  $error = $interface->process;

DESCRIPTION

An FS::UI::Base object represents a user interface object. FS::UI::Base -is intended as a base class for table-specfic classes to inherit from, i.e. -FS::UI::cust_main. The simplest case, which will provide a default UI for your -new table, is as follows:

-  package FS::UI::table_name;
-  use vars qw ( @ISA );
-  use FS::UI::Base;
-  @ISA = qw( FS::UI::Base );
-  sub db_table { 'table_name'; }

Currently available interfaces are: - FS::UI::Gtk, an X-Windows UI implemented using the Gtk+ toolkit - FS::UI::CGI, a web interface implemented using CGI.pm, etc.

METHODS

new
-: -
browse
-: -
title
-: -
addwidget
-: -

VERSION

$Id: Base.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

This documentation is incomplete.

There should be some sort of per-(freeside)-user preferences and the ability -for specific FS::UI:: modules to put their own values there as well.

HISTORY

$Log: Base.html,v $ -

Revision 1.3 2001-04-23 12:40:31 ivan -

documentation and webdemo updates -

-Revision 1.1 1999/08/04 09:03:53 ivan -initial checkin of module files for proper perl installation

Revision 1.1 1999/01/20 09:30:36 ivan -skeletal cross-UI UI code.

- - - - diff --git a/htdocs/docs/man/FS/UI/CGI.html b/htdocs/docs/man/FS/UI/CGI.html deleted file mode 100644 index 49991f1aa..000000000 --- a/htdocs/docs/man/FS/UI/CGI.html +++ /dev/null @@ -1,94 +0,0 @@ - - -FS::UI::CGI - Base class for CGI user-interface objects - - - - - - - - -

NAME
SYNOPSIS
DESCRIPTION
METHODS
VERSION
BUGS
SEE ALSO
HISTORY

- - -

NAME

FS::UI::CGI - Base class for CGI user-interface objects

SYNOPSIS

-  use FS::UI::CGI;
-  use FS::UI::some_table;

-  $interface = new FS::UI::some_table;

-  $error = $interface->browse;
-  $error = $interface->search;
-  $error = $interface->view;
-  $error = $interface->edit;
-  $error = $interface->process;

DESCRIPTION

An FS::UI::CGI object represents a CGI interface object.

METHODS

new
-: -
_header
-: -
_footer
-: -
interface
-: -Returns the string `CGI'. Useful for the author of a table-specific UI class -to conditionally specify certain behaviour. -

VERSION

$Id: CGI.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

This documentation is incomplete.

In _Tableborder, headers should be links that sort on their fields.

_Link uses a constant $BASE_URL

_Link passes the arguments as a manually-constructed GET string instead -of POSTing, for compatability while the web interface is upgraded. Once -this is done it should pass arguements properly (i.e. as a POST, 8-bit clean)

Still some small bits of widget code same as FS::UI::Gtk.

HISTORY

$Log: CGI.html,v $ -

Revision 1.3 2001-04-23 12:40:31 ivan -

documentation and webdemo updates -

-Revision 1.1 1999/08/04 09:03:53 ivan -initial checkin of module files for proper perl installation

Revision 1.1 1999/01/20 09:30:36 ivan -skeletal cross-UI UI code.

- - - - diff --git a/htdocs/docs/man/FS/UI/Gtk.html b/htdocs/docs/man/FS/UI/Gtk.html deleted file mode 100644 index 24d620087..000000000 --- a/htdocs/docs/man/FS/UI/Gtk.html +++ /dev/null @@ -1,91 +0,0 @@ - - -FS::UI::Gtk - Base class for Gtk user-interface objects - - - - - - - - -

NAME
SYNOPSIS
DESCRIPTION
METHODS
VERSION
BUGS
SEE ALSO
HISTORY

- - -

NAME

FS::UI::Gtk - Base class for Gtk user-interface objects

SYNOPSIS

-  use FS::UI::Gtk;
-  use FS::UI::some_table;

-  $interface = new FS::UI::some_table;

-  $error = $interface->browse;
-  $error = $interface->search;
-  $error = $interface->view;
-  $error = $interface->edit;
-  $error = $interface->process;

DESCRIPTION

An FS::UI::Gtk object represents a Gtk user interface object.

METHODS

new
-: -
interface
-: -Returns the string `Gtk'. Useful for the author of a table-specific UI class -to conditionally specify certain behaviour. -

VERSION

$Id: Gtk.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

This documentation is incomplete.

_Tableborder is just a _Table now. _Tableborders should scroll (but not the -headers) and need and need more decoration. (data in white section ala gtksql -and sliding field widths) headers should be buttons that callback to sort on -their fields.

There should be a persistant, per-(freeside)-user store for window positions -and sizes and sort fields etc (see BUGS in the FS::UI::CGI manpage.

Still some small bits of widget code same as FS::UI::CGI.

HISTORY

$Log: Gtk.html,v $ -

Revision 1.3 2001-04-23 12:40:31 ivan -

documentation and webdemo updates -

-Revision 1.1 1999/08/04 09:03:53 ivan -initial checkin of module files for proper perl installation

Revision 1.1 1999/01/20 09:30:36 ivan -skeletal cross-UI UI code.

- - - - diff --git a/htdocs/docs/man/FS/UI/agent.html b/htdocs/docs/man/FS/UI/agent.html deleted file mode 100644 index 8608e4ef4..000000000 --- a/htdocs/docs/man/FS/UI/agent.html +++ /dev/null @@ -1,16 +0,0 @@ - - -./FS/FS/UI/agent.pm - - - - - - - - - - - - - diff --git a/htdocs/docs/man/FS/UID.html b/htdocs/docs/man/FS/UID.html deleted file mode 100644 index 9c4da492b..000000000 --- a/htdocs/docs/man/FS/UID.html +++ /dev/null @@ -1,142 +0,0 @@ - - -FS::UID - Subroutines for database login and assorted other stuff - - - - - - - - -

NAME
SYNOPSIS
DESCRIPTION
SUBROUTINES
CALLBACKS
VERSION
BUGS
SEE ALSO

- - -

NAME

FS::UID - Subroutines for database login and assorted other stuff

SYNOPSIS

-  use FS::UID qw(adminsuidsetup cgisuidsetup dbh datasrc getotaker
-  checkeuid checkruid swapuid);

-  adminsuidsetup $user;

-  $cgi = new CGI;
-  $dbh = cgisuidsetup($cgi);

-  $dbh = dbh;

-  $datasrc = datasrc;

-  $driver_name = driver_name;

DESCRIPTION

Provides a hodgepodge of subroutines.

SUBROUTINES

adminsuidsetup USER
-: -Sets the user to USER (see config.html from the base documentation). -Cleans the environment. -Make sure the script is running as freeside, or setuid freeside. -Opens a connection to the database. -Swaps real and effective UIDs. -Runs any defined callbacks (see below). -Returns the DBI database handle (usually you don't need this). -
-
cgisuidsetup CGI_object
-: -Takes a single argument, which is a CGI (see the CGI manpage) or Apache (see Apache) -object (CGI::Base is depriciated). Runs cgisetotaker and then adminsuidsetup. -
-
cgi
-: -Returns the CGI (see the CGI manpage) object. -
-
dbh
-: -Returns the DBI database handle. -
-
datasrc
-: -Returns the DBI data source. -
-
driver_name
-: -Returns just the driver name portion of the DBI data source. -
-
getotaker
-: -Returns the current Freeside user. -
-
cgisetotaker
-: -Sets and returns the CGI REMOTE_USER. $cgi should be defined as a CGI.pm -object (see the CGI manpage) or an Apache object (see Apache). Support for CGI::Base -and derived classes is depriciated. -
-
checkeuid
-: -Returns true if effective UID is that of the freeside user. -
-
checkruid
-: -Returns true if the real UID is that of the freeside user. -
-
swapuid
-: -Swaps real and effective UIDs. -
-
getsecrets [ USER ]
-: -Sets the user to USER, if supplied. -Sets and returns the DBI datasource, username and password for this user from -the `/usr/local/etc/freeside/mapsecrets' file. -

CALLBACKS

Warning: this interface is likely to change in future releases.

A package can install a callback to be run in adminsuidsetup by putting a -coderef into the hash %FS::UID::callback :

-    $coderef = sub { warn "Hi, I'm returning your call!" };
-    $FS::UID::callback{'Package::Name'};

VERSION

$Id: UID.html,v 1.3 2001-04-23 12:40:30 ivan Exp $

BUGS

Too many package-global variables.

Not OO.

No capabilities yet. When mod_perl and Authen::DBI are implemented, -cgisuidsetup will go away as well.

Goes through contortions to support non-OO syntax with multiple datasrc's.

Callbacks are inelegant.

NAME

FS::agent - Object methods for agent records

SYNOPSIS

-  use FS::agent;

-  $record = new FS::agent \%hash;
-  $record = new FS::agent { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $agent_type = $record->agent_type;

-  $hashref = $record->pkgpart_hashref;
-  #may purchase $pkgpart if $hashref->{$pkgpart};

DESCRIPTION

An FS::agent object represents an agent. Every customer has an agent. Agents -can be used to track things like resellers or salespeople. FS::agent inherits -from FS::Record. The following fields are currently supported:

agemtnum - primary key (assigned automatically for new agents)
-: -
agent - Text name of this agent
-: -
typenum - Agent type. See the FS::agent_type manpage
-: -
prog - For future use.
-: -
freq - For future use.
-: -

METHODS

new HASHREF
-: -Creates a new agent. To add the agent to the database, see insert. -
-
insert
-: -Adds this agent to the database. If there is an error, returns the error, -otherwise returns false. -
-
delete
-: -Deletes this agent from the database. Only agents with no customers can be -deleted. If there is an error, returns the error, otherwise returns false. -
-
replace OLD_RECORD
-: -Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid agent. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -
-
agent_type
-: -Returns the FS::agent_type object (see the FS::agent_type manpage) for this agent. -
-
pkgpart_hashref
-: -Returns a hash reference. The keys of the hash are pkgparts. The value is -true if this agent may purchase the specified package definition. See -the FS::part_pkg manpage. -

VERSION

$Id: agent.html,v 1.3 2001-04-23 12:40:30 ivan Exp $

BUGS

NAME

FS::agent_type - Object methods for agent_type records

SYNOPSIS

-  use FS::agent_type;

-  $record = new FS::agent_type \%hash;
-  $record = new FS::agent_type { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $hashref = $record->pkgpart_hashref;
-  #may purchase $pkgpart if $hashref->{$pkgpart};

-  @type_pkgs = $record->type_pkgs;

-  @pkgparts = $record->pkgpart;

DESCRIPTION

An FS::agent_type object represents an agent type. Every agent (see -the FS::agent manpage) has an agent type. Agent types define which packages (see -the FS::part_pkg manpage) may be purchased by customers (see the FS::cust_main manpage), via -FS::type_pkgs records (see the FS::type_pkgs manpage). FS::agent_type inherits from -FS::Record. The following fields are currently supported:

typenum - primary key (assigned automatically for new agent types)
-: -
atype - Text name of this agent type
-: -

METHODS

new HASHREF
-: -Creates a new agent type. To add the agent type to the database, see -insert. -
-
insert
-: -Adds this agent type to the database. If there is an error, returns the error, -otherwise returns false. -
-
delete
-: -Deletes this agent type from the database. Only agent types with no agents -can be deleted. If there is an error, returns the error, otherwise returns -false. -
-
replace OLD_RECORD
-: -Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid agent type. If there is an -error, returns the error, otherwise returns false. Called by the insert and -replace methods. -
-
pkgpart_hashref
-: -Returns a hash reference. The keys of the hash are pkgparts. The value is -true iff this agent may purchase the specified package definition. See -the FS::part_pkg manpage. -
-
type_pkgs
-: -Returns all FS::type_pkgs objects (see the FS::type_pkgs manpage) for this agent type. -
-
pkgpart
-: -Returns the pkgpart of all package definitions (see the FS::part_pkg manpage) for this -agent type. -

VERSION

$Id: agent_type.html,v 1.3 2001-04-23 12:40:30 ivan Exp $

BUGS

NAME

FS::cust_bill - Object methods for cust_bill records

SYNOPSIS

-  use FS::cust_bill;

-  $record = new FS::cust_bill \%hash;
-  $record = new FS::cust_bill { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  ( $total_previous_balance, @previous_cust_bill ) = $record->previous;

-  @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;

-  ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;

-  @cust_pay_objects = $cust_bill->cust_pay;

-  @lines = $cust_bill->print_text;
-  @lines = $cust_bill->print_text $time;

DESCRIPTION

An FS::cust_bill object represents an invoice; a declaration that a customer -owes you money. The specific charges are itemized as cust_bill_pkg records -(see the FS::cust_bill_pkg manpage). FS::cust_bill inherits from FS::Record. The -following fields are currently supported:

invnum - primary key (assigned automatically for new invoices)
-: -
custnum - customer (see the FS::cust_main manpage)
-: -
_date - specified as a UNIX timestamp; see perlfunc/``time''. Also see -the Time::Local manpage and the Date::Parse manpage for conversion functions.
-: -
charged - amount of this invoice
-: -
printed - how many times this invoice has been printed automatically -(see collect in the FS::cust_main manpage).
-: -

METHODS

new HASHREF
-

-Creates a new invoice. To add the invoice to the database, see insert. -Invoices are normally created by calling the bill method of a customer object -(see the FS::cust_main manpage). -

insert
-

-Adds this invoice to the database (``Posts'' the invoice). If there is an error, -returns the error, otherwise returns false. -

delete
-

-Currently unimplemented. I don't remove invoices because there would then be -no record you ever posted this invoice (which is bad, no?) -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

Only printed may be changed. printed is normally updated by calling the -collect method of a customer object (see the FS::cust_main manpage).

check
-

-Checks all fields to make sure this is a valid invoice. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -

previous
-

-Returns a list consisting of the total previous balance for this customer, -followed by the previous outstanding invoices (as FS::cust_bill objects also). -

cust_bill_pkg
-

-Returns the line items (see the FS::cust_bill_pkg manpage) for this invoice. -

cust_credit
-

-Returns a list consisting of the total previous credited (see -the FS::cust_credit manpage) for this customer, followed by the previous outstanding -credits (FS::cust_credit objects). -

cust_pay
-

-Returns all payments (see the FS::cust_pay manpage) for this invoice. -

owed
-

-Returns the amount owed (still outstanding) on this invoice, which is charged -minus all payments (see the FS::cust_pay manpage). -

print_text [TIME];
-

-Returns an text invoice, as a list of lines. -

TIME an optional value used to control the printing of overdue messages. The -default is now. It isn't the date of the invoice; that's the `_date' field. -It is specified as a UNIX timestamp; see perlfunc/``time''. Also see -the Time::Local manpage and the Date::Parse manpage for conversion functions.

VERSION

$Id: cust_bill.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

The delete method.

print_text formatting (and some logic :/) is in source, but needs to be -slurped in from a file. Also number of lines ($=).

missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style -or something similar so the look can be completely customized?)

NAME

FS::cust_bill_pkg - Object methods for cust_bill_pkg records

SYNOPSIS

-  use FS::cust_bill_pkg;

-  $record = new FS::cust_bill_pkg \%hash;
-  $record = new FS::cust_bill_pkg { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::cust_bill_pkg object represents an invoice line item. -FS::cust_bill_pkg inherits from FS::Record. The following fields are currently -supported:

invnum - invoice (see the FS::cust_bill manpage)
-: -
pkgnum - package (see the FS::cust_pkg manpage) or 0 for the special virtual sales tax package
-: -
setup - setup fee
-: -
recur - recurring fee
-: -
sdate - starting date of recurring fee
-: -
edate - ending date of recurring fee
-: -

sdate and edate are specified as UNIX timestamps; see perlfunc/``time''. Also -see the Time::Local manpage and the Date::Parse manpage for conversion functions.

METHODS

new HASHREF
-: -Creates a new line item. To add the line item to the database, see -insert. Line items are normally created by calling the bill method of a -customer object (see the FS::cust_main manpage). -
-
insert
-: -Adds this line item to the database. If there is an error, returns the error, -otherwise returns false. -
-
delete
-: -Currently unimplemented. I don't remove line items because there would then be -no record the items ever existed (which is bad, no?) -
-
replace OLD_RECORD
-: -Currently unimplemented. This would be even more of an accounting nightmare -than deleteing the items. Just don't do it. -
-
check
-: -Checks all fields to make sure this is a valid line item. If there is an -error, returns the error, otherwise returns false. Called by the insert -method. -

VERSION

$Id: cust_bill_pkg.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

NAME

FS::cust_credit - Object methods for cust_credit records

SYNOPSIS

-  use FS::cust_credit;

-  $record = new FS::cust_credit \%hash;
-  $record = new FS::cust_credit { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::cust_credit object represents a credit; the equivalent of a negative -cust_bill record (see the FS::cust_bill manpage). FS::cust_credit inherits from -FS::Record. The following fields are currently supported:

crednum - primary key (assigned automatically for new credits)
-: -
custnum - customer (see the FS::cust_main manpage)
-: -
amount - amount of the credit
-: -
_date - specified as a UNIX timestamp; see perlfunc/``time''. Also see -the Time::Local manpage and the Date::Parse manpage for conversion functions.
-: -
otaker - order taker (assigned automatically, see the FS::UID manpage)
-: -
reason - text
-: -

METHODS

new HASHREF
-: -Creates a new credit. To add the credit to the database, see insert. -
-
insert
-: -Adds this credit to the database (``Posts'' the credit). If there is an error, -returns the error, otherwise returns false. -
-
delete
-: -Currently unimplemented. -
-
replace OLD_RECORD
-: -Credits may not be modified; there would then be no record the credit was ever -posted. -
-
check
-: -Checks all fields to make sure this is a valid credit. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -
-
cust_refund
-: -Returns all refunds (see the FS::cust_refund manpage) for this credit. -
-
credited
-: -Returns the amount of this credit that is still outstanding; which is -amount minus all refunds (see the FS::cust_refund manpage). -

VERSION

$Id: cust_credit.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

The delete method.

NAME

FS::cust_main - Object methods for cust_main records

SYNOPSIS

-  use FS::cust_main;

-  $record = new FS::cust_main \%hash;
-  $record = new FS::cust_main { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  @cust_pkg = $record->all_pkgs;

-  @cust_pkg = $record->ncancelled_pkgs;

-  $error = $record->bill;
-  $error = $record->bill %options;
-  $error = $record->bill 'time' => $time;

-  $error = $record->collect;
-  $error = $record->collect %options;
-  $error = $record->collect 'invoice_time'   => $time,
-                            'batch_card'     => 'yes',
-                            'report_badcard' => 'yes',
-                          ;

DESCRIPTION

An FS::cust_main object represents a customer. FS::cust_main inherits from -FS::Record. The following fields are currently supported:

custnum - primary key (assigned automatically for new customers)
-: -
agentnum - agent (see the FS::agent manpage)
-: -
refnum - referral (see the FS::part_referral manpage)
-: -
first - name
-: -
last - name
-: -
ss - social security number (optional)
-: -
company - (optional)
-: -
address1
-: -
address2 - (optional)
-: -
city
-: -
county - (optional, see the FS::cust_main_county manpage)
-: -
state - (see the FS::cust_main_county manpage)
-: -
zip
-: -
country - (see the FS::cust_main_county manpage)
-: -
daytime - phone (optional)
-: -
night - phone (optional)
-: -
fax - phone (optional)
-: -
payby - `CARD' (credit cards), `BILL' (billing), `COMP' (free), or `PREPAY' (special billing type: applies a credit - see the FS::prepay_credit manpage and sets billing type to BILL)
-: -
payinfo - card number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see the FS::prepay_credit manpage)
-: -
paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
-: -
payname - name on card or billing name
-: -
tax - tax exempt, empty or `Y'
-: -
otaker - order taker (assigned automatically, see the FS::UID manpage)
-: -

METHODS

new HASHREF
-

-Creates a new customer. To add the customer to the database, see insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this customer to the database. If there is an error, returns the error, -otherwise returns false. -

There is a special insert mode in which you pass a data structure to the insert -method containing FS::cust_pkg and FS::svc_tablename objects. When -running under a transactional database, all records are inserted atomicly, or -the transaction is rolled back. There should be a better explanation of this, -but until then, here's an example:

-  use Tie::RefHash;
-  tie %hash, 'Tie::RefHash'; #this part is important
-  %hash = {
-    $cust_pkg => [ $svc_acct ],
-  };
-  $cust_main->insert( \%hash );

delete NEW_CUSTNUM
-

-This deletes the customer. If there is an error, returns the error, otherwise -returns false. -

This will completely remove all traces of the customer record. This is not -what you want when a customer cancels service; for that, cancel all of the -customer's packages (see cancel in the FS::cust_pkg manpage).

If the customer has any packages, you need to pass a new (valid) customer -number for those packages to be transferred to.

You can't delete a customer with invoices (see the FS::cust_bill manpage), -or credits (see the FS::cust_credit manpage).

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

check
-

-Checks all fields to make sure this is a valid customer record. If there is -an error, returns the error, otherwise returns false. Called by the insert -and repalce methods. -

all_pkgs
-

-Returns all packages (see the FS::cust_pkg manpage) for this customer. -

ncancelled_pkgs
-

-Returns all non-cancelled packages (see the FS::cust_pkg manpage) for this customer. -

bill OPTIONS
-

-Generates invoices (see the FS::cust_bill manpage) for this customer. Usually used in -conjunction with the collect method. -

The only currently available option is `time', which bills the customer as if -it were that time. It is specified as a UNIX timestamp; see -perlfunc/``time''). Also see the Time::Local manpage and the Date::Parse manpage for conversion -functions.

If there is an error, returns the error, otherwise returns false.

collect OPTIONS
-

-(Attempt to) collect money for this customer's outstanding invoices (see -the FS::cust_bill manpage). Usually used after the bill method. -

Depending on the value of `payby', this may print an invoice (`BILL'), charge -a credit card (`CARD'), or just add any necessary (pseudo-)payment (`COMP').

If there is an error, returns the error, otherwise returns false.

Currently available options are:

invoice_time - Use this time when deciding when to print invoices and -late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see perlfunc/``time''). Also see the Time::Local manpage and the Date::Parse manpage -for conversion functions.

batch_card - Set this true to batch cards (see the cust_pay_batch manpage). By -default, cards are processed immediately, which will generate an error if -CyberCash is not installed.

report_badcard - Set this true if you want bad card transactions to -return an error. By default, they don't.

total_owed
-

-Returns the total owed for this customer on all invoices -(see the FS::cust_bill manpage). -

total_credited
-

-Returns the total credits (see the FS::cust_credit manpage) for this customer. -

balance
-

-Returns the balance for this customer (total owed minus total credited). -

invoicing_list [ ARRAYREF ]
-

-If an arguement is given, sets these email addresses as invoice recipients -(see the FS::cust_main_invoice manpage). Errors are not fatal and are not reported -(except as warnings), so use check_invoicing_list first. -

Returns a list of email addresses (with svcnum entries expanded).

Note: You can clear the invoicing list by passing an empty ARRAYREF. You can -check it without disturbing anything by passing nothing.

This interface may change in the future.

check_invoicing_list ARRAYREF
-

-Checks these arguements as valid input for the invoicing_list method. If there -is an error, returns the error, otherwise returns false. -

VERSION

$Id: cust_main.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

The delete method.

The delete method should possibly take an FS::cust_main object reference -instead of a scalar customer number.

Bill and collect options should probably be passed as references instead of a -list.

CyberCash v2 forces us to define some variables in package main.

There should probably be a configuration file with a list of allowed credit -card types.

CyberCash is the only processor.

No multiple currency support (probably a larger project than just this module).

NAME

FS::cust_main_county - Object methods for cust_main_county objects

SYNOPSIS

-  use FS::cust_main_county;

-  $record = new FS::cust_main_county \%hash;
-  $record = new FS::cust_main_county { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::cust_main_county object represents a tax rate, defined by locale. -FS::cust_main_county inherits from FS::Record. The following fields are -currently supported:

taxnum - primary key (assigned automatically for new tax rates)
-: -
state
-: -
county
-: -
country
-: -
tax - percentage
-: -

METHODS

new HASHREF
-: -Creates a new tax rate. To add the tax rate to the database, see insert. -
-
insert
-: -Adds this tax rate to the database. If there is an error, returns the error, -otherwise returns false. -
-
delete
-: -Deletes this tax rate from the database. If there is an error, returns the -error, otherwise returns false. -
-
replace OLD_RECORD
-: -Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid tax rate. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -

VERSION

$Id: cust_main_county.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

NAME

FS::cust_main_invoice - Object methods for cust_main_invoice records

SYNOPSIS

-  use FS::cust_main_invoice;

-  $record = new FS::cust_main_invoice \%hash;
-  $record = new FS::cust_main_invoice { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $email_address = $record->address;

DESCRIPTION

An FS::cust_main_invoice object represents an invoice destination. FS::cust_main_invoice inherits from -FS::Record. The following fields are currently supported:

destnum - primary key
-: -
custnum - customer (see the FS::cust_main manpage)
-: -
dest - Invoice destination: If numeric, a svcnum (see the FS::svc_acct manpage), if string, a literal email address, or `POST' to enable mailing (the default if no cust_main_invoice records exist)
-: -

METHODS

new HASHREF
-

-Creates a new invoice destination. To add the invoice destination to the database, see insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -

delete
-

-Delete this record from the database. -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

check
-

-Checks all fields to make sure this is a valid invoice destination. If there is -an error, returns the error, otherwise returns false. Called by the insert -and repalce methods. -

checkdest
-

-Checks the dest field only. -

address
-

-Returns the literal email address for this record (or `POST'). -

VERSION

$Id: cust_main_invoice.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

NAME

FS::cust_pay - Object methods for cust_pay objects

SYNOPSIS

-  use FS::cust_pay;

-  $record = new FS::cust_pay \%hash;
-  $record = new FS::cust_pay { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::cust_pay object represents a payment; the transfer of money from a -customer. FS::cust_pay inherits from FS::Record. The following fields are -currently supported:

paynum - primary key (assigned automatically for new payments)
-: -
invnum - Invoice (see the FS::cust_bill manpage)
-: -
paid - Amount of this payment
-: -
_date - specified as a UNIX timestamp; see perlfunc/``time''. Also see -the Time::Local manpage and the Date::Parse manpage for conversion functions.
-: -
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
-: -
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
-: -
paybatch - text field for tracking card processing
-: -

METHODS

new HASHREF
-: -Creates a new payment. To add the payment to the databse, see insert. -
-
insert
-: -Adds this payment to the databse, and updates the invoice (see -the FS::cust_bill manpage). -
-
delete
-: -Currently unimplemented (accounting reasons). -
-
replace OLD_RECORD
-: -Currently unimplemented (accounting reasons). -
-
check
-: -Checks all fields to make sure this is a valid payment. If there is an error, -returns the error, otherwise returns false. Called by the insert method. -

VERSION

$Id: cust_pay.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

Delete and replace methods.

NAME

FS::cust_pay_batch - Object methods for batch cards

SYNOPSIS

-  use FS::cust_pay_batch;

-  $record = new FS::cust_pay_batch \%hash;
-  $record = new FS::cust_pay_batch { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::cust_pay_batch object represents a credit card transaction ready to be -batched (sent to a processor). FS::cust_pay_batch inherits from FS::Record. -Typically called by the collect method of an FS::cust_main object. The -following fields are currently supported:

trancode - 77 for charges
-: -
cardnum
-: -
exp - card expiration
-: -
amount
-: -
invnum - invoice
-: -
custnum - customer
-: -
payname - name on card
-: -
first - name
-: -
last - name
-: -
address1
-: -
address2
-: -
city
-: -
state
-: -
zip
-: -
country
-: -

METHODS

new HASHREF
-

-Creates a new record. To add the record to the database, see insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -

delete
-

-Delete this record from the database. If there is an error, returns the error, -otherwise returns false. -

replace OLD_RECORD
-

-#inactive -# -#Replaces the OLD_RECORD with this one in the database. If there is an error, -#returns the error, otherwise returns false. -

check
-

-Checks all fields to make sure this is a valid transaction. If there is -an error, returns the error, otherwise returns false. Called by the insert -and repalce methods. -

VERSION

$Id: cust_pay_batch.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

There should probably be a configuration file with a list of allowed credit -card types.

NAME

FS::cust_pkg - Object methods for cust_pkg objects

SYNOPSIS

-  use FS::cust_pkg;

-  $record = new FS::cust_pkg \%hash;
-  $record = new FS::cust_pkg { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $error = $record->cancel;

-  $error = $record->suspend;

-  $error = $record->unsuspend;

-  $part_pkg = $record->part_pkg;

-  @labels = $record->labels;

-  $error = FS::cust_pkg::order( $custnum, \@pkgparts );
-  $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );

DESCRIPTION

An FS::cust_pkg object represents a customer billing item. FS::cust_pkg -inherits from FS::Record. The following fields are currently supported:

pkgnum - primary key (assigned automatically for new billing items)
-: -
custnum - Customer (see the FS::cust_main manpage)
-: -
pkgpart - Billing item definition (see the FS::part_pkg manpage)
-: -
setup - date
-: -
bill - date
-: -
susp - date
-: -
expire - date
-: -
cancel - date
-: -
otaker - order taker (assigned automatically if null, see the FS::UID manpage)
-: -

Note: setup, bill, susp, expire and cancel are specified as UNIX timestamps; -see perlfunc/``time''. Also see the Time::Local manpage and the Date::Parse manpage for -conversion functions.

METHODS

new HASHREF
-

-Create a new billing item. To add the item to the database, see insert. -

insert
-

-Adds this billing item to the database (``Orders'' the item). If there is an -error, returns the error, otherwise returns false. -

sub insert { - my $self = shift;

-  # custnum might not have have been defined in sub check (for one-shot new
-  # customers), so check it here instead

-  my $error = $self->ut_number('custnum');
-  return $error if $error

-  return "Unknown customer"
-    unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );

-  $self->SUPER::insert;

}

delete
-

-Currently unimplemented. You don't want to delete billing items, because there -would then be no record the customer ever purchased the item. Instead, see -the cancel method. -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

Currently, custnum, setup, bill, susp, expire, and cancel may be changed.

Changing pkgpart may have disasterous effects. See the order subroutine.

setup and bill are normally updated by calling the bill method of a customer -object (see the FS::cust_main manpage).

suspend is normally updated by the suspend and unsuspend methods.

cancel is normally updated by the cancel method (and also the order subroutine -in some cases).

check
-

-Checks all fields to make sure this is a valid billing item. If there is an -error, returns the error, otherwise returns false. Called by the insert and -replace methods. -

cancel
-

-Cancels and removes all services (see the FS::cust_svc manpage and the FS::part_svc manpage) -in this package, then cancels the package itself (sets the cancel field to -now). -

If there is an error, returns the error, otherwise returns false.

suspend
-

-Suspends all services (see the FS::cust_svc manpage and the FS::part_svc manpage) in this -package, then suspends the package itself (sets the susp field to now). -

If there is an error, returns the error, otherwise returns false.

unsuspend
-

-Unsuspends all services (see the FS::cust_svc manpage and the FS::part_svc manpage) in this -package, then unsuspends the package itself (clears the susp field). -

If there is an error, returns the error, otherwise returns false.

part_pkg
-

-Returns the definition for this billing item, as an FS::part_pkg object (see -the FS::part_pkg manpage). -

labels
-

-Returns a list of lists, calling the label method for all services -(see the FS::cust_svc manpage) of this billing item. -

SUBROUTINES

order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF ]
-

-CUSTNUM is a customer (see the FS::cust_main manpage) -

PKGPARTS is a list of pkgparts specifying the the billing item definitions (see -the FS::part_pkg manpage) to order for this customer. Duplicates are of course -permitted.

REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to -remove for this customer. The services (see the FS::cust_svc manpage) are moved to the -new billing items. An error is returned if this is not possible (see -the FS::pkg_svc manpage).

VERSION

$Id: cust_pkg.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?

In sub order, the @pkgparts array (passed by reference) is clobbered.

Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard -method to pass dates to the recur_prog expression, it should do so.

FS::svc_acct, FS::svc_acct_sm, and FS::svc_domain are loaded via 'use' at -compile time, rather than via 'require' in sub { setup, suspend, unsuspend, -cancel } because they use %FS::UID::callback to load configuration values. -Probably need a subroutine which decides what to do based on whether or not -we've fetched the user yet, rather than a hash. See FS::UID and the TODO.

NAME

FS::cust_refund - Object method for cust_refund objects

SYNOPSIS

-  use FS::cust_refund;

-  $record = new FS::cust_refund \%hash;
-  $record = new FS::cust_refund { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::cust_refund represents a refund: the transfer of money to a customer; -equivalent to a negative payment (see the FS::cust_pay manpage). FS::cust_refund -inherits from FS::Record. The following fields are currently supported:

refundnum - primary key (assigned automatically for new refunds)
-: -
crednum - Credit (see the FS::cust_credit manpage)
-: -
refund - Amount of the refund
-: -
_date - specified as a UNIX timestamp; see perlfunc/``time''. Also see -the Time::Local manpage and the Date::Parse manpage for conversion functions.
-: -
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
-: -
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
-: -
otaker - order taker (assigned automatically, see the FS::UID manpage)
-: -

METHODS

new HASHREF
-: -Creates a new refund. To add the refund to the database, see insert. -
-
insert
-: -Adds this refund to the database, and updates the credit (see -the FS::cust_credit manpage). -
-
delete
-: -Currently unimplemented (accounting reasons). -
-
replace OLD_RECORD
-: -Currently unimplemented (accounting reasons). -
-
check
-: -Checks all fields to make sure this is a valid refund. If there is an error, -returns the error, otherwise returns false. Called by the insert method. -

VERSION

$Id: cust_refund.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

Delete and replace methods.

NAME

FS::cust_svc - Object method for cust_svc objects

SYNOPSIS

-  use FS::cust_svc;

-  $record = new FS::cust_svc \%hash
-  $record = new FS::cust_svc { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  ($label, $value) = $record->label;

DESCRIPTION

An FS::cust_svc represents a service. FS::cust_svc inherits from FS::Record. -The following fields are currently supported:

svcnum - primary key (assigned automatically for new services)
-: -
pkgnum - Package (see the FS::cust_pkg manpage)
-: -
svcpart - Service definition (see the FS::part_svc manpage)
-: -

METHODS

new HASHREF
-

-Creates a new service. To add the refund to the database, see insert. -Services are normally created by creating FS::svc_ objects (see -the FS::svc_acct manpage, the FS::svc_domain manpage, and the FS::svc_acct_sm manpage, among others). -

insert
-

-Adds this service to the database. If there is an error, returns the error, -otherwise returns false. -

delete
-

-Deletes this service from the database. If there is an error, returns the -error, otherwise returns false. -

Called by the cancel method of the package (see the FS::cust_pkg manpage).

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

check
-

-Checks all fields to make sure this is a valid service. If there is an error, -returns the error, otehrwise returns false. Called by the insert and -replace methods. -

label
-

-Returns a list consisting of: -- The name of this service (from part_svc) -- A meaningful identifier (username, domain, or mail alias) -- The table name (i.e. svc_domain) for this service -

VERSION

$Id: cust_svc.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

Behaviour of changing the svcpart of cust_svc records is undefined and should -possibly be prohibited, and pkg_svc records are not checked.

pkg_svc records are not checked in general (here).

Deleting this record doesn't check or delete the svc_* record associated -with this record.

NAME

-FS::dbdef - Database objects - -

SYNOPSIS

  use FS::dbdef;
-

  $dbdef = new FS::dbdef (@dbdef_table_objects);
-  $dbdef = load FS::dbdef "filename";
-

  $dbdef->save("filename");
-

  $dbdef->addtable($dbdef_table_object);
-

  @table_names = $dbdef->tables;
-

  $FS_dbdef_table_object = $dbdef->table;
-

DESCRIPTION

-FS::dbdef objects are collections of FS::dbdef_table objects and represnt a -database (a collection of tables). - -

METHODS

new TABLE, TABLE, ...

-Creates a new FS::dbdef object - -

load FILENAME

-Loads an FS::dbdef object from a file. - -

save FILENAME

-Saves an FS::dbdef object to a file. - -

addtable TABLE

-Adds this FS::dbdef_table object. - -

tables

-Returns the names of all tables. - -

table TABLENAME

-Returns the named FS::dbdef_table object. - -

BUGS

-Each FS::dbdef object should have a name which corresponds to its name -within the SQL database engine. - -

NAME

-FS::dbdef_colgroup - Column group objects - -

SYNOPSIS

  use FS::dbdef_colgroup;
-

  $colgroup = new FS::dbdef_colgroup ( $lol );
-  $colgroup = new FS::dbdef_colgroup (
-    [
-      [ 'single_column' ],
-      [ 'multiple_columns', 'another_column', ],
-    ]
-  );
-

  @sql_lists = $colgroup->sql_list;
-

  @singles = $colgroup->singles;
-

DESCRIPTION

-FS::dbdef_colgroup objects represent sets of sets of columns. - -

METHODS

new: -
-Creates a new FS::dbdef_colgroup object. - -
sql_list: -
-Returns a flat list of comma-separated values, for SQL statements. - -
singles: -
-Returns a flat list of all single item lists. - -

BUGS

NAME

-FS::dbdef_column - Column object - -

SYNOPSIS

  use FS::dbdef_column;
-

  $column_object = new FS::dbdef_column ( $name, $sql_type, '' );
-  $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL' );
-  $column_object = new FS::dbdef_column ( $name, $sql_type, '', $length );
-  $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL', $length );
-

  $name = $column_object->name;
-  $column_object->name ( 'name' );
-

  $name = $column_object->type;
-  $column_object->name ( 'sql_type' );
-

  $name = $column_object->null;
-  $column_object->name ( 'NOT NULL' );
-

  $name = $column_object->length;
-  $column_object->name ( $length );
-

  $sql_line = $column->line;
-  $sql_line = $column->line $datasrc;
-

DESCRIPTION

-FS::dbdef::column objects represend columns in tables (see FS::dbdef_table). - -

METHODS

new

-Creates a new FS::dbdef_column object. - -

name

-Returns or sets the column name. - -

type

-Returns or sets the column type. - -

null

-Returns or sets the column null flag. - -

type

-Returns or sets the column length. - -

line [ $datasrc ]

-Returns an SQL column definition. - -

-If passed a DBI $datasrc specifying DBD::mysql or DBD::Pg, will use engine-specific syntax. - -

BUGS

VERSION

-$Id: dbdef_column.html,v 1.2 2000-03-03 18:22:43 ivan Exp $ - - - - diff --git a/htdocs/docs/man/FS/dbdef_index.html b/htdocs/docs/man/FS/dbdef_index.html deleted file mode 100644 index 9d0d12a76..000000000 --- a/htdocs/docs/man/FS/dbdef_index.html +++ /dev/null @@ -1,58 +0,0 @@ - - -FS::dbdef_unique.pm - Index object - - - - - - - -

NAME -
SYNOPSIS -
DESCRIPTION -
BUGS -
SEE ALSO -

- - -

NAME

-FS::dbdef_unique.pm - Index object - -

SYNOPSIS

  use FS::dbdef_index;
-

    # see FS::dbdef_colgroup methods
-

DESCRIPTION

-FS::dbdef_unique objects represent the (non-unique) indices of a table (FS::dbdef_table). FS::dbdef_unique inherits from FS::dbdef_colgroup. - -

BUGS

-Is this empty subclass needed? - -

NAME

-FS::dbdef_table - Table objects - -

SYNOPSIS

  use FS::dbdef_table;
-

  $dbdef_table = new FS::dbdef_table (
-    "table_name",
-    "primary_key",
-    $FS_dbdef_unique_object,
-    $FS_dbdef_index_object,
-    @FS_dbdef_column_objects,
-  );
-

  $dbdef_table->addcolumn ( $FS_dbdef_column_object );
-

  $table_name = $dbdef_table->name;
-  $dbdef_table->name ("table_name");
-

  $table_name = $dbdef_table->primary_keye;
-  $dbdef_table->primary_key ("primary_key");
-

  $FS_dbdef_unique_object = $dbdef_table->unique;
-  $dbdef_table->unique ( $FS_dbdef_unique_object );
-

  $FS_dbdef_index_object = $dbdef_table->index;
-  $dbdef_table->index ( $FS_dbdef_index_object );
-

  @column_names = $dbdef->columns;
-

  $FS_dbdef_column_object = $dbdef->column;
-

  @sql_statements = $dbdef->sql_create_table;
-  @sql_statements = $dbdef->sql_create_table $datasrc;
-

DESCRIPTION

-FS::dbdef_table objects represent a single database table. - -

METHODS

new

-Creates a new FS::dbdef_table object. - -

addcolumn

-Adds this FS::dbdef_column object. - -

name

-Returns or sets the table name. - -

primary_key

-Returns or sets the primary key. - -

unique

-Returns or sets the FS::dbdef_unique object. - -

index

-Returns or sets the FS::dbdef_index object. - -

columns

-Returns a list consisting of the names of all columns. - -

column "column"

-Returns the column object (see FS::dbdef_column) for ``column''. - -

sql_create_table [ $datasrc ]

-Returns an array of SQL statments to create this table. - -

-If passed a DBI $datasrc specifying DBD::mysql, will use MySQL-specific syntax. Non-standard syntax for other engines (if -applicable) may also be supported in the future. - -

BUGS

VERSION

-$Id: dbdef_table.html,v 1.2 2000-03-03 18:22:43 ivan Exp $ - - - - diff --git a/htdocs/docs/man/FS/dbdef_unique.html b/htdocs/docs/man/FS/dbdef_unique.html deleted file mode 100644 index 201f3aa61..000000000 --- a/htdocs/docs/man/FS/dbdef_unique.html +++ /dev/null @@ -1,58 +0,0 @@ - - -FS::dbdef_unique.pm - Unique object - - - - - - - -

NAME -
SYNOPSIS -
DESCRIPTION -
BUGS -
SEE ALSO -

- - -

NAME

-FS::dbdef_unique.pm - Unique object - -

SYNOPSIS

  use FS::dbdef_unique;
-

  # see FS::dbdef_colgroup methods
-

DESCRIPTION

-FS::dbdef_unique objects represent the unique indices of a database table (FS::dbdef_table). FS::dbdef_unique inherits from FS::dbdef_colgroup. - -

BUGS

-Is this empty subclass needed? - -

NAME

FS::domain_record - Object methods for domain_record records

SYNOPSIS

-  use FS::domain_record;

-  $record = new FS::domain_record \%hash;
-  $record = new FS::domain_record { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::domain_record object represents an entry in a DNS zone. -FS::domain_record inherits from FS::Record. The following fields are currently -supported:

recnum - primary key
-: -
svcnum - Domain (see the FS::svc_domain manpage) of this entry
-: -
reczone - partial (or full) zone for this entry
-: -
recaf - address family for this entry, currently only `IN' is recognized.
-: -
rectype - record type for this entry (A, MX, etc.)
-: -
recdata - data for this entry
-: -

METHODS

new HASHREF
-

-Creates a new entry. To add the example to the database, see insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -

delete
-

-Delete this record from the database. -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

check
-

-Checks all fields to make sure this is a valid example. If there is -an error, returns the error, otherwise returns false. Called by the insert -and replace methods. -

VERSION

$Id: domain_record.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

BUGS

The data validation doesn't check everything it could. In particular, -there is no protection against bad data that passes the regex, duplicate -SOA records, forgetting the trailing `.', impossible IP addersses, etc. Of -course, it's still better than editing the zone files directly. :)

HISTORY

$Log: domain_record.html,v $ -

Revision 1.1 2001-04-23 12:41:57 ivan -

new API documentation -

-Revision 1.1 2000/02/03 05:16:52 ivan -beginning of DNS and Apache support

- - - - diff --git a/htdocs/docs/man/FS/nas.html b/htdocs/docs/man/FS/nas.html deleted file mode 100644 index db704c777..000000000 --- a/htdocs/docs/man/FS/nas.html +++ /dev/null @@ -1,117 +0,0 @@ - - -FS::nas - Object methods for nas records - - - - - - - - -

NAME
SYNOPSIS
DESCRIPTION
METHODS
VERSION
BUGS
SEE ALSO

- - -

NAME

FS::nas - Object methods for nas records

SYNOPSIS

-  use FS::nas;

-  $record = new FS::nas \%hash;
-  $record = new FS::nas {
-    'nasnum'  => 1,
-    'nasip'   => '10.4.20.23',
-    'nasfqdn' => 'box1.brc.nv.us.example.net',
-  };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $error = $record->heartbeat($timestamp);

DESCRIPTION

An FS::nas object represents an Network Access Server on your network, such as -a terminal server or equivalent. FS::nas inherits from FS::Record. The -following fields are currently supported:

nasnum - primary key
-: -
nas - NAS name
-: -
nasip - NAS ip address
-: -
nasfqdn - NAS fully-qualified domain name
-: -
last - timestamp indicating the last instant the NAS was in a known - state (used by the session monitoring).
-: -

METHODS

new HASHREF
-

-Creates a new NAS. To add the NAS to the database, see insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -

delete
-

-Delete this record from the database. -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

check
-

-Checks all fields to make sure this is a valid example. If there is -an error, returns the error, otherwise returns false. Called by the insert -and replace methods. -

heartbeat TIMESTAMP
-

-Updates the timestamp for this nas -

VERSION

$Id: nas.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

BUGS

NAME

FS::part_pkg - Object methods for part_pkg objects

SYNOPSIS

-  use FS::part_pkg;

-  $record = new FS::part_pkg \%hash
-  $record = new FS::part_pkg { 'column' => 'value' };

-  $custom_record = $template_record->clone;

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  @pkg_svc = $record->pkg_svc;

-  $svcnum = $record->svcpart;
-  $svcnum = $record->svcpart( 'svc_acct' );

DESCRIPTION

An FS::part_pkg object represents a billing item definition. FS::part_pkg -inherits from FS::Record. The following fields are currently supported:

pkgpart - primary key (assigned automatically for new billing item definitions)
-: -
pkg - Text name of this billing item definition (customer-viewable)
-: -
comment - Text name of this billing item definition (non-customer-viewable)
-: -
setup - Setup fee
-: -
freq - Frequency of recurring fee
-: -
recur - Recurring fee
-: -

setup and recur are evaluated as Safe perl expressions. You can use numbers -just as you would normally. More advanced semantics are not yet defined.

METHODS

new HASHREF
-: -Creates a new billing item definition. To add the billing item definition to -the database, see insert. -
-
clone
-: -An alternate constructor. Creates a new billing item definition by duplicating -an existing definition. A new pkgpart is assigned and `(CUSTOM) ' is prepended -to the comment field. To add the billing item definition to the database, see -insert. -
-
insert
-: -Adds this billing item definition to the database. If there is an error, -returns the error, otherwise returns false. -
-
delete
-: -Currently unimplemented. -
-
replace OLD_RECORD
-: -Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid billing item definition. If -there is an error, returns the error, otherwise returns false. Called by the -insert and replace methods. -
-
pkg_svc
-: -Returns all FS::pkg_svc objects (see the FS::pkg_svc manpage) for this package -definition (with non-zero quantity). -
-
svcpart [ SVCDB ]
-: -Returns the svcpart of a single service definition (see the FS::part_svc manpage) -associated with this billing item definition (see the FS::pkg_svc manpage). Returns -false if there not exactly one service definition with quantity 1, or if -SVCDB is specified and does not match the svcdb of the service definition, -

VERSION

$Id: part_pkg.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

The delete method is unimplemented.

setup and recur semantics are not yet defined (and are implemented in -FS::cust_bill. hmm.).

NAME

FS::part_referral - Object methods for part_referral objects

SYNOPSIS

-  use FS::part_referral;

-  $record = new FS::part_referral \%hash
-  $record = new FS::part_referral { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::part_referral represents a referral - where a customer heard of your -services. This can be used to track the effectiveness of a particular piece of -advertising, for example. FS::part_referral inherits from FS::Record. The -following fields are currently supported:

refnum - primary key (assigned automatically for new referrals)
-: -
referral - Text name of this referral
-: -

METHODS

new HASHREF
-: -Creates a new referral. To add the referral to the database, see insert. -
-
insert
-: -Adds this referral to the database. If there is an error, returns the error, -otherwise returns false. -
-
delete
-: -Currently unimplemented. -
-
replace OLD_RECORD
-: -Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid referral. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -

VERSION

$Id: part_referral.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

The delete method is unimplemented.

NAME

FS::part_svc - Object methods for part_svc objects

SYNOPSIS

-  use FS::part_svc;

-  $record = new FS::part_referral \%hash
-  $record = new FS::part_referral { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::part_svc represents a service definition. FS::part_svc inherits from -FS::Record. The following fields are currently supported:

svcpart - primary key (assigned automatically for new service definitions)
-: -
svc - text name of this service definition
-: -
svcdb - table used for this service. See the FS::svc_acct manpage, -the FS::svc_domain manpage, and the FS::svc_acct_sm manpage, among others.
-: -
svcdb__field - Default or fixed value for field in svcdb. -: -
svcdb__field_flag - defines svcdb__field action: null, `D' for default, or `F' for fixed -: -

METHODS

new HASHREF
-: -Creates a new service definition. To add the service definition to the -database, see insert. -
-
insert
-: -Adds this service definition to the database. If there is an error, returns -the error, otherwise returns false. -
-
delete
-: -Currently unimplemented. -
-
replace OLD_RECORD
-: -Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid service definition. If there is -an error, returns the error, otherwise returns false. Called by the insert -and replace methods. -

VERSION

$Id: part_svc.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

Delete is unimplemented.

The list of svc_* tables is hardcoded. When svc_acct_pop is renamed, this -should be fixed.

NAME

FS::pkg_svc - Object methods for pkg_svc records

SYNOPSIS

-  use FS::pkg_svc;

-  $record = new FS::pkg_svc \%hash;
-  $record = new FS::pkg_svc { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $part_pkg = $record->part_pkg;

-  $part_svc = $record->part_svc;

DESCRIPTION

An FS::pkg_svc record links a billing item definition (see the FS::part_pkg manpage) to -a service definition (see the FS::part_svc manpage). FS::pkg_svc inherits from -FS::Record. The following fields are currently supported:

pkgpart - Billing item definition (see the FS::part_pkg manpage)
-: -
svcpart - Service definition (see the FS::part_svc manpage)
-: -
quantity - Quantity of this service definition that this billing item -definition includes
-: -

METHODS

new HASHREF
-: -Create a new record. To add the record to the database, see insert. -
-
insert
-: -Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -
-
delete
-: -Deletes this record from the database. If there is an error, returns the -error, otherwise returns false. -
-
replace OLD_RECORD
-: -Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid record. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -
-
part_pkg
-: -Returns the FS::part_pkg object (see the FS::part_pkg manpage). -
-
part_svc
-: -Returns the FS::part_svc object (see the FS::part_svc manpage). -

VERSION

$Id: pkg_svc.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

NAME

FS::port - Object methods for port records

SYNOPSIS

-  use FS::port;

-  $record = new FS::port \%hash;
-  $record = new FS::port { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $session = $port->session;

DESCRIPTION

An FS::port object represents an individual port on a NAS. FS::port inherits -from FS::Record. The following fields are currently supported:

portnum - primary key
-: -
ip - IP address of this port
-: -
nasport - port number on the NAS
-: -
nasnum - NAS this port is on - see the FS::nas manpage
-: -

METHODS

new HASHREF
-

-Creates a new port. To add the example to the database, see insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -

delete
-

-Delete this record from the database. -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

check
-

-Checks all fields to make sure this is a valid example. If there is -an error, returns the error, otherwise returns false. Called by the insert -and replace methods. -

session
-

-Returns the currently open session on this port, or if no session is currently -open, the most recent session. See the FS::session manpage. -

VERSION

$Id: port.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

BUGS

The author forgot to customize this manpage.

The session method won't deal well if you have multiple open sessions on a -port, for example if your RADIUS server drops stop records. Suggestions for -how to deal with this sort of lossage welcome; should we close the session -when we get a new session on that port? Tag it as invalid somehow? Close it -one second after it was opened? *sigh* Maybe FS::session shouldn't let you -create overlapping sessions, at least folks will find out their logging is -dropping records.

If you think the above refers multiple user logins you need to read the -manpages again.

NAME

FS::prepay_credit - Object methods for prepay_credit records

SYNOPSIS

-  use FS::prepay_credit;

-  $record = new FS::prepay_credit \%hash;
-  $record = new FS::prepay_credit {
-    'identifier' => '4198123455512121'
-    'amount'     => '19.95',
-  };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::table_name object represents an pre--paid credit, such as a pre-paid -``calling card''. FS::prepay_credit inherits from FS::Record. The following -fields are currently supported:

field - description
-: -
identifier - identifier entered by the user to receive the credit
-: -
amount - amount of the credit
-: -

METHODS

new HASHREF
-

-Creates a new pre-paid credit. To add the example to the database, see -insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -

delete
-

-Delete this record from the database. -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

check
-

-Checks all fields to make sure this is a valid pre-paid credit. If there is -an error, returns the error, otherwise returns false. Called by the insert -and replace methods. -

VERSION

$Id: prepay_credit.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

BUGS

HISTORY

$Log: prepay_credit.html,v $ -

Revision 1.1 2001-04-23 12:41:57 ivan -

new API documentation -

-Revision 1.2 2000/02/02 20:22:18 ivan -bugfix prepayment in signup server

Revision 1.1 2000/01/31 05:22:23 ivan -prepaid ``internet cards''

- - - - diff --git a/htdocs/docs/man/FS/session.html b/htdocs/docs/man/FS/session.html deleted file mode 100644 index c714337be..000000000 --- a/htdocs/docs/man/FS/session.html +++ /dev/null @@ -1,129 +0,0 @@ - - -FS::session - Object methods for session records - - - - - - - - -

NAME
SYNOPSIS
DESCRIPTION
METHODS
VERSION
BUGS
SEE ALSO

- - -

NAME

FS::session - Object methods for session records

SYNOPSIS

-  use FS::session;

-  $record = new FS::session \%hash;
-  $record = new FS::session {
-    'portnum' => 1,
-    'svcnum'  => 2,
-    'login'   => $timestamp,
-    'logout'  => $timestamp,
-  };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $error = $record->nas_heartbeat($timestamp);

DESCRIPTION

An FS::session object represents an user login session. FS::session inherits -from FS::Record. The following fields are currently supported:

sessionnum - primary key
-: -
portnum - NAS port for this session - see the FS::port manpage
-: -
svcnum - User for this session - see the FS::svc_acct manpage
-: -
login - timestamp indicating the beginning of this user session.
-: -
logout - timestamp indicating the end of this user session. May be null, - which indicates a currently open session.
-: -

METHODS

new HASHREF
-

-Creates a new session. To add the session to the database, see insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. If the `login' field is empty, it is replaced with -the current time. -

delete
-

-Delete this record from the database. -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. If the `logout' field is empty, -it is replaced with the current time. -

check
-

-Checks all fields to make sure this is a valid session. If there is -an error, returns the error, otherwise returns false. Called by the insert -and replace methods. -

nas_heartbeat
-

-Heartbeats the nas associated with this session (see the FS::nas manpage). -

svc_acct
-

-Returns the svc_acct record associated with this session (see the FS::svc_acct manpage). -

VERSION

$Id: session.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

BUGS

Maybe you shouldn't be able to insert a session if there's currently an open -session on that port. Or maybe the open session on that port should be flagged -as problematic? autoclosed? *sigh*

Hmm, sessions refer to current svc_acct records... probably need to constrain -deletions to svc_acct records such that no svc_acct records are deleted which -have a session (even if long-closed).

NAME

FS::svc_Common - Object method for all svc_ records

SYNOPSIS

use FS::svc_Common;

@ISA = qw( FS::svc_Common );

DESCRIPTION

FS::svc_Common is intended as a base class for table-specific classes to -inherit from, i.e. FS::svc_acct. FS::svc_Common inherits from FS::Record.

METHODS

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -

The additional fields pkgnum and svcpart (see the FS::cust_svc manpage) should be -defined. An FS::cust_svc record will be created and inserted.

delete
-

-Deletes this account from the database. If there is an error, returns the -error, otherwise returns false. -

The corresponding FS::cust_svc record will be deleted as well.

setfixed
-

-Sets any fixed fields for this service (see the FS::part_svc manpage). If there is an -error, returns the error, otherwise returns the FS::part_svc object (use ref() -to test the return). Usually called by the check method. -

setdefault
-

-Sets all fields to their defaults (see the FS::part_svc manpage), overriding their -current values. If there is an error, returns the error, otherwise returns -the FS::part_svc object (use ref() to test the return). -

suspend
-

unsuspend
-

cancel
-

-Stubs - return false (no error) so derived classes don't need to define these -methods. Called by the cancel method of FS::cust_pkg (see the FS::cust_pkg manpage). -

VERSION

$Id: svc_Common.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

The setfixed method return value.

The new method should set defaults from part_svc (like the check method -sets fixed values)?

NAME

FS::svc_acct - Object methods for svc_acct records

SYNOPSIS

-  use FS::svc_acct;

-  $record = new FS::svc_acct \%hash;
-  $record = new FS::svc_acct { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $error = $record->suspend;

-  $error = $record->unsuspend;

-  $error = $record->cancel;

-  %hash = $record->radius;

DESCRIPTION

An FS::svc_acct object represents an account. FS::svc_acct inherits from -FS::svc_Common. The following fields are currently supported:

svcnum - primary key (assigned automatcially for new accounts)
-: -
username
-: -
_password - generated if blank
-: -
popnum - Point of presence (see the FS::svc_acct_pop manpage)
-: -
uid
-: -
gid
-: -
finger - GECOS
-: -
dir - set automatically if blank (and uid is not)
-: -
shell
-: -
quota - (unimplementd)
-: -
slipip - IP address
-: -
radius_Radius_Attribute - Radius-Attribute -: -

METHODS

new HASHREF
-

-Creates a new account. To add the account to the database, see insert. -

insert
-

-Adds this account to the database. If there is an error, returns the error, -otherwise returns false. -

The additional fields pkgnum and svcpart (see the FS::cust_svc manpage) should be -defined. An FS::cust_svc record will be created and inserted.

If the configuration value (see the FS::Conf manpage) shellmachine exists, and the -username, uid, and dir fields are defined, the command(s) specified in -the shellmachine-useradd configuration are exectued on shellmachine via ssh. -This behaviour can be surpressed by setting $FS::svc_acct::nossh_hack true. -If the shellmachine-useradd configuration file does not exist,

-  useradd -d $dir -m -s $shell -u $uid $username

is the default. If the shellmachine-useradd configuration file exists but -it empty,

-  cp -pr /etc/skel $dir; chown -R $uid.$gid $dir

is the default instead. Otherwise the contents of the file are treated as -a double-quoted perl string, with the following variables available: -$username, $uid, $gid, $dir, and $shell.

delete
-

-Deletes this account from the database. If there is an error, returns the -error, otherwise returns false. -

The corresponding FS::cust_svc record will be deleted as well.

If the configuration value (see the FS::Conf manpage) shellmachine exists, the -command(s) specified in the shellmachine-userdel configuration file are -executed on shellmachine via ssh. This behavior can be surpressed by setting -$FS::svc_acct::nossh_hack true. If the shellmachine-userdel configuration -file does not exist,

-  userdel $username

is the default. If the shellmachine-userdel configuration file exists but -is empty,

-  rm -rf $dir

is the default instead. Otherwise the contents of the file are treated as a -double-quoted perl string, with the following variables available: -$username and $dir.

replace OLD_RECORD
-

-Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

If the configuration value (see the FS::Conf manpage) shellmachine exists, and the -dir field has changed, the command(s) specified in the shellmachine-usermod -configuraiton file are executed on shellmachine via ssh. This behavior can -be surpressed by setting $FS::svc-acct::nossh_hack true. If the -shellmachine-userdel configuration file does not exist or is empty, :

-  [ -d $old_dir ] && 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
-  )

is executed on shellmachine via ssh. This behaviour can be surpressed by -setting $FS::svc_acct::nossh_hack true.

suspend
-

-Suspends this account by prefixing *SUSPENDED* to the password. If there is an -error, returns the error, otherwise returns false. -

Called by the suspend method of FS::cust_pkg (see the FS::cust_pkg manpage).

unsuspend
-

-Unsuspends this account by removing *SUSPENDED* from the password. If there is -an error, returns the error, otherwise returns false. -

Called by the unsuspend method of FS::cust_pkg (see the FS::cust_pkg manpage).

cancel
-

-Just returns false (no error) for now. -

Called by the cancel method of FS::cust_pkg (see the FS::cust_pkg manpage).

check
-

-Checks all fields to make sure this is a valid service. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -

Sets any fixed values; see the FS::part_svc manpage.

radius
-

-Depriciated, use radius_reply instead. -

radius_reply
-

-Returns key/value pairs, suitable for assigning to a hash, for any RADIUS -reply attributes of this record. -

Note that this is now the preferred method for reading RADIUS attributes - -accessing the columns directly is discouraged, as the column names are -expected to change in the future.

radius_check
-

-Returns key/value pairs, suitable for assigning to a hash, for any RADIUS -check attributes of this record. -

Accessing RADIUS attributes directly is not supported and will break in the -future.

VERSION

$Id: svc_acct.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

The bits which ssh should fork before doing so (or maybe queue jobs for a -daemon).

The $recref stuff in sub check should be cleaned up.

The suspend, unsuspend and cancel methods update the database, but not the -current object. This is probably a bug as it's unexpected and -counterintuitive.

NAME

FS::svc_acct_pop - Object methods for svc_acct_pop records

SYNOPSIS

-  use FS::svc_acct_pop;

-  $record = new FS::svc_acct_pop \%hash;
-  $record = new FS::svc_acct_pop { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::svc_acct object represents an point of presence. FS::svc_acct_pop -inherits from FS::Record. The following fields are currently supported:

popnum - primary key (assigned automatically for new accounts)
-: -
city
-: -
state
-: -
ac - area code
-: -
exch - exchange
-: -
loc - rest of number
-: -

METHODS

new HASHREF
-: -Creates a new point of presence (if only it were that easy!). To add the -point of presence to the database, see insert. -
-
insert
-: -Adds this point of presence to the database. If there is an error, returns the -error, otherwise returns false. -
-
delete
-: -Removes this point of presence from the database. -
-
replace OLD_RECORD
-: -Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid point of presence. If there is -an error, returns the error, otherwise returns false. Called by the insert -and replace methods. -

VERSION

$Id: svc_acct_pop.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

It should be renamed to part_pop.

NAME

FS::svc_acct_sm - Object methods for svc_acct_sm records

SYNOPSIS

-  use FS::svc_acct_sm;

-  $record = new FS::svc_acct_sm \%hash;
-  $record = new FS::svc_acct_sm { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $error = $record->suspend;

-  $error = $record->unsuspend;

-  $error = $record->cancel;

DESCRIPTION

An FS::svc_acct object represents a virtual mail alias. FS::svc_acct inherits -from FS::Record. The following fields are currently supported:

svcnum - primary key (assigned automatcially for new accounts)
-: -
domsvc - svcnum of the virtual domain (see the FS::svc_domain manpage)
-: -
domuid - uid of the target account (see the FS::svc_acct manpage)
-: -
domuser - virtual username
-: -

METHODS

new HASHREF
-

-Creates a new virtual mail alias. To add the virtual mail alias to the -database, see insert. -

insert
-

-Adds this virtual mail alias to the database. If there is an error, returns -the error, otherwise returns false. -

The additional fields pkgnum and svcpart (see the FS::cust_svc manpage) should be -defined. An FS::cust_svc record will be created and inserted.

If the configuration values (see the FS::Conf manpage) shellmachine and qmailmachines -exist, and domuser is `*' (meaning a catch-all mailbox), the command:

-  [ -e $dir/.qmail-$qdomain-default ] || {
-    touch $dir/.qmail-$qdomain-default;
-    chown $uid:$gid $dir/.qmail-$qdomain-default;
-  }

is executed on shellmachine via ssh (see dot-qmail/``EXTENSION ADDRESSES''). -This behaviour can be surpressed by setting $FS::svc_acct_sm::nossh_hack true.

delete
-

-Deletes this virtual mail alias from the database. If there is an error, -returns the error, otherwise returns false. -

The corresponding FS::cust_svc record will be deleted as well.

replace OLD_RECORD
-

-Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

suspend
-

-Just returns false (no error) for now. -

Called by the suspend method of FS::cust_pkg (see the FS::cust_pkg manpage).

unsuspend
-

-Just returns false (no error) for now. -

Called by the unsuspend method of FS::cust_pkg (see the FS::cust_pkg manpage).

cancel
-

-Just returns false (no error) for now. -

Called by the cancel method of FS::cust_pkg (see the FS::cust_pkg manpage).

check
-

-Checks all fields to make sure this is a valid virtual mail alias. If there is -an error, returns the error, otherwise returns false. Called by the insert and -replace methods. -

Sets any fixed values; see the FS::part_svc manpage.

VERSION

$Id: svc_acct_sm.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

The remote commands should be configurable.

The $recref stuff in sub check should be cleaned up.

NAME

FS::svc_domain - Object methods for svc_domain records

SYNOPSIS

-  use FS::svc_domain;

-  $record = new FS::svc_domain \%hash;
-  $record = new FS::svc_domain { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $error = $record->suspend;

-  $error = $record->unsuspend;

-  $error = $record->cancel;

DESCRIPTION

An FS::svc_domain object represents a domain. FS::svc_domain inherits from -FS::svc_Common. The following fields are currently supported:

svcnum - primary key (assigned automatically for new accounts)
-: -
domain
-: -

METHODS

new HASHREF
-

-Creates a new domain. To add the domain to the database, see insert. -

insert
-

-Adds this domain to the database. If there is an error, returns the error, -otherwise returns false. -

The additional fields pkgnum and svcpart (see the FS::cust_svc manpage) should be -defined. An FS::cust_svc record will be created and inserted.

The additional field action should be set to N for new domains or M -for transfers.

A registration or transfer email will be submitted unless -$FS::svc_domain::whois_hack is true.

The additional field email can be used to manually set the admin contact -email address on this email. Otherwise, the svc_acct records for this package -(see the FS::cust_pkg manpage) are searched. If there is exactly one svc_acct record -in the same package, it is automatically used. Otherwise an error is returned.

If any soamachine configuration file exists, an SOA record is added to -the domain_record table (see <FS::domain_record>).

If any machines are defined in the nsmachines configuration file, NS -records are added to the domain_record table (see the FS::domain_record manpage).

If any machines are defined in the mxmachines configuration file, MX -records are added to the domain_record table (see the FS::domain_record manpage).

Any problems adding FS::domain_record records will emit warnings, but will -not return errors from this method. If your configuration files are correct -you shouln't have any problems.

delete
-

-Deletes this domain from the database. If there is an error, returns the -error, otherwise returns false. -

The corresponding FS::cust_svc record will be deleted as well.

replace OLD_RECORD
-

-Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

suspend
-

-Just returns false (no error) for now. -

Called by the suspend method of FS::cust_pkg (see the FS::cust_pkg manpage).

unsuspend
-

-Just returns false (no error) for now. -

Called by the unsuspend method of FS::cust_pkg (see the FS::cust_pkg manpage).

cancel
-

-Just returns false (no error) for now. -

Called by the cancel method of FS::cust_pkg (see the FS::cust_pkg manpage).

check
-

-Checks all fields to make sure this is a valid domain. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -

Sets any fixed values; see the FS::part_svc manpage.

whois
-

-Returns the Net::Whois::Domain object (see the Net::Whois manpage) for this domain, or -undef if the domain is not found in whois. -

(If $FS::svc_domain::whois_hack is true, returns that in all cases instead.)

_whois
-

-Depriciated. -

submit_internic
-

-Submits a registration email for this domain. -

VERSION

$Id: svc_domain.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

All BIND/DNS fields should be included (and exported).

Delete doesn't send a registration template.

All registries should be supported.

Should change action to a real field.

The $recref stuff in sub check should be cleaned up.

NAME

FS::svc_www - Object methods for svc_www records

SYNOPSIS

-  use FS::svc_www;

-  $record = new FS::svc_www \%hash;
-  $record = new FS::svc_www { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  $error = $record->suspend;

-  $error = $record->unsuspend;

-  $error = $record->cancel;

DESCRIPTION

An FS::svc_www object represents an web virtual host. FS::svc_www inherits -from FS::svc_Common. The following fields are currently supported:

svcnum - primary key
-: -
recnum - DNS `A' record corresponding to this web virtual host. (see the FS::domain_record manpage)
-: -
usersvc - account (see the FS::svc_acct manpage) corresponding to this web virtual host.
-: -

METHODS

new HASHREF
-

-Creates a new web virtual host. To add the record to the database, see -insert. -

Note that this stores the hash reference, not a distinct copy of the hash it -points to. You can ask the object for a copy with the hash method.

insert
-

-Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -

The additional fields pkgnum and svcpart (see the FS::cust_svc manpage) should be -defined. An FS::cust_svc record will be created and inserted.

If the configuration values (see the FS::Conf manpage) apachemachine, and -apacheroot exist, the command:

-  mkdir $apacheroot/$zone;
-  chown $username $apacheroot/$zone;
-  ln -s $apacheroot/$zone $homedir/$zone

$zone is the DNS A record pointed to by recnum -$username is the username pointed to by usersvc -$homedir is that user's home directory

is executed on apachemachine via ssh. This behaviour can be surpressed by -setting $FS::svc_www::nossh_hack true.

delete
-

-Delete this record from the database. -

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

suspend
-

-Called by the suspend method of FS::cust_pkg (see the FS::cust_pkg manpage). -

unsuspend
-

-Called by the unsuspend method of FS::cust_pkg (see the FS::cust_pkg manpage). -

cancel
-

-Called by the cancel method of FS::cust_pkg (see the FS::cust_pkg manpage). -

check
-

-Checks all fields to make sure this is a valid example. If there is -an error, returns the error, otherwise returns false. Called by the insert -and repalce methods. -

VERSION

$Id: svc_www.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

BUGS

HISTORY

$Log: svc_www.html,v $ -

Revision 1.1 2001-04-23 12:41:57 ivan -

new API documentation -

-Revision 1.4 2001/04/22 01:56:15 ivan -get rid of FS::SSH.pm (became Net::SSH and Net::SCP on CPAN)

Revision 1.3 2000/11/22 23:30:51 ivan -tyop

Revision 1.2 2000/03/01 08:13:59 ivan -compilation bugfixes

Revision 1.1 2000/02/03 05:16:52 ivan -beginning of DNS and Apache support

- - - - diff --git a/htdocs/docs/man/FS/type_pkgs.html b/htdocs/docs/man/FS/type_pkgs.html deleted file mode 100644 index 30b052b81..000000000 --- a/htdocs/docs/man/FS/type_pkgs.html +++ /dev/null @@ -1,100 +0,0 @@ - - -FS::type_pkgs - Object methods for type_pkgs records - - - - - - - - -

NAME
SYNOPSIS
DESCRIPTION
METHODS
VERSION
BUGS
SEE ALSO

- - -

NAME

FS::type_pkgs - Object methods for type_pkgs records

SYNOPSIS

-  use FS::type_pkgs;

-  $record = new FS::type_pkgs \%hash;
-  $record = new FS::type_pkgs { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::type_pkgs record links an agent type (see the FS::agent_type manpage) to a -billing item definition (see the FS::part_pkg manpage). FS::type_pkgs inherits from -FS::Record. The following fields are currently supported:

typenum - Agent type, see the FS::agent_type manpage
-: -
pkgpart - Billing item definition, see the FS::part_pkg manpage
-: -

METHODS

new HASHREF
-: -Create a new record. To add the record to the database, see insert. -
-
insert
-: -Adds this record to the database. If there is an error, returns the error, -otherwise returns false. -
-
delete
-: -Deletes this record from the database. If there is an error, returns the -error, otherwise returns false. -
-
replace OLD_RECORD
-: -Replaces OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -
-
check
-: -Checks all fields to make sure this is a valid record. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. -

VERSION

$Id: type_pkgs.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

fs_passwd

-You may use fs_passwd/fs_passwd as a "passwd", "chfn" and "chsh" replacement on your shell machine(s) to cause password, gecos and shell changes to update your freeside machine. This can pose a security risk if not configured correctly. Do not use this feature unless you understand what you are doing! -

Currently it is assumed that the the crypt(3) function in the C library is the same on the Freeside machine as on the target machine. -

Create a freeside account on the shell machine(s). -
Append the identity.pub from the freeside user on your freeside machine to the authorized_keys file of the newly created freeside user on the shell machine(s). -
Copy fs_passwd/fs_passwd to /usr/local/bin on the shell machine(s). (chown freeside, chmod 4755). You may link it to passwd, chfn and chsh as well. -
Copy fs_passwd/fs_passwdd to /usr/local/sbin on the shell machine(s). (chown freeside, chmod 500) -
Create /usr/local/freeside on the shell machine(s). (chown freeside, chmod 700) -
Run an iteration of "fs_passwd/fs_passwd_server shell.machine" as the freeside user for each shell machine (this is a daemon process). -

- diff --git a/htdocs/docs/postgresql.html b/htdocs/docs/postgresql.html deleted file mode 100755 index 151081176..000000000 --- a/htdocs/docs/postgresql.html +++ /dev/null @@ -1,23 +0,0 @@ - - PostgreSQL notes - - -

PostgreSQL notes

-PostgreSQL ships by default with a maximum of 31 character column names. If -you use arbitrary RADIUS attributes longer than 9 characters, fs-setup will -fail with `duplicate column' errors (in the part_svc table). -Solution: use a different database -engine, or recompile PostgreSQL with 64 character column names. -

-Future versions of Freeside will keep all column names under 31 characters to -avoid this problem. -

-( I've personally been unable to get PostgreSQL working with larger column names, -though the process does look like it should be straightforward. If anyone is -interested in assisting me with this, please get in touch. - -Ivan <ivan@sisd.com> ) -

- - diff --git a/htdocs/docs/schema.html b/htdocs/docs/schema.html deleted file mode 100644 index a61000f1f..000000000 --- a/htdocs/docs/schema.html +++ /dev/null @@ -1,264 +0,0 @@ - - Schema reference - - -

Schema reference

agent - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type). -
- agentnum - primary key -
- agent - name of this agent -
- typenum - agent type -
- prog - (unimplemented) -
- freq - (unimplemented) -
-
agent_type - Agent types define groups of packages that you can then assign to particular agents. -
- typenum - primary key -
- atype - name of this agent type -
-
cust_bill - Invoices. Declarations that a customer owes you money. The specific charges are itemized in cust_bill_pkg. -
- invnum - primary key -
- custnum - customer -
- _date -
- charged - amount of this invoice -
- printed - how many times this invoice has been printed automatically -
-
cust_bill_pkg - Invoice line items -
- invnum - (multiple) key -
- pkgnum - package or 0 for the special virtual sales tax package -
- setup - setup fee -
- recur - recurring fee -
- sdate - starting date -
- edate - ending date -
-
cust_credit - Credits. The equivalent of a negative cust_bill record. -
- crednum - primary key -
- custnum - customer -
- amount - amount credited -
- _date -
- otaker - order taker -
- reason -
-
cust_main - Customers -
- custnum - primary key -
- agentnum - agent -
- refnum - referral -
- titlenum - title -
- first - name -
- middle - name -
- last - name -
- ss - social security number -
- company -
- address1 -
- address2 -
- city -
- county -
- state -
- zip -
- country -
- daytime - phone -
- night - phone -
- fax - phone -
- payby - CARD, BILL, or COMP -
- payinfo - card number, P.O.#, or comp issuer -
- paydate - expiration date -
- payname - billing name (name on card) -
- tax - tax exempt, Y or null -
- otaker - order taker -
-
cust_main_invoice - Invoice destinations for email invoices. Note that a customer can have many email destinations for their invoice (either literal or via svcnum), but only one postal destination. -
- destnum - primary key -
- custnum - customer -
- dest - Invoice destination. Freeside supports three types of invoice delivery: send directly to a service defined in Freeside, send to an arbitrary email address, or print the invoice to a printer and have someone send it out via snail mail. Freeside determines which method to use based on the contents of the dest field. If the contents are numeric, a svcnum pointing to a valid service is expected in the field. If the contents are a string, a literal email address is expected to be in the field. If the special keyword `POST' is present, the snail mail method is used (which is the default if no cust_main_invoice records exist). Snail mail invoices get their address information from cust_main and are printed with the printer defined in the configuration files. -
-
cust_main_county - Tax rates -
- taxnum - primary key -
- state -
- county -
- country -
- tax - % rate -
-
cust_pay - Payments. Money being transferred from a customer. -
- paynum - primary key -
- invnum - invoice -
- paid - amount -
- _date -
- payby - CARD, BILL, or COMP -
- payinfo - card number, P.O.#, or comp issuer -
- paybatch - text field for tracking card processor batches -
-
cust_pay_batch - Pending batch -
- trancode - 77 for charges -
- cardnum -
- exp - card expiration -
- amount -
- invnum - invoice -
- custnum - customer -
- payname - name on card -
- first - name -
- last - name -
- address1 -
- address2 -
- city -
- state -
- zip -
- country -
-
cust_pkg - Customer billing items -
- pkgnum - primary key -
- custnum - customer -
- pkgpart - Package definition -
- setup - date -
- bill - next bill date -
- susp - (past) suspension date -
- expire - (future) cancellation date -
- cancel - (past) cancellation date -
- otaker - order taker -
-
cust_refund - Refunds. The transfer of money to a customer; equivalent to a negative cust_pay record. -
- refundnum - primary key -
- crednum - credit -
- refund - amount -
- _date -
- payby - CARD, BILL or COMP -
- payinfo - card number, P.O.#, or comp issuer -
- otaker - order taker -
-
cust_svc - Customer services -
- svcnum - primary key -
- pkgnum - package -
- svcpart - Service definition -
-
nas - Network Access Server (terminal server) -
- nasnum - primary key -
- nas - NAS name -
- nasip - NAS ip address -
- nasfqdn - NAS fully-qualified domain name -
- last - timestamp indicating the last instant the NAS was in a known state (used by the session monitoring). -
-
part_pkg - Package definitions -
- pkgpart - primary key -
- pkg - package name -
- comment - non-customer visable package comment -
- setup - setup fee -
- freq - recurring frequency (months) -
- recur - recurring fee -
-
part_referral - Referral listing -
- refnum - primary key -
- referral - referral -
-
part_svc - Service definitions -
- svcpart - primary key -
- svc - name of this service -
- svcdb - table used for this service: svc_acct, svc_acct_sm, svc_domain, svc_charge or svc_wo -
- table__field - Default or fixed value for field in table -
- table__field_flag - null, D or F -
-
part_title - Personal titles -
- titlenum - primary key -
- title - personal title (`Dr.' or `Mr.') -
-
pkg_svc -
- pkgpart - Package definition -
- svcpart - Service definition -
- quantity - quantity of this service that this package includes -
-
port - individual port on a nas -
- portnum - primary key -
- ip - IP address of this port -
- nasport - port number on the NAS -
- nasnum - NAS -
-
prepay_credit -
- prepaynum - primary key -
- identifier - text or numeric string used to receive this credit -
- amount - amount of credit -
-
session -
- sessionnum - primary key -
- portnum - Port -
- svcnum - Account -
- login - timestamp indicating the beginning of this user session. -
- logout - timestamp indicating the end of this user session. May be null, which indicates a currently open session. -
- -
svc_acct - Accounts -
- svcnum - primary key -
- username -
- _password -
- popnum - Point of Presence -
- uid -
- gid -
- finger - GECOS -
- dir -
- shell -
- quota - (unimplementd) -
- slipip - IP address -
- radius_Radius_Attribute - Radius-Attribute -
-
svc_acct_pop - Points of Presence -
- popnum - primary key -
- city -
- state -
- ac - area code -
- exch - exchange -
- loc - rest of number -
-
svc_acct_sm - Domain mail aliases -
- svcnum - primary key -
- domsvc - Domain (by svcnum) -
- domuid - Account (by uid) -
- domuser - domuser @ Domain forwards to Account -
-
svc_domain - Domains -
- svcnum - primary key -
- domain -
-
domain_record - Domain zone detail -
- recnum - primary key -
- svcnum - Domain (by svcnum) -
- reczone - zone for this line -
- recaf - address family, usually IN -
- rectype - type for this record (A, MX, etc.) -
- recdata - data for this record -
-
svc_www -
- svcnum - primary key -
- recnum - host -
- usersvc - account -
-
type_pkgs -
- typenum - agent type -
- pkgpart - Package definition -
-

- diff --git a/htdocs/docs/session.html b/htdocs/docs/session.html deleted file mode 100644 index 7dac5fdf7..000000000 --- a/htdocs/docs/session.html +++ /dev/null @@ -1,54 +0,0 @@ - - Session monitor - - -

Session monitor

Installation

-For security reasons, the client portion of the session montior may run on one -or more external public machine(s). On these machines, install: -

Perl (at l -east 5.004_05 for the 5.004 series or 5.005_03 for the 5.005 series. Don't enable experimental features like threads or the PerlIO abstraction layer.) -
FS::SessionClient (copy the fs_session/FS-SessionClient directory to the external machine, then: perl Makefile.PL; make; make install) -

-Then: -

Add the user `freeside' to the the external machine. -
Create the /usr/local/freeside directory on the external machine (owned by the freeside user). -
touch /usr/local/freeside/fs_sessiond_socket; chown freeside /usr/local/freeside/fs_sessiond_socket; chmod 600 /usr/local/freeside/fs_sessiond_socket -
Append the identity.pub from the freeside user on your freeside machine to the authorized_keys file of the newly created freeside user on the external machine(s). -
Run
```
fs_session_server user machine
```
on the Freeside machine. -
- user is a user from the mapsecrets file. -
- machine is the name of the external machine. -
-

Usage

Web -
- Copy FS-SessionClient/cgi/login.cgi and logout.cgi to your web - server's document space. -
- Use suEXEC or setuid (see install.html for details) to run login.cgi and logout.cgi as the freeside user. -
-
Command-line -
```
freeside-login username ( portnum | ip | nasnum nasport )
-freeside-logout username ( portnum | ip | nasnum nasport )
```
-
- username is a customer username from the svc_acct table -
- portnum, ip or nasport and nasnum uniquely identify a port in the port database table. -
-
RADIUS -
- Configure your RADIUS server's login and logout callbacks to use the command-line freeside-login and freeside-logout utilites. -
-

Callbacks

Sesstion start - The command(s) specified in the session-start configuration file are executed on the Freeside machine. The contents of the file are treated as a double-quoted perl string, with the following variables available: $ip, $nasip and $nasfqdn, 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. -
Session end - The command(s) specified in the session-stop configuration file are executed on the Freeside machine. The contents of the file are treated as a double-quoted perl string, with the following variables available: $ip, $nasip and $nasfqdn, 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. -

Dropping expired users

-Run

bin/freeside-session-kill username

periodically from cron. - - diff --git a/htdocs/docs/signup.html b/htdocs/docs/signup.html deleted file mode 100644 index a40b1f963..000000000 --- a/htdocs/docs/signup.html +++ /dev/null @@ -1,57 +0,0 @@ - - Signup server - - -

Signup server

-For security reasons, the signup server should run on an external public -webserver. On this machine, install: -

A web server, such as Apache-SSL or Apache -
SSH -
Perl (at least 5.004_05 for the 5.004 series or 5.005_03 for the 5.005 series. Don't enable experimental features like threads or the PerlIO abstraction layer.) -
Text::Template -
HTTP::Headers::UserAgent (version 2.0 or higher; not yet indexed correctly on CPAN) - -
FS::SignupClient (copy the fs_signup/FS-SignupClient directory to the external machine, then: perl Makefile.PL; make; make install) -

-Then: -

Add the user `freeside' to the the external machine. -
Copy or symlink fs_signup/FS-SignupClient/cgi/signup.cgi into the web server's document space. -
Enable CGI execution for files with the `.cgi' extension. (with Apache) -
Create the /usr/local/freeside directory on the external machine (owned by the freeside user). -
touch /usr/local/freeside/fs_signupd_socket; chown freeside /usr/local/freeside/fs_signupd_socket; chmod 600 /usr/local/freeside/fs_signupd_socket -
Use suEXEC or setuid (see install.html for details) to run signup.cgi as the freeside user. -
Append the identity.pub from the freeside user on your freeside machine to the authorized_keys file of the newly created freeside user on the external machine(s). -
Run
```
fs_signup_server user machine agentnum refnum
```
on the Freeside machine. -
- user is a user from the mapsecrets file. -
- machine is the name of the external machine. -
- agentnum and refnum are the agent and referral, respectively, to use for customers who sign up via this signup server. -
-

-Optional: -

If you create a /usr/local/freeside/ieak.template file on the external machine, it will be sent to IE users with MIME type application/x-Internet-signup. This file will be processed with Text::Template with the following variables available: -
- $ac - area code of selected POP -
- $exch - exchange of selected POP -
- $loc - local part of selected POP -
- $username -
- $password -
- $email_name - first and last name -
- (an example file is included as fs_signup/ieak.template) -
If you create a /usr/local/freeside/cck.template file on the external machine, the variables defined will be sent to Netscape users with MIME type application/x-netscape-autoconfigure-dialer-v2. This file will be processed with Text::Template with the following variables available: -
- $ac - area code of selected POP -
- $exch - exchange of selected POP -
- $loc - local part of selected POP -
- $username -
- $password -
- $email_name - first and last name -
- (an example file is included as fs_signup/cck.template). See the Netscape documentation for more information. -
If there are any entries in the prepay_credit table, a user can enter a string matching the identifier column to receive the credit specified in the amount column, and/or the time specified in the seconds column (for use with the session monitor), after which that identifier is no longer valid. This can be used to implement pre-paid "calling card" type signups. The bin/generate-prepay script can be used to populate the prepay_credit table. -

- diff --git a/htdocs/docs/trouble.html b/htdocs/docs/trouble.html deleted file mode 100644 index fce743928..000000000 --- a/htdocs/docs/trouble.html +++ /dev/null @@ -1,26 +0,0 @@ - - Troubleshooting - - -
Troubleshooting
-
-
When troubleshooting the web interface, helpful information is often in your web server's error log. -
If bin/svc_acct.import fails with an "Out of memory!" error using MySQL, upgrede MySQL and recompile the Perl DBD. There was a memory leak in some older versions of MySQL. -
If you get tons of errors in your web server's error log like this: -
-Ambiguous use of value => resolved to "value" => -at /usr/lib/perl5/site_perl/File/CounterFile.pm line 132. -
- This clutters up your log files but is otherwise harmless. Upgrade to the latest File::CounterFile. -
If you get errors like this: -
-UID.pm: Can't open /var/spool/freeside/conf/secrets: Permission denied -at /your/path/site_perl/FS/UID.pm line 26. -BEGIN failed--compilation aborted at -/your/path/edit/process/part_svc.cgi line 15. -
- Then the scripts are not running as the freeside freeside user. See -the New Installation section of the documentation. -
If you receive `can not connect to server' errors using MySQL on a system that doesn't support native threading, you may need to specify the full hostname in your DBI datasource. See the MySQL documentation, DBI manpage and the DBD::mysql manpage for details. -
- diff --git a/htdocs/docs/upgrade.html b/htdocs/docs/upgrade.html deleted file mode 100644 index d2201f601..000000000 --- a/htdocs/docs/upgrade.html +++ /dev/null @@ -1,24 +0,0 @@ - - Upgrading to 1.1.x - - -
Upgrading to 1.1.x
-
-
Back up your data and current Freeside installation. -
Unpack a copy of the 1.0.0 distribution in a separate location. -
Diff your current installation against the 1.0.0 distribution. -
Apply all the diffs you found above, if applicable. -
Apply (at least) the following changes to your database: -
-ALTER TABLE cust_main CHANGE ss ss char(11) NULL; -ALTER TABLE cust_main CHANGE day daytime varchar(20) NULL; -ALTER TABLE svc_acct CHANGE password _password varchar(25) NOT NULL; -ALTER TABLE part_svc CHANGE svc_acct__password svc_acct___password varchar(25) NULL; -ALTER TABLE part_svc CHANGE svc_acct__password_flag svc_acct___password_flag char(1) NULL; -ALTER TABLE agent_type CHANGE type atype varchar(80) NOT NULL; -
-
Optionally change the field lengths and types to match a 1.1.x install; see `bin/fs-setup'. -
Create the necessary configuration files, -
Copy or symlink htdocs and site_perl to the new 1.1.x copies. -
Run bin/dbdef-create. This file uses MySQL-specific syntax. If you are running a different database engine you will need to modify it slightly. - diff --git a/htdocs/docs/upgrade2.html b/htdocs/docs/upgrade2.html deleted file mode 100644 index 7acae48f7..000000000 --- a/htdocs/docs/upgrade2.html +++ /dev/null @@ -1,11 +0,0 @@ - - Upgrading to 1.1.4 - - -
Upgrading to 1.1.4 from 1.1.x
-
-
If migrating from 1.0.0, see these instructions first. -
Back up your data and current Freeside installation. -
If applicable, create the new configuration files: lpr, cybercash2, cybercash3.2 -
Copy or symlink htdocs and site_perl to the new copies. - diff --git a/htdocs/docs/upgrade3.html b/htdocs/docs/upgrade3.html deleted file mode 100644 index 0837e0207..000000000 --- a/htdocs/docs/upgrade3.html +++ /dev/null @@ -1,40 +0,0 @@ - - Upgrading to 1.2.x - - -
Upgrading to 1.2.x from 1.1.x
-
-
If migrating from 1.0.0, see these instructions first. -
If migrating from less than 1.1.4, see these instructions first. -
Back up your data and current Freeside installation. -
Install the Perl module String-Approx -
Configuration file location has changed! -
Move /var/spool/freeside/dbdef.datasrc to /usr/local/etc/freeside/dbdef.datasrc. -
Move /var/spool/freeside/counters to /usr/local/etc/freeside/counters.datasrc. -
Move /var/spool/freeside/export to /usr/local/etc/freeside/export.datasrc. -
Apply the following changes to your database: -
-ALTER TABLE cust_main CHANGE state state varchar(80) NULL; -ALTER TABLE cust_main_county CHANGE state state varchar(80) NULL; -ALTER TABLE cust_main_county ADD country char(2); -ALTER TABLE cust_main CHANGE paydate paydate varchar(10); -UPDATE cust_main SET country = "US" where country IS NULL OR country = ''; -UPDATE cust_main_county SET country = "US" where country IS NULL OR country = ""; -CREATE TABLE cust_main_invoice ( - destnum int NOT NULL, - custnum int NOT NULL, - dest varchar(80) NOT NULL, - PRIMARY KEY (destnum), - INDEX ( custnum ) -); -
-
Run bin/dbdef-create. This file uses MySQL-specific syntax. If you are running a different database engine you will need to modify it slightly. -
Copy or symlink htdocs and site_perl to the new copies. - diff --git a/htdocs/docs/upgrade4.html b/htdocs/docs/upgrade4.html deleted file mode 100644 index 1d70f8b73..000000000 --- a/htdocs/docs/upgrade4.html +++ /dev/null @@ -1,27 +0,0 @@ - - Upgrading to 1.2.2 - - -
Upgrading to 1.2.2 from 1.2.x
-
-
If migrating from 1.0.0, see these instructions first. -
If migrating from less than 1.1.4, see these instructions first. -
If migrating from less than 1.2.0, see these instructions first. -
Back up your data and current Freeside installation. -
Install the Perl modules Locale-Codes and Net-Whois. -
Apply the following changes to your database: -
-ALTER TABLE cust_pay_batch CHANGE exp exp VARCHAR(11); -
-
Copy or symlink htdocs to the new copy. -
Remove the symlink or directory (your_site_perl_directory)/FS. -
Change to the FS directory in the new tarball, and build and install the - Perl modules: -
-$ cd FS/ -$ perl Makefile.PL -$ make -$ su -# make install
-
Run bin/dbdef-create. This file uses MySQL-specific syntax. If you are running a different database engine you will need to modify it slightly. - diff --git a/htdocs/docs/upgrade5.html b/htdocs/docs/upgrade5.html deleted file mode 100644 index 3f3431653..000000000 --- a/htdocs/docs/upgrade5.html +++ /dev/null @@ -1,34 +0,0 @@ - - Upgrading to 1.3.0 - - -
Upgrading to 1.2.3 from 1.2.2
-
-
If migrating from 1.0.0, see these instructions first. -
If migrating from less than 1.1.4, see these instructions first. -
If migrating from less than 1.2.0, see these instructions first. -
If migrating from less than 1.2.2, see these instructions first. -
Back up your data and current Freeside installation. -
Apply the following changes to your database: -
-ALTER TABLE svc_acct_pop ADD loc CHAR(4); -CREATE TABLE prepay_credit ( - prepaynum int NOT NULL, - identifier varchar(80) NOT NULL, - amount decimal(10,2) NOT NULL, - PRIMARY KEY (prepaynum), - INDEX (identifier) -); -
-
Copy or symlink htdocs to the new copy. -
Remove the symlink or directory (your_site_perl_directory)/FS. -
Change to the FS directory in the new tarball, and build and install the - Perl modules: -
-$ cd FS/ -$ perl Makefile.PL -$ make -$ su -# make install
-
Run bin/dbdef-create. This file uses MySQL-specific syntax. If you are running a different database engine you will need to modify it slightly. - diff --git a/htdocs/docs/upgrade6.html b/htdocs/docs/upgrade6.html deleted file mode 100644 index dc82975f3..000000000 --- a/htdocs/docs/upgrade6.html +++ /dev/null @@ -1,66 +0,0 @@ - - Upgrading to 1.3.0 - - -
Upgrading to 1.3.0 from 1.2.3
-
-
If migrating from 1.0.0, see these instructions first. -
If migrating from less than 1.1.4, see these instructions first. -
If migrating from less than 1.2.0, see these instructions first. -
If migrating from less than 1.2.2, see these instructions first. -
If migrating from less than 1.2.3, see these instructions first. -
Back up your data and current Freeside installation. -
As 1.3.0 requires transactions, MySQL's default MyISAM and ISAM table types are no longer supported. Converting to PostgreSQL is recommended. If you really want to use MySQL, convert your tables to one of the transaction-safe table types such as BDB. -
Copy the invoice_template file from the conf/ directory in the distribution to your configuration directory. -
Install the Text-Template, DBIx-DBSchema, Net-SSH, String-ShellQuote and Net-SCP Perl modules. -
Apply the following changes to your database: -
-CREATE TABLE domain_record ( - recnum int NOT NULL, - svcnum int NOT NULL, - reczone varchar(80) NOT NULL, - recaf char(2) NOT NULL, - rectype char(5) NOT NULL, - recdata varchar(80) NOT NULL, - PRIMARY KEY (recnum) -); -CREATE TABLE svc_www ( - svcnum int NOT NULL, - recnum int NOT NULL, - usersvc int NOT NULL, - PRIMARY KEY (svcnum) -); -ALTER TABLE part_svc ADD svc_www__recnum varchar(80) NULL; -ALTER TABLE part_svc ADD svc_www__recnum_flag char(1) NULL; -ALTER TABLE part_svc ADD svc_www__usersvc varchar(80) NULL; -ALTER TABLE part_svc ADD svc_www__uesrsvc_flag char(1) NULL; -ALTER TABLE svc_acct CHANGE _password _password varchar(50) NULL; -ALTER TABLE svc_acct ADD seconds integer NULL; -ALTER TABLE part_svc ADD svc_acct__seconds integer NULL; -ALTER TABLE part_svc ADD svc_acct__seconds_flag char(1) NULL; -ALTER TABLE prepay_credit ADD seconds integer NULL; - -
-
If your database supports dropping columns: -
-ALTER TABLE cust_bill DROP owed; -ALTER TABLE cust_credit DROP credited; -
- Or, if your database does not support dropping columns, you can do this: -
-ALTER TABLE cust_bill CHANGE owed depriciated decimal(10,2); -ALTER TABLE cust_credit CHANGE credited depriciated2 decimal(10,2); -
- -
Copy or symlink htdocs to the new copy. -
Remove the symlink or directory (your_site_perl_directory)/FS. -
Change to the FS directory in the new tarball, and build and install the - Perl modules: -
-$ cd FS/ -$ perl Makefile.PL -$ make -$ su -# make install
-
Run bin/dbdef-create. - diff --git a/htdocs/docs/upgrade7.html b/htdocs/docs/upgrade7.html deleted file mode 100644 index d9dcfe2ae..000000000 --- a/htdocs/docs/upgrade7.html +++ /dev/null @@ -1,24 +0,0 @@ - - Upgrading to 1.3.1 - - -
Upgrading to 1.3.1 from 1.3.0
-
-
If migrating from 1.0.0, see these instructions first. -
If migrating from less than 1.1.4, see these instructions first. -
If migrating from less than 1.2.0, see these instructions first. -
If migrating from less than 1.2.2, see these instructions first. -
If migrating from less than 1.2.3, see these instructions first. -
If migrating from less than 1.3.0, see these instructions first. -
Back up your data and current Freeside installation. -
Copy or symlink htdocs to the new copy. -
Change to the FS directory in the new tarball, and build and install the - Perl modules: -
-$ cd FS/ -$ perl Makefile.PL -$ make -$ su -# make install UNINST=1
-
Run bin/dbdef-create. - -- cgit v1.2.1