--- loncom/homework/outputtags.pm 2004/10/26 15:03:08 1.35 +++ loncom/homework/outputtags.pm 2016/08/09 23:43:42 1.58 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # tags that create controlled output # -# $Id: outputtags.pm,v 1.35 2004/10/26 15:03:08 albertel Exp $ +# $Id: outputtags.pm,v 1.58 2016/08/09 23:43:42 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,9 +26,12 @@ # http://www.lon-capa.org/ # + + package Apache::outputtags; use strict; +use Apache::lonlocal; use Apache::lonnet; use POSIX qw(strftime); @@ -36,44 +39,152 @@ 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; + + # Different parts can have different due dates... so we keep a list + # of the parts for which we've displayed the duedate: + if (exists($Apache::outputtags::showonce{'displayduedate'})) { - return ''; - } else { - $Apache::outputtags::showonce{'displayduedate'}=1; + if (grep(/^\Q$Apache::inputtags::part\E$/, + @{$Apache::outputtags::showonce{'displayduedate'}})) { + 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 eq '') { -# &Apache::lonxml::debug("using default format"); -# $format="%c"; -# } + 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"); - if (lc($style) !~ 'plain') { - $result ='
Due '. - &Apache::lonnavmaps::timeToHumanString($date). - '
'; - } else { - $result=&mt('Due').' '.&Apache::lonnavmaps::timeToHumanString($date); + + # Only show the due date if the current date is + # different from due date of the previous part. I think + # this is probably the best way to avoid due date clutter. + + my $showduedate = 1; + my $part_count = scalar(@{$Apache::outputtags::showonce{'displayduedate'}}); + if ($part_count > 1) { + my $prev_part_id = $Apache::outputtags::showonce{'displayduedate'}->[$part_count-2]; + my $prev_due_date = &Apache::lonnet::EXT("resource.$prev_part_id.duedate"); + if ($prev_due_date == $date) { + $showduedate = 0; + } } -# } else { -# $result ='
No due date set.
'; -# } - } elsif ( $target eq 'edit' ) { + + if ($showduedate) { + 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; + } + } + } + + } + if ( $target eq 'edit' ) { $result=&Apache::edit::tag_start($target,$token); $result.=''; $result.=&Apache::edit::end_table(); + } return $result; } @@ -104,6 +215,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 { @@ -122,13 +234,19 @@ sub end_displaytitle { sub multipart { my ($uri)=@_; - if (!defined($uri)) { $uri=$ENV{'request.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; @@ -152,7 +270,7 @@ sub start_displayweight { if (!defined($weight) || ($weight eq '')) { $weight=1; } $result.=$weight; } else { - my @parts=&multipart($ENV{'request.uri'}); + my @parts=&multipart($env{'request.uri'}); my $weight; if (@parts) { foreach my $part (@parts) { @@ -184,24 +302,22 @@ sub end_displayweight { sub start_displaystudentphoto { my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_; my $result; - my (undef,undef,$domain,$user) = &Apache::lonxml::whichuser(); - if ($target eq 'web' && $user eq $ENV{'user.name'}) { - my $ret=&Apache::lonnet::reply("studentphoto:$domain:$user:gif",&Apache::lonnet::homeserver($user,$domain)); - my $url="/uploaded/$domain/$user/internal/studentphoto.gif"; - my $tokenurl=&Apache::lonnet::tokenwrapper($url); + 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; my $width=&Apache::lonxml::get_param('width',$parstack,$safeeval); if ($width) { $args.=" width=\"$width\" "; } my $height=&Apache::lonxml::get_param('heigth',$parstack,$safeeval); if ($height) { $args.=" height=\"$height\" "; } - $result.=" \"$user\@$domain\""; + my $align=&Apache::lonxml::get_param('align',$parstack,$safeeval); + if ($align) { $args.=" align=\"$align\" "; } + $result.=" \"$user\@$domain\""; } - if ($target eq 'tex' && $ENV{'request.role'} =~ /^cc/) { - my $ret=&Apache::lonnet::reply("studentphoto:$domain:$user:eps",&Apache::lonnet::homeserver($user,$domain)); - my $url="/uploaded/$domain/$user/internal/studentphoto.eps"; - my $tokenurl=&Apache::lonnet::tokenwrapper($url); + if ($target eq 'tex' && $env{'request.role'} =~ /^cc/) { + my $url=&Apache::lonnet::studentphoto($domain,$user,"eps"); my $ua=new LWP::UserAgent; - my $request=new HTTP::Request('GET',$tokenurl); + my $request=new HTTP::Request('GET',$url); my $response=$ua->request($request); if ($response->is_success) { my $file=$user."_".$domain."_studentphoto.eps"; @@ -211,6 +327,8 @@ sub start_displaystudentphoto { my $width_param=&Apache::londefdef::image_size($Apache::lonnet::perlvar{'lonPrtDir'}."/$file",'0.3',$parstack,$safeeval); $result.=' \graphicspath{{'.$Apache::lonnet::perlvar{'lonPrtDir'}. '}}\includegraphics[width='.$width_param.' mm]{'.$file.'} '; + } else { + $result="$user\@$domain"; } } return $result; @@ -225,3 +343,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