Feature/reserve identifier with new issue url (#118)

Closes #99,
closes #62,
closes #53,
closes #104,
closes #55,
closes #101,
closes #125 

This PR is a massive one, but needed as most of the functionality is
based upon each other, although there are a number of features addressed
here.

Features that come with this PR:
- Reserving identifiers with a GitHub New Issue URL Link
- Linking manually created GtiHub Issue to the Certificate Identifier in
OJS Submission
- Update the information in the GitHub Issue (on metadata form save)
- Delete concept of Venue Type & Venue Name as Labels (instead all
labels in one central Dropdown)
- Labels are cached / saved in the OJS DB (and only fetched from the
API, when they are older than 6 hours)
- Connection to the GitHub Register Issue is shown in the CODECHECK Form
Sidebar panel
  
- - -

❗ I want to include a setting in the settings form for a feature which
is only introduced with this PR here (#101).

Author: nuest

.github/workflows/tests.yml

@@ -244,7 +244,7 @@ jobs:
 
       - name: Configure Apache for OJS
         run: |
-          sudo add-apt-repository --remove ppa:ondrej/php -y || true
+          sudo add-apt-repository ppa:ondrej/php -y
           sudo apt-get update
           sudo apt-get install -y apache2 libapache2-mod-php8.2
           sudo a2enmod rewrite php8.2 alias

CodecheckPlugin.php

@@ -21,6 +21,7 @@
 use APP\plugins\generic\codecheck\controllers\page\CodecheckPageHandler;
 use APP\plugins\generic\codecheck\classes\CodecheckRoles\CodecheckRoleArray;
 use APP\plugins\generic\codecheck\classes\CodecheckRoles\CodecheckRoleManager;
+use APP\core\Request;
 
 class CodecheckPlugin extends GenericPlugin
 {
@@ -408,11 +409,13 @@ public function manage($args, $request): JSONMessage
 
     public function setEnabled($enabled, $contextId = null)
     {
+        CodecheckLogger::debug("Plugin Enabled!");
         $result = parent::setEnabled($enabled, $contextId);
 
         if ($enabled) {
-            $this->migration = new CodecheckSchemaMigration();
-            $this->migration->up();
+            $migration = new CodecheckSchemaMigration();
+            $migration->up();
+            $migration->issueLabelsUp();
         }
 
         return $result;
@@ -423,6 +426,8 @@ public function resetSchema(): void
         $this->migration = new CodecheckSchemaMigration();
         $this->migration->down();
         $this->migration->up();
+        $this->migration->issueLabelsDown();
+        $this->migration->issueLabelsUp();
     }
 }
 

api/v1/CodecheckApiHandler.php

@@ -4,23 +4,23 @@
 
 use APP\plugins\generic\codecheck\classes\Exceptions\ApiFetchException;
 use APP\plugins\generic\codecheck\classes\Exceptions\NoMatchingIssuesFoundException;
-use APP\plugins\generic\codecheck\classes\DataStructures\UniqueArray;
+use APP\plugins\generic\codecheck\classes\DataStructures\UniqueIdentifierArray;
 use APP\plugins\generic\codecheck\classes\CodecheckRegister\CodecheckGithubRegisterApiClient;
 use APP\plugins\generic\codecheck\classes\CodecheckRegister\CertificateIdentifier;
 use APP\plugins\generic\codecheck\classes\Log\CodecheckLogger;
 
 class CertificateIdentifierList
 {
-    private UniqueArray $uniqueArray;
+    private UniqueIdentifierArray $uniqueIdentifierArray;
 
     /**
-     * This initializes a new Certificate Identifier List with a new `UniqueArray`
+     * This initializes a new Certificate Identifier List with a new `uniqueIdentifierArray`
      * 
      * @return void
      */
     function __construct()
     {
-        $this->uniqueArray = new UniqueArray();   
+        $this->uniqueIdentifierArray = new UniqueIdentifierArray();   
     }
 
     /**
@@ -30,22 +30,60 @@ function __construct()
      * @return CertificateIdentifierList Returns a new List containing all fetched Certificate Identifiers from GitHub
      */
     static function fromApi(
-        CodecheckGithubRegisterApiClient $codecheckGithubRegisterApiClient
+        CodecheckGithubRegisterApiClient $codecheckGithubRegisterApiClient,
+        ?bool $onlyNewestIdentifiers
     ): CertificateIdentifierList {
         $newCertificateIdentifierList = new CertificateIdentifierList();
 
         // fetch API
         try {
-            $codecheckGithubRegisterApiClient->fetchIssues();
-        } catch (ApiFetchException $ae) {
-            CodecheckLogger::error($ae->getMessage());
-            throw $ae;
-        } catch (NoMatchingIssuesFoundException $me) {
-            CodecheckLogger::error($me->getMessage());
-            throw $me;
+            if($onlyNewestIdentifiers == true) {
+                $codecheckGithubRegisterApiClient->fetchNewestIssues();
+            } else {
+                $codecheckGithubRegisterApiClient->fetchAllIssues();
+            }
+        } catch (\Throwable $e) {
+            CodecheckLogger::error($e->getCode() . ": " . $e->getMessage());
+            throw $e;
         }
 
-        foreach ($codecheckGithubRegisterApiClient->getIssues() as $issue) {
+        return CertificateIdentifierList::createNewCertificateIdentifierList(
+            $codecheckGithubRegisterApiClient->getIssues(),
+            $newCertificateIdentifierList
+        );
+    }
+
+    /**
+     * Factory Method to create a new CertificateIdentifierList from a GitHub API fetch
+     * 
+     * @param CodecheckGithubRegisterApiClient $codecheckGithubRegisterApiClient The APIParser for the GitHub Issues
+     * @return CertificateIdentifierList Returns a new List containing all fetched Certificate Identifiers from GitHub
+     */
+    static function fromApiWithIdentifier(
+        CodecheckGithubRegisterApiClient $codecheckGithubRegisterApiClient,
+        CertificateIdentifier $certificateIdentifier
+    ): CertificateIdentifierList {
+        $newCertificateIdentifierList = new CertificateIdentifierList();
+
+        // fetch API
+        try {
+            $codecheckGithubRegisterApiClient->fetchIssueByIdentifier($certificateIdentifier);
+        } catch (\Throwable $e) {
+            CodecheckLogger::error($e->getCode() . ": " . $e->getMessage());
+            throw $e;
+        }
+
+        return CertificateIdentifierList::createNewCertificateIdentifierList(
+            $codecheckGithubRegisterApiClient->getIssues(),
+            $newCertificateIdentifierList
+        );
+    }
+
+    private static function createNewCertificateIdentifierList(
+        array $issues,
+        CertificateIdentifierList $newCertificateIdentifierList
+    ): CertificateIdentifierList {
+        foreach ($issues as $issue) {
             // raw identifier (can still have ranges of identifiers);
             $rawIdentifier = CertificateIdentifierList::getRawIdentifier($issue['title']);
 
@@ -56,7 +94,7 @@ static function fromApi(
             }
 
             // append to all identifiers in new Register
-            $newCertificateIdentifierList->appendToCertificateIdList($rawIdentifier);
+            $newCertificateIdentifierList->appendToCertificateIdList($rawIdentifier, $issue);
         }
 
         // return the new Register
@@ -98,10 +136,11 @@ public static function getRawIdentifier(string $title): ?string
     /**
      * Appends a raw Identifier to the list of Certificate Identifiers
      * 
-     * @param string $rawidentifier The raw Identifier to be appended
+     * @param string $rawIdentifier The raw Identifier to be appended
+     * @param array $issue The GitHub Issue information of the raw Identifier to be appended
      * @return void
      */
-    public function appendToCertificateIdList(string $rawIdentifier): void
+    public function appendToCertificateIdList(string $rawIdentifier, array $issue): void
     {
         // list of certificate identifiers in range
         $idRange = [];
@@ -111,42 +150,46 @@ public function appendToCertificateIdList(string $rawIdentifier): void
             // split into "fromIdStr" and "toIdStr"
             list($fromIdStr, $toIdStr) = explode('/', $rawIdentifier);
 
-            $from_identifier = CertificateIdentifier::fromStr($fromIdStr);
-            $to_identifier = CertificateIdentifier::fromStr($toIdStr);
+            $fromIdentifier = CertificateIdentifier::fromStr($fromIdStr);
+            $toIdentifier = CertificateIdentifier::fromStr($toIdStr);
 
             // append to $idRange list
-            for ($id_count = $from_identifier->getNumber(); $id_count <= $to_identifier->getNumber(); $id_count++) {
-                $new_identifier = new CertificateIdentifier($from_identifier->getYear(), $id_count);
+            for ($id_count = $fromIdentifier->getNumber(); $id_count <= $toIdentifier->getNumber(); $id_count++) {
+                $newIdentifier = new CertificateIdentifier($fromIdentifier->getYear(), $id_count);
                 // append new identifier
-                $idRange[] = $new_identifier;
+                $idRange[] = [
+                    'identifier' => $newIdentifier,
+                    'issueUrl' => $issue['html_url'],
+                    'issueNumber' => $issue['number']
+                ];
             }
         }
         // if it isn't a list then just append on identifier
         else {
-            $new_identifier = CertificateIdentifier::fromStr($rawIdentifier);
-            $idRange[] = $new_identifier;
+            $newIdentifier = CertificateIdentifier::fromStr($rawIdentifier);
+            $idRange[] = [
+                'identifier' => $newIdentifier,
+                'issueUrl' => $issue['html_url'],
+                'issueNumber' => $issue['number']
+            ];
         }
 
         // append to all certificate identifiers
-        foreach ($idRange as $identifier) {
-            if (!$this->uniqueArray->contains($identifier)) {
-                $this->uniqueArray->add($identifier);
-            }
-        }
+        $this->uniqueIdentifierArray->addArray($idRange);
     }
 
     /**
      * Sorts the Certificate Identifier List ascending
      */
     public function sortAsc(): void
     {
-        $this->uniqueArray->sort(function($a, $b) {
+        $this->uniqueIdentifierArray->sort(function($a, $b) {
             // First, compare year
-            if ($a->getYear() !== $b->getYear()) {
-                return $a->getYear() <=> $b->getYear();
+            if ($a['identifier']->getYear() !== $b['identifier']->getYear()) {
+                return $a['identifier']->getYear() <=> $b['identifier']->getYear();
             }
             // If years are equal, compare ID
-            return $a->getNumber() <=> $b->getNumber();
+            return $a['identifier']->getNumber() <=> $b['identifier']->getNumber();
         });
     }
 
@@ -155,13 +198,13 @@ public function sortAsc(): void
      */
     public function sortDesc(): void
     {
-        $this->uniqueArray->sort(function($a, $b) {
+        $this->uniqueIdentifierArray->sort(function($a, $b) {
             // First, compare year descending
-            if ($a->getYear() !== $b->getYear()) {
-                return $b->getYear() <=> $a->getYear();
+            if ($a['identifier']->getYear() !== $b['identifier']->getYear()) {
+                return $b['identifier']->getYear() <=> $a['identifier']->getYear();
             }
             // If years are equal, compare ID descending
-            return $b->getNumber() <=> $a->getNumber();
+            return $b['identifier']->getNumber() <=> $a['identifier']->getNumber();
         });
     }
 
@@ -172,7 +215,7 @@ public function sortDesc(): void
      */
     public function getNumberOfIdentifiers(): int
     {
-        return $this->uniqueArray->count();
+        return $this->uniqueIdentifierArray->count();
     }
 
     /**
@@ -184,7 +227,7 @@ public function getNewestIdentifier(): CertificateIdentifier
     {
         $this->sortDesc();
         // get first element of sort descending -> newest element
-        return $this->uniqueArray->at(0);
+        return $this->uniqueIdentifierArray->at(0)['identifier'];
     }
 
     /**
@@ -194,10 +237,21 @@ public function getNewestIdentifier(): CertificateIdentifier
      */
     public function toStr(): string
     {
-        $return_str = "Certificate Identifiers:\n";
-        foreach ($this->uniqueArray->toArray() as $identifier) {
-            $return_str .= $identifier->toStr() . "\n";
+        $returnStr = "Certificate Identifiers:\n";
+        foreach ($this->uniqueIdentifierArray->toArray() as $identifierInformation) {
+            $returnStr .= $identifierInformation['identifier']->toStr() . "\n";
         }
-        return $return_str;
+        return $returnStr;
+    }
+
+    public function getIssueInformationByIdentifier(CertificateIdentifier $identifier): ?array
+    {
+        foreach ($this->uniqueIdentifierArray->toArray() as $identifierInformation) {
+            if($identifierInformation['identifier']->toStr() == $identifier->toStr()){
+                return $identifierInformation;
+            }
+        }
+
+        return null;
     }
 }