3 # $Id: fs-setup,v 1.51 2001-09-04 11:14:13 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;
19 die "Not running uid freeside!" unless checkeuid();
21 my $user = shift or die &usage;
24 #needs to match FS::Record
25 my($dbdef_file) = "/usr/local/etc/freeside/dbdef.". datasrc;
29 print "\nEnter the maximum username length: ";
30 my($username_len)=&getvalue;
32 print "\n\n", <<END, ":";
33 Freeside tracks the RADIUS attributes User-Name, check attribute Password and
34 reply attribute Framed-IP-Address for each user. You can specify additional
35 check and reply attributes. First enter any additional RADIUS check attributes
36 you need to track for each user, separated by whitespace.
38 my @check_attributes = map { s/\-/_/g; $_; } split(" ",&getvalue);
40 print "\n\n", <<END, ":";
41 Now enter any additional reply attributes you need to track for each user,
42 separated by whitespace.
44 my @attributes = map { s/\-/_/g; $_; } split(" ",&getvalue);
46 print "\n\n", <<END, ":";
47 Do you wish to enable the tracking of a second, separate shipping/service
53 my($x)=scalar(<STDIN>);
60 my $x = scalar(<STDIN>);
66 my($char_d) = 80; #default maxlength for text fields
68 #my(@date_type) = ( 'timestamp', '', '' );
69 my(@date_type) = ( 'int', 'NULL', '' );
70 my(@perl_type) = ( 'varchar', 'NULL', 255 );
71 my @money_type = ( 'decimal', '', '10,2' );
74 # create a dbdef object from the old data structure
77 my(%tables)=&tables_hash_hack;
80 my($dbdef) = new DBIx::DBSchema ( map {
83 warn $tables{$_}{'columns'};
84 while (@{$tables{$_}{'columns'}}) {
85 my($name,$type,$null,$length)=splice @{$tables{$_}{'columns'}}, 0, 4;
86 push @columns, new DBIx::DBSchema::Column ( $name,$type,$null,$length );
88 DBIx::DBSchema::Table->new(
90 $tables{$_}{'primary_key'},
91 DBIx::DBSchema::ColGroup::Unique->new($tables{$_}{'unique'}),
92 DBIx::DBSchema::ColGroup::Index->new($tables{$_}{'index'}),
97 my $cust_main = $dbdef->table('cust_main');
98 unless ($ship) { #remove ship_ from cust_main
99 $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
100 } else { #add indices on ship_last and ship_company
101 push @{$cust_main->index->lol_ref}, ( ['ship_last'], ['ship_company'] )
104 #add radius attributes to svc_acct
106 my($svc_acct)=$dbdef->table('svc_acct');
109 foreach $attribute (@attributes) {
110 $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
111 'radius_'. $attribute,
118 foreach $attribute (@check_attributes) {
119 $svc_acct->addcolumn( new DBIx::DBSchema::Column (
127 #make part_svc table (but now as object)
129 my($part_svc)=$dbdef->table('part_svc');
131 #because of svc_acct_pop
132 #foreach (grep /^svc_/, $dbdef->tables) {
133 #foreach (qw(svc_acct svc_acct_sm svc_charge svc_domain svc_wo)) {
134 foreach (qw(svc_acct svc_domain svc_forward svc_www)) {
135 my($table)=$dbdef->table($_);
137 foreach $col ( $table->columns ) {
138 next if $col =~ /^svcnum$/;
139 $part_svc->addcolumn( new DBIx::DBSchema::Column (
140 $table->name. '__' . $table->column($col)->name,
141 'varchar', #$table->column($col)->type,
143 $char_d, #$table->column($col)->length,
145 $part_svc->addcolumn ( new DBIx::DBSchema::Column (
146 $table->name. '__'. $table->column($col)->name . "_flag",
155 $dbdef->save($dbdef_file);
156 &FS::Record::reload_dbdef($dbdef_file);
162 my($dbh)=adminsuidsetup $user;
167 my @sql = $dbdef->sql($dbh);
168 foreach my $statement ( $dbdef->sql($dbh) ) {
169 $dbh->do( $statement )
170 or die "CREATE error: ",$dbh->errstr, "\ndoing statement: $statement";
173 #not really sample data (and shouldn't default to US)
179 AL AK AS AZ AR CA CO CT DC DE FM FL GA GU HI ID IL IN IA KS KY LA
180 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
181 SC SD TN TX UT VT VI VA WA WV WI WY AE AA AP
183 my($cust_main_county)=new FS::cust_main_county({
189 $error=$cust_main_county->insert;
190 die $error if $error;
193 #AU "offical" state codes ala mark.williamson@ebbs.com.au (Mark Williamson)
195 VIC NSW NT QLD TAS ACT WA SA
197 my($cust_main_county)=new FS::cust_main_county({
203 $error=$cust_main_county->insert;
204 die $error if $error;
207 #ISO 2-letter country codes (same as country TLDs) except US and AU
209 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
210 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
211 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
212 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
213 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
214 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
215 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
216 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
217 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
220 my($cust_main_county)=new FS::cust_main_county({
225 $error=$cust_main_county->insert;
226 die $error if $error;
229 $dbh->disconnect or die $dbh->errstr;
231 print "Freeside database initialized sucessfully\n";
234 die "Usage:\n fs-setup user\n";
238 # Now it becomes an object. much better.
240 sub tables_hash_hack {
242 #note that s/(date|change)/_$1/; to avoid keyword conflict.
243 #put a kludge in FS::Record to catch this or? (pry need some date-handling
246 my(%tables)=( #yech.}
250 'agentnum', 'int', '', '',
251 'agent', 'varchar', '', $char_d,
252 'typenum', 'int', '', '',
253 'freq', 'int', 'NULL', '',
256 'primary_key' => 'agentnum',
258 'index' => [ ['typenum'] ],
263 'typenum', 'int', '', '',
264 'atype', 'varchar', '', $char_d,
266 'primary_key' => 'typenum',
273 'typenum', 'int', '', '',
274 'pkgpart', 'int', '', '',
277 'unique' => [ ['typenum', 'pkgpart'] ],
278 'index' => [ ['typenum'] ],
283 'invnum', 'int', '', '',
284 'custnum', 'int', '', '',
286 'charged', @money_type,
287 'printed', 'int', '', '',
289 'primary_key' => 'invnum',
291 'index' => [ ['custnum'] ],
296 'pkgnum', 'int', '', '',
297 'invnum', 'int', '', '',
298 'setup', @money_type,
299 'recur', @money_type,
304 'unique' => [ ['pkgnum', 'invnum'] ],
305 'index' => [ ['invnum'] ],
310 'crednum', 'int', '', '',
311 'custnum', 'int', '', '',
313 'amount', @money_type,
314 'otaker', 'varchar', '', 8,
315 'reason', 'varchar', 'NULL', 255,
317 'primary_key' => 'crednum',
319 'index' => [ ['custnum'] ],
322 'cust_credit_bill' => {
324 'creditbillnum', 'int', '', '',
325 'crednum', 'int', '', '',
326 'invnum', 'int', '', '',
328 'amount', @money_type,
330 'primary_key' => 'creditbillnum',
332 'index' => [ ['crednum'], ['invnum'] ],
337 'custnum', 'int', '', '',
338 'agentnum', 'int', '', '',
339 # 'titlenum', 'int', 'NULL', '',
340 'last', 'varchar', '', $char_d,
341 # 'middle', 'varchar', 'NULL', $char_d,
342 'first', 'varchar', '', $char_d,
343 'ss', 'char', 'NULL', 11,
344 'company', 'varchar', 'NULL', $char_d,
345 'address1', 'varchar', '', $char_d,
346 'address2', 'varchar', 'NULL', $char_d,
347 'city', 'varchar', '', $char_d,
348 'county', 'varchar', 'NULL', $char_d,
349 'state', 'varchar', 'NULL', $char_d,
350 'zip', 'varchar', '', 10,
351 'country', 'char', '', 2,
352 'daytime', 'varchar', 'NULL', 20,
353 'night', 'varchar', 'NULL', 20,
354 'fax', 'varchar', 'NULL', 12,
355 'ship_last', 'varchar', 'NULL', $char_d,
356 # 'ship_middle', 'varchar', 'NULL', $char_d,
357 'ship_first', 'varchar', 'NULL', $char_d,
358 'ship_company', 'varchar', 'NULL', $char_d,
359 'ship_address1', 'varchar', 'NULL', $char_d,
360 'ship_address2', 'varchar', 'NULL', $char_d,
361 'ship_city', 'varchar', 'NULL', $char_d,
362 'ship_county', 'varchar', 'NULL', $char_d,
363 'ship_state', 'varchar', 'NULL', $char_d,
364 'ship_zip', 'varchar', 'NULL', 10,
365 'ship_country', 'char', 'NULL', 2,
366 'ship_daytime', 'varchar', 'NULL', 20,
367 'ship_night', 'varchar', 'NULL', 20,
368 'ship_fax', 'varchar', 'NULL', 12,
369 'payby', 'char', '', 4,
370 'payinfo', 'varchar', 'NULL', 16,
371 #'paydate', @date_type,
372 'paydate', 'varchar', 'NULL', 10,
373 'payname', 'varchar', 'NULL', $char_d,
374 'tax', 'char', 'NULL', 1,
375 'otaker', 'varchar', '', 8,
376 'refnum', 'int', '', '',
377 'referral_custnum', 'int', 'NULL', '',
378 'comments', 'varchar', 'NULL', '',
380 'primary_key' => 'custnum',
382 #'index' => [ ['last'], ['company'] ],
383 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ] ],
386 'cust_main_invoice' => {
388 'destnum', 'int', '', '',
389 'custnum', 'int', '', '',
390 'dest', 'varchar', '', $char_d,
392 'primary_key' => 'destnum',
394 'index' => [ ['custnum'], ],
397 'cust_main_county' => { #county+state+country are checked off the
398 #cust_main_county for validation and to provide
401 'taxnum', 'int', '', '',
402 'state', 'varchar', 'NULL', $char_d,
403 'county', 'varchar', 'NULL', $char_d,
404 'country', 'char', '', 2,
405 'tax', 'real', '', '', #tax %
407 'primary_key' => 'taxnum',
409 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
415 'paynum', 'int', '', '',
416 #now cust_bill_pay #'invnum', 'int', '', '',
417 'custnum', 'int', '', '',
420 'payby', 'char', '', 4, # CARD/BILL/COMP, should be index into
421 # payment type table.
422 'payinfo', 'varchar', 'NULL', 16, #see cust_main above
423 'paybatch', 'varchar', 'NULL', $char_d, #for auditing purposes.
425 'primary_key' => 'paynum',
432 'billpaynum', 'int', '', '',
433 'invnum', 'int', '', '',
434 'paynum', 'int', '', '',
435 'amount', @money_type,
438 'primary_key' => 'billpaynum',
440 'index' => [ [ 'paynum', 'invnum' ] ],
443 'cust_pay_batch' => { #what's this used for again? list of customers
444 #in current CARD batch? (necessarily CARD?)
446 'invnum', 'int', '', '',
447 'custnum', 'int', '', '',
448 'last', 'varchar', '', $char_d,
449 'first', 'varchar', '', $char_d,
450 'address1', 'varchar', '', $char_d,
451 'address2', 'varchar', 'NULL', $char_d,
452 'city', 'varchar', '', $char_d,
453 'state', 'varchar', '', $char_d,
454 'zip', 'varchar', '', 10,
455 'country', 'char', '', 2,
456 'trancode', 'int', '', '',
457 'cardnum', 'varchar', '', 16,
459 'exp', 'varchar', '', 11,
460 'payname', 'varchar', 'NULL', $char_d,
461 'amount', @money_type,
465 'index' => [ ['invnum'], ['custnum'] ],
470 'pkgnum', 'int', '', '',
471 'custnum', 'int', '', '',
472 'pkgpart', 'int', '', '',
473 'otaker', 'varchar', '', 8,
477 'cancel', @date_type,
478 'expire', @date_type,
480 'primary_key' => 'pkgnum',
482 'index' => [ ['custnum'] ],
487 'refundnum', 'int', '', '',
488 #now cust_credit_refund #'crednum', 'int', '', '',
489 'custnum', 'int', '', '',
491 'refund', @money_type,
492 'otaker', 'varchar', '', 8,
493 'reason', 'varchar', '', $char_d,
494 'payby', 'char', '', 4, # CARD/BILL/COMP, should be index
495 # into payment type table.
496 'payinfo', 'varchar', 'NULL', 16, #see cust_main above
497 'paybatch', 'varchar', 'NULL', $char_d,
499 'primary_key' => 'refundnum',
504 'cust_credit_refund' => {
506 'creditrefundnum', 'int', '', '',
507 'crednum', 'int', '', '',
508 'refundnum', 'int', '', '',
509 'amount', @money_type,
512 'primary_key' => 'creditrefundnum',
514 'index' => [ [ 'crednum', 'refundnum' ] ],
520 'svcnum', 'int', '', '',
521 'pkgnum', 'int', 'NULL', '',
522 'svcpart', 'int', '', '',
524 'primary_key' => 'svcnum',
526 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
531 'pkgpart', 'int', '', '',
532 'pkg', 'varchar', '', $char_d,
533 'comment', 'varchar', '', $char_d,
535 'freq', 'int', '', '', #billing frequency (months)
538 'primary_key' => 'pkgpart',
545 # 'titlenum', 'int', '', '',
546 # 'title', 'varchar', '', $char_d,
548 # 'primary_key' => 'titlenum',
549 # 'unique' => [ [] ],
555 'pkgpart', 'int', '', '',
556 'svcpart', 'int', '', '',
557 'quantity', 'int', '', '',
560 'unique' => [ ['pkgpart', 'svcpart'] ],
561 'index' => [ ['pkgpart'] ],
566 'refnum', 'int', '', '',
567 'referral', 'varchar', '', $char_d,
569 'primary_key' => 'refnum',
576 'svcpart', 'int', '', '',
577 'svc', 'varchar', '', $char_d,
578 'svcdb', 'varchar', '', $char_d,
580 'primary_key' => 'svcpart',
585 #(this should be renamed to part_pop)
588 'popnum', 'int', '', '',
589 'city', 'varchar', '', $char_d,
590 'state', 'varchar', '', $char_d,
592 'exch', 'char', '', 3,
593 'loc', 'char', 'NULL', 4, #NULL for legacy purposes
595 'primary_key' => 'popnum',
602 'svcnum', 'int', '', '',
603 'username', 'varchar', '', $username_len, #unique (& remove dup code)
604 '_password', 'varchar', '', 50, #13 for encryped pw's plus ' *SUSPENDED* (mp5 passwords can be 34)
605 'popnum', 'int', 'NULL', '',
606 'uid', 'int', 'NULL', '',
607 'gid', 'int', 'NULL', '',
608 'finger', 'varchar', 'NULL', $char_d,
609 'dir', 'varchar', 'NULL', $char_d,
610 'shell', 'varchar', 'NULL', $char_d,
611 'quota', 'varchar', 'NULL', $char_d,
612 'slipip', 'varchar', 'NULL', 15, #four TINYINTs, bah.
613 'seconds', 'int', 'NULL', '', #uhhhh
614 'domsvc', 'int', '', '',
616 'primary_key' => 'svcnum',
617 'unique' => [ [ 'username', 'domsvc' ] ],
618 'index' => [ ['username'], ['domsvc'] ],
623 # 'svcnum', 'int', '', '',
624 # 'domsvc', 'int', '', '',
625 # 'domuid', 'int', '', '',
626 # 'domuser', 'varchar', '', $char_d,
628 # 'primary_key' => 'svcnum',
629 # 'unique' => [ [] ],
630 # 'index' => [ ['domsvc'], ['domuid'] ],
635 # 'svcnum', 'int', '', '',
636 # 'amount', @money_type,
638 # 'primary_key' => 'svcnum',
639 # 'unique' => [ [] ],
645 'svcnum', 'int', '', '',
646 'domain', 'varchar', '', $char_d,
647 'catchall', 'int', 'NULL', '',
649 'primary_key' => 'svcnum',
650 'unique' => [ ['domain'] ],
656 'recnum', 'int', '', '',
657 'svcnum', 'int', '', '',
658 'reczone', 'varchar', '', $char_d,
659 'recaf', 'char', '', 2,
660 'rectype', 'char', '', 5,
661 'recdata', 'varchar', '', $char_d,
663 'primary_key' => 'recnum',
665 'index' => [ ['svcnum'] ],
670 'svcnum', 'int', '', '',
671 'srcsvc', 'int', '', '',
672 'dstsvc', 'int', '', '',
673 'dst', 'varchar', 'NULL', $char_d,
675 'primary_key' => 'svcnum',
677 'index' => [ ['srcsvc'], ['dstsvc'] ],
682 'svcnum', 'int', '', '',
683 'recnum', 'int', '', '',
684 'usersvc', 'int', '', '',
686 'primary_key' => 'svcnum',
693 # 'svcnum', 'int', '', '',
694 # 'svcnum', 'int', '', '',
695 # 'svcnum', 'int', '', '',
696 # 'worker', 'varchar', '', $char_d,
697 # '_date', @date_type,
699 # 'primary_key' => 'svcnum',
700 # 'unique' => [ [] ],
706 'prepaynum', 'int', '', '',
707 'identifier', 'varchar', '', $char_d,
708 'amount', @money_type,
709 'seconds', 'int', 'NULL', '',
711 'primary_key' => 'prepaynum',
712 'unique' => [ ['identifier'] ],
718 'portnum', 'int', '', '',
719 'ip', 'varchar', 'NULL', 15,
720 'nasport', 'int', 'NULL', '',
721 'nasnum', 'int', '', '',
723 'primary_key' => 'portnum',
730 'nasnum', 'int', '', '',
731 'nas', 'varchar', '', $char_d,
732 'nasip', 'varchar', '', 15,
733 'nasfqdn', 'varchar', '', $char_d,
734 'last', 'int', '', '',
736 'primary_key' => 'nasnum',
737 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
738 'index' => [ [ 'last' ] ],
743 'sessionnum', 'int', '', '',
744 'portnum', 'int', '', '',
745 'svcnum', 'int', '', '',
747 'logout', @date_type,
749 'primary_key' => 'sessionnum',
751 'index' => [ [ 'portnum' ] ],