3 # $Id: fs-setup,v 1.58 2001-09-11 22:20:28 ivan Exp $
5 #to delay loading dbdef until we're ready
6 BEGIN { $FS::Record::setup_hack = 1; }
10 use DBIx::DBSchema 0.18;
11 use DBIx::DBSchema::Table;
12 use DBIx::DBSchema::Column;
13 use DBIx::DBSchema::ColGroup::Unique;
14 use DBIx::DBSchema::ColGroup::Index;
15 use FS::UID qw(adminsuidsetup datasrc checkeuid getsecrets);
17 use FS::cust_main_county;
20 die "Not running uid freeside!" unless checkeuid();
23 map { lc($FS::raddb::attrib{$_}) => $_ } keys %FS::raddb::attrib;
25 my $user = shift or die &usage;
28 #needs to match FS::Record
29 my($dbdef_file) = "/usr/local/etc/freeside/dbdef.". datasrc;
33 print "\nEnter the maximum username length: ";
34 my($username_len)=&getvalue;
36 print "\n\n", <<END, ":";
37 Freeside tracks the RADIUS attributes User-Name, check attribute Password and
38 reply attribute Framed-IP-Address for each user. You can specify additional
39 check and reply attributes. First enter any additional RADIUS check attributes
40 you need to track for each user, separated by whitespace.
42 my @check_attributes = map { $attrib2db{lc($_)} or die "unknown attribute $_"; }
45 print "\n\n", <<END, ":";
46 Now enter any additional reply attributes you need to track for each user,
47 separated by whitespace.
49 my @attributes = map { $attrib2db{lc($_)} or die "unknown attribute $_"; }
52 print "\n\n", <<END, ":";
53 Do you wish to enable the tracking of a second, separate shipping/service
59 my($x)=scalar(<STDIN>);
66 my $x = scalar(<STDIN>);
72 my($char_d) = 80; #default maxlength for text fields
74 #my(@date_type) = ( 'timestamp', '', '' );
75 my(@date_type) = ( 'int', 'NULL', '' );
76 my(@perl_type) = ( 'varchar', 'NULL', 255 );
77 my @money_type = ( 'decimal', '', '10,2' );
80 # create a dbdef object from the old data structure
83 my(%tables)=&tables_hash_hack;
86 my($dbdef) = new DBIx::DBSchema ( map {
88 while (@{$tables{$_}{'columns'}}) {
89 my($name,$type,$null,$length)=splice @{$tables{$_}{'columns'}}, 0, 4;
90 push @columns, new DBIx::DBSchema::Column ( $name,$type,$null,$length );
92 DBIx::DBSchema::Table->new(
94 $tables{$_}{'primary_key'},
95 DBIx::DBSchema::ColGroup::Unique->new($tables{$_}{'unique'}),
96 DBIx::DBSchema::ColGroup::Index->new($tables{$_}{'index'}),
101 my $cust_main = $dbdef->table('cust_main');
102 unless ($ship) { #remove ship_ from cust_main
103 $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
104 } else { #add indices on ship_last and ship_company
105 push @{$cust_main->index->lol_ref}, ( ['ship_last'], ['ship_company'] )
108 #add radius attributes to svc_acct
110 my($svc_acct)=$dbdef->table('svc_acct');
113 foreach $attribute (@attributes) {
114 $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
115 'radius_'. $attribute,
122 foreach $attribute (@check_attributes) {
123 $svc_acct->addcolumn( new DBIx::DBSchema::Column (
131 ##make part_svc table (but now as object)
133 #my($part_svc)=$dbdef->table('part_svc');
135 ##because of svc_acct_pop
136 ##foreach (grep /^svc_/, $dbdef->tables) {
137 ##foreach (qw(svc_acct svc_acct_sm svc_charge svc_domain svc_wo)) {
138 #foreach (qw(svc_acct svc_domain svc_forward svc_www)) {
139 # my($table)=$dbdef->table($_);
141 # foreach $col ( $table->columns ) {
142 # next if $col =~ /^svcnum$/;
143 # $part_svc->addcolumn( new DBIx::DBSchema::Column (
144 # $table->name. '__' . $table->column($col)->name,
145 # 'varchar', #$table->column($col)->type,
147 # $char_d, #$table->column($col)->length,
149 # $part_svc->addcolumn ( new DBIx::DBSchema::Column (
150 # $table->name. '__'. $table->column($col)->name . "_flag",
159 $dbdef->save($dbdef_file);
160 &FS::Record::reload_dbdef($dbdef_file);
166 my($dbh)=adminsuidsetup $user;
171 my @sql = $dbdef->sql($dbh);
172 foreach my $statement ( $dbdef->sql($dbh) ) {
173 $dbh->do( $statement )
174 or die "CREATE error: ",$dbh->errstr, "\ndoing statement: $statement";
177 #not really sample data (and shouldn't default to US)
183 AL AK AS AZ AR CA CO CT DC DE FM FL GA GU HI ID IL IN IA KS KY LA
184 ME MH MD MA MI MN MS MO MT NC ND NE NH NJ NM NV NY MP OH OK OR PA PW PR RI
185 SC SD TN TX UT VT VI VA WA WV WI WY AE AA AP
187 my($cust_main_county)=new FS::cust_main_county({
193 $error=$cust_main_county->insert;
194 die $error if $error;
197 #AU "offical" state codes ala mark.williamson@ebbs.com.au (Mark Williamson)
199 VIC NSW NT QLD TAS ACT WA SA
201 my($cust_main_county)=new FS::cust_main_county({
207 $error=$cust_main_county->insert;
208 die $error if $error;
211 #ISO 2-letter country codes (same as country TLDs) except US and AU
213 AF AL DZ AS AD AO AI AQ AG AR AM AW AT AZ BS BH BD BB BY BE BZ BJ BM BT BO
214 BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CK CR CI
215 HR CU CY CZ DK DJ DM DO TP EC EG SV GQ ER EE ET FK FO FJ FI FR FX GF PF TF GA
216 GM GE DE GH GI GR GL GD GP GU GT GN GW GY HT HM HN HK HU IS IN ID IR IQ IE IL
217 IT JM JP JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV
218 ML MT MH MQ MR MU YT MX FM MD MC MN MS MA MZ MM NA NR NP NL AN NC NZ NI NE NG
219 NU NF MP NO OM PK PW PA PG PY PE PH PN PL PT PR QA RE RO RU RW KN LC VC WS SM
220 ST SA SN SC SL SG SK SI SB SO ZA GS ES LK SH PM SD SR SJ SZ SE CH SY TW TJ TZ
221 TH TG TK TO TT TN TR TM TC TV UG UA AE GB UM UY UZ VU VA VE VN VG VI WF EH
224 my($cust_main_county)=new FS::cust_main_county({
229 $error=$cust_main_county->insert;
230 die $error if $error;
233 $dbh->disconnect or die $dbh->errstr;
235 print "Freeside database initialized sucessfully\n";
238 die "Usage:\n fs-setup user\n";
242 # Now it becomes an object. much better.
244 sub tables_hash_hack {
246 #note that s/(date|change)/_$1/; to avoid keyword conflict.
247 #put a kludge in FS::Record to catch this or? (pry need some date-handling
250 my(%tables)=( #yech.}
254 'agentnum', 'int', '', '',
255 'agent', 'varchar', '', $char_d,
256 'typenum', 'int', '', '',
257 'freq', 'int', 'NULL', '',
260 'primary_key' => 'agentnum',
262 'index' => [ ['typenum'] ],
267 'typenum', 'int', '', '',
268 'atype', 'varchar', '', $char_d,
270 'primary_key' => 'typenum',
277 'typenum', 'int', '', '',
278 'pkgpart', 'int', '', '',
281 'unique' => [ ['typenum', 'pkgpart'] ],
282 'index' => [ ['typenum'] ],
287 'invnum', 'int', '', '',
288 'custnum', 'int', '', '',
290 'charged', @money_type,
291 'printed', 'int', '', '',
293 'primary_key' => 'invnum',
295 'index' => [ ['custnum'] ],
300 'pkgnum', 'int', '', '',
301 'invnum', 'int', '', '',
302 'setup', @money_type,
303 'recur', @money_type,
308 'unique' => [ ['pkgnum', 'invnum'] ],
309 'index' => [ ['invnum'] ],
314 'crednum', 'int', '', '',
315 'custnum', 'int', '', '',
317 'amount', @money_type,
318 'otaker', 'varchar', '', 8,
319 'reason', 'varchar', 'NULL', 255,
321 'primary_key' => 'crednum',
323 'index' => [ ['custnum'] ],
326 'cust_credit_bill' => {
328 'creditbillnum', 'int', '', '',
329 'crednum', 'int', '', '',
330 'invnum', 'int', '', '',
332 'amount', @money_type,
334 'primary_key' => 'creditbillnum',
336 'index' => [ ['crednum'], ['invnum'] ],
341 'custnum', 'int', '', '',
342 'agentnum', 'int', '', '',
343 # 'titlenum', 'int', 'NULL', '',
344 'last', 'varchar', '', $char_d,
345 # 'middle', 'varchar', 'NULL', $char_d,
346 'first', 'varchar', '', $char_d,
347 'ss', 'char', 'NULL', 11,
348 'company', 'varchar', 'NULL', $char_d,
349 'address1', 'varchar', '', $char_d,
350 'address2', 'varchar', 'NULL', $char_d,
351 'city', 'varchar', '', $char_d,
352 'county', 'varchar', 'NULL', $char_d,
353 'state', 'varchar', 'NULL', $char_d,
354 'zip', 'varchar', '', 10,
355 'country', 'char', '', 2,
356 'daytime', 'varchar', 'NULL', 20,
357 'night', 'varchar', 'NULL', 20,
358 'fax', 'varchar', 'NULL', 12,
359 'ship_last', 'varchar', 'NULL', $char_d,
360 # 'ship_middle', 'varchar', 'NULL', $char_d,
361 'ship_first', 'varchar', 'NULL', $char_d,
362 'ship_company', 'varchar', 'NULL', $char_d,
363 'ship_address1', 'varchar', 'NULL', $char_d,
364 'ship_address2', 'varchar', 'NULL', $char_d,
365 'ship_city', 'varchar', 'NULL', $char_d,
366 'ship_county', 'varchar', 'NULL', $char_d,
367 'ship_state', 'varchar', 'NULL', $char_d,
368 'ship_zip', 'varchar', 'NULL', 10,
369 'ship_country', 'char', 'NULL', 2,
370 'ship_daytime', 'varchar', 'NULL', 20,
371 'ship_night', 'varchar', 'NULL', 20,
372 'ship_fax', 'varchar', 'NULL', 12,
373 'payby', 'char', '', 4,
374 'payinfo', 'varchar', 'NULL', 16,
375 #'paydate', @date_type,
376 'paydate', 'varchar', 'NULL', 10,
377 'payname', 'varchar', 'NULL', $char_d,
378 'tax', 'char', 'NULL', 1,
379 'otaker', 'varchar', '', 8,
380 'refnum', 'int', '', '',
381 'referral_custnum', 'int', 'NULL', '',
382 'comments', 'varchar', 'NULL', '',
384 'primary_key' => 'custnum',
386 #'index' => [ ['last'], ['company'] ],
387 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ] ],
390 'cust_main_invoice' => {
392 'destnum', 'int', '', '',
393 'custnum', 'int', '', '',
394 'dest', 'varchar', '', $char_d,
396 'primary_key' => 'destnum',
398 'index' => [ ['custnum'], ],
401 'cust_main_county' => { #county+state+country are checked off the
402 #cust_main_county for validation and to provide
405 'taxnum', 'int', '', '',
406 'state', 'varchar', 'NULL', $char_d,
407 'county', 'varchar', 'NULL', $char_d,
408 'country', 'char', '', 2,
409 'tax', 'real', '', '', #tax %
411 'primary_key' => 'taxnum',
413 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
419 'paynum', 'int', '', '',
420 #now cust_bill_pay #'invnum', 'int', '', '',
421 'custnum', 'int', '', '',
424 'payby', 'char', '', 4, # CARD/BILL/COMP, should be index into
425 # payment type table.
426 'payinfo', 'varchar', 'NULL', 16, #see cust_main above
427 'paybatch', 'varchar', 'NULL', $char_d, #for auditing purposes.
429 'primary_key' => 'paynum',
436 'billpaynum', 'int', '', '',
437 'invnum', 'int', '', '',
438 'paynum', 'int', '', '',
439 'amount', @money_type,
442 'primary_key' => 'billpaynum',
444 'index' => [ [ 'paynum', 'invnum' ] ],
447 'cust_pay_batch' => { #what's this used for again? list of customers
448 #in current CARD batch? (necessarily CARD?)
450 'invnum', 'int', '', '',
451 'custnum', 'int', '', '',
452 'last', 'varchar', '', $char_d,
453 'first', 'varchar', '', $char_d,
454 'address1', 'varchar', '', $char_d,
455 'address2', 'varchar', 'NULL', $char_d,
456 'city', 'varchar', '', $char_d,
457 'state', 'varchar', '', $char_d,
458 'zip', 'varchar', '', 10,
459 'country', 'char', '', 2,
460 'trancode', 'int', '', '',
461 'cardnum', 'varchar', '', 16,
463 'exp', 'varchar', '', 11,
464 'payname', 'varchar', 'NULL', $char_d,
465 'amount', @money_type,
469 'index' => [ ['invnum'], ['custnum'] ],
474 'pkgnum', 'int', '', '',
475 'custnum', 'int', '', '',
476 'pkgpart', 'int', '', '',
477 'otaker', 'varchar', '', 8,
481 'cancel', @date_type,
482 'expire', @date_type,
484 'primary_key' => 'pkgnum',
486 'index' => [ ['custnum'] ],
491 'refundnum', 'int', '', '',
492 #now cust_credit_refund #'crednum', 'int', '', '',
493 'custnum', 'int', '', '',
495 'refund', @money_type,
496 'otaker', 'varchar', '', 8,
497 'reason', 'varchar', '', $char_d,
498 'payby', 'char', '', 4, # CARD/BILL/COMP, should be index
499 # into payment type table.
500 'payinfo', 'varchar', 'NULL', 16, #see cust_main above
501 'paybatch', 'varchar', 'NULL', $char_d,
503 'primary_key' => 'refundnum',
508 'cust_credit_refund' => {
510 'creditrefundnum', 'int', '', '',
511 'crednum', 'int', '', '',
512 'refundnum', 'int', '', '',
513 'amount', @money_type,
516 'primary_key' => 'creditrefundnum',
518 'index' => [ [ 'crednum', 'refundnum' ] ],
524 'svcnum', 'int', '', '',
525 'pkgnum', 'int', 'NULL', '',
526 'svcpart', 'int', '', '',
528 'primary_key' => 'svcnum',
530 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
535 'pkgpart', 'int', '', '',
536 'pkg', 'varchar', '', $char_d,
537 'comment', 'varchar', '', $char_d,
539 'freq', 'int', '', '', #billing frequency (months)
542 'primary_key' => 'pkgpart',
549 # 'titlenum', 'int', '', '',
550 # 'title', 'varchar', '', $char_d,
552 # 'primary_key' => 'titlenum',
553 # 'unique' => [ [] ],
559 'pkgpart', 'int', '', '',
560 'svcpart', 'int', '', '',
561 'quantity', 'int', '', '',
564 'unique' => [ ['pkgpart', 'svcpart'] ],
565 'index' => [ ['pkgpart'] ],
570 'refnum', 'int', '', '',
571 'referral', 'varchar', '', $char_d,
573 'primary_key' => 'refnum',
580 'svcpart', 'int', '', '',
581 'svc', 'varchar', '', $char_d,
582 'svcdb', 'varchar', '', $char_d,
584 'primary_key' => 'svcpart',
589 'part_svc_column' => {
591 'columnnum', 'int', '', '',
592 'svcpart', 'int', '', '',
593 'columnname', 'varchar', '', 64,
594 'columnvalue', 'varchar', 'NULL', $char_d,
595 'columnflag', 'char', 'NULL', 1,
597 'primary_key' => 'columnnum',
598 'unique' => [ [ 'svcpart', 'columnname' ] ],
599 'index' => [ [ 'svcpart' ] ],
602 #(this should be renamed to part_pop)
605 'popnum', 'int', '', '',
606 'city', 'varchar', '', $char_d,
607 'state', 'varchar', '', $char_d,
609 'exch', 'char', '', 3,
610 'loc', 'char', 'NULL', 4, #NULL for legacy purposes
612 'primary_key' => 'popnum',
619 'svcnum', 'int', '', '',
620 'username', 'varchar', '', $username_len, #unique (& remove dup code)
621 '_password', 'varchar', '', 50, #13 for encryped pw's plus ' *SUSPENDED* (mp5 passwords can be 34)
622 'popnum', 'int', 'NULL', '',
623 'uid', 'int', 'NULL', '',
624 'gid', 'int', 'NULL', '',
625 'finger', 'varchar', 'NULL', $char_d,
626 'dir', 'varchar', 'NULL', $char_d,
627 'shell', 'varchar', 'NULL', $char_d,
628 'quota', 'varchar', 'NULL', $char_d,
629 'slipip', 'varchar', 'NULL', 15, #four TINYINTs, bah.
630 'seconds', 'int', 'NULL', '', #uhhhh
631 'domsvc', 'int', '', '',
633 'primary_key' => 'svcnum',
634 'unique' => [ [ 'username', 'domsvc' ] ],
635 'index' => [ ['username'], ['domsvc'] ],
640 # 'svcnum', 'int', '', '',
641 # 'domsvc', 'int', '', '',
642 # 'domuid', 'int', '', '',
643 # 'domuser', 'varchar', '', $char_d,
645 # 'primary_key' => 'svcnum',
646 # 'unique' => [ [] ],
647 # 'index' => [ ['domsvc'], ['domuid'] ],
652 # 'svcnum', 'int', '', '',
653 # 'amount', @money_type,
655 # 'primary_key' => 'svcnum',
656 # 'unique' => [ [] ],
662 'svcnum', 'int', '', '',
663 'domain', 'varchar', '', $char_d,
664 'catchall', 'int', 'NULL', '',
666 'primary_key' => 'svcnum',
667 'unique' => [ ['domain'] ],
673 'recnum', 'int', '', '',
674 'svcnum', 'int', '', '',
675 'reczone', 'varchar', '', $char_d,
676 'recaf', 'char', '', 2,
677 'rectype', 'char', '', 5,
678 'recdata', 'varchar', '', $char_d,
680 'primary_key' => 'recnum',
682 'index' => [ ['svcnum'] ],
687 'svcnum', 'int', '', '',
688 'srcsvc', 'int', '', '',
689 'dstsvc', 'int', '', '',
690 'dst', 'varchar', 'NULL', $char_d,
692 'primary_key' => 'svcnum',
694 'index' => [ ['srcsvc'], ['dstsvc'] ],
699 'svcnum', 'int', '', '',
700 'recnum', 'int', '', '',
701 'usersvc', 'int', '', '',
703 'primary_key' => 'svcnum',
710 # 'svcnum', 'int', '', '',
711 # 'svcnum', 'int', '', '',
712 # 'svcnum', 'int', '', '',
713 # 'worker', 'varchar', '', $char_d,
714 # '_date', @date_type,
716 # 'primary_key' => 'svcnum',
717 # 'unique' => [ [] ],
723 'prepaynum', 'int', '', '',
724 'identifier', 'varchar', '', $char_d,
725 'amount', @money_type,
726 'seconds', 'int', 'NULL', '',
728 'primary_key' => 'prepaynum',
729 'unique' => [ ['identifier'] ],
735 'portnum', 'int', '', '',
736 'ip', 'varchar', 'NULL', 15,
737 'nasport', 'int', 'NULL', '',
738 'nasnum', 'int', '', '',
740 'primary_key' => 'portnum',
747 'nasnum', 'int', '', '',
748 'nas', 'varchar', '', $char_d,
749 'nasip', 'varchar', '', 15,
750 'nasfqdn', 'varchar', '', $char_d,
751 'last', 'int', '', '',
753 'primary_key' => 'nasnum',
754 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
755 'index' => [ [ 'last' ] ],
760 'sessionnum', 'int', '', '',
761 'portnum', 'int', '', '',
762 'svcnum', 'int', '', '',
764 'logout', @date_type,
766 'primary_key' => 'sessionnum',
768 'index' => [ [ 'portnum' ] ],
773 'jobnum', 'int', '', '',
774 'job', 'varchar', '', '',
775 '_date', 'int', '', '',
776 'status', 'varchar', '', $char_d,
778 'primary_key' => 'jobnum',
785 'argnum', 'int', '', '',
786 'jobnum', 'int', '', '',
787 'arg', 'varchar', 'NULL', '',
789 'primary_key' => 'argnum',
791 'index' => [ [ 'jobnum' ] ],