code ?>
+This is an automatic message. Please do not reply to it.
- -'; - -$text = '{{ content|raw }} - - ---- -This is an automatic message. Please do not reply to it. -'; - - MailLayout::create([ - 'is_locked' => true, - 'name' => 'System', - 'code' => 'system', - 'content_html' => $html, - 'content_css' => $css, - 'content_text' => $text, - ]); + MailLayout::createLayouts(); } } diff --git a/modules/system/lang/en/lang.php b/modules/system/lang/en/lang.php index d9ced019b..205845f22 100644 --- a/modules/system/lang/en/lang.php +++ b/modules/system/lang/en/lang.php @@ -190,9 +190,13 @@ return [ 'menu_description' => 'Modify the mail templates that are sent to users and administrators, manage email layouts.', 'new_template' => 'New Template', 'new_layout' => 'New Layout', + 'new_partial' => 'New Partial', 'template' => 'Template', 'templates' => 'Templates', + 'partial' => 'Partial', + 'partials' => 'Partials', 'menu_layouts_label' => 'Mail Layouts', + 'menu_partials_label' => 'Mail Partials', 'layout' => 'Layout', 'layouts' => 'Layouts', 'no_layout' => '-- No layout --', diff --git a/modules/system/models/MailLayout.php b/modules/system/models/MailLayout.php index 602f5708e..be5fadb75 100644 --- a/modules/system/models/MailLayout.php +++ b/modules/system/models/MailLayout.php @@ -1,6 +1,10 @@ 'required|unique:system_mail_layouts', 'name' => 'required', @@ -47,4 +64,64 @@ class MailLayout extends Model return array_get(self::listCodes(), $code); } + /** + * Loops over each mail layout and ensures the system has a layout, + * if the layout does not exist, it will create one. + * @return void + */ + public static function createLayouts() + { + $dbLayouts = self::lists('code', 'code'); + + $definitions = MailManager::instance()->listRegisteredLayouts(); + foreach ($definitions as $code => $path) { + if (array_key_exists($code, $dbLayouts)) { + continue; + } + + self::createLayoutFromFile($code, $path); + } + } + + /** + * Creates a layout using the contents of a specified file. + * @param string $code New Layout code + * @param string $viewPath View path + * @return void + */ + public static function createLayoutFromFile($code, $viewPath) + { + $sections = self::getTemplateSections($viewPath); + + $name = array_get($sections, 'settings.name', '???'); + + $css = 'a, a:hover { + text-decoration: none; + color: #0862A2; + font-weight: bold; + } + + td, tr, th, table { + padding: 0px; + margin: 0px; + } + + p { + margin: 10px 0; + }'; + + self::create([ + 'is_locked' => true, + 'name' => $name, + 'code' => $code, + 'content_css' => $css, + 'content_html' => array_get($sections, 'html'), + 'content_text' => array_get($sections, 'text') + ]); + } + + protected static function getTemplateSections($code) + { + return MailParser::parse(File::get(View::make($code)->getPath())); + } } diff --git a/modules/system/models/MailPartial.php b/modules/system/models/MailPartial.php new file mode 100644 index 000000000..4f0655262 --- /dev/null +++ b/modules/system/models/MailPartial.php @@ -0,0 +1,90 @@ + 'required|unique:system_mail_partials', + 'name' => 'required', + 'content_html' => 'required', + ]; + + /** + * Loops over each mail layout and ensures the system has a layout, + * if the layout does not exist, it will create one. + * @return void + */ + public static function createPartials() + { + $dbPartials = self::lists('code', 'code'); + + $definitions = MailManager::instance()->listRegisteredPartials(); + foreach ($definitions as $code => $path) { + if (array_key_exists($code, $dbPartials)) { + continue; + } + + self::createPartialFromFile($code, $path); + } + } + + /** + * Creates a layout using the contents of a specified file. + * @param string $code New Partial code + * @param string $viewPath View path + * @return void + */ + public static function createPartialFromFile($code, $viewPath) + { + $sections = self::getTemplateSections($viewPath); + + $name = array_get($sections, 'settings.name', '???'); + + self::create([ + 'name' => $name, + 'code' => $code, + 'is_custom' => 0, + 'content_html' => array_get($sections, 'html'), + 'content_text' => array_get($sections, 'text') + ]); + } + + protected static function getTemplateSections($code) + { + return MailParser::parse(File::get(View::make($code)->getPath())); + } +} diff --git a/modules/system/models/MailTemplate.php b/modules/system/models/MailTemplate.php index 6fbdfc038..6f4c96222 100644 --- a/modules/system/models/MailTemplate.php +++ b/modules/system/models/MailTemplate.php @@ -22,6 +22,19 @@ class MailTemplate extends Model */ protected $table = 'system_mail_templates'; + /** + * @var array Guarded fields + */ + protected $guarded = []; + + /** + * @var array Fillable fields + */ + protected $fillable = []; + + /** + * @var array Validation rules + */ public $rules = [ 'code' => 'required|unique:system_mail_templates', 'subject' => 'required', @@ -40,7 +53,7 @@ class MailTemplate extends Model public static function listAllTemplates() { $fileTemplates = (array) MailManager::instance()->listRegisteredTemplates(); - $dbTemplates = (array) self::lists('description', 'code'); + $dbTemplates = (array) self::lists('code', 'code'); $templates = $fileTemplates + $dbTemplates; ksort($templates); return $templates; @@ -52,6 +65,9 @@ class MailTemplate extends Model */ public static function syncAll() { + MailLayout::createLayouts(); + MailPartial::createPartials(); + $templates = MailManager::instance()->listRegisteredTemplates(); $dbTemplates = self::lists('is_custom', 'code'); $newTemplates = array_diff_key($templates, $dbTemplates); @@ -59,8 +75,8 @@ class MailTemplate extends Model /* * Clean up non-customized templates */ - foreach ($dbTemplates as $code => $is_custom) { - if ($is_custom) { + foreach ($dbTemplates as $code => $isCustom) { + if ($isCustom) { continue; } @@ -72,9 +88,10 @@ class MailTemplate extends Model /* * Create new templates */ - foreach ($newTemplates as $code => $description) { + foreach ($newTemplates as $code) { $sections = self::getTemplateSections($code); $layoutCode = array_get($sections, 'settings.layout', 'default'); + $description = array_get($sections, 'settings.description'); $template = self::make(); $template->code = $code; diff --git a/modules/system/models/mailpartial/columns.yaml b/modules/system/models/mailpartial/columns.yaml new file mode 100644 index 000000000..e6e02eb8a --- /dev/null +++ b/modules/system/models/mailpartial/columns.yaml @@ -0,0 +1,13 @@ +# =================================== +# Column Definitions +# =================================== + +columns: + + name: + label: system::lang.mail_templates.name + searchable: true + + code: + label: system::lang.mail_templates.code + searchable: true diff --git a/modules/system/models/mailpartial/fields.yaml b/modules/system/models/mailpartial/fields.yaml new file mode 100644 index 000000000..bea9592cd --- /dev/null +++ b/modules/system/models/mailpartial/fields.yaml @@ -0,0 +1,34 @@ +# =================================== +# Field Definitions +# =================================== + +fields: + + code: + label: system::lang.mail_templates.code + comment: system::lang.mail_templates.code_comment + span: left + context: create + + name@create: + label: system::lang.mail_templates.name + span: right + + name@update: + label: system::lang.mail_templates.name + +secondaryTabs: + fields: + + content_html: + type: codeeditor + size: giant + tab: system::lang.mail_templates.content_html + language: html + stretch: true + + content_text: + type: textarea + size: giant + tab: system::lang.mail_templates.content_text + stretch: true diff --git a/modules/system/twig/MailComponentNode.php b/modules/system/twig/MailComponentNode.php new file mode 100644 index 000000000..82d735567 --- /dev/null +++ b/modules/system/twig/MailComponentNode.php @@ -0,0 +1,51 @@ + $nodes, 'body' => $body], ['names' => $paramNames], $lineno, $tag); + } + + /** + * Compiles the node to PHP. + * + * @param Twig_Compiler $compiler A Twig_Compiler instance + */ + public function compile(Twig_Compiler $compiler) + { + $compiler->addDebugInfo($this); + + $compiler->write("\$context['__system_component_params'] = [];\n"); + + $compiler + ->addDebugInfo($this) + ->write('ob_start();') + ->subcompile($this->getNode('body')) + ->write("\$context['__system_component_params']['body'] = ob_get_clean();"); + + for ($i = 1; $i < count($this->getNode('nodes')); $i++) { + $compiler->write("\$context['__system_component_params']['".$this->getAttribute('names')[$i-1]."'] = "); + $compiler->subcompile($this->getNode('nodes')->getNode($i)); + $compiler->write(";\n"); + } + + $compiler + ->write("echo \System\Classes\MailManager::instance()->renderPartial(") + ->subcompile($this->getNode('nodes')->getNode(0)) + ->write(", \$context['__system_component_params']") + ->write(");\n") + ; + + $compiler->write("unset(\$context['__system_component_params']);\n"); + } +} diff --git a/modules/system/twig/MailComponentTokenParser.php b/modules/system/twig/MailComponentTokenParser.php new file mode 100644 index 000000000..4edd98b07 --- /dev/null +++ b/modules/system/twig/MailComponentTokenParser.php @@ -0,0 +1,82 @@ +getLine(); + $stream = $this->parser->getStream(); + + $name = $this->parser->getExpressionParser()->parseExpression(); + $paramNames = []; + $nodes = [$name]; + + $end = false; + while (!$end) { + $current = $stream->next(); + + switch ($current->getType()) { + case Twig_Token::NAME_TYPE: + $paramNames[] = $current->getValue(); + $stream->expect(Twig_Token::OPERATOR_TYPE, '='); + $nodes[] = $this->parser->getExpressionParser()->parseExpression(); + break; + + case Twig_Token::BLOCK_END_TYPE: + $end = true; + break; + + default: + throw new Twig_Error_Syntax( + sprintf('Invalid syntax in the partial tag. Line %s', $lineno), + $stream->getCurrent()->getLine(), + $stream->getFilename() + ); + break; + } + } + + $body = $this->parser->subparse([$this, 'decideComponentEnd'], true); + $stream->expect(Twig_Token::BLOCK_END_TYPE); + + return new MailComponentNode(new Twig_Node($nodes), $paramNames, $body, $token->getLine(), $this->getTag()); + } + + public function decideComponentEnd(Twig_Token $token) + { + return $token->test('endcomponent'); + } + + /** + * Gets the tag name associated with this token parser. + * + * @return string The tag name + */ + public function getTag() + { + return 'component'; + } +} diff --git a/modules/system/twig/MailPartialNode.php b/modules/system/twig/MailPartialNode.php new file mode 100644 index 000000000..8b95e3f63 --- /dev/null +++ b/modules/system/twig/MailPartialNode.php @@ -0,0 +1,45 @@ + $nodes], ['names' => $paramNames], $lineno, $tag); + } + + /** + * Compiles the node to PHP. + * + * @param Twig_Compiler $compiler A Twig_Compiler instance + */ + public function compile(Twig_Compiler $compiler) + { + $compiler->addDebugInfo($this); + + $compiler->write("\$context['__system_partial_params'] = [];\n"); + + for ($i = 1; $i < count($this->getNode('nodes')); $i++) { + $compiler->write("\$context['__system_partial_params']['".$this->getAttribute('names')[$i-1]."'] = "); + $compiler->subcompile($this->getNode('nodes')->getNode($i)); + $compiler->write(";\n"); + } + + $compiler + ->write("echo \$this->env->getExtension('Cms\Twig\Extension')->partialFunction(") + ->subcompile($this->getNode('nodes')->getNode(0)) + ->write(", \$context['__system_partial_params']") + ->write(");\n") + ; + + $compiler->write("unset(\$context['__system_partial_params']);\n"); + } +} diff --git a/modules/system/twig/MailPartialTokenParser.php b/modules/system/twig/MailPartialTokenParser.php new file mode 100644 index 000000000..2b68c5a10 --- /dev/null +++ b/modules/system/twig/MailPartialTokenParser.php @@ -0,0 +1,74 @@ +getLine(); + $stream = $this->parser->getStream(); + + $name = $this->parser->getExpressionParser()->parseExpression(); + $paramNames = []; + $nodes = [$name]; + + $end = false; + while (!$end) { + $current = $stream->next(); + + switch ($current->getType()) { + case Twig_Token::NAME_TYPE: + $paramNames[] = $current->getValue(); + $stream->expect(Twig_Token::OPERATOR_TYPE, '='); + $nodes[] = $this->parser->getExpressionParser()->parseExpression(); + break; + + case Twig_Token::BLOCK_END_TYPE: + $end = true; + break; + + default: + throw new Twig_Error_Syntax( + sprintf('Invalid syntax in the partial tag. Line %s', $lineno), + $stream->getCurrent()->getLine(), + $stream->getFilename() + ); + break; + } + } + + return new MailPartialNode(new Twig_Node($nodes), $paramNames, $token->getLine(), $this->getTag()); + } + + /** + * Gets the tag name associated with this token parser. + * + * @return string The tag name + */ + public function getTag() + { + return 'partial'; + } +} diff --git a/modules/system/views/mail/button.htm b/modules/system/views/mail/button.htm new file mode 100644 index 000000000..25f41c220 --- /dev/null +++ b/modules/system/views/mail/button.htm @@ -0,0 +1,5 @@ +name = "Button" +== +{{ body|raw }} +== + diff --git a/modules/system/views/mail/default.htm b/modules/system/views/mail/default.htm new file mode 100644 index 000000000..18c35509b --- /dev/null +++ b/modules/system/views/mail/default.htm @@ -0,0 +1,14 @@ +name = "Default layout" +== +{{ content|raw }} +== + + + + + + {{ content|raw }} + + diff --git a/modules/system/views/mail/system.htm b/modules/system/views/mail/system.htm new file mode 100644 index 000000000..a04ed935c --- /dev/null +++ b/modules/system/views/mail/system.htm @@ -0,0 +1,20 @@ +name = "System layout" +== +{{ content|raw }} + + +--- +This is an automatic message. Please do not reply to it. +== + + + + + + {{ content|raw }} +This is an automatic message. Please do not reply to it.
+ + diff --git a/modules/system/views/mail/table.htm b/modules/system/views/mail/table.htm new file mode 100644 index 000000000..4005c84a6 --- /dev/null +++ b/modules/system/views/mail/table.htm @@ -0,0 +1,5 @@ +name = "Table" +== +{{ body|raw }} +== +