fpdfsdk/fpdf_sysfontinfo_embeddertest.cpp

// Copyright 2019 The PDFium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "public/fpdf_sysfontinfo.h"

#include <string>
#include <vector>

#include "build/build_config.h"
#include "core/fxcrt/compiler_specific.h"
#include "testing/embedder_test.h"
#include "testing/embedder_test_environment.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace {

struct TrackingFontInfo {
  FPDF_SYSFONTINFO base;
  FPDF_SYSFONTINFO* wrapped_font_info;
  int* enum_fonts_call_count;
  int* map_font_call_count;
};

extern "C" {

void TrackingEnumFonts(FPDF_SYSFONTINFO* sys_font_info, void* mapper) {
  auto* tracking_info = reinterpret_cast<TrackingFontInfo*>(sys_font_info);
  (*tracking_info->enum_fonts_call_count)++;
  if (tracking_info->wrapped_font_info &&
      tracking_info->wrapped_font_info->EnumFonts) {
    tracking_info->wrapped_font_info->EnumFonts(
        tracking_info->wrapped_font_info, mapper);
  }
}

void* TrackingMapFont(FPDF_SYSFONTINFO* sys_font_info,
                      int weight,
                      FPDF_BOOL italic,
                      int charset,
                      int pitch_family,
                      const char* face,
                      FPDF_BOOL* exact) {
  auto* tracking_info = reinterpret_cast<TrackingFontInfo*>(sys_font_info);
  (*tracking_info->map_font_call_count)++;
  if (tracking_info->wrapped_font_info &&
      tracking_info->wrapped_font_info->MapFont) {
    return tracking_info->wrapped_font_info->MapFont(
        tracking_info->wrapped_font_info, weight, italic, charset, pitch_family,
        face, exact);
  }
  return nullptr;
}

void* TrackingGetFont(FPDF_SYSFONTINFO* sys_font_info, const char* face) {
  auto* tracking_info = reinterpret_cast<TrackingFontInfo*>(sys_font_info);
  if (tracking_info->wrapped_font_info &&
      tracking_info->wrapped_font_info->GetFont) {
    return tracking_info->wrapped_font_info->GetFont(
        tracking_info->wrapped_font_info, face);
  }
  return nullptr;
}

unsigned long TrackingGetFontData(FPDF_SYSFONTINFO* sys_font_info,
                                  void* font,
                                  unsigned int table,
                                  unsigned char* buffer,
                                  unsigned long buf_size) {
  auto* tracking_info = reinterpret_cast<TrackingFontInfo*>(sys_font_info);
  if (tracking_info->wrapped_font_info &&
      tracking_info->wrapped_font_info->GetFontData) {
    return tracking_info->wrapped_font_info->GetFontData(
        tracking_info->wrapped_font_info, font, table, buffer, buf_size);
  }
  return 0;
}

unsigned long TrackingGetFaceName(FPDF_SYSFONTINFO* sys_font_info,
                                  void* font,
                                  char* buffer,
                                  unsigned long buf_size) {
  auto* tracking_info = reinterpret_cast<TrackingFontInfo*>(sys_font_info);
  if (tracking_info->wrapped_font_info &&
      tracking_info->wrapped_font_info->GetFaceName) {
    return tracking_info->wrapped_font_info->GetFaceName(
        tracking_info->wrapped_font_info, font, buffer, buf_size);
  }
  return 0;
}

int TrackingGetFontCharset(FPDF_SYSFONTINFO* sys_font_info, void* font) {
  auto* tracking_info = reinterpret_cast<TrackingFontInfo*>(sys_font_info);
  if (tracking_info->wrapped_font_info &&
      tracking_info->wrapped_font_info->GetFontCharset) {
    return tracking_info->wrapped_font_info->GetFontCharset(
        tracking_info->wrapped_font_info, font);
  }
  return 0;
}

void TrackingDeleteFont(FPDF_SYSFONTINFO* sys_font_info, void* font) {
  auto* tracking_info = reinterpret_cast<TrackingFontInfo*>(sys_font_info);
  if (tracking_info->wrapped_font_info &&
      tracking_info->wrapped_font_info->DeleteFont) {
    tracking_info->wrapped_font_info->DeleteFont(
        tracking_info->wrapped_font_info, font);
  }
}

void FakeRelease(FPDF_SYSFONTINFO* sys_font_info) {}
void FakeEnumFonts(FPDF_SYSFONTINFO* sys_font_info, void* mapper) {}

void* FakeMapFont(FPDF_SYSFONTINFO* sys_font_info,
                  int weight,
                  FPDF_BOOL italic,
                  int charset,
                  int pitch_family,
                  const char* face,
                  FPDF_BOOL* exact) {
  // Any non-null return will do.
  return sys_font_info;
}

void* FakeGetFont(FPDF_SYSFONTINFO* sys_font_info, const char* face) {
  // Any non-null return will do.
  return sys_font_info;
}

unsigned long FakeGetFontData(FPDF_SYSFONTINFO* sys_font_info,
                              void* font,
                              unsigned int table,
                              unsigned char* buffer,
                              unsigned long buf_size) {
  return 0;
}

unsigned long FakeGetFaceName(FPDF_SYSFONTINFO* sys_font_info,
                              void* font,
                              char* buffer,
                              unsigned long buf_size) {
  return 0;
}

int FakeGetFontCharset(FPDF_SYSFONTINFO* sys_font_info, void* font) {
  return 1;
}

void FakeDeleteFont(FPDF_SYSFONTINFO* sys_font_info, void* font) {}

}  // extern "C"

