view src/win32/IdleTracker/idletrack.c @ 12116:e75ef7aa913e

[gaim-migrate @ 14416] " This patch implements a replacement for the queuing system from 1.x. It also obsoletes a previous patch [#1338873] I submitted to prioritize the unseen states in gtk conversations. The attached envelope.png is ripped from the msgunread.png already included in gaim. It should be dropped in the pixmaps directory (Makefile.am is updated accordingly in this patch). The two separate queuing preferences from 1.x, queuing messages while away and queuing all new messages (from docklet), are replaced with a single 3-way preference for conversations. The new preference is "Hide new IM conversations". This preference can be set to never, away and always. When a gtk conversation is created, it may be placed in a hidden conversation window instead of being placed normally. This decision is based upon the preference and possibly the away state of the account the conversation is being created for. This *will* effect conversations the user explicitly requests to be created, so in these cases the caller must be sure to present the conversation to the user, using gaim_gtkconv_present_conversation(). This is done already in gtkdialogs.c which handles creating conversations requested by the user from gaim proper (menus, double-clicking on budy in blist, etc.). The main advantage to not queuing messages is that the conversations exist, the message is written to the conversation (and logged if appropriate) and the unseen state is set on the conversation. This means no additional features are needed to track whether there are queued messages or not, just use the unseen state on conversations. Since conversations may not be visible (messages "queued"), gaim proper needs some notification that there are messages waiting. I opted for a menutray icon that shows up when an im conversation has an unseen message. Clicking this icon will focus (and show if hidden) the first conversation with an unseen message. This is essentially the same behavior of the docklet in cvs right now, except that the icon is only visible when there is a conversation with an unread message. The api that is added is flexible enough to allow either the docklet or the new blist menutray icon to be visible for conversations of any/all types and for unseen messages >= any state. Currently they are set to only IM conversations and only unseen states >= TEXT (system messages and no log messages will not trigger blinking the docklet or showing the blist tray icon), but these could be made preferences relatively easily in the future. Other plugins could probably benefit as well: gaim_gtk_conversations_get_first_unseen(). There is probably some limit to comment size, so I'll stop rambling now. If anyone has more questions/comments, catch me in #gaim, here or on gaim-devel." committer: Tailor Script <tailor@pidgin.im>
author Luke Schierer <lschiere@pidgin.im>
date Wed, 16 Nov 2005 18:17:01 +0000
parents 5c50be815a4e
children 099bb2149158
line wrap: on
line source

/*
 *  idletrack.c
 *
 *  Authors: mrgentry @ http://www.experts-exchange.com
 *           Herman Bloggs <hermanator12002@yahoo.com>
 *  Date: February, 2003
 *  Description: Track user inactivity.
 *
 *  Andrew Whewell <awhewell@users.sourceforge.net> - 25th June 2004. Added
 *  support for GetLastInputInfo under Windows 2000 and above. This avoids having
 *  IDLETRACK.DLL hook itself into every process on the machine, which makes
 *  upgrades easier. The hook mechanism is also used by key loggers, so not
 *  using hooks doesn't put the willys up programs that keep an eye out for
 *  loggers.
 *
 *  Windows 9x doesn't have GetLastInputInfo - when Gaim runs on these machines
 *  the code silently falls back onto the old hooking scheme.
 */
#define _WIN32_WINNT 0x0500
#include <windows.h>

#define EXPORT __declspec(dllexport)

static HANDLE hMapObject = NULL;
static DWORD *lastTime = NULL;
static HHOOK keyHook = NULL;
static HHOOK mouseHook = NULL;
static HINSTANCE g_hInstance = NULL;
static POINT g_point;

/* GetLastInputInfo address and module - if g_GetLastInputInfo == NULL then
 * we fall back on the old "hook the world" method. GetLastInputInfo was brought
 * in with Windows 2000 so Windows 9x will still hook everything.
 */
typedef BOOL (WINAPI *GETLASTINPUTINFO)(LASTINPUTINFO *);
static HMODULE g_user32 = NULL;
static GETLASTINPUTINFO g_GetLastInputInfo = NULL;

