# The LearningOnline Network with CAPA
# Wrapper for external and binary files as standalone resources
#
# $Id: lonwrapper.pm,v 1.82 2023/05/22 21:20:56 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
package Apache::lonwrapper;
use strict;
use Apache::Constants qw(:common);
use Apache::lonenc();
use Apache::lonnet;
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 $forcereg;
unless ($env{'form.folderpath'}) {
$forcereg = 1;
}
my %lt = &Apache::lonlocal::texthash(
'noif' => 'No iframe support.',
'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'}) {
(undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
if ($res =~ /(#[^#]+)$/) {
$anchor = $1;
}
} 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) {
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);
my $args = {'bgcolor' => '#FFFFFF'};
if ($forcereg) {
$args->{'force_register'} = $forcereg;
}
if (ref($brcrum) eq 'ARRAY') {
$args->{'bread_crumbs'} = $brcrum;
}
if ($absolute) {
$args->{'use_absolute'} = $absolute;
}
if ($env{'form.only_body'}) {
$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();
}
}
#
# 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 (($uselink) && ($title eq '')) {
if ($env{'form.symb'}) {
$title=&Apache::lonnet::gettitle($env{'form.symb'});
} elsif (!$is_supp) {
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')) {
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 .= '