Module: OBF::PDF

Defined in:
lib/obf/pdf.rb

Constant Summary collapse

RTL_SCRIPTS = 
%w(Arabic Hebrew Nko Kharoshthi Phoenician Syriac Thaana Tifinagh Tamil)
NEPALI_ALPHABET = 
"कखगघङचछजझञटठडढणतथदधनपफबभमयरलवशषसहक्षत्रज्ञअआइईउऊऋएऐओऔअंअः"

Class Method Summary collapse

Class Method Details

.build_page(pdf, obj, options) ⇒ Object 



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
 
# File 'lib/obf/pdf.rb', line 129

def self.build_page(pdf, obj, options)
  OBF::Utils.as_progress_percent(0, 1.0) do
    pdf.font(options['font']) if options['font'] && File.exists?(options['font'])
    doc_width = 11*72 - 72
    doc_height = 8.5*72 - 72
    default_radius = 3
    text_height = 20
    header_height = 0
  
    if options['pages']
      page_num = options['pages'][obj['id']]
      pdf.add_dest("page#{page_num}", pdf.dest_fit) if options['links']
    end
    # header
    if !options['headerless']
      header_height = 100
      pdf.bounding_box([0, doc_height], :width => doc_width, :height => 100) do
        pdf.line_width = 2
        pdf.font_size 16
      
        pdf.fill_color "eeeeee"
        pdf.stroke_color "888888"
        pdf.fill_and_stroke_rounded_rectangle [0, 100], 100, 100, default_radius
        pdf.fill_color "6D81D1"
        pdf.fill_and_stroke_polygon([5, 50], [35, 85], [35, 70], [95, 70], [95, 30], [35, 30], [35, 15])
        pdf.fill_color "ffffff"
        text_options = {:text => "Go Back"}
        text_options[:anchor] = "page1" if options['links']
        pdf.formatted_text_box [text_options], :at => [10, 90], :width => 80, :height => 80, :align => :center, :valign => :center, :overflow => :shrink_to_fit
        pdf.fill_color "ffffff"
        pdf.fill_and_stroke_rounded_rectangle [110, 100], (doc_width - 200 - 20), 100, default_radius
        pdf.fill_color "DDDB54"
        pdf.fill_and_stroke do
          pdf.move_to 160, 50
          pdf.line_to 190, 70
          pdf.curve_to [190, 30], :bounds => [[100, 130], [100, -30]]
          pdf.line_to 160, 50
        end
        pdf.fill_color "444444"
        pdf.text_box "Say that sentence out loud for me", :at => [210, 90], :width => (doc_width - 200 - 120), :height => 80, :align => :left, :valign => :center, :overflow => :shrink_to_fit
        pdf.fill_color "eeeeee"
        pdf.fill_and_stroke_rounded_rectangle [(doc_width - 100), 100], 100, 100, default_radius
        pdf.fill_color "aaaaaa"
        pdf.fill_and_stroke_polygon([doc_width - 100 + 5, 50], [doc_width - 100 + 35, 85], [doc_width - 100 + 95, 85], [doc_width - 100 + 95, 15], [doc_width - 100 + 35, 15])
        pdf.fill_color "ffffff"
        pdf.text_box "Erase", :at => [(doc_width - 100 + 10), 90], :width => 80, :height => 80, :align => :center, :valign => :center, :overflow => :shrink_to_fit
      end
    end
  
    # board
    pdf.font_size 12
    padding = 10
    grid_height = doc_height - header_height - text_height - (padding * 2)
    grid_width = doc_width
    if obj['grid'] && obj['grid']['rows'] > 0 && obj['grid']['columns'] > 0
      button_height = (grid_height - (padding * (obj['grid']['rows'] - 1))) / obj['grid']['rows'].to_f
      button_width = (grid_width - (padding * (obj['grid']['columns'] - 1))) / obj['grid']['columns'].to_f

      # Grab all the images per board in parallel
      OBF::Utils.log "  batch-retrieving remote images"
      hydra = Typhoeus::Hydra.hydra
      grabs = []
      obj['buttons'].each do |btn|
        image = (obj['images_hash'] || {})[btn['image_id']]
        if image && image['url'] && !image['data'] && !(image['path'] && options['zipper'])
          url = image['url']
          res = OBF::Utils.get_url(url, true)
          if res['request']
            hydra.queue(res['request'])
            grabs << {url: url, req: res['request'], image: image, fill: btn['background_color'] ? OBF::Utils.fix_color(btn['background_color'], 'hex') : "ffffff"}
          end
        elsif image && image['data'] && !(image['path'] && options['zipper'])
          grabs << {image: image, fill: btn['background_color'] ? OBF::Utils.fix_color(btn['background_color'], 'hex') : "ffffff"}
        end
      end
      hydra.run
      threads = []
      grabs.each do |grab|
        if grab[:req]
          grab[:image]['raw_data'] = grab[:req].response.body
          grab[:image]['content_type'] ||= grab[:req].response.headers['Content-Type'] if grab[:req].response.headers['Content-Type']
        end
        grab[:image]['threadable'] = true
        bg = 'white'
        if options['transparent_background'] || options['symbol_background'] == 'transparent'
          bg = "\##{grab[:fill]}"
        elsif options['symbol_background'] == 'black'
          bg = 'black'
        end
        res = OBF::Utils.save_image(grab[:image], options['zipper'], bg)
        threads << res if res && !res.is_a?(String)
      end
      threads.each{|t| t.join }
      grabs.each{|g| g[:image].delete('threadable') }
      OBF::Utils.log "  done with #{grabs.length} remote images!"

      obj['grid']['order'].each_with_index do |buttons, row|
        buttons.each_with_index do |button_id, col|
          button = obj['buttons'].detect{|b| b['id'] == button_id }
          next if !button || button['hidden'] == true
          x = (padding * col) + (col * button_width)
          y = text_height + padding - (padding * row) + grid_height - (row * button_height)
          pdf.bounding_box([x, y], :width => button_width, :height => button_height) do
            fill = "ffffff"
            border = "eeeeee"
            if button['background_color']
              fill = OBF::Utils.fix_color(button['background_color'], 'hex')
            end   
            if button['border_color']
              border = OBF::Utils.fix_color(button['border_color'], 'hex')
            end         
            pdf.fill_color fill
            pdf.stroke_color border
            pdf.fill_and_stroke_rounded_rectangle [0, button_height], button_width, button_height, default_radius
            vertical = options['text_on_top'] ? button_height - text_height : button_height - 5

            text = (button['label'] || button['vocalization']).to_s
            font = options['font']
            # Nepali text isn't working as a fallback for some reason, it says "bad font family"
            if text.match(Regexp.new("[" + NEPALI_ALPHABET + "]"))
              font = File.expand_path('../../MiedingerBook.ttf', __FILE__)
            end
            pdf.font(font) if font && File.exists?(font)
            direction = text.match(rtl_regex) ? :rtl : :ltr
            if options['text_case'] == 'upper'
              text = text.upcase
            elsif options['text_case'] == 'lower'
              text = text.downcase
            end
            text_color = OBF::Utils.fix_color(fill, 'contrast')
            
            if options['text_only']
              # render text
              pdf.fill_color text_color
              pdf.text_box text, :at => [0, 0], :width => button_width, :height => button_height, :align => :center, :valign => :center, :overflow => :shrink_to_fit, :direction => direction
            else
              # render image
              pdf.bounding_box([5, vertical], :width => button_width - 10, :height => button_height - text_height - 5) do
                image = (obj['images_hash'] || {})[button['image_id']]
                if image
                  bg = 'white'
                  if options['transparent_background'] || options['symbol_background'] == 'transparent'
                    bg = "\##{fill}"
                  elsif options['symbol_background'] == 'black'
                    bg = 'black'
                  end
                  image_local_path = image && (image['local_path'] || OBF::Utils.save_image(image, options['zipper'], bg))
                  if image_local_path && File.exist?(image_local_path)
                    pdf.image(image_local_path, :fit => [button_width - 10, button_height - text_height - 5], :position => :center, :vposition => :center) rescue nil
                    File.unlink image_local_path
                  end
                end
              end
              if options['pages'] && button['load_board']
                page = options['pages'][button['load_board']['id']]
                if page
                  page_vertical = options['text_on_top'] ? -2 + text_height : button_height + 2
                  pdf.fill_color "ffffff"            
                  pdf.stroke_color "eeeeee"            
                  pdf.fill_and_stroke_rounded_rectangle [button_width - 18, page_vertical], 20, text_height, 5
                  pdf.fill_color text_color
                  text_options = {:text => page}
                  text_options[:anchor] = "page#{page}" if options['links']
                  pdf.formatted_text_box [text_options], :at => [button_width - 18, page_vertical], :width => 20, :height => text_height, :align => :center, :valign => :center
                end
              end
            
              # render text
              pdf.fill_color text_color
              vertical = options['text_on_top'] ? button_height : text_height
              pdf.text_box text, :at => [0, vertical], :width => button_width, :height => text_height, :align => :center, :valign => :center, :overflow => :shrink_to_fit, :direction => direction
            end
            pdf.font(options['font']) if options['font'] && File.exists?(options['font'])
          end
          index = col + (row * obj['grid']['columns'])
          OBF::Utils.update_current_progress(index.to_f / (obj['grid']['rows'] * obj['grid']['columns']).to_f)
        end
      end
    end
  
    # footer
    pdf.fill_color "aaaaaa"
    if OBF::PDF.footer_text
      text = OBF::PDF.footer_text
      pdf.formatted_text_box [{:text => text, :link => OBF::PDF.footer_url}], :at => [doc_width - 300, text_height], :width => 200, :height => text_height, :align => :right, :valign => :center, :overflow => :shrink_to_fit
    end
    pdf.fill_color "000000"
    if options['pages']
      text_options = {:text => options['pages'][obj['id']]}
      text_options[:anchor] = "page1" if options['links']
      pdf.formatted_text_box [text_options], :at => [doc_width - 100, text_height], :width => 100, :height => text_height, :align => :right, :valign => :center, :overflow => :shrink_to_fit
    end
  end
