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