--- loncom/homework/outputtags.pm 2005/10/11 10:48:23 1.39 +++ loncom/homework/outputtags.pm 2017/05/23 14:59:07 1.60 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # tags that create controlled output # -# $Id: outputtags.pm,v 1.39 2005/10/11 10:48:23 foxr Exp $ +# $Id: outputtags.pm,v 1.60 2017/05/23 14:59:07 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,21 +26,88 @@ # http://www.lon-capa.org/ # + + package Apache::outputtags; use strict; +use Apache::lonlocal; use Apache::lonnet; +use LONCAPA::LWPReq; use POSIX qw(strftime); BEGIN { &Apache::lonxml::register('Apache::outputtags',('displayduedate','displaytitle','displayweight','displaystudentphoto')); } +################################ utilities ########################### + +# +# Does a simple substitution of a tab when the opening tag can +# be replaced by a fixed string.. and same for the closing tag. +# Parameters: +# $input - String in in which to do the substitutions. +# $tag - name of tag without the <>'s e.g. sub for +# $opening - What to replace <$tag> with +# $closing - What to replace with. +# Returns: +# Input string appropriately substituted. +# +sub substitute_tag { + my ($input, + $tag, + $opening, + $closing) = @_; + + $input =~ s/<$tag>/$opening/gi; + $input =~ s/<\/$tag>/$closing/gi; + + return $input; +} + +# +# Substitutes the simple formatting tags in a string +# Parameters: +# $string - input string. +# Returns +# Result of string after simple substitutions +# Tags we handle are: +# , +# +sub substitute_simple_tags_latex { + my ($string) = @_; + + # restore the <>'s: + + $string =~ s/\\ensuremath\{<}/}/>/g; + + + # Substitute the tags: + + $string = &substitute_tag($string, "sub", '\ensuremath{_', '}'); + $string = &substitute_tag($string, 'sup', '\ensuremath{^', '}'); + $string = &substitute_tag($string, 'em', '\em{', '}'); + + + # Escape the remaining <>'s again: + + $string =~ s//\\ensuremath{>}/g; + + + + return $string; +} + +################################ The parser ########################## + sub initialize_outputtags { %Apache::outputtags::showonce=(); } + sub start_displayduedate { my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_; my $result; @@ -51,18 +118,26 @@ sub start_displayduedate { if (exists($Apache::outputtags::showonce{'displayduedate'})) { if (grep(/^\Q$Apache::inputtags::part\E$/, @{$Apache::outputtags::showonce{'displayduedate'}})) { - return ''; + return ''; # Already shown the duedate for this part. } } + # since we will show the duedate for this part, remember it. + push (@{$Apache::outputtags::showonce{'displayduedate'}}, $Apache::inputtags::part); + # Determine the due date format: + # my $status=$Apache::inputtags::status['-1']; &Apache::lonxml::debug("got a $status in duedatebox"); my $style = &Apache::lonxml::get_param('style',$parstack,$safeeval); - if (($status =~ /CAN.*_ANSWER/) && ($target eq 'web')) { + my $format = &Apache::lonxml::get_param('format', $parstack, $safeeval); + if (!$format) { + $format = undef; + } + if (($status =~ /CAN.*_ANSWER/)) { my $id = $Apache::inputtags::part; - my $date = &Apache::lonnet::EXT("resource.$id.duedate"); + my $date = &Apache::lonhomework::due_date($id); &Apache::lonxml::debug("duedatebox found $date for $id"); # Only show the due date if the current date is @@ -80,18 +155,37 @@ sub start_displayduedate { } if ($showduedate) { - if (lc($style) !~ 'plain') { - $result ='
Due '. - &Apache::lonnavmaps::timeToHumanString($date). - '
'; - } else { - $result=&mt('Due').' '.&Apache::lonnavmaps::timeToHumanString($date); + my $duetext = &Apache::lonnavmaps::timeToHumanString($date, '', $format); + if ($target eq 'web') { + if (lc($style) !~ 'plain') { + $result ='
Due '.$duetext.'
'; + } else { + $result=&mt('Due').' '.$duetext; + } + } elsif ($target eq 'tex') { + # For TeX we'll make the duedate tag work exactly like the + # duedate tag for web. + + my $duetext = &Apache::lonnavmaps::timeToHumanString($date, '', $format); + if (lc($style) !~ 'plain') { + # The due date will be put in a box. + # at the start of the line to ensure it won't overlap + # the 1 col boundary. + + $result = '\vspace{1.0 ex} \framebox{' + .&mt('Due').' '.$duetext.'}'; + } else { + $result = &mt('Due') . ' '.$duetext; + } } } - } elsif ( $target eq 'edit' ) { + + } + if ( $target eq 'edit' ) { $result=&Apache::edit::tag_start($target,$token); $result.=''; $result.=&Apache::edit::end_table(); + } return $result; } @@ -122,6 +216,7 @@ sub start_displaytitle { $result.=&Apache::edit::end_table(); } elsif ($target eq 'tex' and $Apache::lonhomework::type ne 'exam') { $name=&Apache::lonxml::latex_special_symbols($name); + $name = &substitute_simple_tags_latex($name); if (lc($style) !~ 'plain') { $result='\vskip 0 mm\noindent\textbf{'.$name.'}\vskip 0 mm'; } else { @@ -141,12 +236,18 @@ sub end_displaytitle { sub multipart { my ($uri)=@_; if (!defined($uri)) { $uri=$env{'request.uri'}; } + my ($symb)=&Apache::lonnet::whichuser(); + my @parts; my $metadata = &Apache::lonnet::metadata($uri,'packages'); foreach (split(/\,/,$metadata)) { if ($_ =~ /^part_(.*)$/) { my $part = $1; - if ($part ne '0') { push(@parts,$part); } + if ($part ne '0' + && !&Apache::loncommon::check_if_partid_hidden($part, + $symb)) { + push(@parts,$part); + } } } return @parts; @@ -202,7 +303,7 @@ sub end_displayweight { sub start_displaystudentphoto { my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_; my $result; - my (undef,undef,$domain,$user) = &Apache::lonxml::whichuser(); + my (undef,undef,$domain,$user) = &Apache::lonnet::whichuser(); if ($target eq 'web' && $user eq $env{'user.name'}) { my $url=&Apache::lonnet::studentphoto($domain,$user,"gif"); my $args; @@ -216,9 +317,9 @@ sub start_displaystudentphoto { } if ($target eq 'tex' && $env{'request.role'} =~ /^cc/) { my $url=&Apache::lonnet::studentphoto($domain,$user,"eps"); - my $ua=new LWP::UserAgent; + my $uhome=&Apache::lonnet::homeserver($user,$domain); my $request=new HTTP::Request('GET',$url); - my $response=$ua->request($request); + my $response=&LONCAPA::LWPReq::makerequest($uhome,$request,'','','',1); if ($response->is_success) { my $file=$user."_".$domain."_studentphoto.eps"; open(FILE,">".$Apache::lonnet::perlvar{'lonPrtDir'}."/$file"); @@ -243,3 +344,47 @@ sub end_displaystudentphoto { 1; __END__ + + +=head1 NAME + +Apache::outputtags; + +=head1 SYNOPSIS + +Handles tags associated with output. Seems to +relate to due dates of the assignment. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 SUBROUTINES + +=over + +=item start_displayduedate() + +=item initialize_outputtags() + +Empties the hash of tags that have already been displayed that should only be displayed once. + +=item end_displayduedate() + +=item start_displaytitle() + +=item end_displaytitle() + +=item multipart() + +=item start_displayweight() + +=item end_displayweight() + +=item start_displaystudentphoto() + +=item end_displaystudentphoto() + + +=back + +=cut