3 * Name: Gravatar Support
4 * Description: If there is no avatar image for a new user or contact this addon will look for one at Gravatar.
6 * Author: Klaus Weidenbach <http://friendica.dszdw.net/profile/klaus>
10 use Friendica\BaseModule;
11 use Friendica\Core\Hook;
12 use Friendica\Core\Logger;
13 use Friendica\Core\Renderer;
14 use Friendica\Database\DBA;
16 use Friendica\Util\ConfigFileLoader;
17 use Friendica\Util\Strings;
20 * Installs the addon hook
22 function gravatar_install() {
23 Hook::register('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
24 Hook::register('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
26 Logger::log("registered gravatar in avatar_lookup hook");
29 function gravatar_load_config(App $a, ConfigFileLoader $loader)
31 $a->getConfigCache()->load($loader->loadAddonConfig('gravatar'));
35 * Looks up the avatar at gravatar.com and returns the URL.
40 function gravatar_lookup($a, &$b) {
41 $default_avatar = DI::config()->get('gravatar', 'default_avatar');
42 $rating = DI::config()->get('gravatar', 'rating');
44 // setting default value if nothing configured
46 $default_avatar = 'identicon'; // default image will be a random pattern
48 $rating = 'g'; // suitable for display on all websites with any audience type
50 $hash = md5(trim(strtolower($b['email'])));
52 $url = 'https://secure.gravatar.com/avatar/' .$hash .'.jpg';
53 $url .= '?s=' .$b['size'] .'&r=' .$rating;
54 if ($default_avatar != "gravatar")
55 $url .= '&d=' .$default_avatar;
62 * Display admin settings for this addon
64 function gravatar_addon_admin (&$a, &$o) {
65 $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/gravatar/" );
67 $default_avatar = DI::config()->get('gravatar', 'default_avatar');
68 $rating = DI::config()->get('gravatar', 'rating');
70 // set default values for first configuration
72 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
74 $rating = 'g'; // suitable for display on all websites with any audience type
76 // Available options for the select boxes
78 'mm' => DI::l10n()->t('generic profile image'),
79 'identicon' => DI::l10n()->t('random geometric pattern'),
80 'monsterid' => DI::l10n()->t('monster face'),
81 'wavatar' => DI::l10n()->t('computer generated face'),
82 'retro' => DI::l10n()->t('retro arcade style face'),
91 // Check if Libravatar is enabled and show warning
92 $r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
93 DBA::escape('libravatar')
96 $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>';
99 // output Gravatar settings
100 $o .= '<input type="hidden" name="form_security_token" value="' . BaseModule::getFormSecurityToken("gravatarsave") .'">';
101 $o .= Renderer::replaceMacros( $t, [
102 '$submit' => DI::l10n()->t('Save Settings'),
103 '$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],
104 '$rating' => ['rating', DI::l10n()->t('Rating of images'), $rating, DI::l10n()->t('Select the appropriate avatar rating for your site. See README'), $ratings],
109 * Save admin settings
111 function gravatar_addon_admin_post (&$a) {
112 BaseModule::checkFormSecurityToken('gravatarsave');
114 $default_avatar = (!empty($_POST['avatar']) ? Strings::escapeTags(trim($_POST['avatar'])) : 'identicon');
115 $rating = (!empty($_POST['rating']) ? Strings::escapeTags(trim($_POST['rating'])) : 'g');
116 DI::config()->set('gravatar', 'default_avatar', $default_avatar);
117 DI::config()->set('gravatar', 'rating', $rating);