Merge pull request #1432 from jygaulier/PHRAS-504_CRLF-in-proposals

PHRAS-504

lib/Alchemy/Phrasea/Controller/Prod/QueryController.php

@@ -15,6 +15,7 @@ use Alchemy\Phrasea\Controller\Controller;
 use Alchemy\Phrasea\Core\Configuration\DisplaySettingService;
 use Alchemy\Phrasea\SearchEngine\SearchEngineOptions;
 use Alchemy\Phrasea\SearchEngine\SearchEngineResult;
+use Alchemy\Phrasea\Utilities\StringHelper;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
@@ -32,6 +33,9 @@ class QueryController extends Controller
     {
         $query = (string) $request->request->get('qry');
 
+        // since the query comes from a submited form, normalize crlf,cr,lf ...
+        $query = StringHelper::crlfNormalize($query);
+
         $json = [];
 
         $options = SearchEngineOptions::fromRequest($this->app, $request);

lib/Alchemy/Phrasea/Form/Login/PhraseaRegisterForm.php

@@ -13,7 +13,7 @@ namespace Alchemy\Phrasea\Form\Login;
 
 use Alchemy\Phrasea\Application;
 use Alchemy\Phrasea\Form\Constraint\NewEmail;
-use Alchemy\Phrasea\Utilities\String\Camelizer;
+use Alchemy\Phrasea\Utilities\StringHelper;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -23,14 +23,12 @@ class PhraseaRegisterForm extends AbstractType
 {
     private $available;
     private $params;
-    private $camelizer;
 
-    public function __construct(Application $app, array $available, array $params = [], Camelizer $camelizer = null)
+    public function __construct(Application $app, array $available, array $params = [])
     {
         $this->app = $app;
         $this->available = $available;
         $this->params = $params;
-        $this->camelizer = $camelizer ?: new Camelizer();
     }
 
     public function buildForm(FormBuilderInterface $builder, array $options)
@@ -115,7 +113,7 @@ class PhraseaRegisterForm extends AbstractType
 
                 $builder->add(
                     // angular does not support hyphens
-                    $this->camelizer->camelize($name, '-'),
+                    StringHelper::camelize($name, '-'),
                     $this->getType($name),
                     $options
                 );

lib/Alchemy/Phrasea/SearchEngine/Elastic/Indexer/Record/Hydrator/MetadataHydrator.php

@@ -15,6 +15,7 @@ use Alchemy\Phrasea\SearchEngine\Elastic\Exception\Exception;
 use Alchemy\Phrasea\SearchEngine\Elastic\Mapping;
 use Alchemy\Phrasea\SearchEngine\Elastic\RecordHelper;
 use Alchemy\Phrasea\SearchEngine\Elastic\Structure\Structure;
+use Alchemy\Phrasea\Utilities\StringHelper;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Driver\Connection as DriverConnection;
 use DomainException;
@@ -74,6 +75,7 @@ SQL;
             switch ($metadata['type']) {
                 case 'caption':
                     // Sanitize fields
+                    $value = StringHelper::crlfNormalize($value);
                     switch ($this->structure->typeOf($key)) {
                         case Mapping::TYPE_DATE:
                             $value = $this->helper->sanitizeDate($value);

lib/Alchemy/Phrasea/Twig/Camelize.php

@@ -11,20 +11,10 @@
 
 namespace Alchemy\Phrasea\Twig;
 
-use Alchemy\Phrasea\Utilities\String\Camelizer;
+use Alchemy\Phrasea\Utilities\StringHelper;
 
 class Camelize extends \Twig_Extension
 {
-    /**
-     * @var Camelizer
-     */
-    private $camelizer;
-
-    public function __construct(Camelizer $camelizer = null)
-    {
-        $this->camelizer = $camelizer ?: new Camelizer();
-    }
-
     /**
      *
      * @return string
@@ -47,6 +37,6 @@ class Camelize extends \Twig_Extension
 
     public function toCamelCase($str, $separator = '-', $pascalCase = false)
     {
-        return $this->camelizer->camelize($str, $separator, $pascalCase);
+        return StringHelper::camelize($str, $separator, $pascalCase);
     }
 }

lib/Alchemy/Phrasea/Utilities/String/Camelizer.php

@@ -1,22 +0,0 @@
-<?php
-
-/*
- * This file is part of Phraseanet
- *
- * (c) 2005-2015 Alchemy
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Alchemy\Phrasea\Utilities\String;
-
-class Camelizer
-{
-    public function camelize($str, $separator = '_', $pascalCase = false)
-    {
-        $transformStr = str_replace(' ', '', ucwords(str_replace($separator, ' ', $str)));
-
-        return $pascalCase ? $transformStr : lcfirst($transformStr);
-    }
-}

lib/Alchemy/Phrasea/Utilities/StringHelper.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of Phraseanet
+ *
+ * (c) 2005-2015 Alchemy
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Alchemy\Phrasea\Utilities;
+
+class StringHelper
+{
+    /**
+     * @param string $str
+     * @return string
+     */
+    public static function crlfNormalize($str)
+    {
+        return str_replace(["\r\n", "\r"], "\n", $str);
+    }
+
+    /**
+     * @param string $str
+     * @param string $separator
+     * @param bool $pascalCase
+     * @return string
+     */
+    public static function camelize($str, $separator = '_', $pascalCase = false)
+    {
+        $transformStr = str_replace(' ', '', ucwords(str_replace($separator, ' ', $str)));
+
+        return $pascalCase ? $transformStr : lcfirst($transformStr);
+    }
+
+}

lib/classes/caption/Field/Value.php

@@ -10,6 +10,7 @@
  */
 
 use Alchemy\Phrasea\Application;
+use Alchemy\Phrasea\Utilities\StringHelper;
 use Alchemy\Phrasea\Vocabulary;
 
 class caption_Field_Value implements cache_cacheableInterface
@@ -87,15 +88,14 @@ class caption_Field_Value implements cache_cacheableInterface
 
         $connbas = $this->databox_field->get_databox()->get_connection();
 
-        $sql = 'SELECT record_id, value, VocabularyType, VocabularyId
-            FROM metadatas WHERE id = :id';
+        $sql = 'SELECT record_id, value, VocabularyType, VocabularyId FROM metadatas WHERE id = :id';
 
         $stmt = $connbas->prepare($sql);
         $stmt->execute([':id' => $this->id]);
         $row = $stmt->fetch(PDO::FETCH_ASSOC);
         $stmt->closeCursor();
 
-        $this->value = $row ? $row['value'] : null;
+        $this->value = $row ? StringHelper::crlfNormalize($row['value']) : null;
 
         try {
             $this->VocabularyType = $row['VocabularyType'] ? Vocabulary\Controller::get($this->app, $row['VocabularyType']) : null;
@@ -204,9 +204,9 @@ class caption_Field_Value implements cache_cacheableInterface
             , ':meta_id'      => $this->getId()
         ];
 
-        $sql_up = 'UPDATE metadatas
-              SET VocabularyType = :VocabType, VocabularyId = :VocabularyId
-              WHERE id = :meta_id';
+        $sql_up = 'UPDATE metadatas'
+              . ' SET VocabularyType = :VocabType, VocabularyId = :VocabularyId'
+              . ' WHERE id = :meta_id';
         $stmt_up = $connbas->prepare($sql_up);
         $stmt_up->execute($params);
         $stmt_up->closeCursor();
@@ -228,9 +228,9 @@ class caption_Field_Value implements cache_cacheableInterface
             , ':meta_id'      => $this->getId()
         ];
 
-        $sql_up = 'UPDATE metadatas
-              SET VocabularyType = :VocabType, VocabularyId = :VocabularyId
-              WHERE id = :meta_id';
+        $sql_up = 'UPDATE metadatas'
+              . ' SET VocabularyType = :VocabType, VocabularyId = :VocabularyId'
+              . ' WHERE id = :meta_id';
         $stmt_up = $connbas->prepare($sql_up);
         $stmt_up->execute($params);
         $stmt_up->closeCursor();
@@ -302,10 +302,8 @@ class caption_Field_Value implements cache_cacheableInterface
             }
         }
 
-        $sql_ins = 'INSERT INTO metadatas
-      (id, record_id, meta_struct_id, value, VocabularyType, VocabularyId)
-      VALUES
-      (null, :record_id, :field, :value, :VocabType, :VocabId)';
+        $sql_ins = 'INSERT INTO metadatas (id, record_id, meta_struct_id, value, VocabularyType, VocabularyId)'
+                . ' VALUES (null, :record_id, :field, :value, :VocabType, :VocabId)';
 
         $params = [
             ':record_id' => $record->get_record_id(),

lib/classes/caption/field.php

@@ -20,12 +20,12 @@ class caption_field implements cache_cacheableInterface
     protected $databox_field;
 
     /**
-     * @var string
+     * @var caption_Field_Value[]
      */
     protected $values;
 
     /**
-     * @var record_adapter
+     * @var \record_adapter
      */
     protected $record;
     protected $app;
@@ -37,7 +37,7 @@ class caption_field implements cache_cacheableInterface
      * @param databox_field    $databox_field
      * @param record_adapter $record
      *
-     * @return $this
+     * @return caption_field
      */
     public function __construct(Application $app, databox_field $databox_field, \record_adapter $record)
     {
@@ -56,6 +56,8 @@ class caption_field implements cache_cacheableInterface
                 break;
             }
         }
+
+        return $this;
     }
 
     protected function get_metadatas_ids()
