File:
[LON-CAPA] /
loncom /
interface /
lonprintout.pm
Revision
1.691:
download - view:
text,
annotated -
select for diffs
Sun Apr 16 01:33:04 2023 UTC (16 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- Printout generation via print icon in "Tools" on Course Contents page.
For these two items available to privileged users:
(a) Selected Resources from selected folder in course for selected people
(b) Selected Resources from selected folder in course for CODEd assignments
include resources that are *not* problems in table of selectable resources.
1: # The LearningOnline Network
2: # Printout
3: #
4: # $Id: lonprintout.pm,v 1.691 2023/04/16 01:33:04 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: # http://www.lon-capa.org/
26: #
27: #
28: package Apache::lonprintout;
29: use strict;
30: use Apache::Constants qw(:common :http);
31: use Apache::lonxml;
32: use Apache::lonnet;
33: use Apache::loncommon;
34: use Apache::inputtags;
35: use Apache::grades;
36: use Apache::edit;
37: use Apache::File();
38: use Apache::lonnavmaps;
39: use Apache::admannotations;
40: use Apache::lonenc;
41: use Apache::entities;
42: use Apache::londefdef;
43: # use Apache::structurelags; # for language management.
44:
45: use File::Basename;
46:
47: use HTTP::Response;
48: use LONCAPA::map();
49: use Apache::lonlocal;
50: use Carp;
51: use LONCAPA;
52:
53:
54: my %perm;
55: my %parmhash;
56: my $resources_printed;
57:
58: # Global variables that describe errors in ssi calls detected by ssi_with_retries.
59: #
60:
61: my $ssi_error; # True if there was an ssi error.
62: my $ssi_last_error_resource; # The resource URI that could not be fetched.
63: my $ssi_last_error; # The error text from the server. (e.g. 500 Server timed out).
64:
65: #
66: # Our ssi max retry count.
67: #
68:
69: my $ssi_retry_count = 5; # Some arbitrary value.
70:
71:
72: # Font size:
73:
74: my $font_size = 'normalsize'; # Default is normalsize...
75:
76: #---------------------------- Helper helpers. -------------------------
77:
78: ##
79: # Filter function to determine if a resource is a printable sequence.
80: #
81: # @param $res -Resource to check.
82: #
83: # @return 1 - printable and a resource
84: # 0 - either notm a sequence or not printable.
85: #
86: sub printable_sequence {
87: my $res = shift;
88:
89: # Non-sequences are not listed:
90:
91: if (!$res->is_sequence()) {
92: return 0;
93: }
94:
95: # Person with pav or pfo can always print:
96:
97: if ($perm{'pav'} || $perm{'pfo'}) {
98: return 1;
99: }
100:
101: if ($res->is_sequence()) {
102: my $symb = $res->symb();
103: my $navmap = $res->{NAV_MAP};
104:
105: # Find the first resource in the map:
106:
107: my $iterator = $navmap->getIterator($res, undef, undef, 1, 1);
108: my $first = $iterator->next();
109:
110: while (1) {
111: if ($first == $iterator->END_ITERATOR) { last; }
112: if (ref($first) && ! $first->is_sequence()) {last; }
113: $first = $iterator->next();
114: }
115:
116:
117: # Might be an empty map:
118:
119: if (!ref($first)) {
120: return 0;
121: }
122: my $partsref = $first->parts();
123: my @parts = @$partsref;
124: my ($open, $close) = $navmap->map_printdates($first, $parts[0]);
125: return &printable($open, $close);
126: }
127: return 0;
128: }
129:
130: # BZ5209:
131: # Create the states needed to run the helper for incomplete problems from
132: # the current folder for selected students.
133: # This includes:
134: # - A resource selector limited to problems (incompleteness must be
135: # calculated on a student per student basis.
136: # - A student selector.
137: # - Tie in to the FORMAT of the print job.
138: #
139: # States:
140: # CHOOSE_INCOMPLETE_PEOPLE_SEQ - Resource selection.
141: # CHOOSE_STUDENTS_INCOMPLETE - Student selection.
142: # CHOOSE_STUDENTS_INCOMPLETE_FORMAT - Format selection
143: # Parameters:
144: # helper - the helper which already contains info about the current folder we can
145: # purloin.
146: # map - the map for which incomplete problems are to be printed
147: # nocurrloc - True if printout called from icon/link in Tools in /adm/navmaps
148: # Return:
149: # XML that can be parsed by the helper to drive the state machine.
150: #
151: sub create_incomplete_folder_selstud_helper {
152: my ($helper, $map, $nocurrloc) = @_;
153:
154:
155: my $symbFilter = '$res->shown_symb()';
156: my $selFilter = '$res->is_problem()';
157:
158:
159: my $resource_chooser = &generate_resource_chooser('CHOOSE_INCOMPLETE_PEOPLE_SEQ',
160: 'Select problem(s) to print',
161: 'multichoice="1" toponly="1" addstatus="1" closeallpages="1" modallink="1" nocurrloc="'.$nocurrloc.'"',
162: 'RESOURCES',
163: 'CHOOSE_STUDENTS_INCOMPLETE',
164: $map,
165: $selFilter,
166: '',
167: $symbFilter,
168: '');
169:
170: my $student_chooser = &generate_student_chooser('CHOOSE_STUDENTS_INCOMPLETE',
171: 'student_sort',
172: 'STUDENTS',
173: 'CHOOSE_STUDENTS_INCOMPLETE_FORMAT');
174:
175: my $format_chooser = &generate_format_selector($helper,
176: 'Format of the print job',
177: 'CHOOSE_STUDENTS_INCOMPLETE_FORMAT'); # end state.
178:
179: return $resource_chooser . $student_chooser . $format_chooser;
180: }
181:
182:
183: # BZ 5209
184: # Create the states needed to run the helper for incomplete problems from
185: # the current folder for selected students.
186: # This includes:
187: # - A resource selector limited to problems. (incompleteness must be calculated
188: # on a student per student basis.
189: # - A student selector.
190: # - Tie in to format for the print job.
191: # States:
192: # INCOMPLETE_PROBLEMS_COURSE_RESOURCES - Resource selector.
193: # INCOMPLETE_PROBLEMS_COURSE_STUDENTS - Student selector.
194: # INCOMPLETE_PROBLEMS_COURSE_FORMAT - Format selection.
195: #
196: # Parameters:
197: # helper - Helper we are creating states for.
198: # Returns:
199: # Text that can be parsed by the helper.
200: #
201:
202: sub create_incomplete_course_helper {
203: my $helper = shift;
204:
205: my $filter = '$res->is_problem() || $res->contains_problem() || $res->is_sequence() || $res->is_practice())';
206: my $symbfilter = '$res->shown_symb()';
207:
208: my $resource_chooser = &generate_resource_chooser('INCOMPLETE_PROBLEMS_COURSE_RESOURCES',
209: 'Select problem(s) to print',
210: 'multichoice = "1" suppressEmptySequences="0" addstatus="1" closeallpagtes="1" modallink="1"',
211: 'RESOURCES',
212: 'INCOMPLETE_PROBLEMS_COURSE_STUDENTS',
213: '',
214: $filter,
215: '',
216: $symbfilter,
217: '');
218:
219: my $people_chooser = &generate_student_chooser('INCOMPLETE_PROBLEMS_COURSE_STUDENTS',
220: 'student_sort',
221: 'STUDENTS',
222: 'INCOMPLETE_PROBLEMS_COURSE_FORMAT');
223:
224: my $format = &generate_format_selector($helper,
225: 'Format of the print job',
226: 'INCOMPLETE_PROBLEMS_COURSE_FORMAT'); # end state.
227:
228: return $resource_chooser . $people_chooser . $format;
229:
230:
231: }
232:
233: # BZ5209
234: # Creates the states needed to run the print helper for a student
235: # that wants to print his incomplete problems from the current folder.
236: # Parameters:
237: # $helper - helper we are generating states for.
238: # $map - The map for which the student wants incomplete problems.
239: # $nocurrloc - True if printout called from icon/link in Tools in /adm/navmaps
240: # Returns:
241: # XML that defines the helper states being created.
242: #
243: # States:
244: # CHOOSE_INCOMPLETE_SEQ - Resource selector.
245: #
246: sub create_incomplete_folder_helper {
247: my ($helper, $map, $nocurrloc) = @_;
248:
249: my $filter = '$res->is_problem()';
250: $filter .= ' && $res->resprintable() ';
251: $filter .= ' && $res->is_incomplete() ';
252:
253: my $symfilter = '$res->shown_symb()';
254:
255: my $resource_chooser = &generate_resource_chooser('CHOOSE_INCOMPLETE_SEQ',
256: 'Select problem(s) to print',
257: 'multichoice="1", toponly ="1", addstatus="1", closeallpages="1" modallink="1" nocurrloc="'.$nocurrloc.'"',
258: 'RESOURCES',
259: 'PAGESIZE',
260: $map,
261: $filter, '',
262: $symfilter,
263: '');
264:
265: return $resource_chooser;
266: }
267:
268:
269: # Returns the text neded for a student chooser.
270: # that text must still be parsed by the helper xml parser.
271: # Parameters:
272: # this_state - State name of the chooser.
273: # sort_choice - variable to hold the sorting choice.
274: # variable - Name of variable to hold students.
275: # next_state - State after chooser.
276:
277:
278: sub generate_student_chooser {
279: my ($this_state,
280: $sort_choice,
281: $variable,
282: $next_state) = @_;
283: my $result = <<CHOOSE_STUDENTS;
284: <state name="$this_state" title="Select Students and Resources">
285: <message><b>Select sorting order of printout</b> </message>
286:
287: <choices variable="$sort_choice">
288: <choice computer='0'>Sort by section then student</choice>
289: <choice computer='1'>Sort by students across sections.</choice>
290: </choices>
291:
292: <message><br /><hr /><br /> </message>
293: <student multichoice='1'
294: variable="$variable"
295: nextstate="$next_state"
296: coursepersonnel="1" />
297: </state>
298:
299: CHOOSE_STUDENTS
300:
301: return $result;
302: }
303:
304: # Generate the text needed for a resource chooser given the top level of
305: # the sequence/page
306: #
307: # Parameters:
308: # this_state - State name of the chooser.
309: # prompt_text - Text to use to prompt user.
310: # resource_options - Resource tag options e.g.
311: # "multichoice='1', toponly='1', addstatus='1',
312: # modallink='1'"
313: # that control the selection and appearance of the
314: # resource selector.
315: # variable - Name of the variable to hold the choice
316: # next_state - Name of the next state the helper should transition
317: # to
318: # top_url - Top level URL within which to make the selector.
319: # If empty the top level sequence is shown.
320: # filter - How to filter the resources.
321: # value_func - <valuefunc> function.
322: # choice_func - If not empty generates a <choicefunc> with this function.
323: # start_new_option
324: # - Fragment appended after valuefunc.
325: #
326: #
327: sub generate_resource_chooser {
328: my ($this_state,
329: $prompt_text,
330: $resource_options,
331: $variable,
332: $next_state,
333: $top_url,
334: $filter,
335: $choice_func,
336: $value_func,
337: $start_new_option) = @_;
338:
339: my $result = <<CHOOSE_RESOURCES;
340: <state name="$this_state" title="$prompt_text">
341: <resource variable="$variable" $resource_options
342: closeallpages="1">
343: <nextstate>$next_state</nextstate>
344: <filterfunc>return $filter;</filterfunc>
345: CHOOSE_RESOURCES
346: if ($choice_func ne '') {
347: $result .= "<choicefunc>return $choice_func;</choicefunc>";
348: }
349: if ($top_url ne '') {
350: $result .= "<mapurl>$top_url</mapurl>";
351: }
352: $result .= <<CHOOSE_RESOURCES;
353: <valuefunc>return $value_func;</valuefunc>
354: $start_new_option
355: </resource>
356: </state>
357: CHOOSE_RESOURCES
358: return $result;
359: }
360: #
361: # Generate the helper XML for a code choice helper dialog:
362: #
363: # Paramters:
364: # $helper - Reference to the helper.
365: # $state - Name of the state for the chooser.
366: # $next_state - Name fo the state to follow the chooser.
367: # $bubble_types - Populates the bubble sheet type dropt down.
368: # $code_selections - Provides set of code choices that have been used
369: # $saved_codes - Provides the list of saved codes.
370: #
371: # Returns;
372: # The Xml of the code chooser.
373: #
374: sub generate_code_selector {
375: my ($helper,
376: $state,
377: $next_state,
378: $bubble_types,
379: $code_selections,
380: $saved_codes) = @_; # Unpack the parameters.
381:
382: my $result = <<CHOOSE_ANON1;
383: <state name="$state" title="Specify CODEd Assignments">
384: <nextstate>$next_state</nextstate>
385: <message><h4>Fill out one of the forms below</h4></message>
386: <message><br /><hr /> <br /></message>
387: <message><h3>Generate new CODEd Assignments</h3></message>
388: <message><table><tr><td><b>Number of CODEd assignments to print:</b></td><td></message>
389: <string variable="NUMBER_TO_PRINT_TOTAL" maxlength="5" size="5" noproceed="1">
390: <validator>
391: if (((\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'}+0) < 1) &&
392: !\$helper->{'VARS'}{'REUSE_OLD_CODES'} &&
393: !\$helper->{'VARS'}{'SINGLE_CODE'} &&
394: !\$helper->{'VARS'}{'CODE_SELECTED_FROM_LIST'} ) {
395:
396: return "You need to specify the number of assignments to print";
397: }
398: if (((\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'}+0) >= 1) &&
399: (\$helper->{'VARS'}{'SINGLE_CODE'} ne '') ) {
400: return 'Specifying number of codes to print and a specific code is not compatible';
401: }
402: return undef;
403: </validator>
404: </string>
405: <message></td></tr><tr><td></message>
406: <message><b>Names to save the CODEs under for later:</b></message>
407: <message></td><td></message>
408: <string variable="ANON_CODE_STORAGE_NAME" maxlength="50" size="20" />
409: <message></td></tr><tr><td></message>
410: <message><b>Bubblesheet type:</b></message>
411: <message></td><td></message>
412: <dropdown variable="CODE_OPTION" multichoice="0" allowempty="0">
413: $bubble_types
414: </dropdown>
415: <message></td></tr><tr><td colspan="2"></td></tr><tr><td></message>
416: <message></td></tr><tr><td></table></message>
417: <message><br /><hr /><h3>Print a Specific CODE </h3><br /><table></message>
418: <message><tr><td><b>Enter a CODE to print:</b></td><td></message>
419: <string variable="SINGLE_CODE" size="10">
420: <validator>
421: if(!\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'} &&
422: !\$helper->{'VARS'}{'REUSE_OLD_CODES'} &&
423: !\$helper->{'VARS'}{'CODE_SELECTED_FROM_LIST'}) {
424: return &Apache::lonprintout::is_code_valid(\$helper->{'VARS'}{'SINGLE_CODE'},
425: \$helper->{'VARS'}{'CODE_OPTION'});
426: } elsif (\$helper->{'VARS'}{'SINGLE_CODE'} ne ''){
427: return 'Specifying a code name is incompatible with specifying number of codes.';
428: } else {
429: return undef; # Other forces control us.
430: }
431: </validator>
432: </string>
433: <message></td></tr><tr><td></message>
434: $code_selections
435: <message></td></tr></table></message>
436: <message><hr /><h3>Reprint a Set of Saved CODEs</h3><table><tr><td></message>
437: <message><b>Select saved CODEs:</b></message>
438: <message></td><td></message>
439: <dropdown variable="REUSE_OLD_CODES">
440: $saved_codes
441: </dropdown>
442: <message></td></tr></table></message>
443: </state>
444: CHOOSE_ANON1
445:
446: return $result;
447: }
448:
449: sub generate_common_choosers {
450: my ($r,$helper,$map,$url,$isProblem,$symbFilter,$start_new_option) = @_;
451:
452: my $randomly_ordered_warning =
453: &get_randomly_ordered_warning($helper, $map);
454:
455: # code for a few states used for printout launched from both
456: # /adm/navmaps and from a resource by a privileged user:
457: # - To allow resources to be selected for printing.
458: # - To determine pagination between assignments.
459: # - To determine how many assignments should be bundled into a single PDF.
460:
461: my $resource_selector= &generate_resource_chooser('SELECT_PROBLEMS',
462: 'Select resources to print',
463: 'multichoice="1" addstatus="1" closeallpages="1" modallink="1" suppressNavmap="1"',
464: 'RESOURCES',
465: 'PRINT_FORMATTING',
466: $map,
467: $isProblem, '', $symbFilter,
468: $start_new_option);
469: $resource_selector .= &generate_format_selector($helper,
470: 'How should results be printed?',
471: 'PRINT_FORMATTING').
472: &generate_resource_chooser('CHOOSE_STUDENTS_PAGE',
473: 'Select Problem(s) to print',
474: "multichoice='1' addstatus='1' closeallpages ='1' modallink='1'",
475: 'RESOURCES',
476: 'PRINT_FORMATTING',
477: $url,
478: $isProblem, '', $symbFilter,
479: $start_new_option);
480:
481: # Generate student choosers.
482:
483: &Apache::lonxml::xmlparse($r, 'helper',
484: &generate_student_chooser('CHOOSE_TGT_STUDENTS_PAGE',
485: 'student_sort',
486: 'STUDENTS',
487: 'CHOOSE_STUDENTS_PAGE'));
488: &Apache::lonxml::xmlparse($r, 'helper',
489: &generate_student_chooser('CHOOSE_STUDENTS',
490: 'student_sort',
491: 'STUDENTS',
492: 'SELECT_PROBLEMS'));
493: &Apache::lonxml::xmlparse($r, 'helper', $resource_selector);
494:
495: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
496: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
497: my @names=&Apache::lonnet::getkeys('CODEs',$cdom,$cnum);
498: my $namechoice='<choice></choice>';
499: foreach my $name (sort {uc($a) cmp uc($b)} @names) {
500: if ($name =~ /^error: 2 /) { next; }
501: if ($name =~ /^type\0/) { next; }
502: $namechoice.='<choice computer="'.$name.'">'.$name.'</choice>';
503: }
504:
505: my %code_values;
506: my %codes_to_print;
507: foreach my $key (@names) {
508: %code_values = &Apache::grades::get_codes($key, $cdom, $cnum);
509: foreach my $key (keys(%code_values)) {
510: $codes_to_print{$key} = 1;
511: }
512: }
513:
514: my $code_selection;
515: foreach my $code (sort {uc($a) cmp uc($b)} (keys(%codes_to_print))) {
516: my $choice = $code;
517: if ($code =~ /^[A-Z]+$/) { # Alpha code
518: $choice = &letters_to_num($code);
519: }
520: push(@{$helper->{DATA}{ALL_CODE_CHOICES}},[$code,$choice]);
521: }
522: if (%codes_to_print) {
523: $code_selection .='
524: <message><b>Choose single CODE from list:</b></message>
525: <message></td><td></message>
526: <dropdown variable="CODE_SELECTED_FROM_LIST" multichoice="0" allowempty="0">
527: <choice></choice>
528: <exec>
529: push(@{$state->{CHOICES}},@{$helper->{DATA}{ALL_CODE_CHOICES}});
530: </exec>
531: </dropdown>
532: <message></td></tr><tr><td></message>
533: '.$/;
534: }
535:
536: my @lines = &Apache::lonnet::get_scantronformat_file();
537: my $codechoice='';
538: foreach my $line (@lines) {
539: next if (($line =~ /^\#/) || ($line eq ''));
540: my ($name,$description,$code_type,$code_length)=
541: (split(/:/,$line))[0,1,2,4];
542: if ($code_length > 0 &&
543: $code_type =~/^(letter|number|-1)/) {
544: $codechoice.='<choice computer="'.$name.'">'.$description.'</choice>';
545: }
546: }
547: if ($codechoice eq '') {
548: $codechoice='<choice computer="default">Default</choice>';
549: }
550: my $anon1 = &generate_code_selector($helper,
551: 'CHOOSE_ANON1',
552: 'SELECT_PROBLEMS',
553: $codechoice,
554: $code_selection,
555: $namechoice) . $resource_selector;
556:
557: &Apache::lonxml::xmlparse($r, 'helper',$anon1);
558:
559: my $anon_page = &generate_code_selector($helper,
560: 'CHOOSE_ANON1_PAGE',
561: 'SELECT_PROBLEMS_PAGE',
562: $codechoice,
563: $code_selection,
564: $namechoice) .
565: &generate_resource_chooser('SELECT_PROBLEMS_PAGE',
566: 'Select Problem(s) to print',
567: "multichoice='1' addstatus='1' closeallpages ='1' modallink='1'",
568: 'RESOURCES',
569: 'PRINT_FORMATTING',
570: $url,
571: $isProblem, '', $symbFilter,
572: $start_new_option);
573: &Apache::lonxml::xmlparse($r, 'helper', $anon_page);
574: return ($randomly_ordered_warning,$codechoice,$code_selection,$namechoice);
575: }
576:
577: # Returns the XML for choosing how assignments are to be formatted
578: # that text must still be parsed by the helper xml parser.
579: # Parameters: 3 (required)
580:
581: # helper - The helper; $helper->{'VARS'}->{'PRINT_TYPE'} used
582: # to check if splitting PDFs by section can be offered.
583: # title - Title for the current state.
584: # this_state - State name of the chooser.
585:
586: sub generate_format_selector {
587: my ($helper,$title,$this_state) = @_;
588: my $secpdfoption;
589: unless (($helper->{'VARS'}->{'PRINT_TYPE'} eq 'problems_for_anon') ||
590: ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'problems_for_anon_page') ||
591: ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'resources_for_anon') ||
592: ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'select_sequences_problems_for_anon') ||
593: ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'select_sequences_resources_for_anon')) {
594: $secpdfoption = '<choice computer="sections">Each PDF contains exactly one section</choice>';
595: }
596: return <<RESOURCE_SELECTOR;
597: <state name="$this_state" title="$title">
598: <message><br /><big><i><b>How should the results be printed?</b></i></big><br /></message>
599: <choices variable="EMPTY_PAGES">
600: <choice computer='0'>Start each student\'s assignment on a new page/column (add a pagefeed after each assignment)</choice>
601: <choice computer='1'>Add one empty page/column after each student\'s assignment</choice>
602: <choice computer='2'>Add two empty pages/column after each student\'s assignment</choice>
603: <choice computer='3'>Add three empty pages/column after each student\'s assignment</choice>
604: </choices>
605: <nextstate>PAGESIZE</nextstate>
606: <message><hr width='33%' /><b>How do you want assignments split into PDF files? </b></message>
607: <choices variable="SPLIT_PDFS">
608: <choice computer="all">All assignments in a single PDF file</choice>
609: $secpdfoption
610: <choice computer="oneper">Each PDF contains exactly one assignment</choice>
611: <choice computer="usenumber" relatedvalue="NUMBER_TO_PRINT">
612: Specify the number of assignments per PDF:</choice>
613: </choices>
614: </state>
615: RESOURCE_SELECTOR
616: }
617:
618: #-----------------------------------------------------------------------
619:
620: # Computes an open and close date from a list of open/close dates for a resource's
621: # parts.
622: #
623: # @param \@opens - reference to an array of open dates.
624: # @param \@closes - reference to an array of close dates.
625: #
626: # @return ($open, $close)
627: #
628: # @note If open/close dates are not defined they will be returned as undef
629: # @note It is possible for there to be no overlap in which case -1,-1
630: # will be returned.
631: # @note The algorithm used is to take the latest open date and the earliest end date.
632: #
633: sub compute_open_window {
634: my ($opensref, $closesref) = @_;
635:
636: my @opens = @$opensref;
637: my @closes = @$closesref;
638:
639: # latest open date:
640: my $latest_open;
641:
642: foreach my $open (@opens) {
643: if (!defined($latest_open) || ($open > $latest_open)) {
644: $latest_open = $open;
645: }
646: }
647: # Earliest close:
648:
649: my $earliest_close;
650: foreach my $close (@closes) {
651: if (!defined($earliest_close) || ($close < $earliest_close)) {
652: $earliest_close = $close;
653: }
654: }
655:
656: # If no overlap...both are -1 as promised.
657:
658: if (($earliest_close ne '') && ($latest_open ne '')
659: && ($earliest_close < $latest_open)) {
660: $latest_open = -1;
661: $earliest_close = -1;
662: }
663:
664: return ($latest_open, $earliest_close);
665:
666: }
667:
668: ##
669: # Determines if 'now' is within the set of printable dates.
670: #
671: # @param $open_date - Starting date/timestamp.
672: # @param $close_date - Ending date/timestamp.
673: #
674: # @return 0 - Not open.
675: # @return 1 - open.
676: #
677: sub printable {
678: my ($open_date, $close_date) = @_;
679:
680:
681: my $now = time();
682:
683: # Have to do a bit of fancy footwork around undefined open/close dates:
684:
685: if ($open_date && ($open_date > $now)) {
686: return 0;
687: }
688:
689: if ($close_date && ($close_date < $now)) {
690: return 0;
691: }
692:
693: return 1;
694:
695: }
696:
697: ##
698: # Returns the innermost print start/print end dates for a resource.
699: # This is done by looking at the start/end dates for its parts and choosing
700: # the intersection of those dates.
701: #
702: # @param res - lonnvamaps::resource object that represents the resource.
703: #
704: # @return (opendate, closedate)
705: #
706: # @note If open/close dates are not defined they will be returned as undef
707: # @note It is possible for there to be no overlap in which case -1,-1
708: # will be returned.
709: # @note The algorithm used is to take the latest open date and the earliest end date.
710: # For consistency with &printable() in lonnavmaps.pm determination of start
711: # date for printing checks printstartdate param first, then, if not set,
712: # opendate param, then, if not set, contentopen param.
713:
714: sub get_print_dates {
715: my $res = shift;
716: my $partsref = $res->parts();
717: my @parts;
718: if (ref($partsref) eq 'ARRAY') {
719: @parts = @{$partsref};
720: }
721: my $open_date;
722: my $close_date;
723: my @open_dates;
724: my @close_dates;
725:
726:
727: if (@parts) {
728: foreach my $part (@parts) {
729: my $partopen = $res->parmval('printstartdate', $part);
730: my $partclose = $res->parmval('printenddate', $part);
731: if (!$partopen) {
732: $partopen = $res->parmval('opendate',$part);
733: }
734: if (!$partopen) {
735: $partopen = $res->parmval('contentopen',$part);
736: }
737: if ($partopen) {
738: push(@open_dates, $partopen);
739: }
740: if ($partclose) {
741: push(@close_dates, $partclose);
742: }
743: push(@open_dates, $partopen);
744: push(@close_dates, $partclose);
745: }
746: }
747:
748: ($open_date, $close_date) = &compute_open_window(\@open_dates, \@close_dates);
749:
750: return ($open_date, $close_date);
751: }
752:
753: ##
754: # Get the dates for which a course says a resource can be printed. This is like
755: # get_print_dates but namvaps::course_print_dates are gotten...and not converted
756: # to times either.
757: #
758: # @param $res - Reference to a resource hash from lonnavmaps::resource.
759: #
760: # @return (opendate, closedate)
761: #
762: sub course_print_dates {
763: my $res = shift;
764: my $partsref = $res->parts();
765: my @parts = @$partsref;
766: my $open_date;
767: my $close_date;
768: my @open_dates;
769: my @close_dates;
770: my $navmap = $res->{NAV_MAP}; # Slightly OO dirty.
771:
772: # Don't bother looping over undefined or empty parts array;
773:
774: if (@parts) {
775: foreach my $part (@parts) {
776: my ($partopen, $partclose) = $navmap->course_printdates($res, $part);
777: push(@open_dates, $partopen);
778: push(@close_dates, $partclose);
779: }
780: ($open_date, $close_date) = &compute_open_window(\@open_dates, \@close_dates);
781: }
782: return ($open_date, $close_date);
783: }
784: ##
785: # Same as above but for the enclosing map:
786: #
787: sub map_print_dates {
788: my $res = shift;
789: my $partsref = $res->parts();
790: my @parts = @$partsref;
791: my $open_date;
792: my $close_date;
793: my @open_dates;
794: my @close_dates;
795: my $navmap = $res->{NAV_MAP}; # slightly OO dirty.
796:
797:
798: # Don't bother looping over undefined or empty parts array;
799:
800: if (@parts) {
801: foreach my $part (@parts) {
802: my ($partopen, $partclose) = $navmap->map_printdates($res, $part);
803: push(@open_dates, $partopen);
804: push(@close_dates, $partclose);
805: }
806: ($open_date, $close_date) = &compute_open_window(\@open_dates, \@close_dates);
807: }
808: return ($open_date, $close_date);
809: }
810:
811: # Determine if a resource is incomplete given the map:
812: # Parameters:
813: # $username - Name of user for whom we are checking.
814: # $domain - Domain of user we are checking.
815: # $map - map name.
816: # Returns:
817: # 0 - map is not incomplete.
818: # 1 - map is incomplete.
819: #
820: sub incomplete {
821: my ($username, $domain, $map) = @_;
822:
823:
824: my $navmap = Apache::lonnavmaps::navmap->new($username, $domain);
825:
826:
827: if (defined($navmap)) {
828: my $res = $navmap->getResourceByUrl($map);
829: my $result = $res->is_incomplete();
830: return $result;
831: } else {
832: return 1;
833: }
834: }
835: #
836: # When printing for students, the resources and order of the
837: # resources may need to be altered if there are folders with
838: # random selectiopn or random ordering (or both) enabled.
839: # This sub computes the set of resources to print for a student
840: # modified both by random ordering and selection and filtered
841: # to only those that are in the original set selected to be printed.
842: #
843: # Parameters:
844: # $map - The URL of the folder being printed.
845: # Used to determine which startResource and finishResource
846: # to use when using the navmap's getIterator method.
847: # $seq - The original set of resources to print.
848: # (really an array of resource names (array of symb's).
849: # $who - Student/domain for whome the sequence will be generated.
850: # $code - CODE being printed when printing Problems/Resources
851: # from folder for CODEd assignments
852: # $nohidemap - If true, parameter in map for hiddenresource will be
853: # ignored. The user calling the routine should have
854: # both the pav and vgr privileges if this is set to true).
855: #
856: # Implicit inputs:
857: # $
858: # Returns:
859: # reference to an array of resources that can be passed to
860: # print_resources.
861: #
862: sub master_seq_to_person_seq {
863: my ($map, $seq, $who, $code, $nohidemap) = @_;
864:
865:
866: my ($username, $userdomain, $usersection) = split(/:/, $who);
867:
868: # Toss the sequence up into a hash so that we have O(1) lookup time.
869: # on the items that come out of the user's list of resources.
870: #
871:
872: my %seq_hash = map {$_ => 1} @$seq;
873: my @output_seq;
874:
875: my $unhidden;
876: if ($nohidemap) {
877: $unhidden = &Apache::lonnet::clutter($map);
878: }
879:
880: my $navmap = Apache::lonnavmaps::navmap->new($username, $userdomain,
881: $code, $unhidden);
882: my ($start,$finish);
883:
884: if ($map) {
885: my $mapres = $navmap->getResourceByUrl($map);
886: if ($mapres->is_map()) {
887: $start = $mapres->map_start();
888: $finish = $mapres->map_finish();
889: }
890: }
891: unless ($start && $finish) {
892: $start = $navmap->firstResource();
893: $finish = $navmap->finishResource();
894: }
895:
896: my $iterator = $navmap->getIterator($start,$finish,{},1);
897:
898: # Iterate on the resource..select the items that are randomly selected
899: # and that are in the seq_hash. Presumably the iterator will take care
900: # of the random ordering part of the deal.
901: #
902: my $curres;
903: while ($curres = $iterator->next()) {
904: #
905: # Only process resources..that are not removed by randomout...
906: # and are selected for printint as well.
907: #
908: if (ref($curres) && ! $curres->randomout()) {
909: my $currsymb = $curres->symb();
910: if (exists($seq_hash{$currsymb})) {
911: push(@output_seq, $currsymb);
912: }
913: }
914: }
915:
916: return \@output_seq; # for now.
917:
918: }
919:
920:
921: # Fetch the contents of a resource, uninterpreted.
922: # This is used here to fetch a latex file to be included
923: # verbatim into the printout<
924: # NOTE: Ask Guy if there is a lonnet function similar to this?
925: #
926: # Parameters:
927: # URL of the file
928: #
929: sub fetch_raw_resource {
930: my ($url) = @_;
931:
932: my $filename = &Apache::lonnet::filelocation("", $url);
933: my $contents = &Apache::lonnet::getfile($filename);
934:
935: if ($contents == -1) {
936: return "File open failed for $filename"; # This will bomb the print.
937: }
938: return $contents;
939:
940:
941: }
942:
943: # Fetch the annotations associated with a URL and
944: # put a centered 'annotations:' title.
945: # This is all suppressed if the annotations are empty.
946: #
947: sub annotate {
948: my ($symb) = @_;
949:
950: my $annotation_text = &Apache::loncommon::get_annotation($symb, 1);
951:
952:
953: my $result = "";
954:
955: if (length($annotation_text) > 0) {
956: $result .= '\\hspace*{\\fill} \\\\[\\baselineskip] \textbf{Annotations:} \\\\ ';
957: $result .= "\n";
958: $result .= &Apache::lonxml::latex_special_symbols($annotation_text,""); # Escape latex.
959: $result .= "\n\n";
960: }
961: return $result;
962: }
963:
964: #
965: # Set a global document font size:
966: # This is done by replacing \begin{document}
967: # with \begin{document}{\some-font-directive
968: # and \end{document} with
969: # }\end{document
970: #
971: sub set_font_size {
972:
973: my ($text) = @_;
974:
975: # There appear to be cases where the font directive is empty.. in which
976: # case the first substitution would insert a spurious \ oh happy day.
977: # as this has been the cause of much mystery and hair pulling _sigh_
978:
979: if ($font_size ne '') {
980:
981: $text =~ s/\\begin\{document}/\\begin{document}{\\$font_size/;
982: $text =~ s/\\end\{document}/}\\end{document}/;
983:
984: }
985: return $text;
986:
987:
988: }
989:
990: # include_pdf - PDF files are included into the
991: # output as follows:
992: # - The PDF, if necessary, is replicated.
993: # - The PDF is added to the list of files to convert to postscript (along with the images).
994: # - The LaTeX is added to include the final converted postscript in the file as an included
995: # job. The assumption is that the includepsheader.ps header will be included.
996: #
997: # Parameters:
998: # pdf_uri - URI of the PDF file to include.
999: #
1000: # Returns:
1001: # The LaTeX to include.
1002: #
1003: # Assumptions:
1004: # The uri is actually a PDF file
1005: # The postscript will have the includepsheader.ps included.
1006: #
1007: #
1008: sub include_pdf {
1009: my ($pdf_uri) = @_;
1010:
1011: # Where is the file? If not local we'll need to repcopy it:'
1012:
1013: my $file = &Apache::lonnet::filelocation('', $pdf_uri);
1014: if (! -e $file) {
1015: &Apache::lonnet::repcopy($file);
1016: $file = &Apache::lonnet::filelocation('',$pdf_uri);
1017: }
1018:
1019: # The file is now replicated locally ... or it did not exist in the first place
1020: # (unlikely). If it did exist, add the pdf to the set of files/images that
1021: # need to be converted for this print job:
1022:
1023: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1024: $file =~ s{(.*)/res/}{$londocroot/res/};
1025:
1026: open(FILE,">>","$Apache::lonnet::perlvar{'lonPrtDir'}/$env{'user.name'}_$env{'user.domain'}_printout.dat");
1027: print FILE ("$file\n");
1028: close (FILE);
1029:
1030: # Construct the special to put out. To do this we need to get the
1031: # resulting filename after conversion. The file will have the same name
1032: # but will be in the user's spool directory with converted images.
1033:
1034: my $dirname = "/home/httpd/prtspool/$env{'user.name'}/";
1035: my ( $base, $path, $ext) = &fileparse($file, '.pdf');
1036: # my $destname = $dirname.'/'.$base.'.eps'; # Not really an eps but easier in printout.pl
1037: $base =~ s/ /\_/g;
1038:
1039:
1040: my $output = &print_latex_header();
1041: $output .= '\special{ps: _begin_job_ ('
1042: .$base.'.pdf.eps'.
1043: ')run _end_job_}';
1044:
1045: return $output;
1046:
1047:
1048: }
1049: ##
1050: # Collect the various \select_language{language_name}
1051: # latex tags to build a \usepackage[lang-list]{babel} which will
1052: # appear just prior to the \begin{document} at the front of the concatenated
1053: # set of resources:
1054: # @param doc - The string of latex to search/replace.
1055: # @return string
1056: # @retval - the modified document stringt.
1057: #
1058: sub collect_languages {
1059: my $doc = shift;
1060: my %languages;
1061: while ($doc =~ /\\selectlanguage\{(\w+)}/mg) {
1062: $languages{$1} = 1; # allows us to request each language exactly once.
1063: }
1064: my @lang_list = (keys(%languages)); # List of unique languages
1065: if (scalar @lang_list) {
1066: my $babel_header = '\usepackage[' . join(',', @lang_list) .']{babel}'. "\n";
1067: $doc =~ s/\\begin\{document}/$babel_header\\begin{document}/;
1068: }
1069: return $doc;
1070: }
1071: #-------------------------------------------------------------------
1072:
1073: #
1074: # ssi_with_retries- Does the server side include of a resource.
1075: # if the ssi call returns an error we'll retry it up to
1076: # the number of times requested by the caller.
1077: # If we still have a proble, no text is appended to the
1078: # output and we set some global variables.
1079: # to indicate to the caller an SSI error occurred.
1080: # All of this is supposed to deal with the issues described
1081: # in LonCAPA BZ 5631 see:
1082: # http://bugs.lon-capa.org/show_bug.cgi?id=5631
1083: # by informing the user that this happened.
1084: #
1085: # Parameters:
1086: # resource - The resource to include. This is passed directly, without
1087: # interpretation to lonnet::ssi.
1088: # form - The form hash parameters that guide the interpretation of the resource
1089: #
1090: # retries - Number of retries allowed before giving up completely.
1091: # Returns:
1092: # On success, returns the rendered resource identified by the resource parameter.
1093: # Side Effects:
1094: # The following global variables can be set:
1095: # ssi_error - If an unrecoverable error occurred this becomes true.
1096: # It is up to the caller to initialize this to false
1097: # if desired.
1098: # ssi_last_error_resource - If an unrecoverable error occurred, this is the value
1099: # of the resource that could not be rendered by the ssi
1100: # call.
1101: # ssi_last_error - The error string fetched from the ssi response
1102: # in the event of an error.
1103: #
1104: sub ssi_with_retries {
1105: my ($resource, $retries, %form) = @_;
1106:
1107: my $target = $form{'grade_target'};
1108: my $aom = $form{'answer_output_mode'};
1109:
1110:
1111:
1112: my ($content, $response) = &Apache::loncommon::ssi_with_retries($resource, $retries, %form);
1113: if (!$response->is_success) {
1114: $ssi_error = 1;
1115: $ssi_last_error_resource = $resource;
1116: $ssi_last_error = $response->code . " " . $response->message;
1117: $content='\section*{!!! An error occurred !!!}';
1118: }
1119:
1120: return $content;
1121:
1122: }
1123:
1124: sub get_student_view_with_retries {
1125: my ($curresline,$retries,$username,$userdomain,$courseid,$target,$moreenv)=@_;
1126:
1127: my ($content, $response) = &Apache::loncommon::get_student_view_with_retries($curresline,$retries,$username,$userdomain,$courseid,$target,$moreenv);
1128: if (!$response->is_success) {
1129: $ssi_error = 1;
1130: $ssi_last_error_resource = $curresline.' for user '.$username.':'.$userdomain;
1131: $ssi_last_error = $response->code . " " . $response->message;
1132: $content='\section*{!!! An error occurred !!!}';
1133: }
1134: return $content;
1135:
1136: }
1137:
1138: #
1139: # printf_style_subst item format_string repl
1140: #
1141: # Does printf style substitution for a format string that
1142: # can have %[n]item in it.. wherever, %[n]item occurs,
1143: # rep is substituted in format_string. Note that
1144: # [n] is an optional integer length. If provided,
1145: # repl is truncated to at most [n] characters prior to
1146: # substitution.
1147: #
1148: sub printf_style_subst {
1149: my ($item, $format_string, $repl) = @_;
1150: my $result = "";
1151: while ($format_string =~ /(%)(\d*)\Q$item\E/g ) {
1152: my $fmt = $1;
1153: my $size = $2;
1154: my $subst = $repl;
1155: if ($size ne "") {
1156: $subst = substr($subst, 0, $size);
1157:
1158: # Here's a nice edge case ... suppose the end of the
1159: # substring is a \. In that case may have just
1160: # chopped off a TeX escape... in that case, we append
1161: # " " for the trailing character, and let the field
1162: # spill over a bit (sigh).
1163: # We don't just chop off the last character in order to deal
1164: # with one last pathology, and that would be if substr had
1165: # trimmed us to e.g. \\\
1166:
1167:
1168: if ($subst =~ /\\$/) {
1169: $subst .= " ";
1170: }
1171: }
1172: my $item_pos = pos($format_string);
1173: $result .= substr($format_string, 0, $item_pos - length($size) -2) . $subst;
1174: $format_string = substr($format_string, pos($format_string));
1175: }
1176:
1177: # Put the residual format string into the result:
1178:
1179: $result .= $format_string;
1180:
1181: return $result;
1182: }
1183:
1184:
1185: # Format a header according to a format.
1186: #
1187:
1188: # Substitutions:
1189: # %a - Assignment name.
1190: # %c - Course name.
1191: # %n - Student name.
1192: # %s - The section if it is supplied.
1193: #
1194: sub format_page_header {
1195: my ($width, $format, $assignment, $course, $student, $section) = @_;
1196:
1197:
1198:
1199: $width = &recalcto_mm($width); # Get width in mm.
1200: my $chars_per_line = int($width/1.6); # Character/textline.
1201:
1202: # Default format?
1203:
1204: if ($format eq '') {
1205: # For the default format, we may need to truncate
1206: # elements.. To do this we need to get the page width.
1207: # we assume that each character is about 2mm in width.
1208: # (correct for the header text size??). We ignore
1209: # any formatting (e.g. boldfacing in this).
1210: #
1211: # - Allow the student/course to be one line.
1212: # but only truncate the course.
1213: # - Allow the assignment to be 2 lines (wrapped).
1214: #
1215:
1216:
1217:
1218: my $name_length = int($chars_per_line *3 /4);
1219: my $sec_length = int($chars_per_line / 5);
1220:
1221: $format = "%$name_length".'n';
1222:
1223: if ($section) {
1224: $format .= ' - Sec: '."%$sec_length".'s';
1225: }
1226:
1227: $format .= '\\\\%c \\\\ %a';
1228:
1229:
1230: }
1231: # An open question is how to handle long user formatted page headers...
1232: # A possible future is to support e.g. %na so that the user can control
1233: # the truncation of the elements that can appear in the header.
1234: #
1235: $format = &printf_style_subst("a", $format, $assignment);
1236: $format = &printf_style_subst("c", $format, $course);
1237: $format = &printf_style_subst("n", $format, $student);
1238: $format = &printf_style_subst("s", $format, $section);
1239:
1240:
1241: # If the user put %'s in the format string, they must be escaped
1242: # to \% else LaTeX will think they are comments and terminate
1243: # the line.. which is bad!!!
1244:
1245: # If the user has role author, $course and $assignment are empty so
1246: # there is '\\ \\ ' in the page header. That's cause a error in LaTeX
1247: if($format =~ /\\\\\s\\\\\s/) {
1248: #TODO find sensible caption for page header
1249: my $testPrintout = '\\\\'.&mt('Authoring Space').' \\\\'.&mt('Test-Printout ');
1250: $format =~ s/\\\\\s\\\\\s/$testPrintout/;
1251: }
1252: #
1253: # We're going to trust LaTeX to break lines appropriately, but
1254: # we'll truncate anything that's more than 3 lines worth of
1255: # text. This is also assuming (which will probably end badly)
1256: # nobody's going to embed LaTeX control sequences in the title
1257: # header or rather that those control sequences won't get broken
1258: # by the stuff below.
1259: #
1260: my $total_length = 3*$chars_per_line;
1261: if (length($format) > $total_length) {
1262: $format = substr($format, 0, $total_length);
1263: }
1264:
1265:
1266: return $format;
1267:
1268: }
1269:
1270: #
1271: # Convert a numeric code to letters
1272: #
1273: sub num_to_letters {
1274: my ($num) = @_;
1275: my @nums= split('',$num);
1276: my @num_to_let=('A'..'Z');
1277: my $word;
1278: foreach my $digit (@nums) { $word.=$num_to_let[$digit]; }
1279: return $word;
1280: }
1281: # Convert a letter code to numeric.
1282: #
1283: sub letters_to_num {
1284: my ($letters) = @_;
1285: my @letters = split('', uc($letters));
1286: my %substitution;
1287: my $digit = 0;
1288: foreach my $letter ('A'..'J') {
1289: $substitution{$letter} = $digit;
1290: $digit++;
1291: }
1292: # The substitution is done as below to preserve leading
1293: # zeroes which are needed to keep the code size exact
1294: #
1295: my $result ="";
1296: foreach my $letter (@letters) {
1297: $result.=$substitution{$letter};
1298: }
1299: return $result;
1300: }
1301:
1302: # Determine if a code is a valid numeric code. Valid
1303: # numeric codes must be comprised entirely of digits and
1304: # have a correct number of digits.
1305: #
1306: # Parameters:
1307: # value - proposed code value.
1308: # num_digits - Number of digits required.
1309: #
1310: sub is_valid_numeric_code {
1311: my ($value, $num_digits) = @_;
1312: # Remove leading/trailing whitespace;
1313: $value =~ s/^\s*//g;
1314: $value =~ s/\s*$//g;
1315:
1316: # All digits?
1317: if ($value !~ /^[0-9]+$/) {
1318: return "Numeric code $value has invalid characters - must only be digits";
1319: }
1320: if (length($value) != $num_digits) {
1321: return "Numeric code $value incorrect number of digits (correct = $num_digits)";
1322: }
1323: return undef;
1324: }
1325: # Determines if a code is a valid alhpa code. Alpha codes
1326: # are ciphers that map [A-J,a-j] -> 0..9 0..9.
1327: # They also have a correct digit count.
1328: # Parameters:
1329: # value - Proposed code value.
1330: # num_letters - correct number of letters.
1331: # Note:
1332: # leading and trailing whitespace are ignored.
1333: #
1334: sub is_valid_alpha_code {
1335: my ($value, $num_letters) = @_;
1336:
1337: # strip leading and trailing spaces.
1338:
1339: $value =~ s/^\s*//g;
1340: $value =~ s/\s*$//g;
1341:
1342: # All alphas in the right range?
1343: if ($value !~ /^[A-J,a-j]+$/) {
1344: return "Invalid letter code $value must only contain A-J";
1345: }
1346: if (length($value) != $num_letters) {
1347: return "Letter code $value has incorrect number of letters (correct = $num_letters)";
1348: }
1349: return undef;
1350: }
1351:
1352: # Determine if a code entered by the user in a helper is valid.
1353: # valid depends on the code type and the type of code selected.
1354: # The type of code selected can either be numeric or
1355: # Alphabetic. If alphabetic, the code, in fact is a simple
1356: # substitution cipher for the actual numeric code: 0->A, 1->B ...
1357: # We'll be nice and be case insensitive for alpha codes.
1358: # Parameters:
1359: # code_value - the value of the code the user typed in.
1360: # code_option - The code type selected from the set in the scantron format
1361: # table.
1362: # Returns:
1363: # undef - The code is valid.
1364: # other - An error message indicating what's wrong.
1365: #
1366: sub is_code_valid {
1367: my ($code_value, $code_option) = @_;
1368: my ($code_type, $code_length) = ('letter', 6); # defaults.
1369: my @lines = &Apache::lonnet::get_scantronformat_file();
1370: foreach my $line (@lines) {
1371: next if (($line =~ /^\#/) || ($line eq ''));
1372: my ($name, $type, $length) = (split(/:/, $line))[0,2,4];
1373: if($name eq $code_option) {
1374: $code_length = $length;
1375: if($type eq 'number') {
1376: $code_type = 'number';
1377: }
1378: }
1379: }
1380: my $valid;
1381: if ($code_type eq 'number') {
1382: return &is_valid_numeric_code($code_value, $code_length);
1383: } else {
1384: return &is_valid_alpha_code($code_value, $code_length);
1385: }
1386:
1387: }
1388: #
1389: # Compare two students by section (Used to sort by section).
1390: #
1391: # Implicit inputs,
1392: # $a - The first one
1393: # $b - The second one.
1394: #
1395: # Returns:
1396: # a-section cmp b-section
1397: #
1398: sub compare_sections {
1399: my ($u1, $d1, $s1, $n1, $stat1) = split(/:/, $a);
1400: my ($u2, $d2, $s2, $n2, $stat2) = split(/:/, $b);
1401:
1402: return $s1 cmp $s2;
1403: }
1404:
1405: # Compare two students by name. The students are in the form
1406: # returned by the helper:
1407: # user:domain:section:last, first:status
1408: # This is a helper function for the perl sort built-in therefore:
1409: # Implicit Inputs:
1410: # $a - The first element to compare (global)
1411: # $b - The second element to compare (global)
1412: # Returns:
1413: # -1 - $a < $b
1414: # 0 - $a == $b
1415: # +1 - $a > $b
1416: # Note that the initial comparison is done on the last names with the
1417: # first names only used to break the tie.
1418: #
1419: #
1420: sub compare_names {
1421: # First split the names up into the primary fields.
1422:
1423: my ($u1, $d1, $s1, $n1, $stat1) = split(/:/, $a);
1424: my ($u2, $d2, $s2, $n2, $stat2) = split(/:/, $b);
1425:
1426: # Now split the last name and first name of each n:
1427: #
1428:
1429: my ($l1,$f1) = split(/,/, $n1);
1430: my ($l2,$f2) = split(/,/, $n2);
1431:
1432: # We don't bother to remove the leading/trailing whitespace from the
1433: # firstname, unless the last names compare identical.
1434:
1435: if($l1 lt $l2) {
1436: return -1;
1437: }
1438: if($l1 gt $l2) {
1439: return 1;
1440: }
1441:
1442: # Break the tie on the first name, but there are leading (possibly trailing
1443: # whitespaces to get rid of first)
1444: #
1445: $f1 =~ s/^\s+//; # Remove leading...
1446: $f1 =~ s/\s+$//; # Trailing spaces from first 1...
1447:
1448: $f2 =~ s/^\s+//;
1449: $f2 =~ s/\s+$//; # And the same for first 2...
1450:
1451: if($f1 lt $f2) {
1452: return -1;
1453: }
1454: if($f1 gt $f2) {
1455: return 1;
1456: }
1457:
1458: # Must be the same name.
1459:
1460: return 0;
1461: }
1462:
1463: sub latex_header_footer_remove {
1464: my $text = shift;
1465: $text =~ s/\\end\{document}//;
1466: $text =~ s/\\documentclass([^&]*)\\begin\{document}//;
1467: return $text;
1468: }
1469: #
1470: # If necessary, encapsulate text inside
1471: # a minipage env.
1472: # necessity is determined by the problem_split param.
1473: #
1474: sub encapsulate_minipage {
1475: my ($text,$problem_split) = @_;
1476: if (!($problem_split =~ /yes/i)) {
1477: $text = '\begin{minipage}{\textwidth}'.$text.'\end{minipage}';
1478: }
1479: return $text;
1480: }
1481: #
1482: # The NUMBER_TO_PRINT and SPLIT_PDFS
1483: # variables interact, this sub looks at these two parameters
1484: # and comes up with a final value for NUMBER_TO_PRINT which can be:
1485: # all - if SPLIT_PDFS eq 'all'.
1486: # 1 - if SPLIT_PDFS eq 'oneper'
1487: # section - if SPLIT_PDFS eq 'sections'
1488: # <unchanged> - if SPLIT_PDFS eq 'usenumber'
1489: #
1490: sub adjust_number_to_print {
1491: my $helper = shift;
1492:
1493: my $split_pdf = $helper->{'VARS'}->{'SPLIT_PDFS'};
1494:
1495: if ($split_pdf eq 'all') {
1496: $helper->{'VARS'}->{'NUMBER_TO_PRINT'} = 'all';
1497: } elsif ($split_pdf eq 'oneper') {
1498: $helper->{'VARS'}->{'NUMBER_TO_PRINT'} = 1;
1499: } elsif ($split_pdf eq 'sections') {
1500: $helper->{'VARS'}->{'NUMBER_TO_PRINT'} = 'section';
1501: } elsif ($split_pdf eq 'usenumber') {
1502: # Unmodified.
1503: } else {
1504: # Error!!!!
1505:
1506: croak "bad SPLIT_PDFS: $split_pdf in lonprintout::adjust_number_to_print";
1507:
1508: }
1509: }
1510:
1511:
1512: sub character_chart {
1513: my $result = shift;
1514: return &Apache::entities::replace_entities($result);
1515: }
1516:
1517: sub old_character_chart {
1518: my $result = shift;
1519: $result =~ s/&\#0?0?(7|9);//g;
1520: $result =~ s/&\#0?(10|13);//g;
1521: $result =~ s/&\#0?32;/ /g;
1522: $result =~ s/&\#0?33;/!/g;
1523: $result =~ s/&(\#0?34|quot);/\"/g;
1524: $result =~ s/&\#0?35;/\\\#/g;
1525: $result =~ s/&\#0?36;/\\\$/g;
1526: $result =~ s/&\#0?37;/\\%/g;
1527: $result =~ s/&(\#0?38|amp);/\\&/g;
1528: $result =~ s/&\#(0?39|146);/\'/g;
1529: $result =~ s/&\#0?40;/(/g;
1530: $result =~ s/&\#0?41;/)/g;
1531: $result =~ s/&\#0?42;/\*/g;
1532: $result =~ s/&\#0?43;/\+/g;
1533: $result =~ s/&\#(0?44|130);/,/g;
1534: $result =~ s/&\#0?45;/-/g;
1535: $result =~ s/&\#0?46;/\./g;
1536: $result =~ s/&\#0?47;/\//g;
1537: $result =~ s/&\#0?48;/0/g;
1538: $result =~ s/&\#0?49;/1/g;
1539: $result =~ s/&\#0?50;/2/g;
1540: $result =~ s/&\#0?51;/3/g;
1541: $result =~ s/&\#0?52;/4/g;
1542: $result =~ s/&\#0?53;/5/g;
1543: $result =~ s/&\#0?54;/6/g;
1544: $result =~ s/&\#0?55;/7/g;
1545: $result =~ s/&\#0?56;/8/g;
1546: $result =~ s/&\#0?57;/9/g;
1547: $result =~ s/&\#0?58;/:/g;
1548: $result =~ s/&\#0?59;/;/g;
1549: $result =~ s/&(\#0?60|lt|\#139);/\$<\$/g;
1550: $result =~ s/&\#0?61;/\\ensuremath\{=\}/g;
1551: $result =~ s/&(\#0?62|gt|\#155);/\\ensuremath\{>\}/g;
1552: $result =~ s/&\#0?63;/\?/g;
1553: $result =~ s/&\#0?65;/A/g;
1554: $result =~ s/&\#0?66;/B/g;
1555: $result =~ s/&\#0?67;/C/g;
1556: $result =~ s/&\#0?68;/D/g;
1557: $result =~ s/&\#0?69;/E/g;
1558: $result =~ s/&\#0?70;/F/g;
1559: $result =~ s/&\#0?71;/G/g;
1560: $result =~ s/&\#0?72;/H/g;
1561: $result =~ s/&\#0?73;/I/g;
1562: $result =~ s/&\#0?74;/J/g;
1563: $result =~ s/&\#0?75;/K/g;
1564: $result =~ s/&\#0?76;/L/g;
1565: $result =~ s/&\#0?77;/M/g;
1566: $result =~ s/&\#0?78;/N/g;
1567: $result =~ s/&\#0?79;/O/g;
1568: $result =~ s/&\#0?80;/P/g;
1569: $result =~ s/&\#0?81;/Q/g;
1570: $result =~ s/&\#0?82;/R/g;
1571: $result =~ s/&\#0?83;/S/g;
1572: $result =~ s/&\#0?84;/T/g;
1573: $result =~ s/&\#0?85;/U/g;
1574: $result =~ s/&\#0?86;/V/g;
1575: $result =~ s/&\#0?87;/W/g;
1576: $result =~ s/&\#0?88;/X/g;
1577: $result =~ s/&\#0?89;/Y/g;
1578: $result =~ s/&\#0?90;/Z/g;
1579: $result =~ s/&\#0?91;/[/g;
1580: $result =~ s/&\#0?92;/\\ensuremath\{\\setminus\}/g;
1581: $result =~ s/&\#0?93;/]/g;
1582: $result =~ s/&\#(0?94|136);/\\ensuremath\{\\wedge\}/g;
1583: $result =~ s/&\#(0?95|138|154);/\\underline{\\makebox[2mm]{\\strut}}/g;
1584: $result =~ s/&\#(0?96|145);/\`/g;
1585: $result =~ s/&\#0?97;/a/g;
1586: $result =~ s/&\#0?98;/b/g;
1587: $result =~ s/&\#0?99;/c/g;
1588: $result =~ s/&\#100;/d/g;
1589: $result =~ s/&\#101;/e/g;
1590: $result =~ s/&\#102;/f/g;
1591: $result =~ s/&\#103;/g/g;
1592: $result =~ s/&\#104;/h/g;
1593: $result =~ s/&\#105;/i/g;
1594: $result =~ s/&\#106;/j/g;
1595: $result =~ s/&\#107;/k/g;
1596: $result =~ s/&\#108;/l/g;
1597: $result =~ s/&\#109;/m/g;
1598: $result =~ s/&\#110;/n/g;
1599: $result =~ s/&\#111;/o/g;
1600: $result =~ s/&\#112;/p/g;
1601: $result =~ s/&\#113;/q/g;
1602: $result =~ s/&\#114;/r/g;
1603: $result =~ s/&\#115;/s/g;
1604: $result =~ s/&\#116;/t/g;
1605: $result =~ s/&\#117;/u/g;
1606: $result =~ s/&\#118;/v/g;
1607: $result =~ s/&\#119;/w/g;
1608: $result =~ s/&\#120;/x/g;
1609: $result =~ s/&\#121;/y/g;
1610: $result =~ s/&\#122;/z/g;
1611: $result =~ s/&\#123;/\\{/g;
1612: $result =~ s/&\#124;/\|/g;
1613: $result =~ s/&\#125;/\\}/g;
1614: $result =~ s/&\#126;/\~/g;
1615: $result =~ s/&\#131;/\\textflorin /g;
1616: $result =~ s/&\#132;/\"/g;
1617: $result =~ s/&\#133;/\\ensuremath\{\\ldots\}/g;
1618: $result =~ s/&\#134;/\\ensuremath\{\\dagger\}/g;
1619: $result =~ s/&\#135;/\\ensuremath\{\\ddagger\}/g;
1620: $result =~ s/&\#137;/\\textperthousand /g;
1621: $result =~ s/&\#140;/{\\OE}/g;
1622: $result =~ s/&\#147;/\`\`/g;
1623: $result =~ s/&\#148;/\'\'/g;
1624: $result =~ s/&\#149;/\\ensuremath\{\\bullet\}/g;
1625: $result =~ s/&(\#150|\#8211);/--/g;
1626: $result =~ s/&\#151;/---/g;
1627: $result =~ s/&\#152;/\\ensuremath\{\\sim\}/g;
1628: $result =~ s/&\#153;/\\texttrademark /g;
1629: $result =~ s/&\#156;/\\oe/g;
1630: $result =~ s/&\#159;/\\\"Y/g;
1631: $result =~ s/&(\#160|nbsp);/~/g;
1632: $result =~ s/&(\#161|iexcl);/!\`/g;
1633: $result =~ s/&(\#162|cent);/\\textcent /g;
1634: $result =~ s/&(\#163|pound);/\\pounds /g;
1635: $result =~ s/&(\#164|curren);/\\textcurrency /g;
1636: $result =~ s/&(\#165|yen);/\\textyen /g;
1637: $result =~ s/&(\#166|brvbar);/\\textbrokenbar /g;
1638: $result =~ s/&(\#167|sect);/\\textsection /g;
1639: $result =~ s/&(\#168|uml);/\\"\{\} /g;
1640: $result =~ s/&(\#169|copy);/\\copyright /g;
1641: $result =~ s/&(\#170|ordf);/\\textordfeminine /g;
1642: $result =~ s/&(\#172|not);/\\ensuremath\{\\neg\}/g;
1643: $result =~ s/&(\#173|shy);/ - /g;
1644: $result =~ s/&(\#174|reg);/\\textregistered /g;
1645: $result =~ s/&(\#175|macr);/\\ensuremath\{^{-}\}/g;
1646: $result =~ s/&(\#176|deg);/\\ensuremath\{^{\\circ}\}/g;
1647: $result =~ s/&(\#177|plusmn);/\\ensuremath\{\\pm\}/g;
1648: $result =~ s/&(\#178|sup2);/\\ensuremath\{^2\}/g;
1649: $result =~ s/&(\#179|sup3);/\\ensuremath\{^3\}/g;
1650: $result =~ s/&(\#180|acute);/\\'\{\} /g;
1651: $result =~ s/&(\#181|micro);/\\ensuremath\{\\mu\}/g;
1652: $result =~ s/&(\#182|para);/\\P/g;
1653: $result =~ s/&(\#183|middot);/\\ensuremath\{\\cdot\}/g;
1654: $result =~ s/&(\#184|cedil);/\\c{\\strut}/g;
1655: $result =~ s/&(\#185|sup1);/\\ensuremath\{^1\}/g;
1656: $result =~ s/&(\#186|ordm);/\\textordmasculine /g;
1657: $result =~ s/&(\#188|frac14);/\\textonequarter /g;
1658: $result =~ s/&(\#189|frac12);/\\textonehalf /g;
1659: $result =~ s/&(\#190|frac34);/\\textthreequarters /g;
1660: $result =~ s/&(\#191|iquest);/?\`/g;
1661: $result =~ s/&(\#192|Agrave);/\\\`{A}/g;
1662: $result =~ s/&(\#193|Aacute);/\\\'{A}/g;
1663: $result =~ s/&(\#194|Acirc);/\\^{A}/g;
1664: $result =~ s/&(\#195|Atilde);/\\~{A}/g;
1665: $result =~ s/&(\#196|Auml);/\\\"{A}/g;
1666: $result =~ s/&(\#197|Aring);/{\\AA}/g;
1667: $result =~ s/&(\#198|AElig);/{\\AE}/g;
1668: $result =~ s/&(\#199|Ccedil);/\\c{c}/g;
1669: $result =~ s/&(\#200|Egrave);/\\\`{E}/g;
1670: $result =~ s/&(\#201|Eacute);/\\\'{E}/g;
1671: $result =~ s/&(\#202|Ecirc);/\\^{E}/g;
1672: $result =~ s/&(\#203|Euml);/\\\"{E}/g;
1673: $result =~ s/&(\#204|Igrave);/\\\`{I}/g;
1674: $result =~ s/&(\#205|Iacute);/\\\'{I}/g;
1675: $result =~ s/&(\#206|Icirc);/\\^{I}/g;
1676: $result =~ s/&(\#207|Iuml);/\\\"{I}/g;
1677: $result =~ s/&(\#209|Ntilde);/\\~{N}/g;
1678: $result =~ s/&(\#210|Ograve);/\\\`{O}/g;
1679: $result =~ s/&(\#211|Oacute);/\\\'{O}/g;
1680: $result =~ s/&(\#212|Ocirc);/\\^{O}/g;
1681: $result =~ s/&(\#213|Otilde);/\\~{O}/g;
1682: $result =~ s/&(\#214|Ouml);/\\\"{O}/g;
1683: $result =~ s/&(\#215|times);/\\ensuremath\{\\times\}/g;
1684: $result =~ s/&(\#216|Oslash);/{\\O}/g;
1685: $result =~ s/&(\#217|Ugrave);/\\\`{U}/g;
1686: $result =~ s/&(\#218|Uacute);/\\\'{U}/g;
1687: $result =~ s/&(\#219|Ucirc);/\\^{U}/g;
1688: $result =~ s/&(\#220|Uuml);/\\\"{U}/g;
1689: $result =~ s/&(\#221|Yacute);/\\\'{Y}/g;
1690: $result =~ s/&(\#223|szlig);/{\\ss}/g;
1691: $result =~ s/&(\#224|agrave);/\\\`{a}/g;
1692: $result =~ s/&(\#225|aacute);/\\\'{a}/g;
1693: $result =~ s/&(\#226|acirc);/\\^{a}/g;
1694: $result =~ s/&(\#227|atilde);/\\~{a}/g;
1695: $result =~ s/&(\#228|auml);/\\\"{a}/g;
1696: $result =~ s/&(\#229|aring);/{\\aa}/g;
1697: $result =~ s/&(\#230|aelig);/{\\ae}/g;
1698: $result =~ s/&(\#231|ccedil);/\\c{c}/g;
1699: $result =~ s/&(\#232|egrave);/\\\`{e}/g;
1700: $result =~ s/&(\#233|eacute);/\\\'{e}/g;
1701: $result =~ s/&(\#234|ecirc);/\\^{e}/g;
1702: $result =~ s/&(\#235|euml);/\\\"{e}/g;
1703: $result =~ s/&(\#236|igrave);/\\\`{i}/g;
1704: $result =~ s/&(\#237|iacute);/\\\'{i}/g;
1705: $result =~ s/&(\#238|icirc);/\\^{i}/g;
1706: $result =~ s/&(\#239|iuml);/\\\"{i}/g;
1707: $result =~ s/&(\#240|eth);/\\ensuremath\{\\partial\}/g;
1708: $result =~ s/&(\#241|ntilde);/\\~{n}/g;
1709: $result =~ s/&(\#242|ograve);/\\\`{o}/g;
1710: $result =~ s/&(\#243|oacute);/\\\'{o}/g;
1711: $result =~ s/&(\#244|ocirc);/\\^{o}/g;
1712: $result =~ s/&(\#245|otilde);/\\~{o}/g;
1713: $result =~ s/&(\#246|ouml);/\\\"{o}/g;
1714: $result =~ s/&(\#247|divide);/\\ensuremath\{\\div\}/g;
1715: $result =~ s/&(\#248|oslash);/{\\o}/g;
1716: $result =~ s/&(\#249|ugrave);/\\\`{u}/g;
1717: $result =~ s/&(\#250|uacute);/\\\'{u}/g;
1718: $result =~ s/&(\#251|ucirc);/\\^{u}/g;
1719: $result =~ s/&(\#252|uuml);/\\\"{u}/g;
1720: $result =~ s/&(\#253|yacute);/\\\'{y}/g;
1721: $result =~ s/&(\#255|yuml);/\\\"{y}/g;
1722: $result =~ s/&\#295;/\\ensuremath\{\\hbar\}/g;
1723: $result =~ s/&\#952;/\\ensuremath\{\\theta\}/g;
1724: #Greek Alphabet
1725: $result =~ s/&(alpha|\#945);/\\ensuremath\{\\alpha\}/g;
1726: $result =~ s/&(beta|\#946);/\\ensuremath\{\\beta\}/g;
1727: $result =~ s/&(gamma|\#947);/\\ensuremath\{\\gamma\}/g;
1728: $result =~ s/&(delta|\#948);/\\ensuremath\{\\delta\}/g;
1729: $result =~ s/&(epsilon|\#949);/\\ensuremath\{\\epsilon\}/g;
1730: $result =~ s/&(zeta|\#950);/\\ensuremath\{\\zeta\}/g;
1731: $result =~ s/&(eta|\#951);/\\ensuremath\{\\eta\}/g;
1732: $result =~ s/&(theta|\#952);/\\ensuremath\{\\theta\}/g;
1733: $result =~ s/&(iota|\#953);/\\ensuremath\{\\iota\}/g;
1734: $result =~ s/&(kappa|\#954);/\\ensuremath\{\\kappa\}/g;
1735: $result =~ s/&(lambda|\#955);/\\ensuremath\{\\lambda\}/g;
1736: $result =~ s/&(mu|\#956);/\\ensuremath\{\\mu\}/g;
1737: $result =~ s/&(nu|\#957);/\\ensuremath\{\\nu\}/g;
1738: $result =~ s/&(xi|\#958);/\\ensuremath\{\\xi\}/g;
1739: $result =~ s/&(omicron|\#959);/o/g;
1740: $result =~ s/&(pi|\#960);/\\ensuremath\{\\pi\}/g;
1741: $result =~ s/&(rho|\#961);/\\ensuremath\{\\rho\}/g;
1742: $result =~ s/&(sigma|\#963);/\\ensuremath\{\\sigma\}/g;
1743: $result =~ s/&(tau|\#964);/\\ensuremath\{\\tau\}/g;
1744: $result =~ s/&(upsilon|\#965);/\\ensuremath\{\\upsilon\}/g;
1745: $result =~ s/&(phi|\#966);/\\ensuremath\{\\phi\}/g;
1746: $result =~ s/&(chi|\#967);/\\ensuremath\{\\chi\}/g;
1747: $result =~ s/&(psi|\#968);/\\ensuremath\{\\psi\}/g;
1748: $result =~ s/&(omega|\#969);/\\ensuremath\{\\omega\}/g;
1749: $result =~ s/&(thetasym|\#977);/\\ensuremath\{\\vartheta\}/g;
1750: $result =~ s/&(piv|\#982);/\\ensuremath\{\\varpi\}/g;
1751: $result =~ s/&(Alpha|\#913);/A/g;
1752: $result =~ s/&(Beta|\#914);/B/g;
1753: $result =~ s/&(Gamma|\#915);/\\ensuremath\{\\Gamma\}/g;
1754: $result =~ s/&(Delta|\#916);/\\ensuremath\{\\Delta\}/g;
1755: $result =~ s/&(Epsilon|\#917);/E/g;
1756: $result =~ s/&(Zeta|\#918);/Z/g;
1757: $result =~ s/&(Eta|\#919);/H/g;
1758: $result =~ s/&(Theta|\#920);/\\ensuremath\{\\Theta\}/g;
1759: $result =~ s/&(Iota|\#921);/I/g;
1760: $result =~ s/&(Kappa|\#922);/K/g;
1761: $result =~ s/&(Lambda|\#923);/\\ensuremath\{\\Lambda\}/g;
1762: $result =~ s/&(Mu|\#924);/M/g;
1763: $result =~ s/&(Nu|\#925);/N/g;
1764: $result =~ s/&(Xi|\#926);/\\ensuremath\{\\Xi\}/g;
1765: $result =~ s/&(Omicron|\#927);/O/g;
1766: $result =~ s/&(Pi|\#928);/\\ensuremath\{\\Pi\}/g;
1767: $result =~ s/&(Rho|\#929);/P/g;
1768: $result =~ s/&(Sigma|\#931);/\\ensuremath\{\\Sigma\}/g;
1769: $result =~ s/&(Tau|\#932);/T/g;
1770: $result =~ s/&(Upsilon|\#933);/\\ensuremath\{\\Upsilon\}/g;
1771: $result =~ s/&(Phi|\#934);/\\ensuremath\{\\Phi\}/g;
1772: $result =~ s/&(Chi|\#935);/X/g;
1773: $result =~ s/&(Psi|\#936);/\\ensuremath\{\\Psi\}/g;
1774: $result =~ s/&(Omega|\#937);/\\ensuremath\{\\Omega\}/g;
1775: #Arrows (extended HTML 4.01)
1776: $result =~ s/&(larr|\#8592);/\\ensuremath\{\\leftarrow\}/g;
1777: $result =~ s/&(uarr|\#8593);/\\ensuremath\{\\uparrow\}/g;
1778: $result =~ s/&(rarr|\#8594);/\\ensuremath\{\\rightarrow\}/g;
1779: $result =~ s/&(darr|\#8595);/\\ensuremath\{\\downarrow\}/g;
1780: $result =~ s/&(harr|\#8596);/\\ensuremath\{\\leftrightarrow\}/g;
1781: $result =~ s/&(lArr|\#8656);/\\ensuremath\{\\Leftarrow\}/g;
1782: $result =~ s/&(uArr|\#8657);/\\ensuremath\{\\Uparrow\}/g;
1783: $result =~ s/&(rArr|\#8658);/\\ensuremath\{\\Rightarrow\}/g;
1784: $result =~ s/&(dArr|\#8659);/\\ensuremath\{\\Downarrow\}/g;
1785: $result =~ s/&(hArr|\#8660);/\\ensuremath\{\\Leftrightarrow\}/g;
1786: #Mathematical Operators (extended HTML 4.01)
1787: $result =~ s/&(forall|\#8704);/\\ensuremath\{\\forall\}/g;
1788: $result =~ s/&(part|\#8706);/\\ensuremath\{\\partial\}/g;
1789: $result =~ s/&(exist|\#8707);/\\ensuremath\{\\exists\}/g;
1790: $result =~ s/&(empty|\#8709);/\\ensuremath\{\\emptyset\}/g;
1791: $result =~ s/&(nabla|\#8711);/\\ensuremath\{\\nabla\}/g;
1792: $result =~ s/&(isin|\#8712);/\\ensuremath\{\\in\}/g;
1793: $result =~ s/&(notin|\#8713);/\\ensuremath\{\\notin\}/g;
1794: $result =~ s/&(ni|\#8715);/\\ensuremath\{\\ni\}/g;
1795: $result =~ s/&(prod|\#8719);/\\ensuremath\{\\prod\}/g;
1796: $result =~ s/&(sum|\#8721);/\\ensuremath\{\\sum\}/g;
1797: $result =~ s/&(minus|\#8722);/\\ensuremath\{-\}/g;
1798: $result =~ s/–/\\ensuremath\{-\}/g;
1799: $result =~ s/&(lowast|\#8727);/\\ensuremath\{*\}/g;
1800: $result =~ s/&(radic|\#8730);/\\ensuremath\{\\surd\}/g;
1801: $result =~ s/&(prop|\#8733);/\\ensuremath\{\\propto\}/g;
1802: $result =~ s/&(infin|\#8734);/\\ensuremath\{\\infty\}/g;
1803: $result =~ s/&(ang|\#8736);/\\ensuremath\{\\angle\}/g;
1804: $result =~ s/&(and|\#8743);/\\ensuremath\{\\wedge\}/g;
1805: $result =~ s/&(or|\#8744);/\\ensuremath\{\\vee\}/g;
1806: $result =~ s/&(cap|\#8745);/\\ensuremath\{\\cap\}/g;
1807: $result =~ s/&(cup|\#8746);/\\ensuremath\{\\cup\}/g;
1808: $result =~ s/&(int|\#8747);/\\ensuremath\{\\int\}/g;
1809: $result =~ s/&(sim|\#8764);/\\ensuremath\{\\sim\}/g;
1810: $result =~ s/&(cong|\#8773);/\\ensuremath\{\\cong\}/g;
1811: $result =~ s/&(asymp|\#8776);/\\ensuremath\{\\approx\}/g;
1812: $result =~ s/&(ne|\#8800);/\\ensuremath\{\\not=\}/g;
1813: $result =~ s/&(equiv|\#8801);/\\ensuremath\{\\equiv\}/g;
1814: $result =~ s/&(le|\#8804);/\\ensuremath\{\\leq\}/g;
1815: $result =~ s/&(ge|\#8805);/\\ensuremath\{\\geq\}/g;
1816: $result =~ s/&(sub|\#8834);/\\ensuremath\{\\subset\}/g;
1817: $result =~ s/&(sup|\#8835);/\\ensuremath\{\\supset\}/g;
1818: $result =~ s/&(nsub|\#8836);/\\ensuremath\{\\not\\subset\}/g;
1819: $result =~ s/&(sube|\#8838);/\\ensuremath\{\\subseteq\}/g;
1820: $result =~ s/&(supe|\#8839);/\\ensuremath\{\\supseteq\}/g;
1821: $result =~ s/&(oplus|\#8853);/\\ensuremath\{\\oplus\}/g;
1822: $result =~ s/&(otimes|\#8855);/\\ensuremath\{\\otimes\}/g;
1823: $result =~ s/&(perp|\#8869);/\\ensuremath\{\\perp\}/g;
1824: $result =~ s/&(sdot|\#8901);/\\ensuremath\{\\cdot\}/g;
1825: #Geometric Shapes (extended HTML 4.01)
1826: $result =~ s/&(loz|\#9674);/\\ensuremath\{\\Diamond\}/g;
1827: #Miscellaneous Symbols (extended HTML 4.01)
1828: $result =~ s/&(spades|\#9824);/\\ensuremath\{\\spadesuit\}/g;
1829: $result =~ s/&(clubs|\#9827);/\\ensuremath\{\\clubsuit\}/g;
1830: $result =~ s/&(hearts|\#9829);/\\ensuremath\{\\heartsuit\}/g;
1831: $result =~ s/&(diams|\#9830);/\\ensuremath\{\\diamondsuit\}/g;
1832: # Chemically useful 'things' contributed by Hon Kie (bug 4652).
1833:
1834: $result =~ s/&\#8636;/\\ensuremath\{\\leftharpoonup\}/g;
1835: $result =~ s/&\#8637;/\\ensuremath\{\\leftharpoondown\}/g;
1836: $result =~ s/&\#8640;/\\ensuremath\{\\rightharpoonup\}/g;
1837: $result =~ s/&\#8641;/\\ensuremath\{\\rightharpoondown\}/g;
1838: $result =~ s/&\#8652;/\\ensuremath\{\\rightleftharpoons\}/g;
1839: $result =~ s/&\#8605;/\\ensuremath\{\\leadsto\}/g;
1840: $result =~ s/&\#8617;/\\ensuremath\{\\hookleftarrow\}/g;
1841: $result =~ s/&\#8618;/\\ensuremath\{\\hookrightarrow\}/g;
1842: $result =~ s/&\#8614;/\\ensuremath\{\\mapsto\}/g;
1843: $result =~ s/&\#8599;/\\ensuremath\{\\nearrow\}/g;
1844: $result =~ s/&\#8600;/\\ensuremath\{\\searrow\}/g;
1845: $result =~ s/&\#8601;/\\ensuremath\{\\swarrow\}/g;
1846: $result =~ s/&\#8598;/\\ensuremath\{\\nwarrow\}/g;
1847:
1848: # Left/right quotations:
1849:
1850: $result =~ s/&(ldquo|#8220);/\`\`/g;
1851: $result =~ s/&(rdquo|#8221);/\'\'/g;
1852:
1853:
1854:
1855: return $result;
1856: }
1857:
1858:
1859: #width, height, oddsidemargin, evensidemargin, topmargin
1860: my %page_formats=
1861: ('letter' => {
1862: 'book' => {
1863: '1' => [ '7.1 in','9.8 in', '-0.57 in','-0.57 in','0.275 in'],
1864: '2' => ['3.66 in','9.8 in', '-0.57 in','-0.57 in','0.275 in']
1865: },
1866: 'album' => {
1867: '1' => [ '8.8 in', '6.8 in','-0.55 in', '-0.55 in','0.394 in'],
1868: '2' => [ '4.8 in', '6.8 in','-0.5 in', '-1.0 in','3.5 in']
1869: },
1870: },
1871: 'legal' => {
1872: 'book' => {
1873: '1' => ['7.1 in','13 in',,'-0.57 in','-0.57 in','-0.5 in'],
1874: '2' => ['3.66 in','13 in','-0.57 in','-0.57 in','-0.5 in']
1875: },
1876: 'album' => {
1877: '1' => ['12 in','7.1 in',,'-0.57 in','-0.57 in','-0.5 in'],
1878: '2' => ['6.0 in','7.1 in','-1 in','-1 in','5 in']
1879: },
1880: },
1881: 'tabloid' => {
1882: 'book' => {
1883: '1' => ['9.8 in','16 in','-0.57 in','-0.57 in','-0.5 in'],
1884: '2' => ['4.9 in','16 in','-0.57 in','-0.57 in','-0.5 in']
1885: },
1886: 'album' => {
1887: '1' => ['16 in','9.8 in','-0.57 in','-0.57 in','-0.5 in'],
1888: '2' => ['16 in','4.9 in','-0.57 in','-0.57 in','-0.5 in']
1889: },
1890: },
1891: 'executive' => {
1892: 'book' => {
1893: '1' => ['6.8 in','9 in','-0.57 in','-0.57 in','1.2 in'],
1894: '2' => ['3.1 in','9 in','-0.57 in','-0.57 in','1.2 in']
1895: },
1896: 'album' => {
1897: '1' => [],
1898: '2' => []
1899: },
1900: },
1901: 'a2' => {
1902: 'book' => {
1903: '1' => [],
1904: '2' => []
1905: },
1906: 'album' => {
1907: '1' => [],
1908: '2' => []
1909: },
1910: },
1911: 'a3' => {
1912: 'book' => {
1913: '1' => [],
1914: '2' => []
1915: },
1916: 'album' => {
1917: '1' => [],
1918: '2' => []
1919: },
1920: },
1921: 'a4' => {
1922: 'book' => {
1923: '1' => ['17.6 cm','27.2 cm','-1.397 cm','-2.11 cm','-1.27 cm'],
1924: '2' => [ '9.1 cm','27.2 cm','-1.397 cm','-2.11 cm','-1.27 cm']
1925: },
1926: 'album' => {
1927: '1' => ['21.59 cm','19.558 cm','-1.397cm','-2.11 cm','0 cm'],
1928: '2' => ['9.91 cm','19.558 cm','-1.397 cm','-2.11 cm','0 cm']
1929: },
1930: },
1931: 'a5' => {
1932: 'book' => {
1933: '1' => [],
1934: '2' => []
1935: },
1936: 'album' => {
1937: '1' => [],
1938: '2' => []
1939: },
1940: },
1941: 'a6' => {
1942: 'book' => {
1943: '1' => [],
1944: '2' => []
1945: },
1946: 'album' => {
1947: '1' => [],
1948: '2' => []
1949: },
1950: },
1951: );
1952:
1953: sub page_format {
1954: #
1955: #Supported paper format: "Letter [8 1/2x11 in]", "Legal [8 1/2x14 in]",
1956: # "Ledger/Tabloid [11x17 in]", "Executive [7 1/2x10 in]",
1957: # "A2 [420x594 mm]", "A3 [297x420 mm]",
1958: # "A4 [210x297 mm]", "A5 [148x210 mm]",
1959: # "A6 [105x148 mm]"
1960: #
1961: my ($papersize,$layout,$numberofcolumns) = @_;
1962: return @{$page_formats{$papersize}->{$layout}->{$numberofcolumns}};
1963: }
1964:
1965:
1966: sub get_name {
1967: my ($uname,$udom)=@_;
1968: if (!defined($uname)) { $uname=$env{'user.name'}; }
1969: if (!defined($udom)) { $udom=$env{'user.domain'}; }
1970: my $plainname=&Apache::loncommon::plainname($uname,$udom);
1971: if ($plainname=~/^\s*$/) { $plainname=$uname.'@'.$udom; }
1972: $plainname=&Apache::lonxml::latex_special_symbols($plainname,'header');
1973: return $plainname;
1974: }
1975:
1976: sub get_course {
1977: my $courseidinfo;
1978: if (defined($env{'request.course.id'})) {
1979: $courseidinfo = &Apache::lonxml::latex_special_symbols(&unescape($env{'course.'.$env{'request.course.id'}.'.description'}),'header');
1980: my $sec = $env{'request.course.sec'};
1981:
1982: }
1983: return $courseidinfo;
1984: }
1985:
1986: sub page_format_transformation {
1987: my ($papersize,$layout,$numberofcolumns,$choice,$text,$assignment,$tableofcontents,$indexlist,$selectionmade) = @_;
1988: my ($textwidth,$textheight,$oddoffset,$evenoffset,$topmargin);
1989:
1990: if ($selectionmade eq '4') {
1991: if ($choice eq 'all_problems') {
1992: $assignment=&mt('Problems from the Whole Course');
1993: } else {
1994: $assignment=&mt('Resources from the Whole Course');
1995: }
1996: } else {
1997: $assignment=&Apache::lonxml::latex_special_symbols($assignment,'header');
1998: }
1999: ($textwidth,$textheight,$oddoffset,$evenoffset,$topmargin) = &page_format($papersize,$layout,$numberofcolumns,$topmargin);
2000:
2001:
2002: my $name = &get_name();
2003: my $courseidinfo = &get_course();
2004: my $header_text = $parmhash{'print_header_format'};
2005: $header_text = &format_page_header($textwidth, $header_text, $assignment,
2006: $courseidinfo, $name);
2007: my $topmargintoinsert = '';
2008: if ($topmargin ne '0') {$topmargintoinsert='\setlength{\topmargin}{'.$topmargin.'}';}
2009: my $fancypagestatement='';
2010: if ($numberofcolumns eq '2') {
2011: $fancypagestatement="\\fancyhead{}\\fancyhead[LO]{$header_text}";
2012: } else {
2013: $fancypagestatement="\\rhead{}\\chead{}\\lhead{$header_text}";
2014: }
2015: if ($layout eq 'album') {
2016: $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 /;
2017: } elsif ($layout eq 'book') {
2018: if ($choice ne 'All class print') {
2019: $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/;
2020: } else {
2021: $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 /;
2022: }
2023: if ($papersize eq 'a4') {
2024: my $papersize_text;
2025: if ($perm{'pav'}) {
2026: $papersize_text = '\\special{papersize=210mm,297mm}';
2027: } else {
2028: $papersize_text = '\special{papersize=210mm,297mm}';
2029: }
2030: $text =~ s/(\\begin\{document})/$1$papersize_text/;
2031: }
2032: }
2033: if ($tableofcontents eq 'yes') {$text=~s/(\\setcounter\{page\}\{1\})/$1 \\tableofcontents\\newpage /;}
2034: if ($indexlist eq 'yes') {
2035: $text=~s/(\\begin\{document})/\\makeindex $1/;
2036: $text=~s/(\\end\{document})/\\strut\\\\\\strut\\printindex $1/;
2037: }
2038: return $text;
2039: }
2040:
2041:
2042: sub page_cleanup {
2043: my $result = shift;
2044:
2045: $result =~ m/\\end\{document}(\d*)$/;
2046: my $number_of_columns = $1;
2047: my $insert = '{';
2048: for (my $id=1;$id<=$number_of_columns;$id++) { $insert .='l'; }
2049: $insert .= '}';
2050: $result =~ s/(\\begin\{longtable})INSERTTHEHEADOFLONGTABLE\\endfirsthead\\endhead/$1$insert/g;
2051: $result =~ s/&\s*REMOVETHEHEADOFLONGTABLE\\\\/\\\\/g;
2052: return $result,$number_of_columns;
2053: }
2054:
2055:
2056: sub details_for_menu {
2057: my ($helper)=@_;
2058: my $postdata=$env{'form.postdata'};
2059: if (!$postdata) { $postdata=$helper->{VARS}{'postdata'}; }
2060: my $name_of_resource = &Apache::lonnet::gettitle($postdata);
2061: my $symbolic = &Apache::lonnet::symbread($postdata);
2062: return if ( $symbolic eq '');
2063:
2064: my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symbolic);
2065: $map=&Apache::lonnet::clutter($map);
2066: my $name_of_sequence = &Apache::lonnet::gettitle($map);
2067: if ($name_of_sequence =~ /^\s*$/) {
2068: $map =~ m|([^/]+)$|;
2069: $name_of_sequence = $1;
2070: }
2071: my $name_of_map = &Apache::lonnet::gettitle($env{'request.course.uri'});
2072: if ($name_of_map =~ /^\s*$/) {
2073: $env{'request.course.uri'} =~ m|([^/]+)$|;
2074: $name_of_map = $1;
2075: }
2076: return ($name_of_resource,$name_of_sequence,$name_of_map);
2077: }
2078:
2079: sub copyright_line {
2080: 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 } ';
2081: }
2082: my $end_of_student = "\n".'\special{ps:ENDOFSTUDENTSTAMP}'."\n";
2083:
2084: sub latex_corrections {
2085: my ($number_of_columns,$result,$selectionmade,$answer_mode) = @_;
2086: # $result =~ s/\\includegraphics\{/\\includegraphics\[width=\\minipagewidth\]{/g;
2087: my $copyright = ©right_line();
2088: if ($selectionmade eq '1' || $answer_mode eq 'only') {
2089: $result =~ s/(\\end\{document})/\\strut\\vskip 0 mm $copyright $end_of_student $1/;
2090: } else {
2091: $result =~ s/(\\end\{document})/\\strut\\vspace\*{-4 mm}\\newline $copyright $end_of_student $1/;
2092: }
2093: $result =~ s/\$number_of_columns/$number_of_columns/g;
2094: $result =~ s/(\\end\{longtable}\s*)(\\strut\\newline\\noindent\\makebox\[\\textwidth\/$number_of_columns\]\[b\]\{\\hrulefill})/$2$1/g;
2095: $result =~ s/(\\end\{longtable}\s*)\\strut\\newline/$1/g;
2096: #-- LaTeX corrections
2097: my $first_comment = index($result,'<!--',0);
2098: while ($first_comment != -1) {
2099: my $end_comment = index($result,'-->',$first_comment);
2100: substr($result,$first_comment,$end_comment-$first_comment+3) = '';
2101: $first_comment = index($result,'<!--',$first_comment);
2102: }
2103: $result =~ s/^\s+$//gm; #remove empty lines
2104: #removes more than one empty space
2105: $result =~ s|(\s\s+)|($1=~/[\n\r]/)?"\n":" "|ge;
2106: $result =~ s/\\\\\s*\\vskip/\\vskip/gm;
2107: $result =~ s/\\\\\s*\\noindent\s*(\\\\)+/\\\\\\noindent /g;
2108: $result =~ s/{\\par }\s*\\\\/\\\\/gm;
2109: $result =~ s/\\\\\s+\[/ \[/g;
2110: #conversion of html characters to LaTeX equivalents
2111: if ($result =~ m/&(\w+|#\d+);/) {
2112: $result = &character_chart($result);
2113: }
2114: $result =~ s/(\\end\{tabular})\s*\\vskip 0 mm/$1/g;
2115: $result =~ s/(\\begin\{enumerate})\s*\\noindent/$1/g;
2116: return $result;
2117: }
2118:
2119:
2120: sub index_table {
2121: my $currentURL = shift;
2122: my $insex_string='';
2123: $currentURL=~s/\.([^\/+])$/\.$1\.meta/;
2124: $insex_string=&Apache::lonnet::metadata($currentURL,'keywords');
2125: return $insex_string;
2126: }
2127:
2128:
2129: sub IndexCreation {
2130: my ($texversion,$currentURL)=@_;
2131: my @key_words=split(/,/,&index_table($currentURL));
2132: my $chunk='';
2133: my $st=index $texversion,'\addcontentsline{toc}{subsection}{';
2134: if ($st>0) {
2135: for (my $i=0;$i<3;$i++) {$st=(index $texversion,'}',$st+1);}
2136: $chunk=substr($texversion,0,$st+1);
2137: substr($texversion,0,$st+1)=' ';
2138: }
2139: foreach my $key_word (@key_words) {
2140: if ($key_word=~/\S+/) {
2141: $texversion=~s/\b($key_word)\b/$1 \\index{$key_word} /i;
2142: }
2143: }
2144: if ($st>0) {substr($texversion,0,1)=$chunk;}
2145: return $texversion;
2146: }
2147:
2148: sub print_latex_header {
2149: my $mode=shift;
2150:
2151: return &Apache::londefdef::latex_header($mode);
2152: }
2153:
2154: sub path_to_problem {
2155: my ($urlp,$colwidth)=@_;
2156: $urlp=&Apache::lonnet::clutter($urlp);
2157:
2158: my $newurlp = '';
2159: $colwidth=~s/\s*mm\s*$//;
2160: #characters average about 2 mm in width
2161: if (length($urlp)*2 > $colwidth) {
2162: my @elements = split('/',$urlp);
2163: my $curlength=0;
2164: foreach my $element (@elements) {
2165: if ($element eq '') { next; }
2166: if ($curlength+(length($element)*2) > $colwidth) {
2167: $newurlp .= '|\vskip -1 mm \verb|';
2168: $curlength=length($element)*2;
2169: } else {
2170: $curlength+=length($element)*2;
2171: }
2172: $newurlp.='/'.$element;
2173: }
2174: } else {
2175: $newurlp=$urlp;
2176: }
2177: return '{\small\noindent\verb|'.$newurlp.'|\vskip 0 mm}';
2178: }
2179:
2180: sub recalcto_mm {
2181: my $textwidth=shift;
2182: my $LaTeXwidth;
2183: if ($textwidth=~/(-?\d+\.?\d*)\s*cm/) {
2184: $LaTeXwidth = $1*10;
2185: } elsif ($textwidth=~/(-?\d+\.?\d*)\s*mm/) {
2186: $LaTeXwidth = $1;
2187: } elsif ($textwidth=~/(-?\d+\.?\d*)\s*in/) {
2188: $LaTeXwidth = $1*25.4;
2189: }
2190: $LaTeXwidth.=' mm';
2191: return $LaTeXwidth;
2192: }
2193:
2194: sub get_textwidth {
2195: my ($helper,$LaTeXwidth)=@_;
2196: my $textwidth=$LaTeXwidth;
2197: if ($helper->{'VARS'}->{'pagesize.width'}=~/\d+/ &&
2198: $helper->{'VARS'}->{'pagesize.widthunit'}=~/\w+/) {
2199: $textwidth=&recalcto_mm($helper->{'VARS'}->{'pagesize.width'}.' '.
2200: $helper->{'VARS'}->{'pagesize.widthunit'});
2201: }
2202: return $textwidth;
2203: }
2204:
2205:
2206: sub unsupported {
2207: my ($currentURL,$mode,$symb)=@_;
2208: my $cleanURL=&Apache::lonenc::check_decrypt($currentURL);
2209: my $shown = $currentURL;
2210: if (($cleanURL ne $currentURL) || ($symb =~ m{/^enc/})) {
2211: $shown = &mt('URL not shown (encrypted)');
2212: }
2213: if ($mode ne '') {$mode='\\'.$mode}
2214: my $result = &print_latex_header($mode);
2215: if ($cleanURL=~m|^(/adm/wrapper)?/ext/|) {
2216: $cleanURL=~s|^(/adm/wrapper)?/ext/|http://|;
2217: $cleanURL=~s|^http://https://|https://|;
2218: if ($shown eq $currentURL) {
2219: $shown = &Apache::lonxml::latex_special_symbols($cleanURL);
2220: }
2221: my $title=&Apache::lonnet::gettitle($symb);
2222: $title = &Apache::lonxml::latex_special_symbols($title);
2223: $result.=' \strut \\\\ \textit{'.$title.'} \strut \\\\ '.$shown.' ';
2224: } else {
2225: if ($shown eq $currentURL) {
2226: $result.=&Apache::lonxml::latex_special_symbols($currentURL);
2227: } else {
2228: $result.=$shown;
2229: }
2230: }
2231: $result.= '\vskip 0.5mm\noindent\makebox[\textwidth/$number_of_columns][b]{\hrulefill} \end{document}';
2232: return $result;
2233: }
2234:
2235: #
2236: # Map from helper layout style to the book/album:
2237: #
2238: sub map_laystyle {
2239: my ($laystyle) = @_;
2240: if ($laystyle eq 'L') {
2241: $laystyle='album';
2242: } else {
2243: $laystyle='book';
2244: }
2245: return $laystyle;
2246: }
2247:
2248: sub print_page_in_course {
2249: my ($helper, $rparmhash, $currentURL, $resources) = @_;
2250:
2251: my %parmhash = %$rparmhash;
2252: my @page_resources = @$resources;
2253: my $mode = $helper->{'VARS'}->{'LATEX_TYPE'};
2254: my $symb = $helper->{'VARS'}->{'symb'};
2255:
2256:
2257: my $format_from_helper = $helper->{'VARS'}->{'FORMAT'};
2258:
2259:
2260: my @temporary_array=split /\|/,$format_from_helper;
2261: my ($laystyle,$numberofcolumns,$papersize,$pdfFormFields)=@temporary_array;
2262: $laystyle = &map_laystyle($laystyle);
2263: my ($textwidth,$textheight,$oddoffset,$evenoffset) = &page_format($papersize,$laystyle,
2264: $numberofcolumns);
2265: my $LaTeXwidth=&recalcto_mm($textwidth);
2266:
2267: if ($mode ne '') {$mode='\\'.$mode}
2268: my $result = &print_latex_header($mode);
2269:
2270: my $title=&Apache::lonnet::gettitle($currentURL);
2271: $title = &Apache::lonxml::latex_special_symbols($title);
2272: $result .= '\noindent\textit{'.$title.'}\\\\';
2273:
2274: if ($helper->{'VARS'}->{'style_file'}=~/\w/) {
2275: &Apache::lonnet::appenv({'construct.style' =>
2276: $helper->{'VARS'}->{'style_file'}});
2277: } elsif ($env{'construct.style'}) {
2278: &Apache::lonnet::delenv('construct.style');
2279: }
2280:
2281: # First is the overall page description. This is then followed by the
2282: # components of the page. Each of which must be printed independently.
2283: my $the_page = shift(@page_resources);
2284:
2285:
2286: foreach my $resource (@page_resources) {
2287: my $resource_src = $resource->src(); # Essentially the URL of the resource.
2288: my $current_url = $resource->link();
2289:
2290: # Recurse if a .page:
2291:
2292: if ($resource_src =~ /.page$/i) {
2293: my $navmap = Apache::lonnavmaps::navmap->new();
2294: my @page_resources = $navmap->retrieveResources($resource_src);
2295: $result .= &print_page_in_course($helper, $rparmhash,
2296: $resource_src, \@page_resources);
2297: } elsif ($resource->ext()) {
2298: $result.=&latex_header_footer_remove(&unsupported($current_url,$mode,$resource->symb));
2299: } elsif ($resource_src =~ /\.(problem|exam|quiz|assess|survey|form|library|xml|html|htm|xhtml|xhtm)$/) {
2300: # these resources go through the XML transformer:
2301: $result .= &Apache::lonxml::latex_special_symbols($resource->title()) . '\\\\';
2302:
2303: my $urlp = &Apache::lonnet::clutter($resource_src);
2304:
2305: my %form;
2306: my %moreenv;
2307:
2308: &Apache::lonxml::remember_problem_counter();
2309: $moreenv{'request.filename'}=$urlp;
2310: if ($helper->{'VARS'}->{'probstatus'} eq 'exam') {$form{'problemtype'}='exam';}
2311:
2312: $form{'grade_target'} = 'tex';
2313: $form{'textwidth'} = &get_textwidth($helper, $LaTeXwidth);
2314: $form{'pdfFormFields'} = $pdfFormFields; #
2315: $form{'showallfoils'} = $helper->{'VARS'}->{'showallfoils'};
2316:
2317: $form{'problem_split'}=$parmhash{'problem_stream_switch'};
2318: $form{'suppress_tries'}=$parmhash{'suppress_tries'};
2319: $form{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
2320: $form{'print_discussions'}=$helper->{'VARS'}->{'PRINT_DISCUSSIONS'};
2321: $form{'print_annotations'}=$helper->{'VARS'}->{'PRINT_ANNOTATIONS'};
2322: if (($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes') ||
2323: ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes')) {
2324: $form{'problem_split'}='yes';
2325: }
2326: my $rndseed = time;
2327: if ($helper->{'VARS'}->{'curseed'}) {
2328: $rndseed=$helper->{'VARS'}->{'curseed'};
2329: }
2330: $form{'rndseed'}=$rndseed;
2331: &Apache::lonnet::appenv(\%moreenv);
2332:
2333: &Apache::lonxml::clear_problem_counter();
2334:
2335: my $texversion = &ssi_with_retries($urlp, $ssi_retry_count, %form);
2336:
2337:
2338: # current document with answers.. no need to encap in minipage
2339: # since there's only one answer.
2340:
2341: if(($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') ||
2342: ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'only')) {
2343: my %answerform = %form;
2344:
2345:
2346: $answerform{'problem_split'}=$parmhash{'problem_stream_switch'};
2347: $answerform{'grade_target'}='answer';
2348: $answerform{'answer_output_mode'}='tex';
2349: $answerform{'rndseed'}=$rndseed;
2350: if ($helper->{'VARS'}->{'probstatus'} eq 'exam') {
2351: $answerform{'problemtype'}='exam';
2352: }
2353: $resources_printed .= $urlp.':';
2354: my $answer=&ssi_with_retries($urlp,$ssi_retry_count, %answerform);
2355:
2356: if ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') {
2357: $texversion=~s/(\\keephidden\{ENDOFPROBLEM})/$answer$1/;
2358: } else {
2359: $texversion= &print_latex_header($helper->{'VARS'}->{'LATEX_TYPE'});
2360: if ($helper->{'VARS'}->{'construction'} ne '1') {
2361: my $title = &Apache::lonnet::gettitle($helper->{'VARS'}->{'symb'});
2362: $title = &Apache::lonxml::latex_special_symbols($title);
2363: $texversion.='\vskip 0 mm \noindent\textbf{'.$title.'}\vskip 0 mm ';
2364: $texversion.=&path_to_problem($urlp,$LaTeXwidth);
2365: } else {
2366: $texversion.='\vskip 0 mm \noindent\textbf{'.
2367: &mt("Printing from Authoring Space: No Title").'}\vskip 0 mm ';
2368: $texversion.=&path_to_problem($urlp,$LaTeXwidth);
2369: }
2370: $texversion.='\vskip 1 mm '.$answer.'\end{document}';
2371: }
2372:
2373:
2374:
2375:
2376:
2377: }
2378: # Print annotations.
2379:
2380:
2381: if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
2382: my $annotation .= &annotate($currentURL);
2383: $texversion =~ s/(\\keephidden\{ENDOFPROBLEM})/$annotation$1/;
2384: }
2385:
2386: if ($helper->{'VARS'}->{'TABLE_INDEX'} eq 'yes') {
2387: $texversion=&IndexCreation($texversion,$currentURL);
2388: }
2389: if ($helper->{'VARS'}->{'CONSTR_RESOURSE_URL'} eq 'yes') {
2390: $texversion=~s/(\\addcontentsline\{toc\}\{subsection\}\{[^\}]*\})/$1 URL: \\verb|$currentURL| \\strut\\\\\\strut /;
2391:
2392: }
2393: $texversion = &latex_header_footer_remove($texversion);
2394:
2395: # the first remaining line is a comment from londefdef the second
2396: # line seems to be an extraneous \vskip 1mm \\\\ :
2397: # (imperfect removal from header_footer_remove?
2398:
2399: $texversion =~ s/\\vskip 1mm \\\\\\\\//;
2400:
2401: $result .= $texversion;
2402: if ($currentURL=~m/\.page\s*$/) {
2403: ($result,$numberofcolumns) = &page_cleanup($result);
2404: }
2405: }
2406: }
2407:
2408: $result.= '\vskip 0.5mm\noindent\makebox[\textwidth/$number_of_columns][b]{\hrulefill} \end{document}';
2409: return $result;
2410: }
2411:
2412:
2413: #
2414: # List of recently generated print files
2415: #
2416: sub recently_generated {
2417: my ($prtspool) = @_;
2418: my $output;
2419: my $zip_result;
2420: my $pdf_result;
2421: opendir(DIR,$prtspool);
2422:
2423: my @files =
2424: grep(/^$env{'user.name'}_$env{'user.domain'}_printout_(\d+)_.*\.(pdf|zip)$/,readdir(DIR));
2425: closedir(DIR);
2426:
2427: @files = sort {
2428: my ($actime) = (stat($prtspool.'/'.$a))[10];
2429: my ($bctime) = (stat($prtspool.'/'.$b))[10];
2430: return $bctime <=> $actime;
2431: } (@files);
2432:
2433: foreach my $filename (@files) {
2434: my ($ext) = ($filename =~ m/(pdf|zip)$/);
2435: my ($cdev,$cino,$cmode,$cnlink,
2436: $cuid,$cgid,$crdev,$csize,
2437: $catime,$cmtime,$cctime,
2438: $cblksize,$cblocks)=stat($prtspool.'/'.$filename);
2439: my $ext_text = 'pdf' ? &mt('PDF File'):&mt('Zip File');
2440: my $result=&Apache::loncommon::start_data_table_row()
2441: .'<td>'
2442: .'<a href="/prtspool/'.$filename.'">'.$ext_text.'</a>'
2443: .'</td>'
2444: .'<td>'.&Apache::lonlocal::locallocaltime($cctime).'</td>'
2445: .'<td align="right">'.$csize.'</td>'
2446: .&Apache::loncommon::end_data_table_row();
2447: if ($ext eq 'pdf') { $pdf_result .= $result; }
2448: if ($ext eq 'zip') { $zip_result .= $result; }
2449: }
2450: if ($zip_result || $pdf_result) {
2451: $output ='<hr />';
2452: }
2453: if ($zip_result) {
2454: $output .='<h3>'.&mt('Recently generated printout zip files')."</h3>\n"
2455: .&Apache::loncommon::start_data_table()
2456: .&Apache::loncommon::start_data_table_header_row()
2457: .'<th>'.&mt('Download').'</th>'
2458: .'<th>'.&mt('Creation Date').'</th>'
2459: .'<th>'.&mt('File Size (Bytes)').'</th>'
2460: .&Apache::loncommon::end_data_table_header_row()
2461: .$zip_result
2462: .&Apache::loncommon::end_data_table();
2463: }
2464: if ($pdf_result) {
2465: $output .='<h3>'.&mt('Recently generated printouts')."</h3>\n"
2466: .&Apache::loncommon::start_data_table()
2467: .&Apache::loncommon::start_data_table_header_row()
2468: .'<th>'.&mt('Download').'</th>'
2469: .'<th>'.&mt('Creation Date').'</th>'
2470: .'<th>'.&mt('File Size (Bytes)').'</th>'
2471: .&Apache::loncommon::end_data_table_header_row()
2472: .$pdf_result
2473: .&Apache::loncommon::end_data_table();
2474: }
2475: return $output;
2476: }
2477:
2478: #
2479: # Retrieve the hash of page breaks.
2480: #
2481: # Inputs:
2482: # helper - reference to helper object.
2483: # Outputs
2484: # A reference to a page break hash.
2485: #
2486: #
2487: # use Data::Dumper;
2488: # sub dump_helper_vars {
2489: # my ($helper) = @_;
2490: # my $helpervars = Dumper($helper->{'VARS'});
2491: # &Apache::lonnet::logthis("Dump of helper vars:\n $helpervars");
2492: #}
2493:
2494: sub get_page_breaks {
2495: my ($helper) = @_;
2496: my %page_breaks;
2497:
2498: foreach my $break (split /\|\|\|/, $helper->{'VARS'}->{'FINISHPAGE'}) {
2499: $page_breaks{$break} = 1;
2500: }
2501: return %page_breaks;
2502: }
2503: #
2504: # Returns text to insert for any extra vskip prior to the resource.
2505: # Parameters:
2506: # helper - Reference to the helper object driving the printout.
2507: # resource - Identifies the resource about to be printed.
2508: #
2509: # This is done as follows:
2510: # POSSIBLE_RESOURCES has the list of possible resources.
2511: # EXTRASPACE has the list of extra space values.
2512: # EXTRASPACE_UNITS is the set of resources for which the units are
2513: # mm. All others are 'in'.
2514: #
2515: # The resource is found in the POSSIBLE_RESOURCES to get the index
2516: # of the EXTRASPACE value.
2517: #
2518: # In order to speed this up for lengthy printouts, the first time,
2519: # POSSIBLE_RESOURCES is turned into a look up hash and
2520: # EXTRASPACE is turned into an array.
2521: #
2522:
2523:
2524: my %possible_resources;
2525: my %extraspace_mm;
2526: my @extraspace;
2527: my $skips_loaded = 0;
2528:
2529: # Function to load the skips hash and array
2530:
2531: sub load_skips {
2532:
2533: my ($helper) = @_;
2534:
2535: # If this is the first time, unwrap the resources and extra spaces:
2536:
2537: if (!$skips_loaded) {
2538: @extraspace = (split(/\|\|\|/, $helper->{'VARS'}->{'EXTRASPACE'}));
2539: my @resource_list = (split(/\|\|\|/, $helper->{'VARS'}->{'POSSIBLE_RESOURCES'}));
2540: my $i = 0;
2541: foreach my $resource (@resource_list) {
2542: $possible_resources{$resource} = $i;
2543: $i++;
2544: }
2545: foreach my $mm_resource (split(/\|\|\|/, $helper->{'VARS'}->{'EXTRASPACE_UNITS'})) {
2546: $extraspace_mm{$mm_resource} = 1;
2547: }
2548: $skips_loaded = 1;
2549: }
2550: }
2551:
2552: sub get_extra_vspaces {
2553: my ($helper, $resource) = @_;
2554:
2555: &load_skips($helper);
2556:
2557: # Lookup the resource in the possible resources hash.. that is the index
2558: # into the extraspace array that gives us either an empty string or
2559: # the number of mm to skip:
2560:
2561: my $index = $possible_resources{$resource};
2562: my $skip = $extraspace[$index];
2563:
2564: my $result = '';
2565: if ($skip ne '') {
2566: my $units = 'in';
2567: if (defined($extraspace_mm{$resource})) {
2568: $units = 'mm';
2569: }
2570: $result = '\vskip '.$skip.' '.$units;
2571: }
2572:
2573:
2574: return $result;
2575:
2576:
2577: }
2578:
2579: #
2580: # The resource chooser part of the helper needs more than just
2581: # the value of the extraspaces var to recover the value into a text
2582: # field option. This sub produces the required format for the saved var:
2583: # specifically
2584: # ||| separated fields of the form resourcename=value
2585: #
2586: # Parameters:
2587: # $helper - Refers to the helper we are configuring
2588: # Implicit input:
2589: # $helper->{'VARS'}->{'EXTRASPACE'} - the spaces helper var has the text field
2590: # value.
2591: # $helper->{'VARS'}->{'EXTRASPACE_UNITS'} - units for the skips (checkboxes).
2592: # $helper->{'VARS'}->{'POSSIBLE_RESOURCES'} - has the list of resources. |||
2593: # separated of course.
2594: # Implicit outputs:
2595: # $env{'form.extraspace'}
2596: # $env{'form.extraspace_units'}
2597: #
2598: sub set_form_extraspace {
2599: my ($helper) = @_;
2600:
2601: # the most convenient way to do this is to drive from the skips arrays/hash.
2602: # may not be the fastest, but this is once per print request so it's not so
2603: # speed critical:
2604:
2605: &load_skips($helper);
2606:
2607: my $result = '';
2608:
2609: foreach my $resource (keys(%possible_resources)) {
2610: my $vskip = $extraspace[$possible_resources{$resource}];
2611: $result .= $resource .'=' . $vskip . '|||';
2612: }
2613:
2614: $env{'form.extraspace'} = $result;
2615: $env{'form.extraspace_units'} = $helper->{'VARS'}->{'EXTRASPACE_UNITS'};
2616: return $result;
2617:
2618: }
2619:
2620: # Output a sequence (recursively if neeed)
2621: # from construction space.
2622: # Parameters:
2623: # url = URL of the sequence to print.
2624: # helper - Reference to the helper hash.
2625: # form - Copy of the format hash.
2626: # LaTeXWidth
2627: # Returns:
2628: # Text to add to the printout.
2629: # NOTE if the first element of the outermost sequence
2630: # is itself a sequence, the outermost caller may need to
2631: # prefix the latex with the page headers stuff.
2632: #
2633: sub print_construction_sequence {
2634: my ($currentURL, $helper, %form, $LaTeXwidth) = @_;
2635:
2636: my $result;
2637: my $rndseed=time;
2638: if ($helper->{'VARS'}->{'curseed'}) {
2639: $rndseed=$helper->{'VARS'}->{'curseed'};
2640: }
2641: my $errtext=&LONCAPA::map::mapread(&Apache::lonnet::filelocation('',$currentURL));
2642:
2643: #
2644: # These make this all support recursing for subsequences.
2645: #
2646: my @order = @LONCAPA::map::order;
2647: my @resources = @LONCAPA::map::resources;
2648:
2649: for (my $member=0;$member<=$#order;$member++) {
2650: $resources[$order[$member]]=~/^([^:]*):([^:]*):/;
2651: my $urlp=$2;
2652: if ($urlp=~/\.(problem|exam|quiz|assess|survey|form|library|xml|html|htm|xhtml|xhtm)$/) {
2653: my $texversion='';
2654: if ($helper->{'VARS'}->{'ANSWER_TYPE'} ne 'only') {
2655: $form{'problem_split'}=$parmhash{'problem_stream_switch'};
2656: $form{'suppress_tries'}=$parmhash{'suppress_tries'};
2657: $form{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
2658: $form{'rndseed'}=$rndseed;
2659: $resources_printed .=$urlp.':';
2660: $texversion=&ssi_with_retries($urlp, $ssi_retry_count, %form);
2661: }
2662: if((($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') ||
2663: ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'only')) &&
2664: ($urlp=~/$LONCAPA::assess_page_re/)) {
2665: # Don't permanently modify %$form...
2666: my %answerform = %form;
2667: $answerform{'grade_target'}='answer';
2668: $answerform{'answer_output_mode'}='tex';
2669: $answerform{'rndseed'}=$rndseed;
2670: $answerform{'problem_split'}=$parmhash{'problem_stream_switch'};
2671: if ($urlp=~/\/res\//) {$env{'request.state'}='published';}
2672: $resources_printed .= $urlp.':';
2673: my $answer=&ssi_with_retries($urlp, $ssi_retry_count, %answerform);
2674: if ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') {
2675: $texversion=~s/(\\keephidden\{ENDOFPROBLEM})/$answer$1/;
2676: } else {
2677: # If necessary, encapsulate answer in minipage:
2678:
2679: $texversion=&print_latex_header($helper->{'VARS'}->{'LATEX_TYPE'});
2680: my $title = &Apache::lonnet::gettitle($helper->{'VARS'}->{'symb'});
2681: $title = &Apache::lonxml::latex_special_symbols($title);
2682: my $body ='\vskip 0 mm \noindent\textbf{'.$title.'}\vskip 0 mm ';
2683: $body.=&path_to_problem($urlp,$LaTeXwidth);
2684: $body.='\vskip 1 mm '.$answer.'\end{document}';
2685: $body = &encapsulate_minipage($body,$answerform{'problem_split'});
2686: $texversion.=$body;
2687: }
2688: }
2689: $texversion = &latex_header_footer_remove($texversion);
2690:
2691: if ($helper->{'VARS'}->{'TABLE_INDEX'} eq 'yes') {
2692: $texversion=&IndexCreation($texversion,$urlp);
2693: }
2694: if ($helper->{'VARS'}->{'CONSTR_RESOURSE_URL'} eq 'yes') {
2695: $texversion=~s/(\\addcontentsline\{toc\}\{subsection\}\{[^\}]*\})/$1 URL: \\verb|$urlp| \\strut\\\\\\strut /;
2696: }
2697: $result.=$texversion;
2698:
2699: } elsif ($urlp=~/\.(sequence|page)$/) {
2700:
2701: # header:
2702:
2703: $result.='\strut\newline\noindent Sequence/page '.$urlp.'\strut\newline\noindent\makebox[\textwidth/$number_of_columns][b]{\hrulefill}\newline\noindent ';
2704:
2705: # IF sequence, recurse:
2706:
2707: if ($urlp =~ /\.sequence$/) {
2708: $result .= &print_construction_sequence($urlp,
2709: $helper, %form,
2710: $LaTeXwidth);
2711: }
2712: }
2713: elsif ($urlp =~ /\.pdf$/i) {
2714: my $texversion;
2715: if ($member != 0) {
2716: $texversion .= '\cleardoublepage';
2717: }
2718:
2719: $texversion .= &include_pdf($urlp);
2720: $texversion = &latex_header_footer_remove($texversion);
2721: if ($member != $#order) {
2722: $texversion .= '\\ \cleardoublepage';
2723: }
2724:
2725: $result .= $texversion;
2726: }
2727: }
2728: if ($helper->{VARS}->{'construction'} eq '1') {$result=~s/(\\begin\{document})/$1 \\fbox\{RANDOM SEED IS $rndseed\} /;}
2729: return $result;
2730: }
2731:
2732: #
2733: # Top level for generating print output.
2734: #
2735: # May call print_resources if multiple resources will be printed.
2736: #
2737: # The main driver is $selectionmade which reflects the type of print out
2738: # requested:
2739: # Value Print type:
2740: # 1 Print resource that's being looked at.
2741: # 2 Print problems in a map or in a page.
2742: # 3 Print pages in a map or resources in a page.
2743: # 4 Print all problems or all resources.
2744: # 5 Print problems for seleted students.
2745: # 6 Print selected problems from a folder.
2746: # 7 Print print selected resources from some scope.
2747: # 8 Print resources for selected students.
2748: #
2749: #BZ 5209
2750: # 2 map_incomplete_problems_seq Print incomplete problems from the current
2751: # folder in student context.
2752: # 5 map_incomplete_problems_people_seq Print incomplete problems from the
2753: # current folder in privileged context.
2754: # 5 incomplete_problems_selpeople_course Print incomplete problems for
2755: # selected people from the entire course.
2756: #
2757: # Item 101 has much the same processing as 8,
2758: #
2759: # Differences: Item 101, 102 require per-student filtering of the resource
2760: # set so that only the incomplete resources are printed.
2761: # For item 100, filtering was done at the helper level.
2762:
2763: sub output_data {
2764:
2765: my ($r,$helper,$rparmhash) = @_;
2766: my %parmhash = %$rparmhash;
2767: $ssi_error = 0; # This will be set nonzero by failing ssi's.
2768: $resources_printed = '';
2769: $font_size = $helper->{'VARS'}->{'fontsize'};
2770: my $print_type = $helper->{'VARS'}->{'PRINT_TYPE'}; # Allows textual simplification.
2771: my $do_postprocessing = 1;
2772: my $js = <<ENDPART;
2773: <script type="text/javascript">
2774: var editbrowser;
2775: function openbrowser(formname,elementname,only,omit) {
2776: var url = '/res/?';
2777: if (editbrowser == null) {
2778: url += 'launch=1&';
2779: }
2780: url += 'catalogmode=interactive&';
2781: url += 'mode=parmset&';
2782: url += 'form=' + formname + '&';
2783: if (only != null) {
2784: url += 'only=' + only + '&';
2785: }
2786: if (omit != null) {
2787: url += 'omit=' + omit + '&';
2788: }
2789: url += 'element=' + elementname + '';
2790: var title = 'Browser';
2791: var options = 'scrollbars=1,resizable=1,menubar=0';
2792: options += ',width=700,height=600';
2793: editbrowser = open(url,title,options,'1');
2794: editbrowser.focus();
2795: }
2796: </script>
2797: ENDPART
2798:
2799:
2800: # Breadcrumbs
2801: #FIXME: Choose better/different breadcrumbs?!? Links?
2802: my $brcrum = [{'href' => '',
2803: 'text' => 'Helper'}, #FIXME: Different origin possible than print out helper?
2804: {'href' => '',
2805: 'text' => 'Preparing Printout'}];
2806:
2807: my $start_page = &Apache::loncommon::start_page('Preparing Printout',
2808: $js,
2809: {'bread_crumbs' => $brcrum,});
2810: my $msg = &mt('Please stand by while processing your print request, this may take some time ...');
2811:
2812: $r->print($start_page."\n<p>\n$msg\n</p>\n");
2813:
2814: # fetch the pagebreaks and store them in the course environment
2815: # The page breaks will be pulled into the hash %page_breaks which is
2816: # indexed by symb and contains 1's for each break.
2817:
2818: $env{'form.pagebreaks'} = $helper->{'VARS'}->{'FINISHPAGE'};
2819: &set_form_extraspace($helper);
2820: $env{'form.lastprinttype'} = $print_type;
2821: &Apache::loncommon::store_course_settings('print',
2822: {'pagebreaks' => 'scalar',
2823: 'extraspace' => 'scalar',
2824: 'extraspace_units' => 'scalar',
2825: 'lastprinttype' => 'scalar'});
2826: my %page_breaks = &get_page_breaks($helper);
2827:
2828: my $format_from_helper = $helper->{'VARS'}->{'FORMAT'};
2829: my ($result,$selectionmade) = ('','');
2830: my $number_of_columns = 1; #used only for pages to determine the width of the cell
2831: my @temporary_array=split /\|/,$format_from_helper;
2832: my ($laystyle,$numberofcolumns,$papersize,$pdfFormFields)=@temporary_array;
2833:
2834: $laystyle = &map_laystyle($laystyle);
2835: my ($textwidth,$textheight,$oddoffset,$evenoffset) = &page_format($papersize,$laystyle,$numberofcolumns);
2836: my $assignment = $env{'form.assignment'};
2837: my $LaTeXwidth=&recalcto_mm($textwidth);
2838: my @print_array=();
2839: my @student_names=();
2840:
2841:
2842: # Common settings for the %form hash:
2843: # In some cases these settings get overridden by specific cases, but the
2844: # settings are common enough to make it worthwhile factoring them out
2845: # here.
2846: #
2847: my %form;
2848: $form{'grade_target'} = 'tex';
2849: $form{'textwidth'} = &get_textwidth($helper, $LaTeXwidth);
2850: $form{'pdfFormFields'} = $pdfFormFields;
2851:
2852: # If form.showallfoils is set, then request all foils be shown:
2853: # privilege will be enforced both by not allowing the
2854: # check box selecting this option to be presnt unless it's ok,
2855: # and by lonresponse's priv. check.
2856: # The if is here because lonresponse.pm only cares that
2857: # showallfoils is defined, not what the value is.
2858:
2859: if ($helper->{'VARS'}->{'showallfoils'} eq "1") {
2860: $form{'showallfoils'} = $helper->{'VARS'}->{'showallfoils'};
2861: }
2862:
2863: if ($helper->{'VARS'}->{'style_file'}=~/\w/) {
2864: &Apache::lonnet::appenv({'construct.style' =>
2865: $helper->{'VARS'}->{'style_file'}});
2866: } elsif ($env{'construct.style'}) {
2867: &Apache::lonnet::delenv('construct.style');
2868: }
2869:
2870: if ($print_type eq 'current_document') {
2871: #-- single document - problem, page, html, xml, ...
2872: my ($currentURL,$cleanURL);
2873:
2874: if ($helper->{'VARS'}->{'construction'} ne '1') {
2875: #prints published resource
2876: $currentURL=$helper->{'VARS'}->{'postdata'};
2877: $cleanURL=&Apache::lonenc::check_decrypt($currentURL);
2878: } else {
2879:
2880: #prints resource from the construction space
2881: $currentURL=$helper->{'VARS'}->{'filename'};
2882: $cleanURL=$currentURL;
2883: }
2884: $selectionmade = 1;
2885:
2886: if ($cleanURL!~m|^/adm/|
2887: && $cleanURL=~/\.(problem|exam|quiz|assess|survey|form|library|xml|html|htm|xhtml|xhtm)$/) {
2888: my $rndseed=time;
2889: my $texversion='';
2890: if ($helper->{'VARS'}->{'ANSWER_TYPE'} ne 'only') {
2891: my %moreenv;
2892: $moreenv{'request.filename'}=$cleanURL;
2893: if ($helper->{'VARS'}->{'probstatus'} eq 'exam') {$form{'problemtype'}='exam';}
2894: $form{'problem_split'}=$parmhash{'problem_stream_switch'};
2895: $form{'suppress_tries'}=$parmhash{'suppress_tries'};
2896: $form{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
2897: $form{'print_discussions'}=$helper->{'VARS'}->{'PRINT_DISCUSSIONS'};
2898: $form{'print_annotations'}=$helper->{'VARS'}->{'PRINT_ANNOTATIONS'};
2899: if (($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes') ||
2900: ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes')) {
2901: $form{'problem_split'}='yes';
2902: }
2903: if ($helper->{'VARS'}->{'curseed'}) {
2904: $rndseed=$helper->{'VARS'}->{'curseed'};
2905: }
2906: $form{'rndseed'}=$rndseed;
2907: &Apache::lonnet::appenv(\%moreenv);
2908:
2909: &Apache::lonxml::clear_problem_counter();
2910:
2911: $resources_printed .= $currentURL.':';
2912: $texversion.=&ssi_with_retries($currentURL,$ssi_retry_count, %form);
2913:
2914: # Add annotations if required:
2915:
2916: &Apache::lonxml::clear_problem_counter();
2917:
2918: &Apache::lonnet::delenv('request.filename');
2919: }
2920: # current document with answers.. no need to encap in minipage
2921: # since there's only one answer.
2922:
2923: if(($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') ||
2924: ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'only')) {
2925:
2926: $form{'problem_split'}=$parmhash{'problem_stream_switch'};
2927: $form{'grade_target'}='answer';
2928: $form{'answer_output_mode'}='tex';
2929: $form{'rndseed'}=$rndseed;
2930: if ($helper->{'VARS'}->{'probstatus'} eq 'exam') {
2931: $form{'problemtype'}='exam';
2932: }
2933: $resources_printed .= $currentURL.':';
2934: my $answer=&ssi_with_retries($currentURL,$ssi_retry_count, %form);
2935:
2936:
2937: if ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') {
2938: $texversion=~s/(\\keephidden\{ENDOFPROBLEM})/$answer$1/;
2939: } else {
2940: $texversion=&print_latex_header($helper->{'VARS'}->{'LATEX_TYPE'});
2941: if ($helper->{'VARS'}->{'construction'} ne '1') {
2942: my $title = &Apache::lonnet::gettitle($helper->{'VARS'}->{'symb'});
2943: $title = &Apache::lonxml::latex_special_symbols($title);
2944: $texversion.='\vskip 0 mm \noindent\textbf{'.$title.'}\vskip 0 mm ';
2945: $texversion.=&path_to_problem($cleanURL,$LaTeXwidth);
2946: } else {
2947: $texversion.='\vskip 0 mm \noindent\textbf{'.
2948: &mt("Printing from Authoring Space: No Title").'}\vskip 0 mm ';
2949:
2950: $texversion.=&path_to_problem($cleanURL,$LaTeXwidth);
2951: }
2952: $texversion.='\vskip 1 mm '.$answer.'\end{document}';
2953: }
2954:
2955:
2956:
2957:
2958:
2959: }
2960: # Print annotations.
2961:
2962:
2963: if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
2964: my $annotation .= &annotate($currentURL);
2965: $texversion =~ s/(\\keephidden\{ENDOFPROBLEM})/$annotation$1/;
2966: }
2967:
2968:
2969: if ($helper->{'VARS'}->{'TABLE_INDEX'} eq 'yes') {
2970: $texversion=&IndexCreation($texversion,$currentURL);
2971: }
2972: if ($helper->{'VARS'}->{'CONSTR_RESOURSE_URL'} eq 'yes') {
2973: $texversion=~s/(\\addcontentsline\{toc\}\{subsection\}\{[^\}]*\})/$1 URL: \\verb|$currentURL| \\strut\\\\\\strut /;
2974:
2975: }
2976: $result .= $texversion;
2977: if ($currentURL=~m/\.page\s*$/) {
2978: ($result,$number_of_columns) = &page_cleanup($result);
2979: }
2980: } elsif ($cleanURL!~m|^/adm/|
2981: && $currentURL=~/\.(sequence|page)$/ && $helper->{'VARS'}->{'construction'} eq '1') {
2982: $result .= &print_construction_sequence($currentURL, $helper, %form,
2983: $LaTeXwidth);
2984: $result .= '\end{document}';
2985: if (!($result =~ /\\begin\{document\}/)) {
2986: $result = &print_latex_header() . $result;
2987: }
2988: # End construction space sequence.
2989: } elsif ($cleanURL=~/\/(smppg|syllabus|aboutme|bulletinboard|ext\.tool)$/) {
2990: $form{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
2991: if ($currentURL=~/\/syllabus$/) {$currentURL=~s/\/res//;}
2992: if ($currentURL=~/\/ext\.tool$/) {$currentURL=~s/^\/adm\/wrapper//;}
2993: $resources_printed .= $currentURL.':';
2994: my $texversion = &ssi_with_retries($currentURL, $ssi_retry_count, %form);
2995: if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
2996: my $annotation = &annotate($currentURL);
2997: $texversion =~ s/(\\end\{document})/$annotation$1/;
2998: }
2999: $result .= $texversion;
3000: } elsif ($cleanURL =~/\.tex$/) {
3001: # For this sort of print of a single LaTeX file,
3002: # We can just print the LaTeX file as it is uninterpreted in any way:
3003: #
3004:
3005: $result = &fetch_raw_resource($currentURL);
3006: if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
3007: my $annotation = &annotate($currentURL);
3008: $result =~ s/(\\end\{document})/$annotation$1/;
3009: }
3010:
3011: $do_postprocessing = 0; # Don't massage the result.
3012:
3013: } elsif ($cleanURL =~ /\.pdf$/i) {
3014: $result .= &include_pdf($cleanURL);
3015: $result .= '\end{document}';
3016: } elsif ($cleanURL =~ /\.page$/i) { # Print page in non construction space contexts.
3017:
3018: # Determine the set of resources in the map of the page:
3019:
3020: my $navmap = Apache::lonnavmaps::navmap->new();
3021: my @page_resources = $navmap->retrieveResources($cleanURL);
3022: $result .= &print_page_in_course($helper, $rparmhash,
3023: $cleanURL, \@page_resources);
3024:
3025:
3026: } else {
3027: $result.=&unsupported($currentURL,$helper->{'VARS'}->{'LATEX_TYPE'},
3028: $helper->{'VARS'}->{'symb'});
3029: }
3030: } elsif (($print_type eq 'map_problems') or
3031: ($print_type eq 'map_problems_in_page') or
3032: ($print_type eq 'map_resources_in_page') or
3033: ($print_type eq 'map_problems_pages') or
3034: ($print_type eq 'all_problems') or
3035: ($print_type eq 'all_resources') or # BUGBUG
3036: ($print_type eq 'select_sequences') or
3037: ($print_type eq 'map_incomplete_problems_seq')
3038: ) {
3039:
3040: #-- produce an output string
3041: if (($print_type eq 'map_problems') or
3042: ($print_type eq 'map_incomplete_problems_seq') or
3043: ($print_type eq 'map_problems_in_page') ) {
3044: $selectionmade = 2;
3045: } elsif (($print_type eq 'map_problems_pages') or
3046: ($print_type eq 'map_resources_in_page'))
3047: {
3048: $selectionmade = 3;
3049: } elsif (($print_type eq 'all_problems')
3050: ) {
3051: $selectionmade = 4;
3052: } elsif ($print_type eq 'all_resources') { #BUGBUG
3053: $selectionmade = 4;
3054: } elsif ($print_type eq 'select_sequences') {
3055: $selectionmade = 7;
3056: }
3057:
3058: $form{'problem_split'}=$parmhash{'problem_stream_switch'};
3059: $form{'suppress_tries'}=$parmhash{'suppress_tries'};
3060: $form{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
3061: $form{'print_discussions'}=$helper->{'VARS'}->{'PRINT_DISCUSSIONS'};
3062: $form{'print_annotations'} = $helper->{'VARS'}->{'PRINT_ANNOTATIONS'};
3063: if (($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes') ||
3064: ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') ) {
3065: $form{'problem_split'}='yes';
3066: }
3067: my $flag_latex_header_remove = 'NO';
3068: my $flag_page_in_sequence = 'NO';
3069: my @master_seq=split /\|\|\|/, $helper->{'VARS'}->{'RESOURCES'};
3070: my $prevassignment='';
3071:
3072: &Apache::lonxml::clear_problem_counter();
3073:
3074: for (my $i=0;$i<=$#master_seq;$i++) {
3075:
3076: &Apache::lonenc::reset_enc();
3077:
3078: # Note due to document structure, not allowed to put \newpage
3079: # prior to the first resource
3080:
3081: if (defined $page_breaks{$master_seq[$i]}) {
3082: if($i != 0) {
3083: $result.="\\newpage\n";
3084: }
3085: }
3086: $result .= &get_extra_vspaces($helper, $master_seq[$i]);
3087: my ($sequence,$middle_thingy,$urlp)=&Apache::lonnet::decode_symb($master_seq[$i]);
3088: $urlp=&Apache::lonnet::clutter($urlp);
3089: $form{'symb'}=$master_seq[$i];
3090:
3091: my $assignment=&Apache::lonxml::latex_special_symbols(&Apache::lonnet::gettitle($sequence),'header'); #title of the assignment which contains this problem
3092:
3093: if ($selectionmade==7) {$helper->{VARS}->{'assignment'}=$assignment;}
3094: if ($i==0) {$prevassignment=$assignment;}
3095: my $texversion='';
3096: if ($urlp!~m|^/adm/|
3097: && $urlp=~/\.(problem|exam|quiz|assess|survey|form|library|page|xml|html|htm|xhtml|xhtm)$/) {
3098: my $extension = $1;
3099: $resources_printed .= $urlp.':';
3100: &Apache::lonxml::remember_problem_counter();
3101: if ($flag_latex_header_remove eq 'NO') {
3102: $texversion.=&print_latex_header($helper->{'VARS'}->{'LATEX_TYPE'}); # RF
3103: unless (($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'only') ||
3104: (($i==0) &&
3105: (($urlp=~/\.page$/) ||
3106: ($print_type eq 'map_problems_in_page') ||
3107: (($print_type eq 'map_resources_in_page') && ($extension !~ /^x?html?$/))))) {
3108: $flag_latex_header_remove = 'YES';
3109: }
3110: }
3111: $texversion.=&ssi_with_retries($urlp, $ssi_retry_count, %form);
3112: if ($urlp=~/\.page$/) {
3113: ($texversion,my $number_of_columns_page) = &page_cleanup($texversion);
3114: if ($number_of_columns_page > $number_of_columns) {$number_of_columns=$number_of_columns_page;}
3115: $texversion =~ s/\\end\{document}\d*/\\end{document}/;
3116: $flag_page_in_sequence = 'YES';
3117: }
3118:
3119: if(($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') ||
3120: ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'only')) {
3121: # Don't permanently pervert the %form hash
3122: my %answerform = %form;
3123: $answerform{'grade_target'}='answer';
3124: $answerform{'answer_output_mode'}='tex';
3125: $resources_printed .= $urlp.':';
3126:
3127: &Apache::lonxml::restore_problem_counter();
3128: my $answer=&ssi_with_retries($urlp, $ssi_retry_count, %answerform);
3129: if ($urlp =~ /\.page$/) {
3130: $answer =~ s/\\end\{document}(\d*)$//;
3131: }
3132: if ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') {
3133: if ($urlp =~ /\.page$/) {
3134: my @probs = split(/\\keephidden\{ENDOFPROBLEM}/,$texversion);
3135: my $lastprob = pop(@probs);
3136: $texversion = join('\keephidden{ENDOFPROBLEM}',@probs).
3137: $answer.'\keephidden{ENDOFPROBLEM}'.$lastprob;
3138: } else {
3139: $texversion=~s/(\\keephidden\{ENDOFPROBLEM})/$answer$1/;
3140: }
3141: } else {
3142: if ($urlp=~/$LONCAPA::assess_page_re/) {
3143: $texversion=&print_latex_header($helper->{'VARS'}->{'LATEX_TYPE'});
3144: # $texversion =~ s/\\begin\{document}//; # FIXME
3145: my $title = &Apache::lonnet::gettitle($master_seq[$i]);
3146: $title = &Apache::lonxml::latex_special_symbols($title);
3147: my $body ='\vskip 0 mm \noindent\textbf{'.$title.'}\vskip 0 mm ';
3148: $body .= &path_to_problem ($urlp,$LaTeXwidth);
3149: $body .='\vskip 1 mm '.$answer;
3150: $body = &encapsulate_minipage($body,$answerform{'problem_split'});
3151: $texversion .= $body;
3152: } else {
3153: $texversion='';
3154: }
3155: }
3156:
3157: }
3158: if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
3159: my $annotation .= &annotate($urlp);
3160: $texversion =~ s/(\\keephidden\{ENDOFPROBLEM})/$annotation$1/;
3161: }
3162:
3163: if ($flag_latex_header_remove ne 'NO') {
3164: $texversion = &latex_header_footer_remove($texversion);
3165: } else {
3166: $texversion =~ s/\\end\{document}//;
3167: }
3168: if ($helper->{'VARS'}->{'TABLE_INDEX'} eq 'yes') {
3169: $texversion=&IndexCreation($texversion,$urlp);
3170: }
3171: if (($selectionmade == 4) and ($assignment ne $prevassignment)) {
3172: my $name = &get_name();
3173: my $courseidinfo = &get_course();
3174: $prevassignment=$assignment;
3175: my $header_text = $parmhash{'print_header_format'};
3176: $header_text = &format_page_header($textwidth, $header_text,
3177: $assignment,
3178: $courseidinfo,
3179: $name);
3180: if ($numberofcolumns eq '1') {
3181: $result .='\newpage \noindent\parbox{\minipagewidth}{\noindent\\lhead{'.$header_text.'}} \vskip 5 mm ';
3182: } else {
3183: $result .='\newpage \noindent\parbox{\minipagewidth}{\noindent\\fancyhead[LO]{'.$header_text.'}} \vskip 5 mm ';
3184: }
3185: }
3186: $result .= $texversion;
3187: $flag_latex_header_remove = 'YES';
3188: } elsif ($urlp=~/\/(smppg|syllabus|aboutme|bulletinboard|ext\.tool)$/) {
3189: $form{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
3190: if ($urlp=~/\/syllabus$/) {$urlp=~s/\/res//;}
3191: if ($urlp=~/\/ext\.tool$/) {$urlp=~s/^\/adm\/wrapper//;}
3192: $resources_printed .= $urlp.':';
3193: my $texversion = &ssi_with_retries($urlp, $ssi_retry_count, %form);
3194: if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
3195: my $annotation = &annotate($urlp);
3196: $texversion =~ s/(\\end\{document)/$annotation$1/;
3197: }
3198:
3199: if ($flag_latex_header_remove ne 'NO') {
3200: $texversion = &latex_header_footer_remove($texversion);
3201: } else {
3202: $texversion =~ s/\\end\{document}/\\vskip 0\.5mm\\noindent\\makebox\[\\textwidth\/\$number_of_columns\]\[b\]\{\\hrulefill\}/;
3203: }
3204: $result .= $texversion;
3205: $flag_latex_header_remove = 'YES';
3206: } elsif ($urlp=~ /\.pdf$/i) {
3207: if ($i > 0) {
3208: $result .= '\cleardoublepage';
3209: }
3210: my $texfrompdf = &include_pdf($urlp);
3211: if ($flag_latex_header_remove ne 'NO') {
3212: $texfrompdf = &latex_header_footer_remove($texfrompdf);
3213: }
3214: $result .= $texfrompdf;
3215: if ($i != $#master_seq) {
3216: if ($numberofcolumns eq '1') {
3217: $result .= '\newpage';
3218: } else {
3219: # the \\'s seem to be needed to let LaTeX know there's something
3220: # on the page since LaTeX seems to not like to clear an empty page.
3221: #
3222: $result .= '\\ \cleardoublepage';
3223: }
3224: }
3225: $flag_latex_header_remove = 'YES';
3226:
3227: } else {
3228: $texversion=&unsupported($urlp,$helper->{'VARS'}->{'LATEX_TYPE'},
3229: $master_seq[$i]);
3230: if ($flag_latex_header_remove ne 'NO') {
3231: $texversion = &latex_header_footer_remove($texversion);
3232: } else {
3233: $texversion =~ s/\\end\{document}//;
3234: }
3235: $result .= $texversion;
3236: $flag_latex_header_remove = 'YES';
3237: }
3238: if (&Apache::loncommon::connection_aborted($r)) {
3239: last;
3240: }
3241: }
3242: &Apache::lonxml::clear_problem_counter();
3243: if ($flag_page_in_sequence eq 'YES') {
3244: $result =~ s/\\usepackage\{calc}/\\usepackage{calc}\\usepackage{longtable}/;
3245: }
3246: $result .= '\end{document}';
3247: } elsif (($print_type eq 'problems_for_students') ||
3248: ($print_type eq 'problems_for_students_from_page') ||
3249: ($print_type eq 'all_problems_students') ||
3250: ($print_type eq 'resources_for_students') ||
3251: ($print_type eq 'incomplete_problems_selpeople_course') ||
3252: ($print_type eq 'map_incomplete_problems_people_seq') ||
3253: ($print_type eq 'select_sequences_problems_for_students') ||
3254: ($print_type eq 'select_sequences_resources_for_students')) {
3255:
3256:
3257: #-- prints assignments for whole class or for selected students
3258: my $type;
3259: if (($print_type eq 'problems_for_students') ||
3260: ($print_type eq 'problems_for_students_from_page') ||
3261: ($print_type eq 'all_problems_students') ||
3262: ($print_type eq 'incomplete_problems_selpeople_course') ||
3263: ($print_type eq 'map_incomplete_problems_people_seq') ||
3264: ($print_type eq 'select_sequences_problems_for_students')) {
3265: $selectionmade=5;
3266: $type='problems';
3267: } elsif (($print_type eq 'resources_for_students') ||
3268: ($print_type eq 'select_sequences_resources_for_students')) {
3269: $selectionmade=8;
3270: $type='resources';
3271: }
3272: my @students=split /\|\|\|/, $helper->{'VARS'}->{'STUDENTS'};
3273: # The normal sort order is by section then by students within the
3274: # section. If the helper var student_sort is 1, then the user has elected
3275: # to override this and output the students by name.
3276: # Each element of the students array is of the form:
3277: # username:domain:section:last, first:status
3278: #
3279: # Note that student sort is not compatible with printing
3280: # 1 section per pdf...so that setting overrides.
3281: #
3282: if (($helper->{'VARS'}->{'student_sort'} eq 1) &&
3283: ($helper->{'VARS'}->{'SPLIT_PDFS'} ne "sections")) {
3284: @students = sort compare_names @students;
3285: } else {
3286: @students = sort compare_sections @students;
3287: }
3288: &adjust_number_to_print($helper);
3289:
3290: if ($helper->{'VARS'}->{'NUMBER_TO_PRINT'} eq '0' ||
3291: $helper->{'VARS'}->{'NUMBER_TO_PRINT'} eq 'all' ) {
3292: $helper->{'VARS'}->{'NUMBER_TO_PRINT'}=$#students+1;
3293: }
3294: # If we are splitting on section boundaries, we need
3295: # to remember that in split_on_sections and
3296: # print all of the students in the list.
3297: #
3298: my $split_on_sections = 0;
3299: if ($helper->{'VARS'}->{'NUMBER_TO_PRINT'} eq 'section') {
3300: $split_on_sections = 1;
3301: $helper->{'VARS'}->{'NUMBER_TO_PRINT'} = $#students+1;
3302: }
3303: my @master_seq=split /\|\|\|/, $helper->{'VARS'}->{'RESOURCES'};
3304:
3305: my $map;
3306: if ($helper->{VARS}->{'symb'}) {
3307: unless ((($print_type eq 'all_problems_students') ||
3308: ($print_type eq 'incomplete_problems_selpeople_course')) &&
3309: $perm{'pfo'}) {
3310: ($map, my $id, my $resource) =
3311: &Apache::lonnet::decode_symb($helper->{VARS}->{'symb'});
3312: }
3313: }
3314:
3315: #loop over students
3316:
3317: my $flag_latex_header_remove = 'NO';
3318: my %moreenv;
3319: $moreenv{'instructor_comments'}='hide';
3320: $moreenv{'textwidth'}=&get_textwidth($helper,$LaTeXwidth);
3321: $moreenv{'print_discussions'}=$helper->{'VARS'}->{'PRINT_DISCUSSIONS'};
3322: $moreenv{'print_annotations'} = $helper->{'VARS'}->{'PRINT_ANNOTATIONS'};
3323: $moreenv{'problem_split'} = $parmhash{'problem_stream_switch'};
3324: $moreenv{'suppress_tries'} = $parmhash{'suppress_tries'};
3325: if (($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes') ||
3326: ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes')) {
3327: $moreenv{'problem_split'}='yes';
3328: }
3329: my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin($r,$#students+1);
3330: my $student_counter=-1;
3331: my $i = 0;
3332: my $last_section = (split(/:/,$students[0]))[2];
3333: my $nohidemap;
3334: if ($perm{'pav'} && $perm{'vgr'}) {
3335: $nohidemap = 1;
3336: }
3337: foreach my $person (@students) {
3338: my $duefile="/home/httpd/prtspool/$env{'user.name'}_$env{'user.domain'}_printout.due";
3339: if (-e $duefile) {
3340: my $temp_file = Apache::File->new('>>'.$duefile);
3341: print $temp_file "1969\n";
3342: }
3343: $student_counter++;
3344: if ($split_on_sections) {
3345: my $this_section = (split(/:/,$person))[2];
3346: if ($this_section ne $last_section) {
3347: $i++;
3348: $last_section = $this_section;
3349: }
3350: } else {
3351: $i=int($student_counter/$helper->{'VARS'}{'NUMBER_TO_PRINT'});
3352: }
3353: my $actual_seq = master_seq_to_person_seq($map, \@master_seq,
3354: $person, undef, $nohidemap);
3355: my ($output,$fullname, $printed)=&print_resources($r,$helper,
3356: $person,$type,
3357: \%moreenv, $actual_seq,
3358: $flag_latex_header_remove,
3359: $LaTeXwidth);
3360: $resources_printed .= ":";
3361: $print_array[$i].=$output;
3362: $student_names[$i].=$person.':'.$fullname.'_END_';
3363: # &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,&mt('last student').' '.$fullname);
3364: &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
3365: $flag_latex_header_remove = 'YES';
3366: if (&Apache::loncommon::connection_aborted($r)) { last; }
3367: }
3368: &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
3369: $result .= $print_array[0].' \end{document}';
3370: } elsif (($print_type eq 'problems_for_anon') ||
3371: ($print_type eq 'problems_for_anon_page') ||
3372: ($print_type eq 'resources_for_anon') ||
3373: ($print_type eq 'select_sequences_problems_for_anon') ||
3374: ($print_type eq 'select_sequences_resources_for_anon')) {
3375: my $cdom =$env{'course.'.$env{'request.course.id'}.'.domain'};
3376: my $cnum =$env{'course.'.$env{'request.course.id'}.'.num'};
3377: my $num_todo=$helper->{'VARS'}->{'NUMBER_TO_PRINT_TOTAL'};
3378: my $code_name=$helper->{'VARS'}->{'ANON_CODE_STORAGE_NAME'};
3379: my $old_name=$helper->{'VARS'}->{'REUSE_OLD_CODES'};
3380: my $single_code = $helper->{'VARS'}->{'SINGLE_CODE'};
3381: my $selected_code = $helper->{'VARS'}->{'CODE_SELECTED_FROM_LIST'};
3382: my $code_option=$helper->{'VARS'}->{'CODE_OPTION'};
3383: my @lines = &Apache::lonnet::get_scantronformat_file();
3384: my ($code_type,$code_length,$bubbles_per_row)=('letter',6,10);
3385: foreach my $line (@lines) {
3386: next if (($line =~ /^\#/) || ($line eq ''));
3387: my ($name,$type,$length,$bubbles_per_item) =
3388: (split(/:/,$line))[0,2,4,17];
3389: if ($name eq $code_option) {
3390: $code_length=$length;
3391: if ($type eq 'number') { $code_type = 'number'; }
3392: chomp($bubbles_per_item);
3393: if (($bubbles_per_item ne '') && ($bubbles_per_item > 0)) {
3394: $bubbles_per_row = $bubbles_per_item;
3395: }
3396: }
3397: }
3398: my $map;
3399: if ($helper->{VARS}{'symb'}) {
3400: ($map, my $id, my $resource) =
3401: &Apache::lonnet::decode_symb($helper->{VARS}{'symb'});
3402: }
3403: my %moreenv = ('textwidth' => &get_textwidth($helper,$LaTeXwidth));
3404: $moreenv{'problem_split'} = $parmhash{'problem_stream_switch'};
3405: $moreenv{'instructor_comments'}='hide';
3406: $moreenv{'bubbles_per_row'} = $bubbles_per_row;
3407: my $seed=time+($$<<16)+($$);
3408: my @allcodes;
3409: if ($old_name) {
3410: my %result=&Apache::lonnet::get('CODEs',
3411: [$old_name,"type\0$old_name"],
3412: $cdom,$cnum);
3413: $code_type=$result{"type\0$old_name"};
3414: @allcodes=split(',',$result{$old_name});
3415: $num_todo=scalar(@allcodes);
3416: } elsif ($selected_code) { # Selection value is always numeric.
3417: $num_todo = 1;
3418: @allcodes = ($selected_code);
3419: } elsif ($single_code) {
3420:
3421: $num_todo = 1; # Unconditionally one code to do.
3422: # If an alpha code have to convert to numbers so it can be
3423: # converted back to letters again :-)
3424: #
3425: if ($code_type ne 'number') {
3426: $single_code = &letters_to_num($single_code);
3427: }
3428: @allcodes = ($single_code);
3429: } else {
3430: my %allcodes;
3431: srand($seed);
3432: for (my $i=0;$i<$num_todo;$i++) {
3433: $moreenv{'CODE'}=&get_CODE(\%allcodes,$i,$seed,$code_length,
3434: $code_type);
3435: }
3436: $code_name =~ s/^\s+//;
3437: $code_name =~ s/\s+$//;
3438: if ($code_name) {
3439: &Apache::lonnet::put('CODEs',
3440: {
3441: $code_name =>join(',',keys(%allcodes)),
3442: "type\0$code_name" => $code_type
3443: },
3444: $cdom,$cnum);
3445: }
3446: @allcodes=keys(%allcodes);
3447: }
3448: my @master_seq=split /\|\|\|/, $helper->{'VARS'}->{'RESOURCES'};
3449: my ($type) = split(/_/,$print_type);
3450: &adjust_number_to_print($helper);
3451: my $number_per_page=$helper->{'VARS'}->{'NUMBER_TO_PRINT'};
3452: if ($number_per_page eq '0' || $number_per_page eq 'all'
3453: || $number_per_page eq 'section') {
3454: $number_per_page=$num_todo > 0 ? $num_todo : 1;
3455: }
3456: my $flag_latex_header_remove = 'NO';
3457: my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin($r,$num_todo);
3458: my $count=0;
3459: my $nohidemap;
3460: if ($perm{'pav'} && $perm{'vgr'}) {
3461: $nohidemap = 1;
3462: }
3463: foreach my $code (sort(@allcodes)) {
3464: my $file_num=int($count/$number_per_page);
3465: if ($code_type eq 'number') {
3466: $moreenv{'CODE'}=$code;
3467: } else {
3468: $moreenv{'CODE'}=&num_to_letters($code);
3469: }
3470: $env{'form.CODE'} = $moreenv{'CODE'};
3471: my $actual_seq = master_seq_to_person_seq($map, \@master_seq,
3472: undef,
3473: $moreenv{'CODE'}, $nohidemap);
3474: delete($env{'form.CODE'});
3475: my ($output,$fullname, $printed)=
3476: &print_resources($r,$helper,'anonymous',$type,\%moreenv,
3477: $actual_seq,$flag_latex_header_remove,
3478: $LaTeXwidth);
3479: $resources_printed .= ":";
3480: $print_array[$file_num].=$output;
3481: &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
3482: &mt('last assignment').' '.$fullname);
3483: $flag_latex_header_remove = 'YES';
3484: $count++;
3485: if (&Apache::loncommon::connection_aborted($r)) { last; }
3486: }
3487: &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
3488: $result .= $print_array[0].' \end{document}';
3489: } elsif ($print_type eq 'problems_from_directory') {
3490: #prints selected problems from the subdirectory
3491: $selectionmade = 6;
3492: my @list_of_files=split /\|\|\|/, $helper->{'VARS'}->{'FILES'};
3493: @list_of_files=sort @list_of_files;
3494: my $flag_latex_header_remove = 'NO';
3495: my $rndseed=time;
3496: if ($helper->{'VARS'}->{'curseed'}) {
3497: $rndseed=$helper->{'VARS'}->{'curseed'};
3498: }
3499: for (my $i=0;$i<=$#list_of_files;$i++) {
3500:
3501: &Apache::lonenc::reset_enc();
3502:
3503: my $urlp = $list_of_files[$i];
3504: $urlp=~s|//|/|;
3505: if ($urlp=~/\//) {
3506: $form{'problem_split'}=$parmhash{'problem_stream_switch'};
3507: $form{'rndseed'}=$rndseed;
3508: $urlp =~ s|^$Apache::lonnet::perlvar{'lonDocRoot'}||;
3509: $resources_printed .= $urlp.':';
3510: my $texversion=&ssi_with_retries($urlp, $ssi_retry_count, %form);
3511: if(($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') ||
3512: ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'only')) {
3513: # Don't permanently pervert %form:
3514: my %answerform = %form;
3515: $answerform{'grade_target'}='answer';
3516: $answerform{'answer_output_mode'}='tex';
3517: $answerform{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
3518: $answerform{'rndseed'}=$rndseed;
3519: $resources_printed .= $urlp.':';
3520: my $answer=&ssi_with_retries($urlp, $ssi_retry_count, %answerform);
3521: if ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') {
3522: $texversion=~s/(\\keephidden\{ENDOFPROBLEM})/$answer$1/;
3523: } else {
3524: $texversion=&print_latex_header($helper->{'VARS'}->{'LATEX_TYPE'});
3525: if ($helper->{'VARS'}->{'construction'} ne '1') {
3526: $texversion.='\vskip 0 mm \noindent ';
3527: $texversion.=&path_to_problem ($urlp,$LaTeXwidth);
3528: } else {
3529: $texversion.='\vskip 0 mm \noindent\textbf{'.
3530: &mt("Printing from Authoring Space: No Title").'}\vskip 0 mm ';
3531: $texversion.=&path_to_problem ($urlp,$LaTeXwidth);
3532: }
3533: $texversion.='\vskip 1 mm '.$answer.'\end{document}';
3534: }
3535: }
3536: #this chunk is responsible for printing the path to problem
3537:
3538: my $newurlp=&path_to_problem($urlp,$LaTeXwidth);
3539: $texversion =~ s/(\\begin\{minipage}\{\\textwidth})/$1 $newurlp/;
3540: if ($flag_latex_header_remove ne 'NO') {
3541: $texversion = &latex_header_footer_remove($texversion);
3542: } else {
3543: $texversion =~ s/\\end\{document}//;
3544: }
3545: if ($helper->{'VARS'}->{'TABLE_INDEX'} eq 'yes') {
3546: $texversion=&IndexCreation($texversion,$urlp);
3547: }
3548: if ($helper->{'VARS'}->{'CONSTR_RESOURSE_URL'} eq 'yes') {
3549: $texversion=~s/(\\addcontentsline\{toc\}\{subsection\}\{[^\}]*\})/$1 URL: \\verb|$urlp| \\strut\\\\\\strut /;
3550:
3551: }
3552: $result .= $texversion;
3553: }
3554: $flag_latex_header_remove = 'YES';
3555: }
3556: if ($helper->{VARS}->{'construction'} eq '1') {$result=~s/(\\typeout)/ RANDOM SEED IS $rndseed $1/;}
3557: $result .= '\end{document}';
3558: }
3559: #-------------------------------------------------------- corrections for the different page formats
3560:
3561: # Only post process if that has not been turned off e.g. by a raw latex resource.
3562:
3563: if ($do_postprocessing) {
3564: $result = &page_format_transformation($papersize,
3565: $laystyle,$numberofcolumns,
3566: $print_type,$result,
3567: $helper->{VARS}->{'assignment'},
3568: $helper->{'VARS'}->{'TABLE_CONTENTS'},
3569: $helper->{'VARS'}->{'TABLE_INDEX'},
3570: $selectionmade);
3571: $result = &latex_corrections($number_of_columns,$result,$selectionmade,
3572: $helper->{'VARS'}->{'ANSWER_TYPE'});
3573: #if ($numberofcolumns == 1) {
3574: $result =~ s/\\textwidth\s*=\s*-?\d*\.?\d*\s*(cm|mm|in)/\\textwidth= $helper->{'VARS'}->{'pagesize.width'} $helper->{'VARS'}->{'pagesize.widthunit'} /;
3575: $result =~ s/\\textheight\s*=?\s*-?\d*\.?\d*\s*(cm|mm|in)/\\textheight $helper->{'VARS'}->{'pagesize.height'} $helper->{'VARS'}->{'pagesize.heightunit'} /;
3576: $result =~ s/\\evensidemargin\s*=\s*-?\d*\.?\d*\s*(cm|mm|in)/\\evensidemargin= $helper->{'VARS'}->{'pagesize.lmargin'} $helper->{'VARS'}->{'pagesize.lmarginunit'} /;
3577: $result =~ s/\\oddsidemargin\s*=\s*-?\d*\.?\d*\s*(cm|mm|in)/\\oddsidemargin= $helper->{'VARS'}->{'pagesize.lmargin'} $helper->{'VARS'}->{'pagesize.lmarginunit'} /;
3578: #}
3579: }
3580:
3581: # Set URLback so we can provide a link back to the resource and to change options.
3582: # (Since the browser back button does not currently work with https,
3583: # the back link is useful even when there is an easy-to-miss LON-CAPA back button.)
3584:
3585: my $URLback=''; #link to original document
3586: if ($helper->{'VARS'}->{'construction'} eq '1') {
3587: $URLback=$helper->{'VARS'}->{'filename'};
3588: } elsif ($helper->{VARS}{'symb'}) {
3589: my ($map, $id, $url) = &Apache::lonnet::decode_symb($helper->{VARS}{'symb'});
3590: my $cdom =$env{'course.'.$env{'request.course.id'}.'.domain'};
3591: my $cnum =$env{'course.'.$env{'request.course.id'}.'.num'};
3592: my ($anchor,$usehttp,$plainurl);
3593: $url = &Apache::lonnet::clutter($url);
3594: $plainurl = $url;
3595: if (($ENV{'SERVER_PORT'} == 443) && ($env{'request.course.id'}) &&
3596: (($url =~ m{^\Q/public/$cdom/$cnum/syllabus\E($|\?)}) ||
3597: ($url =~ m{^\Q/adm/wrapper/ext/\E(?!https:)}))) {
3598: unless ((&Apache::lonnet::uses_sts()) || (&Apache::lonnet::waf_allssl())) {
3599: $usehttp = 1;
3600: }
3601: }
3602: if ($env{'request.enc'}) {
3603: $url = &Apache::lonenc::encrypted($url);
3604: }
3605: if ($url ne '') {
3606: my $symb = $helper->{VARS}{'symb'};
3607: if ($url =~ m{^\Q/adm/wrapper/ext/\E}) {
3608: my $link = $url;
3609: ($link,$anchor) = ($url =~ /^([^\#]+)(?:|(\#[^\#]+))$/);
3610: if ($anchor) {
3611: ($symb) = ($helper->{VARS}{'symb'} =~ /^([^\#]+)/);
3612: }
3613: $url = $link;
3614: }
3615: $URLback = $url;
3616: if ($usehttp) {
3617: $URLback .= (($URLback =~ /\?/) ? '&':'?').'usehttp=1';
3618: }
3619: unless ($plainurl =~ /\.page$/) {
3620: $URLback .= (($URLback =~ /\?/) ? '&':'?').'symb='.&escape($symb.$anchor);
3621: }
3622: }
3623: } elsif (($helper->{VARS}->{'postdata'} eq '/adm/navmaps') &&
3624: ($env{'request.course.id'})) {
3625: $URLback=$helper->{VARS}->{'postdata'};
3626: }
3627: #
3628: # Final adjustment of the font size:
3629: #
3630:
3631: $result = set_font_size($result);
3632:
3633: # Insert any babel headers required.
3634:
3635: $result = &collect_languages($result);
3636:
3637:
3638: #-- writing .tex file in prtspool
3639: my $temp_file;
3640: my $identifier = &Apache::loncommon::get_cgi_id();
3641: my $filename = "/home/httpd/prtspool/$env{'user.name'}_$env{'user.domain'}_printout_$identifier.tex";
3642: if (!($#print_array>0)) {
3643: unless ($temp_file = Apache::File->new('>'.$filename)) {
3644: $r->log_error("Couldn't open $filename for output $!");
3645: return SERVER_ERROR;
3646: }
3647: print $temp_file $result;
3648: my $begin=index($result,'\begin{document}',0);
3649: my $inc=substr($result,0,$begin+16);
3650: } else {
3651: my $begin=index($result,'\begin{document}',0);
3652: my $inc=substr($result,0,$begin+16);
3653: for (my $i=0;$i<=$#print_array;$i++) {
3654: if ($i==0) {
3655: $print_array[$i]=$result;
3656: } else {
3657: $print_array[$i].='\end{document}';
3658: $print_array[$i] =
3659: &latex_corrections($number_of_columns,$print_array[$i],
3660: $selectionmade,
3661: $helper->{'VARS'}->{'ANSWER_TYPE'});
3662:
3663: my $anobegin=index($print_array[$i],'\setcounter{page}',0);
3664: substr($print_array[$i],0,$anobegin)='';
3665: $print_array[$i]=$inc.$print_array[$i];
3666: }
3667: my $temp_file;
3668: my $newfilename=$filename;
3669: my $num=$i+1;
3670: $newfilename =~s/\.tex$//;
3671: $newfilename=sprintf("%s_%03d.tex",$newfilename, $num);
3672: unless ($temp_file = Apache::File->new('>'.$newfilename)) {
3673: $r->log_error("Couldn't open $newfilename for output $!");
3674: return SERVER_ERROR;
3675: }
3676: print $temp_file $print_array[$i];
3677: }
3678: }
3679: my $student_names='';
3680: if ($#print_array>0) {
3681: for (my $i=0;$i<=$#print_array;$i++) {
3682: $student_names.=$student_names[$i].'_ENDPERSON_';
3683: }
3684: } else {
3685: if ($#student_names>-1) {
3686: $student_names=$student_names[0].'_ENDPERSON_';
3687: } else {
3688: my $fullname = &get_name($env{'user.name'},$env{'user.domain'});
3689: $student_names=join(':',$env{'user.name'},$env{'user.domain'},
3690: $env{'request.course.sec'},$fullname).
3691: '_ENDPERSON_'.'_END_';
3692: }
3693: }
3694:
3695: # logic for now is too complex to trace if this has been defined
3696: # yet.
3697: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3698: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3699: &Apache::lonnet::appenv({'cgi.'.$identifier.'.file' => $filename,
3700: 'cgi.'.$identifier.'.layout' => $laystyle,
3701: 'cgi.'.$identifier.'.numcol' => $numberofcolumns,
3702: 'cgi.'.$identifier.'.paper' => $papersize,
3703: 'cgi.'.$identifier.'.selection' => $selectionmade,
3704: 'cgi.'.$identifier.'.tableofcontents' => $helper->{'VARS'}->{'TABLE_CONTENTS'},
3705: 'cgi.'.$identifier.'.tableofindex' => $helper->{'VARS'}->{'TABLE_INDEX'},
3706: 'cgi.'.$identifier.'.role' => $perm{'pav'},
3707: 'cgi.'.$identifier.'.numberoffiles' => $#print_array,
3708: 'cgi.'.$identifier.'.studentnames' => $student_names,
3709: 'cgi.'.$identifier.'.backref' => &escape($URLback),});
3710: &Apache::lonnet::appenv({"cgi.$identifier.user" => $env{'user.name'},
3711: "cgi.$identifier.domain" => $env{'user.domain'},
3712: "cgi.$identifier.courseid" => $cnum,
3713: "cgi.$identifier.coursedom" => $cdom,
3714: "cgi.$identifier.resources" => $resources_printed});
3715:
3716: my $end_page = &Apache::loncommon::end_page();
3717: my $continue_text = &mt('Continue');
3718: # If there's been an unrecoverable SSI error, report it to the user
3719: if ($ssi_error) {
3720: my $helpurl = &Apache::loncommon::top_nav_help('Helpdesk');
3721: $r->print('<br /><p class="LC_error">'.&mt('An unrecoverable network error occurred:').'</p><p>'.
3722: &mt('At least one of the resources you chose to print could not be rendered due to an unrecoverable error when communicating with a server:').
3723: '<br />'.$ssi_last_error_resource.'<br />'.$ssi_last_error.
3724: '</p><p>'.&mt('You can continue using the link provided below, but make sure to carefully inspect your output file! The errors will be marked in the file.').'<br />'.
3725: &mt('You may be able to reprint the individual resources for which this error occurred, as the issue may be temporary.').
3726: '<br />'.&mt('If the error persists, please contact the [_1] for assistance.',$helpurl).'</p><p>'.
3727: &mt('We apologize for the inconvenience.').'</p>'.
3728: '<a href="/cgi-bin/printout.pl?'.$identifier.'">'.$continue_text.'</a>'.$end_page);
3729: } else {
3730: $r->print(<<FINALEND);
3731: <br />
3732: <meta http-equiv="Refresh" content="0; url=/cgi-bin/printout.pl?$identifier" />
3733: <a href="/cgi-bin/printout.pl?$identifier">$continue_text</a>
3734: $end_page
3735: FINALEND
3736: } # endif ssi errors.
3737: }
3738:
3739:
3740: sub get_CODE {
3741: my ($all_codes,$num,$seed,$size,$type)=@_;
3742: my $max='1'.'0'x$size;
3743: my $newcode;
3744: while(1) {
3745: $newcode=sprintf("%0".$size."d",int(rand($max)));
3746: if (!exists($$all_codes{$newcode})) {
3747: $$all_codes{$newcode}=1;
3748: if ($type eq 'number' ) {
3749: return $newcode;
3750: } else {
3751: return &num_to_letters($newcode);
3752: }
3753: }
3754: }
3755: }
3756:
3757: sub print_resources {
3758: my ($r,$helper,$person,$type,$moreenv,$master_seq,$remove_latex_header,
3759: $LaTeXwidth)=@_;
3760: my $current_output = '';
3761: my $printed = '';
3762: my ($username,$userdomain,$usersection) = split /:/,$person;
3763: my $fullname = &get_name($username,$userdomain);
3764: my $namepostfix = "\\\\"; # Both anon and not anon should get the same vspace.
3765:
3766:
3767: #
3768: # Figure out if we need to filter the output by
3769: # the incomplete problems for that person
3770: #
3771: my $print_type = $helper->{'VARS'}->{'PRINT_TYPE'};
3772: my $print_incomplete = 0;
3773: if (($print_type eq 'map_incomplete_problems_people_seq') ||
3774: ($print_type eq 'incomplete_problems_selpeople_course')) {
3775: $print_incomplete = 1;
3776: }
3777: if ($person eq 'anonymous') {
3778: $namepostfix .=&mt('Name:')." ";
3779: $fullname = "CODE - ".$moreenv->{'CODE'};
3780: }
3781:
3782: # Fullname may have special latex characters that need \ prefixing:
3783: #
3784:
3785: my $i = 0;
3786: my $actually_printed = 0; # Count of resources printed.
3787: #goes through all resources, checks if they are available for
3788: #current student, and produces output
3789:
3790: &Apache::lonxml::clear_problem_counter();
3791: my %page_breaks = &get_page_breaks($helper);
3792: my $columns_in_format = (split(/\|/,$helper->{'VARS'}->{'FORMAT'}))[1];
3793: #
3794: # end each student with a
3795: # Special that allows the post processor to even out the page
3796: # counts later. Nasty problem this... it would be really
3797: # nice to put the special in as a postscript comment
3798: # e.g. \special{ps:\ENDOFSTUDENTSTAMP} unfortunately,
3799: # The special gets passed the \ and dvips puts it in the output file
3800: # so we will just rely on printout.pl to strip ENDOFSTUDENTSTAMP from the
3801: # postscript. Each ENDOFSTUDENTSTAMP will go on a line by itself.
3802: #
3803:
3804: my $syllabus_first = 0;
3805: my $current_assignment = "";
3806: my $assignment;
3807: my $courseidinfo = &get_course();
3808: my $possprint = scalar(@{$master_seq});
3809:
3810: foreach my $curresline (@{$master_seq}) {
3811: if (defined $page_breaks{$curresline}) {
3812: if($i != 0) {
3813: $current_output.= "\\newpage\n";
3814: }
3815: }
3816: $current_output .= &get_extra_vspaces($helper, $curresline);
3817: $i++;
3818: my ($map,$id,$res_url) = &Apache::lonnet::decode_symb($curresline);
3819:
3820: # See if we need to emit a new header:
3821:
3822: if ( !($type eq 'problems' &&
3823: ($curresline!~ m/$LONCAPA::assess_page_re/)) ) {
3824: if ($print_incomplete && !&incomplete($username, $userdomain, $res_url)) {
3825: next;
3826: }
3827: $actually_printed++; # we're going to print one.
3828:
3829: if (&Apache::lonnet::allowed('bre',$res_url)) {
3830: if ($res_url!~m|^ext/|
3831: && $res_url=~/\.(problem|exam|quiz|assess|survey|form|library|page|xml|html|htm|xhtml|xhtm)$/) {
3832: $printed .= $curresline.':';
3833: &Apache::lonxml::remember_problem_counter();
3834:
3835: my $rendered = &get_student_view_with_retries($curresline,$ssi_retry_count,$username,$userdomain,$env{'request.course.id'},'tex',$moreenv);
3836: if ($res_url =~ /\.page$/) {
3837: if ($remove_latex_header eq 'NO') {
3838: if (!($rendered =~ /\\begin\{document\}/)) {
3839: $rendered = &print_latex_header().$rendered;
3840: }
3841: }
3842: ;
3843: if ($remove_latex_header eq 'YES') {
3844: $rendered = &latex_header_footer_remove($rendered);
3845: } else {
3846: $rendered =~ s/\\end\{document}\d*//;
3847: }
3848: }
3849: if(($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') ||
3850: ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'only')) {
3851: # Use a copy of the hash so we don't pervert it on future loop passes.
3852: my %answerenv = %{$moreenv};
3853: $answerenv{'answer_output_mode'}='tex';
3854:
3855:
3856: $answerenv{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
3857:
3858: &Apache::lonxml::restore_problem_counter();
3859:
3860: my $ansrendered = &Apache::loncommon::get_student_answers($curresline,$username,$userdomain,$env{'request.course.id'},%answerenv);
3861:
3862: if ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') {
3863: $rendered=~s/(\\keephidden\{ENDOFPROBLEM})/$ansrendered$1/;
3864: } else {
3865:
3866:
3867: my $header =&print_latex_header($helper->{'VARS'}->{'LATEX_TYPE'});
3868: unless ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'only') {
3869: $header =~ s/\\begin\{document}//; #<<<<<
3870: }
3871: my $title = &Apache::lonnet::gettitle($curresline);
3872: $title = &Apache::lonxml::latex_special_symbols($title);
3873: my $body ='\vskip 0 mm \noindent\textbf{'.$title.'}\vskip 0 mm ';
3874: $body .=&path_to_problem($res_url,$LaTeXwidth);
3875: $body .='\vskip 1 mm '.$ansrendered;
3876: $body = &encapsulate_minipage($body,$answerenv{'problem_split'});
3877: $rendered = $header.$body;
3878: }
3879: }
3880: if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
3881: my $url = &Apache::lonnet::clutter($res_url);
3882: my $annotation = &annotate($url);
3883: $rendered =~ s/(\\keephidden\{ENDOFPROBLEM})/$annotation$1/;
3884: }
3885: my $junk;
3886: if ($remove_latex_header eq 'YES') {
3887: $rendered = &latex_header_footer_remove($rendered);
3888: } else {
3889: $rendered =~ s/\\end\{document}//;
3890: }
3891: $current_output .= $rendered;
3892: } elsif ($res_url=~/\/(smppg|syllabus|aboutme|bulletinboard|ext\.tool)$/) {
3893: if ($i == 1) {
3894: $syllabus_first = 1;
3895: }
3896: $printed .= $curresline.':';
3897: my $rendered = &get_student_view_with_retries($curresline,$ssi_retry_count,$username,$userdomain,$env{'request.course.id'},'tex',$moreenv);
3898: if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
3899: my $url = &Apache::lonnet::clutter($res_url);
3900: my $annotation = &annotate($url);
3901: $annotation =~ s/(\\end\{document})/$annotation$1/;
3902: }
3903: if ($remove_latex_header eq 'YES') {
3904: $rendered = &latex_header_footer_remove($rendered);
3905: } else {
3906: $rendered =~ s/\\end\{document}//;
3907: }
3908: $current_output .= $rendered.'\vskip 0.5mm\noindent\makebox[\textwidth/$number_of_columns][b]{\hrulefill}\strut \vskip 0 mm \strut ';
3909: } elsif($res_url =~ /\.pdf$/) {
3910: my $url = &Apache::lonnet::clutter($res_url);
3911: my $rendered = &include_pdf($url);
3912: if ($remove_latex_header ne 'NO') {
3913: $rendered = &latex_header_footer_remove($rendered);
3914: }
3915: $current_output .= $rendered;
3916: } else {
3917: my $rendered = &unsupported($res_url,$helper->{'VARS'}->{'LATEX_TYPE'},$curresline);
3918: if ($remove_latex_header ne 'NO') {
3919: $rendered = &latex_header_footer_remove($rendered);
3920: } else {
3921: $rendered =~ s/\\end\{document}//;
3922: }
3923: $current_output .= $rendered;
3924: }
3925: }
3926: $remove_latex_header = 'YES';
3927: }
3928: $assignment = &Apache::lonxml::latex_special_symbols(
3929: &Apache::lonnet::gettitle($map), 'header');
3930: if (($assignment ne $current_assignment) && ($assignment ne "")) {
3931: my $header_line = &format_page_header($LaTeXwidth, $parmhash{'print_header_format'},
3932: $assignment, $courseidinfo,
3933: $fullname, $usersection);
3934: my $header_start = ($columns_in_format == 1) ? '\lhead'
3935: : '\fancyhead[LO]';
3936: $header_line = $header_start.'{'.$header_line.'}';
3937: $current_output = $current_output . $header_line;
3938: $current_assignment = $assignment;
3939: }
3940:
3941: if (&Apache::loncommon::connection_aborted($r)) { last; }
3942: }
3943: # If we are printing incomplete it's possible we don't have
3944: # anything to print. The print subsystem is not so good at handling
3945: # that so we're going to generate a stub that says there are no
3946: # incomplete resources for the person.
3947: #
3948:
3949: if ($actually_printed == 0) {
3950: my $message = &mt('No resources to print');
3951: if (!$possprint) {
3952: if ($perm{'pav'} || $perm{'pfo'}) {
3953: $message = &mt('There are no unhidden resources to print.')."\n\n".
3954: &mt('The most likely reason is one of the following: ')."\n".
3955: '\begin{itemize}'."\n".
3956: '\item '.&mt("The 'Resource hidden from students' parameter is set for the folder being printed.")."\n".
3957: '\item '.&mt("'Hidden' is checked in the Course Editor individually for each resource in the folder being printed.")."\n".
3958: '\end{itemize}'."\n\n".
3959: &mt("Note: to print a bubblesheet exam which you want to hide from students, ".
3960: "use the Course Editor to check the 'Hidden' checkbox for the exam folder itself.")."\n";
3961: }
3962: } elsif ($print_incomplete) {
3963: $message = &mt('No incomplete resources');
3964: }
3965: if ($message) {
3966: $current_output = &encapsulate_minipage("\\vskip -10mm \n$message\n \\vskip 100 mm { }\n",$moreenv->{'problem_split'});
3967: }
3968: if ($remove_latex_header eq "NO") {
3969: $current_output = &print_latex_header() . $current_output;
3970: } else {
3971: $current_output = &latex_header_footer_remove($current_output);
3972: }
3973: }
3974:
3975: if ($syllabus_first) {
3976: $current_output =~ s/\\\\ Last updated:/Last updated:/
3977: }
3978: my $currentassignment=&Apache::lonxml::latex_special_symbols($helper->{VARS}->{'assignment'},'header');
3979: my $header_line =
3980: &format_page_header($LaTeXwidth, $parmhash{'print_header_format'},
3981: $currentassignment, $courseidinfo, $fullname, $usersection);
3982: my $header_start = ($columns_in_format == 1) ? '\lhead' : '\fancyhead[LO]';
3983: my $newheader = $header_start.'{'.$header_line.'}';
3984: if ($current_output=~/\\documentclass/) {
3985: $current_output =~ s/\\begin\{document}/\\setlength{\\topmargin}{1cm} \\begin{document}\\noindent\\parbox{\\minipagewidth}{\\noindent$newheader$namepostfix}\\vskip 5 mm /;
3986:
3987: } else {
3988: my $blankpages =
3989: '\clearpage\strut\clearpage'x$helper->{'VARS'}->{'EMPTY_PAGES'};
3990:
3991: $current_output = '\strut\vspace*{-6 mm}\\newline'.
3992: ©right_line().' \newpage '.$blankpages.$end_of_student.
3993: '\setcounter{page}{1}\noindent\parbox{\minipagewidth}{\noindent'.
3994: $newheader.$namepostfix. '} \vskip 5 mm '.$current_output;
3995:
3996: }
3997: #
3998: # Close the student bracketing.
3999: #
4000: return ($current_output,$fullname, $printed);
4001:
4002: }
4003:
4004: sub printing_blocked {
4005: my ($r,$blocktext) = @_;
4006: my $title = &mt('Preparing Printout');
4007: &Apache::lonhtmlcommon::clear_breadcrumbs();
4008: &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/printout',
4009: text=> $title});
4010: my $breadcrumbs = &Apache::lonhtmlcommon::breadcrumbs($title);
4011: &Apache::loncommon::content_type($r,'text/html');
4012: &Apache::loncommon::no_cache($r);
4013: $r->send_http_header;
4014: $r->print(&Apache::loncommon::start_page('Preparing Printout').
4015: $breadcrumbs.
4016: $blocktext.
4017: &Apache::loncommon::end_page());
4018: return;
4019: }
4020:
4021: sub handler {
4022:
4023: my $r = shift;
4024:
4025: if ($env{'request.course.id'}) {
4026: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4027: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4028: my $clientip = &Apache::lonnet::get_requestor_ip($r);
4029: my ($blocked,$blocktext) =
4030: &Apache::loncommon::blocking_status('printout',$clientip,$cnum,$cdom);
4031: if ($blocked) {
4032: my $checkrole = "cm./$cdom/$cnum";
4033: if ($env{'request.course.sec'} ne '') {
4034: $checkrole .= "/$env{'request.course.sec'}";
4035: }
4036: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
4037: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
4038: &printing_blocked($r,$blocktext);
4039: return OK;
4040: }
4041: }
4042: }
4043:
4044: &init_perm();
4045: my $helper = printHelper($r);
4046: if (!ref($helper)) {
4047: return $helper;
4048: }
4049:
4050:
4051: %parmhash=&Apache::lonnet::coursedescription($env{'request.course.id'});
4052:
4053:
4054:
4055:
4056: # If a figure conversion queue file exists for this user.domain
4057: # we delete it since it can only be bad (if it were good, printout.pl
4058: # would have deleted it the last time around.
4059:
4060: my $conversion_queuefile = "/home/httpd/prtspool/$env{'user.name'}_$env{'user.domain'}_printout.dat";
4061: if(-e $conversion_queuefile) {
4062: unlink $conversion_queuefile;
4063: }
4064:
4065:
4066: &output_data($r,$helper,\%parmhash);
4067: return OK;
4068: }
4069:
4070: use Apache::lonhelper;
4071:
4072: sub addMessage {
4073: my $text = shift;
4074: my $paramHash = Apache::lonhelper::getParamHash();
4075: $paramHash->{MESSAGE_TEXT} = $text;
4076: Apache::lonhelper::message->new();
4077: }
4078:
4079:
4080:
4081: sub init_perm {
4082: undef(%perm);
4083: $perm{'pav'}=&Apache::lonnet::allowed('pav',$env{'request.course.id'});
4084: if (!$perm{'pav'}) {
4085: $perm{'pav'}=&Apache::lonnet::allowed('pav',
4086: $env{'request.course.id'}.'/'.$env{'request.course.sec'});
4087: }
4088: $perm{'pfo'}=&Apache::lonnet::allowed('pfo',$env{'request.course.id'});
4089: if (!$perm{'pfo'}) {
4090: $perm{'pfo'}=&Apache::lonnet::allowed('pfo',
4091: $env{'request.course.id'}.'/'.$env{'request.course.sec'});
4092: }
4093: $perm{'vgr'}=&Apache::lonnet::allowed('vgr',$env{'request.course.id'});
4094: if (!$perm{'vgr'}) {
4095: $perm{'vgr'}=&Apache::lonnet::allowed('vgr',
4096: $env{'request.course.id'}.'/'.$env{'request.course.sec'});
4097: }
4098: }
4099:
4100: sub get_randomly_ordered_warning {
4101: my ($helper,$map) = @_;
4102:
4103: my $message;
4104:
4105: my $postdata = $env{'form.postdata'} || $helper->{VARS}{'postdata'};
4106: my $navmap = Apache::lonnavmaps::navmap->new();
4107: if (defined($navmap)) {
4108: my $res = $navmap->getResourceByUrl($map);
4109: if ($res) {
4110: my $func =
4111: sub { return ($_[0]->is_map() && $_[0]->randomorder); };
4112: my @matches = $navmap->retrieveResources($res, $func,1,1,1);
4113:
4114: }
4115: } else {
4116: $message = "Retrieval of information about ordering of resources failed.";
4117: return '<message type="warning">'.$message.'</message>';
4118: }
4119: return;
4120: }
4121:
4122: sub printHelper {
4123: my $r = shift;
4124:
4125: if ($r->header_only) {
4126: if ($env{'browser.mathml'}) {
4127: &Apache::loncommon::content_type($r,'text/xml');
4128: } else {
4129: &Apache::loncommon::content_type($r,'text/html');
4130: }
4131: $r->send_http_header;
4132: return OK;
4133: }
4134:
4135: # Send header, nocache
4136: if ($env{'browser.mathml'}) {
4137: &Apache::loncommon::content_type($r,'text/xml');
4138: } else {
4139: &Apache::loncommon::content_type($r,'text/html');
4140: }
4141: &Apache::loncommon::no_cache($r);
4142: $r->send_http_header;
4143: $r->rflush();
4144:
4145: # Unfortunately, this helper is so complicated we have to
4146: # write it by hand
4147:
4148: Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
4149:
4150: my $helper = Apache::lonhelper::helper->new("Printing Helper");
4151: $helper->declareVar('symb');
4152: $helper->declareVar('postdata');
4153: $helper->declareVar('curseed');
4154: $helper->declareVar('probstatus');
4155: $helper->declareVar('filename');
4156: $helper->declareVar('construction');
4157: $helper->declareVar('assignment');
4158: $helper->declareVar('style_file');
4159: $helper->declareVar('student_sort');
4160: $helper->declareVar('FINISHPAGE');
4161: $helper->declareVar('PRINT_TYPE');
4162: $helper->declareVar("showallfoils");
4163: $helper->declareVar("STUDENTS");
4164: $helper->declareVar("EXTRASPACE");
4165:
4166:
4167:
4168:
4169: # The page breaks and extra spaces
4170: # can get loaded initially from the course environment:
4171: # But we only do this in the initial state so that they are allowed to change.
4172: #
4173:
4174:
4175: &Apache::loncommon::restore_course_settings('print',
4176: {'pagebreaks' => 'scalar',
4177: 'extraspace' => 'scalar',
4178: 'extraspace_units' => 'scalar',
4179: 'lastprinttype' => 'scalar'});
4180:
4181: # This will persistently load in the data we want from the
4182: # very first screen.
4183:
4184: if($helper->{VARS}->{PRINT_TYPE} eq $env{'form.lastprinttype'}) {
4185: if (!defined ($env{"form.CURRENT_STATE"})) {
4186:
4187: $helper->{VARS}->{FINISHPAGE} = $env{'form.pagebreaks'};
4188: $helper->{VARS}->{EXTRASPACE} = $env{'form.extraspace'};
4189: $helper->{VARS}->{EXTRASPACE_UNITS} = $env{'form.extraspace_units'};
4190: } else {
4191: my $state = $env{"form.CURRENT_STATE"};
4192: if ($state eq "START") {
4193: $helper->{VARS}->{FINISHPAGE} = $env{'form.pagebreaks'};
4194: $helper->{VARS}->{EXTRASPACE} = $env{'form.extraspace'};
4195: $helper->{VARS}->{EXTRASPACE_UNITS} = $env{'form.extraspace_units'};
4196:
4197: }
4198: }
4199:
4200: }
4201:
4202: # Detect whether we're coming from construction space
4203: if ($env{'form.postdata'}=~m{^/priv}) {
4204: $helper->{VARS}->{'filename'} = $env{'form.postdata'};
4205: $helper->{VARS}->{'construction'} = 1;
4206: } else {
4207: if ($env{'form.postdata'}) {
4208: unless ($env{'form.postdata'} eq '/adm/navmaps') {
4209: $helper->{VARS}->{'symb'} = &Apache::lonnet::symbread($env{'form.postdata'});
4210: }
4211: if ( $helper->{VARS}->{'symb'} eq '') {
4212: $helper->{VARS}->{'postdata'} = $env{'form.postdata'};
4213: }
4214: }
4215: if ($env{'form.symb'}) {
4216: $helper->{VARS}->{'symb'} = $env{'form.symb'};
4217: }
4218: if ($env{'form.url'}) {
4219: unless ($env{'form.url'} eq '/adm/navmaps') {
4220: $helper->{VARS}->{'symb'} = &Apache::lonnet::symbread($helper->{VARS}->{'postdata'});
4221: }
4222: }
4223: }
4224:
4225: if ($helper->{VARS}->{'symb'} ne '') {
4226: $helper->{VARS}->{'symb'}=
4227: &Apache::lonenc::check_encrypt($helper->{VARS}->{'symb'});
4228: }
4229: my ($resourceTitle,$sequenceTitle,$mapTitle,$cdom,$cnum);
4230: if ($helper->{VARS}->{'postdata'} eq '/adm/navmaps') {
4231: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4232: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4233: if ($env{'course.'.$env{'request.course.id'}.'.url'} eq
4234: "uploaded/$cdom/$cnum/default.sequence") {
4235: my $navmap = Apache::lonnavmaps::navmap->new();
4236: if (ref($navmap)) {
4237: my @toplevelres = $navmap->retrieveResources('',sub { !(($_[0]->is_map()) || ($_[0]->src =~ /^\/adm\/navmaps/)) },0,0);
4238: if (@toplevelres) {
4239: my @printable;
4240: if ($perm{'pav'} || $perm{'pfo'}) {
4241: @printable = @toplevelres;
4242: } else {
4243: @printable = $navmap->retrieveResources(undef,sub { $_[0]->resprintable() },0,1);
4244: }
4245: if (@printable) {
4246: $sequenceTitle = 'Main Content';
4247: $mapTitle = $sequenceTitle;
4248: }
4249: }
4250: }
4251: }
4252: } else {
4253: ($resourceTitle,$sequenceTitle,$mapTitle) = &details_for_menu($helper);
4254: }
4255: if ($sequenceTitle ne '') {$helper->{VARS}->{'assignment'}=$sequenceTitle;}
4256:
4257:
4258: # Extract map
4259: my $symb = $helper->{VARS}->{'symb'};
4260: my ($map, $id, $url);
4261: my $subdir;
4262: my $is_published=0; # True when printing from resource space.
4263: my $res_printable = 1; # By default the current resource is printable.
4264: my $res_error;
4265: my $userCanPrint = ($perm{'pav'} || $perm{'pfo'});
4266: my $res_printstartdate;
4267: my $res_printenddate;
4268: my $map_open = 0;
4269: my $map_close = 0xffffffff;
4270: my $course_open = 0;
4271: my $course_close = 0xffffffff;
4272:
4273: # Get the resource name from construction space
4274: if ($helper->{VARS}->{'construction'}) {
4275: $resourceTitle = substr($helper->{VARS}->{'filename'},
4276: rindex($helper->{VARS}->{'filename'}, '/')+1);
4277: $subdir = substr($helper->{VARS}->{'filename'},
4278: 0, rindex($helper->{VARS}->{'filename'}, '/') + 1);
4279: } else {
4280: # From course space:
4281:
4282: if ($symb ne '') {
4283: ($map, $id, $url) = &Apache::lonnet::decode_symb($symb);
4284: $helper->{VARS}->{'postdata'} =
4285: &Apache::lonenc::check_encrypt(&Apache::lonnet::clutter($url));
4286: } elsif (($helper->{VARS}->{'postdata'} eq '/adm/navmaps') &&
4287: ($env{'request.course.id'} ne '')) {
4288: if ($env{'course.'.$env{'request.course.id'}.'.url'} eq
4289: "uploaded/$cdom/$cnum/default.sequence") {
4290: $map = $env{'course.'.$env{'request.course.id'}.'.url'};
4291: $url = $helper->{VARS}->{'postdata'};
4292: }
4293: }
4294: if (($symb ne '') || ($map ne '')) {
4295: if (!$userCanPrint) {
4296: my $navmap = Apache::lonnavmaps::navmap->new();
4297: if (ref($navmap)) {
4298: my $res;
4299: if ($symb ne '') {
4300: $res = $navmap->getBySymb($symb);
4301: } elsif ($map ne '') {
4302: $res = $navmap->getResourceByUrl($map);
4303: }
4304: if (ref($res)) {
4305: $res_printable = $res->resprintable(); #printability in course context
4306: ($res_printstartdate, $res_printenddate) = &get_print_dates($res);
4307: ($course_open, $course_close) = &course_print_dates($res);
4308: ($map_open, $map_close) = &map_print_dates($res);
4309: } else {
4310: $res_error = 1;
4311: }
4312: } else {
4313: $res_error = 1;
4314: }
4315: }
4316: } else {
4317: # Resource space.
4318:
4319: $url = $helper->{VARS}->{'postdata'};
4320: $is_published=1; # From resource space.
4321: }
4322: $url = &Apache::lonnet::clutter($url);
4323: if (!$resourceTitle) { # if the resource doesn't have a title, use the filename
4324: my $postdata = $helper->{VARS}->{'postdata'};
4325: $resourceTitle = substr($postdata, rindex($postdata, '/') + 1);
4326: }
4327: if (($url eq '/adm/navmaps') && ($map eq $env{'course.'.$env{'request.course.id'}.'.url'})) {
4328: $res_printable=0;
4329: } else {
4330: $subdir = &Apache::lonnet::filelocation("", $url);
4331: }
4332:
4333:
4334: }
4335: if (!$helper->{VARS}->{'curseed'} && $env{'form.curseed'}) {
4336: $helper->{VARS}->{'curseed'}=$env{'form.curseed'};
4337: }
4338:
4339: if (!$helper->{VARS}->{'probstatus'} && $env{'form.problemtype'}) {
4340: $helper->{VARS}->{'probstatus'}=$env{'form.problemstatus'};
4341: }
4342:
4343: my $userCanSeeHidden = Apache::lonnavmaps::advancedUser();
4344:
4345: Apache::lonhelper::registerHelperTags();
4346:
4347: # "Delete everything after the last slash."
4348: $subdir =~ s|/[^/]+$||;
4349:
4350: # What can be printed is a very dynamic decision based on
4351: # lots of factors. So we need to dynamically build this list.
4352: # To prevent security leaks, states are only added to the wizard
4353: # if they can be reached, which ensures manipulating the form input
4354: # won't allow anyone to reach states they shouldn't have permission
4355: # to reach.
4356:
4357: # printChoices is tracking the kind of printing the user can
4358: # do, and will be used in a choices construction later.
4359: # In the meantime we will be adding states and elements to
4360: # the helper by hand.
4361: my $printChoices = [];
4362: my $paramHash;
4363:
4364: # If there is a current resource and it is printable
4365: # Give that as a choice.
4366:
4367: if ($resourceTitle && $res_printable) {
4368: push @{$printChoices}, ["<b><i>$resourceTitle</i></b> (".&mt('the resource you just saw on the screen').")", 'current_document', 'PAGESIZE'];
4369: }
4370:
4371: # Useful filter strings
4372:
4373: my $isPrintable = ' && $res->resprintable()';
4374:
4375: my $isProblem = '(($res->is_problem()||$res->contains_problem() ||$res->is_practice()))';
4376: $isProblem .= $isPrintable unless $userCanPrint;
4377: $isProblem .= ' && !$res->randomout()' if !$userCanSeeHidden;
4378: my $isProblemOrMap = '($res->is_problem() || $res->contains_problem() || $res->is_sequence() || $res->is_practice())';
4379: $isProblemOrMap .= $isPrintable unless $userCanPrint;
4380: my $isNotMap = '(!$res->is_sequence())';
4381: $isNotMap .= $isPrintable unless $userCanPrint;
4382: $isNotMap .= ' && !$res->randomout()' if !$userCanSeeHidden;
4383: my $isMap = '$res->is_map()';
4384: $isMap .= $isPrintable unless $userCanPrint;
4385: my $symbFilter = '$res->shown_symb() ';
4386: my $urlValue = '$res->link()';
4387:
4388: $helper->declareVar('SEQUENCE');
4389:
4390: # If we're in a sequence...
4391:
4392: my $start_new_option;
4393: if ($perm{'pav'}) {
4394: $start_new_option =
4395: "<option text='".&mt('Start new page[_1]before selected','<br />').
4396: "' variable='FINISHPAGE' />".
4397: "<option text='".&mt('Extra space[_1]before selected','<br />').
4398: "' variable='EXTRASPACE' type='text' />" .
4399: "<option " .
4400: "' variable='POSSIBLE_RESOURCES' type='hidden' />".
4401: "<option text='".&mt('Space units[_1]check for mm','<br />').
4402: "' variable='EXTRASPACE_UNITS' type='checkbox' />"
4403: ;
4404:
4405:
4406: }
4407:
4408: # If not construction space user can print the components of a page:
4409:
4410: my $page_ispage;
4411: my $page_title;
4412: if (!$helper->{VARS}->{'construction'}) {
4413: my $varspostdata = $helper->{VARS}->{'postdata'};
4414: my $varsassignment = $helper->{VARS}->{'assignment'};
4415: my $page_navmap = Apache::lonnavmaps::navmap->new();
4416: if (defined($page_navmap)) {
4417: my @page_resources = $page_navmap->retrieveResources($url);
4418: if(defined($page_resources[0])) {
4419: $page_ispage = $page_resources[0]->is_page();
4420: $page_title = $page_resources[0]->title();
4421: my $resourcesymb = $page_resources[0]->symb();
4422: my ($pagemap, $pageid, $pageurl) = &Apache::lonnet::decode_symb($symb);
4423: if ($page_ispage) {
4424: push @{$printChoices},
4425: [&mt('Selected [_1]Problems[_2] from page [_3]', '<b>', '</b>', '<b><i>'.$page_title.'</i></b>'),
4426: 'map_problems_in_page',
4427: 'CHOOSE_PROBLEMS_PAGE'];
4428: push @{$printChoices},
4429: [&mt('Selected [_1]Resources[_2] from page [_3]', '<b>', '</b>', '<b><i>'.$page_title.'</i></b>'),
4430: 'map_resources_in_page',
4431: 'CHOOSE_RESOURCES_PAGE'];
4432: }
4433: my $helperFragment = &generate_resource_chooser('CHOOSE_PROBLEMS_PAGE',
4434: 'Select Problem(s) to print',
4435: "multichoice='1' toponly='1' addstatus='1' closeallpages='1' modallink='1'",
4436: 'RESOURCES',
4437: 'PAGESIZE',
4438: $url,
4439: $isProblem, '', $symbFilter,
4440: $start_new_option);
4441:
4442:
4443: $helperFragment .= &generate_resource_chooser('CHOOSE_RESOURCES_PAGE',
4444: 'Select Resource(s) to print',
4445: 'multichoice="1" toponly="1" addstatus="1" closeallpages="1" modallink="1" suppressNavmap="1"',
4446: 'RESOURCES',
4447: 'PAGESIZE',
4448: $url,
4449: $isNotMap, '', $symbFilter,
4450: $start_new_option);
4451:
4452:
4453:
4454:
4455:
4456: &Apache::lonxml::xmlparse($r, 'helper', $helperFragment);
4457:
4458: }
4459: }
4460: }
4461:
4462: if (($helper->{'VAR'}->{'construction'} ne '1' ) &&
4463: $helper->{VARS}->{'postdata'} &&
4464: $helper->{VARS}->{'assignment'}) {
4465:
4466: # BZ 5209 - Print incomplete problems from sequence:
4467: # the exact form of this depends on whether or not we are privileged or a mere
4468: # plebe of s student:
4469:
4470: my $optionText = '';
4471: my $printSelector = 'map_incomplete_problems_seq';
4472: my $nextState = 'CHOOSE_INCOMPLETE_SEQ';
4473: my $textSuffix = '';
4474: my $nocurrloc = '';
4475: if ($helper->{VARS}->{'postdata'} eq '/adm/navmaps') {
4476: $nocurrloc = 1;
4477: }
4478:
4479: if ($userCanPrint) {
4480: $printSelector = 'map_incomplete_problems_people_seq';
4481: $nextState = 'CHOOSE_INCOMPLETE_PEOPLE_SEQ';
4482: $textSuffix = ' for selected students';
4483: my $helperStates =
4484: &create_incomplete_folder_selstud_helper($helper, $map, $nocurrloc);
4485: &Apache::lonxml::xmlparse($r, 'helper', $helperStates);
4486: } else {
4487: if (&printable($map_open, $map_close)) {
4488: my $helperStates = &create_incomplete_folder_helper($helper, $map, $nocurrloc); # Create needed states for student.
4489: &Apache::lonxml::xmlparse($r, 'helper', $helperStates);
4490: } else {
4491: # TODO: Figure out how to break the news...this folder is not printable.
4492: }
4493: }
4494:
4495: if ($userCanPrint || &printable($map_open, $map_close)) {
4496: if ($helper->{VARS}->{'postdata'} eq '/adm/navmaps') {
4497: $optionText = &mt('Selected [_1]Incomplete Problems[_2] [_3]not in a folder[_4]' . $textSuffix,
4498: '<b>','</b>','<i>','</i>');
4499: } else {
4500: $optionText = &mt('Selected [_1]Incomplete Problems[_2] from folder [_3]' . $textSuffix,
4501: '<b>','</b>','<b><i>'.$sequenceTitle.'</b></i>');
4502: }
4503: push(@{$printChoices},
4504: [$optionText,
4505: $printSelector,
4506: $nextState]);
4507: }
4508: # Allow problems from sequence
4509: if ($userCanPrint || &printable($map_open, $map_close)) {
4510: if ($helper->{VARS}->{'postdata'} eq '/adm/navmaps') {
4511: $optionText = &mt('Selected [_1]Problems[_2] [_3]not in a folder[_4]','<b>','</b>','<i>','</i>');
4512: } else {
4513: $optionText = &mt('Selected [_1]Problems[_2] from folder [_3]','<b>','</b>','<b><i>'.$sequenceTitle.'</i></b>');
4514: }
4515: push @{$printChoices},
4516: [$optionText,
4517: 'map_problems',
4518: 'CHOOSE_PROBLEMS'];
4519: # Allow all resources from sequence
4520: if ($helper->{VARS}->{'postdata'} eq '/adm/navmaps') {
4521: $optionText = &mt('Selected [_1]Resources[_2] [_3]not in a folder[_4]','<b>','</b>','<i>','</i>');
4522: } else {
4523: $optionText = &mt('Selected [_1]Resources[_2] from folder [_3]','<b>','</b>','<b><i>'.$sequenceTitle.'</i></b>');
4524: }
4525: push @{$printChoices}, [$optionText,
4526: 'map_problems_pages',
4527: 'CHOOSE_PROBLEMS_HTML'];
4528: my $helperFragment = &generate_resource_chooser('CHOOSE_PROBLEMS',
4529: 'Select Problem(s) to print',
4530: 'multichoice="1" toponly="1" addstatus="1" closeallpages="1" modallink="1" nocurrloc="'.$nocurrloc.'"',
4531: 'RESOURCES',
4532: 'PAGESIZE',
4533: $map,
4534: $isProblem, '',
4535: $symbFilter,
4536: $start_new_option);
4537: $helperFragment .= &generate_resource_chooser('CHOOSE_PROBLEMS_HTML',
4538: 'Select Resource(s) to print',
4539: 'multichoice="1" toponly="1" addstatus="1" closeallpages="1" modallink="1" nocurrloc="'.$nocurrloc.'" suppressNavmap="1"',
4540: 'RESOURCES',
4541: 'PAGESIZE',
4542: $map,
4543: $isNotMap, '',
4544: $symbFilter,
4545: $start_new_option);
4546:
4547: &Apache::lonxml::xmlparse($r, 'helper', $helperFragment);
4548: } else {
4549: # TODO: Figure out how to tell them the folder is not printable.
4550: }
4551: }
4552: # If the user has pfo (print for others) allow them to print all
4553: # problems and resources in the entire course, optionally for selected students
4554: my $post_data = $helper->{VARS}->{'postdata'};
4555:
4556: if ($perm{'pfo'} && !$is_published &&
4557: ($post_data=~/\/res\// || $post_data =~/\/(syllabus|smppg|aboutme|bulletinboard)$/)) {
4558:
4559: # BZ 5209 - incomplete problems from entire course:
4560:
4561: push(@{$printChoices},
4562: [&mt('Selected [_1]Incomplete Problems[_2] from [_3]entire course[_4] for [_5]selected people[_6]',
4563: '<b>','</b>','<b>','</b>','<b>','</b>'),
4564: 'incomplete_problems_selpeople_course', 'INCOMPLETE_PROBLEMS_COURSE_RESOURCES']);
4565: my $helperFragment = &create_incomplete_course_helper($helper); # Create needed states.
4566:
4567: &Apache::lonxml::xmlparse($r, 'helper', $helperFragment);
4568:
4569: # Selected problems/resources from entire course:
4570:
4571: push @{$printChoices}, [&mt('Selected [_1]Problems[_2] from [_3]entire course[_4]','<b>','</b>','<b>','</b>'), 'all_problems', 'ALL_PROBLEMS'];
4572: push @{$printChoices}, [&mt('Selected [_1]Resources[_2] from [_3]entire course[_4]','<b>','</b>','<b>','</b>'), 'all_resources', 'ALL_RESOURCES'];
4573: push @{$printChoices}, [&mt('Selected [_1]Problems[_2] from [_3]entire course[_4] for [_5]selected people[_6]','<b>','</b>','<b>','</b>','<b>','</b>'), 'all_problems_students', 'ALL_PROBLEMS_STUDENTS'];
4574: my $suffixXml = <<ALL_PROBLEMS;
4575: <state name="STUDENTS1" title="Select People">
4576: <message><b>Select sorting order of printout</b> </message>
4577: <choices variable='student_sort'>
4578: <choice computer='0'>Sort by section then student</choice>
4579: <choice computer='1'>Sort by students across sections.</choice>
4580: </choices>
4581: <message><br /><hr /><br /> </message>
4582: <student multichoice='1' variable="STUDENTS" nextstate="PRINT_FORMATTING" coursepersonnel="1"/>
4583: </state>
4584: ALL_PROBLEMS
4585: &Apache::lonxml::xmlparse($r, 'helper',
4586: &generate_resource_chooser('ALL_PROBLEMS',
4587: 'Select Problem(s) to print',
4588: 'multichoice="1" suppressEmptySequences="0" addstatus="1" closeallpages="1" modallink="1"',
4589: 'RESOURCES',
4590: 'PAGESIZE',
4591: '',
4592: $isProblemOrMap, $isNotMap,
4593: $symbFilter,
4594: $start_new_option) .
4595: &generate_resource_chooser('ALL_RESOURCES',
4596: 'Select Resource(s) to print',
4597: 'toponly="0" multichoice="1" suppressEmptySequences="0" addstatus="1" closeallpages="1" modallink="1" suppressNavmap="1"',
4598: 'RESOURCES',
4599: 'PAGESIZE',
4600: '',
4601: $isNotMap,'',$symbFilter,
4602: $start_new_option) .
4603: &generate_resource_chooser('ALL_PROBLEMS_STUDENTS',
4604: 'Select Problem(s) to print',
4605: 'toponly="0" multichoice="1" suppressEmptySequences="0" addstatus="1" closeallpages="1" modallink="1"',
4606: 'RESOURCES',
4607: 'STUDENTS1',
4608: '',
4609: $isProblemOrMap,'' , $symbFilter,
4610: $start_new_option) .
4611: $suffixXml
4612: );
4613:
4614: if ($helper->{VARS}->{'assignment'}) {
4615:
4616: # If we were looking at a page, allow a selection of problems from the page
4617: # either for selected students or for coded assignments.
4618:
4619: if ($page_ispage) {
4620: push @{$printChoices}, [&mt('Selected [_1]Problems[_2] from page [_3] for [_4]selected people[_5]',
4621: '<b>', '</b>', '<b><i>'.$page_title.'</i></b>', '<b>', '</b>'),
4622: 'problems_for_students_from_page', 'CHOOSE_TGT_STUDENTS_PAGE'];
4623: push @{$printChoices}, [&mt('Selected [_1]Problems[_2] from page [_3] for [_4]CODEd assignments[_5]',
4624: '<b>', '</b>', '<b><i>'.$page_title.'</i></b>', '<b>', '</b>'),
4625: 'problems_for_anon_page', 'CHOOSE_ANON1_PAGE'];
4626: }
4627: push @{$printChoices}, [&mt('Selected [_1]Problems[_2] from folder [_3] for [_4]selected people[_5]',
4628: '<b>','</b>','<b><i>'.$sequenceTitle.'</i></b>','<b>','</b>'),
4629: 'problems_for_students', 'CHOOSE_STUDENTS'];
4630: push @{$printChoices}, [&mt('Selected [_1]Problems[_2] from folder [_3] for [_4]CODEd assignments[_5]',
4631: '<b>','</b>','<b><i>'.$sequenceTitle.'</i></b>','<b>','</b>'),
4632: 'problems_for_anon', 'CHOOSE_ANON1'];
4633: }
4634:
4635: my ($randomly_ordered_warning,$codechoice,$code_selection,$namechoice) =
4636: &generate_common_choosers($r,$helper,$map,$url,$isProblem,$symbFilter,$start_new_option);
4637:
4638: if ($helper->{VARS}->{'assignment'}) {
4639:
4640: # Assignment printing:
4641:
4642: push @{$printChoices}, [&mt('Selected [_1]Resources[_2] from folder [_3] for [_4]selected people[_5]','<b>','</b>','<b><i>'.$sequenceTitle.'</i></b>','<b>','</b>'), 'resources_for_students', 'CHOOSE_STUDENTS1'];
4643: push @{$printChoices}, [&mt('Selected [_1]Resources[_2] from folder [_3] for [_4]CODEd assignments[_5]','<b>','</b>','<b><i>'.$sequenceTitle.'</i></b>','<b>','</b>'), 'resources_for_anon', 'CHOOSE_ANON2'];
4644: }
4645:
4646: # resource_selector will hold a few states that:
4647: # - Allow resources to be selected for printing.
4648: # - Determine pagination between assignments.
4649: # - Determine how many assignments should be bundled into a single PDF.
4650: # TODO:
4651: # Probably good to do things like separate this up into several vars, each
4652: # with one state, and use REGEXPs at inclusion time to set state names
4653: # and next states for better mix and match capability
4654: #
4655:
4656: my $resource_selector=<<RESOURCE_SELECTOR;
4657: <state name="SELECT_RESOURCES" title="Select Resources">
4658: $randomly_ordered_warning
4659: <nextstate>PRINT_FORMATTING</nextstate>
4660: <message><br /><big><i><b>Select resources for the assignment</b></i></big><br /></message>
4661: <resource variable="RESOURCES" multichoice="1" addstatus="1"
4662: closeallpages="1" modallink="1">
4663: <filterfunc>return $isNotMap;</filterfunc>
4664: <mapurl>$map</mapurl>
4665: <valuefunc>return $symbFilter;</valuefunc>
4666: $start_new_option
4667: </resource>
4668: </state>
4669: RESOURCE_SELECTOR
4670:
4671: $resource_selector .= &generate_format_selector($helper,
4672: 'Format of the print job',
4673: 'PRINT_FORMATTING');
4674: &Apache::lonxml::xmlparse($r, 'helper', <<CHOOSE_STUDENTS1);
4675: <state name="CHOOSE_STUDENTS1" title="Select Students and Resources">
4676: <choices variable='student_sort'>
4677: <choice computer='0'>Sort by section then student</choice>
4678: <choice computer='1'>Sort by students across sections.</choice>
4679: </choices>
4680: <message><br /><hr /><br /></message>
4681: <student multichoice='1' variable="STUDENTS" nextstate="SELECT_RESOURCES" coursepersonnel="1" />
4682:
4683: </state>
4684: $resource_selector
4685: CHOOSE_STUDENTS1
4686:
4687: &Apache::lonxml::xmlparse($r, 'helper', <<CHOOSE_ANON2);
4688: <state name="CHOOSE_ANON2" title="Select CODEd Assignments">
4689: <nextstate>SELECT_RESOURCES</nextstate>
4690: <message><h4>Fill out one of the forms below</h4></message>
4691: <message><br /><hr /> <br /></message>
4692: <message><h3>Generate new CODEd Assignments</h3></message>
4693: <message><table><tr><td><b>Number of CODEd assignments to print:</b></td><td></message>
4694: <string variable="NUMBER_TO_PRINT_TOTAL" maxlength="5" size="5" noproceed="1">
4695: <validator>
4696: if (((\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'}+0) < 1) &&
4697: !\$helper->{'VARS'}{'REUSE_OLD_CODES'} &&
4698: !\$helper->{'VARS'}{'SINGLE_CODE'} &&
4699: !\$helper->{'VARS'}{'CODE_SELECTED_FROM_LIST'}) {
4700: return "You need to specify the number of assignments to print";
4701: }
4702: if (((\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'}+0) >= 1) &&
4703: (\$helper->{'VARS'}{'SINGLE_CODE'} ne '') ) {
4704: return 'Specifying number of codes to print and a specific code is not compatible';
4705: }
4706: return undef;
4707: </validator>
4708: </string>
4709: <message></td></tr><tr><td></message>
4710: <message><b>Names to save the CODEs under for later:</b></message>
4711: <message></td><td></message>
4712: <string variable="ANON_CODE_STORAGE_NAME" maxlength="50" size="20" />
4713: <message></td></tr><tr><td></message>
4714: <message><b>Bubblesheet type:</b></message>
4715: <message></td><td></message>
4716: <dropdown variable="CODE_OPTION" multichoice="0" allowempty="0">
4717: $codechoice
4718: </dropdown>
4719: <message></td></tr><tr><td></table></message>
4720: <message><br /><hr /><h3>Print a Specific CODE </h3><br /><table></message>
4721: <message><tr><td><b>Enter a CODE to print:</b></td><td></message>
4722: <string variable="SINGLE_CODE" size="10">
4723: <validator>
4724: if(!\$helper->{'VARS'}{'NUMBER_TO_PRINT_TOTAL'} &&
4725: !\$helper->{'VARS'}{'REUSE_OLD_CODES'} &&
4726: !\$helper->{'VARS'}{'CODE_SELECTED_FROM_LIST'}) {
4727: return &Apache::lonprintout::is_code_valid(\$helper->{'VARS'}{'SINGLE_CODE'},
4728: \$helper->{'VARS'}{'CODE_OPTION'});
4729: } elsif (\$helper->{'VARS'}{'SINGLE_CODE'} ne ''){
4730: return 'Specifying a code name is incompatible specifying number of codes.';
4731: } else {
4732: return undef; # Other forces control us.
4733: }
4734: </validator>
4735: </string>
4736: <message></td></tr><tr><td></message>
4737: $code_selection
4738: <message></td></tr></table></message>
4739: <message><hr /><h3>Reprint a Set of Saved CODEs</h3><table><tr><td></message>
4740: <message><b>Select saved CODEs:</b></message>
4741: <message></td><td></message>
4742: <dropdown variable="REUSE_OLD_CODES">
4743: $namechoice
4744: </dropdown>
4745: <message></td></tr></table></message>
4746: </state>
4747: $resource_selector
4748: CHOOSE_ANON2
4749: }
4750:
4751: # FIXME: That RE should come from a library somewhere.
4752: if (($perm{'pav'}
4753: && ($subdir ne '')
4754: && $subdir ne $Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'
4755: && (defined($helper->{'VARS'}->{'construction'})
4756: ||
4757: (&Apache::lonnet::allowed('bre',$subdir) eq 'F'
4758: &&
4759: $helper->{VARS}->{'postdata'}=~/\.(problem|exam|quiz|assess|survey|form|library|page|xml|html|htm|xhtml|xhtm)/)
4760: ))
4761: && $helper->{VARS}->{'assignment'} eq ""
4762: ) {
4763: my $pretty_dir = &Apache::lonnet::hreflocation($subdir);
4764: push @{$printChoices}, [&mt('Selected [_1]Problems[_2] from current subdirectory [_3]','<b>','</b>','<b><i>'.$pretty_dir.'</i></b>','<b>','</b>'), 'problems_from_directory', 'CHOOSE_FROM_SUBDIR'];
4765: my $xmlfrag = <<CHOOSE_FROM_SUBDIR;
4766: <state name="CHOOSE_FROM_SUBDIR" title="Select File(s) from <b><small>$pretty_dir</small></b> to print">
4767:
4768: <files variable="FILES" multichoice='1'>
4769: <nextstate>PAGESIZE</nextstate>
4770: <filechoice>return '$subdir';</filechoice>
4771: CHOOSE_FROM_SUBDIR
4772:
4773: # this is broken up because I really want interpolation above,
4774: # and I really DON'T want it below
4775: $xmlfrag .= <<'CHOOSE_FROM_SUBDIR';
4776: <filefilter>return Apache::lonhelper::files::not_old_version($filename) &&
4777: $filename =~ m/\.(problem|exam|quiz|assess|survey|form|library)$/;
4778: </filefilter>
4779: </files>
4780: </state>
4781: CHOOSE_FROM_SUBDIR
4782: &Apache::lonxml::xmlparse($r, 'helper', $xmlfrag);
4783: }
4784:
4785: # Allow the user to select any sequence in the course, feed it to
4786: # another resource selector for that sequence
4787: if ((!$helper->{VARS}->{'construction'}) &&
4788: (!$is_published || (($subdir eq '') && ($url eq '/adm/navmaps')))) {
4789: push(@$printChoices,[&mt('Selected [_1]Resources[_2] from [_3]selected folder[_4] in course',
4790: '<b>','</b>','<b>','</b>'),
4791: 'select_sequences','CHOOSE_SEQUENCE']);
4792: my $escapedSequenceName;
4793: if ($helper->{VARS}->{'SEQUENCE'} ne '') {
4794: $escapedSequenceName = $helper->{VARS}->{'SEQUENCE'};
4795: } elsif (($subdir eq '') && ($url eq '/adm/navmaps')) {
4796: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4797: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4798: if ($env{'course.'.$env{'request.course.id'}.'.url'} eq
4799: "uploaded/$cdom/$cnum/default.sequence") {
4800: $escapedSequenceName = $env{'course.'.$env{'request.course.id'}.'.url'};
4801: }
4802: }
4803: #Escape apostrophes and backslashes for Perl
4804: $escapedSequenceName =~ s/\\/\\\\/g;
4805: $escapedSequenceName =~ s/'/\\'/g;
4806: my $nocurrloc;
4807: if (($subdir eq '') && ($url eq '/adm/navmaps')) {
4808: $nocurrloc = 'nocurrloc="1"';
4809: if ($perm{'pfo'}) {
4810: push(@{$printChoices},
4811: [&mt('Selected [_1]Problems[_2] from [_3]selected folder[_4] in course for [_5]selected people[_6]',
4812: '<b>','</b>','<b>','</b>','<b>','</b>'),
4813: 'select_sequences_problems_for_students','CHOOSE_SEQUENCE_STUDENTS'],
4814: [&mt('Selected [_1]Problems[_2] from [_3]selected folder[_4] in course for [_5]CODEd assignments[_6]',
4815: '<b>','</b>','<b>','</b>','<b>','</b>'),
4816: 'select_sequences_problems_for_anon','CHOOSE_SEQUENCE_ANON1'],
4817: [&mt('Selected [_1]Resources[_2] from [_3]selected folder[_4] in course for [_5]selected people[_6]',
4818: '<b>','</b>','<b>','</b>','<b>','</b>'),
4819: 'select_sequences_resources_for_students','CHOOSE_SEQUENCE_STUDENTS1'],
4820: [&mt('Selected [_1]Resources[_2] from [_3]selected folder[_4] in course for [_5]CODEd assignments[_6]',
4821: '<b>','</b>','<b>','</b>','<b>','</b>'),
4822: 'select_sequences_resources_for_anon','CHOOSE_SEQUENCE_ANON2']);
4823: if ($escapedSequenceName) {
4824: my ($randomly_ordered_warning,$codechoice,$code_selection,$namechoice) =
4825: &generate_common_choosers($r,$helper,$escapedSequenceName,$escapedSequenceName,
4826: $isProblem,$symbFilter,$start_new_option);
4827:
4828: my $resource_selector .= <<RESOURCE_SELECTOR;
4829: <state name="CHOOSE_STUDENTS2" title="Select Students and Resources">
4830: <choices variable='student_sort'>
4831: <choice computer='0'>Sort by section then student</choice>
4832: <choice computer='1'>Sort by students across sections.</choice>
4833: </choices>
4834: <message><br /><hr /><br /></message>
4835: <student multichoice='1' variable="STUDENTS" nextstate="SELECT_RESOURCES" coursepersonnel="1" />
4836:
4837: </state>
4838: <state name="SELECT_RESOURCES" title="Select Resources">
4839: $randomly_ordered_warning
4840: <nextstate>PRINT_FORMATTING</nextstate>
4841: <message>(mark desired resources then click "next" button) <br /></message>
4842: <resource variable="RESOURCES" multichoice="1" addstatus="1"
4843: closeallpages="1" modallink="1">
4844: <filterfunc>return $isNotMap;</filterfunc>
4845: <mapurl>$map</mapurl>
4846: <valuefunc>return $symbFilter;</valuefunc>
4847: $start_new_option
4848: </resource>
4849: </state>
4850: RESOURCE_SELECTOR
4851:
4852: my $anon3 = &generate_code_selector($helper,
4853: 'CHOOSE_ANON3',
4854: 'SELECT_RESOURCES',
4855: $codechoice,
4856: $code_selection,
4857: $namechoice) . $resource_selector;
4858:
4859: &Apache::lonxml::xmlparse($r, 'helper',$anon3);
4860: }
4861: }
4862: }
4863: if (($subdir eq '') && ($url eq '/adm/navmaps') && ($perm{'pfo'})) {
4864: &Apache::lonxml::xmlparse($r, 'helper', <<CHOOSE_FROM_ANY_SEQUENCE);
4865: <state name="CHOOSE_SEQUENCE" title="Select Sequence To Print From">
4866: <message>Select the sequence to print resources from:</message>
4867: <resource variable="SEQUENCE">
4868: <nextstate>CHOOSE_FROM_ANY_SEQUENCE</nextstate>
4869: <filterfunc>return &Apache::lonprintout::printable_sequence(\$res);</filterfunc>
4870: <valuefunc>return $urlValue;</valuefunc>
4871: <choicefunc>return \$res->hasResource(\$res,sub { return !\$_[0]->is_sequence() },0,0);
4872: </choicefunc>
4873: </resource>
4874: </state>
4875: <state name="CHOOSE_SEQUENCE_STUDENTS" title="Select Sequence To Print From">
4876: <message>Select the sequence to print resources from:</message>
4877: <resource variable="SEQUENCE">
4878: <nextstate>CHOOSE_STUDENTS</nextstate>
4879: <filterfunc>return &Apache::lonprintout::printable_sequence(\$res);</filterfunc>
4880: <valuefunc>return $urlValue;</valuefunc>
4881: <choicefunc>return \$res->hasResource(\$res,sub { return !\$_[0]->is_sequence() },0,0);
4882: </choicefunc>
4883: </resource>
4884: </state>
4885: <state name="CHOOSE_SEQUENCE_ANON1" title="Select Sequence To Print From">
4886: <message>Select the sequence to print resources from:</message>
4887: <resource variable="SEQUENCE">
4888: <nextstate>CHOOSE_ANON1</nextstate>
4889: <filterfunc>return &Apache::lonprintout::printable_sequence(\$res);</filterfunc>
4890: <valuefunc>return $urlValue;</valuefunc>
4891: <choicefunc>return \$res->hasResource(\$res,sub { return !\$_[0]->is_sequence() },0,0);
4892: </choicefunc>
4893: </resource>
4894: </state>
4895: <state name="CHOOSE_SEQUENCE_STUDENTS1" title="Select Sequence To Print From">
4896: <message>Select the sequence to print resources from:</message>
4897: <resource variable="SEQUENCE">
4898: <nextstate>CHOOSE_STUDENTS2</nextstate>
4899: <filterfunc>return &Apache::lonprintout::printable_sequence(\$res);</filterfunc>
4900: <valuefunc>return $urlValue;</valuefunc>
4901: <choicefunc>return \$res->hasResource(\$res,sub { return !\$_[0]->is_sequence() },0,0);
4902: </choicefunc>
4903: </resource>
4904: </state>
4905: <state name="CHOOSE_SEQUENCE_ANON2" title="Select Sequence To Print From">
4906: <message>Select the sequence to print resources from:</message>
4907: <resource variable="SEQUENCE">
4908: <nextstate>CHOOSE_ANON3</nextstate>
4909: <filterfunc>return &Apache::lonprintout::printable_sequence(\$res);</filterfunc>
4910: <valuefunc>return $urlValue;</valuefunc>
4911: <choicefunc>return \$res->hasResource(\$res,sub { return !\$_[0]->is_sequence() },0,0);
4912: </choicefunc>
4913: </resource>
4914: </state>
4915: <state name="CHOOSE_FROM_ANY_SEQUENCE" title="Select Resources To Print">
4916: <message>(mark desired resources then click "next" button) <br /></message>
4917: <resource variable="RESOURCES" multichoice="1" toponly='1' addstatus="1"
4918: closeallpages="1" modallink="1" suppressNavmap="1" $nocurrloc>
4919: <nextstate>PAGESIZE</nextstate>
4920: <filterfunc>return $isNotMap</filterfunc>
4921: <mapurl evaluate='1'>return '$escapedSequenceName';</mapurl>
4922: <valuefunc>return $symbFilter;</valuefunc>
4923: $start_new_option
4924: </resource>
4925: </state>
4926: CHOOSE_FROM_ANY_SEQUENCE
4927: } else {
4928: &Apache::lonxml::xmlparse($r, 'helper', <<CHOOSE_FROM_ANY_SEQUENCE);
4929: <state name="CHOOSE_SEQUENCE" title="Select Sequence To Print From">
4930: <message>Select the sequence to print resources from:</message>
4931: <resource variable="SEQUENCE">
4932: <nextstate>CHOOSE_FROM_ANY_SEQUENCE</nextstate>
4933: <filterfunc>return &Apache::lonprintout::printable_sequence(\$res);</filterfunc>
4934: <valuefunc>return $urlValue;</valuefunc>
4935: <choicefunc>return \$res->hasResource(\$res,sub { return !\$_[0]->is_sequence() },0,0);
4936: </choicefunc>
4937: </resource>
4938: </state>
4939: <state name="CHOOSE_FROM_ANY_SEQUENCE" title="Select Resources To Print">
4940: <message>(mark desired resources then click "next" button) <br /></message>
4941: <resource variable="RESOURCES" multichoice="1" toponly='1' addstatus="1"
4942: closeallpages="1" modallink="1" suppressNavmap="1" $nocurrloc>
4943: <nextstate>PAGESIZE</nextstate>
4944: <filterfunc>return $isNotMap</filterfunc>
4945: <mapurl evaluate='1'>return '$escapedSequenceName';</mapurl>
4946: <valuefunc>return $symbFilter;</valuefunc>
4947: $start_new_option
4948: </resource>
4949: </state>
4950: CHOOSE_FROM_ANY_SEQUENCE
4951: }
4952: }
4953: my $numchoices = 0;
4954: if (ref($printChoices) eq 'ARRAY') {
4955: $numchoices = @{$printChoices};
4956: }
4957: # Early out if nothing to print
4958: if (!$numchoices) {
4959: $r->print(&Apache::loncommon::start_page('Printing Helper').
4960: '<h2>'.&mt('Unable to determine print context').'</h2>'.
4961: '<p>'.&mt('Please display a resource, and then click the "Print" button/icon').'</p>');
4962: my $prtspool=$r->dir_config('lonPrtDir');
4963: my $footer = &recently_generated($prtspool);
4964: $r->print($footer.&Apache::loncommon::end_page());
4965: return OK;
4966: }
4967:
4968: # Generate the first state, to select which resources get printed.
4969: Apache::lonhelper::state->new("START", "Select Printing Options:");
4970: if (!$res_printable) {
4971: my $noprintmsg;
4972: if ($res_error) {
4973: $noprintmsg = &mt('Print availability for current resource could not be determined');
4974: } else {
4975: my $now = time;
4976: my $shownprintstart = &Apache::lonlocal::locallocaltime($res_printstartdate);
4977: my $shownprintend = &Apache::lonlocal::locallocaltime($res_printenddate);
4978: if (($res_printenddate) && ($res_printenddate < $now)) {
4979: $noprintmsg = &mt('Printing for current resource no longer available (ended: [_1])',
4980: $shownprintend);
4981: } else {
4982: if (($res_printstartdate) && ($res_printstartdate > $now)) {
4983: if (($res_printenddate) && ($res_printenddate > $now) && ($res_printenddate > $res_printstartdate)) {
4984: $noprintmsg = &mt('Printing for current resource is only possible between [_1] and [_2]',
4985: $shownprintstart,$shownprintend);
4986: } elsif (!$res_printenddate) {
4987: $noprintmsg = &mt('Printing for current resource will only be possible starting [_1]',
4988: $shownprintstart);
4989: } else {
4990: $noprintmsg = &mt('Printing for current resource is unavailable');
4991: }
4992: }
4993: }
4994: }
4995:
4996: if ($noprintmsg) {
4997: $paramHash = Apache::lonhelper::getParamHash();
4998: $paramHash->{MESSAGE_TEXT} =
4999: '<p class="LC_info">'.$noprintmsg.'</p>';
5000: Apache::lonhelper::message->new();
5001: }
5002: }
5003: $paramHash = Apache::lonhelper::getParamHash();
5004: $paramHash = Apache::lonhelper::getParamHash();
5005: $paramHash->{MESSAGE_TEXT} = "";
5006: Apache::lonhelper::message->new();
5007: $paramHash = Apache::lonhelper::getParamHash();
5008: $paramHash->{'variable'} = 'PRINT_TYPE';
5009: $paramHash->{CHOICES} = $printChoices;
5010: Apache::lonhelper::choices->new();
5011:
5012: my $startedTable = 0; # have we started an HTML table yet? (need
5013: # to close it later)
5014:
5015: if (($perm{'pav'} and $perm{'vgr'}) or
5016: ($helper->{VARS}->{'construction'} eq '1')) {
5017: &addMessage('<br />'
5018: .'<h3>'.&mt('Print Options').'</h3>'
5019: .&Apache::lonhtmlcommon::start_pick_box()
5020: .&Apache::lonhtmlcommon::row_title(
5021: '<label for="ANSWER_TYPE_forminput">'
5022: .&mt('Print Answers')
5023: .'</label>'
5024: )
5025: );
5026: $paramHash = Apache::lonhelper::getParamHash();
5027: $paramHash->{'variable'} = 'ANSWER_TYPE';
5028: $helper->declareVar('ANSWER_TYPE');
5029: $paramHash->{CHOICES} = [
5030: ['Without Answers', 'yes'],
5031: ['With Answers', 'no'],
5032: ['Only Answers', 'only']
5033: ];
5034: Apache::lonhelper::dropdown->new();
5035: &addMessage(&Apache::lonhtmlcommon::row_closure());
5036: $startedTable = 1;
5037:
5038: #
5039: # Select font size.
5040: #
5041:
5042: $helper->declareVar('fontsize');
5043: &addMessage(&Apache::lonhtmlcommon::row_title(&mt('Font Size')));
5044: my $xmlfrag = << "FONT_SELECTION";
5045:
5046:
5047: <dropdown variable='fontsize' multichoice='0' allowempty='0'>
5048: <defaultvalue>
5049: return 'normalsize';
5050: </defaultvalue>
5051: <choice computer='tiny'>Tiny</choice>
5052: <choice computer='sub/superscriptsize'>Script Size</choice>
5053: <choice computer='footnotesize'>Footnote Size</choice>
5054: <choice computer='small'>Small</choice>
5055: <choice computer='normalsize'>Normal (default)</choice>
5056: <choice computer='large'>larger than normal</choice>
5057: <choice computer='Large'>Even larger than normal</choice>
5058: <choice computer='LARGE'>Still larger than normal</choice>
5059: <choice computer='huge'>huge font size</choice>
5060: <choice computer='Huge'>Largest possible size</choice>
5061: </dropdown>
5062: FONT_SELECTION
5063: &Apache::lonxml::xmlparse($r, 'helper', $xmlfrag);
5064: &addMessage(&Apache::lonhtmlcommon::row_closure(1));
5065: }
5066:
5067: if ($perm{'pav'}) {
5068: if (!$startedTable) {
5069: addMessage("<hr width='33%' /><table><tr><td align='right'>".
5070: '<label for="LATEX_TYPE_forminput">'.
5071: &mt('LaTeX mode').
5072: "</label>: </td><td>");
5073: $startedTable = 1;
5074: } else {
5075: &addMessage(&Apache::lonhtmlcommon::row_title(
5076: '<label for="LATEX_TYPE_forminput">'
5077: .&mt('LaTeX mode')
5078: .'</label>'
5079: )
5080: );
5081: }
5082: $paramHash = Apache::lonhelper::getParamHash();
5083: $paramHash->{'variable'} = 'LATEX_TYPE';
5084: $helper->declareVar('LATEX_TYPE');
5085: if ($helper->{VARS}->{'construction'} eq '1') {
5086: $paramHash->{CHOICES} = [
5087: ['standard LaTeX mode', 'standard'],
5088: ['LaTeX batchmode', 'batchmode'], ];
5089: } else {
5090: $paramHash->{CHOICES} = [
5091: ['LaTeX batchmode', 'batchmode'],
5092: ['standard LaTeX mode', 'standard'] ];
5093: }
5094: Apache::lonhelper::dropdown->new();
5095:
5096: &addMessage(&Apache::lonhtmlcommon::row_closure()
5097: .&Apache::lonhtmlcommon::row_title(
5098: '<label for="TABLE_CONTENTS_forminput">'
5099: .&mt('Print Table of Contents')
5100: .'</label>'
5101: )
5102: );
5103: $paramHash = Apache::lonhelper::getParamHash();
5104: $paramHash->{'variable'} = 'TABLE_CONTENTS';
5105: $helper->declareVar('TABLE_CONTENTS');
5106: $paramHash->{CHOICES} = [
5107: ['No', 'no'],
5108: ['Yes', 'yes'] ];
5109: Apache::lonhelper::dropdown->new();
5110: &addMessage(&Apache::lonhtmlcommon::row_closure());
5111:
5112: if (not $helper->{VARS}->{'construction'}) {
5113: &addMessage(&Apache::lonhtmlcommon::row_title(
5114: '<label for="TABLE_INDEX_forminput">'
5115: .&mt('Print Index')
5116: .'</label>'
5117: )
5118: );
5119: $paramHash = Apache::lonhelper::getParamHash();
5120: $paramHash->{'variable'} = 'TABLE_INDEX';
5121: $helper->declareVar('TABLE_INDEX');
5122: $paramHash->{CHOICES} = [
5123: ['No', 'no'],
5124: ['Yes', 'yes'] ];
5125: Apache::lonhelper::dropdown->new();
5126: &addMessage(&Apache::lonhtmlcommon::row_closure());
5127: &addMessage(&Apache::lonhtmlcommon::row_title(
5128: '<label for="PRINT_DISCUSSIONS_forminput">'
5129: .&mt('Print Discussions')
5130: .'</label>'
5131: )
5132: );
5133: $paramHash = Apache::lonhelper::getParamHash();
5134: $paramHash->{'variable'} = 'PRINT_DISCUSSIONS';
5135: $helper->declareVar('PRINT_DISCUSSIONS');
5136: $paramHash->{CHOICES} = [
5137: ['No', 'no'],
5138: ['Yes', 'yes'] ];
5139: Apache::lonhelper::dropdown->new();
5140: &addMessage(&Apache::lonhtmlcommon::row_closure());
5141:
5142: # Prompt for printing annotations too.
5143:
5144: &addMessage(&Apache::lonhtmlcommon::row_title(
5145: '<label for="PRINT_ANNOTATIONS_forminput">'
5146: .&mt('Print Annotations')
5147: .'</label>'
5148: )
5149: );
5150: $paramHash = Apache::lonhelper::getParamHash();
5151: $paramHash->{'variable'} = "PRINT_ANNOTATIONS";
5152: $helper->declareVar("PRINT_ANNOTATIONS");
5153: $paramHash->{CHOICES} = [
5154: ['No', 'no'],
5155: ['Yes', 'yes']];
5156: Apache::lonhelper::dropdown->new();
5157: &addMessage(&Apache::lonhtmlcommon::row_closure());
5158:
5159: &addMessage(&Apache::lonhtmlcommon::row_title(&mt('Foils')));
5160: $paramHash = Apache::lonhelper::getParamHash();
5161: $paramHash->{'multichoice'} = "true";
5162: $paramHash->{'allowempty'} = "true";
5163: $paramHash->{'variable'} = "showallfoils";
5164: $paramHash->{'CHOICES'} = [ [&mt('Show All Foils'), "1"] ];
5165: Apache::lonhelper::choices->new();
5166: &addMessage(&Apache::lonhtmlcommon::row_closure(1));
5167: }
5168:
5169: if ($helper->{'VARS'}->{'construction'}) {
5170: my $stylevalue='$Apache::lonnet::env{"construct.style"}';
5171: my $randseedtext=&mt("Use random seed");
5172: my $stylefiletext=&mt("Use style file");
5173: my $selectfiletext=&mt("Select style file");
5174:
5175: my $xmlfrag .= '<message>'
5176: .&Apache::lonhtmlcommon::row_title('<label for="curseed_forminput">'
5177: .$randseedtext
5178: .'</label>'
5179: )
5180: .'</message>
5181: <string variable="curseed" size="15" maxlength="15">
5182: <defaultvalue>
5183: return '.$helper->{VARS}->{'curseed'}.';
5184: </defaultvalue>'
5185: .'</string>'
5186: .'<message>'
5187: .&Apache::lonhtmlcommon::row_closure()
5188: .&Apache::lonhtmlcommon::row_title('<label for="style_file">'
5189: .$stylefiletext
5190: .'</label>'
5191: )
5192: .'</message>
5193: <string variable="style_file" size="40">
5194: <defaultvalue>
5195: return '.$stylevalue.';
5196: </defaultvalue>
5197: </string><message> '
5198: .qq|<a href="javascript:openbrowser('helpform','style_file_forminput','sty')">|
5199: .$selectfiletext.'</a>'
5200: .&Apache::lonhtmlcommon::row_closure()
5201: .&Apache::lonhtmlcommon::row_title(&mt('Show All Foils'))
5202: .'</message>
5203: <choices allowempty="1" multichoice="true" variable="showallfoils">
5204: <choice computer="1"> </choice>
5205: </choices>'
5206: .'<message>'
5207: .&Apache::lonhtmlcommon::row_closure()
5208: .'</message>';
5209: &Apache::lonxml::xmlparse($r, 'helper', $xmlfrag);
5210:
5211:
5212: &addMessage(&Apache::lonhtmlcommon::row_title(&mt('Problem Type')));
5213: #
5214: # Initial value from construction space:
5215: #
5216: if (!$helper->{VARS}->{'probstatus'} && $env{'form.problemtype'}) {
5217: $helper->{VARS}->{'probstatus'} = $env{'form.problemtype'}; # initial value
5218: }
5219: $xmlfrag = << "PROBTYPE";
5220: <dropdown variable="probstatus" multichoice="0" allowempty="0">
5221: <defaultvalue>
5222: return "$helper->{VARS}->{'probstatus'}";
5223: </defaultvalue>
5224: <choice computer="problem">Homework Problem</choice>
5225: <choice computer="exam">Bubblesheet Exam Problem</choice>
5226: <choice computer="survey">Survey question</choice>
5227: ,choice computer="anonsurvey"Anonymous survey question</choice>
5228: </dropdown>
5229: PROBTYPE
5230: &Apache::lonxml::xmlparse($r, 'helper', $xmlfrag);
5231: &addMessage(&Apache::lonhtmlcommon::row_closure(1));
5232:
5233:
5234:
5235: }
5236: }
5237:
5238:
5239:
5240:
5241: if ($startedTable) {
5242: &addMessage(&Apache::lonhtmlcommon::end_pick_box());
5243: }
5244:
5245: Apache::lonprintout::page_format_state->new("FORMAT");
5246:
5247: # Generate the PAGESIZE state which will offer the user the margin
5248: # choices if they select one column
5249: Apache::lonhelper::state->new("PAGESIZE", "Set Margins");
5250: Apache::lonprintout::page_size_state->new('pagesize', 'FORMAT', 'FINAL');
5251:
5252:
5253: $helper->process();
5254:
5255:
5256: # MANUAL BAILOUT CONDITION:
5257: # If we're in the "final" state, bailout and return to handler
5258: if ($helper->{STATE} eq 'FINAL') {
5259: return $helper;
5260: }
5261:
5262: my $footer;
5263: if ($helper->{STATE} eq 'START') {
5264: my $prtspool=$r->dir_config('lonPrtDir');
5265: $footer = &recently_generated($prtspool);
5266: }
5267: $r->print($helper->display($footer));
5268: &Apache::lonhelper::unregisterHelperTags();
5269:
5270: return OK;
5271: }
5272:
5273:
5274: 1;
5275:
5276: package Apache::lonprintout::page_format_state;
5277:
5278: =pod
5279:
5280: =head1 Helper element: page_format_state
5281:
5282: See lonhelper.pm documentation for discussion of the helper framework.
5283:
5284: Apache::lonprintout::page_format_state is an element that gives the
5285: user an opportunity to select the page layout they wish to print
5286: with: Number of columns, portrait/landscape, and paper size. If you
5287: want to change the paper size choices, change the @paperSize array
5288: contents in this package.
5289:
5290: page_format_state is always directly invoked in lonprintout.pm, so there
5291: is no tag interface. You actually pass parameters to the constructor.
5292:
5293: =over 4
5294:
5295: =item * B<new>(varName): varName is where the print information will be stored in the format FIXME.
5296:
5297: =back
5298:
5299: =cut
5300:
5301: use Apache::lonhelper;
5302:
5303: no strict;
5304: @ISA = ("Apache::lonhelper::element");
5305: use strict;
5306: use Apache::lonlocal;
5307: use Apache::lonnet;
5308:
5309: my $maxColumns = 2;
5310: # it'd be nice if these all worked
5311: #my @paperSize = ("letter [8 1/2x11 in]", "legal [8 1/2x14 in]",
5312: # "tabloid (ledger) [11x17 in]", "executive [7 1/2x10 in]",
5313: # "a2 [420x594 mm]", "a3 [297x420 mm]", "a4 [210x297 mm]",
5314: # "a5 [148x210 mm]", "a6 [105x148 mm]" );
5315: my @paperSize = ("letter [8 1/2x11 in]", "legal [8 1/2x14 in]",
5316: "a4 [210x297 mm]");
5317:
5318: # Tentative format: Orientation (L = Landscape, P = portrait) | Colnum |
5319: # Paper type
5320:
5321: sub new {
5322: my $self = Apache::lonhelper::element->new();
5323:
5324: shift;
5325:
5326: $self->{'variable'} = shift;
5327: my $helper = Apache::lonhelper::getHelper();
5328: $helper->declareVar($self->{'variable'});
5329: bless($self);
5330: return $self;
5331: }
5332:
5333: sub render {
5334: my $self = shift;
5335: my $helper = Apache::lonhelper::getHelper();
5336: my $result = '';
5337: my $var = $self->{'variable'};
5338: my $PageLayout=&mt('Page layout');
5339: my $NumberOfColumns=&mt('Number of columns');
5340: my $PaperType=&mt('Paper type');
5341: my $landscape=&mt('Landscape');
5342: my $portrait=&mt('Portrait');
5343: my $pdfFormLabel=&mt('PDF Form Fields');
5344: my $with=&mt('with Form Fields');
5345: my $without=&mt('without Form Fields');
5346:
5347:
5348: $result.='<h3>'.&mt('Layout Options').'</h3>'
5349: .&Apache::loncommon::start_data_table()
5350: .&Apache::loncommon::start_data_table_header_row()
5351: .'<th>'.$PageLayout.'</th>'
5352: .'<th>'.$NumberOfColumns.'</th>'
5353: .'<th>'.$PaperType.'</th>'
5354: .'<th>'.$pdfFormLabel.'</th>'
5355: .&Apache::loncommon::end_data_table_header_row()
5356: .&Apache::loncommon::start_data_table_row()
5357: .'<td>'
5358: .'<label><input type="radio" name="'.${var}.'.layout" value="L" />'.$landscape.'</label><br />'
5359: .'<label><input type="radio" name="'.${var}.'.layout" value="P" checked="checked" />'.$portrait.'</label>'
5360: .'</td>';
5361:
5362: $result.='<td align="center">'
5363: .'<select name="'.${var}.'.cols">';
5364:
5365: my $i;
5366: for ($i = 1; $i <= $maxColumns; $i++) {
5367: if ($i == 2) {
5368: $result .= '<option value="'.$i.'" selected="selected">'.$i.'</option>'."\n";
5369: } else {
5370: $result .= '<option value="'.$i.'">'.$i.'</option>'."\n";
5371: }
5372: }
5373:
5374: $result .= "</select></td><td>\n";
5375: $result .= "<select name='${var}.paper'>\n";
5376:
5377: my %parmhash=&Apache::lonnet::coursedescription($env{'request.course.id'});
5378: my $DefaultPaperSize=lc($parmhash{'default_paper_size'});
5379: $DefaultPaperSize=~s/\s//g;
5380: if ($DefaultPaperSize eq '') {$DefaultPaperSize='letter';}
5381: $i = 0;
5382: foreach (@paperSize) {
5383: $_=~/(\w+)/;
5384: my $papersize=$1;
5385: if ($paperSize[$i]=~/$DefaultPaperSize/) {
5386: $result .= '<option selected="selected" value="'.$papersize.'">'.$paperSize[$i].'</option>'."\n";
5387: } else {
5388: $result .= '<option value="'.$papersize.'">'.$paperSize[$i].'</option>'."\n";
5389: }
5390: $i++;
5391: }
5392: $result .= <<HTML;
5393: </select>
5394: </td>
5395: <td align='center'>
5396: <select name='${var}.pdfFormFields'>
5397: <option selected="selected" value="no">$without</option>
5398: <option value="yes">$with</option>
5399: </select>
5400: </td>
5401: HTML
5402: $result.=&Apache::loncommon::end_data_table_row()
5403: .&Apache::loncommon::end_data_table();
5404:
5405: return $result;
5406: }
5407:
5408: sub postprocess {
5409: my $self = shift;
5410:
5411: my $var = $self->{'variable'};
5412: my $helper = Apache::lonhelper->getHelper();
5413: $helper->{VARS}->{$var} =
5414: $env{"form.$var.layout"} . '|' . $env{"form.$var.cols"} . '|' .
5415: $env{"form.$var.paper"} . '|' . $env{"form.$var.pdfFormFields"};
5416: return 1;
5417: }
5418:
5419: 1;
5420:
5421: package Apache::lonprintout::page_size_state;
5422:
5423: =pod
5424:
5425: =head1 Helper element: page_size_state
5426:
5427: See lonhelper.pm documentation for discussion of the helper framework.
5428:
5429: Apache::lonprintout::page_size_state is an element that gives the
5430: user the opportunity to further refine the page settings if they
5431: select a single-column page.
5432:
5433: page_size_state is always directly invoked in lonprintout.pm, so there
5434: is no tag interface. You actually pass parameters to the constructor.
5435:
5436: =over 4
5437:
5438: =item * B<new>(varName): varName is where the print information will be stored in the format FIXME.
5439:
5440: =back
5441:
5442: =cut
5443:
5444: use Apache::lonhelper;
5445: use Apache::lonnet;
5446: no strict;
5447: @ISA = ("Apache::lonhelper::element");
5448: use strict;
5449:
5450:
5451:
5452: sub new {
5453: my $self = Apache::lonhelper::element->new();
5454:
5455: shift; # disturbs me (probably prevents subclassing) but works (drops
5456: # package descriptor)... - Jeremy
5457:
5458: $self->{'variable'} = shift;
5459: my $helper = Apache::lonhelper::getHelper();
5460: $helper->declareVar($self->{'variable'});
5461:
5462: # The variable name of the format element, so we can look into
5463: # $helper->{VARS} to figure out whether the columns are one or two
5464: $self->{'formatvar'} = shift;
5465:
5466:
5467: $self->{NEXTSTATE} = shift;
5468: bless($self);
5469:
5470: return $self;
5471: }
5472:
5473: sub render {
5474: my $self = shift;
5475: my $helper = Apache::lonhelper::getHelper();
5476: my $result = '';
5477: my $var = $self->{'variable'};
5478:
5479:
5480:
5481: if (defined $self->{ERROR_MSG}) {
5482: $result .= '<br /><span class="LC_error">' . $self->{ERROR_MSG} . '</span><br />';
5483: }
5484:
5485: my $format = $helper->{VARS}->{$self->{'formatvar'}};
5486:
5487: # Use format to get sensible defaults for the margins:
5488:
5489:
5490: my ($laystyle, $cols, $papersize) = split(/\|/, $format);
5491: ($papersize) = split(/ /, $papersize);
5492:
5493: $laystyle = &Apache::lonprintout::map_laystyle($laystyle);
5494:
5495:
5496:
5497: my %size;
5498: ($size{'width_and_units'},
5499: $size{'height_and_units'},
5500: $size{'margin_and_units'})=
5501: &Apache::lonprintout::page_format($papersize, $laystyle, $cols);
5502:
5503: foreach my $dimension ('width','height','margin') {
5504: ($size{$dimension},$size{$dimension.'_unit'}) =
5505: split(/ +/, $size{$dimension.'_and_units'},2);
5506:
5507: foreach my $unit ('cm','in') {
5508: $size{$dimension.'_options'} .= '<option ';
5509: if ($size{$dimension.'_unit'} eq $unit) {
5510: $size{$dimension.'_options'} .= 'selected="selected" ';
5511: }
5512: $size{$dimension.'_options'} .= '>'.$unit.'</option>';
5513: }
5514: }
5515:
5516: # Adjust margin for LaTeX margin: .. requires units == cm or in.
5517:
5518: if ($size{'margin_unit'} eq 'in') {
5519: $size{'margin'} += 1;
5520: } else {
5521: $size{'margin'} += 2.54;
5522: }
5523: my %lt = &Apache::lonlocal::texthash(
5524: 'format' => 'How should each column be formatted?',
5525: 'width' => 'Width',
5526: 'height' => 'Height',
5527: 'margin' => 'Left Margin'
5528: );
5529:
5530: $result .= '<p>'.$lt{'format'}.'</p>'
5531: .&Apache::lonhtmlcommon::start_pick_box()
5532: .&Apache::lonhtmlcommon::row_title($lt{'width'})
5533: .'<input type="text" name="'.$var.'.width" value="'.$size{'width'}.'" size="4" />'
5534: .'<select name="'.$var.'.widthunit">'
5535: .$size{'width_options'}
5536: .'</select>'
5537: .&Apache::lonhtmlcommon::row_closure()
5538: .&Apache::lonhtmlcommon::row_title($lt{'height'})
5539: .'<input type="text" name="'.$var.'.height" value="'.$size{'height'}.'" size="4" />'
5540: .'<select name="'.$var.'.heightunit">'
5541: .$size{'height_options'}
5542: .'</select>'
5543: .&Apache::lonhtmlcommon::row_closure()
5544: .&Apache::lonhtmlcommon::row_title($lt{'margin'})
5545: .'<input type="text" name="'.$var.'.lmargin" value="'.$size{'margin'}.'" size="4" />'
5546: .'<select name="'.$var.'.lmarginunit">'
5547: .$size{'margin_options'}
5548: .'</select>'
5549: .&Apache::lonhtmlcommon::row_closure(1)
5550: .&Apache::lonhtmlcommon::end_pick_box();
5551: # <p>Hint: Some instructors like to leave scratch space for the student by
5552: # making the width much smaller than the width of the page.</p>
5553:
5554: return $result;
5555: }
5556:
5557:
5558: sub preprocess {
5559: my $self = shift;
5560: my $helper = Apache::lonhelper::getHelper();
5561:
5562: my $format = $helper->{VARS}->{$self->{'formatvar'}};
5563:
5564: # If the user does not have 'pav' privilege, set default widths and
5565: # on to the next state right away.
5566: #
5567: if (!$perm{'pav'}) {
5568: my $var = $self->{'variable'};
5569: my $format = $helper->{VARS}->{$self->{'formatvar'}};
5570:
5571: my ($laystyle, $cols, $papersize) = split(/\|/, $format);
5572: ($papersize) = split(/ /, $papersize);
5573:
5574:
5575: $laystyle = &Apache::lonprintout::map_laystyle($laystyle);
5576:
5577: # Figure out some good defaults for the print out and set them:
5578:
5579: my %size;
5580: ($size{'width'},
5581: $size{'height'},
5582: $size{'lmargin'})=
5583: &Apache::lonprintout::page_format($papersize, $laystyle, $cols);
5584:
5585: foreach my $dim ('width', 'height', 'lmargin') {
5586: my ($value, $units) = split(/ /, $size{$dim});
5587:
5588: $helper->{VARS}->{"$var.".$dim} = $value;
5589: $helper->{VARS}->{"$var.".$dim.'unit'} = $units;
5590:
5591: }
5592:
5593:
5594: # Transition to the next state
5595:
5596: $helper->changeState($self->{NEXTSTATE});
5597: }
5598:
5599: return 1;
5600: }
5601:
5602: sub postprocess {
5603: my $self = shift;
5604:
5605: my $var = $self->{'variable'};
5606: my $helper = Apache::lonhelper->getHelper();
5607: my $width = $helper->{VARS}->{$var .'.width'} = $env{"form.${var}.width"};
5608: my $height = $helper->{VARS}->{$var .'.height'} = $env{"form.${var}.height"};
5609: my $lmargin = $helper->{VARS}->{$var .'.lmargin'} = $env{"form.${var}.lmargin"};
5610: $helper->{VARS}->{$var .'.widthunit'} = $env{"form.${var}.widthunit"};
5611: $helper->{VARS}->{$var .'.heightunit'} = $env{"form.${var}.heightunit"};
5612: $helper->{VARS}->{$var .'.lmarginunit'} = $env{"form.${var}.lmarginunit"};
5613:
5614: my $error = '';
5615:
5616: # /^-?[0-9]+(\.[0-9]*)?$/ -> optional minus, at least on digit, followed
5617: # by an optional period, followed by digits, ending the string
5618:
5619: if ($width !~ /^-?[0-9]*(\.[0-9]*)?$/) {
5620: $error .= "Invalid width; please type only a number.<br />\n";
5621: }
5622: if ($height !~ /^-?[0-9]*(\.[0-9]*)?$/) {
5623: $error .= "Invalid height; please type only a number.<br />\n";
5624: }
5625: if ($lmargin !~ /^-?[0-9]*(\.[0-9]*)?$/) {
5626: $error .= "Invalid left margin; please type only a number.<br />\n";
5627: } else {
5628: # Adjust for LaTeX 1.0 inch margin:
5629:
5630: if ($env{"form.${var}.lmarginunit"} eq "in") {
5631: $helper->{VARS}->{$var.'.lmargin'} = $lmargin - 1;
5632: } else {
5633: $helper->{VARS}->{$var.'.lmargin'} = $lmargin - 2.54;
5634: }
5635: }
5636:
5637: if (!$error) {
5638: Apache::lonhelper::getHelper()->changeState($self->{NEXTSTATE});
5639: return 1;
5640: } else {
5641: $self->{ERROR_MSG} = $error;
5642: return 0;
5643: }
5644: }
5645:
5646: __END__
5647:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>