Detection of invalid sheet name - continued

Invalid names can also be triggered by:
- character ":"
- single quote at the beginning of the name
- single quote at the end of the name

Introduced a StringHelper, wrapping multibyte strings functions

src/Spout/Common/Helper/StringHelper.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Box\Spout\Common\Helper;
+
+/**
+ * Class StringHelper
+ * This class provides helper functions to work with strings and multibyte strings.
+ *
+ * @codeCoverageIgnore
+ *
+ * @package Box\Spout\Common\Helper
+ */
+class StringHelper
+{
+    /** @var bool Whether the mbstring extension is loaded */
+    protected $hasMbstringSupport;
+
+    /**
+     *
+     */
+    public function __construct()
+    {
+        $this->hasMbstringSupport = extension_loaded('mbstring');
+    }
+
+    /**
+     * Returns the length of the given string.
+     * It uses the multi-bytes function is available.
+     * @see strlen
+     * @see mb_strlen
+     *
+     * @param string $string
+     * @return int
+     */
+    public function getStringLength($string)
+    {
+        return $this->hasMbstringSupport ? mb_strlen($string) : strlen($string);
+    }
+
+    /**
+     * Returns the position of the first occurrence of the given character/substring within the given string.
+     * It uses the multi-bytes function is available.
+     * @see strpos
+     * @see mb_strpos
+     *
+     * @param string $char Needle
+     * @param string $string Haystack
+     * @return int Char/substring's first occurrence position within the string if found (starts at 0) or -1 if not found
+     */
+    public function getCharFirstOccurrencePosition($char, $string)
+    {
+        $position = $this->hasMbstringSupport ? mb_strpos($string, $char) : strpos($string, $char);
+        return ($position !== false) ? $position : -1;
+    }
+
+    /**
+     * Returns the position of the last occurrence of the given character/substring within the given string.
+     * It uses the multi-bytes function is available.
+     * @see strrpos
+     * @see mb_strrpos
+     *
+     * @param string $char Needle
+     * @param string $string Haystack
+     * @return int Char/substring's last occurrence position within the string if found (starts at 0) or -1 if not found
+     */
+    public function getCharLastOccurrencePosition($char, $string)
+    {
+        $position = $this->hasMbstringSupport ? mb_strrpos($string, $char) : strrpos($string, $char);
+        return ($position !== false) ? $position : -1;
+    }
+}

src/Spout/Writer/XLSX/Sheet.php

@@ -2,6 +2,7 @@
 
 namespace Box\Spout\Writer\XLSX;
 
+use Box\Spout\Common\Helper\StringHelper;
 use Box\Spout\Writer\Exception\InvalidSheetNameException;
 
 /**
@@ -18,7 +19,7 @@ class Sheet
     const MAX_LENGTH_SHEET_NAME = 31;
 
     /** @var array Invalid characters that cannot be contained in the sheet name */
-    private static $INVALID_CHARACTERS_IN_SHEET_NAME = ['\\', '/', '?', '*', '[', ']'];
+    private static $INVALID_CHARACTERS_IN_SHEET_NAME = ['\\', '/', '?', '*', ':', '[', ']'];
 
     /** @var array Associative array [SHEET_INDEX] => [SHEET_NAME] keeping track of sheets' name to enforce uniqueness */
     protected static $SHEETS_NAME_USED = [];
@@ -29,12 +30,16 @@ class Sheet
     /** @var string Name of the sheet */
     protected $name;
 
+    /** @var \Box\Spout\Common\Helper\StringHelper */
+    protected $stringHelper;
+
     /**
      * @param int $sheetIndex Index of the sheet, based on order of creation (zero-based)
      */
     public function __construct($sheetIndex)
     {
         $this->index = $sheetIndex;
+        $this->stringHelper = new StringHelper();
         $this->setName(self::DEFAULT_SHEET_NAME_PREFIX . ($sheetIndex + 1));
     }
 
