[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.5 and 1.77

version 1.49.2.11.2.5, 2023/10/06 17:35:54 version 1.77, 2021/10/19 00:16:32
Line 39  use Apache::lonhtmlcommon(); Line 39  use Apache::lonhtmlcommon();
 use Apache::lonextresedit();  use Apache::lonextresedit();
 use Apache::lonexttool();  use Apache::lonexttool();
 use Apache::lonhomework();  use Apache::lonhomework();
 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 ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
         $title,$width,$height,$reuse,$is_supp) = @_;          $title,$width,$height) = @_;
   
     my $forcereg;      my $forcereg;
     unless ($env{'form.folderpath'}) {      unless ($env{'form.folderpath'}) {
Line 71  sub wrapper { Line 69  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')) {          unless (($is_pdf) && ($clientmobile)) {
             $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 95  sub wrapper { Line 90  sub wrapper {
     }      }
     if ($env{'form.only_body'}) {      if ($env{'form.only_body'}) {
         $args->{'only_body'} = $env{'form.only_body'};          $args->{'only_body'} = $env{'form.only_body'};
     } elsif (($is_supp) && ($env{'form.folderpath'} ne '')) {  
         $args->{'bread_crumbs_nomenu'} = 1;  
     }      }
   
     my ($countdown,$donemsg,$headjs);      my ($countdown,$donemsg,$headjs);
Line 168  var LCresizedef = 0; Line 161  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'});
         } elsif (!$is_supp) {          } else {
             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 || ($exttool eq 'window') || ($exttool eq 'tab') ||      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') ||          } elsif (($exttool eq 'window') || ($exttool eq 'tab')) {
                  ($is_ext eq 'tab') || ($is_ext eq 'window')) {  
             my $preamble;  
             if ($linktext eq '') {              if ($linktext eq '') {
                 if ($exttool) {                  $linktext = &mt('Launch External Tool');
                     $linktext = &mt('Launch External Tool');  
                 } else {  
                     $linktext = &mt('Link to External Resource');  
                 }  
             }              }
             if ($exttool) {              $url = &HTML::Entities::encode($url,'"<>&');
                 $url = &HTML::Entities::encode($url,'"<>&');              if ($exttool eq 'tab') {
             } else {                  $output .= '<div>'.
                 $url = &HTML::Entities::encode($url.$anchor,'&<>"');                             '<a href="'.$url.'" target="LCExternalToolTab" style="padding:0;clear:both;margin:0;border:0">'.
             }  
             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>'.                             $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 (($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";                  $output .= <<"ENDLINK";
 <script type="text/javascript">  <script type="text/javascript">
 // <![CDATA[  // <![CDATA[
Line 256  var PreviousUrl; Line 192  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 269  function openSinglePopup(strUrl) { Line 205  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>';              }
                 }              if (&Apache::lonnet::EXT('resource.0.gradable')) {
                 if (&Apache::lonnet::EXT('resource.0.gradable')) {                  $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');
                     $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');  
                 }  
             }              }
         } else {          } else {
             if ($uselink) {              if ($uselink) {
Line 304  ENDLINK Line 238  ENDLINK
     } 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']);
         if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {          if ($env{'form.inhibitmenu'} eq 'yes') {
             $offset = 0;              $offset = 0;
         }          }
         my $script = &Apache::lonhtmlcommon::scripttag(<<SCRIPT);          my $script = &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
Line 336  ENDLINK Line 270  ENDLINK
             }              }
         });          });
         window.onload = function(){          window.onload = function(){
             if (LCresizedef) {               if (LCresizedef) {
                 LCnotready = 0;                   LCnotready = 0;
                 \$(window).trigger('resize');                   \$(window).trigger('resize');
             } else {               } else {
                 LCnotready = 1;                   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)
Line 386  sub handler { Line 320  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,$is_supp);          $linktext,$explanation,$width,$height);
   
     for ($url){      for ($url){
         s|^/adm/wrapper||;          s|^/adm/wrapper||;
Line 397  sub handler { Line 331  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$}) {      } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
         $cdom = $1;          $cdom = $1;
         $cnum = $2;          $cnum = $2;
Line 427  sub handler { Line 340  sub handler {
         my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation','id','width','height'],          my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation','id','width','height'],
                                             $cdom,$cnum);                                              $cdom,$cnum);
         if ($toolhash{'id'}) {          if ($toolhash{'id'}) {
             my ($idx,%ltitools);              my %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');
             if ($toolhash{'id'} =~ /^c(\d+)$/) {              if (ref($ltitools{$toolhash{'id'}}) eq 'HASH') {
                 $idx = $1;                  $exttoolremote = $ltitools{$toolhash{'id'}}{'url'};
                 %ltitools = &Apache::lonnet::get_course_lti($cnum,$cdom,'consumer');  
             } else {  
                 $idx = $toolhash{'id'};  
                 %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');  
             }  
             if (ref($ltitools{$idx}) eq 'HASH') {  
                 $exttoolremote = $ltitools{$idx}{'url'};  
             }              }
         }          }
         if ($toolhash{'target'} eq 'window') {          if ($toolhash{'target'} eq 'window') {
Line 455  sub handler { Line 361  sub handler {
     }      }
     if (($is_ext) || ($exttool)) {      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','anchor','only_body']);              ['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/) ||
Line 469  sub handler { Line 375  sub handler {
                 if ($env{'form.anchor'} ne '') {                  if ($env{'form.anchor'} ne '') {
                     $url .= '#'.$env{'form.anchor'};                      $url .= '#'.$env{'form.anchor'};
                 }                  }
                 $is_supp = 1;  
             }              }
             my $type = 'ext';              my $type = 'ext';
             if ($exttool) {              if ($exttool) {
Line 493  sub handler { Line 398  sub handler {
                     $title = &mt('External Tool');                      $title = &mt('External Tool');
                 }                  }
             }              }
             $title = &HTML::Entities::encode($title,'\'"<>&');              $brcrum =
             $is_supp = 1;                  &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,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);  
             }  
             unless ($env{'form.only_body'}) {   
                 $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','only_body']);  
             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();  
             unless ($env{'form.only_body'}) {  
                 $brcrum =  
                     &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);  
             }  
         }          }
     }      }
   
