app/helpers/browse_tags_helper.rb

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