AC-9098:Ability to use Adobe copyright for Adobe Commerce source code for Magento Open Source (CE)-Validation

Author: jayrangnani-gl

Magento2Framework/Sniffs/Header/CopyrightAnotherExtensionsFilesSniff.php

@@ -12,12 +12,9 @@
 
 class CopyrightAnotherExtensionsFilesSniff implements Sniff
 {
+    use CopyrightValidation;
     private const WARNING_CODE = 'FoundCopyrightMissingOrWrongFormat';
 
-    private const COPYRIGHT_MAGENTO_TEXT = 'Copyright © Magento, Inc. All rights reserved.';
-    private const COPYRIGHT_ADOBE = '/Copyright \d+ Adobe/';
-    private const COPYRIGHT_ADOBE_TEXT = 'ADOBE CONFIDENTIAL';
-
     /**
      * Defines the tokenizers that this sniff is using.
      *
@@ -45,19 +42,15 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
-        $fileText = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+      // @phpcs:ignore Magento2.Functions.DiscouragedFunction.Discouraged
+        $content = file_get_contents($phpcsFile->getFilename());
 
-        if (strpos($fileText, self::COPYRIGHT_MAGENTO_TEXT) !== false
-            || preg_match(self::COPYRIGHT_ADOBE, $fileText)
-                || strpos($fileText, self::COPYRIGHT_ADOBE_TEXT) !== false
-        ) {
-            return;
+        if ($this->isCopyrightYearValid($content) === false) {
+            $phpcsFile->addWarningOnLine(
+                'Copyright is missing or has wrong format',
+                null,
+                self::WARNING_CODE
+            );
         }
-
-        $phpcsFile->addWarningOnLine(
-            'Copyright is missing or has wrong format',
-            null,
-            self::WARNING_CODE
-        );
     }
 }

Magento2Framework/Sniffs/Header/CopyrightGraphQLSniff.php

@@ -12,12 +12,9 @@
 
 class CopyrightGraphQLSniff implements Sniff
 {
+    use CopyrightValidation;
     private const WARNING_CODE = 'FoundCopyrightMissingOrWrongFormat';
 
-    private const COPYRIGHT_MAGENTO_TEXT = 'Copyright © Magento, Inc. All rights reserved.';
-    private const COPYRIGHT_ADOBE = '/Copyright \d+ Adobe/';
-    private const COPYRIGHT_ADOBE_TEXT = 'ADOBE CONFIDENTIAL';
-
     private const FILE_EXTENSION = 'graphqls';
 
     /**
@@ -45,16 +42,12 @@ public function process(File $phpcsFile, $stackPtr)
         // @phpcs:ignore Magento2.Functions.DiscouragedFunction.Discouraged
         $content = file_get_contents($phpcsFile->getFilename());
 
-        if (strpos($content, self::COPYRIGHT_MAGENTO_TEXT) !== false
-            || preg_match(self::COPYRIGHT_ADOBE, $content)
-                || strpos($content, self::COPYRIGHT_ADOBE_TEXT) !== false) {
-            return;
+        if ($this->isCopyrightYearValid($content) === false) {
+            $phpcsFile->addWarningOnLine(
+                'Copyright is missing or has wrong format',
+                null,
+                self::WARNING_CODE
+            );
         }
-
-        $phpcsFile->addWarningOnLine(
-            'Copyright is missing or has wrong format',
-            null,
-            self::WARNING_CODE
-        );
     }
 }

Magento2Framework/Sniffs/Header/CopyrightSniff.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2021 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types = 1);
 
@@ -12,11 +12,9 @@
 
 class CopyrightSniff implements Sniff
 {
-    private const WARNING_CODE = 'FoundCopyrightMissingOrWrongFormat';
+    use CopyrightValidation;
 
-    private const COPYRIGHT_MAGENTO_TEXT = 'Copyright © Magento, Inc. All rights reserved.';
-    private const COPYRIGHT_ADOBE = '/Copyright \d+ Adobe/';
-    private const COPYRIGHT_ADOBE_TEXT = 'ADOBE CONFIDENTIAL';
+    private const WARNING_CODE = 'FoundCopyrightMissingOrWrongFormat';
 
     /**
      * @inheritdoc
@@ -46,19 +44,15 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
-        $content = $phpcsFile->getTokens()[$positionComment]['content'];
-        $adobeCopyrightFound = preg_match(self::COPYRIGHT_ADOBE, $content);
+        // @phpcs:ignore Magento2.Functions.DiscouragedFunction.Discouraged
+        $content = file_get_contents($phpcsFile->getFilename());
 
-        if (strpos($content, self::COPYRIGHT_MAGENTO_TEXT) !== false ||
-                $adobeCopyrightFound ||
-                    strpos($content, self::COPYRIGHT_ADOBE_TEXT) !== false) {
-            return;
+        if ($this->isCopyrightYearValid($content) === false) {
+            $phpcsFile->addWarningOnLine(
+                'Copyright is missing or has wrong format',
+                null,
+                self::WARNING_CODE
+            );
         }
-
-        $phpcsFile->addWarningOnLine(
-            'Copyright is missing or has wrong format',
-            $phpcsFile->getTokens()[$positionComment]['line'],
-            self::WARNING_CODE
-        );
     }
 }

Magento2Framework/Sniffs/Header/CopyrightValidation.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ */
+declare(strict_types = 1);
+
+namespace Magento2Framework\Sniffs\Header;
+
+trait CopyrightValidation
+{
+
+  /**
+   * Check is copyright year valid or not
+   *
+   * @param string $content
+   * @return bool
+   */
+    private function isCopyrightYearValid(string $content): bool
+    {
+        $pattern = '/Copyright (\d{4}) Adobe/';
+        if (preg_match($pattern, $content, $matches)) {
+            $year = (int) $matches[1];
+            if ($year >= 2010 && $year <= date("Y")) {
+                return true;
+            } else {
+                return false;
+            }
+        } else {
+            return false;
+        }
+    }
+}

Magento2Framework/Tests/Header/CopyrightAnotherExtensionsFilesUnitTest.4.js

@@ -1,6 +1,6 @@
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2021 Adobe
+ * All Rights Reserved.
  */
 
 define([

Magento2Framework/Tests/Header/CopyrightGraphQLUnitTest.1.graphqls

@@ -1,5 +1,5 @@
-# Copyright © Magento, Inc. All rights reserved.
-# See COPYING.txt for license details.
+# Copyright 2021 Adobe
+# All Rights Reserved.
 
 enum PriceAdjustmentCodesEnum {
     WEEE @deprecated(reason: "WEEE code is deprecated, use fixed_product_taxes.label")

Magento2Framework/Tests/Header/CopyrightGraphQLUnitTest.2.graphqls

@@ -1,5 +1,5 @@
 # Copyright 2020 Adobe
-# See COPYING.txt for license details.
+# All Rights Reserved.
 
 enum PriceAdjustmentCodesEnum {
     WEEE @deprecated(reason: "WEEE code is deprecated, use fixed_product_taxes.label")

Magento2Framework/Tests/Header/CopyrightGraphQLUnitTest.php

@@ -9,28 +9,28 @@
 
 class CopyrightGraphQLUnitTest extends AbstractGraphQLSniffUnitTestCase
 {
-    /**
-     * @inheritdoc
-     */
+  /**
+   * @inheritdoc
+   */
     public function getErrorList(): array
     {
         return [];
     }
 
-    /**
-     * @inheritdoc
-     */
+  /**
+   * @inheritdoc
+   */
     public function getWarningList($testFile = ''): array
     {
         if ($testFile === 'CopyrightGraphQLUnitTest.1.graphqls' ||
-            $testFile === 'CopyrightGraphQLUnitTest.2.graphqls') {
+        $testFile === 'CopyrightGraphQLUnitTest.2.graphqls') {
             return [];
         }
 
         if ($testFile === 'CopyrightGraphQLUnitTest.3.graphqls' ||
-            $testFile === 'CopyrightGraphQLUnitTest.4.graphqls') {
+        $testFile === 'CopyrightGraphQLUnitTest.4.graphqls') {
             return [
-                null => 1
+            null => 1
             ];
         }
 

Magento2Framework/Tests/Header/CopyrightUnitTest.4.inc

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2021 Adobe
+ * All Rights Reserved.
  */
 
 

Magento2Framework/Tests/Header/CopyrightUnitTest.php

@@ -31,9 +31,10 @@ public function getWarningList($testFile = ''): array
                 1 => 1,
             ];
         }
+
         if ($testFile === 'CopyrightUnitTest.2.inc' || $testFile === 'CopyrightUnitTest.3.inc') {
             return [
-                3 => 1,
+                null => 1,
             ];
         }