Annotation of loncom/interface/lonsyllabus.pm, revision 1.89
1.1 www 1: # The LearningOnline Network
2: # Syllabus
3: #
1.89 ! bisitz 4: # $Id: lonsyllabus.pm,v 1.88 2009/04/28 14:43:06 amueller 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.86 bisitz 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.86 bisitz 77:
1.47 www 78: if ($env{'form.wrapperdisplay'} eq 'menu') {
1.50 albertel 79: $r->print(&Apache::lonwrapper::simple_menu());
1.86 bisitz 80: } else {
1.50 albertel 81: $r->print(&Apache::lonwrapper::wrapper("/public/$cdom/$cnum/syllabus?wrapperdisplay=menu",
82: $externalsyllabus));
83: }
84: return OK;
1.86 bisitz 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.86 bisitz 110:
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.86 bisitz 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());
1.86 bisitz 164: }
165:
1.17 www 166: }
167: # ---------------------------------------------------------- Load syllabus info
1.4 www 168: my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);
1.5 www 169: my $allowed=0;
1.27 www 170: my $privileged=0;
1.4 www 171:
1.2 www 172: # This handler might be called anonymously ...
173: # ----------------------------------------------------- Only if not public call
1.40 albertel 174: if ($env{'user.environment'}) {
1.1 www 175: # does this user have privileges to post, etc?
1.53 albertel 176: if ($env{'request.course.id'}
177: && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'}
178: && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) {
1.40 albertel 179: $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
1.27 www 180: $privileged=$allowed;
181: if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
182: $forcestudent='student';
183: }
1.30 sakharuk 184: if ($forcestudent or $target eq 'tex') { $allowed=0; }
1.86 bisitz 185: }
1.40 albertel 186: if (($allowed) && ($env{'form.storesyl'})) {
1.55 albertel 187: foreach my $syl_field (keys(%syllabusfields)) {
188: my $field=$env{'form.'.$syl_field};
1.33 www 189: chomp($field);
1.5 www 190: $field=~s/\s+$//s;
1.33 www 191: $field=~s/^\s+//s;
192: $field=~s/\<br\s*\/*\>$//s;
193: $field=&Apache::lonfeedback::clear_out_html($field,1);
1.55 albertel 194: $syllabus{$syl_field}=$field;
195: if ($syl_field eq 'lll_includeurl') { # clean up included URLs
1.9 www 196: my $field='';
1.55 albertel 197: foreach my $value (split(/\n/,$syllabus{$syl_field})) {
198: my $url=$value;
1.9 www 199: # get rid of leading and trailing spaces
200: $url=~s/^\s+//;
201: $url=~s/\s+$//;
1.75 raeburn 202: if ($url=~m|^https?\://([^/]+)/(.+)$|) {
1.55 albertel 203: my $host = $1;
1.9 www 204: my $remainder=$2;
205: # remove the hostname from internal URLs
1.57 albertel 206: my $hostname = &Apache::lonnet::hostname($host);
207: my %all_hostnames = &Apache::lonnet::all_hostnames();
208: foreach my $possible_host (keys(%all_hostnames)) {
209: if ($possible_host =~ /\Q$hostname\E/i) {
1.9 www 210: $url=$remainder;
211: }
212: }
213: }
214: # norm internal URLs
1.75 raeburn 215: unless ($url=~/^https?\:/) {
1.9 www 216: $url=&Apache::lonnet::clutter($url);
217: }
218: # re-assemble field
219: if ($url) {
220: $field.=$url."\n";
221: }
222: }
1.55 albertel 223: $syllabus{$syl_field}=$field;
1.9 www 224: }
1.5 www 225: }
1.40 albertel 226: $syllabus{'uploaded.domain'}=$env{'user.domain'};
227: $syllabus{'uploaded.name'}=$env{'user.name'};
1.5 www 228: $syllabus{'uploaded.lastmodified'}=time;
229: &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
230: }
1.4 www 231: }
1.85 bisitz 232:
233: #---------------------Print External URL Syllabus Info
234: if( ($allowed) && ($target ne 'tex') ) {
235: my $protocol = $Apache::lonnet::protocol{$homeserver};
236: $protocol = 'http' if ($protocol ne 'https');
237: $r->print('<p class="LC_info">'
238: .&mt('This syllabus can be publicly viewed at [_1]'
239: ,'<tt>'.$protocol.'://'.&Apache::lonnet::hostname($homeserver).$r->uri.'</tt>')
240: .' '.&Apache::loncommon::help_open_topic('Syllabus_ExtLink')
241: .'</p>'
242: .'<p class="LC_info">'
243: .&mt('Instead of using this template you can specify an external URL as Syllabus in the [_1]Course Parameters[_2].'
244: ,'<a href="/adm/parmset?action=crsenv">','</a>')
245: .'</p>'
246: );
247: }
248:
249: #-Print Help Text
1.81 neumanie 250: if ($target ne 'tex') {
1.89 ! bisitz 251: if ($allowed) {
1.81 neumanie 252: $r->print(&Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')));
253: }
254: }
1.88 amueller 255: #----------Print last update
256: my $lastmod=$syllabus{'uploaded.lastmodified'};
257: $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
258: my $who = &Apache::loncommon::aboutmewrapper(
259: &Apache::loncommon::plainname($syllabus{'uploaded.name'},
260: $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'},
261: $syllabus{'uploaded.domain'});
262: if ($target ne 'tex') {
263: $r->print('<div class="LC_info">'.&mt('Last updated').': '.
264: $lastmod . ' '.
265: ($who ? &mt('by').' '.$who
1.89 ! bisitz 266: : '' ) .
1.88 amueller 267: '</div>' );
1.89 ! bisitz 268:
1.88 amueller 269: } else {
270: $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.
271: ($who? &mt('by').'\\\\ '.
272: &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'})
273: :'')
274: .'\\\\');
275: }
1.80 neumanie 276: #--------Functions
277: if ($target ne 'tex') {
1.89 ! bisitz 278: if( $allowed || $privileged) {
1.84 bisitz 279: $r->print(&Apache::lontemplate::start_functionslist());
1.89 ! bisitz 280: if ($allowed) {
1.84 bisitz 281: $r->print(&Apache::lontemplate::item_functionslist(
282: '<a href="'.$r->uri.'?forcestudent=1">'.&mt('Show Public View').'</a>'
283: .&Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView')));
1.89 ! bisitz 284: } elsif ($privileged) {
1.84 bisitz 285: $r->print(&Apache::lontemplate::item_functionslist(
286: '<a href="'.$r->uri.'?forceedit=1">'.&mt('Edit').'</a>'));
1.80 neumanie 287: }
1.84 bisitz 288: $r->print(&Apache::lontemplate::end_functionslist());
1.80 neumanie 289: }
290: }
291: #----------------------------Print Headtitle
1.89 ! bisitz 292: if ($target ne 'tex') {
1.86 bisitz 293: $r->print('<h1>'.$courseenv{'description'}.'</h1>');
1.80 neumanie 294: $r->print('<h3>'. &Apache::lonnet::domain($cdom,'description').'</h3>');
1.89 ! bisitz 295: } else {
1.80 neumanie 296: $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'.
297: &Apache::lonnet::domain($cdom,'description').'}\\\\');
298: }
299: # -------------------------------------------------------- Get course personnel
300: my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
301: if ($target ne 'tex') {
302: $r->print(&Apache::lonhtmlcommon::start_pick_box());
303: } else {
304: $r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline');
305: }
306: my @personnel=sort(keys(%coursepersonnel));
307: my $lastpers=$personnel[$#personnel];
308: foreach my $element (@personnel) {
309: if ($target ne 'tex') {
310: $r->print(&Apache::lonhtmlcommon::row_title($element));
311: } else {
1.86 bisitz 312: $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & ');
1.80 neumanie 313: }
314: foreach (split(/\,/,$coursepersonnel{$element})) {
315: my ($puname,$pudom)=split(/\:/,$_);
316: if ($target ne 'tex') {
317: my $courseperson = &Apache::loncommon::plainname($puname,$pudom);
318: if (($env{'user.name'} eq '') || ($env{'user.name'} eq 'public') ||
319: ($env{'user.domain'} eq '') || ($env{'user.domain'} eq 'public')) {
320: $r->print(' '.$courseperson);
321: } else {
322: $r->print(' '.&Apache::loncommon::aboutmewrapper($courseperson,
323: $puname,$pudom));
324: }
325: } else {
326: $r->print(' '.&Apache::loncommon::plainname($puname,
327: $pudom).' ');
328: }
329: }
330: if ($target ne 'tex') {
331: my $lastclose=$element eq $lastpers?1:0;
332: $r->print(&Apache::lonhtmlcommon::row_closure($lastclose));
333: } else {
334: $r->print('\\\\ \hline');
335: }
336: }
337: if ($target ne 'tex') {
338: $r->print(&Apache::lonhtmlcommon::end_pick_box());
339: } else {
340: $r->print('\end{tabular}\\\\');
341: }
1.79 neumanie 342: # -------------------------------------------------------------- Announcements?
343: my $day = &Apache::lonannounce::showday(time,2,
344: &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
1.80 neumanie 345: if ($target ne 'tex') {
1.89 ! bisitz 346: if ($allowed) {
1.82 neumanie 347: &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_ContentBoxSpecial');
1.86 bisitz 348: $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
1.87 neumanie 349: my $editurl= &Apache::lonnet::absolute_url().'/adm/'.$cdom.'/'.$cnum.'/_rss.html';
350: $r->print( '<a href="'.$editurl.'">'.&mt('New RSS Feed or Blog').'</a>');
1.82 neumanie 351: &Apache::lontemplate::print_end_template($r);
1.89 ! bisitz 352: } elsif (&Apache::lonrss::advertisefeeds($cnum,$cdom) ne '') {
1.82 neumanie 353: &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_ContentBoxSpecial');
1.86 bisitz 354: $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
1.82 neumanie 355: &Apache::lontemplate::print_end_template($r);
1.80 neumanie 356: }
1.86 bisitz 357:
1.79 neumanie 358: } else {
359: $r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
1.86 bisitz 360: }
1.79 neumanie 361: # ---------------------------------------------------------------- Get syllabus
1.86 bisitz 362: if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
1.5 www 363: if ($allowed) {
1.27 www 364: $r->print('<form method="post">'.
365: '<input type="hidden" name="forceedit" value="edit" />');
1.5 www 366: }
1.33 www 367: my @htmlids=();
1.86 bisitz 368:
1.73 ehlerst 369: foreach my $field (sort(keys(%syllabusfields))) {
1.55 albertel 370: if (($syllabus{$field}=~/\w/) || ($allowed)) {
371: my $message=$syllabus{$field};
372: if ($field eq 'lll_includeurl') { # this is the "included" field
1.86 bisitz 373: my $urls=$message;
374: $message='';
375: foreach my $filelink (split(/\n/,$urls)) {
1.55 albertel 376: my $output='';
1.79 neumanie 377: # embed style?
1.86 bisitz 378: my ($curfext)=($filelink=~/\.([^\.]+)$/);
379: my $embstyle=&Apache::loncommon::fileembstyle($curfext);
1.79 neumanie 380: if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {# make ssi call and remove everything but the body contents
1.55 albertel 381: $output=&Apache::lonnet::ssi_body($filelink);
1.79 neumanie 382: } elsif ($embstyle eq 'img') {# embed as an image
1.55 albertel 383: $output='<img src="'.$filelink.'" />';
384: }
1.89 ! bisitz 385: if ($output ne '') {
1.86 bisitz 386: if ($target ne 'tex') {
1.79 neumanie 387: $message.='<p>'.$output.'</p>';
388: } else {
389: $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
390: }
1.86 bisitz 391: }
1.55 albertel 392: }
393: if ($allowed) {
394: $r->print('<h3>'.$syllabusfields{$field}.
1.73 ehlerst 395: &Apache::loncommon::help_open_topic('Syllabus_URLs').'</h3>');
1.55 albertel 396: } else {
397: $r->print($message);
1.86 bisitz 398: }
1.55 albertel 399: } else {
400: &Apache::lonfeedback::newline_to_br(\$message);
1.75 raeburn 401: $message =~s|(https?\://[^\s]+)|<a href="$1"><tt>$1</tt></a>|g;
1.55 albertel 402: if ($allowed) {
403: $message=&Apache::lonspeller::markeduptext($message);
404: }
405: $message=&Apache::lontexconvert::msgtexconverted($message);
1.73 ehlerst 406: if ($target ne 'tex') {
1.89 ! bisitz 407: if ($allowed) {
1.74 ehlerst 408: $r->print('<p>');
1.86 bisitz 409: }
1.76 neumanie 410: &Apache::lontemplate::print_template($r, $syllabusfields{$field}, $message,$allowed,'LC_ContentBoxSpecial');
1.55 albertel 411: } else {
412: $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
413: &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
414: }
415: push(@htmlids,$field);
416: }
417: if ($allowed) {
1.89 ! bisitz 418: if ($target ne 'tex') {
1.74 ehlerst 419: $r->print('</p>');
1.79 neumanie 420: &Apache::lontemplate::print_editbox_template($r, $syllabus{$field}, $field);
1.74 ehlerst 421: }
1.86 bisitz 422:
1.55 albertel 423: }
424: }
1.86 bisitz 425: }
426:
1.5 www 427: if ($allowed) {
1.32 www 428: $r->print('</form>'.
1.33 www 429: &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
1.5 www 430: }
1.79 neumanie 431: # if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
1.4 www 432: } else {
1.86 bisitz 433: if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');}
1.63 bisitz 434: $r->print(&mt('No syllabus information provided.'));
1.36 sakharuk 435: if ($target ne 'tex') {$r->print('</p>');}
1.1 www 436: }
1.86 bisitz 437: if ($target ne 'tex') {
1.65 raeburn 438: if ($env{'form.backto'} eq 'coursecatalog') {
439: $r->print('<form name="backtocat" method="post" action="/adm/coursecatalog">'.
1.66 raeburn 440: &Apache::lonhtmlcommon::echo_form_input(['backto','courseid']).
1.65 raeburn 441: '</form>');
442: }
1.48 albertel 443: $r->print(&Apache::loncommon::end_page());
444: } else {
445: $r->print('\end{document}');
446: }
1.1 www 447: return OK;
1.86 bisitz 448: }
1.1 www 449:
450: 1;
451: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonsyllabus.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface