Work in progress on Twig

Author: moufmouf

composer.json

@@ -18,7 +18,8 @@
     	"mouf/utils.value.value-interface": "~1.0",
     	"mouf/utils.common.paginable-interface": "~1.0",
     	"mouf/utils.common.sortable-interface": "~1.0",
-        "mouf/schema-analyzer": "~1.0"
+        "mouf/schema-analyzer": "~1.0",
+        "twig/twig": "~1.14"
     },
     "require-dev": {
         "phpunit/phpunit": "~4.0",

src/Mouf/Database/MagicQuery.php

@@ -3,6 +3,7 @@
 namespace Mouf\Database;
 
 use Doctrine\Common\Cache\VoidCache;
+use Mouf\Database\MagicQuery\Twig\SqlTwigEnvironmentFactory;
 use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
 use SQLParser\Node\ColRef;
 use SQLParser\Node\Equal;
@@ -26,6 +27,7 @@ class MagicQuery
     private $connection;
     private $cache;
     private $schemaAnalyzer;
+    private $twigEnvironment;
 
     /**
      * @param \Doctrine\DBAL\Connection $connection
@@ -43,6 +45,9 @@ public function __construct($connection = null, $cache = null, SchemaAnalyzer $s
         if ($schemaAnalyzer) {
             $this->schemaAnalyzer = $schemaAnalyzer;
         }
+        if ($this->connection) {
+            $this->twigEnvironment = SqlTwigEnvironmentFactory::getTwigEnvironment($this->connection);
+        }
     }
 
     /**

src/Mouf/Database/MagicQuery/Twig/SqlTwigEnvironmentFactory.php

@@ -0,0 +1,73 @@
+<?php
+namespace Mouf\Database\MagicQuery\Twig;
+
+use Doctrine\DBAL\Connection;
+
+/**
+ * Class in charge of creating the Twig environment
+ */
+class SqlTwigEnvironmentFactory
+{
+    public static function getTwigEnvironment(Connection $connection = null) {
+        $stringLoader = new StringLoader();
+
+        $options = array(
+            // The cache directory is in the temporary directory and reproduces the path to the directory (to avoid cache conflict between apps).
+            'cache' => self::getCacheDirectory(),
+            'strict_variables' => true
+        );
+
+        $twig = new \Twig_Environment($stringLoader, $options);
+
+        if ($connection !== null) {
+
+            $twig->getExtension('core')->setEscaper('sql', function(\Twig_Environment $env, $string, $charset) use ($connection) {
+                var_dump($string);
+                // ARGH! Escapers seems to be not called if $string is empty!
+                if ($string === null) {
+                    return "null";
+                } else {
+                    return $connection->quote($string);
+                }
+            });
+
+            // SQL identifier (table or column names....)
+            $twig->getExtension('core')->setEscaper('sqli', function(\Twig_Environment $env, $string, $charset) use ($connection) {
+                return $connection->quoteIdentifier($string);
+            });
+
+        } else {
+            $twig->getExtension('core')->setEscaper('sql', function(\Twig_Environment $env, $string, $charset) use ($connection) {
+                if ($string === null) {
+                    return "null";
+                } else {
+                    return "'".addslashes($string)."'";
+                }
+            });
+
+            $twig->getExtension('core')->setEscaper('sqli', function(\Twig_Environment $env, $string, $charset) use ($connection) {
+                // Note: we don't know how to escape backticks in a column name. In order to avoid injection,
+                // we remove any backticks.
+                return "`".str_replace('`', '', $string)."`";
+            });
+        }
+
+        // Default autoescape mode: sql
+        $twig->addExtension(new \Twig_Extension_Escaper('sql'));
+
+        return $twig;
+    }
+
+    private static function getCacheDirectory() {
+        // If we are running on a Unix environment, let's prepend the cache with the user id of the PHP process.
+        // This way, we can avoid rights conflicts.
+        if (function_exists('posix_geteuid')) {
+            $posixGetuid = '_'.posix_geteuid();
+        } else {
+            $posixGetuid = '';
+        }
+        $cacheDirectory = rtrim(sys_get_temp_dir(), '/\\').'/magicquerysqltwigtemplate'.$posixGetuid.str_replace(":", "", __DIR__);
+
+        return $cacheDirectory;
+    }
+}

src/Mouf/Database/MagicQuery/Twig/StringLoader.php

@@ -0,0 +1,36 @@
+<?php
+namespace Mouf\Database\MagicQuery\Twig;
+
+
+/**
+ * This loader completely bypasses the loader mechanism, by directly passing the key as a template.
+ * Useful in our very case.
+ *
+ * This is a reimplementation of Twig's String loader that has been deprecated.
+ * We enable it back in our case because there won't be a million of different cache keys.
+ * And yes, we know what we are doing :)
+ */
+class StringLoader implements \Twig_LoaderInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getSource($name)
+    {
+        return $name;
+    }
+    /**
+     * {@inheritdoc}
+     */
+    public function getCacheKey($name)
+    {
+        return $name;
+    }
+    /**
+     * {@inheritdoc}
+     */
+    public function isFresh($name, $time)
+    {
+        return true;
+    }
+}

tests/Mouf/Database/MagicQuery/Twig/SqlTwigEnvironmentFactoryTest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Mouf\Database;
+
+use Doctrine\Common\Cache\ArrayCache;
+use Doctrine\DBAL\Schema\Schema;
+use Mouf\Database\MagicQuery\Twig\SqlTwigEnvironmentFactory;
+use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
+
+class SqlTwigEnvironmentFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    public function testWithConnection()
+    {
+        $config = new \Doctrine\DBAL\Configuration();
+        // TODO: put this in conf variable
+        $connectionParams = array(
+            'url' => 'mysql://root:@localhost/',
+        );
+        $conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams, $config);
+
+        $twigEnvironment = SqlTwigEnvironmentFactory::getTwigEnvironment($conn);
+        $this->doTestTwig($twigEnvironment);
+    }
+
+    /**
+     * We need to run this test in a separate process because Twig seems to be enable to register several escapers
+     * with the same name.
+     *
+     * @runInSeparateProcess
+     */
+    /*public function testWithoutConnection()
+    {
+        $twigEnvironment = SqlTwigEnvironmentFactory::getTwigEnvironment();
+        $this->doTestTwig($twigEnvironment);
+    }*/
+
+
+    private function doTestTwig(\Twig_Environment $twig) {
+        $result = $twig->render("SELECT * FROM toto WHERE id = {{ id }}", ["id"=>null]);
+        $this->assertEquals("SELECT * FROM toto WHERE id = null", $result);
+
+        $result = $twig->render("SELECT * FROM toto WHERE id = {{ id }}", [ "id" => "myid" ]);
+        $this->assertEquals("SELECT * FROM toto WHERE id = 'myid'", $result);
+
+    }
+}

tests/Mouf/Database/MagicQueryTest.php

@@ -41,6 +41,7 @@ public function testStandardSelect()
 
     public function testWithCache() {
         $config = new \Doctrine\DBAL\Configuration();
+        // TODO: put this in conf variable
         $connectionParams = array(
             'url' => 'mysql://root:@localhost/',
         );