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 Server non-inline non-template implementation */
31 #include <boost/algorithm/string/trim.hpp>
32 #include <boost/iostreams/device/file_descriptor.hpp>
33 #include <boost/iostreams/stream.hpp>
34 #include <boost/bind.hpp>
35 #include "../../Utils/senfassert.hh"
36 #include "../../Utils/membind.hh"
37 #include "../../Utils/Logger/SenfLog.hh"
38 #include "Readline.hh"
40 //#include "Server.mpp"
42 ///////////////////////////////cc.p////////////////////////////////////////
44 ///////////////////////////////////////////////////////////////////////////
45 // senf::console::detail::NonBlockingSocketSink
47 prefix_ std::streamsize senf::console::detail::NonblockingSocketSink::write(const char * s,
51 if (client_.handle().writeable()) {
52 std::string data (s, n);
53 client_.translate(data);
54 client_.handle().write( data );
57 catch (SystemException & ex) {
63 ///////////////////////////////////////////////////////////////////////////
64 // senf::console::Server
66 prefix_ senf::console::Server &
67 senf::console::Server::start(senf::INet4SocketAddress const & address)
69 senf::TCPv4ServerSocketHandle handle (address);
70 Server & server (senf::console::Server::start(handle));
71 SENF_LOG((Server::SENFLogArea)(log::NOTICE)(
72 "Console server started at " << address ));
76 prefix_ senf::console::Server &
77 senf::console::Server::start(senf::INet6SocketAddress const & address)
79 senf::TCPv6ServerSocketHandle handle (address);
80 Server & server (senf::console::Server::start(handle));
81 SENF_LOG((Server::SENFLogArea)(log::NOTICE)(
82 "Console server started at " << address ));
86 prefix_ senf::console::Server & senf::console::Server::start(ServerHandle handle)
88 boost::intrusive_ptr<Server> p (new Server(handle));
89 detail::ServerManager::add(boost::intrusive_ptr<Server>(p));
93 prefix_ senf::console::Server::Server(ServerHandle handle)
95 event_ ("senf::console::Server", senf::membind(&Server::newClient, this),
96 handle_, scheduler::FdEvent::EV_READ),
97 root_ (senf::console::root().thisptr()), mode_ (Automatic)
100 prefix_ void senf::console::Server::newClient(int event)
102 ServerHandle::ClientHandle client (handle_.accept());
103 boost::intrusive_ptr<Client> p (new Client(*this, client));
104 clients_.insert( p );
105 SENF_LOG(( "Registered new client " << p.get() ));
108 prefix_ void senf::console::Server::removeClient(Client & client)
110 SENF_LOG(( "Disposing client " << & client ));
111 // THIS DELETES THE CLIENT INSTANCE !!
112 clients_.erase(boost::intrusive_ptr<Client>(&client));
115 ///////////////////////////////////////////////////////////////////////////
116 // senf::console::detail::DumbClientReader
118 prefix_ senf::console::detail::DumbClientReader::DumbClientReader(Client & client)
119 : ClientReader(client), promptLen_ (0), promptActive_ (false)
122 ReadHelper<ClientHandle>::dispatch( handle(), 16384u, ReadUntil("\n"),
123 senf::membind(&DumbClientReader::clientData, this) );
127 senf::console::detail::DumbClientReader::clientData(senf::ReadHelper<ClientHandle>::ptr helper)
129 if (helper->error() || handle().eof()) {
130 // THIS COMMITS SUICIDE. THE INSTANCE IS GONE AFTER stopClient RETURNS
136 promptActive_ = false;
138 std::string data (tail_ + helper->data());
139 tail_ = helper->tail();
140 boost::trim(data); // Gets rid of superfluous \r or \n characters
144 ReadHelper<ClientHandle>::dispatch( handle(), 16384u, ReadUntil("\n"),
145 senf::membind(&DumbClientReader::clientData, this) );
149 prefix_ void senf::console::detail::DumbClientReader::showPrompt()
151 std::string prompt (promptString());
153 stream() << std::flush;
154 handle().write(prompt);
155 promptLen_ = prompt.size();
156 promptActive_ = true;
159 prefix_ void senf::console::detail::DumbClientReader::v_disablePrompt()
161 if (promptActive_ && promptLen_ > 0) {
162 stream() << '\r' << std::string(' ', promptLen_) << '\r';
167 prefix_ void senf::console::detail::DumbClientReader::v_enablePrompt()
169 if (promptActive_ && ! promptLen_)
173 prefix_ void senf::console::detail::DumbClientReader::v_translate(std::string & data)
176 ///////////////////////////////////////////////////////////////////////////
177 // senf::console::detail::NoninteractiveClientReader
180 senf::console::detail::NoninteractiveClientReader::NoninteractiveClientReader(Client & client)
181 : ClientReader (client),
182 readevent_ ("senf::console::detail::NoninteractiveClientReader",
183 senf::membind(&NoninteractiveClientReader::newData, this),
184 handle(), senf::scheduler::FdEvent::EV_READ)
187 prefix_ void senf::console::detail::NoninteractiveClientReader::v_disablePrompt()
190 prefix_ void senf::console::detail::NoninteractiveClientReader::v_enablePrompt()
193 prefix_ void senf::console::detail::NoninteractiveClientReader::v_translate(std::string & data)
197 senf::console::detail::NoninteractiveClientReader::newData(int event)
199 if (event != senf::scheduler::FdEvent::EV_READ || handle().eof()) {
200 if (! buffer_.empty())
201 handleInput(buffer_);
206 std::string::size_type n (buffer_.size());
207 buffer_.resize(n + handle().available());
208 buffer_.erase(handle().read(boost::make_iterator_range(buffer_.begin()+n, buffer_.end())),
210 buffer_.erase(0, handleInput(buffer_, true));
211 stream() << std::flush;
214 ///////////////////////////////////////////////////////////////////////////
215 // senf::console::Client
217 prefix_ senf::console::Client::Client(Server & server, ClientHandle handle)
218 : out_t(boost::ref(*this)), senf::log::IOStreamTarget(out_t::member), server_ (server),
220 readevent_ ("senf::console::Client::interactive_check",
221 boost::bind(&Client::setNoninteractive,this),
222 handle, scheduler::FdEvent::EV_READ, false),
223 timer_ ("senf::console::Client::interactive_timer",
224 boost::bind(&Client::setInteractive, this),
225 scheduler::eventTime() + ClockService::milliseconds(INTERACTIVE_TIMEOUT),
227 name_ (server.name()), reader_ (), mode_ (server.mode())
229 handle_.facet<senf::TCPSocketProtocol>().nodelay();
230 executor_.chroot(root());
232 case Server::Interactive :
235 case Server::Noninteractive :
238 case Server::Automatic :
245 prefix_ void senf::console::Client::setInteractive()
247 readevent_.disable();
249 mode_ = Server::Interactive;
250 reader_.reset(new detail::SafeReadlineClientReader (*this));
251 executor_.autocd(true).autocomplete(true);
254 prefix_ void senf::console::Client::setNoninteractive()
256 readevent_.disable();
258 mode_ = Server::Noninteractive;
259 reader_.reset(new detail::NoninteractiveClientReader(*this));
262 prefix_ void senf::console::Client::translate(std::string & data)
264 reader_->translate(data);
267 prefix_ std::string::size_type senf::console::Client::handleInput(std::string data,
270 if (data.empty() && ! incremental)
275 std::string::size_type n (data.size());
279 n = parser_.parseIncremental(data, boost::bind<void>( boost::ref(executor_),
280 boost::ref(stream()),
283 parser_.parse(data, boost::bind<void>( boost::ref(executor_),
284 boost::ref(stream()),
287 catch (Executor::ExitException &) {
288 // This generates an EOF condition on the Handle. This EOF condition is expected
289 // to be handled gracefully by the ClientReader. We cannot call stop() here, since we
290 // are called from the client reader callback and that will continue executing even if we
291 // call stop here ...
292 handle_.facet<senf::TCPSocketProtocol>().shutdown(senf::TCPSocketProtocol::ShutRD);
294 catch (std::exception & ex) {
295 stream() << ex.what() << std::endl;
298 stream() << "unidentified error (unknown exception thrown)" << std::endl;
303 prefix_ void senf::console::Client::v_write(senf::log::time_type timestamp,
304 std::string const & stream,
305 std::string const & area, unsigned level,
306 std::string const & message)
308 reader_->disablePrompt();
309 IOStreamTarget::v_write(timestamp, stream, area, level, message);
310 out_t::member << std::flush;
311 reader_->enablePrompt();
314 prefix_ std::ostream & senf::console::operator<<(std::ostream & os, Client const & client)
316 typedef ClientSocketHandle< MakeSocketPolicy<
317 INet4AddressingPolicy,ConnectedCommunicationPolicy>::policy > V4Socket;
318 typedef ClientSocketHandle< MakeSocketPolicy<
319 INet6AddressingPolicy,ConnectedCommunicationPolicy>::policy > V6Socket;
322 if (check_socket_cast<V4Socket>(client.handle()))
323 os << dynamic_socket_cast<V4Socket>(client.handle()).peer();
324 else if (check_socket_cast<V6Socket>(client.handle()))
325 os << dynamic_socket_cast<V6Socket>(client.handle()).peer();
327 os << static_cast<void const *>(&client);
329 catch (SystemException &) {
336 prefix_ std::ostream & senf::console::operator<<(std::ostream & os, Client * client)
338 return os << *client;
341 ///////////////////////////////cc.e////////////////////////////////////////
343 //#include "Server.mpp"
349 // comment-column: 40
350 // c-file-style: "senf"
351 // indent-tabs-mode: nil
352 // ispell-local-dictionary: "american"
353 // compile-command: "scons -u test"