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       mail_to(email, :title => t("browse.tag_details.email_link", :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     page = WIKI_PAGES.dig(locale, type, lookup_us) ||
  51            WIKI_PAGES.dig("en", type, lookup_us)
  52
  53     url = "https://wiki.openstreetmap.org/wiki/#{page}?uselang=#{locale}" if page
  54
  55     url
  56   end
  57
  58   def wikipedia_link(key, value)
  59     # Some k/v's are wikipedia=http://en.wikipedia.org/wiki/Full%20URL
  60     return nil if %r{^https?://}.match?(value)
  61
  62     case key
  63     when "wikipedia"
  64       # This regex should match Wikipedia language codes, everything
  65       # from de to zh-classical
  66       lang = if value =~ /^([a-z-]{2,12}):(.+)$/i
  67                # Value is <lang>:<title> so split it up
  68                # Note that value is always left as-is, see: https://trac.openstreetmap.org/ticket/4315
  69                Regexp.last_match(1)
  70              else
  71                # Value is <title> so default to English Wikipedia
  72                "en"
  73              end
  74     when /^wikipedia:(\S+)$/
  75       # Language is in the key, so assume value is the title
  76       lang = Regexp.last_match(1)
  77     else
  78       # Not a wikipedia key!
  79       return nil
  80     end
  81
  82     if value =~ /^([^#]*)#(.*)/
  83       # Contains a reference to a section of the wikipedia article
  84       # Must break it up to correctly build the url
  85       value = Regexp.last_match(1)
  86       section = "##{Regexp.last_match(2)}"
  87       encoded_section = "##{CGI.escape(Regexp.last_match(2).gsub(/ +/, '_'))}"
  88     else
  89       section = ""
  90       encoded_section = ""
  91     end
  92
  93     {
  94       :url => "https://#{lang}.wikipedia.org/wiki/#{value}?uselang=#{I18n.locale}#{encoded_section}",
  95       :title => value + section
  96     }
  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 =~ /(architect|artist|brand|name:etymology|network|operator|subject):wikidata/ &&
 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       return {
 121         :url => "//commons.wikimedia.org/wiki/#{value}?uselang=#{I18n.locale}",
 122         :title => value
 123       }
 124     end
 125     nil
 126   end
 127
 128   def email_link(_key, value)
 129     # Does the value look like an email? eg "someone@domain.tld"
 130
 131     #  Uses Ruby built-in regexp to validate email.
 132     #  This will not catch certain valid emails containing comments, whitespace characters,
 133     #  and quoted strings.
 134     #    (see: https://github.com/ruby/ruby/blob/master/lib/uri/mailto.rb)
 135
 136     # remove any leading and trailing whitespace
 137     email = value.strip
 138
 139     return email if email.match?(URI::MailTo::EMAIL_REGEXP)
 140
 141     nil
 142   end
 143
 144   def telephone_links(_key, value)
 145     # Does it look like a global phone number? eg "+1 (234) 567-8901 "
 146     # or a list of alternate numbers separated by ;
 147     #
 148     # Per RFC 3966, this accepts the visual separators -.() within the number,
 149     # which are displayed and included in the tel: URL, and accepts whitespace,
 150     # which is displayed but not included in the tel: URL.
 151     #  (see: http://tools.ietf.org/html/rfc3966#section-5.1.1)
 152     #
 153     # Also accepting / as a visual separator although not given in RFC 3966,
 154     # because it is used as a visual separator in OSM data in some countries.
 155     if value.match?(%r{^\s*\+[\d\s()/.-]{6,25}\s*(;\s*\+[\d\s()/.-]{6,25}\s*)*$})
 156       return value.split(";").map do |phone_number|
 157         # for display, remove leading and trailing whitespace
 158         phone_number = phone_number.strip
 159
 160         # for tel: URL, remove all whitespace
 161         # "+1 (234) 567-8901 " -> "tel:+1(234)567-8901"
 162         phone_no_whitespace = phone_number.gsub(/\s+/, "")
 163         { :phone_number => phone_number, :url => "tel:#{phone_no_whitespace}" }
 164       end
 165     end
 166     nil
 167   end
 168
 169   def colour_preview(key, value)
 170     return nil unless key =~ /^(?>.+:)?colour$/ && !value.nil? # see discussion at https://github.com/openstreetmap/openstreetmap-website/pull/1779
 171
 172     # does value look like a colour? ( 3 or 6 digit hex code or w3c colour name)
 173     w3c_colors =
 174       %w[aliceblue antiquewhite aqua aquamarine azure beige bisque black blanchedalmond blue blueviolet brown burlywood cadetblue chartreuse chocolate
 175          coral cornflowerblue cornsilk crimson cyan darkblue darkcyan darkgoldenrod darkgray darkgrey darkgreen darkkhaki darkmagenta darkolivegreen
 176          darkorange darkorchid darkred darksalmon darkseagreen darkslateblue darkslategray darkslategrey darkturquoise darkviolet deeppink deepskyblue
 177          dimgray dimgrey dodgerblue firebrick floralwhite forestgreen fuchsia gainsboro ghostwhite gold goldenrod gray grey green greenyellow honeydew
 178          hotpink indianred indigo ivory khaki lavender lavenderblush lawngreen lemonchiffon lightblue lightcoral lightcyan lightgoldenrodyellow lightgray
 179          lightgrey lightgreen lightpink lightsalmon lightseagreen lightskyblue lightslategray lightslategrey lightsteelblue lightyellow lime limegreen
 180          linen magenta maroon mediumaquamarine mediumblue mediumorchid mediumpurple mediumseagreen mediumslateblue mediumspringgreen mediumturquoise
 181          mediumvioletred midnightblue mintcream mistyrose moccasin navajowhite navy oldlace olive olivedrab orange orangered orchid palegoldenrod
 182          palegreen paleturquoise palevioletred papayawhip peachpuff peru pink plum powderblue purple red rosybrown royalblue saddlebrown salmon
 183          sandybrown seagreen seashell sienna silver skyblue slateblue slategray slategrey snow springgreen steelblue tan teal thistle tomato turquoise
 184          violet wheat white whitesmoke yellow yellowgreen]
 185     return nil unless value =~ /^#([0-9a-fA-F]{3}){1,2}$/ || w3c_colors.include?(value.downcase)
 186
 187     value
 188   end
 189 end