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