--- loncom/homework/randomlabel.pm 2007/05/23 22:36:21 1.88 +++ loncom/homework/randomlabel.pm 2025/01/26 16:29:03 1.98 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # random labelling tool # -# $Id: randomlabel.pm,v 1.88 2007/05/23 22:36:21 albertel Exp $ +# $Id: randomlabel.pm,v 1.98 2025/01/26 16:29:03 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -24,35 +24,84 @@ # /home/httpd/html/adm/gpl.txt # # http://www.lon-capa.org/ -# -# SYNTAX: -# -# -# -# -# -# -# -# -# -# -# -# -# -# -# -# -# -# -# =========================================== -# side effect: -# location (123,456): $GroupOne[0] = 2 # images give out indexes -# (321,654): $GroupOne[1] = 1 -# (213,546): $GroupOne[2] = 0 -# location (12,45) : $GroupTwo[0] = "TEXT-3" -# (32,65) : $GroupTwo[1] = "TEXT-1" -# (21,54) : $GroupTwo[2] = "TEXT-2" -# =========================================== + +=pod + +=head1 NAME + +Apache::randomlable.pm + +=head1 SYNOPSIS + +Interface for producing applet code which +randomizes the labelling of an image. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + + +=head1 SYNTAX + + + + + + + + + + + + + + + + + + + + =========================================== + side effect: + location (123,456): $GroupOne[0] = 2 images give out indexes + (321,654): $GroupOne[1] = 1 + (213,546): $GroupOne[2] = 0 + location (12,45) : $GroupTwo[0] = "TEXT-3" + (32,65) : $GroupTwo[1] = "TEXT-1" + (21,54) : $GroupTwo[2] = "TEXT-2" + =========================================== + + +=head1 NOTABLE SUBROUTINES + +=over + +=item check_int() + + utility function to do error checking on a integer. + +=item extract_tag_sizes() + +Parameters: + tag - tag potentially containing height/width attributes. + def_width - Default width. + def_height - Default height. + Returns: + list containing width/height. + +=item get_label_width() + + Utility sub to compute the width of a label. + +=item end_labelgroup() + +begin to assign labels to locations + +=back + +=cut + + + package Apache::randomlabel; use Apache::lonnet; use strict; @@ -61,7 +110,8 @@ use Apache::File(); use Apache::Constants qw(:common :http); use Image::Magick; use Apache::lonplot; -use lib '/home/httpd/lib/perl/'; +use Apache::lonlocal; +use Apache::lonmeta; use LONCAPA; @@ -90,15 +140,8 @@ sub check_int { return $num; } -# Get width/height from an image tag... -# -# Parameters: -# tag - tag potentially containing height/width attributes. -# def_width - Default width. -# def_height - Default height. -# Returns: -# list containing width/height. -# + + sub extract_tag_sizes { my ($tag, $dw, $dh) = @_; $tag =~ s/\s+/ /g; # Collapse whitespace. @@ -121,20 +164,21 @@ sub extract_tag_sizes { } -my ($height_param,$width_param); +my ($height_param,$width_param,$alt_param); sub start_randomlabel { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; push (@Apache::lonxml::namespace,'randomlabel'); ($height_param,$width_param)=(0,0); + $alt_param = ''; $label_xscale = 1.0; # Assume image size not overridden. $label_yscale = 1.0; my $bgimg= &Apache::lonxml::get_param('bgimg',$parstack,$safeeval); - if ( defined($bgimg) && $bgimg !~ /^http:/ ) { + if ( defined($bgimg) && $bgimg !~ /^https?\:/ ) { $bgimg=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$bgimg); if (&Apache::lonnet::repcopy($bgimg) ne 'ok') { - $bgimg='/home/httpd/html/adm/lonKaputt/lonlogo_broken.gif'; + $bgimg=$Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonKaputt/lonlogo_broken.gif'; } } $Apache::randomlabel::obj_cnt=0; @@ -144,16 +188,25 @@ sub start_randomlabel { $args{"cgi.$cgi_id.BGIMG"}=&escape($bgimg); $height_param = &Apache::lonxml::get_param('height',$parstack, $safeeval); $width_param = &Apache::lonxml::get_param('width', $parstack, $safeeval); + $alt_param = &Apache::lonxml::get_param('alt', $parstack, $safeeval); + if ($alt_param eq '') { + unless (($bgimg =~ m{^data\:image/gif;base64,}) || ($bgimg =~ /^https?\:/) || + ($bgimg eq $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonKaputt/lonlogo_broken.gif')) { + $alt_param = &Apache::lonmeta::alttag($Apache::lonxml::pwd[-1],$bgimg); + } + } } elsif ($target eq 'tex' && defined($bgimg)) { $result.=&make_eps_image($bgimg,$parstack,$safeeval); } elsif ($target eq 'edit') { + my $only = join(',',&Apache::loncommon::filecategorytypes('Pictures')); $result.=&Apache::edit::tag_start($target,$token); $Apache::edit::bgimgsrc= &Apache::lonxml::get_param('bgimg',$parstack,$safeeval); $Apache::edit::bgimgsrccurdepth=$Apache::lonxml::curdepth; - $result.=&Apache::edit::text_arg('Image:','bgimg',$token,75).' '; - $result.=&Apache::edit::browse('bgimg').' '; - $result.=&Apache::edit::search('bgimg').'
'. + $result.=&Apache::edit::text_arg('Image:','bgimg',$token,75).' '. + &Apache::edit::browse_or_search('bgimg',undef,undef,$only,undef,1). + '
'. + &Apache::edit::text_arg('Description:' ,'alt' ,$token,40).'
'. &Apache::edit::text_arg('Width(pixel):' ,'width' ,$token,6). &Apache::edit::text_arg('Height(pixel):','height' ,$token,6). &Apache::edit::text_arg('TeXWidth(mm):' ,'texwidth',$token,6). @@ -161,7 +214,7 @@ sub start_randomlabel { } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args($token,$parstack, $safeeval,'bgimg','width', - 'height','texwidth'); + 'height','texwidth','alt'); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); } @@ -175,13 +228,20 @@ sub end_randomlabel { my $count; pop @Apache::lonxml::namespace; if ($target eq 'web') { + my $alttext; + if ($alt_param eq '') { + $alttext = &mt('labeled image'); + } else { + $alttext = $alt_param; + } + $alttext = &HTML::Entities::encode($alttext,'<>&"'); $count = $Apache::randomlabel::obj_cnt; if( $count != 0) { $args{"cgi.$cgi_id.OBJCOUNT"}=$count; } - $result.='
'."\n"; - &Apache::lonnet::appenv(%args); + $result.=''.$alttext.'
'."\n"; + &Apache::lonnet::appenv(\%args); } elsif ($target eq 'tex') { $result='\end{picture}\\\\'; - $result.= ' \vskip -'.$height_param.' mm } \\\\ '; + $result.= ' \vskip -'.$height_param.' mm } \\newline '; } elsif ($target eq 'edit') { $result.=&Apache::edit::end_table; } @@ -358,9 +418,8 @@ sub start_labelgroup { return $result; } -# -# Utility sub to compute the width of a label. -# + + sub get_label_width { my $label = shift; &Apache::lonxml::debug("image label = $label"); @@ -410,7 +469,8 @@ sub add_vars { $out=Apache::run::run($code,$safeeval); } -# begin to assign labels to locations + + sub end_labelgroup { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $gname = $Apache::randomlabel::groupname; @@ -552,6 +612,14 @@ sub end_location { } # +sub insert_label { + my ($after) = @_; + my $depth = scalar(@Apache::lonxml::depthcounter); + $depth-- if ($after); + my $inset = "\t"x$depth; + return "\n$inset"; +} + sub start_label { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result='';