Annotation of loncom/interface/lonsyllabus.pm, revision 1.67
1.1 www 1: # The LearningOnline Network
2: # Syllabus
3: #
1.67 ! raeburn 4: # $Id: lonsyllabus.pm,v 1.66 2008/07/17 12:01:46 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;
32: use Apache::Constants qw(:common);
33: use Apache::loncommon;
34: use Apache::lonnet;
1.5 www 35: use Apache::lontexconvert;
1.11 www 36: use Apache::lonfeedback;
1.19 www 37: use Apache::lonannounce;
1.23 www 38: use Apache::lonlocal;
1.32 www 39: use Apache::lonhtmlcommon;
1.38 www 40: use Apache::lonspeller();
1.54 albertel 41: use HTML::Entities();
1.1 www 42:
43: sub handler {
44: my $r = shift;
1.46 www 45: &Apache::loncommon::content_type($r,'text/html');
46: $r->send_http_header;
47: return OK if $r->header_only;
1.45 www 48:
1.46 www 49: my $target=$env{'form.grade_target'};
1.45 www 50: # --------------------------------------------------- Get course info from URL
51: my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri);
1.46 www 52: # ------------------------------------------------------------ Get query string
53: &Apache::loncommon::get_unprocessed_cgi
1.47 www 54: ($ENV{'QUERY_STRING'},['forcestudent','register','forceedit','wrapperdisplay']);
1.45 www 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;
1.49 albertel 60: &Apache::loncommon::simple_error_page($r,'No syllabus available',
61: 'No syllabus available');
1.45 www 62: return OK;
63: }
64: # ------------------------------------- There is such a course, get environment
65: my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum);
1.46 www 66:
1.1 www 67: # ------------------------------------------------------------ Print the screen
1.49 albertel 68:
69: if ($target eq 'tex') {
1.40 albertel 70: $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
1.28 sakharuk 71: }
1.46 www 72: # -------------------------------------------------- Let's see who handles this
1.47 www 73: my $externalsyllabus=$courseenv{'externalsyllabus'};
1.49 albertel 74:
1.46 www 75: if ($externalsyllabus=~/\w/) {
1.50 albertel 76:
1.47 www 77: if ($env{'form.wrapperdisplay'} eq 'menu') {
1.50 albertel 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;
1.47 www 84: }
1.42 www 85:
1.46 www 86: # ------------------------------ The buck stops here: internal syllabus display
1.5 www 87: # --------------------------------------------------------- The syllabus fields
1.23 www 88: my %syllabusfields=&Apache::lonlocal::texthash(
1.5 www 89: 'aaa_instructorinfo' => 'Instructor Information',
90: 'bbb_description' => 'Course Description',
91: 'ccc_prereq' => 'Prerequisites',
1.7 www 92: 'cdc_classhours' => 'Class Hours',
1.5 www 93: 'ddd_officehours' => 'Office Hours',
94: 'eee_helproom' => 'Helproom Hours',
1.7 www 95: 'efe_projectinfo' => 'Project Information',
1.5 www 96: 'fff_examinfo' => 'Exam Information',
1.7 www 97: 'fgf_deadlines' => 'Deadlines',
1.5 www 98: 'ggg_grading' => 'Grading Information',
1.7 www 99: 'hhh_readings' => 'Readings',
100: 'iii_coursepack' => 'Coursepack',
101: 'jjj_weblinks' => 'Web Links',
1.9 www 102: 'kkk_textbook' => 'Textbook',
103: 'lll_includeurl' => 'URLs To Include in Syllabus');
1.6 www 104: # --------------------------------------------------------------- Force Student
105: my $forcestudent='';
1.40 albertel 106: if ($env{'form.forcestudent'}) { $forcestudent='student'; };
1.27 www 107: my $forceedit='';
1.40 albertel 108: if ($env{'form.forceedit'}) { $forceedit='edit'; }
1.5 www 109:
1.45 www 110: # ----------------------------------------------------------------- Make header
1.28 sakharuk 111: if ($target ne 'tex') {
1.60 albertel 112: my $rss_link = &Apache::lonrss::rss_link($cnum,$cdom);
1.65 raeburn 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: }
1.49 albertel 141: my $start_page =
1.65 raeburn 142: &Apache::loncommon::start_page("Syllabus", $rss_link.$js,
1.49 albertel 143: {'function' => $forcestudent,
144: 'domain' => $cdom,
145: 'force_register' =>
146: $env{'form.register'},});
147:
1.65 raeburn 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 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>'.
1.58 albertel 165: &Apache::lonnet::domain($cdom,'description').'</h3>');
1.28 sakharuk 166: } else {
1.29 sakharuk 167: $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
1.58 albertel 168: &Apache::lonnet::domain($cdom,'description').'}\\\\');
1.28 sakharuk 169: }
1.19 www 170: # -------------------------------------------------------------- Announcements?
1.49 albertel 171: my $day = &Apache::lonannounce::showday(time,2,
172: &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
1.35 sakharuk 173: if ($target ne 'tex') {
1.52 www 174: $r->print($day. &Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
1.35 sakharuk 175: } else {
1.49 albertel 176: $r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
1.35 sakharuk 177: }
1.49 albertel 178:
1.17 www 179: # -------------------------------------------------------- Get course personnel
180: my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
1.28 sakharuk 181: if ($target ne 'tex') {
1.62 albertel 182: $r->print(&Apache::loncommon::start_data_table());
1.28 sakharuk 183: } else {
1.37 sakharuk 184: $r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline');
1.28 sakharuk 185: }
1.36 sakharuk 186: foreach my $element (sort keys %coursepersonnel) {
1.28 sakharuk 187: if ($target ne 'tex') {
1.62 albertel 188: $r->print(&Apache::loncommon::start_data_table_row().
189: '<td>'.$element.'</td><td>');
1.28 sakharuk 190: } else {
1.36 sakharuk 191: $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & ');
1.28 sakharuk 192: }
1.36 sakharuk 193: foreach (split(/\,/,$coursepersonnel{$element})) {
1.17 www 194: my ($puname,$pudom)=split(/\:/,$_);
1.28 sakharuk 195: if ($target ne 'tex') {
1.64 raeburn 196: my $courseperson = &Apache::loncommon::plainname($puname,$pudom);
197: if (($env{'user.name'} eq '') || ($env{'user.name'} eq 'public') ||
198: ($env{'user.domain'} eq '') || ($env{'user.domain'} eq 'public')) {
199: $r->print(' '.$courseperson);
200: } else {
1.67 ! raeburn 201: $r->print(' '.&Apache::loncommon::aboutmewrapper($courseperson,
! 202: $puname,$pudom));
1.64 raeburn 203: }
1.28 sakharuk 204: } else {
205: $r->print(' '.&Apache::loncommon::plainname($puname,
206: $pudom).' ');
207: }
1.17 www 208: }
1.28 sakharuk 209: if ($target ne 'tex') {
1.62 albertel 210: $r->print('</td>'.&Apache::loncommon::end_data_table_row());
1.28 sakharuk 211: } else {
212: $r->print('\\\\ \hline');
213: }
214: }
215: if ($target ne 'tex') {
1.62 albertel 216: $r->print(&Apache::loncommon::end_data_table());
1.28 sakharuk 217: } else {
218: $r->print('\end{tabular}\\\\');
1.17 www 219: }
220: # ---------------------------------------------------------- Load syllabus info
1.4 www 221: my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);
1.5 www 222: my $allowed=0;
1.27 www 223: my $privileged=0;
1.4 www 224:
1.2 www 225: # This handler might be called anonymously ...
226: # ----------------------------------------------------- Only if not public call
1.40 albertel 227: if ($env{'user.environment'}) {
1.1 www 228: # does this user have privileges to post, etc?
1.53 albertel 229: if ($env{'request.course.id'}
230: && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'}
231: && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) {
1.40 albertel 232: $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
1.27 www 233: $privileged=$allowed;
234: if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
235: $forcestudent='student';
236: }
1.30 sakharuk 237: if ($forcestudent or $target eq 'tex') { $allowed=0; }
1.2 www 238: }
1.6 www 239: if ($allowed) {
1.12 www 240: $r->print('<p>'.
1.63 bisitz 241: &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')
1.23 www 242: .' <tt>http://'.
1.57 albertel 243: &Apache::lonnet::hostname($homeserver).$r->uri.'</tt>'.
1.10 www 244: &Apache::loncommon::help_open_topic('Syllabus_ExtLink').'</p>'.
1.47 www 245: '<p>'.&mt('You can specify an external URL as Syllabus in the [_1].','<a href="/adm/parmset?action=crsenv">'.&mt('Course Parameters').'</a>').'</p>'.
1.27 www 246: '<p><a href="'.$r->uri.'?forcestudent=1"><font size="+1">'.
247: &mt('Show Public View').'</font></a>'.
1.10 www 248: &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').
249: '</p>');
1.27 www 250: } elsif ($privileged) {
1.28 sakharuk 251: if ($target ne 'tex') {
252: $r->print('<p><a href="'.$r->uri.'?forceedit=1"><font size="+1">'.
253: &mt('Edit').'</font></a>');
254: }
1.6 www 255: }
1.40 albertel 256: if (($allowed) && ($env{'form.storesyl'})) {
1.55 albertel 257: foreach my $syl_field (keys(%syllabusfields)) {
258: my $field=$env{'form.'.$syl_field};
1.33 www 259: chomp($field);
1.5 www 260: $field=~s/\s+$//s;
1.33 www 261: $field=~s/^\s+//s;
262: $field=~s/\<br\s*\/*\>$//s;
263: $field=&Apache::lonfeedback::clear_out_html($field,1);
1.55 albertel 264: $syllabus{$syl_field}=$field;
265: if ($syl_field eq 'lll_includeurl') { # clean up included URLs
1.9 www 266: my $field='';
1.55 albertel 267: foreach my $value (split(/\n/,$syllabus{$syl_field})) {
268: my $url=$value;
1.9 www 269: # get rid of leading and trailing spaces
270: $url=~s/^\s+//;
271: $url=~s/\s+$//;
1.55 albertel 272: if ($url=~m|^http://([^/]+)/(.+)$|) {
273: my $host = $1;
1.9 www 274: my $remainder=$2;
275: # remove the hostname from internal URLs
1.57 albertel 276: my $hostname = &Apache::lonnet::hostname($host);
277: my %all_hostnames = &Apache::lonnet::all_hostnames();
278: foreach my $possible_host (keys(%all_hostnames)) {
279: if ($possible_host =~ /\Q$hostname\E/i) {
1.9 www 280: $url=$remainder;
281: }
282: }
283: }
284: # norm internal URLs
285: unless ($url=~/^http\:/) {
286: $url=&Apache::lonnet::clutter($url);
287: }
288: # re-assemble field
289: if ($url) {
290: $field.=$url."\n";
291: }
292: }
1.55 albertel 293: $syllabus{$syl_field}=$field;
1.9 www 294: }
1.5 www 295: }
1.40 albertel 296: $syllabus{'uploaded.domain'}=$env{'user.domain'};
297: $syllabus{'uploaded.name'}=$env{'user.name'};
1.5 www 298: $syllabus{'uploaded.lastmodified'}=time;
299: &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
300: }
1.4 www 301: }
302: # ---------------------------------------------------------------- Get syllabus
1.5 www 303: if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
1.8 www 304: my $lastmod=$syllabus{'uploaded.lastmodified'};
1.25 www 305: $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
1.26 albertel 306: my $who = &Apache::loncommon::aboutmewrapper(
307: &Apache::loncommon::plainname($syllabus{'uploaded.name'},
1.7 www 308: $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
1.26 albertel 309: $syllabus{'uploaded.domain'});
1.28 sakharuk 310: if ($target ne 'tex') {
311: $r->print('<table><tr><td>'.&mt('Last updated').':</td><td>'.
1.61 albertel 312: $lastmod.'</td><td>'.
313: ($who ? &mt('by').' '.$who
314: : '' ).
1.28 sakharuk 315: '</td></tr></table><p>');
316: } else {
1.61 albertel 317: $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.
318: ($who? &mt('by').'\\\\ '.
319: &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'})
320: :'')
321: .'\\\\');
1.28 sakharuk 322: }
1.5 www 323: if ($allowed) {
1.27 www 324: $r->print('<form method="post">'.
325: '<input type="hidden" name="forceedit" value="edit" />');
1.5 www 326: }
1.33 www 327: my @htmlids=();
1.55 albertel 328: foreach my $field (sort(keys(%syllabusfields))) {
329: if (($syllabus{$field}=~/\w/) || ($allowed)) {
330: my $message=$syllabus{$field};
331: if ($field eq 'lll_includeurl') { # this is the "included" field
332: my $urls=$message;
333: $message='';
334: foreach my $filelink (split(/\n/,$urls)) {
335: my $output='';
1.9 www 336: # embed style?
1.55 albertel 337: my ($curfext)=($filelink=~/\.([^\.]+)$/);
338: my $embstyle=&Apache::loncommon::fileembstyle($curfext);
339: if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {
1.9 www 340: # make ssi call and remove everything but the body contents
1.55 albertel 341: $output=&Apache::lonnet::ssi_body($filelink);
342: } elsif ($embstyle eq 'img') {
1.9 www 343: # embed as an image
1.55 albertel 344: $output='<img src="'.$filelink.'" />';
345: }
346: if ($target ne 'tex') {
347: $message.='<p>'.$output.'</p>';
348: } else {
349: $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
350: }
351: }
352: if ($allowed) {
353: $r->print('<h3>'.$syllabusfields{$field}.
354: &Apache::loncommon::help_open_topic('Syllabus_URLs').'</h3>'.
355: '<p><a href="'.$r->uri.'?forcestudent=1"><font size="+1">'.&mt('Show Public View').'</font></a>'.
356: &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').'</p>');
357: } else {
358: $r->print($message);
359: }
360: } else {
361: &Apache::lonfeedback::newline_to_br(\$message);
1.56 banghart 362: $message =~s|(https*://[^\s]+)|<a href="$1"><tt>$1</tt></a>|g;
1.55 albertel 363: if ($allowed) {
364: $message=&Apache::lonspeller::markeduptext($message);
365: }
366: $message=&Apache::lontexconvert::msgtexconverted($message);
367: if ($target ne 'tex') {
368: $r->print('<h3>'.$syllabusfields{$field}.'</h3><blockquote>'.
369: $message.'</blockquote>');
370: } else {
371: $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
372: &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
373: }
374: push(@htmlids,$field);
375: }
376: if ($allowed) {
377: $r->print('<br /><textarea cols="80" rows="12" name="'.$field.'" id="'.$field.'">'.
378: &HTML::Entities::encode($syllabus{$field},'"&<>').
1.63 bisitz 379: '</textarea> <input type="submit" name="storesyl" value="'.&mt('Save').'" />');
1.55 albertel 380: }
381: }
1.5 www 382: }
383: if ($allowed) {
1.32 www 384: $r->print('</form>'.
1.33 www 385: &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
1.5 www 386: }
1.28 sakharuk 387: if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
1.4 www 388: } else {
1.36 sakharuk 389: if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');}
1.63 bisitz 390: $r->print(&mt('No syllabus information provided.'));
1.36 sakharuk 391: if ($target ne 'tex') {$r->print('</p>');}
1.1 www 392: }
1.48 albertel 393: if ($target ne 'tex') {
1.65 raeburn 394: if ($env{'form.backto'} eq 'coursecatalog') {
395: $r->print('<form name="backtocat" method="post" action="/adm/coursecatalog">'.
1.66 raeburn 396: &Apache::lonhtmlcommon::echo_form_input(['backto','courseid']).
1.65 raeburn 397: '</form>');
398: }
1.48 albertel 399: $r->print(&Apache::loncommon::end_page());
400: } else {
401: $r->print('\end{document}');
402: }
1.1 www 403: return OK;
404: }
405:
406: 1;
407: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>