Annotation of loncom/homework/randomlabel.pm, revision 1.29

1.1       tsai        1: # The LearningOnline Network with CAPA
                      2: # random labelling tool
1.8       albertel    3: #
1.29    ! sakharuk    4: # $Id: randomlabel.pm,v 1.28 2002/05/20 20:35:13 albertel Exp $
1.8       albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.3       tsai       28: # 7/20/2001 Isaac Tsai, initial syntax
                     29: # 8/10/2001 Isaac Tsai, 
                     30: # 8/30/2001 Isaac Tsai, 
1.1       tsai       31: # SYNTAX:
1.4       albertel   32: # <randomlabel bgimg="URL" width="12" height="45" texwidth="50">
                     33: #    <labelgroup name="GroupOne" type="image">
                     34: #      <location x="123" y="456" />
                     35: #      <location x="321" y="654" />
                     36: #      <location x="213" y="546" />
                     37: #      <label description="TEXT-1">IMG-URL</label>
                     38: #      <label description="TEXT-2">IMG-URL</label>
                     39: #      <label description="TEXT-3">IMG-URL</label>
1.1       tsai       40: #    </labelgroup>
1.4       albertel   41: #    <labelgroup name="GroupTwo" type="text">
                     42: #      <location x="12" y="45" />
                     43: #      <location x="32" y="65" />
                     44: #      <location x="21" y="54" />
1.3       tsai       45: #      <label>TEXT-1</label>
                     46: #      <label>TEXT-2</label>
                     47: #      <label>TEXT-3</label>
1.1       tsai       48: #    </labelgroup>
                     49: #   </randomlabel>
                     50: #  ===========================================
1.3       tsai       51: #  side effect:
                     52: #    location (123,456): $GroupOne[0] = 2  # images give out indexes
                     53: #             (321,654): $GroupOne[1] = 1
                     54: #             (213,546): $GroupOne[2] = 0
                     55: #    location (12,45)  : $GroupTwo[0] = "TEXT-3"
                     56: #             (32,65)  : $GroupTwo[1] = "TEXT-1"
                     57: #             (21,54)  : $GroupTwo[2] = "TEXT-2"
1.1       tsai       58: #  ===========================================
                     59: package Apache::randomlabel;
1.24      sakharuk   60: use Apache::lonnet;
1.1       tsai       61: use strict;
1.13      sakharuk   62: use Apache::edit;
1.1       tsai       63: 
1.13      sakharuk   64: BEGIN {
1.1       tsai       65:   &Apache::lonxml::register('Apache::randomlabel',('randomlabel','labelgroup','location','label'));
                     66: }
                     67: 
1.23      matthew    68: sub check_int {
                     69:     # utility function to do error checking on a integer.
                     70:     my ($num,$default) = @_;
                     71:     $default = 100 if (! defined($default));
                     72:     $num =~ s/\s+//g;  # We dont need no stinkin white space!
                     73:     # If it is a real, just grab the integer part.
                     74:     ($num,undef) = split (/\./,$num) if ($num =~ /\./); 
                     75:     # set to default if what we have left doesn't match anything...
                     76:     $num = $default unless ($num =~/^\d+$/);
                     77:     return $num;
                     78: }
                     79: 
1.1       tsai       80: sub start_randomlabel {
                     81:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                     82:   my $result='';
1.23      matthew    83:   push (@Apache::lonxml::extlinks, '/res/adm/includes/GLabel.class');
1.20      albertel   84:   push (@Apache::lonxml::namespace,'randomlabel');
1.1       tsai       85:   my $bgimg= &Apache::lonxml::get_param('bgimg',$parstack,$safeeval);
1.6       albertel   86:   if ( $bgimg !~ /^http:/ ) {
1.23      matthew    87:     push (@Apache::lonxml::extlinks,$bgimg);
1.6       albertel   88:     $bgimg=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$bgimg);
1.7       albertel   89:     if ($bgimg =~ /$Apache::lonnet::perlvar{'lonDocRoot'}/) {
                     90:       $bgimg=~s/$Apache::lonnet::perlvar{'lonDocRoot'}//;
                     91:     } elsif ($bgimg =~ m:^/home/.*/public_html:) {
                     92:       $bgimg =~ s:^/home/(.*)/public_html:/~$1:;
                     93:     }
1.6       albertel   94:     $bgimg="http://".$ENV{'SERVER_NAME'}.$bgimg;
                     95:   }
