This commit is contained in:
Samantaz Fox 2024-05-02 13:40:34 +02:00 committed by GitHub
commit 5a1ca08486
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
33 changed files with 372 additions and 257 deletions

View File

@ -42,6 +42,24 @@ db:
#########################################
#
# Cache configuration
#
#########################################
cache:
##
## URL of the caching server. To not use a caching server,
## set to an empty string or leave empty.
##
## Note: The same "long" format as the 'db' parameter is
## also supported.
##
url: ""
#########################################
#
# Server config

View File

@ -32,6 +32,10 @@ shards:
git: https://github.com/will/crystal-pg.git
version: 0.24.0
pool:
git: https://github.com/ysbaddaden/pool.git
version: 0.2.4
protodec:
git: https://github.com/iv-org/protodec.git
version: 0.1.5
@ -40,6 +44,10 @@ shards:
git: https://github.com/luislavena/radix.git
version: 0.4.1
redis:
git: https://github.com/stefanwille/crystal-redis.git
version: 2.8.3
spectator:
git: https://github.com/icy-arctic-fox/spectator.git
version: 0.10.4

View File

@ -10,25 +10,35 @@ targets:
main: src/invidious.cr
dependencies:
# Database
pg:
github: will/crystal-pg
version: ~> 0.24.0
sqlite3:
github: crystal-lang/crystal-sqlite3
version: ~> 0.18.0
# Web server
kemal:
github: kemalcr/kemal
version: ~> 1.1.2
kilt:
github: jeromegn/kilt
version: ~> 0.6.1
protodec:
github: iv-org/protodec
version: ~> 0.1.5
athena-negotiation:
github: athena-framework/negotiation
version: ~> 0.1.1
# Youtube backend
protodec:
github: iv-org/protodec
version: ~> 0.1.5
# Caching
redis:
github: stefanwille/crystal-redis
version: ~> 2.8.3
development_dependencies:
spectator:
github: icy-arctic-fox/spectator

36
src/invidious/cache.cr Normal file
View File

@ -0,0 +1,36 @@
require "./cache/*"
module Invidious::Cache
extend self
private INSTANCE = self.init(CONFIG.cache)
def init(cfg : Config::CacheConfig) : ItemStore
# Environment variable takes precedence over local config
url = ENV.fetch("INVIDIOUS_CACHE_URL", nil).try { |u| URI.parse(u) }
url ||= cfg.url
url ||= URI.new
# Determine cache type from URL scheme
type = StoreType.parse?(url.scheme || "none") || StoreType::None
case type
when .none?
return NullItemStore.new
when .redis?
if url.nil?
raise InvalidConfigException.new "Redis cache requires an URL."
end
return RedisItemStore.new(url)
else
raise InvalidConfigException.new "Invalid cache url. Only redis:// URL are currently supported."
end
end
# Shortcut methods to not have to specify INSTANCE everywhere in the code
{% for method in ["fetch", "store", "delete", "clear"] %}
def {{method.id}}(*args, **kwargs)
INSTANCE.{{method.id}}(*args, **kwargs)
end
{% end %}
end

22
src/invidious/cache/item_store.cr vendored Normal file
View File

@ -0,0 +1,22 @@
require "./cacheable_item"
module Invidious::Cache
# Abstract class from which any cached element should inherit
# Note: class is used here, instead of a module, in order to benefit
# from various compiler checks (e.g methods must be implemented)
abstract class ItemStore
# Retrieves an item from the store
# Returns nil if item wasn't found or is expired
abstract def fetch(key : String)
# Stores a given item into cache
abstract def store(key : String, value : String, expires : Time::Span)
# Prematurely deletes item(s) from the cache
abstract def delete(key : String)
abstract def delete(keys : Array(String))
# Removes all the items stored in the cache
abstract def clear
end
end

24
src/invidious/cache/null_item_store.cr vendored Normal file
View File

@ -0,0 +1,24 @@
require "./item_store"
module Invidious::Cache
class NullItemStore < ItemStore
def initialize
end
def fetch(key : String) : String?
return nil
end
def store(key : String, value : String, expires : Time::Span)
end
def delete(key : String)
end
def delete(keys : Array(String))
end
def clear
end
end
end

