<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

use PhpOffice\PhpSpreadsheet\Shared\PasswordHasher;

class Protection
{
    const ALGORITHM_MD2 = 'MD2';
    const ALGORITHM_MD4 = 'MD4';
    const ALGORITHM_MD5 = 'MD5';
    const ALGORITHM_SHA_1 = 'SHA-1';
    const ALGORITHM_SHA_256 = 'SHA-256';
    const ALGORITHM_SHA_384 = 'SHA-384';
    const ALGORITHM_SHA_512 = 'SHA-512';
    const ALGORITHM_RIPEMD_128 = 'RIPEMD-128';
    const ALGORITHM_RIPEMD_160 = 'RIPEMD-160';
    const ALGORITHM_WHIRLPOOL = 'WHIRLPOOL';

    /**
     * Autofilters are locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $autoFilter;

    /**
     * Deleting columns is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $deleteColumns;

    /**
     * Deleting rows is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $deleteRows;

    /**
     * Formatting cells is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $formatCells;

    /**
     * Formatting columns is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $formatColumns;

    /**
     * Formatting rows is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $formatRows;

    /**
     * Inserting columns is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $insertColumns;

    /**
     * Inserting hyperlinks is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $insertHyperlinks;

    /**
     * Inserting rows is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $insertRows;

    /**
     * Objects are locked when sheet is protected, default false.
     *
     * @var ?bool
     */
    private $objects;

    /**
     * Pivot tables are locked when the sheet is protected, default true.
     *
     * @var ?bool
     */
    private $pivotTables;

    /**
     * Scenarios are locked when sheet is protected, default false.
     *
     * @var ?bool
     */
    private $scenarios;

    /**
     * Selection of locked cells is locked when sheet is protected, default false.
     *
     * @var ?bool
     */
    private $selectLockedCells;

    /**
     * Selection of unlocked cells is locked when sheet is protected, default false.
     *
     * @var ?bool
     */
    private $selectUnlockedCells;

    /**
     * Sheet is locked when sheet is protected, default false.
     *
     * @var ?bool
     */
    private $sheet;

    /**
     * Sorting is locked when sheet is protected, default true.
     *
     * @var ?bool
     */
    private $sort;

    /**
     * Hashed password.
     *
     * @var string
     */
    private $password = '';

    /**
     * Algorithm name.
     *
     * @var string
     */
    private $algorithm = '';

    /**
     * Salt value.
     *
     * @var string
     */
    private $salt = '';

    /**
     * Spin count.
     *
     * @var int
     */
    private $spinCount = 10000;

    /**
     * Create a new Protection.
     */
    public function __construct()
    {
    }

    /**
     * Is some sort of protection enabled?
     */
    public function isProtectionEnabled(): bool
    {
        return
            $this->password !== '' ||
            isset($this->sheet) ||
            isset($this->objects) ||
            isset($this->scenarios) ||
            isset($this->formatCells) ||
            isset($this->formatColumns) ||
            isset($this->formatRows) ||
            isset($this->insertColumns) ||
            isset($this->insertRows) ||
            isset($this->insertHyperlinks) ||
            isset($this->deleteColumns) ||
            isset($this->deleteRows) ||
            isset($this->selectLockedCells) ||
            isset($this->sort) ||
            isset($this->autoFilter) ||
            isset($this->pivotTables) ||
            isset($this->selectUnlockedCells);
    }

    public function getSheet(): ?bool
    {
        return $this->sheet;
    }

    public function setSheet(?bool $sheet): self
    {
        $this->sheet = $sheet;

        return $this;
    }

    public function getObjects(): ?bool
    {
        return $this->objects;
    }

    public function setObjects(?bool $objects): self
    {
        $this->objects = $objects;

        return $this;
    }

    public function getScenarios(): ?bool
    {
        return $this->scenarios;
    }

    public function setScenarios(?bool $scenarios): self
    {
        $this->scenarios = $scenarios;

        return $this;
    }

    public function getFormatCells(): ?bool
    {
        return $this->formatCells;
    }

    public function setFormatCells(?bool $formatCells): self
    {
        $this->formatCells = $formatCells;

        return $this;
    }

    public function getFormatColumns(): ?bool
    {
        return $this->formatColumns;
    }

    public function setFormatColumns(?bool $formatColumns): self
    {
        $this->formatColumns = $formatColumns;

        return $this;
    }

    public function getFormatRows(): ?bool
    {
        return $this->formatRows;
    }

    public function setFormatRows(?bool $formatRows): self
    {
        $this->formatRows = $formatRows;

        return $this;
    }

    public function getInsertColumns(): ?bool
    {
        return $this->insertColumns;
    }

    public function setInsertColumns(?bool $insertColumns): self
    {
        $this->insertColumns = $insertColumns;

        return $this;
    }

    public function getInsertRows(): ?bool
    {
        return $this->insertRows;
    }

    public function setInsertRows(?bool $insertRows): self
    {
        $this->insertRows = $insertRows;

        return $this;
    }

    public function getInsertHyperlinks(): ?bool
    {
        return $this->insertHyperlinks;
    }

    public function setInsertHyperlinks(?bool $insertHyperLinks): self
    {
        $this->insertHyperlinks = $insertHyperLinks;

        return $this;
    }

    public function getDeleteColumns(): ?bool
    {
        return $this->deleteColumns;
    }

