Merge pull request #14 from nswdpc/feat-ci-files

Automated updates

Author: JamesDPC

.gitattributes

@@ -4,7 +4,7 @@
 /.editorconfig              export-ignore
 /.gitattributes             export-ignore
 /.gitignore                 export-ignore
-/.php-cs-fixer.dist.php     export-ignore
+/.github                    export-ignore
 /phpunit.xml.dist           export-ignore
 /.waratah                   export-ignore
 /code-of-conduct.md         export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+name: CI
+
+on:
+  pull_request: null
+
+jobs:
+  Silverstripe:
+    name: 'Silverstripe (bundle)'
+    uses: nswdpc/ci-files/.github/workflows/silverstripe_53_83.yml@v-4
+  PHPStan:
+    name: 'PHPStan (analyse)'
+    uses: nswdpc/ci-files/.github/workflows/phpstan.silverstripe_83.yml@v-4
+    needs: Silverstripe

.gitignore

@@ -1,4 +1,6 @@
 /client/node_modules
 /vendor/
 .DS_Store
-/.php_cs.fixer.cache
+/.php-cs-fixer.cache
+/composer.lock
+/public/

.php-cs-fixer.dist.php

@@ -36,7 +36,21 @@
         "ezyang/htmlpurifier" : "^4.17"
     },
     "require-dev": {
+        "cambis/silverstripe-rector": "^2",
         "phpunit/phpunit": "^9.5",
-        "friendsofphp/php-cs-fixer": "^3"
+        "cambis/silverstan": "^2",
+        "nswdpc/ci-files": "dev-v-4",
+        "friendsofphp/php-cs-fixer": "^3",
+        "phpstan/phpstan": "^2",
+        "phpstan/phpstan-phpunit": "^2",
+        "rector/rector": "^2"
+    },
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true,
+            "silverstripe/vendor-plugin": true,
+            "silverstripe/recipe-plugin": true,
+            "phpstan/extension-installer": true
+        }
     }
 }

composer.json

@@ -2,30 +2,26 @@
 
 namespace NSWDPC\Utilities\Trumbowyg;
 
-use SilverStripe\Core\Convert;
-use SilverStripe\Forms\FormField;
 use SilverStripe\Forms\TextareaField;
 use SilverStripe\View\ArrayData;
 use SilverStripe\View\Requirements;
-use Exception;
-use DOMDocument;
 
