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