add progressbar, redirection, and improve links RT#8274
authorjeff <jeff>
Tue, 1 Jun 2010 19:58:05 +0000 (19:58 +0000)
committerjeff <jeff>
Tue, 1 Jun 2010 19:58:05 +0000 (19:58 +0000)
FS/FS/CGI.pm
FS/FS/UI/Web.pm
FS/FS/queue.pm
FS/FS/tax_rate.pm
httemplate/elements/progress-popup.html
httemplate/search/report_newtax.html
httemplate/search/report_queued_newtax.cgi

index f33a718..9454784 100644 (file)
@@ -227,9 +227,15 @@ sub popurl {
 =cut
 
 sub rooturl {
 =cut
 
 sub rooturl {
-  # better to start with the client-provided URL
-  my $cgi = &FS::UID::cgi;
-  my $url_string = $cgi->isa('Apache') ? $cgi->uri : $cgi->url;
+  my $url_string;
+  if ( scalar(@_) ) {
+    $url_string = shift;
+  } else {
+    # better to start with the client-provided URL
+    my $cgi = &FS::UID::cgi;
+    $url_string = $cgi->isa('Apache') ? $cgi->uri : $cgi->url;
+  }
+
   $url_string =~ s/\?.*//;
 
   #even though this is kludgy
   $url_string =~ s/\?.*//;
 
   #even though this is kludgy
index 821b191..2d00d2c 100644 (file)
@@ -494,6 +494,7 @@ use JSON;
 use FS::UID qw(getotaker);
 use FS::Record qw(qsearchs);
 use FS::queue;
 use FS::UID qw(getotaker);
 use FS::Record qw(qsearchs);
 use FS::queue;
+use FS::CGI qw(rooturl);
 
 $DEBUG = 0;
 
 
 $DEBUG = 0;
 
@@ -565,6 +566,7 @@ sub start_job {
     }
   }
   $param{CurrentUser} = getotaker();
     }
   }
   $param{CurrentUser} = getotaker();
