SVN Commit by dpage: r4421 - in trunk/pgadmin3/xtra: . admin admin81 - Mailing list pgadmin-hackers

Author: dpage
Date: 2005-08-28 22:14:32 +0100 (Sun, 28 Aug 2005)
New Revision: 4421

Added:
   trunk/pgadmin3/xtra/admin81/
   trunk/pgadmin3/xtra/admin81/Makefile
   trunk/pgadmin3/xtra/admin81/README.admin81
   trunk/pgadmin3/xtra/admin81/admin81.c
   trunk/pgadmin3/xtra/admin81/admin81.sql.in
Modified:
   trunk/pgadmin3/xtra/admin/README.admin
Log:
There doesn't seem to be a clean way to conditionally compile based in the PostgreSQL version number in pgxs, so just
createa new, cut down version of the module for minimum user confusion. 

Modified: trunk/pgadmin3/xtra/admin/README.admin
===================================================================
--- trunk/pgadmin3/xtra/admin/README.admin    2005-08-28 20:18:31 UTC (rev 4420)
+++ trunk/pgadmin3/xtra/admin/README.admin    2005-08-28 21:14:32 UTC (rev 4421)
@@ -3,8 +3,10 @@

 This directory is a PostgreSQL 'contrib' module which implements a number of
 support functions which pgAdmin will use to provide additional functionality
-if installed on a server.
+if installed on a server.

+*** This version should be used on PostgreSQL 8.0.x and lower Servers ***
+
 Installation
 ============


Added: trunk/pgadmin3/xtra/admin81/Makefile
===================================================================
--- trunk/pgadmin3/xtra/admin81/Makefile    2005-08-28 20:18:31 UTC (rev 4420)
+++ trunk/pgadmin3/xtra/admin81/Makefile    2005-08-28 21:14:32 UTC (rev 4421)
@@ -0,0 +1,11 @@
+subdir = contrib/admin81
+top_builddir = ../..
+include $(top_builddir)/src/Makefile.global
+
+MODULE_big = admin81
+PG_CPPFLAGS = -I$(libpq_srcdir)
+DATA_built = admin81.sql
+DOCS = README.admin81
+OBJS = admin81.o
+
+include $(top_srcdir)/contrib/contrib-global.mk

Added: trunk/pgadmin3/xtra/admin81/README.admin81
===================================================================
--- trunk/pgadmin3/xtra/admin81/README.admin81    2005-08-28 20:18:31 UTC (rev 4420)
+++ trunk/pgadmin3/xtra/admin81/README.admin81    2005-08-28 21:14:32 UTC (rev 4421)
@@ -0,0 +1,37 @@
+PostgreSQL Administration Functions
+===================================
+
+This directory is a PostgreSQL 'contrib' module which implements a number of
+support functions which pgAdmin will use to provide additional functionality
+if installed on a server.
+
+*** This version should be used on PostgreSQL 8.1.x Servers ***
+
+Installation
+============
+
+You will need a PostgreSQL source tree which has been properly configured
+for the local system using the 'configure' script.
+
+Copy this directory into the /contrib directory of the PostgreSQL source tree,
+and then run the following commands as a users with appropriate privileges:
+
+make
+make install
+
+pgAdmin will look for the functions in the Initial Database specified in the
+connection dialogue for the server. To install the functions in the database,
+either run the admin81.sql script using the pgAdmin SQL tool (and then
+restart pgAdmin), or run the script using psql, eg:
+
+psql -u postgres template1 < admin81.sql
+
+On PostgreSQL 8.1 or above, you should use the admin81.sql script.
+
+Objects implemented (superuser only)
+====================================
+
+int8 pg_file_write(fname text, data text, append bool)
+bool pg_file_rename(oldname text, newname text)
+bool pg_file_rename(oldname text, newname text, archivname text)
+bool pg_file_unlink(fname text)

