1 const char w32log_rcs[] = "$Id: w32log.c,v 1.34 2009/05/16 13:27:20 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/w32log.c,v $
6 * Purpose : Functions for creating and destroying the log window,
7 * ouputting strings, processing messages and so on.
9 * Copyright : Written by and Copyright (C) 2001-2009 members of
10 * the Privoxy team. http://www.privoxy.org/
12 * Written by and Copyright (C) 1999 Adam Lock
15 * This program is free software; you can redistribute it
16 * and/or modify it under the terms of the GNU General
17 * Public License as published by the Free Software
18 * Foundation; either version 2 of the License, or (at
19 * your option) any later version.
21 * This program is distributed in the hope that it will
22 * be useful, but WITHOUT ANY WARRANTY; without even the
23 * implied warranty of MERCHANTABILITY or FITNESS FOR A
24 * PARTICULAR PURPOSE. See the GNU General Public
25 * License for more details.
27 * The GNU General Public License should be included with
28 * this file. If not, you can view it at
29 * http://www.gnu.org/copyleft/gpl.html
30 * or write to the Free Software Foundation, Inc., 59
31 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 *********************************************************************/
49 #include "w32taskbar.h"
57 const char w32res_h_rcs[] = W32RES_H_VERSION;
61 const char cygwin_h_rcs[] = CYGWIN_H_VERSION;
64 const char w32log_h_rcs[] = W32LOG_H_VERSION;
66 #ifndef _WIN_CONSOLE /* entire file */
69 * Timers and the various durations
71 #define TIMER_ANIM_ID 1
72 #define TIMER_ANIM_TIME 100
73 #define TIMER_ANIMSTOP_ID 2
74 #define TIMER_ANIMSTOP_TIME 1000
75 #define TIMER_CLIPBUFFER_ID 3
76 #define TIMER_CLIPBUFFER_TIME 1000
77 #define TIMER_CLIPBUFFER_FORCE_ID 4
78 #define TIMER_CLIPBUFFER_FORCE_TIME 5000
81 * Styles of text that can be output
84 #define STYLE_HIGHLIGHT 1
86 #define STYLE_HEADER 3
89 * Number of frames of animation in tray activity sequence
93 #define DEFAULT_MAX_BUFFER_LINES 200
94 #define DEFAULT_LOG_FONT_NAME "MS Sans Serif"
95 #define DEFAULT_LOG_FONT_SIZE 8
98 * These values affect the way the log window behaves, they should be read
99 * from a file but for the moment, they are hardcoded here. Some options are
100 * configurable through the UI.
103 /* Indicates whether task bar shows activity animation */
104 BOOL g_bShowActivityAnimation = 1;
106 /* Indicates whether the log window is shown */
107 BOOL g_bShowLogWindow = 1;
109 /* Indicates if the log window appears on the task bar */
110 BOOL g_bShowOnTaskBar = 0;
112 /* Indicates whether closing the log window really just hides it */
113 BOOL g_bCloseHidesWindow = 1;
115 /* Indicates if messages are logged at all */
116 BOOL g_bLogMessages = 1;
118 /* Indicates whether log messages are highlighted */
119 BOOL g_bHighlightMessages = 1;
121 /* Indicates if buffer is limited in size */
122 BOOL g_bLimitBufferSize = 1;
124 /* Maximum number of lines allowed in buffer when limited */
125 int g_nMaxBufferLines = DEFAULT_MAX_BUFFER_LINES;
128 char g_szFontFaceName[32] = DEFAULT_LOG_FONT_NAME;
130 /* Size of font to use */
131 int g_nFontSize = DEFAULT_LOG_FONT_SIZE;
134 /* FIXME: this is a kludge */
136 const char * g_default_actions_file = NULL;
137 const char * g_user_actions_file = NULL;
138 const char * g_re_filterfile = NULL;
140 const char * g_trustfile = NULL;
141 #endif /* def FEATURE_TRUST */
143 /* FIXME: end kludge */
145 /* Regular expression for detected URLs */
146 #define RE_URL "http:[^ \n\r]*"
149 * Regular expressions that are used to perform highlight in the log window
151 static struct _Pattern
156 } patterns_to_highlight[] =
159 { RE_URL, STYLE_LINK },
160 /* { "[a-zA-Z0-9]+\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+\\.[^ \n\r]*", STYLE_LINK }, */
161 /* interesting text to highlight */
162 /* see jcc.c crunch_reason for the full list */
163 { "Crunch: Blocked:", STYLE_HIGHLIGHT },
164 { "Crunch: Untrusted", STYLE_HIGHLIGHT },
165 { "Crunch: Redirected:", STYLE_HIGHLIGHT },
166 { "Crunch: DNS failure", STYLE_HIGHLIGHT },
167 { "Crunch: Forwarding failed", STYLE_HIGHLIGHT },
168 { "Crunch: Connection failure", STYLE_HIGHLIGHT },
169 { "Crunch: Out of memory", STYLE_HIGHLIGHT },
170 { "Connect: Found reusable socket", STYLE_HIGHLIGHT },
171 { "Connect: Created new connection to", STYLE_HIGHLIGHT },
172 /* what are all the possible error strings?? */
173 { "Error:", STYLE_HIGHLIGHT },
175 { "referer:", STYLE_HEADER },
176 { "proxy-connection:", STYLE_HEADER },
177 { "proxy-agent:", STYLE_HEADER },
178 { "user-agent:", STYLE_HEADER },
179 { "host:", STYLE_HEADER },
180 { "accept:", STYLE_HEADER },
181 { "accept-encoding:", STYLE_HEADER },
182 { "accept-language:", STYLE_HEADER },
183 { "accept-charset:", STYLE_HEADER },
184 { "accept-ranges:", STYLE_HEADER },
185 { "date:", STYLE_HEADER },
186 { "cache-control:", STYLE_HEADER },
187 { "cache-last-checked:", STYLE_HEADER },
188 { "connection:", STYLE_HEADER },
189 { "content-type", STYLE_HEADER },
190 { "content-length", STYLE_HEADER },
191 { "cookie", STYLE_HEADER },
192 { "last-modified:", STYLE_HEADER },
193 { "pragma:", STYLE_HEADER },
194 { "server:", STYLE_HEADER },
195 { "etag:", STYLE_HEADER },
196 { "expires:", STYLE_HEADER },
197 { "warning:", STYLE_HEADER },
198 /* this is the terminator statement - do not delete! */
211 static CRITICAL_SECTION g_criticalsection;
212 static HWND g_hwndTray;
213 static HWND g_hwndLogBox;
214 static WNDPROC g_fnLogBox;
215 static HICON g_hiconAnim[ANIM_FRAMES];
216 static HICON g_hiconIdle;
217 static HICON g_hiconOff;
218 static int g_nAnimFrame;
219 static BOOL g_bClipPending = FALSE;
220 static int g_nRichEditVersion = 0;
225 static HWND CreateLogWindow(HINSTANCE hInstance, int nCmdShow);
226 static HWND CreateHiddenLogOwnerWindow(HINSTANCE hInstance);
227 static LRESULT CALLBACK LogWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
228 static LRESULT CALLBACK LogOwnerWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
229 static LRESULT CALLBACK LogRichEditProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
230 static BOOL InitRichEdit(void);
231 static void LogClipBuffer(void);
232 static void LogCreatePatternMatchingBuffers(void);
233 static void LogDestroyPatternMatchingBuffers(void);
234 static int LogPutStringNoMatch(const char *pszText, int style);
235 static void SetIdleIcon(void);
238 /*********************************************************************
240 * Function : InitLogWindow
242 * Description : Initialise the log window.
246 * Returns : Always TRUE (there should be error checking on the resources).
248 *********************************************************************/
249 BOOL InitLogWindow(void)
254 g_hiconIdle = LoadIcon(g_hInstance, MAKEINTRESOURCE(IDI_IDLE));
255 g_hiconOff = LoadIcon(g_hInstance, MAKEINTRESOURCE(IDI_OFF));
256 for (i = 0; i < ANIM_FRAMES; i++)
258 g_hiconAnim[i] = LoadIcon(g_hInstance, MAKEINTRESOURCE(IDI_ANIMATED1 + i));
260 g_hiconApp = LoadIcon(g_hInstance, MAKEINTRESOURCE(IDI_MAINICON));
262 /* Create the user interface */
263 g_hwndLogFrame = CreateLogWindow(g_hInstance, g_nCmdShow);
264 g_hwndTray = CreateTrayWindow(g_hInstance);
265 TrayAddIcon(g_hwndTray, 1, g_hiconApp, "Privoxy");
267 /* Create pattern matching buffers (for highlighting */
268 LogCreatePatternMatchingBuffers();
270 /* Create a critical section to protect multi-threaded access to certain things */
271 InitializeCriticalSection(&g_criticalsection);
278 /*********************************************************************
280 * Function : TermLogWindow
282 * Description : Cleanup the logwindow.
288 *********************************************************************/
289 void TermLogWindow(void)
293 LogDestroyPatternMatchingBuffers();
295 TrayDeleteIcon(g_hwndTray, 1);
296 DeleteObject(g_hiconApp);
297 DeleteObject(g_hiconIdle);
298 DeleteObject(g_hiconOff);
299 for (i = 0; i < ANIM_FRAMES; i++)
301 DeleteObject(g_hiconAnim[i]);
307 /*********************************************************************
309 * Function : LogCreatePatternMatchingBuffers
311 * Description : Compile the pattern matching buffers.
317 *********************************************************************/
318 void LogCreatePatternMatchingBuffers(void)
321 for (i = 0; patterns_to_highlight[i].str != NULL; i++)
323 regcomp(&patterns_to_highlight[i].buffer, patterns_to_highlight[i].str, REG_ICASE);
328 /*********************************************************************
330 * Function : LogDestroyPatternMatchingBuffers
332 * Description : Free up the pattern matching buffers.
338 *********************************************************************/
339 void LogDestroyPatternMatchingBuffers(void)
342 for (i = 0; patterns_to_highlight[i].str != NULL; i++)
344 regfree(&patterns_to_highlight[i].buffer);
349 /*********************************************************************
351 * Function : LogGetURLUnderCursor
353 * Description : Returns the URL from under the cursor (remember to free it!).
357 * Returns : NULL or a pointer to an URL string.
359 *********************************************************************/
360 char *LogGetURLUnderCursor(void)
362 char *szResult = NULL;
367 DWORD nWordStart = 0;
370 regcomp(&re, RE_URL, REG_ICASE);
372 /* Get the position of the cursor over the text window */
373 GetCursorPos(&ptCursor);
374 ScreenToClient(g_hwndLogBox, &ptCursor);
378 /* Search backwards and fowards to obtain the word that is highlighted */
379 nPos = LOWORD(SendMessage(g_hwndLogBox, EM_CHARFROMPOS, 0, (LPARAM) &ptl));
380 nWordStart = SendMessage(g_hwndLogBox, EM_FINDWORDBREAK, WB_LEFT, nPos);
381 nWordEnd = SendMessage(g_hwndLogBox, EM_FINDWORDBREAK, WB_RIGHTBREAK, nPos);
383 /* Compare the string to the pattern */
384 if (nWordEnd > nWordStart)
389 range.chrg.cpMin = nWordStart;
390 range.chrg.cpMax = nWordEnd;
391 range.lpstrText = (LPSTR)zalloc(nWordEnd - nWordStart + 1);
392 SendMessage(g_hwndLogBox, EM_GETTEXTRANGE, 0, (LPARAM) &range);
394 if (regexec(&re, range.lpstrText, 1, &match, 0) == 0)
396 szResult = range.lpstrText;
400 free(range.lpstrText);
410 /*********************************************************************
412 * Function : LogPutString
414 * Description : Inserts text into the logging window. This is really
415 * a regexp aware wrapper function to `LogPutStringNoMatch'.
418 * 1 : pszText = pointer to string going to the log window
420 * Returns : 1 => success, else the return code from `LogPutStringNoMatch'.
421 * FIXME: this is backwards to the rest of IJB and to common
422 * programming practice. Please use 0 => success instead.
424 *********************************************************************/
425 int LogPutString(const char *pszText)
430 if (pszText == NULL || strlen(pszText) == 0)
440 /* Critical section stops multiple threads doing nasty interactions that
441 * foul up the highlighting and output.
443 EnterCriticalSection(&g_criticalsection);
445 if (g_bHighlightMessages)
449 /* First things first, regexp scan for various things that we would like highlighted */
450 for (i = 0; patterns_to_highlight[i].str != NULL; i++)
452 if (regexec(&patterns_to_highlight[i].buffer, pszText, 1, &match, 0) == 0)
454 char *pszBefore = NULL;
455 char *pszMatch = NULL;
456 char *pszAfter = NULL;
459 /* Split the string up into pieces representing the strings, before
460 at and after the matching pattern
464 pszBefore = (char *)malloc((match.rm_so + 1) * sizeof(char));
465 memset(pszBefore, 0, (match.rm_so + 1) * sizeof(char));
466 strncpy(pszBefore, pszText, match.rm_so);
468 if (match.rm_eo < (regoff_t)strlen(pszText))
470 pszAfter = strdup(&pszText[match.rm_eo]);
472 nMatchSize = match.rm_eo - match.rm_so;
473 pszMatch = (char *)malloc(nMatchSize + 1);
474 strncpy(pszMatch, &pszText[match.rm_so], nMatchSize);
475 pszMatch[nMatchSize] = '\0';
477 /* Recursively call LogPutString */
480 LogPutString(pszBefore);
485 LogPutStringNoMatch(pszMatch, patterns_to_highlight[i].style);
490 LogPutString(pszAfter);
500 result = LogPutStringNoMatch(pszText, STYLE_NONE);
503 LeaveCriticalSection(&g_criticalsection);
510 /*********************************************************************
512 * Function : LogPutStringNoMatch
514 * Description : Puts a string into the logging window.
517 * 1 : pszText = pointer to string going to the log window
518 * 2 : style = STYLE_NONE, STYLE_HEADER, STYLE_HIGHLIGHT, or STYLE_LINK
520 * Returns : Always 1 => success.
521 * FIXME: this is backwards to the rest of IJB and to common
522 * programming practice. Please use 0 => success instead.
524 *********************************************************************/
525 int LogPutStringNoMatch(const char *pszText, int style)
531 assert(g_hwndLogBox);
532 if (g_hwndLogBox == NULL)
537 /* TODO preserve existing selection */
539 /* Go to the end of the text */
540 nTextLength = GetWindowTextLength(g_hwndLogBox);
541 range.cpMin = nTextLength;
542 range.cpMax = nTextLength;
543 SendMessage(g_hwndLogBox, EM_EXSETSEL, 0, (LPARAM) &range);
545 /* Apply a formatting style */
546 memset(&format, 0, sizeof(format));
547 format.cbSize = sizeof(format);
548 format.dwMask = CFM_BOLD | CFM_UNDERLINE | CFM_STRIKEOUT |
549 CFM_ITALIC | CFM_COLOR | CFM_FACE | CFM_SIZE | CFM_CHARSET;
550 format.bCharSet = DEFAULT_CHARSET;
551 format.yHeight = (g_nFontSize * 1440) / 72;
552 strlcpy(format.szFaceName, g_szFontFaceName, sizeof(format.szFaceName));
553 if (style == STYLE_NONE)
556 format.dwEffects |= CFE_AUTOCOLOR;
558 else if (style == STYLE_HEADER)
560 format.dwEffects |= CFE_AUTOCOLOR | CFE_ITALIC;
562 else if (style == STYLE_HIGHLIGHT)
564 format.dwEffects |= CFE_AUTOCOLOR | CFE_BOLD;
566 else if (style == STYLE_LINK)
568 format.dwEffects |= CFE_UNDERLINE;
569 format.crTextColor = RGB(0, 0, 255);
571 SendMessage(g_hwndLogBox, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM) &format);
573 /* Append text to the end */
574 SendMessage(g_hwndLogBox, EM_REPLACESEL, FALSE, (LPARAM) pszText);
576 /* TODO Restore the old selection */
579 if (strchr(pszText, '\n') != NULL)
581 SetTimer(g_hwndLogFrame, TIMER_CLIPBUFFER_ID, TIMER_CLIPBUFFER_TIME, NULL);
584 /* Set the force clip timer going. This timer ensures clipping is done
585 intermittently even when there is a sustained burst of logging
587 SetTimer(g_hwndLogFrame, TIMER_CLIPBUFFER_FORCE_ID, TIMER_CLIPBUFFER_FORCE_TIME, NULL);
589 g_bClipPending = TRUE;
597 /*********************************************************************
599 * Function : LogShowActivity
601 * Description : Start the spinner.
607 *********************************************************************/
608 void LogShowActivity(void)
610 /* Start some activity timers */
611 if (g_bShowActivityAnimation)
613 SetTimer(g_hwndLogFrame, TIMER_ANIM_ID, TIMER_ANIM_TIME, NULL);
614 SetTimer(g_hwndLogFrame, TIMER_ANIMSTOP_ID, TIMER_ANIMSTOP_TIME, NULL);
620 /*********************************************************************
622 * Function : LogClipBuffer
624 * Description : Prunes old lines from the log.
630 *********************************************************************/
631 void LogClipBuffer(void)
633 int nLines = SendMessage(g_hwndLogBox, EM_GETLINECOUNT, 0, 0);
634 if (g_bLimitBufferSize && nLines > g_nMaxBufferLines)
636 /* Compute the range representing the lines to be deleted */
637 LONG nLastLineToDelete = nLines - g_nMaxBufferLines;
638 LONG nLastChar = SendMessage(g_hwndLogBox, EM_LINEINDEX, nLastLineToDelete, 0);
641 range.cpMax = nLastChar;
643 /* TODO get current selection */
645 /* TODO adjust and clip old selection against range to be deleted */
647 /* Select range and erase it (turning off autoscroll to prevent
649 SendMessage(g_hwndLogBox, EM_SETOPTIONS, ECOOP_XOR, ECO_AUTOVSCROLL);
650 SendMessage(g_hwndLogBox, EM_EXSETSEL, 0, (LPARAM) &range);
651 SendMessage(g_hwndLogBox, EM_REPLACESEL, FALSE, (LPARAM) "");
652 SendMessage(g_hwndLogBox, EM_SETOPTIONS, ECOOP_XOR, ECO_AUTOVSCROLL);
654 /* reposition (back to) the end of the log content */
655 range.cpMin = SendMessage (g_hwndLogBox, WM_GETTEXTLENGTH, 0, 0);
657 SendMessage(g_hwndLogBox, EM_EXSETSEL, 0, (LPARAM) &range);
659 /* restore vertical ScrollBar stuff (messed up by AUTOVSCROLL) */
660 SendMessage (g_hwndLogBox, EM_SCROLL, SB_LINEDOWN, 0);
667 /*********************************************************************
669 * Function : CreateHiddenLogOwnerWindow
671 * Description : Creates a hidden owner window that stops the log
672 * window appearing in the task bar.
675 * 1 : hInstance = application's instance handle
677 * Returns : Handle to newly created window.
679 *********************************************************************/
680 HWND CreateHiddenLogOwnerWindow(HINSTANCE hInstance)
682 static const char *szWndName = "PrivoxyLogOwner";
687 wc.lpfnWndProc = LogOwnerWindowProc;
690 wc.hInstance = hInstance;
691 wc.hIcon = g_hiconApp;
693 wc.hbrBackground = 0;
695 wc.lpszClassName = szWndName;
699 hwnd = CreateWindow(szWndName, szWndName,
700 WS_OVERLAPPEDWINDOW, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT,
701 CW_USEDEFAULT, NULL, NULL, hInstance, NULL );
708 /*********************************************************************
710 * Function : LogOwnerWindowProc
712 * Description : Dummy procedure that does nothing special.
715 * 1 : hwnd = window handle
716 * 2 : uMsg = message number
717 * 3 : wParam = first param for this message
718 * 4 : lParam = next param for this message
720 * Returns : Same as `DefWindowProc'.
722 *********************************************************************/
723 LRESULT CALLBACK LogOwnerWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
725 return DefWindowProc(hwnd, uMsg, wParam, lParam);
730 /*********************************************************************
732 * Function : CreateLogWindow
734 * Description : Create the logging window.
737 * 1 : hInstance = application's instance handle
738 * 2 : nCmdShow = window show value (MIN, MAX, NORMAL, etc...)
740 * Returns : Handle to newly created window.
742 *********************************************************************/
743 HWND CreateLogWindow(HINSTANCE hInstance, int nCmdShow)
745 static const char *szWndName = "PrivoxyLogWindow";
746 static const char *szWndTitle = "Privoxy";
749 HWND hwndOwner = (g_bShowOnTaskBar) ? NULL : CreateHiddenLogOwnerWindow(hInstance);
753 memset(&wc, 0, sizeof(wc));
754 wc.cbSize = sizeof(wc);
755 wc.style = CS_DBLCLKS;
756 wc.lpfnWndProc = LogWindowProc;
759 wc.hInstance = hInstance;
760 wc.hIcon = g_hiconApp;
762 wc.hbrBackground = 0;
763 wc.lpszMenuName = MAKEINTRESOURCE(IDR_LOGVIEW);
764 wc.lpszClassName = szWndName;
765 wc.hbrBackground = GetStockObject(WHITE_BRUSH);
766 RegisterClassEx(&wc);
768 hwnd = CreateWindowEx(WS_EX_APPWINDOW, szWndName, szWndTitle,
769 WS_OVERLAPPEDWINDOW, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT,
770 CW_USEDEFAULT, hwndOwner, NULL, hInstance, NULL);
772 /* Now create a child list box */
773 GetClientRect(hwnd, &rcClient);
775 /* Create a rich edit control */
777 g_hwndLogBox = CreateWindowEx(0, (g_nRichEditVersion == 0x0100) ? "RichEdit" : RICHEDIT_CLASS, "",
778 ES_AUTOVSCROLL | ES_MULTILINE | ES_READONLY | ES_NOHIDESEL | WS_CHILD | WS_VSCROLL | WS_HSCROLL | WS_VISIBLE,
779 rcClient.left, rcClient.top, rcClient.right, rcClient.bottom,
780 hwnd, NULL, hInstance, NULL);
781 /* SendMessage(g_hwndLogBox, EM_SETWORDWRAPMODE, 0, 0); */
783 /* Subclass the control to catch certain messages */
784 g_fnLogBox = (WNDPROC) GetWindowLong(g_hwndLogBox, GWL_WNDPROC);
785 SetWindowLong(g_hwndLogBox, GWL_WNDPROC, (LONG) LogRichEditProc);
787 /* Minimizing looks stupid when the log window is not on the task bar, so hide instead */
788 if (!g_bShowOnTaskBar &&
789 (nCmdShow == SW_SHOWMINIMIZED ||
790 nCmdShow == SW_MINIMIZE ||
791 nCmdShow == SW_SHOWMINNOACTIVE))
793 g_bShowLogWindow = FALSE;
797 ShowWindow(hwnd, nCmdShow);
801 GetClientRect(g_hwndLogFrame, &rcClient);
802 SetWindowPos(g_hwndLogBox, NULL, rcClient.left, rcClient.top, rcClient.right - rcClient.left, rcClient.bottom - rcClient.top, SWP_NOZORDER);
809 /*********************************************************************
811 * Function : InitRichEdit
813 * Description : Initialise the rich edit control library.
817 * Returns : TRUE => success, FALSE => failure.
818 * FIXME: this is backwards to the rest of IJB and to common
819 * programming practice. Please use 0 => success instead.
821 *********************************************************************/
822 BOOL InitRichEdit(void)
824 static HINSTANCE hInstRichEdit;
825 if (hInstRichEdit == NULL)
827 g_nRichEditVersion = 0;
828 hInstRichEdit = LoadLibraryA("RICHED20.DLL");
831 g_nRichEditVersion = _RICHEDIT_VER;
835 hInstRichEdit = LoadLibraryA("RICHED32.DLL");
838 g_nRichEditVersion = 0x0100;
842 return (hInstRichEdit != NULL) ? TRUE : FALSE;
847 /*********************************************************************
849 * Function : ShowLogWindow
851 * Description : Shows or hides the log window. We will also raise the
852 * window on a show command in case it is buried.
855 * 1 : bShow = TRUE to show, FALSE to mimize/hide
859 *********************************************************************/
860 void ShowLogWindow(BOOL bShow)
864 SetForegroundWindow(g_hwndLogFrame);
865 SetWindowPos(g_hwndLogFrame, HWND_TOP, 0, 0, 0, 0, SWP_SHOWWINDOW | SWP_NOSIZE | SWP_NOMOVE);
868 else if (g_bShowOnTaskBar)
870 ShowWindow(g_hwndLogFrame, SW_MINIMIZE);
874 ShowWindow(g_hwndLogFrame, SW_HIDE);
879 /*********************************************************************
881 * Function : EditFile
883 * Description : Opens the specified setting file for editing.
884 * FIXME: What if the file has no associated application. Check for return values
885 * from ShellExecute??
888 * 1 : filename = filename from the config (aka config.txt) file.
892 *********************************************************************/
893 void EditFile(const char *filename)
897 ShellExecute(g_hwndLogFrame, "open", filename, NULL, NULL, SW_SHOWNORMAL);
903 /*--------------------------------------------------------------------------*/
904 /* Windows message handlers */
905 /*--------------------------------------------------------------------------*/
908 /*********************************************************************
910 * Function : OnLogRButtonUp
912 * Description : Handler for WM_RBUTTONUP messages.
915 * 1 : nModifier = wParam from mouse message (unused)
916 * 2 : x = x coordinate of the mouse event
917 * 3 : y = y coordinate of the mouse event
921 *********************************************************************/
922 void OnLogRButtonUp(int nModifier, int x, int y)
924 HMENU hMenu = LoadMenu(g_hInstance, MAKEINTRESOURCE(IDR_POPUP_SELECTION));
927 HMENU hMenuPopup = GetSubMenu(hMenu, 0);
929 /* Check if there is a selection */
931 SendMessage(g_hwndLogBox, EM_EXGETSEL, 0, (LPARAM) &range);
932 if (range.cpMin == range.cpMax)
934 EnableMenuItem(hMenuPopup, ID_EDIT_COPY, MF_BYCOMMAND | MF_GRAYED);
938 EnableMenuItem(hMenuPopup, ID_EDIT_COPY, MF_BYCOMMAND | MF_ENABLED);
941 /* Display the popup */
942 TrackPopupMenu(hMenuPopup, TPM_LEFTALIGN | TPM_TOPALIGN | TPM_RIGHTBUTTON, x, y, 0, g_hwndLogFrame, NULL);
949 /*********************************************************************
951 * Function : OnLogCommand
953 * Description : Handler for WM_COMMAND messages.
956 * 1 : nCommand = the command portion of the menu selection event
960 *********************************************************************/
961 void OnLogCommand(int nCommand)
965 case ID_TOGGLE_SHOWWINDOW:
966 g_bShowLogWindow = !g_bShowLogWindow;
968 ShowLogWindow(g_bShowLogWindow);
972 PostMessage(g_hwndLogFrame, WM_CLOSE, 0, 0);
976 SendMessage(g_hwndLogBox, WM_COPY, 0, 0);
979 case ID_VIEW_CLEARLOG:
980 SendMessage(g_hwndLogBox, WM_SETTEXT, 0, (LPARAM) "");
983 case ID_VIEW_LOGMESSAGES:
984 g_bLogMessages = !g_bLogMessages;
985 /* SaveLogSettings(); */
988 case ID_VIEW_MESSAGEHIGHLIGHTING:
989 g_bHighlightMessages = !g_bHighlightMessages;
990 /* SaveLogSettings(); */
993 case ID_VIEW_LIMITBUFFERSIZE:
994 g_bLimitBufferSize = !g_bLimitBufferSize;
995 /* SaveLogSettings(); */
998 case ID_VIEW_ACTIVITYANIMATION:
999 g_bShowActivityAnimation = !g_bShowActivityAnimation;
1000 /* SaveLogSettings(); */
1003 #ifdef FEATURE_TOGGLE
1004 /* by haroon - change toggle to its opposite value */
1005 case ID_TOGGLE_ENABLED:
1006 global_toggle_state = !global_toggle_state;
1007 if (global_toggle_state)
1009 log_error(LOG_LEVEL_INFO, "Now toggled ON.");
1013 log_error(LOG_LEVEL_INFO, "Now toggled OFF.");
1017 #endif /* def FEATURE_TOGGLE */
1019 case ID_TOOLS_EDITCONFIG:
1020 EditFile(configfile);
1023 case ID_TOOLS_EDITDEFAULTACTIONS:
1024 EditFile(g_default_actions_file);
1027 case ID_TOOLS_EDITUSERACTIONS:
1028 EditFile(g_user_actions_file);
1031 case ID_TOOLS_EDITFILTERS:
1032 EditFile(g_re_filterfile);
1035 #ifdef FEATURE_TRUST
1036 case ID_TOOLS_EDITTRUST:
1037 EditFile(g_trustfile);
1039 #endif /* def FEATURE_TRUST */
1042 ShellExecute(g_hwndLogFrame, "open", "LICENSE.txt", NULL, NULL, SW_SHOWNORMAL);
1046 ShellExecute(g_hwndLogFrame, "open", "doc\\faq\\index.html", NULL, NULL, SW_SHOWNORMAL);
1049 case ID_HELP_MANUAL:
1050 ShellExecute(g_hwndLogFrame, "open", "doc\\user-manual\\index.html", NULL, NULL, SW_SHOWNORMAL);
1053 case ID_HELP_STATUS:
1054 ShellExecute(g_hwndLogFrame, "open", CGI_PREFIX "show-status", NULL, NULL, SW_SHOWNORMAL);
1058 MessageBox(g_hwndLogFrame, win32_blurb, "About Privoxy", MB_OK);
1069 /*********************************************************************
1071 * Function : OnLogInitMenu
1073 * Description : Handler for WM_INITMENU messages. Enable, disable,
1074 * check, and/or uncheck menu options as apropos.
1077 * 1 : hmenu = handle to menu to "make current"
1081 *********************************************************************/
1082 void OnLogInitMenu(HMENU hmenu)
1084 /* Only enable editors if there is a file to edit */
1085 EnableMenuItem(hmenu, ID_TOOLS_EDITDEFAULTACTIONS, MF_BYCOMMAND | (g_default_actions_file ? MF_ENABLED : MF_GRAYED));
1086 EnableMenuItem(hmenu, ID_TOOLS_EDITUSERACTIONS, MF_BYCOMMAND | (g_user_actions_file ? MF_ENABLED : MF_GRAYED));
1087 EnableMenuItem(hmenu, ID_TOOLS_EDITFILTERS, MF_BYCOMMAND | (g_re_filterfile ? MF_ENABLED : MF_GRAYED));
1088 #ifdef FEATURE_TRUST
1089 EnableMenuItem(hmenu, ID_TOOLS_EDITTRUST, MF_BYCOMMAND | (g_trustfile ? MF_ENABLED : MF_GRAYED));
1090 #endif /* def FEATURE_TRUST */
1092 /* Check/uncheck options */
1093 CheckMenuItem(hmenu, ID_VIEW_LOGMESSAGES, MF_BYCOMMAND | (g_bLogMessages ? MF_CHECKED : MF_UNCHECKED));
1094 CheckMenuItem(hmenu, ID_VIEW_MESSAGEHIGHLIGHTING, MF_BYCOMMAND | (g_bHighlightMessages ? MF_CHECKED : MF_UNCHECKED));
1095 CheckMenuItem(hmenu, ID_VIEW_LIMITBUFFERSIZE, MF_BYCOMMAND | (g_bLimitBufferSize ? MF_CHECKED : MF_UNCHECKED));
1096 CheckMenuItem(hmenu, ID_VIEW_ACTIVITYANIMATION, MF_BYCOMMAND | (g_bShowActivityAnimation ? MF_CHECKED : MF_UNCHECKED));
1097 #ifdef FEATURE_TOGGLE
1098 /* by haroon - menu item for Enable toggle on/off */
1099 CheckMenuItem(hmenu, ID_TOGGLE_ENABLED, MF_BYCOMMAND | (global_toggle_state ? MF_CHECKED : MF_UNCHECKED));
1100 #endif /* def FEATURE_TOGGLE */
1101 CheckMenuItem(hmenu, ID_TOGGLE_SHOWWINDOW, MF_BYCOMMAND | (g_bShowLogWindow ? MF_CHECKED : MF_UNCHECKED));
1106 /*********************************************************************
1108 * Function : OnLogTimer
1110 * Description : Handler for WM_TIMER messages.
1113 * 1 : nTimer = timer id (animation start/stop or clip buffer)
1117 *********************************************************************/
1118 void OnLogTimer(int nTimer)
1123 TraySetIcon(g_hwndTray, 1, g_hiconAnim[g_nAnimFrame++ % ANIM_FRAMES]);
1126 case TIMER_ANIMSTOP_ID:
1129 KillTimer(g_hwndLogFrame, TIMER_ANIM_ID);
1130 KillTimer(g_hwndLogFrame, TIMER_ANIMSTOP_ID);
1133 case TIMER_CLIPBUFFER_ID:
1134 case TIMER_CLIPBUFFER_FORCE_ID:
1136 g_bClipPending = FALSE;
1137 KillTimer(g_hwndLogFrame, TIMER_CLIPBUFFER_ID);
1138 KillTimer(g_hwndLogFrame, TIMER_CLIPBUFFER_FORCE_ID);
1149 /*********************************************************************
1151 * Function : SetIdleIcon
1153 * Description : Sets the tray icon to either idle or off
1159 *********************************************************************/
1162 #ifdef FEATURE_TOGGLE
1163 if (!global_toggle_state)
1165 TraySetIcon(g_hwndTray, 1, g_hiconOff);
1166 /* log_error(LOG_LEVEL_INFO, "Privoxy OFF icon selected."); */
1169 #endif /* def FEATURE_TOGGLE */
1170 TraySetIcon(g_hwndTray, 1, g_hiconIdle);
1174 /*********************************************************************
1176 * Function : LogRichEditProc
1178 * Description : Window subclass routine handles some events for the rich edit control.
1181 * 1 : hwnd = window handle of the rich edit control
1182 * 2 : uMsg = message number
1183 * 3 : wParam = first param for this message
1184 * 4 : lParam = next param for this message
1186 * Returns : Appropriate M$ window message handler codes.
1188 *********************************************************************/
1189 LRESULT CALLBACK LogRichEditProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
1196 pt.x = LOWORD(lParam);
1197 pt.y = HIWORD(lParam);
1198 ClientToScreen(hwnd, &pt);
1199 OnLogRButtonUp(wParam, pt.x, pt.y);
1204 if ((GetKeyState(VK_CONTROL) != 0) && (wParam == 4)) /* ctrl+d */
1206 OnLogCommand(ID_VIEW_CLEARLOG);
1211 return CallWindowProc(g_fnLogBox, hwnd, uMsg, wParam, lParam);
1216 /*********************************************************************
1218 * Function : LogWindowProc
1220 * Description : Windows call back routine handles events on the log window.
1223 * 1 : hwnd = handle of the logging window
1224 * 2 : uMsg = message number
1225 * 3 : wParam = first param for this message
1226 * 4 : lParam = next param for this message
1228 * Returns : Appropriate M$ window message handler codes.
1230 *********************************************************************/
1231 LRESULT CALLBACK LogWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
1239 /* This is the end - beautiful friend - the end */
1240 DestroyWindow(g_hwndLogBox);
1241 DestroyWindow(g_hwndLogFrame);
1249 g_bShowLogWindow = wParam;
1251 /* Resize the logging window to fit the new frame */
1255 GetClientRect(g_hwndLogFrame, &rc);
1256 SetWindowPos(g_hwndLogBox, NULL, rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top, SWP_NOZORDER);
1261 OnLogInitMenu((HMENU) wParam);
1269 OnLogCommand(LOWORD(wParam));
1276 if (g_bCloseHidesWindow)
1278 ShowLogWindow(FALSE);
1283 ShowLogWindow(FALSE);
1289 if ((GetKeyState(VK_CONTROL) != 0) && (wParam == 4)) /* ctrl+d */
1291 OnLogCommand(ID_VIEW_CLEARLOG);
1297 return DefWindowProc(hwnd, uMsg, wParam, lParam);
1301 #endif /* ndef _WIN_CONSOLE - entire file */