tests/src/Util/StringsTest.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Test\src\Util;
  23
  24 use Friendica\Util\Strings;
  25 use PHPUnit\Framework\TestCase;
  26
  27 /**
  28  * Strings utility test class
  29  */
  30 class StringsTest extends TestCase
  31 {
  32         /**
  33          * randomnames should be random, even length
  34          */
  35         public function testRandomEven()
  36         {
  37                 $randomname1 = Strings::getRandomName(10);
  38                 $randomname2 = Strings::getRandomName(10);
  39
  40                 self::assertNotEquals($randomname1, $randomname2);
  41         }
  42
  43         /**
  44          * randomnames should be random, odd length
  45          */
  46         public function testRandomOdd()
  47         {
  48                 $randomname1 = Strings::getRandomName(9);
  49                 $randomname2 = Strings::getRandomName(9);
  50
  51                 self::assertNotEquals($randomname1, $randomname2);
  52         }
  53
  54         /**
  55          * try to fail ramdonnames
  56          */
  57         public function testRandomNameNoLength()
  58         {
  59                 $randomname1 = Strings::getRandomName(0);
  60                 self::assertEquals(0, strlen($randomname1));
  61         }
  62
  63         /**
  64          * try to fail it with invalid input
  65          *
  66          * @todo What's corect behaviour here? An exception?
  67          */
  68         public function testRandomNameNegativeLength()
  69         {
  70                 $randomname1 = Strings::getRandomName(-23);
  71                 self::assertEquals(0, strlen($randomname1));
  72         }
  73
  74         /**
  75          * test with a length, that may be too short
  76          */
  77         public function testRandomNameLength1()
  78         {
  79                 $randomname1 = Strings::getRandomName(1);
  80                 self::assertEquals(1, strlen($randomname1));
  81
  82                 $randomname2 = Strings::getRandomName(1);
  83                 self::assertEquals(1, strlen($randomname2));
  84         }
  85
  86         /**
  87          * test, that tags are escaped
  88          */
  89         public function testEscapeHtml()
  90         {
  91                 $invalidstring='<submit type="button" onclick="alert(\'failed!\');" />';
  92
  93                 $escapedString = Strings::escapeHtml($invalidstring);
  94
  95                 self::assertEquals(
  96                         "&lt;submit type=&quot;button&quot; onclick=&quot;alert('failed!');&quot; /&gt;",
  97                         $escapedString
  98                 );
  99         }
 100
 101         public function dataIsHex()
 102         {
 103                 return [
 104                         'validHex' => [
 105                                 'input' => '90913473615bf00c122ac78338492980',
 106                                 'valid' => true,
 107                         ],
 108                         'invalidHex' => [
 109                                 'input' => '90913473615bf00c122ac7833849293',
 110                                 'valid' => false,
 111                         ],
 112                         'emptyHex' => [
 113                                 'input' => '',
 114                                 'valid' => false,
 115                         ],
 116                         'nullHex' => [
 117                                 'input' => null,
 118                                 'valid' => false,
 119                         ],
 120                 ];
 121         }
 122
 123         /**
 124          * Tests if the string is a valid hexadecimal value
 125          *
 126          * @param string|null $input
 127          * @param bool        $valid
 128          *
 129          * @dataProvider dataIsHex
 130          */
 131         public function testIsHex(string $input = null, bool $valid = false)
 132         {
 133                 self::assertEquals($valid, Strings::isHex($input));
 134         }
 135
 136         /**
 137          * Tests that Strings::substringReplace behaves the same as substr_replace with ASCII strings in all the possible
 138          * numerical parameter configurations (positive, negative, zero, out of bounds either side, null)
 139          */
 140         public function testSubstringReplaceASCII()
 141         {
 142                 for ($start = -10; $start <= 10; $start += 5) {
 143                         self::assertEquals(
 144                                 substr_replace('string', 'replacement', $start),
 145                                 Strings::substringReplace('string', 'replacement', $start)
 146                         );
 147
 148                         for ($length = -10; $length <= 10; $length += 5) {
 149                                 self::assertEquals(
 150                                         substr_replace('string', 'replacement', $start, $length),
 151                                         Strings::substringReplace('string', 'replacement', $start, $length)
 152                                 );
 153                         }
 154                 }
 155         }
 156
 157
 158         public function dataSubstringReplaceMultiByte()
 159         {
 160                 return [
 161                         'issue-8470' => [
 162                                 'expected' => 'Je n’y pense que maintenant (pask ma sonnette ne fonctionne pas) : mettre un gentil mot avec mes coordonnées sur ma porte est le moyen le plus simple de rester en contact si besoin avec mon voisinage direct ! [url=https://www.instagram.com/p/B-UdH2loee1/?igshid=x4aglyju9kva]instagram.com/p/B-UdH2loee1/…[/url] [rest of the post]',
 163                                 'string' => 'Je n’y pense que maintenant (pask ma sonnette ne fonctionne pas) : mettre un gentil mot avec mes coordonnées sur ma porte est le moyen le plus simple de rester en contact si besoin avec mon voisinage direct ! https://t.co/YoBWTHsAAk [rest of the post]',
 164                                 'replacement' => '[url=https://www.instagram.com/p/B-UdH2loee1/?igshid=x4aglyju9kva]instagram.com/p/B-UdH2loee1/…[/url]',
 165                                 'start' => 209,
 166                                 'length' => 23,
 167                         ],
 168                 ];
 169         }
 170
 171         /**
 172          * Tests cases where Strings::substringReplace is needed over substr_replace with multi-byte strings and character
 173          * offsets
 174          *
 175          * @param string   $expected
 176          * @param string   $string
 177          * @param string   $replacement
 178          * @param int      $start
 179          * @param int|null $length
 180          *
 181          * @dataProvider dataSubstringReplaceMultiByte
 182          */
 183         public function testSubstringReplaceMultiByte(string $expected, string $string, string $replacement, int $start, int $length = null)
 184         {
 185                 self::assertEquals(
 186                         $expected,
 187                         Strings::substringReplace(
 188                                 $string,
 189                                 $replacement,
 190                                 $start,
 191                                 $length
 192                         )
 193                 );
 194         }
 195
 196         public function testPerformWithEscapedBlocks()
 197         {
 198                 $originalText = '[noparse][/noparse][nobb]nobb[/nobb][noparse]noparse[/noparse]';
 199
 200                 $text = Strings::performWithEscapedBlocks($originalText, '#[(?:noparse|nobb)].*?\[/(?:noparse|nobb)]#is', function ($text) {
 201                         return $text;
 202                 });
 203
 204                 self::assertEquals($originalText, $text);
 205         }
 206
 207         public function testPerformWithEscapedBlocksNested()
 208         {
 209                 $originalText = '[noparse][/noparse][nobb]nobb[/nobb][noparse]noparse[/noparse]';
 210
 211                 $text = Strings::performWithEscapedBlocks($originalText, '#[nobb].*?\[/nobb]#is', function ($text) {
 212                         $text = Strings::performWithEscapedBlocks($text, '#[noparse].*?\[/noparse]#is', function ($text) {
 213                                 return $text;
 214                         });
 215
 216                         return $text;
 217                 });
 218
 219                 self::assertEquals($originalText, $text);
 220         }
 221 }