gnu-social/src/Entity/Actor.php

429 lines
13 KiB
PHP

<?php
declare(strict_types = 1);
// {{{ 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\Router\Router;
use App\Core\UserRoles;
use App\Util\Common;
use App\Util\Exception\NicknameException;
use App\Util\Exception\NotFoundException;
use App\Util\Nickname;
use Component\Avatar\Avatar;
use DateTimeInterface;
use Functional as F;
/**
* Entity for actors
*
* @category DB
* @package GNUsocial
*
* @author Zach Copley <zach@status.net>
* @copyright 2010 StatusNet Inc.
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
* @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 Actor extends Entity
{
// {{{ Autocode
// @codeCoverageIgnoreStart
private int $id;
private string $nickname;
private ?string $fullname = null;
private int $roles = 4;
private ?string $homepage;
private ?string $bio;
private ?string $location;
private ?float $lat;
private ?float $lon;
private ?int $location_id;
private ?int $location_service;
private bool $is_local;
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 setNickname(string $nickname): self
{
$this->nickname = $nickname;
return $this;
}
public function getNickname(): string
{
return $this->nickname;
}
public function setFullname(string $fullname): self
{
$this->fullname = $fullname;
return $this;
}
public function getFullname(): ?string
{
if (\is_null($this->fullname)) {
return null;
}
return $this->fullname;
}
public function setRoles(int $roles): self
{
$this->roles = $roles;
return $this;
}
public function getRoles(): int
{
return $this->roles;
}
public function setHomepage(?string $homepage): self
{
$this->homepage = $homepage;
return $this;
}
public function getHomepage(): ?string
{
return $this->homepage;
}
public function setBio(?string $bio): self
{
$this->bio = $bio;
return $this;
}
public function getBio(): ?string
{
return $this->bio;
}
public function setLocation(?string $location): self
{
$this->location = $location;
return $this;
}
public function getLocation(): ?string
{
return $this->location;
}
public function setLat(?float $lat): self
{
$this->lat = $lat;
return $this;
}
public function getLat(): ?float
{
return $this->lat;
}
public function setLon(?float $lon): self
{
$this->lon = $lon;
return $this;
}
public function getLon(): ?float
{
return $this->lon;
}
public function setLocationId(?int $location_id): self
{
$this->location_id = $location_id;
return $this;
}
public function getLocationId(): ?int
{
return $this->location_id;
}
public function setLocationService(?int $location_service): self
{
$this->location_service = $location_service;
return $this;
}
public function getLocationService(): ?int
{
return $this->location_service;
}
public function setIsLocal(bool $is_local): self
{
$this->is_local = $is_local;
return $this;
}
public function getIsLocal(): bool
{
return $this->is_local;
}
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 getLocalUser()
{
if ($this->getIsLocal()) {
return DB::findOneBy('local_user', ['id' => $this->getId()]);
} else {
throw new NotFoundException('This is a remote actor.');
}
}
public function getAvatarUrl(string $size = 'full')
{
return Avatar::getAvatarUrl($this->getId(), $size);
}
public static function getById(int $id): ?self
{
return Cache::get('actor-id-' . $id, fn () => DB::find('actor', ['id' => $id]));
}
public static function getNicknameById(int $id): string
{
return Cache::get('actor-nickname-id-' . $id, fn () => self::getById($id)->getNickname());
}
public static function getFullnameById(int $id): ?string
{
return Cache::get('actor-fullname-id-' . $id, fn () => self::getById($id)->getFullname());
}
public function getSelfTags(bool $_test_force_recompute = false): array
{
return Cache::get(
'selftags-' . $this->id,
fn () => DB::findBy('actor_tag', ['tagger' => $this->id, 'tagged' => $this->id]),
beta: $_test_force_recompute ? \INF : 1.0,
);
}
public function setSelfTags(array $tags, array $existing): void
{
$tag_existing = F\map($existing, fn ($pt) => $pt->getTag());
$tag_to_add = array_diff($tags, $tag_existing);
$tag_to_remove = array_diff($tag_existing, $tags);
$pt_to_remove = F\filter($existing, fn ($pt) => \in_array($pt->getTag(), $tag_to_remove));
foreach ($tag_to_add as $tag) {
$pt = ActorTag::create(['tagger' => $this->id, 'tagged' => $this->id, 'tag' => $tag]);
DB::persist($pt);
}
foreach ($pt_to_remove as $pt) {
DB::persist($pt);
DB::remove($pt);
}
Cache::delete('selftags-' . $this->id);
}
public function getSubscribersCount()
{
return Cache::get(
'subscribers-' . $this->id,
function () {
return DB::dql(
'select count(f) from App\Entity\Subscription f where f.subscribed = :subscribed',
['subscribed' => $this->id],
)[0][1] - 1; // Remove self subscription
},
);
}
public function getSubscribedCount()
{
return Cache::get(
'subscribed-' . $this->id,
function () {
return DB::dql(
'select count(f) from App\Entity\Subscription f where f.subscriber = :subscriber',
['subscriber' => $this->id],
)[0][1] - 1; // Remove self subscription
},
);
}
public function isPerson(): bool
{
return ($this->roles & UserRoles::BOT) === 0;
}
/**
* Resolve an ambiguous nickname reference, checking in following order:
* - Actors that $sender subscribes to
* - Actors that subscribe to $sender
* - Any Actor
*
* @param string $nickname validated nickname of
*
* @throws NicknameException
*/
public function findRelativeActor(string $nickname): ?self
{
// Will throw exception on invalid input.
$nickname = Nickname::normalize($nickname, check_already_used: false);
return Cache::get(
'relative-nickname-' . $nickname . '-' . $this->getId(),
fn () => DB::dql(
<<<'EOF'
select a from actor a where
a.id in (select fa.subscribed from subscription fa join actor aa with fa.subscribed = aa.id where fa.subscriber = :actor_id and aa.nickname = :nickname) or
a.id in (select fb.subscriber from subscription fb join actor ab with fb.subscriber = ab.id where fb.subscribed = :actor_id and ab.nickname = :nickname) or
a.nickname = :nickname
EOF,
['nickname' => $nickname, 'actor_id' => $this->getId()],
['limit' => 1],
)[0] ?? null,
);
}
public function getUri(int $type = Router::ABSOLUTE_PATH): string
{
return Router::url('actor_view_id', ['id' => $this->getId()], $type);
}
public function getUrl(int $type = Router::ABSOLUTE_PATH): string
{
return Router::url('actor_view_nickname', ['nickname' => $this->getNickname()], $type);
}
public function getAliases(): array
{
return array_keys($this->getAliasesWithIDs());
}
public function getAliasesWithIDs(): array
{
$aliases = [];
$aliases[$this->getUri(Router::ABSOLUTE_URL)] = $this->getId();
$aliases[$this->getUrl(Router::ABSOLUTE_URL)] = $this->getId();
return $aliases;
}
/**
* Get the most appropriate language for $this to use when
* referring to $context (a reply or a group, for instance)
*
* @return Language[]
*/
public function getPreferredLanguageChoices(?self $context = null): array
{
$id = $context?->getId() ?? $this->getId();
$key = ActorLanguage::collectionCacheKey($this); // TODO handle language context
$langs = Cache::getHashMap(
$key,
fn () => F\reindex(
DB::dql(
'select l from actor_language al join language l with al.language_id = l.id where al.actor_id = :id order by al.ordering ASC',
['id' => $id],
),
fn (Language $l) => $l->getLocale(),
),
) ?: [
Common::config('site', 'language') => (Cache::getHashMapKey('languages', Common::config('site', 'language'))
?: DB::findOneBy('language', ['locale' => Common::config('site', 'language')])),
];
return array_merge(...F\map(array_values($langs), fn ($l) => $l->toChoiceFormat()));
}
public static function schemaDef(): array
{
return [
'name' => 'actor',
'description' => 'local and remote users, groups and bots are actors, for instance',
'fields' => [
'id' => ['type' => 'serial', 'not null' => true, 'description' => 'unique identifier'],
'nickname' => ['type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'nickname or username'],
'fullname' => ['type' => 'text', 'description' => 'display name'],
'roles' => ['type' => 'int', 'not null' => true, 'default' => UserRoles::USER, 'description' => 'Bitmap of permissions this actor has'],
'homepage' => ['type' => 'text', 'description' => 'identifying URL'],
'bio' => ['type' => 'text', 'description' => 'descriptive biography'],
'location' => ['type' => 'text', 'description' => 'physical location'],
'lat' => ['type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'],
'lon' => ['type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'],
'location_id' => ['type' => 'int', 'description' => 'location id if possible'],
'location_service' => ['type' => 'int', 'description' => 'service used to obtain location id'],
'is_local' => ['type' => 'bool', 'not null' => true, 'description' => 'Does this actor have a LocalUser associated'],
'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' => [
'actor_nickname_idx' => ['nickname'],
],
'fulltext indexes' => [
'actor_fulltext_idx' => ['nickname', 'fullname', 'location', 'bio', 'homepage'],
],
];
}
}