2021-06-26 17:23:15 +02:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Actions;
|
2017-01-13 17:15:48 +01:00
|
|
|
|
2020-11-22 01:17:45 +01:00
|
|
|
use BookStack\Entities\Models\Entity;
|
2020-11-08 00:15:13 +01:00
|
|
|
use BookStack\Facades\Activity as ActivityService;
|
2021-06-26 17:23:15 +02:00
|
|
|
use League\CommonMark\CommonMarkConverter;
|
2017-01-13 17:15:48 +01:00
|
|
|
|
|
|
|
/**
|
2021-06-26 17:23:15 +02:00
|
|
|
* Class CommentRepo.
|
2017-01-13 17:15:48 +01:00
|
|
|
*/
|
2018-01-28 17:58:52 +01:00
|
|
|
class CommentRepo
|
|
|
|
{
|
2017-01-13 17:15:48 +01:00
|
|
|
/**
|
2021-06-26 17:23:15 +02:00
|
|
|
* @var Comment
|
2017-01-13 17:15:48 +01:00
|
|
|
*/
|
|
|
|
protected $comment;
|
2017-04-18 21:51:45 +02:00
|
|
|
|
|
|
|
public function __construct(Comment $comment)
|
|
|
|
{
|
|
|
|
$this->comment = $comment;
|
|
|
|
}
|
|
|
|
|
2017-09-03 17:37:51 +02:00
|
|
|
/**
|
|
|
|
* Get a comment by ID.
|
|
|
|
*/
|
2020-05-02 00:24:11 +02:00
|
|
|
public function getById(int $id): Comment
|
2017-09-03 17:37:51 +02:00
|
|
|
{
|
|
|
|
return $this->comment->newQuery()->findOrFail($id);
|
2017-04-18 21:51:45 +02:00
|
|
|
}
|
|
|
|
|
2017-09-03 17:37:51 +02:00
|
|
|
/**
|
|
|
|
* Create a new comment on an entity.
|
|
|
|
*/
|
2020-05-02 00:24:11 +02:00
|
|
|
public function create(Entity $entity, string $text, ?int $parent_id): Comment
|
2017-09-03 17:37:51 +02:00
|
|
|
{
|
2017-04-18 21:51:45 +02:00
|
|
|
$userId = user()->id;
|
2020-05-02 00:24:11 +02:00
|
|
|
$comment = $this->comment->newInstance();
|
|
|
|
|
|
|
|
$comment->text = $text;
|
|
|
|
$comment->html = $this->commentToHtml($text);
|
2017-09-03 17:37:51 +02:00
|
|
|
$comment->created_by = $userId;
|
2017-04-18 21:51:45 +02:00
|
|
|
$comment->updated_by = $userId;
|
2017-09-03 17:37:51 +02:00
|
|
|
$comment->local_id = $this->getNextLocalId($entity);
|
2020-05-02 00:24:11 +02:00
|
|
|
$comment->parent_id = $parent_id;
|
|
|
|
|
2017-09-03 17:37:51 +02:00
|
|
|
$entity->comments()->save($comment);
|
2021-12-11 18:29:33 +01:00
|
|
|
ActivityService::add(ActivityType::COMMENTED_ON, $entity);
|
2021-06-26 17:23:15 +02:00
|
|
|
|
2017-06-04 15:22:44 +02:00
|
|
|
return $comment;
|
|
|
|
}
|
|
|
|
|
2017-09-03 17:37:51 +02:00
|
|
|
/**
|
|
|
|
* Update an existing comment.
|
|
|
|
*/
|
2020-05-02 00:24:11 +02:00
|
|
|
public function update(Comment $comment, string $text): Comment
|
2017-09-03 17:37:51 +02:00
|
|
|
{
|
|
|
|
$comment->updated_by = user()->id;
|
2020-05-02 00:24:11 +02:00
|
|
|
$comment->text = $text;
|
|
|
|
$comment->html = $this->commentToHtml($text);
|
|
|
|
$comment->save();
|
2021-06-26 17:23:15 +02:00
|
|
|
|
2017-04-18 21:51:45 +02:00
|
|
|
return $comment;
|
|
|
|
}
|
2017-05-15 21:10:14 +02:00
|
|
|
|
2017-09-03 17:37:51 +02:00
|
|
|
/**
|
|
|
|
* Delete a comment from the system.
|
|
|
|
*/
|
2021-11-01 12:17:30 +01:00
|
|
|
public function delete(Comment $comment): void
|
2017-09-03 17:37:51 +02:00
|
|
|
{
|
2020-05-02 00:24:11 +02:00
|
|
|
$comment->delete();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-11-01 12:17:30 +01:00
|
|
|
* Convert the given comment Markdown to HTML.
|
2020-05-02 00:24:11 +02:00
|
|
|
*/
|
2020-05-02 00:41:47 +02:00
|
|
|
public function commentToHtml(string $commentText): string
|
2020-05-02 00:24:11 +02:00
|
|
|
{
|
|
|
|
$converter = new CommonMarkConverter([
|
2021-06-26 17:23:15 +02:00
|
|
|
'html_input' => 'strip',
|
|
|
|
'max_nesting_level' => 10,
|
2020-05-02 00:24:11 +02:00
|
|
|
'allow_unsafe_links' => false,
|
|
|
|
]);
|
|
|
|
|
|
|
|
return $converter->convertToHtml($commentText);
|
2017-04-26 23:05:29 +02:00
|
|
|
}
|
2017-05-15 21:10:14 +02:00
|
|
|
|
2017-09-03 17:37:51 +02:00
|
|
|
/**
|
|
|
|
* Get the next local ID relative to the linked entity.
|
|
|
|
*/
|
2020-05-02 00:24:11 +02:00
|
|
|
protected function getNextLocalId(Entity $entity): int
|
2017-09-03 17:37:51 +02:00
|
|
|
{
|
2021-11-06 01:32:01 +01:00
|
|
|
/** @var Comment $comment */
|
|
|
|
$comment = $entity->comments(false)->orderBy('local_id', 'desc')->first();
|
2021-06-26 17:23:15 +02:00
|
|
|
|
2021-11-06 01:32:01 +01:00
|
|
|
return ($comment->local_id ?? 0) + 1;
|
2017-04-18 21:51:45 +02:00
|
|
|
}
|
2018-01-28 17:58:52 +01:00
|
|
|
}
|