---

StrongroomCore.h

/*
   Copyright (C) 2002 - 2003 the Strongroom project

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   @author Denis de Leeuw Duarte
   @author Ewald Snel
*/

#ifndef __STRONGROOMCORE_H_
#define __STRONGROOMCORE_H_

#include <inttypes.h>
#include <string>

#include <Document.h>
#include <Error.h>
#include <FilePlugin.h>
#include <MetadataPlugin.h>
#include <SecurityPlugin.h>
#include <UserPlugin.h>
#include <LogPlugin.h>
#include <fstream>


using namespace std;

enum CoreStatus
{
    CORE_INIT_ERROR,      //Core is not runnable. Module loading failed.
    CORE_READY,           //Core is runnable and waiting for coreStart().
    CORE_RUNNING,         //Core is in operation.
    CORE_SHUTTING_DOWN,   //Core is busy shutting down individual modules.
    CORE_BROKEN,          //Core has been stopped due to an error.
    CORE_HALTED           //Core and modules have been stopped successfully. 
};


class StrongroomCore
{
public:

    StrongroomCore(string coreConfFile);

    ~StrongroomCore();

    CoreError coreStart();

    CoreError systemShutdown( const UserProfile &admin );

    void log( const string &message, int level=0 );

    CoreError createDocument( const UserProfile &user, const Document &document, NumID &docid );

    CoreError deleteDocument( const UserProfile &user, NumID docid );

    CoreError changeDocument( const UserProfile &user, NumID docid, NumID fileid,
                              string mimetype, NumID &revid );

    CoreError deleteRevision( const UserProfile &user, NumID docid, NumID revid );

    CoreError addRendition( const UserProfile &user, NumID docid, NumID revid,
                            NumID fileid, string mimetype );

    CoreError getDocumentInfo( const UserProfile &user, NumID docid, Document &document );

    CoreError changeDocumentInfo( const UserProfile &user, NumID docid, const Document &document );

    CoreError getDocument( const UserProfile &user, NumID docid, NumID revid,
                           string mimetype, NumID &fileid, int64_t &length );

    CoreError queryUpdates( const UserProfile &user, NumID first, 
                            int maxlen, map<NumID,NumID> &updates );

    CoreError getLoginChallenge( string username, string &challenge );

    CoreError loginUser( string username, string challenge, string response, UserProfile &user );

    CoreError addUser( const UserProfile &admin, const UserProfile &userProfile,
                       string challenge, string password, NumID &userid );

    CoreError deleteUser( const UserProfile &admin, NumID userid );

    CoreError getUserProfile( const UserProfile &admin, NumID userid, UserProfile &userProfile );

    CoreError changeUserProfile( const UserProfile &admin, NumID userid, const UserProfile &userProfile );

    CoreError setPassword( const UserProfile &user, string challenge, string oldPassword, string newPassword );

    CoreError clearPassword( const UserProfile &admin, NumID userid );

    CoreError listUsers( const UserProfile &admin, vector<NumID> &users );

    CoreError createNewFile( const UserProfile &user, NumID docid, NumID revid, NumID &fileid );

    CoreError deleteNewFile( NumID fileid );

    int readFromFile( NumID fileid, uint8_t *buffer, int maxlen );

    int writeToFile( NumID fileid, const uint8_t *buffer, int length );

    CoreError closeFile( NumID fileid );

    CoreStatus coreStatus();

private:
    FilePlugin     * fileModule;
    MetadataPlugin * metadataModule;
    SecurityPlugin * securityModule;
    UserPlugin     * userModule;
    LogPlugin      * logModule;

    CoreStatus status;
};


Plugin *loadModule( string configname, string libname, StrongroomCore *core );

#endif /*__STRONGROOMCORE_H_*/

---