PostgreSQL Source Code  git master
dumputils.h File Reference
#include "libpq-fe.h"
#include "pqexpbuffer.h"
Include dependency graph for dumputils.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define PGDUMP_STRFTIME_FMT   "%Y-%m-%d %H:%M:%S %Z"
 

Functions

bool buildACLCommands (const char *name, const char *subname, const char *nspname, const char *type, const char *acls, const char *baseacls, const char *owner, const char *prefix, int remoteVersion, PQExpBuffer sql)
 
bool buildDefaultACLCommands (const char *type, const char *nspname, const char *acls, const char *acldefault, const char *owner, int remoteVersion, PQExpBuffer sql)
 
void quoteAclUserName (PQExpBuffer output, const char *input)
 
void buildShSecLabelQuery (const char *catalog_name, Oid objectId, PQExpBuffer sql)
 
void emitShSecLabels (PGconn *conn, PGresult *res, PQExpBuffer buffer, const char *objtype, const char *objname)
 
bool variable_is_guc_list_quote (const char *name)
 
bool SplitGUCList (char *rawstring, char separator, char ***namelist)
 
void makeAlterConfigCommand (PGconn *conn, const char *configitem, const char *type, const char *name, const char *type2, const char *name2, PQExpBuffer buf)
 

Macro Definition Documentation

◆ PGDUMP_STRFTIME_FMT

#define PGDUMP_STRFTIME_FMT   "%Y-%m-%d %H:%M:%S %Z"

Definition at line 33 of file dumputils.h.

Function Documentation

◆ buildACLCommands()

bool buildACLCommands ( const char *  name,
const char *  subname,
const char *  nspname,
const char *  type,
const char *  acls,
const char *  baseacls,
const char *  owner,
const char *  prefix,
int  remoteVersion,
PQExpBuffer  sql 
)

Definition at line 64 of file dumputils.c.

