summaryrefslogtreecommitdiff
path: root/app/bin/paramfilelist.c
blob: f6703f3de7aadea3f9edee492352a2589de92f88 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
/** \file paramfilelist.c
 * Handling of the list of parameter files
 */

/*  XTrackCad - Model Railroad CAD
 *  Copyright (C) 2019 Martin Fischer
 *
 *  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 "common.h"
#include "compound.h"
#include "ctrain.h"
#include "custom.h"
#include "dynstring.h"
#include "fileio.h"
#include "layout.h"
#include "paths.h"
#include "include/paramfile.h"
#include "include/paramfilelist.h"
#include "common-ui.h"


dynArr_t paramFileInfo_da;

int curParamFileIndex = PARAM_DEMO;

static int log_params;
static int log_paramupdate;

static char * customPath;
static char * customPathBak;

#define FAVORITESECTION "Parameter File Favorites"
#define FAVORITETOTALS "Total"
#define FAVORITEKEY "Favorite%d"
#define	FAVORITEDELETED "Deleted%d"

int GetParamFileCount()
{
	return (paramFileInfo_da.cnt);
}

/**
 * Show parameter file  error message
 *
 * \param [in,out] file If non-null, the file.
 */

static void
ReadParamError(char *file)
{
	DynString error_msg;
	DynStringMalloc(&error_msg, 100);
	DynStringPrintf(&error_msg,
	                _("The parameter file: %s could not be found and was probably deleted or moved. "
	                  "The file is removed from the active parameter file list."),
	                file);
	wNoticeEx(NT_ERROR, DynStringToCStr(&error_msg), "OK", NULL);
	DynStringFree(&error_msg);
}


/**
 * Update the configuration file in case the name of a parameter file has changed.
 * The function reads a list of new parameter filenames and gets the contents
 * description for each file. If that contents is in use, i.e. is a loaded parameter
 * file, the setting in the config file is updated to the new filename.
 * First line of update file has the date of the update file.
 * * Following lines have filenames, one per line.
 *
 * \return FALSE if update not possible or not necessary, TRUE if update successful
 */

static BOOL_T UpdateParamFiles(void)
{
	char fileName[STR_LONG_SIZE], *fileNameP;
//  const char * cp;
	FILE * updateF;
	long updateTime = -1;
	long lastTime;

	MakeFullpath(&fileNameP, libDir, "xtrkcad.upd", NULL);
	updateF = fopen(fileNameP, "r");
	free(fileNameP);
	if (updateF == NULL) {
		return FALSE;
	}
	wPrefGetInteger("file", "updatetime", &lastTime, 0);

	while ((fgets(fileName, STR_LONG_SIZE, updateF)) != NULL) {
		if ( fileName[0] == '#' ) {
			continue;
		}
		if ( updateTime == -1 ) {
			updateTime = atol(fileName);
			LOG1( log_paramupdate, ( "UpdateParamFiles Last: %ld, Update: %ld\n", lastTime,
			                         updateTime ) );
			if ( updateTime == 0 ) {
				NoticeMessage( "xtrkcad.upd : invalid Update Time", _("OK"), NULL );
				fclose(updateF);
				return FALSE;
			}
			if (lastTime >= updateTime) {
				fclose(updateF);
				return FALSE;
			}
			continue;
		}
		FILE * paramF;

		Stripcr(fileName);
		InfoMessage(_("Updating %s"), fileName);
		LOG1( log_paramupdate, ( "Updating %s\n", fileName ) );
		MakeFullpath(&fileNameP, libDir, "params", fileName, NULL);
		paramF = fopen(fileNameP, "r");
		if (paramF == NULL) {
			NoticeMessage(MSG_PRMFIL_OPEN_NEW, _("Ok"), NULL, fileNameP);
			free(fileNameP);
			continue;
		}
		char * newContents = NULL;
		char * oldContents = NULL;
		while ((fgets(message, sizeof message, paramF)) != NULL) {
			if (strncmp(message, "CONTENTS ", 9) == 0) {
				Stripcr(message);
				if ( newContents == NULL ) {
					// first CONTENTS
					newContents = MyStrdup(message + 9);
					// Get old CONTENTS->FILENAME mapping
					char * cp = wPrefGetString("Parameter File Map", newContents);
					if ( cp ) {
						LOG1( log_paramupdate, ( "ParmUpdate:  Upd CONTENTS %s (was %s) -> %s\n",
						                         newContents,
						                         cp?cp:"<>", fileNameP ) );
					} else {
						LOG1( log_paramupdate, ( "ParmUpdate:  New CONTENTS %s\n", newContents ) );
					}
					// Update CONTENTS->FILENAME mapping
					wPrefSetString("Parameter File Map", newContents, fileNameP);
				} else {
					// Subsequent old CONTENTS
					oldContents = message + 9;
					LOG1( log_paramupdate, ( "  Old CONTENTS %s\n", oldContents ) );
					// Check 'Parameter Files Names' map
					for (int fileNo = 1; ; fileNo++) {
						char fileNoS[4+9+1];
						sprintf(fileNoS, "File%d", fileNo);
						char * prevContents = wPrefGetString("Parameter File Names", fileNoS);
						if (prevContents == NULL || *prevContents == '\0') {
							// End of list
							break;
						}
						if ( strcmp( oldContents, prevContents ) == 0 ) {
							// Update contents index map
							LOG1( log_paramupdate, ( "ParamUpdate:  Found at %s -> %s\n", fileNoS,
							                         newContents ) );
							wPrefSetString( "Parameter File Names", fileNoS, newContents );
							break;
						}
					}
				}
			}
		}
		if ( newContents ) {
			MyFree( newContents );
		}
		fclose(paramF);
		if (newContents == NULL) {
			NoticeMessage(MSG_PRMFIL_NO_CONTENTS, _("Ok"), NULL, fileNameP);
		}

		free(fileNameP);
	}
	fclose(updateF);
	LOG1( log_paramupdate, ( "Param updatetime -> %d\n", updateTime ) );
	wPrefSetInteger("file", "updatetime", updateTime);
	return TRUE;
}

