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