Subversion Repositories oidinfo_api

Rev

Rev 21 | Rev 26 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 daniel-mar 1
<?php
2
 
8 daniel-mar 3
/*
4
 * OID-Info.com API for PHP
16 daniel-mar 5
 * Copyright 2019-2021 Daniel Marschall, ViaThinkSoft
24 daniel-mar 6
 * Version 2021-11-24
8 daniel-mar 7
 *
8
 * Licensed under the Apache License, Version 2.0 (the "License");
9
 * you may not use this file except in compliance with the License.
10
 * You may obtain a copy of the License at
11
 *
12
 *     http://www.apache.org/licenses/LICENSE-2.0
13
 *
14
 * Unless required by applicable law or agreed to in writing, software
15
 * distributed under the License is distributed on an "AS IS" BASIS,
16
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17
 * See the License for the specific language governing permissions and
18
 * limitations under the License.
2 daniel-mar 19
 */
20
 
14 daniel-mar 21
// error_reporting(E_ALL | E_NOTICE | E_STRICT | E_DEPRECATED);
2 daniel-mar 22
 
9 daniel-mar 23
if(!defined('STDIN'))  define('STDIN',  fopen('php://stdin',  'rb'));
24
if(!defined('STDOUT')) define('STDOUT', fopen('php://stdout', 'wb'));
25
if(!defined('STDERR')) define('STDERR', fopen('php://stderr', 'wb'));
26
 
2 daniel-mar 27
if (file_exists(__DIR__ . '/oid_utils.inc.phps')) require_once __DIR__ . '/oid_utils.inc.phps';
28
if (file_exists(__DIR__ . '/oid_utils.inc.php'))  require_once __DIR__ . '/oid_utils.inc.php';
29
if (file_exists(__DIR__ . '/xml_utils.inc.phps')) require_once __DIR__ . '/xml_utils.inc.phps';
30
if (file_exists(__DIR__ . '/xml_utils.inc.php'))  require_once __DIR__ . '/xml_utils.inc.php';
4 daniel-mar 31
if (file_exists(__DIR__ . '/../includes/oid_utils.inc.php'))  require_once __DIR__ . '/../includes/oid_utils.inc.php';
32
if (file_exists(__DIR__ . '/../includes/xml_utils.inc.php'))  require_once __DIR__ . '/../includes/xml_utils.inc.php';
33
if (file_exists(__DIR__ . '/../../includes/oid_utils.inc.php'))  require_once __DIR__ . '/../../includes/oid_utils.inc.php';
34
if (file_exists(__DIR__ . '/../../includes/xml_utils.inc.php'))  require_once __DIR__ . '/../../includes/xml_utils.inc.php';
35
if (file_exists(__DIR__ . '/../../../includes/oid_utils.inc.php'))  require_once __DIR__ . '/../../../includes/oid_utils.inc.php';
36
if (file_exists(__DIR__ . '/../../../includes/xml_utils.inc.php'))  require_once __DIR__ . '/../../../includes/xml_utils.inc.php';
2 daniel-mar 37
 
38
class OIDInfoException extends Exception {
39
}
40
 
