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

Diff for /rat/lonwrapper.pm between versions 1.49.2.11.2.2 and 1.65

version 1.49.2.11.2.2, 2022/08/30 11:48:33 version 1.65, 2017/11/30 14:41:30
Line 38  use Apache::loncommon(); Line 38  use Apache::loncommon();
 use Apache::lonhtmlcommon();  use Apache::lonhtmlcommon();
 use Apache::lonextresedit();  use Apache::lonextresedit();
 use Apache::lonexttool();  use Apache::lonexttool();
 use Apache::lonnavmaps();  
 use LONCAPA qw(:DEFAULT :match);  use LONCAPA qw(:DEFAULT :match);
 use HTML::Entities();  use HTML::Entities();
 use Digest::MD5();  
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
 sub wrapper {  sub wrapper {
     my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,      my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
         $title,$width,$height,$reuse) = @_;          $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;
         &Apache::loncommon::decode_user_agent($r);  
   
     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 71  sub wrapper { Line 65  sub wrapper {
         } elsif ($env{'form.anchor'} ne '') {          } elsif ($env{'form.anchor'} ne '') {
             $anchor = '#'.$env{'form.anchor'};              $anchor = '#'.$env{'form.anchor'};
         }          }
         if (($is_ext eq 'tab') || ($is_ext eq 'window')) {  
             $uselink = 1;  
         }  
         unless (($is_pdf && $clientmobile) || $uselink) {  
             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 97  sub wrapper { Line 82  sub wrapper {
         $args->{'only_body'} = $env{'form.only_body'};          $args->{'only_body'} = $env{'form.only_body'};
     }      }
   
     my $headjs;      my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);
   
 #  
 # 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 ($clientmobile || ($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);  
     my $endpage = &Apache::loncommon::end_page();      my $endpage = &Apache::loncommon::end_page();
       
     if (($uselink) && ($title eq '')) {      if (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab')) {
         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 ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') ||  
         ($is_ext eq 'tab') || ($is_ext eq 'window')) {  
         my $output = $startpage;          my $output = $startpage;
         if ($is_pdf) {          if ($is_pdf) {
             $linktext = &mt('Link to PDF (for mobile devices)');              if ($title eq '') {
             $output .= &create_link($url,$anchor,$title,$linktext);                  $title = $env{'form.title'};
         } elsif (($exttool eq 'window') || ($exttool eq 'tab') ||                  if ($title eq '') {
                  ($is_ext eq 'tab') || ($is_ext eq 'window')) {                      unless ($env{'request.enc'}) {
             my $preamble;                          ($title) = ($url =~ m{/([^/]+)$});
             if ($linktext eq '') {                          $title =~ s/(\?[^\?]+)$//;
                 if ($exttool) {                      }
                     $linktext = &mt('Launch External Tool');  
                 } else {  
                     $linktext = &mt('Link to External Resource');  
                 }                  }
             }              }
             if ($exttool) {              unless ($title eq '') {
                 $url = &HTML::Entities::encode($url,'"<>&');                  $output .= $title.'<br />';
             } else {  
                 $url = &HTML::Entities::encode($url.$anchor,'&<>"');  
             }              }
             if (($exttool eq 'tab') || ($is_ext eq 'tab')) {              $output .= '<a href="'.$url.'">'.&mt('Link to PDF (for mobile devices)').'</a>';
                 my $target;          } elsif (($exttool eq 'window') || ($exttool eq 'tab')) {
                 if ($exttool) {              if ($linktext eq '') {
                     $target = 'LCExternalToolTab';                  $linktext = &mt('Launch External Tool');
                 } else {              }
                     if ($reuse) {              $url = &HTML::Entities::encode($url,'"<>&');
                         $target = 'LCExternalResTab';              if ($exttool eq 'tab') {
                     } else {                  $output .= '<div>'.
                         $target = '_blank';                             '<a href="'.$url.'" target="LCExternalToolTab" style="padding:0;clear:both;margin:0;border:0">'.
                     }  
                     if ($title ne '') {  
                         $preamble = '<span style="font-weight:bold;">'.$title.'</span><br />';  
                     }  
                 }  
                 $output .= '<div>'.$preamble.  
                            '<a href="'.$url.'" target="'.$target.'" style="padding:0;clear:both;margin:0;border:0">'.  
                            $linktext.'</a>'.                             $linktext.'</a>'.
                            '</div>';                             '</div>';
             } else {              } else {
                 my ($target,$extlinkimg);  
                 if ($exttool) {  
                     $target = 'LCExternalToolPopUp';  
                 } else {  
                     $target = 'LCExternalResPopUp';  
                     if ($title ne '') {  
                         $preamble = '<span style="font-weight:bold;">'.$title.'</span><br />';  
                     }  
                     $extlinkimg = '<img src="'.&Apache::loncommon::lonhttpdurl($r->dir_config('lonIconsURL').'/externallink.gif').'" width="19" height="18" border="0" />';  
                     unless ($reuse) {  
                         my $resid;  
                         if ($env{'request.course.id'}) {  
                             unless ($env{'form.folderpath'} =~ /^supplemental/) {  
                                 my $symb=&Apache::lonnet::symbread($r->uri);  
                                 if ($symb) {  
                                     my $navmap = Apache::lonnavmaps::navmap->new();  
                                     if (ref($navmap)) {  
                                         my $res = $navmap->getBySymb($symb);  
                                         if (ref($res)) {  
                                             $resid = $res->id;  
                                             $resid =~ s/\./_/g;  
                                         }  
                                     }  
                                 }  
                             }  
                         }  
                         if ($resid eq '') {  
                             $resid = substr(Digest::MD5::md5_hex(Digest::MD5::md5_hex(time(). {}. rand(). $$)), 0, 8);  
                         }  
                         &js_escape(\$resid);  
                         $target .= $resid;  
                     }  
                 }  
                 $output .= <<"ENDLINK";                  $output .= <<"ENDLINK";
 <script type="text/javascript">  <script type="text/javascript">
 // <![CDATA[  // <![CDATA[
 var windowObjectReference = null;  var windowObjectReference = null; 
 var PreviousUrl;  var PreviousUrl; 
                              
 function openSinglePopup(strUrl) {  function openSinglePopup(strUrl) {
     if (windowObjectReference == null || windowObjectReference.closed) {      if (windowObjectReference == null || windowObjectReference.closed) {
         windowObjectReference = window.open(strUrl, "$target",          windowObjectReference = window.open(strUrl, "LCExternalToolPopUp",
                                             "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");                                              "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");
     } else if(PreviousUrl != strUrl) {      } else if(PreviousUrl != strUrl) {
         windowObjectReference = window.open(strUrl, "$target",          windowObjectReference = window.open(strUrl, "LCExternalToolPopUp",
                                             "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");                                              "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");
         windowObjectReference.focus();          windowObjectReference.focus();
     } else {      } else {
Line 223  function openSinglePopup(strUrl) { Line 133  function openSinglePopup(strUrl) {
 }  }
 // ]]>  // ]]>
 </script>  </script>
 <div>$preamble  <div>
 <a href="$url" target="$target" onclick="openSinglePopup(this.href); return false;">  <a href="$url" target="LCExternalToolPopUp" onclick="openSinglePopup(this.href); return false;">
 $linktext$extlinkimg</a>  $linktext</a>
 </div>  </div>
 ENDLINK  ENDLINK
             }              }
             if ($exttool) {              if ($explanation ne '') {
                 if ($explanation ne '') {                  $output .= '<div>'.$explanation.'</div>';
                     $output .= '<div>'.$explanation.'</div>';  
                 }  
             }              }
         } else {          } else {
             if ($uselink) {              my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
                 $linktext = &mt('Link to resource');              $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
                 $output .= &create_link($url,$anchor,$title,$linktext);                         '<iframe src="'.$dest.'" height="100%" width="100%" frameborder="0">'."\n".
             } else {                         "$lt{'noif'} $noiframe\n".
                 my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');                         "</iframe>\n".
                 $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".                         "</div>\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 280  ENDLINK Line 180  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.onload = function(){  \$(window).trigger('resize') };
             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,'&<>"');          my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
Line 308  ENDFRAME Line 196  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 337  sub handler { Line 205  sub handler {
   
     my $url = $r->uri;      my $url = $r->uri;
     my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,      my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
         $linktext,$explanation,$width,$height,$reuse);          $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://|;
         s|&colon;|:|g;          s|&colon;|:|g;              
     }      }
   
   
     if ($url =~ /\.pdf$/i) {      if ($url =~ /\.pdf$/i) {
         $is_pdf = 1;          $is_pdf = 1;
     } elsif (($is_ext) && ($env{'request.course.id'})) {  
         if ($env{'course.'.$env{'request.course.id'}.'.extresource'}) {  
             (my $selected,$reuse,$width,$height) = split(/:/,$env{'course.'.$env{'request.course.id'}.'.extresource'});  
             if ($selected eq 'tab') {  
                 $is_ext = 'tab';  
                 $width = '';  
                 $height = '';  
             } elsif ($selected eq 'window') {  
                 $is_ext = 'window';  
                 unless ($width =~ /^\d+$/) {  
                     $width = '';  
                 }  
                 unless ($height =~ /^\d+$/) {  
                     $height = '';  
                 }  
             } else {  
                 $width = '';  
                 $height = '';  
                 $reuse = '';  
             }  
         }  
     } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {      } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
         $cdom = $1;          $cdom = $1;
         $cnum = $2;          $cnum = $2;
Line 388  sub handler { Line 236  sub handler {
             $width = $toolhash{'width'};              $width = $toolhash{'width'};
             $height = $toolhash{'height'};              $height = $toolhash{'height'};
         } elsif ($toolhash{'target'} eq 'tab') {          } elsif ($toolhash{'target'} eq 'tab') {
             $exttool = 'tab';              $exttool = 'tab'; 
         }          }
         if (($exttool eq 'window') || ($exttool eq 'tab')) {          if (($exttool eq 'window') || ($exttool eq 'tab')) {
             $linktext = $toolhash{'linktext'};              $linktext = $toolhash{'linktext'}; 
             $explanation = $toolhash{'explanation'};              $explanation = $toolhash{'explanation'};
         } elsif (($exttoolremote =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {          } elsif (($exttoolremote =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
             $exttool = 'tab';              $exttool = 'tab';
Line 469  sub handler { Line 317  sub handler {
             &Apache::lonenc::check_encrypt(\$url);              &Apache::lonenc::check_encrypt(\$url);
         }          }
   
         $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,          $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
                            $linktext,$explanation,undef,$width,$height,$reuse) );                             $linktext,$explanation,undef,$width,$height) );
   
     } # not just the menu      } # not just the menu
           
Line 497  described at http://www.lon-capa.org. Line 345  described at http://www.lon-capa.org.
   
 =over  =over
   
 =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height,$reuse)  =item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$linktext,$explanation,$title,$width,$height)
   
 =over  =over
   
 =item $r  
   
 request object  
   
 =item $url  =item $url
   
 url to display either by including in an iframe within a  url to display 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 540  in Firefox 23 and later, when serving fr Line 381  in Firefox 23 and later, when serving fr
   
 =item $is_ext  =item $is_ext
   
 true if URL is for an external resource. Default true value  true if URL is for an external resource.
 is 1 (display in iframe, unless $uselink is true).  
 If external resource is to be displayed in a tab,  
 value of $is_ext will be tab, if to be displayed in a pop-up window,  
 value of $is_ext will be window.  
   
 =item $is_pdf  =item $is_pdf
   
 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. If the URL is for an External Resource, and  
 $is_ext is window, then a default width (px) may have been defined in the current  
 course for all external resource instances.  
   
 =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.  If the URL is for an External Resource, and  
 $is_ext is window, then a default height (px) may have been defined in the current  
 course for all external resource instances.  
   
 =item $reuse  
   
 optional. If the URL is for an External Resource, and $is_ext is tab or window,  
 then $reuse will be true if the same tab or window is to be reused for display  
 of all external resource instances in a a course.  
   
 =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 displayed 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.11.2.2  
changed lines
  Added in v.1.65

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