1 $Id: TODO,v 1.9 1998-10-13 09:17:20 ivan Exp $
3 If you are interested in helping with any of these, please join the mailing
4 list (send a blank message to ivan-freeside-subscribe@sisd.com) to avoid
9 svc_acct.import should recognize "UNIX" in the RADIUS password file as null.
11 radius logfile parsing and perl expression check.
13 mailing list archive, faq
15 (test cust_main.pm with cybercash v2 and v3)
17 Fix in cust_bill BUGS:
18 There is an off-by-one error in print_text which causes a visual error (Page 1
19 of 2 printed on some single-page invoices).
21 FIX It doesn't properly inherit/override FS::Record yet, so no more replace vs
24 fields should be a method against a FS::Record or derived object, as well as
25 being something you can call as FS::Record::fields('tablename'). Might
26 even be able to handle both in the same routine (that would be neato).
27 Get rid of hfields and other assorted silliness.
28 Clean up hfields/sfields/fields crap. yuck.
30 $lpr in cust_main.pm (from Bill.pm) should become /var/spool/freeside/conf/lpr
32 Override FS::Record new, add, rep and del (create, insert, replace and
33 delete) in all derived classes.
34 IE create, insert, delete and replace from derived classes should override new,
35 add, del and rep (respectively) from FS::Record. Depriciate old names.
37 Allow a cancelled/suspended/active status from packages to bubble up to
38 the customer lists. Put active, then suspended, then cancelled accounts.
39 Similar ordering on the package listing inside a single customer.
41 Add the ability for services to filter information up to the package level
42 for invoices and web screens, so you can select a particlar package based
43 on username or domain name, etc.
45 You can't delete the stuff under administration yet. Add this,
46 _including_ making sure the thing you are deleting is not in use!
48 Immediate removal of incorrectly entered check payments (can't take too
49 long to do this, or accounting is fubared).
51 Add code to move from one service to another (POP to SLIP/PPP, etc.).
52 This _should_ be possible by working off the rules in part_svc rather than
53 hardcoding anything in. The rules in part_svc may need some elaboration,
56 Use ut_ FS::Record methods in all derived classes (possibly some from dbdef?... eventually all from dbdef??? - but then `dbdef-create' would be impossible as there would be metadata we couldn't ask the backend for. hmm.)
58 (bring back from fsold, ) Generalize config-sending stuff and make more configurable.
59 Expand the HylaFAX interface (also possibly generalize for other fax
60 softwar ie .comfaxe); allow things like arbitrary faxes of sales
61 literature, specific troubleshooting documents and so on. Maybe even
62 allow users to do this (though that might not belong in Freeside).
64 misc/process/sendconfig.cgi
65 Configure fax recipients via a separate box rather than using the finger
66 name or first+last from cust_main.
68 move all phone number logic out of Freeside - let HylaFAX or whatever
71 soundex searches for customer name and company? where are free soundex tools? (standard Text::Soundex duh)
73 should be able to link on (username, domain name, some field in email alias) instead of svcnum only. (username done, what else?)
75 (done but clean up) change svc_domain.pm mail sending from a pipe to "/usr/lib/sendmail" to Mail::Mailer or Net::SMTP or something. also is the complete text of the registration agreement needed in there (it used to be)?
77 generalize and make configurable new invoice printing scheme in FS::Bill::collect (past due)
79 deleting an svc_domain should delete all associated svc_acct_sm records.
82 periodic password encrypter
84 Automated, configurable notification, suspension and cancellation of
89 Allow for a future setup date on accounts.
91 one-time/per-customer/? changes in rates and descriptions ('remembered
92 invoices'): implement by creating a new package on the fly... but it isn't
93 associated with any agent types so it won't show up for other customers to buy.
95 if CGI::Base will not have redirect fixed (cgifix.html), should migrate to
96 CGI.pm insetead? It is >1 year newer.
98 library repetitve stuff from Bill.pm Invoice.pm and friends (calculating
99 previous balances etc etc)
102 sub AUTOLOAD in FS::Record should warn? die? if used with a non-existant column
105 edit (not just import, export and allow default/fixed) arbitrary radius stuff
108 edit/svc_acct.cgi and edit/process/svc_acct.cgi should deal with arbitrary radius stuff
110 radius import should take DEFAULT entry and put it in /var/spool/freeside/conf/radius-default ; svc_acct.export should use it (and doc)
112 FS::Invoice and FS::Bill should merge with the classes they're derived from
114 in UI, s/State/State\/Provence/go and s/County/County\/Locality/go
116 .us domains and others!
118 what else (besides l10n) for i18n?
120 audit htdocs/* for things that should be libraried and things that should be
121 new methods on the objects (need to do this before implementing a new UI)
122 all the big things are done
124 some places we die() where we should &FS::CGI::idiot (and perhaps vice-versa).
125 Decide based on whether or not the "error" should show up in logs.
127 all .cgi's should use standard header/footer and idiot() subroutines. maybe HTML:: perl modules
128 for HTML creation. CGI.pm instead.
130 library the conf reading stuff; bin/svc_acct.export version with missing-filename checking is good
131 library conf stuff -> check all the conf stuff to make sure they close filehandles.
133 When running bin/bill, Fix this (Annoying but harmless):
134 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 99, <ADDRESS> chunk 4.
135 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 102, <ADDRESS> chunk 4.
136 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 105, <ADDRESS> chunk 4.
138 all cgi (but internal to the isp) places where package names are listed should also have
139 comment (like agent_type)
141 clean up $recref and other silliness and use -> calls where possible, or
142 one other alternative. clean up everything else.
143 should FS::Record use Tie::Hash? That would be very clean, but where do we
144 store the other information? Maybe you could ask any FS::Record object for a
147 change all htdocs/edit/process/* loops to look like: (library this sort of thing!!!!)
149 my($new) = create FS::svc_acct_sm ( {
151 ($_, scalar($req->param($_)));
152 } qw(svcnum pkgnum svcpart domuser domuid domsvc)
155 to avoid form errors causing too much silliness
157 add this code to all svc_*.pm (already in acct and acct_sm and domain): (library!)
161 my($svcnum)=$self->getfield('svcnum');
163 my($cust_svc)=qsearchs('cust_svc',{'svcnum'=>$svcnum});
164 return "Unknown svcnum" unless $cust_svc;
165 $svcpart=$cust_svc->svcpart;
167 $svcpart=$self->getfield('svcpart');
169 my($part_svc)=qsearchs('part_svc',{'svcpart'=>$svcpart});
170 return "Unkonwn svcpart" unless $part_svc;
172 #set fixed fields from part_svc
174 foreach $field ( fields('svc_acct') ) {
175 if ( $part_svc->getfield('svc_acct__'. $field. '_flag') eq 'F' ) {
176 $self->setfield($field,$part_svc->getfield('svc_acct__'. $field) );
180 change all file access from regular open(FILE,) stuff to OO, because of
181 problems scoping and passing filehandles like that.
183 svc_domain.pm mail sending uses Date::Format which doesn't seem to pick up
186 view/svc_domain.cgi needs to know the domain might be unaudited (cosmetic)
188 --- 1.1.x or 1.2 or later
190 the web interface should create a new object and use it instead of a blank
191 form for new records. the create method of svc_ objects should set defaults
194 sub check in man FS::table_name should be rewriteen. Get rid of $recref
195 stuff. Make sure all fields that refer to other database are checked.
197 Integration with signup disks (are there any free ones? Netscape?).
199 One-button cancel (+refund) for lusers who can't get online.
201 Keep information on virtual web servers (hostname, IP, host machine,
202 directory, etc.) and export this information for importation into the ISPs
205 Remove requirement that the first mail alias be the catchall? Still make
206 sure only one catchall per domain is defined in any case, of course.
208 Ability to move cust_pkg records from one customer to another? (proably
209 will need to cancel the old and create a new like when we move services
212 Auto-increment expired cards one year, and try again?
214 Lay out the forms a bit better.
216 More non-US stuff - zip codes, country codes, foreign currencies, etc.
218 cust_refund.{cgi.pm} need to do cards xaxtions. (now we only have cust_credit)
220 Nicer set of integrated reporting possibilities, like weekly sales totals
221 by customer, package, agent, referral, etc., aging reports sorted by lots
222 of different things, and so on.
224 Client/server setup for users to modify their own passwords, shells, etc,
225 via passwd or secure web interface (prelminary passwd/chfn/chsh
226 replacement done). Complicated by the fact that we don't want to allow
227 incoming connections to the machine running Freeside, so we probably need
228 to have a daemon on each external shell or web machine that is contacted
229 by the Freeside machine. Be very very careful for both traditional
230 security issues and DoS problems.
232 An extension of the above to allow users to modify selected parts of their
233 own information, order and cancel services. A web interface for new
236 Expand domain name stuff to house all domain information. Export
237 named.boot/named.conf (primary and secondary) and named.{domain} files.
238 Add more registries (not just InterNIC's com org net edu)
240 Nice postscript paper invoices, rather than current ASCII invoices.
243 think about race-condititions in FS::Record and derived ->check ->insert
244 and so on, uid and username checks in svc_acct, etc.
246 Move to rsync over ssh file exportation rather than scp.
248 check 'n fix the proactive password checker. (cracklib?)
250 refunds of "BILL" payments: generate pseudo-check.
252 write batch senders and batch parsers for the different credit card processors
254 More CC processors/methods.
256 In FS::Record, the counter dir should have .datasrc appended to it like the
257 dbdef does, which should place all the (most of) the DB metadata in unique
258 files and let me run concurrent .datasrc's. Maybe do something similar for
259 user, password and datasrc itself? (or something to get the out of the source
260 files) and then we're set. (secrets file also needs .datasrc appended, or maybe
261 "/var/spool/freeside".datasrc
263 you should be able to fiddle the setup date in cust_pkg. (at least initially)
265 cych v3 and v2 support
267 delete options in administration section
269 write a generic batch senders and batch parsers.
271 need a way to override svc_acct export on a per-machine basis; just use config files based on machine name i suppose; document that.
273 you should be able to get column types as a method against an FS::Record object
274 as well as dbdef->table($table)->column($column)->type
276 move to perl module for fuzzy and soundex searching.
278 make fs-setup option to add sample data so you can click on "New Customer" right away? so people understand what this stuff is?
280 package view needs to list extraneous services; we need to prevent the
281 creation of them so this never happens (and mark it as such in the source)
282 (the creation problem should be fixed - though they will still happen if people
283 fsck around in the data manually, so list them anyway)
285 add attribute dictionary to fs-setup as a menu, plus analyze users file to
288 Check for and report on duplicate billing accounts (cust_main, though many
289 will have a need for these so probably don't disable them outright.)
291 create a ->warn as well as a ->check method for all FS::table classes?
294 something to automate making a release and updating the web demo
296 export a debian-style (also redhat and?) /etc/group file aswell!
298 seems to be an off-by-one error in the ascii invoice formatting which is saying
299 "1 of 2" pages when there is only one.
301 get rid of agrep? needs the (non-free) glimpse distribution. agrep used to
302 be free? what else can do fuzzy searching?
304 site_perl/svc_domain.cgi (hmm... or maybe should have a button? or maybe svc_domain.pm should handle this) should set $whois_hack for non-internic domains, so you can add them...
306 svc_acct_sm.import qmail import should pull in recipientmap people too.
308 .pm's like svc_acct.pm which need to do time-consuming things like ssh remotely
309 should fork and do them in a child.
311 i18n/l10n: take ALL messages and catalog them in english.txt or in database or something, so we can eventually go int'l. int'l currency support would be a help aswell.
313 get some of { city, county, state, zip } from the missing bits if
314 possible (where can i get the data to do this? usps.gov?)
316 additional interfaces (perltk? java?)
318 Put the GPL notice in all files.
322 one-off package edits! : need a cust_pkgs or cust_part_pkgs or something table,
323 with custnum and partpkg (like type_pkgs)
325 $cust_bill->owed database field to be eliminated, replaced by a method call
326 that calculates on the fly. make sure to grep for ->(get|set)field('owed')
327 same for cust_credit->credited
329 Export quota information.
331 move all configuration to a central place. maybe in blob's in the
332 database. maybe even things like the code to execute when a username is
333 changed can be in there, so less of the distributed scripts change between
336 Implement setup and recurring fees as Safe perl expressions rather than
337 numbers, to allow for variable-rate services. Backwards compatibility is
338 obtained because { 43 } in perl is still 43. :) Define API to pass
339 starting and ending dates and any other necessary data to expression
340 (fees are currently evaluated as Safe expressions but more work needs to
341 be done to define an opmask for various needs, write examples
342 (usage-based billing, etc.) and so on).
344 Add the ability to modify the next billing date in cust_pkg, and take
345 appropriate action. This will allow the implementation of pro-rate/1st of
346 the month billing as well as the ability to manually fiddle with
347 anniversary dates in cust_pkg, so you can sync a customer's anniversary
348 date even if you're using anniversary billing (manually or automatically).
349 (now with above, we need to have a way to automatically pro-rate /^(\d+)$/
350 charges - anything more complicated should figure it out itself given
351 starting and ending dates [document that!])
353 Daily Radius log parsing into database; other logfile formats?
355 Callbacks to enforce hourly limits on accounts (suspend until the end of
356 the billing period?), for those who limit customers rather than tack on
359 Flag packages (part_pkg) as taxable or non/taxable as some ISPs (for
360 example) need to charge tax on equipment but not service (separate flags
361 for setup and recurring fee... or perhaps a setup_tax, setup_notax,
362 recur_tax and recur_notax fees, and possibly something more flexible if
365 Allow for a variable number of invoices for customers who need multiple
368 Add a mail alias service with table svc_acct (not domain mail aliasing
369 which is domain with svc_acct_sm)
371 (bring back from fsold) Change customer comment field from its current kludge to something more
374 Better work orders with more information. Should eventually open a ticket
375 when we have such a thing.
377 edit/process/svc_wo.cgi
378 Call tracking and trouble tickets.
380 use mod_perl and Apache::AuthDBI instead of mod_auth_mysql when we do local
382 More accoutability for complimentary accounts: approval, expiration, term
383 (no more than x months in advance) and notification.
384 Flag particular users (or all users, for that matter) as having their
385 passwords hidden and/or locked from users of Freeside (maybe need Freeside
386 security levels first?).
388 Better Freeside-level configurable access, for those ISP's who have
389 employees they can't trust. Right now you're "stuck" with setting up
390 .htaccess stuff yourself. This should really just be integrated.
392 update site_perl/table_template* (pry out of date)
394 /var/spool/freeside/conf (and whatever else /var/spool/freeside we can)
395 in database (except secrets), then web interface,
396 make /var/spool/freeside a configurable directory (probably as part of
397 some automated installation process?)
399 add a table with column of export services (passwd, shadow, master.passwd, .qmail file update, dns update, etc.) and rows machine groups and whether or not to export that (and any necessary parameters). wasn't matt (vunderkid, not matt@michweb) working on this? find him? each machine goes in a group of its own as well as a group based on function. add a table with only svcpart and machine group. now, when you import from each machine, it can get its own accounts with one svcpart and universal accounts with another svcpart. (though that does make the username duplicate checking more interesting)
401 password and slipip stuff in svc_acct.pm store need to be split into two fields or something, so the silliness in svc_acct.pm and svc_acct.export with looking at the data to decide what to do with it can be fixed (1.2)
403 This requires some serious magic in FS::Record:
404 ok, if date_type in fs-setup is to be something besides int,
405 now we need to create wrappers
406 for them so they behave identically across RDBMS's, ie date pops out as as
407 UNIX timestamp (or an object of some sort? maybe even a blessed $obj which
408 is a string not a hashref for backwards compatibility?) and so on. (remember
409 to treat '0' as Not a Date instead of 1/1/70.
411 Add Freeside-level transactions for RDBMS's which don't support
412 transcations? (Currently we assume a minimal RDBMS which has no rollback,
413 transactions or atomic updates). Or just require a RDBMS that supports
414 rollback and/or atomic updates and get rid of the work-arounds? The /rdb
415 interface had this kludge on top of it but is a technical dead-end in most
416 other ways, unless it can gain an SQL parser and DBD interface.
418 Better automated comparison of our CC records with processors (CyberCash,
419 at least, has not always had 100% accuracy, though recent versions are
422 Expect or other pty based login check, where we actually connect to a
423 terminal server or shell machine and test logging in as the user (if we
424 are keeping a cleartext password for that user) (This is something tech
425 support often needs for new customers)
427 Use cust_main table for pre-sales tracking as well?
429 Automatic commision report and check generation via freq and prog (to
430 become a Safe perl expression) fields in agent table, and possibly others.
432 Database and add a mailed-out date and method for disk/CD mailing, so a
433 customer can call and you can say, "sent on xx/xx/xx via {US Mail, Fedex,
436 Inventory tracking for physical items such as routers (for sale or
437 lease... probably doesn't make a difference in the ordering... but if you
438 cancel a router lease the inventory should come back. hmm.)
440 -- Matt's wishlist ---
442 From matt@michweb.net Fri Feb 20 16:39:53 1998
443 Date: Thu, 19 Feb 1998 23:20:11 -0500
444 From: Matt Simerson <matt@michweb.net>
445 Reply-To: quadran-developer@netgoth.com
446 To: quadran-developer@netgoth.com
447 Subject: Re: Welcome to quadran-developer
449 >Whats it based on and what is it supposed to do? I'm interested, but
450 >unfortunatly, I don't have that much time to help on the project (I'm busily
451 >working on one of my own based around MySQL and Qt right now -- don't know
452 >if it will be GPL'ed or not yet -- we'll probably just use it in house since
453 >it is designed around our system)...
455 That's what I set out to find, but didn't find anything on the web site.
456 I'm looking for something that will do the following:
458 Single point of entry for users on a secure system:
459 Creates account on user (public) systems
460 update /etc/passwd/master.passwd file
461 update radius database (if necessary)
462 Set up up disk quotas (although I hacked adduser to do this)
463 Option for adding user to a mailing list(s)
464 Export of new user info to customizable report (for automated entry
466 accounting software, etc...)
469 Export credit card info for batch processing and have hooks built
470 in for other forms of electronic processing.
471 Batch-Payment (apply payments from formatted text file).
472 Customizable reports for manual entry/importing into Accounting
474 Email or laser print invoices
475 Sanity checks credit card numbers before processing (code available)
477 Simple method for disabling an account.
478 Arbitrary Expiration Dates (on a given day, in x days)
480 Changing password to '*'
481 Virtual customers disabling dns, http server, log processing, etc..
483 Billing for different account types:
484 Dialup monthly flat rate. Prorates for partial months.
485 Dialup monthly flat rate for x hours + hourly usage.
488 Virtual Web accounts - w/multiple mailboxes
490 Disk space used over quota.
491 Tech support minimum + hourly charges
492 Other for misc stuff (modem, RAM, etc...)
494 Per user definable RADIUS attributes (ties in with above)
497 IP filters (for dialup email only)
499 Keep logs of modem usage generated daily from radius accounting logs stored
500 on multiple radius servers.
502 Keep logs of disk usage generated from quota.
504 Method of adding virtual domains to your system:
505 Automatically grabs an IP address from a preassigned pool.
506 Creates a domain.com database file from database fields
507 Updates /etc/named.conf or /etc/named.boot and reloads named.
508 Add's virtual.com to /etc/sendmail.cw or qmail control files.
509 Edits your web servers httpd.conf file and restarts http server.
510 An optional section for adding vif's can be added if the users OS
511 supports adding them on the fly. Otherwise it's up to the end
512 user. Make a hook that can run a custom script that the user
513 tweaks for his system.
514 Update or create the config file your web stats analyzer needs. I've
515 done this for analog (free) and http-analyze. Probably
516 should only officially support analog and let users hack
517 it to their hearts desire.
518 I've already written scripts that do most of the virtual web stuff on my
519 system...in bash. Shouldn't be hard for a perlmeister to convert. In fact,
520 as long as all the info was stored in the database (username, domain name,
521 and ip pool) this could easily just be run as an external script that the
522 user tweaks to match his system.
524 We use a great accounting software (M.Y.O.B) that does all the AP, AR,
525 Payroll, Tax stuff, and most everything else we could need. It's already
526 set up for the type of checks we have, etc, etc... I just need something to
527 do the billing part. I can import/export sales and payments directly once
528 the billing part is done. You can't write accounting software as good as