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