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

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

version 1.27, 2008/01/15 15:23:28 version 1.73, 2020/02/16 23:07:36
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::lonnet;  
 use Apache::lonxml();  
 use Apache::lonenc();  use Apache::lonenc();
 use Apache::lonmenu();  use Apache::lonnet;
   use Apache::lonlocal;
   use Apache::loncommon();
   use Apache::lonhtmlcommon();
   use Apache::lonextresedit();
   use Apache::lonexttool();
   use Apache::lonhomework();
   use LONCAPA qw(:DEFAULT :match);
   use HTML::Entities();
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
   sub wrapper {
       my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
           $title,$width,$height) = @_;
   
 sub simple_menu {      my $forcereg;
 #      unless ($env{'form.folderpath'}) {
 # Producing the menu buttons          $forcereg = 1;
 #      }
     return &Apache::loncommon::start_page('Menu',undef,      my %lt = &Apache::lonlocal::texthash(
   {'only_body' => 1,                                            'noif' => 'No iframe support.',
    'bgcolor'   => '#FFFFFF',}).                                            'show' => 'Show content in pop-up window',
  &Apache::lonmenu::menubuttons(1,'web',1).                                          );
  &Apache::loncommon::end_page();  
 }      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) && ($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 $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'};
       }
   
 sub wrapper {      my ($countdown,$donemsg,$headjs);
     my ($topurl,$bottomurl) = @_;      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();
           }
       }
   
     if ($env{'browser.interface'} eq 'textual') {  
 #  #
 # ssi-based rendering for text-based interface  # 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)
  return   # are used to ensure document.ready() triggers a call to resize, so the iframe contents
     &Apache::loncommon::start_page('Menu',undef,  # do not obscure the Functions menu.
   {'bgcolor'        => '#FFFFFF',  #
    'force_register' => 1,  
        }).      unless (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
     &Apache::lonnet::ssi_body($bottomurl).          $headjs = '
     &Apache::loncommon::end_page();  <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();
   
       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')) {
           my $output = $startpage;
     my %layout = ('border' => 0);          if ($is_pdf) {
     if ($env{'environment.remote'} eq 'off') {              $linktext = &mt('Link to PDF (for mobile devices)');
  $layout{'rows'} = "200,*";              $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 {      } else {
  $layout{'rows'} = "1,*";          windowObjectReference.focus();
  $topurl = "/adm/rat/empty.html";      };
       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 {
               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');
               }
           });
           window.onload = function(){
                if (LCresizedef) {
                    LCnotready = 0;
                    \$(window).trigger('resize') };
                } else {
                    LCnotready = 1;
                }
           };
   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
     }      }
   }
   
     my $start_page =   sub create_link {
  &Apache::loncommon::start_page(undef,undef,      my ($url,$anchor,$title,$linktext) = @_;
        {'force_register' => 1,      my $shownlink;
  'frameset'       => 1,      if ($title eq '') {
  'add_entries'    => \%layout, });          $title = $env{'form.title'};
           if ($title eq '') {
     my $end_page =               unless ($env{'request.enc'}) {
  &Apache::loncommon::end_page({'frameset' => 1});                  ($title) = ($url =~ m{/([^/]+)$});
                       $title =~ s/(\?[^\?]+)$//;
     foreach my $url ($topurl,$bottomurl) {              }
  if ($url !~ /^http:/) {          }
     $url = &Apache::lonenc::check_encrypt($url);      }
  }      unless ($title eq '') {
     }          $shownlink = '<span style="font-weight:bold;">'.$title.'</span><br />';
 #      }
 # frame-based rendering for graphical interface      my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
 #      $shownlink .= '<a href="'.$dest.'">'.$linktext.'</a>';
     my $result =<<ENDDOCUMENT;      return $shownlink;
 $start_page  
 test  
 <frame src="$topurl" />  
 <frame src="$bottomurl" />  
 $end_page  
 ENDDOCUMENT  
   
     return $result;  
 }  }
   
 sub handler {  sub handler {
Line 109  sub handler { Line 314  sub handler {
   
     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,
     if ($env{'form.wrapperdisplay'} eq 'menu') {          $linktext,$explanation,$width,$height);
  $r->print(&simple_menu());  
  return OK;      for ($url){
     }          s|^/adm/wrapper||;
           $is_ext = $_ =~ s|^/ext/|http://|;
     my $orgurl=$r->uri;          s|http://https://?|https://| if ($is_ext);
     my $url=$orgurl;          s|&colon;|:|g;
     $orgurl.=(($orgurl=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};      }
     $orgurl.=(($orgurl=~/\?/)?'&':'?').'wrapperdisplay=menu';  
     $url=~s/^\/adm\/wrapper//;      if ($url =~ /\.pdf$/i) {
     my $is_ext = $url =~ m|^/ext/|;          $is_pdf = 1;
     $url=~s{^/ext/}{http://};      } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
     $url=~s|http://https://|https://|;          $cdom = $1;
     $url=~s|&colon;|:|g;          $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          }
  $r->print(&wrapper($orgurl,$url));  
           unless ($ENV{'QUERY_STRING'} eq '') {
               $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
           }
   
           # encrypt url if not external
           unless ($is_ext) {
               &Apache::lonenc::check_encrypt(\$url);
           }
   
           $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
       
     return OK;      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($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height)
   
   =over
   
   =item $r
   
   request object
   
   =item $url
   
   url to display either by including in an iframe within a
   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
   
   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 $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
   
   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).
   
   =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
   
   Returns markup for the entire page.
   
   =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
   
   =cut
   
Removed from v.1.27  
changed lines
  Added in v.1.73

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