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

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

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