33
src/invidious/cache/redis_item_store.cr vendored Normal file
View File

@ -0,0 +1,33 @@
require "./item_store"
require "json"
require "redis"
module Invidious::Cache
class RedisItemStore < ItemStore
@redis : Redis::PooledClient
def initialize(url : URI)
@redis = Redis::PooledClient.new(url: url.to_s)
end
def fetch(key : String) : String?
return @redis.get(key)
end
def store(key : String, value : String, expires : Time::Span)
@redis.set(key, value, ex: expires.to_i)
end
def delete(key : String)
@redis.del(key)
end
def delete(keys : Array(String))
@redis.del(keys)
end
def clear
@redis.flushdb
end
end
end

6
src/invidious/cache/store_type.cr vendored Normal file
View File

@ -0,0 +1,6 @@
module Invidious::Cache
enum StoreType
None
Redis
end
end

View File

@ -1,12 +1,5 @@
struct DBConfig
include YAML::Serializable
property user : String
property password : String
property host : String
property port : Int32
property dbname : String
end
require "yaml"
require "./config/*"
struct ConfigPreferences
include YAML::Serializable
@ -60,7 +53,7 @@ class Config
# Number of threads to use for crawling videos from channels (for updating subscriptions)
property channel_threads : Int32 = 1
# Time interval between two executions of the job that crawls channel videos (subscriptions update).
@[YAML::Field(converter: Preferences::TimeSpanConverter)]
@[YAML::Field(converter: IV::Config::TimeSpanConverter)]
property channel_refresh_interval : Time::Span = 30.minutes
# Number of threads to use for updating feeds
property feed_threads : Int32 = 1
@ -69,10 +62,10 @@ class Config
# Default log level, valid YAML values are ints and strings, see src/invidious/helpers/logger.cr
property log_level : LogLevel = LogLevel::Info
# Database configuration with separate parameters (username, hostname, etc)
property db : DBConfig? = nil
property db : IV::Config::DBConfig? = nil
# Database configuration using 12-Factor "Database URL" syntax
@[YAML::Field(converter: Preferences::URIConverter)]
@[YAML::Field(converter: IV::Config::URIConverter)]
property database_url : URI = URI.parse("")
# Use polling to keep decryption function up to date
property decrypt_polling : Bool = false
@ -81,6 +74,8 @@ class Config
# Jobs config structure. See jobs.cr and jobs/base_job.cr
property jobs = Invidious::Jobs::JobsConfig.new
# Cache configuration. See cache/cache.cr
property cache = Invidious::Config::CacheConfig.new
# Used to tell Invidious it is behind a proxy, so links to resources should be https://
property https_only : Bool?
@ -118,8 +113,9 @@ class Config
property modified_source_code_url : String? = nil
# Connect to YouTube over 'ipv6', 'ipv4'. Will sometimes resolve fix issues with rate-limiting (see https://github.com/ytdl-org/youtube-dl/issues/21729)
@[YAML::Field(converter: Preferences::FamilyConverter)]
@[YAML::Field(converter: IV::Config::FamilyConverter)]
property force_resolve : Socket::Family = Socket::Family::UNSPEC
# Port to listen for connections (overridden by command line argument)
property port : Int32 = 3000
# Host to bind (overridden by command line argument)
@ -131,7 +127,7 @@ class Config
property use_innertube_for_captions : Bool = false
# Saved cookies in "name1=value1; name2=value2..." format
@[YAML::Field(converter: Preferences::StringToCookies)]
@[YAML::Field(converter: IV::Config::CookiesConverter)]
property cookies : HTTP::Cookies = HTTP::Cookies.new
# Playlist length limit
@ -214,14 +210,8 @@ class Config
# Build database_url from db.* if it's not set directly
if config.database_url.to_s.empty?
if db = config.db
config.database_url = URI.new(
scheme: "postgres",
user: db.user,
password: db.password,
host: db.host,
port: db.port,
path: db.dbname,
)
db.scheme = "postgres"
config.database_url = db.to_uri
else
puts "Config: Either database_url or db.* is required"
exit(1)

View File

