source: trunk/MFCtooling/userlog/userlog.cpp @ 60

Last change on this file since 60 was 60, checked in by jhall, 13 years ago

Extended WM_LBUTTONUP for calculating relativ Coordinates (to work with rule "LeftClickRelativ?")
File size: 15.2 KB
Line 
1#include "stdafx.h"
2#include "userlog.h"
3#include "windowsx.h"
4
5#include <map>
6#include <cstdio>
7
8#include "helpers.h"
9
10#ifdef __USING_MTRACE__
11#define OS_WIN32
12#include "msl/merror/inc/trace.h"
13
14#ifdef __ENCODE_BASE64__
15#include  "encode.h"
16#endif
17
18const static int traceLevel = 3;
19static int level;
20#endif
21
22#ifdef __USING_COSTUMLOG__
23static std::ofstream logfile;
24#endif
25
26#ifdef __TIMING__
27static unsigned long long timing = 0;
28static unsigned long long msgCounter = 0;
29static unsigned long long totalMsgCounter = 0;
30static bool msgCounterChange = false;
31#endif
32
33static MSG lastmsg;
34
35static bool keysPressed[256];
36
37inline bool keyAlreadyPressed(const MSG & msg) {
38        return (msg.message==WM_KEYDOWN || msg.message==WM_SYSKEYDOWN) && keysPressed[msg.wParam];
39}
40
41inline bool keyNotPressed(const MSG & msg) {
42        return (msg.message==WM_KEYUP || msg.message==WM_SYSKEYUP) && !keysPressed[msg.wParam];
43}
44
45
46HANDLE mutex;
47
48
49
50USERLOG_API void __cdecl InitUsagelog() {
51
52        mutex = CreateMutex(NULL, FALSE, TEXT("USAGELOGMUTEX"));
53        if( mutex == NULL ) {
54                MessageBox(0, L"MutexFailure", L"MutexFailure", 0);
55        }
56        for(int i=0; i<256; i++) {
57                keysPressed[i] = false;
58        }
59
60#ifdef __USING_COSTUMLOG__
61        InitLogfile();
62#endif
63        InitHookdata();
64        InitHooks();
65#ifdef __USING_MTRACE__
66        MTrace_AddToLevel(traceLevel,"%s<session>", LOGPREFIX);
67#endif
68#ifdef __USING_COSTUMLOG__
69        logfile << LOGPREFIX << "<session>" << std::endl;
70#endif
71}
72
73USERLOG_API void __cdecl ReleaseUsagelog() {
74        ReleaseHooks();
75#ifdef __USING_MTRACE__
76#ifdef __TIMING__
77        char * mtraceBuffer = new char[128];
78        sprintf(mtraceBuffer, "ul timing: %llu \t\t %llu \t\t %llu", timing, msgCounter, totalMsgCounter);
79        MTrace_AddToLevel(traceLevel,mtraceBuffer);
80        delete mtraceBuffer;
81        msgCounterChange = false;
82#endif
83        MTrace_AddToLevel(traceLevel,"%s</session>", LOGPREFIX);
84#endif
85#ifdef __USING_COSTUMLOG__
86        logfile << LOGPREFIX << "</session>" << std::endl;
87        CloseLogfile();
88#endif
89}
90
91#ifdef __USING_COSTUMLOG__
92void InitLogfile() {
93        logfile.open(LOGFILE, std::ios_base::app);
94        if( logfile.fail() ) {
95                MessageBox(0, L"Logfile could not be opend", L"Error", MB_OK);
96        }
97}
98#endif
99
100#ifdef __USING_COSTUMLOG__
101void CloseLogfile() {
102        logfile.close();
103}
104#endif
105
106void InitHookdata() {
107        myhookdata[CALLWNDHOOKID].nType = WH_CALLWNDPROC;
108        myhookdata[CALLWNDHOOKID].hkproc = CallWndProc;
109        myhookdata[GETMSGHOOKID].nType = WH_GETMESSAGE;
110        myhookdata[GETMSGHOOKID].hkproc = GetMsgProc;
111}
112
113void InitHooks() {
114        for( int i=0 ; i<NUMHOOKS ; i++ ) {
115                myhookdata[i].hookhandle = SetWindowsHookEx(myhookdata[i].nType, myhookdata[i].hkproc, (HINSTANCE) NULL, GetCurrentThreadId());
116                if( myhookdata[i].hookhandle!=NULL ) {
117                        myhookdata[i].active = true;
118                } else {
119                        myhookdata[i].active = false;
120                }
121        }
122}
123
124void ReleaseHooks() {
125        int counter = 0;
126        for( int i=0 ; i<NUMHOOKS ; i++ ) {
127                if( UnhookWindowsHookEx(myhookdata[i].hookhandle) ) counter++;
128        }
129}
130
131
132LRESULT CALLBACK CallWndProc(int nCode, WPARAM wParam, LPARAM lParam) {
133       
134        PCWPSTRUCT cwpMsg = (PCWPSTRUCT) lParam;
135        // Create a MSG struct from the cwpMsg struct
136        // The missing parameters are filled with dummy values
137        MSG msg;
138        msg.hwnd = cwpMsg->hwnd;
139        msg.message = cwpMsg->message;
140        msg.lParam = cwpMsg->lParam;
141        msg.wParam = cwpMsg->wParam;
142        msg.pt.x = -1;
143        msg.pt.y = -1;
144        msg.time = -1;
145        HookProc(CALLWNDHOOKID, nCode, &msg);
146
147        return CallNextHookEx(myhookdata[CALLWNDHOOKID].hookhandle, nCode, wParam, lParam);
148}
149
150LRESULT CALLBACK GetMsgProc(int nCode, WPARAM wParam, LPARAM lParam) {
151        PMSG msg = (PMSG) lParam;
152        HookProc(GETMSGHOOKID,nCode, msg);
153
154        return CallNextHookEx(myhookdata[GETMSGHOOKID].hookhandle, nCode, wParam, lParam);
155}
156
157void HookProc(int nFrom, int nCode, PMSG msg) {
158#ifdef __TIMING__
159        SYSTEMTIME systemTime;
160        GetSystemTime( &systemTime );
161        int startTime = systemTime.wMilliseconds+systemTime.wSecond*1000;
162#endif
163
164        DWORD waitResult;
165        // simple heuristic to eliminate duplicate messages
166        if( !( MessageEquals(*msg, lastmsg) || keyAlreadyPressed(*msg) || keyNotPressed(*msg) ) ) {
167                lastmsg = *msg;
168                if( msg->message==WM_KEYDOWN || msg->message==WM_SYSKEYDOWN ) {
169                        keysPressed[msg->wParam] = true;
170                }
171                if( msg->message==WM_KEYUP || msg->message==WM_SYSKEYUP ) {
172                        keysPressed[msg->wParam] = false;
173                }
174
175                // message filter:
176                // all messages that are defined in this switch statement will be part of the log
177                switch(msg->message) {
178                        // messages for monitoring GUI state
179                        case WM_CREATE:
180                        case WM_DESTROY:
181                        case WM_SETTEXT:
182
183                        // mouse messages
184                        case WM_LBUTTONDOWN:
185                        case WM_LBUTTONUP:
186                        case WM_LBUTTONDBLCLK:
187                        case WM_RBUTTONDOWN:
188                        case WM_RBUTTONUP:
189                        case WM_RBUTTONDBLCLK:
190                        case WM_MBUTTONDOWN:
191                        case WM_MBUTTONUP:
192                        case WM_MBUTTONDBLCLK:
193                        case WM_XBUTTONDOWN:
194                        case WM_XBUTTONUP:
195                        case WM_XBUTTONDBLCLK:
196                        case WM_NCLBUTTONDOWN:
197                        case WM_NCLBUTTONUP:
198                        case WM_NCLBUTTONDBLCLK:
199                        case WM_NCRBUTTONDOWN:
200                        case WM_NCRBUTTONUP:
201                        case WM_NCRBUTTONDBLCLK:
202                        case WM_NCMBUTTONDOWN:
203                        case WM_NCMBUTTONUP:
204                        case WM_NCMBUTTONDBLCLK:
205                        case WM_NCXBUTTONDOWN:
206                        case WM_NCXBUTTONUP:
207                        case WM_NCXBUTTONDBLCLK:
208
209                        // keyboard messages
210                        case WM_KEYDOWN:
211                        case WM_KEYUP:
212                        case WM_SYSKEYDOWN:
213                        case WM_SYSKEYUP:
214
215                        // internal messages usefull for replay/matching of events
216                        case WM_KILLFOCUS:
217                        case WM_SETFOCUS:
218                        case WM_COMMAND:
219                        case WM_SYSCOMMAND:
220                        case WM_HSCROLL:
221                        case WM_VSCROLL:
222                        case WM_MENUSELECT:
223                        case WM_USER:
224                                waitResult = WaitForSingleObject(mutex, 1000);
225                                if( waitResult==WAIT_OBJECT_0 ) {
226                                        WriteLogentryWString(msg, nFrom);
227                                        ReleaseMutex(mutex);
228                                }
229#ifdef __TIMING__
230                                msgCounter++;
231                                msgCounterChange = true;
232#endif // __TIMING__
233                                break;
234                        default:
235                                break;
236                }
237        }
238
239#ifdef __TIMING__
240        GetSystemTime( &systemTime );
241        timing += systemTime.wMilliseconds+systemTime.wSecond*1000-startTime;
242        totalMsgCounter++;
243        if( msgCounterChange && msgCounter%100==0 ) {
244#ifdef __USING_MTRACE__
245                char * mtraceBuffer = new char[128];
246                sprintf(mtraceBuffer, "ul timing: %llu \t\t %llu \t\t %llu", timing, msgCounter, totalMsgCounter);
247                MTrace_AddToLevel(traceLevel,mtraceBuffer);
248                delete mtraceBuffer;
249                msgCounterChange = false;
250#endif // __USING_MTRACE__
251        }
252#endif // __TIMING__
253}
254
255
256void WriteLogentryWString(PMSG msg, int nFrom) {
257        wchar_t * messageStr = NULL;
258        wchar_t buffer[128];
259        wchar_t * newWindowText = NULL;
260        wchar_t * windowName = NULL;
261        unsigned int command = 0;
262        int sourceType = -1;
263        HWND source = NULL;
264        HWND parentHandle = NULL;
265        wchar_t * windowClass = NULL;
266        bool isPopup = false;
267        bool isModal = false;
268        bool htMenu = false;
269        HWND menuHandle = NULL;
270        int scrollPos = -1;
271        unsigned int scrollType = 0;
272        HWND scrollBarHandle = NULL;
273        int retVal = 0;
274
275        // debug vars
276       
277        retVal = GetWindowText(msg->hwnd, buffer, 128);
278        if( retVal > 0  && retVal<MAXINT ) {
279                /*
280                 * In one case at the start of MarWin, when a resource with DlgId 1049 is created,
281                 * GetWindowText returns MAXINT. This behaviour is undocumented.
282                 */
283                replaceWithXmlEntitiesWString(buffer, &windowName, retVal+1);
284        }
285        int windowResourceId = GetDlgCtrlID(msg->hwnd);
286        if( windowResourceId<0 ) {
287                windowResourceId = 0;
288        }
289
290        //**************************************
291        // Message specific variables
292        //**************************************
293
294        if( msg->message==WM_COMMAND ) {
295                command = LOWORD(msg->wParam);
296                sourceType = HIWORD(msg->wParam);
297                source = (HWND) msg->lParam;
298        }
299        if( msg->message==WM_SYSCOMMAND ) {
300                command = LOWORD(msg->wParam);
301        }
302
303        if( msg->message==WM_CREATE ) {
304                parentHandle = GetParent(msg->hwnd);
305               
306                retVal = GetClassName(msg->hwnd, buffer, 128);
307                if( retVal > 0  && retVal<MAXINT ) {
308                        replaceWithXmlEntitiesWString(buffer, &windowClass, retVal+1);
309                }
310
311                // check is dialog is modal
312                // this check is not always accurate, but the best that I could come up with
313                isModal = IsWindowEnabled(parentHandle)==false;
314        }
315
316        if( msg->message==WM_SETTEXT ) {
317                wchar_t * newWindowTextBuffer = (wchar_t*)msg->lParam;
318                if( newWindowTextBuffer!=NULL ) {
319                        size_t len = wcslen(newWindowTextBuffer);
320                        replaceWithXmlEntitiesWString(newWindowTextBuffer, &newWindowText, len+1);
321                }
322        }
323
324        if( msg->message==WM_NCLBUTTONDOWN ) {
325                if( msg->wParam==HTMENU ) {
326                        htMenu = true;
327                }
328        }
329       
330        if( msg->message==WM_INITMENU ) {
331                menuHandle = (HWND) msg->wParam;
332        }
333
334        if( msg->message==WM_HSCROLL || msg->message==WM_VSCROLL ) {
335                scrollType = LOWORD(msg->wParam);
336                scrollPos = HIWORD(msg->wParam);
337                scrollBarHandle = (HWND) msg->lParam;
338        }
339
340        /***************************************/
341        // put debugging variables here
342        /***************************************/
343
344
345        /***************************************
346         * Printing part
347         ***************************************/
348       
349        size_t bufsize = 2048;
350        wchar_t * msgBuffer = new wchar_t[bufsize];
351        size_t pos = 0;
352        //pos += swprintf_s(msgBuffer+pos, bufsize-pos,LOGPREFIXWSTRING);
353
354       
355        // print msg information
356        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<msg type=\"%i\">",msg->message);
357        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"WPARAM\" value=\"%i\"/>", msg->wParam);
358        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"LPARAM\" value=\"%i\"/>", msg->lParam);
359
360        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"window.hwnd\" value=\"%i\"/>", msg->hwnd);
361        if( msg->message==WM_COMMAND ) {
362                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"command\" value=\"%i\"/>",command);
363                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"sourceType\" value=\"%i\"/>",sourceType);
364                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"source\" value=\"%i\"/>",source);
365        }
366        if( msg->message==WM_SYSCOMMAND ) {
367                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"command\" value=\"%i\"/>", command);
368        }
369
370        if( msg->message==WM_LBUTTONUP || msg->message==WM_RBUTTONUP || msg->message==WM_MBUTTONUP ||
371                msg->message==WM_LBUTTONDOWN || msg->message==WM_RBUTTONDOWN || msg->message==WM_MBUTTONDOWN ||
372                msg->message==WM_LBUTTONDBLCLK || msg->message==WM_RBUTTONDBLCLK || msg->message==WM_MBUTTONDBLCLK) {
373               
374                //if( msg->time>-1 )
375                //{
376                        if(msg->message == WM_LBUTTONUP)
377                        {
378                                RECT r;
379                                DWORD dCursorPos = GetMessagePos();
380                                GetWindowRect(msg->hwnd, &r);
381
382                                //dont log absolut coordinates but relativ ones so you can use them in rule "LeftClickRelativ"
383                                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"point.x\" value=\"%i\"/>", GET_X_LPARAM(dCursorPos)-r.left);
384                                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"point.y\" value=\"%i\"/>", GET_Y_LPARAM(dCursorPos)-r.top);
385
386
387                                //check the listBox selection, store it in "scrollPos"
388                                //no selection = -1
389                                //this is only working for listBoxes with style 'selection = single'
390                                retVal = GetClassName(msg->hwnd, buffer, 128);
391                                if( retVal >= -1  && retVal < MAXINT && !lstrcmpi(buffer, L"ListBox") )
392                                {
393                                        scrollPos = (int)SendMessage(msg->hwnd, LB_GETCURSEL, 0, 0);
394                                        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"scrollPos\" value=\"%i\"/>", scrollPos);
395                                }
396
397
398                                //check the TabControl selection, store it in "scrollPos"
399                                //no selection = -1
400                                retVal = GetClassName(msg->hwnd, buffer, 128);
401                                if( retVal >= -1  && retVal < MAXINT && !lstrcmpi(buffer, L"SysTabControl32") )
402                                {
403                                        scrollPos = (int)SendMessage(msg->hwnd, (UINT)4875, 0, 0);
404                                        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"scrollPos\" value=\"%i\"/>", scrollPos);
405                                }
406                        }
407                //}
408        }
409        if( msg->message==WM_MOUSEACTIVATE ) {
410                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"toplevelwindow.hwnd\" value=\"%i\"/>", (HWND) msg->wParam);
411        }
412        if( msg->message==WM_KEYUP || msg->message==WM_KEYDOWN || msg->message==WM_SYSKEYUP || msg->message==WM_SYSKEYDOWN ) {
413                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"key\" value=\"%i\"/>", LOWORD(msg->wParam));
414        }
415        if( msg->message==WM_SETTEXT ) {
416                if( newWindowText!=NULL ) {
417                        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"window.newText\" value=\"%s\"/>", newWindowText);
418                }
419        }
420       
421        if( msg->message==WM_NCLBUTTONDOWN && htMenu ) {
422                pos += swprintf_s(msgBuffer+pos, bufsize-pos,L"<param name=\"isMenu\" value=\"true\"/>");
423        }
424
425        if( msg->message==WM_INITMENU ) {
426                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"menu.hwnd\" value=\"%i\"/>", menuHandle);
427        }
428
429        if( msg->message==WM_CREATE ) {
430                // print window information
431                if( windowName!=NULL ) {
432                        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"window.name\" value=\"%s\"/>", windowName);
433                }
434                if( windowResourceId>0 ) {
435                        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"window.resourceId\" value=\"%i\"/>", windowResourceId);
436                }
437                if( msg->message==WM_CREATE ) {
438                        if( parentHandle!=NULL ) {
439                                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"window.parent.hwnd\" value=\"%i\"/>", parentHandle);
440                        }
441                        if( windowClass!=NULL ) {
442                                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"window.class\" value=\"%s\"/>", windowClass);
443                        }
444                        if( isModal ) {
445                                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"window.ismodal\" value=\"true\"/>");
446                        }
447
448                }
449        }
450        if( msg->message==WM_HSCROLL || msg->message==WM_VSCROLL ) {
451                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"scrollType\" value=\"%i\"/>", scrollType);
452                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"scrollPos\" value=\"%i\"/>", scrollPos);
453                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"scrollBarHandle\" value=\"%i\"/>", scrollBarHandle);
454        }
455
456        if( msg->time!=-1 ) {
457                pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"time\" value=\"%i\"/>", msg->time);
458        }
459       
460        /***************************************/
461        // put debugging and experimental output stuff here
462        /***************************************/
463
464#ifdef __INCLUDEHOOKINFO__
465        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"<param name=\"hook\" value=\"%i\"/>", nFrom);
466#endif
467       
468
469        pos += swprintf_s(msgBuffer+pos,bufsize-pos,L"</msg>", msg->hwnd);
470#ifdef __USING_MTRACE__
471#ifdef __ENCODE_BASE64__
472        size_t arraySize = (pos+1)*2;
473        size_t encodingSize = arraySize*2;
474        char * base64Buffer = new char[encodingSize];
475
476        base64::encoder enc;
477        retVal = enc.encode((char*)msgBuffer, arraySize, base64Buffer);
478        base64Buffer[retVal] = '\0';
479
480        char * mtraceBuffer = new char[retVal+30];
481        sprintf_s(mtraceBuffer,retVal+29,"%s%s", LOGPREFIX, base64Buffer);
482        delete base64Buffer;
483#else
484        char * mtraceBuffer = new char[pos+1];
485        size_t numConverted;
486        wcstombs_s(&numConverted,mtraceBuffer, pos+1, msgBuffer, pos);
487#endif // __ENCODE_BASE64__
488        MTrace_AddToLevel(traceLevel,mtraceBuffer);
489        delete mtraceBuffer;
490#endif // __USING_MTRACE__
491#ifdef __USING_COSTUMLOG__
492        SYSTEMTIME currentTime;
493        GetSystemTime(&currentTime);
494        logfile << currentTime.wDay << "." << currentTime.wMonth << "." << currentTime.wYear << " ";
495        logfile << currentTime.wHour << ":" << currentTime.wMinute << ":" << currentTime.wSecond << ":";
496        logfile << currentTime.wMilliseconds << "\t";
497        logfile << buffer << std::endl;
498#endif
499        delete messageStr;
500        delete newWindowText;
501        delete windowName;
502        delete windowClass;
503        delete msgBuffer;
504}
Note: See TracBrowser for help on using the repository browser.