SRF\SRFWord

Complexity

Total Complexity

47

Size/Duplication

Total Lines	362
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	31
Bugs	2	Features	7

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getMimeType()	0	3	1
A	getFileName()	0	5	2
A	outputAsFile()	0	8	2
A	getParamDefinitions()	0	10	1
A	getResultText()	0	17	3
A	writeDocumentToString()	0	8	1
A	populateDocumentWithQueryData()	0	9	3
A	getImageFilePath()	0	16	4
B	createWordDocument()	0	30	6
A	showLabel()	0	6	1
A	startsWith()	0	4	2
A	setValue()	0	6	2
C	readValue()	0	54	10
C	readRowData()	0	31	7
A	isPHPWordInstalled()	0	7	2

<?php

namespace SRF;

use ImagePage;
use SMW\FileExportPrinter;
use ParamProcessor\Definition\StringParam;
use SMWQueryResult;
use SMWDataItem;
use PhpOffice\PhpWord\PhpWord;
use Title;

/**
 * Semantic Results Format for Microsoft Word
 * @licence GNU GPL v2+
 *
 * @author Wolfgang Fahl < wf@bitplan.com >
 * @since 2.4
 */
class SRFWord extends FileExportPrinter {
	/**
	 * set to true for debug output
	 */
	private $debug = true;
	
	// show imageinformation in the word file
	private $imageDebug=false;
	
	/**
	 *
	 * @var int
	 */
	private $rowNum;
	
	/**
	 *
	 * @var int
	 */
	private $colNum;
	
	/**
	 * Some printers do not mainly produce embeddable HTML or Wikitext, but
	 * produce stand-alone files.
	 * An example is RSS or iCalendar. This function
	 * returns the mimetype string that this file would have, or FALSE if no
	 * standalone files are produced.
	 *
	 * If this function returns something other than FALSE, then the printer will
	 * not be regarded as a printer that displays in-line results. This is used to
	 * determine if a file output should be generated in Special:Ask.
	 *
	 * @param SMWQueryResult $queryResult        	
	 *
	 * @return string
	 */
	public function getMimeType(SMWQueryResult $queryResult) {
		return "application/msword";
	}
	
	/**
	 * get a file name for the Word file
	 *
	 * if the filename parameter is not specified a filename is generated
	 * from the current time
	 *
	 * @param SMWQueryResult $queryResult        	
	 *
	 * @return string
	 *
	 */
	public function getFileName(SMWQueryResult $queryResult) {
		// the filename can be given as a parameter
		$l_filename = $this->params ['filename'] ? $this->params ['filename'] : round ( microtime ( true ) * 1000 ) . '.docx';
		return $l_filename;
	}
	
	/**
	 * output the given query result with the given params as a file
	 *
	 * @param SMWQueryResult $queryResult        	
	 *
	 * @param array $params        	
	 *
	 */
	public function outputAsFile(SMWQueryResult $queryResult, array $params) {
		if ($this->isPHPWordInstalled ()) {
			parent::outputAsFile ( $queryResult, $params );
		} else {
			header ( 'Cache-Control: no-store, no-cache, must-revalidate' );
			echo $this->getResult ( $queryResult, $params, SMW_OUTPUT_FILE );
		}
	}
	
	/**
	 * return the parameter definitions
	 * searchlabel, templatefile and filename are possible
	 *
	 * @param $definitions \ParamProcessor\ParamDefinition[]        	
	 *
	 * @return array
	 */
	public function getParamDefinitions(array $definitions) {
		$params = parent::getParamDefinitions ( $definitions );
		
		$definitions ['searchlabel']->setDefault ( wfMessage ( 'srf-word-link' )->inContentLanguage ()->text () );
		
		$params ['templatefile'] = new StringParam ( 'string', 'templatefile', '' );
		$params ['filename'] = new StringParam ( 'string', 'filename', '' );
		
		return $params;
	}
	
	/**
	 * Return serialised results in specified format.
	 * 
	 * @param $res -
	 *        	the query result
	 * @param $outputMode -
	 *        	how to output - HTML or to a file?
	 */
	protected function getResultText(SMWQueryResult $res, $outputMode) {
		if ($outputMode == SMW_OUTPUT_FILE) {
			if ($this->isPHPWordInstalled ()) {
				$document = $this->createWordDocument ();
				// Get data rows
				$this->populateDocumentWithQueryData ( $res );
				$result = $this->writeDocumentToString ( $document );
			} else {
				$result = wfMessage ( 'srf-word-missing-phpword' )->parse ();
			}
		} else {
			$result = $this->getLink ( $res, $outputMode )->getText ( $outputMode, $this->mLinker );
			$this->isHTML = ($outputMode == SMW_OUTPUT_HTML);
		}
		
		return $result;
	}
	
