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