Annotation of libwww/Library/src/HTAccess.html, revision 2.25
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.23 frystyk 174: /* This is the default cache directory:
175: */
176: #ifndef CACHE_HOME_DIR
177: #define CACHE_HOME_DIR "/tmp/"
178: #endif
179:
180: /* The default directory for "save locally" and "save and execute" files:
181: */
182: #ifndef SAVE_LOCALLY_HOME_DIR
183: #define SAVE_LOCALLY_HOME_DIR "/tmp/"
184: #endif
2.10 timbl 185:
2.9 timbl 186: </PRE>
187: <H2><A
188: NAME="z1">The Request structure</A></H2>When a request is handled, all kinds
189: of things about it need to be passed
190: along. These are all put into a
2.11 timbl 191: HTRequest structure. Note there
192: is also a <A
2.12 timbl 193: NAME="z4" HREF="HTFormat.html#z17">global list of converters</A>
194: .
2.10 timbl 195: <PRE>struct _HTRequest {
2.19 timbl 196:
197: </PRE>The elements of the request structure
198: are as follows.
199: <H3>Set by the caller of HTaccess:</H3>
200: <H4>Conditions of the request itself:</H4>
201: <PRE> HTMethod method;
202:
203: </PRE>An atom for the name of the operation
204: using HTTP <A
205: NAME="z7" HREF="../../Protocols/HTTP/Methods.html">method names</A> .
206: <PRE> HTList * conversions ;
2.20 frystyk 207: </PRE>NULL, or a list of conversions which
2.19 timbl 208: the format manager can do in order
209: to fulfill the request. This is
210: set by the caller of HTAccess. Typically
211: points to a list set up an initialisation
212: time for example by HTInit.
213: <PRE> HTList * encodings; /* allowed content-encodings */
214:
215: </PRE>The list of encodings acceptablein
216: the output stream.
217: <PRE> HTList * languages; /* accepted content-languages */
218:
219: </PRE>The list of (human) language values
220: acceptable in the response
221: <PRE> BOOL (*<A
2.20 frystyk 222: NAME="z9"> callback</A> ) PARAMS((
2.9 timbl 223: struct _HTRequest* request,
224: void *param));
2.19 timbl 225:
226: </PRE>A function to be called back in the
227: event that a file has been saved
228: to disk by HTSaveAndCallBack for
229: example.
230: <PRE> void * context; /* caller data -- HTAccess unaware */
231:
232: </PRE>An arbitrary pointer passed to HTAccess
233: and passed back as a parameter to
234: the <A
2.20 frystyk 235: NAME="z10" HREF="#z9">callback</A> .
2.19 timbl 236: <PRE> HTStream* output_stream;
237:
238: </PRE>NULL in the case of display to the
239: user, or if a specific output stream
240: is required, the stream.
241: <PRE> HTAtom * output_format;
242:
243: </PRE>The output format required, or a
244: generic format such as www/present
245: (present to user).
246: <H4>Information about the requester</H4>
247: <PRE> char * from;
248:
249: </PRE>Email format address of person responible
250: for request
251: <H3>Set by HTAccess</H3>None of the bits below may be looked
252: at by a client application except
253: in the callback routine, when the
254: anchor may be picked out.
255: <PRE> HTParentAnchor* anchor;
256:
257: </PRE>The anchor for the object in question.
2.20 frystyk 258: Set immediately by HTAcesss. Used
2.19 timbl 259: by the protocol and parsing modules.
260: Valid thoughout the access.
261: <PRE> HTChildAnchor * childAnchor; /* For element within the object */
262:
263: </PRE><A
2.20 frystyk 264: NAME="z6">T</A> he anchor for the sub object if
2.19 timbl 265: any. The object builder should ensure
266: that htis is selected, highlighted,
267: etc when the object is loaded. NOTE:
268: Set by HTAccess.
269: <PRE> void * using_cache;
270:
271: </PRE>pointer to cache element if cache
272: hit
2.25 ! luotonen 273: <H3>Error Diagnostics</H3>
! 274: <PRE>
! 275:
! 276: HTList * error_stack; /* List of error messages */
! 277:
! 278: </PRE>
2.21 luotonen 279: <H3>Server Side</H3>
280: <PRE>
281: HTAtom * content_type; /* Content-Type: */
2.18 luotonen 282: HTAtom * content_language;/* Language */
283: HTAtom * content_encoding;/* Encoding */
2.16 luotonen 284: int content_length; /* Content-Length: */
2.21 luotonen 285: HTInputSocket * isoc; /* InputSocket object for reading */
2.14 luotonen 286: char * authorization; /* Authorization: field */
287: HTAAScheme scheme; /* Authentication scheme used */
2.19 timbl 288: </PRE>
2.21 luotonen 289: <H3>Client Side</H3>
2.19 timbl 290: <PRE>
2.14 luotonen 291: HTList * valid_schemes; /* Valid auth.schemes */
292: HTAssocList ** scheme_specifics;/* Scheme-specific parameters */
293: char * prot_template; /* WWW-Protection-Template: field */
294: HTAASetup * setup; /* Doc protection info */
295: HTAARealm * realm; /* Password realm */
296: char * dialog_msg; /* Authentication prompt (client) */
297: HTRetryCallbackType
298: retry_callback; /* Called when password entered */
2.10 timbl 299: };
2.9 timbl 300:
2.19 timbl 301: </PRE>Just to make things easier especially
2.9 timbl 302: for clients, here is a function to
303: return a new blank request:
304: <H2>Create blank request</H2>This request has defaults in -- in
305: most cases it will need some information
306: added before being passed to HTAccess,
307: but it will work as is for a simple
308: request.
2.14 luotonen 309: <PRE>
310: PUBLIC HTRequest * HTRequest_new NOPARAMS;
311:
312:
313: </PRE>
2.19 timbl 314: <H2>Delete request structure</H2>Frees also conversion list hanging
315: from req->conversions.
2.14 luotonen 316: <PRE>
317: PUBLIC void HTRequest_delete PARAMS((HTRequest * req));
1.1 timbl 318:
2.9 timbl 319:
2.5 timbl 320: </PRE>
321: <H2>Flags which may be set to control
322: this module</H2>
2.22 frystyk 323: <PRE>
2.23 frystyk 324: extern char * HTSaveLocallyDir; /* Dir home for "save locally" files */
325: extern char * HTCacheDir; /* Cache dir, default NULL: no cache */
1.1 timbl 326: extern char * HTClientHost; /* Name or number of telnetting host */
327: extern FILE * logfile; /* File to output one-liners to */
2.7 timbl 328: extern BOOL HTSecure; /* Disable security holes? */
2.21 luotonen 329: extern BOOL HTImServer; /* If I'm cern_httpd */
330: extern BOOL HTImProxy; /* If I'm cern_httpd as a proxy */
2.23 frystyk 331: extern BOOL HTForceReload; /* Force reload from cache or net */
1.1 timbl 332:
2.5 timbl 333: </PRE>
334: <H2>Load a document from relative name</H2>
335: <H3>On Entry,</H3>
336: <DL>
337: <DT>relative_name
2.6 timbl 338: <DD> The relative address
2.5 timbl 339: of the file to be accessed.
340: <DT>here
2.6 timbl 341: <DD> The anchor of the object being
2.5 timbl 342: searched
2.9 timbl 343: <DT>request->anchor
344: <DD> not filled in yet
2.5 timbl 345: </DL>
346:
347: <H3>On Exit,</H3>
348: <DL>
349: <DT>returns YES
2.6 timbl 350: <DD> Success in opening
2.5 timbl 351: file
352: <DT>NO
2.6 timbl 353: <DD> Failure
2.5 timbl 354: </DL>
1.1 timbl 355:
2.5 timbl 356: <PRE>extern BOOL HTLoadRelative PARAMS((
1.1 timbl 357: CONST char * relative_name,
2.9 timbl 358: HTParentAnchor * here,
359: HTRequest * request));
1.1 timbl 360:
361:
2.5 timbl 362: </PRE>
363: <H2>Load a document from absolute name</H2>
364: <H3>On Entry,</H3>
365: <DL>
366: <DT>addr
2.6 timbl 367: <DD> The absolute address of the
368: document to be accessed.
2.5 timbl 369: <DT>filter
2.6 timbl 370: <DD> if YES, treat document as
371: HTML
2.9 timbl 372: <DT>request->anchor
373: <DD> not filled in yet
2.5 timbl 374: </DL>
1.1 timbl 375:
2.5 timbl 376: <PRE>
377: </PRE>
378: <H3>On Exit,</H3>
379: <PRE>
380: </PRE>
381: <DL>
382: <DT>returns YES
2.6 timbl 383: <DD> Success in opening document
2.5 timbl 384: <DT>NO
2.6 timbl 385: <DD> Failure
2.5 timbl 386: </DL>
1.1 timbl 387:
2.9 timbl 388: <PRE>extern BOOL HTLoadAbsolute PARAMS((CONST char * addr,
389: HTRequest * request));
1.1 timbl 390:
391:
2.5 timbl 392: </PRE>
393: <H2>Load a document from absolute name
394: to a stream</H2>
395: <H3>On Entry,</H3>
396: <DL>
397: <DT>addr
2.6 timbl 398: <DD> The absolute address of the
399: document to be accessed.
2.5 timbl 400: <DT>filter
2.6 timbl 401: <DD> if YES, treat document as
402: HTML
2.9 timbl 403: <DT>request->anchor
404: <DD> not filled in yet
2.5 timbl 405: </DL>
406:
407: <H3>On Exit,</H3>
408: <DL>
409: <DT>returns YES
2.6 timbl 410: <DD> Success in opening document
2.5 timbl 411: <DT>NO
2.6 timbl 412: <DD> Failure
2.5 timbl 413: </DL>
414: Note: This is equivalent to HTLoadDocument
2.9 timbl 415: <PRE>extern BOOL HTLoadToStream PARAMS((
416: CONST char * addr,
417: BOOL filter,
418: HTRequest * request));
1.1 timbl 419:
420:
2.5 timbl 421: </PRE>
422: <H2>Load if necessary, and select an
2.9 timbl 423: anchor</H2>The anchor parameter may be a child
424: anchor. The anchor in the request
425: is set to the parent anchor.
2.5 timbl 426: <H3>On Entry,</H3>
427: <DL>
2.9 timbl 428: <DT>anchor
429: <DD> may be a child or parenet
430: anchor or 0 in which case there is
431: no effect.
432: <DT>request->anchor
433: <DD> Not set
434: yet.
2.5 timbl 435: </DL>
436:
437: <H3>On Exit,</H3>
438: <PRE>
439: </PRE>
440: <DL>
441: <DT>returns YES
2.6 timbl 442: <DD> Success
2.5 timbl 443: <DT>returns NO
2.6 timbl 444: <DD> Failure
2.9 timbl 445: <DT>request->anchor
446: <DD> The parenet anchor.
2.5 timbl 447: </DL>
448:
2.9 timbl 449: <PRE>extern BOOL HTLoadAnchor PARAMS((HTAnchor * a,
450: HTRequest * request));
1.1 timbl 451:
452:
2.5 timbl 453: </PRE>
2.24 luotonen 454:
455: <H2>Load a Document</H2>
456: This is an internal routine, which has an address AND a matching
457: anchor. (The public routines are called with one OR the other.)
458: This is, however, recursively called from file load module to
459: try ftp.
460:
461: <H3>On entry,</H3>
462: request->
463: <DL>
464: <DT> anchor <DD> a parent anchor with fully qualified
465: hypertext reference as its address set
466: <DT> output_format <DD> valid
467: <DT> output_stream <DD> valid on NULL
468: </DL>
469:
470: <H3>On exit,</H3>
471: returns
472: <DL>
473: <DT> <0 <DD> Error has occured.
474: <DT> HT_LOADED <DD> Success
475: <DT> HT_NO_DATA <DD> Success, but no document loaded.
476: (telnet sesssion started etc)
477: </DL>
478:
479: <PRE>
480: PUBLIC int HTLoad PARAMS((HTRequest * request));
481: </PRE>
482:
483:
2.20 frystyk 484: <H2>Bind an anchor to a request structure
485: without loading</H2>The anchor parameter may be a child
486: anchor. The anchor in the request
487: is set to the parent anchor. This
488: is useful in non-interactive mode
489: if no home-anchor is known. Actually
490: the same as HTLoadAnchor(), but without
491: loading
492: <H3>On Entry,</H3>
493: <DL>
494: <DT>anchor
495: <DD> may be a child or parenet
496: anchor or 0 in which case there is
497: no effect.
498: <DT>request->anchor
499: <DD> Not set yet.
500: </DL>
501:
502: <H3>On Exit,</H3>
503: <PRE>
504: </PRE>returns YES Success<P>
505: returns NO Failure <P>
506: request->anchor The parenet anchor.
507: <PRE>
508: extern BOOL HTBindAnchor PARAMS((HTAnchor *anchor, HTRequest *request));
509:
510:
511: </PRE>
2.5 timbl 512: <H2>Make a stream for Saving object back</H2>
513: <H3>On Entry,</H3>
514: <DL>
2.9 timbl 515: <DT>request->anchor
516: <DD> is valid anchor which
517: has previously beeing loaded
2.5 timbl 518: </DL>
519:
520: <H3>On exit,</H3>
521: <DL>
522: <DT>returns
2.6 timbl 523: <DD> 0 if error else a stream
524: to save the object to.
2.5 timbl 525: </DL>
526:
527: <PRE>
528:
2.13 timbl 529: extern HTStream * HTSaveStream PARAMS((HTRequest * request));
1.1 timbl 530:
531:
2.5 timbl 532: </PRE>
533: <H2>Search</H2>Performs a search on word given by
534: the user. Adds the search words to
535: the end of the current address and
536: attempts to open the new address.
537: <H3>On Entry,</H3>
538: <DL>
539: <DT>*keywords
2.6 timbl 540: <DD> space-separated keyword
2.5 timbl 541: list or similar search list
542: <DT>here
2.6 timbl 543: <DD> The anchor of the object being
2.5 timbl 544: searched
545: </DL>
1.1 timbl 546:
2.9 timbl 547: <PRE>extern BOOL HTSearch PARAMS((
548: CONST char * keywords,
549: HTParentAnchor* here,
550: HTRequest * request));
1.1 timbl 551:
552:
2.5 timbl 553: </PRE>
554: <H2>Search Given Indexname</H2>Performs a keyword search on word
555: given by the user. Adds the keyword
556: to the end of the current address
557: and attempts to open the new address.
558: <H3>On Entry,</H3>
559: <DL>
560: <DT>*keywords
2.6 timbl 561: <DD> space-separated keyword
2.5 timbl 562: list or similar search list
563: <DT>*indexname
2.6 timbl 564: <DD> is name of object search
2.5 timbl 565: is to be done on.
566: </DL>
1.1 timbl 567:
2.5 timbl 568: <PRE>extern BOOL HTSearchAbsolute PARAMS((
2.9 timbl 569: CONST char * keywords,
570: CONST char * indexname,
571: HTRequest * request));
1.1 timbl 572:
573:
2.5 timbl 574: </PRE>
2.9 timbl 575: <H2>Register an access method</H2>An access method is defined by an
576: HTProtocol structure which point
577: to the routines for performing the
578: various logical operations on an
579: object: in HTTP terms, GET, PUT,
580: and POST.<P>
581: Each of these routine takes as a
582: parameter a <A
583: NAME="z2" HREF="#z1">request structure</A> containing
584: details ofthe request. When the
585: protocol class routine is called,
586: the anchor elemnt in the request
587: is already valid (made valid by HTAccess).
588: <PRE>typedef struct _HTProtocol {
1.1 timbl 589: char * name;
590:
2.11 timbl 591: int (*load)PARAMS((HTRequest * request));
1.1 timbl 592:
2.11 timbl 593: HTStream* (*saveStream)PARAMS((HTRequest * request));
594:
2.9 timbl 595: HTStream* (*postStream)PARAMS((
596: HTRequest * request,
597: HTParentAnchor* postTo));
1.1 timbl 598:
599: } HTProtocol;
600:
601: extern BOOL HTRegisterProtocol PARAMS((HTProtocol * protocol));
602:
603:
2.5 timbl 604: </PRE>
605: <H2>Generate the anchor for the home
606: page</H2>
607: <PRE>
608: </PRE>As it involves file access, this
609: should only be done once when the
610: program first runs. This is a default
611: algorithm -- browser don't HAVE to
612: use this.
613: <PRE>extern HTParentAnchor * HTHomeAnchor NOPARAMS;
1.1 timbl 614:
2.25 ! luotonen 615: </PRE>
! 616:
! 617: <H2>Error Diagnostics</H2>
! 618: <PRE>
! 619:
! 620: PUBLIC void HTAddError PARAMS((HTRequest * req,
! 621: char * msg));
! 622:
! 623: PUBLIC void HTAddError2 PARAMS((HTRequest * req,
! 624: char * msg,
! 625: char * param));
! 626:
! 627: PUBLIC void HTAddErrorN PARAMS((HTRequest * req,
! 628: char * msg,
! 629: int param));
! 630:
! 631: PUBLIC void HTClearErrors PARAMS((HTRequest * req));
! 632:
! 633: </PRE>
! 634:
! 635: <PRE>
! 636:
1.1 timbl 637: #endif /* HTACCESS_H */
2.11 timbl 638:
2.25 ! luotonen 639: </PRE>
! 640: end of HTAccess
! 641: </BODY>
2.9 timbl 642: </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