[gui][daemon] Support for icon check enabled function (e.g. icon enabled only if window active #feature

Author: spaceAngel

gui/css/mainPanel/macros.less

@@ -27,4 +27,8 @@
 	.notification:empty {
 		display:none;
 	}
+	
+	.disabled {
+		opacity: 0.4;
+	}
 }

gui/js/app.js

@@ -70,6 +70,7 @@ document.addEventListener('DOMContentLoaded', function() {
 		function() {socket.send('loadmacros', 123);},
 		2000
 	);
+	macrosWidget.init();
 
 	lockScreenImage.init();
 

gui/js/widgets/macros.js

@@ -1,14 +1,33 @@
 /* global cyberPanel, mixins, socket */
 var macrosWidget = {
+	enableStates: [],
+
 	handle: function(data) {
 		cyberPanel.macros = data.macros;
+	},
+
+	init: function() {
+		socket.registerHandler('macros.enabled', macrosWidget.handleEnabled);
+		setInterval(
+			function() {socket.send('macros.enabled', 123);},
+			1500
+		);
+	},
+
+	handleEnabled: function(data) {
+		macrosWidget.enableStates = data.enabled;
 	}
 };
 
 mixins.push({
 	methods: {
 		runMacro: function(hash) {
-			socket.send('macro', [hash]);
+			if (
+				macrosWidget.enableStates == null
+				|| macrosWidget.enableStates[hash] == true
+			) {
+				socket.send('macro', [hash]);
+			}
 		}
 	}
 });

gui/snippets/mainpanel/macros.html

@@ -1,5 +1,12 @@
 <template v-for="macro in macros">
-	<div class="icon" data-hash="" v-on:click="runMacro(macro.hash)" v-if="!macro.isDelimiter" v-bind:style="'float:' +macro.position">
+	<div 
+		class="icon"
+		v-bind:class="{disabled: macrosWidget.enableStates != null && macrosWidget.enableStates[macro.hash] != true}" 
+		data-hash="" 
+		v-on:click="runMacro(macro.hash)" 
+		v-if="!macro.isDelimiter" 
+		v-bind:style="'float:' +macro.position"
+	>
 		<span v-if="macro.notification" class="notification"><% eval(macro.notification)%></span>
 		<i class="fa fa-4x" v-bind:class="[macro.icon]" v-if="macro.icon"></i> 
 		<img v-if="macro.iconImage" v-bind:src="'data:' +macro.iconImage" style="border-color:1px solid blue;"/>

src/CyberPanel/Commands/CommandResolver.php

@@ -17,6 +17,8 @@
 use CyberPanel\Commands\Commands\StorageCommand;
 use CyberPanel\Macros\Commands\LoadMacrosCommand;
 use CyberPanel\Macros\Commands\RunMacroCommand;
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
+use CyberPanel\Macros\Commands\MacrosEnabledListCommand;
 
 class CommandResolver {
 
@@ -28,8 +30,6 @@ private function __construct() {
 		$this->registerCommand('datetime', DateTimeCommand::class);
 		$this->registerCommand('systeminfo', SystemInfoCommand::class);
 		$this->registerCommand('hwinfo', HwInfoCommand::class);
-		$this->registerCommand('loadmacros', LoadMacrosCommand::class);
-		$this->registerCommand('macro', RunMacroCommand::class);
 		$this->registerCommand('keyboard', KeyboardCommand::class);
 		$this->registerCommand('media', MediaCommand::class);
 		$this->registerCommand('lockscreenimage', LockScreenImageCommand::class);
@@ -39,6 +39,9 @@ private function __construct() {
 		$this->registerCommand('files', FileManagerCommand::class);
 		$this->registerCommand('upsstatus', UpsStateCommand::class);
 		$this->registerCommand('storage', StorageCommand::class);
+		$this->registerCommand('loadmacros', LoadMacrosCommand::class);
+		$this->registerCommand('macro', RunMacroCommand::class);
+		$this->registerCommand('macros.enabled', MacrosEnabledListCommand::class);
 	}
 
 	public static function getInstance() : self {

src/CyberPanel/Macros/Commands/MacrosEnabledListCommand.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace CyberPanel\Macros\Commands;
+
+use CyberPanel\Commands\BaseCommand;
+use CyberPanel\Storage;
+
+class MacrosEnabledListCommand extends BaseCommand {
+	public function run() : array {
+		return ['enabled' => Storage::getInstance()->get('macros.enabled')];
+	}
+}

src/CyberPanel/Macros/Macro.php

@@ -20,6 +20,8 @@ class Macro {
 
 	private ?string $notification = NULL;
 
+	private $checkEnabledFunction = NULL;
+
 	public function getIcon() {
 		return $this->icon;
 	}
@@ -95,4 +97,13 @@ public function setNotification(string $notification) : self {
 	public function getNotification() : ?string {
 		return $this->notification;
 	}
+
+	public function setCheckEnabledFunction(callable $checkEnabledFunction) : self {
+		$this->checkEnabledFunction = $checkEnabledFunction;
+		return $this;
+	}
+
+	public function getCheckEnabledFunction() : ?callable {
+		return $this->checkEnabledFunction;
+	}
 }

src/CyberPanel/Macros/MacroHandlingService.php

@@ -3,11 +3,16 @@
 namespace CyberPanel\Macros;
 
 use CyberPanel\System\Executer;
+use CyberPanel\Utils\Traits\HasSocketClient;
 
 class MacroHandlingService {
 
+	use HasSocketClient;
+
 	protected const TICK_INTERVAL = 0.4;
 
+	protected const TICK_CHECK_ENABLE = 3000;
+
 	protected string $pipefile;
 
 	protected static self $instance;
@@ -31,12 +36,18 @@ public function runExecuter() : void {
 	}
 
 	protected function runLoop() : void {
+		$i = 0;
 		while (TRUE) {
 			if (file_exists($this->pipefile)) {
 				Executer::exec(
 					'/bin/bash < ' . $this->pipefile . '; rm ' . $this->pipefile
 				);
 			}
+			if ($i % self::TICK_CHECK_ENABLE == 0) {
+				$this->checkMacrosEnabled();
+				$i = 0;
+			}
+			$i++;
 			sleep(self::TICK_INTERVAL);
 		}
 	}
@@ -47,5 +58,23 @@ public function execCommand(string $command) : void {
 		fclose($pipe);
 	}
 
+	protected function checkMacrosEnabled() : void {
+		$rslt = [];
+		foreach (MacroManager::getInstance()->getMacros() as $key => $macro) {
+			if (is_callable($macro->getCheckEnabledFunction())) {
+				$rslt[$key] = call_user_func($macro->getCheckEnabledFunction());
+			} else {
+				$rslt[$key] = TRUE;
+			}
+		}
+		$this->sendToSocketServer([
+			'command' => 'storage',
+			'parameters' => [
+				'key' => 'macros.enabled',
+				'value' => $rslt,
+			]
+		]);
+	}
+
 
 }

src/CyberPanel/Macros/MacroParser.php

@@ -38,6 +38,9 @@ public function parse(array $data) : Macro {
 			if (array_key_exists('notification', $data)) {
 				$macro->setNotification($data['notification']);
 			}
+			if (array_key_exists('checkEnabledFunction', $data)) {
+				$macro->setCheckEnabledFunction($data['checkEnabledFunction']);
+			}
 		}
 
 		return $macro;