Added: trunk/pgadmin3/xtra/admin81/admin81.c
===================================================================
--- trunk/pgadmin3/xtra/admin81/admin81.c    2005-08-28 20:18:31 UTC (rev 4420)
+++ trunk/pgadmin3/xtra/admin81/admin81.c    2005-08-28 21:14:32 UTC (rev 4421)
@@ -0,0 +1,282 @@
+/*-------------------------------------------------------------------------
+ *
+ * admin81.c
+ *
+ *
+ * Copyright (c) 2004 - 2005, PostgreSQL Global Development Group
+ *
+ * Author: Andreas Pflug <pgadmin@pse-consulting.de>
+ *
+ * IDENTIFICATION
+ *      $PostgreSQL: $
+ *
+ *-------------------------------------------------------------------------
+ */
+#include "postgres.h"
+
+#include <sys/file.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <dirent.h>
+
+#include "miscadmin.h"
+#include "storage/fd.h"
+#include "catalog/pg_type.h"
+#include "funcapi.h"
+
+
+#ifdef WIN32
+
+#ifdef rename
+#undef rename
+#endif
+
+#ifdef unlink
+#undef unlink
+#endif
+
+#endif
+
+extern DLLIMPORT char *DataDir;
+extern DLLIMPORT char *Log_directory;
+
+Datum pg_file_write(PG_FUNCTION_ARGS);
+Datum pg_file_rename(PG_FUNCTION_ARGS);
+Datum pg_file_unlink(PG_FUNCTION_ARGS);
+
+PG_FUNCTION_INFO_V1(pg_file_write);
+PG_FUNCTION_INFO_V1(pg_file_rename);
+PG_FUNCTION_INFO_V1(pg_file_unlink);
+
+typedef struct
+{
+    char *location;
+    DIR *dirdesc;
+} directory_fctx;
+
+/*-----------------------
+ * some helper functions
+ */
+
+/*
+ * Return an absolute path. Argument may be absolute or
+ * relative to the DataDir.
+ */
+static char *absClusterPath(text *arg, bool logAllowed)
+{
+    char *filename;
+    int len=VARSIZE(arg) - VARHDRSZ;
+    int dlen = strlen(DataDir);
+
+    filename = palloc(len+1);
+    memcpy(filename, VARDATA(arg), len);
+    filename[len] = 0;
+
+    if (strstr(filename, "..") != NULL)
+      ereport(ERROR,
+              (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
+               (errmsg("No .. allowed in filenames"))));
+
+    if (is_absolute_path(filename))
+    {
+        if (logAllowed && !strncmp(filename, Log_directory, strlen(Log_directory)))
+            return filename;
+        if (strncmp(filename, DataDir, dlen))
+            ereport(ERROR,
+                    (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
+                     (errmsg("Absolute path not allowed"))));
+
+        return filename;
+    }
+    else
+    {
+        char *absname = palloc(dlen+len+2);
+        sprintf(absname, "%s/%s", DataDir, filename);
+        pfree(filename);
+        return absname;
+    }
+}
+
+
+/*
+ * check for superuser, bark if not.
+ */
+static void
+requireSuperuser(void)
+{
+    if (!superuser())
+        ereport(ERROR,
+                (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
+                 (errmsg("only superuser may access generic file functions"))));
+}
+
+
+
+/* ------------------------------------
+ * generic file handling functions
+ */
+
+Datum pg_file_write(PG_FUNCTION_ARGS)
+{
+    FILE *f;
+    char *filename;
+    text *data;
+    int64 count = 0;
+
+    requireSuperuser();
+
+    filename = absClusterPath(PG_GETARG_TEXT_P(0), false);
+    data = PG_GETARG_TEXT_P(1);
+
+    if (PG_ARGISNULL(2) || !PG_GETARG_BOOL(2))
+    {
+        struct stat fst;
+        if (stat(filename, &fst) >= 0)
+            ereport(ERROR,
+                    (ERRCODE_DUPLICATE_FILE,
+                     errmsg("file %s exists", filename)));
+
+        f = fopen(filename, "wb");
+    }
+    else
+        f = fopen(filename, "ab");
+
+    if (!f)
+    {
+        ereport(ERROR,
+                (errcode_for_file_access(),
+                 errmsg("could open file %s for writing: %m", filename)));
+    }
+
+    if (VARSIZE(data) != 0)
+    {
+        count = fwrite(VARDATA(data), 1, VARSIZE(data) - VARHDRSZ, f);
+
+        if (count != VARSIZE(data) - VARHDRSZ)
+            ereport(ERROR,
+                    (errcode_for_file_access(),
+                     errmsg("error writing file %s: %m", filename)));
+    }
+    fclose(f);
+
+    PG_RETURN_INT64(count);
+}
+
+
+Datum pg_file_rename(PG_FUNCTION_ARGS)
+{
+    char *fn1, *fn2, *fn3;
+    int rc;
+
+    requireSuperuser();
+
+    if (PG_ARGISNULL(0) || PG_ARGISNULL(1))
+        PG_RETURN_NULL();
+
+    fn1=absClusterPath(PG_GETARG_TEXT_P(0), false);
+    fn2=absClusterPath(PG_GETARG_TEXT_P(1), false);
+    if (PG_ARGISNULL(2))
+        fn3=0;
+    else
+        fn3=absClusterPath(PG_GETARG_TEXT_P(2), false);
+
+    if (access(fn1, W_OK) < 0)
+    {
+        ereport(WARNING,
+                (errcode_for_file_access(),
+                 errmsg("file %s not accessible: %m", fn1)));
+
+        PG_RETURN_BOOL(false);
+    }
+
+    if (fn3 && access(fn2, W_OK) < 0)
+    {
+        ereport(WARNING,
+                (errcode_for_file_access(),
+                 errmsg("file %s not accessible: %m", fn2)));
+
+        PG_RETURN_BOOL(false);
+    }
+
+
+    rc = access(fn3 ? fn3 : fn2, 2);
+    if (rc >= 0 || errno != ENOENT)
+    {
+        ereport(ERROR,
+                (ERRCODE_DUPLICATE_FILE,
+                 errmsg("cannot rename to target file %s", fn3 ? fn3 : fn2)));
+    }
+
+    if (fn3)
+    {
+        if (rename(fn2, fn3) != 0)
+        {
+            ereport(ERROR,
+                    (errcode_for_file_access(),
+                     errmsg("could not rename %s to %s: %m", fn2, fn3)));
+        }
+        if (rename(fn1, fn2) != 0)
+        {
+            ereport(WARNING,
+                    (errcode_for_file_access(),
+                     errmsg("could not rename %s to %s: %m", fn1, fn2)));
+
+            if (rename(fn3, fn2) != 0)
+            {
+                ereport(ERROR,
+                        (errcode_for_file_access(),
+                         errmsg("could not rename %s back to %s: %m", fn3, fn2)));
+            }
+            else
+            {
+                ereport(ERROR,
+                        (ERRCODE_UNDEFINED_FILE,
+                         errmsg("renaming %s to %s was reverted", fn2, fn3)));
+
+            }
+        }
+    }
+    else if (rename(fn1, fn2) != 0)
+    {
+            ereport(WARNING,
+                    (errcode_for_file_access(),
+                     errmsg("renaming %s to %s %m", fn1, fn2)));
+        ereport(ERROR,
+                (errcode_for_file_access(),
+                 errmsg("could not rename %s to %s: %m", fn1, fn2)));
+    }
+
+    PG_RETURN_BOOL(true);
+}
+
+
+Datum pg_file_unlink(PG_FUNCTION_ARGS)
+{
+    char *filename;
+
+    requireSuperuser();
+
+    filename = absClusterPath(PG_GETARG_TEXT_P(0), false);
+
+    if (access(filename, W_OK) < 0)
+    {
+        if (errno == ENOENT)
+            PG_RETURN_BOOL(false);
+        else
+            ereport(ERROR,
+                    (errcode_for_file_access(),
+                     errmsg("file %s not accessible: %m", filename)));
+
+    }
+
+    if (unlink(filename) < 0)
+    {
+        ereport(WARNING,
+                (errcode_for_file_access(),
+                 errmsg("could not unlink file %s: %m", filename)));
+
+        PG_RETURN_BOOL(false);
+    }
+    PG_RETURN_BOOL(true);
+}
+

