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