3 * Name: Libravatar Support
4 * 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)
6 * Author: Klaus Weidenbach <http://friendica.dszdw.net/profile/klaus>
8 use Friendica\Core\Addon;
9 use Friendica\Core\Config;
10 use Friendica\Core\L10n;
13 * Installs the addon hook
15 function libravatar_install()
17 if (! version_compare(PHP_VERSION, '5.3.0', '>=')) {
18 info(L10n::t('Could NOT install Libravatar successfully.<br>It requires PHP >= 5.3') .EOL);
19 // avoid registering the hook
23 Addon::registerHook('avatar_lookup', 'addon/libravatar/libravatar.php', 'libravatar_lookup');
24 logger("registered libravatar in avatar_lookup hook");
28 * Removes the addon hook
30 function libravatar_uninstall()
32 Addon::unregisterHook('avatar_lookup', 'addon/libravatar/libravatar.php', 'libravatar_lookup');
33 logger("unregistered libravatar in avatar_lookup hook");
37 * Looks up the avatar at Libravatar and returns the URL.
42 function libravatar_lookup($a, &$b)
44 $default_avatar = Config::get('libravatar', 'default_img');
46 if (! $default_avatar) {
47 // if not set, look up if there was one from the gravatar addon
48 $default_avatar = get_config('gravatar', 'default_img');
49 // setting default avatar if nothing configured
50 if (!$default_avatar) {
51 $default_avatar = 'identicon'; // default image will be a random pattern
55 require_once 'Services/Libravatar.php';
56 $libravatar = new Services_Libravatar();
57 $libravatar->setSize($b['size']);
58 $libravatar->setDefault($default_avatar);
59 $avatar_url = $libravatar->getUrl($b['email']);
61 $b['url'] = $avatar_url;
66 * Display admin settings for this addon
68 function libravatar_addon_admin(&$a, &$o)
70 $t = get_markup_template("admin.tpl", "addon/libravatar");
72 $default_avatar = get_config('libravatar', 'default_img');
74 // set default values for first configuration
75 if (!$default_avatar) {
76 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
79 // Available options for the select boxes
81 'mm' => L10n::t('generic profile image'),
82 'identicon' => L10n::t('random geometric pattern'),
83 'monsterid' => L10n::t('monster face'),
84 'wavatar' => L10n::t('computer generated face'),
85 'retro' => L10n::t('retro arcade style face'),
88 // Show warning if PHP version is too old
89 if (! version_compare(PHP_VERSION, '5.3.0', '>=')) {
90 $o = '<h5>' .L10n::t('Warning') .'</h5><p>';
91 $o .= L10n::t('Your PHP version %s is lower than the required PHP >= 5.3.', PHP_VERSION);
92 $o .= '<br>' .L10n::t('This addon is not functional on your server.') .'<p><br>';
96 // Libravatar falls back to gravatar, so show warning about gravatar addon if enabled
97 $r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
101 $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>';
104 // output Libravatar settings
105 $o .= '<input type="hidden" name="form_security_token" value="' .get_form_security_token("libravatarsave") .'">';
106 $o .= replace_macros( $t, [
107 '$submit' => L10n::t('Save Settings'),
108 '$default_avatar' => ['avatar', L10n::t('Default avatar image'), $default_avatar, L10n::t('Select default avatar image if none was found. See README'), $default_avatars],
113 * Save admin settings
115 function libravatar_addon_admin_post(&$a)
117 check_form_security_token('libravatarrsave');
119 $default_avatar = ((x($_POST, 'avatar')) ? notags(trim($_POST['avatar'])) : 'identicon');
120 Config::set('libravatar', 'default_img', $default_avatar);
121 info(L10n::t('Libravatar settings updated.') .EOL);