<?php
/*
* OIDplus 2.0
* Copyright 2019 - 2023 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 ViaThinkSoft\OIDplus;
// phpcs:disable PSR1.Files.SideEffects
// phpcs:enable PSR1.Files.SideEffects
class OIDplusFourCC extends OIDplusObject {
private $fourcc;
// FourCC Syntax examples:
// fourcc_transform('8BIM') === array(56,66,73,77); // Adobe Photoshop
// fourcc_transform('AVI') === array(65,86,73,32); // AVI File (padded with whitespace)
// fourcc_transform('Y3[10][10]') === array(89,51,10,10); // 10bit Y'CbCr 4:2:2 video
// Non-FourCC: fourcc_transform returns false.
private function fourcc_transform($fourcc) {
if ($fourcc === '') return false;
for ($i=0; $i<4; $i++) {
$out[] = 0x20; // fill with whitespace
} else {
if ($fourcc[0] !== '[') {
$out[] = ord($fourcc[0]); } else {
$out[] = (int
)substr($fourcc,1,$p-1); $fourcc = substr($fourcc,$p+1); }
}
}
if ($fourcc !== '') return false;
return $out;
}
public function __construct($fourcc) {
if (self::fourcc_transform($fourcc) !== false) {
$this->fourcc = $fourcc; // leaf node
} else {
$this->fourcc = $fourcc; // It is a category name
}
}
public static function parse($node_id) {
@list($namespace, $fourcc) = explode(':', $node_id, 2); if ($namespace !== self::ns()) return false;
return new self($fourcc);
}
public static function objectTypeTitle() {
return _L('Four-Character-Code (FourCC)');
}
public static function objectTypeTitleShort() {
return _L('FourCC');
}
public static function ns() {
return 'fourcc';
}
public static function root() {
return self::ns().':';
}
public function isRoot() {
return $this->fourcc == '';
}
public function nodeId($with_ns=true) {
return $with_ns ? self::root().$this->fourcc : $this->fourcc;
}
public function addString($str) {
// Y3[10] [10] --> Y3[10][10]
do {
$test_str2 = $test_str;
} while ($test_str2 != $test_str);
if (self::fourcc_transform($test_str) !== false) {
// real FourCC
return self::root() . $test_str;
} else {
// just a category
if ($this->isRoot()) {
return self::root() . $str;
} else {
return $this->nodeId() . '/' . $str;
}
}
}
public function crudShowId(OIDplusObject $parent) {
if ($this->isLeafNode()) {
// We don't parse '/' in a valid FourCC code (i.e. Leaf node)
return $this->nodeId(false);
} else {
if ($parent->isRoot()) {
} else {
return substr($this->nodeId(), strlen($parent->nodeId())+1); }
}
}
public function jsTreeNodeName(OIDplusObject $parent = null) {
if ($parent == null) return $this->objectTypeTitle();
return $this->crudShowId($parent);
}
public function defaultTitle() {
return $this->fourcc;
}
public function isLeafNode() {
return self::fourcc_transform($this->fourcc) !== false;
}
private function getTechInfo() {
$tech_info[_L('FourCC code')] = $this->fourcc;
$tech_info[_L('C/C++ Literal')] = $this->getMultiCharLiteral();
$tech_info[_L('Big Endian')] = '0x'.$this->getHex(true).' ('.$this->getInt(true).')';
$tech_info[_L('Little Endian')] = '0x'.$this->getHex(false).' ('.$this->getInt(false).')';
return $tech_info;
}
public function getContentPage(&$title, &$content, &$icon) {
$icon = file_exists(__DIR__
.'/img/main_icon.png') ? OIDplus
::webpath(__DIR__
,OIDplus
::PATH_RELATIVE).'img/main_icon.png' : '';
if ($this->isRoot()) {
$title = OIDplusFourCC::objectTypeTitle();
$res = OIDplus
::db()->query("select * from ###objects where parent = ?", array(self::root())); if ($res->any()) {
$content = '<p>'._L('Please select a FourCC in the tree view at the left to show its contents.').'</p>';
} else {
$content = '<p>'._L('Currently, no FourCC is registered in the system.').'</p>';
}
if (!$this->isLeafNode()) {
if (OIDplus::authUtils()->isAdminLoggedIn()) {
$content .= '<h2>'._L('Manage root objects / categories').'</h2>';
} else {
$content .= '<h2>'._L('Available objects / categories').'</h2>';
}
$content .= '%%CRUD%%';
}
} else {
$title = $this->getTitle();
if ($this->isLeafNode()) {
$tech_info = $this->getTechInfo();
$tech_info_html = '';
if (count($tech_info) > 0) { $tech_info_html .= '<h2>'._L('Technical information').'</h2>';
$tech_info_html .= '<table border="0">';
foreach ($tech_info as $key => $value) {
$tech_info_html .= '<tr><td>'.$key.': </td><td><code>'.str_replace(' ',' ',$value).'</code></td></tr>'; }
$tech_info_html .= '</table>';
}
$content = $tech_info_html;
} else {
$content = '';
}
$content .= '<h2>'._L('Description').'</h2>%%DESC%%';
if (!$this->isLeafNode()) {
if ($this->userHasWriteRights()) {
$content .= '<h2>'._L('Create or change subordinate objects / categories').'</h2>';
} else {
$content .= '<h2>'._L('Subordinate objects / categories').'</h2>';
}
$content .= '%%CRUD%%';
}
}
}
public function getIcon($row=null) {
$in_login_treenode = false;
// If we are inside the "Login" area (i.e. "Root object links"), we want the
// correct icon, not a folder icon!
if ($trace['class'] === OIDplusPagePublicLogin::class) $in_login_treenode = true;
}
if (!$in_login_treenode && !$this->isLeafNode()) return null; // foldericon
return parent::getIcon($row);
}
public function one_up() {
// A FourCC is a FourCC, there is no hierarchy
return false;
}
public function distance($to) {
// Distance between FourCCs is not possible
return null;
}
public function getAltIds() {
if ($this->isRoot()) return array(); if (!$this->isLeafNode()) return array(); $ids = parent::getAltIds();
return $ids;
}
private function getInt($big_endian) {
$type = self::fourcc_transform($this->fourcc);
if ($type === false) return false;
$dec = 0;
for ($i=0;$i<4;$i++) $dec = ($dec<<8) + $type[$i];
return $dec;
}
private function getHex($big_endian) {
$dec = $this->getInt($big_endian);
return $hex;
}
private function getMultiCharLiteral() {
$type = self::fourcc_transform($this->fourcc);
if ($type === false) return false;
return c_literal($type);
}
public function getDirectoryName() {
if ($this->isLeafNode()) {
// Leaf (FourCC)
// Example output: "fourcc_23496d52" for 'fourcc:#ImR'
return $this->ns().'_'.$this->getHex(true);
} else {
// Category
return parent::getDirectoryName();
}
}
public static function treeIconFilename($mode) {
return 'img/'.$mode.'_icon16.png';
}
}