Issue #4338, #3391 - Remove registered window class for the status bar

src/plugin/PluginClass.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 22 matching lines @@
 #include "Instances.h"
 #include <thread>
 #include <array>
 
 #ifdef DEBUG_HIDE_EL
 DWORD profileTime = 0;
 #endif
 
 extern CComModule _Module;
 
+// Status bar pane number
+#define STATUSBAR_PANE_NUMBER 2
+
 typedef HANDLE (WINAPI *OPENTHEMEDATA)(HWND, LPCWSTR);
 typedef HRESULT (WINAPI *DRAWTHEMEBACKGROUND)(HANDLE, HDC, INT, INT, LPRECT, LPRECT);
 typedef HRESULT (WINAPI *CLOSETHEMEDATA)(HANDLE);
 
 HICON CPluginClass::s_hIcons[ICON_MAX] = { NULL, NULL, NULL };
 DWORD CPluginClass::s_hIconTypes[ICON_MAX] = { IDI_ICON_DISABLED, IDI_ICON_ENABLED, IDI_ICON_DEACTIVATED };
 uint32_t iconHeight = 32;
 uint32_t iconWidth = 32;
 
 CPluginMimeFilterClient* CPluginClass::s_mimeFilter = NULL;
 
 CLOSETHEMEDATA pfnClose = NULL;
 DRAWTHEMEBACKGROUND pfnDrawThemeBackground = NULL;
 OPENTHEMEDATA pfnOpenThemeData = NULL;
 
-ATOM CPluginClass::s_atomPaneClass = NULL;
 HINSTANCE CPluginClass::s_hUxtheme = NULL;
 std::set<CPluginClass*> CPluginClass::s_instances;
 
 CComAutoCriticalSection CPluginClass::s_criticalSectionLocal;
 CComAutoCriticalSection CPluginClass::s_criticalSectionWindow;
 
 CComQIPtr<IWebBrowser2> CPluginClass::s_asyncWebBrowser2;
 
 namespace
 {
@@ skipping 624 matching lines @@
         }
       }
       else
       {
         DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_GET_UXTHEME, "Class::InitObject - GetModuleHandle(uxtheme.dll)");
       }
     }
   }
   s_criticalSectionLocal.Unlock();
 
-  // Register pane class
-  if (!GetAtomPaneClass())
-  {
-    WNDCLASSEX wcex;
-
-    wcex.cbSize = sizeof(wcex);
-    wcex.style = 0;
-    wcex.lpfnWndProc = (WNDPROC)PaneWindowProc;
-    wcex.cbClsExtra = 0;
-    wcex.cbWndExtra = 0;
-    wcex.hInstance = _Module.m_hInst;
-    wcex.hIcon = NULL;
-    wcex.hCursor = NULL;
-    wcex.hbrBackground = NULL;
-    wcex.lpszMenuName = NULL;
-    wcex.lpszClassName = STATUSBAR_PANE_NAME;
-    wcex.hIconSm = NULL;
-
-    s_criticalSectionLocal.Lock();
-    {
-      s_atomPaneClass = ::RegisterClassEx(&wcex);
-    }
-    s_criticalSectionLocal.Unlock();
-
-    if (!GetAtomPaneClass())
-    {
-      DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_REGISTER_PANE_CLASS, "Class::InitObject - RegisterClassEx");
-      return false;
-    }
-  }
-
   int ieVersion = AdblockPlus::IE::InstalledMajorVersion();
   // Create status pane
   if (ieVersion > 6 && !CreateStatusBarPane())
   {
     return false;
   }
   
   s_criticalSectionLocal.Lock();
   int versionCompRes = CPluginClient::GetInstance()->CompareVersions(CPluginClient::GetInstance()->GetPref(L"currentVersion", L"0.0"), L"1.2");
 
@@ skipping 25 matching lines @@
     // Enable acceptable ads by default
     std::wstring aaUrl = CPluginClient::GetInstance()->GetPref(L"subscriptions_exceptionsurl", L"");
     CPluginClient::GetInstance()->AddSubscription(aaUrl);
   }
   s_criticalSectionLocal.Unlock();
 
   DEBUG_GENERAL("InitObject - end");
   return true;
 }
 
