source: trunk/CrypP2P/Internal/P2PBase.cs @ 1919

Last change on this file since 1919 was 1919, checked in by Paul Lelgemann, 11 years ago

o Updated peers@play libraries to revision 5611: Updated PapsClient supports OverlayMessages needed for Christian Arnolds KeySearcher
o Improved handling of SystemLeft events, allowing to reconnect with P2PEditor using Paps

File size: 20.4 KB
Line 
1/*
2   Copyright 2010 Paul Lelgemann and Christian Arnold,
3                  University of Duisburg-Essen
4
5   Licensed under the Apache License, Version 2.0 (the "License");
6   you may not use this file except in compliance with the License.
7   You may obtain a copy of the License at
8
9       http://www.apache.org/licenses/LICENSE-2.0
10
11   Unless required by applicable law or agreed to in writing, software
12   distributed under the License is distributed on an "AS IS" BASIS,
13   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   See the License for the specific language governing permissions and
15   limitations under the License.
16*/
17
18using System;
19using System.Linq;
20using System.Text;
21using System.Threading;
22using Cryptool.PluginBase;
23using Cryptool.Plugins.PeerToPeer.Internal;
24using Gears4Net;
25using PeersAtPlay;
26using PeersAtPlay.Monitoring;
27using PeersAtPlay.P2PLink;
28using PeersAtPlay.P2PLink.SnalNG;
29using PeersAtPlay.P2POverlay;
30using PeersAtPlay.P2POverlay.Bootstrapper;
31using PeersAtPlay.P2POverlay.Bootstrapper.IrcBootstrapperV2;
32using PeersAtPlay.P2POverlay.Bootstrapper.LocalMachineBootstrapper;
33using PeersAtPlay.P2POverlay.FullMeshOverlay;
34using PeersAtPlay.P2PStorage.DHT;
35using PeersAtPlay.P2PStorage.FullMeshDHT;
36using PeersAtPlay.PapsClient;
37using PeersAtPlay.Util.Logging;
38using PeersAtPlay.P2POverlay.Chord;
39
40/* TODO:
41 * - Delete UseNatTraversal-Flag and insert CertificateCheck and CertificateSetup
42 * - Testing asynchronous methods incl. EventHandlers
43 */
44
45namespace Cryptool.P2P.Internal
46{
47    /// <summary>
48    ///   Wrapper class to integrate peer@play environment into CrypTool.
49    ///   This class synchronizes asynchronous methods for easier usage in CT2.
50    /// </summary>
51    public class P2PBase
52    {
53        #region Variables
54
55        private AutoResetEvent systemJoined;
56        private readonly AutoResetEvent systemLeft;
57        private IBootstrapper bootstrapper;
58        private IP2PLinkManager linkmanager;
59        private P2POverlay overlay;
60        internal IDHT Dht;
61        internal IVersionedDHT VersionedDht;
62
63        /// <summary>
64        ///   True if system was successfully joined, false if system is COMPLETELY left
65        /// </summary>
66        public bool IsConnected { get; private set; }
67
68        /// <summary>
69        ///   True if the underlying peer to peer system has been fully initialized
70        /// </summary>
71        public bool IsInitialized { get; private set; }
72
73        #endregion
74
75        #region Delegates
76
77        public event P2PMessageReceived OnP2PMessageReceived;
78        public delegate void P2PMessageReceived(PeerId sourceAddr, byte[] data);
79
80        public event SystemJoined OnSystemJoined;
81        public delegate void SystemJoined();
82
83        public event SystemLeft OnSystemLeft;
84        public delegate void SystemLeft();
85
86        #endregion
87
88        public P2PBase()
89        {
90            IsConnected = false;
91            IsInitialized = false;
92
93            systemJoined = new AutoResetEvent(false);
94            systemLeft = new AutoResetEvent(false);
95        }
96
97        #region Basic P2P Methods (Init, Start, Stop)
98
99        /// <summary>
100        ///   Initializes the underlying peer-to-peer system with settings configured in P2PSettings. This step is required in order to be able to establish a connection.
101        /// </summary>
102        public void Initialize()
103        {
104            Scheduler scheduler = new STAScheduler("pap");
105
106            switch (P2PSettings.Default.LinkManager)
107            {
108                case P2PLinkManagerType.Snal:
109                    LogToMonitor("Init LinkMgr: Using NAT Traversal stuff");
110
111                    // NAT-Traversal stuff needs a different Snal-Version
112                    linkmanager = new Snal(scheduler);
113
114                    var settings = new PeersAtPlay.P2PLink.SnalNG.Settings();
115                    settings.LoadDefaults();
116                    settings.ConnectInternal = true;
117                    settings.LocalReceivingPort = P2PSettings.Default.LocalReceivingPort;
118                    settings.UseLocalAddressDetection = P2PSettings.Default.UseLocalAddressDetection;
119                    settings.NoDelay = false;
120                    settings.ReuseAddress = false;
121                    settings.UseNetworkMonitorServer = true;
122                    settings.CloseConnectionAfterPingTimeout = true;
123
124                    settings.FragmentMessages = true;
125                    settings.FragmentMessageSize = 10*1024;
126                       
127                    switch(P2PSettings.Default.TransportProtocol)
128                    {
129                        case P2PTransportProtocol.UDP:
130                            settings.TransportProtocol = TransportProtocol.UDP;
131                            break;
132                        case P2PTransportProtocol.TCP_UDP:
133                            settings.TransportProtocol = TransportProtocol.TCP_UDP;
134                            break;
135                        default:
136                            settings.TransportProtocol = TransportProtocol.TCP;
137                            break;
138                    }
139
140                    linkmanager.Settings = settings;
141                    linkmanager.ApplicationType = ApplicationType.CrypTool;
142
143                    break;
144                default:
145                    throw new NotImplementedException();
146            }
147
148            switch (P2PSettings.Default.Bootstrapper)
149            {
150                case P2PBootstrapperType.LocalMachineBootstrapper:
151                    // LocalMachineBootstrapper = only local connection (runs only on one machine)
152                    bootstrapper = new LocalMachineBootstrapper();
153                    break;
154                case P2PBootstrapperType.IrcBootstrapper:
155                    PeersAtPlay.P2POverlay.Bootstrapper.IrcBootstrapperV2.Settings.DelaySymmetricResponse = true;
156                    PeersAtPlay.P2POverlay.Bootstrapper.IrcBootstrapperV2.Settings.IncludeSymmetricResponse = false;
157                    PeersAtPlay.P2POverlay.Bootstrapper.IrcBootstrapperV2.Settings.UsePeerCache = false;
158
159                    bootstrapper = new IrcBootstrapper(scheduler);
160                    break;
161                default:
162                    throw new NotImplementedException();
163            }
164
165            try
166            {
167                switch (P2PSettings.Default.Architecture)
168                {
169                    case P2PArchitecture.FullMesh:
170                        overlay = new FullMeshOverlay(scheduler);
171                        Dht = new FullMeshDHT(scheduler);
172                        break;
173                    case P2PArchitecture.Chord:
174                        overlay = new ChordNGCore(scheduler);
175                        Dht = (IDHT) overlay;
176                        break;
177                    case P2PArchitecture.Server:
178                        PeersAtPlay.PapsClient.Properties.Settings.Default.ServerHost = P2PSettings.Default.ServerHost;
179                        PeersAtPlay.PapsClient.Properties.Settings.Default.ServerPort = P2PSettings.Default.ServerPort;
180                        bootstrapper = new LocalMachineBootstrapper();
181                        overlay = new PapsClientOverlay();
182                        Dht = new PapsClientDht(scheduler);
183                        break;
184                    default:
185                        throw new NotImplementedException();
186                }
187            }
188            catch(Exception e)
189            {
190                P2PManager.GuiLogMessage("Error initializing P2P network: " + e.Message, NotificationLevel.Error);
191                return;
192            }
193
194            overlay.MessageReceived += OverlayMessageReceived;
195            Dht.SystemJoined += OnDhtSystemJoined;
196            Dht.SystemLeft += OnDhtSystemLeft;
197
198            VersionedDht = (IVersionedDHT) Dht;
199
200            P2PManager.GuiLogMessage("Initializing DHT with world name " + P2PSettings.Default.WorldName,
201                                        NotificationLevel.Info);
202            IsInitialized = true;
203            Dht.Initialize(P2PSettings.Default.PeerName, string.Empty, P2PSettings.Default.WorldName, overlay,
204                           bootstrapper, linkmanager, null);
205        }
206
207        /// <summary>
208        ///   Starts the P2P System. When the given P2P world doesn't exist yet,
209        ///   inclusive creating the and bootstrapping to the P2P network.
210        ///   In either case joining the P2P world.
211        ///   This synchronized method returns true not before the peer has
212        ///   successfully joined the network (this may take one or two minutes).
213        /// </summary>
214        /// <exception cref = "InvalidOperationException">When the peer-to-peer system has not been initialized.
215        /// After validating the settings, this can be done by calling Initialize().</exception>
216        /// <returns>True, if the peer has completely joined the p2p network</returns>
217        public bool SynchStart()
218        {
219            if (!IsInitialized)
220            {
221                throw new InvalidOperationException("Peer-to-peer is not initialized.");
222            }
223
224            if (IsConnected)
225            {
226                return true;
227            }
228
229            try
230            {
231                Dht.BeginStart(BeginStartEventHandler);
232
233                // Wait for event SystemJoined. When it's invoked, the peer completely joined the P2P system
234                systemJoined.WaitOne();
235                P2PManager.GuiLogMessage("System join process ended.", NotificationLevel.Debug);
236            }
237            catch (Exception e)
238            {
239                e.GetBaseException();
240            }
241
242            return true;
243        }
244
245        private void BeginStartEventHandler(DHTEventArgs eventArgs)
246        {
247            P2PManager.GuiLogMessage("Received DHTEventArgs: " + eventArgs + ", state: " + eventArgs.State, NotificationLevel.Debug);
248        }
249
250        /// <summary>
251        ///   Disconnects from the peer-to-peer system.
252        /// </summary>
253        /// <returns>True, if the peer has completely left the p2p network</returns>
254        public bool SynchStop()
255        {
256            if (Dht == null) return false;
257
258            Dht.BeginStop(null);
259
260            if (IsConnected)
261                systemLeft.WaitOne();
262
263            systemJoined.Reset();
264            systemLeft.Reset();
265
266            return true;
267        }
268
269        #endregion
270
271        #region Peer related method (GetPeerId, Send message to peer)
272
273        /// <summary>
274        ///   Get PeerName of the actual peer
275        /// </summary>
276        /// <param name = "sPeerName">out: additional peer information UserName on LinkManager</param>
277        /// <returns>PeerID as a String</returns>
278        public PeerId GetPeerId(out string sPeerName)
279        {
280            sPeerName = linkmanager.UserName;
281            return new PeerId(overlay.LocalAddress);
282        }
283
284        /// <summary>
285        ///   Construct PeerId object for a specific byte[] id
286        /// </summary>
287        /// <param name = "byteId">overlay address as byte array</param>
288        /// <returns>corresponding PeerId for given byte[] id</returns>
289        public PeerId GetPeerId(byte[] byteId)
290        {
291            LogToMonitor("GetPeerID: Converting byte[] to PeerId-Object");
292            return new PeerId(overlay.GetAddress(byteId));
293        }
294
295        // overlay.LocalAddress = Overlay-Peer-Address/Names
296        public void SendToPeer(byte[] data, byte[] destinationPeer)
297        {
298            // get stack size of the pap use-data and add own use data (for optimizing Stack size)
299            var realStackSize = overlay.GetHeaderSize() + data.Length;
300
301            var stackData = new ByteStack(realStackSize);
302            stackData.Push(data);
303
304            var destinationAddr = overlay.GetAddress(destinationPeer);
305            var overlayMsg = new OverlayMessage(MessageReceiverType.P2PBase, 
306                                                overlay.LocalAddress, destinationAddr, stackData);
307
308            overlay.Send(overlayMsg);
309        }
310
311        private void OverlayMessageReceived(object sender, OverlayMessageEventArgs e)
312        {
313            if (OnP2PMessageReceived == null) return;
314
315            var pid = new PeerId(e.Message.Source);
316            /* You have to fire this event asynchronous, because the main
317                 * thread will be stopped in this wrapper class for synchronizing
318                 * the asynchronous stuff (AutoResetEvent) --> so this could run
319                 * into a deadlock, when you fire this event synchronous (normal Invoke)
320                 * ATTENTION: This could change the invocation order!!! In my case
321                              no problem, but maybe in future cases... */
322
323            // TODO: not safe: The delegate must have only one target
324            // OnP2PMessageReceived.BeginInvoke(pid, e.Message.Data.PopBytes(e.Message.Data.CurrentStackSize), null, null);
325
326            foreach (var del in OnP2PMessageReceived.GetInvocationList())
327            {
328                var data = e.Message.Data.ToArray();
329                if (e.Message.Data.CurrentStackSize != 0)
330                    data = e.Message.Data.PopBytes(e.Message.Data.CurrentStackSize);
331
332                del.DynamicInvoke(pid, data);
333            }
334        }
335
336        #endregion
337
338        #region Event Handling (System Joined, Left and Message Received)
339
340        private void OnDhtSystemJoined(object sender, EventArgs e)
341        {
342            IsConnected = true;
343
344            if (OnSystemJoined != null)
345                OnSystemJoined();
346
347            systemJoined.Set();
348        }
349
350        private void OnDhtSystemLeft(object sender, SystemLeftEventArgs e)
351        {
352            if (OnSystemLeft != null)
353                OnSystemLeft();
354
355            IsConnected = false;
356            IsInitialized = false;
357
358            // Allow new connection to start and check for waiting / blocked tasks
359            // TODO reset running ConnectionWorkers?
360            systemLeft.Set();
361            systemJoined.Set();
362
363            LogToMonitor("CrypP2P left the system.");
364        }
365
366        #endregion
367
368        #region Synchronous Methods + their Callbacks
369
370        /// <summary>
371        ///   Stores a value in the DHT at the given key
372        /// </summary>
373        /// <param name = "key">Key of DHT Entry</param>
374        /// <param name = "value">Value of DHT Entry</param>
375        /// <returns>True, when storing is completed!</returns>
376        public RequestResult SynchStore(string key, string value)
377        {
378            return SynchStore(key, Encoding.UTF8.GetBytes(value));
379        }
380
381        /// <summary>
382        ///   Stores a value in the DHT at the given key
383        /// </summary>
384        /// <param name = "key">Key of DHT Entry</param>
385        /// <param name = "data">Value of DHT Entry</param>
386        /// <returns>True, when storing is completed!</returns>
387        public RequestResult SynchStore(string key, byte[] data)
388        {
389            var autoResetEvent = new AutoResetEvent(false);
390
391            // LogToMonitor("testcrash" + Encoding.UTF8.GetString(new byte[5000]));
392            LogToMonitor("Begin: SynchStore. Key: " + key + ", " + (data != null ? data.Length : 0) + " bytes");
393
394            var requestResult = new RequestResult {WaitHandle = autoResetEvent, Key = key, Data = data};
395            VersionedDht.Store(OnSynchStoreCompleted, key, data, requestResult);
396
397            // blocking till response
398            autoResetEvent.WaitOne();
399
400            LogToMonitor("End: SynchStore. Key: " + key + ". Status: " + requestResult.Status);
401
402            return requestResult;
403        }
404
405        /// <summary>
406        ///   Callback for a the synchronized store method
407        /// </summary>
408        /// <param name = "storeResult">retrieved data container</param>
409        private static void OnSynchStoreCompleted(StoreResult storeResult)
410        {
411            var requestResult = storeResult.AsyncState as RequestResult;
412            if (requestResult == null)
413            {
414                LogToMonitor("Received OnSynchStoreCompleted, but RequestResult object is missing. Discarding.");
415                return;
416            }
417
418            requestResult.Parse(storeResult);
419
420            // unblock WaitHandle in the synchronous method
421            requestResult.WaitHandle.Set();
422        }
423
424        /// <summary>
425        ///   Get the value of the given DHT Key or null, if it doesn't exist.
426        /// </summary>
427        /// <param name = "key">Key of DHT Entry</param>
428        /// <returns>Value of DHT Entry</returns>
429        public RequestResult SynchRetrieve(string key)
430        {
431            LogToMonitor("Begin: SynchRetrieve. Key: " + key);
432
433            var autoResetEvent = new AutoResetEvent(false);
434            var requestResult = new RequestResult {WaitHandle = autoResetEvent, Key = key};
435
436            Dht.Retrieve(OnSynchRetrieveCompleted, key, requestResult);
437
438            // blocking till response
439            autoResetEvent.WaitOne();
440
441            LogToMonitor("End: SynchRetrieve. Key: " + key + ". Status: " + requestResult.Status);
442
443            return requestResult;
444        }
445
446        /// <summary>
447        ///   Callback for a the synchronized retrieval method
448        /// </summary>
449        /// <param name = "retrieveResult"></param>
450        private static void OnSynchRetrieveCompleted(RetrieveResult retrieveResult)
451        {
452            var requestResult = retrieveResult.AsyncState as RequestResult;
453            if (requestResult == null)
454            {
455                LogToMonitor("Received OnSynchRetrieveCompleted, but RequestResult object is missing. Discarding.");
456                return;
457            }
458
459            requestResult.Parse(retrieveResult);
460
461            // unblock WaitHandle in the synchronous method
462            requestResult.WaitHandle.Set();
463        }
464
465        /// <summary>
466        ///   Removes a key/value pair out of the DHT
467        /// </summary>
468        /// <param name = "key">Key of the DHT Entry</param>
469        /// <returns>True, when removing is completed!</returns>
470        public RequestResult SynchRemove(string key)
471        {
472            LogToMonitor("Begin SynchRemove. Key: " + key);
473
474            var autoResetEvent = new AutoResetEvent(false);
475            var requestResult = new RequestResult { WaitHandle = autoResetEvent, Key = key };
476            VersionedDht.Remove(OnSynchRemoveCompleted, key, requestResult);
477
478            // blocking till response
479            autoResetEvent.WaitOne();
480
481            LogToMonitor("End: SynchRemove. Key: " + key + ". Status: " + requestResult.Status);
482
483            return requestResult;
484        }
485
486        /// <summary>
487        ///   Callback for a the synchronized remove method
488        /// </summary>
489        /// <param name = "removeResult"></param>
490        private static void OnSynchRemoveCompleted(RemoveResult removeResult)
491        {
492            var requestResult = removeResult.AsyncState as RequestResult;
493            if (requestResult == null)
494            {
495                LogToMonitor("Received OnSynchRemoveCompleted, but RequestResult object is missing. Discarding.");
496                return;
497            }
498
499            requestResult.Parse(removeResult);
500
501            // unblock WaitHandle in the synchronous method
502            requestResult.WaitHandle.Set();
503        }
504
505        #endregion
506
507        #region Statistic Methods
508
509        public long TotalBytesSentOnAllLinks()
510        {
511            return (long) linkmanager.GetAllLinkInformation().Sum(linkInformation => linkInformation.TotalBytesSent);
512        }
513
514        public long TotalBytesReceivedOnAllLinks()
515        {
516            return (long) linkmanager.GetAllLinkInformation().Sum(linkInformation => linkInformation.TotalBytesReceived);
517        }
518
519        #endregion
520
521        #region Log facility
522
523        /// <summary>
524        ///   To log the internal state in the Monitoring Software of P@play
525        /// </summary>
526        public void LogInternalState()
527        {
528            if (Dht != null)
529            {
530                Dht.LogInternalState();
531            }
532        }
533
534        private static void LogToMonitor(string sTextToLog)
535        {
536            if (P2PSettings.Default.Log2Monitor)
537                Log.Debug(sTextToLog);
538        }
539
540        #endregion
541    }
542}
Note: See TracBrowser for help on using the repository browser.