fs_selfservice/FS-SelfService/SelfService.pm

   1 package FS::SelfService;
   2
   3 use strict;
   4 use vars qw($VERSION @ISA @EXPORT_OK $dir $socket %autoload $tag);
   5 use Exporter;
   6 use Socket;
   7 use FileHandle;
   8 #use IO::Handle;
   9 use IO::Select;
  10 use Storable 2.09 qw(nstore_fd fd_retrieve);
  11
  12 $VERSION = '0.03';
  13
  14 @ISA = qw( Exporter );
  15
  16 $dir = "/usr/local/freeside";
  17 $socket =  "$dir/selfservice_socket";
  18 $socket .= '.'.$tag if defined $tag && length($tag);
  19
  20 #maybe should ask ClientAPI for this list
  21 %autoload = (
  22   'passwd'               => 'passwd/passwd',
  23   'chfn'                 => 'passwd/passwd',
  24   'chsh'                 => 'passwd/passwd',
  25   'login'                => 'MyAccount/login',
  26   'logout'               => 'MyAccount/logout',
  27   'customer_info'        => 'MyAccount/customer_info',
  28   'edit_info'            => 'MyAccount/edit_info',     #add to ss cgi!
  29   'invoice'              => 'MyAccount/invoice',
  30   'invoice_logo'         => 'MyAccount/invoice_logo',
  31   'list_invoices'        => 'MyAccount/list_invoices', #?
  32   'cancel'               => 'MyAccount/cancel',        #add to ss cgi!
  33   'payment_info'         => 'MyAccount/payment_info',
  34   'process_payment'      => 'MyAccount/process_payment',
  35   'process_prepay'       => 'MyAccount/process_prepay',
  36   'list_pkgs'            => 'MyAccount/list_pkgs',     #add to ss cgi!
  37   'order_pkg'            => 'MyAccount/order_pkg',     #add to ss cgi!
  38   'cancel_pkg'           => 'MyAccount/cancel_pkg',    #add to ss cgi!
  39   'charge'               => 'MyAccount/charge',        #?
  40   'part_svc_info'        => 'MyAccount/part_svc_info',
  41   'provision_acct'       => 'MyAccount/provision_acct',
  42   'provision_external'   => 'MyAccount/provision_external',
  43   'unprovision_svc'      => 'MyAccount/unprovision_svc',
  44   'signup_info'          => 'Signup/signup_info',
  45   'new_customer'         => 'Signup/new_customer',
  46   'agent_login'          => 'Agent/agent_login',
  47   'agent_logout'         => 'Agent/agent_logout',
  48   'agent_info'           => 'Agent/agent_info',
  49   'agent_list_customers' => 'Agent/agent_list_customers',
  50 );
  51 @EXPORT_OK = ( keys(%autoload), qw( regionselector expselect popselector ) );
  52
  53 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
  54 $ENV{'SHELL'} = '/bin/sh';
  55 $ENV{'IFS'} = " \t\n";
  56 $ENV{'CDPATH'} = '';
  57 $ENV{'ENV'} = '';
  58 $ENV{'BASH_ENV'} = '';
  59
  60 my $freeside_uid = scalar(getpwnam('freeside'));
  61 die "not running as the freeside user\n" if $> != $freeside_uid;
  62
  63 -e $dir or die "FATAL: $dir doesn't exist!";
  64 -d $dir or die "FATAL: $dir isn't a directory!";
  65 -r $dir or die "FATAL: Can't read $dir as freeside user!";
  66 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
  67
  68 foreach my $autoload ( keys %autoload ) {
  69
  70   my $eval =
  71   "sub $autoload { ". '
  72                    my $param;
  73                    if ( ref($_[0]) ) {
  74                      $param = shift;
  75                    } else {
  76                      $param = { @_ };
  77                    }
  78
  79                    $param->{_packet} = \''. $autoload{$autoload}. '\';
  80
  81                    simple_packet($param);
  82                  }';
  83
  84   eval $eval;
  85   die $@ if $@;
  86
  87 }
  88
  89 sub simple_packet {
  90   my $packet = shift;
  91   socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
  92   connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
  93   nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
  94   SOCK->flush;
  95
  96   #shoudl trap: Magic number checking on storable file failed at blib/lib/Storable.pm (autosplit into blib/lib/auto/Storable/fd_retrieve.al) line 337, at /usr/local/share/perl/5.6.1/FS/SelfService.pm line 71
  97
  98   #block until there is a message on socket
  99 #  my $w = new IO::Select;
 100 #  $w->add(\*SOCK);
 101 #  my @wait = $w->can_read;
 102   my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
 103   die $return->{'_error'} if defined $return->{_error} && $return->{_error};
 104
 105   $return;
 106 }
 107
 108 =head1 NAME
 109
 110 FS::SelfService - Freeside self-service API
 111
 112 =head1 SYNOPSIS
 113
 114   # password and shell account changes
 115   use FS::SelfService qw(passwd chfn chsh);
 116
 117   # "my account" functionality
 118   use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
 119
 120   my $rv = login( { 'username' => $username,
 121                     'domain'   => $domain,
 122                     'password' => $password,
 123                   }
 124                 );
 125
 126   if ( $rv->{'error'} ) {
 127     #handle login error...
 128   } else {
 129     #successful login
 130     my $session_id = $rv->{'session_id'};
 131   }
 132
 133   my $customer_info = customer_info( { 'session_id' => $session_id } );
 134
 135   #payment_info and process_payment are available in 1.5+ only
 136   my $payment_info = payment_info( { 'session_id' => $session_id } );
 137
 138   #!!! process_payment example
 139
 140   #!!! list_pkgs example
 141
 142   #!!! order_pkg example
 143
 144   #!!! cancel_pkg example
 145
 146   # signup functionality
 147   use FS::SelfService qw( signup_info new_customer );
 148
 149   my $signup_info = signup_info;
 150
 151   $rv = new_customer( {
 152                         'first'            => $first,
 153                         'last'             => $last,
 154                         'company'          => $company,
 155                         'address1'         => $address1,
 156                         'address2'         => $address2,
 157                         'city'             => $city,
 158                         'state'            => $state,
 159                         'zip'              => $zip,
 160                         'country'          => $country,
 161                         'daytime'          => $daytime,
 162                         'night'            => $night,
 163                         'fax'              => $fax,
 164                         'payby'            => $payby,
 165                         'payinfo'          => $payinfo,
 166                         'paycvv'           => $paycvv,
 167                         'paystart_month'   => $paystart_month
 168                         'paystart_year'    => $paystart_year,
 169                         'payissue'         => $payissue,
 170                         'payip'            => $payip
 171                         'paydate'          => $paydate,
 172                         'payname'          => $payname,
 173                         'invoicing_list'   => $invoicing_list,
 174                         'referral_custnum' => $referral_custnum,
 175                         'pkgpart'          => $pkgpart,
 176                         'username'         => $username,
 177                         '_password'        => $password,
 178                         'popnum'           => $popnum,
 179                         'agentnum'         => $agentnum,
 180                       }
 181                     );
 182
 183   my $error = $rv->{'error'};
 184   if ( $error eq '_decline' ) {
 185     print_decline();
 186   } elsif ( $error ) {
 187     reprint_signup();
 188   } else {
 189     print_success();
 190   }
 191
 192 =head1 DESCRIPTION
 193
 194 Use this API to implement your own client "self-service" module.
 195
 196 If you just want to customize the look of the existing "self-service" module,
 197 see XXXX instead.
 198
 199 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
 200
 201 =over 4
 202
 203 =item passwd
 204
 205 =item chfn
 206
 207 =item chsh
 208
 209 =back
 210
 211 =head1 "MY ACCOUNT" FUNCTIONS
 212
 213 =over 4
 214
 215 =item login HASHREF
 216
 217 Creates a user session.  Takes a hash reference as parameter with the
 218 following keys:
 219
 220 =over 4
 221
 222 =item username
 223
 224 =item domain
 225
 226 =item password
 227
 228 =back
 229
 230 Returns a hash reference with the following keys:
 231
 232 =over 4
 233
 234 =item error
 235
 236 Empty on success, or an error message on errors.
 237
 238 =item session_id
 239
 240 Session identifier for successful logins
 241
 242 =back
 243
 244 =item customer_info HASHREF
 245
 246 Returns general customer information.
 247
 248 Takes a hash reference as parameter with a single key: B<session_id>
 249
 250 Returns a hash reference with the following keys:
 251
 252 =over 4
 253
 254 =item name
 255
 256 Customer name
 257
 258 =item balance
 259
 260 Balance owed
 261
 262 =item open
 263
 264 Array reference of hash references of open inoices.  Each hash reference has
 265 the following keys: invnum, date, owed
 266
 267 =item small_custview
 268
 269 An HTML fragment containing shipping and billing addresses.
 270
 271 =item The following fields are also returned: first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo payname month year invoicing_list postal_invoicing
 272
 273 =back
 274
 275 =item edit_info HASHREF
 276
 277 Takes a hash reference as parameter with any of the following keys:
 278
 279 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo paycvv payname month year invoicing_list postal_invoicing
 280
 281 If a field exists, the customer record is updated with the new value of that
 282 field.  If a field does not exist, that field is not changed on the customer
 283 record.
 284
 285 Returns a hash reference with a single key, B<error>, empty on success, or an
 286 error message on errors
 287
 288 =item invoice HASHREF
 289
 290 Returns an invoice.  Takes a hash reference as parameter with two keys:
 291 session_id and invnum
 292
 293 Returns a hash reference with the following keys:
 294
 295 =over 4
 296
 297 =item error
 298
 299 Empty on success, or an error message on errors
 300
 301 =item invnum
 302
 303 Invoice number
 304
 305 =item invoice_text
 306
 307 Invoice text
 308
 309 =back
 310
 311 =item list_invoices HASHREF
 312
 313 Returns a list of all customer invoices.  Takes a hash references with a single
 314 key, session_id.
 315
 316 Returns a hash reference with the following keys:
 317
 318 =over 4
 319
 320 =item error
 321
 322 Empty on success, or an error message on errors
 323
 324 =item invoices
 325
 326 Reference to array of hash references with the following keys:
 327
 328 =over 4
 329
 330 =item invnum
 331
 332 Invoice ID
 333
 334 =item _date
 335
 336 Invoice date, in UNIX epoch time
 337
 338 =back
 339
 340 =back
 341
 342 =item cancel HASHREF
 343
 344 Cancels this customer.
 345
 346 Takes a hash reference as parameter with a single key: B<session_id>
 347
 348 Returns a hash reference with a single key, B<error>, which is empty on
 349 success or an error message on errors.
 350
 351 =item payment_info HASHREF
 352
 353 Returns information that may be useful in displaying a payment page.
 354
 355 Takes a hash reference as parameter with a single key: B<session_id>.
 356
 357 Returns a hash reference with the following keys:
 358
 359 =over 4
 360
 361 =item error
 362
 363 Empty on success, or an error message on errors
 364
 365 =item balance
 366
 367 Balance owed
 368
 369 =item payname
 370
 371 Exact name on credit card (CARD/DCRD)
 372
 373 =item address1
 374
 375 =item address2
 376
 377 =item city
 378
 379 =item state
 380
 381 =item zip
 382
 383 =item payby
 384
 385 Customer's current default payment type.
 386
 387 =item card_type
 388
 389 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
 390
 391 =item payinfo
 392
 393 For CARD/DCRD payment types, the card number
 394
 395 =item month
 396
 397 For CARD/DCRD payment types, expiration month
 398
 399 =item year
 400
 401 For CARD/DCRD payment types, expiration year
 402
 403 =item cust_main_county
 404
 405 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>).  Note these are not FS::cust_main_county objects, but hash references of columns and values.
 406
 407 =item states
 408
 409 Array reference of all states in the current default country.
 410
 411 =item card_types
 412
 413 Hash reference of card types; keys are card types, values are the exact strings
 414 passed to the process_payment function
 415
 416 =item paybatch
 417
 418 Unique transaction identifier (prevents multiple charges), passed to the
 419 process_payment function
 420
 421 =back
 422
 423 =item process_payment HASHREF
 424
 425 Processes a payment and possible change of address or payment type.  Takes a
 426 hash reference as parameter with the following keys:
 427
 428 =over 4
 429
 430 =item session_id
 431
 432 =item save
 433
 434 If true, address and card information entered will be saved for subsequent
 435 transactions.
 436
 437 =item auto
 438
 439 If true, future credit card payments will be done automatically (sets payby to
 440 CARD).  If false, future credit card payments will be done on-demand (sets
 441 payby to DCRD).  This option only has meaning if B<save> is set true.
 442
 443 =item payname
 444
 445 =item address1
 446
 447 =item address2
 448
 449 =item city
 450
 451 =item state
 452
 453 =item zip
 454
 455 =item payinfo
 456
 457 Card number
 458
 459 =item month
 460
 461 Card expiration month
 462
 463 =item year
 464
 465 Card expiration year
 466
 467 =item paybatch
 468
 469 Unique transaction identifier, returned from the payment_info function.
 470 Prevents multiple charges.
 471
 472 =back
 473
 474 Returns a hash reference with a single key, B<error>, empty on success, or an
 475 error message on errors
 476
 477 =item list_pkgs
 478
 479 Returns package information for this customer.
 480
 481 Takes a hash reference as parameter with a single key: B<session_id>
 482
 483 Returns a hash reference containing customer package information.  The hash reference contains the following keys:
 484
 485 =over 4
 486
 487
 488 =item cust_pkg HASHREF
 489
 490 Array reference of hash references, each of which has the fields of a cust_pkg
 491 record (see L<FS::cust_pkg>) as well as the fields below.  Note these are not
 492 the internal FS:: objects, but hash references of columns and values.
 493
 494 =item all fields of part_pkg (XXXpare this down to a secure subset)
 495
 496 =item part_svc - An array of hash references, each of which has the following keys:
 497
 498 =over 4
 499
 500 =item all fields of part_svc (XXXpare this down to a secure subset)
 501
 502 =item avail
 503
 504 =back
 505
 506 =item error
 507
 508 Empty on success, or an error message on errors.
 509
 510 =back
 511
 512 =item order_pkg
 513
 514 Orders a package for this customer.
 515
 516 Takes a hash reference as parameter with the following keys:
 517
 518 =over 4
 519
 520 =item session_id
 521
 522 =item pkgpart
 523
 524 =item svcpart
 525
 526 optional svcpart, required only if the package definition does not contain
 527 one svc_acct service definition with quantity 1 (it may contain others with
 528 quantity >1)
 529
 530 =item username
 531
 532 =item _password
 533
 534 =item sec_phrase
 535
 536 =item popnum
 537
 538 =back
 539
 540 Returns a hash reference with a single key, B<error>, empty on success, or an
 541 error message on errors.  The special error '_decline' is returned for
 542 declined transactions.
 543
 544 =item cancel_pkg
 545
 546 Cancels a package for this customer.
 547
 548 Takes a hash reference as parameter with the following keys:
 549
 550 =over 4
 551
 552 =item session_id
 553
 554 =item pkgpart
 555
 556 =back
 557
 558 Returns a hash reference with a single key, B<error>, empty on success, or an
 559 error message on errors.
 560
 561 =back
 562
 563 =head1 SIGNUP FUNCTIONS
 564
 565 =over 4
 566
 567 =item signup_info HASHREF
 568
 569 Takes a hash reference as parameter with the following keys:
 570
 571 =over 4
 572
 573 =item session_id - Optional agent/reseller interface session
 574
 575 =back
 576
 577 Returns a hash reference containing information that may be useful in
 578 displaying a signup page.  The hash reference contains the following keys:
 579
 580 =over 4
 581
 582 =item cust_main_county
 583
 584 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>).  Note these are not FS::cust_main_county objects, but hash references of columns and values.
 585
 586 =item part_pkg
 587
 588 Available packages - array reference of hash references, each of which has the fields of a part_pkg record (see L<FS::part_pkg>).  Each hash reference also has an additional 'payby' field containing an array reference of acceptable payment types specific to this package (see below and L<FS::part_pkg/payby>).  Note these are not FS::part_pkg objects, but hash references of columns and values.  Requires the 'signup_server-default_agentnum' configuration value to be set, or
 589 an agentnum specified explicitly via reseller interface session_id in the
 590 options.
 591
 592 =item agent
 593
 594 Array reference of hash references, each of which has the fields of an agent record (see L<FS::agent>).  Note these are not FS::agent objects, but hash references of columns and values.
 595
 596 =item agentnum2part_pkg
 597
 598 Hash reference; keys are agentnums, values are array references of available packages for that agent, in the same format as the part_pkg arrayref above.
 599
 600 =item svc_acct_pop
 601
 602 Access numbers - array reference of hash references, each of which has the fields of an svc_acct_pop record (see L<FS::svc_acct_pop>).  Note these are not FS::svc_acct_pop objects, but hash references of columns and values.
 603
 604 =item security_phrase
 605
 606 True if the "security_phrase" feature is enabled
 607
 608 =item payby
 609
 610 Array reference of acceptable payment types for signup
 611
 612 =over 4
 613
 614 =item CARD (credit card - automatic)
 615
 616 =item DCRD (credit card - on-demand - version 1.5+ only)
 617
 618 =item CHEK (electronic check - automatic)
 619
 620 =item DCHK (electronic check - on-demand - version 1.5+ only)
 621
 622 =item LECB (Phone bill billing)
 623
 624 =item BILL (billing, not recommended for signups)
 625
 626 =item COMP (free, definately not recommended for signups)
 627
 628 =item PREPAY (special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL)
 629
 630 =back
 631
 632 =item cvv_enabled
 633
 634 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
 635
 636 =item msgcat
 637
 638 Hash reference of message catalog values, to support error message customization.  Currently available keys are: passwords_dont_match, invalid_card, unknown_card_type, and not_a (as in "Not a Discover card").  Values are configured in the web interface under "View/Edit message catalog".
 639
 640 =item statedefault
 641
 642 Default state
 643
 644 =item countrydefault
 645
 646 Default country
 647
 648 =back
 649
 650 =item new_customer HASHREF
 651
 652 Creates a new customer.  Takes a hash reference as parameter with the
 653 following keys:
 654
 655 =over 4
 656
 657 =item first - first name (required)
 658
 659 =item last - last name (required)
 660
 661 =item ss (not typically collected; mostly used for ACH transactions)
 662
 663 =item company
 664
 665 =item address1 (required)
 666
 667 =item address2
 668
 669 =item city (required)
 670
 671 =item county
 672
 673 =item state (required)
 674
 675 =item zip (required)
 676
 677 =item daytime - phone
 678
 679 =item night - phone
 680
 681 =item fax - phone
 682
 683 =item payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
 684
 685 =item payinfo - Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
 686
 687 =item paycvv - Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
 688
 689 =item paydate - Expiration date for CARD/DCRD
 690
 691 =item payname - Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
 692
 693 =item invoicing_list - comma-separated list of email addresses for email invoices.  The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses),
 694
 695 =item referral_custnum - referring customer number
 696
 697 =item pkgpart - pkgpart of initial package
 698
 699 =item username
 700
 701 =item _password
 702
 703 =item sec_phrase - security phrase
 704
 705 =item popnum - access number (index, not the literal number)
 706
 707 =item agentnum - agent number
 708
 709 =back
 710
 711 Returns a hash reference with the following keys:
 712
 713 =over 4
 714
 715 =item error Empty on success, or an error message on errors.  The special error '_decline' is returned for declined transactions; other error messages should be suitable for display to the user (and are customizable in under Sysadmin | View/Edit message catalog)
 716
 717 =back
 718
 719 =item regionselector HASHREF | LIST
 720
 721 Takes as input a hashref or list of key/value pairs with the following keys:
 722
 723 =over 4
 724
 725 =item selected_county
 726
 727 =item selected_state
 728
 729 =item selected_country
 730
 731 =item prefix - Specify a unique prefix string  if you intend to use the HTML output multiple time son one page.
 732
 733 =item onchange - Specify a javascript subroutine to call on changes
 734
 735 =item default_state
 736
 737 =item default_country
 738
 739 =item locales - An arrayref of hash references specifying regions.  Normally you can just pass the value of the I<cust_main_county> field returned by B<signup_info>.
 740
 741 =back
 742
 743 Returns a list consisting of three HTML fragments for county selection,
 744 state selection and country selection, respectively.
 745
 746 =cut
 747
 748 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
 749 sub regionselector {
 750   my $param;
 751   if ( ref($_[0]) ) {
 752     $param = shift;
 753   } else {
 754     $param = { @_ };
 755   }
 756   $param->{'selected_country'} ||= $param->{'default_country'};
 757   $param->{'selected_state'} ||= $param->{'default_state'};
 758
 759   my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
 760
 761   my $countyflag = 0;
 762
 763   my %cust_main_county;
 764
 765 #  unless ( @cust_main_county ) { #cache
 766     #@cust_main_county = qsearch('cust_main_county', {} );
 767     #foreach my $c ( @cust_main_county ) {
 768     foreach my $c ( @{ $param->{'locales'} } ) {
 769       #$countyflag=1 if $c->county;
 770       $countyflag=1 if $c->{county};
 771       #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
 772       #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
 773       $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
 774     }
 775 #  }
 776   $countyflag=1 if $param->{selected_county};
 777
 778   my $script_html = <<END;
 779     <SCRIPT>
 780     function opt(what,value,text) {
 781       var optionName = new Option(text, value, false, false);
 782       var length = what.length;
 783       what.options[length] = optionName;
 784     }
 785     function ${prefix}country_changed(what) {
 786       country = what.options[what.selectedIndex].text;
 787       for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
 788           what.form.${prefix}state.options[i] = null;
 789 END
 790       #what.form.${prefix}state.options[0] = new Option('', '', false, true);
 791
 792   foreach my $country ( sort keys %cust_main_county ) {
 793     $script_html .= "\nif ( country == \"$country\" ) {\n";
 794     foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
 795       my $text = $state || '(n/a)';
 796       $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
 797     }
 798     $script_html .= "}\n";
 799   }
 800
 801   $script_html .= <<END;
 802     }
 803     function ${prefix}state_changed(what) {
 804 END
 805
 806   if ( $countyflag ) {
 807     $script_html .= <<END;
 808       state = what.options[what.selectedIndex].text;
 809       country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
 810       for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
 811           what.form.${prefix}county.options[i] = null;
 812 END
 813
 814     foreach my $country ( sort keys %cust_main_county ) {
 815       $script_html .= "\nif ( country == \"$country\" ) {\n";
 816       foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
 817         $script_html .= "\nif ( state == \"$state\" ) {\n";
 818           #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
 819           foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
 820             my $text = $county || '(n/a)';
 821             $script_html .=
 822               qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
 823           }
 824         $script_html .= "}\n";
 825       }
 826       $script_html .= "}\n";
 827     }
 828   }
 829
 830   $script_html .= <<END;
 831     }
 832     </SCRIPT>
 833 END
 834
 835   my $county_html = $script_html;
 836   if ( $countyflag ) {
 837     $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
 838     $county_html .= '</SELECT>';
 839   } else {
 840     $county_html .=
 841       qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
 842   }
 843
 844   my $state_html = qq!<SELECT NAME="${prefix}state" !.
 845                    qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
 846   foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
 847     my $text = $state || '(n/a)';
 848     my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
 849     $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
 850   }
 851   $state_html .= '</SELECT>';
 852
 853   $state_html .= '</SELECT>';
 854
 855   my $country_html = qq!<SELECT NAME="${prefix}country" !.
 856                      qq!onChange="${prefix}country_changed(this); $param->{'onchange'}">!;
 857   my $countrydefault = $param->{default_country} || 'US';
 858   foreach my $country (
 859     sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
 860       keys %cust_main_county
 861   ) {
 862     my $selected = $country eq $param->{'selected_country'} ? ' SELECTED' : '';
 863     $country_html .= "\n<OPTION$selected>$country</OPTION>"
 864   }
 865   $country_html .= '</SELECT>';
 866
 867   ($county_html, $state_html, $country_html);
 868
 869 }
 870
 871 #=item expselect HASHREF | LIST
 872 #
 873 #Takes as input a hashref or list of key/value pairs with the following keys:
 874 #
 875 #=over 4
 876 #
 877 #=item prefix - Specify a unique prefix string  if you intend to use the HTML output multiple time son one page.
 878 #
 879 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
 880 #
 881 #=back
 882
 883 =item expselect PREFIX [ DATE ]
 884
 885 Takes as input a unique prefix string and the current expiration date, in
 886 yyyy-mm-dd or m-d-yyyy format
 887
 888 Returns an HTML fragments for expiration date selection.
 889
 890 =cut
 891
 892 sub expselect {
 893   #my $param;
 894   #if ( ref($_[0]) ) {
 895   #  $param = shift;
 896   #} else {
 897   #  $param = { @_ };
 898   #my $prefix = $param->{'prefix'};
 899   #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
 900   #my $date =   exists($param->{'date'})   ? $param->{'date'}   : '';
 901   my $prefix = shift;
 902   my $date = scalar(@_) ? shift : '';
 903
 904   my( $m, $y ) = ( 0, 0 );
 905   if ( $date  =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
 906     ( $m, $y ) = ( $2, $1 );
 907   } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
 908     ( $m, $y ) = ( $1, $3 );
 909   }
 910   my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
 911   for ( 1 .. 12 ) {
 912     $return .= "<OPTION";
 913     $return .= " SELECTED" if $_ == $m;
 914     $return .= ">$_";
 915   }
 916   $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
 917   my @t = localtime;
 918   my $thisYear = $t[5] + 1900;
 919   for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. 2037 ) {
 920     $return .= "<OPTION";
 921     $return .= " SELECTED" if $_ == $y;
 922     $return .= ">$_";
 923   }
 924   $return .= "</SELECT>";
 925
 926   $return;
 927 }
 928
 929 =item popselector HASHREF | LIST
 930
 931 Takes as input a hashref or list of key/value pairs with the following keys:
 932
 933 =over 4
 934
 935 =item popnum
 936
 937 =item pops - An arrayref of hash references specifying access numbers.  Normally you can just pass the value of the I<svc_acct_pop> field returned by B<signup_info>.
 938
 939 =back
 940
 941 Returns an HTML fragment for access number selection.
 942
 943 =cut
 944
 945 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
 946 sub popselector {
 947   my $param;
 948   if ( ref($_[0]) ) {
 949     $param = shift;
 950   } else {
 951     $param = { @_ };
 952   }
 953   my $popnum = $param->{'popnum'};
 954   my $pops = $param->{'pops'};
 955
 956   return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
 957   return $pops->[0]{city}. ', '. $pops->[0]{state}.
 958          ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
 959          '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
 960     if scalar(@$pops) == 1;
 961
 962   my %pop = ();
 963   my %popnum2pop = ();
 964   foreach (@$pops) {
 965     push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
 966     $popnum2pop{$_->{popnum}} = $_;
 967   }
 968
 969   my $text = <<END;
 970     <SCRIPT>
 971     function opt(what,href,text) {
 972       var optionName = new Option(text, href, false, false)
 973       var length = what.length;
 974       what.options[length] = optionName;
 975     }
 976 END
 977
 978   my $init_popstate = $param->{'init_popstate'};
 979   if ( $init_popstate ) {
 980     $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
 981              $init_popstate. '">';
 982   } else {
 983     $text .= <<END;
 984       function acstate_changed(what) {
 985         state = what.options[what.selectedIndex].text;
 986         what.form.popac.options.length = 0
 987         what.form.popac.options[0] = new Option("Area code", "-1", false, true);
 988 END
 989   }
 990
 991   my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
 992   foreach my $state ( sort { $a cmp $b } @states ) {
 993     $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
 994
 995     foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
 996       $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
 997       if ($ac eq $param->{'popac'}) {
 998         $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
 999       }
1000     }
1001     $text .= "}\n" unless $init_popstate;
1002   }
1003   $text .= "popac_changed(what.form.popac)}\n";
1004
1005   $text .= <<END;
1006   function popac_changed(what) {
1007     ac = what.options[what.selectedIndex].text;
1008     what.form.popnum.options.length = 0;
1009     what.form.popnum.options[0] = new Option("City", "-1", false, true);
1010
1011 END
1012
1013   foreach my $state ( @states ) {
1014     foreach my $popac ( keys %{ $pop{$state} } ) {
1015       $text .= "\nif ( ac == \"$popac\" ) {\n";
1016
1017       foreach my $pop ( @{$pop{$state}->{$popac}}) {
1018         my $o_popnum = $pop->{popnum};
1019         my $poptext =  $pop->{city}. ', '. $pop->{state}.
1020                        ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1021
1022         $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1023         if ($popnum == $o_popnum) {
1024           $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1025         }
1026       }
1027       $text .= "}\n";
1028     }
1029   }
1030
1031
1032   $text .= "}\n</SCRIPT>\n";
1033
1034   $text .=
1035     qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1036     qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1037   $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1038            ">$_" foreach sort { $a cmp $b } @states;
1039   $text .= '</SELECT>'; #callback? return 3 html pieces?  #'</TD>';
1040
1041   $text .=
1042     qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1043     qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1044
1045   $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1046
1047
1048   #comment this block to disable initial list polulation
1049   my @initial_select = ();
1050   if ( scalar( @$pops ) > 100 ) {
1051     push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1052   } else {
1053     @initial_select = @$pops;
1054   }
1055   foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1056     $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1057              ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1058              $pop->{city}. ', '. $pop->{state}.
1059                ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1060   }
1061
1062   $text .= qq!</SELECT></TD></TR></TABLE>!;
1063
1064   $text;
1065
1066 }
1067
1068 =back
1069
1070 =head1 RESELLER FUNCTIONS
1071
1072 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1073 with their active session, and the B<customer_info> and B<order_pkg> functions
1074 with their active session and an additional I<custnum> parameter.
1075
1076 =over 4
1077
1078 =item agent_login
1079
1080 =item agent_info
1081
1082 =item agent_list_customers
1083
1084 =back
1085
1086 =head1 BUGS
1087
1088 =head1 SEE ALSO
1089
1090 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>
1091
1092 =cut
1093
1094 1;
1095