+namespace
+{
+  /**
+   * Wrapper for Windows API 'SetWindowLongPtr()' to set a new window procedure
+   *
+   * Adds type safety and proper error handling over calling the API function directly.
+   */
+  DWORD SetWindowProc(HWND window, WNDPROC procedure)
+  {
+    /*
+     * Error handling for 'SetWindowLongPtr()' is not standard.
+     * The method below is as specified by its documentation.
+     */
+    SetLastError(0);
+    ::SetWindowLongPtr(window, GWLP_WNDPROC, reinterpret_cast<LONG_PTR>(procedure));
+    return ::GetLastError();
+  }
+}
+
 bool CPluginClass::CreateStatusBarPane()
 {
   CriticalSection::Lock lock(m_csStatusBar);
 
   CPluginClient* client = CPluginClient::GetInstance();
 
   std::array<wchar_t, MAX_PATH> className;
   // Get browser window and url
   HWND hBrowserWnd = GetBrowserHWND();
   if (!hBrowserWnd)
@@ skipping 106 matching lines @@
   {
 #ifdef _DEBUG
     m_nPaneWidth = 70;
 #else
     m_nPaneWidth = iconWidth;
 #endif
   }
   // Create pane window
   HWND hWndNewPane = ::CreateWindowEx(
     NULL,
-    MAKEINTATOM(GetAtomPaneClass()),
-    L"",
+    L"Edit", // predefined system class
+    L"ABPStatusBarPane",
     WS_CHILD | WS_VISIBLE | WS_CLIPSIBLINGS | WS_CLIPCHILDREN,
     rcStatusBar.Width() - 500, 0, m_nPaneWidth, rcStatusBar.Height(),
     hWndStatusBar,
     (HMENU)3671,
     _Module.m_hInst,
     NULL);
 
   if (!hWndNewPane)
   {
     DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_CREATE_STATUSBAR_PANE, "Class::CreateStatusBarPane - CreateWindowEx")
     return false;
   }
 
+  // Set window procedure to the one for status bars
+  auto error = SetWindowProc(hWndNewPane, CPluginClass::PaneWindowProc);
+  if (error)
+  {
+    DEBUG_ERROR_LOG(error, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_CREATE_STATUSBAR_PANE, "Class::SetStatusBarPaneWindowProc - SetWindowProc");
+    ::DestroyWindow(hWndNewPane);
+    return false;
+  }
+
   DEBUG_GENERAL("ABP window created");
   m_hTabWnd = hTabWnd;
   m_hStatusBarWnd = hWndStatusBar;
   m_hPaneWnd = hWndNewPane;
 
   UpdateTheme();
 
   // Subclass status bar
   m_pWndProcStatus = (WNDPROC)SetWindowLongPtr(hWndStatusBar, GWLP_WNDPROC, (LPARAM)(WNDPROC)NewStatusProc);
 
@@ skipping 132 matching lines @@
   return hMenuTrackPopup;
 }
 
 void CPluginClass::DisplayPluginMenu(HMENU hMenu, int nToolbarCmdID, POINT pt, UINT nMenuFlags)
 {
   CPluginClient* client = CPluginClient::GetInstance();
 
   // Create menu parent window
   HWND hMenuWnd = ::CreateWindowEx(
     NULL,
-    MAKEINTATOM(GetAtomPaneClass()),
-    L"",
+    L"Edit", // predefined system class
+    L"ABPStatusBarPopupMenu",
     0,
     0,0,0,0,
     NULL,
     NULL,
     _Module.m_hInst,
     NULL);
 
   if (!hMenuWnd)
   {
     DestroyMenu(hMenu);
     return;
   }
 
+  // Set window procedure to the one for status bars.
+  auto error = SetWindowProc(hMenuWnd, CPluginClass::PaneWindowProc);
+  if (error)
+  {
+    DEBUG_ERROR_LOG(error, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_CREATE_STATUSBAR_PANE, "Class::DisplayPluginMenu - SetWindowProc");
+    ::DestroyWindow(hMenuWnd);
+    return;
+  }
+
   // Display menu
   nMenuFlags |= TPM_NONOTIFY | TPM_RETURNCMD | TPM_LEFTBUTTON;
 
   int nCommand = ::TrackPopupMenu(hMenu, nMenuFlags, pt.x, pt.y, 0, hMenuWnd, 0);
 
   ::DestroyMenu(hMenu);
   ::DestroyWindow(hMenuWnd);
 
   switch (nCommand)
   {
@@ skipping 625 matching lines @@
         DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_LOAD_ICON, "Class::GetIcon - LoadIcon");
       }
     }
 
     icon = s_hIcons[type];
   }
   s_criticalSectionLocal.Unlock();
 
   return icon;
 }
-
-ATOM CPluginClass::GetAtomPaneClass()
-{
-  return s_atomPaneClass;
-}
-