Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-04-22 06:30:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Move Mastodon API entities to src/Object

Browse source
This commit is contained in:
Hypolite Petovan 2020-01-27 20:01:32 -05:00
parent 74a25eb670
commit 0de8e4db08
13 changed files with 24 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

108
src/Object/Api/Mastodon/Account.php Normal file
View file

@ -0,0 +1,108 @@
<?php
namespace Friendica\Object\Api\Mastodon;
use Friendica\App\BaseURL;
use Friendica\BaseEntity;
use Friendica\Content\Text\BBCode;
use Friendica\Database\DBA;
use Friendica\Model\Contact;
use Friendica\Util\DateTimeFormat;
/**
* Class Account
*
* @see https://docs.joinmastodon.org/entities/account
*/
class Account extends BaseEntity
{
/** @var string */
protected $id;
/** @var string */
protected $username;
/** @var string */
protected $acct;
/** @var string */
protected $display_name;
/** @var bool */
protected $locked;
/** @var string (Datetime) */
protected $created_at;
/** @var int */
protected $followers_count;
/** @var int */
protected $following_count;
/** @var int */
protected $statuses_count;
/** @var string */
protected $note;
/** @var string (URL)*/
protected $url;
/** @var string (URL) */
protected $avatar;
/** @var string (URL) */
protected $avatar_static;
/** @var string (URL) */
protected $header;
/** @var string (URL) */
protected $header_static;
/** @var Emoji[] */
protected $emojis;
/** @var Account|null */
protected $moved = null;
/** @var Field[]|null */
protected $fields = null;
/** @var bool|null */
protected $bot = null;
/** @var bool */
protected $group;
/** @var bool */
protected $discoverable;
/** @var string|null (Datetime) */
protected $last_status_at = null;
/**
* Creates an account record from a public contact record. Expects all contact table fields to be set.
*
* @param BaseURL $baseUrl
* @param array $publicContact Full contact table record with uid = 0
* @param array $apcontact Optional full apcontact table record
* @param array $userContact Optional full contact table record with uid != 0
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public function __construct(BaseURL $baseUrl, array $publicContact, array $apcontact = [], array $userContact = [])
{
$this->id = $publicContact['id'];
$this->username = $publicContact['nick'];
$this->acct =
strpos($publicContact['url'], $baseUrl->get() . '/') === 0 ?
$publicContact['nick'] :
$publicContact['addr'];
$this->display_name = $publicContact['name'];
$this->locked = !empty($apcontact['manually-approve']);
$this->created_at = DateTimeFormat::utc($publicContact['created'], DateTimeFormat::ATOM);
$this->followers_count = $apcontact['followers_count'] ?? 0;
$this->following_count = $apcontact['following_count'] ?? 0;
$this->statuses_count = $apcontact['statuses_count'] ?? 0;
$this->note = BBCode::convert($publicContact['about'], false);
$this->url = $publicContact['url'];
$this->avatar = $userContact['avatar'] ?? $publicContact['avatar'];
$this->avatar_static = $userContact['avatar'] ?? $publicContact['avatar'];
// No header picture in Friendica
$this->header = '';
$this->header_static = '';
// No custom emojis per account in Friendica
$this->emojis = [];
// No metadata fields in Friendica
$this->fields = [];
$this->bot = ($publicContact['contact-type'] == Contact::TYPE_NEWS);
$this->group = ($publicContact['contact-type'] == Contact::TYPE_COMMUNITY);
$this->discoverable = !$publicContact['unsearchable'];
$publicContactLastItem = $publicContact['last-item'] ?: DBA::NULL_DATETIME;
$userContactLastItem = $userContact['last-item'] ?? DBA::NULL_DATETIME;
$lastItem = $userContactLastItem > $publicContactLastItem ? $userContactLastItem : $publicContactLastItem;
$this->last_status_at = $lastItem != DBA::NULL_DATETIME ? DateTimeFormat::utc($lastItem, DateTimeFormat::ATOM) : null;
}
}

22
src/Object/Api/Mastodon/Emoji.php Normal file
View file

@ -0,0 +1,22 @@
<?php
namespace Friendica\Object\Api\Mastodon;
use Friendica\BaseEntity;
/**
* Class Emoji
*
* @see https://docs.joinmastodon.org/api/entities/#emoji
*/
class Emoji extends BaseEntity
{
/** @var string */
protected $shortcode;
/** @var string (URL) */
protected $static_url;
/** @var string (URL) */
protected $url;
/** @var bool */
protected $visible_in_picker;
}

20
src/Object/Api/Mastodon/Field.php Normal file
View file

@ -0,0 +1,20 @@
<?php
namespace Friendica\Object\Api\Mastodon;
use Friendica\BaseEntity;
/**
* Class Field
*
* @see https://docs.joinmastodon.org/api/entities/#field
*/
class Field extends BaseEntity
{
/** @var string */
protected $name;
/** @var string (HTML) */
protected $value;
/** @var string (Datetime)*/
protected $verified_at;
}

31
src/Object/Api/Mastodon/FollowRequest.php Normal file
View file

@ -0,0 +1,31 @@
<?php
namespace Friendica\Object\Api\Mastodon;
use Friendica\App\BaseURL;
/**
* Virtual entity to separate Accounts from Follow Requests.
* In the Mastodon API they are one and the same.
*/
class FollowRequest extends Account
{
/**
* Creates a follow request entity from an introduction record.
*
* The account ID is set to the Introduction ID to allow for later interaction with follow requests.
*
* @param BaseURL $baseUrl
* @param int $introduction_id Introduction record id
* @param array $publicContact Full contact table record with uid = 0
* @param array $apcontact Optional full apcontact table record
* @param array $userContact Optional full contact table record with uid != 0
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public function __construct(BaseURL $baseUrl, int $introduction_id, array $publicContact, array $apcontact = [], array $userContact = [])
{
parent::__construct($baseUrl, $publicContact, $apcontact, $userContact);
$this->id = $introduction_id;
}
}

84
src/Object/Api/Mastodon/Instance.php Normal file
View file

@ -0,0 +1,84 @@
<?php
namespace Friendica\Object\Api\Mastodon;
use Friendica\BaseEntity;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\User;
use Friendica\Module\Register;
/**
* Class Instance
*
* @see https://docs.joinmastodon.org/api/entities/#instance
*/
class Instance extends BaseEntity
{
/** @var string (URL) */
protected $uri;
/** @var string */
protected $title;
/** @var string */
protected $description;
/** @var string */
protected $email;
/** @var string */
protected $version;
/** @var array */
protected $urls;
/** @var Stats */
protected $stats;
/** @var string|null */
protected $thumbnail = null;
/** @var array */
protected $languages;
/** @var int */
protected $max_toot_chars;
/** @var bool */
protected $registrations;
/** @var bool */
protected $approval_required;
/** @var Account|null */
protected $contact_account = null;
/**
* Creates an instance record
*
* @return Instance
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function get()
{
$register_policy = intval(DI::config()->get('config', 'register_policy'));
$baseUrl = DI::baseUrl();
$instance = new Instance();
$instance->uri = $baseUrl->get();
$instance->title = DI::config()->get('config', 'sitename');
$instance->description = DI::config()->get('config', 'info');
$instance->email = DI::config()->get('config', 'admin_email');
$instance->version = FRIENDICA_VERSION;
$instance->urls = []; // Not supported
$instance->stats = Stats::get();
$instance->thumbnail = $baseUrl->get() . (DI::config()->get('system', 'shortcut_icon') ?? 'images/friendica-32.png');
$instance->languages = [DI::config()->get('system', 'language')];
$instance->max_toot_chars = (int)DI::config()->get('config', 'api_import_size', DI::config()->get('config', 'max_import_size'));
$instance->registrations = ($register_policy != Register::CLOSED);
$instance->approval_required = ($register_policy == Register::APPROVE);
$instance->contact_account = [];
if (!empty(DI::config()->get('config', 'admin_email'))) {
$adminList = explode(',', str_replace(' ', '', DI::config()->get('config', 'admin_email')));
$administrator = User::getByEmail($adminList[0], ['nickname']);
if (!empty($administrator)) {
$adminContact = DBA::selectFirst('contact', ['id'], ['nick' => $administrator['nickname'], 'self' => true]);
$instance->contact_account = DI::mstdnAccount()->createFromContactId($adminContact['id']);
}
}
return $instance;
}
}

60
src/Object/Api/Mastodon/Relationship.php Normal file
View file

@ -0,0 +1,60 @@
<?php
namespace Friendica\Object\Api\Mastodon;
use Friendica\BaseEntity;
use Friendica\Model\Contact;
use Friendica\Util\Network;
/**
* Class Relationship
*
* @see https://docs.joinmastodon.org/api/entities/#relationship
*/
class Relationship extends BaseEntity
{
/** @var int */
protected $id;
/** @var bool */
protected $following = false;
/** @var bool */
protected $followed_by = false;
/** @var bool */
protected $blocking = false;
/** @var bool */
protected $muting = false;
/** @var bool */
protected $muting_notifications = false;
/** @var bool */
protected $requested = false;
/** @var bool */
protected $domain_blocking = false;
/**
* Unsupported
* @var bool
*/
protected $showing_reblogs = true;
/**
* Unsupported
* @var bool
*/
protected $endorsed = false;
/**
* @param int $userContactId Contact row Id with uid != 0
* @param array $userContact Full Contact table record with uid != 0
*/
public function __construct(int $userContactId, array $userContact = [])
{
$this->id = $userContactId;
$this->following = in_array($userContact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
$this->followed_by = in_array($userContact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
$this->blocking = (bool)$userContact['blocked'] ?? false;
$this->muting = (bool)$userContact['readonly'] ?? false;
$this->muting_notifications = (bool)$userContact['readonly'] ?? false;
$this->requested = (bool)$userContact['pending'] ?? false;
$this->domain_blocking = Network::isUrlBlocked($userContact['url'] ?? '');
return $this;
}
}

39
src/Object/Api/Mastodon/Stats.php Normal file
View file

@ -0,0 +1,39 @@
<?php
namespace Friendica\Object\Api\Mastodon;
use Friendica\BaseEntity;
use Friendica\Core\Protocol;
use Friendica\Database\DBA;
use Friendica\DI;
/**
* Class Stats
*
* @see https://docs.joinmastodon.org/api/entities/#stats
*/
class Stats extends BaseEntity
{
/** @var int */
protected $user_count = 0;
/** @var int */
protected $status_count = 0;
/** @var int */
protected $domain_count = 0;
/**
* Creates a stats record
*
* @return Stats
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function get() {
$stats = new Stats();
if (!empty(DI::config()->get('system', 'nodeinfo'))) {
$stats->user_count = intval(DI::config()->get('nodeinfo', 'total_users'));
$stats->status_count = DI::config()->get('nodeinfo', 'local_posts') + DI::config()->get('nodeinfo', 'local_comments');
$stats->domain_count = DBA::count('gserver', ["`network` in (?, ?) AND `last_contact` >= `last_failure`", Protocol::DFRN, Protocol::ACTIVITYPUB]);
}
return $stats;
}
}