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\Core\Addon;
11 use Friendica\Core\Config;
12 use Friendica\Core\L10n;
13 use Friendica\Database\DBA;
16 * Installs the addon hook
18 function gravatar_install() {
19 Addon::registerHook('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
20 Addon::registerHook('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
22 logger("registered gravatar in avatar_lookup hook");
26 * Removes the addon hook
28 function gravatar_uninstall() {
29 Addon::unregisterHook('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
30 Addon::unregisterHook('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
32 logger("unregistered gravatar in avatar_lookup hook");
35 function gravatar_load_config(App $a)
37 $a->loadConfigFile(__DIR__. '/config/gravatar.ini.php');
41 * Looks up the avatar at gravatar.com and returns the URL.
46 function gravatar_lookup($a, &$b) {
47 $default_avatar = Config::get('gravatar', 'default_avatar');
48 $rating = Config::get('gravatar', 'rating');
50 // setting default value if nothing configured
52 $default_avatar = 'identicon'; // default image will be a random pattern
54 $rating = 'g'; // suitable for display on all websites with any audience type
56 $hash = md5(trim(strtolower($b['email'])));
58 $url = 'https://secure.gravatar.com/avatar/' .$hash .'.jpg';
59 $url .= '?s=' .$b['size'] .'&r=' .$rating;
60 if ($default_avatar != "gravatar")
61 $url .= '&d=' .$default_avatar;
68 * Display admin settings for this addon
70 function gravatar_addon_admin (&$a, &$o) {
71 $t = get_markup_template( "admin.tpl", "addon/gravatar/" );
73 $default_avatar = Config::get('gravatar', 'default_avatar');
74 $rating = Config::get('gravatar', 'rating');
76 // set default values for first configuration
78 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
80 $rating = 'g'; // suitable for display on all websites with any audience type
82 // Available options for the select boxes
84 'mm' => L10n::t('generic profile image'),
85 'identicon' => L10n::t('random geometric pattern'),
86 'monsterid' => L10n::t('monster face'),
87 'wavatar' => L10n::t('computer generated face'),
88 'retro' => L10n::t('retro arcade style face'),
97 // Check if Libravatar is enabled and show warning
98 $r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
99 DBA::escape('libravatar')
102 $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>';
105 // output Gravatar settings
106 $o .= '<input type="hidden" name="form_security_token" value="' .get_form_security_token("gravatarsave") .'">';
107 $o .= replace_macros( $t, [
108 '$submit' => L10n::t('Save Settings'),
109 '$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],
110 '$rating' => ['rating', L10n::t('Rating of images'), $rating, L10n::t('Select the appropriate avatar rating for your site. See README'), $ratings],
115 * Save admin settings
117 function gravatar_addon_admin_post (&$a) {
118 check_form_security_token('gravatarsave');
120 $default_avatar = ((x($_POST, 'avatar')) ? notags(trim($_POST['avatar'])) : 'identicon');
121 $rating = ((x($_POST, 'rating')) ? notags(trim($_POST['rating'])) : 'g');
122 Config::set('gravatar', 'default_avatar', $default_avatar);
123 Config::set('gravatar', 'rating', $rating);
124 info(L10n::t('Gravatar settings updated.') .EOL);