session.hpp

/*********************************************************************/
// webdar - a web server and interface program to libdar
// Copyright (C) 2013-2025 Denis Corbin
//
// This file is part of Webdar
//
//  Webdar is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  Webdar 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with Webdar.  If not, see <http://www.gnu.org/licenses/>
//
//----
//  to contact the author: dar.linux@free.fr
/*********************************************************************/
 
#ifndef SESSION_HPP
#define SESSION_HPP
 
    // C system header files
#include "my_config.h"
extern "C"
{
}
 
    // C++ system header files
#include <list>
#include <libthreadar/libthreadar.hpp>
 
    // webdar headers
#include "user_interface.hpp"
#include "events.hpp"
 
 
 
class session : public responder, public actor
{
public:
 
    // Object methods
    //
 
    // constructor of the class are left private intentionnaly
    // this class provides a global table of session one can create, lookup or destroy objects in/from this table
 
    virtual answer give_answer(const request & req) override;
 
    bool has_waiting_threads() const { return lock_wui.waiting_thread(); };
    bool has_working_server() const { return lock_wui.working_thread(); };
    std::string get_session_ID() const { return session_ID; };
    bool disconnection_requested() const;
 
 
    virtual void on_event(const std::string & event_name) override;
 
 
    // Class types and methods
    //
 
    struct session_summary
    {
    std::string owner;        
    std::string session_ID;   
    std::string session_name; 
    bool locked;              
    bool libdar_running;      
    bool closing;             
    void clear() { owner = session_ID = ""; locked = libdar_running = closing = false; };
    };
 
 
 
    static bool create_new_session(const std::string & user, bool initial, const request & req, answer & ret);
 
    static unsigned int get_num_session();
 
    static unsigned int get_num_session(const std::string & user);
 
    static std::vector<session_summary> get_summary();
 
    static bool get_session_info(const std::string & session_ID, session_summary & val);
 
 
    static session *acquire_session(const std::string & session_ID);
 
 
    static void release_session(session *sess);
 
 
    static bool close_session(const std::string & session_ID);
 
private:
    session();
    session(const session & ref) = delete;
    session(session && ref) = delete;
    session & operator = (const session & ref) = delete;
    session & operator = (session && ref) = delete;
    ~session() = default;
 
    void set_session_id(const std::string & sessid);
 
    libthreadar::semaphore lock_wui; 
    user_interface wui;       
    pthread_t tid;            
    std::string session_ID;   
 
    void check_caller() const; //< test whether the caller has properly acquired the lock on this object
 
 
    // static types, variables and methods
    //
 
    struct table
    {
    std::string owner;      
    session *reference;     
    unsigned int ref_given; 
    bool closing;           
    void clear() { owner = ""; reference = nullptr; ref_given = 0; closing = false; };
    };
 
    static libthreadar::mutex lock_running;       
    static std::map<std::string, table> running_session;     
    static session_summary publish(std::map<std::string, table>::iterator it);
    static std::string create_new(const std::string & owner); 
};
 
#endif