@ -0,0 +1,14 @@
require "../cache/store_type"
module Invidious::Config
struct CacheConfig
include YAML::Serializable
@[YAML::Field(converter: IV::Config::URIConverter)]
property url : URI? = URI.new
# Required because of YAML serialization
def initialize
end
end
end

View File

@ -0,0 +1,74 @@
module Invidious::Config
module CookiesConverter
def self.to_yaml(value : HTTP::Cookies, yaml : YAML::Nodes::Builder)
(value.map { |c| "#{c.name}=#{c.value}" }).join("; ").to_yaml(yaml)
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : HTTP::Cookies
unless node.is_a?(YAML::Nodes::Scalar)
node.raise "Expected scalar, not #{node.class}"
end
cookies = HTTP::Cookies.new
node.value.split(";").each do |cookie|
next if cookie.strip.empty?
name, value = cookie.split("=", 2)
cookies << HTTP::Cookie.new(name.strip, value.strip)
end
return cookies
end
end
module FamilyConverter
def self.to_yaml(value : Socket::Family, yaml : YAML::Nodes::Builder)
case value
when Socket::Family::UNSPEC then yaml.scalar nil
when Socket::Family::INET then yaml.scalar "ipv4"
when Socket::Family::INET6 then yaml.scalar "ipv6"
when Socket::Family::UNIX then raise "Invalid socket family #{value}"
end
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : Socket::Family
if node.is_a?(YAML::Nodes::Scalar)
case node.value.downcase
when "ipv4" then Socket::Family::INET
when "ipv6" then Socket::Family::INET6
else
Socket::Family::UNSPEC
end
else
node.raise "Expected scalar, not #{node.class}"
end
end
end
module URIConverter
def self.to_yaml(value : URI, yaml : YAML::Nodes::Builder)
yaml.scalar value.normalize!
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : URI
if node.is_a?(YAML::Nodes::Scalar)
URI.parse node.value
else
node.raise "Expected scalar, not #{node.class}"
end
end
end
module TimeSpanConverter
def self.to_yaml(value : Time::Span, yaml : YAML::Nodes::Builder)
return yaml.scalar value.total_minutes.to_i32
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : Time::Span
if node.is_a?(YAML::Nodes::Scalar)
return decode_interval(node.value)
else
node.raise "Expected scalar, not #{node.class}"
end
end
end
end

View File

@ -0,0 +1,23 @@
module Invidious::Config
struct DBConfig
include YAML::Serializable
property scheme : String
property user : String
property password : String
property host : String
property port : Int32
property dbname : String
def to_uri
return URI.new(
scheme: @scheme,
user: @user,
password: @password,
host: @host,
port: @port,
path: @dbname,
)
end
end
end

View File

@ -18,7 +18,6 @@ module Invidious::Database
Invidious::Database.check_table("nonces", Nonce)
Invidious::Database.check_table("session_ids", SessionId)
Invidious::Database.check_table("users", User)
Invidious::Database.check_table("videos", Video)
if cfg.cache_annotations
Invidious::Database.check_table("annotations", Annotation)

View File

@ -38,3 +38,7 @@ end
# some important informations, and that the query should be sent again.
class RetryOnceException < Exception
end
# Exception used to indicate that the config file contains some errors
class InvalidConfigException < Exception
end

View File

@ -74,7 +74,7 @@ def create_notification_stream(env, topics, connection_channel)
published = Time.utc - Time::Span.new(days: time_span[0], hours: time_span[1], minutes: time_span[2], seconds: time_span[3])
video_id = TEST_IDS[rand(TEST_IDS.size)]
video = get_video(video_id)
video = Video.get(video_id)
video.published = published
response = JSON.parse(video.to_json(locale, nil))
@ -133,7 +133,7 @@ def create_notification_stream(env, topics, connection_channel)
next
end
video = get_video(video_id)
video = Video.get(video_id)
video.published = Time.unix(published)
response = JSON.parse(video.to_json(locale, nil))

View File

@ -6,14 +6,14 @@ module Invidious::Routes::API::Manifest
local = env.params.query["local"]?.try &.== "true"
id = env.params.url["id"]
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
# Since some implementations create playlists based on resolution regardless of different codecs,
# we can opt to only add a source to a representation if it has a unique height within that representation
unique_res = env.params.query["unique_res"]?.try { |q| (q == "true" || q == "1").to_unsafe }
begin
video = get_video(id, region: region)
video = Video.get(id, region: region)
rescue ex : NotFoundException
haltf env, status_code: 404
rescue ex

