├── .gitignore ├── LICENSE ├── README.md ├── composer.json ├── events.php ├── services.php ├── src ├── Command │ └── ListStations.php ├── Controller │ └── HelloWorld.php └── EventHandler │ └── AllTheListeners.php └── templates └── hello_world.phtml /.gitignore: -------------------------------------------------------------------------------- 1 | # Node Modules 2 | node_modules 3 | 4 | # Junk/cache files. 5 | *Thumbs.db 6 | tmp/cache/*---* 7 | *.DS_Store 8 | *.apdisk 9 | .vagrant 10 | .idea 11 | 12 | # Composer-generated content 13 | /vendor/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Extending AzuraCast with Plugins 2 | 3 | This repository contains documentation for the AzuraCast plugin system, as well as a working example of some of the more 4 | common modifications that might be made to the AzuraCast system via plugins. 5 | 6 | More information on plugins is available via 7 | the [AzuraCast Documentation](https://www.azuracast.com/docs/developers/plugins/). 8 | 9 | ## Including Plugins 10 | 11 | Plugins are automatically discovered if they're located in the `/plugins` directory relative to the main AzuraCast 12 | installation. Plugins are ignored by the parent AzuraCast instance, so you can update your instance any time you like 13 | without worrying about your plugins being removed. 14 | 15 | ### Docker Installations 16 | 17 | You can clone the plugin directory anywhere you want on the host machine, though it's recommended to have it as a 18 | subdirectory of your AzuraCast install directory (like `/var/azuracast`). To mount the plugin as a volume so Docker 19 | recognizes it, you should create a new file named `docker-compose.override.yml` alongside the 20 | existing `docker-compose.yml` file. If you already have such a file, you can update it to include the extra lines. 21 | 22 | ```yaml 23 | services: 24 | web: 25 | environment: 26 | AZURACAST_PLUGIN_MODE: true 27 | volumes: 28 | - ./path_to_plugin:/var/azuracast/www/plugins/example-plugin 29 | ``` 30 | 31 | Make sure to restart the Docker containers afterward (using `./docker.sh restart`). 32 | 33 | ## Naming Convention 34 | 35 | ### Autoloaded Files 36 | 37 | The following files are automatically loaded along with the relevant section of code: 38 | 39 | - `/services.php`: Register or extend services with the application's Dependency Injection (DI) container. 40 | - `/events.php`: Register listeners for the Event Dispatcher. 41 | 42 | ### Classes 43 | 44 | AzuraCast autoloads PHP files inside `/plugins/(plugin_name)/src` as long as they are in the appropriate namespace. 45 | 46 | The function used to convert from the plugin folder name into the PHP class name is: 47 | 48 | ```php 49 | addListener( 10 | Event\BuildConsoleCommands::class, 11 | function (Event\BuildConsoleCommands $event) use ($dispatcher) { 12 | $event->addAliases([ 13 | 'example:list-stations' => Plugin\ExamplePlugin\Command\ListStations::class, 14 | ]); 15 | } 16 | ); 17 | 18 | // Tell the view handler to look for templates in this directory too 19 | $dispatcher->addListener(Event\BuildView::class, function(Event\BuildView $event) { 20 | $event->getView()->addFolder('example', __DIR__.'/templates'); 21 | }); 22 | 23 | // Add a new route handled exclusively by the plugin. 24 | $dispatcher->addListener(Event\BuildRoutes::class, function(Event\BuildRoutes $event) { 25 | $app = $event->getApp(); 26 | 27 | $app->get('/example', \Plugin\ExamplePlugin\Controller\HelloWorld::class) 28 | ->setName('example-plugin:index:index') 29 | ->add(\App\Middleware\EnableView::class); 30 | }); 31 | 32 | // You can also add classes that implement the EventSubscriberInterface 33 | $dispatcher->addSubscriber(new \Plugin\ExamplePlugin\EventHandler\AllTheListeners); 34 | }; 35 | -------------------------------------------------------------------------------- /services.php: -------------------------------------------------------------------------------- 1 | title('Example Plugin: Stations'); 34 | 35 | $headers = [ 36 | 'ID', 37 | 'Name', 38 | 'Frontend', 39 | 'Backend', 40 | 'Remotes', 41 | ]; 42 | 43 | $rows = []; 44 | 45 | $stations = $this->em->getRepository(Station::class)->findAll(); 46 | 47 | /** @var Station $station */ 48 | foreach($stations as $station) { 49 | $backend = $this->adapters->getBackendAdapter($station); 50 | $frontend = $this->adapters->getFrontendAdapter($station); 51 | 52 | $rows[] = [ 53 | $station->getId(), 54 | $station->getName(), 55 | $station->getBackendType() 56 | ->getName() . ' (' . ($backend->isRunning($station) ? 'Running' : 'Stopped') . ')', 57 | $station->getFrontendType() 58 | ->getName() . ' (' . ($frontend->isRunning($station) ? 'Running' : 'Stopped') . ')', 59 | $station->getRemotes()->count(), 60 | ]; 61 | } 62 | 63 | $io->table($headers, $rows); 64 | 65 | return 0; 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /src/Controller/HelloWorld.php: -------------------------------------------------------------------------------- 1 | getView() 17 | ->renderToResponse($response, 'example::hello_world'); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/EventHandler/AllTheListeners.php: -------------------------------------------------------------------------------- 1 | 'methodName') 26 | * * array('eventName' => array('methodName', $priority)) 27 | * * array('eventName' => array(array('methodName1', $priority), array('methodName2'))) 28 | * 29 | * @return array The event names to listen to 30 | */ 31 | public static function getSubscribedEvents() 32 | { 33 | return [ 34 | Event\Radio\GenerateRawNowPlaying::class => [ 35 | ['setListenerCount', -20] 36 | ], 37 | ]; 38 | } 39 | 40 | public function setListenerCount(Event\Radio\GenerateRawNowPlaying $event) 41 | { 42 | $np_raw = $event->getResult()->toArray(); 43 | 44 | $np_raw['listeners']['current'] = mt_rand(5, 25); 45 | $np_raw['listeners']['unique'] = mt_rand(0, $np_raw['listeners']['current']); 46 | $np_raw['listeners']['total'] = $np_raw['listeners']['current']; 47 | 48 | $event->setResult(Result::fromArray($np_raw)); 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /templates/hello_world.phtml: -------------------------------------------------------------------------------- 1 | layout('minimal', ['title' => __('Hello World!'), 'page_class' => 'example-content']) ?> 2 | 3 |
4 |
5 |
6 |
7 |

Hello World!

8 |
9 | 10 |
11 | This is an example page. 12 |
13 | 14 |
15 | 16 | 17 |
18 |
19 |
20 |
21 | --------------------------------------------------------------------------------