4 * @file src/Model/Attach.php
5 * @brief This file contains the Attach class for database interface
7 namespace Friendica\Model;
9 use Friendica\Core\StorageManager;
10 use Friendica\Core\System;
11 use Friendica\Database\DBA;
12 use Friendica\Database\DBStructure;
14 use Friendica\Model\Storage\IStorage;
15 use Friendica\Object\Image;
16 use Friendica\Util\DateTimeFormat;
17 use Friendica\Util\Mimetype;
18 use Friendica\Util\Security;
21 * Class to handle attach dabatase table
27 * @brief Return a list of fields that are associated with the attach table
29 * @return array field list
32 private static function getFields()
34 $allfields = DBStructure::definition(DI::app()->getBasePath(), false);
35 $fields = array_keys($allfields['attach']['fields']);
36 array_splice($fields, array_search('data', $fields), 1);
41 * @brief Select rows from the attach table and return them as array
43 * @param array $fields Array of selected fields, empty for all
44 * @param array $conditions Array of fields for conditions
45 * @param array $params Array of several parameters
50 * @see \Friendica\Database\DBA::selectToArray
52 public static function selectToArray(array $fields = [], array $conditions = [], array $params = [])
55 $fields = self::getFields();
58 return DBA::selectToArray('attach', $fields, $conditions, $params);
62 * @brief Retrieve a single record from the attach table
64 * @param array $fields Array of selected fields, empty for all
65 * @param array $conditions Array of fields for conditions
66 * @param array $params Array of several parameters
71 * @see \Friendica\Database\DBA::select
73 public static function selectFirst(array $fields = [], array $conditions = [], array $params = [])
76 $fields = self::getFields();
79 return DBA::selectFirst('attach', $fields, $conditions, $params);
83 * @brief Check if attachment with given conditions exists
85 * @param array $conditions Array of extra conditions
90 public static function exists(array $conditions)
92 return DBA::exists('attach', $conditions);
96 * @brief Retrive a single record given the ID
98 * @param int $id Row id of the record
103 * @see \Friendica\Database\DBA::select
105 public static function getById($id)
107 return self::selectFirst([], ['id' => $id]);
111 * @brief Retrive a single record given the ID
113 * @param int $id Row id of the record
118 * @see \Friendica\Database\DBA::select
120 public static function getByIdWithPermission($id)
122 $r = self::selectFirst(['uid'], ['id' => $id]);
127 $sql_acl = Security::getPermissionsSQLByUserId($r['uid']);
130 '`id` = ?' . $sql_acl,
134 $item = self::selectFirst([], $conditions);
140 * @brief Get file data for given row id. null if row id does not exist
142 * @param array $item Attachment data. Needs at least 'id', 'backend-class', 'backend-ref'
144 * @return string file data
147 public static function getData($item)
149 if ($item['backend-class'] == '') {
150 // legacy data storage in 'data' column
151 $i = self::selectFirst(['data'], ['id' => $item['id']]);
157 $backendClass = $item['backend-class'];
158 $backendRef = $item['backend-ref'];
159 return $backendClass::get($backendRef);
164 * @brief Store new file metadata in db and binary in default backend
166 * @param string $data Binary data
167 * @param integer $uid User ID
168 * @param string $filename Filename
169 * @param string $filetype Mimetype. optional, default = ''
170 * @param integer $filesize File size in bytes. optional, default = null
171 * @param string $allow_cid Permissions, allowed contacts. optional, default = ''
172 * @param string $allow_gid Permissions, allowed groups. optional, default = ''
173 * @param string $deny_cid Permissions, denied contacts.optional, default = ''
174 * @param string $deny_gid Permissions, denied greoup.optional, default = ''
176 * @return boolean/integer Row id on success, False on errors
177 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
179 public static function store($data, $uid, $filename, $filetype = '' , $filesize = null, $allow_cid = '', $allow_gid = '', $deny_cid = '', $deny_gid = '')
181 if ($filetype === '') {
182 $filetype = Mimetype::getContentType($filename);
185 if (is_null($filesize)) {
186 $filesize = strlen($data);
189 $backend_ref = DI::storage()->put($data);
192 $hash = System::createGUID(64);
193 $created = DateTimeFormat::utcNow();
198 'filename' => $filename,
199 'filetype' => $filetype,
200 'filesize' => $filesize,
202 'created' => $created,
203 'edited' => $created,
204 'allow_cid' => $allow_cid,
205 'allow_gid' => $allow_gid,
206 'deny_cid' => $deny_cid,
207 'deny_gid' => $deny_gid,
208 'backend-class' => (string)DI::storage(),
209 'backend-ref' => $backend_ref
212 $r = DBA::insert('attach', $fields);
214 return DBA::lastInsertId();
220 * @brief Store new file metadata in db and binary in default backend from existing file
224 * @param string $filename
225 * @param string $allow_cid
226 * @param string $allow_gid
227 * @param string $deny_cid
228 * @param string $deny_gid
229 * @return boolean True on success
230 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
232 public static function storeFile($src, $uid, $filename = '', $allow_cid = '', $allow_gid = '', $deny_cid = '', $deny_gid = '')
234 if ($filename === '') {
235 $filename = basename($src);
238 $data = @file_get_contents($src);
240 return self::store($data, $uid, $filename, '', null, $allow_cid, $allow_gid, $deny_cid, $deny_gid);
245 * @brief Update an attached file
247 * @param array $fields Contains the fields that are updated
248 * @param array $conditions Condition array with the key values
249 * @param Image $img Image data to update. Optional, default null.
250 * @param array|boolean $old_fields Array with the old field values that are about to be replaced (true = update on duplicate)
252 * @return boolean Was the update successful?
254 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
255 * @see \Friendica\Database\DBA::update
257 public static function update($fields, $conditions, Image $img = null, array $old_fields = [])
259 if (!is_null($img)) {
260 // get items to update
261 $items = self::selectToArray(['backend-class','backend-ref'], $conditions);
263 foreach($items as $item) {
264 /** @var IStorage $backend_class */
265 $backend_class = (string)$item['backend-class'];
266 if ($backend_class !== '') {
267 $fields['backend-ref'] = $backend_class::put($img->asString(), $item['backend-ref']);
269 $fields['data'] = $img->asString();
274 $fields['edited'] = DateTimeFormat::utcNow();
276 return DBA::update('attach', $fields, $conditions, $old_fields);
281 * @brief Delete info from table and data from storage
283 * @param array $conditions Field condition(s)
284 * @param array $options Options array, Optional
289 * @see \Friendica\Database\DBA::delete
291 public static function delete(array $conditions, array $options = [])
293 // get items to delete data info
294 $items = self::selectToArray(['backend-class','backend-ref'], $conditions);
296 foreach($items as $item) {
297 /** @var IStorage $backend_class */
298 $backend_class = (string)$item['backend-class'];
299 if ($backend_class !== '') {
300 $backend_class::delete($item['backend-ref']);
304 return DBA::delete('attach', $conditions, $options);