--- loncom/interface/lonsyllabus.pm 2007/07/27 00:24:50 1.62 +++ loncom/interface/lonsyllabus.pm 2012/12/06 21:43:27 1.115 @@ -1,7 +1,7 @@ # The LearningOnline Network # Syllabus # -# $Id: lonsyllabus.pm,v 1.62 2007/07/27 00:24:50 albertel Exp $ +# $Id: lonsyllabus.pm,v 1.115 2012/12/06 21:43:27 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -29,6 +29,7 @@ package Apache::lonsyllabus; use strict; +use Apache::lontemplate; use Apache::Constants qw(:common); use Apache::loncommon; use Apache::lonnet; @@ -51,14 +52,21 @@ sub handler { my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri); # ------------------------------------------------------------ Get query string &Apache::loncommon::get_unprocessed_cgi - ($ENV{'QUERY_STRING'},['forcestudent','register','forceedit','wrapperdisplay']); + ($ENV{'QUERY_STRING'},['register','forceedit', + 'folderpath','title']); # ----------------------------------------------------- Is this even a course? my $homeserver=&Apache::lonnet::homeserver($cnum,$cdom); if ($homeserver eq 'no_host') { &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; - &Apache::loncommon::simple_error_page($r,'No syllabus available', - 'No syllabus available'); + &Apache::loncommon::simple_error_page($r,'No syllabus available', + 'No syllabus available'); + return OK; + } elsif (!&Apache::lonnet::is_course($cdom,$cnum)) { + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + &Apache::loncommon::simple_error_page($r,'No syllabus available', + 'The course/community for which the syllabus was requested does not exist.'); return OK; } # ------------------------------------- There is such a course, get environment @@ -67,21 +75,15 @@ sub handler { # ------------------------------------------------------------ Print the screen if ($target eq 'tex') { - $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'})); - } + $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'})); + } # -------------------------------------------------- Let's see who handles this my $externalsyllabus=$courseenv{'externalsyllabus'}; if ($externalsyllabus=~/\w/) { - - if ($env{'form.wrapperdisplay'} eq 'menu') { - $r->print(&Apache::lonwrapper::simple_menu()); - } else { - $r->print(&Apache::lonwrapper::wrapper("/public/$cdom/$cnum/syllabus?wrapperdisplay=menu", - $externalsyllabus)); - } - return OK; - } + $r->print( Apache::lonwrapper::wrapper($externalsyllabus) ); + return OK; + } # ------------------------------ The buck stops here: internal syllabus display # --------------------------------------------------------- The syllabus fields @@ -102,252 +104,348 @@ sub handler { 'kkk_textbook' => 'Textbook', 'lll_includeurl' => 'URLs To Include in Syllabus'); # --------------------------------------------------------------- Force Student - my $forcestudent=''; - if ($env{'form.forcestudent'}) { $forcestudent='student'; }; - my $forceedit=''; - if ($env{'form.forceedit'}) { $forceedit='edit'; } - -# ----------------------------------------------------------------- Make header + my ($forceedit,$forcestudent); + if ($env{'form.forceedit'}) { $forceedit=1; } + if (!$forceedit) { + $forcestudent=1; + } +# ----------------------------------------------------------------- Make header if ($target ne 'tex') { - my $rss_link = &Apache::lonrss::rss_link($cnum,$cdom); - my $start_page = - &Apache::loncommon::start_page("Syllabus", $rss_link, - {'function' => $forcestudent, - 'domain' => $cdom, - 'force_register' => - $env{'form.register'},}); + my $rss_link = &Apache::lonrss::rss_link($cnum,$cdom); + my $js; + if ($env{'form.backto'} eq 'coursecatalog') { + $js .= <<"ENDSCRIPT"; + + + +ENDSCRIPT + } + my $args = {'function' => undef, + 'domain' => $cdom}; + my $forcereg; + if ($env{'form.register'}) { + $forcereg = 1; + $args->{'force_register'} = $forcereg; + } + if ($env{'form.backto'} eq 'coursecatalog') { + &Apache::lonhtmlcommon::clear_breadcrumbs(); + my $brcrum = [{href=>"javascript:ToCatalog();", + text=>&mt('Course/Community Catalog'), + no_mt=>1} + ]; + if ($env{'form.coursenum'} ne '') { + push(@{$brcrum}, + {href=>"javascript:ToCatalog('details')", + text=>"Course details"}); + } + push(@{$brcrum}, + {href=>$r->uri, + text=>"Course syllabus"}); + $args->{'bread_crumbs'} = $brcrum; + } elsif ($env{'form.folderpath'} =~ /^supplemental/) { + my $crstype = &Apache::loncommon::course_type(); + my $title = $env{'form.title'}; + if ($title eq '') { + $title = &mt('Syllabus'); + } + my $brcrum = + &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1); + if (ref($brcrum) eq 'ARRAY') { + $args->{'bread_crumbs'} = $brcrum; + } + } + my $start_page = + &Apache::loncommon::start_page("Syllabus", $rss_link.$js,$args); + $r->print($start_page); + } +# ---------------------------------------------------------- Load syllabus info + my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum); + my $allowed=0; - $r->print($start_page.'

