DEV Community: Yoichi Dan

mautic の plugin の reload 処理をみる 02

Yoichi Dan — Sat, 07 Aug 2021 23:26:27 +0000

ReloadFacade#reloadPlugins

reload の実態となるメソッドを見ていきます。

public function reloadPlugins()
{
    $plugins                 = $this->pluginModel->getAllPluginsConfig();
    $pluginMetadata          = $this->pluginModel->getPluginsMetadata();
    $installedPlugins        = $this->pluginModel->getInstalledPlugins();
    $installedPluginTables   = $this->pluginModel->getInstalledPluginTables($pluginMetadata);
    $installedPluginsSchemas = $this->pluginModel->createPluginSchemas($installedPluginTables);
    $disabledPlugins         = $this->reloadHelper->disableMissingPlugins($plugins, $installedPlugins);
    $enabledPlugins          = $this->reloadHelper->enableFoundPlugins($plugins, $installedPlugins);
    $updatedPlugins          = $this->reloadHelper->updatePlugins($plugins, $installedPlugins, $pluginMetadata, $installedPluginsSchemas);
    $installedPlugins        = $this->reloadHelper->installPlugins($plugins, $installedPlugins, $pluginMetadata, $installedPluginsSchemas);
    $persist                 = array_values($disabledPlugins + $enabledPlugins + $updatedPlugins + $installedPlugins);

    if (!empty($persist)) {
        $this->pluginModel->saveEntities($persist);
    }

PluginModel

以降では内部を理解するために細かく実行しているが、 PluginModel 自体をpsysh で取得しておけば自由に試せる。

>>> $pluginModel = $container->get('mautic.plugin.model.plugin')

pluginModel->getAllPluginsConfig();

ここは内部的には BundleHelper を見ているため、一つ前の記事で見た通りで %mautic.plugin.bundles% のパラメータを参照している。

pluginModel->getPluginsMetadata()

PluginModel は以下のようになっている。

public function getPluginsMetadata()
{
    $allMetadata     = $this->em->getMetadataFactory()->getAllMetadata();
    $pluginsMetadata = [];

    foreach ($allMetadata as $meta) {
        $namespace = $meta->namespace;

        if (false !== strpos($namespace, 'MauticPlugin')) {
            $bundleName = preg_replace('/\\\Entity$/', '', $namespace);
            if (!isset($pluginsMetadata[$bundleName])) {
                $pluginsMetadata[$bundleName] = [];
            }
            $pluginsMetadata[$bundleName][$meta->getName()] = $meta;
        }
    }

    return $pluginsMetadata;
}

最初に取得している Metadata は以下で psysh で取得できる。

>>> $em = $container->get('doctrine')->getManager();
>>> $em->getMetadataFactory()->getAllMetadata()
   [
     Doctrine\ORM\Mapping\ClassMetadata {#5392
       +name: "Mautic\PluginBundle\Entity\IntegrationEntity",
       +namespace: "Mautic\PluginBundle\Entity",
       +rootEntityName: "Mautic\PluginBundle\Entity\IntegrationEntity",
       +customGeneratorDefinition: null,
       +customRepositoryClassName: "Mautic\PluginBundle\Entity\IntegrationEntityRepository",
       +isMappedSuperclass: false,
       +isEmbeddedClass: false,

上記の通りで、Doctrine\ORM\Mapping\ClassMetadata の一覧が大量に取得できる。（ count したら 101 ありました）

取得した Metadata から namespace に MauticPlugin が入っているものだけを取得し、末尾の \Entity を除外したものを集めている。

pluginModel->getInstalledPlugins()

class PluginModel extends FormModel {
    public function getInstalledPlugins()
    {
        return $this->getEntities(
            [
                'index' => 'bundle',
            ]
        );
    }

    public function getRepository()
    {
        return $this->em->getRepository('MauticPluginBundle:Plugin');
    }

// FormModel の親クラスが AbstractCommonModel
abstract class AbstractCommonModel {
    public function getEntities(array $args = [])
    {
        //set the translator
        $repo = $this->getRepository();

        if ($repo instanceof CommonRepository) {
            $repo->setTranslator($this->translator);
            $repo->setCurrentUser($this->userHelper->getUser());

            return $repo->getEntities($args);
        }

        return [];
    }

getEntities 内で呼ばれる getRepository は PluginModel#getRepository なので、 PluginBundle\Entity\PluginRepository が使われる。これは CommonRepository を継承しているので、instanceof も問題ない。

実行すると以下のように取得できる。

>>> $em->getRepository('MauticPluginBundle:Plugin')->getEntities(['index' => 'bundle',]);
=> [
     "MauticCitrixBundle" => Mautic\PluginBundle\Entity\Plugin {#4605},
     "MauticClearbitBundle" => Mautic\PluginBundle\Entity\Plugin {#4653},
     "MauticCloudStorageBundle" => Mautic\PluginBundle\Entity\Plugin {#4634},
     "MauticCrmBundle" => Mautic\PluginBundle\Entity\Plugin {#4662},
     "MauticEmailMarketingBundle" => Mautic\PluginBundle\Entity\Plugin {#4657},
     "MauticFullContactBundle" => Mautic\PluginBundle\Entity\Plugin {#4603},
     "MauticGmailBundle" => Mautic\PluginBundle\Entity\Plugin {#4593},
     "GrapesJsBuilderBundle" => Mautic\PluginBundle\Entity\Plugin {#4621},
     "HelloWorldBundle" => Mautic\PluginBundle\Entity\Plugin {#4573},
     "MauticFocusBundle" => Mautic\PluginBundle\Entity\Plugin {#4613},
     "MauticTagManagerBundle" => Mautic\PluginBundle\Entity\Plugin {#4616},
     "MauticOutlookBundle" => Mautic\PluginBundle\Entity\Plugin {#4665},
     "MauticSocialBundle" => Mautic\PluginBundle\Entity\Plugin {#4681},
     "MauticZapierBundle" => Mautic\PluginBundle\Entity\Plugin {#4678},
   ]
>>>

getAllPluginsConfig と getInstalledPlugins

名前の通りではあるが、getAllPluginsConfig はあくまで設定情報として取得しているものであって、実際に mautic にインストールされているかは分からないものも含まれている。

逆に getInstalledPlugins はインストールされているかを DB から抽出している。

pluginModel->getInstalledPluginTables

public function getInstalledPluginTables(array $pluginsMetadata)
{
    $currentSchema          = $this->em->getConnection()->getSchemaManager()->createSchema();
    $installedPluginsTables = [];

    foreach ($pluginsMetadata as $bundleName => $pluginMetadata) {
        foreach ($pluginMetadata as $meta) {
            $table = $meta->getTableName();

            if (!isset($installedPluginsTables[$bundleName])) {
                $installedPluginsTables[$bundleName] = [];
            }

            if ($currentSchema->hasTable($table)) {
                $installedPluginsTables[$bundleName][] = $currentSchema->getTable($table);
            }
        }
    }

    return $installedPluginsTables;
}

$pluginsMetadata はすでに取得しているが、一つ例をあげておくと以下のようになる。

>>> $pluginModel->getPluginsMetadata();
>>> array_key_first($pluginMetadata)
=> "MauticPlugin\HelloWorldBundle"
>>> $metadata = $pluginMetadata["MauticPlugin\HelloWorldBundle"]
=> [
     "MauticPlugin\HelloWorldBundle\Entity\World" => Doctrine\ORM\Mapping\ClassMetadata {#5750
       +name: "MauticPlugin\HelloWorldBundle\Entity\World",
       +namespace: "MauticPlugin\HelloWorldBundle\Entity",
...
>>> array_key_first($metadata)
=> "MauticPlugin\HelloWorldBundle\Entity\World"
>>> $meta = $metadata["MauticPlugin\HelloWorldBundle\Entity\World"]
=> Doctrine\ORM\Mapping\ClassMetadata {#5658
     +name: "MauticPlugin\HelloWorldBundle\Entity\World",
     +namespace: "MauticPlugin\HelloWorldBundle\Entity",
     +rootEntityName: "MauticPlugin\HelloWorldBundle\Entity\World",
...
>>> $meta->getTableName();
=> "hello_world"

後は $currentSchema に入っている情報と突き合わせて、テーブル情報を収集している。

インストール直後とかだとそれほど数は多くない。 (HelloWorldBundle は追加で入れているもの）
テーブルを複数使っているプラグインがあることも分かる。

>>> $installedPluginTables = $pluginModel->getInstalledPluginTables($pluginMetadata)
=> [
     "MauticPlugin\HelloWorldBundle" => [
       Doctrine\DBAL\Schema\Table {#11257},
     ],
     "MauticPlugin\MauticTagManagerBundle" => [
       Doctrine\DBAL\Schema\Table {#11724},
     ],
     "MauticPlugin\MauticCitrixBundle" => [
       Doctrine\DBAL\Schema\Table {#12562},
     ],
     "MauticPlugin\MauticSocialBundle" => [
       Doctrine\DBAL\Schema\Table {#12089},
       Doctrine\DBAL\Schema\Table {#12032},
       Doctrine\DBAL\Schema\Table {#13314},
       Doctrine\DBAL\Schema\Table {#13260},
       Doctrine\DBAL\Schema\Table {#12066},
     ],
     "MauticPlugin\MauticCrmBundle" => [
       Doctrine\DBAL\Schema\Table {#12576},
     ],
     "MauticPlugin\GrapesJsBuilderBundle" => [
       Doctrine\DBAL\Schema\Table {#6726},
     ],
     "MauticPlugin\MauticFocusBundle" => [
       Doctrine\DBAL\Schema\Table {#11069},
       Doctrine\DBAL\Schema\Table {#11101},
     ],
   ]

pluginModel->createPluginSchemas

PluginModel はこれが最後。

public function createPluginSchemas(array $installedPluginsTables)
{
    $installedPluginsSchemas = [];
    foreach ($installedPluginsTables as $bundleName => $tables) {
        $installedPluginsSchemas[$bundleName] = new Schema($tables);
    }

    return $installedPluginsSchemas;
}

メソッド名が create になっているが、このメソッドで DB にデータを作成する訳ではない。
単純に $installedPluginsTables のマッピングを変えているだけで値を Schema のオブジェクトに変更している。

ここまでで PluginModel を使ったプラグイン情報の収集部分を見た。
次回は ReloadHelper でのプラグインの更新処理を確認していく。

mautic の plugin の reload 処理をみる 01

Yoichi Dan — Thu, 08 Jul 2021 23:08:15 +0000

まず、上記の処理を追っていく。

<div class="std-toolbar btn-group">
    <a data-toggle="ajax" href="/s/plugins/reload" class="btn btn-default">
        <span
            data-toggle="tooltip" title="" data-placement="left"
            data-original-title="Upload the plugin via FTP or some other protocol to the plugins directory then click this button to install/upgrade.">
            <i class="fa fa-cubes"></i> <span class="hidden-xs hidden-sm">Install/Upgrade Plugins</span>
        </span>
    </a>
</div>

ブラウザの開発者ツールを見ると上記のようになっていた。 /s/plugins/reload が紐付けられているため、このボタンの機能は plugin の reload 機能だと推測できる。

app/bundles/PluginBundle/Config/config.php の routes 定義にも以下が存在した。

'mautic_plugin_reload' => [
    'path'       => '/plugins/reload',
    'controller' => 'MauticPluginBundle:Plugin:reload',
],

reload のアクションはそれほど大きくない。
https://github.com/mautic/mautic/blob/7d4b436891b8ca84b34d2b0f5856bbff2a721c3a/app/bundles/PluginBundle/Controller/PluginController.php#L418-L444

/**
* Scans the addon bundles directly and loads bundles which are not registered to the database.
*
* @return JsonResponse
*/
public function reloadAction()
{
   if (!$this->get('mautic.security')->isGranted('plugin:plugins:manage')) {
       return $this->accessDenied();
   }

   $this->addFlash(
       $this->get('mautic.plugin.facade.reload')->reloadPlugins()
   );

   $viewParameters = [
       'page' => $this->get('session')->get('mautic.plugin.page'),
   ];

   // Refresh the index contents
   return $this->postActionRedirect(
       [
           略
       ]
   );
}

mautic.plugin.facade.reload はなんだろう

DI コンテナから取得しているようなので psysh で確認する

$ bin/console psysh --env=dev
>>> $container->get('mautic.plugin.facade.reload')
=> Mautic\PluginBundle\Facade\ReloadFacade {#4588}

ReloadFacade.php

https://github.com/mautic/mautic/blob/7d4b436891b8ca84b34d2b0f5856bbff2a721c3a/app/bundles/PluginBundle/Facade/ReloadFacade.php

class ReloadFacade
{
    private $pluginModel;
    private $reloadHelper;
    private $translator;

    public function __construct(PluginModel $pluginModel, ReloadHelper $reloadHelper, TranslatorInterface $translator)
    {
        $this->pluginModel  = $pluginModel;
        $this->reloadHelper = $reloadHelper;
        $this->translator   = $translator;
    }

    /**
     * This method finds all plguins that needs to be enabled, disabled, installed and updated
     * and do all those actions.
     *
     * Returns humanly understandable message about its doings.
     *
     * @return string
     */
    public function reloadPlugins()
    {
        $plugins                 = $this->pluginModel->getAllPluginsConfig();
        $pluginMetadata          = $this->pluginModel->getPluginsMetadata();
        $installedPlugins        = $this->pluginModel->getInstalledPlugins();
        $installedPluginTables   = $this->pluginModel->getInstalledPluginTables($pluginMetadata);
        $installedPluginsSchemas = $this->pluginModel->createPluginSchemas($installedPluginTables);
        $disabledPlugins         = $this->reloadHelper->disableMissingPlugins($plugins, $installedPlugins);
        $enabledPlugins          = $this->reloadHelper->enableFoundPlugins($plugins, $installedPlugins);
        $updatedPlugins          = $this->reloadHelper->updatePlugins($plugins, $installedPlugins, $pluginMetadata, $installedPluginsSchemas);
        $installedPlugins        = $this->reloadHelper->installPlugins($plugins, $installedPlugins, $pluginMetadata, $installedPluginsSchemas);
        $persist                 = array_values($disabledPlugins + $enabledPlugins + $updatedPlugins + $installedPlugins);

        if (!empty($persist)) {
            $this->pluginModel->saveEntities($persist);
        }

        // Alert the user to the number of additions
        return $this->translator->trans(
            'mautic.plugin.notice.reloaded',
            [
                '%added%'    => count($installedPlugins),
                '%disabled%' => count($disabledPlugins),
                '%updated%'  => count($updatedPlugins),
            ],
            'flashes'
        );
    }
}

多くの処理が移譲されているので、このクラス自体は大きくない。

この処理は、私がやったことがあるユースケースでは、新しくプラグインを追加して、それを読み込むために、 cache を clear してから、このボタンを押すというものだ。
今回はその観点を軸にみていく。

PluginModel

まず、PluginModel の登場が多いのでこれが何かみていく。
MODELS - Mautic Developer Documentation

上記の資料に Models に関する解説があり、簡単には Controller と View の間でのデータ処理を受け持つとなっている。これは、単に MVC の Model と考えていいのだろうか？まだ Symfony の理解が浅く、Entity との関わり方などが頭で整理できていない。

config.php を見ると以下の定義がある。

'models' => [
    'mautic.plugin.model.plugin' => [
        'class'     => \Mautic\PluginBundle\Model\PluginModel::class,
        'arguments' => [
            'mautic.lead.model.field',
            'mautic.helper.core_parameters',
            'mautic.helper.bundle',
        ],
    ],

    'mautic.plugin.model.integration_entity' => [
        'class' => Mautic\PluginBundle\Model\IntegrationEntityModel::class,
    ],
],

mautic.helper.bundle / BundleHelper

PluginModel の constructor に BundleHelper が指定されているが、これを見ておく。

これは app/bundles/CoreBundle/Helper/BundleHelper.php が実態で CoreBundle の持ち物になっている。PluginBundle は別途存在するが、 CoreBundle はプラグインに関してもその全体を把握しているということのようだ。

class BundleHelper
{
    private $coreBundles   = [];
    private $pluginBundles = [];
    private $allBundles    = [];

    /**
     * BundleHelper constructor.
     */
    public function __construct(array $coreBundles, array $pluginBundles)
    {
        $this->coreBundles   = $coreBundles;
        $this->pluginBundles = $pluginBundles;
        $this->allBundles    = array_merge($coreBundles, $pluginBundles);
    }

では、この constructor の 2 つの引数を確認する。
CoreBundle の config.php を確認すると以下のようになっている。

'mautic.helper.bundle' => [
    'class'     => 'Mautic\CoreBundle\Helper\BundleHelper',
    'arguments' => [
        '%mautic.bundles%',
        '%mautic.plugin.bundles%',
    ],
],

内容を調べてみると以下のようになっている。

$ bin/console debug:container --parameter=mautic.bundles
 ---------------- -----------------------------------------------------------------
  Parameter        Value
 ---------------- -----------------------------------------------------------------
  mautic.bundles   {"MauticCoreBundle":{"isPlugin":false,"base":"Core","bundle"...
 ---------------- -----------------------------------------------------------------

 $ bin/console debug:container --parameter=mautic.plugin.bundles
 ----------------------- -----------------------------------------------------------------
  Parameter               Value
 ----------------------- -----------------------------------------------------------------
  mautic.plugin.bundles   {"MauticOutlookBundle":{"isPlugin":true,"base":"MauticOutloo...
 ----------------------- -----------------------------------------------------------------

psysh で $container->getParameter('mautic.plugin.bundles') をすれば、より詳細な情報も得られます。

このパラメータがセットされる箇所は、軽く検索した感じは app/Config/config.php の以下しかなかったので、ここで設定されたら使われ続けるよう。
https://github.com/mautic/mautic/blob/7d4b436891b8ca84b34d2b0f5856bbff2a721c3a/app/config/config.php#L28-L29

次は ReloadFacade.php に戻って、 reloadPlugins() メソッドから見ていきたいと思います。

mautic の import 機能を少しみてみる

Yoichi Dan — Wed, 07 Jul 2021 23:25:05 +0000

https://github.com/mautic/mautic/commit/93813f25837ec83783078193f9b6a7fb68f714fb

commits を眺めていると、上記が入っていたので import 機能についてみてみた。

上記の commit 自体は以下の PR にある通りで、ざっくりこんな感じ。

これまで companies と contacts の 2 つで利用できていた
DB Schema 視点でいえば他のデータも対応できるはず
しかし、いくつかハードコードがあって使えてなかったので変更したよ

Import events #7308

import 機能

上記の 2 箇所ですね。ただ、 routing の定義としては以下のように {object} をパラメータに取るようになっているので、固定ではないオブジェクトを受け入れられるようになっているようです。
https://github.com/mautic/mautic/blob/7d4b436891b8ca84b34d2b0f5856bbff2a721c3a/app/bundles/LeadBundle/Config/config.php#L110-L117

'mautic_import_index' => [
    'path'       => '/{object}/import/{page}',
    'controller' => 'MauticLeadBundle:Import:index',
],
'mautic_import_action' => [
    'path'       => '/{object}/import/{objectAction}/{objectId}',
    'controller' => 'MauticLeadBundle:Import:execute',
],

new はどこに受け入れられる？

パッと見では上記の routes 定義では new 少なくとも mautic_import_index にはマッチしそうにないです。一応確認します。

$ php bin/console router:match /s/companies/import/new

 Route "mautic_import_index" almost matches but requirement for "page" does not match (\d+)


 [OK] Route "mautic_import_action" matches


+--------------+-----------------------------------------------------------------------------------------------+
| Property     | Value                                                                                         |
+--------------+-----------------------------------------------------------------------------------------------+
| Route Name   | mautic_import_action                                                                          |
| Path         | /s/{object}/import/{objectAction}/{objectId}                                                  |
| Path Regex   | #^/s/(?P<object>[^/]++)/import/(?P<objectAction>[^/]++)(?:/(?P<objectId>[a-zA-Z0-9_-]+))?$#sD |
| Host         | ANY                                                                                           |
| Host Regex   |                                                                                               |
| Scheme       | ANY                                                                                           |
| Method       | ANY                                                                                           |
| Requirements | objectId: [a-zA-Z0-9_-]+                                                                      |
| Class        | Symfony\Component\Routing\Route                                                               |
| Defaults     | _controller: Mautic\LeadBundle\Controller\ImportController::executeAction                     |
|              | objectId: 0                                                                                   |
| Options      | compiler_class: Symfony\Component\Routing\RouteCompiler                                       |
+--------------+-----------------------------------------------------------------------------------------------+

https://developer.mautic.org/#routes

やはりマッチしたのは、 mautic_import_action の方でした。

execute はどこ？

継承関係をたどっていくと以下に行き着きました。
https://github.com/mautic/mautic/blob/7d4b436891b8ca84b34d2b0f5856bbff2a721c3a/app/bundles/CoreBundle/Controller/CommonController.php#L455-L462

public function executeAction($objectAction, $objectId = 0, $objectSubId = 0, $objectModel = '')
{
    if (method_exists($this, "{$objectAction}Action")) {
        return $this->{"{$objectAction}Action"}($objectId, $objectModel);
    }


    return $this->notFound();
}

確かに Mautic\LeadBundle\Controller\ImportController.php には、 newAction が存在するため、ここにマッチしていることがわかりました。

Event

PR を見ていて、特に大きな変更になったのは処理を Event に移譲していた部分ではないかと思います。

Event 部分の知識が全然なので順を追ってみていきたいと思います。

LeadEvents 定数

https://github.com/mautic/mautic/commit/93813f25837ec83783078193f9b6a7fb68f714fb#diff-838ce9c2377d106faf00bf4c65aee930f4c1bf56c0389046c5296cbe214c117eR371-R399

PR 内で 3 つの LeadEvents 定数が新たに定義されています。これが Event の key になるものだと思います。

Debugging Event Listeners

上記のドキュメントから、特定の Event に対する Listeners を取得できるようなので実行してみます。

$ php bin/console debug:event-dispatcher mautic.lead_import_on_initialize

Registered Listeners for "mautic.lead_import_on_initialize" Event
=================================================================

 ------- ------------------------------------------------------------------------- ----------
  Order   Callable                                                                  Priority
 ------- ------------------------------------------------------------------------- ----------
  #1      Mautic\LeadBundle\EventListener\ImportContactSubscriber::onImportInit()   0
  #2      Mautic\LeadBundle\EventListener\ImportCompanySubscriber::onImportInit()   0
 ------- ------------------------------------------------------------------------- ----------

PR にもある 2 つの EventSubscriberInterface 継承クラスが表示されました。他の 2 つの Event についても調べると同じクラスがメソッド違いで表示されます。

中を少し除いてみると以下のようになっています。

final class ImportCompanySubscriber implements EventSubscriberInterface {
    public static function getSubscribedEvents(): array
    {
        return [
            LeadEvents::IMPORT_ON_INITIALIZE    => ['onImportInit'],
            LeadEvents::IMPORT_ON_FIELD_MAPPING => ['onFieldMapping'],
            LeadEvents::IMPORT_ON_PROCESS       => ['onImportProcess'],
        ];
    }

// 以下も同じ function を持つ
final class ImportContactSubscriber implements EventSubscriberInterface {

Event に関しては、仕組みに関してもさっぱりなので、もう少し理解を深めていきたいところです。

mautic を psyph で調べる最初の一歩

Yoichi Dan — Wed, 30 Jun 2021 02:42:13 +0000

psysh をそのまま使ってもいいのですが、今回は psysh-bundle を利用します。

引き続き環境は ddev です。

$ ddev composer require --dev theofidry/psysh-bundle:v3.5.1

v3.5.1 を利用しているのは、mautic の 3.3 branch は symfony のバージョンが 3 系のためです。

以前の mautic では入っていた

続いて README にある通り、 app/AppKernel.php の修正をするのですが、以下のように 3.3 の branch ではコメントアウト状態ですでに入っています。
https://github.com/mautic/mautic/blob/3.3/app/AppKernel.php#L208-L209

// Removed temporarily for https://github.com/mautic/mautic/pull/9602, can be re-added in Mautic 4+
// $bundles[] = new Fidry\PsyshBundle\PsyshBundle();

以下の PR で一度入ったようですが、コメントの通り 4 系に向けた作業の中でコメントアウトされたようです。（~~ただ、feature branch でもまだコメントアウトされたままです~~）

Add the Psysh REPL for dev usage #6667
Upgrade to PHPUnit 9 #9602
Upgrade to Symfony 4 #9409
- ここで再度入っていました

使い方

$ ddev ssh
# ここからはコンテナ内
$ bin/console --env=dev psysh
Psy Shell v0.9.12 (PHP 7.4.20 — cli) by Justin Hileman
New version is available (current: v0.9.12, latest: v0.10.8)
>>>

上述の AppKernel の修正箇所を見てもらうと分かりますが、 dev, test の環境でのみ有効にしているので、コンソールも dev 環境で起動します。(深追いしてないのですが ddev で起動するとデフォルトが prod になっていたため）

例えば DB からデータを取得する

>>> ls
Variables: $container, $kernel, $parameters, $self

ls すると、利用可能な変数が一覧できます。

>>> $em = $container->get('doctrine')->getManager();
=> Doctrine\ORM\EntityManager {#625}
>>> $em->getRepository('MauticPluginBundle:Plugin')->findAll();
=> [
     Mautic\PluginBundle\Entity\Plugin {#4861},
     Mautic\PluginBundle\Entity\Plugin {#4822},
     Mautic\PluginBundle\Entity\Plugin {#4825},
     Mautic\PluginBundle\Entity\Plugin {#4828},
     Mautic\PluginBundle\Entity\Plugin {#4831},
     Mautic\PluginBundle\Entity\Plugin {#4834},
     Mautic\PluginBundle\Entity\Plugin {#4837},
     Mautic\PluginBundle\Entity\Plugin {#4858},
     Mautic\PluginBundle\Entity\Plugin {#4855},
     Mautic\PluginBundle\Entity\Plugin {#4852},
     Mautic\PluginBundle\Entity\Plugin {#4849},
     Mautic\PluginBundle\Entity\Plugin {#4846},
   ]

dump するとオブジェクトの内容を確認できます。

>>> $plugin = $em->getRepository('MauticPluginBundle:Plugin')->find(1);
>>> dump($plugin)
Mautic\PluginBundle\Entity\Plugin {#4861
  -id: 1
  -name: "Outlook"
  -description: "Enables integrations with Outlook for email tracking"
  -primaryDescription: null
  -secondaryDescription: null
  -isMissing: false
  -bundle: "MauticOutlookBundle"
  -version: "1.0"
  -author: "Mautic"
  -integrations: Doctrine\ORM\PersistentCollection {#4860
    -snapshot: []
    -owner: Mautic\PluginBundle\Entity\Plugin {#4861}
    -association: array:16 [ …16]
    -em: Doctrine\ORM\EntityManager {#625 …11}
    -backRefFieldName: "plugin"
    -typeClass: Doctrine\ORM\Mapping\ClassMetadata {#2146 …}
    -isDirty: false
    #collection: Doctrine\Common\Collections\ArrayCollection {#4821
      -elements: []
    }
    #initialized: false
  }
  #changes: []
  #pastChanges: []
}
=> Mautic\PluginBundle\Entity\Plugin {#4861}

Bundle 一覧は以下で見れます。

>>> $kernel->getBundles();
=> [
     "FrameworkBundle" => Symfony\Bundle\FrameworkBundle\FrameworkBundle {#541},
     "SecurityBundle" => Symfony\Bundle\SecurityBundle\SecurityBundle {#546},
     "MonologBundle" => Symfony\Bundle\MonologBundle\MonologBundle {#550},
     "SwiftmailerBundle" => Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle {#27},
     "DoctrineBundle" => Doctrine\Bundle\DoctrineBundle\DoctrineBundle {#74},
     "DoctrineCacheBundle" => Doctrine\Bundle\DoctrineCacheBundle\DoctrineCacheBundle {#549},
....

ddev 上の mautic の dev 環境と debug について

Yoichi Dan — Fri, 25 Jun 2021 22:56:30 +0000

そろそろコードを読むだけではキツくなってきたので、動かしながら確認したくなってきた。

dev 環境

ENVIRONMENTS - Mautic Developer Documentation

dev is used when accessing the site through index_dev.php
上記の通りで index_dev.php を通すだけで動作します。
例えば https://mautic.ddev.site/index_dev.php/s/dashboard のような感じです。

どうして Docker を通しているのに dev 環境で動作できるのか？

このドキュメントを読んで最初は ModHeader を入れて、 MAUTIC_DEV_HOSTS にコンテナからアクセスしている IP を設定して実行してみたのですが、それを ON にしても OFF にしても dev 環境が有効になったので不思議になったのでした。

コンテナ内の mautic にアクセスしている IP は ddev logs -s web -f でログから調べました。
docker network inspect ddev_default あたりで ddev-router を見てもよいかも。

dev 環境の IP 判定

https://github.com/mautic/mautic/blob/features/app/middlewares/Dev/IpRestrictMiddleware.php#L58-L65

if (in_array($request->getClientIp(), $this->allowedIps) || false !== getenv('DDEV_TLD')) {
    return $this->app->handle($request, $type, $catch);
}

getenv('DDEV_TLD') がポイントになっていて、 mautic の ddev をセットアップした時に生成される .ddev-docker-compose-*.yaml の environments に DDEV_TLD: ddev.site の記述があります。

この環境変数は名前の通りで ddev のもので以下の一覧にあります。
https://ddev.readthedocs.io/en/stable/users/extend/custom-commands/#environment-variables-provided
DDEV_TLD: Top-level domain of project, like "ddev.site"

どうやら、これだけで通過するようで、mautic の開発環境に ddev を使う人が多いことが伺えます。（まあ、ルートに .ddev がおいてあるんだから標準なんでしょうけど 😅 )

debug

Step-debugging with ddev and xdebug - DDEV-Local Documentation

上記の ddev のドキュメントがほぼすべてです。

ddev xdebug on を実行
PhpStorm で break point を追加
PhpStorm で Start Listening for PHP Debug Connections をクリック
ブラウザで mautic のサイトを実行し break point の箇所に遷移

本当にこれだけでした 🎉

余談

最初は dev 環境は以下の記事を読んでいたのですが、ここ数年でもまあまあ変わっていることが分かりました。

Local Mautic development with DDEV

mautic のテーブル構成を tbls で俯瞰する

Yoichi Dan — Wed, 23 Jun 2021 22:34:54 +0000

ddev describe すると以下のように DB は phpMyAdmin から参照するだけでなくローカルからもアクセスできるようにしてくれている。

MySQL/MariaDB Credentials
-------------------------
Username: "db", Password: "db", Default database: "db"

or use root credentials when needed: Username: "root", Password: "root"

Database hostname and port INSIDE container: db:3306
To connect to db server inside container or in project settings files:
mysql --host=db --user=db --password=db --database=db
Database hostname and port from HOST: 127.0.0.1:55213
To connect to mysql from your host machine,
mysql --host=127.0.0.1 --port=55213 --user=db --password=db --database=db

Other Services
--------------
MailHog (https):        https://mautic.ddev.site:8026
MailHog:                http://mautic.ddev.site:8025
phpMyAdmin (https):     https://mautic.ddev.site:8037
phpMyAdmin:             http://mautic.ddev.site:8036

もちろん、DataGrip で見たりもするが、テーブル間の繋がりを見るには図としていつでも見れるようになっていると便利。

できたもの

https://github.com/dany1468/mautic-tbls

以下の SVG をブラウザで開くといい感じに俯瞰できる。
https://raw.githubusercontent.com/dany1468/mautic-tbls/main/schema/schema.svg

コメントはほぼ入っていないが、外部キーが貼られているので関連をつかみやすい。

プラグイン周りは？

ER図からは、プラグイン周りはこれぐらいしか関連がない。
app/bundles/PluginBundle/Entity を見ると integration_entity も関与していそうである。

余談

app/bundles/PluginBundle/Entity/Plugin.php を眺めていると、Description は --- 区切りで primary と secondary の説明に分けられると気づいた。

開発環境の mautic に plugin を入れてみる

Yoichi Dan — Tue, 22 Jun 2021 23:13:43 +0000

ddev を使い、かつ mautic は 3.3 の branch を使っている。

mautic-plugin-creator を使っての新規追加

https://dev.to/dany1468/composer-autoload-case-sensitive-4pac
先日の記事で書いた通り、ddev の環境だとさっと動作しなかった。

> ddev ssh
$ php vendor/aviboy2006/mautic-plugin-creator/src/test.php

上記で以下のようなファイルが出来上がる。

$ php bin/console cache:clear

 // Clearing the cache for the prod environment with debug false


 [OK] Cache for the "prod" environment (debug=false) was successfully cleared.

上記で cache をクリアし、プラグイン画面で「Install/Upgrade Plugins」をクリックすると、一覧に表示される。

mautic/plugin-helloworld を入れてみる

そのまま git で入れる。

> git clone git@github.com:mautic/plugin-helloworld.git HelloWorldBundle

当然ながら以下のようになる。

同様に cache をクリアし、読み込むと一覧に出てくる。

次はこの辺の設定画面の作り方とかを見ていきたい。

composer の autoload の case-sensitive でハマった

Yoichi Dan — Mon, 21 Jun 2021 23:29:19 +0000

mautic を触り始めているが PHP に関しては全然なので初歩的なことにハマった。

プラグインを作りたかった

簡単なプラグインを作りたくて以下のリポジトリを使ってみようとしてみました。
https://github.com/aviboy2006/mautic-plugin-creator

README に沿って以下を実行。(ddev で実行している）

> ddev composer require aviboy2006/mautic-plugin-creator
> ddev ssh
$ php vendor/aviboy2006/mautic-plugin-creator/src/test.php

すると、 Fatal error: Uncaught Error: Class 'Aviboy2006\MauticPluginCreator\Plugin' not found のようになってしまう。

原因を探す

実行している test.php は以下のような簡単なもの。

<?php
use Aviboy2006\MauticPluginCreator\Plugin;
require_once __DIR__ . '/../../../autoload.php';

$greeting = new Plugin();
$greeting->initAction();
$greeting->initialiseBundle();

となると、autoload がうまくいっていない可能性が高い。ちなみに PhpStorm 上ではきちんとファイルを認識できていてクラスにジャンプもできている。

autoload されている一覧を表示する

<?php
$autoloader = require_once __DIR__ . '/../../../autoload.php';
// 一覧を出す
echo json_encode($autoloader->getPrefixesPsr4(), JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES);

// ファイルがあるか
$result = $autoloader->findFile('Aviboy2006\MauticPluginCreator\Plugin');
echo json_encode($result);

結果としては以下のようになる。

// 一覧の中に
    "Aviboy2006\\MauticPluginCreator\\": [
        "/var/www/html/vendor/composer/../aviboy2006/mautic-plugin-creator/src"
    ]

// ファイルがあるか
false

つまり、一覧に名前空間は登録されているが、 Plugin は取得できていない。

ちなみにプラグインは以下のようになっている。

<?php 

namespace Aviboy2006\MauticPluginCreator;

class Plugin
{

ここで気づきましたが、 Plugin class のあるファイル名が plugin.php になっていました。

PSR-4 のロードは Class 名は Case-Sensitive であるらしく、今回のケースでいえば

$result = $autoloader->findFile('Aviboy2006\MauticPluginCreator\plugin');
// true

となる。

optimize することでも動作する

composer dump-autoload に -o オプションを付けるとマップが作成されるが、そちらは PSR-4 のような名前空間とパスのマップではなく、単純にファイルをリストした上でマップを作成するらしく、上述の名前空間とパス名での case-sensitive の問題は発生しません。

mautic で Form と Landing Page をとりあえず作ってみる

Yoichi Dan — Fri, 18 Jun 2021 23:43:09 +0000

公式ドキュメント的には、最初に Campaign の説明が来るのだけれど、なんらかコンタクト等の取得元が無いと始まらないので、まずは Form と Landing Page を作ってみる。

最初はいきなり Landing Page の方を作ろうとしてみて、入力フォームが無いのに戸惑ってしまったが、なんのことはなく Form は別だというだけだった。

Form

全体的に雑に作っている、在住は dropdown を作るのが面倒だったので country に紐付けた。

そんなに編集する場所は無いが、「フィールドの HTML 名」はきちんと付けておくほうがよい。空白にすると zai_jyu みたいになってしまう。

アクションもメールを送信するだけ。ここの {formfield=country} のところが、先程の「フィールドの HTML 名」になる。

「フィールドの HTML 名」とは書いているが、HTML を見ると、form の name 属性に使われているので POST パラメータにもなっている。
とはいえ、formfield でのパラメータアクセスのキーにもなるので、明示的な名前にしておく方がいいと思う。（そもそも英語を使うなら自然に設定されるからいんでしょうけど）

Landing Page

Blank のテーマを選んで、最初からあるテキストの場所に {form=1} を入れただけ。

{form=1} の 1 は Form の ID なので、一覧から探せる。

これで終了。

表示

Landing Page の画面から publish されたページのリンクがでるので表示してみる。

在住のドロップダウンにも、国の一覧が出てくる。

送信

Form の画面の方に結果が出てくる。グラフには反映されない。

メールも送信されている。

mautic の多言語対応のソースはどこか

Yoichi Dan — Thu, 17 Jun 2021 23:41:03 +0000

現時点の mautic は最初から日本語化も簡単にできて導入がしやすい。
いくつか日本語化されていない部分があったので、どこで貢献できるのかと思いプロジェクトを見てみたがパッとは en_US 以外のファイルが見つからない。

LanguageHelper

CoreBundle に含まれている。
https://github.com/mautic/mautic/blob/features/app/bundles/CoreBundle/Helper/LanguageHelper.php

上記によると、デフォルトの en_US 以外は remote server から fetch されていることが分かる。

言語ファイルの取得

fetchLanguages と fetchPackage 関数を見てもらうと分かるが、以下の 2 箇所からそれぞれ、manifest と言語パック (zip) を取得していることがわかる。

https://github.com/mautic/mautic/blob/features/app/bundles/CoreBundle/Config/config.php#L1615-L1616

https://language-packs.mautic.com/manifest.json
https://language-packs.mautic.com/ja.zip (日本語の場合)

ja.zip を展開すると分かるが、あらゆる Bundle 用の言語ファイルが含まれていることがわかる。

以下の Github リポジトリが本体のようである。
https://github.com/mautic/language-packs

貢献する場所はどこか

https://language-packs.mautic.com/ にアクセスすると以下が記載されている。

This repository contains Mautic translation packs which are automatically built based on Transifex community translations.

https://www.transifex.com/mautic/mautic/

上記から貢献できることがわかった。

サインアップしようとすると、なぜか失敗するのでまだサインアップできていない。
-> ソーシャルアカウントでのサインアップは失敗するが、メールアドレスでのサインアップはできた

Update 2021/06/19

https://docs.mautic.org/en/translations#how-to-translate-mautic
そもそも上記の公式にちゃんと書いてあった 😅
https://developer.mautic.org/ こっちばっか見てたらだめだな。

mautic のソースコードを WSL2 で開く

Yoichi Dan — Wed, 16 Jun 2021 23:29:32 +0000

最近は Ruby を書くにしても MacBook を開くよりも WSL2 の Linux 環境で済ませることが多くなってきたので、mautic もそちらに clone して開いてみる。

PS > wsl -l -v
  NAME                   STATE           VERSION
* Ubuntu-18.04           Running         2

とりあえず clone する。

PS > git clone git@github.com:mautic/mautic.git

ddev で動作させる

ルートに .ddev/ があるので、そちらに乗ってみる。

Installing Mautic using DDEV | Grav

ddev config は記事通りに全部デフォルトで。

~/git/mautic$ ddev config
You are reconfiguring the project at /home/dan/git/mautic.
The existing configuration will be updated and replaced.
Project name (mautic):

The docroot is the directory from which your site is served.
This is a relative path from your project root at /home/dan/git/mautic
You may leave this value blank if your site files are in the project root
Docroot Location (current directory):
Found a php codebase at /home/dan/git/mautic.
Project Type [backdrop, drupal6, drupal7, drupal8, drupal9, laravel, magento, magento2, php, shopware6, typo3, wordpress] (php):
Project type has no settings paths configured, so not creating settings file.
Configuration complete. You may now run 'ddev start'.

.ddev/config.yaml は以下を変更。

-router_http_port: "80"
-router_https_port: "443"
+router_http_port: "8081"
+router_https_port: "4431"
+timezone: Asia/Tokyo

composer_version: "2" ってのがそのままでいいのか気になりましたが、デフォルトが feature ブランチだったので、もう 4 系になってるからだと。

$ ddev start
略
================
Install complete
================
[2021-06-17 07:53:31]
[2021-06-17 07:53:31]  // Warming up the cache for the dev environment with debug true
[2021-06-17 07:53:31]
[2021-06-17 07:53:31]
[2021-06-17 07:53:31]  [OK] Cache for the "dev" environment (debug=true) was successfully warmed.
[2021-06-17 07:53:31]
[2021-06-17 07:53:31]
Enabling plugins...
13 new plugins were installed and 0 updated.
All done! Here's some useful information:
・ The default login is admin/mautic
・ To open the Mautic instance, go to https://mautic.ddev.site in your browser.
・ To open PHPMyAdmin for managing the database, go to https://mautic.ddev.site:8037 in your browser.
・ To open MailHog for seeing all emails that Mautic sent, go to https://mautic.ddev.site:8026 in your browser.
・ Run "ddev exec composer test" to run PHPUnit tests.
・ Run "ddev exec bin/console COMMAND" (like mautic:segments:update) to use the Mautic CLI. For an overview of all available CLI commands, go to https://mau.tc/cli
・ If you want to stop the instance, simply run "ddev stop".
Successfully started mautic
Project can be reached at https://mautic.ddev.site:4431 https://127.0.0.1:55445

記事には以下の記述があるので実行しておきます。

If you cloned Mautic from GitHub, there is one final step: You need to connect to the running DDEV container and then have Composer install all of the Mautic dependencies. This is done by first running ddev ssh to connect to the container, and then from the project root (which DDEV by default connects you to), run composer install to install all dependencies.

実行はしてみたものの、Nothing to install なので実行は不要だったのかも。

/var/www/html$ composer install
Installing dependencies from lock file (including require-dev)
Verifying lock file contents can be installed on current platform.
Nothing to install, update or remove
Package misd/phone-number-bundle is abandoned, you should avoid using it. Use odolbeau/phone-number-bundle instead.
Package symfony/inflector is abandoned, you should avoid using it. Use use `EnglishInflector` from the String component instead instead.
Package rector/rector-prefixed is abandoned, you should avoid using it. Use rector/rector instead.
Generating autoload files
composer/package-versions-deprecated: Generating version class...
composer/package-versions-deprecated: ...done generating version class
129 packages you are using are looking for funding.
Use the `composer fund` command to find out more!
Symfony recipes are disabled: "symfony/flex" not found in the root composer.json

Executing script php -r "if(file_exists('./.git')&&file_exists('./build/hooks/pre-commit'.(PHP_OS=='WINNT'?'.win':''))){copy('./build/hooks/pre-commit'.(PHP_OS=='WINNT'?'.win':''),'./.git/hooks/pre-commit');} if(file_exists('./.git')&&file_exists('./build/hooks/post-checkout')){copy('./build/hooks/post-checkout','./.git/hooks/post-checkout');}" [OK]
Executing script php -r "if(file_exists('./.git/hooks/pre-commit')&&(PHP_OS!='WINNT')){chmod('./.git/hooks/pre-commit',0755);} if(file_exists('./.git/hooks/post-checkout')&&(PHP_OS!='WINNT')){chmod('./.git/hooks/post-checkout',0755);}" [OK]

> find . -mindepth 2 -type d -name .git | xargs rm -rf

開いてみる

https://mautic.ddev.site:4431

アカウントは先程のログにあったとおり admin/mautic でログインできます。

他のインストールアプリ

$ ddev describe
NAME    TYPE  LOCATION      URL                            STATUS
mautic  php   ~/git/mautic  https://mautic.ddev.site:4431  running

Project Information
-------------------
PHP version:            7.4
NFS mount enabled:      false
Database type:          mariadb
MariaDB version:        10.3

URLs
----
https://mautic.ddev.site:4431
https://127.0.0.1:55445
http://mautic.ddev.site:8081
http://127.0.0.1:55446

MySQL/MariaDB Credentials
------------------------------
Username: "db", Password: "db", Default database: "db"

or use root credentials when needed: Username: "root", Password: "root"

Database hostname and port INSIDE container: db:3306
To connect to db server inside container or in project settings files:
mysql --host=db --user=db --password=db --database=db
Database hostname and port from HOST: 127.0.0.1:55433
To connect to mysql from your host machine,
mysql --host=127.0.0.1 --port=55433 --user=db --password=db --database=db

Other Services
-------------------
MailHog (https):        https://mautic.ddev.site:8026
MailHog:                http://mautic.ddev.site:8025
phpMyAdmin (https):     https://mautic.ddev.site:8037
phpMyAdmin:             http://mautic.ddev.site:8036

DDEV ROUTER STATUS: healthy
ssh-auth status: healthy

実はインストール時に 8025 が衝突して一度失敗したんですが、なるほどこちらでも MailHog をインストールしてたんですね。

上記の URL で問題なくアクセスできました。

PhpStorm で開く

JetBrains プロダクトが今年あたりから WSL2 に対応しており、これまで VS Code でやっていたものが一気に便利になりました。（これまでも Windows 側にマウントしたディレクトリに配置していれば開けましたが、たまに変なことになるので待望でした。）

今回だと \\wsl$\Ubuntu-18.04\home\dan\git\mautic みたいなパスで開くことができます。（IDE 側で勝手に WSL 側も含めてエクスプローラー開いてくれるので直打ちすることはないですが）

ddev の PHP を使う

WSL2 環境には PHP を入れていないので、IDE で使う PHP インタープリタを指定するのに ddev のを使うと楽です。

docker ps すると、ddev で立ち上がっているコンテナが分かります。PHP が入っているのは ddrud/ddev-werbserver コンテナなのでそれを使います。

$ docker ps
CONTAINER ID   IMAGE                                                  COMMAND                  CREATED          STATUS                    PORTS
                                                NAMES
f1b717ae4601   drud/ddev-router:v1.17.3                               "/app/docker-entrypo…"   11 minutes ago   Up 11 minutes (healthy)   127.0.0.1:4431->4431/tcp, 127.0.0.1:8025-8026->8025-8026/tcp, 127.0.0.1:8036-8037->8 036-8037/tcp, 80/tcp, 127.0.0.1:8081->8081/tcp   ddev-router
b4e107b098cf   drud/ddev-webserver:v1.17.4-mautic-built               "/start.sh"              11 minutes ago   Up 11 minutes (healthy)   8025/tcp, 127.0.0.1:55446->80/tcp, 127.0.0.1:55445->443/tcp
                                                ddev-mautic-web
f61027027880   phpmyadmin:5                                           "/docker-entrypoint.…"   11 minutes ago   Up 11 minutes             0.0.0.0:55444->80/tcp
                                                 ddev-mautic-dba
3a8e051f958e   drud/ddev-dbserver-mariadb-10.3:v1.17.3-mautic-built   "/docker-entrypoint.…"   11 minutes ago   Up 11 minutes (healthy)   127.0.0.1:55433->3306/tcp
                                                 ddev-mautic-db

上記のように設定すれば利用できます。今回は Docker で選びましたが、 docker-compose も選べたのでそちらの方がいいのかもしれません。

docker-compose 上の mautic で GeoLite2 の自動更新設定

Yoichi Dan — Wed, 16 Jun 2021 00:04:40 +0000

Maxmind IP lookup database cannot be downloaded anonymously anymore - mautic/mautic

上記の issue でも触れられていますが、mautic がデフォルトにしている MaxMind の GeoLite2 データセットがライセンスキーを必要とするようになったようです。

MaxMind のライセンスを使った設定

上記のように account:password の区切りで設定できます。

Maxmind license | Mautic

直接 MaxMind の `geoipupdate` を使う

通常行う必要は無いですが、参考までに。

対応方法

[Solved] Maxmind GeoLite2 & GeoIP Database Auto-Update | 2020.

Issue にも貼られていた上記のページが対応方法になります。

[BUG] Bad cron for geoip db #171 mautic/docker-mautic

上記をさらに docker に適用する方法が上記に提案されています。
今回はこれらをベースにします。

ディレクトリ構成

Dockefile
GetIP.conf # MaxMind からダウンロードしたライセンスファイル

FROM mautic/mautic:v3

RUN apt-get update && wget https://github.com/maxmind/geoipupdate/releases/download/v4.6.0/geoipupdate_4.6.0_linux_amd64.deb \
    && dpkg -i geoipupdate_4.6.0_linux_amd64.deb && rm geoipupdate_4.6.0_linux_amd64.deb

COPY GeoIP.conf /etc/GeoIP.conf
RUN sed -i -e '/^"$@" &/i mkdir -p /var/www/html/app/cache/ip_data && geoipupdate -f /etc/GeoIP.conf -d /var/www/html/app/cache/ip_data && chown www-data.www-data -R /var/www/html/app/cache/ip_data' /entrypoint.sh

RUN sed -i '/iplookup/s/^/#/g' /etc/cron.d/mautic && \
    echo '        0 4 15 * *     www-data  geoipupdate -f /etc/GeoIP.conf -d /var/www/html/app/cache/ip_data > /var/log/cron.pipe 2>&1' >> /etc/cron.d/mautic

geoipupdate に関しては現在 4.7.1 までリリースされているのでバージョンは指定できるようにした方が良いとは思いますが、ここでは上記の issue に合ったものをそのまま使います。

Dockerfile のポイントは以下です。

/etc/cron.d/mautic に geoipupdate を使ったジョブを追加し、既存の更新処理をコメントアウト
/entrypoint.sh の事前処理の最後に、初回の GeoLite2 データセットのダウンロードを実行
- /var/www/html/app は /entrypoint.sh 内で構築されるため、Dockerfile 内で処理はできないため、ここに記述している

cache ディレクトリの注意

上記では最終的に ip_data を入れる先を /var/www/html/app/cache/ip_data としています。

これは最終的には以下の場所と同じになる必要があります。
https://github.com/mautic/mautic/blob/7a2875bc16a6de50a1803fbc41b64278ae9b5428/app/bundles/CoreBundle/IpLookup/MaxmindDownloadLookup.php#L29

$this->getDataDir().'/GeoLite2-City.mmdb'

さらに展開すると以下です。
https://github.com/mautic/mautic/blob/7a2875bc16a6de50a1803fbc41b64278ae9b5428/app/bundles/CoreBundle/IpLookup/AbstractLocalDataLookup.php#L171

$dataDir = $this->cacheDir.'/../ip_data';

AbstractLocalDataLookup は AbstractLookup を継承しており、初期化は以下の設定が反映されます。
https://github.com/mautic/mautic/blob/de7e701ab2e498e7a8e5129e35a8fa482e1e2ff8/app/bundles/CoreBundle/Config/config.php#L927-L945

つまり、cacheDir は kernel.cache_dir になります。
例えば私の環境では以下のようになるので、上記の Dockerfile ではここが一致しません。 /var/www/html/var/cache/ip_data を指定しなければいけません。

# bin/console debug:container --parameter=kernel.cache_dir
 ------------------ ------------------------------
  Parameter          Value
 ------------------ ------------------------------
  kernel.cache_dir   /var/www/html/var/cache/prod
 ------------------ ------------------------------

DEV Community: Yoichi Dan

mautic の plugin の reload 処理をみる 02

ReloadFacade#reloadPlugins

PluginModel

pluginModel->getAllPluginsConfig();

pluginModel->getPluginsMetadata()

pluginModel->getInstalledPlugins()

getAllPluginsConfig と getInstalledPlugins

pluginModel->getInstalledPluginTables

pluginModel->createPluginSchemas

mautic の plugin の reload 処理をみる 01

mautic.plugin.facade.reload はなんだろう

ReloadFacade.php

PluginModel

mautic.helper.bundle / BundleHelper

mautic の import 機能を少しみてみる

import 機能

new はどこに受け入れられる？

execute はどこ？

Event

LeadEvents 定数

mautic を psyph で調べる最初の一歩

以前の mautic では入っていた

使い方

例えば DB からデータを取得する

ddev 上 の mautic の dev 環境と debug について

dev 環境

どうして Docker を通しているのに dev 環境で動作できるのか？

dev 環境の IP 判定

debug

余談

mautic のテーブル構成を tbls で俯瞰する

できたもの

プラグイン周りは？

余談

開発環境の mautic に plugin を入れてみる

mautic-plugin-creator を使っての新規追加

mautic/plugin-helloworld を入れてみる

composer の autoload の case-sensitive でハマった

プラグインを作りたかった

原因を探す

autoload されている一覧を表示する

optimize することでも動作する

mautic で Form と Landing Page をとりあえず作ってみる

Form

Landing Page

表示

送信

mautic の多言語対応のソースはどこか

LanguageHelper

言語ファイルの取得

貢献する場所はどこか

Update 2021/06/19

mautic のソースコードを WSL2 で開く

ddev で動作させる

開いてみる

他のインストールアプリ

PhpStorm で開く

ddev の PHP を使う

docker-compose 上の mautic で GeoLite2 の自動更新設定

MaxMind のライセンスを使った設定

直接 MaxMind の geoipupdate を使う

対応方法

cache ディレクトリの注意

ddev 上の mautic の dev 環境と debug について

直接 MaxMind の `geoipupdate` を使う