File:  [LON-CAPA] / loncom / interface / lonsyllabus.pm
Revision 1.78: download - view: text, annotated - select for diffs
Thu Feb 19 18:55:53 2009 UTC (15 years, 3 months ago) by neumanie
Branches: MAIN
CVS tags: HEAD
Add Box around Rss feeds in sylabus

    1: # The LearningOnline Network
    2: # Syllabus
    3: #
    4: # $Id: lonsyllabus.pm,v 1.78 2009/02/19 18:55:53 neumanie 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::lonsyllabus;
   30: 
   31: use strict;
   32: use Apache::lontemplate;
   33: use Apache::Constants qw(:common);
   34: use Apache::loncommon;
   35: use Apache::lonnet;
   36: use Apache::lontexconvert;
   37: use Apache::lonfeedback;
   38: use Apache::lonannounce;
   39: use Apache::lonlocal;
   40: use Apache::lonhtmlcommon;
   41: use Apache::lonspeller();
   42: use HTML::Entities();
   43: 
   44: sub handler {
   45:     my $r = shift;
   46:     &Apache::loncommon::content_type($r,'text/html');
   47:     $r->send_http_header;
   48:     return OK if $r->header_only;
   49: 
   50:     my $target=$env{'form.grade_target'};
   51: # --------------------------------------------------- Get course info from URL
   52:     my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri);
   53: # ------------------------------------------------------------ Get query string
   54:     &Apache::loncommon::get_unprocessed_cgi
   55:                         ($ENV{'QUERY_STRING'},['forcestudent','register','forceedit','wrapperdisplay']);
   56: # ----------------------------------------------------- Is this even a course?
   57:     my $homeserver=&Apache::lonnet::homeserver($cnum,$cdom);
   58:     if ($homeserver eq 'no_host') {
   59:         &Apache::loncommon::content_type($r,'text/html');
   60:         $r->send_http_header;
   61:       	&Apache::loncommon::simple_error_page($r,'No syllabus available',
   62: 					      'No syllabus available');
   63:         return OK;
   64:     }
   65: # ------------------------------------- There is such a course, get environment
   66:     my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum);
   67: 
   68: # ------------------------------------------------------------ Print the screen
   69: 
   70:     if ($target eq 'tex') {
   71: 	$r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
   72:     } 
   73: # -------------------------------------------------- Let's see who handles this
   74:     my $externalsyllabus=$courseenv{'externalsyllabus'};
   75: 
   76:     if ($externalsyllabus=~/\w/) {
   77: 	
   78:        if ($env{'form.wrapperdisplay'} eq 'menu') {
   79: 	   $r->print(&Apache::lonwrapper::simple_menu());
   80:        } else {	    
   81: 	   $r->print(&Apache::lonwrapper::wrapper("/public/$cdom/$cnum/syllabus?wrapperdisplay=menu",
   82: 						   $externalsyllabus));
   83:        }
   84:        return OK;
   85:      } 
   86: 
   87: # ------------------------------ The buck stops here: internal syllabus display
   88: # --------------------------------------------------------- The syllabus fields
   89:     my %syllabusfields=&Apache::lonlocal::texthash(
   90:        'aaa_instructorinfo' => 'Instructor Information',
   91:        'bbb_description'    => 'Course Description',
   92:        'ccc_prereq'         => 'Prerequisites',
   93:        'cdc_classhours'     => 'Class Hours',
   94:        'ddd_officehours'    => 'Office Hours',
   95:        'eee_helproom'       => 'Helproom Hours',
   96:        'efe_projectinfo'    => 'Project Information',
   97:        'fff_examinfo'       => 'Exam Information',
   98:        'fgf_deadlines'      => 'Deadlines',
   99:        'ggg_grading'        => 'Grading Information',
  100:        'hhh_readings'       => 'Readings',
  101:        'iii_coursepack'     => 'Coursepack',
  102:        'jjj_weblinks'       => 'Web Links',
  103:        'kkk_textbook'       => 'Textbook',
  104:        'lll_includeurl'     => 'URLs To Include in Syllabus');
  105: # --------------------------------------------------------------- Force Student
  106:     my $forcestudent='';
  107:     if ($env{'form.forcestudent'}) { $forcestudent='student'; };
  108:     my $forceedit='';
  109:     if ($env{'form.forceedit'}) { $forceedit='edit'; }
  110:        
  111: # ----------------------------------------------------------------- Make header 
  112:     if ($target ne 'tex') {
  113: 	my $rss_link = &Apache::lonrss::rss_link($cnum,$cdom);
  114:         my $js;
  115:         if ($env{'form.backto'} eq 'coursecatalog') {
  116:             $js .= <<"ENDSCRIPT";
  117: 
  118: <script type="text/javascript">
  119: function ToCatalog(caller) {
  120:     numidx = getIndexByName('coursenum');
  121:     if (numidx > -1) {
  122:         if (caller != 'details') {
  123:             document.backtocat.elements[numidx].value = '';
  124:         }
  125:     }
  126:     document.backtocat.submit();
  127: }
  128: 
  129: function getIndexByName(item) {
  130:     for (var i=0;i<document.backtocat.elements.length;i++) {
  131:         if (document.backtocat.elements[i].name == item) {
  132:             return i;
  133:         }
  134:     }
  135:     return -1;
  136: }
  137: 
  138: </script>
  139: 
  140: ENDSCRIPT
  141:         }
  142: 	my $start_page = 
  143: 	    &Apache::loncommon::start_page("Syllabus", $rss_link.$js,
  144: 					   {'function'       => $forcestudent,
  145: 					    'domain'         => $cdom,
  146: 					    'force_register' =>
  147: 						$env{'form.register'},});
  148: 
  149: 	$r->print($start_page);
  150:         if ($env{'form.backto'} eq 'coursecatalog') {
  151:             &Apache::lonhtmlcommon::clear_breadcrumbs();
  152:             &Apache::lonhtmlcommon::add_breadcrumb
  153:              ({href=>"javascript:ToCatalog()",
  154:                text=>"Course Catalog"});
  155:             if ($env{'form.coursenum'} ne '') {
  156:                 &Apache::lonhtmlcommon::add_breadcrumb
  157:                   ({href=>"javascript:ToCatalog('details')",
  158:                    text=>"Course details"});
  159:             }
  160:             &Apache::lonhtmlcommon::add_breadcrumb
  161:               ({href=>$r->uri,
  162:                text=>"Course syllabus"});
  163:             $r->print(&Apache::lonhtmlcommon::breadcrumbs());
  164:         }
  165:         $r->print('<h1>'.$courseenv{'description'}.'</h1><h3>'.
  166: 		  &Apache::lonnet::domain($cdom,'description').'</h3>');
  167:     } else {
  168: 	$r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
  169: 		  &Apache::lonnet::domain($cdom,'description').'}\\\\');
  170:     }
  171: # -------------------------------------------------------- Get course personnel
  172:     my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
  173:     if ($target ne 'tex') {
  174: 	$r->print(&Apache::lonhtmlcommon::start_pick_box());
  175:     } else {
  176: 	$r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline');
  177:     }
  178:     my @personnel=sort(keys(%coursepersonnel));
  179:     my $lastpers=$personnel[$#personnel];
  180:     foreach my $element (@personnel) {
  181: 	if ($target ne 'tex') {
  182: 	    $r->print(&Apache::lonhtmlcommon::row_title($element));
  183: 	} else {
  184: 	    $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & '); 
  185: 	}
  186:         foreach (split(/\,/,$coursepersonnel{$element})) {
  187: 	    my ($puname,$pudom)=split(/\:/,$_);
  188: 	    if ($target ne 'tex') {
  189:                 my $courseperson = &Apache::loncommon::plainname($puname,$pudom);
  190:                 if (($env{'user.name'} eq '') || ($env{'user.name'} eq 'public') ||
  191:                     ($env{'user.domain'} eq '') || ($env{'user.domain'} eq 'public')) {
  192: 		    $r->print(' '.$courseperson);
  193:                 } else {
  194:                     $r->print(' '.&Apache::loncommon::aboutmewrapper($courseperson,
  195:                               $puname,$pudom));
  196:                 }
  197: 	    } else {
  198: 		$r->print(' '.&Apache::loncommon::plainname($puname,
  199:                               $pudom).' ');
  200: 	    }
  201: 	}
  202: 	if ($target ne 'tex') {
  203:             my $lastclose=$element eq $lastpers?1:0;
  204:             $r->print(&Apache::lonhtmlcommon::row_closure($lastclose));
  205: 	} else {
  206: 	    $r->print('\\\\ \hline');
  207: 	}
  208:     }
  209:     if ($target ne 'tex') {
  210: 	$r->print(&Apache::lonhtmlcommon::end_pick_box());
  211:     } else {
  212: 	$r->print('\end{tabular}\\\\');
  213:     }
  214: # -------------------------------------------------------------- Announcements?
  215:     my $day = &Apache::lonannounce::showday(time,2,
  216: 			 &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
  217:     if ($target ne 'tex') {	
  218: 	&Apache::lontemplate::print_template($r,'RSS Feeds and Blogs',&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit),1,'LC_ContentBoxSpecial');
  219:     } else {
  220: 	$r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
  221:     }
  222: # ---------------------------------------------------------- Load syllabus info
  223:     my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);
  224:     my $allowed=0;
  225:     my $privileged=0;
  226: 
  227: # This handler might be called anonymously ...
  228: # ----------------------------------------------------- Only if not public call
  229:     if ($env{'user.environment'}) {
  230: # does this user have privileges to post, etc?
  231:        if ($env{'request.course.id'}
  232: 	   && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'}
  233: 	   && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) {
  234:           $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
  235: 	  $privileged=$allowed;
  236: 	  if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
  237: 	      $forcestudent='student';
  238: 	  }
  239:           if ($forcestudent or $target eq 'tex') { $allowed=0; }
  240:        }
  241:        if ($allowed) {
  242:           my $protocol = $Apache::lonnet::protocol{$homeserver};
  243:           $protocol = 'http' if ($protocol ne 'https');
  244:           $r->print('<p>'.&Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')).'</p><p>'.&mt('This syllabus can be publicly viewed at')
  245: 		    .' <tt>'.$protocol.'://'.
  246: 		    &Apache::lonnet::hostname($homeserver).$r->uri.'</tt>'.
  247:                &Apache::loncommon::help_open_topic('Syllabus_ExtLink').'</p>'.
  248:           '<p>'.&mt('You can specify an external URL as Syllabus in the [_1].','<a href="/adm/parmset?action=crsenv">'.&mt('Course Parameters').'</a>').'</p>');
  249:       } 
  250:        if (($allowed) && ($env{'form.storesyl'})) {
  251: 	   foreach my $syl_field (keys(%syllabusfields)) {
  252:                my $field=$env{'form.'.$syl_field};
  253: 	       chomp($field);
  254:                $field=~s/\s+$//s;
  255: 	       $field=~s/^\s+//s;
  256: 	       $field=~s/\<br\s*\/*\>$//s;
  257: 	       $field=&Apache::lonfeedback::clear_out_html($field,1);
  258: 	       $syllabus{$syl_field}=$field;
  259:                if ($syl_field eq 'lll_includeurl') { # clean up included URLs
  260:                   my $field='';
  261: 	          foreach my $value (split(/\n/,$syllabus{$syl_field})) {
  262: 		      my $url=$value;
  263: # get rid of leading and trailing spaces
  264:                       $url=~s/^\s+//;
  265:                       $url=~s/\s+$//;
  266:                       if ($url=~m|^https?\://([^/]+)/(.+)$|) {
  267: 			  my $host = $1;
  268:                           my $remainder=$2;
  269: # remove the hostname from internal URLs
  270: 			  my $hostname = &Apache::lonnet::hostname($host);
  271: 			  my %all_hostnames = &Apache::lonnet::all_hostnames();
  272: 		          foreach my $possible_host (keys(%all_hostnames)) {
  273:                               if ($possible_host =~ /\Q$hostname\E/i) {
  274: 			         $url=$remainder;
  275: 			      }
  276: 		          }
  277: 		      }
  278: # norm internal URLs
  279:                       unless ($url=~/^https?\:/) {
  280: 		          $url=&Apache::lonnet::clutter($url);
  281:                       }
  282: # re-assemble field
  283:                       if ($url) {
  284: 		          $field.=$url."\n";
  285:                       }
  286: 		  }
  287:                   $syllabus{$syl_field}=$field;
  288: 	      }
  289:            }
  290:            $syllabus{'uploaded.domain'}=$env{'user.domain'};
  291:            $syllabus{'uploaded.name'}=$env{'user.name'};
  292:            $syllabus{'uploaded.lastmodified'}=time;
  293:            &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
  294:        }
  295:     }
  296: # ---------------------------------------------------------------- Get syllabus
  297:     if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
  298:        my $lastmod=$syllabus{'uploaded.lastmodified'};
  299:        $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
  300:        my $who = &Apache::loncommon::aboutmewrapper(
  301:                     &Apache::loncommon::plainname($syllabus{'uploaded.name'},
  302:                      $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
  303:                      $syllabus{'uploaded.domain'});
  304:        if ($target ne 'tex') {
  305: 	   $r->print('<table><tr><td>'.&mt('Last updated').':</td><td>'.
  306: 		     $lastmod.'</td><td>'.
  307: 		     ($who ? &mt('by').' '.$who
  308:                            : '' ).
  309: 		     '</td></tr></table><p>');
  310:        } else {
  311: 	   $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.
  312: 		     ($who? &mt('by').'\\\\ '.
  313: 		            &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'})
  314: 		          :'')
  315: 		     .'\\\\');
  316:        }
  317:      
  318: 	if ($target ne 'tex') {
  319: 		&Apache::lontemplate::print_start_page_functions($r);
  320: 		if($allowed){
  321: 			&Apache::lontemplate::print_functions_content($r,'<a href="'.$r->uri.'?forcestudent=1">'.&mt('Show Public View').'</a>'.
  322:           											&Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView'));	      		
  323: 		}elsif($privileged){
  324: 			&Apache::lontemplate::print_functions_content($r,'<a href="'.$r->uri.'?forceedit=1">'.&mt('Edit').'</a>'); 
  325: 		}
  326: 		&Apache::lontemplate::print_end_page_functions($r);
  327: 	  }	
  328:       
  329:        if ($allowed) {
  330: 	   $r->print('<form method="post">'.
  331: 		     '<input type="hidden" name="forceedit" value="edit" />');
  332:        }
  333:        my @htmlids=();
  334: 	
  335: 	foreach my $field (sort(keys(%syllabusfields))) {
  336: 	   if (($syllabus{$field}=~/\w/) || ($allowed)) {
  337: 	       my $message=$syllabus{$field};
  338: 	       if ($field eq 'lll_includeurl') { # this is the "included" field
  339: 		   my $urls=$message;
  340: 		   $message='';
  341: 		   foreach my $filelink (split(/\n/,$urls)) {
  342: 		       my $output='';
  343: # embed style?
  344: 		       my ($curfext)=($filelink=~/\.([^\.]+)$/);
  345: 		       my $embstyle=&Apache::loncommon::fileembstyle($curfext);
  346: 		       if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {
  347: # make ssi call and remove everything but the body contents
  348: 			   $output=&Apache::lonnet::ssi_body($filelink);
  349: 		       } elsif ($embstyle eq 'img') {
  350: # embed as an image
  351: 			   $output='<img src="'.$filelink.'" />';
  352: 		       }
  353: 		       if ($target ne 'tex') {
  354: 			   $message.='<p>'.$output.'</p>';
  355: 		       } else {
  356: 			   $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
  357: 		       }      
  358: 		   }
  359: 		   if ($allowed) {
  360: 		       $r->print('<h3>'.$syllabusfields{$field}.
  361: 			 &Apache::loncommon::help_open_topic('Syllabus_URLs').'</h3>');
  362: 		   } else {
  363: 		       $r->print($message);
  364: 		   } 
  365: 	       } else {
  366: 		   &Apache::lonfeedback::newline_to_br(\$message);
  367: 		   $message =~s|(https?\://[^\s]+)|<a href="$1"><tt>$1</tt></a>|g;
  368: 		   if ($allowed) {
  369: 		       $message=&Apache::lonspeller::markeduptext($message);
  370: 		   }
  371: 		   $message=&Apache::lontexconvert::msgtexconverted($message);
  372: 		   if ($target ne 'tex') {
  373: 			if($allowed){
  374: 				$r->print('<p>');
  375: 			}			
  376: 			&Apache::lontemplate::print_template($r, $syllabusfields{$field}, $message,$allowed,'LC_ContentBoxSpecial');
  377: 		   } else {
  378: 		       $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
  379: 				 &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
  380: 		   }
  381: 		   push(@htmlids,$field);
  382: 	       }
  383: 	       if ($allowed) {
  384: 			if($target ne 'tex'){
  385: 				$r->print('</p>');
  386: 			}
  387: 			&Apache::lontemplate::print_editbox_template($r, $syllabus{$field}, $field);
  388: 	       }
  389: 	   }
  390:        }    
  391: 	
  392:        if ($allowed) {
  393: 	   $r->print('</form>'.
  394: 		     &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
  395:        }
  396:        if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
  397:     } else {
  398: 	if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');} 
  399: 	$r->print(&mt('No syllabus information provided.'));
  400: 	if ($target ne 'tex') {$r->print('</p>');}
  401:     }
  402:     if ($target ne 'tex') {
  403:         if ($env{'form.backto'} eq 'coursecatalog') {
  404:             $r->print('<form name="backtocat" method="post" action="/adm/coursecatalog">'.
  405:                       &Apache::lonhtmlcommon::echo_form_input(['backto','courseid']).
  406:                       '</form>');
  407:         }
  408: 	$r->print(&Apache::loncommon::end_page());
  409:     } else {
  410: 	$r->print('\end{document}');
  411:     }
  412:     return OK;
  413: } 
  414: 
  415: 1;
  416: __END__

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