path: root/src/bin/psql/large_obj.c

#include <config.h>
#include <c.h>
#include "large_obj.h"

#include <stdio.h>
#include <string.h>

#include <libpq-fe.h>
#include <postgres.h>

#include "settings.h"
#include "variables.h"
#include "common.h"
#include "print.h"


/*
 * Since all large object ops must be in a transaction, we must do some magic
 * here. You can set the variable lo_transaction to one of commit|rollback|
 * nothing to get your favourite behaviour regarding any transaction in
 * progress. Rollback is default.
 */

static char notice[80];

static void
_my_notice_handler(void *arg, const char *message)
{
	(void) arg;
	strncpy(notice, message, 79);
	notice[79] = '\0';
}


static bool
handle_transaction(PsqlSettings *pset)
{
	const char *var = GetVariable(pset->vars, "lo_transaction");
	PGresult   *res;
	bool		commit;
	PQnoticeProcessor old_notice_hook;

	if (var && strcmp(var, "nothing") == 0)
		return true;

	commit = (var && strcmp(var, "commit") == 0);

	notice[0] = '\0';
	old_notice_hook = PQsetNoticeProcessor(pset->db, _my_notice_handler, NULL);

	res = PSQLexec(pset, commit ? "COMMIT" : "ROLLBACK");
	if (!res)
		return false;

	if (notice[0])
	{
		if ((!commit && strcmp(notice, "NOTICE:  UserAbortTransactionBlock and not in in-progress state\n") != 0) ||
			(commit && strcmp(notice, "NOTICE:  EndTransactionBlock and not inprogress/abort state\n") != 0))
			fputs(notice, stderr);
	}
	else if (!GetVariableBool(pset->vars, "quiet"))
	{
		if (commit)
			puts("Warning: Your transaction in progress has been committed.");
		else
			puts("Warning: Your transaction in progress has been rolled back.");
	}

	PQsetNoticeProcessor(pset->db, old_notice_hook, NULL);
	return true;
}



/*
 * do_lo_export()
 *
 * Write a large object to a file
 */
bool
do_lo_export(PsqlSettings *pset, const char *loid_arg, const char *filename_arg)
{
	PGresult   *res;
	int			status;
	bool		own_transaction = true;
	const char *var = GetVariable(pset->vars, "lo_transaction");

	if (var && strcmp(var, "nothing") == 0)
		own_transaction = false;

	if (!pset->db)
	{
		fputs("You are not connected to a database.\n", stderr);
		return false;
	}

	if (own_transaction)
	{
		if (!handle_transaction(pset))
			return false;

		if (!(res = PSQLexec(pset, "BEGIN")))
			return false;

		PQclear(res);
	}

	status = lo_export(pset->db, atol(loid_arg), (char *) filename_arg);
	if (status != 1)
	{							/* of course this status is documented
								 * nowhere :( */
		fputs(PQerrorMessage(pset->db), stderr);
		if (own_transaction)
		{
			res = PQexec(pset->db, "ROLLBACK");
			PQclear(res);
		}
		return false;
	}

	if (own_transaction)
	{
		if (!(res = PSQLexec(pset, "COMMIT")))
		{
			res = PQexec(pset->db, "ROLLBACK");
			PQclear(res);
			return false;
		}

		PQclear(res);
	}

	fprintf(pset->queryFout, "lo_export\n");

	return true;
}



/*
 * do_lo_import()
 *
 * Copy large object from file to database
 */
