Merge pull request #45 from zfi/master

Version 1.1.4

Author: zfi

.gitignore

@@ -2,6 +2,8 @@
 *.sqlite
 *.log
 venv/
+build.sh
+CloudSession-Pkg.tar.gz
 
 #################
 ## NetBeans
@@ -16,3 +18,11 @@ nbactions.xml
 #################
 
 .idea
+build
+copy-test
+deploy-test
+deploy2coppa
+dbupdate.sh
+/CloudSession-Templates.tar.gz
+/copy-test
+/deploy2coppa

Failures.py

@@ -98,11 +98,17 @@ def screen_name_already_in_use(screen_name):
            }, 500
 
 
-def rate_exceeded():
+def rate_exceeded(time):
+    """
+      Service requested to frequently.
+
+      time - string representing the date and time the service will be available again
+    """
     logging.debug('Failures: Rate exceeded')
     return {
                'success': False,
                'message': 'Insufficient bucket tokens',
+               'data': time,
                'code': 470
            }, 500
 

app/AuthToken/controllers.py

@@ -1,10 +1,9 @@
 # Import the database object from the main app module
-import json
 import logging
 import uuid
 import datetime
-
 import Failures
+
 from app import db
 from app.User import services as user_service
 

app/AuthToken/models.py

@@ -2,7 +2,6 @@
 # We will define this inside /app/__init__.py in the next sections.
 from app import db
 
-
 class AuthenticationToken(db.Model):
     id = db.Column(db.BigInteger, primary_key=True)
     id_user = db.Column(db.BigInteger, db.ForeignKey('user.id'))

app/Authenticate/controllers.py

@@ -1,9 +1,7 @@
 # Import the database object from the main app module
 import logging
-import uuid
-import datetime
-
 import Failures
+
 from app import db
 from app.User import services as user_services
 from app.RateLimiting import services as rate_limiting_services
@@ -66,7 +64,11 @@ def post(self):
             'email': user.email,
             'locale': user.locale,
             'screenname': user.screen_name,
-            'authentication-source': user.auth_source
+            'authentication-source': user.auth_source,
+            'bdmonth': user.birth_month,
+            'bdyear': user.birth_year,
+            'parent-email': user.parent_email,
+            'parent-email-source': user.parent_email_source
         }}
 
 api.add_resource(AuthenticateLocalUser, '/local')

app/Email/services.py

@@ -1,74 +1,217 @@
-from app import mail, app, db
-
+from app import mail, app
 from os.path import expanduser, isfile
-
-from flask.ext.mail import Message
+from flask_mail import Message
+from app.User.coppa import Coppa, SponsorType
 
 import pystache
 import logging
 
 
+"""
+TODO: System documentation goes here
+"""
+
+
 def send_email_template_for_user(id_user, template, server, **kwargs):
     from app.User.services import get_user
 
-    logging.info("Sending email to user: %s (%s)", id_user, template)
+    # Get a copy of the user record
+    logging.info("Checking for a valid user record for user ID: %s", id_user)
+    user = get_user(id_user)
+
+    if user is None:
+        logging.error("Cannot send email: Invalid user record")
+        return False
+    else:
+        logging.info("Valid record found for user: %s", user.id)
+
+    logging.info("Sending email to user: %s using template: '%s'.", user.email, template)
 
     params = {}
     for key, value in kwargs.items():
+        logging.debug("Logging parameter %s = %s", key, value)
         params[key] = value
 
-    user = get_user(id_user)
-    if user is None:
-        return False
-
+    # The elements in the params array represent the data elements that are
+    # available to the email templates.
     params['screenname'] = user.screen_name
+    params['email'] = user.email
+    params['registrant-email'] = user.email
+    params['sponsoremail'] = user.parent_email
+    params['blocklyprop-host'] = app.config['CLOUD_SESSION_PROPERTIES']['response.host']
+
+    # Default the recipient email address
+    user_email = user.email
+    coppa = Coppa()
+
+    # Send email to parent if user is under 13 years old
+    if template == 'confirm' and coppa.is_coppa_covered(user.birth_month, user.birth_year):
+        # Send email only to the sponsor address
+        user_email = user.parent_email
+        logging.info("COPPA account has a sponsor type of %s", user.parent_email_source)
+
+        if user.parent_email_source == SponsorType.TEACHER:
+            # Teacher handles the account confirmation
+            send_email_template_to_address(user_email, 'confirm-teacher', server, user.locale, params)
+        elif user.parent_email_source == SponsorType.PARENT or\
+                        user.parent_email_source == SponsorType.GUARDIAN:
+            # Parent handles the account confirmation
+            send_email_template_to_address(user_email, 'confirm-parent', server, user.locale, params)
+        else:
+            logging.info("COPPA account %s has invalid sponsor type [%s]", user.id, user.parent_email_source)
+
+        return
+    elif template == 'reset' and coppa.is_coppa_covered(user.birth_month, user.birth_year):
+        # Send email only to the sponsor address
+        logging.info("COPPA account has a sponsor type of %s", user.parent_email_source)
+
+        # Send password reset to student and parent
+        send_email_template_to_address(user.email, 'reset-coppa', server, user.locale, params)
+        send_email_template_to_address(user.parent_email, 'reset-coppa', server, user.locale, params)
+        return
+    else:
+        # Registration not subject to COPPA regulations.
+        #
+        # Evaluate user wanting to use an alternate email address to register
+        # the account.
+        logging.info('Non-COPPA registration')
+        if user.parent_email_source == SponsorType.INDIVIDUAL and user.parent_email:
+            user_email = user.parent_email
+            logging.info('Individual sponsor email %s being used', user_email)
+
+        if user.parent_email:
+            user_email = user.parent_email
+            logging.info('Sponsor email %s being used', user_email)
 
-    send_email_template_to_address(user.email, template, server, user.locale, params)
+        send_email_template_to_address(user_email, template, server, user.locale, params)
+
+    return
 
 
 def send_email_template_to_address(recipient, template, server, locale, params=None, **kwargs):
-    # Read templates
+    logging.info("Preparing email template: %s for %s", template, recipient)
     params = params or {}
+
+    # Add any supplied arguments to the parameter dictionary
     for key, value in kwargs.items():
         params[key] = value
+
     params['email'] = recipient
     params['locale'] = locale
 
+    # Create a URI-friendly version of the email addresses
+    params['email-uri'] = _convert_email_uri(params['email'])
+    logging.info("Email address %s converted to %s",
+                 params['email'],
+                 params['email-uri']
+                 )
+
+    params['registrant-email-uri'] = _convert_email_uri(params['registrant-email'])
+    logging.info("Registrant email address %s converted to %s",
+                 params['registrant-email'],
+                 params['registrant-email-uri']
+                 )
+
+    params['sponsor-email-uri'] = _convert_email_uri(params['sponsoremail'])
+    logging.info("Sponsor email address %s converted to %s",
+                 params['sponsoremail'],
+                 params['sponsor-email-uri']
+                 )
+
+    # Read templates
     (subject, plain, rich) = _read_templates(template, server, locale, params)
+    # Add error checking here to detect any issues with parsing the template.
 
+    logging.info("Sending email to %s", params['email'])
     send_email(recipient, subject, plain, rich)
 
 
 def send_email(recipient, subject, email_text, rich_email_text=None):
+    logging.info('Creating email message package')
     msg = Message(
         recipients=[recipient],
         subject=subject.rstrip(),
         body=email_text,
         html=rich_email_text,
         sender=app.config['DEFAULT_MAIL_SENDER']
     )
-    mail.send(msg)
+
+    # Attempt to send the email
+    try:
+        logging.info('Sending email message to server')
+        mail.send(msg)
+    except Exception as ex:
+        logging.error('Unable to send email')
+        logging.error('Error message: %s', ex.message)
+        return 1
+
+    logging.info('Email message was delivered to server')
+    return 0
 
 
 def _read_templates(template, server, locale, params):
+    logging.info("Loading header text for template: %s", template)
     header = _read_template(template, server, locale, 'header', params)
+
+    logging.info("Loading plain message text for template: %s", template)
     plain = _read_template(template, server, locale, 'plain', params)
+
+    logging.info("Loading rich message text for template: %s", template)
     rich = _read_template(template, server, locale, 'rich', params, True)
 
     return header, plain, rich
 
 
 def _read_template(template, server, locale, part, params, none_if_missing=False):
+    """
+    Render a mustache template.
+
+    :param template: Base template name
+    :param server: Host server
+    :param locale: Language designator
+    :param part: Generic message type descriptor
+    :param params: Text string to replace tags embedded within the template
+    :param none_if_missing: Return 'none' if the requested template is not found
+
+    :return: Upon success, return a Renderer object. Return none or a general
+             error message if the none_is_missing flag is false
+    """
     template_file = expanduser("~/templates/%s/%s/%s/%s.mustache" % (locale, template, server, part))
+
     if isfile(template_file):
         logging.debug('Looking for template file: %s', template_file)
+
         renderer = pystache.Renderer()
-        rendered = renderer.render_path(template_file, params)
-        #print(rendered)
+
+        logging.debug('Rendering the template file')
+        try:
+            rendered = renderer.render_path(template_file, params)
+        except Exception as ex:
+            logging.error('Unable to render template file %s', template_file)
+            logging.error('Error message: %s', ex.message)
+            return 'Template format error.'
+
+        logging.debug('Returning rendered template file.')
         return rendered
     else:
-        logging.error('Looking for template file: %s, but the file is missing', template_file)
+        logging.warn('Looking for template file: %s, but the file is missing', template_file)
         if none_if_missing:
             return None
         else:
             return 'Template missing'
+
+
+def _convert_email_uri(email):
+    """
+    Evaluate email address and replace any plus signs that may appear in the
+    portion of the address prior to the '@' with the literal '%2B'.
+
+    Standard web servers will convert any plus ('+') symbol to a space (' ')
+    anywhere where they may appear in the URL. This will allow functions upstream
+    to create a URI that contains an email address that, when submitted to a
+    server, will not be replaced with a space character.
+    """
+    if "+" in email:
+        return email.replace("+", "%2B")
+    else:
+        return email