// Copyright (C) 2003-2026, Foxit Software Inc..
// All Rights Reserved.
//
// http://www.foxitsoftware.com
//
// The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc..
// You cannot distribute any part of Foxit PDF SDK to any third party or general public,
// unless there is a separate license agreement with Foxit Software Inc. which explicitly grants you such rights.
//
// This file contains an example to demonstrate how to use Foxit PDF SDK to create or open a portfolio PDF file.


const FSDK = require("@foxitsoftware/foxit-pdf-sdk-node");
const fs = require('fs');
const os = require('os');
const path = require('path');
const util = require('util');

var sn = "bPxThFlBAYifO3yiW0C51bKbjPap1zHaf5aG5sX378TjFvB7Q0802A==";
var key = "8f3g1sGNtR8NAgfSNv+BvaJWy2fnrw36NZvzh8GUxYXvs+/YczAk4e34yqlOnmL4asgxGMO7+rlOcSHUSSKagx5g4G7VEXfkYLXnDDx77FOOedZPrFFcOCu1vT4+wOKzy1zkORq9cKtiFf44byH5sfRqf+OvELjep2teT9eF9yPCsSw2vRKljXlPy40DMP9XX1O5OTe+mSG3RvwKUMb0+RpG3YobM87j+/ynTDlJMMXw4vgwuTb1ZuAtlvkTdFz7HDLV81C6TYnn73ddHeGD3qYWBVsD4uJkDwyyH/SWr7QX0HSgVg8HSZqnab1VGdAUYxKY2vGWeOTJdu6qDGb5ZEb9O3kZZg+9LYAmUKzDfCYwfIsYZ8Y9LPC4wMx70kIq7JpNnzPvigrdshV8/ew1F0+qP/P5Z1EB53vDVrp2LVSuL873Wv4g3PzjZlNH+1qgT87hC+Buto4qsSUfP5Y2z0uApu+c/TfttCXbeMLSsw9TY1HQD3mkrZExMaQqRrAuXAcZWdvBnVuG3DCZmm8q0DLxJiCfYfViAU/AkbeKMIGaTJdrvIXBcssfde4nmU6qr0M4x4+Hs2ESddtY2QRtLAUBq/7h7GJlJHkEZr8ueaUy/6D/2vvAWz6wMLgmjlPbDTLqzfnCJylHCPtcJmu1SPPT9v1VreBX3+zNWcIT8HueyHEiUniqzwWkRKaotrnNb/zhnHLPpgaBSwKjyi8rOzzVwu/nY84G9ye4jsVjmkIRItKDrW7z22iS+QQuTwfqLVuMB0OD4jMkPCC2slzPfEeZnuh4+Rewln2qLRJVgI72zJ20OBWAelGSpO1Ii2Y3gOvojdmtUwx6R3Z1qFNWTTB25o9ytcux8BLOtTCkA8T8xaT4N339OTCsu/TmfahIDixKvr8cDa6F2WkBT8SOfv64W9PgiNv5B/BMOD2VWYaAl0N7yD0NkYYg/cDWRC4dfpdeip1jrr0k3mND0oSpIkxC+FicZbaYYwRdtJ9OSVWJ5OE0voLv8HgLze8mw6s4TrN3z+a2NQCveMa2VRN7YcEF7agPrvb/qU+otMwHae/wM7+f+HFAaOW+WTfzfxIVFB8/A1DN0NiEX+em4G7nO5F5ZcvfYPpaaioe8Nn33BbVLtMjXqsOBeM8AXiVfpD6YO75j7BqnBUPnivvD8BxJaaIQZvVSuQmvGm0ynt03IYwE8Rq+jYsunvsZ86jh5BiUR+Nm7sK0Qe9BdZn/7jdqohMv9czfMGUAscX+xBMunFbDpcRbWVpUADcm209L8Ndek2XY7YlCMxPgPVNvfWRF2jxehib9Tpd7zB5ZIDfAEH9zrpLfp29DLvCh2Yx8mH7xxdKG1O9Q0GdHphYHhej6smAcPm68R0GUQaTOLfXqNpueGJC1GAOI3Y4swjyt7jMTWcibnKLzwukWE5rnEDhn5n64JnyUM0ZFkRmtOiV";