1.1       tsai       96:   my $code = &Apache::lonxml::get_param('code',$parstack,$safeeval);
                     97:   my $codebase = &Apache::lonxml::get_param('codebase',$parstack,$safeeval);
1.23      matthew    98:   my $w= &check_int(&Apache::lonxml::get_param('width',$parstack,$safeeval));
                     99:   my $h= &check_int(&Apache::lonxml::get_param('height',$parstack,$safeeval));
1.4       albertel  100:   my $texwidth= &Apache::lonxml::get_param('texwidth',$parstack,$safeeval);
                    101:   if (!$code) { $code='GLabel.class'; }
                    102:   if (!$codebase) { $codebase='/res/adm/includes/'; }
1.3       tsai      103:   $Apache::randomlabel::tlabel_cnt=0;
                    104:   $Apache::randomlabel::ilabel_cnt=0;
                    105:   if ($target eq 'web') {
1.26      albertel  106:     $result.="<applet code=\"$code\" codebase=\"$codebase\" width=\"$w\" height=\"$h\">\n";
                    107:     $result.="<param name=\"bgimg\" value=\"$bgimg\">\n";
1.4       albertel  108:   } elsif ($target eq 'tex') {
1.12      sakharuk  109:     $bgimg=~s/(.gif|.jpg)$/.eps/;
1.24      sakharuk  110:     $bgimg= &Apache::lonnet::filelocation($bgimg);
                    111:     $bgimg=~s/http:\/[^\/]*/\/home\/httpd\/html/;
                    112:     $bgimg=~s/\/$//;
1.12      sakharuk  113:     $result.='\vspace*{2mm}  \noindent \epsfxsize='.$texwidth.' mm \epsffile{'.
1.29    ! sakharuk  114:     $bgimg.'}\setlength{\unitlength}{1mm}  \begin{picture}('.$texwidth.','.$texwidth*$h/$w.')'
1.3       tsai      115:   } elsif ($target eq 'edit') {
1.4       albertel  116:     $result.=&Apache::edit::tag_start($target,$token);
1.18      matthew   117:     $result.=&Apache::edit::text_arg('Image:','bgimg',$token,75).' ';
                    118:     $result.=&Apache::edit::browse('bgimg').' ';
                    119:     $result.=&Apache::edit::search('bgimg').'<br />'.
1.15      matthew   120:         &Apache::edit::text_arg('Width(pixel):' ,'width'   ,$token,6).
                    121:         &Apache::edit::text_arg('Height(pixel):','height'  ,$token,6).
                    122:         &Apache::edit::text_arg('TeXWidth(mm):' ,'texwidth',$token,6).
                    123:         &Apache::edit::end_row().&Apache::edit::start_spanning_row();     
1.3       tsai      124:   } elsif ($target eq 'modified') {
1.4       albertel  125:     my $constructtag=&Apache::edit::get_new_args($token,$parstack,$safeeval,
                    126: 						 'bgimg','width','height',
                    127: 						 'texwidth');
                    128:     if ($constructtag) {
                    129:       $result = &Apache::edit::rebuild_tag($token);
                    130:       $result.=&Apache::edit::handle_insert();
                    131:     }
1.1       tsai      132:   }
                    133:   return $result;
                    134: }
                    135: 
                    136: sub end_randomlabel {
1.3       tsai      137:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    138:   my $result='';
                    139:   my $count;
1.21      albertel  140:   pop @Apache::lonxml::namespace;
1.3       tsai      141:   if ($target eq 'web') {
1.4       albertel  142:     $count = $Apache::randomlabel::tlabel_cnt;
1.26      albertel  143:     if( $count != 0) { $result.= "<param name=\"COUNT\" value=\"$count\">\n"; }
1.4       albertel  144:     $count = $Apache::randomlabel::ilabel_cnt;
1.26      albertel  145:     if( $count != 0) { $result.= "<param name=\"ICOUNT\" value=\"$count\">\n"; }
                    146:     $result .= "</applet>\n<BR />";
1.4       albertel  147:   } elsif ($target eq 'tex') {
1.24      sakharuk  148:     $result='\end{picture}\\\\';
1.4       albertel  149:   } elsif ($target eq 'edit') {
                    150:     $result.=&Apache::edit::end_table;
1.3       tsai      151:   }
                    152:   return $result;
1.1       tsai      153: }
                    154: 
                    155: sub start_labelgroup {
                    156:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    157:   my $result='';
                    158:   my $name = &Apache::lonxml::get_param('name',$parstack,$safeeval);
                    159:   my $type = &Apache::lonxml::get_param('type',$parstack,$safeeval);
1.2       tsai      160:   $type =~tr/A-Z/a-z/;
1.5       albertel  161:   if ($target eq 'web' || $target eq 'tex' || 
                    162:       $target eq 'grade' || $target eq 'answer') {
1.4       albertel  163:     $Apache::randomlabel::groupname=$name;
                    164:     $Apache::randomlabel::type=$type;
                    165:     @Apache::randomlabel::xcoord = ();
                    166:     @Apache::randomlabel::ycoord = ();
1.5       albertel  167:     @Apache::randomlabel::value = ();
1.4       albertel  168:     @Apache::randomlabel::label_arr  = ();
1.26      albertel  169:     @Apache::randomlabel::decription  = ();
1.4       albertel  170:   } elsif ($target eq 'edit') {
                    171:     $result.=&Apache::edit::tag_start($target,$token);
                    172:     $result.=&Apache::edit::text_arg('Name:','name',$token).
                    173:       &Apache::edit::select_arg('Type:','type',['text','image'],$token).
1.13      sakharuk  174: 	  &Apache::edit::end_row().&Apache::edit::start_spanning_row();
1.4       albertel  175:   } elsif ($target eq 'modified') {
                    176:     my $constructtag=&Apache::edit::get_new_args($token,$parstack,$safeeval,
                    177: 						 'name','type');
                    178:     if ($constructtag) {
                    179:       $result = &Apache::edit::rebuild_tag($token);
                    180:       $result.=&Apache::edit::handle_insert();
                    181:     }
                    182:   }
1.3       tsai      183:   return $result;
1.1       tsai      184: }
                    185: 
