gdorn/FreshRSS-Extensions
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Implement options to download/reset all channel icons + other

Browse source
This commit is contained in:
Inverle 2025-06-18 04:00:08 +02:00
parent ff21216885
commit 019e848ad1
7 changed files with 89 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

5
xExtension-YouTube/configure.phtml
View file

@ -36,6 +36,11 @@ declare(strict_types=1);
<?= _t('ext.yt_videos.use_nocookie') ?>
</label>
</div>
<div class="group-controls">
<button id="yt_action_btn" name="yt_action_btn" value="fetchIcons" type="submit" class="btn"><?= _t('ext.yt_videos.fetch_channel_icons') ?></button>
<button id="yt_action_btn" name="yt_action_btn" value="resetIcons" type="submit" class="btn"><?= _t('ext.yt_videos.reset_channel_icons') ?></button>
</div>
</div>
<div class="form-group form-actions">

89
xExtension-YouTube/extension.php
View file

@ -38,36 +38,87 @@ final class YouTubeExtension extends Minz_Extension
{
$this->registerHook('entry_before_display', [$this, 'embedYouTubeVideo']);
$this->registerHook('check_url_before_add', [self::class, 'convertYoutubeFeedUrl']);
$this->registerHook('custom_favicon_hash', [$this, 'iconHash']);
$this->registerHook('feed_before_insert', [$this, 'setIconBeforeInsert']);
$this->registerHook('custom_favicon_hash', [$this, 'iconHashParams']);
$this->registerHook('feed_before_insert', [$this, 'setIconForFeed']);
$this->registerTranslates();
}
public function iconHash(FreshRSS_Feed $feed): ?string {
if ($feed->attributeString('customFaviconExt') !== 'YouTube Video Feed') {
public function iconHashParams(FreshRSS_Feed $feed): ?string {
if ($feed->attributeString('customFaviconExt') !== self::EXT_NAME) {
return null;
}
return 'yt' . $feed->website() . $feed->proxyParam();
}
public function fetchAllIcons() {
$feedDAO = FreshRSS_Factory::createFeedDao();
$ids = $feedDAO->listFeedsIds();
foreach ($ids as $feedId) {
$feed = $feedDAO->searchById($feedId);
if ($feed === null) {
continue;
}
$this->setIconForFeed($feed, setValues: true);
}
}
public function resetAllIcons() {
$feedDAO = FreshRSS_Factory::createFeedDao();
$ids = $feedDAO->listFeedsIds();
foreach ($ids as $feedId) {
$feed = $feedDAO->searchById($feedId);
if ($feed === null) {
continue;
}
if ($feed->attributeString('customFaviconExt') === self::EXT_NAME) {
$v = [];
try {
$feed->resetCustomFavicon(values: $v);
} catch (FreshRSS_Feed_Exception $_) {
$this->warnLog('failed to reset favicon for feed "' . $feed->name(true) . '": feed error');
}
}
}
}
public function warnLog(string $s) {
Minz_Log::warning('[xExtension-YouTube] ' . $s);
}
public function debugLog(string $s) {
Minz_Log::debug('[xExtension-YouTube] ' . $s);
}
/**
* @throws FreshRSS_Context_Exception
* @throws Minz_PermissionDeniedException
*/
public function setIconBeforeInsert(FreshRSS_Feed $feed): FreshRSS_Feed {
public function setIconForFeed(FreshRSS_Feed $feed, bool $setValues = false): FreshRSS_Feed {
$this->loadConfigValues();
if (!$this->downloadIcons || !str_starts_with($feed->website(), 'https://www.youtube.com/')) {
if (!($this->downloadIcons || $setValues) || !str_starts_with($feed->website(), 'https://www.youtube.com/')) {
return $feed;
}
// Return early if the icon had already been downloaded before
$v = $setValues ? [] : null;
$oldAttributes = $feed->attributes();
if (file_exists($feed->setCustomFavicon(extName: self::EXT_NAME, disallowDelete: true))) {
Minz_Log::debug('[xExtension-YouTube] icon had already been downloaded before for feed "' . $feed->name(true) . '" - returning early!');
try {
$path = $feed->setCustomFavicon(extName: self::EXT_NAME, disallowDelete: true, values: $v);
if ($path === null) {
$feed->_attributes($oldAttributes);
return $feed;
} elseif (file_exists($path)) {
$this->debugLog('icon had already been downloaded before for feed "' . $feed->name(true) . '" - returning early!');
return $feed;
}
} catch (FreshRSS_Feed_Exception $_) {
$this->warnLog('failed to set custom favicon for feed "' . $feed->name(true) . '": feed error');
$feed->_attributes($oldAttributes);
return $feed;
}
$feed->_attributes($oldAttributes);
$this->debugLog('downloading icon for feed "' . $feed->name(true) . '"');
$url = $feed->website();
/** @var $curlOptions array<int,int|bool|string> */
@ -77,7 +128,7 @@ final class YouTubeExtension extends Minz_Extension
$dom = new DOMDocument();
if ($html == '' || !@$dom->loadHTML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING)) {
Minz_Log::warning('[xExtension-YouTube] fail while downloading icon for feed "' . $feed->name(true) . '": failed to load HTML');
$this->warnLog('fail while downloading icon for feed "' . $feed->name(true) . '": failed to load HTML');
return $feed;
}
@ -85,29 +136,29 @@ final class YouTubeExtension extends Minz_Extension
$iconElem = $xpath->query('//meta[@name="twitter:image"]');
if ($iconElem === false) {
Minz_Log::warning('[xExtension-YouTube] fail while downloading icon for feed "' . $feed->name(true) . '": icon URL couldn\'t be found');
$this->warnLog('fail while downloading icon for feed "' . $feed->name(true) . '": icon URL couldn\'t be found');
return $feed;
}
$iconUrl = $iconElem->item(0) !== null ? $iconElem->item(0)->getAttribute('content') : null;
if ($iconUrl === null) {
Minz_Log::warning('[xExtension-YouTube] fail while downloading icon for feed "' . $feed->name(true) . '": icon URL couldn\'t be found');
$this->warnLog('fail while downloading icon for feed "' . $feed->name(true) . '": icon URL couldn\'t be found');
return $feed;
}
$contents = downloadHttp($iconUrl, $curlOptions);
if ($contents == '') {
Minz_Log::warning('[xExtension-YouTube] fail while downloading icon for feed "' . $feed->name(true) . '": empty contents');
$this->warnLog('fail while downloading icon for feed "' . $feed->name(true) . '": empty contents');
return $feed;
}
try {
$feed->setCustomFavicon($contents, extName: self::EXT_NAME, disallowDelete: true);
$feed->setCustomFavicon($contents, extName: self::EXT_NAME, disallowDelete: true, values: $v, overrideCustomIcon: true);
} catch (FreshRSS_UnsupportedImageFormat_Exception $_) {
Minz_Log::warning('[xExtension-YouTube] failed to set custom favicon for feed "' . $feed->name(true) . '": unsupported image format');
$this->warnLog('failed to set custom favicon for feed "' . $feed->name(true) . '": unsupported image format');
return $feed;
} catch (FreshRSS_Feed_Exception $_) {
Minz_Log::warning('[xExtension-YouTube] failed to set custom favicon for feed "' . $feed->name(true) . '": feed error');
$this->warnLog('failed to set custom favicon for feed "' . $feed->name(true) . '": feed error');
return $feed;
}
@ -343,6 +394,14 @@ final class YouTubeExtension extends Minz_Extension
$this->registerTranslates();
if (Minz_Request::isPost()) {
switch (Minz_Request::paramString('yt_action_btn')) {
case 'fetchIcons':
$this->fetchAllIcons();
break;
case 'resetIcons':
$this->resetAllIcons();
break;
}
FreshRSS_Context::userConf()->_attribute('yt_player_height', Minz_Request::paramInt('yt_height'));
FreshRSS_Context::userConf()->_attribute('yt_player_width', Minz_Request::paramInt('yt_width'));
FreshRSS_Context::userConf()->_attribute('yt_show_content', Minz_Request::paramBoolean('yt_show_content'));

2
xExtension-YouTube/i18n/de/ext.php
View file

@ -6,6 +6,8 @@ return array(
'width' => 'Breite des Players',
'show_content' => 'Zeige den Inhalt des Feeds an',
'download_channel_icons' => 'Automatically download and set channel icons for feeds',
'fetch_channel_icons' => 'Fetch icons of all channels',
'reset_channel_icons' => 'Reset icons of all channels',
'use_nocookie' => 'Verwende die Cookie-freie Domain www.youtube-nocookie.com',
),
);

2
xExtension-YouTube/i18n/en/ext.php
View file

@ -6,6 +6,8 @@ return array(
'width' => 'Player width',
'show_content' => 'Display the feeds content',
'download_channel_icons' => 'Automatically use the channels’ icons',
'fetch_channel_icons' => 'Fetch icons of all channels',
'reset_channel_icons' => 'Reset icons of all channels',
'use_nocookie' => 'Use the cookie-free domain www.youtube-nocookie.com',
),
);

2
xExtension-YouTube/i18n/fr/ext.php
View file

@ -6,6 +6,8 @@ return array(
'width' => 'Largeur du lecteur',
'show_content' => 'Afficher le contenu du flux',
'download_channel_icons' => 'Utiliser automatiquement les icônes des chaînes',
'fetch_channel_icons' => 'Fetch icons of all channels',
'reset_channel_icons' => 'Reset icons of all channels',
'use_nocookie' => 'Utiliser le domaine www.youtube-nocookie.com pour éviter les cookies',
),
);

2
xExtension-YouTube/i18n/pl/ext.php
View file

@ -6,6 +6,8 @@ return array(
'width' => 'Szerokość odtwarzacza wideo',
'show_content' => 'Wyświetlaj zawartość kanałów',
'download_channel_icons' => 'Automatycznie używaj ikon kanałów',
'fetch_channel_icons' => 'Pobierz ikony wszystkich kanałów',
'reset_channel_icons' => 'Przywróć domyślne ikony wszystkich kanałów',
'use_nocookie' => 'Używaj domeny bez ciasteczek www.youtube-nocookie.com',
),
);

2
xExtension-YouTube/i18n/tr/ext.php
View file

@ -6,6 +6,8 @@ return array(
'width' => 'Oynatıcı genişlik',
'show_content' => 'Yayın içeriğini görüntüle',
'download_channel_icons' => 'Automatically download and set channel icons for feeds',
'fetch_channel_icons' => 'Fetch icons of all channels',
'reset_channel_icons' => 'Reset icons of all channels',
'use_nocookie' => 'Çerezsiz olan "www.youtube-nocookie.com" alan adını kullanın',
),
);