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