Adjust configuration-files GUC behavior as per my recent proposal.

The vars are renamed to data_directory, config_file, hba_file, and
ident_file, and are guaranteed to be set to accurate absolute paths
during postmaster startup.
This commit does not yet do anything about hiding path values from
non-superusers.

Author: tglsfdc

doc/src/sgml/runtime.sgml

@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.286 2004/10/08 01:36:31 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.287 2004/10/09 23:12:53 tgl Exp $
 -->
 
 <Chapter Id="runtime">
@@ -568,8 +568,8 @@ SET ENABLE_SEQSCAN TO OFF;
     <title>File Locations</title>
 
      <variablelist>
-     <varlistentry id="guc-pgdata" xreflabel="pgdata">
-      <term><varname>pgdata</varname> (<type>string</type>)</term>
+     <varlistentry id="guc-data-directory" xreflabel="data-directory">
+      <term><varname>data_directory</varname> (<type>string</type>)</term>
       <listitem>
        <para>
          Specifies the directory to use for data storage.
@@ -578,36 +578,45 @@ SET ENABLE_SEQSCAN TO OFF;
       </listitem>
      </varlistentry>
 
-     <varlistentry id="guc-hba-conf" xreflabel="hba-conf">
-      <term><varname>hba_conf</varname> (<type>string</type>)</term>
+     <varlistentry id="guc-config-file" xreflabel="config-file">
+      <term><varname>config_file</varname> (<type>string</type>)</term>
       <listitem>
        <para>
-         Specifies the file name to use for configuration of host-based 
-         authentication (HBA).
-         This option can only be set at server start or in the
-         <filename>postgresql.conf</filename> file.
+         Specifies the main server configuration file
+	 (customarily called <filename>postgresql.conf</>).
+         This option can only be set on the postmaster command line.
        </para>
       </listitem>
      </varlistentry>
 
-     <varlistentry id="guc-ident-conf" xreflabel="ident-conf">
-      <term><varname>ident_conf</varname> (<type>string</type>)</term>
+     <varlistentry id="guc-hba-file" xreflabel="hba-file">
+      <term><varname>hba_file</varname> (<type>string</type>)</term>
       <listitem>
        <para>
-         Specifies the file name to use for configuration of 
+         Specifies the configuration file for host-based authentication.
+         This option can only be set at server start.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry id="guc-ident-file" xreflabel="ident-file">
+      <term><varname>ident_file</varname> (<type>string</type>)</term>
+      <listitem>
+       <para>
+         Specifies the configuration file for
          <application>ident</> authentication.
-         This option can only be set at server start or in the
-         <filename>postgresql.conf</filename> file.
+         This option can only be set at server start.
        </para>
       </listitem>
      </varlistentry>
 
-     <varlistentry id="external-pidfile" xreflabel="external-pidfile">
-      <term><varname>external_pidfile</varname> (<type>string</type>)</term>
+     <varlistentry id="external-pid-file" xreflabel="external-pid-file">
+      <term><varname>external_pid_file</varname> (<type>string</type>)</term>
       <listitem>
        <para>
-         Specifies the location of an additional <application>postmaster</>
-         process-id (PID) file for use by server administration programs.
+         Specifies that the <application>postmaster</> should create an
+	 additional process-id (PID) file for use by server administration
+	 programs.
          This option can only be set at server start.
        </para>
       </listitem>
@@ -616,11 +625,10 @@ SET ENABLE_SEQSCAN TO OFF;
 
      <para>
       In a default installation, none of the above options is set explicitly
-      in the <filename>postgresql.conf</filename> file.  In this case, the
+      in the <filename>postgresql.conf</filename> file.  Instead, the
       data directory is specified by the <option>-D</option> command-line
-      option or the <envar>PGDATA</envar> environment variable; there is no
-      default for it.  The configuration files are all placed within the
-      data directory.
+      option or the <envar>PGDATA</envar> environment variable, and the
+      configuration files are all placed within the data directory.
      </para>
 
      <para>
@@ -630,27 +638,29 @@ SET ENABLE_SEQSCAN TO OFF;
       when they are kept separate.)  To do this, the <option>-D</option>
       command-line option or <envar>PGDATA</envar> environment variable
       must point to the directory containing the configuration files,
-      and the <varname>pgdata</> option is set in
+      and the <varname>data_directory</> option is set in
       <filename>postgresql.conf</filename> (or on the command line) to show
-      where the data directory is actually located.
+      where the data directory is actually located.  Notice that
+      <varname>data_directory</> overrides <option>-D</option> for the location
+      of the data directory, but not for the location of the configuration
+      files.
      </para>
 
      <para>
