ryzom/client/src/login_patch.cpp

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010-2020  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2014  Matthew LAGOE (Botanic) <cyberempires@gmail.com>
   6 // Copyright (C) 2014-2020  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   7 //
   8 // This program is free software: you can redistribute it and/or modify
   9 // it under the terms of the GNU Affero General Public License as
  10 // published by the Free Software Foundation, either version 3 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU Affero General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Affero General Public License
  19 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 //
  22 // Includes
  23 //
  24
  25 #include "stdpch.h"
  26
  27 #include <sys/stat.h>
  28
  29 #ifndef NL_OS_WINDOWS
  30         #include <unistd.h>
  31 #endif
  32
  33 #ifdef NL_OS_MAC
  34         #include "app_bundle_utils.h"
  35 #endif
  36
  37 #include <memory>
  38 #include <errno.h>
  39
  40 #define USE_CURL
  41
  42 #ifdef USE_CURL
  43         #include <curl/curl.h>
  44 #endif
  45
  46 #include <zlib.h>
  47
  48 #include "nel/misc/debug.h"
  49 #include "nel/misc/path.h"
  50 #include "nel/misc/thread.h"
  51 #include "nel/misc/sha1.h"
  52 #include "nel/misc/big_file.h"
  53 #include "nel/misc/i18n.h"
  54 #include "nel/misc/cmd_args.h"
  55 #include "nel/misc/seven_zip.h"
  56 #include "nel/web/curl_certificates.h"
  57
  58 #include "game_share/bg_downloader_msg.h"
  59
  60 #include "login_patch.h"
  61 #include "login.h"
  62 #include "user_agent.h"
  63
  64
  65 #ifndef RY_BG_DOWNLOADER
  66         #include "client_cfg.h"
  67 #else
  68         #include "../client_background_downloader/client_background_downloader.h"
  69         #define __CLIENT_INSTALL_EXE__
  70 #endif
  71
  72 #ifdef NL_OS_WINDOWS
  73         #include <direct.h>
  74 #endif
  75
  76 //
  77 // Namespaces
  78 //
  79
  80
  81 using namespace std;
  82 using namespace NLMISC;
  83
  84
  85 extern string VersionName;
  86 extern string R2ServerVersion;
  87
  88 #ifdef __CLIENT_INSTALL_EXE__
  89         extern std::string TheTmpInstallDirectory;
  90         extern std::string ClientLauncherUrl;
  91 #else
  92         std::string TheTmpInstallDirectory = "patch/client_install";
  93 #endif
  94
  95 extern NLMISC::CCmdArgs Args;
  96
  97 // ****************************************************************************
  98 // ****************************************************************************
  99 // ****************************************************************************
 100 // CPatchManager
 101 // ****************************************************************************
 102 // ****************************************************************************
 103 // ****************************************************************************
 104
 105 struct EPatchDownloadException : public Exception
 106 {
 107         EPatchDownloadException() : Exception( "Download Error" ) {}
 108         EPatchDownloadException( const std::string& str ) : Exception( str ) {}
 109         virtual ~EPatchDownloadException() throw(){}
 110 };
 111
 112
 113 CPatchManager *CPatchManager::_Instance = NULL;
 114
 115 static std::string ClientRootPath;
 116
 117 // ****************************************************************************
 118 CPatchManager::CPatchManager() : State("t_state"), DataScanState("t_data_scan_state")
 119 {
 120         DescFilename = "ryzom_xxxxx.idx";
 121
 122 #ifdef NL_OS_WINDOWS
 123         UpdateBatchFilename = "updt_nl.bat";
 124         UpgradeBatchFilename = "upgd_nl.bat";
 125 #else
 126         UpdateBatchFilename = "updt_nl.sh";
 127         UpgradeBatchFilename = "upgd_nl.sh";
 128 #endif
 129
 130         std::string rootPath;
 131
 132         if (ClientCfg.getDefaultConfigLocation(rootPath))
 133         {
 134                 // use same directory as client_default.cfg
 135                 rootPath = CFile::getPath(rootPath);
 136         }
 137         else
 138         {
 139                 // use current directory
 140                 rootPath = CPath::getCurrentPath();
 141         }
 142
 143         setClientRootPath(rootPath);
 144
 145         VerboseLog = true;
 146
 147         PatchThread = NULL;
 148         CheckThread = NULL;
 149         InstallThread = NULL;
 150         ScanDataThread = NULL;
 151         DownloadThread = NULL;
 152         Thread = NULL;
 153
 154         LogSeparator = "\n";
 155         ValidDescFile = false;
 156
 157         MustLaunchBatFile = false;
 158
 159         DownloadInProgress = false;
 160         _AsyncDownloader = NULL;
 161         _StateListener = NULL;
 162         _StartRyzomAtEnd = true;
 163 }
 164
 165 // ****************************************************************************
 166 void CPatchManager::setClientRootPath(const std::string& clientRootPath)
 167 {
 168         ClientRootPath = CPath::standardizePath(clientRootPath);
 169         ClientPatchPath = CPath::standardizePath(ClientRootPath + "unpack");
 170
 171         // Delete the .sh file because it's not useful anymore
 172         std::string fullUpdateBatchFilename = ClientRootPath + UpdateBatchFilename;
 173
 174         if (NLMISC::CFile::fileExists(fullUpdateBatchFilename))
 175                 NLMISC::CFile::deleteFile(fullUpdateBatchFilename);
 176
 177         WritableClientDataPath = CPath::standardizePath(ClientRootPath + "data");
 178
 179 #ifdef NL_OS_MAC
 180         ReadableClientDataPath = CPath::standardizePath(getAppBundlePath() + "/Contents/Resources/data");
 181 #elif defined(NL_OS_UNIX)
 182         ReadableClientDataPath = CPath::standardizePath(getRyzomSharePrefix() + "/data");
 183         if (CFile::isDirectory(ReadableClientDataPath)) ReadableClientDataPath.clear();
 184 #else
 185         ReadableClientDataPath.clear();
 186 #endif
 187
 188         if (ReadableClientDataPath.empty()) ReadableClientDataPath = WritableClientDataPath;
 189 }
 190
 191 // ****************************************************************************
 192 void CPatchManager::setErrorMessage(const std::string &message)
 193 {
 194         _ErrorMessage = message;
 195 }
 196
 197 // ****************************************************************************
 198 void CPatchManager::forceStopCheckThread()
 199 {
 200         PatchThread->StopAsked = true;
 201 }
 202
 203 // ****************************************************************************
 204 void CPatchManager::forceStopPatchThread()
 205 {
 206         CheckThread->StopAsked = true;
 207 }
 208
 209 // ****************************************************************************
 210 void CPatchManager::init(const std::vector<std::string>& patchURIs, const std::string &sServerPath, const std::string &sServerVersion)
 211 {
 212         uint    i;
 213         PatchServers.clear();
 214
 215         for (i=0; i<patchURIs.size(); ++i)
 216         {
 217                 PatchServers.push_back(CPatchServer(patchURIs[i]));
 218         }
 219
 220         srand(NLMISC::CTime::getSecondsSince1970());
 221         UsedServer = (sint)(((double)rand() / ((double)RAND_MAX+1.0)) * (double)PatchServers.size());
 222
 223         ServerPath = CPath::standardizePath (sServerPath);
 224         ServerVersion = sServerVersion;
 225
 226         string::size_type pos = ServerPath.find ("@");
 227         if (pos != string::npos)
 228                 DisplayedServerPath = "http://" + ServerPath.substr (pos+1);
 229         else
 230                 DisplayedServerPath = ServerPath;
 231
 232         NLMISC::CFile::createDirectory(ClientPatchPath);
 233         NLMISC::CFile::createDirectory(WritableClientDataPath);
 234
 235
 236         // try to read the version file from the server (that will replace the version number)
 237         try
 238         {
 239                 CConfigFile *cf;
 240
 241 #ifdef RY_BG_DOWNLOADER
 242                 cf = &theApp.ConfigFile;
 243 #else
 244                 cf = &ClientCfg.ConfigFile;
 245 #endif
 246
 247                 // App name matches Domain on the SQL server
 248                 std::string appName = cf->getVarPtr("Application")
 249                         ? cf->getVar("Application").asString(0)
 250                         : "default";
 251
 252                 std::string versionFileName = appName + ".version";
 253                 getServerFile(versionFileName);
 254
 255                 // ok, we have the file, extract version number (aka build number) and the
 256                 // version name if present
 257
 258                 CIFile versionFile(ClientPatchPath + versionFileName);
 259                 char buffer[1024];
 260                 versionFile.getline(buffer, 1024);
 261                 CSString line(buffer);
 262
 263 #ifdef NL_DEBUG
 264                 CConfigFile::CVar *forceVersion = cf->getVarPtr("ForceVersion");
 265
 266                 if (forceVersion != NULL)
 267                 {
 268                         line = forceVersion->asString();
 269                 }
 270 #endif
 271
 272                 // Use the version specified in this file, if the file does not contain an asterisk
 273                 if (line[0] != '*')
 274                 {
 275                         ServerVersion = line.firstWord(true);
 276                         VersionName = line.firstWord(true);
 277                 }
 278
 279                 // force the R2ServerVersion
 280                 R2ServerVersion = ServerVersion;
 281
 282 #ifdef __CLIENT_INSTALL_EXE__
 283                 {
 284                         //The install program load a the url of the mini web site in the patch directory
 285
 286                         std::string clientLauncherUrl = "client_launcher_url.txt";
 287                         bool ok = true;
 288                         try
 289                         {
 290                                 uint32 nServerVersion;
 291                                 fromString(ServerVersion, nServerVersion);
 292                                 std::string url = toString("%05u/%s", nServerVersion, clientLauncherUrl.c_str());
 293                                 // The client version is different from the server version : download new description file
 294                                 getServerFile(url.c_str(), false); // For the moment description file is not zipped
 295                         }
 296                         catch (...)
 297                         {
 298                                 // fallback to patch root directory
 299                                 try
 300                                 {
 301                                         getServerFile(clientLauncherUrl.c_str(), false); // For the moment description file is not zipped
 302                                 }
 303                                 catch(...)
 304                                 {
 305                                         ok = false;
 306                                 }
 307                         }
 308
 309                         if (ok)
 310                         {
 311                                 CIFile versionFile;
 312                                 if (versionFile.open(ClientPatchPath+clientLauncherUrl) )
 313                                 {
 314                                         char buffer[1024];
 315                                         versionFile.getline(buffer, 1024);
 316                                         ClientLauncherUrl = std::string(buffer);
 317                                 }
 318                         }
 319                 }
 320 #endif
 321         }
 322         catch (...)
 323         {
 324                 // no version file
 325         }
 326
 327
 328         // retrieve the current client version, according to .idx
 329         readClientVersionAndDescFile();
 330 }
 331
 332 // ***************************************************************************
 333 void CPatchManager::readClientVersionAndDescFile()
 334 {
 335         try
 336         {
 337                 ValidDescFile = false;
 338                 vector<string> vFiles;
 339                 CPath::getPathContent(ClientPatchPath, false, false, true, vFiles);
 340                 uint32 nVersion = 0xFFFFFFFF;
 341                 uint32 nNewVersion;
 342                 for (uint32 i = 0; i < vFiles.size(); ++i)
 343                 {
 344                         string sName = NLMISC::CFile::getFilename(vFiles[i]);
 345                         string sExt = NLMISC::CFile::getExtension(sName);
 346                         string sBase = sName.substr(0, sName.rfind('_'));
 347                         if ((sExt == "idx") && (sBase == "ryzom"))
 348                         {
 349                                 string val = sName.substr(sName.rfind('_')+1, 5);
 350                                 if (fromString(val, nNewVersion) && ((nNewVersion > nVersion) || (nVersion == 0xFFFFFFFF)))
 351                                         nVersion = nNewVersion;
 352                         }
 353                 }
 354                 if (nVersion != 0xFFFFFFFF)
 355                         readDescFile(nVersion);
 356                 else
 357                         DescFilename = "unknown";
 358                 ValidDescFile = true;
 359         }
 360         catch(const Exception &)
 361         {
 362                 nlwarning("EXCEPTION CATCH: readClientVersionAndDescFile() failed - not important");
 363                 // Not important that there is no desc file
 364         }
 365 }
 366
 367 // ****************************************************************************
 368 void CPatchManager::startCheckThread(bool includeBackgroundPatch)
 369 {
 370         if (CheckThread != NULL)
 371         {
 372                 nlwarning ("check thread is already running");
 373                 return;
 374         }
 375         if (Thread != NULL)
 376         {
 377                 nlwarning ("a thread is already running");
 378                 return;
 379         }
 380
 381         _ErrorMessage.clear();
 382
 383         CheckThread = new CCheckThread(includeBackgroundPatch);
 384         nlassert (CheckThread != NULL);
 385
 386         Thread = IThread::create (CheckThread);
 387         nlassert (Thread != NULL);
 388         Thread->start ();
 389 }
 390
 391 // ****************************************************************************
 392 bool CPatchManager::isCheckThreadEnded(bool &ok)
 393 {
 394         if (CheckThread == NULL)
 395         {
 396                 ok = false;
 397                 return true;
 398         }
 399
 400         bool end = CheckThread->Ended;
 401         if (end)
 402         {
 403                 ok = CheckThread->CheckOk;
 404                 stopCheckThread();
 405         }
 406
 407         return end;
 408 }
 409
 410 // ****************************************************************************
 411 void CPatchManager::stopCheckThread()
 412 {
 413         if(CheckThread && Thread)
 414         {
 415                 Thread->wait();
 416                 delete Thread;
 417                 Thread = NULL;
 418                 delete CheckThread;
 419                 CheckThread = NULL;
 420         }
 421 }
 422
 423 // Return the position of the inserted/found category
 424 sint32 updateCat(vector<CPatchManager::SPatchInfo::SCat> &rOutVec, CPatchManager::SPatchInfo::SCat &rInCat)
 425 {
 426         uint32 i;
 427         for (i = 0; i < rOutVec.size(); ++i)
 428         {
 429                 if (rOutVec[i].Name == rInCat.Name)
 430                         break;
 431         }
 432
 433         if (i == rOutVec.size())
 434         {
 435                 rOutVec.push_back(rInCat);
 436         }
 437         else
 438         {
 439                 rOutVec[i].Size += rInCat.Size;
 440                 rOutVec[i].FinalFileSize += rInCat.FinalFileSize;
 441                 rOutVec[i].SZipSize += rInCat.SZipSize;
 442         }
 443
 444         return i;
 445 }
 446
 447 // ****************************************************************************
 448 void CPatchManager::getInfoToDisp(SPatchInfo &piOut)
 449 {
 450         piOut.NonOptCat.clear();
 451         piOut.OptCat.clear();
 452         piOut.ReqCat.clear();
 453
 454         // Convert FilesToPatch vector that must be initialized into something human readable
 455         uint32 i;
 456         for (i = 0; i < FilesToPatch.size(); ++i)
 457         {
 458                 SFileToPatch &rFTP = FilesToPatch[i];
 459                 // Find the category of the file
 460                 sint32 nCat = -1;
 461                 const CBNPCategorySet &rAllCats = DescFile.getCategories();
 462                 for (uint32 j = 0; j < rAllCats.categoryCount(); ++j)
 463                 {
 464                         const CBNPCategory &rCat = rAllCats.getCategory(j);
 465                         for (uint32 k = 0; k < rCat.fileCount(); ++k)
 466                         {
 467                                 if (rCat.getFile(k) == rFTP.FileName)
 468                                 {
 469                                         nCat = j;
 470                                         break;
 471                                 }
 472                         }
 473
 474                         if (nCat != -1)
 475                                 break;
 476                 }
 477
 478                 if (nCat != -1)
 479                 {
 480                         // Add the category found, if already there just update the size
 481                         const CBNPCategory &rCat = rAllCats.getCategory(nCat);
 482                         string sCatName = rCat.getName();
 483                         // Size of all patches
 484                         uint32 nTotalPatchesSize = 0;
 485                         for (uint32 j = 0; j < rFTP.PatcheSizes.size(); ++j)
 486                                 nTotalPatchesSize += rFTP.PatcheSizes[j];
 487
 488                         SPatchInfo::SCat c;
 489                         c.Name = sCatName;
 490                         c.Size = nTotalPatchesSize;
 491                         c.SZipSize = rFTP.SZFileSize;
 492                         c.FinalFileSize = rFTP.FinalFileSize;
 493                         if (!rCat.getCatRequired().empty())
 494                         {
 495                                 // Ensure the required cat exists
 496                                 SPatchInfo::SCat rc;
 497                                 rc.Name = rCat.getCatRequired();
 498                                 c.Req = updateCat(piOut.ReqCat, rc);
 499                         }
 500
 501                         // In which category of category should we add it ?
 502                         if (rCat.isOptional())
 503                         {
 504                                 if (rCat.isHidden())
 505                                         updateCat(piOut.ReqCat, c);
 506                                 else
 507                                         updateCat(piOut.OptCat, c);
 508                         }
 509                         else
 510                         {
 511                                 updateCat(piOut.NonOptCat, c);
 512                         }
 513                 }
 514         }
 515
 516         for (i = 0; i < OptionalCat.size(); ++i)
 517         {
 518                 const CBNPCategory *pCat = DescFile.getCategories().getCategory(OptionalCat[i]);
 519                 nlassert(pCat != NULL);
 520
 521                 SPatchInfo::SCat c;
 522                 c.Name = pCat->getName();
 523
 524                 if (!pCat->getCatRequired().empty())
 525                 {
 526                         // Ensure the required cat exists
 527                         SPatchInfo::SCat rc;
 528                         rc.Name = pCat->getCatRequired();
 529                         c.Req = updateCat(piOut.ReqCat, rc);
 530                 }
 531
 532                 updateCat(piOut.OptCat, c);
 533         }
 534 }
 535
 536 // ****************************************************************************
 537 // TODO : use selected categories to patch a list of files
 538 void CPatchManager::startPatchThread(const vector<string> &CategoriesSelected, bool applyPatch)
 539 {
 540         if (PatchThread != NULL)
 541         {
 542                 nlwarning ("check thread is already running");
 543                 return;
 544         }
 545         if (Thread != NULL)
 546         {
 547                 nlwarning ("a thread is already running");
 548                 return;
 549         }
 550
 551         _ErrorMessage.clear();
 552
 553         PatchThread = new CPatchThread(applyPatch);
 554         nlassert (PatchThread != NULL);
 555
 556         // Select all the files we have to patch depending on non-optional categories and selected categories
 557         uint32 i, j, k;
 558         // Add non-optional categories
 559         vector<string> CatsSelected = CategoriesSelected;
 560         PatchThread->clear();
 561         const CBNPCategorySet &rAllCats = DescFile.getCategories();
 562         for (i = 0; i < rAllCats.categoryCount(); ++i)
 563         {
 564                 const CBNPCategory &rCat = rAllCats.getCategory(i);
 565                 if (!rCat.isOptional())
 566                         CatsSelected.push_back(rCat.getName());
 567         }
 568
 569         // Add all required categories
 570         uint32 nSize = (uint32)CatsSelected.size();
 571         do
 572         {
 573                 nSize = (uint32)CatsSelected.size();
 574
 575                 for (i = 0; i < CatsSelected.size(); ++i)
 576                 {
 577                         const CBNPCategory *pCat = rAllCats.getCategory(CatsSelected[i]);
 578                         if (pCat == NULL) continue;
 579                         if (pCat->getCatRequired().empty()) continue;
 580                         // Check if the category required is already present
 581                         for (j = 0; j < CatsSelected.size(); ++j)
 582                         {
 583                                 const CBNPCategory *pCat2 = rAllCats.getCategory(CatsSelected[j]);
 584                                 if (pCat2->getName() == pCat->getCatRequired())
 585                                         break;
 586                         }
 587                         // Not present ?
 588                         if (j == CatsSelected.size())
 589                         {
 590                                 CatsSelected.push_back(pCat->getCatRequired());
 591                                 break;
 592                         }
 593                 }
 594         }
 595         while(nSize != CatsSelected.size());
 596
 597         // Select files
 598         for (i = 0; i < CatsSelected.size(); ++i)
 599         {
 600                 // Find the category from the name
 601                 const CBNPCategory *pCat = rAllCats.getCategory(CatsSelected[i]);
 602                 if (pCat != NULL)
 603                 {
 604                         for (j = 0; j < pCat->fileCount(); ++j)
 605                         {
 606                                 const string &rFilename = pCat->getFile(j);
 607                                 const CBNPFileSet &rFileSet = DescFile.getFiles();
 608                                 const CBNPFile *pFile = rFileSet.getFileByName(rFilename);
 609                                 if (pFile != NULL)
 610                                 {
 611                                         // Look if it's a file to patch
 612                                         for (k = 0; k < FilesToPatch.size(); ++k)
 613                                                 if (FilesToPatch[k].FileName == pFile->getFileName())
 614                                                         break;
 615
 616                                         if (k < FilesToPatch.size())
 617                                         {
 618                                                 FilesToPatch[k].Incremental = pCat->isIncremental();
 619                                                 if (!pCat->getUnpackTo().empty())
 620                                                         FilesToPatch[k].ExtractPath = CPath::standardizePath(pCat->getUnpackTo());
 621
 622                                                 PatchThread->add(FilesToPatch[k]);
 623
 624                                                 // Close opened big files
 625                                                 CBigFile::getInstance().remove(FilesToPatch[k].FileName);
 626                                         }
 627                                 }
 628                         }
 629                 }
 630         }
 631
 632         // Launch the thread
 633         Thread = IThread::create (PatchThread);
 634         nlassert (Thread != NULL);
 635         Thread->start ();
 636 }
 637
 638 // ****************************************************************************
 639 bool CPatchManager::isPatchThreadEnded (bool &ok)
 640 {
 641         if (PatchThread == NULL)
 642         {
 643                 ok = false;
 644                 return true;
 645         }
 646
 647         bool end = PatchThread->Ended;
 648         if (end)
 649         {
 650                 ok = PatchThread->PatchOk;
 651                 stopPatchThread();
 652         }
 653
 654         return end;
 655 }
 656
 657 // ****************************************************************************
 658 // Called in main thread
 659 bool CPatchManager::getThreadState (std::string &stateOut, vector<string> &stateLogOut)
 660 {
 661         if ((PatchThread == NULL) && (CheckThread == NULL) && (ScanDataThread==NULL))
 662                 return false;
 663
 664         // clear output
 665         stateOut.clear();
 666         stateLogOut.clear();
 667
 668         // Get access to the state
 669         bool    changed= false;
 670         {
 671                 CSynchronized<CState>::CAccessor as(&State);
 672                 CState  &rState= as.value();
 673                 if (rState.StateChanged)
 674                 {
 675                         // and retrieve info
 676                         changed= true;
 677                         stateOut = rState.State;
 678                         stateLogOut = rState.StateLog;
 679                         // clear state
 680                         rState.StateLog.clear();
 681                         rState.StateChanged= false;
 682                 }
 683         }
 684
 685         // verbose log
 686         if (isVerboseLog() && !stateLogOut.empty())
 687                 for (uint32 i = 0; i < stateLogOut.size(); ++i)
 688                         nlinfo("%s", stateLogOut[i].c_str());
 689
 690         return changed;
 691 }
 692
 693 // ****************************************************************************
 694 void CPatchManager::stopPatchThread()
 695 {
 696         if(PatchThread && Thread)
 697         {
 698                 Thread->wait();
 699                 delete Thread;
 700                 Thread = NULL;
 701                 delete PatchThread;
 702                 PatchThread = NULL;
 703         }
 704 }
 705
 706 // ****************************************************************************
 707 void CPatchManager::deleteBatchFile()
 708 {
 709         deleteFile(ClientRootPath + UpdateBatchFilename, false, false);
 710 }
 711
 712 // ****************************************************************************
 713 void CPatchManager::createBatchFile(CProductDescriptionForClient &descFile, bool wantRyzomRestart, bool useBatchFile)
 714 {
 715         uint nblab = 0;
 716
 717         std::string content;
 718
 719         // Unpack files with category ExtractPath non empty
 720         const CBNPCategorySet &rDescCats = descFile.getCategories();
 721         OptionalCat.clear();
 722
 723         for (uint32 i = 0; i < rDescCats.categoryCount(); ++i)
 724         {
 725                 // For all optional categories check if there is a 'file to patch' in it
 726                 const CBNPCategory &rCat = rDescCats.getCategory(i);
 727
 728                 nlinfo("Category = %s", rCat.getName().c_str());
 729
 730                 if (!rCat.getUnpackTo().empty())
 731                 for (uint32 j = 0; j < rCat.fileCount(); ++j)
 732                 {
 733                         string rFilename = ClientPatchPath + rCat.getFile(j);
 734
 735                         nlinfo("\tFileName = %s", rFilename.c_str());
 736
 737                         // Extract to patch
 738                         vector<string> vFilenames;
 739
 740                         bool result = false;
 741
 742                         try
 743                         {
 744                                 result = bnpUnpack(rFilename, ClientPatchPath, vFilenames);
 745                         }
 746                         catch(...)
 747                         {
 748                                 throw;
 749                         }
 750
 751                         if (!result)
 752                         {
 753                                 // TODO: handle exception?
 754                                 string err = toString("Error unpacking %s", rFilename.c_str());
 755
 756                                 throw Exception (err);
 757                         }
 758                         else
 759                         {
 760                                 for (uint32 fff = 0; fff < vFilenames.size (); fff++)
 761                                 {
 762                                         // this file must be moved
 763                                         string fullDstPath = CPath::standardizePath(rCat.getUnpackTo()); // to be sure there is a / at the end
 764                                         NLMISC::CFile::createDirectoryTree(fullDstPath);
 765
 766                                         std::string FileName = vFilenames[fff];
 767
 768                                         bool succeeded = false;
 769
 770                                         if (!useBatchFile)
 771                                         {
 772                                                 // don't check result, because it's possible the olk file doesn't exist
 773                                                 CFile::deleteFile(fullDstPath + FileName);
 774
 775                                                 // try to move it, if fails move it later in a script
 776                                                 if (CFile::moveFile(fullDstPath + FileName, ClientPatchPath + FileName))
 777                                                         succeeded = true;
 778                                         }
 779
 780                                         // if we didn't succeed to delete or move the file, create a batch file anyway
 781                                         if (!succeeded)
 782                                         {
 783                                                 string batchRelativeDstPath;
 784
 785                                                 // should be always true
 786                                                 if (fullDstPath.compare(0, ClientRootPath.length(), ClientRootPath) == 0)
 787                                                 {
 788                                                         batchRelativeDstPath = fullDstPath.substr(ClientRootPath.length()) + FileName;
 789                                                 }
 790                                                 else
 791                                                 {
 792                                                         batchRelativeDstPath = fullDstPath + FileName;
 793                                                 }
 794
 795 #ifdef NL_OS_WINDOWS
 796                                                 // only fix backslashes for .bat
 797                                                 batchRelativeDstPath = CPath::standardizeDosPath(batchRelativeDstPath);
 798
 799                                                 // use DSTPATH and SRCPATH variables and append filenames
 800                                                 string realDstPath = toString("\"%%ROOTPATH%%\\%s\"", batchRelativeDstPath.c_str());
 801                                                 string realSrcPath = toString("\"%%UNPACKPATH%%\\%s\"", FileName.c_str());
 802
 803                                                 content += toString(":loop%u\n", nblab);
 804                                                 content += toString("attrib -r -a -s -h %s\n", realDstPath.c_str());
 805                                                 content += toString("del %s\n", realDstPath.c_str());
 806                                                 content += toString("if exist %s goto loop%u\n", realDstPath.c_str(), nblab);
 807                                                 content += toString("move %s %s\n", realSrcPath.c_str(), realDstPath.c_str());
 808 #else
 809                                                 // use DSTPATH and SRCPATH variables and append filenames
 810                                                 string realDstPath = toString("\"$ROOTPATH/%s\"", batchRelativeDstPath.c_str());
 811                                                 string realSrcPath = toString("\"$UNPACKPATH/%s\"", FileName.c_str());
 812
 813                                                 content += toString("rm -rf %s\n", realDstPath.c_str());
 814                                                 content += toString("mv %s %s\n", realSrcPath.c_str(), realDstPath.c_str());
 815 #endif
 816
 817                                                 content += "\n";
 818                                         }
 819
 820                                         nblab++;
 821                                 }
 822                         }
 823                 }
 824         }
 825
 826         std::string patchDirectory = CPath::standardizePath(ClientRootPath + "patch");
 827
 828         // Finalize batch file
 829         if (NLMISC::CFile::isExists(patchDirectory) && NLMISC::CFile::isDirectory(patchDirectory))
 830         {
 831                 std::string patchContent;
 832
 833                 vector<string> vFileList;
 834                 CPath::getPathContent (patchDirectory, false, false, true, vFileList, NULL, false);
 835
 836                 for(uint32 i = 0; i < vFileList.size(); ++i)
 837                 {
 838                         bool succeeded = false;
 839
 840                         if (!useBatchFile)
 841                         {
 842                                 if (CFile::deleteFile(vFileList[i]))
 843                                         succeeded = true;
 844                         }
 845
 846                         // if we didn't succeed to delete, create a batch file anyway
 847                         if (!succeeded)
 848                         {
 849 #ifdef NL_OS_WINDOWS
 850                                 patchContent += toString("del \"%%ROOTPATH%%\\patch\\%s\"\n", vFileList[i].c_str());
 851 #else
 852                                 patchContent += toString("rm -f \"$ROOTPATH/patch/%s\"\n", vFileList[i].c_str());
 853 #endif
 854                         }
 855                 }
 856
 857                 if (!patchContent.empty())
 858                 {
 859 #ifdef NL_OS_WINDOWS
 860                         content += ":looppatch\n";
 861
 862                         content += patchContent;
 863
 864                         content += "rd /Q /S \"%%ROOTPATH%%\\patch\"\n";
 865                         content += "if exist \"%%ROOTPATH%%\\patch\" goto looppatch\n";
 866 #else
 867                         content += "rm -rf \"$ROOTPATH/patch\"\n";
 868 #endif
 869                 }
 870                 else
 871                 {
 872                         CFile::deleteDirectory(patchDirectory);
 873                 }
 874         }
 875
 876         if (!content.empty())
 877         {
 878                 deleteBatchFile();
 879
 880                 // batch full path
 881                 std::string batchFilename = ClientRootPath + UpdateBatchFilename;
 882
 883                 // write windows .bat format else write sh format
 884                 FILE *fp = nlfopen (batchFilename, "wt");
 885
 886                 if (fp == NULL)
 887                 {
 888                         string err = toString("Can't open file '%s' for writing: code=%d %s (error code 29)", batchFilename.c_str(), errno, strerror(errno));
 889                         throw Exception (err);
 890                 }
 891                 else
 892                 {
 893                         nlinfo("Creating %s...", batchFilename.c_str());
 894                 }
 895
 896                 string contentPrefix;
 897
 898                 //use bat if windows if not use sh
 899 #ifdef NL_OS_WINDOWS
 900                 contentPrefix += "@echo off\n";
 901                 contentPrefix += "set RYZOM_CLIENT=%~1\n";
 902                 contentPrefix += "set UNPACKPATH=%~2\n";
 903                 contentPrefix += "set ROOTPATH=%~3\n";
 904                 contentPrefix += "set STARTUPPATH=%~4\n";
 905                 contentPrefix += toString("set UPGRADE_FILE=%%ROOTPATH%%\\%s\n", UpgradeBatchFilename.c_str());
 906                 contentPrefix += "\n";
 907                 contentPrefix += "set LOGIN=%~5\n";
 908                 contentPrefix += "set PASSWORD=%~6\n";
 909                 contentPrefix += "set SHARDID=%~7\n";
 910 #else
 911                 contentPrefix += "#!/bin/sh\n";
 912                 contentPrefix += "export RYZOM_CLIENT=\"$1\"\n";
 913                 contentPrefix += "export UNPACKPATH=\"$2\"\n";
 914                 contentPrefix += "export ROOTPATH=\"$3\"\n";
 915                 contentPrefix += "export STARTUPPATH=\"$4\"\n";
 916                 contentPrefix += toString("export UPGRADE_FILE=$ROOTPATH/%s\n", UpgradeBatchFilename.c_str());
 917                 contentPrefix += "\n";
 918                 contentPrefix += "LOGIN=\"$5\"\n";
 919                 contentPrefix += "PASSWORD=\"$6\"\n";
 920                 contentPrefix += "SHARDID=\"$7\"\n";
 921 #endif
 922
 923                 contentPrefix += "\n";
 924
 925                 string contentSuffix;
 926
 927                 // if we need to restart Ryzom, we need to launch it in batch
 928                 std::string additionalParams;
 929
 930                 if (Args.haveLongArg("profile"))
 931                 {
 932                         additionalParams = "--profile " + Args.getLongArg("profile").front();
 933                 }
 934
 935 #ifdef NL_OS_WINDOWS
 936                 // launch upgrade script if present (it'll execute additional steps like moving or deleting files)
 937                 contentSuffix += "if exist \"%UPGRADE_FILE%\" call \"%UPGRADE_FILE%\"\n";
 938
 939                 if (wantRyzomRestart)
 940                 {
 941                         // client shouldn't be in memory anymore else it couldn't be overwritten
 942                         contentSuffix += toString("start \"\" /D \"%%STARTUPPATH%%\" \"%%RYZOM_CLIENT%%\" %s \"%%LOGIN%%\" \"%%PASSWORD%%\" \"%%SHARDID%%\"\n", additionalParams.c_str());
 943                 }
 944 #else
 945                 if (wantRyzomRestart)
 946                 {
 947                         // wait until client not in memory anymore
 948                         contentSuffix += toString("until ! pgrep -x \"%s\" > /dev/null; do sleep 1; done\n", CFile::getFilename(RyzomFilename).c_str());
 949                 }
 950
 951                 // launch upgrade script if present (it'll execute additional steps like moving or deleting files)
 952                 contentSuffix += "if [ -e \"$UPGRADE_FILE\" ]; then chmod +x \"$UPGRADE_FILE\" && \"$UPGRADE_FILE\"; fi\n\n";
 953
 954                 // be sure file is executable
 955                 contentSuffix += "chmod +x \"$RYZOM_CLIENT\"\n\n";
 956
 957                 if (wantRyzomRestart)
 958                 {
 959                         // change to previous client directory
 960                         contentSuffix += "cd \"$STARTUPPATH\"\n\n";
 961
 962                         // launch new client
 963 #ifdef NL_OS_MAC
 964                         // use exec command under OS X
 965                         contentSuffix += toString("exec \"$RYZOM_CLIENT\" %s \"$LOGIN\" \"$PASSWORD\" \"$SHARDID\"\n", additionalParams.c_str());
 966 #else
 967                         contentSuffix += toString("\"$RYZOM_CLIENT\" %s \"$LOGIN\" \"$PASSWORD\" \"$SHARDID\" &\n", additionalParams.c_str());
 968 #endif
 969                 }
 970 #endif
 971
 972                 // append content of script
 973                 fputs(contentPrefix.c_str(), fp);
 974                 fputs(content.c_str(), fp);
 975                 fputs(contentSuffix.c_str(), fp);
 976
 977                 bool writeError = ferror(fp) != 0;
 978                 bool diskFull = ferror(fp) && errno == 28 /* ENOSPC */;
 979                 fclose(fp);
 980                 if (diskFull)
 981                 {
 982                         throw NLMISC::EDiskFullError(batchFilename.c_str());
 983                 }
 984                 if (writeError)
 985                 {
 986                         throw NLMISC::EWriteError(batchFilename.c_str());
 987                 }
 988         }
 989 }
 990
 991 // ****************************************************************************
 992 void CPatchManager::executeBatchFile()
 993 {
 994         // normal quit
 995         extern void quitCrashReport ();
 996         quitCrashReport ();
 997
 998         bool r2Mode = false;
 999
1000 #ifndef RY_BG_DOWNLOADER
1001         r2Mode = ClientCfg.R2Mode;
1002 #endif
1003
1004         std::string batchFilename;
1005
1006         std::vector<std::string> arguments;
1007
1008         std::string startupPath = Args.getStartupPath();
1009
1010         // 3 first parameters are Ryzom client full path, patch directory full path and client root directory full path
1011 #ifdef NL_OS_WINDOWS
1012         batchFilename = CPath::standardizeDosPath(ClientRootPath);
1013
1014         arguments.push_back(CPath::standardizeDosPath(RyzomFilename));
1015         arguments.push_back(CPath::standardizeDosPath(ClientPatchPath));
1016         arguments.push_back(CPath::standardizeDosPath(ClientRootPath));
1017         arguments.push_back(CPath::standardizeDosPath(startupPath));
1018 #else
1019         batchFilename = ClientRootPath;
1020
1021         arguments.push_back(RyzomFilename);
1022         arguments.push_back(ClientPatchPath);
1023         arguments.push_back(ClientRootPath);
1024         arguments.push_back(startupPath);
1025 #endif
1026
1027         // log parameters passed to Ryzom client
1028         nlinfo("Restarting Ryzom...");
1029         nlinfo("RyzomFilename = %s", RyzomFilename.c_str());
1030         nlinfo("ClientPatchPath = %s", ClientPatchPath.c_str());
1031         nlinfo("ClientRootPath = %s", ClientRootPath.c_str());
1032         nlinfo("StartupPath = %s", startupPath.c_str());
1033
1034         batchFilename += UpdateBatchFilename;
1035
1036         // make script executable
1037         CFile::setRWAccess(batchFilename);
1038         CFile::setExecutable(batchFilename);
1039
1040         // append login, password and shard
1041         if (!LoginLogin.empty())
1042         {
1043                 arguments.push_back(LoginLogin);
1044
1045                 if (!LoginPassword.empty())
1046                 {
1047                         // encode password in hexadecimal to avoid invalid characters on command-line
1048                         arguments.push_back("0x" + toHexa(LoginPassword));
1049
1050                         if (!r2Mode)
1051                         {
1052                                 arguments.push_back(toString(LoginShardId));
1053                         }
1054                 }
1055         }
1056
1057         // launchProgram with array of strings as argument will escape arguments with spaces
1058         if (!launchProgramArray(batchFilename, arguments, false))
1059         {
1060                 // error occurs during the launch
1061                 string str = toString("Can't execute '%s': code=%d %s (error code 30)", batchFilename.c_str(), errno, strerror(errno));
1062                 throw Exception (str);
1063         }
1064 }
1065
1066 // ****************************************************************************
1067 void CPatchManager::reboot()
1068 {
1069         onFileInstallFinished(); //In install program wait for the player to select in the gui of the install program if we want to Launch Ryzom or not
1070         createBatchFile(DescFile, _StartRyzomAtEnd);
1071         executeBatchFile();
1072 }
1073
1074
1075 // ****************************************************************************
1076 int CPatchManager::getTotalFilesToGet()
1077 {
1078         if (CheckThread != NULL)
1079                 return CheckThread->TotalFileToCheck;
1080
1081         if (PatchThread != NULL)
1082                 return PatchThread->getNbFileToPatch();
1083
1084         if (ScanDataThread != NULL)
1085                 return ScanDataThread->TotalFileToScan;
1086
1087         return 1;
1088 }
1089
1090 // ****************************************************************************
1091 int CPatchManager::getCurrentFilesToGet()
1092 {
1093         if (CheckThread != NULL)
1094                 return CheckThread->CurrentFileChecked;
1095
1096         if (PatchThread != NULL)
1097                 return PatchThread->getCurrentFilePatched();
1098
1099         if (ScanDataThread != NULL)
1100                 return ScanDataThread->CurrentFileScanned;
1101
1102         return 1;
1103 }
1104
1105 // ****************************************************************************
1106 int CPatchManager::getPatchingSize()
1107 {
1108         if (PatchThread != NULL)
1109                 return PatchThread->getPatchingSize();
1110         return 0;
1111 }
1112
1113 // ****************************************************************************
1114 float CPatchManager::getCurrentFileProgress() const
1115 {
1116         if (PatchThread != NULL)
1117                 return PatchThread->getCurrentFileProgress();
1118         return 0.f;
1119 }
1120
1121 // ****************************************************************************
1122 void CPatchManager::setRWAccess (const string &filename, bool bThrowException)
1123 {
1124         string s = CI18N::get("uiSetAttrib") + " " + CFile::getFilename(filename);
1125         setState(true, s);
1126
1127         if (!NLMISC::CFile::setRWAccess(filename) && bThrowException)
1128         {
1129                 s = CI18N::get("uiAttribErr") + " " + CFile::getFilename(filename) + " (" + toString(errno) + "," + strerror(errno) + ")";
1130                 setState(true, s);
1131                 throw Exception (s);
1132         }
1133 }
1134
1135 // ****************************************************************************
1136 string CPatchManager::deleteFile (const string &filename, bool bThrowException, bool bWarning)
1137 {
1138         string s = CI18N::get("uiDelFile") + " " + CFile::getFilename(filename);
1139         setState(true, s);
1140
1141         if (!NLMISC::CFile::fileExists(filename))
1142         {
1143                 s = CI18N::get("uiDelNoFile");
1144                 setState(true, s);
1145                 return s;
1146         }
1147
1148         if (!NLMISC::CFile::deleteFile(filename))
1149         {
1150                 s = CI18N::get("uiDelErr") + " " + CFile::getFilename(filename) + " (" + toString(errno) + "," + strerror(errno) + ")";
1151                 if(bWarning)
1152                         setState(true, s);
1153                 if(bThrowException)
1154                         throw Exception (s);
1155                 return s;
1156         }
1157         return "";
1158 }
1159
1160 // ****************************************************************************
1161 void CPatchManager::renameFile (const string &src, const string &dst)
1162 {
1163         string s = CI18N::get("uiRenameFile") + " " + NLMISC::CFile::getFilename(src);
1164         setState(true, s);
1165
1166         if (!NLMISC::CFile::moveFile(dst, src))
1167         {
1168                 s = CI18N::get("uiRenameErr") + " " + src + " -> " + dst + " (" + toString(errno) + "," + strerror(errno) + ")";
1169                 setState(true, s);
1170                 throw Exception (s);
1171         }
1172 }
1173
1174 // ****************************************************************************
1175 // Take care this function is called by the thread
1176 void CPatchManager::setState (bool bOutputToLog, const string &ucsNewState)
1177 {
1178         {
1179                 CSynchronized<CState>::CAccessor as(&State);
1180                 CState  &rState= as.value();
1181                 rState.State= ucsNewState;
1182                 if(bOutputToLog)
1183                         rState.StateLog.push_back(ucsNewState);
1184                 rState.StateChanged= true;
1185         }
1186         if (_StateListener)
1187         {
1188                 _StateListener->setState(bOutputToLog, ucsNewState);
1189         }
1190 }
1191
1192 // ****************************************************************************
1193 void CPatchManager::touchState ()
1194 {
1195         {
1196                 CSynchronized<CState>::CAccessor as(&State);
1197                 as.value().StateChanged= true;
1198         }
1199 }
1200
1201 // ****************************************************************************
1202 string CPatchManager::getClientVersion()
1203 {
1204         if (!ValidDescFile)
1205                 return "";
1206
1207         return toString(DescFile.getFiles().getVersionNumber());
1208 }
1209
1210 // ****************************************************************************
1211 void CPatchManager::readDescFile(sint32 nVersion)
1212 {
1213         DescFilename = toString("ryzom_%05d.idx", nVersion);
1214         string srcName = ClientPatchPath + DescFilename;
1215         DescFile.clear();
1216         if (!DescFile.load(srcName))
1217                 throw Exception ("Can't open file '%s'", srcName.c_str ());
1218
1219         uint cat;
1220
1221         if (ClientRootPath != "./")
1222         {
1223                 // fix relative paths
1224                 for (cat = 0; cat < DescFile.getCategories().categoryCount(); ++cat)
1225                 {
1226                         CBNPCategory &category = const_cast<CBNPCategory &>(DescFile.getCategories().getCategory(cat));
1227
1228                         std::string unpackTo = category.getUnpackTo();
1229
1230                         if (unpackTo.substr(0, 1) == ".")
1231                         {
1232                                 unpackTo = CPath::makePathAbsolute(unpackTo, ClientRootPath, true);
1233                                 category.setUnpackTo(unpackTo);
1234                         }
1235                 }
1236         }
1237
1238         // patch category for current platform
1239         std::string platformPatchCategory;
1240
1241 #if defined(NL_OS_WIN64)
1242         platformPatchCategory = "main_exedll_win64";
1243 #elif defined(NL_OS_WINDOWS)
1244         platformPatchCategory = "main_exedll_win32";
1245 #elif defined(NL_OS_MAC)
1246         platformPatchCategory = "main_exedll_osx";
1247 #elif defined(NL_OS_UNIX) && defined(_LP64)
1248         platformPatchCategory = "main_exedll_linux64";
1249 #else
1250         platformPatchCategory = "main_exedll_linux32";
1251 #endif
1252
1253         // check if we are using main_exedll or specific main_exedll_* for platform
1254         bool foundPlatformPatchCategory = false;
1255
1256         for (cat = 0; cat < DescFile.getCategories().categoryCount(); ++cat)
1257         {
1258                 CBNPCategory &category = const_cast<CBNPCategory &>(DescFile.getCategories().getCategory(cat));
1259
1260                 if (category.getName() == platformPatchCategory)
1261                 {
1262                         foundPlatformPatchCategory = true;
1263                         break;
1264                 }
1265         }
1266
1267         if (foundPlatformPatchCategory)
1268         {
1269                 std::set<std::string> forceRemovePatchCategories;
1270
1271                 // only download binaries for current platform
1272                 forceRemovePatchCategories.insert("main_exedll");
1273                 forceRemovePatchCategories.insert("main_exedll_win32");
1274                 forceRemovePatchCategories.insert("main_exedll_win64");
1275                 forceRemovePatchCategories.insert("main_exedll_linux32");
1276                 forceRemovePatchCategories.insert("main_exedll_linux64");
1277                 forceRemovePatchCategories.insert("main_exedll_osx");
1278
1279                 // remove current platform category from remove list
1280                 forceRemovePatchCategories.erase(platformPatchCategory);
1281
1282                 CBNPFileSet &bnpFS = const_cast<CBNPFileSet &>(DescFile.getFiles());
1283
1284                 for (cat = 0; cat < DescFile.getCategories().categoryCount();)
1285                 {
1286                         const CBNPCategory &bnpCat = DescFile.getCategories().getCategory(cat);
1287
1288                         if (std::find(forceRemovePatchCategories.begin(), forceRemovePatchCategories.end(),
1289                                 bnpCat.getName()) != forceRemovePatchCategories.end())
1290                         {
1291                                 for (uint file = 0; file < bnpCat.fileCount(); ++file)
1292                                 {
1293                                         std::string fileName = bnpCat.getFile(file);
1294                                         bnpFS.removeFile(fileName);
1295                                 }
1296                                 const_cast<CBNPCategorySet &>(DescFile.getCategories()).deleteCategory(cat);
1297                         }
1298                         else
1299                         {
1300                                 ++cat;
1301                         }
1302                 }
1303         }
1304 }
1305
1306 // ****************************************************************************
1307 void CPatchManager::getServerFile (const std::string &name, bool bZipped, const std::string& specifyDestName, NLMISC::IProgressCallback *progress)
1308 {
1309         string srcName = name;
1310         if (bZipped) srcName += ".ngz";
1311
1312         string dstName;
1313         if (specifyDestName.empty())
1314         {
1315                 dstName = ClientPatchPath + NLMISC::CFile::getFilename(name);
1316         }
1317         else
1318         {
1319                 dstName = specifyDestName;
1320         }
1321         if (bZipped) dstName += ".ngz";
1322
1323         bool    downloadSuccess = false;
1324
1325         while (!downloadSuccess)
1326         {
1327                 std::string     serverPath;
1328                 std::string     serverDisplayPath;
1329
1330                 if (UsedServer >= 0 && !PatchServers.empty())
1331                 {
1332                         // first use main patch servers
1333                         serverPath = PatchServers[UsedServer].ServerPath;
1334                         serverDisplayPath = PatchServers[UsedServer].DisplayedServerPath;
1335                 }
1336                 else
1337                 {
1338                         // else use alternative emergency patch server
1339                         serverPath = ServerPath;
1340                         serverDisplayPath = DisplayedServerPath;
1341                         UsedServer = -1;
1342                 }
1343
1344                 try
1345                 {
1346                         string s = CI18N::get("uiLoginGetFile") + " " + NLMISC::CFile::getFilename(srcName);
1347                         setState(true, s);
1348
1349                         // get the new file
1350                         downloadFile (serverPath+srcName, dstName, progress);
1351
1352                         downloadSuccess = true;
1353                 }
1354                 catch (const EPatchDownloadException& e)
1355                 {
1356                         //nlwarning("EXCEPTION CATCH: getServerFile() failed - try to find an alternative: %i: %s",UsedServer,PatchServers[UsedServer].DisplayedServerPath.c_str());
1357
1358                         nlwarning("EXCEPTION CATCH: getServerFile() failed - try to find an alternative :");
1359                         nlwarning("%i", UsedServer);
1360                         if (UsedServer >= 0 && UsedServer < (int) PatchServers.size())
1361                         {
1362                                 nlwarning("%s", PatchServers[UsedServer].DisplayedServerPath.c_str());
1363                         }
1364
1365                         // if emergency patch server, this is a real issue, rethrow exception
1366                         if (UsedServer < 0)
1367                         {
1368                                 string s = CI18N::get("uiDLFailed");
1369                                 setState(true, s);
1370
1371                                 throw Exception(e.what());
1372                         }
1373
1374                         string s = CI18N::get("uiDLURIFailed") + " " + serverDisplayPath;
1375                         setState(true, s);
1376
1377                         // this server is unavailable
1378                         PatchServers[UsedServer].Available = false;
1379
1380                         sint    nextServer = (UsedServer+1) % PatchServers.size();
1381
1382                         while (nextServer != UsedServer && !PatchServers[nextServer].Available)
1383                                 nextServer = (nextServer+1) % PatchServers.size();
1384
1385                         // scanned all servers? use alternative
1386                         if (nextServer == UsedServer)
1387                         {
1388                                 string s = CI18N::get("uiNoMoreURI");
1389                                 setState(true, s);
1390                                 UsedServer = -1;
1391                                 nlwarning("EXCEPTION CATCH: getServerFile() failed - no alternative found");
1392                         }
1393                         else
1394                         {
1395                                 UsedServer = nextServer;
1396                                 nlwarning("EXCEPTION CATCH: getServerFile() failed - trying server: %i: %s",UsedServer,PatchServers[UsedServer].DisplayedServerPath.c_str());
1397                         }
1398                 }
1399         }
1400
1401         // decompress it
1402         if (bZipped)
1403                 decompressFile (dstName);
1404 }
1405
1406 // ****************************************************************************
1407 void CPatchManager::downloadFileWithCurl (const string &source, const string &dest, NLMISC::IProgressCallback *progress)
1408 {
1409         DownloadInProgress = true;
1410         try
1411         {
1412 #ifdef USE_CURL
1413                 string s = CI18N::get("uiDLWithCurl") + " " + CFile::getFilename(dest);
1414                 setState(true, s);
1415
1416                 // user agent = nel_launcher
1417
1418                 CURL *curl;
1419                 CURLcode res;
1420
1421                 string sTranslate = CI18N::get("uiLoginGetFile") + " " + NLMISC::CFile::getFilename (source);
1422                 setState(true, sTranslate);
1423                 CurrentFile = NLMISC::CFile::getFilename (source);
1424
1425                 curl_global_init(CURL_GLOBAL_ALL);
1426                 curl = curl_easy_init();
1427                 if(curl == NULL)
1428                 {
1429                         // file not found, delete local file
1430                         throw Exception ("curl init failed");
1431                 }
1432
1433                 curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0);
1434                 curl_easy_setopt(curl, CURLOPT_PROGRESSFUNCTION, downloadProgressFunc);
1435                 curl_easy_setopt(curl, CURLOPT_PROGRESSDATA, (void *) progress);
1436                 curl_easy_setopt(curl, CURLOPT_URL, source.c_str());
1437                 if (source.length() > 8 && (source[4] == 's' || source[4] == 'S')) // 01234 https
1438                 {
1439                         NLWEB::CCurlCertificates::addCertificateFile("cacert.pem");
1440                         NLWEB::CCurlCertificates::useCertificates(curl);
1441                         curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L);
1442                         curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 2L);
1443                 }
1444
1445                 // create the local file
1446                 if (NLMISC::CFile::fileExists(dest))
1447                 {
1448                         setRWAccess(dest, false);
1449                         NLMISC::CFile::deleteFile(dest.c_str());
1450                 }
1451
1452                 FILE *fp = nlfopen (dest, "wb");
1453
1454                 if (fp == NULL)
1455                 {
1456                         curl_easy_setopt(curl, CURLOPT_PROGRESSDATA, NULL);
1457                         throw Exception ("Can't open file '%s' for writing: code=%d %s (error code 37)", dest.c_str (), errno, strerror(errno));
1458                 }
1459
1460                 curl_easy_setopt(curl, CURLOPT_WRITEDATA, fp);
1461                 curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, fwrite);
1462
1463                 //CurrentFilesToGet++;
1464
1465                 res = curl_easy_perform(curl);
1466
1467                 curl_easy_setopt(curl, CURLOPT_PROGRESSDATA, NULL);
1468
1469                 long r;
1470                 curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &r);
1471
1472                 curl_easy_cleanup(curl);
1473
1474                 bool diskFull = ferror(fp) && errno == 28 /*ENOSPC*/;
1475
1476                 fclose(fp);
1477                 curl_global_cleanup();
1478
1479                 CurrentFile.clear();
1480
1481                 if (diskFull)
1482                 {
1483                         NLMISC::CFile::deleteFile(dest.c_str());
1484                         throw NLMISC::EDiskFullError(dest);
1485                 }
1486
1487                 if(CURLE_WRITE_ERROR == res)
1488                 {
1489                         // file not found, delete local file
1490                         NLMISC::CFile::deleteFile(dest.c_str());
1491                         throw NLMISC::EWriteError(dest);
1492                 }
1493
1494                 if(CURLE_FTP_COULDNT_RETR_FILE == res)
1495                 {
1496                         // file not found, delete local file
1497                         NLMISC::CFile::deleteFile(dest.c_str());
1498                         throw EPatchDownloadException (NLMISC::toString("curl download failed: (ec %d %d)", res, r));
1499                 }
1500
1501                 if(CURLE_OK != res)
1502                 {
1503                         NLMISC::CFile::deleteFile(dest.c_str());
1504                         throw EPatchDownloadException (NLMISC::toString("curl download failed: (ec %d %d)", res, r));
1505                 }
1506
1507                 if(r == 404)
1508                 {
1509                         // file not found, delete it
1510                         NLMISC::CFile::deleteFile(dest.c_str());
1511                         throw EPatchDownloadException (NLMISC::toString("curl download failed: (ec %d %d)", res, r));
1512                 }
1513
1514                 if(r < 200 || r >= 300)
1515                 {
1516                         // file not found, delete it
1517                         NLMISC::CFile::deleteFile(dest.c_str());
1518                         throw EPatchDownloadException (NLMISC::toString("curl download failed: (ec %d %d)", res, r));
1519                 }
1520
1521 #else
1522                 throw Exception("USE_CURL is not defined, no curl method");
1523 #endif
1524         }
1525         catch(...)
1526         {
1527                 DownloadInProgress = false;
1528                 throw;
1529         }
1530         if (progress)
1531         {
1532                 // set progress to 1
1533                 validateProgress((void *) progress, 1, 1, 0, 0);
1534         }
1535         DownloadInProgress = false;
1536 }
1537
1538 // ****************************************************************************
1539 void CPatchManager::downloadFile (const string &source, const string &dest, NLMISC::IProgressCallback *progress)
1540 {
1541         // For the moment use only curl
1542         const string sourceLower = toLowerAscii(source.substr(0, 6));
1543
1544         if (startsWith(sourceLower, "http:")
1545                 || startsWith(sourceLower, "https:")
1546                 || startsWith(sourceLower, "ftp:")
1547                 || startsWith(sourceLower, "file:"))
1548         {
1549                 nldebug("Download patch file %s", source.c_str());
1550                 downloadFileWithCurl(source, dest, progress);
1551         }
1552         else
1553         {
1554                 if (!NLMISC::CFile::copyFile(dest, source, false, progress))
1555                 {
1556                         if (errno == 28)
1557                         {
1558                                 throw NLMISC::EDiskFullError(dest);
1559                         }
1560                         throw Exception ("cannot copy file %s to %s", source.c_str(), dest.c_str());
1561                 }
1562         }
1563 }
1564
1565 // ****************************************************************************
1566 // TODO : Review this uncompress routine to uncompress in a temp file before overwriting destination file
1567
1568 void CPatchManager::decompressFile (const string &filename)
1569 {
1570         string sTranslate = CI18N::get("uiDecompressing") + " " + NLMISC::CFile::getFilename(filename);
1571         setState(true, sTranslate);
1572
1573         //if(isVerboseLog()) nlinfo("Calling gzopen('%s','rb')", filename.c_str());
1574         gzFile gz = gzopen (filename.c_str (), "rb");
1575         if (gz == NULL)
1576         {
1577                 string err = toString("Can't open compressed file '%s' : ", filename.c_str());
1578                 if(errno == 0)
1579                 {
1580                         // gzerror
1581                         int gzerrno;
1582                         const char *gzerr = gzerror (gz, &gzerrno);
1583                         err += toString("code=%d %s", gzerrno, gzerr);
1584                 }
1585                 else
1586                 {
1587                         err += toString("code=%d %s", errno, strerror (errno));
1588                 }
1589                 err += " (error code 31)";
1590                 deleteFile (filename);
1591                 throw Exception (err);
1592         }
1593
1594         string dest = filename.substr(0, filename.size ()-4);
1595         setRWAccess(dest, false);
1596         //if(isVerboseLog()) nlinfo("Calling nlfopen('%s','wb')", dest.c_str());
1597         FILE *fp = nlfopen (dest, "wb");
1598         if (fp == NULL)
1599         {
1600                 string err = toString("Can't open file '%s' : code=%d %s, (error code 32)", dest.c_str(), errno, strerror(errno));
1601
1602                 gzclose(gz);
1603                 deleteFile (filename);
1604                 throw Exception (err);
1605         }
1606
1607         //if(isVerboseLog()) nlinfo("Entering the while loop decompression");
1608
1609         uint32 currentSize = 0;
1610         uint8 buffer[10000];
1611         while (!gzeof(gz))
1612         {
1613                 //if(isVerboseLog()) nlinfo("Calling gzread");
1614                 int res = gzread (gz, buffer, 10000);
1615                 //if(isVerboseLog()) nlinfo("gzread returns %d", res);
1616                 if (res == -1)
1617                 {
1618                         int gzerrno;
1619                         const char *gzerr = gzerror (gz, &gzerrno);
1620                         gzclose(gz);
1621                         fclose(fp);
1622                         //deleteFile (filename);
1623                         throw Exception ("Can't read compressed file '%s' (after %d bytes) : code=%d %s, (error code 33)", filename.c_str(), currentSize, gzerrno, gzerr);
1624                 }
1625
1626                 currentSize += res;
1627
1628                 //if(isVerboseLog()) nlinfo("Calling fwrite for %d bytes", res);
1629                 int res2 = (int)fwrite (buffer, 1, res, fp);
1630                 //if(isVerboseLog()) nlinfo("fwrite returns %d", res2);
1631                 if (res2 != res)
1632                 {
1633                         bool diskFull = (errno == 28 /* ENOSPC */);
1634                         string err = toString("Can't write file '%s' : code=%d %s (error code 34)", dest.c_str(), errno, strerror(errno));
1635
1636                         gzclose(gz);
1637                         fclose(fp);
1638                         deleteFile (filename);
1639                         if (diskFull)
1640                         {
1641                                 throw NLMISC::EDiskFullError(err);
1642                         }
1643                         else
1644                         {
1645                                 throw Exception (err);
1646                         }
1647                 }
1648         }
1649
1650         //if(isVerboseLog()) nlinfo("Exiting the while loop decompression");
1651
1652         //if(isVerboseLog()) nlinfo("Calling gzclose");
1653         gzclose(gz);
1654         //if(isVerboseLog()) nlinfo("Calling fclose");
1655         fclose(fp);
1656         deleteFile(filename);
1657
1658         //if(isVerboseLog()) nlinfo("Exiting the decompressing file");
1659 }
1660
1661 // ****************************************************************************
1662 void CPatchManager::applyDate (const string &sFilename, uint32 nDate)
1663 {
1664         // change the file time
1665         if(nDate != 0)
1666         {
1667                 setRWAccess(sFilename, false);
1668                 string s = CI18N::get("uiChangeDate") + " " + NLMISC::CFile::getFilename(sFilename) + " " + timestampToHumanReadable(NLMISC::CFile::getFileModificationDate (sFilename)) +
1669                                                 " -> " + timestampToHumanReadable(nDate);
1670                 setState(true,s);
1671
1672                 if (!NLMISC::CFile::setFileModificationDate(sFilename, nDate))
1673                 {
1674                         int err = NLMISC::getLastError();
1675                         s = CI18N::get("uiChgDateErr") + " " + CFile::getFilename(sFilename) + " (" + toString(err) + ", " + formatErrorMessage(err) + ")";
1676                         setState(true,s);
1677                 }
1678                 s = CI18N::get("uiNowDate") + " " + CFile::getFilename(sFilename) + " " + timestampToHumanReadable(NLMISC::CFile::getFileModificationDate (sFilename));
1679                 setState(true,s);
1680         }
1681 }
1682
1683 // ****************************************************************************
1684 // Get all the patches that need to be applied to a file from the description of this file given by the server
1685 void CPatchManager::getPatchFromDesc(SFileToPatch &ftpOut, const CBNPFile &fIn, bool forceCheckSumTest)
1686 {
1687         uint32 j;
1688         const CBNPFile rFile = fIn;
1689         const string &rFilename = rFile.getFileName();
1690         string sFilePath;
1691         bool inPatchDir = false;
1692         // first see if there's a version that was downloaded from the background downloader
1693         if (NLMISC::CFile::fileExists(ClientPatchPath + rFilename + ".tmp"))
1694         {
1695                 sFilePath = ClientPatchPath + rFilename + ".tmp";
1696                 ftpOut.SrcFileName = sFilePath;
1697                 inPatchDir = true;
1698         }
1699
1700         bool needUnpack = false;
1701         const CBNPCategory *cat = DescFile.getCategories().getCategoryFromFile(rFilename);
1702         if (cat)
1703         {
1704                 needUnpack = !cat->getUnpackTo().empty();
1705         }
1706         else
1707         {
1708                 nlwarning("Can't find file category for %s:", rFilename.c_str());
1709         }
1710
1711         // Does the BNP exists ?
1712         // following lines added by Sadge to ensure that the correct file is patched
1713         // Only look in data path if the file should not be unpack (otherwise it should only remains in the "unpack" directory)
1714         if (!needUnpack)
1715         {
1716                 if (sFilePath.empty())
1717                 {
1718                         if (NLMISC::CFile::fileExists(WritableClientDataPath + rFilename))
1719                         {
1720                                 // if file exists in writable directory, use it
1721                                 sFilePath = WritableClientDataPath + rFilename;
1722                         }
1723                         else if (NLMISC::CFile::fileExists(ReadableClientDataPath + rFilename))
1724                         {
1725                                 // if file exists in readable directory, use it
1726                                 sFilePath = ReadableClientDataPath + rFilename;
1727                         }
1728                 }
1729         }
1730
1731         if (sFilePath.empty() && NLMISC::CFile::fileExists(ClientPatchPath + rFilename))
1732         {
1733                 sFilePath = ClientPatchPath + rFilename;
1734         }
1735
1736 // following lines removed by Sadge to ensure that the correct file is patched
1737 //      string sFilePath = CPath::lookup(rFilename, false, false);
1738 //      if (sFilePath.empty())
1739 //      {
1740 //              if (NLMISC::CFile::fileExists(ClientPatchPath + rFilename))
1741 //                      sFilePath = ClientPatchPath + rFilename;
1742 //      }
1743
1744         // if file not found anywhere
1745         if (sFilePath.empty())
1746         {
1747                 ftpOut.FileName = rFilename;
1748                 ftpOut.LocalFileToDelete = false;
1749                 ftpOut.LocalFileExists = false;
1750                 // It happens some time (maybe a bug) that the versionCount is 0... =>
1751                 // it happens if the BNP file is empty (8 bytes)
1752                 ftpOut.FinalFileSize = EmptyBnpFileSize;
1753                 // BNP does not exists : get all the patches version
1754                 for (j = 0; j < rFile.versionCount(); ++j)
1755                 {
1756                         ftpOut.Patches.push_back(rFile.getVersion(j).getVersionNumber());
1757                         ftpOut.PatcheSizes.push_back(rFile.getVersion(j).getPatchSize());
1758                         ftpOut.LastFileDate = rFile.getVersion(j).getTimeStamp();
1759                         ftpOut.FinalFileSize = rFile.getVersion(j).getFileSize();
1760                         ftpOut.SZFileSize = rFile.getVersion(j).get7ZFileSize();
1761                 }
1762         }
1763         else
1764         {
1765                 // The local BNP file exists : find its version
1766                 uint32 nLocalSize = NLMISC::CFile::getFileSize(sFilePath);
1767                 uint32 nLocalTime = NLMISC::CFile::getFileModificationDate(sFilePath);
1768                 // From the couple time, size look the version of the file
1769                 uint32 nVersionFound = 0xFFFFFFFF;
1770                 // If forceChecksum is wanted (slow), then don't do the test with filesize/date
1771                 if(!forceCheckSumTest)
1772                 {
1773                         for (j = 0; j < rFile.versionCount(); ++j)
1774                         {
1775                                 const CBNPFileVersion &rVersion = rFile.getVersion(j);
1776                                 uint32 nServerSize = rVersion.getFileSize();
1777                                 uint32 nServerTime = rVersion.getTimeStamp();
1778                                 // Does the time and size match a version ?
1779                                 if ((nServerSize == nLocalSize) && (abs((sint32)(nServerTime - nLocalTime)) <= 2) )
1780                                 {
1781                                         nVersionFound = rVersion.getVersionNumber();
1782                                         // break; // ace -> get the last good version (if more than one version of the same file exists)
1783                                 }
1784                         }
1785                 }
1786
1787                 // If the version cannot be found with size and time try with sha1
1788                 if (nVersionFound == 0xFFFFFFFF)
1789                 {
1790                         string sTranslate = CI18N::get("uiCheckInt") + " " + rFilename;
1791                         setState(true, sTranslate);
1792                         CHashKey hkLocalSHA1 = getSHA1(sFilePath);
1793                         for (j = 0; j < rFile.versionCount(); ++j)
1794                         {
1795                                 const CBNPFileVersion &rVersion = rFile.getVersion(j);
1796                                 CHashKey hkServerSHA1 = rVersion.getHashKey();
1797                                 // Does the sha1 match a version ?
1798                                 if (hkServerSHA1 == hkLocalSHA1)
1799                                 {
1800                                         nVersionFound = rVersion.getVersionNumber();
1801                                         applyDate(sFilePath, rVersion.getTimeStamp());
1802                                         // break; // ace -> same as above
1803                                 }
1804                         }
1805                 }
1806
1807                 // No version available found
1808                 if (nVersionFound == 0xFFFFFFFF)
1809                 {
1810                         string sTranslate = CI18N::get("uiNoVersionFound");
1811                         setState(true, sTranslate);
1812                         // Get all patches from beginning (first patch is reference file)
1813                         ftpOut.FileName = rFilename;
1814                         ftpOut.LocalFileToDelete = true;
1815                         ftpOut.LocalFileExists = !inPatchDir;
1816                         // It happens some time (maybe a bug) that the versionCount is 0... =>
1817                         // it happens if the BNP file is empty (8 bytes)
1818                         ftpOut.FinalFileSize = EmptyBnpFileSize;
1819                         // Get all the patches version
1820                         for (j = 0; j < rFile.versionCount(); ++j)
1821                         {
1822                                 ftpOut.Patches.push_back(rFile.getVersion(j).getVersionNumber());
1823                                 ftpOut.PatcheSizes.push_back(rFile.getVersion(j).getPatchSize());
1824                                 ftpOut.LastFileDate = rFile.getVersion(j).getTimeStamp();
1825                                 ftpOut.FinalFileSize = rFile.getVersion(j).getFileSize();
1826                                 ftpOut.SZFileSize = rFile.getVersion(j).get7ZFileSize();
1827                         }
1828                 }
1829                 else // A version of the file has been found
1830                 {
1831                         string sTranslate = CI18N::get("uiVersionFound") + " " + toString(nVersionFound);
1832                         setState(true, sTranslate);
1833                         // Get All patches from this version !
1834                         ftpOut.FileName = rFilename;
1835                         ftpOut.LocalFileToDelete = false;
1836                         ftpOut.LocalFileExists = !inPatchDir;
1837                         // Go to the version
1838                         for (j = 0; j < rFile.versionCount(); ++j)
1839                                 if (rFile.getVersion(j).getVersionNumber() == nVersionFound)
1840                                         break;
1841
1842                         nlassert(j != rFile.versionCount()); // Not normal if we cant find the version we found previously
1843
1844                         // Point on the next version
1845                         j++;
1846                         // If there are newer versions
1847                         if (j != rFile.versionCount())
1848                         {
1849                                 // Add all version until the last one
1850                                 for (; j < rFile.versionCount(); ++j)
1851                                 {
1852                                         ftpOut.Patches.push_back(rFile.getVersion(j).getVersionNumber());
1853                                         ftpOut.PatcheSizes.push_back(rFile.getVersion(j).getPatchSize());
1854                                         ftpOut.LastFileDate = rFile.getVersion(j).getTimeStamp();
1855                                         ftpOut.SZFileSize = rFile.getVersion(j).get7ZFileSize();
1856                                 }
1857                         }
1858                         // Else this file is up to date !
1859
1860                         // For info, get its final file size
1861                         ftpOut.FinalFileSize= rFile.getVersion(rFile.versionCount()-1).getFileSize();
1862                 }
1863         } // end of else local BNP file exists
1864 }
1865
1866 // ****************************************************************************
1867 bool CPatchManager::bnpUnpack(const string &srcBigfile, const string &dstPath, vector<string> &vFilenames)
1868 {
1869         nldebug("bnpUnpack: srcBigfile=%s", srcBigfile.c_str());
1870         string SourceName, DestPath;
1871
1872         // following lines added by Sadge to ensure that the correct file gets patched
1873 //      if              (NLMISC::CFile::fileExists(ClientDataPath + srcBigfile))        SourceName = ClientDataPath + srcBigfile;
1874 //      else if (NLMISC::CFile::fileExists(srcBigfile))                                         SourceName = ClientDataPath + srcBigfile;
1875         SourceName= srcBigfile;
1876
1877 // following lines removed by Sadge to ensure that the correct file gets patched
1878 //      SourceName = CPath::lookup(srcBigfile, false, false);
1879 //      if (SourceName.empty())
1880 //              SourceName = ClientPatchPath + srcBigfile;
1881
1882         if (dstPath.empty())
1883                 DestPath = ClientRootPath;
1884         else
1885                 DestPath = CPath::standardizePath (dstPath);
1886
1887         string s = CI18N::get("uiUnpack") + " " + NLMISC::CFile::getFilename(SourceName);
1888         setState(true,s);
1889
1890         // Read Header of the BNP File
1891         CBigFile::BNP bnpFile;
1892         bnpFile.BigFileName = SourceName;
1893
1894         if (!bnpFile.readHeader())
1895         {
1896                 string s = CI18N::get("uiUnpackErrHead") + " " + CFile::getFilename(SourceName);
1897                 setState(true,s);
1898                 return false;
1899         }
1900
1901         // Unpack
1902         if (!bnpFile.unpack(DestPath))
1903                 return false;
1904
1905         // Return names
1906         {
1907                 vFilenames.clear();
1908                 for (uint32 i = 0; i < bnpFile.SFiles.size(); ++i)
1909                         vFilenames.push_back(bnpFile.SFiles[i].Name);
1910         }
1911
1912         return true;
1913 }
1914
1915
1916 // ****************************************************************************
1917 int CPatchManager::downloadProgressFunc(void *foo, double t, double d, double ultotal, double ulnow)
1918 {
1919         if (d != t)
1920         {
1921                 // In the case of progress = 1, don't update because, this will be called in case of error to signal the end of the download, though
1922                 // no download actually occurred. Instead, we set progress to 1.f at the end of downloadWithCurl if everything went fine
1923                 return validateProgress(foo, t, d, ultotal, ulnow);
1924         }
1925         return 0;
1926 }
1927
1928 // ****************************************************************************
1929 int CPatchManager::validateProgress(void *foo, double t, double d, double /* ultotal */, double /* ulnow */)
1930 {
1931         static std::vector<std::string> units;
1932
1933         if (units.empty())
1934         {
1935                 units.push_back(CI18N::get("uiByte"));
1936                 units.push_back(CI18N::get("uiKb"));
1937                 units.push_back(CI18N::get("uiMb"));
1938         }
1939
1940         CPatchManager *pPM = CPatchManager::getInstance();
1941         double pour1 = t!=0.0?d*100.0/t:0.0;
1942         string sTranslate = CI18N::get("uiLoginGetFile") + toString(" %s : %s / %s (%.02f %%)", NLMISC::CFile::getFilename(pPM->CurrentFile).c_str(),
1943                 NLMISC::bytesToHumanReadableUnits((uint64)d, units).c_str(), NLMISC::bytesToHumanReadableUnits((uint64)t, units).c_str(), pour1);
1944         pPM->setState(false, sTranslate);
1945         if (foo)
1946         {
1947                 ((NLMISC::IProgressCallback *) foo)->progress((float) (t != 0 ? d / t : 0));
1948         }
1949         return 0;
1950 }
1951
1952 // ****************************************************************************
1953 void CPatchManager::MyPatchingCB::progress(float f)
1954 {
1955         CPatchManager *pPM = CPatchManager::getInstance();
1956         double p = 100.0*f;
1957         string sTranslate = CI18N::get("uiApplyingDelta") + toString(" %s (%.02f %%)", CFile::getFilename(patchFilename).c_str(), p);
1958         pPM->setState(false, sTranslate);
1959 }
1960
1961 // ***************************************************************************
1962 void CPatchManager::startScanDataThread()
1963 {
1964         if (ScanDataThread != NULL)
1965         {
1966                 nlwarning ("scan data thread is already running");
1967                 return;
1968         }
1969         if (Thread != NULL)
1970         {
1971                 nlwarning ("a thread is already running");
1972                 return;
1973         }
1974
1975         _ErrorMessage.clear();
1976
1977         // Reset result
1978         clearDataScanLog();
1979
1980         // Read now the client version and Desc File.
1981         readClientVersionAndDescFile();
1982
1983         // start thread
1984         ScanDataThread = new CScanDataThread();
1985         nlassert (ScanDataThread != NULL);
1986
1987         Thread = IThread::create (ScanDataThread);
1988         nlassert (Thread != NULL);
1989         Thread->start ();
1990 }
1991
1992 // ****************************************************************************
1993 bool CPatchManager::isScanDataThreadEnded(bool &ok)
1994 {
1995         if (ScanDataThread == NULL)
1996         {
1997                 ok = false;
1998                 return true;
1999         }
2000
2001         bool end = ScanDataThread->Ended;
2002         if (end)
2003         {
2004                 ok = ScanDataThread->CheckOk;
2005                 stopScanDataThread();
2006         }
2007
2008         return end;
2009 }
2010
2011 // ****************************************************************************
2012 void CPatchManager::stopScanDataThread()
2013 {
2014         if(ScanDataThread && Thread)
2015         {
2016                 Thread->wait();
2017                 delete Thread;
2018                 Thread = NULL;
2019                 delete ScanDataThread;
2020                 ScanDataThread = NULL;
2021         }
2022 }
2023
2024 // ***************************************************************************
2025 void CPatchManager::askForStopScanDataThread()
2026 {
2027         if(!ScanDataThread)
2028                 return;
2029
2030         ScanDataThread->AskForCancel= true;
2031 }
2032
2033 // ***************************************************************************
2034 uint CPatchManager::applyScanDataResult()
2035 {
2036         // if still running, abort
2037         if(ScanDataThread)
2038                 return 0;
2039
2040         uint numError= 0;
2041
2042         {
2043                 TSyncDataScanState::CAccessor   ac(&DataScanState);
2044                 CDataScanState  &val= ac.value();
2045                 numError= (uint)val.FilesWithScanDataError.size();
2046
2047                 // Touch the files with error (will be reloaded at next patch)
2048                 for(uint i=0;i<numError;i++)
2049                 {
2050                         SFileToPatch    &ftp= val.FilesWithScanDataError[i];
2051
2052                         // if the file was not found (just loggued for information)
2053                         if(!ftp.LocalFileExists)
2054                                 continue;
2055
2056                         // get file path
2057                         // following lines added by Sadge to ensure that the correct file gets patched
2058                         string sFilePath;
2059                         if (NLMISC::CFile::fileExists(WritableClientDataPath + ftp.FileName)) sFilePath = WritableClientDataPath + ftp.FileName;
2060                         if (sFilePath.empty() && NLMISC::CFile::fileExists(ReadableClientDataPath + ftp.FileName)) sFilePath = ReadableClientDataPath + ftp.FileName;
2061                         if (sFilePath.empty() && NLMISC::CFile::fileExists(ClientPatchPath + ftp.FileName))     sFilePath = ClientPatchPath + ftp.FileName;
2062
2063 // following lines removed by Sadge to ensure that the correct file gets patched
2064 //                      string sFilePath = CPath::lookup(ftp.FileName, false, false);
2065 //                      if (sFilePath.empty())
2066 //                      {
2067 //                              if (NLMISC::CFile::fileExists(ClientPatchPath + ftp.FileName))
2068 //                                      sFilePath = ClientPatchPath + ftp.FileName;
2069 //                      }
2070
2071                         // Reset to a dummy date, so the patch will be fully/checked/patched next time
2072                         if(!sFilePath.empty())
2073                                 applyDate(sFilePath, DefaultResetDate);
2074                         else
2075                                 nlwarning("File '%s' Not Found. should exist...", ftp.FileName.c_str());
2076                 }
2077         }
2078
2079         return numError;
2080 }
2081
2082 // ***************************************************************************
2083 bool CPatchManager::getDataScanLog(string &text)
2084 {
2085         text.clear();
2086         bool    changed= false;
2087         {
2088                 TSyncDataScanState::CAccessor   ac(&DataScanState);
2089                 CDataScanState  &val= ac.value();
2090                 changed= val.Changed;
2091                 // if changed, build the log
2092                 if(changed)
2093                 {
2094                         for(uint i=0;i<val.FilesWithScanDataError.size();i++)
2095                         {
2096                                 string  str;
2097                                 getCorruptedFileInfo(val.FilesWithScanDataError[i], str);
2098                                 text+= str + "\n";
2099                         }
2100                 }
2101                 // then reset
2102                 val.Changed= false;
2103         }
2104
2105         return changed;
2106 }
2107
2108 // ***************************************************************************
2109 void CPatchManager::addDataScanLogCorruptedFile(const SFileToPatch &ftp)
2110 {
2111         {
2112                 TSyncDataScanState::CAccessor   ac(&DataScanState);
2113                 CDataScanState  &val= ac.value();
2114                 val.FilesWithScanDataError.push_back(ftp);
2115                 val.Changed= true;
2116         }
2117 }
2118
2119 // ***************************************************************************
2120 void CPatchManager::clearDataScanLog()
2121 {
2122         {
2123                 TSyncDataScanState::CAccessor   ac(&DataScanState);
2124                 CDataScanState  &val= ac.value();
2125                 val.FilesWithScanDataError.clear();
2126                 val.Changed= true;
2127         }
2128 }
2129
2130 // ***************************************************************************
2131 void CPatchManager::getCorruptedFileInfo(const SFileToPatch &ftp, string &sTranslate)
2132 {
2133         sTranslate = CI18N::get("uiCorruptedFile") + " " + ftp.FileName + " (" +
2134                 toString("%.1f ", (float)ftp.FinalFileSize/1000000.f) + CI18N::get("uiMb") + ")";
2135 }
2136
2137
2138 // ****************************************************************************
2139 // ****************************************************************************
2140 // ****************************************************************************
2141 // CCheckThread
2142 // ****************************************************************************
2143 // ****************************************************************************
2144 // ****************************************************************************
2145
2146 // ****************************************************************************
2147 CCheckThread::CCheckThread(bool includeBackgroundPatch)
2148 {
2149         Ended = false;
2150         CheckOk = false;
2151         TotalFileToCheck = 0;
2152         CurrentFileChecked = 0;
2153         IncludeBackgroundPatch = includeBackgroundPatch;
2154         StopAsked = false;
2155 }
2156
2157 // ****************************************************************************
2158 void CCheckThread::run ()
2159 {
2160         nlwarning("CCheckThread::start");
2161         StopAsked = false;
2162         CPatchManager *pPM = CPatchManager::getInstance();
2163         pPM->MustLaunchBatFile = false;
2164         try
2165         {
2166                 nlwarning("CCheckThread : get version");
2167                 uint32 i, j, k;
2168                 // Check if the client version is the same as the server version
2169                 string sClientVersion = pPM->getClientVersion();
2170                 string sServerVersion = pPM->getServerVersion();
2171                 string sTranslate = CI18N::get("uiClientVersion") + " (" + sClientVersion + ") ";
2172                 sTranslate += CI18N::get("uiServerVersion") + " (" + sServerVersion + ")";
2173                 pPM->setState(true, sTranslate);
2174
2175                 if (sServerVersion.empty())
2176                 {
2177                         // No need to patch
2178                         CheckOk = true;
2179                         Ended = true;
2180                         return;
2181                 }
2182
2183                 sint32 nServerVersion, nClientVersion;
2184                 fromString(sServerVersion, nServerVersion);
2185                 fromString(sClientVersion, nClientVersion);
2186
2187                 if (nClientVersion != nServerVersion)
2188                 {
2189                         // first, try in the version subdirectory
2190                         try
2191                         {
2192                                 pPM->DescFilename = toString("%05d/ryzom_%05d.idx", nServerVersion, nServerVersion);
2193                                 // The client version is different from the server version : download new description file
2194                                 pPM->getServerFile(pPM->DescFilename, false); // For the moment description file is not zipped
2195                         }
2196                         catch (...)
2197                         {
2198                                 // fallback to patch root directory
2199                                 pPM->DescFilename = toString("ryzom_%05d.idx", nServerVersion);
2200                                 // The client version is different from the server version : download new description file
2201                                 pPM->getServerFile(pPM->DescFilename, false); // For the moment description file is not zipped
2202                         }
2203                 }
2204
2205                 nlwarning("CCheckThread : read description files");
2206
2207                 // Read the description file
2208                 pPM->readDescFile(nServerVersion);
2209
2210                 nlwarning("CCheckThread : check files");
2211
2212                 // For all bnp in the description file get all patches to apply
2213                 // depending on the version of the client bnp files
2214                 const CBNPFileSet &rDescFiles = pPM->DescFile.getFiles();
2215                 pPM->FilesToPatch.clear();
2216                 TotalFileToCheck = rDescFiles.fileCount();
2217                 for (i = 0; i < rDescFiles.fileCount(); ++i)
2218                 {
2219                         CPatchManager::SFileToPatch ftp;
2220                         sTranslate = CI18N::get("uiCheckingFile") + " " + rDescFiles.getFile(i).getFileName();
2221                         pPM->setState(true, sTranslate);
2222                         // get list of patch to apply to this file. don't to a full checksum test if possible
2223                         nlwarning(rDescFiles.getFile(i).getFileName().c_str());
2224                         pPM->getPatchFromDesc(ftp, rDescFiles.getFile(i), false);
2225                         // add the file if there are some patches to apply, or if an already patched version was found in the unpack directory
2226                         if (!ftp.Patches.empty() || (IncludeBackgroundPatch && !ftp.SrcFileName.empty()))
2227                         {
2228                                 pPM->FilesToPatch.push_back(ftp);
2229                                 sTranslate = CI18N::get("uiNeededPatches") + " " + toString (ftp.Patches.size());
2230                                 pPM->setState(true, sTranslate);
2231                         }
2232                         CurrentFileChecked = i;
2233                 }
2234
2235                 // Here we got all the files to patch in FilesToPatch and all the versions that must be obtained
2236                 // Now we have to get the optional categories
2237                 const CBNPCategorySet &rDescCats = pPM->DescFile.getCategories();
2238                 pPM->OptionalCat.clear();
2239                 for (i = 0; i < rDescCats.categoryCount(); ++i)
2240                 {
2241                         // For all optional categories check if there is a 'file to patch' in it
2242                         const CBNPCategory &rCat = rDescCats.getCategory(i);
2243                         if (rCat.isOptional())
2244                         for (j = 0; j < rCat.fileCount(); ++j)
2245                         {
2246                                 const string &rFilename = rCat.getFile(j);
2247                                 bool bAdded = false;
2248                                 for (k = 0; k < pPM->FilesToPatch.size(); ++k)
2249                                 {
2250                                         if (stricmp(pPM->FilesToPatch[k].FileName.c_str(), rFilename.c_str()) == 0)
2251                                         {
2252                                                 pPM->OptionalCat.push_back(rCat.getName());
2253                                                 bAdded = true;
2254                                                 break;
2255                                         }
2256                                 }
2257                                 if (bAdded)
2258                                         break;
2259                         }
2260                 }
2261
2262                 // For all categories that required an optional category if the cat required is present the category that
2263                 // reference it must be present
2264                 for (i = 0; i < rDescCats.categoryCount(); ++i)
2265                 {
2266                         // For all optional categories check if there is a 'file to patch' in it
2267                         const CBNPCategory &rCat = rDescCats.getCategory(i);
2268                         if (rCat.isOptional() && !rCat.getCatRequired().empty())
2269                         {
2270                                 // Does the rCat is already present ?
2271                                 bool bFound = false;
2272                                 for (j = 0; j < pPM->OptionalCat.size(); ++j)
2273                                 {
2274                                         if (rCat.getName() == pPM->OptionalCat[j])
2275                                         {
2276                                                 bFound = true;
2277                                                 break;
2278                                         }
2279                                 }
2280
2281                                 if (!bFound)
2282                                 {
2283                                         // rCat is not present but perhaps its required cat is present
2284                                         const string &sCatReq = rCat.getCatRequired();
2285                                         for (j = 0; j < pPM->OptionalCat.size(); ++j)
2286                                         {
2287                                                 if (sCatReq == pPM->OptionalCat[j])
2288                                                 {
2289                                                         // Required Cat present -> Add the category rCat
2290                                                         pPM->OptionalCat.push_back(rCat.getName());
2291                                                         break;
2292                                                 }
2293                                         }
2294                                 }
2295                         }
2296                 }
2297
2298
2299                 // Delete categories optional cat that are hidden
2300                 for (i = 0; i < rDescCats.categoryCount(); ++i)
2301                 {
2302                         // For all optional categories check if there is a 'file to patch' in it
2303                         const CBNPCategory &rCat = rDescCats.getCategory(i);
2304                         if (rCat.isOptional() && rCat.isHidden())
2305                         {
2306                                 // Does the rCat is present ?
2307                                 for (j = 0; j < pPM->OptionalCat.size(); ++j)
2308                                 {
2309                                         if (rCat.getName() == pPM->OptionalCat[j])
2310                                         {
2311                                                 // remove it
2312                                                 /*#ifdef RY_BG_DOWNLOADER
2313                                                         // fixme : strange stlport link error for the background downloader when using erase ...
2314                                                         std::copy(pPM->OptionalCat.begin() + j + 1, pPM->OptionalCat.end(), pPM->OptionalCat.begin()+j);
2315                                                         pPM->OptionalCat.resize(pPM->OptionalCat.size() - 1);
2316                                                 #else*/
2317                                                         pPM->OptionalCat.erase(pPM->OptionalCat.begin()+j);
2318                                                 //#endif
2319                                                 break;
2320                                         }
2321                                 }
2322                         }
2323                 }
2324
2325                 // Get all extract to category and check files inside the bnp with real files
2326                 for (i = 0; i < rDescCats.categoryCount(); ++i)
2327                 {
2328                         // For all optional categories check if there is a 'file to patch' in it
2329                         const CBNPCategory &rCat = rDescCats.getCategory(i);
2330                         if (!rCat.getUnpackTo().empty())
2331                         {
2332                                 for (j = 0; j < rCat.fileCount(); ++j)
2333                                 {
2334                                         string sBNPFilename = pPM->ClientPatchPath + rCat.getFile(j);
2335
2336                                         sTranslate = CI18N::get("uiCheckInBNP") + " " + rCat.getFile(j);
2337                                         pPM->setState(true, sTranslate);
2338                                         CBigFile::BNP bnpFile;
2339                                         bnpFile.BigFileName = sBNPFilename;
2340
2341                                         if (bnpFile.readHeader())
2342                                         {
2343                                                 // read the file inside the bnp and calculate the sha1
2344                                                 FILE *bnp = nlfopen (sBNPFilename, "rb");
2345                                                 if (bnp != NULL)
2346                                                 {
2347                                                         for (uint32 k = 0; k < bnpFile.SFiles.size(); ++k)
2348                                                         {
2349                                                                 const CBigFile::SBNPFile &rBNPFile = bnpFile.SFiles[k];
2350                                                                 // Is the real file exists ?
2351                                                                 string sRealFilename = rCat.getUnpackTo() + rBNPFile.Name;
2352                                                                 if (NLMISC::CFile::fileExists(sRealFilename))
2353                                                                 {
2354                                                                         // Yes compare the sha1 with the sha1 of the BNP File
2355                                                                         CHashKey sha1BNPFile;
2356                                                                         nlfseek64 (bnp, rBNPFile.Pos, SEEK_SET);
2357                                                                         uint8 *pPtr = new uint8[rBNPFile.Size];
2358                                                                         if (fread (pPtr, rBNPFile.Size, 1, bnp) != 1)
2359                                                                         {
2360                                                                                 delete [] pPtr;
2361                                                                                 break;
2362                                                                         }
2363
2364                                                                         sha1BNPFile = getSHA1(pPtr, rBNPFile.Size);
2365                                                                         delete [] pPtr;
2366                                                                         CHashKey sha1RealFile = getSHA1(sRealFilename, true);
2367                                                                         if ( ! (sha1RealFile == sha1BNPFile))
2368                                                                         {
2369                                                                                 sTranslate = CI18N::get("uiSHA1Diff") + " " + rBNPFile.Name;
2370                                                                                 pPM->setState(true, sTranslate);
2371                                                                                 pPM->MustLaunchBatFile = true;
2372                                                                         }
2373                                                                 }
2374                                                                 else
2375                                                                 {
2376                                                                         // File dest do not exist
2377                                                                         sTranslate = CI18N::get("uiSHA1Diff") + " " + rBNPFile.Name;
2378                                                                         pPM->setState(true, sTranslate);
2379                                                                         pPM->MustLaunchBatFile = true;
2380                                                                 }
2381
2382                                                         }
2383                                                         fclose (bnp);
2384                                                 }
2385                                                 if (StopAsked)
2386                                                 {
2387                                                         StopAsked = false;
2388                                                         return;
2389                                                 }
2390                                         }
2391                                 }
2392                         }
2393                 }
2394
2395                 sTranslate = CI18N::get("uiCheckEndNoErr");
2396                 pPM->setState(true, sTranslate);
2397                 CheckOk = true;
2398                 Ended = true;
2399         }
2400         catch (const NLMISC::EDiskFullError &)
2401         {
2402                 // more explicit message for this common error case
2403                 nlwarning("EXCEPTION CATCH: disk full");
2404                 pPM->setState(true, CI18N::get("uiCheckEndWithErr"));
2405                 pPM->setErrorMessage(CI18N::get("uiPatchDiskFull"));
2406                 CheckOk = false;
2407                 Ended = true;
2408         }
2409         catch (const Exception &e)
2410         {
2411                 nlwarning("EXCEPTION CATCH: CCheckThread::run() failed");
2412                 string sTranslate = CI18N::get("uiCheckEndWithErr") + " " + e.what();
2413                 pPM->setState(true, CI18N::get("uiCheckEndWithErr"));
2414                 pPM->setErrorMessage(sTranslate);
2415                 CheckOk = false;
2416                 Ended = true;
2417         }
2418 }
2419
2420 // ****************************************************************************
2421 // ****************************************************************************
2422 // ****************************************************************************
2423 // CPatchThread
2424 // ****************************************************************************
2425 // ****************************************************************************
2426 // ****************************************************************************
2427
2428 // ****************************************************************************
2429 CPatchThread::CPatchThread(bool commitPatch)
2430 {
2431         Ended = false;
2432         PatchOk = false;
2433         CurrentFilePatched = 0;
2434         PatchSizeProgress = 0;
2435         _CommitPatch = commitPatch;
2436         StopAsked = false;
2437 }
2438
2439 // ****************************************************************************
2440 void CPatchThread::clear()
2441 {
2442         AllFilesToPatch.clear();
2443 }
2444
2445 // ****************************************************************************
2446 // trap : optimize this if needed
2447 void CPatchThread::add(const CPatchManager::SFileToPatch &ftp)
2448 {
2449         for (uint32 i = 0; i < AllFilesToPatch.size(); ++i)
2450         {
2451                 if (AllFilesToPatch[i].FileName == ftp.FileName)
2452                         return;
2453         }
2454         AllFilesToPatch.push_back(ftp);
2455 }
2456
2457
2458 // ****************************************************************************
2459 void CPatchThread::run()
2460 {
2461         StopAsked = false;
2462         CPatchManager *pPM = CPatchManager::getInstance();
2463         bool bErr = false;
2464         uint32 i;
2465
2466         string sServerVersion = pPM->getServerVersion();
2467         PatchSizeProgress = 0;
2468
2469         if (sServerVersion.empty())
2470         {
2471                 // No need to patch
2472                 PatchOk = true;
2473                 Ended = true;
2474                 return;
2475         }
2476
2477         // Patch all the files
2478         // If at least one file has been patched relaunch the client
2479
2480         CurrentFilePatched = 0.f;
2481
2482         string sTranslate;
2483         try
2484         {
2485                 // First do all ref files
2486                 // ----------------------
2487
2488                 for (i = 0; i < AllFilesToPatch.size(); ++i)
2489                 {
2490                         CPatchManager::SFileToPatch &rFTP = AllFilesToPatch[i];
2491                         string ext = NLMISC::CFile::getExtension(rFTP.FileName);
2492                         if (ext == "ref")
2493                         {
2494                                 float oldCurrentFilePatched = CurrentFilePatched;
2495                                 processFile (rFTP);
2496                                 pPM->MustLaunchBatFile = true;
2497                                 CurrentFilePatched = oldCurrentFilePatched + 1.f;
2498                         }
2499                         if (StopAsked)
2500                         {
2501                                 StopAsked = false;
2502                                 return;
2503                         }
2504                 }
2505
2506                 // Second do all bnp files
2507                 // -----------------------
2508
2509                 for (i = 0; i < AllFilesToPatch.size(); ++i)
2510                 {
2511                         CPatchManager::SFileToPatch &rFTP = AllFilesToPatch[i];
2512
2513                         string ext = NLMISC::CFile::getExtension(rFTP.FileName);
2514                         if (ext == "bnp" || ext == "snp")
2515                         {
2516                                 float oldCurrentFilePatched = CurrentFilePatched;
2517                                 processFile (rFTP);
2518                                 pPM->MustLaunchBatFile = true;
2519                                 CurrentFilePatched = oldCurrentFilePatched + 1.f;
2520                         }
2521                         if (StopAsked)
2522                         {
2523                                 StopAsked = false;
2524                                 return;
2525                         }
2526                 }
2527
2528         }
2529         catch (const NLMISC::EDiskFullError &)
2530         {
2531                 // more explicit message for this common error case
2532                 nlwarning("EXCEPTION CATCH: CPatchThread::run() Disk Full");
2533                 pPM->setState(true, CI18N::get("uiPatchEndWithErr"));
2534                 sTranslate = CI18N::get("uiPatchDiskFull");
2535                 bErr = true;
2536         }
2537         catch(const Exception &e)
2538         {
2539                 nlwarning("EXCEPTION CATCH: CPatchThread::run() failed");
2540                 pPM->setState(true, string(e.what()));
2541                 sTranslate = CI18N::get("uiPatchEndWithErr");
2542                 bErr = true;
2543         }
2544
2545
2546         // Unpack all files with the UnpackTo flag
2547         // ---------------------------------------
2548         // To do that we create a batch file that will copy all files (unpacked to patch directory)
2549         // to the directory we want (the UnpackTo string)
2550
2551         // Recreate batch file
2552         if (!pPM->MustLaunchBatFile && !pPM->getAsyncDownloader())
2553         {
2554                 pPM->deleteFile(pPM->UpdateBatchFilename, false, false);
2555         }
2556
2557         if (!bErr)
2558         {
2559                 sTranslate = CI18N::get("uiPatchEndNoErr");
2560         }
2561         else
2562         {
2563                 // Set a more explicit error message
2564                 pPM->setErrorMessage(sTranslate);
2565         }
2566
2567         PatchOk = !bErr;
2568         Ended = true;
2569 }
2570
2571
2572 class CPatchThreadDownloadProgress : public NLMISC::IProgressCallback
2573 {
2574 public:
2575         CPatchThread *PatchThread;
2576         float Scale;
2577         float Bias;
2578         uint CurrentFilePatched;
2579         CPatchThreadDownloadProgress() : PatchThread(NULL),
2580                                                                          Scale(1.f),
2581                                                                          Bias(0.f),
2582                                                                          CurrentFilePatched(0)
2583         {
2584         }
2585         virtual void progress (float progressValue)
2586         {
2587                 clamp(progressValue, 0.f, 1.f);
2588                 nlassert(PatchThread);
2589                 //PatchThread->CurrentFilePatched = std::max(PatchThread->CurrentFilePatched, (float) this->CurrentFilePatched + Bias + Scale * progressValue);
2590                 PatchThread->CurrentFilePatched = this->CurrentFilePatched + Bias + Scale * progressValue;
2591                 CPatchManager::getInstance()->touchState();
2592         }
2593 };
2594
2595 void stopSoundMngr();
2596
2597 // ****************************************************************************
2598 void CPatchThread::processFile (CPatchManager::SFileToPatch &rFTP)
2599 {
2600         CPatchManager *pPM = CPatchManager::getInstance();
2601
2602         // Source File Name (in writable or readable directory)
2603         string SourceName;
2604
2605         // Destination File Name (in writable directory)
2606         string DestinationName;
2607
2608         if (NLMISC::startsWith(rFTP.FileName, "sound"))
2609         {
2610                 // Stop sound playback
2611                 stopSoundMngr();
2612         }
2613
2614         if (rFTP.ExtractPath.empty())
2615         {
2616                 DestinationName = pPM->WritableClientDataPath + rFTP.FileName;
2617
2618                 if (rFTP.LocalFileExists)
2619                 {
2620                         // following lines added by Sadge to ensure that the correct file gets patched
2621                         SourceName.clear();
2622
2623                         if (NLMISC::CFile::fileExists(pPM->WritableClientDataPath + rFTP.FileName))
2624                         {
2625                                 SourceName = pPM->WritableClientDataPath + rFTP.FileName;
2626                         }
2627                         else if (NLMISC::CFile::fileExists(pPM->ReadableClientDataPath + rFTP.FileName))
2628                         {
2629                                 SourceName = pPM->ReadableClientDataPath + rFTP.FileName;
2630                         }
2631
2632                         // version from previous download
2633                         if (SourceName.empty()) throw Exception (std::string("ERROR: Failed to find file: ")+rFTP.FileName);
2634
2635 // following lines removed by Sadge to ensure that the correct file gets patched
2636 //                      SourceName = CPath::lookup(rFTP.FileName); // exception if file do not exists
2637                 }
2638                 else
2639                 {
2640                         // note : if file was background downloaded, we have :
2641                         // rFTP.LocalFileExists = false
2642                         // rFTP.SrcFileName = "unpack/filename.bnp.tmp"
2643                         SourceName = DestinationName;
2644                 }
2645         }
2646         else
2647         {
2648                 SourceName = pPM->ClientPatchPath + rFTP.FileName;
2649                 DestinationName = SourceName;
2650         }
2651
2652         if (rFTP.LocalFileToDelete)
2653         {
2654                 // corrupted or invalid file ? ....
2655                 NLMISC::CFile::deleteFile(SourceName);
2656                 rFTP.LocalFileExists = false;
2657         }
2658
2659         string sTranslate;
2660         sTranslate = CI18N::get("uiProcessing") + " " + rFTP.FileName;
2661         pPM->setState(true, sTranslate);
2662
2663         if (pPM->getAsyncDownloader())
2664         {
2665                 if (!rFTP.ExtractPath.empty())
2666                 {
2667                         std::string info = rFTP.FileName;
2668                 }
2669                 string PatchName = toString("%05d/%s%s", rFTP.Patches[rFTP.Patches.size() - 1], rFTP.FileName.c_str(), ".lzma");
2670                 pPM->getAsyncDownloader()->addToDownloadList(PatchName, SourceName, rFTP.LastFileDate, rFTP.ExtractPath, rFTP.SZFileSize, rFTP.FinalFileSize );
2671                 return;
2672         }
2673
2674
2675         std::string tmpSourceName = rFTP.SrcFileName.empty() ? SourceName : rFTP.SrcFileName; // source is same than destination, or possibly
2676                                                                                                                                                                                  // a patch from a previous background downloader session
2677         if (rFTP.LocalFileToDelete)
2678         {
2679                 // corrupted or invalid file ? ....
2680                 rFTP.LocalFileExists = false;
2681                 NLMISC::CFile::deleteFile(tmpSourceName);
2682         }
2683
2684         string OutFilename;
2685         bool usePatchFile = true;
2686
2687         // compute the total size of patch to download
2688         uint32 totalPatchSize = 0;
2689         if (rFTP.Incremental)
2690         {
2691                 for (uint i=0; i<rFTP.PatcheSizes.size(); ++i)
2692                         totalPatchSize += rFTP.PatcheSizes[i];
2693         }
2694         else if (!rFTP.PatcheSizes.empty())
2695         {
2696                 totalPatchSize = rFTP.PatcheSizes.back();
2697         }
2698
2699
2700         CPatchThreadDownloadProgress progress;
2701         progress.PatchThread = this;
2702         progress.CurrentFilePatched = (uint) floorf(CurrentFilePatched);
2703
2704         // look for the source file, if not present or invalid (not matching
2705         // a known version) or if total patch size greater than half the
2706         // uncompressed final size or if total patch size is greater
2707         // than lzma compressed file, then load the lzma file
2708         if ((rFTP.Incremental && !rFTP.LocalFileExists)         // incremental and no base file, we need a complete file
2709                 || totalPatchSize > rFTP.FinalFileSize / 2              // patch is too big regarding the final file, patch applying time will be slow
2710                 || rFTP.SZFileSize < totalPatchSize)                    // lzma is smaller than patch !
2711         {
2712                 breakable
2713                 {
2714                         usePatchFile = false;
2715                         // compute the seven zip filename
2716                         string lzmaFile = rFTP.FileName+".lzma";
2717
2718                         // download the 7zip file
2719                         try
2720                         {
2721                                 // first, try in the file version subfolfer
2722                                 try
2723                                 {
2724                                         progress.Scale = 1.f;
2725                                         progress.Bias = 0.f;
2726                                         if (!rFTP.Patches.empty())
2727                                         {
2728                                                 pPM->getServerFile(toString("%05u/", rFTP.Patches.back())+lzmaFile, false, "", &progress);
2729                                         }
2730                                         // else -> file comes from a previous download (with .tmp extension, and is up to date)
2731                                         // the remaining code will just rename it with good name and exit
2732                                 }
2733                                 catch (const NLMISC::EWriteError &)
2734                                 {
2735                                         // this is a local error, rethrow ...
2736                                         throw;
2737                                 }
2738                                 catch(...)
2739                                 {
2740                                         // failed with version subfolder, try in the root patch directory
2741                                         pPM->getServerFile(lzmaFile, false, "", &progress);
2742                                 }
2743                         }
2744                         catch (const NLMISC::EWriteError &)
2745                         {
2746                                 // this is a local error, rethrow ...
2747                                 throw;
2748                         }
2749                         catch (...)
2750                         {
2751                                 // can not load the 7zip file, use normal patching
2752                                 usePatchFile = true;
2753                                 break;
2754                         }
2755
2756                         OutFilename = pPM->ClientPatchPath + NLMISC::CFile::getFilename(rFTP.FileName);
2757                         // try to unpack the file
2758                         try
2759                         {
2760                                 if (!unpackLZMA(pPM->ClientPatchPath+lzmaFile, OutFilename+".tmp"))
2761                                 {
2762                                         // fallback to standard patch method
2763                                         usePatchFile = true;
2764                                         break;
2765                                 }
2766                         }
2767                         catch (const NLMISC::EWriteError&)
2768                         {
2769                                 throw;
2770                         }
2771                         catch (...)
2772                         {
2773                                 nlwarning("Failed to unpack lzma file %s", (pPM->ClientPatchPath+lzmaFile).c_str());
2774                                 // fallback to standard patch method
2775                                 usePatchFile = true;
2776                                 break;
2777                         }
2778
2779                         if (rFTP.LocalFileExists)
2780                                 pPM->deleteFile(SourceName);
2781
2782                         pPM->deleteFile(pPM->ClientPatchPath+lzmaFile); // delete the archive file
2783                         pPM->deleteFile(SourceName, false, false); // File can exists if bad BNP loading
2784                         if (_CommitPatch)
2785                         {
2786                                 pPM->renameFile(OutFilename+".tmp", DestinationName);
2787                         }
2788                 }
2789         }
2790         if (usePatchFile)
2791         {
2792                 uint32 currentPatchedSize = 0;
2793                 for (uint32 j = 0; j < rFTP.Patches.size(); ++j)
2794                 {
2795                         // Get the patch
2796                         // first, try in the patch subdirectory
2797                         string PatchName;
2798                         try
2799                         {
2800                                 PatchName = toString("%05d/", rFTP.Patches[j]) + rFTP.FileName.substr(0, rFTP.FileName.size()-4) + toString("_%05d", rFTP.Patches[j]) + ".patch";
2801                                 sTranslate = CI18N::get("uiLoginGetFile") + " " + PatchName;
2802                                 pPM->setState(true, sTranslate);
2803                                 progress.Scale = 1.f;
2804                                 progress.Bias = totalPatchSize != 0 ? (float) currentPatchedSize / totalPatchSize : 0.f;
2805                                 progress.Scale = totalPatchSize != 0 ? (float) rFTP.PatcheSizes[j] / totalPatchSize : 1.f;
2806                                 pPM->getServerFile(PatchName, false, "", &progress);
2807                                 // remove the subfolder name
2808                                 PatchName = NLMISC::CFile::getFilename(PatchName);
2809                         }
2810                         catch (const NLMISC::EWriteError &)
2811                         {
2812                                 throw;
2813                         }
2814                         catch (...)
2815                         {
2816                                 // fallback to patch root directory
2817                                 PatchName = rFTP.FileName.substr(0, rFTP.FileName.size()-4);
2818                                 PatchName += toString("_%05d", rFTP.Patches[j]) + ".patch";
2819                                 sTranslate = CI18N::get("uiLoginGetFile") + " " + PatchName;
2820                                 pPM->setState(true, sTranslate);
2821                                 pPM->getServerFile(PatchName, false, "", &progress);
2822                         }
2823
2824                         // Apply the patch
2825                         // If the patches are not to be applied on the last version
2826                         string SourceNameXD = tmpSourceName;
2827                         if (!rFTP.Incremental)
2828                         {
2829                                 // Some note about non incremental patches :
2830                                 // Usually, files such as '.exe' or '.dll' do not work well with incremental patch, so it is better
2831                                 // to apply a single patch from a refrence version to them. (so here we necessarily got
2832                                 // 'rFTP.Patches.size() == 1' !)
2833                                 // The reference version itself is incrementally patched, however, and may be rebuilt from time to time
2834                                 // when the delta to the reference has become too big (but is most of the time < to the sum of equivallent delta patchs)
2835                                 // The non-incremental final patch (from ref file to final bnp), is guaranteed to be done last
2836                                 // after the reference file has been updated
2837
2838                                 // Find the reference file to apply the patch
2839                                 SourceNameXD = rFTP.FileName;
2840                                 SourceNameXD = SourceNameXD.substr(0, SourceNameXD.rfind('.'));
2841                                 SourceNameXD += "_.ref";
2842
2843                                 if (!_CommitPatch)
2844                                 {
2845                                         // works
2846                                         std::string tmpRefFile = SourceNameXD + ".tmp";
2847                                         if (!NLMISC::CFile::fileExists(pPM->ClientPatchPath + tmpRefFile))
2848                                         {
2849                                                 // Not found in the patch directory -> version in data directory should be good, or would have been
2850                                                 // detected by the check thread else.
2851                                         }
2852                                         else
2853                                         {
2854                                                 SourceNameXD = tmpRefFile; // good ref file download by bg downloader
2855                                         }
2856                                 }
2857
2858                                 // following lines added by Sadge to ensure that the correct file gets patched
2859                                 //                      string SourceNameXDFull;
2860                                 //                      if (NLMISC::CFile::fileExists(pPM->ClientDataPath + SourceNameXD))      SourceNameXDFull = pPM->ClientDataPath + SourceNameXD;
2861
2862                                 // following lines removed by Sadge to ensure that the correct file gets patched
2863                                 //                      string SourceNameXDFull = CPath::lookup(SourceNameXD, false, false);
2864                                 //                      if (SourceNameXDFull.empty())
2865                                 //                              SourceNameXDFull = pPM->ClientDataPath + SourceNameXD;
2866                                 //                      SourceNameXD = SourceNameXDFull;
2867                                 if (CFile::fileExists(pPM->WritableClientDataPath + SourceNameXD))
2868                                 {
2869                                         SourceNameXD = pPM->WritableClientDataPath + SourceNameXD;
2870                                 }
2871                                 else if (CFile::fileExists(pPM->ReadableClientDataPath + SourceNameXD))
2872                                 {
2873                                         SourceNameXD = pPM->ReadableClientDataPath + SourceNameXD;
2874                                 }
2875                         }
2876
2877                         PatchName = pPM->ClientPatchPath + PatchName;
2878
2879                         string OutFilename = pPM->ClientPatchPath + rFTP.FileName + ".tmp__" + toString(j);
2880
2881                         sTranslate = CI18N::get("uiApplyingDelta") + " " + CFile::getFilename(PatchName);
2882                         pPM->setState(true, sTranslate);
2883
2884                         xDeltaPatch(PatchName, SourceNameXD, OutFilename);
2885
2886                         if (rFTP.LocalFileExists)
2887                                 pPM->deleteFile(SourceName);
2888                         pPM->deleteFile(PatchName);
2889
2890                         if (j > 0)
2891                         {
2892                                 pPM->deleteFile(SourceNameXD, false, false); // File can exists if bad BNP loading
2893                         }
2894                         tmpSourceName = OutFilename;
2895                         PatchSizeProgress += rFTP.PatcheSizes[j];
2896                         currentPatchedSize += rFTP.PatcheSizes[j];
2897                 }
2898
2899                 if (tmpSourceName != DestinationName)
2900                 {
2901                         pPM->deleteFile(SourceName, false, false); // File can exists if bad BNP loading
2902                         if (!_CommitPatch)
2903                         {
2904                                 // let the patch in the unpack directory
2905                                 pPM->renameFile(tmpSourceName, pPM->ClientPatchPath + rFTP.FileName + ".tmp");
2906                         }
2907                         else
2908                         {
2909                                 pPM->renameFile(tmpSourceName, DestinationName);
2910                         }
2911                 }
2912         }
2913         else
2914         {
2915                 PatchSizeProgress += totalPatchSize;
2916         }
2917
2918         // If all patches applied with success so file size should be ok
2919         // We just have to change file date to match the last patch applied
2920         pPM->applyDate(DestinationName, rFTP.LastFileDate);
2921         //progress.progress(1.f);
2922 }
2923
2924 // ****************************************************************************
2925 void CPatchThread::xDeltaPatch(const string &patch, const string &src, const string &out)
2926 {
2927         // Internal xdelta
2928
2929         CPatchManager::MyPatchingCB patchingCB;
2930
2931         patchingCB.patchFilename = patch;
2932         patchingCB.srcFilename = src;
2933
2934         CPatchManager *pPM = CPatchManager::getInstance();
2935         pPM->deleteFile(out, false, false);
2936
2937         std::string errorMsg;
2938         CXDeltaPatch::TApplyResult ar = CXDeltaPatch::apply(patch, src, out, errorMsg, &patchingCB);
2939         if (ar != CXDeltaPatch::ApplyResult_Ok)
2940         {
2941                 switch(ar)
2942                 {
2943                         case CXDeltaPatch::ApplyResult_WriteError:
2944                                 throw NLMISC::EWriteError(out);
2945                         break;
2946                         case CXDeltaPatch::ApplyResult_DiskFull:
2947                                 throw NLMISC::EDiskFullError(out);
2948                         break;
2949                         default:
2950                         {
2951                                 std::string str = toString("Error applying %s to %s giving %s", patch.c_str(), src.c_str(), out.c_str());
2952                                 throw Exception (str);
2953                         }
2954                         break;
2955                 }
2956         }
2957
2958
2959         // Launching xdelta
2960 /*
2961         // Start the child process.
2962         string strCmdLine = "xdelta patch " + patch + " " + src + " " + out;
2963 */
2964 }
2965
2966
2967 // ****************************************************************************
2968 // ****************************************************************************
2969 // ****************************************************************************
2970 // CScanDataThread
2971 // ****************************************************************************
2972 // ****************************************************************************
2973 // ****************************************************************************
2974
2975 // ****************************************************************************
2976 CScanDataThread::CScanDataThread()
2977 {
2978         AskForCancel= false;
2979         Ended = false;
2980         CheckOk = false;
2981         TotalFileToScan = 1;
2982         CurrentFileScanned = 1;
2983 }
2984
2985 // ****************************************************************************
2986 void CScanDataThread::run ()
2987 {
2988         CPatchManager *pPM = CPatchManager::getInstance();
2989         try
2990         {
2991                 uint32 i;
2992                 // Check if the client version is the same as the server version
2993                 string sClientVersion = pPM->getClientVersion();
2994                 string sTranslate = CI18N::get("uiClientVersion") + " (" + sClientVersion + ") ";
2995                 pPM->setState(true, sTranslate);
2996
2997                 // For all bnp in the description file get all patches to apply
2998                 // depending on the version of the client bnp files
2999                 const CBNPFileSet &rDescFiles = pPM->DescFile.getFiles();
3000                 TotalFileToScan = rDescFiles.fileCount();
3001                 for (i = 0; i < rDescFiles.fileCount(); ++i)
3002                 {
3003                         sTranslate = CI18N::get("uiCheckingFile") + " " + rDescFiles.getFile(i).getFileName();
3004                         pPM->setState(true, sTranslate);
3005
3006                         // get list of file to apply to this patch, performing a full checksum test (slow...)
3007                         CPatchManager::SFileToPatch ftp;
3008                         pPM->getPatchFromDesc(ftp, rDescFiles.getFile(i), false);
3009                         // if the file has been found but don't correspond to any local version (SHA1)
3010                         // or if the file has not been found (or the .bnp is very very buggy so that addSearchFile() failed)
3011                         if( (ftp.LocalFileExists && ftp.LocalFileToDelete) ||
3012                                 (!ftp.LocalFileExists && !ftp.LocalFileToDelete) )
3013                         {
3014                                 pPM->addDataScanLogCorruptedFile(ftp);
3015                                 CPatchManager::getCorruptedFileInfo(ftp, sTranslate);
3016                                 pPM->setState(true, sTranslate);
3017                         }
3018                         CurrentFileScanned = i;
3019
3020                         // if the user ask to cancel the thread, stop now
3021                         if(AskForCancel)
3022                                 break;
3023                 }
3024
3025                 sTranslate = CI18N::get("uiCheckEndNoErr");
3026                 pPM->setState(true, sTranslate);
3027                 CheckOk = true;
3028                 Ended = true;
3029         }
3030         catch (const Exception &e)
3031         {
3032                 nlwarning("EXCEPTION CATCH: CScanDataThread::run() failed");
3033                 string sTranslate = CI18N::get("uiCheckEndWithErr") + " " + e.what();
3034                 pPM->setState(true, sTranslate);
3035                 CheckOk = false;
3036                 Ended = true;
3037         }
3038 }
3039
3040
3041 // ****************************************************************************
3042 uint32 CPatchManager::SPatchInfo::getAvailablePatchsBitfield() const
3043 {
3044         // About the test (until a patch enum is added, we use the 'optional' flag)
3045         // Non optional -> must patch it (will be for RoS)
3046         // Optional -> Will be for Mainland
3047         // Required : stands for 'bnp' required by the Optional bnps !! so ignore only RoS is wanted
3048
3049         uint32 result = 0;
3050         if (!NonOptCat.empty())
3051         {
3052                 result |= (1 << BGDownloader::DownloadID_RoS);
3053         }
3054         if (!OptCat.empty() || !ReqCat.empty())
3055         {
3056                 result |= (1 << BGDownloader::DownloadID_MainLand);
3057         }
3058         return result;
3059 }
3060
3061 // ***************************************************************************
3062 void CPatchManager::setAsyncDownloader(IAsyncDownloader* asyncDownloader)
3063 {
3064         _AsyncDownloader = asyncDownloader;
3065 }
3066 // ***************************************************************************
3067 IAsyncDownloader* CPatchManager::getAsyncDownloader() const
3068 {
3069         return _AsyncDownloader;
3070 }
3071 // **************************************************************************
3072 // ****************************************************************************
3073 void CPatchManager::startInstallThread(const std::vector<CInstallThreadEntry>& entries)
3074 {
3075         InstallThread = new CInstallThread(entries);
3076         Thread = IThread::create (InstallThread);
3077         nlassert (Thread != NULL);
3078         Thread->start ();
3079 }
3080
3081 void CPatchManager::startDownloadThread(const std::vector<CInstallThreadEntry>& entries)
3082 {
3083         DownloadThread = new CDownloadThread(entries);
3084         Thread = IThread::create (DownloadThread);
3085         nlassert (Thread != NULL);
3086         Thread->start ();
3087 }
3088
3089
3090 void CPatchManager::onFileInstallFinished()
3091 {
3092         if (_AsyncDownloader)
3093         {
3094                 _AsyncDownloader->onFileInstallFinished();
3095         }
3096 }
3097
3098
3099 void CPatchManager::onFileDownloadFinished()
3100 {
3101         if (_AsyncDownloader)
3102         {
3103                 _AsyncDownloader->onFileDownloadFinished();
3104         }
3105 }
3106
3107
3108 void CPatchManager::onFileDownloading(const std::string& sourceName, uint32 rate, uint32 fileIndex, uint32 fileCount, uint64 fileSize, uint64 fullSize)
3109 {
3110         if (_AsyncDownloader)
3111         {
3112                 _AsyncDownloader->onFileDownloading(sourceName, rate, fileIndex, fileCount, fileSize, fullSize);
3113         }
3114 }
3115
3116 void CPatchManager::onFileInstalling(const std::string& sourceName, uint32 rate, uint32 fileIndex, uint32 fileCount, uint64 fileSize, uint64 fullSize)
3117 {
3118         if (_AsyncDownloader)
3119         {
3120                 _AsyncDownloader->onFileInstalling(sourceName, rate, fileIndex, fileCount, fileSize, fullSize);
3121         }
3122 }
3123
3124 bool CPatchManager::download(const std::string& patchFullname, const std::string& sourceFullname,
3125                                                                          const std::string& tmpDirectory, uint32 timestamp)
3126 {
3127         CPatchManager *pPM = CPatchManager::getInstance();
3128
3129         static std::string zsStr = ".lzma";
3130         static std::string::size_type zsStrLength = zsStr.size();
3131
3132         // we delete file if present and diferent timestamp
3133         // if the file is the same then indicates its not necessary to download it a second time
3134         if (NLMISC::CFile::fileExists(sourceFullname))
3135         {
3136                 uint32 t = NLMISC::CFile::getFileModificationDate(sourceFullname);
3137                 if (t == timestamp)
3138                 {       //we didn't downl oad
3139                         return true;
3140                 }
3141                 pPM->deleteFile(sourceFullname);
3142         }
3143         // file will be save to a .tmp file
3144         std::string extension;
3145         if (patchFullname.size() >= zsStrLength && patchFullname.substr(patchFullname.size() - zsStrLength) == zsStr)
3146         {
3147                 extension = zsStr;
3148         }
3149         // remove tmp file if exist
3150         std::string patchName = tmpDirectory + NLMISC::CFile::getFilename(sourceFullname) + extension + std::string(".tmp");
3151         if (NLMISC::CFile::fileExists(patchName))
3152         {
3153                 pPM->deleteFile(patchName);
3154         }
3155         // creates directory tree if necessary
3156         NLMISC::CFile::createDirectoryTree( NLMISC::CFile::getPath(patchName) );
3157         NLMISC::CFile::createDirectoryTree( NLMISC::CFile::getPath(sourceFullname) );
3158
3159         // try to download
3160         try
3161         {
3162                 pPM->getServerFile(patchFullname, false, patchName);
3163         }
3164         catch ( const std::exception& e)
3165         {
3166                 nlwarning("%s", e.what());
3167                 pPM->setState(true, string(e.what()) );
3168                 return false;
3169         }
3170
3171         // install
3172         if (!NLMISC::CFile::fileExists(patchName))
3173         {
3174                 return false;
3175         }
3176         // if file is compressed unpack then commit (rename)
3177         if (patchName.size() >= zsStrLength
3178                 && patchName.substr(patchName.size() - zsStrLength) == zsStr)
3179         {
3180                 std::string outFilename = patchName.substr(0, patchName.size() - zsStrLength);
3181                 unpack7Zip(patchName, outFilename);
3182                 pPM->deleteFile(patchName);
3183                 pPM->renameFile(outFilename, sourceFullname);
3184         }
3185         else
3186         {
3187                 // file is not compressed so rename the .tmp file to final name
3188                 pPM->renameFile(patchName, sourceFullname);
3189         }
3190         // apply modification date
3191         pPM->applyDate(sourceFullname, timestamp);
3192
3193         return true;
3194 }
3195
3196
3197 bool CPatchManager::extract(const std::string& patchPath,
3198                                                         const std::vector<std::string>& sourceFilename,
3199                                                         const std::vector<std::string>& extractPath,
3200                                                         const std::string& updateBatchFilename,
3201                                                         const std::string& execName,
3202                                                         void (*stopFun)() )
3203 {
3204         nlassert(sourceFilename.size() == extractPath.size());
3205         CPatchManager *pPM = CPatchManager::getInstance();
3206
3207         bool ok = false;
3208         for (uint32 j = 0; j < extractPath.size() && !ok; ++j)
3209         {
3210                 if (!extractPath[j].empty())
3211                 {
3212                         ok = true;
3213                 }
3214         }
3215
3216         if (!ok)
3217         {
3218                 // nothing to extract
3219                 return false;
3220         }
3221
3222         // extract
3223         uint nblab = 0;
3224         pPM->deleteFile(updateBatchFilename, false, false);
3225
3226         FILE *fp = nlfopen (updateBatchFilename, "wt");
3227
3228         if (fp == 0)
3229         {
3230                 string err = toString("Can't open file '%s' for writing: code=%d %s (error code 29)", updateBatchFilename.c_str(), errno, strerror(errno));
3231                 throw Exception (err);
3232         }
3233
3234 #ifdef NL_OS_WINDOWS
3235         fprintf(fp, "@echo off\n");
3236         fprintf(fp, "ping 127.0.0.1 -n 7 -w 1000 > nul\n"); // wait
3237 #else
3238         fprintf(fp, "#!/bin/sh\n");
3239         fprintf(fp, "sleep 7\n"); // wait
3240 #endif
3241
3242         // Unpack files with category ExtractPath non empty
3243         for (uint32 j = 0; j < sourceFilename.size(); ++j)
3244         {
3245                 if (!extractPath[j].empty())
3246                 {
3247                         string rFilename = sourceFilename[j];
3248                         // Extract to patch
3249                         vector<string> vFilenames;
3250                         if (!pPM->bnpUnpack(rFilename, patchPath, vFilenames))
3251                         {
3252                                 /*
3253                                 string err = toString("Error unpacking %s", rFilename.c_str());
3254                                 throw Exception (err);
3255                                 */
3256                         }
3257                         else
3258                         {
3259                                 std::string sourcePath = NLMISC::CFile::getPath(sourceFilename[j]);
3260                                 for (uint32 fff = 0; fff < vFilenames.size (); fff++)
3261                                 {
3262                                         string SrcPath = CPath::standardizeDosPath(sourcePath);
3263                                         string SrcName = SrcPath + vFilenames[fff];
3264                                         string DstPath = CPath::standardizeDosPath(extractPath[j]);
3265                                         string DstName = DstPath + vFilenames[fff];
3266                                         NLMISC::CFile::createDirectoryTree(extractPath[j]);
3267
3268                                         // this file must be moved
3269 #ifdef NL_OS_WINDOWS
3270                                         fprintf(fp, ":loop%u\n", nblab);
3271                                         fprintf(fp, "attrib -r -a -s -h %s\n", DstName.c_str());
3272                                         fprintf(fp, "del %s\n", DstName.c_str());
3273                                         fprintf(fp, "if exist %s goto loop%u\n", DstName.c_str(), nblab);
3274                                         fprintf(fp, "move %s %s\n", SrcName.c_str(), DstPath.c_str());
3275 #else
3276                                         // TODO: for Linux and OS X
3277 #endif
3278
3279                                         nblab++;
3280
3281                                 }
3282                         }
3283                 }
3284         }
3285
3286
3287 #ifdef NL_OS_WINDOWS
3288         fprintf(fp, "start %s %%1 %%2 %%3\n", execName.c_str());
3289 #else
3290         // TODO: for Linux and OS X
3291 #endif
3292
3293         fclose(fp);
3294
3295         if (stopFun)
3296         {
3297                 stopFun();
3298         }
3299
3300         if (!launchProgram(updateBatchFilename, "", false))
3301         {
3302                 // error occurs during the launch
3303                 string str = toString("Can't execute '%s': code=%d %s (error code 30)", updateBatchFilename.c_str(), errno, strerror(errno));
3304                 throw Exception (str);
3305         }
3306
3307         return true;
3308 }
3309
3310
3311 void CPatchManager::setStateListener(IPatchManagerStateListener* stateListener)
3312 {
3313         _StateListener = stateListener;
3314 }
3315
3316
3317 void CPatchManager::fatalError(const std::string& errorId, const std::string& param1, const std::string& param2)
3318 {
3319         if (_AsyncDownloader)
3320         {
3321                 _AsyncDownloader->fatalError(errorId, param1, param2);
3322         }
3323 }
3324
3325
3326 // ****************************************************************************
3327 void CDownloadThread::run()
3328 {
3329         CPatchManager *pPM = CPatchManager::getInstance();
3330
3331         std::string patchPath = CPath::standardizePath (ClientRootPath+TheTmpInstallDirectory)+"patch/";
3332
3333
3334         static bool _FirstTime = true;
3335         static uint64 _FullSize = 0;
3336         static uint64 _CurrentSize = 0;
3337         static uint32 _Start;
3338
3339         // At first launch calculat the amount of data need to download
3340         if (_FirstTime)
3341         {
3342                 for (uint first = 0,last = (uint)_Entries.size() ; first != last; ++first)
3343                 {
3344                         _FullSize += _Entries[first].SZipFileSize;
3345                 }
3346                 _Start = NLMISC::CTime::getSecondsSince1970();
3347                 _FirstTime = false;
3348         }
3349
3350
3351         for (uint first = 0,last = (uint)_Entries.size() ; first != last; ++first)
3352         {
3353                 std::string patchName = CPath::standardizePath (_Entries[first].PatchName, false);
3354                 std::string sourceName = CPath::standardizePath (_Entries[first].SourceName, false);
3355
3356                 _CurrentSize += _Entries[first].SZipFileSize;
3357
3358                 uint32 rate = 0;
3359                 // Calculate the time since last update
3360                 uint32 dt = NLMISC::CTime::getSecondsSince1970() - _Start;
3361                 if (dt)
3362                 {
3363                         rate = uint32(_CurrentSize / dt);
3364                 }
3365                 // update Gui
3366                 pPM->onFileDownloading(sourceName, rate, first+1, last, _CurrentSize, _FullSize);
3367
3368                 std::string finalFile =patchPath+ patchName;
3369                 std::string tmpFile = finalFile + std::string(".part");
3370
3371
3372                 bool toDownload = true;
3373                 static volatile bool simulateDownload = false;
3374                 if (simulateDownload)
3375                 {
3376                         nlSleep(100);
3377                 }
3378                 else
3379                 {
3380                         // Do not download if file are identicaly (check size and modification date)
3381                         if (NLMISC::CFile::fileExists(finalFile))
3382                         {
3383                                 uint64 fz = NLMISC::CFile::getFileSize(finalFile);
3384                                 uint32 timestamp = _Entries[first].Timestamp;
3385                                 uint32 timestamp2 = NLMISC::CFile::getFileModificationDate(finalFile);
3386                                 if ( fz == _Entries[first].SZipFileSize && timestamp == timestamp2)
3387                                 {
3388                                         toDownload = false;
3389                                 }
3390                                 else
3391                                 {
3392                                         NLMISC::CFile::deleteFile(finalFile);
3393                                 }
3394                         }
3395
3396                         // file need to be download
3397                         if (toDownload)
3398                         {
3399                                 // delete tmp file if exist
3400                                 if (NLMISC::CFile::fileExists(tmpFile))
3401                                 {
3402                                         NLMISC::CFile::deleteFile(tmpFile);
3403                                 }
3404                                 std::string path = NLMISC::CFile::getPath(tmpFile);
3405                                 // create directory tree
3406                                 NLMISC::CFile::createDirectoryTree(path);
3407                                 // Try to download, rename, applyDate and send error msg to gui in case of error
3408                                 try
3409                                 {
3410                                         pPM->getServerFile(patchName, false, tmpFile);
3411                                         NLMISC::CFile::moveFile(finalFile, tmpFile);
3412
3413                                         pPM->applyDate(finalFile, _Entries[first].Timestamp);
3414                                 }
3415                                 catch ( const std::exception& e)
3416                                 {
3417                                         nlwarning("%s", e.what());
3418                                         pPM->setState(true, string(e.what()) );
3419                                         pPM->fatalError("uiCanNotDownload", patchName.c_str(), "");
3420                                 }
3421                                 catch (...)
3422                                 {
3423                                         pPM->fatalError("uiCanNotDownload", patchName.c_str(), "");
3424                                 }
3425                         }
3426                 }
3427
3428         }
3429         // message to gui to indicates that all file are downloaded
3430         pPM->onFileDownloadFinished();
3431
3432 }
3433
3434 void CInstallThread::run()
3435 {
3436         std::string patchPath = CPath::standardizePath (ClientRootPath+TheTmpInstallDirectory)+"patch/";
3437         CPatchManager *pPM = CPatchManager::getInstance();
3438
3439         std::set<std::string> allowed;
3440
3441         uint first, last;
3442
3443         for (first = 0,last = (uint)_Entries.size() ; first != last; ++first)
3444         {
3445                 std::string correct = CPath::standardizePath (patchPath + _Entries[first].PatchName, false);
3446                 allowed.insert(correct);
3447         }
3448         // Delete file from tmp directory that are not "allowed" (torrent protocol can download partial file that are not asked)
3449         std::vector<std::string> vFiles;
3450         CPath::getPathContent(patchPath , true, false, true, vFiles);
3451         for (uint32 i = 0; i < vFiles.size(); ++i)
3452         {
3453                 std::string sName2 = CPath::standardizePath (vFiles[i], false);
3454                 if (allowed.find(sName2) == allowed.end() )
3455                 {
3456                         pPM->deleteFile(sName2 , false, false);
3457                 }
3458         }
3459
3460         static bool _FirstTime = true;
3461         static uint64 _FullSize = 0;
3462         static uint64 _CurrentSize = 0;
3463         static uint32 _Start;
3464
3465         // calculate size of data to download in order to know the install speed
3466         if (_FirstTime)
3467         {
3468                 for (uint first = 0,last = (uint)_Entries.size() ; first != last; ++first)
3469                 {
3470                         _FullSize += _Entries[first].Size;
3471                 }
3472                 _Start = NLMISC::CTime::getSecondsSince1970();
3473                 _FirstTime = false;
3474         }
3475
3476
3477         for (first = 0,last = (uint)_Entries.size() ; first != last; ++first)
3478         {
3479                 std::string patchName = CPath::standardizePath (patchPath +_Entries[first].PatchName, false);
3480                 std::string sourceName = CPath::standardizePath (_Entries[first].SourceName, false);
3481                 uint32 lastFileDate = _Entries[first].Timestamp;
3482
3483
3484                 _CurrentSize += _Entries[first].Size;
3485                 uint32 rate = 0;
3486                 // calcule the install speed
3487                 uint32 dt = NLMISC::CTime::getSecondsSince1970() - _Start;
3488                 if (dt)
3489                 {
3490                         uint64 size = _CurrentSize / dt;
3491                         rate = uint32 (size);
3492                 }
3493
3494                 // File can exists if bad BNP loading
3495                 if (NLMISC::CFile::fileExists(sourceName))
3496                 {
3497                         pPM->deleteFile(sourceName, false, false);
3498                 }
3499
3500                 if (NLMISC::CFile::fileExists(patchName))
3501                 {
3502                         static std::string zsStr = ".lzma";
3503                         static std::string::size_type zsStrLength = zsStr.size();
3504                         try
3505                         {
3506                                 // if file is compressed unpack the file (decompress, rename tempory file, apply modification date)
3507                                 if (patchName.size() >= zsStrLength
3508                                         && patchName.substr(patchName.size() - zsStrLength) == zsStr)
3509                                 {
3510                                         std::string outFilename = patchName.substr(0, patchName.size() - zsStrLength);
3511                                         std::string localOutFilename = CPath::standardizeDosPath(outFilename);
3512
3513                                         if ( unpackLZMA(patchName, localOutFilename) )
3514                                         {
3515                                                 pPM->deleteFile(patchName);
3516                                                 pPM->renameFile(outFilename, sourceName);
3517                                                 pPM->applyDate(sourceName, lastFileDate);
3518                                         }
3519                                         else
3520                                         {
3521                                                 throw NLMISC::Exception("Can not unpack");
3522                                         }
3523
3524                                 }
3525                                 else
3526                                 {
3527                                         // if file is uncompressed rename tempory file and apply modification date)
3528                                         pPM->renameFile(patchName, sourceName);
3529                                         pPM->applyDate(sourceName, lastFileDate);
3530                                 }
3531                         }
3532                         catch ( const std::exception& e)
3533                         {
3534                                 nlwarning("%s", e.what());
3535                                 pPM->setState(true, string(e.what()) );
3536                                 pPM->fatalError("uiCanNotInstall", patchName.c_str(), "");
3537                                 return;
3538
3539                         }
3540                         catch (...)
3541                         {
3542                                 pPM->fatalError("uiCanNotInstall", patchName.c_str(), "");
3543                                 return;
3544                         }
3545                 }
3546                 // update gui
3547                 pPM->onFileInstalling(sourceName, rate, first+1, last, _CurrentSize, _FullSize);
3548
3549         }
3550         // extract bnp
3551
3552         {
3553                 // remove date from tmp directory (because install is finished)
3554                 std::string install = CPath::standardizePath (ClientRootPath+TheTmpInstallDirectory);
3555
3556                 std::vector<std::string> vFiles;
3557                 // Delete all classic file from tmp directory
3558                 CPath::getPathContent(install, true, false, true, vFiles);
3559                 for (uint32 i = 0; i < vFiles.size(); ++i)
3560                 {
3561                         NLMISC::CFile::deleteFile(vFiles[i]);
3562                 }
3563                 // Delete all directory from tmp directory
3564                 do
3565                 {
3566                         vFiles.clear();
3567                         CPath::getPathContent(install, true, true, false, vFiles);
3568                         for (uint32 i = 0; i < vFiles.size(); ++i)
3569                         {
3570                                 NLMISC::CFile::deleteDirectory(vFiles[i]);
3571                         }
3572                 }
3573                 while ( !vFiles.empty() );
3574                 // delete tmp directory
3575                 NLMISC::CFile::deleteDirectory(install);
3576                 // delete libtorrent_logs directory if exist (not activate)
3577                 if (NLMISC::CFile::fileExists("libtorrent_logs"))
3578                 {
3579                         do
3580                         {
3581                                 vFiles.clear();
3582                                 CPath::getPathContent("libtorrent_logs", true, true, false, vFiles);
3583                                 for (uint32 i = 0; i < vFiles.size(); ++i)
3584                                 {
3585                                         NLMISC::CFile::deleteDirectory(vFiles[i]);
3586                                 }
3587                         }
3588                         while ( !vFiles.empty() );
3589                         NLMISC::CFile::deleteDirectory("libtorrent_logs");
3590                 }
3591
3592         }
3593
3594         pPM->reboot(); // do not reboot just run the extract .bat
3595 }