class FPDFUnavailableSysFontInfoEmbedderTest : public EmbedderTest {
 public:
  FPDFUnavailableSysFontInfoEmbedderTest() = default;
  ~FPDFUnavailableSysFontInfoEmbedderTest() override = default;

  void SetUp() override {
    EmbedderTest::SetUp();
    font_info_.version = 1;
    font_info_.Release = FakeRelease;
    font_info_.EnumFonts = FakeEnumFonts;
    font_info_.MapFont = FakeMapFont;
    font_info_.GetFont = FakeGetFont;
    font_info_.GetFontData = FakeGetFontData;
    font_info_.GetFaceName = FakeGetFaceName;
    font_info_.GetFontCharset = FakeGetFontCharset;
    font_info_.DeleteFont = FakeDeleteFont;
    FPDF_SetSystemFontInfo(&font_info_);
  }

  void TearDown() override {
    FPDF_SetSystemFontInfo(nullptr);
    EmbedderTest::TearDown();

    // Bouncing the library is the only reliable way to fully undo the initial
    // FPDF_SetSystemFontInfo() call at the moment.
    EmbedderTestEnvironment::GetInstance()->TearDown();
    EmbedderTestEnvironment::GetInstance()->SetUp();
  }

  FPDF_SYSFONTINFO font_info_;
};

class FPDFSysFontInfoEmbedderTest : public EmbedderTest {
 public:
  FPDFSysFontInfoEmbedderTest() = default;
  ~FPDFSysFontInfoEmbedderTest() override = default;

  void SetUp() override {
    EmbedderTest::SetUp();
    font_info_ = FPDF_GetDefaultSystemFontInfo();
    ASSERT_TRUE(font_info_);
    FPDF_SetSystemFontInfo(font_info_);
  }

  void TearDown() override {
    EmbedderTest::TearDown();

    // After releasing `font_info_` from PDFium, it is safe to free it.
    FPDF_SetSystemFontInfo(nullptr);
    FPDF_FreeDefaultSystemFontInfo(font_info_);

    // Bouncing the library is the only reliable way to fully undo the initial
    // FPDF_SetSystemFontInfo() call at the moment.
    EmbedderTestEnvironment::GetInstance()->TearDown();

    EmbedderTestEnvironment::GetInstance()->SetUp();
  }

