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