API/DirectServerAction_8h_source.html

#pragma once

#include <NDEVR/ServerActions.h>

#include "DLLInfo.h"

#include <NDEVR/String.h>

#include <NDEVR/PasswordString.h>

#include <NDEVR/DynamicPointer.h>

#include <NDEVR/NDEVRFileServer.h>

#include <NDEVR/ApplicationOption.h>

namespace sql

{

    class Connection;

    class PreparedStatement;

    class ResultSet;

    namespace mysql

    {

        class MySQL_Driver;

    }

}

namespace NDEVR

{


    class DirectServerAction : public ServerActions

    {

    public:

        DirectServerAction(LogPtr log);

        bool open(NDEVRServerInfo& info) override;

        void close() override;

        void setResourceDirectory(const File& file);

        virtual ServerCommandReturn updateUserInfo(ServerCredentials& old_credentials, ServerUserInfo& new_credentials) override;

        virtual ServerCommandReturn addUser(ServerUserInfo& info) override;

        virtual ServerCommandReturn getUserInfo(ServerCredentials& credentials, ServerUserInfo& user_info) override;

        virtual ServerCommandReturn checkCredentials(ServerCredentials& credentials);

        virtual ServerCommandReturn setUserActive(ServerCredentials& info, bool active) override;

        virtual ServerCommandReturn checkPermission(ServerPermission& resource, bool write_permission) override;

        virtual ServerCommandReturn deleteResource(ServerPermission& resource) override;

        virtual ServerCommandReturn addMessages(ServerPermission& permission, Buffer<EncodedMessage>& message) override;

        virtual ServerCommandReturn getMessages(ServerPermission& permission, Buffer<EncodedMessage>& messages, TimeSpan span) override;

        virtual ServerCommandReturn deletePermission(ServerPermission& password) override;

        virtual ServerCommandReturn getLibaryObjects(ServerCredentials& credentials, Buffer<ServerResourceInfo>& resources, bool download_preview) override;

        virtual ServerCommandReturn getResource(ServerPermission& permission, ServerResourceInfo& Resource, bool download_preview, bool download_contents) override;

        virtual ServerCommandReturn getResourceVersions(Buffer<ServerResourceInfo>& versions, ServerPermission& permission, bool download_preview) override;

        virtual ServerCommandReturn addPermission(ServerPermission& our_permission, ServerPermission& new_permission) override;

        virtual ServerCommandReturn addResource(ServerPermission& permission, ServerResourceInfo& Resource) override;

        virtual ServerCommandReturn getUsers(Buffer<ServerUserInfo>& users, ServerCredentials& credentials, bool active = true, bool inactive = false, bool awaiting_aproval = false) override;

        virtual ServerCommandReturn getResourcePermissions(Buffer<ServerPermission>& permissions, ServerPermission& Resource) override;

        virtual ServerCommandReturn getOwnedResources(Buffer<ServerResourceInfo>& resources, ServerCredentials& credentials, bool download_preview) override;

        virtual ServerCommandReturn getSharedResources(Buffer<ServerResourceInfo>& resources, ServerCredentials& resource, bool download_preview) override;

        virtual ServerCommandReturn forceUserActive(ServerCredentials& info, bool active) override;

        sint04 resolveUserID(const StringView& username, bool active = true);

        sint04 resolveUserViaPhoneNumber(const StringView& phone_number, bool active = true);

        sint04 resolveUserViaEmail(const StringView& email, bool active = true);

        sint04 resolveResourceID(const StringView& resource_name, sint04 owner_id);

        sint04 resolvePermissionID(const StringView& resource_name, sint04 owner_id);

        sint04 resourceOwnerUserID(sint04 resource_id);

        bool resolveUserIDIfNeeded(ServerCredentials& permission, bool active = true);

        bool resolveResourceIDIfNeeded(ResourceID& permission, sint04 user_id);

        bool resolvePermissionIDIfNeeded(ServerPermission& permission);

        bool isRateLimited(const ServerCredentials& ip);

        virtual ServerCommandReturn addOrUpdateLibaryObject(ServerPermission& credentials, UUID id, ServerResourceInfo& resource) override;

        virtual ServerCommandReturn getLibaryObject(ServerCredentials& credentials, UUID id, ServerResourceInfo& resource, bool download_preview, bool download_contents) override;

        virtual bool needsReconnect() const;

        virtual bool reconnect() const;

        void logAction(const ServerCredentials& ip, const ServerCommandReturn& return_val, uint04 request_type) override;

    private:

        sql::PreparedStatement* statement(const StringView& statement) const;

        virtual ServerCommandReturn hasUserOrEmail(ServerUserInfo& info, bool active_user);

        virtual ServerCommandReturn getResourceAfterPermissionCheck(ServerResourceInfo& file, bool download_preview, bool download_contents, InfoPipe* log = nullptr);

        ServerCommandReturn updateUserInfoAfterPermissionCheck(ServerUserInfo& info);

        ServerCommandReturn addOrUpdateSharedLinkPermission(ServerPermission& permission, EncodedMessage& message);

