2008-05-15 17:28:44 +01:00
< ? php
2019-09-11 09:25:39 +01:00
2021-10-10 09:26:18 +01:00
declare ( strict_types = 1 );
2020-03-29 20:56:35 +01:00
// {{{ License
2020-08-09 13:44:47 +01:00
2020-05-20 17:53:53 +01:00
// This file is part of GNU social - https://www.gnu.org/software/social
2020-03-29 20:56:35 +01:00
//
// GNU social is free software: you can redistribute it and/or modify
2020-05-10 21:43:15 +01:00
// it under the terms of the GNU Affero General Public License as published by
2020-03-29 20:56:35 +01:00
// 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.
//
2020-05-10 21:43:15 +01:00
// You should have received a copy of the GNU Affero General Public License
2020-03-29 20:56:35 +01:00
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
2020-08-09 13:44:47 +01:00
2020-03-29 20:56:35 +01:00
// }}}
2020-03-29 19:33:16 +01:00
2021-08-04 19:12:37 +01:00
namespace Component\Avatar\Entity ;
2016-01-06 15:14:26 +00:00
2021-09-20 17:01:36 +01:00
use App\Core\Cache ;
2020-08-07 03:03:55 +01:00
use App\Core\DB\DB ;
use App\Core\Entity ;
2022-01-02 03:06:07 +00:00
use App\Core\Event ;
2020-08-08 17:10:25 +01:00
use App\Core\Router\Router ;
use App\Util\Common ;
2021-12-26 09:48:16 +00:00
use Component\Attachment\Entity\Attachment ;
2021-12-27 04:47:04 +00:00
use Component\Attachment\Entity\AttachmentThumbnail ;
2020-05-10 21:43:15 +01:00
use DateTimeInterface ;
2008-05-15 17:28:44 +01:00
/**
2020-03-29 19:33:16 +01:00
* 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
2021-02-19 23:29:43 +00:00
* @ author Hugo Sales < hugo @ hsal . es >
* @ copyright 2020 - 2021 Free Software Foundation , Inc http :// www . fsf . org
2020-03-29 19:33:16 +01:00
* @ license https :// www . gnu . org / licenses / agpl . html GNU AGPL v3 or later
2008-05-15 17:28:44 +01:00
*/
2020-08-07 03:03:55 +01:00
class Avatar extends Entity
2008-05-15 17:28:44 +01:00
{
2020-03-30 15:00:13 +01:00
// {{{ Autocode
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreStart
2021-09-18 03:22:27 +01:00
private int $actor_id ;
2021-04-18 02:17:57 +01:00
private int $attachment_id ;
2021-12-26 21:32:09 +00:00
private ? string $title = null ;
2021-08-04 19:12:37 +01:00
private DateTimeInterface $created ;
private DateTimeInterface $modified ;
2020-03-30 16:13:51 +01:00
2021-09-18 03:22:27 +01:00
public function setActorId ( int $actor_id ) : self
2020-03-30 16:13:51 +01:00
{
2021-09-18 03:22:27 +01:00
$this -> actor_id = $actor_id ;
2020-03-30 16:13:51 +01:00
return $this ;
}
2020-08-08 17:10:25 +01:00
2021-09-18 03:22:27 +01:00
public function getActorId () : int
2020-03-30 16:13:51 +01:00
{
2021-09-18 03:22:27 +01:00
return $this -> actor_id ;
2020-03-30 16:13:51 +01:00
}
2021-04-18 02:17:57 +01:00
public function setAttachmentId ( int $attachment_id ) : self
2020-03-30 16:13:51 +01:00
{
2021-04-18 02:17:57 +01:00
$this -> attachment_id = $attachment_id ;
2020-03-30 16:13:51 +01:00
return $this ;
}
2020-08-08 17:10:25 +01:00
2021-04-18 02:17:57 +01:00
public function getAttachmentId () : int
2020-03-30 16:13:51 +01:00
{
2021-04-18 02:17:57 +01:00
return $this -> attachment_id ;
2020-03-30 16:13:51 +01:00
}
2021-12-26 15:12:06 +00:00
public function setTitle ( ? string $title ) : self
2021-08-17 21:46:09 +01:00
{
2021-12-26 21:32:09 +00:00
$this -> title = \is_null ( $title ) ? null : mb_substr ( $title , 0 , 191 );
2021-12-26 15:12:06 +00:00
return $this ;
2021-08-17 21:46:09 +01:00
}
2021-12-26 15:12:06 +00:00
public function getTitle () : ? string
2021-08-17 21:46:09 +01:00
{
2021-12-26 15:12:06 +00:00
return $this -> title ;
2021-08-17 21:46:09 +01:00
}
2021-05-05 17:03:03 +01:00
public function setCreated ( DateTimeInterface $created ) : self
2020-03-30 16:13:51 +01:00
{
$this -> created = $created ;
return $this ;
}
2020-08-08 17:10:25 +01:00
2021-05-05 17:03:03 +01:00
public function getCreated () : DateTimeInterface
2020-03-30 16:13:51 +01:00
{
return $this -> created ;
}
2021-05-05 17:03:03 +01:00
public function setModified ( DateTimeInterface $modified ) : self
2020-03-30 16:13:51 +01:00
{
$this -> modified = $modified ;
return $this ;
}
2020-08-08 17:10:25 +01:00
2021-05-05 17:03:03 +01:00
public function getModified () : DateTimeInterface
2020-03-30 16:13:51 +01:00
{
return $this -> modified ;
}
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreEnd
2020-03-30 15:00:13 +01:00
// }}} Autocode
2009-02-06 08:13:08 +00:00
2021-04-18 02:17:57 +01:00
private ? Attachment $attachment = null ;
2020-08-07 03:03:55 +01:00
2021-12-27 04:47:04 +00:00
public function getUrl ( string $size = 'medium' , int $type = Router :: ABSOLUTE_PATH ) : string
2020-08-08 17:10:25 +01:00
{
2021-09-20 17:01:36 +01:00
$actor_id = $this -> getActorId ();
2021-10-10 09:26:18 +01:00
return Cache :: get ( " avatar-url- { $actor_id } - { $size } - { $type } " , fn () => Router :: url ( 'avatar_actor' , [ 'actor_id' => $actor_id , 'size' => $size ], $type ));
2020-08-08 17:10:25 +01:00
}
2021-04-18 02:17:57 +01:00
public function getAttachment () : Attachment
2020-08-07 03:03:55 +01:00
{
2021-12-27 04:47:04 +00:00
$this -> attachment ? ? = DB :: findOneBy ( 'attachment' , [ 'id' => $this -> getAttachmentId ()]);
2021-04-18 02:17:57 +01:00
return $this -> attachment ;
2020-08-07 03:03:55 +01:00
}
2021-12-27 04:47:04 +00:00
public function getAttachmentThumbnail ( string $size ) : ? AttachmentThumbnail
{
return AttachmentThumbnail :: getOrCreate ( $this -> getAttachment (), $size );
}
2020-08-09 13:44:47 +01:00
public static function getFilePathStatic ( string $filename ) : string
{
2020-08-14 23:39:16 +01:00
return Common :: config ( 'avatar' , 'dir' ) . $filename ;
2020-08-09 13:44:47 +01:00
}
2021-04-29 19:12:32 +01:00
public function getPath () : string
2020-08-07 03:03:55 +01:00
{
2021-04-18 02:17:57 +01:00
return Common :: config ( 'avatar' , 'dir' ) . $this -> getAttachment () -> getFileName ();
2020-08-07 03:03:55 +01:00
}
/**
2021-08-14 16:47:45 +01:00
* Delete this avatar and kill corresponding attachment
2020-08-07 03:03:55 +01:00
*/
2021-08-14 16:47:45 +01:00
public function delete () : bool
2020-08-07 03:03:55 +01:00
{
2022-01-02 03:06:07 +00:00
$actor_id = $this -> getActorId ();
2021-08-14 16:47:45 +01:00
$attachment = $this -> getAttachment ();
2022-01-02 03:06:07 +00:00
DB :: wrapInTransaction ( fn () => DB :: removeBy ( static :: class , [ 'actor_id' => $actor_id ]));
2021-08-14 16:47:45 +01:00
$attachment -> kill ();
2022-01-02 03:06:07 +00:00
Event :: handle ( 'AvatarUpdate' , [ $actor_id ]);
2021-08-14 16:47:45 +01:00
return true ;
2020-08-07 03:03:55 +01:00
}
2020-03-29 19:33:16 +01:00
public static function schemaDef () : array
2019-09-11 09:25:39 +01:00
{
2020-03-29 19:33:16 +01:00
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' ],
2021-04-18 21:27:31 +01:00
'attachment_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'Attachment.id' , 'multiplicity' => 'one to one' , 'not null' => true , 'description' => 'foreign key to attachment table' ],
2021-09-23 14:03:50 +01:00
'title' => [ 'type' => 'varchar' , 'length' => 191 , 'description' => 'file name of resource when available' ],
2021-08-04 19:12:37 +01:00
'created' => [ 'type' => 'datetime' , 'not null' => true , 'description' => 'date this record was created' , 'default' => 'CURRENT_TIMESTAMP' ],
2021-04-18 02:17:57 +01:00
'modified' => [ 'type' => 'timestamp' , 'not null' => true , 'description' => 'date this record was modified' , 'default' => 'CURRENT_TIMESTAMP' ],
2020-03-29 19:33:16 +01:00
],
2021-09-18 03:22:27 +01:00
'primary key' => [ 'actor_id' ],
2021-02-22 21:34:59 +00:00
'indexes' => [
2021-04-18 02:17:57 +01:00
'avatar_attachment_id_idx' => [ 'attachment_id' ],
2020-03-29 19:33:16 +01:00
],
];
2013-09-30 21:13:37 +01:00
}
2008-05-15 17:28:44 +01:00
}