From bee4bf82bcf2cc61a803310ea557cb2633d7e021 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 14 Apr 2024 15:27:46 +0200 Subject: Adding upstream version 1.1.0. Signed-off-by: Daniel Baumann --- .github/ISSUE_TEMPLATE.md | 46 ++++ .github_changelog_generator | 1 + .mailmap | 7 + AUTHORS | 9 + CHANGELOG.md | 14 + LICENSE | 339 +++++++++++++++++++++++++ README.md | 30 +++ RELEASE.md | 59 +++++ application/controllers/ConfigController.php | 25 ++ application/controllers/GraphController.php | 41 +++ application/controllers/IndexController.php | 25 ++ application/forms/Config/GeneralConfigForm.php | 62 +++++ application/locale/de_DE/LC_MESSAGES/pnp.mo | Bin 0 -> 1237 bytes application/locale/de_DE/LC_MESSAGES/pnp.po | 77 ++++++ application/locale/it_IT/LC_MESSAGES/pnp.mo | Bin 0 -> 1238 bytes application/locale/it_IT/LC_MESSAGES/pnp.po | 67 +++++ application/views/scripts/config/index.phtml | 6 + application/views/scripts/index/iframe.phtml | 4 + configuration.php | 19 ++ library/Pnp/ProvidedHook/Grapher.php | 274 ++++++++++++++++++++ library/Pnp/Web/Controller.php | 27 ++ module.info | 8 + run.php | 3 + 23 files changed, 1143 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github_changelog_generator create mode 100644 .mailmap create mode 100644 AUTHORS create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 RELEASE.md create mode 100644 application/controllers/ConfigController.php create mode 100644 application/controllers/GraphController.php create mode 100644 application/controllers/IndexController.php create mode 100644 application/forms/Config/GeneralConfigForm.php create mode 100644 application/locale/de_DE/LC_MESSAGES/pnp.mo create mode 100644 application/locale/de_DE/LC_MESSAGES/pnp.po create mode 100644 application/locale/it_IT/LC_MESSAGES/pnp.mo create mode 100644 application/locale/it_IT/LC_MESSAGES/pnp.po create mode 100644 application/views/scripts/config/index.phtml create mode 100644 application/views/scripts/index/iframe.phtml create mode 100644 configuration.php create mode 100644 library/Pnp/ProvidedHook/Grapher.php create mode 100644 library/Pnp/Web/Controller.php create mode 100644 module.info create mode 100644 run.php diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..feb3c1c --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,46 @@ + + + + +## Expected Behavior + + + +## Current Behavior + + + +## Possible Solution + + + +## Steps to Reproduce (for bugs) + + +1. +2. +3. +4. + +## Context + + + +## Your Environment + +* Module version (System - About): +* Icinga Web 2 version and modules (System - About): +* Icinga 2 version (`icinga2 --version`): +* Operating System and version: +* Webserver, PHP versions: + diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 0000000..3f515cd --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1 @@ +since-tag=v1.0.1 diff --git a/.mailmap b/.mailmap new file mode 100644 index 0000000..9af885e --- /dev/null +++ b/.mailmap @@ -0,0 +1,7 @@ + + + + + + + diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..ac832d8 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,9 @@ +Eric Lippmann +Johannes Meyer +Lee Clemens +Marius Hein +Markus Frosch +Matthew Thode +Michael Friedrich +Mirko Nardin +Thomas Gelf diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7540843 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Change Log + +## [v1.1.0](https://github.com/Icinga/icingaweb2-module-pnp/tree/v1.1.0) (2017-08-15) +[Full Changelog](https://github.com/Icinga/icingaweb2-module-pnp/compare/v1.0.0...v1.1.0) + +**Implemented enhancements:** + +- \[dev.icinga.com \#9894\] missing "close-Button" in pnp4nagios Module \(Icinga Web 2 Frame\) [\#14](https://github.com/Icinga/icingaweb2-module-pnp/issues/14) +- \[dev.icinga.com \#9797\] Close button to PNP iframe [\#12](https://github.com/Icinga/icingaweb2-module-pnp/issues/12) +- Improve UI and user interaction [\#28](https://github.com/Icinga/icingaweb2-module-pnp/pull/28) ([lazyfrosch](https://github.com/lazyfrosch)) + + + +\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ecbc059 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..a50f902 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +PNP module for Icinga Web 2 +=========================== + +General Information +------------------- + +PNP is an addon to Icinga which analyzes performance data provided by plugins +and stores them automatically into RRD-databases. + +This module integrates PNP4Nagios into your +[Icinga Web 2](https://www.icinga.org/icinga/screenshots/icinga-web-2/) +frontend. It requires [PNP4Nagios](https://docs.pnp4nagios.org/) +to installed and configured. + +Installation +------------ + +Just drop this module to a folder named `pnp` in one of your Icinga Web 2 module +directories. Then enable it in your frontend (Configuration -> Modules -> pnp +-> enable) and it should work out of the box. Check the modules config tab right +there in case you are using a customized installation instead of standard +PNP4Nagios packages. + +TODO +---- + +We should also provide an easy way to integrate our authentication and +permission system into PNP4Nagios. This would require a small wrapper doing an +embedded Icinga Web 2 bootstrap in order to provide our user object and a list +of allowed hosts/services to PNP4Nagios. diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..c2aba0d --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,59 @@ +# Release Workflow + +Specify the release version. + +``` +VERSION=1.1.0 +``` + +## Issues + +Check issues at https://github.com/Icinga/icingaweb2-module-pnp + +## Authors + +Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files: + +``` +git checkout master +git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS +``` + +## Changelog + +Update the [CHANGELOG.md](CHANGELOG.md) file. + +Uses [github_changelog_generator](https://github.com/skywinder/github-changelog-generator) + +``` +export CHANGELOG_GITHUB_TOKEN=xxx +github_changelog_generator --future-release v$VERSION +``` + +Check if the file has been updated correctly. + +## Git Tag + +Commit these changes to the "master" branch: + +``` +git commit -v -a -m "Release version $VERSION" +git push origin master +``` + +And tag it with a signed tag: + +``` +git tag -s -m "Version $VERSION" v$VERSION +``` + +Push the tag. + +``` +git push --tags +``` + +## GitHub Release + +Create a new release for the newly created Git tag. +https://github.com/Icinga/icingaweb2-module-pnp/releases diff --git a/application/controllers/ConfigController.php b/application/controllers/ConfigController.php new file mode 100644 index 0000000..f6a0dcd --- /dev/null +++ b/application/controllers/ConfigController.php @@ -0,0 +1,25 @@ +assertPermission('config/modules'); + + $form = new GeneralConfigForm(); + $form->setIniConfig($this->Config()); + $form->handleRequest(); + + $this->view->form = $form; + $this->view->tabs = $this->Module()->getConfigTabs()->activate('config'); + } +} diff --git a/application/controllers/GraphController.php b/application/controllers/GraphController.php new file mode 100644 index 0000000..312b802 --- /dev/null +++ b/application/controllers/GraphController.php @@ -0,0 +1,41 @@ +getRequest()->getUrl(); + $queryString = $url->getQueryString(); + + $this->view->url = sprintf( + '%s/graph?%s', + $this->getBaseUrl(), + $queryString + ); + + $host = $this->getParam('host'); + $service = $this->getParam('srv'); + + $serviceTitle = ''; + if ($service && $service !== '_HOST_') { + $serviceTitle = sprintf(' | %s: %s', $this->translate('Service'), $service); + } + $this->view->title = $title = sprintf('%s: %s%s', + $this->translate('Host'), + $host, + $serviceTitle + ); + + $this->getTabs()->add('graph', array( + 'label' => $title, + 'url' => $url, + ))->activate('graph'); + + $this->setViewScript('index/iframe'); + } +} diff --git a/application/controllers/IndexController.php b/application/controllers/IndexController.php new file mode 100644 index 0000000..7725268 --- /dev/null +++ b/application/controllers/IndexController.php @@ -0,0 +1,25 @@ +getTabs()->activate('pnp'); + + $defaultQuery = $this->Config()->get('pnp4nagios', 'default_query', 'host=.pnp-internal&srv=runtime'); + + $this->view->title = 'PNP'; + $this->view->url = sprintf( + '%s/graph?%s', + $this->getBaseUrl(), + $defaultQuery + ); + + $this->setViewScript('index/iframe'); + } +} diff --git a/application/forms/Config/GeneralConfigForm.php b/application/forms/Config/GeneralConfigForm.php new file mode 100644 index 0000000..d751055 --- /dev/null +++ b/application/forms/Config/GeneralConfigForm.php @@ -0,0 +1,62 @@ +setName('form_config_pnp4nagios_general'); + $this->setSubmitLabel($this->translate('Save Changes')); + } + + /** + * {@inheritdoc} + */ + public function createElements(array $formData) + { + $this->addElement( + 'text', + 'pnp4nagios_config_dir', + array( + 'value' => '/etc/pnp4nagios', + 'label' => $this->translate('PNP4Nagios configuration'), + 'description' => $this->translate('PNP4Nagios configuration path name (e.g. /etc/pnp4nagios)') + ) + ); + $this->addElement( + 'text', + 'pnp4nagios_base_url', + array( + 'value' => '/pnp4nagios', + 'label' => $this->translate('PNP4Nagios url'), + 'description' => $this->translate('The base URL of your PNP4Nagios installation (e.g. /pnp4nagios)') + ) + ); + + $this->addElement( + 'checkbox', + 'pnp4nagios_menu_disabled', + array( + 'label' => $this->translate('Disable menu entry'), + 'description' => $this->translate('Hide PNP from main menu') + ) + ); + + $this->addElement( + 'text', + 'pnp4nagios_default_query', + array( + 'value' => 'host=.pnp-internal&srv=runtime', + 'label' => $this->translate('Index query'), + 'description' => $this->translate('Default URL query for the index view: /pnp4nagios/graph?{query}') + ) + ); + } +} diff --git a/application/locale/de_DE/LC_MESSAGES/pnp.mo b/application/locale/de_DE/LC_MESSAGES/pnp.mo new file mode 100644 index 0000000..b7076cf Binary files /dev/null and b/application/locale/de_DE/LC_MESSAGES/pnp.mo differ diff --git a/application/locale/de_DE/LC_MESSAGES/pnp.po b/application/locale/de_DE/LC_MESSAGES/pnp.po new file mode 100644 index 0000000..8cd9a5c --- /dev/null +++ b/application/locale/de_DE/LC_MESSAGES/pnp.po @@ -0,0 +1,77 @@ +# Icinga Web 2 - Head for multiple monitoring backends. +# Copyright (C) 2015 Icinga Development Team +# This file is distributed under the same license as Pnp Module. +# FIRST AUTHOR , YEAR. +# +msgid "" +msgstr "" +"Project-Id-Version: Pnp Module (1.0.0)\n" +"Report-Msgid-Bugs-To: dev@icinga.org\n" +"POT-Creation-Date: 2015-11-17 11:56+0100\n" +"PO-Revision-Date: 2015-11-17 12:01+0100\n" +"Last-Translator: Thomas Gelf \n" +"Language: de_DE\n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Poedit 1.5.4\n" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:224 +msgid "25 Hours" +msgstr "25 Stunden" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:223 +msgid "4 Hours" +msgstr "4 Stunden" + +#: /usr/local/icingaweb-modules/pnp/configuration.php:8 +msgid "Config" +msgstr "Konfiguration" + +#: /usr/local/icingaweb-modules/pnp/configuration.php:7 +msgid "Configure this module" +msgstr "Dieses Modul konfigurieren" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:226 +msgid "One Month" +msgstr "Ein Monat" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:225 +msgid "One Week" +msgstr "Eine Woche" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:227 +msgid "One Year" +msgstr "Ein Jahr" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:29 +msgid "PNP4Nagios configuration" +msgstr "PNP4Nagios Konfiguration" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:30 +msgid "PNP4Nagios configuration path name (e.g. /etc/pnp4nagios)" +msgstr "PNP4Nagios Konfigurationspfad (z.b. /etc/pnp4nagios)" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:38 +msgid "PNP4Nagios url" +msgstr "PNP4Nagios URL" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:16 +msgid "Save Changes" +msgstr "Änderungen speichern" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:39 +msgid "The base URL of your PNP4Nagios installation (e.g. /pnp4nagios)" +msgstr "Basis-URL deiner PNP4Nagios installation (z.B. /pnp4nagios)" + +#~ msgid "" +#~ "Configuration form is still missing in this prototype. In case your " +#~ "PNP4Nagios config path is not %s or your base PNP4Nagios web url differs " +#~ "from %s please create a config file in %s following this example:" +#~ msgstr "" +#~ "Dieser Prototyp stellt noch kein Konfigurationsformular bereit. Sollte " +#~ "dein PNP4Nagios Konfigurationspfad nicht %s sein oder deine PNP4Nagios " +#~ "URL sich von %s unterscheiden erstelle bitte unter %s eine dem folgenden " +#~ "Beispiel entprechende Konfigurationsdatei:" diff --git a/application/locale/it_IT/LC_MESSAGES/pnp.mo b/application/locale/it_IT/LC_MESSAGES/pnp.mo new file mode 100644 index 0000000..0a72826 Binary files /dev/null and b/application/locale/it_IT/LC_MESSAGES/pnp.mo differ diff --git a/application/locale/it_IT/LC_MESSAGES/pnp.po b/application/locale/it_IT/LC_MESSAGES/pnp.po new file mode 100644 index 0000000..629b067 --- /dev/null +++ b/application/locale/it_IT/LC_MESSAGES/pnp.po @@ -0,0 +1,67 @@ +# Icinga Web 2 - Head for multiple monitoring backends. +# Copyright (C) 2015 Icinga Development Team +# This file is distributed under the same license as Pnp Module. +# FIRST AUTHOR , YEAR. +# +msgid "" +msgstr "" +"Project-Id-Version: Pnp Module (1.0.0)\n" +"Report-Msgid-Bugs-To: dev@icinga.org\n" +"POT-Creation-Date: 2015-11-17 11:57+0100\n" +"PO-Revision-Date: 2015-11-17 11:59+0100\n" +"Last-Translator: Thomas Gelf \n" +"Language: it_IT\n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Poedit 1.5.4\n" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:224 +msgid "25 Hours" +msgstr "25 ore" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:223 +msgid "4 Hours" +msgstr "4 ore" + +#: /usr/local/icingaweb-modules/pnp/configuration.php:8 +msgid "Config" +msgstr "Configurazione" + +#: /usr/local/icingaweb-modules/pnp/configuration.php:7 +msgid "Configure this module" +msgstr "Configura questo modulo" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:226 +msgid "One Month" +msgstr "Un mese" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:225 +msgid "One Week" +msgstr "Una settimana" + +#: /usr/local/icingaweb-modules/pnp/library/Pnp/ProvidedHook/Grapher.php:227 +msgid "One Year" +msgstr "Un anno" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:29 +msgid "PNP4Nagios configuration" +msgstr "Configurazione PNP4Nagios" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:30 +msgid "PNP4Nagios configuration path name (e.g. /etc/pnp4nagios)" +msgstr "Directory della configurazione PNP4Nagios (es. /etc/pnp4nagios)" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:38 +msgid "PNP4Nagios url" +msgstr "URL PNP4Nagios" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:16 +msgid "Save Changes" +msgstr "Salva modifiche" + +#: /usr/local/icingaweb-modules/pnp/application/forms/Config/GeneralConfigForm.php:39 +msgid "The base URL of your PNP4Nagios installation (e.g. /pnp4nagios)" +msgstr "URL di base della tua installazione PNP4Nagios (es. /pnp4nagios)" diff --git a/application/views/scripts/config/index.phtml b/application/views/scripts/config/index.phtml new file mode 100644 index 0000000..4ca5e68 --- /dev/null +++ b/application/views/scripts/config/index.phtml @@ -0,0 +1,6 @@ +
+ +
+
+ +
\ No newline at end of file diff --git a/application/views/scripts/index/iframe.phtml b/application/views/scripts/index/iframe.phtml new file mode 100644 index 0000000..be0c35a --- /dev/null +++ b/application/views/scripts/index/iframe.phtml @@ -0,0 +1,4 @@ +
+ +
+ diff --git a/configuration.php b/configuration.php new file mode 100644 index 0000000..76713e5 --- /dev/null +++ b/configuration.php @@ -0,0 +1,19 @@ +provideConfigTab('config', array( + 'title' => $this->translate('Configure this module'), + 'label' => $this->translate('Config'), + 'url' => 'config' +)); + + +$menuDisabled = $this->getConfig()->get('pnp4nagios', 'menu_disabled'); +if (! $menuDisabled) { + /** @var \Icinga\Web\Navigation\NavigationItem $section */ + $section = $this->menuSection('pnp'); + $section->setLabel('PNP') + ->setUrl('pnp') + ->setIcon('chart-line') + ->setPriority(50); +} diff --git a/library/Pnp/ProvidedHook/Grapher.php b/library/Pnp/ProvidedHook/Grapher.php new file mode 100644 index 0000000..2dcfbda --- /dev/null +++ b/library/Pnp/ProvidedHook/Grapher.php @@ -0,0 +1,274 @@ +getSection('pnp4nagios'); + $this->configDir = rtrim($cfg->get('config_dir', $this->configDir), '/'); + $this->baseUrl = rtrim($cfg->get('base_url', $this->baseUrl), '/'); + $this->readPnpConfig(); + } + + public function has(MonitoredObject $object) + { + if ($object instanceof Host) { + $service = '_HOST_'; + } elseif ($object instanceof Service) { + $service = $object->service_description; + } else { + return false; + } + + $host = $object->host_name; + return is_file($this->getXmlFilename($host, $service)); + } + + public function getPreviewHtml(MonitoredObject $object) + { + if (! $object->process_perfdata) { + return ''; + } + + // Skip preview images when missing, for local installations only + if (false === strpos($this->baseUrl, '://') && ! $this->has($object)) { + return ''; + } + + if ($object instanceof Host) { + $service = '_HOST_'; + } elseif ($object instanceof Service) { + $service = $object->service_description; + } else { + return ''; + } + + $host = $object->host_name; + + $html = '' + . "\n \n"; + $viewKeys = array_reverse(array_keys($this->pnpViews)); + foreach ($viewKeys as $view) { + $html .= '\n"; + } + $html .= " \n \n"; + foreach ($viewKeys as $view) { + $html .= ' \n"; + } + $html .= "
' . htmlspecialchars($this->getViewName($view)) . "
' + . $this->getPreviewImg($host, $service, $view) + . "
\n"; + return $html; + } + + // Currently unused, but would work fine. This is for tiny preview images + // in list views + public function getSmallPreviewImage($host, $service = null) + { + if ($service === null) { + $service = '_HOST_'; + } + + return sprintf( + '', + $this->baseUrl, + urlencode($this->pnpClean($host)), + urlencode($this->pnpClean($service)) + ); + } + + private function listAdditionalConfigFiles() + { + $files = array(); + $base = $this->configDir . '/config'; + + $file = $base . '_local.php'; + if (file_exists($file) && is_readable($file)) { + $files[] = $file; + } + + $confd = $base . '.d'; + if (is_dir($confd) && is_readable($confd)) { + $dh = opendir($confd); + while ($file === readdir($dh)) { + if ($file[0] === '.') continue; + if (substr($file, -4) !== '.php') continue; + + $filename = $confd . '/' . $file; + if (is_file($filename) && is_readable($filename)) { + $files[] = $filename; + } + } + + closedir($dh); + } + + return $files; + } + + // This reads the PNP4Nagios config and makes it's $conf available + private function readPnpConfig() + { + $file = $this->configDir . '/config.php'; + + if (! is_readable($file)) { + throw new ConfigurationError( + sprintf( + 'Cannot read PNP4Nagios-Web config file "%s"', + $file + ) + ); + } + if (! include($file)) { + throw new ConfigurationError( + sprintf( + 'Including PNP4Nagios-Web config "%s" failed', + $file + ) + ); + } + + if (! isset($views)) { + $views = array(); + } + + foreach ($this->listAdditionalConfigFiles() as $file) { + $oldViews = $views; + include $file; + if (empty($views)) { + $views = $oldViews; + } + } + + if (! isset($conf) || ! is_array($conf)) { + throw new ConfigurationError( + sprintf( + 'There is no $conf in your PNP4Nagios config file "%s"', + $file + ) + ); + } + + if (! isset($views) || ! is_array($views)) { + throw new ConfigurationError( + sprintf( + 'There is no $views array in your PNP4Nagios config file "%s"', + $file + ) + ); + } + + if (! array_key_exists('rrdbase', $conf)) { + throw new ConfigurationError( + sprintf( + 'There is no rrdbase in your PNP4Nagios config file "%s"', + $file + ) + ); + } + $this->pnpConfig = $conf; + $this->pnpViews = $views; + return $this; + } + + // pnp_Core::clean + private function pnpClean($string) + { + if ($string === false) { + return null; + } + return preg_replace('~[ :/\\\]~', '_', $string); + } + + private function getBasePath($host, $service) + { + if ($service === null) { + $service = '_HOST_'; + } + return rtrim($this->pnpConfig['rrdbase'], '/') + . '/' . $this->pnpClean($host) . '/' + . $this->pnpClean($service); + } + + private function getRrdFilename($host, $service) + { + return $this->getBasePath($host, $service) . '.rrd'; + } + + private function getXmlFilename($host, $service) + { + return $this->getBasePath($host, $service) . '.xml'; + } + + private function getPreviewImg($host, $service, $view) + { + $viewName = $this->getViewName($view); + + $host = $this->pnpClean($host); + $service = $this->pnpClean($service); + + $title = $service === '_HOST_' ? sprintf( + '%s, %s', $host, $viewName + ) : sprintf( + '%s on %s, %s', $service, $host, $viewName + ); + + $url = Url::fromPath('pnp/graph', array( + 'host' => $this->pnpClean($host), + 'srv' => $this->pnpClean($service), + 'view' => $view + )); + $imgUrl = sprintf( + '%s/image?host=%s&srv=%s&view=%d&source=0&w=120&h=30', + $this->baseUrl, + urlencode($this->pnpClean($host)), + urlencode($this->pnpClean($service)), + $view + ); + + $html = '%s'; + + return sprintf( + $html, + $url, + htmlspecialchars($title), + $imgUrl, + htmlspecialchars(mt('pnp', 'Loading') . '...') + ); + } + + protected function getViewName($view) + { + return mt('pnp4nagios', $this->pnpViews[$view]['title']); + } + + private function unusedFunctionAllowingToTranslateForeignStrings() + { + mt('pnp4nagios', '4 Hours'); + mt('pnp4nagios', '25 Hours'); + mt('pnp4nagios', 'One Week'); + mt('pnp4nagios', 'One Month'); + mt('pnp4nagios', 'One Year'); + } +} diff --git a/library/Pnp/Web/Controller.php b/library/Pnp/Web/Controller.php new file mode 100644 index 0000000..4af5c06 --- /dev/null +++ b/library/Pnp/Web/Controller.php @@ -0,0 +1,27 @@ +getTabs()->add('pnp', array( + 'label' => $this->translate('PNP'), + 'url' => 'pnp', + )); + } + + protected function setViewScript($name) + { + $this->_helper->viewRenderer->setNoController(true); + $this->_helper->viewRenderer->setScriptAction($name); + } + + protected function getBaseUrl() + { + return rtrim($this->Config()->get('pnp4nagios', 'base_url', '/pnp4nagios'), '/'); + } +} diff --git a/module.info b/module.info new file mode 100644 index 0000000..1919ef2 --- /dev/null +++ b/module.info @@ -0,0 +1,8 @@ +Name: PNP4Nagios +Version: 1.0.1 +Depends: monitoring>=2.1.0 +Description: Timeseries grapher integration for PNP4Nagios + PNP is an addon to Icinga or Nagios which analyzes performance data + provided by plugins and stores them automatically into RRD-database. + + This module requires PNP4Nagios to be fully configured and installed. diff --git a/run.php b/run.php new file mode 100644 index 0000000..7b66ae4 --- /dev/null +++ b/run.php @@ -0,0 +1,3 @@ +provideHook('grapher'); -- cgit v1.2.3