+  $param{RootURL} = rooturl($self->{cgi}->self_url);
   warn "FS::UI::Web::start_job\n".
        join('', map {
                       if ( ref($param{$_}) ) {
   warn "FS::UI::Web::start_job\n".
        join('', map {
                       if ( ref($param{$_}) ) {
@@ -620,13 +622,15 @@ sub job_status {
   }
 
   my @return;
   }
 
   my @return;
-  if ( $job && $job->status ne 'failed' ) {
+  if ( $job && $job->status ne 'failed' && $job->status ne 'done' ) {
     my ($progress, $action) = split ',', $job->statustext, 2; 
     $action ||= 'Server processing job';
     @return = ( 'progress', $progress, $action );
   } elsif ( !$job ) { #handle job gone case : job successful
                       # so close popup, redirect parent window...
     @return = ( 'complete' );
     my ($progress, $action) = split ',', $job->statustext, 2; 
     $action ||= 'Server processing job';
     @return = ( 'progress', $progress, $action );
   } elsif ( !$job ) { #handle job gone case : job successful
                       # so close popup, redirect parent window...
     @return = ( 'complete' );
+  } elsif ( $job->status eq 'done' ) {
+    @return = ( 'done', $job->statustext, '' );
   } else {
     @return = ( 'error', $job ? $job->statustext : $jobnum );
   }
   } else {
     @return = ( 'error', $job ? $job->statustext : $jobnum );
   }
index 99e349c..3f8763d 100644 (file)
@@ -12,7 +12,7 @@ use FS::Record qw( qsearch qsearchs dbh );
 use FS::queue_arg;
 use FS::queue_depend;
 use FS::cust_svc;
 use FS::queue_arg;
 use FS::queue_depend;
 use FS::cust_svc;
-use FS::CGI qw (rooturl);
+use FS::CGI qw(rooturl);
 
 @ISA = qw(FS::Record);
 @EXPORT_OK = qw( joblisting );
 
 @ISA = qw(FS::Record);
 @EXPORT_OK = qw( joblisting );
@@ -67,6 +67,20 @@ Job status (new, locked, or failed)
 
 Freeform text status message
 
 
 Freeform text status message
 
+=cut
+
+sub statustext {
+  my $self = shift;
+  if ( defined ( $_[0] ) ) {
+    $self->SUPER::statustext(@_);
+  } else {
+    my $value = $self->SUPER::statustext();
+    my $rooturl = rooturl();
+    $value =~ s/%%%ROOTURL%%%/$rooturl/g; 
+    $value;
+  }
+}
+
 =item _date
 
 UNIX timestamp
 =item _date
 
 UNIX timestamp
@@ -363,7 +377,7 @@ If there is an error, returns the error, otherwise returns false.
 use vars qw($_update_statustext_dbh);
 sub update_statustext {
   my( $self, $statustext ) = @_;
 use vars qw($_update_statustext_dbh);
 sub update_statustext {
   my( $self, $statustext ) = @_;
-  return '' if $statustext eq $self->statustext;
+  return '' if $statustext eq $self->get('statustext'); #avoid rooturl expansion
   warn "updating statustext for $self to $statustext" if $DEBUG;
 
   $_update_statustext_dbh ||= myconnect;
   warn "updating statustext for $self to $statustext" if $DEBUG;
 
   $_update_statustext_dbh ||= myconnect;
@@ -374,7 +388,7 @@ sub update_statustext {
 
   $sth->execute($statustext, $self->jobnum) or return $sth->errstr;
   $_update_statustext_dbh->commit or die $_update_statustext_dbh->errstr;
 
   $sth->execute($statustext, $self->jobnum) or return $sth->errstr;
   $_update_statustext_dbh->commit or die $_update_statustext_dbh->errstr;
-  $self->statustext($statustext);
+  $self->set('statustext', $statustext); #avoid rooturl expansion
   '';
 
   #my $new = new FS::queue { $self->hash };
   '';
 
   #my $new = new FS::queue { $self->hash };
index 94ba9db..04780da 100644 (file)
@@ -27,8 +27,6 @@ use FS::part_pkg_taxproduct;
 use FS::cust_main;
 use FS::Misc qw( csv_from_fixed );
 
 use FS::cust_main;
 use FS::Misc qw( csv_from_fixed );
 
-#i'd like to dump these
-use FS::CGI qw(rooturl popurl);
 use URI::Escape;
 
 @ISA = qw( FS::Record );
 use URI::Escape;
 
 @ISA = qw( FS::Record );
@@ -1767,17 +1765,21 @@ Launches a tax liability report.
 =cut
 
 sub queue_liability_report {
 =cut
 
 sub queue_liability_report {
-  my $cgi = shift;
+  my $job = shift;
+  my $param = thaw(decode_base64(shift));
+
+  my $cgi = new CGI;
+  $cgi->param('beginning', $param->{beginning});
+  $cgi->param('ending', $param->{ending});
   my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
   my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
-  my $agentnum = $cgi->param('agentnum');
+  my $agentnum = $param->{agentnum};
   $agentnum =~ /^(\d+)$/ ? $agentnum = $1 : $agentnum = '';
   $agentnum =~ /^(\d+)$/ ? $agentnum = $1 : $agentnum = '';
-  my $job = new FS::queue { job => 'FS::tax_rate::generate_liability_report' };
-  $job->insert(
+  generate_liability_report(
     'beginning' => $beginning,
     'ending'    => $ending,
     'agentnum'  => $agentnum,
     'beginning' => $beginning,
     'ending'    => $ending,
     'agentnum'  => $agentnum,
-    'p'         => popurl(2),
-    'rooturl'   => rooturl,
+    'p'         => $param->{RootURL},
+    'job'       => $job,
   );
 }
 
   );
 }
 
@@ -1791,6 +1793,8 @@ agentnum, beginning, and ending
 sub generate_liability_report {
   my %args = @_;
 
 sub generate_liability_report {
   my %args = @_;
 
+  my ( $count, $last, $min_sec ) = _progressbar_foo();
+
   #let us open the temp file early
   my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc;
   my $report = new File::Temp( TEMPLATE => 'report.tax.liability.XXXXXXXX',
   #let us open the temp file early
   my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc;
   my $report = new File::Temp( TEMPLATE => 'report.tax.liability.XXXXXXXX',
@@ -1845,14 +1849,25 @@ sub generate_liability_report {
   my $credit = 0;
   my %taxes = ();
   my %basetaxes = ();
   my $credit = 0;
   my %taxes = ();
   my %basetaxes = ();
-  foreach my $t (qsearch({ table     => 'cust_bill_pkg',
-                           select    => $select,
-                           hashref   => { pkgpart => 0 },
-                           addl_from => $addl_from,
-                           extra_sql => $where,
-                        })
-                )
-  {
+  my $calculated = 0;
+  my @tax_and_location = qsearch({ table     => 'cust_bill_pkg',
+                                   select    => $select,
+                                   hashref   => { pkgpart => 0 },
+                                   addl_from => $addl_from,
+                                   extra_sql => $where,
+                                });
+  $count = scalar(@tax_and_location);
+  foreach my $t ( @tax_and_location ) {
+
+    if ( $args{job} ) {
+      if ( time - $min_sec > $last ) {
+        $args{job}->update_statustext( int( 100 * $calculated / $count ).
+                                       ",Calculated"
+                                     );
+        $last = time;
+      }
+    }
+
     my @params = map { my $f = $_; $f =~ s/.*\.//; $f } @taxparam;
     my $label = join('~', map { $t->$_ } @params);
     $label = 'Tax'. $label if $label =~ /^~/;
     my @params = map { my $f = $_; $f =~ s/.*\.//; $f } @taxparam;
     my $label = join('~', map { $t->$_ } @params);
     $label = 'Tax'. $label if $label =~ /^~/;
@@ -1894,6 +1909,12 @@ sub generate_liability_report {
 
 
   #ordering
 
 
   #ordering
+
+  if ( $args{job} ) {
+    $args{job}->update_statustext( "0,Sorted" );
+    $last = time;
+  }
+
   my @taxes = ();
 
   foreach my $tax ( sort { $a cmp $b } keys %taxes ) {
   my @taxes = ();
 
   foreach my $tax ( sort { $a cmp $b } keys %taxes ) {
@@ -1951,8 +1972,19 @@ EOF
   my $bgcolor2 = '#ffffff';
   my $bgcolor = '';
  
   my $bgcolor2 = '#ffffff';
   my $bgcolor = '';
  
+  $count = scalar(@taxes);
+  $calculated = 0;
   foreach my $tax ( @taxes ) {
  
   foreach my $tax ( @taxes ) {
  
+    if ( $args{job} ) {
+      if ( time - $min_sec > $last ) {
+        $args{job}->update_statustext( int( 100 * $calculated / $count ).
+                                       ",Generated"
+                                     );
+        $last = time;
+      }
+    }
+
     if ( $bgcolor eq $bgcolor1 ) {
       $bgcolor = $bgcolor2;
     } else {
     if ( $bgcolor eq $bgcolor1 ) {
       $bgcolor = $bgcolor2;
     } else {
@@ -1989,7 +2021,7 @@ EOF
   my $dropstring = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/report.';
   $reportname =~ s/^$dropstring//;
 
   my $dropstring = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/report.';
   $reportname =~ s/^$dropstring//;
 
-  my $reporturl = $args{rooturl}. "/misc/queued_report?report=$reportname";
+  my $reporturl = "%%%ROOTURL%%%/misc/queued_report?report=$reportname";
   die "<a href=$reporturl>view</a>\n";
 
 }
   die "<a href=$reporturl>view</a>\n";
 
 }
index 8a55efb..a292102 100644 (file)
@@ -69,6 +69,14 @@ function updateStatus( status_statustext ) {
     alert('job done but no url or message specified');
 % } 
 
     alert('job done but no url or message specified');
 % } 
 
+  } else if ( status.indexOf('done') > -1 ) {
+
+    document.getElementById("progress_message").innerHTML = "Loading report";
+    document.getElementById("progress_bar").innerHTML = '';
+    document.getElementById("progress_percent").innerHTML = '';
+    document.getElementById("progress_jobnum").innerHTML = '';
+    window.top.location.href = statustext.substr(8, statustext.length-18);
+
   } else if ( status.indexOf('error') > -1 ) {
     document.getElementById("progress_message").innerHTML = '<FONT SIZE="+1" COLOR="#FF0000">Error: ' + statustext + '</FONT>';
     document.getElementById("progress_bar").innerHTML = '';
   } else if ( status.indexOf('error') > -1 ) {
     document.getElementById("progress_message").innerHTML = '<FONT SIZE="+1" COLOR="#FF0000">Error: ' + statustext + '</FONT>';
     document.getElementById("progress_bar").innerHTML = '';
index 2588b48..da39b0c 100755 (executable)
@@ -1,6 +1,6 @@
 <% include('/elements/header.html', 'Tax Report' ) %>
 
 <% include('/elements/header.html', 'Tax Report' ) %>
 
-<FORM ACTION="report_queued_newtax.cgi" METHOD="GET">
+<FORM NAME="newtax">
 
 <TABLE>
 
 
 <TABLE>
 
 
 </TABLE>
 
 
 </TABLE>
 
-<BR><INPUT TYPE="submit" VALUE="Get Report">
+<BR><INPUT TYPE="button" VALUE="Get Report" onClick="document.newtax.submit.disabled=true; process();">
 
 </FORM>
 
 
 </FORM>
 
+<% include( '/elements/progress-init.html',
+            'newtax',
+            [ qw( agentnum beginning ending ) ],
+            'report_queued_newtax.cgi',
+          )
+%>
+
 <% include('/elements/footer.html') %>
 <%init>
 
 <% include('/elements/footer.html') %>
 <%init>
 
index 1d5813e..a375fce 100755 (executable)
@@ -1,16 +1,10 @@
-<% include("/elements/header.html", "Queue Tax Report") %>
-<% include("/elements/error.html") %>
-% unless ($error) {
-  <CENTER>
-  Report queued.  Check the job queue for status.
-  </CENTER>
-% }
-<% include("/elements/footer.html") %>
+<% $server->process %>
 <%init>
 
 die "access denied"
   unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
 
 <%init>
 
 die "access denied"
   unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
 
-my $error = FS::tax_rate::queue_liability_report($cgi);
+my $server =
+   new FS::UI::Web::JSRPC 'FS::tax_rate::queue_liability_report', $cgi;
 
 </%init>
 
 </%init>