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