2020-03-29 20:56:35 +01:00
< ? php
2021-10-21 13:49:41 +01:00
declare ( strict_types = 1 );
2020-03-29 20:56:35 +01:00
// {{{ License
2020-06-30 17:26:40 +01:00
2020-05-20 17:53:53 +01:00
// This file is part of GNU social - https://www.gnu.org/software/social
2020-03-29 20:56:35 +01:00
//
// GNU social is free software: you can redistribute it and/or modify
2020-05-10 21:43:15 +01:00
// it under the terms of the GNU Affero General Public License as published by
2020-03-29 20:56:35 +01:00
// 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.
//
2020-05-10 21:43:15 +01:00
// You should have received a copy of the GNU Affero General Public License
2020-03-29 20:56:35 +01:00
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
2020-06-30 17:26:40 +01:00
2020-03-29 20:56:35 +01:00
// }}}
namespace App\Entity ;
2020-08-28 21:16:26 +01:00
use App\Core\Cache ;
2020-08-15 06:47:45 +01:00
use App\Core\DB\DB ;
use App\Core\Entity ;
2021-04-15 23:28:28 +01:00
use App\Core\VisibilityScope ;
2021-09-18 04:54:35 +01:00
use Component\Avatar\Avatar ;
2020-05-10 21:43:15 +01:00
use DateTimeInterface ;
2020-03-29 20:56:35 +01:00
/**
* Entity for notices
*
* @ category DB
* @ package GNUsocial
*
2021-02-19 23:29:43 +00:00
* @ author Hugo Sales < hugo @ hsal . es >
* @ copyright 2020 - 2021 Free Software Foundation , Inc http :// www . fsf . org
2020-03-29 20:56:35 +01:00
* @ license https :// www . gnu . org / licenses / agpl . html GNU AGPL v3 or later
*/
2021-09-09 03:46:30 +01:00
class Note extends Entity
2020-03-29 20:56:35 +01:00
{
2020-03-30 15:00:13 +01:00
// {{{ Autocode
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreStart
2020-03-30 16:13:51 +01:00
private int $id ;
2021-09-18 03:22:27 +01:00
private int $actor_id ;
2021-09-20 17:06:21 +01:00
private ? string $content_type = null ;
private ? string $content = null ;
private ? string $rendered = null ;
2020-03-30 16:13:51 +01:00
private ? int $reply_to ;
2020-06-30 19:20:50 +01:00
private ? bool $is_local ;
2020-03-30 16:13:51 +01:00
private ? string $source ;
private ? int $conversation ;
private ? int $repeat_of ;
2021-09-09 03:46:30 +01:00
private int $scope = VisibilityScope :: PUBLIC ;
2021-10-04 17:00:58 +01:00
private string $url ;
2021-10-21 13:49:41 +01:00
private string $language ;
private DateTimeInterface $created ;
private DateTimeInterface $modified ;
2020-03-30 16:13:51 +01:00
public function setId ( int $id ) : self
{
$this -> id = $id ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getId () : int
{
return $this -> id ;
}
2021-09-18 03:22:27 +01:00
public function setActorId ( int $actor_id ) : self
2020-03-30 16:13:51 +01:00
{
2021-09-18 03:22:27 +01:00
$this -> actor_id = $actor_id ;
2020-03-30 16:13:51 +01:00
return $this ;
}
2020-08-08 17:11:18 +01:00
2021-09-18 03:22:27 +01:00
public function getActorId () : int
2020-03-30 16:13:51 +01:00
{
2021-09-18 03:22:27 +01:00
return $this -> actor_id ;
2020-03-30 16:13:51 +01:00
}
2021-09-09 03:46:30 +01:00
public function getContentType () : string
{
return $this -> content_type ;
}
/**
2021-09-18 03:22:27 +01:00
* @ return Note
2021-09-09 03:46:30 +01:00
*/
public function setContentType ( string $content_type ) : self
{
$this -> content_type = $content_type ;
return $this ;
}
2020-03-30 16:13:51 +01:00
public function setContent ( ? string $content ) : self
{
$this -> content = $content ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getContent () : ? string
{
return $this -> content ;
}
2020-09-05 21:46:37 +01:00
public function setRendered ( ? string $rendered ) : self
{
$this -> rendered = $rendered ;
return $this ;
}
public function getRendered () : ? string
{
return $this -> rendered ;
}
2020-03-30 16:13:51 +01:00
public function setReplyTo ( ? int $reply_to ) : self
{
$this -> reply_to = $reply_to ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getReplyTo () : ? int
{
return $this -> reply_to ;
}
2020-06-30 19:20:50 +01:00
public function setIsLocal ( ? bool $is_local ) : self
2020-03-30 16:13:51 +01:00
{
$this -> is_local = $is_local ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-06-30 19:20:50 +01:00
public function getIsLocal () : ? bool
2020-03-30 16:13:51 +01:00
{
return $this -> is_local ;
}
public function setSource ( ? string $source ) : self
{
$this -> source = $source ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getSource () : ? string
{
return $this -> source ;
}
public function setConversation ( ? int $conversation ) : self
{
$this -> conversation = $conversation ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getConversation () : ? int
{
return $this -> conversation ;
}
public function setRepeatOf ( ? int $repeat_of ) : self
{
$this -> repeat_of = $repeat_of ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getRepeatOf () : ? int
{
return $this -> repeat_of ;
}
2020-09-05 03:33:29 +01:00
public function setScope ( int $scope ) : self
2020-03-30 16:13:51 +01:00
{
$this -> scope = $scope ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-09-05 03:33:29 +01:00
public function getScope () : int
2020-03-30 16:13:51 +01:00
{
return $this -> scope ;
}
2021-10-04 17:00:58 +01:00
public function getUrl () : string
{
return $this -> url ;
}
public function setUrl ( string $url ) : self
{
$this -> url = $url ;
return $this ;
}
2021-10-21 13:49:41 +01:00
public function getLanguage () : string
{
return $this -> language ;
}
public function setLanguage ( string $language ) : self
{
$this -> language = $language ;
return $this ;
}
2021-05-05 17:03:03 +01:00
public function setCreated ( DateTimeInterface $created ) : self
2020-06-30 19:20:50 +01:00
{
$this -> created = $created ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2021-05-05 17:03:03 +01:00
public function getCreated () : DateTimeInterface
2020-06-30 19:20:50 +01:00
{
return $this -> created ;
}
2021-05-05 17:03:03 +01:00
public function setModified ( DateTimeInterface $modified ) : self
2020-06-30 19:20:50 +01:00
{
$this -> modified = $modified ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2021-05-05 17:03:03 +01:00
public function getModified () : DateTimeInterface
2020-06-30 19:20:50 +01:00
{
return $this -> modified ;
}
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreEnd
2020-03-30 15:00:13 +01:00
// }}} Autocode
2020-03-29 20:56:35 +01:00
2021-09-18 03:22:27 +01:00
public function getActor () : Actor
2021-09-14 13:40:50 +01:00
{
2021-10-04 17:00:58 +01:00
return Actor :: getById ( $this -> actor_id );
2021-09-14 13:40:50 +01:00
}
public function getActorNickname () : string
2020-08-15 06:47:45 +01:00
{
2021-10-04 17:00:58 +01:00
return Actor :: getNicknameById ( $this -> actor_id );
2020-08-19 16:31:52 +01:00
}
2021-10-26 14:47:28 +01:00
public function getActorFullname () : string
{
return Actor :: getFullnameById ( $this -> actor_id );
}
2021-09-18 04:54:35 +01:00
public function getActorAvatarUrl ( string $size = 'full' ) : string
2020-08-19 16:31:52 +01:00
{
2021-09-18 04:54:35 +01:00
return Avatar :: getAvatarUrl ( $this -> getActorId (), $size );
2020-08-15 06:47:45 +01:00
}
2021-09-14 13:40:50 +01:00
2021-04-10 23:32:47 +01:00
public static function getAllNotes ( int $noteScope ) : array
2020-12-02 22:57:32 +00:00
{
2021-10-21 13:49:41 +01:00
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 ],
2020-12-02 22:57:32 +00:00
);
}
2020-08-15 06:47:45 +01:00
2020-08-28 21:16:26 +01:00
public function getAttachments () : array
{
return Cache :: get ( 'note-attachments-' . $this -> id , function () {
return DB :: dql (
2021-10-21 13:49:41 +01:00
'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 ],
);
2020-08-28 21:16:26 +01:00
});
}
2021-08-14 15:07:51 +01:00
public function getLinks () : array
{
return Cache :: get ( 'note-links-' . $this -> id , function () {
return DB :: dql (
2021-10-21 13:49:41 +01:00
'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 ],
2021-08-14 15:07:51 +01:00
);
});
}
2020-08-28 21:16:26 +01:00
public function getReplies () : array
{
2021-10-21 13:49:41 +01:00
return Cache :: getList ( 'note-replies-' . $this -> id , fn () => DB :: dql ( 'select n from App\Entity\Note n where n.reply_to = :id' , [ 'id' => $this -> id ]));
2020-09-06 22:34:36 +01:00
}
public function getReplyToNickname () : ? string
{
if ( ! empty ( $this -> reply_to )) {
return Cache :: get ( 'note-reply-to-' . $this -> id , function () {
2021-10-21 13:49:41 +01:00
return DB :: dql (
'select g from App\Entity\Note n join '
. 'App\Entity\Actor g with n.actor_id = g.id where n.reply_to = :reply' ,
[ 'reply' => $this -> reply_to ],
)[ 0 ] -> getNickname ();
2020-09-06 22:34:36 +01:00
});
}
return null ;
2020-08-28 21:16:26 +01:00
}
2020-11-06 19:47:15 +00:00
/**
* Whether this note is visible to the given actor
*/
2021-09-21 16:38:50 +01:00
public function isVisibleTo ( null | Actor | LocalUser $a ) : bool
2020-09-10 23:27:23 +01:00
{
2021-09-21 16:38:50 +01:00
// TODO cache this
2021-04-15 23:28:28 +01:00
$scope = VisibilityScope :: create ( $this -> scope );
2020-09-10 23:27:23 +01:00
return $scope -> public
2021-10-21 13:49:41 +01:00
|| ( ! \is_null ( $a ) && (
2021-09-21 16:38:50 +01:00
( $scope -> follower && 0 != DB :: count ( 'follow' , [ 'follower' => $a -> getId (), 'followed' => $this -> actor_id ]))
|| ( $scope -> addressee && 0 != DB :: count ( 'notification' , [ 'activity_id' => $this -> id , 'actor_id' => $a -> getId ()]))
2021-10-21 13:49:41 +01:00
|| ( $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.actor_id = :actor_id' ,
[ 'note_id' => $this -> id , 'actor_id' => $a -> getId ()],
))
2021-09-21 16:38:50 +01:00
));
2020-09-10 23:27:23 +01:00
}
2021-09-14 13:40:50 +01:00
/**
2021-09-18 03:22:27 +01:00
* @ return Actor []
2021-09-14 13:40:50 +01:00
*/
public function getAttentionProfiles () : array
{
// TODO implement
return [];
}
2020-03-29 20:56:35 +01:00
public static function schemaDef () : array
{
2020-08-15 06:47:45 +01:00
return [
2020-08-13 00:57:22 +01:00
'name' => 'note' ,
2020-03-29 20:56:35 +01:00
'fields' => [
2021-02-22 21:34:59 +00:00
'id' => [ 'type' => 'serial' , 'not null' => true ],
2021-09-18 03:22:27 +01:00
'actor_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'Actor.id' , 'multiplicity' => 'one to one' , 'not null' => true , 'description' => 'who made the note' ],
2021-09-20 17:06:21 +01:00
'content' => [ 'type' => 'text' , 'description' => 'note content' ],
'content_type' => [ 'type' => 'varchar' , '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' ],
2021-02-22 21:34:59 +00:00
'rendered' => [ 'type' => 'text' , 'description' => 'rendered note content, so we can keep the microtags (if not local)' ],
2021-03-11 22:16:17 +00:00
'reply_to' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'Note.id' , 'multiplicity' => 'one to one' , 'description' => 'note replied to, null if root of a conversation' ],
2021-02-22 21:34:59 +00:00
'is_local' => [ 'type' => 'bool' , 'description' => 'was this note generated by a local actor' ],
2021-03-22 12:14:09 +00:00
'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"' ],
2021-03-11 22:16:17 +00:00
'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' ],
2021-04-15 23:28:28 +01:00
'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' ],
2021-10-04 17:00:58 +01:00
'url' => [ 'type' => 'text' , 'description' => 'Permalink to Note' ],
2021-10-21 13:49:41 +01:00
'language' => [ 'type' => 'varchar' , 'length' => 10 , 'description' => 'The locale identifier for the language of a note. 2-leter-iso-language-code_4-leter-script-code_2-leter-iso-country-code' ],
2020-06-30 17:26:40 +01:00
'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' ],
2020-03-29 20:56:35 +01:00
],
2021-02-22 21:34:59 +00:00
'primary key' => [ 'id' ],
'indexes' => [
2021-09-18 03:22:27 +01:00
'note_created_id_is_local_idx' => [ 'created' , 'is_local' ],
'note_actor_created_idx' => [ 'actor_id' , 'created' ],
'note_is_local_created_actor_idx' => [ 'is_local' , 'created' , 'actor_id' ],
'note_repeat_of_created_idx' => [ 'repeat_of' , 'created' ],
'note_conversation_created_idx' => [ 'conversation' , 'created' ],
'note_reply_to_idx' => [ 'reply_to' ],
2020-03-29 20:56:35 +01:00
],
2020-08-13 00:57:22 +01:00
'fulltext indexes' => [ 'notice_fulltext_idx' => [ 'content' ]],
2020-03-29 20:56:35 +01:00
];
}
}