Source for file gmail.php

Documentation is available at gmail.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Plugin
  4.  * @subpackage  Authentication.gmail
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * GMail Authentication Plugin
  14.  *
  15.  * @package     Joomla.Plugin
  16.  * @subpackage  Authentication.gmail
  17.  * @since       1.5
  18.  */
  19. class PlgAuthenticationGMail extends JPlugin
  20. {
  21.     /**
  22.      * This method should handle any authentication and report back to the subject
  23.      *
  24.      * @param   array   $credentials  Array holding the user credentials
  25.      * @param   array   $options      Array of extra options
  26.      * @param   object  &$response    Authentication response object
  27.      *
  28.      * @return  boolean 
  29.      *
  30.      * @since   1.5
  31.      */
  32.     public function onUserAuthenticate($credentials, $options, &$response)
  33.     {
  34.         $success = 0;
  35.  
  36.         // Check if we have curl or not
  37.         if (function_exists('curl_init'))
  38.         {
  39.             // Check if we have a username and password
  40.             if (strlen($credentials['username']) && strlen($credentials['password']))
  41.             {
  42.                 $blacklist = explode(',', $this->params->get('user_blacklist', ''));
  43.  
  44.                 // Check if the username isn't blacklisted
  45.                 if (!in_array($credentials['username'], $blacklist))
  46.                 {
  47.                     $suffix = $this->params->get('suffix', '');
  48.                     $applysuffix = $this->params->get('applysuffix', 0);
  49.                     $offset = strpos($credentials['username'], '@');
  50.  
  51.                     // Check if we want to do suffix stuff, typically for Google Apps for Your Domain
  52.                     if ($suffix && $applysuffix)
  53.                     {
  54.                         if ($applysuffix == 1 && $offset === false)
  55.                         {
  56.                             // Apply suffix if missing
  57.                             $credentials['username'] .= '@' . $suffix;
  58.                         }
  59.                         elseif ($applysuffix == 2)
  60.                         {
  61.                             // Always use suffix
  62.                             if ($offset)
  63.                             {
  64.                                 // If we already have an @, get rid of it and replace it
  65.                                 $credentials['username'] = substr($credentials['username'], 0, $offset);
  66.                             }
  67.  
  68.                             $credentials['username'] .= '@' . $suffix;
  69.                         }
  70.                     }
  71.  
  72.                     $curl = curl_init('https://mail.google.com/mail/feed/atom');
  73.                     curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
  74.                     curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->params->get('verifypeer', 1));
  75.                     //curl_setopt($curl, CURLOPT_HEADER, 1);
  76.                     curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
  77.                     curl_setopt($curl, CURLOPT_USERPWD, $credentials['username'] . ':' . $credentials['password']);
  78.                     curl_exec($curl);
  79.                     $code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
  80.  
  81.                     switch ($code)
  82.                     {
  83.                         case 200:
  84.                             $message = JText::_('JGLOBAL_AUTH_ACCESS_GRANTED');
  85.                             $success = 1;
  86.                             break;
  87.  
  88.                         case 401:
  89.                             $message = JText::_('JGLOBAL_AUTH_ACCESS_DENIED');
  90.                             break;
  91.  
  92.                         default:
  93.                             $message = JText::_('JGLOBAL_AUTH_UNKNOWN_ACCESS_DENIED');
  94.                             break;
  95.                     }
  96.                 }
  97.                 else
  98.                 {
  99.                     // The username is black listed
  100.                     $message = JText::_('JGLOBAL_AUTH_USER_BLACKLISTED');
  101.                 }
  102.             }
  103.             else
  104.             {
  105.                 $message = JText::_('JGLOBAL_AUTH_USER_BLACKLISTED');
  106.             }
  107.         }
  108.         else
  109.         {
  110.             $message = JText::_('JGLOBAL_AUTH_CURL_NOT_INSTALLED');
  111.         }
  112.  
  113.         $response->type = 'GMail';
  114.  
  115.         if ($success)
  116.         {
  117.             $response->status        = JAuthentication::STATUS_SUCCESS;
  118.             $response->error_message = '';
  119.  
  120.             if (strpos($credentials['username'], '@') === false)
  121.             {
  122.                 if ($suffix)
  123.                 {
  124.                     // If there is a suffix then we want to apply it
  125.                     $response->email = $credentials['username'] . '@' . $suffix;
  126.                 }
  127.                 else
  128.                 {
  129.                     // If there isn't a suffix just use the default gmail one
  130.                     $response->email = $credentials['username'] . '@gmail.com';
  131.                 }
  132.             }
  133.             else
  134.             {
  135.                 // The username looks like an email address (probably is) so use that
  136.                 $response->email = $credentials['username'];
  137.             }
  138.  
  139.             // Reset the username to what we ended up using
  140.             $response->username = $credentials['username'];
  141.             $response->fullname = $credentials['username'];
  142.         }
  143.         else
  144.         {
  145.             $response->status        = JAuthentication::STATUS_FAILURE;
  146.             $response->error_message = JText::sprintf('JGLOBAL_AUTH_FAILED', $message);
  147.         }
  148.     }
  149. }

Documentation generated on Tue, 19 Nov 2013 15:04:01 +0100 by phpDocumentor 1.4.3