-
-class TrumbowygEditorField extends TextareaField {
-
-    private static $casting = [
+class TrumbowygEditorField extends TextareaField
+{
+    private static array $casting = [
         'Value' => 'HTMLText',
     ];
 
-    private static $include_own_jquery = true;
+    private static bool $include_own_jquery = true;
 
     /**
      * Get field options
      * @return array
      */
-    protected function getFieldOptions() {
+    protected function getFieldOptions()
+    {
         $options = $this->config()->get('editor_options');
-        if( empty($options) || !is_array($options) ) {
+        if (empty($options) || !is_array($options)) {
             // Fallback options in case of none configured
             $options = [
                 "fixedBtnPane" => true,
@@ -49,15 +45,16 @@ protected function getFieldOptions() {
                 ]
             ];
         }
+
         $options['tagsToRemove'] = self::getDeniedTags();
         return $options;
     }
 
     /**
      * These tags are denied by default
-     * @return array
      */
-    public static function getDeniedTags() {
+    public static function getDeniedTags(): array
+    {
         return [
             'form',
             'script',
@@ -79,10 +76,12 @@ public static function getDeniedTags() {
     /**
      * Returns the field
      */
-    public function Field($properties = []) {
-        $this->setAttribute('data-tw','1');
+    #[\Override]
+    public function Field($properties = [])
+    {
+        $this->setAttribute('data-tw', '1');
 
-        if($this->config()->get('include_own_jquery')) {
+        if ($this->config()->get('include_own_jquery')) {
             Requirements::javascript(
                 "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js",
                 [
@@ -91,6 +90,7 @@ public function Field($properties = []) {
                 ]
             );
         }
+
         Requirements::javascript(
             "https://cdn.jsdelivr.net/npm/trumbowyg@2.31.0/dist/trumbowyg.min.js",
             [
@@ -101,7 +101,7 @@ public function Field($properties = []) {
         // import template with options
         $custom_script = ArrayData::create([
             'ID' => $this->ID(),
-            'Options' => json_encode( $this->getFieldOptions() )
+            'Options' => json_encode($this->getFieldOptions())
         ])->renderWith('NSWDPC/Utilities/Trumbowyg/Script');
         Requirements::customScript(
             $custom_script,
@@ -121,16 +121,24 @@ public function Field($properties = []) {
     /**
      * Return the value, sanitised
      */
-    public function Value() {
+    #[\Override]
+    public function Value()
+    {
         return $this->dataValue();
     }
 
     /**
      * Return cleaned data value
      */
-    public function dataValue() {
-        $sanitiser = new ContentSanitiser();
-        $this->value = $sanitiser->clean($this->value);
+    #[\Override]
+    public function dataValue()
+    {
+        $value = $this->value;
+        if (!is_string($value)) {
+            $value = "";
+        }
+
+        $this->value = ContentSanitiser::clean($value);
         return $this->value;
     }
 

src/Fields/TrumbowygEditorField.php

@@ -3,57 +3,58 @@
 namespace NSWDPC\Utilities\Trumbowyg;
 
 use SilverStripe\Assets\Filesystem;
-use Silverstripe\Core\Config\Configurable;
-use Silverstripe\Core\Config\Config;
-use Silverstripe\ORM\ValidationException;
+use SilverStripe\Core\Config\Configurable;
+use SilverStripe\Core\Config\Config;
 
 /**
  * Sanitise content provided by a trumbowyg field
- * @author James <james@dcs>
+ * @author James
  */
-class ContentSanitiser {
-
+class ContentSanitiser
+{
     use Configurable;
 
     /**
      * @var string
      * default allowed tags, if none are specified in configuration
      */
-    private static $default_allowed_html_tags = "<p><i><blockquote>"
+    private static string $default_allowed_html_tags = "<p><i><blockquote>"
         . "<b><strong><em><br>"
         . "<h2><h3><h4><h5><h6>"
         . "<ol><ul><li><a><strike>";
 
     /**
      * Return tags suitable for strip_tags
-     * @return string
      */
-    public static function getAllowedHTMLTags() : string {
+    public static function getAllowedHTMLTags(): string
+    {
         $allowedHTMLTags = Config::inst()->get(self::class, 'default_allowed_html_tags');
-        if($allowedHTMLTags == "") {
+        if ($allowedHTMLTags == "") {
             $allowedHTMLTags = "<p>";// disallow all
         }
+
         return $allowedHTMLTags;
     }
 
     /**
      * Return tags suitable for strip_tags
-     * @return array
      */
-    public static function getAllowedHTMLTagsAsArray() : array {
+    public static function getAllowedHTMLTagsAsArray(): array
+    {
         $allowedHTMLTags = trim(self::getAllowedHTMLTags(), "<>");
         return explode("><", $allowedHTMLTags);
     }
 
     /**
      * Generate a strict configuration for handling incoming user content
-     * @return array
      */
-    public static function generateConfig() : array {
+    public static function generateConfig(): array
+    {
         $serializerPath = TEMP_PATH . "/HtmlPurifier/Serializer";
-        if(!is_dir($serializerPath)) {
+        if (!is_dir($serializerPath)) {
             Filesystem::makeFolder($serializerPath);
         }
+
         return [
             'Core.Encoding' => 'UTF-8',
             'HTML.AllowedElements' => self::getAllowedHTMLTagsAsArray(),
@@ -70,26 +71,25 @@ public static function generateConfig() : array {
     /**
      * Clean dirty HTML using HTML purifier
      * If the purification fails in any way, an entitised version of the HTML is returned
-     * @param string $html
-     * @return string
      */
-    public static function clean($dirtyHtml) : string {
+    public static function clean(string $dirtyHtml): string
+    {
         try {
             $htmlPurifierConfig = \HTMLPurifier_Config::createDefault();
             $configuration = self::generateConfig();
             foreach ($configuration as $key => $value) {
                 $htmlPurifierConfig->set($key, $value);
             }
+
             $purifier = new \HTMLPurifier($htmlPurifierConfig);
             $cleaned = $purifier->purify($dirtyHtml);
-            if(trim(strip_tags($cleaned ?? '')) === '') {
+            if (trim(strip_tags($cleaned ?? '')) === '') {
                 return '';
             } else {
-                return $cleaned;
+                return trim($cleaned);
             }
-            return $cleaned;
-        } catch (\Exception $e) {
-            return htmlentities($dirtyHtml, ENT_QUOTES|ENT_HTML5, "UTF-8");
+        } catch (\Exception) {
+            return htmlentities($dirtyHtml, ENT_QUOTES | ENT_HTML5, "UTF-8");
         }
     }
 }