keyfile.c 12.6 KB
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
/*
 * "Software pw3270, desenvolvido com base nos códigos fontes do WC3270  e X3270
 * (Paul Mattes Paul.Mattes@usa.net), de emulação de terminal 3270 para acesso a
 * aplicativos mainframe. Registro no INPI sob o nome G3270.
 *
 * Copyright (C) <2008> <Banco do Brasil S.A.>
 *
 * Este programa é software livre. Você pode redistribuí-lo e/ou modificá-lo sob
 * os termos da GPL v.2 - Licença Pública Geral  GNU,  conforme  publicado  pela
 * Free Software Foundation.
 *
 * Este programa é distribuído na expectativa de  ser  útil,  mas  SEM  QUALQUER
 * GARANTIA; sem mesmo a garantia implícita de COMERCIALIZAÇÃO ou  de  ADEQUAÇÃO
 * A QUALQUER PROPÓSITO EM PARTICULAR. Consulte a Licença Pública Geral GNU para
 * obter mais detalhes.
 *
 * Você deve ter recebido uma cópia da Licença Pública Geral GNU junto com este
 * programa; se não, escreva para a Free Software Foundation, Inc., 51 Franklin
 * St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Este programa está nomeado como - e possui - linhas de código.
 *
 * Contatos:
 *
 * perry.werneck@gmail.com	(Alexandre Perry de Souza Werneck)
 * erico.mendonca@gmail.com	(Erico Mascarenhas Mendonça)
 *
 */

#include <config.h>

#ifndef GETTEXT_PACKAGE
#define GETTEXT_PACKAGE PACKAGE_NAME
#endif

#include <libintl.h>
#include <glib/gi18n.h>

#include <glib.h>
#include <glib/gstdio.h>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <lib3270.h>
#include <lib3270/log.h>
#include <v3270.h>
#include <v3270/settings.h>
#include <v3270/keyfile.h>
#include <v3270/actions.h>
#include <lib3270/properties.h>
#include <string.h>
#include <stdlib.h>
#include <pw3270/application.h>

struct _V3270KeyFile {
	gboolean	  changed;		///< @brief Save file?
	GKeyFile	* key_file;
	gchar		  filename[1];
};

static V3270KeyFile * v3270_get_session_descriptor(GtkWidget *terminal) {

	return (V3270KeyFile *) g_object_get_data(G_OBJECT(terminal),"session-descriptor");

}

static void close_keyfile(V3270KeyFile * session) {

	if(session->key_file) {

		if(session->changed) {
			g_message("Saving file %s",session->filename);
			g_key_file_save_to_file(session->key_file,session->filename,NULL);
			session->changed = FALSE;
		} else {
			g_message("Closing file %s",session->filename);
		}

		g_key_file_free(session->key_file);
		session->key_file = NULL;
	}

	g_free(session);
}

static void search_for_defaults(V3270KeyFile *session) {

	GError *error = NULL;
 	size_t ix;

 	// Search for user defaults.
 	static const gchar *usernames[] = {
 		"defaults.3270",
 		"default.3270",
 	};

 	for(ix = 0; ix < G_N_ELEMENTS(usernames);ix++) {

		g_autofree gchar * default_settings = g_build_filename(g_get_user_config_dir(),usernames[ix],NULL);

#ifdef DEBUG
		g_message("Searching for %s", default_settings);
#endif // DEBUG

		if(g_file_test(default_settings,G_FILE_TEST_IS_REGULAR)) {
			if(!g_key_file_load_from_file(session->key_file,default_settings,G_KEY_FILE_NONE,&error)) {
				g_warning("Can't load \"%s\": %s",default_settings,error->message);
				g_error_free(error);
			} else {
				g_message("Loading session preferences from %s",default_settings);
				return;
			}
		}

 	}

 	// Search for system defaults.
 	static const gchar *sysnames[] = {
 		"defaults.3270",
 		"default.3270",
 		"defaults.conf",
 		"default.conf",
 	};

 	for(ix = 0; ix < G_N_ELEMENTS(sysnames);ix++) {

		lib3270_autoptr(char) default_settings = lib3270_build_data_filename(sysnames[ix],NULL);

#ifdef DEBUG
		g_message("Searching for %s", default_settings);
#endif // DEBUG

		if(g_file_test(default_settings,G_FILE_TEST_IS_REGULAR)) {
			if(!g_key_file_load_from_file(session->key_file,default_settings,G_KEY_FILE_NONE,&error)) {
				g_warning("Can't load \"%s\": %s",default_settings,error->message);
				g_error_free(error);
			} else {
				g_message("Loading session preferences from %s",default_settings);
				return;
			}
		}

 	}

 	g_message("Can't find default session file");

}

