Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,7 @@ consts = "consts"
Cpy = "Cpy"

[default.extend-identifiers]
# BTA dependency project name
HalpLibe = "HalpLibe"
# Constant from the `zip` crate
ZIP64_BYTES_THR = "ZIP64_BYTES_THR"
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ const versionTypes = computed(
() =>
[
!editingVersion && { class: 'text-sm', value: 'primary', label: fileTypeLabels.primary },
{ class: 'text-sm', value: 'unknown', label: fileTypeLabels.unknown },
isDatapackProject.value && {
class: 'text-sm',
value: 'required-resource-pack',
Expand Down
12 changes: 9 additions & 3 deletions apps/labrinth/fixtures/dummy_data.sql
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,16 @@ INSERT INTO loaders (id, loader) VALUES (9, 'datapack');

INSERT INTO loaders_project_types (joining_loader_id, joining_project_type_id)
SELECT l.id, pt.id
FROM loaders l
CROSS JOIN project_types pt
FROM
loaders AS l
CROSS JOIN project_types AS pt
WHERE
(l.loader IN ('bukkit', 'waterfall') AND pt.name = 'plugin')
OR (l.loader = 'datapack' AND pt.name = 'datapack');

INSERT INTO loaders_project_types_games (loader_id, project_type_id, game_id)
SELECT lpt.joining_loader_id, lpt.joining_project_type_id, 1
FROM loaders_project_types lpt
FROM loaders_project_types AS lpt
WHERE lpt.joining_loader_id IN (7, 8, 9);

-- Adds dummies to mrpack_loaders
Expand Down Expand Up @@ -74,6 +75,11 @@ ON CONFLICT DO NOTHING;
-- Sample game versions, loaders, categories
-- Game versions is '2'
INSERT INTO loader_field_enum_values (enum_id, value, metadata, created)
VALUES
(2, '1.3', '{"type":"snapshot","major":false}', '2012-07-25 22:00:00+00'),
(2, '1.13.2', '{"type":"release","major":false}', '2018-10-22 11:41:07+00'),
(2, '18w43b', '{"type":"snapshot","major":false}', '2018-10-24 15:02:30+00');
INSERT INTO loader_field_enum_values (enum_id, value, metadata, created)
VALUES (2, '1.20.1', '{"type":"release","major":false}', '2021-08-18 15:48:58.435729+00');
INSERT INTO loader_field_enum_values (enum_id, value, metadata, created)
VALUES (2, '1.20.2', '{"type":"release","major":false}', '2021-08-18 15:48:59.435729+00');
Expand Down
1 change: 1 addition & 0 deletions apps/labrinth/src/routes/v3/version_creation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1003,6 +1003,7 @@ pub async fn upload_file(
loaders.clone(),
file_type,
version_fields.to_vec(),
dependencies,
&mut *transaction,
redis,
)
Expand Down
2 changes: 1 addition & 1 deletion apps/labrinth/src/test/dummy_data.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ use super::{

use super::{database::USER_USER_ID, get_json_val_str};

pub const DUMMY_DATA_UPDATE: i64 = 9;
pub const DUMMY_DATA_UPDATE: i64 = 10;

pub const DUMMY_CATEGORIES: &[&str] = &[
"combat",
Expand Down
100 changes: 100 additions & 0 deletions apps/labrinth/src/validate/fabric.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
use crate::database::models::legacy_loader_fields::MinecraftGameVersion;
use crate::models::projects::Loader;
use crate::validate::{
SupportedGameVersions, ValidationError, ValidationResult,
validate_pack_formats,
};
use eyre::eyre;
use std::io::Cursor;
use zip::ZipArchive;

Expand All @@ -20,6 +23,35 @@ impl super::Validator for FabricValidator {
SupportedGameVersions::All
}

fn ensure_required_loaders(
&self,
archive: &mut ZipArchive<Cursor<bytes::Bytes>>,
loaders: &[Loader],
) -> Result<(), ValidationError> {
if loaders.iter().any(|loader| loader.0 == "bta-babric") {
return Ok(());
}

let manifest = match archive.by_name("fabric.mod.json") {
Ok(manifest) => manifest,
Err(zip::result::ZipError::FileNotFound) => return Ok(()),
Err(error) => return Err(error.into()),
};

let Ok(metadata) =
serde_json::from_reader::<_, serde_json::Value>(manifest)
else {
return Ok(());
};

if has_bta_loader_dependency(&metadata["depends"]["fabricloader"]) {
return Err(ValidationError::InvalidInput(
"files whose `fabric.mod.json` requires a `fabricloader` version containing `-bta.` must include the `bta-babric` loader".into(),
));
}
Ok(())
}

fn validate(
&self,
archive: &mut ZipArchive<Cursor<bytes::Bytes>>,
Expand All @@ -33,3 +65,71 @@ impl super::Validator for FabricValidator {
Ok(validate_pack_formats(archive))
}
}

fn has_bta_loader_dependency(requirement: &serde_json::Value) -> bool {
match requirement {
serde_json::Value::String(range) => range.contains("-bta."),
serde_json::Value::Array(ranges) => {
ranges.iter().any(has_bta_loader_dependency)
}
_ => false,
}
}

pub(super) fn validate_game_versions(
loaders: &[Loader],
game_versions: &[MinecraftGameVersion],
all_game_versions: &[MinecraftGameVersion],
) -> Result<(), ValidationError> {
let release_date = |name: &str| {
all_game_versions
.iter()
.find(|version| version.version == name)
.map(|version| version.created)
.ok_or_else(|| {
eyre!(
"missing minecraft game version `{name}` required for loader validation"
)
})
};

for loader in loaders {
let (valid, requirement) = match loader.0.as_str() {
"fabric" => {
let minimum = release_date("18w43b")?;
(
game_versions
.iter()
.all(|version| version.created >= minimum),
"`18w43b` or later",
)
}
"legacy-fabric" => {
let supported = release_date("1.3")?..=release_date("1.13.2")?;
(
game_versions
.iter()
.all(|version| supported.contains(&version.created)),
"between `1.3` and `1.13.2`, inclusive",
)
}
"babric" | "bta-babric" => (
game_versions
.iter()
.all(|version| version.version == "b1.7.3"),
"`b1.7.3` only",
),
_ => continue,
};
if game_versions.is_empty() || !valid {
return Err(ValidationError::InvalidInput(
format!(
"the `{}` loader requires minecraft versions {requirement}",
loader.0,
)
.into(),
));
}
}
Ok(())
}
124 changes: 121 additions & 3 deletions apps/labrinth/src/validate/mod.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
use crate::database::PgTransaction;
use crate::database::models::legacy_loader_fields::MinecraftGameVersion;
use crate::database::models::loader_fields::VersionField;
use crate::database::models::loader_fields::{
Loader as DBLoader, VersionField,
};
use crate::database::models::version_item::DependencyBuilder;
use crate::models::ids::ProjectId;
use crate::models::pack::PackFormat;
use crate::models::projects::{FileType, Loader};
use crate::models::projects::{DependencyType, FileType, Loader};
use crate::validate::datapack::DataPackValidator;
use crate::validate::fabric::FabricValidator;
use crate::validate::forge::{ForgeValidator, LegacyForgeValidator};
Expand All @@ -13,6 +17,7 @@ use crate::validate::plugin::*;
use crate::validate::quilt::QuiltValidator;
use crate::validate::resourcepack::{PackValidator, TexturePackValidator};
use crate::validate::rift::RiftValidator;
use crate::validate::risugami::RisugamiValidator;
use crate::validate::shader::{
CanvasShaderValidator, CoreShaderValidator, ShaderValidator,
};
Expand All @@ -37,8 +42,12 @@ pub mod project;
mod quilt;
mod resourcepack;
mod rift;
mod risugami;
mod shader;

// BTA loader must exist if HalpLibe project is selected as a dependency
const HALPLIBE_PROJECT_ID: &str = "IIu8YulV";

#[derive(Error, Debug)]
pub enum ValidationError {
#[error("Unable to read Zip Archive: {0}")]
Expand Down Expand Up @@ -95,6 +104,14 @@ pub trait Validator: Sync {
fn get_supported_loaders(&self) -> &[&str];
fn get_supported_game_versions(&self) -> SupportedGameVersions;

fn ensure_required_loaders(
&self,
_archive: &mut ZipArchive<Cursor<Bytes>>,
_loaders: &[Loader],
) -> Result<(), ValidationError> {
Ok(())
}

fn validate(
&self,
archive: &mut ZipArchive<Cursor<bytes::Bytes>>,
Expand Down Expand Up @@ -139,11 +156,13 @@ static VALIDATORS: &[&dyn Validator] = &[
&BungeeCordValidator,
&VelocityValidator,
&SpongeValidator,
&GeyserValidator,
&CanvasShaderValidator,
&ShaderValidator,
&CoreShaderValidator,
&DataPackValidator,
&RiftValidator,
&RisugamiValidator,
&NeoForgeValidator,
];

Expand Down Expand Up @@ -178,6 +197,7 @@ pub async fn validate_file(
loaders: Vec<Loader>,
file_type: Option<FileType>,
version_fields: Vec<VersionField>,
dependencies: &[DependencyBuilder],
transaction: &mut PgTransaction<'_>,
redis: &RedisPool,
) -> Result<ValidationResult, ValidationError> {
Expand All @@ -189,6 +209,18 @@ pub async fn validate_file(
MinecraftGameVersion::list(None, None, &mut *transaction, redis)
.await?;

let available_loaders = DBLoader::list(&mut *transaction, redis).await?;

validate_file_type_for_loaders(file_type, &loaders, &available_loaders)?;

validate_dependencies(&loaders, dependencies)?;

fabric::validate_game_versions(
&loaders,
&game_versions,
&all_game_versions,
)?;

validate_minecraft_file(
data,
file_extension,
Expand All @@ -200,6 +232,84 @@ pub async fn validate_file(
.await
}

fn validate_file_type_for_loaders(
file_type: Option<FileType>,
loaders: &[Loader],
available_loaders: &[DBLoader],
) -> Result<(), ValidationError> {
if matches!(
file_type,
Some(FileType::SourcesJar | FileType::DevJar | FileType::JavadocJar)
) {
let supports_jar_files = available_loaders
.iter()
.filter(|loader| {
loaders.iter().any(|selected| selected.0 == loader.loader)
})
.flat_map(|loader| &loader.supported_project_types)
.any(|project_type| {
matches!(project_type.as_str(), "mod" | "plugin")
});
if !supports_jar_files {
return Err(ValidationError::InvalidInput(
"sources, dev, and javadoc jars are only supported for mods and plugins".into(),
));
}
}
Ok(())
}

fn validate_dependencies(
loaders: &[Loader],
dependencies: &[DependencyBuilder],
) -> Result<(), ValidationError> {
if loaders
.iter()
.any(|loader| matches!(loader.0.as_str(), "bta-babric" | "mrpack"))
{
return Ok(());
}
if dependencies.iter().any(|dependency| {
dependency.dependency_type != DependencyType::Incompatible.as_str()
&& dependency.project_id.is_some_and(|id| {
ProjectId::from(id).to_string() == HALPLIBE_PROJECT_ID
})
}) {
return Err(ValidationError::InvalidInput(
"versions that depend on `halplibe` must include the `bta-babric` loader".into(),
));
}
Ok(())
}

fn validate_additional_jar(
file: &MaybeProtectedZipFile,
file_extension: &str,
file_type: FileType,
) -> Result<ValidationResult, ValidationError> {
if file_extension != "jar" {
return Err(ValidationError::InvalidInput(
"sources, dev, and javadoc jars must use the `.jar` extension"
.into(),
));
}

let MaybeProtectedZipFile::Unprotected(archive) = file else {
return Err(ValidationError::InvalidInput(
"additional jars must be readable jar archives".into(),
));
};

if file_type == FileType::SourcesJar
&& !archive.file_names().any(|name| name.ends_with(".java"))
{
return Err(ValidationError::InvalidInput(
"sources jars must contain at least one `.java` file".into(),
));
}
Ok(ValidationResult::Pass)
}

async fn validate_minecraft_file(
data: Bytes,
file_extension: String,
Expand All @@ -217,6 +327,12 @@ async fn validate_minecraft_file(
},
};

if let MaybeProtectedZipFile::Unprotected(archive) = &mut zip {
for validator in VALIDATORS {
validator.ensure_required_loaders(archive, &loaders)?;
}
}

if let Some(file_type) = file_type {
match file_type {
FileType::RequiredResourcePack | FileType::OptionalResourcePack => {
Expand All @@ -233,7 +349,9 @@ async fn validate_minecraft_file(
))
};
}
FileType::DevJar | FileType::SourcesJar | FileType::JavadocJar => {},
FileType::DevJar | FileType::SourcesJar | FileType::JavadocJar => {
return validate_additional_jar(&zip, &file_extension, file_type);
},
FileType::Unknown => {}
}
}
Expand Down
Loading
Loading