ryzom/tools/stats_scan/char_commands.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  * todo:
  19  *      - charScanScript commands
  20  *              * path for script files in cfg
  21  *              - charScanScriptNew <description>
  22  *              - charScanScriptLoad <file_name>
  23  *              - charScanScriptSave <file_name>
  24  *              - charScanScriptListFiles
  25  *              - charScanScriptListLines
  26  *              - charScanScriptDeleteLine <line_number>
  27  *              - charScanScriptAddInputFiles <directory> <wildcards>
  28  *              - charScanScriptAddInfoExtractor <infoExtractorName> [<args>]
  29  *              - charScanScriptAddFilter <filterName> [<args>]
  30  *              - charScanScriptAddPreInclude <include_file_name>
  31  *              - charScanScriptAddPostInclude <include_file_name>
  32  *              - charScanScriptSetOutputDirectory <directoryName>
  33  *              - charScanScriptSetDescription <description>
  34  *              - charScanScriptRun [-s <file_name>] [-o <output_directory>]
  35  *              - addJobCharScanScript [-s <file_name>] [-o <output_directory>]
  36  *              - charScanScriptListOutputFiles [<output_directory>]
  37  *              - charScanScriptListOutputFileContents <file_name> [<output_directory>]
  38  *              - charScanScriptTestFileList
  39  *              - charScanScriptTestOutput <test_input_file_path>
  40  *              - charScanScriptHelp
  41  * - path for generated files (from cfg + override) => managed incrementally with directory numbering
  42  * - add incremental update systems
  43  *              - add tables with a column per day ()
  44  *              - add tables with a column per week (limited number of weeks)
  45  *              - add tables with a column per month (limited number of months)
  46  */
  47
  48 /*
  49 bool CCharFilterFactory::beginScanJob(const std::vector<std::string>& files, const std::vector<std::string>& filters)
  50 {
  51         bool noErrors= true;
  52
  53         // create a new job
  54         NLMISC::CSmartPtr<CCharacterScanJob> job=new CCharacterScanJob;
  55
  56         // look after the filters
  57         for (uint32 i=0;i<filters.size();++i)
  58         {
  59                 // locate the info extractor corresponding to the given name
  60                 uint32 j=0;
  61                 for (j=0;j<_Filters.size();++j)
  62                         if (filters[i]==_Filters[j]->getName())
  63                                 break;
  64
  65                 // if none found then warn and skip passed
  66                 if(j>=_Filters.size())
  67                 {
  68                         nlwarning("Unknown info extractor: %s",filters[i].c_str());
  69                         noErrors=false;
  70                         continue;
  71                 }
  72
  73                 // add the info extractor to the new job
  74                 job->addFilter(_Filters[j]);
  75         }
  76
  77         // look after the files
  78         job->addFiles(files);
  79
  80         // add the job to the job manager
  81         if (noErrors==true)
  82                 CJobManager::getInstance()->addJob(&*job);
  83
  84         return noErrors;
  85 }
  86
  87 */
  88 //-----------------------------------------------------------------------------
  89 // includes
  90 //-----------------------------------------------------------------------------
  91
  92 #include "nel/misc/path.h"
  93 #include "nel/misc/command.h"
  94 #include "nel/misc/variable.h"
  95 #include "nel/misc/algo.h"
  96 #include "game_share/persistent_data.h"
  97
  98 #include "character.h"
  99 #include "job_manager.h"
 100 #include "char_info_extractor_factory.h"
 101
 102
 103 //-----------------------------------------------------------------------------
 104 // Namespaces
 105 //-----------------------------------------------------------------------------
 106
 107 using namespace std;
 108 using namespace NLMISC;
 109
 110 //-----------------------------------------------------------------------------
 111 // Variables
 112 //-----------------------------------------------------------------------------
 113
 114 CVariable<string>       SourceDirectory("variables", "SourceDirectory", "Directory we scan for files", string("."), 0, true);
 115
 116
 117 //-----------------------------------------------------------------------------
 118 // Commands - misc character related
 119 //-----------------------------------------------------------------------------
 120
 121 NLMISC_COMMAND(listCharNames,"display the names of the characters int he listed save files","<input file name>")
 122 {
 123         if (args.size()!=1 && args.size()!=0)
 124                 return false;
 125
 126         std::string wildcard="pdr_account*";
 127         if (args.size()==1)
 128                 wildcard=args[0];
 129
 130         std::vector<std::string> files;
 131         NLMISC::CPath::getPathContent(SourceDirectory.get().c_str(),false,false,true,files);
 132         for (uint32 i=(uint32)files.size();i--;)
 133         {
 134                 if (!NLMISC::testWildCard(NLMISC::CFile::getFilename(files[i]),wildcard))
 135                 {
 136                         files[i]=files.back();
 137                         files.pop_back();
 138                 }
 139         }
 140         std::sort(files.begin(),files.end());
 141         for (uint32 i=0;i<files.size();++i)
 142         {
 143                 static CPersistentDataRecord pdr;
 144                 pdr.clear();
 145                 pdr.readFromFile(files[i]);
 146
 147                 CStatsScanCharacter c;
 148                 c.apply(pdr);
 149
 150                 log.displayNL("%-40s Name: %s ", files[i].c_str(), c.EntityBase._Name.c_str());
 151         }
 152
 153         return true;
 154 }
 155
 156 //-----------------------------------------------------------------------------
 157 // Commands - charScanner
 158 //-----------------------------------------------------------------------------
 159
 160 NLMISC_COMMAND(listCharInfoExtractors,"display the list of info extractors that exist for characters","")
 161 {
 162         if (args.size()!=0)
 163                 return false;
 164
 165         CCharInfoExtractorFactory::getInstance()->displayInfoExtractorList(&log);
 166
 167         return true;
 168 }
 169
 170 //-----------------------------------------------------------------------------
 171 // Commands - jobsManager
 172 //-----------------------------------------------------------------------------
 173
 174 NLMISC_COMMAND(jobsPause,"pause execution of jobs","")
 175 {
 176         if (args.size()!=0)
 177                 return false;
 178
 179         CJobManager::getInstance()->pause();
 180
 181         return true;
 182 }
 183
 184 NLMISC_COMMAND(jobsResume,"resume execution of jobs","")
 185 {
 186         if (args.size()!=0)
 187                 return false;
 188
 189         CJobManager::getInstance()->resume();
 190
 191         return true;
 192 }
 193
 194 NLMISC_COMMAND(jobsPromote,"pause execution of jobs","<jobId>")
 195 {
 196         if (args.size()!=1)
 197                 return false;
 198
 199         uint32 idx;
 200         NLMISC::fromString(args[0], idx);
 201
 202         if ( (idx==0 && args[0]!="0") )
 203         {
 204                 nlwarning("Argument is not a valid job id - should be a number");
 205                 return false;
 206         }
 207
 208         CJobManager::getInstance()->promoteJob(idx);
 209         CJobManager::getInstance()->listJobs(&log);
 210
 211         return true;
 212 }
 213
 214 NLMISC_COMMAND(JobUpdatesPerUpdate,"set or display the number of job updates per service update","[<count>]")
 215 {
 216         if (args.size()>1)
 217                 return false;
 218
 219         if (args.size()==1)
 220         {
 221                 uint32 count;
 222                 NLMISC::fromString(args[0], count);
 223
 224                 if ( (count==0 && args[0]!="0") )
 225                 {
 226                         nlwarning("Argument is not a valid number");
 227                         return false;
 228                 }
 229                 CJobManager::getInstance()->setJobUpdatesPerUpdate(count);
 230         }
 231
 232         nlinfo("JobUpdatesPerUpdate %d",CJobManager::getInstance()->getJobUpdatesPerUpdate());
 233
 234         return true;
 235 }
 236
 237 NLMISC_COMMAND(jobsStatus,"display the status of the job manager","")
 238 {
 239         if (args.size()!=0)
 240                 return false;
 241
 242         log.displayNL("%s",CJobManager::getInstance()->getStatus().c_str());
 243
 244         return true;
 245 }
 246
 247 NLMISC_COMMAND(jobsList,"display the list of unfinished jobs","")
 248 {
 249         if (args.size()!=0)
 250                 return false;
 251
 252         CJobManager::getInstance()->listJobs(&log);
 253
 254         return true;
 255 }
 256
 257 NLMISC_COMMAND(jobsListAll,"display the list of all jobs (unfinished jobs are marked with a '*')","")
 258 {
 259         if (args.size()!=0)
 260                 return false;
 261
 262         CJobManager::getInstance()->listJobHistory(&log);
 263
 264         return true;
 265 }
 266
 267 NLMISC_COMMAND(jobsDisplayDetails,"display detailed info for the current job (or a given job)","[<job id>]")
 268 {
 269         switch (args.size())
 270         {
 271         case 0:
 272                 CJobManager::getInstance()->displayCurrentJob(&log);
 273                 break;
 274
 275         case 1:
 276                 {
 277                         uint32 idx;
 278                         NLMISC::fromString(args[0], idx);
 279
 280                         if ( (idx==0 && args[0]!="0") )
 281                         {
 282                                 nlwarning("Argument is not a valid job id - should be a number");
 283                                 return false;
 284                         }
 285                         CJobManager::getInstance()->displayJob(idx,&log);
 286                 }
 287                 break;
 288
 289
 290         default:
 291                 return false;
 292         }
 293
 294         return true;
 295 }
 296
 297 //-----------------------------------------------------------------------------
 298 // Commands - charScanScript
 299 //-----------------------------------------------------------------------------
 300
 301
 302 //-----------------------------------------------------------------------------