Annotation of libwww/Library/src/HTAccess.c, revision 1.103
1.61 frystyk 1: /* HTAccess.c
2: ** ACCESS MANAGER
3: **
1.75 frystyk 4: ** (c) COPYRIGHT MIT 1995.
1.61 frystyk 5: ** Please first read the full copyright statement in the file COPYRIGH.
1.1 timbl 6: **
7: ** Authors
1.79 frystyk 8: ** TBL Tim Berners-Lee timbl@w3.org
1.4 timbl 9: ** JFG Jean-Francois Groff jfg@dxcern.cern.ch
1.1 timbl 10: ** DD Denis DeLaRoca (310) 825-4580 <CSP1DWD@mvs.oac.ucla.edu>
11: ** History
12: ** 8 Jun 92 Telnet hopping prohibited as telnet is not secure TBL
13: ** 26 Jun 92 When over DECnet, suppressed FTP, Gopher and News. JFG
1.42 frystyk 14: ** 6 Oct 92 Moved HTClientHost and HTlogfile into here. TBL
1.1 timbl 15: ** 17 Dec 92 Tn3270 added, bug fix. DD
1.2 timbl 16: ** 4 Feb 93 Access registration, Search escapes bad chars TBL
1.9 timbl 17: ** PARAMETERS TO HTSEARCH AND HTLOADRELATIVE CHANGED
18: ** 28 May 93 WAIS gateway explicit if no WAIS library linked in.
1.19 timbl 19: ** Dec 93 Bug change around, more reentrant, etc
1.42 frystyk 20: ** 09 May 94 logfile renamed to HTlogfile to avoid clash with WAIS
1.53 duns 21: ** 8 Jul 94 Insulate free() from _free structure element.
1.88 frystyk 22: ** Sep 95 Rewritten, HFN
1.1 timbl 23: */
24:
1.68 frystyk 25: #if !defined(HT_DIRECT_WAIS) && !defined(HT_DEFAULT_WAIS_GATEWAY)
26: #define HT_DEFAULT_WAIS_GATEWAY "http://www.w3.org:8001/"
1.54 frystyk 27: #endif
1.8 timbl 28:
1.67 frystyk 29: /* Library include files */
1.88 frystyk 30: #include "WWWLib.h"
1.93 frystyk 31: #include "HTReqMan.h"
32: #include "HTAccess.h" /* Implemented here */
1.88 frystyk 33:
1.99 frystyk 34: #ifndef VC
35: #define VC "unknown"
36: #endif
37:
1.93 frystyk 38: PRIVATE char * HTAppName = NULL; /* Application name: please supply */
39: PRIVATE char * HTAppVersion = NULL; /* Application version: please supply */
1.2 timbl 40:
1.99 frystyk 41: PRIVATE char * HTLibName = "libwww";
42: PRIVATE char * HTLibVersion = VC;
43:
44: PRIVATE BOOL HTSecure = NO; /* Can we access local file system? */
45:
1.59 frystyk 46: /* --------------------------------------------------------------------------*/
1.61 frystyk 47: /* Initialization and Termination of the Library */
48: /* --------------------------------------------------------------------------*/
49:
1.99 frystyk 50: /* Information about the Application
51: ** ---------------------------------
1.93 frystyk 52: */
53: PUBLIC CONST char * HTLib_appName (void)
54: {
1.99 frystyk 55: return HTAppName ? HTAppName : "UNKNOWN";
56: }
57:
58: PUBLIC CONST char * HTLib_appVersion (void)
59: {
60: return HTAppVersion ? HTAppVersion : "0.0";
1.93 frystyk 61: }
62:
1.99 frystyk 63: /* Information about libwww
64: ** ------------------------
65: */
66: PUBLIC CONST char * HTLib_name (void)
67: {
68: return HTLibName ? HTLibName : "UNKNOWN";
69: }
70:
71: PUBLIC CONST char * HTLib_version (void)
72: {
73: return HTLibVersion ? HTLibVersion : "0.0";
74: }
75:
76: /* Access Local File System
77: ** ------------------------
78: ** In this mode we do not tough the local file system at all
1.93 frystyk 79: */
1.99 frystyk 80: PUBLIC BOOL HTLib_secure (void)
81: {
82: return HTSecure;
83: }
84:
85: PUBLIC void HTLib_setSecure (BOOL mode)
1.93 frystyk 86: {
1.99 frystyk 87: HTSecure = mode;
1.93 frystyk 88: }
89:
1.61 frystyk 90: /* HTLibInit
91: **
92: ** This function initiates the Library and it MUST be called when
93: ** starting up an application. See also HTLibTerminate()
94: */
1.93 frystyk 95: PUBLIC BOOL HTLibInit (CONST char * AppName, CONST char * AppVersion)
1.61 frystyk 96: {
1.97 frystyk 97: #if WWWTRACE_MODE == WWWTRACE_FILE /* Open trace file */
1.102 frystyk 98: if ((TDEST = fopen(HT_TRACE_FILE, "a")) != NULL) {
1.67 frystyk 99: if (setvbuf(TDEST, NULL, _IOLBF, 0) < 0) { /* Change to line buffer */
1.97 frystyk 100: TTYPrint(TDEST, "WWWLibInit.. Can't initialize TRACE buffer - no TRACE\n");
1.67 frystyk 101: fclose(TDEST);
102: TDEST = NULL;
103: WWW_TraceFlag = 0;
104: }
105: } else
106: WWW_TraceFlag = 0;
1.97 frystyk 107: #endif /* WWWTRACE_FILE */
1.67 frystyk 108:
1.91 frystyk 109: if (WWWTRACE)
1.97 frystyk 110: TTYPrint(TDEST, "WWWLibInit.. INITIALIZING LIBRARY OF COMMON CODE\n");
1.63 frystyk 111:
1.93 frystyk 112: /* Set the application name and version */
113: if (AppName) {
114: char *ptr;
115: StrAllocCopy(HTAppName, AppName);
116: ptr = HTAppName;
117: while (*ptr) {
118: if (WHITE(*ptr)) *ptr = '_';
119: ptr++;
120: }
121: }
122: if (AppVersion) {
123: char *ptr;
124: StrAllocCopy(HTAppVersion, AppVersion);
125: ptr = HTAppVersion;
126: while (*ptr) {
127: if (WHITE(*ptr)) *ptr = '_';
128: ptr++;
129: }
130: }
131:
132: HTBind_init(); /* Initialize bindings */
1.61 frystyk 133:
1.88 frystyk 134: /* Register a call back function for the Net Manager */
1.101 frystyk 135: HTNetCall_addAfter(HTLoad_terminate, HT_ALL);
1.88 frystyk 136:
1.62 frystyk 137: #ifdef WWWLIB_SIG
1.61 frystyk 138: /* On Solaris (and others?) we get a BROKEN PIPE signal when connecting
1.67 frystyk 139: ** to a port where we should get `connection refused'. We ignore this
1.61 frystyk 140: ** using the following function call
141: */
142: HTSetSignal(); /* Set signals in library */
1.1 timbl 143: #endif
144:
1.67 frystyk 145: #ifdef _WINDOWS
146: /*
147: ** Initialise WinSock DLL. This must also be shut down! PMH
148: */
149: {
150: WSADATA wsadata;
151: if (WSAStartup(DESIRED_WINSOCK_VERSION, &wsadata)) {
1.91 frystyk 152: if (WWWTRACE)
1.97 frystyk 153: TTYPrint(TDEST, "WWWLibInit.. Can't initialize WinSoc\n");
1.67 frystyk 154: WSACleanup();
155: return NO;
156: }
157: if (wsadata.wVersion < MINIMUM_WINSOCK_VERSION) {
1.91 frystyk 158: if (WWWTRACE)
1.97 frystyk 159: TTYPrint(TDEST, "WWWLibInit.. Bad version of WinSoc\n");
1.67 frystyk 160: WSACleanup();
161: return NO;
162: }
163: }
164: #endif /* _WINDOWS */
165:
1.71 frystyk 166: #ifndef NO_TIMEGM
167: HTGetTimeZoneOffset(); /* Find offset from GMT if using mktime() */
168: #endif
1.70 frystyk 169: HTTmp_setRoot(NULL); /* Set up default tmp directory */
1.61 frystyk 170: return YES;
171: }
172:
173:
1.90 frystyk 174: /* HTLibTerminate
175: ** --------------
1.61 frystyk 176: ** This function frees memory kept by the Library and should be called
1.63 frystyk 177: ** before exit of an application (if you are on a PC platform)
1.61 frystyk 178: */
1.101 frystyk 179: PUBLIC BOOL HTLibTerminate (void)
1.61 frystyk 180: {
1.91 frystyk 181: if (WWWTRACE)
1.97 frystyk 182: TTYPrint(TDEST, "WWWLibTerm.. Cleaning up LIBRARY OF COMMON CODE\n");
1.101 frystyk 183: HTAtom_deleteAll(); /* Remove the atoms */
184: HTDNS_deleteAll(); /* Remove the DNS host cache */
185: HTAnchor_deleteAll(NULL); /* Delete anchors and drop hyperdocs */
1.73 frystyk 186:
1.81 frystyk 187: HTProtocol_deleteAll(); /* Remove bindings between access and protocols */
1.73 frystyk 188: HTBind_deleteAll(); /* Remove bindings between suffixes, media types */
189:
1.77 frystyk 190: HTFreeHostName(); /* Free up some internal strings */
1.63 frystyk 191: HTFreeMailAddress();
1.70 frystyk 192: HTTmp_freeRoot();
1.67 frystyk 193:
194: #ifdef _WINDOWS
195: WSACleanup();
196: #endif
197:
1.97 frystyk 198: #if WWWTRACE_MODE == WWWTRACE_FILE /* Close trace file */
1.67 frystyk 199: if (TDEST) {
200: fclose(TDEST);
201: TDEST = NULL;
202: WWW_TraceFlag = 0;
203: }
1.97 frystyk 204: #endif /* WWWTRACE_FILE */
1.61 frystyk 205: return YES;
206: }
207:
1.59 frystyk 208: /* --------------------------------------------------------------------------*/
1.88 frystyk 209: /* Access functions */
1.59 frystyk 210: /* --------------------------------------------------------------------------*/
1.33 luotonen 211:
1.90 frystyk 212: /* Request a document
213: ** -----------------
214: ** Private version that requests a document from the request manager
215: ** Returns YES if request accepted, else NO
1.88 frystyk 216: */
1.101 frystyk 217: PRIVATE BOOL HTLoadDocument (HTRequest * request, BOOL recursive)
1.88 frystyk 218: {
219: if (PROT_TRACE) {
1.90 frystyk 220: HTParentAnchor *anchor = HTRequest_anchor(request);
221: char * full_address = HTAnchor_address((HTAnchor *) anchor);
1.97 frystyk 222: TTYPrint(TDEST, "HTAccess.... Accessing document %s\n", full_address);
1.88 frystyk 223: free(full_address);
224: }
1.96 frystyk 225: return HTLoad(request, recursive);
1.58 frystyk 226: }
1.1 timbl 227:
228:
1.90 frystyk 229: /* Request a document from absolute name
230: ** -------------------------------------
231: ** Request a document referencd by an absolute URL.
232: ** Returns YES if request accepted, else NO
233: */
234: PUBLIC BOOL HTLoadAbsolute (CONST char * url, HTRequest* request)
235: {
236: if (url && request) {
237: HTAnchor * anchor = HTAnchor_findAddress(url);
238: HTRequest_setAnchor(request, anchor);
239: return HTLoadDocument(request, NO);
240: }
241: return NO;
242: }
243:
244:
245: /* Request a document from absolute name to stream
246: ** -----------------------------------------------
247: ** Request a document referencd by an absolute URL and sending the data
248: ** down a stream. This is _excactly_ the same as HTLoadAbsolute as
249: ** the ourputstream is specified using the function
250: ** HTRequest_setOutputStream(). 'filter' is ignored!
251: ** Returns YES if request accepted, else NO
252: */
253: PUBLIC BOOL HTLoadToStream (CONST char * url, BOOL filter, HTRequest *request)
254: {
255: return HTLoadAbsolute(url, request);
256: }
257:
258:
259: /* Request a document from relative name
260: ** -------------------------------------
261: ** Request a document referenced by a relative URL. The relative URL is
262: ** made absolute by resolving it relative to the address of the 'base'
263: ** anchor.
264: ** Returns YES if request accepted, else NO
265: */
266: PUBLIC BOOL HTLoadRelative (CONST char * relative,
267: HTParentAnchor * base,
268: HTRequest * request)
269: {
270: BOOL status = NO;
271: if (relative && base && request) {
272: char * rel = NULL;
273: char * full_url = NULL;
274: char * base_url = HTAnchor_address((HTAnchor *) base);
275: StrAllocCopy(rel, relative);
276: full_url = HTParse(HTStrip(rel), base_url,
277: PARSE_ACCESS|PARSE_HOST|PARSE_PATH|PARSE_PUNCTUATION);
278: status = HTLoadAbsolute(full_url, request);
279: free(rel);
280: free(full_url);
281: free(base_url);
282: }
283: return status;
284: }
285:
286:
287: /* Request an anchor
288: ** -----------------
289: ** Request the document referenced by the anchor
290: ** Returns YES if request accepted, else NO
291: */
292: PUBLIC BOOL HTLoadAnchor (HTAnchor * anchor, HTRequest * request)
293: {
294: if (anchor && request) {
295: HTRequest_setAnchor(request, anchor);
296: return HTLoadDocument(request, NO);
297: }
298: return NO;
299: }
300:
301:
302: /* Request an anchor
303: ** -----------------
304: ** Same as HTLoadAnchor but any information in the Error Stack in the
305: ** request object is kept, so that any error messages in one
1.52 frystyk 306: ** This function is almost identical to HTLoadAnchor, but it doesn't
307: ** clear the error stack so that the information in there is kept.
1.90 frystyk 308: ** Returns YES if request accepted, else NO
309: */
310: PUBLIC BOOL HTLoadAnchorRecursive (HTAnchor * anchor, HTRequest * request)
311: {
312: if (anchor && request) {
313: HTRequest_setAnchor(request, anchor);
314: return HTLoadDocument(request, YES);
315: }
316: return NO;
317: }
318:
319:
320: /* Search an Anchor
321: ** ----------------
322: ** Performs a keyword search on word given by the user. Adds the keyword
323: ** to the end of the current address and attempts to open the new address.
324: ** The list of keywords must be a space-separated list and spaces will
325: ** be converted to '+' before the request is issued.
326: ** Search can also be performed by HTLoadAbsolute() etc.
327: ** Returns YES if request accepted, else NO
328: */
329: PUBLIC BOOL HTSearch (CONST char * keywords,
330: HTParentAnchor * base,
331: HTRequest * request)
332: {
1.99 frystyk 333: BOOL status = NO;
1.90 frystyk 334: if (keywords && base && request) {
335: char *base_url = HTAnchor_address((HTAnchor *) base);
336: if (*keywords) {
337: char *plus;
338: StrAllocCat(base_url, "?");
339: StrAllocCat(base_url, keywords);
340: plus = strchr(base_url, '?');
341: while (*plus) {
342: if (*plus == ' ') *plus = '+';
343: plus++;
344: }
1.2 timbl 345: }
1.99 frystyk 346: status = HTLoadAbsolute(base_url, request);
347: free(base_url);
1.90 frystyk 348: }
1.99 frystyk 349: return status;
1.2 timbl 350: }
351:
352:
1.90 frystyk 353: /* Search a document from absolute name
354: ** ------------------------------------
355: ** Request a document referencd by an absolute URL appended with the
356: ** keywords given. The URL can NOT contain any fragment identifier!
357: ** The list of keywords must be a space-separated list and spaces will
358: ** be converted to '+' before the request is issued.
359: ** Returns YES if request accepted, else NO
360: */
361: PUBLIC BOOL HTSearchAbsolute (CONST char * keywords,
362: CONST char * url,
363: HTRequest * request)
364: {
365: if (url && request) {
366: HTAnchor * anchor = HTAnchor_findAddress(url);
367: return HTSearch(keywords, HTAnchor_parent(anchor), request);
368: }
369: return NO;
1.57 howcome 370: }
371:
1.70 frystyk 372: /* --------------------------------------------------------------------------*/
373: /* Document Poster */
374: /* --------------------------------------------------------------------------*/
375:
1.90 frystyk 376: /* Copy an anchor
1.70 frystyk 377: ** --------------
1.90 frystyk 378: ** Fetch the URL (possibly local file URL) and send it using either PUT
379: ** or POST to the remote destination using HTTP. The caller can decide the
380: ** exact method used and which HTTP header fields to transmit by setting
381: ** the user fields in the request structure.
1.92 frystyk 382: ** If posting to NNTP then we can't dispatch at this level but must pass
383: ** the source anchor to the news module that then takes all the refs
384: ** to NNTP and puts into the "newsgroups" header
1.90 frystyk 385: ** Returns YES if request accepted, else NO
1.70 frystyk 386: */
1.90 frystyk 387: PUBLIC BOOL HTCopyAnchor (HTAnchor * src_anchor, HTRequest * main_req)
1.80 frystyk 388: {
1.78 frystyk 389: HTRequest *src_req;
1.85 frystyk 390: if (!src_anchor || !main_req)
1.90 frystyk 391: return NO;
1.70 frystyk 392:
1.80 frystyk 393: /* Build the POST web if not already there */
1.85 frystyk 394: if (!main_req->source) {
1.80 frystyk 395: src_req = HTRequest_new(); /* First set up the source */
396: HTAnchor_clearHeader((HTParentAnchor *) src_anchor);
1.85 frystyk 397: src_req->reload = HT_MEM_REFRESH;
1.80 frystyk 398: src_req->source = src_req; /* Point to myself */
399: src_req->output_format = WWW_SOURCE; /* We want source (for now) */
400:
401: /* Set up the main link in the source anchor */
402: {
1.85 frystyk 403: HTLink *main_link = HTAnchor_findMainLink(src_anchor);
404: HTAnchor *main_anchor = HTAnchor_linkDest(main_link);
405: HTMethod method = HTAnchor_linkMethod(main_link);
406: if (!main_link || method==METHOD_INVALID) {
1.91 frystyk 407: if (WWWTRACE)
1.97 frystyk 408: TTYPrint(TDEST, "Copy Anchor. No destination found or unspecified method");
1.80 frystyk 409: HTRequest_delete(src_req);
1.90 frystyk 410: return NO;
1.80 frystyk 411: }
1.85 frystyk 412: if (HTAnchor_linkResult(main_link) == HT_LINK_NONE) {
413: main_req->GenMask |= HT_DATE; /* Send date header */
414: main_req->source = src_req;
415: main_req->reload = HT_CACHE_REFRESH;
416: main_req->method = method;
417: HTRequest_addDestination(src_req, main_req);
418: main_req->input_format = WWW_SOURCE; /* for now :-( @@@ */
1.90 frystyk 419: if (HTLoadAnchor(main_anchor, main_req) == NO)
420: return NO;
1.85 frystyk 421: }
1.80 frystyk 422: }
1.78 frystyk 423:
1.80 frystyk 424: /* For all other links in the source anchor */
425: if (src_anchor->links) {
426: HTList *cur = src_anchor->links;
427: HTLink *pres;
1.85 frystyk 428: while ((pres = (HTLink *) HTList_nextObject(cur)) &&
429: HTAnchor_linkResult(pres) == HT_LINK_NONE) {
430: HTAnchor *dest = HTAnchor_linkDest(pres);
431: HTMethod method = HTAnchor_linkMethod(pres);
1.80 frystyk 432: HTRequest *dest_req;
433: if (!dest || method==METHOD_INVALID) {
1.91 frystyk 434: if (WWWTRACE)
1.97 frystyk 435: TTYPrint(TDEST, "Copy Anchor. Bad anchor setup %p\n",
1.80 frystyk 436: dest);
1.90 frystyk 437: return NO;
1.80 frystyk 438: }
439: dest_req = HTRequest_new();
1.85 frystyk 440: dest_req->GenMask |= HT_DATE; /* Send date header */
1.80 frystyk 441: dest_req->source = src_req;
1.85 frystyk 442: dest_req->reload = HT_CACHE_REFRESH;
1.80 frystyk 443: dest_req->method = method;
444: HTRequest_addDestination(src_req, dest_req);
445: dest_req->input_format = WWW_SOURCE; /* for now :-( @@@ */
1.90 frystyk 446: if (HTLoadAnchor(dest, dest_req) == NO)
447: return NO;
1.80 frystyk 448: }
449: }
450: } else { /* Use the existing Post Web and restart it */
1.85 frystyk 451: src_req = main_req->source;
1.80 frystyk 452: if (src_req->mainDestination)
1.90 frystyk 453: if (HTLoadDocument(main_req, NO) == NO)
454: return NO;
1.80 frystyk 455: if (src_req->destinations) {
456: HTList *cur = src_anchor->links;
457: HTRequest *pres;
458: while ((pres = (HTRequest *) HTList_nextObject(cur)) != NULL) {
1.90 frystyk 459: if (HTLoadDocument(pres, NO) == NO)
460: return NO;
1.80 frystyk 461: }
462: }
1.78 frystyk 463: }
464:
1.80 frystyk 465: /* Now open the source */
466: return HTLoadAnchor(src_anchor, src_req);
1.70 frystyk 467: }
468:
469:
1.90 frystyk 470: /* Upload an Anchor
1.70 frystyk 471: ** ----------------
1.90 frystyk 472: ** Send the contents (in hyperdoc) of the source anchor using either PUT
473: ** or POST to the remote destination using HTTP. The caller can decide the
474: ** exact method used and which HTTP header fields to transmit by setting
475: ** the user fields in the request structure.
476: ** Returns YES if request accepted, else NO
477: */
478: PUBLIC BOOL HTUploadAnchor (HTAnchor * src_anchor,
479: HTParentAnchor * dest_anchor,
480: HTRequest * dest_req)
1.70 frystyk 481: {
1.90 frystyk 482: if (!src_anchor || !dest_anchor || !dest_req)
483: return NO;
1.70 frystyk 484: if (!(dest_anchor->methods & dest_req->method)) {
1.103 ! frystyk 485: BOOL confirm = NO;
! 486: HTAlertCallback *cbf = HTAlert_find(HT_A_CONFIRM);
! 487: if (cbf)
! 488: confirm=(*cbf)(dest_req, HT_A_CONFIRM, HT_MSG_METHOD, NULL,
! 489: (void *) HTMethod_name(dest_req->method), NULL);
! 490: if (!confirm) return NO;
1.70 frystyk 491: }
1.77 frystyk 492:
493: /* @@@ NOT FINISHED @@@ */
1.70 frystyk 494:
1.90 frystyk 495: return NO;
1.1 timbl 496: }
1.97 frystyk 497:
Webmaster