# The LearningOnline Network # Printout # # $Id: lonprintout.pm,v 1.609 2011/11/07 20:05:56 www Exp $ # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). # # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # LON-CAPA is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with LON-CAPA; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # /home/httpd/html/adm/gpl.txt # http://www.lon-capa.org/ # # package Apache::lonprintout; use strict; use Apache::Constants qw(:common :http); use Apache::lonxml; use Apache::lonnet; use Apache::loncommon; use Apache::inputtags; use Apache::grades; use Apache::edit; use Apache::File(); use Apache::lonnavmaps; use Apache::admannotations; use Apache::lonenc; use Apache::entities; use Apache::londefdef; use File::Basename; use HTTP::Response; use LONCAPA::map(); use POSIX qw(strftime); use Apache::lonlocal; use Carp; use LONCAPA; my %perm; my %parmhash; my $resources_printed; # Global variables that describe errors in ssi calls detected by ssi_with_retries. # my $ssi_error; # True if there was an ssi error. my $ssi_last_error_resource; # The resource URI that could not be fetched. my $ssi_last_error; # The error text from the server. (e.g. 500 Server timed out). # # Our ssi max retry count. # my $ssi_retry_count = 5; # Some arbitrary value. # Font size: my $font_size = 'normalsize'; # Default is normalsize... #---------------------------- Helper helpers. ------------------------- # BZ5209: # Create the states needed to run the helper for incomplete problems from # the current folder for selected students. # This includes: # - A resource selector limited to problems (incompleteness must be # calculated on a student per student basis. # - A student selector. # - Tie in to the FORMAT of the print job. # # States: # CHOOSE_INCOMPLETE_PEOPLE_SEQ - Resource selection. # CHOOSE_STUDENTS_INCOMPLETE - Student selection. # CHOOSE_STUDENTS_INCOMPLETE_FORMAT - Format selection # Parameters: # helper - the helper which already contains info about the current folder we can # purloin. # url - Top url of the sequence # Return: # XML that can be parsed by the helper to drive the state machine. # sub create_incomplete_folder_selstud_helper($helper) { my ($helper, $map) = @_; my $symbFilter = '$res->shown_symb()'; my $selFilter = '$res->is_problem()'; my $resource_chooser = &generate_resource_chooser('CHOOSE_INCOMPLETE_PEOPLE_SEQ', 'Select problem(s) to print', 'multichoice="1" toponly="1" addstatus="1" closeallpages="1"', 'RESOURCES', 'CHOOSE_STUDENTS_INCOMPLETE', $map, $selFilter, '', $symbFilter, ''); my $student_chooser = &generate_student_chooser('CHOOSE_STUDENTS_INCOMPLETE', 'student_sort', 'STUDENTS', 'CHOOSE_STUDENTS_INCOMPLETE_FORMAT'); my $format_chooser = &generate_format_selector($helper, 'Format of the print job', 'CHOOSE_STUDENTS_INCOMPLETE_FORMAT'); # end state. return $resource_chooser . $student_chooser . $format_chooser; } # BZ 5209 # Create the states needed to run the helper for incomplete problems from # the current folder for selected students. # This includes: # - A resource selector limited to problems. (incompleteness must be calculated # on a student per student basis. # - A student selector. # - Tie in to format for the print job. # States: # INCOMPLETE_PROBLEMS_COURSE_RESOURCES - Resource selector. # INCOMPLETE_PROBLEMS_COURSE_STUDENTS - Student selector. # INCOMPLETE_PROBLEMS_COURSE_FORMAT - Format selection. # # Parameters: # helper - Helper we are creating states for. # Returns: # Text that can be parsed by the helper. # sub create_incomplete_course_helper { my $helper = shift; my $filter = '$res->is_problem() || $res->contains_problem() || $res->is_sequence() || $res->is_practice())'; my $symbfilter = '$res->shown_symb()'; my $resource_chooser = &generate_resource_chooser('INCOMPLETE_PROBLEMS_COURSE_RESOURCES', 'Select problem(s) to print', 'multichoice = "1" suppressEmptySequences="0" addstatus="1" closeallpagtes="1"', 'RESOURCES', 'INCOMPLETE_PROBLEMS_COURSE_STUDENTS', '', $filter, '', $symbfilter, ''); my $people_chooser = &generate_student_chooser('INCOMPLETE_PROBLEMS_COURSE_STUDENTS', 'student_sort', 'STUDENTS', 'INCOMPLETE_PROBLEMS_COURSE_FORMAT'); my $format = &generate_format_selector($helper, 'Format of the print job', 'INCOMPLETE_PROBLEMS_COURSE_FORMAT'); # end state. return $resource_chooser . $people_chooser . $format; } # BZ5209 # Creates the states needed to run the print helper for a student # that wants to print his incomplete problems from the current folder. # Parameters: # $helper - helper we are generating states for. # $map - The map for which the student wants incomplete problems. # Returns: # XML that defines the helper states being created. # # States: # CHOOSE_INCOMPLETE_SEQ - Resource selector. # sub create_incomplete_folder_helper { my ($helper, $map) = @_; my $filter = '$res->is_problem()'; $filter .= ' && $res->resprintable() '; $filter .= ' && $res->is_incomplete() '; my $symfilter = '$res->shown_symb()'; my $resource_chooser = &generate_resource_chooser('CHOOSE_INCOMPLETE_SEQ', 'Select problem(s) to print', 'multichoice="1", toponly ="1", addstatus="1", closeallpages="1"', 'RESOURCES', 'PAGESIZE', $map, $filter, '', $symfilter, ''); return $resource_chooser; } # Returns the text neded for a student chooser. # that text must still be parsed by the helper xml parser. # Parameters: # this_state - State name of the chooser. # sort_choice - variable to hold the sorting choice. # variable - Name of variable to hold students. # next_state - State after chooser. sub generate_student_chooser { my ($this_state, $sort_choice, $variable, $next_state) = @_; my $result = < Select sorting order of printout Sort by section then student Sort by students across sections.

CHOOSE_STUDENTS return $result; } # Generate the text needed for a resource chooser given the top level of # the sequence/page # # Parameters: # this_state - State name of the chooser. # prompt_text - Text to use to prompt user. # resource_options - Resource tag options e.g. # "multichoice='1', toponly='1', addstatus='1'" # that control the selection and appearance of the # resource selector. # variable - Name of the variable to hold the choice # next_state - Name of the next state the helper should transition # to # top_url - Top level URL within which to make the selector. # If empty the top level sequence is shown. # filter - How to filter the resources. # value_func - function. # choice_func - If not empty generates a with this function. # start_new_option # - Fragment appended after valuefunc. # # sub generate_resource_chooser { my ($this_state, $prompt_text, $resource_options, $variable, $next_state, $top_url, $filter, $choice_func, $value_func, $start_new_option) = @_; my $result = < $next_state return $filter; CHOOSE_RESOURCES if ($choice_func ne '') { $result .= "return $choice_func;"; } if ($top_url ne '') { $result .= "$top_url"; } $result .= <return $value_func; $start_new_option CHOOSE_RESOURCES return $result; } # # Generate the helper XML for a code choice helper dialog: # # Paramters: # $helper - Reference to the helper. # $state - Name of the state for the chooser. # $next_state - Name fo the state to follow the chooser. # $bubble_types - Populates the bubble sheet type dropt down. # $code_selections - Provides set of code choices that have been used # $saved_codes - Provides the list of saved codes. # # Returns; # The Xml of the code chooser. # sub generate_code_selector { my ($helper, $state, $next_state, $bubble_types, $code_selections, $saved_codes) = @_; # Unpack the parameters. my $result = < $next_state

Fill out one of the forms below

