fs_selfservice/FS-SelfService/SelfService.pm

   1 package FS::SelfService;
   2
   3 use strict;
   4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
   5              $skip_uid_check $dir $socket %autoload $tag );
   6 use Exporter;
   7 use Socket;
   8 use FileHandle;
   9 #use IO::Handle;
  10 use IO::Select;
  11 use Storable 2.09 qw(nstore_fd fd_retrieve);
  12
  13 $VERSION = '0.03';
  14
  15 @ISA = qw( Exporter );
  16
  17 $DEBUG = 0;
  18
  19 $dir = "/usr/local/freeside";
  20 $socket =  "$dir/selfservice_socket";
  21 $socket .= '.'.$tag if defined $tag && length($tag);
  22
  23 #maybe should ask ClientAPI for this list
  24 %autoload = (
  25   'passwd'                    => 'passwd/passwd',
  26   'chfn'                      => 'passwd/passwd',
  27   'chsh'                      => 'passwd/passwd',
  28   'login_info'                => 'MyAccount/login_info',
  29   'login'                     => 'MyAccount/login',
  30   'logout'                    => 'MyAccount/logout',
  31   'switch_acct'               => 'MyAccount/switch_acct',
  32   'customer_info'             => 'MyAccount/customer_info',
  33   'customer_info_short'       => 'MyAccount/customer_info_short',
  34   'edit_info'                 => 'MyAccount/edit_info',     #add to ss cgi!
  35   'invoice'                   => 'MyAccount/invoice',
  36   'invoice_pdf'               => 'MyAccount/invoice_pdf',
  37   'legacy_invoice'            => 'MyAccount/legacy_invoice',
  38   'legacy_invoice_pdf'        => 'MyAccount/legacy_invoice_pdf',
  39   'invoice_logo'              => 'MyAccount/invoice_logo',
  40   'list_invoices'             => 'MyAccount/list_invoices', #?
  41   'cancel'                    => 'MyAccount/cancel',        #add to ss cgi!
  42   'payment_info'              => 'MyAccount/payment_info',
  43   'payment_info_renew_info'   => 'MyAccount/payment_info_renew_info',
  44   'process_payment'           => 'MyAccount/process_payment',
  45   'store_payment'             => 'MyAccount/store_payment',
  46   'process_stored_payment'    => 'MyAccount/process_stored_payment',
  47   'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
  48   'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
  49   'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
  50   'process_prepay'            => 'MyAccount/process_prepay',
  51   'realtime_collect'          => 'MyAccount/realtime_collect',
  52   'list_pkgs'                 => 'MyAccount/list_pkgs',     #add to ss (added?)
  53   'list_svcs'                 => 'MyAccount/list_svcs',     #add to ss (added?)
  54   'list_svc_usage'            => 'MyAccount/list_svc_usage',
  55   'svc_status_html'           => 'MyAccount/svc_status_html',
  56   'acct_forward_info'         => 'MyAccount/acct_forward_info',
  57   'process_acct_forward'      => 'MyAccount/process_acct_forward',
  58   'list_dsl_devices'          => 'MyAccount/list_dsl_devices',
  59   'add_dsl_device'            => 'MyAccount/add_dsl_device',
  60   'delete_dsl_device'         => 'MyAccount/delete_dsl_device',
  61   'port_graph'                => 'MyAccount/port_graph',
  62   'list_cdr_usage'            => 'MyAccount/list_cdr_usage',
  63   'list_support_usage'        => 'MyAccount/list_support_usage',
  64   'order_pkg'                 => 'MyAccount/order_pkg',     #add to ss cgi!
  65   'change_pkg'                => 'MyAccount/change_pkg',
  66   'order_recharge'            => 'MyAccount/order_recharge',
  67   'renew_info'                => 'MyAccount/renew_info',
  68   'order_renew'               => 'MyAccount/order_renew',
  69   'cancel_pkg'                => 'MyAccount/cancel_pkg',    #add to ss cgi!
  70   'suspend_pkg'               => 'MyAccount/suspend_pkg',   #add to ss cgi!
  71   'charge'                    => 'MyAccount/charge',        #?
  72   'part_svc_info'             => 'MyAccount/part_svc_info',
  73   'provision_acct'            => 'MyAccount/provision_acct',
  74   'provision_phone'           => 'MyAccount/provision_phone',
  75   'provision_external'        => 'MyAccount/provision_external',
  76   'unprovision_svc'           => 'MyAccount/unprovision_svc',
  77   'myaccount_passwd'          => 'MyAccount/myaccount_passwd',
  78   'reset_passwd'              => 'MyAccount/reset_passwd',
  79   'check_reset_passwd'        => 'MyAccount/check_reset_passwd',
  80   'process_reset_passwd'      => 'MyAccount/process_reset_passwd',
  81   'create_ticket'             => 'MyAccount/create_ticket',
  82   'get_ticket'                => 'MyAccount/get_ticket',
  83   'adjust_ticket_priority'    => 'MyAccount/adjust_ticket_priority',
  84   'did_report'                => 'MyAccount/did_report',
  85   'signup_info'               => 'Signup/signup_info',
  86   'skin_info'                 => 'MyAccount/skin_info',
  87   'access_info'               => 'MyAccount/access_info',
  88   'domain_select_hash'        => 'Signup/domain_select_hash',  # expose?
  89   'new_customer'              => 'Signup/new_customer',
  90   'capture_payment'           => 'Signup/capture_payment',
  91   #N/A 'clear_signup_cache'        => 'Signup/clear_cache',
  92   'new_agent'                 => 'Agent/new_agent',
  93   'agent_login'               => 'Agent/agent_login',
  94   'agent_logout'              => 'Agent/agent_logout',
  95   'agent_info'                => 'Agent/agent_info',
  96   'agent_list_customers'      => 'Agent/agent_list_customers',
  97   'check_username'            => 'Agent/check_username',
  98   'suspend_username'          => 'Agent/suspend_username',
  99   'unsuspend_username'        => 'Agent/unsuspend_username',
 100   'mason_comp'                => 'MasonComponent/mason_comp',
 101   'call_time'                 => 'PrepaidPhone/call_time',
 102   'call_time_nanpa'           => 'PrepaidPhone/call_time_nanpa',
 103   'phonenum_balance'          => 'PrepaidPhone/phonenum_balance',
 104   #izoom
 105   #'bulk_processrow'           => 'Bulk/processrow',
 106   #conflicts w/Agent one# 'check_username'            => 'Bulk/check_username',
 107   #sg
 108   'ping'                      => 'SGNG/ping',
 109   'decompify_pkgs'            => 'SGNG/decompify_pkgs',
 110   'previous_payment_info'     => 'SGNG/previous_payment_info',
 111   'previous_payment_info_renew_info'
 112                               => 'SGNG/previous_payment_info_renew_info',
 113   'previous_process_payment'  => 'SGNG/previous_process_payment',
 114   'previous_process_payment_order_pkg'
 115                               => 'SGNG/previous_process_payment_order_pkg',
 116   'previous_process_payment_change_pkg'
 117                               => 'SGNG/previous_process_payment_change_pkg',
 118   'previous_process_payment_order_renew'
 119                               => 'SGNG/previous_process_payment_order_renew',
 120 );
 121 @EXPORT_OK = (
 122   keys(%autoload),
 123   qw( regionselector regionselector_hashref location_form
 124       expselect popselector domainselector didselector
 125     )
 126 );
 127
 128 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
 129 $ENV{'SHELL'} = '/bin/sh';
 130 $ENV{'IFS'} = " \t\n";
 131 $ENV{'CDPATH'} = '';
 132 $ENV{'ENV'} = '';
 133 $ENV{'BASH_ENV'} = '';
 134
 135 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
 136 #if you grant appropriate permissions to whatever user
 137 my $freeside_uid = scalar(getpwnam('freeside'));
 138 die "not running as the freeside user\n"
 139   if $> != $freeside_uid && ! $skip_uid_check;
 140
 141 -e $dir or die "FATAL: $dir doesn't exist!";
 142 -d $dir or die "FATAL: $dir isn't a directory!";
 143 -r $dir or die "FATAL: Can't read $dir as freeside user!";
 144 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
 145
 146 foreach my $autoload ( keys %autoload ) {
 147
 148   my $eval =
 149   "sub $autoload { ". '
 150                    my $param;
 151                    if ( ref($_[0]) ) {
 152                      $param = shift;
 153                    } else {
 154                      #warn scalar(@_). ": ". join(" / ", @_);
 155                      $param = { @_ };
 156                    }
 157
 158                    $param->{_packet} = \''. $autoload{$autoload}. '\';
 159
 160                    simple_packet($param);
 161                  }';
 162
 163   eval $eval;
 164   die $@ if $@;
 165
 166 }
 167
 168 sub simple_packet {
 169   my $packet = shift;
 170   warn "sending ". $packet->{_packet}. " to server"
 171     if $DEBUG;
 172   socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
 173   connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
 174   nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
 175   SOCK->flush;
 176
 177   #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
 178
 179   #block until there is a message on socket
 180 #  my $w = new IO::Select;
 181 #  $w->add(\*SOCK);
 182 #  my @wait = $w->can_read;
 183
 184   warn "reading message from server"
 185     if $DEBUG;
 186
 187   my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
 188   die $return->{'_error'} if defined $return->{_error} && $return->{_error};
 189
 190   warn "returning message to client"
 191     if $DEBUG;
 192
 193   $return;
 194 }
 195
 196 =head1 NAME
 197
 198 FS::SelfService - Freeside self-service API
 199
 200 =head1 SYNOPSIS
 201
 202   # password and shell account changes
 203   use FS::SelfService qw(passwd chfn chsh);
 204
 205   # "my account" functionality
 206   use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
 207
 208   my $rv = login( { 'username' => $username,
 209                     'domain'   => $domain,
 210                     'password' => $password,
 211                   }
 212                 );
 213
 214   if ( $rv->{'error'} ) {
 215     #handle login error...
 216   } else {
 217     #successful login
 218     my $session_id = $rv->{'session_id'};
 219   }
 220
 221   my $customer_info = customer_info( { 'session_id' => $session_id } );
 222
 223   #payment_info and process_payment are available in 1.5+ only
 224   my $payment_info = payment_info( { 'session_id' => $session_id } );
 225
 226   #!!! process_payment example
 227
 228   #!!! list_pkgs example
 229
 230   #!!! order_pkg example
 231
 232   #!!! cancel_pkg example
 233
 234   # signup functionality
 235   use FS::SelfService qw( signup_info new_customer );
 236
 237   my $signup_info = signup_info;
 238
 239   $rv = new_customer( {
 240                         'first'            => $first,
 241                         'last'             => $last,
 242                         'company'          => $company,
 243                         'address1'         => $address1,
 244                         'address2'         => $address2,
 245                         'city'             => $city,
 246                         'state'            => $state,
 247                         'zip'              => $zip,
 248                         'country'          => $country,
 249                         'daytime'          => $daytime,
 250                         'night'            => $night,
 251                         'fax'              => $fax,
 252                         'payby'            => $payby,
 253                         'payinfo'          => $payinfo,
 254                         'paycvv'           => $paycvv,
 255                         'paystart_month'   => $paystart_month
 256                         'paystart_year'    => $paystart_year,
 257                         'payissue'         => $payissue,
 258                         'payip'            => $payip
 259                         'paydate'          => $paydate,
 260                         'payname'          => $payname,
 261                         'invoicing_list'   => $invoicing_list,
 262                         'referral_custnum' => $referral_custnum,
 263                         'agentnum'         => $agentnum,
 264                         'pkgpart'          => $pkgpart,
 265
 266                         'username'         => $username,
 267                         '_password'        => $password,
 268                         'popnum'           => $popnum,
 269                         #OR
 270                         'countrycode'      => 1,
 271                         'phonenum'         => $phonenum,
 272                         'pin'              => $pin,
 273                       }
 274                     );
 275
 276   my $error = $rv->{'error'};
 277   if ( $error eq '_decline' ) {
 278     print_decline();
 279   } elsif ( $error ) {
 280     reprint_signup();
 281   } else {
 282     print_success();
 283   }
 284
 285 =head1 DESCRIPTION
 286
 287 Use this API to implement your own client "self-service" module.
 288
 289 If you just want to customize the look of the existing "self-service" module,
 290 see XXXX instead.
 291
 292 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
 293
 294 =over 4
 295
 296 =item passwd
 297
 298 =item chfn
 299
 300 =item chsh
 301
 302 =back
 303
 304 =head1 "MY ACCOUNT" FUNCTIONS
 305
 306 =over 4
 307
 308 =item login HASHREF
 309
 310 Creates a user session.  Takes a hash reference as parameter with the
 311 following keys:
 312
 313 =over 4
 314
 315 =item username
 316
 317 Username
 318
 319 =item domain
 320
 321 Domain
 322
 323 =item password
 324
 325 Password
 326
 327 =back
 328
 329 Returns a hash reference with the following keys:
 330
 331 =over 4
 332
 333 =item error
 334
 335 Empty on success, or an error message on errors.
 336
 337 =item session_id
 338
 339 Session identifier for successful logins
 340
 341 =back
 342
 343 =item customer_info HASHREF
 344
 345 Returns general customer information.
 346
 347 Takes a hash reference as parameter with a single key: B<session_id>
 348
 349 Returns a hash reference with the following keys:
 350
 351 =over 4
 352
 353 =item name
 354
 355 Customer name
 356
 357 =item balance
 358
 359 Balance owed
 360
 361 =item open
 362
 363 Array reference of hash references of open inoices.  Each hash reference has
 364 the following keys: invnum, date, owed
 365
 366 =item small_custview
 367
 368 An HTML fragment containing shipping and billing addresses.
 369
 370 =item The following fields are also returned
 371
 372 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
 373
 374 =back
 375
 376 =item edit_info HASHREF
 377
 378 Takes a hash reference as parameter with any of the following keys:
 379
 380 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
 381
 382 If a field exists, the customer record is updated with the new value of that
 383 field.  If a field does not exist, that field is not changed on the customer
 384 record.
 385
 386 Returns a hash reference with a single key, B<error>, empty on success, or an
 387 error message on errors
 388
 389 =item invoice HASHREF
 390
 391 Returns an invoice.  Takes a hash reference as parameter with two keys:
 392 session_id and invnum
 393
 394 Returns a hash reference with the following keys:
 395
 396 =over 4
 397
 398 =item error
 399
 400 Empty on success, or an error message on errors
 401
 402 =item invnum
 403
 404 Invoice number
 405
 406 =item invoice_text
 407
 408 Invoice text
 409
 410 =back
 411
 412 =item list_invoices HASHREF
 413
 414 Returns a list of all customer invoices.  Takes a hash references with a single
 415 key, session_id.
 416
 417 Returns a hash reference with the following keys:
 418
 419 =over 4
 420
 421 =item error
 422
 423 Empty on success, or an error message on errors
 424
 425 =item invoices
 426
 427 Reference to array of hash references with the following keys:
 428
 429 =over 4
 430
 431 =item invnum
 432
 433 Invoice ID
 434
 435 =item _date
 436
 437 Invoice date, in UNIX epoch time
 438
 439 =back
 440
 441 =back
 442
 443 =item cancel HASHREF
 444
 445 Cancels this customer.
 446
 447 Takes a hash reference as parameter with a single key: B<session_id>
 448
 449 Returns a hash reference with a single key, B<error>, which is empty on
 450 success or an error message on errors.
 451
 452 =item payment_info HASHREF
 453
 454 Returns information that may be useful in displaying a payment page.
 455
 456 Takes a hash reference as parameter with a single key: B<session_id>.
 457
 458 Returns a hash reference with the following keys:
 459
 460 =over 4
 461
 462 =item error
 463
 464 Empty on success, or an error message on errors
 465
 466 =item balance
 467
 468 Balance owed
 469
 470 =item payname
 471
 472 Exact name on credit card (CARD/DCRD)
 473
 474 =item address1
 475
 476 Address line one
 477
 478 =item address2
 479
 480 Address line two
 481
 482 =item city
 483
 484 City
 485
 486 =item state
 487
 488 State
 489
 490 =item zip
 491
 492 Zip or postal code
 493
 494 =item payby
 495
 496 Customer's current default payment type.
 497
 498 =item card_type
 499
 500 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
 501
 502 =item payinfo
 503
 504 For CARD/DCRD payment types, the card number
 505
 506 =item month
 507
 508 For CARD/DCRD payment types, expiration month
 509
 510 =item year
 511
 512 For CARD/DCRD payment types, expiration year
 513
 514 =item cust_main_county
 515
 516 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.
 517
 518 =item states
 519
 520 Array reference of all states in the current default country.
 521
 522 =item card_types
 523
 524 Hash reference of card types; keys are card types, values are the exact strings
 525 passed to the process_payment function
 526
 527 =cut
 528
 529 #this doesn't actually work yet
 530 #
 531 #=item paybatch
 532 #
 533 #Unique transaction identifier (prevents multiple charges), passed to the
 534 #process_payment function
 535
 536 =back
 537
 538 =item process_payment HASHREF
 539
 540 Processes a payment and possible change of address or payment type.  Takes a
 541 hash reference as parameter with the following keys:
 542
 543 =over 4
 544
 545 =item session_id
 546
 547 Session identifier
 548
 549 =item amount
 550
 551 Amount
 552
 553 =item save
 554
 555 If true, address and card information entered will be saved for subsequent
 556 transactions.
 557
 558 =item auto
 559
 560 If true, future credit card payments will be done automatically (sets payby to
 561 CARD).  If false, future credit card payments will be done on-demand (sets
 562 payby to DCRD).  This option only has meaning if B<save> is set true.
 563
 564 =item payname
 565
 566 Name on card
 567
 568 =item address1
 569
 570 Address line one
 571
 572 =item address2
 573
 574 Address line two
 575
 576 =item city
 577
 578 City
 579
 580 =item state
 581
 582 State
 583
 584 =item zip
 585
 586 Zip or postal code
 587
 588 =item country
 589
 590 Two-letter country code
 591
 592 =item payinfo
 593
 594 Card number
 595
 596 =item month
 597
 598 Card expiration month
 599
 600 =item year
 601
 602 Card expiration year
 603
 604 =cut
 605
 606 #this doesn't actually work yet
 607 #
 608 #=item paybatch
 609 #
 610 #Unique transaction identifier, returned from the payment_info function.
 611 #Prevents multiple charges.
 612
 613 =back
 614
 615 Returns a hash reference with a single key, B<error>, empty on success, or an
 616 error message on errors.
 617
 618 =item process_payment_order_pkg
 619
 620 Combines the B<process_payment> and B<order_pkg> functions in one step.  If the
 621 payment processes sucessfully, the package is ordered.  Takes a hash reference
 622 as parameter with the keys of both methods.
 623
 624 Returns a hash reference with a single key, B<error>, empty on success, or an
 625 error message on errors.
 626
 627 =item process_payment_change_pkg
 628
 629 Combines the B<process_payment> and B<change_pkg> functions in one step.  If the
 630 payment processes sucessfully, the package is ordered.  Takes a hash reference
 631 as parameter with the keys of both methods.
 632
 633 Returns a hash reference with a single key, B<error>, empty on success, or an
 634 error message on errors.
 635
 636
 637 =item process_payment_order_renew
 638
 639 Combines the B<process_payment> and B<order_renew> functions in one step.  If
 640 the payment processes sucessfully, the renewal is processed.  Takes a hash
 641 reference as parameter with the keys of both methods.
 642
 643 Returns a hash reference with a single key, B<error>, empty on success, or an
 644 error message on errors.
 645
 646 =item list_pkgs
 647
 648 Returns package information for this customer.  For more detail on services,
 649 see L</list_svcs>.
 650
 651 Takes a hash reference as parameter with a single key: B<session_id>
 652
 653 Returns a hash reference containing customer package information.  The hash reference contains the following keys:
 654
 655 =over 4
 656
 657 =item custnum
 658
 659 Customer number
 660
 661 =item error
 662
 663 Empty on success, or an error message on errors.
 664
 665 =item cust_pkg HASHREF
 666
 667 Array reference of hash references, each of which has the fields of a cust_pkg
 668 record (see L<FS::cust_pkg>) as well as the fields below.  Note these are not
 669 the internal FS:: objects, but hash references of columns and values.
 670
 671 =over 4
 672
 673 =item part_pkg fields
 674
 675 All fields of part_pkg for this specific cust_pkg (be careful with this
 676 information - it may reveal more about your available packages than you would
 677 like users to know in aggregate)
 678
 679 =cut
 680
 681 #XXX pare part_pkg fields down to a more secure subset
 682
 683 =item part_svc
 684
 685 An array of hash references indicating information on unprovisioned services
 686 available for provisioning for this specific cust_pkg.  Each has the following
 687 keys:
 688
 689 =over 4
 690
 691 =item part_svc fields
 692
 693 All fields of part_svc (be careful with this information - it may reveal more
 694 about your available packages than you would like users to know in aggregate)
 695
 696 =cut
 697
 698 #XXX pare part_svc fields down to a more secure subset
 699
 700 =back
 701
 702 =item cust_svc
 703
 704 An array of hash references indicating information on the customer services
 705 already provisioned for this specific cust_pkg.  Each has the following keys:
 706
 707 =over 4
 708
 709 =item label
 710
 711 Array reference with three elements: The first element is the name of this service.  The second element is a meaningful user-specific identifier for the service (i.e. username, domain or mail alias).  The last element is the table name of this service.
 712
 713 =back
 714
 715 =item svcnum
 716
 717 Primary key for this service
 718
 719 =item svcpart
 720
 721 Service definition (see L<FS::part_svc>)
 722
 723 =item pkgnum
 724
 725 Customer package (see L<FS::cust_pkg>)
 726
 727 =item overlimit
 728
 729 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
 730
 731 =back
 732
 733 =back
 734
 735 =item list_svcs
 736
 737 Returns service information for this customer.
 738
 739 Takes a hash reference as parameter with a single key: B<session_id>
 740
 741 Returns a hash reference containing customer package information.  The hash reference contains the following keys:
 742
 743 =over 4
 744
 745 =item custnum
 746
 747 Customer number
 748
 749 =item svcs
 750
 751 An array of hash references indicating information on all of this customer's
 752 services.  Each has the following keys:
 753
 754 =over 4
 755
 756 =item svcnum
 757
 758 Primary key for this service
 759
 760 =item label
 761
 762 Name of this service
 763
 764 =item value
 765
 766 Meaningful user-specific identifier for the service (i.e. username, domain, or
 767 mail alias).
 768
 769 =back
 770
 771 Account (svc_acct) services also have the following keys:
 772
 773 =over 4
 774
 775 =item username
 776
 777 Username
 778
 779 =item email
 780
 781 username@domain
 782
 783 =item seconds
 784
 785 Seconds remaining
 786
 787 =item upbytes
 788
 789 Upload bytes remaining
 790
 791 =item downbytes
 792
 793 Download bytes remaining
 794
 795 =item totalbytes
 796
 797 Total bytes remaining
 798
 799 =item recharge_amount
 800
 801 Cost of a recharge
 802
 803 =item recharge_seconds
 804
 805 Number of seconds gained by recharge
 806
 807 =item recharge_upbytes
 808
 809 Number of upload bytes gained by recharge
 810
 811 =item recharge_downbytes
 812
 813 Number of download bytes gained by recharge
 814
 815 =item recharge_totalbytes
 816
 817 Number of total bytes gained by recharge
 818
 819 =back
 820
 821 =back
 822
 823 =item order_pkg
 824
 825 Orders a package for this customer.
 826
 827 Takes a hash reference as parameter with the following keys:
 828
 829 =over 4
 830
 831 =item session_id
 832
 833 Session identifier
 834
 835 =item pkgpart
 836
 837 Package to order (see L<FS::part_pkg>).
 838
 839 =item svcpart
 840
 841 Service to order (see L<FS::part_svc>).
 842
 843 Normally optional; required only to provision a non-svc_acct service, or if the
 844 package definition does not contain one svc_acct service definition with
 845 quantity 1 (it may contain others with quantity >1).  A svcpart of "none" can
 846 also be specified to indicate that no initial service should be provisioned.
 847
 848 =back
 849
 850 Fields used when provisioning an svc_acct service:
 851
 852 =over 4
 853
 854 =item username
 855
 856 Username
 857
 858 =item _password
 859
 860 Password
 861
 862 =item sec_phrase
 863
 864 Optional security phrase
 865
 866 =item popnum
 867
 868 Optional Access number number
 869
 870 =back
 871
 872 Fields used when provisioning an svc_domain service:
 873
 874 =over 4
 875
 876 =item domain
 877
 878 Domain
 879
 880 =back
 881
 882 Fields used when provisioning an svc_phone service:
 883
 884 =over 4
 885
 886 =item phonenum
 887
 888 Phone number
 889
 890 =item pin
 891
 892 Voicemail PIN
 893
 894 =item sip_password
 895
 896 SIP password
 897
 898 =back
 899
 900 Fields used when provisioning an svc_external service:
 901
 902 =over 4
 903
 904 =item id
 905
 906 External numeric ID.
 907
 908 =item title
 909
 910 External text title.
 911
 912 =back
 913
 914 Fields used when provisioning an svc_pbx service:
 915
 916 =over 4
 917
 918 =item id
 919
 920 Numeric ID.
 921
 922 =item name
 923
 924 Text name.
 925
 926 =back
 927
 928 Returns a hash reference with a single key, B<error>, empty on success, or an
 929 error message on errors.  The special error '_decline' is returned for
 930 declined transactions.
 931
 932 =item change_pkg
 933
 934 Changes a package for this customer.
 935
 936 Takes a hash reference as parameter with the following keys:
 937
 938 =over 4
 939
 940 =item session_id
 941
 942 Session identifier
 943
 944 =item pkgnum
 945
 946 Existing customer package.
 947
 948 =item pkgpart
 949
 950 New package to order (see L<FS::part_pkg>).
 951
 952 =back
 953
 954 Returns a hash reference with the following keys:
 955
 956 =over 4
 957
 958 =item error
 959
 960 Empty on success, or an error message on errors.
 961
 962 =item pkgnum
 963
 964 On success, the new pkgnum
 965
 966 =back
 967
 968
 969 =item renew_info
 970
 971 Provides useful info for early renewals.
 972
 973 Takes a hash reference as parameter with the following keys:
 974
 975 =over 4
 976
 977 =item session_id
 978
 979 Session identifier
 980
 981 =back
 982
 983 Returns a hash reference.  On errors, it contains a single key, B<error>, with
 984 the error message.  Otherwise, contains a single key, B<dates>, pointing to
 985 an array refernce of hash references.  Each hash reference contains the
 986 following keys:
 987
 988 =over 4
 989
 990 =item bill_date
 991
 992 (Future) Bill date.  Indicates a future date for which billing could be run.
 993 Specified as a integer UNIX timestamp.  Pass this value to the B<order_renew>
 994 function.
 995
 996 =item bill_date_pretty
 997
 998 (Future) Bill date as a human-readable string.  (Convenience for display;
 999 subject to change, so best not to parse for the date.)
