0
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2026-08-04 10:39:43 +08:00
discourse/lib/canonical_url.rb
Natalie Tay 16919c4fd4
UX: Prevent incomplete crawler localization settings (#41297)
This PR makes sure crawler localization URLs only work when anonymous
users can resolve the locale from the URL param. This blocks enabling
the crawler param without that prerequisite and keeps hreflang,
canonical URLs, and crawler link rewriting behind the same guard.

/406195/4
2026-07-01 12:13:22 +08:00

80 lines
2.8 KiB
Ruby
Vendored

# frozen_string_literal: true
module CanonicalURL
module ControllerExtensions
ALLOWED_CANONICAL_PARAMS = %w[page]
def canonical_url(url_for_options = {})
url =
case url_for_options
when Hash
url_for(url_for_options)
else
url_for_options
end
@canonical_url = append_content_localization_param(url)
end
def default_canonical
@default_canonical ||=
begin
canonical = +"#{Discourse.base_url_no_prefix}#{request.path}"
allowed_params = params.select { |key| ALLOWED_CANONICAL_PARAMS.include?(key) }
if allowed_params.present?
canonical << "?#{allowed_params.keys.zip(allowed_params.values).map { |key, value| "#{key}=#{value}" }.join("&")}"
end
append_content_localization_param(canonical)
end
end
def self.included(base)
base.helper_method :default_canonical
end
private
def append_content_localization_param(url)
return url unless ContentLocalization.crawler_locale_param_enabled?
return url unless use_crawler_layout?
locale = params[Discourse::LOCALE_PARAM]
return url if locale.blank?
supported = SiteSetting.content_localization_supported_locales.to_s.split("|")
return url if supported.exclude?(locale)
uri = Addressable::URI.parse(url)
uri.query_values = (uri.query_values || {}).merge(Discourse::LOCALE_PARAM => locale)
uri.to_s
end
end
module Helpers
def canonical_link_tag(url = nil)
tag("link", rel: "canonical", href: url || @canonical_url || default_canonical)
end
end
end
# https://github.com/mbleigh/canonical-url/blob/master/lib/canonical_url.rb
# Copyright (c) 2009 Michael Bleigh and Intridea, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.#