Skip to content

JsonCollector: Introduce GetOptionalHeaders() and GetCurlOptions() methods #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

JsonCollector: Introduce GetOptionalHeaders() and GetCurlOptions() methods #44

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
34e2c03
JsonCollector: Introduce GetOptionalHeaders() and GetCurlOptions() me…
jbostoen Jan 15, 2024
cdd4a74
Apply suggestions from code review
Molkobain Jan 16, 2024
3037fb7
Update core/jsoncollector.class.inc.php
jbostoen Jan 17, 2024
ccba487
Update core/jsoncollector.class.inc.php
jbostoen Jan 17, 2024
b668ca5
Update core/jsoncollector.class.inc.php
jbostoen Jan 17, 2024
7794995
Apply suggestions, fixes
jbostoen Jan 18, 2024
dc6e1e1
Apply suggestion
jbostoen Jan 18, 2024
0bba4cc
Apply suggestions from code review
Molkobain Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 43 additions & 3 deletions core/jsoncollector.class.inc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,13 @@ public function Prepare()
} else {
$aDataGet = [];
}
$iSynchroTimeout = (int)Utils::GetConfigurationValue('itop_synchro_timeout', 600); // timeout in seconds, for a synchro to run
$aCurlOptions = Utils::GetCurlOptions($iSynchroTimeout);

$aCurlOptions = $this->GetCurlOptions();


//logs
Utils::Log(LOG_DEBUG, 'Source aDataGet: '.json_encode($aDataGet));
$this->sFileJson = Utils::DoPostRequest($this->sURL, $aDataGet, '', $aResponseHeaders, $aCurlOptions);
$this->sFileJson = Utils::DoPostRequest($this->sURL, $aDataGet, $this->GetOptionalHeaders(), $aResponseHeaders, $aCurlOptions);
Utils::Log(LOG_DEBUG, 'Source sFileJson: '.$this->sFileJson);
Utils::Log(LOG_INFO, 'Synchro URL (target): '.Utils::GetConfigurationValue('itop_url', array()));
} else {
Expand Down Expand Up @@ -258,6 +259,45 @@ public function Fetch()

return false;
}

/**
* @return Optional HTTP headers which can be sent to the specified URL. {@see \Utils::DoPostRequest() $sOptionnalHeaders parameter for the expected synthax}
* For example, a subclass can be override this method to send an Authorization: header. {@see \Utils::DoPostRequest() $sOptionnalHeaders parameter for the expected syntax}
*/
public function GetOptionalHeaders() : string
{
return '';
}

/**
* @return cURL options to use.
* For example, a subclass can be override this method to add the CURLOPT_USERPWD and a value.
*/
public function GetCurlOptions() : array
{
$iSynchroTimeout = (int)Utils::GetConfigurationValue('itop_synchro_timeout', 600); // timeout in seconds, for a synchro to run
$aParamsSourceJson = $this->aCollectorConfig;

// Step 1:
// Use cURL options from "config" XML.
$aConfigCurlOptions = Utils::GetCurlOptions($iSynchroTimeout);

// Step 2:
// If available: Add or update options defined in the "collector" XML.
// Apply the same mechanism to convert constants. The flexibility in place is to allow adding and overriding values, so do not pass on synchro timeout.
$aCollectorCurlOptions = array();

if(isset($aParamsSourceJson['curl_options'])) {
$aCollectorCurlOptions = $aParamsSourceJson['curl_options'];
}
if(isset($aParamsSourceJson['CURL_OPTIONS'])) {
$aCollectorCurlOptions = $aParamsSourceJson['CURL_OPTIONS'];
}

$aCollectorCurlOptions = Utils::ComputeCurlOptions($aCollectorCurlOptions, -1);

return array_replace($aConfigCurlOptions, $aCollectorCurlOptions);
}

/**
* @param array $aData
Expand Down