dlls/dplayx/name_server.c

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