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