const input_path = "../input_files/";
const output_path = "../output_files/";

class TextDoc {
  constructor(file_name, file_mode) {
    this.file_name = file_name;
    this.file_mode = file_mode;
    this.file_stream = fs.openSync(file_name, file_mode);
    if (!this.file_stream) {
      throw new Error('Cannot open file');
    }
  }
  Write(format, ...args) {
    if(!this.file_stream) 
      throw new Error("File not opened");
    let formatted_string = util.format(format, ...args);
    let buffer = new Buffer.from(formatted_string, 'utf-8');
    fs.writeSync(this.file_stream, buffer, 0, buffer.length);
  }
  WriteWithPrefix(count, prefix, format, ...args){
    for (let i = 0; i < count; i++) {
      this.Write(prefix);
    }
    this.Write(format, ...args);
  }
  Close() {
    fs.closeSync(this.file_stream);
    this.file_stream = null;
  }
}

function CreatPortfolioPDF(saved_portfolio_pdf_path) {
  // Create a new blank portfolio PDF.
  let new_portfolio = FSDK.Portfolio.CreatePortfolio();
  if (true == new_portfolio.IsEmpty()) {
    console.log("[FAILED] Fail to create a new portfolio PDF.");
    return false;
  }

  // Get the root node.
  let root_node = new_portfolio.GetRootNode();
  if (true == root_node.IsEmpty()) {
    console.log("[FAILED] Fail to get the root node.");
    return false;
  }
  // The root node should be a folder node, so transfer to use PortfolioFolderNode.
  let root_folder = new FSDK.PortfolioFolderNode(root_node);

  // Pre-load the PDF file which is to be added to new sub folder in portfolio PDF.
  // ATTENTION: please keep the PDF document object valid until portfolio PDF is saved or ends its life-cycle.
  let input_pdf_filename = "AboutFoxit.pdf";
  let input_pdf_file_path = input_path + input_pdf_filename;
  let pdf_doc = new FSDK.PDFDoc(input_pdf_file_path);
  let error_code = pdf_doc.Load("");
  if (error_code != FSDK.e_ErrSuccess) {
    console.log("[FAILED] Fail to load PDF file %s. Error: %d", input_pdf_file_path, error_code);
  }

  // Add a sub folder to root folder node.
  let new_sub_foldernode = root_folder.AddSubFolder("Sub Folder-1");
  if (true == new_sub_foldernode.IsEmpty()) {
    console.log("[FAILED] Fail to add sub folder.\r\n");
  } else {
    new_sub_foldernode.SetDescription("This is a sub folder added to portfolio PDF file.");

    if (false == pdf_doc.IsEmpty()) {
      // Add a valid PDF document object to current folder node.
      // ATTENTION: please keep the PDF document object valid until portfolio PDF is saved or ends its life-cycle.
      let new_filenode = new_sub_foldernode.AddPDFDoc(pdf_doc, input_pdf_filename);
      if (true == new_filenode.IsEmpty()) {
        console.log("[FAILED] Fail to add PDF file %s.", input_pdf_file_path);
      } else {
        let file_spec = new_filenode.GetFileSpec();
        file_spec.SetDescription("This is a common PDF file added to portfolio PDF file");
      }
    }
  }


  // Add a non-PDF file to root folder node.
  let input_file_path = input_path + "FoxitLogo.jpg";
  let new_sub_filenode = root_folder.AddFile(input_file_path);
  if (true == new_sub_filenode.IsEmpty()) {
    console.log("[FAILED] Fail to add file %s.", input_file_path);
  } else {
    let file_spec = new_sub_filenode.GetFileSpec();
    file_spec.SetDescription("This is a non-PDF file added to portfolio PDF file.");
  }
  
  // User can update schema field and other properties by class Portfolio, if necessary.
  
  // Save the new portfolio PDF file.
  let portfolio_pdf_doc = new_portfolio.GetPortfolioPDFDoc();
  if (true == portfolio_pdf_doc.IsEmpty()) {
    console.log("[FAILED] Fail to get portfolio PDF document object.\r\n");
    return false;
  } else {
    return portfolio_pdf_doc.SaveAs(saved_portfolio_pdf_path, FSDK.PDFDoc.e_SaveFlagNormal);
  }
}

