Return to lonwrapper.pm CVS log

Up to [LON-CAPA] / rat

- Breadcrumbs trail for uploaded content in nested folders in
  Supplemental Content.
- Breadcrumbs trail for external resource in Supplemental Content.
- lonwrapper.pm
  - more sanity checking in lonwrapper.pm.
  - increase offset for iframe when functions box is populated.

# The LearningOnline Network with CAPA
# Wrapper for external and binary files as standalone resources
#
# $Id: lonwrapper.pm,v 1.42 2012/11/27 23:45:15 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();

# ================================================================ Main Handler
sub wrapper {
    my ($url,$brcrum) = @_;

    my $forcereg;
    unless ($env{'form.folderpath'}) {
        $forcereg = 1;
    }

    my $args = {'bgcolor' => '#FFFFFF'};
    if ($forcereg) {
        $args->{'force_register'} = $forcereg;
    }
    if (ref($brcrum) eq 'ARRAY') {
         $args->{'bread_crumbs'} = $brcrum;
    }

    my $startpage =  Apache::loncommon::start_page('Menu',undef,$args);
    my $endpage =  Apache::loncommon::end_page();

    my $script = Apache::lonhtmlcommon::scripttag(<<SCRIPT );
    \$(document).ready( function() {
        \$(window).unbind('resize').resize(function(){
            var header;
            var offset = 5;
            var height = 0;
            var hdrtop = 0;
            if (\$('div.LC_head_subbox:first').length) {
                header = \$('div.LC_head_subbox:first');
                offset = 9;
            } else {
                if (\$('#LC_breadcrumbs').length) {
                    header = \$('#LC_breadcrumbs');
                }
            }
            if (header.length) {
                height = header.height();
                hdrtop = header.position().top;
            }
            var pos = height + hdrtop + offset;
            \$('.LC_iframecontainer').css('top', pos);
        });
    });
    window.onload = function(){  \$(window).trigger('resize') }; 
SCRIPT

    # javascript will position the iframe if window was resized (or zoomed)
    return <<ENDFRAME;
    $startpage
    $script
    <div class="LC_iframecontainer">
        <iframe src="$url">No iframe support!</iframe>
    </div>
    $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);

    for ($url){
        s|^/adm/wrapper||;
        $is_ext = $_ =~ s|^/ext/|http://|;         
        s|http://https://|https://|;
        s|&colon;|:|g;              
    }

    if ($is_ext) {
        &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
            ['forceedit','register','folderpath','symb','idx','title']);
        if (($env{'form.forceedit'}) &&
            (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
            (($env{'form.folderpath'} =~ /^supplemental/) ||
             ($env{'form.symb'} =~ /^uploaded/))) {
            $r->print(
                &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
                                                       $env{'form.symb'},
                                                       $env{'form.idx'}));
            return OK;
        } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
            my $crstype = &Apache::loncommon::course_type();
            $brcrum =
                &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$env{'form.title'},1);
            if (ref($brcrum) eq 'ARRAY') {
                my $last = $env{'form.title'};
                if ($last eq '') {
                    $last = &mt('External Resource');
                }
                push(@{$brcrum},
                         {'title' => $last,
                          'text' => $last,
                          'no_mt' => 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) {
            $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
        &Apache::lonenc::check_encrypt(\$url) if $url !~ /^https?\:/ ;

        $r->print( wrapper($url,$brcrum) );

    } # 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)

Wraps $url in an iframe and generates a page for it.
$brcrum contains breadcrumbs for unregistered urls
(i.e., external resources in Supplemental Content).
Returns markup for the entire page.

=item handler()

=back

=cut