68 {
69  bool ok = true;
70  char **aclitems = NULL;
71  char **baseitems = NULL;
72  char **grantitems = NULL;
73  char **revokeitems = NULL;
74  int naclitems = 0;
75  int nbaseitems = 0;
76  int ngrantitems = 0;
77  int nrevokeitems = 0;
78  int i;
79  PQExpBuffer grantee,
80  grantor,
81  privs,
82  privswgo;
83  PQExpBuffer firstsql,
84  secondsql;
85 
86  /*
87  * If the acl was NULL (initial default state), we need do nothing. Note
88  * that this is distinguishable from all-privileges-revoked, which will
89  * look like an empty array ("{}").
90  */
91  if (acls == NULL || *acls == '\0')
92  return true; /* object has default permissions */
93 
94  /* treat empty-string owner same as NULL */
95  if (owner && *owner == '\0')
96  owner = NULL;
97 
98  /* Parse the acls array */
99  if (!parsePGArray(acls, &aclitems, &naclitems))
100  {
101  if (aclitems)
102  free(aclitems);
103  return false;
104  }
105 
106  /* Parse the baseacls too */
107  if (!parsePGArray(baseacls, &baseitems, &nbaseitems))
108  {
109  if (aclitems)
110  free(aclitems);
111  if (baseitems)
112  free(baseitems);
113  return false;
114  }
115 
116  /*
117  * Compare the actual ACL with the base ACL, extracting the privileges
118  * that need to be granted (i.e., are in the actual ACL but not the base
119  * ACL) and the ones that need to be revoked (the reverse). We use plain
120  * string comparisons to check for matches. In principle that could be
121  * fooled by extraneous issues such as whitespace, but since all these
122  * strings are the work of aclitemout(), it should be OK in practice.
123  * Besides, a false mismatch will just cause the output to be a little
124  * more verbose than it really needed to be.
125  */
126  grantitems = (char **) pg_malloc(naclitems * sizeof(char *));
127  for (i = 0; i < naclitems; i++)
128  {
129  bool found = false;
130 
131  for (int j = 0; j < nbaseitems; j++)
132  {
133  if (strcmp(aclitems[i], baseitems[j]) == 0)
134  {
135  found = true;
136  break;
137  }
138  }
139  if (!found)
140  grantitems[ngrantitems++] = aclitems[i];
141  }
142  revokeitems = (char **) pg_malloc(nbaseitems * sizeof(char *));
143  for (i = 0; i < nbaseitems; i++)
144  {
145  bool found = false;
146 
147  for (int j = 0; j < naclitems; j++)
148  {
149  if (strcmp(baseitems[i], aclitems[j]) == 0)
150  {
151  found = true;
152  break;
153  }
154  }
155  if (!found)
156  revokeitems[nrevokeitems++] = baseitems[i];
157  }
158 
159  /* Prepare working buffers */
160  grantee = createPQExpBuffer();
161  grantor = createPQExpBuffer();
162  privs = createPQExpBuffer();
163  privswgo = createPQExpBuffer();
164 
165  /*
166  * At the end, these two will be pasted together to form the result.
167  */
168  firstsql = createPQExpBuffer();
169  secondsql = createPQExpBuffer();
170 
171  /*
172  * Build REVOKE statements for ACLs listed in revokeitems[].
173  */
174  for (i = 0; i < nrevokeitems; i++)
175  {
176  if (!parseAclItem(revokeitems[i],
177  type, name, subname, remoteVersion,
178  grantee, grantor, privs, NULL))
179  {
180  ok = false;
181  break;
182  }
183 
184  if (privs->len > 0)
185  {
186  appendPQExpBuffer(firstsql, "%sREVOKE %s ON %s ",
187  prefix, privs->data, type);
188  if (nspname && *nspname)
189  appendPQExpBuffer(firstsql, "%s.", fmtId(nspname));
190  appendPQExpBuffer(firstsql, "%s FROM ", name);
191  if (grantee->len == 0)
192  appendPQExpBufferStr(firstsql, "PUBLIC;\n");
193  else
194  appendPQExpBuffer(firstsql, "%s;\n",
195  fmtId(grantee->data));
196  }
197  }
198 
199  /*
200  * At this point we have issued REVOKE statements for all initial and
201  * default privileges that are no longer present on the object, so we are
202  * almost ready to GRANT the privileges listed in grantitems[].
203  *
204  * We still need some hacking though to cover the case where new default
205  * public privileges are added in new versions: the REVOKE ALL will revoke
206  * them, leading to behavior different from what the old version had,
207  * which is generally not what's wanted. So add back default privs if the
208  * source database is too old to have had that particular priv. (As of
209  * right now, no such cases exist in supported versions.)
210  */
211 
212  /*
213  * Scan individual ACL items to be granted.
214  *
215  * The order in which privileges appear in the ACL string (the order they
216  * have been GRANT'd in, which the backend maintains) must be preserved to
217  * ensure that GRANTs WITH GRANT OPTION and subsequent GRANTs based on
218  * those are dumped in the correct order. However, some old server
219  * versions will show grants to PUBLIC before the owner's own grants; for
220  * consistency's sake, force the owner's grants to be output first.
221  */
222  for (i = 0; i < ngrantitems; i++)
223  {
224  if (parseAclItem(grantitems[i], type, name, subname, remoteVersion,
225  grantee, grantor, privs, privswgo))
226  {
227  /*
228  * If the grantor isn't the owner, we'll need to use SET SESSION
229  * AUTHORIZATION to become the grantor. Issue the SET/RESET only
230  * if there's something useful to do.
231  */
232  if (privs->len > 0 || privswgo->len > 0)
233  {
234  PQExpBuffer thissql;
235 
236  /* Set owner as grantor if that's not explicit in the ACL */
237  if (grantor->len == 0 && owner)
238  printfPQExpBuffer(grantor, "%s", owner);
239 
240  /* Make sure owner's own grants are output before others */
241  if (owner &&
242  strcmp(grantee->data, owner) == 0 &&
243  strcmp(grantor->data, owner) == 0)
244  thissql = firstsql;
245  else
246  thissql = secondsql;
247 
248  if (grantor->len > 0
249  && (!owner || strcmp(owner, grantor->data) != 0))
250  appendPQExpBuffer(thissql, "SET SESSION AUTHORIZATION %s;\n",
251  fmtId(grantor->data));
252 
253  if (privs->len > 0)
254  {
255  appendPQExpBuffer(thissql, "%sGRANT %s ON %s ",
256  prefix, privs->data, type);
257  if (nspname && *nspname)
258  appendPQExpBuffer(thissql, "%s.", fmtId(nspname));
259  appendPQExpBuffer(thissql, "%s TO ", name);
260  if (grantee->len == 0)
261  appendPQExpBufferStr(thissql, "PUBLIC;\n");
262  else
263  appendPQExpBuffer(thissql, "%s;\n", fmtId(grantee->data));
264  }
265  if (privswgo->len > 0)
266  {
267  appendPQExpBuffer(thissql, "%sGRANT %s ON %s ",
268  prefix, privswgo->data, type);
269  if (nspname && *nspname)
270  appendPQExpBuffer(thissql, "%s.", fmtId(nspname));
271  appendPQExpBuffer(thissql, "%s TO ", name);
272  if (grantee->len == 0)
273  appendPQExpBufferStr(thissql, "PUBLIC");
274  else
275  appendPQExpBufferStr(thissql, fmtId(grantee->data));
276  appendPQExpBufferStr(thissql, " WITH GRANT OPTION;\n");
277  }
278 
279  if (grantor->len > 0
280  && (!owner || strcmp(owner, grantor->data) != 0))
281  appendPQExpBufferStr(thissql, "RESET SESSION AUTHORIZATION;\n");
282  }
283  }
284  else
285  {
286  /* parseAclItem failed, give up */
287  ok = false;
288  break;
289  }
290  }
291 
292  destroyPQExpBuffer(grantee);
293  destroyPQExpBuffer(grantor);
294  destroyPQExpBuffer(privs);
295  destroyPQExpBuffer(privswgo);
296 
297  appendPQExpBuffer(sql, "%s%s", firstsql->data, secondsql->data);
298  destroyPQExpBuffer(firstsql);
299  destroyPQExpBuffer(secondsql);
300 
301  if (aclitems)
302  free(aclitems);
303  if (baseitems)
304  free(baseitems);
305  if (grantitems)
306  free(grantitems);
307  if (revokeitems)
308  free(revokeitems);
309 
310  return ok;
311 }
static bool parseAclItem(const char *item, const char *type, const char *name, const char *subname, int remoteVersion, PQExpBuffer grantee, PQExpBuffer grantor, PQExpBuffer privs, PQExpBuffer privswgo)
Definition: dumputils.c:384
const char * name
Definition: encode.c:561
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
#define free(a)
Definition: header.h:65
int j
Definition: isn.c:74
int i
Definition: isn.c:73
NameData subname
void printfPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:237
PQExpBuffer createPQExpBuffer(void)
Definition: pqexpbuffer.c:74
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:267
void destroyPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:116
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:369
const char * fmtId(const char *rawid)
Definition: string_utils.c:64
bool parsePGArray(const char *atext, char ***itemarray, int *nitems)
Definition: string_utils.c:657

