feat: add wgMwJsonAllowSubmitInvalide config var

OpenSemanticLab · Apr 13, 2024 · 4d46aa7 · 4d46aa7
1 parent 12ba08c
commit 4d46aa7
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 6 deletions.
diff --git a/extension.json b/extension.json
@@ -1,7 +1,7 @@
 {
     "manifest_version":2,
     "name":"MwJson",
-    "version":"0.36.0",
+    "version":"0.37.0",
     "author":[
         "[https://github.com/simontaurus Simon Stier]"
     ],
@@ -228,9 +228,16 @@
 		"SpecialSlotResolver": "special/SlotResolver.php"
     },
     "Hooks":{
-        "BeforePageDisplay":"MwJson::onBeforePageDisplay"
+        "BeforePageDisplay":"MwJson::onBeforePageDisplay",
+        "ResourceLoaderGetConfigVars": "MwJson::onResourceLoaderGetConfigVars"
     },
     "SpecialPages": {
 		"SlotResolver": "SpecialSlotResolver"
+    },
+    "config": {
+        "MwJsonAllowSubmitInvalide": {
+			"value": "always",
+			"description": "Forbid ('never'), conditional if set in schema option ('option') or always ('always') allow the user to save data failing schema validation."
+		}
     }
 }
diff --git a/includes/MwJson.php b/includes/MwJson.php
@@ -10,4 +10,9 @@ public static function onBeforePageDisplay( $out ) {
 
 	}
 
+	// see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderGetConfigVars
+	public static function onResourceLoaderGetConfigVars( array &$vars, $skin, Config $config ): void {
+		$vars['wgMwJsonAllowSubmitInvalide'] = $config->get( 'MwJsonAllowSubmitInvalide' );
+	}
+
 }
diff --git a/modules/ext.MwJson.editor/MwJson_editor.js b/modules/ext.MwJson.editor/MwJson_editor.js
@@ -9,7 +9,7 @@ mwjson.editor = class {
 			mode: "default", // options: default, query
 			copy: false, // editor is used to create a copy of an exiting entry => copy_ignore schema option is applied
 			submit_enabled: true, //if true, add save button
-			allow_submit_with_errors: true,
+			allow_submit_with_errors: undefined, //allow submitting forms even if schema validation fails (see option wgMwJsonAllowSubmitInvalide)
 			lang: mw.config.get('wgUserLanguage'),
 			format: {}, // e.g. datetime format
 			user_id: mw.config.get('wgUserName'),
@@ -70,9 +70,12 @@ mwjson.editor = class {
 	}
 
 	createEditor() {
-		//return function(err, config) {
-
-		//console.log(this);
+		// set allow_submit_with_errors if still undefined
+		if (this.config.allow_submit_with_errors !== true && this.config.allow_submit_with_errors != false) {
+			if (mw.config.get('wgMwJsonAllowSubmitInvalide') === "always") this.config.allow_submit_with_errors = true;
+			if (mw.config.get('wgMwJsonAllowSubmitInvalide') === "option") this.config.allow_submit_with_errors = this.schema?.options?.allow_submit_with_errors || false;
+			if (mw.config.get('wgMwJsonAllowSubmitInvalide') === "never") this.config.allow_submit_with_errors = false;
+		}
 
 		//JSONEditor.defaults.language = "de";
 		this.config.JSONEditorConfig = this.config.JSONEditorConfig || {};