|
| 1 | +from collective.volto.formsupport import _ |
| 2 | +from collective.volto.formsupport.interfaces import ICaptchaSupport |
| 3 | +from collective.volto.formsupport.interfaces import IPostAdapter |
| 4 | +from collective.volto.formsupport.utils import get_blocks |
| 5 | +from collective.volto.otp.utils import validate_email_token |
| 6 | +from copy import deepcopy |
| 7 | +from plone import api |
| 8 | +from plone.restapi.deserializer import json_body |
| 9 | +from plone.schema.email import _isemail |
| 10 | +from zExceptions import BadRequest |
| 11 | +from zope.component import adapter |
| 12 | +from zope.component import getMultiAdapter |
| 13 | +from zope.i18n import translate |
| 14 | +from zope.interface import implementer |
| 15 | +from zope.interface import Interface |
| 16 | + |
| 17 | +import math |
| 18 | +import os |
| 19 | + |
| 20 | + |
| 21 | +@implementer(IPostAdapter) |
| 22 | +@adapter(Interface, Interface) |
| 23 | +class PostAdapter: |
| 24 | + block_id = None |
| 25 | + block = {} |
| 26 | + |
| 27 | + def __init__(self, context, request): |
| 28 | + self.context = context |
| 29 | + self.request = request |
| 30 | + self.form_data = self.extract_data_from_request() |
| 31 | + self.block_id = self.form_data.get("block_id", "") |
| 32 | + if self.block_id: |
| 33 | + self.block = self.get_block_data(block_id=self.block_id) |
| 34 | + |
| 35 | + def __call__(self): |
| 36 | + """ |
| 37 | + Avoid XSS injections and other attacks. |
| 38 | +
|
| 39 | + - cleanup HTML with plone transform |
| 40 | + - remove from data, fields not defined in form schema |
| 41 | + """ |
| 42 | + |
| 43 | + self.validate_form() |
| 44 | + |
| 45 | + return self.form_data |
| 46 | + |
| 47 | + def extract_data_from_request(self): |
| 48 | + form_data = json_body(self.request) |
| 49 | + |
| 50 | + fixed_fields = [] |
| 51 | + transforms = api.portal.get_tool(name="portal_transforms") |
| 52 | + |
| 53 | + block = self.get_block_data(block_id=form_data.get("block_id", "")) |
| 54 | + block_fields = [x.get("field_id", "") for x in block.get("subblocks", [])] |
| 55 | + |
| 56 | + for form_field in form_data.get("data", []): |
| 57 | + if form_field.get("field_id", "") not in block_fields: |
| 58 | + # unknown field, skip it |
| 59 | + continue |
| 60 | + new_field = deepcopy(form_field) |
| 61 | + value = new_field.get("value", "") |
| 62 | + if isinstance(value, str): |
| 63 | + stream = transforms.convertTo("text/plain", value, mimetype="text/html") |
| 64 | + new_field["value"] = stream.getData().strip() |
| 65 | + fixed_fields.append(new_field) |
| 66 | + |
| 67 | + form_data["data"] = fixed_fields |
| 68 | + |
| 69 | + return form_data |
| 70 | + |
| 71 | + def get_block_data(self, block_id): |
| 72 | + blocks = get_blocks(self.context) |
| 73 | + if not blocks: |
| 74 | + return {} |
| 75 | + for id, block in blocks.items(): |
| 76 | + if id != block_id: |
| 77 | + continue |
| 78 | + block_type = block.get("@type", "") |
| 79 | + if block_type != "form": |
| 80 | + continue |
| 81 | + return block |
| 82 | + return {} |
| 83 | + |
| 84 | + def validate_form(self): |
| 85 | + """ |
| 86 | + check all required fields and parameters |
| 87 | + """ |
| 88 | + if not self.block_id: |
| 89 | + raise BadRequest( |
| 90 | + translate( |
| 91 | + _("missing_blockid_label", default="Missing block_id"), |
| 92 | + context=self.request, |
| 93 | + ) |
| 94 | + ) |
| 95 | + if not self.block: |
| 96 | + raise BadRequest( |
| 97 | + translate( |
| 98 | + _( |
| 99 | + "block_form_not_found_label", |
| 100 | + default='Block with @type "form" and id "$block" not found in this context: $context', |
| 101 | + mapping={ |
| 102 | + "block": self.block_id, |
| 103 | + "context": self.context.absolute_url(), |
| 104 | + }, |
| 105 | + ), |
| 106 | + context=self.request, |
| 107 | + ), |
| 108 | + ) |
| 109 | + |
| 110 | + if not self.block.get("store", False) and not self.block.get("send", []): |
| 111 | + raise BadRequest( |
| 112 | + translate( |
| 113 | + _( |
| 114 | + "missing_action", |
| 115 | + default='You need to set at least one form action between "send" and "store".', # noqa |
| 116 | + ), |
| 117 | + context=self.request, |
| 118 | + ) |
| 119 | + ) |
| 120 | + |
| 121 | + if not self.form_data.get("data", []): |
| 122 | + raise BadRequest( |
| 123 | + translate( |
| 124 | + _( |
| 125 | + "empty_form_data", |
| 126 | + default="Empty form data.", |
| 127 | + ), |
| 128 | + context=self.request, |
| 129 | + ) |
| 130 | + ) |
| 131 | + |
| 132 | + self.validate_attachments() |
| 133 | + if self.block.get("captcha", False): |
| 134 | + getMultiAdapter( |
| 135 | + (self.context, self.request), |
| 136 | + ICaptchaSupport, |
| 137 | + name=self.block["captcha"], |
| 138 | + ).verify(self.form_data.get("captcha")) |
| 139 | + |
| 140 | + self.validate_email_fields() |
| 141 | + self.validate_bcc() |
| 142 | + |
| 143 | + def validate_email_fields(self): |
| 144 | + email_fields = [ |
| 145 | + x.get("field_id", "") |
| 146 | + for x in self.block.get("subblocks", []) |
| 147 | + if x.get("field_type", "") == "from" |
| 148 | + ] |
| 149 | + for form_field in self.form_data.get("data", []): |
| 150 | + if form_field.get("field_id", "") not in email_fields: |
| 151 | + continue |
| 152 | + if _isemail(form_field.get("value", "")) is None: |
| 153 | + raise BadRequest( |
| 154 | + translate( |
| 155 | + _( |
| 156 | + "wrong_email", |
| 157 | + default='Email not valid in "${field}" field.', |
| 158 | + mapping={ |
| 159 | + "field": form_field.get("label", ""), |
| 160 | + }, |
| 161 | + ), |
| 162 | + context=self.request, |
| 163 | + ) |
| 164 | + ) |
| 165 | + |
| 166 | + def validate_bcc(self): |
| 167 | + """ |
| 168 | + If otp validation is enabled, check if is valid |
| 169 | + """ |
| 170 | + bcc_fields = [] |
| 171 | + email_otp_verification = self.block.get("email_otp_verification", False) |
| 172 | + block_id = self.form_data.get("block_id", "") |
| 173 | + for field in self.block.get("subblocks", []): |
| 174 | + if field.get("use_as_bcc", False): |
| 175 | + field_id = field.get("field_id", "") |
| 176 | + if field_id not in bcc_fields: |
| 177 | + bcc_fields.append(field_id) |
| 178 | + if not bcc_fields: |
| 179 | + return |
| 180 | + if not email_otp_verification: |
| 181 | + return |
| 182 | + for data in self.form_data.get("data", []): |
| 183 | + value = data.get("value", "") |
| 184 | + if not value: |
| 185 | + continue |
| 186 | + if data.get("field_id", "") not in bcc_fields: |
| 187 | + continue |
| 188 | + otp = data.get("otp", "") |
| 189 | + if not otp: |
| 190 | + raise BadRequest( |
| 191 | + api.portal.translate( |
| 192 | + _( |
| 193 | + "otp_validation_missing_value", |
| 194 | + default="Missing OTP value. Unable to submit the form.", |
| 195 | + ) |
| 196 | + ) |
| 197 | + ) |
| 198 | + if not validate_email_token(block_id, value, otp): |
| 199 | + raise BadRequest( |
| 200 | + api.portal.translate( |
| 201 | + _( |
| 202 | + "otp_validation_wrong_value", |
| 203 | + default="${email}'s OTP is wrong", |
| 204 | + mapping={"email": data["value"]}, |
| 205 | + ) |
| 206 | + ) |
| 207 | + ) |
| 208 | + |
| 209 | + def validate_attachments(self): |
| 210 | + attachments_limit = os.environ.get("FORM_ATTACHMENTS_LIMIT", "") |
| 211 | + if not attachments_limit: |
| 212 | + return |
| 213 | + attachments = self.form_data.get("attachments", {}) |
| 214 | + attachments_len = 0 |
| 215 | + for attachment in attachments.values(): |
| 216 | + data = attachment.get("data", "") |
| 217 | + attachments_len += (len(data) * 3) / 4 - data.count("=", -2) |
| 218 | + if attachments_len > float(attachments_limit) * pow(1024, 2): |
| 219 | + size_name = ("B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB") |
| 220 | + i = int(math.floor(math.log(attachments_len, 1024))) |
| 221 | + p = math.pow(1024, i) |
| 222 | + s = round(attachments_len / p, 2) |
| 223 | + uploaded_str = f"{s} {size_name[i]}" |
| 224 | + raise BadRequest( |
| 225 | + translate( |
| 226 | + _( |
| 227 | + "attachments_too_big", |
| 228 | + default="Attachments too big. You uploaded ${uploaded_str}," |
| 229 | + " but limit is ${max} MB. Try to compress files.", |
| 230 | + mapping={ |
| 231 | + "max": attachments_limit, |
| 232 | + "uploaded_str": uploaded_str, |
| 233 | + }, |
| 234 | + ), |
| 235 | + context=self.request, |
| 236 | + ) |
| 237 | + ) |
| 238 | + |
| 239 | + def filter_parameters(self): |
| 240 | + """ |
| 241 | + do not send attachments fields. |
| 242 | + """ |
| 243 | + result = [] |
| 244 | + |
| 245 | + for field in self.block.get("subblocks", []): |
| 246 | + if field.get("field_type", "") == "attachment": |
| 247 | + continue |
| 248 | + |
| 249 | + for item in self.form_data.get("data", []): |
| 250 | + if item.get("field_id", "") == field.get("field_id", ""): |
| 251 | + result.append(item) |
| 252 | + |
| 253 | + return result |
| 254 | + |
| 255 | + def format_fields(self): |
| 256 | + fields = self.filter_parameters() |
| 257 | + formatted_fields = [] |
| 258 | + field_ids = [field.get("field_id") for field in self.block.get("subblocks", [])] |
| 259 | + |
| 260 | + for field in fields: |
| 261 | + field_id = field.get("field_id", "") |
| 262 | + |
| 263 | + if field_id: |
| 264 | + field_index = field_ids.index(field_id) |
| 265 | + |
| 266 | + if self.block["subblocks"][field_index].get("field_type") == "date": |
| 267 | + field["value"] = api.portal.get_localized_time(field["value"]) |
| 268 | + |
| 269 | + formatted_fields.append(field) |
| 270 | + |
| 271 | + return formatted_fields |
0 commit comments