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

Diff for /rat/lonwrapper.pm between versions 1.42 and 1.49.2.7.2.6

version 1.42, 2012/11/27 23:45:15 version 1.49.2.7.2.6, 2021/10/19 11:27:51
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 LONCAPA qw(:DEFAULT :match);
   use HTML::Entities();
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
 sub wrapper {  sub wrapper {
     my ($url,$brcrum) = @_;      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(
                                             'noif' => 'No iframe support.',
                                             'show' => 'Show content in pop-up window',
                                           );
   
       (undef,undef,undef,undef,undef,undef,my $clientmobile) =
           &Apache::loncommon::decode_user_agent($r);
   
       my ($anchor,$uselink);
       if ($is_ext) {
           if ($env{'form.symb'}) {
               (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
               if ($res =~ /(#[^#]+)$/) {
                   $anchor = $1;
               }
           } elsif ($env{'form.anchor'} ne '') {
               $anchor = '#'.$env{'form.anchor'};
           }
           unless (($is_pdf) && ($clientmobile)) {
               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 $args = {'bgcolor' => '#FFFFFF'};      my $args = {'bgcolor' => '#FFFFFF'};
     if ($forcereg) {      if ($forcereg) {
         $args->{'force_register'} = $forcereg;          $args->{'force_register'} = $forcereg;
     }      }
     if (ref($brcrum) eq 'ARRAY') {      if (ref($brcrum) eq 'ARRAY') {
          $args->{'bread_crumbs'} = $brcrum;          $args->{'bread_crumbs'} = $brcrum;
       }
       if ($absolute) {
           $args->{'use_absolute'} = $absolute;
       }
       if ($env{'form.only_body'}) {
           $args->{'only_body'} = $env{'form.only_body'};
     }      }
   
     my $startpage =  Apache::loncommon::start_page('Menu',undef,$args);      my $headjs;
     my $endpage =  Apache::loncommon::end_page();  
   
     my $script = Apache::lonhtmlcommon::scripttag(<<SCRIPT );  #
     \$(document).ready( function() {  # Where iframe is in use, if window.onload() executes before the custom resize function
         \$(window).unbind('resize').resize(function(){  # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
             var header;  # are used to ensure document.ready() triggers a call to resize, so the iframe contents
             var offset = 5;  # do not obscure the Functions menu.
             var height = 0;  #
             var hdrtop = 0;  
             if (\$('div.LC_head_subbox:first').length) {      unless ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
                 header = \$('div.LC_head_subbox:first');          $headjs = '
                 offset = 9;  <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();
   
       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 ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab')) {
           my $output = $startpage;
           if ($is_pdf) {
               $linktext = &mt('Link to PDF (for mobile devices)');
               $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 {              } else {
                 if (\$('#LC_breadcrumbs').length) {                  $output .= <<"ENDLINK";
                     header = \$('#LC_breadcrumbs');  <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 (header.length) {              if ($explanation ne '') {
                 height = header.height();                  $output .= '<div>'.$explanation.'</div>';
                 hdrtop = header.position().top;              }
           } else {
               if ($uselink) {
                   $linktext = &mt('Link to resource');
                   $output .= &create_link($url,$anchor,$title,$linktext);
               } else {
                   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;
           return $output;
       } elsif ($uselink) {
           $linktext = &mt('Link to resource');
           return $startpage.&create_link($url,$anchor,$title,$linktext).$endpage;
       } else {
           my $offset = 5;
           &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
           if ($env{'form.inhibitmenu'} eq 'yes') {
               $offset = 0;
           }
           my $script = &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
           \$(document).ready( function() {
               \$(window).unbind('resize').resize(function(){
                   var header = null;
                   var offset = $offset;
                   var height = 0;
                   var hdrtop = 0;
                   if (\$('div.LC_head_subbox:first').length) {
                       header = \$('div.LC_head_subbox:first');
                       offset = 9;
                   } else {
                       if (\$('#LC_breadcrumbs').length) {
                           header = \$('#LC_breadcrumbs');
                       }
                   }
                   if (header != null && header.length) {
                       height = header.height();
                       hdrtop = header.position().top;
                   }
                   var pos = height + hdrtop + offset;
                   \$('.LC_iframecontainer').css('top', pos);
               });
               LCresizedef = 1;
               if (LCnotready == 1) {
                   LCnotready = 0;
                   \$(window).trigger('resize');
             }              }
             var pos = height + hdrtop + offset;  
             \$('.LC_iframecontainer').css('top', pos);  
         });          });
     });          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,'&<>"');
     return <<ENDFRAME;          return <<ENDFRAME;
     $startpage          $startpage
     $script          $script
     <div class="LC_iframecontainer">          <div class="LC_iframecontainer">
         <iframe src="$url">No iframe support!</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 {
Line 103  sub handler { Line 272  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);      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://|;          s|http://https://|https://| if ($is_ext);
         s|&colon;|:|g;                        s|&colon;|:|g;
     }      }
   
     if ($is_ext) {      if ($url =~ /\.pdf$/i) {
           $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)) {
         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},          &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
             ['forceedit','register','folderpath','symb','idx','title']);              ['forceedit','register','folderpath','symb','idx','title','anchor']);
         if (($env{'form.forceedit'}) &&          if (($env{'form.forceedit'}) &&
             (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&              (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
             (($env{'form.folderpath'} =~ /^supplemental/) ||              (($env{'form.folderpath'} =~ /^supplemental/) ||
              ($env{'form.symb'} =~ /^uploaded/))) {               ($env{'form.symb'} =~ /^uploaded/))) {
               if ($env{'form.symb'}) {
                   (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   if ($res =~ /(#[^#]+)$/) {
                       $url .= $1;
                   }
               } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
                   if ($env{'form.anchor'} ne '') {
                       $url .= '#'.$env{'form.anchor'};
                   }
               }
               my $type = 'ext';
               if ($exttool) {
                   $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'}));                                                         $env{'form.idx'},$type,$cdom,
                                                          $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();
             $brcrum =              my $title = $env{'form.title'};
                 &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$env{'form.title'},1);              if ($title eq '') {
             if (ref($brcrum) eq 'ARRAY') {                  if ($is_ext) {
                 my $last = $env{'form.title'};                      $title = &mt('External Resource');
                 if ($last eq '') {                  } else {
                     $last = &mt('External Resource');                      $title = &mt('External Tool');
                 }                  }
                 push(@{$brcrum},  
                          {'title' => $last,  
                           'text' => $last,  
                           'no_mt' => 1,  
                          });  
   
             }              }
               $brcrum =
                   &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
         }          }
     }      }
   
 #  #
 # Actual URL  # Actual URL
 #  #
     if ($url=~/$LONCAPA::assess_re/) {      if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
 #  #
 # This is uploaded homework  # This is uploaded homework
 #  #
Line 156  sub handler { Line 369  sub handler {
 #  #
 # This is not homework  # This is not homework
 #  #
         if ($is_ext) {          if (($is_ext) || ($exttool)) {
               $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 166  sub handler { Line 380  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($url,$brcrum) );          $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 195  described at http://www.lon-capa.org. Line 412  described at http://www.lon-capa.org.
   
 =over  =over
   
 =item wrapper($url,$brcrum)  =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height)
   
   =over
   
   =item $r
   
 Wraps $url in an iframe and generates a page for it.  request object
 $brcrum contains breadcrumbs for unregistered urls  
   =item $url
   
   url to display by including in an iframe within a
   LON-CAPA page which has a standard LON-CAPA inline menu.
   
   =item $brcrum
   
   breadcrumbs for unregistered urls
 (i.e., external resources in Supplemental Content).  (i.e., external resources in Supplemental Content).
 Returns markup for the entire page.  
   
 =item handler()  =item $absolute
   
 =back  contains protocol (http or https) followed by
   the hostname, if menu items in the standard LON-CAPA
   interface created by the call to loncommon::start_page()
   within &wrapper() need to use absolute URLs rather than
   relative URLs.
   
 =cut  That will be the case where an external resource has been 
   served from port 80, when the server customarily serves
   requests using Apache/SSL (i.e., port 443). mod_rewrite 
   is used to switch requests for external resources and
   the syllabus: /public/<domain>/<courseid>/syllabus
   (which might also point at an external resource)
   from https:// to http:// where the the URL of the remote site 
   specified in the resource itself is http://.
   
   This is done to avoid default mixed content blocking
   in Firefox 23 and later, when serving from Apache/SSL.
   
   =item $is_ext
   
   true if URL is for an external resource.
   
   =item $is_pdf
   
   true if URL is for a PDF (based on file extension).
   
   =item $title
   
   optional. If wrapped item is a PDF, and $clientmobile 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'}
   will be used, otherwise, the filename will be displayed (unless
   hidden URL set for the resource).
   
   =back
   
   Returns markup for the entire page.
   
   =item handler()
   
   =back
   
   =cut
   
Removed from v.1.42  
changed lines
  Added in v.1.49.2.7.2.6

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