375 lines
12 KiB
PHP
375 lines
12 KiB
PHP
<?php
|
|
|
|
// {{{ License
|
|
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
//
|
|
// GNU social 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.
|
|
//
|
|
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
// }}}
|
|
|
|
namespace App\Entity;
|
|
|
|
use App\Core\Cache;
|
|
use App\Core\DB\DB;
|
|
use App\Core\Entity;
|
|
use App\Core\Event;
|
|
use App\Core\GSFile;
|
|
use App\Core\VisibilityScope;
|
|
use DateTimeInterface;
|
|
|
|
/**
|
|
* Entity for notices
|
|
*
|
|
* @category DB
|
|
* @package GNUsocial
|
|
*
|
|
* @author Hugo Sales <hugo@hsal.es>
|
|
* @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
class Note extends Entity
|
|
{
|
|
// {{{ Autocode
|
|
// @codeCoverageIgnoreStart
|
|
private int $id;
|
|
private int $gsactor_id;
|
|
private string $content_type = 'text/plain';
|
|
private string $content;
|
|
private string $rendered;
|
|
private ?int $reply_to;
|
|
private ?bool $is_local;
|
|
private ?string $source;
|
|
private ?int $conversation;
|
|
private ?int $repeat_of;
|
|
private int $scope = VisibilityScope::PUBLIC;
|
|
private \DateTimeInterface $created;
|
|
private \DateTimeInterface $modified;
|
|
|
|
public function setId(int $id): self
|
|
{
|
|
$this->id = $id;
|
|
return $this;
|
|
}
|
|
|
|
public function getId(): int
|
|
{
|
|
return $this->id;
|
|
}
|
|
|
|
public function setGSActorId(int $gsactor_id): self
|
|
{
|
|
$this->gsactor_id = $gsactor_id;
|
|
return $this;
|
|
}
|
|
|
|
public function getGSActorId(): int
|
|
{
|
|
return $this->gsactor_id;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getContentType(): string
|
|
{
|
|
return $this->content_type;
|
|
}
|
|
|
|
/**
|
|
* @param string $content_type
|
|
*/
|
|
public function setContentType(string $content_type): self
|
|
{
|
|
$this->content_type = $content_type;
|
|
return $this;
|
|
}
|
|
|
|
public function setContent(?string $content): self
|
|
{
|
|
$this->content = $content;
|
|
return $this;
|
|
}
|
|
|
|
public function getContent(): ?string
|
|
{
|
|
return $this->content;
|
|
}
|
|
|
|
public function setRendered(?string $rendered): self
|
|
{
|
|
$this->rendered = $rendered;
|
|
return $this;
|
|
}
|
|
|
|
public function getRendered(): ?string
|
|
{
|
|
return $this->rendered;
|
|
}
|
|
|
|
public function setReplyTo(?int $reply_to): self
|
|
{
|
|
$this->reply_to = $reply_to;
|
|
return $this;
|
|
}
|
|
|
|
public function getReplyTo(): ?int
|
|
{
|
|
return $this->reply_to;
|
|
}
|
|
|
|
public function setIsLocal(?bool $is_local): self
|
|
{
|
|
$this->is_local = $is_local;
|
|
return $this;
|
|
}
|
|
|
|
public function getIsLocal(): ?bool
|
|
{
|
|
return $this->is_local;
|
|
}
|
|
|
|
public function setSource(?string $source): self
|
|
{
|
|
$this->source = $source;
|
|
return $this;
|
|
}
|
|
|
|
public function getSource(): ?string
|
|
{
|
|
return $this->source;
|
|
}
|
|
|
|
public function setConversation(?int $conversation): self
|
|
{
|
|
$this->conversation = $conversation;
|
|
return $this;
|
|
}
|
|
|
|
public function getConversation(): ?int
|
|
{
|
|
return $this->conversation;
|
|
}
|
|
|
|
public function setRepeatOf(?int $repeat_of): self
|
|
{
|
|
$this->repeat_of = $repeat_of;
|
|
return $this;
|
|
}
|
|
|
|
public function getRepeatOf(): ?int
|
|
{
|
|
return $this->repeat_of;
|
|
}
|
|
|
|
public function setScope(int $scope): self
|
|
{
|
|
$this->scope = $scope;
|
|
return $this;
|
|
}
|
|
|
|
public function getScope(): int
|
|
{
|
|
return $this->scope;
|
|
}
|
|
|
|
public function setCreated(DateTimeInterface $created): self
|
|
{
|
|
$this->created = $created;
|
|
return $this;
|
|
}
|
|
|
|
public function getCreated(): DateTimeInterface
|
|
{
|
|
return $this->created;
|
|
}
|
|
|
|
public function setModified(DateTimeInterface $modified): self
|
|
{
|
|
$this->modified = $modified;
|
|
return $this;
|
|
}
|
|
|
|
public function getModified(): DateTimeInterface
|
|
{
|
|
return $this->modified;
|
|
}
|
|
|
|
// @codeCoverageIgnoreEnd
|
|
// }}} Autocode
|
|
|
|
public function getActor(): GSActor
|
|
{
|
|
return GSActor::getFromId($this->gsactor_id);
|
|
}
|
|
|
|
public function getActorNickname(): string
|
|
{
|
|
return GSActor::getNicknameFromId($this->gsactor_id);
|
|
}
|
|
|
|
public function getAvatarUrl()
|
|
{
|
|
$url = null;
|
|
Event::handle('GetAvatarUrl', [$this->getGSActorId(), &$url]);
|
|
return $url;
|
|
}
|
|
|
|
public static function getAllNotes(int $noteScope): array
|
|
{
|
|
return DB::sql('select * from note n ' .
|
|
'where n.reply_to is null and (n.scope & :notescope) <> 0 ' .
|
|
'order by n.created DESC',
|
|
['n' => 'App\Entity\Note'],
|
|
['notescope' => $noteScope]
|
|
);
|
|
}
|
|
|
|
public function getAttachments(): array
|
|
{
|
|
return Cache::get('note-attachments-' . $this->id, function () {
|
|
return DB::dql(
|
|
'select att from App\Entity\Attachment att ' .
|
|
'join App\Entity\AttachmentToNote atn with atn.attachment_id = att.id ' .
|
|
'where atn.note_id = :note_id',
|
|
['note_id' => $this->id]
|
|
);
|
|
});
|
|
}
|
|
|
|
public function getLinks(): array
|
|
{
|
|
return Cache::get('note-links-' . $this->id, function () {
|
|
return DB::dql(
|
|
'select l from App\Entity\Link l ' .
|
|
'join App\Entity\NoteToLink ntl with ntl.link_id = l.id ' .
|
|
'where ntl.note_id = :note_id',
|
|
['note_id' => $this->id]
|
|
);
|
|
});
|
|
}
|
|
|
|
public function getReplies(): array
|
|
{
|
|
return Cache::getList('note-replies-' . $this->id, function () {
|
|
return DB::dql('select n from App\Entity\Note n where n.reply_to = :id', ['id' => $this->id]);
|
|
});
|
|
}
|
|
|
|
public function getReplyToNickname(): ?string
|
|
{
|
|
if (!empty($this->reply_to)) {
|
|
return Cache::get('note-reply-to-' . $this->id, function () {
|
|
return DB::dql('select g from App\Entity\Note n join ' .
|
|
'App\Entity\GSActor g with n.gsactor_id = g.id where n.reply_to = :reply',
|
|
['reply' => $this->reply_to])[0]->getNickname();
|
|
});
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Whether this note is visible to the given actor
|
|
*/
|
|
public function isVisibleTo(GSActor | LocalUser $a): bool
|
|
{
|
|
$scope = VisibilityScope::create($this->scope);
|
|
return $scope->public
|
|
|| ($scope->follower
|
|
&& null != DB::find('follow', ['follower' => $a->getId(), 'followed' => $this->gsactor_id]))
|
|
|| ($scope->addressee
|
|
&& null != DB::find('notification', ['activity_id' => $this->id, 'gsactor_id' => $a->getId()]))
|
|
|| ($scope->group && [] != DB::dql('select m from group_member m ' .
|
|
'join group_inbox i with m.group_id = i.group_id ' .
|
|
'join note n with i.activity_id = n.id ' .
|
|
'where n.id = :note_id and m.gsactor_id = :actor_id',
|
|
['note_id' => $this->id, 'actor_id' => $a->getId()]));
|
|
}
|
|
|
|
/**
|
|
* Create an instance of NoteToLink or fill in the
|
|
* properties of $obj with the associative array $args. Does
|
|
* persist the result
|
|
*/
|
|
public static function create(array $args, mixed $obj = null): self
|
|
{
|
|
/** @var \Symfony\Component\HttpFoundation\File\UploadedFile[] $attachments */
|
|
$attachments = $args['attachments'];
|
|
unset($args['attachments']);
|
|
|
|
$note = parent::create($args, new self());
|
|
|
|
$processed_attachments = [];
|
|
foreach ($attachments as $f) {
|
|
Event::handle('EnforceUserFileQuota', [$f->getSize(), $args['gsactor_id']]);
|
|
$processed_attachments[] = [GSFile::sanitizeAndStoreFileAsAttachment($f), $f->getClientOriginalName()];
|
|
}
|
|
|
|
// Need file and note ids for the next step
|
|
DB::persist($note);
|
|
|
|
if ($processed_attachments != []) {
|
|
foreach ($processed_attachments as [$a, $fname]) {
|
|
if (DB::count('gsactor_to_attachment', $args = ['attachment_id' => $a->getId(), 'gsactor_id' => $args['gsactor_id']]) === 0) {
|
|
DB::persist(GSActorToAttachment::create($args));
|
|
}
|
|
DB::persist(AttachmentToNote::create(['attachment_id' => $a->getId(), 'note_id' => $note->getId(), 'title' => $fname]));
|
|
}
|
|
}
|
|
|
|
return $note;
|
|
}
|
|
|
|
/**
|
|
* @return GSActor[]
|
|
*/
|
|
public function getAttentionProfiles(): array
|
|
{
|
|
// TODO implement
|
|
return [];
|
|
}
|
|
|
|
public static function schemaDef(): array
|
|
{
|
|
return [
|
|
'name' => 'note',
|
|
'fields' => [
|
|
'id' => ['type' => 'serial', 'not null' => true],
|
|
'gsactor_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'GSActor.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'who made the note'],
|
|
'content' => ['type' => 'text', 'not null' => true, 'description' => 'note content'],
|
|
'content_type' => ['type' => 'varchar', 'not null' => true, 'default' => 'text/plain', 'length' => 129, 'description' => 'A note can be written in a multitude of formats such as text/plain, text/markdown, application/x-latex, and text/html'],
|
|
'rendered' => ['type' => 'text', 'description' => 'rendered note content, so we can keep the microtags (if not local)'],
|
|
'reply_to' => ['type' => 'int', 'foreign key' => true, 'target' => 'Note.id', 'multiplicity' => 'one to one', 'description' => 'note replied to, null if root of a conversation'],
|
|
'is_local' => ['type' => 'bool', 'description' => 'was this note generated by a local actor'],
|
|
'source' => ['type' => 'varchar', 'foreign key' => true, 'length' => 32, 'target' => 'NoteSource.code', 'multiplicity' => 'many to one', 'description' => 'fkey to source of note, like "web", "im", or "clientname"'],
|
|
'conversation' => ['type' => 'int', 'foreign key' => true, 'target' => 'Conversation.id', 'multiplicity' => 'one to one', 'description' => 'the local conversation id'],
|
|
'repeat_of' => ['type' => 'int', 'foreign key' => true, 'target' => 'Note.id', 'multiplicity' => 'one to one', 'description' => 'note this is a repeat of'],
|
|
'scope' => ['type' => 'int', 'not null' => true, 'default' => VisibilityScope::PUBLIC, 'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = groups; 8 = followers; 16 = messages; null = default'],
|
|
'created' => ['type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
|
|
'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
|
|
],
|
|
'primary key' => ['id'],
|
|
'indexes' => [
|
|
'note_created_id_is_local_idx' => ['created', 'is_local'],
|
|
'note_gsactor_created_idx' => ['gsactor_id', 'created'],
|
|
'note_is_local_created_gsactor_idx' => ['is_local', 'created', 'gsactor_id'],
|
|
'note_repeat_of_created_idx' => ['repeat_of', 'created'],
|
|
'note_conversation_created_idx' => ['conversation', 'created'],
|
|
'note_reply_to_idx' => ['reply_to'],
|
|
],
|
|
'fulltext indexes' => ['notice_fulltext_idx' => ['content']],
|
|
];
|
|
}
|
|
}
|