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'], ['disabled'] ],
 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'], ['disabled'], ],
 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         'paycvv',   'varchar', 'NULL', 4,
 506         #'paydate',  @date_type,
 507         'paydate',  'varchar', 'NULL', 10,
 508         'payname',  'varchar', 'NULL', $char_d,
 509         'tax',      'char', 'NULL', 1,
 510         'otaker',   'varchar', '',    32,
 511         'refnum',   'int',  '',     '',
 512         'referral_custnum', 'int',  'NULL', '',
 513         'comments', 'text', 'NULL', '',
 514       ],
 515       'primary_key' => 'custnum',
 516       'unique' => [],
 517       #'index' => [ ['last'], ['company'] ],
 518       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 519                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 520                  ],
 521     },
 522
 523     'cust_main_invoice' => {
 524       'columns' => [
 525         'destnum',  'serial',  '',     '',
 526         'custnum',  'int',  '',     '',
 527         'dest',     'varchar', '',  $char_d,
 528       ],
 529       'primary_key' => 'destnum',
 530       'unique' => [],
 531       'index' => [ ['custnum'], ],
 532     },
 533
 534     'cust_main_county' => { #county+state+country are checked off the
 535                             #cust_main_county for validation and to provide
 536                             # a tax rate.
 537       'columns' => [
 538         'taxnum',   'serial',   '',    '',
 539         'state',    'varchar',  'NULL',    $char_d,
 540         'county',   'varchar',  'NULL',    $char_d,
 541         'country',  'char',  '', 2,
 542         'taxclass',   'varchar', 'NULL', $char_d,
 543         'exempt_amount', @money_type,
 544         'tax',      'real',  '',    '', #tax %
 545         'taxname',  'varchar',  'NULL',    $char_d,
 546         'setuptax',  'char', 'NULL', 1, # Y = setup tax exempt
 547         'recurtax',  'char', 'NULL', 1, # Y = recur tax exempt
 548       ],
 549       'primary_key' => 'taxnum',
 550       'unique' => [],
 551   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 552       'index' => [],
 553     },
 554
 555     'cust_pay' => {
 556       'columns' => [
 557         'paynum',   'serial',    '',   '',
 558         #now cust_bill_pay #'invnum',   'int',    '',   '',
 559         'custnum',  'int',    '',   '',
 560         'paid',     @money_type,
 561         '_date',    @date_type,
 562         'payby',    'char',   '',     4, # CARD/BILL/COMP, should be index into
 563                                          # payment type table.
 564         'payinfo',  'varchar',   'NULL', $char_d,  #see cust_main above
 565         'paybatch', 'varchar',   'NULL', $char_d, #for auditing purposes.
 566         'closed',    'char', 'NULL', 1,
 567       ],
 568       'primary_key' => 'paynum',
 569       'unique' => [],
 570       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 571     },
 572
 573     'cust_bill_pay' => {
 574       'columns' => [
 575         'billpaynum', 'serial',     '',   '',
 576         'invnum',  'int',     '',   '',
 577         'paynum',  'int',     '',   '',
 578         'amount',  @money_type,
 579         '_date',   @date_type
 580       ],
 581       'primary_key' => 'billpaynum',
 582       'unique' => [],
 583       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 584     },
 585
 586     'cust_pay_batch' => { #what's this used for again?  list of customers
 587                           #in current CARD batch? (necessarily CARD?)
 588       'columns' => [
 589         'paybatchnum',   'serial',    '',   '',
 590         'invnum',   'int',    '',   '',
 591         'custnum',   'int',    '',   '',
 592         'last',     'varchar', '',     $char_d,
 593         'first',    'varchar', '',     $char_d,
 594         'address1', 'varchar', '',     $char_d,
 595         'address2', 'varchar', 'NULL', $char_d,
 596         'city',     'varchar', '',     $char_d,
 597         'state',    'varchar', 'NULL', $char_d,
 598         'zip',      'varchar', '',     10,
 599         'country',  'char', '',     2,
 600 #        'trancode', 'int', '', '',
 601         'cardnum',  'varchar', '',     16,
 602         #'exp',      @date_type,
 603         'exp',      'varchar', '',     11,
 604         'payname',  'varchar', 'NULL', $char_d,
 605         'amount',   @money_type,
 606       ],
 607       'primary_key' => 'paybatchnum',
 608       'unique' => [],
 609       'index' => [ ['invnum'], ['custnum'] ],
 610     },
 611
 612     'cust_pkg' => {
 613       'columns' => [
 614         'pkgnum',    'serial',    '',   '',
 615         'custnum',   'int',    '',   '',
 616         'pkgpart',   'int',    '',   '',
 617         'otaker',    'varchar', '', 32,
 618         'setup',     @date_type,
 619         'bill',      @date_type,
 620         'last_bill', @date_type,
 621         'susp',      @date_type,
 622         'cancel',    @date_type,
 623         'expire',    @date_type,
 624         'manual_flag', 'char', 'NULL', 1,
 625       ],
 626       'primary_key' => 'pkgnum',
 627       'unique' => [],
 628       'index' => [ ['custnum'] ],
 629     },
 630
 631     'cust_refund' => {
 632       'columns' => [
 633         'refundnum',    'serial',    '',   '',
 634         #now cust_credit_refund #'crednum',      'int',    '',   '',
 635         'custnum',  'int',    '',   '',
 636         '_date',        @date_type,
 637         'refund',       @money_type,
 638         'otaker',       'varchar',   '',   32,
 639         'reason',       'varchar',   '',   $char_d,
 640         'payby',        'char',   '',     4, # CARD/BILL/COMP, should be index
 641                                              # into payment type table.
 642         'payinfo',      'varchar',   'NULL', $char_d,  #see cust_main above
 643         'paybatch',     'varchar',   'NULL', $char_d,
 644         'closed',    'char', 'NULL', 1,
 645       ],
 646       'primary_key' => 'refundnum',
 647       'unique' => [],
 648       'index' => [],
 649     },
 650
 651     'cust_credit_refund' => {
 652       'columns' => [
 653         'creditrefundnum', 'serial',     '',   '',
 654         'crednum',  'int',     '',   '',
 655         'refundnum',  'int',     '',   '',
 656         'amount',  @money_type,
 657         '_date',   @date_type
 658       ],
 659       'primary_key' => 'creditrefundnum',
 660       'unique' => [],
 661       'index' => [ [ 'crednum', 'refundnum' ] ],
 662     },
 663
 664
 665     'cust_svc' => {
 666       'columns' => [
 667         'svcnum',    'serial',    '',   '',
 668         'pkgnum',    'int',    'NULL',   '',
 669         'svcpart',   'int',    '',   '',
 670       ],
 671       'primary_key' => 'svcnum',
 672       'unique' => [],
 673       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 674     },
 675
 676     'part_pkg' => {
 677       'columns' => [
 678         'pkgpart',    'serial',    '',   '',
 679         'pkg',        'varchar',   '',   $char_d,
 680         'comment',    'varchar',   '',   $char_d,
 681         'setup',      @perl_type,
 682         'freq',       'varchar',   '',   $char_d,  #billing frequency
 683         'recur',      @perl_type,
 684         'setuptax',  'char', 'NULL', 1,
 685         'recurtax',  'char', 'NULL', 1,
 686         'plan',       'varchar', 'NULL', $char_d,
 687         'plandata',   'text', 'NULL', '',
 688         'disabled',   'char', 'NULL', 1,
 689         'taxclass',   'varchar', 'NULL', $char_d,
 690       ],
 691       'primary_key' => 'pkgpart',
 692       'unique' => [],
 693       'index' => [ [ 'disabled' ], ],
 694     },
 695
 696 #    'part_title' => {
 697 #      'columns' => [
 698 #        'titlenum',   'int',    '',   '',
 699 #        'title',      'varchar',   '',   $char_d,
 700 #      ],
 701 #      'primary_key' => 'titlenum',
 702 #      'unique' => [ [] ],
 703 #      'index' => [ [] ],
 704 #    },
 705
 706     'pkg_svc' => {
 707       'columns' => [
 708         'pkgpart',    'int',    '',   '',
 709         'svcpart',    'int',    '',   '',
 710         'quantity',   'int',    '',   '',
 711         'primary_svc','char', 'NULL',  1,
 712       ],
 713       'primary_key' => '',
 714       'unique' => [ ['pkgpart', 'svcpart'] ],
 715       'index' => [ ['pkgpart'] ],
 716     },
 717
 718     'part_referral' => {
 719       'columns' => [
 720         'refnum',   'serial',    '',   '',
 721         'referral', 'varchar',   '',   $char_d,
 722         'disabled',     'char', 'NULL', 1,
 723       ],
 724       'primary_key' => 'refnum',
 725       'unique' => [],
 726       'index' => [ ['disabled'] ],
 727     },
 728
 729     'part_svc' => {
 730       'columns' => [
 731         'svcpart',    'serial',    '',   '',
 732         'svc',        'varchar',   '',   $char_d,
 733         'svcdb',      'varchar',   '',   $char_d,
 734         'disabled',   'char',  'NULL',   1,
 735       ],
 736       'primary_key' => 'svcpart',
 737       'unique' => [],
 738       'index' => [ [ 'disabled' ] ],
 739     },
 740
 741     'part_svc_column' => {
 742       'columns' => [
 743         'columnnum',   'serial',         '', '',
 744         'svcpart',     'int',         '', '',
 745         'columnname',  'varchar',     '', 64,
 746         'columnvalue', 'varchar', 'NULL', $char_d,
 747         'columnflag',  'char',    'NULL', 1,
 748       ],
 749       'primary_key' => 'columnnum',
 750       'unique' => [ [ 'svcpart', 'columnname' ] ],
 751       'index' => [ [ 'svcpart' ] ],
 752     },
 753
 754     #(this should be renamed to part_pop)
 755     'svc_acct_pop' => {
 756       'columns' => [
 757         'popnum',    'serial',    '',   '',
 758         'city',      'varchar',   '',   $char_d,
 759         'state',     'varchar',   '',   $char_d,
 760         'ac',        'char',   '',   3,
 761         'exch',      'char',   '',   3,
 762         'loc',       'char',   'NULL',   4, #NULL for legacy purposes
 763       ],
 764       'primary_key' => 'popnum',
 765       'unique' => [],
 766       'index' => [ [ 'state' ] ],
 767     },
 768
 769     'part_pop_local' => {
 770       'columns' => [
 771         'localnum',  'serial',     '',     '',
 772         'popnum',    'int',     '',     '',
 773         'city',      'varchar', 'NULL', $char_d,
 774         'state',     'char',    'NULL', 2,
 775         'npa',       'char',    '',     3,
 776         'nxx',       'char',    '',     3,
 777       ],
 778       'primary_key' => 'localnum',
 779       'unique' => [],
 780       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 781     },
 782
 783     'svc_acct' => {
 784       'columns' => [
 785         'svcnum',    'int',    '',   '',
 786         'username',  'varchar',   '',   $username_len, #unique (& remove dup code)
 787         '_password', 'varchar',   '',   72, #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
 788         'sec_phrase', 'varchar',  'NULL',   $char_d,
 789         'popnum',    'int',    'NULL',   '',
 790         'uid',       'int', 'NULL',   '',
 791         'gid',       'int', 'NULL',   '',
 792         'finger',    'varchar',   'NULL',   $char_d,
 793         'dir',       'varchar',   'NULL',   $char_d,
 794         'shell',     'varchar',   'NULL',   $char_d,
 795         'quota',     'varchar',   'NULL',   $char_d,
 796         'slipip',    'varchar',   'NULL',   15, #four TINYINTs, bah.
 797         'seconds',   'int', 'NULL',   '', #uhhhh
 798         'domsvc',    'int', '',   '',
 799       ],
 800       'primary_key' => 'svcnum',
 801       #'unique' => [ [ 'username', 'domsvc' ] ],
 802       'unique' => [],
 803       'index' => [ ['username'], ['domsvc'] ],
 804     },
 805
 806     #'svc_charge' => {
 807     #  'columns' => [
 808     #    'svcnum',    'int',    '',   '',
 809     #    'amount',    @money_type,
 810     #  ],
 811     #  'primary_key' => 'svcnum',
 812     #  'unique' => [ [] ],
 813     #  'index' => [ [] ],
 814     #},
 815
 816     'svc_domain' => {
 817       'columns' => [
 818         'svcnum',    'int',    '',   '',
 819         'domain',    'varchar',    '',   $char_d,
 820         'catchall',  'int', 'NULL',    '',
 821       ],
 822       'primary_key' => 'svcnum',
 823       'unique' => [ ['domain'] ],
 824       'index' => [],
 825     },
 826
 827     'domain_record' => {
 828       'columns' => [
 829         'recnum',    'serial',     '',  '',
 830         'svcnum',    'int',     '',  '',
 831         #'reczone',   'varchar', '',  $char_d,
 832         'reczone',   'varchar', '',  255,
 833         'recaf',     'char',    '',  2,
 834         'rectype',   'varchar',    '',  5,
 835         #'recdata',   'varchar', '',  $char_d,
 836         'recdata',   'varchar', '',  255,
 837       ],
 838       'primary_key' => 'recnum',
 839       'unique'      => [],
 840       'index'       => [ ['svcnum'] ],
 841     },
 842
 843     'svc_forward' => {
 844       'columns' => [
 845         'svcnum',   'int',            '',   '',
 846         'srcsvc',   'int',        'NULL',   '',
 847         'src',      'varchar',    'NULL',  255,
 848         'dstsvc',   'int',        'NULL',   '',
 849         'dst',      'varchar',    'NULL',  255,
 850       ],
 851       'primary_key' => 'svcnum',
 852       'unique'      => [],
 853       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 854     },
 855
 856     'svc_www' => {
 857       'columns' => [
 858         'svcnum',   'int',    '',  '',
 859         'recnum',   'int',    '',  '',
 860         'usersvc',  'int',    '',  '',
 861       ],
 862       'primary_key' => 'svcnum',
 863       'unique'      => [],
 864       'index'       => [],
 865     },
 866
 867     #'svc_wo' => {
 868     #  'columns' => [
 869     #    'svcnum',    'int',    '',   '',
 870     #    'svcnum',    'int',    '',   '',
 871     #    'svcnum',    'int',    '',   '',
 872     #    'worker',    'varchar',   '',   $char_d,
 873     #    '_date',     @date_type,
 874     #  ],
 875     #  'primary_key' => 'svcnum',
 876     #  'unique' => [ [] ],
 877     #  'index' => [ [] ],
 878     #},
 879
 880     'prepay_credit' => {
 881       'columns' => [
 882         'prepaynum',   'serial',     '',   '',
 883         'identifier',  'varchar', '', $char_d,
 884         'amount',      @money_type,
 885         'seconds',     'int',     'NULL', '',
 886       ],
 887       'primary_key' => 'prepaynum',
 888       'unique'      => [ ['identifier'] ],
 889       'index'       => [],
 890     },
 891
 892     'port' => {
 893       'columns' => [
 894         'portnum',  'serial',     '',   '',
 895         'ip',       'varchar', 'NULL', 15,
 896         'nasport',  'int',     'NULL', '',
 897         'nasnum',   'int',     '',   '',
 898       ],
 899       'primary_key' => 'portnum',
 900       'unique'      => [],
 901       'index'       => [],
 902     },
 903
 904     'nas' => {
 905       'columns' => [
 906         'nasnum',   'serial',     '',    '',
 907         'nas',      'varchar', '',    $char_d,
 908         'nasip',    'varchar', '',    15,
 909         'nasfqdn',  'varchar', '',    $char_d,
 910         'last',     'int',     '',    '',
 911       ],
 912       'primary_key' => 'nasnum',
 913       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
 914       'index'       => [ [ 'last' ] ],
 915     },
 916
 917     'session' => {
 918       'columns' => [
 919         'sessionnum', 'serial',       '',   '',
 920         'portnum',    'int',       '',   '',
 921         'svcnum',     'int',       '',   '',
 922         'login',      @date_type,
 923         'logout',     @date_type,
 924       ],
 925       'primary_key' => 'sessionnum',
 926       'unique'      => [],
 927       'index'       => [ [ 'portnum' ] ],
 928     },
 929
 930     'queue' => {
 931       'columns' => [
 932         'jobnum', 'serial', '', '',
 933         'job', 'text', '', '',
 934         '_date', 'int', '', '',
 935         'status', 'varchar', '', $char_d,
 936         'statustext', 'text', 'NULL', '',
 937         'svcnum', 'int', 'NULL', '',
 938       ],
 939       'primary_key' => 'jobnum',
 940       'unique'      => [],
 941       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
 942     },
 943
 944     'queue_arg' => {
 945       'columns' => [
 946         'argnum', 'serial', '', '',
 947         'jobnum', 'int', '', '',
 948         'arg', 'text', 'NULL', '',
 949       ],
 950       'primary_key' => 'argnum',
 951       'unique'      => [],
 952       'index'       => [ [ 'jobnum' ] ],
 953     },
 954
 955     'queue_depend' => {
 956       'columns' => [
 957         'dependnum', 'serial', '', '',
 958         'jobnum', 'int', '', '',
 959         'depend_jobnum', 'int', '', '',
 960       ],
 961       'primary_key' => 'dependnum',
 962       'unique'      => [],
 963       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
 964     },
 965
 966     'export_svc' => {
 967       'columns' => [
 968         'exportsvcnum' => 'serial', '', '',
 969         'exportnum'    => 'int', '', '',
 970         'svcpart'      => 'int', '', '',
 971       ],
 972       'primary_key' => 'exportsvcnum',
 973       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
 974       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
 975     },
 976
 977     'part_export' => {
 978       'columns' => [
 979         'exportnum', 'serial', '', '',
 980         #'svcpart',   'int', '', '',
 981         'machine', 'varchar', '', $char_d,
 982         'exporttype', 'varchar', '', $char_d,
 983         'nodomain',     'char', 'NULL', 1,
 984       ],
 985       'primary_key' => 'exportnum',
 986       'unique'      => [],
 987       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
 988     },
 989
 990     'part_export_option' => {
 991       'columns' => [
 992         'optionnum', 'serial', '', '',
 993         'exportnum', 'int', '', '',
 994         'optionname', 'varchar', '', $char_d,
 995         'optionvalue', 'text', 'NULL', '',
 996       ],
 997       'primary_key' => 'optionnum',
 998       'unique'      => [],
 999       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1000     },
