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