Annotation of rat/lonwrapper.pm, revision 1.60
1.1 www 1: # The LearningOnline Network with CAPA
2: # Wrapper for external and binary files as standalone resources
3: #
1.60 ! raeburn 4: # $Id: lonwrapper.pm,v 1.59 2017/04/22 16:15:13 raeburn Exp $
1.4 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 www 28:
1.29 jms 29:
1.1 www 30: package Apache::lonwrapper;
31:
32: use strict;
33: use Apache::Constants qw(:common);
1.38 droeschl 34: use Apache::lonenc();
1.18 albertel 35: use Apache::lonnet;
1.42 raeburn 36: use Apache::lonlocal;
37: use Apache::loncommon();
38: use Apache::lonhtmlcommon();
39: use Apache::lonextresedit();
1.50 raeburn 40: use Apache::lonexttool();
41: use LONCAPA qw(:DEFAULT :match);;
1.1 www 42:
43: # ================================================================ Main Handler
1.21 albertel 44: sub wrapper {
1.60 ! raeburn 45: my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title) = @_;
1.23 albertel 46:
1.42 raeburn 47: my $forcereg;
48: unless ($env{'form.folderpath'}) {
49: $forcereg = 1;
50: }
1.46 raeburn 51: my %lt = &Apache::lonlocal::texthash(
52: 'noif' => 'No iframe support.',
53: 'show' => 'Show content in pop-up window',
54: );
55:
1.51 raeburn 56: my $anchor;
1.53 raeburn 57: if ($is_ext) {
58: if ($env{'form.symb'}) {
59: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
60: if ($res =~ /(#[^#]+)$/) {
61: $anchor = $1;
62: }
63: } elsif ($env{'form.anchor'} ne '') {
64: $anchor = '#'.$env{'form.anchor'};
1.51 raeburn 65: }
66: }
67:
68: my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
1.42 raeburn 69: my $args = {'bgcolor' => '#FFFFFF'};
70: if ($forcereg) {
71: $args->{'force_register'} = $forcereg;
72: }
73: if (ref($brcrum) eq 'ARRAY') {
1.45 raeburn 74: $args->{'bread_crumbs'} = $brcrum;
1.42 raeburn 75: }
1.44 raeburn 76: if ($absolute) {
1.57 raeburn 77: $args->{'use_absolute'} = $absolute;
1.44 raeburn 78: }
1.56 raeburn 79: if ($env{'form.only_body'}) {
80: $args->{'only_body'} = $env{'form.only_body'};
81: }
1.42 raeburn 82:
1.46 raeburn 83: my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);
84: my $endpage = &Apache::loncommon::end_page();
1.50 raeburn 85:
86: if (($env{'browser.mobile'}) || ($exttool eq 'window')) {
1.47 raeburn 87: my $output = $startpage;
88: if ($is_pdf) {
89: if ($title eq '') {
1.49 raeburn 90: $title = $env{'form.title'};
91: if ($title eq '') {
92: unless ($env{'request.enc'}) {
93: ($title) = ($url =~ m{/([^/]+)$});
94: $title =~ s/(\?[^\?]+)$//;
95: }
1.47 raeburn 96: }
97: }
98: unless ($title eq '') {
99: $output .= $title.'<br />';
100: }
101: $output .= '<a href="'.$url.'">'.&mt('Link to PDF (for mobile devices)').'</a>';
1.50 raeburn 102: } elsif ($exttool eq 'window') {
1.60 ! raeburn 103: if ($linktext eq '') {
! 104: $linktext = &mt('Launch External Tool');
! 105: }
1.50 raeburn 106: $output .= '<div>'.
107: '<a href="'.$url.'" target="LC_LTI" style="padding:0;clear:both;margin:0;border:0">'.
1.60 ! raeburn 108: $linktext.'</a>'.
1.50 raeburn 109: '</div>';
1.60 ! raeburn 110: if ($explanation ne '') {
! 111: $output .= '<div>'.$explanation.'</div>';
! 112: }
1.47 raeburn 113: } else {
114: $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
1.51 raeburn 115: '<iframe src="'.$url.$anchor.'" height="100%" width="100%" frameborder="0">'."\n".
1.47 raeburn 116: "$lt{'noif'} $noiframe\n".
117: "</iframe>\n".
118: "</div>\n";
119: }
120: $output .= $endpage;
121: return $output;
1.46 raeburn 122: } else {
1.55 raeburn 123: my $offset = 5;
124: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
125: if ($env{'form.inhibitmenu'} eq 'yes') {
126: $offset = 0;
127: }
1.46 raeburn 128: my $script = &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
129: \$(document).ready( function() {
130: \$(window).unbind('resize').resize(function(){
1.54 damieng 131: var header = null;
1.55 raeburn 132: var offset = $offset;
1.46 raeburn 133: var height = 0;
134: var hdrtop = 0;
135: if (\$('div.LC_head_subbox:first').length) {
136: header = \$('div.LC_head_subbox:first');
137: offset = 9;
138: } else {
139: if (\$('#LC_breadcrumbs').length) {
140: header = \$('#LC_breadcrumbs');
141: }
142: }
1.54 damieng 143: if (header != null && header.length) {
1.46 raeburn 144: height = header.height();
145: hdrtop = header.position().top;
1.42 raeburn 146: }
1.46 raeburn 147: var pos = height + hdrtop + offset;
148: \$('.LC_iframecontainer').css('top', pos);
149: });
1.38 droeschl 150: });
1.46 raeburn 151: window.onload = function(){ \$(window).trigger('resize') };
1.39 droeschl 152: SCRIPT
1.46 raeburn 153: # javascript will position the iframe if window was resized (or zoomed)
154: return <<ENDFRAME;
155: $startpage
156: $script
157: <div class="LC_iframecontainer">
1.51 raeburn 158: <iframe src="$url$anchor">$lt{'noif'} $noiframe</iframe>
1.46 raeburn 159: </div>
160: $endpage
1.38 droeschl 161: ENDFRAME
1.46 raeburn 162: }
1.21 albertel 163: }
164:
165: sub handler {
166: my $r=shift;
167: &Apache::loncommon::content_type($r,'text/html');
168: $r->send_http_header;
169:
170: return OK if $r->header_only;
171:
1.38 droeschl 172: my $url = $r->uri;
1.60 ! raeburn 173: my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
! 174: $linktext,$explanation);
1.38 droeschl 175:
176: for ($url){
177: s|^/adm/wrapper||;
178: $is_ext = $_ =~ s|^/ext/|http://|;
179: s|http://https://|https://|;
180: s|:|:|g;
1.21 albertel 181: }
182:
1.50 raeburn 183:
1.47 raeburn 184: if ($url =~ /\.pdf$/i) {
185: $is_pdf = 1;
1.50 raeburn 186: } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/exttools?$}) {
187: $cdom = $1;
188: $cnum = $2;
189: my $marker = $3;
190: $exttool = 'iframe';
1.60 ! raeburn 191: my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation'],
! 192: $cdom,$cnum);
1.50 raeburn 193: if ($toolhash{'target'} eq 'window') {
1.60 ! raeburn 194: $exttool = 'window';
! 195: $linktext = $toolhash{'linktext'};
! 196: $explanation = $toolhash{'explanation'};
1.50 raeburn 197: }
1.47 raeburn 198: }
1.50 raeburn 199: if (($is_ext) || ($exttool)) {
1.42 raeburn 200: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.53 raeburn 201: ['forceedit','register','folderpath','symb','idx','title','anchor']);
1.42 raeburn 202: if (($env{'form.forceedit'}) &&
203: (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
204: (($env{'form.folderpath'} =~ /^supplemental/) ||
205: ($env{'form.symb'} =~ /^uploaded/))) {
1.53 raeburn 206: if ($env{'form.symb'}) {
207: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
208: if ($res =~ /(#[^#]+)$/) {
209: $url .= $1;
210: }
211: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
212: if ($env{'form.anchor'} ne '') {
213: $url .= '#'.$env{'form.anchor'};
214: }
1.52 raeburn 215: }
1.50 raeburn 216: my $type = 'ext';
217: if ($exttool) {
218: $type = 'tool';
1.58 raeburn 219: } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
220: $hostname = $r->hostname();
1.50 raeburn 221: }
1.42 raeburn 222: $r->print(
223: &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
224: $env{'form.symb'},
1.50 raeburn 225: $env{'form.idx'},$type,$cdom,
1.58 raeburn 226: $cnum,$hostname));
1.42 raeburn 227: return OK;
228: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
229: my $crstype = &Apache::loncommon::course_type();
1.43 raeburn 230: my $title = $env{'form.title'};
231: if ($title eq '') {
1.50 raeburn 232: if ($is_ext) {
233: $title = &mt('External Resource');
234: } else {
235: $title = &mt('External Tool');
236: }
1.43 raeburn 237: }
1.42 raeburn 238: $brcrum =
1.43 raeburn 239: &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
1.42 raeburn 240: }
241: }
242:
1.21 albertel 243: #
244: # Actual URL
245: #
1.41 www 246: if ($url=~/$LONCAPA::assess_re/) {
1.21 albertel 247: #
248: # This is uploaded homework
249: #
1.38 droeschl 250: $env{'request.state'}='uploaded';
251: &Apache::lonhomework::renderpage($r,$url);
1.21 albertel 252: } else {
253: #
254: # This is not homework
255: #
1.50 raeburn 256: if (($is_ext) || ($exttool)) {
1.49 raeburn 257: $absolute = $env{'request.use_absolute'};
1.38 droeschl 258: $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
1.42 raeburn 259: $ENV{'QUERY_STRING'} =~ s/\&$//;
1.38 droeschl 260: }
261:
1.35 raeburn 262: unless ($ENV{'QUERY_STRING'} eq '') {
1.38 droeschl 263: $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
1.35 raeburn 264: }
1.38 droeschl 265:
266: # encrypt url if not external
1.59 raeburn 267: unless ($is_ext) {
1.50 raeburn 268: &Apache::lonenc::check_encrypt(\$url);
269: }
1.38 droeschl 270:
1.60 ! raeburn 271: $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation) );
1.38 droeschl 272:
1.21 albertel 273: } # not just the menu
1.38 droeschl 274:
1.21 albertel 275: return OK;
1.13 www 276: } # handler
1.1 www 277:
278: 1;
279: __END__
280:
1.30 jms 281: =pod
1.1 www 282:
1.30 jms 283: =head1 NAME
284:
285: Apache::lonwrapper - External and binary file management.
286:
287: =head1 SYNOPSIS
288:
289: Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
290:
291: This is part of the LearningOnline Network with CAPA project
292: described at http://www.lon-capa.org.
293:
294: =head1 Subroutines
295:
296: =over
297:
1.49 raeburn 298: =item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
1.30 jms 299:
1.45 raeburn 300: =over
301:
1.46 raeburn 302: =item $url
303:
1.45 raeburn 304: url to display by including in an iframe within a
305: LON-CAPA page which has a standard LON-CAPA inline menu.
306:
307: =item $brcrum
308:
309: breadcrumbs for unregistered urls
1.42 raeburn 310: (i.e., external resources in Supplemental Content).
1.45 raeburn 311:
1.46 raeburn 312: =item $absolute
1.45 raeburn 313:
314: contains protocol (http or https) followed by
315: the hostname, if menu items in the standard LON-CAPA
316: interface created by the call to loncommon::start_page()
317: within &wrapper() need to use absolute URLs rather than
318: relative URLs.
319:
320: That will be the case where an external resource has been
321: served from port 80, when the server customarily serves
322: requests using Apache/SSL (i.e., port 443). mod_rewrite
1.49 raeburn 323: is used to switch requests for external resources and
324: the syllabus: /public/<domain>/<courseid>/syllabus
325: (which might also point at an external resource)
1.45 raeburn 326: from https:// to http:// where the the URL of the remote site
327: specified in the resource itself is http://.
328:
329: This is done to avoid default mixed content blocking
330: in Firefox 23 and later, when serving from Apache/SSL.
331:
332: =item $is_ext
333:
334: true if URL is for an external resource.
335:
1.47 raeburn 336: =item $is_pdf
337:
338: true if URL is for a PDF (based on file extension).
339:
1.49 raeburn 340: =item $title
341:
342: optional. If wrapped item is a PDF, and $env{'browser.mobile'}
343: is true, a link to a PDF is shown. The "title" will be displayed
344: above the link, but if not provided as an arg, $env{'form.title'}
345: will be used, otherwise, the filename will be displayed (unless
346: hidden URL set for the resource).
347:
1.45 raeburn 348: =back
349:
1.38 droeschl 350: Returns markup for the entire page.
1.30 jms 351:
352: =item handler()
353:
354: =back
355:
356: =cut
1.1 www 357:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonwrapper.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / rat