1: # The LearningOnline Network
2: # Syllabus
3: #
4: # $Id: lonsyllabus.pm,v 1.105 2010/01/28 17:22:34 raeburn 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' => undef,
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/Community 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: }
166: # ---------------------------------------------------------- Load syllabus info
167: my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);
168: my $allowed=0;
169: my $privileged=0;
170:
171: # This handler might be called anonymously ...
172: # ----------------------------------------------------- Only if not public call
173: if ($env{'user.environment'}) {
174: # does this user have privileges to post, etc?
175: if ($env{'request.course.id'}
176: && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'}
177: && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) {
178: $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
179: $privileged=$allowed;
180: if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
181: $forcestudent='student';
182: }
183: if ($forcestudent or $target eq 'tex') { $allowed=0; }
184: }
185: #store what the user typed in
186: if (($allowed) && ($env{'form.storesyl'})) {
187: foreach my $syl_field (keys(%syllabusfields)) {
188: my $field=$env{'form.'.$syl_field};
189: chomp($field);
190: $field=~s/\s+$//s;
191: $field=~s/^\s+//s;
192: $field=~s/\<br\s*\/*\>$//s;
193: $field=&Apache::lonfeedback::clear_out_html($field,1);
194: #here it will be stored
195: $syllabus{$syl_field}=$field;
196: if ($syl_field eq 'lll_includeurl') { # clean up included URLs
197: my $field='';
198: foreach my $value (split(/\n/,$syllabus{$syl_field})) {
199: my $url=$value;
200: # get rid of leading and trailing spaces
201: $url=~s/^\s+//;
202: $url=~s/\s+$//;
203: if ($url=~m|^https?\://([^/]+)/(.+)$|) {
204: my $host = $1;
205: my $remainder=$2;
206: # remove the hostname from internal URLs
207: my $hostname = &Apache::lonnet::hostname($host);
208: my %all_hostnames = &Apache::lonnet::all_hostnames();
209: foreach my $possible_host (keys(%all_hostnames)) {
210: if ($possible_host =~ /\Q$hostname\E/i) {
211: $url=$remainder;
212: }
213: }
214: }
215: # norm internal URLs
216: unless ($url=~/^https?\:/) {
217: $url=&Apache::lonnet::clutter($url);
218: }
219: # re-assemble field
220: if ($url) {
221: $field.=$url."\n";
222: }
223: }
224: $syllabus{$syl_field}=$field;
225: }
226: }
227: $syllabus{'uploaded.domain'}=$env{'user.domain'};
228: $syllabus{'uploaded.name'}=$env{'user.name'};
229: $syllabus{'uploaded.lastmodified'}=time;
230: &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
231: }
232: }
233:
234: #--------Functions
235: if( ($allowed || $privileged) && $target ne 'tex') {
236: my $functions=&Apache::lonhtmlcommon::start_funclist();
237: if ($allowed) {
238: #if you have the register flag, keep it
239: if($env{'form.register'} == 1) {
240: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
241: '<a href="'.$r->uri.'?forcestudent=1&register=1">'
242: .&mt('Show Public View').'</a>'
243: .&Apache::loncommon::help_open_topic(
244: 'Uploaded_Templates_PublicView'));
245: } else {
246: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
247: '<a href="'.$r->uri.'?forcestudent=1">'
248: .&mt('Show Public View').'</a>'
249: .&Apache::loncommon::help_open_topic(
250: 'Uploaded_Templates_PublicView'));
251: }
252: } elsif ($privileged) {
253: if($env{'form.register'} == 1) {
254: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
255: '<a href="'.$r->uri.'?forceedit=1&register=1">'
256: .&mt('Edit').'</a>');
257: } else {
258: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
259: '<a href="'.$r->uri.'?forceedit=1">'
260: .&mt('Edit').'</a>');
261: }
262: }
263:
264: $functions.=&Apache::lonhtmlcommon::end_funclist();
265: $r->print(&Apache::loncommon::head_subbox($functions));
266: }
267:
268: #---------------------Print External URL Syllabus Info and Help Text
269: if( ($allowed) && ($target ne 'tex') ) {
270: my $protocol = $Apache::lonnet::protocol{$homeserver};
271: $protocol = 'http' if ($protocol ne 'https');
272: $r->print('<p class="LC_info">'
273: .&mt('This syllabus can be publicly viewed at [_1]'
274: ,'<tt>'.$protocol.'://'.&Apache::lonnet::hostname($homeserver).$r->uri.'</tt>')
275: .' '.&Apache::loncommon::help_open_topic('Syllabus_ExtLink')
276: .'</p>'
277: .'<p class="LC_info">'
278: .&mt('Instead of using this template you can specify an external URL as Syllabus in the [_1]Course Configuration[_2].'
279: ,'<a href="/adm/courseprefs?actions=courseinfo&phase=display">','</a>')
280: .'</p>'
281: );
282: #-Print Help Text
283: $r->print(&Apache::loncommon::help_open_topic(
284: 'Uploaded_Templates_TextBoxes',
285: &mt('Help with filling in text boxes')));
286: }
287:
288: #----------Print last update
289: my $lastmod=$syllabus{'uploaded.lastmodified'};
290: $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
291: my $who = &Apache::loncommon::aboutmewrapper(
292: &Apache::loncommon::plainname($syllabus{'uploaded.name'},
293: $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
294: $syllabus{'uploaded.domain'});
295: if ($target ne 'tex') {
296: $r->print('<div class="LC_info">'.&mt('Last updated').': '.
297: $lastmod . ' '.
298: ($who ? &mt('by').' '.$who
299: : '' ) .
300: '</div>' );
301:
302: } else {
303: $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.
304: ($who? &mt('by').'\\\\ '.
305: &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'})
306: :'')
307: .'\\\\');
308: }
309: #----------------------------Print Headtitle
310: if ($target ne 'tex') {
311: $r->print('<h1>'.$courseenv{'description'}.'</h1>');
312: $r->print('<h3>'. &Apache::lonnet::domain($cdom,'description').'</h3>');
313: } else {
314: $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
315: &Apache::lonnet::domain($cdom,'description').'}\\\\');
316: }
317: # -------------------------------------------------------- Get course personnel
318: my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
319: if ($target ne 'tex') {
320: $r->print(&Apache::lonhtmlcommon::start_pick_box());
321: } else {
322: $r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline');
323: }
324: my @personnel=sort(keys(%coursepersonnel));
325: my $lastpers=$personnel[$#personnel];
326: foreach my $element (@personnel) {
327: if ($target ne 'tex') {
328: $r->print(&Apache::lonhtmlcommon::row_title($element));
329: } else {
330: $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & ');
331: }
332: foreach (split(/\,/,$coursepersonnel{$element})) {
333: my ($puname,$pudom)=split(/\:/,$_);
334: if ($target ne 'tex') {
335: my $courseperson = &Apache::loncommon::plainname($puname,$pudom);
336: if (($env{'user.name'} eq '') || ($env{'user.name'} eq 'public') ||
337: ($env{'user.domain'} eq '') || ($env{'user.domain'} eq 'public')) {
338: $r->print(' '.$courseperson);
339: } else {
340: $r->print(' '.&Apache::loncommon::aboutmewrapper($courseperson,
341: $puname,$pudom));
342: }
343: } else {
344: $r->print(' '.&Apache::loncommon::plainname($puname,
345: $pudom).' ');
346: }
347: }
348: if ($target ne 'tex') {
349: my $lastclose=$element eq $lastpers?1:0;
350: $r->print(&Apache::lonhtmlcommon::row_closure($lastclose));
351: } else {
352: $r->print('\\\\ \hline');
353: }
354: }
355: if ($target ne 'tex') {
356: $r->print(&Apache::lonhtmlcommon::end_pick_box());
357: } else {
358: $r->print('\end{tabular}\\\\');
359: }
360: # -------------------------------------------------------------- Announcements?
361: my $day = &Apache::lonannounce::showday(time,2,
362: &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
363: if ($target ne 'tex') {
364: if ($allowed) {
365: &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_Box');
366: $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
367: my $editurl= &Apache::lonnet::absolute_url().'/adm/'.$cdom.'/'.$cnum.'/_rss.html';
368: $r->print( '<a href="'.$editurl.'">'.&mt('New RSS Feed or Blog').'</a>');
369: &Apache::lontemplate::print_end_template($r);
370: } elsif (&Apache::lonrss::advertisefeeds($cnum,$cdom) ne '') {
371: &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_Box');
372: $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
373: &Apache::lontemplate::print_end_template($r);
374: }
375:
376: } else {
377: $r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
378: }
379: # ---------------------------------------------------------------- Get syllabus
380: if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
381: if ($allowed) {
382: $r->print('<form method="post" action="">'.
383: '<input type="hidden" name="forceedit" value="edit" />');
384: }
385: my @htmlids=();
386:
387: foreach my $field (sort(keys(%syllabusfields))) {
388: if (($syllabus{$field}=~/\w/) || ($allowed)) {
389: my $message=$syllabus{$field};
390: if ($field eq 'lll_includeurl') { # this is the "included" field
391: my $urls=$message;
392: $message='';
393: foreach my $filelink (split(/\n/,$urls)) {
394: my $output='';
395: # embed style?
396: my ($curfext)=($filelink=~/\.([^\.]+)$/);
397: my $embstyle=&Apache::loncommon::fileembstyle($curfext);
398: if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {# make ssi call and remove everything but the body contents
399: $output=&Apache::lonnet::ssi_body($filelink);
400: } elsif ($embstyle eq 'img') {# embed as an image
401: $output='<img src="'.$filelink.'" />';
402: }
403: if ($output ne '') {
404: if ($target ne 'tex') {
405: $message.='<p>'.$output.'</p>';
406: } else {
407: $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
408: }
409: }
410: }
411: if ($allowed) {
412: &Apache::lonfeedback::newline_to_br(\$urls);
413: &Apache::lontemplate::print_start_template($r,$syllabusfields{$field}.
414: &Apache::loncommon::help_open_topic('Syllabus_URLs'),'LC_Box');
415: $r->print($urls);
416: $r->print("<br /><div>");
417: &Apache::lontemplate::print_textarea_template($r, $syllabus{$field},
418: $field, Apache::lontemplate->RICH_TEXT_ALWAYS_OFF);
419: &Apache::lontemplate::print_saveall_template($r);
420: $r->print("</div>");
421: &Apache::lontemplate::print_end_template($r);
422:
423: } else {
424: $r->print($message);
425: }
426: } else {
427: if (!&Apache::lonfeedback::contains_block_html($message)) {
428: &Apache::lonfeedback::newline_to_br(\$message);
429: } else {
430: $message = &Apache::lonfeedback::tidy_html($message);
431: }
432: $message=&Apache::lonhtmlcommon::raw_href_to_link($message);
433:
434: if ($allowed) {
435: $message=&Apache::lonspeller::markeduptext($message);
436: }
437: $message=&Apache::lontexconvert::msgtexconverted($message);
438: if ($target ne 'tex') {
439: #output of syllabusfields will be generated here.
440: &Apache::lontemplate::print_start_template($r,$syllabusfields{$field},'LC_Box');
441: $r->print($message);
442: if ($allowed) {
443: $r->print("<br /><div>");
444: &Apache::lontemplate::print_textarea_template($r, $syllabus{$field},
445: $field, Apache::lontemplate->RICH_TEXT_DETECT_HTML);
446: &Apache::lontemplate::print_saveall_template($r);
447: $r->print("</div>");
448: }
449: &Apache::lontemplate::print_end_template($r);
450: } else {
451: $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
452: &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
453: }
454: push(@htmlids,$field);
455: }
456: }
457: }
458: if ($allowed) {
459: $r->print('</form>'.
460: &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
461: }
462: # if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
463: } else {
464: if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');}
465: $r->print(&mt('No syllabus information provided.'));
466: if ($target ne 'tex') {$r->print('</p>');}
467: }
468: if ($target ne 'tex') {
469: if ($env{'form.backto'} eq 'coursecatalog') {
470: $r->print('<form name="backtocat" method="post" action="/adm/coursecatalog">'.
471: &Apache::lonhtmlcommon::echo_form_input(['backto','courseid']).
472: '</form>');
473: }
474: $r->print(&Apache::loncommon::end_page());
475: } else {
476: $r->print('\end{document}');
477: }
478: return OK;
479: }
480:
481: 1;
482: __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