/*
* $LynxId: HTFile.h,v 1.33 2012/02/10 00:59:15 tom Exp $
* File access in libwww
* FILE ACCESS
*
* These are routines for local file access used by WWW browsers and servers.
* Implemented by HTFile.c.
*
* If the file is not a local file, then we pass it on to HTFTP in case it
* can be reached by FTP.
*/
#ifndef HTFILE_H
#define HTFILE_H
#include <HTFormat.h>
#include <HTAccess.h>
#ifndef HTML_H
#include <HTML.h> /* SCW */
#endif /* HTML_H */
#ifdef __cplusplus
extern "C" {
#endif
/*
* Controlling globals
*
* These flags control how directories and files are represented as
* hypertext, and are typically set by the application from command
* line options, etc.
*/ extern int HTDirAccess;
/* Directory access level */
#define HT_DIR_FORBID 0 /* Altogether forbidden */
#define HT_DIR_SELECTIVE 1 /* If HT_DIR_ENABLE_FILE exists */
#define HT_DIR_OK 2 /* Any accesible directory */
#define HT_DIR_ENABLE_FILE ".www_browsable" /* If exists, can browse */
extern int HTDirReadme; /* Include readme files in listing? */
/* Values: */
#define HT_DIR_README_NONE 0 /* No */
#define HT_DIR_README_TOP 1 /* Yes, first */
#define HT_DIR_README_BOTTOM 2 /* Yes, at the end */
#define HT_DIR_README_FILE "README"
/*
* Convert filenames between local and WWW formats
*/
extern char *HTURLPath_toFile(const char *name, int expand_all, int is_remote);
extern char *HTnameOfFile_WWW(const char *name, int WWW_prefix, int expand_all);
#define HTLocalName(name) HTnameOfFile_WWW(name,TRUE,TRUE)
#define HTfullURL_toFile(name) HTnameOfFile_WWW(name,FALSE,TRUE)
#define HTpartURL_toFile(name) HTnameOfFile_WWW(name,FALSE,FALSE)
/*
* Make a WWW name from a full local path name
*/
extern char *WWW_nameOfFile(const char *name);
/*
* Generate the name of a cache file
*/
extern char *HTCacheFileName(const char *name);
/*
* Generate fragments of HTML for source-view:
*/
extern void HTStructured_doctype(HTStructured * target, HTFormat format_out);
extern void HTStructured_meta(HTStructured * target, HTFormat format_out);
/*
* Output directory titles
*
* This is (like the next one) used by HTFTP. It is common code to generate
* the title and heading 1 and the parent directory link for any anchor.
*
* changed to return TRUE if parent directory link was generated,
* FALSE otherwise - KW
*/
extern BOOL HTDirTitles(HTStructured * target, HTParentAnchor *anchor,
HTFormat format_out,
int tildeIsTop);
/*
* Check existence.
*/
extern int HTStat(const char *filename,
struct stat *data);
/* Load a document.
* ----------------
*/
extern int HTLoadFile(const char *addr,
HTParentAnchor *anchor,
HTFormat format_out,
HTStream *sink);
/*
* Output a directory entry
*
* This is used by HTFTP.c for example -- it is a common routine for
* generating a linked directory entry.
*/
extern void HTDirEntry(HTStructured * target, /* in which to put the linked text */ const char *tail, /* last part of directory name */
const char *entry); /* name of this entry */
/*
* HTSetSuffix: Define the representation for a file suffix
*
* This defines a mapping between local file suffixes and file content
* types and encodings.
*
* ON ENTRY,
*
* suffix includes the "." if that is important (normally, yes!)
*
* representation is MIME-style content-type
*
* encoding is MIME-style content-transfer-encoding
* (8bit, 7bit, etc) or HTTP-style content-encoding
* (gzip, compress etc.)
*
* quality an a priori judgement of the quality of such files
* (0.0..1.0)
*
* HTSetSuffix5 has one more parameter for a short description of the type
* which is otherwise derived from the representation:
*
* desc is a short textual description, or NULL
*
* Examples: HTSetSuffix(".ps", "application/postscript", "8bit", 1.0);
* Examples: HTSetSuffix(".psz", "application/postscript", "gzip", 1.0);
* A MIME type could also indicate a non-trivial encoding on its own
* ("application/x-compressed-tar"), but in that case don't use enconding
* to also indicate it but use "binary" etc.
*/
extern void HTSetSuffix5(const char *suffix,
const char *representation,
const char *encoding,
const char *desc,
double quality);
#define HTSetSuffix(suff,rep,enc,q) HTSetSuffix5(suff, rep, enc, NULL, q)
/*
* HTFileFormat: Get Representation and Encoding from file name.
*
* ON EXIT,
*
* return The represntation it imagines the file is in.
*
* *pEncoding The encoding (binary, 7bit, etc). See HTSetSuffix.
*/
extern HTFormat HTFileFormat(const char *filename,
HTAtom **pEncoding,
const char **pDesc);
/*
* HTCharsetFormat: Revise the file format in relation to the Lynx charset.
*
* This checks the format associated with an anchor for
* for an extended MIME Content-Type, and if a charset is
* indicated, sets Lynx up for proper handling in relation
* to the currently selected character set. - FM
*/
extern HTFormat HTCharsetFormat(HTFormat format,
HTParentAnchor *anchor,
int default_LYhndl);
/* Get various pieces of meta info from file name.
* -----------------------------------------------
*
* LYGetFileInfo fills in information that can be determined without
* an actual (new) access to the filesystem, based on current suffix
* and character set configuration. If the file has been loaded and
* parsed before (with the same URL generated here!) and the anchor
* is still around, some results may be influenced by that (in
* particular, charset info from a META tag - this is not actually
* tested!).
* The caller should not keep pointers to the returned objects around
* for too long, the valid lifetimes vary. In particular, the returned
* charset string should be copied if necessary. If return of the
* file_anchor is requested, that one can be used to retrieve
* additional bits of info that are stored in the anchor object and
* are not covered here; as usual, don't keep pointers to the
* file_anchor longer than necessary since the object may disappear
* through HTuncache_current_document or at the next document load.
* - kw
*/
extern void LYGetFileInfo(const char *filename,
HTParentAnchor **pfile_anchor,
HTFormat *pformat,
HTAtom **pencoding,
const char **pdesc,
const char **pcharset,
int *pfile_cs);
/*
* Determine file value from file name.
*/
extern float HTFileValue(const char *filename);
/*
* Known compression types.
*/
typedef enum {
cftNone
,cftCompress
,cftGzip
,cftBzip2
,cftDeflate
} CompressFileType;
/*
* Determine compression type from file name, by looking at its suffix.
*/
extern CompressFileType HTCompressFileType(const char *filename,
const char *dots,
int *rootlen);
/*
* Determine compression type from the content-encoding.
*/
extern CompressFileType HTEncodingToCompressType(const char *encoding);
/*
* Determine compression type from the content-encoding.
*/
extern CompressFileType HTContentTypeToCompressType(const char *ct);
/*
* Determine compression type from the content-type and/or content-encoding.
*/
extern CompressFileType HTContentToCompressType(HTParentAnchor *anchor);
/*
* Determine compression encoding from the compression method.
*/
extern const char *HTCompressTypeToEncoding(CompressFileType method);
/*
* Determine expected file-suffix from the compression method.
*/
extern const char *HTCompressTypeToSuffix(CompressFileType method);
/*
* Determine write access to a file.
*
* ON EXIT,
*
* return value YES if file can be accessed and can be written to.
*
* BUGS
*
* Isn't there a quicker way?
*/
#if defined(HAVE_CONFIG_H)
#ifndef HAVE_GETGROUPS
#define NO_GROUPS
#endif
#else
#ifdef VMS
#define NO_GROUPS
#endif /* VMS */
#ifdef NO_UNIX_IO
#define NO_GROUPS
#endif /* NO_UNIX_IO */
#ifdef PCNFS
#define NO_GROUPS
#endif /* PCNFS */
#ifdef NOUSERS
#define NO_GROUPS
#endif /* PCNFS */
#endif /* HAVE_CONFIG_H */
extern BOOL HTEditable(const char *filename);
/* Make a save stream.
* -------------------
*/
extern HTStream *HTFileSaveStream(HTParentAnchor *anchor);
/*
* Determine a suitable suffix, given the representation.
*
* ON ENTRY,
*
* rep is the atomized MIME style representation
* enc is an encoding (8bit, binary, gzip, compress,..)
*
* ON EXIT,
*
* returns a pointer to a suitable suffix string if one has
* been found, else NULL.
*/
extern const char *HTFileSuffix(HTAtom *rep,
const char *enc);
/*
* Enumerate external programs that lynx may assume exists. Unlike those
* given in download scripts, etc., lynx would really like to know their
* absolute paths, for better security.
*/
typedef enum {
ppUnknown = 0
,ppBZIP2
,ppCHMOD
,ppCOMPRESS
,ppCOPY
,ppCSWING
,ppGZIP
,ppINFLATE
,ppINSTALL
,ppMKDIR
,ppMV
,ppRLOGIN
,ppRM
,ppRMDIR
,ppSETFONT
,ppTAR
,ppTELNET
,ppTN3270
,ppTOUCH
,ppUNCOMPRESS
,ppUNZIP
,ppUUDECODE
,ppZCAT
,ppZIP
,pp_Last
} ProgramPaths;
/*
* Given a program number, return its path
*/
extern const char *HTGetProgramPath(ProgramPaths code);
/*
* Store a program's path
*/
extern void HTSetProgramPath(ProgramPaths code,
const char *path);
/*
* Reset the list of known program paths to the ones that are compiled-in
*/
extern void HTInitProgramPaths(BOOL init);
/*
* The Protocols
*/
#ifdef GLOBALREF_IS_MACRO
extern GLOBALREF (HTProtocol, HTFTP);
extern GLOBALREF (HTProtocol, HTFile);
#else
GLOBALREF HTProtocol HTFTP, HTFile;
#endif /* GLOBALREF_IS_MACRO */
#ifdef __cplusplus
}
#endif
#endif /* HTFILE_H */