ns_urlisdir(3aolserv) [debian man page]

Ns_UrlToFile(3aolserver)				   AOLserver Library Procedures 				  Ns_UrlToFile(3aolserver)

__________________________________________________________________________________________________________________________________________________

NAME

       Ns_SetUrlToFileProc, Ns_UrlIsDir, Ns_UrlIsFile, Ns_UrlToFile - URL to file mapping procedures

SYNOPSIS

       #include "ns.h"

       void
       Ns_SetUrlToFileProc(char *server, Ns_UrlToFileProc *procPtr)

       int
       Ns_UrlIsDir(char *server, char *url)

       int
       Ns_UrlIsFile(char *server, char *url)

       int
       Ns_UrlToFile(Ns_DString *dsPtr, char *server, char *url)
_________________________________________________________________

DESCRIPTION

       These  functions  map  URL paths to real files and directories. They are normally used to determine whether a given URL has a corresponding
       file or directory and to return the real filesystem path that corresponds to the URL.

       Ns_SetUrlToFileProc(server, procPtr)

	      Set a pointer to a custom routine to use in place of Ns_UrlToFile.

       Ns_UrlIsDir(server, url)

	      Construct a directory name by appending the URL to the current AOLserver pages directory for the specified server. Return NS_TRUE if
	      the directory exists; NS_FALSE otherwise.

       Ns_UrlIsFile(server, url)

	      Construct  a file name by appending the URL to the current AOLserver pages directory for the specified server. Return NS_TRUE if the
	      file exists and is a regular file; NS_FALSE otherwise.

	      Example:

	      /* IsFile - Simple request to determine if an URL is a file. */
	      int
	      IsFile(Ns_Conn *conn, void *ctx)
	      {
		  int isfile;
		  char *server;

		  server = Ns_ConnServer(conn);
		  isfile = Ns_UrlIsFile(server, conn->request->url);
		  if (isfile) {
		      Ns_ConnReturnNotice(conn, 200, "File", NULL);
		  } else {
		      Ns_ConnReturnNotice(conn, 200, "Not a File", NULL);
		  }
		  return NS_OK;
	      }

       Ns_UrlToFile(dsPtr, server, url)

	      The Ns_UrlToFile function writes the full path name of the file corresponding to the given  URL.	The  result  is  appended  to  the
	      Ns_DString. The function does not check that the file exists or is readable by the AOLserver process. This function returns a status
	      of NS_OK or NS_ERROR.

	      Normally this prepends the pageroot to the URL path. If you have created your own custom routine	and  used  Ns_SetUrlToFileProc	to
	      point  to  it, your routine is called instead. This could be used to create, for example, a module that takes the given URL and maps
	      it to a file in a different way than the default Ns_UrlToFile routine.

	      Example:

	      /* A simple page fetch request function. */
	      int
	      SimpleFetch(Ns_Conn *conn, void *ctx)
	      {
		  Ns_DString ds;
		  FILE fp;
		  char *server;
		  Ns_DStringInit(&ds);

		  server = Ns_ConnServer(conn);
		  Ns_UrlToFile(&ds, server, conn->request->url);
		  fp = fopen(ds.string, "r");
		  Ns_ConnSendOpenFp(conn, fp, -1);
		  fclose(fp);
		  Ns_DStringFree(&ds);
		  return NS_OK;
	      }

SEE ALSO

       nsd(1), info(n)

KEYWORDS

AOLserver								4.0						  Ns_UrlToFile(3aolserver)

Ns_ConnReturnStatus(3aolserver) 			   AOLserver Library Procedures 			   Ns_ConnReturnStatus(3aolserver)

__________________________________________________________________________________________________________________________________________________

NAME

       Ns_ConnReturnBadRequest, Ns_ConnReturnForbidden, Ns_ConnReturnInternalError, Ns_ConnReturnNoResponse, Ns_ConnReturnNotFound, Ns_ConnReturn-
       NotImplemented, Ns_ConnReturnNotModified, Ns_ConnReturnOk, Ns_ConnReturnStatus, Ns_ConnReturnUnauthorized, Ns_RegisterRedirect  -  Routines
       to return simple standard responses

