Subversion Repositories oidplus

<?php

/*

 * OIDplus 2.0

 * Copyright 2022 - 2023 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_4;

use ViaThinkSoft\OIDplus\INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_7;

use ViaThinkSoft\OIDplus\OIDplus;

use ViaThinkSoft\OIDplus\OIDplusObject;

use ViaThinkSoft\OIDplus\OIDplusPagePluginPublic;

// 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 */

{

        /**

         * @param string $actionID

         * @param array $params

         * @return array

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        public function action(string $actionID, array $params): array {

                return parent::action($actionID, $params);

        }

        /**

         * @param string $id

         * @param array $out

         * @param bool $handled

         * @return void

         */

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

        }

        /**

         * @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;

        }

        /**

         * @return string|null

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        private function cache_id() {

                static $cache_id = null;

                if (!is_null($cache_id)) return $cache_id;

                $cache_id  =  'Create='.OIDplus::db()->getScalar("select max(created) as ts from ###objects where created is not null;");

                $cache_id .= '/Update='.OIDplus::db()->getScalar("select max(updated) as ts from ###objects where updated is not null;");

                $cache_id .= '/Count='.OIDplus::db()->getScalar("select count(id) as cnt from ###objects;");

                $plugin_versions = array();

                foreach (OIDplus::getObjectTypePluginsEnabled() as $otp) {

                        $plugin_versions[] = '/'.$otp->getManifest()->getOid().'='.$otp->getManifest()->getVersion();

                }

                sort($plugin_versions);

                $cache_id .= implode('',$plugin_versions);

                return $cache_id;

        }

        /**

         * @param bool $noCache

         * @return array[]|mixed|null

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        public function readAll(bool $noCache = false) {

                static $local_cache = null;

                $cache_file = OIDplus::localpath().'/userdata/cache/frdl_alt_id.ser';

                if ($noCache === false) {

                        // Local cache (to save time for multiple calls during the same HTTP request)

                        if (!is_null($local_cache)) return $local_cache;

                        // File cache (to save time between HTTP requests)

                        if (file_exists($cache_file)) {

                                $cache_data = unserialize(file_get_contents($cache_file));

                                $cache_id = $cache_data[0];

                                if ($cache_id == $this->cache_id()) {

                                        return $cache_data[1];

                                }

                        }

                }

                $alt_ids = array();

                $rev_lookup = array();

                $res = OIDplus::db()->query("select id from ###objects ".

                                            "where parent <> 'oid:1.3.6.1.4.1.37476.1.2.3.1'");  // TODO FIXME! readAll() is TOOOOO slow if a system has more than 50.000 OIDs!!! DEADLOCK!!!

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

                        $obj = OIDplusObject::parse($row['id']);

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

                        $ary = $obj->getAltIds();

                        foreach ($ary as $a) {

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

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

                                if (!isset($alt_ids[$origin])) $alt_ids[$origin] = array();

                                $alt_ids[$origin][] = $alternative;

                                if (!isset($rev_lookup[$alternative])) $rev_lookup[$alternative] = array();

                                $rev_lookup[$alternative][] = $origin;

                        }

                }

                $data = array($alt_ids, $rev_lookup);

                // File cache (to save time between HTTP requests)

                $cache_data = array($this->cache_id(), $data);

                @file_put_contents($cache_file, serialize($cache_data));

                // Local cache (to save time for multiple calls during the same HTTP request)

                $local_cache = $data;

                return $data;

        }

        /**

         * Acts like in_array(), but allows includes prefilterQuery, e.g. `mac:AA-BB-CC-DD-EE-FF` can be found in an array containing `mac:AABBCCDDEEFF`.

         * @param string $needle

         * @param array $haystack

         * @return bool

         */

        private static function special_in_array(string $needle, array $haystack) {

                $needle_prefiltered = OIDplus::prefilterQuery($needle,false);

                foreach ($haystack as $straw) {

                        $straw_prefiltered = OIDplus::prefilterQuery($straw, false);

                        if ($needle == $straw) return true;

                        else if ($needle == $straw_prefiltered) return true;

                        else if ($needle_prefiltered == $straw) return true;

                        else if ($needle_prefiltered == $straw_prefiltered) return true;

                }

                return false;

        }

        /**

         * @param string $id

         * @return string[]

         * @throws \ViaThinkSoft\OIDplus\OIDplusException

         */

        public function getAlternativesForQuery(string $id/* INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_7 signature takes just 1 param!? , $noCache = false*/): array {

                static $caches = array();

                if(/*$noCache === false && */isset($caches[$id]) ){

                        return $caches[$id];

                }

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

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

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

                                $id='oid:'.\Frdl\Weid\WeidOidConverter::weid2oid($id);

                        }

                }

                list($alt_ids, $rev_lookup) = $this->readAll(false);

                $res = [

                        $id,

                ];

                if(isset($rev_lookup[$id])){

                        $res = array_merge($res, $rev_lookup[$id]);

                }

                foreach($alt_ids as $original => $altIds){

                        // Why self::special_in_array() instead of in_array()? 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!

                        // 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 solved 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.

                        if($id === $original || self::special_in_array($id, $altIds) ){

                                 $res = array_merge($res, $altIds);

                                 $res = array_merge($res, [$original]);

                        }

                }

                $weid = false;

                foreach($res as $alt){

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

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

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

                                        $weid=\Frdl\Weid\WeidOidConverter::oid2weid($altIdRaw);

                                        break;

                                }

                        }

                }

                if ($weid !== false) {

                        $res[]=$weid;

                }

                $res = array_unique($res);

                $caches[$id] = $res;

                return $res;

        }

        /**

         * @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);

                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) {

        }

 }