Clientbase
/
PhpSpreadsheet
mirror of https://github.com/basemaster/PhpSpreadsheet.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Extract cell/range validations from Worksheet and move into a separate Worksheet/Validations class as public static methods 

Extract tryDefinedName logic from Worksheet, nd move into the Worksheet/Validations class as a public static method
Apply stricter validation to autofilter range arguments
This commit is contained in:
MarkBaker 2022-04-23 13:08:06 +02:00
parent 0d014822a0
commit 69edf61ed6
4 changed files with 142 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/PhpSpreadsheet/Calculation/Functions.php
View File

@ -4,7 +4,6 @@ namespace PhpOffice\PhpSpreadsheet\Calculation;
use PhpOffice\PhpSpreadsheet\Cell\Cell; use PhpOffice\PhpSpreadsheet\Cell\Cell;
use PhpOffice\PhpSpreadsheet\Shared\Date; use PhpOffice\PhpSpreadsheet\Shared\Date;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
class Functions class Functions
{ {
@ -686,12 +685,13 @@ class Functions
// Uppercase coordinate // Uppercase coordinate
$pCoordinatex = strtoupper($coordinate); $pCoordinatex = strtoupper($coordinate);
// Eliminate leading equal sign // Eliminate leading equal sign
$pCoordinatex = Worksheet::pregReplace('/^=/', '', $pCoordinatex); $pCoordinatex = (string) preg_replace('/^=/', '', $pCoordinatex);
$defined = $spreadsheet->getDefinedName($pCoordinatex, $worksheet); $defined = $spreadsheet->getDefinedName($pCoordinatex, $worksheet);
if ($defined !== null) { if ($defined !== null) {
$worksheet2 = $defined->getWorkSheet(); $worksheet2 = $defined->getWorkSheet();
if (!$defined->isFormula() && $worksheet2 !== null) { if (!$defined->isFormula() && $worksheet2 !== null) {
$coordinate = "'" . $worksheet2->getTitle() . "'!" . Worksheet::pregReplace('/^=/', '', $defined->getValue()); $coordinate = "'" . $worksheet2->getTitle() . "'!" .
(string) preg_replace('/^=/', '', $defined->getValue());
} }
} }
@ -700,7 +700,7 @@ class Functions
public static function trimTrailingRange(string $coordinate): string public static function trimTrailingRange(string $coordinate): string
{ {
return Worksheet::pregReplace('/:[\\w\$]+$/', '', $coordinate); return (string) preg_replace('/:[\\w\$]+$/', '', $coordinate);
} }
public static function trimSheetFromCellReference(string $coordinate): string public static function trimSheetFromCellReference(string $coordinate): string

23
src/PhpSpreadsheet/Worksheet/AutoFilter.php
View File

@ -7,6 +7,7 @@ use DateTimeZone;
use PhpOffice\PhpSpreadsheet\Calculation\Calculation; use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
use PhpOffice\PhpSpreadsheet\Calculation\Functions; use PhpOffice\PhpSpreadsheet\Calculation\Functions;
use PhpOffice\PhpSpreadsheet\Calculation\Internal\WildcardMatch; use PhpOffice\PhpSpreadsheet\Calculation\Internal\WildcardMatch;
use PhpOffice\PhpSpreadsheet\Cell\AddressRange;
use PhpOffice\PhpSpreadsheet\Cell\Coordinate; use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException; use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
use PhpOffice\PhpSpreadsheet\Shared\Date; use PhpOffice\PhpSpreadsheet\Shared\Date;
@ -50,9 +51,18 @@ class AutoFilter
/** /**
* Create a new AutoFilter. * Create a new AutoFilter.
*
* @param AddressRange|array<int>|string $range
* A simple string containing a Cell range like 'A1:E10' is permitted
* or passing in an array of [$fromColumnIndex, $fromRow, $toColumnIndex, $toRow] (e.g. [3, 5, 6, 8]),
* or an AddressRange object.
*/ */
public function __construct(string $range = '', ?Worksheet $worksheet = null) public function __construct($range = '', ?Worksheet $worksheet = null)
{ {
if ($range !== '') {
[, $range] = Worksheet::extractSheetTitle(Validations::validateCellRange($range), true);
}
$this->range = $range; $this->range = $range;
$this->workSheet = $worksheet; $this->workSheet = $worksheet;
} }
@ -92,12 +102,19 @@ class AutoFilter
/** /**
* Set AutoFilter Cell Range. * Set AutoFilter Cell Range.
*
* @param AddressRange|array<int>|string $range
* A simple string containing a Cell range like 'A1:E10' is permitted
* or passing in an array of [$fromColumnIndex, $fromRow, $toColumnIndex, $toRow] (e.g. [3, 5, 6, 8]),
* or an AddressRange object.
*/ */
public function setRange(string $range): self public function setRange($range = ''): self
{ {
$this->evaluated = false; $this->evaluated = false;
// extract coordinate // extract coordinate
[$worksheet, $range] = Worksheet::extractSheetTitle($range, true); if ($range !== '') {
[, $range] = Worksheet::extractSheetTitle(Validations::validateCellRange($range), true);
}
if (empty($range)) { if (empty($range)) {
// Discard all column rules // Discard all column rules
$this->columns = []; $this->columns = [];

100
src/PhpSpreadsheet/Worksheet/Validations.php Normal file
View File

@ -0,0 +1,100 @@
<?php
namespace PhpOffice\PhpSpreadsheet\Worksheet;
use PhpOffice\PhpSpreadsheet\Cell\AddressRange;
use PhpOffice\PhpSpreadsheet\Cell\CellAddress;
use PhpOffice\PhpSpreadsheet\Cell\CellRange;
class Validations
{
/**
* Validate a cell address.
*
* @param null|array<int>|CellAddress|string $cellAddress Coordinate of the cell as a string, eg: 'C5';
* or as an array of [$columnIndex, $row] (e.g. [3, 5]), or a CellAddress object.
*/
public static function validateCellAddress($cellAddress): string
{
if (is_string($cellAddress)) {
[$worksheet, $address] = Worksheet::extractSheetTitle($cellAddress, true);
// if (!empty($worksheet) && $worksheet !== $this->getTitle()) {
// throw new Exception('Reference is not for this worksheet');
// }
return empty($worksheet) ? strtoupper($address) : $worksheet . '!' . strtoupper($address);
}
if (is_array($cellAddress)) {
$cellAddress = CellAddress::fromColumnRowArray($cellAddress);
}
return (string) $cellAddress;
}
/**
* Validate a cell address or cell range.
*
* @param AddressRange|array<int>|CellAddress|int|string $cellRange Coordinate of the cells as a string, eg: 'C5:F12';
* or as an array of [$fromColumnIndex, $fromRow, $toColumnIndex, $toRow] (e.g. [3, 5, 6, 12]),
* or as a CellAddress or AddressRange object.
*/
public static function validateCellOrCellRange($cellRange): string
{
if (is_string($cellRange) || is_numeric($cellRange)) {
$cellRange = (string) $cellRange;
// Convert a single column reference like 'A' to 'A:A'
$cellRange = (string) preg_replace('/^([A-Z]+)$/', '${1}:${1}', $cellRange);
// Convert a single row reference like '1' to '1:1'
$cellRange = (string) preg_replace('/^(\d+)$/', '${1}:${1}', $cellRange);
} elseif (is_object($cellRange) && $cellRange instanceof CellAddress) {
$cellRange = new CellRange($cellRange, $cellRange);
}
return self::validateCellRange($cellRange);
}
/**
* Validate a cell range.
*
* @param AddressRange|array<int>|string $cellRange Coordinate of the cells as a string, eg: 'C5:F12';
* or as an array of [$fromColumnIndex, $fromRow, $toColumnIndex, $toRow] (e.g. [3, 5, 6, 12]),
* or as an AddressRange object.
*/
public static function validateCellRange($cellRange): string
{
if (is_string($cellRange)) {
[$worksheet, $addressRange] = Worksheet::extractSheetTitle($cellRange, true);
// Convert Column ranges like 'A:C' to 'A1:C1048576'
$addressRange = (string) preg_replace('/^([A-Z]+):([A-Z]+)$/', '${1}1:${2}1048576', $addressRange);
// Convert Row ranges like '1:3' to 'A1:XFD3'
$addressRange = (string) preg_replace('/^(\\d+):(\\d+)$/', 'A${1}:XFD${2}', $addressRange);
return empty($worksheet) ? strtoupper($addressRange) : $worksheet . '!' . strtoupper($addressRange);
}
if (is_array($cellRange)) {
[$from, $to] = array_chunk($cellRange, 2);
$cellRange = new CellRange(CellAddress::fromColumnRowArray($from), CellAddress::fromColumnRowArray($to));
}
return (string) $cellRange;
}
public static function definedNameToCoordinate(string $coordinate, Worksheet $worksheet): string
{
// Uppercase coordinate
$testCoordinate = strtoupper($coordinate);
// Eliminate leading equal sign
$testCoordinate = (string) preg_replace('/^=/', '', $coordinate);
$defined = $worksheet->getParent()->getDefinedName($testCoordinate, $worksheet);
if ($defined !== null) {
if ($defined->getWorksheet() === $worksheet && !$defined->isFormula()) {
$coordinate = (string) preg_replace('/^=/', '', $defined->getValue());
}
}
return $coordinate;
}
}

142
src/PhpSpreadsheet/Worksheet/Worksheet.php
View File

@ -1067,7 +1067,7 @@ class Worksheet implements IComparable
*/ */
public function getHighestColumn($row = null) public function getHighestColumn($row = null)
{ {
if (empty($row)) { if ($row === null) {
return Coordinate::stringFromColumnIndex($this->cachedHighestColumn); return Coordinate::stringFromColumnIndex($this->cachedHighestColumn);
} }
@ -1097,7 +1097,7 @@ class Worksheet implements IComparable
*/ */
public function getHighestRow($column = null) public function getHighestRow($column = null)
{ {
if ($column == null) { if ($column === null) {
return $this->cachedHighestRow; return $this->cachedHighestRow;
} }
@ -1127,96 +1127,6 @@ class Worksheet implements IComparable
return $this->cellCollection->getHighestRowAndColumn(); return $this->cellCollection->getHighestRowAndColumn();
} }
/**
* Validate a cell address.
*
* @param null|array<int>|CellAddress|string $cellAddress Coordinate of the cell as a string, eg: 'C5';
* or as an array of [$columnIndex, $row] (e.g. [3, 5]), or a CellAddress object.
*/
protected function validateCellAddress($cellAddress): string
{
if (is_string($cellAddress)) {
[$worksheet, $address] = self::extractSheetTitle($cellAddress, true);
// if (!empty($worksheet) && $worksheet !== $this->getTitle()) {
// throw new Exception('Reference is not for this worksheet');
// }
return empty($worksheet) ? strtoupper($address) : $worksheet . '!' . strtoupper($address);
}
if (is_array($cellAddress)) {
$cellAddress = CellAddress::fromColumnRowArray($cellAddress);
}
return (string) $cellAddress;
}
private function tryDefinedName(string $coordinate): string
{
// Uppercase coordinate
$coordinate = strtoupper($coordinate);
// Eliminate leading equal sign
$coordinate = self::pregReplace('/^=/', '', $coordinate);
$defined = $this->parent->getDefinedName($coordinate, $this);
if ($defined !== null) {
if ($defined->getWorksheet() === $this && !$defined->isFormula()) {
$coordinate = self::pregReplace('/^=/', '', $defined->getValue());
}
}
return $coordinate;
}
/**
* Validate a cell address or cell range.
*
* @param AddressRange|array<int>|CellAddress|int|string $cellRange Coordinate of the cells as a string, eg: 'C5:F12';
* or as an array of [$fromColumnIndex, $fromRow, $toColumnIndex, $toRow] (e.g. [3, 5, 6, 12]),
* or as a CellAddress or AddressRange object.
*/
protected function validateCellOrCellRange($cellRange): string
{
if (is_string($cellRange) || is_numeric($cellRange)) {
$cellRange = (string) $cellRange;
// Convert a single column reference like 'A' to 'A:A'
$cellRange = self::pregReplace('/^([A-Z]+)$/', '${1}:${1}', $cellRange);
// Convert a single row reference like '1' to '1:1'
$cellRange = self::pregReplace('/^(\d+)$/', '${1}:${1}', $cellRange);
} elseif (is_object($cellRange) && $cellRange instanceof CellAddress) {
$cellRange = new CellRange($cellRange, $cellRange);
}
return $this->validateCellRange($cellRange);
}
/**
* Validate a cell range.
*
* @param AddressRange|array<int>|string $cellRange Coordinate of the cells as a string, eg: 'C5:F12';
* or as an array of [$fromColumnIndex, $fromRow, $toColumnIndex, $toRow] (e.g. [3, 5, 6, 12]),
* or as an AddressRange object.
*/
protected function validateCellRange($cellRange): string
{
if (is_string($cellRange)) {
[$worksheet, $addressRange] = self::extractSheetTitle($cellRange, true);
// Convert Column ranges like 'A:C' to 'A1:C1048576'
$addressRange = self::pregReplace('/^([A-Z]+):([A-Z]+)$/', '${1}1:${2}1048576', $addressRange);
// Convert Row ranges like '1:3' to 'A1:XFD3'
$addressRange = self::pregReplace('/^(\\d+):(\\d+)$/', 'A${1}:XFD${2}', $addressRange);
return empty($worksheet) ? strtoupper($addressRange) : $worksheet . '!' . strtoupper($addressRange);
}
if (is_array($cellRange)) {
[$from, $to] = array_chunk($cellRange, 2);
$cellRange = new CellRange(CellAddress::fromColumnRowArray($from), CellAddress::fromColumnRowArray($to));
}
return (string) $cellRange;
}
/** /**
* Set a cell value. * Set a cell value.
* *
@ -1228,7 +1138,7 @@ class Worksheet implements IComparable
*/ */
public function setCellValue($coordinate, $value) public function setCellValue($coordinate, $value)
{ {
$cellAddress = Functions::trimSheetFromCellReference($this->validateCellAddress($coordinate)); $cellAddress = Functions::trimSheetFromCellReference(Validations::validateCellAddress($coordinate));
$this->getCell($cellAddress)->setValue($value); $this->getCell($cellAddress)->setValue($value);
return $this; return $this;
@ -1266,7 +1176,7 @@ class Worksheet implements IComparable
*/ */
public function setCellValueExplicit($coordinate, $value, $dataType) public function setCellValueExplicit($coordinate, $value, $dataType)
{ {
$cellAddress = Functions::trimSheetFromCellReference($this->validateCellAddress($coordinate)); $cellAddress = Functions::trimSheetFromCellReference(Validations::validateCellAddress($coordinate));
$this->getCell($cellAddress)->setValueExplicit($value, $dataType); $this->getCell($cellAddress)->setValueExplicit($value, $dataType);
return $this; return $this;
@ -1303,7 +1213,7 @@ class Worksheet implements IComparable
*/ */
public function getCell($coordinate): Cell public function getCell($coordinate): Cell
{ {
$cellAddress = Functions::trimSheetFromCellReference($this->validateCellAddress($coordinate)); $cellAddress = Functions::trimSheetFromCellReference(Validations::validateCellAddress($coordinate));
// Shortcut for increased performance for the vast majority of simple cases // Shortcut for increased performance for the vast majority of simple cases
if ($this->cellCollection->has($cellAddress)) { if ($this->cellCollection->has($cellAddress)) {
@ -1454,7 +1364,7 @@ class Worksheet implements IComparable
*/ */
public function cellExists($coordinate): bool public function cellExists($coordinate): bool
{ {
$cellAddress = $this->validateCellAddress($coordinate); $cellAddress = Validations::validateCellAddress($coordinate);
/** @var Worksheet $sheet */ /** @var Worksheet $sheet */
[$sheet, $finalCoordinate] = $this->getWorksheetAndCoordinate($cellAddress); [$sheet, $finalCoordinate] = $this->getWorksheetAndCoordinate($cellAddress);
@ -1546,7 +1456,7 @@ class Worksheet implements IComparable
*/ */
public function getStyle($cellCoordinate): Style public function getStyle($cellCoordinate): Style
{ {
$cellCoordinate = $this->validateCellOrCellRange($cellCoordinate); $cellCoordinate = Validations::validateCellOrCellRange($cellCoordinate);
// set this sheet as active // set this sheet as active
$this->parent->setActiveSheetIndex($this->parent->getIndex($this)); $this->parent->setActiveSheetIndex($this->parent->getIndex($this));
@ -1784,7 +1694,7 @@ class Worksheet implements IComparable
*/ */
public function setBreak($coordinate, $break) public function setBreak($coordinate, $break)
{ {
$cellAddress = Functions::trimSheetFromCellReference($this->validateCellAddress($coordinate)); $cellAddress = Functions::trimSheetFromCellReference(Validations::validateCellAddress($coordinate));
if ($break === self::BREAK_NONE) { if ($break === self::BREAK_NONE) {
if (isset($this->breaks[$cellAddress])) { if (isset($this->breaks[$cellAddress])) {
@ -1836,7 +1746,7 @@ class Worksheet implements IComparable
*/ */
public function mergeCells($range) public function mergeCells($range)
{ {
$range = Functions::trimSheetFromCellReference($this->validateCellRange($range)); $range = Functions::trimSheetFromCellReference(Validations::validateCellRange($range));
if (preg_match('/^([A-Z]+)(\\d+):([A-Z]+)(\\d+)$/', $range, $matches) === 1) { if (preg_match('/^([A-Z]+)(\\d+):([A-Z]+)(\\d+)$/', $range, $matches) === 1) {
$this->mergeCells[$range] = $range; $this->mergeCells[$range] = $range;
@ -1945,7 +1855,7 @@ class Worksheet implements IComparable
*/ */
public function unmergeCells($range) public function unmergeCells($range)
{ {
$range = Functions::trimSheetFromCellReference($this->validateCellRange($range)); $range = Functions::trimSheetFromCellReference(Validations::validateCellRange($range));
if (strpos($range, ':') !== false) { if (strpos($range, ':') !== false) {
if (isset($this->mergeCells[$range])) { if (isset($this->mergeCells[$range])) {
@ -2023,7 +1933,7 @@ class Worksheet implements IComparable
*/ */
public function protectCells($range, $password, $alreadyHashed = false) public function protectCells($range, $password, $alreadyHashed = false)
{ {
$range = Functions::trimSheetFromCellReference($this->validateCellOrCellRange($range)); $range = Functions::trimSheetFromCellReference(Validations::validateCellOrCellRange($range));
if (!$alreadyHashed) { if (!$alreadyHashed) {
$password = Shared\PasswordHasher::hashPassword($password); $password = Shared\PasswordHasher::hashPassword($password);
@ -2071,7 +1981,7 @@ class Worksheet implements IComparable
*/ */
public function unprotectCells($range) public function unprotectCells($range)
{ {
$range = Functions::trimSheetFromCellReference($this->validateCellOrCellRange($range)); $range = Functions::trimSheetFromCellReference(Validations::validateCellOrCellRange($range));
if (isset($this->protectedCells[$range])) { if (isset($this->protectedCells[$range])) {
unset($this->protectedCells[$range]); unset($this->protectedCells[$range]);
@ -2142,7 +2052,7 @@ class Worksheet implements IComparable
if (is_object($autoFilterOrRange) && ($autoFilterOrRange instanceof AutoFilter)) { if (is_object($autoFilterOrRange) && ($autoFilterOrRange instanceof AutoFilter)) {
$this->autoFilter = $autoFilterOrRange; $this->autoFilter = $autoFilterOrRange;
} else { } else {
$cellRange = Functions::trimSheetFromCellReference($this->validateCellRange($autoFilterOrRange)); $cellRange = Functions::trimSheetFromCellReference(Validations::validateCellRange($autoFilterOrRange));
$this->autoFilter->setRange($cellRange); $this->autoFilter->setRange($cellRange);
} }
@ -2216,13 +2126,13 @@ class Worksheet implements IComparable
public function freezePane($coordinate, $topLeftCell = null) public function freezePane($coordinate, $topLeftCell = null)
{ {
$cellAddress = ($coordinate !== null) $cellAddress = ($coordinate !== null)
? Functions::trimSheetFromCellReference($this->validateCellAddress($coordinate)) ? Functions::trimSheetFromCellReference(Validations::validateCellAddress($coordinate))
: null; : null;
if ($cellAddress !== null && Coordinate::coordinateIsRange($cellAddress)) { if ($cellAddress !== null && Coordinate::coordinateIsRange($cellAddress)) {
throw new Exception('Freeze pane can not be set on a range of cells.'); throw new Exception('Freeze pane can not be set on a range of cells.');
} }
$topLeftCell = ($topLeftCell !== null) $topLeftCell = ($topLeftCell !== null)
? Functions::trimSheetFromCellReference($this->validateCellAddress($topLeftCell)) ? Functions::trimSheetFromCellReference(Validations::validateCellAddress($topLeftCell))
: null; : null;
if ($cellAddress !== null && $topLeftCell === null) { if ($cellAddress !== null && $topLeftCell === null) {
@ -2626,7 +2536,7 @@ class Worksheet implements IComparable
*/ */
public function getComment($cellCoordinate) public function getComment($cellCoordinate)
{ {
$cellAddress = Functions::trimSheetFromCellReference($this->validateCellAddress($cellCoordinate)); $cellAddress = Functions::trimSheetFromCellReference(Validations::validateCellAddress($cellCoordinate));
if (Coordinate::coordinateIsRange($cellAddress)) { if (Coordinate::coordinateIsRange($cellAddress)) {
throw new Exception('Cell coordinate string can not be a range of cells.'); throw new Exception('Cell coordinate string can not be a range of cells.');
@ -2697,22 +2607,6 @@ class Worksheet implements IComparable
return $this->setSelectedCells($coordinate); return $this->setSelectedCells($coordinate);
} }
/**
* Sigh - Phpstan thinks, correctly, that preg_replace can return null.
* But Scrutinizer doesn't. Try to satisfy both.
*
* @param mixed $str
*/
private static function ensureString($str): string
{
return is_string($str) ? $str : '';
}
public static function pregReplace(string $pattern, string $replacement, string $subject): string
{
return self::ensureString(preg_replace($pattern, $replacement, $subject));
}
/** /**
* Select a range of cells. * Select a range of cells.
* *
@ -2725,9 +2619,9 @@ class Worksheet implements IComparable
public function setSelectedCells($coordinate) public function setSelectedCells($coordinate)
{ {
if (is_string($coordinate)) { if (is_string($coordinate)) {
$coordinate = $this->tryDefinedName($coordinate); $coordinate = Validations::definedNameToCoordinate($coordinate, $this);
} }
$coordinate = $this->validateCellOrCellRange($coordinate); $coordinate = Validations::validateCellOrCellRange($coordinate);
if (Coordinate::coordinateIsRange($coordinate)) { if (Coordinate::coordinateIsRange($coordinate)) {
[$first] = Coordinate::splitRange($coordinate); [$first] = Coordinate::splitRange($coordinate);