Skip to content

EZP-30759: Creating content with terminal escape codes chars inside Searchable field will return 500 error when using Solr #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 1.5
Choose a base branch
from
Open

EZP-30759: Creating content with terminal escape codes chars inside Searchable field will return 500 error when using Solr #159

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d625bd5
EZP-30759: Creating content with terminal escape codes chars inside S…
kmadejski Oct 25, 2019
1437bbc
Moved parameter to the right file
kmadejski Oct 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions bundle/Resources/config/services.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ parameters:
ezpublish.solr.engine_factory.class: EzSystems\EzPlatformSolrSearchEngineBundle\ApiLoader\SolrEngineFactory
ezpublish.solr.boost_factor_provider_factory.class: EzSystems\EzPlatformSolrSearchEngineBundle\ApiLoader\BoostFactorProviderFactory
ez_search_engine_solr.default_connection: ~
ez_search_engine_solr.invalid_characters_pattern: "#\\x1b[[][^A-Za-z]*[A-Za-z]#"

services:
ezpublish.solr.engine_factory:
Expand Down
12 changes: 10 additions & 2 deletions lib/FieldMapper/ContentFieldMapper/BlockDocumentsBaseContentFields.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,30 @@ class BlockDocumentsBaseContentFields extends ContentFieldMapper
*/
protected $sectionHandler;

/**
* @var string
Copy link
Contributor

@andrerom andrerom Oct 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe something like this (here and on the others):

Suggested change
* @var string
* @var string Pattern with special characters that should be stripped from field value due to Solr not accepting them.

Copy link

@gggeek gggeek Nov 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'regexp pattern' ?

*/
private $invalidCharactersPattern;

/**
* @param \eZ\Publish\SPI\Persistence\Content\Location\Handler $locationHandler
* @param \eZ\Publish\SPI\Persistence\Content\Type\Handler $contentTypeHandler
* @param \eZ\Publish\SPI\Persistence\Content\ObjectState\Handler $objectStateHandler
* @param \eZ\Publish\SPI\Persistence\Content\Section\Handler $sectionHandler
* @param string $invalidCharactersPattern
*/
public function __construct(
LocationHandler $locationHandler,
ContentTypeHandler $contentTypeHandler,
ObjectStateHandler $objectStateHandler,
SectionHandler $sectionHandler
SectionHandler $sectionHandler,
$invalidCharactersPattern
) {
$this->locationHandler = $locationHandler;
$this->contentTypeHandler = $contentTypeHandler;
$this->objectStateHandler = $objectStateHandler;
$this->sectionHandler = $sectionHandler;
$this->invalidCharactersPattern = $invalidCharactersPattern;
}

public function accept(Content $content)
Expand Down Expand Up @@ -104,7 +112,7 @@ public function mapFields(Content $content)
),
new Field(
'content_name',
$contentInfo->name,
preg_replace($this->invalidCharactersPattern, '', $contentInfo->name),
new FieldType\StringField()
),
new Field(
Expand Down
12 changes: 10 additions & 2 deletions lib/FieldMapper/ContentTranslationFieldMapper/BlockDocumentsContentFields.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,22 +44,30 @@ class BlockDocumentsContentFields extends ContentTranslationFieldMapper
*/
protected $boostFactorProvider;

/**
* @var string
*/
private $invalidCharactersPattern;

/**
* @param \eZ\Publish\SPI\Persistence\Content\Type\Handler $contentTypeHandler
* @param \eZ\Publish\Core\Search\Common\FieldRegistry $fieldRegistry
* @param \eZ\Publish\Core\Search\Common\FieldNameGenerator $fieldNameGenerator
* @param \EzSystems\EzPlatformSolrSearchEngine\FieldMapper\BoostFactorProvider $boostFactorProvider
* @param string $invalidCharactersPattern
*/
public function __construct(
ContentTypeHandler $contentTypeHandler,
FieldRegistry $fieldRegistry,
FieldNameGenerator $fieldNameGenerator,
BoostFactorProvider $boostFactorProvider
BoostFactorProvider $boostFactorProvider,
$invalidCharactersPattern
) {
$this->contentTypeHandler = $contentTypeHandler;
$this->fieldRegistry = $fieldRegistry;
$this->fieldNameGenerator = $fieldNameGenerator;
$this->boostFactorProvider = $boostFactorProvider;
$this->invalidCharactersPattern = $invalidCharactersPattern;
}

public function accept(Content $content, $languageCode)
Expand Down Expand Up @@ -102,7 +110,7 @@ public function mapFields(Content $content, $languageCode)
$fieldDefinition->identifier,
$contentType->identifier
),
$indexField->value,
preg_replace($this->invalidCharactersPattern, '', $indexField->value),
$this->getIndexFieldType($contentType, $fieldDefinition, $indexField->type)
);
}
Expand Down
12 changes: 10 additions & 2 deletions lib/FieldMapper/ContentTranslationFieldMapper/ContentDocumentFulltextFields.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,22 +50,30 @@ class ContentDocumentFulltextFields extends ContentTranslationFieldMapper
*/
protected $boostFactorProvider;

