[ADD] Manage robots.txt file via Admin Panel.

Seiger · Seiger · commit 22d8d2973f16 · 2025-02-07T23:42:37.000+02:00
diff --git a/README.md b/README.md
@@ -21,21 +21,26 @@ this plugin provides the tools you need for a competitive edge in the digital la
 
 ## Features
 
+- [x] Custom SEO Title and Description.
+- [x] Canonical URL Implementation.
 - [x] Automatic META Tags Generation.
 - [x] XML Sitemap Generation.
 - [x] Include or exclude documents from xml sitemap (via Searchable).
-- [x] On page Robots index/follow settings.
-- [x] Custom SEO Title and Description.
-- [x] Canonical URL Implementation.
+- [ ] On page Robots index/follow settings.
 - [x] Noindex for Pagination and Custom $_GET Parameters.
+- [x] 30x Redirects for Resolving 404 Errors.
 - [x] HTTP(S) and WWW Redirects.
+- [x] Manage robots.txt file via Admin Panel.
 - [ ] Open Graph Protocol Integration.
-- [x] 30x Redirects for Resolving 404 Errors.
 - [ ] SEO Dashboard and Reporting.
 - [ ] Social Media Integration Metrics.
 - [ ] AI-Powered SEO Recommendations.
 - [ ] Featured Snippets Optimization.
 - [ ] Local Business Schema Markup.
+- [ ] SEO Health Check
+- [ ] Rich Snippets (Schema Markup) Support
+- [ ] Performance Optimization Recommendations
+- [ ] Real-time SEO Analytics
 
 ## Install by artisan package installer
 
diff --git a/composer.json b/composer.json
@@ -3,15 +3,15 @@
     "license": "GPL-3.0",
     "type": "EvolutionCMS-Plugin",
     "description": "Evocms package for collection of SEO Tools for Evolution CMS.",
-    "keywords": ["evocms", "evolution-cms", "seo"],
+    "keywords": ["evocms", "evolution-cms", "seo", "evolution-cms-seo", "seo-tools", "cms-seo", "evolution-cms-plugin"],
     "authors": [
         {
             "name": "Serhii Korneliuk",
             "email": "info@seigerit.com"
         }
     ],
     "require": {
-        "php": "^8.1"
+        "php": ">=8.2"
     },
     "autoload": {
         "psr-4": {
@@ -28,7 +28,12 @@
             }
         }
     },
+    "config": {
+        "exclude-files": [
+            "docs/*"
+        ]
+    },
     "scripts": {
         "post-autoload-dump": []
     }
-}
+}
diff --git a/docs/pages/index.md b/docs/pages/index.md
@@ -28,21 +28,26 @@ this plugin provides the tools you need for a competitive edge in the digital la
 
 ## Features
 
+- [x] Custom SEO Title and Description.
+- [x] Canonical URL Implementation.
 - [x] Automatic META Tags Generation.
 - [x] XML Sitemap Generation.
 - [x] Include or exclude documents from xml sitemap (via Searchable).
-- [x] On page Robots index/follow settings.
-- [x] Custom SEO Title and Description.
-- [x] Canonical URL Implementation.
+- [ ] On page Robots index/follow settings.
 - [x] Noindex for Pagination and Custom $_GET Parameters.
+- [x] 30x Redirects for Resolving 404 Errors.
 - [x] HTTP(S) and WWW Redirects.
+- [x] Manage robots.txt file via Admin Panel.
 - [ ] Open Graph Protocol Integration.
-- [ ] 301 Redirects for Resolving 404 Errors.
 - [ ] SEO Dashboard and Reporting.
 - [ ] Social Media Integration Metrics.
 - [ ] AI-Powered SEO Recommendations.
 - [ ] Featured Snippets Optimization.
 - [ ] Local Business Schema Markup.
