[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 and 1.49.2.11.2.3

version 1.49.2.11, 2021/12/15 00:41:48 version 1.49.2.11.2.3, 2023/01/21 23:25:16
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::lonnavmaps();
   use LONCAPA qw(:DEFAULT :match);
   use HTML::Entities();
   use Digest::MD5();
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
 sub wrapper {  sub wrapper {
     my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title) = @_;      my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
           $title,$width,$height,$reuse,$is_supp) = @_;
   
     my $forcereg;      my $forcereg;
     unless ($env{'form.folderpath'}) {      unless ($env{'form.folderpath'}) {
Line 55  sub wrapper { Line 61  sub wrapper {
     (undef,undef,undef,undef,undef,undef,my $clientmobile) =      (undef,undef,undef,undef,undef,undef,my $clientmobile) =
         &Apache::loncommon::decode_user_agent($r);          &Apache::loncommon::decode_user_agent($r);
   
     my ($anchor,$uselink,$linktext);      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 65  sub wrapper { Line 71  sub wrapper {
         } elsif ($env{'form.anchor'} ne '') {          } elsif ($env{'form.anchor'} ne '') {
             $anchor = '#'.$env{'form.anchor'};              $anchor = '#'.$env{'form.anchor'};
         }          }
         unless (($is_pdf) && ($clientmobile)) {          if (($is_ext eq 'tab') || ($is_ext eq 'window')) {
               $uselink = 1;
           }
           unless (($is_pdf && $clientmobile) || $uselink) {
             my $hostname = $r->hostname();              my $hostname = $r->hostname();
             my $lonhost = $r->dir_config('lonHostID');              my $lonhost = $r->dir_config('lonHostID');
             my $ip = &Apache::lonnet::get_host_ip($lonhost);              my $ip = &Apache::lonnet::get_host_ip($lonhost);
Line 97  sub wrapper { Line 106  sub wrapper {
 # do not obscure the Functions menu.  # do not obscure the Functions menu.
 #  #
   
     unless ($clientmobile || $uselink) {      unless ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
         $headjs = '          $headjs = '
 <script type="text/javascript">  <script type="text/javascript">
 // <![CDATA[  // <![CDATA[
Line 113  var LCresizedef = 0; Line 122  var LCresizedef = 0;
     if (($uselink) && ($title eq '')) {      if (($uselink) && ($title eq '')) {
         if ($env{'form.symb'}) {          if ($env{'form.symb'}) {
             $title=&Apache::lonnet::gettitle($env{'form.symb'});              $title=&Apache::lonnet::gettitle($env{'form.symb'});
         } else {          } elsif (!$is_supp) {
             my $symb=&Apache::lonnet::symbread($r->uri);              my $symb=&Apache::lonnet::symbread($r->uri);
             if ($symb) {              if ($symb) {
                 $title=&Apache::lonnet::gettitle($symb);                  $title=&Apache::lonnet::gettitle($symb);
             }              }
         }          }
     }      }
     if ($clientmobile) {      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)');              $linktext = &mt('Link to PDF (for mobile devices)');
             $output .= &create_link($url,$anchor,$title,$linktext);              $output .= &create_link($url,$anchor,$title,$linktext);
           } elsif (($exttool eq 'window') || ($exttool eq 'tab') ||
                    ($is_ext eq 'tab') || ($is_ext eq 'window')) {
               my $preamble;
               if ($linktext eq '') {
                   if ($exttool) {
                       $linktext = &mt('Launch External Tool');
                   } else {
                       $linktext = &mt('Link to External Resource');
                   }
               }
               if ($exttool) {
                   $url = &HTML::Entities::encode($url,'"<>&');
               } else {
                   $url = &HTML::Entities::encode($url.$anchor,'&<>"');
               }
               if (($exttool eq 'tab') || ($is_ext eq 'tab')) {
                   my $target;
                   if ($exttool) {
                       $target = 'LCExternalToolTab';
                   } else {
                       if ($reuse) {
                           $target = 'LCExternalResTab';
                       } else {
                           $target = '_blank';
                       }
                       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>'.
                              '</div>';
               } 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 (($is_supp) || ($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";
   <script type="text/javascript">
   // <![CDATA[
   var windowObjectReference = null;
   var PreviousUrl;
   
   function openSinglePopup(strUrl) {
       if (windowObjectReference == null || windowObjectReference.closed) {
           windowObjectReference = window.open(strUrl, "$target",
                                               "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");
       } else if(PreviousUrl != strUrl) {
           windowObjectReference = window.open(strUrl, "$target",
                                               "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");
           windowObjectReference.focus();
       } else {
           windowObjectReference.focus();
       };
       PreviousUrl = strUrl;
   }
   // ]]>
   </script>
   <div>$preamble
   <a href="$url" target="$target" onclick="openSinglePopup(this.href); return false;">
   $linktext$extlinkimg</a>
   </div>
   ENDLINK
               }
               if ($exttool) {
                   if ($explanation ne '') {
                       $output .= '<div>'.$explanation.'</div>';
                   }
               }
         } else {          } else {
             if ($uselink) {              if ($uselink) {
                 $linktext = &mt('Link to resource');                  $linktext = &mt('Link to resource');
Line 187  var LCresizedef = 0; Line 296  var LCresizedef = 0;
         };          };
 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
Line 226  sub handler { Line 336  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,$cdom,$cnum,$hostname);      my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
           $linktext,$explanation,$width,$height,$reuse,$is_supp);
   
     for ($url){      for ($url){
         s|^/adm/wrapper||;          s|^/adm/wrapper||;
Line 237  sub handler { Line 348  sub handler {
   
     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$}) {
           $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)) {
     if ($is_ext) {  
         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},          &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
             ['forceedit','register','folderpath','symb','idx','title','anchor']);              ['forceedit','register','folderpath','symb','idx','title','anchor']);
         if (($env{'form.forceedit'}) &&          if (($env{'form.forceedit'}) &&
Line 255  sub handler { Line 413  sub handler {
                 if ($env{'form.anchor'} ne '') {                  if ($env{'form.anchor'} ne '') {
                     $url .= '#'.$env{'form.anchor'};                      $url .= '#'.$env{'form.anchor'};
                 }                  }
                   $is_supp = 1;
             }              }
             if (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {              my $type = 'ext';
               if ($exttool) {
                   $type = 'tool';
               } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
                 $hostname = $r->hostname();                  $hostname = $r->hostname();
             }              }
             my $type = 'ext';  
             $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'},
Line 270  sub handler { Line 431  sub handler {
             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');
                   }
               }
               $title = &HTML::Entities::encode($title,'\'"<>&');
               $is_supp = 1;
               if ($env{'request.course.id'}) {
                   $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   &Apache::loncommon::validate_folderpath(1,'',$cnum,$cdom);
               }
               $brcrum =
                   &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
           }
       } elsif ($env{'request.course.id'}) {
           my $courseurl = &Apache::lonnet::courseid_to_courseurl($env{'request.course.id'});
           $courseurl =~ s{^/}{};
           if ($url =~ m{^\Q/uploaded/$courseurl/supplemental/\E}) {
               $is_supp = 1;
               &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                                                       ['folderpath','title']);
               if ($env{'form.folderpath'}) {
                   $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   &Apache::loncommon::validate_folderpath(1,'',$cnum,$cdom);
             }              }
               my $title = $env{'form.title'};
               $title = &HTML::Entities::encode($title,'\'"<>&');
               my $crstype = &Apache::loncommon::course_type();
             $brcrum =              $brcrum =
                 &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);                  &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 290  sub handler { Line 481  sub handler {
 #  #
 # This is not homework  # This is not homework
 #  #
         if ($is_ext) {          if (($is_ext) || ($exttool)) {
             $absolute = $env{'request.use_absolute'};              $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 301  sub handler { Line 492  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($r,$url,$brcrum,$absolute,$is_ext,$is_pdf) );          $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
                              $linktext,$explanation,undef,$width,$height,$reuse,
                              $is_supp) );
   
     } # not just the menu      } # not just the menu
           
Line 330  described at http://www.lon-capa.org. Line 525  described at http://www.lon-capa.org.
   
 =over  =over
   
 =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title))  =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height,$reuse,$is_supp)
   
 =over  =over
   
Line 340  request object Line 535  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 370  in Firefox 23 and later, when serving fr Line 568  in Firefox 23 and later, when serving fr
   
 =item $is_ext  =item $is_ext
   
 true if URL is for an external resource.  true if URL is for an external resource. Default true value
   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 $clientmobile is true,
Line 384  above the link, but if not provided as a Line 602  above the link, but if not provided as a
 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  
changed lines
  Added in v.1.49.2.11.2.3

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