Generate new CODEd Assignments
Number of CODEd assignments to print: if (((\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'}+0) < 1) && !\$helper->{'VARS'}{'REUSE_OLD_CODES'} && !\$helper->{'VARS'}{'SINGLE_CODE'} && !\$helper->{'VARS'}{'CODE_SELECTED_FROM_LIST'} ) { return "You need to specify the number of assignments to print"; } if (((\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'}+0) >= 1) && (\$helper->{'VARS'}{'SINGLE_CODE'} ne '') ) { return 'Specifying number of codes to print and a specific code is not compatible'; } return undef;
Names to save the CODEs under for later:
Bubblesheet type: $bubble_types

Print a Specific CODE


Enter a CODE to print: if(!\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'} && !\$helper->{'VARS'}{'REUSE_OLD_CODES'} && !\$helper->{'VARS'}{'CODE_SELECTED_FROM_LIST'}) { return &Apache::lonprintout::is_code_valid(\$helper->{'VARS'}{'SINGLE_CODE'}, \$helper->{'VARS'}{'CODE_OPTION'}); } elsif (\$helper->{'VARS'}{'SINGLE_CODE'} ne ''){ return 'Specifying a code name is incompatible with specifying number of codes.'; } else { return undef; # Other forces control us. }
$code_selections

Reprint a Set of Saved CODEs

Select saved CODEs: $saved_codes
CHOOSE_ANON1 return $result; } # Returns the XML for choosing how assignments are to be formatted # that text must still be parsed by the helper xml parser. # Parameters: 3 (required) # helper - The helper; $helper->{'VARS'}->{'PRINT_TYPE'} used # to check if splitting PDFs by section can be offered. # title - Title for the current state. # this_state - State name of the chooser. sub generate_format_selector { my ($helper,$title,$this_state) = @_; my $secpdfoption; unless (($helper->{'VARS'}->{'PRINT_TYPE'} eq 'problems_for_anon') || ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'problems_for_anon_page') || ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'resources_for_anon') ) { $secpdfoption = 'Each PDF contains exactly one section'; } return <
How should the results be printed?
 Start each student\'s assignment on a new page/column (add a pagefeed after each assignment) Add one empty page/column after each student\'s assignment Add two empty pages/column after each student\'s assignment Add three empty pages/column after each student\'s assignment PAGESIZE