end

.build_pdf(obj, dest_path, zipper, opts = {}) ⇒ Object 



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
 
# File 'lib/obf/pdf.rb', line 35

def self.build_pdf(obj, dest_path, zipper, opts={})
  OBF::Utils.as_progress_percent(0, 1.0) do
    # parse obf, draw as pdf
    doc_opts = {
      :page_layout => :landscape, 
      :page_size => [8.5*72, 11*72],
      :info => {
        :Title => obj['name']
      }
    }
    pdf = Prawn::Document.new(doc_opts)
    # remember: https://www.alphabet-type.com/tools/charset-checker/
    pdf.font_families['THFahKwangBold'] = {
      normal: {font: 'THFahKwangBold', file: File.expand_path('../../THFahKwangBold.ttf', __FILE__)}
    }
    pdf.font_families['MiedingerBook'] = {
      normal: {font: 'MiedingerBook', file: File.expand_path('../../MiedingerBook.ttf', __FILE__)}
    }
    pdf.font_families['TimesNewRoman'] = {
      normal: {font: 'TimesNewRoman', file: File.expand_path('../../TimesNewRoman.ttf', __FILE__)}
    }
    pdf.fallback_fonts = ['TimesNewRoman', 'THFahKwangBold', 'MiedingerBook']

    font = opts['font'] if opts['font'] && File.exists?(opts['font'])
    font ||= File.expand_path('../../TimesNewRoman.ttf', __FILE__)
    pdf.font(font) if File.exists?(font)
  
    multi_render_paths = []
    if obj['boards']
      multi_render = obj['boards'].length > 20
      obj['boards'].each_with_index do |board, idx|
        started = Time.now.to_i
        OBF::Utils.log "starting pdf of board #{idx} #{board['name'] || board['id']} at #{started}"
        pre = idx.to_f / obj['boards'].length.to_f
        post = (idx + 1).to_f / obj['boards'].length.to_f
        OBF::Utils.as_progress_percent(pre, post) do
          # if more than 20 pages, build each page individually 
          # and combine them afterwards
          if multi_render
            path = OBF::Utils.temp_path("stash-#{idx}.pdf")
            pdf = Prawn::Document.new(doc_opts)
            build_page(pdf, board, {
              'zipper' => zipper, 
              'pages' => obj['pages'], 
              'headerless' => !!opts['headerless'], 
              'font' => font,
              'links' => false,
              'text_on_top' => !!opts['text_on_top'], 
              'transparent_background' => !!opts['transparent_background'],
              'symbol_background' => opts['symbol_background'],
              'text_case' => opts['text_case']
            })
            pdf.render_file(path)
            multi_render_paths << path
          else
            pdf.start_new_page unless idx == 0
            build_page(pdf, board, {
              'zipper' => zipper, 
              'pages' => obj['pages'], 
              'headerless' => !!opts['headerless'], 
              'font' => font,
              'links' => true,
              'text_on_top' => !!opts['text_on_top'], 
              'transparent_background' => !!opts['transparent_background'],
              'symbol_background' => opts['symbol_background'],
              'text_case' => opts['text_case']
            })
          end
        end
        OBF::Utils.log "  finished pdf of board #{idx}/#{obj['boards'].length} #{Time.now.to_i - started}s"
      end
    else
      build_page(pdf, obj, {
        'headerless' => !!opts['headerless'], 
        'font' => font,
        'text_on_top' => !!opts['text_on_top'], 
        'transparent_background' => !!opts['transparent_background'],
        'symbol_background' => opts['symbol_background'],
        'text_case' => opts['text_case']
      })
    end
    if multi_render_paths.length > 0
      `gs -dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -dPDFSETTINGS=/prepress -sOutputFile=#{dest_path} #{multi_render_paths.join(' ')}`
    else
      pdf.render_file(dest_path)
    end
  
  end
