Return to lonsyllabus.pm CVS log

Up to [LON-CAPA] / loncom / interface

Replaced tabsymbol with 4 whitespaces to avoid conflicts with editors where tabwidth i.e. is expanded to 8 whitespaces.

Use cvs diff -w to check, that between this revision (1.91) and the revision before (1.90) there is no
difference except the whitespaces.

    1: # The LearningOnline Network
    2: # Syllabus
    3: #
    4: # $Id: lonsyllabus.pm,v 1.91 2009/05/19 10:07:54 amueller 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::lontemplate;
   33: use Apache::Constants qw(:common);
   34: use Apache::loncommon;
   35: use Apache::lonnet;
   36: use Apache::lontexconvert;
   37: use Apache::lonfeedback;
   38: use Apache::lonannounce;
   39: use Apache::lonlocal;
   40: use Apache::lonhtmlcommon;
   41: use Apache::lonspeller();
   42: use HTML::Entities();
   43: 
   44: sub handler {
   45:     my $r = shift;
   46:     &Apache::loncommon::content_type($r,'text/html');
   47:     $r->send_http_header;
   48:     return OK if $r->header_only;
   49: 
   50:     my $target=$env{'form.grade_target'};
   51: # --------------------------------------------------- Get course info from URL
   52:     my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri);
   53: # ------------------------------------------------------------ Get query string
   54:     &Apache::loncommon::get_unprocessed_cgi
   55:                         ($ENV{'QUERY_STRING'},['forcestudent','register','forceedit','wrapperdisplay']);
   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;
   61:           &Apache::loncommon::simple_error_page($r,'No syllabus available',
   62:                           'No syllabus available');
   63:         return OK;
   64:     }
   65: # ------------------------------------- There is such a course, get environment
   66:     my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum);
   67: 
   68: # ------------------------------------------------------------ Print the screen
   69: 
   70:     if ($target eq 'tex') {
   71:         $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
   72:     }
   73: # -------------------------------------------------- Let's see who handles this
   74:     my $externalsyllabus=$courseenv{'externalsyllabus'};
   75: 
   76:     if ($externalsyllabus=~/\w/) {
   77: 
   78:        if ($env{'form.wrapperdisplay'} eq 'menu') {
   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;
   85:     }
   86: 
   87: # ------------------------------ The buck stops here: internal syllabus display
   88: # --------------------------------------------------------- The syllabus fields
   89:     my %syllabusfields=&Apache::lonlocal::texthash(
   90:        'aaa_instructorinfo' => 'Instructor Information',
   91:        'bbb_description'    => 'Course Description',
   92:        'ccc_prereq'         => 'Prerequisites',
   93:        'cdc_classhours'     => 'Class Hours',
   94:        'ddd_officehours'    => 'Office Hours',
   95:        'eee_helproom'       => 'Helproom Hours',
   96:        'efe_projectinfo'    => 'Project Information',
   97:        'fff_examinfo'       => 'Exam Information',
   98:        'fgf_deadlines'      => 'Deadlines',
   99:        'ggg_grading'        => 'Grading Information',
  100:        'hhh_readings'       => 'Readings',
  101:        'iii_coursepack'     => 'Coursepack',
  102:        'jjj_weblinks'       => 'Web Links',
  103:        'kkk_textbook'       => 'Textbook',
  104:        'lll_includeurl'     => 'URLs To Include in Syllabus');
  105: # --------------------------------------------------------------- Force Student
  106:     my $forcestudent='';
  107:     if ($env{'form.forcestudent'}) { $forcestudent='student'; };
  108:     my $forceedit='';
  109:     if ($env{'form.forceedit'}) { $forceedit='edit'; }
  110: 
  111: # ----------------------------------------------------------------- Make header
  112:     if ($target ne 'tex') {
  113:         my $rss_link = &Apache::lonrss::rss_link($cnum,$cdom);
  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:         }
  142:         my $start_page =
  143:          &Apache::loncommon::start_page("Syllabus", $rss_link.$js,
  144:                        {'function'       => $forcestudent,
  145:                         'domain'         => $cdom,
  146:                         'force_register' =>
  147:                         $env{'form.register'},});
  148: 
  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:         }
  165: 
  166:     }
  167: # ---------------------------------------------------------- Load syllabus info
  168:     my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum);
  169:     my $allowed=0;
  170:     my $privileged=0;
  171: 
  172: # This handler might be called anonymously ...
  173: # ----------------------------------------------------- Only if not public call
  174:     if ($env{'user.environment'}) {
  175: # does this user have privileges to post, etc?
  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'}) {
  179:             $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'});
  180:             $privileged=$allowed;
  181:             if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) {
  182:                 $forcestudent='student';
  183:             }
  184:             if ($forcestudent or $target eq 'tex') { $allowed=0; }
  185:         }
  186:         if (($allowed) && ($env{'form.storesyl'})) {
  187:             foreach my $syl_field (keys(%syllabusfields)) {
  188:                 my $field=$env{'form.'.$syl_field};
  189:                 chomp($field);
  190:                 $field=~s/\s+$//s;
  191:                 $field=~s/^\s+//s;
  192:                 $field=~s/\<br\s*\/*\>$//s;
  193:                 $field=&Apache::lonfeedback::clear_out_html($field,1);
  194:                 $syllabus{$syl_field}=$field;
  195:                 if ($syl_field eq 'lll_includeurl') { # clean up included URLs
  196:                     my $field='';
  197:                     foreach my $value (split(/\n/,$syllabus{$syl_field})) {
  198:                         my $url=$value;
  199: # get rid of leading and trailing spaces
  200:                         $url=~s/^\s+//;
  201:                         $url=~s/\s+$//;
  202:                         if ($url=~m|^https?\://([^/]+)/(.+)$|) {
  203:                             my $host = $1;
  204:                             my $remainder=$2;
  205: # remove the hostname from internal URLs
  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) {
  210:                                     $url=$remainder;
  211:                                 }
  212:                             }
  213:                         }
  214: # norm internal URLs
  215:                         unless ($url=~/^https?\:/) {
  216:                             $url=&Apache::lonnet::clutter($url);
  217:                         }
  218: # re-assemble field
  219:                         if ($url) {
  220:                             $field.=$url."\n";
  221:                         }
  222:                     }
  223:                     $syllabus{$syl_field}=$field;
  224:                 }
  225:             }
  226:             $syllabus{'uploaded.domain'}=$env{'user.domain'};
  227:             $syllabus{'uploaded.name'}=$env{'user.name'};
  228:             $syllabus{'uploaded.lastmodified'}=time;
  229:             &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum);
  230:         }
  231:     }
  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:                  .'&nbsp;'.&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
  250:     if ($target ne 'tex') {
  251:         if ($allowed) {
  252:             $r->print(&Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')));
  253:         }
  254:     }
  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
  266:                            : '' ) .
  267:              '</div>' );
  268: 
  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:     }
  276: #--------Functions
  277:     if ($target ne 'tex') {
  278:         if( $allowed || $privileged) {
  279:             $r->print(&Apache::lontemplate::start_functionslist());
  280:         if ($allowed) {
  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')));
  284:         } elsif ($privileged) {
  285:             $r->print(&Apache::lontemplate::item_functionslist(
  286:                         '<a href="'.$r->uri.'?forceedit=1">'.&mt('Edit').'</a>'));
  287:         }
  288:             $r->print(&Apache::lontemplate::end_functionslist());
  289:         }
  290:     }
  291: #----------------------------Print Headtitle
  292:     if ($target ne 'tex') {
  293:         $r->print('<h1>'.$courseenv{'description'}.'</h1>');
  294:         $r->print('<h3>'.  &Apache::lonnet::domain($cdom,'description').'</h3>');
  295:     } else {
  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 {
  312:             $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & ');
  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:     }
  342: # -------------------------------------------------------------- Announcements?
  343:     my $day = &Apache::lonannounce::showday(time,2,
  344:              &Apache::lonannounce::readcalendar($cdom.'_'.$cnum));
  345:     if ($target ne 'tex') {
  346:         if ($allowed) {
  347:             &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_ContentBoxSpecial');
  348:             $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
  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>');
  351:             &Apache::lontemplate::print_end_template($r);
  352:         } elsif (&Apache::lonrss::advertisefeeds($cnum,$cdom) ne '') {
  353:             &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_ContentBoxSpecial');
  354:             $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit));
  355:             &Apache::lontemplate::print_end_template($r);
  356:         }
  357: 
  358:     } else {
  359:         $r->print(&Apache::lonxml::xmlparse($r,'tex',$day));
  360:     }
  361: # ---------------------------------------------------------------- Get syllabus
  362:     if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
  363:         if ($allowed) {
  364:             $r->print('<form method="post">'.
  365:             '<input type="hidden" name="forceedit" value="edit" />');
  366:         }
  367:         my @htmlids=();
  368: 
  369:         foreach my $field (sort(keys(%syllabusfields))) {
  370:             if (($syllabus{$field}=~/\w/) || ($allowed)) {
  371:                 my $message=$syllabus{$field};
  372:                 if ($field eq 'lll_includeurl') { # this is the "included" field
  373:                     my $urls=$message;
  374:                     $message='';
  375:                     foreach my $filelink (split(/\n/,$urls)) {
  376:                         my $output='';
  377:                        # embed style?
  378:                         my ($curfext)=($filelink=~/\.([^\.]+)$/);
  379:                         my $embstyle=&Apache::loncommon::fileembstyle($curfext);
  380:                         if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {# make ssi call and remove everything but the body contents
  381:                             $output=&Apache::lonnet::ssi_body($filelink);
  382:                         } elsif ($embstyle eq 'img') {# embed as an image
  383:                             $output='<img src="'.$filelink.'" />';
  384:                         }
  385:                         if ($output ne '') {
  386:                                if ($target ne 'tex') {
  387:                                    $message.='<p>'.$output.'</p>';
  388:                                } else {
  389:                                    $message.=' '.&Apache::lonxml::xmlparse($r,'tex','<p>'.$output.'</p>').' ';
  390:                                }
  391:                         }
  392:                     }
  393:                     if ($allowed) {
  394:                         $r->print('<h3>'.$syllabusfields{$field}.
  395:                         &Apache::loncommon::help_open_topic('Syllabus_URLs').'</h3>');
  396:                     } else {
  397:                         $r->print($message);
  398:                     }
  399:                 } else {
  400:                     &Apache::lonfeedback::newline_to_br(\$message);
  401:                     $message =~s|(https?\://[^\s]+)|<a href="$1"><tt>$1</tt></a>|g;
  402:                     if ($allowed) {
  403:                         $message=&Apache::lonspeller::markeduptext($message);
  404:                     }
  405:                     $message=&Apache::lontexconvert::msgtexconverted($message);
  406:                     if ($target ne 'tex') {
  407:                         if ($allowed) {
  408:                             $r->print('<p>');
  409:                         }
  410:                         &Apache::lontemplate::print_template($r, $syllabusfields{$field}, $message,$allowed,'LC_ContentBoxSpecial');
  411:                     } else {
  412:                         $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
  413:                         &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
  414:                     }
  415:                     push(@htmlids,$field);
  416:                 }
  417:                 if ($allowed) {
  418:                     if ($target ne 'tex') {
  419:                         $r->print('</p>');
  420:                         &Apache::lontemplate::print_editbox_template($r, $syllabus{$field}, $field);
  421:                     }
  422:                 }
  423:             }
  424:         }
  425:         if ($allowed) {
  426:             $r->print('</form>'.
  427:             &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids));
  428:         }
  429:       # if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
  430:     } else {
  431:         if ($target ne 'tex') {$r->print('<p>');} else {$r->print('\par ');}
  432:         $r->print(&mt('No syllabus information provided.'));
  433:         if ($target ne 'tex') {$r->print('</p>');}
  434:     }
  435:     if ($target ne 'tex') {
  436:         if ($env{'form.backto'} eq 'coursecatalog') {
  437:             $r->print('<form name="backtocat" method="post" action="/adm/coursecatalog">'.
  438:                       &Apache::lonhtmlcommon::echo_form_input(['backto','courseid']).
  439:                       '</form>');
  440:         }
  441:         $r->print(&Apache::loncommon::end_page());
  442:     } else {
  443:         $r->print('\end{document}');
  444:     }
  445:     return OK;
  446: }
  447: 
  448: 1;
  449: __END__