Issue 2234 - Add a WSGI controller to collect email addresses for the Adblock Browser iOS launch

sitescripts/submit_email/web/submit_email.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2015 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
 import fcntl
 import hmac
 import hashlib
 import wsgiref.util
-from urlparse import parse_qs, urljoin
-from urllib import urlencode
+from urlparse import parse_qsl, urljoin
+from urllib import urlencode, quote
 
 from sitescripts.utils import get_config, sendMail, encode_email_address
 from sitescripts.web import url_handler, form_handler, send_simple_response
 
 VERIFICATION_PATH = '/verifyEmail'
 
 def sign(config, data):
   secret = config.get('submit_email', 'secret')
   return hmac.new(secret, data, hashlib.sha1).hexdigest()
 
 @url_handler('/submitEmail')
 @form_handler
 def submit_email(environ, start_response, data):
   email = data.get('email', '').strip()
   try:
     email = encode_email_address(email)
   except ValueError:
-    return send_simple_response(start_response, 400, 'Please enter a valid email address.')

[Wladimir Palant, 2015/04/24 22:50:48]

Nit: Move the last parameter to the next line?

+    return send_simple_response(
+      start_response, 400,
+      'Please enter a valid email address.'
+    )
 
   config = get_config()
+  params = [('email', email), ('signature', sign(config, email))]
+  lang = data.get('lang')
+  if lang:
+    params.append(('lang', lang))
+
   sendMail(
     config.get('submit_email', 'verification_email_template'),
     {
       'recipient': email,
       'verification_url': '%s?%s' % (
         urljoin(wsgiref.util.application_uri(environ), VERIFICATION_PATH),
-        urlencode([('email', email), ('signature', sign(config, email))])
+        urlencode(params)
       )
     }
   )
 
-  return send_simple_response(start_response, 200, 'A confirmation email has '
-                                                   'been sent. Please check '
-                                                   'your email and click the '
-                                                   'confirmation link.')

[Wladimir Palant, 2015/04/24 22:50:48]

Nit: Move the last parameter to the next line and add two additional indentation
levels? That's better than trying to squeeze it into whatever space you have
left in the line.

[Sebastian Noack, 2015/04/27 13:39:10]

I actually like it as it is. I certainly dislike starting arguments on lines
with different level of indentation. But well, then lets put all arguments on
intended lines below.

+  return send_simple_response(
+    start_response, 200,
+    'A confirmation email has been sent. Please check '
+    'your email and click the confirmation link.'
+  )
 
 @url_handler(VERIFICATION_PATH)
 def verify_email(environ, start_response):
   config = get_config()
+  params = dict(parse_qsl(environ.get('QUERY_STRING', '')))
 
-  params = parse_qs(environ.get('QUERY_STRING', ''))
-  email = params.get('email', [''])[0]
-  signature = params.get('signature', [''])[0]
-
+  email = params.get('email', '')
+  signature = params.get('signature', '')
   if sign(config, email) != signature:
-    return send_simple_response(start_response, 403, 'Invalid signature in '
-                                                     'verification request.')
+    return send_simple_response(
+      start_response, 403,
+      'Invalid signature in verification request.'
+    )
 
   filename = config.get('submit_email', 'filename')
   with open(filename, 'ab', 0) as file:
     fcntl.lockf(file, fcntl.LOCK_EX)
     try:
       print >>file, email
     finally:
       fcntl.lockf(file, fcntl.LOCK_UN)
 
   location = config.get('submit_email', 'successful_verification_redirect_location')
+  location = location.format(lang=quote(params.get('lang') or 'en', ''))

[kzar, 2015/04/28 11:13:42]

Looks like a typo at the end there? ", ''"

[Sebastian Noack, 2015/04/28 11:31:25]

The empty string at the end is the second argument to quote() to make it escape
backslashes as well.

[kzar, 2015/04/28 11:33:41]

Oh I see.

[Sebastian Noack, 2015/04/28 11:36:04]

I meant (forward) slashes.

   start_response('303 See Other', [('Location', location)])
   return []