end

.footer_text ⇒ Object 



8
9
10
 
# File 'lib/obf/pdf.rb', line 8

def self.footer_text
  @@footer_text
end

.footer_text=(text) ⇒ Object 



12
13
14
 
# File 'lib/obf/pdf.rb', line 12

def self.footer_text=(text)
  @@footer_text = text
end

.footer_url ⇒ Object 



16
17
18
 
# File 'lib/obf/pdf.rb', line 16

def self.footer_url
  @@footer_url
end

.footer_url=(url) ⇒ Object 



20
21
22
 
# File 'lib/obf/pdf.rb', line 20

def self.footer_url=(url)
  @@footer_url = url
end

.from_external(content, dest_path) ⇒ Object 



371
372
373
374
375
376
377
378
379
380
 
# File 'lib/obf/pdf.rb', line 371

def self.from_external(content, dest_path)
  tmp_path = OBF::Utils.temp_path("stash")
  if content['boards']
    from_obz(OBF::OBZ.from_external(content, tmp_path), dest_path)
  else
    from_obf(OBF::OBF.from_external(content, tmp_path), dest_path)
  end
  File.unlink(tmp_path) if File.exist?(tmp_path)
  dest_path
end

.from_obf(obf_json_or_path, dest_path, zipper = nil, opts = {}) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/obf/pdf.rb', line 24

