#include "postgres.h"
#include <sys/file.h>
#include <sys/stat.h>
#include <unistd.h>
#include <dirent.h>
#include "access/htup_details.h"
#include "access/xlog_internal.h"
#include "catalog/pg_type.h"
#include "funcapi.h"
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "postmaster/syslogger.h"
#include "storage/fd.h"
#include "utils/builtins.h"
#include "utils/memutils.h"
#include "utils/timestamp.h"

Include dependency graph for genfile.c:

Data Structures
struct	directory_fctx

Functions
static char *	convert_and_check_filename (text *arg)

static bytea *	read_binary_file (const char *filename, int64 seek_offset, int64 bytes_to_read, bool missing_ok)

static text *	read_text_file (const char *filename, int64 seek_offset, int64 bytes_to_read, bool missing_ok)

Datum	pg_read_file (PG_FUNCTION_ARGS)

Datum	pg_read_binary_file (PG_FUNCTION_ARGS)

Datum	pg_read_file_off_len (PG_FUNCTION_ARGS)

Datum	pg_read_file_all (PG_FUNCTION_ARGS)

Datum	pg_read_binary_file_off_len (PG_FUNCTION_ARGS)

Datum	pg_read_binary_file_all (PG_FUNCTION_ARGS)

Datum	pg_stat_file (PG_FUNCTION_ARGS)

Datum	pg_stat_file_1arg (PG_FUNCTION_ARGS)

Datum	pg_ls_dir (PG_FUNCTION_ARGS)

Datum	pg_ls_dir_1arg (PG_FUNCTION_ARGS)

static Datum	pg_ls_dir_files (FunctionCallInfo fcinfo, char *dir)

Datum	pg_ls_logdir (PG_FUNCTION_ARGS)

Datum	pg_ls_waldir (PG_FUNCTION_ARGS)

Function Documentation

static char* convert_and_check_filename ( text * arg )

static

Definition at line 50 of file genfile.c.

References canonicalize_path(), DataDir, ereport, errcode(), errmsg(), ERROR, filename, is_absolute_path, Log_directory, path_contains_parent_reference(), path_is_prefix_of_path(), path_is_relative_and_below_cwd(), and text_to_cstring().

Referenced by pg_ls_dir(), pg_read_binary_file(), pg_read_file(), and pg_stat_file().

 {
     char       *filename;
 
     filename = text_to_cstring(arg);
     canonicalize_path(filename);    /* filename can change length here */
 
     if (is_absolute_path(filename))
     {
         /* Disallow '/a/b/data/..' */
         if (path_contains_parent_reference(filename))
             ereport(ERROR,
                     (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                      (errmsg("reference to parent directory (\"..\") not allowed"))));
 
         /*
          * Allow absolute paths if within DataDir or Log_directory, even
          * though Log_directory might be outside DataDir.
          */
         if (!path_is_prefix_of_path(DataDir, filename) &&
             (!is_absolute_path(Log_directory) ||
              !path_is_prefix_of_path(Log_directory, filename)))
             ereport(ERROR,
                     (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                      (errmsg("absolute path not allowed"))));
     }
     else if (!path_is_relative_and_below_cwd(filename))
         ereport(ERROR,
                 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                  (errmsg("path must be in or below the current directory"))));
 
     return filename;
 }

Datum pg_ls_dir ( PG_FUNCTION_ARGS )

Definition at line 395 of file genfile.c.

References AllocateDir(), convert_and_check_filename(), CStringGetTextDatum, dirent::d_name, directory_fctx::dirdesc, ereport, errcode(), errcode_for_file_access(), errmsg(), ERROR, FreeDir(), directory_fctx::include_dot_dirs, directory_fctx::location, MemoryContextSwitchTo(), FuncCallContext::multi_call_memory_ctx, palloc(), PG_ARGISNULL, PG_GETARG_BOOL, PG_GETARG_TEXT_PP, PG_NARGS, ReadDir(), SRF_FIRSTCALL_INIT, SRF_IS_FIRSTCALL, SRF_PERCALL_SETUP, SRF_RETURN_DONE, SRF_RETURN_NEXT, superuser(), and FuncCallContext::user_fctx.