View File

@ -314,7 +314,7 @@ module Invidious::Routes::API::V1::Authenticated
end
begin
video = get_video(video_id)
video = Video.get(video_id)
rescue ex : NotFoundException
return error_json(404, ex)
rescue ex

View File

@ -430,7 +430,7 @@ module Invidious::Routes::API::V1::Channels
def self.search(env)
locale = env.get("preferences").as(Preferences).locale
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
env.response.content_type = "application/json"

View File

@ -4,7 +4,7 @@ module Invidious::Routes::API::V1::Feeds
env.response.content_type = "application/json"
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
trending_type = env.params.query["type"]?
begin

View File

@ -1,7 +1,7 @@
module Invidious::Routes::API::V1::Search
def self.search(env)
locale = env.get("preferences").as(Preferences).locale
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
env.response.content_type = "application/json"
@ -24,7 +24,7 @@ module Invidious::Routes::API::V1::Search
def self.search_suggestions(env)
preferences = env.get("preferences").as(Preferences)
region = env.params.query["region"]? || preferences.region
region = find_region(env.params.query["region"]?) || preferences.region
env.response.content_type = "application/json"
@ -65,7 +65,7 @@ module Invidious::Routes::API::V1::Search
page = env.params.query["page"]?.try &.to_i? || 1
locale = env.get("preferences").as(Preferences).locale
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
env.response.content_type = "application/json"
begin

View File

@ -5,11 +5,11 @@ module Invidious::Routes::API::V1::Videos
env.response.content_type = "application/json"
id = env.params.url["id"]
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
proxy = {"1", "true"}.any? &.== env.params.query["local"]?
begin
video = get_video(id, region: region)
video = Video.get(id, region: region)
rescue ex : NotFoundException
return error_json(404, ex)
rescue ex
@ -25,7 +25,7 @@ module Invidious::Routes::API::V1::Videos
env.response.content_type = "application/json"
id = env.params.url["id"]
region = env.params.query["region"]? || env.params.body["region"]?
region = find_region(env.params.query["region"]? || env.params.body["region"]?)
if id.nil? || id.size != 11 || !id.matches?(/^[\w-]+$/)
return error_json(400, "Invalid video ID")
@ -40,7 +40,7 @@ module Invidious::Routes::API::V1::Videos
# getting video info.
begin
video = get_video(id, region: region)
video = Video.get(id, region: region)
rescue ex : NotFoundException
haltf env, 404
rescue ex
@ -168,10 +168,10 @@ module Invidious::Routes::API::V1::Videos
env.response.content_type = "application/json"
id = env.params.url["id"]
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
begin
video = get_video(id, region: region)
video = Video.get(id, region: region)
rescue ex : NotFoundException
haltf env, 404
rescue ex
@ -297,7 +297,7 @@ module Invidious::Routes::API::V1::Videos
def self.comments(env)
locale = env.get("preferences").as(Preferences).locale
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
env.response.content_type = "application/json"

View File

@ -130,7 +130,7 @@ module Invidious::Routes::Embed
subscriptions ||= [] of String
begin
video = get_video(id, region: params.region)
video = Video.get(id, region: params.region)
rescue ex : NotFoundException
return error_template(404, ex)
rescue ex

View File

@ -48,7 +48,7 @@ module Invidious::Routes::Feeds
trending_type = env.params.query["type"]?
trending_type ||= "Default"
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
region ||= env.get("preferences").as(Preferences).region
begin
@ -420,7 +420,7 @@ module Invidious::Routes::Feeds
updated = Time.parse_rfc3339(entry.xpath_node("default:updated", namespaces).not_nil!.content)
begin
video = get_video(id, force_refresh: true)
video = Video.get(id, force_refresh: true)
rescue
next # skip this video since it raised an exception (e.g. it is a scheduled live event)
end

View File

