forms/lib/Constants.php

<?php
/**
 * @copyright Copyright (c) 2021 Jonas Rittershofer <jotoeri@users.noreply.github.com>
 *
 * @author Jonas Rittershofer <jotoeri@users.noreply.github.com>
 *
 * @license AGPL-3.0-or-later
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Forms;

use OCP\Share\IShare;

class Constants {
	/**
	 * Constants for API Controllers
	 */
	public const API_BASE = '/api/{apiVersion}/';
	public const API_V3_REQUIREMENTS = [
		'apiVersion' => 'v3',
		'formId' => '\d+',
		'questionId' => '\d+',
		'optionId' => '\d+',
		'shareId' => '\d+',
		'submissionId' => '\d+',
		'path' => '.+'
	];
	
	/**
	 * Used AppConfig Keys
	 */
	public const CONFIG_KEY_ALLOWPERMITALL = 'allowPermitAll';
	public const CONFIG_KEY_ALLOWPUBLICLINK = 'allowPublicLink';
	public const CONFIG_KEY_ALLOWSHOWTOALL = 'allowShowToAll';
	public const CONFIG_KEY_CREATIONALLOWEDGROUPS = 'creationAllowedGroups';
	public const CONFIG_KEY_RESTRICTCREATION = 'restrictCreation';
	public const CONFIG_KEYS = [
		self::CONFIG_KEY_ALLOWPERMITALL,
		self::CONFIG_KEY_ALLOWPUBLICLINK,
		self::CONFIG_KEY_ALLOWSHOWTOALL,
		self::CONFIG_KEY_CREATIONALLOWEDGROUPS,
		self::CONFIG_KEY_RESTRICTCREATION
	];

	/**
	 * Maximum String lengths, the database is set to store.
	 */
	public const MAX_STRING_LENGTHS = [
		'formTitle' => 256,
		'formDescription' => 8192,
		'submissionMessage' => 2048,
		'questionText' => 2048,
		'questionDescription' => 4096,
		'optionText' => 1024,
		'answerText' => 4096,
	];

	/**
	 * State flags of a form
	 */
	public const FORM_STATE_ACTIVE = 0;
	public const FORM_STATE_CLOSED = 1;
	public const FORM_STATE_ARCHIVED = 2;

	/**
	 * Access flags of a form
	 */
	public const FORM_ACCESS_NOPUBLICSHARE = 0;
	public const FORM_ACCESS_PERMITALLUSERS = 1;
	public const FORM_ACCESS_SHOWTOALLUSERS = 2;
	/** @deprecated 5.0.0 still needed for Migrations */
	public const FORM_ACCESS_LEGACYLINK = 3;
	public const FORM_ACCESS_ARRAY_PERMIT = [
		self::FORM_ACCESS_PERMITALLUSERS,
	];
	public const FORM_ACCESS_ARRAY_SHOWN = [
		self::FORM_ACCESS_SHOWTOALLUSERS,
	];

	/**
	 * !! Keep in sync with src/models/AnswerTypes.js !!
	 */

	// Available AnswerTypes
	public const ANSWER_TYPE_MULTIPLE = 'multiple';
	public const ANSWER_TYPE_MULTIPLEUNIQUE = 'multiple_unique';
	public const ANSWER_TYPE_DROPDOWN = 'dropdown';
	public const ANSWER_TYPE_SHORT = 'short';
	public const ANSWER_TYPE_LONG = 'long';
	public const ANSWER_TYPE_DATE = 'date';
	public const ANSWER_TYPE_DATETIME = 'datetime';
	public const ANSWER_TYPE_TIME = 'time';
	public const ANSWER_TYPE_FILE = 'file';

	// All AnswerTypes
	public const ANSWER_TYPES = [
		self::ANSWER_TYPE_MULTIPLE,
		self::ANSWER_TYPE_MULTIPLEUNIQUE,
		self::ANSWER_TYPE_DROPDOWN,
		self::ANSWER_TYPE_SHORT,
		self::ANSWER_TYPE_LONG,
		self::ANSWER_TYPE_DATE,
		self::ANSWER_TYPE_DATETIME,
		self::ANSWER_TYPE_TIME,
		self::ANSWER_TYPE_FILE,
	];

	// AnswerTypes, that need/have predefined Options
	public const ANSWER_TYPES_PREDEFINED = [
		self::ANSWER_TYPE_MULTIPLE,
		self::ANSWER_TYPE_MULTIPLEUNIQUE,
		self::ANSWER_TYPE_DROPDOWN
	];

	// AnswerTypes for date/time questions
	public const ANSWER_TYPES_DATETIME = [
		self::ANSWER_TYPE_DATE,
		self::ANSWER_TYPE_DATETIME,
		self::ANSWER_TYPE_TIME
	];

	// Formats for AnswerTypes date/datetime/time
	public const ANSWER_PHPDATETIME_FORMAT = [
		self::ANSWER_TYPE_DATE => 'Y-m-d',
		self::ANSWER_TYPE_DATETIME => 'Y-m-d H:i',
		self::ANSWER_TYPE_TIME => 'H:i'
	];

	/**
	 * !! Keep in sync with src/models/ValidationTypes.js !!
	 */

	// Allowed short input types
	public const SHORT_INPUT_TYPES = [
		'phone',
		'email',
		'regex',
		'number'
	];

	// This are allowed extra settings
	public const EXTRA_SETTINGS_DROPDOWN = [
		'allowOtherAnswer' => ['boolean'],
		'shuffleOptions' => ['boolean'],
	];

	public const EXTRA_SETTINGS_MULTIPLE = [
		'allowOtherAnswer' => ['boolean'],
		'optionsLimitMax' => ['integer'],
		'optionsLimitMin' => ['integer'],
		'shuffleOptions' => ['boolean'],
	];

	public const EXTRA_SETTINGS_SHORT = [
		'validationType' => ['string'],
		'validationRegex' => ['string'],
	];

	public const EXTRA_SETTINGS_FILE = [
		'allowedFileTypes' => ['array'],
		'allowedFileExtensions' => ['array'],
		'maxAllowedFilesCount' => ['integer'],
		'maxFileSize' => ['integer'],
	];

	// should be in sync with FileTypes.js
	public const EXTRA_SETTINGS_ALLOWED_FILE_TYPES = [
		'image',
		'x-office/document',
		'x-office/presentation',
		'x-office/spreadsheet',
	];

	/**
	 * !! Keep in sync with src/mixins/ShareTypes.js !!
	 */
	public const SHARE_TYPES_USED = [
		IShare::TYPE_USER,
		IShare::TYPE_GROUP,
		IShare::TYPE_LINK,
		IShare::TYPE_CIRCLE
	];

	/**
	 * !! Keep in sync with src/mixins/PermissionTypes.js !!
	 * Permission values equal the route names, thus making it easy on frontend to evaluate.
	 */
	// Define Form Permissions
	public const PERMISSION_EDIT = 'edit';
	public const PERMISSION_RESULTS = 'results';
	public const PERMISSION_RESULTS_DELETE = 'results_delete';
	public const PERMISSION_SUBMIT = 'submit';
	/** Special internal permissions to allow embedding a form (share) into external websites */
	public const PERMISSION_EMBED = 'embed';

	public const PERMISSION_ALL = [
		self::PERMISSION_EDIT,
		self::PERMISSION_RESULTS,
		self::PERMISSION_RESULTS_DELETE,
		self::PERMISSION_SUBMIT,
		self::PERMISSION_EMBED,
	];

	/**
	 * !! Keep in sync with src/FormsEmptyContent.vue !!
	 * InitialStates for emptyContent to render as...
	 */
	public const EMPTY_NOTFOUND = 'notfound';
	public const EMPTY_EXPIRED = 'expired';

	/**
	 * Constants related to extra settings for questions
	 */
	public const QUESTION_EXTRASETTINGS_OTHER_PREFIX = 'system-other-answer:';

	public const SUPPORTED_EXPORT_FORMATS = [
		'csv' => 'text/csv',
		'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
		'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
	];

	public const DEFAULT_FILE_FORMAT = 'csv';

	public const UNSUBMITTED_FILES_FOLDER = self::FILES_FOLDER . '/unsubmitted';

	public const FILES_FOLDER = 'Forms';
}