*/
public static function multiDataProvider(): array
{
// TODO: Figure out why this is needed here
Config::getInstance()->set('CodemirrorEnable', false);
return [
// Test data for PhpMyAdmin\Plugins\Transformations\Input\Image_JPEG_Upload plugin
[new Image_JPEG_Upload(), 'getName', 'Image upload'],
[
new Image_JPEG_Upload(),
'getInfo',
'Image upload functionality which also displays a thumbnail.'
. ' The options are the width and height of the thumbnail'
. ' in pixels. Defaults to 100 X 100.',
],
[new Image_JPEG_Upload(), 'getMIMEType', 'Image'],
[new Image_JPEG_Upload(), 'getMIMESubtype', 'JPEG'],
[new Image_JPEG_Upload(), 'getScripts', ['transformations/image_upload.js']],
[
new Image_JPEG_Upload(),
'getInputHtml',
' ',
['test', ['150'], '', 0, 0],
],
[
new Image_JPEG_Upload(),
'getInputHtml',
''
. ' ',
[
'2ndtest',
['wrapper_link' => '?table=a', 'wrapper_params' => ['key' => 'value']],
'something',
0,
0,
],
],
// Test data for TextPlainFileupload plugin
[new Text_Plain_FileUpload(), 'getName', 'Text file upload'],
[
new Text_Plain_FileUpload(),
'getInfo',
'File upload functionality for TEXT columns. It does not have a textarea for input.',
],
[new Text_Plain_FileUpload(), 'getMIMEType', 'Text'],
[new Text_Plain_FileUpload(), 'getMIMESubtype', 'Plain'],
[new Text_Plain_FileUpload(), 'getScripts', []],
[
new Text_Plain_FileUpload(),
'getInputHtml',
'',
['test', [], '', 0, 0],
],
[
new Text_Plain_FileUpload(),
'getInputHtml',
'',
['2ndtest', [], 'something', 0, 0],
],
// Test data for Text_Plain_Regexvalidation plugin
[new Text_Plain_RegexValidation(), 'getName', 'Regex Validation'],
[
new Text_Plain_RegexValidation(),
'getInfo',
'Validates the string using regular expression '
. 'and performs insert only if string matches it. '
. 'The first option is the Regular Expression.',
],
[new Text_Plain_RegexValidation(), 'getMIMEType', 'Text'],
[new Text_Plain_RegexValidation(), 'getMIMESubtype', 'Plain'],
[new Text_Plain_RegexValidation(), 'getInputHtml', '', ['', [], '', 0, 0]],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Application_Octetstream_Download plugin
[new Application_Octetstream_Download(), 'getName', 'Download'],
[
new Application_Octetstream_Download(),
'getInfo',
'Displays a link to download the binary data of the column.'
. ' You can use the option to specify the filename.',
],
[new Application_Octetstream_Download(), 'getMIMEType', 'Application'],
[new Application_Octetstream_Download(), 'getMIMESubtype', 'OctetStream'],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Application_Octetstream_Hex plugin
[new Application_Octetstream_Hex(), 'getName', 'Hex'],
[
new Application_Octetstream_Hex(),
'getInfo',
'Displays hexadecimal representation of data. Optional first'
. ' parameter specifies how often space will be added (defaults'
. ' to 2 nibbles).',
],
[new Application_Octetstream_Hex(), 'getMIMEType', 'Application'],
[new Application_Octetstream_Hex(), 'getMIMESubtype', 'OctetStream'],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Image_JPEG_Inline plugin
[new Image_JPEG_Inline(), 'getName', 'Inline'],
[
new Image_JPEG_Inline(),
'getInfo',
'Displays a clickable thumbnail. The options are the maximum width'
. ' and height in pixels. The original aspect ratio is preserved.',
],
[new Image_JPEG_Inline(), 'getMIMEType', 'Image'],
[new Image_JPEG_Inline(), 'getMIMESubtype', 'JPEG'],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Image_JPEG_Link plugin
[new Image_JPEG_Link(), 'getName', 'ImageLink'],
[new Image_JPEG_Link(), 'getInfo', 'Displays a link to download this image.'],
[new Image_JPEG_Link(), 'getMIMEType', 'Image'],
[new Image_JPEG_Link(), 'getMIMESubtype', 'JPEG'],
[new Image_JPEG_Link(), 'applyTransformationNoWrap', false],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Image_PNG_Inline plugin
[new Image_PNG_Inline(), 'getName', 'Inline'],
[
new Image_PNG_Inline(),
'getInfo',
'Displays a clickable thumbnail. The options are the maximum width'
. ' and height in pixels. The original aspect ratio is preserved.',
],
[new Image_PNG_Inline(), 'getMIMEType', 'Image'],
[new Image_PNG_Inline(), 'getMIMESubtype', 'PNG'],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Text_Plain_Dateformat plugin
[new Text_Plain_Dateformat(), 'getName', 'Date Format'],
[
new Text_Plain_Dateformat(),
'getInfo',
'Displays a TIME, TIMESTAMP, DATETIME or numeric unix timestamp'
. ' column as formatted date. The first option is the offset (in'
. ' hours) which will be added to the timestamp (Default: 0). Use'
. ' second option to specify a different date/time format string.'
. ' Third option determines whether you want to see local date or'
. ' UTC one (use "local" or "utc" strings) for that. According to'
. ' that, date format has different value - for "local" see the'
. ' documentation for PHP\'s strftime() function and for "utc" it'
. ' is done using gmdate() function.',
],
[new Text_Plain_Dateformat(), 'getMIMEType', 'Text'],
[new Text_Plain_Dateformat(), 'getMIMESubtype', 'Plain'],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Text_Plain_External plugin
[new Text_Plain_External(), 'getName', 'External'],
[
new Text_Plain_External(),
'getInfo',
'LINUX ONLY:'
. ' Launches an external application and feeds it the column'
. ' data via standard input. Returns the standard output of the'
. ' application. The default is Tidy, to pretty-print HTML code.'
. ' For security reasons, you have to manually edit the file'
. ' src/Plugins/Transformations/Abs/ExternalTransformationsPlugin'
. '.php and list the tools you want to make available.'
. ' The first option is then the number of the program you want to'
. ' use. The second option should be blank for historical reasons.'
. ' The third option, if set to 1, will convert the output using'
. ' htmlspecialchars() (Default 1). The fourth option, if set to 1,'
. ' will prevent wrapping and ensure that the output appears all on'
. ' one line (Default 1).',
],
[new Text_Plain_External(), 'getMIMEType', 'Text'],
[new Text_Plain_External(), 'getMIMESubtype', 'Plain'],
[
new Text_Plain_External(),
'applyTransformationNoWrap',
true,
[['/dev/null -i -wrap -q', '/dev/null -i -wrap -q']],
],
[
new Text_Plain_External(),
'applyTransformationNoWrap',
true,
[['/dev/null -i -wrap -q', '/dev/null -i -wrap -q', '/dev/null -i -wrap -q', 1]],
],
[
new Text_Plain_External(),
'applyTransformationNoWrap',
true,
[['/dev/null -i -wrap -q', '/dev/null -i -wrap -q', '/dev/null -i -wrap -q', '1']],
],
[
new Text_Plain_External(),
'applyTransformationNoWrap',
false,
[['/dev/null -i -wrap -q', '/dev/null -i -wrap -q', '/dev/null -i -wrap -q', 2]],
],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Text_Plain_Formatted plugin
[new Text_Plain_Formatted(), 'getName', 'Formatted'],
[
new Text_Plain_Formatted(),
'getInfo',
'Displays the contents of the column as-is, without running it'
. ' through htmlspecialchars(). That is, the column is assumed'
. ' to contain valid HTML.',
],
[new Text_Plain_Formatted(), 'getMIMEType', 'Text'],
[new Text_Plain_Formatted(), 'getMIMESubtype', 'Plain'],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Text_Plain_Imagelink plugin
[new Text_Plain_Imagelink(), 'getName', 'Image Link'],
[
new Text_Plain_Imagelink(),
'getInfo',
'Displays an image and a link; '
. 'the column contains the filename. The first option'
. ' is a URL prefix like "https://www.example.com/". '
. 'The second and third options'
. ' are the width and the height in pixels.',
],
[new Text_Plain_Imagelink(), 'getMIMEType', 'Text'],
[new Text_Plain_Imagelink(), 'getMIMESubtype', 'Plain'],
// Test data for PhpMyAdmin\Plugins\Transformations\Output\Text_Plain_Sql plugin
[new Text_Plain_Sql(), 'getName', 'SQL'],
[new Text_Plain_Sql(), 'getInfo', 'Formats text as SQL query with syntax highlighting.'],
[new Text_Plain_Sql(), 'getMIMEType', 'Text'],
[new Text_Plain_Sql(), 'getMIMESubtype', 'Plain'],
// Test data for PhpMyAdmin\Plugins\Transformations\Text_Plain_Link plugin
[new Text_Plain_Link(), 'getName', 'TextLink'],
[
new Text_Plain_Link(),
'getInfo',
'Displays a link; the column contains the filename. The first option'
. ' is a URL prefix like "https://www.example.com/".'
. ' The second option is a title for the link.',
],
[new Text_Plain_Link(), 'getMIMEType', 'Text'],
[new Text_Plain_Link(), 'getMIMESubtype', 'Plain'],
// Test data for PhpMyAdmin\Plugins\Transformations\Text_Plain_Longtoipv4 plugin
[new Text_Plain_Longtoipv4(), 'getName', 'Long To IPv4'],
[
new Text_Plain_Longtoipv4(),
'getInfo',
'Converts an (IPv4) Internet network address stored as a BIGINT'
. ' into a string in Internet standard dotted format.',
],
[new Text_Plain_Longtoipv4(), 'getMIMEType', 'Text'],
[new Text_Plain_Longtoipv4(), 'getMIMESubtype', 'Plain'],
// Test data for Text_Plain_PreApPend plugin
[new Text_Plain_PreApPend(), 'getName', 'PreApPend'],
[
new Text_Plain_PreApPend(),
'getInfo',
'Prepends and/or Appends text to a string. First option is text'
. ' to be prepended, second is appended (enclosed in single'
. ' quotes, default empty string).',
],
[new Text_Plain_PreApPend(), 'getMIMEType', 'Text'],
[new Text_Plain_PreApPend(), 'getMIMESubtype', 'Plain'],
// Test data for PhpMyAdmin\Plugins\Transformations\Text_Plain_Substring plugin
[new Text_Plain_Substring(), 'getName', 'Substring'],
[
new Text_Plain_Substring(),
'getInfo',
'Displays a part of a string. The first option is the number '
. 'of characters to skip from the beginning of the string '
. '(Default 0). The second option is the number of characters '
. 'to return (Default: until end of string). The third option is '
. 'the string to append and/or prepend when truncation occurs '
. '(Default: "…").',
],
[new Text_Plain_Substring(), 'getMIMEType', 'Text'],
[new Text_Plain_Substring(), 'getMIMESubtype', 'Plain'],
[new Text_Plain_Substring(), 'getOptions', ['foo', 'bar', 'baz'], [[], ['foo', 'bar', 'baz']]],
[
new Text_Plain_Substring(),
'getOptions',
['foo', 'bar', 'baz'],
[['foo', 'bar', 'baz'], ['foo', 'bar', 'baz']],
],
[new Text_Plain_Substring(), 'getOptions', ['foo','bar','baz'], [['foo','bar','baz'],[1,2,3]]],
];
}
/**
* Tests for getInfo, getName, getMIMEType, getMIMESubtype
* getScripts, applyTransformationNoWrap, getOptions
*
* @param object $object instance of the plugin
* @param string $method the method name
* @param mixed $expected the expected output
* @param mixed[] $args the array of arguments
*/
#[DataProvider('multiDataProvider')]
public function testGetMulti(object $object, string $method, mixed $expected, array $args = []): void
{
$reflectionMethod = new ReflectionMethod($object, $method);
self::assertSame(
$expected,
$reflectionMethod->invokeArgs($object, $args),
);
}
/**
* @return iterable
*/
public static function transformationDataProvider(): iterable
{
yield [new Image_JPEG_Upload(), ['test', [150, 100]], 'test'];
yield [new Text_Plain_FileUpload(), ['test', []], 'test'];
yield [new Text_Plain_RegexValidation(), ['phpMyAdmin', ['/php/i']], 'phpMyAdmin', true, ''];
yield [
new Text_Plain_RegexValidation(),
['qwerty', ['/^a/']],
'qwerty',
false,
'Validation failed for the input string qwerty.',
];
yield [
new Application_Octetstream_Download(),
[
'PMA_BUFFER',
[0 => 'filename', 'wrapper_link' => 'PMA_wrapper_link', 'wrapper_params' => ['key' => 'value']],
],
'filename',
];
yield [
new Application_Octetstream_Download(),
[
'PMA_BUFFER',
[
0 => '',
1 => 'cloumn',
'wrapper_link' => 'PMA_wrapper_link',
'wrapper_params' => ['key' => 'value'],
],
],
'binary_file.dat',
];
yield [new Application_Octetstream_Hex(), ['11111001', [3]], '313 131 313 130 303 1 '];
yield [new Application_Octetstream_Hex(), ['11111001', [0]], '3131313131303031'];
yield [new Application_Octetstream_Hex(), ['11111001', []], '31 31 31 31 31 30 30 31 '];
yield [
new Image_JPEG_Link(),
[
'PMA_IMAGE_LINK',
[
0 => './image/',
1 => '200',
'wrapper_link' => 'PMA_wrapper_link',
'wrapper_params' => ['key' => 'value'],
],
],
'[BLOB]',
];
yield [
new Text_Plain_Dateformat(),
['12345', [0], FieldHelper::fromArray(['type' => MYSQLI_TYPE_TINY])],
'Jan 01, 1970 at 03:25 AM',
];
yield [
new Text_Plain_Dateformat(),
['12345678', [0], FieldHelper::fromArray(['type' => MYSQLI_TYPE_STRING])],
'May 23, 1970 at 09:21 PM',
];
yield [
new Text_Plain_Dateformat(),
['123456789', [0], FieldHelper::fromArray(['type' => -1])],
'Nov 29, 1973 at 09:33 PM',
];
yield [
new Text_Plain_Dateformat(),
['20100201', [0], FieldHelper::fromArray(['type' => -1])],
'Feb 01, 2010 at 12:00 AM',
];
yield [
new Text_Plain_Dateformat(),
['1617153941', ['0', '%B %d, %Y at %I:%M %p', 'local'], FieldHelper::fromArray(['type' => -1])],
'Mar 31, 2021 at 01:25 AM',
];
yield [
new Text_Plain_Dateformat(),
[
'1617153941',
[
'0',
'',// Empty uses the "Y-m-d H:i:s" format
'utc',
],
FieldHelper::fromArray(['type' => -1]),
],
'2021-03-31 01:25:41',
];
yield [
new Text_Plain_Dateformat(),
[
'1617153941',
[
'0',
'',// Empty uses the "%B %d, %Y at %I:%M %p" format
'local',
],
FieldHelper::fromArray(['type' => -1]),
],
'Mar 31, 2021 at 01:25 AM',
];
yield [
new Text_Plain_Dateformat(),
['1617153941', ['0', 'H:i:s Y-d-m', 'utc'], FieldHelper::fromArray(['type' => -1])],
'01:25:41 2021-31-03',
];
yield [
new Text_Plain_External(),
['PMA_BUFFER', ['/dev/null -i -wrap -q', '/dev/null -i -wrap -q']],
'PMA_BUFFER',
];
yield [
new Text_Plain_Formatted(),
["PMA_BUFFER", ['option1', 'option2']],
"",
];
yield [
new Text_Plain_Formatted(),
['PMA_BUFFER', ['option1', 'option2']],
"",
];
yield [
new Text_Plain_Imagelink(),
['PMA_IMAGE', ['http://image/', '200']],
'' . "\n"
. ' ' . "\n"
. ' PMA_IMAGE' . "\n"
. '' . "\n",
];
yield [new Text_Plain_Imagelink(), ['PMA_IMAGE', ['./image/', '200']], './image/PMA_IMAGE'];
yield [
new Text_Plain_Sql(),
['select *', ['option1', 'option2']],
'
' . "\n"
. ' PMA_IMAGE' . "\n"
. '' . "\n",
];
yield [new Text_Plain_Imagelink(), ['PMA_IMAGE', ['./image/', '200']], './image/PMA_IMAGE'];
yield [
new Text_Plain_Sql(),
['select *', ['option1', 'option2']],
'