w2lLaTeXCompiler.php

<?php

/*
 * File: w2lLaTeXCompiler.php
 *
 * Purpose:
 * Provides the commandLine-interface to LaTeX
 *
 * License:
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

if ( !defined('MEDIAWIKI') ) {
	$msg  = 'To install Wiki2LaTeX, put the following line in LocalSettings.php:<br/>';
	$msg .= '<tt>require_once( $IP."/extensions/path_to_Wiki2LaTeX_files/wiki2latex.php" );</tt>';
	echo $msg;
	exit( 1 );
}

class Wiki2LaTeXCompiler {

	function __construct($piece, $mkdir) {
		global $w2lConfig;
		$this->files   = array();
		$this->command = $w2lConfig['ltx_command'];
		$this->sort    = $w2lConfig['ltx_sort'];
		$this->bibtex  = $w2lConfig['ltx_bibtex'];
		$this->repeat  = $w2lConfig['ltx_repeat'];

		$this->piece   = $piece;//name of the working (temporary) directory
		$this->path    = ''; //path of the working directory
		$this->mkdir   = $mkdir;
		
		$this->debug   = false;
		$this->log     = '';
		
		return true;
	}
	
	function addFiles($files) {
		$this->files = $files;
	}
	
	function generateFiles($tpl_vars) {
		global $wgOut;
		$msg = '';
		$tempdir  = wfTempDir(); // temporary dir
		$tempdir .= DIRECTORY_SEPARATOR.'w2ltmp-'.$this->piece;
		$this->path = $tempdir;

		//check whatever needed to work in the temp directory
		if ( true == $this->mkdir ) {
			if ( !@mkdir($this->path) ) {
				$wgOut->addHTML( wfMsg('w2l_temp_dir_missing') );
				return false;
			}
			if ( !file_exists($this->path) OR !is_dir($this->path) OR !is_writable($this->path) ) {
				$wgOut->addHTML( wfMsg('w2l_temp_dir_missing') );
				return false;
			}
			$chmod = chmod($this->path, 0777);

		}

		$cur_dir = getcwd();
		chdir($tempdir);
		/**
		 * @todo Add multilanguage support for the next strings => DONE
		 */
		foreach( $this->files as $file_name => $file_content) {
			$file_content = str_replace(array_keys($tpl_vars), array_values($tpl_vars), $file_content);
			$failure = file_put_contents($file_name, $file_content);
			if ( $failure !== false ) {
				$msg .= wfMsg('w2l_creating_file_success', $file_name,$failure);
				//$msg .= 'Creating file '.$file_name.' with '..' Bytes'."\n"; //migliorare supporto linguistico qui
			} else {
				$msg .= wfMsg('w2l_creating_file_error', $file_name,$failure);
				//$msg .= 'Error creating file '.$file_name."\n";
			}

			chmod($file_name, 0666);
		}
		chdir($cur_dir);
		$this->msg = $msg;
		return true;
	}
	
	function runLaTeX( $file = 'Main', $sort = false, $bibtex = false ) {
		
		//complete the shell command
		$command = str_replace('%file%', $file, $this->command);

		$cur_dir = getcwd();
		chdir($this->path);
	
		$go  = true;
		$i   = 1;
		//message with operation returning status
		$msg  = $this->msg;
		
		$msg .= wfMsg('w2l_compile_command', $command )."\n";
		$msg .= wfMsg('w2l_temppath', $this->path )."\n";
		
		if ( $this->debug == true ) {
			$msg .= "User: ".wfShellExec("whoami");
		}
		
		while ( (true == $go ) OR ( $i > 5 ) ) {
			$msg .= "\n".wfMsg('w2l_compile_run', $i)."\n";

			$msg .= wfShellExec($command);

			if ( !file_exists( $file.'.pdf' ) ) {
				$msg .= wfMsg('w2l_pdf_not_created')."\n";
				$compile_error = true;
				$go = false;
			} else {
				$compile_error = false;

				if ( true == $sort ) {
					// sort it, baby
					$msg .= '===Sort-Result==='."\n";
					$msg .= $this->sortIndexFile($file);
					$msg .= "\n";
				}
				/*
				if ( true == $bibtex ) {
					// run bibtex
					$msg .= '===BibTeX-Result==='."\n";
					$msg .= $this->doBibTex($file);
					$msg .= "\n";
				}
				*/
				
				if ( $this->repeat == $i ) {
					$go = false;
				}
				
				++$i;


			}
		}

		// Now chmod-ing some files
		$mod = 0666;
		if ( is_dir($this->path) ) {
			$directory = dir($this->path);
			while ( false !== ($tmp_file = $directory->read()) ) {
				if ( is_file($tmp_file) ) {
					$res = chmod($tmp_file, $mod);
				}
			}
			$directory->close();
		}
		
		$this->log = file_get_contents($file.'.log');
		chdir($cur_dir);

		$this->msg = $msg;
		return $compile_error;
	}
	
	function sortIndexFile($file = 'Main') {
		$command = str_replace('%file%', $file, $this->sort);
		$msg  = 'Command: '.$command; 
		$msg .= wfShellExec($command);
		return $msg;
	}
	
	function doBibTex($file = 'Main') {
		// Disabling this for now.
		return 'unsupported';
		
		$command = str_replace('%file%', $file, $this->bibtex);
		$msg  = 'Command: '.$command; 
		$msg .= wfShellExec($command);
		return $msg;
	}
	
	function getLog() {
		return $this->getCompileLog();
	}
	function getCompileLog() {
		return $this->msg;
	}
	
	function getLogFile() {
		return $this->log;
	}
}