Convert IJS_Runtime to CPDFSDK_FormFillEnvironment

fpdfsdk/javascript/app.cpp

 // Copyright 2014 PDFium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #include "fpdfsdk/javascript/app.h"
 
 #include <memory>
 #include <vector>
 
 #include "fpdfsdk/cpdfsdk_document.h"
 #include "fpdfsdk/cpdfsdk_formfillenvironment.h"
 #include "fpdfsdk/cpdfsdk_interform.h"
 #include "fpdfsdk/javascript/Document.h"
 #include "fpdfsdk/javascript/JS_Define.h"
 #include "fpdfsdk/javascript/JS_EventHandler.h"
 #include "fpdfsdk/javascript/JS_Object.h"
 #include "fpdfsdk/javascript/JS_Value.h"
 #include "fpdfsdk/javascript/cjs_context.h"
 #include "fpdfsdk/javascript/cjs_runtime.h"
 #include "fpdfsdk/javascript/resource.h"
 #include "third_party/base/stl_util.h"
 
 class GlobalTimer {
  public:
   GlobalTimer(app* pObj,
-              CPDFSDK_FormFillEnvironment* pEnv,
+              CPDFSDK_FormFillEnvironment* pFormFillEnv,
               CJS_Runtime* pRuntime,
               int nType,
               const CFX_WideString& script,
               uint32_t dwElapse,
               uint32_t dwTimeOut);
   ~GlobalTimer();
 
   static void Trigger(int nTimerID);
   static void Cancel(int nTimerID);
 
   bool IsOneShot() const { return m_nType == 1; }
   uint32_t GetTimeOut() const { return m_dwTimeOut; }
   int GetTimerID() const { return m_nTimerID; }
   CJS_Runtime* GetRuntime() const { return m_pRuntime.Get(); }
   CFX_WideString GetJScript() const { return m_swJScript; }
 
  private:
   using TimerMap = std::map<uint32_t, GlobalTimer*>;
   static TimerMap* GetGlobalTimerMap();
 
   uint32_t m_nTimerID;
   app* const m_pEmbedObj;
   bool m_bProcessing;
 
   // data
   const int m_nType;  // 0:Interval; 1:TimeOut
   const uint32_t m_dwTimeOut;
   const CFX_WideString m_swJScript;
   CJS_Runtime::ObservedPtr m_pRuntime;
-  CPDFSDK_FormFillEnvironment* const m_pEnv;
+  CPDFSDK_FormFillEnvironment* const m_pFormFillEnv;
 };
 
 GlobalTimer::GlobalTimer(app* pObj,
-                         CPDFSDK_FormFillEnvironment* pEnv,
+                         CPDFSDK_FormFillEnvironment* pFormFillEnv,
                          CJS_Runtime* pRuntime,
                          int nType,
                          const CFX_WideString& script,
                          uint32_t dwElapse,
                          uint32_t dwTimeOut)
     : m_nTimerID(0),
       m_pEmbedObj(pObj),
       m_bProcessing(false),
       m_nType(nType),
       m_dwTimeOut(dwTimeOut),
       m_swJScript(script),
       m_pRuntime(pRuntime),
