Console/Executor.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief Executor public header */
  25
  26 #ifndef HH_Executor_
  27 #define HH_Executor_ 1
  28
  29 // Custom includes
  30 #include <boost/utility.hpp>
  31 #include "Parse.hh"
  32 #include "../Utils/Logger/SenfLog.hh"
  33 #include "Node.hh"
  34
  35 //#include "Executor.mpp"
  36 ///////////////////////////////hh.p////////////////////////////////////////
  37
  38 namespace senf {
  39 namespace console {
  40
  41     /** \brief Execute config/console commands
  42
  43         The Executor interprets parsed config/console commands and executes them. It manages the
  44         current execution context (current directory, directory stack and so on).
  45
  46         The executor is normally called directly by the parser callback for each command.
  47
  48         Executing the built-in 'exit' command will throw Executor::ExitException. This exception
  49         (which is not derived from std::exception since it's not a real exception) must be handled
  50         by the caller.
  51
  52         All directories are managed using weak pointers. If any of the directories expires (current
  53         directory, directory stack, last directory) it will be replaced with the root
  54         directory. Directories expire when they are destructed or when they are detached from the
  55         config tree root node.
  56       */
  57     class Executor
  58         : boost::noncopyable
  59     {
  60         SENF_LOG_CLASS_AREA();
  61         SENF_LOG_DEFAULT_LEVEL( senf::log::VERBOSE );
  62     public:
  63         ///////////////////////////////////////////////////////////////////////////
  64         // Types
  65
  66         /// Thrown by built-in 'exit' command
  67         struct ExitException {};
  68
  69         /// Executor policy function
  70         typedef boost::function<void (DirectoryNode &,std::string const &)> SecurityPolicy;
  71
  72         /// Thrown by the SecurityPolicy to silently ignore a command
  73         struct IgnoreCommandException {};
  74
  75         ///////////////////////////////////////////////////////////////////////////
  76         //\/name Structors and default members
  77         ///\{
  78
  79         Executor();
  80
  81         ///\}
  82         ///////////////////////////////////////////////////////////////////////////
  83
  84         void execute(std::ostream & output, ParseCommandInfo const & command);
  85                                         ///< Execute command
  86                                         /**< Output will be written to \a output.
  87                                              Same as operator()(). */
  88
  89         void operator()(std::ostream & output, ParseCommandInfo const & command);
  90                                         ///< Execute command
  91                                         /**< Output will be written to \a output.
  92                                              Same as execute(). */
  93         DirectoryNode & cwd() const;    ///< Current working directory
  94         bool skipping() const;
  95
  96         bool autocd() const;            ///< Get current autocd status
  97                                         /**< if autocd is enabled, specifying a directory name as
  98                                              command will cd to that directory. Disabled by
  99                                              default (but enabled automatically by the interactive
 100                                              console). */
 101         Executor & autocd(bool v);      ///< Set autocd status
 102                                         /**< \see autocd() */
 103
 104         bool autocomplete() const;      ///< Get current autocomplete status
 105                                         /**< if autocomplete is enabled, path components which can
 106                                              be uniquely completed will be completed
 107                                              automatically. Disabled by default (but enabled
 108                                              automatically by the interactive console) void
 109                                              autocomplete(bool v). */
 110
 111         Executor & autocomplete(bool v); ///< Set autocomplete status
 112                                         /**< \see autocomplete() */
 113
 114         DirectoryNode & chroot() const; ///< Get root node
 115                                         /**< The root node defaults to senf::console::root(). If
 116                                              changed, all path references are relative to this node
 117                                              and objects outside that tree cannot be accessed. */
 118         Executor & chroot(DirectoryNode & node); ///< chroot into given directory
 119                                         /**< After this call, all path's are interpreted relative to
 120                                              \a node and only nodes in the tree rooted at \a node
 121                                              are accessible via the executor. This value defaults to
 122                                              senf::console::root(). */
 123
 124         Executor & policy(SecurityPolicy policy = SecurityPolicy()); ///< Set security policy
 125                                         /**< The security policy is called before traversing a node
 126                                              to validate that access. */
 127
 128     protected:
 129
 130     private:
 131         typedef std::vector<DirectoryNode::weak_ptr> Path;
 132
 133         void exec(std::ostream & output, ParseCommandInfo const & command);
 134
 135         void cd(ParseCommandInfo::TokensRange dir);
 136         void ls(std::ostream & output, ParseCommandInfo::TokensRange dir);
 137         void pushd(ParseCommandInfo::TokensRange dir);
 138         void popd();
 139         void exit();
 140         void help(std::ostream & output, ParseCommandInfo::TokensRange path);
 141
 142         GenericNode & traverseNode(ParseCommandInfo::TokensRange const & path);
 143         void traverseDirectory(ParseCommandInfo::TokensRange const & path,
 144                                Path & dir);
 145
 146         struct InvalidPathException {};
 147         struct InvalidDirectoryException {};
 148         struct InvalidCommandException {};
 149
 150         DirectoryNode::ptr root_;
 151         SecurityPolicy policy_;
 152         mutable Path cwd_;
 153         Path oldCwd_;
 154
 155         typedef std::vector<Path> DirStack;
 156         DirStack dirstack_;
 157
 158         bool autocd_;
 159         bool autocomplete_;
 160     };
 161
 162 }}
 163
 164 ///////////////////////////////hh.e////////////////////////////////////////
 165 #include "Executor.cci"
 166 //#include "Executor.ct"
 167 //#include "Executor.cti"
 168 #endif
 169
 170 \f
 171 // Local Variables:
 172 // mode: c++
 173 // fill-column: 100
 174 // comment-column: 40
 175 // c-file-style: "senf"
 176 // indent-tabs-mode: nil
 177 // ispell-local-dictionary: "american"
 178 // compile-command: "scons -u test"
 179 // End: