Issue 119 - Switch to injecting CSS for element hiding

src/plugin/PluginClass.h

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2015 Eyeo GmbH
+ * 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
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
@@ skipping 53 matching lines @@
     SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_BEFORENAVIGATE2, OnBeforeNavigate2)
     SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_DOWNLOADCOMPLETE, OnDownloadComplete)
     SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_WINDOWSTATECHANGED, OnWindowStateChanged)
     SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_COMMANDSTATECHANGE, OnCommandStateChange)
     SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_ONQUIT, OnOnQuit)
   END_SINK_MAP()
 
   CPluginClass();
   ~CPluginClass();
 
-  HRESULT FinalConstruct();
-  void FinalRelease();
-
   // IObjectWithSite
-
   STDMETHOD(SetSite)(IUnknown *pUnkSite);
 
   // IOleCommandTarget
-
   STDMETHOD(QueryStatus)(const GUID* pguidCmdGroup, ULONG cCmds, OLECMD prgCmds[], OLECMDTEXT* pCmdText);
   STDMETHOD(Exec)(const GUID*, DWORD nCmdID, DWORD, VARIANTARG*, VARIANTARG* pvaOut);
 
 
   static CPluginTab* GetTab(DWORD dwThreadId);
   CPluginTab* GetTab();
 
   void UpdateStatusBar();
-  static DWORD WINAPI MainThreadProc(LPVOID pParam);
 
 private:
 
   bool SetMenuBar(HMENU hMenu, const std::wstring& url);
   HMENU CreatePluginMenu(const std::wstring& url);
 
   void DisplayPluginMenu(HMENU hMenu, int nToolbarCmdID, POINT pt, UINT nMenuFlags);
   bool CreateStatusBarPane();
 
 public:
   HWND GetBrowserHWND() const;
-  HWND GetTabHWND() const;
-  CComQIPtr<IWebBrowser2> GetBrowser() const;
-
+  bool IsRootBrowser(IWebBrowser2*);
 
   static CPluginMimeFilterClient* s_mimeFilter;
 
 private:
 
   std::wstring GetBrowserUrl() const;
 
   static DWORD WINAPI StartInitObject(LPVOID thisPtr);
   bool InitObject();
   void CloseTheme();
@@ skipping 15 matching lines @@
   void STDMETHODCALLTYPE OnDownloadComplete();
   void STDMETHODCALLTYPE OnWindowStateChanged(unsigned long flags, unsigned long validFlagsMask);
   void STDMETHODCALLTYPE OnCommandStateChange(long command, VARIANT_BOOL enable);
   void STDMETHODCALLTYPE OnOnQuit();
   void Unadvise();
   void EnsureWebBrowserConnected(const ATL::CComPtr<IWebBrowser2>& webBrowser);
 
   void ShowStatusBar();
   bool IsStatusBarEnabled();
 
-private:
   HWND m_hBrowserWnd;
   HWND m_hTabWnd;
   HWND m_hStatusBarWnd;
   HWND m_hPaneWnd;
   
   WNDPROC m_pWndProcStatus;
   int m_nPaneWidth;
   HANDLE m_hTheme;
   struct Data
   {
     std::map<IWebBrowser2*, WebBrowserEventsListener*> connectedWebBrowsersCache;

[sergei, 2016/02/25 17:48:27]

These raw pointers is another point here regarding `shared_ptr/weak_ptr`. I
don't like them but I doubt that we actually want to keep strong references to
child 'WebBrowser's because in that case we can leak heavy 'WebBrowser's.

That point deserves to be deeply investigated, however the current version can
be used, so far.

[sergei, 2016/02/26 08:34:51]

BTW, in addition we probably need to serialize the access to that map, I will
look into it.

[sergei, 2016/02/26 16:57:56]

According to my tests destructors of `WebBrowserEventsListener` are always
called from the same thread in which they have been constructed, BTW it is the
same from which `SetSite` is called.

     std::unique_ptr<CPluginTab> tab;
     ATL::CComPtr<IWebBrowser2> webBrowser2;
   };
   // we need to have it as a shared pointer to get weak pointer to it to avoid
   // wrong usage after destroying of this class.
   std::shared_ptr<Data> m_data;

[Eric, 2015/12/02 17:00:14]

This struct looks like a Very Bad Idea.

If we get our lifetime management correct, there won't be any issue about events
coming in to non-existent objects, and thus a weak pointer won't be needed at
all.

[sergei, 2016/02/25 17:48:27]

It's not about events coming to non-existing objects.

I have observed that there is a race condition in IE regarding the destroying of
'WebBrowser's, even though `m_data` is destroyed (which happens only in
`~CPluginClass`) instances of `WebBrowserEventsListener` are still alive. It
means that our plugin is already destroyed but child 'WebBrowser's are still
alive.

Beside the comment above regarding raw pointers, we can definitely try to listen
to DISPID_ONQUIT from children and unsubscribe our `WebBrowserEventsListener` or
unsubscribe them when our plugin is being destroyed. However, it seems, in that
case the code will be merely more sophisticated. For example, it can happen that
DISPID_ONQUIT events from children come during unsubscribing operation, so we
need to serialize this part, it means again more locks and yet one "global"
variable.

So to operate safely and easier I'm using shared_ptr/weak_ptr.

We can definitely try to elaborate it, but I guess it would be better to make
later.
@Oleksandr?

 
   CriticalSection m_csStatusBar;
 
   NotificationMessage notificationMessage;
 
   bool m_isAdvised;
   bool m_isInitializedOk;
 
   // Atom pane class
   static ATOM s_atomPaneClass;
 
   static ATOM GetAtomPaneClass();
 
   // Icons
   static HICON s_hIcons[ICON_MAX];
   static DWORD s_hIconTypes[ICON_MAX];
 
   static HICON GetIcon(int type);
 
   // Main thread
   static HANDLE s_hMainThread;
   static bool s_isMainThreadDone;
 
-  static HANDLE GetMainThreadHandle();
-  static bool IsMainThreadDone(HANDLE mainThread);
-
   static HINSTANCE s_hUxtheme;
   static std::set<CPluginClass*> s_instances;
   static std::map<DWORD,CPluginClass*> s_threadInstances;
   static CComAutoCriticalSection s_criticalSectionLocal;
-  static CComAutoCriticalSection s_criticalSectionBrowser;
   static CComAutoCriticalSection s_criticalSectionWindow;
 
   // Async browser
   static CComQIPtr<IWebBrowser2> s_asyncWebBrowser2;
   static CComQIPtr<IWebBrowser2> GetAsyncBrowser();
 };
 
 OBJECT_ENTRY_AUTO(__uuidof(PluginClass), CPluginClass)
 
 
 #endif // _PLUGIN_CLASS_H_