First run page triggering

src/plugin/PluginClass.cpp

 #include "PluginStdAfx.h"
 
 #include "PluginClass.h"
 #include "PluginSettings.h"
 #include "PluginSystem.h"
 #ifdef SUPPORT_FILTER
 #include "PluginFilter.h"
 #endif
 #include "PluginMimeFilterClient.h"
 #include "PluginClient.h"
@@ skipping 205 matching lines @@
 
 DWORD WINAPI CPluginClass::StartInitObject(LPVOID thisPtr)
 {
   if (thisPtr == NULL)
     return 0;
   if (!((CPluginClass*)thisPtr)->InitObject(true))
   {
     ((CPluginClass*)thisPtr)->Unadvice();
   }
 
-  if ((((CPluginClass*)thisPtr)->m_hPaneWnd == NULL) || (!((CPluginClass*)thisPtr)->IsStatusBarEnabled()))
-  {
-    ((CPluginClass*)thisPtr)->ShowStatusBar();
-  }
   return 0;
 }
 
 
 
 // This gets called when a new browser window is created (which also triggers the
 // creation of this object). The pointer passed in should be to a IWebBrowser2
 // interface that represents the browser for the window.
 // it is also called when a tab is closed, this unknownSite will be null
 // so we should handle that it is called this way several times during a session
