* @copyright 2018, Maxence Lange * @license GNU AGPL version 3 or any later version * * This program 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. * * This program 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 this program. If not, see . * */ namespace OCA\Social\Db; use DateTime; use Exception; use OCA\Social\Exceptions\CacheActorDoesNotExistException; use OCA\Social\Model\ActivityPub\Actor\Person; use OCA\Social\Service\ConfigService; use OCA\Social\Service\MiscService; use OCP\DB\QueryBuilder\IQueryBuilder; use OCP\IDBConnection; class CacheActorsRequest extends CacheActorsRequestBuilder { const CACHE_TTL = 60 * 24; // 1d /** * CacheActorsRequest constructor. * * @param IDBConnection $connection * @param ConfigService $configService * @param MiscService $miscService */ public function __construct( IDBConnection $connection, ConfigService $configService, MiscService $miscService ) { parent::__construct($connection, $configService, $miscService); } /** * insert cache about an Actor in database. * * @param Person $actor */ public function save(Person $actor) { if ($actor->getCreation() > 0) { $dTime = new DateTime(); $dTime->setTimestamp($actor->getCreation()); } else { $dTime = new DateTime('now'); } $qb = $this->getCacheActorsInsertSql(); $qb->setValue('id', $qb->createNamedParameter($actor->getId())) ->setValue('account', $qb->createNamedParameter($actor->getAccount())) ->setValue('type', $qb->createNamedParameter($actor->getType())) ->setValue('local', $qb->createNamedParameter(($actor->isLocal()) ? '1' : '0')) ->setValue('following', $qb->createNamedParameter($actor->getFollowing())) ->setValue('followers', $qb->createNamedParameter($actor->getFollowers())) ->setValue('inbox', $qb->createNamedParameter($actor->getInbox())) ->setValue('shared_inbox', $qb->createNamedParameter($actor->getSharedInbox())) ->setValue('outbox', $qb->createNamedParameter($actor->getOutbox())) ->setValue('featured', $qb->createNamedParameter($actor->getFeatured())) ->setValue('url', $qb->createNamedParameter($actor->getUrl())) ->setValue( 'preferred_username', $qb->createNamedParameter($actor->getPreferredUsername()) ) ->setValue('name', $qb->createNamedParameter($actor->getName())) ->setValue('summary', $qb->createNamedParameter($actor->getSummary())) ->setValue('public_key', $qb->createNamedParameter($actor->getPublicKey())) ->setValue('source', $qb->createNamedParameter($actor->getSource())) ->setValue('details', $qb->createNamedParameter(json_encode($actor->getDetails()))) ->setValue( 'creation', $qb->createNamedParameter($dTime, IQueryBuilder::PARAM_DATE) ); if ($actor->gotIcon()) { $iconId = $actor->getIcon() ->getId(); } else { $iconId = $actor->getIconId(); } $qb->setValue('icon_id', $qb->createNamedParameter($iconId)); $this->generatePrimaryKey($qb, $actor->getId()); $qb->execute(); } /** * insert cache about an Actor in database. * * @param Person $actor * * @return int */ public function update(Person $actor): int { if ($actor->getCreation() > 0) { $dTime = new DateTime(); $dTime->setTimestamp($actor->getCreation()); } else { $dTime = new DateTime('now'); } $qb = $this->getCacheActorsUpdateSql(); $qb->set('following', $qb->createNamedParameter($actor->getFollowing())) ->set('followers', $qb->createNamedParameter($actor->getFollowers())) ->set('inbox', $qb->createNamedParameter($actor->getInbox())) ->set('shared_inbox', $qb->createNamedParameter($actor->getSharedInbox())) ->set('outbox', $qb->createNamedParameter($actor->getOutbox())) ->set('featured', $qb->createNamedParameter($actor->getFeatured())) ->set('url', $qb->createNamedParameter($actor->getUrl())) ->set( 'preferred_username', $qb->createNamedParameter($actor->getPreferredUsername()) ) ->set('name', $qb->createNamedParameter($actor->getName())) ->set('summary', $qb->createNamedParameter($actor->getSummary())) ->set('public_key', $qb->createNamedParameter($actor->getPublicKey())) ->set('source', $qb->createNamedParameter($actor->getSource())) ->set('details', $qb->createNamedParameter(json_encode($actor->getDetails()))) ->set( 'creation', $qb->createNamedParameter($dTime, IQueryBuilder::PARAM_DATE) ); if ($actor->gotIcon()) { $iconId = $actor->getIcon() ->getId(); } else { $iconId = $actor->getIconId(); } $qb->set('icon_id', $qb->createNamedParameter($iconId)); $this->limitToIdString($qb, $actor->getId()); return $qb->execute(); } /** * get Cached version of an Actor, based on the UriId * * @param string $id * * @return Person * @throws CacheActorDoesNotExistException */ public function getFromId(string $id): Person { $qb = $this->getCacheActorsSelectSql(); $this->limitToIdString($qb, $id); $this->leftJoinCacheDocuments($qb, 'icon_id'); $cursor = $qb->execute(); $data = $cursor->fetch(); $cursor->closeCursor(); if ($data === false) { throw new CacheActorDoesNotExistException(); } return $this->parseCacheActorsSelectSql($data); } /** * get Cached version of an Actor, based on the Account * * @param string $account * * @return Person * @throws CacheActorDoesNotExistException */ public function getFromAccount(string $account): Person { $qb = $this->getCacheActorsSelectSql(); $this->limitToAccount($qb, $account); $this->leftJoinCacheDocuments($qb, 'icon_id'); $this->leftJoinDetails($qb); $cursor = $qb->execute(); $data = $cursor->fetch(); $cursor->closeCursor(); if ($data === false) { throw new CacheActorDoesNotExistException(); } return $this->parseCacheActorsSelectSql($data); } /** * get Cached version of a local Actor, based on the preferred username * * @param string $account * * @return Person * @throws CacheActorDoesNotExistException */ public function getFromLocalAccount(string $account): Person { $qb = $this->getCacheActorsSelectSql(); $this->limitToPreferredUsername($qb, $account); $this->limitToLocal($qb, true); $this->leftJoinCacheDocuments($qb, 'icon_id'); $this->leftJoinDetails($qb); $cursor = $qb->execute(); $data = $cursor->fetch(); $cursor->closeCursor(); if ($data === false) { throw new CacheActorDoesNotExistException(); } return $this->parseCacheActorsSelectSql($data); } /** * @param string $search * * @return Person[] */ public function searchAccounts(string $search): array { $qb = $this->getCacheActorsSelectSql(); $this->searchInAccount($qb, $search); $this->leftJoinCacheDocuments($qb, 'icon_id'); $this->leftJoinDetails($qb); $this->limitResults($qb, 25); $accounts = []; $cursor = $qb->execute(); while ($data = $cursor->fetch()) { $accounts[] = $this->parseCacheActorsSelectSql($data); } $cursor->closeCursor(); return $accounts; } /** * @return Person[] * @throws Exception */ public function getRemoteActorsToUpdate(): array { $qb = $this->getCacheActorsSelectSql(); $this->limitToLocal($qb, false); $this->limitToCreation($qb, self::CACHE_TTL); $update = []; $cursor = $qb->execute(); while ($data = $cursor->fetch()) { $update[] = $this->parseCacheActorsSelectSql($data); } $cursor->closeCursor(); return $update; } /** * delete cached version of an Actor, based on the UriId * * @param string $id */ public function deleteFromId(string $id) { $qb = $this->getCacheActorsDeleteSql(); $this->limitToIdString($qb, $id); $qb->execute(); } }