Added: trunk/pgadmin3/xtra/admin81/admin81.sql.in
===================================================================
--- trunk/pgadmin3/xtra/admin81/admin81.sql.in    2005-08-28 20:18:31 UTC (rev 4420)
+++ trunk/pgadmin3/xtra/admin81/admin81.sql.in    2005-08-28 21:14:32 UTC (rev 4421)
@@ -0,0 +1,21 @@
+/* ***********************************************
+ * Administrative functions - for PostgreSQL 8.1.x
+ * *********************************************** */
+
+/* generic file access functions (genfile.c) */
+
+CREATE FUNCTION pg_file_write(text, text, bool) RETURNS bigint
+   AS 'MODULE_PATHNAME', 'pg_file_write'
+    LANGUAGE C VOLATILE STRICT;
+
+CREATE FUNCTION pg_file_rename(text, text, text) RETURNS bool
+   AS 'MODULE_PATHNAME', 'pg_file_rename'
+    LANGUAGE C VOLATILE;
+
+CREATE FUNCTION pg_file_unlink(text) RETURNS bool
+   AS 'MODULE_PATHNAME', 'pg_file_unlink'
+    LANGUAGE C VOLATILE STRICT;
+
+CREATE FUNCTION pg_file_rename(text, text) RETURNS bool
+   AS 'SELECT pg_file_rename($1, $2, NULL); '
+    LANGUAGE SQL VOLATILE STRICT;