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