Merge pull request #1019 from jun-i-corn/feature/EnablePasswordProtection

enable password protection (Word)

Author: troosan

composer.json

@@ -34,6 +34,17 @@
             "name": "Antoine de Troostembergh"
         }
     ],
+    "scripts": {
+        "check": [
+            "./vendor/bin/php-cs-fixer fix --ansi --dry-run --diff",
+            "./vendor/bin/phpcs --report-width=200 --report-summary  --report-full samples/ src/ tests/ --ignore=src/PhpWord/Shared/PCLZip --standard=PSR2 -n",
+            "./vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist --exclude pclzip.lib.php",
+            "./vendor/bin/phpunit --color=always"
+        ],
+        "fix": [
+            "./vendor/bin/php-cs-fixer fix --ansi"
+        ]
+    },
     "require": {
         "php": ">=5.3.3",
         "ext-xml": "*",

docs/general.rst

@@ -272,6 +272,17 @@ points to twips.
     // 2 cm right margin
     $sectionStyle->setMarginRight(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(2));
 
+Document protection
+-------------------
+
+The document (or parts of it) can be password protected.
+
+.. code-block:: php
+
+    $documentProtection = $phpWord->getSettings()->getDocumentProtection();
+    $documentProtection->setEditing(DocProtect::READ_ONLY);
+    $documentProtection->setPassword('myPassword');
+
 Automatically Recalculate Fields on Open
 ----------------------------------------
 

samples/Sample_38_Protection.php

@@ -0,0 +1,21 @@
+<?php
+use PhpOffice\PhpWord\SimpleType\DocProtect;
+
+include_once 'Sample_Header.php';
+
+// New Word Document
+echo date('H:i:s') , ' Create new PhpWord object' , EOL;
+$phpWord = new \PhpOffice\PhpWord\PhpWord();
+
+$documentProtection = $phpWord->getSettings()->getDocumentProtection();
+$documentProtection->setEditing(DocProtect::READ_ONLY);
+$documentProtection->setPassword('myPassword');
+
+$section = $phpWord->addSection();
+$section->addText('this document is password protected');
+
+// Save file
+echo write($phpWord, basename(__FILE__, '.php'), $writers);
+if (!CLI) {
+    include_once 'Sample_Footer.php';
+}

src/PhpWord/Metadata/Protection.php

@@ -17,31 +17,63 @@
 
 namespace PhpOffice\PhpWord\Metadata;
 
+use PhpOffice\PhpWord\Shared\Microsoft\PasswordEncoder;
+use PhpOffice\PhpWord\SimpleType\DocProtect;
+
 /**
  * Document protection class
  *
  * @since 0.12.0
- * @see  http://www.datypic.com/sc/ooxml/t-w_CT_DocProtect.html
- * @todo Password!
+ * @see http://www.datypic.com/sc/ooxml/t-w_CT_DocProtect.html
  */
 class Protection
 {
     /**
-     * Editing restriction readOnly|comments|trackedChanges|forms
+     * Editing restriction none|readOnly|comments|trackedChanges|forms
      *
      * @var string
      * @see  http://www.datypic.com/sc/ooxml/a-w_edit-1.html
      */
     private $editing;
 
+    /**
+     * password
+     *
+     * @var string
+     */
+    private $password;
+
+    /**
+     * Iterations to Run Hashing Algorithm
+     *
+     * @var int
+     */
+    private $spinCount = 100000;
+
+    /**
+     * Cryptographic Hashing Algorithm (see constants defined in \PhpOffice\PhpWord\Shared\Microsoft\PasswordEncoder)
+     *
+     * @var string
+     */
+    private $algorithm = PasswordEncoder::ALGORITHM_SHA_1;
+
+    /**
+     * Salt for Password Verifier
+     *
+     * @var string
+     */
+    private $salt;
+
     /**
      * Create a new instance
      *
      * @param string $editing
      */
     public function __construct($editing = null)
     {
-        $this->setEditing($editing);
+        if ($editing != null) {
+            $this->setEditing($editing);
+        }
     }
 
     /**
@@ -57,13 +89,111 @@ public function getEditing()
     /**
      * Set editing protection
      *
-     * @param string $editing
+     * @param string $editing Any value of \PhpOffice\PhpWord\SimpleType\DocProtect
      * @return self
      */
     public function setEditing($editing = null)
     {
+        DocProtect::validate($editing);
         $this->editing = $editing;
 
         return $this;
     }
+
+    /**
+     * Get password
+     *
+     * @return string
+     */
+    public function getPassword()
+    {
+        return $this->password;
+    }
+
+    /**
+     * Set password
+     *
+     * @param $password
+     * @return self
+     */
+    public function setPassword($password)
+    {
+        $this->password = $password;
+
+        return $this;
+    }
+
+    /**
+     * Get count for hash iterations
+     *
+     * @return int
+     */
+    public function getSpinCount()
+    {
+        return $this->spinCount;
+    }
+
+    /**
+     * Set count for hash iterations
+     *
+     * @param $spinCount
+     * @return self
+     */
+    public function setSpinCount($spinCount)
+    {
+        $this->spinCount = $spinCount;
+
+        return $this;
+    }
+
+    /**
+     * Get algorithm
+     *
+     * @return string
+     */
+    public function getAlgorithm()
+    {
+        return $this->algorithm;
+    }
+
+    /**
+     * Set algorithm
+     *
+     * @param $algorithm
+     * @return self
+     */
+    public function setAlgorithm($algorithm)
+    {
+        $this->algorithm = $algorithm;
+
+        return $this;
+    }
+
+    /**
+     * Get salt
+     *
+     * @return string
+     */
+    public function getSalt()
+    {
+        return $this->salt;
+    }
+
+    /**
+     * Set salt. Salt HAS to be 16 characters, or an exception will be thrown.
+     *
+     * @param $salt
+     * @throws \InvalidArgumentException
+     * @return self
+     */
+    public function setSalt($salt)
+    {
+        if ($salt !== null && strlen($salt) !== 16) {
+            throw new \InvalidArgumentException('salt has to be of exactly 16 bytes length');
+        }
+
+        $this->salt = $salt;
+
+        return $this;
+    }
 }