friendica-addons/gravatar/gravatar.php

131 lines
4.3 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 15:13:02 +02:00
use Friendica\App;
use Friendica\BaseModule;
use Friendica\Core\Addon;
use Friendica\Core\Config;
2018-01-22 20:03:11 +01:00
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
2018-07-21 15:13:02 +02:00
use Friendica\Database\DBA;
use Friendica\Util\Security;
use Friendica\Util\Strings;
/**
* Installs the addon hook
*/
function gravatar_install() {
Addon::registerHook('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
Addon::registerHook('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
Logger::log("registered gravatar in avatar_lookup hook");
}
/**
* Removes the addon hook
*/
function gravatar_uninstall() {
Addon::unregisterHook('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
Addon::unregisterHook('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
Logger::log("unregistered gravatar in avatar_lookup hook");
}
2018-07-21 15:13:02 +02:00
function gravatar_load_config(App $a)
{
$a->loadConfigFile(__DIR__. '/config/gravatar.ini.php');
}
/**
* Looks up the avatar at gravatar.com and returns the URL.
*
* @param $a array
* @param &$b array
*/
function gravatar_lookup($a, &$b) {
$default_avatar = Config::get('gravatar', 'default_avatar');
$rating = 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 14:15:33 +01:00
$b['url'] = $url;
$b['success'] = true;
}
/**
* Display admin settings for this addon
*/
function gravatar_addon_admin (&$a, &$o) {
$t = Renderer::getMarkupTemplate( "admin.tpl", "addon/gravatar/" );
$default_avatar = Config::get('gravatar', 'default_avatar');
$rating = 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 14:15:33 +01:00
$default_avatars = [
2018-01-22 20:03:11 +01:00
'mm' => L10n::t('generic profile image'),
'identicon' => L10n::t('random geometric pattern'),
'monsterid' => L10n::t('monster face'),
'wavatar' => L10n::t('computer generated face'),
'retro' => L10n::t('retro arcade style face'),
2018-01-15 14:15:33 +01:00
];
$ratings = [
'g' => 'g',
'pg' => 'pg',
'r' => 'r',
'x' => 'x'
2018-01-15 14:15:33 +01:00
];
// Check if Libravatar is enabled and show warning
$r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
2018-07-21 15:13:02 +02:00
DBA::escape('libravatar')
);
if (count($r)) {
2018-01-22 20:03:11 +01:00
$o = '<h5>' .L10n::t('Information') .'</h5><p>' .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, [
2018-01-22 20:03:11 +01:00
'$submit' => L10n::t('Save Settings'),
'$default_avatar' => ['avatar', L10n::t('Default avatar image'), $default_avatar, L10n::t('Select default avatar image if none was found at Gravatar. See README'), $default_avatars],
'$rating' => ['rating', L10n::t('Rating of images'), $rating, L10n::t('Select the appropriate avatar rating for your site. See README'), $ratings],
2018-01-15 14:15:33 +01:00
]);
}
/**
* Save admin settings
*/
function gravatar_addon_admin_post (&$a) {
BaseModule::checkFormSecurityToken('gravatarsave');
$default_avatar = ((x($_POST, 'avatar')) ? Strings::removeTags(trim($_POST['avatar'])) : 'identicon');
$rating = ((x($_POST, 'rating')) ? Strings::removeTags(trim($_POST['rating'])) : 'g');
Config::set('gravatar', 'default_avatar', $default_avatar);
Config::set('gravatar', 'rating', $rating);
2018-01-22 20:03:11 +01:00
info(L10n::t('Gravatar settings updated.') .EOL);
}