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