Class: CartoCSSHelper::OverpassQueryGenerator

Inherits:
Object
  • Object
show all
Defined in:
lib/cartocss_helper/overpass_query_generator.rb

Defined Under Namespace

Classes: NoLocationFound

Class Method Summary collapse

Class Method Details

.attempt_cleanup ⇒ Object 



278
279
280
281
282
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 278

def self.attempt_cleanup
  delete_large_overpass_caches 500 if SystemHelper.not_enough_free_space
  delete_large_overpass_caches 100 if SystemHelper.not_enough_free_space
  delete_large_overpass_caches 50 if SystemHelper.not_enough_free_space
end

.check_for_free_space ⇒ Object

TODO: it really does not belong here… - do system helpera? aż do końca klasy



269
270
271
272
273
274
275
276
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 269

def self.check_for_free_space # TODO: it really does not belong here... - do system helpera? aż do końca klasy
  if SystemHelper.not_enough_free_space
    attempt_cleanup
    if SystemHelper.not_enough_free_space
      raise 'not enough free space on disk with cache folder'
    end
  end
end

.delete_large_overpass_caches(threshold_in_MB) ⇒ Object 



284
285
286
287
288
289
290
291
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 284

def self.delete_large_overpass_caches(threshold_in_MB)
  # TODO: - find library that deals with caches like this, bug here may be unfunny
  Dir.glob(CartoCSSHelper::Configuration.get_path_to_folder_for_overpass_cache + '*') do |file|
    if File.size(file) > (1024 * 1024 * threshold_in_MB)
      SystemHelper.delete_file(file, "removing everpass cache entries larger than #{threshold_in_MB} MB to make free space on the disk")
    end
  end
end

.download_osm_data_for_location(latitude, longitude, size, accept_cache = true) ⇒ Object

TODO: conflict with invalidate_cache



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 57

def self.download_osm_data_for_location(latitude, longitude, size, accept_cache = true) # TODO: conflict with invalidate_cache 
  filename = CartoCSSHelper::Configuration.get_path_to_folder_for_cache + "#{latitude} #{longitude} #{size}.osm"
  if File.exist?(filename)
    return filename if accept_cache
    SystemHelper.delete_file(filename, 'query refusing to accept cache was used')
  end
  query = get_query_to_download_data_around_location(latitude, longitude, size)
  text = get_overpass_query_results(query, "download data for #{latitude} #{longitude} (#{size})", invalidate_cache: false)
  File.new(filename, 'w') do |file|
    file.write text
  end
  return filename
end

.find_data_pair(tags_a, tags_b, latitude, longitude, type_a, type_b, bb_size: 0.1, distance_in_meters: 20, invalidate_cache: false) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 36

def self.find_data_pair(tags_a, tags_b, latitude, longitude, type_a, type_b, bb_size: 0.1, distance_in_meters: 20, invalidate_cache: false)
  return nil, nil if bb_size > 0.5
  bb = overpass_bbox_string(latitude, longitude, bb_size.to_f)
  query = OverpassQueryGenerator.get_query_to_find_data_pair(bb, tags_a, tags_b, type_a, type_b, distance_in_meters: distance_in_meters)
  description = "find #{VisualDiff.tag_dict_to_string(tags_a)} nearby #{VisualDiff.tag_dict_to_string(tags_b)} - bb size: #{bb_size}"
  list = OverpassQueryGenerator.get_overpass_query_results(query, description, invalidate_cache: invalidate_cache)
  if list.length != 0
    return OverpassQueryGenerator.list_returned_by_overpass_to_a_single_location(list)
  end
  return OverpassQueryGenerator.find_data_pair(tags_a, tags_b, latitude, longitude, type_a, type_b, bb_size: bb_size * 2, distance_in_meters: distance_in_meters)
end

.get_elements_across_world(tags, type, invalidate_cache: false) ⇒ Object 



95
96
97
98
99
100
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 95

def self.get_elements_across_world(tags, type, invalidate_cache: false)
  description = "find #{tags} #{type} across the world"
  query = OverpassQueryGenerator.get_query_to_get_location(tags, type, 0, 0, :infinity)
  list = OverpassQueryGenerator.get_overpass_query_results(query, description, invalidate_cache: invalidate_cache)
  return list_returned_by_overpass_to_array(list)
end

.get_elements_near_given_location(tags, type, latitude, longitude, range_in_meters, invalidate_cache: false) ⇒ Object 



88
89
90
91
92
93
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 88

def self.get_elements_near_given_location(tags, type, latitude, longitude, range_in_meters, invalidate_cache: false)
  description = "find #{tags} #{type} within #{range_in_meters / 1000}km from #{latitude}, #{longitude}"
  query = OverpassQueryGenerator.get_query_to_get_location(tags, type, latitude, longitude, range_in_meters)
  list = OverpassQueryGenerator.get_overpass_query_results(query, description, invalidate_cache: invalidate_cache)
  return list_returned_by_overpass_to_array(list)
