From 46c6201a217db553f8bd7f1752b6dd3dcae54d68 Mon Sep 17 00:00:00 2001 From: Johannes Meyer Date: Wed, 3 Jun 2020 15:47:10 +0200 Subject: [PATCH 1/6] Url: Add method `onlyWith()` --- library/Icinga/Web/Url.php | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/library/Icinga/Web/Url.php b/library/Icinga/Web/Url.php index 441819ce3..db7172283 100644 --- a/library/Icinga/Web/Url.php +++ b/library/Icinga/Web/Url.php @@ -828,6 +828,32 @@ class Url return $url; } + /** + * Return a copy of this url with only the given parameter(s) + * + * The argument can be either a single query parameter name or + * an array of parameter names to keep on on the query + * + * @param string|array $keyOrArrayOfKeys + * + * @return static + */ + public function onlyWith($keyOrArrayOfKeys) + { + if (! is_array($keyOrArrayOfKeys)) { + $keyOrArrayOfKeys = [$keyOrArrayOfKeys]; + } + + $url = clone $this; + foreach ($url->getParams()->toArray(false) as $key => $_) { + if (! in_array($key, $keyOrArrayOfKeys, true)) { + $url->remove($key); + } + } + + return $url; + } + public function __clone() { $this->params = clone $this->params; From 60c3fd64063445bf1a7fd02e64d941589ff3913d Mon Sep 17 00:00:00 2001 From: Johannes Meyer Date: Wed, 3 Jun 2020 15:47:57 +0200 Subject: [PATCH 2/6] FilterEditor: Use a new url from request when redirecting searches Creating a new url has the benefit that all framework params are still there. `$this->url()` however returns a url that's already mangled and parameter preservation does not work for framework params. This is not quite the correct fix. But the entire parameter handling here is way too convoluted. --- library/Icinga/Web/Widget/FilterEditor.php | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/library/Icinga/Web/Widget/FilterEditor.php b/library/Icinga/Web/Widget/FilterEditor.php index b2fc563b9..89e1a0bbd 100644 --- a/library/Icinga/Web/Widget/FilterEditor.php +++ b/library/Icinga/Web/Widget/FilterEditor.php @@ -285,12 +285,10 @@ class FilterEditor extends AbstractWidget } } - $url = $this->url()->setQueryString( - $filter->toQueryString() - )->addParams($preserve); - if ($modify) { - $url->getParams()->add('modifyFilter'); - } + $url = Url::fromRequest()->onlyWith($this->preserveParams); + $urlParams = $url->getParams(); + $url->setQueryString($filter->toQueryString()); + $url->getParams()->mergeValues($urlParams->toArray(false)); $this->redirectNow($url); } From 6cf9f190481dced474922a797c5a63d598137149 Mon Sep 17 00:00:00 2001 From: Johannes Meyer Date: Wed, 3 Jun 2020 15:57:08 +0200 Subject: [PATCH 3/6] ActionController: Shift parameter `view` if its value is `compact` --- library/Icinga/Web/Controller/ActionController.php | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/library/Icinga/Web/Controller/ActionController.php b/library/Icinga/Web/Controller/ActionController.php index df6dce1a1..44ebbc512 100644 --- a/library/Icinga/Web/Controller/ActionController.php +++ b/library/Icinga/Web/Controller/ActionController.php @@ -129,7 +129,10 @@ class ActionController extends Zend_Controller_Action $this->_helper->layout()->showFullscreen = $request->getUrl()->shift('showFullscreen'); $this->_helper->layout()->moduleName = $moduleName; - $this->view->compact = $request->getParam('view') === 'compact'; + if ($request->getUrl()->getParam('view') === 'compact') { + $request->getUrl()->remove('view'); + $this->view->compact = true; + } if ($request->getUrl()->shift('showCompact')) { $this->view->compact = true; } From a240e306ede8573da1a79c2eeb5d47261cfeffa9 Mon Sep 17 00:00:00 2001 From: Johannes Meyer Date: Wed, 3 Jun 2020 15:59:06 +0200 Subject: [PATCH 4/6] Preserve/Remove param `showCompact` instead of `view` --- library/Icinga/Web/Controller.php | 2 +- modules/monitoring/application/controllers/ListController.php | 2 +- .../monitoring/application/controllers/ServicesController.php | 2 +- .../monitoring/application/views/scripts/list/comments.phtml | 2 +- .../monitoring/application/views/scripts/list/contacts.phtml | 2 +- .../monitoring/application/views/scripts/list/downtimes.phtml | 2 +- .../monitoring/application/views/scripts/list/hostgroups.phtml | 2 +- modules/monitoring/application/views/scripts/list/hosts.phtml | 2 +- .../application/views/scripts/list/notifications.phtml | 2 +- .../application/views/scripts/list/servicegroups.phtml | 2 +- .../monitoring/application/views/scripts/list/services.phtml | 2 +- .../application/views/scripts/partials/event-history.phtml | 2 +- .../application/views/scripts/partials/show-more.phtml | 2 +- modules/monitoring/library/Monitoring/DataView/DataView.php | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/library/Icinga/Web/Controller.php b/library/Icinga/Web/Controller.php index 7409dfa7e..dba085a58 100644 --- a/library/Icinga/Web/Controller.php +++ b/library/Icinga/Web/Controller.php @@ -235,7 +235,7 @@ class Controller extends ModuleActionController 'sort', // setupSortControl() 'dir', // setupSortControl() 'backend', // Framework - 'view', // Framework + 'showCompact', // Framework '_dev' // Framework ); diff --git a/modules/monitoring/application/controllers/ListController.php b/modules/monitoring/application/controllers/ListController.php index 1e6ce6db1..251a45506 100644 --- a/modules/monitoring/application/controllers/ListController.php +++ b/modules/monitoring/application/controllers/ListController.php @@ -355,7 +355,7 @@ class ListController extends Controller $this->view->form = $form; $this->params - ->remove('view') + ->remove('showCompact') ->remove('format'); $orientation = $this->params->shift('vertical', 0) ? 'vertical' : 'horizontal'; /* diff --git a/modules/monitoring/application/controllers/ServicesController.php b/modules/monitoring/application/controllers/ServicesController.php index 1d65de919..6c6559210 100644 --- a/modules/monitoring/application/controllers/ServicesController.php +++ b/modules/monitoring/application/controllers/ServicesController.php @@ -35,7 +35,7 @@ class ServicesController extends Controller $serviceList = new ServiceList($this->backend); $this->applyRestriction('monitoring/filter/objects', $serviceList); $serviceList->addFilter(Filter::fromQueryString( - (string) $this->params->without(array('service_problem', 'service_handled', 'view')) + (string) $this->params->without(array('service_problem', 'service_handled', 'showCompact')) )); $this->serviceList = $serviceList; $this->serviceList->setColumns(array( diff --git a/modules/monitoring/application/views/scripts/list/comments.phtml b/modules/monitoring/application/views/scripts/list/comments.phtml index 4941922a9..4ea24dfd3 100644 --- a/modules/monitoring/application/views/scripts/list/comments.phtml +++ b/modules/monitoring/application/views/scripts/list/comments.phtml @@ -43,7 +43,7 @@
qlink( $this->translate('Show More'), - $this->url()->without(array('view', 'limit')), + $this->url()->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/list/contacts.phtml b/modules/monitoring/application/views/scripts/list/contacts.phtml index 68f8d3eeb..4928ce1d7 100644 --- a/modules/monitoring/application/views/scripts/list/contacts.phtml +++ b/modules/monitoring/application/views/scripts/list/contacts.phtml @@ -71,7 +71,7 @@
qlink( $this->translate('Show More'), - $this->url()->without(array('view', 'limit')), + $this->url()->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/list/downtimes.phtml b/modules/monitoring/application/views/scripts/list/downtimes.phtml index cefddfa53..dfef61760 100644 --- a/modules/monitoring/application/views/scripts/list/downtimes.phtml +++ b/modules/monitoring/application/views/scripts/list/downtimes.phtml @@ -46,7 +46,7 @@ if (! $this->compact): ?>
qlink( $this->translate('Show More'), - $this->url()->without(array('view', 'limit')), + $this->url()->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/list/hostgroups.phtml b/modules/monitoring/application/views/scripts/list/hostgroups.phtml index aab39f800..2a18517a2 100644 --- a/modules/monitoring/application/views/scripts/list/hostgroups.phtml +++ b/modules/monitoring/application/views/scripts/list/hostgroups.phtml @@ -284,7 +284,7 @@ if (! $this->compact): ?>
qlink( $this->translate('Show More'), - $this->url()->without(array('view', 'limit')), + $this->url()->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/list/hosts.phtml b/modules/monitoring/application/views/scripts/list/hosts.phtml index 1b8466ce3..5ff6aea72 100644 --- a/modules/monitoring/application/views/scripts/list/hosts.phtml +++ b/modules/monitoring/application/views/scripts/list/hosts.phtml @@ -102,7 +102,7 @@ if (! $this->compact): ?>
qlink( $this->translate('Show More'), - $this->url()->without(array('view', 'limit')), + $this->url()->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/list/notifications.phtml b/modules/monitoring/application/views/scripts/list/notifications.phtml index 14e33b654..51ef4326b 100644 --- a/modules/monitoring/application/views/scripts/list/notifications.phtml +++ b/modules/monitoring/application/views/scripts/list/notifications.phtml @@ -112,7 +112,7 @@ if (! $this->compact): ?>
qlink( $this->translate('Show More'), - $this->url(isset($notificationsUrl) ? $notificationsUrl : null)->without(array('view', 'limit')), + $this->url(isset($notificationsUrl) ? $notificationsUrl : null)->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/list/servicegroups.phtml b/modules/monitoring/application/views/scripts/list/servicegroups.phtml index 431fc8e56..502655187 100644 --- a/modules/monitoring/application/views/scripts/list/servicegroups.phtml +++ b/modules/monitoring/application/views/scripts/list/servicegroups.phtml @@ -172,7 +172,7 @@ if (! $this->compact): ?>
qlink( $this->translate('Show More'), - $this->url()->without(array('view', 'limit')), + $this->url()->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/list/services.phtml b/modules/monitoring/application/views/scripts/list/services.phtml index 60a39a32a..9b785a073 100644 --- a/modules/monitoring/application/views/scripts/list/services.phtml +++ b/modules/monitoring/application/views/scripts/list/services.phtml @@ -130,7 +130,7 @@ if (! $this->compact): ?>
qlink( $this->translate('Show More'), - $this->url()->without(array('view', 'limit')), + $this->url()->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/partials/event-history.phtml b/modules/monitoring/application/views/scripts/partials/event-history.phtml index 73eb33bf4..cc1862362 100644 --- a/modules/monitoring/application/views/scripts/partials/event-history.phtml +++ b/modules/monitoring/application/views/scripts/partials/event-history.phtml @@ -247,7 +247,7 @@ $rowAction = Url::fromPath('monitoring/event/show'); compact) { echo $this->qlink( $this->translate('Show More'), - $url->without(array('view', 'limit')), + $url->without(array('showCompact', 'limit')), null, array( 'class' => 'action-link', diff --git a/modules/monitoring/application/views/scripts/partials/show-more.phtml b/modules/monitoring/application/views/scripts/partials/show-more.phtml index 4265ba8dd..fd6a99dc8 100644 --- a/modules/monitoring/application/views/scripts/partials/show-more.phtml +++ b/modules/monitoring/application/views/scripts/partials/show-more.phtml @@ -4,7 +4,7 @@ if ($dataView->hasMore()): ?>
qlink( $this->translate('Show More'), - $this->url()->without(array('view', 'limit')), + $this->url()->without(array('showCompact', 'limit')), null, array( 'data-base-target' => '_next', diff --git a/modules/monitoring/library/Monitoring/DataView/DataView.php b/modules/monitoring/library/Monitoring/DataView/DataView.php index 193f9300a..39c5305b1 100644 --- a/modules/monitoring/library/Monitoring/DataView/DataView.php +++ b/modules/monitoring/library/Monitoring/DataView/DataView.php @@ -147,7 +147,7 @@ abstract class DataView implements QueryInterface, SortRules, FilterColumns, Ite $dir = $url->shift('dir'); $page = $url->shift('page'); $format = $url->shift('format'); - $view = $url->shift('view'); + $view = $url->shift('showCompact'); $view = $url->shift('backend'); foreach ($url->getParams() as $k => $v) { $this->where($k, $v); From 74a9a8edf04c7d35439e2c02ebe5872048ec4698 Mon Sep 17 00:00:00 2001 From: Johannes Meyer Date: Wed, 3 Jun 2020 15:59:53 +0200 Subject: [PATCH 5/6] modal.js: Request compact content with `showCompact` --- public/js/icinga/behavior/modal.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/public/js/icinga/behavior/modal.js b/public/js/icinga/behavior/modal.js index 082b941b1..109e1053e 100644 --- a/public/js/icinga/behavior/modal.js +++ b/public/js/icinga/behavior/modal.js @@ -42,8 +42,8 @@ var $modal = _this.$ghost.clone(); var $urlTarget = _this.icinga.loader.getLinkTargetFor($a); - // Add view=compact, we don't want controls in a modal - url = _this.icinga.utils.addUrlParams(url, { 'view': 'compact' }); + // Add showCompact, we don't want controls in a modal + url = _this.icinga.utils.addUrlFlag(url, 'showCompact'); // Set the toggle's base target on the modal to use it as redirect target $modal.data('redirectTarget', $urlTarget); From e37e181935c2ccbbb46a8d22e5ee8af6896046d0 Mon Sep 17 00:00:00 2001 From: Johannes Meyer Date: Wed, 3 Jun 2020 16:21:22 +0200 Subject: [PATCH 6/6] doc: Mention `view=compact` change in upgrading notes --- doc/80-Upgrading.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/80-Upgrading.md b/doc/80-Upgrading.md index 882ca3543..c6352a07c 100644 --- a/doc/80-Upgrading.md +++ b/doc/80-Upgrading.md @@ -45,6 +45,11 @@ Please consider an upgrade of your central Icinga system to a newer distribution [icinga.com](https://icinga.com/subscription/support-details/) provides an overview about currently supported distributions. +**Framework changes affecting third-party code** + +* Url parameter `view=compact` is now deprecated. `showCompact` should be used instead. + Details are in pull request [#4164](https://github.com/Icinga/icingaweb2/pull/4164). + ## Upgrading to Icinga Web 2 2.7.x **Breaking changes**