GravatarsProvider.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

use Xoops\Core\Service\AbstractContract;
use Xoops\Core\Service\Contract\AvatarInterface;

class GravatarsProvider extends AbstractContract implements AvatarInterface
{
    private static function getGravatar($email)
    {
        $s = 80;   // Size in pixels, defaults to 80px [ 1 - 2048 ]
        $d = 'mm'; // Default imageset to use [ 404 | mm | identicon | monsterid | wavatar ]
        $r = 'g';  // Maximum rating (inclusive) [ g | pg | r | x ]
        if ($helper = Xoops\Module\Helper::getHelper('gravatars')) {
            $v = $helper->getConfig('pixel_size');
            $s = (empty($v)) ? $s : $v;
            $v = $helper->getConfig('default_imageset');
            $d = (empty($v)) ? $d : $v;
            $d = ($d=='default') ? '' : $d; // preferences does not like empty string
            $v = $helper->getConfig('max_rating');
            $r = (empty($v)) ? $r : $v;
        }

        $scheme = \Xoops\Core\HttpRequest::getInstance()->getScheme();
        if ($scheme == 'https') {
            $url = 'https://secure.gravatar.com/avatar/';
        } else {
            $url = 'http://www.gravatar.com/avatar/';
        }
        $url .= md5(strtolower(trim($email)));
        $url .= "?s=$s&d=$d&r=$r";

        return $url;
    }

    private function getUserById($uid)
    {
        $user = \Xoops::getInstance()->getHandlerMember()->getUser((int) $uid);
        return (is_object($user)) ? $user : null;
    }

    public function getName()
    {
        return 'gravatars';
    }

    public function getDescription()
    {
        return 'Use gravatar.com for system avatars.';
    }

    public function getAvatarUrl($response, $userinfo)
    {
        $noInfo = true;
        if (is_object($userinfo)) {
            if (is_a($userinfo, 'XoopsUser')) {
                $email = $userinfo->getVar('email', 'e');
                $response->setValue(self::getGravatar($email));
                $noInfo = false;
            }
        } elseif (is_array($userinfo)) {
            if (!empty($userinfo['email'])) {
                $response->setValue(self::getGravatar($userinfo['email']));
                $noInfo = false;
            }
        } elseif (is_scalar($userinfo)) {
            $user = $this->getUserById((int) $userinfo);
            if (is_object($user) && is_a($user, 'XoopsUser')) {
                $email = $user->getVar('email', 'e');
                $response->setValue(self::getGravatar($email));
                $noInfo = false;
            }
        }
        if ($noInfo) {
            $response->setSuccess(false)->addErrorMessage('User info is invalid');
        }
    }

    public function getAvatarEditUrl($response, \XoopsUser $userinfo)
    {
        $noInfo = true;

        if (is_object($userinfo)) {
            if (is_a($userinfo, 'XoopsUser')) {
                $email = $userinfo->getVar('email', 'e');
                $link = 'http://www.gravatar.com/' . md5(strtolower(trim($email)));
                $response->setValue($link);
                $noInfo = false;
            }
        }
        if ($noInfo) {
            $response->setSuccess(false)->addErrorMessage('User info is invalid');
        }
    }
}