SPARK-1068 added jna.jar and platform.jar and patch provided by hanguokai

relicensing UserIdlePlugin.java under LGPLv3


git-svn-id: http://svn.igniterealtime.org/svn/repos/spark/trunk@12195 b35dd754-fafc-0310-a699-88a17e54d16e

build/build.xml

@@ -25,7 +25,7 @@
 	<property name="version.minor" value="6"/>
 	<property name="version.revision" value="0"/>
 
-	<property name="version.extra" value="12103"/>
+	<property name="version.extra" value="12193"/>
 
 	<!--
 	<loadfile property="version.extra" srcFile="./.svn/entries">

build/rpm/spark.spec

@@ -95,6 +95,8 @@ exit 0
 /usr/share/spark/lib/lti-civil.jar
 /usr/share/spark/lib/log4j.jar
 /usr/share/spark/lib/log4j.properties
+/usr/share/spark/lib/jna.jar
+/usr/share/spark/lib/platform.jar
 /usr/share/spark/lib/js.jar
 /usr/share/spark/lib/cobra.jar
 /usr/share/spark/lib/lobo-pub.jar

src/java/org/jivesoftware/sparkimpl/plugin/idle/COPYING

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

src/java/org/jivesoftware/sparkimpl/plugin/idle/UserIdlePlugin.java

@@ -2,20 +2,19 @@
  * $RCSfile: ,v $
  * $Revision: $
  * $Date: $
+ * Copyright (C) 2004-2011 Jive Software. All rights reserved.
+ * This plugin is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
  * 
- * Copyright (C) 2004-2010 Jive Software. All rights reserved.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
+ * You should have received a copy of the GNU Lesser General Public License
- * you may not use this file except in compliance with the License.
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
  */
 package org.jivesoftware.sparkimpl.plugin.idle;
 
@@ -37,6 +36,17 @@ import org.jivesoftware.spark.util.log.Log;
 import org.jivesoftware.sparkimpl.settings.local.LocalPreferences;
 import org.jivesoftware.sparkimpl.settings.local.SettingsManager;
 