How do you want assignments split into PDF files? All assignments in a single PDF file $secpdfoption Each PDF contains exactly one assignment Specify the number of assignments per PDF: RESOURCE_SELECTOR } #----------------------------------------------------------------------- # Determine if a resource is incomplete given the map: # Parameters: # $username - Name of user for whom we are checking. # $domain - Domain of user we are checking. # $map - map name. # Returns: # 0 - map is not incomplete. # 1 - map is incomplete. # sub incomplete { my ($username, $domain, $map) = @_; my $navmap = Apache::lonnavmaps::navmap->new($username, $domain); if (defined($navmap)) { my $res = $navmap->getResourceByUrl($map); my $result = $res->is_incomplete(); return $result; } else { return 1; } } # # When printing for students, the resoures and order of the # resources may need to be altered if there are folders with # random selectiopn or random ordering (or both) enabled. # This sub computes the set of resources to print for a student # modified both by random ordering and selection and filtered # to only those that are in the original set selcted to be printed. # # Parameters: # $helper - The helper we need $helper->{'VARS'}->{'symb'} # to construct the navmap and the iteration. # $seq - The original set of resources to print # (really an array of resource names (array of symb's). # $who - Student/domain for whome the sequence will be generated. # # Implicit inputs: # $ # Returns: # reference to an array of resources that can be passed to # print_resources. # sub master_seq_to_person_seq { my ($helper, $seq, $who) = @_; my ($username, $userdomain, $usersection) = split(/:/, $who); # Toss the sequence up into a hash so that we have O(1) lookup time. # on the items that come out of the user's list of resources. # my %seq_hash = map {$_ => 1} @$seq; my @output_seq; my ($map, $id, $url) = &Apache::lonnet::decode_symb($helper->{VARS}->{'symb'}); my $navmap = Apache::lonnavmaps::navmap->new($username, $userdomain); my $iterator = $navmap->getIterator($navmap->firstResource(), $navmap->finishResource(), {}, 1); my %nonResourceItems = ( $iterator->BEGIN_MAP => 1, $iterator->BEGIN_BRANCH => 1, $iterator->END_BRANCH => 1, $iterator->END_MAP => 1, $iterator->FORWARD => 1, $iterator->BACKWARD => 1 ); # These items are not resources but appear in the midst of iteration. # Iterate on the resource..select the items that are randomly selected # and that are in the seq_has. Presumably the iterator will take care # of the random ordering part of the deal. # my $curres; while ($curres = $iterator->next()) { # # Only process resources..that are not removed by randomout... # and are selected for printint as well. # if (! exists $nonResourceItems{$curres} && ! $curres->randomout()) { my $symb = $curres->symb(); if (exists $seq_hash{$symb}) { push(@output_seq, $symb); } } } return \@output_seq; # for now. } # Fetch the contents of a resource, uninterpreted. # This is used here to fetch a latex file to be included # verbatim into the printout< # NOTE: Ask Guy if there is a lonnet function similar to this? # # Parameters: # URL of the file # sub fetch_raw_resource { my ($url) = @_; my $filename = &Apache::lonnet::filelocation("", $url); my $contents = &Apache::lonnet::getfile($filename); if ($contents == -1) { return "File open failed for $filename"; # This will bomb the print. } return $contents; } # Fetch the annotations associated with a URL and # put a centered 'annotations:' title. # This is all suppressed if the annotations are empty. # sub annotate { my ($symb) = @_; my $annotation_text = &Apache::loncommon::get_annotation($symb, 1); my $result = ""; if (length($annotation_text) > 0) { $result .= '\\hspace*{\\fill} \\\\[\\baselineskip] \textbf{Annotations:} \\\\ '; $result .= "\n"; $result .= &Apache::lonxml::latex_special_symbols($annotation_text,""); # Escape latex. $result .= "\n\n"; } return $result; } # # Set a global document font size: # This is done by replacing \begin{document} # with \begin{document}{\some-font-directive # and \end{document} with # }\end{document # sub set_font_size { my ($text) = @_; # There appear to be cases where the font directive is empty.. in which # case the first substituion would insert a spurious \ oh happy day. # as this has been the cause of much mystery and hair pulling _sigh_ if ($font_size ne '') { $text =~ s/\\begin{document}/\\begin{document}{\\$font_size/; } $text =~ s/\\end{document}/}\\end{document}/; return $text; } # include_pdf - PDF files are included into the # output as follows: # - The PDF, if necessary, is replicated. # - The PDF is added to the list of files to convert to postscript (along with the images). # - The LaTeX is added to include the final converted postscript in the file as an included # job. The assumption is that the includedpsheader.ps header will be included. # # Parameters: # pdf_uri - URI of the PDF file to include. # # Returns: # The LaTeX to include. # # Assumptions: # The uri is actually a PDF file # The postscript will have the includepsheader.ps included. # # sub include_pdf { my ($pdf_uri) = @_; # Where is the file? If not local we'll need to repcopy it:' my $file = &Apache::lonnet::filelocation('', $pdf_uri); if (! -e $file) { &Apache::lonnet::repcopy($file); $file = &Apache::lonnet::filelocation('',$pdf_uri); } # The file isn ow replicated locally.. or it did not exist in the first place # (unlikely). If it did exist, add the pdf to the set of files/images that # need tob e converted for this print job: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'}; $file =~ s{(.*)/res/}{$londocroot/res/}; open(FILE,">>$Apache::lonnet::perlvar{'lonPrtDir'}/$env{'user.name'}_$env{'user.domain'}_printout.dat"); print FILE ("$file\n"); close (FILE); # Construct the special to put out. To do this we need to get the # resulting filename after conversion. The file will have the same name # but will be in the user's spool directory with converted images. my $dirname = "/home/httpd/prtspool/$env{'user.name'}/"; my ( $base, $path, $ext) = &fileparse($file, '.pdf'); # my $destname = $dirname.'/'.$base.'.eps'; # Not really an eps but easier in printout.pl $base =~ s/ /\_/g; my $output = &print_latex_header(); $output .= '\special{ps: _begin_job_ (' .$base.'.pdf.eps'. ')run _end_job_}'; return $output; } # # ssi_with_retries- Does the server side include of a resource. # if the ssi call returns an error we'll retry it up to # the number of times requested by the caller. # If we still have a proble, no text is appended to the # output and we set some global variables. # to indicate to the caller an SSI error occurred. # All of this is supposed to deal with the issues described # in LonCAPA BZ 5631 see: # http://bugs.lon-capa.org/show_bug.cgi?id=5631 # by informing the user that this happened. # # Parameters: # resource - The resource to include. This is passed directly, without # interpretation to lonnet::ssi. # form - The form hash parameters that guide the interpretation of the resource # # retries - Number of retries allowed before giving up completely. # Returns: # On success, returns the rendered resource identified by the resource parameter. # Side Effects: # The following global variables can be set: # ssi_error - If an unrecoverable error occurred this becomes true. # It is up to the caller to initialize this to false # if desired. # ssi_last_error_resource - If an unrecoverable error occurred, this is the value # of the resource that could not be rendered by the ssi # call. # ssi_last_error - The error string fetched from the ssi response # in the event of an error. # sub ssi_with_retries { my ($resource, $retries, %form) = @_; my $target = $form{'grade_target'}; my $aom = $form{'answer_output_mode'}; my ($content, $response) = &Apache::loncommon::ssi_with_retries($resource, $retries, %form); if (!$response->is_success) { $ssi_error = 1; $ssi_last_error_resource = $resource; $ssi_last_error = $response->code . " " . $response->message; $content='\section*{!!! An error occurred !!!}'; } return $content; } sub get_student_view_with_retries { my ($curresline,$retries,$username,$userdomain,$courseid,$target,$moreenv)=@_; my ($content, $response) = &Apache::loncommon::get_student_view_with_retries($curresline,$retries,$username,$userdomain,$courseid,$target,$moreenv); if (!$response->is_success) { $ssi_error = 1; $ssi_last_error_resource = $curresline.' for user '.$username.':'.$userdomain; $ssi_last_error = $response->code . " " . $response->message; $content='\section*{!!! An error occurred !!!}'; } return $content; } # # printf_style_subst item format_string repl # # Does printf style substitution for a format string that # can have %[n]item in it.. wherever, %[n]item occurs, # rep is substituted in format_string. Note that # [n] is an optional integer length. If provided, # repl is truncated to at most [n] characters prior to # substitution. # sub printf_style_subst { my ($item, $format_string, $repl) = @_; my $result = ""; while ($format_string =~ /(%)(\d*)\Q$item\E/g ) { my $fmt = $1; my $size = $2; my $subst = $repl; if ($size ne "") { $subst = substr($subst, 0, $size); # Here's a nice edge case.. supose the end of the # substring is a \. In that case may have just # chopped off a TeX escape... in that case, we append # " " for the trailing character, and let the field # spill over a bit (sigh). # We don't just chop off the last character in order to deal # with one last pathology, and that would be if substr had # trimmed us to e.g. \\\ if ($subst =~ /\\$/) { $subst .= " "; } } my $item_pos = pos($format_string); $result .= substr($format_string, 0, $item_pos - length($size) -2) . $subst; $format_string = substr($format_string, pos($format_string)); } # Put the residual format string into the result: $result .= $format_string; return $result; } # Format a header according to a format. # # Substitutions: # %a - Assignment name. # %c - Course name. # %n - Student name. # %s - The section if it is supplied. # sub format_page_header { my ($width, $format, $assignment, $course, $student, $section) = @_; $width = &recalcto_mm($width); # Get width in mm. my $chars_per_line = int($width/1.6); # Character/textline. # Default format? if ($format eq '') { # For the default format, we may need to truncate # elements.. To do this we need to get the page width. # we assume that each character is about 2mm in width. # (correct for the header text size??). We ignore # any formatting (e.g. boldfacing in this). # # - Allow the student/course to be one line. # but only truncate the course. # - Allow the assignment to be 2 lines (wrapped). # my $name_length = int($chars_per_line *3 /4); my $sec_length = int($chars_per_line / 5); $format = "%$name_length".'n'; if ($section) { $format .= ' - Sec: '."%$sec_length".'s'; } $format .= '\\\\%c \\\\ %a'; } # An open question is how to handle long user formatted page headers... # A possible future is to support e.g. %na so that the user can control # the truncation of the elements that can appear in the header. # $format = &printf_style_subst("a", $format, $assignment); $format = &printf_style_subst("c", $format, $course); $format = &printf_style_subst("n", $format, $student); $format = &printf_style_subst("s", $format, $section); # If the user put %'s in the format string, they must be escaped # to \% else LaTeX will think they are comments and terminate # the line.. which is bad!!! # If the user has role author, $course and $assignment are empty so # there is '\\ \\ ' in the page header. That's cause a error in LaTeX if($format =~ /\\\\\s\\\\\s/) { #TODO find sensible caption for page header my $testPrintout = '\\\\'.&mt('Construction Space').' \\\\'.&mt('Test-Printout '); $format =~ s/\\\\\s\\\\\s/$testPrintout/; } # # We're going to trust LaTeX to break lines appropriately, but # we'll truncate anything that's more than 3 lines worth of # text. This is also assuming (which will probably end badly) # nobody's going to embed LaTeX control sequences in the title # header or rather that those control sequences won't get broken # by the stuff below. # my $total_length = 3*$chars_per_line; if (length($format) > $total_length) { $format = substr($format, 0, $total_length); } return $format; } # # Convert a numeric code to letters # sub num_to_letters { my ($num) = @_; my @nums= split('',$num); my @num_to_let=('A'..'Z'); my $word; foreach my $digit (@nums) { $word.=$num_to_let[$digit]; } return $word; } # Convert a letter code to numeric. # sub letters_to_num { my ($letters) = @_; my @letters = split('', uc($letters)); my %substitution; my $digit = 0; foreach my $letter ('A'..'J') { $substitution{$letter} = $digit; $digit++; } # The substitution is done as below to preserve leading # zeroes which are needed to keep the code size exact # my $result =""; foreach my $letter (@letters) { $result.=$substitution{$letter}; } return $result; } # Determine if a code is a valid numeric code. Valid # numeric codes must be comprised entirely of digits and # have a correct number of digits. # # Parameters: # value - proposed code value. # num_digits - Number of digits required. # sub is_valid_numeric_code { my ($value, $num_digits) = @_; # Remove leading/trailing whitespace; $value =~ s/^\s*//g; $value =~ s/\s*$//g; # All digits? if ($value !~ /^[0-9]+$/) { return "Numeric code $value has invalid characters - must only be digits"; } if (length($value) != $num_digits) { return "Numeric code $value incorrect number of digits (correct = $num_digits)"; } return undef; } # Determines if a code is a valid alhpa code. Alpha codes # are ciphers that map [A-J,a-j] -> 0..9 0..9. # They also have a correct digit count. # Parameters: # value - Proposed code value. # num_letters - correct number of letters. # Note: # leading and trailing whitespace are ignored. # sub is_valid_alpha_code { my ($value, $num_letters) = @_; # strip leading and trailing spaces. $value =~ s/^\s*//g; $value =~ s/\s*$//g; # All alphas in the right range? if ($value !~ /^[A-J,a-j]+$/) { return "Invalid letter code $value must only contain A-J"; } if (length($value) != $num_letters) { return "Letter code $value has incorrect number of letters (correct = $num_letters)"; } return undef; } # Determine if a code entered by the user in a helper is valid. # valid depends on the code type and the type of code selected. # The type of code selected can either be numeric or # Alphabetic. If alphabetic, the code, in fact is a simple # substitution cipher for the actual numeric code: 0->A, 1->B ... # We'll be nice and be case insensitive for alpha codes. # Parameters: # code_value - the value of the code the user typed in. # code_option - The code type selected from the set in the scantron format # table. # Returns: # undef - The code is valid. # other - An error message indicating what's wrong. # sub is_code_valid { my ($code_value, $code_option) = @_; my ($code_type, $code_length) = ('letter', 6); # defaults. my @lines = &Apache::grades::get_scantronformat_file(); foreach my $line (@lines) { my ($name, $type, $length) = (split(/:/, $line))[0,2,4]; if($name eq $code_option) { $code_length = $length; if($type eq 'number') { $code_type = 'number'; } } } my $valid; if ($code_type eq 'number') { return &is_valid_numeric_code($code_value, $code_length); } else { return &is_valid_alpha_code($code_value, $code_length); } } # Compare two students by name. The students are in the form # returned by the helper: # user:domain:section:last, first:status # This is a helper function for the perl sort built-in therefore: # Implicit Inputs: # $a - The first element to compare (global) # $b - The second element to compare (global) # Returns: # -1 - $a < $b # 0 - $a == $b # +1 - $a > $b # Note that the initial comparison is done on the last names with the # first names only used to break the tie. # # sub compare_names { # First split the names up into the primary fields. my ($u1, $d1, $s1, $n1, $stat1) = split(/:/, $a); my ($u2, $d2, $s2, $n2, $stat2) = split(/:/, $b); # Now split the last name and first name of each n: # my ($l1,$f1) = split(/,/, $n1); my ($l2,$f2) = split(/,/, $n2); # We don't bother to remove the leading/trailing whitespace from the # firstname, unless the last names compare identical. if($l1 lt $l2) { return -1; } if($l1 gt $l2) { return 1; } # Break the tie on the first name, but there are leading (possibly trailing # whitespaces to get rid of first # $f1 =~ s/^\s+//; # Remove leading... $f1 =~ s/\s+$//; # Trailing spaces from first 1... $f2 =~ s/^\s+//; $f2 =~ s/\s+$//; # And the same for first 2... if($f1 lt $f2) { return -1; } if($f1 gt $f2) { return 1; } # Must be the same name. return 0; } sub latex_header_footer_remove { my $text = shift; $text =~ s/\\end{document}//; $text =~ s/\\documentclass([^&]*)\\begin{document}//; return $text; } # # If necessary, encapsulate text inside # a minipage env. # necessity is determined by the problem_split param. # sub encapsulate_minipage { my ($text) = @_; if (!($env{'form.problem.split'} =~ /yes/i)) { $text = '\begin{minipage}{\textwidth}'.$text.'\end{minipage}'; } return $text; } # # The NUMBER_TO_PRINT and SPLIT_PDFS # variables interact, this sub looks at these two parameters # and comes up with a final value for NUMBER_TO_PRINT which can be: # all - if SPLIT_PDFS eq 'all'. # 1 - if SPLIT_PDFS eq 'oneper' # section - if SPLIT_PDFS eq 'sections' # - if SPLIT_PDFS eq 'usenumber' # sub adjust_number_to_print { my $helper = shift; my $split_pdf = $helper->{'VARS'}->{'SPLIT_PDFS'}; if ($split_pdf eq 'all') { $helper->{'VARS'}->{'NUMBER_TO_PRINT'} = 'all'; } elsif ($split_pdf eq 'oneper') { $helper->{'VARS'}->{'NUMBER_TO_PRINT'} = 1; } elsif ($split_pdf eq 'sections') { $helper->{'VARS'}->{'NUMBER_TO_PRINT'} = 'section'; } elsif ($split_pdf eq 'usenumber') { # Unmodified. } else { # Error!!!! croak "bad SPLIT_PDFS: $split_pdf in lonprintout::adjust_number_to_print"; } } sub character_chart { my $result = shift; return &Apache::entities::replace_entities($result); } sub old_character_chart { my $result = shift; $result =~ s/&\#0?0?(7|9);//g; $result =~ s/&\#0?(10|13);//g; $result =~ s/&\#0?32;/ /g; $result =~ s/&\#0?33;/!/g; $result =~ s/&(\#0?34|quot);/\"/g; $result =~ s/&\#0?35;/\\\#/g; $result =~ s/&\#0?36;/\\\$/g; $result =~ s/&\#0?37;/\\%/g; $result =~ s/&(\#0?38|amp);/\\&/g; $result =~ s/&\#(0?39|146);/\'/g; $result =~ s/&\#0?40;/(/g; $result =~ s/&\#0?41;/)/g; $result =~ s/&\#0?42;/\*/g; $result =~ s/&\#0?43;/\+/g; $result =~ s/&\#(0?44|130);/,/g; $result =~ s/&\#0?45;/-/g; $result =~ s/&\#0?46;/\./g; $result =~ s/&\#0?47;/\//g; $result =~ s/&\#0?48;/0/g; $result =~ s/&\#0?49;/1/g; $result =~ s/&\#0?50;/2/g; $result =~ s/&\#0?51;/3/g; $result =~ s/&\#0?52;/4/g; $result =~ s/&\#0?53;/5/g; $result =~ s/&\#0?54;/6/g; $result =~ s/&\#0?55;/7/g; $result =~ s/&\#0?56;/8/g; $result =~ s/&\#0?57;/9/g; $result =~ s/&\#0?58;/:/g; $result =~ s/&\#0?59;/;/g; $result =~ s/&(\#0?60|lt|\#139);/\$<\$/g; $result =~ s/&\#0?61;/\\ensuremath\{=\}/g; $result =~ s/&(\#0?62|gt|\#155);/\\ensuremath\{>\}/g; $result =~ s/&\#0?63;/\?/g; $result =~ s/&\#0?65;/A/g; $result =~ s/&\#0?66;/B/g; $result =~ s/&\#0?67;/C/g; $result =~ s/&\#0?68;/D/g; $result =~ s/&\#0?69;/E/g; $result =~ s/&\#0?70;/F/g; $result =~ s/&\#0?71;/G/g; $result =~ s/&\#0?72;/H/g; $result =~ s/&\#0?73;/I/g; $result =~ s/&\#0?74;/J/g; $result =~ s/&\#0?75;/K/g; $result =~ s/&\#0?76;/L/g; $result =~ s/&\#0?77;/M/g; $result =~ s/&\#0?78;/N/g; $result =~ s/&\#0?79;/O/g; $result =~ s/&\#0?80;/P/g; $result =~ s/&\#0?81;/Q/g; $result =~ s/&\#0?82;/R/g; $result =~ s/&\#0?83;/S/g; $result =~ s/&\#0?84;/T/g; $result =~ s/&\#0?85;/U/g; $result =~ s/&\#0?86;/V/g; $result =~ s/&\#0?87;/W/g; $result =~ s/&\#0?88;/X/g; $result =~ s/&\#0?89;/Y/g; $result =~ s/&\#0?90;/Z/g; $result =~ s/&\#0?91;/[/g; $result =~ s/&\#0?92;/\\ensuremath\{\\setminus\}/g; $result =~ s/&\#0?93;/]/g; $result =~ s/&\#(0?94|136);/\\ensuremath\{\\wedge\}/g; $result =~ s/&\#(0?95|138|154);/\\underline{\\makebox[2mm]{\\strut}}/g; $result =~ s/&\#(0?96|145);/\`/g; $result =~ s/&\#0?97;/a/g; $result =~ s/&\#0?98;/b/g; $result =~ s/&\#0?99;/c/g; $result =~ s/&\#100;/d/g; $result =~ s/&\#101;/e/g; $result =~ s/&\#102;/f/g; $result =~ s/&\#103;/g/g; $result =~ s/&\#104;/h/g; $result =~ s/&\#105;/i/g; $result =~ s/&\#106;/j/g; $result =~ s/&\#107;/k/g; $result =~ s/&\#108;/l/g; $result =~ s/&\#109;/m/g; $result =~ s/&\#110;/n/g; $result =~ s/&\#111;/o/g; $result =~ s/&\#112;/p/g; $result =~ s/&\#113;/q/g; $result =~ s/&\#114;/r/g; $result =~ s/&\#115;/s/g; $result =~ s/&\#116;/t/g; $result =~ s/&\#117;/u/g; $result =~ s/&\#118;/v/g; $result =~ s/&\#119;/w/g; $result =~ s/&\#120;/x/g; $result =~ s/&\#121;/y/g; $result =~ s/&\#122;/z/g; $result =~ s/&\#123;/\\{/g; $result =~ s/&\#124;/\|/g; $result =~ s/&\#125;/\\}/g; $result =~ s/&\#126;/\~/g; $result =~ s/&\#131;/\\textflorin /g; $result =~ s/&\#132;/\"/g; $result =~ s/&\#133;/\\ensuremath\{\\ldots\}/g; $result =~ s/&\#134;/\\ensuremath\{\\dagger\}/g; $result =~ s/&\#135;/\\ensuremath\{\\ddagger\}/g; $result =~ s/&\#137;/\\textperthousand /g; $result =~ s/&\#140;/{\\OE}/g; $result =~ s/&\#147;/\`\`/g; $result =~ s/&\#148;/\'\'/g; $result =~ s/&\#149;/\\ensuremath\{\\bullet\}/g; $result =~ s/&(\#150|\#8211);/--/g; $result =~ s/&\#151;/---/g; $result =~ s/&\#152;/\\ensuremath\{\\sim\}/g; $result =~ s/&\#153;/\\texttrademark /g; $result =~ s/&\#156;/\\oe/g; $result =~ s/&\#159;/\\\"Y/g; $result =~ s/&(\#160|nbsp);/~/g; $result =~ s/&(\#161|iexcl);/!\`/g; $result =~ s/&(\#162|cent);/\\textcent /g; $result =~ s/&(\#163|pound);/\\pounds /g; $result =~ s/&(\#164|curren);/\\textcurrency /g; $result =~ s/&(\#165|yen);/\\textyen /g; $result =~ s/&(\#166|brvbar);/\\textbrokenbar /g; $result =~ s/&(\#167|sect);/\\textsection /g; $result =~ s/&(\#168|uml);/\\"\{\} /g; $result =~ s/&(\#169|copy);/\\copyright /g; $result =~ s/&(\#170|ordf);/\\textordfeminine /g; $result =~ s/&(\#172|not);/\\ensuremath\{\\neg\}/g; $result =~ s/&(\#173|shy);/ - /g; $result =~ s/&(\#174|reg);/\\textregistered /g; $result =~ s/&(\#175|macr);/\\ensuremath\{^{-}\}/g; $result =~ s/&(\#176|deg);/\\ensuremath\{^{\\circ}\}/g; $result =~ s/&(\#177|plusmn);/\\ensuremath\{\\pm\}/g; $result =~ s/&(\#178|sup2);/\\ensuremath\{^2\}/g; $result =~ s/&(\#179|sup3);/\\ensuremath\{^3\}/g; $result =~ s/&(\#180|acute);/\\'\{\} /g; $result =~ s/&(\#181|micro);/\\ensuremath\{\\mu\}/g; $result =~ s/&(\#182|para);/\\P/g; $result =~ s/&(\#183|middot);/\\ensuremath\{\\cdot\}/g; $result =~ s/&(\#184|cedil);/\\c{\\strut}/g; $result =~ s/&(\#185|sup1);/\\ensuremath\{^1\}/g; $result =~ s/&(\#186|ordm);/\\textordmasculine /g; $result =~ s/&(\#188|frac14);/\\textonequarter /g; $result =~ s/&(\#189|frac12);/\\textonehalf /g; $result =~ s/&(\#190|frac34);/\\textthreequarters /g; $result =~ s/&(\#191|iquest);/?\`/g; $result =~ s/&(\#192|Agrave);/\\\`{A}/g; $result =~ s/&(\#193|Aacute);/\\\'{A}/g; $result =~ s/&(\#194|Acirc);/\\^{A}/g; $result =~ s/&(\#195|Atilde);/\\~{A}/g; $result =~ s/&(\#196|Auml);/\\\"{A}/g; $result =~ s/&(\#197|Aring);/{\\AA}/g; $result =~ s/&(\#198|AElig);/{\\AE}/g; $result =~ s/&(\#199|Ccedil);/\\c{c}/g; $result =~ s/&(\#200|Egrave);/\\\`{E}/g; $result =~ s/&(\#201|Eacute);/\\\'{E}/g; $result =~ s/&(\#202|Ecirc);/\\^{E}/g; $result =~ s/&(\#203|Euml);/\\\"{E}/g; $result =~ s/&(\#204|Igrave);/\\\`{I}/g; $result =~ s/&(\#205|Iacute);/\\\'{I}/g; $result =~ s/&(\#206|Icirc);/\\^{I}/g; $result =~ s/&(\#207|Iuml);/\\\"{I}/g; $result =~ s/&(\#209|Ntilde);/\\~{N}/g; $result =~ s/&(\#210|Ograve);/\\\`{O}/g; $result =~ s/&(\#211|Oacute);/\\\'{O}/g; $result =~ s/&(\#212|Ocirc);/\\^{O}/g; $result =~ s/&(\#213|Otilde);/\\~{O}/g; $result =~ s/&(\#214|Ouml);/\\\"{O}/g; $result =~ s/&(\#215|times);/\\ensuremath\{\\times\}/g; $result =~ s/&(\#216|Oslash);/{\\O}/g; $result =~ s/&(\#217|Ugrave);/\\\`{U}/g; $result =~ s/&(\#218|Uacute);/\\\'{U}/g; $result =~ s/&(\#219|Ucirc);/\\^{U}/g; $result =~ s/&(\#220|Uuml);/\\\"{U}/g; $result =~ s/&(\#221|Yacute);/\\\'{Y}/g; $result =~ s/&(\#223|szlig);/{\\ss}/g; $result =~ s/&(\#224|agrave);/\\\`{a}/g; $result =~ s/&(\#225|aacute);/\\\'{a}/g; $result =~ s/&(\#226|acirc);/\\^{a}/g; $result =~ s/&(\#227|atilde);/\\~{a}/g; $result =~ s/&(\#228|auml);/\\\"{a}/g; $result =~ s/&(\#229|aring);/{\\aa}/g; $result =~ s/&(\#230|aelig);/{\\ae}/g; $result =~ s/&(\#231|ccedil);/\\c{c}/g; $result =~ s/&(\#232|egrave);/\\\`{e}/g; $result =~ s/&(\#233|eacute);/\\\'{e}/g; $result =~ s/&(\#234|ecirc);/\\^{e}/g; $result =~ s/&(\#235|euml);/\\\"{e}/g; $result =~ s/&(\#236|igrave);/\\\`{i}/g; $result =~ s/&(\#237|iacute);/\\\'{i}/g; $result =~ s/&(\#238|icirc);/\\^{i}/g; $result =~ s/&(\#239|iuml);/\\\"{i}/g; $result =~ s/&(\#240|eth);/\\ensuremath\{\\partial\}/g; $result =~ s/&(\#241|ntilde);/\\~{n}/g; $result =~ s/&(\#242|ograve);/\\\`{o}/g; $result =~ s/&(\#243|oacute);/\\\'{o}/g; $result =~ s/&(\#244|ocirc);/\\^{o}/g; $result =~ s/&(\#245|otilde);/\\~{o}/g; $result =~ s/&(\#246|ouml);/\\\"{o}/g; $result =~ s/&(\#247|divide);/\\ensuremath\{\\div\}/g; $result =~ s/&(\#248|oslash);/{\\o}/g; $result =~ s/&(\#249|ugrave);/\\\`{u}/g; $result =~ s/&(\#250|uacute);/\\\'{u}/g; $result =~ s/&(\#251|ucirc);/\\^{u}/g; $result =~ s/&(\#252|uuml);/\\\"{u}/g; $result =~ s/&(\#253|yacute);/\\\'{y}/g; $result =~ s/&(\#255|yuml);/\\\"{y}/g; $result =~ s/&\#295;/\\ensuremath\{\\hbar\}/g; $result =~ s/&\#952;/\\ensuremath\{\\theta\}/g; #Greek Alphabet $result =~ s/&(alpha|\#945);/\\ensuremath\{\\alpha\}/g; $result =~ s/&(beta|\#946);/\\ensuremath\{\\beta\}/g; $result =~ s/&(gamma|\#947);/\\ensuremath\{\\gamma\}/g; $result =~ s/&(delta|\#948);/\\ensuremath\{\\delta\}/g; $result =~ s/&(epsilon|\#949);/\\ensuremath\{\\epsilon\}/g; $result =~ s/&(zeta|\#950);/\\ensuremath\{\\zeta\}/g; $result =~ s/&(eta|\#951);/\\ensuremath\{\\eta\}/g; $result =~ s/&(theta|\#952);/\\ensuremath\{\\theta\}/g; $result =~ s/&(iota|\#953);/\\ensuremath\{\\iota\}/g; $result =~ s/&(kappa|\#954);/\\ensuremath\{\\kappa\}/g; $result =~ s/&(lambda|\#955);/\\ensuremath\{\\lambda\}/g; $result =~ s/&(mu|\#956);/\\ensuremath\{\\mu\}/g; $result =~ s/&(nu|\#957);/\\ensuremath\{\\nu\}/g; $result =~ s/&(xi|\#958);/\\ensuremath\{\\xi\}/g; $result =~ s/&(omicron|\#959);/o/g; $result =~ s/&(pi|\#960);/\\ensuremath\{\\pi\}/g; $result =~ s/&(rho|\#961);/\\ensuremath\{\\rho\}/g; $result =~ s/&(sigma|\#963);/\\ensuremath\{\\sigma\}/g; $result =~ s/&(tau|\#964);/\\ensuremath\{\\tau\}/g; $result =~ s/&(upsilon|\#965);/\\ensuremath\{\\upsilon\}/g; $result =~ s/&(phi|\#966);/\\ensuremath\{\\phi\}/g; $result =~ s/&(chi|\#967);/\\ensuremath\{\\chi\}/g; $result =~ s/&(psi|\#968);/\\ensuremath\{\\psi\}/g; $result =~ s/&(omega|\#969);/\\ensuremath\{\\omega\}/g; $result =~ s/&(thetasym|\#977);/\\ensuremath\{\\vartheta\}/g; $result =~ s/&(piv|\#982);/\\ensuremath\{\\varpi\}/g; $result =~ s/&(Alpha|\#913);/A/g; $result =~ s/&(Beta|\#914);/B/g; $result =~ s/&(Gamma|\#915);/\\ensuremath\{\\Gamma\}/g; $result =~ s/&(Delta|\#916);/\\ensuremath\{\\Delta\}/g; $result =~ s/&(Epsilon|\#917);/E/g; $result =~ s/&(Zeta|\#918);/Z/g; $result =~ s/&(Eta|\#919);/H/g; $result =~ s/&(Theta|\#920);/\\ensuremath\{\\Theta\}/g; $result =~ s/&(Iota|\#921);/I/g; $result =~ s/&(Kappa|\#922);/K/g; $result =~ s/&(Lambda|\#923);/\\ensuremath\{\\Lambda\}/g; $result =~ s/&(Mu|\#924);/M/g; $result =~ s/&(Nu|\#925);/N/g; $result =~ s/&(Xi|\#926);/\\ensuremath\{\\Xi\}/g; $result =~ s/&(Omicron|\#927);/O/g; $result =~ s/&(Pi|\#928);/\\ensuremath\{\\Pi\}/g; $result =~ s/&(Rho|\#929);/P/g; $result =~ s/&(Sigma|\#931);/\\ensuremath\{\\Sigma\}/g; $result =~ s/&(Tau|\#932);/T/g; $result =~ s/&(Upsilon|\#933);/\\ensuremath\{\\Upsilon\}/g; $result =~ s/&(Phi|\#934);/\\ensuremath\{\\Phi\}/g; $result =~ s/&(Chi|\#935);/X/g; $result =~ s/&(Psi|\#936);/\\ensuremath\{\\Psi\}/g; $result =~ s/&(Omega|\#937);/\\ensuremath\{\\Omega\}/g; #Arrows (extended HTML 4.01) $result =~ s/&(larr|\#8592);/\\ensuremath\{\\leftarrow\}/g; $result =~ s/&(uarr|\#8593);/\\ensuremath\{\\uparrow\}/g; $result =~ s/&(rarr|\#8594);/\\ensuremath\{\\rightarrow\}/g; $result =~ s/&(darr|\#8595);/\\ensuremath\{\\downarrow\}/g; $result =~ s/&(harr|\#8596);/\\ensuremath\{\\leftrightarrow\}/g; $result =~ s/&(lArr|\#8656);/\\ensuremath\{\\Leftarrow\}/g; $result =~ s/&(uArr|\#8657);/\\ensuremath\{\\Uparrow\}/g; $result =~ s/&(rArr|\#8658);/\\ensuremath\{\\Rightarrow\}/g; $result =~ s/&(dArr|\#8659);/\\ensuremath\{\\Downarrow\}/g; $result =~ s/&(hArr|\#8660);/\\ensuremath\{\\Leftrightarrow\}/g; #Mathematical Operators (extended HTML 4.01) $result =~ s/&(forall|\#8704);/\\ensuremath\{\\forall\}/g; $result =~ s/&(part|\#8706);/\\ensuremath\{\\partial\}/g; $result =~ s/&(exist|\#8707);/\\ensuremath\{\\exists\}/g; $result =~ s/&(empty|\#8709);/\\ensuremath\{\\emptyset\}/g; $result =~ s/&(nabla|\#8711);/\\ensuremath\{\\nabla\}/g; $result =~ s/&(isin|\#8712);/\\ensuremath\{\\in\}/g; $result =~ s/&(notin|\#8713);/\\ensuremath\{\\notin\}/g; $result =~ s/&(ni|\#8715);/\\ensuremath\{\\ni\}/g; $result =~ s/&(prod|\#8719);/\\ensuremath\{\\prod\}/g; $result =~ s/&(sum|\#8721);/\\ensuremath\{\\sum\}/g; $result =~ s/&(minus|\#8722);/\\ensuremath\{-\}/g; $result =~ s/–/\\ensuremath\{-\}/g; $result =~ s/&(lowast|\#8727);/\\ensuremath\{*\}/g; $result =~ s/&(radic|\#8730);/\\ensuremath\{\\surd\}/g; $result =~ s/&(prop|\#8733);/\\ensuremath\{\\propto\}/g; $result =~ s/&(infin|\#8734);/\\ensuremath\{\\infty\}/g; $result =~ s/&(ang|\#8736);/\\ensuremath\{\\angle\}/g; $result =~ s/&(and|\#8743);/\\ensuremath\{\\wedge\}/g; $result =~ s/&(or|\#8744);/\\ensuremath\{\\vee\}/g; $result =~ s/&(cap|\#8745);/\\ensuremath\{\\cap\}/g; $result =~ s/&(cup|\#8746);/\\ensuremath\{\\cup\}/g; $result =~ s/&(int|\#8747);/\\ensuremath\{\\int\}/g; $result =~ s/&(sim|\#8764);/\\ensuremath\{\\sim\}/g; $result =~ s/&(cong|\#8773);/\\ensuremath\{\\cong\}/g; $result =~ s/&(asymp|\#8776);/\\ensuremath\{\\approx\}/g; $result =~ s/&(ne|\#8800);/\\ensuremath\{\\not=\}/g; $result =~ s/&(equiv|\#8801);/\\ensuremath\{\\equiv\}/g; $result =~ s/&(le|\#8804);/\\ensuremath\{\\leq\}/g; $result =~ s/&(ge|\#8805);/\\ensuremath\{\\geq\}/g; $result =~ s/&(sub|\#8834);/\\ensuremath\{\\subset\}/g; $result =~ s/&(sup|\#8835);/\\ensuremath\{\\supset\}/g; $result =~ s/&(nsub|\#8836);/\\ensuremath\{\\not\\subset\}/g; $result =~ s/&(sube|\#8838);/\\ensuremath\{\\subseteq\}/g; $result =~ s/&(supe|\#8839);/\\ensuremath\{\\supseteq\}/g; $result =~ s/&(oplus|\#8853);/\\ensuremath\{\\oplus\}/g; $result =~ s/&(otimes|\#8855);/\\ensuremath\{\\otimes\}/g; $result =~ s/&(perp|\#8869);/\\ensuremath\{\\perp\}/g; $result =~ s/&(sdot|\#8901);/\\ensuremath\{\\cdot\}/g; #Geometric Shapes (extended HTML 4.01) $result =~ s/&(loz|\#9674);/\\ensuremath\{\\Diamond\}/g; #Miscellaneous Symbols (extended HTML 4.01) $result =~ s/&(spades|\#9824);/\\ensuremath\{\\spadesuit\}/g; $result =~ s/&(clubs|\#9827);/\\ensuremath\{\\clubsuit\}/g; $result =~ s/&(hearts|\#9829);/\\ensuremath\{\\heartsuit\}/g; $result =~ s/&(diams|\#9830);/\\ensuremath\{\\diamondsuit\}/g; # Chemically useful 'things' contributed by Hon Kie (bug 4652). $result =~ s/&\#8636;/\\ensuremath\{\\leftharpoonup\}/g; $result =~ s/&\#8637;/\\ensuremath\{\\leftharpoondown\}/g; $result =~ s/&\#8640;/\\ensuremath\{\\rightharpoonup\}/g; $result =~ s/&\#8641;/\\ensuremath\{\\rightharpoondown\}/g; $result =~ s/&\#8652;/\\ensuremath\{\\rightleftharpoons\}/g; $result =~ s/&\#8605;/\\ensuremath\{\\leadsto\}/g; $result =~ s/&\#8617;/\\ensuremath\{\\hookleftarrow\}/g; $result =~ s/&\#8618;/\\ensuremath\{\\hookrightarrow\}/g; $result =~ s/&\#8614;/\\ensuremath\{\\mapsto\}/g; $result =~ s/&\#8599;/\\ensuremath\{\\nearrow\}/g; $result =~ s/&\#8600;/\\ensuremath\{\\searrow\}/g; $result =~ s/&\#8601;/\\ensuremath\{\\swarrow\}/g; $result =~ s/&\#8598;/\\ensuremath\{\\nwarrow\}/g; # Left/right quotations: $result =~ s/&(ldquo|#8220);/\`\`/g; $result =~ s/&(rdquo|#8221);/\'\'/g; return $result; } #width, height, oddsidemargin, evensidemargin, topmargin my %page_formats= ('letter' => { 'book' => { '1' => [ '7.1 in','9.8 in', '-0.57 in','-0.57 in','0.275 in'], '2' => ['3.66 in','9.8 in', '-0.57 in','-0.57 in','0.275 in'] }, 'album' => { '1' => [ '8.8 in', '6.8 in','-0.55 in', '-0.55 in','0.394 in'], '2' => [ '4.8 in', '6.8 in','-0.5 in', '-1.0 in','3.5 in'] }, }, 'legal' => { 'book' => { '1' => ['7.1 in','13 in',,'-0.57 in','-0.57 in','-0.5 in'], '2' => ['3.66 in','13 in','-0.57 in','-0.57 in','-0.5 in'] }, 'album' => { '1' => ['12 in','7.1 in',,'-0.57 in','-0.57 in','-0.5 in'], '2' => ['6.0 in','7.1 in','-1 in','-1 in','5 in'] }, }, 'tabloid' => { 'book' => { '1' => ['9.8 in','16 in','-0.57 in','-0.57 in','-0.5 in'], '2' => ['4.9 in','16 in','-0.57 in','-0.57 in','-0.5 in'] }, 'album' => { '1' => ['16 in','9.8 in','-0.57 in','-0.57 in','-0.5 in'], '2' => ['16 in','4.9 in','-0.57 in','-0.57 in','-0.5 in'] }, }, 'executive' => { 'book' => { '1' => ['6.8 in','9 in','-0.57 in','-0.57 in','1.2 in'], '2' => ['3.1 in','9 in','-0.57 in','-0.57 in','1.2 in'] }, 'album' => { '1' => [], '2' => [] }, }, 'a2' => { 'book' => { '1' => [], '2' => [] }, 'album' => { '1' => [], '2' => [] }, }, 'a3' => { 'book' => { '1' => [], '2' => [] }, 'album' => { '1' => [], '2' => [] }, }, 'a4' => { 'book' => { '1' => ['17.6 cm','27.2 cm','-1.397 cm','-2.11 cm','-1.27 cm'], '2' => [ '9.1 cm','27.2 cm','-1.397 cm','-2.11 cm','-1.27 cm'] }, 'album' => { '1' => ['21.59 cm','19.558 cm','-1.397cm','-2.11 cm','0 cm'], '2' => ['9.91 cm','19.558 cm','-1.397 cm','-2.11 cm','0 cm'] }, }, 'a5' => { 'book' => { '1' => [], '2' => [] }, 'album' => { '1' => [], '2' => [] }, }, 'a6' => { 'book' => { '1' => [], '2' => [] }, 'album' => { '1' => [], '2' => [] }, }, ); sub page_format { # #Supported paper format: "Letter [8 1/2x11 in]", "Legal [8 1/2x14 in]", # "Ledger/Tabloid [11x17 in]", "Executive [7 1/2x10 in]", # "A2 [420x594 mm]", "A3 [297x420 mm]", # "A4 [210x297 mm]", "A5 [148x210 mm]", # "A6 [105x148 mm]" # my ($papersize,$layout,$numberofcolumns) = @_; return @{$page_formats{$papersize}->{$layout}->{$numberofcolumns}}; } sub get_name { my ($uname,$udom)=@_; if (!defined($uname)) { $uname=$env{'user.name'}; } if (!defined($udom)) { $udom=$env{'user.domain'}; } my $plainname=&Apache::loncommon::plainname($uname,$udom); if ($plainname=~/^\s*$/) { $plainname=$uname.'@'.$udom; } $plainname=&Apache::lonxml::latex_special_symbols($plainname,'header'); return $plainname; } sub get_course { my $courseidinfo; if (defined($env{'request.course.id'})) { $courseidinfo = &Apache::lonxml::latex_special_symbols(&unescape($env{'course.'.$env{'request.course.id'}.'.description'}),'header'); my $sec = $env{'request.course.sec'}; } return $courseidinfo; } sub page_format_transformation { my ($papersize,$layout,$numberofcolumns,$choice,$text,$assignment,$tableofcontents,$indexlist,$selectionmade) = @_; my ($textwidth,$textheight,$oddoffset,$evenoffset,$topmargin); if ($selectionmade eq '4') { if ($choice eq 'all_problems') { $assignment=&mt('Problems from the Whole Course'); } else { $assignment=&mt('Resources from the Whole Course'); } } else { $assignment=&Apache::lonxml::latex_special_symbols($assignment,'header'); } ($textwidth,$textheight,$oddoffset,$evenoffset,$topmargin) = &page_format($papersize,$layout,$numberofcolumns,$topmargin); my $name = &get_name(); my $courseidinfo = &get_course(); my $header_text = $parmhash{'print_header_format'}; $header_text = &format_page_header($textwidth, $header_text, $assignment, $courseidinfo, $name); my $topmargintoinsert = ''; if ($topmargin ne '0') {$topmargintoinsert='\setlength{\topmargin}{'.$topmargin.'}';} my $fancypagestatement=''; if ($numberofcolumns eq '2') { $fancypagestatement="\\fancyhead{}\\fancyhead[LO]{$header_text}"; } else { $fancypagestatement="\\rhead{}\\chead{}\\lhead{$header_text}"; } if ($layout eq 'album') { $text =~ s/\\begin{document}/\\setlength{\\oddsidemargin}{$oddoffset}\\setlength{\\evensidemargin}{$evenoffset}$topmargintoinsert\n\\setlength{\\textwidth}{$textwidth}\\setlength{\\textheight}{$textheight}\\setlength{\\textfloatsep}{8pt plus 2\.0pt minus 4\.0pt}\n\\newlength{\\minipagewidth}\\setlength{\\minipagewidth}{\\textwidth\/\$number_of_columns-0\.2cm}\\usepackage{fancyhdr}\\addtolength{\\headheight}{\\baselineskip}\n\\pagestyle{fancy}$fancypagestatement\\usepackage{booktabs}\\begin{document}\\voffset=-0\.8 cm\\setcounter{page}{1}\n /; } elsif ($layout eq 'book') { if ($choice ne 'All class print') { $text =~ s/\\begin{document}/\\textheight $textheight\\oddsidemargin = $evenoffset\\evensidemargin = $evenoffset $topmargintoinsert\n\\textwidth= $textwidth\\newlength{\\minipagewidth}\\setlength{\\minipagewidth}{\\textwidth\/\$number_of_columns-0\.2cm}\n\\renewcommand{\\ref}{\\keephidden\}\\usepackage{fancyhdr}\\addtolength{\\headheight}{\\baselineskip}\\pagestyle{fancy}$fancypagestatement\\usepackage{booktabs}\\begin{document}\n\\voffset=-0\.8 cm\\setcounter{page}{1}\n/; } else { $text =~ s/\\pagestyle{fancy}\\rhead{}\\chead{}\s*\\begin{document}/\\textheight = $textheight\\oddsidemargin = $evenoffset\n\\evensidemargin = $evenoffset $topmargintoinsert\\textwidth= $textwidth\\newlength{\\minipagewidth}\n\\setlength{\\minipagewidth}{\\textwidth\/\$number_of_columns-0\.2cm}\\renewcommand{\\ref}{\\keephidden\}\\pagestyle{fancy}\\rhead{}\\chead{}\\usepackage{booktabs}\\begin{document}\\voffset=-0\.8cm\n\\setcounter{page}{1} \\vskip 5 mm\n /; } if ($papersize eq 'a4') { my $papersize_text; if ($perm{'pav'}) { $papersize_text = '\\special{papersize=210mm,297mm}'; } else { $papersize_text = '\special{papersize=210mm,297mm}'; } $text =~ s/(\\begin{document})/$1$papersize_text/; } } if ($tableofcontents eq 'yes') {$text=~s/(\\setcounter\{page\}\{1\})/$1 \\tableofcontents\\newpage /;} if ($indexlist eq 'yes') { $text=~s/(\\begin{document})/\\makeindex $1/; $text=~s/(\\end{document})/\\strut\\\\\\strut\\printindex $1/; } return $text; } sub page_cleanup { my $result = shift; $result =~ m/\\end{document}(\d*)$/; my $number_of_columns = $1; my $insert = '{'; for (my $id=1;$id<=$number_of_columns;$id++) { $insert .='l'; } $insert .= '}'; $result =~ s/(\\begin{longtable})INSERTTHEHEADOFLONGTABLE\\endfirsthead\\endhead/$1$insert/g; $result =~ s/&\s*REMOVETHEHEADOFLONGTABLE\\\\/\\\\/g; return $result,$number_of_columns; } sub details_for_menu { my ($helper)=@_; my $postdata=$env{'form.postdata'}; if (!$postdata) { $postdata=$helper->{VARS}{'postdata'}; } my $name_of_resource = &Apache::lonnet::gettitle($postdata); my $symbolic = &Apache::lonnet::symbread($postdata); return if ( $symbolic eq ''); my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symbolic); $map=&Apache::lonnet::clutter($map); my $name_of_sequence = &Apache::lonnet::gettitle($map); if ($name_of_sequence =~ /^\s*$/) { $map =~ m|([^/]+)$|; $name_of_sequence = $1; } my $name_of_map = &Apache::lonnet::gettitle($env{'request.course.uri'}); if ($name_of_map =~ /^\s*$/) { $env{'request.course.uri'} =~ m|([^/]+)$|; $name_of_map = $1; } return ($name_of_resource,$name_of_sequence,$name_of_map); } sub copyright_line { return '\noindent\makebox[\textwidth/$number_of_columns][b]{\hrulefill}\vspace*{-2 mm}\newline\noindent{\tiny Printed from LON-CAPA\copyright MSU{\hfill} Licensed under GNU General Public License } '; } my $end_of_student = "\n".'\special{ps:ENDOFSTUDENTSTAMP}'."\n"; sub latex_corrections { my ($number_of_columns,$result,$selectionmade,$answer_mode) = @_; # $result =~ s/\\includegraphics{/\\includegraphics\[width=\\minipagewidth\]{/g; my $copyright = ©right_line(); if ($selectionmade eq '1' || $answer_mode eq 'only') { $result =~ s/(\\end{document})/\\strut\\vskip 0 mm $copyright $end_of_student $1/; } else { $result =~ s/(\\end{document})/\\strut\\vspace\*{-4 mm}\\newline $copyright $end_of_student $1/; } $result =~ s/\$number_of_columns/$number_of_columns/g; $result =~ s/(\\end{longtable}\s*)(\\strut\\newline\\noindent\\makebox\[\\textwidth\/$number_of_columns\]\[b\]{\\hrulefill})/$2$1/g; $result =~ s/(\\end{longtable}\s*)\\strut\\newline/$1/g; #-- LaTeX corrections my $first_comment = index($result,'',$first_comment); substr($result,$first_comment,$end_comment-$first_comment+3) = ''; $first_comment = index($result,'