FS/FS/UI/Web.pm

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