end

.get_file_with_downloaded_osm_data_for_location(latitude, longitude, size, invalidate_cache: false) ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 48

def self.get_file_with_downloaded_osm_data_for_location(latitude, longitude, size, invalidate_cache: false)
  query = get_query_to_download_data_around_location(latitude, longitude, size)
  description = "download data for #{latitude} #{longitude} (#{size})"
  get_overpass_query_results(query, description, invalidate_cache: invalidate_cache)

  filename = OverpassDownloader.cache_filename(query)
  return filename
end

.get_overpass_query_results(query, description, debug = false, invalidate_cache: false) ⇒ Object

TODO: - make debug parameter named



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 246

def self.get_overpass_query_results(query, description, debug = false, invalidate_cache: false) # TODO: - make debug parameter named
  if File.exist?(get_query_cache_refused_response_filename(query))
    puts("response cached as failed")
    puts(get_query_cache_refused_response_filename(query))
    raise OverpassDownloader::OverpassRefusedResponse
  end

  check_for_free_space

  if debug
    Log.info query
    Log.info
  end

  description = 'Running Overpass query (connection initiated on ' + Time.now.to_s + ') ' + description
  begin
    return OverpassDownloader.run_overpass_query query, description, invalidate_cache: invalidate_cache
  rescue OverpassDownloader::OverpassRefusedResponse
    mark_query_as_refused(query)
    raise OverpassDownloader::OverpassRefusedResponse
  end
end

.get_query_cache_filename(_query) ⇒ Object 



241
242
243
244
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 241

def self.get_query_cache_filename(_query)
  Log.warn "call OverpassDownloader.cache_filename directly"
  return OverpassDownloader.cache_filename
end

.get_query_cache_refused_response_filename(query) ⇒ Object 



231
232
233
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 231

def self.get_query_cache_refused_response_filename(query)
  return OverpassDownloader.cache_filename(query) + '_response_refused'
end

.get_query_element_to_get_location(tags, latitude, longitude, type, range) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 218

def self.get_query_element_to_get_location(tags, latitude, longitude, type, range)
  # special support for some tag values - see CartoCSSHelper::OverpassQueryGenerator.turn_list_of_tags_in_overpass_filter for details
  # TODO - escape value with quotation signs in them
  element = "(#{type}"
  element += OverpassQueryGenerator.turn_list_of_tags_in_overpass_filter(tags).strip
  if range != :infinity
    element += "(around:#{range},#{latitude},#{longitude})"
  end
  element += ';);'
  element += "\n\n"
  return element
end

.get_query_to_download_data_around_location(latitude, longitude, size) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 71

def self.get_query_to_download_data_around_location(latitude, longitude, size)
  bb = overpass_bbox_string(latitude, longitude, size)
  query = "[timeout:#{OverpassDownloader.get_allowed_timeout_in_seconds}];"
  query += "\n"
  query += "(node(#{bb});<;);"
  query += "\n"
  query += 'out;'
  query += "\n"
  query += '/*'
  query += "\nbbox size: #{size}"
  query += "\nhttp://www.openstreetmap.org/#map=17/#{latitude}/#{longitude}"
  query += "\n"
  query += '*/'
  query += "\n"
  return query
end

.get_query_to_find_data_pair(bb, tags_a, tags_b, type_a, type_b, distance_in_meters: 20) ⇒ Object

TODO: - split into cache handling and Overpass handling



14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 14