@@ skipping 180 matching lines @@
       }
     }
   }
   return trueth == 1;
 }
 
 void CPluginClass::ShowStatusBar()
 {
   VARIANT_BOOL isVisible;
 
-  CPluginSettings* settings = CPluginSettings::GetInstance();
 
   CComQIPtr<IWebBrowser2> browser = GetAsyncBrowser();
   if (browser)
   {
     HRESULT hr = S_OK;
     hr = browser->get_StatusBar(&isVisible);
     if (SUCCEEDED(hr))
     {
       if (!isVisible)
       {
-        if (!settings->GetStatusBarAsked())
+        SHANDLE_PTR pBrowserHWnd;
+        browser->get_HWND((SHANDLE_PTR*)&pBrowserHWnd);
+        Dictionary* dictionary = Dictionary::GetInstance();
+
+        HKEY pHkey;
+        HKEY pHkeySub;
+        LSTATUS regRes = 0;
+        regRes = RegOpenCurrentUser(KEY_WRITE, &pHkey);
+
+        // Do we have enough rights to enable a status bar?
+        if (regRes != 0)
         {
-          SHANDLE_PTR pBrowserHWnd;
-          browser->get_HWND((SHANDLE_PTR*)&pBrowserHWnd);
-          Dictionary* dictionary = Dictionary::GetInstance();
-          settings->SetStatusBarAsked();
-
-          HKEY pHkey;
-          HKEY pHkeySub;
-          LSTATUS regRes = 0;
-          regRes = RegOpenCurrentUser(KEY_WRITE, &pHkey);
-
-          // Do we have enough rights to enable a status bar?
-          if (regRes != 0)
+          // We use the tab window here and in the next few calls, since the browser window may still not be available
+          LRESULT res = MessageBox((HWND)m_hTabWnd,
+              dictionary->Lookup("status-bar", "error-text").c_str(),
+              dictionary->Lookup("status-bar", "error-title").c_str(),
+              MB_OK);
+          return;
+        }
+        // Ask if a user wants to enable a status bar automatically
+        LRESULT res = MessageBox((HWND)m_hTabWnd,
+            dictionary->Lookup("status-bar", "question").c_str(),
+            dictionary->Lookup("status-bar", "title").c_str(),
+            MB_YESNO);
+        if (res == IDYES)
+        {
+          DWORD trueth = 1;
+          regRes = RegOpenKey(pHkey, L"Software\\Microsoft\\Internet Explorer\\MINIE", &pHkeySub);
+          regRes = RegSetValueEx(pHkeySub, L"ShowStatusBar", 0, REG_DWORD, (BYTE*)&trueth, sizeof(DWORD));
+          regRes = RegCloseKey(pHkeySub);
+          regRes = RegOpenKey(pHkey, L"Software\\Microsoft\\Internet Explorer\\Main", &pHkeySub);
+          regRes = RegSetValueEx(pHkeySub, L"StatusBarWeb", 0, REG_DWORD, (BYTE*)&trueth, sizeof(DWORD));
+          regRes = RegCloseKey(pHkeySub);
+          hr = browser->put_StatusBar(TRUE);
+          if (FAILED(hr))
           {
-            // We use the tab window here and in the next few calls, since the browser window may still not be available
-            LRESULT res = MessageBox((HWND)m_hTabWnd,
-                dictionary->Lookup("status-bar", "error-text").c_str(),
-                dictionary->Lookup("status-bar", "error-title").c_str(),
-                MB_OK);
-            return;
+            DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_PUT_STATUSBAR, "Class::Enable statusbar");
           }
-          // Ask if a user wants to enable a status bar automatically
-          LRESULT res = MessageBox((HWND)m_hTabWnd,
-              dictionary->Lookup("status-bar", "question").c_str(),
-              dictionary->Lookup("status-bar", "title").c_str(),
-              MB_YESNO);
-          if (res == IDYES)
+          CreateStatusBarPane();
+
+          // We need to restart the tab now, to enable the status bar properly
+          VARIANT vFlags;
+          vFlags.vt = VT_I4;
+          vFlags.intVal = navOpenInNewTab;
+
+          CComBSTR curLoc;
+          browser->get_LocationURL(&curLoc);
+          HRESULT hr = browser->Navigate(curLoc, &vFlags, NULL, NULL, NULL);
+          if (FAILED(hr))
           {
-            DWORD trueth = 1;
-            regRes = RegOpenKey(pHkey, L"Software\\Microsoft\\Internet Explorer\\MINIE", &pHkeySub);
-            regRes = RegSetValueEx(pHkeySub, L"ShowStatusBar", 0, REG_DWORD, (BYTE*)&trueth, sizeof(DWORD));
-            regRes = RegCloseKey(pHkeySub);
-            regRes = RegOpenKey(pHkey, L"Software\\Microsoft\\Internet Explorer\\Main", &pHkeySub);
-            regRes = RegSetValueEx(pHkeySub, L"StatusBarWeb", 0, REG_DWORD, (BYTE*)&trueth, sizeof(DWORD));
-            regRes = RegCloseKey(pHkeySub);
-            hr = browser->put_StatusBar(TRUE);
+            vFlags.intVal = navOpenInNewWindow;
+
+            hr = browser->Navigate(CComBSTR(curLoc), &vFlags, NULL, NULL, NULL);
             if (FAILED(hr))
             {
-              DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_PUT_STATUSBAR, "Class::Enable statusbar");
+              DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_NAVIGATION, PLUGIN_ERROR_NAVIGATION, "Navigation::Failed")
             }
-            CreateStatusBarPane();
-
-            // We need to restart the tab now, to enable the status bar properly
-            VARIANT vFlags;
-            vFlags.vt = VT_I4;
-            vFlags.intVal = navOpenInNewTab;
-
-            CComBSTR curLoc;
-            browser->get_LocationURL(&curLoc);
-            HRESULT hr = browser->Navigate(curLoc, &vFlags, NULL, NULL, NULL);
-            if (FAILED(hr))
-            {
-              vFlags.intVal = navOpenInNewWindow;
-
-              hr = browser->Navigate(CComBSTR(curLoc), &vFlags, NULL, NULL, NULL);
-              if (FAILED(hr))
-              {
-                DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_NAVIGATION, PLUGIN_ERROR_NAVIGATION, "Navigation::Failed")
-              }
-            }
-            browser->Quit();
-
           }
+          browser->Quit();
         }
       }
     }
     else
     {
       DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_GET_STATUSBAR, "Class::Get statusbar state");
     }
   }
 }
 
@@ skipping 300 matching lines @@
 
   // Create status pane
   if (bBHO)
   {
     if (!CreateStatusBarPane())
     {
       return false;
     }
   }
 
+  if (CPluginClient::GetInstance()->IsFirstRun())
+  {   
+    CreateThread(NULL, NULL, (LPTHREAD_START_ROUTINE)CPluginClass::FirstRunThread, NULL, NULL, NULL);
+    if ((m_hPaneWnd == NULL) || (!IsStatusBarEnabled()))
+    {
+      ShowStatusBar();
+    }
+
+  }
+
   CPluginSettings* settings = CPluginSettings::GetInstance();
   return true;
 }
 
 bool CPluginClass::CreateStatusBarPane()
 {
   DEBUG_GENERAL(L"Getting client");
 
   CPluginClient* client = CPluginClient::GetInstance();
 
@@ skipping 157 matching lines @@
 
     ::SendMessage(m_hStatusBarWnd, SB_GETPARTS, nPartCount, (LPARAM)pData);
     ::SendMessage(m_hStatusBarWnd, SB_SETPARTS, nPartCount, (LPARAM)pData);
 
     delete[] pData;
   }
   HDC hdc = GetWindowDC(m_hStatusBarWnd);
   SendMessage(m_hStatusBarWnd, WM_PAINT, (WPARAM)hdc, 0);
   ReleaseDC(m_hStatusBarWnd, hdc);
 
