combine ticket notification scrips, #15353
[freeside.git] / httemplate / elements / progress-init.html
index ba9f6ed..2ec248e 100644 (file)
@@ -1,45 +1,82 @@
-<%
-  my( $formname, $fields, $action, $url_or_message, $key ) = @_;
-  $key = '' unless defined $key;
-
-  my $url_or_message_link;
-  if ( ref($url_or_message) ) { #its a message or something
-    $url_or_message_link =
-      'message='. uri_escape( $url_or_message->{'message'} )
-  } else {
-    $url_or_message_link = "url=$url_or_message";
-  }
-%>
+<%doc>
+Example:
+In misc/something.html:
+
+  <FORM NAME="MyForm">
+  <INPUT TYPE="hidden" NAME="recordnum" VALUE="42">
+  <INPUT TYPE="hidden" NAME="what_to_do" VALUE="delete">
+  <% include( '/elements/progress-init.html',
+             'MyForm', 
+             [ 'recordnum', 'what_to_do' ],
+             $p.'misc/process_something.html',
+             { url => $p.'where_to_go_next.html' },
+         #or { message => 'Finished!' },
+         #or { url => $p.'where_to_go.html',
+               message => 'Finished' },
+         # which displays the message, then waits for confirmation before 
+         # redirecting to the URL.
+         #or { popup_url => $p.'popup_contents.html' }
+         # which loads that URL into the popup after completion
+         ) %>
+  </FORM>
+  <SCRIPT TYPE="text/javascript>process();</SCRIPT>
+
+In misc/process_something.html:
+
+<%init>
+my $server = FS::UI::Web::JSRPC->new('FS::something::process_whatever', $cgi);
+</%init>
+<% $server->process %>
 
-<%= include('/elements/xmlhttp.html',
+In FS/something.pm:
+
+sub process_whatever { #class method
+  my $job = shift;
+  my $param = thaw(base64_decode(shift));
+  # param = { 'recordnum' => 42, 'what_to_do' => delete }
+  # make use of this as you like
+  do_phase1;
+  $job->update_statustext(20);
+  do_phase2;
+  $job->update_statustext(40);
+  do_phase3;
+  $job->update_statustext(60);
+  # etc.
+  return 'this value will be ignored';
+}
+
+</%doc>
+<% include('/elements/xmlhttp.html',
               'method' => 'POST',
               'url'    => $action,
-              'subs'   => [ $key.'start_job' ],
+              'subs'   => [ 'start_job' ],
+              'key'    => $key,
            )
 %>
-<SCRIPT TYPE="text/javascript" SRC="../elements/overlibmws.js"></SCRIPT>
-<SCRIPT TYPE="text/javascript" SRC="../elements/overlibmws_iframe.js"></SCRIPT>
+
+% if (!$noinit) { 
+<& /elements/init_overlib.html &>
+%   $noinit = 1;
+% }
+
 <SCRIPT TYPE="text/javascript">
-function OLiframeContent(src, width, height, name) {
-  return ('<iframe src="'+src+'" width="'+width+'" height="'+height+'"'
-   +(name?' name="'+name+'" id="'+name+'"':'')+' scrolling="auto">'
-   +'<div>[iframe not supported]</div></iframe>');
-}
 
-function <%=$key%>process () {
+function <%$key%>process () {
 
-  //alert('<%=$key%>process for form <%=$formname%>');
+  //alert('<%$key%>process for form <%$formname%>');
 
-  document.<%=$formname%>.submit.disabled=true;
+  if ( document.<%$formname%>.submit.disabled == false ) {
+    document.<%$formname%>.submit.disabled=true;
+  }
 
   overlib( 'Submitting job to server...', WIDTH, 444, HEIGHT, 168, CAPTION, 'Please wait...', STICKY, AUTOSTATUSCAP, CLOSETEXT, '', CLOSECLICK, MIDX, 0, MIDY, 0 );
 
   var Hash = new Array();
   var x = 0;
   var fieldName;
-  for (var i = 0; i<document.<%=$formname%>.elements.length; i++) {
-    field  = document.<%=$formname%>.elements[i];
-    if ( <%= join(' || ', map { "(field.name.indexOf('$_') > -1)" } @$fields ) %>
+  for (var i = 0; i<document.<%$formname%>.elements.length; i++) {
+    field  = document.<%$formname%>.elements[i];
+    if ( <% join(' || ', map { "(field.name.indexOf('$_') > -1)" } @$fields ) %>
        )
     {
         if ( field.type == 'select-multiple' ) {
@@ -53,7 +90,7 @@ function <%=$key%>process () {
           }
         } else if (    ( field.type != 'radio'  && field.type != 'checkbox' )
                     || ( ( field.type == 'radio' || field.type == 'checkbox' )
-                         && document.<%=$formname%>.elements[i].checked
+                         && document.<%$formname%>.elements[i].checked
                        )
                   )
         {
@@ -64,18 +101,44 @@ function <%=$key%>process () {
   }
 
   // jsrsPOST = true;
-  // jsrsExecute( '<%= $action %>', <%=$key%>myCallback, 'start_job', Hash );
+  // jsrsExecute( '<% $action %>', <%$key%>myCallback, 'start_job', Hash );
 
-  //alert('start_job( ' + Hash + ', <%=$key%>myCallback )' );
+  //alert('start_job( ' + Hash + ', <%$key%>myCallback )' );
   //alert('start_job()' );
-  <%=$key%>start_job( Hash, <%=$key%>myCallback );
+  <%$key%>start_job( Hash, <%$key%>myCallback );
 
 }
 
-function <%=$key%>myCallback( jobnum ) {
+function <%$key%>myCallback( jobnum ) {
 
-  overlib( OLiframeContent('<%=$p%>elements/progress-popup.html?jobnum=' + jobnum + ';<%=$url_or_message_link%>;formname=<%=$formname%>' , 444, 168, 'progress_popup'), CAPTION, 'Please wait...', STICKY, AUTOSTATUSCAP, CLOSETEXT, '', CLOSECLICK, MIDX, 0, MIDY, 0 );
+  overlib( OLiframeContent('<%$p%>elements/progress-popup.html?jobnum=' + jobnum + ';<%$url_or_message_link%>;formname=<%$formname%>' , 444, 168, '<% $popup_name %>'), CAPTION, 'Please wait...', STICKY, AUTOSTATUSCAP, CLOSETEXT, '', CLOSECLICK, MIDX, 0, MIDY, 0 );
 
 }
 
 </SCRIPT>
+
+<%once>
+my $noinit = 0;
+</%once>
+<%init>
+
+my( $formname, $fields, $action, $url_or_message, $key ) = @_;
+$key = '' unless defined $key;
+
+my $url_or_message_link;
+if ( ref($url_or_message) ) { #its a message or something
+  $url_or_message_link = 'message='. uri_escape( $url_or_message->{'message'} );
+  $url_or_message_link .= ';url='.   uri_escape( $url_or_message->{'url'} )
+    if $url_or_message->{'url'};
+  $url_or_message_link = 'popup_url=' .uri_escape( $url_or_message->{'popup_url'} )
+    if $url_or_message->{'popup_url'};
+
+} else {
+  $url_or_message_link = "url=$url_or_message";
+}
+
+#stupid safari is caching the "location" of popup iframs, and submitting them
+#instead of displaying them.  this should prevent that.
+my $popup_name = 'popup-'.time. "-$$-". rand() * 2**32;
+
+</%init>