Technology Experience

Contenuti gestiti da Igor Damiani
posts - 949, comments - 2741, trackbacks - 15120

My Links

News

  • Questo blog si propone di raccogliere riflessioni, teoriche e pratiche, su tutto quello che riguarda il world-computing che mi sta attorno: programmazione in .NET, software attuale e futuro, notizie provenienti dal web, tecnologia in generale, open-source.

    L'idea è quella di lasciare una sorta di patrimonio personale, una raccolta di idee che un giorno potrebbe farmi sorridere, al pensiero di dov'ero e cosa stavo facendo.

    10/05/2005,
    Milano

Archives

Post Categories

Generale

Creare un hook sulla tastiera con il framework 2.0

Ieri sera mi sono messo davanti al codice del mio HappySign che pian piano sta vedendo la luce. Tra le varie migliorie, ho intenzione di aggiungere una funzionalità che permette di associare una certa combinazione di tasti ad una certa firma. Per esempio, sto scrivendo un'e-mail con Outlook Express, premo CTRL+F6 e lui mi aggiunge automaticamente la firma "Asta la vista, baby...".

Per farlo, occorre ovviamente implementare e gestire un hook sulla tastiera a livello di sistema. In Rete ho trovato tanti esempi e tanto codice. Io mi sono fissato ad utilizzare la classe UserActivityHook riportata qui sotto:

using System;
using System.Runtime.InteropServices;
using System.Reflection;
using System.Threading;
using System.Windows.Forms;

namespace HappySign  {
    
    
/// <summary>
    /// 
This class allows you to tap keyboard and mouse and / or to detect their activity even when an 
    
/// application runes in background or does not have any user interface at all. This class raises 
    
/// common .NET events with KeyEventArgs and MouseEventArgs so you can easily retrive any information you need.
    
/// </summary>
    /// <remarks>
    ///     
created by - Georgi
    
///     created on - 22.05.2004 13:08:01
    
/// </remarks>
    
public class UserActivityHook : object {
        
        
/// <summary>
        /// 
Default constructor - starts hooks automatically
        
/// </summary>
        
public UserActivityHook() {
            Start();
        }
        
        ~UserActivityHook() { 
            Stop();
        } 

        
public event MouseEventHandler OnMouseActivity;
        
public event KeyEventHandler KeyDown;
        
public event KeyPressEventHandler KeyPress;
        
public event KeyEventHandler KeyUp;

        
public delegate int HookProc(int nCode, Int32 wParam, IntPtr lParam);

        
static int hMouseHook = 0; //Declare mouse hook handle as int.
        
static int hKeyboardHook = 0; //Declare keyboard hook handle as int.

        //values from Winuser.h in Microsoft SDK.
        
public const int WH_MOUSE_LL     = 14;    //mouse hook constant
        
public const int WH_KEYBOARD_LL = 13;    //keyboard hook constant    

        
HookProc MouseHookProcedure; //Declare MouseHookProcedure as HookProc type.
        
HookProc KeyboardHookProcedure; //Declare KeyboardHookProcedure as HookProc type.
            

