├── .mailmap ├── AUTHORS ├── LICENSE ├── README.md ├── application ├── controllers │ └── IntegrationsController.php ├── forms │ └── Config │ │ └── TtsIntegrationConfigForm.php └── views │ └── scripts │ └── integrations │ ├── index.phtml │ ├── new.phtml │ ├── remove.phtml │ └── update.phtml ├── configuration.php ├── doc ├── 01-About.md ├── 02-Installation.md ├── 02-Installation.md.d │ └── From-Source.md └── 03-Configuration.md ├── library └── Generictts │ └── Ticket.php ├── module.info ├── phpstan-baseline.neon ├── phpstan.neon ├── public └── css │ └── module.less └── run.php /.mailmap: -------------------------------------------------------------------------------- 1 | Eric Lippmann 2 | Henrik Triem <43344334+htriem@users.noreply.github.com> 3 | Johannes Meyer 4 | Marius Hein 5 | Thomas Gelf 6 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Christopher Peterson <3893680+cspeterson@users.noreply.github.com> 2 | Eric Lippmann 3 | Henrik Triem 4 | Johannes Meyer 5 | Jon Goldberg 6 | Marius Hein 7 | Michael Friedrich 8 | Rudy Gevaert 9 | Thomas Gelf 10 | Yonas Habteab 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Icinga Web GenericTTS Integration 2 | 3 | With the Icinga Web GenericTTS integration, you can replace ticket patterns in acknowledgements, 4 | downtimes, and comments with links to your trouble ticket systems. 5 | To do this, you configure one or more unique regular expressions to link to them. 6 | 7 | ## Documentation 8 | 9 | Icinga Web GenericTTS Integration documentation is available at [icinga.com/docs](https://icinga.com/docs/icinga-web-generictts-integration/latest/). 10 | 11 | ## License 12 | 13 | Icinga Web GenericTTS Integration 14 | and the Icinga Web GenericTTS Integration documentation are licensed under the terms of the 15 | [GNU General Public License Version 2](LICENSE). 16 | -------------------------------------------------------------------------------- /application/controllers/IntegrationsController.php: -------------------------------------------------------------------------------- 1 | getTabs()->add('integrations', array( 24 | 'active' => true, 25 | 'label' => $this->translate('Integrations'), 26 | 'url' => $this->getRequest()->getUrl() 27 | )); 28 | $this->view->integrations = $this->Config(); 29 | } 30 | 31 | /** 32 | * Integrate a new trouble ticket system 33 | */ 34 | public function newAction() 35 | { 36 | $this->getTabs()->add('new-integration', array( 37 | 'active' => true, 38 | 'label' => $this->translate('New Integration'), 39 | 'url' => $this->getRequest()->getUrl() 40 | )); 41 | 42 | $integrations = new TtsIntegrationConfigForm(); 43 | $integrations 44 | ->setIniConfig($this->Config()) 45 | ->setRedirectUrl('generictts/integrations') 46 | ->handleRequest(); 47 | 48 | $this->view->form = $integrations; 49 | } 50 | 51 | /** 52 | * Remove a trouble ticket system integration 53 | */ 54 | public function removeAction() 55 | { 56 | $integration = $this->params->getRequired('integration'); 57 | 58 | $this->getTabs()->add('remove-integration', array( 59 | 'active' => true, 60 | 'label' => $this->translate('Remove Integration'), 61 | 'url' => $this->getRequest()->getUrl() 62 | )); 63 | 64 | $integrations = new TtsIntegrationConfigForm(); 65 | try { 66 | $integrations 67 | ->setIniConfig($this->Config()) 68 | ->bind($integration); 69 | } catch (NotFoundError $e) { 70 | $this->httpNotFound($e->getMessage()); 71 | } 72 | 73 | $confirmation = new ConfirmRemovalForm(array( 74 | 'onSuccess' => function (ConfirmRemovalForm $confirmation) use ($integration, $integrations) { 75 | $integrations->remove($integration); 76 | if ($integrations->save()) { 77 | Notification::success(mt('generictts', 'TTS integration removed')); 78 | return true; 79 | } 80 | return false; 81 | } 82 | )); 83 | $confirmation 84 | ->setRedirectUrl('generictts/integrations') 85 | ->setSubmitLabel($this->translate('Remove Integration')) 86 | ->handleRequest(); 87 | 88 | $this->view->form = $confirmation; 89 | } 90 | 91 | /** 92 | * Update a trouble ticket system integration 93 | */ 94 | public function updateAction() 95 | { 96 | $integration = $this->params->getRequired('integration'); 97 | 98 | $this->getTabs()->add('update-integration', array( 99 | 'active' => true, 100 | 'label' => $this->translate('Update Integration'), 101 | 'url' => $this->getRequest()->getUrl() 102 | )); 103 | 104 | $integrations = new TtsIntegrationConfigForm(); 105 | try { 106 | $integrations 107 | ->setIniConfig($this->Config()) 108 | ->bind($integration); 109 | } catch (NotFoundError $e) { 110 | $this->httpNotFound($e->getMessage()); 111 | } 112 | $integrations 113 | ->setRedirectUrl('generictts/integrations') 114 | ->handleRequest(); 115 | 116 | $this->view->form = $integrations; 117 | } 118 | } 119 | -------------------------------------------------------------------------------- /application/forms/Config/TtsIntegrationConfigForm.php: -------------------------------------------------------------------------------- 1 | setName('form_config_generictts_tts_integrations'); 33 | } 34 | 35 | /** 36 | * {@inheritdoc} 37 | */ 38 | public function createElements(array $formData) 39 | { 40 | $this->addElement( 41 | 'text', 42 | 'name', 43 | array( 44 | 'description' => $this->translate('The name of the TTS integration'), 45 | 'label' => $this->translate('Name'), 46 | 'required' => true 47 | ) 48 | ); 49 | 50 | $patternValidator = new Zend_Validate_Callback(function ($value) { 51 | return @preg_match($value, '') !== false; 52 | }); 53 | $patternValidator->setMessage( 54 | $this->translate('"%value%" is not a valid regular expression.'), 55 | Zend_Validate_Callback::INVALID_VALUE 56 | ); 57 | $this->addElement( 58 | 'text', 59 | 'pattern', 60 | array( 61 | 'value' => '/this-will-not-match(\d{3-6})/', 62 | 'label' => $this->translate('Ticket Pattern'), 63 | 'description' => $this->translate( 64 | 'The pattern to extract ticket IDs from comments.' 65 | . ' The ticket pattern must be a valid regular expression' 66 | ), 67 | 'required' => true, 68 | 'validators' => array($patternValidator) 69 | ) 70 | ); 71 | 72 | $urlValidator = new Zend_Validate_Callback(function ($value) { 73 | return strpos($value, '$1') !== false; 74 | }); 75 | $urlValidator->setMessage( 76 | $this->translate('The URL must contain the placeholder $1 to be substituted with a ticket ID.'), 77 | Zend_Validate_Callback::INVALID_VALUE 78 | ); 79 | $this->addElement( 80 | 'text', 81 | 'url', 82 | array( 83 | 'value' => 'http://no-such-domain.example.com/ticket?id=$1', 84 | 'label' => $this->translate('TTS Ticket URL'), 85 | 'description' => $this->translate( 86 | 'The URL pointing to the TTS with $1 as the placeholder for the ticket ID' 87 | ), 88 | 'required' => true, 89 | 'validators' => array($urlValidator, new UrlValidator()) 90 | ) 91 | ); 92 | } 93 | 94 | /** 95 | * {@inheritdoc} 96 | */ 97 | public function getSubmitLabel() 98 | { 99 | if (($submitLabel = parent::getSubmitLabel()) === null) { 100 | if ($this->boundIntegration === null) { 101 | $submitLabel = $this->translate('Integrate'); 102 | } else { 103 | $submitLabel = $this->translate('Update Integration'); 104 | } 105 | } 106 | return $submitLabel; 107 | } 108 | 109 | /** 110 | * {@inheritdoc} 111 | */ 112 | public function onRequest() 113 | { 114 | // The base class implementation does not make sense here. We're not populating the whole configuration but 115 | // only a section 116 | return; 117 | } 118 | 119 | /** 120 | * {@inheritdoc} 121 | */ 122 | public function onSuccess() 123 | { 124 | $name = $this->getElement('name')->getValue(); 125 | $values = array( 126 | 'pattern' => $this->getElement('pattern')->getValue(), 127 | 'url' => $this->getElement('url')->getValue() 128 | ); 129 | if ($this->boundIntegration === null) { 130 | $successNotification = $this->translate('TTS integrated'); 131 | try { 132 | $this->add($name, $values); 133 | } catch (AlreadyExistsException $e) { 134 | $this->addError($e->getMessage()); 135 | return false; 136 | } 137 | } else { 138 | $successNotification = $this->translate('TTS integration updated'); 139 | try { 140 | $this->update($name, $values, $this->boundIntegration); 141 | } catch (IcingaException $e) { 142 | // Exception may be AlreadyExistsException or NotFoundError 143 | $this->addError($e->getMessage()); 144 | return false; 145 | } 146 | } 147 | if ($this->save()) { 148 | Notification::success($successNotification); 149 | return true; 150 | } 151 | return false; 152 | } 153 | 154 | /** 155 | * Add a TTS integration 156 | * 157 | * @param string $name The name of the integration 158 | * @param array $values 159 | * 160 | * @return $this 161 | * 162 | * @throws AlreadyExistsException If the integration to add already exists 163 | */ 164 | public function add($name, array $values) 165 | { 166 | if ($this->config->hasSection($name)) { 167 | throw new AlreadyExistsException( 168 | $this->translate('Can\'t add integration \'%s\'. Integration already exists'), 169 | $name 170 | ); 171 | } 172 | $this->config->setSection($name, $values); 173 | return $this; 174 | } 175 | 176 | /** 177 | * Bind integration to this form 178 | * 179 | * @param string $name The name of the integration 180 | * 181 | * @return $this 182 | * 183 | * @throws NotFoundError If the given integration does not exist 184 | */ 185 | public function bind($name) 186 | { 187 | if (! $this->config->hasSection($name)) { 188 | throw new NotFoundError( 189 | $this->translate('Can\'t load integration \'%s\'. Integration does not exist'), 190 | $name 191 | ); 192 | } 193 | $this->boundIntegration = $name; 194 | $integration = $this->config->getSection($name)->toArray(); 195 | $integration['name'] = $name; 196 | $this->populate($integration); 197 | return $this; 198 | } 199 | 200 | /** 201 | * Remove a TTS integration 202 | * 203 | * @param string $name The name of the integration 204 | * 205 | * @return $this 206 | * 207 | * @throws NotFoundError If the role does not exist 208 | */ 209 | public function remove($name) 210 | { 211 | if (! $this->config->hasSection($name)) { 212 | throw new NotFoundError( 213 | $this->translate('Can\'t remove integration \'%s\'. Integration does not exist'), 214 | $name 215 | ); 216 | } 217 | $this->config->removeSection($name); 218 | return $this; 219 | } 220 | 221 | /** 222 | * Update a TTS integration 223 | * 224 | * @param string $name The possibly new name of the integration 225 | * @param array $values 226 | * @param string $oldName The name of the integration to update 227 | * 228 | * @return $this 229 | * 230 | * @throws NotFoundError If the integration to update does not exist 231 | */ 232 | public function update($name, array $values, $oldName) 233 | { 234 | if ($name !== $oldName) { 235 | // The integration got a new name 236 | $this->remove($oldName); 237 | $this->add($name, $values); 238 | } else { 239 | if (! $this->config->hasSection($name)) { 240 | throw new NotFoundError( 241 | $this->translate('Can\'t update integration \'%s\'. Integration does not exist'), 242 | $name 243 | ); 244 | } 245 | $this->config->setSection($name, $values); 246 | } 247 | return $this; 248 | } 249 | } 250 | -------------------------------------------------------------------------------- /application/views/scripts/integrations/index.phtml: -------------------------------------------------------------------------------- 1 |
2 | 3 | qlink( 4 | $this->translate('Integrate New Ticket System') , 5 | 'generictts/integrations/new', 6 | null, 7 | array( 8 | 'class' => 'action-link', 9 | 'data-base-target' => '_next', 10 | 'icon' => 'plus', 11 | 'title' => $this->translate('Integrate a new trouble ticket system') 12 | ) 13 | ) ?> 14 |
15 |
16 | isEmpty()): ?> 17 |

