OIDplusIanaPen.class.php

<?php

/*
 * OIDplus 2.0
 * Copyright 2019 - 2021 Daniel Marschall, ViaThinkSoft
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Frdlweb;
use ViaThinkSoft\OIDplus\OIDplusOid;
use ViaThinkSoft\OIDplus\OIDplus;
use ViaThinkSoft\OIDplus\OIDplusConfig;
use ViaThinkSoft\OIDplus\OIDplusObjectTypePlugin;
use ViaThinkSoft\OIDplus\OIDplusPagePluginPublic;
use ViaThinkSoft\OIDplus\OIDplusObject;
use ViaThinkSoft\OIDplus\OIDplusException; 

class OIDplusIanaPen extends OIDplusObject {
	
	//const PREFIX = 'oid:1.3.6.1.4.1.';
	const PREFIX = '1.3.6.1.4.1.';
	
	protected $pen;
    protected $data = null;
    protected $Fetcher = null;

	public function __construct($pen) {
		// No syntax checks
		$this->pen = $pen; 
		//doch!
		if(!is_numeric($this->pen) && is_array($this->getData()) ){
		  $this->pen = $this->getData()['id'];	
		}
		$this->pen = trim($this->pen, '. ');
		//$this->getData();
	}
	
	public function getDotNotation(){
		return rtrim(self::PREFIX.$this->pen, '.');
	}
	
	public function getWeidNotation($withAbbr=true) {
		$weid = \Frdl\Weid\WeidOidConverter::oid2weid($this->getDotNotation());
		if ($withAbbr) {
			$ary = explode(':', $weid);
			$weid = array_pop($ary); // remove namespace and sub-namespace if existing
			$ns = implode(':', $ary).':';

			$weid_arcs = explode('-', $weid);
			foreach ($weid_arcs as $i => &$weid) {
				if ($i == count($weid_arcs)-1) {
					$weid = '<abbr title="'._L('weLuhn check digit').'">'.$weid.'</abbr>';
				} else {
					$oid_arcs = explode('.',$this->pen);
					$weid_num = $oid_arcs[(count($oid_arcs)-1)-(count($weid_arcs)-1)+($i+1)];
					if ($weid_num != $weid) {
						$weid = '<abbr title="'._L('Numeric value').': '.$weid_num.'">'.$weid.'</abbr>';
					}
				}
			}
			$base_arc = '???';
			if ($ns === 'weid:')      $base_arc = '1.3.6.1.4.1.37553.8';
			if ($ns === 'weid:pen:')  $base_arc = '1.3.6.1.4.1';
			if ($ns === 'weid:root:') $base_arc = _L('OID tree root');

			$weid = '<abbr title="'._L('Base OID').': '.$base_arc.'">' . rtrim($ns,':') . '</abbr>:' . implode('-',$weid_arcs);
		}
		return $weid;
	}
	
	public function getCanonicalOid() {
		return $this->getDotNotation();
	}
	public static function secmail($emailaddress){
		$email= $emailaddress;           
		$length = strlen($email);
		$obfuscatedEmail='';
		for ($i = 0; $i < $length; $i++){
			$obfuscatedEmail .= "&#" . \ord($email[$i]).";";
		} 
		return $obfuscatedEmail;
	}
	
	public function getFetcher() {
		if(null === $this->Fetcher ){
		  $this->Fetcher = new \Frdlweb\IanaPenListFetcher();
		}
		return $this->Fetcher;
	}
	
	public function getData() {
		if(null === $this->data ){ 
			$this->data = !$this->pen || $this->pen === self::root() ? false : $this->getFetcher()->get($this->pen);
		}
		return $this->data;
	}

	public static function parse($node_id) {
		// TODO:  if ($node_id == 'pen:') return new self('');
		if(is_numeric($node_id)){
			$node_id = self::ns().':'.$node_id;
		}
		@list($namespace, $pen) = explode(':', $node_id, 2);
		if($namespace !== self::ns() )return false;
		
		/*
		if ($pen !== 'oid:1.3.6.1.4.1' 
			&& $pen.':' !== self::root() 
			&& ($namespace !== self::ns() && !is_numeric($pen) )) return false;
		//$pen = $pen !== self::root() && $pen !== 'oid:1.3.6.1.4.1' && $namespace === self::ns() && is_numeric($pen) ? intval($pen) : $pen;
 */
		$object = new self($pen);
	/*	
		if( $pen && $pen.':' !== self::root()  && 
		   !$object->isRoot() && !is_array($object->getData()) )return false;
		
		if(!is_array($object->getData())  && $pen.':' !== self::root() )return false;
		
		$object->getData(); */
	  return $object;
	}

	public static function objectTypeTitle(): string {
		return _L('IANA Enterprise Numbers');
	}

	public static function objectTypeTitleShort(): string {
		return _L('PEN');
	}

	public static function ns() : string {
	//return 'iana-pen';
		return 'pen';
	}

	public static function root() : string{
		return self::ns().':';
		//return 'oid:1.3.6.1.4.1';
		//return 'pen:1.3.6.1.4.1';
	}

	public function isRoot() :bool{
		// Ärghühhh????// 
	 
		return// 0===0 ||
			is_array($this->getData()) ||
			$this->nodeId(true) === self::root() 
			 // || $this->pen === self::ns()
				// || $this->pen === self::ns().':' 
				// 	 || $this->pen === 0 
				// 	 || $this->pen === '0'
					//  || $this->pen === 'oid:1.3.6.1.4.1'					
					;
	}
	

	
	public static function exists(string $id): bool {
		return $id === self::root() || is_array((new self(ltrim($id,self::ns().':')))->getData());
	}
	/**/
	public function getParent()  {
		//everything is "root" here, self reference!!!
		return new OIDplusOid( $this->getDotNotation() );
		//return new OIDplusOid( rtrim('1.3.6.1.4.1.'.$this->pen, '.')	);
		//return $this; 
	}
	public function nodeId(bool $with_ns = true): string {
		return $with_ns ? self::root().$this->pen : $this->pen;
	}

	public function addString(string $str) : string{
		throw new \Exception('You are not allowed to add a node on this non-authoritive OID-Service. '
		.'You must add this PEN as OID to the system first.');
	}

	public function crudShowId(\ViaThinkSoft\OIDplus\OIDplusObject $parent): string {
		if ($parent->isRoot()) {
			return substr($this->nodeId(), strlen($parent->nodeId()));
		}else{
			return substr($this->nodeId(), strlen($parent->nodeId())+1);
		}
	}

	public function jsTreeNodeName(?\ViaThinkSoft\OIDplus\OIDplusObject $parent = null): string{
		if ($parent == null) return $this->objectTypeTitle();
		if ($parent->isRoot()) {
			return substr($this->nodeId(), strlen($parent->nodeId()));
		} else {
			return substr($this->nodeId(), strlen($parent->nodeId())+1);
		}
	}

	public function defaultTitle() :string{
		 $data = $this->getData();
		 $org = is_array($data) && isset($data['org']) ? $data['org'] : '';
		return $this->nodeId(true) === self::root() ? self::objectTypeTitle() : $org.' ('.$this->getCanonicalOid().')';
	}
	public function getTitle()  :string{
		return $this->defaultTitle();
	}
	public function getDescription()  :string{
		 $data = $this->getData();
		$org = is_array($data) && isset($data['org']) ? $data['org'] : false;
		if(false===$org){
		 return 'Private Enterprise Numbers are assigned by IANA https://www.iana.org.';			
		}
		return $this->getCanonicalOid().' is a Private Enterprise Number assigned by IANA for '.$org
			.', it should be listed at https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers .';
	}	
	public function isLeafNode() :bool{
		return true;
	}
	
	public function getRaMail() {
		 $data = $this->getData();
		return is_array($data) && isset($data['email']) ? $data['email'] : false;
	}
	
	public function getContentPage(&$title, &$content, &$icon) {
		$icon = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : '';
		
	      $title = $this->getTitle();
   
		if ($this->nodeId(true) !== self::root()  ) {
		  $content.='<a href="?goto=oidplus%3Asystem" onclick="openOidInPanel(\''.self::ns().':\', true); return false;">
		  <img src="img/arrow_back.png" alt="Go back" width="16">Private Enterprise Numbers</a>';  
		}
		
		 $content.='<div style="display:block;margin:15px;padding:2px;min-height:480px;">';
		
		  //  $content.='Re: '.$this->getRaMail();
		   $content.= '<p>'.$this->getDescription().'</p>';
		  $data = $this->getData();
		if(is_array($data)){
		  foreach($data as $k => $v){
			  switch($k){
				  case 'oid' : 	
					    $k = 'OID';
					  break;
				  case 'id' : 			 
				        $v = 'iana-pen:'.$this->nodeId(false);
					    $k = 'ID';
					  break;
				  case 'email' : 					  
			          	//$v = str_replace('@', ' & ', $v);  
				        $v = self::secmail($v);
					    $k = 'Email/Registration-Authority';
					  break;
				  case 'org' :  
				        $k = 'Organisation';
					  break;
				  case 'name' :  
				        $k = 'Name/Person';
					  break;
				  default:
					  break;
			  } 
			  $content.= '<p><legend style="display:inline;float:left;">'.ucfirst($k)
				  .'</legend><span style="display:inline;float:right;max-width:320px;">'.$v.'</span></p>'; 
		  }
		}//is array $data
	 	
	 		if ($this->nodeId(true) === self::root()  ) {
				if (OIDplus::authUtils()->isAdminLoggedIn()) {
					$content .= '<h2>'._L('Manage root objects').'</h2>';
					$content .= _L('@ToDo PEN Root/List...');
				} else {
					$content .= '<h2>'._L('Available PENs').'</h2>';
				}
				//$content .= '%%CRUD%%';
				$content .= 'You can either look up the <a href="?goto='.urlencode(rtrim('oid:'.self::PREFIX.$this->pen, '.')).'">'
					.'look up the parent OID</a> or do a lookup or a search for '
					.'<form action="" method="GET" class="input-group">'
					.'<input type="text" 
					    placeholder="enter a local PEN-ID, an OID, an E-Mail, name or searchterm...!"
					    name="goto" oninput="this.value=\'pen:\' + this.value.replace(/pen\:/, \'\').trim();" />'
					.'<button class="btn btn-outline-secondary bg-white border-start-0 border rounded-pill ms-n3">'
					.'<i class="fa fa-search">Search...</i>'
					.'</button></form>'
					;
		 	}else{
		      $weid = \Frdl\Weid\WeidOidConverter::oid2weid($this->getDotNotation());
		      $content.= '<p><legend style="display:inline;float:left;">WEID</legend>
			  <span style="display:inline;float:right;max-width:320px;">'.$weid.'</span></p>'; 		
				
				///$content .= '%%CRUD%%';
			}
		
           $content.='</div>';
	}

	
	public function userHasWriteRights($ra = null): bool  {			
		return false;		
	}	
    	
	public function userHasParentalWriteRights($ra_email=null) :bool{			
		return false;		
	}	
    
	public function userHasReadRights($ra = null): bool{	 
		return true;     
	}
	
	public function isConfidential():bool {     
		return false;    
	}
	
	public function getRa(): \ViaThinkSoft\OIDplus\OIDplusRA{
		return new OIDplusRA($this->getRaMail());
	}
	
 	 public static function findFitting(string $id) {
		$obj = self::parse($id);
		if (!$obj) return false; 
		return $obj;   
	 } 

	public static function treeIconFilename(string $mode): string{
		return 'img/'.$mode.'_icon16.png';
	}
	//public function distance($to) {
	//	return null; // not implemented
	//}	
}