| blob | bdd2e2c3792651027f623c34560967b62e510e26 |
1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
2 // Copyright (C) 2010 Winch Gate Property Limited
3 //
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU Affero General Public License as
6 // published by the Free Software Foundation, either version 3 of the
7 // License, or (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU Affero General Public License for more details.
13 //
14 // You should have received a copy of the GNU Affero General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
19 //#include "pd_string_manager.h"
20 //#include "pd_lib.h"
21 //
22 //#include <string.h>
23 //
24 //#include <nel/misc/file.h>
25 //#include <nel/misc/command.h>
26 //#include <nel/net/unified_network.h>
27 //#include <nel/net/service.h>
28 //
29 //#include "pd_lib.h"
30 //#include "timestamp.h"
31 //
32 //using namespace std;
33 //using namespace NLMISC;
34 //using namespace NLNET;
35 //
36 //
37 //namespace RY_PDS
38 //{
39 //
40 ////
41 ////
42 //
43 ////void cbStoreStringResult(CMessage& msgin, const string &serviceName, uint16 serviceId);
44 //
45 ////TUnifiedCallbackItem PDStringManagerCbArray[] =
46 ////{
47 //// { "STORE_STRING_RESULT", cbStoreStringResult },
48 ////};
49 //
50 ////void cbStoreStringResult(CMessage& msgin, const string &serviceName, uint16 serviceId)
51 ////{
52 //// if (CPDStringManager::_NbProcessingStoreStringRequests)
53 //// {
54 //// CPDStringManager::_NbProcessingStoreStringRequests--;
55 //// }
56 //// else
57 //// nlwarning("<cbStoreStringResult> received more STORE_STRING_RESULT messages than sent STORE_STRING requests");
58 ////
59 //// ucstring str;
60 //// uint32 stringId;
61 ////
62 //// msgin.serial(str);
63 //// msgin.serial(stringId);
64 ////
65 //// uint i;
66 //// for (i=0; i<CPDSLib::_Libs.size(); ++i)
67 //// {
68 //// CPDSLib* lib = CPDSLib::_Libs[i];
69 //// if (lib != NULL)
70 //// lib->getStringManager().setStringId(str, stringId);
71 //// }
72 ////}
73 //
74 //
75 //// Is net callback ready?
76 //bool CPDStringManager::_InitCb = false;
77 //
78 ///// Null String
79 //ucstring CPDStringManager::_NullStr;
80 //
81 ///// Number of store string requests that have not been processed by IOS yet
82 //uint CPDStringManager::_NbProcessingStoreStringRequests = 0;
83 //
84 //
85 ///*
86 // * Constructor
87 // */
88 //CPDStringManager::CPDStringManager()
89 //{
90 // _PDSLib = NULL;
91 // _Callback = NULL;
92 //}
93 //
94 //
95 ///*
96 // * Destructor
97 // */
98 //CPDStringManager::~CPDStringManager()
99 //{
100 //}
101 //
102 //
103 ///*
104 // * Init
105 // */
106 //void CPDStringManager::init(CPDSLib* lib)
107 //{
108 // //
109 // if (!_InitCb)
110 // {
111 // _InitCb = true;
112 // CUnifiedNetwork::getInstance()->addCallbackArray(PDStringManagerCbArray, sizeof(PDStringManagerCbArray)/sizeof(PDStringManagerCbArray[0]));
113 // }
114 //
115 // //
116 // _PDSLib = lib;
117 //}
118 //
119 //
120 ///*
121 // * Get string entry (allocate a new entry if not yet in container)
122 // */
123 //CPDStringManager::TEntryId CPDStringManager::getEntryIdNonConst(const ucstring& str)
124 //{
125 // THash hash = getHash(str);
126 // TEntryId entryId = InvalidEntryId;
127 //
128 // if (_HashTable.size() > hash)
129 // entryId = _HashTable[hash];
130 //
131 // while (entryId != InvalidEntryId)
132 // {
133 // const CStringEntry& entry = _StringEntries[entryId];
134 //
135 // if (entry.String == str)
136 // {
137 // // DONE BY NICO : this forces the lib to update the string id value of the entry. Thus, EGS callbacks are called.
138 // // The real problem is that entries are never removed from _StringEntries. So when we add a string that should have been previously removed, setStringId is never called... )
139 // setStringId(str, entry.StringId);
140 // return entryId;
141 // }
142 //
143 // entryId = entry.NextInHash;
144 // }
145 //
146 // // allocate new entry
147 // entryId = _StringEntries.size();
148 // _StringEntries.resize(entryId+1);
149 //
150 // // check hash table size
151 // if (_HashTable.size() <= hash)
152 // _HashTable.resize(PD_STRING_HASHTABLE_SIZE, InvalidEntryId);
153 //
154 // // fill new entry
155 // CStringEntry& entry = _StringEntries[entryId];
156 //
157 // entry.String = str;
158 // entry.Hash = hash;
159 // entry.NextInHash = _HashTable[hash];
160 //
161 // // link entry in hash table
162 // _HashTable[hash] = entryId;
163 //
164 // if (_PDSLib != NULL)
165 // {
166 // storeStringInIOS(str);
167 // }
168 //
169 // return entryId;
170 //}
171 //
172 //
173 ///*
174 // * Compares 2 ucchar strings
175 // */
176 //bool CPDStringManager::compare(const ucchar* a, const ucchar* b)
177 //{
178 // while (*a == *b && *a != 0)
179 // {
180 // ++a;
181 // ++b;
182 // }
183 // return *a == *b;
184 //}
185 //
186 //
187 //
188 //
189 ///*
190 // * Explicitly add string to manager
191 // * \param eid is the associated entity id
192 // * \param string is the string to add
193 // * \return the persistant string id
194 // */
195 //void CPDStringManager::addString(NLMISC::CEntityId eid, const ucstring& str, bool addToLog)
196 //{
197 // TEntryId entry = getEntryIdNonConst(str);
198 //
199 // if (_PDSLib != NULL)
200 // {
201 // // client mode, send mapping to PDS
202 // _PDSLib->addString(eid, str);
203 // }
204 //
205 // if ((_PDSLib == NULL && addToLog) || (_PDSLib != NULL && !_PDSLib->PDSUsed() && PDEnableStringLog))
206 // {
207 // // PDS mode, log mapping
208 // _Log.Actions.push_back(CLogAction());
209 // _Log.Actions.back().MapId = true;
210 // _Log.Actions.back().EntityId = eid;
211 // _Log.Actions.back().String = str;
212 // }
213 //
214 // mapEid(eid, entry);
215 //}
216 //
217 ///*
218 // * Unmap EntityId
219 // */
220 //void CPDStringManager::unmap(NLMISC::CEntityId eid, bool addToLog)
221 //{
222 // TEIdMap::iterator it = _EIdMap.find(eid);
223 // if (it == _EIdMap.end())
224 // return;
225 //
226 // if (_PDSLib != NULL)
227 // {
228 // // client mode, send unmapping to PDS
229 // _PDSLib->unmapString(eid);
230 // }
231 //
232 // if ((_PDSLib == NULL && addToLog) || (_PDSLib != NULL && !_PDSLib->PDSUsed() && PDEnableStringLog))
233 // {
234 // // PDS mode, log unmapping
235 // _Log.Actions.push_back(CLogAction());
236 // _Log.Actions.back().MapId = false;
237 // _Log.Actions.back().EntityId = eid;
238 // }
239 //
240 // CStringEntry& entry = _StringEntries[(*it).second];
241 //
242 // _EIdMap.erase(it);
243 //
244 // // remove from mapped eids
245 // std::vector<NLMISC::CEntityId>::iterator ite;
246 // for (ite=entry.MappedIds.begin(); ite!=entry.MappedIds.end(); )
247 // {
248 // if (*ite == eid)
249 // ite = entry.MappedIds.erase(ite);
250 // else
251 // ++ite;
252 // }
253 //}
254 //
255 //
256 ///*
257 // * Set string callback
258 // * This callback is called when the string id is received from the IOS.
259 // * That is when string id is ready to be used
260 // */
261 //void CPDStringManager::setCallback(TStringCallback callback)
262 //{
263 // _Callback = callback;
264 //}
265 //
266 //
267 //
268 //
269 ///*
270 // * Display Manager content
271 // */
272 //void CPDStringManager::display(NLMISC::CLog* log) const
273 //{
274 //}
275 //
276 //
277 //
278 ///*
279 // * Serial String Manager
280 // */
281 //void CPDStringManager::serial(NLMISC::IStream& f)
282 //{
283 // H_AUTO( PDSSM_SERIAL );
284 // f.serialCheck((uint32)'PDSM');
285 // uint version = f.serialVersion(0);
286 //
287 // {
288 // H_AUTO( PDSSM_SERIAL_ENTRIES );
289 // f.serialCont(_StringEntries);
290 // }
291 // {
292 // H_AUTO( PDSSM_SERIAL_EIDMAP );
293 // f.serialCont(_EIdMap);
294 // }
295 //
296 // if (f.isReading())
297 // {
298 // H_AUTO( PDSSM_SERIAL_BUILDVOLATILEDATA );
299 // buildVolatileData();
300 // }
301 //}
302 //
303 //
304 ///*
305 // * Set String (PDS side)
306 // */
307 ///*
308 //bool CPDStringManager::setString(const NLMISC::CEntityId& eid, TEntryId id, const ucstring& str)
309 //{
310 // bool success = true;
311 //
312 // if (id >= _StringEntries.size())
313 // {
314 // // alloc string entry
315 // _StringEntries.resize(id+1);
316 //
317 // // fill up entry
318 // CStringEntry& entry = _StringEntries[id];
319 //
320 // entry.Hash = getHash(str);
321 // entry.String = str;
322 //
323 // // link in hash table
324 // if (_HashTable.size() <= entry.Hash)
325 // _HashTable.resize(PD_STRING_HASHTABLE_SIZE, InvalidEntryId);
326 //
327 // entry.NextInHash = _HashTable[entry.Hash];
328 // }
329 // else if (_StringEntries[id].String != str)
330 // {
331 // // entry was alread filled !
332 // nlwarning("CPDStringManager::setString(): entry '%d' already set, entry is kept unchanged", id);
333 // success = false;
334 // }
335 //
336 // _EIdMap[eid] = id;
337 //
338 // return success;
339 //}
340 //*/
341 //
342 //
343 //
344 ///*
345 // * Set string Id
346 // */
347 //void CPDStringManager::setStringId(const ucstring& str, TStringId id)
348 //{
349 // THash hash = getHash(str);
350 // TEntryId entryId = InvalidEntryId;
351 //
352 // if (_HashTable.size() >= hash)
353 // {
354 // entryId = _HashTable[hash];
355 //
356 // while (entryId != InvalidEntryId)
357 // {
358 // CStringEntry& entry = _StringEntries[entryId];
359 //
360 // if (entry.String == str)
361 // {
362 // entry.StringId = id;
363 // _StringIdMap[id] = entryId;
364 // break;
365 // }
366 // entryId = entry.NextInHash;
367 // }
368 // }
369 //
370 // // callback
371 // if (_Callback != NULL)
372 // _Callback(str, id);
373 //}
374 //
375 //
376 //
377 ///*
378 // * Build All String Associations
379 // */
380 //void CPDStringManager::buildStringAssociation()
381 //{
382 // uint i;
383 // for (i=0; i<CPDSLib::_Libs.size(); ++i)
384 // {
385 // CPDSLib* lib = CPDSLib::_Libs[i];
386 // if (lib != NULL)
387 // lib->getStringManager().askAssociations();
388 // }
389 //}
390 //
391 //
392 ///*
393 // * Ask Associations
394 // */
395 //void CPDStringManager::askAssociations()
396 //{
397 // uint i;
398 // for (i=0; i<_StringEntries.size(); ++i)
399 // {
400 // storeStringInIOS(_StringEntries[i].String);
401 // }
402 //}
403 //
404 //
405 //
406 //
407 ///*
408 // * Rebuild volatile data
409 // */
410 //void CPDStringManager::buildVolatileData()
411 //{
412 // static bool alreadyBuilt = false;
413 //
414 ////#ifdef NL_DEBUG
415 //// if(alreadyBuilt)
416 //// nlstopex(("buildVolatileData() called 2 times, BEN, please fix me!!!"));
417 ////#else
418 // if(alreadyBuilt)
419 // nlwarning("buildVolatileData() called 2 times, BEN, please fix me!!!");
420 ////#endif
421 //
422 // _HashTable.clear();
423 //
424 // uint i;
425 // for (i=0; i<_StringEntries.size(); ++i)
426 // {
427 // CStringEntry& entry = _StringEntries[i];
428 //
429 // entry.Hash = getHash(entry.String);
430 //
431 // if (_HashTable.size() <= entry.Hash)
432 // _HashTable.resize(PD_STRING_HASHTABLE_SIZE, InvalidEntryId);
433 //
434 // entry.NextInHash = _HashTable[entry.Hash];
435 // _HashTable[entry.Hash] = i;
436 //
437 // entry.MappedIds.clear();
438 // }
439 //
440 // TEIdMap::const_iterator it;
441 // for (it=_EIdMap.begin(); it!=_EIdMap.end(); ++it)
442 // {
443 // CStringEntry& entry = _StringEntries[(*it).second];
444 // entry.MappedIds.push_back((*it).first);
445 // }
446 //
447 // alreadyBuilt = true;
448 //}
449 //
450 //
451 ///*
452 // * Load String manager default file (to be used by client when PDS is not connected)
453 // */
454 //bool CPDStringManager::load()
455 //{
456 // if (_PDSLib == NULL)
457 // return false;
458 //
459 // std::string logDir = _PDSLib->getLogDirectory();
460 //
461 // if (!CFile::isDirectory(logDir))
462 // {
463 // if (!CFile::createDirectoryTree(logDir))
464 // {
465 // nlwarning("Failed to create log root directory '%s'", logDir.c_str());
466 // }
467 //
468 // if (!CFile::setRWAccess(logDir))
469 // {
470 // nlwarning("Failed, can't set RW access to directory '%s'", logDir.c_str());
471 // }
472 // }
473 //
474 // return load(logDir);
475 //}
476 //
477 ///*
478 // * Save String manager default file (to be used by client when PDS is not connected)
479 // */
480 //bool CPDStringManager::save()
481 //{
482 // if (_PDSLib == NULL)
483 // return false;
484 //
485 // std::string logDir = _PDSLib->getLogDirectory();
486 //
487 // if (!CFile::isDirectory(logDir))
488 // {
489 // if (!CFile::createDirectoryTree(logDir))
490 // {
491 // nlwarning("Failed to create log root directory '%s'", logDir.c_str());
492 // }
493 //
494 // if (!CFile::setRWAccess(logDir))
495 // {
496 // nlwarning("Failed, can't set RW access to directory '%s'", logDir.c_str());
497 // }
498 // }
499 //
500 // return save(logDir);
501 //}
502 //
503 ///*
504 // * Load String manager file
505 // */
506 //bool CPDStringManager::load(const std::string& path)
507 //{
508 // std::string filename = getFile(path);
509 //
510 // if (!CFile::fileExists(filename))
511 // {
512 // nlinfo("CPDStringManager::load(): file '%s' doesn't exist, assumes string manager empty", filename.c_str());
513 // return true;
514 // }
515 //
516 // CIFile file;
517 // if (!file.open(filename))
518 // {
519 // nlwarning("CPDStringManager::load(): failed to load file '%s', string manager left as is", filename.c_str());
520 // return false;
521 // }
522 //
523 // try
524 // {
525 // serial(file);
526 // }
527 // catch (Exception& e)
528 // {
529 // nlwarning("CPDStringManager::load(): failed to load file '%s', exception in serial '%s'", filename.c_str(), e.what());
530 // return false;
531 // }
532 //
533 // return true;
534 //}
535 //
536 ///*
537 // * Save String manager file
538 // */
539 //bool CPDStringManager::save(const std::string& path)
540 //{
541 // std::string filename = getFile(path);
542 //
543 // COFile file;
544 // if (!file.open(filename))
545 // {
546 // nlwarning("CPDStringManager::save(): failed to save file '%s', string manager left as is", filename.c_str());
547 // return false;
548 // }
549 //
550 // try
551 // {
552 // serial(file);
553 // }
554 // catch (Exception& e)
555 // {
556 // nlwarning("CPDStringManager::save(): failed to save file '%s', exception in serial '%s'", filename.c_str(), e.what());
557 // return false;
558 // }
559 //
560 // return true;
561 //}
562 //
563 ///*
564 // * Get String manager filename
565 // */
566 //std::string CPDStringManager::getFile(const std::string& path)
567 //{
568 // return CPath::standardizePath(path) + "string_manager.bin";
569 //}
570 //
571 //
572 ///*
573 // * Apply log
574 // */
575 //bool CPDStringManager::applyLog(NLMISC::IStream& s)
576 //{
577 // try
578 // {
579 // s.serial(_Log);
580 // }
581 // catch (Exception &e)
582 // {
583 // nlwarning("CPDStringManager::applyLog(): failed to apply log from stream, exception in serial '%s'", e.what());
584 // return false;
585 // }
586 //
587 // uint i;
588 // for (i=0; i<_Log.Actions.size(); ++i)
589 // {
590 // CLogAction& action = _Log.Actions[i];
591 //
592 // if (action.MapId)
593 // {
594 // addString(action.EntityId, action.String, false);
595 // }
596 // else
597 // {
598 // unmap(action.EntityId, false);
599 // }
600 // }
601 //
602 // _Log.Actions.clear();
603 //
604 // return true;
605 //}
606 //
607 ///*
608 // * Store log
609 // */
610 //bool CPDStringManager::storeLog(NLMISC::IStream& s)
611 //{
612 // try
613 // {
614 // s.serial(_Log);
615 // }
616 // catch (Exception &e)
617 // {
618 // nlwarning("CPDStringManager::storeLog(): failed to store log to stream, exception in serial '%s'", e.what());
619 // return false;
620 // }
621 //
622 // _Log.Actions.clear();
623 //
624 // return true;
625 //}
626 //
627 ///*
628 // * Is log file
629 // */
630 //bool CPDStringManager::isLogFileName(const std::string& filename, CTimestamp& timestamp)
631 //{
632 // char buffer[32];
633 // if (NLMISC::CFile::getExtension(filename) != "xml" ||
634 // sscanf(NLMISC::CFile::getFilenameWithoutExtension(filename).c_str(), "string_%s", &buffer) != 1)
635 // return false;
636 // timestamp.fromString(buffer);
637 // return true;
638 //}
639 //
640 ///*
641 // * Store string in IOS
642 // */
643 //void CPDStringManager::storeStringInIOS(const ucstring& str)
644 //{
645 // CMessage msgios("STORE_STRING");
646 // msgios.serial( const_cast<ucstring&>(str) );
647 // CUnifiedNetwork::getInstance()->send("IOS", msgios);
648 //
649 // _NbProcessingStoreStringRequests++;
650 //}
651 //
652 ///*
653 // * Returns true if IOS has not processed all store string requests
654 // */
655 //bool CPDStringManager::isWaitingIOSStoreStringResult()
656 //{
657 // return (_NbProcessingStoreStringRequests != 0);
658 //}
659 //
660 //}
661 //