Referenced by pg_ls_dir_1arg().

 {
     FuncCallContext *funcctx;
     struct dirent *de;
     directory_fctx *fctx;
     MemoryContext oldcontext;
 
     if (!superuser())
         ereport(ERROR,
                 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                  (errmsg("must be superuser to get directory listings"))));
 
     if (SRF_IS_FIRSTCALL())
     {
         bool        missing_ok = false;
         bool        include_dot_dirs = false;
 
         /* check the optional arguments */
         if (PG_NARGS() == 3)
         {
             if (!PG_ARGISNULL(1))
                 missing_ok = PG_GETARG_BOOL(1);
             if (!PG_ARGISNULL(2))
                 include_dot_dirs = PG_GETARG_BOOL(2);
         }
 
         funcctx = SRF_FIRSTCALL_INIT();
         oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
 
         fctx = palloc(sizeof(directory_fctx));
         fctx->location = convert_and_check_filename(PG_GETARG_TEXT_PP(0));
 
         fctx->include_dot_dirs = include_dot_dirs;
         fctx->dirdesc = AllocateDir(fctx->location);
 
         if (!fctx->dirdesc)
         {
             if (missing_ok && errno == ENOENT)
             {
                 MemoryContextSwitchTo(oldcontext);
                 SRF_RETURN_DONE(funcctx);
             }
             else
                 ereport(ERROR,
                         (errcode_for_file_access(),
                          errmsg("could not open directory \"%s\": %m",
                                 fctx->location)));
         }
         funcctx->user_fctx = fctx;
         MemoryContextSwitchTo(oldcontext);
     }
 
     funcctx = SRF_PERCALL_SETUP();
     fctx = (directory_fctx *) funcctx->user_fctx;
 
     while ((de = ReadDir(fctx->dirdesc, fctx->location)) != NULL)
     {
         if (!fctx->include_dot_dirs &&
             (strcmp(de->d_name, ".") == 0 ||
              strcmp(de->d_name, "..") == 0))
             continue;
 
         SRF_RETURN_NEXT(funcctx, CStringGetTextDatum(de->d_name));
     }
 
     FreeDir(fctx->dirdesc);
 
     SRF_RETURN_DONE(funcctx);
 }

Datum pg_ls_dir_1arg ( PG_FUNCTION_ARGS )

Definition at line 473 of file genfile.c.

References pg_ls_dir().

 {
     return pg_ls_dir(fcinfo);
 }

static Datum pg_ls_dir_files	(	FunctionCallInfo	fcinfo,
		char *	dir
	)

static

Definition at line 480 of file genfile.c.

References AllocateDir(), BlessTupleDesc(), CreateTemplateTupleDesc(), CStringGetTextDatum, dirent::d_name, directory_fctx::dirdesc, ereport, errcode_for_file_access(), errmsg(), ERROR, FreeDir(), heap_form_tuple(), HeapTupleGetDatum, Int64GetDatum(), INT8OID, directory_fctx::location, MAXPGPATH, MemoryContextSwitchTo(), FuncCallContext::multi_call_memory_ctx, palloc(), pstrdup(), ReadDir(), snprintf(), SRF_FIRSTCALL_INIT, SRF_IS_FIRSTCALL, SRF_PERCALL_SETUP, SRF_RETURN_DONE, SRF_RETURN_NEXT, TEXTOID, time_t_to_timestamptz(), TimestampTzGetDatum, TIMESTAMPTZOID, FuncCallContext::tuple_desc, TupleDescInitEntry(), FuncCallContext::user_fctx, and values.