+- [ ] SEO Health Check
+- [ ] Rich Snippets (Schema Markup) Support
+- [ ] Performance Optimization Recommendations
+- [ ] Real-time SEO Analytics
 
 ## Support
 
diff --git a/lang/en/global.php b/lang/en/global.php
@@ -22,6 +22,7 @@
     'noindex_get' => 'Do not index $_GET',
     'noindex_get_help' => 'Specify the list of $_GET parameters separated by commas. Pages with these options will be banned from indexing.',
     'not_writable' => 'The file ../core/custom/config/seiger/settings/sSeo.php is not writable.',
+    'not_writable_robots' => 'The file ../robots.txt is not writable.',
     'old_url' => 'Old URL',
     'paginates_get' => 'Pagination pages',
     'paginates_get_help' => 'A parameter indicating that this page is a pagination page. Default page.',
@@ -33,8 +34,12 @@
     'redirects_enabled_help' => 'Allows or disables the use of SEO redirects on the site.',
     'redirects_help' => 'Setting up SEO site redirects.',
     'redirects_icon' => 'fa fa-retweet',
+    'robots' => 'Robots',
+    'robots_help' => 'Configuring the robots.txt file.',
+    'robots_icon' => 'fa fas fa-robot',
+    'robots_text_empty' => 'The text for the robots.txt file cannot be empty.',
     'site_key' => 'Site Key',
-    'success_updated' => 'Redirects successfully updated!',
+    'success_updated' => 'Data successfully updated!',
     'title' => 'SEO',
     'using_www' => 'Using WWW',
     'without_www' => 'Without WWW',
diff --git a/lang/ru/global.php b/lang/ru/global.php
@@ -13,15 +13,16 @@
     'ignore' => 'Не враховувати',
     'manage_www' => 'Керування WWW',
     'message_for_large_number_redirects' => 'Занадто велика кількість редіректів може негативно вплинути на швидкість роботи сайту. <br>Зверніть увагу: вказані редіректи застосовуються лише у випадку, якщо сторінку не знайдено (404).',
-    'meta_description' => 'Метаопис',
+    'meta_description' => 'SEO Опис',
     'meta_description_help' => 'Метаопис безпосередньо не впливає на рейтинг веб-сторінки в результатах пошуку, але може впливати на кількість кліків, які отримує сторінка, що може опосередковано впливати на її рейтинг. Намагайтеся отримати метаопис довжиною близько 155 символів.',
-    'meta_title' => 'Мета тайтл',
+    'meta_title' => 'SEO Заголовок',
     'meta_title_help' => 'Хороший мета-заголовок має бути коротким і точним описом вмісту сторінки. Прагніть до 50-60 символів, включаючи пробіли.',
     'new_url' => 'Нова URL-адреса',
     'no_redirects_provided' => 'Редіректи не були надані. Будь ласка, додайте хоча б один редірект перед збереженням.',
     'noindex_get' => 'Не індексувати $_GET',
     'noindex_get_help' => 'Вкажіть список $_GET параметрів через кому. Сторінки з цими параметрами будуть заборонені для індексації.',
     'not_writable' => 'Файл ../core/custom/config/seiger/settings/sSeo.php не доступний для запису.',
+    'not_writable_robots' => 'Файл ../robots.txt не доступний для запису.',
     'old_url' => 'Стара URL-адреса',
     'paginates_get' => 'Сторінки пагінації',
     'paginates_get_help' => 'Параметр, що вказує на те, що дана сторінка є сторінкою пагінації. Типово page.',
@@ -33,8 +34,12 @@
     'redirects_enabled_help' => 'Дозволяє або забороняє використання SEO редіректів на сайті.',
     'redirects_help' => 'Налаштування SEO редіректів сайта.',
     'redirects_icon' => 'fa fa-retweet',
+    'robots' => 'Роботс',
+    'robots_help' => 'Налаштування файлу robots.txt.',
+    'robots_icon' => 'fa fas fa-robot',
+    'robots_text_empty' => 'Текст для файлу robots.txt не може бути порожнім.',
     'site_key' => 'Ключ сайту',
