--- rat/lonwrapper.pm 2019/07/31 00:36:10 1.49.2.6 +++ rat/lonwrapper.pm 2022/08/30 11:48:33 1.49.2.11.2.2 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Wrapper for external and binary files as standalone resources # -# $Id: lonwrapper.pm,v 1.49.2.6 2019/07/31 00:36:10 raeburn Exp $ +# $Id: lonwrapper.pm,v 1.49.2.11.2.2 2022/08/30 11:48:33 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -37,10 +37,16 @@ use Apache::lonlocal; use Apache::loncommon(); use Apache::lonhtmlcommon(); use Apache::lonextresedit(); +use Apache::lonexttool(); +use Apache::lonnavmaps(); +use LONCAPA qw(:DEFAULT :match); +use HTML::Entities(); +use Digest::MD5(); # ================================================================ Main Handler 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) = @_; my $forcereg; unless ($env{'form.folderpath'}) { @@ -52,6 +58,9 @@ sub wrapper { 'show' => 'Show content in pop-up window', ); + (undef,undef,undef,undef,undef,undef,my $clientmobile) = + &Apache::loncommon::decode_user_agent($r); + my ($anchor,$uselink); if ($is_ext) { if ($env{'form.symb'}) { @@ -62,7 +71,10 @@ sub wrapper { } elsif ($env{'form.anchor'} ne '') { $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 $lonhost = $r->dir_config('lonHostID'); my $ip = &Apache::lonnet::get_host_ip($lonhost); @@ -85,7 +97,26 @@ sub wrapper { $args->{'only_body'} = $env{'form.only_body'}; } - my $startpage = &Apache::loncommon::start_page('Menu',undef,$args); + my $headjs; + +# +# 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) +# are used to ensure document.ready() triggers a call to resize, so the iframe contents +# do not obscure the Functions menu. +# + + unless ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) { + $headjs = ' +'."\n"; + } + + my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args); my $endpage = &Apache::loncommon::end_page(); if (($uselink) && ($title eq '')) { @@ -98,11 +129,111 @@ sub wrapper { } } } - if ($env{'browser.mobile'}) { + if ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || + ($is_ext eq 'tab') || ($is_ext eq 'window')) { my $output = $startpage; if ($is_pdf) { $linktext = &mt('Link to PDF (for mobile devices)'); $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 = ''.$title.'
'; + } + } + $output .= '
'.$preamble. + ''. + $linktext.''. + '
'; + } else { + my ($target,$extlinkimg); + if ($exttool) { + $target = 'LCExternalToolPopUp'; + } else { + $target = 'LCExternalResPopUp'; + if ($title ne '') { + $preamble = ''.$title.'
'; + } + $extlinkimg = ''; + unless ($reuse) { + my $resid; + if ($env{'request.course.id'}) { + unless ($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"; + +
$preamble + +$linktext$extlinkimg +
+ENDLINK + } + if ($exttool) { + if ($explanation ne '') { + $output .= '
'.$explanation.'
'; + } + } } else { if ($uselink) { $linktext = &mt('Link to resource'); @@ -149,15 +280,28 @@ sub wrapper { var pos = height + hdrtop + offset; \$('.LC_iframecontainer').css('top', pos); }); + LCresizedef = 1; + if (LCnotready == 1) { + LCnotready = 0; + \$(window).trigger('resize'); + } }); - window.onload = function(){ \$(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 < - + $endpage ENDFRAME @@ -192,20 +336,68 @@ sub handler { return OK if $r->header_only; 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); for ($url){ s|^/adm/wrapper||; - $is_ext = $_ =~ s|^/ext/|http://|; - s|http://https://|https://|; - s|:|:|g; + $is_ext = $_ =~ s|^/ext/|http://|; + s|http://https://|https://| if ($is_ext); + s|:|:|g; } if ($url =~ /\.pdf$/i) { $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) { + if (($is_ext) || ($exttool)) { &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['forceedit','register','folderpath','symb','idx','title','anchor']); if (($env{'form.forceedit'}) && @@ -222,10 +414,12 @@ sub handler { $url .= '#'.$env{'form.anchor'}; } } - if (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) { + my $type = 'ext'; + if ($exttool) { + $type = 'tool'; + } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) { $hostname = $r->hostname(); } - my $type = 'ext'; $r->print( &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'}, $env{'form.symb'}, @@ -236,7 +430,11 @@ sub handler { my $crstype = &Apache::loncommon::course_type(); my $title = $env{'form.title'}; if ($title eq '') { - $title = &mt('External Resource'); + if ($is_ext) { + $title = &mt('External Resource'); + } else { + $title = &mt('External Tool'); + } } $brcrum = &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1); @@ -246,7 +444,7 @@ sub handler { # # Actual URL # - if ($url=~/$LONCAPA::assess_re/) { + if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) { # # This is uploaded homework # @@ -256,7 +454,7 @@ sub handler { # # This is not homework # - if ($is_ext) { + if (($is_ext) || ($exttool)) { $absolute = $env{'request.use_absolute'}; $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/; $ENV{'QUERY_STRING'} =~ s/\&$//; @@ -267,9 +465,12 @@ sub handler { } # 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) ); } # not just the menu @@ -296,7 +497,7 @@ described at http://www.lon-capa.org. =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) =over @@ -306,8 +507,11 @@ request object =item $url -url to display by including in an iframe within a -LON-CAPA page which has a standard LON-CAPA inline menu. +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 @@ -336,26 +540,89 @@ in Firefox 23 and later, when serving fr =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 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 +optional. If wrapped item is a PDF, and $clientmobile 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. 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 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 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 =cut