1 $Id: TODO,v 1.22 1999-02-07 09:59:12 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 missed popurl in (at least) search/cust_pkg.cgi
11 one-screen new customer entry
13 clean up view/cust_pkg and view/svc_* yuck!
15 Lay out the forms a bit better.
17 libwww regression test - since it will create sample data, can also use this
19 make fs-setup option to add sample data so you can click on "New Customer" right away? so people understand what this stuff is?
21 Allow a cancelled/suspended/active status from packages to bubble up to
22 the customer lists. Put active, then suspended, then cancelled accounts.
23 Similar ordering on the package listing inside a single customer.
25 Add the ability for services to filter information up to the package level
26 for invoices and web screens, so you can select a particlar package based
27 on username or domain name, etc.
30 one-time/per-customer/? changes in rates and descriptions ('remembered
31 invoices'): implement by creating a new package on the fly... but it isn't
32 associated with any agent types so it won't show up for other customers to buy.
33 (but also... make sure they go away when the customer does! - need this? :
34 one-off package edits! : need a cust_pkgs or cust_part_pkgs or something table,
35 with custnum and partpkg (like type_pkgs)
36 (what happens if you hit "custom pricing" but the pricing is already custom?)
38 update site_perl/table_template* (pry out of date)
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 add links on view/cust_main.cgi to setup services, like view/cust_pkg.cgi
49 FS::cust_pkg _require_'s FS::$svc, but this won't work with %FS::UID::callback
50 loading of configuration. (pry need same idea, but will run immediately if
51 context allows). Looks like error is masked by 'use FS::cust_svc' which in
52 turn 'use's FS::{svc_acct, svc_acct_sm, svc_domain}' which is now explicit
55 Allow a cancelled/suspended/active status from packages to bubble up to
56 the customer lists. Put active, then suspended, then cancelled accounts.
57 Similar ordering on the package listing inside a single customer.
59 svc_domain.pm mail sending uses Date::Format which doesn't seem to pick up
62 view/svc_domain.cgi needs to know the domain might be unaudited (cosmetic)
64 remove whois_hack set to 1 for svc_domain.pm? add all known registries and
66 .us domains and others!
67 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...
69 turn on the depriciation warnings for [e]idiot in FS::CGI. Stop using [e]idiot
70 the last places it is (htdocs/search/ htdocs/misc/ htdocs/misc/process)
72 (test cust_main.pm with cybercash v2 and v3, especially with the callback
73 stuff AND with mod_perl w/cybercash v2 kludge in package main)
74 (callback stuff should be eliminated by now)
76 bah, table/itable/*table in FS::CGI is silly.
78 doc Apache::AuthDBI as well
80 Provide sample httpd.conf files.
82 hey look: Tie::DBI! Check that out. Override its commit with something that
83 does perl-side caching for ? a performance improvement and as an emulation
84 layer to plug in f.ex mysql's atomic transactions
86 Record.pm uses does some non-portable DBI things. MySQL and Pg seem fine.
87 Fix it anyway unless we migrate to Tie::DBI.
91 cust_bill.pm uses '==' comparison on dates because they're currently ints
93 config file for allowed card types
95 write instructions for adding new services w/svc_Common.pm. Get rid of all
96 places where svc_* tables are hardcoded (rename svc_acct_pop to part_pop so
99 test and document libapache-dbi-logger (woo!)
101 radius logfile parsing and perl expression check.
103 Fix in cust_bill BUGS:
104 There is an off-by-one error in print_text which causes a visual error (Page 1
105 of 2 printed on some single-page invoices).
107 fields should be a method against a FS::Record or derived object, as well as
108 being something you can call as FS::Record::fields('tablename'). Might
109 even be able to handle both in the same routine (that would be neato).
111 Immediate removal of incorrectly entered check payments (can't take too
112 long to do this, or accounting is fubared).
114 Add code to move from one service to another (POP to SLIP/PPP, etc.).
115 This _should_ be possible by working off the rules in part_svc rather than
116 hardcoding anything in. The rules in part_svc may need some elaboration,
119 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.)
121 (bring back from fsold, ) Generalize config-sending stuff and make more configurable.
122 Expand the HylaFAX interface (also possibly generalize for other fax
123 softwar ie .comfaxe); allow things like arbitrary faxes of sales
124 literature, specific troubleshooting documents and so on. Maybe even
125 allow users to do this (though that might not belong in Freeside).
127 misc/process/sendconfig.cgi
128 Configure fax recipients via a separate box rather than using the finger
129 name or first+last from cust_main.
131 move all phone number logic out of Freeside - let HylaFAX or whatever
134 soundex searches for customer name and company? where are free soundex tools? (standard Text::Soundex duh) - I could have sworn I saw Text::Soundex on CPAN?!
136 should be able to link on some field in email alias (right now you can link
137 on username or domain with a fallback to svcnum)
139 generalize and make configurable new invoice printing scheme in FS::cust_main::collect (past due)
141 deleting an svc_domain should delete all associated svc_acct_sm records.
142 same with a svc_acct.
144 periodic password encrypter
146 Automated, configurable notification, suspension and cancellation of
151 Allow for a future setup date on accounts.
153 sub AUTOLOAD in FS::Record should warn? die? if used with a non-existant column
156 edit (not just import, export and allow default/fixed) arbitrary radius stuff
158 edit/svc_acct.cgi and edit/process/svc_acct.cgi should deal with arbitrary radius stuff
160 radius import should take DEFAULT entry and put it in /var/spool/freeside/conf/radius-default ; svc_acct.export should use it (and doc)
162 in UI, s/State/State\/Provence/go and s/County/County\/Locality/go
164 what else (besides l10n) for i18n? (money!)
166 audit htdocs/* for things that should be libraried and things that should be
167 new methods on the objects (need to do this before implementing a new UI)
168 all the big things are done
170 some places we die() where we should &FS::CGI::idiot (and perhaps vice-versa).
171 Decide based on whether or not the "error" should show up in logs.
173 all .cgi's should use standard header/footer and idiot() subroutines. maybe HTML:: perl modules
174 for HTML creation. Maybe Embperl or something along those lines. ?
176 When running bin/bill, Fix this (Annoying but harmless):
177 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 99, <ADDRESS> chunk 4.
178 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 102, <ADDRESS> chunk 4.
179 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 105, <ADDRESS> chunk 4.
181 all cgi (but internal to the isp) places where package names are listed should also have
182 comment (like agent_type)
184 clean up $recref and other silliness and use -> calls where possible, or
185 one other alternative. clean up everything else.
186 should FS::Record use Tie::Hash? That would be very clean, but where do we
187 store the other information? Maybe you could ask any FS::Record object for a
190 change all file access from regular open(FILE,) stuff to OO, because of
191 problems scoping and passing filehandles like that.
193 the web interface should create a new object and use it instead of a blank
194 form for new records. the create method of svc_ objects should set defaults
197 sub check in man FS::table_name should be rewriteen. Get rid of $recref
198 stuff. Make sure all fields that refer to other database are checked.
200 Integration with signup disks (are there any free ones? Netscape?).
202 One-button cancel (+refund) for lusers who can't get online.
204 Keep information on virtual web servers (hostname, IP, host machine,
205 directory, etc.) and export this information for importation into the ISPs
208 Remove requirement that the first mail alias be the catchall? Still make
209 sure only one catchall per domain is defined in any case, of course.
211 Ability to move cust_pkg records from one customer to another? (proably
212 will need to cancel the old and create a new like when we move services
215 Auto-increment expired cards one year, and try again?
217 More non-US stuff - zip codes, country codes, foreign currencies, etc.
219 cust_refund.{cgi.pm} need to do cards xaxtions. (now we only have cust_credit)
221 Nicer set of integrated reporting possibilities, like weekly sales totals
222 by customer, package, agent, referral, etc., aging reports sorted by lots
223 of different things, and so on.
225 Client/server setup for users to modify their own passwords, shells, etc,
226 via passwd or secure web interface (prelminary passwd/chfn/chsh
227 replacement done). Complicated by the fact that we don't want to allow
228 incoming connections to the machine running Freeside, so we probably need
229 to have a daemon on each external shell or web machine that is contacted
230 by the Freeside machine. Be very very careful for both traditional
231 security issues and DoS problems.
233 An extension of the above to allow users to modify selected parts of their
234 own information, order and cancel services. A web interface for new
237 Expand domain name stuff to house all domain information. Export
238 named.boot/named.conf (primary and secondary) and named.{domain} files.
239 Add more registries (not just InterNIC's com org net edu)
241 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 you should be able to fiddle the setup date in cust_pkg. (at least initially)
258 delete options in administration section
260 write a generic batch senders and batch parsers.
262 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. (no, import desync_hosts
263 type stuff from cerkit)
265 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)
267 you should be able to get column types as a method against an FS::Record object
268 as well as dbdef->table($table)->column($column)->type
270 move to perl module for fuzzy and soundex searching.
272 package view needs to list extraneous services; we need to prevent the
273 creation of them so this never happens (and mark it as such in the source)
274 (the creation problem should be fixed - though they will still happen if people
275 fsck around in the data manually, so list them anyway)
277 add attribute dictionary to fs-setup as a menu, plus analyze users file to
280 Check for and report on duplicate billing accounts (cust_main, though many
281 will have a need for these so probably don't disable them outright.)
283 create a ->warn as well as a ->check method for all FS::table classes?
286 something to automate making a release and updating the web demo
288 export a debian-style (also redhat and?) /etc/group file aswell!
290 svc_acct_sm.import qmail import should pull in recipientmap people too.
292 .pm's like svc_acct.pm which need to do time-consuming things like ssh remotely
293 should fork and do them in a child.
295 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.
297 get some of { city, county, state, zip } from the missing bits if
298 possible (where can i get the data to do this? usps.gov?)
300 additional interfaces (perltk? java?)
302 Put the GPL notice in all files.
304 integrate w/IDEA's signup server
306 $cust_bill->owed database field to be eliminated, replaced by a method call
307 that calculates on the fly. make sure to grep for ->(get|set)field('owed')
308 same for cust_credit->credited
310 Export quota information.
312 move all configuration to a central place. maybe in blob's in the
313 database. maybe even things like the code to execute when a username is
314 changed can be in there, so less of the distributed scripts change between
317 Implement setup and recurring fees as Safe perl expressions rather than
318 numbers, to allow for variable-rate services. Backwards compatibility is
319 obtained because { 43 } in perl is still 43. :) Define API to pass
320 starting and ending dates and any other necessary data to expression
321 (fees are currently evaluated as Safe expressions but more work needs to
322 be done to define an opmask for various needs, write examples
323 (usage-based billing, etc.) and so on).
325 Add the ability to modify the next billing date in cust_pkg, and take
326 appropriate action. This will allow the implementation of pro-rate/1st of
327 the month billing as well as the ability to manually fiddle with
328 anniversary dates in cust_pkg, so you can sync a customer's anniversary
329 date even if you're using anniversary billing (manually or automatically).
330 (now with above, we need to have a way to automatically pro-rate /^(\d+)$/
331 charges - anything more complicated should figure it out itself given
332 starting and ending dates [document that!])
334 Daily Radius log parsing into database; other logfile formats?
336 Callbacks to enforce hourly limits on accounts (suspend until the end of
337 the billing period?), for those who limit customers rather than tack on
340 Flag packages (part_pkg) as taxable or non/taxable as some ISPs (for
341 example) need to charge tax on equipment but not service (separate flags
342 for setup and recurring fee... or perhaps a setup_tax, setup_notax,
343 recur_tax and recur_notax fees, and possibly something more flexible if
346 Allow for a variable number of invoices for customers who need multiple
349 Add a mail alias service with table svc_acct (not domain mail aliasing
350 which is domain with svc_acct_sm)
352 (bring back from fsold) Change customer comment field from its current kludge to something more
355 Better work orders with more information. Should eventually open a ticket
356 when we have such a thing.
358 edit/process/svc_wo.cgi
359 Call tracking and trouble tickets.
361 More accoutability for complimentary accounts: approval, expiration, term
362 (no more than x months in advance) and notification.
363 Flag particular users (or all users, for that matter) as having their
364 passwords hidden and/or locked from users of Freeside (maybe need Freeside
365 security levels first?).
367 Better Freeside-level configurable access, for those ISP's who have
368 employees they can't trust. Right now you're "stuck" with setting up
369 .htaccess stuff yourself. This should really just be integrated.
371 configuration/setup should get web interface
373 /usr/local/etc/freeside should be configurable
375 (probably as part of some automated installation process?)
377 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)
379 This requires some serious magic in FS::Record:
380 ok, if date_type in fs-setup is to be something besides int,
381 now we need to create wrappers
382 for them so they behave identically across RDBMS's, ie date pops out as as
383 UNIX timestamp (or an object of some sort? maybe even a blessed $obj which
384 is a string not a hashref for backwards compatibility?) and so on. (remember
385 to treat '0' as Not a Date instead of 1/1/70.
387 Add Freeside-level transactions for RDBMS's which don't support
388 transcations? (Currently we assume a minimal RDBMS which has no rollback,
389 transactions or atomic updates). Or just require a RDBMS that supports
390 rollback and/or atomic updates and get rid of the work-arounds? The /rdb
391 interface had this kludge on top of it but is a technical dead-end in most
392 other ways, unless it can gain an SQL parser and DBD interface.
394 if i'm really bored, find the /rdb interface in fsold and port it to NoSQL,
395 and while I'm add it add interfaces for AnyDBM_File tied hash.. hmm. Shouldn't
396 an FS::Record have something to do with a tied hash? But we don't want
397 performance to go gaga... maybe something with commit to help out here?
399 Ok: FS::Record gives you a tied hash, and you get methods for commit, etc.
401 Better automated comparison of our CC records with processors (CyberCash,
402 at least, has not always had 100% accuracy, though recent versions are
405 Expect or other pty based login check, where we actually connect to a
406 terminal server or shell machine and test logging in as the user (if we
407 are keeping a cleartext password for that user) (This is something tech
408 support often needs for new customers)
410 Use cust_main table for pre-sales tracking as well?
412 Automatic commision report and check generation via freq and prog (to
413 become a Safe perl expression) fields in agent table, and possibly others.
415 Database and add a mailed-out date and method for disk/CD mailing, so a
416 customer can call and you can say, "sent on xx/xx/xx via {US Mail, Fedex,
419 Inventory tracking for physical items such as routers (for sale or
420 lease... probably doesn't make a difference in the ordering... but if you
421 cancel a router lease the inventory should come back. hmm.)
423 -- Matt's wishlist ---
425 From matt@michweb.net Fri Feb 20 16:39:53 1998
426 Date: Thu, 19 Feb 1998 23:20:11 -0500
427 From: Matt Simerson <matt@michweb.net>
428 Reply-To: quadran-developer@netgoth.com
429 To: quadran-developer@netgoth.com
430 Subject: Re: Welcome to quadran-developer
432 >Whats it based on and what is it supposed to do? I'm interested, but
433 >unfortunatly, I don't have that much time to help on the project (I'm busily
434 >working on one of my own based around MySQL and Qt right now -- don't know
435 >if it will be GPL'ed or not yet -- we'll probably just use it in house since
436 >it is designed around our system)...
438 That's what I set out to find, but didn't find anything on the web site.
439 I'm looking for something that will do the following:
441 Single point of entry for users on a secure system:
442 Creates account on user (public) systems
443 update /etc/passwd/master.passwd file
444 update radius database (if necessary)
445 Set up up disk quotas (although I hacked adduser to do this)
446 Option for adding user to a mailing list(s)
447 Export of new user info to customizable report (for automated entry
449 accounting software, etc...)
452 Export credit card info for batch processing and have hooks built
453 in for other forms of electronic processing.
454 Batch-Payment (apply payments from formatted text file).
455 Customizable reports for manual entry/importing into Accounting
457 Email or laser print invoices
458 Sanity checks credit card numbers before processing (code available)
460 Simple method for disabling an account.
461 Arbitrary Expiration Dates (on a given day, in x days)
463 Changing password to '*'
464 Virtual customers disabling dns, http server, log processing, etc..
466 Billing for different account types:
467 Dialup monthly flat rate. Prorates for partial months.
468 Dialup monthly flat rate for x hours + hourly usage.
471 Virtual Web accounts - w/multiple mailboxes
473 Disk space used over quota.
474 Tech support minimum + hourly charges
475 Other for misc stuff (modem, RAM, etc...)
477 Per user definable RADIUS attributes (ties in with above)
480 IP filters (for dialup email only)
482 Keep logs of modem usage generated daily from radius accounting logs stored
483 on multiple radius servers.
485 Keep logs of disk usage generated from quota.
487 Method of adding virtual domains to your system:
488 Automatically grabs an IP address from a preassigned pool.
489 Creates a domain.com database file from database fields
490 Updates /etc/named.conf or /etc/named.boot and reloads named.
491 Add's virtual.com to /etc/sendmail.cw or qmail control files.
492 Edits your web servers httpd.conf file and restarts http server.
493 An optional section for adding vif's can be added if the users OS
494 supports adding them on the fly. Otherwise it's up to the end
495 user. Make a hook that can run a custom script that the user
496 tweaks for his system.
497 Update or create the config file your web stats analyzer needs. I've
498 done this for analog (free) and http-analyze. Probably
499 should only officially support analog and let users hack
500 it to their hearts desire.
501 I've already written scripts that do most of the virtual web stuff on my
502 system...in bash. Shouldn't be hard for a perlmeister to convert. In fact,
503 as long as all the info was stored in the database (username, domain name,
504 and ip pool) this could easily just be run as an external script that the
505 user tweaks to match his system.
507 We use a great accounting software (M.Y.O.B) that does all the AP, AR,
508 Payroll, Tax stuff, and most everything else we could need. It's already
509 set up for the type of checks we have, etc, etc... I just need something to
510 do the billing part. I can import/export sales and payments directly once
511 the billing part is done. You can't write accounting software as good as