File:  [LON-CAPA] / loncom / homework / edit.pm
Revision 1.152: download - view: text, annotated - select for diffs
Fri Nov 28 18:23:03 2014 UTC (9 years, 5 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_11_1, HEAD
- Optionresponse in "checkbox" mode:
  - Additional (optional) attributes: maxcheck and mincheck available to enforce
    requirement on number of checkboxes which may be checked.
  - Intended use case is polling with optionresponse used in survey mode,
    and maximum number of selections voter may make is to be limited.

    1: # The LearningOnline Network with CAPA 
    2: # edit mode helpers
    3: #
    4: # $Id: edit.pm,v 1.152 2014/11/28 18:23:03 raeburn Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: 
   29: =pod
   30: 
   31: =head1 NAME
   32: 
   33: Apache::edit - edit mode helpers
   34: 
   35: =head1 SYNOPSIS
   36: 
   37: Invoked by many homework and xml related modules.
   38: 
   39:  &Apache::edit::SUBROUTINENAME(ARGUMENTS);
   40: 
   41: =head1 INTRODUCTION
   42: 
   43: This module outputs HTML syntax helpful for the rendering of edit
   44: mode interfaces.
   45: 
   46: This is part of the LearningOnline Network with CAPA project
   47: described at http://www.lon-capa.org.
   48: 
   49: =head1 SUBROUTINES
   50: 
   51: =over 4
   52: 
   53: =item initialize_edit() 
   54: 
   55: initialize edit (set colordepth to zero)
   56: 
   57: =item tag_start($target,$token,$description)
   58: 
   59: provide deletion and insertion lists
   60: for the manipulation of a start tag; return a scalar string
   61: 
   62: =item tag_end($target,$token,$description)
   63: 
   64: ending syntax corresponding to
   65: &tag_start. return a scalar string.
   66: 
   67: =item  start_table($token)
   68: 
   69: start table; update colordepth; return scalar string.
   70: 
   71: =item end_table()
   72: 
   73: reduce color depth; end table; return scalar string
   74: 
   75: =item start_spanning_row()
   76: 
   77: start a new table row spanning the 'edit' environment.
   78: 
   79: =item start_row()
   80: 
   81: start a new table row and element. 
   82: 
   83: =item end_row() 
   84: 
   85: end current table element and row.
   86: 
   87: =item movebuttons($target,$token)
   88: 
   89: move-up and move-down buttons; return scalar string
   90: 
   91: =item deletelist($target,$token)
   92: 
   93: provide a yes option in an HTML select element; return scalar string
   94: 
   95: =item handle_delete($space,$target,$token,$tagstack,$parstack,$parser,$safeeval,
   96: $style)
   97: 
   98: respond to a user delete request by passing relevant stack
   99: and array information to various rendering functions; return a scalar string
  100: 
  101: =item get_insert_list($token)
  102: 
  103: provide an insertion list based on possibilities from lonxml; return a scalar string
  104: 
  105: =item insertlist($target,$token)
  106: 
  107: api that uses get_insert_list; return a scalar string
  108: 
  109: =item handleinsert($token)
  110: 
  111: provide an insertion list based on possibilities from lonxml; return a scalar string
  112: 
  113: =item get_insert_list($token)
  114: 
  115: provide an insertion list based on possibilities from lonxml; return a scalar string
  116: 
  117: =item browse($elementname)
  118: 
  119: provide a link which will open up the filesystem browser (lonindexer) and, once a file is selected, place the result in the form element $elementname.
  120: 
  121: =item search($elementname)
  122: 
  123: provide a link which will open up the filesystem searcher (lonsearchcat) and, once a file is selected, place the result in the form element $elementname.
  124: 
  125: =item editline(tag,data,description,size)
  126: 
  127: Provide a <input type="text" ../> for single-line text entry.  This is to be used for text enclosed by tags, not arguements/parameters associated with a tag.
  128: 
  129: =back
  130: 
  131: =cut
  132: 
  133: package Apache::edit; 
  134: 
  135: use strict;
  136: use Apache::lonnet;
  137: use HTML::Entities();
  138: use Apache::lonlocal;
  139: use lib '/home/httpd/lib/perl/';
  140: use LONCAPA;
  141:  
  142: 
  143: # Global Vars
  144: # default list of colors to use in editing
  145: @Apache::edit::colorlist=('#ffffff','#ff0000','#00ff00','#0000ff','#0ff000','#000ff0','#f0000f');
  146: # depth of nesting of edit
  147: $Apache::edit::colordepth=0;
  148: @Apache::edit::inserttag=();
  149: # image-type responses: active background image and curdepth at definition
  150: $Apache::edit::bgimgsrc='';
  151: $Apache::edit::bgimgsrccurdepth='';
  152: 
  153: sub initialize_edit {
  154:     $Apache::edit::colordepth=0;
  155:     @Apache::edit::inserttag=();
  156: }
  157: 
  158: sub tag_start {
  159:     my ($target,$token,$description) = @_;
  160:     my $result='';
  161:     if ($target eq "edit") {
  162: 	my $tag=$token->[1];
  163: 	if (!$description) {
  164: 	    $description=&mt(&Apache::lonxml::description($token));
  165: 	    if (!$description) { $description="&lt;$tag&gt;"; }
  166: 	}
  167: 	$result.= &start_table($token)."<tr><td>$description</td>
  168:                       <td>".&mt('Delete?').' '.
  169: 		      &deletelist($target,$token)
  170: 		      ."</td>
  171:                        <td>".
  172: 		       &insertlist($target,$token);
  173: #<td>". 
  174: #  &movebuttons($target,$token).
  175: #    "</tr><tr><td colspan=\"3\">\n";
  176: 	my @help = Apache::lonxml::helpinfo($token);
  177: 	if ($help[0]) {
  178: 	    $result .= '</td><td class="LC_edit_problem_latexhelper">'.
  179: 		Apache::loncommon::help_open_topic(@help);
  180: 	} else { $result .= "</td><td>&nbsp;"; }
  181: 	$result .= &end_row().&start_spanning_row();
  182:     }
  183:     return $result;
  184: }
  185: 
  186: sub tag_end {
  187:     my ($target,$token,$description) = @_;
  188:     my $result='';
  189:     if ($target eq 'edit') {
  190: 	$result.="</td></tr>".&end_table()."\n";
  191:     }
  192:     return $result;
  193: }
  194: 
  195: sub start_table {
  196:     my ($token)=@_;
  197:     my $tag = &Apache::lonxml::get_tag($token);
  198:     
  199:     my $color = $Apache::lonxml::insertlist{"$tag.color"};
  200:     &Apache::lonxml::debug(" $tag -- $color");
  201:     if (!defined($color)) {
  202: 	$color = $Apache::edit::colorlist[$Apache::edit::colordepth];
  203:     }
  204:     $Apache::edit::colordepth++;
  205:     push(@Apache::edit::inserttag,$token->[1]);
  206:     my $result='<div>';
  207:     $result.='<table bgcolor="'.$color.'" width="97%" border="0" cellspacing="3" cellpadding="2">';
  208:     return $result;
  209: }
  210: 
  211: sub end_table {
  212:     $Apache::edit::colordepth--;
  213:     my $result='</table></div>';
  214:     $result.='<div><table><tr><td>';
  215: 
  216:     my ($tagname,$closingtag);
  217:     if (defined($Apache::edit::inserttag[-2])) {
  218: 	$tagname=$Apache::edit::inserttag[-2];
  219:     } else {
  220: 	if ($Apache::lonhomework::parsing_a_task) {
  221: 	    $tagname='Task';
  222: 	} else {
  223: 	    $tagname='problem';
  224: 	}
  225:     }
  226:     if (defined($Apache::edit::inserttag[-1])) {
  227: 	$closingtag=$Apache::edit::inserttag[-1];
  228:     }
  229:     $result.=&innerinsertlist('edit',$tagname,$closingtag).
  230: 	"</td></tr></table></div>";
  231:     my $last = pop(@Apache::edit::inserttag);
  232:     return $result;
  233: }
  234: 
  235: sub start_spanning_row { return '<tr><td colspan="5" bgcolor="#F0F0F0">';}
  236: sub start_row          { return '<tr><td bgcolor="#DDDDDD">';            }
  237: sub end_row            { return '</td></tr>';          }
  238: 
  239: sub movebuttons {
  240:     my ($target,$token) = @_;
  241:     my $result='<input type="submit" name="moveup.'.
  242: 	$Apache::lonxml::curdepth.'" value="Move Up" />';
  243:     $result.='<input type="submit" name="movedown.'.
  244: 	$Apache::lonxml::curdepth.'" value="Move Down" />';
  245:     return $result;
  246: }
  247: 
  248: sub deletelist {
  249:     my ($target,$token) = @_;
  250:     my $result = "<select name=\"delete_$Apache::lonxml::curdepth\">
  251: <option></option>
  252: <option>".&mt('yes')."</option>
  253: </select>";
  254:     return $result;
  255: }
  256: 
  257: sub handle_delete {
  258:     if (!$env{"form.delete_$Apache::lonxml::curdepth"}) { return ''; }
  259:     my ($space,$target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  260:     my $result=0;
  261:     if ($space) {
  262: 	my $sub1="$space\:\:delete_$token->[1]";
  263: 	{
  264: 	    no strict 'refs';
  265: 	    if (defined &$sub1) {
  266: 		$result=&$sub1($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  267: 	    }
  268: 	}
  269:     }
  270:     if (!$result) {
  271: 	my $endtag='/'.$token->[1];
  272: 	my $bodytext=&Apache::lonxml::get_all_text($endtag,$parser,$style);
  273: 	$$parser['-1']->get_token();
  274: 	&Apache::lonxml::debug("Deleting :$bodytext: for $token->[1]");
  275: 	&Apache::lonxml::end_tag($tagstack,$parstack,$token);
  276:     }
  277:     return 1;
  278: }
  279: 
  280: sub get_insert_list {
  281:     my ($tagname) = @_;
  282:     my $result='';
  283:     my @tags= ();
  284:     #&Apache::lonxml::debug("keys ".join("\n",sort(keys(%Apache::lonxml::insertlist))));
  285:     if ($Apache::lonxml::insertlist{"$tagname.which"}) {
  286: 	push (@tags, @{ $Apache::lonxml::insertlist{"$tagname.which"} });
  287:     }
  288:     foreach my $namespace (@Apache::lonxml::namespace) {
  289: 	if ($Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"}) {
  290: 	    push (@tags, @{ $Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"} });
  291: 	}
  292:     }
  293:     if (@tags) {
  294: 	my %options;
  295: 	foreach my $tag (@tags) {
  296: 	    my $descrip=$Apache::lonxml::insertlist{"$tag.description"};
  297: 	    my $tagnum =$Apache::lonxml::insertlist{"$tag.num"};
  298: 	    $options{$descrip} ="<option value=\"$tagnum\">".
  299: 		&mt($descrip)."</option>\n";
  300: 	}
  301: 	foreach my $option (sort(keys(%options))) {$result.=$options{$option};}
  302: 	if ($result) { $result='<option selected="selected"></option>'.$result; }
  303:     }
  304:     return $result;
  305: }
  306: 
  307: sub insertlist {
  308:     my ($target,$token) = @_;
  309:     return &innerinsertlist($target,$token->[1]);
  310: }
  311: 
  312: sub innerinsertlist {
  313:     my ($target,$tagname,$closingtag) = @_;
  314:     my $result;
  315:     my $after='';
  316:     if ($closingtag) {
  317: 	$after='_after_'.$closingtag; 
  318:     }
  319:     if ($target eq 'edit') {
  320: 	my $optionlist= &get_insert_list($tagname);
  321: 	if ($optionlist) {
  322: 	    $result = &mt('Insert:')."
  323:             <select name=\"insert$after\_$Apache::lonxml::curdepth\">
  324:                   $optionlist
  325:             </select>"
  326: 	} else {
  327: 	    $result="&nbsp;";
  328: 	}
  329:     }
  330:     return $result;
  331: }
  332: 
  333: sub handle_insert {
  334:     if ($env{"form.insert_$Apache::lonxml::curdepth"} eq '') { return ''; }
  335:     my $tagnum = $env{"form.insert_$Apache::lonxml::curdepth"};
  336:     return &do_insert($tagnum);
  337: }
  338: 
  339: sub handle_insertafter {
  340:     my $tagname=shift;
  341:     if ($env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"} eq '') {
  342: 	return '';
  343:     }
  344:     my $tagnum =$env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"};
  345:     return &do_insert($tagnum,1);
  346: }
  347: 
  348: sub do_insert {
  349:     my ($tagnum,$after) = @_;
  350:     my $result;
  351: 
  352:     my $newtag = $Apache::lonxml::insertlist{"$tagnum.tag"};
  353:     my $func   = $Apache::lonxml::insertlist{"$newtag.function"};
  354:     if ($func eq 'default') {
  355: 	my $namespace;
  356: 	if ($newtag =~ /::/) { ($namespace,$newtag) = split(/::/,$newtag); }
  357: 	my $depth = scalar(@Apache::lonxml::depthcounter);
  358: 	$depth -- if ($after);
  359: 	my $inset = "\t"x$depth;
  360: 	$result.="\n$inset<$newtag></$newtag>";
  361:     } else {
  362: 	if (defined(&$func)) {
  363: 	    {
  364: 		no strict 'refs';
  365: 		$result.=&$func();
  366: 	    }
  367: 	} else {
  368: 	    &Apache::lonxml::error("Unable to insert tag $newtag, $func was not defined. ($tagnum)");
  369: 	}
  370:     }
  371:     return $result;
  372: }
  373: 
  374: sub insert_img {
  375:     return '
  376:     <img />';
  377: }
  378: 
  379: sub insert_responseparam {
  380:     return '
  381:     <responseparam />';
  382: }
  383: 
  384: sub insert_parameter {
  385:     return '
  386:     <parameter />';
  387: }
  388: 
  389: sub insert_formularesponse {
  390:     return '
  391: <formularesponse answer="" samples="">
  392:     <responseparam description="Numerical Tolerance" type="tolerance" default="0.00001" name="tol" />
  393:     <textline size="25"/>
  394:     <hintgroup>
  395:     <startouttext /><endouttext />
  396:     </hintgroup>
  397: </formularesponse>';
  398: }
  399: 
  400: sub insert_functionplotresponse {
  401:     return '
  402: <functionplotresponse>
  403: <functionplotelements>
  404: </functionplotelements>
  405: <functionplotruleset>
  406: </functionplotruleset>
  407: </functionplotresponse>';
  408: }
  409: 
  410: sub insert_spline {
  411:     return '
  412: <spline />';
  413: }
  414: 
  415: sub insert_backgroundplot {
  416:     return '
  417: <backgroundplot />';
  418: }
  419: 
  420: sub insert_plotobject {
  421:     return '
  422: <plotobject />';
  423: }
  424: 
  425: sub insert_plotvector {
  426:     return '
  427: <plotvector />';
  428: }
  429: 
  430: sub insert_drawvectorsum {
  431:     return '
  432: <drawvectorsum />';
  433: }
  434: 
  435: 
  436: sub insert_functionplotrule {
  437:     return '
  438: <functionplotrule />';
  439: }
  440: 
  441: sub insert_functionplotvectorrule {
  442:     return '
  443: <functionplotvectorrule />';
  444: }
  445: 
  446: sub insert_functionplotvectorsumrule {
  447:     return '
  448: <functionplotvectorsumrule />';
  449: }
  450: 
  451: sub insert_functionplotcustomrule {
  452:     return '
  453: <functionplotcustomrule>
  454: <answer type="loncapa/perl">
  455: # &fpr_val("label"), &fpr_f($x), &fpr_dfdx($x), &fpr_d2fdx2($x)
  456: # ($xs,$xe,$ys,$ye)=&fpr_vectorcoords("Name"), ($x,$y)=&fpr_objectcoords("Name")
  457: # &fpr_vectorlength("Name"), &fpr_vectorangle("Name")
  458:  
  459: # Return 0 or 1
  460: return 1;
  461: </answer>
  462: </functionplotcustomrule>';
  463: }
  464: 
  465: sub insert_functionplotruleset {
  466:     return '
  467: <functionplotruleset>
  468: <functionplotrule />
  469: </functionplotruleset>';
  470: }
  471: 
  472: sub insert_functionplotelements {
  473:     return '
  474: <functionplotelements>
  475: <spline />
  476: </functionplotelements>';
  477: }
  478: 
  479: sub insert_numericalresponse {
  480:     return '
  481: <numericalresponse answer="">
  482: <responseparam type="tolerance" default="5%" name="tol" description="Numerical Tolerance" />
  483: <responseparam name="sig" type="int_range,0-16" default="0,15" description="Significant Figures" />
  484:     <textline />
  485:     <hintgroup>
  486:     <startouttext /><endouttext />
  487:     </hintgroup>
  488: </numericalresponse>';
  489: }
  490: 
  491: sub insert_externalresponse {
  492:     return '
  493: <externalresponse url="" answer="" answerdisplay="" form="">
  494:     <textfield spellcheck="none" />
  495: </externalresponse>';
  496: }
  497: 
  498: sub insert_customresponse {
  499:     return '
  500: <customresponse>
  501:     <answer type="loncapa/perl">
  502:     </answer>
  503:     <textline />
  504:     <hintgroup>
  505:     <startouttext /><endouttext />
  506:     </hintgroup>
  507: </customresponse>';
  508: }
  509: 
  510: sub insert_customresponse_answer {
  511:     return '
  512:     <answer type="loncapa/perl">
  513:     </answer>
  514: ';
  515: }
  516: 
  517: sub insert_customhint {
  518:     return '
  519:         <customhint>
  520:             <answer type="loncapa/perl">
  521:             </answer>
  522:         </customhint>';
  523: }
  524: 
  525: sub insert_customhint_answer {
  526:     return '
  527:             <answer type="loncapa/perl">
  528:             </answer>
  529: ';
  530: }
  531: 
  532: sub insert_mathresponse {
  533:     return '
  534: <mathresponse>
  535:     <answer>
  536:     </answer>
  537:     <textline />
  538:     <hintgroup>
  539:         <startouttext />
  540:         <endouttext />
  541:     </hintgroup>
  542: </mathresponse>';
  543: }
  544: 
  545: sub insert_mathresponse_answer {
  546:     return '
  547:     <answer>
  548:     </answer>
  549: ';
  550: }
  551: 
  552: sub insert_mathhint {
  553:     return '
  554:         <mathhint>
  555:             <answer>
  556:             </answer>
  557:         </mathhint>';
  558: }
  559: 
  560: sub insert_mathhint_answer {
  561:     return '
  562:             <answer>
  563:             </answer>
  564: ';
  565: }
  566: 
  567: sub insert_stringresponse {
  568:     return '
  569: <stringresponse answer="" type="">
  570:     <textline />
  571:     <hintgroup>
  572:     <startouttext /><endouttext />
  573:     </hintgroup>
  574: </stringresponse>';
  575: }
  576: 
  577: sub insert_essayresponse {
  578:     return '
  579: <essayresponse>
  580:     <textfield></textfield>
  581: </essayresponse>';
  582: }
  583: 
  584: sub insert_imageresponse {
  585:     return '
  586: <imageresponse max="1">
  587:     <foilgroup>
  588:       <foil>
  589:       </foil>
  590:     </foilgroup>
  591:     <hintgroup>
  592:     <startouttext /><endouttext />
  593:     </hintgroup>
  594: </imageresponse>';
  595: }
  596: 
  597: sub insert_optionresponse {
  598:     return '
  599: <optionresponse max="10">
  600:     <foilgroup options="">
  601:       <foil>
  602:          <startouttext /><endouttext />
  603:       </foil>
  604:     </foilgroup>
  605:     <hintgroup>
  606:     <startouttext /><endouttext />
  607:     </hintgroup>
  608: </optionresponse>';
  609: }
  610: 
  611: sub insert_organicresponse {
  612:     return '
  613: <organicresponse>
  614:     <textline />
  615:     <hintgroup>
  616:     <startouttext /><endouttext />
  617:     </hintgroup>
  618: </organicresponse>';
  619: }
  620: 
  621: sub insert_organicstructure {
  622:     return '
  623: <organicstructure />
  624: ';
  625: }
  626: 
  627: sub insert_radiobuttonresponse {
  628:     return '
  629: <radiobuttonresponse max="10">
  630:     <foilgroup>
  631:       <foil>
  632:          <startouttext /><endouttext />
  633:       </foil>
  634:     </foilgroup>
  635:     <hintgroup>
  636:     <startouttext /><endouttext />
  637:     </hintgroup>
  638: </radiobuttonresponse>';
  639: }
  640: 
  641: sub insert_reactionresponse {
  642:     return '
  643: <reactionresponse>
  644:     <textline />
  645:     <hintgroup>
  646:     <startouttext /><endouttext />
  647:     </hintgroup>
  648: </reactionresponse>';
  649: }
  650: 
  651: sub insert_rankresponse {
  652:     return '
  653: <rankresponse max="10">
  654:     <foilgroup options="">
  655:       <foil>
  656:          <startouttext /><endouttext />
  657:       </foil>
  658:     </foilgroup>
  659:     <hintgroup>
  660:     <startouttext /><endouttext />
  661:     </hintgroup>
  662: </rankresponse>';
  663: }
  664: 
  665: sub insert_matchresponse {
  666:     return '
  667: <matchresponse max="10">
  668:     <foilgroup options="">
  669:       <itemgroup>
  670:         <item>
  671:           <startouttext /><endouttext />
  672:         </item>
  673:       </itemgroup>
  674:       <foil>
  675:          <startouttext /><endouttext />
  676:       </foil>
  677:     </foilgroup>
  678:     <hintgroup>
  679:     <startouttext /><endouttext />
  680:     </hintgroup>
  681: </matchresponse>';
  682: }
  683: 
  684: sub insert_startpartmarker { return '<startpartmarker />'; }
  685: sub insert_endpartmarker { return '<endpartmarker />'; }
  686: 
  687: sub insert_displayduedate { return '<displayduedate />'; }
  688: sub insert_displaytitle   { return '<displaytitle />'; }
  689: sub insert_hintpart {
  690:     return '
  691: <hintpart on="default">
  692:     <startouttext/><endouttext />
  693: </hintpart>';
  694: }
  695: 
  696: sub insert_hintgroup {
  697:   return '
  698: <hintgroup>
  699:     <startouttext /><endouttext />
  700: </hintgroup>';
  701: }
  702: 
  703: sub insert_numericalhint {
  704:     return '
  705: <numericalhint>
  706: </numericalhint>';
  707: }
  708: 
  709: sub insert_reactionhint {
  710:     return '
  711: <reactionhint>
  712: </reactionhint>';
  713: }
  714: 
  715: sub insert_organichint {
  716:     return '
  717: <organichint>
  718: </organichint>';
  719: }
  720: 
  721: sub insert_stringhint {
  722:     return '
  723: <stringhint>
  724: </stringhint>';
  725: }
  726: 
  727: sub insert_formulahint {
  728:     return '
  729: <formulahint>
  730: </formulahint>';
  731: }
  732: 
  733: sub insert_radiobuttonhint {
  734:     return '
  735: <radiobuttonhint>
  736: </radiobuttonhint>';
  737: }
  738: 
  739: sub insert_optionhint {
  740:     return '
  741: <optionhint>
  742: </optionhint>';
  743: }
  744: 
  745: sub insert_startouttext {
  746:     return "<startouttext /><endouttext />";
  747: }
  748: 
  749: sub insert_script {
  750:     return "\n<script type=\"loncapa/perl\"></script>";
  751: }
  752: 
  753: sub js_change_detection {
  754:     my $unsaved=&mt("There are unsaved changes");
  755:     return (<<SCRIPT);
  756: <script type="text/javascript">
  757: // <![CDATA[
  758: var clean = true;
  759: var is_submit = false;
  760: var still_ask = false;
  761: function compareForm(event_) {
  762:         if (!event_ && window.event) {
  763:           event_ = window.event;
  764:         }
  765: 	if ((!is_submit || (is_submit && still_ask)) && !clean) {
  766: 	    still_ask = false;
  767: 	    is_submit = false;
  768:             event_.returnValue = "$unsaved";
  769:             return "$unsaved";
  770:         }
  771: }
  772: function unClean() {
  773:      clean=false;
  774: }
  775: window.onbeforeunload = compareForm;
  776: // ]]>
  777: </script>
  778: SCRIPT
  779: }
  780: 
  781: sub form_change_detection {
  782:     return ' onsubmit="is_submit=true;" ';
  783: }
  784: 
  785: sub element_change_detection {
  786:     return ' onchange="unClean();" ';
  787: }
  788: 
  789: sub submit_ask_anyway {
  790:     my ($extra_action) = @_;
  791:     return ' onclick="still_ask=true;'.$extra_action.'" ';
  792: }
  793: 
  794: sub submit_dont_ask {
  795:     my ($extra_action) = @_;
  796:     return ' onclick="is_submit=true;'.$extra_action.'" ';
  797: }
  798: 
  799: sub js_update_linknum {
  800:     return (<<SCRIPT);
  801: <script type="text/javascript">
  802: // <![CDATA[
  803: function updateNumber(name,index,caller,textprompt) {
  804:     var pickitem = document.getElementById(name+'_'+index);
  805:     var picknumtext = document.getElementById(name+'_numtext_'+index);
  806:     if (pickitem.checked) {
  807:         var showval = '';
  808:         if (pickitem.value != 'nochoice') {
  809:             showval = pickitem.value;
  810:         } 
  811:         var picknum=prompt(textprompt,showval);
  812:         if (picknum == '' || picknum == null) {
  813:             if (caller == 'check') {
  814:                 pickitem.checked=false;
  815:                 pickitem.value='nochoice';
  816:             }
  817:         } else {
  818:             picknum.toString();
  819:             var regexdigit=/^\\d+\$/;
  820:             if (regexdigit.test(picknum)) {
  821:                 pickitem.value = picknum;
  822:                 picknumtext.innerHTML = '&nbsp;<a href="javascript:updateNumber(\\''+name+'\\',\\''+index+'\\',\\'link\\',\\''+textprompt+'\\');">'+picknum+'</a>';
  823:             } else {
  824:                 if (caller == 'check') {
  825:                     pickitem.checked=false;
  826:                     pickitem.value='nochoice';
  827:                 }
  828:                 return;
  829:             }
  830:         }
  831:     } else {
  832:         pickitem.value = '';
  833:         picknumtext.innerHTML = '';
  834:     }
  835: }
  836: 
  837: // ]]>
  838: </script>
  839: SCRIPT
  840: 
  841: }
  842: 
  843: sub textarea_sizes {
  844:     my ($data)=@_;
  845:     my $count=0;
  846:     my $maxlength=-1;
  847:     foreach (split ("\n", $$data)) {
  848: 	$count+=int(length($_)/79);
  849: 	$count++;
  850: 	if (length($_) > $maxlength) { $maxlength = length($_); }
  851:     }
  852:     my $rows = $count;
  853:     my $cols = $maxlength;
  854:     return ($rows,$cols);
  855: }
  856: 
  857: sub editline {
  858:     my ($tag,$data,$description,$size)=@_;
  859:     $data=&HTML::Entities::encode($data,'<>&"');
  860:     if ($description) { $description=$description."<br />"; }
  861:     my $change_code = &element_change_detection();
  862:     my $result = <<"END";
  863: $description
  864: <input type="text" name="homework_edit_$Apache::lonxml::curdepth" 
  865:        value="$data" size="$size" $change_code />
  866: END
  867:     return $result;
  868: }
  869: 
  870: sub editfield {
  871:     my ($tag,$data,$description,$minwidth,$minheight,$usehtmlarea)=@_;
  872: 
  873:     my ($rows,$cols)=&textarea_sizes(\$data);
  874:     my $textareaclass;
  875:  
  876:     if (&Apache::lonhtmlcommon::htmlareabrowser() && $usehtmlarea) { 
  877: 	$rows+=7;      # make room for HTMLarea
  878: 	$minheight+=7; # make room for HTMLarea
  879:         $textareaclass = ' class="LC_richDefaultOff"';
  880:     }
  881:     if ($cols > 80) { $cols = 80; }
  882:     if ($cols < $minwidth ) { $cols = $minwidth; }
  883:     if ($rows < $minheight) { $rows = $minheight; }
  884:     if ($description) { $description='<br />'.&mt($description).'<br />'; }
  885: 
  886:     # remove typesetting whitespace from between data and the end tag
  887:     # to make the edit look prettier
  888:     $data =~ s/\n?[ \t]*$//;
  889: 
  890:     return $description."\n".'<textarea style="width:99%" rows="'.$rows.
  891: 	'" cols="'.$cols.'" name="homework_edit_'.
  892: 	$Apache::lonxml::curdepth.'" id="homework_edit_'.
  893: 	$Apache::lonxml::curdepth.'" '.&element_change_detection().
  894:         $textareaclass.'>'.
  895: 	&HTML::Entities::encode($data,'<>&"').'</textarea>'.
  896:         ($usehtmlarea?'<br />'.&Apache::lonhtmlcommon::spelllink('lonhomework',
  897:                                    'homework_edit_'.$Apache::lonxml::curdepth):'')."\n";
  898: }
  899: 
  900: sub modifiedfield {
  901:     my ($endtag,$parser) = @_;
  902:     my $result;
  903:     $result=$env{"form.homework_edit_$Apache::lonxml::curdepth"};
  904:     my $bodytext=&Apache::lonxml::get_all_text($endtag,$parser);
  905:     # textareas throw away intial \n 
  906:     if ($bodytext=~/^\n/) {
  907: 	$result="\n".$result;
  908:     }
  909:     # if there is typesetting whitespace from between the data and the end tag
  910:     # restore to keep the source looking pretty
  911:     if ($bodytext =~ /(\n?[ \t]*)$/) {
  912: 	$result .= $1;
  913:     }
  914:     return $result;
  915: }
  916: 
  917: # Returns a 1 if the token has been modified and you should rebuild the tag
  918: # side-effects, will modify the $token if new values are found
  919: sub get_new_args {
  920:     my ($token,$parstack,$safeeval,@args)=@_;
  921:     my $rebuild=0;
  922:     foreach my $arg (@args) {
  923: 	#just want the string that it was set to
  924: 	my $value=$token->[2]->{$arg};
  925: 	my $element=&html_element_name($arg);
  926: 	my $newvalue=$env{"form.$element"};
  927: 	&Apache::lonxml::debug("for:$arg: cur is :$value: new is :$newvalue:");
  928: 	if (defined($newvalue) && $value ne $newvalue) {
  929: 	    if (ref($newvalue) eq 'ARRAY') {
  930: 		$token->[2]->{$arg}=join(',',@$newvalue);
  931: 	    } else {
  932: 		$token->[2]->{$arg}=$newvalue;
  933: 	    }
  934: 	    $rebuild=1;
  935: 	    # add new attributes to the of the attribute seq
  936: 	    if (!grep { $arg eq $_ } (@{ $token->[3] })) {
  937: 		push(@{ $token->[3] },$arg);
  938: 	    }
  939: 	} elsif (!defined($newvalue) && defined($value)) {
  940: 	    delete($token->[2]->{$arg});
  941: 	    $rebuild=1;
  942: 	}
  943:     }
  944:     return $rebuild;
  945: }
  946: 
  947: # looks for /> on start tags
  948: sub rebuild_tag {
  949:     my ($token) = @_;
  950:     my $result;
  951:     if ($token->[0] eq 'S') {
  952: 	$result = '<'.$token->[1];
  953: 	foreach my $attribute (@{ $token->[3] }) {
  954: 	    my $value = $token->[2]{$attribute};
  955: 	    next if ($value eq '');
  956: 	    $value =~s/^\s+|\s+$//g;
  957: 	    $value =~s/\"//g;
  958: 	    &Apache::lonxml::debug("setting :$attribute: to  :$value:");
  959: 	    $result.=' '.$attribute.'="'.$value.'"';
  960: 	}
  961: 	if ($token->[4] =~ m:/>$:) {
  962: 	    $result.=' />';
  963: 	} else {
  964: 	    $result.='>';
  965: 	}
  966:     } elsif ( $token->[0] eq 'E' ) {
  967: 	$result = '</'.$token->[1].'>';
  968:     }
  969:     return $result;
  970: }
  971: 
  972: sub html_element_name {
  973:     my ($name) = @_;
  974:     return $name.'_'.$Apache::lonxml::curdepth;
  975: }
  976: 
  977: sub hidden_arg {
  978:     my ($name,$token) = @_;
  979:     my $result;
  980:     my $arg=$token->[2]{$name};
  981:     $result='<input name="'.&html_element_name($name).
  982: 	'" type="hidden" value="'.$arg.'" />';
  983:     return $result;
  984: }
  985: 
  986: sub checked_arg {
  987:     my ($description,$name,$list,$token,$onclick,$useid) = @_;
  988:     my $result;
  989:     my $optionlist="";
  990:     my $allselected=$token->[2]{$name};
  991:     $result=&mt($description);
  992:     foreach my $option (@$list) {
  993: 	my ($value,$text);
  994: 	if ( ref($option) eq 'ARRAY') {
  995: 	    $value='value="'.$$option[0].'"';
  996: 	    $text=&mt($$option[1]);
  997: 	    $option=$$option[0];
  998: 	} else {
  999: 	    $text=&mt($option);
 1000: 	    $value='value="'.$option.'"';
 1001: 	}
 1002:         $result.=' <span class="LC_edit_opt"><label><input type="checkbox" '.$value.' name="'.
 1003: 	    &html_element_name($name).'"';
 1004: 	foreach my $selected (split(/,/,$allselected)) {
 1005: 	    if ( $selected eq $option ) {
 1006: 		$result.=' checked="checked" ';
 1007: 		last;
 1008: 	    }
 1009: 	}
 1010:         if ($useid) {
 1011:             $result .= ' id="'.&html_element_name($name).'" ';
 1012:         }
 1013: 	$result.=&element_change_detection().$onclick.' />'.$text.'</label></span>'."\n";
 1014:     }
 1015:     return $result;
 1016: }
 1017: 
 1018: sub text_arg {
 1019:     my ($description,$name,$token,$size, $class) = @_;
 1020:     my $result;
 1021:     if (!defined $size) { $size=20; }
 1022:     my $arg=$token->[2]{$name};
 1023:     $result=&mt($description).'&nbsp;<input name="'.&html_element_name($name).
 1024: 	'" type="text" value="'.$arg.'" size="'.$size.'" ';
 1025:     if (defined $class) {
 1026: 	$result .= 'class="' . $class . '" ';
 1027:     }
 1028:     $result .=	&element_change_detection().'/>';
 1029:     return ' <span class="LC_edit_opt">'.$result.'</span>';
 1030: }
 1031: 
 1032: sub select_arg {
 1033:     my ($description,$name,$list,$token) = @_;
 1034:     my $result;
 1035:     my $optionlist="";
 1036:     my $selected=$token->[2]{$name};
 1037:     if (ref($list) eq 'ARRAY') {
 1038:         foreach my $option (@{$list}) {
 1039: 	    my ($text,$value);
 1040: 	    if (ref($option) eq 'ARRAY') {
 1041: 	        $value='value="'.&HTML::Entities::encode($option->[0]).'"';
 1042: 	        $text=$option->[1];
 1043: 	        $option=$option->[0];
 1044: 	    } else {
 1045: 	        $text=$option;
 1046: 	        $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"';
 1047: 	    }
 1048: 	    if ( $selected eq $option ) {
 1049: 	        $optionlist.="<option $value selected=\"selected\">".&mt($text)."</option>\n";
 1050: 	    } else {
 1051: 	        $optionlist.="<option $value >".&mt($text)."</option>\n";
 1052: 	    }
 1053:         }
 1054:     }
 1055:     $result.=' <span class="LC_edit_opt">'.&mt($description).'&nbsp;<select name="'.
 1056: 	&html_element_name($name).'" '.&element_change_detection().' >
 1057:        '.$optionlist.'
 1058:       </select></span>';
 1059:     return $result;
 1060: }
 1061: 
 1062: sub select_or_text_arg {
 1063:     my ($description,$name,$list,$token,$size) = @_;
 1064:     my $result;
 1065:     my $optionlist="";
 1066:     my $found=0;
 1067:     my $selected=$token->[2]{$name};
 1068:     if (ref($list) eq 'ARRAY') {
 1069:         foreach my $option (@{$list}) {
 1070: 	    my ($text,$value);
 1071: 	    if (ref($option) eq 'ARRAY') {
 1072: 	        $value='value="'.&HTML::Entities::encode($option->[0]).'"';
 1073: 	        $text=$option->[1];
 1074: 	        $option=$option->[0];
 1075: 	    } else {
 1076: 	        $text=$option;
 1077: 	        $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"';
 1078: 	    }
 1079: 	    if ( $selected eq $option ) {
 1080: 	        $optionlist.="<option $value selected=\"selected\">$text</option>\n";
 1081: 	        $found=1;
 1082: 	    } else {
 1083: 	        $optionlist.="<option $value>$text</option>\n";
 1084: 	    }
 1085:         }
 1086:     }
 1087:     $optionlist.="<option value=\"TYPEDINVALUE\"".
 1088:  	((!$found)?' selected="selected"':'').
 1089:  	">".&mt('Type-in value')."</option>\n";
 1090: #
 1091:     my $change_code=&element_change_detection();
 1092:     my $element=&html_element_name($name);
 1093:     my $selectelement='select_list_'.$element;
 1094:     my $typeinelement='type_in_'.$element;
 1095:     my $typeinvalue=($found?'':$selected);
 1096: #
 1097:     my $hiddenvalue='this.form.'.$element.'.value';
 1098:     my $selectedindex='this.form.'.$selectelement.'.selectedIndex';
 1099:     my $selectedvalue='this.form.'.$selectelement.
 1100: 	     '.options['.$selectedindex.'].value';
 1101:     my $typedinvalue='this.form.'.$typeinelement.'.value';
 1102:     my $selecttypeinindex='this.form.'.$selectelement.'.options.length';
 1103:     $description=&mt($description);
 1104: #
 1105:     return (<<ENDSELECTORTYPE);
 1106:  <span class="LC_edit_opt">
 1107: $description
 1108: &nbsp;<select name="$selectelement"
 1109: onchange="if ($selectedvalue!='TYPEDINVALUE') { $hiddenvalue=$selectedvalue; $typedinvalue=''; }" >
 1110: $optionlist
 1111: </select>
 1112: <input type="text" size="$size" name="$typeinelement"
 1113:        value="$typeinvalue" 
 1114: onchange="$hiddenvalue=$typedinvalue;"
 1115: onfocus="$selectedindex=$selecttypeinindex-1;" />
 1116: <input type="hidden" name="$element" value="$selected" $change_code />
 1117: </span>
 1118: ENDSELECTORTYPE
 1119: }
 1120: 
 1121: #----------------------------------------------------- image coordinates
 1122: # single image coordinates, x, y 
 1123: sub entercoords {
 1124:     my ($idx,$idy,$mode,$width,$height) = @_;
 1125:     unless ($Apache::edit::bgimgsrc) { return ''; }
 1126:     if ($idx) { $idx.='_'; }
 1127:     if ($idy) { $idy.='_'; }
 1128:     my $bgfile=&escape(&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$Apache::edit::bgimgsrc));
 1129:     my $form    = 'lonhomework';
 1130:     my $element;
 1131:     if (! defined($mode) || $mode eq 'attribute') {
 1132:         $element = &escape("$Apache::lonxml::curdepth");
 1133:     } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
 1134:         $element = &escape('homework_edit_'.
 1135:                                            $Apache::lonxml::curdepth);
 1136:     }
 1137:     my $id=$Apache::lonxml::curdepth;
 1138:     my %data=("imagechoice.$id.type"      =>'point',
 1139: 	      "imagechoice.$id.formname"  =>$form,
 1140: 	      "imagechoice.$id.formx"     =>"$idx$element",
 1141: 	      "imagechoice.$id.formy"     =>"$idy$element",
 1142: 	      "imagechoice.$id.file"      =>$bgfile,
 1143: 	      "imagechoice.$id.formcoord" =>$element);
 1144:     if ($height) {
 1145: 	$data{"imagechoice.$id.formheight"}=$height.'_'.
 1146: 	    $Apache::edit::bgimgsrccurdepth;
 1147:     }
 1148:     if ($width) {
 1149: 	$data{"imagechoice.$id.formwidth"}=$width.'_'.
 1150: 	    $Apache::edit::bgimgsrccurdepth;
 1151:     }
 1152:     &Apache::lonnet::appenv(\%data);
 1153:     my $text="Click Coordinates";
 1154:     my $result='<a href="/adm/imagechoice?token='.$id.'" target="imagechoice">'.$text.'</a>';
 1155:     return $result;
 1156: }
 1157: 
 1158: # coordinates (x1,y1)-(x2,y2)...
 1159: # mode can be either box, or polygon
 1160: sub entercoord {
 1161:     my ($idx,$mode,$width,$height,$type) = @_;
 1162:     unless ($Apache::edit::bgimgsrc) { return ''; }
 1163:     my $bgfile=&escape(&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$Apache::edit::bgimgsrc));
 1164:     my $form    = 'lonhomework';
 1165:     my $element;
 1166:     if (! defined($mode) || $mode eq 'attribute') {
 1167:         $element = &escape("$idx\_$Apache::lonxml::curdepth");
 1168:     } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
 1169:         $element = &escape('homework_edit_'.
 1170:                                            $Apache::lonxml::curdepth);
 1171:     }
 1172:     my $id=$Apache::lonxml::curdepth;
 1173:     my %data=("imagechoice.$id.type"      =>$type,
 1174: 	      "imagechoice.$id.formname"  =>$form,
 1175: 	      "imagechoice.$id.file"      =>$bgfile,
 1176: 	      "imagechoice.$id.formcoord" =>$element);
 1177:     if ($height) {
 1178: 	$data{"imagechoice.$id.formheight"}=$height.'_'.
 1179: 	    $Apache::edit::bgimgsrccurdepth;
 1180:     }
 1181:     if ($width) {
 1182: 	$data{"imagechoice.$id.formwidth"}=$width.'_'.
 1183: 	    $Apache::edit::bgimgsrccurdepth;
 1184:     }
 1185:     &Apache::lonnet::appenv(\%data);
 1186:     my $text="Enter Coordinates";
 1187:     if ($type eq 'polygon') { $text='Create Polygon Data'; }
 1188:     my $result='<a href="/adm/imagechoice?token='.$id.'" target="imagechoice">'.$text.'</a>';
 1189:     return $result;
 1190: }
 1191: 
 1192: sub deletecoorddata {
 1193:     &Apache::lonnet::delenv('imagechoice.');
 1194: }
 1195: 
 1196: #----------------------------------------------------- browse
 1197: sub browse {
 1198:     # insert a link to call up the filesystem browser (lonindexer)
 1199:     my ($id, $mode, $titleid, $only) = @_;
 1200:     my $form    = 'lonhomework';
 1201:     my $element;
 1202:     if (! defined($mode) || $mode eq 'attribute') {
 1203:         $element = &escape("$id\_$Apache::lonxml::curdepth");
 1204:     } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
 1205:         $element = &escape('homework_edit_'.
 1206:                                            $Apache::lonxml::curdepth);	
 1207:     }
 1208:     my $titleelement;
 1209:     if ($titleid) {
 1210: 	$titleelement=",'$only','','".&escape("$titleid\_$Apache::lonxml::curdepth")."'";
 1211:     } else {
 1212:         $titleelement=",'$only'";
 1213:     }
 1214:     my $result = <<"ENDBUTTON";
 1215: <a href=\"javascript:openbrowser('$form','$element'$titleelement)\"\>Select</a>
 1216: ENDBUTTON
 1217:     return $result;
 1218: }
 1219: 
 1220: #----------------------------------------------------- browse
 1221: sub search {
 1222:     # insert a link to call up the filesystem browser (lonindexer)
 1223:     my ($id, $mode, $titleid) = @_;
 1224:     my $form    = 'lonhomework';
 1225:     my $element;
 1226:     if (! defined($mode) || $mode eq 'attribute') {
 1227:         $element = &escape("$id\_$Apache::lonxml::curdepth");
 1228:     } elsif ($mode eq 'textnode') {  # for data between <tag> ... </tag>
 1229:         $element = &escape('homework_edit_'.
 1230:                                            $Apache::lonxml::curdepth);
 1231:     }
 1232:     my $titleelement;
 1233:     if ($titleid) {
 1234: 	$titleelement=",'".&escape("$titleid\_$Apache::lonxml::curdepth")."'";
 1235:     }
 1236:     my $result = <<"ENDBUTTON";
 1237: <a href=\"javascript:opensearcher('$form','$element'$titleelement)\"\>Search</a>
 1238: ENDBUTTON
 1239:     return $result;
 1240: }
 1241: 
 1242: 
 1243: 1;
 1244: __END__
 1245: 
 1246: 

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