Annotation of libwww/Library/src/HTAccess.html, revision 2.20
2.9 timbl 1: <HTML>
2: <HEAD>
2.6 timbl 3: <TITLE>HTAccess: Access manager for libwww</TITLE>
2.19 timbl 4: <NEXTID N="z11">
2.9 timbl 5: </HEAD>
2.5 timbl 6: <BODY>
7: <H1>Access Manager</H1>This module keeps a list of valid
8: protocol (naming scheme) specifiers
9: with associated access code. It
10: allows documents to be loaded given
11: various combinations of parameters.
12: New access protocols may be registered
13: at any time.<P>
2.9 timbl 14: Note: HTRequest defined and request
15: parametsr added to almost all calls
16: 18 Nov 1993.<P>
2.5 timbl 17: Part of the <A
2.19 timbl 18: NAME="z0" HREF="Overview.html">libwww library</A> . Implemented
19: by <A
20: NAME="z8" HREF="HTAccess.c">HTAcces.c</A>
2.5 timbl 21: <PRE>#ifndef HTACCESS_H
1.1 timbl 22: #define HTACCESS_H
23:
24: /* Definition uses:
25: */
26: #include "HTUtils.h"
2.16 luotonen 27: #include "HTList.h"
1.1 timbl 28: #include "tcp.h"
2.14 luotonen 29:
1.1 timbl 30:
31: #ifdef SHORT_NAMES
2.8 timbl 32: #define HTClientHost HTClHost
33: #define HTSearchAbsolute HTSeAbso
34: #define HTOutputStream HTOuStre
35: #define HTOutputFormat HTOuForm
1.1 timbl 36: #endif
37:
2.16 luotonen 38: typedef enum {
39: METHOD_INVALID = 0,
40: METHOD_GET = 1,
41: METHOD_HEAD,
42: METHOD_POST,
43: METHOD_PUT,
44: METHOD_DELETE,
45: METHOD_CHECKOUT,
46: METHOD_CHECKIN,
47: METHOD_SHOWMETHOD,
48: METHOD_LINK,
49: METHOD_UNLINK,
50: MAX_METHODS
51: } HTMethod;
52:
53:
54: </PRE>
55: <H2>Methods</H2>
56: <PRE>
57:
58: /* Get method enum value
59: ** ---------------------
60: */
61: PUBLIC HTMethod HTMethod_enum PARAMS((char * name));
62:
63:
64: /* Get method name
65: ** ---------------
66: */
67: PUBLIC char * HTMethod_name PARAMS((HTMethod method));
68:
69:
70: /* PUBLIC HTMethod_inList()
71: ** IS A METHOD IN A LIST OF METHOD NAMES
72: ** ON ENTRY:
73: ** method is the method to look for.
74: ** list is a list of method names.
75: **
76: ** ON EXIT:
77: ** returns YES, if method was found.
78: ** NO, if not found.
79: */
80: PUBLIC BOOL HTMethod_inList PARAMS((HTMethod method,
81: HTList * list));
82: </PRE>
83: <H2>Match Template Against Filename</H2>
84: <PRE>
85: /* PUBLIC HTAA_templateMatch()
86: ** STRING COMPARISON FUNCTION FOR FILE NAMES
87: ** WITH ONE WILDCARD * IN THE TEMPLATE
88: ** NOTE:
89: ** This is essentially the same code as in HTRules.c, but it
90: ** cannot be used because it is embedded in between other code.
91: ** (In fact, HTRules.c should use this routine, but then this
92: ** routine would have to be more sophisticated... why is life
93: ** sometimes so hard...)
94: **
95: ** ON ENTRY:
96: ** template is a template string to match the file name
97: ** agaist, may contain a single wildcard
98: ** character * which matches zero or more
99: ** arbitrary characters.
100: ** filename is the filename (or pathname) to be matched
101: ** agaist the template.
102: **
103: ** ON EXIT:
104: ** returns YES, if filename matches the template.
105: ** NO, otherwise.
106: */
107: PUBLIC BOOL HTAA_templateMatch PARAMS((CONST char * template,
108: CONST char * filename));
109:
110:
2.19 timbl 111: </PRE>The following have to be defined
2.10 timbl 112: in advance of the other include files
113: because of circular references.
114: <PRE>typedef struct _HTRequest HTRequest;
115:
2.14 luotonen 116: /*
117: ** Callback to call when username and password
118: ** have been prompted.
119: */
120: typedef int (*HTRetryCallbackType) PARAMS((HTRequest * req));
121:
122:
2.10 timbl 123: #include "HTAnchor.h"
124: #include <A
125: NAME="z3" HREF="HTFormat.html">"HTFormat.h"</A>
2.15 luotonen 126: #include "HTAAUtil.h" /* HTAAScheme, HTAAFailReason */
2.14 luotonen 127: #include "HTAABrow.h" /* HTAASetup */
2.10 timbl 128:
129:
1.1 timbl 130: /* Return codes from load routines:
131: **
132: ** These codes may be returned by the protocol modules,
133: ** and by the HTLoad routines.
134: ** In general, positive codes are OK and negative ones are bad.
135: */
136:
137: #define HT_NO_DATA -9999 /* return code: OK but no data was loaded */
138: /* Typically, other app started or forked */
139:
2.5 timbl 140: </PRE>
2.6 timbl 141: <H2>Default Addresses</H2>These control the home page selection.
2.8 timbl 142: To mess with these for normal browses
2.6 timbl 143: is asking for user confusion.
144: <PRE>#define LOGICAL_DEFAULT "WWW_HOME" /* Defined to be the home page */
1.1 timbl 145:
2.6 timbl 146: #ifndef PERSONAL_DEFAULT
147: #define PERSONAL_DEFAULT "WWW/default.html" /* in home directory */
148: #endif
149: #ifndef LOCAL_DEFAULT_FILE
1.1 timbl 150: #define LOCAL_DEFAULT_FILE "/usr/local/lib/WWW/default.html"
2.6 timbl 151: #endif
2.7 timbl 152: /* If one telnets to a www access point,
153: it will look in this file for home page */
154: #ifndef REMOTE_POINTER
155: #define REMOTE_POINTER "/etc/www-remote.url" /* can't be file */
156: #endif
157: /* and if that fails it will use this. */
2.6 timbl 158: #ifndef REMOTE_ADDRESS
1.1 timbl 159: #define REMOTE_ADDRESS "http://info.cern.ch/remote.html" /* can't be file */
160: #endif
161:
162: /* If run from telnet daemon and no -l specified, use this file:
163: */
164: #ifndef DEFAULT_LOGFILE
165: #define DEFAULT_LOGFILE "/usr/adm/www-log/www-log"
166: #endif
167:
168: /* If the home page isn't found, use this file:
169: */
170: #ifndef LAST_RESORT
2.6 timbl 171: #define LAST_RESORT "http://info.cern.ch/default.html"
1.1 timbl 172: #endif
173:
2.10 timbl 174:
2.9 timbl 175: </PRE>
176: <H2><A
177: NAME="z1">The Request structure</A></H2>When a request is handled, all kinds
178: of things about it need to be passed
179: along. These are all put into a
2.11 timbl 180: HTRequest structure. Note there
181: is also a <A
2.12 timbl 182: NAME="z4" HREF="HTFormat.html#z17">global list of converters</A>
183: .
2.10 timbl 184: <PRE>struct _HTRequest {
2.19 timbl 185:
186:
187: </PRE>The elements of the request structure
188: are as follows.
189: <H3>Set by the caller of HTaccess:</H3>
190: <H4>Conditions of the request itself:</H4>
191: <PRE> HTMethod method;
192:
193: </PRE>An atom for the name of the operation
194: using HTTP <A
195: NAME="z7" HREF="../../Protocols/HTTP/Methods.html">method names</A> .
196: <PRE> HTList * conversions ;
2.20 ! frystyk 197: </PRE>NULL, or a list of conversions which
2.19 timbl 198: the format manager can do in order
199: to fulfill the request. This is
200: set by the caller of HTAccess. Typically
201: points to a list set up an initialisation
202: time for example by HTInit.
203: <PRE> HTList * encodings; /* allowed content-encodings */
204:
205: </PRE>The list of encodings acceptablein
206: the output stream.
207: <PRE> HTList * languages; /* accepted content-languages */
208:
209: </PRE>The list of (human) language values
210: acceptable in the response
211: <PRE> BOOL (*<A
2.20 ! frystyk 212: NAME="z9"> callback</A> ) PARAMS((
2.9 timbl 213: struct _HTRequest* request,
214: void *param));
2.19 timbl 215:
216: </PRE>A function to be called back in the
217: event that a file has been saved
218: to disk by HTSaveAndCallBack for
219: example.
220: <PRE> void * context; /* caller data -- HTAccess unaware */
221:
222: </PRE>An arbitrary pointer passed to HTAccess
223: and passed back as a parameter to
224: the <A
2.20 ! frystyk 225: NAME="z10" HREF="#z9">callback</A> .
2.19 timbl 226: <PRE> HTStream* output_stream;
227:
228: </PRE>NULL in the case of display to the
229: user, or if a specific output stream
230: is required, the stream.
231: <PRE> HTAtom * output_format;
232:
233: </PRE>The output format required, or a
234: generic format such as www/present
235: (present to user).
236: <H4>Information about the requester</H4>
237: <PRE> char * from;
238:
239: </PRE>Email format address of person responible
240: for request
241: <PRE> char * user_agent;
242:
243: </PRE>The name of the client software package
244: in use.
245: <H3>Set by HTAccess</H3>None of the bits below may be looked
246: at by a client application except
247: in the callback routine, when the
248: anchor may be picked out.
249: <PRE> HTParentAnchor* anchor;
250:
251: </PRE>The anchor for the object in question.
2.20 ! frystyk 252: Set immediately by HTAcesss. Used
2.19 timbl 253: by the protocol and parsing modules.
254: Valid thoughout the access.
255: <PRE> HTChildAnchor * childAnchor; /* For element within the object */
256:
257: </PRE><A
2.20 ! frystyk 258: NAME="z6">T</A> he anchor for the sub object if
2.19 timbl 259: any. The object builder should ensure
260: that htis is selected, highlighted,
261: etc when the object is loaded. NOTE:
262: Set by HTAccess.
263: <PRE> void * using_cache;
264:
265: </PRE>pointer to cache element if cache
266: hit
267: <PRE> int status_code;
268:
269: </PRE>HTTP-style status code in case of
270: error. Initialised by AA code to
271: 200, overwritten with something else
272: if error.
273: <PRE> char * reason_line;
274:
275: </PRE>Reason for failing if any. Human
276: readable.
277: <H3>Server side</H3>
278: <PRE> int soc; /* Socket from which request came */
2.15 luotonen 279: HTInputSocket * isoc; /* InputSocket object for reading */
2.14 luotonen 280: char * request; /* First request line as received */
281: char * argument; /* Arg to HTTP method as given */
282: char * arg_path; /* Pathinfo part of argument */
2.16 luotonen 283: char * arg_keywords; /* Keyword part of URL */
2.19 timbl 284: char * translated;
285:
286: </PRE>Translated filename (set by function
287: HTTranslateReq(). NULL, if this is
288: a script execution request
289: <PRE> char * script;
290:
291: </PRE>Executable script name (set by HTTranslateReq().
292: NULL if not a script request.
293: <PRE> char * script_pathinfo;/* Path info after script name */
2.15 luotonen 294: char * script_pathtrans;/* Path info translated */
2.18 luotonen 295: HTAtom * content_language;/* Language */
296: HTAtom * content_encoding;/* Encoding */
2.14 luotonen 297: char * location; /* Location for redirection */
2.16 luotonen 298: HTAtom * content_type; /* Content-Type: */
299: int content_length; /* Content-Length: */
300: char * last_modified; /* Last-Modified: */
301: char * expires; /* Expires: */
302: char * uri; /* Uri: */
303: char * message_id; /* Message-Id: */
304: HTList * allowed; /* Allowed: (list of HTAtoms) */
305: HTList * public; /* Public: (list of HTAtoms) */
2.17 luotonen 306: char * meta_file; /* File for meta information */
2.14 luotonen 307: char * authorization; /* Authorization: field */
308: HTAAScheme scheme; /* Authentication scheme used */
309: char * auth_string; /* Authentication string */
2.15 luotonen 310: char * www_authenticate;/*WWW-Authenticate: (should be a */
311: /* a HTList *) */
2.14 luotonen 312: HTAAFailReason reason; /* Reason for failing */
2.16 luotonen 313:
2.19 timbl 314:
315: </PRE>
316: <H3>Client side AA</H3>
317: <PRE>
2.14 luotonen 318: HTList * valid_schemes; /* Valid auth.schemes */
319: HTAssocList ** scheme_specifics;/* Scheme-specific parameters */
320: char * prot_template; /* WWW-Protection-Template: field */
321: HTAASetup * setup; /* Doc protection info */
322: HTAARealm * realm; /* Password realm */
323: char * dialog_msg; /* Authentication prompt (client) */
324: HTRetryCallbackType
325: retry_callback; /* Called when password entered */
2.10 timbl 326: };
2.9 timbl 327:
2.19 timbl 328: </PRE>Just to make things easier especially
2.9 timbl 329: for clients, here is a function to
330: return a new blank request:
331: <H2>Create blank request</H2>This request has defaults in -- in
332: most cases it will need some information
333: added before being passed to HTAccess,
334: but it will work as is for a simple
335: request.
2.14 luotonen 336: <PRE>
337: PUBLIC HTRequest * HTRequest_new NOPARAMS;
338:
339:
340: </PRE>
2.19 timbl 341: <H2>Delete request structure</H2>Frees also conversion list hanging
342: from req->conversions.
2.14 luotonen 343: <PRE>
344: PUBLIC void HTRequest_delete PARAMS((HTRequest * req));
1.1 timbl 345:
2.9 timbl 346:
2.5 timbl 347: </PRE>
348: <H2>Flags which may be set to control
349: this module</H2>
350: <PRE>extern int HTDiag; /* Flag: load source as plain text */
1.1 timbl 351: extern char * HTClientHost; /* Name or number of telnetting host */
352: extern FILE * logfile; /* File to output one-liners to */
2.7 timbl 353: extern BOOL HTSecure; /* Disable security holes? */
1.1 timbl 354:
355:
356:
2.5 timbl 357: </PRE>
358: <H2>Load a document from relative name</H2>
359: <H3>On Entry,</H3>
360: <DL>
361: <DT>relative_name
2.6 timbl 362: <DD> The relative address
2.5 timbl 363: of the file to be accessed.
364: <DT>here
2.6 timbl 365: <DD> The anchor of the object being
2.5 timbl 366: searched
2.9 timbl 367: <DT>request->anchor
368: <DD> not filled in yet
2.5 timbl 369: </DL>
370:
371: <H3>On Exit,</H3>
372: <DL>
373: <DT>returns YES
2.6 timbl 374: <DD> Success in opening
2.5 timbl 375: file
376: <DT>NO
2.6 timbl 377: <DD> Failure
2.5 timbl 378: </DL>
1.1 timbl 379:
2.5 timbl 380: <PRE>extern BOOL HTLoadRelative PARAMS((
1.1 timbl 381: CONST char * relative_name,
2.9 timbl 382: HTParentAnchor * here,
383: HTRequest * request));
1.1 timbl 384:
385:
2.5 timbl 386: </PRE>
387: <H2>Load a document from absolute name</H2>
388: <H3>On Entry,</H3>
389: <DL>
390: <DT>addr
2.6 timbl 391: <DD> The absolute address of the
392: document to be accessed.
2.5 timbl 393: <DT>filter
2.6 timbl 394: <DD> if YES, treat document as
395: HTML
2.9 timbl 396: <DT>request->anchor
397: <DD> not filled in yet
2.5 timbl 398: </DL>
1.1 timbl 399:
2.5 timbl 400: <PRE>
401: </PRE>
402: <H3>On Exit,</H3>
403: <PRE>
404: </PRE>
405: <DL>
406: <DT>returns YES
2.6 timbl 407: <DD> Success in opening document
2.5 timbl 408: <DT>NO
2.6 timbl 409: <DD> Failure
2.5 timbl 410: </DL>
1.1 timbl 411:
2.9 timbl 412: <PRE>extern BOOL HTLoadAbsolute PARAMS((CONST char * addr,
413: HTRequest * request));
1.1 timbl 414:
415:
2.5 timbl 416: </PRE>
417: <H2>Load a document from absolute name
418: to a stream</H2>
419: <H3>On Entry,</H3>
420: <DL>
421: <DT>addr
2.6 timbl 422: <DD> The absolute address of the
423: document to be accessed.
2.5 timbl 424: <DT>filter
2.6 timbl 425: <DD> if YES, treat document as
426: HTML
2.9 timbl 427: <DT>request->anchor
428: <DD> not filled in yet
2.5 timbl 429: </DL>
430:
431: <H3>On Exit,</H3>
432: <DL>
433: <DT>returns YES
2.6 timbl 434: <DD> Success in opening document
2.5 timbl 435: <DT>NO
2.6 timbl 436: <DD> Failure
2.5 timbl 437: </DL>
438: Note: This is equivalent to HTLoadDocument
2.9 timbl 439: <PRE>extern BOOL HTLoadToStream PARAMS((
440: CONST char * addr,
441: BOOL filter,
442: HTRequest * request));
1.1 timbl 443:
444:
2.5 timbl 445: </PRE>
446: <H2>Load if necessary, and select an
2.9 timbl 447: anchor</H2>The anchor parameter may be a child
448: anchor. The anchor in the request
449: is set to the parent anchor.
2.5 timbl 450: <H3>On Entry,</H3>
451: <DL>
2.9 timbl 452: <DT>anchor
453: <DD> may be a child or parenet
454: anchor or 0 in which case there is
455: no effect.
456: <DT>request->anchor
457: <DD> Not set
458: yet.
2.5 timbl 459: </DL>
460:
461: <H3>On Exit,</H3>
462: <PRE>
463: </PRE>
464: <DL>
465: <DT>returns YES
2.6 timbl 466: <DD> Success
2.5 timbl 467: <DT>returns NO
2.6 timbl 468: <DD> Failure
2.9 timbl 469: <DT>request->anchor
470: <DD> The parenet anchor.
2.5 timbl 471: </DL>
472:
2.9 timbl 473: <PRE>extern BOOL HTLoadAnchor PARAMS((HTAnchor * a,
474: HTRequest * request));
1.1 timbl 475:
476:
2.5 timbl 477: </PRE>
2.20 ! frystyk 478: <H2>Bind an anchor to a request structure
! 479: without loading</H2>The anchor parameter may be a child
! 480: anchor. The anchor in the request
! 481: is set to the parent anchor. This
! 482: is useful in non-interactive mode
! 483: if no home-anchor is known. Actually
! 484: the same as HTLoadAnchor(), but without
! 485: loading
! 486: <H3>On Entry,</H3>
! 487: <DL>
! 488: <DT>anchor
! 489: <DD> may be a child or parenet
! 490: anchor or 0 in which case there is
! 491: no effect.
! 492: <DT>request->anchor
! 493: <DD> Not set yet.
! 494: </DL>
! 495:
! 496: <H3>On Exit,</H3>
! 497: <PRE>
! 498: </PRE>returns YES Success<P>
! 499: returns NO Failure <P>
! 500: request->anchor The parenet anchor.
! 501: <PRE>
! 502: extern BOOL HTBindAnchor PARAMS((HTAnchor *anchor, HTRequest *request));
! 503:
! 504:
! 505: </PRE>
2.5 timbl 506: <H2>Make a stream for Saving object back</H2>
507: <H3>On Entry,</H3>
508: <DL>
2.9 timbl 509: <DT>request->anchor
510: <DD> is valid anchor which
511: has previously beeing loaded
2.5 timbl 512: </DL>
513:
514: <H3>On exit,</H3>
515: <DL>
516: <DT>returns
2.6 timbl 517: <DD> 0 if error else a stream
518: to save the object to.
2.5 timbl 519: </DL>
520:
521: <PRE>
522:
2.13 timbl 523: extern HTStream * HTSaveStream PARAMS((HTRequest * request));
1.1 timbl 524:
525:
2.5 timbl 526: </PRE>
527: <H2>Search</H2>Performs a search on word given by
528: the user. Adds the search words to
529: the end of the current address and
530: attempts to open the new address.
531: <H3>On Entry,</H3>
532: <DL>
533: <DT>*keywords
2.6 timbl 534: <DD> space-separated keyword
2.5 timbl 535: list or similar search list
536: <DT>here
2.6 timbl 537: <DD> The anchor of the object being
2.5 timbl 538: searched
539: </DL>
1.1 timbl 540:
2.9 timbl 541: <PRE>extern BOOL HTSearch PARAMS((
542: CONST char * keywords,
543: HTParentAnchor* here,
544: HTRequest * request));
1.1 timbl 545:
546:
2.5 timbl 547: </PRE>
548: <H2>Search Given Indexname</H2>Performs a keyword search on word
549: given by the user. Adds the keyword
550: to the end of the current address
551: and attempts to open the new address.
552: <H3>On Entry,</H3>
553: <DL>
554: <DT>*keywords
2.6 timbl 555: <DD> space-separated keyword
2.5 timbl 556: list or similar search list
557: <DT>*indexname
2.6 timbl 558: <DD> is name of object search
2.5 timbl 559: is to be done on.
560: </DL>
1.1 timbl 561:
2.5 timbl 562: <PRE>extern BOOL HTSearchAbsolute PARAMS((
2.9 timbl 563: CONST char * keywords,
564: CONST char * indexname,
565: HTRequest * request));
1.1 timbl 566:
567:
2.5 timbl 568: </PRE>
2.9 timbl 569: <H2>Register an access method</H2>An access method is defined by an
570: HTProtocol structure which point
571: to the routines for performing the
572: various logical operations on an
573: object: in HTTP terms, GET, PUT,
574: and POST.<P>
575: Each of these routine takes as a
576: parameter a <A
577: NAME="z2" HREF="#z1">request structure</A> containing
578: details ofthe request. When the
579: protocol class routine is called,
580: the anchor elemnt in the request
581: is already valid (made valid by HTAccess).
582: <PRE>typedef struct _HTProtocol {
1.1 timbl 583: char * name;
584:
2.11 timbl 585: int (*load)PARAMS((HTRequest * request));
1.1 timbl 586:
2.11 timbl 587: HTStream* (*saveStream)PARAMS((HTRequest * request));
588:
2.9 timbl 589: HTStream* (*postStream)PARAMS((
590: HTRequest * request,
591: HTParentAnchor* postTo));
1.1 timbl 592:
593: } HTProtocol;
594:
595: extern BOOL HTRegisterProtocol PARAMS((HTProtocol * protocol));
596:
597:
2.5 timbl 598: </PRE>
599: <H2>Generate the anchor for the home
600: page</H2>
601: <PRE>
602: </PRE>As it involves file access, this
603: should only be done once when the
604: program first runs. This is a default
605: algorithm -- browser don't HAVE to
606: use this.
607: <PRE>extern HTParentAnchor * HTHomeAnchor NOPARAMS;
1.1 timbl 608:
609: #endif /* HTACCESS_H */
2.11 timbl 610:
2.20 ! frystyk 611: </PRE>end of HTAccess</BODY>
2.9 timbl 612: </HTML>
Webmaster
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to HTAccess.html CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / libwww / Library / src