def self.get_query_to_find_data_pair(bb, tags_a, tags_b, type_a, type_b, distance_in_meters: 20)
  filter_a = OverpassQueryGenerator.turn_list_of_tags_in_overpass_filter(tags_a)
  filter_b = OverpassQueryGenerator.turn_list_of_tags_in_overpass_filter(tags_b)

  query = "[timeout:#{OverpassDownloader.get_allowed_timeout_in_seconds}][out:csv(::lat,::lon;false)];
  #{type_a}(#{bb})#{filter_a};
  node(around:#{distance_in_meters})->.anodes;
  #{type_b}(#{bb})#{filter_b};
  node(around:#{distance_in_meters}).anodes;
  out;"

  return query
end

.get_query_to_get_location(tags, type, latitude, longitude, range) ⇒ Object 



134
135
136
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 134

def self.get_query_to_get_location(tags, type, latitude, longitude, range)
  return get_query_to_get_location_set_format(tags, type, latitude, longitude, range, "[out:csv(::lat,::lon;false)]")
end

.get_query_to_get_location_set_format(tags, type, latitude, longitude, range, format) ⇒ Object

TODO: better, more generic function name get_query_to_get_objects_matching? put latitude, longitude, range together to avoid passing dummy variables



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 141

def self.get_query_to_get_location_set_format(tags, type, latitude, longitude, range, format)
  # special support for range == :infinity
  # special support for some tag values - see CartoCSSHelper::OverpassQueryGenerator.turn_list_of_tags_in_overpass_filter for details
  locator = "[timeout:#{OverpassDownloader.get_allowed_timeout_in_seconds}]#{format};"
  locator += "\n"
  type = 'way' if type == 'closed_way'
  locator += OverpassQueryGenerator.get_query_element_to_get_location(tags, latitude, longitude, type, range)
  locator += 'out center;'
  locator += "\n"
  locator += '/*'
  range_string = if range == :infinity
                   'infinity'
                 else
                   "#{range / 1000}km"
                 end
  locator += "\nrange: #{range_string}"
  locator += "\nhttp://www.openstreetmap.org/#map=17/#{latitude}/#{longitude}"
  locator += "\n"
  locator += '*/'
  locator += "\n"
  return locator
end

.list_returned_by_overpass_to_a_single_location(list) ⇒ Object 



118
119
120
121
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 118

def self.list_returned_by_overpass_to_a_single_location(list)
  list = list_returned_by_overpass_to_array(list)
  return list[0]
end

.list_returned_by_overpass_to_array(list) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 123

def self.list_returned_by_overpass_to_array(list)
  list = list.split("\n")
  new_list = list.map do |x|
    x = x.split("\t")
    x[0] = x[0].to_f
    x[1] = x[1].to_f
    x
  end
  return new_list
end

.locate_element_with_given_tags_and_type(tags, type, latitude, longitude, max_range_in_km_for_radius = 1600) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 102

def self.locate_element_with_given_tags_and_type(tags, type, latitude, longitude, max_range_in_km_for_radius = 1600)
  # special support for some tag values - see CartoCSSHelper::OverpassQueryGenerator.turn_list_of_tags_in_overpass_filter for details
  range = 10 * 1000
  while range <= max_range_in_km_for_radius * 1000
    list = OverpassQueryGenerator.get_elements_near_given_location(tags, type, latitude, longitude, range)
    return list[0] if list.length != 0
    range += [2 * range, 200_000].min
  end
  list = get_elements_across_world(tags, type)
  if list.length != 0
    return list[0]
  else
    raise NoLocationFound, "failed to find #{tags} #{type} across the world"
  end
end

.mark_query_as_refused(query) ⇒ Object 



235
236
237
238
239
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 235

def self.mark_query_as_refused(query)
  file = File.new(get_query_cache_refused_response_filename(query), 'w')
  file.write ''
  file.close
end

.overpass_bbox_string(latitude, longitude, size) ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 28

def self.overpass_bbox_string(latitude, longitude, size)
  min_latitude = latitude - size / 2
  max_latitude = latitude + size / 2
  min_longitude = longitude - size / 2
  max_longitude = longitude + size / 2
  return "#{min_latitude},#{min_longitude},#{max_latitude},#{max_longitude}"
end

.overpass_escape(text) ⇒ Object 



192
193
194
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 192

def self.overpass_escape(text)
  return text.gsub("\\", "\\\\\\").gsub("'", "\\\\'")
end

.translate_tag_object_into_filter_data(tag) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 174

def self.translate_tag_object_into_filter_data(tag)
 operator = :equal
 key = tag[0]
 value = :any_value
 if tag[1].class == Hash
   # complex operation
   if tag[1][:operation] == :not_equal_to
     operator = :not_equal
   else
     raise "unexpected operation in #{tag[1]}"
   end
   value = tag[1][:value]
 else
   value = tag[1]
 end
 return { operator: operator, key: key, value: value }
end

.turn_list_of_tags_in_overpass_filter(tags) ⇒ Object 



164
165
166
167
168
169
170
171
172
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 164

def self.turn_list_of_tags_in_overpass_filter(tags)
  # special support for following tag values:  :any_value, {operation: :not_equal_to, value: "tag"}
  element = ''
  tags.each do |tag|
    element += turn_tag_into_overpass_filter(tag)
    element += "\n"
  end
  return element
end

.turn_tag_into_overpass_filter(tag) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/cartocss_helper/overpass_query_generator.rb', line 196

def self.turn_tag_into_overpass_filter(tag)
 filter_data = translate_tag_object_into_filter_data(tag)
 value = filter_data[:value]
 key = filter_data[:key]
 operator = filter_data[:operator]

 value = overpass_escape(value) if value != :any_value
 key = overpass_escape(key)

 if value == :any_value && operator == :equal
   return "\t['#{key}']"
 elsif value == :any_value && operator == :not_equal
   return "\t['#{key}'!~'.*']"
 elsif value != :any_value && operator == :equal
   return "\t['#{key}'='#{value}']"
 elsif value != :any_value && operator == :not_equal
   return "\t['#{key}'!='#{value}']"
 else
   raise "unexpected situation in <#{tag}>"
 end
end