Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 1 | // Copyright 2017 PDFium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
Jane Liu | f63e813 | 2017-07-25 18:11:27 -0400 | [diff] [blame] | 5 | #include <memory> |
| 6 | #include <string> |
| 7 | #include <vector> |
| 8 | |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 9 | #include "public/fpdf_attachment.h" |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 10 | #include "public/fpdfview.h" |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 11 | #include "testing/embedder_test.h" |
Lei Zhang | b6992dd | 2019-02-05 23:30:20 +0000 | [diff] [blame] | 12 | #include "testing/fx_string_testhelpers.h" |
Lei Zhang | 4c64e96 | 2019-02-05 19:24:12 +0000 | [diff] [blame] | 13 | #include "testing/utils/hash.h" |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 14 | |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 15 | static constexpr char kDateKey[] = "CreationDate"; |
| 16 | static constexpr char kChecksumKey[] = "CheckSum"; |
| 17 | |
Lei Zhang | ab41f25 | 2018-12-23 03:10:50 +0000 | [diff] [blame] | 18 | class FPDFAttachmentEmbedderTest : public EmbedderTest {}; |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 19 | |
Lei Zhang | ab41f25 | 2018-12-23 03:10:50 +0000 | [diff] [blame] | 20 | TEST_F(FPDFAttachmentEmbedderTest, ExtractAttachments) { |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 21 | // Open a file with two attachments. |
| 22 | ASSERT_TRUE(OpenDocument("embedded_attachments.pdf")); |
| 23 | EXPECT_EQ(2, FPDFDoc_GetAttachmentCount(document())); |
| 24 | |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 25 | // Retrieve the first attachment. |
| 26 | FPDF_ATTACHMENT attachment = FPDFDoc_GetAttachment(document(), 0); |
| 27 | ASSERT_TRUE(attachment); |
| 28 | |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 29 | // Check that the name of the first attachment is correct. |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 30 | unsigned long len = FPDFAttachment_GetName(attachment, nullptr, 0); |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 31 | std::vector<char> buf(len); |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 32 | EXPECT_EQ(12u, FPDFAttachment_GetName(attachment, buf.data(), len)); |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 33 | EXPECT_STREQ(L"1.txt", |
| 34 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 35 | .c_str()); |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 36 | |
| 37 | // Check that the content of the first attachment is correct. |
| 38 | len = FPDFAttachment_GetFile(attachment, nullptr, 0); |
| 39 | buf.clear(); |
| 40 | buf.resize(len); |
| 41 | ASSERT_EQ(4u, FPDFAttachment_GetFile(attachment, buf.data(), len)); |
| 42 | EXPECT_EQ(std::string("test"), std::string(buf.data(), 4)); |
| 43 | |
| 44 | // Check that a non-existent key does not exist. |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 45 | EXPECT_FALSE(FPDFAttachment_HasKey(attachment, "none")); |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 46 | |
| 47 | // Check that the string value of a non-string dictionary entry is empty. |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 48 | static constexpr char kSizeKey[] = "Size"; |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 49 | EXPECT_EQ(FPDF_OBJECT_NUMBER, |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 50 | FPDFAttachment_GetValueType(attachment, kSizeKey)); |
| 51 | EXPECT_EQ(2u, |
| 52 | FPDFAttachment_GetStringValue(attachment, kSizeKey, nullptr, 0)); |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 53 | |
| 54 | // Check that the creation date of the first attachment is correct. |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 55 | len = FPDFAttachment_GetStringValue(attachment, kDateKey, nullptr, 0); |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 56 | buf.clear(); |
| 57 | buf.resize(len); |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 58 | EXPECT_EQ(48u, FPDFAttachment_GetStringValue(attachment, kDateKey, buf.data(), |
| 59 | len)); |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 60 | EXPECT_STREQ(L"D:20170712214438-07'00'", |
| 61 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 62 | .c_str()); |
| 63 | |
| 64 | // Retrieve the second attachment. |
| 65 | attachment = FPDFDoc_GetAttachment(document(), 1); |
| 66 | ASSERT_TRUE(attachment); |
| 67 | |
| 68 | // Retrieve the second attachment file. |
| 69 | len = FPDFAttachment_GetFile(attachment, nullptr, 0); |
| 70 | buf.clear(); |
| 71 | buf.resize(len); |
| 72 | EXPECT_EQ(5869u, FPDFAttachment_GetFile(attachment, buf.data(), len)); |
| 73 | |
| 74 | // Check that the calculated checksum of the file data matches expectation. |
| 75 | const char kCheckSum[] = "72afcddedf554dda63c0c88e06f1ce18"; |
| 76 | const wchar_t kCheckSumW[] = L"<72AFCDDEDF554DDA63C0C88E06F1CE18>"; |
| 77 | const std::string generated_checksum = |
| 78 | GenerateMD5Base16(reinterpret_cast<uint8_t*>(buf.data()), len); |
| 79 | EXPECT_EQ(kCheckSum, generated_checksum); |
| 80 | |
| 81 | // Check that the stored checksum matches expectation. |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 82 | len = FPDFAttachment_GetStringValue(attachment, kChecksumKey, nullptr, 0); |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 83 | buf.clear(); |
| 84 | buf.resize(len); |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 85 | EXPECT_EQ(70u, FPDFAttachment_GetStringValue(attachment, kChecksumKey, |
Jane Liu | 18ae06d | 2017-07-18 10:15:16 -0400 | [diff] [blame] | 86 | buf.data(), len)); |
| 87 | EXPECT_EQ(kCheckSumW, |
| 88 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data()))); |
Jane Liu | 53aafa9 | 2017-07-12 19:55:02 -0400 | [diff] [blame] | 89 | } |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 90 | |
Lei Zhang | ab41f25 | 2018-12-23 03:10:50 +0000 | [diff] [blame] | 91 | TEST_F(FPDFAttachmentEmbedderTest, AddAttachments) { |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 92 | // Open a file with two attachments. |
| 93 | ASSERT_TRUE(OpenDocument("embedded_attachments.pdf")); |
| 94 | EXPECT_EQ(2, FPDFDoc_GetAttachmentCount(document())); |
| 95 | |
| 96 | // Check that adding an attachment with an empty name would fail. |
| 97 | EXPECT_FALSE(FPDFDoc_AddAttachment(document(), nullptr)); |
| 98 | |
| 99 | // Add an attachment to the beginning of the embedded file list. |
Lei Zhang | f0f6768 | 2019-04-08 17:03:21 +0000 | [diff] [blame^] | 100 | ScopedFPDFWideString file_name = GetFPDFWideString(L"0.txt"); |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 101 | FPDF_ATTACHMENT attachment = |
| 102 | FPDFDoc_AddAttachment(document(), file_name.get()); |
| 103 | |
| 104 | // Check that writing to a file with nullptr but non-zero bytes would fail. |
| 105 | EXPECT_FALSE(FPDFAttachment_SetFile(attachment, document(), nullptr, 10)); |
| 106 | |
| 107 | // Set the new attachment's file. |
| 108 | constexpr char kContents1[] = "Hello!"; |
| 109 | EXPECT_TRUE(FPDFAttachment_SetFile(attachment, document(), kContents1, |
| 110 | strlen(kContents1))); |
| 111 | |
| 112 | // Verify the name of the new attachment (i.e. the first attachment). |
| 113 | attachment = FPDFDoc_GetAttachment(document(), 0); |
| 114 | ASSERT_TRUE(attachment); |
| 115 | unsigned long len = FPDFAttachment_GetName(attachment, nullptr, 0); |
| 116 | std::vector<char> buf(len); |
| 117 | EXPECT_EQ(12u, FPDFAttachment_GetName(attachment, buf.data(), len)); |
| 118 | EXPECT_STREQ(L"0.txt", |
| 119 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 120 | .c_str()); |
| 121 | |
| 122 | // Verify the content of the new attachment (i.e. the first attachment). |
| 123 | len = FPDFAttachment_GetFile(attachment, nullptr, 0); |
| 124 | buf.clear(); |
| 125 | buf.resize(len); |
| 126 | ASSERT_EQ(6u, FPDFAttachment_GetFile(attachment, buf.data(), len)); |
| 127 | EXPECT_EQ(std::string(kContents1), std::string(buf.data(), 6)); |
| 128 | |
| 129 | // Add an attachment to the end of the embedded file list and set its file. |
| 130 | file_name = GetFPDFWideString(L"z.txt"); |
| 131 | attachment = FPDFDoc_AddAttachment(document(), file_name.get()); |
| 132 | constexpr char kContents2[] = "World!"; |
| 133 | EXPECT_TRUE(FPDFAttachment_SetFile(attachment, document(), kContents2, |
| 134 | strlen(kContents2))); |
| 135 | EXPECT_EQ(4, FPDFDoc_GetAttachmentCount(document())); |
| 136 | |
| 137 | // Verify the name of the new attachment (i.e. the fourth attachment). |
| 138 | attachment = FPDFDoc_GetAttachment(document(), 3); |
| 139 | ASSERT_TRUE(attachment); |
| 140 | len = FPDFAttachment_GetName(attachment, nullptr, 0); |
| 141 | buf.clear(); |
| 142 | buf.resize(len); |
| 143 | EXPECT_EQ(12u, FPDFAttachment_GetName(attachment, buf.data(), len)); |
| 144 | EXPECT_STREQ(L"z.txt", |
| 145 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 146 | .c_str()); |
| 147 | |
| 148 | // Verify the content of the new attachment (i.e. the fourth attachment). |
| 149 | len = FPDFAttachment_GetFile(attachment, nullptr, 0); |
| 150 | buf.clear(); |
| 151 | buf.resize(len); |
| 152 | ASSERT_EQ(6u, FPDFAttachment_GetFile(attachment, buf.data(), len)); |
| 153 | EXPECT_EQ(std::string(kContents2), std::string(buf.data(), 6)); |
| 154 | } |
| 155 | |
Lei Zhang | ab41f25 | 2018-12-23 03:10:50 +0000 | [diff] [blame] | 156 | TEST_F(FPDFAttachmentEmbedderTest, AddAttachmentsWithParams) { |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 157 | // Open a file with two attachments. |
| 158 | ASSERT_TRUE(OpenDocument("embedded_attachments.pdf")); |
| 159 | EXPECT_EQ(2, FPDFDoc_GetAttachmentCount(document())); |
| 160 | |
| 161 | // Add an attachment to the embedded file list. |
Lei Zhang | f0f6768 | 2019-04-08 17:03:21 +0000 | [diff] [blame^] | 162 | ScopedFPDFWideString file_name = GetFPDFWideString(L"5.txt"); |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 163 | FPDF_ATTACHMENT attachment = |
| 164 | FPDFDoc_AddAttachment(document(), file_name.get()); |
| 165 | constexpr char kContents[] = "Hello World!"; |
| 166 | EXPECT_TRUE(FPDFAttachment_SetFile(attachment, document(), kContents, |
| 167 | strlen(kContents))); |
| 168 | |
| 169 | // Set the date to be an arbitrary value. |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 170 | constexpr wchar_t kDateW[] = L"D:20170720161527-04'00'"; |
Lei Zhang | f0f6768 | 2019-04-08 17:03:21 +0000 | [diff] [blame^] | 171 | ScopedFPDFWideString ws_date = GetFPDFWideString(kDateW); |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 172 | EXPECT_TRUE( |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 173 | FPDFAttachment_SetStringValue(attachment, kDateKey, ws_date.get())); |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 174 | |
| 175 | // Set the checksum to be an arbitrary value. |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 176 | constexpr wchar_t kCheckSumW[] = L"<ABCDEF01234567899876543210FEDCBA>"; |
Lei Zhang | f0f6768 | 2019-04-08 17:03:21 +0000 | [diff] [blame^] | 177 | ScopedFPDFWideString ws_checksum = GetFPDFWideString(kCheckSumW); |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 178 | EXPECT_TRUE(FPDFAttachment_SetStringValue(attachment, kChecksumKey, |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 179 | ws_checksum.get())); |
| 180 | |
| 181 | // Verify the name of the new attachment (i.e. the second attachment). |
| 182 | attachment = FPDFDoc_GetAttachment(document(), 1); |
| 183 | ASSERT_TRUE(attachment); |
| 184 | unsigned long len = FPDFAttachment_GetName(attachment, nullptr, 0); |
| 185 | std::vector<char> buf(len); |
| 186 | EXPECT_EQ(12u, FPDFAttachment_GetName(attachment, buf.data(), len)); |
| 187 | EXPECT_STREQ(L"5.txt", |
| 188 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 189 | .c_str()); |
| 190 | |
| 191 | // Verify the content of the new attachment. |
| 192 | len = FPDFAttachment_GetFile(attachment, nullptr, 0); |
| 193 | buf.clear(); |
| 194 | buf.resize(len); |
| 195 | ASSERT_EQ(12u, FPDFAttachment_GetFile(attachment, buf.data(), len)); |
| 196 | EXPECT_EQ(std::string(kContents), std::string(buf.data(), 12)); |
| 197 | |
| 198 | // Verify the creation date of the new attachment. |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 199 | len = FPDFAttachment_GetStringValue(attachment, kDateKey, nullptr, 0); |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 200 | buf.clear(); |
| 201 | buf.resize(len); |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 202 | EXPECT_EQ(48u, FPDFAttachment_GetStringValue(attachment, kDateKey, buf.data(), |
| 203 | len)); |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 204 | EXPECT_STREQ(kDateW, |
| 205 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 206 | .c_str()); |
| 207 | |
| 208 | // Verify the checksum of the new attachment. |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 209 | len = FPDFAttachment_GetStringValue(attachment, kChecksumKey, nullptr, 0); |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 210 | buf.clear(); |
| 211 | buf.resize(len); |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 212 | EXPECT_EQ(70u, FPDFAttachment_GetStringValue(attachment, kChecksumKey, |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 213 | buf.data(), len)); |
| 214 | EXPECT_STREQ(kCheckSumW, |
| 215 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 216 | .c_str()); |
| 217 | |
| 218 | // Overwrite the existing file with empty content, and check that the checksum |
| 219 | // gets updated to the correct value. |
| 220 | EXPECT_TRUE(FPDFAttachment_SetFile(attachment, document(), nullptr, 0)); |
| 221 | EXPECT_EQ(0u, FPDFAttachment_GetFile(attachment, nullptr, 0)); |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 222 | len = FPDFAttachment_GetStringValue(attachment, kChecksumKey, nullptr, 0); |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 223 | buf.clear(); |
| 224 | buf.resize(len); |
Lei Zhang | df064df | 2017-08-31 02:33:27 -0700 | [diff] [blame] | 225 | EXPECT_EQ(70u, FPDFAttachment_GetStringValue(attachment, kChecksumKey, |
Jane Liu | 54a4214 | 2017-07-24 16:40:54 -0400 | [diff] [blame] | 226 | buf.data(), len)); |
| 227 | EXPECT_EQ(L"<D41D8CD98F00B204E9800998ECF8427E>", |
| 228 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data()))); |
Jane Liu | f63e813 | 2017-07-25 18:11:27 -0400 | [diff] [blame] | 229 | } |
| 230 | |
Lei Zhang | ab41f25 | 2018-12-23 03:10:50 +0000 | [diff] [blame] | 231 | TEST_F(FPDFAttachmentEmbedderTest, DeleteAttachment) { |
Jane Liu | f63e813 | 2017-07-25 18:11:27 -0400 | [diff] [blame] | 232 | // Open a file with two attachments. |
| 233 | ASSERT_TRUE(OpenDocument("embedded_attachments.pdf")); |
| 234 | EXPECT_EQ(2, FPDFDoc_GetAttachmentCount(document())); |
| 235 | |
| 236 | // Verify the name of the first attachment. |
| 237 | FPDF_ATTACHMENT attachment = FPDFDoc_GetAttachment(document(), 0); |
| 238 | unsigned long len = FPDFAttachment_GetName(attachment, nullptr, 0); |
| 239 | std::vector<char> buf(len); |
| 240 | EXPECT_EQ(12u, FPDFAttachment_GetName(attachment, buf.data(), len)); |
| 241 | EXPECT_STREQ(L"1.txt", |
| 242 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 243 | .c_str()); |
| 244 | |
| 245 | // Delete the first attachment. |
| 246 | EXPECT_TRUE(FPDFDoc_DeleteAttachment(document(), 0)); |
| 247 | EXPECT_EQ(1, FPDFDoc_GetAttachmentCount(document())); |
| 248 | |
| 249 | // Verify the name of the new first attachment. |
| 250 | attachment = FPDFDoc_GetAttachment(document(), 0); |
| 251 | len = FPDFAttachment_GetName(attachment, nullptr, 0); |
| 252 | buf.clear(); |
| 253 | buf.resize(len); |
| 254 | EXPECT_EQ(26u, FPDFAttachment_GetName(attachment, buf.data(), len)); |
| 255 | EXPECT_STREQ(L"attached.pdf", |
| 256 | GetPlatformWString(reinterpret_cast<unsigned short*>(buf.data())) |
| 257 | .c_str()); |
| 258 | } |