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

1.1       www         1: # The LearningOnline Network
                      2: # Syllabus
                      3: #
1.60    ! albertel    4: # $Id: lonsyllabus.pm,v 1.59 2007/05/02 01:33:49 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.54      albertel   41: use HTML::Entities();
1.1       www        42: 
                     43: sub handler {
                     44:     my $r = shift;
1.46      www        45:     &Apache::loncommon::content_type($r,'text/html');
                     46:     $r->send_http_header;
                     47:     return OK if $r->header_only;
1.45      www        48: 
1.46      www        49:     my $target=$env{'form.grade_target'};
1.45      www        50: # --------------------------------------------------- Get course info from URL
                     51:     my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri);
1.46      www        52: # ------------------------------------------------------------ Get query string
                     53:     &Apache::loncommon::get_unprocessed_cgi
1.47      www        54:                         ($ENV{'QUERY_STRING'},['forcestudent','register','forceedit','wrapperdisplay']);
1.45      www        55: # ----------------------------------------------------- Is this even a course?
                     56:     my $homeserver=&Apache::lonnet::homeserver($cnum,$cdom);
                     57:     if ($homeserver eq 'no_host') {
                     58:         &Apache::loncommon::content_type($r,'text/html');
                     59:         $r->send_http_header;
1.49      albertel   60:       	&Apache::loncommon::simple_error_page($r,'No syllabus available',
                     61: 					      'No syllabus available');
1.45      www        62:         return OK;
                     63:     }
                     64: # ------------------------------------- There is such a course, get environment
                     65:     my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum);
1.46      www        66: 
1.1       www        67: # ------------------------------------------------------------ Print the screen
1.49      albertel   68: 
                     69:     if ($target eq 'tex') {
1.40      albertel   70: 	$r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
1.28      sakharuk   71:     } 
1.46      www        72: # -------------------------------------------------- Let's see who handles this
1.47      www        73:     my $externalsyllabus=$courseenv{'externalsyllabus'};
1.49      albertel   74: 
1.46      www        75:     if ($externalsyllabus=~/\w/) {
1.50      albertel   76: 	
1.47      www        77:        if ($env{'form.wrapperdisplay'} eq 'menu') {
1.50      albertel   78: 	   $r->print(&Apache::lonwrapper::simple_menu());
                     79:        } else {	    
                     80: 	   $r->print(&Apache::lonwrapper::wrapper("/public/$cdom/$cnum/syllabus?wrapperdisplay=menu",
                     81: 						   $externalsyllabus));
                     82:        }
                     83:        return OK;
1.47      www        84:      } 
1.42      www        85: 
1.46      www        86: # ------------------------------ The buck stops here: internal syllabus display
1.5       www        87: # --------------------------------------------------------- The syllabus fields
1.23      www        88:     my %syllabusfields=&Apache::lonlocal::texthash(
1.5       www        89:        'aaa_instructorinfo' => 'Instructor Information',
                     90:        'bbb_description'    => 'Course Description',
                     91:        'ccc_prereq'         => 'Prerequisites',
1.7       www        92:        'cdc_classhours'     => 'Class Hours',
1.5       www        93:        'ddd_officehours'    => 'Office Hours',
                     94:        'eee_helproom'       => 'Helproom Hours',
1.7       www        95:        'efe_projectinfo'    => 'Project Information',
1.5       www        96:        'fff_examinfo'       => 'Exam Information',
1.7       www        97:        'fgf_deadlines'      => 'Deadlines',
1.5       www        98:        'ggg_grading'        => 'Grading Information',
1.7       www        99:        'hhh_readings'       => 'Readings',
                    100:        'iii_coursepack'     => 'Coursepack',
                    101:        'jjj_weblinks'       => 'Web Links',
1.9       www       102:        'kkk_textbook'       => 'Textbook',
                    103:        'lll_includeurl'     => 'URLs To Include in Syllabus');
1.6       www       104: # --------------------------------------------------------------- Force Student
                    105:     my $forcestudent='';
1.40      albertel  106:     if ($env{'form.forcestudent'}) { $forcestudent='student'; };
1.27      www       107:     my $forceedit='';
1.40      albertel  108:     if ($env{'form.forceedit'}) { $forceedit='edit'; }
1.5       www       109:        
1.45      www       110: # ----------------------------------------------------------------- Make header 
1.28      sakharuk  111:     if ($target ne 'tex') {
1.60    ! albertel  112: 	my $rss_link = &Apache::lonrss::rss_link($cnum,$cdom);
        !           113:     
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.58      albertel  122: 		  &Apache::lonnet::domain($cdom,'description').'</h3>');
1.28      sakharuk  123:     } else {
1.29      sakharuk  124: 	$r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
1.58      albertel  125: 		  &Apache::lonnet::domain($cdom,'description').'}\\\\');
1.28      sakharuk  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.53      albertel  180:        if ($env{'request.course.id'}
                    181: 	   && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'}
                    182: 	   && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) {
1.40      albertel  183:           $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
1.27      www       184: 	  $privileged=$allowed;
                    185: 	  if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
                    186: 	      $forcestudent='student';
                    187: 	  }
