Module: OBF::Utils

Defined in:
lib/obf/utils.rb

Defined Under Namespace

Classes: Zipper

Class Method Summary collapse

Class Method Details

.as_progress_percent(a, b, &block) ⇒ Object 



337
338
339
340
341
342
343
 
# File 'lib/obf/utils.rb', line 337

def self.as_progress_percent(a, b, &block)
  if Object.const_defined?('Progress') && Progress.respond_to?(:as_percent)
    Progress.as_percent(a, b, &block)
  else
    block.call
  end
end

.build_zip(dest_path = nil, &block) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
 
# File 'lib/obf/utils.rb', line 320

def self.build_zip(dest_path=nil, &block)
  require 'zip'
  
  if !dest_path
    dest_path = OBF::Utils.temp_path(['archive', '.obz'])
  end
  Zip::File.open(dest_path, Zip::File::CREATE) do |zipfile|
    block.call(Zipper.new(zipfile))
  end
end

.fix_color(str, type = 'hex') ⇒ Object 



192
193
194
195
196
197
198
199
200
 
# File 'lib/obf/utils.rb', line 192

def self.fix_color(str, type='hex')
  lookup = str + "::" + type
  @@colors ||= {}
  return @@colors[lookup] if @@colors[lookup]
  path = File.dirname(File.dirname(__FILE__)) + '/tinycolor_convert.js'
  color = `node #{path} "#{str}" #{type}`.strip
  @@colors[lookup] = color
  color
end

.get_url(url) ⇒ Object 



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

def self.get_url(url)
  return nil unless url
  content_type = nil
  data = nil
  if url.match(/^data:/)
    content_type = url.split(/;/)[0].split(/:/)[1]
    data = Base64.strict_decode64(url.split(/\,/, 2)[1])
  else
    res = Typhoeus.get(URI.escape(url))
    content_type = res.headers['Content-Type']
    data = res.body
  end
  type = MIME::Types[content_type]
  type = type && type[0]
  extension = ""
  if type.respond_to?(:preferred_extension)
    extension = ("." + type.preferred_extension) if type.preferred_extension
  elsif type.respond_to?(:extensions)
    extension = ("." + type.extensions[0]) if type && type.extensions && type.extensions.length > 0
  end
  {
    'content_type' => content_type,
    'data' => data,
    'extension' => extension
  }
end

.identify_file(path) ⇒ Object 



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

def self.identify_file(path)
  name = File.basename(path) rescue nil
  if name.match(/\.obf$/)
    return :obf
  elsif name.match(/\.obz$/)
    return :obz
  elsif name.match(/\.avz$/)
    return :avz
  else
    json = JSON.parse(File.read(path)) rescue nil
    if json
      if json['format'] && json['format'].match(/^open-board-/)
        return :obf
      end
      return :unknown
    end
    
    begin
      plist = CFPropertyList::List.new(:file => path) rescue nil
      plist_data = CFPropertyList.native_types(plist.value) rescue nil
      if plist_data
        if plist_data['$objects'] && plist_data['$objects'].any?{|o| o['$classname'] == 'SYWord' }
          return :sfy
        end
        return :unknown
      end
    rescue CFFormatError => e
    end
    
    xml = Nokogiri::XML(File.open(path)) rescue nil
    if xml && xml.children.length > 0
      if xml.children[0].name == 'sensorygrid'
        return :sgrid
      end
      return :unknown
    end

    begin
      type = nil
      load_zip(path) do |zipper|
        if zipper.glob('manifest.json').length > 0
          json = JSON.parse(zipper.read('manifest.json')) rescue nil
          if json['root'] && json['format'] && json['format'].match(/^open-board-/)
            type = :obz
          end
        end
        if !type && zipper.glob('*.js').length > 0
          json = JSON.parse(zipper.read('*.js')) rescue nil
          if json['locale'] && json['sheets']
            type = :picto4me
          end
        end
      end
      return type if type
    rescue Zip::Error => e
    end
  end
  return :unknown
end

.image_base64(url) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/obf/utils.rb', line 96

