Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: sitescripts/formmail/web/formmail2.py

Issue 29374647: Issue 4814 - Adds csv log to formmail2 (Closed) Base URL: https://hg.adblockplus.org/sitescripts
Patch Set: adds error logging and tests Created Feb. 13, 2017, 10:22 a.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
OLDNEW
1 # This file is part of the Adblock Plus web scripts, 1 # This file is part of the Adblock Plus web scripts,
2 # Copyright (C) 2006-2016 Eyeo GmbH 2 # Copyright (C) 2006-2016 Eyeo GmbH
3 # 3 #
4 # Adblock Plus is free software: you can redistribute it and/or modify 4 # Adblock Plus is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License version 3 as 5 # it under the terms of the GNU General Public License version 3 as
6 # published by the Free Software Foundation. 6 # published by the Free Software Foundation.
7 # 7 #
8 # Adblock Plus is distributed in the hope that it will be useful, 8 # Adblock Plus is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of 9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details. 11 # GNU General Public License for more details.
12 # 12 #
13 # You should have received a copy of the GNU General Public License 13 # You should have received a copy of the GNU General Public License
14 # along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. 14 # along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>.
15 15 import os
16 import datetime 16 import datetime
17 import collections 17 import collections
18 18
19 from csv import DictWriter, DictReader
19 from sitescripts.utils import get_config, sendMail, encode_email_address 20 from sitescripts.utils import get_config, sendMail, encode_email_address
20 from sitescripts.web import registerUrlHandler, form_handler 21 from sitescripts.web import registerUrlHandler, form_handler
21 22
22 23
23 def get_config_items(): 24 def get_config_items():
24 config = get_config() 25 config = get_config()
25 default_keys = set(config.defaults()) 26 default_keys = set(config.defaults())
26 for name, value in config.items('formmail2'): 27 for name, value in config.items('formmail2'):
27 if name not in default_keys: 28 if name not in default_keys:
28 yield name, value 29 yield name, value
(...skipping 16 matching lines...) Expand all
45 store_value(conf_dict, path, value) 46 store_value(conf_dict, path, value)
46 return conf_dict 47 return conf_dict
47 48
48 49
49 def make_error(spec, check_type, default_message): 50 def make_error(spec, check_type, default_message):
50 if check_type in spec: 51 if check_type in spec:
51 return spec[check_type].value 52 return spec[check_type].value
52 return default_message 53 return default_message
53 54
54 55
56 def formfield_error(parameters, log_path):
57 err_file = os.path.basename(log_path) + '_error'
58 err_path = os.path.join(os.path.dirname(log_path), err_file)
59 if os.path.isfile(err_path):
60 with open(err_path, 'a') as error_log:
61 writer = DictWriter(error_log, fieldnames=parameters.keys())
62 writer.writerow(parameters)
63 raise Exception(
64 'Field names have changed, error log appended to ' + err_path)
65 with open(err_path, 'w') as error_log:
66 writer = DictWriter(error_log, fieldnames=parameters.keys())
67 writer.writeheader()
68 writer.writerow(parameters)
69 raise Exception(
70 'Field names have changed, error log written to ' + err_path)
71
72
73 def collect_formdata(params, path):
74 if os.path.isfile(path):
75 with open(path, 'ab+') as formlog:
76 reader = DictReader(formlog)
77 if reader.fieldnames != params.keys():
78 formfield_error(params, path)
79 writer = DictWriter(formlog, fieldnames=params.keys())
80 writer.writerow(params)
81 return
82 with open(path, 'w') as new_formlog:
83 writer = DictWriter(new_formlog, fieldnames=params.keys())
84 writer.writeheader()
85 writer.writerow(params)
86 return
87
88
89 def validate_fields(fields, params):
90 errors = []
91 for field, spec in fields.items():
92 if 'mandatory' in spec.value:
93 if field not in params.keys():
94 errors.append(make_error(spec, 'mandatory',
95 'No {} entered'.format(field)))
96 if 'email' in spec.value and field in params.keys():
97 try:
98 params[field] = encode_email_address(params[field])
99 except ValueError:
100 errors.append(make_error(spec, 'email', 'Invalid email'))
101 return errors
102
103
55 def make_handler(name, config): 104 def make_handler(name, config):
56 try: 105 try:
106 log_path = config['csv_log'].value
107 except KeyError:
108 raise Exception('No log configured for form handler: ' + name)
109 try:
57 url = config['url'].value 110 url = config['url'].value
58 except (KeyError, AttributeError): 111 except (KeyError, AttributeError):
59 raise Exception('No URL configured for form handler:' + name) 112 raise Exception('No URL configured for form handler:' + name)
60 try: 113 try:
61 template = config['template'].value 114 template = config['template'].value
62 except (KeyError, AttributeError): 115 except KeyError:
63 raise Exception('No template configured for form handler:' + name) 116 template = None
64 try: 117 try:
65 fields = config['fields'] 118 fields = config['fields']
66 for field, spec in fields.items(): 119 for field, spec in fields.items():
67 spec.value = {s.strip() for s in spec.value.split(',')} 120 spec.value = {s.strip() for s in spec.value.split(',')}
68 except KeyError: 121 except KeyError:
69 raise Exception('No fields configured for form handler:' + name) 122 raise Exception('No fields configured for form handler:' + name)
70 if len(fields) == 0: 123 if len(fields) == 0:
71 raise Exception('No fields configured for form handler:' + name) 124 raise Exception('No fields configured for form handler:' + name)
72 125
73 @form_handler 126 @form_handler
74 def handler(environ, start_response, params): 127 def handler(environ, start_response, params):
75 response_headers = [('Content-Type', 'text/plain; charset=utf-8')] 128 response_headers = [('Content-Type', 'text/plain; charset=utf-8')]
76 errors = [] 129 errors = validate_fields(fields, params)
77 for field, spec in fields.items():
78 if 'mandatory' in spec.value:
79 if field not in params.keys():
80 errors.append(make_error(spec, 'mandatory',
81 'No {} entered'.format(field)))
82 if 'email' in spec.value and field in params.keys():
83 try:
84 params[field] = encode_email_address(params[field])
85 except ValueError:
86 errors.append(make_error(spec, 'email', 'Invalid email'))
87 if errors: 130 if errors:
88 start_response('400 Bad Request', response_headers) 131 start_response('400 Bad Request', response_headers)
89 return '\n'.join(errors) 132 return '\n'.join(errors)
90 133 params['time'] = datetime.datetime.now()
91 template_args = { 134 if template is not None:
92 'time': datetime.datetime.now(), 135 template_args = {
93 'fields': {field: params.get(field, '') for field in fields} 136 'time': params['time'],
94 } 137 'fields': {field: params.get(field, '') for field in fields}
95 sendMail(template, template_args) 138 }
139 sendMail(template, template_args)
140 collect_formdata(params, log_path)
96 start_response('200 OK', response_headers) 141 start_response('200 OK', response_headers)
97 return '' 142 return ''
98 143
99 return url, handler 144 return url, handler
100 145
101 146
102 conf_dict = conf_parse(get_config_items()) 147 conf_dict = conf_parse(get_config_items())
103 for name, config in conf_dict.items(): 148 for name, config in conf_dict.items():
104 url, handler = make_handler(name, config) 149 url, handler = make_handler(name, config)
105 registerUrlHandler(url, handler) 150 registerUrlHandler(url, handler)
OLDNEW
« sitescripts/formmail/test/test_formmail2.py ('K') | « sitescripts/formmail/test/test_formmail2.py ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld