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

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

version 1.19, 2006/02/10 21:44:02 version 1.65, 2017/11/30 14:41:30
Line 26 Line 26
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
   
   
 package Apache::lonwrapper;  package Apache::lonwrapper;
   
 use strict;  use strict;
 use Apache::Constants qw(:common);  use Apache::Constants qw(:common);
   use Apache::lonenc();
 use Apache::lonnet;  use Apache::lonnet;
 use Apache::lonxml();  use Apache::lonlocal;
 use Apache::lonmenu;  use Apache::loncommon();
   use Apache::lonhtmlcommon();
   use Apache::lonextresedit();
   use Apache::lonexttool();
   use LONCAPA qw(:DEFAULT :match);
   use HTML::Entities();
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
   sub wrapper {
       my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
           $title,$width,$height) = @_;
   
       my $forcereg;
       unless ($env{'form.folderpath'}) {
           $forcereg = 1;
       }
       my %lt = &Apache::lonlocal::texthash(
                                             'noif' => 'No iframe support.',
                                             'show' => 'Show content in pop-up window',
                                           );
   
       my $anchor;
       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'};
           }
       }
   
       my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
       my $args = {'bgcolor' => '#FFFFFF'};
       if ($forcereg) {
           $args->{'force_register'} = $forcereg;
       }
       if (ref($brcrum) eq 'ARRAY') {
           $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 $endpage = &Apache::loncommon::end_page();
       
       if (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab')) {
           my $output = $startpage;
           if ($is_pdf) {
               if ($title eq '') {
                   $title = $env{'form.title'};
                   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')) {
               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>';
               }
           } 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;
       } 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);
               });
           });
           window.onload = function(){  \$(window).trigger('resize') };
   SCRIPT
           # javascript will position the iframe if window was resized (or zoomed)
           my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
           return <<ENDFRAME;
           $startpage
           $script
           <div class="LC_iframecontainer">
               <iframe src="$dest">$lt{'noif'} $noiframe</iframe>
           </div>
           $endpage
   ENDFRAME
       }
   }
   
 sub handler {  sub handler {
   my $r=shift;      my $r=shift;
   &Apache::loncommon::content_type($r,'text/html');      &Apache::loncommon::content_type($r,'text/html');
   $r->send_http_header;      $r->send_http_header;
   
   return OK if $r->header_only;      return OK if $r->header_only;
   
   &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},      my $url = $r->uri;
                                           ['wrapperdisplay']);      my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
   my $orgurl=$r->uri;          $linktext,$explanation,$width,$height);
   my $url=$orgurl;  
   $orgurl.=(($orgurl=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};      for ($url){
   $orgurl.=(($orgurl=~/\?/)?'&':'?').'wrapperdisplay=menu';          s|^/adm/wrapper||;
   $url=~s/^\/adm\/wrapper//;          $is_ext = $_ =~ s|^/ext/|http://|;         
   my $is_ext = $url =~ m|^/ext/|;          s|http://https://|https://|;
   $url=~s/^\/ext\//http\:\/\//;          s|&colon;|:|g;              
   $url=~s|&colon;|:|g;      }
   if ($env{'form.wrapperdisplay'} eq 'menu') {  
 #  
 # Producing the menu buttons      if ($url =~ /\.pdf$/i) {
 #          $is_pdf = 1;
       $r->print('<html><body bgcolor="#FFFFFF">'.      } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
                 &Apache::lonmenu::menubuttons(1,'web',1).'</body></html>');          $cdom = $1;
   } else {          $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'},
               ['forceedit','register','folderpath','symb','idx','title','anchor']);
           if (($env{'form.forceedit'}) &&
               (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
               (($env{'form.folderpath'} =~ /^supplemental/) ||
                ($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(
                   &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
                                                          $env{'form.symb'},
                                                          $env{'form.idx'},$type,$cdom,
                                                          $cnum,$hostname));
               return OK;
           } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
               my $crstype = &Apache::loncommon::course_type();
               my $title = $env{'form.title'};
               if ($title eq '') {
                   if ($is_ext) {
                       $title = &mt('External Resource');
                   } else {
                       $title = &mt('External Tool');
                   }
               }
               $brcrum =
                   &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
           }
       }
   
 #  #
 # Actual URL  # Actual URL
 #  #
       if ($url=~/\.(problem|exam|quiz|assess|survey|form|library)$/) {      if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
 #  #
 # This is uploaded homework  # This is uploaded homework
 #  #
           $env{'request.state'}='uploaded';          $env{'request.state'}='uploaded';
           &Apache::lonhomework::renderpage($r,$url);          &Apache::lonhomework::renderpage($r,$url);
       } else {      } else {
 #  #
 # This is not homework  # This is not homework
 #  #
   if ($is_ext) {          if (($is_ext) || ($exttool)) {
       $ENV{'QUERY_STRING'}=~s/(^|\&)symb=[^\&]*/$1/;              $absolute = $env{'request.use_absolute'};
   }              $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
   $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};               $ENV{'QUERY_STRING'} =~ s/\&$//;
                                                  # reappend the query arguments          }
   my $events='onLoad="'.&Apache::lonmenu::loadevents.  
       '" onUnload="'.&Apache::lonmenu::unloadevents.'"';          unless ($ENV{'QUERY_STRING'} eq '') {
   my $script=&Apache::lonmenu::registerurl(1,undef);              $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
           }
   if ($env{'browser.interface'} eq 'textual') {  
 #          # encrypt url if not external
 # ssi-based rendering for text-based interface          unless ($is_ext) {
 #              &Apache::lonenc::check_encrypt(\$url);
       $r->print('<html><head>'.          }
  &Apache::lonmenu::registerurl(1).  
  '</head><body bgcolor="#FFFFFF">'.          $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
  &Apache::lonmenu::menubuttons(1).                             $linktext,$explanation,undef,$width,$height) );
  &Apache::lonnet::ssi_body($url).'</body></html>');  
   } elsif ($env{'environment.remote'} eq 'off') {      } # not just the menu
 #      
 # This is inline remote      return OK;
 #   
       $r->print(<<ENDDOCUMENTINL);  
 <html>  
 <head>  
 $script  
 </head>  
 <frameset rows="180,*" border=0 $events>  
 <frame src="$orgurl">  
 <frame src="$url">  
 </frameset>  
 </html>  
 ENDDOCUMENTINL  
           } else {  
 #  
 # frame-based rendering for graphical interface  
 #  
   $r->print(<<ENDDOCUMENT);  
 <html>  
 <head>  
 $script  
 </head>  
 <frameset rows="1,*" border=0 $events>  
 <frame src="/adm/rat/empty.html">  
 <frame src="$url">  
 </frameset>  
 </html>  
 ENDDOCUMENT  
           }  
       } # not homework  
   } # not just the menu  
   return OK;  
 } # handler  } # handler
   
 1;  1;
 __END__  __END__
   
   =pod
   
   =head1 NAME
   
   Apache::lonwrapper - External and binary file management.
   
   =head1 SYNOPSIS
   
   Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
   
   This is part of the LearningOnline Network with CAPA project
   described at http://www.lon-capa.org.
   
   =head1 Subroutines
   
   =over
   
   =item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$linktext,$explanation,$title,$width,$height)
   
   =over
   
   =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).
   
   =item $absolute
   
   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.
   
   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 $env{'browser.mobile'} 
   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.19  
changed lines
  Added in v.1.65

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