'.$courseenv{'description'}.'

'. - &Apache::lonnet::domain($cdom,'description').'

'); +# This handler might be called anonymously ... +# ----------------------------------------------------- Only if not public call + if ($env{'user.environment'}) { +# does this user have privileges to post, etc? + if ($env{'request.course.id'} + && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'} + && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) { + $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'}); + if ($forcestudent or $target eq 'tex') { $allowed=0; } + } +#store what the user typed in + if (($allowed) && ($env{'form.storesyl'})) { + foreach my $syl_field (keys(%syllabusfields)) { + my $field=$env{'form.'.$syl_field}; + chomp($field); + $field=~s/\s+$//s; + $field=~s/^\s+//s; + $field=~s/\$//s; + $field=&Apache::lonfeedback::clear_out_html($field,1); + #here it will be stored + $syllabus{$syl_field}=$field; + if ($syl_field eq 'lll_includeurl') { # clean up included URLs + my $field=''; + foreach my $value (split(/\n/,$syllabus{$syl_field})) { + my $url=$value; +# get rid of leading and trailing spaces + $url=~s/^\s+//; + $url=~s/\s+$//; + if ($url=~m|^https?\://([^/]+)/(.+)$|) { + my $host = $1; + my $remainder=$2; +# remove the hostname from internal URLs + my $hostname = &Apache::lonnet::hostname($host); + my %all_hostnames = &Apache::lonnet::all_hostnames(); + foreach my $possible_host (keys(%all_hostnames)) { + if ($possible_host =~ /\Q$hostname\E/i) { + $url=$remainder; + } + } + } +# norm internal URLs + unless ($url=~/^https?\:/) { + $url=&Apache::lonnet::clutter($url); + } +# re-assemble field + if ($url) { + $field.=$url."\n"; + } + } + $syllabus{$syl_field}=$field; + } + } + $syllabus{'uploaded.domain'}=$env{'user.domain'}; + $syllabus{'uploaded.name'}=$env{'user.name'}; + $syllabus{'uploaded.lastmodified'}=time; + &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum); + } + } + + if ($allowed) { +#---------------------------------- Print External URL Syllabus Info if editing + if ($target ne 'tex') { + my $protocol = $Apache::lonnet::protocol{$homeserver}; + $protocol = 'http' if ($protocol ne 'https'); + $r->print('
' + .'

' + .&mt('This syllabus can be publicly viewed at [_1]' + ,''.$protocol.'://'.&Apache::lonnet::hostname($homeserver).$r->uri.'') + .' '.&Apache::loncommon::help_open_topic('Syllabus_ExtLink') + .'

' + .'

' + .&mt('Instead of using this template you can specify an external URL as Syllabus in the [_1]Course Configuration[_2].' + ,'','') + .'

' + .'
'); + } } else { - $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'. - &Apache::lonnet::domain($cdom,'description').'}\\\\'); +#--------------------------------------------- Print last update unless editing + my $lastmod=$syllabus{'uploaded.lastmodified'}; + $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never')); + my $who; + if ($syllabus{'uploaded.lastmodified'}) { + if (($env{'user.name'} ne 'public') && ($env{'user.domain'} ne 'public')) { + $who = &Apache::loncommon::aboutmewrapper( + &Apache::loncommon::plainname($syllabus{'uploaded.name'}, + $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'}, + $syllabus{'uploaded.domain'}); + } else { +# Public user? +# Only display name of user, but no link to personal information page + $who = &Apache::loncommon::plainname( + $syllabus{'uploaded.name'}, + $syllabus{'uploaded.domain'}); + } + } + if ($target ne 'tex') { + $r->print('
'.&mt('Last updated').': '. + $lastmod . ' '. + ($who ? &mt('by').' '.$who + : '' ) . + '
' ); + } else { + $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '. + ($who? &mt('by').'\\\\ '. + &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'}) + :'') + .'\\\\'); + } } -# -------------------------------------------------------------- Announcements? - my $day = &Apache::lonannounce::showday(time,2, - &Apache::lonannounce::readcalendar($cdom.'_'.$cnum)); + +#-------------------------------------------------------------- Print Headtitle if ($target ne 'tex') { - $r->print($day. &Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit)); + $r->print('
'. + '

'.$courseenv{'description'}.'

'); + if ($allowed) { + $r->print('
'. + '

'.&Apache::lonnet::domain($cdom,'description').'

'. + '
'); +# Print Help Text if editing at right side of screen + $r->print('
'. + &Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')). + '