References appendPQExpBuffer(), appendPQExpBufferStr(), createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), fmtId(), free, i, j, PQExpBufferData::len, name, parseAclItem(), parsePGArray(), pg_malloc(), printfPQExpBuffer(), subname, and generate_unaccent_rules::type.

Referenced by buildDefaultACLCommands(), dumpACL(), dumpRoleGUCPrivs(), and dumpTablespaces().

◆ buildDefaultACLCommands()

bool buildDefaultACLCommands ( const char *  type,
const char *  nspname,
const char *  acls,
const char *  acldefault,
const char *  owner,
int  remoteVersion,
PQExpBuffer  sql 
)

Definition at line 327 of file dumputils.c.

332 {
333  PQExpBuffer prefix;
334 
335  prefix = createPQExpBuffer();
336 
337  /*
338  * We incorporate the target role directly into the command, rather than
339  * playing around with SET ROLE or anything like that. This is so that a
340  * permissions error leads to nothing happening, rather than changing
341  * default privileges for the wrong user.
342  */
343  appendPQExpBuffer(prefix, "ALTER DEFAULT PRIVILEGES FOR ROLE %s ",
344  fmtId(owner));
345  if (nspname)
346  appendPQExpBuffer(prefix, "IN SCHEMA %s ", fmtId(nspname));
347 
348  /*
349  * There's no such thing as initprivs for a default ACL, so the base ACL
350  * is always just the object-type-specific default.
351  */
352  if (!buildACLCommands("", NULL, NULL, type,
353  acls, acldefault, owner,
354  prefix->data, remoteVersion, sql))
355  {
356  destroyPQExpBuffer(prefix);
357  return false;
358  }
359 
360  destroyPQExpBuffer(prefix);
361 
362  return true;
363 }
Acl * acldefault(ObjectType objtype, Oid ownerId)
Definition: acl.c:743
bool buildACLCommands(const char *name, const char *subname, const char *nspname, const char *type, const char *acls, const char *baseacls, const char *owner, const char *prefix, int remoteVersion, PQExpBuffer sql)
Definition: dumputils.c:64

References acldefault(), appendPQExpBuffer(), buildACLCommands(), createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), fmtId(), and generate_unaccent_rules::type.

Referenced by dumpDefaultACL().

◆ buildShSecLabelQuery()

void buildShSecLabelQuery ( const char *  catalog_name,
Oid  objectId,
PQExpBuffer  sql 
)

Definition at line 637 of file dumputils.c.

