-
Notifications
You must be signed in to change notification settings - Fork 348
/
FeedbackController.php
148 lines (129 loc) · 4.16 KB
/
FeedbackController.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?php
/**
* Controller for configurable forms (feedback etc).
*
* PHP version 8
*
* @category VuFind
* @package Controller
* @author Josiah Knoll <jk1135@ship.edu>
* @author Samuli Sillanpää <samuli.sillanpaa@helsinki.fi>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org Main Site
*/
namespace VuFind\Controller;
use Laminas\Log\LoggerAwareInterface;
use Laminas\View\Model\ViewModel;
use VuFind\Db\Entity\UserEntityInterface;
use VuFind\Form\Form;
use VuFind\Log\LoggerAwareTrait;
/**
* Controller for configurable forms (feedback etc).
*
* @category VuFind
* @package Controller
* @author Josiah Knoll <jk1135@ship.edu>
* @author Samuli Sillanpää <samuli.sillanpaa@helsinki.fi>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org/wiki/development Wiki
*/
class FeedbackController extends AbstractBase implements LoggerAwareInterface
{
use LoggerAwareTrait;
/**
* Feedback form class
*
* @var string
*/
protected $formClass = \VuFind\Form\Form::class;
/**
* Display Feedback home form.
*
* @return ViewModel
*/
public function homeAction()
{
return $this->forwardTo('Feedback', 'Form');
}
/**
* Handles rendering and submit of dynamic forms.
* Form configurations are specified in FeedbackForms.yaml.
*
* @return mixed
*/
public function formAction()
{
$formId = $this->params()->fromRoute('id', $this->params()->fromQuery('id'));
if (!$formId) {
$formId = 'FeedbackSite';
}
$user = $this->getUser() ?: null;
$form = $this->serviceLocator->get($this->formClass);
$prefill = $this->params()->fromQuery();
$params = [];
if ($refererHeader = $this->getRequest()->getHeader('Referer')) {
$params['referrer'] = $refererHeader->getFieldValue();
}
if ($userAgentHeader = $this->getRequest()->getHeader('User-Agent')) {
$params['userAgent'] = $userAgentHeader->getFieldValue();
}
$form->setFormId($formId, $params, $prefill);
if (!$form->isEnabled()) {
throw new \VuFind\Exception\Forbidden("Form '$formId' is disabled");
}
if (!$user && $form->showOnlyForLoggedUsers()) {
return $this->forceLogin();
}
$view = $this->createViewModel(compact('form', 'formId', 'user'));
$view->useCaptcha
= $this->captcha()->active('feedback') && $form->useCaptcha();
$params = $this->params();
$form->setData($params->fromPost());
if (!$this->formWasSubmitted(useCaptcha: $view->useCaptcha)) {
$form = $this->prefillUserInfo($form, $user);
return $view;
}
if (!$form->isValid()) {
return $view;
}
$primaryHandler = $form->getPrimaryHandler();
$success = $primaryHandler->handle($form, $params, $user);
if ($success) {
$view->setVariable('successMessage', $form->getSubmitResponse());
$view->setTemplate('feedback/response');
} else {
$this->flashMessenger()->addErrorMessage(
$this->translate('could_not_process_feedback')
);
}
$handlers = $form->getSecondaryHandlers();
foreach ($handlers as $handler) {
try {
$handler->handle($form, $params, $user);
} catch (\Exception $e) {
$this->logError($e->getMessage());
}
}
return $view;
}
/**
* Prefill form sender fields for logged in users.
*
* @param Form $form Form
* @param ?UserEntityInterface $user User
*
* @return Form
*/
protected function prefillUserInfo(Form $form, ?UserEntityInterface $user)
{
if ($user) {
$form->setData(
[
'name' => $user->getFirstname() . ' ' . $user->getLastname(),
'email' => $user->getEmail(),
]
);
}
return $form;
}
}