libt2n: (gerd) some documentation improvement as preparation for release
[libt2n] / src / command_server.cpp
1 /***************************************************************************
2  *   Copyright (C) 2006 by Gerd v. Egidy                                   *
3  *   gve@intra2net.com                                                     *
4  *                                                                         *
5  *   This library is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU Lesser General Public License version   *
7  *   2.1 as published by the Free Software Foundation.                     *
8  *                                                                         *
9  *   This library is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU Lesser General Public License for more details.                   *
13  *                                                                         *
14  *   You should have received a copy of the GNU Lesser General Public      *
15  *   License along with this program; if not, write to the                 *
16  *   Free Software Foundation, Inc.,                                       *
17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
18  ***************************************************************************/
19
20 #include <string>
21 #include <sstream>
22 #include <stdexcept>
23 #include <iostream>
24
25 #include <boost/archive/binary_oarchive.hpp>
26 #include <boost/archive/binary_iarchive.hpp>
27 #include <boost/archive/xml_oarchive.hpp>
28 #include <boost/archive/xml_iarchive.hpp>
29 #include <boost/serialization/serialization.hpp>
30
31 #include <boost/bind.hpp>
32
33 #include "command_server.hxx"
34 #include "container.hxx"
35 #include "log.hxx"
36
37 #ifdef HAVE_CONFIG_H
38 #include <config.h>
39 #endif
40
41 using namespace std;
42
43 namespace libt2n
44 {
45
46 command_server::command_server(server& _s)
47     : s(_s), guard_handle(0)
48 {
49     // register callback
50     s.add_callback(new_connection,bind(&command_server::send_hello, boost::ref(*this), _1));
51 }
52
53 /// send a hello message to a new connection
54 void command_server::send_hello(unsigned int conn_id)
55 {
56     server_connection* sc=s.get_connection(conn_id);
57
58     std::ostringstream hello;
59
60     hello << "T2Nv" << PROTOCOL_VERSION << ';';
61
62     int byteordercheck=1;
63     hello.write((char*)&byteordercheck,sizeof(byteordercheck));
64
65     hello << ';';
66
67     sc->write(hello.str());
68 }
69
70 /// handle a command including deserialization and answering
71 void command_server::handle_packet(const std::string& packet, server_connection* conn)
72 {
73     OBJLOGSTREAM(s,debug,"handling packet from connection " << conn->get_id());
74
75     // deserialize packet
76     std::istringstream ifs(packet);
77     boost::archive::binary_iarchive ia(ifs);
78     command_container ccont;
79     result_container res;
80
81     try
82     {
83         ia >> ccont;
84     }
85     catch(boost::archive::archive_exception &e)
86     {
87         std::ostringstream msg;
88         msg << "archive_exception while deserializing on server-side, "
89                "code " << e.code << " (" << e.what() << ")";
90         res.set_exception(new t2n_serialization_error(msg.str()));
91     }
92     catch(...)
93         { throw; }
94
95     if (!res.has_exception())
96     {
97         std::ostream* ostr;
98         if ((ostr=s.get_logstream(fulldebug))!=NULL)
99         {
100             (*ostr) << "decoded packet data: " << std::endl;
101             boost::archive::xml_oarchive xo(*ostr);
102             xo << BOOST_SERIALIZATION_NVP(ccont);
103         }
104
105         command* cmd=cast_command(ccont.get_command());
106
107         if (cmd)
108         {
109             try
110             {
111                 res.set_result((*cmd)());
112             }
113             catch (t2n_exception &e)
114                 { res.set_exception(e.clone()); }
115             catch (...)
116                 { throw; }
117         }
118         else
119         {
120             std::ostringstream msg;
121             if (ccont.get_command()!=NULL)
122                 msg << "illegal command of type " << typeid(ccont.get_command()).name() << " called";
123             else
124                 msg << "NULL command called";
125             res.set_exception(new t2n_command_error(msg.str()));
126         }
127     }
128
129     std::ostringstream ofs;
130     boost::archive::binary_oarchive oa(ofs);
131
132     try
133     {
134         oa << res;
135     }
136     catch(boost::archive::archive_exception &e)
137     {
138         std::ostringstream msg;
139         msg << "archive_exception while serializing on server-side, "
140                "code " << e.code << " (" << e.what() << ")";
141         res.set_exception(new t2n_serialization_error(msg.str()));
142         oa << res;
143     }
144     catch(...)
145         { throw; }
146
147     std::ostream* ostr;
148     if ((ostr=s.get_logstream(fulldebug))!=NULL)
149     {
150         (*ostr) << "returning result, decoded data: " << std::endl;
151         boost::archive::xml_oarchive xo(*ostr);
152         xo << BOOST_SERIALIZATION_NVP(res);
153     }
154
155     conn->write(ofs.str());
156 }
157
158 /** @brief handle incoming commands
159     @param[in,out] usec_timeout wait until new data is found, max timeout usecs.
160             -1: wait endless, 0: instant return
161 */
162 void command_server::handle(long long usec_timeout, long long* usec_timeout_remaining)
163 {
164     guard_handle++;
165     try
166     {
167         if (s.fill_buffer(usec_timeout,usec_timeout_remaining))
168         {
169             std::string packet;
170             unsigned int conn_id;
171
172             while (s.get_packet(packet,conn_id))
173             {
174                 server_connection* conn=s.get_connection(conn_id);
175                 if (!conn)
176                     EXCEPTIONSTREAM(error,logic_error,"illegal connection id " << conn_id << " received");
177
178                 try
179                     { handle_packet(packet,conn); }
180                 catch (t2n_transfer_error &e)
181                 {
182                     // shut down a connection with transfer errors (usually write errors)
183                     conn->close();
184                 }
185                 catch(...)
186                     { throw; }
187             }
188         }
189     }
190     catch(...)
191     {
192         guard_handle--;
193         throw;
194     }
195     guard_handle--;
196
197     // don't call cleanup on re-entered handle-calls
198     if (guard_handle == 0)
199         s.cleanup();
200 }
201
202 }