	/*
	 * Turns the PHPWord document object into a string
	 * @param document - the document
	 */
	private function writeDocumentToString($document) {
		$l_tempFileName = $document->save ();
		// write to output pipe to allow downloading the resulting document
		ob_start ();
		readfile ( $l_tempFileName );
		// $objWriter->save('php://output');
		return ob_get_clean ();
	}
	
	/**
	 * Populates the PHPWord document with the query data
	 *
	 * @param $res SMWQueryResult
	 *        	the query result
	 */
	private function populateDocumentWithQueryData($res) {
		if ($this->debug)
			wfDebug ( "populating Document with Query data\n" );
		while ( $row = $res->getNext () ) {
			$this->rowNum ++;
			$this->colNum = 0;
			$this->readRowData ( $row );
		}
	}
	
	/**
	 * get the local ImageFilePath for the given filePageTitle
	 * 
	 * @param $p_FilePageTitle -
	 *        	the title of the File: page without prefix
	 * @return the local file path to the image file
	 */
	function getImageFilePath($p_FilePageTitle) {

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for getImageFilePath.

		$l_localFilePath = null;
		$l_fileTitle = Title::newFromText ( $p_FilePageTitle, NS_FILE );
		if ($l_fileTitle !== null && $l_fileTitle->exists ()) {
			if ($this->debug)
				wfDebug ( "got file title " . $l_fileTitle->getFullURL () . "\n" );
			$l_filePage = new ImagePage ( $l_fileTitle, $this );
			
			$l_virtualFile = $l_filePage->getDisplayedFile ();
			$l_virtualFilePath = $l_virtualFile->getPath ();
			
			$l_localFile = $l_virtualFile->getRepo ()->getLocalReference ( $l_virtualFilePath );
			$l_localFilePath = $l_localFile->getPath ();
		}
		return $l_localFilePath;
	}
	
	/**
	 * Creates a new PHPWord document and returns it
	 *
	 * @return PHPWord
	 */
	private function createWordDocument() {
		// get the templatefile pageTitle
		$l_templatefile = $this->params ['templatefile'];
		// get the local image file path for the template
		$l_localFilePath = $this->getImageFilePath ( $l_templatefile );
		if ($l_localFilePath != null) {
			if ($this->debug)
				wfDebug ( "template " . $l_templatefile . " for Word is at " . $l_localFilePath . "\n" );
				// see https://github.com/PHPOffice/PHPWord
			$this->objPHPWord = new \PhpOffice\PhpWord\PhpWord ();
			// the document to be saved is based on the template
			$this->document = $this->objPHPWord->loadTemplate ( $l_localFilePath );
		} else {
			if ($this->debug)
				wfDebug ( "creating word object with no template\n" );
				// see https://github.com/PHPOffice/PHPWord
			$this->objPHPWord = new \PhpOffice\PhpWord\PhpWord ();
			$this->document = $this->objPHPWord;
		}
		if ($this->debug)
			wfDebug ( "setting creator\n" );
			
			// Set document properties
		$l_properties = $this->objPHPWord->getDocInfo ();
		$l_properties->setCreator ( "SemanticMediaWiki PHPWord Export" );
		if ($this->debug)
			wfDebug ( "creator set\n" );
		
		return $this->document;
	}
	
	/**
	 * filter labels
	 * 
	 * @param
	 *        	$label
	 * @return bool
	 */
	private function showLabel($label) {
		$l_show = true;
		// filter labels
		// $l_show=!(array_key_exists("mainlabel", $this->params) && $label === $this->params[ "mainlabel" ] . '#');
		return $l_show;
	}
	
	/**
	 * check that a string starts with a given other string
	 * 
	 * @param
	 *        	haystack - the string to search in
	 * @param
	 *        	needle - the string to search for
	 */
	function startsWith($haystack, $needle) {

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for startsWith.

		// search backwards starting from haystack length characters from the end
		return $needle === "" || strrpos ( $haystack, $needle, - strlen ( $haystack ) ) !== FALSE;
	}
	
	/**
	 * set the Value for the given name and value in the word document
	 * 
	 * @param
	 *        	p_name the name of the field (needle)
	 * @param
	 *        	p_value the content of the field (value)
	 */
	private function setValue($p_name, $p_value) {
		if ($this->debug) {
			wfDebug ( "setting word document field " . $p_name . " with value '" . $p_value . "' \n" );
		}
		$this->document->setValue ( $p_name, $p_value );
	}
	
