Return to lonsimplepage.pm CVS log

Up to [LON-CAPA] / loncom / interface

Refactors nearly-common code located in the templated pages,
into a new routine &print_template_fields() which controls printing
LC_Boxes for fields, and <textarea>s as necessary.  Custom fields
(links to be included, for example), are processed using handler routines
in closures, which are passed in a hash to the routine.

Saves about 140 lines of code are so?

# The LearningOnline Network
# Simple Page Editor
#
# $Id: lonsimplepage.pm,v 1.93 2010/01/31 06:03:55 faziophi 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::lonsimplepage;

use strict;
use Apache::Constants qw(:common);
use Apache::loncommon;
use Apache::lontemplate;
use Apache::lonnet;
use Apache::lontexconvert;
use Apache::lonfeedback;
use Apache::lonlocal;
use Apache::lonprintout;
use Apache::lonxml;
use Apache::longroup;
use HTML::Entities();
use LONCAPA;

sub get_db_name {
    my ($url) = @_;
    my ($udom,$uname,$marker)=(split(m{/},$url))[2,3,4];
    my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'};
    my $crs = $env{'course.'.$env{'request.course.id'}.'.num'};

    my $db_name;

    if ($dom && $crs && ($udom eq $dom) && ($uname eq $crs)) {
        $marker =~ s/\W//g;
        $db_name = 'grppage_'.$marker;
    } else {
        $marker=~s/\D//g;
        $db_name = 'smppage_'.$marker;
    }
    return if (!defined($marker));

    return $db_name;
}