/**
 * Read the list of parameter files from configuration and load the files.
 *
 */
void LoadParamFileList(void)
{
	int fileNo;
	BOOL_T updated = FALSE;
	long *favoriteList = NULL;
	long favorites;
	int nextFavorite = 0;

	updated = UpdateParamFiles();

	wPrefGetIntegerBasic(FAVORITESECTION, FAVORITETOTALS, &favorites, 0);
	if (favorites) {
		DynString topic;
		favoriteList = MyMalloc(sizeof(long)*favorites);

		DynStringMalloc(&topic, 16);
		for (int i = 0; i < favorites; i++) {
			DynStringPrintf(&topic, FAVORITEKEY, i);
			wPrefGetIntegerBasic(FAVORITESECTION, DynStringToCStr(&topic), &favoriteList[i],
			                     0);
		}
		DynStringFree(&topic);
	}

	for (fileNo = 1; ; fileNo++) {
		char *fileName;
		const char * contents;
//      enum paramFileState structState = PARAMFILE_UNLOADED;


		sprintf(message, "File%d", fileNo);
		contents = wPrefGetString("Parameter File Names", message);
		if (contents == NULL || *contents == '\0') {
			break;
		}
		InfoMessage("Parameters for %s", contents);
		fileName = wPrefGetString("Parameter File Map", contents);
		if (fileName == NULL || *fileName == '\0') {
			NoticeMessage(MSG_PRMFIL_NO_MAP, _("Ok"), NULL, contents);
			continue;
		}
		char * share;

		// Rewire to the latest system level
#define SHAREPARAMS (PATH_SEPARATOR "share" PATH_SEPARATOR "xtrkcad" PATH_SEPARATOR "params" PATH_SEPARATOR)
#define SHAREBETAPARAMS (PATH_SEPARATOR "share" PATH_SEPARATOR "xtrkcad-beta" PATH_SEPARATOR "params" PATH_SEPARATOR)
		if ((share= strstr(fileName,SHAREPARAMS))) {
			share += strlen(SHAREPARAMS);
		}
#ifndef WINDOWS
#ifndef __APPLE__
		if ( share == NULL &&
		     (share= strstr(fileName,SHAREBETAPARAMS))) {
			share += strlen(SHAREBETAPARAMS);
		}
#endif
#endif
		if ( share ) {
			MakeFullpath(&fileName, wGetAppLibDir(), "params", share, NULL);
			LOG1( log_paramupdate, ( "Param LoadParamList: %s -> %s\n", contents,
			                         fileName ) );
			wPrefSetString("Parameter File Map", contents, fileName);
		}

		if (ReadParamFile(fileName) >= 0) {

			if (curContents == NULL) {
				curContents = curSubContents = MyStrdup(contents);
			}
			paramFileInfo(curParamFileIndex).contents = curContents;
			if (favoriteList && fileNo == favoriteList[nextFavorite]) {
				DynString topic;
				long deleted;
				DynStringMalloc(&topic, 16);
				DynStringPrintf(&topic, FAVORITEDELETED, fileNo);

				wPrefGetIntegerBasic(FAVORITESECTION, DynStringToCStr(&topic), &deleted, 0L);
				paramFileInfo(curParamFileIndex).favorite = TRUE;
				paramFileInfo(curParamFileIndex).deleted = deleted;
				if (nextFavorite < favorites - 1) {
					nextFavorite++;
				}
				DynStringFree(&topic);
			}
		} else {
			ReadParamError(fileName);
		}
	}
	curParamFileIndex = PARAM_CUSTOM;
	if (updated) {
		SaveParamFileList();
	}

	MyFree(favoriteList);
}

