Rev 1116 | Rev 1130 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
707 | daniel-mar | 1 | <?php |
2 | |||
3 | /* |
||
4 | * OIDplus 2.0 |
||
1086 | daniel-mar | 5 | * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft |
707 | 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; |
707 | 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 | |||
707 | daniel-mar | 26 | class OIDplusDomain extends OIDplusObject { |
27 | private $domain; |
||
28 | |||
1116 | daniel-mar | 29 | /** |
30 | * @param string $domain |
||
31 | */ |
||
32 | public function __construct(string $domain) { |
||
707 | daniel-mar | 33 | // TODO: syntax checks |
34 | $this->domain = $domain; |
||
35 | } |
||
36 | |||
1116 | daniel-mar | 37 | /** |
38 | * @param string $node_id |
||
39 | * @return OIDplusDomain|null |
||
40 | */ |
||
41 | public static function parse(string $node_id)/*: ?OIDplusDomain*/ { |
||
707 | daniel-mar | 42 | @list($namespace, $domain) = explode(':', $node_id, 2); |
1116 | daniel-mar | 43 | if ($namespace !== self::ns()) return null; |
707 | daniel-mar | 44 | return new self($domain); |
45 | } |
||
46 | |||
1116 | daniel-mar | 47 | /** |
48 | * @return string |
||
49 | */ |
||
50 | public static function objectTypeTitle(): string { |
||
707 | daniel-mar | 51 | return _L('Domain Names'); |
52 | } |
||
53 | |||
1116 | daniel-mar | 54 | /** |
55 | * @return string |
||
56 | */ |
||
57 | public static function objectTypeTitleShort(): string { |
||
707 | daniel-mar | 58 | return _L('Domain'); |
59 | } |
||
60 | |||
1116 | daniel-mar | 61 | /** |
62 | * @return string |
||
63 | */ |
||
64 | public static function ns(): string { |
||
707 | daniel-mar | 65 | return 'domain'; |
66 | } |
||
67 | |||
1116 | daniel-mar | 68 | /** |
69 | * @return string |
||
70 | */ |
||
71 | public static function root(): string { |
||
860 | daniel-mar | 72 | return self::ns().':'; |
707 | daniel-mar | 73 | } |
74 | |||
1116 | daniel-mar | 75 | /** |
76 | * @return bool |
||
77 | */ |
||
78 | public function isRoot(): bool { |
||
707 | daniel-mar | 79 | return $this->domain == ''; |
80 | } |
||
81 | |||
1116 | daniel-mar | 82 | /** |
83 | * @param bool $with_ns |
||
84 | * @return string |
||
85 | */ |
||
86 | public function nodeId(bool $with_ns=true): string { |
||
859 | daniel-mar | 87 | return $with_ns ? self::root().$this->domain : $this->domain; |
707 | daniel-mar | 88 | } |
89 | |||
1116 | daniel-mar | 90 | /** |
91 | * @param string $str |
||
92 | * @return string |
||
93 | * @throws OIDplusException |
||
94 | */ |
||
95 | public function addString(string $str): string { |
||
707 | daniel-mar | 96 | if ($this->isRoot()) { |
859 | daniel-mar | 97 | return self::root().$str; |
707 | daniel-mar | 98 | } else { |
99 | if (strpos($str,'.') !== false) throw new OIDplusException(_L('Please only submit one arc.')); |
||
859 | daniel-mar | 100 | return self::root().$str.'.'.$this->nodeId(false); |
707 | daniel-mar | 101 | } |
102 | } |
||
103 | |||
1116 | daniel-mar | 104 | /** |
105 | * @param OIDplusObject $parent |
||
106 | * @return string |
||
107 | */ |
||
108 | public function crudShowId(OIDplusObject $parent): string { |
||
707 | daniel-mar | 109 | return $this->domain; |
110 | } |
||
111 | |||
1116 | daniel-mar | 112 | /** |
113 | * @return string |
||
114 | * @throws OIDplusException |
||
115 | */ |
||
116 | public function crudInsertSuffix(): string { |
||
707 | daniel-mar | 117 | return $this->isRoot() ? '' : substr($this->addString(''), strlen(self::ns())+1); |
118 | } |
||
119 | |||
1116 | daniel-mar | 120 | /** |
121 | * @param OIDplusObject|null $parent |
||
122 | * @return string |
||
123 | */ |
||
124 | public function jsTreeNodeName(OIDplusObject $parent = null): string { |
||
707 | daniel-mar | 125 | if ($parent == null) return $this->objectTypeTitle(); |
126 | return $this->domain; |
||
127 | } |
||
128 | |||
1116 | daniel-mar | 129 | /** |
130 | * @return string |
||
131 | */ |
||
132 | public function defaultTitle(): string { |
||
707 | daniel-mar | 133 | return $this->domain; |
134 | } |
||
135 | |||
1116 | daniel-mar | 136 | /** |
137 | * @return bool |
||
138 | */ |
||
139 | public function isLeafNode(): bool { |
||
707 | daniel-mar | 140 | return false; |
141 | } |
||
142 | |||
1116 | daniel-mar | 143 | /** |
144 | * @param string $title |
||
145 | * @param string $content |
||
146 | * @param string $icon |
||
147 | * @return void |
||
148 | * @throws OIDplusException |
||
149 | */ |
||
150 | public function getContentPage(string &$title, string &$content, string &$icon) { |
||
801 | daniel-mar | 151 | $icon = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : ''; |
707 | daniel-mar | 152 | |
153 | if ($this->isRoot()) { |
||
154 | $title = OIDplusDomain::objectTypeTitle(); |
||
155 | |||
156 | $res = OIDplus::db()->query("select * from ###objects where parent = ?", array(self::root())); |
||
790 | daniel-mar | 157 | if ($res->any()) { |
962 | daniel-mar | 158 | $content = '<p>'._L('Please select a Domain Name in the tree view at the left to show its contents.').'</p>'; |
707 | daniel-mar | 159 | } else { |
962 | daniel-mar | 160 | $content = '<p>'._L('Currently, no Domain Name is registered in the system.').'</p>'; |
707 | daniel-mar | 161 | } |
162 | |||
163 | if (!$this->isLeafNode()) { |
||
164 | if (OIDplus::authUtils()->isAdminLoggedIn()) { |
||
165 | $content .= '<h2>'._L('Manage root objects').'</h2>'; |
||
166 | } else { |
||
167 | $content .= '<h2>'._L('Available objects').'</h2>'; |
||
168 | } |
||
169 | $content .= '%%CRUD%%'; |
||
170 | } |
||
171 | } else { |
||
172 | $title = $this->getTitle(); |
||
173 | |||
174 | $content = '<h3>'.explode(':',$this->nodeId())[1].'</h3>'; |
||
175 | |||
176 | $content .= '<h2>'._L('Description').'</h2>%%DESC%%'; // TODO: add more meta information about the object type |
||
177 | |||
178 | if (!$this->isLeafNode()) { |
||
179 | if ($this->userHasWriteRights()) { |
||
928 | daniel-mar | 180 | $content .= '<h2>'._L('Create or change subordinate objects').'</h2>'; |
707 | daniel-mar | 181 | } else { |
928 | daniel-mar | 182 | $content .= '<h2>'._L('Subordinate objects').'</h2>'; |
707 | daniel-mar | 183 | } |
184 | $content .= '%%CRUD%%'; |
||
185 | } |
||
186 | } |
||
187 | } |
||
188 | |||
1116 | daniel-mar | 189 | /** |
190 | * @return OIDplusDomain|null |
||
191 | */ |
||
192 | public function one_up()/*: ?OIDplusDomain*/ { |
||
707 | daniel-mar | 193 | $oid = $this->domain; |
194 | |||
195 | $p = strpos($oid, '.'); |
||
713 | daniel-mar | 196 | if ($p === false) return self::parse(''); |
707 | daniel-mar | 197 | |
198 | $oid_up = substr($oid, $p+1); |
||
199 | |||
200 | return self::parse(self::ns().':'.$oid_up); |
||
201 | } |
||
202 | |||
1116 | daniel-mar | 203 | /** |
204 | * @param $to |
||
205 | * @return int|null |
||
206 | */ |
||
707 | daniel-mar | 207 | public function distance($to) { |
208 | if (!is_object($to)) $to = OIDplusObject::parse($to); |
||
1121 | daniel-mar | 209 | if (!$to) return null; |
1116 | daniel-mar | 210 | if (!($to instanceof $this)) return null; |
707 | daniel-mar | 211 | |
212 | $a = $to->domain; |
||
213 | $b = $this->domain; |
||
214 | |||
215 | if (substr($a,-1) == '.') $a = substr($a,0,strlen($a)-1); |
||
216 | if (substr($b,-1) == '.') $b = substr($b,0,strlen($b)-1); |
||
217 | |||
218 | $ary = explode('.', $a); |
||
219 | $bry = explode('.', $b); |
||
220 | |||
221 | $ary = array_reverse($ary); |
||
222 | $bry = array_reverse($bry); |
||
223 | |||
224 | $min_len = min(count($ary), count($bry)); |
||
225 | |||
226 | for ($i=0; $i<$min_len; $i++) { |
||
1116 | daniel-mar | 227 | if ($ary[$i] != $bry[$i]) return null; |
707 | daniel-mar | 228 | } |
229 | |||
230 | return count($ary) - count($bry); |
||
231 | } |
||
232 | |||
1116 | daniel-mar | 233 | /** |
234 | * @return string |
||
235 | */ |
||
236 | public function getDirectoryName(): string { |
||
707 | daniel-mar | 237 | if ($this->isRoot()) return $this->ns(); |
238 | return $this->ns().'_'.md5($this->nodeId(false)); |
||
239 | } |
||
800 | daniel-mar | 240 | |
1116 | daniel-mar | 241 | /** |
242 | * @param string $mode |
||
243 | * @return string |
||
244 | */ |
||
245 | public static function treeIconFilename(string $mode): string { |
||
800 | daniel-mar | 246 | return 'img/'.$mode.'_icon16.png'; |
247 | } |
||
707 | daniel-mar | 248 | } |