1.30      sakharuk  188:           if ($forcestudent or $target eq 'tex') { $allowed=0; }
1.2       www       189:        }
1.6       www       190:        if ($allowed) {
1.12      www       191:           $r->print('<p>'.
1.23      www       192: &Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes','Help with filling in text boxes').'</p><p>'.&mt('This syllabus can be publicly viewed at')
                    193: 		    .' <tt>http://'.
1.57      albertel  194: 		    &Apache::lonnet::hostname($homeserver).$r->uri.'</tt>'.
1.10      www       195:                &Apache::loncommon::help_open_topic('Syllabus_ExtLink').'</p>'.
1.47      www       196:           '<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       197: 	  '<p><a href="'.$r->uri.'?forcestudent=1"><font size="+1">'.
                    198: &mt('Show Public View').'</font></a>'.
1.10      www       199:           &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').
                    200:           '</p>');
1.27      www       201:       } elsif ($privileged) {
1.28      sakharuk  202: 	  if ($target ne 'tex') {
                    203: 	      $r->print('<p><a href="'.$r->uri.'?forceedit=1"><font size="+1">'.
                    204: 			&mt('Edit').'</font></a>'); 
                    205: 	  }
1.6       www       206:       }
1.40      albertel  207:        if (($allowed) && ($env{'form.storesyl'})) {
1.55      albertel  208: 	   foreach my $syl_field (keys(%syllabusfields)) {
                    209:                my $field=$env{'form.'.$syl_field};
1.33      www       210: 	       chomp($field);
1.5       www       211:                $field=~s/\s+$//s;
1.33      www       212: 	       $field=~s/^\s+//s;
                    213: 	       $field=~s/\<br\s*\/*\>$//s;
                    214: 	       $field=&Apache::lonfeedback::clear_out_html($field,1);
1.55      albertel  215: 	       $syllabus{$syl_field}=$field;
                    216:                if ($syl_field eq 'lll_includeurl') { # clean up included URLs
1.9       www       217:                   my $field='';
1.55      albertel  218: 	          foreach my $value (split(/\n/,$syllabus{$syl_field})) {
                    219: 		      my $url=$value;
1.9       www       220: # get rid of leading and trailing spaces
                    221:                       $url=~s/^\s+//;
                    222:                       $url=~s/\s+$//;
1.55      albertel  223:                       if ($url=~m|^http://([^/]+)/(.+)$|) {
                    224: 			  my $host = $1;
1.9       www       225:                           my $remainder=$2;
                    226: # remove the hostname from internal URLs
1.57      albertel  227: 			  my $hostname = &Apache::lonnet::hostname($host);
                    228: 			  my %all_hostnames = &Apache::lonnet::all_hostnames();
                    229: 		          foreach my $possible_host (keys(%all_hostnames)) {
                    230:                               if ($possible_host =~ /\Q$hostname\E/i) {
1.9       www       231: 			         $url=$remainder;
                    232: 			      }
                    233: 		          }
                    234: 		      }
                    235: # norm internal URLs
                    236:                       unless ($url=~/^http\:/) {
                    237: 		          $url=&Apache::lonnet::clutter($url);
                    238:                       }
                    239: # re-assemble field
                    240:                       if ($url) {
                    241: 		          $field.=$url."\n";
                    242:                       }
                    243: 		  }
1.55      albertel  244:                   $syllabus{$syl_field}=$field;
1.9       www       245: 	      }
1.5       www       246:            }
1.40      albertel  247:            $syllabus{'uploaded.domain'}=$env{'user.domain'};
                    248:            $syllabus{'uploaded.name'}=$env{'user.name'};
1.5       www       249:            $syllabus{'uploaded.lastmodified'}=time;
                    250:            &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
                    251:        }
1.4       www       252:     }
                    253: # ---------------------------------------------------------------- Get syllabus
1.5       www       254:     if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
1.8       www       255:        my $lastmod=$syllabus{'uploaded.lastmodified'};
1.25      www       256:        $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
1.26      albertel  257:        my $who = &Apache::loncommon::aboutmewrapper(
                    258:                     &Apache::loncommon::plainname($syllabus{'uploaded.name'},
1.7       www       259:                      $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
1.26      albertel  260:                      $syllabus{'uploaded.domain'});
1.28      sakharuk  261:        if ($target ne 'tex') {
                    262: 	   $r->print('<table><tr><td>'.&mt('Last updated').':</td><td>'.
                    263: 		     $lastmod.'</td><td>'.&mt('by').' '.$who.
                    264: 		     '</td></tr></table><p>');
                    265:        } else {
                    266: 	   $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.&mt('by').'\\\\ '.
                    267: 		     &Apache::loncommon::plainname($syllabus{'uploaded.name'},
                    268:                      $syllabus{'uploaded.domain'}).'\\\\');
                    269:        }
1.5       www       270:        if ($allowed) {
1.27      www       271: 	   $r->print('<form method="post">'.
                    272: 		     '<input type="hidden" name="forceedit" value="edit" />');
1.5       www       273:        }
1.33      www       274:        my @htmlids=();
1.55      albertel  275:        foreach my $field (sort(keys(%syllabusfields))) {
                    276: 	   if (($syllabus{$field}=~/\w/) || ($allowed)) {
                    277: 	       my $message=$syllabus{$field};
                    278: 	       if ($field eq 'lll_includeurl') { # this is the "included" field
                    279: 		   my $urls=$message;
                    280: 		   $message='';
                    281: 		   foreach my $filelink (split(/\n/,$urls)) {
                    282: 		       my $output='';
1.9       www       283: # embed style?
1.55      albertel  284: 		       my ($curfext)=($filelink=~/\.([^\.]+)$/);
                    285: 		       my $embstyle=&Apache::loncommon::fileembstyle($curfext);
                    286: 		       if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {
1.9       www       287: # make ssi call and remove everything but the body contents
1.55      albertel  288: 			   $output=&Apache::lonnet::ssi_body($filelink);
                    289: 		       } elsif ($embstyle eq 'img') {
1.9       www       290: # embed as an image
1.55      albertel  291: 			   $output='<img src="'.$filelink.'" />';
                    292: 		       }
                    293: 		       if ($target ne 'tex') {
                    294: 			   $message.='<p>'.$output.'</p>';
                    295: 		       } else {
                    296: 			   $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
                    297: 		       }      
                    298: 		   }
                    299: 		   if ($allowed) {
                    300: 		       $r->print('<h3>'.$syllabusfields{$field}.
                    301: 				 &Apache::loncommon::help_open_topic('Syllabus_URLs').'</h3>'.
                    302: 				 '<p><a href="'.$r->uri.'?forcestudent=1"><font size="+1">'.&mt('Show Public View').'</font></a>'.
                    303: 				 &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').'</p>');
                    304: 		   } else {
                    305: 		       $r->print($message);
                    306: 		   } 
                    307: 	       } else {
                    308: 		   &Apache::lonfeedback::newline_to_br(\$message);
1.56      banghart  309: 		   $message =~s|(https*://[^\s]+)|<a href="$1"><tt>$1</tt></a>|g;
1.55      albertel  310: 		   if ($allowed) {
                    311: 		       $message=&Apache::lonspeller::markeduptext($message);
                    312: 		   }
                    313: 		   $message=&Apache::lontexconvert::msgtexconverted($message);
                    314: 		   if ($target ne 'tex') {
                    315: 		       $r->print('<h3>'.$syllabusfields{$field}.'</h3><blockquote>'.
                    316: 				 $message.'</blockquote>');
                    317: 		   } else {
                    318: 		       $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
                    319: 				 &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
                    320: 		   }
                    321: 		   push(@htmlids,$field);
                    322: 	       }
                    323: 	       if ($allowed) {
                    324: 		   $r->print('<br /><textarea cols="80" rows="12" name="'.$field.'" id="'.$field.'">'.
                    325: 			     &HTML::Entities::encode($syllabus{$field},'"&<>').
1.59      albertel  326: 			     '</textarea> <input type="submit" name="storesyl" value="Save" />');
1.55      albertel  327: 	       }
                    328: 	   }
1.5       www       329:        }
                    330:        if ($allowed) {
1.32      www       331: 	   $r->print('</form>'.
1.33      www       332: 		     &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
1.5       www       333:        }
1.28      sakharuk  334:        if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
1.4       www       335:     } else {
1.36      sakharuk  336: 	if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');} 
                    337: 	$r->print('No syllabus information provided.');
                    338: 	if ($target ne 'tex') {$r->print('</p>');}
1.1       www       339:     }
1.48      albertel  340:     if ($target ne 'tex') {
                    341: 	$r->print(&Apache::loncommon::end_page());
                    342:     } else {
                    343: 	$r->print('\end{document}');
                    344:     }
1.1       www       345:     return OK;
                    346: } 
                    347: 
                    348: 1;
                    349: __END__

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