silverstripe / silverstripe-documentconverter

src/ServiceConnector.php

<?php

namespace SilverStripe\DocumentConverter;

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

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

    use Configurable;
    use Injectable;

    /**
     * @config
     * @var array Docvert connection username
     */
    private static $username = null;

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

    /**
     * @config
     * @var array Docvert connection password
     */
    private static $password = null;

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

    /**
     * @config
     * @var array Docvert service URL
     */
    private static $url = null;

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

    /**
     * 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
     */
    protected $docvertDetails = [
        'username' => null,
        'password' => null,
        'url' => null
    ];

    public function __construct($fileDescriptor, $chosenFolderID = null)
    {
        $this->fileDescriptor = $fileDescriptor;
        $this->chosenFolderID = $chosenFolderID;
    }


    /**
     * Retrieves detail in priority order from
     * 1. local instance field
     * 2. Config
     * 3. Environment
     *
     * @param string $detail key name for detail
     * @return string the value for that key
     */
    protected function getDetail($detail)
    {
        $fromDetails = $this->docvertDetails[$detail];
        if ($fromDetails) {
            return $fromDetails;
        }
        
        $fromConfig = $this->config()->get($detail);
        if ($fromConfig) {
            return $fromConfig;
        }

        $fromEnv = Environment::getEnv('DOCVERT_' . strtoupper($detail));
        if ($fromEnv) {
            return $fromEnv;
        }
    }

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

    public function getUsername()
    {
        return $this->getDetail('username');
    }

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

    public function getPassword()
    {
        return $this->getDetail('password');
    }

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

    public function getUrl()
    {
        return $this->getDetail('url');
    }

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

        $file = new CURLFile(
            $this->fileDescriptor['path'],
            $this->fileDescriptor['mimeType'],
            $this->fileDescriptor['name']
        );

        curl_setopt_array($ch, [

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

            CURLOPT_URL => $this->getUrl(),
            CURLOPT_USERPWD => sprintf('%s:%s', $this->getUsername(), $this->getPassword()),
            CURLOPT_POST => 1,
            CURLOPT_POSTFIELDS => ['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);

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

        $returnValue = curl_exec($ch);

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

        $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

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

        curl_close($ch);

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

        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 ['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, e.g. apt-get install php-zip
        $zip = new ZipArchive();

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

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

        if (!file_exists(ASSETS_PATH . $folderName . '/index.html')) {
            return ['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;
    }
}