bool
do_lo_import(PsqlSettings *pset, const char *filename_arg, const char *comment_arg)
{
	PGresult   *res;
	Oid			loid;
	char		buf[1024];
	unsigned int i;
	bool		own_transaction = true;
	const char *var = GetVariable(pset->vars, "lo_transaction");

	if (var && strcmp(var, "nothing") == 0)
		own_transaction = false;

	if (!pset->db)
	{
		fputs("You are not connected to a database.\n", stderr);
		return false;
	}

	if (own_transaction)
	{
		if (!handle_transaction(pset))
			return false;

		if (!(res = PSQLexec(pset, "BEGIN")))
			return false;

		PQclear(res);
	}

	loid = lo_import(pset->db, (char *) filename_arg);
	if (loid == InvalidOid)
	{
		fputs(PQerrorMessage(pset->db), stderr);
		if (own_transaction)
		{
			res = PQexec(pset->db, "ROLLBACK");
			PQclear(res);
		}
		return false;
	}

	/* insert description if given */
	if (comment_arg)
	{
		sprintf(buf, "INSERT INTO pg_description VALUES (%d, '", loid);
		for (i = 0; i < strlen(comment_arg); i++)
			if (comment_arg[i] == '\'')
				strcat(buf, "\\'");
			else
				strncat(buf, &comment_arg[i], 1);
		strcat(buf, "')");

		if (!(res = PSQLexec(pset, buf)))
		{
			if (own_transaction)
			{
				res = PQexec(pset->db, "ROLLBACK");
				PQclear(res);
			}
			return false;
		}
	}

	if (own_transaction)
	{
		if (!(res = PSQLexec(pset, "COMMIT")))
		{
			res = PQexec(pset->db, "ROLLBACK");
			PQclear(res);
			return false;
		}

		PQclear(res);
	}


	fprintf(pset->queryFout, "lo_import %d\n", loid);

	return true;
}



/*
 * do_lo_unlink()
 *
 * removes a large object out of the database
 */
bool
do_lo_unlink(PsqlSettings *pset, const char *loid_arg)
{
	PGresult   *res;
	int			status;
	Oid			loid = (Oid) atol(loid_arg);
	char		buf[256];
	bool		own_transaction = true;
	const char *var = GetVariable(pset->vars, "lo_transaction");

	if (var && strcmp(var, "nothing") == 0)
		own_transaction = false;

	if (!pset->db)
	{
		fputs("You are not connected to a database.\n", stderr);
		return false;
	}

	if (own_transaction)
	{
		if (!handle_transaction(pset))
			return false;

		if (!(res = PSQLexec(pset, "BEGIN")))
			return false;

		PQclear(res);
	}

	status = lo_unlink(pset->db, loid);
	if (status == -1)
	{
		fputs(PQerrorMessage(pset->db), stderr);
		if (own_transaction)
		{
			res = PQexec(pset->db, "ROLLBACK");
			PQclear(res);
		}
		return false;
	}

	/* remove the comment as well */
	sprintf(buf, "DELETE FROM pg_description WHERE objoid = %d", loid);
	if (!(res = PSQLexec(pset, buf)))
	{
		if (own_transaction)
		{
			res = PQexec(pset->db, "ROLLBACK");
			PQclear(res);
		}
		return false;
	}


	if (own_transaction)
	{
		if (!(res = PSQLexec(pset, "COMMIT")))
		{
			res = PQexec(pset->db, "ROLLBACK");
			PQclear(res);
			return false;
		}
		PQclear(res);
	}


	fprintf(pset->queryFout, "lo_unlink %d\n", loid);

	return true;
}



/*
 * do_lo_list()
 *
 * Show all large objects in database, with comments if desired
 */
bool
do_lo_list(PsqlSettings *pset)
{
	PGresult   *res;
	char		descbuf[512];
	printQueryOpt myopt = pset->popt;

	descbuf[0] = '\0';
	strcat(descbuf, "SELECT usename as \"Owner\", substring(relname from 5) as \"ID\"");
	if (GetVariableBool(pset->vars, "description"))
		strcat(descbuf, ",\n  obj_description(pg_class.oid) as \"Description\"");
	strcat(descbuf, "\nFROM pg_class, pg_user\n"
		   "WHERE usesysid = relowner AND relkind = 'l'\n"
		   "ORDER BY \"ID\"");

	res = PSQLexec(pset, descbuf);
	if (!res)
		return false;

	myopt.topt.tuples_only = false;
	myopt.nullPrint = NULL;
	myopt.title = "Large objects";

	printQuery(res, &myopt, pset->queryFout);

	PQclear(res);
	return true;
}