File:  [LON-CAPA] / loncom / homework / edit.pm
Revision 1.93: download - view: text, annotated - select for diffs
Tue Jun 7 01:33:19 2005 UTC (18 years, 9 months ago) by albertel
Branches: MAIN
CVS tags: version_2_0_0, version_1_99_3, version_1_99_2, version_1_99_1, version_1_99_0, HEAD
- BUG#4065 make it so html entities work inside of <oprtionresponse> values
(for instance &ne;)

# The LearningOnline Network with CAPA 
# edit mode helpers
#
# $Id: edit.pm,v 1.93 2005/06/07 01:33:19 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#

package Apache::edit; 

use strict;
use Apache::lonnet;
use HTML::Entities();
use Apache::lonlocal;

# Global Vars
# default list of colors to use in editing
@Apache::edit::colorlist=('#ffffff','#ff0000','#00ff00','#0000ff','#0ff000','#000ff0','#f0000f');
# depth of nesting of edit
$Apache::edit::colordepth=0;
@Apache::edit::inserttag=();
# image-type responses: active background image and curdepth at definition
$Apache::edit::bgimgsrc='';
$Apache::edit::bgimgsrccurdepth='';

sub initialize_edit {
    $Apache::edit::colordepth=0;
    @Apache::edit::inserttag=();
}

sub tag_start {
    my ($target,$token,$description) = @_;
    my $result='';
    if ($target eq "edit") {
	my $tag=$token->[1];
	if (!$description) {
	    $description=&Apache::lonxml::description($token);
	    if (!$description) { $description="&lt;$tag&gt;"; }
	}
	$result.= &start_table($token)."<tr><td>$description</td>
                      <td>Delete".
		      &deletelist($target,$token)
		      ."</td>
                       <td>".
		       &insertlist($target,$token);
#<td>". 
#  &movebuttons($target,$token).
#    "</tr><tr><td colspan=\"3\">\n";
	my @help = Apache::lonxml::helpinfo($token);
	if ($help[0]) {
	    $result .= '</td><td align="right" valign="top">' .
		Apache::loncommon::help_open_topic(@help);
	} else { $result .= "</td><td>&nbsp;"; }
	$result .= &end_row().&start_spanning_row();
    }
    return $result;
}

sub tag_end {
    my ($target,$token,$description) = @_;
    my $result='';
    if ($target eq 'edit') {
	$result.="</td></tr>".&end_table()."\n";
    }
    return $result;
}

sub start_table {
    my ($token)=@_;
    my $tag = $token->[1];
    my $tagnum;
    foreach my $namespace (reverse @Apache::lonxml::namespace) {
	my $testtag=$namespace.'::'.$tag;
	$tagnum=$Apache::lonxml::insertlist{"$testtag.num"};
	if (defined($tagnum)) { last; }
    }
    if (!defined ($tagnum)) {$tagnum=$Apache::lonxml::insertlist{"$tag.num"};}
    my $color = $Apache::lonxml::insertlist{"$tagnum.color"};
    if (!defined($color)) {
	$color = $Apache::edit::colorlist[$Apache::edit::colordepth];
    }
    $Apache::edit::colordepth++;
    push(@Apache::edit::inserttag,$token->[1]);
    my $result='<div align="right">';
    $result.='<table bgcolor="'.$color.'" width="97%" border="0" cellspacing="5" cellpadding="3">';
    return $result;
}

sub end_table {
    $Apache::edit::colordepth--;
    my $result='</table></div>';
    $result.="<table><tr><td>";

    my ($tagname,$closingtag);
    if (defined($Apache::edit::inserttag[-2])) {
	$tagname=$Apache::edit::inserttag[-2];
    } else {$tagname='problem';}
    if (defined($Apache::edit::inserttag[-1])) {
	$closingtag=$Apache::edit::inserttag[-1];
    }
    $result.=&innerinsertlist('edit',$tagname,$closingtag).
	"</td></tr></table>";
    pop(@Apache::edit::inserttag);
    return $result;
}

