Tikz -- proof of concept only -- don't pull into develop (yet) on openwebwork

lib/PGcore.pm

@@ -759,7 +759,7 @@ sub AskSage {
 	my $self = shift;
 	my $python = shift;
 	my $options = shift;
-	$options->{curlCommand} = $self->{envir}->{externalCurlCommand};
+	$options->{curlCommand} = WeBWorK::PG::IO::curlCommand();  #FIXME just changed from alternate source
 	WeBWorK::PG::IO::AskSage($python, $options);
 }
 

lib/TikZ_Image2.pm

@@ -0,0 +1,210 @@
+#!/bin/perl
+
+#This is a Perl Module which simplifies and automates the process of generating
+# simple images using TikZ, and converting them into a Web-Useable format
+# MV; March 2014
+
+use strict; 
+use warnings;
+use Carp;
+
+package TikZ_Image2;
+
+use WeBWorK::PG::IO;
+#The constructor is meant to be called with no parameters
+sub new {
+	my $class = shift;
+	my $rh_envir = shift;
+	my $tex=();
+	my $tikz_options = shift;
+	my $self = {
+			code			 =>	$tex, 
+			tikz_options	 =>	$tikz_options,
+			working_dir      => '',
+			file_name 		 => '',
+			destination_path => '',
+			pdflatex_command => WeBWorK::PG::IO::pdflatexCommand(),
+			convert_command  => WeBWorK::PG::IO::convertCommand(),
+			copy_command     => WeBWorK::PG::IO::copyCommand(),
+			# rh_envir       => $rh_envir,   # pointer to the environment
+			displayMode      => $rh_envir->{displayMode},
+			ext              => 'png',  # or svg or png or gif
+	};
+	return bless $self, $class;
+}
+
+#FIXME -- passing in the actual commands to TikZ_Image2.pm
+#FIXME -- is extremely dangerous.  It gives command line access
+#FIXME -- to authors to insert just about any command.
+#FIXME -- allow ext to be overridden
+#typical values for command line apps
+
+
+# how should this module get the pdflatex command
+# and the convert command -- it needs access to site.conf
+# or else those locations need to be shared with PGcore
+# Call this method in the location where you want to generate your HTML code
+# OR, comment out print HTML $self->include() and use it when your image is 
+# complete
+
+#tempDirectory	=>	 /Volumes/WW_test/opt/webwork/webwork2/htdocs/tmp/daemon_course/
+# tempURL	=>	 /webwork2_files/tmp/daemon_course/
+# templateDirectory	=>	 /Volumes/WW_test/opt/webwork/courses/daemon_course/templates/
+
+
+# these should all be in $envir->{externalPdflatexPath} etc.
+# externalLaTeXPath	=>	 /Volumes/WW_test/opt/local/texlive/2010/bin/x86_64-darwin/latex
+# externalDvipngPath	=>	 /Volumes/WW_test/opt/local/texlive/2010/bin/x86_64-darwin/dvipng
+# externalcp	=>	 /bin/cp
+# externalPdflatexPath	=>	 /Volumes/WW_test/opt/local/texlive/2010/bin/x86_64-darwin/pdflatex --shell-escape
+# externalConvert	=>	 
+
+my $extern_pdflatex='';
+# sub set_commandline_mode {
+# 	my $self = shift;
+# 	my $commandline_mode = shift;    #FIXME this section is temporary
+# 	my $working_dir = $self->{working_dir};
+# 	if ($commandline_mode eq 'wwtest') {		
+# 		$extern_pdflatex="/Volumes/WW_test/opt/local/bin/pdflatex --shell-escape";
+# 		$self->{convert_command}  = "convert $working_dir/hardcopy.pdf "; #add destination file later
+# 		$self->{copy_command}     = "cp ";
+# 	} elsif ( $commandline_mode eq 'macbook') {
+# 		$extern_pdflatex ="/Library/TeX/texbin/pdflatex --shell-escape";
+# 		$self->{convert_command}  = "/usr/local/bin/convert $working_dir/hardcopy.pdf ";
+# 		$self->{copy_command}     = "cp ";
+# 	} elsif ( $commandline_mode eq 'hosted2') {
+# 		$extern_pdflatex="/usr/local/bin/pdflatex --shell-escape";
+# 		$self->{convert_command}  = "/usr/local/bin/convert $working_dir/hardcopy.pdf "; #add destination file later
+# 		$self->{copy_command}     = "cp ";
+# 	}
+# 	$self->{pdflatex_command} =  "cd " . $working_dir . " && "
+# 		. $extern_pdflatex. " >pdflatex.stdout 2>pdflatex.stderr hardcopy.tex";
+# }
+# Insert your TikZ image code, not including begin and end tags, as a single
+# string parameter for this method. Works best single quoted.
+sub addTex {
+	my $self= shift;
+	$self->{code} .= shift;
+}
+
+sub ext {
+	my $self = shift;
+	if (@_) {
+		return $self->{ext} = shift;
+	} else {
+		return $self->{ext};
+	}
+
+}
+sub header {
+	my $self = shift;
+	my @output=();
+	push @output, "\\documentclass{standalone}\n";
+	push @output, "\\usepackage{tikz}\n";
+	push @output, "\\usepackage{comment}\n"; # often used in tikz graphs
+	push @output, "\\begin{document}\n";
+#	push @output, "\\begin{tikzpicture}[".$self->{tikz_options}."]\n";
+	@output;
+}
+
+sub footer {
+	my $self = shift;
+	my @output=();
+#	push @output, "\\end{tikzpicture}\n";
+	push @output, "\\end{document}\n";
+	@output;
+}
+
+# how should this module get the pdflatex command
+# and the convert command -- it needs access to site.conf
+# or else those locations need to be shared with PGcore
+# Call this method in the location where you want to generate your HTML code
+# OR, comment out print HTML $self->include() and use it when your image is 
+# complete
+sub render {
+	my $self = shift;
+	my $working_dir =  $self->{working_dir};
+	my $file_name = $self->{file_name};
+	my $file_path = "$working_dir/hardcopy";
+	my $html_directory   = $self->{html_temp};
+	my $fh;
+	open( $fh, ">", "$file_path.tex" ) or warn "Can't open $file_path.tex for writing<br/>\n";
+	chmod( 0777, "$file_path.tex");
+	print $fh $self->header();
+	print $fh $self->{code}."\n";	
+	print $fh $self->footer();
+	close $fh;	
+	my $pdflatex_command = $self->{pdflatex_command};
+	warn "render:  $pdflatex_command <br/>\n";
+	system "$pdflatex_command ";  # produces a .pdf file
+	unless (-r "$working_dir/hardcopy.pdf" ) {
+		warn "file $working_dir/hardcopy.pdf was not created<br/>\n";
+	} else {
+		warn "file $working_dir/hardcopy.pdf created<br/>\n";
+		unless ($self->convert) {
+			warn "convert operation failed<br/>\n";
+		} else {
+			warn "convert operation success<br/>\n";	
+			unless ($self->copy) {
+				warn "copy operation failed<br/>\n";
+			} else {
+				warn "copy operation succeeded<br/>\n";
+			}
+		}
+	}
+	#$self->clean_up;
+
+#here I'm assuming there's some file open which generates the HTML code for the
+# problem and its page, so render() should be called in the problem text portion
+# of a PG file.
+	#print HTML $self->include();
+}
+sub convert {
+	my $self = shift;
+	my $working_dir =  $self->{working_dir};
+	my $file_name = $self->{file_name};
+	my $file_path = "$working_dir/$file_name";
+	my $ext = $self->{ext};   # or png or gif
+	my $convert_command = $self->{convert_command};
+	warn "converting: ","$convert_command  $file_path.$ext","\n"; 
+	system "$convert_command  $file_path.$ext";
+	return -r "$file_path.$ext";
+}
+
+sub clean_up {
+	my $self = shift;
+	my $working_dir =  $self->{working_dir};
+	my $file_name = $self->{file_name};
+	my $file_path = "$working_dir/$file_name";
+	if (-e "$file_path.tex") {
+		# warn "clean up rm -f $working_dir/*";
+		system "rm -f $working_dir/*";
+	}
+}
+sub copy {
+	my $self = shift;
+	my $working_dir =  $self->{working_dir};
+	my $file_name = $self->{file_name};
+	my $file_path = "$working_dir/$file_name";
+	my $destination_path = $self->{destination_path};
+	my $copy_command = $self->{copy_command};
+	my $ext = $self->{ext};
+	if ($self->{displayMode} ne 'TeX') {
+		warn "copy: $copy_command $working_dir/$file_name.$ext $destination_path.$ext\n";	
+		system "$copy_command $working_dir/$file_name.$ext $destination_path.$ext";
+		$self->{final_destination_path}= "$destination_path.$ext";
+		return -r "$destination_path.$ext";
+	} else {
+		warn "copy: $copy_command $working_dir/hardcopy.pdf $destination_path.pdf\n";	
+		system "$copy_command $working_dir/hardcopy.pdf $destination_path.pdf";
+		$self->{final_destination_path}= "$destination_path.pdf";
+		return -r "$destination_path.pdf";
+	}
+}
+
+#Separating out the html so as not to get confused
+sub include {
+	my $html= qq|<img src=img.png alt="TikZ Image">|;
+	return $html;
+}
+1;

