2009-05-12 02:45:00 +09:00
< ? php
2020-03-30 03:33:16 +09:00
2020-03-30 04:56:35 +09:00
// {{{ License
2021-02-23 06:34:59 +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/>.
2021-02-23 06:34:59 +09:00
2020-03-30 04:56:35 +09:00
// }}}
2020-03-30 03:33:16 +09:00
namespace App\Entity ;
2019-09-11 14:15:16 +09:00
2020-08-09 01:10:25 +09:00
use App\Core\DB\DB ;
2020-08-07 11:03:55 +09:00
use App\Core\Entity ;
2021-08-05 21:46:28 +09:00
use App\Core\Event ;
2021-07-23 04:57:03 +09:00
use App\Core\GSFile ;
2021-08-05 03:12:37 +09:00
use App\Core\Log ;
2021-04-17 00:57:25 +09:00
use App\Util\Common ;
2020-05-11 05:43:15 +09:00
use DateTimeInterface ;
2019-06-07 22:08:27 +09:00
/**
2020-03-30 03:33:16 +09:00
* Entity for uploaded files
*
* @ category DB
2019-06-07 22:08:27 +09:00
* @ package GNUsocial
2020-03-30 03:33:16 +09:00
*
* @ author Zach Copley < zach @ status . net >
* @ copyright 2010 StatusNet Inc .
2019-06-07 22:08:27 +09:00
* @ author Mikael Nordfeldth < mmn @ hethane . se >
2020-03-30 03:33:16 +09:00
* @ 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
2019-09-11 14:15:16 +09:00
* @ license https :// www . gnu . org / licenses / agpl . html GNU AGPL v3 or later
2009-05-12 02:45:00 +09:00
*/
2021-04-17 04:27:33 +09:00
class Attachment extends Entity
2009-05-12 02:45:00 +09:00
{
2020-03-30 23:00:13 +09:00
// {{{ Autocode
2021-05-06 01:03:03 +09:00
// @codeCoverageIgnoreStart
2020-03-31 00:13:51 +09:00
private int $id ;
2021-04-16 01:58:13 +09:00
private ? string $remote_url ;
private ? string $remote_url_hash ;
2020-07-01 03:20:50 +09:00
private ? string $file_hash ;
2021-03-11 02:20:42 +09:00
private ? int $gsactor_id ;
2020-03-31 00:13:51 +09:00
private ? string $mimetype ;
private ? string $title ;
2021-03-11 02:20:42 +09:00
private ? string $filename ;
2020-07-01 03:20:50 +09:00
private ? bool $is_local ;
2021-04-16 01:58:13 +09:00
private ? int $source ;
2021-04-16 07:28:28 +09:00
private ? int $scope ;
2021-04-30 05:29:21 +09:00
private ? int $size ;
2021-05-02 06:48:44 +09:00
private ? int $width ;
private ? int $height ;
2021-04-28 06:24:48 +09:00
private \DateTimeInterface $modified ;
2020-03-31 00:13:51 +09:00
public function setId ( int $id ) : self
{
$this -> id = $id ;
return $this ;
}
2020-08-09 01:10:25 +09:00
2020-03-31 00:13:51 +09:00
public function getId () : int
{
return $this -> id ;
}
2021-04-16 01:58:13 +09:00
public function setRemoteUrl ( ? string $remote_url ) : self
2020-03-31 00:13:51 +09:00
{
2021-04-16 01:58:13 +09:00
$this -> remote_url = $remote_url ;
2020-03-31 00:13:51 +09:00
return $this ;
}
2020-08-09 01:10:25 +09:00
2021-04-16 01:58:13 +09:00
public function getRemoteUrl () : ? string
2020-03-31 00:13:51 +09:00
{
2021-04-16 01:58:13 +09:00
return $this -> remote_url ;
2020-03-31 00:13:51 +09:00
}
2021-04-16 01:58:13 +09:00
public function setRemoteUrlHash ( ? string $remote_url_hash ) : self
2020-03-31 00:13:51 +09:00
{
2021-04-16 01:58:13 +09:00
$this -> remote_url_hash = $remote_url_hash ;
2020-03-31 00:13:51 +09:00
return $this ;
}
2020-08-09 01:10:25 +09:00
2021-04-16 01:58:13 +09:00
public function getRemoteUrlHash () : ? string
2020-07-01 03:20:50 +09:00
{
2021-04-16 01:58:13 +09:00
return $this -> remote_url_hash ;
2020-07-01 03:20:50 +09:00
}
2020-05-12 02:39:12 +09:00
2020-07-01 03:20:50 +09:00
public function setFileHash ( ? string $file_hash ) : self
{
$this -> file_hash = $file_hash ;
return $this ;
}
2020-08-09 01:10:25 +09:00
2020-07-01 03:20:50 +09:00
public function getFileHash () : ? string
2020-03-31 00:13:51 +09:00
{
2020-07-01 03:20:50 +09:00
return $this -> file_hash ;
2020-03-31 00:13:51 +09:00
}
2021-03-11 02:20:42 +09:00
public function setGSActorId ( ? int $gsactor_id ) : self
2020-08-15 16:06:33 +09:00
{
2021-03-11 02:20:42 +09:00
$this -> gsactor_id = $gsactor_id ;
2020-08-15 16:06:33 +09:00
return $this ;
}
2021-03-11 02:20:42 +09:00
public function getGSActorId () : ? int
2020-08-15 16:06:33 +09:00
{
2021-03-11 02:20:42 +09:00
return $this -> gsactor_id ;
2020-08-15 16:06:33 +09:00
}
2020-03-31 00:13:51 +09:00
public function setMimetype ( ? string $mimetype ) : self
{
$this -> mimetype = $mimetype ;
return $this ;
}
2020-08-09 01:10:25 +09:00
2020-03-31 00:13:51 +09:00
public function getMimetype () : ? string
{
return $this -> mimetype ;
}
2021-07-23 04:57:03 +09:00
public function getMimetypeMajor () : ? string
{
$mime = $this -> getMimetype ();
return is_null ( $mime ) ? $mime : GSFile :: mimetypeMajor ( $mime );
}
public function getMimetypeMinor () : ? string
{
$mime = $this -> getMimetype ();
return is_null ( $mime ) ? $mime : GSFile :: mimetypeMinor ( $mime );
}
2020-03-31 00:13:51 +09:00
public function setTitle ( ? string $title ) : self
{
$this -> title = $title ;
return $this ;
}
2020-08-09 01:10:25 +09:00
2020-03-31 00:13:51 +09:00
public function getTitle () : ? string
{
return $this -> title ;
}
2021-03-11 02:20:42 +09:00
public function setFilename ( ? string $filename ) : self
{
$this -> filename = $filename ;
return $this ;
}
public function getFilename () : ? string
{
return $this -> filename ;
}
2020-07-01 03:20:50 +09:00
public function setIsLocal ( ? bool $is_local ) : self
2020-03-31 00:13:51 +09:00
{
2020-07-01 03:20:50 +09:00
$this -> is_local = $is_local ;
2020-03-31 00:13:51 +09:00
return $this ;
}
2020-08-09 01:10:25 +09:00
2020-07-01 03:20:50 +09:00
public function getIsLocal () : ? bool
2020-03-31 00:13:51 +09:00
{
2020-07-01 03:20:50 +09:00
return $this -> is_local ;
2020-03-31 00:13:51 +09:00
}
2021-04-16 01:58:13 +09:00
public function setSource ( ? int $source ) : self
2020-08-20 09:43:33 +09:00
{
2021-04-16 01:58:13 +09:00
$this -> source = $source ;
2020-08-20 09:43:33 +09:00
return $this ;
}
2021-04-16 01:58:13 +09:00
public function getSource () : ? int
2020-08-20 09:43:33 +09:00
{
2021-04-16 01:58:13 +09:00
return $this -> source ;
2020-08-20 09:43:33 +09:00
}
2021-04-16 07:28:28 +09:00
public function setScope ( ? int $scope ) : self
{
$this -> scope = $scope ;
return $this ;
}
public function getScope () : ? int
{
return $this -> scope ;
}
2021-04-30 05:29:21 +09:00
public function setSize ( ? int $size ) : self
{
$this -> size = $size ;
return $this ;
}
public function getSize () : ? int
{
return $this -> size ;
}
2021-05-02 06:48:44 +09:00
public function setWidth ( ? int $width ) : self
{
$this -> width = $width ;
return $this ;
}
public function getWidth () : ? int
{
return $this -> width ;
}
public function setHeight ( ? int $height ) : self
{
$this -> height = $height ;
return $this ;
}
public function getHeight () : ? int
{
return $this -> height ;
}
2021-05-03 00:48:06 +09:00
public function setModified ( DateTimeInterface $modified ) : self
2020-03-31 00:13:51 +09:00
{
2020-08-07 11:03:55 +09:00
$this -> modified = $modified ;
2020-03-31 00:13:51 +09:00
return $this ;
}
2020-08-09 01:10:25 +09:00
2021-05-03 00:48:06 +09:00
public function getModified () : DateTimeInterface
2020-03-31 00:13:51 +09:00
{
2020-08-07 11:03:55 +09:00
return $this -> modified ;
2020-03-31 00:13:51 +09:00
}
2021-05-06 01:03:03 +09:00
// @codeCoverageIgnoreEnd
2020-08-07 11:03:55 +09:00
// }}} Autocode
const URLHASH_ALGO = 'sha256' ;
const FILEHASH_ALGO = 'sha256' ;
/**
2021-08-05 21:46:28 +09:00
*
* Warning : Underlying DB :: findBy doesn ' t respect remove persistence
* @ return int
*/
public function countDependencies () : int
{
$attachment_id = $this -> getId ();
$notes = DB :: findBy ( 'attachment_to_note' , [ 'attachment_id' => $attachment_id ]);
$dependencies = count ( $notes );
Event :: handle ( 'AttachmentCountDependencies' , [ $attachment_id , & $dependencies ]);
return $dependencies ;
}
/**
*
* @ depends Attachment -> countDependencies ()
* @ return bool
*/
public function isSafeDelete () : bool
{
return $this -> countDependencies () === 0 ;
}
/**
* Delete this attachment and optionally all the associated entities ( avatar and / or thumbnails , which this owns )
2020-08-07 11:03:55 +09:00
*/
2021-04-30 03:12:32 +09:00
public function delete ( bool $cascade = true , bool $flush = true ) : void
2020-03-31 00:13:51 +09:00
{
2020-08-07 11:03:55 +09:00
$files = [];
if ( $cascade ) {
2021-04-30 03:12:32 +09:00
foreach ( $this -> getThumbnails () as $at ) {
$files [] = $at -> getPath ();
$at -> delete ( flush : false );
2020-08-07 11:03:55 +09:00
}
}
2021-04-30 03:12:32 +09:00
$files [] = $this -> getPath ();
2020-08-07 11:03:55 +09:00
DB :: remove ( $this );
if ( $flush ) {
DB :: flush ();
}
2021-04-30 03:12:32 +09:00
foreach ( $files as $f ) {
if ( file_exists ( $f )) {
if ( @ unlink ( $f ) === false ) {
Log :: warning ( " Failed deleting file for attachment with id= { $this -> id } at { $f } " );
}
}
2020-08-07 11:03:55 +09:00
}
2020-03-31 00:13:51 +09:00
}
2020-08-07 11:03:55 +09:00
2021-04-30 03:12:32 +09:00
/**
* Find all thumbnails associated with this attachment . Don ' t bother caching as this is not supposed to be a common operation
*/
public function getThumbnails ()
2020-03-31 00:13:51 +09:00
{
2021-04-30 03:12:32 +09:00
return DB :: findBy ( 'attachment_thumbnail' , [ 'attachment_id' => $this -> id ]);
2020-03-31 00:13:51 +09:00
}
2021-04-17 00:57:25 +09:00
public function getPath ()
{
return Common :: config ( 'attachments' , 'dir' ) . $this -> getFilename ();
}
2021-04-26 06:26:53 +09:00
public function getAttachmentUrl ()
{
return Router :: url ( 'attachment_thumbnail' , [ 'id' => $this -> getAttachmentId (), 'w' => Common :: config ( 'attachment' , 'width' ), 'h' => Common :: config ( 'attachment' , 'height' )]);
}
2020-03-30 03:33:16 +09:00
public static function schemaDef () : array
{
return [
2021-04-16 07:28:28 +09:00
'name' => 'attachment' ,
2020-03-30 03:33:16 +09:00
'fields' => [
2021-04-15 08:30:35 +09:00
'id' => [ 'type' => 'serial' , 'not null' => true ],
'remote_url' => [ 'type' => 'text' , 'description' => 'URL after following possible redirections' ],
'remote_url_hash' => [ 'type' => 'varchar' , 'length' => 64 , 'description' => 'sha256 of destination URL (url field)' ],
'file_hash' => [ 'type' => 'varchar' , 'length' => 64 , 'description' => 'sha256 of the file contents, if the file is stored locally' ],
'gsactor_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'GSActor.id' , 'multiplicity' => 'one to one' , 'description' => 'If set, used so each actor can have a version of this file (for avatars, for instance)' ],
'mimetype' => [ 'type' => 'varchar' , 'length' => 50 , 'description' => 'mime type of resource' ],
'title' => [ 'type' => 'text' , 'description' => 'title of resource when available' ],
2021-04-29 00:03:17 +09:00
'filename' => [ 'type' => 'varchar' , 'length' => 191 , 'description' => 'file name of resource when available' ],
2021-04-15 08:30:35 +09:00
'is_local' => [ 'type' => 'bool' , 'description' => 'whether the file is stored locally' ],
'source' => [ 'type' => 'int' , 'default' => null , 'description' => 'Source of the Attachment (upload, TFN, embed)' ],
2021-04-16 07:28:28 +09:00
'scope' => [ 'type' => 'int' , 'default' => null , 'description' => 'visibility scope for this attachment' ],
2021-04-30 05:29:21 +09:00
'size' => [ 'type' => 'int' , 'description' => 'size of resource when available' ],
2021-05-02 06:48:44 +09:00
'width' => [ 'type' => 'int' , 'description' => 'width in pixels, if it can be described as such and data is available' ],
'height' => [ 'type' => 'int' , 'description' => 'height in pixels, if it can be described as such and data is available' ],
2021-04-15 08:30:35 +09:00
'modified' => [ 'type' => 'timestamp' , 'not null' => true , 'default' => 'CURRENT_TIMESTAMP' , 'description' => 'date this record was modified' ],
2020-03-30 03:33:16 +09:00
],
'primary key' => [ 'id' ],
'unique keys' => [
2021-05-03 00:48:06 +09:00
'attachment_file_hash_uniq' => [ 'file_hash' ],
2020-03-30 03:33:16 +09:00
],
'indexes' => [
2020-07-01 01:26:40 +09:00
'file_filehash_idx' => [ 'file_hash' ],
2020-03-30 03:33:16 +09:00
],
2020-08-14 05:56:31 +09:00
];
2015-02-20 02:59:28 +09:00
}
2016-02-03 08:22:18 +09:00
}