41
class OIDInfoAPI {
42
 
43
        # --- PART 0: Constants
44
 
45
        // First digit of the ping result
46
        // "-" = error
47
        // "0" = OID does not exist
48
        // "1" = OID does exist, but is not approved yet
49
        // "2" = OID does exist and is accessible
50
        /*private*/ const PING_IDX_EXISTS = 0;
51
 
52
        // Second digit of the ping result
53
        // "-" = error
54
        // "0" = The OID may not be created
55
        // "1" = OID is not an illegal OID, and none of its ascendant is a leaf and its parent OID is not frozen
56
        /*private*/ const PING_IDX_MAY_CREATE = 1;
57
 
58
        /*private*/ const SOFT_CORRECT_BEHAVIOR_NONE = 0;
59
        /*private*/ const SOFT_CORRECT_BEHAVIOR_LOWERCASE_BEGINNING = 1;
60
        /*private*/ const SOFT_CORRECT_BEHAVIOR_ALL_POSSIBLE = 2;
61
 
62
        /*public*/ const DEFAULT_ILLEGALITY_RULE_FILE = __DIR__ . '/oid_illegality_rules';
63
 
64
        # --- Part 1: "Ping API" for checking if OIDs are available or allowed to create
65
 
66
        public $verbosePingProviders = array('https://misc.daniel-marschall.de/oid-repository/ping_oid.php?oid={OID}');
67
 
68
        private $pingCache = array();
69
 
70
        public $pingCacheMaxAge = 3600;
71
 
72
        public function clearPingCache() {
73
                $this->pingCache = array();
74
        }
75
 
76
        public function checkOnlineExists($oid) {
77
                if (!self::strictCheckSyntax($oid)) return false;
78
 
79
                $pingResult = $this->pingOID($oid);
80
                $ret = $pingResult[self::PING_IDX_EXISTS] >= 1;
81
                return $ret;
82
        }
83
 
84
        public function checkOnlineAvailable($oid) {
85
                if (!self::strictCheckSyntax($oid)) return false;
86
 
87
                $pingResult = $this->pingOID($oid);
88
                $ret = $pingResult[self::PING_IDX_EXISTS] == 2;
89
                return $ret;
90
        }
91
 
92
        public function checkOnlineAllowed($oid) {
93
                if (!self::strictCheckSyntax($oid)) return false;
94
 
95
                $pingResult = $this->pingOID($oid);
96
                return $pingResult[self::PING_IDX_MAY_CREATE] == 1;
97
        }
98
 
99
        public function checkOnlineMayCreate($oid) {
100
                if (!self::strictCheckSyntax($oid)) return false;
101
 
102
                $pingResult = $this->pingOID($oid);
103
 
104
                // OID is either illegal, or one of their parents are leaf or frozen
105
                # if (!checkOnlineAllowed($oid)) return false;
106
                if ($pingResult[self::PING_IDX_MAY_CREATE] == 0) return false;
107
 
108
                // The OID exists already, so we don't need to create it again
109
                # if ($this->checkOnlineExists($oid)) return false;
110
                if ($pingResult[self::PING_IDX_EXISTS] >= 1) return false;
111
 
112
                return true;
113
        }
114
 
115
        protected function pingOID($oid) {
116
                if (isset($this->pingCache[$oid])) {
117
                        $cacheAge = $this->pingCache[$oid][0] - time();
118
                        if ($cacheAge <= $this->pingCacheMaxAge) {
119
                                return $this->pingCache[$oid][1];
120
                        }
121
                }
122
 
123
                if (count($this->verbosePingProviders) == 0) {
124
                        throw new OIDInfoException("No verbose ping provider available!");
125
                }
126
 
127
                $res = false;
128
                foreach ($this->verbosePingProviders as $url) {
129
                        $url = str_replace('{OID}', $oid, $url);
130
                        $cn = @file_get_contents($url);
131
                        if ($cn === false) continue;
132
                        $loc_res = trim($cn);
133
                        if (strpos($loc_res, '-') === false) {
134
                                $res = $loc_res;
135
                                break;
136
                        }
137
                }
138
                if ($res === false) {
139
                        throw new OIDInfoException("Could not ping OID $oid status!");
140
                }
141
 
142
                // if ($this->pingCacheMaxAge >= 0) {
143
                        $this->pingCache[$oid] = array(time(), $res);
144
                //}
145
 
146
                return $res;
147
        }
148
 
149
        # --- PART 2: Syntax checking
150
 
151
        public static function strictCheckSyntax($oid) {
152
                return oid_valid_dotnotation($oid, false, false, 1);
153
        }
154
 
155
        // Returns false if $oid has wrong syntax
156
        // Return an OID without leading dot or zeroes, if the syntax is acceptable
157
        public static function trySanitizeOID($oid) {
158
                // Allow leading dots and leading zeroes, but remove then afterwards
159
                $ok = oid_valid_dotnotation($oid, true, true, 1);
160
                if ($ok === false) return false;
161
 
162
                return sanitizeOID($oid, $oid[0] == '.');
163
        }
164
 
165
        # --- PART 3: XML file creation
166
 
167
        protected static function eMailValid($email) {
168
                # TODO: use isemail project
169
 
170
                if (empty($email)) return false;
171
 
172
                if (strpos($email, '@') === false) return false;
173
 
174
                $ary = explode('@', $email, 2);
175
                if (!isset($ary[1])) return false;
176
                if (strpos($ary[1], '.') === false) return false;
177
 
178
                return true;
179
        }
180
 
181
        public function softCorrectEMail($email, $params) {
24 daniel-mar 182
                $params = $this->init_params($params);
183
 
2 daniel-mar 184
                $email = str_replace(' ', '', $email);
185
                $email = str_replace('&', '@', $email);
186
                $email = str_replace('(at)', '@', $email);
187
                $email = str_replace('[at]', '@', $email);
188
                $email = str_replace('(dot)', '.', $email);
189
                $email = str_replace('[dot]', '.', $email);
190
                $email = trim($email);
191
 
192
                if (!$params['allow_illegal_email'] && !self::eMailValid($email)) {
193
                        return '';
194
                }
195
 
196
                return $email;
197
        }
198
 
199
        public function softCorrectPhone($phone, $params) {
24 daniel-mar 200
                $params = $this->init_params($params);
201
 
2 daniel-mar 202
                // TODO: if no "+", add "+1" , but only if address is in USA
203
                // TODO: or use param to fixate country if it is not known
204
                /*
205
                NOTE: with german phone numbers, this will cause trouble, even if we assume "+49"
206
                        06223 / 1234
207
                        shall be
208
                        +49 6223 1234
209
                        and not
210
                        +49 06223 1234
211
                */
212
 
213
                $phone = str_replace('-', ' ', $phone);
214
                $phone = str_replace('.', ' ', $phone);
215
                $phone = str_replace('/', ' ', $phone);
216
                $phone = str_replace('(', ' ', $phone);
217
                $phone = str_replace(')', ' ', $phone);
218
 
219
                // HL7 registry has included this accidently
220
                $phone = str_replace('&quot;', '', $phone);
221
 
222
                $phone = trim($phone);
223
 
224
                return $phone;
225
        }
226
 
5 daniel-mar 227
        private static function strip_to_xhtml_light($str, $allow_strong_text=false) {
228
                // <strong> is allowed in the XSD, but not <b>
2 daniel-mar 229
                $str = str_ireplace('<b>', '<strong>', $str);
230
                $str = str_ireplace('</b>', '</strong>', $str);
231
 
5 daniel-mar 232
                if (!$allow_strong_text) {
233
                        // <strong> is only used for very important things like the word "deprecated". It should therefore not used for anything else
234
                        $str = str_ireplace('<strong>', '', $str);
235
                        $str = str_ireplace('</strong>', '', $str);
236
                }
237
 
2 daniel-mar 238
                $str = preg_replace('@<\s*script.+<\s*/script.*>@isU', '', $str);
239
                $str = preg_replace('@<\s*style.+<\s*/style.*>@isU', '', $str);
240
 
241
                $str = preg_replace_callback(
242
                        '@<(\s*/{0,1}\d*)([^\s/>]+)(\s*[^>]*)>@i',
243
                        function ($treffer) {
244
                                // see http://oid-info.com/xhtml-light.xsd
245
                                $whitelist = array('a', 'br', 'code', 'em', 'font', 'img', 'li', 'strong', 'sub', 'sup', 'ul');
246
 
247
                                $pre = $treffer[1];
248
                                $tag = $treffer[2];
249
                                $attrib = $treffer[3];
250
                                if (in_array($tag, $whitelist)) {
251
                                        return '<'.$pre.$tag.$attrib.'>';
252
                                } else {
253
                                        return '';
254
                                }
255
                        }, $str);
256
 
257
                return $str;
258
        }
259
 
260
        const OIDINFO_CORRECT_DESC_OPTIONAL_ENDING_DOT = 0;
261
        const OIDINFO_CORRECT_DESC_ENFORCE_ENDING_DOT = 1;
262
        const OIDINFO_CORRECT_DESC_DISALLOW_ENDING_DOT = 2;
263
 
264
        public function correctDesc($desc, $params, $ending_dot_policy=self::OIDINFO_CORRECT_DESC_OPTIONAL_ENDING_DOT, $enforce_xhtml_light=false) {
24 daniel-mar 265
                $params = $this->init_params($params);
266
 
2 daniel-mar 267
                $desc = trim($desc);
268
 
269
                $desc = preg_replace('@<!\\[CDATA\\[(.+)\\]\\]>@ismU', '\\1', $desc);
270
 
271
                if (substr_count($desc, '>') != substr_count($desc, '<')) {
272
                        $params['allow_html'] = false;
273
                }
274
 
275
                $desc = str_replace("\r", '', $desc);
276
 
277
                if (!$params['allow_html']) {
278
                        // htmlentities_numeric() does this for us
279
                        /*
280
                        $desc = str_replace('&', '&amp;', $desc);
281
                        $desc = str_replace('<', '&lt;', $desc);
282
                        $desc = str_replace('>', '&gt;', $desc);
283
                        $desc = str_replace('"', '&quot;', $desc);
284
                        $desc = str_replace("'", '&#39;', $desc); // &apos; is not HTML. It is XML
285
                        */
286
 
287
                        $desc = str_replace("\n", '<br />', $desc);
288
                } else {
289
                        // Some problems we had with HL7 registry
290
                        $desc = preg_replace('@&lt;(/{0,1}(p|i|b|u|ul|li))&gt;@ismU', '<\\1>', $desc);
291
                        # preg_match_all('@&lt;[^ :\\@]+&gt;@ismU', $desc, $m);
292
                        # if (count($m[0]) > 0) print_r($m);
293
 
294
                        $desc = preg_replace('@<i>(.+)&lt;i/&gt;@ismU', '<i>\\1</i>', $desc);
295
                        $desc = str_replace('<p><p>', '</p><p>', $desc);
296
 
297
                        // <p> are not supported by oid-info.com
298
                        $desc = str_replace('<p>', '<br /><br />', $desc);
299
                        $desc = str_replace('</p>', '', $desc);
300
                }
301
 
302
                // Escape unicode characters as numeric &#...;
303
                // The XML 1.0 standard does only has a few entities, but nothing like e.g. &euro; , so we prefer numeric
304
 
305
                //$desc = htmlentities_numeric($desc, $params['allow_html']);
306
                if (!$params['allow_html']) $desc = htmlentities($desc);
307
                $desc = html_named_to_numeric_entities($desc);
308
 
309
                // Remove HTML tags which are not allowed
310
                if ($params['allow_html'] && (!$params['ignore_xhtml_light']) && $enforce_xhtml_light) {
311
                        // oid-info.com does only allow a few HTML tags
312
                        // see http://oid-info.com/xhtml-light.xsd
313
                        $desc = self::strip_to_xhtml_light($desc);
314
                }
315
 
316
                // Solve some XML problems...
317
                $desc = preg_replace('@<\s*br\s*>@ismU', '<br/>', $desc); // auto close <br>
318
                $desc = preg_replace('@(href\s*=\s*)(["\'])(.*)&([^#].*)(\2)@ismU', '\1\2\3&amp;\4\5', $desc); // fix "&" inside href-URLs to &amp;
319
                // TODO: what do we do if there are more XHTML errors (e.g. additional open tags) which would make the XML invalid?
320
 
321
                // "Trim" <br/>
13 daniel-mar 322
                $count = 0;
2 daniel-mar 323
                do { $desc = preg_replace('@^\s*<\s*br\s*/{0,1}\s*>@isU', '', $desc, -1, $count); } while ($count > 0); // left trim
324
                do { $desc = preg_replace('@<\s*br\s*/{0,1}\s*>\s*$@isU', '', $desc, -1, $count); } while ($count > 0); // right trim
325
 
326
                // Correct double-encoded stuff
327
                if (!isset($params['tolerant_htmlentities']) || $params['tolerant_htmlentities']) {
328
                        do {
329
                                $old_desc = $desc;
330
                                # Full list of entities: https://www.freeformatter.com/html-entities.html
331
                                # Max: 8 chars ( &thetasym; )
332
                                # Min: 2 chars ( lt,gt,ni,or,ne,le,ge,Mu,Nu,Xi,Pi,mu,nu,xi,pi )
333
                                $desc = preg_replace('@(&|&amp;)(#|&#35;)(\d+);@ismU', '&#\3;', $desc);
334
                                $desc = preg_replace('@(&|&amp;)([a-zA-Z0-9]{2,8});@ismU', '&\2;', $desc);
335
                        } while ($old_desc != $desc);
336
                }
337
 
338
                // TODO: use the complete list of oid-info.com
339
                // TODO: Make this step optional using $params
340
                /*
341
                Array
342
                (
343
                    [0] => Root OID for
344
                    [1] => OID for
345
                    [2] => OID identifying
346
                    [3] => Top arc for
347
                    [4] => Arc for
348
                    [5] => arc root
349
                    [6] => Node for
350
                    [7] => Leaf node for
351
                    [8] => This OID describes
352
                    [9] => [tT]his oid
353
                    [10] => This arc describes
354
                    [11] => This identifies
355
                    [12] => Identifies a
356
                    [13] => [Oo]bject [Ii]dentifier
357
                    [14] => Identifier for
358
                    [15] => This [Ii]dentifier is for
359
                    [16] => Identifiers used by
360
                    [17] => identifier$
361
                    [18] => This branch
362
                    [19] => Branch for
363
                    [20] => Child tree for
364
                    [21] => Child for
365
                    [22] => Subtree for
366
                    [23] => Sub-OID
367
                    [24] => Tree for
368
                    [25] => Child object
369
                    [26] => Parent OID
370
                    [27] =>  root for
371
                    [28] => Assigned for
372
                    [29] => Used to identify
373
                    [30] => Used in
374
                    [31] => Used for
375
                    [32] => For use by
376
                    [33] => Entry for
377
                    [34] => This is for
378
                    [35] =>  ["]?OID["]?
379
                    [36] => ^OID
380
                    [37] =>  OID$
381
                    [38] =>  oid
382
                    [39] =>  oid$
383
                    [40] =>  OIDs
384
                )
385
                $x = 'Root OID for ; OID for ; OID identifying ; Top arc for ; Arc for ; arc root; Node for ; Leaf node for ; This OID describes ; [tT]his oid ; This arc describes ; This identifies ; Identifies a ; [Oo]bject [Ii]dentifier; Identifier for ; This [Ii]dentifier is for ; Identifiers used by ; identifier$; This branch ; Branch for ; Child tree for ; Child for ; Subtree for ; Sub-OID; Tree for ; Child object; Parent OID;  root for ; Assigned for ; Used to identify ; Used in ; Used for ; For use by ; Entry for ; This is for ;  ["]?OID["]? ; ^OID ;  OID$;  oid ;  oid$;  OIDs';
386
                $ary = explode('; ', $x);
387
                print_r($ary);
388
                */
389
                $desc = preg_replace("@^Root OID for the @i",                   '', $desc);
390
                $desc = preg_replace("@^Root OID for @i",                       '', $desc);
391
                $desc = preg_replace("@^OID root for the @i",                   '', $desc);
392
                $desc = preg_replace("@^OID root for @i",                       '', $desc);
393
                $desc = preg_replace("@^This OID will be used for @i",          '', $desc);
394
                $desc = preg_replace("@^This will be a generic OID for the @i", '', $desc);
395
                $desc = preg_replace("@^OID for @i",                            '', $desc);
396
                $desc = preg_replace("@ Root OID$@i",                           '', $desc);
397
                $desc = preg_replace("@ OID$@i",                                '', $desc);
398
                $desc = preg_replace("@ OID Namespace$@i",                      '', $desc);
399
                $desc = preg_replace("@^OID for @i",                            '', $desc);
400
 
401
                $desc = rtrim($desc);
402
                if ($ending_dot_policy == self::OIDINFO_CORRECT_DESC_ENFORCE_ENDING_DOT) {
403
                        if (($desc != '') && (substr($desc, -1)) != '.') $desc .= '.';
404
                } else if ($ending_dot_policy == self::OIDINFO_CORRECT_DESC_DISALLOW_ENDING_DOT) {
405
                        $desc = preg_replace('@\\.$@', '', $desc);
406
                }
407
 
408
                return $desc;
409
        }
410
 
411
        public function xmlAddHeader($firstName, $lastName, $email) {
412
                // TODO: encode
413
 
414
                $firstName = htmlentities_numeric($firstName);
415
                if (empty($firstName)) {
416
                        throw new OIDInfoException("Please supply a first name");
417
                }
418
 
419
                $lastName  = htmlentities_numeric($lastName);
420
                if (empty($lastName)) {
421
                        throw new OIDInfoException("Please supply a last name");
422
                }
423
 
424
                $email     = htmlentities_numeric($email);
425
                if (empty($email)) {
426
                        throw new OIDInfoException("Please supply an email address");
427
                }
428
 
429
//              $out  = "<!DOCTYPE oid-database>\n\n";
430
                $out  = '<?xml version="1.0" encoding="UTF-8" ?>'."\n";
431
                $out .= '<oid-database xmlns="http://oid-info.com"'."\n";
432
                $out .= '              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"'."\n";
433
                $out .= '              xsi:schemaLocation="http://oid-info.com '."\n";
434
                $out .= '                                  http://oid-info.com/oid.xsd">'."\n";
435
                $out .= "\t<submitter>\n";
436
                $out .= "\t\t<first-name>$firstName</first-name>\n";
437
                $out .= "\t\t<last-name>$lastName</last-name>\n";
438
                $out .= "\t\t<email>$email</email>\n";
439
                $out .= "\t</submitter>\n";
440
 
441
                if (!self::eMailValid($email)) {
442
                        throw new OIDInfoException("eMail address '$email' is invalid");
443
                }
444
 
445
                return $out;
446
        }
447
 
448
        public function xmlAddFooter() {
449
                return "</oid-database>\n";
450
        }
451
 
452
        /*
453
                -- CODE TEMPLATE --
454
 
455
                $params['allow_html'] = false; // Allow HTML in <description> and <information>
456
                $params['allow_illegal_email'] = true; // We should allow it, because we don't know if the user has some kind of human-readable anti-spam technique
457
                $params['soft_correct_behavior'] = OIDInfoAPI::SOFT_CORRECT_BEHAVIOR_NONE;
458
                $params['do_online_check'] = false; // Flag to disable this online check, because it generates a lot of traffic and runtime.
459
                $params['do_illegality_check'] = true;
460
                $params['do_simpleping_check'] = true;
461
                $params['auto_extract_name'] = '';
462
                $params['auto_extract_url'] = '';
463
                $params['always_output_comment'] = false; // Also output comment if there was an error (e.g. OID already existing)
464
                $params['creation_allowed_check'] = true;
465
                $params['tolerant_htmlentities'] = true;
466
                $params['ignore_xhtml_light'] = false;
467
 
468
                $elements['synonymous-identifier'] = ''; // string or array
469
                $elements['description'] = '';
470
                $elements['information'] = '';
471
 
472
                $elements['first-registrant']['first-name'] = '';
473
                $elements['first-registrant']['last-name'] = '';
474
                $elements['first-registrant']['address'] = '';
475
                $elements['first-registrant']['email'] = '';
476
                $elements['first-registrant']['phone'] = '';
477
                $elements['first-registrant']['fax'] = '';
478
                $elements['first-registrant']['creation-date'] = '';
479
 
480
                $elements['current-registrant']['first-name'] = '';
481
                $elements['current-registrant']['last-name'] = '';
482
                $elements['current-registrant']['address'] = '';
483
                $elements['current-registrant']['email'] = '';
484
                $elements['current-registrant']['phone'] = '';
485
                $elements['current-registrant']['fax'] = '';
486
                $elements['current-registrant']['modification-date'] = '';
487
 
488
                $oid = '1.2.3';
489
 
490
                $comment = 'test';
491
 
492
                echo $oa->createXMLEntry($oid, $elements, $params, $comment);
493
        */
24 daniel-mar 494
        private function init_params($params) {
2 daniel-mar 495
                // Backward compatibility
496
                if (!isset($params['do_csv_check']))           $params['do_simpleping_check'] = true;
497
 
498
                // Set default behavior
499
                if (!isset($params['allow_html']))             $params['allow_html'] = false; // Allow HTML in <description> and <information>
500
                if (!isset($params['allow_illegal_email']))    $params['allow_illegal_email'] = true; // We should allow it, because we don't know if the user has some kind of human-readable anti-spam technique
501
                if (!isset($params['soft_correct_behavior']))  $params['soft_correct_behavior'] = self::SOFT_CORRECT_BEHAVIOR_NONE;
502
                if (!isset($params['do_online_check']))        $params['do_online_check'] = false; // Flag to disable this online check, because it generates a lot of traffic and runtime.
503
                if (!isset($params['do_illegality_check']))    $params['do_illegality_check'] = true;
504
                if (!isset($params['do_simpleping_check']))    $params['do_simpleping_check'] = true;
505
                if (!isset($params['auto_extract_name']))      $params['auto_extract_name'] = '';
506
                if (!isset($params['auto_extract_url']))       $params['auto_extract_url'] = '';
507
                if (!isset($params['always_output_comment']))  $params['always_output_comment'] = false; // Also output comment if there was an error (e.g. OID already existing)
508
                if (!isset($params['creation_allowed_check'])) $params['creation_allowed_check'] = true;
509
                if (!isset($params['tolerant_htmlentities']))  $params['tolerant_htmlentities'] = true;
510
                if (!isset($params['ignore_xhtml_light']))     $params['ignore_xhtml_light'] = false;
511
 
24 daniel-mar 512
                return $params;
513
        }
514
        public function createXMLEntry($oid, $elements, $params, $comment='') {
515
                $params = $this->init_params($params);
516
 
2 daniel-mar 517
                $out = '';
518
                if (!empty($comment)) $out .= "\t\t<!-- $comment -->\n";
519
 
520
                if ($params['always_output_comment']) {
521
                        $err = $out;
522
                } else {
523
                        $err = false;
524
                }
525
 
526
                if (isset($elements['dotted_oid'])) {
527
                        throw new OIDInfoException("'dotted_oid' in the \$elements array is not supported. Please use the \$oid argument.");
528
                }
529
                if (isset($elements['value'])) {
530
                        // TODO: WHAT SHOULD WE DO WITH THAT?
531
                        throw new OIDInfoException("'value' in the \$elements array is currently not supported.");
532
                }
533
 
534
                $bak_oid = $oid;
535
                $oid = self::trySanitizeOID($oid);
536
                if ($oid === false) {
9 daniel-mar 537
                        fwrite(STDOUT/*STDERR*/,"<!-- ERROR: Ignored '$bak_oid', because it is not a valid OID -->\n");
6 daniel-mar 538
                        return $err;
2 daniel-mar 539
                }
540
 
541
                if ($params['creation_allowed_check']) {
6 daniel-mar 542
                        if (!$this->oidMayCreate($oid, $params['do_online_check'], $params['do_simpleping_check'], $params['do_illegality_check'])) {
9 daniel-mar 543
                                fwrite(STDOUT/*STDERR*/,"<!-- ERROR: Creation of $oid disallowed -->\n");
6 daniel-mar 544
                                return $err;
545
                        }
7 daniel-mar 546
                } else {
547
                        if ($params['do_illegality_check'] && ($this->illegalOid($oid))) {
9 daniel-mar 548
                                fwrite(STDOUT/*STDERR*/,"<!-- ERROR: Creation of $oid disallowed -->\n");
7 daniel-mar 549
                                return $err;
550
                        }
2 daniel-mar 551
                }
552
 
553
                $elements['description'] = $this->correctDesc($elements['description'], $params, self::OIDINFO_CORRECT_DESC_DISALLOW_ENDING_DOT, true);
554
                $elements['information'] = $this->correctDesc($elements['information'], $params, self::OIDINFO_CORRECT_DESC_ENFORCE_ENDING_DOT, true);
555
 
5 daniel-mar 556
                // Request by O.D. 26 August 2019
557
                $elements['description'] = trim($elements['description']);
13 daniel-mar 558
                $m = array();
5 daniel-mar 559
                if (preg_match('@^[a-z]@', $elements['description'], $m)) {
6 daniel-mar 560
                        $ending_dot_policy = self::OIDINFO_CORRECT_DESC_DISALLOW_ENDING_DOT; // for description
5 daniel-mar 561
                        if (($ending_dot_policy != self::OIDINFO_CORRECT_DESC_ENFORCE_ENDING_DOT) && (strpos($elements['description'], ' ') === false)) { // <-- added by DM
562
                                $elements['description'] = '"' . $elements['description'] . '"';
563
                        }
564
                }
565
                // End request by O.D. 26. August 2019
566
 
2 daniel-mar 567
                if ($params['auto_extract_name'] || $params['auto_extract_url']) {
568
                        if (!empty($elements['information'])) $elements['information'] .= '<br /><br />';
569
                        if ($params['auto_extract_name'] || $params['auto_extract_url']) {
570
                                $elements['information'] .= 'Automatically extracted from <a href="'.$params['auto_extract_url'].'">'.$params['auto_extract_name'].'</a>.';
571
                        } else if ($params['auto_extract_name']) {
572
                                $elements['information'] .= 'Automatically extracted from '.$params['auto_extract_name'];
573
                        } else if ($params['auto_extract_url']) {
574
                                $hr_url = $params['auto_extract_url'];
575
                                // $hr_url = preg_replace('@^https{0,1}://@ismU', '', $hr_url);
576
                                $hr_url = preg_replace('@^http://@ismU', '', $hr_url);
577
                                $elements['information'] .= 'Automatically extracted from <a href="'.$params['auto_extract_url'].'">'.$hr_url.'</a>.';
578
                        }
579
                }
580
 
581
                // Validate ASN.1 ID
582
                if (isset($elements['synonymous-identifier'])) {
583
                        if (!is_array($elements['synonymous-identifier'])) {
584
                                $elements['synonymous-identifier'] = array($elements['synonymous-identifier']);
585
                        }
586
                        foreach ($elements['synonymous-identifier'] as &$synid) {
587
                                if ($synid == '') {
588
                                        $synid = null;
589
                                        continue;
590
                                }
591
 
592
                                $behavior = $params['soft_correct_behavior'];
593
 
594
                                if ($behavior == self::SOFT_CORRECT_BEHAVIOR_NONE) {
595
                                        if (!oid_id_is_valid($synid)) $synid = null;
596
                                } else if ($behavior == self::SOFT_CORRECT_BEHAVIOR_LOWERCASE_BEGINNING) {
597
                                        $synid[0] = strtolower($synid[0]);
598
                                        if (!oid_id_is_valid($synid)) $synid = null;
599
                                } else if ($behavior == self::SOFT_CORRECT_BEHAVIOR_ALL_POSSIBLE) {
600
                                        $synid = oid_soft_correct_id($synid);
601
                                        // if (!oid_id_is_valid($synid)) $synid = null;
602
                                } else {
603
                                        throw new OIDInfoException("Unexpected soft-correction behavior for ASN.1 IDs");
604
                                }
605
                        }
606
                }
607
 
608
                // ATTENTION: the XML-generator will always add <dotted-oid> , but what will happen if additionally an
609
                // asn1-path (<value>) is given? (the resulting OIDs might be inconsistent/mismatch)
610
                if (isset($elements['value']) && (!asn1_path_valid($elements['value']))) {
611
                        unset($elements['value']);
612
                }
613
 
614
                // Validate IRI (currently not supported by oid-info.com, but the tag name is reserved)
615
                if (isset($elements['iri'])) {
616
                        if (!is_array($elements['iri'])) {
617
                                $elements['iri'] = array($elements['iri']);
618
                        }
619
                        foreach ($elements['iri'] as &$iri) {
15 daniel-mar 620
                                // Do not allow Numeric-only. It would only be valid in an IRI path, but not in a single identifier
2 daniel-mar 621
                                if (!iri_arc_valid($iri, false)) $iri = null;
622
                        }
623
                }
624
 
625
                if (isset($elements['first-registrant']['phone']))
626
                $elements['first-registrant']['phone']   = $this->softCorrectPhone($elements['first-registrant']['phone'], $params);
627
 
628
                if (isset($elements['current-registrant']['phone']))
629
                $elements['current-registrant']['phone'] = $this->softCorrectPhone($elements['current-registrant']['phone'], $params);
630
 
631
                if (isset($elements['first-registrant']['fax']))
632
                $elements['first-registrant']['fax']     = $this->softCorrectPhone($elements['first-registrant']['fax'], $params);
633
 
634
                if (isset($elements['current-registrant']['fax']))
635
                $elements['current-registrant']['fax']   = $this->softCorrectPhone($elements['current-registrant']['fax'], $params);
636
 
637
                if (isset($elements['first-registrant']['email']))
638
                $elements['first-registrant']['email']   = $this->softCorrectEMail($elements['first-registrant']['email'], $params);
639
 
640
                if (isset($elements['current-registrant']['email']))
641
                $elements['current-registrant']['email'] = $this->softCorrectEMail($elements['current-registrant']['email'], $params);
642
 
643
                // TODO: if name is empty, but address has 1 line, take it as firstname (but remove hyperlink)
644
 
645
                $out_loc = '';
646
                foreach ($elements as $name => $val) {
647
                        if (($name == 'first-registrant') || ($name == 'current-registrant')) {
648
                                $out_loc2 = '';
649
                                foreach ($val as $name2 => $val2) {
650
                                        if (is_null($val2)) continue;
651
                                        if (empty($val2)) continue;
652
 
653
                                        if (!is_array($val2)) $val2 = array($val2);
654
 
655
                                        foreach ($val2 as $val3) {
656
                                                // if (is_null($val3)) continue;
657
                                                if (empty($val3)) continue;
658
 
659
                                                if ($name2 == 'address') {
660
                                                        // $val3 = htmlentities_numeric($val3);
661
                                                        $val3 = $this->correctDesc($val3, $params, self::OIDINFO_CORRECT_DESC_DISALLOW_ENDING_DOT, true);
662
                                                } else {
663
                                                        // $val3 = htmlentities_numeric($val3);
664
                                                        $val3 = $this->correctDesc($val3, $params, self::OIDINFO_CORRECT_DESC_DISALLOW_ENDING_DOT, false);
665
                                                }
666
                                                $out_loc2 .= "\t\t\t<$name2>".$val3."</$name2>\n";
667
                                        }
668
                                }
669
 
670
                                if (!empty($out_loc2)) {
671
                                        $out_loc .= "\t\t<$name>\n";
672
                                        $out_loc .= $out_loc2;
673
                                        $out_loc .= "\t\t</$name>\n";
674
                                }
675
                        } else {
676
                                // if (is_null($val)) continue;
677
                                if (empty($val) && ($name != 'description')) continue; // description is mandatory, according to http://oid-info.com/oid.xsd
678
 
679
                                if (!is_array($val)) $val = array($val);
680
 
681
                                foreach ($val as $val2) {
682
                                        // if (is_null($val2)) continue;
683
                                        if (empty($val2) && ($name != 'description')) continue; // description is mandatory, according to http://oid-info.com/oid.xsd
684
 
685
                                        if (($name != 'description') && ($name != 'information')) { // don't correctDesc description/information, because we already did it above.
686
                                                // $val2 = htmlentities_numeric($val2);
687
                                                $val2 = $this->correctDesc($val2, $params, self::OIDINFO_CORRECT_DESC_OPTIONAL_ENDING_DOT, false);
688
                                        }
689
                                        $out_loc .= "\t\t<$name>".$val2."</$name>\n";
690
                                }
691
                        }
692
                }
693
 
694
                if (!empty($out)) {
695
                        $out = "\t<oid>\n"."\t\t".trim($out)."\n";
696
                } else {
697
                        $out = "\t<oid>\n";
698
                }
699
                $out .= "\t\t<dot-notation>$oid</dot-notation>\n";
700
                $out .= $out_loc;
701
                $out .= "\t</oid>\n";
702
 
703
                return $out;
704
        }
705
 
706
        # --- PART 4: Offline check if OIDs are illegal
707
 
708
        protected $illegality_rules = array();
709
 
710
        public function clearIllegalityRules() {
711
                $this->illegality_rules = array();
712
        }
713
 
714
        public function loadIllegalityRuleFile($file) {
715
                if (!file_exists($file)) {
716
                        throw new OIDInfoException("Error: File '$file' does not exist");
717
                }
718
 
719
                $lines = file($file);
720
 
721
                if ($lines === false) {
722
                        throw new OIDInfoException("Error: Could not load '$file'");
723
                }
724
 
725
                $signature = trim(array_shift($lines));
726
                if (($signature != '[1.3.6.1.4.1.37476.3.1.5.1]') && ($signature != '[1.3.6.1.4.1.37476.3.1.5.2]')) {
727
                        throw new OIDInfoException("'$file' does not seem to a valid illegality rule file (file format OID does not match. Signature $signature unexpected)");
728
                }
729
 
730
                foreach ($lines as $line) {
731
                        // Remove comments
732
                        $ary  = explode('--', $line);
733
                        $rule = trim($ary[0]);
734
 
735
                        if ($rule !== '') $this->addIllegalityRule($rule);
736
                }
737
        }
738
 
739
        public function addIllegalityRule($rule) {
740
                $test = $rule;
741
                $test = preg_replace('@\\.\\(!\\d+\\)@ismU', '.0', $test); // added in ver 2
742
                $test = preg_replace('@\\.\\(\\d+\\+\\)@ismU', '.0', $test);
743
                $test = preg_replace('@\\.\\(\\d+\\-\\)@ismU', '.0', $test);
744
                $test = preg_replace('@\\.\\(\\d+\\-\\d+\\)@ismU', '.0', $test);
745
                $test = preg_replace('@\\.\\*@ismU', '.0', $test);
746
 
747
                if (!oid_valid_dotnotation($test, false, false, 1)) {
748
                        throw new OIDInfoException("Illegal illegality rule '$rule'.");
749
                }
750
 
751
                $this->illegality_rules[] = $rule;
752
        }
753
 
7 daniel-mar 754
        private static function bigint_cmp($a, $b) {
755
                if (function_exists('bccomp')) {
756
                        return bccomp($a, $b);
757
                }
758
 
759
                if (function_exists('gmp_cmp')) {
760
                        return gmp_cmp($a, $b);
761
                }
762
 
763
                if ($a > $b) return 1;
764
                if ($a < $b) return -1;
765
                return 0;
766
        }
767
 
2 daniel-mar 768
        public function illegalOID($oid, &$illegal_root='') {
769
                $bak = $oid;
770
                $oid = self::trySanitizeOID($oid);
771
                if ($oid === false) {
772
                        $illegal_root = $bak;
773
                        return true; // is illegal
774
                }
775
 
776
                $rules = $this->illegality_rules;
777
 
778
                foreach ($rules as $rule) {
779
                        $rule = str_replace(array('(', ')'), '', $rule);
780
 
781
                        $oarr = explode('.', $oid);
782
                        $rarr = explode('.', $rule);
783
 
784
                        if (count($oarr) < count($rarr)) continue;
785
 
786
                        $rulefit = true;
787
 
788
                        $illrootary = array();
789
 
790
                        $vararcs = 0;
791
                        $varsfit = 0;
792
                        for ($i=0; $i<count($rarr); $i++) {
793
                                $oelem = $oarr[$i];
794
                                $relem = $rarr[$i];
795
 
796
                                $illrootary[] = $oelem;
797
 
798
                                if ($relem == '*') $relem = '0+';
799
 
800
                                $startchar = substr($relem, 0, 1);
801
                                $endchar = substr($relem, -1, 1);
802
                                if ($startchar == '!') { // added in ver 2
803
                                        $vararcs++;
804
                                        $relem = substr($relem, 1, strlen($relem)-1); // cut away first char
7 daniel-mar 805
                                        $cmp = self::bigint_cmp($oelem, $relem) != 0;
806
                                        if ($cmp) $varsfit++;
2 daniel-mar 807
                                } else if ($endchar == '+') {
808
                                        $vararcs++;
809
                                        $relem = substr($relem, 0, strlen($relem)-1); // cut away last char
7 daniel-mar 810
                                        $cmp = self::bigint_cmp($oelem, $relem) >= 0;
811
                                        if ($cmp) $varsfit++;
2 daniel-mar 812
                                } else if ($endchar == '-') {
813
                                        $vararcs++;
814
                                        $relem = substr($relem, 0, strlen($relem)-1); // cut away last char
7 daniel-mar 815
                                        $cmp = self::bigint_cmp($oelem, $relem) <= 0;
816
                                        if ($cmp) $varsfit++;
2 daniel-mar 817
                                } else if (strpos($relem, '-') !== false) {
818
                                        $vararcs++;
819
                                        $limarr = explode('-', $relem);
820
                                        $limmin = $limarr[0];
821
                                        $limmax = $limarr[1];
7 daniel-mar 822
                                        $cmp_min = self::bigint_cmp($oelem, $limmin) >= 0;
823
                                        $cmp_max = self::bigint_cmp($oelem, $limmax) <= 0;
824
                                        if ($cmp_min && $cmp_max) $varsfit++;
2 daniel-mar 825
                                } else {
826
                                        if ($relem != $oelem) {
827
                                                $rulefit = false;
828
                                                break;
829
                                        }
830
                                }
831
                        }
832
 
833
                        if ($rulefit && ($vararcs == $varsfit)) {
834
                                $illegal_root = implode('.', $illrootary);
835
                                return true; // is illegal
836
                        }
837
                }
838
 
839
                $illegal_root = '';
840
                return false; // not illegal
841
        }
842
 
843
        # --- PART 5: Misc functions
844
 
845
        function __construct() {
846
                if (file_exists(self::DEFAULT_ILLEGALITY_RULE_FILE)) {
847
                        $this->loadIllegalityRuleFile(self::DEFAULT_ILLEGALITY_RULE_FILE);
848
                }
849
        }
850
 
851
        public static function getPublicURL($oid) {
852
                return "http://oid-info.com/get/$oid";
853
        }
854
 
855
        public function oidExisting($oid, $onlineCheck=true, $useSimplePingProvider=true) {
856
                $bak_oid = $oid;
857
                $oid = self::trySanitizeOID($oid);
858
                if ($oid === false) {
859
                        throw new OIDInfoException("'$bak_oid' is not a valid OID");
860
                }
861
 
862
                $canuseSimplePingProvider = $useSimplePingProvider && $this->simplePingProviderAvailable();
863
                if ($canuseSimplePingProvider) {
864
                        if ($this->simplePingProviderCheckOID($oid)) return true;
865
                }
866
                if ($onlineCheck) {
867
                        return $this->checkOnlineExists($oid);
868
                }
869
                if ((!$canuseSimplePingProvider) && (!$onlineCheck)) {
870
                        throw new OIDInfoException("No simple or verbose checking method chosen/available");
871
                }
872
                return false;
873
        }
874
 
875
        public function oidMayCreate($oid, $onlineCheck=true, $useSimplePingProvider=true, $illegalityCheck=true) {
876
                $bak_oid = $oid;
877
                $oid = self::trySanitizeOID($oid);
878
                if ($oid === false) {
879
                        throw new OIDInfoException("'$bak_oid' is not a valid OID");
880
                }
881
 
882
                if ($illegalityCheck && $this->illegalOID($oid)) return false;
883
 
884
                $canuseSimplePingProvider = $useSimplePingProvider && $this->simplePingProviderAvailable();
885
                if ($canuseSimplePingProvider) {
886
                        if ($this->simplePingProviderCheckOID($oid)) return false;
887
                }
888
                if ($onlineCheck) {
889
                        return $this->checkOnlineMayCreate($oid);
890
                }
891
                if ((!$canuseSimplePingProvider) && (!$onlineCheck)) {
892
                        throw new OIDInfoException("No simple or verbose checking method chosen/available");
893
                }
894
                return true;
895
        }
896
 
897
        # --- PART 6: Simple Ping Providers
898
        # TODO: Question ... can't these provider concepts (SPP and VPP) not somehow be combined?
899
 
900
        protected $simplePingProviders = array();
901
 
902
        public function addSimplePingProvider($addr) {
903
                if (!isset($this->simplePingProviders[$addr])) {
904
                        if (strtolower(substr($addr, -4, 4)) == '.csv') {
905
                                $this->simplePingProviders[$addr] = new CSVSimplePingProvider($addr);
906
                        } else {
907
                                $this->simplePingProviders[$addr] = new OIDSimplePingProvider($addr);
908
                                // $this->simplePingProviders[$addr]->connect();
909
                        }
910
                }
911
                return $this->simplePingProviders[$addr];
912
        }
913
 
914
        public function removeSimplePingProvider($addr) {
915
                $this->simplePingProviders[$addr]->disconnect();
916
                unset($this->simplePingProviders[$addr]);
917
        }
918
 
919
        public function removeAllSimplePingProviders() {
920
                foreach ($this->simplePingProviders as $addr => $obj) {
921
                        $this->removeSimplePingProvider($addr);
922
                }
923
        }
924
 
925
        public function listSimplePingProviders() {
926
                $out = array();
927
                foreach ($this->simplePingProviders as $addr => $obj) {
928
                        $out[] = $addr;
929
                }
930
                return $out;
931
        }
932
 
933
        public function simplePingProviderCheckOID($oid) {
934
                if (!$this->simplePingProviderAvailable()) {
935
                        throw new OIDInfoException("No simple ping providers available.");
936
                }
937
 
938
                $one_null = false;
13 daniel-mar 939
                foreach ($this->simplePingProviders as /*$addr =>*/ $obj) {
2 daniel-mar 940
                        $res = $obj->queryOID($oid);
941
                        if ($res) return true;
942
                        if ($res !== false) $one_null = true;
943
                }
944
 
945
                return $one_null ? null : false;
946
        }
947
 
948
        public function simplePingProviderAvailable() {
949
                return count($this->simplePingProviders) >= 1;
950
        }
951
 
952
}
953
 