'); + } else { + $r->print('

'.&Apache::lonnet::domain($cdom,'description').'

'); + } } else { - $r->print(&Apache::lonxml::xmlparse($r,'tex',$day)); + $r->print('\noindent{\large\textbf{'.$courseenv{'description'}.'}}\\\\\\\\\textbf{'. + &Apache::lonnet::domain($cdom,'description').'}\\\\'); } - # -------------------------------------------------------- Get course personnel my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum); if ($target ne 'tex') { - $r->print(&Apache::loncommon::start_data_table()); + $r->print(&Apache::lonhtmlcommon::start_pick_box()); } else { - $r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline'); + $r->print('\begin{tabular}{|p{0.45\textwidth}|p{0.45\textwidth}|}\hline'); } - foreach my $element (sort keys %coursepersonnel) { - if ($target ne 'tex') { - $r->print(&Apache::loncommon::start_data_table_row(). - ''.$element.''); - } else { - $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & '); - } + my @personnel=sort(keys(%coursepersonnel)); + my $lastpers=$personnel[$#personnel]; + foreach my $element (@personnel) { + if ($target ne 'tex') { + $r->print(&Apache::lonhtmlcommon::row_title($element)); + } else { + $r->print(' '.&Apache::lonxml::xmlparse($r,'tex',$element).' & '); + } + my @coursepersonlist; foreach (split(/\,/,$coursepersonnel{$element})) { - my ($puname,$pudom)=split(/\:/,$_); - if ($target ne 'tex') { - $r->print(' '.&Apache::loncommon::aboutmewrapper( - &Apache::loncommon::plainname($puname, - $pudom),$puname,$pudom)); - } else { - $r->print(' '.&Apache::loncommon::plainname($puname, + my ($puname,$pudom)=split(/\:/,$_); + if ($target ne 'tex') { + my $courseperson = &Apache::loncommon::plainname($puname,$pudom); + if (($env{'user.name'} eq '') || ($env{'user.name'} eq 'public') || + ($env{'user.domain'} eq '') || ($env{'user.domain'} eq 'public')) { + push(@coursepersonlist,$courseperson); + } else { + push(@coursepersonlist,&Apache::loncommon::aboutmewrapper($courseperson, + $puname,$pudom)); + } + } else { + push(@coursepersonlist,&Apache::loncommon::plainname($puname, $pudom).' '); - } - } - if ($target ne 'tex') { - $r->print(''.&Apache::loncommon::end_data_table_row()); - } else { - $r->print('\\\\ \hline'); - } + } + } + $r->print(join(", ",@coursepersonlist)); + if ($target ne 'tex') { + my $lastclose=$element eq $lastpers?1:0; + $r->print(&Apache::lonhtmlcommon::row_closure($lastclose)); + } else { + $r->print('\\\\ \hline'); + } } if ($target ne 'tex') { - $r->print(&Apache::loncommon::end_data_table()); + $r->print(&Apache::lonhtmlcommon::end_pick_box()); } else { - $r->print('\end{tabular}\\\\'); + $r->print('\end{tabular}\\\\'); } -# ---------------------------------------------------------- Load syllabus info - my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum); - my $allowed=0; - my $privileged=0; +# -------------------------------------------------------------- Announcements? + my $day = &Apache::lonannounce::showday(time,2, + &Apache::lonannounce::readcalendar($cdom.'_'.$cnum)); + if ($target ne 'tex') { + if ($allowed) { + &Apache::lontemplate::print_start_template($r,&mt('RSS Feeds and Blogs'),'LC_Box'); + $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit)); + my $editurl= &Apache::lonnet::absolute_url().'/adm/'.$cdom.'/'.$cnum.'/_rss.html'; + $r->print( ''.&mt('New RSS Feed or Blog').''); + &Apache::lontemplate::print_end_template($r); + } elsif (&Apache::lonrss::advertisefeeds($cnum,$cdom) ne '') { + &Apache::lontemplate::print_start_template($r,&mt('RSS Feeds and Blogs'),'LC_Box'); + $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit)); + &Apache::lontemplate::print_end_template($r); + } -# This handler might be called anonymously ... -# ----------------------------------------------------- Only if not public call - if ($env{'user.environment'}) { -# does this user have privileges to post, etc? - if ($env{'request.course.id'} - && $cdom eq $env{'course.'.$env{'request.course.id'}.'.domain'} - && $cnum eq $env{'course.'.$env{'request.course.id'}.'.num'}) { - $allowed=&Apache::lonnet::allowed('mdc',$env{'request.course.id'}); - $privileged=$allowed; - if (($syllabus{'uploaded.lastmodified'}) && (!$forceedit)) { - $forcestudent='student'; - } - if ($forcestudent or $target eq 'tex') { $allowed=0; } - } - if ($allowed) { - $r->print('

'. -&Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes','Help with filling in text boxes').'

'.&mt('This syllabus can be publicly viewed at') - .' http://'. - &Apache::lonnet::hostname($homeserver).$r->uri.''. - &Apache::loncommon::help_open_topic('Syllabus_ExtLink').'

'. - '

'.&mt('You can specify an external URL as Syllabus in the [_1].',''.&mt('Course Parameters').'').'

'. - '

'. -&mt('Show Public View').''. - &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView'). - '

