File:  [LON-CAPA] / loncom / xml / lonxml.pm
Revision 1.470: download - view: text, annotated - select for diffs
Wed Dec 5 14:52:15 2007 UTC (16 years, 5 months ago) by albertel
Branches: MAIN
CVS tags: version_2_6_2, version_2_6_1, version_2_6_0, version_2_5_99_1, HEAD
- make editing html/sty have same look and feel as EditXML
- elminate bottom buttons

    1: # The LearningOnline Network with CAPA
    2: # XML Parser Module 
    3: #
    4: # $Id: lonxml.pm,v 1.470 2007/12/05 14:52:15 albertel Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: # Copyright for TtHfunc and TtMfunc by Ian Hutchinson. 
   29: # TtHfunc and TtMfunc (the "Code") may be compiled and linked into 
   30: # binary executable programs or libraries distributed by the 
   31: # Michigan State University (the "Licensee"), but any binaries so 
   32: # distributed are hereby licensed only for use in the context
   33: # of a program or computational system for which the Licensee is the 
   34: # primary author or distributor, and which performs substantial 
   35: # additional tasks beyond the translation of (La)TeX into HTML.
   36: # The C source of the Code may not be distributed by the Licensee
   37: # to any other parties under any circumstances.
   38: #
   39: 
   40: 
   41: package Apache::lonxml; 
   42: use vars 
   43: qw(@pwd @outputstack $redirection $import @extlinks $metamode $evaluate %insertlist @namespace $errorcount $warningcount);
   44: use strict;
   45: use LONCAPA;
   46: use HTML::LCParser();
   47: use HTML::TreeBuilder();
   48: use HTML::Entities();
   49: use Safe();
   50: use Safe::Hole();
   51: use Math::Cephes();
   52: use Math::Random();
   53: use Opcode();
   54: use POSIX qw(strftime);
   55: use Time::HiRes qw( gettimeofday tv_interval );
   56: use Symbol();
   57: 
   58: sub register {
   59:   my ($space,@taglist) = @_;
   60:   foreach my $temptag (@taglist) {
   61:     push(@{ $Apache::lonxml::alltags{$temptag} },$space);
   62:   }
   63: }
   64: 
   65: sub deregister {
   66:   my ($space,@taglist) = @_;
   67:   foreach my $temptag (@taglist) {
   68:     my $tempspace = $Apache::lonxml::alltags{$temptag}[-1];
   69:     if ($tempspace eq $space) {
   70:       pop(@{ $Apache::lonxml::alltags{$temptag} });
   71:     }
   72:   }
   73:   #&printalltags();
   74: }
   75: 
   76: use Apache::Constants qw(:common);
   77: use Apache::lontexconvert();
   78: use Apache::style();
   79: use Apache::run();
   80: use Apache::londefdef();
   81: use Apache::scripttag();
   82: use Apache::languagetags();
   83: use Apache::edit();
   84: use Apache::inputtags();
   85: use Apache::outputtags();
   86: use Apache::lonnet;
   87: use Apache::File();
   88: use Apache::loncommon();
   89: use Apache::lonfeedback();
   90: use Apache::lonmsg();
   91: use Apache::loncacc();
   92: use Apache::lonmaxima();
   93: use Apache::lonlocal;
   94: 
   95: #====================================   Main subroutine: xmlparse  
   96: 
   97: #debugging control, to turn on debugging modify the correct handler
   98: 
   99: $Apache::lonxml::debug=0;
  100: 
  101: # keeps count of the number of warnings and errors generated in a parse
  102: $warningcount=0;
  103: $errorcount=0;
  104: 
  105: #path to the directory containing the file currently being processed
  106: @pwd=();
  107: 
  108: #these two are used for capturing a subset of the output for later processing,
  109: #don't touch them directly use &startredirection and &endredirection
  110: @outputstack = ();
  111: $redirection = 0;
  112: 
  113: #controls wheter the <import> tag actually does
  114: $import = 1;
  115: @extlinks=();
  116: 
  117: # meta mode is a bit weird only some output is to be turned off
  118: #<output> tag turns metamode off (defined in londefdef.pm)
  119: $metamode = 0;
  120: 
  121: # turns on and of run::evaluate actually derefencing var refs
  122: $evaluate = 1;
  123: 
  124: # data structure for eidt mode, determines what tags can go into what other tags
  125: %insertlist=();
  126: 
  127: # stores the list of active tag namespaces
  128: @namespace=();
  129: 
  130: # stores all Scrit Vars displays for later showing
  131: my @script_var_displays=();
  132: 
  133: # a pointer the the Apache request object
  134: $Apache::lonxml::request='';
  135: 
  136: # a problem number counter, and check on ether it is used
  137: $Apache::lonxml::counter=1;
  138: $Apache::lonxml::counter_changed=0;
  139: 
  140: # Part counter hash.   In analysis mode, the
  141: # problems can use this to record which parts increment the counter
  142: # by how much.  The counter subs will maintain this hash via
  143: # their optional part parameters.  Note that the assumption is that
  144: # analysis is done in one request and therefore it is not necessary to
  145: # save this information request-to-request.
  146: 
  147: 
  148: %Apache::lonxml::counters_per_part = ();
  149: 
  150: #internal check on whether to look at style defs
  151: $Apache::lonxml::usestyle=1;
  152: 
  153: #locations used to store the parameter string for style substitutions
  154: $Apache::lonxml::style_values='';
  155: $Apache::lonxml::style_end_values='';
  156: 
  157: #array of ssi calls that need to occur after we are done parsing
  158: @Apache::lonxml::ssi_info=();
  159: 
  160: #should we do the postag variable interpolation
  161: $Apache::lonxml::post_evaluate=1;
  162: 
  163: #a header message to emit in the case of any generated warning or errors
  164: $Apache::lonxml::warnings_error_header='';
  165: 
  166: #  Control whether or not LaTeX symbols should be substituted for their
  167: #  \ style equivalents...this may be turned off e.g. in an verbatim
  168: #  environment.
  169: 
  170: $Apache::lonxml::substitute_LaTeX_symbols = 1; # Starts out on.
  171: 
  172: sub enable_LaTeX_substitutions {
  173:     $Apache::lonxml::substitute_LaTeX_symbols = 1;
  174: }
  175: sub disable_LaTeX_substitutions {
  176:     $Apache::lonxml::substitute_LaTeX_symbols = 0;
  177: }
  178: 
  179: sub xmlend {
  180:     my ($target,$parser)=@_;
  181:     my $mode='xml';
  182:     my $status='OPEN';
  183:     if ($Apache::lonhomework::parsing_a_problem ||
  184: 	$Apache::lonhomework::parsing_a_task ) {
  185: 	$mode='problem';
  186: 	$status=$Apache::inputtags::status[-1]; 
  187:     }
  188:     my $discussion;
  189:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  190: 					   ['LONCAPA_INTERNAL_no_discussion']);
  191:     if (! exists($env{'form.LONCAPA_INTERNAL_no_discussion'}) ||
  192:         $env{'form.LONCAPA_INTERNAL_no_discussion'} ne 'true') {
  193:         $discussion=&Apache::lonfeedback::list_discussion($mode,$status);
  194:     }
  195:     if ($target eq 'tex') {
  196: 	$discussion.='<tex>\keephidden{ENDOFPROBLEM}\vskip 0.5mm\noindent\makebox[\textwidth/$number_of_columns][b]{\hrulefill}\end{document}</tex>';
  197: 	&Apache::lonxml::newparser($parser,\$discussion,'');
  198: 	return '';
  199:     }
  200: 
  201:     return $discussion;
  202: }
  203: 
  204: sub tokeninputfield {
  205:     my $defhost=$Apache::lonnet::perlvar{'lonHostID'};
  206:     $defhost=~tr/a-z/A-Z/;
  207:     return (<<ENDINPUTFIELD)
  208: <script type="text/javascript">
  209:     function updatetoken() {
  210: 	var comp=new Array;
  211:         var barcode=unescape(document.tokeninput.barcode.value);
  212:         comp=barcode.split('*');
  213:         if (typeof(comp[0])!="undefined") {
  214: 	    document.tokeninput.codeone.value=comp[0];
  215: 	}
  216:         if (typeof(comp[1])!="undefined") {
  217: 	    document.tokeninput.codetwo.value=comp[1];
  218: 	}
  219:         if (typeof(comp[2])!="undefined") {
  220:             comp[2]=comp[2].toUpperCase();
  221: 	    document.tokeninput.codethree.value=comp[2];
  222: 	}
  223:         document.tokeninput.barcode.value='';
  224:     }  
  225: </script>
  226: <form method="post" name="tokeninput">
  227: <table border="2" bgcolor="#FFFFBB">
  228: <tr><th>DocID Checkin</th></tr>
  229: <tr><td>
  230: <table>
  231: <tr>
  232: <td>Scan in Barcode</td>
  233: <td><input type="text" size="22" name="barcode" 
  234: onChange="updatetoken()"/></td>
  235: </tr>
  236: <tr><td><i>or</i> Type in DocID</td>
  237: <td>
  238: <input type="text" size="5" name="codeone" />
  239: <b><font size="+2">*</font></b>
  240: <input type="text" size="5" name="codetwo" />
  241: <b><font size="+2">*</font></b>
  242: <input type="text" size="10" name="codethree" value="$defhost" 
  243: onChange="this.value=this.value.toUpperCase()" />
  244: </td></tr>
  245: </table>
  246: </td></tr>
  247: <tr><td><input type="submit" value="Check in DocID" /></td></tr>
  248: </table>
  249: </form>
  250: ENDINPUTFIELD
  251: }
  252: 
  253: sub maketoken {
  254:     my ($symb,$tuname,$tudom,$tcrsid)=@_;
  255:     unless ($symb) {
  256: 	$symb=&Apache::lonnet::symbread();
  257:     }
  258:     unless ($tuname) {
  259: 	$tuname=$env{'user.name'};
  260:         $tudom=$env{'user.domain'};
  261:         $tcrsid=$env{'request.course.id'};
  262:     }
  263: 
  264:     return &Apache::lonnet::checkout($symb,$tuname,$tudom,$tcrsid);
  265: }
  266: 
  267: sub printtokenheader {
  268:     my ($target,$token,$tsymb,$tcrsid,$tudom,$tuname)=@_;
  269:     unless ($token) { return ''; }
  270: 
  271:     my ($symb,$courseid,$domain,$name) = &Apache::lonnet::whichuser();
  272:     unless ($tsymb) {
  273: 	$tsymb=$symb;
  274:     }
  275:     unless ($tuname) {
  276: 	$tuname=$name;
  277:         $tudom=$domain;
  278:         $tcrsid=$courseid;
  279:     }
  280: 
  281:     my $plainname=&Apache::loncommon::plainname($tuname,$tudom);
  282: 
  283:     if ($target eq 'web') {
  284:         my %idhash=&Apache::lonnet::idrget($tudom,($tuname));
  285: 	return 
  286:  '<img align="right" src="/cgi-bin/barcode.png?encode='.$token.'" />'.
  287:                &mt('Checked out for').' '.$plainname.
  288:                '<br />'.&mt('User').': '.$tuname.' at '.$tudom.
  289: 	       '<br />'.&mt('ID').': '.$idhash{$tuname}.
  290: 	       '<br />'.&mt('CourseID').': '.$tcrsid.
  291: 	       '<br />'.&mt('Course').': '.$env{'course.'.$tcrsid.'.description'}.
  292:                '<br />'.&mt('DocID').': '.$token.
  293:                '<br />'.&mt('Time').': '.&Apache::lonlocal::locallocaltime().'<hr />';
  294:     } else {
  295:         return $token;
  296:     }
  297: }
  298: 
  299: sub printalltags {
  300:   my $temp;
  301:   foreach $temp (sort keys %Apache::lonxml::alltags) {
  302:     &Apache::lonxml::debug("$temp -- ".
  303: 		  join(',',@{ $Apache::lonxml::alltags{$temp} }));
  304:   }
  305: }
  306: 
  307: sub xmlparse {
  308:  my ($request,$target,$content_file_string,$safeinit,%style_for_target) = @_;
  309: 
  310:  &setup_globals($request,$target);
  311:  &Apache::inputtags::initialize_inputtags();
  312:  &Apache::bridgetask::initialize_bridgetask();
  313:  &Apache::outputtags::initialize_outputtags();
  314:  &Apache::edit::initialize_edit();
  315:  &Apache::londefdef::initialize_londefdef();
  316: 
  317: #
  318: # do we have a course style file?
  319: #
  320: 
  321:  if ($env{'request.course.id'} && $env{'request.state'} ne 'construct') {
  322:      my $bodytext=
  323: 	 $env{'course.'.$env{'request.course.id'}.'.default_xml_style'};
  324:      if ($bodytext) {
  325: 	 foreach my $file (split(',',$bodytext)) {
  326: 	     my $location=&Apache::lonnet::filelocation('',$file);
  327: 	     my $styletext=&Apache::lonnet::getfile($location);
  328: 	     if ($styletext ne '-1') {
  329: 		 %style_for_target = (%style_for_target,
  330: 				      &Apache::style::styleparser($target,$styletext));
  331: 	     }
  332: 	 }
  333:      }
  334:  } elsif ($env{'construct.style'}
  335: 	  && ($env{'request.state'} eq 'construct')) {
  336:      my $location=&Apache::lonnet::filelocation('',$env{'construct.style'});
  337:      my $styletext=&Apache::lonnet::getfile($location);
  338:      if ($styletext ne '-1') {
  339: 	 %style_for_target = (%style_for_target,
  340: 			      &Apache::style::styleparser($target,$styletext));
  341:      }
  342:  }
  343: #&printalltags();
  344:  my @pars = ();
  345:  my $pwd=$env{'request.filename'};
  346:  $pwd =~ s:/[^/]*$::;
  347:  &newparser(\@pars,\$content_file_string,$pwd);
  348: 
  349:  my $safeeval = new Safe;
  350:  my $safehole = new Safe::Hole;
  351:  &init_safespace($target,$safeeval,$safehole,$safeinit);
  352: #-------------------- Redefinition of the target in the case of compound target
  353: 
  354:  ($target, my @tenta) = split('&&',$target);
  355: 
  356:  my @stack = ();
  357:  my @parstack = ();
  358:  &initdepth();
  359:  &init_alarm();
  360:  my $finaloutput = &inner_xmlparse($target,\@stack,\@parstack,\@pars,
  361: 				   $safeeval,\%style_for_target,1);
  362: 
  363:  if (@stack) {
  364:      &warning("At end of file some tags were still left unclosed, ".
  365: 	      '<tt>&lt;'.join('&gt;</tt>, <tt>&lt;',reverse(@stack)).
  366: 	      '&gt;</tt>');
  367:  }
  368:  if ($env{'request.uri'}) {
  369:     &writeallows($env{'request.uri'});
  370:  }
  371:  &do_registered_ssi();
  372:  if ($Apache::lonxml::counter_changed) { &store_counter() }
  373: 
  374:  &clean_safespace($safeeval);
  375: 
  376:  if (@script_var_displays) {
  377:      $finaloutput .= join('',@script_var_displays);
  378:      undef(@script_var_displays);
  379:  }
  380:  &init_state();
  381:  if ($env{'form.return_only_error_and_warning_counts'}) {
  382:      return "$errorcount:$warningcount";
  383:  }
  384:  return $finaloutput;
  385: }
  386: 
  387: sub latex_special_symbols {
  388:     my ($string,$where)=@_;
  389:     #
  390:     #  If e.g. in verbatim mode, then don't substitute.
  391:     #  but return original string.
  392:     #
  393:     if (!($Apache::lonxml::substitute_LaTeX_symbols)) {
  394: 	return $string;
  395:     }
  396:     if ($where eq 'header') {
  397: 	$string =~ s/\\/\$\\backslash\$/g; # \  -> $\backslash$ per LaTex line by line pg  10.
  398: 	$string =~ s/(\$|%|\{|\})/\\$1/g;
  399: 	$string=&Apache::lonprintout::character_chart($string);
  400: 	# any & or # leftover should be safe to just escape
  401:         $string=~s/([^\\])\&/$1\\\&/g;
  402:         $string=~s/([^\\])\#/$1\\\#/g;
  403: 	$string =~ s/_/\\_/g;              # _ -> \_
  404: 	$string =~ s/\^/\\\^{}/g;          # ^ -> \^{} 
  405:     } else {
  406: 	$string=~s/\\/\\ensuremath{\\backslash}/g;
  407: 	$string=~s/\\\%|\%/\\\%/g;
  408: 	$string=~s/\\{|{/\\{/g;
  409: 	$string=~s/\\}|}/\\}/g;
  410: 	$string=~s/\\ensuremath\\{\\backslash\\}/\\ensuremath{\\backslash}/g;
  411: 	$string=~s/\\\$|\$/\\\$/g;
  412: 	$string=~s/\\\_|\_/\\\_/g;
  413:         $string=~s/([^\\]|^)(\~|\^)/$1\\$2\\strut /g;
  414: 	$string=~s/(>|<)/\\ensuremath\{$1\}/g; #more or less
  415: 	$string=&Apache::lonprintout::character_chart($string);
  416: 	# any & or # leftover should be safe to just escape
  417: 	$string=~s/\\\&|\&/\\\&/g;
  418: 	$string=~s/\\\#|\#/\\\#/g;
  419:         $string=~s/\|/\$\\mid\$/g;
  420: #single { or } How to escape?
  421:     }
  422:     return $string;
  423: }
  424: 
  425: sub inner_xmlparse {
  426:   my ($target,$stack,$parstack,$pars,$safeeval,$style_for_target,$start)=@_;
  427:   my $finaloutput = '';
  428:   my $result;
  429:   my $token;
  430:   my $dontpop=0;
  431:   my $startredirection = $Apache::lonxml::redirection;
  432:   while ( $#$pars > -1 ) {
  433:     while ($token = $$pars['-1']->get_token) {
  434:       if (($token->[0] eq 'T') || ($token->[0] eq 'C') ) {
  435: 	if ($metamode<1) {
  436: 	    my $text=$token->[1];
  437: 	    if ($token->[0] eq 'C' && $target eq 'tex') {
  438: 		$text = '';
  439: #		$text = '%'.$text."\n";
  440: 	    }
  441: 	    $result.=$text;
  442: 	}
  443:       } elsif (($token->[0] eq 'D')) {
  444: 	if ($metamode<1 && $target eq 'web') {
  445: 	    my $text=$token->[1];
  446: 	    $result.=$text;
  447: 	}
  448:       } elsif ($token->[0] eq 'PI') {
  449: 	if ($metamode<1 && $target eq 'web') {
  450: 	  $result=$token->[2];
  451: 	}
  452:       } elsif ($token->[0] eq 'S') {
  453: 	# add tag to stack
  454: 	push (@$stack,$token->[1]);
  455: 	# add parameters list to another stack
  456: 	push (@$parstack,&parstring($token));
  457: 	&increasedepth($token);
  458: 	if ($Apache::lonxml::usestyle &&
  459: 	    exists($$style_for_target{$token->[1]})) {
  460: 	    $Apache::lonxml::usestyle=0;
  461: 	    my $string=$$style_for_target{$token->[1]}.
  462: 	      '<LONCAPA_INTERNAL_TURN_STYLE_ON />';
  463: 	    &Apache::lonxml::newparser($pars,\$string);
  464: 	    $Apache::lonxml::style_values=$$parstack[-1];
  465: 	    $Apache::lonxml::style_end_values=$$parstack[-1];
  466: 	} else {
  467: 	  $result = &callsub("start_$token->[1]", $target, $token, $stack,
  468: 			     $parstack, $pars, $safeeval, $style_for_target);
  469: 	}
  470:       } elsif ($token->[0] eq 'E') {
  471: 	if ($Apache::lonxml::usestyle &&
  472: 	    exists($$style_for_target{'/'."$token->[1]"})) {
  473: 	    $Apache::lonxml::usestyle=0;
  474: 	    my $string=$$style_for_target{'/'.$token->[1]}.
  475: 	      '<LONCAPA_INTERNAL_TURN_STYLE_ON end="'.$token->[1].'" />';
  476: 	    &Apache::lonxml::newparser($pars,\$string);
  477: 	    $Apache::lonxml::style_values=$Apache::lonxml::style_end_values;
  478: 	    $Apache::lonxml::style_end_values='';
  479: 	    $dontpop=1;
  480: 	} else {
  481: 	    #clear out any tags that didn't end
  482: 	    while ($token->[1] ne $$stack['-1'] && ($#$stack > -1)) {
  483: 		my $lasttag=$$stack[-1];
  484: 		if ($token->[1] =~ /^\Q$lasttag\E$/i) {
  485: 		    &Apache::lonxml::warning('Using tag &lt;/'.$token->[1].'&gt; on line '.$token->[3].' as end tag to &lt;'.$$stack[-1].'&gt;');
  486: 		    last;
  487: 		} else {
  488: 		    &Apache::lonxml::warning('Found tag &lt;/'.$token->[1].'&gt; on line '.$token->[3].' when looking for &lt;/'.$$stack[-1].'&gt; in file');
  489: 		    &end_tag($stack,$parstack,$token);
  490: 		}
  491: 	    }
  492: 	    $result = &callsub("end_$token->[1]", $target, $token, $stack,
  493: 			       $parstack, $pars,$safeeval, $style_for_target);
  494: 	}
  495:       } else {
  496: 	&Apache::lonxml::error("Unknown token event :$token->[0]:$token->[1]:");
  497:       }
  498:       #evaluate variable refs in result
  499:       if ($Apache::lonxml::post_evaluate &&$result ne "") {
  500: 	  my $extras;
  501: 	  if (!$Apache::lonxml::usestyle) {
  502: 	      $extras=$Apache::lonxml::style_values;
  503: 	  }
  504: 	if ( $#$parstack > -1 ) {
  505: 	  $result=&Apache::run::evaluate($result,$safeeval,$extras.$$parstack[-1]);
  506: 	} else {
  507: 	  $result= &Apache::run::evaluate($result,$safeeval,$extras);
  508: 	}
  509:       }
  510:       $Apache::lonxml::post_evaluate=1;
  511: 
  512:       if (($token->[0] eq 'T') || ($token->[0] eq 'C') || ($token->[0] eq 'D') ) {
  513: 	  #Style file definitions should be correct
  514: 	  if ($target eq 'tex' && ($Apache::lonxml::usestyle)) {
  515: 	      $result=&latex_special_symbols($result);
  516: 	  }
  517:       }
  518: 
  519:       if ($Apache::lonxml::redirection) {
  520: 	$Apache::lonxml::outputstack['-1'] .= $result;
  521:       } else {
  522: 	$finaloutput.=$result;
  523:       }
  524:       $result = '';
  525: 
  526:       if ($token->[0] eq 'E' && !$dontpop) {
  527: 	&end_tag($stack,$parstack,$token);
  528:       }
  529:       $dontpop=0;
  530:     }	
  531:     if ($#$pars > -1) {
  532: 	pop @$pars;
  533: 	pop @Apache::lonxml::pwd;
  534:     }
  535:   }
  536: 
  537:   # if ($target eq 'meta') {
  538:   #   $finaloutput.=&endredirection;
  539:   # }
  540: 
  541:   if ( $start && $target eq 'grade') { &endredirection(); }
  542:   if ( $Apache::lonxml::redirection > $startredirection) {
  543:       while ($Apache::lonxml::redirection > $startredirection) {
  544: 	  $finaloutput .= &endredirection();
  545:       }
  546:   }
  547:   if (($ENV{'QUERY_STRING'}) && ($target eq 'web')) {
  548:     $finaloutput=&afterburn($finaloutput);
  549:   }	    
  550:   return $finaloutput;
  551: }
  552: 
  553: ## 
  554: ## Looks to see if there is a subroutine defined for this tag.  If so, call it,
  555: ## otherwise do not call it as we do not know what it is.
  556: ##
  557: sub callsub {
  558:   my ($sub,$target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  559:   my $currentstring='';
  560:   my $nodefault;
  561:   {
  562:     my $sub1;
  563:     no strict 'refs';
  564:     my $tag=$token->[1];
  565: # get utterly rid of extended html tags
  566:     if ($tag=~/^x\-/i) { return ''; }
  567:     my $space=$Apache::lonxml::alltags{$tag}[-1];
  568:     if (!$space) {
  569:      	$tag=~tr/A-Z/a-z/;
  570: 	$sub=~tr/A-Z/a-z/;
  571: 	$space=$Apache::lonxml::alltags{$tag}[-1]
  572:     }
  573: 
  574:     my $deleted=0;
  575:     if (($token->[0] eq 'S') && ($target eq 'modified')) {
  576:       $deleted=&Apache::edit::handle_delete($space,$target,$token,$tagstack,
  577: 					     $parstack,$parser,$safeeval,
  578: 					     $style);
  579:     }
  580:     if (!$deleted) {
  581:       if ($space) {
  582: 	#&Apache::lonxml::debug("Calling sub $sub in $space $metamode");
  583: 	$sub1="$space\:\:$sub";
  584: 	($currentstring,$nodefault) = &$sub1($target,$token,$tagstack,
  585: 					     $parstack,$parser,$safeeval,
  586: 					     $style);
  587:       } else {
  588:           if ($target eq 'tex') {
  589:               # throw away tag name
  590:               return '';
  591:           }
  592: 	#&Apache::lonxml::debug("NOT Calling sub $sub in $space $metamode");
  593: 	if ($metamode <1) {
  594: 	  if (defined($token->[4]) && ($metamode < 1)) {
  595: 	    $currentstring = $token->[4];
  596: 	  } else {
  597: 	    $currentstring = $token->[2];
  598: 	  }
  599: 	}
  600:       }
  601:       #    &Apache::lonxml::debug("nodefalt:$nodefault:");
  602:       if ($currentstring eq '' && $nodefault eq '') {
  603: 	if ($target eq 'edit') {
  604: 	  #&Apache::lonxml::debug("doing default edit for $token->[1]");
  605: 	  if ($token->[0] eq 'S') {
  606: 	    $currentstring = &Apache::edit::tag_start($target,$token);
  607: 	  } elsif ($token->[0] eq 'E') {
  608: 	    $currentstring = &Apache::edit::tag_end($target,$token);
  609: 	  }
  610: 	}
  611:       }
  612:       if ($target eq 'modified' && $nodefault eq '') {
  613: 	  if ($currentstring eq '') {
  614: 	      if ($token->[0] eq 'S') {
  615: 		  $currentstring = $token->[4];
  616: 	      } elsif ($token->[0] eq 'E') {
  617: 		  $currentstring = $token->[2];
  618: 	      } else {
  619: 		  $currentstring = $token->[2];
  620: 	      }
  621: 	  }
  622: 	  if ($token->[0] eq 'S') {
  623: 	      $currentstring.=&Apache::edit::handle_insert();
  624: 	  } elsif ($token->[0] eq 'E') {
  625: 	      $currentstring.=&Apache::edit::handle_insertafter($token->[1]);
  626: 	  }
  627:       }
  628:     }
  629:     use strict 'refs';
  630:   }
  631:   return $currentstring;
  632: }
  633: 
  634: {
  635:     my %state;
  636: 
  637:     sub init_state {
  638: 	undef(%state);
  639:     }
  640:     
  641:     sub set_state {
  642: 	my ($key,$value) = @_;
  643: 	$state{$key} = $value;
  644: 	return $value;
  645:     }
  646:     sub get_state {
  647: 	my ($key) = @_;
  648: 	return $state{$key};
  649:     }
  650: }
  651: 
  652: sub setup_globals {
  653:   my ($request,$target)=@_;
  654:   $Apache::lonxml::request=$request;
  655:   $errorcount=0;
  656:   $warningcount=0;
  657:   $Apache::lonxml::default_homework_loaded=0;
  658:   $Apache::lonxml::usestyle=1;
  659:   &init_counter();
  660:   &clear_bubble_lines_for_part();
  661:   &init_state();
  662:   &set_state('target',$target);
  663:   @Apache::lonxml::pwd=();
  664:   @Apache::lonxml::extlinks=();
  665:   @script_var_displays=();
  666:   @Apache::lonxml::ssi_info=();
  667:   $Apache::lonxml::post_evaluate=1;
  668:   $Apache::lonxml::warnings_error_header='';
  669:   $Apache::lonxml::substitute_LaTeX_symbols = 1;
  670:   if ($target eq 'meta') {
  671:     $Apache::lonxml::redirection = 0;
  672:     $Apache::lonxml::metamode = 1;
  673:     $Apache::lonxml::evaluate = 1;
  674:     $Apache::lonxml::import = 0;
  675:   } elsif ($target eq 'answer') {
  676:     $Apache::lonxml::redirection = 0;
  677:     $Apache::lonxml::metamode = 1;
  678:     $Apache::lonxml::evaluate = 1;
  679:     $Apache::lonxml::import = 1;
  680:   } elsif ($target eq 'grade') {
  681:     &startredirection(); #ended in inner_xmlparse on exit
  682:     $Apache::lonxml::metamode = 0;
  683:     $Apache::lonxml::evaluate = 1;
  684:     $Apache::lonxml::import = 1;
  685:   } elsif ($target eq 'modified') {
  686:     $Apache::lonxml::redirection = 0;
  687:     $Apache::lonxml::metamode = 0;
  688:     $Apache::lonxml::evaluate = 0;
  689:     $Apache::lonxml::import = 0;
  690:   } elsif ($target eq 'edit') {
  691:     $Apache::lonxml::redirection = 0;
  692:     $Apache::lonxml::metamode = 0;
  693:     $Apache::lonxml::evaluate = 0;
  694:     $Apache::lonxml::import = 0;
  695:   } elsif ($target eq 'analyze') {
  696:     $Apache::lonxml::redirection = 0;
  697:     $Apache::lonxml::metamode = 0;
  698:     $Apache::lonxml::evaluate = 1;
  699:     $Apache::lonxml::import = 1;
  700:   } else {
  701:     $Apache::lonxml::redirection = 0;
  702:     $Apache::lonxml::metamode = 0;
  703:     $Apache::lonxml::evaluate = 1;
  704:     $Apache::lonxml::import = 1;
  705:   }
  706: }
  707: 
  708: sub init_safespace {
  709:   my ($target,$safeeval,$safehole,$safeinit) = @_;
  710:   $safeeval->deny_only(':dangerous');
  711:   $safeeval->reval('use Math::Complex;');
  712:   $safeeval->permit_only(":default");
  713:   $safeeval->permit("entereval");
  714:   $safeeval->permit(":base_math");
  715:   $safeeval->permit("sort");
  716:   $safeeval->permit("time");
  717:   $safeeval->deny("rand");
  718:   $safeeval->deny("srand");
  719:   $safeeval->deny(":base_io");
  720:   $safehole->wrap(\&Apache::scripttag::xmlparse,$safeeval,'&xmlparse');
  721:   $safehole->wrap(\&Apache::outputtags::multipart,$safeeval,'&multipart');
  722:   $safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&EXT');
  723:   $safehole->wrap(\&Apache::chemresponse::chem_standard_order,$safeeval,
  724: 		  '&chem_standard_order');
  725:   $safehole->wrap(\&Apache::response::check_status,$safeeval,'&check_status');
  726: 
  727:   $safehole->wrap(\&Apache::lonmaxima::maxima_eval,$safeeval,'&maxima_eval');
  728:   $safehole->wrap(\&Apache::lonmaxima::maxima_check,$safeeval,'&maxima_check');
  729:   $safehole->wrap(\&Apache::lonmaxima::maxima_cas_formula_fix,$safeeval,
  730: 		  '&maxima_cas_formula_fix');
  731: 
  732:   $safehole->wrap(\&Apache::caparesponse::capa_formula_fix,$safeeval,
  733: 		  '&capa_formula_fix');
  734: 
  735:   $safehole->wrap(\&Math::Cephes::asin,$safeeval,'&asin');
  736:   $safehole->wrap(\&Math::Cephes::acos,$safeeval,'&acos');
  737:   $safehole->wrap(\&Math::Cephes::atan,$safeeval,'&atan');
  738:   $safehole->wrap(\&Math::Cephes::sinh,$safeeval,'&sinh');
  739:   $safehole->wrap(\&Math::Cephes::cosh,$safeeval,'&cosh');
  740:   $safehole->wrap(\&Math::Cephes::tanh,$safeeval,'&tanh');
  741:   $safehole->wrap(\&Math::Cephes::asinh,$safeeval,'&asinh');
  742:   $safehole->wrap(\&Math::Cephes::acosh,$safeeval,'&acosh');
  743:   $safehole->wrap(\&Math::Cephes::atanh,$safeeval,'&atanh');
  744:   $safehole->wrap(\&Math::Cephes::erf,$safeeval,'&erf');
  745:   $safehole->wrap(\&Math::Cephes::erfc,$safeeval,'&erfc');
  746:   $safehole->wrap(\&Math::Cephes::j0,$safeeval,'&j0');
  747:   $safehole->wrap(\&Math::Cephes::j1,$safeeval,'&j1');
  748:   $safehole->wrap(\&Math::Cephes::jn,$safeeval,'&jn');
  749:   $safehole->wrap(\&Math::Cephes::jv,$safeeval,'&jv');
  750:   $safehole->wrap(\&Math::Cephes::y0,$safeeval,'&y0');
  751:   $safehole->wrap(\&Math::Cephes::y1,$safeeval,'&y1');
  752:   $safehole->wrap(\&Math::Cephes::yn,$safeeval,'&yn');
  753:   $safehole->wrap(\&Math::Cephes::yv,$safeeval,'&yv');
  754:   
  755:   $safehole->wrap(\&Math::Cephes::bdtr  ,$safeeval,'&bdtr'  );
  756:   $safehole->wrap(\&Math::Cephes::bdtrc ,$safeeval,'&bdtrc' );
  757:   $safehole->wrap(\&Math::Cephes::bdtri ,$safeeval,'&bdtri' );
  758:   $safehole->wrap(\&Math::Cephes::btdtr ,$safeeval,'&btdtr' );
  759:   $safehole->wrap(\&Math::Cephes::chdtr ,$safeeval,'&chdtr' );
  760:   $safehole->wrap(\&Math::Cephes::chdtrc,$safeeval,'&chdtrc');
  761:   $safehole->wrap(\&Math::Cephes::chdtri,$safeeval,'&chdtri');
  762:   $safehole->wrap(\&Math::Cephes::fdtr  ,$safeeval,'&fdtr'  );
  763:   $safehole->wrap(\&Math::Cephes::fdtrc ,$safeeval,'&fdtrc' );
  764:   $safehole->wrap(\&Math::Cephes::fdtri ,$safeeval,'&fdtri' );
  765:   $safehole->wrap(\&Math::Cephes::gdtr  ,$safeeval,'&gdtr'  );
  766:   $safehole->wrap(\&Math::Cephes::gdtrc ,$safeeval,'&gdtrc' );
  767:   $safehole->wrap(\&Math::Cephes::nbdtr ,$safeeval,'&nbdtr' );
  768:   $safehole->wrap(\&Math::Cephes::nbdtrc,$safeeval,'&nbdtrc');
  769:   $safehole->wrap(\&Math::Cephes::nbdtri,$safeeval,'&nbdtri');
  770:   $safehole->wrap(\&Math::Cephes::ndtr  ,$safeeval,'&ndtr'  );
  771:   $safehole->wrap(\&Math::Cephes::ndtri ,$safeeval,'&ndtri' );
  772:   $safehole->wrap(\&Math::Cephes::pdtr  ,$safeeval,'&pdtr'  );
  773:   $safehole->wrap(\&Math::Cephes::pdtrc ,$safeeval,'&pdtrc' );
  774:   $safehole->wrap(\&Math::Cephes::pdtri ,$safeeval,'&pdtri' );
  775:   $safehole->wrap(\&Math::Cephes::stdtr ,$safeeval,'&stdtr' );
  776:   $safehole->wrap(\&Math::Cephes::stdtri,$safeeval,'&stdtri');
  777: 
  778:   $safehole->wrap(\&Math::Cephes::Matrix::mat,$safeeval,'&mat');
  779:   $safehole->wrap(\&Math::Cephes::Matrix::new,$safeeval,
  780: 		  '&Math::Cephes::Matrix::new');
  781:   $safehole->wrap(\&Math::Cephes::Matrix::coef,$safeeval,
  782: 		  '&Math::Cephes::Matrix::coef');
  783:   $safehole->wrap(\&Math::Cephes::Matrix::clr,$safeeval,
  784: 		  '&Math::Cephes::Matrix::clr');
  785:   $safehole->wrap(\&Math::Cephes::Matrix::add,$safeeval,
  786: 		  '&Math::Cephes::Matrix::add');
  787:   $safehole->wrap(\&Math::Cephes::Matrix::sub,$safeeval,
  788: 		  '&Math::Cephes::Matrix::sub');
  789:   $safehole->wrap(\&Math::Cephes::Matrix::mul,$safeeval,
  790: 		  '&Math::Cephes::Matrix::mul');
  791:   $safehole->wrap(\&Math::Cephes::Matrix::div,$safeeval,
  792: 		  '&Math::Cephes::Matrix::div');
  793:   $safehole->wrap(\&Math::Cephes::Matrix::inv,$safeeval,
  794: 		  '&Math::Cephes::Matrix::inv');
  795:   $safehole->wrap(\&Math::Cephes::Matrix::transp,$safeeval,
  796: 		  '&Math::Cephes::Matrix::transp');
  797:   $safehole->wrap(\&Math::Cephes::Matrix::simq,$safeeval,
  798: 		  '&Math::Cephes::Matrix::simq');
  799:   $safehole->wrap(\&Math::Cephes::Matrix::mat_to_vec,$safeeval,
  800: 		  '&Math::Cephes::Matrix::mat_to_vec');
  801:   $safehole->wrap(\&Math::Cephes::Matrix::vec_to_mat,$safeeval,
  802: 		  '&Math::Cephes::Matrix::vec_to_mat');
  803:   $safehole->wrap(\&Math::Cephes::Matrix::check,$safeeval,
  804: 		  '&Math::Cephes::Matrix::check');
  805:   $safehole->wrap(\&Math::Cephes::Matrix::check,$safeeval,
  806: 		  '&Math::Cephes::Matrix::check');
  807: 
  808: #  $safehole->wrap(\&Math::Cephes::new_fract,$safeeval,'&new_fract');
  809: #  $safehole->wrap(\&Math::Cephes::radd,$safeeval,'&radd');
  810: #  $safehole->wrap(\&Math::Cephes::rsub,$safeeval,'&rsub');
  811: #  $safehole->wrap(\&Math::Cephes::rmul,$safeeval,'&rmul');
  812: #  $safehole->wrap(\&Math::Cephes::rdiv,$safeeval,'&rdiv');
  813: #  $safehole->wrap(\&Math::Cephes::euclid,$safeeval,'&euclid');
  814: 
  815:   $safehole->wrap(\&Math::Random::random_beta,$safeeval,'&math_random_beta');
  816:   $safehole->wrap(\&Math::Random::random_chi_square,$safeeval,'&math_random_chi_square');
  817:   $safehole->wrap(\&Math::Random::random_exponential,$safeeval,'&math_random_exponential');
  818:   $safehole->wrap(\&Math::Random::random_f,$safeeval,'&math_random_f');
  819:   $safehole->wrap(\&Math::Random::random_gamma,$safeeval,'&math_random_gamma');
  820:   $safehole->wrap(\&Math::Random::random_multivariate_normal,$safeeval,'&math_random_multivariate_normal');
  821:   $safehole->wrap(\&Math::Random::random_multinomial,$safeeval,'&math_random_multinomial');
  822:   $safehole->wrap(\&Math::Random::random_noncentral_chi_square,$safeeval,'&math_random_noncentral_chi_square');
  823:   $safehole->wrap(\&Math::Random::random_noncentral_f,$safeeval,'&math_random_noncentral_f');
  824:   $safehole->wrap(\&Math::Random::random_normal,$safeeval,'&math_random_normal');
  825:   $safehole->wrap(\&Math::Random::random_permutation,$safeeval,'&math_random_permutation');
  826:   $safehole->wrap(\&Math::Random::random_permuted_index,$safeeval,'&math_random_permuted_index');
  827:   $safehole->wrap(\&Math::Random::random_uniform,$safeeval,'&math_random_uniform');
  828:   $safehole->wrap(\&Math::Random::random_poisson,$safeeval,'&math_random_poisson');
  829:   $safehole->wrap(\&Math::Random::random_uniform_integer,$safeeval,'&math_random_uniform_integer');
  830:   $safehole->wrap(\&Math::Random::random_negative_binomial,$safeeval,'&math_random_negative_binomial');
  831:   $safehole->wrap(\&Math::Random::random_binomial,$safeeval,'&math_random_binomial');
  832:   $safehole->wrap(\&Math::Random::random_seed_from_phrase,$safeeval,'&random_seed_from_phrase');
  833:   $safehole->wrap(\&Math::Random::random_set_seed_from_phrase,$safeeval,'&random_set_seed_from_phrase');
  834:   $safehole->wrap(\&Math::Random::random_get_seed,$safeeval,'&random_get_seed');
  835:   $safehole->wrap(\&Math::Random::random_set_seed,$safeeval,'&random_set_seed');
  836:   $safehole->wrap(\&Apache::loncommon::languages,$safeeval,'&languages');
  837:   $safehole->wrap(\&Apache::lonxml::error,$safeeval,'&LONCAPA_INTERNAL_ERROR');
  838:   $safehole->wrap(\&Apache::lonxml::debug,$safeeval,'&LONCAPA_INTERNAL_DEBUG');
  839:   $safehole->wrap(\&Apache::lonnet::logthis,$safeeval,'&LONCAPA_INTERNAL_LOGTHIS');
  840:   $safehole->wrap(\&Apache::inputtags::finalizeawards,$safeeval,'&LONCAPA_INTERNAL_FINALIZEAWARDS');
  841:   $safehole->wrap(\&Apache::caparesponse::get_sigrange,$safeeval,'&LONCAPA_INTERNAL_get_sigrange');
  842: #  use Data::Dumper;
  843: #  $safehole->wrap(\&Data::Dumper::Dumper,$safeeval,'&LONCAPA_INTERNAL_Dumper');
  844: #need to inspect this class of ops
  845: # $safeeval->deny(":base_orig");
  846:   $safeeval->permit("require");
  847:   $safeinit .= ';$external::target="'.$target.'";';
  848:   &Apache::run::run($safeinit,$safeeval);
  849:   &initialize_rndseed($safeeval);
  850: }
  851: 
  852: sub clean_safespace {
  853:     my ($safeeval) = @_;
  854:     delete_package_recurse($safeeval->{Root});
  855: }
  856: 
  857: sub delete_package_recurse {
  858:      my ($package) = @_;
  859:      my @subp;
  860:      {
  861: 	 no strict 'refs';
  862: 	 while (my ($key,$val) = each(%{*{"$package\::"}})) {
  863: 	     if (!defined($val)) { next; }
  864: 	     local (*ENTRY) = $val;
  865: 	     if (defined *ENTRY{HASH} && $key =~ /::$/ &&
  866: 		 $key ne "main::" && $key ne "<none>::")
  867: 	     {
  868: 		 my ($p) = $package ne "main" ? "$package\::" : "";
  869: 		 ($p .= $key) =~ s/::$//;
  870: 		 push(@subp,$p);
  871: 	     }
  872: 	 }
  873:      }
  874:      foreach my $p (@subp) {
  875: 	 delete_package_recurse($p);
  876:      }
  877:      Symbol::delete_package($package);
  878: }
  879: 
  880: sub initialize_rndseed {
  881:     my ($safeeval)=@_;
  882:     my $rndseed;
  883:     my ($symb,$courseid,$domain,$name) = &Apache::lonnet::whichuser();
  884:     $rndseed=&Apache::lonnet::rndseed($symb,$courseid,$domain,$name);
  885:     my $safeinit = '$external::randomseed="'.$rndseed.'";';
  886:     &Apache::lonxml::debug("Setting rndseed to $rndseed");
  887:     &Apache::run::run($safeinit,$safeeval);
  888: }
  889: 
  890: sub default_homework_load {
  891:     my ($safeeval)=@_;
  892:     &Apache::lonxml::debug('Loading default_homework');
  893:     my $default=&Apache::lonnet::getfile('/home/httpd/html/res/adm/includes/default_homework.lcpm');
  894:     if ($default eq -1) {
  895: 	&Apache::lonxml::error("<b>Unable to find <i>default_homework.lcpm</i></b>");
  896:     } else {
  897: 	&Apache::run::run($default,$safeeval);
  898: 	$Apache::lonxml::default_homework_loaded=1;
  899:     }
  900: }
  901: 
  902: {
  903:     my $alarm_depth;
  904:     sub init_alarm {
  905: 	alarm(0);
  906: 	$alarm_depth=0;
  907:     }
  908: 
  909:     sub start_alarm {
  910: 	if ($alarm_depth<1) {
  911: 	    my $old=alarm($Apache::lonnet::perlvar{'lonScriptTimeout'});
  912: 	    if ($old) {
  913: 		&Apache::lonxml::error("Cancelled an alarm of $old, this shouldn't occur.");
  914: 	    }
  915: 	}
  916: 	$alarm_depth++;
  917:     }
  918: 
  919:     sub end_alarm {
  920: 	$alarm_depth--;
  921: 	if ($alarm_depth<1) { alarm(0); }
  922:     }
  923: }
  924: my $metamode_was;
  925: sub startredirection {
  926:     if (!$Apache::lonxml::redirection) {
  927: 	$metamode_was=$Apache::lonxml::metamode;
  928:     }
  929:     $Apache::lonxml::metamode=0;
  930:     $Apache::lonxml::redirection++;
  931:     push (@Apache::lonxml::outputstack, '');
  932: }
  933: 
  934: sub endredirection {
  935:     if (!$Apache::lonxml::redirection) {
  936: 	&Apache::lonxml::error("Endredirection was called before a startredirection, perhaps you have unbalanced tags. Some debugging information:".join ":",caller);
  937: 	return '';
  938:     }
  939:     $Apache::lonxml::redirection--;
  940:     if (!$Apache::lonxml::redirection) {
  941: 	$Apache::lonxml::metamode=$metamode_was;
  942:     }
  943:     pop @Apache::lonxml::outputstack;
  944: }
  945: sub in_redirection {
  946:     return ($Apache::lonxml::redirection > 0)
  947: }
  948: 
  949: sub end_tag {
  950:   my ($tagstack,$parstack,$token)=@_;
  951:   pop(@$tagstack);
  952:   pop(@$parstack);
  953:   &decreasedepth($token);
  954: }
  955: 
  956: sub initdepth {
  957:   @Apache::lonxml::depthcounter=();
  958:   undef($Apache::lonxml::last_depth_count);
  959: }
  960: 
  961: 
  962: my @timers;
  963: my $lasttime;
  964: # @Apache::lonxml::depthcounter -> count of tags that exist so
  965: #                                  far at each level
  966: # $Apache::lonxml::last_depth_count -> when ascending, need to
  967: # remember the count for the level below the current level (for
  968: # example going from 1_2 -> 1 -> 1_3 need to remember the 2 )
  969: 
  970: sub increasedepth {
  971:   my ($token) = @_;
  972:   push(@Apache::lonxml::depthcounter,$Apache::lonxml::last_depth_count+1);
  973:   undef($Apache::lonxml::last_depth_count);
  974:   my $time;
  975:   if ($Apache::lonxml::debug eq "1") {
  976:       push(@timers,[&gettimeofday()]);
  977:       $time=&tv_interval($lasttime);
  978:       $lasttime=[&gettimeofday()];
  979:   }
  980:   my $spacing='  'x($#Apache::lonxml::depthcounter);
  981:   $Apache::lonxml::curdepth=join('_',@Apache::lonxml::depthcounter);
  982: #  &Apache::lonxml::debug("s$spacing$Apache::lonxml::depth : $Apache::lonxml::olddepth : $Apache::lonxml::curdepth : $token->[1] : $time");
  983: #print "<br />s $Apache::lonxml::depth : $Apache::lonxml::olddepth : $curdepth : $token->[1]\n";
  984: }
  985: 
  986: sub decreasedepth {
  987:   my ($token) = @_;
  988:   if (  $#Apache::lonxml::depthcounter == -1) {
  989:       &Apache::lonxml::warning(&mt("Missing tags, unable to properly run file."));
  990:   }
  991:   $Apache::lonxml::last_depth_count = pop(@Apache::lonxml::depthcounter);
  992: 
  993:   my ($timer,$time);
  994:   if ($Apache::lonxml::debug eq "1") {
  995:       $timer=pop(@timers);
  996:       $time=&tv_interval($lasttime);
  997:       $lasttime=[&gettimeofday()];
  998:   }
  999:   my $spacing='  'x($#Apache::lonxml::depthcounter);
 1000:   $Apache::lonxml::curdepth = join('_',@Apache::lonxml::depthcounter);
 1001: #  &Apache::lonxml::debug("e$spacing$Apache::lonxml::depth : $Apache::lonxml::olddepth : $Apache::lonxml::curdepth : $token->[1] : $time : ".&tv_interval($timer));
 1002: #print "<br />e $Apache::lonxml::depth : $Apache::lonxml::olddepth : $token->[1] : $curdepth\n";
 1003: }
 1004: 
 1005: sub get_id {
 1006:     my ($parstack,$safeeval)=@_;
 1007:     my $id= &Apache::lonxml::get_param('id',$parstack,$safeeval);
 1008:     if ($env{'request.state'} eq 'construct' && $id =~ /([._]|[^\w\d\s[:punct:]])/) {
 1009: 	&error(&mt("ID &quot;[_1]&quot; contains invalid characters, IDs are only allowed to contain letters, numbers, spaces and -",'<tt>'.$id.'</tt>'));
 1010:     }
 1011:     if ($id =~ /^\s*$/) { $id = $Apache::lonxml::curdepth; }
 1012:     return $id;
 1013: }
 1014: 
 1015: sub get_all_text_unbalanced {
 1016: #there is a copy of this in lonpublisher.pm
 1017:     my($tag,$pars)= @_;
 1018:     my $token;
 1019:     my $result='';
 1020:     $tag='<'.$tag.'>';
 1021:     while ($token = $$pars[-1]->get_token) {
 1022: 	if (($token->[0] eq 'T')||($token->[0] eq 'C')||($token->[0] eq 'D')) {
 1023: 	    if ($token->[0] eq 'T' && $token->[2]) {
 1024: 		$result.='<![CDATA['.$token->[1].']]>';
 1025: 	    } else {
 1026: 		$result.=$token->[1];
 1027: 	    }
 1028: 	} elsif ($token->[0] eq 'PI') {
 1029: 	    $result.=$token->[2];
 1030: 	} elsif ($token->[0] eq 'S') {
 1031: 	    $result.=$token->[4];
 1032: 	} elsif ($token->[0] eq 'E')  {
 1033: 	    $result.=$token->[2];
 1034: 	}
 1035: 	if ($result =~ /\Q$tag\E/is) {
 1036: 	    ($result,my $redo)=$result =~ /(.*)\Q$tag\E(.*)/is;
 1037: 	    #&Apache::lonxml::debug('Got a winner with leftovers ::'.$2);
 1038: 	    #&Apache::lonxml::debug('Result is :'.$1);
 1039: 	    $redo=$tag.$redo;
 1040: 	    &Apache::lonxml::newparser($pars,\$redo);
 1041: 	    last;
 1042: 	}
 1043:     }
 1044:     return $result
 1045: 
 1046: }
 1047: 
 1048: #########################################################################
 1049: #                                                                       #
 1050: #           bubble line counter management                              #
 1051: #                                                                       #
 1052: #########################################################################
 1053: 
 1054: =pod
 1055: 
 1056: For bubble grading mode and exam bubble printing mode, the tracking of
 1057: the current 'bubble line number' is stored in the %env element
 1058: 'form.counter', and is modifed and handled by the following routines.
 1059: 
 1060: The value of it is stored in $Apache:lonxml::counter when live and
 1061: stored back to env after done.
 1062: 
 1063: =item &increment_counter($increment);
 1064: 
 1065: Increments the internal counter environment variable a specified amount
 1066: 
 1067: Optional Arguments:
 1068:   $increment - amount to increment by (defaults to 1)
 1069:                Also 1 if the value is negative or zero.
 1070:   $part_response - A concatenation of the part and response id
 1071:                    identifying exactly what is being 'answered'.
 1072: 
 1073: 
 1074: =cut
 1075: 
 1076: sub increment_counter {
 1077:     my ($increment, $part_response) = @_;
 1078:     if (!defined($increment) || $increment le 0) {
 1079: 	$increment = 1;
 1080:     }
 1081:     $Apache::lonxml::counter += $increment;
 1082: 
 1083:     # If the caller supplied the response_id parameter, 
 1084:     # Maintain its counter.. creating if necessary.
 1085: 
 1086:     if (defined($part_response)) {
 1087: 	if (!defined($Apache::lonxml::counters_per_part{$part_response})) {
 1088: 	    $Apache::lonxml::counters_per_part{$part_response} = 0;
 1089: 	}
 1090: 	$Apache::lonxml::counters_per_part{$part_response} += $increment;
 1091: 	my $new_value = $Apache::lonxml::counters_per_part{$part_response};
 1092:     }
 1093: 	
 1094:     $Apache::lonxml::counter_changed=1;
 1095: }
 1096: 
 1097: =pod
 1098: 
 1099: =item &init_counter($increment);
 1100: 
 1101: Initialize the internal counter environment variable
 1102: 
 1103: =cut
 1104: 
 1105: sub init_counter {
 1106:     if ($env{'request.state'} eq 'construct') {
 1107: 	$Apache::lonxml::counter=1;
 1108: 	$Apache::lonxml::counter_changed=1;
 1109:     } elsif (defined($env{'form.counter'})) {
 1110: 	$Apache::lonxml::counter=$env{'form.counter'};
 1111: 	$Apache::lonxml::counter_changed=0;
 1112:     } else {
 1113: 	$Apache::lonxml::counter=1;
 1114: 	$Apache::lonxml::counter_changed=1;
 1115:     }
 1116: }
 1117: 
 1118: sub store_counter {
 1119:     &Apache::lonnet::appenv(('form.counter' => $Apache::lonxml::counter));
 1120:     $Apache::lonxml::counter_changed=0;
 1121:     return '';
 1122: }
 1123: 
 1124: {
 1125:     my $state;
 1126:     sub clear_problem_counter {
 1127: 	undef($state);
 1128: 	&Apache::lonnet::delenv('form.counter');
 1129: 	&Apache::lonxml::init_counter();
 1130: 	&Apache::lonxml::store_counter();
 1131:     }
 1132: 
 1133:     sub remember_problem_counter {
 1134: 	&Apache::lonnet::transfer_profile_to_env(undef,undef,1);
 1135: 	$state = $env{'form.counter'};
 1136:     }
 1137: 
 1138:     sub restore_problem_counter {
 1139: 	if (defined($state)) {
 1140: 	    &Apache::lonnet::appenv(('form.counter' => $state));
 1141: 	}
 1142:     }
 1143:     sub get_problem_counter {
 1144: 	if ($Apache::lonxml::counter_changed) { &store_counter() }
 1145: 	&Apache::lonnet::transfer_profile_to_env(undef,undef,1);
 1146: 	return $env{'form.counter'};
 1147:     }
 1148: }
 1149: 
 1150: =pod
 1151: 
 1152: =item  bubble_lines_for_part(part_response)
 1153: 
 1154: Returns the number of lines required to get a response for
 1155: $part_response (this is just $Apache::lonxml::counters_per_part{$part_response}
 1156: 
 1157: =cut
 1158: 
 1159: sub bubble_lines_for_part {
 1160:     my ($part_response) = @_;
 1161: 
 1162:     if (!defined($Apache::lonxml::counters_per_part{$part_response})) {
 1163: 	return 0;
 1164:     } else {
 1165: 	return $Apache::lonxml::counters_per_part{$part_response};
 1166:     }
 1167: }
 1168: 
 1169: =pod
 1170: 
 1171: =item clear_bubble_lines_for_part
 1172: 
 1173: Clears the hash of bubble lines per part.  If a caller
 1174: needs to analyze several resources this should be called between
 1175: resources to reset the hash for each problem being analyzed.
 1176: 
 1177: =cut
 1178: 
 1179: sub clear_bubble_lines_for_part {
 1180:     undef(%Apache::lonxml::counters_per_part);
 1181: }
 1182: 
 1183: =pod
 1184: 
 1185: =item set_bubble_lines(part_response, value)
 1186: 
 1187: If there is a problem part, that for whatever reason
 1188: requires bubble lines that are not
 1189: the same as the counter increment, it can call this sub during
 1190: analysis to set its hash value explicitly.
 1191: 
 1192: =cut
 1193: 
 1194: sub set_bubble_lines {
 1195:     my ($part_response, $value) = @_;
 1196: 
 1197:     $Apache::lonxml::counters_per_part{$part_response} = $value;
 1198: }
 1199: 
 1200: =pod
 1201: 
 1202: =item get_bubble_line_hash
 1203: 
 1204: Returns the current bubble line hash.  This is assumed to 
 1205: be small so we return a copy
 1206: 
 1207: 
 1208: =cut
 1209: 
 1210: sub get_bubble_line_hash {
 1211:     return %Apache::lonxml::counters_per_part;
 1212: }
 1213: 
 1214: 
 1215: #--------------------------------------------------
 1216: 
 1217: sub get_all_text {
 1218:     my($tag,$pars,$style)= @_;
 1219:     my $gotfullstack=1;
 1220:     if (ref($pars) ne 'ARRAY') {
 1221: 	$gotfullstack=0;
 1222: 	$pars=[$pars];
 1223:     }
 1224:     if (ref($style) ne 'HASH') {
 1225: 	$style={};
 1226:     }
 1227:     my $depth=0;
 1228:     my $token;
 1229:     my $result='';
 1230:     if ( $tag =~ m:^/: ) { 
 1231: 	my $tag=substr($tag,1); 
 1232: 	#&Apache::lonxml::debug("have:$tag:");
 1233: 	my $top_empty=0;
 1234: 	while (($depth >=0) && ($#$pars > -1) && (!$top_empty)) {
 1235: 	    while (($depth >=0) && ($token = $$pars[-1]->get_token)) {
 1236: 		#&Apache::lonxml::debug("e token:$token->[0]:$depth:$token->[1]:".$#$pars.":".$#Apache::lonxml::pwd);
 1237: 		if (($token->[0] eq 'T')||($token->[0] eq 'C')||($token->[0] eq 'D')) {
 1238: 		    if ($token->[2]) {
 1239: 			$result.='<![CDATA['.$token->[1].']]>';
 1240: 		    } else {
 1241: 			$result.=$token->[1];
 1242: 		    }
 1243: 		} elsif ($token->[0] eq 'PI') {
 1244: 		    $result.=$token->[2];
 1245: 		} elsif ($token->[0] eq 'S') {
 1246: 		    if ($token->[1] =~ /^\Q$tag\E$/i) { $depth++; }
 1247: 		    if ($token->[1] =~ /^LONCAPA_INTERNAL_TURN_STYLE_ON$/) { $Apache::lonxml::usestyle=1; }
 1248: 		    if ($token->[1] =~ /^LONCAPA_INTERNAL_TURN_STYLE_OFF$/) { $Apache::lonxml::usestyle=0; }
 1249: 		    $result.=$token->[4];
 1250: 		} elsif ($token->[0] eq 'E')  {
 1251: 		    if ( $token->[1] =~ /^\Q$tag\E$/i) { $depth--; }
 1252: 		    #skip sending back the last end tag
 1253: 		    if ($depth == 0 && exists($$style{'/'.$token->[1]}) && $Apache::lonxml::usestyle) {
 1254: 			my $string=
 1255: 			    '<LONCAPA_INTERNAL_TURN_STYLE_OFF end="yes" />'.
 1256: 				$$style{'/'.$token->[1]}.
 1257: 				    $token->[2].
 1258: 					'<LONCAPA_INTERNAL_TURN_STYLE_ON />';
 1259: 			&Apache::lonxml::newparser($pars,\$string);
 1260: 			#&Apache::lonxml::debug("reParsing $string");
 1261: 			next;
 1262: 		    }
 1263: 		    if ($depth > -1) {
 1264: 			$result.=$token->[2];
 1265: 		    } else {
 1266: 			$$pars[-1]->unget_token($token);
 1267: 		    }
 1268: 		}
 1269: 	    }
 1270: 	    if (($depth >=0) && ($#$pars == 0) ) { $top_empty=1; }
 1271: 	    if (($depth >=0) && ($#$pars > 0) ) {
 1272: 		pop(@$pars);
 1273: 		pop(@Apache::lonxml::pwd);
 1274: 	    }
 1275: 	}
 1276: 	if ($top_empty && $depth >= 0) {
 1277: 	    #never found the end tag ran out of text, throw error send back blank
 1278: 	    &error('Never found end tag for &lt;'.$tag.
 1279: 		   '&gt; current string <pre>'.
 1280: 		   &HTML::Entities::encode($result,'<>&"').
 1281: 		   '</pre>');
 1282: 	    if ($gotfullstack) {
 1283: 		my $newstring='</'.$tag.'>'.$result;
 1284: 		&Apache::lonxml::newparser($pars,\$newstring);
 1285: 	    }
 1286: 	    $result='';
 1287: 	}
 1288:     } else {
 1289: 	while ($#$pars > -1) {
 1290: 	    while ($token = $$pars[-1]->get_token) {
 1291: 		#&Apache::lonxml::debug("s token:$token->[0]:$depth:$token->[1]");
 1292: 		if (($token->[0] eq 'T')||($token->[0] eq 'C')||
 1293: 		    ($token->[0] eq 'D')) {
 1294: 		    if ($token->[2]) {
 1295: 			$result.='<![CDATA['.$token->[1].']]>';
 1296: 		    } else {
 1297: 			$result.=$token->[1];
 1298: 		    }
 1299: 		} elsif ($token->[0] eq 'PI') {
 1300: 		    $result.=$token->[2];
 1301: 		} elsif ($token->[0] eq 'S') {
 1302: 		    if ( $token->[1] =~ /^\Q$tag\E$/i) {
 1303: 			$$pars[-1]->unget_token($token); last;
 1304: 		    } else {
 1305: 			$result.=$token->[4];
 1306: 		    }
 1307: 		    if ($token->[1] =~ /^LONCAPA_INTERNAL_TURN_STYLE_ON$/) { $Apache::lonxml::usestyle=1; }
 1308: 		    if ($token->[1] =~ /^LONCAPA_INTERNAL_TURN_STYLE_OFF$/) { $Apache::lonxml::usestyle=0; }
 1309: 		} elsif ($token->[0] eq 'E')  {
 1310: 		    $result.=$token->[2];
 1311: 		}
 1312: 	    }
 1313: 	    if (($#$pars > 0) ) {
 1314: 		pop(@$pars);
 1315: 		pop(@Apache::lonxml::pwd);
 1316: 	    } else { last; }
 1317: 	}
 1318:     }
 1319:     #&Apache::lonxml::debug("Exit:$result:");
 1320:     return $result
 1321: }
 1322: 
 1323: sub newparser {
 1324:   my ($parser,$contentref,$dir) = @_;
 1325:   push (@$parser,HTML::LCParser->new($contentref));
 1326:   $$parser[-1]->xml_mode(1);
 1327:   $$parser[-1]->marked_sections(1);
 1328:   if ( $dir eq '' ) {
 1329:     push (@Apache::lonxml::pwd, $Apache::lonxml::pwd[$#Apache::lonxml::pwd]);
 1330:   } else {
 1331:     push (@Apache::lonxml::pwd, $dir);
 1332:   } 
 1333: }
 1334: 
 1335: sub parstring {
 1336:     my ($token) = @_;
 1337:     my (@vars,@values);
 1338:     foreach my $attr (@{$token->[3]}) {
 1339: 	if ($attr!~/\W/) {
 1340: 	    my $val=$token->[2]->{$attr};
 1341: 	    $val =~ s/([\%\@\\\"\'])/\\$1/g;
 1342: 	    $val =~ s/(\$[^\{a-zA-Z_])/\\$1/g;
 1343: 	    $val =~ s/(\$)$/\\$1/;
 1344: 	    #if ($val =~ m/^[\%\@]/) { $val="\\".$val; }
 1345: 	    push(@vars,"\$$attr");
 1346: 	    push(@values,"\"$val\"");
 1347: 	}
 1348:     }
 1349:     my $var_init = 
 1350: 	(@vars) ? 'my ('.join(',',@vars).') = ('.join(',',@values).');'
 1351: 	        : '';
 1352:     return $var_init;
 1353: }
 1354: 
 1355: sub extlink {
 1356:     my ($res,$exact)=@_;
 1357:     if (!$exact) {
 1358: 	$res=&Apache::lonnet::hreflocation($Apache::lonxml::pwd[-1],$res);
 1359:     }
 1360:     push(@Apache::lonxml::extlinks,$res)	 
 1361: }
 1362: 
 1363: sub writeallows {
 1364:     unless ($#extlinks>=0) { return; }
 1365:     my $thisurl = &Apache::lonnet::clutter(shift);
 1366:     if ($env{'httpref.'.$thisurl}) {
 1367: 	$thisurl=$env{'httpref.'.$thisurl};
 1368:     }
 1369:     my $thisdir=$thisurl;
 1370:     $thisdir=~s/\/[^\/]+$//;
 1371:     my %httpref=();
 1372:     foreach (@extlinks) {
 1373:        $httpref{'httpref.'.
 1374:  	        &Apache::lonnet::hreflocation($thisdir,&unescape($_))}=$thisurl;
 1375:     }
 1376:     @extlinks=();
 1377:     &Apache::lonnet::appenv(%httpref);
 1378: }
 1379: 
 1380: sub register_ssi {
 1381:     my ($url,%form)=@_;
 1382:     push (@Apache::lonxml::ssi_info,{'url'=>$url,'form'=>\%form});
 1383:     return '';
 1384: }
 1385: 
 1386: sub do_registered_ssi {
 1387:     foreach my $info (@Apache::lonxml::ssi_info) {
 1388: 	my %form=%{ $info->{'form'}};
 1389: 	my $url=$info->{'url'};
 1390: 	&Apache::lonnet::ssi($url,%form);
 1391:     }
 1392: }
 1393: 
 1394: sub add_script_result {
 1395:     my ($display) = @_;
 1396:     push(@script_var_displays, $display);
 1397: }
 1398: 
 1399: #
 1400: # Afterburner handles anchors, highlights and links
 1401: #
 1402: sub afterburn {
 1403:     my $result=shift;
 1404:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
 1405: 					    ['highlight','anchor','link']);
 1406:     if ($env{'form.highlight'}) {
 1407:        foreach (split(/\,/,$env{'form.highlight'})) {
 1408:            my $anchorname=$_;
 1409: 	   my $matchthis=$anchorname;
 1410:            $matchthis=~s/\_+/\\s\+/g;
 1411:            $result=~s/(\Q$matchthis\E)/\<font color=\"red\"\>$1\<\/font\>/gs;
 1412:        }
 1413:     }
 1414:     if ($env{'form.link'}) {
 1415:        foreach (split(/\,/,$env{'form.link'})) {
 1416:            my ($anchorname,$linkurl)=split(/\>/,$_);
 1417: 	   my $matchthis=$anchorname;
 1418:            $matchthis=~s/\_+/\\s\+/g;
 1419:            $result=~s/(\Q$matchthis\E)/\<a href=\"$linkurl\"\>$1\<\/a\>/gs;
 1420:        }
 1421:     }
 1422:     if ($env{'form.anchor'}) {
 1423:         my $anchorname=$env{'form.anchor'};
 1424: 	my $matchthis=$anchorname;
 1425:         $matchthis=~s/\_+/\\s\+/g;
 1426:         $result=~s/(\Q$matchthis\E)/\<a name=\"$anchorname\"\>$1\<\/a\>/s;
 1427:         $result.=(<<"ENDSCRIPT");
 1428: <script type="text/javascript">
 1429:     document.location.hash='$anchorname';
 1430: </script>
 1431: ENDSCRIPT
 1432:     }
 1433:     return $result;
 1434: }
 1435: 
 1436: sub storefile {
 1437:     my ($file,$contents)=@_;
 1438:     &Apache::lonnet::correct_line_ends(\$contents);
 1439:     if (my $fh=Apache::File->new('>'.$file)) {
 1440: 	print $fh $contents;
 1441:         $fh->close();
 1442:         return 1;
 1443:     } else {
 1444: 	&warning("Unable to save file $file");
 1445: 	return 0;
 1446:     }
 1447: }
 1448: 
 1449: sub createnewhtml {
 1450:     my $title=&mt('Title of document goes here');
 1451:     my $body=&mt('Body of document goes here');
 1452:     my $filecontents=(<<SIMPLECONTENT);
 1453: <html>
 1454: <head>
 1455: <title>$title</title>
 1456: </head>
 1457: <body bgcolor="#FFFFFF">
 1458: $body
 1459: </body>
 1460: </html>
 1461: SIMPLECONTENT
 1462:     return $filecontents;
 1463: }
 1464: 
 1465: sub createnewsty {
 1466:   my $filecontents=(<<SIMPLECONTENT);
 1467: <definetag name="">
 1468:     <render>
 1469:        <web></web>
 1470:        <tex></tex>
 1471:     </render>
 1472: </definetag>
 1473: SIMPLECONTENT
 1474:   return $filecontents;
 1475: }
 1476: 
 1477: 
 1478: sub inserteditinfo {
 1479:       my ($filecontents, $filetype, $filename)=@_;
 1480:       $filecontents = &HTML::Entities::encode($filecontents,'<>&"');
 1481: #      my $editheader='<a href="#editsection">Edit below</a><hr />';
 1482:       my $xml_help = '';
 1483:       my $initialize='';
 1484:       my $textarea_id = 'filecont';
 1485:       my ($add_to_onload, $add_to_onresize);
 1486:       $initialize=&Apache::lonhtmlcommon::spellheader();
 1487:       if ($filetype eq 'html' 
 1488: 	  && (!&Apache::lonhtmlcommon::htmlareablocked() &&
 1489: 	      &Apache::lonhtmlcommon::htmlareabrowser())) {
 1490: 	  $textarea_id .= '___Frame';
 1491: 	  my $lang = &Apache::lonhtmlcommon::htmlarea_lang();
 1492: 	  $initialize.=(<<FULLPAGE);
 1493: <script type="text/javascript">
 1494: lonca
 1495:     function initDocument() {
 1496:         var oFCKeditor = new FCKeditor('filecont');
 1497: 	oFCKeditor.Config['CustomConfigurationsPath'] = '/fckeditor/loncapaconfig.js'  ;
 1498: 	oFCKeditor.Config['FullPage'] = true
 1499: 	oFCKeditor.Config['AutoDetectLanguage'] = false;
 1500:         oFCKeditor.Config['DefaultLanguage'] = "$lang";
 1501: 	oFCKeditor.ReplaceTextarea();
 1502:     }
 1503:     function check_if_dirty(editor) {
 1504: 	if (editor.IsDirty()) {
 1505: 	    unClean();
 1506: 	}
 1507:     }
 1508:     function FCKeditor_OnComplete(editor) {
 1509: 	editor.Events.AttachEvent("OnSelectionChange",check_if_dirty);
 1510: 	resize_textarea('$textarea_id','LC_aftertextarea');
 1511:     }
 1512: </script>
 1513: FULLPAGE
 1514:       } else {
 1515: 	  $initialize.=(<<FULLPAGE);
 1516: <script type="text/javascript">
 1517:     function initDocument() {
 1518: 	resize_textarea('$textarea_id','LC_aftertextarea');
 1519:     }
 1520: </script>
 1521: FULLPAGE
 1522:       }
 1523: 
 1524:       $add_to_onload = 'initDocument();';
 1525:       $add_to_onresize = "resize_textarea('$textarea_id','LC_aftertextarea');";
 1526: 
 1527:       if ($filetype eq 'html') {
 1528: 	  $xml_help=&Apache::loncommon::helpLatexCheatsheet();
 1529:       }
 1530: 
 1531:       my $titledisplay=&display_title();
 1532:       my %lt=&Apache::lonlocal::texthash('st' => 'Save and Edit',
 1533: 					 'vi' => 'Save and View',
 1534: 					 'dv' => 'Discard Edits and View',
 1535: 					 'un' => 'undo',
 1536: 					 'ed' => 'Edit');
 1537:       my $spelllink .=&Apache::lonhtmlcommon::spelllink('xmledit','filecont');
 1538:       my $textarea_events = &Apache::edit::element_change_detection();
 1539:       my $form_events     = &Apache::edit::form_change_detection();
 1540:       my $editfooter=(<<ENDFOOTER);
 1541: $initialize
 1542: <a name="editsection" />
 1543: <form $form_events method="post" name="xmledit">
 1544:   <div class="LC_edit_problem_editxml_header">
 1545:     <table class="LC_edit_problem_header_title"><tr><td>
 1546:         $filename
 1547:       </td><td align="right">
 1548:         $xml_help
 1549:       </td></tr>
 1550:     </table>
 1551:     <div class="LC_edit_problem_discards">
 1552:       <input type="submit" name="discardview" accesskey="d" value="$lt{'dv'}" />
 1553:       <input type="submit" name="Undo" accesskey="u" value="$lt{'un'}" />
 1554:       $spelllink
 1555:     </div>
 1556:     <div class="LC_edit_problem_saves">
 1557:       <input type="submit" name="savethisfile" accesskey="s" value="$lt{'st'}" />
 1558:       <input type="submit" name="viewmode" accesskey="v" value="$lt{'vi'}" />
 1559:     </div>
 1560:   </div>
 1561:   <textarea $textarea_events style="width:100%" cols="80" rows="44" name="filecont" id="filecont">$filecontents</textarea>
 1562:   <div id="LC_aftertextarea">
 1563:     <br />
 1564:     $titledisplay
 1565:   </div>
 1566: </form>
 1567: </body>
 1568: ENDFOOTER
 1569:       return ($editfooter,$add_to_onload,$add_to_onresize);;
 1570: }
 1571: 
 1572: sub get_target {
 1573:   my $viewgrades=&Apache::lonnet::allowed('vgr',$env{'request.course.id'});
 1574:   if ( $env{'request.state'} eq 'published') {
 1575:     if ( defined($env{'form.grade_target'})
 1576: 	 && ($viewgrades == 'F' )) {
 1577:       return ($env{'form.grade_target'});
 1578:     } elsif (defined($env{'form.grade_target'})) {
 1579:       if (($env{'form.grade_target'} eq 'web') ||
 1580: 	  ($env{'form.grade_target'} eq 'tex') ) {
 1581: 	return $env{'form.grade_target'}
 1582:       } else {
 1583: 	return 'web';
 1584:       }
 1585:     } else {
 1586:       return 'web';
 1587:     }
 1588:   } elsif ($env{'request.state'} eq 'construct') {
 1589:     if ( defined($env{'form.grade_target'})) {
 1590:       return ($env{'form.grade_target'});
 1591:     } else {
 1592:       return 'web';
 1593:     }
 1594:   } else {
 1595:     return 'web';
 1596:   }
 1597: }
 1598: 
 1599: sub handler {
 1600:     my $request=shift;
 1601:     
 1602:     my $target=&get_target();
 1603:     
 1604:     $Apache::lonxml::debug=$env{'user.debug'};
 1605:     
 1606:     &Apache::loncommon::content_type($request,'text/html');
 1607:     &Apache::loncommon::no_cache($request);
 1608:     if ($env{'request.state'} eq 'published') {
 1609: 	$request->set_last_modified(&Apache::lonnet::metadata($request->uri,
 1610: 							      'lastrevisiondate'));
 1611:     }
 1612:     $request->send_http_header;
 1613:     
 1614:     return OK if $request->header_only;
 1615: 
 1616: 
 1617:     my $file=&Apache::lonnet::filelocation("",$request->uri);
 1618:     my $filetype;
 1619:     if ($file =~ /\.sty$/) {
 1620: 	$filetype='sty';
 1621:     } else {
 1622: 	$filetype='html';
 1623:     }
 1624: #
 1625: # Edit action? Save file.
 1626: #
 1627:     if (!($env{'request.state'} eq 'published')) {
 1628: 	if ($env{'form.savethisfile'} || $env{'form.viewmode'} || $env{'form.Undo'}) {
 1629: 	    my $html_file=&Apache::lonnet::getfile($file);
 1630: 	    my $error = &Apache::lonhomework::handle_save_or_undo($request, \$html_file, \$env{'form.filecont'});
 1631: 	}
 1632:     }
 1633:     my %mystyle;
 1634:     my $result = '';
 1635:     my $filecontents=&Apache::lonnet::getfile($file);
 1636:     if ($filecontents eq -1) {
 1637: 	my $start_page=&Apache::loncommon::start_page('File Error');
 1638: 	my $end_page=&Apache::loncommon::end_page();
 1639: 	my $fnf=&mt('File not found');
 1640: 	$result=(<<ENDNOTFOUND);
 1641: $start_page
 1642: <b>$fnf: $file</b>
 1643: $end_page
 1644: ENDNOTFOUND
 1645:         $filecontents='';
 1646: 	if ($env{'request.state'} ne 'published') {
 1647: 	    if ($filetype eq 'sty') {
 1648: 		$filecontents=&createnewsty();
 1649: 	    } else {
 1650: 		$filecontents=&createnewhtml();
 1651: 	    }
 1652: 	    $env{'form.editmode'}='Edit'; #force edit mode
 1653: 	}
 1654:     } else {
 1655: 	unless ($env{'request.state'} eq 'published') {
 1656: 	    if ($filecontents=~/BEGIN LON-CAPA Internal/) {
 1657: 		&Apache::lonxml::error(&mt('This file appears to be a rendering of a LON-CAPA resource. If this is correct, this resource will act very oddly and incorrectly.'));
 1658: 	    }
 1659: #
 1660: # we are in construction space, see if edit mode forced
 1661:             &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
 1662: 						    ['editmode']);
 1663: 	}
 1664: 	if (!$env{'form.editmode'} || $env{'form.viewmode'} || $env{'form.discardview'}) {
 1665: 	    &Apache::structuretags::reset_problem_globals();
 1666: 	    $result = &Apache::lonxml::xmlparse($request,$target,$filecontents,
 1667: 						'',%mystyle);
 1668: 	    # .html files may contain <problem> or <Task> need to clean
 1669: 	    # up if it did
 1670: 	    &Apache::structuretags::reset_problem_globals();
 1671: 	    &Apache::lonhomework::finished_parsing();
 1672: 	    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
 1673: 						    ['rawmode']);
 1674: 	    if ($env{'form.rawmode'}) { $result = $filecontents; }
 1675: 	    if ($filetype eq 'sty') {
 1676: 		my $controls =
 1677: 		    ($env{'request.state'} eq 'construct') ? &Apache::londefdef::edit_controls()
 1678: 		                                           : '';
 1679: 		my %options = ('bgcolor' => '#FFFFFF');
 1680: 		$result = 
 1681: 		    &Apache::loncommon::start_page(undef,undef,\%options).
 1682: 		    $controls.
 1683: 		    $result.
 1684: 		    &Apache::loncommon::end_page();
 1685: 	    }
 1686: 	}
 1687:     }
 1688: 
 1689: #
 1690: # Edit action? Insert editing commands
 1691: #
 1692:     unless ($env{'request.state'} eq 'published') {
 1693: 	if ($env{'form.editmode'} && (!($env{'form.viewmode'})) && (!($env{'form.discardview'})))
 1694: 	{
 1695: 	    my $displayfile=$request->uri;
 1696: 	    $displayfile=~s/^\/[^\/]*//;
 1697: 
 1698: 	    my ($edit_info, $add_to_onload, $add_to_onresize)=
 1699: 		&inserteditinfo($filecontents,$filetype,$displayfile);
 1700: 
 1701: 	    my %options = 
 1702: 		('add_entries' =>
 1703:                    {'onresize' => $add_to_onresize,
 1704: 		    'onload'   => $add_to_onload,   });
 1705: 
 1706: 	    if ($env{'environment.remote'} ne 'off') {
 1707: 		$options{'bgcolor'}   = '#FFFFFF';
 1708: 		$options{'only_body'} = 1;
 1709: 	    }
 1710: 	    my $js =
 1711: 		&Apache::edit::js_change_detection().
 1712: 		&Apache::loncommon::resize_textarea_js();
 1713: 	    my $start_page = &Apache::loncommon::start_page(undef,$js,
 1714: 							    \%options);
 1715: 	    $result=$start_page.
 1716: 		&Apache::lonxml::message_location().
 1717: 		$edit_info.
 1718: 		&Apache::loncommon::end_page();
 1719: 	}
 1720:     }
 1721:     if ($filetype eq 'html') { &writeallows($request->uri); }
 1722:     
 1723:     &Apache::lonxml::add_messages(\$result);
 1724:     $request->print($result);
 1725:     
 1726:     return OK;
 1727: }
 1728: 
 1729: sub display_title {
 1730:     my $result;
 1731:     if ($env{'request.state'} eq 'construct') {
 1732: 	my $title=&Apache::lonnet::gettitle();
 1733: 	if (!defined($title) || $title eq '') {
 1734: 	    $title = $env{'request.filename'};
 1735: 	    $title = substr($title, rindex($title, '/') + 1);
 1736: 	}
 1737: 	$result = "<script type='text/javascript'>top.document.title = '$title - LON-CAPA Construction Space';</script>";
 1738:     }
 1739:     return $result;
 1740: }
 1741: 
 1742: sub debug {
 1743:     if ($Apache::lonxml::debug eq "1") {
 1744: 	$|=1;
 1745: 	my $request=$Apache::lonxml::request;
 1746: 	if (!$request) {
 1747: 	    eval { $request=Apache->request; };
 1748: 	}
 1749: 	if (!$request) {
 1750: 	    eval { $request=Apache2::RequestUtil->request; };
 1751: 	}
 1752: 	$request->print('<font size="-2"><pre>DEBUG:'.&HTML::Entities::encode($_[0],'<>&"')."</pre></font>\n");
 1753: 	#&Apache::lonnet::logthis($_[0]);
 1754:     }
 1755: }
 1756: 
 1757: sub show_error_warn_msg {
 1758:     if ($env{'request.filename'} eq '/home/httpd/html/res/lib/templates/simpleproblem.problem' &&
 1759: 	&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) {
 1760: 	return 1;
 1761:     }
 1762:     return (($Apache::lonxml::debug eq 1) ||
 1763: 	    ($env{'request.state'} eq 'construct') ||
 1764: 	    ($Apache::lonhomework::browse eq 'F'
 1765: 	     &&
 1766: 	     $env{'form.show_errors'} eq 'on'));
 1767: }
 1768: 
 1769: sub error {
 1770:     my @errors = @_;
 1771: 
 1772:     $errorcount++;
 1773: 
 1774:     if (defined($Apache::inputtags::part)) {
 1775: 	if ( @Apache::inputtags::response ) {
 1776: 	    push(@errors,
 1777: 		 &mt("This error occurred while processing response [_1] in part [_2]",
 1778: 		     $Apache::inputtags::response[-1],
 1779: 		     $Apache::inputtags::part));
 1780: 	} else {
 1781: 	    push(@errors,
 1782: 		 &mt("This error occurred while processing part [_1]",
 1783: 		     $Apache::inputtags::part));
 1784: 	}
 1785:     }
 1786: 
 1787:     if ( &show_error_warn_msg() ) {
 1788: 	# If printing in construction space, put the error inside <pre></pre>
 1789: 	push(@Apache::lonxml::error_messages,
 1790: 	     $Apache::lonxml::warnings_error_header.
 1791: 	     "<b>ERROR:</b>".join("<br />\n",@errors)."<br />\n");
 1792: 	$Apache::lonxml::warnings_error_header='';
 1793:     } else {
 1794: 	my $errormsg;
 1795: 	my ($symb)=&Apache::lonnet::symbread();
 1796: 	if ( !$symb ) {
 1797: 	    #public or browsers
 1798: 	    $errormsg=&mt("An error occured while processing this resource. The author has been notified.");
 1799: 	}
 1800: 	my $host=$Apache::lonnet::perlvar{'lonHostID'};
 1801: 	push(@errors, "The error occurred on host <tt>$host</tt>");
 1802: 
 1803: 	my $msg = join('<br />', @errors);
 1804: 
 1805: 	#notify author
 1806: 	&Apache::lonmsg::author_res_msg($env{'request.filename'},$msg);
 1807: 	#notify course
 1808: 	if ( $symb && $env{'request.course.id'} ) {
 1809: 	    my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
 1810: 	    my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
 1811: 	    my (undef,%users)=&Apache::lonmsg::decide_receiver(undef,0,1,1,1);
 1812: 	    my $declutter=&Apache::lonnet::declutter($env{'request.filename'});
 1813:             my $baseurl = &Apache::lonnet::clutter($declutter);
 1814: 	    my @userlist;
 1815: 	    foreach (keys %users) {
 1816: 		my ($user,$domain) = split(/:/, $_);
 1817: 		push(@userlist,"$user\@$domain");
 1818: 		my $key=$declutter.'_'.$user.'_'.$domain;
 1819: 		my %lastnotified=&Apache::lonnet::get('nohist_xmlerrornotifications',
 1820: 						      [$key],
 1821: 						      $cdom,$cnum);
 1822: 		my $now=time;
 1823: 		if ($now-$lastnotified{$key}>86400) {
 1824:                     my $title = &Apache::lonnet::gettitle($symb);
 1825:                     my $sentmessage;
 1826: 		    &Apache::lonmsg::user_normal_msg($user,$domain,
 1827: 		        "Error [$title]",$msg,'',$baseurl,'','',
 1828:                         \$sentmessage,$symb,$title,1);
 1829: 		    &Apache::lonnet::put('nohist_xmlerrornotifications',
 1830: 					 {$key => $now},
 1831: 					 $cdom,$cnum);		
 1832: 		}
 1833: 	    }
 1834: 	    if ($env{'request.role.adv'}) {
 1835: 		$errormsg=&mt("An error occured while processing this resource. The course personnel ([_1]) and the author have been notified.",join(', ',@userlist));
 1836: 	    } else {
 1837: 		$errormsg=&mt("An error occured while processing this resource. The instructor has been notified.");
 1838: 	    }
 1839: 	}
 1840: 	push(@Apache::lonxml::error_messages,"<b>$errormsg</b> <br />");
 1841:     }
 1842: }
 1843: 
 1844: sub warning {
 1845:     $warningcount++;
 1846:   
 1847:     if ($env{'form.grade_target'} ne 'tex') {
 1848: 	if ( &show_error_warn_msg() ) {
 1849: 	    push(@Apache::lonxml::warning_messages,
 1850: 		 $Apache::lonxml::warnings_error_header.
 1851: 		 "<b>W</b>ARNING<b>:</b>".join('<br />',@_)."<br />\n");
 1852: 	    $Apache::lonxml::warnings_error_header='';
 1853: 	}
 1854:     }
 1855: }
 1856: 
 1857: sub info {
 1858:     if ($env{'form.grade_target'} ne 'tex' 
 1859: 	&& $env{'request.state'} eq 'construct') {
 1860: 	push(@Apache::lonxml::info_messages,join('<br />',@_)."<br />\n");
 1861:     }
 1862: }
 1863: 
 1864: sub message_location {
 1865:     return '__LONCAPA_INTERNAL_MESSAGE_LOCATION__';
 1866: }
 1867: 
 1868: sub add_messages {
 1869:     my ($msg)=@_;
 1870:     my $result=join(' ',
 1871: 		    @Apache::lonxml::info_messages,
 1872: 		    @Apache::lonxml::error_messages,
 1873: 		    @Apache::lonxml::warning_messages);
 1874:     undef(@Apache::lonxml::info_messages);
 1875:     undef(@Apache::lonxml::error_messages);
 1876:     undef(@Apache::lonxml::warning_messages);
 1877:     $$msg=~s/__LONCAPA_INTERNAL_MESSAGE_LOCATION__/$result/;
 1878:     $$msg=~s/__LONCAPA_INTERNAL_MESSAGE_LOCATION__//g;
 1879: }
 1880: 
 1881: sub get_param {
 1882:     my ($param,$parstack,$safeeval,$context,$case_insensitive) = @_;
 1883:     if ( ! $context ) { $context = -1; }
 1884:     my $args ='';
 1885:     if ( $#$parstack > (-2-$context) ) { $args=$$parstack[$context]; }
 1886:     if ( ! $Apache::lonxml::usestyle ) {
 1887: 	$args=$Apache::lonxml::style_values.$args;
 1888:     }
 1889:     if ( ! $args ) { return undef; }
 1890:     if ( $case_insensitive ) {
 1891: 	if ($args =~ s/(my (?:.*))(\$\Q$param\E[,\)])/$1.lc($2)/ei) {
 1892: 	    return &Apache::run::run("{$args;".'return $'.$param.'}',
 1893:                                      $safeeval); #'
 1894: 	} else {
 1895: 	    return undef;
 1896: 	}
 1897:     } else {
 1898: 	if ( $args =~ /my .*\$\Q$param\E[,\)]/ ) {
 1899: 	    return &Apache::run::run("{$args;".'return $'.$param.'}',
 1900:                                      $safeeval); #'
 1901: 	} else {
 1902: 	    return undef;
 1903: 	}
 1904:     }
 1905: }
 1906: 
 1907: sub get_param_var {
 1908:   my ($param,$parstack,$safeeval,$context,$case_insensitive) = @_;
 1909:   if ( ! $context ) { $context = -1; }
 1910:   my $args ='';
 1911:   if ( $#$parstack > (-2-$context) ) { $args=$$parstack[$context]; }
 1912:   if ( ! $Apache::lonxml::usestyle ) {
 1913:       $args=$Apache::lonxml::style_values.$args;
 1914:   }
 1915:   &Apache::lonxml::debug("Args are $args param is $param");
 1916:   if ($case_insensitive) {
 1917:       if (! ($args=~s/(my (?:.*))(\$\Q$param\E[,\)])/$1.lc($2)/ei)) {
 1918: 	  return undef;
 1919:       }
 1920:   } elsif ( $args !~ /my .*\$\Q$param\E[,\)]/ ) { return undef; }
 1921:   my $value=&Apache::run::run("{$args;".'return $'.$param.'}',$safeeval); #'
 1922:   &Apache::lonxml::debug("first run is $value");
 1923:   if ($value =~ /^[\$\@\%][a-zA-Z_]\w*$/) {
 1924:       &Apache::lonxml::debug("doing second");
 1925:       my @result=&Apache::run::run("return $value",$safeeval,1);
 1926:       if (!defined($result[0])) {
 1927: 	  return $value
 1928:       } else {
 1929: 	  if (wantarray) { return @result; } else { return $result[0]; }
 1930:       }
 1931:   } else {
 1932:     return $value;
 1933:   }
 1934: }
 1935: 
 1936: sub register_insert_xml {
 1937:     my $parser = HTML::LCParser->new($Apache::lonnet::perlvar{'lonTabDir'}
 1938: 				     .'/insertlist.xml');
 1939:     my ($tagnum,$in_help)=(0,0);
 1940:     my @alltags;
 1941:     my $tag;
 1942:     while (my $token = $parser->get_token()) {
 1943: 	if ($token->[0] eq 'S') {
 1944: 	    my $key;
 1945: 	    if      ($token->[1] eq 'tag') {
 1946: 		$tag = $token->[2]{'name'};
 1947: 		$insertlist{"$tagnum.tag"} = $tag;
 1948: 		$insertlist{"$tag.num"}   = $tagnum;
 1949: 		push(@alltags,$tag);
 1950: 	    } elsif ($in_help && $token->[1] eq 'file') {
 1951: 		$key = $tag.'.helpfile';
 1952: 	    } elsif ($in_help && $token->[1] eq 'description') {
 1953: 		$key = $tag.'.helpdesc';
 1954: 	    } elsif ($token->[1] eq 'description' ||
 1955: 		     $token->[1] eq 'color'       ||
 1956: 		     $token->[1] eq 'show'          ) {
 1957: 		$key = $tag.'.'.$token->[1];
 1958: 	    } elsif ($token->[1] eq 'insert_sub') {
 1959: 		$key = $tag.'.function';
 1960: 	    } elsif ($token->[1] eq 'help') {
 1961: 		$in_help=1;
 1962: 	    } elsif ($token->[1] eq 'allow') {
 1963: 		$key = $tag.'.allow';
 1964: 	    }
 1965: 	    if (defined($key)) {
 1966: 		$insertlist{$key} = $parser->get_text();
 1967: 		$insertlist{$key} =~ s/(^\s*|\s*$ )//gx;
 1968: 	    }
 1969: 	} elsif ($token->[0] eq 'E') {
 1970: 	    if      ($token->[1] eq 'tag') {
 1971: 		undef($tag);
 1972: 		$tagnum++;
 1973: 	    } elsif ($token->[1] eq 'help') {
 1974: 		undef($in_help);
 1975: 	    }
 1976: 	}
 1977:     }
 1978:     
 1979:     # parse the allows and ignore tags set to <show>no</show>
 1980:     foreach my $tag (@alltags) {	
 1981:         next if (!exists($insertlist{"$tag.allow"}));
 1982: 	my $allow =  $insertlist{"$tag.allow"};
 1983:        	foreach my $element (split(',',$allow)) {
 1984: 	    $element =~ s/(^\s*|\s*$ )//gx;
 1985: 	    if (!exists($insertlist{"$element.show"})
 1986:                 || $insertlist{"$element.show"} ne 'no') {
 1987: 		push(@{ $insertlist{$tag.'.which'} },$element);
 1988: 	    }
 1989: 	}
 1990:     }
 1991: }
 1992: 
 1993: sub register_insert {
 1994:     return &register_insert_xml(@_);
 1995: #    &dump_insertlist('2');
 1996: }
 1997: 
 1998: sub dump_insertlist {
 1999:     my ($ext) = @_;
 2000:     open(XML,">/tmp/insertlist.xml.$ext");
 2001:     print XML ("<insertlist>");
 2002:     my $i=0;
 2003: 
 2004:     while (exists($insertlist{"$i.tag"})) {
 2005: 	my $tag = $insertlist{"$i.tag"};
 2006: 	print XML ("
 2007: \t<tag name=\"$tag\">");
 2008: 	if (defined($insertlist{"$tag.description"})) {
 2009: 	    print XML ("
 2010: \t\t<description>".$insertlist{"$tag.description"}."</description>");
 2011: 	}
 2012: 	if (defined($insertlist{"$tag.color"})) {
 2013: 	    print XML ("
 2014: \t\t<color>".$insertlist{"$tag.color"}."</color>");
 2015: 	}
 2016: 	if (defined($insertlist{"$tag.function"})) {
 2017: 	    print XML ("
 2018: \t\t<insert_sub>".$insertlist{"$tag.function"}."</insert_sub>");
 2019: 	}
 2020: 	if (defined($insertlist{"$tag.show"})
 2021: 	    && $insertlist{"$tag.show"} ne 'yes') {
 2022: 	    print XML ("
 2023: \t\t<show>".$insertlist{"$tag.show"}."</show>");
 2024: 	}
 2025: 	if (defined($insertlist{"$tag.helpfile"})) {
 2026: 	    print XML ("
 2027: \t\t<help>
 2028: \t\t\t<file>".$insertlist{"$tag.helpfile"}."</file>");
 2029: 	    if ($insertlist{"$tag.helpdesc"} ne '') {
 2030: 		print XML ("
 2031: \t\t\t<description>".$insertlist{"$tag.helpdesc"}."</description>");
 2032: 	    }
 2033: 	    print XML ("
 2034: \t\t</help>");
 2035: 	}
 2036: 	if (defined($insertlist{"$tag.which"})) {
 2037: 	    print XML ("
 2038: \t\t<allow>".join(',',sort(@{ $insertlist{"$tag.which"} }))."</allow>");
 2039: 	}
 2040: 	print XML ("
 2041: \t</tag>");
 2042: 	$i++;
 2043:     }
 2044:     print XML ("\n</insertlist>\n");
 2045:     close(XML);
 2046: }
 2047: 
 2048: sub description {
 2049:     my ($token)=@_;
 2050:     my $tag = &get_tag($token);
 2051:     return $insertlist{$tag.'.description'};
 2052: }
 2053: 
 2054: # Returns a list containing the help file, and the description
 2055: sub helpinfo {
 2056:     my ($token)=@_;
 2057:     my $tag = &get_tag($token);
 2058:     return ($insertlist{$tag.'.helpfile'}, $insertlist{$tag.'.helpdesc'});
 2059: }
 2060: 
 2061: sub get_tag {
 2062:     my ($token)=@_;
 2063:     my $tagnum;
 2064:     my $tag=$token->[1];
 2065:     foreach my $namespace (reverse(@Apache::lonxml::namespace)) {
 2066: 	my $testtag = $namespace.'::'.$tag;
 2067: 	$tagnum = $insertlist{"$testtag.num"};
 2068: 	last if (defined($tagnum));
 2069:     }
 2070:     if (!defined($tagnum)) {
 2071: 	$tagnum = $Apache::lonxml::insertlist{"$tag.num"};
 2072:     }
 2073:     return $insertlist{"$tagnum.tag"};
 2074: }
 2075: 
 2076: 1;
 2077: __END__
 2078: 
 2079: 

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