341 lines
11 KiB
PHP
341 lines
11 KiB
PHP
|
<?php namespace RainLab\Builder\Classes;
|
||
|
|
|
||
|
|
use ApplicationException;
|
||
|
|
use Symfony\Component\Yaml\Dumper as YamlDumper;
|
||
|
|
use ValidationException;
|
||
|
|
use Exception;
|
||
|
|
use Lang;
|
||
|
|
use File;
|
||
|
|
use Twig;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper class for generating controller class files and associated files.
|
||
|
|
*
|
||
|
|
* @package rainlab\builder
|
||
|
|
* @author Alexey Bobkov, Samuel Georges
|
||
|
|
*/
|
||
|
|
class ControllerGenerator
|
||
|
|
{
|
||
|
|
protected $sourceModel;
|
||
|
|
|
||
|
|
protected $templateVars;
|
||
|
|
|
||
|
|
protected $configTemplateProperties = [];
|
||
|
|
|
||
|
|
protected $templateFiles = [];
|
||
|
|
|
||
|
|
protected $filesGenerated;
|
||
|
|
|
||
|
|
protected $designTimeProviders = [];
|
||
|
|
|
||
|
|
public function __construct($source)
|
||
|
|
{
|
||
|
|
$this->sourceModel = $source;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function generate()
|
||
|
|
{
|
||
|
|
$this->filesGenerated = [];
|
||
|
|
$this->templateVars = [];
|
||
|
|
|
||
|
|
try {
|
||
|
|
$this->validateBehaviorViewTemplates();
|
||
|
|
$this->validateBehaviorConfigSettings();
|
||
|
|
$this->validateControllerUnique();
|
||
|
|
|
||
|
|
$this->setTemplateVars();
|
||
|
|
$this->generateControllerFile();
|
||
|
|
$this->generateConfigFiles();
|
||
|
|
$this->generateViews();
|
||
|
|
}
|
||
|
|
catch (Exception $ex) {
|
||
|
|
$this->rollback();
|
||
|
|
|
||
|
|
throw $ex;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public function setTemplateVariable($var, $value)
|
||
|
|
{
|
||
|
|
$this->templateVars[$var] = $value;
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function validateBehaviorViewTemplates()
|
||
|
|
{
|
||
|
|
if (!$this->sourceModel->behaviors) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->templateFiles = [];
|
||
|
|
|
||
|
|
$controllerPath = $this->sourceModel->getControllerFilePath(true);
|
||
|
|
$behaviorLibrary = ControllerBehaviorLibrary::instance();
|
||
|
|
|
||
|
|
$knownTemplates = [];
|
||
|
|
foreach ($this->sourceModel->behaviors as $behaviorClass) {
|
||
|
|
$behaviorInfo = $behaviorLibrary->getBehaviorInfo($behaviorClass);
|
||
|
|
if (!$behaviorInfo) {
|
||
|
|
throw new ValidationException([
|
||
|
|
'behaviors' => Lang::get('rainlab.builder::lang.controller.error_unknown_behavior', [
|
||
|
|
'class' => $behaviorClass
|
||
|
|
])
|
||
|
|
]);
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($behaviorInfo['viewTemplates'] as $viewTemplate) {
|
||
|
|
$templateFileName = basename($viewTemplate);
|
||
|
|
$templateBaseName = pathinfo($templateFileName, PATHINFO_FILENAME);
|
||
|
|
|
||
|
|
if (in_array($templateFileName, $knownTemplates)) {
|
||
|
|
throw new ValidationException([
|
||
|
|
'behaviors' => Lang::get('rainlab.builder::lang.controller.error_behavior_view_conflict', [
|
||
|
|
'view' => $templateBaseName
|
||
|
|
])
|
||
|
|
]);
|
||
|
|
|
||
|
|
throw new ApplicationException();
|
||
|
|
}
|
||
|
|
|
||
|
|
$knownTemplates[] = $templateFileName;
|
||
|
|
|
||
|
|
$filePath = File::symbolizePath($viewTemplate);
|
||
|
|
if (!File::isFile($filePath)) {
|
||
|
|
throw new ValidationException([
|
||
|
|
'behaviors' => Lang::get('rainlab.builder::lang.controller.error_behavior_view_file_not_found', [
|
||
|
|
'class' => $behaviorClass,
|
||
|
|
'view' => $templateFileName
|
||
|
|
])
|
||
|
|
]);
|
||
|
|
}
|
||
|
|
|
||
|
|
$destFilePath = $controllerPath.'/'.$templateBaseName;
|
||
|
|
if (File::isFile($destFilePath)) {
|
||
|
|
throw new ValidationException([
|
||
|
|
'behaviors' => Lang::get('rainlab.builder::lang.controller.error_behavior_view_file_exists', [
|
||
|
|
'view' => $destFilePath
|
||
|
|
])
|
||
|
|
]);
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->templateFiles[$filePath] = $destFilePath;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function validateBehaviorConfigSettings()
|
||
|
|
{
|
||
|
|
if (!$this->sourceModel->behaviors) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->configTemplateProperties = [];
|
||
|
|
|
||
|
|
$controllerPath = $this->sourceModel->getControllerFilePath(true);
|
||
|
|
$behaviorLibrary = ControllerBehaviorLibrary::instance();
|
||
|
|
|
||
|
|
$knownConfgFiles = [];
|
||
|
|
foreach ($this->sourceModel->behaviors as $behaviorClass) {
|
||
|
|
$behaviorInfo = $behaviorLibrary->getBehaviorInfo($behaviorClass);
|
||
|
|
$configFileName = $behaviorInfo['configFileName'];
|
||
|
|
|
||
|
|
if (!strlen($configFileName)) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (in_array($configFileName, $knownConfgFiles)) {
|
||
|
|
throw new ValidationException([
|
||
|
|
'behaviors' => Lang::get('rainlab.builder::lang.controller.error_behavior_config_conflict', [
|
||
|
|
'file' => $configFileName
|
||
|
|
])
|
||
|
|
]);
|
||
|
|
|
||
|
|
throw new ApplicationException();
|
||
|
|
}
|
||
|
|
|
||
|
|
$knownConfgFiles[] = $configFileName;
|
||
|
|
|
||
|
|
$destFilePath = $controllerPath.'/'.$configFileName;
|
||
|
|
if (File::isFile($destFilePath)) {
|
||
|
|
throw new ValidationException([
|
||
|
|
'behaviors' => Lang::get('rainlab.builder::lang.controller.error_behavior_config_file_exists', [
|
||
|
|
'file' => $destFilePath
|
||
|
|
])
|
||
|
|
]);
|
||
|
|
}
|
||
|
|
|
||
|
|
$configPropertyName = $behaviorInfo['configPropertyName'];
|
||
|
|
$this->configTemplateProperties[$configPropertyName] = $configFileName;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function validateControllerUnique()
|
||
|
|
{
|
||
|
|
$controlerFilePath = $this->sourceModel->getControllerFilePath();
|
||
|
|
|
||
|
|
if (File::isFile($controlerFilePath)) {
|
||
|
|
throw new ValidationException([
|
||
|
|
'controller' => Lang::get('rainlab.builder::lang.controller.error_controller_exists', [
|
||
|
|
'file' => basename($controlerFilePath)
|
||
|
|
])
|
||
|
|
]);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function setTemplateVars()
|
||
|
|
{
|
||
|
|
$pluginCodeObj = $this->sourceModel->getPluginCodeObj();
|
||
|
|
|
||
|
|
$this->templateVars['pluginNamespace'] = $pluginCodeObj->toPluginNamespace();
|
||
|
|
$this->templateVars['pluginCode'] = $pluginCodeObj->toCode();
|
||
|
|
$this->templateVars['permissions'] = $this->sourceModel->permissions;
|
||
|
|
$this->templateVars['controller'] = $this->sourceModel->controller;
|
||
|
|
$this->templateVars['baseModelClassName'] = $this->sourceModel->baseModelClassName;
|
||
|
|
|
||
|
|
$this->templateVars['controllerUrl'] = $pluginCodeObj->toUrl().'/'.strtolower($this->sourceModel->controller);
|
||
|
|
|
||
|
|
$menuItem = $this->sourceModel->menuItem;
|
||
|
|
if ($menuItem) {
|
||
|
|
$itemParts = explode('||', $menuItem);
|
||
|
|
$this->templateVars['menuItem'] = $itemParts[0];
|
||
|
|
|
||
|
|
if (count($itemParts) > 1) {
|
||
|
|
$this->templateVars['sideMenuItem'] = $itemParts[1];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->sourceModel->behaviors) {
|
||
|
|
$this->templateVars['behaviors'] = $this->sourceModel->behaviors;
|
||
|
|
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$this->templateVars['behaviors'] = [];
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->templateVars['behaviorConfigVars'] = $this->configTemplateProperties;
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function getTemplatePath($template)
|
||
|
|
{
|
||
|
|
return __DIR__.'/controllergenerator/templates/'.$template;
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function parseTemplate($templatePath, $vars = [])
|
||
|
|
{
|
||
|
|
$template = File::get($templatePath);
|
||
|
|
|
||
|
|
$vars = array_merge($this->templateVars, $vars);
|
||
|
|
$code = Twig::parse($template, $vars);
|
||
|
|
|
||
|
|
return $code;
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function writeFile($path, $data)
|
||
|
|
{
|
||
|
|
$fileDirectory = dirname($path);
|
||
|
|
if (!File::isDirectory($fileDirectory)) {
|
||
|
|
if (!File::makeDirectory($fileDirectory, 0777, true, true)) {
|
||
|
|
throw new ApplicationException(Lang::get('rainlab.builder::lang.common.error_make_dir', [
|
||
|
|
'name' => $fileDirectory
|
||
|
|
]));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (@File::put($path, $data) === false) {
|
||
|
|
throw new ApplicationException(Lang::get('rainlab.builder::lang.controller.error_save_file', [
|
||
|
|
'file' => basename($path)
|
||
|
|
]));
|
||
|
|
}
|
||
|
|
|
||
|
|
@File::chmod($path);
|
||
|
|
$this->filesGenerated[] = $path;
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function rollback()
|
||
|
|
{
|
||
|
|
foreach ($this->filesGenerated as $path) {
|
||
|
|
@unlink($path);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function generateControllerFile()
|
||
|
|
{
|
||
|
|
$templateParts = [];
|
||
|
|
$code = $this->parseTemplate($this->getTemplatePath('controller-config-vars.php.tpl'));
|
||
|
|
if (strlen($code)) {
|
||
|
|
$templateParts[] = $code;
|
||
|
|
}
|
||
|
|
|
||
|
|
$code = $this->parseTemplate($this->getTemplatePath('controller-permissions.php.tpl'));
|
||
|
|
if (strlen($code)) {
|
||
|
|
$templateParts[] = $code;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (count($templateParts)) {
|
||
|
|
$templateParts = "\n".implode("\n", $templateParts);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$templateParts = "";
|
||
|
|
}
|
||
|
|
|
||
|
|
$code = $this->parseTemplate($this->getTemplatePath('controller.php.tpl'), [
|
||
|
|
'templateParts' => $templateParts
|
||
|
|
]);
|
||
|
|
|
||
|
|
$controlerFilePath = $this->sourceModel->getControllerFilePath();
|
||
|
|
|
||
|
|
$this->writeFile($controlerFilePath, $code);
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function getBehaviorDesignTimeProvider($providerClass)
|
||
|
|
{
|
||
|
|
if (array_key_exists($providerClass, $this->designTimeProviders)) {
|
||
|
|
return $this->designTimeProviders[$providerClass];
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->designTimeProviders[$providerClass] = new $providerClass(null, []);
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function generateConfigFiles()
|
||
|
|
{
|
||
|
|
if (!$this->sourceModel->behaviors) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$controllerPath = $this->sourceModel->getControllerFilePath(true);
|
||
|
|
$behaviorLibrary = ControllerBehaviorLibrary::instance();
|
||
|
|
$dumper = new YamlDumper();
|
||
|
|
|
||
|
|
foreach ($this->sourceModel->behaviors as $behaviorClass) {
|
||
|
|
$behaviorInfo = $behaviorLibrary->getBehaviorInfo($behaviorClass);
|
||
|
|
$configFileName = $behaviorInfo['configFileName'];
|
||
|
|
|
||
|
|
if (!strlen($configFileName)) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$provider = $this->getBehaviorDesignTimeProvider($behaviorInfo['designTimeProvider']);
|
||
|
|
|
||
|
|
$destFilePath = $controllerPath.'/'.$configFileName;
|
||
|
|
|
||
|
|
try {
|
||
|
|
$configArray = $provider->getDefaultConfiguration($behaviorClass, $this->sourceModel, $this);
|
||
|
|
}
|
||
|
|
catch (Exception $ex) {
|
||
|
|
throw new ValidationException(['baseModelClassName' => $ex->getMessage()]);
|
||
|
|
}
|
||
|
|
|
||
|
|
$code = $dumper->dump($configArray, 20, 0, false, true);
|
||
|
|
|
||
|
|
$this->writeFile($destFilePath, $code);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function generateViews()
|
||
|
|
{
|
||
|
|
foreach ($this->templateFiles as $templatePath=>$destPath) {
|
||
|
|
$code = $this->parseTemplate($templatePath);
|
||
|
|
|
||
|
|
$this->writeFile($destPath, $code);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|