sub start_spanning_row { return '<tr><td colspan="4" bgcolor="#DDDDDD">';}
sub start_row          { return '<tr><td bgcolor="#DDDDDD">';            }
sub end_row            { return '</td></tr>';          }

sub movebuttons {
    my ($target,$token) = @_;
    my $result='<input type="submit" name="moveup.'.
	$Apache::lonxml::curdepth.'" value="Move Up" />';
    $result.='<input type="submit" name="movedown.'.
	$Apache::lonxml::curdepth.'" value="Move Down" />';
    return $result;
}

sub deletelist {
    my ($target,$token) = @_;
    my $result = "<select name=\"delete_$Apache::lonxml::curdepth\">
<option></option>
<option>Yes</option>
</select>";
    return $result;
}

sub handle_delete {
    if (!$env{"form.delete_$Apache::lonxml::curdepth"}) { return ''; }
    my ($space,$target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $result=0;
    if ($space) {
	my $sub1="$space\:\:delete_$token->[1]";
	{
	    no strict 'refs';
	    if (defined &$sub1) {
		$result=&$sub1($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
	    }
	}
    }
    if (!$result) {
	my $endtag='/'.$token->[1];
	my $bodytext=&Apache::lonxml::get_all_text($endtag,$parser);
	$$parser['-1']->get_token();
	&Apache::lonxml::debug("Deleting :$bodytext: for $token->[1]");
	&Apache::lonxml::end_tag($tagstack,$parstack,$token);
    }
    return 1;
}

sub get_insert_list {
    my ($tagname) = @_;
    my $result='';
    my @tagnums= ();
    #&Apache::lonxml::debug("keys ".join("\n",sort(keys(%Apache::lonxml::insertlist))));
    if ($Apache::lonxml::insertlist{"$tagname.which"}) {
	push (@tagnums, @{ $Apache::lonxml::insertlist{"$tagname.which"} });
    }
    foreach my $namespace (@Apache::lonxml::namespace) {
	if ($Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"}) {
	    push (@tagnums, @{ $Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"} });
	}
    }
    if (@tagnums) {
	my %options;
	foreach my $tagnum (@tagnums) {
	    my $descrip=$Apache::lonxml::insertlist{"$tagnum.description"};
	    $options{$descrip} ="<option value=\"$tagnum\">".
		$descrip."</option>\n";
	}
	foreach my $option (sort(keys(%options))) {$result.=$options{$option};}
	if ($result) { $result='<option selected="selected"></option>'.$result; }
    }
    return $result;
}

sub insertlist {
    my ($target,$token) = @_;
    return &innerinsertlist($target,$token->[1]);
}

sub innerinsertlist {
    my ($target,$tagname,$closingtag) = @_;
    my $result;
    my $after='';
    if ($closingtag) {
	$after='_after_'.$closingtag; 
    }
    if ($target eq 'edit') {
	my $optionlist= &get_insert_list($tagname);
	if ($optionlist) {
	    $result = "Insert:
            <select name=\"insert$after\_$Apache::lonxml::curdepth\">
                  $optionlist
            </select>"
	} else {
	    $result="&nbsp;";
	}
    }
    return $result;
}

sub handle_insert {
    if ($env{"form.insert_$Apache::lonxml::curdepth"} eq '') { return ''; }
    my $result;
    my $tagnum = $env{"form.insert_$Apache::lonxml::curdepth"};
    my $func=$Apache::lonxml::insertlist{"$tagnum.function"};
    if ($func eq 'default') {
	my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
	my $namespace;
	if ($newtag =~ /::/) { ($namespace,$newtag) = split(/::/,$newtag); }
	$result.="\n<$newtag>\n</$newtag>";
    } else {
	if (defined(&$func)) {
	    {
		no strict 'refs';
		$result.=&$func();
	    }
	} else {
	    my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
	    &Apache::lonxml::error("Unable to insert tag ".$Apache::lonxml::curdepth." ($tagnum) $newtag, func was not defined.");
	}
    }
    return $result;
}

sub handle_insertafter {
    my $tagname=shift;
    if ($env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"} eq '')
    { return ''; }
    my $result;
    my $tagnum =$env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"};
    my $func=$Apache::lonxml::insertlist{"$tagnum.function"};
    if ($func eq 'default') {
	my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
	my $namespace;
	if ($newtag =~ /::/) { ($namespace,$newtag) = split(/::/,$newtag); }
	$result.="\n<$newtag>\n</$newtag>";
    } else {
	if (defined(&$func)) {
	    {
		no strict 'refs';
		$result.=&$func();
	    }
	} else {
	    my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
	    &Apache::lonxml::error("Unable to insert (after) tag $newtag, $func was not defined. ($tagname $tagnum)");
	}
    }
    return $result;
}

sub insert_img {
    return '
    <img />';
}

sub insert_responseparam {
    return '
    <responseparam />';
}

sub insert_parameter {
    return '
    <parameter />';
}

sub insert_formularesponse {
    return '
<formularesponse answer="" samples="">
    <responseparam description="Numerical Tolerance" type="tolerance" default="0.00001" name="tol" />
    <textline size="25"/>
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</formularesponse>';
}

sub insert_numericalresponse {
    return '
<numericalresponse answer="">
<responseparam type="tolerance" default="5%" name="tol" description="Numerical Tolerance" />
<responseparam name="sig" type="int_range,0-16" default="0,15" description="Significant Figures" />
    <textline />
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</numericalresponse>';
}

sub insert_stringresponse {
    return '
<stringresponse answer="" type="">
    <textline />
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</stringresponse>';
}

sub insert_essayresponse {
    return '
<essayresponse>
    <textfield></textfield>
</essayresponse>';
}

sub insert_imageresponse {
    return '
<imageresponse max="1">
    <foilgroup>
      <foil>
      </foil>
    </foilgroup>
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</imageresponse>';
}

sub insert_optionresponse {
    return '
<optionresponse max="10">
    <foilgroup options="">
      <foil>
         <startouttext /><endouttext />
      </foil>
    </foilgroup>
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</optionresponse>';
}

sub insert_organicresponse {
    return '
<organicresponse>
    <textline />
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</organicresponse>';
}

sub insert_organicstructure {
    return '
<organicstructure />
';
}

sub insert_radiobuttonresponse {
    return '
<radiobuttonresponse max="10">
    <foilgroup>
      <foil>
         <startouttext /><endouttext />
      </foil>
    </foilgroup>
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</radiobuttonresponse>';
}

sub insert_reactionresponse {
    return '
<reactionresponse>
    <textline />
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</reactionresponse>';
}

sub insert_rankresponse {
    return '
<rankresponse max="10">
    <foilgroup options="">
      <foil>
         <startouttext /><endouttext />
      </foil>
    </foilgroup>
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</rankresponse>';
}

sub insert_matchresponse {
    return '
<matchresponse max="10">
    <foilgroup options="">
      <itemgroup>
      </itemgroup>
      <foil>
         <startouttext /><endouttext />
      </foil>
    </foilgroup>
    <hintgroup>
    <startouttext /><endouttext />
    </hintgroup>
</matchresponse>';
}

sub insert_displayduedate { return '<displayduedate />'; }
sub insert_displaytitle   { return '<displaytitle />'; }
sub insert_hintpart {
    return '
<hintpart on="default">
    <startouttext/><endouttext />
</hintpart>';
}

sub insert_hintgroup {
  return '
<hintgroup>
    <startouttext /><endouttext />
</hintgroup>';
}

sub insert_numericalhint {
    return '
<numericalhint>
</numericalhint>';
}

sub insert_stringhint {
    return '
<stringhint>
</stringhint>';
}

sub insert_formulahint {
    return '
<formulahint>
</formulahint>';
}

sub insert_radiobuttonhint {
    return '
<radiobuttonhint>
</radiobuttonhint>';
}

sub insert_optionhint {
    return '
<optionhint>
</optionhint>';
}

sub insert_startouttext {
    return "<startouttext /><endouttext />";
}

sub insert_script {
    return "\n<script type=\"loncapa/perl\"></script>";
}

sub textarea_sizes {
    my ($data)=@_;
    my $count=0;
    my $maxlength=-1;
    foreach (split ("\n", $$data)) {
	$count+=int(length($_)/79);
	$count++;
	if (length($_) > $maxlength) { $maxlength = length($_); }
    }
    my $rows = $count;
    my $cols = $maxlength;
    return ($rows,$cols);
}

sub editline {
    my ($tag,$data,$description,$size)=@_;
    $data=&HTML::Entities::encode($data,'<>&"');
    if ($description) { $description="<br />".$description."<br />"; }
    my $result = <<"END";
$description
<input type="text" name="homework_edit_$Apache::lonxml::curdepth" 
       value="$data" size="$size" />
END
    return $result;
}

sub editfield {
    my ($tag,$data,$description,$minwidth,$minheight,$usehtmlarea)=@_;

    my ($rows,$cols)=&textarea_sizes(\$data);
    if (&Apache::lonhtmlcommon::htmlareabrowser() &&
	!&Apache::lonhtmlcommon::htmlareablocked()) {
	$rows+=7;      # make room for HTMLarea
	$minheight+=7; # make room for HTMLarea
    }
    if ($cols > 80) { $cols = 80; }
    if ($cols < $minwidth ) { $cols = $minwidth; }
    if ($rows < $minheight) { $rows = $minheight; }
    if ($description) { $description="<br />".$description."<br />"; }
    if ($usehtmlarea) {
	push @Apache::lonxml::htmlareafields,'homework_edit_'.
	    $Apache::lonxml::curdepth;
    }
    return $description."\n".'&nbsp;&nbsp;&nbsp;<textarea style="width:100%" rows="'.$rows.
	'" cols="'.$cols.'" name="homework_edit_'.
	$Apache::lonxml::curdepth.'" id="homework_edit_'.
	$Apache::lonxml::curdepth.'">'.
	&HTML::Entities::encode($data,'<>&"').'</textarea>'.
	($usehtmlarea?&Apache::lonhtmlcommon::spelllink('lonhomework',
			 'homework_edit_'.$Apache::lonxml::curdepth):'')."\n";
}

sub modifiedfield {
    my ($endtag,$parser) = @_;
    my $result;
#  foreach my $envkey (sort keys %env) {
#    &Apache::lonxml::debug("$envkey ---- $env{$envkey}");
#  }
#  &Apache::lonxml::debug("I want homework_edit_$Apache::lonxml::curdepth");
#  &Apache::lonxml::debug($env{"form.homework_edit_$Apache::lonxml::curdepth"});
    $result=$env{"form.homework_edit_$Apache::lonxml::curdepth"};
    my $bodytext=&Apache::lonxml::get_all_text($endtag,$parser);
    # textareas throw away intial \n 
    if ($bodytext=~/^\n/) { $result="\n".$result; }
    return $result;
}

# Returns a 1 if the token has been modified and you should rebuild the tag
# side-effects, will modify the $token if new values are found
sub get_new_args {
    my ($token,$parstack,$safeeval,@args)=@_;
    my $rebuild=0;
    foreach my $arg (@args) {
	#just want the string that it was set to
	my $value=$token->[2]->{$arg};
	my $element=&html_element_name($arg);
	my $newvalue=$env{"form.$element"};
	&Apache::lonxml::debug("for:$arg: cur is :$value: new is :$newvalue:");
	if (defined($newvalue) && $value ne $newvalue) {
	    if (ref($newvalue) eq 'ARRAY') {
		$token->[2]->{$arg}=join(',',@$newvalue);
	    } else {
		$token->[2]->{$arg}=$newvalue;
	    }
	    $rebuild=1;
	} elsif (!defined($newvalue) && defined($value)) {
	    delete($token->[2]->{$arg});
	    $rebuild=1;
	}
    }
    return $rebuild;
}

# looks for /> on start tags
sub rebuild_tag {
    my ($token) = @_;
    my $result;
    if ($token->[0] eq 'S') {
	$result = '<'.$token->[1];
	while (my ($key,$val)= each(%{$token->[2]})) {
	    $val=~s:^\s+|\s+$::g;
	    $val=~s:"::g; #"
	    &Apache::lonxml::debug("setting :$key: to  :$val:");
	    $result.=' '.$key.'="'.$val.'"';
	}
	if ($token->[4] =~ m:/>$:) {
	    $result.=' />';
	} else {
	    $result.='>';
	}
    } elsif ( $token->[0] eq 'E' ) {
	$result = '</'.$token->[1].'>';
    }
    return $result;
}

sub html_element_name {
    my ($name) = @_;
    return $name.'_'.$Apache::lonxml::curdepth;
}

sub hidden_arg {
    my ($name,$token) = @_;
    my $result;
    my $arg=$token->[2]{$name};
    $result='<input name="'.&html_element_name($name).
	'" type="hidden" value="'.$arg.'" />';
    return $result;
}

sub checked_arg {
    my ($description,$name,$list,$token) = @_;
    my $result;
    my $optionlist="";
    my $allselected=$token->[2]{$name};
    $result=&mt($description);
    foreach my $option (@$list) {
	my ($value,$text);
	if ( ref($option) eq 'ARRAY') {
	    $value='value="'.$$option[0].'"';
	    $text=$$option[1];
	    $option=$$option[0];
	} else {
	    $text=$option;
	    $value='value="'.$option.'"';
	}
	$result.="<nobr><input type='checkbox' $value name='".
	    &html_element_name($name)."'";
	foreach my $selected (split(/,/,$allselected)) {
	    if ( $selected eq $option ) {
		$result.=" checked='checked' ";
		last;
	    }
	}
	$result.=" />$text</nobr>\n";
    }
    return $result;
}

sub text_arg {
    my ($description,$name,$token,$size) = @_;
    my $result;
    if (!defined $size) { $size=20; }
    my $arg=$token->[2]{$name};
    $result=&mt($description).'&nbsp;<input name="'.&html_element_name($name).
	'" type="text" value="'.$arg.'" size="'.$size.'" />';
    return '<nobr>'.$result.'</nobr>';
}

sub select_arg {
    my ($description,$name,$list,$token) = @_;
    my $result;
    my $optionlist="";
    my $selected=$token->[2]{$name};
    foreach my $option (@$list) {
	my ($text,$value);
	if ( ref($option) eq 'ARRAY') {
	    $value='value="'.&HTML::Entities::encode($$option[0]).'"';
	    $text=$$option[1];
	    $option=$$option[0];
	} else {
	    $text=$option;
	    $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"';
	}
	if ( $selected eq $option ) {
	    $optionlist.="<option $value selected=\"selected\">$text</option>\n";
	} else {
	    $optionlist.="<option $value >$text</option>\n";
	}
    }
    $result.='<nobr>'.$description.'&nbsp;<select name="'.
	&html_element_name($name).'">
       '.$optionlist.'
      </select></nobr>';
    return $result;
}

sub select_or_text_arg {
    my ($description,$name,$list,$token,$size) = @_;
    my $result;
    my $optionlist="";
    my $found=0;
    my $selected=$token->[2]{$name};
    foreach my $option (@$list) {
	my ($text,$value);
	if ( ref($option) eq 'ARRAY') {
	    $value='value="'.&HTML::Entities::encode($$option[0]).'"';
	    $text=$$option[1];
	    $option=$$option[0];
	} else {
	    $text=$option;
	    $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"';
	}
	if ( $selected eq $option ) {
	    $optionlist.="<option $value selected=\"selected\">$text</option>\n";
	    $found=1;
	} else {
	    $optionlist.="<option $value>$text</option>\n";
	}
    }
    $optionlist.="<option value=\"TYPEDINVALUE\"".
 	((!$found)?' selected="selected"':'').
 	">".&mt('Type-in value')."</option>\n";
#
    my $element=&html_element_name($name);
    my $selectelement='select_list_'.$element;
    my $typeinelement='type_in_'.$element;
    my $typeinvalue=($found?'':$selected);
#
    my $hiddenvalue='this.form.'.$element.'.value';
    my $selectedindex='this.form.'.$selectelement.'.selectedIndex';
    my $selectedvalue='this.form.'.$selectelement.
	     '.options['.$selectedindex.'].value';
    my $typedinvalue='this.form.'.$typeinelement.'.value';
    my $selecttypeinindex='this.form.'.$selectelement.'.options.length';
    $description=&mt($description);
#
    return (<<ENDSELECTORTYPE);
<nobr>
$description
&nbsp;<select name="$selectelement"
onChange="if ($selectedvalue!='TYPEDINVALUE') { $hiddenvalue=$selectedvalue; $typedinvalue=''; }" >
$optionlist
</select>
<input type="text" size="$size" name="$typeinelement"
       value="$typeinvalue" 
onChange="$hiddenvalue=$typedinvalue;"
onFocus="$selectedindex=$selecttypeinindex-1;" />
<input type="hidden" name="$element" value="$selected" />
</nobr>
ENDSELECTORTYPE
}

#----------------------------------------------------- image coordinates
# single image coordinates, x, y 
sub entercoords {
    my ($idx,$idy,$mode,$width,$height) = @_;
    unless ($Apache::edit::bgimgsrc) { return ''; }
    if ($idx) { $idx.='_'; }
    if ($idy) { $idy.='_'; }
    my $bgfile=&Apache::lonnet::escape(&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$Apache::edit::bgimgsrc));
    my $form    = 'lonhomework';
    my $element;
    if (! defined($mode) || $mode eq 'attribute') {
        $element = &Apache::lonnet::escape("$Apache::lonxml::curdepth");
    } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
        $element = &Apache::lonnet::escape('homework_edit_'.
                                           $Apache::lonxml::curdepth);
    }
    my $id=$Apache::lonxml::curdepth;
    my %data=("imagechoice.$id.type"      =>'point',
	      "imagechoice.$id.formname"  =>$form,
	      "imagechoice.$id.formx"     =>"$idx$element",
	      "imagechoice.$id.formy"     =>"$idy$element",
	      "imagechoice.$id.file"      =>$bgfile,
	      "imagechoice.$id.formcoord" =>$element);
    if ($height) {
	$data{"imagechoice.$id.formheight"}=$height.'_'.
	    $Apache::edit::bgimgsrccurdepth;
    }
    if ($width) {
	$data{"imagechoice.$id.formwidth"}=$width.'_'.
	    $Apache::edit::bgimgsrccurdepth;
    }
    &Apache::lonnet::appenv(%data);
    my $text="Click Coordinates";
    my $result='<a href="/adm/imagechoice?token='.$id.'" target="imagechoice">'.$text.'</a>';
    return $result;
}

# coordinates (x1,y1)-(x2,y2)...
# mode can be either box, or polygon
sub entercoord {
    my ($idx,$mode,$width,$height,$type) = @_;
    unless ($Apache::edit::bgimgsrc) { return ''; }
    my $bgfile=&Apache::lonnet::escape(&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$Apache::edit::bgimgsrc));
    my $form    = 'lonhomework';
    my $element;
    if (! defined($mode) || $mode eq 'attribute') {
        $element = &Apache::lonnet::escape("$idx\_$Apache::lonxml::curdepth");
    } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
        $element = &Apache::lonnet::escape('homework_edit_'.
                                           $Apache::lonxml::curdepth);
    }
    my $id=$Apache::lonxml::curdepth;
    my %data=("imagechoice.$id.type"      =>$type,
	      "imagechoice.$id.formname"  =>$form,
	      "imagechoice.$id.file"      =>$bgfile,
	      "imagechoice.$id.formcoord" =>$element);
    if ($height) {
	$data{"imagechoice.$id.formheight"}=$height.'_'.
	    $Apache::edit::bgimgsrccurdepth;
    }
    if ($width) {
	$data{"imagechoice.$id.formwidth"}=$width.'_'.
	    $Apache::edit::bgimgsrccurdepth;
    }
    &Apache::lonnet::appenv(%data);
    my $text="Enter Coordinates";
    if ($type eq 'polygon') { $text='Create Polygon Data'; }
    my $result='<a href="/adm/imagechoice?token='.$id.'" target="imagechoice">'.$text.'</a>';
    return $result;
}

sub deletecoorddata {
    &Apache::lonnet::delenv("imagechoice\\.");
}

#----------------------------------------------------- browse
sub browse {
    # insert a link to call up the filesystem browser (lonindexer)
    my ($id, $mode, $titleid) = @_;
    my $form    = 'lonhomework';
    my $element;
    if (! defined($mode) || $mode eq 'attribute') {
        $element = &Apache::lonnet::escape("$id\_$Apache::lonxml::curdepth");
    } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
        $element = &Apache::lonnet::escape('homework_edit_'.
                                           $Apache::lonxml::curdepth);	
    }
    my $titleelement;
    if ($titleid) {
	$titleelement=",'','','".&Apache::lonnet::escape("$titleid\_$Apache::lonxml::curdepth")."'";
    }
    my $result = <<"ENDBUTTON";
<a href=\"javascript:openbrowser('$form','$element'$titleelement)\"\>Select</a>
ENDBUTTON
    return $result;
}