function OutputTab(output_txt_doc, nTabCount) {
  for (let i = 0; i<nTabCount; i++)
    output_txt_doc.Write("\t");
}

function OutputFileNodeInfo(output_txt_doc, node, tab_count) {
  if (tab_count>0)
    OutputTab(output_txt_doc, tab_count);
  output_txt_doc.Write("Type:File\r\n");

  let temp_node = new FSDK.PortfolioFileNode(node);
  let key_name = temp_node.GetKeyName();
  if (tab_count>0)
    OutputTab(output_txt_doc, tab_count);
  output_txt_doc.Write("Key Name:%s\r\n", key_name);

  let file_spec = temp_node.GetFileSpec();
  let file_name = file_spec.GetFileName();
  if (tab_count>0)
      OutputTab(output_txt_doc, tab_count);
  output_txt_doc.Write("File Name:%s\r\n", file_name);

  let description = file_spec.GetDescription();
  if (tab_count>0)
    OutputTab(output_txt_doc, tab_count);
  output_txt_doc.Write("Description:%s\r\n", description);
}

function OutputFolderNodeInfo(output_txt_doc, node, tab_count) {
  if (tab_count>0)
    OutputTab(output_txt_doc, tab_count);
  output_txt_doc.Write("Type:Folder\r\n");

  let temp_node = new FSDK.PortfolioFolderNode(node);
  let name = temp_node.GetName();
  if (tab_count>0)
    OutputTab(output_txt_doc, tab_count);
  output_txt_doc.Write("Name:%s\r\n", name);

  let description = temp_node.GetDescription();
  if (tab_count>0)
    OutputTab(output_txt_doc, tab_count);
  output_txt_doc.Write("Description:%s\r\n", description);

  let sub_nodes = temp_node.GetSortedSubNodes();
  OutputSubNodesInfo(output_txt_doc, sub_nodes, tab_count + 1);
}

function OutputNodeInfo(output_txt_doc, node, tab_count) {
  let node_type = new FSDK.PortfolioNode(node).GetNodeType();
  switch (node_type) {
    case FSDK.PortfolioNode.e_TypeFolder:
      OutputFolderNodeInfo(output_txt_doc, new FSDK.PortfolioFolderNode(node), tab_count);
      break;
    case FSDK.PortfolioNode.e_TypeFile:
      OutputFileNodeInfo(output_txt_doc, new FSDK.PortfolioFileNode(node), tab_count);
      break;
    default:
      break;
  }
}

function OutputSubNodesInfo(output_txt_doc, sub_nodes, tab_count) {
  for (let index = 0; index < sub_nodes.GetSize(); index++) {
    if (tab_count > 0)
      OutputTab(output_txt_doc, tab_count);
    output_txt_doc.Write("Sorted Index (under current folder):%d\r\n", index);
    OutputNodeInfo(output_txt_doc, sub_nodes.GetAt(index), tab_count);
    output_txt_doc.Write("========\r\n");
  }
}

function OutputSchemaFields(output_txt_doc, field_array) {
  if (field_array.GetSize() <= 0) return;
  output_txt_doc.Write("==== Schema Fields ====\r\n");

  for (let i = 0; i < field_array.GetSize(); i++) {
    output_txt_doc.Write("Field index:%d\r\n", i);
    let field = field_array.GetAt(i);
    if (true == field.IsEmpty()) continue;
    let key_name = field.GetKeyName();
    output_txt_doc.Write("Key name: %s\r\n", key_name);

    let subtype_name = field.GetSubtypeName();
    output_txt_doc.Write("Subtype name: %s\r\n", subtype_name);

    let display_name = field.GetDisplayName();
    output_txt_doc.Write("Display name: %s\r\n", display_name);

    let is_visible = field.IsVisible();
    output_txt_doc.Write("Visibility: %s\r\n", is_visible ? "true" : "false");

    output_txt_doc.Write("========\r\n");
  }
}

