Diff for /rat/lonwrapper.pm between versions 1.49.2.4.4.1 and 1.76

version 1.49.2.4.4.1, 2020/04/07 20:39:03 version 1.76, 2020/02/29 16:05:26
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 LONCAPA qw(:DEFAULT :match);
   use HTML::Entities();
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
 sub wrapper {  sub wrapper {
     my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,      my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
         $title,$width,$height) = @_;          $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',
                                         );                                          );
   
     my $anchor;      my ($anchor,$uselink);
     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 64  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) && ($env{'browser.mobile'})) {
               my $hostname = $r->hostname();
               my $lonhost = $r->dir_config('lonHostID');
               my $ip = &Apache::lonnet::get_host_ip($lonhost);
               $uselink = &Apache::loncommon::is_nonframeable($url,$absolute,$hostname,$ip);
           }
     }      }
   
     my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);      my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
Line 81  sub wrapper { Line 89  sub wrapper {
         $args->{'only_body'} = $env{'form.only_body'};          $args->{'only_body'} = $env{'form.only_body'};
     }      }
   
     my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);      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
   # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
   # are used to ensure document.ready() triggers a call to resize, so the iframe contents
   # do not obscure the Functions menu.
   #
   
       unless (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
           $headjs = '
   <script type="text/javascript">
   // <![CDATA[
   var LCnotready = 0;
   var LCresizedef = 0;
   // ]]>
   </script>'."\n";
       }
   
       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 ($env{'form.symb'}) {
               $title=&Apache::lonnet::gettitle($env{'form.symb'});
           } else {
               my $symb=&Apache::lonnet::symbread($r->uri);
               if ($symb) {
                   $title=&Apache::lonnet::gettitle($symb);
               }
           }
       }
     if (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab')) {      if (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab')) {
         my $output = $startpage;          my $output = $startpage;
         if ($is_pdf) {          if ($is_pdf) {
             if ($title eq '') {              $linktext = &mt('Link to PDF (for mobile devices)');
                 $title = $env{'form.title'};              $output .= &create_link($url,$anchor,$title,$linktext);
                 if ($title eq '') {  
                     unless ($env{'request.enc'}) {  
                         ($title) = ($url =~ m{/([^/]+)$});  
                         $title =~ s/(\?[^\?]+)$//;  
                     }  
                 }  
             }  
             unless ($title eq '') {  
                 $output .= $title.'<br />';  
             }  
             $output .= '<a href="'.$url.'">'.&mt('Link to PDF (for mobile devices)').'</a>';  
         } elsif (($exttool eq 'window') || ($exttool eq 'tab')) {          } elsif (($exttool eq 'window') || ($exttool eq 'tab')) {
             if ($linktext eq '') {              if ($linktext eq '') {
                 $linktext = &mt('Launch External Tool');                  $linktext = &mt('Launch External Tool');
             }              }
               $url = &HTML::Entities::encode($url,'"<>&');
             if ($exttool eq 'tab') {              if ($exttool eq 'tab') {
                 $output .= '<div>'.                  $output .= '<div>'.
                            '<a href="'.$url.'" target="LCExternalToolTab" style="padding:0;clear:both;margin:0;border:0">'.                             '<a href="'.$url.'" target="LCExternalToolTab" style="padding:0;clear:both;margin:0;border:0">'.
Line 140  ENDLINK Line 211  ENDLINK
             if ($explanation ne '') {              if ($explanation ne '') {
                 $output .= '<div>'.$explanation.'</div>';                  $output .= '<div>'.$explanation.'</div>';
             }              }
               if (&Apache::lonnet::EXT('resource.0.gradable')) {
                   $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');
               }
         } else {          } else {
             $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".              if ($uselink) {
                        '<iframe src="'.$url.$anchor.'" height="100%" width="100%" frameborder="0">'."\n".                  $linktext = &mt('Link to resource');
                        "$lt{'noif'} $noiframe\n".                  $output .= &create_link($url,$anchor,$title,$linktext);
                        "</iframe>\n".              } else {
                        "</div>\n";                  my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
                   $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
                              '<iframe src="'.$dest.'" height="100%" width="100%" frameborder="0">'."\n".
                              "$lt{'noif'} $noiframe\n".
                              "</iframe>\n".
                              "</div>\n";
               }
         }          }
         $output .= $endpage;          $output .= $endpage;
         return $output;          return $output;
       } elsif ($uselink) {
           $linktext = &mt('Link to resource');
           return $startpage.&create_link($url,$anchor,$title,$linktext).$endpage;
     } else {      } else {
         my $offset = 5;          my $offset = 5;
         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);          &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
Line 177  ENDLINK Line 260  ENDLINK
                 var pos = height + hdrtop + offset;                  var pos = height + hdrtop + offset;
                 \$('.LC_iframecontainer').css('top', pos);                  \$('.LC_iframecontainer').css('top', pos);
             });              });
               LCresizedef = 1;
               if (LCnotready == 1) {
                   LCnotready = 0;
                   \$(window).trigger('resize');
               }
         });          });
         window.onload = function(){  \$(window).trigger('resize') };          window.onload = function(){
                if (LCresizedef) {
                    LCnotready = 0;
                    \$(window).trigger('resize');
                } else {
                    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
     }      }
 }  }
   
   sub create_link {
       my ($url,$anchor,$title,$linktext) = @_;
       my $shownlink;
       if ($title eq '') {
           $title = $env{'form.title'};
           if ($title eq '') {
               unless ($env{'request.enc'}) {
                   ($title) = ($url =~ m{/([^/]+)$});
                   $title =~ s/(\?[^\?]+)$//;
               }
           }
       }
       unless ($title eq '') {
           $shownlink = '<span style="font-weight:bold;">'.$title.'</span><br />';
       }
       my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
       $shownlink .= '<a href="'.$dest.'">'.$linktext.'</a>';
       return $shownlink;
   }
   
 sub handler {  sub handler {
     my $r=shift;      my $r=shift;
     &Apache::loncommon::content_type($r,'text/html');      &Apache::loncommon::content_type($r,'text/html');
Line 200  sub handler { Line 316  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,$exttool,$cdom,$cnum,      my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
         $linktext,$explanation,$width,$height);          $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://|;          s|http://https://|https://| if ($is_ext);
         s|&colon;|:|g;                        s|&colon;|:|g;
     }      }
   
     if ($url =~ /\.pdf$/i) {      if ($url =~ /\.pdf$/i) {
Line 221  sub handler { Line 337  sub handler {
         my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation','id','width','height'],          my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation','id','width','height'],
                                             $cdom,$cnum);                                              $cdom,$cnum);
         if ($toolhash{'id'}) {          if ($toolhash{'id'}) {
             my %ltitools = &Apache::lonnet::get_domain_ltitools($cdom);              my %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');
             if (ref($ltitools{$toolhash{'id'}}) eq 'HASH') {              if (ref($ltitools{$toolhash{'id'}}) eq 'HASH') {
                 $exttoolremote = $ltitools{$toolhash{'id'}}{'url'};                  $exttoolremote = $ltitools{$toolhash{'id'}}{'url'};
             }              }
Line 260  sub handler { Line 376  sub handler {
             my $type = 'ext';              my $type = 'ext';
             if ($exttool) {              if ($exttool) {
                 $type = 'tool';                  $type = 'tool';
               } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
                   $hostname = $r->hostname();
             }              }
             $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'},
                                                        $env{'form.idx'},$type,$cdom,                                                         $env{'form.idx'},$type,$cdom,
                                                        $cnum));                                                         $cnum,$hostname));
             return OK;              return OK;
         } elsif ($env{'form.folderpath'} =~ /^supplemental/) {          } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
             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 306  sub handler { Line 428  sub handler {
             &Apache::lonenc::check_encrypt(\$url);              &Apache::lonenc::check_encrypt(\$url);
         }          }
   
         $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,          $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
                            $linktext,$explanation,undef,$width,$height) );                             $linktext,$explanation,undef,$width,$height) );
   
     } # not just the menu      } # not just the menu
Line 334  described at http://www.lon-capa.org. Line 456  described at http://www.lon-capa.org.
   
 =over  =over
   
 =item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height)  =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height)
   
 =over  =over
   
   =item $r
   
   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 382  If URL is for an External Tool, will con Line 511  If URL is for an External Tool, will con
   
 =item $linktext  =item $linktext
   
 optional. If URL is for an External Tool, and target type is window or tab,  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,  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.  or may be a default defined in the domain for all instances of the tool.
   
 =item $explanation  =item $explanation
   
 optional. If URL is for an External Tool, and target type is window or tab,  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,  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.  or may be a default defined in the domain for all instances of the tool.
   
Line 403  hidden URL set for the resource). Line 532  hidden URL set for the resource).
 =item $width  =item $width
   
 optional. If URL is for an External Tool, and target type is window,  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  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)  the tool.  If so, that width will be used for the window opened (via a link)
 to launch the external tool.  to launch the external tool.
   
 =item $height  =item $height
   
 optional. If URL is for an External Tool, and target type is window,  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  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)  the tool.  If so, that height will be used for the window opened (via a link)
 to launch the external tool.  to launch the external tool.
   
Line 420  Returns markup for the entire page. Line 549  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.4.4.1  
changed lines
  Added in v.1.76


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