-      If you wish, you can also make the <option>-D</option>
-      command-line option or <envar>PGDATA</envar> environment variable
-      point directly to the master configuration file (which then need not be
-      named <filename>postgresql.conf</filename>).  The <varname>pgdata</>
-      option must be set to determine the data directory location.
-      The other configuration files will by default be sought
-      in the data directory.
+      If you wish, you can specify the configuration file names and locations
+      individually using the options <varname>config_file</>,
+      <varname>hba_file</> and/or <varname>ident_file</>.
+      <varname>config_file</> can only be specified on the 
+      <command>postmaster</command> command line, but the others can be
+      set within the main configuration file.  If all three options plus
+      <varname>data_directory</> are explicitly set, then it is not necessary
+      to specify <option>-D</option> or <envar>PGDATA</envar>.
      </para>
 
      <para>
-      With any of these approaches, you can specify the locations of the
-      secondary configuration files (<filename>pg_hba.conf</> and
-      <filename>pg_ident.conf</>) by setting <varname>hba_conf</> and/or
-      <varname>ident_conf</> in the master configuration file.  These options
-      override the normal locations and names of the secondary files.
+      When setting any of these options, a relative path will be interpreted
+      with respect to the directory in which the <command>postmaster</command>
+      is started.
      </para>
    </sect2>
 

src/backend/libpq/hba.c

@@ -10,7 +10,7 @@
  *
  *
  * IDENTIFICATION
- *	  $PostgreSQL: pgsql/src/backend/libpq/hba.c,v 1.131 2004/10/08 01:36:34 tgl Exp $
+ *	  $PostgreSQL: pgsql/src/backend/libpq/hba.c,v 1.132 2004/10/09 23:12:57 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -44,12 +44,6 @@
 /* Standard TCP port number for Ident service.	Assigned by IANA */
 #define IDENT_PORT 113
 
-/* Name of the config file	*/
-#define CONF_FILE "pg_hba.conf"
-
-/* Name of the usermap file */
-#define USERMAP_FILE "pg_ident.conf"
-
 /* This is used to separate values in multi-valued column strings */
 #define MULTI_VALUE_SEP "\001"
 
@@ -65,11 +59,11 @@
  * one token, since blank lines are not entered in the data structure.
  */
 
-/* pre-parsed content of CONF_FILE and corresponding line #s */
+/* pre-parsed content of HBA config file and corresponding line #s */
 static List *hba_lines = NIL;
 static List *hba_line_nums = NIL;
 
-/* pre-parsed content of USERMAP_FILE and corresponding line #s */
+/* pre-parsed content of ident usermap file and corresponding line #s */
 static List *ident_lines = NIL;
 static List *ident_line_nums = NIL;
 
@@ -743,8 +737,9 @@ parse_hba(List *line, int line_num, hbaPort *port,
 		{
 			ereport(LOG,
 					(errcode(ERRCODE_CONFIG_FILE_ERROR),
-					 errmsg("invalid IP address \"%s\" in pg_hba.conf file line %d: %s",
-							token, line_num, gai_strerror(ret))));
+					 errmsg("invalid IP address \"%s\" in \"%s\" line %d: %s",
+							token, HbaFileName, line_num,
+							gai_strerror(ret))));
 			if (cidr_slash)
 				*cidr_slash = '/';
 			if (gai_result)
@@ -777,8 +772,9 @@ parse_hba(List *line, int line_num, hbaPort *port,
 			{
 				ereport(LOG,
 						(errcode(ERRCODE_CONFIG_FILE_ERROR),
-						 errmsg("invalid IP mask \"%s\" in pg_hba.conf file line %d: %s",
-								token, line_num, gai_strerror(ret))));
+						 errmsg("invalid IP mask \"%s\" in \"%s\" line %d: %s",
+								token, HbaFileName, line_num,
+								gai_strerror(ret))));
 				if (gai_result)
 					freeaddrinfo_all(hints.ai_family, gai_result);
 				goto hba_other_error;
@@ -791,8 +787,8 @@ parse_hba(List *line, int line_num, hbaPort *port,
 			{
 				ereport(LOG,
 						(errcode(ERRCODE_CONFIG_FILE_ERROR),
-						 errmsg("IP address and mask do not match in pg_hba.conf file line %d",
-								line_num)));
+						 errmsg("IP address and mask do not match in \"%s\" line %d",
+								HbaFileName, line_num)));
 				goto hba_other_error;
 			}
 		}
