File:
[LON-CAPA] /
loncom /
interface /
lonsyllabus.pm
Revision
1.93:
download - view:
text,
annotated -
select for diffs
Thu Jun 11 16:48:33 2009 UTC (15 years, 1 month ago) by
bisitz
Branches:
MAIN
CVS tags:
bz5969,
bz2851,
HEAD,
BZ5971-printing-apage
Functionslist:
- Moved sub routines from lontemplate.pm to lonhtmlcommon.pm to allow wider access
- Renamed sub routine names:
- start_functionslist -> start_funclist
- item_functionslist -> add_item_funclist
- end_functionslist -> end_funclist
- Added line breaks for HTML source code
- Added pod documentation to sub routines
- Adjusted sub routine calls
Changes related to modification of LON-CAPA screen header:
- Moved functionslists into new standard screen header "head_subbox"
Other changes:
- Got rid of special style for fieldset legend; adjusted texts
(lonmsgdisplay.pm, loncommon.pm, de.pm, zh.pm)
- Added warning/info style to warning/info message for weboutput
and corrected tex output for "No page information provided" message
(lonsimplepage.pm)
- Optimized floating for functions/actions
(lonmsgdisplay.pm)
1: # The LearningOnline Network
2: # Syllabus
3: #
4: # $Id: lonsyllabus.pm,v 1.93 2009/06/11 16:48:33 bisitz 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: }
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: if (($allowed) && ($env{'form.storesyl'})) {
186: foreach my $syl_field (keys(%syllabusfields)) {
187: my $field=$env{'form.'.$syl_field};
188: chomp($field);
189: $field=~s/\s+$//s;
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;
194: if ($syl_field eq 'lll_includeurl') { # clean up included URLs
195: my $field='';
196: foreach my $value (split(/\n/,$syllabus{$syl_field})) {
197: my $url=$value;
198: # get rid of leading and trailing spaces
199: $url=~s/^\s+//;
200: $url=~s/\s+$//;
201: if ($url=~m|^https?\://([^/]+)/(.+)$|) {
202: my $host = $1;
203: my $remainder=$2;
204: # remove the hostname from internal URLs
205: my $hostname = &Apache::lonnet::hostname($host);
206: my %all_hostnames = &Apache::lonnet::all_hostnames();
207: foreach my $possible_host (keys(%all_hostnames)) {
208: if ($possible_host =~ /\Q$hostname\E/i) {
209: $url=$remainder;
210: }
211: }
212: }
213: # norm internal URLs
214: unless ($url=~/^https?\:/) {
215: $url=&Apache::lonnet::clutter($url);
216: }
217: # re-assemble field
218: if ($url) {
219: $field.=$url."\n";
220: }
221: }
222: $syllabus{$syl_field}=$field;
223: }
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: }
230: }
231:
232: #--------Functions
233: if( $allowed || $privileged) {
234: my $functions=&Apache::lonhtmlcommon::start_funclist();
235: if ($allowed) {
236: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
237: '<a href="'.$r->uri.'?forcestudent=1">'
238: .&mt('Show Public View').'</a>'
239: .&Apache::loncommon::help_open_topic(
240: 'Uploaded_Templates_PublicView'));
241: } elsif ($privileged) {
242: $functions.=&Apache::lonhtmlcommon::add_item_funclist(
243: '<a href="'.$r->uri.'?forceedit=1">'
244: .&mt('Edit').'</a>');
245: }
246: $functions.=&Apache::lonhtmlcommon::end_funclist();
247: $r->print(&Apache::loncommon::head_subbox($functions));
248: }
249:
250: #---------------------Print External URL Syllabus Info
251: if( ($allowed) && ($target ne 'tex') ) {
252: my $protocol = $Apache::lonnet::protocol{$homeserver};
253: $protocol = 'http' if ($protocol ne 'https');
254: $r->print('<p class="LC_info">'
255: .&mt('This syllabus can be publicly viewed at [_1]'
256: ,'<tt>'.$protocol.'://'.&Apache::lonnet::hostname($homeserver).$r->uri.'</tt>')
257: .' '.&Apache::loncommon::help_open_topic('Syllabus_ExtLink')
258: .'</p>'
259: .'<p class="LC_info">'
260: .&mt('Instead of using this template you can specify an external URL as Syllabus in the [_1]Course Parameters[_2].'
261: ,'<a href="/adm/parmset?action=crsenv">','</a>')
262: .'</p>'
263: );
264: }
265:
266: #-Print Help Text
267: if ($target ne 'tex') {
268: if ($allowed) {
269: $r->print(&Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')));
270: }
271: }
272: #----------Print last update
273: my $lastmod=$syllabus{'uploaded.lastmodified'};
274: $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
275: my $who = &Apache::loncommon::aboutmewrapper(
276: &Apache::loncommon::plainname($syllabus{'uploaded.name'},
277: $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
278: $syllabus{'uploaded.domain'});
279: if ($target ne 'tex') {
280: $r->print('<div class="LC_info">'.&mt('Last updated').': '.
281: $lastmod . ' '.
282: ($who ? &mt('by').' '.$who
283: : '' ) .
284: '</div>' );
285:
286: } else {
287: $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.
288: ($who? &mt('by').'\\\\ '.
289: &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'})
290: :'')
291: .'\\\\');
292: }
293: #----------------------------Print Headtitle
294: if ($target ne 'tex') {
295: $r->print('<h1>'.$courseenv{'description'}.'</h1>');
296: $r->print('<h3>'. &Apache::lonnet::domain($cdom,'description').'</h3>');
297: } else {
298: $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
299: &Apache::lonnet::domain($cdom,'description').'}\\\\');
300: }
301: # -------------------------------------------------------- Get course personnel
302: my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
303: if ($target ne 'tex') {
304: $r->print(&Apache::lonhtmlcommon::start_pick_box());
305: } else {
306: $r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline');
307: }
308: my @personnel=sort(keys(%coursepersonnel));
309: my $lastpers=$personnel[$#personnel];
310: foreach my $element (@personnel) {
311: if ($target ne 'tex') {
312: $r->print(&Apache::lonhtmlcommon::row_title($element));
313: } else {
314: $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & ');
315: }
316: foreach (split(/\,/,$coursepersonnel{$element})) {
317: my ($puname,$pudom)=split(/\:/,$_);
318: if ($target ne 'tex') {
319: my $courseperson = &Apache::loncommon::plainname($puname,$pudom);
320: if (($env{'user.name'} eq '') || ($env{'user.name'} eq 'public') ||
321: ($env{'user.domain'} eq '') || ($env{'user.domain'} eq 'public')) {
322: $r->print(' '.$courseperson);
323: } else {
324: $r->print(' '.&Apache::loncommon::aboutmewrapper($courseperson,
325: $puname,$pudom));
326: }
327: } else {
328: $r->print(' '.&Apache::loncommon::plainname($puname,
329: $pudom).' ');
330: }
331: }
332: if ($target ne 'tex') {
333: my $lastclose=$element eq $lastpers?1:0;
334: $r->print(&Apache::lonhtmlcommon::row_closure($lastclose));
335: } else {
336: $r->print('\\\\ \hline');
337: }
338: }
339: if ($target ne 'tex') {
340: $r->print(&Apache::lonhtmlcommon::end_pick_box());
341: } else {
342: $r->print('\end{tabular}\\\\');
343: }
344: # -------------------------------------------------------------- Announcements?
345: my $day = &Apache::lonannounce::showday(time,2,
346: &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
347: if ($target ne 'tex') {
348: if ($allowed) {
349: &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_Box');
350: $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
351: my $editurl= &Apache::lonnet::absolute_url().'/adm/'.$cdom.'/'.$cnum.'/_rss.html';
352: $r->print( '<a href="'.$editurl.'">'.&mt('New RSS Feed or Blog').'</a>');
353: &Apache::lontemplate::print_end_template($r);
354: } elsif (&Apache::lonrss::advertisefeeds($cnum,$cdom) ne '') {
355: &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_Box');
356: $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
357: &Apache::lontemplate::print_end_template($r);
358: }
359:
360: } else {
361: $r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
362: }
363: # ---------------------------------------------------------------- Get syllabus
364: if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
365: if ($allowed) {
366: $r->print('<form method="post">'.
367: '<input type="hidden" name="forceedit" value="edit" />');
368: }
369: my @htmlids=();
370:
371: foreach my $field (sort(keys(%syllabusfields))) {
372: if (($syllabus{$field}=~/\w/) || ($allowed)) {
373: my $message=$syllabus{$field};
374: if ($field eq 'lll_includeurl') { # this is the "included" field
375: my $urls=$message;
376: $message='';
377: foreach my $filelink (split(/\n/,$urls)) {
378: my $output='';
379: # embed style?
380: my ($curfext)=($filelink=~/\.([^\.]+)$/);
381: my $embstyle=&Apache::loncommon::fileembstyle($curfext);
382: if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {# make ssi call and remove everything but the body contents
383: $output=&Apache::lonnet::ssi_body($filelink);
384: } elsif ($embstyle eq 'img') {# embed as an image
385: $output='<img src="'.$filelink.'" />';
386: }
387: if ($output ne '') {
388: if ($target ne 'tex') {
389: $message.='<p>'.$output.'</p>';
390: } else {
391: $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
392: }
393: }
394: }
395: if ($allowed) {
396: $r->print('<h3>'.$syllabusfields{$field}.
397: &Apache::loncommon::help_open_topic('Syllabus_URLs').'</h3>');
398: } else {
399: $r->print($message);
400: }
401: } else {
402: &Apache::lonfeedback::newline_to_br(\$message);
403: $message =~s|(https?\://[^\s]+)|<a href="$1"><tt>$1</tt></a>|g;
404: if ($allowed) {
405: $message=&Apache::lonspeller::markeduptext($message);
406: }
407: $message=&Apache::lontexconvert::msgtexconverted($message);
408: if ($target ne 'tex') {
409: if ($allowed) {
410: $r->print('<p>');
411: }
412: &Apache::lontemplate::print_template($r, $syllabusfields{$field}, $message,$allowed,'LC_Box');
413: } else {
414: $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
415: &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
416: }
417: push(@htmlids,$field);
418: }
419: if ($allowed) {
420: if ($target ne 'tex') {
421: $r->print('</p>');
422: &Apache::lontemplate::print_editbox_template($r, $syllabus{$field}, $field);
423: }
424: }
425: }
426: }
427: if ($allowed) {
428: $r->print('</form>'.
429: &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
430: }
431: # if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
432: } else {
433: if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');}
434: $r->print(&mt('No syllabus information provided.'));
435: if ($target ne 'tex') {$r->print('</p>');}
436: }
437: if ($target ne 'tex') {
438: if ($env{'form.backto'} eq 'coursecatalog') {
439: $r->print('<form name="backtocat" method="post" action="/adm/coursecatalog">'.
440: &Apache::lonhtmlcommon::echo_form_input(['backto','courseid']).
441: '</form>');
442: }
443: $r->print(&Apache::loncommon::end_page());
444: } else {
445: $r->print('\end{document}');
446: }
447: return OK;
448: }
449:
450: 1;
451: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>