friendica-addons/libravatar/libravatar.php

132 lines
4.3 KiB
PHP
Raw Normal View History

<?php
/**
* Name: Libravatar Support
* Description: If there is no avatar image for a new user or contact this addon will look for one at Libravatar. Please disable Gravatar addon if you use this one. (requires PHP >= 5.3)
* Version: 1.1
* Author: Klaus Weidenbach <http://friendica.dszdw.net/profile/klaus>
*/
2018-07-21 09:13:02 -04:00
use Friendica\App;
use Friendica\BaseModule;
use Friendica\Core\Config;
use Friendica\Core\Hook;
2018-01-22 14:03:11 -05:00
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
2018-07-21 09:13:02 -04:00
use Friendica\Database\DBA;
use Friendica\Util\Config\ConfigFileLoader;
use Friendica\Util\Strings;
/**
* Installs the addon hook
*/
2018-01-22 14:03:11 -05:00
function libravatar_install()
{
Hook::register('load_config', 'addon/libravatar/libravatar.php', 'libravatar_load_config');
Hook::register('avatar_lookup', 'addon/libravatar/libravatar.php', 'libravatar_lookup');
Logger::log("registered libravatar in avatar_lookup hook");
}
/**
* Removes the addon hook
*/
2018-01-22 14:03:11 -05:00
function libravatar_uninstall()
{
Hook::unregister('load_config', 'addon/libravatar/libravatar.php', 'libravatar_load_config');
Hook::unregister('avatar_lookup', 'addon/libravatar/libravatar.php', 'libravatar_lookup');
Logger::log("unregistered libravatar in avatar_lookup hook");
}
function libravatar_load_config(App $a, ConfigFileLoader $loader)
{
2019-02-10 14:10:59 -05:00
$a->getConfigCache()->load($loader->loadAddonConfig('libravatar'));
}
/**
* Looks up the avatar at Libravatar and returns the URL.
*
* @param $a array
* @param &$b array
*/
2018-01-22 14:03:11 -05:00
function libravatar_lookup($a, &$b)
{
$default_avatar = Config::get('libravatar', 'default_avatar');
if (! $default_avatar) {
// if not set, look up if there was one from the gravatar addon
$default_avatar = Config::get('gravatar', 'default_avatar');
// setting default avatar if nothing configured
2018-01-22 14:03:11 -05:00
if (!$default_avatar) {
$default_avatar = 'identicon'; // default image will be a random pattern
2018-01-22 14:03:11 -05:00
}
}
require_once 'Services/Libravatar.php';
$libravatar = new Services_Libravatar();
$libravatar->setSize($b['size']);
$libravatar->setDefault($default_avatar);
$avatar_url = $libravatar->getUrl($b['email']);
$b['url'] = $avatar_url;
$b['success'] = true;
}
/**
* Display admin settings for this addon
*/
2018-01-22 14:03:11 -05:00
function libravatar_addon_admin(&$a, &$o)
{
$t = Renderer::getMarkupTemplate("admin.tpl", "addon/libravatar");
$default_avatar = Config::get('libravatar', 'default_avatar');
// set default values for first configuration
2018-01-22 14:03:11 -05:00
if (!$default_avatar) {
$default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
2018-01-22 14:03:11 -05:00
}
// Available options for the select boxes
2018-01-15 08:15:33 -05:00
$default_avatars = [
2018-01-22 14:03:11 -05: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 08:15:33 -05:00
];
// Show warning if PHP version is too old
if (! version_compare(PHP_VERSION, '5.3.0', '>=')) {
2018-01-22 14:03:11 -05:00
$o = '<h5>' .L10n::t('Warning') .'</h5><p>';
$o .= L10n::t('Your PHP version %s is lower than the required PHP >= 5.3.', PHP_VERSION);
2018-01-22 14:03:11 -05:00
$o .= '<br>' .L10n::t('This addon is not functional on your server.') .'<p><br>';
return;
}
// Libravatar falls back to gravatar, so show warning about gravatar addon if enabled
$r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
2018-07-21 09:13:02 -04:00
DBA::escape('gravatar')
);
if (count($r)) {
2018-01-22 14:03:11 -05:00
$o = '<h5>' .L10n::t('Information') .'</h5><p>' .L10n::t('Gravatar addon is installed. Please disable the Gravatar addon.<br>The Libravatar addon will fall back to Gravatar if nothing was found at Libravatar.') .'</p><br><br>';
}
// output Libravatar settings
$o .= '<input type="hidden" name="form_security_token" value="' . BaseModule::getFormSecurityToken("libravatarsave") .'">';
$o .= Renderer::replaceMacros( $t, [
2018-01-22 14:03:11 -05: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. See README'), $default_avatars],
2018-01-15 08:15:33 -05:00
]);
}
/**
* Save admin settings
*/
2018-01-22 14:03:11 -05:00
function libravatar_addon_admin_post(&$a)
{
BaseModule::checkFormSecurityToken('libravatarrsave');
$default_avatar = (!empty($_POST['avatar']) ? Strings::escapeTags(trim($_POST['avatar'])) : 'identicon');
Config::set('libravatar', 'default_avatar', $default_avatar);
2018-01-22 14:03:11 -05:00
info(L10n::t('Libravatar settings updated.') .EOL);
}