w32log.c

   1 const char w32log_rcs[] = "$Id: w32log.c,v 1.45 2012/05/24 15:05:17 fabiankeil Exp $";
   2 /*********************************************************************
   3  *
   4  * File        :  $Source: /cvsroot/ijbswa/current/w32log.c,v $
   5  *
   6  * Purpose     :  Functions for creating and destroying the log window,
   7  *                ouputting strings, processing messages and so on.
   8  *
   9  * Copyright   :  Written by and Copyright (C) 2001-2009 members of
  10  *                the Privoxy team.  http://www.privoxy.org/
  11  *
  12  *                Written by and Copyright (C) 1999 Adam Lock
  13  *                <locka@iol.ie>
  14  *
  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.
  20  *
  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.
  26  *
  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.
  32  *
  33  *********************************************************************/
  34
  35
  36 #include "config.h"
  37
  38 #include <assert.h>
  39 #include <stdio.h>
  40
  41 #ifndef STRICT
  42 #define STRICT
  43 #endif
  44 #include <windows.h>
  45 #include <richedit.h>
  46
  47 #include "project.h"
  48 #include "w32log.h"
  49 #include "w32taskbar.h"
  50 #include "win32.h"
  51 #include "w32res.h"
  52 #include "jcc.h"
  53 #include "miscutil.h"
  54 #include "errlog.h"
  55 #include "loadcfg.h"
  56
  57 const char w32res_h_rcs[] = W32RES_H_VERSION;
  58
  59 #ifdef __MINGW32__
  60 #include "cygwin.h"
  61 const char cygwin_h_rcs[] = CYGWIN_H_VERSION;
  62 #endif
  63
  64 const char w32log_h_rcs[] = W32LOG_H_VERSION;
  65
  66 #ifndef _WIN_CONSOLE /* entire file */
  67
  68 /*
  69  * Timers and the various durations
  70  */
  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
  79
  80 /*
  81  * Styles of text that can be output
  82  */
  83 #define STYLE_NONE      0
  84 #define STYLE_HIGHLIGHT 1
  85 #define STYLE_LINK      2
  86 #define STYLE_HEADER    3
  87
  88 /*
  89  * Number of frames of animation in tray activity sequence
  90  */
  91 #define ANIM_FRAMES 8
  92
  93 #define DEFAULT_MAX_BUFFER_LINES    200
  94 #define DEFAULT_LOG_FONT_NAME       "MS Sans Serif"
  95 #define DEFAULT_LOG_FONT_SIZE       8
  96
  97 /*
  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.
 101  */
 102
 103 /* Indicates whether task bar shows activity animation */
 104 BOOL g_bShowActivityAnimation = 1;
 105
 106 /* Indicates whether the log window is shown */
 107 BOOL g_bShowLogWindow = 1;
 108
 109 /* Indicates if the log window appears on the task bar */
 110 BOOL g_bShowOnTaskBar = 0;
 111
 112 /* Indicates whether closing the log window really just hides it */
 113 BOOL g_bCloseHidesWindow = 1;
 114
 115 /* Indicates if messages are logged at all */
 116 BOOL g_bLogMessages = 1;
 117
 118 /* Indicates whether log messages are highlighted */
 119 BOOL g_bHighlightMessages = 1;
 120
 121 /* Indicates if buffer is limited in size */
 122 BOOL g_bLimitBufferSize = 1;
 123
 124 /* Maximum number of lines allowed in buffer when limited */
 125 int g_nMaxBufferLines = DEFAULT_MAX_BUFFER_LINES;
 126
 127 /* Font to use */
 128 char g_szFontFaceName[32] = DEFAULT_LOG_FONT_NAME;
 129
 130 /* Size of font to use */
 131 int g_nFontSize = DEFAULT_LOG_FONT_SIZE;
 132
 133
 134 /* FIXME: this is a kludge */
 135
 136 const char * g_default_actions_file = NULL;
 137 const char * g_user_actions_file = NULL;
 138 const char * g_default_filterfile = NULL;
 139 const char * g_user_filterfile = NULL;
 140 #ifdef FEATURE_TRUST
 141 const char * g_trustfile = NULL;
 142 #endif /* def FEATURE_TRUST */
 143
 144 /* FIXME: end kludge */
 145
 146 /* Regular expression for detected URLs */
 147 #define RE_URL "http:[^ \n\r]*"
 148
 149 /*
 150  * Regular expressions that are used to perform highlight in the log window
 151  */
 152 static struct _Pattern
 153 {
 154    const char *str;
 155    int style;
 156    regex_t buffer;
 157 } patterns_to_highlight[] =
 158 {
 159    /* url headers */
 160    { RE_URL,                STYLE_LINK },
 161 /* { "[a-zA-Z0-9]+\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+\\.[^ \n\r]*", STYLE_LINK }, */
 162    /* interesting text to highlight */
 163    /*   see jcc.c crunch_reason for the full list */
 164    { "Crunch: Blocked:",            STYLE_HIGHLIGHT },
 165    { "Crunch: Untrusted",           STYLE_HIGHLIGHT },
 166    { "Crunch: Redirected:",         STYLE_HIGHLIGHT },
 167    { "Crunch: DNS failure",         STYLE_HIGHLIGHT },
 168    { "Crunch: Forwarding failed",   STYLE_HIGHLIGHT },
 169    { "Crunch: Connection failure",  STYLE_HIGHLIGHT },
 170    { "Crunch: Out of memory",       STYLE_HIGHLIGHT },
 171    { "Connect: Found reusable socket",     STYLE_HIGHLIGHT },
 172    { "Connect: Reusing server socket",     STYLE_HIGHLIGHT },
 173    { "Connect: Created new connection to", STYLE_HIGHLIGHT },
 174    { "hung up on us",               STYLE_HIGHLIGHT },
 175    { "Crunching Referer:",          STYLE_HIGHLIGHT },
 176    /* what are all the possible error strings?? */
 177    { "Error:",                      STYLE_HIGHLIGHT },
 178    /* http headers */
 179    { "referer:",            STYLE_HEADER },
 180    { "proxy-connection:",   STYLE_HEADER },
 181    { "proxy-agent:",        STYLE_HEADER },
 182    { "user-agent:",         STYLE_HEADER },
 183    { "host:",               STYLE_HEADER },
 184    { "accept:",             STYLE_HEADER },
 185    { "accept-encoding:",    STYLE_HEADER },
 186    { "accept-language:",    STYLE_HEADER },
 187    { "accept-charset:",     STYLE_HEADER },
 188    { "accept-ranges:",      STYLE_HEADER },
 189    { "date:",               STYLE_HEADER },
 190    { "cache-control:",      STYLE_HEADER },
 191    { "cache-last-checked:", STYLE_HEADER },
 192    { "connection:",         STYLE_HEADER },
 193    { "content-type",        STYLE_HEADER },
 194    { "content-length",      STYLE_HEADER },
 195    { "cookie",              STYLE_HEADER },
 196    { "last-modified:",      STYLE_HEADER },
 197    { "pragma:",             STYLE_HEADER },
 198    { "server:",             STYLE_HEADER },
 199    { "etag:",               STYLE_HEADER },
 200    { "expires:",            STYLE_HEADER },
 201    { "warning:",            STYLE_HEADER },
 202    /* this is the terminator statement - do not delete! */
 203    { NULL,                  STYLE_NONE }
 204 };
 205
 206 /*
 207  * Public variables
 208  */
 209 HWND g_hwndLogFrame;
 210 HICON g_hiconApp;
 211
 212 /*
 213  * Private variables
 214  */
 215 static CRITICAL_SECTION g_criticalsection;
 216 static HWND g_hwndTray;
 217 static HWND g_hwndLogBox;
 218 static WNDPROC g_fnLogBox;
 219 static HICON g_hiconAnim[ANIM_FRAMES];
 220 static HICON g_hiconIdle;
 221 static HICON g_hiconOff;
 222 static int g_nAnimFrame;
 223 static BOOL g_bClipPending = FALSE;
 224 static int g_nRichEditVersion = 0;
 225
 226 /*
 227  * Private functions
 228  */
 229 static HWND CreateLogWindow(HINSTANCE hInstance, int nCmdShow);
 230 static HWND CreateHiddenLogOwnerWindow(HINSTANCE hInstance);
 231 static LRESULT CALLBACK LogWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
 232 static LRESULT CALLBACK LogOwnerWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
 233 static LRESULT CALLBACK LogRichEditProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
 234 static BOOL InitRichEdit(void);
 235 static void LogClipBuffer(void);
 236 static void LogCreatePatternMatchingBuffers(void);
 237 static void LogDestroyPatternMatchingBuffers(void);
 238 static int LogPutStringNoMatch(const char *pszText, int style);
 239 static void SetIdleIcon(void);
 240
 241
 242 /*********************************************************************
 243  *
 244  * Function    :  InitLogWindow
 245  *
 246  * Description :  Initialise the log window.
 247  *
 248  * Parameters  :  None
 249  *
 250  * Returns     :  Always TRUE (there should be error checking on the resources).
 251  *
 252  *********************************************************************/
 253 BOOL InitLogWindow(void)
 254 {
 255    int i;
 256
 257    /* Load the icons */
 258    g_hiconIdle = LoadIcon(g_hInstance, MAKEINTRESOURCE(IDI_IDLE));
 259    g_hiconOff  = LoadIcon(g_hInstance, MAKEINTRESOURCE(IDI_OFF));
 260    for (i = 0; i < ANIM_FRAMES; i++)
 261    {
 262       g_hiconAnim[i] = LoadIcon(g_hInstance, MAKEINTRESOURCE(IDI_ANIMATED1 + i));
 263    }
 264    g_hiconApp = LoadIcon(g_hInstance, MAKEINTRESOURCE(IDI_MAINICON));
 265
 266    /* Create the user interface */
 267    g_hwndLogFrame = CreateLogWindow(g_hInstance, g_nCmdShow);
 268    g_hwndTray = CreateTrayWindow(g_hInstance);
 269    TrayAddIcon(g_hwndTray, 1, g_hiconApp, "Privoxy");
 270
 271    /* Create pattern matching buffers (for highlighting */
 272    LogCreatePatternMatchingBuffers();
 273
 274    /* Create a critical section to protect multi-threaded access to certain things */
 275    InitializeCriticalSection(&g_criticalsection);
 276
 277    return TRUE;
 278
 279 }
 280
 281
 282 /*********************************************************************
 283  *
 284  * Function    :  TermLogWindow
 285  *
 286  * Description :  Cleanup the logwindow.
 287  *
 288  * Parameters  :  None
 289  *
 290  * Returns     :  N/A
 291  *
 292  *********************************************************************/
 293 void TermLogWindow(void)
 294 {
 295    int i;
 296
 297    LogDestroyPatternMatchingBuffers();
 298
 299    TrayDeleteIcon(g_hwndTray, 1);
 300    DeleteObject(g_hiconApp);
 301    DeleteObject(g_hiconIdle);
 302    DeleteObject(g_hiconOff);
 303    for (i = 0; i < ANIM_FRAMES; i++)
 304    {
 305       DeleteObject(g_hiconAnim[i]);
 306    }
 307
 308 }
 309
 310
 311 /*********************************************************************
 312  *
 313  * Function    :  LogCreatePatternMatchingBuffers
 314  *
 315  * Description :  Compile the pattern matching buffers.
 316  *
 317  * Parameters  :  None
 318  *
 319  * Returns     :  N/A
 320  *
 321  *********************************************************************/
 322 void LogCreatePatternMatchingBuffers(void)
 323 {
 324    int i;
 325    for (i = 0; patterns_to_highlight[i].str != NULL; i++)
 326    {
 327       regcomp(&patterns_to_highlight[i].buffer, patterns_to_highlight[i].str, REG_ICASE);
 328    }
 329 }
 330
 331
 332 /*********************************************************************
 333  *
 334  * Function    :  LogDestroyPatternMatchingBuffers
 335  *
 336  * Description :  Free up the pattern matching buffers.
 337  *
 338  * Parameters  :  None
 339  *
 340  * Returns     :  N/A
 341  *
 342  *********************************************************************/
 343 void LogDestroyPatternMatchingBuffers(void)
 344 {
 345    int i;
 346    for (i = 0; patterns_to_highlight[i].str != NULL; i++)
 347    {
 348       regfree(&patterns_to_highlight[i].buffer);
 349    }
 350 }
 351
 352
 353 /*********************************************************************
 354  *
 355  * Function    :  LogPutString
 356  *
 357  * Description :  Inserts text into the logging window.  This is really
 358  *                a regexp aware wrapper function to `LogPutStringNoMatch'.
 359  *
 360  * Parameters  :
 361  *          1  :  pszText = pointer to string going to the log window
 362  *
 363  * Returns     :  1 => success, else the return code from `LogPutStringNoMatch'.
 364  *                FIXME: this is backwards to the rest of IJB and to common
 365  *                programming practice.  Please use 0 => success instead.
 366  *
 367  *********************************************************************/
 368 int LogPutString(const char *pszText)
 369 {
 370    int i;
 371    int result = 0;
 372
 373    if (!g_bLogMessages)
 374    {
 375       return 1;
 376    }
 377
 378    if (pszText == NULL || strlen(pszText) == 0)
 379    {
 380       return 1;
 381    }
 382
 383    /* Critical section stops multiple threads doing nasty interactions that
 384     * foul up the highlighting and output.
 385     */
 386    EnterCriticalSection(&g_criticalsection);
 387
 388    if (g_bHighlightMessages)
 389    {
 390       regmatch_t match;
 391
 392       /* First things first, regexp scan for various things that we would like highlighted */
 393       for (i = 0; patterns_to_highlight[i].str != NULL; i++)
 394       {
 395          if (regexec(&patterns_to_highlight[i].buffer, pszText, 1, &match, 0) == 0)
 396          {
 397             char *pszBefore = NULL;
 398             char *pszMatch = NULL;
 399             char *pszAfter = NULL;
 400             int nMatchSize;
 401
 402             /* Split the string up into pieces representing the strings, before
 403                at and after the matching pattern
 404              */
 405             if (match.rm_so > 0)
 406             {
 407                pszBefore = (char *)malloc((match.rm_so + 1) * sizeof(char));
 408                memset(pszBefore, 0, (match.rm_so + 1) * sizeof(char));
 409                strncpy(pszBefore, pszText, match.rm_so);
 410             }
 411             if (match.rm_eo < (regoff_t)strlen(pszText))
 412             {
 413                pszAfter = strdup(&pszText[match.rm_eo]);
 414             }
 415             nMatchSize = match.rm_eo - match.rm_so;
 416             pszMatch = (char *)malloc(nMatchSize + 1);
 417             strncpy(pszMatch, &pszText[match.rm_so], nMatchSize);
 418             pszMatch[nMatchSize] = '\0';
 419
 420             /* Recursively call LogPutString */
 421             if (pszBefore)
 422             {
 423                LogPutString(pszBefore);
 424                free(pszBefore);
 425             }
 426             if (pszMatch)
 427             {
 428                LogPutStringNoMatch(pszMatch, patterns_to_highlight[i].style);
 429                free(pszMatch);
 430             }
 431             if (pszAfter)
 432             {
 433                LogPutString(pszAfter);
 434                free(pszAfter);
 435             }
 436
 437             result = 1;
 438             goto end;
 439          }
 440       }
 441    }
 442
 443    result = LogPutStringNoMatch(pszText, STYLE_NONE);
 444
 445 end:
 446    LeaveCriticalSection(&g_criticalsection);
 447
 448    return result;
 449
 450 }
 451
 452
 453 /*********************************************************************
 454  *
 455  * Function    :  LogPutStringNoMatch
 456  *
 457  * Description :  Puts a string into the logging window.
 458  *
 459  * Parameters  :
 460  *          1  :  pszText = pointer to string going to the log window
 461  *          2  :  style = STYLE_NONE, STYLE_HEADER, STYLE_HIGHLIGHT, or STYLE_LINK
 462  *
 463  * Returns     :  Always 1 => success.
 464  *                FIXME: this is backwards to the rest of IJB and to common
 465  *                programming practice.  Please use 0 => success instead.
 466  *
 467  *********************************************************************/
 468 int LogPutStringNoMatch(const char *pszText, int style)
 469 {
 470    CHARRANGE range;
 471    CHARFORMAT format;
 472    int nTextLength;
 473
 474    assert(g_hwndLogBox);
 475    if (g_hwndLogBox == NULL)
 476    {
 477       return 1;
 478    }
 479
 480    /* TODO preserve existing selection */
 481
 482    /* Go to the end of the text */
 483    nTextLength = GetWindowTextLength(g_hwndLogBox);
 484    range.cpMin = nTextLength;
 485    range.cpMax = nTextLength;
 486    SendMessage(g_hwndLogBox, EM_EXSETSEL, 0, (LPARAM) &range);
 487
 488    /* Apply a formatting style */
 489    memset(&format, 0, sizeof(format));
 490    format.cbSize = sizeof(format);
 491    format.dwMask = CFM_BOLD | CFM_UNDERLINE | CFM_STRIKEOUT |
 492       CFM_ITALIC | CFM_COLOR | CFM_FACE | CFM_SIZE | CFM_CHARSET;
 493    format.bCharSet = DEFAULT_CHARSET;
 494    format.yHeight = (g_nFontSize * 1440) / 72;
 495    strlcpy(format.szFaceName, g_szFontFaceName, sizeof(format.szFaceName));
 496    if (style == STYLE_NONE)
 497    {
 498       /* DO NOTHING */
 499       format.dwEffects |= CFE_AUTOCOLOR;
 500    }
 501    else if (style == STYLE_HEADER)
 502    {
 503       format.dwEffects |= CFE_AUTOCOLOR | CFE_ITALIC;
 504    }
 505    else if (style == STYLE_HIGHLIGHT)
 506    {
 507       format.dwEffects |= CFE_AUTOCOLOR | CFE_BOLD;
 508    }
 509    else if (style == STYLE_LINK)
 510    {
 511       format.dwEffects |= CFE_UNDERLINE;
 512       format.crTextColor = RGB(0, 0, 255);
 513    }
 514    SendMessage(g_hwndLogBox, EM_SETCHARFORMAT, SCF_SELECTION, (LPARAM) &format);
 515
 516    /* Append text to the end */
 517    SendMessage(g_hwndLogBox, EM_REPLACESEL, FALSE, (LPARAM) pszText);
 518
 519    /* TODO Restore the old selection */
 520
 521    /* Purge buffer */
 522    if (strchr(pszText, '\n') != NULL)
 523    {
 524       SetTimer(g_hwndLogFrame, TIMER_CLIPBUFFER_ID, TIMER_CLIPBUFFER_TIME, NULL);
 525       if (!g_bClipPending)
 526       {
 527          /* Set the force clip timer going. This timer ensures clipping is done
 528             intermittently even when there is a sustained burst of logging
 529          */
 530          SetTimer(g_hwndLogFrame, TIMER_CLIPBUFFER_FORCE_ID, TIMER_CLIPBUFFER_FORCE_TIME, NULL);
 531       }
 532       g_bClipPending = TRUE;
 533    }
 534
 535    return 1;
 536
 537 }
 538
 539
 540 /*********************************************************************
 541  *
 542  * Function    :  LogShowActivity
 543  *
 544  * Description :  Start the spinner.
 545  *
 546  * Parameters  :  None
 547  *
 548  * Returns     :  N/A
 549  *
 550  *********************************************************************/
 551 void LogShowActivity(void)
 552 {
 553    int i;
 554
 555    /* Try to figure out if SetIdleIcon() is thread-safe */
 556    for (i = 0; i < 1000; i++)
 557    {
 558       SetIdleIcon();
 559    }
 560
 561    /* Start some activity timers */
 562    if (g_bShowActivityAnimation)
 563    {
 564       SetTimer(g_hwndLogFrame, TIMER_ANIM_ID, TIMER_ANIM_TIME, NULL);
 565       SetTimer(g_hwndLogFrame, TIMER_ANIMSTOP_ID, TIMER_ANIMSTOP_TIME, NULL);
 566    }
 567
 568 }
 569
 570
 571 /*********************************************************************
 572  *
 573  * Function    :  LogClipBuffer
 574  *
 575  * Description :  Prunes old lines from the log.
 576  *
 577  * Parameters  :  None
 578  *
 579  * Returns     :  N/A
 580  *
 581  *********************************************************************/
 582 void LogClipBuffer(void)
 583 {
 584    int nLines = SendMessage(g_hwndLogBox, EM_GETLINECOUNT, 0, 0);
 585    if (g_bLimitBufferSize && nLines > g_nMaxBufferLines)
 586    {
 587       /* Compute the range representing the lines to be deleted */
 588       LONG nLastLineToDelete = nLines - g_nMaxBufferLines;
 589       LONG nLastChar = SendMessage(g_hwndLogBox, EM_LINEINDEX, nLastLineToDelete, 0);
 590       CHARRANGE range;
 591       range.cpMin = 0;
 592       range.cpMax = nLastChar;
 593
 594       /* TODO get current selection */
 595
 596       /* TODO adjust and clip old selection against range to be deleted */
 597
 598       /* Select range and erase it (turning off autoscroll to prevent
 599          nasty scrolling) */
 600       SendMessage(g_hwndLogBox, EM_SETOPTIONS, ECOOP_XOR, ECO_AUTOVSCROLL);
 601       SendMessage(g_hwndLogBox, EM_EXSETSEL, 0, (LPARAM) &range);
 602       SendMessage(g_hwndLogBox, EM_REPLACESEL, FALSE, (LPARAM) "");
 603       SendMessage(g_hwndLogBox, EM_SETOPTIONS, ECOOP_XOR, ECO_AUTOVSCROLL);
 604
 605       /* reposition (back to) the end of the log content */
 606       range.cpMin = SendMessage (g_hwndLogBox, WM_GETTEXTLENGTH, 0, 0);
 607       range.cpMax = -1;
 608       SendMessage(g_hwndLogBox, EM_EXSETSEL, 0, (LPARAM) &range);
 609
 610       /* restore vertical ScrollBar stuff (messed up by AUTOVSCROLL) */
 611       SendMessage (g_hwndLogBox, EM_SCROLL, SB_LINEDOWN, 0);
 612
 613    }
 614
 615 }
 616
 617
 618 /*********************************************************************
 619  *
 620  * Function    :  CreateHiddenLogOwnerWindow
 621  *
 622  * Description :  Creates a hidden owner window that stops the log
 623  *                window appearing in the task bar.
 624  *
 625  * Parameters  :
 626  *          1  :  hInstance = application's instance handle
 627  *
 628  * Returns     :  Handle to newly created window.
 629  *
 630  *********************************************************************/
 631 HWND CreateHiddenLogOwnerWindow(HINSTANCE hInstance)
 632 {
 633    static const char *szWndName = "PrivoxyLogOwner";
 634    WNDCLASS wc;
 635    HWND hwnd;
 636
 637    wc.style          = 0;
 638    wc.lpfnWndProc    = LogOwnerWindowProc;
 639    wc.cbClsExtra     = 0;
 640    wc.cbWndExtra     = 0;
 641    wc.hInstance      = hInstance;
 642    wc.hIcon          = g_hiconApp;
 643    wc.hCursor        = 0;
 644    wc.hbrBackground  = 0;
 645    wc.lpszMenuName   = 0;
 646    wc.lpszClassName  = szWndName;
 647
 648    RegisterClass(&wc);
 649
 650    hwnd = CreateWindow(szWndName, szWndName,
 651       WS_OVERLAPPEDWINDOW, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT,
 652       CW_USEDEFAULT, NULL, NULL, hInstance, NULL);
 653
 654    return hwnd;
 655
 656 }
 657
 658
 659 /*********************************************************************
 660  *
 661  * Function    :  LogOwnerWindowProc
 662  *
 663  * Description :  Dummy procedure that does nothing special.
 664  *
 665  * Parameters  :
 666  *          1  :  hwnd = window handle
 667  *          2  :  uMsg = message number
 668  *          3  :  wParam = first param for this message
 669  *          4  :  lParam = next param for this message
 670  *
 671  * Returns     :  Same as `DefWindowProc'.
 672  *
 673  *********************************************************************/
 674 LRESULT CALLBACK LogOwnerWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
 675 {
 676    return DefWindowProc(hwnd, uMsg, wParam, lParam);
 677
 678 }
 679
 680
 681 /*********************************************************************
 682  *
 683  * Function    :  CreateLogWindow
 684  *
 685  * Description :  Create the logging window.
 686  *
 687  * Parameters  :
 688  *          1  :  hInstance = application's instance handle
 689  *          2  :  nCmdShow = window show value (MIN, MAX, NORMAL, etc...)
 690  *
 691  * Returns     :  Handle to newly created window.
 692  *
 693  *********************************************************************/
 694 HWND CreateLogWindow(HINSTANCE hInstance, int nCmdShow)
 695 {
 696    static const char *szWndName = "PrivoxyLogWindow";
 697    static const char *szWndTitle = "Privoxy";
 698
 699    HWND hwnd = NULL;
 700    HWND hwndOwner = (g_bShowOnTaskBar) ? NULL : CreateHiddenLogOwnerWindow(hInstance);
 701    RECT rcClient;
 702    WNDCLASSEX wc;
 703
 704    memset(&wc, 0, sizeof(wc));
 705    wc.cbSize         = sizeof(wc);
 706    wc.style          = CS_DBLCLKS;
 707    wc.lpfnWndProc    = LogWindowProc;
 708    wc.cbClsExtra     = 0;
 709    wc.cbWndExtra     = 0;
 710    wc.hInstance      = hInstance;
 711    wc.hIcon          = g_hiconApp;
 712    wc.hCursor        = 0;
 713    wc.hbrBackground  = 0;
 714    wc.lpszMenuName   = MAKEINTRESOURCE(IDR_LOGVIEW);
 715    wc.lpszClassName  = szWndName;
 716    wc.hbrBackground  = GetStockObject(WHITE_BRUSH);
 717    RegisterClassEx(&wc);
 718
 719    hwnd = CreateWindowEx(WS_EX_APPWINDOW, szWndName, szWndTitle,
 720       WS_OVERLAPPEDWINDOW, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT,
 721       CW_USEDEFAULT, hwndOwner, NULL, hInstance, NULL);
 722
 723    /* Now create a child list box */
 724    GetClientRect(hwnd, &rcClient);
 725
 726    /* Create a rich edit control */
 727    InitRichEdit();
 728    g_hwndLogBox = CreateWindowEx(0, (g_nRichEditVersion == 0x0100) ? "RichEdit" : RICHEDIT_CLASS, "",
 729       ES_AUTOVSCROLL | ES_MULTILINE | ES_READONLY | ES_NOHIDESEL | WS_CHILD | WS_VSCROLL | WS_HSCROLL | WS_VISIBLE,
 730       rcClient.left, rcClient.top, rcClient.right, rcClient.bottom,
 731       hwnd, NULL, hInstance, NULL);
 732 /* SendMessage(g_hwndLogBox, EM_SETWORDWRAPMODE, 0, 0); */
 733
 734    /* Subclass the control to catch certain messages */
 735    g_fnLogBox = (WNDPROC) GetWindowLong(g_hwndLogBox, GWL_WNDPROC);
 736    SetWindowLong(g_hwndLogBox, GWL_WNDPROC, (LONG) LogRichEditProc);
 737
 738    /* Minimizing looks stupid when the log window is not on the task bar, so hide instead */
 739    if (!g_bShowOnTaskBar &&
 740          (nCmdShow == SW_SHOWMINIMIZED ||
 741           nCmdShow == SW_MINIMIZE ||
 742           nCmdShow == SW_SHOWMINNOACTIVE))
 743    {
 744       g_bShowLogWindow = FALSE;
 745       nCmdShow = SW_HIDE;
 746    }
 747
 748    ShowWindow(hwnd, nCmdShow);
 749    UpdateWindow(hwnd);
 750
 751
 752    GetClientRect(g_hwndLogFrame, &rcClient);
 753    SetWindowPos(g_hwndLogBox, NULL, rcClient.left, rcClient.top, rcClient.right - rcClient.left, rcClient.bottom - rcClient.top, SWP_NOZORDER);
 754
 755    return hwnd;
 756
 757 }
 758
 759
 760 /*********************************************************************
 761  *
 762  * Function    :  InitRichEdit
 763  *
 764  * Description :  Initialise the rich edit control library.
 765  *
 766  * Parameters  :  None
 767  *
 768  * Returns     :  TRUE => success, FALSE => failure.
 769  *                FIXME: this is backwards to the rest of IJB and to common
 770  *                programming practice.  Please use 0 => success instead.
 771  *
 772  *********************************************************************/
 773 BOOL InitRichEdit(void)
 774 {
 775    static HINSTANCE hInstRichEdit;
 776    if (hInstRichEdit == NULL)
 777    {
 778       g_nRichEditVersion = 0;
 779       hInstRichEdit = LoadLibraryA("RICHED20.DLL");
 780       if (hInstRichEdit)
 781       {
 782          g_nRichEditVersion = _RICHEDIT_VER;
 783       }
 784       else
 785       {
 786          hInstRichEdit = LoadLibraryA("RICHED32.DLL");
 787          if (hInstRichEdit)
 788          {
 789             g_nRichEditVersion = 0x0100;
 790          }
 791       }
 792    }
 793    return (hInstRichEdit != NULL) ? TRUE : FALSE;
 794
 795 }
 796
 797
 798 /*********************************************************************
 799  *
 800  * Function    :  ShowLogWindow
 801  *
 802  * Description :  Shows or hides the log window.  We will also raise the
 803  *                window on a show command in case it is buried.
 804  *
 805  * Parameters  :
 806  *          1  :  bShow = TRUE to show, FALSE to mimize/hide
 807  *
 808  * Returns     :  N/A
 809  *
 810  *********************************************************************/
 811 void ShowLogWindow(BOOL bShow)
 812 {
 813    if (bShow)
 814    {
 815       SetForegroundWindow(g_hwndLogFrame);
 816       SetWindowPos(g_hwndLogFrame, HWND_TOP, 0, 0, 0, 0, SWP_SHOWWINDOW | SWP_NOSIZE | SWP_NOMOVE);
 817
 818    }
 819    else if (g_bShowOnTaskBar)
 820    {
 821       ShowWindow(g_hwndLogFrame, SW_MINIMIZE);
 822    }
 823    else
 824    {
 825       ShowWindow(g_hwndLogFrame, SW_HIDE);
 826    }
 827 }
 828
 829
 830 /*********************************************************************
 831  *
 832  * Function    :  EditFile
 833  *
 834  * Description :  Opens the specified setting file for editing.
 835  * FIXME: What if the file has no associated application. Check for return values
 836 *        from ShellExecute??
 837  *
 838  * Parameters  :
 839  *          1  :  filename = filename from the config (aka config.txt) file.
 840  *
 841  * Returns     :  N/A
 842  *
 843  *********************************************************************/
 844 void EditFile(const char *filename)
 845 {
 846    if (filename)
 847    {
 848       ShellExecute(g_hwndLogFrame, "open", filename, NULL, NULL, SW_SHOWNORMAL);
 849    }
 850
 851 }
 852
 853
 854 /*--------------------------------------------------------------------------*/
 855 /* Windows message handlers                                                 */
 856 /*--------------------------------------------------------------------------*/
 857
 858
 859 /*********************************************************************
 860  *
 861  * Function    :  OnLogRButtonUp
 862  *
 863  * Description :  Handler for WM_RBUTTONUP messages.
 864  *
 865  * Parameters  :
 866  *          1  :  nModifier = wParam from mouse message (unused)
 867  *          2  :  x = x coordinate of the mouse event
 868  *          3  :  y = y coordinate of the mouse event
 869  *
 870  * Returns     :  N/A
 871  *
 872  *********************************************************************/
 873 void OnLogRButtonUp(int nModifier, int x, int y)
 874 {
 875    HMENU hMenu = LoadMenu(g_hInstance, MAKEINTRESOURCE(IDR_POPUP_SELECTION));
 876    if (hMenu != NULL)
 877    {
 878       HMENU hMenuPopup = GetSubMenu(hMenu, 0);
 879
 880       /* Check if there is a selection */
 881       CHARRANGE range;
 882       SendMessage(g_hwndLogBox, EM_EXGETSEL, 0, (LPARAM) &range);
 883       if (range.cpMin == range.cpMax)
 884       {
 885          EnableMenuItem(hMenuPopup, ID_EDIT_COPY, MF_BYCOMMAND | MF_GRAYED);
 886       }
 887       else
 888       {
 889          EnableMenuItem(hMenuPopup, ID_EDIT_COPY, MF_BYCOMMAND | MF_ENABLED);
 890       }
 891
 892       /* Display the popup */
 893       TrackPopupMenu(hMenuPopup, TPM_LEFTALIGN | TPM_TOPALIGN | TPM_RIGHTBUTTON, x, y, 0, g_hwndLogFrame, NULL);
 894       DestroyMenu(hMenu);
 895    }
 896
 897 }
 898
 899
 900 /*********************************************************************
 901  *
 902  * Function    :  OnLogCommand
 903  *
 904  * Description :  Handler for WM_COMMAND messages.
 905  *
 906  * Parameters  :
 907  *          1  :  nCommand = the command portion of the menu selection event
 908  *
 909  * Returns     :  N/A
 910  *
 911  *********************************************************************/
 912 void OnLogCommand(int nCommand)
 913 {
 914    switch (nCommand)
 915    {
 916       case ID_TOGGLE_SHOWWINDOW:
 917          g_bShowLogWindow = !g_bShowLogWindow;
 918
 919          ShowLogWindow(g_bShowLogWindow);
 920          break;
 921
 922       case ID_FILE_EXIT:
 923          PostMessage(g_hwndLogFrame, WM_CLOSE, 0, 0);
 924          break;
 925
 926       case ID_EDIT_COPY:
 927          SendMessage(g_hwndLogBox, WM_COPY, 0, 0);
 928          break;
 929
 930       case ID_VIEW_CLEARLOG:
 931          SendMessage(g_hwndLogBox, WM_SETTEXT, 0, (LPARAM) "");
 932          break;
 933
 934       case ID_VIEW_LOGMESSAGES:
 935          g_bLogMessages = !g_bLogMessages;
 936          /* SaveLogSettings(); */
 937          break;
 938
 939       case ID_VIEW_MESSAGEHIGHLIGHTING:
 940          g_bHighlightMessages = !g_bHighlightMessages;
 941          /* SaveLogSettings(); */
 942          break;
 943
 944       case ID_VIEW_LIMITBUFFERSIZE:
 945          g_bLimitBufferSize = !g_bLimitBufferSize;
 946          /* SaveLogSettings(); */
 947          break;
 948
 949       case ID_VIEW_ACTIVITYANIMATION:
 950          g_bShowActivityAnimation = !g_bShowActivityAnimation;
 951          /* SaveLogSettings(); */
 952          break;
 953
 954 #ifdef FEATURE_TOGGLE
 955       case ID_TOGGLE_ENABLED:
 956          global_toggle_state = !global_toggle_state;
 957          log_error(LOG_LEVEL_INFO,
 958             "Now toggled %s", global_toggle_state ? "ON" : "OFF");
 959          /*
 960           * Leverage TIMER_ANIMSTOP_ID to set the idle icon through the
 961           * "application queue". According to MSDN, 10 milliseconds are
 962           * the lowest value possible and seem to be close enough to
 963           * "instantly".
 964           */
 965          SetTimer(g_hwndLogFrame, TIMER_ANIMSTOP_ID, 10, NULL);
 966          break;
 967 #endif /* def FEATURE_TOGGLE */
 968
 969       case ID_TOOLS_EDITCONFIG:
 970          EditFile(configfile);
 971          break;
 972
 973       case ID_TOOLS_EDITDEFAULTACTIONS:
 974          EditFile(g_default_actions_file);
 975          break;
 976
 977       case ID_TOOLS_EDITUSERACTIONS:
 978          EditFile(g_user_actions_file);
 979          break;
 980
 981       case ID_TOOLS_EDITDEFAULTFILTERS:
 982          EditFile(g_default_filterfile);
 983          break;
 984
 985       case ID_TOOLS_EDITUSERFILTERS:
 986          EditFile(g_user_filterfile);
 987          break;
 988
 989 #ifdef FEATURE_TRUST
 990       case ID_TOOLS_EDITTRUST:
 991          EditFile(g_trustfile);
 992          break;
 993 #endif /* def FEATURE_TRUST */
 994
 995       case ID_HELP_GPL:
 996          ShellExecute(g_hwndLogFrame, "open", "LICENSE.txt", NULL, NULL, SW_SHOWNORMAL);
 997          break;
 998
 999       case ID_HELP_FAQ:
1000          ShellExecute(g_hwndLogFrame, "open", "doc\\faq\\index.html", NULL, NULL, SW_SHOWNORMAL);
1001          break;
1002
1003       case ID_HELP_MANUAL:
1004          ShellExecute(g_hwndLogFrame, "open", "doc\\user-manual\\index.html", NULL, NULL, SW_SHOWNORMAL);
1005          break;
1006
1007       case ID_HELP_STATUS:
1008          ShellExecute(g_hwndLogFrame, "open", CGI_PREFIX "show-status", NULL, NULL, SW_SHOWNORMAL);
1009          break;
1010
1011       case ID_HELP_ABOUT:
1012          MessageBox(g_hwndLogFrame, win32_blurb, "About Privoxy", MB_OK);
1013          break;
1014
1015       default:
1016          /* DO NOTHING */
1017          break;
1018    }
1019
1020 }
1021
1022
1023 /*********************************************************************
1024  *
1025  * Function    :  OnLogInitMenu
1026  *
1027  * Description :  Handler for WM_INITMENU messages.  Enable, disable,
1028  *                check, and/or uncheck menu options as apropos.
1029  *
1030  * Parameters  :
1031  *          1  :  hmenu = handle to menu to "make current"
1032  *
1033  * Returns     :  N/A
1034  *
1035  *********************************************************************/
1036 void OnLogInitMenu(HMENU hmenu)
1037 {
1038    /* Only enable editors if there is a file to edit */
1039    EnableMenuItem(hmenu, ID_TOOLS_EDITDEFAULTACTIONS, MF_BYCOMMAND | (g_default_actions_file ? MF_ENABLED : MF_GRAYED));
1040    EnableMenuItem(hmenu, ID_TOOLS_EDITUSERACTIONS, MF_BYCOMMAND | (g_user_actions_file ? MF_ENABLED : MF_GRAYED));
1041    EnableMenuItem(hmenu, ID_TOOLS_EDITDEFAULTFILTERS, MF_BYCOMMAND | (g_default_filterfile ? MF_ENABLED : MF_GRAYED));
1042    EnableMenuItem(hmenu, ID_TOOLS_EDITUSERFILTERS, MF_BYCOMMAND | (g_user_filterfile ? MF_ENABLED : MF_GRAYED));
1043 #ifdef FEATURE_TRUST
1044    EnableMenuItem(hmenu, ID_TOOLS_EDITTRUST, MF_BYCOMMAND | (g_trustfile ? MF_ENABLED : MF_GRAYED));
1045 #endif /* def FEATURE_TRUST */
1046
1047    /* Check/uncheck options */
1048    CheckMenuItem(hmenu, ID_VIEW_LOGMESSAGES, MF_BYCOMMAND | (g_bLogMessages ? MF_CHECKED : MF_UNCHECKED));
1049    CheckMenuItem(hmenu, ID_VIEW_MESSAGEHIGHLIGHTING, MF_BYCOMMAND | (g_bHighlightMessages ? MF_CHECKED : MF_UNCHECKED));
1050    CheckMenuItem(hmenu, ID_VIEW_LIMITBUFFERSIZE, MF_BYCOMMAND | (g_bLimitBufferSize ? MF_CHECKED : MF_UNCHECKED));
1051    CheckMenuItem(hmenu, ID_VIEW_ACTIVITYANIMATION, MF_BYCOMMAND | (g_bShowActivityAnimation ? MF_CHECKED : MF_UNCHECKED));
1052 #ifdef FEATURE_TOGGLE
1053    /* by haroon - menu item for Enable toggle on/off */
1054    CheckMenuItem(hmenu, ID_TOGGLE_ENABLED, MF_BYCOMMAND | (global_toggle_state ? MF_CHECKED : MF_UNCHECKED));
1055 #endif /* def FEATURE_TOGGLE */
1056    CheckMenuItem(hmenu, ID_TOGGLE_SHOWWINDOW, MF_BYCOMMAND | (g_bShowLogWindow ? MF_CHECKED : MF_UNCHECKED));
1057
1058 }
1059
1060
1061 /*********************************************************************
1062  *
1063  * Function    :  OnLogTimer
1064  *
1065  * Description :  Handler for WM_TIMER messages.
1066  *
1067  * Parameters  :
1068  *          1  :  nTimer = timer id (animation start/stop or clip buffer)
1069  *
1070  * Returns     :  N/A
1071  *
1072  *********************************************************************/
1073 void OnLogTimer(int nTimer)
1074 {
1075    switch (nTimer)
1076    {
1077       case TIMER_ANIM_ID:
1078          TraySetIcon(g_hwndTray, 1, g_hiconAnim[g_nAnimFrame++ % ANIM_FRAMES]);
1079          break;
1080
1081       case TIMER_ANIMSTOP_ID:
1082          g_nAnimFrame = 0;
1083          SetIdleIcon();
1084          KillTimer(g_hwndLogFrame, TIMER_ANIM_ID);
1085          KillTimer(g_hwndLogFrame, TIMER_ANIMSTOP_ID);
1086          break;
1087
1088       case TIMER_CLIPBUFFER_ID:
1089       case TIMER_CLIPBUFFER_FORCE_ID:
1090          LogClipBuffer();
1091          g_bClipPending = FALSE;
1092          KillTimer(g_hwndLogFrame, TIMER_CLIPBUFFER_ID);
1093          KillTimer(g_hwndLogFrame, TIMER_CLIPBUFFER_FORCE_ID);
1094          break;
1095
1096       default:
1097          /* DO NOTHING */
1098          break;
1099    }
1100
1101 }
1102
1103
1104 /*********************************************************************
1105  *
1106  * Function    :  SetIdleIcon
1107  *
1108  * Description :  Sets the tray icon to either idle or off
1109  *
1110  * Parameters  :  none
1111  *
1112  * Returns     :  N/A
1113  *
1114  *********************************************************************/
1115 void SetIdleIcon()
1116 {
1117 #ifdef FEATURE_TOGGLE
1118          if (!global_toggle_state)
1119          {
1120             TraySetIcon(g_hwndTray, 1, g_hiconOff);
1121          }
1122          else
1123 #endif /* def FEATURE_TOGGLE */
1124          TraySetIcon(g_hwndTray, 1, g_hiconIdle);
1125 }
1126
1127
1128 /*********************************************************************
1129  *
1130  * Function    :  LogRichEditProc
1131  *
1132  * Description :  Window subclass routine handles some events for the rich edit control.
1133  *
1134  * Parameters  :
1135  *          1  :  hwnd = window handle of the rich edit control
1136  *          2  :  uMsg = message number
1137  *          3  :  wParam = first param for this message
1138  *          4  :  lParam = next param for this message
1139  *
1140  * Returns     :  Appropriate M$ window message handler codes.
1141  *
1142  *********************************************************************/
1143 LRESULT CALLBACK LogRichEditProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
1144 {
1145    switch (uMsg)
1146    {
1147       case WM_RBUTTONUP:
1148       {
1149          POINT pt;
1150          pt.x = LOWORD(lParam);
1151          pt.y = HIWORD(lParam);
1152          ClientToScreen(hwnd, &pt);
1153          OnLogRButtonUp(wParam, pt.x, pt.y);
1154          return 0;
1155       }
1156       case WM_CHAR:
1157       {
1158          if ((GetKeyState(VK_CONTROL) != 0) && (wParam == 4)) /* ctrl+d */
1159          {
1160              OnLogCommand(ID_VIEW_CLEARLOG);
1161              return 0;
1162          }
1163       }
1164    }
1165    return CallWindowProc(g_fnLogBox, hwnd, uMsg, wParam, lParam);
1166
1167 }
1168
1169
1170 /*********************************************************************
1171  *
1172  * Function    :  LogWindowProc
1173  *
1174  * Description :  Windows call back routine handles events on the log window.
1175  *
1176  * Parameters  :
1177  *          1  :  hwnd = handle of the logging window
1178  *          2  :  uMsg = message number
1179  *          3  :  wParam = first param for this message
1180  *          4  :  lParam = next param for this message
1181  *
1182  * Returns     :  Appropriate M$ window message handler codes.
1183  *
1184  *********************************************************************/
1185 LRESULT CALLBACK LogWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
1186 {
1187    switch (uMsg)
1188    {
1189       case WM_CREATE:
1190          return 0;
1191
1192       case WM_CLOSE:
1193          /* This is the end - my only friend - the end */
1194          DestroyWindow(g_hwndLogBox);
1195          DestroyWindow(g_hwndLogFrame);
1196          return 0;
1197
1198       case WM_DESTROY:
1199          PostQuitMessage(0);
1200          return 0;
1201
1202       case WM_SHOWWINDOW:
1203          g_bShowLogWindow = wParam;
1204       case WM_SIZE:
1205          /* Resize the logging window to fit the new frame */
1206          if (g_hwndLogBox)
1207          {
1208             RECT rc;
1209             GetClientRect(g_hwndLogFrame, &rc);
1210             SetWindowPos(g_hwndLogBox, NULL, rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top, SWP_NOZORDER);
1211          }
1212          return 0;
1213
1214       case WM_INITMENU:
1215          OnLogInitMenu((HMENU) wParam);
1216          return 0;
1217
1218       case WM_TIMER:
1219          OnLogTimer(wParam);
1220          return 0;
1221
1222       case WM_COMMAND:
1223          OnLogCommand(LOWORD(wParam));
1224          return 0;
1225
1226       case WM_SYSCOMMAND:
1227          switch (wParam)
1228          {
1229             case SC_CLOSE:
1230                if (g_bCloseHidesWindow)
1231                {
1232                   ShowLogWindow(FALSE);
1233                   return 0;
1234                }
1235                break;
1236             case SC_MINIMIZE:
1237                ShowLogWindow(FALSE);
1238                return 0;
1239          }
1240          break;
1241
1242       case WM_CHAR:
1243          if ((GetKeyState(VK_CONTROL) != 0) && (wParam == 4)) /* ctrl+d */
1244          {
1245              OnLogCommand(ID_VIEW_CLEARLOG);
1246              return 0;
1247          }
1248          break;
1249    }
1250
1251    return DefWindowProc(hwnd, uMsg, wParam, lParam);
1252
1253 }
1254
1255 #endif /* ndef _WIN_CONSOLE - entire file */
1256
1257 /*
1258   Local Variables:
1259   tab-width: 3
1260   end:
1261 */