-  if (CPluginClient::GetInstance()->GetIsFirstRun())

[Wladimir Palant, 2013/07/11 11:58:10]

Is CreateStatusBarPane() really the best place for this code? For example, what
about IE6, don't we want to show the first-run page there? Also, won't this code
run twice on some occasions?

From what I understand, this belongs into CPluginClass::InitObject(). Also, we
need to ensure that this code only runs once, no matter how many processes are
created. That's best to be done in the engine - rename the call into something
like PROC_FIRST_RUN_ACTIONS_NEEDED and have it return true only the first time
it is called (critical section required here).

-  {   
-    CreateThread(NULL, NULL, (LPTHREAD_START_ROUTINE)CPluginClass::FirstRunThread, NULL, NULL, NULL);
-  }
-
   return true;
 }
 
 void CPluginClass::FirstRunThread()
 {
-  // IE may still be not ready to navigate. Try until it is.
-  VARIANT_BOOL isBusy = VARIANT_FALSE;
-  while (GetAsyncBrowser()->get_Busy(&isBusy) == S_OK && isBusy != VARIANT_FALSE)
-  {
-    Sleep(100);
-  }
+  CoInitialize(NULL);
   VARIANT vFlags;
   vFlags.vt = VT_I4;
   vFlags.intVal = navOpenInNewTab;
 
-  READYSTATE readyState;
-  HRESULT hr;
-  while ((hr = GetAsyncBrowser()->get_ReadyState(&readyState) == S_OK) && (readyState <= READYSTATE_LOADED))

[Wladimir Palant, 2013/07/11 11:58:10]

We are opening in a new tab, why do we care about the ready state of the current
page?

-  {
-    Sleep(100);
-  }
-  CComBSTR bTest = CComBSTR(UserSettingsFirstRunPageUrl().c_str());
+  CComBSTR navigatePath = CComBSTR(FirstRunPageFileUrl().c_str());
   
-  //Try 10 times, or until successful
-  int numberOfAttempts = 0;
-  while ((hr != S_OK) && (numberOfAttempts < 10))
-  {
-    hr = GetAsyncBrowser()->Navigate(bTest, &vFlags, NULL, NULL, NULL);
-    if (FAILED(hr))
-    {
-      vFlags.intVal = navOpenInNewWindow;
-
-      hr = GetAsyncBrowser()->Navigate(bTest, &vFlags, NULL, NULL, NULL);
-      if (FAILED(hr))
-      {
-        DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_NAVIGATION, PLUGIN_ERROR_NAVIGATION_SETTINGS, "Navigation::Failed")

[Wladimir Palant, 2013/07/11 11:58:10]

This should probably be PLUGIN_ERROR_NAVIGATION_WELCOME rather than
PLUGIN_ERROR_NAVIGATION_SETTINGS. Either way, do we really need all these debug
messages? Wouldn't one be sufficient, after 10 failed attempts?

-      }
-    }
-    Sleep(100);
-  }

[Wladimir Palant, 2013/07/11 11:58:10]

Does it really have to be that complicated? No other occasions where we open a
new tab take special precautions. If they are necessary then we probably should
create a helper function to open a tab and use it consistently. If not - well...

[Oleksandr, 2013/07/20 20:22:30]

This turned out to be unnecessary after all. I've been having issues with
Navigate failing, but it turned out for a completely different reason. All works
fine like this.
On 2013/07/11 11:58:10, Wladimir Palant wrote:

+  HRESULT hr = GetAsyncBrowser()->Navigate(navigatePath, &vFlags, NULL, NULL, NULL);
+  if (FAILED(hr))
+  {
+    vFlags.intVal = navOpenInNewWindow;
+    hr = GetAsyncBrowser()->Navigate(navigatePath, &vFlags, NULL, NULL, NULL);
+  }
+
   if (FAILED(hr))
   {
     DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_NAVIGATION, PLUGIN_ERROR_NAVIGATION_WELCOME, "Navigation::Welcome page failed")
   }
 }
 void CPluginClass::CloseTheme()
 {
   if (m_hTheme)
   {
     if (pfnClose)
@@ skipping 872 matching lines @@
         }
       }
     }
 
     hTabWnd = ::GetWindow(hTabWnd, GW_HWNDNEXT);
   }
 
   return hTabWnd;
 
 }