        //Declare wrapper managed POINT class.
        
[StructLayout(LayoutKind.Sequential)]
        
public class POINT 
        {
            
public int x;
            
public int y;
        }

        
//Declare wrapper managed MouseHookStruct class.
        
[StructLayout(LayoutKind.Sequential)]
        
public class MouseHookStruct 
        {
            
public POINT pt;
            
public int hwnd;
            
public int wHitTestCode;
            
public int dwExtraInfo;
        }

        
//Declare wrapper managed KeyboardHookStruct class.
        
[StructLayout(LayoutKind.Sequential)]
        
public class KeyboardHookStruct
        {
            
public int vkCode;    //Specifies a virtual-key code. The code must be a value in the range 1 to 254. 
            
public int scanCode; // Specifies a hardware scan code for the key. 
            
public int flags;  // Specifies the extended-key flag, event-injected flag, context code, and transition-state flag.
            
public int time; // Specifies the time stamp for this message.
            
public int dwExtraInfo; // Specifies extra information associated with the message. 
        
}


        
//Import for SetWindowsHookEx function.
        //Use this function to install a hook.
        
[DllImport("user32.dll",CharSet=CharSet.Auto,
            CallingConvention=CallingConvention.StdCall)]
        
public static extern int SetWindowsHookEx(int idHook, HookProc lpfn, 
            IntPtr hInstance, 
int threadId);

        
//Import for UnhookWindowsHookEx.
        //Call this function to uninstall the hook.
        
[DllImport("user32.dll",CharSet=CharSet.Auto,
             CallingConvention=CallingConvention.StdCall)]
        
public static extern bool UnhookWindowsHookEx(int idHook);
        
        
//Import for CallNextHookEx.
        //Use this function to pass the hook information to next hook procedure in chain.
        
[DllImport("user32.dll",CharSet=CharSet.Auto,
             CallingConvention=CallingConvention.StdCall)]
        
public static extern int CallNextHookEx(int idHook, int nCode, 
            Int32 wParam, IntPtr lParam);  

        
public void Start()
        {
            
// install Mouse hook 
            
if(hMouseHook == 0)
            {
                
// Create an instance of HookProc.
                
MouseHookProcedure = new HookProc(MouseHookProc);

                hMouseHook = SetWindowsHookEx( WH_MOUSE_LL,
                    MouseHookProcedure, 
                    Marshal.GetHINSTANCE(
                        Assembly.GetExecutingAssembly().GetModules()[0]),
                    0);

                
//If SetWindowsHookEx fails.
                
if(hMouseHook == 0 )    {
                    Stop();
                    
throw new Exception("SetWindowsHookEx failed.");
                }
            }
            
            
// install Keyboard hook 
            
if(hKeyboardHook == 0)
            {
                KeyboardHookProcedure = 
new HookProc(KeyboardHookProc);
                hKeyboardHook = SetWindowsHookEx( WH_KEYBOARD_LL,
                    KeyboardHookProcedure, 
                    Marshal.GetHINSTANCE(
                    Assembly.GetExecutingAssembly().GetModules()[0]),
                    0);

                
//If SetWindowsHookEx fails.
                
if(hKeyboardHook == 0 )    {
                    Stop();
                    
throw new Exception("SetWindowsHookEx ist failed.");
                }
            }
        }

        
public void Stop()
        {
            
bool retMouse =true;
            
bool retKeyboard = true;
            
if(hMouseHook != 0)
            {
                retMouse = UnhookWindowsHookEx(hMouseHook);
                hMouseHook = 0;
            } 
            
            
if(hKeyboardHook != 0)
            {
                retKeyboard = UnhookWindowsHookEx(hKeyboardHook);
                hKeyboardHook = 0;
            } 
            
            
//If UnhookWindowsHookEx fails.
            
if (!(retMouse && retKeyboard)) throw new Exception("UnhookWindowsHookEx failed.");
        }



          
private const int WM_MOUSEMOVE = 0x200;
          
private const int WM_LBUTTONDOWN = 0x201;
          
private const int WM_RBUTTONDOWN = 0x204;
          
private const int WM_MBUTTONDOWN = 0x207;
          
private const int WM_LBUTTONUP = 0x202;
          
private const int WM_RBUTTONUP = 0x205;
          
private const int WM_MBUTTONUP = 0x208;
          
private const int WM_LBUTTONDBLCLK = 0x203;
          
private const int WM_RBUTTONDBLCLK = 0x206;
        
private const int WM_MBUTTONDBLCLK = 0x209;

        
private int MouseHookProc(int nCode, Int32 wParam, IntPtr lParam)
        {
            
// if ok and someone listens to our events
            
if ((nCode >= 0) && (OnMouseActivity!=null)) {
                
                MouseButtons button=MouseButtons.None;
                
switch (wParam)
                {
                    
case WM_LBUTTONDOWN: 
                    
//case WM_LBUTTONUP: 
                    //case WM_LBUTTONDBLCLK: 
                        
button=MouseButtons.Left; 
                        
break;
                    
case WM_RBUTTONDOWN: 
                    
//case WM_RBUTTONUP: 
                    //case WM_RBUTTONDBLCLK: 
                        
button=MouseButtons.Right; 
                        
break;
                }
                
int clickCount=0;
                
if (button!=MouseButtons.None)
                    
if (wParam==WM_LBUTTONDBLCLK || wParam==WM_RBUTTONDBLCLK) clickCount=2;
                    
else clickCount=1;
                
                
//Marshall the data from callback.
                
MouseHookStruct MyMouseHookStruct = (MouseHookStruct) Marshal.PtrToStructure(lParam, typeof(MouseHookStruct));
                MouseEventArgs e=
new MouseEventArgs(
                                                    button, 
                                                    clickCount, 
                                                    MyMouseHookStruct.pt.x, 
                                                    MyMouseHookStruct.pt.y, 
                                                    0 );
                OnMouseActivity(
this, e);
            }
            
return CallNextHookEx(hMouseHook, nCode, wParam, lParam); 
        }


        
//The ToAscii function translates the specified virtual-key code and keyboard state to the corresponding character or characters. The function translates the code using the input language and physical keyboard layout identified by the keyboard layout handle.
        
[DllImport("user32")] 
        
public static extern int ToAscii(int uVirtKey, //[in] Specifies the virtual-key code to be translated. 
                                         
int uScanCode, // [in] Specifies the hardware scan code of the key to be translated. The high-order bit of this value is set if the key is up (not pressed). 
                                         
byte[] lpbKeyState, // [in] Pointer to a 256-byte array that contains the current keyboard state. Each element (byte) in the array contains the state of one key. If the high-order bit of a byte is set, the key is down (pressed). The low bit, if set, indicates that the key is toggled on. In this function, only the toggle bit of the CAPS LOCK key is relevant. The toggle state of the NUM LOCK and SCROLL LOCK keys is ignored.
                                         
byte[] lpwTransKey, // [out] Pointer to the buffer that receives the translated character or characters. 
                                         
int fuState); // [in] Specifies whether a menu is active. This parameter must be 1 if a menu is active, or 0 otherwise. 

