N°3169 - Add feature to connect Gsuite mail box with OAuth

N°2504 - Add feature to connect Office mail box with OAuth2 for Microsoft Graph
N°5102 - Allow to send emails (eg. notifications) using GSuite SMTP and OAuth

sources/Core/Authentication/Client/OAuth/OAuthClientProviderAbstract.php

@@ -0,0 +1,163 @@
+<?php
+
+namespace Combodo\iTop\Core\Authentication\Client\OAuth;
+
+use League\OAuth2\Client\Provider\GenericProvider;
+use League\OAuth2\Client\Token\AccessToken;
+use utils;
+
+abstract class OAuthClientProviderAbstract implements IOAuthClientProvider
+{
+	/** @var string */
+	static protected $sVendorName = '';
+	/** @var array */
+	static protected $sVendorColors = ['', '', '', ''];
+	/** @var string */
+	static protected $sVendorIcon = '';
+	static protected $sRedirectUri = '';
+	static protected $sRequiredSMTPScope = '';
+	static protected $sRequiredIMAPScope = '';
+	static protected $sRequiredPOPScope = '';
+	/** @var \League\OAuth2\Client\Provider\GenericProvider */
+	protected $oVendorProvider;
+	/** @var \League\OAuth2\Client\Token\AccessToken */
+	protected $oAccessToken;
+
+	protected $sScope;
+
+
+	/**
+	 * @return \League\OAuth2\Client\Provider\GenericProvider
+	 */
+	public function GetVendorProvider()
+	{
+		return $this->oVendorProvider;
+	}
+
+	/**
+	 * @param \League\OAuth2\Client\Provider\GenericProvider $oVendorProvider
+	 */
+	public function SetVendorProvider(GenericProvider $oVendorProvider)
+	{
+		$this->oVendorProvider = $oVendorProvider;
+	}
+
+	/**
+	 * @return \League\OAuth2\Client\Token\AccessToken
+	 */
+	public function GetAccessToken(): AccessToken
+	{
+		return $this->oAccessToken;
+	}
+
+	/**
+	 * @param \League\OAuth2\Client\Token\AccessToken $oAccessToken
+	 */
+	public function SetAccessToken(AccessToken $oAccessToken)
+	{
+		$this->oAccessToken = $oAccessToken;
+	}
+
+	/**
+	 * @return string
+	 */
+	public static function GetVendorIcon(): string
+	{
+		return static::$sVendorIcon;
+	}
+
+	/**
+	 * @return string
+	 */
+	public static function GetVendorName(): string
+	{
+		return static::$sVendorName;
+	}
+
+
+	public static function getConfFromAccessToken($oAccessToken, $sClientId, $sClientSecret): string
+	{
+		$sAccessToken = $oAccessToken->getToken();
+		$sRefreshToken = $oAccessToken->getRefreshToken();
+		$sVendor = static::GetVendorName();
+
+		return <<<EOF
+'email_transport' => 'SMTP_OAuth',
+'email_transport_smtp.oauth.provider' => '$sVendor',
+'email_transport_smtp.oauth.client_id' => '$sClientId',
+'email_transport_smtp.oauth.client_secret' => '$sClientSecret',
+'email_transport_smtp.oauth.access_token' => '$sAccessToken',
+'email_transport_smtp.oauth.refresh_token' => '$sRefreshToken',
+EOF;
+	}
+
+	/**
+	 * @return array
+	 */
+	public static function GetVendorColors(): array
+	{
+		return static::$sVendorColors;
+	}
+
+	/**
+	 * @return void
+	 * @throws \Exception
+	 */
+	public static function InitizalizeRedirectUri()
+	{
+		static::$sRedirectUri = utils::GetAbsoluteUrlAppRoot().'pages/oauth/landing.php';
+	}
+
+	/**
+	 * @return string
+	 */
+	public static function GetRedirectUri(): string
+	{
+		if (static::$sRedirectUri === '') {
+			static::InitizalizeRedirectUri();
+		}
+
+		return static::$sRedirectUri;
+	}
+
+	/**
+	 * @return string
+	 */
+	public static function GetRequiredSMTPScope(): string
+	{
+		return static::$sRequiredSMTPScope;
+	}
+
+	/**
+	 * @return string
+	 */
+	public static function GetRequiredIMAPScope(): string
+	{
+		return static::$sRequiredIMAPScope;
+	}
+
+	/**
+	 * @return string
+	 */
+	public static function GetRequiredPOPScope(): string
+	{
+		return static::$sRequiredPOPScope;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function GetScope()
+	{
+		return $this->sScope;
+	}
+
+	/**
+	 * @param mixed $sScope
+	 */
+	public function SetScope($sScope)
+	{
+		$this->sScope = $sScope;
+	}
+
+}