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       # This regex should match Wikipedia language codes, everything
  73       # from de to zh-classical
  74       lang = if value =~ /^([a-z-]{2,12}):(.+)$/i
  75                # Value is <lang>:<title> so split it up
  76                # Note that value is always left as-is, see: https://trac.openstreetmap.org/ticket/4315
  77                Regexp.last_match(1)
  78              else
  79                # Value is <title> so default to English Wikipedia
  80                "en"
  81              end
  82     when /^wikipedia:(\S+)$/
  83       # Language is in the key, so assume value is the title
  84       lang = Regexp.last_match(1)
  85     else
  86       # Not a wikipedia key!
  87       return nil
  88     end
  89
  90     if value =~ /^([^#]*)#(.*)/
  91       # Contains a reference to a section of the wikipedia article
  92       # Must break it up to correctly build the url
  93       value = Regexp.last_match(1)
  94       section = "##{Regexp.last_match(2)}"
  95       encoded_section = "##{CGI.escape(Regexp.last_match(2).gsub(/ +/, '_'))}"
  96     else
  97       section = ""
  98       encoded_section = ""
  99     end
 100
 101     {
 102       :url => "https://#{lang}.wikipedia.org/wiki/#{value}?uselang=#{I18n.locale}#{encoded_section}",
 103       :title => value + section
 104     }
 105   end
 106
 107   def wikidata_links(key, value)
 108     # The simple wikidata-tag (this is limited to only one value)
 109     if key == "wikidata" && value =~ /^[Qq][1-9][0-9]*$/
 110       return [{
 111         :url => "//www.wikidata.org/entity/#{value}?uselang=#{I18n.locale}",
 112         :title => value
 113       }]
 114     # Key has to be one of the accepted wikidata-tags
 115     elsif key =~ /(#{SECONDARY_WIKI_PREFIXES}):wikidata/o &&
 116           # Value has to be a semicolon-separated list of wikidata-IDs (whitespaces allowed before and after semicolons)
 117           value =~ /^[Qq][1-9][0-9]*(\s*;\s*[Qq][1-9][0-9]*)*$/
 118       # Splitting at every semicolon to get a separate hash for each wikidata-ID
 119       return value.split(";").map do |id|
 120         { :title => id, :url => "//www.wikidata.org/entity/#{id.strip}?uselang=#{I18n.locale}" }
 121       end
 122     end
 123     nil
 124   end
 125
 126   def wikimedia_commons_link(key, value)
 127     if key == "wikimedia_commons" && value =~ /^(?:file|category):/i
 128       return {
 129         :url => "//commons.wikimedia.org/wiki/#{value}?uselang=#{I18n.locale}",
 130         :title => value
 131       }
 132     end
 133     nil
 134   end
 135
 136   def email_link(key, value)
 137     # Avoid converting conditional tags into emails, since EMAIL_REGEXP is quite permissive
 138     return nil unless %w[email contact:email].include? key
 139
 140     # Does the value look like an email? eg "someone@domain.tld"
 141
 142     #  Uses Ruby built-in regexp to validate email.
 143     #  This will not catch certain valid emails containing comments, whitespace characters,
 144     #  and quoted strings.
 145     #    (see: https://github.com/ruby/ruby/blob/master/lib/uri/mailto.rb)
 146
 147     # remove any leading and trailing whitespace
 148     email = value.strip
 149
 150     return email if email.match?(URI::MailTo::EMAIL_REGEXP)
 151
 152     nil
 153   end
 154
 155   def telephone_links(_key, value)
 156     # Does it look like a global phone number? eg "+1 (234) 567-8901 "
 157     # or a list of alternate numbers separated by ;
 158     #
 159     # Per RFC 3966, this accepts the visual separators -.() within the number,
 160     # which are displayed and included in the tel: URL, and accepts whitespace,
 161     # which is displayed but not included in the tel: URL.
 162     #  (see: http://tools.ietf.org/html/rfc3966#section-5.1.1)
 163     #
 164     # Also accepting / as a visual separator although not given in RFC 3966,
 165     # because it is used as a visual separator in OSM data in some countries.
 166     if value.match?(%r{^\s*\+[\d\s()/.-]{6,25}\s*(;\s*\+[\d\s()/.-]{6,25}\s*)*$})
 167       return value.split(";").map do |phone_number|
 168         # for display, remove leading and trailing whitespace
 169         phone_number = phone_number.strip
 170
 171         # for tel: URL, remove all whitespace
 172         # "+1 (234) 567-8901 " -> "tel:+1(234)567-8901"
 173         phone_no_whitespace = phone_number.gsub(/\s+/, "")
 174         { :phone_number => phone_number, :url => "tel:#{phone_no_whitespace}" }
 175       end
 176     end
 177     nil
 178   end
 179
 180   def colour_preview(key, value)
 181     return nil unless key =~ /^(?>.+:)?colour$/ && !value.nil? # see discussion at https://github.com/openstreetmap/openstreetmap-website/pull/1779
 182
 183     # does value look like a colour? ( 3 or 6 digit hex code or w3c colour name)
 184     w3c_colors =
 185       %w[aliceblue antiquewhite aqua aquamarine azure beige bisque black blanchedalmond blue blueviolet brown burlywood cadetblue chartreuse chocolate
 186          coral cornflowerblue cornsilk crimson cyan darkblue darkcyan darkgoldenrod darkgray darkgrey darkgreen darkkhaki darkmagenta darkolivegreen
 187          darkorange darkorchid darkred darksalmon darkseagreen darkslateblue darkslategray darkslategrey darkturquoise darkviolet deeppink deepskyblue
 188          dimgray dimgrey dodgerblue firebrick floralwhite forestgreen fuchsia gainsboro ghostwhite gold goldenrod gray grey green greenyellow honeydew
 189          hotpink indianred indigo ivory khaki lavender lavenderblush lawngreen lemonchiffon lightblue lightcoral lightcyan lightgoldenrodyellow lightgray
 190          lightgrey lightgreen lightpink lightsalmon lightseagreen lightskyblue lightslategray lightslategrey lightsteelblue lightyellow lime limegreen
 191          linen magenta maroon mediumaquamarine mediumblue mediumorchid mediumpurple mediumseagreen mediumslateblue mediumspringgreen mediumturquoise
 192          mediumvioletred midnightblue mintcream mistyrose moccasin navajowhite navy oldlace olive olivedrab orange orangered orchid palegoldenrod
 193          palegreen paleturquoise palevioletred papayawhip peachpuff peru pink plum powderblue purple red rosybrown royalblue saddlebrown salmon
 194          sandybrown seagreen seashell sienna silver skyblue slateblue slategray slategrey snow springgreen steelblue tan teal thistle tomato turquoise
 195          violet wheat white whitesmoke yellow yellowgreen]
 196     return nil unless value =~ /^#([0-9a-fA-F]{3}){1,2}$/ || w3c_colors.include?(value.downcase)
 197
 198     value
 199   end
 200 end