feat(copyright): SPDX copyright detection added

[rohitpandey49]

Signed-off-by: Rohit Pandey rohit.pandey4900@gmail.com

Description

As discussed in issue #1592 , implements a part of the REUSE.Software specification, by detecting the SPDX-FileCopyrightText keyword from .license suffixed files, and applying the copyright detected by the Copyright agent to the associated file.

Changes

1. New regex added to identify SPDX copyright statement.
2. Applied copyright detected in .license file to the associated file.

How to test

1. Start new upload - you may want to use example package available here: https://github.com/fossology/fossology/wiki/ReSo-%28REUSE.Software%29#testing
2. Select REUSE.Software Analysis and Copyright option.
   
3. Start Upload
4. Check the copyright applied to associated file of .license file.

[GMishx]

@rohitpandey49 Indeed there are empty space at the end of line in src/reso/agent/ResoAgent.php but on line 199 and 208

[GMishx]

Additional note @rohitpandey49 , please check if the copyright table does not already have entry for the given set of agent_fk, pfile_fk and hash otherwise it will cause duplicate entries for copyright if same file is scanned multiple times.

[rohitpandey49]

@GMishx Sir please check.

[github-actions]

This pull request has conflicts, please rebase with master to resolve those before we can evaluate the pull request.

[shaheemazmalmmd]

@rohitpandey49 : please rebase the branch with master and resolve the conflicts.

[GMishx]

@rohitpandey49 , changes looks good to me. Please add following changes to the code as well.

1. The change in CopyrightDao.php is a boolean logic fix (invert AND with OR and vice-versa if the condition is changed). This also fixes the test case.
2. The change in ResoAgentPlugin.php allows reso to add copyright agent as a dependency if user has selected it.

diff --git a/src/lib/php/Dao/CopyrightDao.php b/src/lib/php/Dao/CopyrightDao.php
index 95390cf2f..c833de25f 100644
--- a/src/lib/php/Dao/CopyrightDao.php
+++ b/src/lib/php/Dao/CopyrightDao.php
@@ -61,7 +61,7 @@ class CopyrightDao
     $statementName = __METHOD__.$tableName;
     $params = array($pFileId);
     $addAgentValue = "";
-    if (!empty($agentId) || $agentId[0] != 0) {
+    if (!empty($agentId) && $agentId[0] != 0) {
       $agentIds = implode(",", $agentId);
       $statementName .= '.agentId';
       $addAgentValue = ' AND agent_fk= ANY($2::int[])';
diff --git a/src/reso/ui/ResoAgentPlugin.php b/src/reso/ui/ResoAgentPlugin.php
index 1b44d6b21..31a12fa04 100644
--- a/src/reso/ui/ResoAgentPlugin.php
+++ b/src/reso/ui/ResoAgentPlugin.php
@@ -38,7 +38,12 @@ class ResoAgentPlugin extends AgentPlugin
    */
   public function AgentAdd($jobId, $uploadId, &$errorMsg, $dependencies=array(), $arguments=null)
   {
+    $copyrightAgentScheduled = GetParm("Check_agent_copyright",
+        PARM_INTEGER) == 1;
     $dependencies[] = "ojo";
+    if ($copyrightAgentScheduled) {
+      $dependencies[] = "copyright";
+    }
     if ($this->AgentHasResults($uploadId) == 1) {
       return 0;
     }

[rohitpandey49]

@GMishx Sir, updated. Please check.

[GMishx]

Sorry @rohitpandey49 , I messed the dependency check. Can you please modify it like following? We can merge the PR after that.

diff --git a/src/reso/ui/ResoAgentPlugin.php b/src/reso/ui/ResoAgentPlugin.php
index 279d6202b..714a3b809 100644
--- a/src/reso/ui/ResoAgentPlugin.php
+++ b/src/reso/ui/ResoAgentPlugin.php
@@ -39,9 +39,9 @@ class ResoAgentPlugin extends AgentPlugin
   public function AgentAdd($jobId, $uploadId, &$errorMsg, $dependencies=array(), $arguments=null)
   {
     $copyrightAgentScheduled = GetParm("Check_agent_copyright", PARM_INTEGER) == 1;
-    $dependencies[] = "ojo";
+    $dependencies[] = "agent_ojo";
     if ($copyrightAgentScheduled) {
-      $dependencies[] = "copyright";
+      $dependencies[] = "agent_copyright";
     }
     if ($this->AgentHasResults($uploadId) == 1) {
       return 0;
@@ -52,7 +52,7 @@ class ResoAgentPlugin extends AgentPlugin
       return $jobQueueId;
     }
 
-    return $this->doAgentAdd($jobId, $uploadId, $errorMsg, array("agent_ojo"),$uploadId);
+    return $this->doAgentAdd($jobId, $uploadId, $errorMsg, $dependencies, $uploadId);
   }
 
   /**

[rohitpandey49]

@GMishx Sir updated. Please check.

[GMishx]

Changes looks good. Tested, working as expected.