<?php
-
/**
- * @file src/Model/Attach.php
- * @brief This file contains the Attach class for database interface
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Model;
-use Friendica\BaseObject;
use Friendica\Core\System;
-use Friendica\Core\StorageManager;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
+use Friendica\Core\Storage\Exception\InvalidClassStorageException;
+use Friendica\Core\Storage\Exception\ReferenceStorageException;
use Friendica\Object\Image;
-use Friendica\Util\Security;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Mimetype;
+use Friendica\Security\Security;
/**
* Class to handle attach dabatase table
*/
-class Attach extends BaseObject
+class Attach
{
/**
- * @brief Return a list of fields that are associated with the attach table
+ * Return a list of fields that are associated with the attach table
*
* @return array field list
* @throws \Exception
*/
- private static function getFields()
+ private static function getFields(): array
{
- $allfields = DBStructure::definition(false);
+ $allfields = DBStructure::definition(DI::app()->getBasePath(), false);
$fields = array_keys($allfields['attach']['fields']);
array_splice($fields, array_search('data', $fields), 1);
return $fields;
}
/**
- * @brief Select rows from the attach table
+ * Select rows from the attach table and return them as array
*
* @param array $fields Array of selected fields, empty for all
* @param array $conditions Array of fields for conditions
* @param array $params Array of several parameters
*
- * @return boolean|array
+ * @return array|bool
*
* @throws \Exception
- * @see \Friendica\Database\DBA::select
+ * @see \Friendica\Database\DBA::selectToArray
*/
- public static function select(array $fields = [], array $conditions = [], array $params = [])
+ public static function selectToArray(array $fields = [], array $conditions = [], array $params = [])
{
if (empty($fields)) {
$fields = self::getFields();
}
- $r = DBA::select('attach', $fields, $conditions, $params);
- return DBA::toArray($r);
+ return DBA::selectToArray('attach', $fields, $conditions, $params);
}
/**
- * @brief Retrieve a single record from the attach table
+ * Retrieve a single record from the attach table
*
* @param array $fields Array of selected fields, empty for all
* @param array $conditions Array of fields for conditions
}
/**
- * @brief Check if attachment with given conditions exists
+ * Check if attachment with given conditions exists
*
* @param array $conditions Array of extra conditions
*
* @return boolean
* @throws \Exception
*/
- public static function exists(array $conditions)
+ public static function exists(array $conditions): bool
{
return DBA::exists('attach', $conditions);
}
/**
- * @brief Retrive a single record given the ID
+ * Retrive a single record given the ID
*
* @param int $id Row id of the record
*
* @throws \Exception
* @see \Friendica\Database\DBA::select
*/
- public static function getById($id)
+ public static function getById(int $id)
{
return self::selectFirst([], ['id' => $id]);
}
/**
- * @brief Retrive a single record given the ID
+ * Retrive a single record given the ID
*
* @param int $id Row id of the record
*
* @throws \Exception
* @see \Friendica\Database\DBA::select
*/
- public static function getByIdWithPermission($id)
+ public static function getByIdWithPermission(int $id)
{
$r = self::selectFirst(['uid'], ['id' => $id]);
if ($r === false) {
}
/**
- * @brief Get file data for given row id. null if row id does not exist
+ * Get file data for given row id. null if row id does not exist
*
* @param array $item Attachment data. Needs at least 'id', 'backend-class', 'backend-ref'
*
- * @return string file data
+ * @return string|null file data or null on failure
* @throws \Exception
*/
- public static function getData($item)
+ public static function getData(array $item)
{
- if ($item['backend-class'] == '') {
+ if (!empty($item['data'])) {
+ return $item['data'];
+ }
+
+ try {
+ $backendClass = DI::storageManager()->getByName($item['backend-class'] ?? '');
+ $backendRef = $item['backend-ref'];
+ return $backendClass->get($backendRef);
+ } catch (InvalidClassStorageException $storageException) {
// legacy data storage in 'data' column
$i = self::selectFirst(['data'], ['id' => $item['id']]);
if ($i === false) {
return null;
}
return $i['data'];
- } else {
- $backendClass = $item['backend-class'];
- $backendRef = $item['backend-ref'];
- return $backendClass::get($backendRef);
+ } catch (ReferenceStorageException $referenceStorageException) {
+ DI::logger()->debug('No data found for item', ['item' => $item, 'exception' => $referenceStorageException]);
+ return '';
}
}
/**
- * @brief Store new file metadata in db and binary in default backend
+ * Store new file metadata in db and binary in default backend
*
* @param string $data Binary data
* @param integer $uid User ID
* @param string $deny_cid Permissions, denied contacts.optional, default = ''
* @param string $deny_gid Permissions, denied greoup.optional, default = ''
*
- * @return boolean/integer Row id on success, False on errors
+ * @return boolean|integer Row id on success, False on errors
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public function store($data, $uid, $filename, $filetype = '' , $filesize = null, $allow_cid = '', $allow_gid = '', $deny_cid = '', $deny_gid = '')
+ public static function store(string $data, int $uid, string $filename, string $filetype = '' , int $filesize = null, string $allow_cid = '', string $allow_gid = '', string $deny_cid = '', string $deny_gid = '')
{
if ($filetype === '') {
$filetype = Mimetype::getContentType($filename);
$filesize = strlen($data);
}
- $backend_class = StorageManager::getBackend();
- $backend_ref = '';
- if ($backend_class !== '') {
- $backend_ref = $backend_class::put($data);
- $data = '';
- }
+ $backend_ref = DI::storage()->put($data);
+ $data = '';
$hash = System::createGUID(64);
$created = DateTimeFormat::utcNow();
'allow_gid' => $allow_gid,
'deny_cid' => $deny_cid,
'deny_gid' => $deny_gid,
- 'backend-class' => $backend_class,
+ 'backend-class' => (string)DI::storage(),
'backend-ref' => $backend_ref
];
}
/**
- * @brief Store new file metadata in db and binary in default backend from existing file
+ * Store new file metadata in db and binary in default backend from existing file
*
- * @param $src
- * @param $uid
- * @param string $filename
+ * @param string $src Source file name
+ * @param int $uid User id
+ * @param string $filename Optional file name
* @param string $allow_cid
* @param string $allow_gid
* @param string $deny_cid
* @param string $deny_gid
- * @return boolean True on success
+ * @return boolean|int Insert id or false on failure
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function storeFile($src, $uid, $filename = '', $allow_cid = '', $allow_gid = '', $deny_cid = '', $deny_gid = '')
+ public static function storeFile(string $src, int $uid, string $filename = '', string $allow_cid = '', string $allow_gid = '', string $deny_cid = '', string $deny_gid = '')
{
if ($filename === '') {
$filename = basename($src);
/**
- * @brief Update an attached file
+ * Update an attached file
*
* @param array $fields Contains the fields that are updated
* @param array $conditions Condition array with the key values
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @see \Friendica\Database\DBA::update
*/
- public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
+ public static function update(array $fields, array $conditions, Image $img = null, array $old_fields = []): bool
{
if (!is_null($img)) {
// get items to update
- $items = self::select(['backend-class','backend-ref'], $conditions);
+ $items = self::selectToArray(['backend-class','backend-ref'], $conditions);
foreach($items as $item) {
- $backend_class = (string)$item['backend-class'];
- if ($backend_class !== '') {
- $fields['backend-ref'] = $backend_class::put($img->asString(), $item['backend-ref']);
- } else {
- $fields['data'] = $img->asString();
+ try {
+ $backend_class = DI::storageManager()->getWritableStorageByName($item['backend-class'] ?? '');
+ $fields['backend-ref'] = $backend_class->put($img->asString(), $item['backend-ref'] ?? '');
+ } catch (InvalidClassStorageException $storageException) {
+ DI::logger()->debug('Storage class not found.', ['conditions' => $conditions, 'exception' => $storageException]);
+ } catch (ReferenceStorageException $referenceStorageException) {
+ DI::logger()->debug('Item doesn\'t exist.', ['conditions' => $conditions, 'exception' => $referenceStorageException]);
}
}
}
/**
- * @brief Delete info from table and data from storage
+ * Delete info from table and data from storage
*
* @param array $conditions Field condition(s)
* @param array $options Options array, Optional
* @throws \Exception
* @see \Friendica\Database\DBA::delete
*/
- public static function delete(array $conditions, array $options = [])
+ public static function delete(array $conditions, array $options = []): bool
{
// get items to delete data info
- $items = self::select(['backend-class','backend-ref'], $conditions);
+ $items = self::selectToArray(['backend-class','backend-ref'], $conditions);
foreach($items as $item) {
- $backend_class = (string)$item['backend-class'];
- if ($backend_class !== '') {
- $backend_class::delete($item['backend-ref']);
+ try {
+ $backend_class = DI::storageManager()->getWritableStorageByName($item['backend-class'] ?? '');
+ $backend_class->delete($item['backend-ref'] ?? '');
+ } catch (InvalidClassStorageException $storageException) {
+ DI::logger()->debug('Storage class not found.', ['conditions' => $conditions, 'exception' => $storageException]);
+ } catch (ReferenceStorageException $referenceStorageException) {
+ DI::logger()->debug('Item doesn\'t exist.', ['conditions' => $conditions, 'exception' => $referenceStorageException]);
}
}