Hello,
+ A new post has been published on the {{ object.name }} blog:
+ {{ ctx.get('blog_post').name }}
+ Read the full post
+
+ Hello,
+ A new post has been published on the Blog blog you are following:
+
+
+ By
+ Thank you for following our blog!
+
+
Hello,
+ A new post has been published on the {{ object.name }} blog:
+ {{ ctx.get('blog_post').name }}
+ Read the full post
+
This module extends the website blog functionality by allowing you to +configure custom email templates for new blog post notifications.
+This module requires:
+Table of contents
+This module does not require additional configuration after +installation. It works automatically once installed.
+Make sure the following modules are installed:
+The system will automatically install the necessary dependencies during +installation.
+After installation, a default custom template is available:
+You can use this template as-is, customize it, or create new templates +based on it.
+The module uses the same access permissions as the base modules:
+No additional permission configuration is required.
+Template Requirements:
+Recommended Template Structure:
+This guide explains how to use the Website Blog Email Template module to +configure custom email notifications for new blog posts.
+Step 1: Access Blog Settings
+Step 2: Select or Create Email Template
+Step 3: Create a New Template (if needed)
+Step 4: Save the Blog Configuration
+When creating or editing a template, you can use the following context +variables:
+Blog Information:
+Post Information (via context):
+Example Template Body:
++<div style="margin: 0px; padding: 0px; font-size: 13px;"> + <p>Hello,<br/><br/> + A new post has been published on the <strong>{{ object.name }}</strong> blog:<br/><br/> + <strong>{{ ctx.get('blog_post').name }}</strong><br/><br/> + <a href="{{ ctx.get('blog_post').website_url }}">Read the full post</a> + </p> +</div> ++
Template Selection Logic
+When a new blog post is published:
+Notification Recipients
+Example 1: Simple Custom Template
+Example 2: Branded Template
+Example 3: Multi-language Support
+Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.
+Do not contact contributors directly about support or help with technical issues.
+This module is maintained by the OCA.
+ +
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.
+Current maintainer:
+
This module is part of the OCA/website project on GitHub.
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
+New post {{ ctx.get('blog_post').name }} " "published!
" + ), + } + ) + + def test_blog_post_publication_without_template(self): + """Test that default template is used when no custom template is configured""" + blog = self.test_blog + blog.mail_template_id = False + + # Subscribe users to the blog + blog.message_subscribe( + [self.user_employee.partner_id.id, self.user_public.partner_id.id] + ) + + # Create a new post + post = ( + self.env["blog.post"] + .with_user(self.user_blogmanager) + .create( + { + "name": "Test Post Without Template", + "blog_id": blog.id, + "content": "Test content
", + } + ) + ) + + # Mock message_post_with_view to verify it's called + with patch.object( + type(blog), "message_post_with_view" + ) as mock_message_post_with_view: + # Publish the post + post.write({"website_published": True}) + + # Verify message_post_with_view was called with default template + mock_message_post_with_view.assert_called_once() + call_args = mock_message_post_with_view.call_args + self.assertEqual( + call_args[0][0], "website_blog.blog_post_template_new_post" + ) + self.assertEqual(call_args[1]["subject"], "Test Post Without Template") + self.assertIn("post", call_args[1]["values"]) + self.assertEqual(call_args[1]["values"]["post"], post) + + def test_blog_post_publication_with_template(self): + """Test that custom template is used when configured""" + blog = self.test_blog + blog.mail_template_id = self.mail_template + + # Subscribe users to the blog + blog.message_subscribe( + [self.user_employee.partner_id.id, self.user_public.partner_id.id] + ) + + # Create a new post + post = ( + self.env["blog.post"] + .with_user(self.user_blogmanager) + .create( + { + "name": "Test Post With Template", + "blog_id": blog.id, + "content": "Test content
", + } + ) + ) + + # Mock message_post_with_template to verify it's called + with patch.object( + type(blog), "message_post_with_template" + ) as mock_message_post_with_template: + # Publish the post + post.write({"website_published": True}) + + # Verify message_post_with_template was called with custom template + mock_message_post_with_template.assert_called_once() + call_args = mock_message_post_with_template.call_args + self.assertEqual(call_args[0][0], self.mail_template.id) + self.assertEqual(call_args[1]["subject"], "Test Post With Template") + self.assertEqual( + call_args[1]["email_layout_xmlid"], "mail.mail_notification_light" + ) + + def test_blog_post_publication_context(self): + """Test that blog post is passed in context when using custom template""" + blog = self.test_blog + blog.mail_template_id = self.mail_template + + # Subscribe users to the blog + blog.message_subscribe( + [self.user_employee.partner_id.id, self.user_public.partner_id.id] + ) + + # Create a new post + post = ( + self.env["blog.post"] + .with_user(self.user_blogmanager) + .create( + { + "name": "Test Post Context", + "blog_id": blog.id, + "content": "Test content
", + } + ) + ) + + # Track context passed to message_post_with_template + captured_context = {} + + # Store original method + original_message_post_with_template = type(blog).message_post_with_template + + def mock_message_post_with_template(self, *args, **kwargs): + # Capture context from the recordset that calls the method + # (self is the recordset returned by with_context) + captured_context["context"] = self.env.context + # Call original method + return original_message_post_with_template(self, *args, **kwargs) + + # Patch message_post_with_template to capture context + with patch.object( + type(blog), "message_post_with_template", mock_message_post_with_template + ): + # Publish the post + post.write({"website_published": True}) + + # Verify context contains blog_post + self.assertIn("blog_post", captured_context["context"]) + self.assertIn("blog_post_id", captured_context["context"]) + self.assertEqual(captured_context["context"]["blog_post"], post) + self.assertEqual(captured_context["context"]["blog_post_id"], post.id) + + def test_blog_post_publication_message_creation(self): + """Test that messages are actually created when publishing posts""" + blog = self.test_blog + blog.mail_template_id = False + + # Subscribe users to the blog + blog.message_subscribe( + [self.user_employee.partner_id.id, self.user_public.partner_id.id] + ) + + # Count initial messages + initial_message_count = len(blog.message_ids) + + # Create and publish a post + post = ( + self.env["blog.post"] + .with_user(self.user_blogmanager) + .create( + { + "name": "Test Post Message", + "blog_id": blog.id, + "content": "Test content
", + } + ) + ) + post.write({"website_published": True}) + + # Verify a new message was created + self.assertEqual(len(blog.message_ids), initial_message_count + 1) + + # Verify the message has the correct subtype + publish_message = blog.message_ids.filtered( + lambda m: m.subtype_id + == self.env.ref("website_blog.mt_blog_blog_published") + ) + self.assertTrue(publish_message, "Publish message should be created") + + # Verify followers are notified + self.assertIn( + self.user_employee.partner_id, + publish_message.notified_partner_ids, + "Blog followers should be notified", + ) + + def test_blog_post_publication_with_template_message_creation(self): + """Test that messages are created when using custom template""" + blog = self.test_blog + blog.mail_template_id = self.mail_template + + # Subscribe users to the blog + blog.message_subscribe( + [self.user_employee.partner_id.id, self.user_public.partner_id.id] + ) + + # Count initial messages + initial_message_count = len(blog.message_ids) + + # Create and publish a post + post = ( + self.env["blog.post"] + .with_user(self.user_blogmanager) + .create( + { + "name": "Test Post Custom Template", + "blog_id": blog.id, + "content": "Test content
", + } + ) + ) + post.write({"website_published": True}) + + # Verify a new message was created + self.assertEqual(len(blog.message_ids), initial_message_count + 1) + + # Verify the message has the correct subtype + publish_message = blog.message_ids.filtered( + lambda m: m.subtype_id + == self.env.ref("website_blog.mt_blog_blog_published") + ) + self.assertTrue(publish_message, "Publish message should be created") + + # Verify followers are notified + self.assertIn( + self.user_employee.partner_id, + publish_message.notified_partner_ids, + "Blog followers should be notified", + ) + + def test_blog_post_unpublish_no_notification(self): + """Test that unpublishing a post doesn't trigger notification""" + blog = self.test_blog + blog.mail_template_id = False + + # Subscribe users to the blog + blog.message_subscribe( + [self.user_employee.partner_id.id, self.user_public.partner_id.id] + ) + + # Create and publish a post + post = ( + self.env["blog.post"] + .with_user(self.user_blogmanager) + .create( + { + "name": "Test Post Unpublish", + "blog_id": blog.id, + "content": "Test content
", + } + ) + ) + post.write({"website_published": True}) + + # Count messages after publishing + messages_after_publish = len(blog.message_ids) + + # Unpublish the post + post.write({"website_published": False}) + + # Verify no new message was created + self.assertEqual(len(blog.message_ids), messages_after_publish) diff --git a/website_blog_email_template/views/website_blog_views.xml b/website_blog_email_template/views/website_blog_views.xml new file mode 100644 index 0000000000..80de488a7e --- /dev/null +++ b/website_blog_email_template/views/website_blog_views.xml @@ -0,0 +1,19 @@ + + +