gzip ISO: allow custom index file name/location via a template

At PCSX2_ui.ini: default:  GzipIsoIndexTemplate=$(f).pindex.tmp
The rules:
- must contain one and only one instance of '$(f)' (without the quotes)
- if starts with $(f) then it expands to the full path + file name.
- if doesn't start with $(f) then the path is ignored (name+ext only)
- if doesn't start with $(f) and ends up relative,
  then it's relative to pcsx2.exe (not to cwd)
- No checks are performed if the result file name can be created, so the dir
  should exist.
- PCSX2 will not try to rename/move older index files to the new name/location.
  If it's modified - the user should take care of rename/move before loading
  gzipped iso files or else it will create a new index according to the template

Examples:
$(f).pindex.tmp - the default - same dir as the iso, loads older index files.
$(f).pindex     - a popular request.
cache.gz/$(f)   - relative to pcsx2.exe (if the dir exists).
%appdata%/pcsx2/cache.gz/$(f) - should end up at the default install docs dir.

pcsx2/CDVD/CompressedFileReader.cpp

@@ -14,6 +14,8 @@
 */
 
 #include "PrecompiledHeader.h"
+#include <wx/stdpaths.h>
+#include "AppConfig.h"
 #include "AsyncFileReader.h"
 
 #include "zlib_indexed.h"
@@ -177,17 +179,80 @@ int ChunksCache::Read(void* pDest, PX_off_t offset, int length) {
 	return -1;
 }
 
+static wxString INDEX_TEMPLATE_KEY(L"$(f)");
+// template:
+// must contain one and only one instance of '$(f)' (without the quotes)
+// if if !canEndWithKey -> must not end with $(f)
+// if starts with $(f) then it expands to the full path + file name.
+// if doesn't start with $(f) then it's expanded to file name only (with extension)
+// if doesn't start with $(f) and ends up relative,
+//   then it's relative to base (not to cwd)
+// No checks are performed if the result file name can be created.
+// If this proves useful, we can move it into Path:: . Right now there's no need.
+static wxString ApplyTemplate(const wxString &name, const wxDirName &base,
+                              const wxString &fileTemplate, const wxString &filename,
+                              bool canEndWithKey)
+{
+	wxString tem(fileTemplate);
+	wxString key = INDEX_TEMPLATE_KEY;
+	tem = tem.Trim(true).Trim(false); // both sides
 
-static wxString iso2indexname(const wxString& isoname) {
+	int first = tem.find(key);
-	return isoname + L".pindex.tmp";
+	if (first < 0 // not found
+	    || first != tem.rfind(key) // more than one instance
+	    || !canEndWithKey && first == tem.length() - key.length())
+	{
+		Console.Error(L"Invalid %s template '%s'.\n"
+		              L"Template must contain exactly one '%s' and must not end with it. Abotring.",
+		              name.c_str(), tem.c_str(), key.c_str());
+		return L"";
+	}
+
+	wxString fname(filename);
+	if (first > 0)
+		fname = Path::GetFilename(fname); // without path
+
+	tem.Replace(key, fname);
+	if (first > 0)
+		tem = Path::Combine(base, tem); // ignores appRoot if tem is absolute
+
+	return tem;
 }
 
-static void WarnOldIndex(const wxString& filename) {
+/*
-	wxString oldName = filename + L".pcsx2.index.tmp";
+static void TestTemplate(const wxDirName &base, const wxString &fname, bool canEndWithKey)
-	if (wxFileName::FileExists(oldName)) {
+{
-		Console.Warning("Note: Unused old index detected, please delete it manually: '%s'", (const char*)oldName.To8BitData());
+	const char *ins[] = {
+		"$(f).pindex.tmp",                    // same folder as the original file
+		"	$(f).pindex.tmp ",                // same folder as the original file (trimmed silently)
+		"cache/$(f).pindex",                  // relative to base
+		"../$(f).pindex",                     // relative to base
+		"%appdata%/pcsx2/cache/$(f).pindex",  // c:/Users/<user>/AppData/Roaming/pcsx2/cache/ ...
+		"c:\\pcsx2-cache/$(f).pindex",        // absolute
+		"~/.cache/$(f).pindex",	              // TODO: check if this works on *nix. It should...
+		                                      //       (on windows ~ isn't recognized as special)
+		"cache/$(f)/$(f).index",              // invalid: appears twice
+		"hello",                              // invalid: doesn't contain $(f)
+		"hello$(f)",                          // invalid, can't end with $(f)
+		NULL
+	};
+
+	for (int i = 0; ins[i]; i++) {
+		wxString tem(wxString::From8BitData(ins[i]));
+		Console.WriteLn(Color_Green, L"test: '%s' -> '%s'",
+		                tem.c_str(),
+		                ApplyTemplate(L"test", base, tem, fname, canEndWithKey).c_str());
 	}
 }
+*/
+
+static wxString iso2indexname(const wxString& isoname) {
+	//testTemplate(isoname);
+	wxDirName appRoot = // TODO: have only one of this in PCSX2. Right now have few...
+	    (wxDirName)(wxFileName(wxStandardPaths::Get().GetExecutablePath()).GetPath());
+	//TestTemplate(appRoot, isoname, false);
+	return ApplyTemplate(L"gzip index", appRoot, g_Conf->GzipIsoIndexTemplate, isoname, false);
+}
 
 #define SPAN_DEFAULT (1048576L * 4)   /* distance between direct access points when creating a new index */
 #define READ_CHUNK_SIZE (256 * 1024)  /* zlib extraction chunks size (at 0-based boundaries) */
@@ -275,8 +340,9 @@ bool GzippedFileReader::OkIndex() {
 		return true;
 
 	// Try to read index from disk
-	WarnOldIndex(m_filename);
 	wxString indexfile = iso2indexname(m_filename);
+	if (indexfile.length() == 0)
+		return false; // iso2indexname(...) will print errors if it can't apply the template
 
 	if (wxFileName::FileExists(indexfile) && (m_pIndex = ReadIndexFromFile(indexfile))) {
 		Console.WriteLn(Color_Green, "OK: Gzip quick access index read from disk: '%s'", (const char*)indexfile.To8BitData());

pcsx2/gui/AppConfig.cpp

@@ -544,6 +544,8 @@ AppConfig::AppConfig()
 		Mcd[slot].Enabled	= !FileMcd_IsMultitapSlot(slot);	// enables main 2 slots
 		Mcd[slot].Filename	= FileMcd_GetDefaultName( slot );
 	}
+
+	GzipIsoIndexTemplate = L"$(f).pindex.tmp";
 }
 
 // ------------------------------------------------------------------------
@@ -634,6 +636,7 @@ void AppConfig::LoadSaveRootItems( IniInterface& ini )
 	ini.EnumEntry( L"LanguageId", LanguageId, NULL, LanguageId );
 	IniEntry( LanguageCode );
 	IniEntry( RecentIsoCount );
+	IniEntry( GzipIsoIndexTemplate );
 	IniEntry( DeskTheme );
 	IniEntry( Listbook_ImageSize );
 	IniEntry( Toolbar_ImageSize );

pcsx2/gui/AppConfig.h

@@ -295,6 +295,7 @@ public:
 	// Memorycard options - first 2 are default slots, last 6 are multitap 1 and 2
 	// slots (3 each)
 	McdOptions				Mcd[8];
+	wxString				GzipIsoIndexTemplate; // for quick-access index with gzipped ISO
 
 	ConsoleLogOptions		ProgLogBox;
 	FolderOptions			Folders;