2008-05-16 01:28:44 +09:00
|
|
|
<?php
|
2019-09-11 17:25:39 +09:00
|
|
|
|
2020-03-30 04:56:35 +09:00
|
|
|
// {{{ License
|
2020-08-09 21:44:47 +09:00
|
|
|
|
2020-05-21 01:53:53 +09:00
|
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
2020-03-30 04:56:35 +09:00
|
|
|
//
|
|
|
|
// GNU social is free software: you can redistribute it and/or modify
|
2020-05-11 05:43:15 +09:00
|
|
|
// it under the terms of the GNU Affero General Public License as published by
|
2020-03-30 04:56:35 +09: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-11 05:43:15 +09:00
|
|
|
// You should have received a copy of the GNU Affero General Public License
|
2020-03-30 04:56:35 +09:00
|
|
|
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
|
2020-08-09 21:44:47 +09:00
|
|
|
|
2020-03-30 04:56:35 +09:00
|
|
|
// }}}
|
2020-03-30 03:33:16 +09:00
|
|
|
|
|
|
|
namespace App\Entity;
|
2016-01-07 00:14:26 +09:00
|
|
|
|
2020-08-07 11:03:55 +09:00
|
|
|
use App\Core\DB\DB;
|
|
|
|
use App\Core\Entity;
|
2020-08-09 01:10:25 +09:00
|
|
|
use App\Core\Router\Router;
|
|
|
|
use App\Util\Common;
|
2020-05-11 05:43:15 +09:00
|
|
|
use DateTimeInterface;
|
|
|
|
|
2008-05-16 01:28:44 +09:00
|
|
|
/**
|
2020-03-30 03:33:16 +09: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-20 08:29:43 +09:00
|
|
|
* @author Hugo Sales <hugo@hsal.es>
|
|
|
|
* @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
|
2020-03-30 03:33:16 +09:00
|
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
2008-05-16 01:28:44 +09:00
|
|
|
*/
|
2020-08-07 11:03:55 +09:00
|
|
|
class Avatar extends Entity
|
2008-05-16 01:28:44 +09:00
|
|
|
{
|
2020-03-30 23:00:13 +09:00
|
|
|
// {{{ Autocode
|
2020-08-13 10:35:01 +09:00
|
|
|
private int $gsactor_id;
|
2020-08-07 11:03:55 +09:00
|
|
|
private int $file_id;
|
2020-08-13 10:35:01 +09:00
|
|
|
private DateTimeInterface $created;
|
|
|
|
private DateTimeInterface $modified;
|
2020-03-31 00:13:51 +09:00
|
|
|
|
2021-02-21 06:01:08 +09:00
|
|
|
public function setGSActorId(int $gsactor_id): self
|
2020-03-31 00:13:51 +09:00
|
|
|
{
|
2020-08-13 10:35:01 +09:00
|
|
|
$this->gsactor_id = $gsactor_id;
|
2020-03-31 00:13:51 +09:00
|
|
|
return $this;
|
|
|
|
}
|
2020-08-09 01:10:25 +09:00
|
|
|
|
2021-02-21 06:01:08 +09:00
|
|
|
public function getGSActorId(): int
|
2020-03-31 00:13:51 +09:00
|
|
|
{
|
2020-08-13 10:35:01 +09:00
|
|
|
return $this->gsactor_id;
|
2020-03-31 00:13:51 +09:00
|
|
|
}
|
|
|
|
|
2020-08-07 11:03:55 +09:00
|
|
|
public function setFileId(int $file_id): self
|
2020-03-31 00:13:51 +09:00
|
|
|
{
|
2020-08-07 11:03:55 +09:00
|
|
|
$this->file_id = $file_id;
|
2020-03-31 00:13:51 +09:00
|
|
|
return $this;
|
|
|
|
}
|
2020-08-09 01:10:25 +09:00
|
|
|
|
2020-08-07 11:03:55 +09:00
|
|
|
public function getFileId(): int
|
2020-03-31 00:13:51 +09:00
|
|
|
{
|
2020-08-07 11:03:55 +09:00
|
|
|
return $this->file_id;
|
2020-03-31 00:13:51 +09:00
|
|
|
}
|
|
|
|
|
2020-05-11 05:43:15 +09:00
|
|
|
public function setCreated(DateTimeInterface $created): self
|
2020-03-31 00:13:51 +09:00
|
|
|
{
|
|
|
|
$this->created = $created;
|
|
|
|
return $this;
|
|
|
|
}
|
2020-08-09 01:10:25 +09:00
|
|
|
|
2020-05-11 05:43:15 +09:00
|
|
|
public function getCreated(): DateTimeInterface
|
2020-03-31 00:13:51 +09:00
|
|
|
{
|
|
|
|
return $this->created;
|
|
|
|
}
|
|
|
|
|
2020-05-11 05:43:15 +09:00
|
|
|
public function setModified(DateTimeInterface $modified): self
|
2020-03-31 00:13:51 +09:00
|
|
|
{
|
|
|
|
$this->modified = $modified;
|
|
|
|
return $this;
|
|
|
|
}
|
2020-08-09 01:10:25 +09:00
|
|
|
|
2020-05-11 05:43:15 +09:00
|
|
|
public function getModified(): DateTimeInterface
|
2020-03-31 00:13:51 +09:00
|
|
|
{
|
|
|
|
return $this->modified;
|
|
|
|
}
|
|
|
|
|
2020-03-30 23:00:13 +09:00
|
|
|
// }}} Autocode
|
2009-02-06 17:13:08 +09:00
|
|
|
|
2020-08-07 11:03:55 +09:00
|
|
|
private ?File $file = null;
|
|
|
|
|
2020-08-09 01:10:25 +09:00
|
|
|
public function getUrl(): string
|
|
|
|
{
|
2020-08-13 08:57:22 +09:00
|
|
|
return Router::url('avatar', ['nickname' => GSActor::getNicknameFromId($this->gsactor_id)]);
|
2020-08-09 01:10:25 +09:00
|
|
|
}
|
|
|
|
|
2020-08-07 11:03:55 +09:00
|
|
|
public function getFile(): File
|
|
|
|
{
|
|
|
|
$this->file = $this->file ?: DB::find('file', ['id' => $this->file_id]);
|
|
|
|
return $this->file;
|
|
|
|
}
|
|
|
|
|
2020-08-09 21:44:47 +09:00
|
|
|
public static function getFilePathStatic(string $filename): string
|
|
|
|
{
|
2020-08-15 07:39:16 +09:00
|
|
|
return Common::config('avatar', 'dir') . $filename;
|
2020-08-09 21:44:47 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
public function getFilePath(): string
|
2020-08-07 11:03:55 +09:00
|
|
|
{
|
2020-08-15 07:39:16 +09:00
|
|
|
return Common::config('avatar', 'dir') . $this->getFile()->getFileName();
|
2020-08-07 11:03:55 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete this avatar and the corresponding file and thumbnails, which this owns
|
|
|
|
*/
|
|
|
|
public function delete(bool $flush = false, bool $delete_files_now = false, bool $cascading = false): array
|
|
|
|
{
|
|
|
|
// Don't go into a loop if we're deleting from File
|
|
|
|
if (!$cascading) {
|
|
|
|
$files = $this->getFile()->delete($cascade = true, $file_flush = false, $delete_files_now);
|
|
|
|
} else {
|
2020-08-13 08:57:22 +09:00
|
|
|
DB::remove(DB::getReference('avatar', ['gsactor_id' => $this->gsactor_id]));
|
2020-08-07 11:03:55 +09:00
|
|
|
$file_path = $this->getFilePath();
|
|
|
|
$files[] = $file_path;
|
|
|
|
if ($flush) {
|
|
|
|
DB::flush();
|
|
|
|
}
|
|
|
|
return $delete_files_now ? [] : $files;
|
|
|
|
}
|
|
|
|
return [];
|
|
|
|
}
|
|
|
|
|
2020-03-30 03:33:16 +09:00
|
|
|
public static function schemaDef(): array
|
2019-09-11 17:25:39 +09:00
|
|
|
{
|
2020-03-30 03:33:16 +09:00
|
|
|
return [
|
|
|
|
'name' => 'avatar',
|
|
|
|
'fields' => [
|
2020-08-13 08:57:22 +09:00
|
|
|
'gsactor_id' => ['type' => 'int', 'not null' => true, 'description' => 'foreign key to gsactor table'],
|
2020-08-07 11:03:55 +09:00
|
|
|
'file_id' => ['type' => 'int', 'not null' => true, 'description' => 'foreign key to file table'],
|
|
|
|
'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'],
|
2020-03-30 03:33:16 +09:00
|
|
|
],
|
2020-08-13 08:57:22 +09:00
|
|
|
'primary key' => ['gsactor_id'],
|
2020-03-30 03:33:16 +09:00
|
|
|
'foreign keys' => [
|
2020-08-13 08:57:22 +09:00
|
|
|
'avatar_gsactor_id_fkey' => ['gsactor', ['gsactor_id' => 'id']],
|
2020-08-07 11:03:55 +09:00
|
|
|
'avatar_file_id_fkey' => ['file', ['file_id' => 'id']],
|
2020-03-30 03:33:16 +09:00
|
|
|
],
|
|
|
|
'indexes' => [
|
2020-08-07 11:03:55 +09:00
|
|
|
'avatar_file_id_idx' => ['file_id'],
|
2020-03-30 03:33:16 +09:00
|
|
|
],
|
|
|
|
];
|
2013-10-01 05:13:37 +09:00
|
|
|
}
|
2008-05-16 01:28:44 +09:00
|
|
|
}
|