friendica-addons/gravatar/gravatar.php

119 lines
4 KiB
PHP
Raw Normal View History

<?php
/**
* Name: Gravatar Support
* Description: If there is no avatar image for a new user or contact this addon will look for one at Gravatar.
* Version: 1.1
* Author: Klaus Weidenbach <http://friendica.dszdw.net/profile/klaus>
*/
2018-07-21 13:13:02 +00:00
use Friendica\App;
use Friendica\BaseModule;
use Friendica\Core\Hook;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
2018-07-21 13:13:02 +00:00
use Friendica\Database\DBA;
2020-01-18 21:07:06 +00:00
use Friendica\DI;
use Friendica\Core\Config\Util\ConfigFileManager;
use Friendica\Util\Strings;
/**
* Installs the addon hook
*/
function gravatar_install() {
Hook::register('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
Hook::register('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
2021-10-03 17:35:20 +00:00
Logger::notice("registered gravatar in avatar_lookup hook");
}
function gravatar_load_config(App $a, ConfigFileManager $loader)
{
$a->getConfigCache()->load($loader->loadAddonConfig('gravatar'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
}
/**
* Looks up the avatar at gravatar.com and returns the URL.
*
* @param $a array
* @param &$b array
*/
function gravatar_lookup(App $a, array &$b)
{
$default_avatar = DI::config()->get('gravatar', 'default_avatar');
$rating = DI::config()->get('gravatar', 'rating');
// setting default value if nothing configured
if(! $default_avatar)
$default_avatar = 'identicon'; // default image will be a random pattern
if(! $rating)
$rating = 'g'; // suitable for display on all websites with any audience type
$hash = md5(trim(strtolower($b['email'])));
$url = 'https://secure.gravatar.com/avatar/' .$hash .'.jpg';
$url .= '?s=' .$b['size'] .'&r=' .$rating;
if ($default_avatar != "gravatar")
$url .= '&d=' .$default_avatar;
2018-01-15 13:15:33 +00:00
$b['url'] = $url;
$b['success'] = true;
}
/**
* Display admin settings for this addon
*/
function gravatar_addon_admin (App $a, string &$o)
{
$t = Renderer::getMarkupTemplate( "admin.tpl", "addon/gravatar/" );
$default_avatar = DI::config()->get('gravatar', 'default_avatar');
$rating = DI::config()->get('gravatar', 'rating');
// set default values for first configuration
if (!$default_avatar) {
$default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
}
if (!$rating) {
$rating = 'g'; // suitable for display on all websites with any audience type
}
// Available options for the select boxes
2018-01-15 13:15:33 +00:00
$default_avatars = [
'mm' => DI::l10n()->t('generic profile image'),
'identicon' => DI::l10n()->t('random geometric pattern'),
'monsterid' => DI::l10n()->t('monster face'),
'wavatar' => DI::l10n()->t('computer generated face'),
'retro' => DI::l10n()->t('retro arcade style face'),
2018-01-15 13:15:33 +00:00
];
$ratings = [
'g' => 'g',
'pg' => 'pg',
'r' => 'r',
'x' => 'x'
2018-01-15 13:15:33 +00:00
];
// Check if Libravatar is enabled and show warning
2021-10-03 17:35:20 +00:00
if (DBA::exists('addon', ['name' => 'libravatar', 'installed' => true])) {
$o = '<h5>' .DI::l10n()->t('Information') .'</h5><p>' .DI::l10n()->t('Libravatar addon is installed, too. Please disable Libravatar addon or this Gravatar addon.<br>The Libravatar addon will fall back to Gravatar if nothing was found at Libravatar.') .'</p><br><br>';
}
// output Gravatar settings
$o .= '<input type="hidden" name="form_security_token" value="' . BaseModule::getFormSecurityToken("gravatarsave") .'">';
$o .= Renderer::replaceMacros( $t, [
'$submit' => DI::l10n()->t('Save Settings'),
'$default_avatar' => ['avatar', DI::l10n()->t('Default avatar image'), $default_avatar, DI::l10n()->t('Select default avatar image if none was found at Gravatar. See README'), $default_avatars],
'$rating' => ['rating', DI::l10n()->t('Rating of images'), $rating, DI::l10n()->t('Select the appropriate avatar rating for your site. See README'), $ratings],
2018-01-15 13:15:33 +00:00
]);
}
/**
* Save admin settings
*/
function gravatar_addon_admin_post (App $a)
{
BaseModule::checkFormSecurityToken('gravatarsave');
DI::config()->set('gravatar', 'default_avatar', trim($_POST['avatar'] ?? 'identicon'));
DI::config()->set('gravatar', 'rating', $rating = trim($_POST['rating'] ?? 'g'));
}