function OutputPortfolioProperties(output_txt_doc, portfolio) {
  output_txt_doc.Write("==== Portfolio Properties ====\r\n");
  let initial_filespec_keyname = portfolio.GetInitialFileSpecKeyName();
  output_txt_doc.Write("Initial FileSpec Key Name:%s\r\n", initial_filespec_keyname);

  let view_mode = portfolio.GetInitialViewMode();
  let view_mode_str = "";
  switch (view_mode) {
    case FSDK.Portfolio.e_InitialViewUnknownMode:
      view_mode_str = "Unknown";
      break;
    case FSDK.Portfolio.e_InitialViewDetailMode:
      view_mode_str = "Detail";
      break;
    case FSDK.Portfolio.e_InitialViewTileMode:
      view_mode_str = "Tile";
      break;
    case FSDK.Portfolio.e_InitialViewHidden:
      view_mode_str = "Hidden";
      break;
  }
  output_txt_doc.Write("Initial View Mode:%s\r\n", view_mode_str);
  let is_ascending = portfolio.IsSortedInAscending();
  output_txt_doc.Write("Sorting Order:%s\r\n", is_ascending? "Ascending" : "Descending" );

  let sorting_field_name = portfolio.GetSortingFieldKeyName();
  output_txt_doc.Write("Sorting Field Key Name:%s\r\n", sorting_field_name);


  let field_array = portfolio.GetSchemaFields();
  OutputSchemaFields(output_txt_doc, field_array);
}

function OutputPortfolioPDFInfo(portfolio_file_path, output_txt_doc) {
  let pdf_doc = new FSDK.PDFDoc(portfolio_file_path);
  let error_code = pdf_doc.Load("");
  if (error_code != FSDK.e_ErrSuccess) {
    console.log("[FAILED] Fail to load Portfolio PDF file %s. Error: %d\n", portfolio_file_path, error_code);
    return;
  }

  if (false == pdf_doc.IsPortfolio()) {
    console.log("[FAILED] Fail to output portfolio information for PDF file %s, because it is not a portfolio PDF file.", portfolio_file_path);
    return;
  }

  let exist_portfolio = FSDK.Portfolio.CreatePortfolio(pdf_doc);
  if (true == exist_portfolio.IsEmpty()) {
    console.log("[FAILED] Fail to create a portfolio object based an existed portfolio PDF document.");
    return;
  }

  // Output portfolio properties.
  OutputPortfolioProperties(output_txt_doc, exist_portfolio);
  output_txt_doc.Write("======================================================================\r\n");

  // Output all nodes.
  output_txt_doc.Write("==== Nodes Information ====\r\n");
  let root_node = exist_portfolio.GetRootNode();
  let root_folder = new FSDK.PortfolioFolderNode(root_node);
  let sub_nodes = root_folder.GetSortedSubNodes();
  OutputSubNodesInfo(output_txt_doc, sub_nodes, 0);
}

let error_code = FSDK.Library.Initialize(sn, key);
if (FSDK.e_ErrSuccess != error_code) {
  if (FSDK.e_ErrInvalidLicense == error_code)
    console.log("[Failed] Current used Foxit PDF SDK key information is invalid.");
  else
    console.log("Library Initialize Error: %d", FSDK.e_ErrSuccess);
  return;
}

let output_directory = output_path + "portfolio/";
if (!fs.existsSync(output_directory))  {
  fs.mkdirSync(output_directory);
}


try {
  let saved_portfolio_pdf_path = output_directory + "new_portfolio.pdf";
  // Create a new portfolio PDF file
  if (CreatPortfolioPDF(saved_portfolio_pdf_path)) {
    let output_info_file_path = output_directory + "new_portfolio_info.txt";
    let text_doc = new TextDoc(output_info_file_path, "w");
    // Show information of the new portfolio PDF file.
    OutputPortfolioPDFInfo(saved_portfolio_pdf_path, text_doc);
  }

  console.log("END: Portfolio demo.");

} catch (e) {
  console.log(e);
}
FSDK.Library.Release();