--- rat/lonwrapper.pm 2020/05/22 23:54:42 1.49.2.4.4.2 +++ rat/lonwrapper.pm 2021/10/19 00:16:32 1.77 @@ -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.4.4.2 2020/05/22 23:54:42 raeburn Exp $ +# $Id: lonwrapper.pm,v 1.77 2021/10/19 00:16:32 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -37,24 +37,29 @@ use Apache::lonlocal; use Apache::loncommon(); use Apache::lonhtmlcommon(); use Apache::lonextresedit(); +use Apache::lonexttool(); +use Apache::lonhomework(); use LONCAPA qw(:DEFAULT :match); +use HTML::Entities(); # ================================================================ Main Handler sub wrapper { - my ($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) = @_; my $forcereg; unless ($env{'form.folderpath'}) { $forcereg = 1; } - my %lt = &Apache::lonlocal::texthash( 'noif' => 'No iframe support.', 'show' => 'Show content in pop-up window', ); - my $anchor; + (undef,undef,undef,undef,undef,undef,my $clientmobile) = + &Apache::loncommon::decode_user_agent($r); + + my ($anchor,$uselink); if ($is_ext) { if ($env{'form.symb'}) { (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'}); @@ -64,6 +69,12 @@ sub wrapper { } elsif ($env{'form.anchor'} ne '') { $anchor = '#'.$env{'form.anchor'}; } + unless (($is_pdf) && ($clientmobile)) { + my $hostname = $r->hostname(); + my $lonhost = $r->dir_config('lonHostID'); + my $ip = &Apache::lonnet::get_host_ip($lonhost); + $uselink = &Apache::loncommon::is_nonframeable($url,$absolute,$hostname,$ip); + } } my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400); @@ -81,29 +92,92 @@ sub wrapper { $args->{'only_body'} = $env{'form.only_body'}; } - my $startpage = &Apache::loncommon::start_page('Menu',undef,$args); + my ($countdown,$donemsg,$headjs); + if (($exttool) && (&Apache::lonnet::EXT('resource.0.gradable') =~ /^yes$/i)) { + $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$url); + if ($env{'form.markaccess'}) { + my $symb=&Apache::lonnet::symbread($url); + my @interval=&Apache::lonnet::EXT('resource.0.interval',$symb); + my ($timelimit) = split(/_/,$interval[0]); + my $setres = &Apache::lonnet::set_first_access($interval[1],$timelimit); + if ($setres eq 'ok') { + delete($env{'form.markaccess'}); + } + } elsif ($env{'form.LC_interval_done'} eq 'true') { + my $symb=&Apache::lonnet::symbread($url); + if ($symb) { + (my $donebuttonresult,$donemsg) = &Apache::lonhomework::zero_timer($symb); + undef($env{'form.LC_interval_done'}); + undef($env{'form.LC_interval_done_proctorpass'}); + } + } + my ($status,$result,$resource_due) = + &Apache::lonexttool::gradabletool_access_check(); + undef($Apache::lonhomework::browse); + if ($status eq 'CAN_ANSWER') { + if ($resource_due) { + my $time_left = $resource_due - time(); + if ($resource_due && ($time_left > 0)) { + $countdown =' +'."\n". + &Apache::lonhtmlcommon::set_due_date($resource_due); + } + } + } else { + if ($status eq 'SHOW_ANSWER') { + $result = &Apache::lonexttool::display_score(). + &Apache::lonfeedback::list_discussion('tool','OPEN'); + } + return &Apache::loncommon::start_page('Menu',undef,$args). + $result. + &Apache::loncommon::end_page(); + } + } + +# +# 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).$countdown.$donemsg; my $endpage = &Apache::loncommon::end_page(); - if (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab')) { + if (($uselink) && ($title eq '')) { + if ($env{'form.symb'}) { + $title=&Apache::lonnet::gettitle($env{'form.symb'}); + } else { + my $symb=&Apache::lonnet::symbread($r->uri); + if ($symb) { + $title=&Apache::lonnet::gettitle($symb); + } + } + } + if ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab')) { my $output = $startpage; if ($is_pdf) { - if ($title eq '') { - $title = $env{'form.title'}; - if ($title eq '') { - unless ($env{'request.enc'}) { - ($title) = ($url =~ m{/([^/]+)$}); - $title =~ s/(\?[^\?]+)$//; - } - } - } - unless ($title eq '') { - $output .= $title.'
'; - } - $output .= ''.&mt('Link to PDF (for mobile devices)').''; + $linktext = &mt('Link to PDF (for mobile devices)'); + $output .= &create_link($url,$anchor,$title,$linktext); } elsif (($exttool eq 'window') || ($exttool eq 'tab')) { if ($linktext eq '') { $linktext = &mt('Launch External Tool'); } + $url = &HTML::Entities::encode($url,'"<>&'); if ($exttool eq 'tab') { $output .= '
'. ''. @@ -140,15 +214,27 @@ ENDLINK if ($explanation ne '') { $output .= '
'.$explanation.'
'; } + if (&Apache::lonnet::EXT('resource.0.gradable')) { + $output .= &Apache::lonfeedback::list_discussion('tool','OPEN'); + } } else { - $output .= '
'."\n". - '\n". - "
\n"; + if ($uselink) { + $linktext = &mt('Link to resource'); + $output .= &create_link($url,$anchor,$title,$linktext); + } else { + my $dest = &HTML::Entities::encode($url.$anchor,'&<>"'); + $output .= '
'."\n". + '\n". + "
\n"; + } } $output .= $endpage; return $output; + } elsif ($uselink) { + $linktext = &mt('Link to resource'); + return $startpage.&create_link($url,$anchor,$title,$linktext).$endpage; } else { my $offset = 5; &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']); @@ -177,21 +263,54 @@ ENDLINK 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 } } +sub create_link { + my ($url,$anchor,$title,$linktext) = @_; + my $shownlink; + if ($title eq '') { + $title = $env{'form.title'}; + if ($title eq '') { + unless ($env{'request.enc'}) { + ($title) = ($url =~ m{/([^/]+)$}); + $title =~ s/(\?[^\?]+)$//; + } + } + } + unless ($title eq '') { + $shownlink = ''.$title.'
'; + } + my $dest = &HTML::Entities::encode($url.$anchor,'&<>"'); + $shownlink .= ''.$linktext.''; + return $shownlink; +} + sub handler { my $r=shift; &Apache::loncommon::content_type($r,'text/html'); @@ -200,14 +319,14 @@ sub handler { return OK if $r->header_only; my $url = $r->uri; - my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum, + my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname, $linktext,$explanation,$width,$height); 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) { @@ -260,18 +379,24 @@ sub handler { my $type = 'ext'; if ($exttool) { $type = 'tool'; + } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) { + $hostname = $r->hostname(); } $r->print( &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'}, $env{'form.symb'}, $env{'form.idx'},$type,$cdom, - $cnum)); + $cnum,$hostname)); return OK; } elsif ($env{'form.folderpath'} =~ /^supplemental/) { 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); @@ -306,7 +431,7 @@ sub handler { &Apache::lonenc::check_encrypt(\$url); } - $r->print( wrapper($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) ); } # not just the menu @@ -334,14 +459,21 @@ described at http://www.lon-capa.org. =over -=item wrapper($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) =over +=item $r + +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 @@ -382,20 +514,20 @@ If URL is for an External Tool, will con =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, 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, +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). @@ -403,14 +535,14 @@ 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 +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. =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 +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. @@ -420,6 +552,25 @@ 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 didplayed 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