Subversion Repositories oidplus

<?php

/*

 * OIDplus 2.0

 * Copyright 2022 - 2024 Daniel Marschall, ViaThinkSoft / Till Wehowski, Frdlweb

 *

 * Licensed under the MIT License.

 */

namespace Frdlweb\OIDplus;

use ViaThinkSoft\OIDplus\INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3;

use ViaThinkSoft\OIDplus\INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_4;

use ViaThinkSoft\OIDplus\INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_7;

use ViaThinkSoft\OIDplus\INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_8;

use ViaThinkSoft\OIDplus\OIDplus;

use ViaThinkSoft\OIDplus\OIDplusObject;

use ViaThinkSoft\OIDplus\OIDplusPagePluginPublic;

use ViaThinkSoft\OIDplus\OIDplusNotification;

// phpcs:disable PSR1.Files.SideEffects

\defined('INSIDE_OIDPLUS') or die;

// phpcs:enable PSR1.Files.SideEffects

class OIDplusPagePublicAltIds extends OIDplusPagePluginPublic

        implements INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_4,  /* whois*Attributes */

                   INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_7,  /* getAlternativesForQuery */

                   INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_8,  /* getNotifications */

                   INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3   /* *objects* */

{

        /**

         * @var bool

         */

        private $db_table_exists;

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3

         * @param string $id

         * @return void

         */

        public function beforeObjectDelete(string $id){

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3

         * @param string $id

         * @return void

         */

        public function afterObjectDelete(string $id){

                if (!$this->db_table_exists) return;

                OIDplus::db()->query("DELETE FROM ###altids WHERE origin = ?", [$id]);

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3

         * @param string $id

         * @param array $params

         * @return void

         */

        public function beforeObjectUpdateSuperior(string $id, array &$params){

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3

         * @param string $id

         * @param array $params

         * @return void

         */

        public function afterObjectUpdateSuperior(string $id, array &$params){

                $this->saveAltIdsForQuery($id);

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3

         * @param string $id

         * @param array $params

         * @return void

         */

        public function beforeObjectUpdateSelf(string $id, array &$params){

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3

         * @param string $id

         * @param array $params

         * @return void

         */

        public function afterObjectUpdateSelf(string $id, array &$params){

                $this->saveAltIdsForQuery($id);

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3

         * @param string $id

         * @param array $params

         * @return void

         */

        public function beforeObjectInsert(string $id, array &$params){

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_3

         * @param string $id

         * @param array $params

         * @return void

         */

        public function afterObjectInsert(string $id, array &$params){

                $this->saveAltIdsForQuery($id);

        }

        /**

         * Adds the required database table if DBMS is known

         * @param bool $html

         * @return void

         * @throws \ViaThinkSoft\OIDplus\OIDplusConfigInitializationException

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        public function init(bool $html=true) {

                if (!OIDplus::db()->tableExists("###altids")) {

                        if (OIDplus::db()->getSlang()->id() == 'mysql') {

                                OIDplus::db()->query("CREATE TABLE ###altids ( `origin` varchar(255) NOT NULL, `alternative` varchar(255) NOT NULL, UNIQUE KEY (`origin`, `alternative`)   )");

                                $this->db_table_exists = true;

                        } else if (OIDplus::db()->getSlang()->id() == 'mssql') {

                                // We use nvarchar(225) instead of varchar(255), see https://github.com/frdl/oidplus-plugin-alternate-id-tracking/issues/18

                                // Unfortunately, we cannot use nvarchar(255), because we need two of them for the primary key, and an index must not be greater than 900 bytes in SQL Server.

                                // Therefore we can only use 225 Unicode characters instead of 255.

                                // It is very unlikely that someone has such giant identifiers. But if they do, then saveAltIdsForQuery() will reject the INSERT commands to avoid that an SQL Exception is thrown.

                                OIDplus::db()->query("CREATE TABLE ###altids ( [origin] nvarchar(225) NOT NULL, [alternative] nvarchar(225) NOT NULL, CONSTRAINT [PK_###altids] PRIMARY KEY CLUSTERED( [origin] ASC, [alternative] ASC ) )");

                                $this->db_table_exists = true;

                        } else if (OIDplus::db()->getSlang()->id() == 'oracle') {

                                // TODO: Implement Table Creation for this DBMS (see CREATE TABLE syntax at plugins/viathinksoft/sqlSlang/oracle/sql/*.sql)

                                $this->db_table_exists = false;

                        } else if (OIDplus::db()->getSlang()->id() == 'pgsql') {

                                // TODO: Implement Table Creation for this DBMS (see CREATE TABLE syntax at plugins/viathinksoft/sqlSlang/pgsql/sql/*.sql)

                                $this->db_table_exists = false;

                        } else if (OIDplus::db()->getSlang()->id() == 'access') {

                                // TODO: Implement Table Creation for this DBMS (see CREATE TABLE syntax at plugins/viathinksoft/sqlSlang/access/sql/*.sql)

                                $this->db_table_exists = false;

                        } else if (OIDplus::db()->getSlang()->id() == 'sqlite') {

                                // TODO: Implement Table Creation for this DBMS (see CREATE TABLE syntax at plugins/viathinksoft/sqlSlang/sqlite/sql/*.sql)

                                $this->db_table_exists = false;

                        } else if (OIDplus::db()->getSlang()->id() == 'firebird') {

                                // TODO: Implement Table Creation for this DBMS (see CREATE TABLE syntax at plugins/viathinksoft/sqlSlang/firebird/sql/*.sql)

                                $this->db_table_exists = false;

                        } else {

                                // DBMS not supported

                                $this->db_table_exists = false;

                        }

                } else {

                        $this->db_table_exists = true;

                }

                // Whenever a user visits a page, we need to update our cache, so that reverse-lookups are possible later

                // TODO! Dirty hack. We need a cleaner solution...

                if (isset($_REQUEST['goto'])) $this->saveAltIdsForQuery($_REQUEST['goto']); // => solve using implementing gui()?

                if (isset($_REQUEST['query'])) $this->saveAltIdsForQuery($_REQUEST['query']); // for webwhois.php?query=... and rdap.php?query=...

                if (isset($_REQUEST['id'])) $this->saveAltIdsForQuery($_REQUEST['id']); // => solve using implementing action()?

        }

        // TODO: call this via cronjob  https://github.com/frdl/oidplus-plugin-alternate-id-tracking/issues/20

        public function renewAll() {

                if (!$this->db_table_exists) return;

                OIDplus::db()->query("DELETE FROM ###altids");

                $resQ = OIDplus::db()->query("SELECT * FROM ###objects");

                while ($row = $resQ->fetch_array()) {

                        $this->saveAltIdsForQuery($row['id']);

                }

        }

        protected function saveAltIdsForQuery(string $id){

                if (!$this->db_table_exists) return;

                $obj = OIDplusObject::parse($id);

                if (!$obj) return; // e.g. if plugin is disabled

                $ary = $obj->getAltIds();

                $origin = $obj->nodeId(true);

                OIDplus::db()->query("DELETE FROM ###altids WHERE origin = ?", [$id]);

                // Why prefiltering? Consider the following testcase:

                // "oid:1.3.6.1.4.1.37553.8.8.2" defines alt ID "mac:63-CF-E4-AE-C5-66" which is NOT canonized (otherwise it would not look good)!

                // You must be able to enter "mac:63-CF-E4-AE-C5-66" in the search box, which gets canonized

                // to mac:63CFE4AEC566 and must be resolved to "oid:1.3.6.1.4.1.37553.8.8.2" by this plugin.

                // Therefore we use self::special_in_array().

                // However, it is mandatory, that previously saveAltIdsForQuery("oid:1.3.6.1.4.1.37553.8.8.2") was called once!

                // Please also note that the "weid:" to "oid:" converting is handled by prefilterQuery(), but only if the OID plugin is installed.

                $origin_prefiltered = OIDplus::prefilterQuery($origin, false);

                if($origin_prefiltered !== $origin){

                        $ok = true;

                        if (OIDplus::db()->getSlang()->id() == 'mssql') {

                                // Explanation: See comment in the init() method.

                                if ((strlen($origin) > 225) || (strlen($origin_prefiltered) > 225)) $ok = false;

                        }

                        if ($ok) {

                                try {

                                        OIDplus::db()->query("INSERT INTO ###altids (origin, alternative) VALUES (?,?);", [$origin, $origin_prefiltered]);

                                } catch (\Exception $e) {

                                        // There could be a Primary Key collission if this method is called simultaneously at the same moment

                                        // Ignore it. The last caller will eventually execute all INSERTs after its call to DELETE.

                                }

                        }

                }

                foreach ($ary as $a) {

                        $alternative = $a->getNamespace() . ':' . $a->getId();

                        $ok = true;

                        if (OIDplus::db()->getSlang()->id() == 'mssql') {

                                // Explanation: See comment in the init() method.

                                if ((strlen($origin) > 225) || (strlen($alternative) > 225)) $ok = false;

                        }

                        if ($ok) {

                                try {

                                        OIDplus::db()->query("INSERT INTO ###altids (origin, alternative) VALUES (?,?);", [$origin, $alternative]);

                                } catch (\Exception $e) {

                                        // There could be a Primary Key collission if this method is called simultaneously at the same moment

                                        // Ignore it. The last caller will eventually execute all INSERTs after its call to DELETE.

                                }

                        }

                        $alternative_prefiltered = OIDplus::prefilterQuery($alternative, false);

                        if($alternative_prefiltered !== $alternative){

                                $ok = true;

                                if (OIDplus::db()->getSlang()->id() == 'mssql') {

                                        // Explanation: See comment in the init() method.

                                        if ((strlen($origin) > 225) || (strlen($alternative_prefiltered) > 225)) $ok = false;

                                }

                                if ($ok) {

                                        try {

                                                OIDplus::db()->query("INSERT INTO ###altids (origin, alternative) VALUES (?,?);", [$origin, $alternative_prefiltered]);

                                        } catch (\Exception $e) {

                                                // There could be a Primary Key collission if this method is called simultaneously at the same moment

                                                // Ignore it. The last caller will eventually execute all INSERTs after its call to DELETE.

                                        }

                                }

                        }

                }

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_7

         * @param string $id

         * @return array|string[]

         * @throws \ReflectionException

         * @throws \ViaThinkSoft\OIDplus\OIDplusConfigInitializationException

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        public function getAlternativesForQuery(string $id): array {

                if (!$this->db_table_exists) return [];

                $id_prefiltered = OIDplus::prefilterQuery($id, false);

                $res = [

                        $id,

                        $id_prefiltered

                ];

                $resQ = OIDplus::db()->query("SELECT origin, alternative FROM ###altids WHERE origin = ? OR alternative = ? OR origin = ? OR alternative = ?", [$res[0],$res[0],$res[1],$res[1]]);

                while ($row = $resQ->fetch_array()) {

                        if(!in_array($row['origin'], $res)){

                                $res[]=$row['origin'];

                        }

                        if(!in_array($row['alternative'], $res)){

                                $res[]=$row['alternative'];

                        }

                }

                return array_unique($res);

        }

        /**

         * @param string $id

         * @param array $out

         * @param bool $handled

         * @return void

         */

        public function gui(string $id, array &$out, bool &$handled) {

                // $this->saveAltIdsForQuery($id);

        }

        /**

         * @param array $out

         * @return void

         */

        public function publicSitemap(array &$out) {

        }

        /**

         * @param array $json

         * @param string|null $ra_email

         * @param bool $nonjs

         * @param string $req_goto

         * @return bool

         */

        public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool {

                return false;

        }

        /**

         * @param string $request

         * @return array|false

         */

        public function tree_search(string $request) {

                return false;

        }

        /**

         * @param string $id

         * @return false|mixed|string

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        public function getCanonical(string $id){

                foreach($this->getAlternativesForQuery($id) as $alt){

                        if (strpos($alt,':') !== false) {

                                list($ns, $altIdRaw) = explode(':', $alt, 2);

                                if($ns === 'oid'){

                                        return $alt;

                                }

                        }

                }

                return false;

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_4

         * @param string $id

         * @param array $out

         * @return void

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        public function whoisObjectAttributes(string $id, array &$out) {

                $xmlns = 'oidplus-frdlweb-altids-plugin';

                $xmlschema = 'urn:oid:1.3.6.1.4.1.37553.8.1.8.8.53354196964.641310544.1714020422';

                $xmlschemauri = OIDplus::webpath(__DIR__.'/altids.xsd',OIDplus::PATH_ABSOLUTE_CANONICAL);

                $handleShown = false;

                $canonicalShown = false;

                $out1 = array();

                $out2 = array();

                //$tmp = $this->getAlternativesForQuery($id);

                $obj = OIDplusObject::parse($id);

                $tmp = [

                        $this->getCanonical($id),

                ];

                foreach ($obj->getAltIds() as $altId) {

                        $tmp[] = $altId->getNamespace().':'.$altId->getId();

                }

                sort($tmp); // DM 26.03.2023 : Added sorting (intended to sort "alternate-identifier")

                foreach($tmp as $alt) {

                        if (strpos($alt,':') === false) continue;

                        list($ns, $altIdRaw) = explode(':', $alt, 2);

                        if (($canonicalShown === false) && ($ns === 'oid')) {

                                $canonicalShown=true;

                                $out1[] = [

                                        'xmlns' => $xmlns,

                                        'xmlschema' => $xmlschema,

                                        'xmlschemauri' => $xmlschemauri,

                                        'name' => 'canonical-identifier',

                                        'value' => $ns.':'.$altIdRaw,

                                ];

                        }

                        if (($handleShown === false) && ($alt === $id)) {

                                $handleShown=true;

                                $out1[] = [

                                        'xmlns' => $xmlns,

                                        'xmlschema' => $xmlschema,

                                        'xmlschemauri' => $xmlschemauri,

                                        'name' => 'handle-identifier',

                                        'value' => $alt,

                                ];

                        }

                        if ($alt !== $id) { // DM 26.03.2023 : Added condition that alternate must not be the id itself

                                $out2[] = [

                                        'xmlns' => $xmlns,

                                        'xmlschema' => $xmlschema,

                                        'xmlschemauri' => $xmlschemauri,

                                        'name' => 'alternate-identifier',

                                        'value' => $ns.':'.$altIdRaw,

                                ];

                        }

                }

                // DM 26.03.2023 : Added this

                $out = array_merge($out, $out1); // handle-identifier and canonical-identifier

                $out = array_merge($out, $out2); // alternate-identifier

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_4

         * @param string $email

         * @param array $out

         * @return void

         */

        public function whoisRaAttributes(string $email, array &$out) {

        }

        /**

         * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_8

         * @param string|null $user

         * @return array

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        public function getNotifications(string $user=null): array {

                $notifications = array();

                if ((!$user || ($user == 'admin')) && OIDplus::authUtils()->isAdminLoggedIn()) {

                        if (!$this->db_table_exists) {

                                $title = _L('Alt ID Plugin');

                                $notifications[] = new OIDplusNotification('ERR', _L('OIDplus plugin "%1" is enabled, but it does not know how to create its database tables to this DBMS. Therefore the plugin does not work.', htmlentities($title)));

                        }

                }

                return $notifications;

        }

}