Rev 1121 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
635 | daniel-mar | 1 | <?php |
2 | |||
3 | /* |
||
4 | * OIDplus 2.0 |
||
1086 | daniel-mar | 5 | * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft |
635 | daniel-mar | 6 | * |
7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
||
8 | * you may not use this file except in compliance with the License. |
||
9 | * You may obtain a copy of the License at |
||
10 | * |
||
11 | * http://www.apache.org/licenses/LICENSE-2.0 |
||
12 | * |
||
13 | * Unless required by applicable law or agreed to in writing, software |
||
14 | * distributed under the License is distributed on an "AS IS" BASIS, |
||
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||
16 | * See the License for the specific language governing permissions and |
||
17 | * limitations under the License. |
||
18 | */ |
||
19 | |||
1050 | daniel-mar | 20 | namespace ViaThinkSoft\OIDplus; |
635 | daniel-mar | 21 | |
1086 | daniel-mar | 22 | // phpcs:disable PSR1.Files.SideEffects |
23 | \defined('INSIDE_OIDPLUS') or die; |
||
24 | // phpcs:enable PSR1.Files.SideEffects |
||
25 | |||
635 | daniel-mar | 26 | class OIDplusOther extends OIDplusObject { |
1130 | daniel-mar | 27 | /** |
28 | * @var string |
||
29 | */ |
||
635 | daniel-mar | 30 | private $other; |
31 | |||
1116 | daniel-mar | 32 | /** |
1130 | daniel-mar | 33 | * @param string $other |
1116 | daniel-mar | 34 | */ |
1130 | daniel-mar | 35 | public function __construct(string $other) { |
635 | daniel-mar | 36 | // No syntax checks |
37 | $this->other = $other; |
||
38 | } |
||
39 | |||
1116 | daniel-mar | 40 | /** |
41 | * @param string $node_id |
||
42 | * @return OIDplusOther|null |
||
43 | */ |
||
44 | public static function parse(string $node_id)/*: ?OIDplusOther*/ { |
||
635 | daniel-mar | 45 | @list($namespace, $other) = explode(':', $node_id, 2); |
1116 | daniel-mar | 46 | if ($namespace !== self::ns()) return null; |
635 | daniel-mar | 47 | return new self($other); |
48 | } |
||
49 | |||
1116 | daniel-mar | 50 | /** |
51 | * @return string |
||
52 | */ |
||
53 | public static function objectTypeTitle(): string { |
||
635 | daniel-mar | 54 | return _L('Other objects'); |
55 | } |
||
56 | |||
1116 | daniel-mar | 57 | /** |
58 | * @return string |
||
59 | */ |
||
60 | public static function objectTypeTitleShort(): string { |
||
635 | daniel-mar | 61 | return _L('Object'); |
62 | } |
||
63 | |||
1116 | daniel-mar | 64 | /** |
65 | * @return string |
||
66 | */ |
||
67 | public static function ns(): string { |
||
635 | daniel-mar | 68 | return 'other'; |
69 | } |
||
70 | |||
1116 | daniel-mar | 71 | /** |
72 | * @return string |
||
73 | */ |
||
74 | public static function root(): string { |
||
860 | daniel-mar | 75 | return self::ns().':'; |
635 | daniel-mar | 76 | } |
77 | |||
1116 | daniel-mar | 78 | /** |
79 | * @return bool |
||
80 | */ |
||
81 | public function isRoot(): bool { |
||
635 | daniel-mar | 82 | return $this->other == ''; |
83 | } |
||
84 | |||
1116 | daniel-mar | 85 | /** |
86 | * @param bool $with_ns |
||
87 | * @return string |
||
88 | */ |
||
89 | public function nodeId(bool $with_ns=true): string { |
||
859 | daniel-mar | 90 | return $with_ns ? self::root().$this->other : $this->other; |
635 | daniel-mar | 91 | } |
92 | |||
1116 | daniel-mar | 93 | /** |
94 | * @param string $str |
||
95 | * @return string |
||
96 | */ |
||
97 | public function addString(string $str): string { |
||
635 | daniel-mar | 98 | if ($this->isRoot()) { |
858 | daniel-mar | 99 | return self::root() . $str; |
635 | daniel-mar | 100 | } else { |
101 | return $this->nodeId() . '\\' . $str; |
||
102 | } |
||
103 | } |
||
104 | |||
1116 | daniel-mar | 105 | /** |
106 | * @param OIDplusObject $parent |
||
107 | * @return string |
||
108 | */ |
||
109 | public function crudShowId(OIDplusObject $parent): string { |
||
635 | daniel-mar | 110 | if ($parent->isRoot()) { |
111 | return substr($this->nodeId(), strlen($parent->nodeId())); |
||
112 | } else { |
||
113 | return substr($this->nodeId(), strlen($parent->nodeId())+1); |
||
114 | } |
||
115 | } |
||
116 | |||
1116 | daniel-mar | 117 | /** |
118 | * @param OIDplusObject|null $parent |
||
119 | * @return string |
||
120 | */ |
||
121 | public function jsTreeNodeName(OIDplusObject $parent = null): string { |
||
635 | daniel-mar | 122 | if ($parent == null) return $this->objectTypeTitle(); |
123 | if ($parent->isRoot()) { |
||
124 | return substr($this->nodeId(), strlen($parent->nodeId())); |
||
125 | } else { |
||
126 | return substr($this->nodeId(), strlen($parent->nodeId())+1); |
||
127 | } |
||
128 | } |
||
129 | |||
1116 | daniel-mar | 130 | /** |
131 | * @return string |
||
132 | */ |
||
133 | public function defaultTitle(): string { |
||
635 | daniel-mar | 134 | $ary = explode('\\', $this->other); // TODO: but if an arc contains "\", this does not work. better read from db? |
135 | $ary = array_reverse($ary); |
||
136 | return $ary[0]; |
||
137 | } |
||
138 | |||
1116 | daniel-mar | 139 | /** |
140 | * @return bool |
||
141 | */ |
||
142 | public function isLeafNode(): bool { |
||
635 | daniel-mar | 143 | return false; |
144 | } |
||
145 | |||
1116 | daniel-mar | 146 | /** |
147 | * @param string $title |
||
148 | * @param string $content |
||
149 | * @param string $icon |
||
150 | * @return void |
||
151 | * @throws OIDplusException |
||
152 | */ |
||
153 | public function getContentPage(string &$title, string &$content, string &$icon) { |
||
801 | daniel-mar | 154 | $icon = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : ''; |
635 | daniel-mar | 155 | |
156 | if ($this->isRoot()) { |
||
157 | $title = OIDplusOther::objectTypeTitle(); |
||
158 | |||
159 | $res = OIDplus::db()->query("select * from ###objects where parent = ?", array(self::root())); |
||
790 | daniel-mar | 160 | if ($res->any()) { |
962 | daniel-mar | 161 | $content = '<p>'._L('Please select an object in the tree view at the left to show its contents.').'</p>'; |
635 | daniel-mar | 162 | } else { |
962 | daniel-mar | 163 | $content = '<p>'._L('Currently, no misc. objects are registered in the system.').'</p>'; |
635 | daniel-mar | 164 | } |
165 | |||
166 | if (!$this->isLeafNode()) { |
||
167 | if (OIDplus::authUtils()->isAdminLoggedIn()) { |
||
168 | $content .= '<h2>'._L('Manage root objects').'</h2>'; |
||
169 | } else { |
||
170 | $content .= '<h2>'._L('Available objects').'</h2>'; |
||
171 | } |
||
172 | $content .= '%%CRUD%%'; |
||
173 | } |
||
174 | } else { |
||
175 | $title = $this->getTitle(); |
||
176 | |||
177 | $content = '<h2>'._L('Description').'</h2>%%DESC%%'; // TODO: add more meta information about the object type |
||
178 | |||
179 | if (!$this->isLeafNode()) { |
||
180 | if ($this->userHasWriteRights()) { |
||
928 | daniel-mar | 181 | $content .= '<h2>'._L('Create or change subordinate objects').'</h2>'; |
635 | daniel-mar | 182 | } else { |
928 | daniel-mar | 183 | $content .= '<h2>'._L('Subordinate objects').'</h2>'; |
635 | daniel-mar | 184 | } |
185 | $content .= '%%CRUD%%'; |
||
186 | } |
||
187 | } |
||
188 | } |
||
189 | |||
1116 | daniel-mar | 190 | /** |
191 | * @return OIDplusOther|null |
||
192 | */ |
||
193 | public function one_up()/*: ?OIDplusOther*/ { |
||
635 | daniel-mar | 194 | $oid = $this->other; |
195 | |||
196 | $p = strrpos($oid, '\\'); |
||
713 | daniel-mar | 197 | if ($p === false) return self::parse($oid); |
198 | if ($p == 0) return self::parse('\\'); |
||
635 | daniel-mar | 199 | |
200 | $oid_up = substr($oid, 0, $p); |
||
201 | |||
202 | return self::parse(self::ns().':'.$oid_up); |
||
203 | } |
||
204 | |||
1116 | daniel-mar | 205 | /** |
1130 | daniel-mar | 206 | * @param OIDplusObject|string $to |
1116 | daniel-mar | 207 | * @return int|null |
208 | */ |
||
635 | daniel-mar | 209 | public function distance($to) { |
210 | if (!is_object($to)) $to = OIDplusObject::parse($to); |
||
1121 | daniel-mar | 211 | if (!$to) return null; |
1116 | daniel-mar | 212 | if (!($to instanceof $this)) return null; |
635 | daniel-mar | 213 | |
214 | $a = $to->other; |
||
215 | $b = $this->other; |
||
216 | |||
217 | if (substr($a,0,1) == '\\') $a = substr($a,1); |
||
218 | if (substr($b,0,1) == '\\') $b = substr($b,1); |
||
219 | |||
220 | $ary = explode('\\', $a); |
||
221 | $bry = explode('\\', $b); |
||
222 | |||
223 | $min_len = min(count($ary), count($bry)); |
||
224 | |||
225 | for ($i=0; $i<$min_len; $i++) { |
||
1116 | daniel-mar | 226 | if ($ary[$i] != $bry[$i]) return null; |
635 | daniel-mar | 227 | } |
228 | |||
229 | return count($ary) - count($bry); |
||
230 | } |
||
231 | |||
1116 | daniel-mar | 232 | /** |
233 | * @return string |
||
234 | */ |
||
235 | public function getDirectoryName(): string { |
||
635 | daniel-mar | 236 | if ($this->isRoot()) return $this->ns(); |
237 | return $this->ns().'_'.md5($this->nodeId(false)); |
||
238 | } |
||
800 | daniel-mar | 239 | |
1116 | daniel-mar | 240 | /** |
241 | * @param string $mode |
||
242 | * @return string |
||
243 | */ |
||
244 | public static function treeIconFilename(string $mode): string { |
||
800 | daniel-mar | 245 | return 'img/'.$mode.'_icon16.png'; |
246 | } |
||
635 | daniel-mar | 247 | } |