gravatar/gravatar.php

   1 <?php
   2 /**
   3  * Name: Gravatar Support
   4  * Description: If there is no avatar image for a new user or contact this addon will look for one at Gravatar.
   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 gravatar_install() {
  16         Addon::registerHook('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
  17
  18         logger("registered gravatar in avatar_lookup hook");
  19 }
  20
  21 /**
  22  * Removes the addon hook
  23  */
  24 function gravatar_uninstall() {
  25         Addon::unregisterHook('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
  26
  27         logger("unregistered gravatar in avatar_lookup hook");
  28 }
  29
  30 /**
  31  * Looks up the avatar at gravatar.com and returns the URL.
  32  *
  33  * @param $a array
  34  * @param &$b array
  35  */
  36 function gravatar_lookup($a, &$b) {
  37         $default_avatar = Config::get('gravatar', 'default_img');
  38         $rating = Config::get('gravatar', 'rating');
  39
  40         // setting default value if nothing configured
  41         if(! $default_avatar)
  42                 $default_avatar = 'identicon'; // default image will be a random pattern
  43         if(! $rating)
  44                 $rating = 'g'; // suitable for display on all websites with any audience type
  45
  46         $hash = md5(trim(strtolower($b['email'])));
  47
  48         $url = 'https://secure.gravatar.com/avatar/' .$hash .'.jpg';
  49         $url .= '?s=' .$b['size'] .'&r=' .$rating;
  50         if ($default_avatar != "gravatar")
  51                 $url .= '&d=' .$default_avatar;
  52
  53         $b['url'] = $url;
  54         $b['success'] = true;
  55 }
  56
  57 /**
  58  * Display admin settings for this addon
  59  */
  60 function gravatar_addon_admin (&$a, &$o) {
  61         $t = get_markup_template( "admin.tpl", "addon/gravatar/" );
  62
  63         $default_avatar = Config::get('gravatar', 'default_img');
  64         $rating = Config::get('gravatar', 'rating');
  65
  66         // set default values for first configuration
  67         if(! $default_avatar)
  68                 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
  69         if(! $rating)
  70                 $rating = 'g'; // suitable for display on all websites with any audience type
  71
  72         // Available options for the select boxes
  73         $default_avatars = [
  74                 'mm' => L10n::t('generic profile image'),
  75                 'identicon' => L10n::t('random geometric pattern'),
  76                 'monsterid' => L10n::t('monster face'),
  77                 'wavatar' => L10n::t('computer generated face'),
  78                 'retro' => L10n::t('retro arcade style face'),
  79         ];
  80         $ratings = [
  81                 'g' => 'g',
  82                 'pg' => 'pg',
  83                 'r' => 'r',
  84                 'x' => 'x'
  85         ];
  86
  87         // Check if Libravatar is enabled and show warning
  88         $r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
  89                 dbesc('libravatar')
  90         );
  91         if (count($r)) {
  92                 $o = '<h5>' .L10n::t('Information') .'</h5><p>' .L10n::t('Libravatar addon is installed, too. Please disable Libravatar addon or this Gravatar addon.<br>The Libravatar addon will fall back to Gravatar if nothing was found at Libravatar.') .'</p><br><br>';
  93         }
  94
  95         // output Gravatar settings
  96         $o .= '<input type="hidden" name="form_security_token" value="' .get_form_security_token("gravatarsave") .'">';
  97         $o .= replace_macros( $t, [
  98                 '$submit' => L10n::t('Save Settings'),
  99                 '$default_avatar' => ['avatar', L10n::t('Default avatar image'), $default_avatar, L10n::t('Select default avatar image if none was found at Gravatar. See README'), $default_avatars],
 100                 '$rating' => ['rating', L10n::t('Rating of images'), $rating, L10n::t('Select the appropriate avatar rating for your site. See README'), $ratings],
 101         ]);
 102 }
 103
 104 /**
 105  * Save admin settings
 106  */
 107 function gravatar_addon_admin_post (&$a) {
 108         check_form_security_token('gravatarsave');
 109
 110         $default_avatar = ((x($_POST, 'avatar')) ? notags(trim($_POST['avatar'])) : 'identicon');
 111         $rating = ((x($_POST, 'rating')) ? notags(trim($_POST['rating'])) : 'g');
 112         Config::set('gravatar', 'default_img', $default_avatar);
 113         Config::set('gravatar', 'rating', $rating);
 114         info(L10n::t('Gravatar settings updated.') .EOL);
 115 }