/**
 * Save the currently selected parameter files. Parameter files that have been unloaded
 * are not saved.
 *
 */

void SaveParamFileList(void)
{
	int fileInx;
	int fileNo;
	int favorites;
	char * contents, *cp;

	for (fileInx = 0, fileNo = 1, favorites = 0; fileInx < paramFileInfo_da.cnt;
	     fileInx++) {
		if (paramFileInfo(fileInx).valid && (!paramFileInfo(fileInx).deleted ||
		                                     paramFileInfo(fileInx).favorite)) {
			sprintf(message, "File%d", fileNo);
			contents = paramFileInfo(fileInx).contents;
			for (cp = contents; *cp; cp++) {
				if (*cp == '=' || *cp == '\'' || *cp == '"' || *cp == ':' || *cp == '.') {
					*cp = ' ';
				}
			}
			LOG1( log_paramupdate, ( "Param SaveFileList:  %s -> %s\n", message,
			                         contents ) );
			wPrefSetString("Parameter File Names", message, contents);
			LOG1( log_paramupdate, ( "Param                %s -> %s\n", contents,
			                         paramFileInfo(fileInx).name ) );
			wPrefSetString("Parameter File Map", contents, paramFileInfo(fileInx).name);
			if (paramFileInfo(fileInx).favorite) {
				sprintf(message, FAVORITEKEY, favorites);
				LOG1( log_paramupdate, ( "Param Favorite                %s -> %d\n", message,
				                         fileNo ) );
				wPrefSetInteger(FAVORITESECTION, message, fileNo);
				sprintf(message, FAVORITEDELETED, fileNo);
				LOG1( log_paramupdate, ( "Param                        %s -> %d\n", message,
				                         paramFileInfo(fileInx).deleted ) );
				wPrefSetInteger(FAVORITESECTION, message, paramFileInfo(fileInx).deleted);
				favorites++;
			}
			fileNo++;
		}
	}
	sprintf(message, "File%d", fileNo);
	LOG1( log_paramupdate, ( "Param SaveFileList:  %s -> <>\n", message ) );
	wPrefSetString("Parameter File Names", message, "");
	LOG1( log_paramupdate, ( "Param Favorite       %s -> %d\n", FAVORITETOTALS,
	                         favorites ) );
	wPrefSetInteger(FAVORITESECTION, FAVORITETOTALS, favorites);
}

void
UpdateParamFileList(void)
{
	for (size_t i = 0; i < (unsigned)paramFileInfo_da.cnt; i++) {
		SetParamFileState((int)i);
	}
}



/**
 * Load the selected parameter files. This is a callback executed when the file selection dialog
 * is closed.
 * Steps:
 * - the parameters are read from file
 * - check is performed to see whether the content is already present, if yes the previously
 * loaded content is invalidated
 * - loaded parameter file is added to list of parameter files
 * - if a parameter file dialog exists the list is updated. It is either rewritten in
 * in case of an invalidated file or the new file is appended
 * - the settings are updated
 * These steps are repeated for every file in list
 *
 * \param files IN the number of filenames in the fileName array
 * \param fileName IN an array of fully qualified filenames
 * \param data IN ignored
 * \return  TRUE on success, FALSE on error
 */

int LoadParamFile(
        int files,
        char ** fileName,
        void * data)
{
	wIndex_t inx;
	int i = 0;

	CHECK(fileName != NULL);
	CHECK(files > 0);

	for (i = 0; i < files; i++) {
//      enum paramFileState structState = PARAMFILE_UNLOADED;
		int newIndex;

		curContents = curSubContents = NULL;

		newIndex = ReadParamFile(fileName[i]);
		if (newIndex >= 0) {
			// in case the contents is already present, make invalid
			for (inx = 0; inx < newIndex; inx++) {
				if (paramFileInfo(inx).valid &&
				    strcmp(paramFileInfo(inx).contents, curContents) == 0) {
					paramFileInfo(inx).valid = FALSE;
					break;
				}
			}

			LOG1( log_paramupdate, ( "Param Load: %s -> %s\n", curContents,
			                         paramFileInfo(curParamFileIndex).name) );
			wPrefSetString("Parameter File Map", curContents,
			               paramFileInfo(curParamFileIndex).name);
		} else {
			ReadParamError(fileName[i]);
		}
	}
	//Only set the ParamFileDir if not the system directory
	if ( (!strstr(fileName[i-1],SHAREPARAMS))
#ifndef WINDOWS
#ifndef __APPLE__
	     && (!strstr(fileName[i-1],SHAREBETAPARAMS))
#endif
#endif
	   ) {
		SetParamFileDir(fileName[i - 1]);
	}
	curParamFileIndex = PARAM_CUSTOM;
	DoChangeNotification(CHANGE_PARAMS);
	return TRUE;
}

