]> git.mxchange.org Git - flightgear.git/blob - src/MultiPlayer/multiplaymgr.cxx
Merge branch 'aperry/terrasync' into next
[flightgear.git] / src / MultiPlayer / multiplaymgr.cxx
1 //////////////////////////////////////////////////////////////////////
2 //
3 // multiplaymgr.hpp
4 //
5 // Written by Duncan McCreanor, started February 2003.
6 // duncan.mccreanor@airservicesaustralia.com
7 //
8 // Copyright (C) 2003  Airservices Australia
9 // Copyright (C) 2005  Oliver Schroeder
10 // Copyright (C) 2006  Mathias Froehlich
11 //
12 // This program is free software; you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of the
15 // License, or (at your option) any later version.
16 //
17 // This program is distributed in the hope that it will be useful, but
18 // WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20 // General Public License for more details.
21 //
22 // You should have received a copy of the GNU General Public License
23 // along with this program; if not, write to the Free Software
24 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
25 //
26 // $Id$
27 //  
28 //////////////////////////////////////////////////////////////////////
29
30 #ifdef HAVE_CONFIG_H
31 #include <config.h>
32 #endif
33
34 #include <iostream>
35 #include <algorithm>
36 #include <cstring>
37 #include <osg/Math>             // isNaN
38 #include <plib/netSocket.h>
39
40 #include <simgear/misc/stdint.hxx>
41 #include <simgear/timing/timestamp.hxx>
42 #include <simgear/debug/logstream.hxx>
43 #include <simgear/props/props.hxx>
44
45 #include <AIModel/AIManager.hxx>
46 #include <Main/fg_props.hxx>
47 #include "multiplaymgr.hxx"
48 #include "mpmessages.hxx"
49
50 using namespace std;
51
52 #define MAX_PACKET_SIZE 1200
53 #define MAX_TEXT_SIZE 128
54
55 // These constants are provided so that the ident 
56 // command can list file versions
57 const char sMULTIPLAYMGR_BID[] = "$Id$";
58 const char sMULTIPLAYMGR_HID[] = MULTIPLAYTXMGR_HID;
59
60 // A static map of protocol property id values to property paths,
61 // This should be extendable dynamically for every specific aircraft ...
62 // For now only that static list
63 const FGMultiplayMgr::IdPropertyList
64 FGMultiplayMgr::sIdPropertyList[] = {
65   {100, "surface-positions/left-aileron-pos-norm",  simgear::props::FLOAT},
66   {101, "surface-positions/right-aileron-pos-norm", simgear::props::FLOAT},
67   {102, "surface-positions/elevator-pos-norm",      simgear::props::FLOAT},
68   {103, "surface-positions/rudder-pos-norm",        simgear::props::FLOAT},
69   {104, "surface-positions/flap-pos-norm",          simgear::props::FLOAT},
70   {105, "surface-positions/speedbrake-pos-norm",    simgear::props::FLOAT},
71   {106, "gear/tailhook/position-norm",              simgear::props::FLOAT},
72   {107, "gear/launchbar/position-norm",             simgear::props::FLOAT},
73   {108, "gear/launchbar/state",                     simgear::props::STRING},
74   {109, "gear/launchbar/holdback-position-norm",    simgear::props::FLOAT},
75   {110, "canopy/position-norm",                     simgear::props::FLOAT},
76   {111, "surface-positions/wing-pos-norm",          simgear::props::FLOAT},
77   {112, "surface-positions/wing-fold-pos-norm",     simgear::props::FLOAT},
78
79   {200, "gear/gear[0]/compression-norm",           simgear::props::FLOAT},
80   {201, "gear/gear[0]/position-norm",              simgear::props::FLOAT},
81   {210, "gear/gear[1]/compression-norm",           simgear::props::FLOAT},
82   {211, "gear/gear[1]/position-norm",              simgear::props::FLOAT},
83   {220, "gear/gear[2]/compression-norm",           simgear::props::FLOAT},
84   {221, "gear/gear[2]/position-norm",              simgear::props::FLOAT},
85   {230, "gear/gear[3]/compression-norm",           simgear::props::FLOAT},
86   {231, "gear/gear[3]/position-norm",              simgear::props::FLOAT},
87   {240, "gear/gear[4]/compression-norm",           simgear::props::FLOAT},
88   {241, "gear/gear[4]/position-norm",              simgear::props::FLOAT},
89
90   {300, "engines/engine[0]/n1",  simgear::props::FLOAT},
91   {301, "engines/engine[0]/n2",  simgear::props::FLOAT},
92   {302, "engines/engine[0]/rpm", simgear::props::FLOAT},
93   {310, "engines/engine[1]/n1",  simgear::props::FLOAT},
94   {311, "engines/engine[1]/n2",  simgear::props::FLOAT},
95   {312, "engines/engine[1]/rpm", simgear::props::FLOAT},
96   {320, "engines/engine[2]/n1",  simgear::props::FLOAT},
97   {321, "engines/engine[2]/n2",  simgear::props::FLOAT},
98   {322, "engines/engine[2]/rpm", simgear::props::FLOAT},
99   {330, "engines/engine[3]/n1",  simgear::props::FLOAT},
100   {331, "engines/engine[3]/n2",  simgear::props::FLOAT},
101   {332, "engines/engine[3]/rpm", simgear::props::FLOAT},
102   {340, "engines/engine[4]/n1",  simgear::props::FLOAT},
103   {341, "engines/engine[4]/n2",  simgear::props::FLOAT},
104   {342, "engines/engine[4]/rpm", simgear::props::FLOAT},
105   {350, "engines/engine[5]/n1",  simgear::props::FLOAT},
106   {351, "engines/engine[5]/n2",  simgear::props::FLOAT},
107   {352, "engines/engine[5]/rpm", simgear::props::FLOAT},
108   {360, "engines/engine[6]/n1",  simgear::props::FLOAT},
109   {361, "engines/engine[6]/n2",  simgear::props::FLOAT},
110   {362, "engines/engine[6]/rpm", simgear::props::FLOAT},
111   {370, "engines/engine[7]/n1",  simgear::props::FLOAT},
112   {371, "engines/engine[7]/n2",  simgear::props::FLOAT},
113   {372, "engines/engine[7]/rpm", simgear::props::FLOAT},
114   {380, "engines/engine[8]/n1",  simgear::props::FLOAT},
115   {381, "engines/engine[8]/n2",  simgear::props::FLOAT},
116   {382, "engines/engine[8]/rpm", simgear::props::FLOAT},
117   {390, "engines/engine[9]/n1",  simgear::props::FLOAT},
118   {391, "engines/engine[9]/n2",  simgear::props::FLOAT},
119   {392, "engines/engine[9]/rpm", simgear::props::FLOAT},
120
121   {800, "rotors/main/rpm", simgear::props::FLOAT},
122   {801, "rotors/tail/rpm", simgear::props::FLOAT},
123   {810, "rotors/main/blade[0]/position-deg",  simgear::props::FLOAT},
124   {811, "rotors/main/blade[1]/position-deg",  simgear::props::FLOAT},
125   {812, "rotors/main/blade[2]/position-deg",  simgear::props::FLOAT},
126   {813, "rotors/main/blade[3]/position-deg",  simgear::props::FLOAT},
127   {820, "rotors/main/blade[0]/flap-deg",  simgear::props::FLOAT},
128   {821, "rotors/main/blade[1]/flap-deg",  simgear::props::FLOAT},
129   {822, "rotors/main/blade[2]/flap-deg",  simgear::props::FLOAT},
130   {823, "rotors/main/blade[3]/flap-deg",  simgear::props::FLOAT},
131   {830, "rotors/tail/blade[0]/position-deg",  simgear::props::FLOAT},
132   {831, "rotors/tail/blade[1]/position-deg",  simgear::props::FLOAT},
133
134   {900, "sim/hitches/aerotow/tow/length",                       simgear::props::FLOAT},
135   {901, "sim/hitches/aerotow/tow/elastic-constant",             simgear::props::FLOAT},
136   {902, "sim/hitches/aerotow/tow/weight-per-m-kg-m",            simgear::props::FLOAT},
137   {903, "sim/hitches/aerotow/tow/dist",                         simgear::props::FLOAT},
138   {904, "sim/hitches/aerotow/tow/connected-to-property-node",   simgear::props::BOOL},
139   {905, "sim/hitches/aerotow/tow/connected-to-ai-or-mp-callsign",   simgear::props::STRING},
140   {906, "sim/hitches/aerotow/tow/brake-force",                  simgear::props::FLOAT},
141   {907, "sim/hitches/aerotow/tow/end-force-x",                  simgear::props::FLOAT},
142   {908, "sim/hitches/aerotow/tow/end-force-y",                  simgear::props::FLOAT},
143   {909, "sim/hitches/aerotow/tow/end-force-z",                  simgear::props::FLOAT},
144   {930, "sim/hitches/aerotow/is-slave",                         simgear::props::BOOL},
145   {931, "sim/hitches/aerotow/speed-in-tow-direction",           simgear::props::FLOAT},
146   {932, "sim/hitches/aerotow/open",                             simgear::props::BOOL},
147   {933, "sim/hitches/aerotow/local-pos-x",                      simgear::props::FLOAT},
148   {934, "sim/hitches/aerotow/local-pos-y",                      simgear::props::FLOAT},
149   {935, "sim/hitches/aerotow/local-pos-z",                      simgear::props::FLOAT},
150
151   {1001, "controls/flight/slats",  simgear::props::FLOAT},
152   {1002, "controls/flight/speedbrake",  simgear::props::FLOAT},
153   {1003, "controls/flight/spoilers",  simgear::props::FLOAT},
154   {1004, "controls/gear/gear-down",  simgear::props::FLOAT},
155   {1005, "controls/lighting/nav-lights",  simgear::props::FLOAT},
156   {1006, "controls/armament/station[0]/jettison-all",  simgear::props::BOOL},
157
158   {1100, "sim/model/variant", simgear::props::INT},
159   {1101, "sim/model/livery/file", simgear::props::STRING},
160
161   {10001, "sim/multiplay/transmission-freq-hz",  simgear::props::STRING},
162   {10002, "sim/multiplay/chat",  simgear::props::STRING},
163
164   {10100, "sim/multiplay/generic/string[0]", simgear::props::STRING},
165   {10101, "sim/multiplay/generic/string[1]", simgear::props::STRING},
166   {10102, "sim/multiplay/generic/string[2]", simgear::props::STRING},
167   {10103, "sim/multiplay/generic/string[3]", simgear::props::STRING},
168   {10104, "sim/multiplay/generic/string[4]", simgear::props::STRING},
169   {10105, "sim/multiplay/generic/string[5]", simgear::props::STRING},
170   {10106, "sim/multiplay/generic/string[6]", simgear::props::STRING},
171   {10107, "sim/multiplay/generic/string[7]", simgear::props::STRING},
172   {10108, "sim/multiplay/generic/string[8]", simgear::props::STRING},
173   {10109, "sim/multiplay/generic/string[9]", simgear::props::STRING},
174   {10110, "sim/multiplay/generic/string[10]", simgear::props::STRING},
175   {10111, "sim/multiplay/generic/string[11]", simgear::props::STRING},
176   {10112, "sim/multiplay/generic/string[12]", simgear::props::STRING},
177   {10113, "sim/multiplay/generic/string[13]", simgear::props::STRING},
178   {10114, "sim/multiplay/generic/string[14]", simgear::props::STRING},
179   {10115, "sim/multiplay/generic/string[15]", simgear::props::STRING},
180   {10116, "sim/multiplay/generic/string[16]", simgear::props::STRING},
181   {10117, "sim/multiplay/generic/string[17]", simgear::props::STRING},
182   {10118, "sim/multiplay/generic/string[18]", simgear::props::STRING},
183   {10119, "sim/multiplay/generic/string[19]", simgear::props::STRING},
184
185   {10200, "sim/multiplay/generic/float[0]", simgear::props::FLOAT},
186   {10201, "sim/multiplay/generic/float[1]", simgear::props::FLOAT},
187   {10202, "sim/multiplay/generic/float[2]", simgear::props::FLOAT},
188   {10203, "sim/multiplay/generic/float[3]", simgear::props::FLOAT},
189   {10204, "sim/multiplay/generic/float[4]", simgear::props::FLOAT},
190   {10205, "sim/multiplay/generic/float[5]", simgear::props::FLOAT},
191   {10206, "sim/multiplay/generic/float[6]", simgear::props::FLOAT},
192   {10207, "sim/multiplay/generic/float[7]", simgear::props::FLOAT},
193   {10208, "sim/multiplay/generic/float[8]", simgear::props::FLOAT},
194   {10209, "sim/multiplay/generic/float[9]", simgear::props::FLOAT},
195   {10210, "sim/multiplay/generic/float[10]", simgear::props::FLOAT},
196   {10211, "sim/multiplay/generic/float[11]", simgear::props::FLOAT},
197   {10212, "sim/multiplay/generic/float[12]", simgear::props::FLOAT},
198   {10213, "sim/multiplay/generic/float[13]", simgear::props::FLOAT},
199   {10214, "sim/multiplay/generic/float[14]", simgear::props::FLOAT},
200   {10215, "sim/multiplay/generic/float[15]", simgear::props::FLOAT},
201   {10216, "sim/multiplay/generic/float[16]", simgear::props::FLOAT},
202   {10217, "sim/multiplay/generic/float[17]", simgear::props::FLOAT},
203   {10218, "sim/multiplay/generic/float[18]", simgear::props::FLOAT},
204   {10219, "sim/multiplay/generic/float[19]", simgear::props::FLOAT},
205
206   {10300, "sim/multiplay/generic/int[0]", simgear::props::INT},
207   {10301, "sim/multiplay/generic/int[1]", simgear::props::INT},
208   {10302, "sim/multiplay/generic/int[2]", simgear::props::INT},
209   {10303, "sim/multiplay/generic/int[3]", simgear::props::INT},
210   {10304, "sim/multiplay/generic/int[4]", simgear::props::INT},
211   {10305, "sim/multiplay/generic/int[5]", simgear::props::INT},
212   {10306, "sim/multiplay/generic/int[6]", simgear::props::INT},
213   {10307, "sim/multiplay/generic/int[7]", simgear::props::INT},
214   {10308, "sim/multiplay/generic/int[8]", simgear::props::INT},
215   {10309, "sim/multiplay/generic/int[9]", simgear::props::INT},
216   {10310, "sim/multiplay/generic/int[10]", simgear::props::INT},
217   {10311, "sim/multiplay/generic/int[11]", simgear::props::INT},
218   {10312, "sim/multiplay/generic/int[12]", simgear::props::INT},
219   {10313, "sim/multiplay/generic/int[13]", simgear::props::INT},
220   {10314, "sim/multiplay/generic/int[14]", simgear::props::INT},
221   {10315, "sim/multiplay/generic/int[15]", simgear::props::INT},
222   {10316, "sim/multiplay/generic/int[16]", simgear::props::INT},
223   {10317, "sim/multiplay/generic/int[17]", simgear::props::INT},
224   {10318, "sim/multiplay/generic/int[18]", simgear::props::INT},
225   {10319, "sim/multiplay/generic/int[19]", simgear::props::INT}
226 };
227
228 const unsigned
229 FGMultiplayMgr::numProperties = (sizeof(FGMultiplayMgr::sIdPropertyList)
230                                  / sizeof(FGMultiplayMgr::sIdPropertyList[0]));
231
232 // Look up a property ID using binary search.
233 namespace
234 {
235   struct ComparePropertyId
236   {
237     bool operator()(const FGMultiplayMgr::IdPropertyList& lhs,
238                     const FGMultiplayMgr::IdPropertyList& rhs)
239     {
240       return lhs.id < rhs.id;
241     }
242     bool operator()(const FGMultiplayMgr::IdPropertyList& lhs,
243                     unsigned id)
244     {
245       return lhs.id < id;
246     }
247     bool operator()(unsigned id,
248                     const FGMultiplayMgr::IdPropertyList& rhs)
249     {
250       return id < rhs.id;
251     }
252   };
253     
254 }
255 const FGMultiplayMgr::IdPropertyList* FGMultiplayMgr::findProperty(unsigned id)
256 {
257   std::pair<const IdPropertyList*, const IdPropertyList*> result
258     = std::equal_range(sIdPropertyList, sIdPropertyList + numProperties, id,
259                        ComparePropertyId());
260   if (result.first == result.second) {
261     return 0;
262   } else {
263     return result.first;
264   }
265 }
266
267 namespace
268 {
269   bool verifyProperties(const xdr_data_t* data, const xdr_data_t* end)
270   {
271     using namespace simgear;
272     const xdr_data_t* xdr = data;
273     while (xdr < end) {
274       unsigned id = XDR_decode_uint32(*xdr);
275       const FGMultiplayMgr::IdPropertyList* plist
276         = FGMultiplayMgr::findProperty(id);
277     
278       if (plist) {
279         xdr++;
280         // How we decode the remainder of the property depends on the type
281         switch (plist->type) {
282         case props::INT:
283         case props::BOOL:
284         case props::LONG:
285           xdr++;
286           break;
287         case props::FLOAT:
288         case props::DOUBLE:
289           {
290             float val = XDR_decode_float(*xdr);
291             if (osg::isNaN(val))
292               return false;
293             xdr++;
294             break;
295           }
296         case props::STRING:
297         case props::UNSPECIFIED:
298           {
299             // String is complicated. It consists of
300             // The length of the string
301             // The string itself
302             // Padding to the nearest 4-bytes.
303             // XXX Yes, each byte is padded out to a word! Too late
304             // to change...
305             uint32_t length = XDR_decode_uint32(*xdr);
306             xdr++;
307             // Old versions truncated the string but left the length
308             // unadjusted.
309             if (length > MAX_TEXT_SIZE)
310               length = MAX_TEXT_SIZE;
311             xdr += length;
312             // Now handle the padding
313             while ((length % 4) != 0)
314               {
315                 xdr++;
316                 length++;
317                 //cout << "0";
318               }
319           }
320           break;
321         default:
322           // cerr << "Unknown Prop type " << id << " " << type << "\n";
323           xdr++;
324           break;
325         }            
326       }
327       else {
328         // give up; this is a malformed property list.
329         return false;
330       }
331     }
332     return true;
333   }
334 }
335 //////////////////////////////////////////////////////////////////////
336 //
337 //  MultiplayMgr constructor
338 //
339 //////////////////////////////////////////////////////////////////////
340 FGMultiplayMgr::FGMultiplayMgr() 
341 {
342   mSocket        = 0;
343   mInitialised   = false;
344   mHaveServer    = false;
345 } // FGMultiplayMgr::FGMultiplayMgr()
346 //////////////////////////////////////////////////////////////////////
347
348 //////////////////////////////////////////////////////////////////////
349 //
350 //  MultiplayMgr destructor
351 //
352 //////////////////////////////////////////////////////////////////////
353 FGMultiplayMgr::~FGMultiplayMgr() 
354 {
355   Close();
356 } // FGMultiplayMgr::~FGMultiplayMgr()
357 //////////////////////////////////////////////////////////////////////
358
359 //////////////////////////////////////////////////////////////////////
360 //
361 //  Initialise object
362 //
363 //////////////////////////////////////////////////////////////////////
364 bool
365 FGMultiplayMgr::init (void) 
366 {
367   //////////////////////////////////////////////////
368   //  Initialise object if not already done
369   //////////////////////////////////////////////////
370   if (mInitialised) {
371     SG_LOG(SG_NETWORK, SG_WARN, "FGMultiplayMgr::init - already initialised");
372     return false;
373   }
374   //////////////////////////////////////////////////
375   //  Set members from property values
376   //////////////////////////////////////////////////
377   short rxPort = fgGetInt("/sim/multiplay/rxport");
378   string rxAddress = fgGetString("/sim/multiplay/rxhost");
379   short txPort = fgGetInt("/sim/multiplay/txport");
380   string txAddress = fgGetString("/sim/multiplay/txhost");
381   mCallsign = fgGetString("/sim/multiplay/callsign");
382   if (txPort > 0 && !txAddress.empty()) {
383     mServer.set(txAddress.c_str(), txPort);
384     if (strncmp (mServer.getHost(), "0.0.0.0", 8) == 0) {
385       mHaveServer = false;
386       SG_LOG(SG_NETWORK, SG_DEBUG,
387         "FGMultiplayMgr - could not resolve '"
388         << txAddress << "', Multiplayermode disabled");
389     } else {
390       mHaveServer = true;
391     }
392     if (rxPort <= 0)
393       rxPort = txPort;
394   }
395   if (rxPort <= 0) {
396     SG_LOG(SG_NETWORK, SG_DEBUG,
397       "FGMultiplayMgr - No receiver port, Multiplayermode disabled");
398     return (false);
399   }
400   if (mCallsign.empty())
401     mCallsign = "JohnDoe"; // FIXME: use getpwuid
402   SG_LOG(SG_NETWORK,SG_INFO,"FGMultiplayMgr::init-txaddress= "<<txAddress);
403   SG_LOG(SG_NETWORK,SG_INFO,"FGMultiplayMgr::init-txport= "<<txPort );
404   SG_LOG(SG_NETWORK,SG_INFO,"FGMultiplayMgr::init-rxaddress="<<rxAddress );
405   SG_LOG(SG_NETWORK,SG_INFO,"FGMultiplayMgr::init-rxport= "<<rxPort);
406   SG_LOG(SG_NETWORK,SG_INFO,"FGMultiplayMgr::init-callsign= "<<mCallsign);
407   Close(); // Should Init be called twice, close Socket first
408            // A memory leak was reported here by valgrind
409   mSocket = new netSocket();
410   if (!mSocket->open(false)) {
411     SG_LOG( SG_NETWORK, SG_DEBUG,
412             "FGMultiplayMgr::init - Failed to create data socket" );
413     return false;
414   }
415   mSocket->setBlocking(false);
416   if (mSocket->bind(rxAddress.c_str(), rxPort) != 0) {
417     perror("bind");
418     SG_LOG( SG_NETWORK, SG_DEBUG,
419             "FGMultiplayMgr::Open - Failed to bind receive socket" );
420     return false;
421   }
422   mInitialised = true;
423   return true;
424 } // FGMultiplayMgr::init()
425 //////////////////////////////////////////////////////////////////////
426
427 //////////////////////////////////////////////////////////////////////
428 //
429 //  Closes and deletes the local player object. Closes
430 //  and deletes the tx socket. Resets the object state to unitialised.
431 //
432 //////////////////////////////////////////////////////////////////////
433 void
434 FGMultiplayMgr::Close (void) 
435 {
436   mMultiPlayerMap.clear();
437
438   if (mSocket) {
439     mSocket->close();
440     delete mSocket;
441     mSocket = 0;
442   }
443   mInitialised = false;
444 } // FGMultiplayMgr::Close(void)
445 //////////////////////////////////////////////////////////////////////
446
447 //////////////////////////////////////////////////////////////////////
448 //
449 //  Description: Sends the position data for the local position.
450 //
451 //////////////////////////////////////////////////////////////////////
452
453 /**
454  * The buffer that holds a multi-player message, suitably aligned.
455  */
456 union FGMultiplayMgr::MsgBuf
457 {
458     MsgBuf()
459     {
460         memset(&Msg, 0, sizeof(Msg));
461     }
462
463     T_MsgHdr* msgHdr()
464     {
465         return reinterpret_cast<T_MsgHdr*>(Msg);
466     }
467
468     const T_MsgHdr* msgHdr() const
469     {
470         return reinterpret_cast<const T_MsgHdr*>(Msg);
471     }
472
473     T_PositionMsg* posMsg()
474     {
475         return reinterpret_cast<T_PositionMsg*>(Msg + sizeof(T_MsgHdr));
476     }
477
478     const T_PositionMsg* posMsg() const
479     {
480         return reinterpret_cast<const T_PositionMsg*>(Msg + sizeof(T_MsgHdr));
481     }
482
483     xdr_data_t* properties()
484     {
485         return reinterpret_cast<xdr_data_t*>(Msg + sizeof(T_MsgHdr)
486                                              + sizeof(T_PositionMsg));
487     }
488
489     const xdr_data_t* properties() const
490     {
491         return reinterpret_cast<const xdr_data_t*>(Msg + sizeof(T_MsgHdr)
492                                                    + sizeof(T_PositionMsg));
493     }
494     /**
495      * The end of the properties buffer.
496      */
497     xdr_data_t* propsEnd()
498     {
499         return reinterpret_cast<xdr_data_t*>(Msg + MAX_PACKET_SIZE);
500     };
501
502     const xdr_data_t* propsEnd() const
503     {
504         return reinterpret_cast<const xdr_data_t*>(Msg + MAX_PACKET_SIZE);
505     };
506     /**
507      * The end of properties actually in the buffer. This assumes that
508      * the message header is valid.
509      */
510     xdr_data_t* propsRecvdEnd()
511     {
512         return reinterpret_cast<xdr_data_t*>(Msg + msgHdr()->MsgLen);
513     }
514
515     const xdr_data_t* propsRecvdEnd() const
516     {
517         return reinterpret_cast<const xdr_data_t*>(Msg + msgHdr()->MsgLen);
518     }
519     
520     xdr_data2_t double_val;
521     char Msg[MAX_PACKET_SIZE];
522 };
523
524 void
525 FGMultiplayMgr::SendMyPosition(const FGExternalMotionData& motionInfo)
526 {
527   if ((! mInitialised) || (! mHaveServer))
528         return;
529   if (! mHaveServer) {
530     SG_LOG( SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::SendMyPosition - no server");
531     return;
532   }
533
534   MsgBuf msgBuf;
535   T_PositionMsg* PosMsg = msgBuf.posMsg();
536
537   strncpy(PosMsg->Model, fgGetString("/sim/model/path"), MAX_MODEL_NAME_LEN);
538   PosMsg->Model[MAX_MODEL_NAME_LEN - 1] = '\0';
539   
540   PosMsg->time = XDR_encode_double (motionInfo.time);
541   PosMsg->lag = XDR_encode_double (motionInfo.lag);
542   for (unsigned i = 0 ; i < 3; ++i)
543     PosMsg->position[i] = XDR_encode_double (motionInfo.position(i));
544   SGVec3f angleAxis;
545   motionInfo.orientation.getAngleAxis(angleAxis);
546   for (unsigned i = 0 ; i < 3; ++i)
547     PosMsg->orientation[i] = XDR_encode_float (angleAxis(i));
548   for (unsigned i = 0 ; i < 3; ++i)
549     PosMsg->linearVel[i] = XDR_encode_float (motionInfo.linearVel(i));
550   for (unsigned i = 0 ; i < 3; ++i)
551     PosMsg->angularVel[i] = XDR_encode_float (motionInfo.angularVel(i));
552   for (unsigned i = 0 ; i < 3; ++i)
553     PosMsg->linearAccel[i] = XDR_encode_float (motionInfo.linearAccel(i));
554   for (unsigned i = 0 ; i < 3; ++i)
555     PosMsg->angularAccel[i] = XDR_encode_float (motionInfo.angularAccel(i));
556   
557   xdr_data_t* ptr = msgBuf.properties();
558   std::vector<FGPropertyData*>::const_iterator it;
559   it = motionInfo.properties.begin();
560   //cout << "OUTPUT PROPERTIES\n";
561   xdr_data_t* msgEnd = msgBuf.propsEnd();
562   while (it != motionInfo.properties.end() && ptr + 2 < msgEnd) {
563     
564     // First element is the ID. Write it out when we know we have room for
565     // the whole property.
566     xdr_data_t id =  XDR_encode_uint32((*it)->id);
567     // The actual data representation depends on the type
568     switch ((*it)->type) {
569       case simgear::props::INT:
570       case simgear::props::BOOL:
571       case simgear::props::LONG:
572         *ptr++ = id;
573         *ptr++ = XDR_encode_uint32((*it)->int_value);
574         //cout << "Prop:" << (*it)->id << " " << (*it)->type << " "<< (*it)->int_value << "\n";
575         break;
576       case simgear::props::FLOAT:
577       case simgear::props::DOUBLE:
578         *ptr++ = id;
579         *ptr++ = XDR_encode_float((*it)->float_value);
580         //cout << "Prop:" << (*it)->id << " " << (*it)->type << " "<< (*it)->float_value << "\n";
581         break;
582       case simgear::props::STRING:
583       case simgear::props::UNSPECIFIED:
584         {
585           // String is complicated. It consists of
586           // The length of the string
587           // The string itself
588           // Padding to the nearest 4-bytes.        
589           const char* lcharptr = (*it)->string_value;
590           
591           if (lcharptr != 0)
592           {
593             // Add the length         
594             ////cout << "String length: " << strlen(lcharptr) << "\n";
595             uint32_t len = strlen(lcharptr);
596             if (len > MAX_TEXT_SIZE)
597               len = MAX_TEXT_SIZE;
598             // XXX This should not be using 4 bytes per character!
599             // If there's not enough room for this property, drop it
600             // on the floor.
601             if (ptr + 2 + ((len + 3) & ~3) > msgEnd)
602                 goto escape;
603             //cout << "String length unint32: " << len << "\n";
604             *ptr++ = id;
605             *ptr++ = XDR_encode_uint32(len);
606             if (len != 0)
607             {
608               // Now the text itself
609               // XXX This should not be using 4 bytes per character!
610               int lcount = 0;
611               while ((*lcharptr != '\0') && (lcount < MAX_TEXT_SIZE)) 
612               {
613                 *ptr++ = XDR_encode_int8(*lcharptr);
614                 lcharptr++;
615                 lcount++;          
616               }
617
618               //cout << "Prop:" << (*it)->id << " " << (*it)->type << " " << len << " " << (*it)->string_value;
619
620               // Now pad if required
621               while ((lcount % 4) != 0)
622               {
623                 *ptr++ = XDR_encode_int8(0);
624                 lcount++;          
625                 //cout << "0";
626               }
627               
628               //cout << "\n";
629             }
630           }
631           else
632           {
633             // Nothing to encode
634             *ptr++ = id;
635             *ptr++ = XDR_encode_uint32(0);
636             //cout << "Prop:" << (*it)->id << " " << (*it)->type << " 0\n";
637           }
638         }
639         break;
640         
641       default:
642         //cout << " Unknown Type: " << (*it)->type << "\n";
643         *ptr++ = id;
644         *ptr++ = XDR_encode_float((*it)->float_value);;
645         //cout << "Prop:" << (*it)->id << " " << (*it)->type << " "<< (*it)->float_value << "\n";
646         break;
647     }
648         
649     ++it;
650   }
651 escape:
652   unsigned msgLen = reinterpret_cast<char*>(ptr) - msgBuf.Msg;
653   FillMsgHdr(msgBuf.msgHdr(), POS_DATA_ID, msgLen);
654   mSocket->sendto(msgBuf.Msg, msgLen, 0, &mServer);
655   SG_LOG(SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::SendMyPosition");
656 } // FGMultiplayMgr::SendMyPosition()
657
658 //////////////////////////////////////////////////////////////////////
659
660 //////////////////////////////////////////////////////////////////////
661 //
662 //  Name: SendTextMessage
663 //  Description: Sends a message to the player. The message must
664 //  contain a valid and correctly filled out header and optional
665 //  message body.
666 //
667 //////////////////////////////////////////////////////////////////////
668 void
669 FGMultiplayMgr::SendTextMessage(const string &MsgText)
670 {
671   if (!mInitialised || !mHaveServer)
672     return;
673
674   T_MsgHdr MsgHdr;
675   FillMsgHdr(&MsgHdr, CHAT_MSG_ID);
676   //////////////////////////////////////////////////
677   // Divide the text string into blocks that fit
678   // in the message and send the blocks.
679   //////////////////////////////////////////////////
680   unsigned iNextBlockPosition = 0;
681   T_ChatMsg ChatMsg;
682   
683   char Msg[sizeof(T_MsgHdr) + sizeof(T_ChatMsg)];
684   while (iNextBlockPosition < MsgText.length()) {
685     strncpy (ChatMsg.Text, 
686              MsgText.substr(iNextBlockPosition, MAX_CHAT_MSG_LEN - 1).c_str(),
687              MAX_CHAT_MSG_LEN);
688     ChatMsg.Text[MAX_CHAT_MSG_LEN - 1] = '\0';
689     memcpy (Msg, &MsgHdr, sizeof(T_MsgHdr));
690     memcpy (Msg + sizeof(T_MsgHdr), &ChatMsg, sizeof(T_ChatMsg));
691     mSocket->sendto (Msg, sizeof(T_MsgHdr) + sizeof(T_ChatMsg), 0, &mServer);
692     iNextBlockPosition += MAX_CHAT_MSG_LEN - 1;
693
694   }
695   
696   
697 } // FGMultiplayMgr::SendTextMessage ()
698 //////////////////////////////////////////////////////////////////////
699
700 //////////////////////////////////////////////////////////////////////
701 //
702 //  Name: ProcessData
703 //  Description: Processes data waiting at the receive socket. The
704 //  processing ends when there is no more data at the socket.
705 //  
706 //////////////////////////////////////////////////////////////////////
707 void
708 FGMultiplayMgr::Update(void) 
709 {
710   if (!mInitialised)
711     return;
712
713   /// Just for expiry
714   long stamp = SGTimeStamp::now().getSeconds();
715
716   //////////////////////////////////////////////////
717   //  Read the receive socket and process any data
718   //////////////////////////////////////////////////
719   ssize_t bytes;
720   do {
721     MsgBuf msgBuf;
722     //////////////////////////////////////////////////
723     //  Although the recv call asks for 
724     //  MAX_PACKET_SIZE of data, the number of bytes
725     //  returned will only be that of the next
726     //  packet waiting to be processed.
727     //////////////////////////////////////////////////
728     netAddress SenderAddress;
729     bytes = mSocket->recvfrom(msgBuf.Msg, sizeof(msgBuf.Msg), 0,
730                               &SenderAddress);
731     //////////////////////////////////////////////////
732     //  no Data received
733     //////////////////////////////////////////////////
734     if (bytes <= 0) {
735       if (errno != EAGAIN && errno != 0) // MSVC output "NoError" otherwise
736         perror("FGMultiplayMgr::MP_ProcessData");
737       break;
738     }
739     if (bytes <= static_cast<ssize_t>(sizeof(T_MsgHdr))) {
740       SG_LOG( SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::MP_ProcessData - "
741               << "received message with insufficient data" );
742       break;
743     }
744     //////////////////////////////////////////////////
745     //  Read header
746     //////////////////////////////////////////////////
747     T_MsgHdr* MsgHdr = msgBuf.msgHdr();
748     MsgHdr->Magic       = XDR_decode_uint32 (MsgHdr->Magic);
749     MsgHdr->Version     = XDR_decode_uint32 (MsgHdr->Version);
750     MsgHdr->MsgId       = XDR_decode_uint32 (MsgHdr->MsgId);
751     MsgHdr->MsgLen      = XDR_decode_uint32 (MsgHdr->MsgLen);
752     MsgHdr->ReplyPort   = XDR_decode_uint32 (MsgHdr->ReplyPort);
753     MsgHdr->Callsign[MAX_CALLSIGN_LEN -1] = '\0';
754     if (MsgHdr->Magic != MSG_MAGIC) {
755       SG_LOG( SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::MP_ProcessData - "
756               << "message has invalid magic number!" );
757       break;
758     }
759     if (MsgHdr->Version != PROTO_VER) {
760       SG_LOG( SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::MP_ProcessData - "
761               << "message has invalid protocoll number!" );
762       break;
763     }
764     if (MsgHdr->MsgLen != bytes) {
765       SG_LOG(SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::MP_ProcessData - "
766              << "message from " << MsgHdr->Callsign << " has invalid length!");
767       break;
768     }
769     //////////////////////////////////////////////////
770     //  Process messages
771     //////////////////////////////////////////////////
772     switch (MsgHdr->MsgId) {
773     case CHAT_MSG_ID:
774       ProcessChatMsg(msgBuf, SenderAddress);
775       break;
776     case POS_DATA_ID:
777       ProcessPosMsg(msgBuf, SenderAddress, stamp);
778       break;
779     case UNUSABLE_POS_DATA_ID:
780     case OLD_OLD_POS_DATA_ID:
781     case OLD_PROP_MSG_ID:
782     case OLD_POS_DATA_ID:
783       break;
784     default:
785       SG_LOG( SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::MP_ProcessData - "
786               << "Unknown message Id received: " << MsgHdr->MsgId );
787       break;
788     }
789   } while (bytes > 0);
790
791   // check for expiry
792   MultiPlayerMap::iterator it = mMultiPlayerMap.begin();
793   while (it != mMultiPlayerMap.end()) {
794     if (it->second->getLastTimestamp() + 10 < stamp) {
795       std::string name = it->first;
796       it->second->setDie(true);
797       mMultiPlayerMap.erase(it);
798       it = mMultiPlayerMap.upper_bound(name);
799     } else
800       ++it;
801   }
802 } // FGMultiplayMgr::ProcessData(void)
803 //////////////////////////////////////////////////////////////////////
804
805 //////////////////////////////////////////////////////////////////////
806 //
807 //  handle a position message
808 //
809 //////////////////////////////////////////////////////////////////////
810 void
811 FGMultiplayMgr::ProcessPosMsg(const FGMultiplayMgr::MsgBuf& Msg,
812                               const netAddress& SenderAddress, long stamp)
813 {
814   const T_MsgHdr* MsgHdr = Msg.msgHdr();
815   if (MsgHdr->MsgLen < sizeof(T_MsgHdr) + sizeof(T_PositionMsg)) {
816     SG_LOG( SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::MP_ProcessData - "
817             << "Position message received with insufficient data" );
818     return;
819   }
820   const T_PositionMsg* PosMsg = Msg.posMsg();
821   FGExternalMotionData motionInfo;
822   motionInfo.time = XDR_decode_double(PosMsg->time);
823   motionInfo.lag = XDR_decode_double(PosMsg->lag);
824   for (unsigned i = 0; i < 3; ++i)
825     motionInfo.position(i) = XDR_decode_double(PosMsg->position[i]);
826   SGVec3f angleAxis;
827   for (unsigned i = 0; i < 3; ++i)
828     angleAxis(i) = XDR_decode_float(PosMsg->orientation[i]);
829   motionInfo.orientation = SGQuatf::fromAngleAxis(angleAxis);
830   for (unsigned i = 0; i < 3; ++i)
831     motionInfo.linearVel(i) = XDR_decode_float(PosMsg->linearVel[i]);
832   for (unsigned i = 0; i < 3; ++i)
833     motionInfo.angularVel(i) = XDR_decode_float(PosMsg->angularVel[i]);
834   for (unsigned i = 0; i < 3; ++i)
835     motionInfo.linearAccel(i) = XDR_decode_float(PosMsg->linearAccel[i]);
836   for (unsigned i = 0; i < 3; ++i)
837     motionInfo.angularAccel(i) = XDR_decode_float(PosMsg->angularAccel[i]);
838
839
840   //cout << "INPUT MESSAGE\n";
841
842   // There was a bug in 1.9.0 and before: T_PositionMsg was 196 bytes
843   // on 32 bit architectures and 200 bytes on 64 bit, and this
844   // structure is put directly on the wire. By looking at the padding,
845   // we can sort through the mess, mostly:
846   // If padding is 0 (which is not a valid property type), then the
847   // message was produced by a new client or an old 64 bit client that
848   // happened to have 0 on the stack;
849   // Else if the property list starting with the padding word is
850   // well-formed, then the client is probably an old 32 bit client and
851   // we'll go with that;
852   // Else it is an old 64-bit client and properties start after the
853   // padding.
854   // There is a chance that we could be fooled by garbage in the
855   // padding looking like a valid property, so verifyProperties() is
856   // strict about the validity of the property values.
857   const xdr_data_t* xdr = Msg.properties();
858   if (PosMsg->pad != 0) {
859     if (verifyProperties(&PosMsg->pad, Msg.propsRecvdEnd()))
860       xdr = &PosMsg->pad;
861     else if (!verifyProperties(xdr, Msg.propsRecvdEnd()))
862       goto noprops;
863   }
864   while (xdr < Msg.propsRecvdEnd()) {
865     FGPropertyData* pData = new FGPropertyData;
866     // simgear::props::Type type = simgear::props::UNSPECIFIED;
867     
868     // First element is always the ID
869     pData->id = XDR_decode_uint32(*xdr);
870     //cout << pData->id << " ";
871     xdr++;
872     
873     // Check the ID actually exists and get the type
874     const IdPropertyList* plist = findProperty(pData->id);
875     
876     if (plist)
877     {
878       pData->type = plist->type;
879       // How we decode the remainder of the property depends on the type
880       switch (pData->type) {
881         case simgear::props::INT:
882         case simgear::props::BOOL:
883         case simgear::props::LONG:
884           pData->int_value = XDR_decode_uint32(*xdr);
885           xdr++;
886           //cout << pData->int_value << "\n";
887           break;
888         case simgear::props::FLOAT:
889         case simgear::props::DOUBLE:
890           pData->float_value = XDR_decode_float(*xdr);
891           xdr++;
892           //cout << pData->float_value << "\n";
893           break;
894         case simgear::props::STRING:
895         case simgear::props::UNSPECIFIED:
896           {
897             // String is complicated. It consists of
898             // The length of the string
899             // The string itself
900             // Padding to the nearest 4-bytes.    
901             uint32_t length = XDR_decode_uint32(*xdr);
902             xdr++;
903             //cout << length << " ";
904             // Old versions truncated the string but left the length unadjusted.
905             if (length > MAX_TEXT_SIZE)
906               length = MAX_TEXT_SIZE;
907             pData->string_value = new char[length + 1];
908             //cout << " String: ";
909             for (unsigned i = 0; i < length; i++)
910               {
911                 pData->string_value[i] = (char) XDR_decode_int8(*xdr);
912                 xdr++;
913                 //cout << pData->string_value[i];
914               }
915
916             pData->string_value[length] = '\0';
917
918             // Now handle the padding
919             while ((length % 4) != 0)
920               {
921                 xdr++;
922                 length++;
923                 //cout << "0";
924               }
925             //cout << "\n";
926           }
927           break;
928
929         default:
930           pData->float_value = XDR_decode_float(*xdr);
931           SG_LOG(SG_NETWORK, SG_DEBUG, "Unknown Prop type " << pData->id << " " << pData->type);
932           xdr++;
933           break;
934       }            
935
936       motionInfo.properties.push_back(pData);
937     }
938     else
939     {
940       // We failed to find the property. We'll try the next packet immediately.
941       SG_LOG(SG_NETWORK, SG_INFO, "FGMultiplayMgr::ProcessPosMsg - "
942              "message from " << MsgHdr->Callsign << " has unknown property id "
943              << pData->id); 
944     }
945   }
946  noprops:
947   FGAIMultiplayer* mp = getMultiplayer(MsgHdr->Callsign);
948   if (!mp)
949     mp = addMultiplayer(MsgHdr->Callsign, PosMsg->Model);
950   mp->addMotionInfo(motionInfo, stamp);
951 } // FGMultiplayMgr::ProcessPosMsg()
952 //////////////////////////////////////////////////////////////////////
953
954 //////////////////////////////////////////////////////////////////////
955 //
956 //  handle a chat message
957 //  FIXME: display chat message withi flightgear
958 //
959 //////////////////////////////////////////////////////////////////////
960 void
961 FGMultiplayMgr::ProcessChatMsg(const MsgBuf& Msg,
962                                const netAddress& SenderAddress)
963 {
964   const T_MsgHdr* MsgHdr = Msg.msgHdr();
965   if (MsgHdr->MsgLen < sizeof(T_MsgHdr) + 1) {
966     SG_LOG( SG_NETWORK, SG_DEBUG, "FGMultiplayMgr::MP_ProcessData - "
967             << "Chat message received with insufficient data" );
968     return;
969   }
970   
971   char *chatStr = new char[MsgHdr->MsgLen - sizeof(T_MsgHdr)];
972   const T_ChatMsg* ChatMsg
973       = reinterpret_cast<const T_ChatMsg *>(Msg.Msg + sizeof(T_MsgHdr));
974   strncpy(chatStr, ChatMsg->Text,
975           MsgHdr->MsgLen - sizeof(T_MsgHdr));
976   chatStr[MsgHdr->MsgLen - sizeof(T_MsgHdr) - 1] = '\0';
977   
978   SG_LOG (SG_NETWORK, SG_WARN, "Chat [" << MsgHdr->Callsign << "]"
979            << " " << chatStr);
980
981   delete [] chatStr;
982 } // FGMultiplayMgr::ProcessChatMsg ()
983 //////////////////////////////////////////////////////////////////////
984
985 void
986 FGMultiplayMgr::FillMsgHdr(T_MsgHdr *MsgHdr, int MsgId, unsigned _len)
987 {
988   uint32_t len;
989   switch (MsgId) {
990   case CHAT_MSG_ID:
991     len = sizeof(T_MsgHdr) + sizeof(T_ChatMsg);
992     break;
993   case POS_DATA_ID:
994     len = _len;
995     break;
996   default:
997     len = sizeof(T_MsgHdr);
998     break;
999   }
1000   MsgHdr->Magic           = XDR_encode_uint32(MSG_MAGIC);
1001   MsgHdr->Version         = XDR_encode_uint32(PROTO_VER);
1002   MsgHdr->MsgId           = XDR_encode_uint32(MsgId);
1003   MsgHdr->MsgLen          = XDR_encode_uint32(len);
1004   MsgHdr->ReplyAddress    = 0; // Are obsolete, keep them for the server for
1005   MsgHdr->ReplyPort       = 0; // now
1006   strncpy(MsgHdr->Callsign, mCallsign.c_str(), MAX_CALLSIGN_LEN);
1007   MsgHdr->Callsign[MAX_CALLSIGN_LEN - 1] = '\0';
1008 }
1009
1010 FGAIMultiplayer*
1011 FGMultiplayMgr::addMultiplayer(const std::string& callsign,
1012                                const std::string& modelName)
1013 {
1014   if (0 < mMultiPlayerMap.count(callsign))
1015     return mMultiPlayerMap[callsign].get();
1016
1017   FGAIMultiplayer* mp = new FGAIMultiplayer;
1018   mp->setPath(modelName.c_str());
1019   mp->setCallSign(callsign);
1020   mMultiPlayerMap[callsign] = mp;
1021
1022   FGAIManager *aiMgr = (FGAIManager*)globals->get_subsystem("ai_model");
1023   if (aiMgr) {
1024     aiMgr->attach(mp);
1025
1026     /// FIXME: that must follow the attach ATM ...
1027     for (unsigned i = 0; i < numProperties; ++i)
1028       mp->addPropertyId(sIdPropertyList[i].id, sIdPropertyList[i].name);
1029   }
1030
1031   return mp;
1032 }
1033
1034 FGAIMultiplayer*
1035 FGMultiplayMgr::getMultiplayer(const std::string& callsign)
1036 {
1037   if (0 < mMultiPlayerMap.count(callsign))
1038     return mMultiPlayerMap[callsign].get();
1039   else
1040     return 0;
1041 }