        //The GetKeyboardState function copies the status of the 256 virtual keys to the specified buffer. 
        
[DllImport("user32")] 
        
public static extern int GetKeyboardState(byte[] pbKeyState);

        
private const int WM_KEYDOWN         = 0x100;
        
private const int WM_KEYUP             = 0x101;
        
private const int WM_SYSKEYDOWN     = 0x104;
        
private const int WM_SYSKEYUP         = 0x105;

        
private int KeyboardHookProc(int nCode, Int32 wParam, IntPtr lParam)
        {
            
// it was ok and someone listens to events
            
if ((nCode >= 0) && (KeyDown!=null || KeyUp!=null || KeyPress!=null))
            {
                KeyboardHookStruct MyKeyboardHookStruct = (KeyboardHookStruct) Marshal.PtrToStructure(lParam, 
typeof(KeyboardHookStruct));
                
// raise KeyDown
                
if ( KeyDown!=null && ( wParam ==WM_KEYDOWN || wParam==WM_SYSKEYDOWN ))
                {
                    Keys keyData=(Keys)MyKeyboardHookStruct.vkCode;
                    KeyEventArgs e = 
new KeyEventArgs(keyData);
                    KeyDown(
this, e);
                }
                
                
// raise KeyPress
                
if ( KeyPress!=null &&  wParam ==WM_KEYDOWN )
                {
                    
byte[] keyState = new byte[256];
                    GetKeyboardState(keyState);

                    
byte[] inBuffer= new byte[2];
                    
if (ToAscii(MyKeyboardHookStruct.vkCode,
                            MyKeyboardHookStruct.scanCode,
                            keyState,
                            inBuffer,
                            MyKeyboardHookStruct.flags)==1) 
                            {
                                KeyPressEventArgs e = 
new KeyPressEventArgs((char)inBuffer[0]);
                                KeyPress(
this, e);
                            }
                }
                
                
// raise KeyUp
                
if ( KeyUp!=null && ( wParam ==WM_KEYUP || wParam==WM_SYSKEYUP ))
                {
                    Keys keyData=(Keys)MyKeyboardHookStruct.vkCode;
                    KeyEventArgs e = 
new KeyEventArgs(keyData);
                    KeyUp(
this, e);
                }

            }
            
return CallNextHookEx(hKeyboardHook, nCode, wParam, lParam); 
        }
    }
}