static void ReadCustom(void)
{
	FILE * f;
	MakeFullpath(&customPath, workingDir, sCustomF, NULL);
	customPathBak = MyStrdup(customPath);
	customPathBak[ strlen(customPathBak)-1 ] = '1';
	f = fopen(customPath, "r");
	if (f != NULL) {
		fclose(f);
		curParamFileIndex = PARAM_CUSTOM;
		ReadParams(0, workingDir, sCustomF);
	}
}


/**
 * Open the custom file where user-defined turnouts, cars and such are stored
 */

FILE * OpenCustom(char *mode)
{
	FILE * ret = NULL;

	if (inPlayback) {
		return NULL;
	}
	if (*mode == 'w') {
		rename(customPath, customPathBak);
	}
	if (customPath) {
		ret = fopen(customPath, mode);
		if (ret == NULL) {
			NoticeMessage(MSG_OPEN_FAIL, _("Continue"), NULL, _("Custom"), customPath,
			              strerror(errno));
		}
	}

	return ret;
}
/**
 * Update and open the parameter files dialog box
 *
 * \param junk
 */

static void DoParamFileListDialog(void *junk)
{
	DoParamFiles(junk);
	ParamFileListLoad(paramFileInfo_da.cnt, &paramFileInfo_da);

}

addButtonCallBack_t ParamFilesInit(void)
{
	RegisterChangeNotification(ParamFilesChange);
	return &DoParamFileListDialog;
}

/**
 * Get the initial parameter files. The Xtrkcad.xtq file containing scale and
 * demo definitions is read.
 *
 * \return FALSE on error, TRUE otherwise
 */
BOOL_T ParamFileListInit(void)
{
	/** @logcmd @showrefby params=n paramfilelist.c Log ReadParams
	 * (including scale file (xtq), custom file (*.cus) and other params (xtp))
	 */
	log_params = LogFindIndex("params");
	log_paramupdate = LogFindIndex("paramupdate");

	SetCLocale();
	// get the default definitions
	if (ReadParams(lParamKey, libDir, sParamQF) == FALSE) {
		SetUserLocale();
		return FALSE;
	}

	curParamFileIndex = PARAM_CUSTOM;

	if (lParamKey == 0) {
		LoadParamFileList();
		ReadCustom();
	}

	SetUserLocale();
	return TRUE;

}

/**
 * Deletes all parameter types described by index
 *
 * \param  index Zero-based index of the.
 */

static void
DeleteAllParamTypes(int index)
{

	DeleteTurnoutParams(index);
	DeleteCarProto(index);
	DeleteCarPart(index);
	DeleteStructures(index);
}


/**
 * Unload parameter file: all parameter definitions from this file are deleted
 * from memory. Strings allocated to store the filename and contents
 * description are free'd as well.
 * In order to keep the overall data structures consistent, the file info
 * structure is not removed from the array but flagged as garbage
 *
 * \param  fileIndex Zero-based index of the file.
 *
 * \returns True if it succeeds, false if it fails.
 */

bool
UnloadParamFile(wIndex_t fileIndex)
{
	paramFileInfo_p paramFileI = &paramFileInfo(fileIndex);

	DeleteAllParamTypes(fileIndex);

	MyFree(paramFileI->name);
	MyFree(paramFileI->contents);

	paramFileI->valid = FALSE;

	for (int i = 0; i < paramFileInfo_da.cnt; i++) {
		LOG1(log_params, ("UnloadParamFiles: = %s: %d\n", paramFileInfo(i).contents,
		                  paramFileInfo(i).trackState))
	}

	return (true);
}

/**
 * Reload parameter file
 *
 * \param  index Zero-based index of the paramFileInfo struct.
 *
 * \returns True if it succeeds, false if it fails.
 */

bool
ReloadParamFile(wIndex_t index)
{
	paramFileInfo_p paramFileI = &paramFileInfo(index);

	DeleteAllParamTypes(index);
	MyFree(paramFileI->contents);

	ReloadDeletedParamFile(index);

	return(true);
}