mirror of
https://github.com/Karaka-Management/oms-Comments.git
synced 2026-01-11 16:18:41 +00:00
467 lines
14 KiB
PHP
467 lines
14 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Jingga
|
|
*
|
|
* PHP Version 8.2
|
|
*
|
|
* @package Modules\Comments
|
|
* @copyright Dennis Eichhorn
|
|
* @license OMS License 2.2
|
|
* @version 1.0.0
|
|
* @link https://jingga.app
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace Modules\Comments\Controller;
|
|
|
|
use Modules\Admin\Models\AccountMapper;
|
|
use Modules\Admin\Models\NullAccount;
|
|
use Modules\Comments\Models\Comment;
|
|
use Modules\Comments\Models\CommentList;
|
|
use Modules\Comments\Models\CommentListMapper;
|
|
use Modules\Comments\Models\CommentMapper;
|
|
use Modules\Comments\Models\CommentStatus;
|
|
use Modules\Comments\Models\CommentVote;
|
|
use Modules\Comments\Models\CommentVoteMapper;
|
|
use Modules\Media\Models\Media;
|
|
use phpOMS\Message\Http\RequestStatusCode;
|
|
use phpOMS\Message\RequestAbstract;
|
|
use phpOMS\Message\ResponseAbstract;
|
|
use phpOMS\Utils\Parser\Markdown\Markdown;
|
|
|
|
/**
|
|
* Comments controller class.
|
|
*
|
|
* @package Modules\Comments
|
|
* @license OMS License 2.2
|
|
* @link https://jingga.app
|
|
* @since 1.0.0
|
|
*/
|
|
final class ApiController extends Controller
|
|
{
|
|
/**
|
|
* Api method to create comment list
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiCommentListCreate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
$commentList = $this->createCommentList();
|
|
$this->createModel($request->header->account, $commentList, CommentListMapper::class, 'comment_list', $request->getOrigin());
|
|
$this->createStandardCreateResponse($request, $response, $commentList);
|
|
}
|
|
|
|
/**
|
|
* Create a comment list
|
|
*
|
|
* @return CommentList
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function createCommentList() : CommentList
|
|
{
|
|
return new CommentList();
|
|
}
|
|
|
|
/**
|
|
* Api method to update comment list
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiCommentListUpdate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (!empty($val = $this->validateCommentListUpdate($request))) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidUpdateResponse($request, $response, $val);
|
|
|
|
return;
|
|
}
|
|
|
|
/** @var \Modules\Comments\Models\CommentList $old */
|
|
$old = CommentListMapper::get()->where('id', $request->getDataInt('id') ?? 0)->execute();
|
|
$new = $this->updateCommentListFromRequest($request, clone $old);
|
|
|
|
$this->updateModel($request->header->account, $old, $new, CommentListMapper::class, 'comment_list', $request->getOrigin());
|
|
$this->createStandardUpdateResponse($request, $response, $new);
|
|
}
|
|
|
|
/**
|
|
* Method to update comment from request.
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return CommentList
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function updateCommentListFromRequest(RequestAbstract $request, CommentList $new) : CommentList
|
|
{
|
|
$new->allowEdit = $request->getDataBool('allow_edit') ?? false;
|
|
$new->allowVoting = $request->getDataBool('allow_voting') ?? false;
|
|
$new->allowFiles = $request->getDataBool('allow_upload') ?? false;
|
|
$new->status = CommentStatus::tryFromValue($request->getDataInt('commentlist_status')) ?? $new->status;
|
|
|
|
return $new;
|
|
}
|
|
|
|
/**
|
|
* Validate CommentList update request
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return array<string, bool>
|
|
*
|
|
* @todo Implement API validation function
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function validateCommentListUpdate(RequestAbstract $request) : array
|
|
{
|
|
$val = [];
|
|
if (($val['id'] = !$request->hasData('id'))) {
|
|
return $val;
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Api method to create comment
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiCommentCreate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (!empty($val = $this->validateCommentCreate($request))) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidCreateResponse($request, $response, $val);
|
|
|
|
return;
|
|
}
|
|
|
|
$comment = $this->createCommentFromRequest($request);
|
|
$this->createModel($request->header->account, $comment, CommentMapper::class, 'comment', $request->getOrigin());
|
|
|
|
if (!empty($request->files)
|
|
|| !empty($request->getDataJson('media'))
|
|
) {
|
|
$this->createCommentMedia($comment, $request);
|
|
}
|
|
|
|
$this->createStandardCreateResponse($request, $response, $comment);
|
|
}
|
|
|
|
/**
|
|
* Create media for comment
|
|
*
|
|
* @param Comment $comment Comment
|
|
* @param RequestAbstract $request Request data incl. files to upload
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function createCommentMedia(Comment $comment, RequestAbstract $request) : void
|
|
{
|
|
$path = $this->createCommentDir($comment);
|
|
|
|
/** @var \Modules\Admin\Models\Account $account */
|
|
$account = AccountMapper::get()->where('id', $request->header->account)->execute();
|
|
$accountPath = '/Accounts/' . $account->id . ' ' . $account->login
|
|
. '/Comments/'
|
|
. $comment->createdAt->format('Y/m')
|
|
. '/' . $comment->id;
|
|
|
|
if (!empty($request->files)) {
|
|
$uploaded = $this->app->moduleManager->get('Media', 'Api')->uploadFiles(
|
|
names: [],
|
|
fileNames: [],
|
|
files: $request->files,
|
|
account: $request->header->account,
|
|
basePath: __DIR__ . '/../../../Modules/Media/Files' . $path,
|
|
virtualPath: $path,
|
|
rel: $comment->id,
|
|
mapper: CommentMapper::class,
|
|
field: 'files'
|
|
);
|
|
|
|
if ($account->id !== 0) {
|
|
$this->app->moduleManager->get('Media', 'Api')->addMediaToCollectionAndModel(
|
|
account: $request->header->account,
|
|
files: \array_map(function (Media $media) { return $media->id; }, $uploaded->sources),
|
|
collectionPath: $accountPath
|
|
);
|
|
}
|
|
}
|
|
|
|
if (!empty($media = $request->getDataJson('media'))) {
|
|
$this->app->moduleManager->get('Media', 'Api')->addMediaToCollectionAndModel(
|
|
$request->header->account,
|
|
$media,
|
|
$comment->id,
|
|
CommentMapper::class,
|
|
'files',
|
|
$path
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create media directory path
|
|
*
|
|
* @param Comment $comment Comment
|
|
*
|
|
* @return string
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function createCommentDir(Comment $comment) : string
|
|
{
|
|
return '/Modules/Comments/'
|
|
. $comment->createdAt->format('Y/m/d') . '/'
|
|
. $comment->id;
|
|
}
|
|
|
|
/**
|
|
* Validate comment create request
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return array<string, bool>
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function validateCommentCreate(RequestAbstract $request) : array
|
|
{
|
|
$val = [];
|
|
if (($val['plain'] = !$request->hasData('plain'))
|
|
|| ($val['list'] = !$request->hasData('list'))
|
|
) {
|
|
return $val;
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Method to create comment from request.
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return Comment
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function createCommentFromRequest(RequestAbstract $request) : Comment
|
|
{
|
|
$comment = new Comment();
|
|
$comment->createdBy = new NullAccount($request->header->account);
|
|
$comment->title = $request->getDataString('title') ?? '';
|
|
$comment->contentRaw = $request->getDataString('plain') ?? '';
|
|
$comment->content = Markdown::parse($request->getDataString('plain') ?? '');
|
|
$comment->ref = $request->hasData('ref') ? (int) $request->getData('ref') : null;
|
|
$comment->list = $request->getDataInt('list') ?? 0;
|
|
|
|
return $comment;
|
|
}
|
|
|
|
/**
|
|
* Api method to create comment
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiCommentUpdate(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (!empty($val = $this->validateCommentUpdate($request))) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidUpdateResponse($request, $response, $val);
|
|
|
|
return;
|
|
}
|
|
|
|
/** @var \Modules\Comments\Models\Comment $old */
|
|
$old = CommentMapper::get()->where('id', $request->getDataInt('id') ?? 0)->execute();
|
|
$new = $this->updateCommentFromRequest($request, clone $old);
|
|
|
|
$this->updateModel($request->header->account, $old, $new, CommentMapper::class, 'comment', $request->getOrigin());
|
|
$this->createStandardUpdateResponse($request, $response, $new);
|
|
}
|
|
|
|
/**
|
|
* Method to update comment from request.
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return Comment
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function updateCommentFromRequest(RequestAbstract $request, Comment $new) : Comment
|
|
{
|
|
$new->title = $request->getDataString('title') ?? $new->title;
|
|
$new->contentRaw = $request->getDataString('plain') ?? $new->contentRaw;
|
|
$new->content = Markdown::parse($request->getDataString('plain') ?? $new->contentRaw);
|
|
$new->ref = $request->getDataInt('ref') ?? $new->ref;
|
|
|
|
return $new;
|
|
}
|
|
|
|
/**
|
|
* Validate CommentList update request
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return array<string, bool>
|
|
*
|
|
* @todo Implement API validation function
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function validateCommentUpdate(RequestAbstract $request) : array
|
|
{
|
|
$val = [];
|
|
if (($val['id'] = !$request->hasData('id'))) {
|
|
return $val;
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Api method to get a comment
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiCommentGet(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
/** @var \Modules\Comments\Models\Comment $comment */
|
|
$comment = CommentMapper::get()->where('id', $request->getDataInt('id') ?? 0)->execute();
|
|
$this->createStandardReturnResponse($request, $response, $comment);
|
|
}
|
|
|
|
/**
|
|
* Api method to delete comment
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiCommentDelete(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
/** @var \Modules\Comments\Models\Comment $comment */
|
|
$comment = CommentMapper::get()->where('id', $request->getDataInt('id') ?? 0)->execute();
|
|
$this->deleteModel($request->header->account, $comment, CommentMapper::class, 'comment', $request->getOrigin());
|
|
$this->createStandardDeleteResponse($request, $response, $comment);
|
|
}
|
|
|
|
/**
|
|
* Api method to change vote
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
* @param ResponseAbstract $response Response
|
|
* @param array $data Generic data
|
|
*
|
|
* @return void
|
|
*
|
|
* @api
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function apiChangeCommentVote(RequestAbstract $request, ResponseAbstract $response, array $data = []) : void
|
|
{
|
|
if (!empty($val = $this->validateCommentVote($request))) {
|
|
$response->header->status = RequestStatusCode::R_400;
|
|
$this->createInvalidUpdateResponse($request, $response, $val);
|
|
|
|
return;
|
|
}
|
|
|
|
/** @var \Modules\Comments\Models\CommentVote $vote */
|
|
$vote = CommentVoteMapper::findVote($request->getDataInt('id') ?? 0, $request->header->account);
|
|
|
|
if ($vote->id === 0) {
|
|
$new = new CommentVote();
|
|
$new->score = (int) $request->getData('type');
|
|
$new->comment = $request->getDataInt('id') ?? 0;
|
|
$new->createdBy = $request->header->account;
|
|
|
|
$this->createModel($request->header->account, $new, CommentVoteMapper::class, 'comment_vote', $request->getOrigin());
|
|
$this->createStandardUpdateResponse($request, $response, $new);
|
|
} else {
|
|
$new = clone $vote;
|
|
$new->score = (int) $request->getData('type');
|
|
|
|
$this->updateModel($request->header->account, $vote, $new, CommentVoteMapper::class, 'comment_vote', $request->getOrigin());
|
|
$this->createStandardUpdateResponse($request, $response, $new);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Validate answer vote request
|
|
*
|
|
* @param RequestAbstract $request Request
|
|
*
|
|
* @return array<string, bool> Returns the validation array of the request
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
private function validateCommentVote(RequestAbstract $request) : array
|
|
{
|
|
$val = [];
|
|
if (($val['id'] = !$request->hasData('id'))
|
|
|| ($val['type'] = ($request->getDataInt('type') < -1 || $request->getDataInt('type') > 1))
|
|
) {
|
|
return $val;
|
|
}
|
|
|
|
return [];
|
|
}
|
|
}
|