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