Line 556  sub handler { Line 432  sub handler {
         }          }
   
         $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,          $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
                            $linktext,$explanation,undef,$width,$height,$reuse,                             $linktext,$explanation,undef,$width,$height) );
                            $is_supp) );  
   
     } # not just the menu      } # not just the menu
           
Line 584  described at http://www.lon-capa.org. Line 459  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,$is_supp)  =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height)
   
 =over  =over
   
Line 627  in Firefox 23 and later, when serving fr Line 502  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
   
Line 643  If URL is for an External Tool, will con Line 514  If URL is for an External Tool, will con
   
 =item $linktext  =item $linktext
   
 optional. If URL is for an External Tool, and target type is window or tab,  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,  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.  or may be a default defined in the domain for all instances of the tool.
   
 =item $explanation  =item $explanation
   
 optional. If URL is for an External Tool, and target type is window or tab,  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,  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.  or may be a default defined in the domain for all instances of the tool.
   
Line 664  hidden URL set for the resource). Line 535  hidden URL set for the resource).
 =item $width  =item $width
   
 optional. If URL is for an External Tool, and target type is window,  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  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)  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  to launch the external tool.
 $is_ext is window, then a default width (px) may have been defined in the current  
 course for all external resource instances.  
   
 =item $height  =item $height
   
 optional. If URL is for an External Tool, and target type is window,  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  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)  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  to launch the external tool.
 $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
   
Line 694  Returns markup for the entire page. Line 555  Returns markup for the entire page.
 Content handler for requests for: /adm/wrapper/...  Content handler for requests for: /adm/wrapper/...
 used for content to be displayed in an iframe, or launched in a separate tab  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  or window via a link.  The target URL is extracted from the requested URL, by
 removing the /adm/wrapper prefix.  removing the /adm/wrapper prefix. 
   
 The target URL will typically be a PDF served from the current server, an  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  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  (from an LTI Provider) launched from LON-CAPA (as LTI Consumer) and launched
 via a link.  via a link.
   
 If the request included forceedit in the query string, and the requester has  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  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,  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).  or change the setting for the external tool instance.
   
 If not in edit mode, then the wrapper() subroutine will be called to generate the  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  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.  window, or an iframe to display the content inline. 
   
 =back  =back
   
Removed from v.1.49.2.11.2.5  
changed lines
  Added in v.1.77

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