#----------------------------------------------------- browse
sub search {
    # insert a link to call up the filesystem browser (lonindexer)
    my ($id, $mode, $titleid) = @_;
    my $form    = 'lonhomework';
    my $element;
    if (! defined($mode) || $mode eq 'attribute') {
        $element = &Apache::lonnet::escape("$id\_$Apache::lonxml::curdepth");
    } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
        $element = &Apache::lonnet::escape('homework_edit_'.
                                           $Apache::lonxml::curdepth);
    }
    my $titleelement;
    if ($titleid) {
	$titleelement=",'".&Apache::lonnet::escape("$titleid\_$Apache::lonxml::curdepth")."'";
    }
    my $result = <<"ENDBUTTON";
<a href=\"javascript:opensearcher('$form','$element'$titleelement)\"\>Search</a>
ENDBUTTON
    return $result;
}


1;
__END__

=head1 NAME

Apache::edit - edit mode helpers

=head1 SYNOPSIS

Invoked by many homework and xml related modules.

 &Apache::edit::SUBROUTINENAME(ARGUMENTS);

=head1 INTRODUCTION

This module outputs HTML syntax helpful for the rendering of edit
mode interfaces.

This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.

=head1 HANDLER SUBROUTINE

There is no handler subroutine.

=head1 OTHER SUBROUTINES

