feat: integrate logging library and enhance settings validation

Author: bhlindemann

src/IconManager.php

@@ -30,6 +30,7 @@
 use lindemannrock\iconmanager\services\IconSetsService;
 use lindemannrock\iconmanager\utilities\ClearIconCache;
 use lindemannrock\iconmanager\variables\IconManagerVariable;
+use lindemannrock\logginglibrary\LoggingLibrary;
 use yii\base\Event;
 use craft\console\Application as ConsoleApplication;
 use craft\services\Utilities;
@@ -171,12 +172,15 @@ public function getCpNavItem(): ?array
                 ],
             ];
 
-            if (Craft::$app->getUser()->checkPermission('accessPlugin-icon-manager')) {
-                $item['subnav']['logs'] = [
-                    'label' => Craft::t('icon-manager', 'Logs'),
-                    'url' => 'icon-manager/logs',
-                ];
+            // Add logs section using the logging library (only if installed)
+            if (Craft::$app->getPlugins()->isPluginInstalled('logging-library') &&
+                Craft::$app->getPlugins()->isPluginEnabled('logging-library')) {
+                $item = LoggingLibrary::addLogsNav($item, $this->handle, [
+                    'accessPlugin-icon-manager'
+                ]);
+            }
 
+            if (Craft::$app->getUser()->checkPermission('accessPlugin-icon-manager')) {
                 $item['subnav']['settings'] = [
                     'label' => Craft::t('icon-manager', 'Settings'),
                     'url' => 'icon-manager/settings',
@@ -203,8 +207,8 @@ function(RegisterUrlRulesEvent $event) {
                     'icon-manager/icon-sets/<iconSetId:\d+>' => 'icon-manager/icon-sets/edit',
                     'icon-manager/icon-sets/delete' => 'icon-manager/icon-sets/delete',
                     'icon-manager/icon-sets/refresh-icons' => 'icon-manager/icon-sets/refresh-icons',
-                    'icon-manager/logs' => 'icon-manager/logs/index',
-                    'icon-manager/logs/download' => 'icon-manager/logs/download',
+                    'icon-manager/logs' => 'logging-library/logs/index',
+                    'icon-manager/logs/download' => 'logging-library/logs/download',
                     'icon-manager/settings' => 'icon-manager/settings/index',
                     'icon-manager/settings/save' => 'icon-manager/settings/save',
                     'icon-manager/icons/render' => 'icon-manager/icons/render',
@@ -353,54 +357,16 @@ private function _clearIconCache(): void
      */
     private function _registerLogTarget(): void
     {
-        // Skip if already configured
-        if (isset(Craft::$app->getLog()->targets['icon-manager'])) {
-            return;
-        }
-
-        // Get base logs path
-        $logsPath = Craft::$app->getPath()->getLogPath();
-
-        // Use date-based log file naming
-        $date = date('Y-m-d');
-        $logFile = $logsPath . "/icon-manager-{$date}.log";
-
-        // Get log level from settings with fallback
-        $logLevel = $this->getSettings()->logLevel ?? 'error';
-
-        // Map log level to array of levels to include
-        $levels = match ($logLevel) {
-            'trace' => ['error', 'warning', 'info', 'trace'],
-            'info' => ['error', 'warning', 'info'],
-            'warning' => ['error', 'warning'],
-            'error' => ['error'],
-            default => ['error', 'warning', 'info']
-        };
-
-        // Create a new log target instance
-        $target = new \yii\log\FileTarget([
-            'logFile' => $logFile,
-            'categories' => ['icon-manager'],
-            'logVars' => [],
-            'levels' => $levels,
-            'maxFileSize' => 10240, // 10MB
-            'maxLogFiles' => 30, // Keep 30 days
-            'prefix' => function ($message) {
-                $user = Craft::$app->has('user', true) ? Craft::$app->getUser() : null;
-                $userId = $user && !$user->getIsGuest() ? $user->getId() : '-';
-                return "[user:{$userId}]";
-            },
-            'rotateByCopy' => false
+        // Configure logging using the new logging library
+        $settings = $this->getSettings();
+
+        LoggingLibrary::configure([
+            'pluginHandle' => $this->handle,
+            'pluginName' => $this->name,
+            'logLevel' => $settings->logLevel,
+            'enableLogViewer' => true,
+            'permissions' => ['iconManager:viewLogs'],
         ]);
-
-        // Add the target to the log dispatcher and ensure it's available immediately
-        Craft::$app->getLog()->targets['icon-manager'] = $target;
-
-        // Initialize the target immediately
-        $target->init();
-
-        // Mark as registered
-        self::$_logTargetRegistered = true;
     }
 
 }

src/controllers/SettingsController.php

@@ -51,10 +51,6 @@ public function actionSave(): ?Response
         // Get settings from request (nested under 'settings' key)
         $postedSettings = $request->getBodyParam('settings', []);
 
-        // Debug logging
-        Craft::info('Posted settings: ' . json_encode($postedSettings), 'icon-manager');
-        Craft::info('Current overridden settings: ' . json_encode($settings->getOverriddenSettings()), 'icon-manager');
-        Craft::info('Current overridden icon types: ' . json_encode($settings->getOverriddenIconTypes()), 'icon-manager');
 
         // Only update non-overridden settings
         if (!$settings->isOverridden('pluginName')) {
@@ -92,10 +88,6 @@ public function actionSave(): ?Response
 
         $settings->enabledIconTypes = $currentIconTypes;
 
-        // Before saving, log the current values
-        Craft::info('Settings before save - showLabels: ' . ($settings->showLabels ? 'true' : 'false'), 'icon-manager');
-        Craft::info('Settings before save - iconSize: ' . $settings->iconSize, 'icon-manager');
-        Craft::info('Settings before save - material-icons: ' . ($settings->enabledIconTypes['material-icons'] ? 'true' : 'false'), 'icon-manager');
 
         // Validate
         if (!$settings->validate()) {

src/models/Settings.php

@@ -91,10 +91,41 @@ protected function defineRules(): array
             [['enableCache'], 'boolean'],
             [['cacheDuration'], 'integer', 'min' => 1],
             [['enabledIconTypes'], 'safe'],
-            [['logLevel'], 'in', 'range' => ['trace', 'info', 'warning', 'error']],
+            [['logLevel'], 'in', 'range' => ['debug', 'info', 'warning', 'error']],
+            [['logLevel'], 'validateLogLevel'],
         ];
     }
 
+    /**
+     * Validate log level - debug requires devMode
+     */
+    public function validateLogLevel($attribute, $params, $validator)
+    {
+        $logLevel = $this->$attribute;
+
+        // Reset session warning when devMode is true - allows warning to show again if devMode changes
+        if (Craft::$app->getConfig()->getGeneral()->devMode) {
+            Craft::$app->getSession()->remove('im_debug_config_warning');
+        }
+
+        // Debug level is only allowed when devMode is enabled - auto-fallback to info
+        if ($logLevel === 'debug' && !Craft::$app->getConfig()->getGeneral()->devMode) {
+            $this->$attribute = 'info';
+
+            // Only log warning once per session for config overrides
+            if ($this->isOverriddenByConfig('logLevel')) {
+                if (Craft::$app->getSession()->get('im_debug_config_warning') === null) {
+                    Craft::warning('Log level "debug" from config file changed to "info" because devMode is disabled. Please update your config/icon-manager.php file.', 'icon-manager');
+                    Craft::$app->getSession()->set('im_debug_config_warning', true);
+                }
+            } else {
+                // Database setting - save the correction
+                Craft::warning('Log level automatically changed from "debug" to "info" because devMode is disabled. This setting has been saved.', 'icon-manager');
+                $this->saveToDatabase();
+            }
+        }
+    }
+
     /**
      * Get the resolved icon sets path
      */
@@ -183,7 +214,7 @@ public static function loadFromDatabase(?Settings $settings = null): self
                     if ($setting === 'enabledIconTypes' && is_array($value)) {
                         // Track which specific icon types are overridden
                         $settings->_overriddenIconTypes = array_keys($value);
-                        
+
                         // Only override the icon types that are in the config
                         // Keep database values for non-specified icon types
                         foreach ($value as $iconType => $enabled) {
@@ -197,7 +228,13 @@ public static function loadFromDatabase(?Settings $settings = null): self
                 }
             }
         }
-        
+
+        // IMPORTANT: Validate settings after config overrides are applied
+        // This will trigger validateLogLevel and other validation methods
+        if (!$settings->validate()) {
+            Craft::error('Icon Manager settings validation failed: ' . print_r($settings->getErrors(), true), 'icon-manager');
+        }
+
         return $settings;
     }
 
@@ -281,4 +318,67 @@ public function getOverriddenIconTypes(): array
     {
         return $this->_overriddenIconTypes;
     }
+
+    /**
+     * Check if a setting is being overridden by config file
+     *
+     * @param string $attribute The setting attribute name
+     * @return bool
+     */
+    public function isOverriddenByConfig(string $attribute): bool
+    {
+        // Get the config file path
+        $configPath = \Craft::$app->getPath()->getConfigPath() . '/icon-manager.php';
+
+        if (!file_exists($configPath)) {
+            return false;
+        }
+
+        // Load the raw config file
+        $rawConfig = require $configPath;
+
+        // Check if this attribute is set in the config file (root level or environment level)
+        $hasRootConfig = array_key_exists($attribute, $rawConfig);
+        $env = \Craft::$app->getConfig()->getGeneral()->env ?? '*';
+        $hasEnvConfig = isset($rawConfig[$env]) && is_array($rawConfig[$env]) && array_key_exists($attribute, $rawConfig[$env]);
+
+        if (!$hasRootConfig && !$hasEnvConfig) {
+            return false;
+        }
+
+
+        return true;
+    }
+
+    /**
+     * Get the raw config value (for display in settings form)
+     *
+     * @param string $attribute The setting attribute name
+     * @return mixed|null
+     */
+    public function getRawConfigValue(string $attribute)
+    {
+        // Get the config file path
+        $configPath = \Craft::$app->getPath()->getConfigPath() . '/icon-manager.php';
+
+        if (!file_exists($configPath)) {
+            return null;
+        }
+
+        // Load the raw config file
+        $rawConfig = require $configPath;
+
+        // Check environment-specific settings first (highest priority)
+        $env = \Craft::$app->getConfig()->getGeneral()->env ?? '*';
+        if (isset($rawConfig[$env]) && is_array($rawConfig[$env]) && array_key_exists($attribute, $rawConfig[$env])) {
+            return $rawConfig[$env][$attribute];
+        }
+
+        // Check root level
+        if (array_key_exists($attribute, $rawConfig)) {
+            return $rawConfig[$attribute];
+        }
+
+        return null;
+    }
 }