        ServerCommandReturn getSharedLinkPermissions(ServerCredentials& permission, Buffer<ServerPermission>& out);

        ServerCommandReturn getPublicPermissions(ServerCredentials& permission, Buffer<ServerPermission>& out);

        ServerCommandReturn getPermissionInfo(ServerPermission& permission);

        void updateAccessTime(ServerCredentials& credentials, ServerResourceInfo& file, bool is_write);

        void getPermissionInfo(const DynamicPointer<sql::ResultSet>& res, ServerPermission& permission);

        bool getSharedPermissionPassword(const DynamicPointer<sql::ResultSet>& res, ServerPermission& permission);

        void getPublicPermissionInfo(ServerPermission& permission);

        sql::mysql::MySQL_Driver* m_driver;

        sql::Connection* m_connection;

        File m_resource_location;

        LogPtr m_log;

    public:

        mutable Dictionary<uint08, sql::PreparedStatement*> m_cached_statements;

        static ApplicationOption<String> address;

        static ApplicationOption<uint04> port;

        static ApplicationOption<String> username;

        static ApplicationOption<PasswordString> password;

        static ApplicationOption<uint04> max_login_failure_count;

        static ApplicationOption<sint04> login_check_interval_minutes;

        Dictionary<sint04, sint04> resource_ownership_lookup;

    };


}

ApplicationOption
The default object to store data of any type that should persist through sessions of the application.
Definition ApplicationOptions.h:171

Buffer
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58

Dictionary
A hash-based key-value store, useful for quick associative lookups.
Definition Dictionary.h:64

DirectServerAction::m_cached_statements
Dictionary< uint08, sql::PreparedStatement * > m_cached_statements
Cache of prepared SQL statements.
Definition DirectServerAction.h:84

DirectServerAction::username
static ApplicationOption< String > username
Database login username.
Definition DirectServerAction.h:87

DirectServerAction::max_login_failure_count
static ApplicationOption< uint04 > max_login_failure_count
Max failed logins before lockout.
Definition DirectServerAction.h:89

DirectServerAction::login_check_interval_minutes
static ApplicationOption< sint04 > login_check_interval_minutes
Interval in minutes for rate limiting checks.
Definition DirectServerAction.h:90

DirectServerAction::port
static ApplicationOption< uint04 > port
Database server port.
Definition DirectServerAction.h:86

DirectServerAction::resource_ownership_lookup
Dictionary< sint04, sint04 > resource_ownership_lookup
Cache of resource ID to owner ID mappings.
Definition DirectServerAction.h:91

DirectServerAction::address
static ApplicationOption< String > address
Database server address.
Definition DirectServerAction.h:85

DirectServerAction::password
static ApplicationOption< PasswordString > password
Database login password.
Definition DirectServerAction.h:88

DynamicPointer
Provides a modifiable pointer that has shared ownership of a dynamically allocated object.
Definition Pointer.hpp:356

File
Logic for reading or writing to a file as well as navigating filesystems or other common file operati...
Definition File.h:53

InfoPipe
A light-weight base class for Log that allows processes to update, without the need for additional in...
Definition ProgressInfo.hpp:49

LogPtr
A light-weight wrapper that will be a no-op if there is not a valid log reference,...
Definition ProgressInfo.hpp:102

Resource
A core part of the engine, stores variables that can be listened to with ResourceListener which will ...
Definition Resource.h:42

ServerActions
Abstract interface for all server-side CRUD operations on users, resources, and permissions.
Definition ServerActions.h:208

StringView
The core String View class for the NDEVR API.
Definition StringView.h:58

TimeSpan
Stores a time span, or difference between two times, with an optional start time.
Definition TimeSpan.h:46

UUID
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer s...
Definition UUID.h:61

NDEVR
The primary namespace for the NDEVR SDK.
Definition ArialTileFetcherModule.h:35

uint04
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...
Definition BaseValues.hpp:97

sint04
int32_t sint04
-Defines an alias representing a 4 byte, signed integer.
Definition BaseValues.hpp:65

NDPO::file
@ file
The source file path associated with this object.
Definition DesignProperties.h:257

EncodedMessage
Represents an encoded message associated with a resource version, including header and body.
Definition ServerActions.h:144

NDEVRServerInfo
Contains the address, credentials, and security flag needed to connect to an NDEVR server.
Definition NDEVRCommunicationLogic.h:60

ResourceID
Identifies a resource on the server by name, ID, owner, and version.
Definition ServerActions.h:115

ServerCommandReturn
Encapsulates a server command's return status, including a code and optional message.
Definition ServerActions.h:49

ServerCredentials
Stores user credentials for server authentication, including username, password hash,...
Definition ServerActions.h:104

ServerPermission
Defines permissions for a user to access a specific resource, including encryption data.
Definition ServerActions.h:156

ServerResourceInfo
Metadata for a server-hosted resource including type, timestamps, size, and cached data.
Definition ServerActions.h:192

ServerUserInfo
Extended user information including contact details and encryption keys.
Definition ServerActions.h:181