1001
1002     'radius_usergroup' => {
1003       'columns' => [
1004         'usergroupnum', 'serial', '', '',
1005         'svcnum',       'int', '', '',
1006         'groupname',    'varchar', '', $char_d,
1007       ],
1008       'primary_key' => 'usergroupnum',
1009       'unique'      => [],
1010       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1011     },
1012
1013     'msgcat' => {
1014       'columns' => [
1015         'msgnum', 'serial', '', '',
1016         'msgcode', 'varchar', '', $char_d,
1017         'locale', 'varchar', '', 16,
1018         'msg', 'text', '', '',
1019       ],
1020       'primary_key' => 'msgnum',
1021       'unique'      => [ [ 'msgcode', 'locale' ] ],
1022       'index'       => [],
1023     },
1024
1025     'cust_tax_exempt' => {
1026       'columns' => [
1027         'exemptnum', 'serial', '', '',
1028         'custnum',   'int', '', '',
1029         'taxnum',    'int', '', '',
1030         'year',      'int', '', '',
1031         'month',     'int', '', '',
1032         'amount',   @money_type,
1033       ],
1034       'primary_key' => 'exemptnum',
1035       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1036       'index'       => [],
1037     },
1038
1039     'router' => {
1040       'columns' => [
1041         'routernum', 'serial', '', '',
1042         'routername', 'varchar', '', $char_d,
1043         'svcnum', 'int', 'NULL', '',
1044       ],
1045       'primary_key' => 'routernum',
1046       'unique'      => [],
1047       'index'       => [],
1048     },
1049
1050     'part_svc_router' => {
1051       'columns' => [
1052         'svcpart', 'int', '', '',
1053         'routernum', 'int', '', '',
1054       ],
1055       'primary_key' => '',
1056       'unique'      => [],
1057       'index'       => [],
1058     },
1059
1060     'addr_block' => {
1061       'columns' => [
1062         'blocknum', 'serial', '', '',
1063         'routernum', 'int', '', '',
1064         'ip_gateway', 'varchar', '', 15,
1065         'ip_netmask', 'int', '', '',
1066       ],
1067       'primary_key' => 'blocknum',
1068       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1069       'index'       => [],
1070     },
1071
1072     'svc_broadband' => {
1073       'columns' => [
1074         'svcnum', 'int', '', '',
1075         'blocknum', 'int', '', '',
1076         'speed_up', 'int', '', '',
1077         'speed_down', 'int', '', '',
1078         'ip_addr', 'varchar', '', 15,
1079       ],
1080       'primary_key' => 'svcnum',
1081       'unique'      => [],
1082       'index'       => [],
1083     },
1084
1085     'part_virtual_field' => {
1086       'columns' => [
1087         'vfieldpart', 'int', '', '',
1088         'dbtable', 'varchar', '', 32,
1089         'name', 'varchar', '', 32,
1090         'check_block', 'text', 'NULL', '',
1091         'length', 'int', 'NULL', '',
1092         'list_source', 'text', 'NULL', '',
1093         'label', 'varchar', 'NULL', 80,
1094       ],
1095       'primary_key' => 'vfieldpart',
1096       'unique' => [],
1097       'index' => [],
1098     },
1099
1100     'virtual_field' => {
1101       'columns' => [
1102         'recnum', 'int', '', '',
1103         'vfieldpart', 'int', '', '',
1104         'value', 'varchar', '', 128,
1105       ],
1106       'primary_key' => '',
1107       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1108       'index' => [],
1109     },
1110
1111     'acct_snarf' => {
1112       'columns' => [
1113         'snarfnum',  'int', '', '',
1114         'svcnum',    'int', '', '',
1115         'machine',   'varchar', '', 255,
1116         'protocol',  'varchar', '', $char_d,
1117         'username',  'varchar', '', $char_d,
1118         '_password', 'varchar', '', $char_d,
1119       ],
1120       'primary_key' => 'snarfnum',
1121       'unique' => [],
1122       'index'  => [ [ 'svcnum' ] ],
1123     },
1124
1125     'svc_external' => {
1126       'columns' => [
1127         'svcnum', 'int', '', '',
1128         'id',     'int', '', '',
1129         'title',  'varchar', 'NULL', $char_d,
1130       ],
1131       'primary_key' => 'svcnum',
1132       'unique'      => [],
1133       'index'       => [],
1134     },
1135
1136   );
1137
1138   %tables;
1139
1140 }
1141