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