SilverStripe\DocumentConverter\DocumentConverter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setDocvertUrl()	0	2	1
A	setDocvertUsername()	0	2	1
A	getDocvertUrl()	0	2	1
A	__construct()	0	4	1
A	getDocvertPassword()	0	2	1
C	import()	0	69	8
A	getDocvertUsername()	0	2	1
A	setDocvertPassword()	0	2	1

<?php

namespace SilverStripe\DocumentConverter;

use CURLFile;
use SilverStripe\Assets\Folder;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\ORM\DataObject;
use ZipArchive;

/**
 * Utility class hiding the specifics of the document conversion process.
 */
class DocumentConverter {

	use Configurable;

	/**
	 * @var array Docvert connection details
	 * @config
	 */
	private static $docvert_details = [

The private property $docvert_details is not used, and could be removed.

		'username' => '',
		'password' => '',
		'url' => ''
	];

	/**
	 * Associative array of:
	 * - name: the full name of the file including the extension.
	 * - path: the path to the file on the local filesystem.
	 * - mimeType
	 */
	protected $fileDescriptor;

	/**
	 * @var int
	 * ID of a SilverStripe\Assets\Folder
	 */
	protected $chosenFolderID;

	/**
	 * @var array instance specific connection details
	 * initially filled with the config settings
	 */
	protected $docvertDetails = [
		'username' => '',
		'password' => '',
		'url' => ''
	];

	public function __construct($fileDescriptor, $chosenFolderID = null) {
		$this->fileDescriptor = $fileDescriptor;
		$this->chosenFolderID = $chosenFolderID;
		array_merge($this->docvertDetails, (array)$this->config()->get('docvert_details'));
	}

	public function setDocvertUsername($username = null)  {
		$this->docvertDetails['username'] = $username;
	}

	public function getDocvertUsername() {
		return $this->docvertDetails['username'];
	}

	public function setDocvertPassword($password = null) {
		$this->docvertDetails['password'] = $password;
	}

	public function getDocvertPassword() {
		return $this->docvertDetails['password'];
	}

	public function setDocvertUrl($url = null) {
		$this->docvertDetails['url'] = $url;
	}

	public function getDocvertUrl() {
		return $this->docvertDetails['url'];
	}

	public function import() {
		$ch = curl_init();

		// PHP 5.5+ introduced CURLFile which makes the '@/path/to/file' syntax deprecated.
		if(class_exists('CURLFile')) {
			$file = new CURLFile(
				$this->fileDescriptor['path'],
				$this->fileDescriptor['mimeType'],
				$this->fileDescriptor['name']
			);
		} else {
			$file = '@' . $this->fileDescriptor['path'];
		}

		curl_setopt_array($ch, array(
			CURLOPT_URL => $this->getDocvertUrl(),
			CURLOPT_USERPWD => sprintf('%s:%s', $this->getDocvertUsername(), $this->getDocvertPassword()),
			CURLOPT_POST => 1,
			CURLOPT_POSTFIELDS => array('file' => $file),
			CURLOPT_CONNECTTIMEOUT => 25,
			CURLOPT_TIMEOUT => 100,
		));

		$chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
		$folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
		$outname = tempnam(ASSETS_PATH, 'convert');
		$outzip = $outname . '.zip';

		$out = fopen($outzip, 'w');
		curl_setopt($ch, CURLOPT_FILE, $out);
		$returnValue = curl_exec($ch);
		$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
		curl_close($ch);
		fclose($out);

It seems like $out can also be of type false; however, parameter $handle of fclose() does only seem to accept resource, maybe add an additional type check?

		chmod($outzip, 0666);

		if (!$returnValue || ($status != 200)) {
			return array('error' => _t(
				__CLASS__ . '.SERVERUNREACHABLE',
				'Could not contact document conversion server. Please try again later or contact your system administrator.',
				'Document Converter process Word documents into HTML.'
			));
		}

		// extract the converted document into assets
		// you need php zip, i.e. port install php5-zip
		$zip = new ZipArchive();

		if($zip->open($outzip)) {
			$zip->extractTo(ASSETS_PATH .$folderName);
		}

		// remove temporary files
		unlink($outname);
		unlink($outzip);

		if (!file_exists(ASSETS_PATH . $folderName . '/index.html')) {
			return array('error' =>  _t(
				__CLASS__ . '.PROCESSFAILED',
				'Could not process document, please double-check you uploaded a .doc or .docx format.',
				'Document Converter processes Word documents into HTML.'
			));
		}

		$content = file_get_contents(ASSETS_PATH . $folderName . '/index.html');

		unlink(ASSETS_PATH . $folderName . '/index.html');

		return $content;
	}

}