Server.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Utils_Console_Server_
#define HH_SENF_Utils_Console_Server_ 1

// Custom includes
#include <set>
#include <boost/scoped_ptr.hpp>
#include <senf/Scheduler/FdEvent.hh>
#include <senf/Scheduler/TimerEvent.hh>
#include <senf/Socket/Protocols/INet/INetAddressing.hh>
#include <senf/Utils/Logger.hh>
#include <senf/Utils/intrusive_refcount.hh>
#include "ScopedDirectory.hh"
#include "Executor.hh"

#include "Server.ih"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace console {

    class Client;

    class Server
        : public senf::intrusive_refcount
    {
        SENF_LOG_CLASS_AREA();
        SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        typedef detail::ServerHandle ServerHandle;

        enum Mode { Automatic, Interactive, Noninteractive };

        //-////////////////////////////////////////////////////////////////////////

        static Server & start(senf::INet4SocketAddress const & address);
        static Server & start(senf::INet6SocketAddress const & address);

        std::string const & name() const; 

        Server & name(std::string const & name); 

        Server & welcomeMessage(std::string const & message); 

        DirectoryNode & root() const;   

        Server & root(DirectoryNode & root); 

        Mode mode() const;              

        Server & mode(Mode mode);       

        void stop();                    

    protected:

    private:
        Server(ServerHandle handle);

        static Server & start(ServerHandle handle);

        void newClient(int event);
        void removeClient(Client & client);
        boost::shared_ptr<DirectoryNode> consoleSelf(std::ostream & os);
        static DirectoryNode & sysConsoleDir();

        ServerHandle handle_;
        scheduler::FdEvent event_;
        DirectoryNode::ptr root_;
        static ScopedDirectory<> sysConsoleDir_;
        Mode mode_;

        typedef std::set< boost::intrusive_ptr<Client> > Clients;
        Clients clients_;
        std::string name_;
        std::string welcomeMsg_;

        friend class Client;
    };

    class Client
        : public senf::intrusive_refcount,
          private boost::base_from_member< detail::SocketStreamOStream >,
          public senf::log::IOStreamTarget
    {
        typedef boost::base_from_member< detail::SocketStreamOStream > out_t;

        SENF_LOG_CLASS_AREA();
        SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );

        static const unsigned INTERACTIVE_TIMEOUT = 500; // milliseconds;

    public:
        typedef Server::ServerHandle::ClientHandle ClientHandle;

        ~Client();

        void stop();                    

        std::string const & name() const; 

        ClientHandle handle() const;    
        std::ostream & stream();        

        std::string promptString() const; 
        DirectoryNode & root() const;   
        DirectoryNode & cwd() const;    

        Server::Mode mode() const;      

        void write(std::string const & data) const;

        std::string const & backtrace() const; 
        unsigned width() const;         

        static Client & get(std::ostream & os);

        static unsigned getWidth(std::ostream & os, unsigned defaultWidth = 0,
                                 unsigned minWidth = 0);

        void setProperty(std::string const & key, std::string const & value);
        std::string getProperty(std::string const & key, std::string const & defaultValue) const;
        boost::optional<std::string> getProperty(std::string const & key) const;

    private:
        Client(Server & server, ClientHandle handle);

        void setInteractive();
        void setNoninteractive();

        size_t handleInput(std::string input, bool incremental = false);
        virtual void v_write(senf::log::time_type timestamp, std::string const & stream,
                             std::string const & area, unsigned level,
                             std::string const & message);

        void dumpProperties(std::ostream & os) const;

        ScopedDirectory<> dir_;
        Server & server_;
        ClientHandle handle_;
        scheduler::FdEvent readevent_;
        scheduler::TimerEvent timer_;
        CommandParser parser_;
        Executor executor_;
        std::string name_;
        boost::scoped_ptr<detail::ClientReader> reader_;
        Server::Mode mode_;
        std::string backtrace_;
        typedef std::map<std::string, std::string> PropertyMap;
        PropertyMap properties_;

        friend class Server;
        friend class detail::ClientReader;
        friend class detail::SocketStreamSink;

        class SysBacktrace
        {
            SysBacktrace();
            static void  backtrace(std::ostream & os);
            static SysBacktrace instance_;
        };

    };

    std::ostream & operator<<(std::ostream & os, Client const & client);

    std::ostream & operator<<(std::ostream & os, Client * client);

}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "Server.cci"
//#include "Server.ct"
//#include "Server.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: