Sync with Mautic 5 upstream + Webmecanik features (4.0.0)

.all-contributorsrc

@@ -31,12 +31,60 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "LadySolveig",
+      "name": "Martina  Scholz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/64533137?v=4",
+      "profile": "https://github.com/LadySolveig",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "escopecz",
+      "name": "John Linhart",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1235442?v=4",
+      "profile": "http://johnlinhart.com",
+      "contributions": [
+        "review"
+      ]
+    },
+    {
+      "login": "Rocksheep",
+      "name": "Marinus van Velzen",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1311371?v=4",
+      "profile": "https://github.com/Rocksheep",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "PierreAmmeloot",
+      "name": "Pierre Ammeloot",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4603318?v=4",
+      "profile": "https://pierre.ammeloot.fr",
+      "contributions": [
+        "userTesting"
+      ]
+    },
+    {
+      "login": "matbcvo",
+      "name": "Martin Vooremäe",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1006437?v=4",
+      "profile": "https://matbcvo.github.io",
+      "contributions": [
+        "code",
+        "test"
+      ]
     }
   ],
   "contributorsPerLine": 7,
   "projectName": "api-library",
   "projectOwner": "mautic",
   "repoType": "github",
   "repoHost": "https://github.com",
-  "skipCi": true
+  "skipCi": true,
+  "commitConvention": "angular",
+  "commitType": "docs"
 }

.ddev/local.config.php.dist

@@ -52,10 +52,10 @@ return [
     'version'           => 'OAuth1a',
 
     // Required for OAuth1a and OAuth2
-    'baseUrl'           => 'http://localhost/mautic/index_dev.php',
+    'baseUrl'           => 'http://localhost/mautic/index.php',
 
     // Required for All tests
-    'apiUrl'            => 'http://localhost/mautic/index_dev.php/api/',
+    'apiUrl'            => 'http://localhost/mautic/index.php/api/',
     // Required for EmailsTest
     'testEmail'         => 'notexisting@email.com',
 

.ddev/mautic-local.php.dist

@@ -14,4 +14,9 @@ $parameters = [
     'db_password'           => 'db',
     'admin_email'           => 'mautic@ddev.local',
     'admin_password'        => 'mautic',
+	'mailer_from_name'      => 'DDEV',
+	'mailer_from_email'     => 'mautic@ddev.local',
+	'mailer_transport'      => 'smtp',
+	'mailer_host'           => 'localhost',
+	'mailer_port'           => '1025',
 ];

.ddev/mautic-setup.sh

@@ -11,9 +11,7 @@ setup_mautic() {
     cp ../.ddev/mautic-local.php.dist ./app/config/local.php
 
     printf "Installing Mautic...\n"
-    php bin/console mautic:install --force http://localhost/mautic \
-        --mailer_from_name="DDEV" --mailer_from_email="mautic@ddev.local" \
-        --mailer_transport="smtp" --mailer_host="localhost" --mailer_port="1025"
+    php bin/console mautic:install --force http://localhost/mautic
     php bin/console cache:warmup --no-interaction --env=dev
 
     printf "Enabling Twilio plugin for tests...\n"

.github/ci-files/.env

@@ -0,0 +1,28 @@
+# In all environments, the following files are loaded if they exist,
+# the latter taking precedence over the former:
+#
+#  * .env                contains default values for the environment variables needed by the app
+#  * .env.local          uncommitted file with local overrides
+#  * .env.$APP_ENV       committed environment-specific defaults
+#  * .env.$APP_ENV.local uncommitted environment-specific overrides
+#
+# Real environment variables win over .env files.
+#
+# DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
+#
+# Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
+# https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration
+APP_ENV=test
+APP_DEBUG=0
+
+DB_HOST=127.0.0.1
+DB_NAME=mautictest
+DB_USER=root
+DB_PORT=3306
+DB_PASSWD=
+MAUTIC_DB_PREFIX=
+MAUTIC_TABLE_PREFIX=
+MAUTIC_ENV=test
+MAUTIC_ADMIN_USERNAME=admin
+MAUTIC_ADMIN_PASSWORD=mautic
+MAUTIC_DB_DRIVER=pdo_mysql

.github/ci-files/local.config.php

@@ -34,7 +34,7 @@
     |
     */
     'userName'         => 'admin',
-    'password'         => 'mautic',
+    'password'         => 'Maut1cR0cks!',
 
     /*
     |--------------------------------------------------------------------------
@@ -52,10 +52,10 @@
     'version'           => 'OAuth1a',
 
     // Required for OAuth1a and OAuth2
-    'baseUrl'           => 'http://localhost/index_dev.php',
+    'baseUrl'           => 'http://localhost/index.php',
 
     // Required for All tests
-    'apiUrl'            => 'http://localhost/index_dev.php/api/',
+    'apiUrl'            => 'http://localhost/index.php/api/',
     // Required for EmailsTest
     'testEmail'         => 'notexisting@email.com',
 

.github/ci-files/local.php → .github/ci-files/local_4.php

@@ -14,4 +14,7 @@
     'db_password'           => '',
     'admin_email'           => 'github-actions@mautic.org',
     'admin_password'        => 'mautic',
+    'mailer_transport'      => 'smtp',
+    'mailer_host'           => 'localhost',
+    'mailer_port'           => '1025',
 ];

.github/ci-files/local_5.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Parameter overrides for GitHub Actions.
+ */
+$parameters = [
+    'api_enabled'           => true,
+    'api_enable_basic_auth' => true,
+    'db_driver'             => 'pdo_mysql',
+    'db_host'               => '127.0.0.1',
+    'db_table_prefix'       => null,
+    'db_port'               => getenv('DB_PORT'),
+    'db_name'               => 'mautictest',
+    'db_user'               => 'root',
+    'db_password'           => '',
+    'admin_email'           => 'github-actions@mautic.org',
+    'admin_password'        => 'Maut1cR0cks!',
+    'mailer_from_name'      => 'GitHub Actions',
+    'mailer_from_email'     => 'github-actions@mautic.org',
+    'mailer_transport'      => 'smtp',
+    'mailer_dsn'            => 'smtp://localhost:1025',
+];

.github/workflows/tests.yml

@@ -13,12 +13,12 @@ on:
         required: false
 jobs:
   phpunit:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     name: PHPUnit tests
 
     services:
       mysql:
-        image: mysql:5.7
+        image: mysql:8.4
         env:
           MYSQL_ALLOW_EMPTY_PASSWORD: yes
           MYSQL_DATABASE: mautictest
@@ -30,7 +30,7 @@ jobs:
         image: mailhog/mailhog:latest
         ports:
           - 1025:1025
-          
+
       redis:
         image: redis:6
         ports:
@@ -45,7 +45,7 @@ jobs:
     - name: Setup PHP, with composer and extensions
       uses: shivammathur/setup-php@v2
       with:
-        php-version: 8.0
+        php-version: 8.3
         ini-values: session.save_handler=redis, session.save_path="tcp://127.0.0.1:6379"
         extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite, mysql, pdo_mysql
         coverage: pcov
@@ -57,14 +57,15 @@ jobs:
       # We need the sed command at the bottom to set the PHP session save path to a directory that's writable for PHP
       # NOTE: update the PHP version below as well if you're updating PHP!
       run: |
-        sudo add-apt-repository ppa:ondrej/php -y
-        sudo add-apt-repository ppa:ondrej/apache2 -y
-        sudo apt-get install apache2 libapache2-mod-php8.0
+        sudo apt-get update -o Acquire::Retries=3
+        sudo apt-get install -y --no-install-recommends apache2 libapache2-mod-php8.3
+
         sudo a2enmod rewrite
-        sudo sed -i 's,^session.save_handler =.*$,session.save_handler = redis,' /etc/php/8.0/apache2/php.ini
-        sudo sed -i 's,^;session.save_path =.*$,session.save_path = "tcp://127.0.0.1:6379",' /etc/php/8.0/apache2/php.ini
+        sudo sed -i 's,^session.save_handler =.*$,session.save_handler = redis,' /etc/php/8.3/apache2/php.ini
+        sudo sed -i 's,^;session.save_path =.*$,session.save_path = "tcp://127.0.0.1:6379",' /etc/php/8.3/apache2/php.ini
+        sudo sed -i 's,^memory_limit =.*$,memory_limit = 256M,' /etc/php/8.3/apache2/php.ini
         sudo service apache2 restart
-        cat /etc/php/8.0/apache2/php.ini | grep session
+        cat /etc/php/8.3/apache2/php.ini | grep session
 
     - name: Install dependencies
       run: |
@@ -89,37 +90,49 @@ jobs:
         sudo chown -R www-data:www-data /var/www/html
         rm -rf /var/www/html/*
         mv $GITHUB_WORKSPACE/mautic/* /var/www/html/
+        cp ./.github/ci-files/.env /var/www/html/
+        sed -i 's/DB_PORT=3306/DB_PORT=${{ job.services.mysql.ports[3306] }}/g' /var/www/html/.env
+        rm -f /var/www/html/.env.test
 
     - name: Install Mautic
       env:
         DB_PORT: ${{ job.services.mysql.ports[3306] }}
       run: |
         composer install --prefer-dist --no-progress
-        cp $GITHUB_WORKSPACE/.github/ci-files/local.php ./app/config/local.php
-        php bin/console mautic:install http://localhost/ \
-          --force --mailer_from_name="GitHub Actions" --mailer_from_email="github-actions@mautic.org" \
-          --mailer_transport="smtp" --mailer_host="localhost" --mailer_port="1025" --env=dev
-        php bin/console cache:warmup --no-interaction --env=dev
+        if [[ "$(jq -r '.version | .[0:1]' app/release_metadata.json)" == "4" ]]; then
+            cp $GITHUB_WORKSPACE/.github/ci-files/local_4.php ./app/config/local.php
+            php bin/console mautic:install http://localhost/ --force --env=test --mailer_from_name="GitHub Actions" --mailer_from_email="github-actions@mautic.org"
+            sed -i "s/('prod',/('test',/g" ./index.php
+            echo "MAUTIC_VERSION=4" >> $GITHUB_ENV
+        else
+            cp $GITHUB_WORKSPACE/.github/ci-files/local_5.php ./config/local.php
+            php bin/console mautic:install http://localhost/ --force --env=test
+            echo "MAUTIC_VERSION=5" >> $GITHUB_ENV
+        fi
+
+        php bin/console cache:warmup --no-interaction --env=test
       working-directory: /var/www/html/
 
       # Enable Twilio plugin with random credentials (needed for MessagesTest to function, doesn't actually contact Twilio API).
     - name: Enable Twilio plugin
       run: |
         mysql -uroot -P${{ job.services.mysql.ports[3306] }} -h127.0.0.1 -e "USE mautictest; INSERT INTO plugin_integration_settings (plugin_id, name, is_published, supported_features, api_keys, feature_settings) VALUES (NULL, 'Twilio', 1, 'a:0:{}', 'a:2:{s:8:\"username\";s:169:\"bzFmNlIydWRSZXlIN2lQVkdpanJ4aTQ2NUh6RVdDbHlLRVhsWGZ4b0kyZVNxLzYrQ1J6V1RvMnlhVEp0c245TEp6eStQekx5ZVhLWjB1YVdoR3RnR2dHQ3k1emVVdGt5NzZKUmtjUnJ3c1E9|L8tbZRIYhwatT7Mq+HAdYA==\";s:8:\"password\";s:169:\"T2d2cFpXQWE5YVZnNFFianJSYURRYUtGRHBNZGZjM1VETXg2Wm5Va3NheW43MjVWUlJhTVlCL2pYMDBpbElONStiVVBNbEM3M3BaeGJMNkFKNUFEN1pTNldSRjc4bUM4SDh1SE9OY1k5MTg9|TeuSvfx4XSUOvp0O7T49Cg==\";}', 'a:4:{s:20:\"sending_phone_number\";N;s:22:\"disable_trackable_urls\";i:0;s:16:\"frequency_number\";N;s:14:\"frequency_time\";N;}');"
-        php bin/console mautic:plugins:reload --env=dev
+        php bin/console mautic:plugins:reload --env=test
       working-directory: /var/www/html
 
     - name: Set correct ownership so Apache can access the files
       run: sudo chown -R www-data:www-data /var/www/html
-    
+
     - name: Run tests
-      run: vendor/bin/paratest -p 3 --coverage-clover coverage.xml
+      run: |
+        sed -i 's/env name="MAUTIC_VERSION" value="5"/env name="MAUTIC_VERSION" value="${{ env.MAUTIC_VERSION }}"/g' ./phpunit.xml.dist
+        vendor/bin/phpunit --coverage-clover coverage.xml
 
     - name: Upload code coverage
       run: bash <(curl -s https://codecov.io/bash)
-    
+
     - name: Upload logs as artifacts
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v4
       if: always()
       with:
         name: mautic-logs
@@ -132,17 +145,17 @@ jobs:
         SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
         SLACK_MESSAGE: 'The daily API library tests against mautic/mautic have failed. Most likely a PR was merged recently which introduced a regression of some sort.'
 
-  cs:
-    runs-on: ubuntu-20.04
-    name: CS tests
+  tests:
+    runs-on: ubuntu-24.04
+    name: CS & PHPSTAN tests
 
     steps:
     - uses: actions/checkout@v3
 
     - name: Setup PHP, with composer and extensions
       uses: shivammathur/setup-php@v2
       with:
-        php-version: 8.0
+        php-version: 8.3
         extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite, mysql, pdo_mysql
 
     - name: Install dependencies
@@ -151,4 +164,7 @@ jobs:
         composer install --prefer-dist --no-progress
 
     - name: Run CS tests
-      run: vendor/bin/php-cs-fixer fix --config=.php_cs -v --dry-run --using-cache=no --show-progress=dots --diff $(git diff -- '*.php' --name-only --diff-filter=ACMRTUXB "HEAD~..HEAD")
+      run: vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php -v --dry-run --using-cache=no --show-progress=dots --diff $(git diff -- '*.php' --name-only --diff-filter=ACMRTUXB "HEAD~..HEAD")
+
+    - name: Run PHPSTAN tests
+      run: composer phpstan

.gitignore

@@ -8,8 +8,11 @@
 /tests/local.config.php_*
 /tests/local.tokens.php
 /tests/phpunit.phar
+/composer.lock
 /vendor
 .DS_Store
+/.php-cs-fixer.cache
 .phpunit.result.cache
 /.ddev/mautic-preference
 /mautic
+CLAUDE.md

.well-known/funding-manifest-urls

@@ -0,0 +1 @@
+https://github.com/mautic/mautic/blob/5.x/funding.json