@ -228,7 +228,7 @@ module Invidious::Routes::Playlists
prefs = env.get("preferences").as(Preferences)
locale = prefs.locale
region = env.params.query["region"]? || prefs.region
region = find_region(env.params.query["region"]?) || prefs.region
user = env.get? "user"
sid = env.get? "sid"
@ -352,7 +352,7 @@ module Invidious::Routes::Playlists
video_id = env.params.query["video_id"]
begin
video = get_video(video_id)
video = Video.get(video_id)
rescue ex : NotFoundException
return error_json(404, ex)
rescue ex

View File

@ -110,7 +110,7 @@ module Invidious::Routes::PreferencesRoute
automatic_instance_redirect ||= "off"
automatic_instance_redirect = automatic_instance_redirect == "on"
region = env.params.body["region"]?.try &.as(String)
region = find_region(env.params.body["region"]?)
locale = env.params.body["locale"]?.try &.as(String)
locale ||= CONFIG.default_user_preferences.locale

View File

@ -40,7 +40,7 @@ module Invidious::Routes::Search
prefs = env.get("preferences").as(Preferences)
locale = prefs.locale
region = env.params.query["region"]? || prefs.region
region = find_region(env.params.query["region"]?) || prefs.region
query = Invidious::Search::Query.new(env.params.query, :regular, region)

View File

@ -9,7 +9,7 @@ module Invidious::Routes::VideoPlayback
mns ||= [] of String
if query_params["region"]?
region = query_params["region"]
region = find_region(query_params["region"])
query_params.delete("region")
end
@ -265,7 +265,7 @@ module Invidious::Routes::VideoPlayback
return error_template(400, "Invalid itag")
end
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
local = (env.params.query["local"]? == "true")
title = env.params.query["title"]?
@ -275,7 +275,7 @@ module Invidious::Routes::VideoPlayback
end
begin
video = get_video(id, region: region)
video = Video.get(id, region: region)
rescue ex : NotFoundException
return error_template(404, ex)
rescue ex

View File

@ -3,7 +3,7 @@
module Invidious::Routes::Watch
def self.handle(env)
locale = env.get("preferences").as(Preferences).locale
region = env.params.query["region"]?
region = find_region(env.params.query["region"]?)
if env.params.query.to_s.includes?("%20") || env.params.query.to_s.includes?("+")
url = "/watch?" + env.params.query.to_s.gsub("%20", "").delete("+")
@ -52,7 +52,7 @@ module Invidious::Routes::Watch
env.params.query.delete_all("listen")
begin
video = get_video(id, region: params.region)
video = Video.get(id, region: params.region)
rescue ex : NotFoundException
LOGGER.error("get_video not found: #{id} : #{ex.message}")
return error_template(404, ex)

View File

@ -59,7 +59,7 @@ struct Invidious::User
next if video_id == "Video Id"
begin
video = get_video(video_id)
video = Video.get(video_id)
rescue ex
next
end
@ -133,7 +133,7 @@ struct Invidious::User
next if !video_id
begin
video = get_video(video_id, false)
video = Video.get(video_id)
rescue ex
next
end

View File

