-
Notifications
You must be signed in to change notification settings - Fork 79
Fix - Massive action update on CustomAssets #1247
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.
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
RomainLvr
wants to merge
2
commits into
main
Choose a base branch
from
fix/massive-action-custom-asset-dropdown-fields
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -1361,6 +1361,14 @@ public static function showSingle($itemtype, $searchOption, $massiveaction = fal | |||||||||
| (string) $searchOption['linkfield'], | ||||||||||
| ); | ||||||||||
|
|
||||||||||
| // itemtype is stored in a JSON array, so entry is surrounded by double quotes | ||||||||||
| $search_string = json_encode($itemtype); | ||||||||||
| // Backslashes must be doubled in LIKE clause according to MySQL documentation | ||||||||||
| // But do not escape backslashes for CustomAsset, as they are alrady escaped | ||||||||||
| if (!str_contains($search_string, 'CustomAsset')) { | ||||||||||
|
Comment on lines
+1367
to
+1368
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| $search_string = str_replace('\\', '\\\\', $search_string); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| //find field | ||||||||||
| $iterator = $DB->request([ | ||||||||||
| 'SELECT' => [ | ||||||||||
|
|
@@ -1381,7 +1389,7 @@ public static function showSingle($itemtype, $searchOption, $massiveaction = fal | |||||||||
| ], | ||||||||||
| 'WHERE' => [ | ||||||||||
| 'fields.name' => $cleaned_linkfield, | ||||||||||
| 'containers.itemtypes' => ['LIKE', sprintf('%%%s%%', $itemtype)], | ||||||||||
| 'containers.itemtypes' => ['LIKE', '%' . $DB->escape($search_string) . '%'], | ||||||||||
| ], | ||||||||||
| ]); | ||||||||||
|
|
||||||||||
|
|
||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,10 @@ | ||||||||||||||||||||||
| <?xml version="1.0"?> | ||||||||||||||||||||||
| <psalm | ||||||||||||||||||||||
| runTaintAnalysis="true" | ||||||||||||||||||||||
| > | ||||||||||||||||||||||
| <projectFiles> | ||||||||||||||||||||||
| <directory name="src"/> | ||||||||||||||||||||||
| <file name="hook.php"/> | ||||||||||||||||||||||
| <file name="setup.php"/> | ||||||||||||||||||||||
|
Comment on lines
+6
to
+8
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we need to create a dedicated PR for PSALM to make it complete:
Suggested change
|
||||||||||||||||||||||
| </projectFiles> | ||||||||||||||||||||||
| </psalm> | ||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * ------------------------------------------------------------------------- | ||
| * Fields plugin for GLPI | ||
| * ------------------------------------------------------------------------- | ||
| * | ||
| * LICENSE | ||
| * | ||
| * This file is part of Fields. | ||
| * | ||
| * Fields is free software; you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation; either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * Fields is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with Fields. If not, see <http://www.gnu.org/licenses/>. | ||
| * ------------------------------------------------------------------------- | ||
| * @copyright Copyright (C) 2013-2023 by Fields plugin team. | ||
| * @license GPLv2 https://www.gnu.org/licenses/gpl-2.0.html | ||
| * @link https://github.com/pluginsGLPI/fields | ||
| * ------------------------------------------------------------------------- | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace GlpiPlugin\Field\Tests\Units; | ||
|
|
||
| use Glpi\Tests\DbTestCase; | ||
| use Glpi\Tests\GLPITestCase; | ||
| use GlpiPlugin\Field\Tests\FieldTestTrait; | ||
| use PluginFieldsContainer; | ||
| use PluginFieldsField; | ||
| use Search; | ||
|
|
||
| require_once __DIR__ . '/../FieldTestCase.php'; | ||
|
|
||
| /** | ||
| * Reproduces the bug where the massive action "update" widget for a Fields | ||
| * plugin field is never rendered for CustomAsset itemtypes (namespaced | ||
| * classes like Glpi\CustomAsset\XxxAsset), because PluginFieldsField::showSingle() | ||
| * builds a LIKE query against the un-escaped itemtype string. | ||
| */ | ||
| final class MassiveActionCustomAssetTest extends DbTestCase | ||
| { | ||
| use FieldTestTrait; | ||
|
|
||
| public function setUp(): void | ||
| { | ||
| GLPITestCase::setUp(); | ||
| $this->login(); | ||
| } | ||
|
|
||
| public function tearDown(): void | ||
| { | ||
| $this->tearDownFieldTest(); | ||
| GLPITestCase::tearDown(); | ||
| } | ||
|
|
||
| public function testShowSingleDisplaysFieldForCustomAsset(): void | ||
| { | ||
| $definition = $this->initAssetDefinition('so' . substr((string) $this->getUniqueString(), 0, 6)); | ||
| $asset_class = $definition->getAssetClassName(); | ||
|
|
||
| $container = $this->createFieldContainer([ | ||
| 'label' => 'F', | ||
| 'type' => 'tab', | ||
| 'itemtypes' => [$asset_class], | ||
| 'is_active' => 1, | ||
| 'entities_id' => 0, | ||
| 'is_recursive' => 1, | ||
| ]); | ||
|
|
||
| $field = $this->createField([ | ||
| 'label' => 'Custom Asset Field', | ||
| 'type' => 'text', | ||
| PluginFieldsContainer::getForeignKeyField() => $container->getID(), | ||
| 'ranking' => 1, | ||
| 'is_active' => 1, | ||
| 'is_readonly' => 0, | ||
| ]); | ||
| $field_name = $field->fields['name']; | ||
|
|
||
| $search_option = null; | ||
| foreach (Search::getOptions($asset_class) as $so) { | ||
| if (($so['linkfield'] ?? null) === $field_name) { | ||
| $search_option = $so; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| $this->assertIsArray($search_option, 'search option not found for plugin field on custom asset'); | ||
|
|
||
| ob_start(); | ||
| $result = PluginFieldsField::showSingle($asset_class, $search_option, true); | ||
| $html = ob_get_clean(); | ||
|
|
||
| $this->assertTrue($result, 'showSingle() should find the field container for a CustomAsset itemtype'); | ||
| $this->assertStringContainsString($field_name, $html); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.