	/**
	 * get the Value for the given dataValue
	 * 
	 * @param
	 *        	dataValue - the dataValue to read the value from
	 * @param
	 *        	plabel - the label
	 */
	private function readValue(/* SMWDataValue */ $dataValue, $plabel) {
		$l_value = $dataValue->getShortWikiText ();
		// $l_value=$dataValue->getWikiValue();
		$l_type = $dataValue->getTypeID ();
		$l_ditype = "?";
		$l_dataItem = $dataValue->getDataItem ();
		if ($l_dataItem != null) {
			// get the data item type
			$l_ditype = $l_dataItem->getDIType ();
		}
		// uppercase/lower case handling?
		// $l_name=strtolower($plabel);
		$l_name = $plabel;
		if ($this->debug) {
			wfDebug ( "readValue from field: " . $l_name . "(type:" . $l_type . "/ditype:" . $l_ditype . ")=" . $l_value . "\n" );
		}
		// check whether the field points to an image
		$l_isimage = false;
		// first check if it is a wiki page
		if ($l_ditype == SMWDataItem::TYPE_WIKIPAGE) {
			$l_title = Title::newFromText ( $l_value );
			$l_ns = $l_title->getNamespace ();
			// then check whether it's in the file namespace
			if ($l_ns == NS_FILE) {
				$l_image = $this->getImageFilePath ( $l_value );
				// now we should check the mime type ...
				// $l_finfo = new finfo(FILEINFO_MIME);
				// $l_mimetype = $finfo->file('path/filename');
				$l_mimetype = mime_content_type ( $l_image );
				if ($this->startsWith ( $l_mimetype, "image" )) {
					$l_isimage = true;
					if ($this->debug) {
						wfDebug ( "field " . $l_name . " points to image rom FILE namespace with title: " . $l_title->getPrefixedText () . "\n\tlocated at " . $l_image . "\n\tmimetype " . $l_mimetype . " asked for \n" );
					}
				}
			}
		}
		if ($l_isimage) {
			if (method_exists($this->document, "setImageValueAlt")) {
				$this->document->setImageValueAlt ( $l_name, $l_image );

The variable $l_image does not seem to be defined for all execution paths leading up to this point.

				if ($this->imageDebug) {
					$l_rid = $this->document->searchImageId ( $l_name );
					$l_imagefile = $this->document->getImgFileName ( $l_rid );
					// only for debug
					$this->setValue ( $l_name, $l_value . "(" . $l_rid . "/" . $l_imagefile . ")" );
				} else {
					// text field version of image label
					$this->setValue ( $l_name, $l_value);
				}
			}
		} else {
			$this->setValue ( $l_name, $l_value );
		}
	}
	
	/**
	 * read data from the given row
	 * 
	 * @param $row -
	 *        	SMWResultArray
	 */
	private function readRowData($row) {
		// loop over fields of this row
		foreach ( $row as /* SMWResultArray */ $field ) {
			// http://kontext.fraunhofer.de/haenelt/kurs/Skripten/Wiki-Anleitungen/SMW-Ausgabeschnittstellex.pdf
			if ($this->debug) {

This if statement is empty and can be removed.

				// can not do this "Fatal error: Nesting level too deep - recursive dependency?
				// $l_fielddump = var_export($field, true);
				// wfDebug("fielddump=".$l_fielddump."\n");
			}
			$l_fieldinfo = $field->getPrintRequest ();
			$l_label = $l_fieldinfo->getLabel ();
			
			if ($this->debug) {
				wfDebug ( "field label=" . $l_label . "\n" );
			}
			// shall we display the content of the field with this label?
			if ($this->showLabel ( $l_label )) {
				// how many values did we set?
				$l_printcount = 0;
				while ( ( /* SMWDataValue */ $dataValue = $field->getNextDataValue ()) !== false ) {
					$this->readValue ( $dataValue, $l_label );
					$l_printcount ++;
				}
				// if no value was set yet
				if ($l_printcount == 0) {
					// set an empty entry
					$this->setValue ( $l_label, "" );
				}
			}
		}
	}
	
	/**
	 * check whether PHP Word is installed
	 */
	private function isPHPWordInstalled() {
		$l_result = class_exists ( "PhpOffice\PhpWord\PhpWord" );
		if ($this->debug) {
			wfDebug ( "isPhpWordInstalled: " . $l_result . "\n" );
		}
		return $l_result;
	}
}