castopod/app/Libraries/ActivityPub/Entities/Note.php
Yassine Doghri 2f525c0f6e feat(fediverse): implement activitypub protocols + update user interface
- add "ActivityPub" library to handle server to server federation and basic
  client to server protocols using activitypub:
  - add webfinger endpoint to look for actor
  - add actor definition with inbox / outbox / followers
  - remote follow an actor
  - create notes with possible preview cards
  - interract with favourites, reblogs and replies
  - block incoming actors and/or domains
  - broadcast/schedule activities to fediverse followers using a cron task
- For castopod, the podcast is the actor:
  - overwrite the activitypub library for castopod's specific needs
  - perform basic interactions administrating a podcast to interact with fediverse users:
    - create notes with episode attachment
    - favourite and share a note + reply
    - add specific castopod_namespaces for podcasts and episodes definitions
- overwrite CodeIgniter's Route service to include alternate-content option for
  activitystream requests
- update episode publication logic:
  - remove publication inputs in create / edit episode form
  - publish / schedule or unpublish an episode after creation
  - the podcaster publishes a note when publishing an episode
- Javascript / Typescript modules:
  - fix Dropdown.ts to keep dropdown menu in foreground
  - add Modal.ts for funding links modal
  - add Toggler.ts to toggle various css states in ui
- User Interface:
  - update tailwindcss to v2
  - use castopod's pine and rose colors
  - update public layout to a 3 column layout
  - add pages in public for podcast activity, episode list and notes
  - update episode page to include linked notes
  - remove previous and next episodes from episode pages
  - show different public views depending on whether user is authenticated or not
  - use Kumbh Sans and Montserrat fonts
- update CodeIgniter's config files
- with CodeIgniter's new requirements, update docker environments are now based on
  php v7.3 image
- move Image entity to Libraries
- update composer and npm packages to latest versions

closes #69 #65 #85, fixes #51 #91 #92 #88
2021-04-02 17:20:02 +00:00

201 lines
4.4 KiB
PHP

<?php
/**
* @copyright 2021 Podlibre
* @license https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
* @link https://castopod.org/
*/
namespace ActivityPub\Entities;
use Michalsn\Uuid\UuidEntity;
class Note extends UuidEntity
{
protected $uuids = ['id', 'in_reply_to_id', 'reblog_of_id'];
/**
* @var \ActivityPub\Entities\Actor
*/
protected $actor;
/**
* @var boolean
*/
protected $is_reply;
/**
* @var \ActivityPub\Entities\Note
*/
protected $reply_to_note;
/**
* @var boolean
*/
protected $is_reblog;
/**
* @var \ActivityPub\Entities\Note
*/
protected $reblog_of_note;
/**
* @var \ActivityPub\Entities\PreviewCard
*/
protected $preview_card;
/**
* @var \ActivityPub\Entities\Note[]
*/
protected $replies;
/**
* @var \ActivityPub\Entities\Note[]
*/
protected $reblogs;
protected $dates = ['published_at', 'created_at'];
protected $casts = [
'id' => 'string',
'uri' => 'string',
'actor_id' => 'integer',
'in_reply_to_id' => '?string',
'reblog_of_id' => '?string',
'message' => 'string',
'message_html' => 'string',
'favourites_count' => 'integer',
'reblogs_count' => 'integer',
'replies_count' => 'integer',
];
/**
* Returns the note's actor
*
* @return \ActivityPub\Entities\Actor
*/
public function getActor()
{
if (empty($this->actor_id)) {
throw new \RuntimeException(
'Note must have an actor_id before getting actor.',
);
}
if (empty($this->actor)) {
$this->actor = model('ActorModel')->getActorById($this->actor_id);
}
return $this->actor;
}
public function getPreviewCard()
{
if (empty($this->id)) {
throw new \RuntimeException(
'Note must be created before getting preview_card.',
);
}
if (empty($this->preview_card)) {
$this->preview_card = model('PreviewCardModel')->getNotePreviewCard(
$this->id,
);
}
return $this->preview_card;
}
public function getReplies()
{
if (empty($this->id)) {
throw new \RuntimeException(
'Note must be created before getting replies.',
);
}
if (empty($this->replies)) {
$this->replies = model('NoteModel')->getNoteReplies($this->id);
}
return $this->replies;
}
public function getIsReply()
{
$this->is_reply = $this->in_reply_to_id !== null;
return $this->is_reply;
}
public function getReplyToNote()
{
if (empty($this->in_reply_to_id)) {
throw new \RuntimeException('Note is not a reply.');
}
if (empty($this->reply_to_note)) {
$this->reply_to_note = model('NoteModel')->getNoteById(
$this->in_reply_to_id,
);
}
return $this->reply_to_note;
}
public function getReblogs()
{
if (empty($this->id)) {
throw new \RuntimeException(
'Note must be created before getting reblogs.',
);
}
if (empty($this->reblogs)) {
$this->reblogs = model('NoteModel')->getNoteReblogs(
service('uuid')
->fromString($this->id)
->getBytes(),
);
}
return $this->reblogs;
}
public function getIsReblog()
{
return $this->reblog_of_id != null;
}
public function getReblogOfNote()
{
if (empty($this->reblog_of_id)) {
throw new \RuntimeException('Note is not a reblog.');
}
if (empty($this->reblog_of_note)) {
$this->reblog_of_note = model('NoteModel')->getNoteById(
$this->reblog_of_id,
);
}
return $this->reblog_of_note;
}
public function setMessage(string $message)
{
helper('activitypub');
$messageWithoutTags = strip_tags($message);
$this->attributes['message'] = $messageWithoutTags;
$this->attributes['message_html'] = str_replace(
"\n",
'<br />',
linkify($messageWithoutTags),
);
return $this;
}
}