@@ -71,8 +73,8 @@ class caption_field implements cache_cacheableInterface
         $sql = 'SELECT id FROM metadatas WHERE record_id = :record_id AND meta_struct_id = :meta_struct_id';
 
         $params = [
-            ':record_id'      => $this->record->get_record_id(),
-            ':meta_struct_id' => $this->databox_field->get_id(),
+            ':record_id'      => $this->record->get_record_id()
+            , ':meta_struct_id' => $this->databox_field->get_id()
         ];
 
         $stmt = $connbas->prepare($sql);
@@ -118,7 +120,7 @@ class caption_field implements cache_cacheableInterface
     }
 
     /**
-     * @return $this
+     * @return caption_field
      */
     public function delete()
     {
@@ -167,7 +169,7 @@ class caption_field implements cache_cacheableInterface
 
     /**
      * @param  int   $meta_id
-     * @return array
+     * @return \caption_Field_Value
      */
     public function get_value($meta_id)
     {
@@ -175,8 +177,8 @@ class caption_field implements cache_cacheableInterface
     }
 
     /**
-     * @param bool|string $custom_separator
-     * @param bool        $highlight
+     * @param String  $custom_separator
+     * @param Boolean $highlightTheso
      *
      * @return mixed
      */
@@ -389,7 +391,7 @@ class caption_field implements cache_cacheableInterface
      * @param  mixed         $value
      * @param  string        $option
      * @param  int           $duration
-     * @return $this
+     * @return caption_field
      */
     public function set_data_to_cache($value, $option = null, $duration = 360000)
     {
@@ -400,7 +402,7 @@ class caption_field implements cache_cacheableInterface
      * Part of the cache_cacheableInterface
      *
      * @param  string        $option
-     * @return $this
+     * @return caption_field
      */
     public function delete_data_from_cache($option = null)
     {

tests/Alchemy/Tests/Phrasea/Form/Login/PhraseaRegisterFormTest.php

@@ -4,7 +4,6 @@ namespace Alchemy\Tests\Phrasea\Form\Login;
 
 use Alchemy\Phrasea\Form\Login\PhraseaRegisterForm;;
 use Alchemy\Tests\Phrasea\Form\FormTestCase;
-use Alchemy\Phrasea\Utilities\String\Camelizer;
 
 /**
  * @group functional
@@ -27,7 +26,7 @@ class PhraseaRegisterFormTest extends FormTestCase
             ]
         ];
 
-        return new PhraseaRegisterForm(self::$DI['app'], $available, $params, new Camelizer());
+        return new PhraseaRegisterForm(self::$DI['app'], $available, $params);
     }
 
     public function testFormDoesRegisterValidFields()
@@ -63,7 +62,7 @@ class PhraseaRegisterFormTest extends FormTestCase
             $expected[] = 'collections';
         }
 
-        $form = new PhraseaRegisterForm(self::$DI['app'], $available, $params, new Camelizer());
+        $form = new PhraseaRegisterForm(self::$DI['app'], $available, $params);
 
         foreach (array_keys(self::$DI['app']->form($form)->createView()->vars['form']->children) as $name) {
             $this->assertContains($name, $expected);
@@ -99,7 +98,7 @@ class PhraseaRegisterFormTest extends FormTestCase
             $expected[] = 'collections';
         }
 
-        $form = new PhraseaRegisterForm(self::$DI['app'], $available, $params, new Camelizer());
+        $form = new PhraseaRegisterForm(self::$DI['app'], $available, $params);
 
         foreach (array_keys(self::$DI['app']->form($form)->createView()->vars['form']->children) as $name) {
             $this->assertContains($name, $expected);

tests/Alchemy/Tests/Phrasea/Utilities/String/CamelizerTest.php

@@ -1,34 +0,0 @@
-<?php
-
-namespace Alchemy\Tests\Phrasea\Utilities\String;
-
-use Alchemy\Phrasea\Utilities\String\Camelizer;
-
-/**
- * @group functional
- * @group legacy
- */
-class CamelizerTest extends \PhraseanetTestCase
-{
-    /**
-     * @dataProvider provideStrings
-     * @covers Alchemy\Phrasea\Utilities\String\Camelizer::camelize
-     */
-    public function testCamelize($string, $separator, $expected, $pascalize)
-    {
-        $camelizer = new Camelizer();
-        $result = $camelizer->camelize($string, $separator, $pascalize);
-
-        $this->assertEquals($expected, $result);
-    }
-
-    public function provideStrings()
-    {
-        return [
-            ['string-test', '-', 'stringTest', false],
-            ['string test', ' ', 'stringTest', false],
-            ['string_test', '_', 'stringTest', false],
-            ['string#test', '#', 'StringTest', true],
-        ];
-    }
-}

tests/Alchemy/Tests/Phrasea/Utilities/String/StringHelperTest.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Alchemy\Tests\Phrasea\Utilities\String;
+
+use Alchemy\Phrasea\Utilities\StringHelper;
+
+/**
+ * @group unit
+ */
+class StringHelperTest extends \PhraseanetTestCase
+{
+    /**
+     * @dataProvider provideStringsForCamelize
+     * @covers Alchemy\Phrasea\Utilities\StringHelper::camelize
+     */
+    public function testCamelize($string, $separator, $expected, $pascalize)
+    {
+        $result = StringHelper::camelize($string, $separator, $pascalize);
+
+        $this->assertEquals($expected, $result);
+    }
+
+    public function provideStringsForCamelize()
+    {
+        return [
+            ['string-test', '-', 'stringTest', false],
+            ['string test', ' ', 'stringTest', false],
+            ['string_test', '_', 'stringTest', false],
+            ['string#test', '#', 'StringTest', true],
+        ];
+    }
+
+
+
+    /**
+     * @dataProvider provideStringsForCrLfNormalize
+     * @covers Alchemy\Phrasea\Utilities\StringHelper::crlfNormalize
+     */
+    public function testCrLfNormalize($string, $expected)
+    {
+        $result = StringHelper::crlfNormalize($string);
+
+        $this->assertEquals($expected, $result);
+    }
+
+    public function provideStringsForCrLfNormalize()
+    {
+        return [
+            ["ABC\rDEF", "ABC\nDEF"],
+            ["ABC\nDEF", "ABC\nDEF"],
+            ["ABC\r\nDEF", "ABC\nDEF"],
+            ["ABC\n\rDEF", "ABC\n\nDEF"],
+        ];
+    }
+}

www/skins/prod/jquery.main-prod.js

@@ -340,7 +340,7 @@ function newSearch(query) {
     p4.Results.Selection.empty();
 
     clearAnswers();
-    $('#searchForm input[name="qry"]').val(query);
+    $('#SENT_query').val(query);
     var histo = $('#history-queries ul');
 
     histo.prepend('<li onclick="doSpecialSearch(\'' + query.replace(/\'/g, "\\'") + '\')">' + query + '</li>');
@@ -612,9 +612,7 @@ function getFacetsTree() {
 }
 
 function facetCombinedSearch() {
-
     var q = $("#EDIT_query").val();
-    console.debug(selectedFacetValues);
     var q_facet = "";
     _.each(_.values(selectedFacetValues), function(facetValue) {
         q_facet += (q_facet ? " AND " : "") + '(' + facetValue.query + ')';