--- rat/lonwrapper.pm 2001/07/05 18:14:17 1.3 +++ rat/lonwrapper.pm 2017/05/07 13:58:04 1.61 @@ -1,56 +1,366 @@ # The LearningOnline Network with CAPA # Wrapper for external and binary files as standalone resources # -# (Edit Handler for RAT Maps -# (TeX Content Handler +# $Id: lonwrapper.pm,v 1.61 2017/05/07 13:58:04 raeburn Exp $ # -# 05/29/00,05/30 Gerd Kortemeyer) -# 7/1,6/30 Gerd Kortemeyer) +# Copyright Michigan State University Board of Trustees # -# 7/5 Gerd Kortemeyer +# 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::lonnet(); -use Apache::lonxml(); +use Apache::lonenc(); +use Apache::lonnet; +use Apache::lonlocal; +use Apache::loncommon(); +use Apache::lonhtmlcommon(); +use Apache::lonextresedit(); +use Apache::lonexttool(); +use LONCAPA qw(:DEFAULT :match);; # ================================================================ Main Handler +sub wrapper { + my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title) = @_; -sub handler { - my $r=shift; - $r->content_type('text/html'); - $r->send_http_header; - - return OK if $r->header_only; - - my $url=$r->uri; - $url=~s/^\/adm\/wrapper//; - $url=~s/^\/ext\//http\:\/\//; - my $events='onLoad="'.&Apache::lonxml::loadevents. - '" onUnload="'.&Apache::lonxml::unloadevents.'"'; - my $script=&Apache::lonxml::registerurl(1); - $r->print(< - -$script - - - - - - -ENDDOCUMENT - return OK; + 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; + 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'}; + } + } + + 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 $startpage = &Apache::loncommon::start_page('Menu',undef,$args); + my $endpage = &Apache::loncommon::end_page(); + + if (($env{'browser.mobile'}) || ($exttool eq 'window')) { + 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)').''; + } elsif ($exttool eq 'window') { + if ($linktext eq '') { + $linktext = &mt('Launch External Tool'); + } + $output .= '

'. + ''. + $linktext.''. + '

'; + if ($explanation ne '') { + $output .= '

'.$explanation.'

'; + } + } else { + $output .= '

'."\n". + '\n". + "

\n"; + } + $output .= $endpage; + return $output; + } 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(< + + + $endpage +ENDFRAME + } } +sub handler { + my $r=shift; + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + + return OK if $r->header_only; + + my $url = $r->uri; + my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname, + $linktext,$explanation); + + for ($url){ + s|^/adm/wrapper||; + $is_ext = $_ =~ s|^/ext/|http://|; + s|http://https://|https://|; + s|:|:|g; + } + + + if ($url =~ /\.pdf$/i) { + $is_pdf = 1; + } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/exttool$}) { + $cdom = $1; + $cnum = $2; + my $marker = $3; + $exttool = 'iframe'; + my $exttoolremote; + my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation','id'], + $cdom,$cnum); + if ($toolhash{'id'}) { + my %ltitools = &Apache::lonnet::get_domain_ltitools($cdom); + if (ref($ltitools{$toolhash{'id'}}) eq 'HASH') { + $exttoolremote = $ltitools{$toolhash{'id'}}{'url'}; + } + } + if ($toolhash{'target'} eq 'window') { + $exttool = 'window'; + $linktext = $toolhash{'linktext'}; + $explanation = $toolhash{'explanation'}; + } elsif (($exttoolremote =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) { + $exttool = 'window'; + } + } + if (($is_ext) || ($exttool)) { + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['forceedit','register','folderpath','symb','idx','title','anchor']); + if (($env{'form.forceedit'}) && + (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) && + (($env{'form.folderpath'} =~ /^supplemental/) || + ($env{'form.symb'} =~ /^uploaded/))) { + if ($env{'form.symb'}) { + (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'}); + if ($res =~ /(#[^#]+)$/) { + $url .= $1; + } + } elsif ($env{'form.folderpath'} =~ /^supplemental/) { + if ($env{'form.anchor'} ne '') { + $url .= '#'.$env{'form.anchor'}; + } + } + 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,$hostname)); + return OK; + } elsif ($env{'form.folderpath'} =~ /^supplemental/) { + 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'); + } + } + $brcrum = + &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1); + } + } + +# +# Actual URL +# + if ($url=~/$LONCAPA::assess_re/) { +# +# This is uploaded homework +# + $env{'request.state'}='uploaded'; + &Apache::lonhomework::renderpage($r,$url); + } else { +# +# This is not homework +# + if (($is_ext) || ($exttool)) { + $absolute = $env{'request.use_absolute'}; + $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/; + $ENV{'QUERY_STRING'} =~ s/\&$//; + } + + unless ($ENV{'QUERY_STRING'} eq '') { + $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'}; + } + + # encrypt url if not external + unless ($is_ext) { + &Apache::lonenc::check_encrypt(\$url); + } + + $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation) ); + + } # not just the menu + + return OK; +} # handler + 1; __END__ +=pod + +=head1 NAME + +Apache::lonwrapper - External and binary file management. + +=head1 SYNOPSIS + +Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 Subroutines + +=over + +=item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$title)) + +=over + +=item $url + +url to display by including in an iframe within a +LON-CAPA page which has a standard LON-CAPA inline menu. + +=item $brcrum + +breadcrumbs for unregistered urls +(i.e., external resources in Supplemental Content). + +=item $absolute + +contains protocol (http or https) followed by +the hostname, if menu items in the standard LON-CAPA +interface created by the call to loncommon::start_page() +within &wrapper() need to use absolute URLs rather than +relative URLs. + +That will be the case where an external resource has been +served from port 80, when the server customarily serves +requests using Apache/SSL (i.e., port 443). mod_rewrite +is used to switch requests for external resources and +the syllabus: /public///syllabus +(which might also point at an external resource) +from https:// to http:// where the the URL of the remote site +specified in the resource itself is http://. + +This is done to avoid default mixed content blocking +in Firefox 23 and later, when serving from Apache/SSL. + +=item $is_ext + +true if URL is for an external resource. + +=item $is_pdf + +true if URL is for a PDF (based on file extension). + +=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 +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). +=back +Returns markup for the entire page. +=item handler() +=back +=cut