lib/WeBWorK/PG/IO.pm

@@ -13,6 +13,8 @@ use WeBWorK::CourseEnvironment;
 my $CE = new WeBWorK::CourseEnvironment({
     webwork_dir => $ENV{WEBWORK_ROOT},
 					});
+
+
 =head1 NAME
 
 WeBWorK::PG::IO - Private functions used by WeBWorK::PG::Translator for file IO.
@@ -250,11 +252,56 @@ Checks to see if the given path is a sub directory of the courses directory
 
 =cut
 
-sub path_is_course_subdir {
-
+sub path_is_course_subdir {  
     return path_is_subdir(shift,$CE->{webwork_courses_dir},1);
 }
 
+
+
+
+=item curlCommand 
+
+	curl -- path to curl defined in site.conf
+
+=cut
+
+#FIXME change {curlCommand} to {curl}, here, and site.conf 
+
+sub WeBWorK::PG::IO::curlCommand {
+	# $CE->{externalPrograms}->{curlCommand};
+	$CE->{externalPrograms}->{curl};
+}
+=item convertCommand
+
+	convert -- path to convert defined in site.conf
+
+=cut
+
+sub WeBWorK::PG::IO::convertCommand {
+	$CE->{externalPrograms}->{convert};
+}
+
+=item pdflatexCommand
+
+	pdflatex -- path to pdflatex defined in site.conf
+
+=cut
+
+sub WeBWorK::PG::IO::pdflatexCommand {
+	$CE->{externalPrograms}->{pdflatex};
+}
+
+=item copyCommand
+
+	copyCommand -- path to cp defined in site.conf
+
+=cut
+
+sub WeBWorK::PG::IO::copyCommand {
+	$CE->{externalPrograms}->{cp};
+}
+
+
 #
 # isolate the call to the sage server in case we have to jazz it up
 #

lib/WeBWorK/PG/ImageGenerator.pm

@@ -238,7 +238,7 @@ sub add {
 	my $url      = $self->{url};
 	my $basename = $self->{basename};
 	my $useCache = $self->{useCache};
-	my $depths  = $self->{depths};
+	my $depths   = $self->{depths};
 
 	# if the string came in with delimiters, chop them off and set the mode
 	# based on whether they were \[ .. \] or \( ... \). this means that if