FS::Record::qsearch - more portable, doesn't depend on $sth->execute returning
[freeside.git] / TODO
1 $Id: TODO,v 1.45 2000-06-23 12:25:59 ivan Exp $
2
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 
5 duplication of effort.
6
7 ---
8
9 update the cybercash links in config.html and in the homepage.  add more explicit support for other payment types.  etc.
10
11 From "Tim Jung" <tjung@igateway.net>
12 .
13 Automatic CC Decline Notices via email
14 Block Time billing for prepaid internet cards (400 hours or whatever block
15 time of hours)
16 Trouble Ticket System with simple search function for Knowledge Base feature
17 Employee Timecards
18 Credit Card System support for Red Hat's CCVS, and other Linux credit card
19 programs
20 Contact Manager/Lead Tracking
21 Pre-Sale Quotes
22 Cisco NetFlow Account for IP traffic billing
23 VoIP and FoIP billing
24 Roaming per minute billing based on Radius Proxy support or number they
25 dialed into from Radius logs (800# etc)
26 Support for OpenSRS Domain Registration
27 Support for TUCOWS signup CDs
28
29
30 dbdef-create for postgres
31
32 pro-rating, fiddling dates
33
34 It looks like svc_acct.import doesn't deal well with comments and
35 multi-attribute lines.
36
37 ivan@rootwood:~/freeside_current$ rgrep -r domuid * | cut -d: -f1 | sort |
38 uniq
39 CVS/Base/TODO
40 TODO
41 bin/fs-setup
42 bin/svc_acct_sm.export
43 bin/svc_acct_sm.import
44 htdocs/docs/man/svc_acct_sm.txt
45 htdocs/docs/schema.html
46 htdocs/edit/CVS/Base/part_svc.cgi
47 htdocs/edit/part_svc.cgi
48 htdocs/edit/process/svc_acct_sm.cgi
49 htdocs/edit/svc_acct_sm.cgi
50 htdocs/search/svc_acct_sm.cgi
51 htdocs/view/svc_acct_sm.cgi
52 site_perl/svc_acct_sm.pm
53
54 rootwood:COMPLETEHOST/TODO
55
56 Currently, you set a value in the %FS::UID::callback hash with a coderef  
57 of the code you want to execute, but this was bad design and will shortly
58 be changed to a subroutine to which you pass your coderef to register it.
59
60 This is not a bug, it is how the system is currently designed.  After 
61 defining a new package, you need to specifically allow agent types to
62 purchase packages.  You can do this from the edit screen of the new agent
63 type.
64 .
65 It wouldn't be a bad idea to add a configuration value that makes new
66 packages available for all currently existing agent types automatically.
67 .
68 On Fri, Apr 07, 2000 at 10:50:35AM -0500, David Morton wrote:
69 > For some reason, the type_pkgs table didn't get updated when I tried to
70 > create a domain service and package...  insert into type_pkgs values   
71 > (4,1);  fixed it up so that I could actually order the package.
72
73
74 From: Chuck Cochems <zaphod@tdl.com>
75 .
76 1) automated generating of late notices.  So far the only way I know to
77 generate one is to re-invoice manually.
78
79 2) smart credit card rejection handling.  It should e-mail a note at
80 least, explainig that it did't go through, and why.
81
82 3)coment field in the main customer record.
83 .
84 4) streamlined payment entry feature. the current scheme has it fairly
85 buried.
86
87 5) queries to show al customers who owe money,and such stuff as that.
88
89
90 credits aren't counted against past invoices?  hmm.  something needs to be
91 done to "apply payment" genericly. and zero out invoices etc.
92
93 more email which should make it into a more organized TODO list:
94 .
95 I would also love to see Freeside support bandwidth billing by reading the
96 Cisco NetFlow Accounting data so we and other ISP's could automatically bill
97 co-located servers and even potentially other virtually hosted sites like
98 MUD, Palace Chat, IRC Chat, etc based on the bandwidth they use or average
99 sustained rates or whatever. I'm not much of a programmer so I don't know
100 what all this entails but I did download a NetFlow client agent/whatever for
101 Linux though.
102  .
103 It would also be nice to see Freeside be able to read Apache log files and
104 bill customers for web traffic that way as an option also. Plus an option to
105 bill for excessive disk usage without having to use quotas if you didn't
106 want to, would be a nice feature as well. So you could monitor with a script
107 or something to see how much disk space a user was using then get some
108 average and charge a certain amount for anything above some preset limit for
109 that account type. I might be able to hack something like this up, but I'm
110 not 100% sure where to start or if there is something out there that could
111 be modified or not.
112 .
113 Do you think that you will ever support the HKS CCVS (Hell's Kitchen
114 Software Credit Card Verification Software) since Red Hat bought them out
115 and is going to be including that for credit card processing when you buy
116 the professional version? What about possibly supporting the OpenCCVS which
117 is a GNU/GPL version of a credit card program? I haven't had time to comb
118 through the Freeside code to see how hard it would be to add support for
119 these as externally called programs.
120 .
121 Also any thoughts on help desk, and knowledge base stuff? Any thoughts on
122 this stuff, and how possible and what kinds of work or time frame would be
123 involved?
124 .
125 Tim Jung
126 System Admin
127 Internet Gateway Inc.
128 tjung@igateway.net
129
130
131
132            CVS via SSH (Score:1)
133            by platinum (jedgar at fxp dot org) on Thursday September 30, @07:13PM EDT (#4)
134            (User Info) http://www.fxp.org/~jedgar
135            The links above are your best bet for basic cvs server configuration. Once you have a pserver set up, you
136            may consider using cvs via ssh. All you need to do is the following: 
137
138            1) Have ssh and sshd set up on the client and server machines 
139            2) Set CVSROOT="joe@example.com:/home/ncvs" 
140            3) Set CVS_RSH="/usr/local/bin/ssh" 
141            4) Use cvs normally 
142            (Obviously, insert the proper host/paths above) 
143
144            You can also set up cvs/ssh to not need a password every time (similiar to an initial 'cvs login'): 
145
146            1) run ssh-keygen on client machine using no passphrase. 
147            2) copy/add ~/.ssh/identity.pub on the client to ~/.ssh/authorized_keys on the server 
148            (man ssh for more details) 
149
150            The main reason I mentio
151            CVS via SSH (Score:1)
152            by platinum (jedgar at fxp dot org) on Thursday September 30, @07:13PM EDT (#4)
153            (User Info) http://www.fxp.org/~jedgar
154
155
156 There's no way to do this currently, though it would be pretty
157 straightforward to modify the source - specifically, the _collect_
158 subroutine in FS::cust_main.
159 >
160 On Mon, Dec 13, 1999 at 04:05:32PM -0700, Jeff Garner wrote:
161 > Freeside will e-mail my users when they are billed if they are setup as
162 > billing.
163 >
164 > When setup by credit card it does not e-mail them.  Is there a way to
165 > turn on e-mail invoices for those who are billed via credit card?  Kind
166 > of like a recipt of billing....
167
168
169 doc: http://www.softagency.co.jp/mysql/qmail.en.html
170
171 sql1992.txt standard is 18 character column names.  shoot for that, not just
172 32 (postgresql default)
173
174 Also note that (AFAIK) Freeside won't display any package that has more
175 than one service on the "Add Customer" page.  The reason for this is
176 because there's no way to dynamically alter the displayed html form
177 based on which package is selected. One possible solution would be to
178 make an additional page that's used in the signup process that would
179 display the form for each package, like a MS-style "Wizard".  The first
180 page lets you select the package, then the second page has the custom
181 form with fields for each service in that package and a save button. Of
182 course, that would require a little perl work.
183 .
184 Later,
185 Scott Cruzen <sic@boernenet.com>
186
187
188 Your suggested script with back up /usr/local/etc/freeside, but will miss
189 any database not named `freeside'.  Both of our scripts are specific to
190 MySQL.  If you're interested in contributing to Freeside, maybe you could
191 work on a script which: reads the mapsecrets configuration file and then
192 each secrets file to find out what specific database engine(s) (MySQL,
193 PostgreSQL, etc.) and database(s) need to be backed up, then does so,
194 serializing backups of the same engine, i.e. stop mysql, do all the mysql
195 backups, start mysql, stop postgresql, do all the postgresql backups,
196 start postgresql, etc.
197 > #!/bin/sh                                                                     
198 > apachectl stop                                                                
199 > mysqldump -t freeside > fs-backup.sql                                         
200 > apachectl start                                                               
201 > tar -Pzcvf fs-backup-`date +%y%m%d%H%M%S`.tgz fs-backup.sql /usr/local/etc/freeside/                                                       
202 > rm fs-backup.sql                                                              
203
204 I chose to use counters in the filesystem because there is no standard way
205 to get the value of an auto-incrementing keyfield which is common across  
206 all databases (as seen through DBI/DBD).
207 .
208 It certainly wouldn't be a bad idea to use the database-specific methods,
209 when available.
210
211 htdocs/edit/svc_acct.cgi:
212 (Does the `*HIDDEN*' show up when you are adding a new account, and 
213 specify the password, then receive an error and are returned to the form?)
214
215 more DOC:
216 Thought some of you might be interested in this:
217   
218 <ftp://ftp.minivend.com/pub> has CyberCash compatibility modules for 
219 Paymentnet <http://www.paymentnet.com> and Authorizenet 
220 <http://www.authorizenet.com> which should allow you process transactions
221 using those services as well as CyberCash.
222
223 The files are named CCLib.pm.paymentnet and CCLib.pm_authorizenet,
224 respectively, and are installed by renaming to CCLib.pm and moving to your
225 site_perl directory.  Otherwise, follow the directions for Cybercash v2 in
226 htdocs/docs/config.html
227
228 DOC:
229 fs_passwd/ is a client-server replacement for the `passwd', `chfn' and    
230 `chsh' commands that updates the Freeside database.  (so for that to be   
231 useful, you'd have to be exporting that data periodically)
232   
233 fs_radlog/ is a client-server RADIUS log parser that stuffs the data into
234 SQL.  It isn't finished, and probably won't be unless someone who I can't
235 convince to use one of the RADIUS daemons that logs to SQL directly pays  
236 me money or something.
237   
238 fs_signup/ is a client-server signup server.  i'm just finishing it up    
239 now; probably isn't on your machine yet.
240
241
242 http://www.sisd.com/freeside/list-archive/msg00812.html
243
244 package definitions should be implicit allow wrt agent types, not implicit deny
245 (with the old behavior possible via a config file)
246
247 > So is there anyway it could be setup to allow you to select a "primary
248 > service" from each package?  This service would be the one you were prompted
249 > for.  Could the signup server then be expanded to allow users to go into
250 > their package and "turn-on" the remaining non-primary services(using the
251 > primary account.)
252
253 take the GPL'ed whois proxy stuff at www.geektools.com and turn it into
254 intelligence for Net::Whois.
255
256 A web version of the fs_passwd stuff would be nifty.   
257
258 If you have Cistron authenticating directly from MySQL, you can replicate
259 in real-time instead of exporting periodically.  See 
260 <http://www.mysql.com/Manual_chapter/manual_Common_problems.html#Replication>.
261
262 these go in docs:
263 <http://www.sisd.com/freeside/list-archive/msg00541.html> (was 546), and
264
265 and http://www.sisd.com/freeside/list-archive/msg00421.html (was 423)
266
267 > > 5: Is there anyway to get freeside to send a sysadmin a warning when a
268 > > credit card has expired?
269 No, but there should be.
270
271 Put this in the doc (quoting Mark Wells <mark@pc-intouch.com>):
272 >Of course, thanks to the sheer coolness of SQL and MyODBC, you can do
273 >whatever reports you want in basically whatever application you want.
274 >There's no need for Freeside itself to do any reports at all.
275
276 middle names and titles
277
278 On Wed, Jul 07, 1999 at 01:11:40PM -0400, Frank Nazario wrote:
279 > Playing and entering information to Freeside i encountered the following
280 > missing reports:
281
282 > View Customers by Agent
283
284 > View Pending Invoices
285
286
287 grep 'uncomment this to encrypt password immediately' site_perl/svc_acct.pm
288 Not to say that it shouldn't be a configurable option.
289
290 in site_perl/cust_main_invoice.pm (elsewhere?), error out if mydomain config file is gone
291 (at least until the idea of a default domain goes away)
292
293 FS::Record::qsearch does an eval every loop iteration (which is itself not
294 guaranteed to work across all DBD's and should be fixed).  This has got to be
295 slow.  Fix it.  (I think recent Perls might have a way to accept a variable
296 there, no eval needed?)
297
298 Could you have added /bin/sync, /sbin/shutdown, and /bin/halt to the
299 `shells' configuration file before importing, and removed them afterwords?
300 (even better if svc_acct.import did that automatically - it could just    
301 munge and restore @FS::svc_acct::shells... hmm.)
302
303 > BTW, Ivan, I am trying to verify in an additional database table that a
304 > particular user doesn't exist. This database is used to store email aliases a$
305 > additional POP boxes for our customers (kinda like AOL allows). I have toyed  
306 > with the idea of just writing the aliases to an email only svc_acct that
307 > doesn't write to the password file, but that isn't really how I want to do it.
308
309 Actually, I think that's a pretty good way to do it.  Cerkit contributed
310 support a little while back for svc_acct.pm and svc_acct.export for
311 multiple export targets.  It needs to be cleaned up and documented, which
312 I'll try to get to soon.  For this to work correctly, the svc_acct_sm
313 table should go away, along with the concept of a "default" domain.  
314
315 default setting for new packages should allow all agents to purchase them...
316 with a config file for the old behaviour
317
318 fix or replace Term::Query (Quiz::Question doesn't do what i need)
319
320 Check config file reading stuff from CPAN
321  
322 Authorizenet module from CPAN!
323
324 <http://www.math.fu-berlin.de/~leitner/mutt/faq.html> has a good y2k complience
325 statement!
326
327     I'm hoping Freeside can support arbitrailly complex pricing plans
328     because of a simple concept: all prices are perl expressions.  So if
329     you use `19.95' for example, perl evalates that to be `19.95'.  But if
330     you need to do a complex pricing scheme, you just need to write an
331     appropriate perl expression, which will most likely pull data from the
332     database to return pricing.  Some things will already log to SQL; for
333     example most RADIUS servers can or have a patch available.  Getting
334     Freeside to bill based on any sort of data then becomes a matter of
335     importing the data into the database.
336  
337     There are some issues involved with pro-rating, partial month charges,
338     that sort of thing.  Expressions will need a standard way to have the
339     applicable time/data ranges passed to them.  Also the expressions are
340     currently running under the Safe perl module, and the opmask might not
341     be right in all situations.  I'll try to spend some time working on
342     this if you are using it.
343
344 > 2. can customers view their bills on-line.                                    
345  
346 Not yet; it needs to be proxied from Freeside to a customer web server in
347 a secure way using something not completely unlike the fs_passwd,
348 fs_passwdd, fs_passwd_server trio.
349
350
351 > Lastly, if someone over pays on an invoice, the credit part does not flow
352 > over to other invoices..
353
354 The total balance flows over correctly, but individual payments don't.
355 The code you're looking for is in FS::cust_pay::insert
356
357 The question of what to do with overpayments that don't have another 
358 invoice to flow into (yet.. or possibly not) is still an open one.    The
359 legacy system Freeside replaced long ago had a separate place for this
360 (payments waiting for an invoice) for each customer, and it gave our
361 bookeeper fits.
362
363
364 option to relax username uniqueness in favor of username+domain or mail/shell
365 vs. radius to ease import for isp's with namespace problems or who buy others.
366
367 do i have to store anything for radius realms besides regular radius attributes
368 (which are handled fine now)?
369
370 warn or complain or something when invoice_from is empty (and we use it)
371
372 Right now Freeside uses the `freq' field of a package definition as a 
373 number of months.  The specific section of code you're looking for is in  
374 FS::cust_main::bill:
375         
376         #change this bit to use Date::Manip?
377         #$sdate=$cust_pkg->bill || time;
378         #$sdate=$cust_pkg->bill || $time;
379         $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
380         my ($sec,$min,$hour,$mday,$mon,$year) =
381           (localtime($sdate) )[0,1,2,3,4,5];
382         $mon += $part_pkg->getfield('freq');
383         until ( $mon < 12 ) { $mon -= 12; $year++; }
384         $cust_pkg->setfield('bill',
385           timelocal($sec,$min,$hour,$mday,$mon,$year));
386         $cust_pkg_mod_flag = 1;
387   
388 ..and when I went poking for this, looks like it tells us just what needs   
389 to be done!  Hehehe...
390
391 Date::Manip can handle cool things like "+ 1 month" (actually the current
392 case of /^(\d+)$/ would have to be added as a special case of "+ $1 
393 month") and "+ 30 days" (what you need) and even "+ 5 business days" !
394
395
396 On Wed, Apr 28, 1999 at 08:38:16PM +0000, Kristian Hoffmann wrote:
397 > I can't quite seem to figure out how this exporting works.  From what I
398 > understand, when you run svc_acct.export, it rewrites the /etc/passwd,
399 > /etc/shadow, etc. files.  Is this only for initial setups with the
400 > export hooks being in the pm's?
401  
402 You can use both, or just one method.  The configuration files control    
403 this.  One of the things in the TODO is to take out the last few things   
404 that aren't customizable wrt this and put them in config files.
405
406 http://www.daemonnews.org/199905/user-mgmt.html
407
408 Term::Query doesn't install out of the box from CPAN.  Fix it (and get it 
409 submitted upstream!), or remove requirement from bin/svc_acct.import and
410 bin/svc_acct_sm.import and take it out of the install instructions.
411
412 use this cool link to explain the Freeside API
413 ftp://cpan.nas.nasa.gov/pub/perl/CPAN/doc/FMTEYEWTK/easy_objects.html
414
415 Multiple tax rates by geographic region (county, state, and county) are   
416 supported; just choose View/Edit tax rates from the main menu.
417
418 Multiple tax rates by package are not (yet) supported.
419
420 On Wed, Jul 07, 1999 at 12:13:36PM -0400, Shaun Batterton wrote:
421 > How would you handle something like multiple tax rates and multiple   
422 > states?  For example in Connecticut, they just changed computer and/or
423 > data processing services to 3% (whatever that is), and everything else
424 > is 6%.
425
426
427 > Second, when trying to add a new user I get two types of errors; first one
428 > is when I place an e-mail address and select the "submit," Freeside
429 > complains with "Error: Unknown local account (specified literally)"
430 .  
431 You probably put a (local) email address in for email invoices.  Freeside
432 stores these as references to the database records, so (for example) they
433 follow username changes.
434 .
435 I'm guessing you put in the email address that you were creating, and got
436 that error because it didn't exist yet.  Sounds like a buglet to me.  I'll
437 try to fix that soon; in the meantime you can add the invoicing email 
438 address afterwords.
439
440 (workaround for postgres before 6.5) (unlikely to ever be implemented)
441 In the mean-time, this could probably be fixed with the reverse of        
442 the kludge in FS::Record::new.  This removes `$' and `,' from money fields
443 coming out of the database.  Something which fixed up the data so Postgres
444 was happy with it could go in FS::Record::_quote, for data going into the
445 database.
446
447 our data display problem might be a Freeside problem wrt not using 
448 Oracle-compatible DBI syntax (fixed using the return value from $sth->execute
449 as a number of rows - something else?).
450
451 hooks for arbitrary commands out of configuration files
452 svc_acct.pm svc_acct_sm.pm etc.
453
454 Add this to a FAQ, along with doing it for middle names:
455
456
457 >  What I'm finding difficult is how to easily 
458 > customize fields.  For example, I am trying to add a "middle name" field
459 > to the Customer Edit, view, etc.  If I'm going about it right, it appears
460 > I have to edit the cust_main.cgi under edit and edit/process and the
461 > site_perl/cust_main.pm, as well as other things.  Perhaps you could shed
462 > some light on the best way of doing this.
463
464 You have the basic idea.  To implement that completely, I would:
465 - Add the new field to bin/fs-setup for new users
466 - Document the field in htdocs/docs/schema.html
467 - Document the change in a new file, htdocs/docs/upgrade4.html
468 * Run bin/dbdef-create
469 * Add the new field to edit/cust_main.cgi and edit/process/cust_main.cgi
470
471 For bonus points, I'd grep around for the various bits which use "$first 
472 $last" or "$last, $first" and replace them with a method call in cust_main.pm,
473  , like search/cust_main.cgi
474
475 document security model:
476 Don't forget about Apache usernames - since, via the mapsecrets file, each
477 user can login to the SQL database with a different username and
478 password, you can utitilize the security model of the SQL database as
479 well.  Also, each username here can point to a different configuration
480 directory where you could store user-specific configuration info.  Then   
481 you could link each username to one-to-many agents. 
482 (The web demo works using a trivial version of this.)
483
484 Yes, queue processing or the equivalent via checkpoint fields on various  
485 talbes (which you pick up via a pretty simple SELECT) would be really 
486 nice too.
487
488 default (and ordering) state/county/country config file
489 expand the
490 cust_main_county table to provide a preferred ordering, so the most common
491 entries would be at the top of the selection box.  automatically, based on
492 recent selections?
493
494 hmm... maybe svc_acct__shell should check off the legal shells list if
495 applicable?  yeah... cool.
496
497 payinfo field should me much larger than 16
498
499
500 [Mon Apr 12 20:31:21 1999] [error] [Mon Apr 12 20:31:21 1999] null: Error closing true: Broken pipe at /usr/local/lib/site_perl/FS/cust_main.pm line 615.
501
502 javascript (yuck!) "are you sure?" confirmation on cancelations, etc.
503 (view/cust_pkg and view/svc_*)
504
505 get rid of time2str("%D") which formats dates in a non-y2k-safe looking fashion
506 (all the actual date handling uses UNIX timestamps and is fine)
507
508 uncomment expire in view/cust_pkg.cgi and find the expire cron from fsold
509
510 (Test this)
511 one-time/per-customer/? changes in rates and descriptions ('remembered
512 invoices'): implement by creating a new package on the fly... but it isn't 
513 associated with any agent types so it won't show up for other customers to buy.
514 (but also... make sure they go away when the customer does! - need this? :
515  one-off package edits! : need a cust_pkgs or cust_part_pkgs or something table,
516  with custnum and partpkg (like type_pkgs)
517 (what happens if you hit "custom pricing" but the pricing is already custom?)
518
519 Lay out any remaining ugly forms better.
520
521 remove "records identical" warning?  gets in the way of more important stuff.
522 or fix logic which tries to update identical records??
523 1.2 should be quiet enough that the error log is useful, hopefully.
524
525 Postgres has a maximum column length of 31 characters (but see NAMEDATALEN in
526 postgres_ext.h).  part_svc has columns like: svc_acct__radius_Attribute_flag
527 (22 characters!)  It seems that stuff over the limit is silently ignored,
528 so we get 4 characters back.  So, Radius_Attributes are max 13 characters with
529 stock Postgres.  see rfc2138 for what's affected
530 What's a good fix?  (besides recompiling postgres with NAMEDATALEN 64)
531 (mysql has a 64 character max column length.  others?)
532
533 [Mon Mar 29 06:57:56 1999] -e: Use of uninitialized value at /usr/lib/perl5/Date/Format.pm line 333.
534 (when sending mail in cust_main.pm::bill or svc_domain.pm)
535
536 look at DBIx::Recordset!  (and Tie::DBI, and...)
537
538 undefined conf/lpr gives this uninfomative error:
539 [Fri Feb 26 16:42:36 1999] bill.cgi: Can't do bidirectional pipe at
540 /usr/lib/per
541 l5/site_perl/FS/cust_main.pm line 629.
542 [Fri Feb 26 16:42:38 1999] bill.cgi: Error closing : Broken pipe at
543 /usr/lib/per
544 l5/site_perl/FS/cust_main.pm line 631.
545 So give a meaningful error!
546
547 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
548
549 i10n: Apache::Language
550
551 Apache::Session?  Other useful Apache::* ?
552
553 email invoices are only sent for the BILL payby.  If setup, should statements
554 (since they're not invoices) be sent for COMP and CARD as well?
555
556 $cgi->keywords is causing the (hard to trace) error:
557         Use of uninitialized value at (eval 5) line 5
558
559 edit/cust_main.cgi gives an uninformative error message:
560 > Can't call method "agentnum" without a package or object reference at   
561 > /usr/local/apache-ssl/htdocs/freeside/edit/cust_main.cgi line 116.
562 if there are no agents.
563
564 (is this missing on any web screens?  (easy with $cust_svc->label)
565 Add the ability for services to filter information up to the package level
566 for web screens, so you can select a particlar package based
567 on username or domain name, etc.
568
569 Allow a cancelled/suspended/active status from packages to bubble up to
570 the customer lists.  Put active, then suspended, then cancelled accounts.
571 Similar ordering on the package listing inside a single customer.
572
573 false laziness: edit/cust_main.cgi got some parts copied from edit/svc_acct.cgi
574 the web interface in general needs to be redone in a more abstract way.
575
576 false laziness: some of search/svc_acct_sm.cgi was copied to search/svc_domain.cgi.  but web interface in general needs to be rewritten in a mucho cleaner way.
577
578 subroutine the where clause (eventually all SQL) as OO perhaps (has anyone done this?)
579
580 add a select method to FS::Record?
581
582 one-time/per-customer/? changes in rates and descriptions ('remembered
583 invoices'): implement by creating a new package on the fly... but it isn't 
584 associated with any agent types so it won't show up for other customers to buy.
585 (but also... make sure they go away when the customer does! - need this? :
586  one-off package edits! : need a cust_pkgs or cust_part_pkgs or something table,
587  with custnum and partpkg (like type_pkgs)
588 (what happens if you hit "custom pricing" but the pricing is already custom?)
589
590 You can't delete the stuff under administration yet.  Add this,
591 _including_ making sure the thing you are deleting is not in use!
592
593 add links on view/cust_main.cgi to setup services, like view/cust_pkg.cgi
594
595 FS::cust_pkg _require_'s FS::$svc, but this won't work with %FS::UID::callback
596 loading of configuration.  (pry need same idea, but will run immediately if
597 context allows).  Looks like error is masked by 'use FS::cust_svc' which in
598 turn 'use's FS::{svc_acct, svc_acct_sm, svc_domain}' which is now explicit
599 w/comments in source
600
601 Allow a cancelled/suspended/active status from packages to bubble up to
602 the customer lists.  Put active, then suspended, then cancelled accounts.
603 Similar ordering on the package listing inside a single customer.
604
605 svc_domain.pm mail sending uses Date::Format which doesn't seem to pick up 
606 correct timezone.
607
608 view/svc_domain.cgi needs to know the domain might be unaudited (cosmetic)
609
610 remove whois_hack set to 1 for svc_domain.pm?  add all known registries and
611 whois accordingly.
612 .us domains and others!
613 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...
614
615 turn on the depriciation warnings for [e]idiot in FS::CGI. Stop using [e]idiot
616 the last places it is (htdocs/search/ htdocs/misc/ htdocs/misc/process)
617
618 (test cust_main.pm with cybercash v2 and v3, especially with the callback
619  stuff AND with mod_perl w/cybercash v2 kludge in package main)
620 (callback stuff should be eliminated by now)
621
622 bah, table/itable/*table in FS::CGI is silly.
623
624 doc Apache::AuthDBI as well
625 ..
626 Provide sample httpd.conf files.
627
628 hey look: Tie::DBI!  Check that out.  Override its commit with something that
629 does perl-side caching for ? a performance improvement and as an emulation
630 layer to plug in f.ex mysql's atomic transactions
631 ..
632 Record.pm uses does some non-portable DBI things.  MySQL and Pg seem fine.
633 Fix it anyway unless we migrate to Tie::DBI.
634
635 faq
636
637 cust_bill.pm uses '==' comparison on dates because they're currently ints
638
639 config file for allowed card types
640
641 write instructions for adding new services w/svc_Common.pm.  Get rid of all
642 places where svc_* tables are hardcoded (rename svc_acct_pop to part_pop so
643 we can do that)
644
645 test and document libapache-dbi-logger (woo!)
646
647 radius logfile parsing and perl expression check.
648
649 Fix in cust_bill BUGS: 
650 There is an off-by-one error in print_text which causes a visual error (Page 1
651 of 2 printed on some single-page invoices).
652
653 fields should be a method against a FS::Record or derived object, as well as
654 being something you can call as FS::Record::fields('tablename').  Might
655 even be able to handle both in the same routine (that would be neato).
656
657 Immediate removal of incorrectly entered check payments (can't take too
658 long to do this, or accounting is fubared).
659
660 Add code to move from one service to another (POP to SLIP/PPP, etc.).
661 This _should_ be possible by working off the rules in part_svc rather than
662 hardcoding anything in.  The rules in part_svc may need some elaboration,
663 perhaps.
664
665 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.)
666
667 (bring back from fsold, ) Generalize config-sending stuff and make more configurable.
668 Expand the HylaFAX interface (also possibly generalize for other fax
669 softwar ie .comfaxe); allow things like arbitrary faxes of sales
670 literature, specific troubleshooting documents and so on.  Maybe even
671 allow users to do this (though that might not belong in Freeside).
672 misc/sendconfig.cgi
673 misc/process/sendconfig.cgi
674 Configure fax recipients via a separate box rather than using the finger
675 name or first+last from cust_main.
676
677 move all phone number logic out of Freeside - let HylaFAX or whatever
678 handle it.
679
680 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?!
681
682 should be able to link on some field in email alias (right now you can link
683 on username or domain with a fallback to svcnum)
684
685 generalize and make configurable new invoice printing scheme in FS::cust_main::collect (past due)
686
687 deleting an svc_domain should delete all associated svc_acct_sm records.
688 same with a svc_acct.
689
690 periodic password encrypter
691
692 Automated, configurable notification, suspension and cancellation of
693 defunct accounts.
694 ...
695 expire cron job
696 ...
697 Allow for a future setup date on accounts.
698
699 sub AUTOLOAD in FS::Record should warn? die? if used with a non-existant column
700 name?
701
702 edit (not just import, export and allow default/fixed) arbitrary radius stuff
703 in svc_acct
704 edit/svc_acct.cgi and edit/process/svc_acct.cgi should deal with arbitrary radius stuff
705
706 radius import should take DEFAULT entry and put it in /var/spool/freeside/conf/radius-default ; svc_acct.export should use it (and doc)
707
708 in UI, s/State/State\/Provence/go and s/County/County\/Locality/go
709
710 what else (besides l10n) for i18n? (money!)
711
712 audit htdocs/* for things that should be libraried and things that should be
713 new methods on the objects (need to do this before implementing a new UI)
714 all the big things are done
715
716 some places we die() where we should &FS::CGI::idiot (and perhaps vice-versa).
717 Decide based on whether or not the "error" should show up in logs.
718
719 all .cgi's should use standard header/footer and idiot() subroutines.  maybe HTML:: perl modules
720 for HTML creation.  Maybe Embperl or something along those lines.  ?
721
722 When running bin/bill, Fix this (Annoying but harmless):
723 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 99, <ADDRESS> chunk 4.
724 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 102, <ADDRESS> chunk 4.
725 Use of uninitialized value at /usr/local/lib/site_perl/FS/cust_pkg.pm line 105, <ADDRESS> chunk 4.
726
727 all cgi (but internal to the isp) places where package names are listed should also have
728 comment (like agent_type)
729
730 clean up $recref and other silliness and use -> calls where possible, or
731 one other alternative.  clean up everything else.
732 should FS::Record use Tie::Hash?  That would be very clean, but where do we
733 store the other information?  Maybe you could ask any FS::Record object for a
734 tied hash?
735
736 change all file access from regular open(FILE,) stuff to OO, because of 
737 problems scoping and passing filehandles like that.
738
739 the web interface should create a new object and use it instead of a blank
740 form for new records.  the create method of svc_ objects should set defaults
741 (from part_svc).
742
743 sub check in man FS::table_name should be rewriteen.  Get rid of $recref
744 stuff.  Make sure all fields that refer to other database are checked.
745
746 Integration with signup disks (are there any free ones?  Netscape?).
747
748 One-button cancel (+refund) for lusers who can't get online.
749
750 Keep information on virtual web servers (hostname, IP, host machine,
751 directory, etc.) and export this information for importation into the ISPs
752 web farm. 
753
754 Remove requirement that the first mail alias be the catchall?  Still make
755 sure only one catchall per domain is defined in any case, of course. 
756
757 Ability to move cust_pkg records from one customer to another? (proably
758 will need to cancel the old and create a new like when we move services
759 between packages). 
760
761 Auto-increment expired cards one year, and try again?
762
763 More non-US stuff - zip codes, country codes, foreign currencies, etc.
764
765 cust_refund.{cgi.pm} need to do cards xaxtions.  (now we only have cust_credit)
766
767 Nicer set of integrated reporting possibilities, like weekly sales totals
768 by customer, package, agent, referral, etc., aging reports sorted by lots
769 of different things, and so on.
770
771 Client/server setup for users to modify their own passwords, shells, etc,
772 via passwd or secure web interface (prelminary passwd/chfn/chsh
773 replacement done).  Complicated by the fact that we don't want to allow
774 incoming connections to the machine running Freeside, so we probably need
775 to have a daemon on each external shell or web machine that is contacted
776 by the Freeside machine.  Be very very careful for both traditional
777 security issues and DoS problems. 
778
779 An extension of the above to allow users to modify selected parts of their
780 own information, order and cancel services.  A web interface for new
781 customers.
782
783 Expand domain name stuff to house all domain information.  Export
784 named.boot/named.conf (primary and secondary) and named.{domain} files.
785 Add more registries (not just InterNIC's com org net edu)
786
787 Nice postscript paper invoices, rather than current ASCII invoices.
788
789 think about race-condititions in FS::Record and derived ->check ->insert
790 and so on, uid and username checks in svc_acct, etc.
791
792 Move to rsync over ssh file exportation rather than scp.
793
794 check 'n fix the proactive password checker. (cracklib?)
795
796 refunds of "BILL" payments: generate pseudo-check.
797
798 write batch senders and batch parsers for the different credit card processors
799 people use/
800 More CC processors/methods.
801
802 you should be able to fiddle the setup date in cust_pkg. (at least initially)
803
804 delete options in administration section
805
806 write a generic batch senders and batch parsers.
807
808 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
809 type stuff from cerkit)
810 ...
811 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)
812
813 you should be able to get column types as a method against an FS::Record object
814 as well as dbdef->table($table)->column($column)->type
815
816 move to perl module for fuzzy and soundex searching.
817
818 package view needs to list extraneous services; we need to prevent the
819 creation of them so this never happens (and mark it as such in the source)
820 (the creation problem should be fixed - though they will still happen if people
821 fsck around in the data manually, so list them anyway)
822
823 add attribute dictionary to fs-setup as a menu, plus analyze users file to
824 decide automatically
825
826 Check for and report on duplicate billing accounts (cust_main, though many
827 will have a need for these so probably don't disable them outright.)
828
829 create a ->warn as well as a ->check method for all FS::table classes?
830 (see above)
831
832 something to automate making a release and updating the web demo
833
834 export a debian-style (also redhat and?) /etc/group file aswell!
835
836 svc_acct_sm.import qmail import should pull in recipientmap people too.
837
838 .pm's like svc_acct.pm which need to do time-consuming things like ssh remotely
839 should fork and do them in a child.
840
841 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.
842
843 get some of { city, county, state, zip } from the missing bits if
844 possible (where can i get the data to do this?  usps.gov?)
845
846 additional interfaces (perltk?  java?)
847
848 Put the GPL notice in all files.
849
850 integrate w/IDEA's signup server
851
852 $cust_bill->owed database field to be eliminated, replaced by a method call
853 that calculates on the fly.  make sure to grep for ->(get|set)field('owed') 
854 same for cust_credit->credited
855
856 Export quota information.
857
858 move all configuration to a central place.  maybe in blob's in the
859 database.  maybe even things like the code to execute when a username is
860 changed can be in there, so less of the distributed scripts change between
861 different sites.
862
863 Implement setup and recurring fees as Safe perl expressions rather than
864 numbers, to allow for variable-rate services.  Backwards compatibility is
865 obtained because { 43 } in perl is still 43.  :)  Define API to pass
866 starting and ending dates and any other necessary data to expression
867 (fees are currently evaluated as Safe expressions but more work needs to
868 be done to define an opmask for various needs, write examples
869 (usage-based billing, etc.) and so on).
870 ...
871 Add the ability to modify the next billing date in cust_pkg, and take
872 appropriate action.  This will allow the implementation of pro-rate/1st of
873 the month billing as well as the ability to manually fiddle with
874 anniversary dates in cust_pkg, so you can sync a customer's anniversary
875 date even if you're using anniversary billing (manually or automatically).
876 (now with above, we need to have a way to automatically pro-rate /^(\d+)$/
877 charges - anything more complicated should figure it out itself given
878 starting and ending dates [document that!])
879 ...
880 Daily Radius log parsing into database; other logfile formats?
881 ...
882 Callbacks to enforce hourly limits on accounts (suspend until the end of
883 the billing period?), for those who limit customers rather than tack on
884 extra charges.
885
886 Flag packages (part_pkg) as taxable or non/taxable as some ISPs (for
887 example) need to charge tax on equipment but not service (separate flags
888 for setup and recurring fee... or perhaps a setup_tax, setup_notax,
889 recur_tax and recur_notax fees, and possibly something more flexible if
890 there is need).
891
892 Allow for a variable number of invoices for customers who need multiple
893 copies.
894
895 Add a mail alias service with table svc_acct (not domain mail aliasing
896 which is domain with svc_acct_sm)
897
898 (bring back from fsold) Change customer comment field from its current kludge to something more
899 workable.
900
901 Better work orders with more information.  Should eventually open a ticket
902 when we have such a thing.
903 edit/svc_wo.cgi
904 edit/process/svc_wo.cgi
905 Call tracking and trouble tickets.
906
907 More accoutability for complimentary accounts: approval, expiration, term
908 (no more than x months in advance) and notification.
909 Flag particular users (or all users, for that matter) as having their
910 passwords hidden and/or locked from users of Freeside (maybe need Freeside
911 security levels first?). 
912 ...
913 Better Freeside-level configurable access, for those ISP's who have
914 employees they can't trust.  Right now you're "stuck" with setting up
915 .htaccess stuff yourself.  This should really just be integrated. 
916
917 configuration/setup should get web interface
918 ...
919 /usr/local/etc/freeside should be configurable
920 ...
921 (probably as part of some automated installation process?)
922
923 This requires some serious magic in FS::Record:
924 ok, if date_type in fs-setup is to be something besides int,
925 now we need to create wrappers
926 for them so they behave identically across RDBMS's, ie date pops out as as
927 UNIX timestamp (or an object of some sort? maybe even a blessed $obj which
928 is a string not a hashref for backwards compatibility?) and so on. (remember
929 to treat '0' as Not a Date instead of 1/1/70.
930
931 Add Freeside-level transactions for RDBMS's which don't support
932 transcations?  (Currently we assume a minimal RDBMS which has no rollback,
933 transactions or atomic updates).  Or just require a RDBMS that supports
934 rollback and/or atomic updates and get rid of the work-arounds?  The /rdb
935 interface had this kludge on top of it but is a technical dead-end in most
936 other ways, unless it can gain an SQL parser and DBD interface.
937 ...
938 if i'm really bored, find the /rdb interface in fsold and port it to NoSQL,
939 and while I'm add it add interfaces for AnyDBM_File tied hash.. hmm.  Shouldn't
940 an FS::Record have something to do with a tied hash?  But we don't want
941 performance to go gaga... maybe something with commit to help out here?
942 ...
943 Ok: FS::Record gives you a tied hash, and you get methods for commit, etc.
944
945 Better automated comparison of our CC records with processors (CyberCash,
946 at least, has not always had 100% accuracy, though recent versions are
947 much better) 
948
949 Expect or other pty based login check, where we actually connect to a
950 terminal server or shell machine and test logging in as the user (if we
951 are keeping a cleartext password for that user)  (This is something tech
952 support often needs for new customers)
953
954 Use cust_main table for pre-sales tracking as well?
955
956 Automatic commision report and check generation via freq and prog (to
957 become a Safe perl expression) fields in agent table, and possibly others.
958
959 Database and add a mailed-out date and method for disk/CD mailing, so a
960 customer can call and you can say, "sent on xx/xx/xx via {US Mail, Fedex,
961 UPS, etc}" 
962
963 Inventory tracking for physical items such as routers (for sale or
964 lease... probably doesn't make a difference in the ordering... but if you
965 cancel a router lease the inventory should come back.  hmm.)
966
967 -- Matt's wishlist ---
968
969 From matt@michweb.net Fri Feb 20 16:39:53 1998
970 Date: Thu, 19 Feb 1998 23:20:11 -0500
971 From: Matt Simerson <matt@michweb.net>
972 Reply-To: quadran-developer@netgoth.com
973 To: quadran-developer@netgoth.com
974 Subject: Re: Welcome to quadran-developer
975
976 >Whats it based on and what is it supposed to do?  I'm interested, but
977 >unfortunatly, I don't have that much time to help on the project (I'm busily
978 >working on one of my own based around MySQL and Qt right now -- don't know
979 >if it will be GPL'ed or not yet -- we'll probably just use it in house since
980 >it is designed around our system)...
981
982 That's what I set out to find, but didn't find anything on the web site.
983 I'm looking for something that will do the following:
984
985 Single point of entry for users on a secure system:
986         Creates account on user (public) systems
987                 update /etc/passwd/master.passwd file
988                 update radius database (if necessary)
989         Set up up disk quotas (although I hacked adduser to do this)
990         Option for adding user to a mailing list(s)
991         Export of new user info to customizable report (for automated entry
992 into
993                 accounting software, etc...)
994
995 Automated billing:
996         Export credit card info for batch processing and have hooks built
997                 in for other forms of electronic processing.
998         Batch-Payment (apply payments from formatted text file).
999         Customizable reports for manual entry/importing into Accounting
1000 software
1001         Email or laser print invoices
1002         Sanity checks credit card numbers before processing (code available)
1003
1004 Simple method for disabling an account.
1005         Arbitrary Expiration Dates (on a given day, in x days)
1006         Remove from radius.
1007         Changing password to '*'
1008         Virtual customers disabling dns, http server, log processing, etc..
1009
1010 Billing for different account types:
1011         Dialup monthly flat rate. Prorates for partial months.
1012         Dialup monthly flat rate for x hours + hourly usage.
1013         Dialup email only
1014         Email only accounts
1015         Virtual Web accounts - w/multiple mailboxes
1016         Leased line accounts
1017         Disk space used over quota.
1018         Tech support minimum + hourly charges
1019         Other for misc stuff (modem, RAM, etc...)
1020
1021 Per user definable RADIUS attributes (ties in with above)
1022         Fixed IP
1023         Simultaneous Use
1024         IP filters (for dialup email only)
1025
1026 Keep logs of modem usage generated daily from radius accounting logs stored
1027 on multiple radius servers.
1028
1029 Keep logs of disk usage generated from quota.
1030
1031 Method of adding virtual domains to your system:
1032         Automatically grabs an IP address from a preassigned pool.
1033         Creates a domain.com database file from database fields
1034         Updates /etc/named.conf or /etc/named.boot and reloads named.
1035         Add's virtual.com to /etc/sendmail.cw or qmail control files.
1036         Edits your web servers httpd.conf file and restarts http server.
1037         An optional section for adding vif's can be added if the users OS
1038                 supports adding them on the fly. Otherwise it's up to the end
1039                 user. Make a hook that can run a custom script that the user
1040                 tweaks for his system.
1041         Update or create the config file your web stats analyzer needs. I've
1042                 done this for analog (free) and http-analyze. Probably
1043                 should only officially support analog and let users hack
1044                 it to their hearts desire.
1045 I've already written scripts that do most of the virtual web stuff on my
1046 system...in bash. Shouldn't be hard for a perlmeister to convert. In fact,
1047 as long as all the info was stored in the database (username, domain name,
1048 and ip pool) this could easily just be run as an external script that the
1049 user tweaks to match his system.
1050
1051 We use a great accounting software (M.Y.O.B) that does all the AP, AR,
1052 Payroll, Tax stuff, and most everything else we could need. It's already
1053 set up for the type of checks we have, etc, etc... I just need something to
1054 do the billing part. I can import/export sales and payments directly once
1055 the billing part is done. You can't write accounting software as good as
1056 M.Y.O.B. for $120.
1057
1058