Console: Add lots of documentation
[senf.git] / Console / Server.cc
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 Server non-inline non-template implementation */
25
26 #include "Server.hh"
27 //#include "Server.ih"
28
29 // Custom includes
30 #include <unistd.h>
31 #include <iostream>
32 #include <boost/algorithm/string/trim.hpp>
33 #include <boost/iostreams/device/file_descriptor.hpp>
34 #include <boost/iostreams/stream.hpp>
35 #include <boost/bind.hpp>
36 #include "../Utils/senfassert.hh"
37 #include "../Utils/membind.hh"
38 #include "../Utils/Logger/SenfLog.hh"
39
40 //#include "Server.mpp"
41 #define prefix_
42 ///////////////////////////////cc.p////////////////////////////////////////
43
44 prefix_ senf::console::Server &
45 senf::console::Server::start(senf::INet4SocketAddress const & address)
46 {
47     senf::TCPv4ServerSocketHandle handle (address);
48     senf::console::Server::start(handle);
49     SENF_LOG((Server::SENFLogArea)(log::NOTICE)( 
50                  "Console server started at " << address ));
51     return *instance_;
52 }
53
54 prefix_ senf::console::Server &
55 senf::console::Server::start(senf::INet6SocketAddress const & address)
56 {
57     senf::TCPv6ServerSocketHandle handle (address);
58     senf::console::Server::start(handle);
59     SENF_LOG((Server::SENFLogArea)(log::NOTICE)( 
60                  "Console server started at " << address ));
61     return *instance_;
62 }
63
64 ///////////////////////////////////////////////////////////////////////////
65 // senf::console::Server
66
67 boost::scoped_ptr<senf::console::Server> senf::console::Server::instance_;
68
69 prefix_ void senf::console::Server::start(ServerHandle handle)
70 {
71     SENF_ASSERT( ! instance_ );
72     instance_.reset(new Server(handle));
73 }
74
75 prefix_ senf::console::Server::Server(ServerHandle handle)
76     : handle_ (handle)
77 {
78     Scheduler::instance().add( handle_, senf::membind(&Server::newClient, this) );
79 }
80
81 prefix_ senf::console::Server::~Server()
82 {
83     Scheduler::instance().remove(handle_);
84 }
85
86 prefix_ void senf::console::Server::newClient(Scheduler::EventId event)
87 {
88     ServerHandle::ClientSocketHandle client (handle_.accept());
89     boost::intrusive_ptr<Client> p (new Client(client, name_));
90     clients_.insert( p );
91     SENF_LOG(( "Registered new client " << p.get() ));
92 }
93
94 prefix_ void senf::console::Server::removeClient(Client & client)
95 {
96     SENF_LOG(( "Disposing client " << & client ));
97     // THIS DELETES THE CLIENT INSTANCE !!
98     clients_.erase(boost::intrusive_ptr<Client>(&client));
99 }
100
101 ///////////////////////////////////////////////////////////////////////////
102 // senf::console::Client
103
104 prefix_ senf::console::Client::Client(ClientHandle handle, std::string const & name)
105     : handle_ (handle), name_ (name), out_(::dup(handle.fd()))
106 {
107     showPrompt();
108     ReadHelper<ClientHandle>::dispatch( handle_, 16384u, ReadUntil("\n"),
109                                         senf::membind(&Client::clientData, this) );
110 }
111
112 prefix_ senf::console::Client::~Client()
113 {}
114
115 prefix_ void senf::console::Client::stopClient()
116 {
117     // THIS COMMITS SUICIDE. THE INSTANCE IS GONE AFTER removeClient RETURNS
118     Server::instance_->removeClient(*this);
119 }
120
121 prefix_ void senf::console::Client::clientData(ReadHelper<ClientHandle>::ptr helper)
122 {
123     if (helper->error() || handle_.eof()) {
124         // THIS COMMITS SUICIDE. THE INSTANCE IS GONE AFTER stopClient RETURNS
125         stopClient();
126         return;
127     }
128
129     std::string data (tail_ + helper->data());
130     tail_ = helper->tail();
131     boost::trim(data); // Gets rid of superfluous  \r or \n characters
132
133     try {
134         if (! parser_.parse(data, boost::bind<void>(boost::ref(executor_), _1, boost::ref(out_))))
135             out_ << "syntax error" << std::endl;
136     }
137     catch (Executor::ExitException &) {
138         // THIS COMMITS SUICIDE. THE INSTANCE IS GONE AFTER stopClient RETURNS
139         stopClient();
140         return;
141     }
142     catch (std::exception & ex) {
143         out_ << ex.what() << std::endl;
144     }
145     catch (...) {
146         out_ << "unidentified error (unknown exception thrown)" << std::endl;
147     }
148
149     showPrompt();
150     ReadHelper<ClientHandle>::dispatch( handle_, 16384u, ReadUntil("\n"),
151                                         senf::membind(&Client::clientData, this) );
152 }
153
154 prefix_ void senf::console::Client::showPrompt()
155 {
156     out_ << name_ << ":" << executor_.cwd().path() << "# " << std::flush;
157 }
158
159 ///////////////////////////////cc.e////////////////////////////////////////
160 #undef prefix_
161 //#include "Server.mpp"
162
163 \f
164 // Local Variables:
165 // mode: c++
166 // fill-column: 100
167 // comment-column: 40
168 // c-file-style: "senf"
169 // indent-tabs-mode: nil
170 // ispell-local-dictionary: "american"
171 // compile-command: "scons -u test"
172 // End: