app/helpers/browse_tags_helper.rb

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