WebSVN – oidplus – Diff – /trunk/plugins/viathinksoft/adminPages/120_registration/OIDplusPageAdminRegistration.class.php

         /*private*/ const QUERY_REGISTER_V1 =         '1.3.6.1.4.1.37476.2.5.2.1.1.1';
         /*private*/ const QUERY_UNREGISTER_V1 =       '1.3.6.1.4.1.37476.2.5.2.1.2.1';
         /*private*/ const QUERY_LISTALLSYSTEMIDS_V1 = '1.3.6.1.4.1.37476.2.5.2.1.3.1';
         /*private*/ const QUERY_LIVESTATUS_V1 =       '1.3.6.1.4.1.37476.2.5.2.1.4.1';
+        /**
+         * @param string $actionID
+         * @return bool
+         */
-        public function csrfUnlock($actionID) {
+        public function csrfUnlock(string $actionID): bool {
                 if ($actionID == 'verify_pubkey') return true;
                 return parent::csrfUnlock($actionID);
+        }
+        /**
+         * @param string $actionID
+         * @param array $params
+         * @return array
+         * @throws OIDplusException
+         */
-        public function action($actionID, $params) {
+        public function action(string $actionID, array $params): array {
                 if ($actionID == 'verify_pubkey') {
                         _CheckParamExists($params, 'challenge');
                         $payload = 'oidplus-verify-pubkey:'.sha3_512($params['challenge']);
                         return array(
                                 "status" => 0,
                                 "response" => base64_encode($signature)
                         );
                 } else {
-                        throw new OIDplusException(_L('Unknown action ID'));
+                        return parent::action($actionID, $params);
+                }
+        }
+        /**
+         * @param string $id
+         * @param array $out
+         * @param bool $handled
+         * @return void
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
-        public function gui($id, &$out, &$handled) {
+        public function gui(string $id, array &$out, bool &$handled) {
                 if ($id === 'oidplus:srv_registration') {
                         $handled = true;
                         $out['title'] = _L('System registration settings');
                         $out['icon'] = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : '';
                         $out['text']  = '<p><a '.OIDplus::gui()->link('oidplus:srv_registration').'><img src="img/arrow_back.png" width="16" alt="'._L('Go back').'"> '._L('Go back to registration settings').'</a></p>' .
                                         $json['content'];
+                }
+        }
+        /**
+         * @return bool
+         * @throws OIDplusException
+         */
-        protected function areWeRegistered() {
+        protected function areWeRegistered(): bool {
                 // To check if we are registered. Check it "anonymously" (i.e. without revealing our system ID)
                 $res = url_get_contents('https://oidplus.viathinksoft.com/reg2/query.php?query='.self::QUERY_LISTALLSYSTEMIDS_V1);
                 $json = @json_decode($res, true);
                 $list = $json['list'];
                 return in_array(OIDplus::getSystemId(false), $list);
+        }
+        /**
+         * @param $privacy_level
+         * @return false|void
+         * @throws OIDplusException
+         */
         public function sendRegistrationQuery($privacy_level=null) {
                 if (is_null($privacy_level)) {
                         $privacy_level = OIDplus::config()->getValue('reg_privacy');
+                }
                                 if (!$json) {
                                         return false; // throw new OIDplusException(_L('JSON reply from ViaThinkSoft decoding error: %1',$res));
+                                }
                                 if (isset($json['error']) || ($json['status'] < 0)) {
-                                        if (isset($json['error'])) {
-                                                return false; // throw new OIDplusException(_L('Received error status code: %1',$json['error']));
-                                        } else {
-                                                return false; // throw new OIDplusException(_L('Received error status code: %1',$json['status']));
+                                        return false; // throw new OIDplusException(_L('Received error status code: %1',isset($json['error']) ? $json['error'] : $json['status']));
-                                        }
+                                }
+                        }
                 } else {
                         if ($privacy_level == 0) {
                                 $adminExportPlugin = OIDplus::getPluginByOid('1.3.6.1.4.1.37476.2.5.2.4.3.400'); // OIDplusPageAdminOIDInfoExport
                                 if (isset($json['vts_ca'])) OIDplus::config()->setValue('vts_ca', $json['vts_ca']);
+                        }
+                }
+        }
+        /**
+         * @param bool $html
+         * @return void
+         * @throws OIDplusException
+         */
-        public function init($html=true) {
+        public function init(bool $html=true) {
                 if (OIDplus::getEditionInfo()['vendor'] != 'ViaThinkSoft') {
                         throw new OIDplusException(_L('This plugin is only available in the ViaThinkSoft edition of OIDplus'));
+                }
                 // Note: It is important that the default value is '2', otherwise, systems which don't have CURL will fail
+                                }
+                        }
+                }
+        }
+        /**
+         * @param array $json
+         * @param string|null $ra_email
+         * @param bool $nonjs
+         * @param string $req_goto
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function tree(&$json, $ra_email=null, $nonjs=false, $req_goto='') {
+        public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool {
                 if (!OIDplus::authUtils()->isAdminLoggedIn()) return false;
                 if (file_exists(__DIR__.'/img/main_icon16.png')) {
                         $tree_icon = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon16.png';
                 } else {
                 );
                 return true;
+        }
+        /**
+         * @param string $request
+         * @return array|false
+         */
-        public function tree_search($request) {
+        public function tree_search(string $request) {
                 return false;
+        }
+        /**
+         * @param string $id
+         * @return bool
+         */
-        public function implementsFeature($id) {
+        public function implementsFeature(string $id): bool {
                 if (strtolower($id) == '1.3.6.1.4.1.37476.2.5.2.3.1') return true; // oobeEntry, oobeRequested
                 if (strtolower($id) == '1.3.6.1.4.1.37476.2.5.2.3.8') return true; // getNotifications()
                 return false;
+        }
+        /**
+         * Implements interface 1.3.6.1.4.1.37476.2.5.2.3.1
+         * @return bool
+         * @throws OIDplusException
+         */
         public function oobeRequested(): bool {
-                // Interface 1.3.6.1.4.1.37476.2.5.2.3.1
                 return OIDplus::config()->getValue('oobe_registration_done') == '0';
+        }
+        /**
+         * Implements interface 1.3.6.1.4.1.37476.2.5.2.3.1
+         * @param $step
+         * @param $do_edits
+         * @param $errors_happened
+         * @return void
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         public function oobeEntry($step, $do_edits, &$errors_happened)/*: void*/ {
-                // Interface 1.3.6.1.4.1.37476.2.5.2.3.1
                 echo '<h2>'._L('Step %1: System registration and automatic publishing (optional)',$step).'</h2>';
                 if (file_exists(__DIR__ . '/info$'.OIDplus::getCurrentLang().'.html')) {
                         $info = file_get_contents(__DIR__ . '/info$'.OIDplus::getCurrentLang().'.html');
                 } else {
                 echo '<p>'._L('<i>Privacy information:</i> This setting can always be changed in the administrator login / control panel.').'<br>';
                 echo _L('<a %1>Click here</a> for more information about privacy related topics.','href="../../../../res/OIDplus/privacy_documentation.html" target="_blank"');
                 echo '</p>';
+        }
+        /**
+         * Implements interface 1.3.6.1.4.1.37476.2.5.2.3.8
+         * @param $user
+         * @return array
+         * @throws OIDplusException
+         */
         public function getNotifications($user=null): array {
-                // Interface 1.3.6.1.4.1.37476.2.5.2.3.8
                 $notifications = array();
                 if ((!$user || ($user == 'admin')) && OIDplus::authUtils()->isAdminLoggedIn()) {
                         if (!function_exists('curl_init')) {
                                 $title = _L('System registration');
                                 $notifications[] = array('ERR', _L('OIDplus plugin "%1" is enabled, but the required PHP extension "%2" is not installed.', '<a '.OIDplus::gui()->link('oidplus:srv_registration').'>'.htmlentities($title).'</a>', 'php_curl'));

Subversion Repositories oidplus

oidplus/trunk/plugins/viathinksoft/adminPages/120_registration/OIDplusPageAdminRegistration.class.php – Rev 1086 → 1116