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\Config;
12 use Friendica\Core\Hook;
13 use Friendica\Core\L10n;
14 use Friendica\Core\Logger;
15 use Friendica\Core\Renderer;
16 use Friendica\Database\DBA;
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");
30 * Removes the addon hook
32 function gravatar_uninstall() {
33 Hook::unregister('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
34 Hook::unregister('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
36 Logger::log("unregistered gravatar in avatar_lookup hook");
39 function gravatar_load_config(App $a)
41 $a->loadConfigFile(__DIR__ . '/config/gravatar.config.php');
45 * Looks up the avatar at gravatar.com and returns the URL.
50 function gravatar_lookup($a, &$b) {
51 $default_avatar = Config::get('gravatar', 'default_avatar');
52 $rating = Config::get('gravatar', 'rating');
54 // setting default value if nothing configured
56 $default_avatar = 'identicon'; // default image will be a random pattern
58 $rating = 'g'; // suitable for display on all websites with any audience type
60 $hash = md5(trim(strtolower($b['email'])));
62 $url = 'https://secure.gravatar.com/avatar/' .$hash .'.jpg';
63 $url .= '?s=' .$b['size'] .'&r=' .$rating;
64 if ($default_avatar != "gravatar")
65 $url .= '&d=' .$default_avatar;
72 * Display admin settings for this addon
74 function gravatar_addon_admin (&$a, &$o) {
75 $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/gravatar/" );
77 $default_avatar = Config::get('gravatar', 'default_avatar');
78 $rating = Config::get('gravatar', 'rating');
80 // set default values for first configuration
82 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
84 $rating = 'g'; // suitable for display on all websites with any audience type
86 // Available options for the select boxes
88 'mm' => L10n::t('generic profile image'),
89 'identicon' => L10n::t('random geometric pattern'),
90 'monsterid' => L10n::t('monster face'),
91 'wavatar' => L10n::t('computer generated face'),
92 'retro' => L10n::t('retro arcade style face'),
101 // Check if Libravatar is enabled and show warning
102 $r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
103 DBA::escape('libravatar')
106 $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>';
109 // output Gravatar settings
110 $o .= '<input type="hidden" name="form_security_token" value="' . BaseModule::getFormSecurityToken("gravatarsave") .'">';
111 $o .= Renderer::replaceMacros( $t, [
112 '$submit' => L10n::t('Save Settings'),
113 '$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],
114 '$rating' => ['rating', L10n::t('Rating of images'), $rating, L10n::t('Select the appropriate avatar rating for your site. See README'), $ratings],
119 * Save admin settings
121 function gravatar_addon_admin_post (&$a) {
122 BaseModule::checkFormSecurityToken('gravatarsave');
124 $default_avatar = (!empty($_POST['avatar']) ? Strings::escapeTags(trim($_POST['avatar'])) : 'identicon');
125 $rating = (!empty($_POST['rating']) ? Strings::escapeTags(trim($_POST['rating'])) : 'g');
126 Config::set('gravatar', 'default_avatar', $default_avatar);
127 Config::set('gravatar', 'rating', $rating);
128 info(L10n::t('Gravatar settings updated.') .EOL);