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 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 DirectoryNode & cwd() const; ///< Current working directory
96 std::string cwdPath() const; ///< Return pathname of current directory
97 bool skipping() const; ///< \c true, if currently skipping a directory group
99 bool autocd() const; ///< Get current autocd status
100 /**< if autocd is enabled, specifying a directory name as
101 command will cd to that directory. Disabled by
102 default (but enabled automatically by the interactive
104 Executor & autocd(bool v); ///< Set autocd status
105 /**< \see autocd() */
107 bool autocomplete() const; ///< Get current autocomplete status
108 /**< if autocomplete is enabled, path components which can
109 be uniquely completed will be completed
110 automatically. Disabled by default (but enabled
111 automatically by the interactive console) void
112 autocomplete(bool v). */
114 Executor & autocomplete(bool v); ///< Set autocomplete status
115 /**< \see autocomplete() */
117 DirectoryNode & chroot() const; ///< Get root node
118 /**< The root node defaults to senf::console::root(). If
119 changed, all path references are relative to this node
120 and objects outside that tree cannot be accessed. */
121 Executor & chroot(DirectoryNode & node); ///< chroot into given directory
122 /**< After this call, all path's are interpreted relative to
123 \a node and only nodes in the tree rooted at \a node
124 are accessible via the executor. This value defaults to
125 senf::console::root(). */
127 Executor & policy(SecurityPolicy policy = SecurityPolicy()); ///< Set security policy
128 /**< The security policy is called before traversing a node
129 to validate that access. */
134 typedef std::vector<DirectoryNode::weak_ptr> Path;
136 void exec(std::ostream & output, ParseCommandInfo const & command);
138 void cd(ParseCommandInfo::TokensRange dir);
139 void ls(std::ostream & output, ParseCommandInfo::TokensRange dir);
140 void pushd(ParseCommandInfo::TokensRange dir);
143 void help(std::ostream & output, ParseCommandInfo::TokensRange path);
145 GenericNode & traverseNode(ParseCommandInfo::TokensRange const & path);
146 void traverseDirectory(ParseCommandInfo::TokensRange const & path,
148 std::string complete(DirectoryNode & dir, std::string const & name);
150 struct InvalidPathException {};
151 struct InvalidDirectoryException {};
152 struct InvalidCommandException {};
154 DirectoryNode::ptr root_;
155 SecurityPolicy policy_;
159 typedef std::vector<Path> DirStack;
168 ///////////////////////////////hh.e////////////////////////////////////////
169 #include "Executor.cci"
170 //#include "Executor.ct"
171 //#include "Executor.cti"
178 // comment-column: 40
179 // c-file-style: "senf"
180 // indent-tabs-mode: nil
181 // ispell-local-dictionary: "american"
182 // compile-command: "scons -u test"