Skip to content

Commit

Permalink
Change default image_mode to proxy, remove deprecated option
Browse files Browse the repository at this point in the history
  • Loading branch information
Nutomic committed Nov 8, 2024
1 parent 917e408 commit 7f294a8
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 33 deletions.
5 changes: 0 additions & 5 deletions config/defaults.hjson
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,6 @@
url: "http://localhost:8080/"
# Set a custom pictrs API key. ( Required for deleting images )
api_key: "string"
# Backwards compatibility with 0.18.1. False is equivalent to `image_mode: None`, true is
# equivalent to `image_mode: StoreLinkPreviews`.
#
# To be removed in 0.20
cache_external_link_previews: true
# Specifies how to handle remote images, so that users don't have to connect directly to remote
# servers.
image_mode:
Expand Down
2 changes: 1 addition & 1 deletion crates/api_common/src/request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ pub async fn delete_image_from_pictrs(
async fn generate_pictrs_thumbnail(image_url: &Url, context: &LemmyContext) -> LemmyResult<Url> {
let pictrs_config = context.settings().pictrs_config()?;

match pictrs_config.image_mode() {
match pictrs_config.image_mode {
PictrsImageMode::None => return Ok(image_url.clone()),
PictrsImageMode::ProxyAllImages => {
return Ok(proxy_image_link(image_url.clone(), context).await?.into())
Expand Down
4 changes: 2 additions & 2 deletions crates/api_common/src/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1045,7 +1045,7 @@ pub async fn process_markdown(

markdown_check_for_blocked_urls(&text, url_blocklist)?;

if context.settings().pictrs_config()?.image_mode() == PictrsImageMode::ProxyAllImages {
if context.settings().pictrs_config()?.image_mode == PictrsImageMode::ProxyAllImages {
let (text, links) = markdown_rewrite_image_links(text);
RemoteImage::create(&mut context.pool(), links.clone()).await?;

Expand Down Expand Up @@ -1115,7 +1115,7 @@ async fn proxy_image_link_internal(
pub async fn proxy_image_link(link: Url, context: &LemmyContext) -> LemmyResult<DbUrl> {
proxy_image_link_internal(
link,
context.settings().pictrs_config()?.image_mode(),
context.settings().pictrs_config()?.image_mode,
context,
)
.await
Expand Down
16 changes: 1 addition & 15 deletions crates/utils/src/settings/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use urlencoding::encode;

pub mod structs;

use structs::{DatabaseConnection, PictrsConfig, PictrsImageMode, Settings};
use structs::{DatabaseConnection, PictrsConfig, Settings};

static DEFAULT_CONFIG_FILE: &str = "config/config.hjson";

Expand Down Expand Up @@ -114,17 +114,3 @@ impl Settings {
.ok_or_else(|| anyhow!("images_disabled").into())
}
}

impl PictrsConfig {
pub fn image_mode(&self) -> PictrsImageMode {
if let Some(cache_external_link_previews) = self.cache_external_link_previews {
if cache_external_link_previews {
PictrsImageMode::StoreLinkPreviews
} else {
PictrsImageMode::None
}
} else {
self.image_mode.clone()
}
}
}
14 changes: 4 additions & 10 deletions crates/utils/src/settings/structs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -76,16 +76,10 @@ pub struct PictrsConfig {
#[default(None)]
pub api_key: Option<String>,

/// Backwards compatibility with 0.18.1. False is equivalent to `image_mode: None`, true is
/// equivalent to `image_mode: StoreLinkPreviews`.
///
/// To be removed in 0.20
pub(super) cache_external_link_previews: Option<bool>,

/// Specifies how to handle remote images, so that users don't have to connect directly to remote
/// servers.
#[default(PictrsImageMode::StoreLinkPreviews)]
pub(super) image_mode: PictrsImageMode,
#[default(PictrsImageMode::ProxyAllImages)]
pub image_mode: PictrsImageMode,

/// Timeout for uploading images to pictrs (in seconds)
#[default(30)]
Expand All @@ -106,8 +100,7 @@ pub enum PictrsImageMode {
/// ensures that they can be reliably retrieved and can be resized using pict-rs APIs. However
/// it also increases storage usage.
///
/// This is the default behaviour, and also matches Lemmy 0.18.
#[default]
/// This behaviour matches Lemmy 0.18.
StoreLinkPreviews,
/// If enabled, all images from remote domains are rewritten to pass through
/// `/api/v3/image_proxy`, including embedded images in markdown. Images are stored temporarily
Expand All @@ -116,6 +109,7 @@ pub enum PictrsImageMode {
/// local server.
///
/// Requires pict-rs 0.5
#[default]
ProxyAllImages,
}

Expand Down

0 comments on commit 7f294a8

Please sign in to comment.