2017-08-08 12:52:15 -07:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
module JsonLdHelper
|
2022-02-03 05:07:29 -08:00
|
|
|
include ContextHelper
|
|
|
|
|
2017-08-08 12:52:15 -07:00
|
|
|
def equals_or_includes?(haystack, needle)
|
|
|
|
haystack.is_a?(Array) ? haystack.include?(needle) : haystack == needle
|
|
|
|
end
|
|
|
|
|
2018-05-02 03:40:24 -07:00
|
|
|
def equals_or_includes_any?(haystack, needles)
|
|
|
|
needles.any? { |needle| equals_or_includes?(haystack, needle) }
|
|
|
|
end
|
|
|
|
|
2017-08-08 12:52:15 -07:00
|
|
|
def first_of_value(value)
|
|
|
|
value.is_a?(Array) ? value.first : value
|
|
|
|
end
|
|
|
|
|
2022-03-12 00:11:36 -08:00
|
|
|
def uri_from_bearcap(str)
|
|
|
|
if str&.start_with?('bear:')
|
|
|
|
Addressable::URI.parse(str).query_values['u']
|
|
|
|
else
|
|
|
|
str
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-11-29 19:06:20 -08:00
|
|
|
# The url attribute can be a string, an array of strings, or an array of objects.
|
|
|
|
# The objects could include a mimeType. Not-included mimeType means it's text/html.
|
|
|
|
def url_to_href(value, preferred_type = nil)
|
2019-07-10 09:59:28 -07:00
|
|
|
single_value = begin
|
|
|
|
if value.is_a?(Array) && !value.first.is_a?(String)
|
|
|
|
value.find { |link| preferred_type.nil? || ((link['mimeType'].presence || 'text/html') == preferred_type) }
|
|
|
|
elsif value.is_a?(Array)
|
|
|
|
value.first
|
|
|
|
else
|
|
|
|
value
|
|
|
|
end
|
|
|
|
end
|
2017-11-29 19:06:20 -08:00
|
|
|
|
|
|
|
if single_value.nil? || single_value.is_a?(String)
|
|
|
|
single_value
|
|
|
|
else
|
|
|
|
single_value['href']
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-10-27 07:10:36 -07:00
|
|
|
def as_array(value)
|
2022-01-19 13:37:27 -08:00
|
|
|
if value.nil?
|
|
|
|
[]
|
|
|
|
elsif value.is_a?(Array)
|
|
|
|
value
|
|
|
|
else
|
|
|
|
[value]
|
|
|
|
end
|
2017-10-27 07:10:36 -07:00
|
|
|
end
|
|
|
|
|
2017-08-21 13:57:34 -07:00
|
|
|
def value_or_id(value)
|
2017-08-26 10:55:10 -07:00
|
|
|
value.is_a?(String) || value.nil? ? value : value['id']
|
2017-08-21 13:57:34 -07:00
|
|
|
end
|
|
|
|
|
2017-08-08 12:52:15 -07:00
|
|
|
def supported_context?(json)
|
2017-08-22 11:00:49 -07:00
|
|
|
!json.nil? && equals_or_includes?(json['@context'], ActivityPub::TagManager::CONTEXT)
|
2017-08-08 12:52:15 -07:00
|
|
|
end
|
|
|
|
|
2018-01-07 20:00:23 -08:00
|
|
|
def unsupported_uri_scheme?(uri)
|
2022-03-12 00:02:24 -08:00
|
|
|
uri.nil? || !uri.start_with?('http://', 'https://')
|
2018-01-07 20:00:23 -08:00
|
|
|
end
|
|
|
|
|
2019-03-12 14:58:59 -07:00
|
|
|
def invalid_origin?(url)
|
|
|
|
return true if unsupported_uri_scheme?(url)
|
|
|
|
|
|
|
|
needle = Addressable::URI.parse(url).host
|
|
|
|
haystack = Addressable::URI.parse(@account.uri).host
|
|
|
|
|
|
|
|
!haystack.casecmp(needle).zero?
|
|
|
|
end
|
|
|
|
|
2017-08-26 04:47:38 -07:00
|
|
|
def canonicalize(json)
|
2018-05-02 09:58:48 -07:00
|
|
|
graph = RDF::Graph.new << JSON::LD::API.toRdf(json, documentLoader: method(:load_jsonld_context))
|
2017-08-26 04:47:38 -07:00
|
|
|
graph.dump(:normalize)
|
|
|
|
end
|
|
|
|
|
2022-02-03 05:07:29 -08:00
|
|
|
def compact(json)
|
|
|
|
compacted = JSON::LD::API.compact(json.without('signature'), full_context, documentLoader: method(:load_jsonld_context))
|
|
|
|
compacted['signature'] = json['signature']
|
|
|
|
compacted
|
|
|
|
end
|
|
|
|
|
2022-02-03 05:09:04 -08:00
|
|
|
# Patches a JSON-LD document to avoid compatibility issues on redistribution
|
|
|
|
#
|
|
|
|
# Since compacting a JSON-LD document against Mastodon's built-in vocabulary
|
|
|
|
# means other extension namespaces will be expanded, malformed JSON-LD
|
|
|
|
# attributes lost, and some values “unexpectedly” compacted this method
|
|
|
|
# patches the following likely sources of incompatibility:
|
|
|
|
# - 'https://www.w3.org/ns/activitystreams#Public' being compacted to
|
|
|
|
# 'as:Public' (for instance, pre-3.4.0 Mastodon does not understand
|
|
|
|
# 'as:Public')
|
|
|
|
# - single-item arrays being compacted to the item itself (`[foo]` being
|
|
|
|
# compacted to `foo`)
|
|
|
|
#
|
|
|
|
# It is not always possible for `patch_for_forwarding!` to produce a document
|
|
|
|
# deemed safe for forwarding. Use `safe_for_forwarding?` to check the status
|
|
|
|
# of the output document.
|
|
|
|
#
|
|
|
|
# @param original [Hash] The original JSON-LD document used as reference
|
|
|
|
# @param compacted [Hash] The compacted JSON-LD document to be patched
|
|
|
|
# @return [void]
|
|
|
|
def patch_for_forwarding!(original, compacted)
|
|
|
|
original.without('@context', 'signature').each do |key, value|
|
|
|
|
next if value.nil? || !compacted.key?(key)
|
|
|
|
|
|
|
|
compacted_value = compacted[key]
|
|
|
|
if value.is_a?(Hash) && compacted_value.is_a?(Hash)
|
|
|
|
patch_for_forwarding!(value, compacted_value)
|
|
|
|
elsif value.is_a?(Array)
|
|
|
|
compacted_value = [compacted_value] unless compacted_value.is_a?(Array)
|
|
|
|
return if value.size != compacted_value.size
|
|
|
|
|
|
|
|
compacted[key] = value.zip(compacted_value).map do |v, vc|
|
|
|
|
if v.is_a?(Hash) && vc.is_a?(Hash)
|
|
|
|
patch_for_forwarding!(v, vc)
|
|
|
|
vc
|
|
|
|
elsif v == 'https://www.w3.org/ns/activitystreams#Public' && vc == 'as:Public'
|
|
|
|
v
|
|
|
|
else
|
|
|
|
vc
|
|
|
|
end
|
|
|
|
end
|
|
|
|
elsif value == 'https://www.w3.org/ns/activitystreams#Public' && compacted_value == 'as:Public'
|
|
|
|
compacted[key] = value
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Tests whether a JSON-LD compaction is deemed safe for redistribution,
|
|
|
|
# that is, if it doesn't change its meaning to consumers that do not actually
|
|
|
|
# handle JSON-LD, but rely on values being serialized in a certain way.
|
|
|
|
#
|
|
|
|
# See `patch_for_forwarding!` for details.
|
|
|
|
#
|
|
|
|
# @param original [Hash] The original JSON-LD document used as reference
|
|
|
|
# @param compacted [Hash] The compacted JSON-LD document to be patched
|
|
|
|
# @return [Boolean] Whether the patched document is deemed safe
|
|
|
|
def safe_for_forwarding?(original, compacted)
|
|
|
|
original.without('@context', 'signature').all? do |key, value|
|
|
|
|
compacted_value = compacted[key]
|
|
|
|
return false unless value.class == compacted_value.class
|
|
|
|
|
|
|
|
if value.is_a?(Hash)
|
|
|
|
safe_for_forwarding?(value, compacted_value)
|
|
|
|
elsif value.is_a?(Array)
|
|
|
|
value.zip(compacted_value).all? do |v, vc|
|
|
|
|
v.is_a?(Hash) ? (vc.is_a?(Hash) && safe_for_forwarding?(v, vc)) : v == vc
|
|
|
|
end
|
|
|
|
else
|
|
|
|
value == compacted_value
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-05-12 07:48:32 -07:00
|
|
|
def fetch_resource(uri, id, on_behalf_of = nil)
|
2017-10-03 16:13:48 -07:00
|
|
|
unless id
|
2018-05-12 07:48:32 -07:00
|
|
|
json = fetch_resource_without_id_validation(uri, on_behalf_of)
|
2019-07-10 09:59:28 -07:00
|
|
|
|
2021-05-01 14:18:59 -07:00
|
|
|
return if !json.is_a?(Hash) || unsupported_uri_scheme?(json['id'])
|
2019-07-10 09:59:28 -07:00
|
|
|
|
2017-10-03 16:13:48 -07:00
|
|
|
uri = json['id']
|
|
|
|
end
|
|
|
|
|
2018-05-12 07:48:32 -07:00
|
|
|
json = fetch_resource_without_id_validation(uri, on_behalf_of)
|
2017-10-03 16:13:48 -07:00
|
|
|
json.present? && json['id'] == uri ? json : nil
|
|
|
|
end
|
|
|
|
|
2019-03-05 06:21:14 -08:00
|
|
|
def fetch_resource_without_id_validation(uri, on_behalf_of = nil, raise_on_temporary_error = false)
|
2019-07-11 05:49:55 -07:00
|
|
|
on_behalf_of ||= Account.representative
|
2019-07-10 09:59:28 -07:00
|
|
|
|
2019-07-11 05:49:55 -07:00
|
|
|
build_request(uri, on_behalf_of).perform do |response|
|
2019-07-10 09:59:28 -07:00
|
|
|
raise Mastodon::UnexpectedResponseError, response unless response_successful?(response) || response_error_unsalvageable?(response) || !raise_on_temporary_error
|
|
|
|
|
2019-07-11 05:49:55 -07:00
|
|
|
body_to_json(response.body_with_limit) if response.code == 200
|
2018-03-24 04:49:54 -07:00
|
|
|
end
|
2017-08-13 17:29:36 -07:00
|
|
|
end
|
|
|
|
|
2018-08-22 11:55:14 -07:00
|
|
|
def body_to_json(body, compare_id: nil)
|
|
|
|
json = body.is_a?(String) ? Oj.load(body, mode: :strict) : body
|
2019-07-10 09:59:28 -07:00
|
|
|
|
2018-08-22 11:55:14 -07:00
|
|
|
return if compare_id.present? && json['id'] != compare_id
|
2019-07-10 09:59:28 -07:00
|
|
|
|
2018-08-22 11:55:14 -07:00
|
|
|
json
|
2017-08-08 12:52:15 -07:00
|
|
|
rescue Oj::ParseError
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
2017-08-26 04:47:38 -07:00
|
|
|
def merge_context(context, new_context)
|
|
|
|
if context.is_a?(Array)
|
|
|
|
context << new_context
|
|
|
|
else
|
|
|
|
[context, new_context]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-03-05 06:21:14 -08:00
|
|
|
def response_successful?(response)
|
|
|
|
(200...300).cover?(response.code)
|
|
|
|
end
|
|
|
|
|
|
|
|
def response_error_unsalvageable?(response)
|
2019-07-10 09:59:28 -07:00
|
|
|
response.code == 501 || ((400...500).cover?(response.code) && ![401, 408, 429].include?(response.code))
|
2019-03-05 06:21:14 -08:00
|
|
|
end
|
|
|
|
|
2018-05-12 07:48:32 -07:00
|
|
|
def build_request(uri, on_behalf_of = nil)
|
2019-07-10 09:59:28 -07:00
|
|
|
Request.new(:get, uri).tap do |request|
|
|
|
|
request.on_behalf_of(on_behalf_of) if on_behalf_of
|
|
|
|
request.add_headers('Accept' => 'application/activity+json, application/ld+json')
|
|
|
|
end
|
2017-08-08 12:52:15 -07:00
|
|
|
end
|
2018-05-02 09:58:48 -07:00
|
|
|
|
2023-02-08 01:36:23 -08:00
|
|
|
def load_jsonld_context(url, _options = {}, &block)
|
2018-05-02 09:58:48 -07:00
|
|
|
json = Rails.cache.fetch("jsonld:context:#{url}", expires_in: 30.days, raw: true) do
|
|
|
|
request = Request.new(:get, url)
|
|
|
|
request.add_headers('Accept' => 'application/ld+json')
|
|
|
|
request.perform do |res|
|
|
|
|
raise JSON::LD::JsonLdError::LoadingDocumentFailed unless res.code == 200 && res.mime_type == 'application/ld+json'
|
2019-07-10 09:59:28 -07:00
|
|
|
|
2018-05-02 09:58:48 -07:00
|
|
|
res.body_with_limit
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-07-28 04:48:43 -07:00
|
|
|
doc = JSON::LD::API::RemoteDocument.new(json, documentUrl: url)
|
2019-07-10 09:59:28 -07:00
|
|
|
|
2023-02-08 01:36:23 -08:00
|
|
|
block ? yield(doc) : doc
|
2018-05-02 09:58:48 -07:00
|
|
|
end
|
2017-08-08 12:52:15 -07:00
|
|
|
end
|