@@ -849,13 +845,14 @@ parse_hba(List *line, int line_num, hbaPort *port,
 	if (line_item)
 		ereport(LOG,
 				(errcode(ERRCODE_CONFIG_FILE_ERROR),
-				 errmsg("invalid entry in pg_hba.conf file at line %d, token \"%s\"",
-						line_num, (char *) lfirst(line_item))));
+				 errmsg("invalid entry in \"%s\" at line %d, token \"%s\"",
+						HbaFileName, line_num,
+						(char *) lfirst(line_item))));
 	else
 		ereport(LOG,
 				(errcode(ERRCODE_CONFIG_FILE_ERROR),
-			errmsg("missing field in pg_hba.conf file at end of line %d",
-				   line_num)));
+			errmsg("missing field in \"%s\" at end of line %d",
+				   HbaFileName, line_num)));
 
 	/* Come here if suitable message already logged */
 hba_other_error:
@@ -1030,42 +1027,25 @@ load_user(void)
 
 /*
  * Read the config file and create a List of Lists of tokens in the file.
- * If we find a file by the old name of the config file (pg_hba), we issue
- * an error message because it probably needs to be converted.	He didn't
- * follow directions and just installed his old hba file in the new database
- * system.
  */
 void
 load_hba(void)
 {
-	FILE	   *file;			/* The config file we have to read */
-	char	   *conf_file;		/* The name of the config file */
+	FILE	   *file;
 
 	if (hba_lines || hba_line_nums)
 		free_lines(&hba_lines, &hba_line_nums);
 
-	if (guc_hbafile)
-	{
-		/* HBA filename specified in config file */
-		conf_file = pstrdup(guc_hbafile);
-	}
-	else
-	{
-		/* put together the full pathname to the config file */
-		conf_file = palloc(strlen(ConfigDir) + strlen(CONF_FILE) + 2);
-		sprintf(conf_file, "%s/%s", ConfigDir, CONF_FILE);
-	}
-
-	file = AllocateFile(conf_file, "r");
+	file = AllocateFile(HbaFileName, "r");
+	/* Failure is fatal since with no HBA entries we can do nothing... */
 	if (file == NULL)
 		ereport(FATAL,
 				(errcode_for_file_access(),
 				 errmsg("could not open configuration file \"%s\": %m",
-						conf_file)));
+						HbaFileName)));
 
 	tokenize_file(file, &hba_lines, &hba_line_nums);
 	FreeFile(file);
-	pfree(conf_file);
 }
 
 
@@ -1121,13 +1101,14 @@ parse_ident_usermap(List *line, int line_number, const char *usermap_name,
 	if (line_item)
 		ereport(LOG,
 				(errcode(ERRCODE_CONFIG_FILE_ERROR),
-				 errmsg("invalid entry in pg_ident.conf file at line %d, token \"%s\"",
-						line_number, (const char *) lfirst(line_item))));
+				 errmsg("invalid entry in \"%s\" at line %d, token \"%s\"",
+						IdentFileName, line_number,
+						(const char *) lfirst(line_item))));
 	else
 		ereport(LOG,
 				(errcode(ERRCODE_CONFIG_FILE_ERROR),
-		  errmsg("missing entry in pg_ident.conf file at end of line %d",
-				 line_number)));
+		  errmsg("missing entry in \"%s\" at end of line %d",
+				 IdentFileName, line_number)));
 
 	*error_p = true;
 }
@@ -1191,38 +1172,25 @@ check_ident_usermap(const char *usermap_name,
 void
 load_ident(void)
 {
-	FILE	   *file;			/* The map file we have to read */
-	char	   *map_file;		/* The name of the map file we have to
-								 * read */
+	FILE	   *file;
 
 	if (ident_lines || ident_line_nums)
 		free_lines(&ident_lines, &ident_line_nums);
 
-	if (guc_identfile)
-	{
-		/* IDENT filename specified in config file */
-		map_file = pstrdup(guc_identfile);
-	}
-	else
-	{
-		map_file = palloc(strlen(ConfigDir) + strlen(USERMAP_FILE) + 2);
-		sprintf(map_file, "%s/%s", ConfigDir, USERMAP_FILE);
-	}
-
-	file = AllocateFile(map_file, "r");
+	file = AllocateFile(IdentFileName, "r");
 	if (file == NULL)
 	{
+		/* not fatal ... we just won't do any special ident maps */
 		ereport(LOG,
 				(errcode_for_file_access(),
 				 errmsg("could not open Ident usermap file \"%s\": %m",
-						map_file)));
+						IdentFileName)));
 	}
 	else
 	{
 		tokenize_file(file, &ident_lines, &ident_line_nums);
 		FreeFile(file);
 	}
-	pfree(map_file);
 }