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

Diff for /rat/lonwrapper.pm between versions 1.76 and 1.80

version 1.76, 2020/02/29 16:05:26 version 1.80, 2022/10/27 21:35:30
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) = @_;          $title,$width,$height,$reuse,$is_supp) = @_;
   
     my $forcereg;      my $forcereg;
     unless ($env{'form.folderpath'}) {      unless ($env{'form.folderpath'}) {
Line 56  sub wrapper { Line 58  sub wrapper {
                                           'show' => 'Show content in pop-up window',                                            'show' => 'Show content in pop-up window',
                                         );                                          );
   
       (undef,undef,undef,undef,undef,undef,my $clientmobile) =
           &Apache::loncommon::decode_user_agent($r);
   
     my ($anchor,$uselink);      my ($anchor,$uselink);
     if ($is_ext) {      if ($is_ext) {
         if ($env{'form.symb'}) {          if ($env{'form.symb'}) {
Line 66  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) && ($env{'browser.mobile'})) {          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 142  sub wrapper { Line 150  sub wrapper {
 # do not obscure the Functions menu.  # do not obscure the Functions menu.
 #  #
   
     unless (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {      unless ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
         $headjs = '          $headjs = '
 <script type="text/javascript">  <script type="text/javascript">
 // <![CDATA[  // <![CDATA[
Line 158  var LCresizedef = 0; Line 166  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 (($env{'browser.mobile'}) || ($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 '') {
                 $linktext = &mt('Launch External Tool');                  if ($exttool) {
                       $linktext = &mt('Launch External Tool');
                   } else {
                       $linktext = &mt('Link to External Resource');
                   }
             }              }
             $url = &HTML::Entities::encode($url,'"<>&');              if ($exttool) {
             if ($exttool eq 'tab') {                  $url = &HTML::Entities::encode($url,'"<>&');
                 $output .= '<div>'.              } else {
                            '<a href="'.$url.'" target="LCExternalToolTab" style="padding:0;clear:both;margin:0;border:0">'.                  $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>'.                             $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 189  var PreviousUrl; Line 254  var PreviousUrl;
   
 function openSinglePopup(strUrl) {  function openSinglePopup(strUrl) {
     if (windowObjectReference == null || windowObjectReference.closed) {      if (windowObjectReference == null || windowObjectReference.closed) {
         windowObjectReference = window.open(strUrl, "LCExternalToolPopUp",          windowObjectReference = window.open(strUrl, "$target",
                                             "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, "LCExternalToolPopUp",          windowObjectReference = window.open(strUrl, "$target",
                                             "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 202  function openSinglePopup(strUrl) { Line 267  function openSinglePopup(strUrl) {
 }  }
 // ]]>  // ]]>
 </script>  </script>
 <div>  <div>$preamble
 <a href="$url" target="LCExternalToolPopUp" onclick="openSinglePopup(this.href); return false;">  <a href="$url" target="$target" onclick="openSinglePopup(this.href); return false;">
 $linktext</a>  $linktext$extlinkimg</a>
 </div>  </div>
 ENDLINK  ENDLINK
             }              }
             if ($explanation ne '') {              if ($exttool) {
                 $output .= '<div>'.$explanation.'</div>';                  if ($explanation ne '') {
             }                      $output .= '<div>'.$explanation.'</div>';
             if (&Apache::lonnet::EXT('resource.0.gradable')) {                  }
                 $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');                  if (&Apache::lonnet::EXT('resource.0.gradable')) {
                       $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');
                   }
             }              }
         } else {          } else {
             if ($uselink) {              if ($uselink) {
Line 317  sub handler { Line 384  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);          $linktext,$explanation,$width,$height,$reuse,$is_supp);
   
     for ($url){      for ($url){
         s|^/adm/wrapper||;          s|^/adm/wrapper||;
Line 328  sub handler { Line 395  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 372  sub handler { Line 460  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 395  sub handler { Line 484  sub handler {
                     $title = &mt('External Tool');                      $title = &mt('External Tool');
                 }                  }
             }              }
               $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'};
               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);
   
         }          }
     }      }
   
Line 429  sub handler { Line 542  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) );                             $linktext,$explanation,undef,$width,$height,$reuse,
                              $is_supp) );
   
     } # not just the menu      } # not just the menu
           
Line 456  described at http://www.lon-capa.org. Line 570  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)  =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height,$reuse,$is_supp)
   
 =over  =over
   
Line 499  in Firefox 23 and later, when serving fr Line 613  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
   
Line 511  If URL is for an External Tool, will con Line 629  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.
   
 =item $title  =item $title
   
 optional. If wrapped item is a PDF, and $env{'browser.mobile'}   optional. If wrapped item is a PDF, and $clientmobile is true,
 is true, a link to a PDF is shown. The "title" will be displayed  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'}  above the link, but if not provided as an arg, $env{'form.title'}
 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).
Line 532  hidden URL set for the resource). Line 650  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.  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  =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.  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
   
Line 552  Returns markup for the entire page. Line 680  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 didplayed to allow  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,  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.76  
changed lines
  Added in v.1.80

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