-
Notifications
You must be signed in to change notification settings - Fork 348
/
CommentRecord.php
156 lines (142 loc) · 5.03 KB
/
CommentRecord.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
149
150
151
152
153
154
155
156
<?php
/**
* AJAX handler to comment on a record.
*
* PHP version 8
*
* Copyright (C) Villanova University 2018-2024.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2,
* as published by the Free Software Foundation.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* @category VuFind
* @package AJAX
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org/wiki/development Wiki
*/
namespace VuFind\AjaxHandler;
use Laminas\Mvc\Controller\Plugin\Params;
use VuFind\Config\AccountCapabilities;
use VuFind\Controller\Plugin\Captcha;
use VuFind\Db\Entity\UserEntityInterface;
use VuFind\Db\Service\CommentsServiceInterface;
use VuFind\Db\Table\Resource;
use VuFind\I18n\Translator\TranslatorAwareInterface;
use VuFind\Record\Loader as RecordLoader;
use function intval;
/**
* AJAX handler to comment on a record.
*
* @category VuFind
* @package AJAX
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org/wiki/development Wiki
*/
class CommentRecord extends AbstractBase implements TranslatorAwareInterface
{
use \VuFind\I18n\Translator\TranslatorAwareTrait;
/**
* Constructor
*
* @param Resource $table Resource database table
* @param CommentsServiceInterface $commentsService Comments database service
* @param Captcha $captcha Captcha controller plugin
* @param ?UserEntityInterface $user Logged in user (or null)
* @param bool $enabled Are comments enabled?
* @param RecordLoader $recordLoader Record loader
* @param AccountCapabilities $accountCapabilities Account capabilities helper
*/
public function __construct(
protected Resource $table,
protected CommentsServiceInterface $commentsService,
protected Captcha $captcha,
protected ?UserEntityInterface $user,
protected bool $enabled,
protected RecordLoader $recordLoader,
protected AccountCapabilities $accountCapabilities
) {
}
/**
* Is CAPTCHA valid? (Also returns true if CAPTCHA is disabled).
*
* @return bool
*/
protected function checkCaptcha()
{
// Not enabled? Report success!
if (!$this->captcha->active('userComments')) {
return true;
}
$this->captcha->setErrorMode('none');
return $this->captcha->verify();
}
/**
* Handle a request.
*
* @param Params $params Parameter helper from controller
*
* @return array [response data, HTTP status code]
*/
public function handleRequest(Params $params)
{
// Make sure comments are enabled:
if (!$this->enabled) {
return $this->formatResponse(
$this->translate('Comments disabled'),
self::STATUS_HTTP_BAD_REQUEST
);
}
if (!$this->user) {
return $this->formatResponse(
$this->translate('You must be logged in first'),
self::STATUS_HTTP_NEED_AUTH
);
}
$id = $params->fromPost('id');
$source = $params->fromPost('source', DEFAULT_SEARCH_BACKEND);
$comment = $params->fromPost('comment');
if (empty($id) || empty($comment)) {
return $this->formatResponse(
$this->translate('bulk_error_missing'),
self::STATUS_HTTP_BAD_REQUEST
);
}
$driver = $this->recordLoader->load($id, $source, false);
if (!$this->checkCaptcha()) {
return $this->formatResponse(
$this->translate('captcha_not_passed'),
self::STATUS_HTTP_FORBIDDEN
);
}
$resource = $this->table->findResource($id, $source);
$commentId = $this->commentsService->addComment(
$comment,
$this->user,
$resource
);
$rating = $params->fromPost('rating', '');
if (
$driver->isRatingAllowed()
&& ('' !== $rating
|| $this->accountCapabilities->isRatingRemovalAllowed())
) {
$driver->addOrUpdateRating(
$this->user->getId(),
'' === $rating ? null : intval($rating)
);
}
return $this->formatResponse(compact('commentId'));
}
}