1 // Copyright 2014 The PDFium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #include "public/fpdf_dataavail.h"
8
9 #include <memory>
10 #include <utility>
11
12 #include "core/fpdfapi/page/cpdf_docpagedata.h"
13 #include "core/fpdfapi/parser/cpdf_data_avail.h"
14 #include "core/fpdfapi/parser/cpdf_document.h"
15 #include "core/fpdfapi/render/cpdf_docrenderdata.h"
16 #include "core/fxcrt/fx_safe_types.h"
17 #include "core/fxcrt/fx_stream.h"
18 #include "core/fxcrt/retain_ptr.h"
19 #include "core/fxcrt/unowned_ptr.h"
20 #include "core/fxcrt/unowned_ptr_exclusion.h"
21 #include "fpdfsdk/cpdfsdk_helpers.h"
22 #include "public/fpdf_formfill.h"
23 #include "third_party/base/numerics/safe_conversions.h"
24
25 #ifdef PDF_ENABLE_XFA
26 #include "fpdfsdk/fpdfxfa/cpdfxfa_context.h"
27 #endif // PDF_ENABLE_XFA
28
29 // These checks are here because core/ and public/ cannot depend on each other.
30 static_assert(CPDF_DataAvail::kDataError == PDF_DATA_ERROR,
31 "CPDF_DataAvail::kDataError value mismatch");
32 static_assert(CPDF_DataAvail::kDataNotAvailable == PDF_DATA_NOTAVAIL,
33 "CPDF_DataAvail::kDataNotAvailable value mismatch");
34 static_assert(CPDF_DataAvail::kDataAvailable == PDF_DATA_AVAIL,
35 "CPDF_DataAvail::kDataAvailable value mismatch");
36
37 static_assert(CPDF_DataAvail::kLinearizationUnknown ==
38 PDF_LINEARIZATION_UNKNOWN,
39 "CPDF_DataAvail::kLinearizationUnknown value mismatch");
40 static_assert(CPDF_DataAvail::kNotLinearized == PDF_NOT_LINEARIZED,
41 "CPDF_DataAvail::kNotLinearized value mismatch");
42 static_assert(CPDF_DataAvail::kLinearized == PDF_LINEARIZED,
43 "CPDF_DataAvail::kLinearized value mismatch");
44
45 static_assert(CPDF_DataAvail::kFormError == PDF_FORM_ERROR,
46 "CPDF_DataAvail::kFormError value mismatch");
47 static_assert(CPDF_DataAvail::kFormNotAvailable == PDF_FORM_NOTAVAIL,
48 "CPDF_DataAvail::kFormNotAvailable value mismatch");
49 static_assert(CPDF_DataAvail::kFormAvailable == PDF_FORM_AVAIL,
50 "CPDF_DataAvail::kFormAvailable value mismatch");
51 static_assert(CPDF_DataAvail::kFormNotExist == PDF_FORM_NOTEXIST,
52 "CPDF_DataAvail::kFormNotExist value mismatch");
53
54 namespace {
55
56 class FPDF_FileAvailContext final : public CPDF_DataAvail::FileAvail {
57 public:
FPDF_FileAvailContext(FX_FILEAVAIL * avail)58 explicit FPDF_FileAvailContext(FX_FILEAVAIL* avail) : avail_(avail) {}
59 ~FPDF_FileAvailContext() override = default;
60
61 // CPDF_DataAvail::FileAvail:
IsDataAvail(FX_FILESIZE offset,size_t size)62 bool IsDataAvail(FX_FILESIZE offset, size_t size) override {
63 return !!avail_->IsDataAvail(
64 avail_, pdfium::base::checked_cast<size_t>(offset), size);
65 }
66
67 private:
68 // TODO(tsepez): fix murky ownership in tests.
69 UNOWNED_PTR_EXCLUSION FX_FILEAVAIL* const avail_;
70 };
71
72 class FPDF_FileAccessContext final : public IFX_SeekableReadStream {
73 public:
74 CONSTRUCT_VIA_MAKE_RETAIN;
75
76 // IFX_SeekableReadStream:
GetSize()77 FX_FILESIZE GetSize() override { return file_->m_FileLen; }
78
ReadBlockAtOffset(pdfium::span<uint8_t> buffer,FX_FILESIZE offset)79 bool ReadBlockAtOffset(pdfium::span<uint8_t> buffer,
80 FX_FILESIZE offset) override {
81 if (buffer.empty() || offset < 0)
82 return false;
83
84 if (!pdfium::base::IsValueInRangeForNumericType<FX_FILESIZE>(buffer.size()))
85 return false;
86
87 FX_SAFE_FILESIZE new_pos = buffer.size();
88 new_pos += offset;
89 return new_pos.IsValid() && new_pos.ValueOrDie() <= GetSize() &&
90 file_->m_GetBlock(
91 file_->m_Param,
92 pdfium::base::checked_cast<unsigned long>(offset), buffer.data(),
93 pdfium::base::checked_cast<unsigned long>(buffer.size()));
94 }
95
96 private:
FPDF_FileAccessContext(FPDF_FILEACCESS * file)97 explicit FPDF_FileAccessContext(FPDF_FILEACCESS* file) : file_(file) {}
98 ~FPDF_FileAccessContext() override = default;
99
100 // TODO(tsepez): fix murky ownership in tests.
101 UNOWNED_PTR_EXCLUSION FPDF_FILEACCESS* const file_;
102 };
103
104 class FPDF_DownloadHintsContext final : public CPDF_DataAvail::DownloadHints {
105 public:
FPDF_DownloadHintsContext(FX_DOWNLOADHINTS * pDownloadHints)106 explicit FPDF_DownloadHintsContext(FX_DOWNLOADHINTS* pDownloadHints)
107 : m_pDownloadHints(pDownloadHints) {}
108 ~FPDF_DownloadHintsContext() override = default;
109
110 // IFX_DownloadHints
AddSegment(FX_FILESIZE offset,size_t size)111 void AddSegment(FX_FILESIZE offset, size_t size) override {
112 if (m_pDownloadHints) {
113 m_pDownloadHints->AddSegment(m_pDownloadHints,
114 static_cast<size_t>(offset), size);
115 }
116 }
117
118 private:
119 UnownedPtr<FX_DOWNLOADHINTS> m_pDownloadHints;
120 };
121
122 class FPDF_AvailContext {
123 public:
FPDF_AvailContext(FX_FILEAVAIL * file_avail,FPDF_FILEACCESS * file)124 FPDF_AvailContext(FX_FILEAVAIL* file_avail, FPDF_FILEACCESS* file)
125 : file_avail_(std::make_unique<FPDF_FileAvailContext>(file_avail)),
126 file_read_(pdfium::MakeRetain<FPDF_FileAccessContext>(file)),
127 data_avail_(
128 std::make_unique<CPDF_DataAvail>(file_avail_.get(), file_read_)) {}
129 ~FPDF_AvailContext() = default;
130
data_avail()131 CPDF_DataAvail* data_avail() { return data_avail_.get(); }
132
133 private:
134 std::unique_ptr<FPDF_FileAvailContext> const file_avail_;
135 RetainPtr<FPDF_FileAccessContext> const file_read_;
136 std::unique_ptr<CPDF_DataAvail> const data_avail_;
137 };
138
FPDFAvailContextFromFPDFAvail(FPDF_AVAIL avail)139 FPDF_AvailContext* FPDFAvailContextFromFPDFAvail(FPDF_AVAIL avail) {
140 return reinterpret_cast<FPDF_AvailContext*>(avail);
141 }
142
FPDFAvailFromFPDFAvailContext(FPDF_AvailContext * pAvailContext)143 FPDF_AVAIL FPDFAvailFromFPDFAvailContext(FPDF_AvailContext* pAvailContext) {
144 return reinterpret_cast<FPDF_AVAIL>(pAvailContext);
145 }
146
147 } // namespace
148
FPDFAvail_Create(FX_FILEAVAIL * file_avail,FPDF_FILEACCESS * file)149 FPDF_EXPORT FPDF_AVAIL FPDF_CALLCONV FPDFAvail_Create(FX_FILEAVAIL* file_avail,
150 FPDF_FILEACCESS* file) {
151 auto pAvail = std::make_unique<FPDF_AvailContext>(file_avail, file);
152
153 // Caller takes ownership.
154 return FPDFAvailFromFPDFAvailContext(pAvail.release());
155 }
156
FPDFAvail_Destroy(FPDF_AVAIL avail)157 FPDF_EXPORT void FPDF_CALLCONV FPDFAvail_Destroy(FPDF_AVAIL avail) {
158 // Take ownership back from caller and destroy.
159 std::unique_ptr<FPDF_AvailContext>(FPDFAvailContextFromFPDFAvail(avail));
160 }
161
FPDFAvail_IsDocAvail(FPDF_AVAIL avail,FX_DOWNLOADHINTS * hints)162 FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_IsDocAvail(FPDF_AVAIL avail,
163 FX_DOWNLOADHINTS* hints) {
164 auto* avail_context = FPDFAvailContextFromFPDFAvail(avail);
165 if (!avail_context)
166 return PDF_DATA_ERROR;
167 FPDF_DownloadHintsContext hints_context(hints);
168 return avail_context->data_avail()->IsDocAvail(&hints_context);
169 }
170
171 FPDF_EXPORT FPDF_DOCUMENT FPDF_CALLCONV
FPDFAvail_GetDocument(FPDF_AVAIL avail,FPDF_BYTESTRING password)172 FPDFAvail_GetDocument(FPDF_AVAIL avail, FPDF_BYTESTRING password) {
173 auto* avail_context = FPDFAvailContextFromFPDFAvail(avail);
174 if (!avail_context)
175 return nullptr;
176 CPDF_Parser::Error error;
177 std::unique_ptr<CPDF_Document> document;
178 std::tie(error, document) = avail_context->data_avail()->ParseDocument(
179 std::make_unique<CPDF_DocRenderData>(),
180 std::make_unique<CPDF_DocPageData>(), password);
181 if (error != CPDF_Parser::SUCCESS) {
182 ProcessParseError(error);
183 return nullptr;
184 }
185
186 ReportUnsupportedFeatures(document.get());
187 return FPDFDocumentFromCPDFDocument(document.release());
188 }
189
FPDFAvail_GetFirstPageNum(FPDF_DOCUMENT doc)190 FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_GetFirstPageNum(FPDF_DOCUMENT doc) {
191 CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(doc);
192 return pDoc ? pDoc->GetParser()->GetFirstPageNo() : 0;
193 }
194
FPDFAvail_IsPageAvail(FPDF_AVAIL avail,int page_index,FX_DOWNLOADHINTS * hints)195 FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_IsPageAvail(FPDF_AVAIL avail,
196 int page_index,
197 FX_DOWNLOADHINTS* hints) {
198 auto* avail_context = FPDFAvailContextFromFPDFAvail(avail);
199 if (!avail_context)
200 return PDF_DATA_ERROR;
201 if (page_index < 0)
202 return PDF_DATA_NOTAVAIL;
203 FPDF_DownloadHintsContext hints_context(hints);
204 return avail_context->data_avail()->IsPageAvail(page_index, &hints_context);
205 }
206
FPDFAvail_IsFormAvail(FPDF_AVAIL avail,FX_DOWNLOADHINTS * hints)207 FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_IsFormAvail(FPDF_AVAIL avail,
208 FX_DOWNLOADHINTS* hints) {
209 auto* avail_context = FPDFAvailContextFromFPDFAvail(avail);
210 if (!avail_context)
211 return PDF_FORM_ERROR;
212 FPDF_DownloadHintsContext hints_context(hints);
213 return avail_context->data_avail()->IsFormAvail(&hints_context);
214 }
215
FPDFAvail_IsLinearized(FPDF_AVAIL avail)216 FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_IsLinearized(FPDF_AVAIL avail) {
217 auto* avail_context = FPDFAvailContextFromFPDFAvail(avail);
218 if (!avail_context)
219 return PDF_LINEARIZATION_UNKNOWN;
220 return avail_context->data_avail()->IsLinearizedPDF();
221 }
222