Annotation of loncom/interface/lonsyllabus.pm, revision 1.97
1.1 www 1: # The LearningOnline Network
2: # Syllabus
3: #
1.97 ! amueller 4: # $Id: lonsyllabus.pm,v 1.96 2009/09/07 18:31:50 raeburn 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;
1.70 amueller 32: use Apache::lontemplate;
1.1 www 33: use Apache::Constants qw(:common);
34: use Apache::loncommon;
35: use Apache::lonnet;
1.5 www 36: use Apache::lontexconvert;
1.11 www 37: use Apache::lonfeedback;
1.19 www 38: use Apache::lonannounce;
1.23 www 39: use Apache::lonlocal;
1.32 www 40: use Apache::lonhtmlcommon;
1.38 www 41: use Apache::lonspeller();
1.54 albertel 42: use HTML::Entities();
1.1 www 43:
44: sub handler {
45: my $r = shift;
1.46 www 46: &Apache::loncommon::content_type($r,'text/html');
47: $r->send_http_header;
48: return OK if $r->header_only;
1.45 www 49:
1.46 www 50: my $target=$env{'form.grade_target'};
1.45 www 51: # --------------------------------------------------- Get course info from URL
52: my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri);
1.46 www 53: # ------------------------------------------------------------ Get query string
54: &Apache::loncommon::get_unprocessed_cgi
1.47 www 55: ($ENV{'QUERY_STRING'},['forcestudent','register','forceedit','wrapperdisplay']);
1.45 www 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;
1.91 amueller 61: &Apache::loncommon::simple_error_page($r,'No syllabus available',
62: 'No syllabus available');
1.45 www 63: return OK;
64: }
65: # ------------------------------------- There is such a course, get environment
66: my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum);
1.46 www 67:
1.1 www 68: # ------------------------------------------------------------ Print the screen
1.49 albertel 69:
70: if ($target eq 'tex') {
1.91 amueller 71: $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
1.86 bisitz 72: }
1.46 www 73: # -------------------------------------------------- Let's see who handles this
1.47 www 74: my $externalsyllabus=$courseenv{'externalsyllabus'};
1.49 albertel 75:
1.46 www 76: if ($externalsyllabus=~/\w/) {
1.86 bisitz 77:
1.47 www 78: if ($env{'form.wrapperdisplay'} eq 'menu') {
1.91 amueller 79: $r->print(&Apache::lonwrapper::simple_menu());
1.86 bisitz 80: } else {
1.91 amueller 81: $r->print(&Apache::lonwrapper::wrapper("/public/$cdom/$cnum/syllabus?wrapperdisplay=menu",
82: $externalsyllabus));
1.50 albertel 83: }
84: return OK;
1.90 amueller 85: }
1.42 www 86:
1.46 www 87: # ------------------------------ The buck stops here: internal syllabus display
1.5 www 88: # --------------------------------------------------------- The syllabus fields
1.23 www 89: my %syllabusfields=&Apache::lonlocal::texthash(
1.5 www 90: 'aaa_instructorinfo' => 'Instructor Information',
91: 'bbb_description' => 'Course Description',
92: 'ccc_prereq' => 'Prerequisites',
1.7 www 93: 'cdc_classhours' => 'Class Hours',
1.5 www 94: 'ddd_officehours' => 'Office Hours',
95: 'eee_helproom' => 'Helproom Hours',
1.7 www 96: 'efe_projectinfo' => 'Project Information',
1.5 www 97: 'fff_examinfo' => 'Exam Information',
1.7 www 98: 'fgf_deadlines' => 'Deadlines',
1.5 www 99: 'ggg_grading' => 'Grading Information',
1.7 www 100: 'hhh_readings' => 'Readings',
101: 'iii_coursepack' => 'Coursepack',
102: 'jjj_weblinks' => 'Web Links',
1.9 www 103: 'kkk_textbook' => 'Textbook',
104: 'lll_includeurl' => 'URLs To Include in Syllabus');
1.6 www 105: # --------------------------------------------------------------- Force Student
106: my $forcestudent='';
1.40 albertel 107: if ($env{'form.forcestudent'}) { $forcestudent='student'; };
1.27 www 108: my $forceedit='';
1.40 albertel 109: if ($env{'form.forceedit'}) { $forceedit='edit'; }
1.86 bisitz 110:
111: # ----------------------------------------------------------------- Make header
1.28 sakharuk 112: if ($target ne 'tex') {
1.91 amueller 113: my $rss_link = &Apache::lonrss::rss_link($cnum,$cdom);
1.65 raeburn 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');
1.90 amueller 121: if (numidx > -1) {
122: if (caller != 'details') {
123: document.backtocat.elements[numidx].value = '';
124: }
1.65 raeburn 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: }
1.91 amueller 142: my $start_page =
143: &Apache::loncommon::start_page("Syllabus", $rss_link.$js,
1.97 ! amueller 144: {'function' => undef,
1.91 amueller 145: 'domain' => $cdom,
146: 'force_register' =>
147: $env{'form.register'},});
1.49 albertel 148:
1.91 amueller 149: $r->print($start_page);
1.65 raeburn 150: if ($env{'form.backto'} eq 'coursecatalog') {
151: &Apache::lonhtmlcommon::clear_breadcrumbs();
152: &Apache::lonhtmlcommon::add_breadcrumb
1.90 amueller 153: ({href=>"javascript:ToCatalog()",
154: text=>"Course Catalog"});
1.65 raeburn 155: if ($env{'form.coursenum'} ne '') {
156: &Apache::lonhtmlcommon::add_breadcrumb
1.90 amueller 157: ({href=>"javascript:ToCatalog('details')",
158: text=>"Course details"});
1.65 raeburn 159: }
160: &Apache::lonhtmlcommon::add_breadcrumb
1.90 amueller 161: ({href=>$r->uri,
162: text=>"Course syllabus"});
1.65 raeburn 163: $r->print(&Apache::lonhtmlcommon::breadcrumbs());
1.86 bisitz 164: }
1.17 www 165: }
166: # ---------------------------------------------------------- Load syllabus info
1.4 www 167: my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);
1.5 www 168: my $allowed=0;
1.27 www 169: my $privileged=0;
1.4 www 170:
1.2 www 171: # This handler might be called anonymously ...
172: # ----------------------------------------------------- Only if not public call
1.40 albertel 173: if ($env{'user.environment'}) {
1.1 www 174: # does this user have privileges to post, etc?
1.90 amueller 175: if ($env{'request.course.id'}
1.91 amueller 176: && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'}
177: && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) {
1.90 amueller 178: $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
1.91 amueller 179: $privileged=$allowed;
180: if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
181: $forcestudent='student';
182: }
1.90 amueller 183: if ($forcestudent or $target eq 'tex') { $allowed=0; }
184: }
185: if (($allowed) && ($env{'form.storesyl'})) {
1.91 amueller 186: foreach my $syl_field (keys(%syllabusfields)) {
1.90 amueller 187: my $field=$env{'form.'.$syl_field};
1.91 amueller 188: chomp($field);
1.90 amueller 189: $field=~s/\s+$//s;
1.91 amueller 190: $field=~s/^\s+//s;
191: $field=~s/\<br\s*\/*\>$//s;
192: $field=&Apache::lonfeedback::clear_out_html($field,1);
193: $syllabus{$syl_field}=$field;
1.90 amueller 194: if ($syl_field eq 'lll_includeurl') { # clean up included URLs
195: my $field='';
1.91 amueller 196: foreach my $value (split(/\n/,$syllabus{$syl_field})) {
197: my $url=$value;
1.9 www 198: # get rid of leading and trailing spaces
1.90 amueller 199: $url=~s/^\s+//;
200: $url=~s/\s+$//;
201: if ($url=~m|^https?\://([^/]+)/(.+)$|) {
1.91 amueller 202: my $host = $1;
1.90 amueller 203: my $remainder=$2;
1.9 www 204: # remove the hostname from internal URLs
1.91 amueller 205: my $hostname = &Apache::lonnet::hostname($host);
206: my %all_hostnames = &Apache::lonnet::all_hostnames();
207: foreach my $possible_host (keys(%all_hostnames)) {
1.90 amueller 208: if ($possible_host =~ /\Q$hostname\E/i) {
1.91 amueller 209: $url=$remainder;
210: }
211: }
212: }
1.9 www 213: # norm internal URLs
1.90 amueller 214: unless ($url=~/^https?\:/) {
1.91 amueller 215: $url=&Apache::lonnet::clutter($url);
1.90 amueller 216: }
1.9 www 217: # re-assemble field
1.90 amueller 218: if ($url) {
1.91 amueller 219: $field.=$url."\n";
1.90 amueller 220: }
1.91 amueller 221: }
1.90 amueller 222: $syllabus{$syl_field}=$field;
1.91 amueller 223: }
1.90 amueller 224: }
225: $syllabus{'uploaded.domain'}=$env{'user.domain'};
226: $syllabus{'uploaded.name'}=$env{'user.name'};
227: $syllabus{'uploaded.lastmodified'}=time;
228: &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
229: }
1.4 www 230: }
1.85 bisitz 231:
1.93 bisitz 232: #--------Functions
1.94 droeschl 233: if( ($allowed || $privileged) && $target ne 'tex') {
234: my $functions=&Apache::lonhtmlcommon::start_funclist();
235: if ($allowed) {
1.97 ! amueller 236: #if you have the register flag, keep it
! 237: if($env{'form.register'} == 1) {
! 238: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
! 239: '<a href="'.$r->uri.'?forcestudent=1®ister=1">'
! 240: .&mt('Show Public View').'</a>'
! 241: .&Apache::loncommon::help_open_topic(
! 242: 'Uploaded_Templates_PublicView'));
! 243: } else {
! 244: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
1.94 droeschl 245: '<a href="'.$r->uri.'?forcestudent=1">'
246: .&mt('Show Public View').'</a>'
247: .&Apache::loncommon::help_open_topic(
248: 'Uploaded_Templates_PublicView'));
1.97 ! amueller 249: }
1.93 bisitz 250: } elsif ($privileged) {
1.97 ! amueller 251: if($env{'form.register'} == 1) {
! 252: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
! 253: '<a href="'.$r->uri.'?forceedit=1®ister=1">'
! 254: .&mt('Edit').'</a>');
! 255: } else {
! 256: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
1.94 droeschl 257: '<a href="'.$r->uri.'?forceedit=1">'
258: .&mt('Edit').'</a>');
1.97 ! amueller 259: }
1.93 bisitz 260: }
1.94 droeschl 261:
1.93 bisitz 262: $functions.=&Apache::lonhtmlcommon::end_funclist();
263: $r->print(&Apache::loncommon::head_subbox($functions));
264: }
265:
1.94 droeschl 266: #---------------------Print External URL Syllabus Info and Help Text
1.90 amueller 267: if( ($allowed) && ($target ne 'tex') ) {
1.91 amueller 268: my $protocol = $Apache::lonnet::protocol{$homeserver};
269: $protocol = 'http' if ($protocol ne 'https');
1.85 bisitz 270: $r->print('<p class="LC_info">'
271: .&mt('This syllabus can be publicly viewed at [_1]'
272: ,'<tt>'.$protocol.'://'.&Apache::lonnet::hostname($homeserver).$r->uri.'</tt>')
273: .' '.&Apache::loncommon::help_open_topic('Syllabus_ExtLink')
274: .'</p>'
275: .'<p class="LC_info">'
1.96 raeburn 276: .&mt('Instead of using this template you can specify an external URL as Syllabus in the [_1]Course Configuration[_2].'
277: ,'<a href="/adm/courseprefs?actions=courseinfo&phase=display">','</a>')
1.85 bisitz 278: .'</p>'
279: );
1.94 droeschl 280: #-Print Help Text
281: $r->print(&Apache::loncommon::help_open_topic(
282: 'Uploaded_Templates_TextBoxes',
283: &mt('Help with filling in text boxes')));
1.90 amueller 284: }
1.85 bisitz 285:
1.88 amueller 286: #----------Print last update
1.90 amueller 287: my $lastmod=$syllabus{'uploaded.lastmodified'};
288: $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
289: my $who = &Apache::loncommon::aboutmewrapper(
290: &Apache::loncommon::plainname($syllabus{'uploaded.name'},
291: $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
292: $syllabus{'uploaded.domain'});
293: if ($target ne 'tex') {
1.91 amueller 294: $r->print('<div class="LC_info">'.&mt('Last updated').': '.
295: $lastmod . ' '.
296: ($who ? &mt('by').' '.$who
1.89 bisitz 297: : '' ) .
1.88 amueller 298: '</div>' );
1.89 bisitz 299:
1.90 amueller 300: } else {
1.91 amueller 301: $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.
302: ($who? &mt('by').'\\\\ '.
303: &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'})
304: :'')
305: .'\\\\');
1.90 amueller 306: }
1.80 neumanie 307: #----------------------------Print Headtitle
1.90 amueller 308: if ($target ne 'tex') {
1.91 amueller 309: $r->print('<h1>'.$courseenv{'description'}.'</h1>');
310: $r->print('<h3>'. &Apache::lonnet::domain($cdom,'description').'</h3>');
1.90 amueller 311: } else {
1.91 amueller 312: $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
313: &Apache::lonnet::domain($cdom,'description').'}\\\\');
1.90 amueller 314: }
1.80 neumanie 315: # -------------------------------------------------------- Get course personnel
316: my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
317: if ($target ne 'tex') {
1.91 amueller 318: $r->print(&Apache::lonhtmlcommon::start_pick_box());
1.80 neumanie 319: } else {
1.91 amueller 320: $r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline');
1.80 neumanie 321: }
322: my @personnel=sort(keys(%coursepersonnel));
323: my $lastpers=$personnel[$#personnel];
324: foreach my $element (@personnel) {
1.91 amueller 325: if ($target ne 'tex') {
326: $r->print(&Apache::lonhtmlcommon::row_title($element));
327: } else {
328: $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & ');
329: }
1.80 neumanie 330: foreach (split(/\,/,$coursepersonnel{$element})) {
1.91 amueller 331: my ($puname,$pudom)=split(/\:/,$_);
332: if ($target ne 'tex') {
1.80 neumanie 333: my $courseperson = &Apache::loncommon::plainname($puname,$pudom);
334: if (($env{'user.name'} eq '') || ($env{'user.name'} eq 'public') ||
335: ($env{'user.domain'} eq '') || ($env{'user.domain'} eq 'public')) {
1.91 amueller 336: $r->print(' '.$courseperson);
1.80 neumanie 337: } else {
338: $r->print(' '.&Apache::loncommon::aboutmewrapper($courseperson,
339: $puname,$pudom));
340: }
1.91 amueller 341: } else {
342: $r->print(' '.&Apache::loncommon::plainname($puname,
1.80 neumanie 343: $pudom).' ');
1.91 amueller 344: }
345: }
346: if ($target ne 'tex') {
1.80 neumanie 347: my $lastclose=$element eq $lastpers?1:0;
348: $r->print(&Apache::lonhtmlcommon::row_closure($lastclose));
1.91 amueller 349: } else {
350: $r->print('\\\\ \hline');
351: }
1.80 neumanie 352: }
353: if ($target ne 'tex') {
1.91 amueller 354: $r->print(&Apache::lonhtmlcommon::end_pick_box());
1.80 neumanie 355: } else {
1.91 amueller 356: $r->print('\end{tabular}\\\\');
1.80 neumanie 357: }
1.79 neumanie 358: # -------------------------------------------------------------- Announcements?
359: my $day = &Apache::lonannounce::showday(time,2,
1.91 amueller 360: &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
1.80 neumanie 361: if ($target ne 'tex') {
1.91 amueller 362: if ($allowed) {
1.92 bisitz 363: &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_Box');
1.91 amueller 364: $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
365: my $editurl= &Apache::lonnet::absolute_url().'/adm/'.$cdom.'/'.$cnum.'/_rss.html';
366: $r->print( '<a href="'.$editurl.'">'.&mt('New RSS Feed or Blog').'</a>');
367: &Apache::lontemplate::print_end_template($r);
368: } elsif (&Apache::lonrss::advertisefeeds($cnum,$cdom) ne '') {
1.92 bisitz 369: &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_Box');
1.91 amueller 370: $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
371: &Apache::lontemplate::print_end_template($r);
372: }
1.86 bisitz 373:
1.79 neumanie 374: } else {
1.91 amueller 375: $r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
1.86 bisitz 376: }
1.79 neumanie 377: # ---------------------------------------------------------------- Get syllabus
1.86 bisitz 378: if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
1.90 amueller 379: if ($allowed) {
1.95 bisitz 380: $r->print('<form method="post" action="">'.
1.91 amueller 381: '<input type="hidden" name="forceedit" value="edit" />');
1.90 amueller 382: }
383: my @htmlids=();
1.86 bisitz 384:
1.91 amueller 385: foreach my $field (sort(keys(%syllabusfields))) {
386: if (($syllabus{$field}=~/\w/) || ($allowed)) {
387: my $message=$syllabus{$field};
388: if ($field eq 'lll_includeurl') { # this is the "included" field
389: my $urls=$message;
390: $message='';
391: foreach my $filelink (split(/\n/,$urls)) {
392: my $output='';
393: # embed style?
394: my ($curfext)=($filelink=~/\.([^\.]+)$/);
395: my $embstyle=&Apache::loncommon::fileembstyle($curfext);
396: if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {# make ssi call and remove everything but the body contents
397: $output=&Apache::lonnet::ssi_body($filelink);
398: } elsif ($embstyle eq 'img') {# embed as an image
399: $output='<img src="'.$filelink.'" />';
400: }
401: if ($output ne '') {
402: if ($target ne 'tex') {
403: $message.='<p>'.$output.'</p>';
404: } else {
405: $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
406: }
407: }
408: }
409: if ($allowed) {
410: $r->print('<h3>'.$syllabusfields{$field}.
411: &Apache::loncommon::help_open_topic('Syllabus_URLs').'</h3>');
412: } else {
413: $r->print($message);
414: }
415: } else {
416: &Apache::lonfeedback::newline_to_br(\$message);
417: $message =~s|(https?\://[^\s]+)|<a href="$1"><tt>$1</tt></a>|g;
418: if ($allowed) {
419: $message=&Apache::lonspeller::markeduptext($message);
420: }
421: $message=&Apache::lontexconvert::msgtexconverted($message);
422: if ($target ne 'tex') {
1.92 bisitz 423: &Apache::lontemplate::print_template($r, $syllabusfields{$field}, $message,$allowed,'LC_Box');
1.91 amueller 424: } else {
425: $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
426: &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
427: }
428: push(@htmlids,$field);
429: }
430: if ($allowed) {
431: if ($target ne 'tex') {
432: &Apache::lontemplate::print_editbox_template($r, $syllabus{$field}, $field);
433: }
434: }
435: }
1.90 amueller 436: }
437: if ($allowed) {
1.91 amueller 438: $r->print('</form>'.
439: &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
1.90 amueller 440: }
1.79 neumanie 441: # if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
1.4 www 442: } else {
1.91 amueller 443: if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');}
444: $r->print(&mt('No syllabus information provided.'));
445: if ($target ne 'tex') {$r->print('</p>');}
1.1 www 446: }
1.86 bisitz 447: if ($target ne 'tex') {
1.65 raeburn 448: if ($env{'form.backto'} eq 'coursecatalog') {
449: $r->print('<form name="backtocat" method="post" action="/adm/coursecatalog">'.
1.66 raeburn 450: &Apache::lonhtmlcommon::echo_form_input(['backto','courseid']).
1.65 raeburn 451: '</form>');
452: }
1.91 amueller 453: $r->print(&Apache::loncommon::end_page());
1.48 albertel 454: } else {
1.91 amueller 455: $r->print('\end{document}');
1.48 albertel 456: }
1.1 www 457: return OK;
1.86 bisitz 458: }
1.1 www 459:
460: 1;
461: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonsyllabus.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface