summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.mailmap5
-rw-r--r--AUTHORS10
-rw-r--r--LICENSE339
-rw-r--r--README.md15
-rw-r--r--application/controllers/IntegrationsController.php118
-rw-r--r--application/forms/Config/TtsIntegrationConfigForm.php249
-rw-r--r--application/views/scripts/integrations/index.phtml56
-rw-r--r--application/views/scripts/integrations/new.phtml6
-rw-r--r--application/views/scripts/integrations/remove.phtml6
-rw-r--r--application/views/scripts/integrations/update.phtml6
-rw-r--r--configuration.php11
-rw-r--r--doc/01-About.md15
-rw-r--r--doc/02-Installation.md20
-rw-r--r--doc/02-Installation.md.d/From-Source.md10
-rw-r--r--doc/03-Configuration.md25
-rw-r--r--library/Generictts/Ticket.php71
-rw-r--r--module.info7
-rw-r--r--public/css/module.less5
-rw-r--r--run.php5
19 files changed, 979 insertions, 0 deletions
diff --git a/.mailmap b/.mailmap
new file mode 100644
index 0000000..50a7ca3
--- /dev/null
+++ b/.mailmap
@@ -0,0 +1,5 @@
+Eric Lippmann <eric.lippmann@icinga.com> <eric.lippmann@netways.de>
+Henrik Triem <henrik.triem@icinga.com> <43344334+htriem@users.noreply.github.com>
+Johannes Meyer <johannes.meyer@icinga.com> <johannes.meyer@netways.de>
+Marius Hein <marius.hein@netways.de>
+Thomas Gelf <thomas@gelf.net>
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..ecb40dc
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,10 @@
+Christopher Peterson <3893680+cspeterson@users.noreply.github.com>
+Eric Lippmann <eric.lippmann@icinga.com>
+Henrik Triem <henrik.triem@icinga.com>
+Johannes Meyer <johannes.meyer@icinga.com>
+Jon Goldberg <jon@megaphonetech.com>
+Marius Hein <marius.hein@netways.de>
+Michael Friedrich <michael.friedrich@icinga.com>
+Rudy Gevaert <rudy.gevaert@ugent.be>
+Thomas Gelf <thomas@gelf.net>
+Yonas Habteab <yonas.habteab@icinga.com>
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d159169
--- /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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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.
+
+ <signature of Ty Coon>, 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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..06b375f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Icinga Web GenericTTS Integration
+
+With the Icinga Web GenericTTS integration, you can replace ticket patterns in acknowledgements,
+downtimes, and comments with links to your trouble ticket systems.
+To do this, you configure one or more unique regular expressions to link to them.
+
+## Documentation
+
+Icinga Web GenericTTS Integration documentation is available at [icinga.com/docs](https://icinga.com/docs/icinga-web-generictts-integration/latest/).
+
+## License
+
+Icinga Web GenericTTS Integration
+and the Icinga Web GenericTTS Integration documentation are licensed under the terms of the
+[GNU General Public License Version 2](LICENSE).
diff --git a/application/controllers/IntegrationsController.php b/application/controllers/IntegrationsController.php
new file mode 100644
index 0000000..340e15d
--- /dev/null
+++ b/application/controllers/IntegrationsController.php
@@ -0,0 +1,118 @@
+<?php
+
+/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Module\Generictts\Controllers;
+
+use Icinga\Exception\NotFoundError;
+use Icinga\Forms\ConfirmRemovalForm;
+use Icinga\Module\Generictts\Forms\Config\TtsIntegrationConfigForm;
+use Icinga\Web\Controller;
+use Icinga\Web\Notification;
+
+/**
+ * Manage trouble ticket system integrations
+ */
+class IntegrationsController extends Controller
+{
+ /**
+ * List trouble ticket system integrations
+ */
+ public function indexAction()
+ {
+ $this->getTabs()->add('integrations', array(
+ 'active' => true,
+ 'label' => $this->translate('Integrations'),
+ 'url' => $this->getRequest()->getUrl()
+ ));
+ $this->view->integrations = $this->Config();
+ }
+
+ /**
+ * Integrate a new trouble ticket system
+ */
+ public function newAction()
+ {
+ $this->getTabs()->add('new-integration', array(
+ 'active' => true,
+ 'label' => $this->translate('New Integration'),
+ 'url' => $this->getRequest()->getUrl()
+ ));
+
+ $integrations = new TtsIntegrationConfigForm();
+ $integrations
+ ->setIniConfig($this->Config())
+ ->setRedirectUrl('generictts/integrations')
+ ->handleRequest();
+
+ $this->view->form = $integrations;
+ }
+
+ /**
+ * Remove a trouble ticket system integration
+ */
+ public function removeAction()
+ {
+ $integration = $this->params->getRequired('integration');
+
+ $this->getTabs()->add('remove-integration', array(
+ 'active' => true,
+ 'label' => $this->translate('Remove Integration'),
+ 'url' => $this->getRequest()->getUrl()
+ ));
+
+ $integrations = new TtsIntegrationConfigForm();
+ try {
+ $integrations
+ ->setIniConfig($this->Config())
+ ->bind($integration);
+ } catch (NotFoundError $e) {
+ $this->httpNotFound($e->getMessage());
+ }
+
+ $confirmation = new ConfirmRemovalForm(array(
+ 'onSuccess' => function (ConfirmRemovalForm $confirmation) use ($integration, $integrations) {
+ $integrations->remove($integration);
+ if ($integrations->save()) {
+ Notification::success(mt('generictts', 'TTS integration removed'));
+ return true;
+ }
+ return false;
+ }
+ ));
+ $confirmation
+ ->setRedirectUrl('generictts/integrations')
+ ->setSubmitLabel($this->translate('Remove Integration'))
+ ->handleRequest();
+
+ $this->view->form = $confirmation;
+ }
+
+ /**
+ * Update a trouble ticket system integration
+ */
+ public function updateAction()
+ {
+ $integration = $this->params->getRequired('integration');
+
+ $this->getTabs()->add('update-integration', array(
+ 'active' => true,
+ 'label' => $this->translate('Update Integration'),
+ 'url' => $this->getRequest()->getUrl()
+ ));
+
+ $integrations = new TtsIntegrationConfigForm();
+ try {
+ $integrations
+ ->setIniConfig($this->Config())
+ ->bind($integration);
+ } catch (NotFoundError $e) {
+ $this->httpNotFound($e->getMessage());
+ }
+ $integrations
+ ->setRedirectUrl('generictts/integrations')
+ ->handleRequest();
+
+ $this->view->form = $integrations;
+ }
+}
diff --git a/application/forms/Config/TtsIntegrationConfigForm.php b/application/forms/Config/TtsIntegrationConfigForm.php
new file mode 100644
index 0000000..2bdb562
--- /dev/null
+++ b/application/forms/Config/TtsIntegrationConfigForm.php
@@ -0,0 +1,249 @@
+<?php
+
+/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Module\Generictts\Forms\Config;
+
+use Zend_Validate_Callback;
+use Icinga\Exception\AlreadyExistsException;
+use Icinga\Exception\IcingaException;
+use Icinga\Exception\NotFoundError;
+use Icinga\Forms\ConfigForm;
+use Icinga\Web\Form\Validator\UrlValidator;
+use Icinga\Web\Notification;
+
+/**
+ * Form for managing trouble ticket system integrations
+ */
+class TtsIntegrationConfigForm extends ConfigForm
+{
+ /**
+ * Name of the integration if the form is bound to one
+ *
+ * @var string
+ */
+ protected $boundIntegration;
+
+ /**
+ * {@inheritdoc}
+ */
+ public function init()
+ {
+ $this->setName('form_config_generictts_tts_integrations');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function createElements(array $formData)
+ {
+ $this->addElement(
+ 'text',
+ 'name',
+ array(
+ 'description' => $this->translate('The name of the TTS integration'),
+ 'label' => $this->translate('Name'),
+ 'required' => true
+ )
+ );
+
+ $patternValidator = new Zend_Validate_Callback(function ($value) {
+ return @preg_match($value, '') !== false;
+ });
+ $patternValidator->setMessage(
+ $this->translate('"%value%" is not a valid regular expression.'),
+ Zend_Validate_Callback::INVALID_VALUE
+ );
+ $this->addElement(
+ 'text',
+ 'pattern',
+ array(
+ 'value' => '/this-will-not-match(\d{3-6})/',
+ 'label' => $this->translate('Ticket Pattern'),
+ 'description' => $this->translate(
+ 'The pattern to extract ticket IDs from comments.'
+ . ' The ticket pattern must be a valid regular expression'
+ ),
+ 'required' => true,
+ 'validators' => array($patternValidator)
+ )
+ );
+
+ $urlValidator = new Zend_Validate_Callback(function ($value) {
+ return strpos($value, '$1') !== false;
+ });
+ $urlValidator->setMessage(
+ $this->translate('The URL must contain the placeholder $1 to be substituted with a ticket ID.'),
+ Zend_Validate_Callback::INVALID_VALUE
+ );
+ $this->addElement(
+ 'text',
+ 'url',
+ array(
+ 'value' => 'http://no-such-domain.example.com/ticket?id=$1',
+ 'label' => $this->translate('TTS Ticket URL'),
+ 'description' => $this->translate(
+ 'The URL pointing to the TTS with $1 as the placeholder for the ticket ID'
+ ),
+ 'required' => true,
+ 'validators' => array($urlValidator, new UrlValidator())
+ )
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getSubmitLabel()
+ {
+ if (($submitLabel = parent::getSubmitLabel()) === null) {
+ if ($this->boundIntegration === null) {
+ $submitLabel = $this->translate('Integrate');
+ } else {
+ $submitLabel = $this->translate('Update Integration');
+ }
+ }
+ return $submitLabel;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function onRequest()
+ {
+ // The base class implementation does not make sense here. We're not populating the whole configuration but
+ // only a section
+ return;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function onSuccess()
+ {
+ $name = $this->getElement('name')->getValue();
+ $values = array(
+ 'pattern' => $this->getElement('pattern')->getValue(),
+ 'url' => $this->getElement('url')->getValue()
+ );
+ if ($this->boundIntegration === null) {
+ $successNotification = $this->translate('TTS integrated');
+ try {
+ $this->add($name, $values);
+ } catch (AlreadyExistsException $e) {
+ $this->addError($e->getMessage());
+ return false;
+ }
+ } else {
+ $successNotification = $this->translate('TTS integration updated');
+ try {
+ $this->update($name, $values, $this->boundIntegration);
+ } catch (IcingaException $e) {
+ // Exception may be AlreadyExistsException or NotFoundError
+ $this->addError($e->getMessage());
+ return false;
+ }
+ }
+ if ($this->save()) {
+ Notification::success($successNotification);
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Add a TTS integration
+ *
+ * @param string $name The name of the integration
+ * @param array $values
+ *
+ * @return $this
+ *
+ * @throws AlreadyExistsException If the integration to add already exists
+ */
+ public function add($name, array $values)
+ {
+ if ($this->config->hasSection($name)) {
+ throw new AlreadyExistsException(
+ $this->translate('Can\'t add integration \'%s\'. Integration already exists'),
+ $name
+ );
+ }
+ $this->config->setSection($name, $values);
+ return $this;
+ }
+
+ /**
+ * Bind integration to this form
+ *
+ * @param string $name The name of the integration
+ *
+ * @return $this
+ *
+ * @throws NotFoundError If the given integration does not exist
+ */
+ public function bind($name)
+ {
+ if (! $this->config->hasSection($name)) {
+ throw new NotFoundError(
+ $this->translate('Can\'t load integration \'%s\'. Integration does not exist'),
+ $name
+ );
+ }
+ $this->boundIntegration = $name;
+ $integration = $this->config->getSection($name)->toArray();
+ $integration['name'] = $name;
+ $this->populate($integration);
+ return $this;
+ }
+
+ /**
+ * Remove a TTS integration
+ *
+ * @param string $name The name of the integration
+ *
+ * @return $this
+ *
+ * @throws NotFoundError If the role does not exist
+ */
+ public function remove($name)
+ {
+ if (! $this->config->hasSection($name)) {
+ throw new NotFoundError(
+ $this->translate('Can\'t remove integration \'%s\'. Integration does not exist'),
+ $name
+ );
+ }
+ $this->config->removeSection($name);
+ return $this;
+ }
+
+ /**
+ * Update a TTS integration
+ *
+ * @param string $name The possibly new name of the integration
+ * @param array $values
+ * @param string $oldName The name of the integration to update
+ *
+ * @return $this
+ *
+ * @throws NotFoundError If the integration to update does not exist
+ */
+ public function update($name, array $values, $oldName)
+ {
+ if ($name !== $oldName) {
+ // The integration got a new name
+ $this->remove($oldName);
+ $this->add($name, $values);
+ } else {
+ if (! $this->config->hasSection($name)) {
+ throw new NotFoundError(
+ $this->translate('Can\'t update integration \'%s\'. Integration does not exist'),
+ $name
+ );
+ }
+ $this->config->setSection($name, $values);
+ }
+ return $this;
+ }
+}
diff --git a/application/views/scripts/integrations/index.phtml b/application/views/scripts/integrations/index.phtml
new file mode 100644
index 0000000..0f657ce
--- /dev/null
+++ b/application/views/scripts/integrations/index.phtml
@@ -0,0 +1,56 @@
+<div class="controls">
+ <?= $tabs ?>
+ <?= $this->qlink(
+ $this->translate('Integrate New Ticket System') ,
+ 'generictts/integrations/new',
+ null,
+ array(
+ 'class' => 'action-link',
+ 'data-base-target' => '_next',
+ 'icon' => 'plus',
+ 'title' => $this->translate('Integrate a new trouble ticket system')
+ )
+ ) ?>
+</div>
+<div class="content">
+<?php /** @var \Icinga\Application\Config $integrations */ if ($integrations->isEmpty()): ?>
+ <p><?= $this->translate('No ticket system has been integrated yet.') ?></p>
+<?php return; endif ?>
+ <table class="tts-integrations-table common-table table-row-selectable" data-base-target="_next">
+ <thead>
+ <tr>
+ <th><?= $this->translate('Name') ?></th>
+ <th><?= $this->translate('Pattern') ?></th>
+ <th><?= $this->translate('URL') ?></th>
+ </tr>
+ </thead>
+ <tbody>
+ <?php foreach ($integrations as $name => $integration): /** @var object $role */ ?>
+ <tr>
+ <td>
+ <?= $this->qlink(
+ $name,
+ 'generictts/integrations/update',
+ array('integration' => $name),
+ array('title' => sprintf($this->translate('Update integration %s'), $name))
+ ) ?>
+ </td>
+ <td><?= $this->escape($integration->pattern) ?></td>
+ <td><?= $this->escape($integration->url) ?></td>
+ <td class="icon-col text-right">
+ <?= $this->qlink(
+ '',
+ 'generictts/integrations/remove',
+ array('integration' => $name),
+ array(
+ 'class' => 'action-link',
+ 'icon' => 'cancel',
+ 'title' => sprintf($this->translate('Remove integration %s'), $name)
+ )
+ ) ?>
+ </td>
+ </tr>
+ <?php endforeach ?>
+ </tbody>
+ </table>
+</div>
diff --git a/application/views/scripts/integrations/new.phtml b/application/views/scripts/integrations/new.phtml
new file mode 100644
index 0000000..13a8ed9
--- /dev/null
+++ b/application/views/scripts/integrations/new.phtml
@@ -0,0 +1,6 @@
+<div class="controls">
+ <?= $tabs ?>
+</div>
+<div class="content">
+ <?= $form ?>
+</div>
diff --git a/application/views/scripts/integrations/remove.phtml b/application/views/scripts/integrations/remove.phtml
new file mode 100644
index 0000000..13a8ed9
--- /dev/null
+++ b/application/views/scripts/integrations/remove.phtml
@@ -0,0 +1,6 @@
+<div class="controls">
+ <?= $tabs ?>
+</div>
+<div class="content">
+ <?= $form ?>
+</div>
diff --git a/application/views/scripts/integrations/update.phtml b/application/views/scripts/integrations/update.phtml
new file mode 100644
index 0000000..13a8ed9
--- /dev/null
+++ b/application/views/scripts/integrations/update.phtml
@@ -0,0 +1,6 @@
+<div class="controls">
+ <?= $tabs ?>
+</div>
+<div class="content">
+ <?= $form ?>
+</div>
diff --git a/configuration.php b/configuration.php
new file mode 100644
index 0000000..81b31ef
--- /dev/null
+++ b/configuration.php
@@ -0,0 +1,11 @@
+<?php
+
+/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */
+
+/** @var $this \Icinga\Application\Modules\Module */
+
+$this->provideConfigTab('integrations', array(
+ 'label' => $this->translate('TTS Integrations'),
+ 'title' => $this->translate('Manage trouble ticket system integrations'),
+ 'url' => 'integrations'
+));
diff --git a/doc/01-About.md b/doc/01-About.md
new file mode 100644
index 0000000..6c47e80
--- /dev/null
+++ b/doc/01-About.md
@@ -0,0 +1,15 @@
+# Icinga Web GenericTTS Integration
+
+With the Icinga Web GenericTTS integration, you can replace ticket patterns in acknowledgements,
+downtimes, and comments with links to your trouble ticket systems.
+To do this, you configure one or more unique regular expressions to link to them.
+
+## Installation
+
+To install Icinga Web GenericTTS Integration see [Installation](02-Installation.md).
+
+## License
+
+Icinga Web GenericTTS Integration
+and the Icinga Web GenericTTS Integration documentation are licensed under the terms of the
+GNU General Public License Version 2.
diff --git a/doc/02-Installation.md b/doc/02-Installation.md
new file mode 100644
index 0000000..bf720e2
--- /dev/null
+++ b/doc/02-Installation.md
@@ -0,0 +1,20 @@
+<!-- {% if index %} -->
+# Installing Icinga Web GenericTTS Integration
+
+The recommended way to install Icinga Web GenericTTS Integration
+and its dependencies is to use prebuilt packages for
+all supported platforms from our official release repository.
+Please note that [Icinga Web](https://icinga.com/docs/icinga-web) is required to run Icinga Web GenericTTS Integration
+and if it is not already set up, it is best to do this first.
+
+The following steps will guide you through installing and setting up Icinga Web GenericTTS Integration.
+<!-- {% else %} -->
+<!-- {% if not icingaDocs %} -->
+
+## Installing the Package
+
+If the [repository](https://packages.icinga.com) is not configured yet, please add it first.
+Then use your distribution's package manager to install the `icinga-generictts` package
+or install [from source](02-Installation.md.d/From-Source.md).
+<!-- {% endif %} -->
+<!-- {% endif %} --><!-- {# end else if index #} -->
diff --git a/doc/02-Installation.md.d/From-Source.md b/doc/02-Installation.md.d/From-Source.md
new file mode 100644
index 0000000..9f38577
--- /dev/null
+++ b/doc/02-Installation.md.d/From-Source.md
@@ -0,0 +1,10 @@
+# Installing Icinga Web GenericTTS Integration from Source
+
+Please see the Icinga Web documentation on
+[how to install modules](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation) from source.
+Make sure you use `generictts` as the module name. The following requirements must also be met.
+
+## Requirements
+
+* [Icinga Web](https://icinga.com/docs/icinga-web/latest/)
+<!-- {% include "02-Installation.md" %} -->
diff --git a/doc/03-Configuration.md b/doc/03-Configuration.md
new file mode 100644
index 0000000..84e915c
--- /dev/null
+++ b/doc/03-Configuration.md
@@ -0,0 +1,25 @@
+# Configuration
+
+After enabling `generictts`,
+you can access its configuration in Icinga Web via the module's configuration tab.
+But you can also change its configuration manually.
+`generictts` maintains a configuration file that is normally located under the following path:
+
+```
+/etc/icingaweb2/modules/generictts/config.ini
+```
+
+## Example Configuration
+
+You need to understand regular expressions for the configuration.
+A pattern has to be specified that captures a ticket reference for use in a link to your ticket system.
+
+In the following example, every time we encounter an acknowledgement, downtime, or comment
+that contains a hash `#` followed by digits, that number is stored in the capturing group `$1`
+and replaced with a link that references that specific ticket in your ticket system.
+
+```ini
+[my-ticket-system]
+pattern = "/#([0-9]+)/"
+url = "https://my.ticket.system/tickets/id=$1"
+```
diff --git a/library/Generictts/Ticket.php b/library/Generictts/Ticket.php
new file mode 100644
index 0000000..b8ded1d
--- /dev/null
+++ b/library/Generictts/Ticket.php
@@ -0,0 +1,71 @@
+<?php
+
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Module\Generictts;
+
+use Icinga\Application\Config;
+use Icinga\Application\Hook\TicketHook;
+
+/**
+ * GenericTTS TicketHook implementation
+ */
+class Ticket extends TicketHook
+{
+ /**
+ * GenericTTS configuration
+ *
+ * @var \Icinga\Application\Config
+ */
+ protected $config;
+
+ /**
+ * Configured trouble ticket system integrations
+ *
+ * @var \Icinga\Application\Hook\Ticket\TicketPattern[]
+ */
+ protected $ticketPatterns;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function init()
+ {
+ $config = Config::module('generictts');
+ $this->config = $config;
+
+ $ticketPatterns = array();
+ foreach ($config as $section => $values) {
+ if ($values->get('url')) { // Skip integrations that don't contain a URL
+ $ticketPattern = $this->createTicketPattern($section, $values->get('pattern'));
+ if ($ticketPattern->isValid()) { // Skip integrations that don't contain a pattern
+ $ticketPatterns[$section] = $ticketPattern;
+ }
+ }
+ }
+ $this->ticketPatterns = $ticketPatterns;
+ }
+
+ /**
+ * {@inheritdoc}
+ *
+ * @return \Icinga\Application\Hook\Ticket\TicketPattern[]
+ */
+ public function getPattern()
+ {
+ return $this->ticketPatterns;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function createLink($match)
+ {
+ /** @var \Icinga\Application\Hook\Ticket\TicketPattern $match */
+ return sprintf(
+ '<a href="%s" target="_blank">%s</a>',
+ preg_replace('/\$1/', rawurlencode($match[1]), $this->config->get($match->getName(), 'url')),
+ $match[0]
+ );
+ }
+}
diff --git a/module.info b/module.info
new file mode 100644
index 0000000..b2d0984
--- /dev/null
+++ b/module.info
@@ -0,0 +1,7 @@
+Module: generictts
+Version: 2.1.0
+Description: Generic Trouble Ticket System connection module
+ This module allows to easily link issue/ticket numbers in your Icinga
+ acknowledgement or downtime comments. Configure a pattern matching
+ your ticket numbers and a URL with placeholders. Please note that
+ Icinga Web 2 version 2.3.0 is required at least to run this module.
diff --git a/public/css/module.less b/public/css/module.less
new file mode 100644
index 0000000..a00320c
--- /dev/null
+++ b/public/css/module.less
@@ -0,0 +1,5 @@
+/*! Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */
+
+.tts-integrations-table {
+ table-layout: fixed;
+}
diff --git a/run.php b/run.php
new file mode 100644
index 0000000..e0d2a4c
--- /dev/null
+++ b/run.php
@@ -0,0 +1,5 @@
+<?php
+
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+$this->provideHook('ticket', '\\Icinga\\Module\\Generictts\\Ticket');