From 1d78feba564672dd8c8588308323df4764257c4f Mon Sep 17 00:00:00 2001 From: Maciej Kobus Date: Tue, 21 Nov 2023 13:02:26 +0100 Subject: [PATCH] IBX-7057: Provided Notifications API (#1) Co-authored-by: Andrew Longosz Co-authored-by: Konrad Oboza --- .eslintrc.json | 3 + .github/pull_request_template.md | 18 +- .github/workflows/backend-ci.yaml | 184 +++++ .github/workflows/pr-check.yaml | 2 +- .github/workflows/release.yaml | 2 +- .gitignore | 7 + .php-cs-fixer.php | 14 + COPYRIGHT | 10 +- LICENSE | 665 ++++++++++-------- .../Parser/NotificationsConfigParser.php | 73 ++ src/bundle/IbexaNotificationsBundle.php | 9 + src/bundle/Resources/config/services.yaml | 4 +- src/bundle/Resources/config/services/.gitkeep | 0 .../Resources/config/services/mappers.yaml | 13 + .../Resources/config/services/papi.yaml | 9 + .../services/subscription_resolver.yaml | 15 + src/contracts/.gitkeep | 0 .../Service/NotificationServiceInterface.php | 19 + .../SymfonyNotificationAdapter.php | 32 + src/contracts/Value/NotificationInterface.php | 14 + .../Recipent/SymfonyRecipientAdapter.php | 62 ++ src/contracts/Value/RecipientInterface.php | 16 + src/lib/.gitkeep | 0 src/lib/Mapper/NotificationMapper.php | 29 + .../Mapper/NotificationMapperInterface.php | 22 + src/lib/Mapper/RecipientMapper.php | 29 + src/lib/Mapper/RecipientMapperInterface.php | 22 + src/lib/Service/NotificationService.php | 69 ++ .../ChainSubscriptionResolver.php | 39 + .../ConfigBasedSubscriptionResolver.php | 37 + .../SubscriptionResolverInterface.php | 21 + src/lib/Value/ChannelSubscription.php | 32 + 32 files changed, 1143 insertions(+), 328 deletions(-) create mode 100644 .eslintrc.json create mode 100644 .github/workflows/backend-ci.yaml create mode 100644 .gitignore create mode 100644 .php-cs-fixer.php create mode 100644 src/bundle/DependencyInjection/Configuration/Parser/NotificationsConfigParser.php delete mode 100644 src/bundle/Resources/config/services/.gitkeep create mode 100644 src/bundle/Resources/config/services/mappers.yaml create mode 100644 src/bundle/Resources/config/services/papi.yaml create mode 100644 src/bundle/Resources/config/services/subscription_resolver.yaml delete mode 100644 src/contracts/.gitkeep create mode 100644 src/contracts/Service/NotificationServiceInterface.php create mode 100644 src/contracts/Value/Notification/SymfonyNotificationAdapter.php create mode 100644 src/contracts/Value/NotificationInterface.php create mode 100644 src/contracts/Value/Recipent/SymfonyRecipientAdapter.php create mode 100644 src/contracts/Value/RecipientInterface.php delete mode 100644 src/lib/.gitkeep create mode 100644 src/lib/Mapper/NotificationMapper.php create mode 100644 src/lib/Mapper/NotificationMapperInterface.php create mode 100644 src/lib/Mapper/RecipientMapper.php create mode 100644 src/lib/Mapper/RecipientMapperInterface.php create mode 100644 src/lib/Service/NotificationService.php create mode 100644 src/lib/SubscriptionResolver/ChainSubscriptionResolver.php create mode 100644 src/lib/SubscriptionResolver/ConfigBasedSubscriptionResolver.php create mode 100644 src/lib/SubscriptionResolver/SubscriptionResolverInterface.php create mode 100644 src/lib/Value/ChannelSubscription.php diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..ef9bcb1 --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "eslint-config-ibexa/eslint" +} diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f442e9b..c77c5ff 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,9 @@ -| Question | Answer | -|--------------------------------|-------------------------------------------------------| -| **JIRA issue** | [IBX-XXXXX](https://issues.ibexa.co/browse/IBX-XXXXX) | -| **Type** | feature/bug/improvement | -| **Target eZ Platform version** | `v4.x` - please update `x` accordingly | -| **BC breaks** | yes/no | -| **Doc needed** | yes/no | +| Question | Answer | +|--------------------------|-----------------------------------------------------| +| **JIRA issue** | [IBX-XXXX](https://issues.ibexa.co/browse/IBX-XXXX) | +| **Type** | feature/bug/improvement | +| **Target Ibexa version** | `v4.6` | +| **BC breaks** | yes/no | @@ -12,5 +11,6 @@ - [ ] Provided PR description. - [ ] Tested the solution manually. - [ ] Provided automated test coverage. -- [ ] Checked that target branch is set correctly (master for features, the oldest supported for bugs). -- [ ] Asked for a review (ping `@ibexa/engineering`). +- [ ] Checked that target branch is set correctly (main for features, the oldest supported for bugs). +- [ ] Ran PHP CS Fixer for new PHP code (use `$ composer fix-cs`). +- [ ] Asked for a review (ping for example `@ibexa/php-dev` for back-end changes and/or `@ibexa/javascript-dev` for front-end changes). diff --git a/.github/workflows/backend-ci.yaml b/.github/workflows/backend-ci.yaml new file mode 100644 index 0000000..4ae9a6c --- /dev/null +++ b/.github/workflows/backend-ci.yaml @@ -0,0 +1,184 @@ +name: Backend build + +on: + push: + branches: + - main + - '[0-9]+.[0-9]+' + pull_request: ~ + +jobs: + cs-fix: + name: Run code style check + runs-on: "ubuntu-22.04" + strategy: + matrix: + php: + - '8.1' + steps: + - uses: actions/checkout@v3 + + - name: Setup PHP Action + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + coverage: none + extensions: 'pdo_sqlite, gd' + tools: cs2pr + + - uses: ramsey/composer-install@v2 + with: + dependency-versions: "highest" + + - name: Run code style check + run: composer run-script check-cs -- --format=checkstyle | cs2pr + + deptrac: + name: Deptrac + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Deptrac + uses: smoench/deptrac-action@master + + tests: + name: Tests + runs-on: "ubuntu-22.04" + timeout-minutes: 10 + + strategy: + fail-fast: false + matrix: + php: + - '7.4' + - '8.1' + - '8.2' + + steps: + - uses: actions/checkout@v3 + + - name: Setup PHP Action + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + coverage: none + extensions: pdo_sqlite, gd + tools: cs2pr + + - uses: ramsey/composer-install@v2 + with: + dependency-versions: "highest" + composer-options: "--prefer-dist --no-progress --no-suggest" + + - name: Setup problem matchers for PHPUnit + run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" + + - name: Run PHPStan analysis + run: composer run-script phpstan + + - name: Run test suite + run: composer run-script --timeout=600 test + + integration-tests-postgres: + name: PostgreSQL integration tests + needs: tests + services: + postgres: + image: postgres:10 + ports: + - 5432 + env: + POSTGRES_PASSWORD: postgres + POSTGRES_DB: testdb + options: >- + --health-cmd pg_isready + --health-interval 10s + --health-timeout 5s + --health-retries 5 + --tmpfs /var/lib/postgres + runs-on: "ubuntu-22.04" + timeout-minutes: 10 + + strategy: + fail-fast: false + matrix: + php: + - '7.4' + - '8.1' + - '8.2' + + steps: + - uses: actions/checkout@v3 + + - name: Setup PHP Action + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + coverage: none + extensions: pdo_pgsql, gd + tools: cs2pr + + - uses: ramsey/composer-install@v2 + with: + dependency-versions: "highest" + + - name: Setup problem matchers for PHPUnit + run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" + + - name: Run integration test suite vs Postgresql + run: composer run-script --timeout=600 test -- --testsuite integration + env: + DATABASE_URL: "pgsql://postgres:postgres@localhost:${{ job.services.postgres.ports[5432] }}/testdb?server_version=10" + + integration-tests-mysql: + name: MySQL integration tests + needs: tests + services: + mysql: + image: ghcr.io/ibexa/core/mysql + ports: + - 3306/tcp + env: + MYSQL_RANDOM_ROOT_PASSWORD: true + MYSQL_USER: mysql + MYSQL_PASSWORD: mysql + MYSQL_DATABASE: testdb + options: >- + --health-cmd="mysqladmin ping" + --health-interval=10s + --health-timeout=5s + --health-retries=5 + --tmpfs=/var/lib/mysql + runs-on: "ubuntu-22.04" + timeout-minutes: 10 + + strategy: + fail-fast: false + matrix: + php: + - '7.4' + - '8.1' + - '8.2' + + steps: + - uses: actions/checkout@v3 + + - name: Setup PHP Action + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + coverage: none + extensions: pdo_mysql, gd, redis + tools: cs2pr + + - uses: ramsey/composer-install@v2 + with: + dependency-versions: "highest" + + - name: Setup problem matchers for PHPUnit + run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" + + - name: Run integration test suite vs MySQL + run: composer run-script --timeout=600 test -- --testsuite integration + env: + DATABASE_URL: "mysql://mysql:mysql@127.0.0.1:${{ job.services.mysql.ports[3306] }}/testdb" diff --git a/.github/workflows/pr-check.yaml b/.github/workflows/pr-check.yaml index b8ae375..d8d8edd 100644 --- a/.github/workflows/pr-check.yaml +++ b/.github/workflows/pr-check.yaml @@ -2,7 +2,7 @@ name: PR check on: pull_request: - types: + types: - opened - synchronize - reopened diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index bda8dc2..28852a1 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,6 +1,6 @@ name: Call Automatic Changelog Generator for tag Workflow -on: +on: push: tags: - 'v*' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4ac5e75 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +/.php-cs-fixer.cache +/.phpunit.result.cache +/composer.lock +/node_modules/ +/vendor +/yarn.lock +/var diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php new file mode 100644 index 0000000..6a82765 --- /dev/null +++ b/.php-cs-fixer.php @@ -0,0 +1,14 @@ +setFinder( + PhpCsFixer\Finder::create() + ->in(__DIR__ . '/src') + ->in(__DIR__ . '/tests') + ->files()->name('*.php') +); diff --git a/COPYRIGHT b/COPYRIGHT index de9ee86..6933d21 100644 --- a/COPYRIGHT +++ b/COPYRIGHT @@ -3,7 +3,7 @@ Copyright (C) 1999-2023 Ibexa AS (formerly eZ Systems AS). All rights reserved. This source code is available separately under the following licenses: A - Ibexa Business Use License Agreement (Ibexa BUL), -version 2.3 or later versions (as license terms may be updated from time to time) +version 2.4 or later versions (as license terms may be updated from time to time) Ibexa BUL is granted by having a valid Ibexa DXP (formerly eZ Platform Enterprise) subscription, as described at: https://www.ibexa.co/product For the full Ibexa BUL license text, please see: @@ -12,9 +12,7 @@ For the full Ibexa BUL license text, please see: AND -B - Ibexa Trial and Test License Agreement (Ibexa TTL), -version 2.2 or later versions (as license terms may be updated from time to time) -Trial can be granted by Ibexa, reach out to Ibexa AS for evaluation access: https://www.ibexa.co/about-ibexa/contact-us -For the full Ibexa TTL license text, please see: +B - GNU General Public License, version 2 +Grants an copyleft open source license with ABSOLUTELY NO WARRANTY. For the full GPL license text, please see: - LICENSE file placed in the root of this source code, or -- https://www.ibexa.co/software-information/licenses-and-agreements (latest version applies) +- https://www.gnu.org/licenses/old-licenses/gpl-2.0.html diff --git a/LICENSE b/LICENSE index 17c112b..45d0ea7 100644 --- a/LICENSE +++ b/LICENSE @@ -1,315 +1,360 @@ -Copyright (C) 1999-2023 Ibexa AS. All rights reserved. -This source code is provided under the license bundled below. +Copyright (C) 1999-2023 Ibexa AS (formerly eZ Systems AS). All rights reserved. -The source code is available separately under the Ibexa BUL 2.3 License, -granted by having a valid Ibexa Digital Experience Platform (DXP) subscription: -- https://www.ibexa.co/products -- https://www.ibexa.co/software-information/licenses-and-agreements/ibexa-business-use-license-agreement-ibexa-bul-version-2.3 +This source code is available separately under the following licenses: + +A - Ibexa Business Use License Agreement (Ibexa BUL), +version 2.4 or later versions (as license terms may be updated from time to time) +Ibexa BUL is granted by having a valid Ibexa DXP (formerly eZ Platform Enterprise) subscription, +as described at: https://www.ibexa.co/product +For the full Ibexa BUL license text, please see: +- LICENSE-bul file placed in the root of this source code, or +- https://www.ibexa.co/software-information/licenses-and-agreements (latest version applies) + +AND + +B - GNU General Public License, version 2 +Grants an copyleft open source license with ABSOLUTELY NO WARRANTY. +Full GPL license text below, or online on: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html -To get access to the full source code under TTL license below, -reach out to Ibexa AS for evaluation access: -- https://www.ibexa.co/about-ibexa/contact-us ---------------------------------------------------------- -Ibexa Trial and Test License Agreement ("Ibexa TTL") Version 2.2 - - -IMPORTANT: Please read the following license agreement carefully. - -This license agreement is between Ibexa AS (Norwegian business -registration no. 981 601 564), a Norwegian company ("Licensor" or "Ibexa"), -and a test or trial user ("Licensee" or "you"). By installing all or any -portion of the software (or authorizing any other person to do so), you -accept the terms and conditions of this license. If you acquired the -software without an opportunity to review this license and do not accept -the license, you must: (a) not use the software and (b) return or delete -the software, with your certification of deletion, within thirty (30) -days of the acquire date. - -This license agreement is entered into in connection with Licensee's -participation in testing a new version of Licensor software and is valid -for 6 months from the date the software was acquired (downloaded). - -The parties hereby agree to the following software license terms: - - -1. Definitions - -"Licensed Software" means the Ibexa Digital Experience Platform (DXP) -or other software product (such as Ibexa Commerce) downloaded, ordered or -otherwise legally acquired (licensed) by Licensee from Licensor (or -other party authorized by the Licensor) under these terms. - -"Licensed Copy" means one sample of the Licensed Software. - -"Website" means up to three defined site access configurations (unique -URLs) that may for instance consist of one site for public use, one site -for internal use (such as an intranet) and one site for site -administrator use, communicated an unlimited number of channels -(such as traditional web, mobile). - -2. License grant - -2.1 You may -Licensor grants you a limited, non-exclusive, time limited and -non-transferable right to: -(a) install and run the Licensed Copy on the agreed number of Websites -for internal testing purposes; -(b) make enhancements, patches, workarounds, bug fixes or other -modifications (collectively "Licensee Modifications") to the Licensed -Copy, solely for your internal testing of the Licensed Software, and -(c) perform presentations based on the Licensed Software, including -building and presenting sample solutions to your clients or potential -clients. - -Since the license is free of charge, you are obliged to submit Licensee -Modifications to Ibexa on a continuous basis to contribution@ibexa.co as -contributions, see section 7.1. Such contribution must include a short -note explaining the Licensee Modification. - -Licensee may make a reasonable number of copies of the Licensed Copy as -required for backup and archival purposes only. - -2.2 You may not -Licensee may use the Licensed Software only as expressly granted in -section 2.1. Without limiting the foregoing, Licensee may not: (a) use -or operate the Licensed Software for regular business use; (b) give, -lease, license, sell, make available, or distribute any part of the -Licensed Software or Licensee Modifications to any third party, except -as otherwise expressly permitted herein; (c) use the Licensed Software -to operate in or as a time-sharing, outsourcing, service bureau, -application service provider, managed service provider environment or -similar service directed towards and performed on behalf or for the -benefit of a third party; (d) copy the Licensed Software onto any public -or distributed network; or (e) change any rights notices which appear in -the Licensed Software. - -3. Your responsibility -Except as expressly set forth herein or in a separate written agreement, -Licensee is the sole responsible for the installation of the Licensed -Software, its operation, supervision, maintenance, management and -related training and support. You are also the sole responsible for any -related installation, maintenance and configuration of computer hardware -used by the Licensed Software. - -4. Price -You may use the Software free of charge. - -5. Audit rights -During the term of this license and for a three (3) year period -following its termination, Licensor may conduct periodic reviews of -Licensee's records relating to its Licensed Software for the purpose of -verifying Licensee's compliance with this license and any related -agreements. During this three (3) year period, you are obliged to -maintain complete and accurate books and other records related to -software licensing and related payments. Licensor must exercise its -right of audit upon no fewer than 15 days' prior notice. Licensee will -provide Licensor with reasonable access and assistance for the audit, -including reasonable use of available office equipment and space. -Licensor shall upon request deliver to Licensee a copy of the results of -any such audit. - -6. Termination -Licensor may terminate this license immediately if you are in breach any -of its provisions and such breach remains uncured 30 days after receipt -of notice. In the event that you are or becomes liquidated, dissolved, -bankrupt or insolvent, whether voluntarily or involuntarily, or is to -take any action to be so declared, Licensor may terminate this license -immediately. Upon cancellation or other termination of this license, for -any reason, you must immediately destroy all copies of the Licensed -Software, and confirm the destruction within 7 (seven) days. Sections 5 -through 11 shall survive the termination of this license for any reason. - -7. Intellectual property rights - -7.1 General -Licensee agrees that the copyright and all other intellectual property -and proprietary rights of whatever nature in the Licensed Software and -related documentation are not by this license transferred to you. No -trademarks of Ibexa may be used by you without Licensor's express written -permission. If permission is grated, use must always take place in -accordance with the applicable Licensor guidelines as they may be -updated from time to time. For Licensee Modifications, you must, in the -modified files and in a separate text file, clearly indicate that the -Licensed Software contains modifications and state their dates. - -7.2 Contribution of Licensee Modifications -To the extent that any contributed Licensee Modifications incorporates -any element which is subject to any intellectual property right owned by -Licensee, Licensee hereby grants to Ibexa an unrestricted, non-exclusive, -perpetual, royalty-free, world-wide, irrevocable and fully transferable -license to make, use, sell, offer for sale, reproduce, create -derivatives of, publish, display, sublicense or otherwise practice such -intellectual property right. - -Regarding any copyrights in Licensee Modifications: -- You hereby assign to us joint ownership, and to the extent that such - assignment is or becomes invalid, ineffective or unenforceable, you - hereby grant to us a perpetual, irrevocable, non-exclusive, worldwide, - no-charge unrestricted license to exercise all rights under those - copyrights. This includes, at our option, the right to sublicense - these same rights to third parties through multiple levels of - sub-licensees or other licensing arrangements; - -- You agree that each of us can do all things in relation to Licensee - Modifications as if each of us were sole and independent copyright - holders. If one of us makes a derivative work the Licensee - Modifications, the one who makes the derivative work (or has it made) - will be the sole owner of that derivative work, hereunder make, have - made, use, license, offer to license, import, and otherwise transfer - your contribution in whole or in part, whether at a charge or at - no-charge; - -- You agree that neither of us have any duty to consult with, obtain the - consent of, pay or render accounts to the other for any use or - distribution of the material. - -With respect to the Licensee Modifications, you represent that: -- it is an original work by you and that you can legally grant the - rights set out in these terms; -- it does not to the best of your knowledge violate any third party's - copyrights, trademarks, patents or other intellectual property rights. - -8. Disclaimer of warranties -The Licensed Software is licensed "as is," without any warranties -whatsoever. Licensor expressly disclaims, and licensee expressly waives, -all warranties, whether express or implied, including warranties of -merchantability, fitness for a particular purpose, non-infringement, -system integration, non-interference and accuracy of informational -content. Licensor does not warrant that the licensed software will meet -licensee's requirements or that the operation of the licensed software -will be uninterrupted or error-free, or that errors will be corrected. -The entire risk of the licensed software's quality and performance is -with licensee. - -9. Indemnification -Licensee agrees to indemnify and hold Licensor harmless against any -damage or loss (including reasonable attorneys' fees) related to any -claim based upon: (a) use of the Licensed Software in a manner -prohibited under this license or in a manner for which the Licensed -Software was not designed; (b) Licensee Modifications or changes made by -Licensee to the Licensed Software (where use of unmodified Licensed -Software would not infringe); or (c) changes made, or actions taken, by -Licensor upon Licensee's direct instructions. - -10. Limitation of liability -To the extent permitted by applicable law, licensor shall have no -liability with respect to its obligations under this license or -otherwise for direct, consequential, exemplary, special, indirect, -incidental or punitive damages, including any lost profits or lost -savings (whether resulting from impaired or lost data, software or -computer failure or any other cause), even if it has been advised of the -possibility of such damages. - -This limitation of liability applies to any default, including breach of -contract, breach of warranty, negligence, misrepresentations and other -torts. The parties agree that the remedies and limitations herein -allocate the risks between the parties as authorized by applicable laws. -The license fee (non) is set in reliance upon this allocation of risk -and the exclusion of certain damages as set forth in this license. - -11. Miscellaneous - -11.1 Interpretation -Failure by Licensor to exercise any right or remedy does not signify -acceptance of the event giving rise to such right or remedy, or loss of -such right. No claim arising out of this License may be brought by you -more than one year after the cause of the claim arose. - -If any part of this license is held by a court of competent jurisdiction -to be illegal or unenforceable, the validity or enforceability of the -remainder of this License shall not be affected and such provision shall -be deemed modified to the minimum extent necessary to make such -provision consistent with applicable law. In its modified form, such -provision shall be enforceable and enforced. - -11.2 Termination for patent action -This license shall terminate automatically and you may no longer -exercise any of the rights granted to you by this license as of the date -you commence an action, including a cross-claim or counterclaim, against -Ibexa, an Ibexa partner or other licensee of Ibexa software alleging that the -Software infringes a patent. - -11.3 Assignment -Without the prior written consent of Licensor, you may not assign, -sublicense or otherwise transfer this license or its rights or -obligations under this license to any person or party, whether by -operation of law or otherwise. Any attempt by you to assign this license -without Licensor's prior written consent is void and will terminate the -license without further notice. - -11.4 Governing law -This License shall be deemed to have been executed in Norway and shall -be governed by the laws of Norway, without regard to any conflict of law -provisions. - -11.5 Disputes and legal venue -The parties shall first attempt to resolve any disputes, controversies -or claims (collectively "Dispute") arising out of or relating to this -license through amicable discussions and negotiations. - -If a Dispute cannot be resolved amicably between the parties, such -Dispute shall be referred to Oslo City Court as mandatory legal venue. -However, if you are located in a country that does not have a bilateral -or multilateral ruling enforcement treaty with Norway, the Dispute shall -be referred to and finally determined by arbitration administered by the -World Intellectual Property Organization (WIPO) Arbitration and -Mediation Centre in accordance with the WIPO Arbitration Rules. - -The place of arbitration shall be in Oslo, Norway. The arbitrator - of -which there shall be only one - shall be bound by the provisions of this -license and base the award on Norwegian substantive law and judicial -precedent. The parties agree that the arbitrator shall have the power to -decide all matters, including arbitrability, and to award any remedies, -including attorneys' fees, costs and equitable relief, available under -applicable law. Either party may enforce any judgment rendered by the -arbitrator in any court of competent jurisdiction. The parties further -agree and acknowledge that arbitration shall be the sole and final -remedy for any dispute between the parties. All proceedings and -documents shall remain strictly confidential. - -In no event shall the United Nations Convention on Contracts for the -International Sale of Goods apply to, or govern, this License. - -11.6 Notices -Any notice under this license shall be delivered and addressed to -Licensee at the address provided to Licensor (or authorized -representative) at the time of order, and to Licensor at - -Attn: Software Licensing Dept/CLA, -Ibexa AS -Solligata 2 -0254 Oslo -Norway - -Notices are deemed received by any party: (a) on the day given, if -personally delivered or if sent by confirmed facsimile transmission, -receipt verified; (b) on the third day after deposit, if mailed by -certified, first class, postage prepaid, return receipt requested mail, -or by reputable, expedited overnight courier; or (c) on the fifth day -after deposit, if sent by reputable, expedited international courier. - -Either party may change its address for notice purposes upon notice in -accordance with this section. - -11.7 Export law assurances -Licensee is responsible for complying with any applicable local laws, -including but not limited to export and import regulations. - -11.8 Entire agreement -This license comprises the entire agreement, and supersedes and merges -all prior proposals, understandings and agreements, oral and written, -between the parties relating to the subject matter of this license. -Licensor's acceptance of any document shall not be construed as an -acceptance of provisions which are in any way in conflict or -inconsistent with, or in addition to, this license, unless such terms -are separately and specifically accepted in writing by an authorized -officer of Licensor. - -11.9 Update of terms -The Licensor may from time to time issue new versions of this license. -Unless you within 30 days from when you were first made aware or should -have become aware of the new license has not made reservations directed -at Licensor in writing, such new version of the license shall be deemed -as accepted by you. + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/src/bundle/DependencyInjection/Configuration/Parser/NotificationsConfigParser.php b/src/bundle/DependencyInjection/Configuration/Parser/NotificationsConfigParser.php new file mode 100644 index 0000000..138f9ef --- /dev/null +++ b/src/bundle/DependencyInjection/Configuration/Parser/NotificationsConfigParser.php @@ -0,0 +1,73 @@ +arrayNode('notifications') + ->children() + ->arrayNode('subscriptions') + ->info('Mandatory system notifications. Users cannot opt-out from below subscriptions.') + ->useAttributeAsKey('notification_type') + ->arrayPrototype() + ->children() + ->arrayNode('channels') + ->cannotBeEmpty() + ->scalarPrototype()->end() + ->end() + ->end() + ->end() + ->end() + ->end() + ->end(); + } + + /** + * @param array> $scopeSettings + */ + public function mapConfig(array &$scopeSettings, $currentScope, ContextualizerInterface $contextualizer): void + { + if (empty($scopeSettings['notifications'])) { + return; + } + + $settings = $scopeSettings['notifications']; + + foreach (self::MAPPED_SETTINGS as $key) { + if (empty($settings[$key])) { + continue; + } + + $contextualizer->setContextualParameter( + sprintf('notifications.%s', $key), + $currentScope, + $settings[$key] + ); + } + } + + /** + * @param array $config + */ + public function postMap(array $config, ContextualizerInterface $contextualizer): void + { + foreach (self::MAPPED_SETTINGS as $setting) { + $contextualizer->mapConfigArray(sprintf('notifications.%s', $setting), $config); + } + } +} diff --git a/src/bundle/IbexaNotificationsBundle.php b/src/bundle/IbexaNotificationsBundle.php index c7f2cf1..2373924 100644 --- a/src/bundle/IbexaNotificationsBundle.php +++ b/src/bundle/IbexaNotificationsBundle.php @@ -8,8 +8,17 @@ namespace Ibexa\Bundle\Notifications; +use Ibexa\Bundle\Notifications\DependencyInjection\Configuration\Parser\NotificationsConfigParser; +use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\HttpKernel\Bundle\Bundle; final class IbexaNotificationsBundle extends Bundle { + public function build(ContainerBuilder $container): void + { + /** @var \Ibexa\Bundle\Core\DependencyInjection\IbexaCoreExtension $core */ + $core = $container->getExtension('ibexa'); + + $core->addConfigParser(new NotificationsConfigParser()); + } } diff --git a/src/bundle/Resources/config/services.yaml b/src/bundle/Resources/config/services.yaml index a6bdf1d..346884c 100644 --- a/src/bundle/Resources/config/services.yaml +++ b/src/bundle/Resources/config/services.yaml @@ -1,2 +1,4 @@ imports: - - { resource: services/**/*.yaml } + - { resource: services/mappers.yaml } + - { resource: services/papi.yaml } + - { resource: services/subscription_resolver.yaml } diff --git a/src/bundle/Resources/config/services/.gitkeep b/src/bundle/Resources/config/services/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/src/bundle/Resources/config/services/mappers.yaml b/src/bundle/Resources/config/services/mappers.yaml new file mode 100644 index 0000000..9930244 --- /dev/null +++ b/src/bundle/Resources/config/services/mappers.yaml @@ -0,0 +1,13 @@ +services: + _defaults: + autowire: true + autoconfigure: true + public: false + + Ibexa\Notifications\Mapper\NotificationMapper: ~ + + Ibexa\Notifications\Mapper\NotificationMapperInterface: '@Ibexa\Notifications\Mapper\NotificationMapper' + + Ibexa\Notifications\Mapper\RecipientMapper: ~ + + Ibexa\Notifications\Mapper\RecipientMapperInterface: '@Ibexa\Notifications\Mapper\RecipientMapper' diff --git a/src/bundle/Resources/config/services/papi.yaml b/src/bundle/Resources/config/services/papi.yaml new file mode 100644 index 0000000..d7e087b --- /dev/null +++ b/src/bundle/Resources/config/services/papi.yaml @@ -0,0 +1,9 @@ +services: + _defaults: + autowire: true + autoconfigure: true + public: false + + Ibexa\Notifications\Service\NotificationService: ~ + + Ibexa\Contracts\Notifications\Service\NotificationServiceInterface: '@Ibexa\Notifications\Service\NotificationService' diff --git a/src/bundle/Resources/config/services/subscription_resolver.yaml b/src/bundle/Resources/config/services/subscription_resolver.yaml new file mode 100644 index 0000000..49ae282 --- /dev/null +++ b/src/bundle/Resources/config/services/subscription_resolver.yaml @@ -0,0 +1,15 @@ +services: + _defaults: + autowire: true + autoconfigure: true + public: false + + Ibexa\Notifications\SubscriptionResolver\ConfigBasedSubscriptionResolver: + tags: + - ibexa.notifications.subscription_resolver + + Ibexa\Notifications\SubscriptionResolver\ChainSubscriptionResolver: + arguments: + $resolvers: !tagged_iterator ibexa.notifications.subscription_resolver + + Ibexa\Notifications\SubscriptionResolver\SubscriptionResolverInterface: '@Ibexa\Notifications\SubscriptionResolver\ChainSubscriptionResolver' diff --git a/src/contracts/.gitkeep b/src/contracts/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/src/contracts/Service/NotificationServiceInterface.php b/src/contracts/Service/NotificationServiceInterface.php new file mode 100644 index 0000000..5b094c8 --- /dev/null +++ b/src/contracts/Service/NotificationServiceInterface.php @@ -0,0 +1,19 @@ + $recipients + */ + public function send(NotificationInterface $notification, array $recipients = []): void; +} diff --git a/src/contracts/Value/Notification/SymfonyNotificationAdapter.php b/src/contracts/Value/Notification/SymfonyNotificationAdapter.php new file mode 100644 index 0000000..d9702d6 --- /dev/null +++ b/src/contracts/Value/Notification/SymfonyNotificationAdapter.php @@ -0,0 +1,32 @@ +notification = $notification; + } + + public function getType(): string + { + return get_class($this->notification); + } + + public function getNotification(): Notification + { + return $this->notification; + } +} diff --git a/src/contracts/Value/NotificationInterface.php b/src/contracts/Value/NotificationInterface.php new file mode 100644 index 0000000..cdf4bf7 --- /dev/null +++ b/src/contracts/Value/NotificationInterface.php @@ -0,0 +1,14 @@ +recipient = $recipient; + } + + public function getMail(): string + { + if (!$this->recipient instanceof EmailRecipientInterface) { + throw new BadStateException( + '$recipient', + sprintf( + 'Internal %s instance does not implement %s', + SymfonyRecipentInterface::class, + EmailRecipientInterface::class, + ), + ); + } + + return $this->recipient->getEmail(); + } + + public function getPhone(): string + { + if (!$this->recipient instanceof SmsRecipientInterface) { + throw new BadStateException( + '$recipient', + sprintf( + 'Internal %s instance does not implement %s', + SymfonyRecipentInterface::class, + SmsRecipientInterface::class, + ), + ); + } + + return $this->recipient->getPhone(); + } + + public function getRecipient(): SymfonyRecipentInterface + { + return $this->recipient; + } +} diff --git a/src/contracts/Value/RecipientInterface.php b/src/contracts/Value/RecipientInterface.php new file mode 100644 index 0000000..70b4d85 --- /dev/null +++ b/src/contracts/Value/RecipientInterface.php @@ -0,0 +1,16 @@ +getNotification(); + } +} diff --git a/src/lib/Mapper/NotificationMapperInterface.php b/src/lib/Mapper/NotificationMapperInterface.php new file mode 100644 index 0000000..f957424 --- /dev/null +++ b/src/lib/Mapper/NotificationMapperInterface.php @@ -0,0 +1,22 @@ +getRecipient(); + } +} diff --git a/src/lib/Mapper/RecipientMapperInterface.php b/src/lib/Mapper/RecipientMapperInterface.php new file mode 100644 index 0000000..da034fa --- /dev/null +++ b/src/lib/Mapper/RecipientMapperInterface.php @@ -0,0 +1,22 @@ +notifier = $notifier; + $this->subscriptionResolver = $subscriptionResolver; + $this->notificationMapper = $notificationMapper; + $this->recipientMapper = $recipientMapper; + } + + /** + * @param array<\Ibexa\Contracts\Notifications\Value\RecipientInterface> $recipients + */ + public function send(NotificationInterface $notification, array $recipients = []): void + { + $channels = array_map( + static fn ( + ChannelSubscription $channelSubscription + ): string => $channelSubscription->getChannel(), + array_filter( + iterator_to_array($this->subscriptionResolver->resolve($notification)) + ) + ); + + if (empty($channels)) { + return; + } + + $symfonyRecipients = array_map( + [$this->recipientMapper, 'mapToSymfonyRecipient'], + $recipients + ); + + $symfonyNotification = $this->notificationMapper->mapToSymfonyNotification($notification); + $symfonyNotification->channels($channels); + + $this->notifier->send($symfonyNotification, ...$symfonyRecipients); + } +} diff --git a/src/lib/SubscriptionResolver/ChainSubscriptionResolver.php b/src/lib/SubscriptionResolver/ChainSubscriptionResolver.php new file mode 100644 index 0000000..b94f9a9 --- /dev/null +++ b/src/lib/SubscriptionResolver/ChainSubscriptionResolver.php @@ -0,0 +1,39 @@ + */ + private iterable $resolvers; + + /** + * @param iterable<\Ibexa\Notifications\SubscriptionResolver\SubscriptionResolverInterface> $resolvers + */ + public function __construct(iterable $resolvers) + { + $this->resolvers = $resolvers; + } + + public function resolve(NotificationInterface $notification, array $context = []): iterable + { + foreach ($this->resolvers as $resolver) { + $channelSubscriptions = $resolver->resolve($notification, $context); + foreach ($channelSubscriptions as $channelSubscription) { + if (null === $channelSubscription) { + continue; + } + + yield $channelSubscription; + } + } + } +} diff --git a/src/lib/SubscriptionResolver/ConfigBasedSubscriptionResolver.php b/src/lib/SubscriptionResolver/ConfigBasedSubscriptionResolver.php new file mode 100644 index 0000000..46592c3 --- /dev/null +++ b/src/lib/SubscriptionResolver/ConfigBasedSubscriptionResolver.php @@ -0,0 +1,37 @@ +configResolver = $configResolver; + } + + public function resolve(NotificationInterface $notification, array $context = []): iterable + { + $config = $this->configResolver->getParameter('notifications.subscriptions'); + $notificationType = $notification->getType(); + + if (!array_key_exists($notificationType, $config)) { + yield; + } + + foreach ($config[$notificationType]['channels'] as $channel) { + yield new ChannelSubscription($notificationType, $channel); + } + } +} diff --git a/src/lib/SubscriptionResolver/SubscriptionResolverInterface.php b/src/lib/SubscriptionResolver/SubscriptionResolverInterface.php new file mode 100644 index 0000000..e8c5f42 --- /dev/null +++ b/src/lib/SubscriptionResolver/SubscriptionResolverInterface.php @@ -0,0 +1,21 @@ + $context + * + * @return \Iterator<\Ibexa\Notifications\Value\ChannelSubscription|null> + */ + public function resolve(NotificationInterface $notification, array $context = []): iterable; +} diff --git a/src/lib/Value/ChannelSubscription.php b/src/lib/Value/ChannelSubscription.php new file mode 100644 index 0000000..1da463a --- /dev/null +++ b/src/lib/Value/ChannelSubscription.php @@ -0,0 +1,32 @@ +notificationType = $notificationType; + $this->channel = $channel; + } + + public function getNotificationType(): string + { + return $this->notificationType; + } + + public function getChannel(): string + { + return $this->channel; + } +}