3 # $Id: fs-setup,v 1.43 2001-08-19 13:50:47 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 {
82 while (@{$tables{$_}{'columns'}}) {
83 my($name,$type,$null,$length)=splice @{$tables{$_}{'columns'}}, 0, 4;
84 push @columns, new DBIx::DBSchema::Column ( $name,$type,$null,$length );
86 DBIx::DBSchema::Table->new(
88 $tables{$_}{'primary_key'},
89 DBIx::DBSchema::ColGroup::Unique->new($tables{$_}{'unique'}),
90 DBIx::DBSchema::ColGroup::Index->new($tables{$_}{'index'}),
95 my $cust_main = $dbdef->table('cust_main');
96 unless ($ship) { #remove ship_ from cust_main
97 $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
98 } else { #add indices on ship_last and ship_company
99 push @{$cust_main->index->lol_ref}, ( ['ship_last'], ['ship_company'] )
102 #add radius attributes to svc_acct
104 my($svc_acct)=$dbdef->table('svc_acct');
107 foreach $attribute (@attributes) {
108 $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
109 'radius_'. $attribute,
116 foreach $attribute (@check_attributes) {
117 $svc_acct->addcolumn( new DBIx::DBSchema::Column (
125 #make part_svc table (but now as object)
127 my($part_svc)=$dbdef->table('part_svc');
129 #because of svc_acct_pop
130 #foreach (grep /^svc_/, $dbdef->tables) {
131 #foreach (qw(svc_acct svc_acct_sm svc_charge svc_domain svc_wo)) {
132 foreach (qw(svc_acct svc_domain svc_forward svc_www)) {
133 my($table)=$dbdef->table($_);
135 foreach $col ( $table->columns ) {
136 next if $col =~ /^svcnum$/;
137 $part_svc->addcolumn( new DBIx::DBSchema::Column (
138 $table->name. '__' . $table->column($col)->name,
139 'varchar', #$table->column($col)->type,
141 $char_d, #$table->column($col)->length,
143 $part_svc->addcolumn ( new DBIx::DBSchema::Column (
144 $table->name. '__'. $table->column($col)->name . "_flag",
153 $dbdef->save($dbdef_file);
154 &FS::Record::reload_dbdef($dbdef_file);
160 my($dbh)=adminsuidsetup $user;
165 my @sql = $dbdef->sql($dbh);
166 foreach my $statement ( $dbdef->sql($dbh) ) {
167 $dbh->do( $statement )
168 or die "CREATE error: ",$dbh->errstr, "\ndoing statement: $statement";
171 #not really sample data (and shouldn't default to US)
177 AL AK AS AZ AR CA CO CT DC DE FM FL GA GU HI ID IL IN IA KS KY LA
178 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
179 SC SD TN TX UT VT VI VA WA WV WI WY AE AA AP
181 my($cust_main_county)=new FS::cust_main_county({
187 $error=$cust_main_county->insert;
188 die $error if $error;
191 #AU "offical" state codes ala mark.williamson@ebbs.com.au (Mark Williamson)
193 VIC NSW NT QLD TAS ACT WA SA
195 my($cust_main_county)=new FS::cust_main_county({
201 $error=$cust_main_county->insert;
202 die $error if $error;
205 #ISO 2-letter country codes (same as country TLDs) except US and AU
207 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
208 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
209 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
210 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
211 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
212 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
213 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
214 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
215 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
218 my($cust_main_county)=new FS::cust_main_county({
223 $error=$cust_main_county->insert;
224 die $error if $error;
227 $dbh->disconnect or die $dbh->errstr;
229 print "Freeside database initialized sucessfully\n";
232 die "Usage:\n fs-setup user\n";
236 # Now it becomes an object. much better.
238 sub tables_hash_hack {
240 #note that s/(date|change)/_$1/; to avoid keyword conflict.
241 #put a kludge in FS::Record to catch this or? (pry need some date-handling
244 my(%tables)=( #yech.}
248 'agentnum', 'int', '', '',
249 'agent', 'varchar', '', $char_d,
250 'typenum', 'int', '', '',
251 'freq', 'int', 'NULL', '',
254 'primary_key' => 'agentnum',
256 'index' => [ ['typenum'] ],
261 'typenum', 'int', '', '',
262 'atype', 'varchar', '', $char_d,
264 'primary_key' => 'typenum',
271 'typenum', 'int', '', '',
272 'pkgpart', 'int', '', '',
275 'unique' => [ ['typenum', 'pkgpart'] ],
276 'index' => [ ['typenum'] ],
281 'invnum', 'int', '', '',
282 'custnum', 'int', '', '',
284 'charged', @money_type,
285 'printed', 'int', '', '',
287 'primary_key' => 'invnum',
289 'index' => [ ['custnum'] ],
294 'pkgnum', 'int', '', '',
295 'invnum', 'int', '', '',
296 'setup', @money_type,
297 'recur', @money_type,
302 'unique' => [ ['pkgnum', 'invnum'] ],
303 'index' => [ ['invnum'] ],
308 'crednum', 'int', '', '',
309 'custnum', 'int', '', '',
311 'amount', @money_type,
312 'otaker', 'varchar', '', 8,
313 'reason', 'varchar', 'NULL', 255,
315 'primary_key' => 'crednum',
317 'index' => [ ['custnum'] ],
322 'custnum', 'int', '', '',
323 'agentnum', 'int', '', '',
324 # 'titlenum', 'int', 'NULL', '',
325 'last', 'varchar', '', $char_d,
326 # 'middle', 'varchar', 'NULL', $char_d,
327 'first', 'varchar', '', $char_d,
328 'ss', 'char', 'NULL', 11,
329 'company', 'varchar', 'NULL', $char_d,
330 'address1', 'varchar', '', $char_d,
331 'address2', 'varchar', 'NULL', $char_d,
332 'city', 'varchar', '', $char_d,
333 'county', 'varchar', 'NULL', $char_d,
334 'state', 'varchar', 'NULL', $char_d,
335 'zip', 'varchar', '', 10,
336 'country', 'char', '', 2,
337 'daytime', 'varchar', 'NULL', 20,
338 'night', 'varchar', 'NULL', 20,
339 'fax', 'varchar', 'NULL', 12,
340 'ship_last', 'varchar', 'NULL', $char_d,
341 # 'ship_middle', 'varchar', 'NULL', $char_d,
342 'ship_first', 'varchar', 'NULL', $char_d,
343 'ship_company', 'varchar', 'NULL', $char_d,
344 'ship_address1', 'varchar', 'NULL', $char_d,
345 'ship_address2', 'varchar', 'NULL', $char_d,
346 'ship_city', 'varchar', 'NULL', $char_d,
347 'ship_county', 'varchar', 'NULL', $char_d,
348 'ship_state', 'varchar', 'NULL', $char_d,
349 'ship_zip', 'varchar', 'NULL', 10,
350 'ship_country', 'char', 'NULL', 2,
351 'ship_daytime', 'varchar', 'NULL', 20,
352 'ship_night', 'varchar', 'NULL', 20,
353 'ship_fax', 'varchar', 'NULL', 12,
354 'payby', 'char', '', 4,
355 'payinfo', 'varchar', 'NULL', 16,
356 #'paydate', @date_type,
357 'paydate', 'varchar', 'NULL', 10,
358 'payname', 'varchar', 'NULL', $char_d,
359 'tax', 'char', 'NULL', 1,
360 'otaker', 'varchar', '', 8,
361 'refnum', 'int', '', '',
362 'comments', 'varchar', 'NULL', '',
364 'primary_key' => 'custnum',
366 #'index' => [ ['last'], ['company'] ],
367 'index' => [ ['last'], [ 'company' ] ],
370 'cust_main_invoice' => {
372 'destnum', 'int', '', '',
373 'custnum', 'int', '', '',
374 'dest', 'varchar', '', $char_d,
376 'primary_key' => 'destnum',
378 'index' => [ ['custnum'], ],
381 'cust_main_county' => { #county+state+country are checked off the
382 #cust_main_county for validation and to provide
385 'taxnum', 'int', '', '',
386 'state', 'varchar', 'NULL', $char_d,
387 'county', 'varchar', 'NULL', $char_d,
388 'country', 'char', '', 2,
389 'tax', 'real', '', '', #tax %
391 'primary_key' => 'taxnum',
393 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
399 'paynum', 'int', '', '',
400 'invnum', 'int', '', '',
403 'payby', 'char', '', 4, # CARD/BILL/COMP, should be index into
404 # payment type table.
405 'payinfo', 'varchar', 'NULL', 16, #see cust_main above
406 'paybatch', 'varchar', 'NULL', $char_d, #for auditing purposes.
408 'primary_key' => 'paynum',
410 'index' => [ ['invnum'] ],
413 'cust_pay_batch' => { #what's this used for again? list of customers
414 #in current CARD batch? (necessarily CARD?)
416 'invnum', 'int', '', '',
417 'custnum', 'int', '', '',
418 'last', 'varchar', '', $char_d,
419 'first', 'varchar', '', $char_d,
420 'address1', 'varchar', '', $char_d,
421 'address2', 'varchar', 'NULL', $char_d,
422 'city', 'varchar', '', $char_d,
423 'state', 'varchar', '', $char_d,
424 'zip', 'varchar', '', 10,
425 'country', 'char', '', 2,
426 'trancode', 'int', '', '',
427 'cardnum', 'varchar', '', 16,
429 'exp', 'varchar', '', 11,
430 'payname', 'varchar', 'NULL', $char_d,
431 'amount', @money_type,
435 'index' => [ ['invnum'], ['custnum'] ],
440 'pkgnum', 'int', '', '',
441 'custnum', 'int', '', '',
442 'pkgpart', 'int', '', '',
443 'otaker', 'varchar', '', 8,
447 'cancel', @date_type,
448 'expire', @date_type,
450 'primary_key' => 'pkgnum',
452 'index' => [ ['custnum'] ],
457 'refundnum', 'int', '', '',
458 'crednum', 'int', '', '',
460 'refund', @money_type,
461 'otaker', 'varchar', '', 8,
462 'reason', 'varchar', '', $char_d,
463 'payby', 'char', '', 4, # CARD/BILL/COMP, should be index
464 # into payment type table.
465 'payinfo', 'varchar', 'NULL', 16, #see cust_main above
467 'primary_key' => 'refundnum',
469 'index' => [ ['crednum'] ],
474 'svcnum', 'int', '', '',
475 'pkgnum', 'int', 'NULL', '',
476 'svcpart', 'int', '', '',
478 'primary_key' => 'svcnum',
480 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
485 'pkgpart', 'int', '', '',
486 'pkg', 'varchar', '', $char_d,
487 'comment', 'varchar', '', $char_d,
489 'freq', 'int', '', '', #billing frequency (months)
492 'primary_key' => 'pkgpart',
499 # 'titlenum', 'int', '', '',
500 # 'title', 'varchar', '', $char_d,
502 # 'primary_key' => 'titlenum',
503 # 'unique' => [ [] ],
509 'pkgpart', 'int', '', '',
510 'svcpart', 'int', '', '',
511 'quantity', 'int', '', '',
514 'unique' => [ ['pkgpart', 'svcpart'] ],
515 'index' => [ ['pkgpart'] ],
520 'refnum', 'int', '', '',
521 'referral', 'varchar', '', $char_d,
523 'primary_key' => 'refnum',
530 'svcpart', 'int', '', '',
531 'svc', 'varchar', '', $char_d,
532 'svcdb', 'varchar', '', $char_d,
534 'primary_key' => 'svcpart',
539 #(this should be renamed to part_pop)
542 'popnum', 'int', '', '',
543 'city', 'varchar', '', $char_d,
544 'state', 'varchar', '', $char_d,
546 'exch', 'char', '', 3,
547 'loc', 'char', 'NULL', 4, #NULL for legacy purposes
549 'primary_key' => 'popnum',
556 'svcnum', 'int', '', '',
557 'username', 'varchar', '', $username_len, #unique (& remove dup code)
558 '_password', 'varchar', '', 50, #13 for encryped pw's plus ' *SUSPENDED* (mp5 passwords can be 34)
559 'popnum', 'int', 'NULL', '',
560 'uid', 'int', 'NULL', '',
561 'gid', 'int', 'NULL', '',
562 'finger', 'varchar', 'NULL', $char_d,
563 'dir', 'varchar', 'NULL', $char_d,
564 'shell', 'varchar', 'NULL', $char_d,
565 'quota', 'varchar', 'NULL', $char_d,
566 'slipip', 'varchar', 'NULL', 15, #four TINYINTs, bah.
567 'seconds', 'int', 'NULL', '', #uhhhh
568 'domsvc', 'int', '', '',
570 'primary_key' => 'svcnum',
571 'unique' => [ [ 'username', 'domsvc' ] ],
572 'index' => [ ['username'], ['domsvc'] ],
577 # 'svcnum', 'int', '', '',
578 # 'domsvc', 'int', '', '',
579 # 'domuid', 'int', '', '',
580 # 'domuser', 'varchar', '', $char_d,
582 # 'primary_key' => 'svcnum',
583 # 'unique' => [ [] ],
584 # 'index' => [ ['domsvc'], ['domuid'] ],
589 # 'svcnum', 'int', '', '',
590 # 'amount', @money_type,
592 # 'primary_key' => 'svcnum',
593 # 'unique' => [ [] ],
599 'svcnum', 'int', '', '',
600 'domain', 'varchar', '', $char_d,
601 'catchall', 'int', '', '',
603 'primary_key' => 'svcnum',
604 'unique' => [ ['domain'] ],
610 'recnum', 'int', '', '',
611 'svcnum', 'int', '', '',
612 'reczone', 'varchar', '', $char_d,
613 'recaf', 'char', '', 2,
614 'rectype', 'char', '', 5,
615 'recdata', 'varchar', '', $char_d,
617 'primary_key' => 'recnum',
619 'index' => [ ['svcnum'] ],
624 'svcnum', 'int', '', '',
625 'srcsvc', 'int', '', '',
626 'dstsvc', 'int', '', '',
627 'dst', 'varchar', 'NULL', $char_d,
629 'primary_key' => 'svcnum',
631 'index' => [ ['srcsvc'], ['dstsvc'] ],
636 'svcnum', 'int', '', '',
637 'recnum', 'int', '', '',
638 'usersvc', 'int', '', '',
640 'primary_key' => 'svcnum',
647 # 'svcnum', 'int', '', '',
648 # 'svcnum', 'int', '', '',
649 # 'svcnum', 'int', '', '',
650 # 'worker', 'varchar', '', $char_d,
651 # '_date', @date_type,
653 # 'primary_key' => 'svcnum',
654 # 'unique' => [ [] ],
660 'prepaynum', 'int', '', '',
661 'identifier', 'varchar', '', $char_d,
662 'amount', @money_type,
663 'seconds', 'int', 'NULL', '',
665 'primary_key' => 'prepaynum',
666 'unique' => [ ['identifier'] ],
672 'portnum', 'int', '', '',
673 'ip', 'varchar', 'NULL', 15,
674 'nasport', 'int', 'NULL', '',
675 'nasnum', 'int', '', '',
677 'primary_key' => 'portnum',
684 'nasnum', 'int', '', '',
685 'nas', 'varchar', '', $char_d,
686 'nasip', 'varchar', '', 15,
687 'nasfqdn', 'varchar', '', $char_d,
688 'last', 'int', '', '',
690 'primary_key' => 'nasnum',
691 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
692 'index' => [ [ 'last' ] ],
697 'sessionnum', 'int', '', '',
698 'portnum', 'int', '', '',
699 'svcnum', 'int', '', '',
701 'logout', @date_type,
703 'primary_key' => 'sessionnum',
705 'index' => [ [ 'portnum' ] ],