def self.from_obf(obf_json_or_path, dest_path, zipper=nil, opts={})
  obj = obf_json_or_path
  if obj.is_a?(String)
    obj = OBF::Utils.parse_obf(File.read(obf_json_or_path))
  else
    obj = OBF::Utils.parse_obf(obf_json_or_path)
  end
  build_pdf(obj, dest_path, zipper, opts)
  return dest_path
end

.from_obz(obz_path, dest_path, opts = {}) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/obf/pdf.rb', line 324

def self.from_obz(obz_path, dest_path, opts={})
  OBF::Utils.load_zip(obz_path) do |zipper|
    manifest = JSON.parse(zipper.read('manifest.json'))
    root = manifest['root']
    board = OBF::Utils.parse_obf(zipper.read(root))
    board['path'] = root
    unvisited_boards = [board]
    visited_boards = []
    while unvisited_boards.length > 0
      board = unvisited_boards.shift
      visited_boards << board
      children = []
      board['buttons'].each do |button|
        if button['load_board']
          children << button['load_board']
          all_boards = visited_boards + unvisited_boards
          if all_boards.none?{|b| b['id'] == button['load_board']['id'] || b['path'] == button['load_board']['path'] }
            path = button['load_board']['path'] || (manifest['paths'] && manifest['paths']['boards'] && manifest['paths']['boards'][button['load_board']['id']])
            if path
              b = OBF::Utils.parse_obf(zipper.read(path))
              b['path'] = path
              button['load_board']['id'] = b['id']
              unvisited_boards << b
            end
          end
        end
      end
    end
    
    pages = {}
    visited_boards.each_with_index do |board, idx|
      pages[board['id']] = (idx + 1).to_s
    end
    
    build_pdf({
      'name' => 'Communication Board Set',
      'boards' => visited_boards,
      'pages' => pages
    }, dest_path, zipper, opts)
  end
  # parse obz, draw as pdf

  # TODO: helper files included at the end for emergencies (eg. body parts)
  
  return dest_path
end

.rtl_regex ⇒ Object 



125
126
127
 
# File 'lib/obf/pdf.rb', line 125

def self.rtl_regex
  @res ||= /[#{RTL_SCRIPTS.map{ |script| "\\p{#{script}}" }.join}]/
end

.to_png(pdf, dest_path) ⇒ Object 



382
383
384
 
# File 'lib/obf/pdf.rb', line 382

def self.to_png(pdf, dest_path)
  OBF::PNG.from_pdf(pdf, dest_path)
end