ISSUE-345: mail sending, privileges

CHANGELOG.md

@@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## x.y.z (next release)
 
 ### Added
+- Graylog integration for centralized logging (#TBD)
 
 ### Changed
 

README.md

@@ -16,7 +16,7 @@ phpList is an open source newsletter manager. This project is a rewrite of the
 
 ## About this package
 
-This is the core module of the successor to phpList 3. It will have the 
+This is the core module of the successor to phpList 3. It will have the
 following responsibilities:
 
 * provide access to the DB via Doctrine models and repositories (and raw SQL
@@ -41,7 +41,7 @@ Since this package is only a service required to run a full installation of **ph
 
 ## Contributing to this package
 
-Contributions to phpList repositories are highly welcomed! To get started please take a look at the [contribution guide](.github/CONTRIBUTING.md). It contains everything you would need to make your first contribution including how to run local style checks and run tests. 
+Contributions to phpList repositories are highly welcomed! To get started please take a look at the [contribution guide](.github/CONTRIBUTING.md). It contains everything you would need to make your first contribution including how to run local style checks and run tests.
 
 ### Code of Conduct
 
@@ -53,9 +53,11 @@ this code.
 ## Structure
 
 * [Class Docs][docs/phpdoc/]
+* [Mailer Transports](docs/mailer-transports.md) - How to use different email providers (Gmail, Amazon SES, Mailchimp, SendGrid)
 * [Class structure overview](docs/ClassStructure.md)
 * [Graphic domain model](docs/DomainModel/DomainModel.svg) and
   a [description of the domain entities](docs/DomainModel/Entities.md)
+* [Mailer Transports](docs/mailer-transports.md) - How to use different email providers (Gmail, Amazon SES, Mailchimp, SendGrid)
 
 
 ## Running the web server
@@ -79,9 +81,9 @@ already in use, on the next free port after 8000).
 
 You can stop the server with CTRL + C.
 
-#### Development and Documentation 
+#### Development and Documentation
 
-We use `phpDocumentor` to automatically generate documentation for classes. To make this process efficient and easier, you are required to properly "document" your  `classes`,`properties`, `methods` ... by annotating them with [docblocks](https://docs.phpdoc.org/latest/guide/guides/docblocks.html). 
+We use `phpDocumentor` to automatically generate documentation for classes. To make this process efficient and easier, you are required to properly "document" your  `classes`,`properties`, `methods` ... by annotating them with [docblocks](https://docs.phpdoc.org/latest/guide/guides/docblocks.html).
 
 More about generatings docs in [PHPDOC.md](PHPDOC.md)
 
@@ -124,12 +126,12 @@ listed in the `extra` section of the module's `composer.json` like this:
 
 ```json
 "extra": {
-    "phplist/core": {
-        "bundles": [
-            "Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle",
-            "PhpList\\Core\\EmptyStartPageBundle\\PhpListEmptyStartPageBundle"
-        ]
-    }
+  "phplist/core": {
+    "bundles": [
+      "Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle",
+      "PhpList\\Core\\EmptyStartPageBundle\\PhpListEmptyStartPageBundle"
+    ]
+  }
 }
 ```
 
@@ -144,32 +146,32 @@ the `extra` section of the module's `composer.json` like this:
 
 ```json
 "extra": {
-    "phplist/core": {
-        "routes": {
-            "homepage": {
-                "resource": "@PhpListEmptyStartPageBundle/Controller/",
-                "type": "annotation"
-            }
-        }
+  "phplist/core": {
+    "routes": {
+      "homepage": {
+        "resource": "@PhpListEmptyStartPageBundle/Controller/",
+        "type": "annotation"
+      }
     }
+  }
 }
 ```
 
 You can also provide system configuration for your module:
 
 ```json
 "extra": {
-    "phplist/core": {
-        "configuration": {
-            "framework": {
-                "templating": {
-                    "engines": [
-                        "twig"
-                    ]
-                }
-            }
+  "phplist/core": {
+    "configuration": {
+      "framework": {
+        "templating": {
+          "engines": [
+            "twig"
+          ]
         }
+      }
     }
+  }
 }
 ```
 
@@ -204,6 +206,17 @@ phpList module), please use the
 [REST API](https://github.com/phpList/rest-api).
 
 
+## Email Configuration
+
+phpList supports multiple email transport providers through Symfony Mailer. The following transports are included:
+
+* Gmail
+* Amazon SES
+* Mailchimp Transactional (Mandrill)
+* SendGrid
+
+For detailed configuration instructions, see the [Mailer Transports documentation](docs/mailer-transports.md).
+
 ## Copyright
 
 phpList is copyright (C) 2000-2021 [phpList Ltd](https://www.phplist.com/).

composer.json

@@ -46,6 +46,7 @@
         "symfony/error-handler": "^6.4",
         "symfony/serializer": "^6.4",
         "symfony/monolog-bundle": "^3.10",
+        "graylog2/gelf-php": "^2.0",
         "symfony/serializer-pack": "^1.3",
         "symfony/orm-pack": "^2.4",
         "doctrine/orm": "^3.3",
@@ -59,7 +60,15 @@
         "masterminds/html5": "^2.9",
         "ext-dom": "*",
         "league/csv": "^9.23.0",
-        "doctrine/doctrine-migrations-bundle": "^3.4"
+        "doctrine/doctrine-migrations-bundle": "^3.4",
+        "symfony/mailer": "^6.4",
+        "symfony/google-mailer": "^6.4",
+        "symfony/amazon-mailer": "^6.4",
+        "symfony/mailchimp-mailer": "^6.4",
+        "symfony/sendgrid-mailer": "^6.4",
+        "symfony/twig-bundle": "^6.4",
+        "symfony/messenger": "^6.4",
+        "symfony/lock": "^6.4"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
@@ -127,9 +136,11 @@
             "bundles": [
                 "Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle",
                 "Symfony\\Bundle\\MonologBundle\\MonologBundle",
+                "Symfony\\Bundle\\TwigBundle\\TwigBundle",
                 "Doctrine\\Bundle\\DoctrineBundle\\DoctrineBundle",
                 "Doctrine\\Bundle\\MigrationsBundle\\DoctrineMigrationsBundle",
-                "PhpList\\Core\\EmptyStartPageBundle\\EmptyStartPageBundle"
+                "PhpList\\Core\\EmptyStartPageBundle\\EmptyStartPageBundle",
+                "FOS\\RestBundle\\FOSRestBundle"
             ],
             "routes": {
                 "homepage": {

config/PHPMD/rules.xml

@@ -51,7 +51,7 @@
     <!-- rules from the "naming" rule set -->
     <rule ref="rulesets/naming.xml/ShortVariable">
         <properties>
-            <property name="exceptions" value="id,ip"/>
+            <property name="exceptions" value="id,ip,cc"/>
         </properties>
     </rule>
     <rule ref="rulesets/naming.xml/LongVariable">

config/config.yml

@@ -40,3 +40,5 @@ framework:
     serializer:
         enabled: true
         enable_attributes: true
+    mailer:
+        dsn: '%app.mailer_dsn%'

config/config_dev.yml

@@ -14,6 +14,14 @@ monolog:
             path: '%kernel.logs_dir%/%kernel.environment%.log'
             level: debug
             channels: ['!event']
+        # Graylog handler disabled for development environment - using local logging only
+        # graylog:
+        #     type: gelf
+        #     publisher:
+        #         hostname: '%app.config.graylog_host%'
+        #         port: '%app.config.graylog_port%'
+        #     level: debug
+        #     channels: ['!event']
         console:
             type: console
             process_psr_3_messages: false

config/config_prod.yml

@@ -3,6 +3,14 @@ imports:
 
 monolog:
     handlers:
+        # Primary handler for production is Graylog
+        graylog:
+            type: gelf
+            publisher:
+                hostname: '%app.config.graylog_host%'
+                port: '%app.config.graylog_port%'
+            level: error
+        # Local file logging as backup
         main:
             type: fingers_crossed
             action_level: error

config/packages/messenger.yaml

@@ -0,0 +1,27 @@
+# This file is the Symfony Messenger configuration for asynchronous processing
+framework:
+    messenger:
+        # Uncomment this (and the failed transport below) to send failed messages to this transport for later handling.
+        # failure_transport: failed
+
+        transports:
+            # https://symfony.com/doc/current/messenger.html#transport-configuration
+            async_email:
+                dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
+                options:
+                    auto_setup: true
+                    use_notify: true
+                    check_delayed_interval: 60000
+                retry_strategy:
+                    max_retries: 3
+                    # milliseconds delay
+                    delay: 1000
+                    multiplier: 2
+                    max_delay: 0
+
+            # failed: 'doctrine://default?queue_name=failed'
+
+        routing:
+            # Route your messages to the transports
+            'PhpList\Core\Domain\Messaging\Message\AsyncEmailMessage': async_email
+            'PhpList\Core\Domain\Messaging\Message\SubscriberConfirmationMessage': async_email

config/parameters.yml.dist

@@ -22,6 +22,21 @@ parameters:
     database_password: '%%env(PHPLIST_DATABASE_PASSWORD)%%'
     env(PHPLIST_DATABASE_PASSWORD): 'phplist'
 
+    # Email configuration
+    app.mailer_from: '%%env(MAILER_FROM)%%'
+    env(MAILER_FROM): '[email protected]'
+    app.mailer_dsn: '%%env(MAILER_DSN)%%'
+    env(MAILER_DSN): 'smtp://username:[email protected]:2525'
+    app.confirmation_url: '%%env(CONFIRMATION_URL)%%'
+    env(CONFIRMATION_URL): 'https://example.com/confirm/'
+
+    # Messenger configuration for asynchronous processing
+    app.messenger_transport_dsn: '%%env(MESSENGER_TRANSPORT_DSN)%%'
+    env(MESSENGER_TRANSPORT_DSN): 'doctrine://default?auto_setup=true'
+
     # A secret key that's used to generate certain security-related tokens
     secret: '%%env(PHPLIST_SECRET)%%'
     env(PHPLIST_SECRET): %1$s
+
+    graylog_host: 'graylog.example.com'
+    graylog_port: 12201

config/services/commands.yml

@@ -0,0 +1,10 @@
+services:
+  _defaults:
+    autowire: true
+    autoconfigure: true
+    public: false
+
+  PhpList\Core\Domain\Messaging\Command\:
+    resource: '../../src/Domain/Messaging/Command'
+    tags: ['console.command']
+

config/services/managers.yml

@@ -52,12 +52,6 @@ services:
     autowire: true
     autoconfigure: true
 
-  PhpList\Core\Domain\Subscription\Service\SubscriberCsvExporter:
+  PhpList\Core\Domain\Configuration\Service\Manager\ConfigManager:
     autowire: true
     autoconfigure: true
-    public: true
-
-  PhpList\Core\Domain\Subscription\Service\SubscriberCsvImporter:
-    autowire: true
-    autoconfigure: true
-    public: true

config/services/messenger.yml

@@ -0,0 +1,12 @@
+services:
+    # Register message handlers for Symfony Messenger
+    PhpList\Core\Domain\Messaging\MessageHandler\:
+        resource: '../../src/Domain/Messaging/MessageHandler'
+        tags: [ 'messenger.message_handler' ]
+
+    PhpList\Core\Domain\Messaging\MessageHandler\SubscriberConfirmationMessageHandler:
+        autowire: true
+        autoconfigure: true
+        tags: [ 'messenger.message_handler' ]
+        arguments:
+            $confirmationUrl: '%app.confirmation_url%'

config/packages/app.yml → config/services/parameters.yml

@@ -1,5 +1,5 @@
-app:
-  config:
+parameters:
+  app.config:
     message_from_address: '[email protected]'
     admin_address: '[email protected]'
     default_message_age: 15768000
@@ -8,3 +8,4 @@ app:
     notify_start_default: '[email protected]'
     notify_end_default: '[email protected]'
     always_add_google_tracking: true
+    click_track: true

config/services/providers.yml

@@ -0,0 +1,4 @@
+services:
+  PhpList\Core\Domain\Subscription\Service\Provider\SubscriberProvider:
+    autowire: true
+    autoconfigure: true

config/services/repositories.yml

@@ -60,3 +60,48 @@ services:
         parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
         arguments:
             - PhpList\Core\Domain\Messaging\Model\TemplateImage
+
+    PhpList\Core\Domain\Configuration\Repository\ConfigRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Configuration\Model\Config
+
+    PhpList\Core\Domain\Messaging\Repository\UserMessageBounceRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Messaging\Model\UserMessageBounce
+
+    PhpList\Core\Domain\Messaging\Repository\UserMessageForwardRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Messaging\Model\UserMessageForward
+
+    PhpList\Core\Domain\Analytics\Repository\LinkTrackRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Analytics\Model\LinkTrack
+
+    PhpList\Core\Domain\Analytics\Repository\UserMessageViewRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Analytics\Model\UserMessageView
+
+    PhpList\Core\Domain\Analytics\Repository\LinkTrackUmlClickRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Analytics\Model\LinkTrackUmlClick
+
+    PhpList\Core\Domain\Messaging\Repository\UserMessageRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Messaging\Model\UserMessage
+
+    PhpList\Core\Domain\Subscription\Repository\SubscriberHistoryRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Subscription\Model\SubscriberHistory
+
+    PhpList\Core\Domain\Messaging\Repository\ListMessageRepository:
+        parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+        arguments:
+            - PhpList\Core\Domain\Subscription\Model\ListMessage