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