ryzom/server/src/server_share/log_command_gen.cpp

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2019  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program 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
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #include "stdpch.h"
  21 #include "game_share/utils.h"
  22 #include "log_command_gen.h"
  23
  24
  25 #include "logger_service_itf.h"
  26 #include "logger_service_client.h"
  27
  28 // A function fo force linking of this code module
  29 void forceLink_Command(){}
  30
  31
  32
  33
  34 class CCommandDesc
  35 {
  36         friend class CLoggerClient;
  37
  38         /// The list of log definition for this log class
  39         std::vector<LGS::TLogDefinition>        _LogDefs;
  40
  41         /// Stack of context variable
  42
  43         std::vector<NLMISC::CEntityId>  _charId;
  44
  45
  46         /// Counter of 'no context' object stacked.
  47         uint32  _NoContextCount;
  48
  49 public:
  50         /// constructor
  51         CCommandDesc()
  52                 :       _NoContextCount(0)
  53         {
  54                 _LogDefs.resize(4);
  55
  56                 {
  57                         LGS::TLogDefinition  &logDef = _LogDefs[0];
  58
  59                         logDef.setLogName("Command_ExecCtx");
  60
  61                         logDef.setContext(true);
  62
  63
  64                 }
  65
  66                 {
  67                         LGS::TLogDefinition  &logDef = _LogDefs[1];
  68
  69
  70
  71                         logDef.setLogName("Command_Exec");
  72                         logDef.setLogText("A character execute an admin command");
  73
  74                         logDef.getParams().resize(3);
  75                         logDef.getListParams().resize(0);
  76
  77
  78                         logDef.getParams()[0].setName("charId");
  79                         logDef.getParams()[0].setType(LGS::TSupportedParamType::spt_entityId);
  80
  81                         logDef.getParams()[1].setName("cmdName");
  82                         logDef.getParams()[1].setType(LGS::TSupportedParamType::spt_string);
  83                         logDef.getParams()[1].setList(false);
  84
  85                         logDef.getParams()[2].setName("cmdArg");
  86                         logDef.getParams()[2].setType(LGS::TSupportedParamType::spt_string);
  87                         logDef.getParams()[2].setList(false);
  88
  89                 }
  90
  91                 {
  92                         LGS::TLogDefinition  &logDef = _LogDefs[2];
  93
  94
  95
  96                         logDef.setLogName("Command_ExecOnTarget");
  97                         logDef.setLogText("A character execute an admin command on its target");
  98
  99                         logDef.getParams().resize(4);
 100                         logDef.getListParams().resize(0);
 101
 102
 103                         logDef.getParams()[0].setName("charId");
 104                         logDef.getParams()[0].setType(LGS::TSupportedParamType::spt_entityId);
 105
 106                         logDef.getParams()[1].setName("targetId");
 107                         logDef.getParams()[1].setType(LGS::TSupportedParamType::spt_entityId);
 108                         logDef.getParams()[1].setList(false);
 109
 110                         logDef.getParams()[2].setName("cmdName");
 111                         logDef.getParams()[2].setType(LGS::TSupportedParamType::spt_string);
 112                         logDef.getParams()[2].setList(false);
 113
 114                         logDef.getParams()[3].setName("cmdArg");
 115                         logDef.getParams()[3].setType(LGS::TSupportedParamType::spt_string);
 116                         logDef.getParams()[3].setList(false);
 117
 118                 }
 119
 120                 {
 121                         LGS::TLogDefinition  &logDef = _LogDefs[3];
 122
 123
 124
 125                         logDef.setLogName("Command_TPOutsideNewbieland");
 126                         logDef.setLogText("A CSR has tp'ed a player outside of the newbieland");
 127
 128                         logDef.getParams().resize(1);
 129                         logDef.getListParams().resize(0);
 130
 131
 132                         logDef.getParams()[0].setName("movedCharId");
 133                         logDef.getParams()[0].setType(LGS::TSupportedParamType::spt_entityId);
 134                         logDef.getParams()[0].setList(false);
 135
 136                 }
 137
 138
 139                 // Register the log definitions
 140                 LGS::ILoggerServiceClient::addLogDefinitions(_LogDefs);
 141         }
 142
 143         // Context var stack accessor
 144
 145         bool getContextVar_charId (NLMISC::CEntityId &value)
 146         {
 147                 if (_charId.empty())
 148                         return false;
 149
 150                 value = _charId.back();
 151                 return true;
 152         }
 153
 154         void pushContextVar_charId (const NLMISC::CEntityId &value)
 155         {
 156                 _charId.push_back(value);
 157         }
 158         void popContextVar_charId ()
 159         {
 160                 _charId.pop_back();
 161         }
 162
 163
 164         void pushNoContext()
 165         {
 166                 ++_NoContextCount;
 167         }
 168         void popNoContext()
 169         {
 170                 nlassert(_NoContextCount > 0);
 171                 --_NoContextCount;
 172         }
 173
 174         uint32 getNoContextCount()
 175         {
 176                 return _NoContextCount;
 177         }
 178
 179 };
 180 // Instantiate the descriptor class
 181 CCommandDesc    CommandDesc;
 182
 183
 184
 185 const std::string TLogContext_Command_ExecCtx::_ContextName("Command_ExecCtx");
 186 /// The constructor push a log context in the logger system
 187 TLogContext_Command_ExecCtx::TLogContext_Command_ExecCtx(const NLMISC::CEntityId &charId)
 188 {
 189         if (LGS::ILoggerServiceClient::isInitialized())
 190                 LGS::ILoggerServiceClient::getInstance()->pushLogContext(_ContextName);
 191
 192         // stack the context param in the context class object
 193         CommandDesc.pushContextVar_charId(charId);
 194
 195 }
 196
 197 /// The destructor pop a context in the logger system
 198 TLogContext_Command_ExecCtx::~TLogContext_Command_ExecCtx()
 199 {
 200         if (LGS::ILoggerServiceClient::isInitialized())
 201                 LGS::ILoggerServiceClient::getInstance()->popLogContext(_ContextName);
 202
 203         // pop the context param in the context class object
 204         CommandDesc.popContextVar_charId();
 205
 206 }
 207
 208
 209 /// No context context. Use this to disable any contextual log underneath
 210 TLogNoContext_Command::TLogNoContext_Command()
 211 {
 212         CommandDesc.pushNoContext();
 213 }
 214
 215 TLogNoContext_Command::~TLogNoContext_Command()
 216 {
 217         CommandDesc.popNoContext();
 218 }
 219
 220
 221
 222 void _log_Command_Exec(const std::string &cmdName, const std::string &cmdArg, const char *_filename_, uint _lineNo_)
 223 {
 224         static LGS::TLogInfo logInfo;
 225         static bool init = false;
 226         if (!init)
 227         {
 228                 logInfo.setLogName("Command_Exec");
 229                 logInfo.getParams().resize(3);
 230                 logInfo.getListParams().resize(0);
 231         }
 232
 233
 234         // Context parameter
 235                 NLMISC::CEntityId       charId;
 236         if (!CommandDesc.getContextVar_charId(charId))
 237         {
 238                 // If this bomb is thrown, you need to add a log context (or otherwise a 'noContext').
 239                 STOP_IF(CommandDesc.getNoContextCount() == 0, _filename_<<"("<<_lineNo_<<") : Missing log context for log 'Command'");
 240                 return;
 241         }
 242
 243
 244         logInfo.getParams()[0] = LGS::TParamValue(charId);
 245
 246         logInfo.getParams()[1] = LGS::TParamValue(cmdName);
 247
 248         logInfo.getParams()[2] = LGS::TParamValue(cmdArg);
 249
 250
 251         logInfo.setTimeStamp(NLMISC::CTime::getSecondsSince1970());
 252
 253         if (LGS::ILoggerServiceClient::isInitialized())
 254                 LGS::ILoggerServiceClient::getInstance()->sendLog(logInfo);
 255 }
 256
 257 void _log_Command_ExecOnTarget(const NLMISC::CEntityId &targetId, const std::string &cmdName, const std::string &cmdArg, const char *_filename_, uint _lineNo_)
 258 {
 259         static LGS::TLogInfo logInfo;
 260         static bool init = false;
 261         if (!init)
 262         {
 263                 logInfo.setLogName("Command_ExecOnTarget");
 264                 logInfo.getParams().resize(4);
 265                 logInfo.getListParams().resize(0);
 266         }
 267
 268
 269         // Context parameter
 270                 NLMISC::CEntityId       charId;
 271         if (!CommandDesc.getContextVar_charId(charId))
 272         {
 273                 // If this bomb is thrown, you need to add a log context (or otherwise a 'noContext').
 274                 STOP_IF(CommandDesc.getNoContextCount() == 0, _filename_<<"("<<_lineNo_<<") : Missing log context for log 'Command'");
 275                 return;
 276         }
 277
 278
 279         logInfo.getParams()[0] = LGS::TParamValue(charId);
 280
 281         logInfo.getParams()[1] = LGS::TParamValue(targetId);
 282
 283         logInfo.getParams()[2] = LGS::TParamValue(cmdName);
 284
 285         logInfo.getParams()[3] = LGS::TParamValue(cmdArg);
 286
 287
 288         logInfo.setTimeStamp(NLMISC::CTime::getSecondsSince1970());
 289
 290         if (LGS::ILoggerServiceClient::isInitialized())
 291                 LGS::ILoggerServiceClient::getInstance()->sendLog(logInfo);
 292 }
 293
 294 void _log_Command_TPOutsideNewbieland(const NLMISC::CEntityId &movedCharId, const char *_filename_, uint _lineNo_)
 295 {
 296         static LGS::TLogInfo logInfo;
 297         static bool init = false;
 298         if (!init)
 299         {
 300                 logInfo.setLogName("Command_TPOutsideNewbieland");
 301                 logInfo.getParams().resize(1);
 302                 logInfo.getListParams().resize(0);
 303         }
 304
 305
 306         logInfo.getParams()[0] = LGS::TParamValue(movedCharId);
 307
 308
 309         logInfo.setTimeStamp(NLMISC::CTime::getSecondsSince1970());
 310
 311         if (LGS::ILoggerServiceClient::isInitialized())
 312                 LGS::ILoggerServiceClient::getInstance()->sendLog(logInfo);
 313 }