Changeset 7358 for main/waeup.sirp/trunk/src/waeup

Timestamp:

16 Dec 2011, 07:13:28 (13 years ago)

Author:

Henrik Bettermann

Message:

Seat up a global utility class to ease customization. Transform send_mail function into a utility method.

Location:

main/waeup.sirp/trunk/src/waeup/sirp

Files:

• browser/pages.py (modified) (5 diffs)
• interfaces.py (modified) (1 diff)
• students/browser.py (modified) (3 diffs)
• students/utils.py (modified) (1 diff)
• utils/helpers.py (modified) (1 diff)
• utils/utils.py (added)

main/waeup.sirp/trunk/src/waeup/sirp/browser/pages.py

@@ -50 +50 @@
     ILocalRolesAssignable, DuplicationError, IConfigurationContainer,
     ISessionConfiguration, ISessionConfigurationAdd,
-    IPasswordValidator, IContactForm)
+    IPasswordValidator, IContactForm, ISIRPUtils)
 from waeup.sirp.permissions import get_users_with_local_roles, get_all_roles
 from waeup.sirp.students.catalog import search as searchstudents
@@ -58 +58 @@
 from waeup.sirp.widgets.restwidget import ReSTDisplayWidget
 from waeup.sirp.authentication import get_principal_role_manager
-from waeup.sirp.utils.helpers import get_user_account, send_mail
+from waeup.sirp.utils.helpers import get_user_account
 from waeup.sirp.browser.layout import jsaction, JSAction
 
@@ -228 +228 @@
         email_to = self.config.email_admin
         subject = self.config.email_subject
-        success = send_mail(fullname,username,usertype,self.config.name,
-                  body,email_from,email_to,subject)
+        sirp_utils = getUtility(ISIRPUtils)
+        success = sirp_utils.sendMail(fullname,username,usertype,
+                  self.config.name,body,email_from,email_to,subject)
         if success:
             self.flash('Your message has been sent.')
@@ -252 +253 @@
         subject = self.config.email_subject
         usertype = u'Anonymous'
-        success = send_mail(fullname,username,usertype,self.config.name,
-                  body,email_from,email_to,subject)
+        sirp_utils = getUtility(ISIRPUtils)
+        success = sirp_utils.sendMail(fullname,username,usertype,
+                  self.config.name,body,email_from,email_to,subject)
         if success:
             self.flash('Your message has been sent.')
@@ -476 +478 @@
         email_to = self.context.email
         subject = self.config.email_subject
-        success = send_mail(fullname,username,usertype,self.config.name,
-                  body,email_from,email_to,subject)
+        sirp_utils = getUtility(ISIRPUtils)
+        success = sirp_utils.sendMail(fullname,username,usertype,
+                  self.config.name,body,email_from,email_to,subject)
         if success:
             self.flash('Your message has been sent.')

main/waeup.sirp/trunk/src/waeup/sirp/interfaces.py

@@ -140 +140 @@
         return value
 
+class ISIRPUtils(Interface):
+    """A collection of methods which are subject to customization.
+    """
+    def sendMail(fullname,username,usertype,portal,body,email_from,email_to,subject):
+        """Send an email with data provided by forms.
+        """
+
 class ISIRPObject(Interface):
     """A SIRP object.

main/waeup.sirp/trunk/src/waeup/sirp/students/browser.py

@@ -40 +40 @@
 from waeup.sirp.browser.layout import jsaction, JSAction
 from waeup.sirp.interfaces import (
-    ISIRPObject, IUserAccount, IExtFileStore, IPasswordValidator, IContactForm)
+    ISIRPObject, IUserAccount, IExtFileStore, IPasswordValidator, IContactForm,
+    ISIRPUtils)
 from waeup.sirp.widgets.datewidget import (
     FriendlyDateWidget, FriendlyDateDisplayWidget,
@@ -60 +61 @@
 from waeup.sirp.applicants.interfaces import IApplicantBaseData
 from waeup.sirp.hostels.hostel import NOT_OCCUPIED
-from waeup.sirp.utils.helpers import send_mail
 
 def write_log_message(view, message):
@@ -393 +393 @@
         subject = data['subject']
         email_to = self.context.email
-        success = send_mail(fullname,username,usertype,self.config.name,
+        sirp_utils = getUtility(ISIRPUtils)
+        success = sirp_utils.sendMail(fullname,username,usertype,self.config.name,
                   body,email_from,email_to,subject)
         if success:

main/waeup.sirp/trunk/src/waeup/sirp/students/utils.py

@@ -16 +16 @@
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ##
-"""General helper functions for the student section.
+"""General helper functions and utilities for the student section.
 """
 import grok

main/waeup.sirp/trunk/src/waeup/sirp/utils/helpers.py

@@ -480 +480 @@
     account = authenticator.getAccount(principal_id)
     return account
-
-def send_mail(fullname,username,usertype,portal,body,email_from,email_to,subject):
-    """Send an email with data provided by forms.
-    """
-    config = grok.getSite()['configuration']
-    text = """Fullname: %s
-User Id: %s
-User Type: %s
-Portal: %s
-
-%s
-"""
-    msg = MIMEText(text % (fullname,username,usertype,portal,body))
-    msg['From'] = '%s <%s>' % (fullname,email_from)
-    msg['To'] = email_to
-    msg['Subject'] = subject
-    server = smtplib.SMTP(config.smtp_server)
-    if config.smtp_requires_login:
-        server.login(config.smtp_username,config.smtp_password)
-    try:
-        server.sendmail(email_from,email_to,msg.as_string())
-    except:
-        return False
-    server.quit()
-    return True