FS/FS/ClientAPI/MyAccount.pm

   1 package FS::ClientAPI::MyAccount;
   2
   3 use 5.008; #require 5.8+ for Time::Local 1.05+
   4 use strict;
   5 use vars qw( $cache $DEBUG $me );
   6 use subs qw( _cache _provision );
   7 use IO::Scalar;
   8 use Data::Dumper;
   9 use Digest::MD5 qw(md5_hex);
  10 use Digest::SHA qw(sha512_hex);
  11 use Date::Format;
  12 use Time::Duration;
  13 use Time::Local qw(timelocal_nocheck);
  14 use Business::CreditCard 0.35;
  15 use HTML::Entities;
  16 use Text::CSV_XS;
  17 use Spreadsheet::WriteExcel;
  18 use OLE::Storage_Lite;
  19 use FS::UI::Web::small_custview qw(small_custview); #less doh
  20 use FS::UI::Web;
  21 use FS::UI::bytecount qw( display_bytecount );
  22 use FS::Conf;
  23 #use FS::UID qw(dbh);
  24 use FS::Record qw(qsearch qsearchs dbh);
  25 use FS::Msgcat qw(gettext);
  26 use FS::Misc qw(card_types money_pretty);
  27 use FS::Misc::DateTime qw(parse_datetime);
  28 use FS::TicketSystem;
  29 use FS::ClientAPI_SessionCache;
  30 use FS::cust_svc;
  31 use FS::svc_acct;
  32 use FS::svc_forward;
  33 use FS::svc_domain;
  34 use FS::svc_phone;
  35 use FS::svc_external;
  36 use FS::svc_dsl;
  37 use FS::dsl_device;
  38 use FS::part_svc;
  39 use FS::cust_main;
  40 use FS::cust_bill;
  41 use FS::legacy_cust_bill;
  42 use FS::cust_main_county;
  43 use FS::part_pkg;
  44 use FS::cust_pkg;
  45 use FS::payby;
  46 use FS::acct_rt_transaction;
  47 use FS::msg_template;
  48 use FS::contact;
  49 use FS::cust_location;
  50
  51 # for code organization
  52 use FS::ClientAPI::MyAccount::contact;
  53 use FS::ClientAPI::MyAccount::quotation;
  54
  55 $DEBUG = 0;
  56 $me = '[FS::ClientAPI::MyAccount]';
  57
  58 use vars qw( @cust_main_editable_fields @location_editable_fields );
  59 @cust_main_editable_fields = qw(
  60   first last company daytime night fax mobile
  61   locale
  62   payby payinfo payname paystart_month paystart_year payissue payip
  63   ss paytype paystate stateid stateid_state
  64 );
  65 @location_editable_fields = qw(
  66   address1 address2 city county state zip country
  67 );
  68
  69
  70 BEGIN { #preload to reduce time customer_info takes
  71   if ( $FS::TicketSystem::system ) {
  72     warn "$me: initializing ticket system\n" if $DEBUG;
  73     FS::TicketSystem->init();
  74   }
  75 }
  76
  77 sub _cache {
  78   $cache ||= new FS::ClientAPI_SessionCache( {
  79                'namespace' => 'FS::ClientAPI::MyAccount',
  80              } );
  81 }
  82
  83 sub skin_info {
  84   my $p = shift;
  85
  86   my($context, $session, $custnum) = _custoragent_session_custnum($p);
  87   #return { 'error' => $session } if $context eq 'error';
  88
  89   my $agentnum = '';
  90   if ( $context eq 'customer' ) {
  91
  92     my $sth = dbh->prepare('SELECT agentnum FROM cust_main WHERE custnum = ?')
  93       or die dbh->errstr;
  94
  95     $sth->execute($custnum) or die $sth->errstr;
  96
  97     $agentnum = $sth->fetchrow_arrayref->[0]
  98       or die "no agentnum for custnum $custnum";
  99
 100   #} elsif ( $context eq 'agent' ) {
 101   } elsif ( defined($p->{'agentnum'}) and $p->{'agentnum'} =~ /^(\d+)$/ ) {
 102     $agentnum = $1;
 103   }
 104   $p->{'agentnum'} = $agentnum;
 105
 106   my $conf = new FS::Conf;
 107
 108   #false laziness w/Signup.pm
 109
 110   my $skin_info_cache_agent = _cache->get("skin_info_cache_agent$agentnum");
 111
 112   if ( $skin_info_cache_agent ) {
 113
 114     warn "$me loading cached skin info for agentnum $agentnum\n"
 115       if $DEBUG > 1;
 116
 117   } else {
 118
 119     warn "$me populating skin info cache for agentnum $agentnum\n"
 120       if $DEBUG > 1;
 121
 122     $skin_info_cache_agent = {
 123       'agentnum' => $agentnum,
 124       ( map { $_ => scalar( $conf->config($_, $agentnum) ) }
 125         qw( company_name date_format ) ),
 126       ( map { $_ => scalar( $conf->config("selfservice-$_", $agentnum ) ) }
 127         qw( body_bgcolor box_bgcolor stripe1_bgcolor stripe2_bgcolor
 128             text_color link_color vlink_color hlink_color alink_color
 129             font title_color title_align title_size menu_bgcolor menu_fontsize
 130           )
 131       ),
 132       'menu_disable' => [ $conf->config('selfservice-menu_disable',$agentnum) ],
 133       ( map { $_ => $conf->exists("selfservice-$_", $agentnum ) }
 134         qw( menu_skipblanks menu_skipheadings menu_nounderline no_logo enable_payment_without_balance )
 135       ),
 136       ( map { $_ => scalar($conf->config_binary("selfservice-$_", $agentnum)) }
 137         qw( title_left_image title_right_image
 138             menu_top_image menu_body_image menu_bottom_image
 139           )
 140       ),
 141       'logo' => scalar($conf->config_binary('logo.png', $agentnum )),
 142       ( map { $_ => join("\n", $conf->config("selfservice-$_", $agentnum ) ) }
 143         qw( head body_header body_footer company_address ) ),
 144       'money_char' => $conf->config("money_char") || '$',
 145       'menu' => join("\n", $conf->config("ng_selfservice-menu", $agentnum ) ) ||
 146                 'main.php Home
 147
 148                  services.php Services
 149                  services.php My Services
 150                  services_new.php Order a new service
 151
 152                  personal.php Profile
 153                  personal.php Personal Information
 154                  password.php Change Password
 155
 156                  payment.php Payments
 157                  payment_cc.php Credit Card Payment
 158                  payment_ach.php Electronic Check Payment
 159                  payment_paypal.php PayPal Payment
 160                  payment_webpay.php Webpay Payments
 161
 162                  usage.php Usage
 163                  usage_data.php Data usage
 164                  usage_cdr.php Call usage
 165
 166                  tickets.php Help Desk
 167                  tickets.php Open Tickets
 168                  tickets_resolved.php Resolved Tickets
 169                  ticket_create.php Create a new ticket
 170
 171                  docs.php FAQs
 172
 173                  logout.php Logout
 174                 ',
 175     };
 176
 177     _cache->set("skin_info_cache_agent$agentnum", $skin_info_cache_agent);
 178
 179   }
 180
 181   #{ %$skin_info_cache_agent };
 182   $skin_info_cache_agent;
 183
 184 }
 185
 186 sub login_info {
 187   my $p = shift;
 188
 189   my $conf = new FS::Conf;
 190
 191   my %info = (
 192     %{ skin_info($p) },
 193     'phone_login'  => $conf->exists('selfservice_server-phone_login'),
 194     'single_domain'=> scalar($conf->config('selfservice_server-single_domain')),
 195     'banner_url'       => scalar($conf->config('selfservice-login_banner_url')),
 196     'banner_image_md5' =>
 197       md5_hex($conf->config_binary('selfservice-login_banner_image')),
 198   );
 199
 200   return \%info;
 201
 202 }
 203
 204 sub login_banner_image {
 205   my $p = shift;
 206   my $conf = new FS::Conf;
 207   my $image = $conf->config_binary('selfservice-login_banner_image');
 208   return {
 209     'md5'   => md5_hex($image),
 210     'image' => $image,
 211   };
 212 }
 213
 214 #false laziness w/FS::ClientAPI::passwd::passwd
 215 sub login {
 216   my $p = shift;
 217
 218   my $conf = new FS::Conf;
 219
 220   my $svc_x = '';
 221   my $session = {};
 222   if ( $p->{'domain'} eq 'svc_phone'
 223        && $conf->exists('selfservice_server-phone_login') ) {
 224
 225     my $svc_phone = qsearchs( 'svc_phone', { 'phonenum' => $p->{'username'} } );
 226     return { error => 'Number not found.' } unless $svc_phone;
 227
 228     #XXX?
 229     #my $pkg_svc = $svc_acct->cust_svc->pkg_svc;
 230     #return { error => 'Only primary user may log in.' }
 231     #  if $conf->exists('selfservice_server-primary_only')
 232     #    && ( ! $pkg_svc || $pkg_svc->primary_svc ne 'Y' );
 233
 234     return { error => 'Incorrect PIN.' }
 235       unless $svc_phone->check_pin($p->{'password'});
 236
 237     $svc_x = $svc_phone;
 238
 239   } elsif ( $p->{email}
 240               && (my $contact = FS::contact->by_selfservice_email($p->{email}))
 241           )
 242   {
 243     return { error => 'Incorrect contact password.' }
 244       unless $contact->authenticate_password($p->{'password'});
 245
 246     $session->{'contactnum'} = $contact->contactnum;
 247
 248     $session->{'custnum'} = $contact->custnum;
 249
 250   } else {
 251
 252     ( $p->{username}, $p->{domain} ) = split('@', $p->{email}) if $p->{email};
 253
 254     my $svc_domain = qsearchs('svc_domain', { 'domain' => $p->{'domain'} } )
 255       or return { error => 'Domain '. $p->{'domain'}. ' not found' };
 256
 257     my @svc_acct = qsearch( 'svc_acct', { 'username'  => $p->{'username'},
 258                                           'domsvc'    => $svc_domain->svcnum, }
 259                           );
 260
 261     if ( $conf->exists('selfservice_server-login_svcpart') ) {
 262       my @svcpart = $conf->config('selfservice_server-login_svcpart');
 263       @svc_acct = grep { my $svcpart = $_->cust_svc->svcpart;
 264                          scalar( grep( $_ eq $svcpart, @svcpart ) );
 265                        }
 266                     @svc_acct;
 267     }
 268
 269     if ( $conf->exists('selfservice_server-primary_only') ) {
 270         @svc_acct =
 271           grep {
 272             my $cust_svc = $_->cust_svc;
 273             $cust_svc->cust_pkg->part_pkg->svcpart([qw( svc_acct svc_phone )])
 274               == $cust_svc->svcpart
 275           }
 276           @svc_acct;
 277     }
 278
 279     return { error => 'User not found.' } unless @svc_acct;
 280
 281     #return { error => 'Multiple users.' } if scalar(@svc_acct) > 1;
 282
 283     my $svc_acct = $svc_acct[0];
 284
 285     if ( $conf->exists('selfservice_server-login_svcpart') ) {
 286       my @svcpart = $conf->config('selfservice_server-login_svcpart');
 287       my $svcpart = $svc_acct->cust_svc->svcpart;
 288       return { error => 'Invalid user.' }
 289         unless grep($_ eq $svcpart, @svcpart);
 290     }
 291
 292     return { error => 'Incorrect password.' }
 293       unless $svc_acct->check_password($p->{'password'});
 294
 295     $svc_x = $svc_acct;
 296
 297   }
 298
 299   if ( $svc_x ) {
 300
 301     $session->{'svcnum'} = $svc_x->svcnum;
 302
 303     my $cust_svc = $svc_x->cust_svc;
 304     my $cust_pkg = $cust_svc->cust_pkg;
 305     if ( $cust_pkg ) {
 306       my $cust_main = $cust_pkg->cust_main;
 307       $session->{'custnum'} = $cust_main->custnum;
 308       if ( $conf->exists('pkg-balances') ) {
 309         my @cust_pkg = grep { $_->part_pkg->freq !~ /^(0|$)/ }
 310                             $cust_main->ncancelled_pkgs;
 311         $session->{'pkgnum'} = $cust_pkg->pkgnum
 312           if scalar(@cust_pkg) > 1;
 313       }
 314     }
 315
 316     #my $pkg_svc = $svc_acct->cust_svc->pkg_svc;
 317     #return { error => 'Only primary user may log in.' }
 318     #  if $conf->exists('selfservice_server-primary_only')
 319     #    && ( ! $pkg_svc || $pkg_svc->primary_svc ne 'Y' );
 320     my $part_pkg = $cust_pkg->part_pkg;
 321     return { error => 'Only primary user may log in.' }
 322       if $conf->exists('selfservice_server-primary_only')
 323          && $cust_svc->svcpart != $part_pkg->svcpart([qw( svc_acct svc_phone )]);
 324
 325   }
 326
 327   my $session_id;
 328   do {
 329     $session_id = md5_hex(md5_hex(time(). {}. rand(). $$))
 330   } until ( ! defined _cache->get($session_id) ); #just in case
 331
 332   my $timeout = $conf->config('selfservice-session_timeout') || '1 hour';
 333   _cache->set( $session_id, $session, $timeout );
 334
 335   return { 'error'      => '',
 336            'session_id' => $session_id,
 337          };
 338 }
 339
 340 sub logout {
 341   my $p = shift;
 342   my $skin_info = skin_info($p);
 343   if ( $p->{'session_id'} ) {
 344     _cache->remove($p->{'session_id'});
 345     return { %$skin_info, 'error' => '' };
 346   } else {
 347     return { %$skin_info, 'error' => "Can't resume session" }; #better error message
 348   }
 349 }
 350
 351 sub switch_acct {
 352   my $p = shift;
 353
 354   my($context, $session, $custnum) = _custoragent_session_custnum($p);
 355   return { 'error' => $session } if $context eq 'error';
 356
 357   my $svc_acct = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_acct' )
 358     or return { 'error' => "Service not found" };
 359
 360   $session->{'svcnum'} = $svc_acct->svcnum;
 361
 362   my $conf = new FS::Conf;
 363   my $timeout = $conf->config('selfservice-session_timeout') || '1 hour';
 364   _cache->set( $p->{'session_id'}, $session, $timeout );
 365
 366   return { 'error' => '' };
 367
 368 }
 369
 370 sub payment_gateway {
 371   # internal use only
 372   # takes a cust_main and a cust_payby entry, returns the payment_gateway
 373   my $conf = new FS::Conf;
 374   my $cust_main = shift;
 375   my $cust_payby = shift;
 376   my $gatewaynum = $conf->config('selfservice-payment_gateway');
 377   if ( $gatewaynum ) {
 378     my $pg = qsearchs('payment_gateway', { gatewaynum => $gatewaynum });
 379     die "configured gatewaynum $gatewaynum not found!" if !$pg;
 380     return $pg;
 381   }
 382   else {
 383     return '' if ! FS::payby->realtime($cust_payby);
 384     my $pg = $cust_main->agent->payment_gateway(
 385       'method'  => FS::payby->payby2bop($cust_payby),
 386       'nofatal' => 1
 387     );
 388     return $pg;
 389   }
 390 }
 391
 392 sub access_info {
 393   my $p = shift;
 394
 395   my $conf = new FS::Conf;
 396
 397   my $info = skin_info($p);
 398
 399   use vars qw( $cust_paybys ); #cache for performance
 400   unless ( $cust_paybys ) {
 401
 402     my %cust_paybys = map { $_ => 1 }
 403                       map { FS::payby->payby2payment($_) }
 404                           $conf->config('signup_server-payby');
 405
 406     $cust_paybys = [ keys %cust_paybys ];
 407
 408   }
 409   $info->{'cust_paybys'} = $cust_paybys;
 410
 411   my($context, $session, $custnum) = _custoragent_session_custnum($p);
 412   return { 'error' => $session } if $context eq 'error';
 413
 414   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
 415     or return { 'error' => "unknown custnum $custnum" };
 416
 417   $info->{'hide_payment_fields'} = [
 418     map {
 419       my $pg = payment_gateway($cust_main, $_);
 420       $pg && $pg->gateway_namespace eq 'Business::OnlineThirdPartyPayment';
 421     } @{ $info->{cust_paybys} }
 422   ];
 423
 424   $info->{'self_suspend_reason'} =
 425       $conf->config('selfservice-self_suspend_reason', $cust_main->agentnum);
 426
 427   $info->{'edit_ticket_subject'} =
 428       $conf->exists('ticket_system-selfservice_edit_subject') &&
 429       $cust_main->edit_subject;
 430
 431   $info->{'timeout'} = $conf->config('selfservice-timeout') || 3600;
 432
 433   $info->{'hide_usage'} = $conf->exists('selfservice_hide-usage');
 434
 435   return { %$info,
 436            'custnum'       => $custnum,
 437            'access_pkgnum' => $session->{'pkgnum'},
 438            'access_svcnum' => $session->{'svcnum'},
 439          };
 440 }
 441
 442 sub customer_info {
 443   my $p = shift;
 444
 445   my($context, $session, $custnum) = _custoragent_session_custnum($p);
 446   return { 'error' => $session } if $context eq 'error';
 447
 448   my %return;
 449
 450   my $conf = new FS::Conf;
 451   $return{'require_address2'} = $conf->exists('cust_main-require_address2');
 452
 453 #  if ( $FS::TicketSystem::system ) {
 454 #    warn "$me customer_info: initializing ticket system\n" if $DEBUG;
 455 #    FS::TicketSystem->init();
 456 #  }
 457
 458   if ( $custnum ) { #customer record
 459
 460     %return = ( %return, %{ customer_info_short($p) } );
 461
 462     #redundant with customer_info_short, but we need it for several things below
 463     my $search = { 'custnum' => $custnum };
 464     $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
 465     my $cust_main = qsearchs('cust_main', $search )
 466       or return { 'error' => "unknown custnum $custnum" };
 467
 468     my $list_tickets = list_tickets($p);
 469     $return{'tickets'} = $list_tickets->{'tickets'};
 470
 471     if ( $session->{'pkgnum'} ) {
 472       #XXX open invoices in the pkg-balances case
 473     } else {
 474       $return{'money_char'} = $conf->config("money_char") || '$';
 475       my @open = map {
 476                        {
 477                          invnum     => $_->invnum,
 478                          date       => time2str("%b %o, %Y", $_->_date),
 479                          owed       => $_->owed,
 480                          charged    => $_->charged,
 481                        };
 482                      } $cust_main->open_cust_bill;
 483       $return{open_invoices} = \@open;
 484
 485       my $sql = 'SELECT MAX(_date) FROM cust_bill WHERE custnum = ?';
 486       my $sth = dbh->prepare($sql) or die  dbh->errstr;
 487       $sth->execute($custnum)      or die $sth->errstr;
 488       $return{'last_invoice_date'} = $sth->fetchrow_arrayref->[0];
 489       $return{'last_invoice_date_pretty'} =
 490         time2str('%m/%d/%Y', $return{'last_invoice_date'} );
 491     }
 492
 493     #customer_info_short always has nobalance on..
 494     $return{small_custview} =
 495       small_custview( $cust_main,
 496                       $return{countrydefault},
 497                       ( $session->{'pkgnum'} ? 1 : 0 ), #nobalance
 498                     );
 499
 500     $return{has_ship_address} = $cust_main->has_ship_address;
 501     $return{status} = $cust_main->status;
 502     $return{statuscolor} = $cust_main->statuscolor;
 503
 504     # compatibility: some places in selfservice use this to determine
 505     # if there's a ship address
 506     if ( $return{has_ship_address} ) {
 507       $return{ship_last}  = $cust_main->last;
 508       $return{ship_first} = $cust_main->first;
 509     }
 510
 511     if (scalar($conf->config('support_packages'))) {
 512       my @support_services = ();
 513       foreach ($cust_main->support_services) {
 514         my $seconds = $_->svc_x->seconds || 0;
 515         my $time_remaining = (($seconds < 0) ? '-' : '' ).
 516                              int(abs($seconds)/3600)."h".
 517                              sprintf("%02d",(abs($seconds)%3600)/60)."m";
 518         my $cust_pkg = $_->cust_pkg;
 519         my $pkgnum = '';
 520         my $pkg = '';
 521         $pkgnum = $cust_pkg->pkgnum if $cust_pkg;
 522         $pkg = $cust_pkg->part_pkg->pkg if $cust_pkg;
 523         push @support_services, { svcnum => $_->svcnum,
 524                                   time => $time_remaining,
 525                                   pkgnum => $pkgnum,
 526                                   pkg => $pkg,
 527                                 };
 528       }
 529       $return{support_services} = \@support_services;
 530     }
 531
 532     if ( $conf->config('prepayment_discounts-credit_type') ) {
 533       #need to eval?
 534       $return{discount_terms_hash} = { $cust_main->discount_terms_hash };
 535     }
 536
 537   } elsif ( $session->{'svcnum'} ) { #no customer record
 538
 539     my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $session->{'svcnum'} } )
 540       or die "unknown svcnum";
 541     $return{name} = $svc_acct->email;
 542
 543   } else {
 544
 545     return { 'error' => 'Expired session' }; #XXX redirect to login w/this err!
 546
 547   }
 548
 549   return { 'error'   => '',
 550            'custnum' => $custnum,
 551            %return,
 552          };
 553
 554 }
 555
 556 sub customer_info_short {
 557   my $p = shift;
 558
 559   my($context, $session, $custnum) = _custoragent_session_custnum($p);
 560   return { 'error' => $session } if $context eq 'error';
 561
 562   my %return;
 563
 564   my $conf = new FS::Conf;
 565
 566   if ( $custnum ) { #customer record
 567
 568     my $search = { 'custnum' => $custnum };
 569     $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
 570     my $cust_main = qsearchs('cust_main', $search )
 571       or return { 'error' => "unknown custnum $custnum" };
 572
 573     $return{display_custnum} = $cust_main->display_custnum;
 574
 575     if ( $session->{'pkgnum'} ) {
 576       $return{balance} = $cust_main->balance_pkgnum( $session->{'pkgnum'} );
 577       #next_bill_date from cust_pkg?
 578     } else {
 579       $return{balance} = $cust_main->balance;
 580       $return{next_bill_date} = $cust_main->next_bill_date;
 581       $return{next_bill_date_pretty} =
 582         $return{next_bill_date} ? time2str('%m/%d/%Y', $return{next_bill_date} )
 583                                 : '(none)';
 584     }
 585     $return{balance_pretty} = money_pretty($return{balance});
 586
 587     $return{countrydefault} = scalar($conf->config('countrydefault'));
 588
 589     $return{small_custview} =
 590       small_custview( $cust_main,
 591                       $return{countrydefault},
 592                       1, ##nobalance
 593                     );
 594
 595     $return{name} = $cust_main->first. ' '. $cust_main->get('last');
 596
 597     $return{payby} = $cust_main->payby;
 598
 599     #none of these are terribly expensive if we want 'em...
 600     for (@cust_main_editable_fields) {
 601       $return{$_} = $cust_main->get($_);
 602     }
 603     #maybe a little more expensive, but it should be cached by now
 604     for (@location_editable_fields) {
 605       $return{$_} = $cust_main->bill_location->get($_);
 606       $return{'ship_'.$_} = $cust_main->ship_location->get($_);
 607     }
 608
 609     if ( $cust_main->payby =~ /^(CARD|DCRD)$/ ) {
 610       $return{payinfo} = $cust_main->paymask;
 611       @return{'month', 'year'} = $cust_main->paydate_monthyear;
 612     }
 613
 614     my @invoicing_list = $cust_main->invoicing_list;
 615     $return{'invoicing_list'} =
 616       join(', ', grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list );
 617     $return{'postal_invoicing'} =
 618       0 < ( grep { $_ eq 'POST' } @invoicing_list );
 619
 620     if ( $session->{'svcnum'} ) {
 621       my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $session->{'svcnum'} });
 622       $return{'svc_label'} = ($cust_svc->label)[1] if $cust_svc;
 623       $return{'svcnum'} = $session->{'svcnum'};
 624     }
 625
 626   } elsif ( $session->{'svcnum'} ) { #no customer record
 627
 628     #uuh, not supproted yet... die?
 629     return { 'error' => 'customer_info_short not yet supported as agent' };
 630
 631   } else {
 632
 633     return { 'error' => 'Expired session' }; #XXX redirect to login w/this err!
 634
 635   }
 636
 637   # this is here because this routine is called by both fs_ and ng_ main pages, where it appears
 638   # it is not customer-specific, though it is only shown to authenticated customers
 639   # it is not currently agent-specific, though at some point it might be
 640   $return{'announcement'} = join(' ',$conf->config('selfservice-announcement')) || '';
 641
 642   return { 'error'          => '',
 643            'custnum'        => $custnum,
 644            %return,
 645          };
 646 }
 647
 648 sub customer_recurring {
 649   my $p = shift;
 650
 651   my($context, $session, $custnum) = _custoragent_session_custnum($p);
 652   return { 'error' => $session } if $context eq 'error';
 653
 654   my %return;
 655
 656   my $conf = new FS::Conf;
 657
 658   my $search = { 'custnum' => $custnum };
 659   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
 660   my $cust_main = qsearchs('cust_main', $search )
 661     or return { 'error' => "customer_info_short: unknown custnum $custnum" };
 662
 663   $return{'display_recurring'} = [ $cust_main->display_recurring ];
 664
 665   return { 'error'          => '',
 666            'custnum'        => $custnum,
 667            %return,
 668          };
 669 }
 670
 671 sub billing_history {
 672   my $p = shift;
 673
 674   my($context, $session, $custnum) = _custoragent_session_custnum($p);
 675   return { 'error' => $session } if $context eq 'error';
 676
 677   return { 'error' => 'No customer' } unless $custnum;
 678
 679   my $search = { 'custnum' => $custnum };
 680   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
 681   my $cust_main = qsearchs('cust_main', $search )
 682     or return { 'error' => "unknown custnum $custnum" };
 683
 684   my %return = ();
 685
 686   if ( $session->{'pkgnum'} ) {
 687     #$return{balance} = $cust_main->balance_pkgnum( $session->{'pkgnum'} );
 688     #next_bill_date from cust_pkg?
 689     return { 'error' => 'No history for package' };
 690   }
 691
 692   $return{balance} = $cust_main->balance;
 693   $return{balance_pretty} = money_pretty($return{balance});
 694   $return{next_bill_date} = $cust_main->next_bill_date;
 695   $return{next_bill_date_pretty} =
 696     $return{next_bill_date} ? time2str('%m/%d/%Y', $return{next_bill_date} )
 697                             : '(none)';
 698
 699   my $conf = new FS::Conf;
 700
 701   $return{'history'} = [
 702     $cust_main->payment_history(
 703       'line_items' => $conf->exists('selfservice-billing_history-line_items'),
 704       'reverse_sort' => 1,
 705     )
 706   ];
 707
 708   $return{'money_char'} = $conf->config("money_char") || '$',
 709
 710   return \%return;
 711
 712 }
 713
 714 sub edit_info {
 715   my $p = shift;
 716   my $session = _cache->get($p->{'session_id'})
 717     or return { 'error' => "Can't resume session" }; #better error message
 718
 719   my $custnum = $session->{'custnum'}
 720     or return { 'error' => "no customer record" };
 721
 722   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
 723     or return { 'error' => "unknown custnum $custnum" };
 724
 725   my $conf = new FS::Conf;
 726   if (($p->{payby} eq "CHEK" || $p->{payby} eq "DCHEK") && $conf->exists('selfservice-ACH_info_readonly')) {
 727     return { 'error' => "You do not have authority to add a bank account" };
 728   }
 729
 730   my $new = new FS::cust_main { $cust_main->hash };
 731
 732   $new->set( $_ => $p->{$_} )
 733     foreach grep { exists $p->{$_} } @cust_main_editable_fields;
 734
 735   if ( exists($p->{address1}) ) {
 736     my $bill_location = FS::cust_location->new({
 737         map { $_ => $p->{$_} } @location_editable_fields
 738     });
 739     # if this is unchanged from before, cust_main::replace will ignore it
 740     $new->set('bill_location' => $bill_location);
 741   }
 742
 743   if ( exists($p->{ship_address1}) ) {
 744     my $ship_location = FS::cust_location->new({
 745         map { $_ => $p->{"ship_$_"} } @location_editable_fields
 746     });
 747     if ( !grep { length($p->{"ship_$_"}) } @location_editable_fields ) {
 748       # Selfservice unfortunately tries to indicate "same as billing
 749       # address" by sending all fields empty.  Did this ever work?
 750       $ship_location = $cust_main->bill_location;
 751     }
 752     $new->set('ship_location' => $ship_location);
 753   }
 754   # but if it hasn't been passed in at all, leave ship_location alone--
 755   # DON'T change it to match bill_location.
 756
 757   my $payby = '';
 758   if (exists($p->{'payby'})) {
 759     $p->{'payby'} =~ /^([A-Z]{4})$/
 760       or return { 'error' => "illegal_payby " . $p->{'payby'} };
 761     $payby = $1;
 762   }
 763
 764   if ( $payby =~ /^(CARD|DCRD)$/ ) {
 765
 766     $new->paydate($p->{'year'}. '-'. $p->{'month'}. '-01');
 767
 768     if ( $new->payinfo eq $cust_main->paymask ) {
 769       $new->payinfo($cust_main->payinfo);
 770       $new->paycvv( $p->{'paycvv'} || $cust_main->paycvv );
 771     } else {
 772       $new->payinfo($p->{'payinfo'});
 773       return { 'error' => 'CVV2 is required' }
 774         if ! $p->{'paycvv'} && $conf->exists('selfservice-onfile_require_cvv');
 775       $new->paycvv( $p->{'paycvv'} )
 776     }
 777
 778     $new->set( 'payby' => $p->{'auto'} ? 'CARD' : 'DCRD' );
 779
 780   } elsif ( $payby =~ /^(CHEK|DCHK)$/ ) {
 781
 782     my $payinfo;
 783     $p->{'payinfo1'} =~ /^([\dx]+)$/
 784       or return { 'error' => "illegal account number ". $p->{'payinfo1'} };
 785     my $payinfo1 = $1;
 786      $p->{'payinfo2'} =~ /^([\dx\.]+)$/ # . turned on by echeck-country CA ?
 787       or return { 'error' => "illegal ABA/routing number ". $p->{'payinfo2'} };
 788     my $payinfo2 = $1;
 789     $payinfo = $payinfo1. '@'. $payinfo2;
 790
 791     $new->payinfo( ($payinfo eq $cust_main->paymask)
 792                      ? $cust_main->payinfo
 793                      : $payinfo
 794                  );
 795
 796     $new->set( 'payby' => $p->{'auto'} ? 'CHEK' : 'DCHK' );
 797
 798   } elsif ( $payby =~ /^(BILL)$/ ) {
 799     #no-op
 800   } elsif ( $payby ) {  #notyet ready
 801     return { 'error' => "unknown payby $payby" };
 802   }
 803
 804   my @invoicing_list;
 805   if ( exists $p->{'invoicing_list'} || exists $p->{'postal_invoicing'} ) {
 806     #false laziness with httemplate/edit/process/cust_main.cgi
 807     @invoicing_list = split( /\s*\,\s*/, $p->{'invoicing_list'} );
 808     push @invoicing_list, 'POST' if $p->{'postal_invoicing'};
 809   } else {
 810     @invoicing_list = $cust_main->invoicing_list;
 811   }
 812
 813   my $error = $new->replace($cust_main, \@invoicing_list);
 814   return { 'error' => $error } if $error;
 815   #$cust_main = $new;
 816
 817   return { 'error' => '' };
 818 }
 819
 820 sub payment_info {
 821   my $p = shift;
 822   my $session = _cache->get($p->{'session_id'})
 823     or return { 'error' => "Can't resume session" }; #better error message
 824
 825   ##
 826   #generic
 827   ##
 828
 829   my $conf = new FS::Conf;
 830   use vars qw($payment_info); #cache for performance
 831   unless ( $payment_info ) {
 832
 833     my %states = map { $_->state => 1 }
 834                    qsearch('cust_main_county', {
 835                      'country' => $conf->config('countrydefault') || 'US'
 836                    } );
 837
 838     my %cust_paybys = map { $_ => 1 }
 839                       map { FS::payby->payby2payment($_) }
 840                           $conf->config('signup_server-payby');
 841
 842     my @cust_paybys = keys %cust_paybys;
 843
 844     $payment_info = {
 845
 846       #list all counties/states/countries
 847       'cust_main_county' =>
 848         [ map { $_->hashref } qsearch('cust_main_county', {}) ],
 849
 850       #shortcut for one-country folks
 851       'states' =>
 852         [ sort { $a cmp $b } keys %states ],
 853
 854       'card_types' => card_types(),
 855
 856       'withcvv'            => $conf->exists('selfservice-require_cvv'), #or enable optional cvv?
 857       'require_cvv'        => $conf->exists('selfservice-require_cvv'),
 858       'onfile_require_cvv' => $conf->exists('selfservice-onfile_require_cvv'),
 859
 860       'paytypes' => [ @FS::cust_main::paytypes ],
 861
 862       'paybys' => [ $conf->config('signup_server-payby') ],
 863       'cust_paybys' => \@cust_paybys,
 864
 865       'stateid_label' => FS::Msgcat::_gettext('stateid'),
 866       'stateid_state_label' => FS::Msgcat::_gettext('stateid_state'),
 867
 868       'show_ss'  => $conf->exists('show_ss'),
 869       'show_stateid' => $conf->exists('show_stateid'),
 870       'show_paystate' => $conf->exists('show_bankstate'),
 871
 872       'save_unchecked' => $conf->exists('selfservice-save_unchecked'),
 873       'ach_read_only' => $conf->exists('selfservice-ACH_info_readonly'),
 874
 875     };
 876
 877   }
 878
 879   ##
 880   #customer-specific
 881   ##
 882
 883   my %return = %$payment_info;
 884
 885   delete $return{'cust_main_county'} if $p->{'omit_cust_main_county'};
 886
 887   my $custnum = $session->{'custnum'};
 888
 889   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
 890     or return { 'error' => "unknown custnum $custnum" };
 891
 892   $return{'hide_payment_fields'} = [
 893     map {
 894       my $pg = payment_gateway($cust_main, $_);
 895       $pg && $pg->gateway_namespace eq 'Business::OnlineThirdPartyPayment';
 896     } @{ $return{cust_paybys} }
 897   ];
 898
 899   $return{balance} = $cust_main->balance; #XXX pkg-balances?
 900
 901   $return{payname} = $cust_main->payname
 902                      || ( $cust_main->first. ' '. $cust_main->get('last') );
 903
 904   $return{$_} = $cust_main->bill_location->get($_)
 905     for qw(address1 address2 city state zip);
 906
 907   $return{payby} = $cust_main->payby;
 908   $return{stateid_state} = $cust_main->stateid_state;
 909
 910   if ( $cust_main->payby =~ /^(CARD|DCRD)$/ ) {
 911     $return{card_type} = cardtype($cust_main->payinfo);
 912     $return{payinfo} = $cust_main->paymask;
 913
 914     @return{'month', 'year'} = $cust_main->paydate_monthyear;
 915
 916   }
 917
 918   if ( $cust_main->payby =~ /^(CHEK|DCHK)$/ ) {
 919     my ($payinfo1, $payinfo2) = split '@', $cust_main->paymask;
 920     $return{payinfo1} = $payinfo1;
 921     $return{payinfo2} = $payinfo2;
 922     $return{paytype}  = $cust_main->paytype;
 923     $return{paystate} = $cust_main->paystate;
 924     $return{payname}  = $cust_main->payname;    # override 'first/last name' default from above, if any.  Is instution-name here.  (#15819)
 925   }
 926
 927   if ( $conf->config('prepayment_discounts-credit_type') ) {
 928     #need to eval?
 929     $return{discount_terms_hash} = { $cust_main->discount_terms_hash };
 930   }
 931
 932   #doubleclick protection
 933   my $_date = time;
 934   $return{payunique} = "webui-MyAccount-$_date-$$-". rand() * 2**32; #new
 935   $return{paybatch} = $return{payunique};  #back compat
 936
 937   $return{credit_card_surcharge_percentage} = $conf->config('credit-card-surcharge-percentage', $cust_main->agentnum);
 938
 939   return { 'error' => '',
 940            %return,
 941          };
 942
 943 }
 944
 945 #some false laziness with httemplate/process/payment.cgi - look there for
 946 #ACH and CVV support stuff
 947
 948 sub validate_payment {
 949   my $p = shift;
 950
 951   my $session = _cache->get($p->{'session_id'})
 952     or return { 'error' => "Can't resume session" }; #better error message
 953
 954   my $custnum = $session->{'custnum'};
 955
 956   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
 957     or return { 'error' => "unknown custnum $custnum" };
 958
 959   $p->{'amount'} =~ /^\s*(\d+(\.\d{2})?)\s*$/
 960     or return { 'error' => gettext('illegal_amount') };
 961   my $amount = $1;
 962   return { error => 'Amount must be greater than 0' } unless $amount > 0;
 963
 964   #false laziness w/tr-amount_fee.html, but we don't want selfservice users
 965   #changing the hidden form values
 966   my $conf = new FS::Conf;
 967   my $fee_display = $conf->config('selfservice_process-display') || 'add';
 968   my $fee_pkgpart = $conf->config('selfservice_process-pkgpart', $cust_main->agentnum);
 969   my $fee_skip_first = $conf->exists('selfservice_process-skip_first');
 970   if ( $fee_display eq 'add'
 971          and $fee_pkgpart
 972          and ! $fee_skip_first || scalar($cust_main->cust_pay)
 973      )
 974   {
 975     my $fee_pkg = qsearchs('part_pkg', { pkgpart=>$fee_pkgpart } );
 976     $amount = sprintf('%.2f', $amount + $fee_pkg->option('setup_fee') );
 977   }
 978
 979   $p->{'discount_term'} =~ /^\s*(\d*)\s*$/
 980     or return { 'error' => gettext('illegal_discount_term'). ': '. $p->{'discount_term'} };
 981   my $discount_term = $1;
 982
 983   $p->{'payname'} =~ /^([\w \,\.\-\']+)$/
 984     or return { 'error' => gettext('illegal_name'). " payname: ". $p->{'payname'} };
 985   my $payname = $1;
 986
 987   $p->{'payunique'} =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]*)$/
 988     or return { 'error' => gettext('illegal_text'). " payunique: ". $p->{'payunique'} };
 989   my $payunique = $1;
 990
 991   $p->{'paybatch'} =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]*)$/
 992     or return { 'error' => gettext('illegal_text'). " paybatch: ". $p->{'paybatch'} };
 993   my $paybatch = $1;
 994
 995   $payunique = $paybatch if ! length($payunique) && length($paybatch);
 996
 997   $p->{'payby'} ||= 'CARD';
 998   $p->{'payby'} =~ /^([A-Z]{4})$/
 999     or return { 'error' => "illegal_payby " . $p->{'payby'} };