639 {
640  appendPQExpBuffer(sql,
641  "SELECT provider, label FROM pg_catalog.pg_shseclabel "
642  "WHERE classoid = 'pg_catalog.%s'::pg_catalog.regclass "
643  "AND objoid = '%u'", catalog_name, objectId);
644 }

References appendPQExpBuffer().

Referenced by buildShSecLabels(), and dumpDatabase().

◆ emitShSecLabels()

void emitShSecLabels ( PGconn conn,
PGresult res,
PQExpBuffer  buffer,
const char *  objtype,
const char *  objname 
)

Definition at line 655 of file dumputils.c.

657 {
658  int i;
659 
660  for (i = 0; i < PQntuples(res); i++)
661  {
662  char *provider = PQgetvalue(res, i, 0);
663  char *label = PQgetvalue(res, i, 1);
664 
665  /* must use fmtId result before calling it again */
666  appendPQExpBuffer(buffer,
667  "SECURITY LABEL FOR %s ON %s",
668  fmtId(provider), objtype);
669  appendPQExpBuffer(buffer,
670  " %s IS ",
671  fmtId(objname));
673  appendPQExpBufferStr(buffer, ";\n");
674  }
675 }
int PQntuples(const PGresult *res)
Definition: fe-exec.c:3340
char * PQgetvalue(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3735
static JitProviderCallbacks provider
Definition: jit.c:43
static char * label
PGconn * conn
Definition: streamutil.c:54
void appendStringLiteralConn(PQExpBuffer buf, const char *str, PGconn *conn)
Definition: string_utils.c:293

References appendPQExpBuffer(), appendPQExpBufferStr(), appendStringLiteralConn(), conn, fmtId(), i, label, PQgetvalue(), PQntuples(), provider, and res.

Referenced by buildShSecLabels(), and dumpDatabase().

◆ makeAlterConfigCommand()

void makeAlterConfigCommand ( PGconn conn,
const char *  configitem,
const char *  type,
const char *  name,
const char *  type2,
const char *  name2,
PQExpBuffer  buf 
)

Definition at line 823 of file dumputils.c.

827 {
828  char *mine;
829  char *pos;
830 
831  /* Parse the configitem. If we can't find an "=", silently do nothing. */
832  mine = pg_strdup(configitem);
833  pos = strchr(mine, '=');
834  if (pos == NULL)
835  {
836  pg_free(mine);
837  return;
838  }
839  *pos++ = '\0';
840 
841  /* Build the command, with suitable quoting for everything. */
842  appendPQExpBuffer(buf, "ALTER %s %s ", type, fmtId(name));
843  if (type2 != NULL && name2 != NULL)
844  appendPQExpBuffer(buf, "IN %s %s ", type2, fmtId(name2));
845  appendPQExpBuffer(buf, "SET %s TO ", fmtId(mine));
846 
847  /*
848  * Variables that are marked GUC_LIST_QUOTE were already fully quoted by
849  * flatten_set_variable_args() before they were put into the setconfig
850  * array. However, because the quoting rules used there aren't exactly
851  * like SQL's, we have to break the list value apart and then quote the
852  * elements as string literals. (The elements may be double-quoted as-is,
853  * but we can't just feed them to the SQL parser; it would do the wrong
854  * thing with elements that are zero-length or longer than NAMEDATALEN.)
855  *
856  * Variables that are not so marked should just be emitted as simple
857  * string literals. If the variable is not known to
858  * variable_is_guc_list_quote(), we'll do that; this makes it unsafe to
859  * use GUC_LIST_QUOTE for extension variables.
860  */
861  if (variable_is_guc_list_quote(mine))
862  {
863  char **namelist;
864  char **nameptr;
865 
866  /* Parse string into list of identifiers */
867  /* this shouldn't fail really */
868  if (SplitGUCList(pos, ',', &namelist))
869  {
870  for (nameptr = namelist; *nameptr; nameptr++)
871  {
872  if (nameptr != namelist)
873  appendPQExpBufferStr(buf, ", ");
874  appendStringLiteralConn(buf, *nameptr, conn);
875  }
876  }
877  pg_free(namelist);
878  }
879  else
881 
882  appendPQExpBufferStr(buf, ";\n");
883 
884  pg_free(mine);
885 }
bool variable_is_guc_list_quote(const char *name)
Definition: dumputils.c:689
bool SplitGUCList(char *rawstring, char separator, char ***namelist)
Definition: dumputils.c:723
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
void pg_free(void *ptr)
Definition: fe_memutils.c:105
static char * buf
Definition: pg_test_fsync.c:67

References appendPQExpBuffer(), appendPQExpBufferStr(), appendStringLiteralConn(), buf, conn, fmtId(), name, pg_free(), pg_strdup(), SplitGUCList(), generate_unaccent_rules::type, and variable_is_guc_list_quote().

Referenced by dumpDatabaseConfig(), and dumpUserConfig().

◆ quoteAclUserName()

void quoteAclUserName ( PQExpBuffer  output,
const char *  input 
)

Definition at line 544 of file dumputils.c.

545 {
546  const char *src;
547  bool safe = true;
548 
549  for (src = input; *src; src++)
550  {
551  /* This test had better match what putid() does */
552  if (!isalnum((unsigned char) *src) && *src != '_')
553  {
554  safe = false;
555  break;
556  }
557  }
558  if (!safe)
560  for (src = input; *src; src++)
561  {
562  /* A double quote character in a username is encoded as "" */
563  if (*src == '"')
566  }
567  if (!safe)
569 }
static void output(uint64 loop_count)
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:380

References appendPQExpBufferChar(), and output().

Referenced by getNamespaces().

◆ SplitGUCList()

bool SplitGUCList ( char *  rawstring,
char  separator,
char ***  namelist 
)

Definition at line 723 of file dumputils.c.

725 {
726  char *nextp = rawstring;
727  bool done = false;
728  char **nextptr;
729 
730  /*
731  * Since we disallow empty identifiers, this is a conservative
732  * overestimate of the number of pointers we could need. Allow one for
733  * list terminator.
734  */
735  *namelist = nextptr = (char **)
736  pg_malloc((strlen(rawstring) / 2 + 2) * sizeof(char *));
737  *nextptr = NULL;
738 
739  while (isspace((unsigned char) *nextp))
740  nextp++; /* skip leading whitespace */
741 
742  if (*nextp == '\0')
743  return true; /* allow empty string */
744 
745  /* At the top of the loop, we are at start of a new identifier. */
746  do
747  {
748  char *curname;
749  char *endp;
750 
751  if (*nextp == '"')
752  {
753  /* Quoted name --- collapse quote-quote pairs */
754  curname = nextp + 1;
755  for (;;)
756  {
757  endp = strchr(nextp + 1, '"');
758  if (endp == NULL)
759  return false; /* mismatched quotes */
760  if (endp[1] != '"')
761  break; /* found end of quoted name */
762  /* Collapse adjacent quotes into one quote, and look again */
763  memmove(endp, endp + 1, strlen(endp));
764  nextp = endp;
765  }
766  /* endp now points at the terminating quote */
767  nextp = endp + 1;
768  }
769  else
770  {
771  /* Unquoted name --- extends to separator or whitespace */
772  curname = nextp;
773  while (*nextp && *nextp != separator &&
774  !isspace((unsigned char) *nextp))
775  nextp++;
776  endp = nextp;
777  if (curname == nextp)
778  return false; /* empty unquoted name not allowed */
779  }
780 
781  while (isspace((unsigned char) *nextp))
782  nextp++; /* skip trailing whitespace */
783 
784  if (*nextp == separator)
785  {
786  nextp++;
787  while (isspace((unsigned char) *nextp))
788  nextp++; /* skip leading whitespace for next */
789  /* we expect another name, so done remains false */
790  }
791  else if (*nextp == '\0')
792  done = true;
793  else
794  return false; /* invalid syntax */
795 
796  /* Now safe to overwrite separator with a null */
797  *endp = '\0';
798 
799  /*
800  * Finished isolating current name --- add it to output array
801  */
802  *nextptr++ = curname;
803 
804  /* Loop back if we didn't reach end of string */
805  } while (!done);
806 
807  *nextptr = NULL;
808  return true;
809 }

References pg_malloc().

Referenced by makeAlterConfigCommand().

◆ variable_is_guc_list_quote()

bool variable_is_guc_list_quote ( const char *  name)

Definition at line 689 of file dumputils.c.

690 {
691  if (pg_strcasecmp(name, "local_preload_libraries") == 0 ||
692  pg_strcasecmp(name, "search_path") == 0 ||
693  pg_strcasecmp(name, "session_preload_libraries") == 0 ||
694  pg_strcasecmp(name, "shared_preload_libraries") == 0 ||
695  pg_strcasecmp(name, "temp_tablespaces") == 0 ||
696  pg_strcasecmp(name, "unix_socket_directories") == 0)
697  return true;
698  else
699  return false;
700 }
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36

References name, and pg_strcasecmp().

Referenced by dumpFunc(), and makeAlterConfigCommand().