File:  [LON-CAPA] / loncom / homework / edit.pm
Revision 1.98: download - view: text, annotated - select for diffs
Thu Dec 15 23:20:55 2005 UTC (18 years, 4 months ago) by albertel
Branches: MAIN
CVS tags: HEAD
- detect in Edit and EditXML screns if there are changes and throw up a 'unsaved changes warning' BUG#4469

    1: # The LearningOnline Network with CAPA 
    2: # edit mode helpers
    3: #
    4: # $Id: edit.pm,v 1.98 2005/12/15 23:20:55 albertel Exp $
    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: #
   28: 
   29: package Apache::edit; 
   30: 
   31: use strict;
   32: use Apache::lonnet;
   33: use HTML::Entities();
   34: use Apache::lonlocal;
   35: 
   36: # Global Vars
   37: # default list of colors to use in editing
   38: @Apache::edit::colorlist=('#ffffff','#ff0000','#00ff00','#0000ff','#0ff000','#000ff0','#f0000f');
   39: # depth of nesting of edit
   40: $Apache::edit::colordepth=0;
   41: @Apache::edit::inserttag=();
   42: # image-type responses: active background image and curdepth at definition
   43: $Apache::edit::bgimgsrc='';
   44: $Apache::edit::bgimgsrccurdepth='';
   45: 
   46: sub initialize_edit {
   47:     $Apache::edit::colordepth=0;
   48:     @Apache::edit::inserttag=();
   49: }
   50: 
   51: sub tag_start {
   52:     my ($target,$token,$description) = @_;
   53:     my $result='';
   54:     if ($target eq "edit") {
   55: 	my $tag=$token->[1];
   56: 	if (!$description) {
   57: 	    $description=&Apache::lonxml::description($token);
   58: 	    if (!$description) { $description="<$tag>"; }
   59: 	}
   60: 	$result.= &start_table($token)."<tr><td>$description</td>
   61:                       <td>Delete".
   62: 		      &deletelist($target,$token)
   63: 		      ."</td>
   64:                        <td>".
   65: 		       &insertlist($target,$token);
   66: #<td>". 
   67: #  &movebuttons($target,$token).
   68: #    "</tr><tr><td colspan=\"3\">\n";
   69: 	my @help = Apache::lonxml::helpinfo($token);
   70: 	if ($help[0]) {
   71: 	    $result .= '</td><td align="right" valign="top">' .
   72: 		Apache::loncommon::help_open_topic(@help);
   73: 	} else { $result .= "</td><td>&nbsp;"; }
   74: 	$result .= &end_row().&start_spanning_row();
   75:     }
   76:     return $result;
   77: }
   78: 
   79: sub tag_end {
   80:     my ($target,$token,$description) = @_;
   81:     my $result='';
   82:     if ($target eq 'edit') {
   83: 	$result.="</td></tr>".&end_table()."\n";
   84:     }
   85:     return $result;
   86: }
   87: 
   88: sub start_table {
   89:     my ($token)=@_;
   90:     my $tag = $token->[1];
   91:     my $tagnum;
   92:     foreach my $namespace (reverse @Apache::lonxml::namespace) {
   93: 	my $testtag=$namespace.'::'.$tag;
   94: 	$tagnum=$Apache::lonxml::insertlist{"$testtag.num"};
   95: 	&Apache::lonxml::debug(" $testtag ");
   96: 	if (defined($tagnum)) { last; }
   97:     }
   98:     if (!defined ($tagnum)) {$tagnum=$Apache::lonxml::insertlist{"$tag.num"};}
   99:     my $color = $Apache::lonxml::insertlist{"$tagnum.color"};
  100:     &Apache::lonxml::debug(" $tagnum -- $color");
  101:     if (!defined($color)) {
  102: 	$color = $Apache::edit::colorlist[$Apache::edit::colordepth];
  103:     }
  104:     $Apache::edit::colordepth++;
  105:     push(@Apache::edit::inserttag,$token->[1]);
  106:     my $result='<div align="right">';
  107:     $result.='<table bgcolor="'.$color.'" width="97%" border="0" cellspacing="5" cellpadding="3">';
  108:     return $result;
  109: }
  110: 
  111: sub end_table {
  112:     $Apache::edit::colordepth--;
  113:     my $result='</table></div>';
  114:     $result.='<div align="left"><table><tr><td>';
  115: 
  116:     my ($tagname,$closingtag);
  117:     if (defined($Apache::edit::inserttag[-2])) {
  118: 	$tagname=$Apache::edit::inserttag[-2];
  119:     } else {$tagname='problem';}
  120:     if (defined($Apache::edit::inserttag[-1])) {
  121: 	$closingtag=$Apache::edit::inserttag[-1];
  122:     }
  123:     $result.=&innerinsertlist('edit',$tagname,$closingtag).
  124: 	"</td></tr></table></div>";
  125:     pop(@Apache::edit::inserttag);
  126:     return $result;
  127: }
  128: 
  129: sub start_spanning_row { return '<tr><td colspan="4" bgcolor="#DDDDDD">';}
  130: sub start_row          { return '<tr><td bgcolor="#DDDDDD">';            }
  131: sub end_row            { return '</td></tr>';          }
  132: 
  133: sub movebuttons {
  134:     my ($target,$token) = @_;
  135:     my $result='<input type="submit" name="moveup.'.
  136: 	$Apache::lonxml::curdepth.'" value="Move Up" />';
  137:     $result.='<input type="submit" name="movedown.'.
  138: 	$Apache::lonxml::curdepth.'" value="Move Down" />';
  139:     return $result;
  140: }
  141: 
  142: sub deletelist {
  143:     my ($target,$token) = @_;
  144:     my $result = "<select name=\"delete_$Apache::lonxml::curdepth\">
  145: <option></option>
  146: <option>Yes</option>
  147: </select>";
  148:     return $result;
  149: }
  150: 
  151: sub handle_delete {
  152:     if (!$env{"form.delete_$Apache::lonxml::curdepth"}) { return ''; }
  153:     my ($space,$target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  154:     my $result=0;
  155:     if ($space) {
  156: 	my $sub1="$space\:\:delete_$token->[1]";
  157: 	{
  158: 	    no strict 'refs';
  159: 	    if (defined &$sub1) {
  160: 		$result=&$sub1($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  161: 	    }
  162: 	}
  163:     }
  164:     if (!$result) {
  165: 	my $endtag='/'.$token->[1];
  166: 	my $bodytext=&Apache::lonxml::get_all_text($endtag,$parser,$style);
  167: 	$$parser['-1']->get_token();
  168: 	&Apache::lonxml::debug("Deleting :$bodytext: for $token->[1]");
  169: 	&Apache::lonxml::end_tag($tagstack,$parstack,$token);
  170:     }
  171:     return 1;
  172: }
  173: 
  174: sub get_insert_list {
  175:     my ($tagname) = @_;
  176:     my $result='';
  177:     my @tagnums= ();
  178:     #&Apache::lonxml::debug("keys ".join("\n",sort(keys(%Apache::lonxml::insertlist))));
  179:     if ($Apache::lonxml::insertlist{"$tagname.which"}) {
  180: 	push (@tagnums, @{ $Apache::lonxml::insertlist{"$tagname.which"} });
  181:     }
  182:     foreach my $namespace (@Apache::lonxml::namespace) {
  183: 	if ($Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"}) {
  184: 	    push (@tagnums, @{ $Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"} });
  185: 	}
  186:     }
  187:     if (@tagnums) {
  188: 	my %options;
  189: 	foreach my $tagnum (@tagnums) {
  190: 	    my $descrip=$Apache::lonxml::insertlist{"$tagnum.description"};
  191: 	    $options{$descrip} ="<option value=\"$tagnum\">".
  192: 		$descrip."</option>\n";
  193: 	}
  194: 	foreach my $option (sort(keys(%options))) {$result.=$options{$option};}
  195: 	if ($result) { $result='<option selected="selected"></option>'.$result; }
  196:     }
  197:     return $result;
  198: }
  199: 
  200: sub insertlist {
  201:     my ($target,$token) = @_;
  202:     return &innerinsertlist($target,$token->[1]);
  203: }
  204: 
  205: sub innerinsertlist {
  206:     my ($target,$tagname,$closingtag) = @_;
  207:     my $result;
  208:     my $after='';
  209:     if ($closingtag) {
  210: 	$after='_after_'.$closingtag; 
  211:     }
  212:     if ($target eq 'edit') {
  213: 	my $optionlist= &get_insert_list($tagname);
  214: 	if ($optionlist) {
  215: 	    $result = "Insert:
  216:             <select name=\"insert$after\_$Apache::lonxml::curdepth\">
  217:                   $optionlist
  218:             </select>"
  219: 	} else {
  220: 	    $result="&nbsp;";
  221: 	}
  222:     }
  223:     return $result;
  224: }
  225: 
  226: sub handle_insert {
  227:     if ($env{"form.insert_$Apache::lonxml::curdepth"} eq '') { return ''; }
  228:     my $result;
  229:     my $tagnum = $env{"form.insert_$Apache::lonxml::curdepth"};
  230:     my $func=$Apache::lonxml::insertlist{"$tagnum.function"};
  231:     if ($func eq 'default') {
  232: 	my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
  233: 	my $namespace;
  234: 	if ($newtag =~ /::/) { ($namespace,$newtag) = split(/::/,$newtag); }
  235: 	$result.="\n<$newtag>\n</$newtag>";
  236:     } else {
  237: 	if (defined(&$func)) {
  238: 	    {
  239: 		no strict 'refs';
  240: 		$result.=&$func();
  241: 	    }
  242: 	} else {
  243: 	    my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
  244: 	    &Apache::lonxml::error("Unable to insert tag ".$Apache::lonxml::curdepth." ($tagnum) $newtag, func was not defined.");
  245: 	}
  246:     }
  247:     return $result;
  248: }
  249: 
  250: sub handle_insertafter {
  251:     my $tagname=shift;
  252:     if ($env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"} eq '')
  253:     { return ''; }
  254:     my $result;
  255:     my $tagnum =$env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"};
  256:     my $func=$Apache::lonxml::insertlist{"$tagnum.function"};
  257:     if ($func eq 'default') {
  258: 	my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
  259: 	my $namespace;
  260: 	if ($newtag =~ /::/) { ($namespace,$newtag) = split(/::/,$newtag); }
  261: 	$result.="\n<$newtag>\n</$newtag>";
  262:     } else {
  263: 	if (defined(&$func)) {
  264: 	    {
  265: 		no strict 'refs';
  266: 		$result.=&$func();
  267: 	    }
  268: 	} else {
  269: 	    my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
  270: 	    &Apache::lonxml::error("Unable to insert (after) tag $newtag, $func was not defined. ($tagname $tagnum)");
  271: 	}
  272:     }
  273:     return $result;
  274: }
  275: 
  276: sub insert_img {
  277:     return '
  278:     <img />';
  279: }
  280: 
  281: sub insert_responseparam {
  282:     return '
  283:     <responseparam />';
  284: }
  285: 
  286: sub insert_parameter {
  287:     return '
  288:     <parameter />';
  289: }
  290: 
  291: sub insert_formularesponse {
  292:     return '
  293: <formularesponse answer="" samples="">
  294:     <responseparam description="Numerical Tolerance" type="tolerance" default="0.00001" name="tol" />
  295:     <textline size="25"/>
  296:     <hintgroup>
  297:     <startouttext /><endouttext />
  298:     </hintgroup>
  299: </formularesponse>';
  300: }
  301: 
  302: sub insert_numericalresponse {
  303:     return '
  304: <numericalresponse answer="">
  305: <responseparam type="tolerance" default="5%" name="tol" description="Numerical Tolerance" />
  306: <responseparam name="sig" type="int_range,0-16" default="0,15" description="Significant Figures" />
  307:     <textline />
  308:     <hintgroup>
  309:     <startouttext /><endouttext />
  310:     </hintgroup>
  311: </numericalresponse>';
  312: }
  313: 
  314: sub insert_customresponse {
  315:     return '
  316: <customresponse>
  317:     <answer type="loncapa/perl">
  318:     </answer>
  319:     <textline />
  320:     <hintgroup>
  321:     <startouttext /><endouttext />
  322:     </hintgroup>
  323: </customresponse>';
  324: }
  325: 
  326: sub insert_customresponse_answer {
  327:     return '
  328:     <answer type="loncapa/perl">
  329:     </answer>
  330: ';
  331: }
  332: 
  333: sub insert_stringresponse {
  334:     return '
  335: <stringresponse answer="" type="">
  336:     <textline />
  337:     <hintgroup>
  338:     <startouttext /><endouttext />
  339:     </hintgroup>
  340: </stringresponse>';
  341: }
  342: 
  343: sub insert_essayresponse {
  344:     return '
  345: <essayresponse>
  346:     <textfield></textfield>
  347: </essayresponse>';
  348: }
  349: 
  350: sub insert_imageresponse {
  351:     return '
  352: <imageresponse max="1">
  353:     <foilgroup>
  354:       <foil>
  355:       </foil>
  356:     </foilgroup>
  357:     <hintgroup>
  358:     <startouttext /><endouttext />
  359:     </hintgroup>
  360: </imageresponse>';
  361: }
  362: 
  363: sub insert_optionresponse {
  364:     return '
  365: <optionresponse max="10">
  366:     <foilgroup options="">
  367:       <foil>
  368:          <startouttext /><endouttext />
  369:       </foil>
  370:     </foilgroup>
  371:     <hintgroup>
  372:     <startouttext /><endouttext />
  373:     </hintgroup>
  374: </optionresponse>';
  375: }
  376: 
  377: sub insert_organicresponse {
  378:     return '
  379: <organicresponse>
  380:     <textline />
  381:     <hintgroup>
  382:     <startouttext /><endouttext />
  383:     </hintgroup>
  384: </organicresponse>';
  385: }
  386: 
  387: sub insert_organicstructure {
  388:     return '
  389: <organicstructure />
  390: ';
  391: }
  392: 
  393: sub insert_radiobuttonresponse {
  394:     return '
  395: <radiobuttonresponse max="10">
  396:     <foilgroup>
  397:       <foil>
  398:          <startouttext /><endouttext />
  399:       </foil>
  400:     </foilgroup>
  401:     <hintgroup>
  402:     <startouttext /><endouttext />
  403:     </hintgroup>
  404: </radiobuttonresponse>';
  405: }
  406: 
  407: sub insert_reactionresponse {
  408:     return '
  409: <reactionresponse>
  410:     <textline />
  411:     <hintgroup>
  412:     <startouttext /><endouttext />
  413:     </hintgroup>
  414: </reactionresponse>';
  415: }
  416: 
  417: sub insert_rankresponse {
  418:     return '
  419: <rankresponse max="10">
  420:     <foilgroup options="">
  421:       <foil>
  422:          <startouttext /><endouttext />
  423:       </foil>
  424:     </foilgroup>
  425:     <hintgroup>
  426:     <startouttext /><endouttext />
  427:     </hintgroup>
  428: </rankresponse>';
  429: }
  430: 
  431: sub insert_matchresponse {
  432:     return '
  433: <matchresponse max="10">
  434:     <foilgroup options="">
  435:       <itemgroup>
  436:       </itemgroup>
  437:       <foil>
  438:          <startouttext /><endouttext />
  439:       </foil>
  440:     </foilgroup>
  441:     <hintgroup>
  442:     <startouttext /><endouttext />
  443:     </hintgroup>
  444: </matchresponse>';
  445: }
  446: 
  447: sub insert_displayduedate { return '<displayduedate />'; }
  448: sub insert_displaytitle   { return '<displaytitle />'; }
  449: sub insert_hintpart {
  450:     return '
  451: <hintpart on="default">
  452:     <startouttext/><endouttext />
  453: </hintpart>';
  454: }
  455: 
  456: sub insert_hintgroup {
  457:   return '
  458: <hintgroup>
  459:     <startouttext /><endouttext />
  460: </hintgroup>';
  461: }
  462: 
  463: sub insert_numericalhint {
  464:     return '
  465: <numericalhint>
  466: </numericalhint>';
  467: }
  468: 
  469: sub insert_stringhint {
  470:     return '
  471: <stringhint>
  472: </stringhint>';
  473: }
  474: 
  475: sub insert_formulahint {
  476:     return '
  477: <formulahint>
  478: </formulahint>';
  479: }
  480: 
  481: sub insert_radiobuttonhint {
  482:     return '
  483: <radiobuttonhint>
  484: </radiobuttonhint>';
  485: }
  486: 
  487: sub insert_optionhint {
  488:     return '
  489: <optionhint>
  490: </optionhint>';
  491: }
  492: 
  493: sub insert_startouttext {
  494:     return "<startouttext /><endouttext />";
  495: }
  496: 
  497: sub insert_script {
  498:     return "\n<script type=\"loncapa/perl\"></script>";
  499: }
  500: 
  501: sub js_change_detection {
  502:     my $unsaved=&mt("There are unsaved changes");
  503:     return (<<SCRIPT);
  504: <script type="text/javascript">
  505: var clean = true;
  506: var is_submit = false;
  507: function compareForm(event_) {
  508:         if (!event_ && window.event) {
  509:           event_ = window.event;
  510:         }
  511: 	if (!is_submit && !clean) {
  512:             event_.returnValue = "$unsaved";
  513:             return "$unsaved";
  514:         }
  515: }
  516: function unClean() {
  517:      clean=false;
  518: }
  519: window.onbeforeunload = compareForm;
  520: </script>
  521: SCRIPT
  522: }
  523: 
  524: sub form_change_detection {
  525:     return ' onsubmit="is_submit=true;" ';
  526: }
  527: 
  528: sub element_change_detection {
  529:     return ' onchange="unClean();" ';
  530: }
  531: 
  532: sub textarea_sizes {
  533:     my ($data)=@_;
  534:     my $count=0;
  535:     my $maxlength=-1;
  536:     foreach (split ("\n", $$data)) {
  537: 	$count+=int(length($_)/79);
  538: 	$count++;
  539: 	if (length($_) > $maxlength) { $maxlength = length($_); }
  540:     }
  541:     my $rows = $count;
  542:     my $cols = $maxlength;
  543:     return ($rows,$cols);
  544: }
  545: 
  546: sub editline {
  547:     my ($tag,$data,$description,$size)=@_;
  548:     $data=&HTML::Entities::encode($data,'<>&"');
  549:     if ($description) { $description="<br />".$description."<br />"; }
  550:     my $change_code = &element_change_detection();
  551:     my $result = <<"END";
  552: $description
  553: <input type="text" name="homework_edit_$Apache::lonxml::curdepth" 
  554:        value="$data" size="$size" $change_code />
  555: END
  556:     return $result;
  557: }
  558: 
  559: sub editfield {
  560:     my ($tag,$data,$description,$minwidth,$minheight,$usehtmlarea)=@_;
  561: 
  562:     my ($rows,$cols)=&textarea_sizes(\$data);
  563:     if (&Apache::lonhtmlcommon::htmlareabrowser() &&
  564: 	!&Apache::lonhtmlcommon::htmlareablocked()) {
  565: 	$rows+=7;      # make room for HTMLarea
  566: 	$minheight+=7; # make room for HTMLarea
  567:     }
  568:     if ($cols > 80) { $cols = 80; }
  569:     if ($cols < $minwidth ) { $cols = $minwidth; }
  570:     if ($rows < $minheight) { $rows = $minheight; }
  571:     if ($description) { $description="<br />".$description."<br />"; }
  572:     if ($usehtmlarea) {
  573: 	push @Apache::lonxml::htmlareafields,'homework_edit_'.
  574: 	    $Apache::lonxml::curdepth;
  575:     }
  576:     return $description."\n".'&nbsp;&nbsp;&nbsp;<textarea style="width:100%" rows="'.$rows.
  577: 	'" cols="'.$cols.'" name="homework_edit_'.
  578: 	$Apache::lonxml::curdepth.'" id="homework_edit_'.
  579: 	$Apache::lonxml::curdepth.'" '.&element_change_detection().'>'.
  580: 	&HTML::Entities::encode($data,'<>&"').'</textarea>'.
  581: 	($usehtmlarea?&Apache::lonhtmlcommon::spelllink('lonhomework',
  582: 			 'homework_edit_'.$Apache::lonxml::curdepth):'')."\n";
  583: }
  584: 
  585: sub modifiedfield {
  586:     my ($endtag,$parser) = @_;
  587:     my $result;
  588: #  foreach my $envkey (sort keys %env) {
  589: #    &Apache::lonxml::debug("$envkey ---- $env{$envkey}");
  590: #  }
  591: #  &Apache::lonxml::debug("I want homework_edit_$Apache::lonxml::curdepth");
  592: #  &Apache::lonxml::debug($env{"form.homework_edit_$Apache::lonxml::curdepth"});
  593:     $result=$env{"form.homework_edit_$Apache::lonxml::curdepth"};
  594:     my $bodytext=&Apache::lonxml::get_all_text($endtag,$parser);
  595:     # textareas throw away intial \n 
  596:     if ($bodytext=~/^\n/) { $result="\n".$result; }
  597:     return $result;
  598: }
  599: 
  600: # Returns a 1 if the token has been modified and you should rebuild the tag
  601: # side-effects, will modify the $token if new values are found
  602: sub get_new_args {
  603:     my ($token,$parstack,$safeeval,@args)=@_;
  604:     my $rebuild=0;
  605:     foreach my $arg (@args) {
  606: 	#just want the string that it was set to
  607: 	my $value=$token->[2]->{$arg};
  608: 	my $element=&html_element_name($arg);
  609: 	my $newvalue=$env{"form.$element"};
  610: 	&Apache::lonxml::debug("for:$arg: cur is :$value: new is :$newvalue:");
  611: 	if (defined($newvalue) && $value ne $newvalue) {
  612: 	    if (ref($newvalue) eq 'ARRAY') {
  613: 		$token->[2]->{$arg}=join(',',@$newvalue);
  614: 	    } else {
  615: 		$token->[2]->{$arg}=$newvalue;
  616: 	    }
  617: 	    $rebuild=1;
  618: 	} elsif (!defined($newvalue) && defined($value)) {
  619: 	    delete($token->[2]->{$arg});
  620: 	    $rebuild=1;
  621: 	}
  622:     }
  623:     return $rebuild;
  624: }
  625: 
  626: # looks for /> on start tags
  627: sub rebuild_tag {
  628:     my ($token) = @_;
  629:     my $result;
  630:     if ($token->[0] eq 'S') {
  631: 	$result = '<'.$token->[1];
  632: 	while (my ($key,$val)= each(%{$token->[2]})) {
  633: 	    $val=~s:^\s+|\s+$::g;
  634: 	    $val=~s:"::g; #"
  635: 	    &Apache::lonxml::debug("setting :$key: to  :$val:");
  636: 	    $result.=' '.$key.'="'.$val.'"';
  637: 	}
  638: 	if ($token->[4] =~ m:/>$:) {
  639: 	    $result.=' />';
  640: 	} else {
  641: 	    $result.='>';
  642: 	}
  643:     } elsif ( $token->[0] eq 'E' ) {
  644: 	$result = '</'.$token->[1].'>';
  645:     }
  646:     return $result;
  647: }
  648: 
  649: sub html_element_name {
  650:     my ($name) = @_;
  651:     return $name.'_'.$Apache::lonxml::curdepth;
  652: }
  653: 
  654: sub hidden_arg {
  655:     my ($name,$token) = @_;
  656:     my $result;
  657:     my $arg=$token->[2]{$name};
  658:     $result='<input name="'.&html_element_name($name).
  659: 	'" type="hidden" value="'.$arg.'" />';
  660:     return $result;
  661: }
  662: 
  663: sub checked_arg {
  664:     my ($description,$name,$list,$token) = @_;
  665:     my $result;
  666:     my $optionlist="";
  667:     my $allselected=$token->[2]{$name};
  668:     $result=&mt($description);
  669:     foreach my $option (@$list) {
  670: 	my ($value,$text);
  671: 	if ( ref($option) eq 'ARRAY') {
  672: 	    $value='value="'.$$option[0].'"';
  673: 	    $text=$$option[1];
  674: 	    $option=$$option[0];
  675: 	} else {
  676: 	    $text=$option;
  677: 	    $value='value="'.$option.'"';
  678: 	}
  679: 	$result.="<nobr><input type='checkbox' $value name='".
  680: 	    &html_element_name($name)."'";
  681: 	foreach my $selected (split(/,/,$allselected)) {
  682: 	    if ( $selected eq $option ) {
  683: 		$result.=" checked='checked' ";
  684: 		last;
  685: 	    }
  686: 	}
  687: 	$result.=&element_change_detection()." />$text</nobr>\n";
  688:     }
  689:     return $result;
  690: }
  691: 
  692: sub text_arg {
  693:     my ($description,$name,$token,$size) = @_;
  694:     my $result;
  695:     if (!defined $size) { $size=20; }
  696:     my $arg=$token->[2]{$name};
  697:     $result=&mt($description).'&nbsp;<input name="'.&html_element_name($name).
  698: 	'" type="text" value="'.$arg.'" size="'.$size.'" '.
  699: 	&element_change_detection().'/>';
  700:     return '<nobr>'.$result.'</nobr>';
  701: }
  702: 
  703: sub select_arg {
  704:     my ($description,$name,$list,$token) = @_;
  705:     my $result;
  706:     my $optionlist="";
  707:     my $selected=$token->[2]{$name};
  708:     foreach my $option (@$list) {
  709: 	my ($text,$value);
  710: 	if ( ref($option) eq 'ARRAY') {
  711: 	    $value='value="'.&HTML::Entities::encode($$option[0]).'"';
  712: 	    $text=$$option[1];
  713: 	    $option=$$option[0];
  714: 	} else {
  715: 	    $text=$option;
  716: 	    $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"';
  717: 	}
  718: 	if ( $selected eq $option ) {
  719: 	    $optionlist.="<option $value selected=\"selected\">$text</option>\n";
  720: 	} else {
  721: 	    $optionlist.="<option $value >$text</option>\n";
  722: 	}
  723:     }
  724:     $result.='<nobr>'.$description.'&nbsp;<select name="'.
  725: 	&html_element_name($name).'" '.&element_change_detection().' >
  726:        '.$optionlist.'
  727:       </select></nobr>';
  728:     return $result;
  729: }
  730: 
  731: sub select_or_text_arg {
  732:     my ($description,$name,$list,$token,$size) = @_;
  733:     my $result;
  734:     my $optionlist="";
  735:     my $found=0;
  736:     my $selected=$token->[2]{$name};
  737:     foreach my $option (@$list) {
  738: 	my ($text,$value);
  739: 	if ( ref($option) eq 'ARRAY') {
  740: 	    $value='value="'.&HTML::Entities::encode($$option[0]).'"';
  741: 	    $text=$$option[1];
  742: 	    $option=$$option[0];
  743: 	} else {
  744: 	    $text=$option;
  745: 	    $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"';
  746: 	}
  747: 	if ( $selected eq $option ) {
  748: 	    $optionlist.="<option $value selected=\"selected\">$text</option>\n";
  749: 	    $found=1;
  750: 	} else {
  751: 	    $optionlist.="<option $value>$text</option>\n";
  752: 	}
  753:     }
  754:     $optionlist.="<option value=\"TYPEDINVALUE\"".
  755:  	((!$found)?' selected="selected"':'').
  756:  	">".&mt('Type-in value')."</option>\n";
  757: #
  758:     my $change_code=&element_change_detection();
  759:     my $element=&html_element_name($name);
  760:     my $selectelement='select_list_'.$element;
  761:     my $typeinelement='type_in_'.$element;
  762:     my $typeinvalue=($found?'':$selected);
  763: #
  764:     my $hiddenvalue='this.form.'.$element.'.value';
  765:     my $selectedindex='this.form.'.$selectelement.'.selectedIndex';
  766:     my $selectedvalue='this.form.'.$selectelement.
  767: 	     '.options['.$selectedindex.'].value';
  768:     my $typedinvalue='this.form.'.$typeinelement.'.value';
  769:     my $selecttypeinindex='this.form.'.$selectelement.'.options.length';
  770:     $description=&mt($description);
  771: #
  772:     return (<<ENDSELECTORTYPE);
  773: <nobr>
  774: $description
  775: &nbsp;<select name="$selectelement"
  776: onChange="if ($selectedvalue!='TYPEDINVALUE') { $hiddenvalue=$selectedvalue; $typedinvalue=''; }" >
  777: $optionlist
  778: </select>
  779: <input type="text" size="$size" name="$typeinelement"
  780:        value="$typeinvalue" 
  781: onChange="$hiddenvalue=$typedinvalue;"
  782: onFocus="$selectedindex=$selecttypeinindex-1;" />
  783: <input type="hidden" name="$element" value="$selected" $change_code />
  784: </nobr>
  785: ENDSELECTORTYPE
  786: }
  787: 
  788: #----------------------------------------------------- image coordinates
  789: # single image coordinates, x, y 
  790: sub entercoords {
  791:     my ($idx,$idy,$mode,$width,$height) = @_;
  792:     unless ($Apache::edit::bgimgsrc) { return ''; }
  793:     if ($idx) { $idx.='_'; }
  794:     if ($idy) { $idy.='_'; }
  795:     my $bgfile=&Apache::lonnet::escape(&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$Apache::edit::bgimgsrc));
  796:     my $form    = 'lonhomework';
  797:     my $element;
  798:     if (! defined($mode) || $mode eq 'attribute') {
  799:         $element = &Apache::lonnet::escape("$Apache::lonxml::curdepth");
  800:     } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
  801:         $element = &Apache::lonnet::escape('homework_edit_'.
  802:                                            $Apache::lonxml::curdepth);
  803:     }
  804:     my $id=$Apache::lonxml::curdepth;
  805:     my %data=("imagechoice.$id.type"      =>'point',
  806: 	      "imagechoice.$id.formname"  =>$form,
  807: 	      "imagechoice.$id.formx"     =>"$idx$element",
  808: 	      "imagechoice.$id.formy"     =>"$idy$element",
  809: 	      "imagechoice.$id.file"      =>$bgfile,
  810: 	      "imagechoice.$id.formcoord" =>$element);
  811:     if ($height) {
  812: 	$data{"imagechoice.$id.formheight"}=$height.'_'.
  813: 	    $Apache::edit::bgimgsrccurdepth;
  814:     }
  815:     if ($width) {
  816: 	$data{"imagechoice.$id.formwidth"}=$width.'_'.
  817: 	    $Apache::edit::bgimgsrccurdepth;
  818:     }
  819:     &Apache::lonnet::appenv(%data);
  820:     my $text="Click Coordinates";
  821:     my $result='<a href="/adm/imagechoice?token='.$id.'" target="imagechoice">'.$text.'</a>';
  822:     return $result;
  823: }
  824: 
  825: # coordinates (x1,y1)-(x2,y2)...
  826: # mode can be either box, or polygon
  827: sub entercoord {
  828:     my ($idx,$mode,$width,$height,$type) = @_;
  829:     unless ($Apache::edit::bgimgsrc) { return ''; }
  830:     my $bgfile=&Apache::lonnet::escape(&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$Apache::edit::bgimgsrc));
  831:     my $form    = 'lonhomework';
  832:     my $element;
  833:     if (! defined($mode) || $mode eq 'attribute') {
  834:         $element = &Apache::lonnet::escape("$idx\_$Apache::lonxml::curdepth");
  835:     } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
  836:         $element = &Apache::lonnet::escape('homework_edit_'.
  837:                                            $Apache::lonxml::curdepth);
  838:     }
  839:     my $id=$Apache::lonxml::curdepth;
  840:     my %data=("imagechoice.$id.type"      =>$type,
  841: 	      "imagechoice.$id.formname"  =>$form,
  842: 	      "imagechoice.$id.file"      =>$bgfile,
  843: 	      "imagechoice.$id.formcoord" =>$element);
  844:     if ($height) {
  845: 	$data{"imagechoice.$id.formheight"}=$height.'_'.
  846: 	    $Apache::edit::bgimgsrccurdepth;
  847:     }
  848:     if ($width) {
  849: 	$data{"imagechoice.$id.formwidth"}=$width.'_'.
  850: 	    $Apache::edit::bgimgsrccurdepth;
  851:     }
  852:     &Apache::lonnet::appenv(%data);
  853:     my $text="Enter Coordinates";
  854:     if ($type eq 'polygon') { $text='Create Polygon Data'; }
  855:     my $result='<a href="/adm/imagechoice?token='.$id.'" target="imagechoice">'.$text.'</a>';
  856:     return $result;
  857: }
  858: 
  859: sub deletecoorddata {
  860:     &Apache::lonnet::delenv("imagechoice\\.");
  861: }
  862: 
  863: #----------------------------------------------------- browse
  864: sub browse {
  865:     # insert a link to call up the filesystem browser (lonindexer)
  866:     my ($id, $mode, $titleid) = @_;
  867:     my $form    = 'lonhomework';
  868:     my $element;
  869:     if (! defined($mode) || $mode eq 'attribute') {
  870:         $element = &Apache::lonnet::escape("$id\_$Apache::lonxml::curdepth");
  871:     } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
  872:         $element = &Apache::lonnet::escape('homework_edit_'.
  873:                                            $Apache::lonxml::curdepth);	
  874:     }
  875:     my $titleelement;
  876:     if ($titleid) {
  877: 	$titleelement=",'','','".&Apache::lonnet::escape("$titleid\_$Apache::lonxml::curdepth")."'";
  878:     }
  879:     my $result = <<"ENDBUTTON";
  880: <a href=\"javascript:openbrowser('$form','$element'$titleelement)\"\>Select</a>
  881: ENDBUTTON
  882:     return $result;
  883: }
  884: 
  885: #----------------------------------------------------- browse
  886: sub search {
  887:     # insert a link to call up the filesystem browser (lonindexer)
  888:     my ($id, $mode, $titleid) = @_;
  889:     my $form    = 'lonhomework';
  890:     my $element;
  891:     if (! defined($mode) || $mode eq 'attribute') {
  892:         $element = &Apache::lonnet::escape("$id\_$Apache::lonxml::curdepth");
  893:     } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
  894:         $element = &Apache::lonnet::escape('homework_edit_'.
  895:                                            $Apache::lonxml::curdepth);
  896:     }
  897:     my $titleelement;
  898:     if ($titleid) {
  899: 	$titleelement=",'".&Apache::lonnet::escape("$titleid\_$Apache::lonxml::curdepth")."'";
  900:     }
  901:     my $result = <<"ENDBUTTON";
  902: <a href=\"javascript:opensearcher('$form','$element'$titleelement)\"\>Search</a>
  903: ENDBUTTON
  904:     return $result;
  905: }
  906: 
  907: 
  908: 1;
  909: __END__
  910: 
  911: =head1 NAME
  912: 
  913: Apache::edit - edit mode helpers
  914: 
  915: =head1 SYNOPSIS
  916: 
  917: Invoked by many homework and xml related modules.
  918: 
  919:  &Apache::edit::SUBROUTINENAME(ARGUMENTS);
  920: 
  921: =head1 INTRODUCTION
  922: 
  923: This module outputs HTML syntax helpful for the rendering of edit
  924: mode interfaces.
  925: 
  926: This is part of the LearningOnline Network with CAPA project
  927: described at http://www.lon-capa.org.
  928: 
  929: =head1 HANDLER SUBROUTINE
  930: 
  931: There is no handler subroutine.
  932: 
  933: =head1 OTHER SUBROUTINES
  934: 
  935: =over 4
  936: 
  937: =item *
  938: 
  939: initialize_edit() : initialize edit (set colordepth to zero)
  940: 
  941: =item *
  942: 
  943: tag_start($target,$token,$description) : provide deletion and insertion lists
  944: for the manipulation of a start tag; return a scalar string
  945: 
  946: =item *
  947: 
  948: tag_end($target,$token,$description) : ending syntax corresponding to
  949: &tag_start. return a scalar string.
  950: 
  951: =item *
  952: 
  953: start_table($token) : start table; update colordepth; return scalar string.
  954: 
  955: =item *
  956: 
  957: end_table() : reduce color depth; end table; return scalar string
  958: 
  959: =item *
  960: 
  961: start_spanning_row() : start a new table row spanning the 'edit' environment.
  962: 
  963: =item *
  964: 
  965: start_row() : start a new table row and element. 
  966: 
  967: =item *
  968: 
  969: end_row() : end current table element and row.
  970: 
  971: =item *
  972: 
  973: movebuttons($target,$token) : move-up and move-down buttons; return scalar
  974: string
  975: 
  976: =item *
  977: 
  978: deletelist($target,$token) : provide a yes option in an HTML select element;
  979: return scalar string
  980: 
  981: =item *
  982: 
  983: handle_delete($space,$target,$token,$tagstack,$parstack,$parser,$safeeval,
  984: $style) : respond to a user delete request by passing relevant stack
  985: and array information to various rendering functions; return a scalar string
  986: 
  987: =item *
  988: 
  989: get_insert_list($token) : provide an insertion list based on possibilities
  990: from lonxml; return a scalar string
  991: 
  992: =item *
  993: 
  994: insertlist($target,$token) : api that uses get_insert_list;
  995: return a scalar string
  996: 
  997: =item *
  998: 
  999: handleinsert($token) : provide an insertion list based on possibilities
 1000: from lonxml; return a scalar string
 1001: 
 1002: =item *
 1003: 
 1004: get_insert_list($token) : provide an insertion list based on possibilities
 1005: from lonxml; return a scalar string
 1006: 
 1007: =item *
 1008: browse($elementname) : provide a link which will open up the filesystem
 1009: browser (lonindexer) and, once a file is selected, place the result in
 1010: the form element $elementname.
 1011: 
 1012: =item *
 1013: search($elementname) : provide a link which will open up the filesystem
 1014: searcher (lonsearchcat) and, once a file is selected, place the result in
 1015: the form element $elementname.
 1016: 
 1017: =item *
 1018: editline(tag,data,description,size): Provide a <input type="text" ../> for
 1019: single-line text entry.  This is to be used for text enclosed by tags, not
 1020: arguements/parameters associated with a tag.
 1021: 
 1022: =back
 1023: 
 1024: incomplete...
 1025: 
 1026: =cut

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