Annotation of rat/lonwrapper.pm, revision 1.49.2.8
1.1 www 1: # The LearningOnline Network with CAPA
2: # Wrapper for external and binary files as standalone resources
3: #
1.49.2.8! raeburn 4: # $Id: lonwrapper.pm,v 1.49.2.7 2019/08/02 00:19:00 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.1 www 40:
41: # ================================================================ Main Handler
1.21 albertel 42: sub wrapper {
1.49.2.6 raeburn 43: my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title) = @_;
1.23 albertel 44:
1.42 raeburn 45: my $forcereg;
46: unless ($env{'form.folderpath'}) {
47: $forcereg = 1;
48: }
49:
1.46 raeburn 50: my %lt = &Apache::lonlocal::texthash(
51: 'noif' => 'No iframe support.',
52: 'show' => 'Show content in pop-up window',
53: );
54:
1.49.2.7 raeburn 55: my ($anchor,$uselink,$linktext);
1.49.2.2 raeburn 56: if ($is_ext) {
57: if ($env{'form.symb'}) {
58: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
1.49.2.3 raeburn 59: if ($res =~ /(#[^#]+)$/) {
1.49.2.2 raeburn 60: $anchor = $1;
61: }
62: } elsif ($env{'form.anchor'} ne '') {
63: $anchor = '#'.$env{'form.anchor'};
1.49.2.1 raeburn 64: }
1.49.2.6 raeburn 65: unless (($is_pdf) && ($env{'browser.mobile'})) {
66: my $hostname = $r->hostname();
67: my $lonhost = $r->dir_config('lonHostID');
68: my $ip = &Apache::lonnet::get_host_ip($lonhost);
69: $uselink = &Apache::loncommon::is_nonframeable($url,$absolute,$hostname,$ip);
70: }
1.49.2.1 raeburn 71: }
72:
73: my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
1.42 raeburn 74: my $args = {'bgcolor' => '#FFFFFF'};
75: if ($forcereg) {
76: $args->{'force_register'} = $forcereg;
77: }
78: if (ref($brcrum) eq 'ARRAY') {
1.45 raeburn 79: $args->{'bread_crumbs'} = $brcrum;
1.42 raeburn 80: }
1.44 raeburn 81: if ($absolute) {
1.49.2.4 raeburn 82: $args->{'use_absolute'} = $absolute;
83: }
84: if ($env{'form.only_body'}) {
85: $args->{'only_body'} = $env{'form.only_body'};
1.44 raeburn 86: }
1.42 raeburn 87:
1.49.2.8! raeburn 88: my $headjs;
! 89:
! 90: #
! 91: # Where iframe is in use, if window.onload() executes before the custom resize function
! 92: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
! 93: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
! 94: # do not obscure the Functions menu.
! 95: #
! 96:
! 97: unless (($env{'browser.mobile'}) || $uselink) {
! 98: $headjs = '
! 99: <script type="text/javascript">
! 100: // <![CDATA[
! 101: var LCnotready = 0;
! 102: var LCresizedef = 0;
! 103: // ]]>
! 104: </script>'."\n";
! 105:
! 106: my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args);
1.46 raeburn 107: my $endpage = &Apache::loncommon::end_page();
1.38 droeschl 108:
1.49.2.6 raeburn 109: if (($uselink) && ($title eq '')) {
110: if ($env{'form.symb'}) {
111: $title=&Apache::lonnet::gettitle($env{'form.symb'});
112: } else {
113: my $symb=&Apache::lonnet::symbread($r->uri);
114: if ($symb) {
115: $title=&Apache::lonnet::gettitle($symb);
116: }
117: }
118: }
1.46 raeburn 119: if ($env{'browser.mobile'}) {
1.47 raeburn 120: my $output = $startpage;
121: if ($is_pdf) {
1.49.2.6 raeburn 122: $linktext = &mt('Link to PDF (for mobile devices)');
123: $output .= &create_link($url,$anchor,$title,$linktext);
1.47 raeburn 124: } else {
1.49.2.6 raeburn 125: if ($uselink) {
126: $linktext = &mt('Link to resource');
127: $output .= &create_link($url,$anchor,$title,$linktext);
128: } else {
129: my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
130: $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
131: '<iframe src="'.$dest.'" height="100%" width="100%" frameborder="0">'."\n".
132: "$lt{'noif'} $noiframe\n".
133: "</iframe>\n".
134: "</div>\n";
135: }
1.47 raeburn 136: }
137: $output .= $endpage;
138: return $output;
1.49.2.6 raeburn 139: } elsif ($uselink) {
140: $linktext = &mt('Link to resource');
141: return $startpage.&create_link($url,$anchor,$title,$linktext).$endpage;
1.46 raeburn 142: } else {
1.49.2.3 raeburn 143: my $offset = 5;
144: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
145: if ($env{'form.inhibitmenu'} eq 'yes') {
146: $offset = 0;
147: }
1.46 raeburn 148: my $script = &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
149: \$(document).ready( function() {
150: \$(window).unbind('resize').resize(function(){
1.49.2.3 raeburn 151: var header = null;
152: var offset = $offset;
1.46 raeburn 153: var height = 0;
154: var hdrtop = 0;
155: if (\$('div.LC_head_subbox:first').length) {
156: header = \$('div.LC_head_subbox:first');
157: offset = 9;
158: } else {
159: if (\$('#LC_breadcrumbs').length) {
160: header = \$('#LC_breadcrumbs');
161: }
162: }
1.49.2.3 raeburn 163: if (header != null && header.length) {
1.46 raeburn 164: height = header.height();
165: hdrtop = header.position().top;
1.42 raeburn 166: }
1.46 raeburn 167: var pos = height + hdrtop + offset;
168: \$('.LC_iframecontainer').css('top', pos);
169: });
1.49.2.8! raeburn 170: LCresizedef = 1;
! 171: if (LCnotready == 1) {
! 172: LCnotready = 0;
! 173: \$(window).trigger('resize');
! 174: }
1.38 droeschl 175: });
1.49.2.8! raeburn 176: window.onload = function(){
! 177: if (LCresizedef) {
! 178: LCnotready = 0;
! 179: \$(window).trigger('resize') };
! 180: } else {
! 181: LCnotready = 1;
! 182: }
! 183: };
1.39 droeschl 184: SCRIPT
1.46 raeburn 185: # javascript will position the iframe if window was resized (or zoomed)
186: return <<ENDFRAME;
187: $startpage
188: $script
189: <div class="LC_iframecontainer">
1.49.2.1 raeburn 190: <iframe src="$url$anchor">$lt{'noif'} $noiframe</iframe>
1.46 raeburn 191: </div>
192: $endpage
1.38 droeschl 193: ENDFRAME
1.46 raeburn 194: }
1.21 albertel 195: }
196:
1.49.2.6 raeburn 197: sub create_link {
198: my ($url,$anchor,$title,$linktext) = @_;
199: my $shownlink;
200: if ($title eq '') {
201: $title = $env{'form.title'};
202: if ($title eq '') {
203: unless ($env{'request.enc'}) {
204: ($title) = ($url =~ m{/([^/]+)$});
205: $title =~ s/(\?[^\?]+)$//;
206: }
207: }
208: }
209: unless ($title eq '') {
210: $shownlink = '<span style="font-weight:bold;">'.$title.'</span><br />';
211: }
212: my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
213: $shownlink .= '<a href="'.$dest.'">'.$linktext.'</a>';
214: return $shownlink;
215: }
216:
1.21 albertel 217: sub handler {
218: my $r=shift;
219: &Apache::loncommon::content_type($r,'text/html');
220: $r->send_http_header;
221:
222: return OK if $r->header_only;
223:
1.38 droeschl 224: my $url = $r->uri;
1.49.2.5 raeburn 225: my ($is_ext,$brcrum,$absolute,$is_pdf,$cdom,$cnum,$hostname);
1.38 droeschl 226:
227: for ($url){
228: s|^/adm/wrapper||;
1.49.2.8! raeburn 229: $is_ext = $_ =~ s|^/ext/|http://|;
! 230: s|http://https://?|https://| if ($is_ext);
! 231: s|:|:|g;
1.21 albertel 232: }
233:
1.47 raeburn 234: if ($url =~ /\.pdf$/i) {
235: $is_pdf = 1;
236: }
237:
1.42 raeburn 238: if ($is_ext) {
239: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.49.2.2 raeburn 240: ['forceedit','register','folderpath','symb','idx','title','anchor']);
1.42 raeburn 241: if (($env{'form.forceedit'}) &&
242: (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
243: (($env{'form.folderpath'} =~ /^supplemental/) ||
244: ($env{'form.symb'} =~ /^uploaded/))) {
1.49.2.2 raeburn 245: if ($env{'form.symb'}) {
246: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
247: if ($res =~ /(#[^#]+)$/) {
248: $url .= $1;
249: }
250: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
251: if ($env{'form.anchor'} ne '') {
252: $url .= '#'.$env{'form.anchor'};
253: }
254: }
1.49.2.5 raeburn 255: if (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
256: $hostname = $r->hostname();
257: }
258: my $type = 'ext';
1.42 raeburn 259: $r->print(
260: &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
261: $env{'form.symb'},
1.49.2.5 raeburn 262: $env{'form.idx'},$type,$cdom,
263: $cnum,$hostname));
1.42 raeburn 264: return OK;
265: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
266: my $crstype = &Apache::loncommon::course_type();
1.43 raeburn 267: my $title = $env{'form.title'};
268: if ($title eq '') {
269: $title = &mt('External Resource');
270: }
1.42 raeburn 271: $brcrum =
1.43 raeburn 272: &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
1.42 raeburn 273: }
274: }
275:
1.21 albertel 276: #
277: # Actual URL
278: #
1.41 www 279: if ($url=~/$LONCAPA::assess_re/) {
1.21 albertel 280: #
281: # This is uploaded homework
282: #
1.38 droeschl 283: $env{'request.state'}='uploaded';
284: &Apache::lonhomework::renderpage($r,$url);
1.21 albertel 285: } else {
286: #
287: # This is not homework
288: #
1.38 droeschl 289: if ($is_ext) {
1.49 raeburn 290: $absolute = $env{'request.use_absolute'};
1.38 droeschl 291: $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
1.42 raeburn 292: $ENV{'QUERY_STRING'} =~ s/\&$//;
1.38 droeschl 293: }
294:
1.35 raeburn 295: unless ($ENV{'QUERY_STRING'} eq '') {
1.38 droeschl 296: $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
1.35 raeburn 297: }
1.38 droeschl 298:
299: # encrypt url if not external
300: &Apache::lonenc::check_encrypt(\$url) if $url !~ /^https?\:/ ;
301:
1.49.2.6 raeburn 302: $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf) );
1.38 droeschl 303:
1.21 albertel 304: } # not just the menu
1.38 droeschl 305:
1.21 albertel 306: return OK;
1.13 www 307: } # handler
1.1 www 308:
309: 1;
310: __END__
311:
1.30 jms 312: =pod
1.1 www 313:
1.30 jms 314: =head1 NAME
315:
316: Apache::lonwrapper - External and binary file management.
317:
318: =head1 SYNOPSIS
319:
320: Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
321:
322: This is part of the LearningOnline Network with CAPA project
323: described at http://www.lon-capa.org.
324:
325: =head1 Subroutines
326:
327: =over
328:
1.49.2.6 raeburn 329: =item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
1.30 jms 330:
1.45 raeburn 331: =over
332:
1.49.2.6 raeburn 333: =item $r
334:
335: request object
336:
1.46 raeburn 337: =item $url
338:
1.45 raeburn 339: url to display by including in an iframe within a
340: LON-CAPA page which has a standard LON-CAPA inline menu.
341:
342: =item $brcrum
343:
344: breadcrumbs for unregistered urls
1.42 raeburn 345: (i.e., external resources in Supplemental Content).
1.45 raeburn 346:
1.46 raeburn 347: =item $absolute
1.45 raeburn 348:
349: contains protocol (http or https) followed by
350: the hostname, if menu items in the standard LON-CAPA
351: interface created by the call to loncommon::start_page()
352: within &wrapper() need to use absolute URLs rather than
353: relative URLs.
354:
355: That will be the case where an external resource has been
356: served from port 80, when the server customarily serves
357: requests using Apache/SSL (i.e., port 443). mod_rewrite
1.49 raeburn 358: is used to switch requests for external resources and
359: the syllabus: /public/<domain>/<courseid>/syllabus
360: (which might also point at an external resource)
1.45 raeburn 361: from https:// to http:// where the the URL of the remote site
362: specified in the resource itself is http://.
363:
364: This is done to avoid default mixed content blocking
365: in Firefox 23 and later, when serving from Apache/SSL.
366:
367: =item $is_ext
368:
369: true if URL is for an external resource.
370:
1.47 raeburn 371: =item $is_pdf
372:
373: true if URL is for a PDF (based on file extension).
374:
1.49 raeburn 375: =item $title
376:
377: optional. If wrapped item is a PDF, and $env{'browser.mobile'}
378: is true, a link to a PDF is shown. The "title" will be displayed
379: above the link, but if not provided as an arg, $env{'form.title'}
380: will be used, otherwise, the filename will be displayed (unless
381: hidden URL set for the resource).
382:
1.45 raeburn 383: =back
384:
1.38 droeschl 385: Returns markup for the entire page.
1.30 jms 386:
387: =item handler()
388:
389: =back
390:
391: =cut
1.1 www 392:
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