-    'success_updated' => 'Редіректи успішно оновлено!',
+    'success_updated' => 'Дані успішно оновлено!',
     'title' => 'SEO',
     'using_www' => 'З WWW',
     'without_www' => 'Без WWW',
diff --git a/lang/uk/global.php b/lang/uk/global.php
@@ -13,15 +13,16 @@
     'ignore' => 'Не враховувати',
     'manage_www' => 'Керування WWW',
     'message_for_large_number_redirects' => 'Занадто велика кількість редіректів може негативно вплинути на швидкість роботи сайту. <br>Зверніть увагу: вказані редіректи застосовуються лише у випадку, якщо сторінку не знайдено (404).',
-    'meta_description' => 'Метаопис',
+    'meta_description' => 'SEO Опис',
     'meta_description_help' => 'Метаопис безпосередньо не впливає на рейтинг веб-сторінки в результатах пошуку, але може впливати на кількість кліків, які отримує сторінка, що може опосередковано впливати на її рейтинг. Намагайтеся отримати метаопис довжиною близько 155 символів.',
-    'meta_title' => 'Мета тайтл',
+    'meta_title' => 'SEO Заголовок',
     'meta_title_help' => 'Хороший мета-заголовок має бути коротким і точним описом вмісту сторінки. Прагніть до 50-60 символів, включаючи пробіли.',
     'new_url' => 'Нова URL-адреса',
     'no_redirects_provided' => 'Редіректи не були надані. Будь ласка, додайте хоча б один редірект перед збереженням.',
     'noindex_get' => 'Не індексувати $_GET',
     'noindex_get_help' => 'Вкажіть список $_GET параметрів через кому. Сторінки з цими параметрами будуть заборонені для індексації.',
     'not_writable' => 'Файл ../core/custom/config/seiger/settings/sSeo.php не доступний для запису.',
+    'not_writable_robots' => 'Файл ../robots.txt не доступний для запису.',
     'old_url' => 'Стара URL-адреса',
     'paginates_get' => 'Сторінки пагінації',
     'paginates_get_help' => 'Параметр, що вказує на те, що дана сторінка є сторінкою пагінації. Типово page.',
@@ -33,8 +34,12 @@
     'redirects_enabled_help' => 'Дозволяє або забороняє використання SEO редіректів на сайті.',
     'redirects_help' => 'Налаштування SEO редіректів сайта.',
     'redirects_icon' => 'fa fa-retweet',
+    'robots' => 'Роботс',
+    'robots_help' => 'Налаштування файлу robots.txt.',
+    'robots_icon' => 'fa fas fa-robot',
+    'robots_text_empty' => 'Текст для файлу robots.txt не може бути порожнім.',
     'site_key' => 'Ключ сайту',
-    'success_updated' => 'Редіректи успішно оновлено!',
+    'success_updated' => 'Дані успішно оновлено!',
     'title' => 'SEO',
     'using_www' => 'З WWW',
     'without_www' => 'Без WWW',
diff --git a/plugins/sSeoPlugin.php b/plugins/sSeoPlugin.php
@@ -94,16 +94,18 @@
 /**
  * Redirects
  */
