SystemSettings.php

<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\MistralAI;

use Piwik\Container\StaticContainer;
use Piwik\Piwik;
use Piwik\Plugins\MistralAI\Services\DataPrivacy;
use Piwik\Plugins\MistralAI\Settings\DefaultPrompts;
use Piwik\Plugins\MistralAI\Settings\LegacyPrompts;
use Piwik\Plugins\MistralAI\Settings\SingleValue;
use Piwik\Settings\Setting;
use Piwik\Settings\FieldConfig;
use Piwik\Settings\Storage\Factory as StorageFactory;
use Piwik\Validators\NotEmpty;

/**
 * System-wide settings for MistralAI plugin.
 */
class SystemSettings extends \Piwik\Settings\Plugin\SystemSettings
{
    use SettingsBase;

    /** @var Setting */
    public $host;
    public $apiKey;
    public $modelPreset;
    public $modelCustom;
    public $agentModel;
    public $chatBasePrompt;
    public $insightBasePrompt;
    public $dataSharingAllowed;
    public $maskPersonalData;
    public $stripUrlQueryStrings;
    public $excludeVisitorData;

    /** @var Setting|null @deprecated Legacy property for backwards compatibility during updates */
    public $model;

    protected function init()
    {
        // the model chosen with a previous plugin version is kept until the model settings are saved
        $legacyModel = $this->getLegacyModel();
        $defaultPreset = Config::DEFAULT_MODEL;
        $defaultCustom = '';
        if ($legacyModel !== '') {
            if (Config::isAvailableModel($legacyModel)) {
                $defaultPreset = $legacyModel;
            } else {
                $defaultCustom = $legacyModel;
            }
        }

        $this->host = $this->makeSetting('host', Config::DEFAULT_HOST, FieldConfig::TYPE_STRING, function (FieldConfig $field) {
            $this->configureHostField($field);
            $field->validators[] = new NotEmpty();
            $field->validate = function ($value) {
                if (!self::isHttpsUrl((string) $value)) {
                    throw new \Exception(Piwik::translate('MistralAI_InvalidApiUrl'));
                }
            };
        });

        $this->apiKey = $this->makeSetting('apiKey', null, FieldConfig::TYPE_STRING, function (FieldConfig $field) {
            $this->configureApiKeyField($field);
        });

        $this->modelPreset = $this->makeSetting('modelPreset', $defaultPreset, FieldConfig::TYPE_ARRAY, function (FieldConfig $field) {
            $this->configureModelPresetField($field, SingleValue::toString($this->modelPreset->getValue()));
            $field->validators[] = new NotEmpty();
        });

        $this->modelCustom = $this->makeSetting('modelCustom', $defaultCustom, FieldConfig::TYPE_STRING, function (FieldConfig $field) {
            $this->configureModelCustomField($field);
        });

        $this->agentModel = $this->makeSetting('agentModel', Config::DEFAULT_AGENT_MODEL, FieldConfig::TYPE_STRING, function (FieldConfig $field) {
            $this->configureAgentModelField($field, (string) $this->agentModel->getValue());
            $field->validators[] = new NotEmpty();
        });

        // a default prompt is not stored, so the defaults rewritten by a later version reach this install
        $this->chatBasePrompt = $this->makeSetting('chatBasePrompt', Piwik::translate('MistralAI_ChatBasePromptDefault'), FieldConfig::TYPE_STRING, function (FieldConfig $field) {
            $this->configureChatBasePromptField($field);
            $field->transform = function ($value) {
                return DefaultPrompts::toStoredGeneralPrompt(LegacyPrompts::CHAT, $value);
            };
        });

        $this->insightBasePrompt = $this->makeSetting('insightBasePrompt', Piwik::translate('MistralAI_InsightBasePromptDefault'), FieldConfig::TYPE_STRING, function (FieldConfig $field) {
            $this->configureInsightBasePromptField($field);
            $field->transform = function ($value) {
                return DefaultPrompts::toStoredGeneralPrompt(LegacyPrompts::INSIGHT, $value);
            };
        });

        // nothing is sent to the AI provider until a super user allows it
        foreach (DataPrivacy::DEFAULTS as $name => $default) {
            $this->$name = $this->makeSetting($name, $default, FieldConfig::TYPE_BOOL, function (FieldConfig $field) use ($name) {
                $field->title = Piwik::translate('MistralAI_PrivacySetting_' . $name);
                $field->description = Piwik::translate('MistralAI_PrivacySetting_' . $name . 'Help');
                $field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
            });
        }
    }

    /**
     * The settings are edited on the Mistral AI page of the System administration (see Settings\SystemSettingsForm):
     * none is listed in Administration > General settings nor accepted by CorePluginsAdmin.setSystemSettings, which
     * would bypass the API key masking of that page.
     *
     * @return Setting[]
     */
    public function getSettingsWritableByCurrentUser()
    {
        return [];
    }

    /**
     * Every request is refused for a host that is not an HTTPS URL, so such a host cannot be saved.
     */
    public static function isHttpsUrl(string $url): bool
    {
        $parsed = parse_url(trim($url));

        return is_array($parsed) && strtolower($parsed['scheme'] ?? '') === 'https' && !empty($parsed['host']);
    }

    /**
     * Model of the general settings, the custom model overrides the preset. May be the latest recommended option.
     */
    public function getConfiguredModel(): string
    {
        $model = trim((string) $this->modelCustom->getValue());

        return $model !== '' ? $model : SingleValue::toString($this->modelPreset->getValue());
    }

    /**
     * Chat prompt of the general settings: the default, in the language of the current user, when none is stored or
     * when the stored one is a default of a previous version
     */
    public function getChatBasePrompt(): string
    {
        return DefaultPrompts::resolve(LegacyPrompts::CHAT, SingleValue::toString($this->chatBasePrompt->getValue()));
    }

    /**
     * Insight prompt of the general settings, see getChatBasePrompt()
     */
    public function getInsightBasePrompt(): string
    {
        return DefaultPrompts::resolve(LegacyPrompts::INSIGHT, SingleValue::toString($this->insightBasePrompt->getValue()));
    }

    /**
     * Value of the agent model setting: latest recommended, same as chat, or a model.
     */
    public function getConfiguredAgentModel(): string
    {
        $model = trim((string) $this->agentModel->getValue());

        return $model !== '' ? $model : Config::DEFAULT_AGENT_MODEL;
    }

    /**
     * Value of the single "model" setting of previous plugin versions, empty once the model settings were saved.
     */
    private function getLegacyModel(): string
    {
        try {
            $storage = StaticContainer::get(StorageFactory::class)->getPluginStorage($this->pluginName, '');
            if (
                $storage->getValue('modelPreset', null, FieldConfig::TYPE_ARRAY) !== null
                || $storage->getValue('modelCustom', null, FieldConfig::TYPE_STRING) !== null
            ) {
                return '';
            }

            return SingleValue::toString($storage->getValue('model', null, FieldConfig::TYPE_ARRAY));
        } catch (\Throwable $e) {
            return '';
        }
    }
}