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