From 121d59ee28709ca0229930f86d77d8e71fb9024d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20L=C3=BCbking?= <thomas.luebking@gmail.com>
Date: Sat, 26 Sep 2015 17:42:34 +0200
Subject: [PATCH] add black/whitelist config to videowall

REVIEW: 125410
BUG: 353153
FIXED-IN: 5.5
---
 scripts/videowall/contents/code/main.js    |  35 ++---
 scripts/videowall/contents/config/main.xml |  22 +++
 scripts/videowall/contents/ui/config.ui    | 148 +++++++++++++++++++++
 scripts/videowall/metadata.desktop         |   7 +-
 4 files changed, 194 insertions(+), 18 deletions(-)
 create mode 100644 scripts/videowall/contents/config/main.xml
 create mode 100644 scripts/videowall/contents/ui/config.ui

diff --git a/scripts/videowall/contents/code/main.js b/scripts/videowall/contents/code/main.js
index e4d83de88f..cc27df9812 100644
--- a/scripts/videowall/contents/code/main.js
+++ b/scripts/videowall/contents/code/main.js
@@ -17,27 +17,28 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *********************************************************************/
+
+var applyTo = readConfig("ApplyTo", true);
+var whitelist = readConfig("Whitelist", "vlc, xv, vdpau, smplayer, dragon, xine, ffplay, mplayer").toString().toLowerCase().split(",");
+for (i = 0; i < whitelist.length; ++i)
+    whitelist[i] = whitelist[i].trim();
+
+var ignore = readConfig("Ignore", false);
+var blacklist = readConfig("Blacklist", "").toString().toLowerCase().split(",");
+for (i = 0; i < blacklist.length; ++i)
+    blacklist[i] = blacklist[i].trim();
+
+
 function isVideoPlayer(client) {
-    if (client.resourceName == "vlc") {
-        return true;
-    }
-    if (client.resourceName == "smplayer") {
-        return true;
-    }
-    if (client.resourceName == "dragon") {
-        return true;
-    }
-    if (client.resourceName == "xv") { //mplayer
-        return true;
-    }
-    if (client.resourceName == "ffplay") {
-        return true;
-    }
-    return false;
+    if (applyTo == true && whitelist.indexOf(client.resourceClass.toString()) < 0)
+        return false; // required whitelist match failed
+    if (ignore == true && blacklist.indexOf(client.resourceClass.toString()) > -1)
+        return false; // required blacklist match hit
+    return true;
 }
 
 var videowall = function(client, set) {
-    if (isVideoPlayer(client) && set) {
+    if (set && isVideoPlayer(client)) {
         client.geometry = workspace.clientArea(KWin.FullArea, 0, 1);
     }
 };
diff --git a/scripts/videowall/contents/config/main.xml b/scripts/videowall/contents/config/main.xml
new file mode 100644
index 0000000000..7baa80d459
--- /dev/null
+++ b/scripts/videowall/contents/config/main.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kcfg xmlns="http://www.kde.org/standards/kcfg/1.0"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://www.kde.org/standards/kcfg/1.0
+      http://www.kde.org/standards/kcfg/1.0/kcfg.xsd" >
+  <kcfgfile name=""/>
+  <group name="">
+    <entry name="ApplyTo" type="bool">
+      <default>true</default>
+    </entry>
+    <entry name="Whitelist" type="string">
+      <default>vlc, xv, vdpau, smplayer, dragon, xine, ffplay, mplayer</default>
+    </entry>
+    <entry name="Ignore" type="bool">
+      <default>false</default>
+    </entry>
+    <entry name="Blacklist" type="string">
+      <default></default>
+    </entry>
+  </group>
+
+</kcfg>
diff --git a/scripts/videowall/contents/ui/config.ui b/scripts/videowall/contents/ui/config.ui
new file mode 100644
index 0000000000..53543cdfcb
--- /dev/null
+++ b/scripts/videowall/contents/ui/config.ui
@@ -0,0 +1,148 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>KWin::VideoWallConfigForm</class>
+ <widget class="QWidget" name="KWin::VideoWallConfigForm">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>334</width>
+    <height>59</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Video Wall</string>
+  </property>
+  <layout class="QFormLayout" name="formLayout">
+   <item row="0" column="0">
+    <widget class="QCheckBox" name="kcfg_ApplyTo">
+     <property name="text">
+      <string>Apply to</string>
+     </property>
+     <property name="checked">
+      <bool>true</bool>
+     </property>
+    </widget>
+   </item>
+   <item row="0" column="1">
+    <layout class="QHBoxLayout" name="horizontalLayout_2">
+     <item>
+      <widget class="QLineEdit" name="kcfg_Whitelist">
+       <property name="text">
+        <string>vlc, xv, vdpau, smplayer, dragon, xine, ffplay</string>
+       </property>
+       <property name="placeholderText">
+        <string>Comma separated list of window classes</string>
+       </property>
+      </widget>
+     </item>
+     <item>
+      <widget class="QLabel" name="applyLabel">
+       <property name="visible">
+        <bool>false</bool>
+       </property>
+       <property name="text">
+        <string>All</string>
+       </property>
+      </widget>
+     </item>
+    </layout>
+   </item>
+   <item row="1" column="0">
+    <widget class="QCheckBox" name="kcfg_Ignore">
+     <property name="text">
+      <string>Ignore</string>
+     </property>
+    </widget>
+   </item>
+   <item row="1" column="1">
+    <layout class="QHBoxLayout" name="horizontalLayout">
+     <item>
+      <widget class="QLineEdit" name="kcfg_Blacklist">
+       <property name="visible">
+        <bool>false</bool>
+       </property>
+       <property name="placeholderText">
+        <string>Comma separated list of window classes</string>
+       </property>
+      </widget>
+     </item>
+     <item>
+      <widget class="QLabel" name="ignoreLabel">
+       <property name="text">
+        <string>None</string>
+       </property>
+      </widget>
+     </item>
+    </layout>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections>
+  <connection>
+   <sender>kcfg_ApplyTo</sender>
+   <signal>toggled(bool)</signal>
+   <receiver>kcfg_Whitelist</receiver>
+   <slot>setVisible(bool)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>41</x>
+     <y>9</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>143</x>
+     <y>13</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>kcfg_ApplyTo</sender>
+   <signal>toggled(bool)</signal>
+   <receiver>applyLabel</receiver>
+   <slot>setHidden(bool)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>28</x>
+     <y>15</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>330</x>
+     <y>20</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>kcfg_Ignore</sender>
+   <signal>toggled(bool)</signal>
+   <receiver>kcfg_Blacklist</receiver>
+   <slot>setVisible(bool)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>33</x>
+     <y>44</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>111</x>
+     <y>45</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>kcfg_Ignore</sender>
+   <signal>toggled(bool)</signal>
+   <receiver>ignoreLabel</receiver>
+   <slot>setHidden(bool)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>51</x>
+     <y>33</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>327</x>
+     <y>42</y>
+    </hint>
+   </hints>
+  </connection>
+ </connections>
+</ui>
diff --git a/scripts/videowall/metadata.desktop b/scripts/videowall/metadata.desktop
index 73449839b7..fc8e6b68e0 100644
--- a/scripts/videowall/metadata.desktop
+++ b/scripts/videowall/metadata.desktop
@@ -101,5 +101,10 @@ X-KDE-PluginInfo-Version=1.0
 
 X-KDE-PluginInfo-Depends=
 X-KDE-PluginInfo-License=GPL
-X-KDE-ServiceTypes=KWin/Script
+X-KDE-ServiceTypes=KWin/Script,KCModule
+
+X-KDE-Library=kwin/effects/configs/kcm_kwin4_genericscripted
+X-KDE-PluginKeyword=videowall
+X-KDE-ParentComponents=videowall
+
 Type=Service