quoting fix for billing expressions
[freeside.git] / bin / fs-setup
1 #!/usr/bin/perl -Tw
2 #
3 # $Id: fs-setup,v 1.96.4.6 2002-12-24 22:41:21 ivan Exp $
4
5 #to delay loading dbdef until we're ready
6 BEGIN { $FS::Record::setup_hack = 1; }
7
8 use strict;
9 use DBI;
10 use DBIx::DBSchema 0.20;
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);
16 use FS::Record;
17 use FS::cust_main_county;
18 use FS::raddb;
19 use FS::part_bill_event;
20
21 die "Not running uid freeside!" unless checkeuid();
22
23 my %attrib2db =
24   map { lc($FS::raddb::attrib{$_}) => $_ } keys %FS::raddb::attrib;
25
26 my $user = shift or die &usage;
27 getsecrets($user);
28
29 #needs to match FS::Record
30 my($dbdef_file) = "/usr/local/etc/freeside/dbdef.". datasrc;
31
32 ###
33
34 #print "\nEnter the maximum username length: ";
35 #my($username_len)=&getvalue;
36 my $username_len = 32; #usernamemax config file
37
38 print "\n\n", <<END, ":";
39 Freeside tracks the RADIUS User-Name, check attribute Password and
40 reply attribute Framed-IP-Address for each user.  You can specify additional
41 check and reply attributes (or you can add them later with the
42 fs-radius-add-check and fs-radius-add-reply programs).
43
44 First enter any additional RADIUS check attributes you need to track for each 
45 user, separated by whitespace.
46 END
47 my @check_attributes = map { $attrib2db{lc($_)} or die "unknown attribute $_"; }
48                          split(" ",&getvalue);
49
50 print "\n\n", <<END, ":";
51 Now enter any additional reply attributes you need to track for each user,
52 separated by whitespace.
53 END
54 my @attributes = map { $attrib2db{lc($_)} or die "unknown attribute $_"; }
55                    split(" ",&getvalue);
56
57 print "\n\n", <<END, ":";
58 Do you wish to enable the tracking of a second, separate shipping/service
59 address?
60 END
61 my $ship = &_yesno;
62
63 sub getvalue {
64   my($x)=scalar(<STDIN>);
65   chop $x;
66   $x;
67 }
68
69 sub _yesno {
70   print " [y/N]:";
71   my $x = scalar(<STDIN>);
72   $x =~ /^y/i;
73 }
74
75 ###
76
77 my($char_d) = 80; #default maxlength for text fields
78
79 #my(@date_type)  = ( 'timestamp', '', ''     );
80 my(@date_type)  = ( 'int', 'NULL', ''     );
81 my(@perl_type) = ( 'text', 'NULL', ''  ); 
82 my @money_type = ( 'decimal',   '', '10,2' );
83
84 ###
85 # create a dbdef object from the old data structure
86 ###
87
88 my(%tables)=&tables_hash_hack;
89
90 #turn it into objects
91 my($dbdef) = new DBIx::DBSchema ( map {  
92   my(@columns);
93   while (@{$tables{$_}{'columns'}}) {
94     my($name,$type,$null,$length)=splice @{$tables{$_}{'columns'}}, 0, 4;
95     push @columns, new DBIx::DBSchema::Column ( $name,$type,$null,$length );
96   }
97   DBIx::DBSchema::Table->new(
98     $_,
99     $tables{$_}{'primary_key'},
100     DBIx::DBSchema::ColGroup::Unique->new($tables{$_}{'unique'}),
101     DBIx::DBSchema::ColGroup::Index->new($tables{$_}{'index'}),
102     @columns,
103   );
104 } (keys %tables) );
105
106 my $cust_main = $dbdef->table('cust_main');
107 unless ($ship) { #remove ship_ from cust_main
108   $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
109 } else { #add indices
110   push @{$cust_main->index->lol_ref},
111     map { [ "ship_$_" ] } qw( last company daytime night fax );
112 }
113
114 #add radius attributes to svc_acct
115
116 my($svc_acct)=$dbdef->table('svc_acct');
117
118 my($attribute);
119 foreach $attribute (@attributes) {
120   $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
121     'radius_'. $attribute,
122     'varchar',
123     'NULL',
124     $char_d,
125   ));
126 }
127
128 foreach $attribute (@check_attributes) {
129   $svc_acct->addcolumn( new DBIx::DBSchema::Column (
130     'rc_'. $attribute,
131     'varchar',
132     'NULL',
133     $char_d,
134   ));
135 }
136
137 ##make part_svc table (but now as object)
138 #
139 #my($part_svc)=$dbdef->table('part_svc');
140 #
141 ##because of svc_acct_pop
142 ##foreach (grep /^svc_/, $dbdef->tables) { 
143 ##foreach (qw(svc_acct svc_acct_sm svc_charge svc_domain svc_wo)) {
144 #foreach (qw(svc_acct svc_domain svc_forward svc_www)) {
145 #  my($table)=$dbdef->table($_);
146 #  my($col);
147 #  foreach $col ( $table->columns ) {
148 #    next if $col =~ /^svcnum$/;
149 #    $part_svc->addcolumn( new DBIx::DBSchema::Column (
150 #      $table->name. '__' . $table->column($col)->name,
151 #      'varchar', #$table->column($col)->type, 
152 #      'NULL',
153 #      $char_d, #$table->column($col)->length,
154 #    ));
155 #    $part_svc->addcolumn ( new DBIx::DBSchema::Column (
156 #      $table->name. '__'. $table->column($col)->name . "_flag",
157 #      'char',
158 #      'NULL',
159 #      1,
160 #    ));
161 #  }
162 #}
163
164 #create history tables (false laziness w/create-history-tables)
165 foreach my $table ( grep { ! /^h_/ } $dbdef->tables ) {
166   my $tableobj = $dbdef->table($table)
167     or die "unknown table $table";
168
169   die "unique->lol_ref undefined for $table"
170     unless defined $tableobj->unique->lol_ref;
171   die "index->lol_ref undefined for $table"
172     unless defined $tableobj->index->lol_ref;
173
174   my $h_tableobj = DBIx::DBSchema::Table->new( {
175     name        => "h_$table",
176     primary_key => 'historynum',
177     unique      => DBIx::DBSchema::ColGroup::Unique->new( [] ),
178     'index'     => DBIx::DBSchema::ColGroup::Index->new( [
179                      @{$tableobj->unique->lol_ref},
180                      @{$tableobj->index->lol_ref}
181                    ] ),
182     columns     => [
183                      DBIx::DBSchema::Column->new( {
184                        'name'    => 'historynum',
185                        'type'    => 'serial',
186                        'null'    => 'NOT NULL',
187                        'length'  => '',
188                        'default' => '',
189                        'local'   => '',
190                      } ),
191                      DBIx::DBSchema::Column->new( {
192                        'name'    => 'history_date',
193                        'type'    => 'int',
194                        'null'    => 'NULL',
195                        'length'  => '',
196                        'default' => '',
197                        'local'   => '',
198                      } ),
199                      DBIx::DBSchema::Column->new( {
200                        'name'    => 'history_user',
201                        'type'    => 'varchar',
202                        'null'    => 'NOT NULL',
203                        'length'  => '80',
204                        'default' => '',
205                        'local'   => '',
206                      } ),
207                      DBIx::DBSchema::Column->new( {
208                        'name'    => 'history_action',
209                        'type'    => 'varchar',
210                        'null'    => 'NOT NULL',
211                        'length'  => '80',
212                        'default' => '',
213                        'local'   => '',
214                      } ),
215                      map { $tableobj->column($_) } $tableobj->columns
216                    ],
217   } );
218   $dbdef->addtable($h_tableobj);
219 }
220
221 #important
222 $dbdef->save($dbdef_file);
223 &FS::Record::reload_dbdef($dbdef_file);
224
225 ###
226 # create 'em
227 ###
228
229 my($dbh)=adminsuidsetup $user;
230
231 #create tables
232 $|=1;
233
234 foreach my $statement ( $dbdef->sql($dbh) ) {
235   $dbh->do( $statement )
236     or die "CREATE error: ". $dbh->errstr. "\ndoing statement: $statement";
237 }
238
239 #not really sample data (and shouldn't default to US)
240
241 #cust_main_county
242
243 #USPS state codes
244 foreach ( qw(
245 AL AK AS AZ AR CA CO CT DC DE FM FL GA GU HI ID IL IN IA KS KY LA
246 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 
247 SC SD TN TX UT VT VI VA WA WV WI WY AE AA AP
248 ) ) {
249   my($cust_main_county)=new FS::cust_main_county({
250     'state' => $_,
251     'tax'   => 0,
252     'country' => 'US',
253   });  
254   my($error);
255   $error=$cust_main_county->insert;
256   die $error if $error;
257 }
258
259 #AU "offical" state codes ala mark.williamson@ebbs.com.au (Mark Williamson)
260 foreach ( qw(
261 VIC NSW NT QLD TAS ACT WA SA
262 ) ) {
263   my($cust_main_county)=new FS::cust_main_county({
264     'state' => $_,
265     'tax'   => 0,
266     'country' => 'AU',
267   });  
268   my($error);
269   $error=$cust_main_county->insert;
270   die $error if $error;
271 }
272
273 #ISO 2-letter country codes (same as country TLDs) except US and AU
274 foreach ( qw(
275 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
276 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
277 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
278 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
279 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
280 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
281 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
282 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
283 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
284 YE YU ZR ZM ZW
285 ) ) {
286   my($cust_main_county)=new FS::cust_main_county({
287     'tax'   => 0,
288     'country' => $_,
289   });  
290   my($error);
291   $error=$cust_main_county->insert;
292   die $error if $error;
293 }
294
295 #billing events
296 foreach my $aref ( 
297   [ 'COMP', 'Comp invoice', '$cust_bill->comp();', 30, 'comp' ],
298   [ 'CARD', 'Batch card', '$cust_bill->batch_card();', 40, 'batch-card' ],
299   [ 'BILL', 'Send invoice', '$cust_bill->send();', 50, 'send' ],
300 ) {
301
302   my $part_bill_event = new FS::part_bill_event({
303     'payby' => $aref->[0],
304     'event' => $aref->[1],
305     'eventcode' => $aref->[2],
306     'seconds' => 0,
307     'weight' => $aref->[3],
308     'plan' => $aref->[4],
309   });
310   my($error);
311   $error=$part_bill_event->insert;
312   die $error if $error;
313
314 }
315
316 $dbh->commit or die $dbh->errstr;
317 $dbh->disconnect or die $dbh->errstr;
318
319 print "Freeside database initialized sucessfully\n";
320
321 sub usage {
322   die "Usage:\n  fs-setup user\n"; 
323 }
324
325 ###
326 # Now it becomes an object.  much better.
327 ###
328 sub tables_hash_hack {
329
330   #note that s/(date|change)/_$1/; to avoid keyword conflict.
331   #put a kludge in FS::Record to catch this or? (pry need some date-handling
332   #stuff anyway also)
333
334   my(%tables)=( #yech.}
335
336     'agent' => {
337       'columns' => [
338         'agentnum', 'int',            '',     '',
339         'agent',    'varchar',           '',     $char_d,
340         'typenum',  'int',            '',     '',
341         'freq',     'int',       'NULL', '',
342         'prog',     @perl_type,
343       ],
344       'primary_key' => 'agentnum',
345       'unique' => [],
346       'index' => [ ['typenum'] ],
347     },
348
349     'agent_type' => {
350       'columns' => [
351         'typenum',   'int',  '', '',
352         'atype',     'varchar', '', $char_d,
353       ],
354       'primary_key' => 'typenum',
355       'unique' => [],
356       'index' => [],
357     },
358
359     'type_pkgs' => {
360       'columns' => [
361         'typenum',   'int',  '', '',
362         'pkgpart',   'int',  '', '',
363       ],
364       'primary_key' => '',
365       'unique' => [ ['typenum', 'pkgpart'] ],
366       'index' => [ ['typenum'] ],
367     },
368
369     'cust_bill' => {
370       'columns' => [
371         'invnum',    'int',  '', '',
372         'custnum',   'int',  '', '',
373         '_date',     @date_type,
374         'charged',   @money_type,
375         'printed',   'int',  '', '',
376         'closed',    'char', 'NULL', 1,
377       ],
378       'primary_key' => 'invnum',
379       'unique' => [],
380       'index' => [ ['custnum'] ],
381     },
382
383     'cust_bill_event' => {
384       'columns' => [
385         'eventnum',    'int',  '', '',
386         'invnum',   'int',  '', '',
387         'eventpart',   'int',  '', '',
388         '_date',     @date_type,
389         'status', 'varchar', '', $char_d,
390         'statustext', 'text', 'NULL', '',
391       ],
392       'primary_key' => 'eventnum',
393       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
394       'unique' => [],
395       'index' => [ ['invnum'], ['status'] ],
396     },
397
398     'part_bill_event' => {
399       'columns' => [
400         'eventpart',    'int',  '', '',
401         'payby',       'char',  '', 4,
402         'event',       'varchar',           '',     $char_d,
403         'eventcode',    @perl_type,
404         'seconds',     'int', 'NULL', '',
405         'weight',      'int', '', '',
406         'plan',       'varchar', 'NULL', $char_d,
407         'plandata',   'text', 'NULL', '',
408         'disabled',     'char', 'NULL', 1,
409       ],
410       'primary_key' => 'eventpart',
411       'unique' => [],
412       'index' => [ ['payby'] ],
413     },
414
415     'cust_bill_pkg' => {
416       'columns' => [
417         'pkgnum',  'int', '', '',
418         'invnum',  'int', '', '',
419         'setup',   @money_type,
420         'recur',   @money_type,
421         'sdate',   @date_type,
422         'edate',   @date_type,
423       ],
424       'primary_key' => '',
425       'unique' => [ ['pkgnum', 'invnum'] ],
426       'index' => [ ['invnum'] ],
427     },
428
429     'cust_credit' => {
430       'columns' => [
431         'crednum',  'int', '', '',
432         'custnum',  'int', '', '',
433         '_date',    @date_type,
434         'amount',   @money_type,
435         'otaker',   'varchar', '', 8,
436         'reason',   'text', 'NULL', '',
437         'closed',    'char', 'NULL', 1,
438       ],
439       'primary_key' => 'crednum',
440       'unique' => [],
441       'index' => [ ['custnum'] ],
442     },
443
444     'cust_credit_bill' => {
445       'columns' => [
446         'creditbillnum', 'int', '', '',
447         'crednum',  'int', '', '',
448         'invnum',  'int', '', '',
449         '_date',    @date_type,
450         'amount',   @money_type,
451       ],
452       'primary_key' => 'creditbillnum',
453       'unique' => [],
454       'index' => [ ['crednum'], ['invnum'] ],
455     },
456
457     'cust_main' => {
458       'columns' => [
459         'custnum',  'int',  '',     '',
460         'agentnum', 'int',  '',     '',
461 #        'titlenum', 'int',  'NULL',   '',
462         'last',     'varchar', '',     $char_d,
463 #        'middle',   'varchar', 'NULL', $char_d,
464         'first',    'varchar', '',     $char_d,
465         'ss',       'char', 'NULL', 11,
466         'company',  'varchar', 'NULL', $char_d,
467         'address1', 'varchar', '',     $char_d,
468         'address2', 'varchar', 'NULL', $char_d,
469         'city',     'varchar', '',     $char_d,
470         'county',   'varchar', 'NULL', $char_d,
471         'state',    'varchar', 'NULL', $char_d,
472         'zip',      'varchar', '',     10,
473         'country',  'char', '',     2,
474         'daytime',  'varchar', 'NULL', 20,
475         'night',    'varchar', 'NULL', 20,
476         'fax',      'varchar', 'NULL', 12,
477         'ship_last',     'varchar', 'NULL', $char_d,
478 #        'ship_middle',   'varchar', 'NULL', $char_d,
479         'ship_first',    'varchar', 'NULL', $char_d,
480         'ship_company',  'varchar', 'NULL', $char_d,
481         'ship_address1', 'varchar', 'NULL', $char_d,
482         'ship_address2', 'varchar', 'NULL', $char_d,
483         'ship_city',     'varchar', 'NULL', $char_d,
484         'ship_county',   'varchar', 'NULL', $char_d,
485         'ship_state',    'varchar', 'NULL', $char_d,
486         'ship_zip',      'varchar', 'NULL', 10,
487         'ship_country',  'char', 'NULL', 2,
488         'ship_daytime',  'varchar', 'NULL', 20,
489         'ship_night',    'varchar', 'NULL', 20,
490         'ship_fax',      'varchar', 'NULL', 12,
491         'payby',    'char', '',     4,
492         'payinfo',  'varchar', 'NULL', $char_d,
493         #'paydate',  @date_type,
494         'paydate',  'varchar', 'NULL', 10,
495         'payname',  'varchar', 'NULL', $char_d,
496         'tax',      'char', 'NULL', 1,
497         'otaker',   'varchar', '',     8,
498         'refnum',   'int',  '',     '',
499         'referral_custnum', 'int',  'NULL', '',
500         'comments', 'text', 'NULL', '',
501       ],
502       'primary_key' => 'custnum',
503       'unique' => [],
504       #'index' => [ ['last'], ['company'] ],
505       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
506                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
507                  ],
508     },
509
510     'cust_main_invoice' => {
511       'columns' => [
512         'destnum',  'int',  '',     '',
513         'custnum',  'int',  '',     '',
514         'dest',     'varchar', '',  $char_d,
515       ],
516       'primary_key' => 'destnum',
517       'unique' => [],
518       'index' => [ ['custnum'], ],
519     },
520
521     'cust_main_county' => { #county+state+country are checked off the
522                             #cust_main_county for validation and to provide
523                             # a tax rate.
524       'columns' => [
525         'taxnum',   'int',   '',    '',
526         'state',    'varchar',  'NULL',    $char_d,
527         'county',   'varchar',  'NULL',    $char_d,
528         'country',  'char',  '', 2, 
529         'taxclass',   'varchar', 'NULL', $char_d,
530         'exempt_amount', @money_type,
531         'tax',      'real',  '',    '', #tax %
532       ],
533       'primary_key' => 'taxnum',
534       'unique' => [],
535   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
536       'index' => [],
537     },
538
539     'cust_pay' => {
540       'columns' => [
541         'paynum',   'int',    '',   '',
542         #now cust_bill_pay #'invnum',   'int',    '',   '',
543         'custnum',  'int',    '',   '',
544         'paid',     @money_type,
545         '_date',    @date_type,
546         'payby',    'char',   '',     4, # CARD/BILL/COMP, should be index into
547                                          # payment type table.
548         'payinfo',  'varchar',   'NULL', $char_d,  #see cust_main above
549         'paybatch', 'varchar',   'NULL', $char_d, #for auditing purposes.
550         'closed',    'char', 'NULL', 1,
551       ],
552       'primary_key' => 'paynum',
553       'unique' => [],
554       'index' => [ [ 'custnum' ], [ 'paybatch' ] ],
555     },
556
557     'cust_bill_pay' => {
558       'columns' => [
559         'billpaynum', 'int',     '',   '',
560         'invnum',  'int',     '',   '',
561         'paynum',  'int',     '',   '',
562         'amount',  @money_type,
563         '_date',   @date_type
564       ],
565       'primary_key' => 'billpaynum',
566       'unique' => [],
567       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
568     },
569
570     'cust_pay_batch' => { #what's this used for again?  list of customers
571                           #in current CARD batch? (necessarily CARD?)
572       'columns' => [
573         'paybatchnum',   'int',    '',   '',
574         'invnum',   'int',    '',   '',
575         'custnum',   'int',    '',   '',
576         'last',     'varchar', '',     $char_d,
577         'first',    'varchar', '',     $char_d,
578         'address1', 'varchar', '',     $char_d,
579         'address2', 'varchar', 'NULL', $char_d,
580         'city',     'varchar', '',     $char_d,
581         'state',    'varchar', 'NULL', $char_d,
582         'zip',      'varchar', '',     10,
583         'country',  'char', '',     2,
584 #        'trancode', 'int', '', '',
585         'cardnum',  'varchar', '',     16,
586         #'exp',      @date_type,
587         'exp',      'varchar', '',     11,
588         'payname',  'varchar', 'NULL', $char_d,
589         'amount',   @money_type,
590       ],
591       'primary_key' => 'paybatchnum',
592       'unique' => [],
593       'index' => [ ['invnum'], ['custnum'] ],
594     },
595
596     'cust_pkg' => {
597       'columns' => [
598         'pkgnum',    'int',    '',   '',
599         'custnum',   'int',    '',   '',
600         'pkgpart',   'int',    '',   '',
601         'otaker',    'varchar', '', 8,
602         'setup',     @date_type,
603         'bill',      @date_type,
604         'susp',      @date_type,
605         'cancel',    @date_type,
606         'expire',    @date_type,
607         'manual_flag', 'char', 'NULL', 1,
608       ],
609       'primary_key' => 'pkgnum',
610       'unique' => [],
611       'index' => [ ['custnum'] ],
612     },
613
614     'cust_refund' => {
615       'columns' => [
616         'refundnum',    'int',    '',   '',
617         #now cust_credit_refund #'crednum',      'int',    '',   '',
618         'custnum',  'int',    '',   '',
619         '_date',        @date_type,
620         'refund',       @money_type,
621         'otaker',       'varchar',   '',   8,
622         'reason',       'varchar',   '',   $char_d,
623         'payby',        'char',   '',     4, # CARD/BILL/COMP, should be index
624                                              # into payment type table.
625         'payinfo',      'varchar',   'NULL', $char_d,  #see cust_main above
626         'paybatch',     'varchar',   'NULL', $char_d,
627         'closed',    'char', 'NULL', 1,
628       ],
629       'primary_key' => 'refundnum',
630       'unique' => [],
631       'index' => [],
632     },
633
634     'cust_credit_refund' => {
635       'columns' => [
636         'creditrefundnum', 'int',     '',   '',
637         'crednum',  'int',     '',   '',
638         'refundnum',  'int',     '',   '',
639         'amount',  @money_type,
640         '_date',   @date_type
641       ],
642       'primary_key' => 'creditrefundnum',
643       'unique' => [],
644       'index' => [ [ 'crednum', 'refundnum' ] ],
645     },
646
647
648     'cust_svc' => {
649       'columns' => [
650         'svcnum',    'int',    '',   '',
651         'pkgnum',    'int',    'NULL',   '',
652         'svcpart',   'int',    '',   '',
653       ],
654       'primary_key' => 'svcnum',
655       'unique' => [],
656       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
657     },
658
659     'part_pkg' => {
660       'columns' => [
661         'pkgpart',    'int',    '',   '',
662         'pkg',        'varchar',   '',   $char_d,
663         'comment',    'varchar',   '',   $char_d,
664         'setup',      @perl_type,
665         'freq',       'int', '', '',  #billing frequency (months)
666         'recur',      @perl_type,
667         'setuptax',  'char', 'NULL', 1,
668         'recurtax',  'char', 'NULL', 1,
669         'plan',       'varchar', 'NULL', $char_d,
670         'plandata',   'text', 'NULL', '',
671         'disabled',   'char', 'NULL', 1,
672         'taxclass',   'varchar', 'NULL', $char_d,
673       ],
674       'primary_key' => 'pkgpart',
675       'unique' => [],
676       'index' => [ [ 'disabled' ] ],
677     },
678
679 #    'part_title' => {
680 #      'columns' => [
681 #        'titlenum',   'int',    '',   '',
682 #        'title',      'varchar',   '',   $char_d,
683 #      ],
684 #      'primary_key' => 'titlenum',
685 #      'unique' => [ [] ],
686 #      'index' => [ [] ],
687 #    },
688
689     'pkg_svc' => {
690       'columns' => [
691         'pkgpart',    'int',    '',   '',
692         'svcpart',    'int',    '',   '',
693         'quantity',   'int',    '',   '',
694       ],
695       'primary_key' => '',
696       'unique' => [ ['pkgpart', 'svcpart'] ],
697       'index' => [ ['pkgpart'] ],
698     },
699
700     'part_referral' => {
701       'columns' => [
702         'refnum',   'int',    '',   '',
703         'referral', 'varchar',   '',   $char_d,
704       ],
705       'primary_key' => 'refnum',
706       'unique' => [],
707       'index' => [],
708     },
709
710     'part_svc' => {
711       'columns' => [
712         'svcpart',    'int',    '',   '',
713         'svc',        'varchar',   '',   $char_d,
714         'svcdb',      'varchar',   '',   $char_d,
715         'disabled',   'char',  'NULL',   1,
716       ],
717       'primary_key' => 'svcpart',
718       'unique' => [],
719       'index' => [ [ 'disabled' ] ],
720     },
721
722     'part_svc_column' => {
723       'columns' => [
724         'columnnum',   'int',         '', '',
725         'svcpart',     'int',         '', '',
726         'columnname',  'varchar',     '', 64,
727         'columnvalue', 'varchar', 'NULL', $char_d,
728         'columnflag',  'char',    'NULL', 1, 
729       ],
730       'primary_key' => 'columnnum',
731       'unique' => [ [ 'svcpart', 'columnname' ] ],
732       'index' => [ [ 'svcpart' ] ],
733     },
734
735     #(this should be renamed to part_pop)
736     'svc_acct_pop' => {
737       'columns' => [
738         'popnum',    'int',    '',   '',
739         'city',      'varchar',   '',   $char_d,
740         'state',     'varchar',   '',   $char_d,
741         'ac',        'char',   '',   3,
742         'exch',      'char',   '',   3,
743         'loc',       'char',   'NULL',   4, #NULL for legacy purposes
744       ],
745       'primary_key' => 'popnum',
746       'unique' => [],
747       'index' => [ [ 'state' ] ],
748     },
749
750     'part_pop_local' => {
751       'columns' => [
752         'localnum',  'int',     '',     '',
753         'popnum',    'int',     '',     '',
754         'city',      'varchar', 'NULL', $char_d,
755         'state',     'char',    'NULL', 2,
756         'npa',       'char',    '',     3,
757         'nxx',       'char',    '',     3,
758       ],
759       'primary_key' => 'localnum',
760       'unique' => [],
761       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
762     },
763
764     'svc_acct' => {
765       'columns' => [
766         'svcnum',    'int',    '',   '',
767         'username',  'varchar',   '',   $username_len, #unique (& remove dup code)
768         '_password', 'varchar',   '',   50, #13 for encryped pw's plus ' *SUSPENDED* (mp5 passwords can be 34)
769         'sec_phrase', 'varchar',  'NULL',   $char_d,
770         'popnum',    'int',    'NULL',   '',
771         'uid',       'int', 'NULL',   '',
772         'gid',       'int', 'NULL',   '',
773         'finger',    'varchar',   'NULL',   $char_d,
774         'dir',       'varchar',   'NULL',   $char_d,
775         'shell',     'varchar',   'NULL',   $char_d,
776         'quota',     'varchar',   'NULL',   $char_d,
777         'slipip',    'varchar',   'NULL',   15, #four TINYINTs, bah.
778         'seconds',   'int', 'NULL',   '', #uhhhh
779         'domsvc',    'int', '',   '',
780       ],
781       'primary_key' => 'svcnum',
782       #'unique' => [ [ 'username', 'domsvc' ] ],
783       'unique' => [],
784       'index' => [ ['username'], ['domsvc'] ],
785     },
786
787 #    'svc_acct_sm' => {
788 #      'columns' => [
789 #        'svcnum',    'int',    '',   '',
790 #        'domsvc',    'int',    '',   '',
791 #        'domuid',    'int', '',   '',
792 #        'domuser',   'varchar',   '',   $char_d,
793 #      ],
794 #      'primary_key' => 'svcnum',
795 #      'unique' => [ [] ],
796 #      'index' => [ ['domsvc'], ['domuid'] ], 
797 #    },
798
799     #'svc_charge' => {
800     #  'columns' => [
801     #    'svcnum',    'int',    '',   '',
802     #    'amount',    @money_type,
803     #  ],
804     #  'primary_key' => 'svcnum',
805     #  'unique' => [ [] ],
806     #  'index' => [ [] ],
807     #},
808
809     'svc_domain' => {
810       'columns' => [
811         'svcnum',    'int',    '',   '',
812         'domain',    'varchar',    '',   $char_d,
813         'catchall',  'int', 'NULL',    '',
814       ],
815       'primary_key' => 'svcnum',
816       'unique' => [ ['domain'] ],
817       'index' => [],
818     },
819
820     'domain_record' => {
821       'columns' => [
822         'recnum',    'int',     '',  '',
823         'svcnum',    'int',     '',  '',
824         #'reczone',   'varchar', '',  $char_d,
825         'reczone',   'varchar', '',  255,
826         'recaf',     'char',    '',  2,
827         'rectype',   'char',    '',  5,
828         #'recdata',   'varchar', '',  $char_d,
829         'recdata',   'varchar', '',  255,
830       ],
831       'primary_key' => 'recnum',
832       'unique'      => [],
833       'index'       => [ ['svcnum'] ],
834     },
835
836     'svc_forward' => {
837       'columns' => [
838         'svcnum',   'int',    '',  '',
839         'srcsvc',   'int',    '',  '',
840         'dstsvc',   'int',    '',  '',
841         'dst',      'varchar',    'NULL',  $char_d,
842       ],
843       'primary_key' => 'svcnum',
844       'unique'      => [],
845       'index'       => [ ['srcsvc'], ['dstsvc'] ],
846     },
847
848     'svc_www' => {
849       'columns' => [
850         'svcnum',   'int',    '',  '',
851         'recnum',   'int',    '',  '',
852         'usersvc',  'int',    '',  '',
853       ],
854       'primary_key' => 'svcnum',
855       'unique'      => [],
856       'index'       => [],
857     },
858
859     #'svc_wo' => {
860     #  'columns' => [
861     #    'svcnum',    'int',    '',   '',
862     #    'svcnum',    'int',    '',   '',
863     #    'svcnum',    'int',    '',   '',
864     #    'worker',    'varchar',   '',   $char_d,
865     #    '_date',     @date_type,
866     #  ],
867     #  'primary_key' => 'svcnum',
868     #  'unique' => [ [] ],
869     #  'index' => [ [] ],
870     #},
871
872     'prepay_credit' => {
873       'columns' => [
874         'prepaynum',   'int',     '',   '',
875         'identifier',  'varchar', '', $char_d,
876         'amount',      @money_type,
877         'seconds',     'int',     'NULL', '',
878       ],
879       'primary_key' => 'prepaynum',
880       'unique'      => [ ['identifier'] ],
881       'index'       => [],
882     },
883
884     'port' => {
885       'columns' => [
886         'portnum',  'int',     '',   '',
887         'ip',       'varchar', 'NULL', 15,
888         'nasport',  'int',     'NULL', '',
889         'nasnum',   'int',     '',   '',
890       ],
891       'primary_key' => 'portnum',
892       'unique'      => [],
893       'index'       => [],
894     },
895
896     'nas' => {
897       'columns' => [
898         'nasnum',   'int',     '',    '',
899         'nas',      'varchar', '',    $char_d,
900         'nasip',    'varchar', '',    15,
901         'nasfqdn',  'varchar', '',    $char_d,
902         'last',     'int',     '',    '',
903       ],
904       'primary_key' => 'nasnum',
905       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
906       'index'       => [ [ 'last' ] ],
907     },
908
909     'session' => {
910       'columns' => [
911         'sessionnum', 'int',       '',   '',
912         'portnum',    'int',       '',   '',
913         'svcnum',     'int',       '',   '',
914         'login',      @date_type,
915         'logout',     @date_type,
916       ],
917       'primary_key' => 'sessionnum',
918       'unique'      => [],
919       'index'       => [ [ 'portnum' ] ],
920     },
921
922     'queue' => {
923       'columns' => [
924         'jobnum', 'int', '', '',
925         'job', 'text', '', '',
926         '_date', 'int', '', '',
927         'status', 'varchar', '', $char_d,
928         'statustext', 'text', 'NULL', '',
929         'svcnum', 'int', 'NULL', '',
930       ],
931       'primary_key' => 'jobnum',
932       'unique'      => [],
933       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
934     },
935
936     'queue_arg' => {
937       'columns' => [
938         'argnum', 'int', '', '',
939         'jobnum', 'int', '', '',
940         'arg', 'text', 'NULL', '',
941       ],
942       'primary_key' => 'argnum',
943       'unique'      => [],
944       'index'       => [ [ 'jobnum' ] ],
945     },
946
947     'queue_depend' => {
948       'columns' => [
949         'dependnum', 'int', '', '',
950         'jobnum', 'int', '', '',
951         'depend_jobnum', 'int', '', '',
952       ],
953       'primary_key' => 'dependnum',
954       'unique'      => [],
955       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
956     },
957
958     'export_svc' => {
959       'columns' => [
960         'exportsvcnum' => 'int', '', '',
961         'exportnum'    => 'int', '', '',
962         'svcpart'      => 'int', '', '',
963       ],
964       'primary_key' => 'exportsvcnum',
965       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
966       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
967     },
968
969     'part_export' => {
970       'columns' => [
971         'exportnum', 'int', '', '',
972         #'svcpart',   'int', '', '',
973         'machine', 'varchar', '', $char_d,
974         'exporttype', 'varchar', '', $char_d,
975         'nodomain',     'char', 'NULL', 1,
976       ],
977       'primary_key' => 'exportnum',
978       'unique'      => [],
979       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
980     },
981
982     'part_export_option' => {
983       'columns' => [
984         'optionnum', 'int', '', '',
985         'exportnum', 'int', '', '',
986         'optionname', 'varchar', '', $char_d,
987         'optionvalue', 'text', 'NULL', '',
988       ],
989       'primary_key' => 'optionnum',
990       'unique'      => [],
991       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
992     },
993
994     'radius_usergroup' => {
995       'columns' => [
996         'usergroupnum', 'int', '', '',
997         'svcnum',       'int', '', '',
998         'groupname',    'varchar', '', $char_d,
999       ],
1000       'primary_key' => 'usergroupnum',
1001       'unique'      => [],
1002       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1003     },
1004
1005     'msgcat' => {
1006       'columns' => [
1007         'msgnum', 'int', '', '',
1008         'msgcode', 'varchar', '', $char_d,
1009         'locale', 'varchar', '', 16,
1010         'msg', 'text', '', '',
1011       ],
1012       'primary_key' => 'msgnum',
1013       'unique'      => [ [ 'msgcode', 'locale' ] ],
1014       'index'       => [],
1015     },
1016
1017     'cust_tax_exempt' => {
1018       'columns' => [
1019         'exemptnum', 'int', '', '',
1020         'custnum',   'int', '', '',
1021         'taxnum',    'int', '', '',
1022         'year',      'int', '', '',
1023         'month',     'int', '', '',
1024         'amount',   @money_type,
1025       ],
1026       'primary_key' => 'exemptnum',
1027       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1028       'index'       => [],
1029     },
1030
1031
1032
1033   );
1034
1035   %tables;
1036
1037 }
1038