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\Config;
  12 use Friendica\Core\Hook;
  13 use Friendica\Core\L10n;
  14 use Friendica\Core\Logger;
  15 use Friendica\Core\Renderer;
  16 use Friendica\Database\DBA;
  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::log("registered gravatar in avatar_lookup hook");
  27 }
  28
  29 /**
  30  * Removes the addon hook
  31  */
  32 function gravatar_uninstall() {
  33         Hook::unregister('load_config',   'addon/gravatar/gravatar.php', 'gravatar_load_config');
  34         Hook::unregister('avatar_lookup', 'addon/gravatar/gravatar.php', 'gravatar_lookup');
  35
  36         Logger::log("unregistered gravatar in avatar_lookup hook");
  37 }
  38
  39 function gravatar_load_config(App $a)
  40 {
  41         $a->loadConfigFile(__DIR__ . '/config/gravatar.config.php');
  42 }
  43
  44 /**
  45  * Looks up the avatar at gravatar.com and returns the URL.
  46  *
  47  * @param $a array
  48  * @param &$b array
  49  */
  50 function gravatar_lookup($a, &$b) {
  51         $default_avatar = Config::get('gravatar', 'default_avatar');
  52         $rating = Config::get('gravatar', 'rating');
  53
  54         // setting default value if nothing configured
  55         if(! $default_avatar)
  56                 $default_avatar = 'identicon'; // default image will be a random pattern
  57         if(! $rating)
  58                 $rating = 'g'; // suitable for display on all websites with any audience type
  59
  60         $hash = md5(trim(strtolower($b['email'])));
  61
  62         $url = 'https://secure.gravatar.com/avatar/' .$hash .'.jpg';
  63         $url .= '?s=' .$b['size'] .'&r=' .$rating;
  64         if ($default_avatar != "gravatar")
  65                 $url .= '&d=' .$default_avatar;
  66
  67         $b['url'] = $url;
  68         $b['success'] = true;
  69 }
  70
  71 /**
  72  * Display admin settings for this addon
  73  */
  74 function gravatar_addon_admin (&$a, &$o) {
  75         $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/gravatar/" );
  76
  77         $default_avatar = Config::get('gravatar', 'default_avatar');
  78         $rating = Config::get('gravatar', 'rating');
  79
  80         // set default values for first configuration
  81         if(! $default_avatar)
  82                 $default_avatar = 'identicon'; // pseudo-random geometric pattern based on email hash
  83         if(! $rating)
  84                 $rating = 'g'; // suitable for display on all websites with any audience type
  85
  86         // Available options for the select boxes
  87         $default_avatars = [
  88                 'mm' => L10n::t('generic profile image'),
  89                 'identicon' => L10n::t('random geometric pattern'),
  90                 'monsterid' => L10n::t('monster face'),
  91                 'wavatar' => L10n::t('computer generated face'),
  92                 'retro' => L10n::t('retro arcade style face'),
  93         ];
  94         $ratings = [
  95                 'g' => 'g',
  96                 'pg' => 'pg',
  97                 'r' => 'r',
  98                 'x' => 'x'
  99         ];
 100
 101         // Check if Libravatar is enabled and show warning
 102         $r = q("SELECT * FROM `addon` WHERE `name` = '%s' and `installed` = 1",
 103                 DBA::escape('libravatar')
 104         );
 105         if (count($r)) {
 106                 $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>';
 107         }
 108
 109         // output Gravatar settings
 110         $o .= '<input type="hidden" name="form_security_token" value="' . BaseModule::getFormSecurityToken("gravatarsave") .'">';
 111         $o .= Renderer::replaceMacros( $t, [
 112                 '$submit' => L10n::t('Save Settings'),
 113                 '$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],
 114                 '$rating' => ['rating', L10n::t('Rating of images'), $rating, L10n::t('Select the appropriate avatar rating for your site. See README'), $ratings],
 115         ]);
 116 }
 117
 118 /**
 119  * Save admin settings
 120  */
 121 function gravatar_addon_admin_post (&$a) {
 122         BaseModule::checkFormSecurityToken('gravatarsave');
 123
 124         $default_avatar = (!empty($_POST['avatar']) ? Strings::escapeTags(trim($_POST['avatar'])) : 'identicon');
 125         $rating = (!empty($_POST['rating']) ? Strings::escapeTags(trim($_POST['rating'])) : 'g');
 126         Config::set('gravatar', 'default_avatar', $default_avatar);
 127         Config::set('gravatar', 'rating', $rating);
 128         info(L10n::t('Gravatar settings updated.') .EOL);
 129 }