  FPDF_SYSFONTINFO* font_info_;
};

class FPDFVersion1Versus2ComparisonTest : public EmbedderTest {
 public:
  FPDFVersion1Versus2ComparisonTest() = default;
  ~FPDFVersion1Versus2ComparisonTest() override = default;

  void SetupVersion(int version) {
    EmbedderTestEnvironment::GetInstance()->TearDown();
    EmbedderTestEnvironment::GetInstance()->SetUp();

    enum_fonts_call_count_ = 0;
    map_font_call_count_ = 0;

    wrapped_font_info_ = FPDF_GetDefaultSystemFontInfo();
    ASSERT_TRUE(wrapped_font_info_);

    tracking_font_info_.base.version = version;
    tracking_font_info_.base.Release = nullptr;
    tracking_font_info_.base.EnumFonts = TrackingEnumFonts;
    tracking_font_info_.base.MapFont = TrackingMapFont;
    tracking_font_info_.base.GetFont = TrackingGetFont;
    tracking_font_info_.base.GetFontData = TrackingGetFontData;
    tracking_font_info_.base.GetFaceName = TrackingGetFaceName;
    tracking_font_info_.base.GetFontCharset = TrackingGetFontCharset;
    tracking_font_info_.base.DeleteFont = TrackingDeleteFont;
    tracking_font_info_.wrapped_font_info = wrapped_font_info_;
    tracking_font_info_.enum_fonts_call_count = &enum_fonts_call_count_;
    tracking_font_info_.map_font_call_count = &map_font_call_count_;

    FPDF_SetSystemFontInfo(&tracking_font_info_.base);
  }

  void TearDown() override {
    if (wrapped_font_info_) {
      FPDF_SetSystemFontInfo(nullptr);
      if (wrapped_font_info_->Release) {
        wrapped_font_info_->Release(wrapped_font_info_);
      }
      FPDF_FreeDefaultSystemFontInfo(wrapped_font_info_);
      wrapped_font_info_ = nullptr;
    }
    EmbedderTest::TearDown();

    // Bouncing the library is the only reliable way to fully undo the initial
    // FPDF_SetSystemFontInfo() call at the moment.
    EmbedderTestEnvironment::GetInstance()->TearDown();
    EmbedderTestEnvironment::GetInstance()->SetUp();
  }

  int enum_fonts_call_count_ = 0;
  int map_font_call_count_ = 0;
  FPDF_SYSFONTINFO* wrapped_font_info_ = nullptr;
  TrackingFontInfo tracking_font_info_ = {};
};

}  // namespace

TEST_F(FPDFVersion1Versus2ComparisonTest, Version1CallsEnumFonts) {
  SetupVersion(1);

  ASSERT_TRUE(OpenDocument("hello_world.pdf"));
  FPDF_PAGE page = LoadPage(0);
  ASSERT_TRUE(page);
  ScopedFPDFBitmap bitmap = RenderPage(page);
  ASSERT_TRUE(bitmap);
  UnloadPage(page);

  // Version 1 should call EnumFonts at least once.
  EXPECT_GT(enum_fonts_call_count_, 0);
}

TEST_F(FPDFVersion1Versus2ComparisonTest, Version2SkipsEnumFonts) {
  SetupVersion(2);

  ASSERT_TRUE(OpenDocument("hello_world.pdf"));
  FPDF_PAGE page = LoadPage(0);
  ASSERT_TRUE(page);
  ScopedFPDFBitmap bitmap = RenderPage(page);
  ASSERT_TRUE(bitmap);
  UnloadPage(page);

  // Version 2 should NOT call EnumFonts but should call MapFont.
  EXPECT_EQ(enum_fonts_call_count_, 0);
  EXPECT_GT(map_font_call_count_, 0);
}