954
interface IOIDSimplePingProvider {
955
        public function queryOID($oid);
956
        public function disconnect();
957
        public function connect();
958
}
959
 
960
class CSVSimplePingProvider implements IOIDSimplePingProvider {
961
        protected $csvfile = '';
962
        protected $lines = array();
963
        protected $filemtime = 0;
964
 
965
        public function queryOID($oid) {
966
                $this->reloadCSV();
967
                return in_array($oid, $this->lines);
968
        }
969
 
970
        public function disconnect() {
971
                // Nothing
972
        }
973
 
974
        public function connect() {
975
                // Nothing
976
        }
977
 
978
        // TODO: This cannot handle big CSVs. We need to introduce the old code of "2016-09-02_old_oidinfo_api_with_csv_reader.zip" here.
979
        protected function reloadCSV() {
980
                if (!file_exists($this->csvfile)) {
981
                        throw new OIDInfoException("File '".$this->csvfile."' does not exist");
982
                }
983
                $filemtime = filemtime($this->csvfile);
984
                if ($filemtime != $this->filemtime) {
13 daniel-mar 985
                        $this->lines = file($this->csvfile);
2 daniel-mar 986
                        $this->filemtime = $filemtime;
987
                }
988
        }
989
 
990
        function __construct($csvfile) {
991
                $this->csvfile = $csvfile;
992
                $this->reloadCSV();
993
        }
994
}
995
 
