fpdfsdk/include/fsdk_actionhandler.h

// 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

#ifndef FPDFSDK_INCLUDE_FSDK_ACTIONHANDLER_H_
#define FPDFSDK_INCLUDE_FSDK_ACTIONHANDLER_H_

#include <memory>
#include <set>

#include "core/include/fpdfdoc/fpdf_doc.h"
#include "core/include/fxcrt/fx_string.h"
#include "fsdk_baseform.h"

class CPDFSDK_Annot;
class CPDFSDK_Document;
class CPDF_Bookmark;
class CPDF_Dictionary;

class CPDFSDK_FormActionHandler {
 public:
  FX_BOOL DoAction_Hide(const CPDF_Action& action, CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_SubmitForm(const CPDF_Action& action,
                              CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_ResetForm(const CPDF_Action& action,
                             CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_ImportData(const CPDF_Action& action,
                              CPDFSDK_Document* pDocument);
};

class CPDFSDK_ActionHandler {
 public:
  CPDFSDK_ActionHandler();

  FX_BOOL DoAction_DocOpen(const CPDF_Action& action,
                           CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_JavaScript(const CPDF_Action& JsAction,
                              CFX_WideString csJSName,
                              CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_Page(const CPDF_Action& action,
                        enum CPDF_AAction::AActionType eType,
                        CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_Document(const CPDF_Action& action,
                            enum CPDF_AAction::AActionType eType,
                            CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_BookMark(CPDF_Bookmark* pBookMark,
                            const CPDF_Action& action,
                            CPDF_AAction::AActionType type,
                            CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_Screen(const CPDF_Action& action,
                          CPDF_AAction::AActionType type,
                          CPDFSDK_Document* pDocument,
                          CPDFSDK_Annot* pScreen);
  FX_BOOL DoAction_Link(const CPDF_Action& action, CPDFSDK_Document* pDocument);
  FX_BOOL DoAction_Field(const CPDF_Action& action,
                         CPDF_AAction::AActionType type,
                         CPDFSDK_Document* pDocument,
                         CPDF_FormField* pFormField,
                         PDFSDK_FieldAction& data);
  FX_BOOL DoAction_FieldJavaScript(const CPDF_Action& JsAction,
                                   CPDF_AAction::AActionType type,
                                   CPDFSDK_Document* pDocument,
                                   CPDF_FormField* pFormField,
                                   PDFSDK_FieldAction& data);

 private:
  FX_BOOL ExecuteDocumentOpenAction(const CPDF_Action& action,
                                    CPDFSDK_Document* pDocument,
                                    std::set<CPDF_Dictionary*>* visited);
  FX_BOOL ExecuteDocumentPageAction(const CPDF_Action& action,
                                    CPDF_AAction::AActionType type,
                                    CPDFSDK_Document* pDocument,
                                    std::set<CPDF_Dictionary*>* visited);
  FX_BOOL ExecuteFieldAction(const CPDF_Action& action,
                             CPDF_AAction::AActionType type,
                             CPDFSDK_Document* pDocument,
                             CPDF_FormField* pFormField,
                             PDFSDK_FieldAction& data,
                             std::set<CPDF_Dictionary*>* visited);
  FX_BOOL ExecuteScreenAction(const CPDF_Action& action,
                              CPDF_AAction::AActionType type,
                              CPDFSDK_Document* pDocument,
                              CPDFSDK_Annot* pScreen,
                              std::set<CPDF_Dictionary*>* visited);
  FX_BOOL ExecuteBookMark(const CPDF_Action& action,
                          CPDFSDK_Document* pDocument,
                          CPDF_Bookmark* pBookmark,
                          std::set<CPDF_Dictionary*>* visited);
  FX_BOOL ExecuteLinkAction(const CPDF_Action& action,
                            CPDFSDK_Document* pDocument,
                            std::set<CPDF_Dictionary*>* visited);

  void DoAction_NoJs(const CPDF_Action& action, CPDFSDK_Document* pDocument);
  void RunDocumentPageJavaScript(CPDFSDK_Document* pDocument,
                                 CPDF_AAction::AActionType type,
                                 const CFX_WideString& script);
  void RunDocumentOpenJavaScript(CPDFSDK_Document* pDocument,
                                 const CFX_WideString& sScriptName,
                                 const CFX_WideString& script);
  void RunFieldJavaScript(CPDFSDK_Document* pDocument,
                          CPDF_FormField* pFormField,
                          CPDF_AAction::AActionType type,
                          PDFSDK_FieldAction& data,
                          const CFX_WideString& script);

  FX_BOOL IsValidField(CPDFSDK_Document* pDocument,
                       CPDF_Dictionary* pFieldDict);
  FX_BOOL IsValidDocView(CPDFSDK_Document* pDocument);

  void DoAction_GoTo(CPDFSDK_Document* pDocument, const CPDF_Action& action);
  void DoAction_GoToR(CPDFSDK_Document* pDocument, const CPDF_Action& action);
  void DoAction_Launch(CPDFSDK_Document* pDocument, const CPDF_Action& action);
  void DoAction_URI(CPDFSDK_Document* pDocument, const CPDF_Action& action);
  void DoAction_Named(CPDFSDK_Document* pDocument, const CPDF_Action& action);
  void DoAction_SetOCGState(CPDFSDK_Document* pDocument,
                            const CPDF_Action& action);

  std::unique_ptr<CPDFSDK_FormActionHandler> m_pFormActionHandler;
};

#endif  // FPDFSDK_INCLUDE_FSDK_ACTIONHANDLER_H_