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

Diff for /rat/lonwrapper.pm between versions 1.78 and 1.86

version 1.78, 2022/08/28 02:41:30 version 1.86, 2023/12/31 21:45:03
Line 47  use Digest::MD5(); Line 47  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) = @_;          $title,$width,$height,$reuse,$is_supp) = @_;
   
     my $forcereg;      my $forcereg;
     unless ($env{'form.folderpath'}) {      unless ($env{'form.folderpath'}) {
Line 82  sub wrapper { Line 82  sub wrapper {
         }          }
     }      }
   
     my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);      my $noiframe = &Apache::loncommon::modal_link(&HTML::Entities::encode($url.$anchor,'&<>"\''),$lt{'show'},500,400);
     my $args = {'bgcolor' => '#FFFFFF'};      my $args = {'bgcolor' => '#FFFFFF'};
     if ($forcereg) {      if ($forcereg) {
         $args->{'force_register'} = $forcereg;          $args->{'force_register'} = $forcereg;
Line 95  sub wrapper { Line 95  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 151  sub wrapper { Line 153  sub wrapper {
 #  #
   
     unless ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {      unless ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
         $headjs = '          $headjs = &Apache::loncommon::iframe_wrapper_headjs();
 <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 $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args).$countdown.$donemsg;
Line 166  var LCresizedef = 0; Line 162  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);
Line 225  var LCresizedef = 0; Line 221  var LCresizedef = 0;
                     unless ($reuse) {                      unless ($reuse) {
                         my $resid;                          my $resid;
                         if ($env{'request.course.id'}) {                          if ($env{'request.course.id'}) {
                             unless ($env{'form.folderpath'} =~ /^supplemental/) {                              unless (($is_supp) || ($env{'form.folderpath'} =~ /^supplemental/)) {
                                 my $symb=&Apache::lonnet::symbread($r->uri);                                  my $symb=&Apache::lonnet::symbread($r->uri);
                                 if ($symb) {                                  if ($symb) {
                                     my $navmap = Apache::lonnavmaps::navmap->new();                                      my $navmap = Apache::lonnavmaps::navmap->new();
Line 300  ENDLINK Line 296  ENDLINK
         $linktext = &mt('Link to resource');          $linktext = &mt('Link to resource');
         return $startpage.&create_link($url,$anchor,$title,$linktext).$endpage;          return $startpage.&create_link($url,$anchor,$title,$linktext).$endpage;
     } else {      } 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)          # javascript will position the iframe if window was resized (or zoomed)
           my $script = &Apache::loncommon::iframe_wrapper_resizejs();
         my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');          my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
         return <<ENDFRAME;          return <<ENDFRAME;
         $startpage          $startpage
Line 384  sub handler { Line 339  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);          $linktext,$explanation,$width,$height,$reuse,$is_supp);
   
     for ($url){      for ($url){
         s|^/adm/wrapper||;          s|^/adm/wrapper||;
Line 409  sub handler { Line 364  sub handler {
                 }                  }
                 unless ($height =~ /^\d+$/) {                  unless ($height =~ /^\d+$/) {
                     $height = '';                      $height = '';
                 }                   }
             } else {              } else {
                 $width = '';                  $width = '';
                 $height = '';                  $height = '';
Line 425  sub handler { Line 380  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 %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');              my ($idx,%ltitools);
             if (ref($ltitools{$toolhash{'id'}}) eq 'HASH') {              if ($toolhash{'id'} =~ /^c(\d+)$/) {
                 $exttoolremote = $ltitools{$toolhash{'id'}}{'url'};                  $idx = $1;
                   %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 446  sub handler { Line 408  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']);              ['forceedit','register','folderpath','symb','idx','title','anchor','only_body']);
         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 460  sub handler { Line 422  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 483  sub handler { Line 446  sub handler {
                     $title = &mt('External Tool');                      $title = &mt('External Tool');
                 }                  }
             }              }
             $brcrum =              $title = &HTML::Entities::encode($title,'\'"<>&');
                 &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);              $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);
               }
               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 517  sub handler { Line 509  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,$reuse,
                              $is_supp) );
   
     } # not just the menu      } # not just the menu
           
Line 544  described at http://www.lon-capa.org. Line 537  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)  =item wrapper()
   
   Args: $r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height,$reuse,$is_supp
   
 =over  =over
   
Line 588  in Firefox 23 and later, when serving fr Line 583  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. Default true value
 is 1 (display in iframe, unless $uselink is true).   is 1 (display in iframe, unless $uselink is true).
 If external resource is to be displayed in a tab,  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 tab, if to be displayed in a pop-up window,
 value of $is_ext will be window.    value of $is_ext will be window.
   
 =item $is_pdf  =item $is_pdf
   
Line 603  If URL is for an External Tool, will con Line 598  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 624  hidden URL set for the resource). Line 619  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. 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  $is_ext is window, then a default width (px) may have been defined in the current
 course for all external resource instances.  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.  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  $is_ext is window, then a default height (px) may have been defined in the current
 course for all external resource instances.  course for all external resource instances.
   
Line 649  of all external resource instances in a Line 644  of all external resource instances in a
   
 Returns markup for the entire page.  Returns markup for the entire page.
   
   =item create_link()
   
   Args: $url,$anchor,$title,$linktext
   
   =over
   
   =item $url
   
   URL to link to
   
   =item $anchor
   
   optional.  Will be the anchor to append to the URL, if there is one.
   
   =item $title
   
   optional. If provided will be the title displayed above the link. If
   one is not provided, then $env{'form.title'} will be used, unless empty.
   
   =item $linktext
   
   The text to inlcude between the <a href="$url"> and </a> tags.
   
   =back
   
   Returns HTML needed to show a link which can be followed to display the
   part of the original URL following the initial /adm/wrapper part 
   in the original request, in the case where an iframe is not going to be
   used to embed the content available at the URL in the existing page.
   
 =item handler()  =item handler()
   
 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.78  
changed lines
  Added in v.1.86

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