-Event::listen('evolution.OnPageNotFound', function ($params) {
-    $requestUri = trim(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), '/');
-    $siteKey = evo()->getConfig('check_sMultisite', false) ? evo()->getConfig('site_key', 'default') : 'default';
-    $redirect = sRedirect::where('site_key', $siteKey)->where('old_url', $requestUri)->first();
-
-    if ($redirect) {
-        evo()->sendRedirect($redirect->new_url, 0, '', $redirect->type);
-        exit;
-    }
-});
+if (config('seiger.settings.sSeo.redirects_enabled', 0) == 1) {
+    Event::listen('evolution.OnPageNotFound', function ($params) {
+        $requestUri = trim(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), '/');
+        $siteKey = evo()->getConfig('check_sMultisite', false) ? evo()->getConfig('site_key', 'default') : 'default';
+        $redirect = sRedirect::where('site_key', $siteKey)->where('old_url', $requestUri)->first();
+
+        if ($redirect) {
+            evo()->sendRedirect($redirect->new_url, 0, '', $redirect->type);
+            exit;
+        }
+    });
+}
 
 Event::listen('evolution.OnHeadWebDocumentRender', function($params) {
     // Meta Canonical
@@ -121,10 +123,6 @@
     return view('sSeo::partials.headWebDocument', compact('canonical', 'robots', 'title', 'description'))->render();
 });
 
-Event::listen('evolution.OnDocFormSave', function($params) {
-    sSeo::generateSitemap();
-});
-
 /**
  * Add Menu item
  */
@@ -133,7 +131,7 @@
         'sseo',
         'tools',
         '<i class="'.__('sSeo::global.icon').'"></i><span class="menu-item-text">'.__('sSeo::global.title').'</span>',
-        sSeo::route('sSeo.redirects'),
+        config('seiger.settings.sSeo.redirects_enabled', 0) == 1 ? sSeo::route('sSeo.redirects') : sSeo::route('sSeo.configure'),
         __('sSeo::global.title'),
         "",
         "",
@@ -173,6 +171,7 @@
         $data = array_merge(['resource_id' => $params['id'], 'resource_type' => 'document'], request()->input('sseo', []));
         sSeo::updateSeoFields($data);
     }
