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 */
26 #ifndef HH_SENF_Scheduler_Console_Executor_
27 #define HH_SENF_Scheduler_Console_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 typedef void result_type;
77 ///////////////////////////////////////////////////////////////////////////
78 //\/name Structors and default members
84 ///////////////////////////////////////////////////////////////////////////
86 void execute(std::ostream & output, ParseCommandInfo const & command);
88 /**< Output will be written to \a output.
89 Same as operator()(). */
91 void operator()(std::ostream & output, ParseCommandInfo const & command);
93 /**< Output will be written to \a output.
95 GenericNode & getNode(ParseCommandInfo const & command);
96 DirectoryNode & cwd() const; ///< Current working directory
97 void cwd(DirectoryNode & dir); ///< Change current directory
98 std::string cwdPath() const; ///< Return pathname of current directory
99 bool skipping() const; ///< \c true, if currently skipping a directory group
101 bool autocd() const; ///< Get current autocd status
102 /**< if autocd is enabled, specifying a directory name as
103 command will cd to that directory. Disabled by
104 default (but enabled automatically by the interactive
106 Executor & autocd(bool v); ///< Set autocd status
107 /**< \see autocd() */
109 bool autocomplete() const; ///< Get current autocomplete status
110 /**< if autocomplete is enabled, path components which can
111 be uniquely completed will be completed
112 automatically. Disabled by default (but enabled
113 automatically by the interactive console). */
115 Executor & autocomplete(bool v); ///< Set autocomplete status
116 /**< \see autocomplete() */
119 DirectoryNode & chroot() const; ///< Get root node
120 /**< The root node defaults to senf::console::root(). If
121 changed, all path references are relative to this node
122 and objects outside that tree cannot be accessed. */
124 Executor & chroot(DirectoryNode & node); ///< chroot into given directory
125 /**< After this call, all path's are interpreted relative to
126 \a node and only nodes in the tree rooted at \a node
127 are accessible via the executor. This value defaults to
128 senf::console::root(). */
130 Executor & policy(SecurityPolicy policy = SecurityPolicy()); ///< Set security policy
131 /**< The security policy is called before traversing a node
132 to validate that access. */
137 typedef std::vector<DirectoryNode::weak_ptr> Path;
139 void exec(std::ostream & output, ParseCommandInfo const & command);
141 void cd(ParseCommandInfo::TokensRange dir);
142 void ls(std::ostream & output, ParseCommandInfo::TokensRange dir);
143 void lr(std::ostream & output, ParseCommandInfo::TokensRange dir);
144 void pushd(ParseCommandInfo::TokensRange dir);
147 void help(std::ostream & output, ParseCommandInfo::TokensRange path);
149 GenericNode & traverseNode(ParseCommandInfo::TokensRange const & path);
150 void traverseDirectory(ParseCommandInfo::TokensRange const & path,
152 std::string complete(DirectoryNode & dir, std::string const & name);
154 struct InvalidPathException {
156 InvalidPathException() : path() {}
157 InvalidPathException(std::string path_) : path(path_) {}
160 struct InvalidDirectoryException {
162 InvalidDirectoryException() : path() {}
163 InvalidDirectoryException(std::string path_) : path(path_) {}
165 struct InvalidCommandException {};
167 DirectoryNode::ptr root_;
168 SecurityPolicy policy_;
172 typedef std::vector<Path> DirStack;
179 void senf_console_format_value(DirectoryNode::ptr value, std::ostream & os);
183 ///////////////////////////////hh.e////////////////////////////////////////
184 #include "Executor.cci"
185 //#include "Executor.ct"
186 //#include "Executor.cti"
193 // comment-column: 40
194 // c-file-style: "senf"
195 // indent-tabs-mode: nil
196 // ispell-local-dictionary: "american"
197 // compile-command: "scons -u test"