ryzom/client/src/login_progress_post_thread.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) 2016  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 "login_progress_post_thread.h"
  22 #include "game_share/login_registry.h"
  23 #include "nel/misc/system_info.h"
  24
  25
  26 using namespace NLMISC;
  27
  28
  29
  30
  31 ///////////////////////
  32 // Utility functions //
  33 ///////////////////////
  34
  35
  36 //===========================================================================================
  37 static std::string uint64ToHex(uint64 size)
  38 {
  39         char data[256];
  40         sprintf(data, "%" NL_I64 "X", size);
  41         return std::string(data);
  42 }
  43
  44 //===========================================================================================
  45 static std::string sizeToHumanStd(uint64 size)
  46 {
  47         double total = (double) size;
  48         std::string unit;
  49         if (total >= 1024.0*1024.0*1024.0)
  50         {
  51                 total /= 1024.0*1024*1024;
  52                 unit = "GB";
  53         }
  54         else if (total >= 1024*1024.0)
  55         {
  56                 total /= 1024.0*1024;
  57                 unit = "MB";
  58         }
  59         else if (total >= 1024.0)
  60         {
  61                 total = int(total/1024.0);
  62                 unit = "KB";
  63         }
  64         else
  65         {
  66                 unit = "B";
  67         }
  68         static char buffer[256];
  69         if ( total > 100.0)
  70         {
  71                 sprintf(buffer, "%0.0f", (double)total);
  72         }
  73         else if (total > 10.0)
  74         {
  75                 sprintf(buffer, "%0.1f", (double)total);
  76         }
  77         else
  78         {
  79                 sprintf(buffer, "%0.2f", (double)total);
  80         }
  81         std::string ret(buffer);
  82         ret+=unit;
  83
  84         return ret;
  85 }
  86
  87 //===========================================================================================
  88 static std::string getVideoInfoDeviceName()
  89 {
  90         uint64 version;
  91         std::string ret;
  92         bool ok = CSystemInfo::getVideoInfo(ret, version);
  93         if (ok)
  94         {
  95                 return ret.c_str();
  96         }
  97         return "";
  98 }
  99
 100 //===========================================================================================
 101 static uint64 getVideoDriverVersion()
 102 {
 103         static std::string ret;
 104         uint64 version=0;
 105         ret.clear();
 106         bool ok = CSystemInfo::getVideoInfo(ret, version);
 107         if (ok)
 108         {
 109                 return version;
 110         }
 111         return 0;
 112 }
 113
 114 //===========================================================================================
 115 static std::string extractToken(const std::string& res, const std::string& token)
 116 {
 117         std::string ret("");
 118         std::string tokenBegin = std::string("<") + token + ">";
 119         std::string::size_type tokenBeginLen = tokenBegin.size();
 120         std::string tokenEnd = std::string("</") + token + ">";
 121         std::string::size_type tokenEndLen = tokenBegin.size();
 122
 123         std::string::size_type begin = res.find(tokenBegin);
 124         std::string::size_type end = begin != std::string::npos && res.size() > tokenBeginLen + tokenEndLen ? res.find(tokenEnd, begin+tokenBeginLen) : std::string::npos;
 125         if (begin != std::string::npos && end != std::string::npos)
 126         {
 127                 ret = res.substr(begin+tokenBeginLen, end - (begin+tokenBeginLen));
 128         }
 129         return ret;
 130
 131 }
 132
 133 /////////////////////////
 134 // login progress task //
 135 /////////////////////////
 136
 137
 138 typedef std::deque<CLoginStep> TStepQueue;
 139
 140 class CLoginProgressTask : public NLMISC::IRunnable
 141 {
 142 public:
 143         std::string                                     StartupHost;
 144         std::string                                     StartupPage;
 145         CSynchronized<TStepQueue>       StepQueue;
 146         bool                                            StopWanted;
 147 public:
 148         //============================================================================================
 149         CLoginProgressTask() : StepQueue("")
 150         {
 151                 StopWanted = false;
 152         }
 153
 154         //============================================================================================
 155         void clearQueue()
 156         {
 157                 CSynchronized<TStepQueue>::CAccessor access(&StepQueue);
 158                 access.value().clear();
 159         }
 160
 161         //============================================================================================
 162         virtual void run()
 163         {
 164                 try
 165                 {
 166                         // init and send hardware info if first time
 167                         std::string productInstallId = CLoginRegistry::getProductInstallId();
 168                         if (productInstallId.empty())
 169                         {
 170                                 throw NLMISC::Exception("Couldn't retrieve product install id");
 171                         }
 172                         std::string res = sendMsg(std::string("login") + "&install_id=" + productInstallId);
 173                         std::string userId = extractToken(res, "user_id");
 174                         if (userId.empty())
 175                         {
 176                                 res = sendMsg(std::string("init") + "&install_id=" + productInstallId + buildSysInfoString());
 177                                 userId = extractToken(res, "user_id");
 178                         }
 179                         if (userId.empty())
 180                         {
 181                                 throw NLMISC::Exception("Couldn't retrieve user id");
 182                         }
 183                         // from now, wait each step from the client
 184                         for (;;)
 185                         {
 186                                 CLoginStep loginStep;
 187                                 bool newStep = false;
 188                                 {
 189                                         CSynchronized<TStepQueue>::CAccessor access(&StepQueue);
 190                                         if (!access.value().empty())
 191                                         {
 192                                                 loginStep = access.value().front();
 193                                                 access.value().pop_front();
 194                                                 newStep = true;
 195                                         }
 196                                         if (newStep)
 197                                         {
 198                                                 if (loginStep.Step == (uint)LoginStep_Stop)
 199                                                 {
 200                                                         break;
 201                                                 }
 202                                                 uint currentStep = CLoginRegistry::getLoginStep();
 203                                                 // during install program some messages can be launch multiple times (eg "install_update&percent=17" that indicates that 17 percent of the installation is already done)
 204                                                 bool isInInstallation = InstallStep_StartDownload <= loginStep.Step && loginStep.Step <=  InstallStep_StopInstall;
 205                                                 bool hasBeenInstalled = currentStep > InstallStep_StopInstall;
 206                                                 if ((isInInstallation&&!hasBeenInstalled) || (loginStep.Step > CLoginRegistry::getLoginStep()) )
 207                                                 {
 208                                                         std::string ret= sendMsg(loginStep.PostString + "&user_id=" + userId);
 209                                                         // If we reached this point, server has correctly received the step -> commit current progress in registry
 210                                                         // Only send msg for player that have never installed the software
 211                                                         CLoginRegistry::setLoginStep(loginStep.Step);
 212                                                         // Async Ret enable the player to Know via pulling the return of the sendMsg
 213                                                         if (loginStep.AsyncRet && loginStep.AsyncSent)
 214                                                         {
 215                                                                 (*loginStep.AsyncRet) = ret;
 216                                                                 (*loginStep.AsyncSent) = true;
 217                                                         }
 218
 219                                                 }
 220                                         }
 221                                 }
 222                                 nlSleep(1000);
 223                                 if (StopWanted) break;
 224                         }
 225                 }
 226                 catch (const std::exception &e)
 227                 {
 228                         nlwarning(e.what());
 229                 }
 230                 catch(...)
 231                 {
 232                         clearQueue();
 233                         throw;
 234                 }
 235                 clearQueue();
 236         }
 237         //============================================================================================
 238         std::string sendMsg(const std::string &msg)
 239         {
 240                 CHttpClient httpClient;
 241                 std::string ret;
 242                 if (!httpClient.connect("http://" + StartupHost))
 243                 {
 244                         throw NLMISC::Exception("Can't connect to http server");
 245                 }
 246                 //std::string postString = "http://" + StartupHost + StartupPage +  "?cmd=log&msg=" + msg;
 247                 //nlwarning("POST STRING = %s", postString.c_str());
 248                 if (!httpClient.sendPost("http://" + StartupHost + StartupPage, "cmd=log&msg=" + msg))
 249                 {
 250                         throw NLMISC::Exception("Post failed");
 251                 }
 252                 if (!httpClient.receive(ret))
 253                 {
 254                         throw NLMISC::Exception("Receive failed");
 255                 }
 256                 httpClient.disconnect();
 257                 return ret;
 258         }
 259         //============================================================================================
 260         std::string buildSysInfoString()
 261         {
 262                 std::string sis;
 263                 sis =  "&os="                           + CSystemInfo::getOS();
 264                 sis += "&proc="                         + CSystemInfo::getProc();
 265                 sis += "&memory="                       + sizeToHumanStd(CSystemInfo::totalPhysicalMemory());
 266                 sis += "&video_card="           + getVideoInfoDeviceName();
 267                 sis += "&driver_version="       + uint64ToHex(getVideoDriverVersion());
 268                 /*
 269                 sis =  "&os=win2k";
 270                 sis += "&proc=p4";
 271                 sis += "&memory=1024";
 272                 sis += "&video_card=ati";
 273                 sis += "&driver_version=1";
 274                 */
 275                 return sis;
 276         }
 277 };
 278
 279 //===========================================================================================
 280 CLoginProgressPostThread::CLoginProgressPostThread()
 281 {
 282         // Construct
 283         _Thread = NULL;
 284         _Task = NULL;
 285 }
 286
 287 //===========================================================================================
 288 CLoginProgressPostThread::~CLoginProgressPostThread()
 289 {
 290         release();
 291 }
 292
 293 //===========================================================================================
 294 void CLoginProgressPostThread::init(const std::string &startupHost, const std::string &startupPage)
 295 {
 296         nlassert(!_Thread);
 297         CLoginProgressTask *lpt = new CLoginProgressTask;
 298         // Its not the real Startup Host this values comes from the InstallStatsUrl value of the config file
 299         lpt->StartupHost = startupHost;
 300         lpt->StartupPage = startupPage;
 301         _Task = lpt;
 302         _Thread = IThread::create(lpt);
 303         if (!_Thread)
 304         {
 305                 release();
 306                 return;
 307         }
 308         _Thread->start();
 309 }
 310
 311 //===========================================================================================
 312 void CLoginProgressPostThread::release()
 313 {
 314         if (_Task)
 315         {
 316                 safe_cast<CLoginProgressTask *>(_Task)->StopWanted = true;
 317         }
 318         if (_Thread && _Thread->isRunning()) _Thread->wait();
 319         delete _Task;
 320         delete _Thread;
 321         _Task = NULL;
 322         _Thread = NULL;
 323 }
 324
 325 //===========================================================================================
 326 void CLoginProgressPostThread::step(const CLoginStep &ls)
 327 {
 328         if (!_Task) return;
 329         if (!_Thread->isRunning()) return;
 330         CLoginProgressTask *lpt = safe_cast<CLoginProgressTask *>(_Task);
 331         {
 332                 CSynchronized<TStepQueue>::CAccessor access(&lpt->StepQueue);
 333                 access.value().push_back(ls);
 334         }
 335 }
 336
 337 //===========================================================================================
 338 void CLoginProgressPostThread::init(NLMISC::CConfigFile &configFile)
 339 {
 340         std::string installStartupPage;
 341         std::string installStartupHost;
 342         static std::string httpStr = "http://";
 343
 344         if (configFile.getVarPtr("InstallStatsUrl") )
 345         {
 346
 347                 static std::string httpStr = "http://";
 348                 static std::string::size_type httpStrSize = httpStr.size();
 349                 std::string tmp = configFile.getVarPtr("InstallStatsUrl")->asString(0);
 350                 std::string::size_type it= tmp.find(httpStr);
 351                 if (it == std::string::npos) return;
 352
 353                 std::string::size_type hostPageSeparator = tmp.find("/", httpStrSize);
 354                 if (hostPageSeparator == std::string::npos) return;
 355
 356                 installStartupPage = tmp.substr(hostPageSeparator); //keep the leading slash
 357                 installStartupHost = tmp.substr(httpStrSize, hostPageSeparator  - httpStrSize); // dont keep the last slah
 358
 359                 init(installStartupHost, installStartupPage);
 360         }
 361         else
 362         {
 363 //              nlwarning("Error the InstallStatsUrl is not in the client_default.cfg.");
 364         }
 365 }
 366
 367
 368
 369