PostgreSQL Source Code  git master
dropuser.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * dropuser
4  *
5  * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
6  * Portions Copyright (c) 1994, Regents of the University of California
7  *
8  * src/bin/scripts/dropuser.c
9  *
10  *-------------------------------------------------------------------------
11  */
12 
13 #include "postgres_fe.h"
14 #include "common.h"
15 #include "common/logging.h"
16 #include "common/string.h"
17 #include "fe_utils/option_utils.h"
18 #include "fe_utils/string_utils.h"
19 
20 
21 static void help(const char *progname);
22 
23 
24 int
25 main(int argc, char *argv[])
26 {
27  static int if_exists = 0;
28 
29  static struct option long_options[] = {
30  {"host", required_argument, NULL, 'h'},
31  {"port", required_argument, NULL, 'p'},
32  {"username", required_argument, NULL, 'U'},
33  {"no-password", no_argument, NULL, 'w'},
34  {"password", no_argument, NULL, 'W'},
35  {"echo", no_argument, NULL, 'e'},
36  {"interactive", no_argument, NULL, 'i'},
37  {"if-exists", no_argument, &if_exists, 1},
38  {NULL, 0, NULL, 0}
39  };
40 
41  const char *progname;
42  int optindex;
43  int c;
44 
45  char *dropuser = NULL;
46  char *host = NULL;
47  char *port = NULL;
48  char *username = NULL;
49  enum trivalue prompt_password = TRI_DEFAULT;
50  ConnParams cparams;
51  bool echo = false;
52  bool interactive = false;
53 
54  PQExpBufferData sql;
55 
56  PGconn *conn;
57  PGresult *result;
58 
59  pg_logging_init(argv[0]);
60  progname = get_progname(argv[0]);
61  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pgscripts"));
62 
63  handle_help_version_opts(argc, argv, "dropuser", help);
64 
65  while ((c = getopt_long(argc, argv, "h:p:U:wWei", long_options, &optindex)) != -1)
66  {
67  switch (c)
68  {
69  case 'h':
70  host = pg_strdup(optarg);
71  break;
72  case 'p':
74  break;
75  case 'U':
77  break;
78  case 'w':
79  prompt_password = TRI_NO;
80  break;
81  case 'W':
82  prompt_password = TRI_YES;
83  break;
84  case 'e':
85  echo = true;
86  break;
87  case 'i':
88  interactive = true;
89  break;
90  case 0:
91  /* this covers the long options */
92  break;
93  default:
94  /* getopt_long already emitted a complaint */
95  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
96  exit(1);
97  }
98  }
99 
100  switch (argc - optind)
101  {
102  case 0:
103  break;
104  case 1:
105  dropuser = argv[optind];
106  break;
107  default:
108  pg_log_error("too many command-line arguments (first is \"%s\")",
109  argv[optind + 1]);
110  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
111  exit(1);
112  }
113 
114  if (dropuser == NULL)
115  {
116  if (interactive)
117  {
118  dropuser = simple_prompt("Enter name of role to drop: ", true);
119  }
120  else
121  {
122  pg_log_error("missing required argument role name");
123  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
124  exit(1);
125  }
126  }
127 
128  if (interactive)
129  {
130  printf(_("Role \"%s\" will be permanently removed.\n"), dropuser);
131  if (!yesno_prompt("Are you sure?"))
132  exit(0);
133  }
134 
135  cparams.dbname = NULL; /* this program lacks any dbname option... */
136  cparams.pghost = host;
137  cparams.pgport = port;
138  cparams.pguser = username;
139  cparams.prompt_password = prompt_password;
140  cparams.override_dbname = NULL;
141 
142  conn = connectMaintenanceDatabase(&cparams, progname, echo);
143 
144  initPQExpBuffer(&sql);
145  appendPQExpBuffer(&sql, "DROP ROLE %s%s;",
146  (if_exists ? "IF EXISTS " : ""), fmtId(dropuser));
147 
148  if (echo)
149  printf("%s\n", sql.data);
150  result = PQexec(conn, sql.data);
151 
152  if (PQresultStatus(result) != PGRES_COMMAND_OK)
153  {
154  pg_log_error("removal of role \"%s\" failed: %s",
155  dropuser, PQerrorMessage(conn));
156  PQfinish(conn);
157  exit(1);
158  }
159 
160  PQclear(result);
161  PQfinish(conn);
162  exit(0);
163 }
164 
165 
166 static void
167 help(const char *progname)
168 {
169  printf(_("%s removes a PostgreSQL role.\n\n"), progname);
170  printf(_("Usage:\n"));
171  printf(_(" %s [OPTION]... [ROLENAME]\n"), progname);
172  printf(_("\nOptions:\n"));
173  printf(_(" -e, --echo show the commands being sent to the server\n"));
174  printf(_(" -i, --interactive prompt before deleting anything, and prompt for\n"
175  " role name if not specified\n"));
176  printf(_(" -V, --version output version information, then exit\n"));
177  printf(_(" --if-exists don't report error if user doesn't exist\n"));
178  printf(_(" -?, --help show this help, then exit\n"));
179  printf(_("\nConnection options:\n"));
180  printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
181  printf(_(" -p, --port=PORT database server port\n"));
182  printf(_(" -U, --username=USERNAME user name to connect as (not the one to drop)\n"));
183  printf(_(" -w, --no-password never prompt for password\n"));
184  printf(_(" -W, --password force password prompt\n"));
185  printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
186  printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
187 }
bool yesno_prompt(const char *question)
Definition: common.c:136
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1212
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:446
PGconn * connectMaintenanceDatabase(ConnParams *cparams, const char *progname, bool echo)
int main(int argc, char *argv[])
Definition: dropuser.c:25
static void help(const char *progname)
Definition: dropuser.c:167
#define _(x)
Definition: elog.c:89
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:6908
void PQfinish(PGconn *conn)
Definition: fe-connect.c:4261
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:3270
void PQclear(PGresult *res)
Definition: fe-exec.c:718
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:2273
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:57
#define no_argument
Definition: getopt_long.h:24
#define required_argument
Definition: getopt_long.h:25
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:97
exit(1)
void pg_logging_init(const char *argv0)
Definition: logging.c:83
#define pg_log_error(...)
Definition: logging.h:106
#define pg_log_error_hint(...)
Definition: logging.h:112
const char * progname
Definition: main.c:50
void handle_help_version_opts(int argc, char *argv[], const char *fixed_progname, help_handler hlp)
Definition: option_utils.c:24
static int if_exists
Definition: pg_dumpall.c:73
PGDLLIMPORT int optind
Definition: getopt.c:50
PGDLLIMPORT char * optarg
Definition: getopt.c:52
static int port
Definition: pg_regress.c:92
const char * username
Definition: pgbench.c:309
const char * get_progname(const char *argv0)
Definition: path.c:574
#define printf(...)
Definition: port.h:231
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:92
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:267
char * c
char * simple_prompt(const char *prompt, bool echo)
Definition: sprompt.c:38
PGconn * conn
Definition: streamutil.c:54
const char * fmtId(const char *rawid)
Definition: string_utils.c:64
const char * pguser
Definition: connect_utils.h:31
char * override_dbname
Definition: pg_backup.h:89
char * pgport
Definition: pg_backup.h:83
char * pghost
Definition: pg_backup.h:84
char * dbname
Definition: pg_backup.h:82
enum trivalue prompt_password
Definition: connect_utils.h:32
trivalue
Definition: vacuumlo.c:35
@ TRI_YES
Definition: vacuumlo.c:38
@ TRI_DEFAULT
Definition: vacuumlo.c:36
@ TRI_NO
Definition: vacuumlo.c:37