3 # $Id: fs-setup,v 1.67 2001-11-06 17:48:17 ivan Exp $
5 #to delay loading dbdef until we're ready
6 BEGIN { $FS::Record::setup_hack = 1; }
10 use DBIx::DBSchema 0.19;
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;
35 my $username_len = 32; #usernamemax config file
37 print "\n\n", <<END, ":";
38 Freeside tracks the RADIUS User-Name, check attribute Password and
39 reply attribute Framed-IP-Address for each user. You can specify additional
40 check and reply attributes (or you can add them later with the
41 fs-radius-add-check and fs-radius-add-reply programs).
43 First enter any additional RADIUS check attributes you need to track for each
44 user, separated by whitespace.
46 my @check_attributes = map { $attrib2db{lc($_)} or die "unknown attribute $_"; }
49 print "\n\n", <<END, ":";
50 Now enter any additional reply attributes you need to track for each user,
51 separated by whitespace.
53 my @attributes = map { $attrib2db{lc($_)} or die "unknown attribute $_"; }
56 print "\n\n", <<END, ":";
57 Do you wish to enable the tracking of a second, separate shipping/service
63 my($x)=scalar(<STDIN>);
70 my $x = scalar(<STDIN>);
76 my($char_d) = 80; #default maxlength for text fields
78 #my(@date_type) = ( 'timestamp', '', '' );
79 my(@date_type) = ( 'int', 'NULL', '' );
80 my(@perl_type) = ( 'text', 'NULL', '' );
81 my @money_type = ( 'decimal', '', '10,2' );
84 # create a dbdef object from the old data structure
87 my(%tables)=&tables_hash_hack;
90 my($dbdef) = new DBIx::DBSchema ( map {
92 while (@{$tables{$_}{'columns'}}) {
93 my($name,$type,$null,$length)=splice @{$tables{$_}{'columns'}}, 0, 4;
94 push @columns, new DBIx::DBSchema::Column ( $name,$type,$null,$length );
96 DBIx::DBSchema::Table->new(
98 $tables{$_}{'primary_key'},
99 DBIx::DBSchema::ColGroup::Unique->new($tables{$_}{'unique'}),
100 DBIx::DBSchema::ColGroup::Index->new($tables{$_}{'index'}),
105 my $cust_main = $dbdef->table('cust_main');
106 unless ($ship) { #remove ship_ from cust_main
107 $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
108 } else { #add indices on ship_last and ship_company
109 push @{$cust_main->index->lol_ref}, ( ['ship_last'], ['ship_company'] )
112 #add radius attributes to svc_acct
114 my($svc_acct)=$dbdef->table('svc_acct');
117 foreach $attribute (@attributes) {
118 $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
119 'radius_'. $attribute,
126 foreach $attribute (@check_attributes) {
127 $svc_acct->addcolumn( new DBIx::DBSchema::Column (
135 ##make part_svc table (but now as object)
137 #my($part_svc)=$dbdef->table('part_svc');
139 ##because of svc_acct_pop
140 ##foreach (grep /^svc_/, $dbdef->tables) {
141 ##foreach (qw(svc_acct svc_acct_sm svc_charge svc_domain svc_wo)) {
142 #foreach (qw(svc_acct svc_domain svc_forward svc_www)) {
143 # my($table)=$dbdef->table($_);
145 # foreach $col ( $table->columns ) {
146 # next if $col =~ /^svcnum$/;
147 # $part_svc->addcolumn( new DBIx::DBSchema::Column (
148 # $table->name. '__' . $table->column($col)->name,
149 # 'varchar', #$table->column($col)->type,
151 # $char_d, #$table->column($col)->length,
153 # $part_svc->addcolumn ( new DBIx::DBSchema::Column (
154 # $table->name. '__'. $table->column($col)->name . "_flag",
163 $dbdef->save($dbdef_file);
164 &FS::Record::reload_dbdef($dbdef_file);
170 my($dbh)=adminsuidsetup $user;
175 my @sql = $dbdef->sql($dbh);
176 foreach my $statement ( $dbdef->sql($dbh) ) {
177 $dbh->do( $statement )
178 or die "CREATE error: ",$dbh->errstr, "\ndoing statement: $statement";
181 #not really sample data (and shouldn't default to US)
187 AL AK AS AZ AR CA CO CT DC DE FM FL GA GU HI ID IL IN IA KS KY LA
188 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
189 SC SD TN TX UT VT VI VA WA WV WI WY AE AA AP
191 my($cust_main_county)=new FS::cust_main_county({
197 $error=$cust_main_county->insert;
198 die $error if $error;
201 #AU "offical" state codes ala mark.williamson@ebbs.com.au (Mark Williamson)
203 VIC NSW NT QLD TAS ACT WA SA
205 my($cust_main_county)=new FS::cust_main_county({
211 $error=$cust_main_county->insert;
212 die $error if $error;
215 #ISO 2-letter country codes (same as country TLDs) except US and AU
217 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
218 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
219 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
220 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
221 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
222 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
223 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
224 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
225 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
228 my($cust_main_county)=new FS::cust_main_county({
233 $error=$cust_main_county->insert;
234 die $error if $error;
237 $dbh->disconnect or die $dbh->errstr;
239 print "Freeside database initialized sucessfully\n";
242 die "Usage:\n fs-setup user\n";
246 # Now it becomes an object. much better.
248 sub tables_hash_hack {
250 #note that s/(date|change)/_$1/; to avoid keyword conflict.
251 #put a kludge in FS::Record to catch this or? (pry need some date-handling
254 my(%tables)=( #yech.}
258 'agentnum', 'int', '', '',
259 'agent', 'varchar', '', $char_d,
260 'typenum', 'int', '', '',
261 'freq', 'int', 'NULL', '',
264 'primary_key' => 'agentnum',
266 'index' => [ ['typenum'] ],
271 'typenum', 'int', '', '',
272 'atype', 'varchar', '', $char_d,
274 'primary_key' => 'typenum',
281 'typenum', 'int', '', '',
282 'pkgpart', 'int', '', '',
285 'unique' => [ ['typenum', 'pkgpart'] ],
286 'index' => [ ['typenum'] ],
291 'invnum', 'int', '', '',
292 'custnum', 'int', '', '',
294 'charged', @money_type,
295 'printed', 'int', '', '',
297 'primary_key' => 'invnum',
299 'index' => [ ['custnum'] ],
304 'pkgnum', 'int', '', '',
305 'invnum', 'int', '', '',
306 'setup', @money_type,
307 'recur', @money_type,
312 'unique' => [ ['pkgnum', 'invnum'] ],
313 'index' => [ ['invnum'] ],
318 'crednum', 'int', '', '',
319 'custnum', 'int', '', '',
321 'amount', @money_type,
322 'otaker', 'varchar', '', 8,
323 'reason', 'text', 'NULL', '',
325 'primary_key' => 'crednum',
327 'index' => [ ['custnum'] ],
330 'cust_credit_bill' => {
332 'creditbillnum', 'int', '', '',
333 'crednum', 'int', '', '',
334 'invnum', 'int', '', '',
336 'amount', @money_type,
338 'primary_key' => 'creditbillnum',
340 'index' => [ ['crednum'], ['invnum'] ],
345 'custnum', 'int', '', '',
346 'agentnum', 'int', '', '',
347 # 'titlenum', 'int', 'NULL', '',
348 'last', 'varchar', '', $char_d,
349 # 'middle', 'varchar', 'NULL', $char_d,
350 'first', 'varchar', '', $char_d,
351 'ss', 'char', 'NULL', 11,
352 'company', 'varchar', 'NULL', $char_d,
353 'address1', 'varchar', '', $char_d,
354 'address2', 'varchar', 'NULL', $char_d,
355 'city', 'varchar', '', $char_d,
356 'county', 'varchar', 'NULL', $char_d,
357 'state', 'varchar', 'NULL', $char_d,
358 'zip', 'varchar', '', 10,
359 'country', 'char', '', 2,
360 'daytime', 'varchar', 'NULL', 20,
361 'night', 'varchar', 'NULL', 20,
362 'fax', 'varchar', 'NULL', 12,
363 'ship_last', 'varchar', 'NULL', $char_d,
364 # 'ship_middle', 'varchar', 'NULL', $char_d,
365 'ship_first', 'varchar', 'NULL', $char_d,
366 'ship_company', 'varchar', 'NULL', $char_d,
367 'ship_address1', 'varchar', 'NULL', $char_d,
368 'ship_address2', 'varchar', 'NULL', $char_d,
369 'ship_city', 'varchar', 'NULL', $char_d,
370 'ship_county', 'varchar', 'NULL', $char_d,
371 'ship_state', 'varchar', 'NULL', $char_d,
372 'ship_zip', 'varchar', 'NULL', 10,
373 'ship_country', 'char', 'NULL', 2,
374 'ship_daytime', 'varchar', 'NULL', 20,
375 'ship_night', 'varchar', 'NULL', 20,
376 'ship_fax', 'varchar', 'NULL', 12,
377 'payby', 'char', '', 4,
378 'payinfo', 'varchar', 'NULL', $char_d,
379 #'paydate', @date_type,
380 'paydate', 'varchar', 'NULL', 10,
381 'payname', 'varchar', 'NULL', $char_d,
382 'tax', 'char', 'NULL', 1,
383 'otaker', 'varchar', '', 8,
384 'refnum', 'int', '', '',
385 'referral_custnum', 'int', 'NULL', '',
386 'comments', 'text', 'NULL', '',
388 'primary_key' => 'custnum',
390 #'index' => [ ['last'], ['company'] ],
391 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ] ],
394 'cust_main_invoice' => {
396 'destnum', 'int', '', '',
397 'custnum', 'int', '', '',
398 'dest', 'varchar', '', $char_d,
400 'primary_key' => 'destnum',
402 'index' => [ ['custnum'], ],
405 'cust_main_county' => { #county+state+country are checked off the
406 #cust_main_county for validation and to provide
409 'taxnum', 'int', '', '',
410 'state', 'varchar', 'NULL', $char_d,
411 'county', 'varchar', 'NULL', $char_d,
412 'country', 'char', '', 2,
413 'tax', 'real', '', '', #tax %
415 'primary_key' => 'taxnum',
417 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
423 'paynum', 'int', '', '',
424 #now cust_bill_pay #'invnum', 'int', '', '',
425 'custnum', 'int', '', '',
428 'payby', 'char', '', 4, # CARD/BILL/COMP, should be index into
429 # payment type table.
430 'payinfo', 'varchar', 'NULL', 16, #see cust_main above
431 'paybatch', 'varchar', 'NULL', $char_d, #for auditing purposes.
433 'primary_key' => 'paynum',
440 'billpaynum', 'int', '', '',
441 'invnum', 'int', '', '',
442 'paynum', 'int', '', '',
443 'amount', @money_type,
446 'primary_key' => 'billpaynum',
448 'index' => [ [ 'paynum', 'invnum' ] ],
451 'cust_pay_batch' => { #what's this used for again? list of customers
452 #in current CARD batch? (necessarily CARD?)
454 'paybatchnum', 'int', '', '',
455 'invnum', 'int', '', '',
456 'custnum', 'int', '', '',
457 'last', 'varchar', '', $char_d,
458 'first', 'varchar', '', $char_d,
459 'address1', 'varchar', '', $char_d,
460 'address2', 'varchar', 'NULL', $char_d,
461 'city', 'varchar', '', $char_d,
462 'state', 'varchar', '', $char_d,
463 'zip', 'varchar', '', 10,
464 'country', 'char', '', 2,
465 # 'trancode', 'int', '', '',
466 'cardnum', 'varchar', '', 16,
468 'exp', 'varchar', '', 11,
469 'payname', 'varchar', 'NULL', $char_d,
470 'amount', @money_type,
472 'primary_key' => 'paybatchnum',
474 'index' => [ ['invnum'], ['custnum'] ],
479 'pkgnum', 'int', '', '',
480 'custnum', 'int', '', '',
481 'pkgpart', 'int', '', '',
482 'otaker', 'varchar', '', 8,
486 'cancel', @date_type,
487 'expire', @date_type,
488 'manual_flag', 'char', 'NULL', 1,
490 'primary_key' => 'pkgnum',
492 'index' => [ ['custnum'] ],
497 'refundnum', 'int', '', '',
498 #now cust_credit_refund #'crednum', 'int', '', '',
499 'custnum', 'int', '', '',
501 'refund', @money_type,
502 'otaker', 'varchar', '', 8,
503 'reason', 'varchar', '', $char_d,
504 'payby', 'char', '', 4, # CARD/BILL/COMP, should be index
505 # into payment type table.
506 'payinfo', 'varchar', 'NULL', 16, #see cust_main above
507 'paybatch', 'varchar', 'NULL', $char_d,
509 'primary_key' => 'refundnum',
514 'cust_credit_refund' => {
516 'creditrefundnum', 'int', '', '',
517 'crednum', 'int', '', '',
518 'refundnum', 'int', '', '',
519 'amount', @money_type,
522 'primary_key' => 'creditrefundnum',
524 'index' => [ [ 'crednum', 'refundnum' ] ],
530 'svcnum', 'int', '', '',
531 'pkgnum', 'int', 'NULL', '',
532 'svcpart', 'int', '', '',
534 'primary_key' => 'svcnum',
536 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
541 'pkgpart', 'int', '', '',
542 'pkg', 'varchar', '', $char_d,
543 'comment', 'varchar', '', $char_d,
545 'freq', 'int', '', '', #billing frequency (months)
547 'setuptax', 'char', 'NULL', 1,
548 'recurtax', 'char', 'NULL', 1,
549 'plan', 'varchar', 'NULL', $char_d,
550 'plandata', 'text', 'NULL', '',
552 'primary_key' => 'pkgpart',
559 # 'titlenum', 'int', '', '',
560 # 'title', 'varchar', '', $char_d,
562 # 'primary_key' => 'titlenum',
563 # 'unique' => [ [] ],
569 'pkgpart', 'int', '', '',
570 'svcpart', 'int', '', '',
571 'quantity', 'int', '', '',
574 'unique' => [ ['pkgpart', 'svcpart'] ],
575 'index' => [ ['pkgpart'] ],
580 'refnum', 'int', '', '',
581 'referral', 'varchar', '', $char_d,
583 'primary_key' => 'refnum',
590 'svcpart', 'int', '', '',
591 'svc', 'varchar', '', $char_d,
592 'svcdb', 'varchar', '', $char_d,
594 'primary_key' => 'svcpart',
599 'part_svc_column' => {
601 'columnnum', 'int', '', '',
602 'svcpart', 'int', '', '',
603 'columnname', 'varchar', '', 64,
604 'columnvalue', 'varchar', 'NULL', $char_d,
605 'columnflag', 'char', 'NULL', 1,
607 'primary_key' => 'columnnum',
608 'unique' => [ [ 'svcpart', 'columnname' ] ],
609 'index' => [ [ 'svcpart' ] ],
612 #(this should be renamed to part_pop)
615 'popnum', 'int', '', '',
616 'city', 'varchar', '', $char_d,
617 'state', 'varchar', '', $char_d,
619 'exch', 'char', '', 3,
620 'loc', 'char', 'NULL', 4, #NULL for legacy purposes
622 'primary_key' => 'popnum',
624 'index' => [ [ 'state' ] ],
627 'part_pop_local' => {
629 'localnum', 'int', '', '',
630 'popnum', 'int', '', '',
631 'city', 'varchar', 'NULL', $char_d,
632 'state', 'char', 'NULL', 2,
633 'npa', 'char', '', 3,
634 'nxx', 'char', '', 3,
636 'primary_key' => 'popnum',
638 'index' => [ [ 'npa', 'nxx' ] ],
643 'svcnum', 'int', '', '',
644 'username', 'varchar', '', $username_len, #unique (& remove dup code)
645 '_password', 'varchar', '', 50, #13 for encryped pw's plus ' *SUSPENDED* (mp5 passwords can be 34)
646 'popnum', 'int', 'NULL', '',
647 'uid', 'int', 'NULL', '',
648 'gid', 'int', 'NULL', '',
649 'finger', 'varchar', 'NULL', $char_d,
650 'dir', 'varchar', 'NULL', $char_d,
651 'shell', 'varchar', 'NULL', $char_d,
652 'quota', 'varchar', 'NULL', $char_d,
653 'slipip', 'varchar', 'NULL', 15, #four TINYINTs, bah.
654 'seconds', 'int', 'NULL', '', #uhhhh
655 'domsvc', 'int', '', '',
657 'primary_key' => 'svcnum',
658 'unique' => [ [ 'username', 'domsvc' ] ],
659 'index' => [ ['username'], ['domsvc'] ],
664 # 'svcnum', 'int', '', '',
665 # 'domsvc', 'int', '', '',
666 # 'domuid', 'int', '', '',
667 # 'domuser', 'varchar', '', $char_d,
669 # 'primary_key' => 'svcnum',
670 # 'unique' => [ [] ],
671 # 'index' => [ ['domsvc'], ['domuid'] ],
676 # 'svcnum', 'int', '', '',
677 # 'amount', @money_type,
679 # 'primary_key' => 'svcnum',
680 # 'unique' => [ [] ],
686 'svcnum', 'int', '', '',
687 'domain', 'varchar', '', $char_d,
688 'catchall', 'int', 'NULL', '',
690 'primary_key' => 'svcnum',
691 'unique' => [ ['domain'] ],
697 'recnum', 'int', '', '',
698 'svcnum', 'int', '', '',
699 'reczone', 'varchar', '', $char_d,
700 'recaf', 'char', '', 2,
701 'rectype', 'char', '', 5,
702 'recdata', 'varchar', '', $char_d,
704 'primary_key' => 'recnum',
706 'index' => [ ['svcnum'] ],
711 'svcnum', 'int', '', '',
712 'srcsvc', 'int', '', '',
713 'dstsvc', 'int', '', '',
714 'dst', 'varchar', 'NULL', $char_d,
716 'primary_key' => 'svcnum',
718 'index' => [ ['srcsvc'], ['dstsvc'] ],
723 'svcnum', 'int', '', '',
724 'recnum', 'int', '', '',
725 'usersvc', 'int', '', '',
727 'primary_key' => 'svcnum',
734 # 'svcnum', 'int', '', '',
735 # 'svcnum', 'int', '', '',
736 # 'svcnum', 'int', '', '',
737 # 'worker', 'varchar', '', $char_d,
738 # '_date', @date_type,
740 # 'primary_key' => 'svcnum',
741 # 'unique' => [ [] ],
747 'prepaynum', 'int', '', '',
748 'identifier', 'varchar', '', $char_d,
749 'amount', @money_type,
750 'seconds', 'int', 'NULL', '',
752 'primary_key' => 'prepaynum',
753 'unique' => [ ['identifier'] ],
759 'portnum', 'int', '', '',
760 'ip', 'varchar', 'NULL', 15,
761 'nasport', 'int', 'NULL', '',
762 'nasnum', 'int', '', '',
764 'primary_key' => 'portnum',
771 'nasnum', 'int', '', '',
772 'nas', 'varchar', '', $char_d,
773 'nasip', 'varchar', '', 15,
774 'nasfqdn', 'varchar', '', $char_d,
775 'last', 'int', '', '',
777 'primary_key' => 'nasnum',
778 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
779 'index' => [ [ 'last' ] ],
784 'sessionnum', 'int', '', '',
785 'portnum', 'int', '', '',
786 'svcnum', 'int', '', '',
788 'logout', @date_type,
790 'primary_key' => 'sessionnum',
792 'index' => [ [ 'portnum' ] ],
797 'jobnum', 'int', '', '',
798 'job', 'text', '', '',
799 '_date', 'int', '', '',
800 'status', 'varchar', '', $char_d,
802 'primary_key' => 'jobnum',
809 'argnum', 'int', '', '',
810 'jobnum', 'int', '', '',
811 'arg', 'text', 'NULL', '',
813 'primary_key' => 'argnum',
815 'index' => [ [ 'jobnum' ] ],