strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Changes:

Browse source 
- added type-hints
- added documentation
- changed double-quotes to single
This commit is contained in:
Roland Häder 2022-06-18 23:12:25 +02:00
parent f3b57008b5
commit fa14a02a19
Signed by: roland
GPG key ID: C82EDE5DDFA0BA77
2 changed files with 50 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
src/Model/Post/Media.php
View file

@ -109,7 +109,7 @@ class Media
* @param array $media * @param array $media
* @return array cleaned media array * @return array cleaned media array
*/ */
private static function unsetEmptyFields(array $media) private static function unsetEmptyFields(array $media): array
{ {
$fields = ['mimetype', 'height', 'width', 'size', 'preview', 'preview-height', 'preview-width', 'description']; $fields = ['mimetype', 'height', 'width', 'size', 'preview', 'preview-height', 'preview-width', 'description'];
foreach ($fields as $field) { foreach ($fields as $field) {
@ -145,7 +145,7 @@ class Media
* @param string $title * @param string $title
* @return string "[attach]" element * @return string "[attach]" element
*/ */
public static function getAttachElement(string $href, int $length, string $type, string $title = '') public static function getAttachElement(string $href, int $length, string $type, string $title = ''): string
{ {
$media = self::fetchAdditionalData(['type' => self::DOCUMENT, 'url' => $href, $media = self::fetchAdditionalData(['type' => self::DOCUMENT, 'url' => $href,
'size' => $length, 'mimetype' => $type, 'description' => $title]); 'size' => $length, 'mimetype' => $type, 'description' => $title]);
@ -160,7 +160,7 @@ class Media
* @param array $media * @param array $media
* @return array media array with additional data * @return array media array with additional data
*/ */
public static function fetchAdditionalData(array $media) public static function fetchAdditionalData(array $media): array
{ {
if (Network::isLocalLink($media['url'])) { if (Network::isLocalLink($media['url'])) {
$media = self::fetchLocalData($media); $media = self::fetchLocalData($media);
@ -235,7 +235,7 @@ class Media
* @param array $media * @param array $media
* @return array media with added data * @return array media with added data
*/ */
private static function fetchLocalData(array $media) private static function fetchLocalData(array $media): array
{ {
if (!preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $media['url'] ?? '', $matches)) { if (!preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $media['url'] ?? '', $matches)) {
return $media; return $media;
@ -266,7 +266,7 @@ class Media
* @param array $data * @param array $data
* @return array data array with the detected type * @return array data array with the detected type
*/ */
public static function addType(array $data) public static function addType(array $data): array
{ {
if (empty($data['mimetype'])) { if (empty($data['mimetype'])) {
Logger::info('No MimeType provided', ['media' => $data]); Logger::info('No MimeType provided', ['media' => $data]);
@ -318,7 +318,7 @@ class Media
* @param string $preview Preview picture * @param string $preview Preview picture
* @return boolean * @return boolean
*/ */
private static function isPictureLink(string $page, string $preview) private static function isPictureLink(string $page, string $preview): bool
{ {
return preg_match('#/photos/.*/image/#ism', $page) && preg_match('#/photo/.*-1\.#ism', $preview); return preg_match('#/photos/.*/image/#ism', $page) && preg_match('#/photo/.*-1\.#ism', $preview);
} }
@ -330,7 +330,7 @@ class Media
* @param string $body * @param string $body
* @return string Body without media links * @return string Body without media links
*/ */
public static function insertFromBody(int $uriid, string $body) public static function insertFromBody(int $uriid, string $body): string
{ {
// Simplify image codes // Simplify image codes
$unshared_body = $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body); $unshared_body = $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
@ -413,6 +413,7 @@ class Media
* *
* @param integer $uriid * @param integer $uriid
* @param string $body * @param string $body
* @return void
*/ */
public static function insertFromRelevantUrl(int $uriid, string $body) public static function insertFromRelevantUrl(int $uriid, string $body)
{ {
@ -448,6 +449,7 @@ class Media
* *
* @param integer $uriid * @param integer $uriid
* @param string $body * @param string $body
* @return void
*/ */
public static function insertFromAttachmentData(int $uriid, string $body) public static function insertFromAttachmentData(int $uriid, string $body)
{ {
@ -506,9 +508,9 @@ class Media
/** /**
* Retrieves the media attachments associated with the provided item ID. * Retrieves the media attachments associated with the provided item ID.
* *
* @param int $uri_id * @param int $uri_id URI id
* @param array $types * @param array $types Media types
* @return array * @return array|bool Array on success, false on error
* @throws \Exception * @throws \Exception
*/ */
public static function getByURIId(int $uri_id, array $types = []) public static function getByURIId(int $uri_id, array $types = [])
@ -525,12 +527,12 @@ class Media
/** /**
* Checks if media attachments are associated with the provided item ID. * Checks if media attachments are associated with the provided item ID.
* *
* @param int $uri_id * @param int $uri_id URI id
* @param array $types * @param array $types Media types
* @return array * @return bool Whether media attachment exists
* @throws \Exception * @throws \Exception
*/ */
public static function existsByURIId(int $uri_id, array $types = []) public static function existsByURIId(int $uri_id, array $types = []): bool
{ {
$condition = ['uri-id' => $uri_id]; $condition = ['uri-id' => $uri_id];
@ -544,13 +546,13 @@ class Media
/** /**
* Split the attachment media in the three segments "visual", "link" and "additional" * Split the attachment media in the three segments "visual", "link" and "additional"
* *
* @param int $uri_id * @param int $uri_id URI id
* @param string $guid * @param string $guid GUID
* @param array $links list of links that shouldn't be added * @param array $links list of links that shouldn't be added
* @param bool $has_media * @param bool $has_media
* @return array attachments * @return array attachments
*/ */
public static function splitAttachments(int $uri_id, string $guid = '', array $links = [], bool $has_media = true) public static function splitAttachments(int $uri_id, string $guid = '', array $links = [], bool $has_media = true): array
{ {
$attachments = ['visual' => [], 'link' => [], 'additional' => []]; $attachments = ['visual' => [], 'link' => [], 'additional' => []];
@ -648,7 +650,7 @@ class Media
* @param string $body * @param string $body
* @return string body * @return string body
*/ */
public static function addAttachmentsToBody(int $uriid, string $body = '') public static function addAttachmentsToBody(int $uriid, string $body = ''): string
{ {
if (empty($body)) { if (empty($body)) {
$item = Post::selectFirst(['body'], ['uri-id' => $uriid]); $item = Post::selectFirst(['body'], ['uri-id' => $uriid]);
@ -701,7 +703,7 @@ class Media
* @param string $size One of the Proxy::SIZE_* constants * @param string $size One of the Proxy::SIZE_* constants
* @return string preview link * @return string preview link
*/ */
public static function getPreviewUrlForId(int $id, string $size = ''):string public static function getPreviewUrlForId(int $id, string $size = ''): string
{ {
$url = DI::baseUrl() . '/photo/preview/'; $url = DI::baseUrl() . '/photo/preview/';
switch ($size) { switch ($size) {
@ -731,7 +733,7 @@ class Media
* @param string $size One of the Proxy::SIZE_* constants * @param string $size One of the Proxy::SIZE_* constants
* @return string media link * @return string media link
*/ */
public static function getUrlForId(int $id, string $size = ''):string public static function getUrlForId(int $id, string $size = ''): string
{ {
$url = DI::baseUrl() . '/photo/media/'; $url = DI::baseUrl() . '/photo/media/';
switch ($size) { switch ($size) {

48
src/Module/Photo.php
View file

@ -128,7 +128,7 @@ class Photo extends BaseModule
throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo is not available.')); throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo is not available.'));
} }
$photo = self::getPhotoByid($id, $this->parameters['type'], $customsize ?: Proxy::PIXEL_SMALL); $photo = self::getPhotoById($id, $this->parameters['type'], $customsize ?: Proxy::PIXEL_SMALL);
} else { } else {
$photoid = pathinfo($this->parameters['name'], PATHINFO_FILENAME); $photoid = pathinfo($this->parameters['name'], PATHINFO_FILENAME);
$scale = 0; $scale = 0;
@ -228,10 +228,18 @@ class Photo extends BaseModule
System::exit(); System::exit();
} }
private static function getPhotoByid(int $id, $type, $customsize) /**
* Fetches photo record by given id number, type and custom size
*
* @param int $id Photo id
* @param string $type Photo type
* @param int $customsize Custom size (?)
* @return array|bool Array on success, false on error
*/
private static function getPhotoById(int $id, string $type, int $customsize)
{ {
switch($type) { switch($type) {
case "preview": case 'preview':
$media = DBA::selectFirst('post-media', ['preview', 'url', 'mimetype', 'type', 'uri-id'], ['id' => $id]); $media = DBA::selectFirst('post-media', ['preview', 'url', 'mimetype', 'type', 'uri-id'], ['id' => $id]);
if (empty($media)) { if (empty($media)) {
return false; return false;
@ -251,7 +259,7 @@ class Photo extends BaseModule
} }
return MPhoto::createPhotoForExternalResource($url, (int)local_user(), $media['mimetype']); return MPhoto::createPhotoForExternalResource($url, (int)local_user(), $media['mimetype']);
case "media": case 'media':
$media = DBA::selectFirst('post-media', ['url', 'mimetype', 'uri-id'], ['id' => $id, 'type' => Post\Media::IMAGE]); $media = DBA::selectFirst('post-media', ['url', 'mimetype', 'uri-id'], ['id' => $id, 'type' => Post\Media::IMAGE]);
if (empty($media)) { if (empty($media)) {
return false; return false;
@ -262,14 +270,14 @@ class Photo extends BaseModule
} }
return MPhoto::createPhotoForExternalResource($media['url'], (int)local_user(), $media['mimetype']); return MPhoto::createPhotoForExternalResource($media['url'], (int)local_user(), $media['mimetype']);
case "link": case 'link':
$link = DBA::selectFirst('post-link', ['url', 'mimetype'], ['id' => $id]); $link = DBA::selectFirst('post-link', ['url', 'mimetype'], ['id' => $id]);
if (empty($link)) { if (empty($link)) {
return false; return false;
} }
return MPhoto::createPhotoForExternalResource($link['url'], (int)local_user(), $link['mimetype']); return MPhoto::createPhotoForExternalResource($link['url'], (int)local_user(), $link['mimetype']);
case "contact": case 'contact':
$fields = ['uid', 'uri-id', 'url', 'nurl', 'avatar', 'photo', 'xmpp', 'addr', 'network', 'failed', 'updated']; $fields = ['uid', 'uri-id', 'url', 'nurl', 'avatar', 'photo', 'xmpp', 'addr', 'network', 'failed', 'updated'];
$contact = Contact::getById($id, $fields); $contact = Contact::getById($id, $fields);
if (empty($contact)) { if (empty($contact)) {
@ -287,7 +295,7 @@ class Photo extends BaseModule
} else { } else {
$scale = 4; $scale = 4;
} }
$photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $contact['uid'], "profile" => 1]); $photo = MPhoto::selectFirst([], ['scale' => $scale, 'uid' => $contact['uid'], 'profile' => 1]);
if (!empty($photo)) { if (!empty($photo)) {
return $photo; return $photo;
} }
@ -330,7 +338,7 @@ class Photo extends BaseModule
} }
if ($update) { if ($update) {
Logger::info('Invalid file, contact update initiated', ['cid' => $id, 'url' => $contact['url'], 'avatar' => $url]); Logger::info('Invalid file, contact update initiated', ['cid' => $id, 'url' => $contact['url'], 'avatar' => $url]);
Worker::add(PRIORITY_LOW, "UpdateContact", $id); Worker::add(PRIORITY_LOW, 'UpdateContact', $id);
} else { } else {
Logger::info('Invalid file', ['cid' => $id, 'url' => $contact['url'], 'avatar' => $url]); Logger::info('Invalid file', ['cid' => $id, 'url' => $contact['url'], 'avatar' => $url]);
} }
@ -352,7 +360,7 @@ class Photo extends BaseModule
} }
} }
return MPhoto::createPhotoForExternalResource($url, 0, $mimetext); return MPhoto::createPhotoForExternalResource($url, 0, $mimetext);
case "header": case 'header':
$fields = ['uid', 'url', 'header', 'network', 'gsid']; $fields = ['uid', 'url', 'header', 'network', 'gsid'];
$contact = Contact::getById($id, $fields); $contact = Contact::getById($id, $fields);
if (empty($contact)) { if (empty($contact)) {
@ -367,37 +375,37 @@ class Photo extends BaseModule
$url = Contact::getDefaultHeader($contact); $url = Contact::getDefaultHeader($contact);
} }
return MPhoto::createPhotoForExternalResource($url); return MPhoto::createPhotoForExternalResource($url);
case "banner": case 'banner':
$photo = MPhoto::selectFirst([], ["scale" => 3, 'uid' => $id, 'photo-type' => MPhoto::USER_BANNER]); $photo = MPhoto::selectFirst([], ['scale' => 3, 'uid' => $id, 'photo-type' => MPhoto::USER_BANNER]);
if (!empty($photo)) { if (!empty($photo)) {
return $photo; return $photo;
} }
return MPhoto::createPhotoForExternalResource(DI::baseUrl() . '/images/friendica-banner.jpg'); return MPhoto::createPhotoForExternalResource(DI::baseUrl() . '/images/friendica-banner.jpg');
case "profile": case 'profile':
case "custom": case 'custom':
$scale = 4; $scale = 4;
break; break;
case "micro": case 'micro':
$scale = 6; $scale = 6;
break; break;
case "avatar": case 'avatar':
default: default:
$scale = 5; $scale = 5;
} }
$photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $id, "profile" => 1]); $photo = MPhoto::selectFirst([], ['scale' => $scale, 'uid' => $id, 'profile' => 1]);
if (empty($photo)) { if (empty($photo)) {
$contact = DBA::selectFirst('contact', [], ['uid' => $id, 'self' => true]) ?: []; $contact = DBA::selectFirst('contact', [], ['uid' => $id, 'self' => true]) ?: [];
switch($type) { switch($type) {
case "profile": case 'profile':
case "custom": case 'custom':
$default = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL); $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
break; break;
case "micro": case 'micro':
$default = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO); $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
break; break;
case "avatar": case 'avatar':
default: default:
$default = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB); $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
} }