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\Addon;
12 use Friendica\Core\Config;
13 use Friendica\Core\L10n;
14 use Friendica\Core\Logger;
15 use Friendica\Database\DBA;
16 use Friendica\Util\Security;
19 * Installs the addon hook
21 function gravatar_install() {
22 Addon::registerHook('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
23 Addon::registerHook('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
25 Logger::log("registered gravatar in avatar_lookup hook");
29 * Removes the addon hook
31 function gravatar_uninstall() {
32 Addon::unregisterHook('load_config', 'addon/gravatar/gravatar.php', 'gravatar_load_config');
33 Addon::unregisterHook('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
35 Logger::log("unregistered gravatar in avatar_lookup hook");
38 function gravatar_load_config(App $a)
40 $a->loadConfigFile(__DIR__. '/config/gravatar.ini.php');
44 * Looks up the avatar at gravatar.com and returns the URL.
49 function gravatar_lookup($a, &$b) {
50 $default_avatar = Config::get('gravatar', 'default_avatar');
51 $rating = Config::get('gravatar', 'rating');
53 // setting default value if nothing configured
55 $default_avatar = 'identicon'; // default image will be a random pattern
57 $rating = 'g'; // suitable for display on all websites with any audience type
59 $hash = md5(trim(strtolower($b['email'])));
61 $url = 'https://secure.gravatar.com/avatar/' .$hash .'.jpg';
62 $url .= '?s=' .$b['size'] .'&r=' .$rating;
63 if ($default_avatar != "gravatar")
64 $url .= '&d=' .$default_avatar;
71 * Display admin settings for this addon
73 function gravatar_addon_admin (&$a, &$o) {
74 $t = get_markup_template( "admin.tpl", "addon/gravatar/" );
76 $default_avatar = Config::get('gravatar', 'default_avatar');
77 $rating = Config::get('gravatar', 'rating');
79 // set default values for first configuration
81 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
83 $rating = 'g'; // suitable for display on all websites with any audience type
85 // Available options for the select boxes
87 'mm' => L10n::t('generic profile image'),
88 'identicon' => L10n::t('random geometric pattern'),
89 'monsterid' => L10n::t('monster face'),
90 'wavatar' => L10n::t('computer generated face'),
91 'retro' => L10n::t('retro arcade style face'),
100 // Check if Libravatar is enabled and show warning
101 $r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
102 DBA::escape('libravatar')
105 $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>';
108 // output Gravatar settings
109 $o .= '<input type="hidden" name="form_security_token" value="' . BaseModule::getFormSecurityToken("gravatarsave") .'">';
110 $o .= replace_macros( $t, [
111 '$submit' => L10n::t('Save Settings'),
112 '$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],
113 '$rating' => ['rating', L10n::t('Rating of images'), $rating, L10n::t('Select the appropriate avatar rating for your site. See README'), $ratings],
118 * Save admin settings
120 function gravatar_addon_admin_post (&$a) {
121 BaseModule::checkFormSecurityToken('gravatarsave');
123 $default_avatar = ((x($_POST, 'avatar')) ? notags(trim($_POST['avatar'])) : 'identicon');
124 $rating = ((x($_POST, 'rating')) ? notags(trim($_POST['rating'])) : 'g');
125 Config::set('gravatar', 'default_avatar', $default_avatar);
126 Config::set('gravatar', 'rating', $rating);
127 info(L10n::t('Gravatar settings updated.') .EOL);