FS/bin/freeside-setup

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