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: address comments, now encodes user input to utf8 Created Feb. 28, 2017, 4 p.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 from csv import DictWriter, DictReader
18 19
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:
(...skipping 17 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('Field names have changed, error log '
64 '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('Field names have changed, error log '
70 'written to ' + err_path)
71
72
73 def collect_formdata(params, path):
Vasily Kuznetsov 2017/02/28 18:38:49 This function is basically adding the form data to
Jon Sonesen 2017/03/07 12:11:24 I agree
74 if os.path.isfile(path):
75 with open(path, 'ab+') as formlog:
76 formlog.seek(0)
77 reader = DictReader(formlog)
78 if reader.fieldnames != params.keys():
79 formfield_error(params, path)
80 formlog.seek(os.SEEK_END)
81 writer = DictWriter(formlog, fieldnames=params.keys())
82 writer.writerow(params)
83 return
84 with open(path, 'w') as new_formlog:
85 writer = DictWriter(new_formlog, fieldnames=params.keys())
86 writer.writeheader()
87 writer.writerow(params)
88 return
89
90
91 def validate_fields(fields, params):
92 errors = []
93 for field, spec in fields.items():
94 if 'mandatory' in spec.value:
95 if field not in params.keys():
96 errors.append(make_error(spec, 'mandatory',
97 'No {} entered'.format(field)))
98 if 'email' in spec.value and field in params.keys():
99 try:
100 params[field] = encode_email_address(params[field])
101 except ValueError:
102 errors.append(make_error(spec, 'email', 'Invalid email'))
103 return errors
104
105
55 def make_handler(name, config): 106 def make_handler(name, config):
56 try: 107 try:
108 log_path = config['csv_log'].value
109 except KeyError:
110 raise Exception('No log configured for form handler: ' + name)
Vasily Kuznetsov 2017/02/28 18:38:49 It seems that the log is still mandatory here. Als
Jon Sonesen 2017/03/07 12:11:25 Ok, yeah I think I meant to change that to an attr
111 try:
57 url = config['url'].value 112 url = config['url'].value
58 except (KeyError, AttributeError): 113 except (KeyError, AttributeError):
59 raise Exception('No URL configured for form handler:' + name) 114 raise Exception('No URL configured for form handler:' + name)
60 try: 115 try:
61 template = config['template'].value 116 template = config['template'].value
62 except (KeyError, AttributeError): 117 except KeyError:
63 raise Exception('No template configured for form handler:' + name) 118 template = None
64 try: 119 try:
65 fields = config['fields'] 120 fields = config['fields']
66 for field, spec in fields.items(): 121 for field, spec in fields.items():
67 spec.value = {s.strip() for s in spec.value.split(',')} 122 spec.value = {s.strip() for s in spec.value.split(',')}
68 except KeyError: 123 except KeyError:
69 raise Exception('No fields configured for form handler:' + name) 124 raise Exception('No fields configured for form handler:' + name)
70 if len(fields) == 0: 125 if len(fields) == 0:
71 raise Exception('No fields configured for form handler:' + name) 126 raise Exception('No fields configured for form handler:' + name)
72 127
73 @form_handler 128 @form_handler
74 def handler(environ, start_response, params): 129 def handler(environ, start_response, params):
75 response_headers = [('Content-Type', 'text/plain; charset=utf-8')] 130 response_headers = [('Content-Type', 'text/plain; charset=utf-8')]
76 errors = [] 131 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: 132 if errors:
88 start_response('400 Bad Request', response_headers) 133 start_response('400 Bad Request', response_headers)
89 return '\n'.join(errors) 134 return '\n'.join(errors)
135 params = {field: params.get(field, '').encode('utf8')
136 for field in fields}
137 time = datetime.datetime.now()
138 if template is not None:
139 template_args = {
140 'time': time,
141 'fields': {field: params.get(field, '')
Vasily Kuznetsov 2017/02/28 18:38:49 This and the following lines could fit in one line
Jon Sonesen 2017/03/07 12:11:25 I usually feel it is easier on the eyes if the key
142 for field in fields}
90 143
91 template_args = { 144 }
92 'time': datetime.datetime.now(), 145 sendMail(template, template_args)
93 'fields': {field: params.get(field, '') for field in fields} 146 params['time'] = time
94 } 147 ollect_formdata(params, log_path)
Vasily Kuznetsov 2017/02/28 18:38:49 The first 'c' seems to have disappeared somehow ;)
Jon Sonesen 2017/03/07 12:11:25 geeez XD sorry
95 sendMail(template, template_args)
96 start_response('200 OK', response_headers) 148 start_response('200 OK', response_headers)
97 return '' 149 return ''
98 150
99 return url, handler 151 return url, handler
100 152
101 153
102 conf_dict = conf_parse(get_config_items()) 154 conf_dict = conf_parse(get_config_items())
103 for name, config in conf_dict.items(): 155 for name, config in conf_dict.items():
104 url, handler = make_handler(name, config) 156 url, handler = make_handler(name, config)
105 registerUrlHandler(url, handler) 157 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