Annotation of loncom/interface/lonsyllabus.pm, revision 1.52

1.1       www         1: # The LearningOnline Network
                      2: # Syllabus
                      3: #
1.52    ! www         4: # $Id: lonsyllabus.pm,v 1.51 2006/04/10 19:59:54 albertel Exp $
1.1       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: #
                     28: 
                     29: package Apache::lonsyllabus;
                     30: 
                     31: use strict;
                     32: use Apache::Constants qw(:common);
                     33: use Apache::loncommon;
                     34: use Apache::lonnet;
1.5       www        35: use Apache::lontexconvert;
1.11      www        36: use Apache::lonfeedback;
1.19      www        37: use Apache::lonannounce;
1.23      www        38: use Apache::lonlocal;
1.32      www        39: use Apache::lonhtmlcommon;
1.38      www        40: use Apache::lonspeller();
1.1       www        41: 
                     42: sub handler {
                     43:     my $r = shift;
1.46      www        44:     &Apache::loncommon::content_type($r,'text/html');
                     45:     $r->send_http_header;
                     46:     return OK if $r->header_only;
1.45      www        47: 
1.46      www        48:     my $target=$env{'form.grade_target'};
1.45      www        49: # --------------------------------------------------- Get course info from URL
                     50:     my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri);
1.46      www        51: # ------------------------------------------------------------ Get query string
                     52:     &Apache::loncommon::get_unprocessed_cgi
1.47      www        53:                         ($ENV{'QUERY_STRING'},['forcestudent','register','forceedit','wrapperdisplay']);
1.45      www        54: # ----------------------------------------------------- Is this even a course?
                     55:     my $homeserver=&Apache::lonnet::homeserver($cnum,$cdom);
                     56:     if ($homeserver eq 'no_host') {
                     57:         &Apache::loncommon::content_type($r,'text/html');
                     58:         $r->send_http_header;
1.49      albertel   59:       	&Apache::loncommon::simple_error_page($r,'No syllabus available',
                     60: 					      'No syllabus available');
1.45      www        61:         return OK;
                     62:     }
                     63: # ------------------------------------- There is such a course, get environment
                     64:     my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum);
1.46      www        65: 
1.1       www        66: # ------------------------------------------------------------ Print the screen
1.49      albertel   67: 
                     68:     my $rss_link =
                     69: 	&Apache::lonrss::rss_link('http://'.$ENV{'HTTP_HOST'}.'/public/'.$cdom.'/'.$cnum.'/Course_Announcements.rss');
                     70: 
                     71:     if ($target eq 'tex') {
1.40      albertel   72: 	$r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
1.28      sakharuk   73:     } 
1.46      www        74: # -------------------------------------------------- Let's see who handles this
1.47      www        75:     my $externalsyllabus=$courseenv{'externalsyllabus'};
1.49      albertel   76: 
1.46      www        77:     if ($externalsyllabus=~/\w/) {
1.50      albertel   78: 	
1.47      www        79:        if ($env{'form.wrapperdisplay'} eq 'menu') {
1.50      albertel   80: 	   $r->print(&Apache::lonwrapper::simple_menu());
                     81:        } else {	    
                     82: 	   $r->print(&Apache::lonwrapper::wrapper("/public/$cdom/$cnum/syllabus?wrapperdisplay=menu",
                     83: 						   $externalsyllabus));
                     84:        }
                     85:        return OK;
1.47      www        86:      } 
1.42      www        87: 
1.46      www        88: # ------------------------------ The buck stops here: internal syllabus display
1.5       www        89: # --------------------------------------------------------- The syllabus fields
1.23      www        90:     my %syllabusfields=&Apache::lonlocal::texthash(
1.5       www        91:        'aaa_instructorinfo' => 'Instructor Information',
                     92:        'bbb_description'    => 'Course Description',
                     93:        'ccc_prereq'         => 'Prerequisites',
1.7       www        94:        'cdc_classhours'     => 'Class Hours',
1.5       www        95:        'ddd_officehours'    => 'Office Hours',
                     96:        'eee_helproom'       => 'Helproom Hours',
1.7       www        97:        'efe_projectinfo'    => 'Project Information',
1.5       www        98:        'fff_examinfo'       => 'Exam Information',
1.7       www        99:        'fgf_deadlines'      => 'Deadlines',
1.5       www       100:        'ggg_grading'        => 'Grading Information',
1.7       www       101:        'hhh_readings'       => 'Readings',
                    102:        'iii_coursepack'     => 'Coursepack',
                    103:        'jjj_weblinks'       => 'Web Links',
1.9       www       104:        'kkk_textbook'       => 'Textbook',
                    105:        'lll_includeurl'     => 'URLs To Include in Syllabus');
