ryzom/tools/stats_scan/character_scan_job.cpp

   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/>.
  16
  17
  18 //-------------------------------------------------------------------------------------------------
  19 // includes
  20 //-------------------------------------------------------------------------------------------------
  21
  22 #include "nel/misc/variable.h"
  23 #include "nel/misc/path.h"
  24 #include "nel/misc/common.h"
  25
  26 #include "game_share/persistent_data.h"
  27
  28 #include "character_scan_job.h"
  29 #include "character.h"
  30
  31
  32 //-------------------------------------------------------------------------------------------------
  33 // Variables
  34 //-------------------------------------------------------------------------------------------------
  35
  36 extern NLMISC::CVariable<std::string> OutputDirectory;
  37
  38
  39 //-------------------------------------------------------------------------------------------------
  40 // methods CCharacterScanJob
  41 //-------------------------------------------------------------------------------------------------
  42
  43 CCharacterScanJob::CCharacterScanJob()
  44 {
  45         // start by initialising simple properties
  46         _CharTblFile=NULL;
  47         _NextFile=0;
  48         _State=INIT;
  49
  50         // setup the special reserved table columns 'account' and 'accountSlot'
  51         charTblAddCol("account");
  52         charTblAddCol("accountSlot");
  53
  54         // open the output file for the character table
  55         std::string filename= "char_tbl.csv";
  56         _CharTblFile = NLMISC::nlfopen(filename, "wb");
  57         if (_CharTblFile==NULL)
  58         {
  59                 nlwarning("Failed to open output file: %s",filename.c_str());
  60                 _State=ERROR;
  61         }
  62 }
  63
  64 CCharacterScanJob::~CCharacterScanJob()
  65 {
  66         if (_State!=ERROR)
  67                 _State=CLOSED;
  68
  69         if (_CharTblFile!=NULL)
  70                 fclose(_CharTblFile);
  71
  72         // flush the stats maps to their respective output files
  73         for (TCharStatsMap::iterator it=_CharStatsMap.begin();it!=_CharStatsMap.end();++it)
  74         {
  75                 // create the output file name and open the file for writing
  76                 std::string filename="char_stats_"+(*it).first+".csv";
  77                 FILE* f = NLMISC::nlfopen(filename, "wb");
  78                 if (f==NULL)
  79                 {
  80                         nlwarning("Failed to open output file: %s",filename.c_str());
  81                         continue;
  82                 }
  83
  84                 // dump data to the file
  85                 for (TCharStatsMapTbl::iterator it2=it->second.begin();it2!=it->second.end();++it2)
  86                 {
  87                         fprintf(f,"%s,%d,\n",it2->first.c_str(),it2->second);
  88                 }
  89
  90                 // the writing is finished so close the file
  91                 fclose(f);
  92         }
  93 }
  94
  95 void CCharacterScanJob::update()
  96 {
  97         if (_NextFile>=_Files.size())
  98                 return;
  99
 100         // load the file into a pdr record
 101         static CPersistentDataRecord pdr;
 102         pdr.clear();
 103         pdr.readFromFile(_Files[_NextFile]);
 104         ++_NextFile;
 105
 106         // create a character representation and apply the pdr
 107         CStatsScanCharacter c;
 108         c.apply(pdr);
 109
 110         // iterate over the info extractors executing their core code
 111         for (uint32 i=0;i<_InfoExtractors.size();++i)
 112         {
 113                 _InfoExtractors[i]->execute(this,&c);
 114         }
 115
 116         // flush the info collected by the info extractors to the output file
 117         charTblFlushRow(123,456);
 118 }
 119
 120 bool CCharacterScanJob::charTblAddCol(const std::string& name)
 121 {
 122         nlassert(_State==INIT);
 123
 124         // make sure the col doesn't already exist in the table
 125         for (uint32 i=0;i<_TblCols.size();++i)
 126         {
 127                 nlassert(_TblCols[i]!=name);
 128         }
 129
 130         // add the colt ot he table
 131         _TblCols.push_back(name);
 132
 133         return true;
 134 }
 135
 136 bool CCharacterScanJob::addInfoExtractor(ICharInfoExtractor* infoExtractor)
 137 {
 138         // make sure this info extractor doesn't already exist
 139         for (uint32 i=0;i<_InfoExtractors.size();++i)
 140         {
 141                 if(_InfoExtractors[i]->toString()== infoExtractor->toString())
 142                 {
 143                         nlwarning("Attempt to add info extractor to the same job more than once: %s",infoExtractor->toString().c_str());
 144                         return false;
 145                 }
 146         }
 147
 148         // append the new info extractor to the buffer
 149         _InfoExtractors.push_back(infoExtractor);
 150
 151         return true;
 152 }
 153
 154 bool CCharacterScanJob::addFilter(ICharFilter* filter)
 155 {
 156         // make sure this info extractor doesn't already exist
 157         for (uint32 i=0;i<_Filters.size();++i)
 158         {
 159                 if(_Filters[i]->toString()== filter->toString())
 160                 {
 161                         nlwarning("Attempt to add filter to the same job more than once: %s",filter->toString().c_str());
 162                         return false;
 163                 }
 164         }
 165
 166         // append the new info extractor to the buffer
 167         _Filters.push_back(filter);
 168
 169         return true;
 170 }
 171
 172 bool CCharacterScanJob::addFiles(const CFileDescriptionContainer& fdc)
 173 {
 174         for (uint32 i=0;i<fdc.size();++i)
 175         {
 176                 // generate a normalised a full file name with expanded path
 177                 std::string fullFileName= NLMISC::CPath::getFullPath(NLMISC::CFile::getPath(fdc[i].FileName))+NLMISC::CFile::getFilename(fdc[i].FileName);
 178
 179                 // make sure the full file name doesn't already exist in the _Files vector
 180                 uint32 j;
 181                 for (j=0;j<_Files.size();++j)
 182                 {
 183                         if (fullFileName==_Files[j])
 184                                 break;
 185                 }
 186                 if (j<_Files.size())
 187                         continue;
 188
 189                 // add the full file name to the _Files vector
 190                 _Files.push_back(fullFileName);
 191         }
 192         return true;
 193 }
 194
 195 bool CCharacterScanJob::setOutputPath(const std::string& path)
 196 {
 197         nlinfo("Setting output path to: %s",path.c_str());
 198         _OutputPath= NLMISC::CPath::getFullPath(OutputDirectory)+path;
 199         bool result= NLMISC::CFile::createDirectoryTree(_OutputPath);
 200         if (result==false)
 201         {
 202                 nlwarning("Failed to create directory tree: %s",path.c_str());
 203                 return false;
 204         }
 205         return true;
 206 }
 207
 208 void CCharacterScanJob::charTblFlushRow(uint32 account,uint32 slot)
 209 {
 210         // setup the stuff for the ne
 211         charTblSetEntry("account",NLMISC::toString(account));
 212         charTblSetEntry("accountSlot",NLMISC::toString(slot));
 213
 214         nlassert(_State==WORK);
 215
 216         // build the row text from the _CurrentRowEntries entries and erase the entries as we go
 217         std::string rowTxt;
 218         for (uint32 i=0;i<_TblCols.size();++i)
 219         {
 220                 if (!rowTxt.empty())
 221                         rowTxt+=',';
 222                 rowTxt+=_CurrentRowEntries[_TblCols[i]];
 223                 _CurrentRowEntries.erase(_TblCols[i]);
 224         }
 225
 226         // get rid of any excess entries (spew warnings to compain about the problem)
 227         while (!_CurrentRowEntries.empty())
 228         {
 229                 nlwarning("Character Tbl entry found for unknown column: %s: %s",(*_CurrentRowEntries.begin()).first.c_str(),(*_CurrentRowEntries.begin()).second.c_str());
 230                 _CurrentRowEntries.erase(_CurrentRowEntries.begin());
 231         }
 232
 233         // add the row text to the output file
 234         fprintf(_CharTblFile,"%s\n",rowTxt.c_str());
 235         fflush(_CharTblFile);
 236 }
 237
 238 void CCharacterScanJob::charTblSetEntry(const std::string& colName,const std::string& value)
 239 {
 240         nlassert(_State==WORK);
 241
 242         // ensure we don't already have a value for this col
 243         nlassert(_CurrentRowEntries.find(colName)==_CurrentRowEntries.end());
 244
 245         // det the value for the col
 246         _CurrentRowEntries[colName]= value;
 247 }
 248
 249 void CCharacterScanJob::freqTblAddEntry(const std::string& tblName, const std::string& key)
 250 {
 251         nlassert(_State==WORK);
 252
 253         // if the key doesn't exist in the given freq tbl then init the value to 1 else increment
 254         if(_CharStatsMap[tblName].find(key)==_CharStatsMap[tblName].end())
 255                 _CharStatsMap[tblName][key]=1;
 256         else
 257                 ++_CharStatsMap[tblName][key];
 258 }
 259
 260 bool CCharacterScanJob::finished()
 261 {
 262         return _NextFile>= _Files.size();
 263 }
 264
 265 std::string CCharacterScanJob::getShortStatus()
 266 {
 267         return NLMISC::toString("CharacterFiles %d/%d",_NextFile,_Files.size());
 268 }
 269
 270 std::string CCharacterScanJob::getStatus()
 271 {
 272         return getShortStatus();
 273 }
 274
 275 void CCharacterScanJob::display(NLMISC::CLog* log)
 276 {
 277         log->displayNL("%s",getStatus().c_str());
 278         for (uint32 i=0;i<_InfoExtractors.size();++i)
 279         {
 280                 log->displayNL("- %s",_InfoExtractors[i]->toString().c_str());
 281         }
 282 }
 283
 284