-
Notifications
You must be signed in to change notification settings - Fork 271
/
reader.rb
329 lines (306 loc) · 9.46 KB
/
reader.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# coding: utf-8
# typed: strict
# frozen_string_literal: true
################################################################################
#
# Copyright (C) 2006 Peter J Jones (pjones@pmade.com)
# Copyright (C) 2011 James Healy
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
################################################################################
require 'stringio'
module PDF
################################################################################
# The Reader class serves as an entry point for parsing a PDF file.
#
# PDF is a page based file format. There is some data associated with the
# document (metadata, bookmarks, etc) but all visible content is stored
# under a Page object.
#
# In most use cases for extracting and examining the contents of a PDF it
# makes sense to traverse the information using page based iteration.
#
# In addition to the documentation here, check out the
# PDF::Reader::Page class.
#
# == File Metadata
#
# reader = PDF::Reader.new("somefile.pdf")
#
# puts reader.pdf_version
# puts reader.info
# puts reader.metadata
# puts reader.page_count
#
# == Iterating over page content
#
# reader = PDF::Reader.new("somefile.pdf")
#
# reader.pages.each do |page|
# puts page.fonts
# puts page.images
# puts page.text
# end
#
# == Extracting all text
#
# reader = PDF::Reader.new("somefile.pdf")
#
# reader.pages.map(&:text)
#
# == Extracting content from a single page
#
# reader = PDF::Reader.new("somefile.pdf")
#
# page = reader.page(1)
# puts page.fonts
# puts page.images
# puts page.text
#
# == Low level callbacks (ala current version of PDF::Reader)
#
# reader = PDF::Reader.new("somefile.pdf")
#
# page = reader.page(1)
# page.walk(receiver)
#
# == Encrypted Files
#
# Depending on the algorithm it may be possible to parse an encrypted file.
# For standard PDF encryption you'll need the :password option
#
# reader = PDF::Reader.new("somefile.pdf", :password => "apples")
#
class Reader
# lowlevel hash-like access to all objects in the underlying PDF
attr_reader :objects
# creates a new document reader for the provided PDF.
#
# input can be an IO-ish object (StringIO, File, etc) containing a PDF
# or a filename
#
# reader = PDF::Reader.new("somefile.pdf")
#
# File.open("somefile.pdf","rb") do |file|
# reader = PDF::Reader.new(file)
# end
#
# If the source file is encrypted you can provide a password for decrypting
#
# reader = PDF::Reader.new("somefile.pdf", :password => "apples")
#
# Using this method directly is supported, but it's more common to use
# `PDF::Reader.open`
#
def initialize(input, opts = {})
@cache = PDF::Reader::ObjectCache.new
opts.merge!(:cache => @cache)
@objects = PDF::Reader::ObjectHash.new(input, opts)
end
# Return a Hash with some basic information about the PDF file
#
def info
dict = @objects.deref_hash(@objects.trailer[:Info]) || {}
doc_strings_to_utf8(dict)
end
# Return a String with extra XML metadata provided by the author of the PDF file. Not
# always present.
#
def metadata
stream = @objects.deref_stream(root[:Metadata])
if stream.nil?
nil
else
xml = stream.unfiltered_data
xml.force_encoding("utf-8")
xml
end
end
# To number of pages in this PDF
#
def page_count
pages = @objects.deref_hash(root[:Pages])
unless pages.kind_of?(::Hash)
raise MalformedPDFError, "Pages structure is missing #{pages.class}"
end
@page_count ||= @objects.deref_integer(pages[:Count]) || 0
end
# The PDF version this file uses
#
def pdf_version
@objects.pdf_version
end
# syntactic sugar for opening a PDF file and the most common approach. Accepts the
# same arguments as new().
#
# PDF::Reader.open("somefile.pdf") do |reader|
# puts reader.pdf_version
# end
#
# or
#
# PDF::Reader.open("somefile.pdf", :password => "apples") do |reader|
# puts reader.pdf_version
# end
#
def self.open(input, opts = {}, &block)
yield PDF::Reader.new(input, opts)
end
# returns an array of PDF::Reader::Page objects, one for each
# page in the source PDF.
#
# reader = PDF::Reader.new("somefile.pdf")
#
# reader.pages.each do |page|
# puts page.fonts
# puts page.rectangles
# puts page.text
# end
#
# See the docs for PDF::Reader::Page to read more about the
# methods available on each page
#
def pages
return [] if page_count <= 0
(1..self.page_count).map do |num|
begin
PDF::Reader::Page.new(@objects, num, :cache => @cache)
rescue InvalidPageError
raise MalformedPDFError, "Missing data for page: #{num}"
end
end
end
# returns a single PDF::Reader::Page for the specified page.
# Use this instead of pages method when you need to access just a single
# page
#
# reader = PDF::Reader.new("somefile.pdf")
# page = reader.page(10)
#
# puts page.text
#
# See the docs for PDF::Reader::Page to read more about the
# methods available on each page
#
def page(num)
num = num.to_i
if num < 1 || num > self.page_count
raise InvalidPageError, "Valid pages are 1 .. #{self.page_count}"
end
PDF::Reader::Page.new(@objects, num, :cache => @cache)
end
private
# recursively convert strings from outside a content stream into UTF-8
#
def doc_strings_to_utf8(obj)
case obj
when ::Hash then
{}.tap { |new_hash|
obj.each do |key, value|
new_hash[key] = doc_strings_to_utf8(value)
end
}
when Array then
obj.map { |item| doc_strings_to_utf8(item) }
when String then
if has_utf16_bom?(obj)
utf16_to_utf8(obj)
else
pdfdoc_to_utf8(obj)
end
else
obj
end
end
def has_utf16_bom?(str)
first_bytes = str[0,2]
return false if first_bytes.nil?
first_bytes.unpack("C*") == [254, 255]
end
# TODO find a PDF I can use to spec this behaviour
#
def pdfdoc_to_utf8(obj)
obj.force_encoding("utf-8")
obj
end
# one day we'll all run on a 1.9 compatible VM and I can just do this with
# String#encode
#
def utf16_to_utf8(obj)
str = obj[2, obj.size].to_s
str = str.unpack("n*").pack("U*")
str.force_encoding("utf-8")
str
end
def root
@root ||= @objects.deref_hash(@objects.trailer[:Root]) || {}
end
end
end
################################################################################
require 'pdf/reader/resources'
require 'pdf/reader/buffer'
require 'pdf/reader/bounding_rectangle_runs_filter'
require 'pdf/reader/cid_widths'
require 'pdf/reader/cmap'
require 'pdf/reader/encoding'
require 'pdf/reader/error'
require 'pdf/reader/filter'
require 'pdf/reader/filter/ascii85'
require 'pdf/reader/filter/ascii_hex'
require 'pdf/reader/filter/depredict'
require 'pdf/reader/filter/flate'
require 'pdf/reader/filter/lzw'
require 'pdf/reader/filter/null'
require 'pdf/reader/filter/run_length'
require 'pdf/reader/font'
require 'pdf/reader/font_descriptor'
require 'pdf/reader/form_xobject'
require 'pdf/reader/glyph_hash'
require 'pdf/reader/lzw'
require 'pdf/reader/object_cache'
require 'pdf/reader/object_hash'
require 'pdf/reader/object_stream'
require 'pdf/reader/pages_strategy'
require 'pdf/reader/parser'
require 'pdf/reader/point'
require 'pdf/reader/print_receiver'
require 'pdf/reader/rectangle'
require 'pdf/reader/reference'
require 'pdf/reader/register_receiver'
require 'pdf/reader/no_text_filter'
require 'pdf/reader/null_security_handler'
require 'pdf/reader/security_handler_factory'
require 'pdf/reader/standard_key_builder'
require 'pdf/reader/key_builder_v5'
require 'pdf/reader/aes_v2_security_handler'
require 'pdf/reader/aes_v3_security_handler'
require 'pdf/reader/rc4_security_handler'
require 'pdf/reader/unimplemented_security_handler'
require 'pdf/reader/stream'
require 'pdf/reader/text_run'
require 'pdf/reader/type_check'
require 'pdf/reader/page_state'
require 'pdf/reader/page_text_receiver'
require 'pdf/reader/token'
require 'pdf/reader/xref'
require 'pdf/reader/page'
require 'pdf/reader/validating_receiver'