Allow targeting channels

Author: TimWolla

files_wcf/js/Bastelstu.be/_Push.js

@@ -43,6 +43,10 @@ define([ 'Bastelstu.be/core' ], function (core) {
 		onMessage(message, callback) {
 			return core.Promise.reject(new Error('Unsupported'))
 		}
+
+		getFeatureFlags() {
+			return [ ]
+		}
 	}
 
 	return new Push()

files_wcf/lib/system/push/PushHandler.class.php

@@ -19,6 +19,13 @@ class PushHandler extends \wcf\system\SingletonFactory {
 	 */
 	private $deferred = array();
 
+	/**
+	 * Channels to join for this page view.
+	 *
+	 * @var	string[]
+	 */
+	private $channels = [ ];
+	
 	/**
 	 * Returns whether a push service is enabled.
 	 * 
@@ -43,52 +50,42 @@ public function isRunning() {
 		return (boolean) $backend::getInstance()->isRunning();
 	}
 
+	/**
+	 * @see	\wcf\system\push\PushHandler::getFeatureFlags()
+	 */
+	public function getFeatureFlags() {
+		$backend = PUSH_BACKEND;
+		if (method_exists($backend, 'getFeatureFlags')) {
+			return $backend::getInstance()->getFeatureFlags();
+		}
+		
+		return [ ];
+	}
+	
 	/**
 	 * Sends a message to the connected clients. Returns `true` on success and `false`
 	 * otherwise.
 	 * 
-	 * If `$userIDs` is an empty array the message will be sent to every connected client. 
-	 * Otherwise the message will only be sent to clients with the given userID.
-	 * 
-	 * `$payload` will be made available in the JavaScript code as a parameter. Note that
-	 * a specific push backend may choose to ignore the payload, if it cannot transmit it.
-	 * Make sure that you properly handle this in your code.
-	 * 
-	 * ATTENTION: Do NOT (!) send any security related information via sendMessage.
-	 * Not every push service can validate whether the userID given was forged by a malicious client!
+	 * $message must be an array containing the following:
+	 * message: string - The message to send.
+	 * payload: ?array - Additional data to send.
+	 * target: ?array - Targets to send to. The message is send to the Union of Targets.
 	 * 
-	 * @param	string		$message
-	 * @param	array<integer>	$userIDs
-	 * @param	array		$payload
+	 * @param	array		$message
 	 * @return	boolean
 	 */
 	public function sendMessage($message, array $userIDs = array(), array $payload = array()) {
 		if (!$this->isEnabled()) return false;
-		if (!\wcf\data\package\Package::isValidPackageName($message)) return false;
-		$userIDs = array_unique(\wcf\util\ArrayUtil::toIntegerArray($userIDs));
 
 		$backend = PUSH_BACKEND;
 		return (boolean) $backend::getInstance()->sendMessage($message, $userIDs, $payload);
 	}
 
 	/**
-	 * Registers a deferred message. Returns `true` on any well-formed message and `false`
-	 * otherwise.
-	 * Deferred messages will be sent on shutdown. This can be useful if your handler depends
-	 * on data that may not be written to database yet or to achieve a better performance as the
-	 * page is delivered first.
-	 * 
-	 * ATTENTION: Use this method only if your messages are not critical as you cannot check
-	 * whether your message was delivered successfully.
-	 * ATTENTION: Do NOT (!) send any security related information via sendDeferredMessage.
-	 * Not every push service can validate whether the userID given was forged by a malicious client!
-	 * 
-	 * @see	\wcf\system\push\PushHandler::sendMessage()
+	 * @deprecated
 	 */
 	public function sendDeferredMessage($message, array $userIDs = array(), array $payload = array()) {
 		if (!$this->isEnabled()) return false;
-		if (!\wcf\data\package\Package::isValidPackageName($message)) return false;
-		$userIDs = array_unique(\wcf\util\ArrayUtil::toIntegerArray($userIDs));
 
 		$this->deferred[] = array(
 			'message' => $message,
@@ -107,4 +104,22 @@ public function __destruct() {
 			$this->sendMessage($data['message'], $data['userIDs'], $data['payload']);
 		}
 	}
+	
+	/**
+	 * Joins the given channel for this request.
+	 *
+	 * @param	string	$name
+	 */
+	public function joinChannel($name) {
+		$this->channels[$name] = $name;
+	}
+	
+	/**
+	 * Returns the list of joined channels.
+	 *
+	 * @return	string[]
+	 */
+	public function getChannels() {
+		return array_values($this->channels);
+	}
 }

package.xml

@@ -5,8 +5,8 @@
 		<packagedescription><![CDATA[Push provides an easy to use push server API.]]></packagedescription>
 		<packagedescription language="de"><![CDATA[Push stellt ein einfach zu verwendendes Push-Server-API zur Verfügung.]]></packagedescription>
 		<isapplication>0</isapplication>
-		<version>2.0.0 RC 1</version>
-		<date>2016-12-18</date>
+		<version>2.1.0 Alpha 1</version>
+		<date>2017-09-25</date>
 		<license><![CDATA[BSD 3-Clause License <http://opensource.org/licenses/BSD-3-Clause>]]></license>
 	</packageinformation>
 
@@ -16,7 +16,7 @@
 	</authorinformation>
 
 	<requiredpackages>
-		<requiredpackage minversion="3.0.0 RC 1">com.woltlab.wcf</requiredpackage>
+		<requiredpackage minversion="3.0.8">com.woltlab.wcf</requiredpackage>
 		<requiredpackage minversion="2.4.1">be.bastelstu.core-js</requiredpackage>
 	</requiredpackages>
 
@@ -29,6 +29,11 @@
 		<instruction type="templateListener" />
 	</instructions>
 
+	<instructions type="update" fromversion="2.0.0 RC 1">
+		<instruction type="file" application="wcf">files_wcf.tar</instruction>
+		<instruction type="templateListener" />
+	</instructions>
+
 	<instructions type="update" fromversion="1.1.1">
 		<instruction type="file" application="wcf">files_wcf.tar</instruction>
 		<instruction type="templateListener">templateListener.xml</instruction>