996
 
997
class OIDSimplePingProvider implements IOIDSimplePingProvider {
998
        protected $addr = '';
999
        protected $connected = false;
1000
        protected $socket = null;
1001
 
15 daniel-mar 1002
        const SPP_MAX_CONNECTION_ATTEMPTS = 3; // TODO: Put into an OIDInfoAPI class...?
2 daniel-mar 1003
 
1004
        const DEFAULT_PORT = 49500;
1005
 
1006
        protected function spp_reader_init() {
1007
                $this->spp_reader_uninit();
1008
 
16 daniel-mar 1009
                $ary = explode(':', $this->addr); // TODO: does not work with an IPv6 address
2 daniel-mar 1010
                $host = $ary[0];
1011
                $service_port = isset($ary[1]) ? $ary[1] : self::DEFAULT_PORT;
16 daniel-mar 1012
 
1013
                $is_ip = filter_var($host, FILTER_VALIDATE_IP) !== false;
1014
                if (!$is_ip) {
1015
                        $address = @gethostbyname($host);
1016
                        if ($address === $host) {
21 daniel-mar 1017
                                $msg = "gethostbyname() failed.\n"; // TODO: exceptions? (also all "echos" below)
1018
                                throw new Exception($msg);
1019
                                // echo $msg;
1020
                                // return false;
16 daniel-mar 1021
                        }
1022
                } else {
1023
                        $address = $host;
2 daniel-mar 1024
                }
16 daniel-mar 1025
 
2 daniel-mar 1026
                $this->socket = @socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
1027
                if ($this->socket === false) {
21 daniel-mar 1028
                        $msg = "socket_create() failed: " . socket_strerror(socket_last_error()) . "\n";
1029
                        throw new Exception($msg);
1030
                        // echo $msg;
1031
                        // return false;
2 daniel-mar 1032
                }
1033
                $result = @socket_connect($this->socket, $address, $service_port);
1034
                if ($result === false) {
21 daniel-mar 1035
                        $msg = "socket_connect() failed: " . socket_strerror(socket_last_error($this->socket)) . "\n";
1036
                        throw new Exception($msg);
1037
                        // echo $msg;
1038
                        // return false;
2 daniel-mar 1039
                }
1040
 
1041
                $this->connected = true;
1042
        }
1043
 
1044
        protected function spp_reader_avail($oid, $failcount=0) {
1045
                $in = "${oid}\n\0"; // PHP's socket_send() does not send a trailing \n . There needs to be something after the \n ... :(
1046
 
1047
                if ($failcount >= self::SPP_MAX_CONNECTION_ATTEMPTS) {
21 daniel-mar 1048
                        $msg = "Query $oid: CONNECTION TO SIMPLE PING PROVIDER FAILED!\n";
1049
                        throw new Exception($msg);
1050
                        // echo $msg;
1051
                        // return null;
2 daniel-mar 1052
                }
1053
 
1054
                if (!$this->connected) {
1055
                        $this->spp_reader_init();
1056
                }
1057
 
1058
                $s = @socket_send($this->socket, $in, strlen($in), 0);
1059
                if ($s != strlen($in)) {
1060
                        // echo "Query $oid: Sending failed\n";
1061
                        $this->spp_reader_init();
1062
                        if (!$this->socket) return null;
1063
                        return $this->spp_reader_avail($oid, $failcount+1);
1064
                }
1065
 
1066
                $out = @socket_read($this->socket, 2048);
1067
                if (trim($out) == '1') {
1068
                        return true;
1069
                } else if (trim($out) == '0') {
1070
                        return false;
1071
                } else {
1072
                        // echo "Query $oid: Receiving failed\n";
1073
                        $this->spp_reader_init();
1074
                        if (!$this->socket) return null;
1075
                        return $this->spp_reader_avail($oid, $failcount+1);
1076
                }
1077
        }
1078
 
1079
        protected function spp_reader_uninit() {
1080
                if (!$this->connected) return;
1081
                @socket_close($this->socket);
1082
                $this->connected = false;
1083
        }
1084
 
1085
        public function queryOID($oid) {
1086
                if (trim($oid) === 'bye') return null;
1087
                return $this->spp_reader_avail($oid);
1088
        }
1089
 
1090
        public function disconnect() {
1091
                return $this->spp_reader_uninit();
1092
        }
1093
 
1094
        public function connect() {
1095
                return $this->spp_reader_init();
1096
        }
1097
 
1098
        function __construct($addr='localhost:49500') {
1099
                $this->addr = $addr;
1100
        }
1101
 
1102
}