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