'); - } elsif ($privileged) { - if ($target ne 'tex') { - $r->print('

'. - &mt('Edit').''); - } - } - if (($allowed) && ($env{'form.storesyl'})) { - foreach my $syl_field (keys(%syllabusfields)) { - my $field=$env{'form.'.$syl_field}; - chomp($field); - $field=~s/\s+$//s; - $field=~s/^\s+//s; - $field=~s/\$//s; - $field=&Apache::lonfeedback::clear_out_html($field,1); - $syllabus{$syl_field}=$field; - if ($syl_field eq 'lll_includeurl') { # clean up included URLs - my $field=''; - foreach my $value (split(/\n/,$syllabus{$syl_field})) { - my $url=$value; -# get rid of leading and trailing spaces - $url=~s/^\s+//; - $url=~s/\s+$//; - if ($url=~m|^http://([^/]+)/(.+)$|) { - my $host = $1; - my $remainder=$2; -# remove the hostname from internal URLs - my $hostname = &Apache::lonnet::hostname($host); - my %all_hostnames = &Apache::lonnet::all_hostnames(); - foreach my $possible_host (keys(%all_hostnames)) { - if ($possible_host =~ /\Q$hostname\E/i) { - $url=$remainder; - } - } - } -# norm internal URLs - unless ($url=~/^http\:/) { - $url=&Apache::lonnet::clutter($url); - } -# re-assemble field - if ($url) { - $field.=$url."\n"; - } - } - $syllabus{$syl_field}=$field; - } - } - $syllabus{'uploaded.domain'}=$env{'user.domain'}; - $syllabus{'uploaded.name'}=$env{'user.name'}; - $syllabus{'uploaded.lastmodified'}=time; - &Apache::lonnet::put('syllabus',\%syllabus,$cdom,$cnum); - } + } else { + $r->print(&Apache::lonxml::xmlparse($r,'tex',$day)); } # ---------------------------------------------------------------- Get syllabus if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) { - my $lastmod=$syllabus{'uploaded.lastmodified'}; - $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never')); - my $who = &Apache::loncommon::aboutmewrapper( - &Apache::loncommon::plainname($syllabus{'uploaded.name'}, - $syllabus{'uploaded.domain'}),$syllabus{'uploaded.name'}, - $syllabus{'uploaded.domain'}); - if ($target ne 'tex') { - $r->print('
'.&mt('Last updated').':'. - $lastmod.''. - ($who ? &mt('by').' '.$who - : '' ). - '

'); - } else { - $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '. - ($who? &mt('by').'\\\\ '. - &Apache::loncommon::plainname($syllabus{'uploaded.name'},$syllabus{'uploaded.domain'}) - :'') - .'\\\\'); - } - if ($allowed) { - $r->print('

'. - ''); - } - my @htmlids=(); - foreach my $field (sort(keys(%syllabusfields))) { - if (($syllabus{$field}=~/\w/) || ($allowed)) { - my $message=$syllabus{$field}; - if ($field eq 'lll_includeurl') { # this is the "included" field - my $urls=$message; - $message=''; - foreach my $filelink (split(/\n/,$urls)) { - my $output=''; -# embed style? - my ($curfext)=($filelink=~/\.([^\.]+)$/); - my $embstyle=&Apache::loncommon::fileembstyle($curfext); - if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) { -# make ssi call and remove everything but the body contents - $output=&Apache::lonnet::ssi_body($filelink); - } elsif ($embstyle eq 'img') { -# embed as an image - $output=''; - } - if ($target ne 'tex') { - $message.='

'.$output.'

'; - } else { - $message.=' '.&Apache::lonxml::xmlparse($r,'tex','

'.$output.'

').' '; - } - } - if ($allowed) { - $r->print('

'.$syllabusfields{$field}. - &Apache::loncommon::help_open_topic('Syllabus_URLs').'

'. - '

'.&mt('Show Public View').''. - &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').'

'); - } else { - $r->print($message); - } - } else { - &Apache::lonfeedback::newline_to_br(\$message); - $message =~s|(https*://[^\s]+)|$1|g; - if ($allowed) { - $message=&Apache::lonspeller::markeduptext($message); - } - $message=&Apache::lontexconvert::msgtexconverted($message); - if ($target ne 'tex') { - $r->print('

'.$syllabusfields{$field}.'

'. - $message.'
'); - } else { - $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'. - &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\'); - } - push(@htmlids,$field); - } - if ($allowed) { - $r->print('
'); - } - } - } - if ($allowed) { - $r->print('
'. - &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids)); - } - if ($target ne 'tex') {$r->print('

');} else {$r->print('\\\\');} + if ($allowed) { + $r->print('
'. + ''); + } + my $url_include_handler = sub { + my ($r, $field, $message, $group, $data_ref, $fields_ref, $target, $allowed) = @_; + my %data = %{$data_ref}; + my %fields = %{$fields_ref}; + my $urls=$message; + $message=''; + foreach my $filelink (split(/\n/,$urls)) { + my $output=''; + # embed style? + my ($curfext)=($filelink=~/\.([^\.]+)$/); + my $embstyle=&Apache::loncommon::fileembstyle($curfext); + if (($embstyle eq 'ssi') || ($curfext=~/\/$/)) {# make ssi call and remove everything but the body contents + $output=&Apache::lonnet::ssi_body($filelink); + } elsif ($embstyle eq 'img') {# embed as an image + $output=''; + } + if ($output ne '') { + if ($target ne 'tex') { + $message.='

'.$output.'

'; + } else { + $message.=' '.&Apache::lonxml::xmlparse($r,'tex','

'.$output.'

').' '; + } + } + } + if ($allowed) { + &Apache::lonfeedback::newline_to_br(\$urls); + &Apache::lontemplate::print_start_template($r,$fields{$field}. + &Apache::loncommon::help_open_topic('Syllabus_URLs'),'LC_Box'); + $r->print($urls); + $r->print("
"); + &Apache::lontemplate::print_textarea_template($r, $data{$field}, + $field, Apache::lontemplate->RICH_TEXT_ALWAYS_OFF); + &Apache::lontemplate::print_saveall_template($r); + $r->print("
"); + &Apache::lontemplate::print_end_template($r); + + } else { + $r->print($message); + } + }; + my %custom_hash = ( 'lll_includeurl' => $url_include_handler ); + &Apache::lontemplate::print_template_fields($r, \%syllabus, \%syllabusfields, + $target, $allowed, Apache::lontemplate->RICH_TEXT_DETECT_HTML, \%custom_hash); + if ($allowed) { + $r->print('
'. + &Apache::lonhtmlcommon::htmlareaselectactive()); + } } else { - if ($target ne 'tex') {$r->print('

');} else {$r->print('\par ');} - $r->print('No syllabus information provided.'); - if ($target ne 'tex') {$r->print('

');} + if ($target ne 'tex') {$r->print('

');} else {$r->print('\par ');} + $r->print(&mt('No syllabus information provided.')); + if ($target ne 'tex') {$r->print('

');} } if ($target ne 'tex') { - $r->print(&Apache::loncommon::end_page()); + $r->print('
'); + if ($env{'form.backto'} eq 'coursecatalog') { + $r->print('
'. + &Apache::lonhtmlcommon::echo_form_input(['backto','courseid']). + '
'); + } + $r->print(&Apache::loncommon::end_page()); } else { - $r->print('\end{document}'); + $r->print('\end{document}'); } return OK; -} +} 1; __END__