Con il framework 1.1 la classe qui sopra funziona egregiamente. Con il framework 2.0 invece no. Quando istanzio un oggetto UserActivityHook con un banale...

UserActivityHook kh = new UserActivityHook();

...viene eseguito il costruttore, che a sua volta chiama il metodo Start. A questo punto mi vengono sollevate due exception (che ora, purtroppo, non ricordo): una quando viene creato l'hook sul mouse, e l'altra quando viene creato l'hook sulla tastiera. Ho scritto un post in merito sul forum UGIdotNET.

Preso dal panico, ho cercato altri esempi sulla Rete, ma tutti soffrono dello stesso problema. Ho pensato quindi che ci fosse qualche differenza tra FW1.1 e FW2.0 in tema di Interop. In particolare, sembra che l'API SetWindowsHookEx non funzioni a dovere, oppure che sia dichiarata male.

Dal forum, ho avuto una risposta di Corrado che, almeno per il momento, fa luce sulla questione. A quanto pare le dichiarazioni delle API della classe qui sopra non sono corrette: se qualcuno ha avuto lo stesso problema, vi rimando allo stesso URL segnalato da Corrado, ovvero http://support.microsoft.com/kb/318804/.

In questo momento non posso testare, ma lo farò questa sera!

powered by IMHO 1.2

Print | posted on giovedì 3 novembre 2005 12:32 |

Feedback

Gravatar

# re: Creare un hook sulla tastiera con il framework 2.0

Mi permetto di darti un piccolo tip:
non è necessario ridefinire la struttura POINT, puoi utilizzare la managed System.Drawing.Point che "casualmente" si adegua perfettamente per essere usata con P/Invoke. Questo non è il solo caso; lo stesso vale anche per altre strutture.
04/11/2005 00:51 | Massimo Prota
Gravatar

# re: Creare un hook sulla tastiera con il framework 2.0

Massimo, non sono proprio convinto che sia conveniente quella scelta.
Mancando l'attributo StructLayout il rischio è che la struttura managed possa avere un layout diverso da quello atteso. Per esempio su piattaforme a 64bit può accadere anche se naturalmente poi avresti altri problemi.
Con tutto questo non metto in dubbi che funzioni ma non credo sia una buona pratica.
04/11/2005 11:59 | Raffaele Rialdi
Gravatar

# re: Creare un hook sulla tastiera con il framework 2.0

Grazie per la precisazione Raf.
Molte volte negli articoli su P/Invoke ho visto definire la struttura RECT che si mappa perfettamente su Rectangle e utilizzando quest'ultima mi è sempre andato tutto liscio. Pensavo fosse dato da una svista o un copy&paste troppo facile e non avevo considerato quanto dici.
04/11/2005 15:40 | Massimo Prota
Gravatar

# re: Creare un hook sulla tastiera con il framework 2.0

Ho riletto meglio il tuo commento: le strutture di cui abbiamo parlato (Point e Rectangle) sono comunque marcate con l'attributo StructLayout (LayoutKind.Sequential) all'interno del framework. Ne ero sicuro perché so che questo è attributo è molto importante quando si parla di strutture e P/Invoke (da una vecchia sessione di Corrado in un workshop :)) e quindi ne avevo verificato la presenza quando avevo deciso di usare la struttura Rectangle anzichè ridefinirla con RECT.
04/11/2005 15:49 | Massimo Prota
Gravatar

# re: Creare un hook sulla tastiera con il framework 2.0

Ottimo punto Massimo.
Io avevo dato un occhio solo a Msdn e non a Reflector.
Msdn manca di specificare che Point e Rect sono già marcate con StructLayout e quindi non può che filare tutto liscio.
04/11/2005 16:41 | Raffaele Rialdi
Gravatar

# Global hook in .NET 2.0

16/11/2005 19:18 | Technology Experience
Comments have been closed on this topic.

Powered by:
Powered By Subtext Powered By ASP.NET