1000   my $payby = $1;
1001
1002   #false laziness w/process/payment.cgi
1003   my $payinfo;
1004   my $paycvv = '';
1005   if ( $payby eq 'CHEK' || $payby eq 'DCHK' ) {
1006
1007     $p->{'payinfo1'} =~ /^([\dx]+)$/
1008       or return { 'error' => "illegal account number ". $p->{'payinfo1'} };
1009     my $payinfo1 = $1;
1010      $p->{'payinfo2'} =~ /^([\dx]+)$/
1011       or return { 'error' => "illegal ABA/routing number ". $p->{'payinfo2'} };
1012     my $payinfo2 = $1;
1013     $payinfo = $payinfo1. '@'. $payinfo2;
1014
1015     $payinfo = $cust_main->payinfo
1016       if $cust_main->paymask eq $payinfo;
1017
1018     my $achonfile = 0;
1019     foreach my $cust_payby ($cust_main->cust_payby('CHEK','DCHK')) {
1020       if ( $cust_payby->paymask eq $payinfo ) {
1021         $payinfo = $cust_payby->payinfo;
1022         $achonfile = 1;
1023         last;
1024       }
1025     }
1026
1027     if ($conf->exists('selfservice-ACH_info_readonly') && !$achonfile) {
1028       return { 'error' => "You are not allowed to change your payment information." };
1029     }
1030
1031   } elsif ( $payby eq 'CARD' || $payby eq 'DCRD' ) {
1032
1033     $payinfo = $p->{'payinfo'};
1034
1035     my $onfile = 0;
1036
1037     #more intelligent matching will be needed here if you change
1038     #card_masking_method and don't remove existing paymasks
1039     if ( $cust_main->paymask eq $payinfo ) {
1040       $payinfo = $cust_main->payinfo;
1041       $onfile = 1;
1042     }
1043
1044     $payinfo =~ s/\D//g;
1045     $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1046       or return { 'error' => gettext('invalid_card') }; # . ": ". $self->payinfo
1047     $payinfo = $1;
1048
1049     validate($payinfo)
1050       or return { 'error' => gettext('invalid_card') }; # . ": ". $self->payinfo
1051     return { 'error' => gettext('unknown_card_type') }
1052       if $payinfo !~ /^99\d{14}$/ && cardtype($payinfo) eq "Unknown";
1053
1054     if ( length($p->{'paycvv'}) && $p->{'paycvv'} !~ /^\s*$/ ) {
1055       if ( cardtype($payinfo) eq 'American Express card' ) {
1056         $p->{'paycvv'} =~ /^\s*(\d{4})\s*$/
1057           or return { 'error' => "CVV2 (CID) for American Express cards is four digits." };
1058         $paycvv = $1;
1059       } else {
1060         $p->{'paycvv'} =~ /^\s*(\d{3})\s*$/
1061           or return { 'error' => "CVV2 (CVC2/CID) is three digits." };
1062         $paycvv = $1;
1063       }
1064     } elsif ( $conf->exists('selfservice-onfile_require_cvv') ) {
1065       return { 'error' => 'CVV2 is required' };
1066     } elsif ( !$onfile && $conf->exists('selfservice-require_cvv') ) {
1067       return { 'error' => 'CVV2 is required' };
1068     }
1069
1070   } else {
1071     die "unknown payby $payby";
1072   }
1073
1074   my %payby2fields = (
1075     'CARD' => [ qw( paystart_month paystart_year payissue payip
1076                     address1 address2 city state zip country    ) ],
1077     'CHEK' => [ qw( ss paytype paystate stateid stateid_state payip ) ],
1078   );
1079
1080   my $card_type = '';
1081   $card_type = cardtype($payinfo) if $payby eq 'CARD';
1082
1083   {
1084     'cust_main'      => $cust_main, #XXX or just custnum??
1085     'amount'         => sprintf('%.2f', $amount),
1086     'payby'          => $payby,
1087     'payinfo'        => $payinfo,
1088     'paymask'        => $cust_main->mask_payinfo( $payby, $payinfo ),
1089     'card_type'      => $card_type,
1090     'paydate'        => $p->{'year'}. '-'. $p->{'month'}. '-01',
1091     'paydate_pretty' => $p->{'month'}. ' / '. $p->{'year'},
1092     'month'          => $p->{'month'},
1093     'year'           => $p->{'year'},
1094     'payname'        => $payname,
1095     'payunique'      => $payunique,
1096     'paybatch'       => $paybatch,
1097     'paycvv'         => $paycvv,
1098     'payname'        => $payname,
1099     'discount_term'  => $discount_term,
1100     'pkgnum'         => $session->{'pkgnum'},
1101     map { $_ => $p->{$_} } ( @{ $payby2fields{$payby} },
1102                              qw( save auto ),
1103                            )
1104   };
1105
1106 }
1107
1108 sub store_payment {
1109   my $p = shift;
1110
1111   my $validate = validate_payment($p);
1112   return $validate if $validate->{'error'};
1113
1114   my $conf = new FS::Conf;
1115   my $timeout = $conf->config('selfservice-session_timeout') || '1 hour'; #?
1116   _cache->set( 'payment_'.$p->{'session_id'}, $validate, $timeout );
1117
1118   +{ map { $_=>$validate->{$_} }
1119       qw( card_type paymask payname paydate_pretty month year amount
1120           address1 address2 city state zip country
1121         )
1122   };
1123
1124 }
1125
1126 sub process_stored_payment {
1127   my $p = shift;
1128
1129   my $session_id = $p->{'session_id'};
1130
1131   my $payment_info = _cache->get( "payment_$session_id" )
1132     or return { 'error' => "Can't resume session" }; #better error message
1133
1134   do_process_payment($payment_info);
1135
1136 }
1137
1138 sub process_payment {
1139   my $p = shift;
1140
1141   my $payment_info = validate_payment($p);
1142   return $payment_info if $payment_info->{'error'};
1143
1144   do_process_payment($payment_info);
1145
1146 }
1147
1148 sub do_process_payment {
1149   my $validate = shift;
1150
1151   my $cust_main = $validate->{'cust_main'};
1152
1153   my $amount = delete $validate->{'amount'};
1154   my $paynum = '';
1155
1156   my $payby = delete $validate->{'payby'};
1157
1158   if ( $validate->{'save'} ) {
1159     my $new = new FS::cust_main { $cust_main->hash };
1160     if ($payby eq 'CARD' || $payby eq 'DCRD') {
1161       $new->set( $_ => $validate->{$_} )
1162         foreach qw( payname paystart_month paystart_year payissue payip );
1163       $new->set( 'payby' => $validate->{'auto'} ? 'CARD' : 'DCRD' );
1164
1165       my $bill_location = FS::cust_location->new({
1166           map { $_ => $validate->{$_} }
1167           qw(address1 address2 city state country zip)
1168       }); # county?
1169       $new->set('bill_location' => $bill_location);
1170       # but don't allow the service address to change this way.
1171
1172     } elsif ($payby eq 'CHEK' || $payby eq 'DCHK') {
1173       $new->set( $_ => $validate->{$_} )
1174         foreach qw( payname payip paytype paystate
1175                     stateid stateid_state );
1176       $new->set( 'payby' => $validate->{'auto'} ? 'CHEK' : 'DCHK' );
1177     }
1178     $new->payinfo( $validate->{'payinfo'} ); #to properly set paymask
1179     $new->set( 'paydate' => $validate->{'paydate'} );
1180     my $error = $new->replace($cust_main);
1181     if ( $error ) {
1182       #no, this causes customers to process their payments again
1183       #return { 'error' => $error };
1184       #XXX just warn verosely for now so i can figure out how these happen in
1185       # the first place, eventually should redirect them to the "change
1186       #address" page but indicate if the payment processed?
1187       delete($validate->{'payinfo'}); #don't want to log this!
1188       warn "WARNING: error changing customer info when processing payment (not returning to customer as a processing error): $error\n".
1189            "NEW: ". Dumper($new)."\n".
1190            "OLD: ". Dumper($cust_main)."\n".
1191            "PACKET: ". Dumper($validate)."\n";
1192     } else {
1193       $cust_main = $new;
1194     }
1195   }
1196
1197   my $error = $cust_main->realtime_bop( $FS::payby::payby2bop{$payby}, $amount,
1198     'quiet'       => 1,
1199     'manual'      => 1,
1200     'selfservice' => 1,
1201     'paynum_ref'  => \$paynum,
1202     %$validate,
1203   );
1204   return { 'error' => $error } if $error;
1205
1206   #no error, so order the fee package if applicable...
1207   my $conf = new FS::Conf;
1208   my $fee_pkgpart = $conf->config('selfservice_process-pkgpart', $cust_main->agentnum);
1209   my $fee_skip_first = $conf->exists('selfservice_process-skip_first');
1210
1211   if ( $fee_pkgpart and ! $fee_skip_first || scalar($cust_main->cust_pay) ) {
1212
1213     my $cust_pkg = new FS::cust_pkg { 'pkgpart' => $fee_pkgpart };
1214
1215     $error = $cust_main->order_pkg( 'cust_pkg' => $cust_pkg );
1216     return { 'error' => "payment processed successfully, but error ordering fee: $error" }
1217       if $error;
1218
1219     #and generate an invoice for it now too
1220     $error = $cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1221     return { 'error' => "payment processed and fee ordered successfully, but error billing fee: $error" }
1222       if $error;
1223
1224   }
1225
1226   $cust_main->apply_payments;
1227
1228   my $cust_pay = '';
1229   my $receipt_html = '';
1230   if ($paynum) {
1231       # currently supported for realtime CC only; send receipt data to SS
1232       $cust_pay = qsearchs('cust_pay', { 'paynum' => $paynum } );
1233       if($cust_pay) {
1234         $receipt_html = qq!
1235 <TABLE BGCOLOR="#cccccc" BORDER=0 CELLSPACING=2>
1236
1237 <TR>
1238   <TD ALIGN="right">Payment#</TD>
1239   <TD BGCOLOR="#FFFFFF"><B>! . $cust_pay->paynum . qq!</B></TD>
1240 </TR>
1241
1242 <TR>
1243   <TD ALIGN="right">Date</TD>
1244
1245   <TD BGCOLOR="#FFFFFF"><B>! .
1246         time2str("%a&nbsp;%b&nbsp;%o,&nbsp;%Y&nbsp;%r", $cust_pay->_date)
1247                                                             . qq!</B></TD>
1248 </TR>
1249
1250
1251 <TR>
1252   <TD ALIGN="right">Amount</TD>
1253   <TD BGCOLOR="#FFFFFF"><B>! . sprintf('%.2f', $cust_pay->paid) . qq!</B></TD>
1254
1255 </TR>
1256
1257 <TR>
1258   <TD ALIGN="right">Payment method</TD>
1259   <TD BGCOLOR="#FFFFFF"><B>! . $cust_pay->payby_name .' #'. $cust_pay->paymask
1260                                                                 . qq!</B></TD>
1261 </TR>
1262
1263 </TABLE>
1264 !;
1265       }
1266   }
1267
1268   if ( $cust_pay ) {
1269
1270     return {
1271       'error'        => '',
1272       'amount'       => sprintf('%.2f', $cust_pay->paid),
1273       'date'         => $cust_pay->_date,
1274       'date_pretty'  => time2str('%Y-%m-%d', $cust_pay->_date),
1275       'time_pretty'  => time2str('%T', $cust_pay->_date),
1276       'auth_num'     => $cust_pay->auth,
1277       'order_num'    => $cust_pay->order_number,
1278       'receipt_html' => $receipt_html,
1279     };
1280
1281   } else {
1282
1283     return {
1284       'error'        => '',
1285       'receipt_html' => '',
1286     };
1287
1288   }
1289
1290 }
1291
1292 sub realtime_collect {
1293   my $p = shift;
1294
1295   my $session = _cache->get($p->{'session_id'})
1296     or return { 'error' => "Can't resume session" }; #better error message
1297
1298   my $custnum = $session->{'custnum'};
1299
1300   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1301     or return { 'error' => "unknown custnum $custnum" };
1302
1303   my $amount;
1304   if ( $p->{'amount'} ) {
1305     $amount = $p->{'amount'};
1306   }
1307   elsif ( $session->{'pkgnum'} ) {
1308     $amount = $cust_main->balance_pkgnum( $session->{'pkgnum'} );
1309   }
1310   else {
1311     $amount = $cust_main->balance;
1312   }
1313
1314   my $error = $cust_main->realtime_collect(
1315     'method'     => $p->{'method'},
1316     'amount'     => $amount,
1317     'pkgnum'     => $session->{'pkgnum'},
1318     'session_id' => $p->{'session_id'},
1319     'apply'      => 1,
1320     'selfservice'=> 1,
1321   );
1322   return { 'error' => $error } unless ref( $error );
1323
1324   return { 'error' => '', amount => $amount, %$error };
1325 }
1326
1327 sub start_thirdparty {
1328   my $p = shift;
1329   my $session = _cache->get($p->{'session_id'})
1330     or return { 'error' => "Can't resume session" }; #better error message
1331   my $custnum = $session->{'custnum'};
1332   my $cust_main = FS::cust_main->by_key($custnum);
1333
1334   my $amount = $p->{'amount'}
1335     or return { error => 'no amount' };
1336
1337   my $result = $cust_main->create_payment(
1338     'method'      => $p->{'method'},
1339     'amount'      => $p->{'amount'},
1340     'pkgnum'      => $session->{'pkgnum'},
1341     'session_id'  => $p->{'session_id'},
1342   );
1343
1344   if ( ref($result) ) { # hashref or error
1345     return $result;
1346   } else {
1347     return { error => $result };
1348   }
1349 }
1350
1351 sub finish_thirdparty {
1352   my $p = shift;
1353   my $session_id = delete $p->{'session_id'};
1354   my $session = _cache->get($session_id)
1355     or return { 'error' => "Can't resume session" };
1356   my $custnum = $session->{'custnum'};
1357   my $cust_main = FS::cust_main->by_key($custnum);
1358
1359   if ( $p->{_cancel} ) {
1360     # customer backed out of making a payment
1361     return $cust_main->cancel_payment( $session_id );
1362   }
1363   my $result = $cust_main->execute_payment( $session_id, %$p );
1364   if ( ref($result) ) {
1365     return $result;
1366   } else {
1367     return { error => $result };
1368   }
1369 }
1370
1371 sub process_payment_order_pkg {
1372   my $p = shift;
1373
1374   my $hr = process_payment($p);
1375   return $hr if $hr->{'error'};
1376
1377   order_pkg($p);
1378 }
1379
1380 sub process_payment_order_renew {
1381   my $p = shift;
1382
1383   my $hr = process_payment($p);
1384   return $hr if $hr->{'error'};
1385
1386   order_renew($p);
1387 }
1388
1389 sub process_prepay {
1390
1391   my $p = shift;
1392
1393   my $session = _cache->get($p->{'session_id'})
1394     or return { 'error' => "Can't resume session" }; #better error message
1395
1396   my %return;
1397
1398   my $custnum = $session->{'custnum'};
1399
1400   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1401     or return { 'error' => "unknown custnum $custnum" };
1402
1403   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = ( 0, 0, 0, 0, 0 );
1404   my $error = $cust_main->recharge_prepay( $p->{'prepaid_cardnum'},
1405                                            \$amount,
1406                                            \$seconds,
1407                                            \$upbytes,
1408                                            \$downbytes,
1409                                            \$totalbytes,
1410                                          );
1411
1412   return { 'error' => $error } if $error;
1413
1414   return { 'error'     => '',
1415            'amount'    => $amount,
1416            'seconds'   => $seconds,
1417            'duration'  => duration_exact($seconds),
1418            'upbytes'   => $upbytes,
1419            'upload'    => FS::UI::bytecount::bytecount_unexact($upbytes),
1420            'downbytes' => $downbytes,
1421            'download'  => FS::UI::bytecount::bytecount_unexact($downbytes),
1422            'totalbytes'=> $totalbytes,
1423            'totalload' => FS::UI::bytecount::bytecount_unexact($totalbytes),
1424          };
1425
1426 }
1427
1428 sub invoice {
1429   my $p = shift;
1430   my $session = _cache->get($p->{'session_id'})
1431     or return { 'error' => "Can't resume session" }; #better error message
1432
1433   my $custnum = $session->{'custnum'};
1434
1435   my $invnum = $p->{'invnum'};
1436
1437   my $cust_bill = qsearchs('cust_bill', { 'invnum'  => $invnum,
1438                                           'custnum' => $custnum } )
1439     or return { 'error' => "Can't find invnum" };
1440
1441   #my %return;
1442
1443   return { 'error'        => '',
1444            'invnum'       => $invnum,
1445            'invoice_text' => join('', $cust_bill->print_text ),
1446            'invoice_html' => $cust_bill->print_html( { unsquelch_cdr => 1 } ),
1447          };
1448
1449 }
1450
1451 sub invoice_pdf {
1452   my $p = shift;
1453   my $session = _cache->get($p->{'session_id'})
1454     or return { 'error' => "Can't resume session" }; #better error message
1455
1456   my $custnum = $session->{'custnum'};
1457
1458   my $invnum = $p->{'invnum'};
1459
1460   my $cust_bill = qsearchs('cust_bill', { 'invnum'  => $invnum,
1461                                           'custnum' => $custnum } )
1462     or return { 'error' => "Can't find invnum" };
1463
1464   #my %return;
1465
1466   return { 'error'       => '',
1467            'invnum'      => $invnum,
1468            'invoice_pdf' => $cust_bill->print_pdf({
1469                               'unsquelch_cdr' => 1,
1470                               'locale'        => $p->{'locale'},
1471                             }),
1472          };
1473
1474 }
1475
1476 sub legacy_invoice {
1477   my $p = shift;
1478   my $session = _cache->get($p->{'session_id'})
1479     or return { 'error' => "Can't resume session" }; #better error message
1480
1481   my $custnum = $session->{'custnum'};
1482
1483   my $legacyinvnum = $p->{'legacyinvnum'};
1484
1485   my %hash = (
1486     'legacyinvnum' => $legacyinvnum,
1487     'custnum'      => $custnum,
1488   );
1489
1490   my $legacy_cust_bill =
1491          qsearchs('legacy_cust_bill', { %hash, 'locale' => $p->{'locale'} } )
1492       || qsearchs('legacy_cust_bill', \%hash )
1493     or return { 'error' => "Can't find legacyinvnum" };
1494
1495   #my %return;
1496
1497   return { 'error'        => '',
1498            'legacyinvnum' => $legacyinvnum,
1499            'legacyid'     => $legacy_cust_bill->legacyid,
1500            'invoice_html' => $legacy_cust_bill->content_html,
1501          };
1502
1503 }
1504
1505 sub legacy_invoice_pdf {
1506   my $p = shift;
1507   my $session = _cache->get($p->{'session_id'})
1508     or return { 'error' => "Can't resume session" }; #better error message
1509
1510   my $custnum = $session->{'custnum'};
1511
1512   my $legacyinvnum = $p->{'legacyinvnum'};
1513
1514   my $legacy_cust_bill = qsearchs('legacy_cust_bill', {
1515     'legacyinvnum' => $legacyinvnum,
1516     'custnum'      => $custnum,
1517   }) or return { 'error' => "Can't find legacyinvnum" };
1518
1519   #my %return;
1520
1521   return { 'error'        => '',
1522            'legacyinvnum' => $legacyinvnum,
1523            'legacyid'     => $legacy_cust_bill->legacyid,
1524            'invoice_pdf'  => $legacy_cust_bill->content_pdf,
1525          };
1526
1527 }
1528
1529 sub invoice_logo {
1530   my $p = shift;
1531
1532   #sessioning for this?  how do we get the session id to the backend invoice
1533   # template so it can add it to the link, blah
1534
1535   my $agentnum = '';
1536   if ( $p->{'invnum'} ) {
1537     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $p->{'invnum'} } )
1538       or return { 'error' => 'unknown invnum' };
1539     $agentnum = $cust_bill->cust_main->agentnum;
1540   }
1541
1542   my $templatename = $p->{'template'} || $p->{'templatename'};
1543
1544   #false laziness-ish w/view/cust_bill-logo.cgi
1545
1546   my $conf = new FS::Conf;
1547   if ( $templatename =~ /^([^\.\/]*)$/ && $conf->exists("logo_$1.png") ) {
1548     $templatename = "_$1";
1549   } else {
1550     $templatename = '';
1551   }
1552
1553   my $filename = "logo$templatename.png";
1554
1555   return { 'error'        => '',
1556            'logo'         => $conf->config_binary($filename, $agentnum),
1557            'content_type' => 'image/png', #should allow gif, jpg too
1558          };
1559 }
1560
1561
1562 sub list_invoices {
1563   my $p = shift;
1564   my $session = _cache->get($p->{'session_id'})
1565     or return { 'error' => "Can't resume session" }; #better error message
1566
1567   my $custnum = $session->{'custnum'};
1568
1569   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1570     or return { 'error' => "unknown custnum $custnum" };
1571
1572   my $conf = new FS::Conf;
1573
1574   my @legacy_cust_bill = $cust_main->legacy_cust_bill;
1575
1576   my @cust_bill = grep ! $_->hide, $cust_main->cust_bill;
1577
1578   my $balance = 0;
1579   my $invoices = [
1580     map {
1581       #not super efficient, we also run cust_bill_pay/cust_credited inside owed
1582       my @payments_and_credits = sort {$b->_date <=> $a->_date} ($_->cust_bill_pay,$_->cust_credited);
1583       my $owed = $_->owed;
1584       $balance += $owed;
1585       +{ 'invnum'       => $_->invnum,
1586          '_date'        => $_->_date,
1587          'date'         => time2str("%b %o, %Y", $_->_date),
1588          'date_short'   => time2str("%m-%d-%Y",  $_->_date),
1589          'previous'     => sprintf('%.2f', ($_->previous)[0]),
1590          'charged'      => sprintf('%.2f', $_->charged),
1591          'owed'         => sprintf('%.2f', $owed),
1592          'balance'      => sprintf('%.2f', $balance),
1593          'lastpay'      => @payments_and_credits
1594                            ? time2str("%b %o, %Y", $payments_and_credits[0]->_date)
1595                            : '',
1596       }
1597     } @cust_bill
1598   ];
1599
1600   return  { 'error'       => '',
1601             'balance'     => $cust_main->balance,
1602             'money_char'  => $conf->config("money_char") || '$',
1603             'invoices'    => $invoices,
1604             'legacy_invoices' => [
1605               map {
1606                     +{ 'legacyinvnum' => $_->legacyinvnum,
1607                        'legacyid'     => $_->legacyid,
1608                        '_date'        => $_->_date,
1609                        'date'         => time2str("%b %o, %Y", $_->_date),
1610                        'date_short'   => time2str("%m-%d-%Y",  $_->_date),
1611                        'charged'      => sprintf('%.2f', $_->charged),
1612                        'has_content'  => (    length($_->content_pdf)
1613                                            || length($_->content_html) ),
1614                      }
1615                   }
1616                   @legacy_cust_bill
1617             ],
1618           };
1619 }
1620
1621 sub list_payments {
1622   my $p = shift;
1623   my $session = _cache->get($p->{'session_id'})
1624     or return { 'error' => "Can't resume session" }; #better error message
1625
1626   my $custnum = $session->{'custnum'};
1627
1628   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1629     or return { 'error' => "unknown custnum $custnum" };
1630
1631   return  { 'error'       => '',
1632             'balance'     => $cust_main->balance,
1633             'money_char'  => FS::Conf->new->config("money_char") || '$',
1634             'payments'    => [ map $_->SSAPI_getinfo, $cust_main->cust_pay ],
1635           };
1636 }
1637
1638 sub payment_receipt {
1639   my $p = shift;
1640   my $session = _cache->get($p->{'session_id'})
1641     or return { 'error' => "Can't resume session" }; #better error message
1642
1643   my $custnum = $session->{'custnum'};
1644
1645   my $cust_pay = qsearchs('cust_pay', { 'custnum' => $custnum,
1646                                         'paynum'  => $p->{'paynum'},
1647                                       }
1648                          )
1649     or return { 'error' => "unknown payment ". $p->{'paynum'} };
1650
1651   return {
1652            'error' => '',
1653            %{ $cust_pay->SSAPI_getinfo },
1654          };
1655 }
1656
1657 sub cancel {
1658   my $p = shift;
1659   my $session = _cache->get($p->{'session_id'})
1660     or return { 'error' => "Can't resume session" }; #better error message
1661
1662   my $custnum = $session->{'custnum'};
1663
1664   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1665     or return { 'error' => "unknown custnum $custnum" };
1666
1667   my @errors = $cust_main->cancel( 'quiet'=>1 );
1668
1669   my $error = scalar(@errors) ? join(' / ', @errors) : '';
1670
1671   return { 'error' => $error };
1672
1673 }
1674
1675 sub pkg_info {
1676   my $p = shift;
1677
1678   my($context, $session, $custnum) = _custoragent_session_custnum($p);
1679   return { 'error' => $session } if $context eq 'error';
1680
1681   my $pkg = qsearchs({
1682     'table'     => 'cust_pkg',
1683     'addl_from' => 'LEFT JOIN part_pkg USING ( pkgpart )',
1684     'hashref'   => {
1685                       'custnum' => $custnum,
1686                       'pkgnum'  => $p->{'pkgnum'},
1687                    },
1688   })
1689     or return {'error' => 'unknown pkg num $pkgnum'};
1690
1691   return {
1692         pkg_label => $pkg->pkg,
1693         pkgpart   => $pkg->pkgpart,
1694         classnum  => $pkg->classnum,
1695   };
1696
1697 }
1698
1699 sub list_pkgs {
1700   my $p = shift;
1701
1702   my($context, $session, $custnum) = _custoragent_session_custnum($p);
1703   return { 'error' => $session } if $context eq 'error';
1704
1705   my $search = { 'custnum' => $custnum };
1706   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
1707   my $cust_main = qsearchs('cust_main', $search )
1708     or return { 'error' => "unknown custnum $custnum" };
1709
1710   my $conf = new FS::Conf;
1711   my $immutable = $conf->exists('selfservice_immutable-package');
1712
1713 # the duplication below is necessary:
1714 # 1. to maintain the current buggy behaviour wrt the cust_pkg and part_pkg
1715 # hashes overwriting each other (setup and no_auto fields). Fixing that is a
1716 # non-backwards-compatible change breaking the software of anyone using the API
1717 # instead of the stock selfservice
1718 # 2. to return cancelled packages as well - for wholesale and non-wholesale
1719   if( $conf->exists('selfservice_server-view-wholesale') ) {
1720     return { 'svcnum'   => $session->{'svcnum'},
1721             'custnum'  => $custnum,
1722             'cust_pkg' => [ map {
1723                           { $_->hash,
1724                             immutable => $immutable,
1725                             part_pkg => [ map $_->hashref, $_->part_pkg ],
1726                             part_svc =>
1727                               [ map $_->hashref, $_->available_part_svc ],
1728                             cust_svc =>
1729                               [ map { my $ref = { $_->hash,
1730                                                   label => [ $_->label ],
1731                                                 };
1732                                       $ref->{_password} = $_->svc_x->_password
1733                                         if $context eq 'agent'
1734                                         && $conf->exists('agent-showpasswords')
1735                                         && $_->part_svc->svcdb eq 'svc_acct';
1736                                       $ref;
1737                                     } $_->cust_svc
1738                               ],
1739                           };
1740                         } $cust_main->cust_pkg
1741                   ],
1742     'small_custview' =>
1743       small_custview( $cust_main, $conf->config('countrydefault') ),
1744     'wholesale_view' => 1,
1745     'login_svcpart' => [ $conf->config('selfservice_server-login_svcpart') ],
1746     'date_format' => $conf->config('date_format') || '%m/%d/%Y',
1747     'lnp' => $conf->exists('svc_phone-lnp'),
1748       };
1749   }
1750
1751   { 'svcnum'   => $session->{'svcnum'},
1752     'custnum'  => $custnum,
1753     'cust_pkg' => [ map {
1754                           my $primary_cust_svc = $_->primary_cust_svc;
1755                           +{ $_->hash,
1756                             $_->part_pkg->hash,
1757                             immutable   => $immutable,
1758                             pkg_label   => $_->pkg_locale,
1759                             status      => $_->status,
1760                             statuscolor => $_->statuscolor,
1761                             part_svc =>
1762                               [ map { $_->hashref }
1763                                   grep { $_->selfservice_access ne 'hidden' }
1764                                     $_->available_part_svc
1765                               ],
1766                             cust_svc =>
1767                               [ map { my $ref = { $_->hash,
1768                                                   label => [ $_->label ],
1769                                                 };
1770                                       $ref->{_password} = $_->svc_x->_password
1771                                         if $context eq 'agent'
1772                                         && $conf->exists('agent-showpasswords')
1773                                         && $_->part_svc->svcdb eq 'svc_acct';
1774                                       $ref->{svchash} = { $_->svc_x->hash } if
1775                                         $_->part_svc->svcdb eq 'svc_phone';
1776                                       $ref->{svchash}->{svcpart} =  $_->part_svc->svcpart
1777                                         if $_->part_svc->svcdb eq 'svc_phone'; # hack
1778                                       $ref;
1779                                     }
1780                                   grep { $_->part_svc->selfservice_access ne 'hidden' }
1781                                     $_->cust_svc
1782                               ],
1783                             primary_cust_svc =>
1784                               $primary_cust_svc
1785                                 ? { $primary_cust_svc->hash,
1786                                     label => [ $primary_cust_svc->label ],
1787                                     finger => $primary_cust_svc->svc_x->finger, #uuh
1788                                     $primary_cust_svc->part_svc->hash,
1789                                   }
1790                                 : {}, #'' ?
1791                           };
1792                         } $cust_main->ncancelled_pkgs
1793                   ],
1794     'small_custview' =>
1795       small_custview( $cust_main, $conf->config('countrydefault') ),
1796     'date_format' => $conf->config('date_format') || '%m/%d/%Y',
1797   };
1798
1799 }
1800
1801 sub list_svcs {
1802   my $p = shift;
1803
1804   my($context, $session, $custnum) = _custoragent_session_custnum($p);
1805   return { 'error' => $session } if $context eq 'error';
1806
1807   my $conf = new FS::Conf;
1808
1809   my $hide_usage = $conf->exists('selfservice_hide-usage') ? 1 : 0;
1810   my $search = { 'custnum' => $custnum };
1811   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
1812   my $cust_main = qsearchs('cust_main', $search )
1813     or return { 'error' => "unknown custnum $custnum" };
1814
1815   my $pkgnum = $session->{'pkgnum'} || $p->{'pkgnum'} || '';
1816   if ( ! $pkgnum && $p->{'svcnum'} ) {
1817     my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $p->{'svcnum'} } );
1818     $pkgnum = $cust_svc->pkgnum if $cust_svc;
1819   }
1820
1821   my @cust_svc = ();
1822   my @cust_pkg_usage = ();
1823   foreach my $cust_pkg ( $p->{'ncancelled'}
1824                          ? $cust_main->ncancelled_pkgs
1825                          : $cust_main->unsuspended_pkgs ) {
1826     next if $pkgnum && $cust_pkg->pkgnum != $pkgnum;
1827     push @cust_svc, @{[ $cust_pkg->cust_svc ]}; #@{[ ]} to force array context
1828     push @cust_pkg_usage, $cust_pkg->cust_pkg_usage;
1829   }
1830
1831   @cust_svc = grep { $_->part_svc->selfservice_access ne 'hidden' } @cust_svc;
1832   my %usage_pools;
1833   if (!$hide_usage) {
1834     foreach (@cust_pkg_usage) {
1835       my $part = $_->part_pkg_usage;
1836       my $tag = $part->description . ($part->shared ? 1 : 0);
1837       my $row = $usage_pools{$tag}
1838             ||= [ $part->description, 0, 0, $part->shared ? 1 : 0 ];
1839       $row->[1] += sprintf('%.1f', $_->minutes); # minutes remaining
1840       $row->[2] += $part->minutes; # minutes total
1841     }
1842   } # otherwise just leave them empty
1843
1844   if ( $p->{'svcdb'} ) {
1845     my $svcdb = ref($p->{'svcdb'}) eq 'HASH'
1846                   ? $p->{'svcdb'}
1847                   : ref($p->{'svcdb'}) eq 'ARRAY'
1848                     ? { map { $_=>1 } @{ $p->{'svcdb'} } }
1849                     : { $p->{'svcdb'} => 1 };
1850     @cust_svc = grep $svcdb->{ $_->part_svc->svcdb }, @cust_svc
1851   }
1852
1853   #@svc_x = sort { $a->domain cmp $b->domain || $a->username cmp $b->username }
1854   #              @svc_x;
1855
1856   my @svcs; # stuff to return to the client
1857   my %bytes_used_total; # for _used columns only
1858   foreach my $cust_svc (@cust_svc) {
1859     my $svc_x = $cust_svc->svc_x;
1860     my($label, $value) = $cust_svc->label;
1861     my $part_svc = $cust_svc->part_svc;
1862     my $svcdb = $part_svc->svcdb;
1863     my $cust_pkg = $cust_svc->cust_pkg;
1864     my $part_pkg = $cust_pkg->part_pkg;
1865
1866     my %hash = (
1867       'svcnum'         => $cust_svc->svcnum,
1868       'display_svcnum' => $cust_svc->display_svcnum,
1869       'svcdb'          => $svcdb,
1870       'label'          => $label,
1871       'value'          => $value,
1872       'pkg_label'      => $cust_pkg->pkg_locale,
1873       'pkg_status'     => $cust_pkg->status,
1874       'readonly'       => ($part_svc->selfservice_access eq 'readonly'),
1875     );
1876
1877     # would it make sense to put this in a svc_* method?
1878
1879     if (!$hide_usage and grep(/^$svcdb$/, qw(svc_acct svc_broadband)) and $part_svc->part_export_usage) {
1880       my $last_bill = $cust_pkg->last_bill || 0;
1881       my $now = time;
1882       my $up_used = $cust_svc->attribute_since_sqlradacct($last_bill,$now,'AcctInputOctets');
1883       my $down_used = $cust_svc->attribute_since_sqlradacct($last_bill,$now,'AcctOutputOctets');
1884       %hash = (
1885         %hash,
1886         'seconds_used'    => $cust_svc->seconds_since_sqlradacct($last_bill,$now),
1887         'upbytes_used'    => display_bytecount($up_used),
1888         'downbytes_used'  => display_bytecount($down_used),
1889         'totalbytes_used' => display_bytecount($up_used + $down_used)
1890       );
1891       $bytes_used_total{'seconds_used'} += $hash{'seconds_used'};
1892       $bytes_used_total{'upbytes_used'} += $up_used;
1893       $bytes_used_total{'downbytes_used'} += $down_used;
1894       $bytes_used_total{'totalbytes_used'} += $up_used + $down_used;
1895     }
1896
1897     if ( $svcdb eq 'svc_acct' ) {
1898       foreach (qw(username email finger seconds)) {
1899         $hash{$_} = $svc_x->$_;
1900       }
1901
1902       if (!$hide_usage) {
1903         %hash = (
1904           %hash,
1905           'upbytes'    => display_bytecount($svc_x->upbytes),
1906           'downbytes'  => display_bytecount($svc_x->downbytes),
1907           'totalbytes' => display_bytecount($svc_x->totalbytes),
1908
1909           'recharge_amount'  => $part_pkg->option('recharge_amount',1),
1910           'recharge_seconds' => $part_pkg->option('recharge_seconds',1),
1911           'recharge_upbytes'    =>
1912             display_bytecount($part_pkg->option('recharge_upbytes',1)),
1913           'recharge_downbytes'  =>
1914             display_bytecount($part_pkg->option('recharge_downbytes',1)),
1915           'recharge_totalbytes' =>
1916             display_bytecount($part_pkg->option('recharge_totalbytes',1)),
1917           # more...
1918         );
1919       }
1920
1921     } elsif ( $svcdb eq 'svc_dsl' ) {
1922
1923       $hash{'phonenum'} = $svc_x->phonenum;
1924       if ( $svc_x->first || $svc_x->get('last') || $svc_x->company ) {
1925         $hash{'name'} = $svc_x->first. ' '. $svc_x->get('last');
1926         $hash{'name'} = $svc_x->company. ' ('. $hash{'name'}. ')'
1927           if $svc_x->company;
1928       } else {
1929         $hash{'name'} = $cust_main->name;
1930       }
1931       # no usage to hide here
1932
1933     } elsif ( $svcdb eq 'svc_phone' or $svcdb eq 'svc_pbx' ) {
1934       if (!$hide_usage) {
1935         # could potentially show lots of things...
1936         $hash{'outbound'} = 1;
1937         $hash{'inbound'}  = 0;
1938         if ( $svcdb eq 'svc_phone' ) {
1939           if ( $part_pkg->plan eq 'voip_inbound' ) {
1940             $hash{'outbound'} = 0;
1941             $hash{'inbound'}  = 1;
1942           } elsif ( $part_pkg->option('selfservice_inbound_format')
1943                 or  $conf->config('selfservice-default_inbound_cdr_format')
1944           ) {
1945             $hash{'inbound'}  = 1;
1946           }
1947         }
1948         foreach (qw(inbound outbound)) {
1949           # hmm...we can't filter by status here, because there might
1950           # not be cdr_terminations at all.  have to go by date.
1951           # find all since the last bill date.
1952           # XXX cdr types?  we are going to need them.
1953           if ( $hash{$_} ) {
1954             my $sum_cdr = $svc_x->sum_cdrs(
1955               'inbound' => ( $_ eq 'inbound' ? 1 : 0 ),
1956               'begin'   => ($cust_pkg->last_bill || 0),
1957               'nonzero' => 1,
1958               'disable_charged_party' => 1,
1959             );
1960             $hash{$_} = $sum_cdr->hashref;
1961           }
1962         }
1963       } # not hiding usage
1964     } # svcdb
1965
1966     push @svcs, \%hash;
1967   } # foreach $cust_svc
1968
1969   foreach my $field (keys %bytes_used_total) {
1970     if ($field =~ /bytes/) {
1971       $bytes_used_total{$field} = display_bytecount($bytes_used_total{$field});
1972     }
1973   }
1974
1975   return {
1976     'svcnum'   => $session->{'svcnum'},
1977     'custnum'  => $custnum,
1978     'date_format' => $conf->config('date_format') || '%m/%d/%Y',
1979     'view_usage_nodomain' => $conf->exists('selfservice-view_usage_nodomain'),
1980     'svcs'     => \@svcs,
1981     'bytes_used_total' => \%bytes_used_total,
1982     'usage_pools' => [
1983       map { $usage_pools{$_} }
1984       sort { $a cmp $b }
1985       keys %usage_pools
1986     ],
1987     'hide_usage' => $hide_usage,
1988   };
1989
1990 }
1991
1992 sub _customer_svc_x {
1993   my($custnum, $svcnum, $table) = (shift, shift, shift);
1994   my $hashref = ref($svcnum) ? $svcnum : { 'svcnum' => $svcnum };
1995
1996   $custnum =~ /^(\d+)$/ or die "illegal custnum";
1997   my $search = " AND custnum = $1";
1998   #$search .= " AND agentnum = ". $session->{'agentnum'} if $context eq 'agent';
1999
2000   qsearchs( {
2001     'table'     => ($table || 'svc_acct'),
2002     'addl_from' => 'LEFT JOIN cust_svc  USING ( svcnum  ) '.
2003                    'LEFT JOIN cust_pkg  USING ( pkgnum  ) ',#.
2004                    #'LEFT JOIN cust_main USING ( custnum ) ',
2005     'hashref'   => $hashref,
2006     'extra_sql' => $search, #important
2007   } );
2008
2009 }
2010
2011 sub svc_status_html {
2012   my $p = shift;
2013
2014   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2015   return { 'error' => $session } if $context eq 'error';
2016
2017   #XXX only svc_dsl for now
2018   my $svc_x = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_dsl')
2019     or return { 'error' => "Service not found" };
2020
2021   my $html = $svc_x->getstatus_html;
2022
2023   return { 'html' => $html };
2024
2025 }
2026
2027 sub svc_status_hash {
2028   my $p = shift;
2029
2030   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2031   return { 'error' => $session } if $context eq 'error';
2032
2033   #XXX only svc_acct for now
2034   my $svc_x = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_acct')
2035     or return { 'error' => "Service not found" };
2036
2037   my ( $html, $hashref ) = $svc_x->export_getstatus;
2038   return $hashref;
2039
2040 }
2041
2042 sub set_svc_status_hash    { _svc_method_X(shift, 'export_setstatus') }
2043 sub set_svc_status_listadd { _svc_method_X(shift, 'export_setstatus_listadd') }
2044 sub set_svc_status_listdel { _svc_method_X(shift, 'export_setstatus_listdel') }
2045 sub set_svc_status_vacationadd { _svc_method_X(shift, 'export_setstatus_vacationadd') }
2046 sub set_svc_status_vacationdel { _svc_method_X(shift, 'export_setstatus_vacationdel') }
2047
2048 sub _svc_method_X {
2049   my( $p, $method ) = @_;
2050
2051   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2052   return { 'error' => $session } if $context eq 'error';
2053
2054   #XXX only svc_acct for now
2055   my $svc_x = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_acct')
2056     or return { 'error' => "Service not found" };
2057
2058   warn "$method ". join(' / ', map "$_=>".$p->{$_}, keys %$p )
2059     if $DEBUG;
2060   my $error = $svc_x->$method($p); #$p? returns error?
2061   return { 'error' => $error } if $error;
2062
2063   return {}; #? { 'error' => '' }
2064
2065 }
2066
2067 sub acct_forward_info {
2068   my $p = shift;
2069
2070   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2071   return { 'error' => $session } if $context eq 'error';
2072
2073   my $svc_forward = _customer_svc_x( $custnum,
2074                                      { 'srcsvc' => $p->{'svcnum'} },
2075                                      'svc_forward',
2076                                    )
2077     or return { 'error' => '',
2078                 'dst'   => '',
2079               };
2080
2081   return { 'error' => '',
2082            'dst'   => $svc_forward->dst || $svc_forward->dstsvc_acct->email,
2083          };
2084
2085 }
2086
2087 sub process_acct_forward {
2088   my $p = shift;
2089   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2090   return { 'error' => $session } if $context eq 'error';
2091
2092   my $old = _customer_svc_x( $custnum,
2093                              { 'srcsvc' => $p->{'svcnum'} },
2094                              'svc_forward',
2095                            );
2096
2097   if ( $p->{'dst'} eq '' ) {
2098     if ( $old ) {
2099       my $error = $old->delete;
2100       return { 'error' => $error };
2101     }
2102     return { 'error' => '' };
2103   }
2104
2105   my $new = new FS::svc_forward { 'srcsvc' => $p->{'svcnum'},
2106                                   'dst'    => $p->{'dst'},
2107                                 };
2108
2109   my $error;
2110   if ( $old ) {
2111     $new->svcnum($old->svcnum);
2112     my $cust_svc = $old->cust_svc;
2113     $new->svcpart($old->svcpart);
2114     $new->pkgnuym($old->pkgnum);
2115     $error = $new->replace($old);
2116   } else {
2117     my $conf = new FS::Conf;
2118     $new->svcpart($conf->config('selfservice-svc_forward_svcpart'));
2119
2120     my $svc_acct = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_acct' )
2121       or return { 'error' => 'No service' }; #how would we even get here?
2122
2123     $new->pkgnum( $svc_acct->cust_svc->pkgnum );
2124
2125     $error = $new->insert;
2126   }
2127
2128   return { 'error' => $error };
2129
2130 }
2131
2132 sub list_dsl_devices {
2133   my $p = shift;
2134
2135   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2136   return { 'error' => $session } if $context eq 'error';
2137
2138   my $svc_dsl = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_dsl' )
2139     or return { 'error' => "Service not found" };
2140
2141   return {
2142     'devices' => [ map {
2143                          +{ 'mac_addr' => $_->mac_addr };
2144                        } $svc_dsl->dsl_device
2145                  ],
2146   };
2147
2148 }
2149
2150 sub add_dsl_device {
2151   my $p = shift;
2152
2153   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2154   return { 'error' => $session } if $context eq 'error';
2155
2156   my $svc_dsl = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_dsl' )
2157     or return { 'error' => "Service not found" };
2158
2159   return { 'error' => 'No MAC address supplied' }
2160     unless length($p->{'mac_addr'});
2161
2162   my $dsl_device = new FS::dsl_device { 'svcnum'   => $svc_dsl->svcnum,
2163                                         'mac_addr' => scalar($p->{'mac_addr'}),
2164                                       };
2165   my $error = $dsl_device->insert;
2166   return { 'error' => $error };
2167
2168 }
2169
2170 sub delete_dsl_device {
2171   my $p = shift;
2172
2173   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2174   return { 'error' => $session } if $context eq 'error';
2175
2176   my $svc_dsl = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_dsl' )
2177     or return { 'error' => "Service not found" };
2178
2179   my $dsl_device = qsearchs('dsl_device', { 'svcnum'   => $svc_dsl->svcnum,
2180                                             'mac_addr' => scalar($p->{'mac_addr'}),
2181                                           }
2182                            )
2183     or return { 'error' => 'Unknown MAC address: '. $p->{'mac_addr'} };
2184
2185   my $error = $dsl_device->delete;
2186   return { 'error' => $error };
2187
2188 }
2189
2190 sub port_graph {
2191   my $p = shift;
2192   _usage_details( \&_port_graph, $p,
2193                   'svcdb' => 'svc_port',
2194                 );
2195 }
2196
2197 sub _port_graph {
2198   my($svc_port, $begin, $end) = @_;
2199   my @usage = ();
2200   my $pngOrError = $svc_port->graph_png( start=>$begin, end=> $end );
2201   push @usage, { 'png' => $pngOrError };
2202   (@usage);
2203 }
2204
2205 sub _list_svc_usage {
2206   my($svc_acct, $begin, $end) = @_;
2207   my @usage = ();
2208   foreach my $part_export (
2209     map { qsearch ( 'part_export', { 'exporttype' => $_ } ) }
2210     qw( sqlradius sqlradius_withdomain )
2211   ) {
2212     push @usage, @ { $part_export->usage_sessions($begin, $end, $svc_acct) };
2213   }
2214   (@usage);
2215 }
2216
2217 sub list_svc_usage {
2218   _usage_details(\&_list_svc_usage, @_);
2219 }
2220
2221 sub _list_support_usage {
2222   my($svc_acct, $begin, $end) = @_;
2223   my @usage = ();
2224   foreach ( grep { $begin <= $_->_date && $_->_date <= $end }
2225             qsearch('acct_rt_transaction', { 'svcnum' => $svc_acct->svcnum })
2226           ) {
2227     push @usage, { 'seconds'  => $_->seconds,
2228                    'support'  => $_->support,
2229                    '_date'    => $_->_date,
2230                    'id'       => $_->transaction_id,
2231                    'creator'  => $_->creator,
2232                    'subject'  => $_->subject,
2233                    'status'   => $_->status,
2234                    'ticketid' => $_->ticketid,
2235                  };
2236   }
2237   (@usage);
2238 }
2239
2240 sub list_support_usage {
2241   _usage_details(\&_list_support_usage, @_);
2242 }
2243
2244 sub _list_cdr_usage {
2245   # XXX CDR type support...
2246   # XXX any way to do a paged search on this?
2247   # we have to return the results all at once...
2248   my($svc_x, $begin, $end, %opt) = @_;
2249   map [ $_->downstream_csv(%opt, 'keeparray' => 1) ],
2250     $svc_x->get_cdrs(
2251       'begin' => $begin,
2252       'end'   => $end,
2253       'disable_charged_party' => 1,
2254       %opt
2255     );
2256 }
2257
2258 sub list_cdr_usage {
2259   my $p = shift;
2260   _usage_details( \&_list_cdr_usage, $p );
2261 }
2262
2263 sub _usage_details {
2264   my($callback, $p, %opt) = @_;
2265   my $conf = FS::Conf->new;
2266
2267   if ( $conf->exists('selfservice_hide-usage') ) {
2268     return { 'error' => 'Viewing usage is not allowed.' };
2269   }
2270
2271   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2272   return { 'error' => $session } if $context eq 'error';
2273
2274   my $search = { 'svcnum' => $p->{'svcnum'} };
2275   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2276
2277   my $cust_svc = qsearchs( 'cust_svc', $search );
2278   return { 'error' => 'No service selected in list_svc_usage' }
2279     unless $cust_svc;
2280
2281   my $svc_x = $cust_svc->svc_x;
2282   my $svcdb = $svc_x->table;
2283   my $cust_pkg = $cust_svc->cust_pkg;
2284   my $freq     = $cust_pkg->part_pkg->freq;
2285   my %callback_opt;
2286   my $header = [];
2287   if ( $svcdb eq 'svc_phone' or $svcdb eq 'svc_pbx' ) {
2288     my $format = '';
2289     if ( $p->{inbound} ) {
2290       $format = $cust_pkg->part_pkg->option('selfservice_inbound_format')
2291                 || $conf->config('selfservice-default_inbound_cdr_format')
2292                 || 'source_default';
2293       $callback_opt{inbound} = 1;
2294     } else {
2295       $format = $cust_pkg->part_pkg->option('selfservice_format')
2296                 || $conf->config('selfservice-default_cdr_format')
2297                 || 'default';
2298     }
2299
2300     $callback_opt{format} = $format;
2301     $callback_opt{use_clid} = 1;
2302     $header = [ split(',', FS::cdr::invoice_header($format) ) ];
2303   }
2304
2305   my $start    = $cust_pkg->setup;
2306   #my $end      = $cust_pkg->bill; # or time?
2307   my $end      = time;
2308
2309   unless ( $p->{beginning} ) {
2310     $p->{beginning} = $cust_pkg->last_bill;
2311     $p->{ending}    = $end;
2312   }
2313
2314   die "illegal beginning" if $p->{beginning} !~ /^\d*$/;
2315   die "illegal ending"    if $p->{ending}    !~ /^\d*$/;
2316
2317   my (@usage) = &$callback($svc_x, $p->{beginning}, $p->{ending},
2318     %callback_opt
2319   );
2320
2321   if ( $conf->exists('selfservice-hide_cdr_price') ) {
2322     # ugly kludge, I know
2323     my ($delete_col) = grep { $header->[$_] eq 'Price' } (0..scalar(@$header));
2324     if (defined $delete_col) {
2325       delete($_->[$delete_col]) foreach ($header, @usage);
2326     }
2327   }
2328
2329   #kinda false laziness with FS::cust_main::bill, but perhaps
2330   #we should really change this bit to DateTime and DateTime::Duration
2331   #
2332   #change this bit to use Date::Manip? CAREFUL with timezones (see
2333   # mailing list archive)
2334   my ($nsec,$nmin,$nhour,$nmday,$nmon,$nyear) =
2335     (localtime($p->{ending}) )[0,1,2,3,4,5];
2336   my ($psec,$pmin,$phour,$pmday,$pmon,$pyear) =
2337     (localtime($p->{beginning}) )[0,1,2,3,4,5];
2338
2339   if ( $freq =~ /^\d+$/ ) {
2340     $nmon += $freq;
2341     until ( $nmon < 12 ) { $nmon -= 12; $nyear++; }
2342     $pmon -= $freq;
2343     until ( $pmon >= 0 ) { $pmon += 12; $pyear--; }
2344   } elsif ( $freq =~ /^(\d+)w$/ ) {
2345     my $weeks = $1;
2346     $nmday += $weeks * 7;
2347     $pmday -= $weeks * 7;
2348   } elsif ( $freq =~ /^(\d+)d$/ ) {
2349     my $days = $1;
2350     $nmday += $days;
2351     $pmday -= $days;
2352   } elsif ( $freq =~ /^(\d+)h$/ ) {
2353     my $hours = $1;
2354     $nhour += $hours;
2355     $phour -= $hours;
2356   } else {
2357     return { 'error' => "unparsable frequency: ". $freq };
2358   }
2359
2360   my $previous  = timelocal_nocheck($psec,$pmin,$phour,$pmday,$pmon,$pyear);
2361   my $next      = timelocal_nocheck($nsec,$nmin,$nhour,$nmday,$nmon,$nyear);
2362
2363   {
2364     'error'     => '',
2365     'svcnum'    => $p->{svcnum},
2366     'beginning' => $p->{beginning},
2367     'ending'    => $p->{ending},
2368     'inbound'   => $p->{inbound},
2369     'previous'  => ($previous > $start) ? $previous : $start,
2370     'next'      => ($next < $end) ? $next : $end,
2371     'header'    => $header,
2372     'usage'     => \@usage,
2373   };
2374 }
2375
2376 sub order_pkg {
2377   my $p = shift;
2378
2379   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2380   return { 'error' => $session } if $context eq 'error';
2381
2382   my $search = { 'custnum' => $custnum };
2383   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2384   my $cust_main = qsearchs('cust_main', $search )
2385     or return { 'error' => "unknown custnum $custnum" };
2386
2387   my $status = $cust_main->status;
2388
2389   my %order_pkg_options = ();
2390   if ( $p->{locationnum} > 0 ) {
2391     $order_pkg_options{locationnum} = delete($p->{locationnum});
2392   } elsif ( $p->{address1} ) {
2393     $order_pkg_options{'cust_location'} = new FS::cust_location {
2394       map { $_ => $p->{$_} }
2395         qw( address1 address2 city county state zip country )
2396     };
2397   }
2398
2399   #false laziness w/ClientAPI/Signup.pm
2400
2401   my $cust_pkg = new FS::cust_pkg ( {
2402     'custnum'  => $custnum,
2403     'pkgpart'  => $p->{'pkgpart'},
2404     'quantity' => $p->{'quantity'} || 1,
2405   } );
2406   my $error = $cust_pkg->check;
2407   return { 'error' => $error } if $error;
2408
2409   my @svc = ();
2410   unless ( $p->{'svcpart'} eq 'none' ) {
2411
2412     my $svcdb;
2413     my $svcpart = '';
2414     if ( $p->{'svcpart'} =~ /^(\d+)$/ ) {
2415       $svcpart = $1;
2416       my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2417       return { 'error' => "Unknown svcpart $svcpart" } unless $part_svc;
2418       $svcdb = $part_svc->svcdb;
2419     } else {
2420       $svcdb = 'svc_acct';
2421     }
2422     $svcpart ||= $cust_pkg->part_pkg->svcpart($svcdb);
2423
2424     my %fields = (
2425       'svc_acct'     => [ qw( username domsvc _password sec_phrase popnum ) ],
2426       'svc_domain'   => [ qw( domain ) ],
2427       'svc_phone'    => [ qw( phonenum pin sip_password phone_name ) ],
2428       'svc_external' => [ qw( id title ) ],
2429       'svc_pbx'      => [ qw( id title ) ],
2430     );
2431
2432     my $svc_x = "FS::$svcdb"->new( {
2433       'svcpart'   => $svcpart,
2434       map { $_ => $p->{$_} } @{$fields{$svcdb}}
2435     } );
2436
2437     if ( $svcdb eq 'svc_acct' && exists($p->{"snarf_machine1"}) ) {
2438       my @acct_snarf;
2439       my $snarfnum = 1;
2440       while ( length($p->{"snarf_machine$snarfnum"}) ) {
2441         my $acct_snarf = new FS::acct_snarf ( {
2442           'machine'   => $p->{"snarf_machine$snarfnum"},
2443           'protocol'  => $p->{"snarf_protocol$snarfnum"},
2444           'username'  => $p->{"snarf_username$snarfnum"},
2445           '_password' => $p->{"snarf_password$snarfnum"},
2446         } );
2447         $snarfnum++;
2448         push @acct_snarf, $acct_snarf;
2449       }
2450       $svc_x->child_objects( \@acct_snarf );
2451     }
2452
2453     my $y = $svc_x->setdefault; # arguably should be in new method
2454     return { 'error' => $y } if $y && !ref($y);
2455
2456     $error = $svc_x->check;
2457     return { 'error' => $error } if $error;
2458
2459     push @svc, $svc_x;
2460
2461   }
2462
2463   $error = $cust_main->order_pkg(
2464     'cust_pkg' => $cust_pkg,
2465     'svcs'     => \@svc,
2466     'noexport' => 1,
2467     %order_pkg_options,
2468   );
2469   return { 'error' => $error } if $error;
2470
2471   my $conf = new FS::Conf;
2472   if ( $conf->exists('signup_server-realtime') ) {
2473
2474     my $bill_error = _do_bop_realtime( $cust_main, $status, 'collect'=>$p->{run_bill_events} );
2475
2476     if ($bill_error) {
2477       $cust_pkg->cancel('quiet'=>1);
2478       return $bill_error;
2479     } else {
2480       $cust_pkg->reexport;
2481     }
2482
2483   } else {
2484     $cust_pkg->reexport;
2485   }
2486
2487   my $svcnum = $svc[0] ? $svc[0]->svcnum : '';
2488
2489   return { error=>'', pkgnum=>$cust_pkg->pkgnum, svcnum=>$svcnum };
2490
2491 }
2492
2493 sub change_pkg {
2494   my $p = shift;
2495
2496   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2497   return { 'error' => $session } if $context eq 'error';
2498
2499   my $conf = new FS::Conf;
2500   my $immutable = $conf->exists('selfservice_immutable-package');
2501   return { 'error' => "Package modification disabled" } if $immutable;
2502
2503   my $search = { 'custnum' => $custnum };
2504   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2505   my $cust_main = qsearchs('cust_main', $search )
2506     or return { 'error' => "unknown custnum $custnum" };
2507
2508   my $status = $cust_main->status;
2509   my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $p->{pkgnum} } )
2510     or return { 'error' => "unknown package $p->{pkgnum}" };
2511
2512   #if someone does need self-service package change of suspended packages,
2513   # figure out how to be more discriminating
2514   return { error=>"Can't change a suspended package", pkgnum=>$cust_pkg->pkgnum}
2515     if $cust_pkg->status eq 'suspended';
2516
2517   my $err_or_cust_pkg = $cust_pkg->change( 'pkgpart'  => $p->{'pkgpart'},
2518                                            'quantity' => $p->{'quantity'} || 1,
2519                                          );
2520
2521   my $new_pkg = qsearchs('part_pkg', { 'pkgpart' => $p->{pkgpart} } )
2522     or return { 'error' => "unknown package $p->{pkgpart}" };
2523
2524   return { error=>$err_or_cust_pkg, pkgnum=>$cust_pkg->pkgnum }
2525     unless ref($err_or_cust_pkg);
2526
2527
2528   if ( $conf->exists('signup_server-realtime') ) {
2529
2530     my $bill_error = _do_bop_realtime( $cust_main, $status, 'no_invoice_void'=>1 );
2531
2532     if ($bill_error) {
2533       $err_or_cust_pkg->suspend;
2534       return $bill_error;
2535     } else {
2536       $err_or_cust_pkg->reexport;
2537     }
2538
2539   } else {
2540     $err_or_cust_pkg->reexport;
2541   }
2542
2543   return { error => '', pkg => $new_pkg->pkg, pkgnum => $err_or_cust_pkg->pkgnum };
2544
2545 }
2546
2547 sub order_recharge {
2548   my $p = shift;
2549
2550   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2551   return { 'error' => $session } if $context eq 'error';
2552
2553   my $search = { 'custnum' => $custnum };
2554   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2555   my $cust_main = qsearchs('cust_main', $search )
2556     or return { 'error' => "unknown custnum $custnum" };
2557
2558   my $status = $cust_main->status;
2559   my $cust_svc = qsearchs( 'cust_svc', { 'svcnum' => $p->{'svcnum'} } )
2560     or return { 'error' => "unknown service " . $p->{'svcnum'} };
2561
2562   my $svc_x = $cust_svc->svc_x;
2563   my $part_pkg = $cust_svc->cust_pkg->part_pkg;
2564
2565   my %vhash =
2566     map { $_ =~ /^recharge_(.*)$/; $1, $part_pkg->option($_, 1) }
2567     qw ( recharge_seconds recharge_upbytes recharge_downbytes
2568          recharge_totalbytes );
2569   my $amount = $part_pkg->option('recharge_amount', 1);
2570
2571   my ($l, $v, $d) = $cust_svc->label;  # blah
2572   my $pkg = "Recharge $v";
2573
2574   my $bill_error = $cust_main->charge($amount, $pkg,
2575      "time: $vhash{seconds}, up: $vhash{upbytes}," .
2576      "down: $vhash{downbytes}, total: $vhash{totalbytes}",
2577      $part_pkg->taxclass); #meh
2578
2579   my $conf = new FS::Conf;
2580   if ( $conf->exists('signup_server-realtime') && !$bill_error ) {
2581
2582     $bill_error = _do_bop_realtime( $cust_main, $status );
2583
2584     if ($bill_error) {
2585       return $bill_error;
2586     } else {
2587       my $error = $svc_x->recharge (\%vhash);
2588       return { 'error' => $error } if $error;
2589     }
2590
2591   } else {
2592     my $error = $bill_error;
2593     $error ||= $svc_x->recharge (\%vhash);
2594     return { 'error' => $error } if $error;
2595   }
2596
2597   return { error => '', svc => $cust_svc->part_svc->svc };
2598
2599 }
2600
2601 sub _do_bop_realtime {
2602   my ($cust_main, $status, %opt) = @_;
2603
2604   my $old_balance = $cust_main->balance;
2605
2606   my @cust_bill;
2607   my $bill_error = $cust_main->bill(
2608     'return_bill'   => \@cust_bill,
2609   );
2610
2611   $bill_error ||= $cust_main->apply_payments_and_credits;
2612
2613   $bill_error ||= $cust_main->realtime_collect('selfservice' => 1)
2614     if $cust_main->payby =~ /^(CARD|CHEK)$/;
2615
2616   if (    $cust_main->balance > $old_balance
2617        && $cust_main->balance > 0
2618        && ( $cust_main->payby !~ /^(BILL|DCRD|DCHK)$/
2619               || $status eq 'suspended'
2620           )
2621      )
2622   {
2623     unless ( $opt{'no_invoice_void'} ) {
2624
2625       #this used to apply a credit, but now we can void invoices...
2626       foreach my $cust_bill (@cust_bill) {
2627         my $voiderror = $cust_bill->void('automatic payment failed');
2628         warn "Error voiding cust bill after decline: $voiderror" if $voiderror;
2629       }
2630
2631     }
2632
2633     return { 'error' => '_decline', 'bill_error' => $bill_error };
2634   }
2635
2636   if ( $opt{'collect'} ) {
2637     my $collect_error = $cust_main->collect();
2638     return { 'error' => '_decline', 'bill_error' => $collect_error }
2639      if $collect_error; #?
2640   }
2641
2642   '';
2643 }
2644
2645 sub renew_info {
2646   my $p = shift;
2647
2648   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2649   return { 'error' => $session } if $context eq 'error';
2650
2651   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
2652     or return { 'error' => "unknown custnum $custnum" };
2653
2654   my @cust_pkg = sort { $a->bill <=> $b->bill }
2655                  grep { $_->part_pkg->freq ne '0' }
2656                  $cust_main->ncancelled_pkgs;
2657
2658   #return { 'error' => 'No active packages to renew.' } unless @cust_pkg;
2659
2660   my $total = $cust_main->balance;
2661
2662   my @array = map {
2663                     my $bill = $_->bill;
2664                     $total += $_->part_pkg->base_recur($_, \$bill);
2665                     my $renew_date = $_->part_pkg->add_freq($_->bill);
2666                     {
2667                       'pkgnum'             => $_->pkgnum,
2668                       'amount'             => sprintf('%.2f', $total),
2669                       'bill_date'          => $_->bill,
2670                       'bill_date_pretty'   => time2str('%x', $_->bill),
2671                       'renew_date'         => $renew_date,
2672                       'renew_date_pretty'  => time2str('%x', $renew_date),
2673                       'expire_date'        => $_->expire,
2674                       'expire_date_pretty' => time2str('%x', $_->expire),
2675                     };
2676                   }
2677                   @cust_pkg;
2678
2679   return { 'dates' => \@array };
2680
2681 }
2682
2683 sub payment_info_renew_info {
2684   my $p = shift;
2685   my $renew_info   = renew_info($p);
2686   my $payment_info = payment_info($p);
2687   return { %$renew_info,
2688            %$payment_info,
2689          };
2690 }
2691
2692 sub order_renew {
2693   my $p = shift;
2694
2695   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2696   return { 'error' => $session } if $context eq 'error';
2697
2698   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
2699     or return { 'error' => "unknown custnum $custnum" };
2700
2701   my $date = $p->{'date'};
2702
2703   my $now = time;
2704
2705   #freeside-daily -n -d $date fs_daily $custnum
2706   $cust_main->bill_and_collect( 'time'         => $date,
2707                                 'invoice_time' => $now,
2708                                 'actual_time'  => $now,
2709                                 'check_freq'   => '1d',
2710                               );
2711
2712   return { 'error' => '' };
2713
2714 }
2715
2716 sub suspend_pkg {
2717   my $p = shift;
2718   my $session = _cache->get($p->{'session_id'})
2719     or return { 'error' => "Can't resume session" }; #better error message
2720
2721   my $custnum = $session->{'custnum'};
2722
2723   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
2724     or return { 'error' => "unknown custnum $custnum" };
2725
2726   my $conf = new FS::Conf;
2727   my $reasonnum =
2728     $conf->config('selfservice-self_suspend_reason', $cust_main->agentnum)
2729       or return { 'error' => 'Permission denied' };
2730
2731   my $pkgnum = $p->{'pkgnum'};
2732
2733   my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
2734                                         'pkgnum'  => $pkgnum,   } )
2735     or return { 'error' => "unknown pkgnum $pkgnum" };
2736
2737   my $error = $cust_pkg->suspend(reason => $reasonnum);
2738   return { 'error' => $error };
2739
2740 }
2741
2742 sub cancel_pkg {
2743   my $p = shift;
2744   my $session = _cache->get($p->{'session_id'})
2745     or return { 'error' => "Can't resume session" }; #better error message
2746
2747   my $custnum = $session->{'custnum'};
2748   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
2749     or return { 'error' => "unknown custnum $custnum" };
2750
2751   my $pkgnum = $p->{'pkgnum'};
2752   my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
2753                                         'pkgnum'  => $pkgnum,   } )
2754     or return { 'error' => "unknown pkgnum $pkgnum" };
2755
2756   my $error = $cust_pkg->cancel( 'quiet' => 1,
2757                                  'date'  => $p->{'date'},
2758                                );
2759   return { 'error' => $error };
2760 }
2761
2762 sub provision_phone {
2763   my $p = shift;
2764   my @bulkdid;
2765   @bulkdid = @{$p->{'bulkdid'}} if $p->{'bulkdid'};
2766
2767   #editing an existing phone number
2768   if ( $p->{'svcnum'} && $p->{'svcnum'} =~ /^\d+$/ ) {
2769       my($context, $session, $custnum) = _custoragent_session_custnum($p);
2770       return { 'error' => $session } if $context eq 'error';
2771
2772       my $svc_phone = qsearchs('svc_phone', { svcnum => $p->{'svcnum'} });
2773       return { 'error' => 'service not found' } unless $svc_phone;
2774       return { 'error' => 'invalid svcnum' }
2775         if $svc_phone && $svc_phone->cust_svc->cust_pkg->custnum != $custnum;
2776
2777       $svc_phone->email($p->{'email'})
2778         if $svc_phone->email ne $p->{'email'} && $p->{'email'} =~ /^([\w\.\d@]+|)$/;
2779       $svc_phone->forwarddst($p->{'forwarddst'})
2780         if $svc_phone->forwarddst ne $p->{'forwarddst'}
2781             && $p->{'forwarddst'} =~ /^(\d+|)$/;
2782       return { 'error' => $svc_phone->replace };
2783  }
2784
2785   # single DID LNP
2786   unless ( $p->{'lnp'} ) {
2787     $p->{'lnp_desired_due_date'} = parse_datetime($p->{'lnp_desired_due_date'});
2788     $p->{'lnp_status'} = "portingin";
2789     return _provision( 'FS::svc_phone',
2790                   [qw(lnp_desired_due_date lnp_other_provider
2791                     lnp_other_provider_account phonenum countrycode lnp_status)],
2792                   [qw(phonenum countrycode)],
2793                   $p,
2794                   @_
2795                 );
2796   }
2797
2798   # single DID order (the usual case)
2799   unless (scalar(@bulkdid)) {
2800     return _provision( 'FS::svc_phone',
2801                   [qw(phonenum countrycode)],
2802                   [qw(phonenum countrycode)],
2803                   $p,
2804                   @_
2805                 );
2806   }
2807
2808   # bulk DID order case
2809   my $error;
2810   foreach my $did ( @bulkdid ) {
2811     $did =~ s/[^0-9]//g;
2812     $error = _provision( 'FS::svc_phone',
2813               [qw(phonenum countrycode)],
2814               [qw(phonenum countrycode)],
2815               {
2816                 'pkgnum' => $p->{'pkgnum'},
2817                 'svcpart' => $p->{'svcpart'},
2818                 'phonenum' => $did,
2819                 'countrycode' => $p->{'countrycode'},
2820                 'session_id' => $p->{'session_id'},
2821               }
2822             );
2823     return $error if ($error->{'error'} && length($error->{'error'}) > 1);
2824   }
2825   { 'bulkdid' => [ @bulkdid ], 'svc' => $error->{'svc'} }
2826 }
2827
2828 sub provision_pbx {
2829   my $p = shift;
2830   warn "provision_pbx called\n"
2831     if $DEBUG;
2832
2833   warn "provision_pbx calling _provision\n"
2834     if $DEBUG;
2835   _provision( 'FS::svc_pbx',
2836               [qw(id title max_extensions max_simultaneous ip_addr)],
2837               [qw(id title max_extensions max_simultaneous ip_addr)],
2838               $p,
2839               @_
2840             );
2841 }
2842
2843 sub provision_acct {
2844   my $p = shift;
2845   warn "provision_acct called\n"
2846     if $DEBUG;
2847
2848   return { 'error' => gettext('passwords_dont_match') }
2849     if $p->{'_password'} ne $p->{'_password2'};
2850   return { 'error' => gettext('empty_password') }
2851     unless length($p->{'_password'});
2852
2853   if ($p->{'domsvc'}) {
2854     my %domains = domain_select_hash FS::svc_acct(map { $_ => $p->{$_} }
2855                                                   qw ( svcpart pkgnum ) );
2856     return { 'error' => gettext('invalid_domain') }
2857       unless ($domains{$p->{'domsvc'}});
2858   }
2859
2860   warn "provision_acct calling _provision\n"
2861     if $DEBUG;
2862   _provision( 'FS::svc_acct',
2863               [qw(username _password domsvc)],
2864               [qw(username _password domsvc)],
2865               $p,
2866               @_
2867             );
2868 }
2869
2870 sub provision_external {
2871   my $p = shift;
2872   #_provision( 'FS::svc_external', [qw(id title)], [qw(id title)], $p, @_ );
2873   _provision( 'FS::svc_external',
2874               [],
2875               [qw(id title)],
2876               $p,
2877               @_
2878             );
2879 }
2880
2881 sub provision_forward {
2882   my $p = shift;
2883   _provision( 'FS::svc_forward',
2884               ['srcsvc','src','dstsvc','dst'],
2885               [],
2886               $p,
2887             );
2888 }
2889
2890 sub _provision {
2891   my( $class, $fields, $return_fields, $p ) = splice(@_, 0, 4);
2892   warn "_provision called for $class\n"
2893     if $DEBUG;
2894
2895   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2896   return { 'error' => $session } if $context eq 'error';
2897
2898   my $search = { 'custnum' => $custnum };
2899   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2900   my $cust_main = qsearchs('cust_main', $search )
2901     or return { 'error' => "unknown custnum $custnum" };
2902
2903   my $pkgnum = $p->{'pkgnum'};
2904
2905   warn "searching for custnum $custnum pkgnum $pkgnum\n"
2906     if $DEBUG;
2907   my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
2908                                         'pkgnum'  => $pkgnum,
2909                                                                } )
2910     or return { 'error' => "unknown pkgnum $pkgnum" };
2911
2912   warn "searching for svcpart ". $p->{'svcpart'}. "\n"
2913     if $DEBUG;
2914   my $part_svc = qsearchs('part_svc', { 'svcpart' => $p->{'svcpart'} } )
2915     or return { 'error' => "unknown svcpart $p->{'svcpart'}" };
2916
2917   return { error=> 'svcpart '. $p->{'svcpart'}. " is not a $class definition" }
2918     if $class ne 'FS::'. $part_svc->svcdb;
2919
2920   warn "creating $class record\n"
2921     if $DEBUG;
2922   my $svc_x = $class->new( {
2923     'pkgnum'  => $p->{'pkgnum'},
2924     'svcpart' => $p->{'svcpart'},
2925     map { $_ => $p->{$_} } @$fields
2926   } );
2927
2928   my %insert_args = ();
2929   #i shouldn't be a special case here (pass an option or something)
2930   if ( $class eq 'FS::svc_phone'
2931          && grep length($p->{$_}), @location_editable_fields
2932      )
2933   {
2934     $insert_args{'cust_location'} = new FS::cust_location {
2935       map { $_ => $p->{$_} } @location_editable_fields
2936     };
2937   }
2938
2939   warn "inserting $class record\n"
2940     if $DEBUG;
2941   my $error = $svc_x->insert(%insert_args);
2942
2943   unless ( $error ) {
2944     warn "finding inserted record for svcnum ". $svc_x->svcnum. "\n"
2945       if $DEBUG;
2946     $svc_x = qsearchs($svc_x->table, { 'svcnum' => $svc_x->svcnum })
2947   }
2948
2949   my $return = { 'svc'   => $part_svc->svc,
2950                  'error' => $error,
2951                  map { $_ => $svc_x->get($_) } @$return_fields
2952                };
2953   warn "_provision returning ". Dumper($return). "\n"
2954     if $DEBUG;
2955   return $return;
2956
2957 }
2958
2959 sub part_svc_info {
2960   my $p = shift;
2961
2962   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2963   return { 'error' => $session } if $context eq 'error';
2964
2965   my $search = { 'custnum' => $custnum };
2966   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2967   my $cust_main = qsearchs('cust_main', $search )
2968     or return { 'error' => "unknown custnum $custnum" };
2969
2970   my $pkgnum = $p->{'pkgnum'};
2971
2972   my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
2973                                         'pkgnum'  => $pkgnum,
2974                                                                } )
2975     or return { 'error' => "unknown pkgnum $pkgnum" };
2976
2977   my $svcpart = $p->{'svcpart'};
2978
2979   my $pkg_svc = qsearchs('pkg_svc', { 'pkgpart' => $cust_pkg->pkgpart,
2980                                       'svcpart' => $svcpart,           } )
2981     or return { 'error' => "unknown svcpart $svcpart for pkgnum $pkgnum" };
2982   my $part_svc = $pkg_svc->part_svc;
2983
2984   my $conf = new FS::Conf;
2985
2986   my $ret = {
2987     'svc'     => $part_svc->svc,
2988     'svcdb'   => $part_svc->svcdb,
2989     'pkgnum'  => $pkgnum,
2990     'svcpart' => $svcpart,
2991     'custnum' => $custnum,
2992
2993     'security_phrase' => 0, #XXX !
2994     'svc_acct_pop'    => [], #XXX !
2995     'popnum'          => '',
2996     'init_popstate'   => '',
2997     'popac'           => '',
2998     'acstate'         => '',
2999
3000     'small_custview' =>
3001       small_custview( $cust_main, $conf->config('countrydefault') ),
3002
3003   };
3004
3005   if ($p->{'svcnum'} && $p->{'svcnum'} =~ /^\d+$/
3006                      && $ret->{'svcdb'} eq 'svc_phone') {
3007         $ret->{'svcnum'} = $p->{'svcnum'};
3008         my $svc_phone = qsearchs('svc_phone', { svcnum => $p->{'svcnum'} });
3009         if ( $svc_phone && $svc_phone->cust_svc->cust_pkg->custnum == $custnum ) {
3010             $ret->{'email'} = $svc_phone->email;
3011             $ret->{'forwarddst'} = $svc_phone->forwarddst;
3012         }
3013   }
3014
3015   if ($ret->{'svcdb'} eq 'svc_forward') {
3016     $ret->{'forward_emails'} = {$cust_pkg->forward_emails()};
3017   }
3018
3019   $ret;
3020 }
3021
3022 sub unprovision_svc {
3023   my $p = shift;
3024
3025   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3026   return { 'error' => $session } if $context eq 'error';
3027
3028   my $search = { 'custnum' => $custnum };
3029   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
3030   my $cust_main = qsearchs('cust_main', $search )
3031     or return { 'error' => "unknown custnum $custnum" };
3032
3033   my $svcnum = $p->{'svcnum'};
3034
3035   my $cust_svc = qsearchs('cust_svc', { 'svcnum'  => $svcnum, } )
3036     or return { 'error' => "unknown svcnum $svcnum" };
3037
3038   return { 'error' => "Service $svcnum does not belong to customer $custnum" }
3039     unless $cust_svc->cust_pkg->custnum == $custnum;
3040
3041   my $conf = new FS::Conf;
3042
3043   return { 'svc'   => $cust_svc->part_svc->svc,
3044            'error' => $cust_svc->cancel,
3045            'small_custview' =>
3046              small_custview( $cust_main, $conf->config('countrydefault') ),
3047          };
3048
3049 }
3050
3051 sub myaccount_passwd {
3052   my $p = shift;
3053   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3054   return { 'error' => $session } if $context eq 'error';
3055
3056   return { 'error' => "New passwords don't match." }
3057     if $p->{'new_password'} ne $p->{'new_password2'};
3058
3059   return { 'error' => 'Enter new password' }
3060     unless length($p->{'new_password'});
3061
3062   #my $search = { 'custnum' => $custnum };
3063   #$search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
3064   $custnum =~ /^(\d+)$/ or die "illegal custnum";
3065   my $search = " AND custnum = $1";
3066   $search .= " AND agentnum = ". $session->{'agentnum'} if $context eq 'agent';
3067
3068   my $svc_acct = qsearchs( {
3069     'table'     => 'svc_acct',
3070     'addl_from' => 'LEFT JOIN cust_svc  USING ( svcnum  ) '.
3071                    'LEFT JOIN cust_pkg  USING ( pkgnum  ) '.
3072                    'LEFT JOIN cust_main USING ( custnum ) ',
3073     'hashref'   => { 'svcnum' => $p->{'svcnum'}, },
3074     'extra_sql' => $search, #important
3075   } )
3076     or return { 'error' => "Service not found" };
3077
3078   my $error = '';
3079
3080   my $conf = new FS::Conf;
3081
3082   return { 'error' => 'Incorrect current password.' }
3083     if  ( exists($p->{'old_password'})
3084           || $conf->exists('selfservice-password_change_oldpass')
3085         )
3086     && ! $svc_acct->check_password($p->{'old_password'});
3087
3088   $error ||= $svc_acct->is_password_allowed($p->{'new_password'})
3089          ||  $svc_acct->set_password($p->{'new_password'})
3090          ||  $svc_acct->replace();
3091
3092   #regular pw change in self-service should change contact pw too, otherwise its
3093   #way too confusing.  hell its confusing they're separate at all, but alas.
3094   #need to support the "ISP provides email that's used as a contact email" case
3095   #as well as we can.
3096   my $contact = FS::contact->by_selfservice_email($svc_acct->email);
3097   if ( $contact && $contact->custnum == $custnum ) {
3098     #svc_acct was successful but this one returns an error?  "shouldn't happen"
3099     #don't recheck is_password_allowed here; if the svc_acct password was
3100     #legal, that's good enough
3101     $error ||= $contact->change_password($p->{'new_password'});
3102   }
3103
3104   my($label, $value) = $svc_acct->cust_svc->label;
3105
3106   return { 'error' => $error,
3107            'label' => $label,
3108            'value' => $value,
3109          };
3110
3111 }
3112
3113 sub reset_passwd {
3114   my $p = shift;
3115
3116   my $info = skin_info($p);
3117
3118   my $conf = new FS::Conf;
3119   my $verification = $conf->config('selfservice-password_reset_verification')
3120     or return { %$info, 'error' => 'Password resets disabled' };
3121
3122   my $contact = '';
3123   my $svc_acct = '';
3124   my $cust_main = '';
3125   if ( $p->{'email'} ) { #new-style, changes contact and svc_acct
3126
3127     $contact = FS::contact->by_selfservice_email($p->{'email'});
3128
3129     $cust_main = $contact->cust_main if $contact;
3130
3131     #also look for an svc_acct, otherwise it would be super confusing
3132
3133     my($username, $domain) = split('@', $p->{'email'});
3134     my $svc_domain = qsearchs('svc_domain', { 'domain' => $domain } );
3135     if ( $svc_domain ) {
3136       $svc_acct = qsearchs('svc_acct', { 'username' => $username,
3137                                          'domsvc'   => $svc_domain->svcnum  }
3138                           );
3139       if ( $svc_acct ) {
3140         my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3141         $cust_main ||= $cust_pkg->cust_main if $cust_pkg;
3142
3143         #precaution: don't change svc_acct password not part of the same
3144         # customer as contact
3145         $svc_acct = '' if ! $cust_pkg
3146                        || $cust_pkg->custnum != $cust_main->custnum;
3147       }
3148
3149     }
3150
3151     return { %$info, 'error' => 'Email address not found' }
3152       unless $contact || $svc_acct;
3153
3154   } elsif ( $p->{'username'} ) { #old style, looks in svc_acct only
3155
3156     my $svc_domain = qsearchs('svc_domain', { 'domain' => $p->{'domain'} } )
3157       or return { %$info, 'error' => 'Account not found' };
3158
3159     $svc_acct = qsearchs('svc_acct', { 'username' => $p->{'username'},
3160                                        'domsvc'   => $svc_domain->svcnum  }
3161                         )
3162       or return { %$info, 'error' => 'Account not found' };
3163
3164     my $cust_pkg = $svc_acct->cust_svc->cust_pkg
3165       or return { %$info, 'error' => 'Account not found' };
3166
3167     $cust_main = $cust_pkg->cust_main;
3168
3169   }
3170
3171   my %verify = (
3172     'email'   => sub { 1; },
3173     'paymask' => sub {
3174       my( $p, $cust_main ) = @_;
3175       $cust_main->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/
3176         && $p->{'paymask'} eq substr($cust_main->paymask, -4)
3177     },
3178     'amount'  => sub {
3179       my( $p, $cust_main ) = @_;
3180       my $cust_pay = qsearchs({
3181         'table' => 'cust_pay',
3182         'hashref' => { 'custnum' => $cust_main->custnum },
3183         'order_by' => 'ORDER BY _date DESC LIMIT 1',
3184       })
3185         or return 0;
3186
3187       $p->{'amount'} == $cust_pay->paid;
3188     },
3189     'zip'     => sub {
3190       my( $p, $cust_main ) = @_;
3191       $p->{'zip'} eq $cust_main->zip
3192         || ( $cust_main->ship_zip && $p->{'zip'} eq $cust_main->ship_zip );
3193     },
3194   );
3195
3196   foreach my $verify ( split(',', $verification) ) {
3197
3198     &{ $verify{$verify} }( $p, $cust_main )
3199       or return { %$info, 'error' => 'Account not found' };
3200
3201   }
3202
3203   #okay, we're verified
3204
3205   if ( $contact ) {
3206
3207     my $error = $contact->send_reset_email(
3208                             'svcnum' => ($svc_acct ? $svc_acct->svcnum : ''),
3209                           );
3210
3211     if ( $error ) {
3212       return { %$info, 'error' => $error }; #????
3213     }
3214
3215   } elsif ( $svc_acct ) {
3216
3217     #create a unique session
3218
3219     my $reset_session = {
3220       'svcnum'   => $svc_acct->svcnum,
3221       'agentnum' => $svc_acct->cust_main->agentnum,
3222     };
3223
3224     my $timeout = '1 hour'; #?
3225
3226     my $reset_session_id;
3227     do {
3228       $reset_session_id = sha512_hex(time(). {}. rand(). $$)
3229     } until ( ! defined _cache->get("reset_passwd_$reset_session_id") );
3230       #just in case
3231
3232     _cache->set( "reset_passwd_$reset_session_id", $reset_session, $timeout );
3233
3234     #email it
3235
3236     my $msgnum = $conf->config('selfservice-password_reset_msgnum',
3237                                $cust_main->agentnum);
3238     #die "selfservice-password_reset_msgnum unset" unless $msgnum;
3239     return { %$info, 'error' => "selfservice-password_reset_msgnum unset" }
3240       unless $msgnum;
3241     my $msg_template = qsearchs('msg_template', { msgnum => $msgnum } );
3242     my $error = $msg_template->send( 'cust_main'     => $cust_main,
3243                                      'object'        => $svc_acct,
3244                                      'substitutions' => {
3245                                        'session_id' => $reset_session_id,
3246                                      }
3247                                    );
3248     if ( $error ) {
3249       return { %$info, 'error' => $error }; #????
3250     }
3251
3252   }
3253
3254   return { %$info, 'error' => '' };
3255 }
3256
3257 sub check_reset_passwd {
3258   my $p = shift;
3259
3260   my $conf = new FS::Conf;
3261   my $verification = $conf->config('selfservice-password_reset_verification')
3262     or return { 'error' => 'Password resets disabled' };
3263
3264   my $reset_session = _cache->get('reset_passwd_'. $p->{'session_id'})
3265     or return { 'error' => "Can't resume session" }; #better error message
3266
3267   if ( $reset_session->{'svcnum'} ) {
3268
3269     my $svcnum = $reset_session->{'svcnum'};
3270
3271     my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $svcnum } )
3272       or return { 'error' => "Service not found" };
3273
3274     $p->{'agentnum'} = $svc_acct->cust_svc->cust_pkg->cust_main->agentnum;
3275     my $info = skin_info($p);
3276
3277     return { %$info,
3278              'error'      => '',
3279              'session_id' => $p->{'session_id'},
3280              'username'   => $svc_acct->username,
3281            };
3282
3283   } elsif ( $reset_session->{'contactnum'} ) {
3284
3285     my $contactnum = $reset_session->{'contactnum'};
3286
3287     my $contact = qsearchs('contact', { 'contactnum' => $contactnum } )
3288       or return { 'error' => "Contact not found" };
3289
3290     my @contact_email = $contact->contact_email;
3291     return { 'error' => 'No contact email' } unless @contact_email;
3292
3293     $p->{'agentnum'} = $contact->cust_main->agentnum;
3294     my $info = skin_info($p);
3295
3296     return { %$info,
3297              'error'      => '',
3298              'session_id' => $p->{'session_id'},
3299              'email'      => $contact_email[0]->email, #the first?
3300            };
3301
3302   } else {
3303
3304     return { 'error' => 'No svcnum or contactnum in session' }; #??
3305
3306   }
3307
3308 }
3309
3310 sub process_reset_passwd {
3311   my $p = shift;
3312
3313   my $conf = new FS::Conf;
3314   my $verification = $conf->config('selfservice-password_reset_verification')
3315     or return { 'error' => 'Password resets disabled' };
3316
3317   my $reset_session = _cache->get('reset_passwd_'. $p->{'session_id'})
3318     or return { 'error' => "Can't resume session" }; #better error message
3319
3320   my $info = '';
3321
3322   my $svc_acct = '';
3323   if ( $reset_session->{'svcnum'} ) {
3324
3325     my $svcnum = $reset_session->{'svcnum'};
3326
3327     $svc_acct = qsearchs('svc_acct', { 'svcnum' => $svcnum } )
3328       or return { 'error' => "Service not found" };
3329
3330     $p->{'agentnum'} ||= $svc_acct->cust_svc->cust_pkg->cust_main->agentnum;
3331     $info ||= skin_info($p);
3332
3333   }
3334
3335   my $contact = '';
3336   if ( $reset_session->{'contactnum'} ) {
3337
3338     my $contactnum = $reset_session->{'contactnum'};
3339
3340     $contact = qsearchs('contact', { 'contactnum' => $contactnum } )
3341       or return { 'error' => "Contact not found" };
3342
3343     $p->{'agentnum'} ||= $contact->cust_main->agentnum;
3344     $info ||= skin_info($p);
3345
3346   }
3347
3348   return { %$info, 'error' => "New passwords don't match." }
3349     if $p->{'new_password'} ne $p->{'new_password2'};
3350
3351   return { %$info, 'error' => 'Enter new password' }
3352     unless length($p->{'new_password'});
3353
3354   if ( $svc_acct ) {
3355
3356     my $error ||= $svc_acct->is_password_allowed($p->{'new_password'})
3357               ||  $svc_acct->set_password($p->{'new_password'})
3358               ||  $svc_acct->replace();
3359
3360     return { %$info, 'error' => $error } if $error;
3361
3362     #my($label, $value) = $svc_acct->cust_svc->label;
3363     #return { 'error' => $error,
3364     #         #'label' => $label,
3365     #         #'value' => $value,
3366     #       };
3367
3368   }
3369
3370   if ( $contact ) {
3371
3372     my $error = $contact->is_password_allowed($p->{'new_password'})
3373             ||  $contact->change_password($p->{'new_password'});
3374
3375     return { %$info, 'error' => $error }; # if $error;
3376
3377   }
3378
3379   #password changed ,so remove session, don't want it reused
3380   _cache->remove($p->{'session_id'});
3381
3382   return { %$info, 'error' => '' };
3383
3384 }
3385
3386 sub validate_passwd {
3387   my $p = shift;
3388
3389   my %result;
3390   %result = ( 'fieldid' => $p->{'fieldid'} )
3391     if $p->{'fieldid'} =~ /^\w+$/;
3392
3393   return { %result, 'password_invalid' => 'Enter new password' }
3394     unless length($p->{'check_password'});
3395
3396   my $svc_acct;
3397   if ($p->{'svcnum'}) {
3398     # false laziness with myaccount_passwd
3399     my($context, $session, $custnum) = _custoragent_session_custnum($p);
3400     return { %result, 'error' => $session } if $context eq 'error';
3401
3402     $custnum =~ /^(\d+)$/ or die "illegal custnum";
3403     my $search = " AND custnum = $1";
3404     $search .= " AND agentnum = ". $session->{'agentnum'} if $context eq 'agent';
3405
3406     $svc_acct = qsearchs( {
3407       'table'     => 'svc_acct',
3408       'addl_from' => 'LEFT JOIN cust_svc  USING ( svcnum  ) '.
3409                      'LEFT JOIN cust_pkg  USING ( pkgnum  ) '.
3410                      'LEFT JOIN cust_main USING ( custnum ) ',
3411       'hashref'   => { 'svcnum' => $p->{'svcnum'}, },
3412       'extra_sql' => $search, #important
3413     } )
3414       or return { %result, 'error' => "Service not found" };
3415     # end false laziness
3416   }
3417
3418   unless ($svc_acct) {
3419     my $conf = new FS::Conf;
3420     my $agentnum = $p->{'agentnum'};
3421     return { %result, 'password_valid' => 1 }
3422       if $conf->config_bool('password-insecure', $p->{'agentnum'});
3423   }
3424
3425   $svc_acct ||= new FS::svc_acct {};
3426
3427   my $error = $svc_acct->is_password_allowed($p->{'check_password'});
3428   return { %result, 'password_invalid' => $error } if $error;
3429   return { %result, 'password_valid' => 1 };
3430 }
3431
3432 sub list_tickets {
3433   my $p = shift;
3434   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3435   return { 'error' => $session } if $context eq 'error';
3436
3437   my @tickets = ();
3438   if ( $session->{'pkgnum'} ) {
3439
3440     #tickets for specific service with pkg-balances on
3441     my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
3442                                           'pkgnum'  => $session->{'pkgnum'} })
3443                      or return { 'error' => 'unknown package' };
3444     foreach my $cust_svc ( $cust_pkg->cust_svc ) {
3445       push @tickets, $cust_svc->tickets( $p->{status} );
3446     }
3447
3448   } else {
3449
3450     my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
3451       or return { 'error' => "unknown custnum $custnum" };
3452
3453     @tickets = $cust_main->tickets( $p->{status} );
3454   }
3455
3456   # unavoidable false laziness w/ httemplate/view/cust_main/tickets.html
3457   if ( $FS::TicketSystem::system && FS::TicketSystem->selfservice_priority ) {
3458     my $conf = new FS::Conf;
3459     my $dir = $conf->exists('ticket_system-priority_reverse') ? -1 : 1;
3460     +{ tickets => [
3461          sort {
3462            (
3463              ($a->{'_selfservice_priority'} eq '') <=>
3464              ($b->{'_selfservice_priority'} eq '')
3465            ) ||
3466            ( $dir *
3467              ($b->{'_selfservice_priority'} <=> $a->{'_selfservice_priority'})
3468            )
3469          } @tickets
3470        ]
3471     };
3472   } else {
3473     +{ tickets => \@tickets };
3474   }
3475
3476 }
3477
3478 sub create_ticket {
3479   my $p = shift;
3480   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3481   return { 'error' => $session } if $context eq 'error';
3482
3483   warn "$me create_ticket: initializing ticket system\n" if $DEBUG;
3484   FS::TicketSystem->init();
3485
3486   my $conf = new FS::Conf;
3487   my $queue = $p->{'queue'}
3488               || $conf->config('ticket_system-selfservice_queueid')
3489               || $conf->config('ticket_system-default_queueid');
3490
3491   warn "$me create_ticket: creating ticket\n" if $DEBUG;
3492   my $err_or_ticket = FS::TicketSystem->create_ticket(
3493     '', #create RT session based on FS CurrentUser (fs_selfservice)
3494     'queue'   => $queue,
3495     'custnum' => $custnum,
3496     'svcnum'  => $session->{'svcnum'},
3497     map { $_ => $p->{$_} } qw( requestor cc subject message mime_type )
3498   );
3499
3500   if ( ref($err_or_ticket) ) {
3501     warn "$me create_ticket: successful: ". $err_or_ticket->id. "\n"
3502       if $DEBUG;
3503     return { 'error'     => '',
3504              'ticket_id' => $err_or_ticket->id,
3505            };
3506   } else {
3507     warn "$me create_ticket: unsuccessful: $err_or_ticket\n"
3508       if $DEBUG;
3509     return { 'error' => $err_or_ticket };
3510   }
3511
3512
3513 }
3514
3515 sub did_report {
3516   my $p = shift;
3517   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3518   return { 'error' => $session } if $context eq 'error';
3519
3520   return { error => 'requested format not implemented' }
3521     unless ($p->{'format'} eq 'csv' || $p->{'format'} eq 'xls');
3522
3523   my $conf = new FS::Conf;
3524   my $age_threshold = 0;
3525   $age_threshold = time() - $conf->config('selfservice-recent-did-age')
3526     if ($p->{'recentonly'} && $conf->exists('selfservice-recent-did-age'));
3527
3528   my $search = { 'custnum' => $custnum };
3529   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
3530   my $cust_main = qsearchs('cust_main', $search )
3531     or return { 'error' => "unknown custnum $custnum" };
3532
3533 # does it make more sense to just run one sql query for this instead of all the
3534 # insanity below? would increase performance greately for large data sets?
3535   my @svc_phone = ();
3536   foreach my $cust_pkg ( $cust_main->ncancelled_pkgs ) {
3537         my @part_svc = $cust_pkg->part_svc;
3538         foreach my $part_svc ( @part_svc ) {
3539             if($part_svc->svcdb eq 'svc_phone'){
3540                 my @cust_pkg_svc = @{$part_svc->cust_pkg_svc};
3541                 foreach my $cust_pkg_svc ( @cust_pkg_svc ) {
3542                     push @svc_phone, $cust_pkg_svc->svc_x
3543                         if $cust_pkg_svc->date_inserted >= $age_threshold;
3544                 }
3545             }
3546         }
3547   }
3548
3549   my $csv;
3550   my $xls;
3551   my($xls_r,$xls_c) = (0,0);
3552   my $xls_workbook;
3553   my $content = '';
3554   my @fields = qw( countrycode phonenum pin sip_password phone_name );
3555   if($p->{'format'} eq 'csv') {
3556     $csv = new Text::CSV_XS { 'always_quote' => 1,
3557                                  'eol'          => "\n",
3558                                 };
3559     return { 'error' => 'Unable to create CSV' } unless $csv->combine(@fields);
3560     $content .= $csv->string;
3561   }
3562   elsif($p->{'format'} eq 'xls') {
3563     my $XLS1 = new IO::Scalar \$content;
3564     $xls_workbook = Spreadsheet::WriteExcel->new($XLS1)
3565         or return { 'error' => "Error opening .xls file: $!" };
3566     $xls = $xls_workbook->add_worksheet('DIDs');
3567     foreach ( @fields ) {
3568         $xls->write(0,$xls_c++,$_);
3569     }
3570     $xls_r++;
3571   }
3572
3573   foreach my $svc_phone ( @svc_phone ) {
3574     my @cols = map { $svc_phone->$_ } @fields;
3575     if($p->{'format'} eq 'csv') {
3576         return { 'error' => 'Unable to create CSV' }
3577             unless $csv->combine(@cols);
3578         $content .= $csv->string;
3579     }
3580     elsif($p->{'format'} eq 'xls') {
3581         $xls_c = 0;
3582         foreach ( @cols ) {
3583             $xls->write($xls_r,$xls_c++,$_);
3584         }
3585         $xls_r++;
3586     }
3587   }
3588
3589   $xls_workbook->close() if $p->{'format'} eq 'xls';
3590
3591   { content => $content, format => $p->{'format'}, };
3592 }
3593
3594 sub get_ticket {
3595   my $p = shift;
3596   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3597   return { 'error' => $session } if $context eq 'error';
3598
3599 #  warn "$me get_ticket: initializing ticket system\n" if $DEBUG;
3600 #  FS::TicketSystem->init();
3601 #  return { 'error' => 'get_ticket configuration error' }
3602 #    if $FS::TicketSystem::system ne 'RT_Internal';
3603
3604   # check existence and ownership as part of this
3605   warn "$me get_ticket: fetching ticket\n" if $DEBUG;
3606   my $rt_session = FS::TicketSystem->session('');
3607   my $Ticket = FS::TicketSystem->get_ticket_object(
3608     $rt_session,
3609     ticket_id => $p->{'ticket_id'},
3610     custnum => $custnum
3611   );
3612   return { 'error' => 'ticket not found' } if !$Ticket;
3613
3614   if ( length( $p->{'subject'} || '' ) ) {
3615     # subject change
3616     if ( $p->{'subject'} ne $Ticket->Subject ) {
3617       my ($val, $msg) = $Ticket->SetSubject($p->{'subject'});
3618       return { 'error' => "unable to set subject: $msg" } if !$val;
3619     }
3620   }
3621
3622   if(length($p->{'reply'})) {
3623     my @err_or_res = FS::TicketSystem->correspond_ticket(
3624       $rt_session,
3625       'ticket_id' => $p->{'ticket_id'},
3626       'content' => $p->{'reply'},
3627     );
3628
3629     return { 'error' => 'unable to reply to ticket' }
3630     unless ( $err_or_res[0] != 0 && defined $err_or_res[2] );
3631   }
3632
3633   warn "$me get_ticket: getting ticket history\n" if $DEBUG;
3634   my $err_or_ticket = FS::TicketSystem->get_ticket(
3635     $rt_session,
3636     'ticket_id' => $p->{'ticket_id'},
3637   );
3638
3639   if ( !ref($err_or_ticket) ) { # there is no way this should ever happen
3640     warn "$me get_ticket: unsuccessful: $err_or_ticket\n"
3641       if $DEBUG;
3642     return { 'error' => $err_or_ticket };
3643   }
3644
3645   my @custs = @{$err_or_ticket->{'custs'}};
3646   my @txns = @{$err_or_ticket->{'txns'}};
3647   my @filtered_txns;
3648
3649   # superseded by check in get_ticket_object
3650   #return { 'error' => 'invalid ticket requested' }
3651   #unless grep($_ eq $custnum, @custs);
3652
3653   foreach my $txn ( @txns ) {
3654     push @filtered_txns, $txn
3655     if ($txn->{'type'} eq 'EmailRecord'
3656       || $txn->{'type'} eq 'Correspond'
3657       || $txn->{'type'} eq 'Create');
3658   }
3659
3660   warn "$me get_ticket: successful: \n"
3661   if $DEBUG;
3662   return { 'error'     => '',
3663     'transactions' => \@filtered_txns,
3664     'ticket_fields' => $err_or_ticket->{'fields'},
3665     'ticket_id' => $p->{'ticket_id'},
3666   };
3667 }
3668
3669 sub adjust_ticket_priority {
3670   my $p = shift;
3671   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3672   return { 'error' => $session } if $context eq 'error';
3673
3674 #  warn "$me adjust_ticket_priority: initializing ticket system\n" if $DEBUG;
3675 #  FS::TicketSystem->init;
3676   my $ss_priority = FS::TicketSystem->selfservice_priority;
3677
3678   return { 'error' => 'adjust_ticket_priority configuration error' }
3679     if $FS::TicketSystem::system ne 'RT_Internal'
3680       or !$ss_priority;
3681
3682   my $values = $p->{'values'}; #hashref, id => priority value
3683   my %ticket_error;
3684
3685   foreach my $id (keys %$values) {
3686     warn "$me adjust_ticket_priority: fetching ticket $id\n" if $DEBUG;
3687     my $Ticket = FS::TicketSystem->get_ticket_object('',
3688       'ticket_id' => $id,
3689       'custnum'   => $custnum,
3690     );
3691     if ( !$Ticket ) {
3692       $ticket_error{$id} = 'ticket not found';
3693       next;
3694     }
3695
3696   # RT API stuff--would we gain anything by wrapping this in FS::TicketSystem?
3697   # We're not going to implement it for RT_External.
3698     my $old_value = $Ticket->FirstCustomFieldValue($ss_priority);
3699     my $new_value = $values->{$id};
3700     next if $old_value eq $new_value;
3701
3702     warn "$me adjust_ticket_priority: updating ticket $id\n" if $DEBUG;
3703
3704     # AddCustomFieldValue works fine (replacing any existing value) if it's
3705     # a single-valued custom field, which it should be.  If it's not, you're
3706     # doing something wrong.
3707     my ($val, $msg);
3708     if ( length($new_value) ) {
3709       ($val, $msg) = $Ticket->AddCustomFieldValue(
3710         Field => $ss_priority,
3711         Value => $new_value,
3712       );
3713     }
3714     else {
3715       ($val, $msg) = $Ticket->DeleteCustomFieldValue(
3716         Field => $ss_priority,
3717         Value => $old_value,
3718       );
3719     }
3720
3721     $ticket_error{$id} = $msg if !$val;
3722     warn "$me adjust_ticket_priority: $id: $msg\n" if $DEBUG and !$val;
3723   }
3724   return { 'error' => '',
3725            'ticket_error' => \%ticket_error,
3726            %{ customer_info($p) } # send updated customer info back
3727          }
3728 }
3729
3730 #--
3731
3732 sub _custoragent_session_custnum {
3733   my $p = shift;
3734
3735   my($context, $session, $custnum);
3736   if ( $p->{'session_id'} ) {
3737
3738     $context = 'customer';
3739     $session = _cache->get($p->{'session_id'})
3740       or return ( 'error' => "Can't resume session" ); #better error message
3741     $custnum = $session->{'custnum'};
3742
3743   } elsif ( $p->{'agent_session_id'} ) {
3744
3745     $context = 'agent';
3746     my $agent_cache = new FS::ClientAPI_SessionCache( {
3747       'namespace' => 'FS::ClientAPI::Agent',
3748     } );
3749     $session = $agent_cache->get($p->{'agent_session_id'})
3750       or return ( 'error' => "Can't resume session" ); #better error message
3751     $custnum = $p->{'custnum'};
3752
3753   } else {
3754     $context = 'error';
3755     return ( 'error' => "Can't resume session" ); #better error message
3756   }
3757
3758   ($context, $session, $custnum);
3759
3760 }
3761
3762 1;
3763