=over 4

=item *

initialize_edit() : initialize edit (set colordepth to zero)

=item *

tag_start($target,$token,$description) : provide deletion and insertion lists
for the manipulation of a start tag; return a scalar string

=item *

tag_end($target,$token,$description) : ending syntax corresponding to
&tag_start. return a scalar string.

=item *

start_table($token) : start table; update colordepth; return scalar string.

=item *

end_table() : reduce color depth; end table; return scalar string

=item *

start_spanning_row() : start a new table row spanning the 'edit' environment.

=item *

start_row() : start a new table row and element. 

=item *

end_row() : end current table element and row.

=item *

movebuttons($target,$token) : move-up and move-down buttons; return scalar
string

=item *

deletelist($target,$token) : provide a yes option in an HTML select element;
return scalar string

=item *

handle_delete($space,$target,$token,$tagstack,$parstack,$parser,$safeeval,
$style) : respond to a user delete request by passing relevant stack
and array information to various rendering functions; return a scalar string

=item *

get_insert_list($token) : provide an insertion list based on possibilities
from lonxml; return a scalar string

=item *

insertlist($target,$token) : api that uses get_insert_list;
return a scalar string

=item *

handleinsert($token) : provide an insertion list based on possibilities
from lonxml; return a scalar string

=item *

get_insert_list($token) : provide an insertion list based on possibilities
from lonxml; return a scalar string

=item *
browse($elementname) : provide a link which will open up the filesystem
browser (lonindexer) and, once a file is selected, place the result in
the form element $elementname.

=item *
search($elementname) : provide a link which will open up the filesystem
searcher (lonsearchcat) and, once a file is selected, place the result in
the form element $elementname.

=item *
editline(tag,data,description,size): Provide a <input type="text" ../> for
single-line text entry.  This is to be used for text enclosed by tags, not
arguements/parameters associated with a tag.

=back

incomplete...

=cut

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