SYNOPSIS

       #include "ns.h"

       int
       Ns_ConnReturnBadRequest(conn, msg)

       int
       Ns_ConnReturnForbidden(conn)

       int
       Ns_ConnReturnInternalError(conn)

       int
       Ns_ConnReturnNoResponse(conn)

       int
       Ns_ConnReturnNotFound(conn)

       int
       Ns_ConnReturnNotImplemented(conn)

       int
       Ns_ConnReturnNotModified(conn)

       int
       Ns_ConnReturnOk(conn)

       int
       Ns_ConnReturnStatus(conn, status)

       int
       Ns_ConnReturnUnauthorized(conn)

       void
       Ns_RegisterRedirect(server, status, url)

ARGUMENTS

       Ns_Conn	 conn	(in)	  Pointer to open connection.

       char	 *msg	(in)	  String with additional message text.

       int	 status (in)	  Integer HTTP status code.

       char	 *url	(in)	  String which specifies internal redirection url.

       char	 *server(in)	  Virtual server.
_________________________________________________________________

DESCRIPTION

       These  routines are used to generate complete responses, including headers, approriate status codes, content types, and possibly short HTML
       content messages for the most common HTTP error or status responses.  They each coorespond to a particular HTTP status code,  for  example,
       Ns_ConnReturnNotFound  generates an HTTP 404 "Not Found" response.  They all return NS_OK if the response was sent or NS_ERROR if an under-
       lying routine failed.

       The default behavior is to return an internal, server generated response possibly with a short English language message, for  example  "The
       requested  URL  cannot be accessed by this server".  This behavior can be modified by calling the Ns_RegisterRedirect to redirect responses
       internally for the cooresponding HTTP status code to another URL on the server.	The "redirects" server config section can be used  to  map
       these redirects at startup

       int Ns_ConnReturnBadRequest(conn, msg)
	      Returns  an  HTTP 400 response with the short HTML message "Invalid Request: The HTTP request presented by your browser is invalid."
	      The optional msg string, if present, is also included in the message body.

       int Ns_ConnReturnForbidden(conn)
	      Returns an HTTP 403 response with the short HTML message "Forbidden: The requested URL cannot be accessed by this server."

       int Ns_ConnReturnInternalError(conn)
	      Returns an HTTP 500 response with the short HTML message "Server Error: The requested URL cannot be accessed due to a  system  error
	      on this server."

       int Ns_ConnReturnNoResponse(conn)
	      Equivalent to Ns_ConnReturnStatus(conn, 204).

       int Ns_ConnReturnNotFound(conn)
	      Returns an HTTP 404 response with the short HTML message "Not Found: The requested URL was not found on this server."

       int Ns_ConnReturnNotImplemented(conn)
	      Returns  an  HTTP  404 response with the short HTML message "Not Implemented: The requested URL or method is not implemented by this
	      server."

       int Ns_ConnReturnNotModified(conn)
	      Equivalent to Ns_ConnReturnStatus(conn, 304).

       int Ns_ConnReturnOk(conn)
	      Equivalent to Ns_ConnReturnStatus(conn, 200).

       int Ns_ConnReturnStatus(conn, status)
	      Generates a response with the given HTTP status with no content.

       int Ns_ConnReturnUnauthorized(conn)
	      Returns an HTTP 401 response with the short HTML message "Access Denied: The requested URL cannot be accessed because a valid  user-
	      name and password are required."	As "WWW-Authenticate: Basic realm=server realm" header is also included in the response.

       void Ns_RegisterRedirect(server, status, url)
	      Redirect	the  above  responses from the given server for the given status code from the simple internal messages described above to
	      the given internal url. The redirect is performed using Ns_ConnRedirect.

SEE ALSO

       Ns_ConnFlush(3), Ns_ConnRedirect(3), Ns_ConnSetRequiredHeaders(3), Ns_ConnQueueHeaders(3), ns_return(n)

KEYWORDS

       connnection, response

AOLserver								4.0					   Ns_ConnReturnStatus(3aolserver)