    public function setDeleteColumns(?bool $deleteColumns): self
    {
        $this->deleteColumns = $deleteColumns;

        return $this;
    }

    public function getDeleteRows(): ?bool
    {
        return $this->deleteRows;
    }

    public function setDeleteRows(?bool $deleteRows): self
    {
        $this->deleteRows = $deleteRows;

        return $this;
    }

    public function getSelectLockedCells(): ?bool
    {
        return $this->selectLockedCells;
    }

    public function setSelectLockedCells(?bool $selectLockedCells): self
    {
        $this->selectLockedCells = $selectLockedCells;

        return $this;
    }

    public function getSort(): ?bool
    {
        return $this->sort;
    }

    public function setSort(?bool $sort): self
    {
        $this->sort = $sort;

        return $this;
    }

    public function getAutoFilter(): ?bool
    {
        return $this->autoFilter;
    }

    public function setAutoFilter(?bool $autoFilter): self
    {
        $this->autoFilter = $autoFilter;

        return $this;
    }

    public function getPivotTables(): ?bool
    {
        return $this->pivotTables;
    }

    public function setPivotTables(?bool $pivotTables): self
    {
        $this->pivotTables = $pivotTables;

        return $this;
    }

    public function getSelectUnlockedCells(): ?bool
    {
        return $this->selectUnlockedCells;
    }

    public function setSelectUnlockedCells(?bool $selectUnlockedCells): self
    {
        $this->selectUnlockedCells = $selectUnlockedCells;

        return $this;
    }

    /**
     * Get hashed password.
     *
     * @return string
     */
    public function getPassword()
    {
        return $this->password;
    }

    /**
     * Set Password.
     *
     * @param string $password
     * @param bool $alreadyHashed If the password has already been hashed, set this to true
     *
     * @return $this
     */
    public function setPassword($password, $alreadyHashed = false)
    {
        if (!$alreadyHashed) {
            $salt = $this->generateSalt();
            $this->setSalt($salt);
            $password = PasswordHasher::hashPassword($password, $this->getAlgorithm(), $this->getSalt(), $this->getSpinCount());
        }

        $this->password = $password;

        return $this;
    }

    public function setHashValue(string $password): self
    {
        return $this->setPassword($password, true);
    }

    /**
     * Create a pseudorandom string.
     */
    private function generateSalt(): string
    {
        return base64_encode(random_bytes(16));
    }

    /**
     * Get algorithm name.
     */
    public function getAlgorithm(): string
    {
        return $this->algorithm;
    }

    /**
     * Set algorithm name.
     */
    public function setAlgorithm(string $algorithm): self
    {
        return $this->setAlgorithmName($algorithm);
    }

    /**
     * Set algorithm name.
     */
    public function setAlgorithmName(string $algorithm): self
    {
        $this->algorithm = $algorithm;

        return $this;
    }

    public function getSalt(): string
    {
        return $this->salt;
    }

    public function setSalt(string $salt): self
    {
        return $this->setSaltValue($salt);
    }

    public function setSaltValue(string $salt): self
    {
        $this->salt = $salt;

        return $this;
    }

    /**
     * Get spin count.
     */
    public function getSpinCount(): int
    {
        return $this->spinCount;
    }

    /**
     * Set spin count.
     */
    public function setSpinCount(int $spinCount): self
    {
        $this->spinCount = $spinCount;

        return $this;
    }

    /**
     * Verify that the given non-hashed password can "unlock" the protection.
     */
    public function verify(string $password): bool
    {
        if ($this->password === '') {
            return true;
        }

        $hash = PasswordHasher::hashPassword($password, $this->getAlgorithm(), $this->getSalt(), $this->getSpinCount());

        return $this->getPassword() === $hash;
    }

    /**
     * Implement PHP __clone to create a deep clone, not just a shallow copy.
     */
    public function __clone()
    {
        $vars = get_object_vars($this);
        foreach ($vars as $key => $value) {
            if (is_object($value)) {
                $this->$key = clone $value;
            } else {
                $this->$key = $value;
            }
        }
    }
}

• [D] AutoFilter
• [D] Drawing
• [D] Table
• [F] AutoFilter.php
  Delete
• [F] AutoFit.php
  Delete
• [F] BaseDrawing.php
  Delete
• [F] CellIterator.php
  Delete
• [F] Column.php
  Delete
• [F] ColumnCellIterator.php
  Delete
• [F] ColumnDimension.php
  Delete
• [F] ColumnIterator.php
  Delete
• [F] Dimension.php
  Delete
• [F] Drawing.php
  Delete
• [F] HeaderFooter.php
  Delete
• [F] HeaderFooterDrawing.php
  Delete
• [F] Iterator.php
  Delete
• [F] MemoryDrawing.php
  Delete
• [F] PageBreak.php
  Delete
• [F] PageMargins.php
  Delete
• [F] PageSetup.php
  Delete
• [F] Protection.php
  Delete
• [F] Row.php
  Delete
• [F] RowCellIterator.php
  Delete
• [F] RowDimension.php
  Delete
• [F] RowIterator.php
  Delete
• [F] SheetView.php
  Delete
• [F] Table.php
  Delete
• [F] Validations.php
  Delete
• [F] Worksheet.php
  Delete

Developer

• Support

Back to Home page