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