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