first commit

administrator/components/com_akeebabackup/engine/Util/PushMessages.php

@@ -0,0 +1,148 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Util;
+
+defined('AKEEBAENGINE') || die();
+
+use Akeeba\Engine\Factory;
+use Akeeba\Engine\Platform;
+use Akeeba\Engine\Util\Pushbullet\Connector;
+use Exception;
+
+class PushMessages
+{
+	/**
+	 * The PushBullet connector
+	 *
+	 * @var Connector[]
+	 */
+	private $connectors = [];
+
+	/**
+	 * Should we send push messages?
+	 *
+	 * @var bool
+	 */
+	private $enabled = true;
+
+	/**
+	 * Creates the push messaging object
+	 */
+	public function __construct()
+	{
+		$pushPreference = Platform::getInstance()->get_platform_configuration_option('push_preference', '0');
+		$apiKey         = Platform::getInstance()->get_platform_configuration_option('push_apikey', '');
+
+		// No API key? No push messages are enabled, so no point continuing really...
+		if (empty($apiKey))
+		{
+			$pushPreference = 0;
+		}
+
+		// We use a switch in case we add support for more push APIs in the future. The push_preference platform
+		// option will tell us which service to use. In that case we'll have to refactor this class, but the public
+		// API will remain the same.
+		switch ($pushPreference)
+		{
+			default:
+			case 0:
+				$this->enabled = false;
+				break;
+
+			case 1:
+				$keys = explode(',', $apiKey);
+				$keys = array_map('trim', $keys);
+
+				foreach ($keys as $key)
+				{
+					try
+					{
+						$connector = new Connector($key);
+						$connector->getDevices();
+						$this->connectors[] = $connector;
+					}
+					catch (Exception $e)
+					{
+						Factory::getLog()->warning("Push messages cannot be sent with API key $key. Error received when trying to establish PushBullet connection: " . $e->getMessage());
+					}
+				}
+
+				if (empty($this->connectors))
+				{
+					Factory::getLog()->warning('No push messages can be sent: none of the provided API keys is usable. Push messages have been deactivated.');
+
+					$this->enabled = false;
+				}
+
+				break;
+		}
+	}
+
+	/**
+	 * Sends a push message to all connected devices. The intent is to provide the user with an information message,
+	 * e.g. notify them about the progress of the backup.
+	 *
+	 * @param   string  $subject  The subject of the message, shown in the lock screen. Keep it short.
+	 * @param   string  $details  Long(er) description of what the message is about. Plain text (no HTML).
+	 *
+	 * @return  void
+	 */
+	public function message($subject, $details = null)
+	{
+		if (!$this->enabled)
+		{
+			return;
+		}
+
+		foreach ($this->connectors as $connector)
+		{
+			try
+			{
+				$connector->pushNote('', $subject, $details);
+			}
+			catch (Exception $e)
+			{
+				Factory::getLog()->warning('Push messages suspended. Error received when trying to send push message:' . $e->getMessage());
+				$this->enabled = false;
+			}
+		}
+	}
+
+	/**
+	 * Sends a push message, containing a URL/URI, to all connected devices. The URL will be rendered as something
+	 * clickable on most devices.
+	 *
+	 * @param   string  $url      The URL/URI
+	 * @param   string  $subject  The subject of the message, shown in the lock screen. Keep it short.
+	 * @param   string  $details  Long(er) description of what the message is about. Plain text (no HTML).
+	 *
+	 * @return  void
+	 */
+	public function link($url, $subject, $details = null)
+	{
+		if (!$this->enabled)
+		{
+			return;
+		}
+
+		foreach ($this->connectors as $connector)
+		{
+			try
+			{
+				$connector->pushLink('', $subject, $url, $details);
+			}
+			catch (Exception $e)
+			{
+				Factory::getLog()->warning('Push messages suspended. Error received when trying to send push message with a link:' . $e->getMessage());
+				$this->enabled = false;
+			}
+		}
+	}
+}