TEST_F(FPDFUnavailableSysFontInfoEmbedderTest, Bug972518) {
  ASSERT_TRUE(OpenDocument("bug_972518.pdf"));
  ASSERT_EQ(1, FPDF_GetPageCount(document()));

  ScopedPage page = LoadScopedPage(0);
  ASSERT_TRUE(page);
}

TEST_F(FPDFSysFontInfoEmbedderTest, DefaultSystemFontInfo) {
  ASSERT_TRUE(OpenDocument("hello_world.pdf"));
  ASSERT_EQ(1, FPDF_GetPageCount(document()));

  ScopedPage page = LoadScopedPage(0);
  ASSERT_TRUE(page);

  {
    // Not checking the rendering because it will depend on the fonts installed.
    ScopedFPDFBitmap bitmap = RenderPage(page.get());
    ASSERT_EQ(200, FPDFBitmap_GetWidth(bitmap.get()));
    ASSERT_EQ(200, FPDFBitmap_GetHeight(bitmap.get()));
  }
}

TEST_F(FPDFSysFontInfoEmbedderTest, DefaultTTFMap) {
  static constexpr int kExpectedCharsets[] = {
      FXFONT_ANSI_CHARSET,        FXFONT_SHIFTJIS_CHARSET,
      FXFONT_HANGEUL_CHARSET,     FXFONT_GB2312_CHARSET,
      FXFONT_CHINESEBIG5_CHARSET, FXFONT_ARABIC_CHARSET,
      FXFONT_CYRILLIC_CHARSET,    FXFONT_EASTERNEUROPEAN_CHARSET,
  };
  std::vector<int> charsets;

  const FPDF_CharsetFontMap* cfmap = FPDF_GetDefaultTTFMap();
  ASSERT_TRUE(cfmap);

  // Stop at either end mark.
  while (cfmap->charset != -1 && cfmap->fontname) {
    charsets.push_back(cfmap->charset);
    // SAFETY: requires FPDF_GetDefaultTTFMap() to provide a sentinel.
    UNSAFE_BUFFERS(++cfmap);
  }

  // Confirm end marks only occur as a pair.
  EXPECT_EQ(cfmap->charset, -1);
  EXPECT_EQ(cfmap->fontname, nullptr);

  EXPECT_THAT(charsets, testing::UnorderedElementsAreArray(kExpectedCharsets));
}

TEST_F(FPDFSysFontInfoEmbedderTest, DefaultTTFMapCountAndEntries) {
  static constexpr int kExpectedCharsets[] = {
      FXFONT_ANSI_CHARSET,
      FXFONT_GB2312_CHARSET,
      FXFONT_CHINESEBIG5_CHARSET,
      FXFONT_SHIFTJIS_CHARSET,
      FXFONT_HANGEUL_CHARSET,
      FXFONT_CYRILLIC_CHARSET,
      FXFONT_EASTERNEUROPEAN_CHARSET,
      FXFONT_ARABIC_CHARSET,
  };
  static const std::string kExpectedFontNames[] = {
      "Helvetica", "SimSun", "MingLiU", "MS Gothic", "Batang", "Arial",
#if BUILDFLAG(IS_WIN)
      "Tahoma",
#else
      "Arial",
#endif
      "Arial",
  };
  std::vector<int> charsets;
  std::vector<const char*> font_names;

  const size_t count = FPDF_GetDefaultTTFMapCount();
  for (size_t i = 0; i < count; ++i) {
    const FPDF_CharsetFontMap* entry = FPDF_GetDefaultTTFMapEntry(i);
    ASSERT_TRUE(entry);
    charsets.push_back(entry->charset);
    font_names.push_back(entry->fontname);
  }

  EXPECT_THAT(charsets, testing::ElementsAreArray(kExpectedCharsets));
  EXPECT_THAT(font_names, testing::ElementsAreArray(kExpectedFontNames));

  // Test out of bound indices.
  EXPECT_FALSE(FPDF_GetDefaultTTFMapEntry(count));
  EXPECT_FALSE(FPDF_GetDefaultTTFMapEntry(9999));
}