dlls/dplayx/name_server.c

   1 /* DPLAYX.DLL name server implementation
   2  *
   3  * Copyright 2000-2001 - Peter Hunnisett
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 /* NOTE: Methods with the NS_ prefix are name server methods */
  21
  22 #include <stdarg.h>
  23 #include <string.h>
  24
  25 #define NONAMELESSUNION
  26 #define NONAMELESSSTRUCT
  27 #include "windef.h"
  28 #include "winbase.h"
  29 #include "winnls.h"
  30 #include "wine/unicode.h"
  31 #include "wine/debug.h"
  32 #include "mmsystem.h"
  33
  34 #include "dplayx_global.h"
  35 #include "name_server.h"
  36 #include "wine/dplaysp.h"
  37 #include "dplayx_messages.h"
  38 #include "dplayx_queue.h"
  39
  40 /* FIXME: Need to create a crit section, store and use it */
  41
  42 WINE_DEFAULT_DEBUG_CHANNEL(dplay);
  43
  44 /* NS specific structures */
  45 struct NSCacheData
  46 {
  47   DPQ_ENTRY(NSCacheData) next;
  48
  49   DWORD dwTime; /* Time at which data was last known valid */
  50   LPDPSESSIONDESC2 data;
  51
  52   LPVOID lpNSAddrHdr;
  53
  54 };
  55 typedef struct NSCacheData NSCacheData, *lpNSCacheData;
  56
  57 struct NSCache
  58 {
  59   lpNSCacheData present; /* keep track of what is to be looked at when walking */
  60
  61   DPQ_HEAD(NSCacheData) first;
  62
  63   BOOL bNsIsLocal;
  64   LPVOID lpLocalAddrHdr;  /* FIXME: Not yet used */
  65   LPVOID lpRemoteAddrHdr; /* FIXME: Not yet used */
  66 };
  67 typedef struct NSCache NSCache, *lpNSCache;
  68
  69 /* Function prototypes */
  70 static DPQ_DECL_DELETECB( cbDeleteNSNodeFromHeap, lpNSCacheData );
  71
  72 /* Name Server functions
  73  * ---------------------
  74  */
  75 void NS_SetLocalComputerAsNameServer( LPCDPSESSIONDESC2 lpsd, LPVOID lpNSInfo )
  76 {
  77 #if 0
  78   /* FIXME: Remove this method? */
  79   DPLAYX_SetLocalSession( lpsd );
  80 #endif
  81   lpNSCache lpCache = (lpNSCache)lpNSInfo;
  82
  83   lpCache->bNsIsLocal = TRUE;
  84 }
  85
  86 static DPQ_DECL_COMPARECB( cbUglyPig, GUID )
  87 {
  88   return IsEqualGUID( elem1, elem2 );
  89 }
  90
  91 /* Store the given NS remote address for future reference */
  92 void NS_AddRemoteComputerAsNameServer( LPCVOID                      lpcNSAddrHdr,
  93                                        DWORD                        dwHdrSize,
  94                                        LPCDPMSG_ENUMSESSIONSREPLY   lpcMsg,
  95                                        LPVOID                       lpNSInfo )
  96 {
  97   DWORD len;
  98   lpNSCache     lpCache = (lpNSCache)lpNSInfo;
  99   lpNSCacheData lpCacheNode;
 100
 101   TRACE( "%p, %p, %p\n", lpcNSAddrHdr, lpcMsg, lpNSInfo );
 102
 103   /* See if we can find this session. If we can, remove it as it's a dup */
 104   DPQ_REMOVE_ENTRY_CB( lpCache->first, next, data->guidInstance, cbUglyPig,
 105                        lpcMsg->sd.guidInstance, lpCacheNode );
 106
 107   if( lpCacheNode != NULL )
 108   {
 109     TRACE( "Duplicate session entry for %s removed - updated version kept\n",
 110            debugstr_guid( &lpCacheNode->data->guidInstance ) );
 111     cbDeleteNSNodeFromHeap( lpCacheNode );
 112   }
 113
 114   /* Add this to the list */
 115   lpCacheNode = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof( *lpCacheNode ) );
 116
 117   if( lpCacheNode == NULL )
 118   {
 119     ERR( "no memory for NS node\n" );
 120     return;
 121   }
 122
 123   lpCacheNode->lpNSAddrHdr = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY,
 124                                         dwHdrSize );
 125   CopyMemory( lpCacheNode->lpNSAddrHdr, lpcNSAddrHdr, dwHdrSize );
 126
 127   lpCacheNode->data = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof( *(lpCacheNode->data) ) );
 128
 129   if( lpCacheNode->data == NULL )
 130   {
 131     ERR( "no memory for SESSIONDESC2\n" );
 132     HeapFree( GetProcessHeap(), 0, lpCacheNode );
 133     return;
 134   }
 135
 136   *lpCacheNode->data = lpcMsg->sd;
 137   len = WideCharToMultiByte( CP_ACP, 0, (LPCWSTR)(lpcMsg+1), -1, NULL, 0, NULL, NULL );
 138   if ((lpCacheNode->data->u1.lpszSessionNameA = HeapAlloc( GetProcessHeap(), 0, len )))
 139   {
 140       WideCharToMultiByte( CP_ACP, 0, (LPCWSTR)(lpcMsg+1), -1,
 141                            lpCacheNode->data->u1.lpszSessionNameA, len, NULL, NULL );
 142   }
 143
 144   lpCacheNode->dwTime = timeGetTime();
 145
 146   DPQ_INSERT(lpCache->first, lpCacheNode, next );
 147
 148   lpCache->present = lpCacheNode;
 149
 150   /* Use this message as an opportunity to weed out any old sessions so
 151    * that we don't enum them again
 152    */
 153   NS_PruneSessionCache( lpNSInfo );
 154 }
 155
 156 LPVOID NS_GetNSAddr( LPVOID lpNSInfo )
 157 {
 158   lpNSCache lpCache = (lpNSCache)lpNSInfo;
 159
 160   FIXME( ":quick stub\n" );
 161
 162   /* Ok. Cheat and don't search for the correct stuff just take the first.
 163    * FIXME: In the future how are we to know what is _THE_ enum we used?
 164    *        This is going to have to go into dplay somehow. Perhaps it
 165    *        comes back with app server id for the join command! Oh... that
 166    *        must be it. That would make this method obsolete once that's
 167    *        in place.
 168    */
 169 #if 1
 170   return lpCache->first.lpQHFirst->lpNSAddrHdr;
 171 #else
 172   /* FIXME: Should convert over to this */
 173   return lpCache->bNsIsLocal ? lpCache->lpLocalAddrHdr
 174                              : lpCache->lpRemoteAddrHdr;
 175 #endif
 176 }
 177
 178 /* Get the magic number associated with the Name Server */
 179 DWORD NS_GetNsMagic( LPVOID lpNSInfo )
 180 {
 181   LPDWORD lpHdrInfo = NS_GetNSAddr( lpNSInfo );
 182
 183   return lpHdrInfo[1];
 184 }
 185
 186 void NS_SetLocalAddr( LPVOID lpNSInfo, LPCVOID lpHdr, DWORD dwHdrSize )
 187 {
 188   lpNSCache lpCache = (lpNSCache)lpNSInfo;
 189
 190   lpCache->lpLocalAddrHdr = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, dwHdrSize );
 191
 192   CopyMemory( lpCache->lpLocalAddrHdr, lpHdr, dwHdrSize );
 193 }
 194
 195 /* This function is responsible for sending a request for all other known
 196    nameservers to send us what sessions they have registered locally
 197  */
 198 HRESULT NS_SendSessionRequestBroadcast( LPCGUID lpcGuid,
 199                                         DWORD dwFlags,
 200                                         const SPINITDATA *lpSpData )
 201
 202 {
 203   DPSP_ENUMSESSIONSDATA data;
 204   LPDPMSG_ENUMSESSIONSREQUEST lpMsg;
 205
 206   TRACE( "enumerating for guid %s\n", debugstr_guid( lpcGuid ) );
 207
 208   /* Get the SP to deal with sending the EnumSessions request */
 209   FIXME( ": not all data fields are correct\n" );
 210
 211   data.dwMessageSize = lpSpData->dwSPHeaderSize + sizeof( *lpMsg ); /*FIXME!*/
 212   data.lpMessage = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY,
 213                               data.dwMessageSize );
 214   data.lpISP = lpSpData->lpISP;
 215   data.bReturnStatus = (dwFlags & DPENUMSESSIONS_RETURNSTATUS) ? TRUE : FALSE;
 216
 217
 218   lpMsg = (LPDPMSG_ENUMSESSIONSREQUEST)(((BYTE*)data.lpMessage)+lpSpData->dwSPHeaderSize);
 219
 220   /* Setup EnumSession request message */
 221   lpMsg->envelope.dwMagic    = DPMSGMAGIC_DPLAYMSG;
 222   lpMsg->envelope.wCommandId = DPMSGCMD_ENUMSESSIONSREQUEST;
 223   lpMsg->envelope.wVersion   = DPMSGVER_DP6;
 224
 225   lpMsg->dwPasswordSize = 0; /* FIXME: If enumerating passwords..? */
 226   lpMsg->dwFlags        = dwFlags;
 227
 228   lpMsg->guidApplication = *lpcGuid;
 229
 230   return (lpSpData->lpCB->EnumSessions)( &data );
 231 }
 232
 233 /* Delete a name server node which has been allocated on the heap */
 234 static DPQ_DECL_DELETECB( cbDeleteNSNodeFromHeap, lpNSCacheData )
 235 {
 236   /* NOTE: This proc doesn't deal with the walking pointer */
 237
 238   /* FIXME: Memory leak on data (contained ptrs) */
 239   HeapFree( GetProcessHeap(), 0, elem->data );
 240   HeapFree( GetProcessHeap(), 0, elem->lpNSAddrHdr );
 241   HeapFree( GetProcessHeap(), 0, elem );
 242 }
 243
 244 /* Render all data in a session cache invalid */
 245 void NS_InvalidateSessionCache( LPVOID lpNSInfo )
 246 {
 247   lpNSCache lpCache = (lpNSCache)lpNSInfo;
 248
 249   if( lpCache == NULL )
 250   {
 251     ERR( ": invalidate nonexistent cache\n" );
 252     return;
 253   }
 254
 255   DPQ_DELETEQ( lpCache->first, next, lpNSCacheData, cbDeleteNSNodeFromHeap );
 256
 257   /* NULL out the walking pointer */
 258   lpCache->present = NULL;
 259
 260   lpCache->bNsIsLocal = FALSE;
 261
 262 }
 263
 264 /* Create and initialize a session cache */
 265 BOOL NS_InitializeSessionCache( LPVOID* lplpNSInfo )
 266 {
 267   lpNSCache lpCache = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof( *lpCache ) );
 268
 269   *lplpNSInfo = lpCache;
 270
 271   if( lpCache == NULL )
 272   {
 273     return FALSE;
 274   }
 275
 276   DPQ_INIT(lpCache->first);
 277   lpCache->present = NULL;
 278
 279   lpCache->bNsIsLocal = FALSE;
 280
 281   return TRUE;
 282 }
 283
 284 /* Delete a session cache */
 285 void NS_DeleteSessionCache( LPVOID lpNSInfo )
 286 {
 287   NS_InvalidateSessionCache( (lpNSCache)lpNSInfo );
 288 }
 289
 290 /* Reinitialize the present pointer for this cache */
 291 void NS_ResetSessionEnumeration( LPVOID lpNSInfo )
 292 {
 293   ((lpNSCache)lpNSInfo)->present = ((lpNSCache)lpNSInfo)->first.lpQHFirst;
 294 }
 295
 296 LPDPSESSIONDESC2 NS_WalkSessions( LPVOID lpNSInfo )
 297 {
 298   LPDPSESSIONDESC2 lpSessionDesc;
 299   lpNSCache lpCache = (lpNSCache)lpNSInfo;
 300
 301   /* FIXME: The pointers could disappear when walking if a prune happens */
 302
 303   /* Test for end of the list */
 304   if( lpCache->present == NULL )
 305   {
 306     return NULL;
 307   }
 308
 309   lpSessionDesc = lpCache->present->data;
 310
 311   /* Advance tracking pointer */
 312   lpCache->present = lpCache->present->next.lpQNext;
 313
 314   return lpSessionDesc;
 315 }
 316
 317 /* This method should check to see if there are any sessions which are
 318  * older than the criteria. If so, just delete that information.
 319  */
 320 /* FIXME: This needs to be called by some periodic timer */
 321 void NS_PruneSessionCache( LPVOID lpNSInfo )
 322 {
 323   lpNSCache     lpCache = lpNSInfo;
 324
 325   const DWORD dwPresentTime = timeGetTime();
 326   const DWORD dwPrunePeriod = DPMSG_WAIT_60_SECS; /* is 60 secs enough? */
 327
 328   /* This silly little algorithm is based on the fact we keep entries in
 329    * the queue in a time based order. It also assumes that it is not possible
 330    * to wrap around over yourself (which is not unreasonable).
 331    * The if statements verify if the first entry in the queue is less
 332    * than dwPrunePeriod old depending on the "clock" roll over.
 333    */
 334   for( ;; )
 335   {
 336     lpNSCacheData lpFirstData;
 337
 338     if( DPQ_IS_EMPTY(lpCache->first) )
 339     {
 340       /* Nothing to prune */
 341       break;
 342     }
 343
 344     /* Deal with time in a wrap around safe manner - unsigned arithmetic.
 345      * Check the difference in time */
 346     if( (dwPresentTime - (DPQ_FIRST(lpCache->first)->dwTime)) < dwPrunePeriod )
 347     {
 348       /* First entry has not expired yet; don't prune */
 349       break;
 350     }
 351
 352     lpFirstData = DPQ_FIRST(lpCache->first);
 353     DPQ_REMOVE( lpCache->first, DPQ_FIRST(lpCache->first), next );
 354     cbDeleteNSNodeFromHeap( lpFirstData );
 355   }
 356
 357 }
 358
 359 /* NAME SERVER Message stuff */
 360 void NS_ReplyToEnumSessionsRequest( LPCVOID lpcMsg,
 361                                     LPVOID* lplpReplyData,
 362                                     LPDWORD lpdwReplySize,
 363                                     IDirectPlay2Impl* lpDP )
 364 {
 365   LPDPMSG_ENUMSESSIONSREPLY rmsg;
 366   DWORD dwVariableSize;
 367   DWORD dwVariableLen;
 368   /* LPCDPMSG_ENUMSESSIONSREQUEST msg = (LPDPMSG_ENUMSESSIONSREQUEST)lpcMsg; */
 369   BOOL bAnsi = TRUE; /* FIXME: This needs to be in the DPLAY interface */
 370
 371   FIXME( ": few fixed + need to check request for response\n" );
 372
 373   if (bAnsi)
 374   {
 375       dwVariableLen = MultiByteToWideChar( CP_ACP, 0,
 376                                            lpDP->dp2->lpSessionDesc->u1.lpszSessionNameA,
 377                                            -1, NULL, 0 );
 378   }
 379   else
 380   {
 381       dwVariableLen = strlenW( lpDP->dp2->lpSessionDesc->u1.lpszSessionName ) + 1;
 382   }
 383
 384   dwVariableSize = dwVariableLen * sizeof( WCHAR );
 385
 386   *lpdwReplySize = lpDP->dp2->spData.dwSPHeaderSize +
 387                      sizeof( *rmsg ) + dwVariableSize;
 388   *lplpReplyData = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY,
 389                               *lpdwReplySize );
 390
 391   rmsg = (LPDPMSG_ENUMSESSIONSREPLY)( (BYTE*)*lplpReplyData +
 392                                              lpDP->dp2->spData.dwSPHeaderSize);
 393
 394   rmsg->envelope.dwMagic    = DPMSGMAGIC_DPLAYMSG;
 395   rmsg->envelope.wCommandId = DPMSGCMD_ENUMSESSIONSREPLY;
 396   rmsg->envelope.wVersion   = DPMSGVER_DP6;
 397
 398   CopyMemory( &rmsg->sd, lpDP->dp2->lpSessionDesc,
 399               lpDP->dp2->lpSessionDesc->dwSize );
 400   rmsg->dwUnknown = 0x0000005c;
 401   if( bAnsi )
 402   {
 403       MultiByteToWideChar( CP_ACP, 0, lpDP->dp2->lpSessionDesc->u1.lpszSessionNameA, -1,
 404                            (LPWSTR)(rmsg+1), dwVariableLen );
 405   }
 406   else
 407   {
 408       strcpyW( (LPWSTR)(rmsg+1), lpDP->dp2->lpSessionDesc->u1.lpszSessionName );
 409   }
 410 }