/*
 *		Copyright (C) 2013-2015, 2019 by the Konclude Developer Team.
 *
 *		This file is part of the reasoning system Konclude.
 *		For details and support, see <http://konclude.com/>.
 *
 *		Konclude is free software: you can redistribute it and/or modify
 *		it under the terms of version 3 of the GNU Lesser General Public
 *		License (LGPLv3) as published by the Free Software Foundation.
 *
 *		Konclude is distributed in the hope that it will be useful,
 *		but WITHOUT ANY WARRANTY; without even the implied warranty of
 *		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *		GNU (Lesser) General Public License for more details.
 *
 *		You should have received a copy of the GNU (Lesser) General Public
 *		License along with Konclude. If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef KONCLUDE_REASONER_REVISION_PERSISTENCE_CONTOLOGYREVISIONDIRECTORYFILEPERSISTENCERBASE_H
#define KONCLUDE_REASONER_REVISION_PERSISTENCE_CONTOLOGYREVISIONDIRECTORYFILEPERSISTENCERBASE_H

// Libraries includes
#include <QDir>
#include <QTemporaryFile>
#include <QFile>
#include <QDomDocument>

// Namespace includes
#include "PersistenceSettings.h"
#include "COntologyRevisionPersistencer.h"


// Other includes
#include "Config/CConfigDataReader.h"

#include "Reasoner/Revision/COntologyRevision.h"

#include "Reasoner/Generator/CConcreteOntologyUpdateCollectorBuilder.h"

#include "Parser/COWL2QtXMLOntologyStableStreamParser.h"
#include "Parser/COWL2QtXMLOntologyStreamParser.h"
#include "Parser/COntologyMultiAutoParsingLoader.h"

#include "Renderer/COntologyAxiomExpressionsRenderVisitor.h"
#include "Renderer/COntologyOWL2QtXMLRenderer.h"

#include "Control/Command/CCommandRecordRouter.h"

// Logger includes
#include "Logger/CLogger.h"
#include "Logger/CLogIdentifier.h"


namespace Konclude {

	using namespace Logger;
	using namespace Renderer;
	using namespace Config;
	using namespace Parser;
	using namespace Control::Command;

	namespace Reasoner {

		using namespace Generator;

		namespace Revision {

			namespace Persistence {

				/*! 
				 *
				 *		\class		COntologyRevisionDirectoryFilePersistencerBase
				 *		\author		Andreas Steigmiller
				 *		\version	0.1
				 *		\brief		TODO
				 *
				 */
				class COntologyRevisionDirectoryFilePersistencerBase : public COntologyRevisionPersistencer, public CLogIdentifier {
					// public methods
					public:
						//! Constructor
						COntologyRevisionDirectoryFilePersistencerBase(CConfiguration* config);

						//! Destructor
						virtual ~COntologyRevisionDirectoryFilePersistencerBase();

						virtual bool persistOntologyRevision(COntologyRevision* ontoRev, COntologyRevision* prevOntoRev);

						virtual bool loadLatestOntologyRevision(const QString& ontologyName, COntologyRevision* ontoRev);

						virtual bool hasNewOntologyRevision(const QString& ontologyName, COntologyRevision* ontoRev);

						virtual bool hasOntologyPersisted(const QString& ontologyName);
						virtual bool deletePersistedOntology(const QString& ontologyName);

					// protected methods
					protected:
						QStringList getOntologyFileNameParts(const QString& ontologyName);

						QString getNextPersistingOntologyRevisionString(const QString& ontologyName, const QStringList& pathSepStrings, COntologyRevision* ontoRev);



						virtual bool writeOntologyToFile(QFile* file, COntologyRevision* ontoRev) = 0;

						virtual bool loadOntologyFromFile(const QString& ontologyString, const QString& fileNameString, QFile* file, COntologyRevision* ontoRev, CConcreteOntologyUpdateCollectorBuilder *builder);


						QStringList getPersistedOntologyVersionFilesSortedLatest(const QString& ontologyName);
						bool deletePersistingLimitOntologyVersions(const QString& ontologyName);

					// protected variables
					protected:
						QString mConfBaseDirectory;

						QString mOWLNS;

						CConfiguration* mConfig;

						QHash<QString,QString> mOntologyNameLastFileHash;
						QHash<COntologyRevision*,QString> mOntologyNameFileHash;

						QString mFileEndingWritingName;
						QString mFileEndingLoadingName;

						cint64 mKeepingVersionLimit;
					
					// private methods
					private:

					// private variables
					private:

				};

			}; // end namespace Persistence

		}; // end namespace Revision

	}; // end namespace Reasoner

}; // end namespace Konclude

#endif // KONCLUDE_REASONER_REVISION_PERSISTENCE_CONTOLOGYREVISIONDIRECTORYFILEPERSISTENCERBASE_H