1.6       www       106: # --------------------------------------------------------------- Force Student
                    107:     my $forcestudent='';
1.40      albertel  108:     if ($env{'form.forcestudent'}) { $forcestudent='student'; };
1.27      www       109:     my $forceedit='';
1.40      albertel  110:     if ($env{'form.forceedit'}) { $forceedit='edit'; }
1.5       www       111:        
1.45      www       112: # ----------------------------------------------------------------- Make header 
1.28      sakharuk  113:     if ($target ne 'tex') {
1.49      albertel  114: 	my $start_page = 
                    115: 	    &Apache::loncommon::start_page("Syllabus", $rss_link,
                    116: 					   {'function'       => $forcestudent,
                    117: 					    'domain'         => $cdom,
                    118: 					    'force_register' =>
                    119: 						$env{'form.register'},});
                    120: 
                    121: 	$r->print($start_page.'<h1>'.$courseenv{'description'}.'</h1><h3>'.
1.28      sakharuk  122:                  $Apache::lonnet::domaindescription{$cdom}.'</h3>');
                    123:     } else {
1.29      sakharuk  124: 	$r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
1.28      sakharuk  125:                  $Apache::lonnet::domaindescription{$cdom}.'}\\\\');
                    126:     }
1.19      www       127: # -------------------------------------------------------------- Announcements?
1.49      albertel  128:     my $day = &Apache::lonannounce::showday(time,2,
                    129: 			 &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
1.35      sakharuk  130:     if ($target ne 'tex') {
1.52    ! www       131: 	$r->print($day. &Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
1.35      sakharuk  132:     } else {
1.49      albertel  133: 	$r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
1.35      sakharuk  134:     }
1.49      albertel  135: 
1.17      www       136: # -------------------------------------------------------- Get course personnel
                    137:     my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
1.28      sakharuk  138:     if ($target ne 'tex') {
                    139: 	$r->print('<table border="2">');
                    140:     } else {
1.37      sakharuk  141: 	$r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline');
1.28      sakharuk  142:     }
1.36      sakharuk  143:     foreach my $element (sort keys %coursepersonnel) {
1.28      sakharuk  144: 	if ($target ne 'tex') {
1.36      sakharuk  145: 	    $r->print('<tr><td>'.$element.'</td><td>');
1.28      sakharuk  146: 	} else {
1.36      sakharuk  147: 	    $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & '); 
1.28      sakharuk  148: 	}
1.36      sakharuk  149:         foreach (split(/\,/,$coursepersonnel{$element})) {
1.17      www       150: 	    my ($puname,$pudom)=split(/\:/,$_);
1.28      sakharuk  151: 	    if ($target ne 'tex') {
                    152: 		$r->print(' '.&Apache::loncommon::aboutmewrapper(
                    153:                               &Apache::loncommon::plainname($puname,
                    154:                               $pudom),$puname,$pudom));
                    155: 	    } else {
                    156: 		$r->print(' '.&Apache::loncommon::plainname($puname,
                    157:                               $pudom).' ');
                    158: 	    }
1.17      www       159: 	}
1.28      sakharuk  160: 	if ($target ne 'tex') {
                    161: 	    $r->print('</td></tr>');
                    162: 	} else {
                    163: 	    $r->print('\\\\ \hline');
                    164: 	}
                    165:     }
                    166:     if ($target ne 'tex') {
                    167: 	$r->print('</table>');
                    168:     } else {
                    169: 	$r->print('\end{tabular}\\\\');
1.17      www       170:     }
                    171: # ---------------------------------------------------------- Load syllabus info
1.4       www       172:     my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);
1.5       www       173:     my $allowed=0;
1.27      www       174:     my $privileged=0;
1.4       www       175: 
1.2       www       176: # This handler might be called anonymously ...
                    177: # ----------------------------------------------------- Only if not public call
1.40      albertel  178:     if ($env{'user.environment'}) {
1.1       www       179: # does this user have privileges to post, etc?
1.40      albertel  180:        if ($env{'request.course.id'}) {
                    181:           $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
1.27      www       182: 	  $privileged=$allowed;
                    183: 	  if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
                    184: 	      $forcestudent='student';
                    185: 	  }
1.30      sakharuk  186:           if ($forcestudent or $target eq 'tex') { $allowed=0; }
1.2       www       187:        }
1.6       www       188:        if ($allowed) {
1.12      www       189:           $r->print('<p>'.
1.23      www       190: &Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes','Help with filling in text boxes').'</p><p>'.&mt('This syllabus can be publicly viewed at')
                    191: 		    .' <tt>http://'.
1.10      www       192: 		    $Apache::lonnet::hostname{$homeserver}.$r->uri.'</tt>'.
                    193:                &Apache::loncommon::help_open_topic('Syllabus_ExtLink').'</p>'.
1.47      www       194:           '<p>'.&mt('You can specify an external URL as Syllabus in the [_1].','<a href="/adm/parmset?action=crsenv">'.&mt('Course Parameters').'</a>').'</p>'.
1.27      www       195: 	  '<p><a href="'.$r->uri.'?forcestudent=1"><font size="+1">'.
                    196: &mt('Show Public View').'</font></a>'.
1.10      www       197:           &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').
                    198:           '</p>');
1.27      www       199:       } elsif ($privileged) {
1.28      sakharuk  200: 	  if ($target ne 'tex') {
                    201: 	      $r->print('<p><a href="'.$r->uri.'?forceedit=1"><font size="+1">'.
                    202: 			&mt('Edit').'</font></a>'); 
                    203: 	  }
1.6       www       204:       }
1.40      albertel  205:        if (($allowed) && ($env{'form.storesyl'})) {
1.5       www       206: 	   foreach (keys %syllabusfields) {
1.40      albertel  207:                my $field=$env{'form.'.$_};
1.33      www       208: 	       chomp($field);
1.5       www       209:                $field=~s/\s+$//s;
1.33      www       210: 	       $field=~s/^\s+//s;
                    211: 	       $field=~s/\<br\s*\/*\>$//s;
                    212: 	       $field=&Apache::lonfeedback::clear_out_html($field,1);
1.7       www       213: 	       $syllabus{$_}=$field;
1.9       www       214:                if ($_ eq 'lll_includeurl') { # clean up included URLs
                    215:                   my $field='';
                    216: 	          foreach (split(/\n/,$syllabus{$_})) {
                    217: 		      my $url=$_;
                    218: # get rid of leading and trailing spaces
                    219:                       $url=~s/^\s+//;
                    220:                       $url=~s/\s+$//;
                    221:                       if ($url=~/^http\:\/\/([^\/]+)\/(.+)$/) {
                    222:                           my $remainder=$2;
                    223: # remove the hostname from internal URLs
                    224: 		          foreach (keys %Apache::lonnet::hostname) {
                    225:                               if ($1=~/$Apache::lonnet::hostname{$_}/i) {
                    226: 			         $url=$remainder;
                    227: 			      }
                    228: 		          }
                    229: 		      }
                    230: # norm internal URLs
                    231:                       unless ($url=~/^http\:/) {
                    232: 		          $url=&Apache::lonnet::clutter($url);
                    233:                       }
                    234: # re-assemble field
                    235:                       if ($url) {
                    236: 		          $field.=$url."\n";
                    237:                       }
                    238: 		  }
                    239:                   $syllabus{$_}=$field;
                    240: 	      }
1.5       www       241:            }
1.40      albertel  242:            $syllabus{'uploaded.domain'}=$env{'user.domain'};
                    243:            $syllabus{'uploaded.name'}=$env{'user.name'};
1.5       www       244:            $syllabus{'uploaded.lastmodified'}=time;
                    245:            &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
                    246:        }
1.4       www       247:     }
                    248: # ---------------------------------------------------------------- Get syllabus
1.5       www       249:     if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
1.8       www       250:        my $lastmod=$syllabus{'uploaded.lastmodified'};
1.25      www       251:        $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
1.26      albertel  252:        my $who = &Apache::loncommon::aboutmewrapper(
                    253:                     &Apache::loncommon::plainname($syllabus{'uploaded.name'},
1.7       www       254:                      $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
1.26      albertel  255:                      $syllabus{'uploaded.domain'});
1.28      sakharuk  256:        if ($target ne 'tex') {
                    257: 	   $r->print('<table><tr><td>'.&mt('Last updated').':</td><td>'.
                    258: 		     $lastmod.'</td><td>'.&mt('by').' '.$who.
                    259: 		     '</td></tr></table><p>');
                    260:        } else {
                    261: 	   $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.&mt('by').'\\\\ '.
                    262: 		     &Apache::loncommon::plainname($syllabus{'uploaded.name'},
                    263:                      $syllabus{'uploaded.domain'}).'\\\\');
                    264:        }
1.5       www       265:        if ($allowed) {
1.27      www       266: 	   $r->print('<form method="post">'.
                    267: 		     '<input type="hidden" name="forceedit" value="edit" />');
1.5       www       268:        }
1.33      www       269:        my @htmlids=();
1.5       www       270:        foreach (sort keys %syllabusfields) {
1.32      www       271:           if (($syllabus{$_}=~/\w/) || ($allowed)) {
1.5       www       272:               my $message=$syllabus{$_};
1.9       www       273:               if ($_ eq 'lll_includeurl') { # this is the "included" field
                    274: 		  my $urls=$message;
                    275:                   $message='';
                    276:                   foreach my $filelink (split(/\n/,$urls)) {
                    277: 		      my $output='';
                    278: # embed style?
                    279: 		      my ($curfext)=($filelink=~/\.([^\.]+)$/);
                    280:                       my $embstyle=&Apache::loncommon::fileembstyle($curfext);
1.12      www       281: 	              if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {
1.9       www       282: # make ssi call and remove everything but the body contents
1.13      www       283: 			  $output=&Apache::lonnet::ssi_body($filelink);
1.9       www       284: 	              } elsif ($embstyle eq 'img') {
                    285: # embed as an image
                    286:                          $output='<img src="'.$filelink.'" />';
                    287: 		      }
1.34      sakharuk  288: 		      if ($target ne 'tex') {
                    289: 			  $message.='<p>'.$output.'</p>';
                    290: 		      } else {
                    291: 			  $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
                    292: 		      }		      
1.9       www       293:                   }
                    294:                   if ($allowed) {
                    295:                      $r->print('<h3>'.$syllabusfields{$_}.
1.10      www       296:           &Apache::loncommon::help_open_topic('Syllabus_URLs').'</h3>'.
1.27      www       297: 	  '<p><a href="'.$r->uri.'?forcestudent=1"><font size="+1">'.&mt('Show Public View').'</font></a>'.
1.10      www       298:  &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').'</p>');
1.9       www       299: 		 } else {
                    300:                   $r->print($message);
                    301:                  } 
                    302:               } else {
1.41      albertel  303: 		  &Apache::lonfeedback::newline_to_br(\$message);
1.9       www       304:                  $message
1.20      www       305:            =~s/(https*\:\/\/[^\s]+)/\<a href=\"$1\"\>\<tt\>$1\<\/tt\>\<\/a\>/g;
1.38      www       306: 		 if ($allowed) {
                    307: 		     $message=&Apache::lonspeller::markeduptext($message);
                    308: 		 }
1.9       www       309: 	         $message=&Apache::lontexconvert::msgtexconverted($message);
1.28      sakharuk  310: 		 if ($target ne 'tex') {
                    311: 		     $r->print('<h3>'.$syllabusfields{$_}.'</h3><blockquote>'.
                    312:                                $message.'</blockquote>');
                    313: 		 } else {
                    314: 		     $r->print('\\\\\textbf{'.$syllabusfields{$_}.'}\\\\'.
1.31      sakharuk  315: 			       &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
1.28      sakharuk  316: 		 }
1.33      www       317: 		 push @htmlids,$_;
1.9       www       318: 	     }
1.5       www       319:               if ($allowed) {
1.33      www       320:                  $r->print(
                    321: 	   '<br /><textarea cols="80" rows="12" name="'.$_.'" id="'.$_.'">'.
1.5       www       322: 			   $syllabus{$_}.
1.33      www       323:            '</textarea> <input type="submit" name="storesyl" value="Store" />');
1.5       www       324: 	      }
                    325: 	  }
                    326:        }
                    327:        if ($allowed) {
1.32      www       328: 	   $r->print('</form>'.
1.33      www       329: 		     &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
1.5       www       330:        }
1.28      sakharuk  331:        if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
1.4       www       332:     } else {
1.36      sakharuk  333: 	if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');} 
                    334: 	$r->print('No syllabus information provided.');
                    335: 	if ($target ne 'tex') {$r->print('</p>');}
1.1       www       336:     }
1.48      albertel  337:     if ($target ne 'tex') {
                    338: 	$r->print(&Apache::loncommon::end_page());
                    339:     } else {
                    340: 	$r->print('\end{document}');
                    341:     }
1.1       www       342:     return OK;
                    343: } 
                    344: 
                    345: 1;
                    346: __END__

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>