--- rat/lonwrapper.pm 2023/07/06 19:53:17 1.49.2.11.2.4 +++ rat/lonwrapper.pm 2024/07/04 02:30:39 1.49.2.12 @@ -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.11.2.4 2023/07/06 19:53:17 raeburn Exp $ +# $Id: lonwrapper.pm,v 1.49.2.12 2024/07/04 02:30:39 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -37,22 +37,16 @@ use Apache::lonlocal; use Apache::loncommon(); use Apache::lonhtmlcommon(); use Apache::lonextresedit(); -use Apache::lonexttool(); -use Apache::lonhomework(); -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,$exttool,$linktext,$explanation, - $title,$width,$height,$reuse,$is_supp) = @_; + my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title) = @_; my $forcereg; unless ($env{'form.folderpath'}) { $forcereg = 1; } + my %lt = &Apache::lonlocal::texthash( 'noif' => 'No iframe support.', 'show' => 'Show content in pop-up window', @@ -61,7 +55,7 @@ sub wrapper { (undef,undef,undef,undef,undef,undef,my $clientmobile) = &Apache::loncommon::decode_user_agent($r); - my ($anchor,$uselink); + my ($anchor,$uselink,$linktext); if ($is_ext) { if ($env{'form.symb'}) { (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'}); @@ -71,10 +65,7 @@ sub wrapper { } elsif ($env{'form.anchor'} ne '') { $anchor = '#'.$env{'form.anchor'}; } - if (($is_ext eq 'tab') || ($is_ext eq 'window')) { - $uselink = 1; - } - unless (($is_pdf && $clientmobile) || $uselink) { + unless (($is_pdf) && ($clientmobile)) { my $hostname = $r->hostname(); my $lonhost = $r->dir_config('lonHostID'); my $ip = &Apache::lonnet::get_host_ip($lonhost); @@ -82,7 +73,7 @@ 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'}; if ($forcereg) { $args->{'force_register'} = $forcereg; @@ -97,51 +88,7 @@ sub wrapper { $args->{'only_body'} = $env{'form.only_body'}; } - 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(); - } - } + my $headjs; # # Where iframe is in use, if window.onload() executes before the custom resize function @@ -150,7 +97,7 @@ sub wrapper { # do not obscure the Functions menu. # - unless ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) { + unless ($clientmobile || $uselink) { $headjs = ' '."\n"; } - my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args).$countdown.$donemsg; + my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args); my $endpage = &Apache::loncommon::end_page(); if (($uselink) && ($title eq '')) { if ($env{'form.symb'}) { $title=&Apache::lonnet::gettitle($env{'form.symb'}); - } elsif (!$is_supp) { + } else { my $symb=&Apache::lonnet::symbread($r->uri); if ($symb) { $title=&Apache::lonnet::gettitle($symb); } } } - if ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || - ($is_ext eq 'tab') || ($is_ext eq 'window')) { + if ($clientmobile) { 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 (($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"; - -
$preamble - -$linktext$extlinkimg -
-ENDLINK - } - if ($exttool) { - if ($explanation ne '') { - $output .= '
'.$explanation.'
'; - } - if (&Apache::lonnet::EXT('resource.0.gradable')) { - $output .= &Apache::lonfeedback::list_discussion('tool','OPEN'); - } - } } else { if ($uselink) { $linktext = &mt('Link to resource'); @@ -343,12 +187,11 @@ ENDLINK }; SCRIPT # javascript will position the iframe if window was resized (or zoomed) - my $dest = &HTML::Entities::encode($url.$anchor,'&<>"'); return < - + $endpage ENDFRAME @@ -383,8 +226,7 @@ sub handler { return OK if $r->header_only; my $url = $r->uri; - my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname, - $linktext,$explanation,$width,$height,$reuse,$is_supp); + my ($is_ext,$brcrum,$absolute,$is_pdf,$cdom,$cnum,$hostname); for ($url){ s|^/adm/wrapper||; @@ -395,63 +237,9 @@ sub handler { 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 ($idx,%ltitools); - if ($toolhash{'id'} =~ /^c(\d+)$/) { - $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') { - $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) || ($exttool)) { + + if ($is_ext) { &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['forceedit','register','folderpath','symb','idx','title','anchor']); if (($env{'form.forceedit'}) && @@ -467,14 +255,11 @@ sub handler { if ($env{'form.anchor'} ne '') { $url .= '#'.$env{'form.anchor'}; } - $is_supp = 1; } - my $type = 'ext'; - if ($exttool) { - $type = 'tool'; - } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) { + if (($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'}, @@ -485,47 +270,17 @@ sub handler { my $crstype = &Apache::loncommon::course_type(); my $title = $env{'form.title'}; if ($title eq '') { - if ($is_ext) { - $title = &mt('External Resource'); - } else { - $title = &mt('External Tool'); - } - } - $title = &HTML::Entities::encode($title,'\'"<>&'); - $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); + $title = &mt('External Resource'); } $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'}; - $title = &HTML::Entities::encode($title,'\'"<>&'); - my $crstype = &Apache::loncommon::course_type(); - $brcrum = - &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1); - - } } # # Actual URL # - if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) { + if ($url=~/$LONCAPA::assess_re/) { # # This is uploaded homework # @@ -535,7 +290,7 @@ sub handler { # # This is not homework # - if (($is_ext) || ($exttool)) { + if ($is_ext) { $absolute = $env{'request.use_absolute'}; $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/; $ENV{'QUERY_STRING'} =~ s/\&$//; @@ -546,13 +301,9 @@ sub handler { } # encrypt url if not external - unless ($is_ext) { - &Apache::lonenc::check_encrypt(\$url); - } + &Apache::lonenc::check_encrypt(\$url) if $url !~ /^https?\:/ ; - $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool, - $linktext,$explanation,undef,$width,$height,$reuse, - $is_supp) ); + $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf) ); } # not just the menu @@ -579,7 +330,7 @@ described at http://www.lon-capa.org. =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,$title)) =over @@ -589,11 +340,8 @@ request object =item $url -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. +url to display by including in an iframe within a +LON-CAPA page which has a standard LON-CAPA inline menu. =item $brcrum @@ -622,32 +370,12 @@ in Firefox 23 and later, when serving fr =item $is_ext -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. +true if URL is for an external resource. =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 $clientmobile is true, @@ -656,55 +384,12 @@ above the link, but if not provided as a 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