mirror of
https://github.com/Icinga/icingaweb2-module-director.git
synced 2026-06-11 01:40:01 -04:00
Merge 6c554c3d38 into 5d38237dd7
This commit is contained in:
Markus Frosch
GitHub
commit
eb960c1961
2 changed files with 434 additions and 1 deletions
431
library/Director/Import/ImportSourceGraphQL.php
Normal file
431
library/Director/Import/ImportSourceGraphQL.php
Normal file
|
|
@ -0,0 +1,431 @@
|
|||
<?php
|
||||
|
||||
namespace Icinga\Module\Director\Import;
|
||||
|
||||
use Icinga\Exception\InvalidPropertyException;
|
||||
use Icinga\Module\Director\Hook\ImportSourceHook;
|
||||
use Icinga\Module\Director\RestApi\RestApiClient;
|
||||
use Icinga\Module\Director\Web\Form\QuickForm;
|
||||
use InvalidArgumentException;
|
||||
|
||||
class ImportSourceGraphQL extends ImportSourceHook
|
||||
{
|
||||
/** @var []object */
|
||||
protected $data;
|
||||
|
||||
public function getName()
|
||||
{
|
||||
return 'GraphQL';
|
||||
}
|
||||
|
||||
public function setSettings($settings)
|
||||
{
|
||||
// Reset any cached data
|
||||
$this->data = null;
|
||||
|
||||
return parent::setSettings($settings);
|
||||
}
|
||||
|
||||
public function fetchData()
|
||||
{
|
||||
// Use data cache to run query only once
|
||||
if ($this->data !== null) {
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
$body = [
|
||||
'query' => $this->getSetting('query', ''),
|
||||
];
|
||||
|
||||
if (($variables = $this->getSetting('variables')) !== null) {
|
||||
$body['variables'] = json_decode($variables);
|
||||
}
|
||||
|
||||
$result = $this->getRestApi()->post(
|
||||
$this->getUrl(),
|
||||
$body,
|
||||
$this->buildHeaders()
|
||||
);
|
||||
|
||||
$result = (array) $this->extractProperty($result);
|
||||
|
||||
// sort by a key of the objects
|
||||
if (! empty($sortKey = $this->getSetting('sort_by'))) {
|
||||
usort($result, function ($a, $b) use ($sortKey) {
|
||||
return strcmp(
|
||||
static::getSubKey($sortKey, $a, true),
|
||||
static::getSubKey($sortKey, $b, true)
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
$this->data = $result;
|
||||
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
public function listColumns()
|
||||
{
|
||||
$rows = $this->fetchData();
|
||||
$columns = [];
|
||||
|
||||
foreach ($rows as $object) {
|
||||
foreach (array_keys((array) $object) as $column) {
|
||||
if (! isset($columns[$column])) {
|
||||
$columns[] = $column;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $columns;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract result from a property specified
|
||||
*
|
||||
* A simple key, like "objects", will take the final result from key objects
|
||||
*
|
||||
* If you have a deeper key like "objects" under the key "results", specify this as "results.objects".
|
||||
*
|
||||
* When a key of the JSON object contains a literal ".", this can be escaped as
|
||||
*
|
||||
* @param $result
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
protected function extractProperty($result)
|
||||
{
|
||||
$property = $this->getSetting('extract_property');
|
||||
if (empty($property)) {
|
||||
// TODO: Try to find array
|
||||
return $result;
|
||||
}
|
||||
|
||||
return static::getSubKey($property, $result);
|
||||
}
|
||||
|
||||
protected function buildHeaders()
|
||||
{
|
||||
$headers = [
|
||||
'Accept' => 'application/json',
|
||||
'Content-Type' => 'application/json',
|
||||
];
|
||||
|
||||
$text = $this->getSetting('headers', '');
|
||||
foreach (preg_split('~\r?\n~', $text, -1, PREG_SPLIT_NO_EMPTY) as $header) {
|
||||
$header = trim($header);
|
||||
$parts = preg_split('~\s*:\s*~', $header, 2);
|
||||
if (count($parts) < 2) {
|
||||
throw new InvalidPropertyException('Could not parse header: "%s"', $header);
|
||||
}
|
||||
|
||||
$headers[$parts[0]] = $parts[1];
|
||||
}
|
||||
|
||||
return $headers;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
public static function addSettingsFormFields(QuickForm $form)
|
||||
{
|
||||
static::addUrl($form);
|
||||
static::addGraphQLFields($form);
|
||||
static::addResultProperty($form);
|
||||
static::addAuthentication($form);
|
||||
static::addSslOptions($form);
|
||||
static::addHeader($form);
|
||||
static::addProxy($form);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
protected static function addHeader(QuickForm $form)
|
||||
{
|
||||
$form->addElement('textarea', 'headers', [
|
||||
'label' => $form->translate('HTTP Header'),
|
||||
'description' => implode(' ', [
|
||||
$form->translate('Additional headers for the HTTP request.'),
|
||||
$form->translate('Specify headers in text format "Header: Value", each header on a new line.'),
|
||||
]),
|
||||
'class' => 'preformatted',
|
||||
'rows' => 4,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
protected static function addGraphQLFields(QuickForm $form)
|
||||
{
|
||||
$form->addElement('textarea', 'query', [
|
||||
'label' => $form->translate('GraphQL Query'),
|
||||
'description' => implode(' ', [
|
||||
$form->translate('Query for GraphQL.'),
|
||||
$form->translate('Example:') . ' query { table { field } }',
|
||||
]),
|
||||
'class' => 'preformatted',
|
||||
'rows' => 6,
|
||||
]);
|
||||
|
||||
$form->addElement('textarea', 'variables', [
|
||||
'label' => $form->translate('GraphQL Variables'),
|
||||
'description' => $form->translate('Variables for the GraphQL query in JSON format.'),
|
||||
'class' => 'preformatted',
|
||||
'rows' => 5,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
protected static function addSslOptions(QuickForm $form)
|
||||
{
|
||||
static::addBoolean($form, 'ssl_verify_peer', [
|
||||
'label' => $form->translate('Verify Peer'),
|
||||
'description' => $form->translate(
|
||||
'Whether we should check that our peer\'s certificate has'
|
||||
. ' been signed by a trusted CA. This is strongly recommended.'
|
||||
)
|
||||
], 'y');
|
||||
static::addBoolean($form, 'ssl_verify_host', [
|
||||
'label' => $form->translate('Verify Host'),
|
||||
'description' => $form->translate(
|
||||
'Whether we should check that the certificate matches the'
|
||||
. 'configured host'
|
||||
)
|
||||
], 'y');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
protected static function addUrl(QuickForm $form)
|
||||
{
|
||||
$form->addElement('text', 'url', [
|
||||
'label' => 'REST API URL',
|
||||
'description' => $form->translate(
|
||||
'Something like https://api.example.com/api/v1/graphql'
|
||||
),
|
||||
'required' => true,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
protected static function addResultProperty(QuickForm $form)
|
||||
{
|
||||
$form->addElement('text', 'extract_property', [
|
||||
'label' => 'Extract property',
|
||||
'description' => implode("\n", [
|
||||
$form->translate('Select the property in the JSON result, which contains the array of results.'),
|
||||
$form->translate('Also deeper keys can be specific by a dot-notation:'),
|
||||
'"data.objects", "data.query.objects"',
|
||||
$form->translate('Literal dots in a key name can be written in the escape notation:'),
|
||||
'"key\.with\.dots"',
|
||||
]),
|
||||
'required' => true,
|
||||
]);
|
||||
|
||||
$form->addElement('text', 'sort_by', [
|
||||
'label' => 'Sort by property',
|
||||
'description' => implode("\n", [
|
||||
$form->translate('Sort the results by a property.'),
|
||||
$form->translate('Relative to the extracted property.'),
|
||||
$form->translate('This might be helpful when the API returns results randomly, ' .
|
||||
'which can confuse the change logic of Director imports.'),
|
||||
]),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
protected static function addAuthentication(QuickForm $form)
|
||||
{
|
||||
$form->addElement('text', 'username', [
|
||||
'label' => $form->translate('Username'),
|
||||
'description' => $form->translate(
|
||||
'Will be used to authenticate against your REST API'
|
||||
),
|
||||
]);
|
||||
|
||||
$form->addElement('storedPassword', 'password', [
|
||||
'label' => $form->translate('Password'),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
protected static function addProxy(QuickForm $form)
|
||||
{
|
||||
$form->addElement('select', 'proxy_type', [
|
||||
'label' => $form->translate('Proxy'),
|
||||
'description' => $form->translate(
|
||||
'In case your API is only reachable through a proxy, please'
|
||||
. ' choose it\'s protocol right here'
|
||||
),
|
||||
'multiOptions' => $form->optionalEnum([
|
||||
'HTTP' => $form->translate('HTTP proxy'),
|
||||
'SOCKS5' => $form->translate('SOCKS5 proxy'),
|
||||
]),
|
||||
'class' => 'autosubmit'
|
||||
]);
|
||||
|
||||
$proxyType = $form->getSentOrObjectSetting('proxy_type');
|
||||
|
||||
if ($proxyType) {
|
||||
$form->addElement('text', 'proxy', [
|
||||
'label' => $form->translate('Proxy Address'),
|
||||
'description' => $form->translate(
|
||||
'Hostname, IP or <host>:<port>'
|
||||
),
|
||||
'required' => true,
|
||||
]);
|
||||
if ($proxyType === 'HTTP') {
|
||||
$form->addElement('text', 'proxy_user', [
|
||||
'label' => $form->translate('Proxy Username'),
|
||||
'description' => $form->translate(
|
||||
'In case your proxy requires authentication, please'
|
||||
. ' configure this here'
|
||||
),
|
||||
]);
|
||||
|
||||
$passRequired = strlen($form->getSentOrObjectSetting('proxy_user')) > 0;
|
||||
|
||||
$form->addElement('storedPassword', 'proxy_pass', [
|
||||
'label' => $form->translate('Proxy Password'),
|
||||
'required' => $passRequired
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
protected function getUrl()
|
||||
{
|
||||
$url = $this->getSetting('url');
|
||||
$parts = \parse_url($url);
|
||||
if (isset($parts['path'])) {
|
||||
$path = $parts['path'];
|
||||
} else {
|
||||
$path = '/';
|
||||
}
|
||||
|
||||
if (isset($parts['query'])) {
|
||||
$url = "$path?" . $parts['query'];
|
||||
} else {
|
||||
$url = $path;
|
||||
}
|
||||
|
||||
return $url;
|
||||
}
|
||||
|
||||
protected function getRestApi()
|
||||
{
|
||||
$url = $this->getSetting('url');
|
||||
$parts = \parse_url($url);
|
||||
if (isset($parts['host'])) {
|
||||
$host = $parts['host'];
|
||||
} else {
|
||||
throw new InvalidArgumentException("URL '$url' has no host");
|
||||
}
|
||||
|
||||
$api = new RestApiClient(
|
||||
$host,
|
||||
$this->getSetting('username'),
|
||||
$this->getSetting('password')
|
||||
);
|
||||
|
||||
$api->setScheme($parts['scheme']);
|
||||
|
||||
if (isset($parts['port'])) {
|
||||
$api->setPort($parts['port']);
|
||||
}
|
||||
|
||||
if ($this->getSetting('ssl_verify_peer', 'y') === 'n') {
|
||||
$api->disableSslPeerVerification();
|
||||
}
|
||||
if ($this->getSetting('ssl_verify_host', 'y') === 'n') {
|
||||
$api->disableSslHostVerification();
|
||||
}
|
||||
|
||||
if ($proxy = $this->getSetting('proxy')) {
|
||||
if ($proxyType = $this->getSetting('proxy_type')) {
|
||||
$api->setProxy($proxy, $proxyType);
|
||||
} else {
|
||||
$api->setProxy($proxy);
|
||||
}
|
||||
|
||||
if ($user = $this->getSetting('proxy_user')) {
|
||||
$api->setProxyAuth($user, $this->getSetting('proxy_pass'));
|
||||
}
|
||||
}
|
||||
|
||||
return $api;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param QuickForm $form
|
||||
* @param string $key
|
||||
* @param array $options
|
||||
* @param string|null $default
|
||||
*
|
||||
* @throws \Zend_Form_Exception
|
||||
*/
|
||||
protected static function addBoolean(QuickForm $form, $key, $options, $default = null)
|
||||
{
|
||||
if ($default === null) {
|
||||
$form->addElement('OptionalYesNo', $key, $options);
|
||||
} else {
|
||||
$form->addElement('YesNo', $key, $options);
|
||||
$form->getElement($key)->setValue($default);
|
||||
}
|
||||
}
|
||||
|
||||
protected static function getSubKey($property, $data, $allowNull = false)
|
||||
{
|
||||
$parts = preg_split('~(?<!\\\\)\.~', $property);
|
||||
|
||||
// iterate over parts of the attribute path
|
||||
foreach ($parts as $part) {
|
||||
// un-escape any dots
|
||||
$part = preg_replace('~\\\\.~', '.', $part);
|
||||
|
||||
if ($allowNull && ! is_object($data)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (property_exists($data, $part)) {
|
||||
$data = $data->$part;
|
||||
} else {
|
||||
throw new \RuntimeException(sprintf(
|
||||
'data has no "%s" property. Available keys: %s',
|
||||
$part,
|
||||
implode(', ', array_keys((array) $data))
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
|
|
@ -13,6 +13,7 @@ use Icinga\Module\Director\Import\ImportSourceCoreApi;
|
|||
use Icinga\Module\Director\Import\ImportSourceDirectorObject;
|
||||
use Icinga\Module\Director\Import\ImportSourceLdap;
|
||||
use Icinga\Module\Director\Import\ImportSourceRestApi;
|
||||
use Icinga\Module\Director\Import\ImportSourceGraphQL;
|
||||
use Icinga\Module\Director\Import\ImportSourceSql;
|
||||
use Icinga\Module\Director\Job\ConfigJob;
|
||||
use Icinga\Module\Director\Job\HousekeepingJob;
|
||||
|
|
@ -93,7 +94,8 @@ $directorHooks = [
|
|||
ImportSourceSql::class,
|
||||
ImportSourceLdap::class,
|
||||
ImportSourceCoreApi::class,
|
||||
ImportSourceRestApi::class
|
||||
ImportSourceRestApi::class,
|
||||
ImportSourceGraphQL::class
|
||||
],
|
||||
'director/Job' => [
|
||||
ConfigJob::class,
|
||||
|
|
|
|||
Loading…
Reference in a new issue