Referenced by pg_ls_logdir(), and pg_ls_waldir().

 {
     FuncCallContext *funcctx;
     struct dirent *de;
     directory_fctx *fctx;
 
     if (SRF_IS_FIRSTCALL())
     {
         MemoryContext oldcontext;
         TupleDesc   tupdesc;
 
         funcctx = SRF_FIRSTCALL_INIT();
         oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
 
         fctx = palloc(sizeof(directory_fctx));
 
         tupdesc = CreateTemplateTupleDesc(3, false);
         TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
                            TEXTOID, -1, 0);
         TupleDescInitEntry(tupdesc, (AttrNumber) 2, "size",
                            INT8OID, -1, 0);
         TupleDescInitEntry(tupdesc, (AttrNumber) 3, "modification",
                            TIMESTAMPTZOID, -1, 0);
         funcctx->tuple_desc = BlessTupleDesc(tupdesc);
 
         fctx->location = pstrdup(dir);
         fctx->dirdesc = AllocateDir(fctx->location);
 
         if (!fctx->dirdesc)
             ereport(ERROR,
                     (errcode_for_file_access(),
                      errmsg("could not read directory \"%s\": %m",
                             fctx->location)));
 
         funcctx->user_fctx = fctx;
         MemoryContextSwitchTo(oldcontext);
     }
 
     funcctx = SRF_PERCALL_SETUP();
     fctx = (directory_fctx *) funcctx->user_fctx;
 
     while ((de = ReadDir(fctx->dirdesc, fctx->location)) != NULL)
     {
         Datum       values[3];
         bool        nulls[3];
         char        path[MAXPGPATH * 2];
         struct stat attrib;
         HeapTuple   tuple;
 
         /* Skip hidden files */
         if (de->d_name[0] == '.')
             continue;
 
         /* Get the file info */
         snprintf(path, sizeof(path), "%s/%s", fctx->location, de->d_name);
         if (stat(path, &attrib) < 0)
             ereport(ERROR,
                     (errcode_for_file_access(),
                      errmsg("could not stat directory \"%s\": %m", dir)));
 
         /* Ignore anything but regular files */
         if (!S_ISREG(attrib.st_mode))
             continue;
 
         values[0] = CStringGetTextDatum(de->d_name);
         values[1] = Int64GetDatum((int64) attrib.st_size);
         values[2] = TimestampTzGetDatum(time_t_to_timestamptz(attrib.st_mtime));
         memset(nulls, 0, sizeof(nulls));
 
         tuple = heap_form_tuple(funcctx->tuple_desc, values, nulls);
         SRF_RETURN_NEXT(funcctx, HeapTupleGetDatum(tuple));
     }
 
     FreeDir(fctx->dirdesc);
     SRF_RETURN_DONE(funcctx);
 }

Datum pg_ls_logdir ( PG_FUNCTION_ARGS )

Definition at line 559 of file genfile.c.

References Log_directory, and pg_ls_dir_files().

 {
     return pg_ls_dir_files(fcinfo, Log_directory);
 }

Datum pg_ls_waldir ( PG_FUNCTION_ARGS )

Definition at line 566 of file genfile.c.

References pg_ls_dir_files(), and XLOGDIR.

 {
     return pg_ls_dir_files(fcinfo, XLOGDIR);
 }

Datum pg_read_binary_file ( PG_FUNCTION_ARGS )

Definition at line 230 of file genfile.c.

References convert_and_check_filename(), ereport, errcode(), errmsg(), ERROR, filename, PG_GETARG_BOOL, PG_GETARG_INT64, PG_GETARG_TEXT_PP, PG_NARGS, PG_RETURN_BYTEA_P, PG_RETURN_NULL, read_binary_file(), and superuser().

Referenced by pg_read_binary_file_all(), and pg_read_binary_file_off_len().

 {
     text       *filename_t = PG_GETARG_TEXT_PP(0);
     int64       seek_offset = 0;
     int64       bytes_to_read = -1;
     bool        missing_ok = false;
     char       *filename;
     bytea      *result;
 
     if (!superuser())
         ereport(ERROR,
                 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                  (errmsg("must be superuser to read files"))));
 
     /* handle optional arguments */
     if (PG_NARGS() >= 3)
     {
         seek_offset = PG_GETARG_INT64(1);
         bytes_to_read = PG_GETARG_INT64(2);
 
         if (bytes_to_read < 0)
             ereport(ERROR,
                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                      errmsg("requested length cannot be negative")));
     }
     if (PG_NARGS() >= 4)
         missing_ok = PG_GETARG_BOOL(3);
 
     filename = convert_and_check_filename(filename_t);
 
     result = read_binary_file(filename, seek_offset,
                               bytes_to_read, missing_ok);
     if (result)
         PG_RETURN_BYTEA_P(result);
     else
         PG_RETURN_NULL();
 }

Datum pg_read_binary_file_all ( PG_FUNCTION_ARGS )

Definition at line 296 of file genfile.c.

References pg_read_binary_file().

 {
     return pg_read_binary_file(fcinfo);
 }

Datum pg_read_binary_file_off_len ( PG_FUNCTION_ARGS )

Definition at line 290 of file genfile.c.

References pg_read_binary_file().

 {
     return pg_read_binary_file(fcinfo);
 }

Datum pg_read_file ( PG_FUNCTION_ARGS )

Definition at line 189 of file genfile.c.

