+
{{ article.title }}
{{ article.summary }}
@@ -225,9 +225,19 @@ onMounted(() => { padding: 0; } + ul, + ol { + margin-bottom: 0.5rem; + + ul, + ol { + margin-top: 0.25rem; + } + } + ul > li:not(:last-child), ol > li:not(:last-child) { - margin-bottom: 0.5rem; + margin-bottom: 0.25rem; } ul, @@ -302,8 +312,10 @@ onMounted(() => { h1, h2 { + font-weight: 600; + a { - font-weight: 800; + font-weight: 600; } } diff --git a/apps/frontend/src/pages/news/changelog.vue b/apps/frontend/src/pages/news/changelog.vue index b59fb4f7a8..2bca688d31 100644 --- a/apps/frontend/src/pages/news/changelog.vue +++ b/apps/frontend/src/pages/news/changelog.vue @@ -1,6 +1,6 @@
-
diff --git a/apps/frontend/src/pages/news/index.vue b/apps/frontend/src/pages/news/index.vue
index 0398072638..1168d4d8d1 100644
--- a/apps/frontend/src/pages/news/index.vue
+++ b/apps/frontend/src/pages/news/index.vue
@@ -44,7 +44,7 @@ useSeoMeta({
Changelog
+Changelog
Keep up-to-date on what's new with Modrinth.
-
News
+News
-
+
{{ formatMessage(messages.whatContentType) }}
-
+
{{
formatMessage(messages.whatContentId, {
item: formatReportItemType(formatMessage, reportItem),
@@ -160,7 +160,7 @@
= {
'Summaries from Microsoft Defender, VirusTotal, or AI malware detection are not sufficient forms of evidence and will not be accepted.',
}),
],
+ 'missing-disclosure': [
+ defineMessage({
+ id: 'report.note.missing-disclosure.1',
+ defaultMessage: `Content disclosures are a new feature we've just added. We're giving creators a grace period to get their disclosures up-to-date before we begin accepting reports for missing or incorrect disclosures.`,
+ }),
+ defineMessage({
+ id: 'report.note.missing-disclosure.2',
+ defaultMessage:
+ 'Check back later once the grace period has ended. Reports of this type are not being accepted at this time.',
+ }),
+ ],
}
const messages = defineMessages({
diff --git a/apps/frontend/src/pages/user/[user].vue b/apps/frontend/src/pages/user/[user].vue
index a4e01bc453..c7f3ec27ed 100644
--- a/apps/frontend/src/pages/user/[user].vue
+++ b/apps/frontend/src/pages/user/[user].vue
@@ -24,6 +24,7 @@ import { useQueryClient } from '@tanstack/vue-query'
import AdPlaceholder from '~/components/ui/AdPlaceholder.vue'
import CollectionCreateModal from '~/components/ui/create/CollectionCreateModal.vue'
import ProjectCreateModal from '~/components/ui/create/ProjectCreateModal.vue'
+import { warmProjectCheckCaches } from '~/composables/queries/project'
const route = useNativeRoute()
const client = injectModrinthClient()
@@ -62,7 +63,7 @@ try {
// Let the mounted layout's useQuery surface errors; do not fail route setup.
}
-await Promise.allSettled([
+const [projectsResult] = await Promise.allSettled([
queryClient.ensureQueryData({
queryKey: ['user', userId.value, 'projects'],
queryFn: () => userProfile.getProjects(userId.value),
@@ -80,6 +81,9 @@ await Promise.allSettled([
}),
])
+if (projectsResult.status === 'fulfilled') {
+ warmProjectCheckCaches(queryClient, projectsResult.value)
+}
const title = computed(() =>
prefetchedUser ? `${prefetchedUser.username} - Modrinth` : 'Modrinth',
)
diff --git a/apps/frontend/src/providers/setup/user-country.ts b/apps/frontend/src/providers/setup/user-country.ts
new file mode 100644
index 0000000000..457b521387
--- /dev/null
+++ b/apps/frontend/src/providers/setup/user-country.ts
@@ -0,0 +1,41 @@
+import { provideUserCountry } from '@modrinth/ui'
+import { onMounted } from 'vue'
+
+import { useRequestHeaders, useState } from '#imports'
+
+function getCountryFromLocale(locale: string | undefined) {
+ if (!locale) return undefined
+
+ try {
+ return new Intl.Locale(locale).region?.toUpperCase()
+ } catch {
+ return undefined
+ }
+}
+
+export function setupUserCountryProvider() {
+ const country = useState('userCountry', () => 'US')
+ const fromServer = useState('userCountryFromServer', () => false)
+
+ if (import.meta.server) {
+ const headers = useRequestHeaders(['cf-ipcountry', 'accept-language'])
+ const cloudflareCountry = headers['cf-ipcountry']
+ const locale = headers['accept-language']?.split(',')[0]?.split(';')[0]?.trim()
+ const detectedCountry = cloudflareCountry?.toUpperCase() ?? getCountryFromLocale(locale)
+
+ if (detectedCountry) {
+ country.value = detectedCountry
+ fromServer.value = true
+ }
+ }
+
+ if (import.meta.client) {
+ onMounted(() => {
+ if (!fromServer.value) {
+ country.value = getCountryFromLocale(navigator.language) ?? country.value
+ }
+ })
+ }
+
+ return provideUserCountry(country)
+}
diff --git a/apps/frontend/src/public/news/article/ai-policy-and-disclosures/details.webp b/apps/frontend/src/public/news/article/ai-policy-and-disclosures/details.webp
new file mode 100644
index 0000000000..597a833e9a
Binary files /dev/null and b/apps/frontend/src/public/news/article/ai-policy-and-disclosures/details.webp differ
diff --git a/apps/frontend/src/public/news/article/ai-policy-and-disclosures/filters.webp b/apps/frontend/src/public/news/article/ai-policy-and-disclosures/filters.webp
new file mode 100644
index 0000000000..42f74bde17
Binary files /dev/null and b/apps/frontend/src/public/news/article/ai-policy-and-disclosures/filters.webp differ
diff --git a/apps/frontend/src/public/news/article/ai-policy-and-disclosures/settings.webp b/apps/frontend/src/public/news/article/ai-policy-and-disclosures/settings.webp
new file mode 100644
index 0000000000..5ad8b30f9f
Binary files /dev/null and b/apps/frontend/src/public/news/article/ai-policy-and-disclosures/settings.webp differ
diff --git a/apps/frontend/src/public/news/article/ai-policy-and-disclosures/thumbnail.webp b/apps/frontend/src/public/news/article/ai-policy-and-disclosures/thumbnail.webp
new file mode 100644
index 0000000000..b5a135e87e
Binary files /dev/null and b/apps/frontend/src/public/news/article/ai-policy-and-disclosures/thumbnail.webp differ
diff --git a/apps/frontend/src/public/news/feed/articles.json b/apps/frontend/src/public/news/feed/articles.json
index 3c3e72849c..9a0f99664e 100644
--- a/apps/frontend/src/public/news/feed/articles.json
+++ b/apps/frontend/src/public/news/feed/articles.json
@@ -1,5 +1,12 @@
{
"articles": [
+ {
+ "title": "New AI rules and project disclosures",
+ "summary": "An update to Modrinth’s Content Rules and our new mandatory content disclosures.",
+ "thumbnail": "https://modrinth.com/news/article/ai-policy-and-disclosures/thumbnail.webp",
+ "date": "2026-08-13T16:00:00.000Z",
+ "link": "https://modrinth.com/news/article/ai-policy-and-disclosures"
+ },
{
"title": "Share instances with friends",
"summary": "Play more easily with friends without having to share .mrpack files.",
diff --git a/apps/frontend/src/public/news/feed/rss.xml b/apps/frontend/src/public/news/feed/rss.xml
index 3cd0ddca33..32457f0121 100644
--- a/apps/frontend/src/public/news/feed/rss.xml
+++ b/apps/frontend/src/public/news/feed/rss.xml
@@ -4,9 +4,17 @@
@modrinth/blog
- Mon, 10 Aug 2026 21:14:09 GMT
+ Thu, 13 Aug 2026 15:54:59 GMT
-
+
<![CDATA[New AI rules and project disclosures]]>
+ https://modrinth.com/news/article/ai-policy-and-disclosures/
+ Thu, 13 Aug 2026 16:00:00 GMT
+ <![CDATA[<p>This year, fully AI-generated content has begun <em>flooding</em> Modrinth. Project submissions have gone up from about 2,500 per week at the start of the year to over 5,000 per week now.</p><p>We’ve never had a quality threshold for uploading to Modrinth, and we continue to believe that you should not need to make professional, perfect work in order to publish on Modrinth. But we do believe that it has to be <em>your</em> work, and generating it completely with AI is not your work. Modrinth is a community of creators. In order to be creators, you need to actually create something.</p><p>Today, we’re announcing a set of new features and policies aimed at informing users about things they may want to know about a project before downloading, eliminating fully AI-generated content, and enforcing transparency for content that has been made in part with generative AI.</p><p>In addition, we have made a very minor update to our <a href="/legal/terms" rel="noopener nofollow ugc">Terms of Use</a>, to prohibit the use of data on Modrinth to train AI models.</p><h2>Content disclosures</h2><p>We have introduced content disclosures to provide a standardized place for certain things that we feel it is important for users to understand before downloading a project on Modrinth.</p><p><img src="/news/article/ai-policy-and-disclosures/details.webp" alt="In the Details panel on the sidebar of a project, a couple disclosures are listed as an example. Contains paid features: Cosmetic items are purchaseable with Mod Coins; Contains opt-out telemetry: Anonymous launch analytics about game version and mod loaders."></p><p>Here’s the current list of content disclosures available at this time:</p><ul><li><strong>Contains AI-generated content</strong><ul><li>Projects must enable this if they:<ul><li>contain a substantial amount of AI-generated code</li><li><em>any</em> assets that are substantially AI-generated</li><li>the project’s design relies on the use of generative AI</li><li>or, if any element of your project’s page such as description or publishing relies on generative AI</li></ul></li><li>There are also options available to disclose if you use it for code, assets, text, or functionality within the project.</li></ul></li><li><strong>Contains advertising</strong><ul><li>Projects that contain advertisements, sponsorships, or promotions of other works must enable this disclosure.</li><li>If the promotion has no direct monetary value <strong><em>and</em></strong> it is for something that the average person would consider <em>relevant</em> and <em>unobtrusive</em> (such as a link to your Modrinth profile in the corner of the settings page for your own mod), we would not consider that an advertisement for the purposes of this disclosure.</li></ul></li><li><strong>Contains paid features</strong><ul><li>Projects that contain features that can be obtained by spending real-world money.</li><li>You must provide a list of the types of paid features.</li></ul></li><li><strong>Contains telemetry</strong><ul><li>If your project collects any data on users (sent either to yourself or a third party), it must be disclosed here.</li><li>There’s three types of telemetry consent options you can select: Opt-in, Opt-out, and Always active</li><li>You must provide a list of the types of data that is collected.</li></ul></li><li><strong>Contains derivative content</strong><ul><li>If your project is a fork or uses substantial parts of another work, you must declare it as a derivative work of the source work.</li><li>You must at least provide the name of the work, and if available, a link. You may also provide a small explanation of how it is a derivative work, such as a brief summary of what is different about your fork.</li></ul></li><li><strong>Photosensitivity warning</strong><ul><li>If your project contains anything that you think may be dangerous to certain people who are sensitive to flashing lights or patterns, you must enable the photosensitivity disclosure.</li></ul></li><li><strong>Contains external system interactions</strong><ul><li>Projects that read or edit things on the user’s system outside of the game must enable this disclosure.</li><li>You must describe precisely how it interacts with the user’s system in the required note.</li><li>The most common usage of this is in some “horror” mods, where they may do harmless but spooky things on your computer such as adding creepy files to your desktop.</li></ul></li><li><strong>Archived</strong><ul><li>This isn’t new, but we’re transitioning it from a project visibility status to a disclosure.</li><li>This will allow you to have an Unlisted project also be archived, previously archived projects were always Public.</li><li>You can also include a note to explain why your project has been archived.</li></ul></li></ul><p><img src="/news/article/ai-policy-and-disclosures/settings.webp" alt="In project settings, there is a new Disclosures tab. On it, you can toggle disclosures on and off, and some of them have additional fields you need to fill out."></p><p>Projects with disclosures you’d like to avoid can be filtered out in search under the “Advanced exclusions” options. When filtering out projects with photosensitivity warnings, we will warn the user that not all projects without the warning are guaranteed to be safe for users with photosensitivities. Advanced exclusion filters will be persistent across searches in your browser so that you don't have to apply them every time you search.</p><p><img src="/news/article/ai-policy-and-disclosures/filters.webp" alt="At the bottom of the search filters, there is an "Advanced exclusions" section. You can select different disclosures to exclude from your search results."></p><h2>New AI policy</h2><p>We’ve added Section 6 to the <a href="/legal/rules" rel="noopener nofollow ugc">Content Rules</a>, which is as follows:</p><div id="rule-6"></div><p>To summarize:</p><ul><li>AI images as project icons, banners, gallery images, or in their descriptions are no longer allowed.</li><li>Fully or nearly fully AI-generated projects are no longer allowed.</li><li>AI-assisted projects, where the human creator contributed in a primary and significant way, are allowed but must disclose that AI assistance was used.</li></ul><h2>Enforcement</h2><p>Obviously, this is a big change and creators will need to take some time to update their projects to have all necessary disclosures or take down projects that are no longer allowed. For this reason, we will have a 45 day grace period to give everyone enough time to get their projects in order.</p><p>During this grace period, we will not be accepting reports for projects in violation of the new AI policy or for missing content disclosures to give them a fair chance to update them. The 45-day grace period ends on <strong>September 27, 2026</strong>.</p><p>In addition, we will not tolerate witch-hunting on the Modrinth platform. These disclosures are to inform users and provide transparency between user and creator. Anyone using them to shame, insult, belittle, or harass others will be swiftly and permanently removed from the Modrinth platform and community Discord server. Be kind to each other.</p><h2>Terms of Use update</h2><p>Modrinth's <a href="/legal/terms" rel="noopener nofollow ugc">Terms of Use</a> have been updated in a very minor way to prohibit the use of data on Modrinth to train AI models. The exact change is as follows:</p><blockquote><p>Additionally, you agree not to:</p><ul><li>[...]</li><li>Use any data, content, or materials available on or through the Service to train, develop, or improve any artificial intelligence or machine learning models.</li></ul></blockquote><p>A larger TOU update will be coming in the future to address other issues since the last update was in 2023, but we felt it was important to address this sooner rather than later.</p><p>—</p><p>Thank you for your patience with us on this feature. We know it’s been long-requested and overdue, but we wanted to make sure we shipped something comprehensive, enforceable, and more than just a publicity stunt.</p><p>Thank you as always for continuing to support us. It means a lot. 💚</p>]]>
+
-
<![CDATA[Share instances with friends]]>
,
+ pub updated_by: DBUserId,
+ pub set_by_moderator: bool,
+ pub deleted_at: Option>,
+ pub lock_status: DisclosureLockStatus,
+}
+
+impl DBProjectDisclosure {
+ pub async fn upsert(
+ &self,
+ exec: impl crate::database::Executor<'_, Database = sqlx::Postgres>,
+ ) -> Result<(), DatabaseError> {
+ let (disclosure_type, metadata) =
+ self.disclosure.to_parts().map_err(|e| {
+ DatabaseError::Internal(eyre::Report::new(e).wrap_err(
+ "failed to serialize project disclosure metadata",
+ ))
+ })?;
+
+ sqlx::query!(
+ r#"
+ INSERT INTO project_disclosures (project_id, type, metadata, updated_by, set_by_moderator, lock_status)
+ VALUES ($1, $2, $3, $4, $5, $6)
+ ON CONFLICT (project_id, type) DO UPDATE SET
+ metadata = $3,
+ updated_at = now(),
+ updated_by = $4,
+ set_by_moderator = $5,
+ deleted_at = NULL,
+ lock_status = $6
+ "#,
+ self.project_id as DBProjectId,
+ disclosure_type,
+ metadata,
+ self.updated_by as DBUserId,
+ self.set_by_moderator,
+ <&'static str>::from(self.lock_status),
+ )
+ .execute(exec)
+ .await?;
+
+ Ok(())
+ }
+
+ pub async fn get_many_for_project(
+ project_id: DBProjectId,
+ include_deleted: bool,
+ exec: impl crate::database::Executor<'_, Database = sqlx::Postgres>,
+ ) -> Result, DatabaseError> {
+ let rows = sqlx::query!(
+ r#"
+ SELECT project_id, type AS "disclosure_type!", metadata, updated_at, updated_by, set_by_moderator, deleted_at, lock_status
+ FROM project_disclosures
+ WHERE project_id = $1 AND ($2 OR deleted_at IS NULL)
+ ORDER BY updated_at DESC
+ "#,
+ project_id as DBProjectId,
+ include_deleted,
+ )
+ .fetch_all(exec)
+ .await?;
+
+ rows.into_iter()
+ .map(|row| {
+ Ok(DBProjectDisclosure {
+ project_id: DBProjectId(row.project_id),
+ disclosure: ProjectDisclosure::from_parts(
+ &row.disclosure_type,
+ row.metadata,
+ )
+ .map_err(|e| {
+ DatabaseError::Internal(eyre::Report::new(e).wrap_err(
+ "failed to deserialize project disclosure metadata",
+ ))
+ })?,
+ updated_at: row.updated_at,
+ updated_by: DBUserId(row.updated_by),
+ set_by_moderator: row.set_by_moderator,
+ deleted_at: row.deleted_at,
+ lock_status: DisclosureLockStatus::from_str(
+ &row.lock_status,
+ )
+ .map_err(|e| {
+ DatabaseError::Internal(eyre::Report::new(e).wrap_err(
+ "failed to parse project disclosure lock status",
+ ))
+ })?,
+ })
+ })
+ .collect()
+ }
+
+ /// Returns the subset of `project_ids` that carry a disclosure of the given type.
+ pub async fn projects_with_type(
+ disclosure_type: ProjectDisclosureType,
+ project_ids: &[DBProjectId],
+ exec: impl crate::database::Executor<'_, Database = sqlx::Postgres>,
+ ) -> Result, DatabaseError> {
+ let ids = project_ids.iter().map(|id| id.0).collect::>();
+ let rows = sqlx::query_scalar!(
+ r#"
+ SELECT project_id
+ FROM project_disclosures
+ WHERE type = $1 AND project_id = ANY($2) AND deleted_at IS NULL
+ "#,
+ <&'static str>::from(disclosure_type),
+ &ids,
+ )
+ .fetch_all(exec)
+ .await?;
+
+ Ok(rows.into_iter().map(DBProjectId).collect())
+ }
+
+ pub async fn get_lock_statuses_for_project(
+ project_id: DBProjectId,
+ types: &[String],
+ exec: impl crate::database::Executor<'_, Database = sqlx::Postgres>,
+ ) -> Result, DatabaseError> {
+ let rows = sqlx::query!(
+ r#"
+ SELECT type AS "disclosure_type!", lock_status
+ FROM project_disclosures
+ WHERE project_id = $1 AND type = ANY($2)
+ "#,
+ project_id as DBProjectId,
+ types,
+ )
+ .fetch_all(exec)
+ .await?;
+
+ rows.into_iter()
+ .map(|row| {
+ let lock_status = DisclosureLockStatus::from_str(
+ &row.lock_status,
+ )
+ .map_err(|e| {
+ DatabaseError::Internal(eyre::Report::new(e).wrap_err(
+ "failed to parse project disclosure lock status",
+ ))
+ })?;
+
+ Ok((row.disclosure_type, lock_status))
+ })
+ .collect()
+ }
+
+ pub async fn remove(
+ project_id: DBProjectId,
+ disclosure_type: ProjectDisclosureType,
+ updated_by: DBUserId,
+ set_by_moderator: bool,
+ exec: impl crate::database::Executor<'_, Database = sqlx::Postgres>,
+ ) -> Result {
+ let result = sqlx::query!(
+ r#"
+ UPDATE project_disclosures
+ SET deleted_at = now(), updated_at = now(), updated_by = $3, set_by_moderator = $4
+ WHERE project_id = $1 AND type = $2 AND deleted_at IS NULL
+ "#,
+ project_id as DBProjectId,
+ <&'static str>::from(disclosure_type),
+ updated_by as DBUserId,
+ set_by_moderator,
+ )
+ .execute(exec)
+ .await?;
+
+ Ok(result.rows_affected() > 0)
+ }
+}
diff --git a/apps/labrinth/src/database/models/user_item.rs b/apps/labrinth/src/database/models/user_item.rs
index a5efc5e701..cb88f48a72 100644
--- a/apps/labrinth/src/database/models/user_item.rs
+++ b/apps/labrinth/src/database/models/user_item.rs
@@ -1,15 +1,19 @@
use super::ids::{DBProjectId, DBUserId};
use super::{DBCollectionId, DBReportId, DBThreadId};
use crate::database::models::charge_item::DBCharge;
+use crate::database::models::thread_item::ThreadMessageBuilder;
use crate::database::models::user_subscription_item::DBUserSubscription;
use crate::database::models::{DBOrganizationId, DatabaseError};
use crate::database::{PgTransaction, models};
use crate::models::billing::ChargeStatus;
+use crate::models::projects::ProjectStatus;
+use crate::models::threads::MessageBody;
use crate::models::users::Badges;
use crate::util::error::Context;
use ariadne::ids::base62_impl::{parse_base62, to_base62};
use chrono::{DateTime, Utc};
use dashmap::DashMap;
+use futures::TryStreamExt;
use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};
use std::fmt::{Debug, Display};
@@ -593,12 +597,120 @@ impl DBUser {
.wrap_err("failed to get user by ID")?;
if let Some(delete_user) = user {
+ let username = delete_user.username.clone();
DBUser::clear_caches(&[(id, Some(delete_user.username))], redis)
.await
.wrap_err("failed to clear caches")?;
let deleted_user: DBUserId =
crate::models::users::DELETED_USER.into();
+ let user_id_str = ariadne::ids::UserId::from(id).to_string();
+
+ let owned_projects = sqlx::query!(
+ r#"
+ SELECT
+ m.id AS "id!",
+ m.status AS "status!",
+ m.slug,
+ t.id AS "thread_id!"
+ FROM mods m
+ INNER JOIN team_members tm
+ ON tm.team_id = m.team_id
+ AND tm.user_id = $1
+ AND tm.is_owner = TRUE
+ INNER JOIN threads t ON t.mod_id = m.id
+ "#,
+ id as DBUserId,
+ )
+ .fetch(&mut *transaction)
+ .try_collect::>()
+ .await
+ .wrap_err("failed to fetch projects owned by deleted user")?;
+
+ for project in &owned_projects {
+ let thread_id = DBThreadId(project.thread_id);
+
+ ThreadMessageBuilder {
+ author_id: Some(deleted_user),
+ body: MessageBody::Text {
+ body: format!(
+ "Project transferred to Ghost when user account `{username}` (`{user_id_str}`) was deleted"
+ ),
+ private: true,
+ replying_to: None,
+ associated_images: Vec::new(),
+ },
+ thread_id,
+ hide_identity: false,
+ }
+ .insert(&mut *transaction)
+ .await
+ .wrap_err(
+ "failed to insert project transfer thread message",
+ )?;
+
+ if ProjectStatus::from_string(&project.status)
+ == ProjectStatus::Processing
+ {
+ ThreadMessageBuilder {
+ author_id: Some(deleted_user),
+ body: MessageBody::Text {
+ body: format!(
+ "Automatically rejected when user account `{username}` (`{user_id_str}`) was deleted"
+ ),
+ private: true,
+ replying_to: None,
+ associated_images: Vec::new(),
+ },
+ thread_id,
+ hide_identity: false,
+ }
+ .insert(&mut *transaction)
+ .await
+ .wrap_err(
+ "failed to insert automatic rejection thread message",
+ )?;
+
+ ThreadMessageBuilder {
+ author_id: Some(deleted_user),
+ body: MessageBody::StatusChange {
+ new_status: ProjectStatus::Rejected,
+ old_status: ProjectStatus::Processing,
+ },
+ thread_id,
+ hide_identity: false,
+ }
+ .insert(&mut *transaction)
+ .await
+ .wrap_err(
+ "failed to insert automatic rejection status change",
+ )?;
+
+ sqlx::query!(
+ r#"
+ UPDATE mods
+ SET status = $1
+ WHERE id = $2
+ "#,
+ ProjectStatus::Rejected.as_str(),
+ project.id,
+ )
+ .execute(&mut *transaction)
+ .await
+ .wrap_err(
+ "failed to reject processing project owned by deleted user",
+ )?;
+ }
+
+ models::DBProject::clear_cache(
+ DBProjectId(project.id),
+ project.slug.clone(),
+ None,
+ redis,
+ )
+ .await
+ .wrap_err("failed to clear project cache")?;
+ }
sqlx::query!(
"
@@ -626,7 +738,6 @@ impl DBUser {
.await
.wrap_err("failed to update versions author_id")?;
- use futures::TryStreamExt;
let notifications: Vec = sqlx::query!(
"
SELECT n.id FROM notifications n
diff --git a/apps/labrinth/src/models/mod.rs b/apps/labrinth/src/models/mod.rs
index c39de80557..e21616f12b 100644
--- a/apps/labrinth/src/models/mod.rs
+++ b/apps/labrinth/src/models/mod.rs
@@ -6,6 +6,7 @@ pub mod v3;
pub use v3::analytics;
pub use v3::billing;
pub use v3::collections;
+pub use v3::disclosures;
pub use v3::ids;
pub use v3::images;
pub use v3::moderation_notes;
diff --git a/apps/labrinth/src/models/v2/projects.rs b/apps/labrinth/src/models/v2/projects.rs
index 4afd9dc877..c4501b7a8e 100644
--- a/apps/labrinth/src/models/v2/projects.rs
+++ b/apps/labrinth/src/models/v2/projects.rs
@@ -3,7 +3,10 @@ use std::convert::TryFrom;
use std::collections::HashMap;
use super::super::ids::OrganizationId;
-use crate::database::models::{DatabaseError, version_item};
+use crate::database::models::{
+ DBProjectDisclosure, DBProjectId, DatabaseError, version_item,
+};
+use crate::models::disclosures::ProjectDisclosureType;
use crate::models::ids::{ProjectId, TeamId, ThreadId, VersionId};
use crate::models::projects::{
Dependency, License, Link, Loader, ModeratorMessage, MonetizationStatus,
@@ -238,28 +241,42 @@ impl LegacyProject {
}
// Because from needs a version_item, this is a helper function to get many from one db query.
- pub async fn from_many<'a, E>(
+ pub async fn from_many(
data: Vec,
- exec: E,
+ pool: &crate::database::PgPool,
redis: &RedisPool,
- ) -> Result, DatabaseError>
- where
- E: crate::database::Acquire<'a, Database = sqlx::Postgres>,
- {
+ ) -> Result, DatabaseError> {
let version_ids: Vec<_> = data
.iter()
.filter_map(|p| p.versions.first().map(|i| (*i).into()))
.collect();
+ let project_ids: Vec =
+ data.iter().map(|p| p.id.into()).collect();
+
let example_versions =
- version_item::DBVersion::get_many(&version_ids, exec, redis)
+ version_item::DBVersion::get_many(&version_ids, pool, redis)
.await?;
+ let archived_disclosure_ids = DBProjectDisclosure::projects_with_type(
+ ProjectDisclosureType::Archived,
+ &project_ids,
+ pool,
+ )
+ .await?;
+
let mut legacy_projects = Vec::new();
for project in data {
let version_item = example_versions
.iter()
.find(|v| v.inner.project_id == project.id.into())
.cloned();
- let project = LegacyProject::from(project, version_item);
+ let has_archived_disclosure =
+ archived_disclosure_ids.contains(&project.id.into());
+ let mut project = LegacyProject::from(project, version_item);
+ if has_archived_disclosure
+ && project.status == ProjectStatus::Approved
+ {
+ project.status = ProjectStatus::Archived;
+ }
legacy_projects.push(project);
}
Ok(legacy_projects)
diff --git a/apps/labrinth/src/models/v3/disclosures.rs b/apps/labrinth/src/models/v3/disclosures.rs
new file mode 100644
index 0000000000..52f6c06187
--- /dev/null
+++ b/apps/labrinth/src/models/v3/disclosures.rs
@@ -0,0 +1,177 @@
+use crate::database::models::DBProjectDisclosure;
+use ariadne::ids::UserId;
+use chrono::{DateTime, Utc};
+use serde::{Deserialize, Serialize};
+use std::collections::BTreeSet;
+use strum::{EnumDiscriminants, EnumString, IntoStaticStr};
+use utoipa::ToSchema;
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema, EnumDiscriminants)]
+#[serde(rename_all = "snake_case", tag = "type")]
+#[strum_discriminants(
+ name(ProjectDisclosureType),
+ derive(IntoStaticStr, EnumString),
+ strum(serialize_all = "snake_case")
+)]
+pub enum ProjectDisclosure {
+ AiContent {
+ note: Option,
+ uses: BTreeSet,
+ },
+ Advertisements {
+ note: Option,
+ },
+ EpilepsyTriggers {
+ note: Option,
+ },
+ SystemInteractions {
+ note: Option,
+ interactions: Vec,
+ },
+ Telemetry {
+ consent: TelemetryConsent,
+ data_collected: Vec,
+ },
+ DerivativeWork {
+ sources: Vec,
+ },
+ PaidFeatures {
+ features: Vec,
+ },
+ Archived {
+ note: Option,
+ },
+}
+
+impl ProjectDisclosure {
+ pub fn to_parts(
+ &self,
+ ) -> Result<(&'static str, serde_json::Value), serde_json::Error> {
+ let serde_json::Value::Object(mut object) = serde_json::to_value(self)?
+ else {
+ return Err(serde::ser::Error::custom(
+ "project disclosure must serialize to a JSON object",
+ ));
+ };
+ object.remove("type");
+ Ok((
+ ProjectDisclosureType::from(self).into(),
+ serde_json::Value::Object(object),
+ ))
+ }
+
+ pub fn from_parts(
+ kind: &str,
+ metadata: serde_json::Value,
+ ) -> Result {
+ let serde_json::Value::Object(mut object) = metadata else {
+ return Err(serde::de::Error::custom(
+ "project disclosure metadata must be a JSON object",
+ ));
+ };
+ object.insert(
+ "type".to_owned(),
+ serde_json::Value::String(kind.to_owned()),
+ );
+ serde_json::from_value(serde_json::Value::Object(object))
+ }
+}
+
+#[derive(
+ Debug,
+ Clone,
+ Copy,
+ Default,
+ Serialize,
+ Deserialize,
+ ToSchema,
+ IntoStaticStr,
+ EnumString,
+)]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum DisclosureLockStatus {
+ #[default]
+ Unlocked,
+ CannotDisable,
+ FullyLocked,
+}
+
+impl DisclosureLockStatus {
+ pub fn allows_edit(self) -> bool {
+ !matches!(self, Self::FullyLocked)
+ }
+
+ pub fn allows_removal(self) -> bool {
+ matches!(self, Self::Unlocked)
+ }
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+pub struct ProjectDisclosureData {
+ #[serde(flatten)]
+ pub disclosure: ProjectDisclosure,
+ pub set_by_moderator: bool,
+ pub lock_status: DisclosureLockStatus,
+ pub updated_at: DateTime,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub updated_by: Option,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub deleted_at: Option>,
+}
+
+impl ProjectDisclosureData {
+ pub fn from_db(
+ value: DBProjectDisclosure,
+ viewer_is_moderator: bool,
+ ) -> Self {
+ let updated_by = (!value.set_by_moderator || viewer_is_moderator)
+ .then_some(value.updated_by.into());
+
+ Self {
+ disclosure: value.disclosure,
+ set_by_moderator: value.set_by_moderator,
+ lock_status: value.lock_status,
+ updated_at: value.updated_at,
+ updated_by,
+ deleted_at: value.deleted_at,
+ }
+ }
+}
+
+#[derive(
+ Debug,
+ Clone,
+ Serialize,
+ Deserialize,
+ ToSchema,
+ IntoStaticStr,
+ PartialEq,
+ Eq,
+ PartialOrd,
+ Ord,
+)]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum AiUsages {
+ Code,
+ Assets,
+ Text,
+ Functionality,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema, IntoStaticStr)]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum TelemetryConsent {
+ OptIn,
+ OptOut,
+ AlwaysActive,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+pub struct DerivativeSource {
+ pub link: Option,
+ pub label: String,
+ pub note: Option,
+}
diff --git a/apps/labrinth/src/models/v3/mod.rs b/apps/labrinth/src/models/v3/mod.rs
index 8925b7caec..777de99443 100644
--- a/apps/labrinth/src/models/v3/mod.rs
+++ b/apps/labrinth/src/models/v3/mod.rs
@@ -3,6 +3,7 @@ pub mod analytics;
pub mod analytics_event;
pub mod billing;
pub mod collections;
+pub mod disclosures;
pub mod ids;
pub mod images;
pub mod moderation_notes;
diff --git a/apps/labrinth/src/models/v3/projects.rs b/apps/labrinth/src/models/v3/projects.rs
index c2479a88fc..03e05e51b6 100644
--- a/apps/labrinth/src/models/v3/projects.rs
+++ b/apps/labrinth/src/models/v3/projects.rs
@@ -570,11 +570,13 @@ impl ProjectStatus {
pub fn can_be_requested(&self) -> bool {
match self {
ProjectStatus::Approved => true,
- ProjectStatus::Archived => true,
ProjectStatus::Unlisted => true,
ProjectStatus::Private => true,
ProjectStatus::Draft => true,
+ // `archived` is represented by a disclosure, not a status, so it
+ // can no longer be requested or set as a status.
+ ProjectStatus::Archived => false,
ProjectStatus::Rejected => false,
ProjectStatus::Processing => false,
ProjectStatus::Unknown => false,
diff --git a/apps/labrinth/src/routes/v2/projects.rs b/apps/labrinth/src/routes/v2/projects.rs
index 407d6359b2..1adf08f1c2 100644
--- a/apps/labrinth/src/routes/v2/projects.rs
+++ b/apps/labrinth/src/routes/v2/projects.rs
@@ -1,7 +1,9 @@
+use crate::database::models as db_models;
use crate::database::models::categories::LinkPlatform;
use crate::database::models::{project_item, version_item};
use crate::database::{PgPool, ReadOnlyPgPool};
use crate::file_hosting::FileHost;
+use crate::models::disclosures::ProjectDisclosureType;
use crate::models::projects::{
Link, MonetizationStatus, Project, ProjectStatus, Version,
};
@@ -206,7 +208,7 @@ pub async fn random_projects_get(
match v2_reroute::extract_ok_json::>(response).await {
Ok(project) => {
let legacy_projects =
- LegacyProject::from_many(project, &**pool, &redis)
+ LegacyProject::from_many(project, &pool, &redis)
.await
.wrap_internal_err(
"executing `LegacyProject::from_many`",
@@ -252,7 +254,7 @@ pub async fn projects_get(
match v2_reroute::extract_ok_json::>(response).await {
Ok(project) => {
let legacy_projects =
- LegacyProject::from_many(project, &**pool, &redis)
+ LegacyProject::from_many(project, &pool, &redis)
.await
.wrap_internal_err(
"executing `LegacyProject::from_many`",
@@ -315,7 +317,19 @@ pub async fn project_get(
}
None => None,
};
- let project = LegacyProject::from(project, version_item);
+ let has_archived_disclosure =
+ db_models::DBProjectDisclosure::projects_with_type(
+ ProjectDisclosureType::Archived,
+ &[project.id.into()],
+ &**pool,
+ )
+ .await
+ .wrap_internal_err("fetching archival disclosure status")?
+ .contains(&project.id.into());
+ let mut project = LegacyProject::from(project, version_item);
+ if has_archived_disclosure && project.status == ProjectStatus::Approved {
+ project.status = ProjectStatus::Archived;
+ }
Ok(HttpResponse::Ok().json(project))
}
@@ -402,7 +416,7 @@ pub async fn dependency_list(
Ok(dependency_info) => {
let converted_projects = LegacyProject::from_many(
dependency_info.projects,
- &**pool,
+ &pool,
&redis,
)
.await
@@ -671,6 +685,7 @@ pub async fn project_edit(
redis.clone(),
session_queue.clone(),
search_state.clone(),
+ true,
)
.await
.or_else(v2_reroute::flatten_404_error)
diff --git a/apps/labrinth/src/routes/v2/users.rs b/apps/labrinth/src/routes/v2/users.rs
index 3c5dae8e8e..860159d638 100644
--- a/apps/labrinth/src/routes/v2/users.rs
+++ b/apps/labrinth/src/routes/v2/users.rs
@@ -193,7 +193,7 @@ pub async fn projects_list(
match v2_reroute::extract_ok_json::>(response).await {
Ok(project) => {
let legacy_projects =
- LegacyProject::from_many(project, &**pool, &redis)
+ LegacyProject::from_many(project, &pool, &redis)
.await
.wrap_internal_err(
"executing `LegacyProject::from_many`",
@@ -465,7 +465,7 @@ pub async fn user_follows(
match v2_reroute::extract_ok_json::>(response).await {
Ok(project) => {
let legacy_projects =
- LegacyProject::from_many(project, &**pool, &redis)
+ LegacyProject::from_many(project, &pool, &redis)
.await
.wrap_internal_err(
"executing `LegacyProject::from_many`",
diff --git a/apps/labrinth/src/routes/v2/version_file.rs b/apps/labrinth/src/routes/v2/version_file.rs
index f1db94c0bf..b9108eb1ef 100644
--- a/apps/labrinth/src/routes/v2/version_file.rs
+++ b/apps/labrinth/src/routes/v2/version_file.rs
@@ -364,7 +364,7 @@ pub async fn get_projects_from_hashes(
.collect::>();
let legacy_projects = LegacyProject::from_many(
projects_hashes.into_values().collect(),
- &**pool,
+ &pool,
&redis,
)
.await
diff --git a/apps/labrinth/src/routes/v3/disclosures.rs b/apps/labrinth/src/routes/v3/disclosures.rs
new file mode 100644
index 0000000000..3c790c703d
--- /dev/null
+++ b/apps/labrinth/src/routes/v3/disclosures.rs
@@ -0,0 +1,292 @@
+use actix_web::{HttpRequest, get, patch, web};
+use chrono::Utc;
+use eyre::eyre;
+use serde::{Deserialize, Serialize};
+use utoipa::ToSchema;
+use xredis::RedisPool;
+
+use crate::auth::checks::{is_team_member_project, is_visible_project};
+use crate::auth::get_user_from_headers;
+use crate::database::{DBProject, models as db_models};
+use crate::database::{PgPool, ReadOnlyPgPool};
+use crate::models::disclosures::{
+ DisclosureLockStatus, ProjectDisclosure, ProjectDisclosureData,
+ ProjectDisclosureType,
+};
+use crate::models::pats::Scopes;
+use crate::models::teams::ProjectPermissions;
+use crate::queue::session::AuthQueue;
+use crate::routes::ApiError;
+use crate::search::SearchState;
+use crate::util::error::Context;
+use std::str::FromStr;
+
+pub fn config(cfg: &mut web::ServiceConfig) {
+ cfg.service(get_project_disclosures)
+ .service(modify_project_disclosures);
+}
+
+#[derive(Serialize, ToSchema)]
+pub struct GetProjectDisclosures {
+ pub disclosures: Vec,
+}
+
+#[utoipa::path(
+ context_path = "/project",
+ tag = "project_disclosures",
+ responses((status = OK, body = GetProjectDisclosures), (status = BAD_REQUEST, description = "Invalid request input"))
+)]
+#[get("/{project_id}/disclosures")]
+pub async fn get_project_disclosures(
+ req: HttpRequest,
+ info: web::Path<(String,)>,
+ pool: web::Data,
+ ro_pool: web::Data,
+ redis: web::Data,
+ session_queue: web::Data,
+) -> Result, ApiError> {
+ let (string,) = info.into_inner();
+
+ let project = db_models::DBProject::get(&string, &***ro_pool, &redis)
+ .await
+ .wrap_internal_err("failed to fetch project")?
+ .wrap_not_found_err("resource not found")?;
+
+ let user_option = get_user_from_headers(
+ &req,
+ &**pool,
+ &redis,
+ &session_queue,
+ Scopes::PROJECT_READ,
+ )
+ .await
+ .map(|(_, user)| user)
+ .ok();
+
+ if !is_visible_project(&project.inner, &user_option, &pool, false)
+ .await
+ .wrap_internal_err("failed to check project visibility")?
+ {
+ return Err(ApiError::NotFound(eyre!("resource not found")));
+ }
+
+ let viewer_is_moderator =
+ user_option.as_ref().is_some_and(|user| user.role.is_mod());
+
+ let include_deleted = viewer_is_moderator
+ || is_team_member_project(&project.inner, &user_option, &pool)
+ .await
+ .wrap_internal_err("failed to check project team membership")?;
+
+ let disclosures = db_models::DBProjectDisclosure::get_many_for_project(
+ project.inner.id,
+ include_deleted,
+ &***ro_pool,
+ )
+ .await
+ .wrap_internal_err("failed to fetch project disclosures")?;
+
+ Ok(web::Json(GetProjectDisclosures {
+ disclosures: disclosures
+ .into_iter()
+ .map(|disclosure| {
+ ProjectDisclosureData::from_db(disclosure, viewer_is_moderator)
+ })
+ .collect(),
+ }))
+}
+
+#[derive(Deserialize, ToSchema)]
+pub struct ModifyProjectDisclosures {
+ pub set: Vec,
+ pub remove: Vec,
+ #[serde(default)]
+ pub lock_status: Option,
+}
+
+#[utoipa::path(
+ context_path = "/project",
+ tag = "project_disclosures",
+ request_body = ModifyProjectDisclosures,
+ responses((status = NO_CONTENT))
+)]
+#[patch("/{project_id}/disclosures")]
+pub async fn modify_project_disclosures(
+ req: HttpRequest,
+ info: web::Path<(String,)>,
+ pool: web::Data,
+ redis: web::Data,
+ search_state: web::Data,
+ session_queue: web::Data,
+ body: web::Json,
+) -> Result<(), ApiError> {
+ let (string,) = info.into_inner();
+ let body = body.into_inner();
+
+ if body.set.is_empty() && body.remove.is_empty() {
+ return Err(ApiError::Request(eyre!(
+ "must provide at least one disclosure to set or remove"
+ )));
+ }
+
+ let user = get_user_from_headers(
+ &req,
+ &**pool,
+ &redis,
+ &session_queue,
+ Scopes::PROJECT_WRITE,
+ )
+ .await
+ .wrap_auth_err("authenticating API request")?
+ .1;
+
+ let project = db_models::DBProject::get(&string, &**pool, &redis)
+ .await
+ .wrap_internal_err("failed to fetch project")?
+ .wrap_not_found_err("resource not found")?;
+
+ let (team_member, organization_team_member) =
+ db_models::DBTeamMember::get_for_project_permissions(
+ &project.inner,
+ user.id.into(),
+ &**pool,
+ )
+ .await
+ .wrap_internal_err("failed to fetch project permissions")?;
+
+ let can_edit_details = ProjectPermissions::get_permissions_by_role(
+ &user.role,
+ &team_member,
+ &organization_team_member,
+ )
+ .is_some_and(|perms| perms.contains(ProjectPermissions::EDIT_DETAILS));
+
+ if !can_edit_details {
+ return Err(ApiError::Auth(eyre!(
+ "you do not have permission to edit this project's disclosures"
+ )));
+ }
+
+ let is_moderator = user.role.is_mod();
+ let is_project_member =
+ team_member.is_some() || organization_team_member.is_some();
+
+ if body.lock_status.is_some() && !is_moderator {
+ return Err(ApiError::Auth(eyre!(
+ "only moderators can set the lock status of a disclosure"
+ )));
+ }
+
+ let modified_types = body
+ .set
+ .iter()
+ .map(|disclosure| {
+ <&'static str>::from(ProjectDisclosureType::from(disclosure))
+ .to_owned()
+ })
+ .chain(body.remove.iter().cloned())
+ .collect::>();
+
+ let lock_statuses =
+ db_models::DBProjectDisclosure::get_lock_statuses_for_project(
+ project.inner.id,
+ &modified_types,
+ &**pool,
+ )
+ .await
+ .wrap_internal_err("failed to fetch disclosure lock statuses")?;
+
+ let lock_status_of = |disclosure_type: &str| {
+ lock_statuses
+ .get(disclosure_type)
+ .copied()
+ .unwrap_or_default()
+ };
+
+ if !is_moderator {
+ for disclosure in &body.set {
+ let disclosure_type =
+ <&'static str>::from(ProjectDisclosureType::from(disclosure));
+ if !lock_status_of(disclosure_type).allows_edit() {
+ return Err(ApiError::Auth(eyre!(
+ "you cannot modify the `{disclosure_type}` disclosure, it is locked by a moderator"
+ )));
+ }
+ }
+
+ for disclosure_type in &body.remove {
+ if !lock_status_of(disclosure_type).allows_removal() {
+ return Err(ApiError::Auth(eyre!(
+ "you cannot remove the `{disclosure_type}` disclosure, it is locked by a moderator"
+ )));
+ }
+ }
+ }
+
+ let mut transaction = pool
+ .begin()
+ .await
+ .wrap_internal_err("starting database transaction")?;
+
+ for disclosure in body.set {
+ let disclosure_type =
+ <&'static str>::from(ProjectDisclosureType::from(&disclosure));
+
+ let lock_status =
+ body.lock_status.unwrap_or(lock_status_of(disclosure_type));
+
+ let set_by_moderator =
+ is_moderator && (!is_project_member || !lock_status.allows_edit());
+
+ db_models::DBProjectDisclosure {
+ project_id: project.inner.id,
+ disclosure,
+ updated_at: Utc::now(),
+ updated_by: user.id.into(),
+ set_by_moderator,
+ deleted_at: None,
+ lock_status,
+ }
+ .upsert(&mut transaction)
+ .await
+ .wrap_internal_err("failed to upsert project disclosure")?;
+ }
+
+ for disclosure_type in &body.remove {
+ let set_by_moderator = is_moderator
+ && (!is_project_member
+ || !lock_status_of(disclosure_type).allows_removal());
+
+ let disclosure_type = ProjectDisclosureType::from_str(disclosure_type)
+ .map_err(|_| {
+ ApiError::Request(eyre!(
+ "unknown disclosure type `{disclosure_type}`"
+ ))
+ })?;
+ db_models::DBProjectDisclosure::remove(
+ project.inner.id,
+ disclosure_type,
+ user.id.into(),
+ set_by_moderator,
+ &mut transaction,
+ )
+ .await
+ .wrap_internal_err("failed to remove project disclosure")?;
+ }
+
+ transaction
+ .commit()
+ .await
+ .wrap_internal_err("failed to commit project disclosure changes")?;
+
+ DBProject::clear_cache(project.inner.id, project.inner.slug, None, &redis)
+ .await
+ .wrap_internal_err("clearing cached data from Redis")?;
+
+ search_state
+ .queue
+ .push_project_change(project.inner.id.into())
+ .await;
+
+ Ok(())
+}
diff --git a/apps/labrinth/src/routes/v3/mod.rs b/apps/labrinth/src/routes/v3/mod.rs
index 735daff22f..fd2e087039 100644
--- a/apps/labrinth/src/routes/v3/mod.rs
+++ b/apps/labrinth/src/routes/v3/mod.rs
@@ -9,6 +9,7 @@ pub mod analytics_get;
pub mod blocked_users;
pub mod collections;
pub mod content;
+pub mod disclosures;
pub mod friends;
pub mod images;
pub mod limits;
@@ -38,13 +39,16 @@ pub fn config(cfg: &mut web::ServiceConfig) {
cfg.service(
web::scope("/v3/payout")
.wrap(default_cors())
- .configure(payouts::config),
+ .configure(payouts::config)
+ .service(payouts::paypal_webhook)
+ .service(payouts::tremendous_webhook),
);
cfg.service(
web::scope("/v3/project")
.wrap(default_cors())
.configure(projects::project_config)
- .configure(project_creation::config),
+ .configure(project_creation::config)
+ .configure(disclosures::config),
);
cfg.service(
web::scope("/v3")
@@ -56,8 +60,6 @@ pub fn config(cfg: &mut web::ServiceConfig) {
.configure(notifications::config)
.configure(oauth_clients::config)
.configure(organizations::config)
- .service(payouts::paypal_webhook)
- .service(payouts::tremendous_webhook)
.configure(projects::config)
.configure(reports::config)
.configure(statistics::config)
@@ -111,6 +113,8 @@ pub fn config(cfg: &mut web::ServiceConfig) {
projects::project_unfollow,
projects::project_get_organization,
projects::dependency_list,
+ disclosures::get_project_disclosures,
+ disclosures::modify_project_disclosures,
project_creation::project_create,
project_creation::project_create_with_id,
project_creation::new::create,
diff --git a/apps/labrinth/src/routes/v3/projects.rs b/apps/labrinth/src/routes/v3/projects.rs
index 82762e5c3b..682ba8e37c 100644
--- a/apps/labrinth/src/routes/v3/projects.rs
+++ b/apps/labrinth/src/routes/v3/projects.rs
@@ -15,6 +15,9 @@ use crate::database::{self, models as db_models};
use crate::database::{PgPool, PgTransaction, ReadOnlyPgPool};
use crate::env::ENV;
use crate::file_hosting::{FileHost, FileHostPublicity};
+use crate::models::disclosures::{
+ DisclosureLockStatus, ProjectDisclosure, ProjectDisclosureType,
+};
use crate::models::ids::{ProjectId, VersionId};
use crate::models::images::ImageContext;
use crate::models::notifications::NotificationBody;
@@ -22,8 +25,9 @@ use crate::models::pats::Scopes;
use crate::models::projects::{
MonetizationStatus, Project, ProjectStatus, SideTypesMigrationReviewStatus,
};
-use crate::models::teams::ProjectPermissions;
+use crate::models::teams::{DEFAULT_ROLE, ProjectPermissions};
use crate::models::threads::MessageBody;
+use crate::models::users::DELETED_USER;
use crate::models::{self, exp};
use crate::queue::session::AuthQueue;
use crate::routes::ApiError;
@@ -40,6 +44,7 @@ use chrono::Utc;
use eyre::eyre;
use futures::TryStreamExt;
use itertools::Itertools;
+use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};
use validator::Validate;
use xredis::RedisPool;
@@ -216,7 +221,7 @@ pub async fn projects_get(
Ok(HttpResponse::Ok().json(projects))
}
-/// Get a project.
+/// Get a project.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = OK, body = Project))
@@ -351,7 +356,7 @@ pub struct EditProject {
}
#[allow(clippy::too_many_arguments)]
-/// Update a project.
+/// Update a project.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = NO_CONTENT))
@@ -374,6 +379,7 @@ pub async fn project_edit(
redis,
session_queue,
search_state,
+ false,
)
.await
}
@@ -386,6 +392,7 @@ pub async fn project_edit_internal(
redis: web::Data,
session_queue: web::Data,
search_state: web::Data,
+ sync_archival_disclosure: bool,
) -> Result {
let user = get_user_from_headers(
&req,
@@ -486,105 +493,142 @@ pub async fn project_edit_internal(
)));
}
- if !(user.role.is_mod()
- || !project_item.inner.status.is_approved()
- && status == &ProjectStatus::Processing
- || project_item.inner.status.is_approved()
- && status.can_be_requested())
- {
- return Err(ApiError::Auth(eyre::eyre!(
- "You don't have permission to set this status!",
- )));
- }
+ let archival_disclosure =
+ db_models::DBProjectDisclosure::get_many_for_project(
+ project_item.inner.id,
+ false,
+ &mut transaction,
+ )
+ .await
+ .wrap_internal_err("failed to fetch project disclosures")?
+ .into_iter()
+ .find(|disclosure| {
+ matches!(
+ disclosure.disclosure,
+ ProjectDisclosure::Archived { .. }
+ )
+ });
+ let has_archived_disclosure = archival_disclosure.is_some();
- // If a moderator (non-admin) is completing a review while another moderator holds an
- // active checklist lock, block them from changing the project status.
- if user.role.is_mod()
- && !user.role.is_admin()
- && project_item.inner.status == ProjectStatus::Processing
- && status != &ProjectStatus::Processing
- && let Some(lock) =
- DBModerationLock::get_with_user(project_item.inner.id, &pool)
- .await
- .wrap_internal_err(
- "fetching moderation lock from database",
- )?
- && lock.moderator_id != db_ids::DBUserId::from(user.id)
- && !lock.expired
- {
- return Err(ApiError::Auth(eyre::eyre!(format!(
- "This project is currently being moderated by @{}. Please wait for them to finish or for the lock to expire.",
- lock.moderator_username
- ))));
- }
+ if status == &ProjectStatus::Archived {
+ if !has_archived_disclosure {
+ db_models::DBProjectDisclosure {
+ project_id: project_item.inner.id,
+ disclosure: ProjectDisclosure::Archived { note: None },
+ updated_at: Utc::now(),
+ updated_by: user.id.into(),
+ set_by_moderator: user.role.is_mod(),
+ deleted_at: None,
+ lock_status: DisclosureLockStatus::Unlocked,
+ }
+ .upsert(&mut transaction)
+ .await
+ .wrap_internal_err("failed to upsert archival disclosure")?;
+ }
+ } else {
+ if !(user.role.is_mod()
+ || !project_item.inner.status.is_approved()
+ && status == &ProjectStatus::Processing
+ || project_item.inner.status.is_approved()
+ && status.can_be_requested())
+ {
+ return Err(ApiError::Auth(eyre::eyre!(
+ "You don't have permission to set this status!",
+ )));
+ }
- if status == &ProjectStatus::Processing {
- if project_item.versions.is_empty() {
- return Err(ApiError::Request(eyre::eyre!(String::from(
- "Project submitted for review with no initial versions",
+ // If a moderator (non-admin) is completing a review while another moderator holds an
+ // active checklist lock, block them from changing the project status.
+ if user.role.is_mod()
+ && !user.role.is_admin()
+ && project_item.inner.status == ProjectStatus::Processing
+ && status != &ProjectStatus::Processing
+ && let Some(lock) = DBModerationLock::get_with_user(
+ project_item.inner.id,
+ &pool,
+ )
+ .await
+ .wrap_internal_err("fetching moderation lock from database")?
+ && lock.moderator_id != db_ids::DBUserId::from(user.id)
+ && !lock.expired
+ {
+ return Err(ApiError::Auth(eyre::eyre!(format!(
+ "This project is currently being moderated by @{}. Please wait for them to finish or for the lock to expire.",
+ lock.moderator_username
))));
}
- sqlx::query!(
- "
- UPDATE mods
- SET moderation_message = NULL, moderation_message_body = NULL, queued = NOW()
- WHERE (id = $1)
- ",
- id as db_ids::DBProjectId,
- )
- .execute(&mut transaction)
- .await.wrap_internal_err("querying database for `project_edit_internal`")?;
- }
+ if status == &ProjectStatus::Processing {
+ if project_item.versions.is_empty() {
+ return Err(ApiError::Request(eyre::eyre!(String::from(
+ "Project submitted for review with no initial versions",
+ ))));
+ }
- if status.is_approved() && !project_item.inner.status.is_approved() {
- sqlx::query!(
- "
- UPDATE mods
- SET approved = NOW()
- WHERE id = $1 AND approved IS NULL
- ",
- id as db_ids::DBProjectId,
- )
- .execute(&mut transaction)
- .await
- .wrap_internal_err(
- "querying database for `project_edit_internal`",
- )?;
- }
+ sqlx::query!(
+ "
+ UPDATE mods
+ SET moderation_message = NULL, moderation_message_body = NULL, queued = NOW()
+ WHERE (id = $1)
+ ",
+ id as db_ids::DBProjectId,
+ )
+ .execute(&mut transaction)
+ .await
+ .wrap_internal_err(
+ "querying database for `project_edit_internal`",
+ )?;
+ }
- if status.is_searchable()
- && !project_item.inner.webhook_sent
- && !ENV.PUBLIC_DISCORD_WEBHOOK.is_empty()
- && project_item.inner.components.minecraft_server.is_none()
- {
- crate::util::webhook::send_discord_webhook(
- project_item.inner.id.into(),
- &pool,
- &redis,
- &ENV.PUBLIC_DISCORD_WEBHOOK,
- None,
- )
- .await
- .ok();
+ if status.is_approved() && !project_item.inner.status.is_approved()
+ {
+ sqlx::query!(
+ "
+ UPDATE mods
+ SET approved = NOW()
+ WHERE id = $1 AND approved IS NULL
+ ",
+ id as db_ids::DBProjectId,
+ )
+ .execute(&mut transaction)
+ .await
+ .wrap_internal_err(
+ "querying database for `project_edit_internal`",
+ )?;
+ }
- sqlx::query!(
- "
+ if status.is_searchable()
+ && !project_item.inner.webhook_sent
+ && !ENV.PUBLIC_DISCORD_WEBHOOK.is_empty()
+ && project_item.inner.components.minecraft_server.is_none()
+ {
+ crate::util::webhook::send_discord_webhook(
+ project_item.inner.id.into(),
+ &pool,
+ &redis,
+ &ENV.PUBLIC_DISCORD_WEBHOOK,
+ None,
+ )
+ .await
+ .ok();
+
+ sqlx::query!(
+ "
UPDATE mods
SET webhook_sent = TRUE
WHERE id = $1
",
- id as db_ids::DBProjectId,
- )
- .execute(&mut transaction)
- .await
- .wrap_internal_err(
- "querying database for `project_edit_internal`",
- )?;
- }
+ id as db_ids::DBProjectId,
+ )
+ .execute(&mut transaction)
+ .await
+ .wrap_internal_err(
+ "querying database for `project_edit_internal`",
+ )?;
+ }
- if user.role.is_mod() && !ENV.MODERATION_SLACK_WEBHOOK.is_empty() {
- crate::util::webhook::send_slack_project_webhook(
+ if user.role.is_mod() && !ENV.MODERATION_SLACK_WEBHOOK.is_empty() {
+ crate::util::webhook::send_slack_project_webhook(
project_item.inner.id.into(),
&pool,
&redis,
@@ -603,83 +647,103 @@ pub async fn project_edit_internal(
)
.await
.ok();
- }
-
- if team_member.is_none_or(|x| !x.accepted) {
- let notified_members = sqlx::query!(
- "
- SELECT tm.user_id id
- FROM team_members tm
- WHERE tm.team_id = $1 AND tm.accepted
- ",
- project_item.inner.team_id as db_ids::DBTeamId
- )
- .fetch(&mut transaction)
- .map_ok(|c| db_models::DBUserId(c.id))
- .try_collect::>()
- .await
- .wrap_internal_err("fetching notified members from database")?;
-
- NotificationBuilder {
- body: NotificationBody::StatusChange {
- project_id: project_item.inner.id.into(),
- old_status: project_item.inner.status,
- new_status: *status,
- },
}
- .insert_many(notified_members.clone(), &mut transaction, &redis)
- .await
- .wrap_internal_err(
- "inserting database records for `project_edit_internal`",
- )?;
- NotificationBuilder {
- body: if status.is_approved() {
- NotificationBody::ProjectStatusApproved {
- project_id: project_item.inner.id.into(),
- }
- } else {
- NotificationBody::ProjectStatusNeutral {
+ if team_member.is_none_or(|x| !x.accepted) {
+ let notified_members = sqlx::query!(
+ "
+ SELECT tm.user_id id
+ FROM team_members tm
+ WHERE tm.team_id = $1 AND tm.accepted
+ ",
+ project_item.inner.team_id as db_ids::DBTeamId
+ )
+ .fetch(&mut transaction)
+ .map_ok(|c| db_models::DBUserId(c.id))
+ .try_collect::>()
+ .await
+ .wrap_internal_err("fetching notified members from database")?;
+
+ NotificationBuilder {
+ body: NotificationBody::StatusChange {
project_id: project_item.inner.id.into(),
old_status: project_item.inner.status,
new_status: *status,
- }
- },
+ },
+ }
+ .insert_many(notified_members.clone(), &mut transaction, &redis)
+ .await
+ .wrap_internal_err(
+ "inserting database records for `project_edit_internal`",
+ )?;
+
+ NotificationBuilder {
+ body: if status.is_approved() {
+ NotificationBody::ProjectStatusApproved {
+ project_id: project_item.inner.id.into(),
+ }
+ } else {
+ NotificationBody::ProjectStatusNeutral {
+ project_id: project_item.inner.id.into(),
+ old_status: project_item.inner.status,
+ new_status: *status,
+ }
+ },
+ }
+ .insert_many(notified_members, &mut transaction, &redis)
+ .await
+ .wrap_internal_err(
+ "inserting database records for `project_edit_internal`",
+ )?;
}
- .insert_many(notified_members, &mut transaction, &redis)
+
+ ThreadMessageBuilder {
+ author_id: Some(user.id.into()),
+ body: MessageBody::StatusChange {
+ new_status: *status,
+ old_status: project_item.inner.status,
+ },
+ thread_id: project_item.thread_id,
+ hide_identity: user.role.is_mod(),
+ }
+ .insert(&mut transaction)
.await
.wrap_internal_err(
"inserting database records for `project_edit_internal`",
)?;
- }
- ThreadMessageBuilder {
- author_id: Some(user.id.into()),
- body: MessageBody::StatusChange {
- new_status: *status,
- old_status: project_item.inner.status,
- },
- thread_id: project_item.thread_id,
- hide_identity: user.role.is_mod(),
- }
- .insert(&mut transaction)
- .await
- .wrap_internal_err(
- "inserting database records for `project_edit_internal`",
- )?;
+ sqlx::query!(
+ "
+ UPDATE mods
+ SET status = $1
+ WHERE (id = $2)
+ ",
+ status.as_str(),
+ id as db_ids::DBProjectId,
+ )
+ .execute(&mut transaction)
+ .await
+ .wrap_internal_err(
+ "querying database for `project_edit_internal`",
+ )?;
- sqlx::query!(
- "
- UPDATE mods
- SET status = $1
- WHERE (id = $2)
- ",
- status.as_str(),
- id as db_ids::DBProjectId,
- )
- .execute(&mut transaction)
- .await
- .wrap_internal_err("querying database for `project_edit_internal`")?;
+ if sync_archival_disclosure
+ && archival_disclosure.is_some_and(|disclosure| {
+ user.role.is_mod()
+ || disclosure.lock_status.allows_removal()
+ })
+ {
+ db_models::DBProjectDisclosure::remove(
+ project_item.inner.id,
+ ProjectDisclosureType::Archived,
+ user.id.into(),
+ user.role.is_mod(),
+ &mut transaction,
+ )
+ .await
+ .wrap_internal_err("failed to remove archival disclosure")?;
+ }
+ }
}
if let Some(requested_status) = &new_project.requested_status {
@@ -1313,7 +1377,7 @@ pub async fn edit_project_categories(
// pub total_hits: usize,
// }
-/// Search projects.
+/// Search projects.
#[utoipa::path(
tag = "search",
get,
@@ -1360,7 +1424,7 @@ pub async fn project_search(
}
// for more complicated search queries
-/// Search projects.
+/// Search projects.
#[utoipa::path(
tag = "search",
request_body = serde_json::Value,
@@ -1380,7 +1444,7 @@ pub async fn project_search_post(
}
//checks the validity of a project id or slug
-/// Check project availability.
+/// Check project availability.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = OK, body = ProjectCheckResponse))
@@ -1420,7 +1484,7 @@ pub struct DependencyInfo {
pub versions: Vec,
}
-/// List project dependencies.
+/// List project dependencies.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = OK, body = DependencyInfo))
@@ -1944,7 +2008,7 @@ pub struct Extension {
}
#[allow(clippy::too_many_arguments)]
-/// Update a project icon.
+/// Update a project icon.
#[utoipa::path(
context_path = "/project",
tag = "projects",
@@ -2108,7 +2172,7 @@ pub async fn project_icon_edit_internal(
Ok(HttpResponse::NoContent().body(""))
}
-/// Delete a project icon.
+/// Delete a project icon.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = NO_CONTENT))
@@ -2249,7 +2313,7 @@ pub struct GalleryCreateQuery {
}
#[allow(clippy::too_many_arguments)]
-/// Add a gallery item.
+/// Add a gallery item.
#[utoipa::path(
context_path = "/project",
tag = "projects",
@@ -2472,7 +2536,7 @@ pub struct GalleryEditQuery {
pub ordering: Option,
}
-/// Update a gallery item.
+/// Update a gallery item.
#[utoipa::path(
context_path = "/project",
tag = "projects",
@@ -2694,7 +2758,7 @@ pub struct GalleryDeleteQuery {
pub url: String,
}
-/// Delete a gallery item.
+/// Delete a gallery item.
#[utoipa::path(
context_path = "/project",
tag = "projects",
@@ -2849,7 +2913,7 @@ pub async fn delete_gallery_item_internal(
Ok(HttpResponse::NoContent().body(""))
}
-/// Delete a project.
+/// Delete a project.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = NO_CONTENT))
@@ -2940,9 +3004,169 @@ pub async fn project_delete_internal(
&mut transaction,
)
.await
- .wrap_api_err(
- "executing `tech_review_sync::sync_deleted_project_tech_review_exit`",
- )?;
+ .wrap_internal_err("removing project from technical review queue")?;
+
+ // rejected & withheld projects are transferred to ghost so moderation data is preserved
+ if matches!(
+ project.inner.status,
+ ProjectStatus::Rejected | ProjectStatus::Withheld
+ ) {
+ let deleted_user: db_ids::DBUserId = DELETED_USER.into();
+
+ let deleted_slug = if let Some(slug) = &project.inner.slug {
+ let candidate = format!(
+ "{slug}--deleted-{}",
+ ProjectId::from(project.inner.id)
+ );
+ if candidate.len() <= 255 {
+ let taken = sqlx::query!(
+ r#"
+ SELECT EXISTS(
+ SELECT 1 FROM mods
+ WHERE
+ (slug = LOWER($1) OR text_id_lower = LOWER($1))
+ AND id != $2
+ ) AS "exists!"
+ "#,
+ candidate,
+ project.inner.id as db_ids::DBProjectId,
+ )
+ .fetch_one(&mut transaction)
+ .await
+ .wrap_internal_err("checking deleted slug availability")?
+ .exists;
+
+ if !taken {
+ Some(candidate.to_lowercase())
+ } else {
+ None
+ }
+ } else {
+ None
+ }
+ } else {
+ None
+ };
+
+ sqlx::query!(
+ "
+ UPDATE mods
+ SET organization_id = NULL, slug = COALESCE($1, slug)
+ WHERE id = $2
+ ",
+ deleted_slug,
+ project.inner.id as db_ids::DBProjectId,
+ )
+ .execute(&mut transaction)
+ .await
+ .wrap_internal_err(
+ "failed to detach project from organization and update slug",
+ )?;
+
+ let affected_user_ids = sqlx::query!(
+ "
+ DELETE FROM team_members
+ WHERE team_id = $1
+ RETURNING user_id
+ ",
+ project.inner.team_id as db_ids::DBTeamId,
+ )
+ .fetch(&mut transaction)
+ .map_ok(|x| db_ids::DBUserId(x.user_id))
+ .try_collect::>()
+ .await
+ .wrap_internal_err("failed to remove project team members")?;
+
+ let new_member_id = db_ids::generate_team_member_id(&mut transaction)
+ .await
+ .wrap_internal_err("failed to generate team member ID")?;
+ DBTeamMember {
+ id: new_member_id,
+ team_id: project.inner.team_id,
+ user_id: deleted_user,
+ role: DEFAULT_ROLE.to_owned(),
+ is_owner: true,
+ permissions: ProjectPermissions::all(),
+ organization_permissions: None,
+ accepted: true,
+ payouts_split: Decimal::ZERO,
+ ordering: 0,
+ }
+ .insert(&mut transaction)
+ .await
+ .wrap_internal_err("failed to transfer project ownership to ghost")?;
+
+ ThreadMessageBuilder {
+ author_id: Some(deleted_user),
+ body: MessageBody::Text {
+ body: format!(
+ "Project transferred to Ghost when user account `{}` (`{}`) deleted this project",
+ user.username,
+ user.id
+ ),
+ private: true,
+ replying_to: None,
+ associated_images: Vec::new(),
+ },
+ thread_id: project.thread_id,
+ hide_identity: false,
+ }
+ .insert(&mut transaction)
+ .await
+ .wrap_internal_err(
+ "failed to insert project transfer thread message",
+ )?;
+
+ sqlx::query!(
+ "
+ DELETE FROM collections_mods
+ WHERE mod_id = $1
+ ",
+ project.inner.id as db_ids::DBProjectId,
+ )
+ .execute(&mut transaction)
+ .await
+ .wrap_internal_err("failed to delete project from collections_mods")?;
+
+ sqlx::query!(
+ "
+ DELETE FROM mod_follows
+ WHERE mod_id = $1
+ ",
+ project.inner.id as db_ids::DBProjectId,
+ )
+ .execute(&mut transaction)
+ .await
+ .wrap_internal_err("failed to delete project followers")?;
+
+ transaction
+ .commit()
+ .await
+ .wrap_internal_err("failed to commit transaction")?;
+
+ let mut cache_user_ids = affected_user_ids;
+ cache_user_ids.push(deleted_user);
+ db_models::DBUser::clear_project_cache(&cache_user_ids, &redis)
+ .await
+ .wrap_internal_err("failed to clear user project cache")?;
+ DBTeamMember::clear_cache(project.inner.team_id, &redis)
+ .await
+ .wrap_internal_err("clearing cached data from Redis")?;
+ db_models::DBProject::clear_cache(
+ project.inner.id,
+ project.inner.slug.clone(),
+ None,
+ &redis,
+ )
+ .await
+ .wrap_internal_err("clearing cached data from Redis")?;
+ search_state
+ .queue
+ .push_project_removal(project.inner.id.into())
+ .await;
+
+ return Ok(());
+ }
let context = ImageContext::Project {
project_id: Some(project.inner.id.into()),
@@ -3002,7 +3226,7 @@ pub async fn project_delete_internal(
}
}
-/// Follow a project.
+/// Follow a project.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = NO_CONTENT))
@@ -3109,7 +3333,7 @@ pub async fn project_follow_internal(
}
}
-/// Unfollow a project.
+/// Unfollow a project.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = NO_CONTENT))
@@ -3213,7 +3437,7 @@ pub async fn project_unfollow_internal(
}
}
-/// Get a project's organization.
+/// Get a project's organization.
#[utoipa::path(
context_path = "/project",
tag = "projects", responses((status = OK, body = models::organizations::Organization))
diff --git a/apps/labrinth/src/search/backend/elasticsearch/mod.rs b/apps/labrinth/src/search/backend/elasticsearch/mod.rs
index b6474bd61d..29026364a4 100644
--- a/apps/labrinth/src/search/backend/elasticsearch/mod.rs
+++ b/apps/labrinth/src/search/backend/elasticsearch/mod.rs
@@ -688,6 +688,11 @@ impl Elasticsearch {
"compatible_dependency_project_ids": {
"type": "keyword"
},
+ "disclosure_types": {"type": "keyword"},
+ "required_dependency_project_ids": {"type": "keyword"},
+ "optional_dependency_project_ids": {"type": "keyword"},
+ "embedded_dependency_project_ids": {"type": "keyword"},
+ "incompatible_dependency_project_ids": {"type": "keyword"},
"project_loader_fields": {
"type": "object",
"enabled": false
diff --git a/apps/labrinth/src/search/backend/typesense/mod.rs b/apps/labrinth/src/search/backend/typesense/mod.rs
index 6c7e407730..158e2e1d02 100644
--- a/apps/labrinth/src/search/backend/typesense/mod.rs
+++ b/apps/labrinth/src/search/backend/typesense/mod.rs
@@ -715,6 +715,48 @@ impl SearchField {
optional: true,
token_separators: &["-"],
},
+ SearchField::DisclosureTypes => TypesenseFieldSpec {
+ path: "disclosure_types",
+ ty: "string[]",
+ facet: true,
+ sort: false,
+ optional: true,
+ token_separators: &["_"],
+ },
+ SearchField::RequiredDependencyProjectIds => TypesenseFieldSpec {
+ path: "required_dependency_project_ids",
+ ty: "string[]",
+ facet: true,
+ sort: false,
+ optional: true,
+ token_separators: &["-"],
+ },
+ SearchField::OptionalDependencyProjectIds => TypesenseFieldSpec {
+ path: "optional_dependency_project_ids",
+ ty: "string[]",
+ facet: true,
+ sort: false,
+ optional: true,
+ token_separators: &["-"],
+ },
+ SearchField::EmbeddedDependencyProjectIds => TypesenseFieldSpec {
+ path: "embedded_dependency_project_ids",
+ ty: "string[]",
+ facet: true,
+ sort: false,
+ optional: true,
+ token_separators: &["-"],
+ },
+ SearchField::IncompatibleDependencyProjectIds => {
+ TypesenseFieldSpec {
+ path: "incompatible_dependency_project_ids",
+ ty: "string[]",
+ facet: true,
+ sort: false,
+ optional: true,
+ token_separators: &["-"],
+ }
+ }
}
}
}
diff --git a/apps/labrinth/src/search/indexing.rs b/apps/labrinth/src/search/indexing.rs
index 26ca2ba53b..658db2eacb 100644
--- a/apps/labrinth/src/search/indexing.rs
+++ b/apps/labrinth/src/search/indexing.rs
@@ -18,6 +18,7 @@ use crate::database::models::{
DBOrganizationId, DBProjectId, DBUserId, DBVersionId, LoaderFieldEnumId,
LoaderFieldEnumValueId, LoaderFieldId,
};
+use crate::models::disclosures::ProjectDisclosure;
use crate::models::exp;
use crate::models::ids::{ProjectId, VersionId};
use crate::models::projects::{DependencyType, from_duplicate_version_fields};
@@ -316,6 +317,32 @@ async fn build_search_documents(
)
.await?;
+ info!("Indexing local disclosures!");
+
+ let project_disclosures: DashMap<
+ DBProjectId,
+ Vec<(String, serde_json::Value)>,
+ > = sqlx::query!(
+ "
+ SELECT project_id, type, metadata
+ FROM project_disclosures
+ WHERE project_id = ANY($1) AND deleted_at IS NULL
+ ",
+ &*project_ids,
+ )
+ .fetch(pool)
+ .try_fold(
+ DashMap::new(),
+ |acc: DashMap>, m| {
+ acc.entry(DBProjectId(m.project_id))
+ .or_default()
+ .push((m.r#type, m.metadata));
+ async move { Ok(acc) }
+ },
+ )
+ .await
+ .wrap_err("failed to fetch project disclosures")?;
+
info!("Indexing local versions!");
let mut versions = load_project_versions(pool, project_ids.clone()).await?;
@@ -497,6 +524,45 @@ async fn build_search_documents(
let mut project_categories = categories;
project_categories.sort();
project_categories.dedup();
+
+ let disclosure_types = project_disclosures
+ .remove(&project.id)
+ .map(|(_, disclosures)| disclosures)
+ .unwrap_or_default()
+ .into_iter()
+ .flat_map(|(kind, metadata)| {
+ let disclosure =
+ match ProjectDisclosure::from_parts(&kind, metadata) {
+ Ok(disclosure) => disclosure,
+ Err(e) => {
+ warn!(
+ project_id = project.id.0,
+ disclosure_type = kind,
+ "indexing project disclosure without its metadata: {e}"
+ );
+ return vec![kind];
+ }
+ };
+
+ let mut disclosure_type_tokens = vec![kind.clone()];
+
+ match &disclosure {
+ ProjectDisclosure::AiContent { uses, .. } => {
+ disclosure_type_tokens.extend(uses.iter().map(|usage| {
+ format!("{kind}_{}", <&'static str>::from(usage))
+ }));
+ }
+ ProjectDisclosure::Telemetry { consent, .. } => {
+ disclosure_type_tokens.push(format!(
+ "{kind}_{}",
+ <&'static str>::from(consent)
+ ));
+ }
+ _ => {}
+ }
+ disclosure_type_tokens
+ })
+ .collect::>();
let dependencies = dependencies
.get(&project.id)
.map(|x| x.clone())
@@ -517,6 +583,34 @@ async fn build_search_documents(
})
.map(|dependency| dependency.project_id.clone())
.collect::>();
+ let required_dependency_project_ids = dependencies
+ .iter()
+ .filter(|dependency| {
+ dependency.dependency_type == DependencyType::Required
+ })
+ .map(|dependency| dependency.project_id.clone())
+ .collect::>();
+ let optional_dependency_project_ids = dependencies
+ .iter()
+ .filter(|dependency| {
+ dependency.dependency_type == DependencyType::Optional
+ })
+ .map(|dependency| dependency.project_id.clone())
+ .collect::>();
+ let embedded_dependency_project_ids = dependencies
+ .iter()
+ .filter(|dependency| {
+ dependency.dependency_type == DependencyType::Embedded
+ })
+ .map(|dependency| dependency.project_id.clone())
+ .collect::>();
+ let incompatible_dependency_project_ids = dependencies
+ .iter()
+ .filter(|dependency| {
+ dependency.dependency_type == DependencyType::Incompatible
+ })
+ .map(|dependency| dependency.project_id.clone())
+ .collect::>();
if let Some(versions) = versions.remove(&project.id) {
let Some(latest_version) = versions.iter().max_by(|a, b| {
@@ -731,7 +825,12 @@ async fn build_search_documents(
color: project.color.map(|x| x as u32),
dependency_project_ids,
compatible_dependency_project_ids,
+ required_dependency_project_ids,
+ optional_dependency_project_ids,
+ embedded_dependency_project_ids,
+ incompatible_dependency_project_ids,
dependencies,
+ disclosure_types,
project_loader_fields,
loader_fields,
loaders: project_loaders,
diff --git a/apps/labrinth/src/search/mod.rs b/apps/labrinth/src/search/mod.rs
index 9df4220e71..7c5254cb73 100644
--- a/apps/labrinth/src/search/mod.rs
+++ b/apps/labrinth/src/search/mod.rs
@@ -218,6 +218,11 @@ pub enum SearchField {
MinecraftJavaServerPingData,
DependencyProjectIds,
CompatibleDependencyProjectIds,
+ DisclosureTypes,
+ RequiredDependencyProjectIds,
+ OptionalDependencyProjectIds,
+ EmbeddedDependencyProjectIds,
+ IncompatibleDependencyProjectIds,
}
#[derive(Debug, Error)]
@@ -289,7 +294,17 @@ pub struct UploadSearchProject {
#[serde(default)]
pub compatible_dependency_project_ids: Vec,
#[serde(default)]
+ pub required_dependency_project_ids: Vec,
+ #[serde(default)]
+ pub optional_dependency_project_ids: Vec,
+ #[serde(default)]
+ pub embedded_dependency_project_ids: Vec,
+ #[serde(default)]
+ pub incompatible_dependency_project_ids: Vec,
+ #[serde(default)]
pub dependencies: Vec,
+ #[serde(default)]
+ pub disclosure_types: Vec,
// Hidden fields to get the Project model out of the search results.
pub loaders: Vec, // Search uses loaders as categories- this is purely for the Project model.
@@ -387,7 +402,17 @@ pub struct ResultSearchProject {
#[serde(default)]
pub compatible_dependency_project_ids: Vec,
#[serde(default)]
+ pub required_dependency_project_ids: Vec,
+ #[serde(default)]
+ pub optional_dependency_project_ids: Vec,
+ #[serde(default)]
+ pub embedded_dependency_project_ids: Vec,
+ #[serde(default)]
+ pub incompatible_dependency_project_ids: Vec,
+ #[serde(default)]
pub dependencies: Vec,
+ #[serde(default)]
+ pub disclosure_types: Vec,
// Hidden fields to get the Project model out of the search results.
pub loaders: Vec, // Search uses loaders as categories- this is purely for the Project model.
@@ -429,7 +454,16 @@ impl From for ResultSearchProject {
dependency_project_ids: source.dependency_project_ids,
compatible_dependency_project_ids: source
.compatible_dependency_project_ids,
+ required_dependency_project_ids: source
+ .required_dependency_project_ids,
+ optional_dependency_project_ids: source
+ .optional_dependency_project_ids,
+ embedded_dependency_project_ids: source
+ .embedded_dependency_project_ids,
+ incompatible_dependency_project_ids: source
+ .incompatible_dependency_project_ids,
dependencies: source.dependencies,
+ disclosure_types: source.disclosure_types,
loaders: source.loaders,
project_loader_fields: source.project_loader_fields,
components: source.components,
diff --git a/packages/api-client/src/modules/index.ts b/packages/api-client/src/modules/index.ts
index 28b3c77e9a..a08a953259 100644
--- a/packages/api-client/src/modules/index.ts
+++ b/packages/api-client/src/modules/index.ts
@@ -32,6 +32,7 @@ import { LabrinthCollectionsModule } from './labrinth/collections'
import { LabrinthContentV3Module } from './labrinth/content/v3'
import { LabrinthExternalProjectsInternalModule } from './labrinth/external-projects/internal'
import { LabrinthFriendsV3Module } from './labrinth/friends/v3'
+import { LabrinthGeoIpModule } from './labrinth/geoip'
import { LabrinthGlobalsInternalModule } from './labrinth/globals/internal'
import { LabrinthImagesV3Module } from './labrinth/images/v3'
import { LabrinthLimitsV3Module } from './labrinth/limits/v3'
@@ -111,6 +112,7 @@ export const MODULE_REGISTRY = {
labrinth_content_v3: LabrinthContentV3Module,
labrinth_external_projects_internal: LabrinthExternalProjectsInternalModule,
labrinth_friends_v3: LabrinthFriendsV3Module,
+ labrinth_geoip: LabrinthGeoIpModule,
labrinth_globals_internal: LabrinthGlobalsInternalModule,
labrinth_images_v3: LabrinthImagesV3Module,
labrinth_moderation_internal: LabrinthModerationInternalModule,
diff --git a/packages/api-client/src/modules/labrinth/geoip.ts b/packages/api-client/src/modules/labrinth/geoip.ts
new file mode 100644
index 0000000000..0ef7dd636a
--- /dev/null
+++ b/packages/api-client/src/modules/labrinth/geoip.ts
@@ -0,0 +1,23 @@
+import { AbstractModule } from '../../core/abstract-module'
+
+export class LabrinthGeoIpModule extends AbstractModule {
+ public getModuleID(): string {
+ return 'labrinth_geoip'
+ }
+
+ public async getCountry(): Promise {
+ const trace = await this.client.request('/trace', {
+ api: 'https://api.modrinth.com',
+ version: 'cdn-cgi',
+ method: 'GET',
+ skipAuth: true,
+ })
+ const country = trace
+ .split('\n')
+ .find((line) => line.startsWith('loc='))
+ ?.slice(4)
+ .toUpperCase()
+
+ return country?.match(/^[A-Z]{2}$/) ? country : undefined
+ }
+}
diff --git a/packages/api-client/src/modules/labrinth/index.ts b/packages/api-client/src/modules/labrinth/index.ts
index 51cca73d32..ec38853f06 100644
--- a/packages/api-client/src/modules/labrinth/index.ts
+++ b/packages/api-client/src/modules/labrinth/index.ts
@@ -8,6 +8,7 @@ export * from './collections'
export * from './content/v3'
export * from './external-projects/internal'
export * from './friends/v3'
+export * from './geoip'
export * from './globals/internal'
export * from './images/v3'
export * from './limits/v3'
diff --git a/packages/api-client/src/modules/labrinth/projects/v3.ts b/packages/api-client/src/modules/labrinth/projects/v3.ts
index 1c86154e88..3adc2a2fba 100644
--- a/packages/api-client/src/modules/labrinth/projects/v3.ts
+++ b/packages/api-client/src/modules/labrinth/projects/v3.ts
@@ -222,4 +222,116 @@ export class LabrinthProjectsV3Module extends AbstractModule {
method: 'DELETE',
})
}
+
+ /**
+ * Create a gallery image for a project
+ *
+ * @param id - Project ID or slug
+ * @param file - Image file to upload
+ * @param options - Gallery image options
+ *
+ * @example
+ * ```typescript
+ * await client.labrinth.projects_v3.createGalleryImage('sodium', imageFile, {
+ * featured: true,
+ * name: 'Screenshot 1',
+ * description: 'Main menu with Sodium enabled'
+ * })
+ * ```
+ */
+ public async createGalleryImage(
+ id: string,
+ file: Blob,
+ options: {
+ ext: string
+ featured: boolean
+ name?: string
+ description?: string
+ ordering?: number
+ },
+ ): Promise {
+ const params: Record = {
+ ext: options.ext,
+ featured: String(options.featured),
+ }
+ if (options.name) params.name = options.name
+ if (options.description) params.description = options.description
+ if (options.ordering !== undefined) params.ordering = String(options.ordering)
+
+ return this.client.request(`/project/${id}/gallery`, {
+ api: 'labrinth',
+ version: 3,
+ method: 'POST',
+ params,
+ body: file,
+ })
+ }
+
+ /**
+ * Delete a gallery image from a project
+ *
+ * @param id - Project ID or slug
+ * @param url - URL of the gallery image to delete
+ *
+ * @example
+ * ```typescript
+ * await client.labrinth.projects_v3.deleteGalleryImage('sodium', 'https://cdn.modrinth.com/...')
+ * ```
+ */
+ public async deleteGalleryImage(id: string, url: string): Promise {
+ return this.client.request(`/project/${id}/gallery`, {
+ api: 'labrinth',
+ version: 3,
+ method: 'DELETE',
+ params: { url },
+ })
+ }
+
+ /**
+ * Get content disclosures for a project
+ *
+ * @param id - Project ID or slug
+ * @returns Promise resolving to the project's disclosures
+ *
+ * @example
+ * ```typescript
+ * const { disclosures } = await client.labrinth.projects_v3.getDisclosures('sodium')
+ * ```
+ */
+ public async getDisclosures(id: string): Promise {
+ return this.client.request(
+ `/project/${id}/disclosures`,
+ {
+ api: 'labrinth',
+ version: 3,
+ method: 'GET',
+ },
+ )
+ }
+
+ /**
+ * Modify content disclosures for a project
+ *
+ * @param id - Project ID or slug
+ * @param data - Disclosures to set and types to remove
+ *
+ * @example
+ * ```typescript
+ * await client.labrinth.projects_v3.modifyDisclosures('sodium', {
+ * set: [{ type: 'ai_content', uses: ['text'], note: 'Translations are AI-generated.' }],
+ * remove: ['advertisements'],
+ * })
+ * ```
+ */
+ public async modifyDisclosures(
+ id: string,
+ data: Labrinth.Projects.v3.ModifyProjectDisclosures,
+ ): Promise {
+ return this.client.request(`/project/${id}/disclosures`, {
+ api: 'labrinth',
+ version: 3,
+ method: 'PATCH',
+ body: data,
+ })
+ }
}
diff --git a/packages/api-client/src/modules/labrinth/types.ts b/packages/api-client/src/modules/labrinth/types.ts
index 647390a2bc..18713f53b8 100644
--- a/packages/api-client/src/modules/labrinth/types.ts
+++ b/packages/api-client/src/modules/labrinth/types.ts
@@ -1301,6 +1301,80 @@ export namespace Labrinth {
projects: Project[]
versions: Labrinth.Versions.v3.Version[]
}
+
+ export type TelemetryConsent = 'opt_in' | 'opt_out' | 'always_active'
+
+ export type AiUsage = 'code' | 'assets' | 'text' | 'functionality'
+
+ export type DisclosureLockStatus = 'unlocked' | 'cannot_disable' | 'fully_locked'
+
+ export type DerivativeSource = {
+ label: string
+ link?: string | null
+ note?: string | null
+ }
+
+ export type ProjectDisclosure =
+ | {
+ type: 'ai_content'
+ uses: AiUsage[]
+ note?: string | null
+ }
+ | {
+ type: 'advertisements'
+ note?: string | null
+ }
+ | {
+ type: 'epilepsy_triggers'
+ note?: string | null
+ }
+ | {
+ type: 'system_interactions'
+ interactions: string[]
+ note?: string | null
+ }
+ | {
+ type: 'telemetry'
+ consent: TelemetryConsent
+ data_collected: string[]
+ }
+ | {
+ type: 'derivative_work'
+ sources: DerivativeSource[]
+ }
+ | {
+ type: 'paid_features'
+ features: string[]
+ }
+ | {
+ type: 'archived'
+ note?: string | null
+ }
+
+ export type ProjectDisclosureData = ProjectDisclosure & {
+ set_by_moderator: boolean
+ lock_status: DisclosureLockStatus
+ updated_at: string
+ updated_by?: string | null
+ deleted_at?: string | null
+ }
+
+ export type ProjectDisclosureType = ProjectDisclosure['type']
+
+ export type ProjectDisclosureOf = Extract<
+ ProjectDisclosureData,
+ { type: T }
+ >
+
+ export type GetProjectDisclosures = {
+ disclosures: ProjectDisclosureData[]
+ }
+
+ export type ModifyProjectDisclosures = {
+ set: ProjectDisclosure[]
+ remove: ProjectDisclosureType[]
+ lock_status?: DisclosureLockStatus | null
+ }
}
}
diff --git a/packages/app-lib/Cargo.toml b/packages/app-lib/Cargo.toml
index b3d05f8885..fb5f6e5083 100644
--- a/packages/app-lib/Cargo.toml
+++ b/packages/app-lib/Cargo.toml
@@ -50,6 +50,7 @@ httpdate = { workspace = true }
image = { workspace = true, features = ["gif", "jpeg", "png", "webp"] }
indicatif = { workspace = true, optional = true }
itertools = { workspace = true }
+json5 = { workspace = true }
modrinth-content-management = { workspace = true }
notify = { workspace = true }
notify-debouncer-mini = { workspace = true }
@@ -59,6 +60,8 @@ paste = { workspace = true }
path-util = { workspace = true }
phf = { workspace = true }
png = { workspace = true }
+postcard = { workspace = true, optional = true }
+postcard-bindgen = { workspace = true, features = ["generating", "std"], optional = true }
quartz_nbt = { workspace = true, features = ["serde"] }
quick-xml = { workspace = true, features = ["async-tokio"] }
rand = { workspace = true }
@@ -76,7 +79,8 @@ reqwest = { workspace = true, features = [
"stream",
] }
rgb = { workspace = true }
-serde = { workspace = true, features = ["derive"] }
+serde = { workspace = true, features = ["derive", "rc"] }
+serde-binhum = { workspace = true }
serde_ini = { workspace = true }
serde_json = { workspace = true }
serde_with = { workspace = true }
@@ -105,9 +109,15 @@ tokio = { workspace = true, features = [
"time",
] }
tokio-util = { workspace = true, features = ["compat", "io", "io-util", "time"] }
+toml = { workspace = true }
tracing = { workspace = true }
tracing-error = { workspace = true }
tracing-subscriber = { workspace = true, features = ["chrono", "env-filter"] }
+ts-rs = { workspace = true, features = [
+ "chrono-impl",
+ "no-serde-warnings",
+ "uuid-impl"
+], optional = true }
url = { workspace = true, features = ["serde"] }
urlencoding = { workspace = true }
uuid = { workspace = true, features = ["serde", "v4"] }
@@ -129,7 +139,8 @@ winreg = { workspace = true }
[features]
cli = ["dep:indicatif"]
-tauri = ["dep:tauri"]
+export-ts = ["dep:postcard-bindgen", "dep:ts-rs"]
+tauri = ["dep:postcard", "dep:tauri"]
[lints]
workspace = true
diff --git a/packages/app-lib/migrations/20260811120000_instance-content-locks.sql b/packages/app-lib/migrations/20260811120000_instance-content-locks.sql
new file mode 100644
index 0000000000..b98c3315bd
--- /dev/null
+++ b/packages/app-lib/migrations/20260811120000_instance-content-locks.sql
@@ -0,0 +1,6 @@
+CREATE TABLE instance_content_locks (
+ file_id TEXT NOT NULL,
+
+ PRIMARY KEY (file_id),
+ FOREIGN KEY (file_id) REFERENCES instance_files(id) ON DELETE CASCADE
+);
diff --git a/packages/app-lib/src/api/handler.rs b/packages/app-lib/src/api/handler.rs
index b35a0bf2b2..1f16218dc8 100644
--- a/packages/app-lib/src/api/handler.rs
+++ b/packages/app-lib/src/api/handler.rs
@@ -126,7 +126,9 @@ pub async fn parse_command(
if let Some(ext) = path.extension()
&& ext == "mrpack"
{
- return Ok(CommandPayload::RunMRPack { path });
+ return Ok(CommandPayload::RunMRPack {
+ path: path.to_string_lossy().into_owned(),
+ });
}
emit_warning(&format!(
"Invalid command, unrecognized filetype: {}",
diff --git a/packages/app-lib/src/api/instance.rs b/packages/app-lib/src/api/instance.rs
index c49d327d98..b93f6cd2b1 100644
--- a/packages/app-lib/src/api/instance.rs
+++ b/packages/app-lib/src/api/instance.rs
@@ -35,8 +35,9 @@ pub use self::projects::{
InstallProjectWithDependenciesRequest, add_project_from_path,
add_project_from_version, install_project_with_dependencies,
is_file_on_modrinth, remove_project, repair_managed_modrinth,
- switch_project_version_with_dependencies, toggle_disable_project,
- update_all_projects, update_managed_modrinth_version, update_project,
+ set_project_locked, switch_project_version_with_dependencies,
+ toggle_disable_project, update_all_projects,
+ update_managed_modrinth_version, update_project,
};
pub use self::run::{
QuickPlayType, kill, run, try_update_playtime_by_instance_id,
diff --git a/packages/app-lib/src/api/instance/export_mrpack.rs b/packages/app-lib/src/api/instance/export_mrpack.rs
index b0ba914642..d3ad218c04 100644
--- a/packages/app-lib/src/api/instance/export_mrpack.rs
+++ b/packages/app-lib/src/api/instance/export_mrpack.rs
@@ -8,18 +8,18 @@ use crate::pack::install_from::{
};
use crate::state::{
CacheBehaviour, CachedEntry, InstanceMetadata, ModLoader, SideType, State,
+ VersionEnvironment,
};
use crate::util::io::{self, IOError};
-use async_zip::tokio::write::ZipFileWriter;
-use async_zip::{Compression, ZipEntryBuilder};
use futures::{StreamExt, stream};
use path_util::SafeRelativeUtf8UnixPathBuf;
use serde::Serialize;
use std::collections::{HashMap, HashSet};
+use std::io::{Read, Seek, Write};
use std::path::PathBuf;
use std::time::UNIX_EPOCH;
-use tokio::fs::File;
-use tokio_util::compat::FuturesAsyncWriteCompatExt;
+use zip::write::SimpleFileOptions;
+use zip::{CompressionMethod, ZipWriter};
const DEFAULT_SELECTED_EXPORT_PATH_PREFIXES: &[&str] = &[
"mods",
@@ -29,6 +29,8 @@ const DEFAULT_SELECTED_EXPORT_PATH_PREFIXES: &[&str] = &[
"config",
];
const EXPORT_CANDIDATE_METADATA_CONCURRENCY: usize = 32;
+const EXPORT_COPY_BUFFER_SIZE: usize = 256 * 1024;
+const STANDARD_ZIP_FILE_SIZE_ERROR: &str = "Your modpack cannot be exported as it contains a file over the size limit of 4 GB";
const NEVER_EXPORTABLE_PATH_PREFIXES: &[&str] = &[
"profile.json",
@@ -181,10 +183,6 @@ pub async fn export_mrpack(
);
let instance_base_path = get_full_path(instance_id).await?;
- let mut file = File::create(&export_path)
- .await
- .map_err(|e| IOError::with_path(e, &export_path))?;
- let mut writer = ZipFileWriter::with_tokio(&mut file).force_no_zip64();
let version_id = version_id.unwrap_or("1.0.0".to_string());
let mut packfile =
create_mrpack_json(&metadata, version_id, description).await?;
@@ -196,16 +194,8 @@ pub async fn export_mrpack(
.iter()
.map(|file| file.path.as_str().to_string())
.collect::>();
- let loading_bar = init_loading(
- LoadingBarType::ZipExtract {
- instance_id: metadata.instance.id.clone(),
- instance_name: metadata.instance.name.clone(),
- },
- 1.0,
- "Exporting instance to .mrpack",
- )
- .await?;
+ let mut override_files = Vec::new();
let mut directories = vec![instance_base_path.clone()];
while let Some(directory) = directories.pop() {
let mut read_dir = io::read_dir(&directory).await?;
@@ -238,34 +228,91 @@ pub async fn export_mrpack(
continue;
}
- let mut stream = writer
- .write_entry_stream(
- ZipEntryBuilder::new(
- format!("overrides/{relative_path}").into(),
- Compression::Deflate,
- )
- .build(),
- )
- .await?
- .compat_write();
- let mut source = File::open(&path)
+ let size = entry
+ .metadata()
.await
- .map_err(|e| IOError::with_path(e, &path))?;
- tokio::io::copy(&mut source, &mut stream)
- .await
- .map_err(IOError::from)?;
- stream.into_inner().close().await?;
+ .map_err(|e| IOError::with_path(e, &path))?
+ .len();
+ ensure_standard_zip_file_size(size)?;
+ override_files.push((path, relative_path, size));
}
}
+ let total_bytes = override_files
+ .iter()
+ .fold(1_u64, |total, (_, _, size)| total.saturating_add(*size));
+ let loading_bar = init_loading(
+ LoadingBarType::PackExport {
+ instance_id: metadata.instance.id.clone(),
+ instance_name: metadata.instance.name.clone(),
+ },
+ total_bytes as f64,
+ "Exporting instance to .mrpack",
+ )
+ .await?;
let data = serde_json::to_vec_pretty(&packfile)?;
- let builder = ZipEntryBuilder::new(
- "modrinth.index.json".to_string().into(),
- Compression::Deflate,
- );
- writer.write_entry_whole(builder, &data).await?;
- writer.close().await?;
- emit_loading(&loading_bar, 1.0, None)?;
+ tokio::task::spawn_blocking(move || {
+ let file = std::fs::File::create(&export_path)
+ .map_err(|error| IOError::with_path(error, &export_path))?;
+ write_mrpack_archive(file, override_files, &data, |bytes_written| {
+ emit_loading(&loading_bar, bytes_written as f64, None)
+ })
+ })
+ .await??;
+
+ Ok(())
+}
+
+fn ensure_standard_zip_file_size(size: u64) -> crate::Result<()> {
+ if size > zip::ZIP64_BYTES_THR {
+ return Err(crate::ErrorKind::OtherError(
+ STANDARD_ZIP_FILE_SIZE_ERROR.to_string(),
+ )
+ .into());
+ }
+
+ Ok(())
+}
+
+fn write_mrpack_archive(
+ writer: W,
+ override_files: Vec<(PathBuf, SafeRelativeUtf8UnixPathBuf, u64)>,
+ packfile_data: &[u8],
+ mut emit_progress: F,
+) -> crate::Result<()>
+where
+ W: Write + Seek,
+ F: FnMut(u64) -> crate::Result<()>,
+{
+ let options = SimpleFileOptions::default()
+ .compression_method(CompressionMethod::Deflated);
+ let mut writer = ZipWriter::new(writer);
+ let mut buffer = vec![0_u8; EXPORT_COPY_BUFFER_SIZE];
+
+ for (path, relative_path, _) in override_files {
+ writer
+ .start_file(format!("overrides/{relative_path}"), options)
+ .map_err(std::io::Error::from)?;
+ let mut source = std::fs::File::open(&path)
+ .map_err(|error| IOError::with_path(error, &path))?;
+ loop {
+ let bytes_read = source
+ .read(&mut buffer)
+ .map_err(|error| IOError::with_path(error, &path))?;
+ if bytes_read == 0 {
+ break;
+ }
+ writer.write_all(&buffer[..bytes_read])?;
+ emit_progress(bytes_read as u64)?;
+ }
+ }
+
+ writer
+ .start_file("modrinth.index.json", options)
+ .map_err(std::io::Error::from)?;
+ writer.write_all(packfile_data)?;
+ writer.finish().map_err(std::io::Error::from)?;
+ emit_progress(1)?;
Ok(())
}
@@ -413,6 +460,39 @@ fn pack_get_relative_path(
)?)
}
+fn get_mrpack_environment(
+ environment: Option,
+) -> HashMap {
+ let (client, server) = match environment
+ .unwrap_or(VersionEnvironment::Unknown)
+ {
+ VersionEnvironment::ClientAndServer
+ | VersionEnvironment::SingleplayerOnly => {
+ (SideType::Required, SideType::Required)
+ }
+ VersionEnvironment::ClientOnly => {
+ (SideType::Required, SideType::Unsupported)
+ }
+ VersionEnvironment::ClientOnlyServerOptional => {
+ (SideType::Required, SideType::Optional)
+ }
+ VersionEnvironment::ServerOnly
+ | VersionEnvironment::DedicatedServerOnly => {
+ (SideType::Unsupported, SideType::Required)
+ }
+ VersionEnvironment::ServerOnlyClientOptional => {
+ (SideType::Optional, SideType::Required)
+ }
+ VersionEnvironment::ClientOrServer
+ | VersionEnvironment::ClientOrServerPrefersBoth => {
+ (SideType::Optional, SideType::Optional)
+ }
+ VersionEnvironment::Unknown => (SideType::Optional, SideType::Optional),
+ };
+
+ HashMap::from([(EnvType::Client, client), (EnvType::Server, server)])
+}
+
#[tracing::instrument(skip_all)]
pub async fn create_mrpack_json(
metadata: &InstanceMetadata,
@@ -461,9 +541,10 @@ pub async fn create_mrpack_json(
_ => None,
})
.collect::>();
- let versions = CachedEntry::get_version_many(
- &projects.iter().map(|x| &*x.1).collect::>(),
- None,
+ let version_ids = projects.iter().map(|x| &*x.1).collect::>();
+ let versions = CachedEntry::get_version_v3_many(
+ &version_ids,
+ Some(CacheBehaviour::MustRevalidate),
&state.pool,
&state.api_semaphore,
)
@@ -473,9 +554,7 @@ pub async fn create_mrpack_json(
.filter_map(|(path, version_id)| {
if let Some(version) = versions.iter().find(|x| x.id == version_id)
{
- let mut env = HashMap::new();
- env.insert(EnvType::Client, SideType::Required);
- env.insert(EnvType::Server, SideType::Required);
+ let env = get_mrpack_environment(version.environment);
let Some(primary_file) = version.files.first() else {
return Some(Err(crate::ErrorKind::OtherError(format!(
"No primary file found for mod at: {path}"
diff --git a/packages/app-lib/src/api/instance/projects.rs b/packages/app-lib/src/api/instance/projects.rs
index d8dc5f0eea..365e1a1c4e 100644
--- a/packages/app-lib/src/api/instance/projects.rs
+++ b/packages/app-lib/src/api/instance/projects.rs
@@ -60,6 +60,7 @@ pub async fn update_project(
&state,
)
.await?;
+ ensure_project_not_frozen(instance_id, project_path, &state).await?;
let path = crate::state::instances::commands::update_project(
instance_id,
project_path,
@@ -197,6 +198,7 @@ pub async fn switch_project_version_with_dependencies(
&state,
)
.await?;
+ ensure_project_not_frozen(instance_id, project_path, &state).await?;
let metadata = super::get::get(instance_id).await?.ok_or_else(|| {
crate::ErrorKind::InputError("Unknown instance".to_string())
})?;
@@ -289,6 +291,27 @@ pub async fn remove_project(
Ok(())
}
+#[tracing::instrument]
+pub async fn set_project_locked(
+ instance_id: &str,
+ project: &str,
+ locked: bool,
+) -> crate::Result<()> {
+ let state = State::get().await?;
+ ensure_shared_instance_can_modify_project(instance_id, project, &state)
+ .await?;
+ crate::state::instances::commands::set_project_locked(
+ instance_id,
+ project,
+ locked,
+ &state,
+ )
+ .await?;
+ emit_instance(instance_id, InstancePayloadType::Edited).await?;
+
+ Ok(())
+}
+
async fn ensure_shared_instance_can_modify_project(
instance_id: &str,
project_path: &str,
@@ -328,6 +351,28 @@ async fn ensure_shared_instance_can_modify_project(
Ok(())
}
+async fn ensure_project_not_frozen(
+ instance_id: &str,
+ project_path: &str,
+ state: &State,
+) -> crate::Result<()> {
+ if crate::state::instances::commands::is_project_locked(
+ instance_id,
+ project_path,
+ state,
+ )
+ .await?
+ {
+ return Err(crate::ErrorKind::InputError(
+ "Frozen content cannot change versions. Unfreeze it first."
+ .to_string(),
+ )
+ .into());
+ }
+
+ Ok(())
+}
+
#[tracing::instrument]
pub async fn update_managed_modrinth_version(
instance_id: &str,
diff --git a/packages/app-lib/src/api/pack/import/mod.rs b/packages/app-lib/src/api/pack/import/mod.rs
index 20b7f287ab..3081c9fc70 100644
--- a/packages/app-lib/src/api/pack/import/mod.rs
+++ b/packages/app-lib/src/api/pack/import/mod.rs
@@ -23,6 +23,10 @@ pub mod gdlauncher;
pub mod mmc;
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
pub enum ImportLauncherType {
MultiMC,
PrismLauncher,
diff --git a/packages/app-lib/src/api/server_address.rs b/packages/app-lib/src/api/server_address.rs
index 12f88f278f..ace5fe1589 100644
--- a/packages/app-lib/src/api/server_address.rs
+++ b/packages/app-lib/src/api/server_address.rs
@@ -82,18 +82,20 @@ fn parse_server_address_inner(
address: &str,
) -> std::result::Result<(&str, u16), String> {
let (host, port_str) = if address.starts_with("[") {
- let colon_index = address.find(':');
- let close_bracket_index = address.rfind(']');
- if colon_index.is_none() || close_bracket_index.is_none() {
+ let (Some(colon_index), Some(close_bracket_index)) =
+ (address.find(':'), address.rfind(']'))
+ else {
+ return Err(format!("Invalid bracketed host/port: {address}"));
+ };
+ if close_bracket_index <= colon_index {
return Err(format!("Invalid bracketed host/port: {address}"));
}
- let close_bracket_index = close_bracket_index.unwrap();
let host = &address[1..close_bracket_index];
if close_bracket_index + 1 == address.len() {
(host, "")
} else {
- if address.as_bytes().get(close_bracket_index).copied()
+ if address.as_bytes().get(close_bracket_index + 1).copied()
!= Some(b':')
{
return Err(format!(
@@ -109,9 +111,10 @@ fn parse_server_address_inner(
(host, port_str)
}
} else {
- let colon_pos = address.find(':');
- if let Some(colon_pos) = colon_pos {
- (&address[..colon_pos], &address[colon_pos + 1..])
+ if let Some((host, port)) = address.split_once(':')
+ && !port.contains(':')
+ {
+ (host, port)
} else {
(address, "")
}
@@ -164,3 +167,29 @@ pub async fn resolve_server_address(
.unwrap_or_else(|| (host.to_owned(), port)),
)
}
+
+#[cfg(test)]
+mod tests {
+ use super::parse_server_address_inner;
+
+ #[test]
+ fn parses_ipv4_server_addresses() {
+ for (address, expected) in [
+ ("192.0.2.1", ("192.0.2.1", 25565)),
+ ("192.0.2.1:25566", ("192.0.2.1", 25566)),
+ ] {
+ assert_eq!(parse_server_address_inner(address), Ok(expected));
+ }
+ }
+
+ #[test]
+ fn parses_ipv6_server_addresses() {
+ for (address, expected) in [
+ ("2001:db8::1", ("2001:db8::1", 25565)),
+ ("[2001:db8::1]", ("2001:db8::1", 25565)),
+ ("[2001:db8::1]:25566", ("2001:db8::1", 25566)),
+ ] {
+ assert_eq!(parse_server_address_inner(address), Ok(expected));
+ }
+ }
+}
diff --git a/packages/app-lib/src/error.rs b/packages/app-lib/src/error.rs
index 675b2b582c..2ed78b430d 100644
--- a/packages/app-lib/src/error.rs
+++ b/packages/app-lib/src/error.rs
@@ -23,6 +23,10 @@ pub struct LabrinthError {
}
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "snake_case")]
pub enum SharedInstanceUnavailableReason {
Deleted,
diff --git a/packages/app-lib/src/event/emit.rs b/packages/app-lib/src/event/emit.rs
index bc82d9fafa..870599d1e5 100644
--- a/packages/app-lib/src/event/emit.rs
+++ b/packages/app-lib/src/event/emit.rs
@@ -1,16 +1,16 @@
use super::{FriendPayload, LoadingBarId};
+#[cfg(feature = "tauri")]
+use crate::event::{
+ AppEvent, InstancePayload, LoadingPayload, ProcessPayload, WarningPayload,
+};
use crate::event::{
CommandPayload, EventError, InstanceBulkUpdateProgressPayload,
InstancePayloadType, LoadingBar, LoadingBarType, ProcessPayloadType,
};
-#[cfg(feature = "tauri")]
-use crate::event::{
- InstancePayload, LoadingPayload, ProcessPayload, WarningPayload,
-};
use futures::prelude::*;
use serde_json::Value;
#[cfg(feature = "tauri")]
-use tauri::{Emitter, Manager};
+use tauri::Manager;
use uuid::Uuid;
#[cfg(feature = "cli")]
@@ -61,7 +61,7 @@ pub async fn init_loading_unsafe(
total: f64,
title: &str,
) -> crate::Result {
- let event_state = crate::EventState::get()?;
+ let event_state = crate::EventState::get();
let key = LoadingBarId(Uuid::new_v4());
event_state.loading_bars.insert(
@@ -105,7 +105,7 @@ pub fn emit_loading(
increment_frac: f64,
message: Option<&str>,
) -> crate::Result<()> {
- let event_state = crate::EventState::get()?;
+ let event_state = crate::EventState::get();
let Some(mut loading_bar) = event_state.loading_bars.get_mut(&key.0) else {
return Err(EventError::NoLoadingBar(key.0).into());
@@ -131,25 +131,17 @@ pub fn emit_loading(
//Emit event to tauri
#[cfg(feature = "tauri")]
- event_state
- .app
- .emit(
- "loading",
- LoadingPayload {
- fraction: if display_frac >= 1.0 {
- None // by convention, when its done, we submit None
- // any further updates will be ignored (also sending None)
- } else {
- Some(display_frac)
- },
- message: message
- .unwrap_or(&loading_bar.message)
- .to_string(),
- event: loading_bar.bar_type.clone(),
- loader_uuid: loading_bar.loading_bar_uuid,
- },
- )
- .map_err(EventError::from)?;
+ event_state.send(AppEvent::Loading(LoadingPayload {
+ fraction: if display_frac >= 1.0 {
+ None // by convention, when its done, we submit None
+ // any further updates will be ignored (also sending None)
+ } else {
+ Some(display_frac)
+ },
+ message: message.unwrap_or(&loading_bar.message).to_string(),
+ event: loading_bar.bar_type.clone(),
+ loader_uuid: loading_bar.loading_bar_uuid.to_string(),
+ }))?;
#[cfg(not(any(feature = "cli", feature = "tauri")))]
let _ = message;
@@ -164,16 +156,10 @@ pub fn emit_loading(
pub async fn emit_warning(message: &str) -> crate::Result<()> {
#[cfg(feature = "tauri")]
{
- let event_state = crate::EventState::get()?;
- event_state
- .app
- .emit(
- "warning",
- WarningPayload {
- message: message.to_string(),
- },
- )
- .map_err(EventError::from)?;
+ let event_state = crate::EventState::get();
+ event_state.send(AppEvent::Warning(WarningPayload {
+ message: message.to_string(),
+ }))?;
}
tracing::warn!("{}", message);
Ok(())
@@ -185,11 +171,8 @@ pub async fn emit_instance_bulk_update_progress(
) -> crate::Result<()> {
#[cfg(feature = "tauri")]
{
- let event_state = crate::EventState::get()?;
- event_state
- .app
- .emit("instance_bulk_update_progress", payload)
- .map_err(EventError::from)?;
+ let event_state = crate::EventState::get();
+ event_state.send(AppEvent::InstanceBulkUpdateProgress(payload))?;
}
Ok(())
}
@@ -201,11 +184,8 @@ pub async fn emit_command(command: CommandPayload) -> crate::Result<()> {
tracing::debug!("Command: {}", serde_json::to_string(&command)?);
#[cfg(feature = "tauri")]
{
- let event_state = crate::EventState::get()?;
- event_state
- .app
- .emit("command", command)
- .map_err(EventError::from)?;
+ let event_state = crate::EventState::get();
+ event_state.send(AppEvent::Command(command))?;
if let Some(window) = event_state.app.get_window("main") {
let _ = window.set_focus();
@@ -224,19 +204,13 @@ pub async fn emit_process(
) -> crate::Result<()> {
#[cfg(feature = "tauri")]
{
- let event_state = crate::EventState::get()?;
- event_state
- .app
- .emit(
- "process",
- ProcessPayload {
- instance_id: instance_id.to_string(),
- uuid,
- event,
- message: message.to_string(),
- },
- )
- .map_err(EventError::from)?;
+ let event_state = crate::EventState::get();
+ event_state.send(AppEvent::Process(ProcessPayload {
+ instance_id: instance_id.to_string(),
+ uuid: uuid.to_string(),
+ event,
+ message: message.to_string(),
+ }))?;
}
Ok(())
}
@@ -249,17 +223,11 @@ pub async fn emit_instance(
) -> crate::Result<()> {
#[cfg(feature = "tauri")]
{
- let event_state = crate::EventState::get()?;
- event_state
- .app
- .emit(
- "instance",
- InstancePayload {
- instance_id: instance_id.to_string(),
- event,
- },
- )
- .map_err(EventError::from)?;
+ let event_state = crate::EventState::get();
+ event_state.send(AppEvent::Instance(InstancePayload {
+ instance_id: instance_id.to_string(),
+ event,
+ }))?;
}
Ok(())
}
@@ -268,11 +236,8 @@ pub async fn emit_instance(
pub async fn emit_friend(payload: FriendPayload) -> crate::Result<()> {
#[cfg(feature = "tauri")]
{
- let event_state = crate::EventState::get()?;
- event_state
- .app
- .emit("friend", payload)
- .map_err(EventError::from)?;
+ let event_state = crate::EventState::get();
+ event_state.send(AppEvent::Friend(payload))?;
}
Ok(())
@@ -282,11 +247,9 @@ pub async fn emit_friend(payload: FriendPayload) -> crate::Result<()> {
pub async fn emit_notification(payload: Value) -> crate::Result<()> {
#[cfg(feature = "tauri")]
{
- let event_state = crate::EventState::get()?;
+ let event_state = crate::EventState::get();
event_state
- .app
- .emit("notification", payload)
- .map_err(EventError::from)?;
+ .send(AppEvent::Notification(serde_json::to_string(&payload)?))?;
}
Ok(())
diff --git a/packages/app-lib/src/event/mod.rs b/packages/app-lib/src/event/mod.rs
index af1d5fe69f..7206441262 100644
--- a/packages/app-lib/src/event/mod.rs
+++ b/packages/app-lib/src/event/mod.rs
@@ -1,15 +1,18 @@
//! Theseus state management system
-use ariadne::ids::UserId;
-use ariadne::users::UserStatus;
-use chrono::{DateTime, Utc};
use dashmap::DashMap;
-use serde::{Deserialize, Serialize};
-use std::{path::PathBuf, sync::Arc};
#[cfg(feature = "tauri")]
-use tauri::Emitter;
+use parking_lot::RwLock;
+use serde::{Deserialize, Serialize};
+#[cfg(feature = "export-ts")]
+use std::path::PathBuf;
+use std::sync::Arc;
+#[cfg(feature = "tauri")]
+use tauri::ipc::{Channel, InvokeResponseBody};
use tokio::sync::OnceCell;
use uuid::Uuid;
+use crate::install::InstallJobSnapshot;
+
pub mod emit;
// Global event state
@@ -19,21 +22,30 @@ pub struct EventState {
/// Tauri app
#[cfg(feature = "tauri")]
pub app: tauri::AppHandle,
+ #[cfg(feature = "tauri")]
+ event_channel: RwLock>,
pub loading_bars: DashMap,
}
impl EventState {
#[cfg(feature = "tauri")]
- pub async fn init(app: tauri::AppHandle) -> crate::Result> {
- EVENT_STATE
+ pub async fn init(
+ app: tauri::AppHandle,
+ event_channel: Channel,
+ ) -> crate::Result> {
+ let state = EVENT_STATE
.get_or_try_init(|| async {
- Ok(Arc::new(Self {
+ Ok::<_, crate::Error>(Arc::new(Self {
app,
+ event_channel: RwLock::new(event_channel.clone()),
loading_bars: DashMap::new(),
}))
})
.await
- .cloned()
+ .cloned()?;
+
+ *state.event_channel.write() = event_channel;
+ Ok(state)
}
#[cfg(not(feature = "tauri"))]
@@ -48,14 +60,28 @@ impl EventState {
.cloned()
}
- pub fn get() -> crate::Result> {
- Ok(EVENT_STATE.get().ok_or(EventError::NotInitialized)?.clone())
+ pub fn get() -> Arc {
+ EVENT_STATE
+ .get()
+ .expect("should be initialized when used")
+ .clone()
+ }
+
+ #[cfg(feature = "tauri")]
+ pub fn send(&self, event: AppEvent) -> crate::Result<()> {
+ let payload =
+ postcard::to_allocvec(&event).map_err(EventError::from)?;
+ self.event_channel
+ .read()
+ .send(InvokeResponseBody::Raw(payload))
+ .map_err(EventError::from)?;
+ Ok(())
}
// Values provided should not be used directly, as they are clones and are not guaranteed to be up-to-date
pub async fn list_progress_bars() -> crate::Result>
{
- let value = Self::get()?;
+ let value = Self::get();
Ok(value.loading_bars.clone())
}
@@ -63,11 +89,122 @@ impl EventState {
pub async fn get_main_window() -> crate::Result>
{
use tauri::Manager;
- let value = Self::get()?;
+ let value = Self::get();
Ok(value.app.get_webview_window("main"))
}
}
+#[derive(Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
+#[serde(tag = "type", content = "payload", rename_all = "snake_case")]
+#[cfg_attr(
+ feature = "export-ts",
+ ts(
+ tag = "type",
+ content = "payload",
+ rename_all = "snake_case",
+ export_to = "AppEvent.ts"
+ )
+)]
+pub enum AppEvent {
+ Loading(LoadingPayload),
+ Process(ProcessPayload),
+ Instance(InstancePayload),
+ InstanceBulkUpdateProgress(InstanceBulkUpdateProgressPayload),
+ InstallJob(std::sync::Arc),
+ Command(CommandPayload),
+ Warning(WarningPayload),
+ Friend(FriendPayload),
+ Notification(
+ #[cfg_attr(feature = "export-ts", ts(type = "unknown"))] String,
+ ),
+ Log(LogPayload),
+ AdsConsentRequired(bool),
+}
+
+#[cfg(feature = "export-ts")]
+pub fn export_app_event_bindings(
+ output: impl Into,
+) -> Result<(), Box> {
+ use postcard_bindgen::{PackageInfo, generate_bindings, javascript};
+ use ts_rs::{Config, TS};
+
+ let output = output.into();
+ let config = Config::default()
+ .with_out_dir(output.clone())
+ .with_large_int("number");
+ AppEvent::export_all(&config)?;
+
+ javascript::build_package(
+ &output,
+ PackageInfo {
+ name: "postcard".into(),
+ version: "0.0.0".try_into()?,
+ },
+ javascript::GenerationSettings::default()
+ .type_script_types(true)
+ .module_structure(false)
+ .esm_module(true),
+ generate_bindings!(
+ AppEvent,
+ LoadingBarType,
+ LoadingPayload,
+ WarningPayload,
+ InstanceBulkUpdateProgressPayload,
+ InstanceBulkUpdateProgressStage,
+ CommandPayload,
+ ProcessPayload,
+ ProcessPayloadType,
+ InstancePayload,
+ InstancePayloadType,
+ FriendPayload,
+ FriendStatusPayload,
+ LogEvent,
+ LogPayload,
+ crate::state::Log4jEvent,
+ crate::install::InstallJobSnapshot,
+ crate::install::InstallJobKind,
+ crate::install::InstallJobStatus,
+ crate::install::model::InstallTarget,
+ crate::install::InstallPhaseId,
+ crate::install::InstallProgress,
+ crate::install::InstallProgressSecondary,
+ crate::install::InstallPhaseDetails,
+ crate::install::InstallJavaStep,
+ crate::install::model::InstallJobDisplay,
+ crate::install::InstallErrorView,
+ crate::install::model::InstallApiErrorDetails,
+ crate::install::InstallErrorContext,
+ crate::api::pack::import::ImportLauncherType,
+ crate::state::ModLoader,
+ crate::SharedInstanceUnavailableReason
+ ),
+ )?;
+ fix_postcard_javascript_utf8(&output.join("postcard/index.js"))?;
+ Ok(())
+}
+
+#[cfg(feature = "export-ts")]
+fn fix_postcard_javascript_utf8(
+ output: &std::path::Path,
+) -> Result<(), Box> {
+ const GENERATED: &str = "deserialize_string = () => { const str = this.pop_n(Number(this.try_take(U32_BYTES))); return String.fromCharCode(...str) }";
+ const UTF8: &str = "deserialize_string = () => new TextDecoder().decode(new Uint8Array(this.pop_n(Number(this.try_take(U32_BYTES)))))";
+
+ let javascript = std::fs::read_to_string(output)?;
+ if !javascript.contains(GENERATED) {
+ return Err(
+ "postcard-bindgen's generated string decoder changed".into()
+ );
+ }
+ std::fs::write(output, javascript.replace(GENERATED, UTF8))?;
+ Ok(())
+}
+
#[derive(Serialize, Debug, Clone)]
pub struct LoadingBar {
// loading_bar_uuid not be used directly by external functions as it may not reflect the current state of the loading bar/hashmap
@@ -91,55 +228,58 @@ impl Drop for LoadingBarId {
fn drop(&mut self) {
let loader_uuid = self.0;
tokio::spawn(async move {
- if let Ok(event_state) = EventState::get() {
- #[cfg(any(feature = "tauri", feature = "cli"))]
- if let Some((_, bar)) =
- event_state.loading_bars.remove(&loader_uuid)
+ let event_state = EventState::get();
+ #[cfg(any(feature = "tauri", feature = "cli"))]
+ if let Some((_, bar)) =
+ event_state.loading_bars.remove(&loader_uuid)
+ {
+ #[cfg(feature = "tauri")]
{
- #[cfg(feature = "tauri")]
- {
- let loader_uuid = bar.loading_bar_uuid;
- let event = bar.bar_type.clone();
- let fraction = bar.current / bar.total;
+ let loader_uuid = bar.loading_bar_uuid;
+ let event = bar.bar_type.clone();
+ let fraction = bar.current / bar.total;
- let _ = event_state.app.emit(
- "loading",
- LoadingPayload {
- fraction: None,
- message: "Completed".to_string(),
- event,
- loader_uuid,
- },
- );
- tracing::trace!(
- "Exited at {fraction} for loading bar: {:?}",
- loader_uuid
- );
- }
-
- // Emit event to indicatif progress bar arc
- #[cfg(feature = "cli")]
- {
- let cli_progress_bar = bar.cli_progress_bar;
- cli_progress_bar.finish();
- }
+ let _ =
+ event_state.send(AppEvent::Loading(LoadingPayload {
+ fraction: None,
+ message: "Completed".to_string(),
+ event,
+ loader_uuid: loader_uuid.to_string(),
+ }));
+ tracing::trace!(
+ "Exited at {fraction} for loading bar: {:?}",
+ loader_uuid
+ );
}
- #[cfg(not(any(feature = "tauri", feature = "cli")))]
- event_state.loading_bars.remove(&loader_uuid);
+ // Emit event to indicatif progress bar arc
+ #[cfg(feature = "cli")]
+ {
+ let cli_progress_bar = bar.cli_progress_bar;
+ cli_progress_bar.finish();
+ }
}
+
+ #[cfg(not(any(feature = "tauri", feature = "cli")))]
+ event_state.loading_bars.remove(&loader_uuid);
});
}
}
-#[derive(Serialize, Deserialize, Clone, Debug, Hash, PartialEq, Eq)]
+#[derive(Clone, Debug, Hash, PartialEq, Eq)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
#[serde(tag = "type")]
#[serde(rename_all = "snake_case")]
+#[cfg_attr(feature = "export-ts", ts(tag = "type", rename_all = "snake_case"))]
pub enum LoadingBarType {
LegacyDataMigration,
DirectoryMove {
- old: PathBuf,
- new: PathBuf,
+ old: String,
+ new: String,
},
JavaDownload {
version: u32,
@@ -153,7 +293,7 @@ pub enum LoadingBarType {
PackDownload {
instance_id: String,
pack_name: String,
- icon: Option,
+ icon: Option,
pack_id: Option,
pack_version: Option,
},
@@ -172,11 +312,15 @@ pub enum LoadingBarType {
instance_id: String,
instance_name: String,
},
+ PackExport {
+ instance_id: String,
+ instance_name: String,
+ },
ConfigChange {
- new_path: PathBuf,
+ new_path: String,
},
CopyInstance {
- import_location: PathBuf,
+ import_location: String,
instance_name: String,
},
LauncherUpdate {
@@ -185,22 +329,32 @@ pub enum LoadingBarType {
},
}
-#[derive(Serialize, Clone)]
-#[cfg(feature = "tauri")]
+#[derive(Serialize, Deserialize, Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
pub struct LoadingPayload {
pub event: LoadingBarType,
- pub loader_uuid: Uuid,
+ pub loader_uuid: String,
pub fraction: Option, // by convention, if optional, it means the loading is done
pub message: String,
}
-#[derive(Serialize, Clone)]
-#[cfg(feature = "tauri")]
+#[derive(Serialize, Deserialize, Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
pub struct WarningPayload {
pub message: String,
}
-#[derive(Serialize, Clone)]
+#[derive(Serialize, Deserialize, Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "camelCase")]
pub struct InstanceBulkUpdateProgressPayload {
pub instance_id: String,
@@ -209,7 +363,11 @@ pub struct InstanceBulkUpdateProgressPayload {
pub total: usize,
}
-#[derive(Serialize, Clone)]
+#[derive(Serialize, Deserialize, Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "snake_case")]
pub enum InstanceBulkUpdateProgressStage {
ResolvingVersions,
@@ -217,8 +375,14 @@ pub enum InstanceBulkUpdateProgressStage {
Finishing,
}
-#[derive(Serialize, Clone)]
+#[derive(Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
#[serde(tag = "event")]
+#[cfg_attr(feature = "export-ts", ts(tag = "event"))]
pub enum CommandPayload {
InstallMod {
id: String,
@@ -242,36 +406,54 @@ pub enum CommandPayload {
},
RunMRPack {
// run or install .mrpack
- path: PathBuf,
+ path: String,
},
}
-#[derive(Serialize, Clone)]
-#[cfg(feature = "tauri")]
+#[derive(Serialize, Deserialize, Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
pub struct ProcessPayload {
pub instance_id: String,
- pub uuid: Uuid,
+ pub uuid: String,
pub event: ProcessPayloadType,
pub message: String,
}
-#[derive(Serialize, Clone, Debug)]
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "snake_case")]
pub enum ProcessPayloadType {
Launched,
Finished,
}
-#[derive(Serialize, Clone)]
-#[cfg(feature = "tauri")]
+#[derive(Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
pub struct InstancePayload {
pub instance_id: String,
#[serde(flatten)]
+ #[cfg_attr(feature = "export-ts", ts(flatten))]
pub event: InstancePayloadType,
}
-#[derive(Serialize, Clone)]
+#[derive(Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
#[serde(tag = "event", rename_all = "snake_case")]
+#[cfg_attr(feature = "export-ts", ts(tag = "event", rename_all = "snake_case"))]
pub enum InstancePayloadType {
Created,
Synced,
@@ -282,7 +464,7 @@ pub enum InstancePayloadType {
ServerJoined {
host: String,
port: u16,
- timestamp: DateTime,
+ timestamp: String,
},
Edited,
ContentInstallFinished {
@@ -295,47 +477,87 @@ pub enum InstancePayloadType {
Removed,
}
-#[derive(Serialize, Clone)]
+#[derive(Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
#[serde(rename_all = "snake_case")]
#[serde(tag = "event")]
+#[cfg_attr(feature = "export-ts", ts(tag = "event", rename_all = "snake_case"))]
pub enum FriendPayload {
- FriendRequest { from: UserId },
- UserOffline { id: UserId },
- StatusUpdate { user_status: UserStatus },
+ FriendRequest { from: String },
+ UserOffline { id: String },
+ StatusUpdate { user_status: FriendStatusPayload },
StatusSync,
}
-#[cfg(feature = "tauri")]
+#[derive(Serialize, Deserialize, Clone)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+pub struct FriendStatusPayload {
+ pub user_id: String,
+ pub profile_name: Option,
+ pub last_update: String,
+}
+
+impl From for FriendStatusPayload {
+ fn from(status: ariadne::users::UserStatus) -> Self {
+ Self {
+ user_id: status.user_id.to_string(),
+ profile_name: status.profile_name,
+ last_update: status.last_update.to_rfc3339(),
+ }
+ }
+}
+
pub use self::log_types::*;
-#[cfg(feature = "tauri")]
mod log_types {
use crate::state::Log4jEvent;
- use serde::Serialize;
- #[derive(Serialize, Clone)]
+ #[derive(Clone)]
+ #[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+ )]
+ #[serde_binhum::serde_binhum]
#[serde(tag = "type", rename_all = "snake_case")]
+ #[cfg_attr(
+ feature = "export-ts",
+ ts(tag = "type", rename_all = "snake_case")
+ )]
pub enum LogEvent {
Log4j(Log4jEvent),
Legacy { message: String },
}
- #[derive(Serialize, Clone)]
+ #[derive(Clone)]
+ #[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+ )]
+ #[serde_binhum::serde_binhum]
pub struct LogPayload {
pub instance_id: String,
#[serde(flatten)]
+ #[cfg_attr(feature = "export-ts", ts(flatten))]
pub event: LogEvent,
}
}
#[derive(Debug, thiserror::Error)]
pub enum EventError {
- #[error("Event state was not properly initialized")]
- NotInitialized,
-
#[error("Non-existent loading bar of key: {0}")]
NoLoadingBar(Uuid),
+ #[cfg(feature = "tauri")]
+ #[error("Postcard encoding error: {0}")]
+ PostcardEncode(#[from] postcard::Error),
+
#[cfg(feature = "tauri")]
#[error("Tauri error: {0}")]
TauriError(#[from] tauri::Error),
diff --git a/packages/app-lib/src/install/events.rs b/packages/app-lib/src/install/events.rs
index fb9b169f03..028bbb6841 100644
--- a/packages/app-lib/src/install/events.rs
+++ b/packages/app-lib/src/install/events.rs
@@ -200,14 +200,11 @@ pub async fn emit_install_job(
) -> crate::Result<()> {
#[cfg(feature = "tauri")]
{
- use tauri::Emitter;
-
let result: crate::Result<()> = (|| {
- let event_state = crate::EventState::get()?;
- event_state
- .app
- .emit("install_job", snapshot)
- .map_err(crate::event::EventError::from)?;
+ let event_state = crate::EventState::get();
+ event_state.send(crate::event::AppEvent::InstallJob(
+ std::sync::Arc::new(snapshot.clone()),
+ ))?;
Ok(())
})();
if let Err(error) = result {
diff --git a/packages/app-lib/src/install/model.rs b/packages/app-lib/src/install/model.rs
index 4f49c1db9f..9c6574393e 100644
--- a/packages/app-lib/src/install/model.rs
+++ b/packages/app-lib/src/install/model.rs
@@ -6,7 +6,6 @@ use crate::state::{
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use std::path::PathBuf;
-use uuid::Uuid;
pub type InstallModpackPreview = CreatePackInstance;
@@ -300,6 +299,10 @@ impl InstallRequest {
}
#[derive(Serialize, Deserialize, Clone, Copy, Debug, Eq, PartialEq)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "snake_case")]
pub enum InstallJobKind {
CreateInstance,
@@ -345,6 +348,10 @@ impl InstallJobKind {
}
#[derive(Serialize, Deserialize, Clone, Copy, Debug, Eq, PartialEq)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "snake_case")]
pub enum InstallJobStatus {
Queued,
@@ -386,8 +393,14 @@ impl InstallJobStatus {
}
}
-#[derive(Serialize, Deserialize, Clone, Debug)]
+#[derive(Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
#[serde(tag = "type", rename_all = "snake_case")]
+#[cfg_attr(feature = "export-ts", ts(tag = "type", rename_all = "snake_case"))]
pub enum InstallTarget {
NewInstance { instance_id: Option },
ExistingInstance { instance_id: String },
@@ -408,6 +421,10 @@ pub struct InstallProgressState {
}
#[derive(Serialize, Deserialize, Clone, Copy, Debug, Eq, PartialEq)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "snake_case")]
pub enum InstallPhaseId {
PreparingInstance,
@@ -425,21 +442,35 @@ pub enum InstallPhaseId {
RollingBack,
}
-#[derive(Serialize, Deserialize, Clone, Debug)]
+#[derive(Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
pub struct InstallProgress {
pub current: u64,
pub total: u64,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub secondary: Option,
}
#[derive(Serialize, Deserialize, Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
pub struct InstallProgressSecondary {
pub current: u64,
pub total: u64,
}
#[derive(Serialize, Deserialize, Clone, Copy, Debug, Eq, PartialEq)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "snake_case")]
pub enum InstallJavaStep {
Resolving,
@@ -449,8 +480,14 @@ pub enum InstallJavaStep {
Validating,
}
-#[derive(Serialize, Deserialize, Clone, Debug)]
+#[derive(Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
#[serde(tag = "type", rename_all = "snake_case")]
+#[cfg_attr(feature = "export-ts", ts(tag = "type", rename_all = "snake_case"))]
pub enum InstallPhaseDetails {
Empty,
Instance {
@@ -481,52 +518,74 @@ pub struct InstallJobPaths {
pub final_instance_path: Option,
}
-#[derive(Serialize, Deserialize, Clone, Debug, bon::Builder)]
+#[derive(Clone, Debug, bon::Builder)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
#[builder(start_fn = new)]
pub struct InstallErrorContext {
#[builder(start_fn, into)]
pub operation: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub source_path: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub target_path: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub file_path: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub entry_path: Option,
- #[serde(default, skip_serializing_if = "Vec::is_empty")]
+ #[serde(default)]
#[builder(default)]
pub urls: Vec,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub expected_hash: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub expected_size: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub project_id: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub version_id: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub minecraft_version: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub loader: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub java_version: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub os: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
#[builder(into)]
pub arch: Option,
}
#[derive(Serialize, Deserialize, Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
pub struct InstallJobDisplay {
pub title: String,
pub icon: Option,
@@ -538,30 +597,48 @@ pub struct InstallRollbackState {
pub install_stage: InstanceInstallStage,
}
-#[derive(Serialize, Deserialize, Clone, Debug)]
+#[derive(Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
pub struct InstallErrorView {
pub code: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub phase: Option,
pub message: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub reason: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub api: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub context: Option,
}
-#[derive(Serialize, Deserialize, Clone, Debug)]
+#[derive(Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
+#[serde_binhum::serde_binhum]
pub struct InstallApiErrorDetails {
pub error: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub status: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub method: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub url: Option,
#[serde(default, skip_serializing_if = "Option::is_none")]
+ #[cfg_attr(feature = "export-ts", ts(optional))]
pub route: Option,
}
@@ -610,8 +687,12 @@ impl InstallErrorView {
}
#[derive(Serialize, Deserialize, Clone, Debug)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
pub struct InstallJobSnapshot {
- pub job_id: Uuid,
+ pub job_id: String,
pub instance_id: Option,
pub kind: InstallJobKind,
pub status: InstallJobStatus,
@@ -622,7 +703,7 @@ pub struct InstallJobSnapshot {
pub display: Option,
pub error: Option,
pub rollback_error: Option,
- pub created: DateTime,
- pub modified: DateTime,
- pub finished: Option>,
+ pub created: String,
+ pub modified: String,
+ pub finished: Option,
}
diff --git a/packages/app-lib/src/install/store.rs b/packages/app-lib/src/install/store.rs
index cc6d13796f..671c4f6eff 100644
--- a/packages/app-lib/src/install/store.rs
+++ b/packages/app-lib/src/install/store.rs
@@ -34,7 +34,7 @@ struct InstallJobRow {
impl InstallJobRecord {
pub fn snapshot(&self) -> InstallJobSnapshot {
InstallJobSnapshot {
- job_id: self.id,
+ job_id: self.id.to_string(),
instance_id: self.instance_id.clone(),
kind: self.kind,
status: self.status,
@@ -45,9 +45,9 @@ impl InstallJobRecord {
display: self.state.display.clone(),
error: self.state.error.clone(),
rollback_error: self.state.rollback_error.clone(),
- created: self.created,
- modified: self.modified,
- finished: self.finished,
+ created: self.created.to_rfc3339(),
+ modified: self.modified.to_rfc3339(),
+ finished: self.finished.map(|finished| finished.to_rfc3339()),
}
}
}
diff --git a/packages/app-lib/src/lib.rs b/packages/app-lib/src/lib.rs
index 79b0e997a6..ba3881c7ed 100644
--- a/packages/app-lib/src/lib.rs
+++ b/packages/app-lib/src/lib.rs
@@ -20,8 +20,10 @@ mod state;
pub use api::*;
pub use error::*;
+#[cfg(feature = "export-ts")]
+pub use event::export_app_event_bindings;
pub use event::{
- EventState, LoadingBar, LoadingBarType, emit::emit_loading,
+ AppEvent, EventState, LoadingBar, LoadingBarType, emit::emit_loading,
emit::init_loading,
};
pub use logger::start_logger;
diff --git a/packages/app-lib/src/state/cache.rs b/packages/app-lib/src/state/cache.rs
index 867fc1b624..61b7d89d57 100644
--- a/packages/app-lib/src/state/cache.rs
+++ b/packages/app-lib/src/state/cache.rs
@@ -1,4 +1,4 @@
-use crate::state::ProjectType;
+use crate::state::{EmbeddedContentMetadata, ProjectType};
use crate::util::fetch::{FetchSemaphore, fetch_json, sha1_async};
use chrono::{DateTime, Utc};
use dashmap::DashSet;
@@ -21,6 +21,7 @@ pub enum CacheValueType {
Project,
ProjectV3,
Version,
+ VersionV3,
User,
Team,
Organization,
@@ -37,6 +38,7 @@ pub enum CacheValueType {
SearchResults,
SearchResultsV3,
ModpackFiles,
+ EmbeddedContentMetadata,
/// Cached list of versions for a project (without changelogs for fast loading)
ProjectVersions,
}
@@ -47,6 +49,7 @@ impl CacheValueType {
CacheValueType::Project => "project",
CacheValueType::ProjectV3 => "project_v3",
CacheValueType::Version => "version",
+ CacheValueType::VersionV3 => "version_v3",
CacheValueType::User => "user",
CacheValueType::Team => "team",
CacheValueType::Organization => "organization",
@@ -63,6 +66,9 @@ impl CacheValueType {
CacheValueType::SearchResults => "search_results",
CacheValueType::SearchResultsV3 => "search_results_v3",
CacheValueType::ModpackFiles => "modpack_files",
+ CacheValueType::EmbeddedContentMetadata => {
+ "embedded_content_metadata"
+ }
CacheValueType::ProjectVersions => "project_versions",
}
}
@@ -72,6 +78,7 @@ impl CacheValueType {
"project" => CacheValueType::Project,
"project_v3" => CacheValueType::ProjectV3,
"version" => CacheValueType::Version,
+ "version_v3" => CacheValueType::VersionV3,
"user" => CacheValueType::User,
"team" => CacheValueType::Team,
"organization" => CacheValueType::Organization,
@@ -88,6 +95,9 @@ impl CacheValueType {
"search_results" => CacheValueType::SearchResults,
"search_results_v3" => CacheValueType::SearchResultsV3,
"modpack_files" => CacheValueType::ModpackFiles,
+ "embedded_content_metadata" => {
+ CacheValueType::EmbeddedContentMetadata
+ }
"project_versions" => CacheValueType::ProjectVersions,
_ => CacheValueType::Project,
}
@@ -100,7 +110,10 @@ impl CacheValueType {
CacheValueType::FileHash => 30 * 24 * 60 * 60, // 30 days
// ModpackFiles never expire - version_id is immutable so hashes never change
// TODO: There has to be a way to exclude this from the "Purge cache" stuff?
- CacheValueType::ModpackFiles => 100 * 365 * 24 * 60 * 60, // 100 years (effectively never)
+ CacheValueType::ModpackFiles
+ | CacheValueType::EmbeddedContentMetadata => {
+ 100 * 365 * 24 * 60 * 60 // 100 years (effectively never)
+ }
CacheValueType::SearchResults | CacheValueType::SearchResultsV3 => {
10 * 60 // 10 minutes
}
@@ -134,6 +147,7 @@ impl CacheValueType {
| CacheValueType::GameVersions
| CacheValueType::DonationPlatforms
| CacheValueType::Version
+ | CacheValueType::VersionV3
| CacheValueType::Team
| CacheValueType::File
| CacheValueType::LoaderManifest
@@ -141,6 +155,7 @@ impl CacheValueType {
| CacheValueType::SearchResults
| CacheValueType::SearchResultsV3
| CacheValueType::ModpackFiles
+ | CacheValueType::EmbeddedContentMetadata
| CacheValueType::ProjectVersions => None,
}
}
@@ -162,6 +177,13 @@ pub struct CachedProjectVersions {
pub versions: Vec,
}
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct CachedEmbeddedContentMetadata {
+ pub cache_key: String,
+ pub hash: String,
+ pub metadata: Option,
+}
+
// De/serialization strategy:
// - on serialize:
// - in the `cache` table, save the `data_type` (variant of this value) alongside
@@ -181,6 +203,7 @@ pub struct CachedProjectVersions {
pub enum CacheValue {
Project(Project),
Version(Version),
+ VersionV3(VersionV3),
User(User),
Team(Vec),
Organization(Organization),
@@ -197,6 +220,7 @@ pub enum CacheValue {
SearchResults(SearchResults),
SearchResultsV3(SearchResultsV3),
ModpackFiles(CachedModpackFiles),
+ EmbeddedContentMetadata(CachedEmbeddedContentMetadata),
ProjectVersions(CachedProjectVersions),
ProjectV3(ProjectV3),
}
@@ -543,6 +567,30 @@ pub struct Version {
pub loaders: Vec,
}
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct VersionV3 {
+ pub id: String,
+ pub files: Vec,
+ #[serde(default)]
+ pub environment: Option,
+}
+
+#[derive(Serialize, Deserialize, Clone, Copy, Debug)]
+#[serde(rename_all = "snake_case")]
+pub enum VersionEnvironment {
+ ClientAndServer,
+ ClientOnly,
+ ClientOnlyServerOptional,
+ SingleplayerOnly,
+ ServerOnly,
+ ServerOnlyClientOptional,
+ DedicatedServerOnly,
+ ClientOrServer,
+ ClientOrServerPrefersBoth,
+ #[serde(other)]
+ Unknown,
+}
+
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct VersionFile {
pub hashes: HashMap,
@@ -661,6 +709,7 @@ impl CacheValue {
CacheValue::Project(_) => CacheValueType::Project,
CacheValue::ProjectV3(_) => CacheValueType::ProjectV3,
CacheValue::Version(_) => CacheValueType::Version,
+ CacheValue::VersionV3(_) => CacheValueType::VersionV3,
CacheValue::User(_) => CacheValueType::User,
CacheValue::Team { .. } => CacheValueType::Team,
CacheValue::Organization(_) => CacheValueType::Organization,
@@ -681,6 +730,9 @@ impl CacheValue {
CacheValue::SearchResults(_) => CacheValueType::SearchResults,
CacheValue::SearchResultsV3(_) => CacheValueType::SearchResultsV3,
CacheValue::ModpackFiles(_) => CacheValueType::ModpackFiles,
+ CacheValue::EmbeddedContentMetadata(_) => {
+ CacheValueType::EmbeddedContentMetadata
+ }
CacheValue::ProjectVersions(_) => CacheValueType::ProjectVersions,
}
}
@@ -690,6 +742,7 @@ impl CacheValue {
CacheValue::Project(project) => project.id.clone(),
CacheValue::ProjectV3(project) => project.id.clone(),
CacheValue::Version(version) => version.id.clone(),
+ CacheValue::VersionV3(version) => version.id.clone(),
CacheValue::User(user) => user.id.clone(),
CacheValue::Team(members) => members
.iter()
@@ -724,6 +777,9 @@ impl CacheValue {
CacheValue::SearchResults(search) => search.search.clone(),
CacheValue::SearchResultsV3(search) => search.search.clone(),
CacheValue::ModpackFiles(files) => files.version_id.clone(),
+ CacheValue::EmbeddedContentMetadata(metadata) => {
+ metadata.cache_key.clone()
+ }
CacheValue::ProjectVersions(pv) => pv.project_id.clone(),
}
}
@@ -746,6 +802,7 @@ impl CacheValue {
| CacheValue::GameVersions(_)
| CacheValue::DonationPlatforms(_)
| CacheValue::Version(_)
+ | CacheValue::VersionV3(_)
| CacheValue::Team { .. }
| CacheValue::File { .. }
| CacheValue::LoaderManifest { .. }
@@ -753,6 +810,7 @@ impl CacheValue {
| CacheValue::SearchResults(_)
| CacheValue::SearchResultsV3(_)
| CacheValue::ModpackFiles(_)
+ | CacheValue::EmbeddedContentMetadata(_)
| CacheValue::ProjectVersions(_) => None,
}
}
@@ -762,6 +820,7 @@ impl CacheValue {
CacheValue::Project(project) => serde_json::to_value(project),
CacheValue::ProjectV3(project) => serde_json::to_value(project),
CacheValue::Version(version) => serde_json::to_value(version),
+ CacheValue::VersionV3(version) => serde_json::to_value(version),
CacheValue::User(user) => serde_json::to_value(user),
CacheValue::Team(members) => serde_json::to_value(members),
CacheValue::Organization(org) => serde_json::to_value(org),
@@ -788,6 +847,9 @@ impl CacheValue {
CacheValue::SearchResults(search) => serde_json::to_value(search),
CacheValue::SearchResultsV3(search) => serde_json::to_value(search),
CacheValue::ModpackFiles(files) => serde_json::to_value(files),
+ CacheValue::EmbeddedContentMetadata(metadata) => {
+ serde_json::to_value(metadata)
+ }
CacheValue::ProjectVersions(pv) => serde_json::to_value(pv),
}
.map_err(|err| {
@@ -898,6 +960,7 @@ impl_cache_methods!(
(Project, Project),
(ProjectV3, ProjectV3),
(Version, Version),
+ (VersionV3, VersionV3),
(User, User),
(Team, Vec),
(Organization, Organization),
@@ -905,6 +968,7 @@ impl_cache_methods!(
(LoaderManifest, CachedLoaderManifest),
(FileHash, CachedFileHash),
(FileUpdate, CachedFileUpdate),
+ (EmbeddedContentMetadata, CachedEmbeddedContentMetadata),
(SearchResults, SearchResults),
(SearchResultsV3, SearchResultsV3)
);
@@ -1274,6 +1338,15 @@ impl CachedEntry {
CacheValue::Version
)
}
+ CacheValueType::VersionV3 => {
+ fetch_original_values!(
+ VersionV3,
+ env!("MODRINTH_API_URL_V3"),
+ "versions",
+ Some("/v3/versions"),
+ CacheValue::VersionV3
+ )
+ }
CacheValueType::User => {
fetch_original_values!(
User,
@@ -1855,6 +1928,10 @@ impl CachedEntry {
// not fetched from an external API
vec![]
}
+ CacheValueType::EmbeddedContentMetadata => {
+ // Embedded content metadata is populated from local archives.
+ vec![]
+ }
CacheValueType::ProjectVersions => {
let mut values = vec![];
@@ -1976,6 +2053,9 @@ impl CachedEntry {
CacheValueType::Version => {
CacheValue::Version(parse(data, id, "version")?)
}
+ CacheValueType::VersionV3 => {
+ CacheValue::VersionV3(parse(data, id, "version_v3")?)
+ }
CacheValueType::User => CacheValue::User(parse(data, id, "user")?),
CacheValueType::Team => CacheValue::Team(parse(data, id, "team")?),
CacheValueType::Organization => {
@@ -2018,6 +2098,13 @@ impl CachedEntry {
CacheValueType::ModpackFiles => {
CacheValue::ModpackFiles(parse(data, id, "modpack_files")?)
}
+ CacheValueType::EmbeddedContentMetadata => {
+ CacheValue::EmbeddedContentMetadata(parse(
+ data,
+ id,
+ "embedded_content_metadata",
+ )?)
+ }
CacheValueType::ProjectVersions => CacheValue::ProjectVersions(
parse(data, id, "project_versions")?,
),
diff --git a/packages/app-lib/src/state/dirs.rs b/packages/app-lib/src/state/dirs.rs
index c3bcd37d0d..e3fb378608 100644
--- a/packages/app-lib/src/state/dirs.rs
+++ b/packages/app-lib/src/state/dirs.rs
@@ -253,8 +253,8 @@ impl DirectoryInfo {
if prev_dir != move_dir {
let loader_bar_id = init_loading(
LoadingBarType::DirectoryMove {
- old: prev_dir.clone(),
- new: move_dir.clone(),
+ old: prev_dir.to_string_lossy().into_owned(),
+ new: move_dir.to_string_lossy().into_owned(),
},
100.0,
"Moving launcher directory",
diff --git a/packages/app-lib/src/state/friends.rs b/packages/app-lib/src/state/friends.rs
index 435813a133..ebf250e69f 100644
--- a/packages/app-lib/src/state/friends.rs
+++ b/packages/app-lib/src/state/friends.rs
@@ -192,11 +192,11 @@ impl FriendsSocket {
match server_message {
ServerToClientMessage::StatusUpdate { status } => {
statuses.insert(status.user_id, status.clone());
- let _ = emit_friend(FriendPayload::StatusUpdate { user_status: status }).await;
+ let _ = emit_friend(FriendPayload::StatusUpdate { user_status: status.into() }).await;
},
ServerToClientMessage::UserOffline { id } => {
statuses.remove(&id);
- let _ = emit_friend(FriendPayload::UserOffline { id }).await;
+ let _ = emit_friend(FriendPayload::UserOffline { id: id.to_string() }).await;
}
ServerToClientMessage::FriendStatuses { statuses: new_statuses } => {
statuses.clear();
@@ -206,7 +206,7 @@ impl FriendsSocket {
let _ = emit_friend(FriendPayload::StatusSync).await;
}
ServerToClientMessage::FriendRequest { from } => {
- let _ = emit_friend(FriendPayload::FriendRequest { from }).await;
+ let _ = emit_friend(FriendPayload::FriendRequest { from: from.to_string() }).await;
}
ServerToClientMessage::FriendRequestRejected { .. } => {}, // TODO
diff --git a/packages/app-lib/src/state/instance_types.rs b/packages/app-lib/src/state/instance_types.rs
index c3b6567fa3..abb8bbca89 100644
--- a/packages/app-lib/src/state/instance_types.rs
+++ b/packages/app-lib/src/state/instance_types.rs
@@ -73,6 +73,10 @@ impl LauncherFeatureVersion {
}
#[derive(Debug, Eq, PartialEq, Clone, Copy, Deserialize, Serialize)]
+#[cfg_attr(
+ feature = "export-ts",
+ derive(ts_rs::TS, postcard_bindgen::PostcardBindings)
+)]
#[serde(rename_all = "lowercase")]
pub enum ModLoader {
Vanilla,
@@ -120,6 +124,7 @@ pub struct ContentFile {
pub hash: String,
pub file_name: String,
pub enabled: bool,
+ pub locked: bool,
pub size: u64,
pub metadata: Option,
pub update_version_id: Option,
diff --git a/packages/app-lib/src/state/instances/adapters/sqlite/content_rows.rs b/packages/app-lib/src/state/instances/adapters/sqlite/content_rows.rs
index ff51044eb7..3de9b7f54b 100644
--- a/packages/app-lib/src/state/instances/adapters/sqlite/content_rows.rs
+++ b/packages/app-lib/src/state/instances/adapters/sqlite/content_rows.rs
@@ -9,6 +9,7 @@ use crate::state::instances::{
use crate::state::{ModLoader, ProjectType, ReleaseChannel};
use chrono::{DateTime, TimeZone, Utc};
use sqlx::{Executor, Sqlite, SqlitePool, Transaction};
+use std::collections::HashSet;
use uuid::Uuid;
#[derive(Debug, sqlx::FromRow)]
@@ -529,6 +530,89 @@ where
rows.into_iter().map(TryInto::try_into).collect()
}
+pub(crate) async fn get_locked_instance_file_ids(
+ instance_id: &str,
+ pool: &SqlitePool,
+) -> crate::Result> {
+ let file_ids = sqlx::query_scalar::<_, String>(
+ "
+ SELECT content_lock.file_id
+ FROM instance_content_locks content_lock
+ INNER JOIN instance_files file ON file.id = content_lock.file_id
+ WHERE file.instance_id = ?
+ ",
+ )
+ .bind(instance_id)
+ .fetch_all(pool)
+ .await?;
+
+ Ok(file_ids.into_iter().collect())
+}
+
+pub(crate) async fn is_instance_file_locked(
+ instance_id: &str,
+ relative_path: &str,
+ pool: &SqlitePool,
+) -> crate::Result {
+ let locked = sqlx::query_scalar::<_, i64>(
+ "
+ SELECT EXISTS (
+ SELECT 1
+ FROM instance_content_locks content_lock
+ INNER JOIN instance_files file ON file.id = content_lock.file_id
+ WHERE file.instance_id = ? AND file.relative_path = ?
+ )
+ ",
+ )
+ .bind(instance_id)
+ .bind(relative_path)
+ .fetch_one(pool)
+ .await?;
+
+ Ok(locked != 0)
+}
+
+pub(crate) async fn set_instance_file_locked(
+ instance_id: &str,
+ relative_path: &str,
+ locked: bool,
+ pool: &SqlitePool,
+) -> crate::Result<()> {
+ let file =
+ get_instance_file_by_relative_path(instance_id, relative_path, pool)
+ .await?
+ .ok_or_else(|| {
+ crate::ErrorKind::InputError(format!(
+ "Unknown content file {relative_path}"
+ ))
+ })?;
+
+ if locked {
+ sqlx::query(
+ "
+ INSERT INTO instance_content_locks (file_id)
+ VALUES (?)
+ ON CONFLICT (file_id) DO NOTHING
+ ",
+ )
+ .bind(&file.id)
+ .execute(pool)
+ .await?;
+ } else {
+ sqlx::query(
+ "
+ DELETE FROM instance_content_locks
+ WHERE file_id = ?
+ ",
+ )
+ .bind(&file.id)
+ .execute(pool)
+ .await?;
+ }
+
+ Ok(())
+}
+
pub(crate) async fn set_instance_file_missing(
file_id: &str,
missing: bool,
diff --git a/packages/app-lib/src/state/instances/commands/apply_content_install.rs b/packages/app-lib/src/state/instances/commands/apply_content_install.rs
index c3e036d537..b2b9c5b640 100644
--- a/packages/app-lib/src/state/instances/commands/apply_content_install.rs
+++ b/packages/app-lib/src/state/instances/commands/apply_content_install.rs
@@ -513,7 +513,9 @@ pub(crate) async fn add_project_bytes(
let scope = resolve_content_scope(instance_id, None, state).await?;
let project_type = match project_type {
Some(project_type) => project_type,
- None => infer_project_type(&bytes)?,
+ None => {
+ super::embedded_content_metadata::infer_project_type_bytes(&bytes)?
+ }
};
let relative_path = format!("{}/{}", project_type.get_folder(), file_name);
let full_path =
@@ -793,6 +795,37 @@ pub(crate) async fn content_source_kind_for_project_path(
}))
}
+pub(crate) async fn is_project_locked(
+ instance_id: &str,
+ project_path: &str,
+ state: &State,
+) -> crate::Result {
+ let scope = resolve_content_scope(instance_id, None, state).await?;
+ content_rows::is_instance_file_locked(
+ &scope.instance.id,
+ project_path,
+ &state.pool,
+ )
+ .await
+}
+
+pub(crate) async fn set_project_locked(
+ instance_id: &str,
+ project_path: &str,
+ locked: bool,
+ state: &State,
+) -> crate::Result<()> {
+ let _content_lock = state.lock_instance_content(instance_id).await;
+ let scope = resolve_content_scope(instance_id, None, state).await?;
+ content_rows::set_instance_file_locked(
+ &scope.instance.id,
+ project_path,
+ locked,
+ &state.pool,
+ )
+ .await
+}
+
pub(crate) async fn rename_project_companion_file(
instance_id: &str,
old_project_path: &str,
@@ -940,37 +973,3 @@ async fn upsert_entry_for_file(
Ok(())
}
-
-fn infer_project_type(bytes: &Bytes) -> crate::Result {
- let cursor = std::io::Cursor::new(&**bytes);
- let mut archive = zip::ZipArchive::new(cursor).map_err(|_| {
- crate::ErrorKind::InputError(
- "Unable to infer project type for input file".to_string(),
- )
- })?;
-
- if archive.by_name("fabric.mod.json").is_ok()
- || archive.by_name("quilt.mod.json").is_ok()
- || archive.by_name("META-INF/neoforge.mods.toml").is_ok()
- || archive.by_name("META-INF/mods.toml").is_ok()
- || archive.by_name("mcmod.info").is_ok()
- {
- Ok(ProjectType::Mod)
- } else if archive.by_name("pack.mcmeta").is_ok() {
- if archive.file_names().any(|name| name.starts_with("data/")) {
- Ok(ProjectType::DataPack)
- } else {
- Ok(ProjectType::ResourcePack)
- }
- } else if archive
- .file_names()
- .any(|name| name.starts_with("shaders/"))
- {
- Ok(ProjectType::ShaderPack)
- } else {
- Err(crate::ErrorKind::InputError(
- "Unable to infer project type for input file".to_string(),
- )
- .into())
- }
-}
diff --git a/packages/app-lib/src/state/instances/commands/apply_content_update.rs b/packages/app-lib/src/state/instances/commands/apply_content_update.rs
index 232e361305..beb8a45b80 100644
--- a/packages/app-lib/src/state/instances/commands/apply_content_update.rs
+++ b/packages/app-lib/src/state/instances/commands/apply_content_update.rs
@@ -461,10 +461,11 @@ async fn bulk_updateable_project_paths(
Ok(items
.into_iter()
.filter(|item| {
- !shared_instance_member
- || !item
- .source_kind
- .is_some_and(ContentSourceKind::is_shared_instance_managed)
+ !item.locked
+ && (!shared_instance_member
+ || !item.source_kind.is_some_and(
+ ContentSourceKind::is_shared_instance_managed,
+ ))
})
.map(|item| item.file_path)
.collect())
diff --git a/packages/app-lib/src/state/instances/commands/embedded_content_metadata.rs b/packages/app-lib/src/state/instances/commands/embedded_content_metadata.rs
new file mode 100644
index 0000000000..5cbe2083f1
--- /dev/null
+++ b/packages/app-lib/src/state/instances/commands/embedded_content_metadata.rs
@@ -0,0 +1,611 @@
+use crate::state::{
+ CacheValue, CachedEmbeddedContentMetadata, CachedEntry, ContentFile,
+ EmbeddedContentMetadata, Instance, ModLoader, ProjectType, State,
+};
+use bytes::Bytes;
+use futures::stream::{self, StreamExt};
+use serde_json::Value as JsonValue;
+use std::collections::{HashMap, HashSet};
+use std::fs::File;
+use std::io::{Cursor, Read, Seek};
+use std::path::Path;
+use toml::Value as TomlValue;
+use zip::ZipArchive;
+
+const MAX_METADATA_BYTES: u64 = 1024 * 1024;
+const MAX_ICON_BYTES: u64 = 8 * 1024 * 1024;
+const PREFERRED_ICON_SIZE: u32 = 96;
+const MAX_NAME_CHARS: usize = 256;
+const MAX_VERSION_CHARS: usize = 128;
+
+pub(crate) struct ArchiveInspection {
+ pub metadata: Option,
+ pub icon: Option,
+}
+
+#[derive(Clone, Copy)]
+enum ModMetadataKind {
+ Fabric,
+ Quilt,
+ NeoForge,
+ Forge,
+ LegacyForge,
+}
+
+pub(crate) fn infer_project_type_bytes(
+ bytes: &Bytes,
+) -> crate::Result {
+ let mut archive = ZipArchive::new(Cursor::new(&**bytes)).map_err(|_| {
+ crate::ErrorKind::InputError(
+ "Unable to infer project type for input file".to_string(),
+ )
+ })?;
+ infer_project_type(&mut archive)
+}
+
+fn inspect_content_file(
+ path: &Path,
+ loader: ModLoader,
+) -> crate::Result {
+ let file = File::open(path).map_err(|error| {
+ crate::ErrorKind::OtherError(format!(
+ "Could not open content archive {}: {error}",
+ path.display()
+ ))
+ })?;
+ inspect_content_archive(file, Some(loader))
+}
+
+fn inspect_content_archive(
+ reader: R,
+ loader: Option,
+) -> crate::Result {
+ let mut archive = ZipArchive::new(reader).map_err(|_| {
+ crate::ErrorKind::InputError(
+ "Unable to infer project type for input file".to_string(),
+ )
+ })?;
+ let project_type = infer_project_type(&mut archive)?;
+ let (metadata, icon) = match project_type {
+ ProjectType::Mod => inspect_mod(&mut archive, loader),
+ ProjectType::DataPack | ProjectType::ResourcePack => {
+ inspect_pack(&mut archive)
+ }
+ ProjectType::ShaderPack => (None, None),
+ };
+
+ Ok(ArchiveInspection { metadata, icon })
+}
+
+fn infer_project_type(
+ archive: &mut ZipArchive,
+) -> crate::Result {
+ if has_entry(archive, "fabric.mod.json")
+ || has_entry(archive, "quilt.mod.json")
+ || has_entry(archive, "META-INF/neoforge.mods.toml")
+ || has_entry(archive, "META-INF/mods.toml")
+ || has_entry(archive, "mcmod.info")
+ {
+ Ok(ProjectType::Mod)
+ } else if has_entry(archive, "pack.mcmeta") {
+ if archive.file_names().any(|name| name.starts_with("data/")) {
+ Ok(ProjectType::DataPack)
+ } else {
+ Ok(ProjectType::ResourcePack)
+ }
+ } else if archive
+ .file_names()
+ .any(|name| name.starts_with("shaders/"))
+ {
+ Ok(ProjectType::ShaderPack)
+ } else {
+ Err(crate::ErrorKind::InputError(
+ "Unable to infer project type for input file".to_string(),
+ )
+ .into())
+ }
+}
+
+fn inspect_pack(
+ archive: &mut ZipArchive,
+) -> (Option, Option) {
+ let icon = read_icon_entry(archive, "pack.png");
+ let metadata = EmbeddedContentMetadata::default();
+
+ if metadata.is_empty() && icon.is_none() {
+ (None, None)
+ } else {
+ (Some(metadata), icon)
+ }
+}
+
+fn inspect_mod(
+ archive: &mut ZipArchive,
+ loader: Option,
+) -> (Option, Option) {
+ let manifest = read_manifest(archive);
+ let order = metadata_order(loader);
+ let parsed = order.iter().find_map(|kind| match kind {
+ ModMetadataKind::Fabric => parse_fabric_metadata(archive),
+ ModMetadataKind::Quilt => parse_quilt_metadata(archive),
+ ModMetadataKind::NeoForge => parse_toml_metadata(
+ archive,
+ "META-INF/neoforge.mods.toml",
+ &manifest,
+ ),
+ ModMetadataKind::Forge => {
+ parse_toml_metadata(archive, "META-INF/mods.toml", &manifest)
+ }
+ ModMetadataKind::LegacyForge => parse_legacy_forge_metadata(archive),
+ });
+ let (mut metadata, icon_path) =
+ parsed.unwrap_or_else(|| (EmbeddedContentMetadata::default(), None));
+
+ if metadata.name.is_none() {
+ metadata.name = manifest
+ .get("implementation-title")
+ .and_then(|value| clean_string(value, MAX_NAME_CHARS));
+ }
+ if metadata.version.is_none() {
+ metadata.version = manifest
+ .get("implementation-version")
+ .and_then(|value| clean_string(value, MAX_VERSION_CHARS));
+ }
+
+ let icon = icon_path
+ .as_deref()
+ .and_then(|path| read_icon_entry(archive, path));
+ if metadata.is_empty() && icon.is_none() {
+ (None, None)
+ } else {
+ (Some(metadata), icon)
+ }
+}
+
+fn metadata_order(loader: Option) -> [ModMetadataKind; 5] {
+ match loader {
+ Some(ModLoader::Fabric) => [
+ ModMetadataKind::Fabric,
+ ModMetadataKind::Quilt,
+ ModMetadataKind::NeoForge,
+ ModMetadataKind::Forge,
+ ModMetadataKind::LegacyForge,
+ ],
+ Some(ModLoader::Quilt) => [
+ ModMetadataKind::Quilt,
+ ModMetadataKind::Fabric,
+ ModMetadataKind::NeoForge,
+ ModMetadataKind::Forge,
+ ModMetadataKind::LegacyForge,
+ ],
+ Some(ModLoader::Forge) => [
+ ModMetadataKind::Forge,
+ ModMetadataKind::LegacyForge,
+ ModMetadataKind::NeoForge,
+ ModMetadataKind::Fabric,
+ ModMetadataKind::Quilt,
+ ],
+ Some(ModLoader::NeoForge) => [
+ ModMetadataKind::NeoForge,
+ ModMetadataKind::Forge,
+ ModMetadataKind::LegacyForge,
+ ModMetadataKind::Fabric,
+ ModMetadataKind::Quilt,
+ ],
+ Some(ModLoader::Vanilla) | None => [
+ ModMetadataKind::Fabric,
+ ModMetadataKind::Quilt,
+ ModMetadataKind::NeoForge,
+ ModMetadataKind::Forge,
+ ModMetadataKind::LegacyForge,
+ ],
+ }
+}
+
+fn parse_fabric_metadata(
+ archive: &mut ZipArchive,
+) -> Option<(EmbeddedContentMetadata, Option)> {
+ let root = read_json_entry(archive, "fabric.mod.json")?;
+ let metadata = EmbeddedContentMetadata {
+ name: root
+ .get("name")
+ .and_then(JsonValue::as_str)
+ .or_else(|| root.get("id").and_then(JsonValue::as_str))
+ .and_then(|value| clean_string(value, MAX_NAME_CHARS)),
+ version: root
+ .get("version")
+ .and_then(json_scalar_string)
+ .and_then(|value| clean_string(&value, MAX_VERSION_CHARS)),
+ ..Default::default()
+ };
+ let icon = root.get("icon").and_then(json_icon_path);
+ Some((metadata, icon))
+}
+
+fn parse_quilt_metadata(
+ archive: &mut ZipArchive,
+) -> Option<(EmbeddedContentMetadata, Option)> {
+ let text = read_text_entry(archive, "quilt.mod.json")?;
+ let root = json5::from_str::(&text).ok()?;
+ let loader = root.get("quilt_loader").unwrap_or(&root);
+ let display = loader.get("metadata").unwrap_or(loader);
+ let metadata = EmbeddedContentMetadata {
+ name: display
+ .get("name")
+ .and_then(JsonValue::as_str)
+ .or_else(|| loader.get("id").and_then(JsonValue::as_str))
+ .and_then(|value| clean_string(value, MAX_NAME_CHARS)),
+ version: loader
+ .get("version")
+ .and_then(json_scalar_string)
+ .and_then(|value| clean_string(&value, MAX_VERSION_CHARS)),
+ ..Default::default()
+ };
+ let icon = display
+ .get("icon")
+ .or_else(|| loader.get("icon"))
+ .and_then(json_icon_path);
+ Some((metadata, icon))
+}
+
+fn parse_toml_metadata(
+ archive: &mut ZipArchive,
+ path: &str,
+ manifest: &HashMap,
+) -> Option<(EmbeddedContentMetadata, Option)> {
+ let text = read_text_entry(archive, path)?;
+ let root = toml::from_str::(&text).ok()?;
+ let mod_table = root.get("mods")?.as_array()?.first()?.as_table()?;
+ let name = mod_table
+ .get("displayName")
+ .or_else(|| mod_table.get("modId"))
+ .and_then(toml_scalar_string)
+ .and_then(|value| clean_string(&value, MAX_NAME_CHARS));
+ let version = mod_table
+ .get("version")
+ .and_then(toml_scalar_string)
+ .and_then(|value| resolve_toml_value(&value, &root, manifest))
+ .and_then(|value| clean_string(&value, MAX_VERSION_CHARS));
+ let icon = mod_table
+ .get("logoFile")
+ .and_then(TomlValue::as_str)
+ .and_then(safe_archive_path);
+
+ Some((
+ EmbeddedContentMetadata {
+ name,
+ version,
+ ..Default::default()
+ },
+ icon,
+ ))
+}
+
+fn parse_legacy_forge_metadata(
+ archive: &mut ZipArchive,
+) -> Option<(EmbeddedContentMetadata, Option)> {
+ let root = read_json_entry(archive, "mcmod.info")?;
+ let entry = root
+ .as_array()
+ .and_then(|entries| entries.first())
+ .or_else(|| {
+ root.get("modList")
+ .and_then(JsonValue::as_array)
+ .and_then(|entries| entries.first())
+ })?;
+ let metadata = EmbeddedContentMetadata {
+ name: entry
+ .get("name")
+ .and_then(JsonValue::as_str)
+ .or_else(|| entry.get("modid").and_then(JsonValue::as_str))
+ .and_then(|value| clean_string(value, MAX_NAME_CHARS)),
+ version: entry
+ .get("version")
+ .and_then(json_scalar_string)
+ .and_then(|value| clean_string(&value, MAX_VERSION_CHARS)),
+ ..Default::default()
+ };
+ let icon = entry
+ .get("logoFile")
+ .and_then(JsonValue::as_str)
+ .and_then(safe_archive_path);
+ Some((metadata, icon))
+}
+
+fn resolve_toml_value(
+ value: &str,
+ root: &TomlValue,
+ manifest: &HashMap,
+) -> Option {
+ if value == "${file.jarVersion}" {
+ return manifest.get("implementation-version").cloned();
+ }
+ if let Some(key) = value
+ .strip_prefix("${file.")
+ .and_then(|value| value.strip_suffix('}'))
+ {
+ return root
+ .get("properties")
+ .and_then(TomlValue::as_table)
+ .and_then(|properties| properties.get(key))
+ .and_then(toml_scalar_string);
+ }
+ Some(value.to_string())
+}
+
+fn json_icon_path(value: &JsonValue) -> Option {
+ if let Some(path) = value.as_str() {
+ return safe_archive_path(path);
+ }
+ let icons = value.as_object()?;
+ let mut candidates = icons
+ .iter()
+ .filter_map(|(size, path)| {
+ Some((
+ size.parse::().ok()?,
+ safe_archive_path(path.as_str()?)?,
+ ))
+ })
+ .collect::>();
+ candidates.sort_by_key(|(size, _)| *size);
+ candidates
+ .iter()
+ .find(|(size, _)| *size >= PREFERRED_ICON_SIZE)
+ .or_else(|| candidates.last())
+ .map(|(_, path)| path.clone())
+}
+
+fn safe_archive_path(path: &str) -> Option {
+ let path = path.trim().trim_start_matches('/');
+ if path.is_empty()
+ || path.contains('\0')
+ || path.contains('\\')
+ || path
+ .split('/')
+ .any(|part| part.is_empty() || part == "." || part == "..")
+ {
+ return None;
+ }
+ Some(path.to_string())
+}
+
+fn clean_string(value: &str, max_chars: usize) -> Option {
+ let value = value.trim();
+ if value.is_empty() || value.contains("${") {
+ return None;
+ }
+ let value = value
+ .chars()
+ .filter(|character| !character.is_control())
+ .take(max_chars)
+ .collect::();
+ (!value.is_empty()).then_some(value)
+}
+
+fn json_scalar_string(value: &JsonValue) -> Option {
+ match value {
+ JsonValue::String(value) => Some(value.clone()),
+ JsonValue::Number(value) => Some(value.to_string()),
+ _ => None,
+ }
+}
+
+fn toml_scalar_string(value: &TomlValue) -> Option {
+ match value {
+ TomlValue::String(value) => Some(value.clone()),
+ TomlValue::Integer(value) => Some(value.to_string()),
+ TomlValue::Float(value) => Some(value.to_string()),
+ _ => None,
+ }
+}
+
+fn read_manifest(
+ archive: &mut ZipArchive,
+) -> HashMap
-
+
{{
formatMessage(messages.whatReportReason, {
item: formatReportItemType(formatMessage, reportItem),
@@ -211,7 +211,7 @@
}}
- {{ item === 'copyright' ? 'Reuploaded work' : capitalizeString(item) }}
+ {{ formatReportType(formatMessage, item) }}
-
+
{{ formatMessage(messages.reportBodyTitle) }}
@@ -255,7 +256,7 @@
id="submit-button"
type="colored"
color="brand"
- :disabled="submitLoading || !canSubmit"
+ :disabled="submitLoading || !canSubmit || disableReporting"
@click="submitReport"
>
@@ -291,6 +292,7 @@ import {
defineMessage,
defineMessages,
formatReportItemType,
+ formatReportType,
injectNotificationManager,
IntlFormatted,
MarkdownEditor,
@@ -410,10 +412,18 @@ async function fetchItem() {
}
const reportItems = ['project', 'version', 'user']
-const reportTypes = computed(() => tags.value.reportTypes)
+const reportTypes = computed(() => {
+ const types = [...tags.value.reportTypes]
+ if (reportItem.value === 'project') {
+ types.push('missing-disclosure')
+ }
+ return types
+})
+const disableReporting = computed(() => reportType.value === 'missing-disclosure')
const canSubmit = computed(() => {
return (
+ !disableReporting.value &&
reportItem.value !== '' &&
reportItemID.value !== '' &&
reportType.value !== '' &&
@@ -546,6 +556,17 @@ const warnings: Record
@@ -247,6 +247,7 @@