static DWORD* setup_shared_mem() {
	BOOL fInit;

	/* Set up the shared memory. */
	hMapObject = CreateFileMapping((HANDLE) 0xFFFFFFFF, /* use paging file        */
								   NULL,                /* no security attributes */
								   PAGE_READWRITE,      /* read/write access      */
								   0,                   /* size: high 32-bits     */
								   sizeof(DWORD),       /* size: low 32-bits      */
								   "timermem");         /* name of map object     */

	if (hMapObject == NULL)
		return NULL;

	/* The first process to attach initializes memory. */
	fInit = (GetLastError() != ERROR_ALREADY_EXISTS);

	/* Get a pointer to the file-mapped shared memory. */
	lastTime = (DWORD*) MapViewOfFile(hMapObject,     /* object to map view of    */
									  FILE_MAP_WRITE, /* read/write access        */
									  0,              /* high offset:  map from   */
									  0,              /* low offset:   beginning  */
									  0);             /* default: map entire file */

	if (lastTime == NULL)
		return NULL;

	*lastTime = GetTickCount();

	return lastTime;
}


LRESULT CALLBACK KeyboardProc(int code, WPARAM wParam, LPARAM lParam) {
	if (!(code < 0)) {
                if (lastTime == NULL)
                        lastTime = setup_shared_mem();

                if (lastTime)
                        *lastTime = GetTickCount();
        }
	return CallNextHookEx(keyHook, code, wParam, lParam);
}


LRESULT CALLBACK MouseProc(int code, WPARAM wParam, LPARAM lParam) {
	/* We need to verify that the Mouse pointer has actually moved. */
	if(!(code < 0) && 
           !((g_point.x == ((MOUSEHOOKSTRUCT*)lParam)->pt.x) &&
             (g_point.y == ((MOUSEHOOKSTRUCT*)lParam)->pt.y))) {
                g_point.x = ((MOUSEHOOKSTRUCT*)lParam)->pt.x;
                g_point.y = ((MOUSEHOOKSTRUCT*)lParam)->pt.y;

                if (lastTime == NULL)
                        lastTime = setup_shared_mem();

                if (lastTime)
                        *lastTime = GetTickCount();
	}
	return CallNextHookEx(mouseHook, code, wParam, lParam);
}


EXPORT DWORD wgaim_get_lastactive() {
        DWORD result = 0;

        /* If we have GetLastInputInfo then use it, otherwise use the hooks*/
        if (g_GetLastInputInfo != NULL) {
                LASTINPUTINFO lii;
                memset(&lii, 0, sizeof(lii));
                lii.cbSize = sizeof(lii);
                if (g_GetLastInputInfo(&lii)) {
                        result = lii.dwTime;
                }
        } else {
	        if (lastTime == NULL)
		        lastTime = setup_shared_mem();

	        if (lastTime)
		        result = *lastTime;
        }

	return result;
}


EXPORT BOOL wgaim_set_idlehooks() {
        /* Is GetLastInputInfo available?*/
        g_user32 = LoadLibrary("user32.dll");
        if (g_user32) {
                g_GetLastInputInfo = (GETLASTINPUTINFO)GetProcAddress(g_user32, "GetLastInputInfo");
        }

        /* If we couldn't find GetLastInputInfo then fall back onto the hooking scheme*/
        if (g_GetLastInputInfo == NULL) {
	        /* Set up the shared memory.*/
	        lastTime = setup_shared_mem();
	        if (lastTime == NULL)
		        return FALSE;
	        *lastTime = GetTickCount();

	        /* Set up the keyboard hook.*/
	        keyHook = SetWindowsHookEx(WH_KEYBOARD, KeyboardProc, g_hInstance, 0);
	        if (keyHook == NULL) {
		        UnmapViewOfFile(lastTime);
		        CloseHandle(hMapObject);
		        return FALSE;
	        }

	        /* Set up the mouse hook.*/
	        mouseHook = SetWindowsHookEx(WH_MOUSE, MouseProc, g_hInstance, 0);
	        if (mouseHook == NULL) {
		        UnhookWindowsHookEx(keyHook);
		        UnmapViewOfFile(lastTime);
		        CloseHandle(hMapObject);
		        return FALSE;
	        }
	}

	return TRUE;
}


EXPORT void wgaim_remove_idlehooks() {
        if (g_user32 != NULL)
                FreeLibrary(g_user32);
	if (keyHook)
		UnhookWindowsHookEx(keyHook);
	if (mouseHook)
		UnhookWindowsHookEx(mouseHook);
	if (lastTime)
		UnmapViewOfFile(lastTime);
	if (hMapObject)
		CloseHandle(hMapObject);
}

int WINAPI DllMain(HINSTANCE hInstance, DWORD dwReason, LPVOID lpReserved) {
	switch(dwReason) {
		case DLL_PROCESS_ATTACH:
			g_hInstance = hInstance;
			g_point.x = 0;
			g_point.y = 0;
			break;
		case DLL_PROCESS_DETACH:
			break;
	}
	return TRUE;
}