References convert_and_check_filename(), ereport, errcode(), errmsg(), ERROR, filename, PG_GETARG_BOOL, PG_GETARG_INT64, PG_GETARG_TEXT_PP, PG_NARGS, PG_RETURN_NULL, PG_RETURN_TEXT_P, read_text_file(), and superuser().

Referenced by pg_read_file_all(), and pg_read_file_off_len().

 {
     text       *filename_t = PG_GETARG_TEXT_PP(0);
     int64       seek_offset = 0;
     int64       bytes_to_read = -1;
     bool        missing_ok = false;
     char       *filename;
     text       *result;
 
     if (!superuser())
         ereport(ERROR,
                 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                  (errmsg("must be superuser to read files"))));
 
     /* handle optional arguments */
     if (PG_NARGS() >= 3)
     {
         seek_offset = PG_GETARG_INT64(1);
         bytes_to_read = PG_GETARG_INT64(2);
 
         if (bytes_to_read < 0)
             ereport(ERROR,
                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                      errmsg("requested length cannot be negative")));
     }
     if (PG_NARGS() >= 4)
         missing_ok = PG_GETARG_BOOL(3);
 
     filename = convert_and_check_filename(filename_t);
 
     result = read_text_file(filename, seek_offset, bytes_to_read, missing_ok);
     if (result)
         PG_RETURN_TEXT_P(result);
     else
         PG_RETURN_NULL();
 }

Datum pg_read_file_all ( PG_FUNCTION_ARGS )

Definition at line 284 of file genfile.c.

References pg_read_file().

 {
     return pg_read_file(fcinfo);
 }

Datum pg_read_file_off_len ( PG_FUNCTION_ARGS )

Definition at line 278 of file genfile.c.

References pg_read_file().

 {
     return pg_read_file(fcinfo);
 }

Datum pg_stat_file ( PG_FUNCTION_ARGS )

Definition at line 305 of file genfile.c.

References BlessTupleDesc(), BoolGetDatum, BOOLOID, convert_and_check_filename(), CreateTemplateTupleDesc(), ereport, errcode(), errcode_for_file_access(), errmsg(), ERROR, filename, heap_form_tuple(), HeapTupleGetDatum, Int64GetDatum(), INT8OID, pfree(), PG_GETARG_BOOL, PG_GETARG_TEXT_PP, PG_NARGS, PG_RETURN_DATUM, PG_RETURN_NULL, superuser(), time_t_to_timestamptz(), TimestampTzGetDatum, TIMESTAMPTZOID, TupleDescInitEntry(), and values.

Referenced by pg_stat_file_1arg().

 {
     text       *filename_t = PG_GETARG_TEXT_PP(0);
     char       *filename;
     struct stat fst;
     Datum       values[6];
     bool        isnull[6];
     HeapTuple   tuple;
     TupleDesc   tupdesc;
     bool        missing_ok = false;
 
     if (!superuser())
         ereport(ERROR,
                 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                  (errmsg("must be superuser to get file information"))));
 
     /* check the optional argument */
     if (PG_NARGS() == 2)
         missing_ok = PG_GETARG_BOOL(1);
 
     filename = convert_and_check_filename(filename_t);
 
     if (stat(filename, &fst) < 0)
     {
         if (missing_ok && errno == ENOENT)
             PG_RETURN_NULL();
         else
             ereport(ERROR,
                     (errcode_for_file_access(),
                      errmsg("could not stat file \"%s\": %m", filename)));
     }
 
     /*
      * This record type had better match the output parameters declared for me
      * in pg_proc.h.
      */
     tupdesc = CreateTemplateTupleDesc(6, false);
     TupleDescInitEntry(tupdesc, (AttrNumber) 1,
                        "size", INT8OID, -1, 0);
     TupleDescInitEntry(tupdesc, (AttrNumber) 2,
                        "access", TIMESTAMPTZOID, -1, 0);
     TupleDescInitEntry(tupdesc, (AttrNumber) 3,
                        "modification", TIMESTAMPTZOID, -1, 0);
     TupleDescInitEntry(tupdesc, (AttrNumber) 4,
                        "change", TIMESTAMPTZOID, -1, 0);
     TupleDescInitEntry(tupdesc, (AttrNumber) 5,
                        "creation", TIMESTAMPTZOID, -1, 0);
     TupleDescInitEntry(tupdesc, (AttrNumber) 6,
                        "isdir", BOOLOID, -1, 0);
     BlessTupleDesc(tupdesc);
 
     memset(isnull, false, sizeof(isnull));
 
     values[0] = Int64GetDatum((int64) fst.st_size);
     values[1] = TimestampTzGetDatum(time_t_to_timestamptz(fst.st_atime));
     values[2] = TimestampTzGetDatum(time_t_to_timestamptz(fst.st_mtime));
     /* Unix has file status change time, while Win32 has creation time */
 #if !defined(WIN32) && !defined(__CYGWIN__)
     values[3] = TimestampTzGetDatum(time_t_to_timestamptz(fst.st_ctime));
     isnull[4] = true;
 #else
     isnull[3] = true;
     values[4] = TimestampTzGetDatum(time_t_to_timestamptz(fst.st_ctime));
 #endif
     values[5] = BoolGetDatum(S_ISDIR(fst.st_mode));
 
     tuple = heap_form_tuple(tupdesc, values, isnull);
 
     pfree(filename);
 
     PG_RETURN_DATUM(HeapTupleGetDatum(tuple));
 }