def self.image_base64(url)
  image = nil
  if url.match(/:\/\//)
    image = get_url(url)
  else
    types = MIME::Types.type_for(url)
    image = {
      'data' => File.read(url),
      'content_type' => types[0] && types[0].to_s
    }
  end
  return nil unless image
  str = "data:" + image['content_type']
  str += ";base64," + Base64.strict_encode64(image['data'])
  str
end

.image_raw(url) ⇒ Object 



90
91
92
93
94
 
# File 'lib/obf/utils.rb', line 90

def self.image_raw(url)
  image = get_url(url)
  return nil unless image
  image
end

.load_zip(path, &block) ⇒ Object 



312
313
314
315
316
317
318
 
# File 'lib/obf/utils.rb', line 312

def self.load_zip(path, &block)
  require 'zip'

  Zip::File.open(path) do |zipfile|
    block.call(Zipper.new(zipfile))
  end
end

.obf_shell ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/obf/utils.rb', line 177

def self.obf_shell
  {
    'format' => 'open-board-0.1',
    'license' => {'type' => 'private'},
    'buttons' => [],
    'grid' => {
      'rows' => 0,
      'columns' => 0,
      'order' => [[]]
    },
    'images' => [],
    'sounds' => []
  }
end

.parse_grid(pre_grid) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
 
# File 'lib/obf/utils.rb', line 240

def self.parse_grid(pre_grid)
  pre_grid ||= {}
  grid = {
    'rows' => pre_grid['rows'] || 1,
    'columns' => pre_grid['columns'] || 1,
    'order' => pre_grid['order'] || [[nil]]
  }
  # TODO: parse order better
  grid
end

.parse_license(pre_license) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/obf/utils.rb', line 227

def self.parse_license(pre_license)
  pre_license = {} unless pre_license.is_a?(Hash)
  license = {}
  ['type', 'copyright_notice_url', 'source_url', 'author_name', 'author_url', 'author_email', 'uneditable'].each do |attr|
    license[attr] = pre_license[attr] if pre_license[attr] != nil
  end
  license['type'] ||= 'private'
  license['copyright_notice_url'] ||= license['copyright_notice_link'] if license.key?('copyright_notice_link')
  license['source_url'] ||= license['source_link'] if license.key?('source_link')
  license['author_url'] ||= license['author_link'] if license.key?('author_link')
  license
end

.parse_obf(obj) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/obf/utils.rb', line 202

def self.parse_obf(obj)
  json = obj
  if obj.is_a?(String)
    json = JSON.parse(obj)
  end
  ['images', 'sounds', 'buttons'].each do |key|
    json["#{key}_hash"] = json[key]
    if json[key].is_a?(Array)
      hash = {}
      json[key].each do |item|
        hash[item['id']] = item
      end
      json["#{key}_hash"] = hash
    elsif json["#{key}_hash"]
      array = []
      json["#{key}_hash"].each do |id, item|
        item['id'] ||= id
        array << item
      end
      json[key] = array
    end
  end
  json
end

.save_image(image, zipper = nil) ⇒ Object 



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

def self.save_image(image, zipper=nil)
  if image['data']
    if !image['content_type']
      image['content_type'] = image['data'].split(/;/)[0].split(/:/)[1]
    end
  elsif image['path'] && zipper
    image['raw_data'] = zipper.read(image['path'])
    if !image['content_type']
      types = MIME::Types.type_for(image['path'])
      image['content_type'] = types[0] && types[0].to_s
    end
  elsif image['url']
    url_data = get_url(image['url'])
    image['raw_data'] = url_data['data']
    image['content_type'] = url_data['content_type']
  elsif image['symbol']
    # not supported
  end
  type = MIME::Types[image['content_type']]
  type = type && type[0]
  if type.respond_to?(:preferred_extension)
    extension = type && ("." + type.preferred_extension)
  elsif type.respond_to?(:extensions)
    extension = type && ("." + type.extensions.first)
  end
  file = Tempfile.new(["image_stash", extension.to_s])
  file.binmode
  if image['data']
    str = Base64.strict_decode64(image['data'].split(/\,/, 2)[1])
    file.write str
  elsif image['raw_data']
    file.write image['raw_data']
  else
    file.close
    return nil
  end
  file.close
  `convert #{file.path} -density 1200 -resize 300x300 -background none -gravity center -extent 300x300 #{file.path}.png`
  "#{file.path}.png"
end

.sound_base64(url) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/obf/utils.rb', line 160

def self.sound_base64(url)
  sound = nil
  if url.match(/:\/\//)
    sound = get_url(url)
  else
    types = MIME::Types.type_for(url)
    sound = {
      'data' => File.read(url),
      'content_type' => types[0] && types[0].to_s
    }
  end
  return nil unless sound
  str = "data:" + sound['content_type']
  str += ";base64," + Base64.strict_encode64(sound['data'])
  str
end

.sound_raw(url) ⇒ Object 



154
155
156
157
158
 
# File 'lib/obf/utils.rb', line 154

def self.sound_raw(url)
  sound = get_url(url)
  return nil unless sound
  sound
end

.temp_path(*args) ⇒ Object 



251
252
253
254
255
256
 
# File 'lib/obf/utils.rb', line 251

def self.temp_path(*args)
  file = Tempfile.new(*args)
  res = file.path
  file.unlink
  res
end

.update_current_progress(*args) ⇒ Object 



331
332
333
334
335
 
# File 'lib/obf/utils.rb', line 331

def self.update_current_progress(*args)
  if Object.const_defined?('Progress') && Progress.respond_to?(:update_current_progress)
    Progress.update_current_progress(*args)
  end
end