4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief Executor public header */
27 #define HH_Executor_ 1
30 #include <boost/utility.hpp>
32 #include "../Utils/Logger/SenfLog.hh"
35 //#include "Executor.mpp"
36 ///////////////////////////////hh.p////////////////////////////////////////
41 /** \brief Execute config/console commands
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).
46 The executor is normally called directly by the parser callback for each command.
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
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.
60 SENF_LOG_CLASS_AREA();
61 SENF_LOG_DEFAULT_LEVEL( senf::log::VERBOSE );
63 ///////////////////////////////////////////////////////////////////////////
66 /// Thrown by built-in 'exit' command
67 struct ExitException {};
69 /// Executor policy function
70 typedef boost::function<void (DirectoryNode &,std::string const &)> SecurityPolicy;
72 /// Thrown by the SecurityPolicy to silently ignore a command
73 struct IgnoreCommandException {};
75 ///////////////////////////////////////////////////////////////////////////
76 //\/name Structors and default members
82 ///////////////////////////////////////////////////////////////////////////
84 void execute(std::ostream & output, ParseCommandInfo const & command);
86 /**< Output will be written to \a output.
87 Same as operator()(). */
89 void operator()(std::ostream & output, ParseCommandInfo const & command);
91 /**< Output will be written to \a output.
93 DirectoryNode & cwd() const; ///< Current working directory
95 bool autocd() const; ///< Get current autocd status
96 /**< if autocd is enabled, specifying a directory name as
97 command will cd to that directory. Disabled by
98 default (but enabled automatically by the interactive
100 Executor & autocd(bool v); ///< Set autocd status
101 /**< \see autocd() */
103 bool autocomplete() const; ///< Get current autocomplete status
104 /**< if autocomplete is enabled, path components which can
105 be uniquely completed will be completed
106 automatically. Disabled by default (but enabled
107 automatically by the interactive console) void
108 autocomplete(bool v). */
110 Executor & autocomplete(bool v); ///< Set autocomplete status
111 /**< \see autocomplete() */
113 DirectoryNode & chroot() const; ///< Get root node
114 /**< The root node defaults to senf::console::root(). If
115 changed, all path references are relative to this node
116 and objects outside that tree cannot be accessed. */
117 Executor & chroot(DirectoryNode & node); ///< chroot into given directory
118 /**< After this call, all path's are interpreted relative to
119 \a node and only nodes in the tree rooted at \a node
120 are accessible via the executor. This value defaults to
121 senf::console::root(). */
123 Executor & policy(SecurityPolicy policy = SecurityPolicy()); ///< Set security policy
124 /**< The security policy is called before traversing a node
125 to validate that access. */
130 GenericNode & traverseNode(ParseCommandInfo::TokensRange const & path);
131 DirectoryNode & traverseDirectory(ParseCommandInfo::TokensRange const & path);
133 template <class ForwardRange>
134 GenericNode & traverse(DirectoryNode & dir, ForwardRange const & range);
136 struct InvalidPathException {};
137 struct InvalidDirectoryException {};
138 struct InvalidCommandException {};
140 DirectoryNode::ptr root_;
141 SecurityPolicy policy_;
142 DirectoryNode::weak_ptr cwd_;
143 DirectoryNode::weak_ptr oldCwd_;
145 DirEntry(DirectoryNode::weak_ptr dir_, bool skip_) : dir(dir_), skip(skip_) {}
146 DirectoryNode::weak_ptr dir;
149 typedef std::vector<DirEntry> DirStack;
161 ///////////////////////////////hh.e////////////////////////////////////////
162 #include "Executor.cci"
163 #include "Executor.ct"
164 //#include "Executor.cti"
171 // comment-column: 40
172 // c-file-style: "senf"
173 // indent-tabs-mode: nil
174 // ispell-local-dictionary: "american"
175 // compile-command: "scons -u test"