File:
[LON-CAPA] /
loncom /
interface /
lonsyllabus.pm
Revision
1.69.4.2:
download - view:
text,
annotated -
select for diffs
Thu Jan 28 17:25:10 2010 UTC (14 years, 8 months ago) by
raeburn
Branches:
version_2_9_X
CVS tags:
version_2_9_1,
version_2_9_0,
version_2_8_99_1
Diff to branchpoint 1.69:
preferred,
unified
- Backport 1.85 (part), 1.96 (part), 1.99 (part), 1.100, 1.101, 1.103.
1: # The LearningOnline Network
2: # Syllabus
3: #
4: # $Id: lonsyllabus.pm,v 1.69.4.2 2010/01/28 17:25:10 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 $js;
114: if ($env{'form.backto'} eq 'coursecatalog') {
115: $js .= <<"ENDSCRIPT";
116:
117: <script type="text/javascript">
118: function ToCatalog(caller) {
119: numidx = getIndexByName('coursenum');
120: if (numidx > -1) {
121: if (caller != 'details') {
122: document.backtocat.elements[numidx].value = '';
123: }
124: }
125: document.backtocat.submit();
126: }
127:
128: function getIndexByName(item) {
129: for (var i=0;i<document.backtocat.elements.length;i++) {
130: if (document.backtocat.elements[i].name == item) {
131: return i;
132: }
133: }
134: return -1;
135: }
136:
137: </script>
138:
139: ENDSCRIPT
140: }
141: my $start_page =
142: &Apache::loncommon::start_page("Syllabus", $rss_link.$js,
143: {'function' => $forcestudent,
144: 'domain' => $cdom,
145: 'force_register' =>
146: $env{'form.register'},});
147:
148: $r->print($start_page);
149: if ($env{'form.backto'} eq 'coursecatalog') {
150: &Apache::lonhtmlcommon::clear_breadcrumbs();
151: &Apache::lonhtmlcommon::add_breadcrumb
152: ({href=>"javascript:ToCatalog()",
153: text=>"Course/Community Catalog"});
154: if ($env{'form.coursenum'} ne '') {
155: &Apache::lonhtmlcommon::add_breadcrumb
156: ({href=>"javascript:ToCatalog('details')",
157: text=>"Course details"});
158: }
159: &Apache::lonhtmlcommon::add_breadcrumb
160: ({href=>$r->uri,
161: text=>"Course syllabus"});
162: $r->print(&Apache::lonhtmlcommon::breadcrumbs());
163: }
164: $r->print('<h1>'.$courseenv{'description'}.'</h1><h3>'.
165: &Apache::lonnet::domain($cdom,'description').'</h3>');
166: } else {
167: $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
168: &Apache::lonnet::domain($cdom,'description').'}\\\\');
169: }
170: # -------------------------------------------------------------- Announcements?
171: my $day = &Apache::lonannounce::showday(time,2,
172: &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
173: if ($target ne 'tex') {
174: $r->print($day. &Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
175: } else {
176: $r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
177: }
178:
179: # -------------------------------------------------------- Get course personnel
180: my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
181: if ($target ne 'tex') {
182: $r->print(&Apache::lonhtmlcommon::start_pick_box());
183: } else {
184: $r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline');
185: }
186: my @personnel=sort(keys(%coursepersonnel));
187: my $lastpers=$personnel[$#personnel];
188: foreach my $element (@personnel) {
189: if ($target ne 'tex') {
190: $r->print(&Apache::lonhtmlcommon::row_title($element));
191: } else {
192: $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & ');
193: }
194: foreach (split(/\,/,$coursepersonnel{$element})) {
195: my ($puname,$pudom)=split(/\:/,$_);
196: if ($target ne 'tex') {
197: my $courseperson = &Apache::loncommon::plainname($puname,$pudom);
198: if (($env{'user.name'} eq '') || ($env{'user.name'} eq 'public') ||
199: ($env{'user.domain'} eq '') || ($env{'user.domain'} eq 'public')) {
200: $r->print(' '.$courseperson);
201: } else {
202: $r->print(' '.&Apache::loncommon::aboutmewrapper($courseperson,
203: $puname,$pudom));
204: }
205: } else {
206: $r->print(' '.&Apache::loncommon::plainname($puname,
207: $pudom).' ');
208: }
209: }
210: if ($target ne 'tex') {
211: my $lastclose=$element eq $lastpers?1:0;
212: $r->print(&Apache::lonhtmlcommon::row_closure($lastclose));
213: } else {
214: $r->print('\\\\ \hline');
215: }
216: }
217: if ($target ne 'tex') {
218: $r->print(&Apache::lonhtmlcommon::end_pick_box());
219: } else {
220: $r->print('\end{tabular}\\\\');
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>'.
245: &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')
246: .' <tt>'.$protocol.'://'.
247: &Apache::lonnet::hostname($homeserver).$r->uri.'</tt>'.
248: &Apache::loncommon::help_open_topic('Syllabus_ExtLink').'</p>'.
249: '<p class="LC_info">'.
250: &mt('Instead of using this template you can specify an external URL as Syllabus in the [_1]Course Configuration[_2].',
251: '<a href="/adm/courseprefs?actions=courseinfo&phase=display">','</a>').
252: '</p>'.
253: '<p><a href="'.$r->uri.'?forcestudent=1"><font size="+1">'.
254: &mt('Show Public View').'</font></a>'.
255: &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').
256: '</p>');
257: } elsif ($privileged) {
258: if ($target ne 'tex') {
259: $r->print('<p><a href="'.$r->uri.'?forceedit=1"><font size="+1">'.
260: &mt('Edit').'</font></a>');
261: }
262: }
263: if (($allowed) && ($env{'form.storesyl'})) {
264: foreach my $syl_field (keys(%syllabusfields)) {
265: my $field=$env{'form.'.$syl_field};
266: chomp($field);
267: $field=~s/\s+$//s;
268: $field=~s/^\s+//s;
269: $field=~s/\<br\s*\/*\>$//s;
270: $field=&Apache::lonfeedback::clear_out_html($field,1);
271: $syllabus{$syl_field}=$field;
272: if ($syl_field eq 'lll_includeurl') { # clean up included URLs
273: my $field='';
274: foreach my $value (split(/\n/,$syllabus{$syl_field})) {
275: my $url=$value;
276: # get rid of leading and trailing spaces
277: $url=~s/^\s+//;
278: $url=~s/\s+$//;
279: if ($url=~m|^https?\://([^/]+)/(.+)$|) {
280: my $host = $1;
281: my $remainder=$2;
282: # remove the hostname from internal URLs
283: my $hostname = &Apache::lonnet::hostname($host);
284: my %all_hostnames = &Apache::lonnet::all_hostnames();
285: foreach my $possible_host (keys(%all_hostnames)) {
286: if ($possible_host =~ /\Q$hostname\E/i) {
287: $url=$remainder;
288: }
289: }
290: }
291: # norm internal URLs
292: unless ($url=~/^https?\:/) {
293: $url=&Apache::lonnet::clutter($url);
294: }
295: # re-assemble field
296: if ($url) {
297: $field.=$url."\n";
298: }
299: }
300: $syllabus{$syl_field}=$field;
301: }
302: }
303: $syllabus{'uploaded.domain'}=$env{'user.domain'};
304: $syllabus{'uploaded.name'}=$env{'user.name'};
305: $syllabus{'uploaded.lastmodified'}=time;
306: &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
307: }
308: }
309: # ---------------------------------------------------------------- Get syllabus
310: if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
311: my $lastmod=$syllabus{'uploaded.lastmodified'};
312: $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
313: my $who = &Apache::loncommon::aboutmewrapper(
314: &Apache::loncommon::plainname($syllabus{'uploaded.name'},
315: $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
316: $syllabus{'uploaded.domain'});
317: if ($target ne 'tex') {
318: $r->print('<table><tr><td>'.&mt('Last updated').':</td><td>'.
319: $lastmod.'</td><td>'.
320: ($who ? &mt('by').' '.$who
321: : '' ).
322: '</td></tr></table><p>');
323: } else {
324: $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.
325: ($who? &mt('by').'\\\\ '.
326: &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'})
327: :'')
328: .'\\\\');
329: }
330: if ($allowed) {
331: $r->print('<form method="post">'.
332: '<input type="hidden" name="forceedit" value="edit" />');
333: }
334: my @htmlids=();
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: '<p><a href="'.$r->uri.'?forcestudent=1"><font size="+1">'.&mt('Show Public View').'</font></a>'.
363: &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').'</p>');
364: } else {
365: $r->print($message);
366: }
367: } else {
368: if (!&Apache::lonfeedback::contains_block_html($message)) {
369: &Apache::lonfeedback::newline_to_br(\$message);
370: }
371: $message=&Apache::lonhtmlcommon::raw_href_to_link($message);
372: if ($allowed) {
373: $message=&Apache::lonspeller::markeduptext($message);
374: }
375: $message=&Apache::lontexconvert::msgtexconverted($message);
376: if ($target ne 'tex') {
377: $r->print('<h3>'.$syllabusfields{$field}.'</h3><blockquote>'.
378: $message.'</blockquote>');
379: } else {
380: $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
381: &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
382: }
383: push(@htmlids,$field);
384: }
385: if ($allowed) {
386: $r->print('<br /><textarea cols="80" rows="12" name="'.$field.'" id="'.$field.'">'.
387: &HTML::Entities::encode($syllabus{$field},'"&<>').
388: '</textarea> <input type="submit" name="storesyl" value="'.&mt('Save').'" />');
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>