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