kylekatarnls/jade-php

View on GitHub
src/Pug/Engine/PugJsEngine.php

Summary

Maintainability
A
1 hr
Test Coverage
<?php

namespace Pug\Engine;

use NodejsPhpFallback\NodejsPhpFallback;

/**
 * Class Pug\PugJsEngine.
 */
class PugJsEngine extends Keywords
{
    /**
     * @var NodejsPhpFallback
     */
    protected $nodeEngine;

    /**
     * Return the NodejsPhpFallback instance used to execute pug-cli via node.
     *
     * @return NodejsPhpFallback
     */
    public function getNodeEngine()
    {
        if (!$this->nodeEngine) {
            $this->nodeEngine = new NodejsPhpFallback($this->hasOption('node_path')
                ? $this->getDefaultOption('node_path')
                : 'node'
            );
        }

        return $this->nodeEngine;
    }

    protected function getHtml($file, array &$options)
    {
        if (empty($this->getDefaultOption('cache_dir'))) {
            $html = file_get_contents($file);
            unlink($file);

            return $html;
        }

        $currentDirectory = getcwd();
        $realPath = realpath($file);

        $handler = fopen($file, 'a');
        fwrite($handler, 'module.exports=template;');
        fclose($handler);

        $directory = dirname($file);
        $renderFile = './render.' . time() . mt_rand(0, 999999999) . '.js';
        chdir($directory);
        file_put_contents($renderFile,
            'console.log(require(' . json_encode($realPath) . ')' .
            '(require(' . json_encode($options['obj']) . ')));'
        );

        $node = $this->getNodeEngine();
        $html = $node->nodeExec($renderFile);
        unlink($renderFile);
        chdir($currentDirectory);

        return $html;
    }

    protected function parsePugJsResult($result, $path, array $options)
    {
        $result = explode('rendered ', $result);
        if (count($result) < 2) {
            throw new \RuntimeException(
                'Pugjs throw an error: ' . $result[0]
            );
        }
        $file = trim($result[1]);
        $html = $this->getHtml($file, $options);

        if ($options['delete']) {
            unlink($path);
        }

        unlink($options['obj']);

        return $html;
    }

    protected function getPugCliArguments($options)
    {
        $args = [];

        if (!empty($options['pretty'])) {
            $args[] = '--pretty';
            unset($options['pretty']);
        }

        foreach ($options as $option => $value) {
            if (!empty($value)) {
                $args[] = '--' . $option . ' ' . escapeshellarg($value);
            }
        }

        return $args;
    }

    /**
     * Returns true if the rendered file is up to date against the source.
     *
     * @param string      $renderFile
     * @param string      $filename
     * @param PugJsEngine $pug
     *
     * @return bool
     */
    public static function pugJsCacheCheck($renderFile, $filename, self $pug)
    {
        return file_exists($renderFile) && (
            filemtime($renderFile) >= filemtime($filename) ||
            !$pug->getDefaultOption('upToDateCheck')
        );
    }

    protected function getCachedHtml($input, $filename, $options)
    {
        $renderFile = $options['out'] . '/' . preg_replace('/\.[^.]+$/', '', basename($filename)) . '.js';
        $cacheCheck = $this->getDefaultOption('pugjs_cache_check', [static::class, 'pugJsCacheCheck']);

        if (call_user_func($cacheCheck, $renderFile, $filename, $this)) {
            $mTime = filemtime($renderFile);
            if (!$input) {
                $input = file_get_contents($filename);
            }
            $html = $this->parsePugJsResult('rendered ' . $renderFile, $input, $options);
            touch($renderFile, $mTime);

            return $html;
        }

        return false;
    }

    protected function checkCachedHtml($input, $filename, $options, &$args)
    {
        if (empty($this->getDefaultOption('cache_dir'))) {
            return false;
        }

        $args[] = '--client';

        return $this->getCachedHtml($input, $filename, $options);
    }

    protected function callPugCli($input, $filename, $options, $fallback)
    {
        $args = $this->getPugCliArguments($options);
        $html = $this->checkCachedHtml($input, $filename, $options, $args);

        if ($html) {
            return $html;
        }

        $directory = dirname($filename);
        $currentDirectory = getcwd();
        $basename = basename($filename);
        chdir($directory);
        $node = $this->getNodeEngine();
        $result = $node->execModuleScript(
            'pug-cli',
            'index.js',
            implode(' ', $args) .
            ' ' . escapeshellarg($basename) .
            ' 2>&1',
            $fallback
        );
        chdir($currentDirectory);

        return $this->parsePugJsResult($result, $filename, $options);
    }

    /**
     * Render using the native Pug JS engine.
     *
     * @param string   $input    pug input or file
     * @param string   $filename optional file path
     * @param array    $vars     to pass to the view
     * @param callable $fallback called if JS engine not available
     *
     * @throws \Exception
     *
     * @return string
     */
    public function renderWithJs($input, $filename, $vars = null, $fallback = null)
    {
        if (is_array($filename)) {
            if (!is_null($vars)) {
                $fallback = $vars;
            }
            $vars = $filename;
            $filename = null;
        }

        $vars = $this->mergeWithSharedVariables($vars);
        $workDirectory = empty($this->getDefaultOption('cache_dir'))
            ? sys_get_temp_dir()
            : $this->getOption('cache_dir');
        if ($toDelete = !$filename) {
            $filename = $workDirectory . '/source-' . mt_rand(0, 999999999) . '.pug';
            file_put_contents($filename, $input);
        }

        $options = [
            'path'    => realpath($filename),
            'basedir' => $this->getDefaultOption('basedir'),
            'pretty'  => $this->getDefaultOption('prettyprint'),
            'out'     => $workDirectory,
            'delete'  => $toDelete,
        ];

        $optionsFile = $workDirectory . '/options-' . mt_rand(0, 999999999) . '.js';
        file_put_contents($optionsFile, 'module.exports = require(' .
                json_encode(realpath(NodejsPhpFallback::getPrefixPath() . '/require.js')) .
            ').appendRequireMethod(' .
                (empty($vars) ? '{}' : json_encode($vars, JSON_UNESCAPED_SLASHES)) .
            ');'
        );
        $options['obj'] = $optionsFile;

        return $this->callPugCli($input, $filename, $options, $fallback);
    }

    /**
     * Render using the native Pug JS engine.
     *
     * @param string   $path     pug file
     * @param array    $vars     to pass to the view
     * @param callable $fallback called if JS engine not available
     *
     * @throws \Exception
     *
     * @return string
     */
    public function renderFileWithJs($path, array $vars, $fallback)
    {
        return $this->renderWithJs(null, $path, $vars, $fallback);
    }
}