/**
* @var string
*/
private $invalidCharactersPattern;

/**
* @param \eZ\Publish\SPI\Persistence\Content\Type\Handler $contentTypeHandler
* @param \eZ\Publish\Core\Search\Common\FieldRegistry $fieldRegistry
* @param \eZ\Publish\Core\Search\Common\FieldNameGenerator $fieldNameGenerator
* @param \EzSystems\EzPlatformSolrSearchEngine\FieldMapper\BoostFactorProvider $boostFactorProvider
* @param $invalidCharactersPattern
*/
public function __construct(
ContentTypeHandler $contentTypeHandler,
FieldRegistry $fieldRegistry,
FieldNameGenerator $fieldNameGenerator,
BoostFactorProvider $boostFactorProvider
BoostFactorProvider $boostFactorProvider,
$invalidCharactersPattern
) {
$this->contentTypeHandler = $contentTypeHandler;
$this->fieldRegistry = $fieldRegistry;
$this->fieldNameGenerator = $fieldNameGenerator;
$this->boostFactorProvider = $boostFactorProvider;
$this->invalidCharactersPattern = $invalidCharactersPattern;
}

public function accept(Content $content, $languageCode)
Expand Down Expand Up @@ -104,7 +112,7 @@ public function mapFields(Content $content, $languageCode)

$fields[] = new Field(
self::$fieldName,
$indexField->value,
preg_replace($this->invalidCharactersPattern, '', $indexField->value),
$this->getIndexFieldType($contentType)
);
}
Expand Down
12 changes: 10 additions & 2 deletions lib/FieldMapper/ContentTranslationFieldMapper/ContentDocumentTranslatedContentNameField.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,24 @@ class ContentDocumentTranslatedContentNameField extends ContentTranslationFieldM
*/
protected $boostFactorProvider;

/**
* @var string
*/
private $invalidCharactersPattern;

/**
* @param \eZ\Publish\SPI\Persistence\Content\Type\Handler $contentTypeHandler
* @param \EzSystems\EzPlatformSolrSearchEngine\FieldMapper\BoostFactorProvider $boostFactorProvider
* @param $invalidCharactersPattern
*/
public function __construct(
ContentTypeHandler $contentTypeHandler,
BoostFactorProvider $boostFactorProvider
BoostFactorProvider $boostFactorProvider,
$invalidCharactersPattern
) {
$this->contentTypeHandler = $contentTypeHandler;
$this->boostFactorProvider = $boostFactorProvider;
$this->invalidCharactersPattern = $invalidCharactersPattern;
}

public function accept(Content $content, $languageCode)
Expand All @@ -60,7 +68,7 @@ public function mapFields(Content $content, $languageCode)
return [];
}

$contentName = $content->versionInfo->names[$languageCode];
$contentName = preg_replace($this->invalidCharactersPattern, '', $content->versionInfo->names[$languageCode]);
$contentType = $this->contentTypeHandler->load(
$content->versionInfo->contentInfo->contentTypeId
);
Expand Down
4 changes: 4 additions & 0 deletions lib/Resources/config/container/solr/field_mappers.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ services:
- '@ezpublish.spi.persistence.content_type_handler'
- '@ezpublish.spi.persistence.object_state_handler'
- '@ezpublish.spi.persistence.section_handler'
- '%ez_search_engine_solr.invalid_characters_pattern%'
tags:
- {name: ezpublish.search.solr.field_mapper.block}

Expand All @@ -26,6 +27,7 @@ services:
- '@ezpublish.search.common.field_registry'
- '@ezpublish.search.common.field_name_generator'
- '@ezpublish.search.solr.field_mapper.boost_factor_provider'
- '%ez_search_engine_solr.invalid_characters_pattern%'
tags:
- {name: ezpublish.search.solr.field_mapper.block_translation}

Expand Down Expand Up @@ -53,6 +55,7 @@ services:
- '@ezpublish.search.common.field_registry'
- '@ezpublish.search.common.field_name_generator'
- '@ezpublish.search.solr.field_mapper.boost_factor_provider'
- '%ez_search_engine_solr.invalid_characters_pattern%'
tags:
- {name: ezpublish.search.solr.field_mapper.content_translation}

Expand All @@ -61,6 +64,7 @@ services:
arguments:
- '@ezpublish.spi.persistence.content_type_handler'
- '@ezpublish.search.solr.field_mapper.boost_factor_provider'
- '%ez_search_engine_solr.invalid_characters_pattern%'
tags:
- {name: ezpublish.search.solr.field_mapper.content_translation}

Expand Down