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
   9 use Friendica\App;
  10 use Friendica\BaseModule;
  11 use Friendica\Core\Hook;
  12 use Friendica\Core\Logger;
  13 use Friendica\Core\Renderer;
  14 use Friendica\Database\DBA;
  15 use Friendica\DI;
  16 use Friendica\Core\Config\Util\ConfigFileManager;
  17 use Friendica\Util\Strings;
  18
  19 /**
  20  * Installs the addon hook
  21  */
  22 function gravatar_install() {
  23         Hook::register('load_config',   'addon/gravatar/gravatar.php', 'gravatar_load_config');
  24         Hook::register('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
  25
  26         Logger::notice("registered gravatar in avatar_lookup hook");
  27 }
  28
  29 function gravatar_load_config(ConfigFileManager $loader)
  30 {
  31         DI::app()->getConfigCache()->load($loader->loadAddonConfig('gravatar'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
  32 }
  33
  34 /**
  35  * Looks up the avatar at gravatar.com and returns the URL.
  36  *
  37  * @param &$b array
  38  */
  39 function gravatar_lookup(array &$b)
  40 {
  41         $default_avatar = DI::config()->get('gravatar', 'default_avatar');
  42         $rating = DI::config()->get('gravatar', 'rating');
  43
  44         // setting default value if nothing configured
  45         if(! $default_avatar)
  46                 $default_avatar = 'identicon'; // default image will be a random pattern
  47         if(! $rating)
  48                 $rating = 'g'; // suitable for display on all websites with any audience type
  49
  50         $hash = md5(trim(strtolower($b['email'])));
  51
  52         $url = 'https://secure.gravatar.com/avatar/' .$hash .'.jpg';
  53         $url .= '?s=' .$b['size'] .'&r=' .$rating;
  54         if ($default_avatar != "gravatar")
  55                 $url .= '&d=' .$default_avatar;
  56
  57         $b['url'] = $url;
  58         $b['success'] = true;
  59 }
  60
  61 /**
  62  * Display admin settings for this addon
  63  */
  64 function gravatar_addon_admin (string &$o)
  65 {
  66         $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/gravatar/" );
  67
  68         $default_avatar = DI::config()->get('gravatar', 'default_avatar');
  69         $rating = DI::config()->get('gravatar', 'rating');
  70
  71         // set default values for first configuration
  72         if (!$default_avatar) {
  73                 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
  74         }
  75         if (!$rating) {
  76                 $rating = 'g'; // suitable for display on all websites with any audience type
  77         }
  78
  79         // Available options for the select boxes
  80         $default_avatars = [
  81                 'mm' => DI::l10n()->t('generic profile image'),
  82                 'identicon' => DI::l10n()->t('random geometric pattern'),
  83                 'monsterid' => DI::l10n()->t('monster face'),
  84                 'wavatar' => DI::l10n()->t('computer generated face'),
  85                 'retro' => DI::l10n()->t('retro arcade style face'),
  86         ];
  87         $ratings = [
  88                 'g' => 'g',
  89                 'pg' => 'pg',
  90                 'r' => 'r',
  91                 'x' => 'x'
  92         ];
  93
  94         // Check if Libravatar is enabled and show warning
  95         if (!empty(DI::config()->get('addons', 'libravatar'))) {
  96                 $o = '<h5>' .DI::l10n()->t('Information') .'</h5><p>' .DI::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>';
  97         }
  98
  99         // output Gravatar settings
 100         $o .= '<input type="hidden" name="form_security_token" value="' . BaseModule::getFormSecurityToken("gravatarsave") .'">';
 101         $o .= Renderer::replaceMacros( $t, [
 102                 '$submit' => DI::l10n()->t('Save Settings'),
 103                 '$default_avatar' => ['avatar', DI::l10n()->t('Default avatar image'), $default_avatar, DI::l10n()->t('Select default avatar image if none was found at Gravatar. See README'), $default_avatars],
 104                 '$rating' => ['rating', DI::l10n()->t('Rating of images'), $rating, DI::l10n()->t('Select the appropriate avatar rating for your site. See README'), $ratings],
 105         ]);
 106 }
 107
 108 /**
 109  * Save admin settings
 110  */
 111 function gravatar_addon_admin_post ()
 112 {
 113         BaseModule::checkFormSecurityToken('gravatarsave');
 114
 115         DI::config()->set('gravatar', 'default_avatar', trim($_POST['avatar'] ?? 'identicon'));
 116         DI::config()->set('gravatar', 'rating', $rating = trim($_POST['rating'] ?? 'g'));
 117 }