-<?php
+<?php declare(strict_types=1);
-namespace Rapsys\PackBundle\Twig;
+/*
+ * This file is part of the Rapsys PackBundle package.
+ *
+ * (c) Raphaël Gertz <symfony@rapsys.eu>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Rapsys\PackBundle\Parser;
+
+use Psr\Container\ContainerInterface;
+
+use Rapsys\PackBundle\RapsysPackBundle;
+use Rapsys\PackBundle\Util\SluggerUtil;
use Symfony\Component\Asset\PackageInterface;
use Symfony\Component\Filesystem\Exception\IOExceptionInterface;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\HttpKernel\Config\FileLocator;
+use Symfony\Component\Routing\Exception\InvalidParameterException;
+use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
+use Symfony\Component\Routing\Exception\RouteNotFoundException;
+use Symfony\Component\Routing\RouterInterface;
+
use Twig\Error\Error;
use Twig\Node\Expression\AssignNameExpression;
use Twig\Node\Node;
use Twig\Token;
use Twig\TokenParser\AbstractTokenParser;
-class PackTokenParser extends AbstractTokenParser {
- ///The tag name
- protected $tag;
-
+/**
+ * {@inheritdoc}
+ */
+class TokenParser extends AbstractTokenParser {
/**
- * Constructor
- *
- * @param FileLocator locator The FileLocator instance
- * @param PackageInterface package The Assets Package instance
- * @param array config The config path
- * @param string tag The tag name
- * @param string output The default output string
- * @param array filters The default filters array
+ * Filters array
*/
- public function __construct(FileLocator $locator, PackageInterface $package, $config, $tag, $output, $filters) {
- //Save locator
- $this->locator = $locator;
-
- //Save assets package
- $this->package = $package;
-
- //Set name
- $this->name = $config['name'];
+ protected array $filters;
- //Set scheme
- $this->scheme = $config['scheme'];
-
- //Set timeout
- $this->timeout = $config['timeout'];
+ /**
+ * Output string
+ */
+ protected string $output;
- //Set agent
- $this->agent = $config['agent'];
+ /**
+ * Route string
+ */
+ protected string $route;
- //Set redirect
- $this->redirect = $config['redirect'];
+ /**
+ * Token string
+ */
+ protected string $token;
- //Set tag
- $this->tag = $tag;
+ /**
+ * Constructor
+ *
+ * @param ContainerInterface $container The ContainerInterface instance
+ * @param FileLocator $locator The FileLocator instance
+ * @param RouterInterface $router The RouterInterface instance
+ * @param SluggerUtil $slugger The SluggerUtil instance
+ * @param array $config The config
+ * @param mixed $ctx The context stream instance
+ * @param string $prefix The output prefix
+ * @param string $tag The tag name
+ */
+ public function __construct(protected ContainerInterface $container, protected FileLocator $locator, protected RouterInterface $router, protected SluggerUtil $slugger, protected array $config, protected mixed $ctx, protected string $prefix, protected string $tag) {
+ //Set filters
+ $this->filters = $config['filters'][$prefix];
//Set output
- $this->output = $output;
+ $this->output = $config['public'].'/'.$config['prefixes']['pack'].'/'.$config['prefixes'][$prefix].'/*.'.$prefix;
- //Set filters
- $this->filters = $filters;
+ //Set route
+ $this->route = $config['routes'][$prefix];
+
+ //Set token
+ $this->token = $config['tokens'][$prefix];
}
/**
*
* @return string This tag name
*/
- public function getTag() {
+ public function getTag(): string {
return $this->tag;
}
/**
* Parse the token
*
- * @param Token token The \Twig\Token instance
+ * @xxx Skip filter when debug mode is enabled is not possible
+ * @xxx This code is only run once when twig cache is enabled
+ * @xxx Twig cache value is not avaible in container parameters, maybe in twig env ?
*
+ * @param Token $token The \Twig\Token instance
* @return Node The PackNode
- *
- * @todo see if we can't add a debug mode behaviour
- *
- * If twig.debug or env=dev (or rapsys_pack.config.debug?) is set, it should be possible to loop on each input
- * and process the captured body without applying requested filter.
- *
- * @todo list:
- * - detect debug mode
- * - retrieve fixe link from input s%@(Name)Bundle/Resources/public(/somewhere/file.ext)%/bundles/\L\1\E\2%
- * - for each inputs:
- * - generate a set asset_url=x
- * - generate a body
*/
- public function parse(Token $token) {
+ public function parse(Token $token): Node {
+ //Get parser
$parser = $this->parser;
+
+ //Get parser stream
$stream = $this->parser->getStream();
+ //Set inputs array
$inputs = [];
- $name = $this->name;
- $output = $this->output;
- $filters = $this->filters;
+ //Set content
$content = '';
//Process the token block until end
while (!$stream->test(Token::BLOCK_END_TYPE)) {
//The files to process
if ($stream->test(Token::STRING_TYPE)) {
- //'somewhere/somefile.(css,img,js)' 'somewhere/*' '@jquery'
+ //'somewhere/somefile.(css|img|js)' 'somewhere/*' '@jquery'
$inputs[] = $stream->next()->getValue();
//The filters token
} elseif ($stream->test(Token::NAME_TYPE, 'filters')) {
//filter='yui_js'
$stream->next();
$stream->expect(Token::OPERATOR_TYPE, '=');
- $filters = array_merge($filters, array_filter(array_map('trim', explode(',', $stream->expect(Token::STRING_TYPE)->getValue()))));
+ $this->filters = array_merge($this->filters, array_filter(array_map('trim', explode(',', $stream->expect(Token::STRING_TYPE)->getValue()))));
+ //The route token
+ } elseif ($stream->test(Token::NAME_TYPE, 'route')) {
+ //output='rapsyspack_css' OR output='rapsyspack_js' OR output='rapsyspack_img'
+ $stream->next();
+ $stream->expect(Token::OPERATOR_TYPE, '=');
+ $this->route = $stream->expect(Token::STRING_TYPE)->getValue();
//The output token
} elseif ($stream->test(Token::NAME_TYPE, 'output')) {
//output='js/packed/*.js' OR output='js/core.js'
$stream->next();
$stream->expect(Token::OPERATOR_TYPE, '=');
- $output = $stream->expect(Token::STRING_TYPE)->getValue();
- //The name token
- } elseif ($stream->test(Token::NAME_TYPE, 'name')) {
+ $this->output = $stream->expect(Token::STRING_TYPE)->getValue();
+ //TODO: add format ? jpeg|png|gif|webp|webm ???
+ //The token name
+ } elseif ($stream->test(Token::NAME_TYPE, 'token')) {
//name='core_js'
$stream->next();
$stream->expect(Token::OPERATOR_TYPE, '=');
- $name = $stream->expect(Token::STRING_TYPE)->getValue();
+ $this->token = $stream->expect(Token::STRING_TYPE)->getValue();
//Unexpected token
} else {
$token = $stream->getCurrent();
+ //Throw error
throw new Error(sprintf('Unexpected token "%s" of value "%s"', Token::typeToEnglish($token->getType()), $token->getValue()), $token->getLine(), $stream->getSourceContext());
}
}
//Process end block
$stream->expect(Token::BLOCK_END_TYPE);
- //TODO: debug mode should be inserted here before the output variable is rewritten
+ //Without valid output
+ if (($pos = strpos($this->output, '*')) === false || $pos !== strrpos($this->output, '*')) {
+ //Throw error
+ throw new Error(sprintf('Invalid output "%s"', $this->output), $token->getLine(), $stream->getSourceContext());
+ }
- //Replace star with sha1
- if (($pos = strpos($output, '*')) !== false) {
- //XXX: assetic use substr(sha1(serialize($inputs).serialize($filters).serialize($options)), 0, 7)
- $output = substr($output, 0, $pos).sha1(serialize($inputs).serialize($filters)).substr($output, $pos + 1);
+ //Without existing route
+ if ($this->router->getRouteCollection()->get($this->route) === null) {
+ //Throw error
+ throw new Error(sprintf('Invalid route "%s"', $this->route), $token->getLine(), $stream->getSourceContext());
}
+ //Set file
+ //XXX: assetic use substr(sha1(serialize($inputs).serialize($this->filters).serialize($this->output)), 0, 7)
+ $file = $this->slugger->hash([$inputs, $this->filters, $this->output, $this->route, $this->token]);
+
+ //Replace star by file
+ $this->output = substr($this->output, 0, $pos).$file.substr($this->output, $pos + 1);
+
//Process inputs
for($k = 0; $k < count($inputs); $k++) {
//Deal with generic url
if (strpos($inputs[$k], '//') === 0) {
//Fix url
- $inputs[$k] = $this->scheme.substr($inputs[$k], 2);
+ $inputs[$k] = ($_ENV['RAPSYSPACK_SCHEME'] ?? 'https').'://'.substr($inputs[$k], 2);
//Deal with non url path
} elseif (strpos($inputs[$k], '://') === false) {
//Check if we have a bundle path
if (strpos($inputs[$k], '*') !== false || (($a = strpos($inputs[$k], '{')) !== false && ($b = strpos($inputs[$k], ',', $a)) !== false && strpos($inputs[$k], '}', $b) !== false)) {
//Get replacement
$replacement = glob($inputs[$k], GLOB_NOSORT|GLOB_BRACE);
+
//Check that these are working files
foreach($replacement as $input) {
//Check that it's a file
if (!is_file($input)) {
+ //Throw error
throw new Error(sprintf('Input path "%s" from "%s" is not a file', $input, $inputs[$k]), $token->getLine(), $stream->getSourceContext());
}
}
+
//Replace with glob path
array_splice($inputs, $k, 1, $replacement);
+
//Fix current key
$k += count($replacement) - 1;
//Check that it's a file
} elseif (!is_file($inputs[$k])) {
+ //Throw error
throw new Error(sprintf('Input path "%s" is not a file', $inputs[$k]), $token->getLine(), $stream->getSourceContext());
}
}
}
- //Init context
- $ctx = stream_context_create(
- [
- 'http' => [
- 'timeout' => $this->timeout,
- 'user_agent' => $this->agent,
- 'redirect' => $this->redirect,
- ]
- ]
- );
+ #TODO: move the inputs reading from here to inside the filters ?
//Check inputs
if (!empty($inputs)) {
//Retrieve files content
foreach($inputs as $input) {
//Try to retrieve content
- if (($data = file_get_contents($input, false, $ctx)) === false) {
+ if (($data = file_get_contents($input, false, $this->ctx)) === false) {
+ //Throw error
throw new Error(sprintf('Unable to retrieve input path "%s"', $input), $token->getLine(), $stream->getSourceContext());
}
+
//Append content
$content .= $data;
}
}
//Check filters
- if (!empty($filters)) {
+ if (!empty($this->filters)) {
//Apply all filters
- foreach($filters as $filter) {
+ foreach($this->filters as $filter) {
//Init args
$args = [$stream->getSourceContext(), $token->getLine()];
+
//Check if args is available
if (!empty($filter['args'])) {
//Append args if provided
$args += $filter['args'];
}
+
//Init reflection
$reflection = new \ReflectionClass($filter['class']);
+
//Set instance args
$tool = $reflection->newInstanceArgs($args);
+
//Process content
$content = $tool->process($content);
+
//Remove object
unset($tool, $reflection);
}
#throw new Error('Empty filters token', $token->getLine(), $stream->getSourceContext());
}
- //Retrieve asset uri
- //XXX: this path is the merge of services.assets.path_package.arguments[0] and rapsys_pack.output.(css,img,js)
- if (($outputUrl = $this->package->getUrl($output)) === false) {
- throw new Error(sprintf('Unable to get url for asset: %s', $output), $token->getLine(), $stream->getSourceContext());
- }
-
//Check if we have a bundle path
- if ($output[0] == '@') {
+ if ($this->output[0] == '@') {
//Resolve it
- $output = $this->getLocated($output, $token->getLine(), $stream->getSourceContext());
+ $this->output = $this->getLocated($this->output, $token->getLine(), $stream->getSourceContext());
}
//Get filesystem
$filesystem = new Filesystem();
//Create output dir if not present
- if (!is_dir($dir = dirname($output))) {
+ if (!is_dir($dir = dirname($this->output))) {
try {
//Create dir
//XXX: set as 0775, symfony umask (0022) will reduce rights (0755)
- $filesystem->mkdir($dir, 0775);
+ $filesystem->mkdir($dir, 0775);
} catch (IOExceptionInterface $e) {
//Throw error
throw new Error(sprintf('Output directory "%s" do not exists and unable to create it', $dir), $token->getLine(), $stream->getSourceContext(), $e);
//Write content to file
//XXX: this call is (maybe) atomic
//XXX: see https://symfony.com/doc/current/components/filesystem.html#dumpfile
- $filesystem->dumpFile($output, $content);
+ $filesystem->dumpFile($this->output, $content);
} catch (IOExceptionInterface $e) {
//Throw error
- throw new Error(sprintf('Unable to write to: %s', $output), $token->getLine(), $stream->getSourceContext(), $e);
+ throw new Error(sprintf('Unable to write "%s"', $this->output), $token->getLine(), $stream->getSourceContext(), $e);
+ }
+
+ //Without output file mtime
+ if (($mtime = filemtime($this->output)) === false) {
+ //Throw error
+ throw new Error(sprintf('Unable to get "%s" mtime', $this->output), $token->getLine(), $stream->getSourceContext(), $e);
+ }
+
+ //TODO: get mimetype for images ? and set _format ?
+
+ try {
+ //Generate asset url
+ $asset = $this->router->generate($this->route, [ 'file' => $file, 'u' => $mtime ]);
+ //Catch router exceptions
+ } catch (RouteNotFoundException|MissingMandatoryParametersException|InvalidParameterException $e) {
+ //Throw error
+ throw new Error(sprintf('Unable to generate asset route "%s"', $this->route), $token->getLine(), $stream->getSourceContext(), $e);
}
//Set name in context key
- $ref = new AssignNameExpression($name, $token->getLine());
+ $ref = new AssignNameExpression($this->token, $token->getLine());
//Set output in context value
- $value = new TextNode($outputUrl, $token->getLine());
+ $value = new TextNode($asset, $token->getLine());
//Send body with context set
return new Node([
/**
* Test for tag end
*
- * @param Token token The \Twig\Token instance
- *
- * @return bool
+ * @param Token $token The \Twig\Token instance
+ * @return bool The token end test result
*/
- public function testEndTag(Token $token) {
+ public function testEndTag(Token $token): bool {
return $token->test(['end'.$this->getTag()]);
}
/**
* Get path from bundled file
*
- * @param string file The bundled file path
- * @param int lineno The template line where the error occurred
- * @param Source source The source context where the error occurred
- * @param \Exception prev The previous exception
+ * @see https://symfony.com/doc/current/bundles.html#overridding-the-bundle-directory-structure
*
+ * @param string $file The bundled file path
+ * @param int $lineno The template line where the error occurred
+ * @param Source $source The source context where the error occurred
+ * @param Exception $prev The previous exception
* @return string The resolved file path
- *
- * @todo Try retrive public dir from the member function BundleNameBundle::getPublicDir() return value ?
- * @xxx see https://symfony.com/doc/current/bundles.html#overridding-the-bundle-directory-structure
*/
- public function getLocated($file, int $lineno = 0, Source $source = null, \Exception $prev = null) {
+ public function getLocated(string $file, int $lineno = 0, ?Source $source = null, ?\Exception $prev = null): string {
/*TODO: add a @jquery magic feature ?
if ($file == '@jquery') {
#header('Content-Type: text/plain');
return $this->config['jquery'];
}*/
- //Check that we have a / separator between bundle name and path
- if (($pos = strpos($file, '/')) === false) {
- throw new Error(sprintf('Invalid path "%s"', $file), $token->getLine(), $stream->getSourceContext());
+ //Extract bundle
+ if (($bundle = strstr($file, '/', true)) === false) {
+ throw new Error(sprintf('Invalid bundle "%s"', $file), $lineno, $source);
}
- //Set bundle
- $bundle = substr($file, 0, $pos);
-
- //Set path
- $path = substr($file, $pos + 1);
-
- //Check for bundle suffix presence
- //XXX: use "bundle templates automatic namespace" mimicked behaviour to find intended bundle and/or path
- //XXX: see https://symfony.com/doc/4.3/templates.html#bundle-templates
- if (strlen($bundle) < strlen('Bundle') || substr($bundle, -strlen('Bundle')) !== 'Bundle') {
- //Append Bundle in an attempt to fix it's naming for locator
- $bundle .= 'Bundle';
-
- //Check for public resource prefix presence
- if (strlen($path) < strlen('Resources/public') || substr($path, 0, strlen('Resources/public')) != 'Resources/public') {
- //Prepend standard public path
- $path = 'Resources/public/'.$path;
- }
+ //Extract path
+ if (($path = strstr($file, '/')) === false) {
+ throw new Error(sprintf('Invalid path "%s"', $file), $lineno, $source);
}
- //Resolve bundle prefix
- try {
- $prefix = $this->locator->locate($bundle);
- //Catch bundle does not exist or is not enabled exception
- } catch(\InvalidArgumentException $e) {
- //Fix lowercase first bundle character
- if ($bundle[1] > 'Z' || $bundle[1] < 'A') {
- $bundle[1] = strtoupper($bundle[1]);
- }
-
- //Detect double bundle suffix
- if (strlen($bundle) > strlen('_bundleBundle') && substr($bundle, -strlen('_bundleBundle')) == '_bundleBundle') {
- //Strip extra bundle
- $bundle = substr($bundle, 0, -strlen('Bundle'));
- }
+ //Extract alias
+ $alias = strtolower(substr($bundle, 1));
- //Convert snake case in camel case
- if (strpos($bundle, '_') !== false) {
- //Fix every first character following a _
- while(($cur = strpos($bundle, '_')) !== false) {
- $bundle = substr($bundle, 0, $cur).ucfirst(substr($bundle, $cur + 1));
- }
+ //With public parameter
+ if ($this->container->hasParameter($alias.'.public')) {
+ //Set prefix
+ $prefix = $this->container->getParameter($alias.'.public');
+ //Without public parameter
+ } else {
+ //Without bundle suffix presence
+ //XXX: use "bundle templates automatic namespace" mimicked behaviour to find intended bundle and/or path
+ //XXX: see https://symfony.com/doc/4.3/templates.html#bundle-templates
+ if (strlen($bundle) < strlen('@Bundle') || substr($bundle, -strlen('Bundle')) !== 'Bundle') {
+ //Append Bundle
+ $bundle .= 'Bundle';
}
- //Resolve fixed bundle prefix
+ //Try to resolve bundle prefix
try {
$prefix = $this->locator->locate($bundle);
- //Catch bundle does not exist or is not enabled exception again
+ //Catch bundle does not exist or is not enabled exception
} catch(\InvalidArgumentException $e) {
- //Bail out as bundle or path is invalid and we have no way to know what was meant
- throw new Error(sprintf('Invalid bundle name "%s" in path "%s". Maybe you meant "%s"', substr($file, 1, $pos - 1), $file, $bundle.'/'.$path), $token->getLine(), $stream->getSourceContext(), $e);
+ throw new Error(sprintf('Unlocatable bundle "%s"', $bundle), $lineno, $source, $e);
+ }
+
+ //With Resources/public subdirectory
+ if (is_dir($prefix.'Resources/public')) {
+ $prefix .= 'Resources/public';
+ //With public subdirectory
+ } elseif (is_dir($prefix.'public')) {
+ $prefix .= 'public';
+ //Without any public subdirectory
+ } else {
+ throw new Error(sprintf('Bundle "%s" lacks a public subdirectory', $bundle), $lineno, $source, $e);
}
}
Rapsys Git / packbundle / blobdiff