-      m_pEnv(pEnv) {
-  CFX_SystemHandler* pHandler = m_pEnv->GetSysHandler();
+      m_pFormFillEnv(pFormFillEnv) {
+  CFX_SystemHandler* pHandler = m_pFormFillEnv->GetSysHandler();
   m_nTimerID = pHandler->SetTimer(dwElapse, Trigger);
   (*GetGlobalTimerMap())[m_nTimerID] = this;
 }
 
 GlobalTimer::~GlobalTimer() {
   if (!m_nTimerID)
     return;
 
   if (GetRuntime())
-    m_pEnv->GetSysHandler()->KillTimer(m_nTimerID);
+    m_pFormFillEnv->GetSysHandler()->KillTimer(m_nTimerID);
 
   GetGlobalTimerMap()->erase(m_nTimerID);
 }
 
 // static
 void GlobalTimer::Trigger(int nTimerID) {
   auto it = GetGlobalTimerMap()->find(nTimerID);
   if (it == GetGlobalTimerMap()->end())
     return;
 
@@ skipping 113 matching lines @@
 app::~app() {
 }
 
 FX_BOOL app::activeDocs(IJS_Context* cc,
                         CJS_PropValue& vp,
                         CFX_WideString& sError) {
   if (!vp.IsGetting())
     return FALSE;
 
   CJS_Context* pContext = (CJS_Context*)cc;
-  CPDFSDK_FormFillEnvironment* pFormFillEnv = pContext->GetFormFillEnv();
   CJS_Runtime* pRuntime = pContext->GetJSRuntime();
-  CPDFSDK_Document* pCurDoc = pContext->GetJSRuntime()->GetReaderDocument();
+  CJS_Document* pJSDocument = nullptr;
+  v8::Local<v8::Object> pObj = pRuntime->GetThisObj();
+  if (CFXJS_Engine::GetObjDefnID(pObj) == CJS_Document::g_nObjDefnID) {
+    pJSDocument = static_cast<CJS_Document*>(pRuntime->GetObjectPrivate(pObj));
+  }
+
   CJS_Array aDocs;
-  if (CPDFSDK_Document* pDoc = pFormFillEnv->GetSDKDocument()) {
-    CJS_Document* pJSDocument = nullptr;
-    if (pDoc == pCurDoc) {

[dsinclair, 2016/10/11 17:37:45]

As far as I can tell, these should always be equal.  The context gets its
environment from the runtime. So, those two documents should be the same.

-      v8::Local<v8::Object> pObj = pRuntime->GetThisObj();
-      if (CFXJS_Engine::GetObjDefnID(pObj) == CJS_Document::g_nObjDefnID) {
-        pJSDocument =
-            static_cast<CJS_Document*>(pRuntime->GetObjectPrivate(pObj));
-      }
-    } else {
-      v8::Local<v8::Object> pObj =
-          pRuntime->NewFxDynamicObj(CJS_Document::g_nObjDefnID);
-      pJSDocument =
-          static_cast<CJS_Document*>(pRuntime->GetObjectPrivate(pObj));
-      ASSERT(pJSDocument);
-    }
-    aDocs.SetElement(pRuntime, 0, CJS_Value(pRuntime, pJSDocument));
-  }
+  aDocs.SetElement(pRuntime, 0, CJS_Value(pRuntime, pJSDocument));
+
   if (aDocs.GetLength(pRuntime) > 0)
     vp << aDocs;
   else
     vp.GetJSValue()->SetNull(pRuntime);
 
   return TRUE;
 }
 
 FX_BOOL app::calculate(IJS_Context* cc,
                        CJS_PropValue& vp,
@@ skipping 64 matching lines @@
   vp << JS_NUM_VIEWERVERSION;
   return TRUE;
 }
 
 FX_BOOL app::platform(IJS_Context* cc,
                       CJS_PropValue& vp,
                       CFX_WideString& sError) {
   if (!vp.IsGetting())
     return FALSE;
 #ifdef PDF_ENABLE_XFA
-  CPDFSDK_FormFillEnvironment* pEnv =
-      static_cast<CJS_Context*>(cc)->GetJSRuntime()->GetReaderEnv();
-  if (!pEnv)
+  CPDFSDK_FormFillEnvironment* pFormFillEnv =
+      static_cast<CJS_Context*>(cc)->GetJSRuntime()->GetFormFillEnv();
+  if (!pFormFillEnv)
     return FALSE;
-  CFX_WideString platfrom = pEnv->GetPlatform();
+  CFX_WideString platfrom = pFormFillEnv->GetPlatform();
   if (!platfrom.IsEmpty()) {
     vp << platfrom;
     return TRUE;
   }
 #endif
   vp << JS_STR_PLATFORM;
   return TRUE;
 }
 
 FX_BOOL app::language(IJS_Context* cc,
                       CJS_PropValue& vp,
                       CFX_WideString& sError) {
   if (!vp.IsGetting())
     return FALSE;
 #ifdef PDF_ENABLE_XFA
-  CPDFSDK_FormFillEnvironment* pEnv =
-      static_cast<CJS_Context*>(cc)->GetJSRuntime()->GetReaderEnv();
-  if (!pEnv)
+  CPDFSDK_FormFillEnvironment* pFormFillEnv =
+      static_cast<CJS_Context*>(cc)->GetJSRuntime()->GetFormFillEnv();
+  if (!pFormFillEnv)
     return FALSE;
-  CFX_WideString language = pEnv->GetLanguage();
+  CFX_WideString language = pFormFillEnv->GetLanguage();
   if (!language.IsEmpty()) {
     vp << language;
     return TRUE;
   }
 #endif
   vp << JS_STR_LANGUANGE;
   return TRUE;
 }
 
 // creates a new fdf object that contains no data
@@ skipping 26 matching lines @@
                    CFX_WideString& sError) {
   CJS_Runtime* pRuntime = CJS_Runtime::FromContext(cc);
   std::vector<CJS_Value> newParams = JS_ExpandKeywordParams(
       pRuntime, params, 4, L"cMsg", L"nIcon", L"nType", L"cTitle");
 
   if (newParams[0].GetType() == CJS_Value::VT_unknown) {
     sError = JSGetStringFromID(IDS_STRING_JSPARAMERROR);
     return FALSE;
   }
 
-  CPDFSDK_FormFillEnvironment* pEnv = pRuntime->GetReaderEnv();
-  if (!pEnv) {
+  CPDFSDK_FormFillEnvironment* pFormFillEnv = pRuntime->GetFormFillEnv();
+  if (!pFormFillEnv) {
     vRet = CJS_Value(pRuntime, 0);
     return TRUE;
   }
 
   CFX_WideString swMsg;
   if (newParams[0].GetType() == CJS_Value::VT_object) {
     CJS_Array carray;
     if (newParams[0].ConvertToArray(pRuntime, carray)) {
       swMsg = L"[";
       CJS_Value element(pRuntime);
@@ skipping 19 matching lines @@
   if (newParams[2].GetType() != CJS_Value::VT_unknown)
     iType = newParams[2].ToInt(pRuntime);
 
   CFX_WideString swTitle;
   if (newParams[3].GetType() != CJS_Value::VT_unknown)
     swTitle = newParams[3].ToCFXWideString(pRuntime);
   else
     swTitle = JSGetStringFromID(IDS_STRING_JSALERT);
 
   pRuntime->BeginBlock();
-  pEnv->GetSDKDocument()->KillFocusAnnot(0);
+  pFormFillEnv->GetSDKDocument()->KillFocusAnnot(0);
 
-  vRet = CJS_Value(pRuntime, pEnv->JS_appAlert(swMsg.c_str(), swTitle.c_str(),
-                                               iType, iIcon));
+  vRet = CJS_Value(pRuntime, pFormFillEnv->JS_appAlert(
+                                 swMsg.c_str(), swTitle.c_str(), iType, iIcon));
   pRuntime->EndBlock();
   return TRUE;
 }
 
 FX_BOOL app::beep(IJS_Context* cc,
                   const std::vector<CJS_Value>& params,
                   CJS_Value& vRet,
                   CFX_WideString& sError) {
   if (params.size() == 1) {
     CJS_Runtime* pRuntime = CJS_Runtime::FromContext(cc);
-    CPDFSDK_FormFillEnvironment* pEnv = pRuntime->GetReaderEnv();
-    pEnv->JS_appBeep(params[0].ToInt(pRuntime));
+    pRuntime->GetFormFillEnv()->JS_appBeep(params[0].ToInt(pRuntime));
     return TRUE;
   }
 
   sError = JSGetStringFromID(IDS_STRING_JSPARAMERROR);
   return FALSE;
 }
 
 FX_BOOL app::findComponent(IJS_Context* cc,
                            const std::vector<CJS_Value>& params,
                            CJS_Value& vRet,
@@ skipping 23 matching lines @@
 
   CJS_Runtime* pRuntime = CJS_Runtime::FromContext(cc);
   CFX_WideString script =
       params.size() > 0 ? params[0].ToCFXWideString(pRuntime) : L"";
   if (script.IsEmpty()) {
     sError = JSGetStringFromID(IDS_STRING_JSAFNUMBER_KEYSTROKE);
     return TRUE;
   }
 
   uint32_t dwInterval = params.size() > 1 ? params[1].ToInt(pRuntime) : 1000;
-  CPDFSDK_FormFillEnvironment* pEnv = pRuntime->GetReaderEnv();
 
-  GlobalTimer* timerRef =
-      new GlobalTimer(this, pEnv, pRuntime, 0, script, dwInterval, 0);
+  GlobalTimer* timerRef = new GlobalTimer(this, pRuntime->GetFormFillEnv(),
+                                          pRuntime, 0, script, dwInterval, 0);
   m_Timers.insert(std::unique_ptr<GlobalTimer>(timerRef));
 
   v8::Local<v8::Object> pRetObj =
       pRuntime->NewFxDynamicObj(CJS_TimerObj::g_nObjDefnID);
   CJS_TimerObj* pJS_TimerObj =
       static_cast<CJS_TimerObj*>(pRuntime->GetObjectPrivate(pRetObj));
   TimerObj* pTimerObj = static_cast<TimerObj*>(pJS_TimerObj->GetEmbedObject());
   pTimerObj->SetTimer(timerRef);
 
   vRet = CJS_Value(pRuntime, pRetObj);
@@ skipping 10 matching lines @@
   }
 
   CJS_Runtime* pRuntime = CJS_Runtime::FromContext(cc);
   CFX_WideString script = params[0].ToCFXWideString(pRuntime);
   if (script.IsEmpty()) {
     sError = JSGetStringFromID(IDS_STRING_JSAFNUMBER_KEYSTROKE);
     return TRUE;
   }
 
   uint32_t dwTimeOut = params.size() > 1 ? params[1].ToInt(pRuntime) : 1000;
-  CPDFSDK_FormFillEnvironment* pEnv = pRuntime->GetReaderEnv();
-
   GlobalTimer* timerRef =
-      new GlobalTimer(this, pEnv, pRuntime, 1, script, dwTimeOut, dwTimeOut);
+      new GlobalTimer(this, pRuntime->GetFormFillEnv(), pRuntime, 1, script,
+                      dwTimeOut, dwTimeOut);
   m_Timers.insert(std::unique_ptr<GlobalTimer>(timerRef));
 
   v8::Local<v8::Object> pRetObj =
       pRuntime->NewFxDynamicObj(CJS_TimerObj::g_nObjDefnID);
 
   CJS_TimerObj* pJS_TimerObj =
       static_cast<CJS_TimerObj*>(pRuntime->GetObjectPrivate(pRetObj));
 
   TimerObj* pTimerObj = static_cast<TimerObj*>(pJS_TimerObj->GetEmbedObject());
   pTimerObj->SetTimer(timerRef);
@@ skipping 269 matching lines @@
 FX_BOOL app::media(IJS_Context* cc, CJS_PropValue& vp, CFX_WideString& sError) {
   return FALSE;
 }
 
 FX_BOOL app::execDialog(IJS_Context* cc,
                         const std::vector<CJS_Value>& params,
                         CJS_Value& vRet,
                         CFX_WideString& sError) {
   return TRUE;
 }