gnu-social/components/Avatar/Entity/Avatar.php

173 lines
4.9 KiB
PHP
Raw Normal View History

<?php
// {{{ 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 Component\Avatar\Entity;
use App\Core\DB\DB;
use App\Core\Entity;
use App\Core\Router\Router;
use App\Entity\Attachment;
use App\Util\Common;
use DateTimeInterface;
/**
* Entity for user's avatar
*
* @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 Avatar extends Entity
{
// {{{ Autocode
// @codeCoverageIgnoreStart
2021-09-18 03:22:27 +01:00
private int $actor_id;
private int $attachment_id;
private ?string $filename;
private DateTimeInterface $created;
private DateTimeInterface $modified;
2021-09-18 03:22:27 +01:00
public function setActorId(int $actor_id): self
{
2021-09-18 03:22:27 +01:00
$this->actor_id = $actor_id;
return $this;
}
2021-09-18 03:22:27 +01:00
public function getActorId(): int
{
2021-09-18 03:22:27 +01:00
return $this->actor_id;
}
public function setAttachmentId(int $attachment_id): self
{
$this->attachment_id = $attachment_id;
return $this;
}
public function getAttachmentId(): int
{
return $this->attachment_id;
}
/**
* @return null|string
*/
public function getFilename(): ?string
{
return $this->filename;
}
/**
* @param null|string $filename
*/
public function setFilename(?string $filename): void
{
$this->filename = $filename;
}
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
private ?Attachment $attachment = null;
public function getUrl(): string
{
2021-09-18 03:22:27 +01:00
return Router::url('avatar', ['actor_id' => $this->actor_id]);
}
public function getAttachment(): Attachment
{
2021-04-29 19:12:32 +01:00
$this->attachment = $this->attachment ?: DB::findOneBy('attachment', ['id' => $this->attachment_id]);
return $this->attachment;
}
public static function getFilePathStatic(string $filename): string
{
2020-08-14 23:39:16 +01:00
return Common::config('avatar', 'dir') . $filename;
}
2021-04-29 19:12:32 +01:00
public function getPath(): string
{
return Common::config('avatar', 'dir') . $this->getAttachment()->getFileName();
}
/**
* Delete this avatar and kill corresponding attachment
2021-04-29 19:12:32 +01:00
*
* @return bool
*/
public function delete(): bool
{
DB::remove($this);
$attachment = $this->getAttachment();
$attachment->kill();
DB::flush();
return true;
}
public static function schemaDef(): array
{
return [
'name' => 'avatar',
'fields' => [
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' => 'foreign key to actor table'],
'attachment_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Attachment.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'foreign key to attachment table'],
'filename' => ['type' => 'varchar', 'length' => 191, 'description' => 'file name of resource when available'],
'created' => ['type' => 'datetime', 'not null' => true, 'description' => 'date this record was created', 'default' => 'CURRENT_TIMESTAMP'],
'modified' => ['type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified', 'default' => 'CURRENT_TIMESTAMP'],
],
2021-09-18 03:22:27 +01:00
'primary key' => ['actor_id'],
'indexes' => [
'avatar_attachment_id_idx' => ['attachment_id'],
],
];
Avatar resizing improvements and better code reuse * getOriginal added to Avatar class This is a static function that retrieves the original avatar in a leaner way than Profile->getOriginalAvatar() did (see below). This will throw an Exception if there was none to be found. * getProfileAvatars added to Avatar class This gets all Avatars from a profile and returns them in an array. * newSize added to Avatar class This will scale an original avatar or throw an Exception (originally from Avatar::getOriginal) if one wasn't found. * deleteFromProfile added to Avatar class Deletes all avatars for a Profile. This makes the code much smarter when removing all avatars from a user. Previously only specific, hardcoded (through constants) sizes would be deleted. If you ever changed lib/framework.php then many oddsized avatars would remain with the old method. * Migrated Profile class to new Avatar::getOriginal support Profile class now uses Avatar::getOriginal through its own $this->getOriginalAvatar and thus remains backwards compatible. * Updating stock GNU Social to use Avatar::getOriginal All places where core StatusNet code used the $profile->getOriginalAvatar, it will now useAvatar::getOriginal with proper error handling. * Updated Profile class to use Avatar::newSize When doing setOriginal, the scaling will be done with the new method introduced in this merge. This also edits the _fillAvatar function to avoid adding NULL values to the array (which causes errors when attempting to access array entries as objects). See issue #3478 at http://status.net/open-source/issues/3478
2013-09-30 21:13:37 +01:00
}
}