design-comuni-plone-theme 11.21.1 → 11.22.0

package/src/customizations/volto-form-block/components/Sidebar.jsx

@@ -0,0 +1,325 @@
+// CUSTOMIZATION:
+// - 112-113 reset subscription limit to default when set_limit is not active
+
+import React, { useState, useEffect } from 'react';
+import PropTypes from 'prop-types';
+import { useSelector, useDispatch } from 'react-redux';
+import {
+  Segment,
+  Accordion,
+  Form,
+  Button,
+  Grid,
+  Confirm,
+  Dimmer,
+  Loader,
+} from 'semantic-ui-react';
+import { defineMessages, useIntl, FormattedMessage } from 'react-intl';
+
+import { Icon } from '@plone/volto/components';
+
+import upSVG from '@plone/volto/icons/up-key.svg';
+import downSVG from '@plone/volto/icons/down-key.svg';
+import downloadSVG from '@plone/volto/icons/download.svg';
+import deleteSVG from '@plone/volto/icons/delete.svg';
+
+import warningSVG from '@plone/volto/icons/warning.svg';
+
+import {
+  getFormData,
+  exportCsvFormData,
+  clearFormData,
+} from 'volto-form-block/actions';
+
+import { BlockDataForm } from '@plone/volto/components';
+import { flattenToAppURL } from '@plone/volto/helpers';
+import { getFieldName } from 'volto-form-block/components/utils';
+
+import 'volto-form-block/components/Sidebar.css';
+import config from '@plone/volto/registry';
+
+const messages = defineMessages({
+  exportCsv: {
+    id: 'form_edit_exportCsv',
+    defaultMessage: 'Export data',
+  },
+  clearData: {
+    id: 'form_clear_data',
+    defaultMessage: 'Clear data',
+  },
+  formDataCount: {
+    id: 'form_formDataCount',
+    defaultMessage: '{formDataCount} item(s) stored',
+  },
+  confirmClearData: {
+    id: 'form_confirmClearData',
+    defaultMessage: 'Are you sure you want to delete all saved items?',
+  },
+  cancel: {
+    id: 'Cancel',
+    defaultMessage: 'Cancel',
+  },
+  fieldId: {
+    id: 'fieldId',
+    defaultMessage: 'Field ID',
+  },
+  remove_data_cron_info: {
+    id: 'remove_data_cron_info',
+    defaultMessage:
+      'To automate the removal of records that have exceeded the maximum number of days indicated in configuration, a cron must be set up on the server as indicated in the product documentation.',
+  },
+  remove_data_warning: {
+    id: 'remove_data_warning',
+    defaultMessage:
+      'There are {record} record that have exceeded the maximum number of days.',
+  },
+  remove_data_button: {
+    id: 'remove_data_button',
+    defaultMessage: 'remove expired data',
+  },
+});
+
+const Sidebar = ({
+  data,
+  properties,
+  block,
+  onChangeBlock,
+  onChangeSubBlock,
+  selected = 0,
+  setSelected,
+}) => {
+  const intl = useIntl();
+  const dispatch = useDispatch();
+  const [confirmOpen, setConfirmOpen] = useState(false);
+
+  const formData = useSelector((state) => state.formData);
+  const clearFormDataState = useSelector(
+    (state) => state.clearFormData?.loaded,
+  );
+  useEffect(() => {
+    if (properties?.['@id'])
+      dispatch(
+        getFormData({
+          path: flattenToAppURL(properties['@id']),
+          block_id: block,
+        }),
+      );
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [clearFormDataState]);
+
+  if (data.send_email === undefined) data.send_email = true;
+
+  // reset subscription limit to default when set_limit is not active
+  if (data.set_limit === false) data.limit = -1;
+
+  data.subblocks &&
+    data.subblocks.forEach((subblock) => {
+      subblock.field_id = subblock.id;
+    });
+  var FormSchema = config.blocks.blocksConfig.form.formSchema;
+  var FieldSchema = config.blocks.blocksConfig.form.fieldSchema;
+
+  return (
+    <Form>
+      <Segment.Group raised>
+        <header className="header pulled">
+          <h2>
+            <FormattedMessage id="Form" defaultMessage="Form" />
+          </h2>
+        </header>
+        <Segment>
+          <BlockDataForm
+            schema={FormSchema(data)}
+            onChangeField={(id, value) => {
+              onChangeBlock(block, {
+                ...data,
+                [id]: value,
+              });
+            }}
+            formData={data}
+          />
+          {properties?.['@components']?.form_data && (
+            <Form.Field inline>
+              <Grid>
+                <Grid.Row stretched centered style={{ padding: '1rem 0' }}>
+                  <Dimmer active={formData?.loading}>
+                    <Loader size="tiny" />
+                  </Dimmer>
+                  <p>
+                    {intl.formatMessage(messages.formDataCount, {
+                      formDataCount: formData?.result?.items_total ?? 0,
+                    })}
+                  </p>
+                </Grid.Row>
+                <Grid.Row
+                  stretched
+                  centered
+                  columns={2}
+                  style={{ marginBottom: '0.5rem' }}
+                >
+                  <Grid.Column>
+                    <Button
+                      compact
+                      onClick={() =>
+                        dispatch(
+                          exportCsvFormData(
+                            flattenToAppURL(properties['@id']),
+                            `export-${properties.id ?? 'form'}.csv`,
+                            block,
+                          ),
+                        )
+                      }
+                      size="tiny"
+                      style={{ display: 'flex', alignItems: 'center' }}
+                    >
+                      <Icon name={downloadSVG} size="1.5rem" />{' '}
+                      {intl.formatMessage(messages.exportCsv)}
+                    </Button>
+                  </Grid.Column>
+                  <Grid.Column>
+                    <Button
+                      compact
+                      onClick={() => setConfirmOpen(true)}
+                      size="tiny"
+                      style={{ display: 'flex', alignItems: 'center' }}
+                    >
+                      <Icon name={deleteSVG} size="1.5rem" />{' '}
+                      {intl.formatMessage(messages.clearData)}
+                    </Button>
+                    <Confirm
+                      open={confirmOpen}
+                      content={intl.formatMessage(messages.confirmClearData)}
+                      cancelButton={intl.formatMessage(messages.cancel)}
+                      onCancel={() => setConfirmOpen(false)}
+                      onConfirm={() => {
+                        dispatch(
+                          clearFormData({
+                            path: flattenToAppURL(properties['@id']),
+                            block_id: block,
+                          }),
+                        );
+                        setConfirmOpen(false);
+                      }}
+                    />
+                  </Grid.Column>
+                </Grid.Row>
+                {data.remove_data_after_days > 0 && (
+                  <Grid.Row>
+                    <div class="ui message info tiny">
+                      {formData.loaded &&
+                        formData.result?.expired_total > 0 && (
+                          <>
+                            <p>
+                              <Icon name={warningSVG} size="18px" />
+                              {intl.formatMessage(
+                                messages.remove_data_warning,
+                                {
+                                  record: formData.result.expired_total,
+                                },
+                              )}
+                            </p>
+                            <p>
+                              <Button
+                                onClick={() =>
+                                  dispatch(
+                                    clearFormData({
+                                      path: flattenToAppURL(properties['@id']),
+                                      expired: true,
+                                      block_id: block,
+                                    }),
+                                  )
+                                }
+                                size="tiny"
+                                compact
+                                style={{
+                                  display: 'flex',
+                                  alignItems: 'center',
+                                }}
+                              >
+                                <Icon name={deleteSVG} size="1.5rem" />{' '}
+                                {intl.formatMessage(
+                                  messages.remove_data_button,
+                                )}
+                              </Button>
+                            </p>
+                          </>
+                        )}
+                      <p>
+                        {intl.formatMessage(messages.remove_data_cron_info)}
+                      </p>
+                    </div>
+                  </Grid.Row>
+                )}
+              </Grid>
+            </Form.Field>
+          )}
+        </Segment>
+        <Accordion fluid styled className="form">
+          {data.subblocks &&
+            data.subblocks.map((subblock, index) => {
+              return (
+                <div key={'subblock' + index}>
+                  <Accordion.Title
+                    active={selected === index}
+                    index={index}
+                    onClick={() =>
+                      setSelected(selected === index ? null : index)
+                    }
+                  >
+                    {subblock.label ?? subblock.field_name}
+                    {selected === index ? (
+                      <Icon name={upSVG} size="20px" />
+                    ) : (
+                      <Icon name={downSVG} size="20px" />
+                    )}
+                  </Accordion.Title>
+                  <Accordion.Content active={selected === index}>
+                    {/* Field ID info */}
+                    {(subblock.field_type === 'text' ||
+                      subblock.field_type === 'from' ||
+                      subblock.field_type === 'textarea' ||
+                      subblock.field_type === 'date' ||
+                      subblock.field_type === 'single_choice' ||
+                      subblock.field_type === 'multiple_choice' ||
+                      subblock.field_type === 'select' ||
+                      subblock.field_type === 'checkbox' ||
+                      subblock.field_type === 'attachment') && (
+                      <Segment tertiary>
+                        {intl.formatMessage(messages.fieldId)}:{' '}
+                        <strong>
+                          {getFieldName(subblock.label, subblock.field_id)}
+                        </strong>
+                      </Segment>
+                    )}
+                    <BlockDataForm
+                      schema={FieldSchema(subblock)}
+                      onChangeField={(name, value) => {
+                        var update_values = {};
+
+                        onChangeSubBlock(index, {
+                          ...subblock,
+                          [name]: value,
+                          ...update_values,
+                        });
+                      }}
+                      formData={subblock}
+                    />
+                  </Accordion.Content>
+                </div>
+              );
+            })}
+        </Accordion>
+      </Segment.Group>
+    </Form>
+  );
+};
+
+Sidebar.propTypes = {
+  data: PropTypes.objectOf(PropTypes.any),
+  block: PropTypes.string,
+  onChangeBlock: PropTypes.func,
+  selected: PropTypes.any,
+  setSelected: PropTypes.func,
+};
+
+export default Sidebar;

package/src/customizations/volto-form-block/components/View.jsx

@@ -0,0 +1,390 @@
+// CUSTOMIZATION:
+// - added warning state to form
+
+import React, { useState, useEffect, useReducer, useRef } from 'react';
+import { useSelector, useDispatch } from 'react-redux';
+import PropTypes from 'prop-types';
+import { useIntl, defineMessages } from 'react-intl';
+import { submitForm } from 'volto-form-block/actions';
+import { getFieldName } from 'volto-form-block/components/utils';
+import FormView from 'volto-form-block/components/FormView';
+import { formatDate } from '@plone/volto/helpers/Utils/Date';
+import config from '@plone/volto/registry';
+import { Captcha } from 'volto-form-block/components/Widget';
+import { isValidEmail } from 'volto-form-block/helpers/validators';
+import ValidateConfigForm from 'volto-form-block/components/ValidateConfigForm';
+import { OTP_FIELDNAME_EXTENDER } from 'volto-form-block/components/Widget';
+
+const messages = defineMessages({
+  formSubmitted: {
+    id: 'formSubmitted',
+    defaultMessage: 'Form successfully submitted',
+  },
+  defaultInvalidFieldMessage: {
+    id: 'formblock_defaultInvalidFieldMessage',
+    defaultMessage: 'Invalid field value',
+  },
+  requiredFieldMessage: {
+    id: 'formblock_requiredFieldMessage',
+    defaultMessage: 'Fill-in this field',
+  },
+  invalidEmailMessage: {
+    id: 'formblock_invalidEmailMessage',
+    defaultMessage: 'The email is incorrect',
+  },
+  insertOtp: {
+    id: 'formblock_insertOtp_error',
+    defaultMessage: 'Please, insert the OTP code recived via email.',
+  },
+});
+
+const initialState = {
+  loading: false,
+  error: null,
+  result: null,
+  warning: null,
+};
+
+const FORM_STATES = {
+  normal: 'normal',
+  loading: 'loading',
+  error: 'error',
+  success: 'success',
+  warning: 'warning',
+};
+
+const formStateReducer = (state, action) => {
+  switch (action.type) {
+    case FORM_STATES.normal:
+      return initialState;
+
+    case FORM_STATES.loading:
+      return { loading: true, error: null, result: null, warning: null };
+
+    case FORM_STATES.error:
+      return {
+        loading: false,
+        error: action.error,
+        result: null,
+        warning: null,
+      };
+
+    case FORM_STATES.warning:
+      return {
+        loading: false,
+        error: null,
+        result: action.result,
+        warning: true,
+      };
+
+    case FORM_STATES.success:
+      return {
+        loading: false,
+        error: null,
+        result: action.result,
+        warning: null,
+      };
+
+    default:
+      return initialState;
+  }
+};
+
+const getInitialData = (data) => {
+  const { static_fields = [], subblocks = [] } = data;
+
+  return {
+    ...subblocks.reduce(
+      (acc, field) =>
+        field.field_type === 'hidden'
+          ? {
+              ...acc,
+              [getFieldName(field.label, field.id)]: {
+                ...field,
+                ...(data[field.id] && { custom_field_id: data[field.id] }),
+              },
+            }
+          : acc,
+      {},
+    ),
+    ...static_fields.reduce(
+      (acc, field) => ({
+        ...acc,
+        [getFieldName(field.label, field.id)]: field,
+      }),
+      {},
+    ),
+  };
+};
+
+/**
+ * Form view
+ * @class View
+ */
+const View = ({ data, id, path }) => {
+  const intl = useIntl();
+  const dispatch = useDispatch();
+
+  const [formData, setFormData] = useReducer((state, action) => {
+    if (action.reset) {
+      return getInitialData(data);
+    }
+
+    return {
+      ...state,
+      [action.field]: action.value,
+    };
+  }, getInitialData(data));
+
+  const [formState, setFormState] = useReducer(formStateReducer, initialState);
+  const [formErrors, setFormErrors] = useState([]);
+
+  const submitResults = useSelector(
+    (state) => state.submitForm?.subrequests?.[id],
+  );
+  const captchaToken = useRef();
+
+  const onChangeFormData = (field_id, field, value, extras) => {
+    setFormData({ field, value: { field_id, value, ...extras } });
+  };
+
+  useEffect(() => {
+    if (formErrors.length > 0) {
+      isValidForm();
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [formData]);
+
+  const isValidForm = () => {
+    const v = [];
+    data.subblocks.forEach((subblock, index) => {
+      const name = getFieldName(subblock.label, subblock.id);
+      const fieldType = subblock.field_type;
+      const isBCC = subblock.use_as_bcc;
+      const additionalField =
+        config.blocks.blocksConfig.form.additionalFields?.filter(
+          (f) => f.id === fieldType && f.isValid !== undefined,
+        )?.[0] ?? null;
+
+      if (
+        subblock.required &&
+        additionalField &&
+        !additionalField?.isValid(formData, name)
+      ) {
+        const validation = additionalField?.isValid(formData, name);
+        if (typeof validation === 'boolean') {
+          //for retro-compatibility with previous formErrors structure
+          v.push({
+            field: name,
+            message: intl.formatMessage(messages.defaultInvalidFieldMessage),
+          });
+        } else if (typeof validation === 'object') {
+          v.push(validation);
+        }
+      } else if (
+        subblock.required &&
+        fieldType === 'checkbox' &&
+        !formData[name]?.value
+      ) {
+        v.push({
+          field: name,
+          message: intl.formatMessage(messages.requiredFieldMessage),
+        });
+      } else if (
+        subblock.required &&
+        (!formData[name] ||
+          formData[name]?.value?.length === 0 ||
+          JSON.stringify(formData[name]?.value ?? {}) === '{}')
+      ) {
+        v.push({
+          field: name,
+          message: intl.formatMessage(messages.requiredFieldMessage),
+        });
+      } else if (
+        (fieldType === 'from' || fieldType === 'email') &&
+        formData[name]?.value
+      ) {
+        if (!isValidEmail(formData[name].value)) {
+          v.push({
+            field: name,
+            message: intl.formatMessage(messages.invalidEmailMessage),
+          });
+        } else if (isBCC && !formData[name].otp) {
+          v.push({
+            field: name + OTP_FIELDNAME_EXTENDER,
+            message: intl.formatMessage(messages.insertOtp),
+          });
+        }
+      }
+    });
+
+    if (data.captcha && !captchaToken.current) {
+      v.push({
+        field: 'captcha',
+        message: intl.formatMessage(messages.requiredFieldMessage),
+      });
+    }
+
+    setFormErrors(v);
+    return v.length === 0;
+  };
+
+  const submit = (e) => {
+    e.preventDefault();
+    captcha
+      .verify()
+      .then(() => {
+        if (isValidForm()) {
+          let attachments = {};
+          let captcha = {
+            provider: data.captcha,
+            token: captchaToken.current,
+          };
+          if (data.captcha === 'honeypot') {
+            captcha.value = formData[data.captcha_props.id]?.value ?? '';
+          }
+
+          let formattedFormData = { ...formData };
+          data.subblocks.forEach((subblock) => {
+            let name = getFieldName(subblock.label, subblock.id);
+            if (formattedFormData[name]?.value) {
+              formattedFormData[name].field_id = subblock.field_id;
+              const isAttachment =
+                config.blocks.blocksConfig.form.attachment_fields.includes(
+                  subblock.field_type,
+                );
+              const isDate = subblock.field_type === 'date';
+
+              if (isAttachment) {
+                attachments[name] = formattedFormData[name].value;
+                delete formattedFormData[name];
+              }
+
+              if (isDate) {
+                formattedFormData[name].value = formatDate({
+                  date: formattedFormData[name].value,
+                  format: 'DD-MM-YYYY',
+                  locale: intl.locale,
+                });
+              }
+            }
+          });
+          dispatch(
+            submitForm(
+              path,
+              id,
+              Object.keys(formattedFormData).map((name) => ({
+                ...formattedFormData[name],
+              })),
+              attachments,
+              captcha,
+            ),
+          );
+          setFormState({ type: FORM_STATES.loading });
+        } else {
+          setFormState({ type: FORM_STATES.error });
+        }
+      })
+      .catch(() => {
+        setFormState({ type: FORM_STATES.error });
+      });
+  };
+
+  const resetFormState = () => {
+    setFormData({ reset: true });
+    setFormState({ type: FORM_STATES.normal });
+  };
+
+  const resetFormOnError = () => {
+    setFormState({ type: FORM_STATES.normal });
+  };
+
+  const getErrorMessage = (field) => {
+    const e = formErrors?.filter((e) => e.field === field);
+    return e.length > 0 ? e[0].message : null;
+  };
+
+  const captcha = new Captcha({
+    captchaToken,
+    captcha: data.captcha,
+    captcha_props: data.captcha_props,
+    errorMessage: getErrorMessage('captcha'),
+    onChangeFormData,
+  });
+
+  const formid = `form-${id}`;
+
+  useEffect(() => {
+    if (submitResults?.loaded) {
+      if (submitResults?.result?.data?.waiting_list) {
+        setFormState({
+          type: FORM_STATES.warning,
+          result: {
+            ...submitResults.result,
+          },
+        });
+      } else {
+        setFormState({
+          type: FORM_STATES.success,
+          result: {
+            message: intl.formatMessage(messages.formSubmitted),
+            ...submitResults.result,
+          },
+        });
+      }
+      captcha.reset();
+      const formItem = document.getElementById(formid);
+      if (formItem !== null) {
+        const formItemPosition = formItem.getBoundingClientRect();
+        formItemPosition !== null &&
+          window.scrollTo({
+            top: formItemPosition.x,
+            left: formItemPosition.y,
+            behavior: 'smooth',
+          });
+      }
+    } else if (submitResults?.error) {
+      let errorDescription = `${
+        JSON.parse(submitResults.error.response?.text ?? '{}')?.message
+      }`;
+
+      setFormState({ type: FORM_STATES.error, error: errorDescription });
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [submitResults]);
+
+  useEffect(() => {
+    resetFormState();
+  }, []);
+
+  return (
+    <ValidateConfigForm data={data}>
+      <FormView
+        id={formid}
+        formState={formState}
+        formErrors={formErrors}
+        formData={formData}
+        captcha={captcha}
+        onChangeFormData={onChangeFormData}
+        data={data}
+        onSubmit={submit}
+        resetFormState={resetFormState}
+        resetFormOnError={resetFormOnError}
+        getErrorMessage={getErrorMessage}
+        path={path}
+        block_id={id}
+      />
+    </ValidateConfigForm>
+  );
+};
+
+/**
+ * Property types.
+ * @property {Object} propTypes Property types.
+ * @static
+ */
+View.propTypes = {
+  data: PropTypes.objectOf(PropTypes.any).isRequired,
+};
+
+export default View;