add store state etc option, default off (#5969)

JorisGoosen · web-flow · commit 39dca0900135 · 2025-08-27T14:13:32.000+02:00
* add store state etc option, default off implements jasp-stats/INTERNAL-jasp#2915 Saving example file BFI Network goes from 2.3mb to 617kb * add extra property to analysis that stroes whether it was loaded with state and give the user a nice oui/non box on trying to resize or save plots
diff --git a/Common/tempfiles.cpp b/Common/tempfiles.cpp
@@ -247,6 +247,14 @@ void TempFiles::createSpecific(const string &name, int id, string &root, string
 	relativePath += "/" + name;
 }
 
+bool TempFiles::stateFileExists(int id)
+{
+	std::filesystem::path stateFilePath = Utils::osPath(_sessionDirName + "/resources" + (id >= 0 ? "/" + std::to_string(id) : "") + "/state");
+	
+	std::error_code error;
+	return std::filesystem::exists(stateFilePath, error) && !error;
+}
+
 void TempFiles::create(const string &extension, int id, string &root, string &relativePath)
 {
 	std::error_code error;
diff --git a/Common/tempfiles.h b/Common/tempfiles.h
@@ -55,6 +55,7 @@ class TempFiles
 
 	static std::string	sessionDirName() { return _sessionDirName; }
 	static stringvec	retrieveList(int id = -1);
+	static bool			stateFileExists(int id);
 
 	static void			deleteList(const stringvec &files);
 	static void			deleteAll(int id = -1);
diff --git a/Desktop/analysis/analyses.cpp b/Desktop/analysis/analyses.cpp
@@ -17,15 +17,16 @@
 //
 
 #include "analyses.h"
+#include "tempfiles.h"
 #include "utilities/settings.h"
+#include "gui/jaspConfiguration/jaspconfiguration.h"
 #include "modules/ribbonmodel.h"
 #include "analysisform.h"
 #include "knownissues.h"
 #include "timers.h"
 #include <QTimer>
 #include <QFile>
 #include "log.h"
-#include "gui/jaspConfiguration/jaspconfiguration.h"
 
 using namespace std;
 using Modules::Upgrader;
@@ -110,6 +111,9 @@ Analysis* Analyses::createFromJaspFileEntry(Json::Value analysisData, RibbonMode
 
 	if(wasUpgraded)
 		analysis->setUpgradeMsgs(msgs);
+	
+	if(!TempFiles::stateFileExists(id))
+		analysis->_storedWithoutState = true; //This will trigger the "you need a refresh" on resize
 
 	return analysis;
 }
diff --git a/Desktop/analysis/analysis.cpp b/Desktop/analysis/analysis.cpp
@@ -223,7 +223,8 @@ void Analysis::setResults(const Json::Value & results, Status status, const Json
 	if(_status == Analysis::Complete)
 		checkForRSources();
 
-	_wasUpgraded = false;
+	_wasUpgraded		= false;
+	_storedWithoutState = false;
 }
 
 void Analysis::exportResults()
@@ -473,9 +474,10 @@ void Analysis::setStatus(Analysis::Status status)
 		bool neededRefresh = needsRefresh();
 
 		TempFiles::deleteList(TempFiles::retrieveList(_id));
-		_wasUpgraded = false;
-
-		_moduleVersion = _dynamicModule ?  _dynamicModule->version() : AppInfo::version;
+		
+		_wasUpgraded		= false;
+		_storedWithoutState	= false;
+		_moduleVersion		= _dynamicModule ?  _dynamicModule->version() : AppInfo::version;
 
 		if(neededRefresh != needsRefresh())
 			emit needsRefreshChanged();
@@ -987,7 +989,7 @@ void Analysis::setUpgradeMsgs(const Modules::UpgradeMsgs &msgs)
 bool Analysis::needsRefresh() const
 {
 	bool differentVersion = _moduleVersion != (_dynamicModule ? _dynamicModule->version() : AppInfo::version);
-	return _wasUpgraded || differentVersion;
+	return _wasUpgraded || _storedWithoutState || differentVersion;
 }
 
 bool Analysis::isWaitingForModule()
diff --git a/Desktop/analysis/analysis.h b/Desktop/analysis/analysis.h
@@ -68,6 +68,7 @@ class Analysis : public AnalysisBase
 
 	bool				needsRefresh()				const	override;
 	bool				wasUpgraded()				const	override	{ return _wasUpgraded; }
+	bool				storedWithoutState()		const				{ return _storedWithoutState; }
 	bool				isWaitingForModule();
 	void				setResults(			const Json::Value & results, analysisResultStatus	status, const Json::Value & progress = Json::nullValue) { setResults(results, analysisResultsStatusToAnalysisStatus(status), progress); }
 	void				setResults(			const Json::Value & results, Status					status, const Json::Value & progress = Json::nullValue);
@@ -245,6 +246,7 @@ public slots:
 								_lastQmlFormPath				= "";
 	bool						_isDuplicate					= false,
 								_wasUpgraded					= false,
+								_storedWithoutState				= false,
 								_tryToFixNotes					= false,
 								_hasReport						= false,
 								_beingTranslated				= false;
diff --git a/Desktop/components/JASP/Widgets/FileMenu/PrefsResults.qml b/Desktop/components/JASP/Widgets/FileMenu/PrefsResults.qml
@@ -93,7 +93,7 @@ PrefsScrollView
 				onCheckedChanged:	preferencesModel.useDefaultPPI = checked
 				height:				implicitHeight * preferencesModel.uiScale
 				toolTip:			qsTr("Use the Pixels Per Inch of your screen to render your plots.")
-				focus:				true
+				
 
 				KeyNavigation.tab:		customPPISpinBox
 			}
@@ -198,7 +198,20 @@ PrefsScrollView
 				onCheckedChanged:	preferencesModel.showRSyntaxInResults = checked
 				height:				implicitHeight * preferencesModel.uiScale
 				toolTip:			qsTr("Add R syntax for each analysis")
-				focus:				true
+				
+
+				KeyNavigation.tab:		displayExactPVals
+			}
+			
+			CheckBox
+			{
+				id:					storeStateEtc
+				label:				qsTr("Store analysis state and plot in jasp-files")
+				checked:			preferencesModel.storeStateEtc
+				onCheckedChanged:	preferencesModel.storeStateEtc = checked
+				height:				implicitHeight * preferencesModel.uiScale
+				toolTip:			qsTr("Enabling this can cause filesize of jaspfiles to increase, sometimes by a lot.")
+				
 
 				KeyNavigation.tab:		displayExactPVals
 			}