translate('No ticket system has been integrated yet.') ?>

18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | $integration): /** @var object $role */ ?> 29 | 30 | 38 | 39 | 40 | 52 | 53 | 54 | 55 |
translate('Name') ?>translate('Pattern') ?>translate('URL') ?>
31 | qlink( 32 | $name, 33 | 'generictts/integrations/update', 34 | array('integration' => $name), 35 | array('title' => sprintf($this->translate('Update integration %s'), $name)) 36 | ) ?> 37 | escape($integration->pattern) ?>escape($integration->url) ?> 41 | qlink( 42 | '', 43 | 'generictts/integrations/remove', 44 | array('integration' => $name), 45 | array( 46 | 'class' => 'action-link', 47 | 'icon' => 'cancel', 48 | 'title' => sprintf($this->translate('Remove integration %s'), $name) 49 | ) 50 | ) ?> 51 |
56 |
57 | -------------------------------------------------------------------------------- /application/views/scripts/integrations/new.phtml: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 |
5 | 6 |
7 | -------------------------------------------------------------------------------- /application/views/scripts/integrations/remove.phtml: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 |
5 | 6 |
7 | -------------------------------------------------------------------------------- /application/views/scripts/integrations/update.phtml: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 |
5 | 6 |
7 | -------------------------------------------------------------------------------- /configuration.php: -------------------------------------------------------------------------------- 1 | provideConfigTab('integrations', array( 8 | 'label' => $this->translate('TTS Integrations'), 9 | 'title' => $this->translate('Manage trouble ticket system integrations'), 10 | 'url' => 'integrations' 11 | )); 12 | -------------------------------------------------------------------------------- /doc/01-About.md: -------------------------------------------------------------------------------- 1 | # Icinga Web GenericTTS Integration 2 | 3 | With the Icinga Web GenericTTS integration, you can replace ticket patterns in acknowledgements, 4 | downtimes, and comments with links to your trouble ticket systems. 5 | To do this, you configure one or more unique regular expressions to link to them. 6 | 7 | ## Installation 8 | 9 | To install Icinga Web GenericTTS Integration see [Installation](02-Installation.md). 10 | 11 | ## License 12 | 13 | Icinga Web GenericTTS Integration 14 | and the Icinga Web GenericTTS Integration documentation are licensed under the terms of the 15 | GNU General Public License Version 2. 16 | -------------------------------------------------------------------------------- /doc/02-Installation.md: -------------------------------------------------------------------------------- 1 | 2 | # Installing Icinga Web GenericTTS Integration 3 | 4 | The recommended way to install Icinga Web GenericTTS Integration 5 | and its dependencies is to use prebuilt packages for 6 | all supported platforms from our official release repository. 7 | Please note that [Icinga Web](https://icinga.com/docs/icinga-web) is required to run Icinga Web GenericTTS Integration 8 | and if it is not already set up, it is best to do this first. 9 | 10 | The following steps will guide you through installing and setting up Icinga Web GenericTTS Integration. 11 | 12 | 13 | 14 | ## Installing the Package 15 | 16 | If the [repository](https://packages.icinga.com) is not configured yet, please add it first. 17 | Then use your distribution's package manager to install the `icinga-generictts` package 18 | or install [from source](02-Installation.md.d/From-Source.md). 19 | 20 | 21 | -------------------------------------------------------------------------------- /doc/02-Installation.md.d/From-Source.md: -------------------------------------------------------------------------------- 1 | # Installing Icinga Web GenericTTS Integration from Source 2 | 3 | Please see the Icinga Web documentation on 4 | [how to install modules](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation) from source. 5 | Make sure you use `generictts` as the module name. The following requirements must also be met. 6 | 7 | ## Requirements 8 | 9 | * [Icinga Web](https://icinga.com/docs/icinga-web/latest/) 10 | 11 | -------------------------------------------------------------------------------- /doc/03-Configuration.md: -------------------------------------------------------------------------------- 1 | # Configuration 2 | 3 | After enabling `generictts`, 4 | you can access its configuration in Icinga Web via the module's configuration tab. 5 | But you can also change its configuration manually. 6 | `generictts` maintains a configuration file that is normally located under the following path: 7 | 8 | ``` 9 | /etc/icingaweb2/modules/generictts/config.ini 10 | ``` 11 | 12 | ## Example Configuration 13 | 14 | You need to understand regular expressions for the configuration. 15 | A pattern has to be specified that captures a ticket reference for use in a link to your ticket system. 16 | 17 | In the following example, every time we encounter an acknowledgement, downtime, or comment 18 | that contains a hash `#` followed by digits, that number is stored in the capturing group `$1` 19 | and replaced with a link that references that specific ticket in your ticket system. 20 | 21 | ```ini 22 | [my-ticket-system] 23 | pattern = "/#([0-9]+)/" 24 | url = "https://my.ticket.system/tickets/id=$1" 25 | ``` 26 | -------------------------------------------------------------------------------- /library/Generictts/Ticket.php: -------------------------------------------------------------------------------- 1 | config = $config; 36 | 37 | $ticketPatterns = array(); 38 | foreach ($config as $section => $values) { 39 | if ($values->get('url')) { // Skip integrations that don't contain a URL 40 | $ticketPattern = $this->createTicketPattern($section, $values->get('pattern')); 41 | if ($ticketPattern->isValid()) { // Skip integrations that don't contain a pattern 42 | $ticketPatterns[$section] = $ticketPattern; 43 | } 44 | } 45 | } 46 | $this->ticketPatterns = $ticketPatterns; 47 | } 48 | 49 | /** 50 | * {@inheritdoc} 51 | * 52 | * @return \Icinga\Application\Hook\Ticket\TicketPattern[] 53 | */ 54 | public function getPattern() 55 | { 56 | return $this->ticketPatterns; 57 | } 58 | 59 | /** 60 | * {@inheritdoc} 61 | */ 62 | public function createLink($match) 63 | { 64 | /** @var \Icinga\Application\Hook\Ticket\TicketPattern $match */ 65 | return sprintf( 66 | '%s', 67 | preg_replace('/\$1/', rawurlencode($match[1]), $this->config->get($match->getName(), 'url')), 68 | $match[0] 69 | ); 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /module.info: -------------------------------------------------------------------------------- 1 | Module: generictts 2 | Version: 2.1.0 3 | Description: Generic Trouble Ticket System connection module 4 | This module allows to easily link issue/ticket numbers in your Icinga 5 | acknowledgement or downtime comments. Configure a pattern matching 6 | your ticket numbers and a URL with placeholders. Please note that 7 | Icinga Web 2 version 2.3.0 is required at least to run this module. 8 | -------------------------------------------------------------------------------- /phpstan-baseline.neon: -------------------------------------------------------------------------------- 1 | parameters: 2 | ignoreErrors: 3 | - 4 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Controllers\\\\IntegrationsController\\:\\:indexAction\\(\\) has no return type specified\\.$#" 5 | count: 1 6 | path: application/controllers/IntegrationsController.php 7 | 8 | - 9 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Controllers\\\\IntegrationsController\\:\\:newAction\\(\\) has no return type specified\\.$#" 10 | count: 1 11 | path: application/controllers/IntegrationsController.php 12 | 13 | - 14 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Controllers\\\\IntegrationsController\\:\\:removeAction\\(\\) has no return type specified\\.$#" 15 | count: 1 16 | path: application/controllers/IntegrationsController.php 17 | 18 | - 19 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Controllers\\\\IntegrationsController\\:\\:updateAction\\(\\) has no return type specified\\.$#" 20 | count: 1 21 | path: application/controllers/IntegrationsController.php 22 | 23 | - 24 | message: "#^Parameter \\#1 \\$name of method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:bind\\(\\) expects string, mixed given\\.$#" 25 | count: 2 26 | path: application/controllers/IntegrationsController.php 27 | 28 | - 29 | message: "#^Parameter \\#1 \\$name of method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:remove\\(\\) expects string, mixed given\\.$#" 30 | count: 1 31 | path: application/controllers/IntegrationsController.php 32 | 33 | - 34 | message: "#^Cannot call method getValue\\(\\) on Zend_Form_Element\\|null\\.$#" 35 | count: 3 36 | path: application/forms/Config/TtsIntegrationConfigForm.php 37 | 38 | - 39 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:add\\(\\) has parameter \\$values with no value type specified in iterable type array\\.$#" 40 | count: 1 41 | path: application/forms/Config/TtsIntegrationConfigForm.php 42 | 43 | - 44 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:createElements\\(\\) has no return type specified\\.$#" 45 | count: 1 46 | path: application/forms/Config/TtsIntegrationConfigForm.php 47 | 48 | - 49 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:createElements\\(\\) has parameter \\$formData with no value type specified in iterable type array\\.$#" 50 | count: 1 51 | path: application/forms/Config/TtsIntegrationConfigForm.php 52 | 53 | - 54 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:onRequest\\(\\) has no return type specified\\.$#" 55 | count: 1 56 | path: application/forms/Config/TtsIntegrationConfigForm.php 57 | 58 | - 59 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:update\\(\\) has parameter \\$values with no value type specified in iterable type array\\.$#" 60 | count: 1 61 | path: application/forms/Config/TtsIntegrationConfigForm.php 62 | 63 | - 64 | message: "#^Parameter \\#1 \\$name of method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:add\\(\\) expects string, mixed given\\.$#" 65 | count: 1 66 | path: application/forms/Config/TtsIntegrationConfigForm.php 67 | 68 | - 69 | message: "#^Parameter \\#1 \\$name of method Icinga\\\\Module\\\\Generictts\\\\Forms\\\\Config\\\\TtsIntegrationConfigForm\\:\\:update\\(\\) expects string, mixed given\\.$#" 70 | count: 1 71 | path: application/forms/Config/TtsIntegrationConfigForm.php 72 | 73 | - 74 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Ticket\\:\\:createLink\\(\\) has parameter \\$match with no value type specified in iterable type array\\.$#" 75 | count: 1 76 | path: library/Generictts/Ticket.php 77 | 78 | - 79 | message: "#^Method Icinga\\\\Module\\\\Generictts\\\\Ticket\\:\\:init\\(\\) has no return type specified\\.$#" 80 | count: 1 81 | path: library/Generictts/Ticket.php 82 | 83 | - 84 | message: "#^Parameter \\#1 \\$string of function rawurlencode expects string, string\\|null given\\.$#" 85 | count: 1 86 | path: library/Generictts/Ticket.php 87 | 88 | - 89 | message: "#^Parameter \\#2 \\$pattern of method Icinga\\\\Application\\\\Hook\\\\TicketHook\\:\\:createTicketPattern\\(\\) expects string, mixed given\\.$#" 90 | count: 1 91 | path: library/Generictts/Ticket.php 92 | 93 | - 94 | message: "#^Parameter \\#3 \\$subject of function preg_replace expects array\\|string, mixed given\\.$#" 95 | count: 1 96 | path: library/Generictts/Ticket.php 97 | -------------------------------------------------------------------------------- /phpstan.neon: -------------------------------------------------------------------------------- 1 | includes: 2 | - phpstan-baseline.neon 3 | 4 | parameters: 5 | level: max 6 | 7 | checkFunctionNameCase: true 8 | checkInternalClassCaseSensitivity: true 9 | treatPhpDocTypesAsCertain: false 10 | 11 | paths: 12 | - application 13 | - library 14 | 15 | scanDirectories: 16 | - vendor 17 | 18 | ignoreErrors: 19 | - 20 | messages: 21 | - '#Unsafe usage of new static\(\)#' 22 | - '#. but return statement is missing#' 23 | reportUnmatched: false 24 | 25 | universalObjectCratesClasses: 26 | - Icinga\Web\View 27 | -------------------------------------------------------------------------------- /public/css/module.less: -------------------------------------------------------------------------------- 1 | /*! Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */ 2 | 3 | .tts-integrations-table { 4 | table-layout: fixed; 5 | } 6 | -------------------------------------------------------------------------------- /run.php: -------------------------------------------------------------------------------- 1 | provideHook('ticket', '\\Icinga\\Module\\Generictts\\Ticket'); 6 | --------------------------------------------------------------------------------