Inheritance diagram for ilNICKeyRegisteredObjective:

Collaboration diagram for ilNICKeyRegisteredObjective:

Public Member Functions
	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

Public Member Functions inherited from ilSetupObjective
	__construct (\ilSetupConfig $config)

Data Fields
const	MAX_REDIRECTS = 5

const	SOCKET_TIMEOUT = 5

const	ILIAS_NIC_SERVER = "https://nic.ilias.de/index.php"

Protected Member Functions
	getURLStringForNIC ($settings, \ilSystemFolderSetupConfig $systemfolder_config, \ilHttpSetupConfig $http_config)

	getCurlConnection (string $url)

Additional Inherited Members
Protected Attributes inherited from ilSetupObjective
	$config

Detailed Description

Definition at line 7 of file class.ilNICKeyRegisteredObjective.php.

Member Function Documentation

◆ achieve()

ilNICKeyRegisteredObjective::achieve ( Setup\Environment $environment )

Definition at line 38 of file class.ilNICKeyRegisteredObjective.php.

References $factory, $GLOBALS, XapiProxy\$req, $response, $url, ilCurlConnection\_isCurlExtensionLoaded(), getCurlConnection(), and getURLStringForNIC().

                                                             : Setup\Environment
     {
         $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
         $settings = $factory->settingsFor("common");
         $systemfolder_config = $environment->getConfigFor("systemfolder");
         $http_config = $environment->getConfigFor("http");
 
         if (!\ilCurlConnection::_isCurlExtensionLoaded()) {
             throw new Setup\UnachievableException(
                 "CURL extension is required to register NIC."
             );
         }
 
         //ATTENTION: This makes ilProxySettings work. It uses global ilSetting...
         $old_settings = $GLOBALS["ilSetting"] ?? null;
         $GLOBALS["ilSetting"] = $settings;
 
         $url = $this->getURLStringForNIC($settings, $systemfolder_config, $http_config);
         $req = $this->getCurlConnection($url);
         $response = $req->exec();
         $req->parseResponse($response);
 
         if ($req->getInfo()["http_code"] != "200") {
             $settings->set("nic_enabled", "-1");
             throw new Setup\UnachievableException(
                 "Could not connect to NIC server at \"" . self::ILIAS_NIC_SERVER . "\""
             );
         }
 
         $status = explode("\n", $req->getResponseBody());
         $settings->set("nic_enabled", "1");
         $settings->set("inst_id", $status[2]);
 
         $GLOBALS["ilSetting"] = $old_settings;
 
         return $environment;
     }

Here is the call graph for this function:

◆ getCurlConnection()

ilNICKeyRegisteredObjective::getCurlConnection ( string $url )

protected

Definition at line 97 of file class.ilNICKeyRegisteredObjective.php.

References XapiProxy\$req.

Referenced by achieve().

     {
         $req = new \ilCurlConnection($url);
         $req->init();
 
         $req->setOpt(CURLOPT_HEADER, 1);
         $req->setOpt(CURLOPT_RETURNTRANSFER, 1);
         $req->setOpt(CURLOPT_CONNECTTIMEOUT, self::SOCKET_TIMEOUT);
         $req->setOpt(CURLOPT_MAXREDIRS, self::MAX_REDIRECTS);
 
         return $req;
     }

Here is the caller graph for this function:

◆ getHash()

ilNICKeyRegisteredObjective::getHash ( )

Definition at line 13 of file class.ilNICKeyRegisteredObjective.php.

                               : string
     {
         return hash("sha256", self::class);
     }

◆ getLabel()

ilNICKeyRegisteredObjective::getLabel ( )

Definition at line 18 of file class.ilNICKeyRegisteredObjective.php.

                                : string
     {
         return "The NIC key is registered at the ILIAS Open Source society";
     }

◆ getPreconditions()

ilNICKeyRegisteredObjective::getPreconditions ( Setup\Environment $environment )

Definition at line 28 of file class.ilNICKeyRegisteredObjective.php.

                                                                      : array
     {
         $http_config = $environment->getConfigFor("http");
         return [
             new \ilNICKeyStoredObjective($this->config),
             new \ilSettingsFactoryExistsObjective(),
             new \ilHttpConfigStoredObjective($http_config)
         ];
     }

◆ getURLStringForNIC()

ilNICKeyRegisteredObjective::getURLStringForNIC	(		$settings,
		\ilSystemFolderSetupConfig	$systemfolder_config,
		\ilHttpSetupConfig	$http_config
	)

protected

Definition at line 76 of file class.ilNICKeyRegisteredObjective.php.

References $url, ilSystemFolderSetupConfig\getClientDescription(), ilSystemFolderSetupConfig\getClientName(), ilSystemFolderSetupConfig\getContactEMail(), ilSystemFolderSetupConfig\getContactFirstname(), ilSystemFolderSetupConfig\getContactLastname(), and ilHttpSetupConfig\getHttpPath().

Referenced by achieve().

                                                                                                                                        : string
     {
         $inst_id = $settings->get("inst_id", 0);
         $http_path = $http_config->getHttpPath();
         $host_name = parse_url($http_path)["host"];
 
         $url = self::ILIAS_NIC_SERVER .
                 "?cmd=getid" .
                 "&inst_id=" . rawurlencode($inst_id) .
                 "&hostname=" . rawurlencode($host_name) .
                 "&inst_name=" . rawurlencode($systemfolder_config->getClientName()) .
                 "&inst_info=" . rawurlencode($systemfolder_config->getClientDescription()) .
                 "&http_path=" . rawurlencode($http_path) .
                 "&contact_firstname=" . rawurlencode($systemfolder_config->getContactFirstname()) .
                 "&contact_lastname=" . rawurlencode($systemfolder_config->getContactLastname()) .
                 "&contact_email=" . rawurlencode($systemfolder_config->getContactEMail()) .
                 "&nic_key=" . rawurlencode($settings->get("nic_key"));
 
         return $url;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNotable()

ilNICKeyRegisteredObjective::isNotable ( )

Definition at line 23 of file class.ilNICKeyRegisteredObjective.php.

                                 : bool
     {
         return true;
     }

Field Documentation

◆ ILIAS_NIC_SERVER

const ilNICKeyRegisteredObjective::ILIAS_NIC_SERVER = "https://nic.ilias.de/index.php"

Definition at line 11 of file class.ilNICKeyRegisteredObjective.php.

◆ MAX_REDIRECTS

const ilNICKeyRegisteredObjective::MAX_REDIRECTS = 5

Definition at line 9 of file class.ilNICKeyRegisteredObjective.php.

◆ SOCKET_TIMEOUT

const ilNICKeyRegisteredObjective::SOCKET_TIMEOUT = 5

Definition at line 10 of file class.ilNICKeyRegisteredObjective.php.

The documentation for this class was generated from the following file:

setup/classes/class.ilNICKeyRegisteredObjective.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members