--- loncom/interface/lonprintout.pm	2007/07/25 23:20:38	1.506
+++ loncom/interface/lonprintout.pm	2008/01/28 11:40:42	1.513
@@ -1,8 +1,7 @@
-#
 # The LearningOnline Network
 # Printout
 #
-# $Id: lonprintout.pm,v 1.506 2007/07/25 23:20:38 albertel Exp $
+# $Id: lonprintout.pm,v 1.513 2008/01/28 11:40:42 foxr Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -38,6 +37,8 @@ use Apache::grades;
 use Apache::edit;
 use Apache::File();
 use Apache::lonnavmaps;
+use Apache::admannotations;
+
 use LONCAPA::map();
 use POSIX qw(strftime);
 use Apache::lonlocal;
@@ -70,6 +71,27 @@ sub fetch_raw_resource {
     
 }
 
+#  Fetch the annotations associated with a URL and 
+#  put a centered 'annotations:' title.
+#  This is all suppressed if the annotations are empty.
+#
+sub annotate {
+    my ($symb) = @_;
+
+    my $annotation_text = &Apache::admannotations::get_annotation($symb, 1);
+
+
+    my $result = "";
+
+    if (length($annotation_text) > 0) {
+	$result .= '\\hspace*{\\fill} \\\\[\\baselineskip] \textbf{Annotations:} \\\\ ';
+	$result .= "\n";
+	$result .= &Apache::lonxml::latex_special_symbols($annotation_text,"");	# Escape latex.
+	$result .= "\n\n";
+    }
+    return $result;
+}
+
 #
 #   printf_style_subst  item format_string repl
 #  