@@ -58,7 +63,7 @@ class Sheet
      * Sets the name of the sheet. Note that Excel has some restrictions on the name:
      *  - it should not be blank
      *  - it should not exceed 31 characters
-     *  - it should not contain these characters: \ / ? * [ or ]
+     *  - it should not contain these characters: \ / ? * : [ or ]
      *  - it should be unique
      *
      * @param string $name Name of the sheet
@@ -71,7 +76,7 @@ class Sheet
             $errorMessage = "The sheet's name is invalid. It did not meet at least one of these requirements:\n";
             $errorMessage .= " - It should not be blank\n";
             $errorMessage .= " - It should not exceed 31 characters\n";
-            $errorMessage .= " - It should not contain these characters: \\ / ? * [ or ]\n";
+            $errorMessage .= " - It should not contain these characters: \\ / ? * : [ or ]\n";
             $errorMessage .= " - It should be unique";
             throw new InvalidSheetNameException($errorMessage);
         }
@@ -95,42 +100,15 @@ class Sheet
             return false;
         }
 
-        $nameLength = $this->getStringLength($name);
-        $hasValidLength = ($nameLength > 0 && $nameLength <= self::MAX_LENGTH_SHEET_NAME);
-        $containsInvalidCharacters = $this->doesContainInvalidCharacters($name);
-        $isNameUnique = $this->isNameUnique($name);
+        $nameLength = $this->stringHelper->getStringLength($name);
 
-        return ($hasValidLength && !$containsInvalidCharacters && $isNameUnique);
-    }
-
-    /**
-     * Returns the length of the given string.
-     * It uses the multi-bytes function is available.
-     * @see strlen
-     * @see mb_strlen
-     *
-     * @param string $string
-     * @return int
-     */
-    protected function getStringLength($string)
-    {
-        return extension_loaded('mbstring') ? mb_strlen($string) : strlen($string);
-    }
-
-    /**
-     * Returns the position of the given character/substring in the given string.
-     * It uses the multi-bytes function is available.
-     * @see strpos
-     * @see mb_strpos
-     *
-     * @param string $string Haystack
-     * @param string $char Needle
-     * @return int Index of the char in the string if found (started at 0) or -1 if not found
-     */
-    protected function getCharPosition($string, $char)
-    {
-        $position = extension_loaded('mbstring') ? mb_strpos($string, $char) : strpos($string, $char);
-        return ($position !== false) ? $position : -1;
+        return (
+            $nameLength > 0 &&
+            $nameLength <= self::MAX_LENGTH_SHEET_NAME &&
+            !$this->doesContainInvalidCharacters($name) &&
+            $this->isNameUnique($name) &&
+            !$this->doesStartOrEndWithSingleQuote($name)
+        );
     }
 
     /**
@@ -142,13 +120,21 @@ class Sheet
      */
     protected function doesContainInvalidCharacters($name)
     {
-        foreach (self::$INVALID_CHARACTERS_IN_SHEET_NAME as $invalidCharacter) {
-            if ($this->getCharPosition($name, $invalidCharacter) !== -1) {
-                return true;
-            }
-        }
+        return (str_replace(self::$INVALID_CHARACTERS_IN_SHEET_NAME, '', $name) !== $name);
+    }
 
-        return false;
+    /**
+     * Returns whether the given name starts or ends with a single quote
+     *
+     * @param string $name
+     * @return bool TRUE if the name starts or ends with a single quote, FALSE otherwise.
+     */
+    protected function doesStartOrEndWithSingleQuote($name)
+    {
+        $startsWithSingleQuote = ($this->stringHelper->getCharFirstOccurrencePosition('\'', $name) === 0);
+        $endsWithSingleQuote = ($this->stringHelper->getCharLastOccurrencePosition('\'', $name) === ($this->stringHelper->getStringLength($name) - 1));
+
+        return ($startsWithSingleQuote || $endsWithSingleQuote);
     }
 
     /**