1000
1001 =item amount
1002
1003 Base amount which will be charged if renewed early as of this date.
1004
1005 =item renew_date
1006
1007 Renewal date; i.e. even-futher future date at which the customer will be paid
1008 through if the early renewal is completed with the given B<bill-date>.
1009 Specified as a integer UNIX timestamp.
1010
1011 =item renew_date_pretty
1012
1013 Renewal date as a human-readable string.  (Convenience for display;
1014 subject to change, so best not to parse for the date.)
1015
1016 =item pkgnum
1017
1018 Package that will be renewed.
1019
1020 =item expire_date
1021
1022 Expiration date of the package that will be renewed.
1023
1024 =item expire_date_pretty
1025
1026 Expiration date of the package that will be renewed, as a human-readable
1027 string.  (Convenience for display; subject to change, so best not to parse for
1028 the date.)
1029
1030 =back
1031
1032 =item order_renew
1033
1034 Renews this customer early; i.e. runs billing for this customer in advance.
1035
1036 Takes a hash reference as parameter with the following keys:
1037
1038 =over 4
1039
1040 =item session_id
1041
1042 Session identifier
1043
1044 =item date
1045
1046 Integer date as returned by the B<renew_info> function, indicating the advance
1047 date for which to run billing.
1048
1049 =back
1050
1051 Returns a hash reference with a single key, B<error>, empty on success, or an
1052 error message on errors.
1053
1054 =item cancel_pkg
1055
1056 Cancels a package for this customer.
1057
1058 Takes a hash reference as parameter with the following keys:
1059
1060 =over 4
1061
1062 =item session_id
1063
1064 Session identifier
1065
1066 =item pkgpart
1067
1068 pkgpart of package to cancel
1069
1070 =back
1071
1072 Returns a hash reference with a single key, B<error>, empty on success, or an
1073 error message on errors.
1074
1075 =back
1076
1077 =head1 SIGNUP FUNCTIONS
1078
1079 =over 4
1080
1081 =item signup_info HASHREF
1082
1083 Takes a hash reference as parameter with the following keys:
1084
1085 =over 4
1086
1087 =item session_id - Optional agent/reseller interface session
1088
1089 =back
1090
1091 Returns a hash reference containing information that may be useful in
1092 displaying a signup page.  The hash reference contains the following keys:
1093
1094 =over 4
1095
1096 =item cust_main_county
1097
1098 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.
1099
1100 =item part_pkg
1101
1102 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
1103 an agentnum specified explicitly via reseller interface session_id in the
1104 options.
1105
1106 =item agent
1107
1108 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.
1109
1110 =item agentnum2part_pkg
1111
1112 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.
1113
1114 =item svc_acct_pop
1115
1116 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.
1117
1118 =item security_phrase
1119
1120 True if the "security_phrase" feature is enabled
1121
1122 =item payby
1123
1124 Array reference of acceptable payment types for signup
1125
1126 =over 4
1127
1128 =item CARD
1129
1130 credit card - automatic
1131
1132 =item DCRD
1133
1134 credit card - on-demand - version 1.5+ only
1135
1136 =item CHEK
1137
1138 electronic check - automatic
1139
1140 =item DCHK
1141
1142 electronic check - on-demand - version 1.5+ only
1143
1144 =item LECB
1145
1146 Phone bill billing
1147
1148 =item BILL
1149
1150 billing, not recommended for signups
1151
1152 =item COMP
1153
1154 free, definitely not recommended for signups
1155
1156 =item PREPAY
1157
1158 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1159
1160 =back
1161
1162 =item cvv_enabled
1163
1164 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1165
1166 =item msgcat
1167
1168 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".
1169
1170 =item statedefault
1171
1172 Default state
1173
1174 =item countrydefault
1175
1176 Default country
1177
1178 =back
1179
1180 =item new_customer HASHREF
1181
1182 Creates a new customer.  Takes a hash reference as parameter with the
1183 following keys:
1184
1185 =over 4
1186
1187 =item first
1188
1189 first name (required)
1190
1191 =item last
1192
1193 last name (required)
1194
1195 =item ss
1196
1197 (not typically collected; mostly used for ACH transactions)
1198
1199 =item company
1200
1201 Company name
1202
1203 =item address1 (required)
1204
1205 Address line one
1206
1207 =item address2
1208
1209 Address line two
1210
1211 =item city (required)
1212
1213 City
1214
1215 =item county
1216
1217 County
1218
1219 =item state (required)
1220
1221 State
1222
1223 =item zip (required)
1224
1225 Zip or postal code
1226
1227 =item daytime
1228
1229 Daytime phone number
1230
1231 =item night
1232
1233 Evening phone number
1234
1235 =item fax
1236
1237 Fax number
1238
1239 =item payby
1240
1241 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1242
1243 =item payinfo
1244
1245 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1246
1247 =item paycvv
1248
1249 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1250
1251 =item paydate
1252
1253 Expiration date for CARD/DCRD
1254
1255 =item payname
1256
1257 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1258
1259 =item invoicing_list
1260
1261 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),
1262
1263 =item referral_custnum
1264
1265 referring customer number
1266
1267 =item agentnum
1268
1269 Agent number
1270
1271 =item pkgpart
1272
1273 pkgpart of initial package
1274
1275 =item username
1276
1277 Username
1278
1279 =item _password
1280
1281 Password
1282
1283 =item sec_phrase
1284
1285 Security phrase
1286
1287 =item popnum
1288
1289 Access number (index, not the literal number)
1290
1291 =item countrycode
1292
1293 Country code (to be provisioned as a service)
1294
1295 =item phonenum
1296
1297 Phone number (to be provisioned as a service)
1298
1299 =item pin
1300
1301 Voicemail PIN
1302
1303 =back
1304
1305 Returns a hash reference with the following keys:
1306
1307 =over 4
1308
1309 =item error
1310
1311 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 Configuration | View/Edit message catalog)
1312
1313 =back
1314
1315 =item regionselector HASHREF | LIST
1316
1317 Takes as input a hashref or list of key/value pairs with the following keys:
1318
1319 =over 4
1320
1321 =item selected_county
1322
1323 Currently selected county
1324
1325 =item selected_state
1326
1327 Currently selected state
1328
1329 =item selected_country
1330
1331 Currently selected country
1332
1333 =item prefix
1334
1335 Specify a unique prefix string  if you intend to use the HTML output multiple time son one page.
1336
1337 =item onchange
1338
1339 Specify a javascript subroutine to call on changes
1340
1341 =item default_state
1342
1343 Default state
1344
1345 =item default_country
1346
1347 Default country
1348
1349 =item locales
1350
1351 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>.
1352
1353 =back
1354
1355 Returns a list consisting of three HTML fragments for county selection,
1356 state selection and country selection, respectively.
1357
1358 =cut
1359
1360 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1361 sub regionselector {
1362   my $param;
1363   if ( ref($_[0]) ) {
1364     $param = shift;
1365   } else {
1366     $param = { @_ };
1367   }
1368   $param->{'selected_country'} ||= $param->{'default_country'};
1369   $param->{'selected_state'} ||= $param->{'default_state'};
1370
1371   my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1372
1373   my $countyflag = 0;
1374
1375   my %cust_main_county;
1376
1377 #  unless ( @cust_main_county ) { #cache
1378     #@cust_main_county = qsearch('cust_main_county', {} );
1379     #foreach my $c ( @cust_main_county ) {
1380     foreach my $c ( @{ $param->{'locales'} } ) {
1381       #$countyflag=1 if $c->county;
1382       $countyflag=1 if $c->{county};
1383       #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1384       #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1385       $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1386     }
1387 #  }
1388   $countyflag=1 if $param->{selected_county};
1389
1390   my $script_html = <<END;
1391     <SCRIPT>
1392     function opt(what,value,text) {
1393       var optionName = new Option(text, value, false, false);
1394       var length = what.length;
1395       what.options[length] = optionName;
1396     }
1397     function ${prefix}country_changed(what) {
1398       country = what.options[what.selectedIndex].text;
1399       for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1400           what.form.${prefix}state.options[i] = null;
1401 END
1402       #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1403
1404   foreach my $country ( sort keys %cust_main_county ) {
1405     $script_html .= "\nif ( country == \"$country\" ) {\n";
1406     foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1407       my $text = $state || '(n/a)';
1408       $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1409     }
1410     $script_html .= "}\n";
1411   }
1412
1413   $script_html .= <<END;
1414     }
1415     function ${prefix}state_changed(what) {
1416 END
1417
1418   if ( $countyflag ) {
1419     $script_html .= <<END;
1420       state = what.options[what.selectedIndex].text;
1421       country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1422       for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1423           what.form.${prefix}county.options[i] = null;
1424 END
1425
1426     foreach my $country ( sort keys %cust_main_county ) {
1427       $script_html .= "\nif ( country == \"$country\" ) {\n";
1428       foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1429         $script_html .= "\nif ( state == \"$state\" ) {\n";
1430           #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1431           foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1432             my $text = $county || '(n/a)';
1433             $script_html .=
1434               qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1435           }
1436         $script_html .= "}\n";
1437       }
1438       $script_html .= "}\n";
1439     }
1440   }
1441
1442   $script_html .= <<END;
1443     }
1444     </SCRIPT>
1445 END
1446
1447   my $county_html = $script_html;
1448   if ( $countyflag ) {
1449     $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1450     foreach my $county (
1451       sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1452     ) {
1453       my $text = $county || '(n/a)';
1454       $county_html .= qq!<OPTION VALUE="$county"!.
1455                       ($county eq $param->{'selected_county'} ?
1456                         ' SELECTED>' :
1457                         '>'
1458                       ).
1459                       $text.
1460                       '</OPTION>';
1461     }
1462     $county_html .= '</SELECT>';
1463   } else {
1464     $county_html .=
1465       qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1466   }
1467
1468   my $state_html = qq!<SELECT NAME="${prefix}state" !.
1469                    qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1470   foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1471     my $text = $state || '(n/a)';
1472     my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1473     $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1474   }
1475   $state_html .= '</SELECT>';
1476
1477   my $country_html = '';
1478   if ( scalar( keys %cust_main_county ) > 1 )  {
1479
1480     $country_html = qq(<SELECT NAME="${prefix}country" ).
1481                     qq(onChange="${prefix}country_changed(this); ).
1482                                  $param->{'onchange'}.
1483                                '"'.
1484                       '>';
1485     my $countrydefault = $param->{default_country} || 'US';
1486     foreach my $country (
1487       sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1488         keys %cust_main_county
1489     ) {
1490       my $selected = $country eq $param->{'selected_country'}
1491                        ? ' SELECTED'
1492                        : '';
1493       $country_html .= "\n<OPTION$selected>$country</OPTION>"
1494     }
1495     $country_html .= '</SELECT>';
1496   } else {
1497
1498     $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1499                             ' VALUE="'. (keys %cust_main_county )[0]. '">';
1500
1501   }
1502
1503   ($county_html, $state_html, $country_html);
1504
1505 }
1506
1507 sub regionselector_hashref {
1508   my ($county_html, $state_html, $country_html) = regionselector(@_);
1509   {
1510     'county_html'  => $county_html,
1511     'state_html'   => $state_html,
1512     'country_html' => $country_html,
1513   };
1514 }
1515
1516 =item location_form HASHREF | LIST
1517
1518 Takes as input a hashref or list of key/value pairs with the following keys:
1519
1520 =over 4
1521
1522 =item session_id
1523
1524 Current customer session_id
1525
1526 =item no_asterisks
1527
1528 Omit red asterisks from required fields.
1529
1530 =item address1_label
1531
1532 Label for first address line.
1533
1534 =back
1535
1536 Returns an HTML fragment for a location form (address, city, state, zip,
1537 country)
1538
1539 =cut
1540
1541 sub location_form {
1542   my $param;
1543   if ( ref($_[0]) ) {
1544     $param = shift;
1545   } else {
1546     $param = { @_ };
1547   }
1548
1549   my $session_id = delete $param->{'session_id'};
1550
1551   my $rv = mason_comp( 'session_id' => $session_id,
1552                        'comp'       => '/elements/location.html',
1553                        'args'       => [ %$param ],
1554                      );
1555
1556   #hmm.
1557   $rv->{'error'} || $rv->{'output'};
1558
1559 }
1560
1561
1562 #=item expselect HASHREF | LIST
1563 #
1564 #Takes as input a hashref or list of key/value pairs with the following keys:
1565 #
1566 #=over 4
1567 #
1568 #=item prefix - Specify a unique prefix string  if you intend to use the HTML output multiple time son one page.
1569 #
1570 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1571 #
1572 #=back
1573
1574 =item expselect PREFIX [ DATE ]
1575
1576 Takes as input a unique prefix string and the current expiration date, in
1577 yyyy-mm-dd or m-d-yyyy format
1578
1579 Returns an HTML fragments for expiration date selection.
1580
1581 =cut
1582
1583 sub expselect {
1584   #my $param;
1585   #if ( ref($_[0]) ) {
1586   #  $param = shift;
1587   #} else {
1588   #  $param = { @_ };
1589   #my $prefix = $param->{'prefix'};
1590   #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1591   #my $date =   exists($param->{'date'})   ? $param->{'date'}   : '';
1592   my $prefix = shift;
1593   my $date = scalar(@_) ? shift : '';
1594
1595   my( $m, $y ) = ( 0, 0 );
1596   if ( $date  =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1597     ( $m, $y ) = ( $2, $1 );
1598   } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1599     ( $m, $y ) = ( $1, $3 );
1600   }
1601   my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1602   for ( 1 .. 12 ) {
1603     $return .= qq!<OPTION VALUE="$_"!;
1604     $return .= " SELECTED" if $_ == $m;
1605     $return .= ">$_";
1606   }
1607   $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1608   my @t = localtime;
1609   my $thisYear = $t[5] + 1900;
1610   for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1611     $return .= qq!<OPTION VALUE="$_"!;
1612     $return .= " SELECTED" if $_ == $y;
1613     $return .= ">$_";
1614   }
1615   $return .= "</SELECT>";
1616
1617   $return;
1618 }
1619
1620 =item popselector HASHREF | LIST
1621
1622 Takes as input a hashref or list of key/value pairs with the following keys:
1623
1624 =over 4
1625
1626 =item popnum
1627
1628 Access number number
1629
1630 =item pops
1631
1632 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>.
1633
1634 =back
1635
1636 Returns an HTML fragment for access number selection.
1637
1638 =cut
1639
1640 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1641 sub popselector {
1642   my $param;
1643   if ( ref($_[0]) ) {
1644     $param = shift;
1645   } else {
1646     $param = { @_ };
1647   }
1648   my $popnum = $param->{'popnum'};
1649   my $pops = $param->{'pops'};
1650
1651   return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1652   return $pops->[0]{city}. ', '. $pops->[0]{state}.
1653          ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1654          '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1655     if scalar(@$pops) == 1;
1656
1657   my %pop = ();
1658   my %popnum2pop = ();
1659   foreach (@$pops) {
1660     push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1661     $popnum2pop{$_->{popnum}} = $_;
1662   }
1663
1664   my $text = <<END;
1665     <SCRIPT>
1666     function opt(what,href,text) {
1667       var optionName = new Option(text, href, false, false)
1668       var length = what.length;
1669       what.options[length] = optionName;
1670     }
1671 END
1672
1673   my $init_popstate = $param->{'init_popstate'};
1674   if ( $init_popstate ) {
1675     $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1676              $init_popstate. '">';
1677   } else {
1678     $text .= <<END;
1679       function acstate_changed(what) {
1680         state = what.options[what.selectedIndex].text;
1681         what.form.popac.options.length = 0
1682         what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1683 END
1684   }
1685
1686   my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1687   foreach my $state ( sort { $a cmp $b } @states ) {
1688     $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1689
1690     foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1691       $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1692       if ($ac eq $param->{'popac'}) {
1693         $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1694       }
1695     }
1696     $text .= "}\n" unless $init_popstate;
1697   }
1698   $text .= "popac_changed(what.form.popac)}\n";
1699
1700   $text .= <<END;
1701   function popac_changed(what) {
1702     ac = what.options[what.selectedIndex].text;
1703     what.form.popnum.options.length = 0;
1704     what.form.popnum.options[0] = new Option("City", "-1", false, true);
1705
1706 END
1707
1708   foreach my $state ( @states ) {
1709     foreach my $popac ( keys %{ $pop{$state} } ) {
1710       $text .= "\nif ( ac == \"$popac\" ) {\n";
1711
1712       foreach my $pop ( @{$pop{$state}->{$popac}}) {
1713         my $o_popnum = $pop->{popnum};
1714         my $poptext =  $pop->{city}. ', '. $pop->{state}.
1715                        ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1716
1717         $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1718         if ($popnum == $o_popnum) {
1719           $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1720         }
1721       }
1722       $text .= "}\n";
1723     }
1724   }
1725
1726
1727   $text .= "}\n</SCRIPT>\n";
1728
1729   $param->{'acstate'} = '' unless defined($param->{'acstate'});
1730
1731   $text .=
1732     qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1733     qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1734   $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1735            ">$_" foreach sort { $a cmp $b } @states;
1736   $text .= '</SELECT>'; #callback? return 3 html pieces?  #'</TD>';
1737
1738   $text .=
1739     qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1740     qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1741
1742   $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1743
1744
1745   #comment this block to disable initial list polulation
1746   my @initial_select = ();
1747   if ( scalar( @$pops ) > 100 ) {
1748     push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1749   } else {
1750     @initial_select = @$pops;
1751   }
1752   foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1753     $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1754              ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1755              $pop->{city}. ', '. $pop->{state}.
1756                ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1757   }
1758
1759   $text .= qq!</SELECT></TD></TR></TABLE>!;
1760
1761   $text;
1762
1763 }
1764
1765 =item domainselector HASHREF | LIST
1766
1767 Takes as input a hashref or list of key/value pairs with the following keys:
1768
1769 =over 4
1770
1771 =item pkgnum
1772
1773 Package number
1774
1775 =item domsvc
1776
1777 Service number of the selected item.
1778
1779 =back
1780
1781 Returns an HTML fragment for domain selection.
1782
1783 =cut
1784
1785 sub domainselector {
1786   my $param;
1787   if ( ref($_[0]) ) {
1788     $param = shift;
1789   } else {
1790     $param = { @_ };
1791   }
1792   my $domsvc= $param->{'domsvc'};
1793   my $rv =
1794       domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1795   my $domains = $rv->{'domains'};
1796   $domsvc = $rv->{'domsvc'} unless $domsvc;
1797
1798   return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1799     unless scalar(keys %$domains);
1800
1801   if (scalar(keys %$domains) == 1) {
1802     my $key;
1803     foreach(keys %$domains) {
1804       $key = $_;
1805     }
1806     return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1807            '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1808   }
1809
1810   my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1811
1812
1813   foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1814     $text .= qq!<OPTION VALUE="!. $domain. '"'.
1815              ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1816              $domains->{$domain};
1817   }
1818
1819   $text .= qq!</SELECT></TD></TR>!;
1820
1821   $text;
1822
1823 }
1824
1825 =item didselector HASHREF | LIST
1826
1827 Takes as input a hashref or list of key/value pairs with the following keys:
1828
1829 =over 4
1830
1831 =item field
1832
1833 Field name for the returned HTML fragment.
1834
1835 =item svcpart
1836
1837 Service definition (see L<FS::part_svc>)
1838
1839 =back
1840
1841 Returns an HTML fragment for DID selection.
1842
1843 =cut
1844
1845 sub didselector {
1846   my $param;
1847   if ( ref($_[0]) ) {
1848     $param = shift;
1849   } else {
1850     $param = { @_ };
1851   }
1852
1853   my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1854                        'args'=>[ %$param ],
1855                      );
1856
1857   #hmm.
1858   $rv->{'error'} || $rv->{'output'};
1859
1860 }
1861
1862 =back
1863
1864 =head1 RESELLER FUNCTIONS
1865
1866 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1867 with their active session, and the B<customer_info> and B<order_pkg> functions
1868 with their active session and an additional I<custnum> parameter.
1869
1870 For the most part, development of the reseller web interface has been
1871 superceded by agent-virtualized access to the backend.
1872
1873 =over 4
1874
1875 =item agent_login
1876
1877 Agent login
1878
1879 =item agent_info
1880
1881 Agent info
1882
1883 =item agent_list_customers
1884
1885 List agent's customers.
1886
1887 =back
1888
1889 =head1 BUGS
1890
1891 =head1 SEE ALSO
1892
1893 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>
1894
1895 =cut
1896
1897 1;
1898