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