/* Copyright (C) 2009-2010 wxLauncher Team This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #include "generated/configure_launcher.h" #include "datastructures/FSOExecutable.h" #include #include #include "global/MemoryDebugging.h" // on linux these seem to be defined to be gnu_dev_* #ifdef major #undef major #endif #ifdef minor #undef minor #endif enum BuildCapabilities_enum { SUPPORT_OPENAL = 1<<0, NOT_SUPPORT_DIRECT3D = 1<<1, } BuildCapabilities; FSOExecutable::FSOExecutable(): major(0), minor(0), revision(0), inferno(false), sse(0), _64bit(false), configuration(CONFIG_RELEASE), build(0), year(0), month(0), antipodes(false),antNumber(0), buildCaps(0) { } FSOExecutable::~FSOExecutable() { } bool FSOExecutable::SupportsDirect3D() { return (buildCaps & NOT_SUPPORT_DIRECT3D) == 0; } bool FSOExecutable::SupportsOpenAL() { return (buildCaps & SUPPORT_OPENAL) > 0; } bool FSOExecutable::IsRootFolderValid(const wxFileName& path, bool quiet) { if ( !path.IsOk() ) { if (!quiet) { wxLogError(_T(" New root folder %s is not OK"), path.GetFullPath().c_str()); } return false; } if ( path.GetPath().IsEmpty() ) { if (!quiet) { wxLogError(_T(" Root folder %s is empty"), path.GetFullPath().c_str()); } return false; } return HasFSOExecutables(path); } bool FSOExecutable::HasFSOExecutables(const wxFileName& path) { wxCHECK_MSG(path.IsOk(), false, wxString::Format(_T("provided path %s to HasFSOExecutables is invalid"), path.GetFullPath().c_str())); return !FSOExecutable::GetBinariesFromRootFolder(path, true).IsEmpty(); } #if IS_LINUX bool IsFileToIgnore(const wxString& filename) { return filename.EndsWith(_T(".exe")) || filename.EndsWith(_T(".map")) || filename.EndsWith(_T(".pdb")) || filename.EndsWith(_T(".app")) || filename.EndsWith(_T(".ini")) || filename.EndsWith(_T(".tar")) || filename.EndsWith(_T(".gz")) || filename.EndsWith(_T(".bz2")) || filename.EndsWith(_T(".tgz")) || filename.EndsWith(_T(".tbz")) || filename.EndsWith(_T(".tbz2")); } #endif #if IS_WIN32 #define EXECUTABLE_GLOB_PATTERN _T("fs2_*.exe") #define FRED_EXECUTABLE_GLOB_PATTERN _T("fred2_*.exe") #elif IS_LINUX #define EXECUTABLE_GLOB_PATTERN _T("fs2_*") #define FRED_EXECUTABLE_GLOB_PATTERN _T("fred2_*") #elif IS_APPLE #define EXECUTABLE_GLOB_PATTERN _T("fs2_*.app") #define FRED_EXECUTABLE_GLOB_PATTERN _T("fred2_*.app") #else #error "One of IS_WIN32, IS_LINUX, IS_APPLE must evaluate to true" #endif // quiet is for when you just want to check whether there are FSO/FRED binaries wxArrayString FSOExecutable::GetBinariesFromRootFolder(const wxFileName& path, bool quiet) { return FSOExecutable::GetBinariesFromRootFolder(path, EXECUTABLE_GLOB_PATTERN, quiet); } wxArrayString FSOExecutable::GetFredBinariesFromRootFolder(const wxFileName& path, bool quiet) { return FSOExecutable::GetBinariesFromRootFolder(path, FRED_EXECUTABLE_GLOB_PATTERN, quiet); } wxArrayString FSOExecutable::GetBinariesFromRootFolder(const wxFileName& path, const wxString& globPattern, bool quiet) { wxArrayString files; // Check args because this function gets crap tossed at it to validate wxString pathStr(path.GetPath()); if (pathStr.IsEmpty()) { wxLogInfo(wxT("GetBinaries called with empty root folder")); return files; } wxDir folder(pathStr); if (!folder.IsOpened()) { wxLogInfo(wxT("GetBinaries called on '%s' which cannot be opened"), pathStr.c_str()); return files; } wxString filename; #if IS_APPLE // Binaries are directories on OSX. bool cont = folder.GetFirst(&filename, globPattern, wxDIR_DIRS); #else bool cont = folder.GetFirst(&filename, globPattern, wxDIR_FILES); #endif while (cont) { #if IS_LINUX if ( !IsFileToIgnore(filename) ) { #endif files.Add(filename); #if IS_LINUX } #endif cont = folder.GetNext(&filename); } // filter out launcher binaries (at least on OSX) for (int i = files.GetCount() - 1; i >= 0; --i) { if (files[i].Lower().Find(_T("launcher")) != wxNOT_FOUND) { files.RemoveAt(i); } } #if IS_APPLE // find actual (Unix) executable inside .app bundle and call the path to it the "executable" for (wxArrayString::iterator it = files.begin(), end = files.end(); it != end; ++it) { wxString pathToBin = wxDir::FindFirst(path.GetPath(wxPATH_GET_SEPARATOR) + *it + _T("/Contents/MacOS"), _T("*"), wxDIR_FILES); pathToBin.Replace(path.GetPath(wxPATH_GET_SEPARATOR), _T("")); *it = pathToBin; } #endif if (!quiet) { wxString execType = globPattern.Lower().Find(_T("fred")) == wxNOT_FOUND ? _T("FS2") : _T("FRED2"); wxLogInfo(_T(" Found %u %s Open executables in '%s'"), static_cast(files.GetCount()), execType.c_str(), path.GetPath().c_str()); for (size_t i = 0, n = files.GetCount(); i < n; ++i) { wxLogDebug(_T("Found executable: %s"), files.Item(i).c_str()); } } return files; } FSOExecutable FSOExecutable::GetBinaryVersion(wxString binaryname) { wxLogDebug(_T("Making version struct for the executable '%s'"), binaryname.c_str()); FSOExecutable ver; wxStringTokenizer tok(binaryname, _T("_.- ()[]/")); ver.executablename = binaryname; if ( !tok.HasMoreTokens() ) { wxLogError( _T("Did not find initial 'fs2' or 'fred2' token in executable '%s'"), binaryname.c_str()); return ver; } wxString first(tok.GetNextToken()); if ( tok.HasMoreTokens() && (!first.CmpNoCase(_T("fred2")) || !first.CmpNoCase(_T("fs2"))) ) { wxString second(tok.GetNextToken()); if ( !second.CmpNoCase(_T("open")) ) { if ( !first.CmpNoCase(_T("fs2")) ) { ver.binaryname = _T("FS2 Open"); } else { ver.binaryname = _T("FRED2 Open"); } } else { wxLogWarning(_T("was expecting 'open'; got %s in executable %s"), second.c_str(), binaryname.c_str()); return ver; } } else { wxLogWarning(_T("executable name '%s' too short"), binaryname.c_str()); return ver; } while ( tok.HasMoreTokens() ) { wxString token = tok.GetNextToken(); wxString temp; long tempVersion; if (token.IsEmpty()) { // can happen in OS X nightly debug builds // do nothing } else if ( !token.CmpNoCase(_T("exe")) ) { ; // do nothing #if IS_APPLE } else if ( !token.CmpNoCase(_T("app")) ) { break; // we've reached the end of the app name #endif } else if (token.ToLong(&tempVersion) && token.size() == 8) { // must be a date from a nightly build; add it to the string if (!ver.string.IsEmpty()) { ver.string += _T(" "); } wxString year(token.Mid(0, 4)); wxString month(token.Mid(4, 2)); wxString day(token.Mid(6, 2)); year.ToLong(&ver.year); year.ToLong(&ver.month); // not interested in the day at this time // add it in YYYY-MM-DD format ver.string += year; ver.string += _T("-"); ver.string += month; ver.string += _T("-"); ver.string += day; } else if ( (ver.year > 2015 || (ver.year == 2015 && ver.month > 5)) && token.size() == 7 && SmellsLikeGitCommitHash(token)) { // must be a commit hash on a nightly build if (ver.string.size() > 0) { ver.string += _T(' '); } ver.string += token; } else if (token.ToLong(&tempVersion) && ver.antipodes && ver.antNumber == 0) { // must be antipodes number if ( tempVersion > 0 ) { ver.antNumber = (int)tempVersion; } else { wxLogWarning( _T("antipodes number out of range (%ld) in executable %s"), tempVersion, binaryname.c_str()); } } else if ( token.ToLong(&tempVersion) && ver.major == 0 ) { // must be major version number if ( tempVersion < 1000 && tempVersion > 0 ) { ver.major = (int)tempVersion; } else { wxLogWarning( _T("major version number out of range (%ld) in executable %s"), tempVersion, binaryname.c_str()); } } else if ( token.ToLong(&tempVersion) && ver.minor == 0 ) { // must be minor version number if ( tempVersion < 1000 && tempVersion >= 0 ) { ver.minor = (int)tempVersion; } else { wxLogWarning( _T("minor version number out of range (%ld) in executable %s"), tempVersion, binaryname.c_str()); } } else if ( token.ToLong(&tempVersion) && ver.revision == 0) { // must be revision version number if ( tempVersion < 1000 && tempVersion >= 0 ) { ver.revision = (int)tempVersion; } else { wxLogWarning( _T("Revision version number out of range (%ld) in executable %s"), tempVersion, binaryname.c_str()); } } else if ( !token.CmpNoCase(_T("d")) || !token.CmpNoCase(_T("debug")) ) { ver.configuration = CONFIG_DEBUG; } else if ( !token.CmpNoCase(_T("FastDbg")) ) { ver.configuration = CONFIG_FASTDEBUG; } else if ( token.Lower().EndsWith(_T("d"), &temp) ) { if ( temp.ToLong(&tempVersion) ) { // is the revision version number if ( tempVersion < 1000 && tempVersion >= 0 ) { ver.revision = (int)tempVersion; ver.configuration = CONFIG_DEBUG; } else { wxLogWarning( _T("Revision version number out of range (%ld) in executable %s"), tempVersion, binaryname.c_str()); } } else { wxLogWarning( _T("Token ending in 'd' is not a number (%s) in executable %s"), token.c_str(), binaryname.c_str()); ver.string += wxString::Format(ver.string.IsEmpty() ? _T("%s") : _T(" %s") , token.c_str()); } } else if ( token.Lower().EndsWith(_T("r"), &temp) ) { if (temp.IsEmpty()) { // do nothing, the 'r' wasn't preceded by a number } else if ( temp.ToLong(&tempVersion) ) { // is the revision version number if ( tempVersion < 1000 && tempVersion >= 0 ) { ver.revision = (int)tempVersion; ver.configuration = CONFIG_RELEASE; } else { wxLogWarning( _T("Revision version number out of range (%ld) in executable %s"), tempVersion, binaryname.c_str()); } } else { wxLogWarning( _T("Token ending in 'r' is not a number (%s) in executable %s"), token.c_str(), binaryname.c_str()); ver.string += wxString::Format(ver.string.IsEmpty() ? _T("%s") : _T(" %s"), token.c_str()); } } else if ( token.StartsWith(_T("r"), &temp) && temp.ToLong(&tempVersion) ) { // must be a revision number from SirKnightly's builds if ( tempVersion > 0 ) { ver.build = (int)tempVersion; } else { wxLogWarning( _T("SirKnightly build number out of range (%ld) in executable %s"), tempVersion, binaryname.c_str()); } } else if ( !token.CmpNoCase(_T("ant")) ) { ver.antipodes = true; } else if ( token.Lower().StartsWith(_T("ant"), &temp) && !ver.antipodes ) { ver.antipodes = true; // in case the token is of the format, e.g., "Ant8" long antNumber; if (temp.ToLong(&antNumber)) { if (antNumber > 0) { ver.antNumber = antNumber; } else { wxLogWarning(_T("Invalid antipodes number %ld in executable %s"), antNumber, binaryname.c_str()); } } } else if ( !token.CmpNoCase(_T("avx")) ) { ver.sse = 3; } else if ( !token.CmpNoCase(_T("sse2")) ) { ver.sse = 2; } else if ( !token.CmpNoCase(_T("sse")) ) { if (ver.string.Lower().EndsWith(_T("no"))) { // probably NO SSE ver.sse = -1; const int lastSpaceIndex = ver.string.Find(_T(' '), true); if (lastSpaceIndex == wxNOT_FOUND) { wxASSERT(ver.string.Lower() == _T("no")); ver.string = wxEmptyString; } else { ver.string = ver.string.Mid(0, lastSpaceIndex); } } else { ver.sse = 1; } } else if ( !token.CmpNoCase(_T("inf")) || !token.CmpNoCase(_T("inferno"))) { ver.inferno = true; } else if ( !token.CmpNoCase(_T("x64")) ) { ver._64bit = true; } else { if (!ver.string.IsEmpty()) { ver.string += _T(" "); } ver.string += token; } } return ver; } /** Returns the version string to display to the user from a previously parsed FSOVersion object. The intention is to display all information that is normally encoded into the executable's file name into a long string that more user friendly. The resulting string looks something like this: \verbatim FS2 Open Antipodes 4 Debug SSE2 FS2 Open 3.6.10 Inferno SSE FRED2 Open 3.6.11 Debug \endverbatim */ wxString FSOExecutable::GetVersionString() const { const bool hasVersion = (this->major != 0) || this->antipodes; const bool useFullVersion = hasVersion && !this->antipodes; // just to improve code readability wxString antipodesStr; if (this->antipodes) { antipodesStr += _T(" Antipodes"); if (this->antNumber != 0) { antipodesStr += wxString::Format(_T(" %d"), antNumber); } } // again, to improve code readability wxString sseStr; switch (this->sse) { case -1: sseStr = _T(" NO SSE"); break; case 1: sseStr = _T(" SSE"); break; case 2: sseStr = _T(" SSE2"); break; case 3: sseStr = _T(" AVX"); break; default: // nothing break; } wxString configString; switch(this->configuration) { case CONFIG_RELEASE: configString = _T(""); break; case CONFIG_DEBUG: configString = _T(" Debug"); break; case CONFIG_FASTDEBUG: configString = _T(" Fast Debug"); break; default: configString = _T(""); break; } return wxString::Format(_T("%s%s%s%s%s%s%s%s%s"), (this->binaryname.IsEmpty()) ? _T("Unknown") : this->binaryname.c_str(), // FS2 Open (useFullVersion) ? wxString::Format(_T(" %d.%d.%d"), this->major, this->minor, this->revision).c_str() : wxEmptyString, (this->antipodes) ? antipodesStr.c_str() : wxEmptyString, (this->build == 0) ? wxEmptyString : wxString::Format((hasVersion) ? _T(" (Build %d)") : _T(" Build %d"), this->build).c_str(), (this->string.IsEmpty()) ? wxEmptyString : wxString::Format((hasVersion) ? _T(" (%s)") : _T(" %s"), this->string.c_str()).c_str(), configString.c_str(), (this->inferno && !this->antipodes) ? _T(" Inferno") : wxEmptyString, (this->sse == 0) ? wxEmptyString : sseStr.c_str(), (this->_64bit) ? _T(" 64-bit") : wxEmptyString ); } bool FSOExecutable::SmellsLikeGitCommitHash(const wxString & str) { auto c = str.begin(); while (c != str.end()) { switch (int(*c)) { case _T('0'): case _T('1'): case _T('2'): case _T('3'): case _T('4'): case _T('5'): case _T('6'): case _T('7'): case _T('8'): case _T('9'): case _T('a'): case _T('b'): case _T('c'): case _T('d'): case _T('e'): case _T('f'): break; default: return false; } c++; } return true; }