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