[BACK]Return to lonwrapper.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / rat

Diff for /rat/lonwrapper.pm between versions 1.49.2.12 and 1.73

version 1.49.2.12, 2024/07/04 02:30:39 version 1.73, 2020/02/16 23:07:36
Line 37  use Apache::lonlocal; Line 37  use Apache::lonlocal;
 use Apache::loncommon();  use Apache::loncommon();
 use Apache::lonhtmlcommon();  use Apache::lonhtmlcommon();
 use Apache::lonextresedit();  use Apache::lonextresedit();
   use Apache::lonexttool();
   use Apache::lonhomework();
   use LONCAPA qw(:DEFAULT :match);
   use HTML::Entities();
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
 sub wrapper {  sub wrapper {
     my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title) = @_;      my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
           $title,$width,$height) = @_;
   
     my $forcereg;      my $forcereg;
     unless ($env{'form.folderpath'}) {      unless ($env{'form.folderpath'}) {
         $forcereg = 1;          $forcereg = 1;
     }      }
   
     my %lt = &Apache::lonlocal::texthash(      my %lt = &Apache::lonlocal::texthash(
                                           'noif' => 'No iframe support.',                                            'noif' => 'No iframe support.',
                                           'show' => 'Show content in pop-up window',                                            'show' => 'Show content in pop-up window',
                                         );                                          );
   
     (undef,undef,undef,undef,undef,undef,my $clientmobile) =      my ($anchor,$uselink);
         &Apache::loncommon::decode_user_agent($r);  
   
     my ($anchor,$uselink,$linktext);  
     if ($is_ext) {      if ($is_ext) {
         if ($env{'form.symb'}) {          if ($env{'form.symb'}) {
             (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});              (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
Line 65  sub wrapper { Line 66  sub wrapper {
         } elsif ($env{'form.anchor'} ne '') {          } elsif ($env{'form.anchor'} ne '') {
             $anchor = '#'.$env{'form.anchor'};              $anchor = '#'.$env{'form.anchor'};
         }          }
         unless (($is_pdf) && ($clientmobile)) {          unless (($is_pdf) && ($env{'browser.mobile'})) {
             my $hostname = $r->hostname();              my $hostname = $r->hostname();
             my $lonhost = $r->dir_config('lonHostID');              my $lonhost = $r->dir_config('lonHostID');
             my $ip = &Apache::lonnet::get_host_ip($lonhost);              my $ip = &Apache::lonnet::get_host_ip($lonhost);
Line 73  sub wrapper { Line 74  sub wrapper {
         }          }
     }      }
   
     my $noiframe = &Apache::loncommon::modal_link(&HTML::Entities::encode($url.$anchor,'&<>"\''),$lt{'show'},500,400);      my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
     my $args = {'bgcolor' => '#FFFFFF'};      my $args = {'bgcolor' => '#FFFFFF'};
     if ($forcereg) {      if ($forcereg) {
         $args->{'force_register'} = $forcereg;          $args->{'force_register'} = $forcereg;
Line 88  sub wrapper { Line 89  sub wrapper {
         $args->{'only_body'} = $env{'form.only_body'};          $args->{'only_body'} = $env{'form.only_body'};
     }      }
   
     my $headjs;      my ($countdown,$donemsg,$headjs);
       if (($exttool) && (&Apache::lonnet::EXT('resource.0.gradable') =~ /^yes$/i)) {
           $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$url);
           if ($env{'form.markaccess'}) {
               my $symb=&Apache::lonnet::symbread($url);
               my @interval=&Apache::lonnet::EXT('resource.0.interval',$symb);
               my ($timelimit) = split(/_/,$interval[0]);
               my $setres = &Apache::lonnet::set_first_access($interval[1],$timelimit);
               if ($setres eq 'ok') {
                   delete($env{'form.markaccess'});
               }
           } elsif ($env{'form.LC_interval_done'} eq 'true') {
               my $symb=&Apache::lonnet::symbread($url);
               if ($symb) {
                   (my $donebuttonresult,$donemsg) = &Apache::lonhomework::zero_timer($symb);
                   undef($env{'form.LC_interval_done'});
                   undef($env{'form.LC_interval_done_proctorpass'});
               }
           }
           my ($status,$result,$resource_due) =
               &Apache::lonexttool::gradabletool_access_check();
           undef($Apache::lonhomework::browse);
           if ($status eq 'CAN_ANSWER') {
               if ($resource_due) {
                   my $time_left = $resource_due - time();
                   if ($resource_due && ($time_left > 0)) {
                       $countdown ='
   <script type="text/javascript">
   // <![CDATA['."\n".
                                &Apache::lonhtmlcommon::countdown().'
   // ]]>
   </script>'."\n".
                       &Apache::lonhtmlcommon::set_due_date($resource_due);
                   }
               }
           } else {
               if ($status eq 'SHOW_ANSWER') {
                   $result = &Apache::lonexttool::display_score().
                             &Apache::lonfeedback::list_discussion('tool','OPEN');
               }
               return &Apache::loncommon::start_page('Menu',undef,$args).
                      $result.
                      &Apache::loncommon::end_page();
           }
       }
   
 #  #
 # Where iframe is in use, if window.onload() executes before the custom resize function  # Where iframe is in use, if window.onload() executes before the custom resize function
Line 97  sub wrapper { Line 142  sub wrapper {
 # do not obscure the Functions menu.  # do not obscure the Functions menu.
 #  #
   
     unless ($clientmobile || $uselink) {      unless (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
         $headjs = '          $headjs = '
 <script type="text/javascript">  <script type="text/javascript">
 // <![CDATA[  // <![CDATA[
Line 105  var LCnotready = 0; Line 150  var LCnotready = 0;
 var LCresizedef = 0;  var LCresizedef = 0;
 // ]]>  // ]]>
 </script>'."\n";  </script>'."\n";
     }  
   
     my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args);      my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args).$countdown.$donemsg;
     my $endpage = &Apache::loncommon::end_page();      my $endpage = &Apache::loncommon::end_page();
   
     if (($uselink) && ($title eq '')) {      if (($uselink) && ($title eq '')) {
Line 120  var LCresizedef = 0; Line 164  var LCresizedef = 0;
             }              }
         }          }
     }      }
     if ($clientmobile) {      if (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab')) {
         my $output = $startpage;          my $output = $startpage;
         if ($is_pdf) {          if ($is_pdf) {
             $linktext = &mt('Link to PDF (for mobile devices)');              $linktext = &mt('Link to PDF (for mobile devices)');
             $output .= &create_link($url,$anchor,$title,$linktext);              $output .= &create_link($url,$anchor,$title,$linktext);
           } elsif (($exttool eq 'window') || ($exttool eq 'tab')) {
               if ($linktext eq '') {
                   $linktext = &mt('Launch External Tool');
               }
               $url = &HTML::Entities::encode($url,'"<>&');
               if ($exttool eq 'tab') {
                   $output .= '<div>'.
                              '<a href="'.$url.'" target="LCExternalToolTab" style="padding:0;clear:both;margin:0;border:0">'.
                              $linktext.'</a>'.
                              '</div>';
               } else {
                   $output .= <<"ENDLINK";
   <script type="text/javascript">
   // <![CDATA[
   var windowObjectReference = null;
   var PreviousUrl;
   
   function openSinglePopup(strUrl) {
       if (windowObjectReference == null || windowObjectReference.closed) {
           windowObjectReference = window.open(strUrl, "LCExternalToolPopUp",
                                               "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");
       } else if(PreviousUrl != strUrl) {
           windowObjectReference = window.open(strUrl, "LCExternalToolPopUp",
                                               "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");
           windowObjectReference.focus();
       } else {
           windowObjectReference.focus();
       };
       PreviousUrl = strUrl;
   }
   // ]]>
   </script>
   <div>
   <a href="$url" target="LCExternalToolPopUp" onclick="openSinglePopup(this.href); return false;">
   $linktext</a>
   </div>
   ENDLINK
               }
               if ($explanation ne '') {
                   $output .= '<div>'.$explanation.'</div>';
               }
               if (&Apache::lonnet::EXT('resource.0.gradable')) {
                   $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');
               }
         } else {          } else {
             if ($uselink) {              if ($uselink) {
                 $linktext = &mt('Link to resource');                  $linktext = &mt('Link to resource');
Line 178  var LCresizedef = 0; Line 266  var LCresizedef = 0;
             }              }
         });          });
         window.onload = function(){          window.onload = function(){
             if (LCresizedef) {               if (LCresizedef) {
                 LCnotready = 0;                   LCnotready = 0;
                 \$(window).trigger('resize');                   \$(window).trigger('resize') };
             } else {               } else {
                 LCnotready = 1;                   LCnotready = 1;
             }               }
         };          };
 SCRIPT  SCRIPT
         # javascript will position the iframe if window was resized (or zoomed)          # javascript will position the iframe if window was resized (or zoomed)
           my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
         return <<ENDFRAME;          return <<ENDFRAME;
         $startpage          $startpage
         $script          $script
         <div class="LC_iframecontainer">          <div class="LC_iframecontainer">
             <iframe src="$url$anchor">$lt{'noif'} $noiframe</iframe>              <iframe src="$dest">$lt{'noif'} $noiframe</iframe>
         </div>          </div>
         $endpage          $endpage
 ENDFRAME  ENDFRAME
Line 226  sub handler { Line 315  sub handler {
     return OK if $r->header_only;      return OK if $r->header_only;
   
     my $url = $r->uri;      my $url = $r->uri;
     my ($is_ext,$brcrum,$absolute,$is_pdf,$cdom,$cnum,$hostname);      my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
           $linktext,$explanation,$width,$height);
   
     for ($url){      for ($url){
         s|^/adm/wrapper||;          s|^/adm/wrapper||;
         $is_ext = $_ =~ s|^/ext/|http://|;          $is_ext = $_ =~ s|^/ext/|http://|;
         s|http://https://|https://| if ($is_ext);          s|http://https://?|https://| if ($is_ext);
         s|&colon;|:|g;          s|&colon;|:|g;
     }      }
   
     if ($url =~ /\.pdf$/i) {      if ($url =~ /\.pdf$/i) {
         $is_pdf = 1;          $is_pdf = 1;
       } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
           $cdom = $1;
           $cnum = $2;
           my $marker = $3;
           $exttool = 'iframe';
           my $exttoolremote;
           my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation','id','width','height'],
                                               $cdom,$cnum);
           if ($toolhash{'id'}) {
               my %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');
               if (ref($ltitools{$toolhash{'id'}}) eq 'HASH') {
                   $exttoolremote = $ltitools{$toolhash{'id'}}{'url'};
               }
           }
           if ($toolhash{'target'} eq 'window') {
               $exttool = 'window';
               $width = $toolhash{'width'};
               $height = $toolhash{'height'};
           } elsif ($toolhash{'target'} eq 'tab') {
               $exttool = 'tab';
           }
           if (($exttool eq 'window') || ($exttool eq 'tab')) {
               $linktext = $toolhash{'linktext'};
               $explanation = $toolhash{'explanation'};
           } elsif (($exttoolremote =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
               $exttool = 'tab';
           }
     }      }
        if (($is_ext) || ($exttool)) {
     if ($is_ext) {  
         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},          &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
             ['forceedit','register','folderpath','symb','idx','title','anchor']);              ['forceedit','register','folderpath','symb','idx','title','anchor']);
         if (($env{'form.forceedit'}) &&          if (($env{'form.forceedit'}) &&
Line 256  sub handler { Line 372  sub handler {
                     $url .= '#'.$env{'form.anchor'};                      $url .= '#'.$env{'form.anchor'};
                 }                  }
             }              }
             if (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {              my $type = 'ext';
               if ($exttool) {
                   $type = 'tool';
               } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
                 $hostname = $r->hostname();                  $hostname = $r->hostname();
             }              }
             my $type = 'ext';  
             $r->print(              $r->print(
                 &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},                  &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
                                                        $env{'form.symb'},                                                         $env{'form.symb'},
Line 270  sub handler { Line 388  sub handler {
             my $crstype = &Apache::loncommon::course_type();              my $crstype = &Apache::loncommon::course_type();
             my $title = $env{'form.title'};              my $title = $env{'form.title'};
             if ($title eq '') {              if ($title eq '') {
                 $title = &mt('External Resource');                  if ($is_ext) {
                       $title = &mt('External Resource');
                   } else {
                       $title = &mt('External Tool');
                   }
             }              }
             $brcrum =              $brcrum =
                 &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);                  &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
Line 280  sub handler { Line 402  sub handler {
 #  #
 # Actual URL  # Actual URL
 #  #
     if ($url=~/$LONCAPA::assess_re/) {      if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
 #  #
 # This is uploaded homework  # This is uploaded homework
 #  #
Line 290  sub handler { Line 412  sub handler {
 #  #
 # This is not homework  # This is not homework
 #  #
         if ($is_ext) {          if (($is_ext) || ($exttool)) {
             $absolute = $env{'request.use_absolute'};              $absolute = $env{'request.use_absolute'};
             $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;              $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
             $ENV{'QUERY_STRING'} =~ s/\&$//;              $ENV{'QUERY_STRING'} =~ s/\&$//;
Line 301  sub handler { Line 423  sub handler {
         }          }
   
         # encrypt url if not external          # encrypt url if not external
         &Apache::lonenc::check_encrypt(\$url) if $url !~ /^https?\:/ ;          unless ($is_ext) {
               &Apache::lonenc::check_encrypt(\$url);
           }
   
         $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf) );          $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
                              $linktext,$explanation,undef,$width,$height) );
   
     } # not just the menu      } # not just the menu
           
Line 330  described at http://www.lon-capa.org. Line 455  described at http://www.lon-capa.org.
   
 =over  =over
   
 =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title))  =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height)
   
 =over  =over
   
Line 340  request object Line 465  request object
   
 =item $url  =item $url
   
 url to display by including in an iframe within a  url to display either by including in an iframe within a
 LON-CAPA page which has a standard LON-CAPA inline menu.  LON-CAPA page which has a standard LON-CAPA inline menu,
   or in some cases launched in a separate tab or window,
   launched via a link in a LON-CAPA page with standard inline
   menu.
   
 =item $brcrum  =item $brcrum
   
Line 376  true if URL is for an external resource. Line 504  true if URL is for an external resource.
   
 true if URL is for a PDF (based on file extension).  true if URL is for a PDF (based on file extension).
   
   =item $exttool
   
   If URL is for an External Tool, will contain the target type: iframe, window or tab.
   
   =item $linktext
   
   optional. If URL is for an External Tool, and target type is window or tab, 
   then the link text may be an option set in the course for each tool instance,
   or may be a default defined in the domain for all instances of the tool.
   
   =item $explanation
   
   optional. If URL is for an External Tool, and target type is window or tab, 
   then the explanation is an option set in the course for each tool instance,
   or may be a default defined in the domain for all instances of the tool.
   
 =item $title  =item $title
   
 optional. If wrapped item is a PDF, and $clientmobile is true,  optional. If wrapped item is a PDF, and $env{'browser.mobile'} 
 a link to a PDF is shown. The "title" will be displayed  is true, a link to a PDF is shown. The "title" will be displayed
 above the link, but if not provided as an arg, $env{'form.title'}  above the link, but if not provided as an arg, $env{'form.title'}
 will be used, otherwise, the filename will be displayed (unless  will be used, otherwise, the filename will be displayed (unless
 hidden URL set for the resource).  hidden URL set for the resource).
   
   =item $width
   
   optional. If URL is for an External Tool, and target type is window,
   then a default width may have been defined in the domain for all instances of 
   the tool.  If so, that width will be used for the window opened (via a link)
   to launch the external tool.
   
   =item $height
   
   optional. If URL is for an External Tool, and target type is window,
   then a default height may have been defined in the domain for all instances of 
   the tool.  If so, that height will be used for the window opened (via a link)
   to launch the external tool.
   
 =back  =back
   
 Returns markup for the entire page.  Returns markup for the entire page.
   
 =item handler()  =item handler()
   
   Content handler for requests for: /adm/wrapper/...
   used for content to be displayed in an iframe, or launched in a separate tab
   or window via a link.  The target URL is extracted from the requested URL, by
   removing the /adm/wrapper prefix. 
   
   The target URL will typically be a PDF served from the current server, an 
   external resource URL served from a different server, or an external tool
   (from an LTI Provider) launched from LON-CAPA (as LTI Consumer) and launched
   via a link.
   
   If the request included forceedit in the query string, and the requester has
   rights to modify course content, then the editor will be didplayed to allow
   changes to be made to the resource (e.g., change the URL of the external resource,
   or change the setting for the external tool instance.
   
   If not in edit mode, then the wrapper() subroutine will be called to generate the
   standard LON-CAPA inline menu, and then either a link to launch a separate tab or
   window, or an iframe to display the content inline. 
   
 =back  =back
   
 =cut  =cut
Removed from v.1.49.2.12  
changed lines
  Added in v.1.73

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>