PageRenderTime 27ms CodeModel.GetById 34ms RepoModel.GetById 0ms app.codeStats 0ms

/app/helpers/browse_tags_helper.rb

https://github.com/mikelmaron/openstreetmap-website
Ruby | 193 lines | 129 code | 22 blank | 42 comment | 15 complexity | 1cc029e73632ebc9a2ae433ca975e17d MD5 | raw file
  1. module BrowseTagsHelper
  2. def format_key(key)
  3. if url = wiki_link("key", key)
  4. link_to h(key), url, :title => t("browse.tag_details.wiki_link.key", :key => key)
  5. else
  6. h(key)
  7. end
  8. end
  9. def format_value(key, value)
  10. if wp = wikipedia_link(key, value)
  11. link_to h(wp[:title]), wp[:url], :title => t("browse.tag_details.wikipedia_link", :page => wp[:title])
  12. elsif wdt = wikidata_links(key, value)
  13. # IMPORTANT: Note that wikidata_links() returns an array of hashes, unlike for example wikipedia_link(),
  14. # which just returns one such hash.
  15. wdt = wdt.map do |w|
  16. link_to(w[:title], w[:url], :title => t("browse.tag_details.wikidata_link", :page => w[:title].strip))
  17. end
  18. safe_join(wdt, ";")
  19. elsif wmc = wikimedia_commons_link(key, value)
  20. link_to h(wmc[:title]), wmc[:url], :title => t("browse.tag_details.wikimedia_commons_link", :page => wmc[:title])
  21. elsif url = wiki_link("tag", "#{key}=#{value}")
  22. link_to h(value), url, :title => t("browse.tag_details.wiki_link.tag", :key => key, :value => value)
  23. elsif email = email_link(key, value)
  24. link_to(h(email[:email]), email[:url], :title => t("browse.tag_details.email_link", :email => email[:email]))
  25. elsif phones = telephone_links(key, value)
  26. # similarly, telephone_links() returns an array of phone numbers
  27. phones = phones.map do |p|
  28. link_to(h(p[:phone_number]), p[:url], :title => t("browse.tag_details.telephone_link", :phone_number => p[:phone_number]))
  29. end
  30. safe_join(phones, "; ")
  31. elsif colour_value = colour_preview(key, value)
  32. tag.span("", :class => "colour-preview-box", :"data-colour" => colour_value, :title => t("browse.tag_details.colour_preview", :colour_value => colour_value)) + colour_value
  33. else
  34. linkify h(value)
  35. end
  36. end
  37. private
  38. def wiki_link(type, lookup)
  39. locale = I18n.locale.to_s
  40. # update-wiki-pages does s/ /_/g on keys before saving them, we
  41. # have to replace spaces with underscore so we'll link
  42. # e.g. `source=Isle of Man Government aerial imagery (2001)' to
  43. # the correct page.
  44. lookup_us = lookup.tr(" ", "_")
  45. if page = WIKI_PAGES.dig(locale, type, lookup_us)
  46. url = "https://wiki.openstreetmap.org/wiki/#{page}?uselang=#{locale}"
  47. elsif page = WIKI_PAGES.dig("en", type, lookup_us)
  48. url = "https://wiki.openstreetmap.org/wiki/#{page}?uselang=#{locale}"
  49. end
  50. url
  51. end
  52. def wikipedia_link(key, value)
  53. # Some k/v's are wikipedia=http://en.wikipedia.org/wiki/Full%20URL
  54. return nil if %r{^https?://}.match?(value)
  55. case key
  56. when "wikipedia"
  57. # This regex should match Wikipedia language codes, everything
  58. # from de to zh-classical
  59. lang = if value =~ /^([a-z-]{2,12}):(.+)$/i
  60. # Value is <lang>:<title> so split it up
  61. # Note that value is always left as-is, see: https://trac.openstreetmap.org/ticket/4315
  62. Regexp.last_match(1)
  63. else
  64. # Value is <title> so default to English Wikipedia
  65. "en"
  66. end
  67. when /^wikipedia:(\S+)$/
  68. # Language is in the key, so assume value is the title
  69. lang = Regexp.last_match(1)
  70. else
  71. # Not a wikipedia key!
  72. return nil
  73. end
  74. if value =~ /^([^#]*)#(.*)/
  75. # Contains a reference to a section of the wikipedia article
  76. # Must break it up to correctly build the url
  77. value = Regexp.last_match(1)
  78. section = "##{Regexp.last_match(2)}"
  79. encoded_section = "##{CGI.escape(Regexp.last_match(2).gsub(/ +/, '_')).tr('%', '.')}"
  80. else
  81. section = ""
  82. encoded_section = ""
  83. end
  84. {
  85. :url => "https://#{lang}.wikipedia.org/wiki/#{value}?uselang=#{I18n.locale}#{encoded_section}",
  86. :title => value + section
  87. }
  88. end
  89. def wikidata_links(key, value)
  90. # The simple wikidata-tag (this is limited to only one value)
  91. if key == "wikidata" && value =~ /^[Qq][1-9][0-9]*$/
  92. return [{
  93. :url => "//www.wikidata.org/entity/#{value}?uselang=#{I18n.locale}",
  94. :title => value
  95. }]
  96. # Key has to be one of the accepted wikidata-tags
  97. elsif key =~ /(architect|artist|brand|name:etymology|network|operator|subject):wikidata/ &&
  98. # Value has to be a semicolon-separated list of wikidata-IDs (whitespaces allowed before and after semicolons)
  99. value =~ /^[Qq][1-9][0-9]*(\s*;\s*[Qq][1-9][0-9]*)*$/
  100. # Splitting at every semicolon to get a separate hash for each wikidata-ID
  101. return value.split(";").map do |id|
  102. { :title => id, :url => "//www.wikidata.org/entity/#{id.strip}?uselang=#{I18n.locale}" }
  103. end
  104. end
  105. nil
  106. end
  107. def wikimedia_commons_link(key, value)
  108. if key == "wikimedia_commons" && value =~ /^(?:file|category):/i
  109. return {
  110. :url => "//commons.wikimedia.org/wiki/#{value}?uselang=#{I18n.locale}",
  111. :title => value
  112. }
  113. end
  114. nil
  115. end
  116. def email_link(_key, value)
  117. # Does the value look like an email? eg "someone@domain.tld"
  118. # Uses Ruby built-in regexp to validate email.
  119. # This will not catch certain valid emails containing comments, whitespace characters,
  120. # and quoted strings.
  121. # (see: https://github.com/ruby/ruby/blob/master/lib/uri/mailto.rb)
  122. # remove any leading and trailing whitespace
  123. email = value.strip
  124. if email.match?(URI::MailTo::EMAIL_REGEXP)
  125. # add 'mailto:'' prefix
  126. return { :email => email, :url => "mailto:#{email}" }
  127. end
  128. nil
  129. end
  130. def telephone_links(_key, value)
  131. # Does it look like a global phone number? eg "+1 (234) 567-8901 "
  132. # or a list of alternate numbers separated by ;
  133. #
  134. # Per RFC 3966, this accepts the visual separators -.() within the number,
  135. # which are displayed and included in the tel: URL, and accepts whitespace,
  136. # which is displayed but not included in the tel: URL.
  137. # (see: http://tools.ietf.org/html/rfc3966#section-5.1.1)
  138. #
  139. # Also accepting / as a visual separator although not given in RFC 3966,
  140. # because it is used as a visual separator in OSM data in some countries.
  141. if value.match?(%r{^\s*\+[\d\s()/.-]{6,25}\s*(;\s*\+[\d\s()/.-]{6,25}\s*)*$})
  142. return value.split(";").map do |phone_number|
  143. # for display, remove leading and trailing whitespace
  144. phone_number = phone_number.strip
  145. # for tel: URL, remove all whitespace
  146. # "+1 (234) 567-8901 " -> "tel:+1(234)567-8901"
  147. phone_no_whitespace = phone_number.gsub(/\s+/, "")
  148. { :phone_number => phone_number, :url => "tel:#{phone_no_whitespace}" }
  149. end
  150. end
  151. nil
  152. end
  153. def colour_preview(key, value)
  154. return nil unless key =~ /^(?>.+:)?colour$/ && !value.nil? # see discussion at https://github.com/openstreetmap/openstreetmap-website/pull/1779
  155. # does value look like a colour? ( 3 or 6 digit hex code or w3c colour name)
  156. w3c_colors =
  157. %w[aliceblue antiquewhite aqua aquamarine azure beige bisque black blanchedalmond blue blueviolet brown burlywood cadetblue chartreuse chocolate
  158. coral cornflowerblue cornsilk crimson cyan darkblue darkcyan darkgoldenrod darkgray darkgrey darkgreen darkkhaki darkmagenta darkolivegreen
  159. darkorange darkorchid darkred darksalmon darkseagreen darkslateblue darkslategray darkslategrey darkturquoise darkviolet deeppink deepskyblue
  160. dimgray dimgrey dodgerblue firebrick floralwhite forestgreen fuchsia gainsboro ghostwhite gold goldenrod gray grey green greenyellow honeydew
  161. hotpink indianred indigo ivory khaki lavender lavenderblush lawngreen lemonchiffon lightblue lightcoral lightcyan lightgoldenrodyellow lightgray
  162. lightgrey lightgreen lightpink lightsalmon lightseagreen lightskyblue lightslategray lightslategrey lightsteelblue lightyellow lime limegreen
  163. linen magenta maroon mediumaquamarine mediumblue mediumorchid mediumpurple mediumseagreen mediumslateblue mediumspringgreen mediumturquoise
  164. mediumvioletred midnightblue mintcream mistyrose moccasin navajowhite navy oldlace olive olivedrab orange orangered orchid palegoldenrod
  165. palegreen paleturquoise palevioletred papayawhip peachpuff peru pink plum powderblue purple red rosybrown royalblue saddlebrown salmon
  166. sandybrown seagreen seashell sienna silver skyblue slateblue slategray slategrey snow springgreen steelblue tan teal thistle tomato turquoise
  167. violet wheat white whitesmoke yellow yellowgreen]
  168. return nil unless value =~ /^#([0-9a-fA-F]{3}){1,2}$/ || w3c_colors.include?(value.downcase)
  169. value
  170. end
  171. end