Datum pg_stat_file_1arg ( PG_FUNCTION_ARGS )

Definition at line 386 of file genfile.c.

References pg_stat_file().

 {
     return pg_stat_file(fcinfo);
 }

static bytea* read_binary_file	(	const char *	filename,
		int64	seek_offset,
		int64	bytes_to_read,
		bool	missing_ok
	)

static

Definition at line 93 of file genfile.c.

References AllocateFile(), buf, ereport, errcode(), errcode_for_file_access(), errmsg(), ERROR, FreeFile(), fseeko, MaxAllocSize, palloc(), PG_BINARY_R, SET_VARSIZE, VARDATA, and VARHDRSZ.

Referenced by pg_read_binary_file(), and read_text_file().

 {
     bytea      *buf;
     size_t      nbytes;
     FILE       *file;
 
     if (bytes_to_read < 0)
     {
         if (seek_offset < 0)
             bytes_to_read = -seek_offset;
         else
         {
             struct stat fst;
 
             if (stat(filename, &fst) < 0)
             {
                 if (missing_ok && errno == ENOENT)
                     return NULL;
                 else
                     ereport(ERROR,
                             (errcode_for_file_access(),
                              errmsg("could not stat file \"%s\": %m", filename)));
             }
 
             bytes_to_read = fst.st_size - seek_offset;
         }
     }
 
     /* not sure why anyone thought that int64 length was a good idea */
     if (bytes_to_read > (MaxAllocSize - VARHDRSZ))
         ereport(ERROR,
                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                  errmsg("requested length too large")));
 
     if ((file = AllocateFile(filename, PG_BINARY_R)) == NULL)
     {
         if (missing_ok && errno == ENOENT)
             return NULL;
         else
             ereport(ERROR,
                     (errcode_for_file_access(),
                      errmsg("could not open file \"%s\" for reading: %m",
                             filename)));
     }
 
     if (fseeko(file, (off_t) seek_offset,
                (seek_offset >= 0) ? SEEK_SET : SEEK_END) != 0)
         ereport(ERROR,
                 (errcode_for_file_access(),
                  errmsg("could not seek in file \"%s\": %m", filename)));
 
     buf = (bytea *) palloc((Size) bytes_to_read + VARHDRSZ);
 
     nbytes = fread(VARDATA(buf), 1, (size_t) bytes_to_read, file);
 
     if (ferror(file))
         ereport(ERROR,
                 (errcode_for_file_access(),
                  errmsg("could not read file \"%s\": %m", filename)));
 
     SET_VARSIZE(buf, nbytes + VARHDRSZ);
 
     FreeFile(file);
 
     return buf;
 }

static text* read_text_file	(	const char *	filename,
		int64	seek_offset,
		int64	bytes_to_read,
		bool	missing_ok
	)

static

Definition at line 166 of file genfile.c.

References buf, pg_verifymbstr(), read_binary_file(), VARDATA, VARHDRSZ, and VARSIZE.

Referenced by pg_read_file().

 {
     bytea      *buf;
 
     buf = read_binary_file(filename, seek_offset, bytes_to_read, missing_ok);
 
     if (buf != NULL)
     {
         /* Make sure the input is valid */
         pg_verifymbstr(VARDATA(buf), VARSIZE(buf) - VARHDRSZ, false);
 
         /* OK, we can cast it to text safely */
         return (text *) buf;
     }
     else
         return NULL;
 }

Data Structures

Functions

Function Documentation