@ -1,6 +1,5 @@
struct Preferences
include JSON::Serializable
include YAML::Serializable
property annotations : Bool = CONFIG.default_user_preferences.annotations
property annotations_subscribed : Bool = CONFIG.default_user_preferences.annotations_subscribed
@ -8,17 +7,14 @@ struct Preferences
property automatic_instance_redirect : Bool = CONFIG.default_user_preferences.automatic_instance_redirect
@[JSON::Field(converter: Preferences::StringToArray)]
@[YAML::Field(converter: Preferences::StringToArray)]
property captions : Array(String) = CONFIG.default_user_preferences.captions
@[JSON::Field(converter: Preferences::StringToArray)]
@[YAML::Field(converter: Preferences::StringToArray)]
property comments : Array(String) = CONFIG.default_user_preferences.comments
property continue : Bool = CONFIG.default_user_preferences.continue
property continue_autoplay : Bool = CONFIG.default_user_preferences.continue_autoplay
@[JSON::Field(converter: Preferences::BoolToString)]
@[YAML::Field(converter: Preferences::BoolToString)]
property dark_mode : String = CONFIG.default_user_preferences.dark_mode
property latest_only : Bool = CONFIG.default_user_preferences.latest_only
property listen : Bool = CONFIG.default_user_preferences.listen
@ -78,27 +74,6 @@ struct Preferences
end
end
end
def self.to_yaml(value : String, yaml : YAML::Nodes::Builder)
yaml.scalar value
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : String
unless node.is_a?(YAML::Nodes::Scalar)
node.raise "Expected scalar, not #{node.class}"
end
case node.value
when "true"
"dark"
when "false"
"light"
when ""
CONFIG.default_user_preferences.dark_mode
else
node.value
end
end
end
module ClampInt
@ -109,58 +84,6 @@ struct Preferences
def self.from_json(value : JSON::PullParser) : Int32
value.read_int.clamp(0, MAX_ITEMS_PER_PAGE).to_i32
end
def self.to_yaml(value : Int32, yaml : YAML::Nodes::Builder)
yaml.scalar value
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : Int32
node.value.clamp(0, MAX_ITEMS_PER_PAGE)
end
end
module FamilyConverter
def self.to_yaml(value : Socket::Family, yaml : YAML::Nodes::Builder)
case value
when Socket::Family::UNSPEC
yaml.scalar nil
when Socket::Family::INET
yaml.scalar "ipv4"
when Socket::Family::INET6
yaml.scalar "ipv6"
when Socket::Family::UNIX
raise "Invalid socket family #{value}"
end
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : Socket::Family
if node.is_a?(YAML::Nodes::Scalar)
case node.value.downcase
when "ipv4"
Socket::Family::INET
when "ipv6"
Socket::Family::INET6
else
Socket::Family::UNSPEC
end
else
node.raise "Expected scalar, not #{node.class}"
end
end
end
module URIConverter
def self.to_yaml(value : URI, yaml : YAML::Nodes::Builder)
yaml.scalar value.normalize!
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : URI
if node.is_a?(YAML::Nodes::Scalar)
URI.parse node.value
else
node.raise "Expected scalar, not #{node.class}"
end
end
end
module ProcessString
@ -171,14 +94,6 @@ struct Preferences
def self.from_json(value : JSON::PullParser) : String
HTML.escape(value.read_string[0, 100])
end
def self.to_yaml(value : String, yaml : YAML::Nodes::Builder)
yaml.scalar value
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : String
HTML.escape(node.value[0, 100])
end
end
module StringToArray
@ -202,73 +117,5 @@ struct Preferences
result
end
def self.to_yaml(value : Array(String), yaml : YAML::Nodes::Builder)
yaml.sequence do
value.each do |element|
yaml.scalar element
end
end
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : Array(String)
begin
unless node.is_a?(YAML::Nodes::Sequence)
node.raise "Expected sequence, not #{node.class}"
end
result = [] of String
node.nodes.each do |item|
unless item.is_a?(YAML::Nodes::Scalar)
node.raise "Expected scalar, not #{item.class}"
end
result << HTML.escape(item.value[0, 100])
end
rescue ex
if node.is_a?(YAML::Nodes::Scalar)
result = [HTML.escape(node.value[0, 100]), ""]
else
result = ["", ""]
end
end
result
end
end
module StringToCookies
def self.to_yaml(value : HTTP::Cookies, yaml : YAML::Nodes::Builder)
(value.map { |c| "#{c.name}=#{c.value}" }).join("; ").to_yaml(yaml)
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : HTTP::Cookies
unless node.is_a?(YAML::Nodes::Scalar)
node.raise "Expected scalar, not #{node.class}"
end
cookies = HTTP::Cookies.new
node.value.split(";").each do |cookie|
next if cookie.strip.empty?
name, value = cookie.split("=", 2)
cookies << HTTP::Cookie.new(name.strip, value.strip)
end
cookies
end
end
module TimeSpanConverter
def self.to_yaml(value : Time::Span, yaml : YAML::Nodes::Builder)
return yaml.scalar value.total_minutes.to_i32
end
def self.from_yaml(ctx : YAML::ParseContext, node : YAML::Nodes::Node) : Time::Span
if node.is_a?(YAML::Nodes::Scalar)
return decode_interval(node.value)
else
node.raise "Expected scalar, not #{node.class}"
end
end
end
end

View File