@@ -733,6 +755,13 @@ sub character_chart {
     $result =~ s/&\#8600;/\\ensuremath\{\\searrow\}/g;
     $result =~ s/&\#8601;/\\ensuremath\{\\swarrow\}/g;
     $result =~ s/&\#8598;/\\ensuremath\{\\nwarrow\}/g;
+
+    # Left/right quotations:
+
+    $result =~ s/&(ldquo|#8220);/\`\`/g;
+    $result =~ s/&(rdquo|#8221);/\'\'/g;
+
+
     return $result;
 }
 
@@ -1319,6 +1348,8 @@ sub output_data {
 </script>
 ENDPART
 
+
+
     my $start_page  = &Apache::loncommon::start_page('Preparing Printout',$js);
     my $msg = &mt('Please stand by while processing your print request, this may take some time ...');
 
@@ -1352,6 +1383,7 @@ ENDPART
     my @print_array=();
     my @student_names=();
 
+     
     #  Common settings for the %form has:
     # In some cases these settings get overriddent by specific cases, but the
     # settings are common enough to make it worthwhile factoring them out
@@ -1389,6 +1421,7 @@ ENDPART
 	    $currentURL=$helper->{'VARS'}->{'postdata'};
 	    $cleanURL=&Apache::lonenc::check_decrypt($currentURL);
 	} else {
+
             #prints resource from the construction space
 	    $currentURL='/'.$helper->{'VARS'}->{'filename'};
 	    if ($currentURL=~/([^?]+)/) {$currentURL=$1;}
@@ -1407,7 +1440,11 @@ ENDPART
 		$form{'suppress_tries'}=$parmhash{'suppress_tries'};
 		$form{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
 		$form{'print_discussions'}=$helper->{'VARS'}->{'PRINT_DISCUSSIONS'};
-		if ($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes') {$form{'problem_split'}='yes';}
+		$form{'print_annotations'}=$helper->{'VARS'}->{'PRINT_ANNOTATIONS'};
+		if (($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes') ||
+		    ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes')) {
+		    $form{'problem_split'}='yes';
+		}
 		if ($helper->{'VARS'}->{'curseed'}) {
 		    $rndseed=$helper->{'VARS'}->{'curseed'};
 		}
@@ -1419,6 +1456,8 @@ ENDPART
 		$resources_printed .= $currentURL.':';
 		$texversion.=&Apache::lonnet::ssi($currentURL,%form);
 
+		#  Add annotations if required:
+	    
 		&Apache::lonxml::clear_problem_counter();
 
 		&Apache::lonnet::delenv('request.filename');
@@ -1437,6 +1476,8 @@ ENDPART
 		}
 		$resources_printed .= $currentURL.':';
 		my $answer=&Apache::lonnet::ssi($currentURL,%form);
+		
+
 		if ($helper->{'VARS'}->{'ANSWER_TYPE'} eq 'no') {
 		    $texversion=~s/(\\keephidden{ENDOFPROBLEM})/$answer$1/;
 		} else {
@@ -1454,7 +1495,20 @@ ENDPART
 		    }
 		    $texversion.='\vskip 1 mm '.$answer.'\end{document}';
 		}
+
+
+		
+
 	    }
+	    # Print annotations.
+
+
+	    if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
+		my $annotation .= &annotate($currentURL);
+		$texversion =~ s/(\\keephidden{ENDOFPROBLEM})/$annotation$1/;
+	    }
+
+
 	    if ($helper->{'VARS'}->{'TABLE_INDEX'} eq 'yes') {
 		$texversion=&IndexCreation($texversion,$currentURL);
 	    }
@@ -1483,6 +1537,10 @@ ENDPART
 		if ($currentURL=~/\/syllabus$/) {$currentURL=~s/\/res//;}
 		$resources_printed .= $currentURL.':';
 		my $texversion=&Apache::lonnet::ssi($currentURL,%form);
+		if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
+		    my $annotation = &annotate($currentURL);
+		    $texversion    =~ s/(\\end{document})/$annotation$1/;
+		}
 		$result .= $texversion;
 	} elsif ($cleanURL =~/.tex$/) {
 	    # For this sort of print of a single LaTeX file,
@@ -1490,6 +1548,11 @@ ENDPART
 	    #
 
 	    $result = &fetch_raw_resource($currentURL);
+	    if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
+		my $annotation = &annotate($currentURL);
+		$result =~ s/(\\end{document})/$annotation$1/;
+	    }
+
 	    $do_postprocessing = 0; # Don't massage the result.
 
 	} else {
@@ -1501,6 +1564,8 @@ ENDPART
              ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'all_problems')       or
 	     ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'all_resources')      or # BUGBUG
 	     ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'select_sequences')) { 
+
+
         #-- produce an output string
 	if ($helper->{'VARS'}->{'PRINT_TYPE'} eq 'map_problems') {
 	    $selectionmade = 2;
@@ -1517,7 +1582,11 @@ ENDPART
 	$form{'suppress_tries'}=$parmhash{'suppress_tries'};
 	$form{'latex_type'}=$helper->{'VARS'}->{'LATEX_TYPE'};
 	$form{'print_discussions'}=$helper->{'VARS'}->{'PRINT_DISCUSSIONS'};
-	if ($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes') {$form{'problem_split'}='yes';}
+	$form{'print_annotations'} = $helper->{'VARS'}->{'PRINT_ANNOTATIONS'};
+	if (($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes')   ||
+	    ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') ) {
+	    $form{'problem_split'}='yes';
+	}
 	my $flag_latex_header_remove = 'NO';
 	my $flag_page_in_sequence = 'NO';
 	my @master_seq=split /\|\|\|/, $helper->{'VARS'}->{'RESOURCES'};
@@ -1547,7 +1616,6 @@ ENDPART
 	    if ($urlp!~m|^/adm/|
 		&& $urlp=~/\.(problem|exam|quiz|assess|survey|form|library|page|xml|html|htm|xhtml|xhtm)$/) {
 		$resources_printed .= $urlp.':';
-
 		&Apache::lonxml::remember_problem_counter();
 		$texversion.=&Apache::lonnet::ssi($urlp,%form);
 		if ($urlp=~/\.page$/) {
@@ -1584,7 +1652,13 @@ ENDPART
 			    $texversion='';
 			}
 		    }
+
 		}
+		if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
+		    my $annotation .= &annotate($urlp);
+		    $texversion =~ s/(\\keephidden{ENDOFPROBLEM})/$annotation$1/;
+		}
+
 		if ($flag_latex_header_remove ne 'NO') {
 		    $texversion = &latex_header_footer_remove($texversion);
 		} else {
@@ -1616,6 +1690,11 @@ ENDPART
 		if ($urlp=~/\/syllabus$/) {$urlp=~s/\/res//;}
 		$resources_printed .= $urlp.':';
 		my $texversion=&Apache::lonnet::ssi($urlp,%form);
+		if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
+		    my $annotation = &annotate($urlp);
+		    $texversion =~ s/(\\end{document)/$annotation$1/;
+		}
+
 		if ($flag_latex_header_remove ne 'NO') {
 		    $texversion = &latex_header_footer_remove($texversion);
 		} else {
@@ -1691,9 +1770,13 @@ ENDPART
          $moreenv{'instructor_comments'}='hide';
 	 $moreenv{'textwidth'}=&get_textwidth($helper,$LaTeXwidth);
 	 $moreenv{'print_discussions'}=$helper->{'VARS'}->{'PRINT_DISCUSSIONS'};
+	 $moreenv{'print_annotations'} = $helper->{'VARS'}->{'PRINT_ANNOTATIONS'};
 	 $moreenv{'problem_split'}    = $parmhash{'problem_stream_switch'};
 	 $moreenv{'suppress_tries'}   = $parmhash{'suppress_tries'};
-	 if ($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes') {$moreenv{'problem_split'}='yes';}
+	 if (($helper->{'VARS'}->{'PRINT_DISCUSSIONS'} eq 'yes')  ||
+	     ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes')) {
+	     $moreenv{'problem_split'}='yes';
+	 }
 	 my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin($r,'Print Status','Class Print Status',$#students+1,'inline','75');
 	 my $student_counter=-1;
 	 my $i = 0;
@@ -1969,10 +2052,7 @@ ENDPART
     }
 
     my $URLback=''; #link to original document
-    if ($helper->{'VARS'}->{'construction'} ne '1') {
-	#prints published resource
-	$URLback=&escape('/adm/flip?postdata=return:');
-    } else {
+    if ($helper->{'VARS'}->{'construction'} eq '1') {
 	#prints resource from the construction space
 	$URLback='/'.$helper->{'VARS'}->{'filename'};
 	if ($URLback=~/([^?]+)/) {
@@ -2061,6 +2141,7 @@ sub print_resources {
     #   postscript.  Each ENDOFSTUDENTSTAMP will go on a line by itself.
     #
 
+
     foreach my $curresline (@{$master_seq})  {
 	if (defined $page_breaks{$curresline}) {
 	    if($i != 0) {
@@ -2068,6 +2149,7 @@ sub print_resources {
 	    }
 	}
 	$i++;
+
 	if ( !($type eq 'problems' && 
 	       ($curresline!~ m/\.(problem|exam|quiz|assess|survey|form|library)$/)) ) {
 	    my ($map,$id,$res_url) = &Apache::lonnet::decode_symb($curresline);
@@ -2106,6 +2188,12 @@ sub print_resources {
 			    $rendered = $header.$body;
 			}
 		    }
+
+		    if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
+			my $url = &Apache::lonnet::clutter($res_url);
+			my $annotation = &annotate($url);
+			$rendered =~  s/(\\keephidden{ENDOFPROBLEM})/$annotation$1/;
+		    }
 		    if ($remove_latex_header eq 'YES') {
 			$rendered = &latex_header_footer_remove($rendered);
 		    } else {
@@ -2115,7 +2203,11 @@ sub print_resources {
 		} elsif ($res_url=~/\/(smppg|syllabus|aboutme|bulletinboard)$/) {
 		    $printed .= $curresline.':';
 		    my $rendered = &Apache::loncommon::get_student_view($curresline,$username,$userdomain,$env{'request.course.id'},'tex',$moreenv);
-
+		    if ($helper->{'VARS'}->{'PRINT_ANNOTATIONS'} eq 'yes') {
+			my $url = &Apache::lonnet::clutter($res_url);
+			my $annotation = &annotate($url);
+			$annotation    =~ s/(\\end{document})/$annotation$1/;
+		    }
 		    if ($remove_latex_header eq 'YES') {
 			$rendered = &latex_header_footer_remove($rendered);
 		    } else {
@@ -2222,6 +2314,28 @@ sub init_perm {
     }
 }
 
+sub get_randomly_ordered_warning {
+    my ($helper,$map) = @_;
+
+    my $message;
+
+    my $postdata = $env{'form.postdata'} || $helper->{VARS}{'postdata'};
+    my $navmap = Apache::lonnavmaps::navmap->new();
+    my $res = $navmap->getResourceByUrl($map);
+    if ($res) {
+	my $func = 
+	    sub { return ($_[0]->is_map() && $_[0]->randomorder); };
+	my @matches = $navmap->retrieveResources($res, $func,1,1,1);
+	if (@matches) {
+	    $message = "Some of the items below are in folders set to be randomly ordered. However, when printing the contents of these folders, they will be printed in the original order for all students, not the randomized order.";
+	}
+    }
+    if ($message) {
+	return '<message type="warning">'.$message.'</message>';
+    }
+    return;
+}
+
 sub printHelper {
     my $r = shift;
 
@@ -2358,7 +2472,7 @@ sub printHelper {
 	$helper->{VARS}->{'curseed'}=$env{'form.curseed'};
     }
     if (!$helper->{VARS}->{'probstatus'} && $env{'form.problemtype'}) {
-	$helper->{VARS}->{'probstatus'}=$env{'form.problemtype'};
+	$helper->{VARS}->{'probstatus'}=$env{'form.problemstatus'};
     }
 
     my $userCanSeeHidden = Apache::lonnavmaps::advancedUser();
@@ -2448,8 +2562,8 @@ HELPERFRAGMENT
     if ($perm{'pfo'} &&  !$is_published  &&
         ($helper->{VARS}->{'postdata'}=~/\/res\// || $helper->{VARS}->{'postdata'}=~/\/(syllabus|smppg|aboutme|bulletinboard)$/)) { 
 
-        push @{$printChoices}, ['Selected <b>Problems</b> from <b>entire course</b>', 'all_problems', 'ALL_PROBLEMS'];
-	push @{$printChoices}, ['Selected <b>Resources</b> from <b>entire course</b>', 'all_resources', 'ALL_RESOURCES'];
+        push @{$printChoices}, [&mtn('Selected <b>Problems</b> from <b>entire course</b>'), 'all_problems', 'ALL_PROBLEMS'];
+	push @{$printChoices}, [&mtn('Selected <b>Resources</b> from <b>entire course</b>'), 'all_resources', 'ALL_RESOURCES'];
          &Apache::lonxml::xmlparse($r, 'helper', <<ALL_PROBLEMS);
   <state name="ALL_PROBLEMS" title="Select Problem(s) to print">
     <resource variable="RESOURCES" toponly='0' multichoice="1"
@@ -2477,6 +2591,9 @@ ALL_PROBLEMS
 	    push @{$printChoices}, [&mt("Selected <b>Problems</b> from folder <b><i>[_1]</i></b> for <b>CODEd assignments</b>",$sequenceTitle), 'problems_for_anon', 'CHOOSE_ANON1'];
 	}
 
+	my $randomly_ordered_warning = 
+	    &get_randomly_ordered_warning($helper,$map);
+
 	# resource_selector will hold a few states that:
 	#   - Allow resources to be selected for printing.
 	#   - Determine pagination between assignments.
@@ -2488,6 +2605,8 @@ ALL_PROBLEMS
 	#
 	my $resource_selector=<<RESOURCE_SELECTOR;
     <state name="SELECT_PROBLEMS" title="Select resources to print">
+    $randomly_ordered_warning
+
    <nextstate>PRINT_FORMATTING</nextstate> 
    <message><br /><big><i><b>Select resources for the assignment</b></i></big><br /></message>
     <resource variable="RESOURCES" multichoice="1" addstatus="1" 
@@ -2655,6 +2774,8 @@ CHOOSE_ANON1
 
 	$resource_selector=<<RESOURCE_SELECTOR;
     <state name="SELECT_RESOURCES" title="Select Resources">
+    $randomly_ordered_warning
+
     <nextstate>PRINT_FORMATTING</nextstate>
     <message><br /><big><i><b>Select resources for the assignment</b></i></big><br /></message>
     <resource variable="RESOURCES" multichoice="1" addstatus="1" 
@@ -2794,7 +2915,7 @@ CHOOSE_FROM_SUBDIR
     # Allow the user to select any sequence in the course, feed it to
     # another resource selector for that sequence
     if (!$helper->{VARS}->{'construction'} && !$is_published) {
-	push @$printChoices, ["Selected <b>Resources</b> from <b>selected folder</b> in course",
+	push @$printChoices, [&mtn("Selected <b>Resources</b> from <b>selected folder</b> in course"),
 			      'select_sequences', 'CHOOSE_SEQUENCE'];
 	my $escapedSequenceName = $helper->{VARS}->{'SEQUENCE'};
 	#Escape apostrophes and backslashes for Perl
@@ -2923,6 +3044,21 @@ CHOOSE_FROM_ANY_SEQUENCE
 	    Apache::lonhelper::dropdown->new();
 	    addMessage("</td></tr>");
 
+	    # Prompt for printing annotations too.
+		
+	    addMessage("<tr><td align='right'>".
+		       '<label for="PRINT_ANNOTATIONS_forminput">'.
+		       &mt('Print Annotations').
+		       "</label>:</td><td>");
+	    $paramHash = Apache::lonhelper::getParamHash();
+	    $paramHash->{'variable'} = "PRINT_ANNOTATIONS";
+	    $helper->declareVar("PRINT_ANNOTATIONS");
+	    $paramHash->{CHOICES} = [
+				     ['No', 'no'],
+				     ['Yes', 'yes']];
+	    Apache::lonhelper::dropdown->new();
+	    addMessage("</td></tr>");
+
 	    addMessage("<tr><td align = 'right'>  </td><td>");
 	    $paramHash = Apache::lonhelper::getParamHash();
 	    $paramHash->{'multichoice'} = "true";
@@ -2962,6 +3098,24 @@ CHOOSE_FROM_ANY_SEQUENCE
 	     <message></td></tr></message>
 RNDSEED
             &Apache::lonxml::xmlparse($r, 'helper', $xmlfrag);
+
+
+	    addMessage("<tr><td>Problem Type:</td><td>");
+	    $paramHash = &Apache::lonhelper::getParamHash();
+	    $paramHash->{'variable'} = 'probstatus'; # Already declared:
+	    #
+	    # Initial value from construction space:
+	    #
+	    if (!$helper->{VARS}->{'probstatus'} && $env{'form.problemtype'}) {
+		$helper->{VARS}->{'probstatus'} = $env{'form.problemtype'};	# initial value
+	    }
+	    $paramHash->{CHOICES} = [
+				     ['Homework problem',     'problem'],
+				     ['Exam Problem', 'exam'],
+				     ['Survey question',      'survey']];
+	    Apache::lonhelper::dropdown->new();
+	    addMessage("</td></tr>"); 
+
 	} 
     }