Add hook to include custom variables by default when searching under Overview entries

[oskarnrk]

The hook can be implemented in multiple ways. For example:

Add to run.php

$this->provideHook('Icingadb/SearchColumnsProvider');

SearchColumnsProvider.php

<?php

namespace Icinga\Module\Icingadb\ProvidedHook;

use Icinga\Module\Icingadb\Hook\SearchColumnsProviderHook;
use ipl\Orm\Model;

class SearchColumnsProvider extends SearchColumnsProviderHook
{
    public function retrieveCustomVars(Model $model): array
    {
        switch ($model->getTableName()) {
            case 'host':
                return ['host.vars.hostfoo', 'host.vars.hostbar'];
            case 'service':
                return ['service.vars.servicefoo', 'service.vars.servicebar'];
            default:
                return [];
        }
    }
}

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Oscar Zambotti.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email email@example.com
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[cla-bot]

Thank you for your pull request. Before we can look at it, you'll need to sign a Contributor License Agreement (CLA).

Please follow instructions at https://icinga.com/company/contributor-agreement to sign the CLA.

After that, please reply here with a comment and we'll verify.

Contributors that have not signed yet: @oskarnrk

Details

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Please contact us if you think this is the case.

• If you signed the CLA as a corporation, your GitHub username may not have been submitted to us. Please reach out to the responsible person in your organization.

[oskarnrk]

Thank you for your pull request. Before we can look at it, you'll need to sign a Contributor License Agreement (CLA).

Please follow instructions at https://icinga.com/company/contributor-agreement to sign the CLA.

After that, please reply here with a comment and we'll verify.

Contributors that have not signed yet: @oskarnrk

I signed the ICLA, thanks in advance.

[oskarnrk]

Is it possibile to retrigger the CLA check? Thanks

[bobapple]

@cla-bot check

[oskarnrk]

Please, is it possible to check this quite old PR? Thanks 😇

[nilmerg]

Hi, the reason why (at least for me) no-one looked at this yet, is that this isn't just a small feature. This has so many other parts which might be affected, that I don't want to introduce a half baked solution. (Besides that a new hook also requires us to cover support for it, which I cannot guarantee at all)

[nilmerg]

Since Icinga/ipl-web@91221e2 there's an additional usage of Model::getSearchColumns(). It's intended to provide the same set of columns the searchbar will provide as a default in the same route, but applied in case the user hits enter faster than the default suggestion appears (or rather can be interacted with).

My suggestion to extend this, isolated to Icinga DB Web, is to change \Icinga\Module\Icingadb\Common\SearchControls::createSearchBar to override what the base implementation did. However, for this to work at all, \ipl\Web\Compat\SearchControls::callHandleRequest has be overridden and you have to call $searchBar->handleRequest($this->getServerRequest()).

[nilmerg]

looking fine now, but please rebase and fix the conflicts

[nilmerg]

Looks fine, thanks :)