Executor.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_Executor_
#define HH_SENF_Utils_Console_Executor_ 1

// Custom includes
#include <boost/noncopyable.hpp>
#include "Parse.hh"
#include <senf/Utils/Logger/SenfLog.hh>
#include "Node.hh"

//#include "Executor.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace console {

    class Executor
        : boost::noncopyable
    {
        SENF_LOG_CLASS_AREA();
        SENF_LOG_DEFAULT_LEVEL( senf::log::VERBOSE );
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        struct ExitException {};

        typedef boost::function<void (DirectoryNode &,std::string const &)> SecurityPolicy;

        struct IgnoreCommandException {};

        typedef void result_type;

        //-////////////////////////////////////////////////////////////////////////
        //\/name Structors and default members
        //\{

        Executor();

        //\}
        //-////////////////////////////////////////////////////////////////////////

        void execute(std::ostream & output, ParseCommandInfo const & command);

        void operator()(std::ostream & output, ParseCommandInfo const & command);

        GenericNode & getNode(ParseCommandInfo const & command);
        DirectoryNode & cwd() const;    
        void cwd(DirectoryNode & dir);  
        std::string cwdPath() const;    
        bool skipping() const;          

        bool autocd() const;            

        Executor & autocd(bool v);      

        bool autocomplete() const;      

        Executor & autocomplete(bool v); 

        DirectoryNode & chroot() const; 

        Executor & chroot(DirectoryNode & node); 

        Executor & policy(SecurityPolicy policy = SecurityPolicy()); 

    protected:

    private:
        typedef std::vector<DirectoryNode::weak_ptr> Path;

        void exec(std::ostream & output, ParseCommandInfo const & command);

        void cd(ParseCommandInfo::TokensRange dir);
        void ls(std::ostream & output, ParseCommandInfo::TokensRange dir);
        void ll(std::ostream & output, ParseCommandInfo::TokensRange dir);
        void lr(std::ostream & output, ParseCommandInfo::TokensRange dir);
        void echo(std::ostream & output, ParseCommandInfo::TokensRange args);
        void pushd(ParseCommandInfo::TokensRange dir);
        void popd();
        void exit();
        void help(std::ostream & output, ParseCommandInfo::TokensRange path);

        GenericNode & traverseNode(ParseCommandInfo::TokensRange const & path);
        void traverseDirectory(ParseCommandInfo::TokensRange const & path,
                               Path & dir);
        std::string complete(DirectoryNode & dir, std::string const & name);

        struct InvalidPathException {
            std::string path;
            InvalidPathException() : path() {}
            InvalidPathException(std::string path_) : path(path_) {}

        };
        struct InvalidDirectoryException {
            std::string path;
            InvalidDirectoryException() : path() {}
            InvalidDirectoryException(std::string path_) : path(path_) {}
        };
        struct InvalidCommandException {};

        DirectoryNode::ptr root_;
        SecurityPolicy policy_;
        mutable Path cwd_;
        Path oldCwd_;

        typedef std::vector<Path> DirStack;
        DirStack dirstack_;

        bool autocd_;
        bool autocomplete_;
    };

    void senf_console_format_value(DirectoryNode::ptr value, std::ostream & os);

}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "Executor.cci"
//#include "Executor.ct"
//#include "Executor.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: