FS/FS/UI/Web.pm

   1 package FS::UI::Web;
   2
   3 use strict;
   4 use vars qw($DEBUG @ISA @EXPORT_OK $me);
   5 use Exporter;
   6 use FS::Conf;
   7 use FS::Record qw(dbdef);
   8 use FS::cust_main;  # are sql_balance and sql_date_balance in the right module?
   9
  10 #use vars qw(@ISA);
  11 #use FS::UI
  12 #@ISA = qw( FS::UI );
  13 @ISA = qw( Exporter );
  14
  15 @EXPORT_OK = qw( svc_url );
  16
  17 $DEBUG = 0;
  18 $me = '[FS::UID::Web]';
  19
  20 ###
  21 # date parsing
  22 ###
  23
  24 use Date::Parse;
  25 sub parse_beginning_ending {
  26   my($cgi, $prefix) = @_;
  27   $prefix .= '_' if $prefix;
  28
  29   my $beginning = 0;
  30   if ( $cgi->param($prefix.'begin') =~ /^(\d+)$/ ) {
  31     $beginning = $1;
  32   } elsif ( $cgi->param($prefix.'beginning') =~ /^([ 0-9\-\/]{1,64})$/ ) {
  33     $beginning = str2time($1) || 0;
  34   }
  35
  36   my $ending = 4294967295; #2^32-1
  37   if ( $cgi->param($prefix.'end') =~ /^(\d+)$/ ) {
  38     $ending = $1 - 1;
  39   } elsif ( $cgi->param($prefix.'ending') =~ /^([ 0-9\-\/]{1,64})$/ ) {
  40     #probably need an option to turn off the + 86399
  41     $ending = str2time($1) + 86399;
  42   }
  43
  44   ( $beginning, $ending );
  45 }
  46
  47 =item svc_url
  48
  49 Returns a service URL, first checking to see if there is a service-specific
  50 page to link to, otherwise to a generic service handling page.  Options are
  51 passed as a list of name-value pairs, and include:
  52
  53 =over 4
  54
  55 =item * m - Mason request object ($m)
  56
  57 =item * action - The action for which to construct "edit", "view", or "search"
  58
  59 =item ** part_svc - Service definition (see L<FS::part_svc>)
  60
  61 =item ** svcdb - Service table
  62
  63 =item *** query - Query string
  64
  65 =item *** svc   - FS::cust_svc or FS::svc_* object
  66
  67 =item ahref - Optional flag, if set true returns <A HREF="$url"> instead of just the URL.
  68
  69 =back
  70
  71 * Required fields
  72
  73 ** part_svc OR svcdb is required
  74
  75 *** query OR svc is required
  76
  77 =cut
  78
  79   # ##
  80   # #required
  81   # ##
  82   #  'm'        => $m, #mason request object
  83   #  'action'   => 'edit', #or 'view'
  84   #
  85   #  'part_svc' => $part_svc, #usual
  86   #   #OR
  87   #  'svcdb'    => 'svc_table',
  88   #
  89   #  'query'    => #optional query string
  90   #                # (pass a blank string if you want a "raw" URL to add your
  91   #                #  own svcnum to)
  92   #   #OR
  93   #  'svc'      => $svc_x, #or $cust_svc, it just needs a svcnum
  94   #
  95   # ##
  96   # #optional
  97   # ##
  98   #  'ahref'    => 1, # if set true, returns <A HREF="$url">
  99
 100 use FS::CGI qw(rooturl);
 101 sub svc_url {
 102   my %opt = @_;
 103
 104   #? return '' unless ref($opt{part_svc});
 105
 106   my $svcdb = $opt{svcdb} || $opt{part_svc}->svcdb;
 107   my $query = exists($opt{query}) ? $opt{query} : $opt{svc}->svcnum;
 108   my $url;
 109   warn "$me [svc_url] checking for /$opt{action}/$svcdb.cgi component"
 110     if $DEBUG;
 111   if ( $opt{m}->interp->comp_exists("/$opt{action}/$svcdb.cgi") ) {
 112     $url = "$svcdb.cgi?";
 113   } else {
 114
 115     my $generic = $opt{action} eq 'search' ? 'cust_svc' : 'svc_Common';
 116
 117     $url = "$generic.html?svcdb=$svcdb;";
 118     $url .= 'svcnum=' if $query =~ /^\d+(;|$)/ or $query eq '';
 119   }
 120
 121   import FS::CGI 'rooturl'; #WTF!  why is this necessary
 122   my $return = rooturl(). "$opt{action}/$url$query";
 123
 124   $return = qq!<A HREF="$return">! if $opt{ahref};
 125
 126   $return;
 127 }
 128
 129 sub svc_link {
 130   my($m, $part_svc, $cust_svc) = @_ or return '';
 131   svc_X_link( $part_svc->svc, @_ );
 132 }
 133
 134 sub svc_label_link {
 135   my($m, $part_svc, $cust_svc) = @_ or return '';
 136   svc_X_link( ($cust_svc->label)[1], @_ );
 137 }
 138
 139 sub svc_X_link {
 140   my ($x, $m, $part_svc, $cust_svc) = @_ or return '';
 141
 142   return $x
 143    unless $FS::CurrentUser::CurrentUser->access_right('View customer services');
 144
 145   my $ahref = svc_url(
 146     'ahref'    => 1,
 147     'm'        => $m,
 148     'action'   => 'view',
 149     'part_svc' => $part_svc,
 150     'svc'      => $cust_svc,
 151   );
 152
 153   "$ahref$x</A>";
 154 }
 155
 156 #this probably needs an ACL too...
 157 sub svc_export_links {
 158   my ($m, $part_svc, $cust_svc) = @_ or return '';
 159
 160   my $ahref = $cust_svc->export_links;
 161
 162   join('', @$ahref);
 163 }
 164
 165 sub parse_lt_gt {
 166   my($cgi, $field) = @_;
 167
 168   my @search = ();
 169
 170   my %op = (
 171     'lt' => '<',
 172     'gt' => '>',
 173   );
 174
 175   foreach my $op (keys %op) {
 176
 177     warn "checking for ${field}_$op field\n"
 178       if $DEBUG;
 179
 180     if ( $cgi->param($field."_$op") =~ /^\s*\$?\s*(-?[\d\,\s]+(\.\d\d)?)\s*$/ ) {
 181
 182       my $num = $1;
 183       $num =~ s/[\,\s]+//g;
 184       my $search = "$field $op{$op} $num";
 185       push @search, $search;
 186
 187       warn "found ${field}_$op field; adding search element $search\n"
 188         if $DEBUG;
 189     }
 190
 191   }
 192
 193   @search;
 194
 195 }
 196
 197 ###
 198 # cust_main report subroutines
 199 ###
 200
 201
 202 =item cust_header [ CUST_FIELDS_VALUE ]
 203
 204 Returns an array of customer information headers according to the supplied
 205 customer fields value, or if no value is supplied, the B<cust-fields>
 206 configuration value.
 207
 208 =cut
 209
 210 use vars qw( @cust_fields @cust_colors @cust_styles @cust_aligns );
 211
 212 sub cust_header {
 213
 214   warn "FS::UI:Web::cust_header called"
 215     if $DEBUG;
 216
 217   my $conf = new FS::Conf;
 218
 219   my %header2method = (
 220     'Customer'                 => 'name',
 221     'Cust. Status'             => 'ucfirst_cust_status',
 222     'Cust#'                    => 'custnum',
 223     'Name'                     => 'contact',
 224     'Company'                  => 'company',
 225     '(bill) Customer'          => 'name',
 226     '(service) Customer'       => 'ship_name',
 227     '(bill) Name'              => 'contact',
 228     '(service) Name'           => 'ship_contact',
 229     '(bill) Company'           => 'company',
 230     '(service) Company'        => 'ship_company',
 231     'Address 1'                => 'address1',
 232     'Address 2'                => 'address2',
 233     'City'                     => 'city',
 234     'State'                    => 'state',
 235     'Zip'                      => 'zip',
 236     'Country'                  => 'country_full',
 237     'Day phone'                => 'daytime', # XXX should use msgcat, but how?
 238     'Night phone'              => 'night',   # XXX should use msgcat, but how?
 239     'Fax number'               => 'fax',
 240     '(bill) Address 1'         => 'address1',
 241     '(bill) Address 2'         => 'address2',
 242     '(bill) City'              => 'city',
 243     '(bill) State'             => 'state',
 244     '(bill) Zip'               => 'zip',
 245     '(bill) Country'           => 'country_full',
 246     '(bill) Day phone'         => 'daytime', # XXX should use msgcat, but how?
 247     '(bill) Night phone'       => 'night',   # XXX should use msgcat, but how?
 248     '(bill) Fax number'        => 'fax',
 249     '(service) Address 1'      => 'ship_address1',
 250     '(service) Address 2'      => 'ship_address2',
 251     '(service) City'           => 'ship_city',
 252     '(service) State'          => 'ship_state',
 253     '(service) Zip'            => 'ship_zip',
 254     '(service) Country'        => 'ship_country_full',
 255     '(service) Day phone'      => 'ship_daytime', # XXX should use msgcat, how?
 256     '(service) Night phone'    => 'ship_night',   # XXX should use msgcat, how?
 257     '(service) Fax number'     => 'ship_fax',
 258     'Invoicing email(s)'       => 'invoicing_list_emailonly_scalar',
 259     'Payment Type'             => 'payby',
 260     'Current Balance'          => 'current_balance',
 261   );
 262   $header2method{'Cust#'} = 'display_custnum'
 263     if $conf->exists('cust_main-default_agent_custid');
 264
 265   my %header2colormethod = (
 266     'Cust. Status' => 'cust_statuscolor',
 267   );
 268   my %header2style = (
 269     'Cust. Status' => 'b',
 270   );
 271   my %header2align = (
 272     'Cust. Status' => 'c',
 273   );
 274
 275   my $cust_fields;
 276   my @cust_header;
 277   if ( @_ && $_[0] ) {
 278
 279     warn "  using supplied cust-fields override".
 280           " (ignoring cust-fields config file)"
 281       if $DEBUG;
 282     $cust_fields = shift;
 283
 284   } else {
 285
 286     if (    $conf->exists('cust-fields')
 287          && $conf->config('cust-fields') =~ /^([\w\. \|\#\(\)]+):?/
 288        )
 289     {
 290       warn "  found cust-fields configuration value"
 291         if $DEBUG;
 292       $cust_fields = $1;
 293     } else {
 294       warn "  no cust-fields configuration value found; using default 'Cust. Status | Customer'"
 295         if $DEBUG;
 296       $cust_fields = 'Cust. Status | Customer';
 297     }
 298
 299   }
 300
 301   @cust_header = split(/ \| /, $cust_fields);
 302   @cust_fields = map { $header2method{$_} || $_ } @cust_header;
 303   @cust_colors = map { exists $header2colormethod{$_}
 304                          ? $header2colormethod{$_}
 305                          : ''
 306                      }
 307                      @cust_header;
 308   @cust_styles = map { exists $header2style{$_} ? $header2style{$_} : '' }
 309                      @cust_header;
 310   @cust_aligns = map { exists $header2align{$_} ? $header2align{$_} : 'l' }
 311                      @cust_header;
 312
 313   #my $svc_x = shift;
 314   @cust_header;
 315 }
 316
 317 =item cust_sql_fields [ CUST_FIELDS_VALUE ]
 318
 319 Returns a list of fields for the SELECT portion of an SQL query.
 320
 321 As with L<the cust_header subroutine|/cust_header>, the fields returned are
 322 defined by the supplied customer fields setting, or if no customer fields
 323 setting is supplied, the <B>cust-fields</B> configuration value.
 324
 325 =cut
 326
 327 sub cust_sql_fields {
 328
 329   my @fields = qw( last first company );
 330   push @fields, map "ship_$_", @fields;
 331   push @fields, 'country';
 332
 333   cust_header(@_);
 334   #inefficientish, but tiny lists and only run once per page
 335
 336   my @add_fields = qw( address1 address2 city state zip daytime night fax );
 337   push @fields,
 338     grep { my $field = $_; grep { $_ eq $field } @cust_fields }
 339          ( @add_fields, ( map "ship_$_", @add_fields ), 'payby' );
 340
 341   my @extra_fields = ();
 342   if (grep { $_ eq 'current_balance' } @cust_fields) {
 343     push @extra_fields, FS::cust_main->balance_sql . " AS current_balance";
 344   }
 345
 346   map("cust_main.$_", @fields), @extra_fields;
 347 }
 348
 349 =item cust_fields OBJECT [ CUST_FIELDS_VALUE ]
 350
 351 Given an object that contains fields from cust_main (say, from a
 352 JOINed search.  See httemplate/search/svc_* for examples), returns an array
 353 of customer information, or "(unlinked)" if this service is not linked to a
 354 customer.
 355
 356 As with L<the cust_header subroutine|/cust_header>, the fields returned are
 357 defined by the supplied customer fields setting, or if no customer fields
 358 setting is supplied, the <B>cust-fields</B> configuration value.
 359
 360 =cut
 361
 362 sub cust_fields {
 363   my $record = shift;
 364   warn "FS::UI::Web::cust_fields called for $record ".
 365        "(cust_fields: @cust_fields)"
 366     if $DEBUG > 1;
 367
 368   #cust_header(@_) unless @cust_fields; #now need to cache to keep cust_fields
 369   #                                     #override incase we were passed as a sub
 370
 371   my $seen_unlinked = 0;
 372   map {
 373     if ( $record->custnum ) {
 374       warn "  $record -> $_"
 375         if $DEBUG > 1;
 376       $record->$_(@_);
 377     } else {
 378       warn "  ($record unlinked)"
 379         if $DEBUG > 1;
 380       $seen_unlinked++ ? '' : '(unlinked)';
 381     }
 382   } @cust_fields;
 383 }
 384
 385 =item cust_colors
 386
 387 Returns an array of subroutine references (or empty strings) for returning
 388 customer information colors.
 389
 390 As with L<the cust_header subroutine|/cust_header>, the fields returned are
 391 defined by the supplied customer fields setting, or if no customer fields
 392 setting is supplied, the <B>cust-fields</B> configuration value.
 393
 394 =cut
 395
 396 sub cust_colors {
 397   map {
 398     my $method = $_;
 399     if ( $method ) {
 400       sub { shift->$method(@_) };
 401     } else {
 402       '';
 403     }
 404   } @cust_colors;
 405 }
 406
 407 =item cust_styles
 408
 409 Returns an array of customer information styles.
 410
 411 As with L<the cust_header subroutine|/cust_header>, the fields returned are
 412 defined by the supplied customer fields setting, or if no customer fields
 413 setting is supplied, the <B>cust-fields</B> configuration value.
 414
 415 =cut
 416
 417 sub cust_styles {
 418   map {
 419     if ( $_ ) {
 420       $_;
 421     } else {
 422       '';
 423     }
 424   } @cust_styles;
 425 }
 426
 427 =item cust_aligns
 428
 429 Returns an array or scalar (depending on context) of customer information
 430 alignments.
 431
 432 As with L<the cust_header subroutine|/cust_header>, the fields returned are
 433 defined by the supplied customer fields setting, or if no customer fields
 434 setting is supplied, the <B>cust-fields</B> configuration value.
 435
 436 =cut
 437
 438 sub cust_aligns {
 439   if ( wantarray ) {
 440     @cust_aligns;
 441   } else {
 442     join('', @cust_aligns);
 443   }
 444 }
 445
 446 ###
 447 # begin JSRPC code...
 448 ###
 449
 450 package FS::UI::Web::JSRPC;
 451
 452 use strict;
 453 use vars qw($DEBUG);
 454 use Carp;
 455 use Storable qw(nfreeze);
 456 use MIME::Base64;
 457 use JSON;
 458 use FS::UID qw(getotaker);
 459 use FS::Record qw(qsearchs);
 460 use FS::queue;
 461
 462 $DEBUG = 0;
 463
 464 sub new {
 465         my $class = shift;
 466         my $self  = {
 467                 env => {},
 468                 job => shift,
 469                 cgi => shift,
 470         };
 471
 472         bless $self, $class;
 473
 474         croak "CGI object required as second argument" unless $self->{'cgi'};
 475
 476         return $self;
 477 }
 478
 479 sub process {
 480
 481   my $self = shift;
 482
 483   my $cgi = $self->{'cgi'};
 484
 485   # XXX this should parse JSON foo and build a proper data structure
 486   my @args = $cgi->param('arg');
 487
 488   #work around konqueror bug!
 489   @args = map { s/\x00$//; $_; } @args;
 490
 491   my $sub = $cgi->param('sub'); #????
 492
 493   warn "FS::UI::Web::JSRPC::process:\n".
 494        "  cgi=$cgi\n".
 495        "  sub=$sub\n".
 496        "  args=".join(', ',@args)."\n"
 497     if $DEBUG;
 498
 499   if ( $sub eq 'start_job' ) {
 500
 501     $self->start_job(@args);
 502
 503   } elsif ( $sub eq 'job_status' ) {
 504
 505     $self->job_status(@args);
 506
 507   } else {
 508
 509     die "unknown sub $sub";
 510
 511   }
 512
 513 }
 514
 515 sub start_job {
 516   my $self = shift;
 517
 518   warn "FS::UI::Web::start_job: ". join(', ', @_) if $DEBUG;
 519 #  my %param = @_;
 520   my %param = ();
 521   while ( @_ ) {
 522     my( $field, $value ) = splice(@_, 0, 2);
 523     unless ( exists( $param{$field} ) ) {
 524       $param{$field} = $value;
 525     } elsif ( ! ref($param{$field}) ) {
 526       $param{$field} = [ $param{$field}, $value ];
 527     } else {
 528       push @{$param{$field}}, $value;
 529     }
 530   }
 531   $param{CurrentUser} = getotaker();
 532   warn "FS::UI::Web::start_job\n".
 533        join('', map {
 534                       if ( ref($param{$_}) ) {
 535                         "  $_ => [ ". join(', ', @{$param{$_}}). " ]\n";
 536                       } else {
 537                         "  $_ => $param{$_}\n";
 538                       }
 539                     } keys %param )
 540     if $DEBUG;
 541
 542   #first get the CGI params shipped off to a job ASAP so an id can be returned
 543   #to the caller
 544
 545   my $job = new FS::queue { 'job' => $self->{'job'} };
 546
 547   #too slow to insert all the cgi params as individual args..,?
 548   #my $error = $queue->insert('_JOB', $cgi->Vars);
 549
 550   #warn 'froze string of size '. length(nfreeze(\%param)). " for job args\n"
 551   #  if $DEBUG;
 552
 553   my $error = $job->insert( '_JOB', encode_base64(nfreeze(\%param)) );
 554
 555   if ( $error ) {
 556
 557     warn "job not inserted: $error\n"
 558       if $DEBUG;
 559
 560     $error;  #this doesn't seem to be handled well,
 561              # will trigger "illegal jobnum" below?
 562              # (should never be an error inserting the job, though, only thing
 563              #  would be Pg f%*kage)
 564   } else {
 565
 566     warn "job inserted successfully with jobnum ". $job->jobnum. "\n"
 567       if $DEBUG;
 568
 569     $job->jobnum;
 570   }
 571
 572 }
 573
 574 sub job_status {
 575   my( $self, $jobnum ) = @_; #$url ???
 576
 577   sleep 1; # XXX could use something better...
 578
 579   my $job;
 580   if ( $jobnum =~ /^(\d+)$/ ) {
 581     $job = qsearchs('queue', { 'jobnum' => $jobnum } );
 582   } else {
 583     die "FS::UI::Web::job_status: illegal jobnum $jobnum\n";
 584   }
 585
 586   my @return;
 587   if ( $job && $job->status ne 'failed' ) {
 588     @return = ( 'progress', $job->statustext );
 589   } elsif ( !$job ) { #handle job gone case : job successful
 590                       # so close popup, redirect parent window...
 591     @return = ( 'complete' );
 592   } else {
 593     @return = ( 'error', $job ? $job->statustext : $jobnum );
 594   }
 595
 596   objToJson(\@return);
 597
 598 }
 599
 600 1;
 601