V3270KeyFile * v3270_key_file_open(GtkWidget *terminal, const gchar *filename, GError **error) {

	g_return_val_if_fail(GTK_IS_V3270(terminal),FALSE);
	g_return_val_if_fail(*error == NULL,FALSE);

	V3270KeyFile * new_session = (V3270KeyFile *) g_malloc0(sizeof(struct _V3270KeyFile) + strlen(filename));
	V3270KeyFile * old_session = g_object_get_data(G_OBJECT(terminal),"session-descriptor");

	// Clone session
	if(old_session) {
		*new_session = *old_session;
	}

	strcpy(new_session->filename,filename);
	new_session->key_file = g_key_file_new();
	g_object_set_data_full(G_OBJECT(terminal),"session-descriptor",new_session,(GDestroyNotify) close_keyfile);

	// Load file
	if(g_file_test(new_session->filename,G_FILE_TEST_IS_REGULAR)) {

		// Found session file, open it.
		if(!g_key_file_load_from_file(new_session->key_file,new_session->filename,G_KEY_FILE_NONE,error)) {
			g_warning("Can't load \"%s\"",new_session->filename);
		} else {
			g_message("Loading session preferences from %s",new_session->filename);
		}

	} else {

		// No session file, load the defaults (if available) and save file
		search_for_defaults(new_session);

	}

	if(*error) {
		g_warning("Error '%s' loading keyfile", (*error)->message);
		return new_session;
	}

	// Got key file, load it.
	v3270_load_key_file(terminal,new_session->key_file,NULL);
	v3270_accelerator_map_load_key_file(terminal,new_session->key_file,NULL);

	if(g_key_file_has_group(new_session->key_file,"environment")) {

		// Has environment group, set values.
		gchar **keys = g_key_file_get_keys(new_session->key_file,"environment",NULL,NULL);

		if(keys) {
			size_t ix;
			for(ix=0; keys[ix]; ix++) {
				g_autofree gchar * value = g_key_file_get_string(new_session->key_file,"environment",keys[ix],NULL);
				if(value) {
#ifdef _WIN32
					g_autofree gchar * env = g_strconcat(keys[ix],"=",value,NULL);
					putenv(env);
#else
					if(setenv(keys[ix],value,1)) {
						g_warning("Can't set \"%s\" to \"%s\"",keys[ix],value);
					}
#endif // _WIN32
				}
			}

			g_strfreev(keys);
		}
	}

	if(!*error) {

		GApplication *application = g_application_get_default();

		if(pw3270_application_get_boolean(application,"update-default-session-file",TRUE)) {

			GSettings * settings = pw3270_application_get_settings(application);

			if(settings) {
				g_message("Updating default session file to '%s'",filename);
				g_settings_set_string(settings,"default-session-file",filename);
			}

		}

		if(pw3270_application_get_boolean(application,"add-session-to-recent-manager",TRUE)) {

			// new_session->key_file
			g_autofree gchar * display_name = g_key_file_get_string(new_session->key_file,"terminal","session-name",NULL);

			GtkRecentData recent_data = {

				.display_name = display_name,
				.app_name = G_STRINGIFY(PRODUCT_NAME),
				.description = _("TN3270 Session description"),
				.mime_type = "application/x-pw3270",
				.app_exec = G_STRINGIFY(PRODUCT_NAME) " %f",

			};

			gtk_recent_manager_add_full(
			    gtk_recent_manager_get_default(),
			    filename,
			    &recent_data
			);

		}
	}


	return new_session;
}

void v3270_key_file_close(GtkWidget *terminal) {

	V3270KeyFile *session = g_object_get_data(G_OBJECT(terminal),"session-descriptor");

	if(session->key_file) {

		if(session->changed) {
			g_message("Saving file %s",session->filename);
			g_key_file_save_to_file(session->key_file,session->filename,NULL);
			session->changed = FALSE;
		} else {
			g_message("Closing file %s",session->filename);
		}

		g_key_file_free(session->key_file);
		session->key_file = NULL;
	}

}

GKeyFile * v3270_key_file_get(GtkWidget *terminal) {
	return v3270_get_session_descriptor(terminal)->key_file;
}

void v3270_key_file_save_to_file(GtkWidget * terminal, const gchar *filename, GError **error) {

	if(error && *error)
		return;

	V3270KeyFile * new_session = (V3270KeyFile *) g_malloc0(sizeof(struct _V3270KeyFile) + strlen(filename));
	V3270KeyFile * old_session = g_object_get_data(G_OBJECT(terminal),"session-descriptor");

	if(old_session) {
		*new_session = *old_session;
	}

	strcpy(new_session->filename,filename);
	new_session->key_file = g_key_file_new();

	g_object_set_data_full(G_OBJECT(terminal),"session-descriptor",new_session,(GDestroyNotify) close_keyfile);
	v3270_key_file_save(terminal,error);

}

void v3270_key_file_save(GtkWidget *terminal, GError **error) {

	if(error && *error)
		return;

	V3270KeyFile *session = v3270_get_session_descriptor(terminal);

	session->changed = FALSE;

	debug("%s: terminal=%p session=%p key-file=%p)",__FUNCTION__,terminal,session,session->key_file);

	v3270_to_key_file(terminal,session->key_file,"terminal");
	v3270_accelerator_map_to_key_file(terminal, session->key_file, "accelerators");

	g_key_file_save_to_file(session->key_file,session->filename,NULL);

}