1.5       albertel  186: sub add_vars {
1.28      albertel  187:   my ($name,$order,$label,$labelorder,$value,$image,$safeeval) = @_;
1.5       albertel  188:   my $code = '${'.$name."}{'".($order+1)."'}='".$label."';";
                    189:   my $out=Apache::run::run($code,$safeeval);
                    190:   if ($value) {
                    191:     $code = '${'.$name."}{'value_".($order+1)."'}='".$value."';";
                    192:     $out=Apache::run::run($code,$safeeval);
                    193:     $code = '${'.$name."}{'labelvalue_".($labelorder+1)."'}='".$value."';";
                    194:     $out=Apache::run::run($code,$safeeval);
1.4       albertel  195:   }
1.28      albertel  196:   if ($image) {
                    197:       my $code = '${'.$name."}{'image_".($order+1)."'}='".$image."';";
                    198:       my $out=Apache::run::run($code,$safeeval);
                    199:   }
1.5       albertel  200:   $code = '${'.$name."}{'numlocations'}='".($order+1)."';";
                    201:   $out=Apache::run::run($code,$safeeval);
1.4       albertel  202: }
1.5       albertel  203: 
1.1       tsai      204: # begin to assign labels to locations
                    205: sub end_labelgroup {
                    206:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    207:   my $gname = $Apache::randomlabel::groupname;
1.2       tsai      208:   my $type  = $Apache::randomlabel::type;
1.4       albertel  209:   my $result='';
1.5       albertel  210:   if ($target eq 'web' || $target eq 'answer' || $target eq 'grade') {
1.4       albertel  211:     my @idx_arr = (0 .. $#Apache::randomlabel::label_arr);
                    212:     &Apache::structuretags::shuffle(\@idx_arr);
                    213:     for(0 .. $#Apache::randomlabel::label_arr) {
                    214:       my $str;
                    215:       my $xstr;
                    216:       my $ystr;
                    217:       my $label = "$Apache::randomlabel::label_arr[ $idx_arr[$_] ]";
1.5       albertel  218:       my $x = $Apache::randomlabel::xcoord[$_];
                    219:       my $y = $Apache::randomlabel::ycoord[$_];
                    220:       my $value = $Apache::randomlabel::value[$_];
1.4       albertel  221:       if( $type eq 'text') {
1.28      albertel  222: 	&add_vars($gname,$_,$label,$idx_arr[$_],$value,'',$safeeval);
1.4       albertel  223: 	$str = 'LB'.$Apache::randomlabel::tlabel_cnt;
                    224: 	$xstr = 'X'.$Apache::randomlabel::tlabel_cnt;
                    225: 	$ystr = 'Y'.$Apache::randomlabel::tlabel_cnt;
                    226: 	$Apache::randomlabel::tlabel_cnt += 1;
                    227:       } elsif ( $type eq 'image') {
1.28      albertel  228: 	&add_vars($gname,$_,
                    229: 		  $Apache::randomlabel::description[$idx_arr[$_]],
                    230: 		  $idx_arr[$_],$value,$label,$safeeval);
1.26      albertel  231: 	$str = 'IMG'.$Apache::randomlabel::ilabel_cnt;
                    232: 	$xstr = 'IX'.$Apache::randomlabel::ilabel_cnt;
                    233: 	$ystr = 'IY'.$Apache::randomlabel::ilabel_cnt;
1.4       albertel  234: 	$Apache::randomlabel::ilabel_cnt += 1;
                    235:       } else {
                    236: 	&Apache::lonxml::error('Unknown type of label :'.$type.':');
                    237:       }
1.5       albertel  238:       if ($target eq 'web') {
                    239: 	$result .= '<param name="' . $str  . '" value="'.$label.'">';
                    240: 	$result .= '<param name="' . $xstr . '" value="'.$x.'">';
1.26      albertel  241: 	$result .= '<param name="' . $ystr . '" value="'.$y.'">'."\n";
1.5       albertel  242:       }
1.3       tsai      243:     }
1.4       albertel  244:   } elsif ($target eq 'tex') {
                    245:     my $WX1=0; #  Web x-coord. of upper left corner (ULC)
                    246:     my $WY1=0; #  Web y-coord. of (ULC)
                    247:     my $wwidth=&Apache::lonxml::get_param('width',$parstack,$safeeval,-2);
                    248:     my $wheight=&Apache::lonxml::get_param('height',$parstack,$safeeval,-2);
                    249:     my $texwidth=&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,-2);
                    250:     my $TX1=0;
                    251:     my $TY1=$texwidth*($wheight/$wwidth);
                    252:     my $TX2=$texwidth;
                    253:     my $TY2=0;
                    254: 
                    255: 
                    256:     my $slopex=($wwidth-$WX1)/($TX2-$TX1);
                    257:     my $slopey=($wheight-$WY1)/($TY2-($TY1-1.0));
                    258:     my $cstx=$wwidth-$slopex*($TX2);
                    259:     my $csty=$wheight-$slopey*($TY2);
                    260: 
                    261:     my @idx_arr = (0 .. $#Apache::randomlabel::label_arr);
                    262:     &Apache::structuretags::shuffle(\@idx_arr);
                    263: 
                    264:     &Apache::lonxml::debug("Array is:".$#Apache::randomlabel::label_arr.":");
                    265:     for(my $i=0;$i <= $#Apache::randomlabel::label_arr; $i++) {
                    266:       my $label = "$Apache::randomlabel::label_arr[ $idx_arr[$i] ]";
                    267:       my $x = $Apache::randomlabel::xcoord[$i];
                    268:       my $y = $Apache::randomlabel::ycoord[$i];
1.5       albertel  269:       my $value = $Apache::randomlabel::value[$i];
1.16      sakharuk  270: #      my $tcX=$x*($texwidth/$wwidth) - $texwidth;
1.29    ! sakharuk  271:       my $tcX=($x)*($texwidth/$wwidth);
1.16      sakharuk  272: #      my $tcY=$TY1-$y*($TY1/$wheight)-2;
1.19      albertel  273:       my $ratio=($wwidth > 0 ? $wheight/$wwidth : 1 );
                    274:       my $tcY=$TY1-$y*($TY1/$wheight)+$texwidth*$ratio;
1.4       albertel  275:       $tcX=sprintf('%.2f',$tcX);
                    276:       $tcY=sprintf('%.2f',$tcY);
                    277:       $result.='\put('.$tcX.','.$tcY.'){\normalsize \bf '.$label.'}'."\n";
                    278:       if( $type eq 'text') {
1.28      albertel  279: 	&add_vars($gname,$i,$label,$idx_arr[$i],$value,'',$safeeval);
1.4       albertel  280:       } elsif ( $type eq 'image') {
1.28      albertel  281: 	&add_vars($gname,$i,
                    282: 		  $Apache::randomlabel::description[$idx_arr[$i]],
                    283: 		  $idx_arr[$i],$value,$label,$safeeval);
1.4       albertel  284:       } else {
                    285: 	&Apache::lonxml::error('Unknown type of label :'.$type.':');
                    286:       }
                    287:     }
                    288:   } elsif ($target eq 'edit') {
                    289:     $result.=&Apache::edit::end_table;
1.1       tsai      290:   }
1.4       albertel  291:   return $result;
1.1       tsai      292: }
                    293: 
1.5       albertel  294: # <location x="123" y="456" value="some value"/>
1.1       tsai      295: sub start_location {
                    296:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.23      matthew   297:   my $x= &check_int(&Apache::lonxml::get_param('x',$parstack,$safeeval),50);
                    298:   my $y= &check_int(&Apache::lonxml::get_param('y',$parstack,$safeeval),50);
1.5       albertel  299:   my $value= &Apache::lonxml::get_param('value',$parstack,$safeeval);
1.3       tsai      300:   my $result='';
1.1       tsai      301:   push(@Apache::randomlabel::xcoord,$x);
1.4       albertel  302:   push(@Apache::randomlabel::ycoord,$y);
1.5       albertel  303:   push(@Apache::randomlabel::value,$value);
1.4       albertel  304:   if ($target eq 'edit') {
                    305:     $result.=&Apache::edit::tag_start($target,$token);
                    306:     $result.=&Apache::edit::text_arg('X:','x',$token,4).
                    307:       &Apache::edit::text_arg('Y:','y',$token,4).
1.5       albertel  308: 	&Apache::edit::text_arg('Value:','value',$token).
1.13      sakharuk  309: 	  &Apache::edit::end_row();
1.4       albertel  310:     $result.=&Apache::edit::end_table;
                    311:   } elsif ($target eq 'modified') {
                    312:     my $constructtag=&Apache::edit::get_new_args($token,$parstack,$safeeval,
1.5       albertel  313: 						 'x','y','value');
1.4       albertel  314:     if ($constructtag) {
                    315:       $result = &Apache::edit::rebuild_tag($token);
                    316:       $result.=&Apache::edit::handle_insert();
                    317:     }
                    318:   }
1.3       tsai      319:   return $result;
1.1       tsai      320: }
                    321: 
                    322: sub end_location {
1.3       tsai      323:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.4       albertel  324:   my @result;
                    325:   if ($target eq 'edit') { @result=('','no') }
                    326:   return @result;
1.1       tsai      327: }
                    328: 
1.2       tsai      329: # <label>$var_abc</label>
1.1       tsai      330: sub start_label {
                    331:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.3       tsai      332:   my $result='';
1.26      albertel  333:   my $type = &Apache::lonxml::get_param('type',$parstack,$safeeval,-2);
1.5       albertel  334:   if ($target eq 'web' || $target eq 'tex' || 
                    335:       $target eq 'grade' || $target eq 'answer') {
1.4       albertel  336:     my $ltext=&Apache::lonxml::get_all_text("/label",$$parser[-1]);
1.14      albertel  337:     $ltext=&Apache::run::evaluate($ltext,$safeeval,$$parstack[-1]);
1.26      albertel  338:     if ($type eq 'image') {
                    339:       &Apache::lonxml::debug("Turning $ltext and $Apache::lonxml::pwd[-1]");
                    340:       $ltext="http://$ENV{'SERVER_NAME'}".&Apache::lonnet::hreflocation($Apache::lonxml::pwd[-1],
                    341: 					   $ltext);
                    342:       &Apache::lonxml::debug("into $ltext");
                    343:       my $description = &Apache::lonxml::get_param('description',
                    344: 						   $parstack,$safeeval);
                    345:       push(@Apache::randomlabel::description,$description);
                    346:     }
1.4       albertel  347:     push(@Apache::randomlabel::label_arr,$ltext);
                    348:   } elsif ($target eq 'edit') {
1.26      albertel  349:     $result.=&Apache::edit::tag_start($target,$token,"$type Label");
1.4       albertel  350:     my $text=&Apache::lonxml::get_all_text("/label",$$parser[-1]);
1.27      albertel  351:     if ($type eq 'image') {
                    352:       $result.=&Apache::edit::end_row().&Apache::edit::start_spanning_row();
                    353:       $result.=&Apache::edit::text_arg('Description:','description',$token);
                    354:     }
1.26      albertel  355:     if ($type eq 'text') { $result.="Label Text:"; }
                    356:     if ($type eq 'image') { $result.="Path to image:"; }
                    357:     $result.=&Apache::edit::editline('',$text,'',20).
                    358:       &Apache::edit::end_table();
1.4       albertel  359:   } elsif ($target eq 'modified') {
                    360:     my $text=$$parser[-1]->get_text("/label");
1.26      albertel  361:     $result = '<label>';
                    362:     if ($type eq 'image') {
                    363:       my $constructtag=&Apache::edit::get_new_args($token,$parstack,$safeeval,
                    364: 						   'description');
                    365:       if ($constructtag) {
                    366: 	$result = &Apache::edit::rebuild_tag($token);
                    367:       } else {
                    368: 	$result = $token->[4];
                    369:       }
                    370:     }
                    371:     $result.=&Apache::edit::modifiedfield($token);
1.4       albertel  372:   }
1.3       tsai      373:   return $result;
1.1       tsai      374: }
                    375: 
                    376: sub end_label {
1.3       tsai      377:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.4       albertel  378:   my @result;
                    379:   if ($target eq 'edit') { @result=('','no') }
                    380:   return @result;
1.1       tsai      381: }
                    382: 
                    383: 
                    384: 
                    385: 1;
                    386: __END__
                    387:  

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>