+import com.sun.jna.platform.win32.Kernel32;
+import com.sun.jna.platform.win32.User32;
+import com.sun.jna.platform.win32.WinUser;
+import com.sun.jna.platform.win32.WinDef.HMODULE;
+import com.sun.jna.platform.win32.WinDef.LRESULT;
+import com.sun.jna.platform.win32.WinDef.WPARAM;
+import com.sun.jna.platform.win32.WinUser.HHOOK;
+import com.sun.jna.platform.win32.WinUser.KBDLLHOOKSTRUCT;
+import com.sun.jna.platform.win32.WinUser.LowLevelKeyboardProc;
+import com.sun.jna.platform.win32.WinUser.MSG;
+
 public class UserIdlePlugin extends TimerTask implements Plugin {
 
     private final int CHECKTIME = 2;
@@ -46,6 +56,7 @@ public class UserIdlePlugin extends TimerTask implements Plugin {
     private int counter = 0;
     private LocalPreferences pref = SettingsManager.getLocalPreferences();
     private Presence latestPresence;
+    private KeyHook keyHook;
 
     @Override
     public boolean canShutDown() {
@@ -58,8 +69,13 @@ public class UserIdlePlugin extends TimerTask implements Plugin {
 	// Check all 5 secounds
 	timer.schedule(this, (1000 * 10), (1000 * CHECKTIME));
 
+	if (Spark.isWindows()) {
+	    keyHook = new KeyHook();
+	    keyHook.initKeyHook();
+	} else {
 	    addGlobalListener();
 	}
+    }
 
     @Override
     public void shutdown() {
@@ -67,14 +83,18 @@ public class UserIdlePlugin extends TimerTask implements Plugin {
 
     @Override
     public void uninstall() {
+	if (Spark.isWindows()) {
+	    keyHook.quitKeyHook();
+	}
     }
 
     private void setIdle() {
-		latestPresence = SparkManager.getWorkspace().getStatusBar().getPresence();
+	latestPresence = SparkManager.getWorkspace().getStatusBar()
-		if ((latestPresence.getMode() ==  Presence.Mode.available ) ||
+		.getPresence();
-				latestPresence.getMode() == Presence.Mode.chat)
+	if ((latestPresence.getMode() == Presence.Mode.available)
-		{
+		|| latestPresence.getMode() == Presence.Mode.chat) {
-			Presence presence = new Presence(Presence.Type.available, Res.getString("status.away"), 1, Presence.Mode.away);
+	    Presence presence = new Presence(Presence.Type.available,
+		    Res.getString("status.away"), 1, Presence.Mode.away);
 	    SparkManager.getSessionManager().changePresence(presence);
 	}
     }
@@ -88,14 +108,17 @@ public class UserIdlePlugin extends TimerTask implements Plugin {
 	if (pref.isIdleOn()) {
 	    PointerInfo info = MouseInfo.getPointerInfo();
 	    // DecimalFormat format = new DecimalFormat("0.00");
-			//System.out.println(format.format(info.getLocation().getY()).toString() + "-" + 7.24288464E8 + "-" + (info.getLocation().getY() == 7.24288464E8));
+	    // System.out.println(format.format(info.getLocation().getY()).toString()
-			//System.out.println(format.format(info.getLocation().getX()).toString() + "-" + 7.24288464E8 + "-" + (info.getLocation().getX() == 7.24288464E8));
+	    // + "-" + 7.24288464E8 + "-" + (info.getLocation().getY() ==
+	    // 7.24288464E8));
+	    // System.out.println(format.format(info.getLocation().getX()).toString()
+	    // + "-" + 7.24288464E8 + "-" + (info.getLocation().getX() ==
+	    // 7.24288464E8));
 	    int automaticIdleTime = (pref.getIdleTime() * 60) / CHECKTIME;
 
 	    // Windows Desktop Lock
 	    if (Spark.isWindows()) {
 
-				
 		if (info != null) {
 		    if (info.getLocation().getX() > 50000000
 			    || info.getLocation().getY() > 50000000) {
@@ -160,4 +183,74 @@ public class UserIdlePlugin extends TimerTask implements Plugin {
 	    }
 	});
     }
+
+    private void userActive() {
+	counter = 0;
+	if (hasChanged) {
+	    setOnline();
+	    hasChanged = false;
+	}
+    }
+
+    /** Sample implementation of a low-level keyboard hook on W32. */
+    class KeyHook {
+	private HHOOK hhk;
+	private LowLevelKeyboardProc keyboardHook;
+	private Thread thread;
+
+	public void initKeyHook() {
+
+	    thread = new Thread(new Runnable() {
+
+		@Override
+		public void run() {
+		    final User32 lib = User32.INSTANCE;
+		    HMODULE hMod = Kernel32.INSTANCE.GetModuleHandle(null);
+		    keyboardHook = new LowLevelKeyboardProc() {
+			public LRESULT callback(int nCode, WPARAM wParam,
+				KBDLLHOOKSTRUCT info) {
+			    if (nCode >= 0) {
+				switch (wParam.intValue()) {
+				// case WinUser.WM_KEYUP:
+				case WinUser.WM_KEYDOWN:
+				    // case WinUser.WM_SYSKEYUP:
+				case WinUser.WM_SYSKEYDOWN:
+				    // do active
+				    userActive();
+				}
+			    }
+			    return lib.CallNextHookEx(hhk, nCode, wParam,
+				    info.getPointer());
+			}
+		    };
+		    hhk = lib.SetWindowsHookEx(WinUser.WH_KEYBOARD_LL,
+			    keyboardHook, hMod, 0);
+
+		    // This bit never returns from GetMessage
+		    int result;
+		    MSG msg = new MSG();
+		    while ((result = lib.GetMessage(msg, null, 0, 0)) != 0) {
+			if (result == -1) {
+			    System.err.println("error in get message");
+			    break;
+			} else {
+			    System.err.println("got message");
+			    lib.TranslateMessage(msg);
+			    lib.DispatchMessage(msg);
+			}
+		    }
+		    lib.UnhookWindowsHookEx(hhk);
+		}
+	    });
+	    thread.start();
+	}
+
+	@SuppressWarnings("deprecation")
+	public void quitKeyHook() {
+	    final User32 lib = User32.INSTANCE;
+	    lib.UnhookWindowsHookEx(hhk);
+	    thread.stop();
+	}
+
+    }
 }