@ -5,8 +5,6 @@ enum VideoType
end
struct Video
include DB::Serializable
# Version of the JSON structure
# It prevents us from loading an incompatible version from cache
# (either newer or older, if instances with different versions run
@ -16,23 +14,16 @@ struct Video
# the `params` structure in videos/parser.cr!!!
#
SCHEMA_VERSION = 2
CACHE_KEY = "video_v#{SCHEMA_VERSION}"
property id : String
@[DB::Field(converter: Video::JSONConverter)]
property info : Hash(String, JSON::Any)
property updated : Time
@[DB::Field(ignore: true)]
@captions = [] of Invidious::Videos::Captions::Metadata
@[DB::Field(ignore: true)]
property adaptive_fmts : Array(Hash(String, JSON::Any))?
@[DB::Field(ignore: true)]
property fmt_stream : Array(Hash(String, JSON::Any))?
@[DB::Field(ignore: true)]
property description : String?
module JSONConverter
@ -41,6 +32,45 @@ struct Video
end
end
# Create new object from cache (JSON)
def initialize(@id, @info)
end
def self.get(id : String, *, force_refresh = false, region = nil)
key = "#{CACHE_KEY}:#{id}"
key += ":#{region}" if !region.nil?
# Fetch video from cache, unles a force refresh is requested
info = force_refresh ? nil : IV::Cache::INSTANCE.fetch(key)
updated = false
# Fetch video from youtube, if needed
if info.nil?
video = Video.new(id, fetch_video(id, region))
updated = true
else
video = Video.new(id, JSON.parse(info).as_h)
# If the video has premiered or the live has started, refresh the data.
if (video.live_now && video.published < Time.utc)
video = Video.new(id, fetch_video(id, region))
updated = true
end
end
# Store updated entry in cache
# TODO: finer cache control based on video type & publication date
if updated
if video.live_now || video.published < Time.utc
IV::Cache::INSTANCE.store(key, info.to_json, 10.minutes)
else
IV::Cache::INSTANCE.store(key, info.to_json, 2.hours)
end
end
return Video.new(id, info)
end
# Methods for API v1 JSON
def to_json(locale : String?, json : JSON::Builder)
@ -362,35 +392,6 @@ struct Video
getset_bool isUpcoming
end
def get_video(id, refresh = true, region = nil, force_refresh = false)
if (video = Invidious::Database::Videos.select(id)) && !region
# If record was last updated over 10 minutes ago, or video has since premiered,
# refresh (expire param in response lasts for 6 hours)
if (refresh &&
(Time.utc - video.updated > 10.minutes) ||
(video.premiere_timestamp.try &.< Time.utc)) ||
force_refresh ||
video.schema_version != Video::SCHEMA_VERSION # cache control
begin
video = fetch_video(id, region)
Invidious::Database::Videos.update(video)
rescue ex
Invidious::Database::Videos.delete(id)
raise ex
end
end
else
video = fetch_video(id, region)
Invidious::Database::Videos.insert(video) if !region
end
return video
rescue DB::Error
# Avoid common `DB::PoolRetryAttemptsExceeded` error and friends
# Note: All DB errors inherit from `DB::Error`
return fetch_video(id, region)
end
def fetch_video(id, region)
info = extract_video_info(video_id: id)
@ -408,13 +409,7 @@ def fetch_video(id, region)
end
end
video = Video.new({
id: id,
info: info,
updated: Time.utc,
})
return video
return info
end
def process_continuation(query, plid, id)

View File

@ -25,3 +25,13 @@ REGIONS = {
"TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI",
"VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW",
}
# Utility function that searches in the array above for a given input.
def find_region(reg : String?) : String?
return nil if reg.nil?
# Normalize input
region = (reg || "").upcase[0..1]
return REGIONS.find(&.== region)
end

View File

@ -38,7 +38,9 @@ def process_video_params(query, preferences)
preferred_captions = query["subtitles"]?.try &.split(",").map(&.downcase)
quality = query["quality"]?
quality_dash = query["quality_dash"]?
region = query["region"]?
region = find_region(query["region"]?)
related_videos = query["related_videos"]?.try { |q| (q == "true" || q == "1").to_unsafe }
speed = query["speed"]?.try &.rchop("x").to_f?
video_loop = query["loop"]?.try { |q| (q == "true" || q == "1").to_unsafe }