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