sub handler {
    my $r = shift;
    &Apache::loncommon::content_type($r,'text/html');
    $r->send_http_header;
    return OK if $r->header_only;
    my $target=$env{'form.grade_target'};
# ------------------------------------------------------------ Print the screen
    if ($target eq 'tex') {
        $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
    }

# Is this even in a course?
    unless ($env{'request.course.id'}) {
        if ($target ne 'tex') {
            &Apache::loncommon::simple_error_page($r,'','Not in a course');
        } else {
            $r->print('\textbf{Not in a course}\end{document}');
        }
        return OK;
    }

    my $db_name = &get_db_name($r->uri);

    my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'};
    my $crs = $env{'course.'.$env{'request.course.id'}.'.num'};
    my ($group,$group_desc,$group_home_view,$group_home_edit,
        $group_view_perm,$group_edit_perm);
    my %curr_group = ();
    my %groupinfo = ();
    if ($db_name =~ /^grppage_/) {
        $group = (split(m{/},$r->uri))[4];
        $group =~ s/\W//g;
        my %curr_groups = &Apache::longroup::coursegroups($dom,$crs,$group);
        if (!%curr_groups) {
            &Apache::loncommon::simple_error_page($r,'','Invalid group name');
            return OK;
        }
        %groupinfo =
        &Apache::longroup::get_group_settings($curr_groups{$group});
        $group_desc = &unescape($groupinfo{'description'});
    }

    if (!$db_name) {
        &Apache::loncommon::simple_error_page($r,'','Invalid call');
        return OK;
    }

# --------------------------------------------------------- The syllabus fields
    my %syllabusfields=&Apache::lonlocal::texthash(
       'aaa_title'         => 'Page Title',
       'bbb_content'       => 'Content',
       'ccc_webreferences' => 'Web References');
    if ($group ne '') {
        $syllabusfields{'abb_links'} = &mt('Available Group Tools');
    }


# ------------------------------------------------------------ Get query string
    &Apache::loncommon::get_unprocessed_cgi
                        ($ENV{'QUERY_STRING'},['forcestudent','forceedit',
                                               'register','ref']);
# --------------------------------------------------------------- Force Student
    my $forcestudent='';
    if ($env{'form.forcestudent'} || $target eq 'tex' ) { $forcestudent='student'; };
    my $forceedit='';
    if ($env{'form.forceedit'}) { $forceedit='edit'; }

    my $refarg;
    if ($env{'form.ref'}) {
        $refarg = '&ref='.$env{'form.ref'};
    }

    my %syllabus=&Apache::lonnet::dump($db_name,$dom,$crs);

# --------------------------------------- There is such a user, get environment

    if ($target ne 'tex') {
        my $title = 'Simple Course Page';
        if ($group ne '') {
            $title = 'Simple Group Page';
        }
        my $start_page =
        &Apache::loncommon::start_page($title,undef,
                       {'function'       => $forcestudent,
                        'domain'         => $dom,
                        'force_register' =>
                        $env{'form.register'},});
        $r->print($start_page);
    }

    if ($group ne '') {
        my $group_view_perm =
               &Apache::lonnet::allowed('vcg',$env{'request.course.id'}.
               ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
        $group_edit_perm =
               &Apache::lonnet::allowed('mdg',$env{'request.course.id'}.
               ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
        $group_home_view = &Apache::lonnet::allowed('vgh',
                                         $env{'request.course.id'}.'/'.$group);
        $group_home_edit = &Apache::lonnet::allowed('mgh',
                                         $env{'request.course.id'}.'/'.$group);
        if ($group_view_perm || $group_edit_perm || $group_home_view ||
            $group_home_edit || &Apache::longroup::check_group_access($group)) {
            if (($env{'form.ref'} eq 'grouplist') && ($target ne 'tex')) {
                $r->print(&grouppage_breadcrumbs($dom,$crs,$group,$group_desc));
            }
            if ((!$group_home_edit) && (!$group_home_view) &&
                (!$group_view_perm) && (!$group_edit_perm)) {
                &display_group_links($r,$target,$group,'view',$refarg,%groupinfo);
                if ($env{'form.grade_target'} ne 'tex') {
                    $r->print(&Apache::loncommon::end_page());
                } else {
                    $r->print('\end{document}');
                }
                return OK;
            }
        } else {
            my $msg =
            &mt('You do not currently have rights to view this group.');
            if ($target ne 'tex') {
                $r->print('<p class="LC_warning">'.$msg.'</p>'.
                &Apache::loncommon::end_page());
            } else {
                $r->print('\textbf{'.$msg.'}\end{document}');
            }
            return OK;
        }
        my ($blocked,$blocktext) =
             &Apache::loncommon::blocking_status('groups');
        if ($blocked) {
            $r->print($blocktext);
            $r->print(&Apache::loncommon::end_page());
            return OK;
        }
    }

    my $allowed;

    if ($group ne '') {
        $allowed  = $group_edit_perm;
        if (!$allowed) {
            $allowed = $group_home_edit;
        }
    } else {
        $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
    }
    my $privileged=$allowed;
    if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
        $forcestudent='student';
    }

    if ($forcestudent or $target eq 'tex') { $allowed=0; }

    if (($env{'form.uploaddoc.filename'} and $target ne 'tex') &&
    ($env{'form.storeupl'}) && ($allowed)) {
        if ($env{'form.uploaddoc.filename'}=~/\.(gif|jpg|png|jpeg)$/i) {
            if ($syllabus{'uploaded.photourl'}) {
                &Apache::lonnet::removeuploadedurl($syllabus{'uploaded.photourl'});
            }
            if ($group ne '') {
                $syllabus{'uploaded.photourl'}=&Apache::lonnet::userfileupload(
                                              'uploaddoc',1,"grouppage/$group");
            } else {
                $syllabus{'uploaded.photourl'}=
                &Apache::lonnet::userfileupload('uploaddoc',1,'simplepage');
            }
        }
        $syllabus{'uploaded.lastmodified'}=time;
        &Apache::lonnet::put($db_name,\%syllabus,$dom,$crs);
    }
#    if ($allowed && $env{'form.delupl'}) {
#        if ($syllabus{'uploaded.photourl'}) {
#            &Apache::lonnet::removeuploadedurl($syllabus{'uploaded.photourl'});
#            delete($syllabus{'uploaded.photourl'});
#            &Apache::lonnet::del('simplepage',['uploaded.photourl']);
#        }
#    }
    if (($allowed) && ($env{'form.storesyl'})) {
        foreach my $syl_field (keys(%syllabusfields)) {
            my $field=$env{'form.'.$syl_field};
            chomp($field);
            $field=~s/\s+$//s;
            $field=~s/^\s+//s;
            $field=~s/\<br\s*\/*\>$//s;
            $field=&Apache::lonfeedback::clear_out_html($field,1);
            $syllabus{$syl_field}=$field;
        }
        $syllabus{'uploaded.lastmodified'}=time;
        &Apache::lonnet::put($db_name,\%syllabus,$dom,$crs);
    }

#---Print Function
    if ($target ne 'tex') {
        if ($allowed || $privileged) {
            my $functions=&Apache::lonhtmlcommon::start_funclist();
            if ($allowed) {
                $functions.=&Apache::lonhtmlcommon::add_item_funclist(
                                '<a href="'.$r->uri.'?forcestudent=1">'
                               .&mt('Show Student View').'</a>'
                               .&Apache::loncommon::help_open_topic(
                                    'Uploaded_Templates_PublicView'));
            } elsif ($privileged) {
                my $edittext = &mt('Edit');
                    if ($group ne '') {
                    $edittext = &mt('Edit Group Homepage');
                }
                $functions.=&Apache::lonhtmlcommon::add_item_funclist(
                                '<a href="'.$r->uri.'?forceedit=edit'.$refarg.'">'
                               .$edittext.'</a>');
                if ($group ne '') {
                    if ($group_edit_perm) {
                        $functions.=&Apache::lonhtmlcommon::add_item_funclist(
                                        '<a href="/adm/coursegroups'
                                       .'?action=modify&amp;refpage=grouplist'
                                       .'&amp;state=pick_task&amp;groupname='
                                       .$group.'">'
                                       .&mt('Edit Group Settings')
                                       .'</a>');
                       }
                    }
            }
            $functions.=&Apache::lonhtmlcommon::end_funclist();
            $r->print(&Apache::loncommon::head_subbox($functions));
        }
    }

#---Print help Text
    if($target ne 'tex'){
        if ($allowed) {
            $r->print(&Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')));
        }
    }

# ---------------------------------------------------------------- Get syllabus
    if ((($syllabus{'uploaded.lastmodified'}) &&
         (($group ne '' && ($group_home_view || $group_edit_perm ||
           $group_view_perm)) || ($group eq ''))) || ($allowed)) {
        #Print the title
        my $titletext=&HTML::Entities::encode($syllabus{'aaa_title'},'<>&"');
        if ($target ne 'tex') {
            if ($allowed) {
            }
            $r->print('<h2>'.$titletext.'</h2>');
        } else {
            my $safeinit;
            $r->print(&Apache::lonxml::xmlparse($r,'tex','<h1>'.$titletext.'</h1>'));
        }
        if ($allowed) {
            if ($env{'form.grade_target'} ne 'tex') {
                #editbox for title
                $r->print('<form method="post" action="" enctype="multipart/form-data">');
				&Apache::lontemplate::print_start_template($r,&mt('Title'),'LC_Box');
				$r->print($titletext);
				$r->print("<br /><div>");
				&Apache::lontemplate::print_textarea_template($r, $syllabus{'aaa_title'},
					'aaa_title', Apache::lontemplate->RICH_TEXT_ALWAYS_OFF);
				&Apache::lontemplate::print_saveall_template($r);
				$r->print("</div>");
				&Apache::lontemplate::print_end_template($r);
            } else {
                my $safeinit;
                $r->print(&Apache::lonxml::xmlparse($r,'tex',$syllabus{'aaa_title'},$safeinit));
            }
        }

        #print the image
        my $image='';
        if ($syllabus{'uploaded.photourl'}) {
            &Apache::lonnet::allowuploaded('/adm/smppg',
                    $syllabus{'uploaded.photourl'});

            $image='<img src="'.$syllabus{'uploaded.photourl'}
                  .'" alt="'.&mt('Image').'" />';
            if ($target eq 'tex') {
                $image=&Apache::lonxml::xmlparse($r,'tex',$image);
            }
        }

        if ($allowed) {
            &Apache::lontemplate::print_start_template($r, &mt('Upload a Photo'),'LC_Box');
            $r->print($image);
            $r->print("<br /><br />");
            $r->print(
                '<input type="hidden" name="forceedit" value="edit" />'.
                '<input type="file" name="uploaddoc" size="50" />'.
                '<input type="submit" name="storeupl" value="'.&mt('Upload').'" />'.
                '<input type="hidden" name="forceedit" value="edit" />');
            &Apache::lontemplate::print_end_template($r);
    

#            if ($syllabus{'uploaded.photourl'}) {
#                $r->print('<input type="submit" name="delupl"'
#                         .' value="'.&mt('Delete Photo').'" />');
#            }
        }
        #Image in Student view and printout.
        else {
            $r->print($image);
        }
       	
        my $links_handler = sub { 
        	my ($r, $field, $message, $group, $data_ref, $fields_ref, $target, $allowed) = @_;
			if ($group ne '') {
				my %data = %{$data_ref};
				my %fields = %{$fields_ref};
				$r->print('<br /><input type="hidden" name="'.$field.
					'" value="'.$data{$field}.'" />');
				&display_group_links($r, $target, $group, 'edit', $refarg, %groupinfo);
				$r->print('<br />');
			}
        };
        my $title_handler = sub {};
		my %custom_handlers = (
			'abb_links' => $links_handler,
			'aaa_title' => $title_handler
		);
		&Apache::lontemplate::print_template_fields($r, \%syllabus, \%syllabusfields, 
			$target, $allowed, Apache::lontemplate->RICH_TEXT_DETECT_HTML, \%custom_handlers, $group);
		
        if ($allowed && ($env{'form.grade_target'} ne 'tex')) {
            $r->print(&Apache::lonhtmlcommon::htmlareaselectactive
                ('bbb_content').'</form>');
        }

    } else {
        if ($group ne '') {
            &display_group_links($r,$target,$group,'view',$refarg,%groupinfo);
        } else {
            my $text=&mt('No page information provided.');
            if ($target ne 'tex') {
                $r->print('<p class="LC_info">'.$text.'</p>');
            } else {
            $r->print($text)
            }
        }
    }
    if ($env{'form.grade_target'} ne 'tex') {
        $r->print(&Apache::loncommon::end_page());
    } else {
        $r->print('\end{document}');
    }
    return OK;
}

sub display_group_links {
    my ($r,$target,$group,$context,$refarg,%groupinfo) = @_;
    my @available = ();
    my %menu = ();
    %{$menu{'email'}} = (
                        text => 'Group Message',
                        href => '/adm/email?compose=group&amp;group='.$group.
                                $refarg,
                      );
    %{$menu{'discussion'}} = (
                        text => 'Discussion Boards',
                        href => '/adm/groupboards?group='.$group.$refarg,
                      );
    %{$menu{'chat'}} = (
                        text => 'Group Chat Room',
                        href => "javascript:group_chat('$group')",
                      );
    %{$menu{'files'}} = (
                        text => 'Group Portfolio',
                        href => '/adm/coursegrp_portfolio?group='.$group.
                                $refarg,
                      );
    %{$menu{'roster'}} = (
                        text => 'Membership Roster',
                        href => '/adm/grouproster?group='.$group.$refarg,
                      );
    foreach my $tool (sort(keys(%menu))) {
        if ($groupinfo{functions}{$tool} eq 'on') {
            push(@available,$tool);
        }
    }
    if (@available > 0) {
        my $output = '';
        if ($target eq 'tex') {
            $output = '<table cellspacing="4" cellpadding="4">';
        } else {
            $output = &Apache::loncommon::start_data_table();
        }
        foreach my $tool (@available) {
            if ($target eq 'tex') {
                $output .= '<tr><td>'.&mt($menu{$tool}{text}).'</td></tr>';
            } else {
                $output .= &Apache::loncommon::start_data_table_row()
                          .'<td><a href="'.$menu{$tool}{href}.'">'
                          .&mt($menu{$tool}{text}).'</a></td>'
                          .&Apache::loncommon::end_data_table_row();
            }
        }
        if ($target eq 'tex') {
            $output .= '</table>';
        } else {
            $output .= &Apache::loncommon::end_data_table();
        }
        if ($target eq 'tex') {
            $r->print(&Apache::lonxml::xmlparse($r,'tex',&mt('Available functions').'<br /><br />'.$output));
        } else {
            $r->print('<h3>'.&mt('Available Group Tools').'</h3>'.$output);
        }
    } else {
        my $output;
        if ($context eq 'edit') {
            $output = &mt('No group functionality.');
        } else {
            $output = &mt('No group functionality (e.g., e-mail, discussion, chat room or file upload) is currently available to you in this group: [_1].','<b>'.&unescape($groupinfo{'description'}).'</b>');
        }
        if ($target eq 'tex') {
            $r->print(&Apache::lonxml::xmlparse($r,'tex',$output));
        } else {
            $r->print($output);
        }
    }
}

sub grouppage_breadcrumbs {
    my ($cdom,$cnum,$group,$description) = @_;
    &Apache::lonhtmlcommon::clear_breadcrumbs();
    &Apache::lonhtmlcommon::add_breadcrumb
        ({href=>"/adm/coursegroups",
          text=>"Groups",
          title=>"Display Groups"},
        {href=>"/adm/$cdom/$cnum/$group/smppg?ref=grouplist",
          text=>&mt('Group:')." $description",
          title=>"Go to group's home page"},
        );
    my $output .= &Apache::lonhtmlcommon::breadcrumbs(&mt('Group page - [_1]',
                                                           $description));
    return $output;
}

1;
__END__