+    sSeo::generateSitemap();
 });
 Event::listen('evolution.sCommerceAfterProductContentSave', function($params) {
     if (isset($params['product']) && $params['product']->id) {
diff --git a/src/Controllers/sSeoController.php b/src/Controllers/sSeoController.php
@@ -15,17 +15,6 @@
  */
 class sSeoController
 {
-    /**
-     * Returns the view for the index page.
-     *
-     * @return mixed The view for the index page.
-     */
-    public function index()
-    {
-        $GLOBALS['SystemAlertMsgQueque'] = &$_SESSION['SystemAlertMsgQueque'];
-        return $this->view('index');
-    }
-
     /**
      * Returns the view for the redirects page.
      *
@@ -45,35 +34,26 @@ public function redirects()
     }
 
     /**
-     * Updates the configure file with the new values.
+     * Returns the view for the index page.
      *
-     * @return \Illuminate\Http\RedirectResponse The redirect response to the previous page.
+     * @return mixed The view for the index page.
      */
-    public function updateConfigure()
+    public function robots()
     {
-        $string = '<?php return [' . "\n";
-
-        $string .= "\t" . '"manage_www" => ' . (int)request()->get('manage_www', 0) . ',' . "\n";
-        $string .= "\t" . '"paginates_get" => "' . request()->get('paginates_get', 'page') . '",' . "\n";
-
-        $noindex_get = explode(',', request()->get('noindex_get', ''));
-        $string .= "\t" . '"noindex_get" => [' . "\n";
-        foreach ($noindex_get as $item) {
-            $string .= "\t\t" . '"' . trim($item) . '",' . "\n";
-        }
-        $string .= "\t" . '],' . "\n";
-
-        $string .= "\t" . '"redirects_enabled" => ' . (int)request()->get('redirects_enabled', 0) . ',' . "\n";
-
-        $string .= '];';
-
-        // Save config
-        $handle = fopen(EVO_CORE_PATH . 'custom/config/seiger/settings/sSeo.php', "w");
-        fwrite($handle, $string);
-        fclose($handle);
+        $GLOBALS['SystemAlertMsgQueque'] = &$_SESSION['SystemAlertMsgQueque'];
+        $robots = file_get_contents(MODX_BASE_PATH . 'robots.txt') ?: '';
+        return $this->view('index', compact('robots'));
+    }
 
-        evo()->clearCache('full');
-        return redirect()->back();
+    /**
+     * Returns the view for the index page.
+     *
+     * @return mixed The view for the index page.
+     */
+    public function configure()
+    {
+        $GLOBALS['SystemAlertMsgQueque'] = &$_SESSION['SystemAlertMsgQueque'];
+        return $this->view('index');
     }
 
     /**
@@ -171,6 +151,63 @@ public function updateRedirects()
         return redirect()->back()->with('success', trans('sSeo::global.success_updated'));
     }
 
+
+    /**
+     * Update the content of the robots.txt file.
+     *
+     * This method handles the update of the robots.txt file by taking the
+     * content passed from the request, validating that it is not empty,
+     * and then writing it to the `robots.txt` file. If the input is empty,
+     * it redirects the user back with an error message. Otherwise, it writes
+     * the content to the file and returns a success message.
+     *
+     * @return \Illuminate\Http\RedirectResponse
+     */
+    public function updateRobots()
+    {
+        $robots = request()->input('robots', []);
+
+        if (empty($robots)) {
+            return redirect()->back()->with('error', trans('sSeo::global.robots_text_empty'));
+        }
+
+        file_put_contents(MODX_BASE_PATH . 'robots.txt', $robots);
+
+        return redirect()->back()->with('success', trans('sSeo::global.success_updated'));
+    }
+
+    /**
+     * Updates the configure file with the new values.
+     *
+     * @return \Illuminate\Http\RedirectResponse The redirect response to the previous page.
+     */
+    public function updateConfigure()
+    {
+        $string = '<?php return [' . "\n";
+
+        $string .= "\t" . '"manage_www" => ' . (int)request()->get('manage_www', 0) . ',' . "\n";
+        $string .= "\t" . '"paginates_get" => "' . request()->get('paginates_get', 'page') . '",' . "\n";
+
+        $noindex_get = explode(',', request()->get('noindex_get', ''));
+        $string .= "\t" . '"noindex_get" => [' . "\n";
+        foreach ($noindex_get as $item) {
+            $string .= "\t\t" . '"' . trim($item) . '",' . "\n";
+        }
+        $string .= "\t" . '],' . "\n";
+
+        $string .= "\t" . '"redirects_enabled" => ' . (int)request()->get('redirects_enabled', 0) . ',' . "\n";
+
+        $string .= '];';
+
+        // Save config
+        $handle = fopen(EVO_CORE_PATH . 'custom/config/seiger/settings/sSeo.php', "w");
+        fwrite($handle, $string);
+        fclose($handle);
+
+        evo()->clearCache('full');
+        return redirect()->back();
+    }
+
     /**
      * Returns the view for the specified template.
      *
diff --git a/src/Http/routes.php b/src/Http/routes.php
@@ -4,8 +4,10 @@
 use Seiger\sSeo\Controllers\sSeoController;
 
 Route::middleware('mgr')->prefix('sseo')->name('sSeo.')->group(function () {
-    Route::get('/', [sSeoController::class, 'redirects'])->name('redirects');
-    Route::get('/configure', [sSeoController::class, 'index'])->name('index');
+    Route::get('/redirects', [sSeoController::class, 'redirects'])->name('redirects');
+    Route::get('/robots', [sSeoController::class, 'robots'])->name('robots');
+    Route::get('/configure', [sSeoController::class, 'configure'])->name('configure');
     Route::post('/redirects', [sSeoController::class, 'updateRedirects'])->name('update-redirects');
+    Route::post('/robots', [sSeoController::class, 'updateRobots'])->name('update-robots');
     Route::post('/configure', [sSeoController::class, 'updateConfigure'])->name('update-configure');
 });
diff --git a/views/index.blade.php b/views/index.blade.php
diff --git a/views/robotsTab.blade.php b/views/robotsTab.blade.php
