Annotation of loncom/homework/edit.pm, revision 1.99

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

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