Return to lonsimplepage.pm CVS log

Up to [LON-CAPA] / loncom / interface

- Bug 6669
  - lonhtmlgateway::process_incoming_html() used instead of
    lonfeedback::clear_out_html() to ensure fields contain valid xhtml.
    (more HTML tags now supported).
 - requires perl-XML-LibXML 1.62 or newer:
   update needed on CentOS/RHEL/Scientific Linux 5; SLES 9/10; RHEL 4.

    1: # The LearningOnline Network
    2: # Simple Page Editor
    3: #
    4: # $Id: lonsimplepage.pm,v 1.103 2013/09/17 15:04:30 raeburn Exp $
    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: #
   28: 
   29: package Apache::lonsimplepage;
   30: 
   31: use strict;
   32: use Apache::Constants qw(:common);
   33: use Apache::loncommon;
   34: use Apache::lontemplate;
   35: use Apache::lonnet;
   36: use Apache::lonhtmlgateway;
   37: use Apache::lonlocal;
   38: use Apache::lonprintout;
   39: use Apache::lonxml;
   40: use Apache::longroup;
   41: use Apache::lonnavmaps();
   42: use HTML::Entities();
   43: use LONCAPA;
   44: 
   45: sub get_db_name {
   46:     my ($url,$marker,$cdom,$cnum) = @_;
   47:     my ($udom,$uname,$timemark)=(split(m{/},$url))[2,3,4];
   48:     if ($marker eq '') {
   49:         $marker = $timemark;
   50:     }
   51:     if (($cdom eq '') || ($cnum eq '')) {
   52:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
   53:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
   54:     }
   55:     my $db_name;
   56: 
   57:     if ($cdom && $cnum && ($udom eq $cdom) && ($uname eq $cnum)) {
   58:         $marker =~ s/\W//g;
   59:         $db_name = 'grppage_'.$marker;
   60:     } else {
   61:         $marker=~s/\D//g;
   62:         $db_name = 'smppage_'.$marker;
   63:     }
   64:     return if (!defined($marker));
   65:     return $db_name;
   66: }
   67: 
   68: sub handler {
   69:     my $r = shift;
   70:     &Apache::loncommon::content_type($r,'text/html');
   71:     $r->send_http_header;
   72:     return OK if $r->header_only;
   73:     my $target=$env{'form.grade_target'};
   74: # ------------------------------------------------------------ Print the screen
   75:     if ($target eq 'tex') {
   76:         $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
   77:     }
   78: 
   79: # Is this even in a course?
   80:     unless ($env{'request.course.id'}) {
   81:         if ($target ne 'tex') {
   82:             &Apache::loncommon::simple_error_page($r,'','Not in a course');
   83:         } else {
   84:             $r->print('\textbf{Not in a course}\end{document}');
   85:         }
   86:         return OK;
   87:     }
   88: 
   89:     my $marker = (split(m{/},$r->uri))[4];
   90:     my $db_name = &get_db_name($r->uri,$marker);
   91: 
   92:     my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'};
   93:     my $crs = $env{'course.'.$env{'request.course.id'}.'.num'};
   94:     my ($group,$group_desc);
   95: 
   96:     my %curr_group = ();
   97:     my %groupinfo = ();
   98:     if ($db_name =~ /^grppage_/) {
   99:         $group = $marker;
  100:         $group =~ s/\W//g;
  101:         my %curr_groups = &Apache::longroup::coursegroups($dom,$crs,$group);
  102:         if (!%curr_groups) {
  103:             &Apache::loncommon::simple_error_page($r,'','Invalid group name');
  104:             return OK;
  105:         }
  106:         %groupinfo =
  107:         &Apache::longroup::get_group_settings($curr_groups{$group});
  108:         $group_desc = &unescape($groupinfo{'description'});
  109:     }
  110: 
  111:     if (!$db_name) {
  112:         &Apache::loncommon::simple_error_page($r,'','Invalid call');
  113:         return OK;
  114:     }
  115: 
  116: # --------------------------------------------------------- The syllabus fields
  117:     my %syllabusfields=&Apache::lonlocal::texthash(
  118:        'aaa_title'         => 'Page Title',
  119:        'bbb_content'       => ($target eq 'tex'?'':'Content'),
  120:        'ccc_webreferences' => 'Web References');
  121:     if ($group ne '') {
  122:         $syllabusfields{'abb_links'} = &mt('Available Group Tools');
  123:     }
  124: 
  125: 
  126: # ------------------------------------------------------------ Get query string
  127:     &Apache::loncommon::get_unprocessed_cgi
  128:                         ($ENV{'QUERY_STRING'},['forceedit','todocs',
  129:                                                'register','ref']);
  130: # --------------------------------------------------------------- Force Student
  131:     my ($forceedit,$forcestudent);
  132:     $forceedit = $env{'form.forceedit'};
  133:     if (!$forceedit) {
  134:         $forcestudent=1;
  135:     }
  136: 
  137:     my $refarg;
  138:     if ($env{'form.ref'}) {
  139:         $refarg = '&ref='.$env{'form.ref'};
  140:     }
  141: 
  142:     my %syllabus=&Apache::lonnet::dump($db_name,$dom,$crs);
  143: 
  144: # --------------------------------------- There is such a user, get environment
  145:     my ($registered,$group_view_perm,$group_edit_perm,$group_home_view,
  146:         $group_home_edit,$has_group_access);
  147:     my $brcrum = [];
  148:     if ($group eq '') {
  149:         $registered = $env{'form.register'};
  150:     } else {
  151:         unless ($env{'form.ref'} eq 'grouplist') {
  152:             $registered = $env{'form.register'};
  153:         }
  154:         $group_view_perm =
  155:                &Apache::lonnet::allowed('vcg',$env{'request.course.id'}.
  156:                ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
  157:         $group_edit_perm =
  158:                &Apache::lonnet::allowed('mdg',$env{'request.course.id'}.
  159:                ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
  160:         $group_home_view = &Apache::lonnet::allowed('vgh',
  161:                                          $env{'request.course.id'}.'/'.$group);
  162:         $group_home_edit = &Apache::lonnet::allowed('mgh',
  163:                                          $env{'request.course.id'}.'/'.$group);
  164:         if ($group_view_perm || $group_edit_perm || $group_home_view ||
  165:             $group_home_edit || &Apache::longroup::check_group_access($group)) {
  166:             $has_group_access = 1;
  167:             if (($env{'form.ref'} eq 'grouplist') && ($target ne 'tex') &&
  168:                 (!$registered)) {
  169:                 $brcrum = &grouppage_breadcrumbs($dom,$crs,$group,$group_desc);
  170:             }
  171:         }
  172:     }
  173: 
  174:     if ($target ne 'tex') {
  175:         my $title = ($group eq '')? 'Simple Course Page':'Simple Group Page';
  176:         my $start_page =
  177:         &Apache::loncommon::start_page($title,undef,
  178:                        {'domain'         => $dom,
  179:                         'group'          => $group,
  180:                         'bread_crumbs'   => $brcrum,
  181:                         'force_register' => $registered,
  182:                        }); 
  183:         $r->print($start_page);
  184:     }
  185: 
  186:     if ($group ne '') {
  187:         if ($has_group_access) {
  188:             if ((!$group_home_edit) && (!$group_home_view) &&
  189:                 (!$group_view_perm) && (!$group_edit_perm)) {
  190:                 &display_group_links($r,$target,$group,'view',$refarg,%groupinfo);
  191:                 if ($env{'form.grade_target'} ne 'tex') {
  192:                     $r->print(&Apache::loncommon::end_page());
  193:                 } else {
  194:                     $r->print('\end{document}');
  195:                 }
  196:                 return OK;
  197:             }
  198:         } else {
  199:             my $msg =
  200:             &mt('You do not currently have rights to view this group.');
  201:             if ($target ne 'tex') {
  202:                 $r->print('<p class="LC_warning">'.$msg.'</p>'.
  203:                 &Apache::loncommon::end_page());
  204:             } else {
  205:                 $r->print('\textbf{'.$msg.'}\end{document}');
  206:             }
  207:             return OK;
  208:         }
  209:         my ($blocked,$blocktext) =
  210:              &Apache::loncommon::blocking_status('groups');
  211:         if ($blocked) {
  212:             $r->print($blocktext);
  213:             $r->print(&Apache::loncommon::end_page());
  214:             return OK;
  215:         }
  216:     }
  217: 
  218:     my $allowed;
  219: 
  220:     if ($group ne '') {
  221:         $allowed  = $group_edit_perm;
  222:         if (!$allowed) {
  223:             $allowed = $group_home_edit;
  224:         }
  225:     } else {
  226:         $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
  227:     }
  228: 
  229:     if ($forcestudent or $target eq 'tex') { $allowed=0; }
  230: 
  231:     if (($env{'form.uploaddoc.filename'} and $target ne 'tex') &&
  232:     ($env{'form.storeupl'}) && ($allowed)) {
  233:         if ($env{'form.uploaddoc.filename'}=~/\.(gif|jpg|png|jpeg)$/i) {
  234:             if ($syllabus{'uploaded.photourl'}) {
  235:                 &Apache::lonnet::removeuploadedurl($syllabus{'uploaded.photourl'});
  236:             }
  237:             if ($group ne '') {
  238:                 $syllabus{'uploaded.photourl'}=&Apache::lonnet::userfileupload(
  239:                                               'uploaddoc','coursedoc',
  240:                                               "grouppage/$group");
  241:             } else {
  242:                 $syllabus{'uploaded.photourl'}=
  243:                 &Apache::lonnet::userfileupload('uploaddoc','coursedoc',
  244:                                                 "simplepage/$marker");
  245:             }
  246:         }
  247:         $syllabus{'uploaded.lastmodified'}=time;
  248:         &Apache::lonnet::put($db_name,\%syllabus,$dom,$crs);
  249:     }
  250: #    if ($allowed && $env{'form.delupl'}) {
  251: #        if ($syllabus{'uploaded.photourl'}) {
  252: #            &Apache::lonnet::removeuploadedurl($syllabus{'uploaded.photourl'});
  253: #            delete($syllabus{'uploaded.photourl'});
  254: #            &Apache::lonnet::del('simplepage',['uploaded.photourl']);
  255: #        }
  256: #    }
  257:     if (($allowed) && ($env{'form.storesyl'})) {
  258:         foreach my $syl_field (keys(%syllabusfields)) {
  259:             my $field=$env{'form.'.$syl_field};
  260:             chomp($field);
  261:             my $gateway = Apache::lonhtmlgateway->new();
  262:             $field = $gateway->process_incoming_html($field,1);
  263:             $syllabus{$syl_field}=$field;
  264:         }
  265:         $syllabus{'uploaded.lastmodified'}=time;
  266:         &Apache::lonnet::put($db_name,\%syllabus,$dom,$crs);
  267:     }
  268: 
  269: #---Print help Text
  270:     if($target ne 'tex'){
  271:         if ($allowed) {
  272:             $r->print(&Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')));
  273:         }
  274:     }
  275: 
  276: # ---------------------------------------------------------------- Get syllabus
  277:     if ((($syllabus{'uploaded.lastmodified'}) &&
  278:          (($group ne '' && ($group_home_view || $group_edit_perm ||
  279:            $group_view_perm)) || ($group eq ''))) || ($allowed)) {
  280:         #Print the title
  281:         my $titletext=&HTML::Entities::encode($syllabus{'aaa_title'},'<>&"');
  282:         if ($target ne 'tex') {
  283:             if ($allowed) {
  284:             }
  285:             $r->print('<h2>'.$titletext.'</h2>');
  286:         } else {
  287:             my $safeinit;
  288:             $r->print(&Apache::lonxml::xmlparse($r,'tex','<h1>'.$titletext.'</h1>'));
  289:         }
  290:         if ($allowed) {
  291:             if ($env{'form.grade_target'} ne 'tex') {
  292:                 #editbox for title
  293:                 $r->print('<form method="post" action="" enctype="multipart/form-data">'."\n".
  294:                           '<input type="hidden" register="'.$registered.'" />');
  295: 				&Apache::lontemplate::print_start_template($r,&mt('Title'),'LC_Box');
  296: 				$r->print($titletext);
  297: 				$r->print("<br /><div>");
  298: 				&Apache::lontemplate::print_textarea_template($r, $syllabus{'aaa_title'},
  299: 					'aaa_title', Apache::lontemplate->RICH_TEXT_ALWAYS_OFF);
  300: 				&Apache::lontemplate::print_saveall_template($r);
  301: 				$r->print("</div>");
  302: 				&Apache::lontemplate::print_end_template($r);
  303:             } else {
  304:                 my $safeinit;
  305:                 $r->print(&Apache::lonxml::xmlparse($r,'tex',$syllabus{'aaa_title'},$safeinit));
  306:             }
  307:         }
  308: 
  309:         #print the image
  310:         my $image='';
  311:         if ($syllabus{'uploaded.photourl'}) {
  312:             &Apache::lonnet::allowuploaded('/adm/smppg',
  313:                     $syllabus{'uploaded.photourl'});
  314: 
  315:             $image='<img src="'.$syllabus{'uploaded.photourl'}
  316:                   .'" alt="'.&mt('Image').'" />';
  317:             if ($target eq 'tex') {
  318:                 $image=&Apache::lonxml::xmlparse($r,'tex',$image);
  319:             }
  320:         }
  321: 
  322:         if ($allowed) {
  323:             &Apache::lontemplate::print_start_template($r, &mt('Upload a Photo'),'LC_Box');
  324:             $r->print($image);
  325:             $r->print("<br /><br />");
  326:             $r->print(
  327:                 '<input type="hidden" name="forceedit" value="edit" />'.
  328:                 '<input type="file" name="uploaddoc" size="50" />'.
  329:                 '<input type="submit" name="storeupl" value="'.&mt('Upload').'" />'.
  330:                 '<input type="hidden" name="forceedit" value="edit" />');
  331:             &Apache::lontemplate::print_end_template($r);
  332:     
  333: 
  334: #            if ($syllabus{'uploaded.photourl'}) {
  335: #                $r->print('<input type="submit" name="delupl"'
  336: #                         .' value="'.&mt('Delete Photo').'" />');
  337: #            }
  338:         }
  339:         #Image in Student view and printout.
  340:         else {
  341:             $r->print($image);
  342:         }
  343:        	
  344:         my $links_handler = sub { 
  345:         	my ($r, $field, $message, $group, $data_ref, $fields_ref, $target, $allowed) = @_;
  346: 			if ($group ne '') {
  347: 				my %data = %{$data_ref};
  348: 				my %fields = %{$fields_ref};
  349: 				$r->print('<br /><input type="hidden" name="'.$field.
  350: 					'" value="'.$data{$field}.'" />');
  351: 				&display_group_links($r, $target, $group, 'edit', $refarg, %groupinfo);
  352: 				$r->print('<br />');
  353: 			}
  354:         };
  355:         my $title_handler = sub {};
  356: 		my %custom_handlers = (
  357: 			'abb_links' => $links_handler,
  358: 			'aaa_title' => $title_handler
  359: 		);
  360: 		&Apache::lontemplate::print_template_fields($r, \%syllabus, \%syllabusfields, 
  361: 			$target, $allowed, Apache::lontemplate->RICH_TEXT_DETECT_HTML, \%custom_handlers, $group);
  362: 		
  363:         if ($allowed && ($env{'form.grade_target'} ne 'tex')) {
  364:             $r->print(&Apache::lonhtmlcommon::htmlareaselectactive().
  365:                       '</form>');
  366:         }
  367: 
  368:     } else {
  369:         if ($group ne '') {
  370:             &display_group_links($r,$target,$group,'view',$refarg,%groupinfo);
  371:         } else {
  372:             my $text=&mt('No page information provided.');
  373:             if ($target ne 'tex') {
  374:                 $r->print('<p class="LC_info">'.$text.'</p>');
  375:             } else {
  376:             $r->print($text)
  377:             }
  378:         }
  379:     }
  380:     if ($env{'form.grade_target'} ne 'tex') {
  381:         $r->print(&Apache::loncommon::end_page());
  382:     } else {
  383:         $r->print('\end{document}');
  384:     }
  385:     return OK;
  386: }
  387: 
  388: sub display_group_links {
  389:     my ($r,$target,$group,$context,$refarg,%groupinfo) = @_;
  390:     my @available = ();
  391:     my %menu = ();
  392:     %{$menu{'email'}} = (
  393:                         text => 'Group Message',
  394:                         href => '/adm/email?compose=group&amp;group='.$group.
  395:                                 $refarg,
  396:                       );
  397:     %{$menu{'discussion'}} = (
  398:                         text => 'Discussion Boards',
  399:                         href => '/adm/groupboards?group='.$group.$refarg,
  400:                       );
  401:     %{$menu{'chat'}} = (
  402:                         text => 'Group Chat Room',
  403:                         href => "javascript:group_chat('$group')",
  404:                       );
  405:     %{$menu{'files'}} = (
  406:                         text => 'Group Portfolio',
  407:                         href => '/adm/coursegrp_portfolio?group='.$group.
  408:                                 $refarg,
  409:                       );
  410:     %{$menu{'roster'}} = (
  411:                         text => 'Membership Roster',
  412:                         href => '/adm/grouproster?group='.$group.$refarg,
  413:                       );
  414:     foreach my $tool (sort(keys(%menu))) {
  415:         if ($groupinfo{functions}{$tool} eq 'on') {
  416:             push(@available,$tool);
  417:         }
  418:     }
  419:     if (@available > 0) {
  420:         my $output = '';
  421:         if ($target eq 'tex') {
  422:             $output = '<table cellspacing="4" cellpadding="4">';
  423:         } else {
  424:             $output = &Apache::loncommon::start_data_table();
  425:         }
  426:         foreach my $tool (@available) {
  427:             if ($target eq 'tex') {
  428:                 $output .= '<tr><td>'.&mt($menu{$tool}{text}).'</td></tr>';
  429:             } else {
  430:                 $output .= &Apache::loncommon::start_data_table_row()
  431:                           .'<td><a href="'.$menu{$tool}{href}.'">'
  432:                           .&mt($menu{$tool}{text}).'</a></td>'
  433:                           .&Apache::loncommon::end_data_table_row();
  434:             }
  435:         }
  436:         if ($target eq 'tex') {
  437:             $output .= '</table>';
  438:         } else {
  439:             $output .= &Apache::loncommon::end_data_table();
  440:         }
  441:         if ($target eq 'tex') {
  442:             $r->print(&Apache::lonxml::xmlparse($r,'tex',&mt('Available functions').'<br /><br />'.$output));
  443:         } else {
  444:             $r->print('<h3>'.&mt('Available Group Tools').'</h3>'.$output);
  445:         }
  446:     } else {
  447:         my $output;
  448:         if ($context eq 'edit') {
  449:             $output = &mt('No group functionality.');
  450:         } else {
  451:             $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>');
  452:         }
  453:         if ($target eq 'tex') {
  454:             $r->print(&Apache::lonxml::xmlparse($r,'tex',$output));
  455:         } else {
  456:             $r->print($output);
  457:         }
  458:     }
  459: }
  460: 
  461: sub grouppage_breadcrumbs {
  462:     my ($cdom,$cnum,$group,$description) = @_;
  463:     &Apache::lonhtmlcommon::clear_breadcrumbs();
  464:     return [{href=>"/adm/coursegroups",
  465:              text=>"Groups",
  466:              title=>"Display Groups"},
  467:             {href=>"/adm/$cdom/$cnum/$group/smppg?ref=grouplist",
  468:              text=>&mt('Group:')." $description",
  469:              title=>"Go to group's home page"},
  470:            ];
  471: }
  472: 
  473: 1;
  474: __END__