/// @brief Search standard paths.
gchar * v3270_key_file_get_default_path(GtkWidget *terminal) {

	size_t folder;
	const gchar *folders[] = {
		g_get_user_data_dir(),
		g_get_user_special_dir(G_USER_DIRECTORY_DOCUMENTS),
		g_get_user_special_dir(G_USER_DIRECTORY_DESKTOP)
	};

	size_t application;
	const gchar *applications[] = {
		G_STRINGIFY(PRODUCT_NAME),
		PACKAGE_NAME,
		"3270",
		"tn3270"
	};

	for(folder = 0; folder < G_N_ELEMENTS(folders); folder++) {

		if(!(folders[folder] && g_file_test(folders[folder],G_FILE_TEST_IS_DIR)))
			continue;

		for(application = 0; application < G_N_ELEMENTS(applications); application++) {

			gchar * appdir = g_build_filename(folder[folders],application[applications],NULL);

			debug("Testing for \"%s\"",appdir);
			if(g_file_test(appdir,G_FILE_TEST_IS_DIR)) {
				return appdir;
			}
			g_free(appdir);

		}

	}

	// Not found, try the current session path.
	const gchar * filename = v3270_key_file_get_filename(terminal);
	debug("Testing for \"%s\"",filename);
	if(filename
	        && g_file_test(filename,G_FILE_TEST_IS_REGULAR)
	        && g_str_has_prefix(filename,g_get_user_data_dir())
	        && !g_str_has_prefix(filename,g_get_user_config_dir())
	  ) {
		return g_path_get_dirname(filename);
	}

	return g_strdup(g_get_user_special_dir(G_USER_DIRECTORY_DOCUMENTS));

}

gchar * v3270_keyfile_get_default_filename(void) {

	GSettings *settings = pw3270_application_get_settings(g_application_get_default());
	if(settings) {

		g_autofree gchar * def_key_file = g_settings_get_string(settings,"default-session-file");

		if(def_key_file && *def_key_file) {

			if(g_file_test(def_key_file,G_FILE_TEST_IS_REGULAR))
				return g_strdup(def_key_file);

			g_autofree gchar * def_key_full = g_build_filename(g_get_user_config_dir(),def_key_file,NULL);

			if(g_file_test(def_key_full,G_FILE_TEST_IS_REGULAR))
				return g_strdup(def_key_full);
		}

	}

	// No default key file, use the old scheme.

	gchar * filename = g_build_filename(g_get_user_config_dir(),"default.3270",NULL);

	g_autofree gchar * compatible = g_build_filename(g_get_user_config_dir(),G_STRINGIFY(PRODUCT_NAME) ".conf",NULL);
	if(g_file_test(compatible,G_FILE_TEST_IS_REGULAR))
		g_rename(compatible,filename);


	return filename;
}

gchar * v3270_key_file_build_filename(GtkWidget *terminal) {

	g_autofree gchar * defname = v3270_keyfile_get_default_filename();
	const gchar * current = v3270_key_file_get_filename(terminal);

	// If is not the default name, return it.
	if(current && *current && g_file_test(current,G_FILE_TEST_IS_REGULAR) && strcmp(defname,current)) {
		return g_strdup(current);
	}

	g_autofree gchar * folder = v3270_key_file_get_default_path(terminal);

	const char * hostname = lib3270_host_get_name(v3270_get_session(terminal));
	debug("Hostname=\"%s\"",hostname);

	gchar * name = g_strconcat(folder,G_DIR_SEPARATOR_S,(hostname ? hostname : "session"),".3270",NULL);
	unsigned int index = 0;
	while(g_file_test(name,G_FILE_TEST_EXISTS)) {
		g_free(name);
		name = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s.%u.3270",folder,hostname,++index);
	}

	debug("%s returns \"%s\"",__FUNCTION__,name);

	return name;
}

const gchar * v3270_key_file_get_filename(GtkWidget *terminal) {

	V3270KeyFile *session = v3270_get_session_descriptor(terminal);

	if(session && *session->filename)
		return session->filename;

	return NULL;

}

void v3270_key_file_set_boolean(GtkWidget *terminal, const gchar *group_name, const gchar *key, gboolean value) {

	V3270KeyFile *session = v3270_get_session_descriptor(terminal);
	g_key_file_set_boolean(session->key_file,group_name ? group_name : "terminal",key,value);
	session->changed = TRUE;

}

gboolean v3270_key_file_can_write(GtkWidget *widget) {

#if defined(DEBUG)

	return TRUE;

#else

	const V3270KeyFile * descriptor = v3270_get_session_descriptor(widget);

	if(!(descriptor && *descriptor->filename))
		return FALSE;

	if(g_access(descriptor->filename,W_OK))
		return FALSE;

#ifdef _WIN32
	return TRUE;
#else
	return !g_str_has_prefix(descriptor->filename,g_get_user_config_dir());
#endif // _WIN32

#endif // DEBUG

}