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 emails = email_links(key, value)
  25       # similarly, email_links() returns an array of emails
  26       emails = emails.map do |e|
  27         link_to(h(e[:email]), e[:url], :title => t("browse.tag_details.email_link", :email => e[:email]))
  28       end
  29       safe_join(emails, "; ")
  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       content_tag(:span, "", :class => "colour-preview-box", :"data-colour" => colour_value, :title => t("browse.tag_details.colour_preview", :colour_value => colour_value)) + colour_value
  38     else
  39       linkify h(value)
  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     if page = WIKI_PAGES.dig(locale, type, lookup_us)
  55       url = "https://wiki.openstreetmap.org/wiki/#{page}?uselang=#{locale}"
  56     elsif page = WIKI_PAGES.dig("en", type, lookup_us)
  57       url = "https://wiki.openstreetmap.org/wiki/#{page}?uselang=#{locale}"
  58     end
  59
  60     url
  61   end
  62
  63   def wikipedia_link(key, value)
  64     # Some k/v's are wikipedia=http://en.wikipedia.org/wiki/Full%20URL
  65     return nil if value =~ %r{^https?://}
  66
  67     if key == "wikipedia"
  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     elsif key =~ /^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(/ +/, "_")).tr("%", ".")
  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 =~ /(architect|artist|brand|name:etymology|network|operator|subject):wikidata/ &&
 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_links(_key, value)
 133     # Does value look like an email? eg "someone@domain.tld"
 134     # or a list of alternate emails separated by ;
 135
 136     # Uses WHATWG implementation of email validation, which follows RFC 1123
 137     # but is a willful violation of RFC 5322.
 138     #  (see: https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address)
 139     if value.match?(%r{^\s*[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\s*
 140                       (;\s*[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\s*)*$
 141                     }x)
 142       return value.split(";").map do |email|
 143         # remove any leading or trailing whitespace if present
 144         email = email.strip
 145
 146         # add 'mailto:'' prefix
 147         { :email => email, :url => "mailto:#{email}" }
 148       end
 149     end
 150     nil
 151   end
 152
 153   def telephone_links(_key, value)
 154     # Does it look like a global phone number? eg "+1 (234) 567-8901 "
 155     # or a list of alternate numbers separated by ;
 156     #
 157     # Per RFC 3966, this accepts the visual separators -.() within the number,
 158     # which are displayed and included in the tel: URL, and accepts whitespace,
 159     # which is displayed but not included in the tel: URL.
 160     #  (see: http://tools.ietf.org/html/rfc3966#section-5.1.1)
 161     #
 162     # Also accepting / as a visual separator although not given in RFC 3966,
 163     # because it is used as a visual separator in OSM data in some countries.
 164     if value.match?(%r{^\s*\+[\d\s\(\)/\.-]{6,25}\s*(;\s*\+[\d\s\(\)/\.-]{6,25}\s*)*$})
 165       return value.split(";").map do |phone_number|
 166         # for display, remove leading and trailing whitespace
 167         phone_number = phone_number.strip
 168
 169         # for tel: URL, remove all whitespace
 170         # "+1 (234) 567-8901 " -> "tel:+1(234)567-8901"
 171         phone_no_whitespace = phone_number.gsub(/\s+/, "")
 172         { :phone_number => phone_number, :url => "tel:#{phone_no_whitespace}" }
 173       end
 174     end
 175     nil
 176   end
 177
 178   def colour_preview(key, value)
 179     return nil unless key =~ /^(?>.+:)?colour$/ && !value.nil? # see discussion at https://github.com/openstreetmap/openstreetmap-website/pull/1779
 180
 181     # does value look like a colour? ( 3 or 6 digit hex code or w3c colour name)
 182     w3c_colors =
 183       %w[aliceblue antiquewhite aqua aquamarine azure beige bisque black blanchedalmond blue blueviolet brown burlywood cadetblue chartreuse chocolate
 184          coral cornflowerblue cornsilk crimson cyan darkblue darkcyan darkgoldenrod darkgray darkgrey darkgreen darkkhaki darkmagenta darkolivegreen
 185          darkorange darkorchid darkred darksalmon darkseagreen darkslateblue darkslategray darkslategrey darkturquoise darkviolet deeppink deepskyblue
 186          dimgray dimgrey dodgerblue firebrick floralwhite forestgreen fuchsia gainsboro ghostwhite gold goldenrod gray grey green greenyellow honeydew
 187          hotpink indianred indigo ivory khaki lavender lavenderblush lawngreen lemonchiffon lightblue lightcoral lightcyan lightgoldenrodyellow lightgray
 188          lightgrey lightgreen lightpink lightsalmon lightseagreen lightskyblue lightslategray lightslategrey lightsteelblue lightyellow lime limegreen
 189          linen magenta maroon mediumaquamarine mediumblue mediumorchid mediumpurple mediumseagreen mediumslateblue mediumspringgreen mediumturquoise
 190          mediumvioletred midnightblue mintcream mistyrose moccasin navajowhite navy oldlace olive olivedrab orange orangered orchid palegoldenrod
 191          palegreen paleturquoise palevioletred papayawhip peachpuff peru pink plum powderblue purple red rosybrown royalblue saddlebrown salmon
 192          sandybrown seagreen seashell sienna silver skyblue slateblue slategray slategrey snow springgreen steelblue tan teal thistle tomato turquoise
 193          violet wheat white whitesmoke yellow yellowgreen]
 194     return nil unless value =~ /^#([0-9a-fA-F]{3}){1,2}$/ || w3c_colors.include?(value.downcase)
 195
 196     value
 197   end
 198 end