Custom Scripts are executed only on the client-side (i.e. in Forms). Here are some examples to get you started
\n\n\n// fetch local_tax_no on selection of customer \n// cur_frm.add_fetch(link_field, source_fieldname, target_fieldname); \ncur_frm.add_fetch('customer', 'local_tax_no', 'local_tax_no');\n\n// additional validation on dates \nfrappe.ui.form.on('Task', 'validate', function(frm) {\n if (frm.doc.from_date < get_today()) {\n msgprint('You can not select past date in From Date');\n validated = false;\n } \n});\n\n// make a field read-only after saving \nfrappe.ui.form.on('Task', {\n refresh: function(frm) {\n // use the __islocal value of doc, to check if the doc is saved or not\n frm.set_df_property('myfield', 'read_only', frm.doc.__islocal ? 0 : 1);\n } \n});\n\n// additional permission check\nfrappe.ui.form.on('Task', {\n validate: function(frm) {\n if(user=='user1@example.com' && frm.doc.purpose!='Material Receipt') {\n msgprint('You are only allowed Material Receipt');\n validated = false;\n }\n } \n});\n\n// calculate sales incentive\nfrappe.ui.form.on('Sales Invoice', {\n validate: function(frm) {\n // calculate incentives for each person on the deal\n total_incentive = 0\n $.each(frm.doc.sales_team, function(i, d) {\n // calculate incentive\n var incentive_percent = 2;\n if(frm.doc.base_grand_total > 400) incentive_percent = 4;\n // actual incentive\n d.incentives = flt(frm.doc.base_grand_total) * incentive_percent / 100;\n total_incentive += flt(d.incentives)\n });\n frm.doc.total_incentive = total_incentive;\n } \n})\n\nCustom Scripts are executed only on the client-side (i.e. in Forms). Here are some examples to get you started
\n\n\n// fetch local_tax_no on selection of customer \n// cur_frm.add_fetch(link_field, source_fieldname, target_fieldname); \ncur_frm.add_fetch('customer', 'local_tax_no', 'local_tax_no');\n\n// additional validation on dates \nfrappe.ui.form.on('Task', 'validate', function(frm) {\n if (frm.doc.from_date < get_today()) {\n msgprint('You can not select past date in From Date');\n validated = false;\n } \n});\n\n// make a field read-only after saving \nfrappe.ui.form.on('Task', {\n refresh: function(frm) {\n // use the __islocal value of doc, to check if the doc is saved or not\n frm.set_df_property('myfield', 'read_only', frm.doc.__islocal ? 0 : 1);\n } \n});\n\n// additional permission check\nfrappe.ui.form.on('Task', {\n validate: function(frm) {\n if(user=='user1@example.com' && frm.doc.purpose!='Material Receipt') {\n msgprint('You are only allowed Material Receipt');\n validated = false;\n }\n } \n});\n\n// calculate sales incentive\nfrappe.ui.form.on('Sales Invoice', {\n validate: function(frm) {\n // calculate incentives for each person on the deal\n total_incentive = 0\n $.each(frm.doc.sales_team, function(i, d) {\n // calculate incentive\n var incentive_percent = 2;\n if(frm.doc.base_grand_total > 400) incentive_percent = 4;\n // actual incentive\n d.incentives = flt(frm.doc.base_grand_total) * incentive_percent / 100;\n total_incentive += flt(d.incentives)\n });\n frm.doc.total_incentive = total_incentive;\n } \n})\n\nlog(text)",
+ "fieldname": "console",
+ "fieldtype": "Code",
+ "label": "Console",
+ "options": "Python"
+ },
+ {
+ "fieldname": "output",
+ "fieldtype": "Code",
+ "label": "Output",
+ "read_only": 1
+ },
+ {
+ "default": "0",
+ "fieldname": "commit",
+ "fieldtype": "Check",
+ "label": "Commit"
+ }
+ ],
+ "hide_toolbar": 1,
+ "index_web_pages_for_search": 1,
+ "issingle": 1,
+ "links": [],
+ "modified": "2020-08-21 14:44:35.296877",
+ "modified_by": "Administrator",
+ "module": "Desk",
+ "name": "System Console",
+ "owner": "Administrator",
+ "permissions": [
+ {
+ "email": 1,
+ "print": 1,
+ "read": 1,
+ "role": "System Manager",
+ "share": 1,
+ "write": 1
+ }
+ ],
+ "quick_entry": 1,
+ "sort_field": "modified",
+ "sort_order": "DESC",
+ "track_changes": 1
+}
diff --git a/frappe/desk/doctype/system_console/system_console.py b/frappe/desk/doctype/system_console/system_console.py
new file mode 100644
index 0000000000..6c87ca8c36
--- /dev/null
+++ b/frappe/desk/doctype/system_console/system_console.py
@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020, Frappe Technologies and contributors
+# For license information, please see license.txt
+
+from __future__ import unicode_literals
+
+import json
+
+import frappe
+from frappe.utils.safe_exec import safe_exec
+from frappe.model.document import Document
+
+class SystemConsole(Document):
+ def run(self):
+ frappe.only_for('System Manager')
+ try:
+ frappe.debug_log = []
+ safe_exec(self.console)
+ self.output = '\n'.join(frappe.debug_log)
+ except: # noqa: E722
+ self.output = frappe.get_traceback()
+
+ if self.commit:
+ frappe.db.commit()
+ else:
+ frappe.db.rollback()
+
+ frappe.get_doc(dict(
+ doctype='Console Log',
+ script=self.console,
+ output=self.output)).insert()
+ frappe.db.commit()
+
+@frappe.whitelist()
+def execute_code(doc):
+ console = frappe.get_doc(json.loads(doc))
+ console.run()
+ return console.as_dict()
\ No newline at end of file
diff --git a/frappe/desk/doctype/system_console/test_system_console.py b/frappe/desk/doctype/system_console/test_system_console.py
new file mode 100644
index 0000000000..55ef199122
--- /dev/null
+++ b/frappe/desk/doctype/system_console/test_system_console.py
@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020, Frappe Technologies and Contributors
+# See license.txt
+from __future__ import unicode_literals
+
+import frappe
+import unittest
+
+class TestSystemConsole(unittest.TestCase):
+ def test_system_console(self):
+ system_console = frappe.get_doc('System Console')
+ system_console.console = 'log("hello")'
+ system_console.run()
+
+ self.assertEqual(system_console.output, 'hello')
+
+ system_console.console = 'log(frappe.db.get_value("DocType", "DocType", "module"))'
+ system_console.run()
+
+ self.assertEqual(system_console.output, 'Core')
diff --git a/frappe/desk/form/meta.py b/frappe/desk/form/meta.py
index ba0e5c2216..c28a40657f 100644
--- a/frappe/desk/form/meta.py
+++ b/frappe/desk/form/meta.py
@@ -130,7 +130,7 @@ class FormMeta(Meta):
def add_custom_script(self):
"""embed all require files"""
# custom script
- custom = frappe.db.get_value("Custom Script", {"dt": self.name}, "script") or ""
+ custom = frappe.db.get_value("Custom Script", {"dt": self.name, "enabled": 1}, "script") or ""
self.set("__custom_js", custom)
diff --git a/frappe/email/doctype/newsletter/newsletter.js b/frappe/email/doctype/newsletter/newsletter.js
index 0f1e8dc57c..3277d8e9ee 100644
--- a/frappe/email/doctype/newsletter/newsletter.js
+++ b/frappe/email/doctype/newsletter/newsletter.js
@@ -14,9 +14,6 @@ frappe.ui.form.on('Newsletter', {
});
}, "fa fa-play", "btn-success");
}
- if (!doc.__islocal && cint(doc.email_sent)) {
- frm.set_df_property('schedule_send', "read_only", 1);
- }
frm.events.setup_dashboard(frm);
diff --git a/frappe/email/doctype/newsletter/newsletter.json b/frappe/email/doctype/newsletter/newsletter.json
index 4804b3d6fa..1dd6115b43 100644
--- a/frappe/email/doctype/newsletter/newsletter.json
+++ b/frappe/email/doctype/newsletter/newsletter.json
@@ -15,7 +15,10 @@
"email_sent",
"newsletter_content",
"subject",
+ "content_type",
"message",
+ "message_md",
+ "message_html",
"send_unsubscribe_link",
"send_attachments",
"published",
@@ -37,8 +40,7 @@
"fieldname": "send_from",
"fieldtype": "Data",
"ignore_xss_filter": 1,
- "label": "Sender",
- "no_copy": 1
+ "label": "Sender"
},
{
"default": "0",
@@ -50,7 +52,8 @@
},
{
"fieldname": "newsletter_content",
- "fieldtype": "Section Break"
+ "fieldtype": "Section Break",
+ "label": "Content"
},
{
"fieldname": "subject",
@@ -61,11 +64,12 @@
"reqd": 1
},
{
+ "depends_on": "eval: doc.content_type === 'Rich Text'",
"fieldname": "message",
"fieldtype": "Text Editor",
"in_list_view": 1,
"label": "Message",
- "reqd": 1
+ "mandatory_depends_on": "eval: doc.content_type === 'Rich Text'"
},
{
"default": "1",
@@ -87,16 +91,20 @@
"read_only": 1
},
{
+ "collapsible": 1,
"fieldname": "test_the_newsletter",
- "fieldtype": "Section Break"
+ "fieldtype": "Section Break",
+ "label": "Testing"
},
{
"description": "A Lead with this Email Address should exist",
"fieldname": "test_email_id",
"fieldtype": "Data",
- "label": "Test Email Address"
+ "label": "Test Email Address",
+ "options": "Email"
},
{
+ "depends_on": "eval: doc.test_email_id",
"fieldname": "test_send",
"fieldtype": "Button",
"label": "Test",
@@ -117,7 +125,8 @@
"depends_on": "eval: doc.schedule_sending",
"fieldname": "schedule_send",
"fieldtype": "Datetime",
- "label": "Schedule Send"
+ "label": "Schedule Send",
+ "read_only_depends_on": "eval: doc.email_sent"
},
{
"default": "0",
@@ -125,11 +134,32 @@
"fieldtype": "Check",
"label": "Send Attachments"
},
+ {
+ "fieldname": "content_type",
+ "fieldtype": "Select",
+ "label": "Content Type",
+ "options": "Rich Text\nMarkdown\nHTML"
+ },
+ {
+ "depends_on": "eval:doc.content_type === 'Markdown'",
+ "fieldname": "message_md",
+ "fieldtype": "Markdown Editor",
+ "label": "Message (Markdown)",
+ "mandatory_depends_on": "eval:doc.content_type === 'Markdown'"
+ },
+ {
+ "depends_on": "eval:doc.content_type === 'HTML'",
+ "fieldname": "message_html",
+ "fieldtype": "HTML Editor",
+ "label": "Message (HTML)",
+ "mandatory_depends_on": "eval:doc.content_type === 'HTML'"
+ },
{
"default": "0",
"fieldname": "schedule_sending",
"fieldtype": "Check",
- "label": "Schedule Sending"
+ "label": "Schedule Sending",
+ "read_only_depends_on": "eval: doc.email_sent"
}
],
"has_web_view": 1,
@@ -139,7 +169,7 @@
"is_published_field": "published",
"links": [],
"max_attachments": 3,
- "modified": "2020-08-17 18:11:59.541686",
+ "modified": "2020-08-24 19:59:37.262500",
"modified_by": "Administrator",
"module": "Email",
"name": "Newsletter",
diff --git a/frappe/email/doctype/newsletter/newsletter.py b/frappe/email/doctype/newsletter/newsletter.py
index 849c21f768..0a0a13a6ce 100755
--- a/frappe/email/doctype/newsletter/newsletter.py
+++ b/frappe/email/doctype/newsletter/newsletter.py
@@ -8,12 +8,9 @@ import frappe.utils
from frappe import throw, _
from frappe.website.website_generator import WebsiteGenerator
from frappe.utils.verified_command import get_signed_params, verify_request
-from frappe.utils.background_jobs import enqueue
from frappe.email.queue import send
from frappe.email.doctype.email_group.email_group import add_subscribers
-from frappe.utils import parse_addr, now_datetime
-from frappe.utils import validate_email_address
-
+from frappe.utils import parse_addr, now_datetime, markdown, validate_email_address
class Newsletter(WebsiteGenerator):
def onload(self):
@@ -29,8 +26,8 @@ class Newsletter(WebsiteGenerator):
def test_send(self, doctype="Lead"):
self.recipients = frappe.utils.split_emails(self.test_email_id)
- self.queue_all()
- frappe.msgprint(_("Scheduled to send to {0}").format(self.test_email_id))
+ self.queue_all(test_email=True)
+ frappe.msgprint(_("Test email sent to {0}").format(self.test_email_id))
def send_emails(self):
"""send emails to leads and customers"""
@@ -40,21 +37,13 @@ class Newsletter(WebsiteGenerator):
self.recipients = self.get_recipients()
if self.recipients:
- if getattr(frappe.local, "is_ajax", False):
- self.validate_send()
- # using default queue with a longer timeout as this isn't a scheduled task
- enqueue(send_newsletter, queue='default', timeout=6000, event='send_newsletter',
- newsletter=self.name)
-
- else:
- self.queue_all()
-
- frappe.msgprint(_("Scheduled to send to {0} recipients").format(len(self.recipients)))
+ self.queue_all()
+ frappe.msgprint(_("Email queued to {0} recipients").format(len(self.recipients)))
else:
frappe.msgprint(_("Newsletter should have atleast one recipient"))
- def queue_all(self):
+ def queue_all(self, test_email=False):
if not self.get("recipients"):
# in case it is called via worker
self.recipients = self.get_recipients()
@@ -80,7 +69,7 @@ class Newsletter(WebsiteGenerator):
frappe.throw(_("Unable to find attachment {0}").format(file.name))
send(recipients=self.recipients, sender=sender,
- subject=self.subject, message=self.message,
+ subject=self.subject, message=self.get_message(),
reference_doctype=self.doctype, reference_name=self.name,
add_unsubscribe_link=self.send_unsubscribe_link, attachments=attachments,
unsubscribe_method="/unsubscribe",
@@ -90,9 +79,18 @@ class Newsletter(WebsiteGenerator):
if not frappe.flags.in_test:
frappe.db.auto_commit_on_many_writes = False
- self.db_set("email_sent", 1)
- self.db_set("schedule_send", now_datetime())
- self.db_set("scheduled_to_send", len(self.recipients))
+ if not test_email:
+ self.db_set("email_sent", 1)
+ self.db_set("schedule_send", now_datetime())
+ self.db_set("scheduled_to_send", len(self.recipients))
+
+ def get_message(self):
+
+ return {
+ 'Rich Text': self.message,
+ 'Markdown': markdown(self.message_md),
+ 'HTML': self.message_html
+ }[self.content_type]
def get_recipients(self):
"""Get recipients from Email Group"""
diff --git a/frappe/email/doctype/newsletter/newsletter_list.js b/frappe/email/doctype/newsletter/newsletter_list.js
index e95d29545d..9ded6148e0 100644
--- a/frappe/email/doctype/newsletter/newsletter_list.js
+++ b/frappe/email/doctype/newsletter/newsletter_list.js
@@ -1,8 +1,10 @@
frappe.listview_settings['Newsletter'] = {
- add_fields: ["subject", "email_sent"],
+ add_fields: ["subject", "email_sent", "schedule_sending"],
get_indicator: function(doc) {
- if(doc.email_sent) {
+ if (doc.email_sent) {
return [__("Sent"), "green", "email_sent,=,Yes"];
+ } else if (doc.schedule_sending) {
+ return [__("Scheduled"), "orange", "email_sent,=,No|schedule_sending,=,Yes"];
} else {
return [__("Not Sent"), "orange", "email_sent,=,No"];
}
diff --git a/frappe/email/doctype/newsletter/test_newsletter.py b/frappe/email/doctype/newsletter/test_newsletter.py
index bb339165d3..ee7f123b7e 100644
--- a/frappe/email/doctype/newsletter/test_newsletter.py
+++ b/frappe/email/doctype/newsletter/test_newsletter.py
@@ -67,6 +67,7 @@ class TestNewsletter(unittest.TestCase):
"doctype": "Newsletter",
"subject": "_Test Newsletter",
"send_from": "Test Sender {{ subtitle }}
+{%- endif -%}