diff --git a/Desktop/data/exporters/jaspexporter.cpp b/Desktop/data/exporters/jaspexporter.cpp
@@ -31,6 +31,7 @@
 #include "utilities/qutils.h"
 #include <fstream>
 #include "appinfo.h"
+#include "gui/preferencesmodel.h"
 
 
 const Version JASPExporter::jaspArchiveVersion = Version("5.0.0");
@@ -164,7 +165,8 @@ void JASPExporter::saveAnalyses(archive *a)
 
 	for (const Json::Value & analysisJson : analysesDataList)
 		for (const std::string & path : TempFiles::retrieveList(analysisJson["id"].asInt()))
-			saveTempFile(a, path);
+			if(PreferencesModel::prefs()->storeStateEtc() || !stringUtils::endsWith(path, "/state"))
+				saveTempFile(a, path);
 }
 
 void JASPExporter::saveDatabase(archive * a)
diff --git a/Desktop/gui/preferencesmodel.cpp b/Desktop/gui/preferencesmodel.cpp
@@ -191,6 +191,7 @@ GET_PREF_FUNC_BOOL(	remoteConfiguration,		Settings::REMOTE_CONFIGURATION
 GET_PREF_FUNC_STR(	remoteConfigurationURL,		Settings::REMOTE_CONFIGURATION_URL					)
 GET_PREF_FUNC_BOOL(	useConfigurationFile,		Settings::USE_CONFIGURATION_FILE					)
 GET_PREF_FUNC_BOOL(	startMaximized,				Settings::START_MAXIMIZED							)
+GET_PREF_FUNC_BOOL(	storeStateEtc,				Settings::STORE_STATE_ETC							)
 
 bool PreferencesModel::engineSandbox() const
 {
@@ -397,7 +398,7 @@ SET_PREF_FUNCTION(				bool,   	setRemoteConfiguration, 	remoteConfiguration,		re
 SET_PREF_FUNCTION(				QString,	setRemoteConfigurationURL,	remoteConfigurationURL,		remoteConfigurationURLChanged,	Settings::REMOTE_CONFIGURATION_URL					)
 SET_PREF_FUNCTION(				bool,   	setUseConfigurationFile, 	useConfigurationFile,		useConfigurationFileChanged,    Settings::USE_CONFIGURATION_FILE  					)
 SET_PREF_FUNCTION(				bool,   	setStartMaximized,			startMaximized,				startMaximizedChanged,			Settings::START_MAXIMIZED		  					)
-
+SET_PREF_FUNCTION(				bool,   	setStoreStateEtc,			storeStateEtc,				storeStateEtcChanged,			Settings::STORE_STATE_ETC		  					)
 
 void PreferencesModel::setGithubPatCustom(QString newPat)
 {
diff --git a/Desktop/gui/preferencesmodel.h b/Desktop/gui/preferencesmodel.h
@@ -82,11 +82,10 @@ class PreferencesModel : public PreferencesModelBase
 	Q_PROPERTY(QString		remoteConfigurationURL	READ remoteConfigurationURL		WRITE setRemoteConfigurationURL		NOTIFY remoteConfigurationURLChanged	)
 	Q_PROPERTY(bool			useConfigurationFile	READ useConfigurationFile		WRITE setUseConfigurationFile		NOTIFY useConfigurationFileChanged		)
 	Q_PROPERTY(bool			startMaximized			READ startMaximized				WRITE setStartMaximized				NOTIFY startMaximizedChanged			)
-
+	Q_PROPERTY(bool			storeStateEtc			READ storeStateEtc				WRITE setStoreStateEtc				NOTIFY storeStateEtcChanged				)
+	
 
 public:
-
-
 	explicit	 PreferencesModel(QObject *parent = 0);
 
 	static PreferencesModel * prefs() { return qobject_cast<PreferencesModel*>(_singleton); }
@@ -175,6 +174,9 @@ class PreferencesModel : public PreferencesModelBase
 	bool startMaximized() const;
 	void setStartMaximized(bool newStartMaximized);
 	
+	bool storeStateEtc() const;
+	void setStoreStateEtc(bool newStoreStateEtc);
+	
 public slots:
 	bool engineSandbox()							const;
 	bool useNativeFileDialog()						const;
@@ -309,6 +311,7 @@ public slots:
 	void remoteConfigurationURLChanged(	QString		remoteConfigurationURL);
 	void useConfigurationFileChanged(	bool		enabled);
 	void startMaximizedChanged(			bool		startMaximized);
+	void storeStateEtcChanged(			bool		state);
 	
 private slots:
 	void dataLabelNAChangedSlot(QString label);
diff --git a/Desktop/mainwindow.cpp b/Desktop/mainwindow.cpp
@@ -1081,7 +1081,11 @@ void MainWindow::analysisSaveImageHandler(int id, QString options)
 
 	if (analysis->needsRefresh())
 	{
-		if(MessageForwarder::showYesNo(tr("Version incompatibility"), tr("This analysis was created in an older version of JASP, to save the image it must be refreshed first.\n\nRefresh the analysis?")))
+		if(		analysis->storedWithoutState() 
+			?	MessageForwarder::showYesNo(tr("Stored without state"), tr("This analysis was saved without state, to save the image it must be refreshed first.\n\nRefresh the analysis?"))
+			:	MessageForwarder::showYesNo(tr("Version incompatibility"), tr("This analysis was created in an older version of JASP, to save the image it must be refreshed first.\n\nRefresh the analysis?"))
+				
+		)
 			analysis->refresh();
 	}
 	else
@@ -1147,7 +1151,10 @@ void MainWindow::analysisEditImageHandler(int id, QString options)
 
 	if (analysis->needsRefresh())
 	{
-		if (MessageForwarder::showYesNo(tr("Version incompatibility"), tr("This analysis was created in an older version of JASP, to resize the image it must be refreshed first.\n\nRefresh the analysis?")))
+		if (	analysis->storedWithoutState() 
+			?	MessageForwarder::showYesNo(tr("Stored without state"), tr("This analysis was stored without state, to resize the image it must be refreshed first.\n\nRefresh the analysis?"))
+			:	MessageForwarder::showYesNo(tr("Version incompatibility"), tr("This analysis was created in an older version of JASP, to resize the image it must be refreshed first.\n\nRefresh the analysis?"))
+		)
 			analysis->refresh();
 		else
 			emit editImageCancelled(id);
diff --git a/Desktop/utilities/settings.cpp b/Desktop/utilities/settings.cpp
@@ -114,6 +114,7 @@ const Settings::Setting Settings::Values[] = {
 	{"localConfigurationPath",		""		},
 	{"useConfigurationFile",		true	},
 	{"startMaximized",				false	},
+	{"storeStateEtc",				false	},
 };	
 
 QVariant Settings::value(Settings::Type key)
diff --git a/Desktop/utilities/settings.h b/Desktop/utilities/settings.h
@@ -93,7 +93,8 @@ class Settings {
 		REMOTE_CONFIGURATION_URL,
 		LOCAL_CONFIGURATION_PATH,
 		USE_CONFIGURATION_FILE,
-		START_MAXIMIZED
+		START_MAXIMIZED,
+		STORE_STATE_ETC,
 	};
 
 	static QVariant value(Settings::Type key);
diff --git a/Resources/Help/preferences/PrefsResults.md b/Resources/Help/preferences/PrefsResults.md
@@ -34,4 +34,16 @@ This option let's you toggle the background colour of plots between white and tr
 
 ### Show R syntax
 
-Add R syntax for each analysis
+Show R syntax required to call each analysis in R.
+
+### Store analysis state and plot in jasp-files
+
+When an analysis runs it creates temporary files that contain the state of the analysis and the same for each plot. 
+The analysis uses this to avoid rerunning the same code over and over again by reusing old results whenever it can.
+Enabling this option will allow you to store this in your jaspfile, so that the next time you load it with this version of jasp you can rerun much quicker. 
+However, your filesize might increase, sometimes by a lot.
+
+You might want to enable this option if you are working with analyses that can take a long time for certain steps, like bootstrapping with a large N.
+In that case storing it might save you a lot of time if you've closed JASP in the meantime.
+We've turned it off by default because in most cases the time it takes to rerun it once is not so bad and it makes all jaspfiles smaller.
+And when loading a jaspfile made by an older version this data is discarded anyway.

Original file line number	Diff line number	Diff line change
`@@ -247,6 +247,14 @@ void TempFiles::createSpecific(const string &name, int id, string &root, string`
`247`	`247`	`relativePath += "/" + name;`
`248`	`248`	`}`
`249`	`249`
	`250`	`+bool TempFiles::stateFileExists(int id)`
	`251`	`+{`
	`252`	`+ std::filesystem::path stateFilePath = Utils::osPath(_sessionDirName + "/resources" + (id >= 0 ? "/" + std::to_string(id) : "") + "/state");`
	`253`	`+`
	`254`	`+ std::error_code error;`
	`255`	`+ return std::filesystem::exists(stateFilePath, error) && !error;`
	`256`	`+}`
	`257`	`+`
`250`	`258`	`void TempFiles::create(const string &extension, int id, string &root, string &relativePath)`
`251`	`259`	`{`
`252`	`260`	`std::error_code error;`
Original file line number	Diff line number	Diff line change
`@@ -191,6 +191,7 @@ GET_PREF_FUNC_BOOL( remoteConfiguration, Settings::REMOTE_CONFIGURATION`
`191`	`191`	`GET_PREF_FUNC_STR( remoteConfigurationURL, Settings::REMOTE_CONFIGURATION_URL )`
`192`	`192`	`GET_PREF_FUNC_BOOL( useConfigurationFile, Settings::USE_CONFIGURATION_FILE )`
`193`	`193`	`GET_PREF_FUNC_BOOL( startMaximized, Settings::START_MAXIMIZED )`
	`194`	`+GET_PREF_FUNC_BOOL( storeStateEtc, Settings::STORE_STATE_ETC )`
`194`	`195`
`195`	`196`	`bool PreferencesModel::engineSandbox() const`
`196`	`197`	`{`
`@@ -397,7 +398,7 @@ SET_PREF_FUNCTION( bool, setRemoteConfiguration, remoteConfiguration, re`
`397`	`398`	`SET_PREF_FUNCTION( QString, setRemoteConfigurationURL, remoteConfigurationURL, remoteConfigurationURLChanged, Settings::REMOTE_CONFIGURATION_URL )`
`398`	`399`	`SET_PREF_FUNCTION( bool, setUseConfigurationFile, useConfigurationFile, useConfigurationFileChanged, Settings::USE_CONFIGURATION_FILE )`
`399`	`400`	`SET_PREF_FUNCTION( bool, setStartMaximized, startMaximized, startMaximizedChanged, Settings::START_MAXIMIZED )`
`400`		`-`
	`401`	`+SET_PREF_FUNCTION( bool, setStoreStateEtc, storeStateEtc, storeStateEtcChanged, Settings::STORE_STATE_ETC )`
`401`	`402`
`402`	`403`	`void PreferencesModel::setGithubPatCustom(QString newPat)`
`403`	`404`	`{`