Return to lonsimplepage.pm CVS log

Up to [LON-CAPA] / loncom / interface

Optimized names for sub routines which create functionslists:
- Standarized/more consistent compared to exisiting routine names (e.g., start_data_table)
- Betting fitting with regard to routine's functionality
- No misunderstood connection to start_page routine anymore

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