CMS Theme import and management

.codeclimate.yml

@@ -0,0 +1,4 @@
+exclude_patterns:
+ - "src/frontend/messages/**/*.php"
+ - "src/admin/messages/**/*.php"
+ - "src/admin/migrations/*.php"

.travis.yml

@@ -8,11 +8,13 @@ php:
  - 7.1
  - 7.2
  - 7.3
+ - 7.4
  - nightly
 
 matrix:
  allow_failures:
  - php: 5.6
+ - php: 7.4
  - php: nightly
 
 sudo: false

CHANGELOG.md

@@ -5,6 +5,7 @@ In order to read more about upgrading and BC breaks have a look at the [UPGRADE
 
 ## 3.0
 
++ [#211](https://github.com/luyadev/luya-module-cms/pull/211) Add the theme loading and management to the cms module based on core theme [luya/issues/1916](https://github.com/luyadev/luya/issues/1916)
 + [#235](https://github.com/luyadev/luya-module-cms/issues/235) Fixed cms toolbar bug in ajax context.
 
 ## 2.2.0 (12. November 2019)

src/admin/Module.php

@@ -2,6 +2,7 @@
 
 namespace luya\cms\admin;
 
+use luya\cms\admin\importers\ThemeImporter;
 use Yii;
 use luya\console\interfaces\ImportControllerInterface;
 use luya\cms\admin\importers\BlockImporter;
@@ -54,6 +55,7 @@ final class Module extends \luya\admin\base\Module implements CoreModuleInterfac
  'api-cms-navcontainer' => 'luya\cms\admin\apis\NavContainerController',
  'api-cms-navitemblock' => 'luya\cms\admin\apis\NavItemBlockController',
  'api-cms-redirect' => 'luya\cms\admin\apis\RedirectController',
+ 'api-cms-theme' => 'luya\cms\admin\apis\ThemeController',
  ];
 
  public $apiRules = [
@@ -264,6 +266,7 @@ public function getMenu()
  ->itemRoute('menu_group_item_env_permission', "cmsadmin/permission/index", 'gavel')
  ->itemApi('menu_group_item_env_container', 'cmsadmin/navcontainer/index', 'label_outline', 'api-cms-navcontainer')
  ->itemApi('menu_group_item_env_layouts', 'cmsadmin/layout/index', 'view_quilt', 'api-cms-layout')
+ ->itemApi('menu_group_item_env_themes', 'cmsadmin/theme/index', 'color_lens', 'api-cms-theme')
  ->itemRoute('menu_group_item_env_config', 'cmsadmin/config/index', 'build')
  ->itemApi('menu_group_item_env_redirections', 'cmsadmin/redirect/index', 'compare_arrows', 'api-cms-redirect')
  ->group('menu_group_elements')
@@ -302,6 +305,7 @@ public function extendPermissionRoutes()
  public function import(ImportControllerInterface $importer)
  {
  return [
+ ThemeImporter::class,
  BlockImporter::class,
  CmslayoutImporter::class,
  PropertyConsistencyImporter::class,

src/admin/apis/ThemeController.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace luya\cms\admin\apis;
+
+/**
+ * Theme for LUYA CMS.
+ *
+ * This module / component allow user to manage actual display themes.
+ *
+ * @author Bennet Klarhoelter <boehsermoe@me.com>
+ * @since 3.0.0
+ */
+class ThemeController extends \luya\admin\ngrest\base\Api
+{
+ public $modelClass = 'luya\cms\models\Theme';
+}

src/admin/controllers/ThemeController.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace luya\cms\admin\controllers;
+
+use luya\admin\ngrest\base\Controller;
+
+/**
+ * Theme for LUYA CMS.
+ *
+ * This module / component allow user to manage actual display themes.
+ *
+ * @author Bennet Klarhoelter <boehsermoe@me.com>
+ * @since 3.0.0
+ */
+class ThemeController extends Controller
+{
+ public $modelClass = 'luya\cms\models\Theme';
+}

src/admin/importers/BlockImporter.php

@@ -35,20 +35,20 @@ public function run()
  }
 
  $exists = [];
- 
+
  foreach ($this->getImporter()->getDirectoryFiles('blocks') as $file) {
  $exists[] = $this->saveBlock($file['ns']);
  }
-  
+
  foreach (Yii::$app->packageInstaller->configs as $config) {
  $exists = array_merge($exists, $this->handleBlockDefinitions($config->blocks));
  }
-  
+
  // provide backwards compatibility for core 1.0.7 and below
  if ($this->hasProperty('module')) {
  $exists = array_merge($exists, $this->handleBlockDefinitions($this->module->blocks));
  }
-  
+
  foreach (Block::find()->all() as $block) {
  if (!class_exists($block->class)) {
  $this->addLog("[!] The block {$block->class} used {$block->usageCount} times, does not exists anymore. You should either use migrate or cleanup command.");

src/admin/importers/CmslayoutImporter.php

@@ -41,6 +41,10 @@ public function run()
  foreach ((array) $this->module->cmsLayouts as $layoutDefintion) {
  $this->handleLayoutFile($layoutFiles, $layoutDefintion);
  }
+
+ foreach (Yii::$app->themeManager->getThemes() as $themeConfig) {
+ $this->handleLayoutFile($layoutFiles, $themeConfig->getViewPath() . DIRECTORY_SEPARATOR . 'cmslayouts', $themeConfig->name);
+ }
 
  // remove all view files not found somewhere ...
  foreach (Layout::find()->where(['not in', 'id', $layoutFiles])->all() as $layoutItem) {
@@ -55,21 +59,22 @@ public function run()
  *
  * @param array $layoutFiles
  * @param string $path
+ * @param string $themeName
  */
- protected function handleLayoutFile(&$layoutFiles, $path)
+ protected function handleLayoutFile(&$layoutFiles, $path, $themeName = null)
  {
  $aliased = Yii::getAlias($path, false);
  $filePath = $aliased ? $aliased : $path;
 
  if (is_dir($filePath)) {
  foreach ($this->getFilesFromFolder($filePath) as $file) {
- $handler = $this->importLayoutFile($file, $path);
+ $handler = $this->importLayoutFile($file, $path, $themeName);
  if ($handler) {
  $layoutFiles[] = $handler;
  }
  }
  } else {
- $handler = $this->importLayoutFile($filePath, $path);
+ $handler = $this->importLayoutFile($filePath, $path, $themeName);
  if ($handler) {
  $layoutFiles[] = $handler;
  }
@@ -99,7 +104,7 @@ protected function getFilesFromFolder($folderPath)
  * @throws Exception
  * @return string
  */
- protected function importLayoutFile($file, $aliased)
+ protected function importLayoutFile($file, $aliased, $themeName = null)
  {
  if (!file_exists($file)) {
  return false;
@@ -131,7 +136,11 @@ protected function importLayoutFile($file, $aliased)
  }
 
  $readableFileName = $this->generateReadableName($fileinfo->name);
-
+
+ if ($themeName) {
+ $readableFileName = $this->generateReadableName($themeName) . ' - ' . $readableFileName;
+ }
+
  $content = file_get_contents($file);
 
  preg_match_all("/placeholders\[[\'\"](.*?)[\'\"]\]/", $content, $results);

src/admin/importers/ThemeImporter.php

@@ -0,0 +1,124 @@
+<?php
+
+namespace luya\cms\admin\importers;
+
+use luya\cms\models\Theme;
+use luya\console\Importer;
+use luya\helpers\Json;
+use luya\theme\ThemeConfig;
+use luya\theme\ThemeManager;
+use Yii;
+use yii\base\InvalidConfigException;
+
+/**
+ * Class ThemeImporter
+ * Import theme.json files from the folder and analyse config.
+ *
+ * @property ThemeManager $themeManager
+ *
+ * @author Bennet Klarhoelter <boehsermoe@me.com>
+ * @since 3.0.0
+ */
+class ThemeImporter extends Importer
+{
+ /**
+ * @var ThemeManager
+ */
+ private $_themeManager;
+
+ /**
+ * @inheritdoc
+ */
+ public function run($thowException = false)
+ {
+ $exists = [];
+
+ foreach ($this->getThemeManager()->getThemes($thowException) as $theme) {
+ /** @var \luya\theme\Theme $theme */
+ $exists = array_merge($exists, $this->handleThemeDefinitionInDirectories($theme->basePath));
+ }
+
+ foreach (Theme::find()->all() as $theme) {
+ if (!in_array($theme->id, $exists) && $theme->delete()) {
+ $this->addLog("[!] The theme {$theme->base_path} does not found anymore and was deleted.");
+ }
+ }
+
+ return $this->addLog("Theme importer finished with " . count($exists) . " themes.");
+ }
+
+ /**
+ * Handle a theme definition for different folders
+ *
+ * @param string $themeDefinition
+ * @return array
+ */
+ protected function handleThemeDefinitionInDirectories($themeDefinition)
+ {
+ $results = [];
+
+ $themeDefinition = preg_replace('#^vendor/#', '@vendor/', $themeDefinition);
+
+ $themeId = $this->saveTheme($themeDefinition);
+ if ($themeId) {
+ $results[$themeDefinition] = $themeId;
+ }
+
+ return $results;
+ }
+
+ /**
+ * Save a theme by its base path.
+ * Example path: @app/themes/blank
+ *
+ * @param $basePath
+ * @return mixed|bool False if could not exists.
+ * @throws InvalidConfigException
+ */
+ protected function saveTheme($basePath)
+ {
+ $themeFile = Yii::getAlias($basePath . '/theme.json');
+ $config = Json::decode(file_get_contents($themeFile)) ?: [];
+
+ $themeConfig = new ThemeConfig($basePath, $config);
+
+ $themeModel = Theme::findOne(['base_path' => $basePath]);
+
+ if (!$themeModel) {
+ $themeModel = new Theme();
+ $themeModel->base_path = $basePath;
+ $themeModel->setThemeConfig($themeConfig);
+
+ $log = "Added theme $basePath to database.";
+ } else {
+ $themeModel->setThemeConfig($themeConfig);
+ $log = "Updated theme $basePath.";
+ }
+
+ if ($themeModel->save()) {
+ $this->addLog($log);
+ }
+
+ return $themeModel->id;
+ }
+
+ /**
+ * @return ThemeManager
+ */
+ public function getThemeManager()
+ {
+ if ($this->_themeManager == null) {
+ $this->_themeManager = Yii::$app->themeManager;
+ }
+
+ return $this->_themeManager;
+ }
+
+ /**
+ * @param ThemeManager $themeManager
+ */
+ public function setThemeManager($themeManager)
+ {
+ $this->_themeManager = $themeManager;
+ }
+}

src/admin/migrations/m190728_084936_cms_theme.php

@@ -0,0 +1,24 @@
+<?php
+
+use yii\db\Migration;
+
+/**
+ * Class m190728_084936_cms_theme
+ */
+class m190728_084936_cms_theme extends Migration
+{
+ public function safeUp()
+ {
+ $this->createTable('cms_theme', [
+ 'id' => $this->primaryKey(),
+ 'is_active' => $this->boolean()->notNull()->defaultValue(0),
+ 'base_path' => $this->string(255)->notNull()->unique(),
+ 'json_config' => $this->text()->notNull(),
+ ]);
+ }
+
+ public function safeDown()
+ {
+ $this->dropTable('cms_theme');
+ }
+}

src/admin/views/aws/blockpages/index.php

@@ -18,16 +18,18 @@
  <th>Created</th>
 </tr>
 </thead>
-<?php foreach ($blocks as $block): ?>
- <tr ui-sref="custom.cmsedit({ navId : <?= $block->navItemPage->forceNavItem->nav_id; ?>, templateId: 'cmsadmin/default/index'})" style="cursor:pointer;">
- <td>
- <a ui-sref="custom.cmsedit({ navId : <?= $block->navItemPage->forceNavItem->nav_id; ?>, templateId: 'cmsadmin/default/index'})"><?= $block->navItemPage->forceNavItem->title; ?></a>
- </td>
- <td><?= $block->navItemPage->forceNavItem->lang->name; ?></td>
- <td><?= $block->navItemPage->version_alias; ?></td>
- <td><?= Yii::$app->formatter->asBoolean(!$block->is_hidden); ?></td>
- <td><?= Yii::$app->formatter->asDate($block->navItemPage->forceNavItem->timestamp_update); ?></td>
- <td><?= Yii::$app->formatter->asDate($block->navItemPage->forceNavItem->timestamp_create); ?></td>
- </tr>
-<?php endforeach; ?>
+<?php if (isset($blocks)) : ?>
+ <?php foreach ($blocks as $block): ?>
+ <tr ui-sref="custom.cmsedit({ navId : <?= $block->navItemPage->forceNavItem->nav_id; ?>, templateId: 'cmsadmin/default/index'})" style="cursor:pointer;">
+ <td>
+ <a ui-sref="custom.cmsedit({ navId : <?= $block->navItemPage->forceNavItem->nav_id; ?>, templateId: 'cmsadmin/default/index'})"><?= $block->navItemPage->forceNavItem->title; ?></a>
+ </td>
+ <td><?= $block->navItemPage->forceNavItem->lang->name; ?></td>
+ <td><?= $block->navItemPage->version_alias; ?></td>
+ <td><?= Yii::$app->formatter->asBoolean(!$block->is_hidden); ?></td>
+ <td><?= Yii::$app->formatter->asDate($block->navItemPage->forceNavItem->timestamp_update); ?></td>
+ <td><?= Yii::$app->formatter->asDate($block->navItemPage->forceNavItem->timestamp_create); ?></td>
+ </tr>
+ <?php endforeach; ?>
+<?php endif ?>
 </table>

src/frontend/Bootstrap.php

@@ -2,14 +2,13 @@
 
 namespace luya\cms\frontend;
 
-use Yii;
+use luya\cms\models\Config;
+use luya\web\Application;
+use luya\web\ErrorHandler;
+use luya\web\ErrorHandlerExceptionRenderEvent;
 use yii\base\BootstrapInterface;
 use yii\web\NotFoundHttpException;
 use yii\web\Response;
-use luya\web\ErrorHandlerExceptionRenderEvent;
-use luya\web\Application;
-use luya\web\ErrorHandler;
-use luya\cms\models\Config;
 
 /**
  * CMS Bootstrap.
@@ -48,7 +47,7 @@ public function bootstrap($app)
  // handle not found exceptions
  $app->errorHandler->on(ErrorHandler::EVENT_BEFORE_EXCEPTION_RENDER, function (ErrorHandlerExceptionRenderEvent $event) use ($app) {
  if ($app instanceof Application && $event->exception instanceof NotFoundHttpException && !$app->request->isAdmin) {
- $errorPageNavId = Config::get(Config::HTTP_EXCEPTION_NAV_ID, 0); 
+ $errorPageNavId = Config::get(Config::HTTP_EXCEPTION_NAV_ID, 0);
  // if not defined abort.
  if (!$errorPageNavId) {
  return;