libravatar/libravatar.php

   1 <?php
   2 /**
   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)
   5  * Version: 1.1
   6  * Author: Klaus Weidenbach <http://friendica.dszdw.net/profile/klaus>
   7  */
   8
   9 use Friendica\App;
  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\Core\Renderer;
  16 use Friendica\Database\DBA;
  17 use Friendica\Util\Security;
  18 use Friendica\Util\Strings;
  19
  20 /**
  21  * Installs the addon hook
  22  */
  23 function libravatar_install()
  24 {
  25         Addon::registerHook('load_config',   'addon/libravatar/libravatar.php', 'libravatar_load_config');
  26         Addon::registerHook('avatar_lookup', 'addon/libravatar/libravatar.php', 'libravatar_lookup');
  27         Logger::log("registered libravatar in avatar_lookup hook");
  28 }
  29
  30 /**
  31  * Removes the addon hook
  32  */
  33 function libravatar_uninstall()
  34 {
  35         Addon::unregisterHook('load_config',   'addon/libravatar/libravatar.php', 'libravatar_load_config');
  36         Addon::unregisterHook('avatar_lookup', 'addon/libravatar/libravatar.php', 'libravatar_lookup');
  37         Logger::log("unregistered libravatar in avatar_lookup hook");
  38 }
  39
  40 function libravatar_load_config(App $a)
  41 {
  42         $a->loadConfigFile(__DIR__. '/config/libravatar.ini.php');
  43 }
  44
  45 /**
  46  * Looks up the avatar at Libravatar and returns the URL.
  47  *
  48  * @param $a array
  49  * @param &$b array
  50  */
  51 function libravatar_lookup($a, &$b)
  52 {
  53         $default_avatar = Config::get('libravatar', 'default_avatar');
  54
  55         if (! $default_avatar) {
  56                 // if not set, look up if there was one from the gravatar addon
  57                 $default_avatar = Config::get('gravatar', 'default_avatar');
  58                 // setting default avatar if nothing configured
  59                 if (!$default_avatar) {
  60                         $default_avatar = 'identicon'; // default image will be a random pattern
  61                 }
  62         }
  63
  64         require_once 'Services/Libravatar.php';
  65         $libravatar = new Services_Libravatar();
  66         $libravatar->setSize($b['size']);
  67         $libravatar->setDefault($default_avatar);
  68         $avatar_url = $libravatar->getUrl($b['email']);
  69
  70         $b['url'] = $avatar_url;
  71         $b['success'] = true;
  72 }
  73
  74 /**
  75  * Display admin settings for this addon
  76  */
  77 function libravatar_addon_admin(&$a, &$o)
  78 {
  79         $t = Renderer::getMarkupTemplate("admin.tpl", "addon/libravatar");
  80
  81         $default_avatar = Config::get('libravatar', 'default_avatar');
  82
  83         // set default values for first configuration
  84         if (!$default_avatar) {
  85                 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
  86         }
  87
  88         // Available options for the select boxes
  89         $default_avatars = [
  90                 'mm' => L10n::t('generic profile image'),
  91                 'identicon' => L10n::t('random geometric pattern'),
  92                 'monsterid' => L10n::t('monster face'),
  93                 'wavatar' => L10n::t('computer generated face'),
  94                 'retro' => L10n::t('retro arcade style face'),
  95         ];
  96
  97         // Show warning if PHP version is too old
  98         if (! version_compare(PHP_VERSION, '5.3.0', '>=')) {
  99                 $o = '<h5>' .L10n::t('Warning') .'</h5><p>';
 100                 $o .= L10n::t('Your PHP version %s is lower than the required PHP >= 5.3.', PHP_VERSION);
 101                 $o .= '<br>' .L10n::t('This addon is not functional on your server.') .'<p><br>';
 102                 return;
 103         }
 104
 105         // Libravatar falls back to gravatar, so show warning about gravatar addon if enabled
 106         $r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
 107                 DBA::escape('gravatar')
 108         );
 109         if (count($r)) {
 110                 $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>';
 111         }
 112
 113         // output Libravatar settings
 114         $o .= '<input type="hidden" name="form_security_token" value="' . BaseModule::getFormSecurityToken("libravatarsave") .'">';
 115         $o .= Renderer::replaceMacros( $t, [
 116                 '$submit' => L10n::t('Save Settings'),
 117                 '$default_avatar' => ['avatar', L10n::t('Default avatar image'), $default_avatar, L10n::t('Select default avatar image if none was found. See README'), $default_avatars],
 118         ]);
 119 }
 120
 121 /**
 122  * Save admin settings
 123  */
 124 function libravatar_addon_admin_post(&$a)
 125 {
 126         BaseModule::checkFormSecurityToken('libravatarrsave');
 127
 128         $default_avatar = ((x($_POST, 'avatar')) ? Strings::removeTags(trim($_POST['avatar'])) : 'identicon');
 129         Config::set('libravatar', 'default_avatar', $default_avatar);
 130         info(L10n::t('Libravatar settings updated.') .EOL);
 131 }