--- loncom/interface/lonsyllabus.pm 2007/03/08 01:58:45 1.58 +++ loncom/interface/lonsyllabus.pm 2015/06/09 21:22:57 1.138 @@ -1,7 +1,7 @@ # The LearningOnline Network # Syllabus # -# $Id: lonsyllabus.pm,v 1.58 2007/03/08 01:58:45 albertel Exp $ +# $Id: lonsyllabus.pm,v 1.138 2015/06/09 21:22:57 damieng Exp $ # # Copyright Michigan State University Board of Trustees # @@ -29,11 +29,13 @@ package Apache::lonsyllabus; use strict; +use Apache::lontemplate; use Apache::Constants qw(:common); use Apache::loncommon; use Apache::lonnet; use Apache::lontexconvert; use Apache::lonfeedback; +use Apache::lonhtmlgateway; use Apache::lonannounce; use Apache::lonlocal; use Apache::lonhtmlcommon; @@ -51,40 +53,147 @@ 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','todocs', + 'folderpath','title','only_body']); # ----------------------------------------------------- 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 my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum); + my $crstype = &Apache::loncommon::course_type(); -# ------------------------------------------------------------ Print the screen +# --------------------------------------------------------------- Force Student + my ($forceedit,$forcestudent); + if ($env{'form.forceedit'}) { $forceedit=1; } + if (!$forceedit) { + $forcestudent=1; + } - my $rss_link = - &Apache::lonrss::rss_link('http://'.$ENV{'HTTP_HOST'}.'/public/'.$cdom.'/'.$cnum.'/Course_Announcements.rss'); +# --------------------------------------------------------------- Check Privileges + my $allowed = 0; + 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; } + } + } - if ($target eq 'tex') { - $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'})); - } # -------------------------------------------------- Let's see who handles this - my $externalsyllabus=$courseenv{'externalsyllabus'}; + my $external=$courseenv{'externalsyllabus'}; + my $uploaded=$courseenv{'uploadedsyllabus'}; + my $minimal=$courseenv{'minimalsyllabus'}; + + if (($minimal =~/\w/) || ($uploaded =~/\w/)) { + my ($item,$is_pdf); + if ($minimal =~/\w/) { + if ($external =~ m{\Q$minimal\E$}) { + undef($external); + } + $item = $minimal; + } elsif ($uploaded =~/\w/) { + if ($external =~ m{\Q$uploaded\E$}) { + undef($external); + } + $item = $uploaded; + if ($item =~ /\.pdf$/i) { + $is_pdf = 1; + } + } + unless ($allowed && $forceedit) { + my $file=&Apache::lonnet::filelocation("",$item); + if ($file =~ /\.(tex|x?html?)$/) { + my $filetype = $1; + my $filecontents=&Apache::lonnet::getfile($file); + if ($filecontents eq -1) { + $r->print(&mt('Syllabus file unavailable')); + } elsif ($filetype eq 'tex') { + if ($target eq 'tex') { + $r->print($filecontents); + } else { + my $result = &Apache::lontexconvert::converted(\$filecontents, + $env{'form.texengine'}); + my %args; + &get_breadcrumbs($cdom,$cnum,$crstype,\%args); + if ($env{'form.only_body'}) { + $args{'only_body'} = 1; + } + if ($env{'request.use_absolute'}) { + $args{'use_absolute'} = $env{'request.use_absolute'}; + } + $r->print(&Apache::loncommon::start_page("Syllabus",undef,\%args). + $result. + &Apache::loncommon::end_page()); + } + } else { + my %mystyle; + unless ($target eq 'tex') { + $target = 'web'; + } + &Apache::structuretags::reset_problem_globals(); + my $oldfile = $env{'request.filename'}; + $env{'request.filename'} = $item; + my $result = &Apache::lonxml::xmlparse($r,$target,$filecontents, + '',%mystyle); + &Apache::structuretags::reset_problem_globals(); + &Apache::lonhomework::finished_parsing(); + $env{'request.filename'} = $oldfile; + &Apache::lonxml::add_messages(\$result); + $r->print($result); + } + } else { + if ($target eq 'tex') { + $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}). + ' \strut \\\\ \textbf{'.&mt('Syllabus').'} \strut \\\\ '. + &mt('Unsupported file type.').' \strut \\\\ '. + &mt('Print the syllabus directly from your web browser'). + '\end{document}'); + } else { + $r->print(&Apache::lonwrapper::wrapper($item,undef,$env{'request.use_absolute'}, + undef,$is_pdf,&mt('Syllabus'))); + } + } + return OK; + } + } elsif ($external=~/\w/) { + unless ($allowed && $forceedit) { + if ($target eq 'tex') { + $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}). + ' \strut \\\\ \textbf{'.&mt('Syllabus').'} \strut \\\\ '.$external.' '. + ' \strut \\\\ '.&mt('Print the syllabus directly from your web browser'). + '\end{document}'); + } else { + my $is_ext = 1; + my $is_pdf; + if ($external =~ /\.pdf$/i) { + $is_pdf = 1; + } + $r->print(&Apache::lonwrapper::wrapper($external,undef,$env{'request.use_absolute'}, + $is_ext,$is_pdf,&mt('Syllabus'))); + } + return OK; + } + } + +# ------------------------------------------------------------ Print the screen - 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; - } + if ($target eq 'tex') { + $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'})); + } # ------------------------------ The buck stops here: internal syllabus display # --------------------------------------------------------- The syllabus fields @@ -104,247 +213,1453 @@ sub handler { 'jjj_weblinks' => 'Web Links', '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 +# ---------------------------------------------------------- Load syllabus info + my %syllabus=&Apache::lonnet::dump('syllabus',$cdom,$cnum); + my ($output,%displayfields,%noshow); + +# This handler might be called anonymously ... +# ----------------------------------------------------- Only if not public call + if ($allowed) { + if (($env{'form.choice'} =~ /^(template|minimal|url|file)$/) || + ($env{'form.phase'} =~ /^(upload|check)_embedded$/)) { + my $earlyout; + ($earlyout,$uploaded,$external,$minimal,$output) = + &save_changes($cnum,$cdom,$uploaded,$external,$minimal, + \%syllabus,\%syllabusfields,\%courseenv); + if (($env{'form.choice'} eq 'minimal') && + ($minimal eq "/uploaded/$cdom/$cnum/portfolio/syllabus/loncapa.html")) { + delete($env{'form.symb'}); + delete($env{'request.symb'}); + $r->internal_redirect("$minimal?editmode=1&forceedit=1"); + return OK; + } + if ($earlyout) { + if ($target ne 'tex') { + &print_header($r,$cnum,$cdom,$crstype,$allowed,$forceedit, + \%syllabus,\%syllabusfields); + $r->print($output. + &Apache::loncommon::end_page()); + } + return OK; + } + } + } if ($target ne 'tex') { - my $start_page = - &Apache::loncommon::start_page("Syllabus", $rss_link, - {'function' => $forcestudent, - 'domain' => $cdom, - 'force_register' => - $env{'form.register'},}); + &print_header($r,$cnum,$cdom,$crstype,$allowed,$forceedit,\%syllabus, + \%syllabusfields); + $r->print($output); + } - $r->print($start_page.'
'. + &mt('All feeds currently hidden'). + $msg. + '
'); + } else { + $r->print(''. + &mt('No current feeds'). + $msg. + '
'); + } + $rsslinktext = &mt('Manage Course RSS Feeds/Blogs'); + if ($crstype eq 'Community') { + $rsslinktext = &mt('Manage Community RSS Feeds/Blogs'); + } + } + my $editurl= &Apache::lonnet::absolute_url().'/adm/'.$cdom.'/'.$cnum.'/_rss.html'; + $r->print( ''.$rsslinktext.''); + &Apache::lontemplate::print_end_template($r); + } else { + unless ($hidefeeds) { + my $feeds = &Apache::lonrss::advertisefeeds($cnum,$cdom,$forceedit); + if ($feeds ne '') { + &Apache::lontemplate::print_start_template($r,&mt('RSS Feeds and Blogs'),'LC_Box'); + $r->print($feeds); + &Apache::lontemplate::print_end_template($r); + } + } + } } else { - $r->print(&Apache::lonxml::xmlparse($r,'tex',$day)); + $r->print(&Apache::lonxml::xmlparse($r,'tex',$day)); } +# ---------------------------------------------------------------- Get syllabus + if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) { + my $url_include_handler = sub { + my ($r, $field, $message, $group, $data_ref, $fields_ref, $target, $allowed, $display) = @_; + 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=''.$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', + 'box_'.$field,$display); + $r->print($urls); + $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::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;
+sub save_changes {
+ my ($cnum,$cdom,$uploaded,$external,$minimal,$syllabus,$syllabusfields,$courseenv) = @_;
+ my ($earlyout,$output);
+ unless ((ref($syllabus) eq 'HASH') && (ref($syllabusfields) eq 'HASH') ||
+ (ref($courseenv) eq 'HASH')) {
+ return ($earlyout,$uploaded,$external,$minimal,$output);
+ }
+ if (($env{'form.deleteuploaded_file'}) || ($env{'form.deleteuploaded_minimal'})) {
+ my %storehash;
+ if (($env{'form.choice'} eq 'file') &&
+ ($env{'form.deleteuploaded_file'}) && ($uploaded =~ /\w/)) {
+ if ($courseenv->{'uploadedsyllabus'} =~ m{^\Q/uploaded/$cdom/$cnum/portfolio\E(/syllabus/.+)$}) {
+ my $filename = $1;
+ &update_access_permissions($cdom,$cnum,$filename);
+ }
+ &Apache::lonnet::delenv('course.'.$env{'request.course.id'}.'.uploadedsyllabus');
+ &Apache::lonnet::delenv('course.'.$env{'request.course.id'}.'.externalsyllabus');
+ $storehash{'uploadedsyllabus'} = '';
+ $storehash{'externalsyllabus'} = '';
+ my $putres = &Apache::lonnet::put('environment',\%storehash,$cdom,$cnum);
+ undef($uploaded);
+ undef($external);
+ } elsif (($env{'form.choice'} eq 'minimal') &&
+ ($env{'form.deleteuploaded_minimal'}) && ($minimal =~ /\w/)) {
+ my $minimalurl = "/uploaded/$cdom/$cnum/portfolio/syllabus/loncapa.html";
+ if ($courseenv->{'minimalsyllabus'} eq "$minimalurl") {
+ my $filecontents=&Apache::lonnet::getfile(&Apache::lonnet::filelocation("",$minimalurl));
+ unless ($filecontents eq -1) {
+ $env{'form.output'} = $filecontents;
+ &Apache::lonnet::finishuserfileupload($cnum,$cdom,'output',
+ 'portfolio/syllabus/loncapa.html.bak');
+ $minimalurl = &default_minimal_syllabus($cnum,$cdom);
+ }
+ }
+ &update_access_permissions($cdom,$cnum,'/syllabus/loncapa.html');
+ &Apache::lonnet::delenv('course.'.$env{'request.course.id'}.'.externalsyllabus');
+ &Apache::lonnet::delenv('course.'.$env{'request.course.id'}.'.minimalsyllabus');
+ $storehash{'externalsyllabus'} = '';
+ $storehash{'minimalsyllabus'} = '';
+ my $putres = &Apache::lonnet::put('environment',\%storehash,$cdom,$cnum);
+ undef($external);
+ undef($minimal);
+ }
+ } elsif ($env{'form.choice'} eq 'template') {
+#store what the user typed in to the template
+ my @shown = &Apache::loncommon::get_env_multiple('form.showfield');
+ $syllabus->{'uploaded.fields'} = '';
+ if (@shown == 0) {
+ $syllabus->{'uploaded.fields'} = 'none';
+ } else {
+ foreach my $field (sort(@shown)) {
+ if (($field eq '000_showpeople') ||
+ ($field eq '111_showrssfeeds') ||
+ ($syllabusfields->{$field})) {
+ my ($prefix) = split(/_/,$field);
+ $syllabus->{'uploaded.fields'} .= $prefix.',';
+ }
+ if ($field eq '000_showpeople') {
+ my @hideusers = &Apache::loncommon::get_env_multiple('form.hideuser');
+ my @hideroles = &Apache::loncommon::get_env_multiple('form.hiderole');
+ my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum,1);
+ my %personnel;
+ foreach my $key (keys(%coursepersonnel)) {
+ map { $personnel{$key}{$_} = 1; } split(/,/,$coursepersonnel{$key});
+ }
+ %{$syllabus->{'personnel'}} = ();
+ $syllabus->{'personnel'}{'hideuser'} = '';
+ $syllabus->{'personnel'}{'hiderole'} = '';
+ foreach my $role (@hideroles) {
+ if (exists($personnel{$role})) {
+ $syllabus->{'personnel'}{'hiderole'} .= $role.',';
+ }
+ }
+ foreach my $item (@hideusers) {
+ my ($role,$user) = split(/\&/,$item);
+ if (ref($personnel{$role}) eq 'HASH') {
+ if ($personnel{$role}{$user}) {
+ $syllabus->{'personnel'}{'hideuser'} .= $item.',';
+ }
+ }
+ }
+ $syllabus->{'personnel'}{'hideuser'} =~ s/,$//;
+ $syllabus->{'personnel'}{'hiderole'} =~ s/,$//;
+ }
+ }
+ $syllabus->{'uploaded.fields'} =~ s/,$//;
+ }
+ foreach my $syl_field (keys(%{$syllabusfields})) {
+ my $field=$env{'form.'.$syl_field};
+ chomp($field);
+ my $gateway = Apache::lonhtmlgateway->new();
+ $field = $gateway->process_incoming_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|^http://([^/]+)/(.+)$|) {
- my $host = $1;
- my $remainder=$2;
+ $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;
- }
- }
- }
+ 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);
- }
+ 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 ($url) {
+ $field.=$url."\n";
+ }
+ }
+ $syllabus->{$syl_field}=$field;
+ }
+ }
+ my $now = time;
+ $syllabus->{'uploaded.domain'}=$env{'user.domain'};
+ $syllabus->{'uploaded.name'}=$env{'user.name'};
+ $syllabus->{'uploaded.lastmodified'} = $now;
+ my $putres = &Apache::lonnet::put('syllabus',$syllabus,$cdom,$cnum);
+ if ($putres eq 'ok') {
+ ($uploaded,$minimal,$external) =
+ &update_syllabus_env($cdom,$cnum,$courseenv,$env{'form.choice'},$uploaded,
+ $minimal,$external);
+ $output = '
'.&mt('Last updated').': | '. - $lastmod.' | '.&mt('by').' '.$who. - ' |
'); - } else { - $r->print('\\\\ '.&mt('Last updated').': '.$lastmod.' '.&mt('by').'\\\\ '. - &Apache::loncommon::plainname($syllabus{'uploaded.name'}, - $syllabus{'uploaded.domain'}).'\\\\'); - } - if ($allowed) { - $r->print('
'. - &Apache::lonhtmlcommon::htmlareaselectactive(@htmlids)); - } - if ($target ne 'tex') {$r->print('');} else {$r->print('\\\\');} - } else { - if ($target ne 'tex') {$r->print('');} else {$r->print('\par ');} - $r->print('No syllabus information provided.'); - if ($target ne 'tex') {$r->print('
');} + return ($earlyout,$uploaded,$external,$minimal,$output); +} + +sub default_minimal_syllabus { + my ($cnum,$cdom) = @_; + my $title; + if ($env{'form.syllabustitle'}) { + $title = $env{'form.syllabustitle'}; + $title =~ s{`}{}g; + $title=~s/^\s+//; + $title=~s/\s+$//; } - if ($target ne 'tex') { - $r->print(&Apache::loncommon::end_page()); + if ($title eq '') { + $title = &mt('Syllabus'); + } + my $initialtext = &mt('Replace with your own content.'); + my $newhtml = <