* * @author Vinzenz Rosenkranz * @author René Gieling * @author Inigo Jiron * @author Natalie Gilbert * @author Affan Hussain * @author John Molakvoæ * @author Jonas Rittershofer * * @license GNU AGPL version 3 or any later version * * 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 . * */ namespace OCA\Forms\Controller; use OCA\Forms\Db\Form; use OCA\Forms\Db\FormMapper; use OCA\Forms\Db\Submission; use OCA\Forms\Db\SubmissionMapper; use OCA\Forms\Db\Answer; use OCA\Forms\Db\AnswerMapper; use OCA\Forms\Db\OptionMapper; use OCA\Forms\Db\QuestionMapper; use OCP\AppFramework\Controller; use OCP\AppFramework\Db\DoesNotExistException; use OCP\AppFramework\Http\RedirectResponse; use OCP\AppFramework\Http\TemplateResponse; use OCP\IGroupManager; use OCP\IRequest; use OCP\IURLGenerator; use OCP\IUserSession; use OCP\IInitialStateService; use OCP\Util; class PageController extends Controller { protected $appName; /** @var FormMapper */ private $formMapper; /** @var SubmissionMapper */ private $submissionMapper; /** @var AnswerMapper */ private $answerMapper; /** @var IURLGenerator */ private $urlGenerator; /** @var IGroupManager */ private $groupManager; /** @var IUserSession */ private $userSession; /** @var IInitialStateService */ private $initialStateService; public function __construct(string $appName, IRequest $request, IGroupManager $groupManager, IURLGenerator $urlGenerator, FormMapper $formMapper, QuestionMapper $questionMapper, OptionMapper $optionMapper, SubmissionMapper $SubmissionMapper, AnswerMapper $AnswerMapper, IUserSession $userSession, IInitialStateService $initialStateService) { parent::__construct($appName, $request); $this->groupManager = $groupManager; $this->urlGenerator = $urlGenerator; $this->appName = $appName; $this->formMapper = $formMapper; $this->questionMapper = $questionMapper; $this->optionMapper = $optionMapper; $this->submissionMapper = $SubmissionMapper; $this->answerMapper = $AnswerMapper; $this->userSession = $userSession; $this->initialStateService = $initialStateService; } /** * @NoAdminRequired * @NoCSRFRequired * * @return TemplateResponse */ public function index(): TemplateResponse { Util::addScript($this->appName, 'forms'); Util::addStyle($this->appName, 'forms'); return new TemplateResponse($this->appName, 'main'); } /** * @NoAdminRequired * @NoCSRFRequired * * @return TemplateResponse */ public function createForm(): TemplateResponse { Util::addScript($this->appName, 'forms'); Util::addStyle($this->appName, 'forms'); return new TemplateResponse($this->appName, 'main'); } /** * @NoAdminRequired * @NoCSRFRequired * * TODO: Implement cloning * * @return TemplateResponse */ public function cloneForm(): TemplateResponse { Util::addScript($this->appName, 'forms'); Util::addStyle($this->appName, 'forms'); return new TemplateResponse($this->appName, 'main'); } /** * @NoAdminRequired * @NoCSRFRequired * * @return TemplateResponse */ public function editForm(): TemplateResponse { Util::addScript($this->appName, 'forms'); Util::addStyle($this->appName, 'forms'); return new TemplateResponse($this->appName, 'main'); } /** * @NoAdminRequired * @NoCSRFRequired * * @return TemplateResponse */ public function getResult(): TemplateResponse { Util::addScript($this->appName, 'forms'); Util::addStyle($this->appName, 'forms'); return new TemplateResponse($this->appName, 'main'); } private function getOptions(int $questionId): array { $optionList = []; try{ $optionEntities = $this->optionMapper->findByQuestion($questionId); foreach ($optionEntities as $optionEntity) { $optionList[] = $optionEntity->read(); } } catch (DoesNotExistException $e) { //handle silently } finally { return $optionList; } } private function getQuestions(int $formId): array { $questionList = []; try{ $questionEntities = $this->questionMapper->findByForm($formId); foreach ($questionEntities as $questionEntity) { $question = $questionEntity->read(); $question['options'] = $this->getOptions($question['id']); $questionList[] = $question; } } catch (DoesNotExistException $e) { //handle silently }finally{ return $questionList; } } private function getForm(int $id): array { $form = $this->formMapper->findById($id); $result = $form->read(); $result['questions'] = $this->getQuestions($id); return $result; } /** * @NoAdminRequired * @NoCSRFRequired * @PublicPage * @param string $hash * @return TemplateResponse */ public function gotoForm($hash): ?TemplateResponse { // Inject style on all templates Util::addStyle($this->appName, 'forms'); // TODO: check if already submitted try { $form = $this->formMapper->findByHash($hash); } catch (DoesNotExistException $e) { return new TemplateResponse('forms', 'notfound'); } // Does the user have permissions to display if (!$this->hasUserAccess($form)) { return new TemplateResponse('forms', 'notfound'); } // Has form expired if ($form->getExpires() !== 0 && time() > $form->getExpires()) { return new TemplateResponse('forms', 'expired'); } $renderAs = $this->userSession->isLoggedIn() ? 'user' : 'public'; Util::addScript($this->appName, 'submit'); $this->initialStateService->provideInitialState($this->appName, 'form', $this->getForm($form->getId())); return new TemplateResponse($this->appName, 'main', [], $renderAs); } /** * @NoAdminRequired * @PublicPage * * Process a new submission * @param int $formId * @param string $userId * @param array $answers * @param array $questions * @return RedirectResponse */ public function insertSubmission(int $id, string $userId, array $answers, array $questions) { $form = $this->formMapper->findById($id); $anonID = "anon-user-". hash('md5', (time() + rand())); // Insert Submission $submission = new Submission(); $submission->setFormId($id); if ($form->getIsAnonymous()){ $submission->setUserId($anonID); } else { $submission->setUserId($userId); } $submission->setTimestamp(time()); $this->submissionMapper->insert($submission); $submissionId = $submission->getId(); //Insert Answers foreach($questions as $question) { // If question is answered, the questionText exists as key in $answers. Does not exist, when a (non-mandatory) question was not answered. if (array_key_exists($question['text'], $answers)) { if($question['type'] === "checkbox"){ foreach(($answers[$question['text']]) as $ansText) { $answer = new Answer(); $answer->setSubmissionId($submissionId); $answer->setQuestionId($question['id']); $answer->setText($ansText); $this->answerMapper->insert($answer); } } else { $answer = new Answer(); $answer->setSubmissionId($submissionId); $answer->setQuestionId($question['id']); $answer->setText($answers[$question['text']]); $this->answerMapper->insert($answer); } } } $hash = $form->getHash(); $url = $this->urlGenerator->linkToRoute('forms.page.goto_form', ['hash' => $hash]); return new RedirectResponse($url); } /** * @NoAdminRequired * Check if user has access to this form * * @param Form $form * @return boolean */ private function hasUserAccess(Form $form): bool { $access = $form->getAccess(); $ownerId = $form->getOwnerId(); $user = $this->userSession->getUser(); if ($access['type'] === 'public') { return true; } // Refuse access, if not public and no user logged in. if (!$user) { return false; } // Always grant access to owner. if ($ownerId === $user->getUID()) { return true; } // Refuse access, if SubmitOnce is set and user already has taken part. if ($form->getSubmitOnce()) { $participants = $this->submissionMapper->findParticipantsByForm($form->getId()); foreach($participants as $participant) { if ($participant === $user->getUID()) { return false; } } } // Now all remaining users are allowed, if access-type 'registered'. if ($access['type'] === 'registered') { return true; } // Selected Access remains. // Grant Access, if user is in users-Array. if (in_array($user->getUID(), $access['users'])) { return true; } // Check if access granted by group. foreach ($access['groups'] as $group) { if( $this->groupManager->isInGroup($user->getUID(), $group) ) { return true; } } // None of the possible access-options matched. return false; } }