Annotation of libwww/Library/src/HTFilter.c, revision 2.15

2.1       frystyk     1: /*
                      2: **     BEFORE AND AFTER FILTERS
                      3: **
                      4: **     (c) COPYRIGHT MIT 1995.
                      5: **     Please first read the full copyright statement in the file COPYRIGH.
2.15    ! frystyk     6: **     @(#) $Id: HTFilter.c,v 2.14 1996/09/13 02:05:25 frystyk Exp $
2.1       frystyk     7: **
                      8: **     This module implrments a set of default filters that can be registerd
                      9: **     as BEFORE and AFTER filters to the Net manager
                     10: ** Authors
                     11: **     HFN     Henrik Frystyk, frystyk@w.org
                     12: ** History
                     13: **     Jul 4, 96       Written
                     14: */
                     15: 
                     16: /* Library include files */
                     17: #include "WWWLib.h"
                     18: #include "WWWCache.h"
                     19: #include "WWWHTTP.h"
                     20: #include "HTLog.h"
                     21: #include "HTAccess.h"
2.10      frystyk    22: #include "HTProxy.h"
                     23: #include "HTRules.h"
2.1       frystyk    24: #include "HTFilter.h"                                   /* Implemented here */
                     25: 
                     26: /* ------------------------------------------------------------------------- */
                     27: 
                     28: /*
                     29: **     Proxy and Gateway BEFORE filter
                     30: **     -------------------------------
                     31: **     Checks for registerd proxy servers or gateways and sees whether this
                     32: **     request should be redirected to a proxy or a gateway. Proxies have
                     33: **     higher priority than gateways so we look for them first!
                     34: **     For HTTP/1.0 and HTTP/1.1 we may only send a full URL (including the
                     35: **     host portion) to proxy servers. Therefore, we tell the Library whether
                     36: **     to use the full URL or the traditional HTTP one without the host part.
                     37: */
2.15    ! frystyk    38: PUBLIC int HTProxyFilter (HTRequest * request, void * param, int mode)
2.1       frystyk    39: {
                     40:     HTParentAnchor * anchor = HTRequest_anchor(request);
2.2       frystyk    41:     char * addr = HTAnchor_physical(anchor);
2.1       frystyk    42:     char * physical = NULL;
                     43:     if ((physical = HTProxy_find(addr))) {
2.6       frystyk    44:        HTRequest_setFullURI(request, YES);                       /* For now */
2.5       frystyk    45:        HTRequest_setProxy(request, physical);
2.8       frystyk    46:        HT_FREE(physical);
2.6       frystyk    47: #if 0
                     48:        /* Don't paste the URLs together anymore */
2.1       frystyk    49:        StrAllocCat(physical, addr);
2.5       frystyk    50:        HTAnchor_setPhysical(anchor, physical); 
2.6       frystyk    51: #endif
2.1       frystyk    52:     } else if ((physical = HTGateway_find(addr))) {
                     53:        /* 
                     54:        ** A gateway URL is crated by chopping off any leading "/" to make the
                     55:        ** host into part of path
                     56:        */
                     57:        char * path =
                     58:            HTParse(addr, "", PARSE_HOST + PARSE_PATH + PARSE_PUNCTUATION);
                     59:        char * gatewayed = HTParse(path+1, physical, PARSE_ALL);
                     60:        HTAnchor_setPhysical(anchor, gatewayed);
                     61:        HT_FREE(path);
                     62:        HT_FREE(gatewayed);
                     63:        HTRequest_setFullURI(request, NO);
2.6       frystyk    64:        HTRequest_deleteProxy(request);
2.1       frystyk    65:     } else {
2.6       frystyk    66:        HTRequest_setFullURI(request, NO);                        /* For now */
                     67:        HTRequest_deleteProxy(request);
2.1       frystyk    68:     }
                     69:     return HT_OK;
                     70: }
                     71: 
                     72: /*
                     73: **     Rule Translation BEFORE Filter
                     74: **     ------------------------------
                     75: **     If we have a set of rules loaded (see the Rule manager) then check
                     76: **     before each request whether how that should be translated. The trick
                     77: **     is that a parent anchor has a "address" which is the part from the URL
                     78: **     we used when we created the anchor. However, it also have a "physical
                     79: **     address" which is the place we are actually going to look for the
2.2       frystyk    80: **     resource. Hence this filter translates the physical address
                     81: **     (if any translations are found)
2.1       frystyk    82: */
2.15    ! frystyk    83: PUBLIC int HTRuleFilter (HTRequest * request, void * param, int mode)
2.1       frystyk    84: {
                     85:     HTList * list = HTRule_global();
                     86:     HTParentAnchor * anchor = HTRequest_anchor(request);
2.2       frystyk    87:     char * addr = HTAnchor_physical(anchor);
2.1       frystyk    88:     char * physical = HTRule_translate(list, addr, NO);
                     89:     if (!physical) {
                     90:        HTRequest_addError(request, ERR_FATAL, NO, HTERR_FORBIDDEN,
                     91:                           NULL, 0, "HTRuleFilter");
                     92:        return HT_ERROR;
                     93:     }
                     94:     HTAnchor_setPhysical(anchor, physical);
                     95:     HT_FREE(physical);
                     96:     return HT_OK;
                     97: }
                     98: 
                     99: /*
                    100: **     Cache Validation BEFORE Filter
                    101: **     ------------------------------
                    102: **     Check the cache mode to see if we can use an already loaded version
                    103: **     of this document. If so and our copy is valid then we don't have
                    104: **     to go out and get it unless we are forced to
2.3       frystyk   105: **     We only check the cache in caseof a GET request. Otherwise, we go
                    106: **     directly to the source.
2.1       frystyk   107: */
2.15    ! frystyk   108: PUBLIC int HTCacheFilter (HTRequest * request, void * param, int mode)
2.1       frystyk   109: {
                    110:     HTParentAnchor * anchor = HTRequest_anchor(request);
2.12      frystyk   111:     HTCache * cache = NULL;
2.15    ! frystyk   112:     HTReload reload = HTRequest_reloadMode(request);
2.3       frystyk   113:     HTMethod method = HTRequest_method(request);
2.12      frystyk   114:     HTDisconnectedMode disconnect = HTCacheMode_disconnected();
                    115:     BOOL validate = NO;
2.3       frystyk   116: 
                    117:     /*
2.12      frystyk   118:     **  If the cache is disabled all together then it won't help looking, huh?
2.3       frystyk   119:     */
2.12      frystyk   120:     if (!HTCacheMode_enabled()) return HT_OK;
                    121:     if (CACHE_TRACE) HTTrace("Cachefilter. Checking persistent cache\n");
2.3       frystyk   122: 
2.1       frystyk   123:     /*
2.12      frystyk   124:     **  Now check the cache...
2.1       frystyk   125:     */
2.12      frystyk   126:     if (method != METHOD_GET) {
                    127:        if (CACHE_TRACE) HTTrace("Cachefilter. We only check GET methods\n");
2.15    ! frystyk   128:     } else if (reload == HT_CACHE_FLUSH) {
2.12      frystyk   129:        /*
                    130:        ** If the mode if "Force Reload" then don't even bother to check the
                    131:        ** cache - we flush everything we know abut this document anyway.
2.1       frystyk   132:        ** Add the appropriate request headers. We use both the "pragma"
                    133:        ** and the "cache-control" headers in order to be
2.12      frystyk   134:        ** backwards compatible with HTTP/1.0
2.1       frystyk   135:        */
2.12      frystyk   136:        validate = YES;
2.1       frystyk   137:        HTRequest_addGnHd(request, HT_G_PRAGMA_NO_CACHE);
2.11      frystyk   138:        HTRequest_addCacheControl(request, "no-cache", "");
2.1       frystyk   139: 
                    140:        /*
2.15    ! frystyk   141:        **  We also flush the information in the anchor as we don't want to
        !           142:        **  inherit any "old" values
2.1       frystyk   143:        */
                    144:        HTAnchor_clearHeader(anchor);
                    145: 
2.12      frystyk   146:     } else {
                    147:        /*
                    148:        ** Check the persistent cache manager. If we have a cache hit then
                    149:        ** continue to see if the reload mode requires us to do a validation
                    150:        ** check. This filter assumes that we can get the cached version
                    151:        ** through one of our protocol modules (for example the file module)
                    152:        */
                    153:        cache = HTCache_find(anchor);
2.1       frystyk   154:        if (cache) {
2.15    ! frystyk   155:            reload = HTMAX(reload, HTCache_isFresh(cache, request));
        !           156:            HTRequest_setReloadMode(request, reload);
2.12      frystyk   157: 
                    158:            /*
                    159:            **  Now check the mode and add the right headers for the validation
                    160:            **  If we are to validate a cache entry then we get a lock
                    161:            **  on it so that not other requests can steal it.
                    162:            */
2.15    ! frystyk   163:            if (reload == HT_CACHE_RANGE_VALIDATE) {
        !           164:                /*
        !           165:                **  If we were asked to range validate the cached object then
        !           166:                **  use the etag or the last modified for cache validation
        !           167:                */
        !           168:                validate = YES;
        !           169:                HTCache_getLock(cache, request);
        !           170:                HTRequest_addRqHd(request, HT_C_IF_RANGE);
        !           171:            } else if (reload == HT_CACHE_END_VALIDATE) {
2.12      frystyk   172:                /*
                    173:                **  If we were asked to end-to-end validate the cached object
                    174:                **  then use a max-age=0 cache control directive
                    175:                */
                    176:                validate = YES;
                    177:                HTCache_getLock(cache, request);
                    178:                HTRequest_addCacheControl(request, "max-age", "0");
2.15    ! frystyk   179:            } else if (reload == HT_CACHE_VALIDATE) {
2.11      frystyk   180:                /*
2.12      frystyk   181:                **  If we were asked to validate the cached object then
2.11      frystyk   182:                **  use the etag or the last modified for cache validation
2.15    ! frystyk   183:                **  We use both If-None-Match or If-Modified-Since.
2.11      frystyk   184:                */
2.12      frystyk   185:                validate = YES;
                    186:                HTCache_getLock(cache, request);
2.11      frystyk   187:                HTRequest_addRqHd(request, HT_C_IF_NONE_MATCH | HT_C_IMS);
2.12      frystyk   188:            } else {
                    189:                /*
                    190:                **  The entity does not require any validation at all. We
2.15    ! frystyk   191:                **  can just go ahead and get it from the cache. In case we
        !           192:                **  have a fresh subpart of the entity, then we issue a 
        !           193:                **  conditional GET request with the range set by the cache
        !           194:                **  manager. Issuing the conditional range request is 
        !           195:                **  equivalent to a validation as we have to go out on the
        !           196:                **  net. This may have an effect if running in disconnected
        !           197:                **  mode. We disable all BEFORE filters as they don't make
        !           198:                **  sense while loading the cache entry.
2.12      frystyk   199:                */
2.15    ! frystyk   200:                {
        !           201:                    char * name = HTCache_name(cache);
        !           202:                    HTAnchor_setPhysical(anchor, name);
        !           203:                    HTCache_addHit(cache);
        !           204:                    HT_FREE(name);
        !           205:                }
2.11      frystyk   206:            }
                    207:        }
2.12      frystyk   208:     }
                    209:     
                    210:     /*
                    211:     **  If we are in disconnected mode and we are to validate an entry
                    212:     **  then check whether what mode of disconnected mode we're in. If
                    213:     **  we are to use our own cache then return a "504 Gateway Timeout"
                    214:     */
                    215:     if ((!cache || validate) && disconnect != HT_DISCONNECT_NONE) {
                    216:        if (disconnect == HT_DISCONNECT_EXTERNAL)
                    217:            HTRequest_addCacheControl(request, "only-if-cached", "");
                    218:        else {
                    219:            HTRequest_addError(request, ERR_FATAL, NO,
                    220:                               HTERR_GATE_TIMEOUT, "Disconnected Cache Mode",
                    221:                               0, "HTCacheFilter");
                    222:            return HT_ERROR;
                    223:        }
2.11      frystyk   224:     }
                    225:     return HT_OK;
                    226: }
                    227: 
                    228: /*
2.15    ! frystyk   229: **     Check the Memory Cache (History list) BEFORE filter
        !           230: **     ---------------------------------------------------
2.11      frystyk   231: **     Check if document is already loaded. The user can define whether
                    232: **     the history list should follow normal expiration or work as a
                    233: **     traditional history list where expired documents are not updated.
                    234: **     We don't check for anything but existence proof of a document
                    235: **     associated with the anchor as the definition is left to the application
                    236: */
2.15    ! frystyk   237: PUBLIC int HTMemoryCacheFilter (HTRequest * request, void * param, int mode)
2.11      frystyk   238: {
                    239:     HTReload validation = HTRequest_reloadMode(request);
                    240:     HTParentAnchor * anchor = HTRequest_anchor(request);
                    241:     void * document = HTAnchor_document(anchor);
2.1       frystyk   242: 
2.11      frystyk   243:     /*
2.14      frystyk   244:     **  We only check the memory cache if it's a GET method
                    245:     */
                    246:     if (HTRequest_method(request) != METHOD_GET) {
                    247:        if (CACHE_TRACE) HTTrace("Mem Cache... We only check GET methods\n");
                    248:        return HT_OK;
                    249:     }
                    250: 
                    251:     /*
2.11      frystyk   252:     **  If we are asked to flush the persistent cache then there is no reason
                    253:     **  to do anything here - we're flushing it anyway. Also if no document
                    254:     **  then just exit from this filter.
                    255:     */
                    256:     if (!document || validation > HT_CACHE_FLUSH_MEM) {
                    257:        if (CACHE_TRACE) HTTrace("Mem Cache... No fresh document...\n");
                    258:        return HT_OK;
                    259:     }
2.1       frystyk   260: 
2.11      frystyk   261:     /*
                    262:     **  If we have a document object associated with this anchor then we also
                    263:     **  have the object in the history list. Depending on what the user asked,
                    264:     **  we can add a cache validator
                    265:     */
2.14      frystyk   266: #if 0
2.11      frystyk   267:     if (document) {
                    268:        if (validation != HT_CACHE_FLUSH_MEM) {
2.14      frystyk   269:            HTExpiresMode expires = HTCacheMode_expires();
2.11      frystyk   270:            if (CACHE_TRACE)
                    271:                HTTrace("Mem Cache... Document already in memory\n");
                    272:            if (expires != HT_EXPIRES_IGNORE) {
                    273: 
                    274:                /*
                    275:                **  Ask the cache manager if this object has expired. Also
                    276:                **  check if we should care about expiration or not.
                    277:                */
                    278:                if (!HTCache_isValid(anchor)) {
                    279:                    if (expires == HT_EXPIRES_NOTIFY) {
                    280: 
                    281:                        /*
                    282:                        ** See if we have a function registered for outputting errors.
                    283:                        ** If so then call it and present the message to the user
                    284:                        */
                    285:                        HTAlertCallback * cbf = HTAlert_find(HT_A_MESSAGE);
                    286:                        if (cbf)
                    287:                            (*cbf)(request, HT_A_MESSAGE, HTERR_CACHE_EXPIRED,
                    288:                                   NULL, HTRequest_error(request), NULL);
                    289:                    } else {
                    290:                        if (CACHE_TRACE) HTTrace("Mem Cache... Expired - autoreload\n");
                    291:                        HTRequest_addRqHd(request, HT_C_IF_NONE_MATCH | HT_C_IMS);
                    292:                        return HT_OK;           /* Must go get it */
                    293:                    }
                    294:                }
2.1       frystyk   295:            }
                    296:        }
2.14      frystyk   297:        return HT_LOADED;                       /* Got it! */
                    298:     }
                    299:     return HT_OK;
                    300: #endif
                    301:     if (document && validation != HT_CACHE_FLUSH_MEM) {
                    302:        if (CACHE_TRACE) HTTrace("Mem Cache... Document already in memory\n");
                    303:        return HT_LOADED;
2.1       frystyk   304:     }
                    305:     return HT_OK;
                    306: }
                    307: 
                    308: /*
2.15    ! frystyk   309: **     Cache Update AFTER filter
        !           310: **     -------------------------
        !           311: **     On our way out we catch the metainformation and stores it in
        !           312: **     our persistent store. If we have a cache validation (a 304
        !           313: **     response then we use the new metainformation and merges it with
        !           314: **     the existing information already captured in the cache.
        !           315: */
        !           316: PUBLIC int HTCacheUpdateFilter (HTRequest * request, HTResponse * response,
        !           317:                                void * param, int status)
        !           318: {
        !           319:     HTParentAnchor * anchor = HTRequest_anchor(request);
        !           320:     HTCache * cache = HTCache_find(anchor);
        !           321: 
        !           322:     /*
        !           323:     **  If this request resulted in a "304 Not Modified" response then
        !           324:     **  we merge the new metainformation with the old.
        !           325:     */
        !           326:     if (CACHE_TRACE) HTTrace("Cache....... Merging metainformation\n");
        !           327: 
        !           328:     /*
        !           329:     **  It may in fact be that the information in the 304 response
        !           330:     **  told us that we can't cache the entity anymore. If this is the
        !           331:     **  case then flush it now. Otherwise prepare for a cache read
        !           332:     */
        !           333:     if (HTResponse_isCachable(response) == NO) {
        !           334:        HTCache_remove(cache);
        !           335:     } else {
        !           336:        HTCache_updateMeta(cache, request, response);
        !           337:        HTRequest_setReloadMode(request, HT_CACHE_OK);
        !           338:     }
        !           339: 
        !           340:     /*
        !           341:     **  Start request directly from the cache. As with the redirection filter
        !           342:     **  we reuse the same request object which means that we must
        !           343:     **  keep this around until the cache load request has terminated
        !           344:     **  In the case of a 
        !           345:     */
        !           346:     {
        !           347:        HTLoad(request, NO);
        !           348:        return HT_ERROR;
        !           349:     }
        !           350: }
        !           351: 
        !           352: /*
2.1       frystyk   353: **     Error and Information AFTER filter
                    354: **     ----------------------------------
                    355: **     It checks the status code from a request and generates an 
                    356: **     error/information message if required.
                    357: */
2.15    ! frystyk   358: PUBLIC int HTInfoFilter (HTRequest * request, HTResponse * response,
        !           359:                         void * param, int status)
2.1       frystyk   360: {
                    361:     HTParentAnchor * anchor = HTRequest_anchor(request);
                    362:     char * uri = HTAnchor_address((HTAnchor*) anchor);
                    363:     switch (status) {
                    364:     case HT_RETRY:
                    365:        if (PROT_TRACE)
                    366:            HTTrace("Load End.... NOT AVAILABLE, RETRY AT %ld\n",
2.15    ! frystyk   367:                    HTResponse_retryTime(response));
2.1       frystyk   368:        break;
                    369: 
                    370:     case HT_ERROR:
                    371:     {
                    372:        /*
                    373:        ** See if we have a function registered for outputting errors.
                    374:        ** If so then call it and present the message to the user
                    375:        */
                    376:        HTAlertCallback *cbf = HTAlert_find(HT_A_MESSAGE);
                    377:        if (cbf) (*cbf)(request, HT_A_MESSAGE, HT_MSG_NULL, NULL,
                    378:                        HTRequest_error(request), NULL);
                    379:        if (PROT_TRACE)
                    380:            HTTrace("Load End.... ERROR: Can't access `%s\'\n",
                    381:                    uri ? uri : "<UNKNOWN>");
2.3       frystyk   382:        break;
2.7       frystyk   383:     }    
                    384: 
                    385:     case HT_NO_DATA:
                    386:     {
                    387:        /*
                    388:        ** The document was empty
                    389:        */
                    390:        HTAlertCallback *cbf = HTAlert_find(HT_A_MESSAGE);
                    391:        if (cbf) (*cbf)(request, HT_A_MESSAGE, HT_MSG_NULL, NULL,
                    392:                        HTRequest_error(request), NULL);
                    393:        if (PROT_TRACE)
                    394:            HTTrace("Load End.... EMPTY: No content `%s\'\n",
                    395:                    uri ? uri : "<UNKNOWN>");
                    396:        break;
                    397:     }    
2.3       frystyk   398: 
                    399:     case HT_LOADED:
                    400:     {
                    401:        /*
                    402:        ** Even though we have received a loaded status the thing we have
                    403:        ** loaded successfully may in fact be an error message. We therefore
                    404:        ** look at the error stack to see what to do.
                    405:        */
                    406:        HTAlertCallback *cbf = HTAlert_find(HT_A_MESSAGE);
                    407:        if (cbf) (*cbf)(request, HT_A_MESSAGE, HT_MSG_NULL, NULL,
                    408:                        HTRequest_error(request), NULL);
                    409:        if (PROT_TRACE) HTTrace("Load End.... OK: `%s\'\n", uri);
2.1       frystyk   410:        break;
                    411:     }
                    412: 
                    413:     default:
                    414:        if (PROT_TRACE)
                    415:            HTTrace("Load End.... Request ended with code %d\n", status);
                    416:        break;
                    417:     }
                    418: 
                    419:     HT_FREE(uri);
                    420:     return HT_OK;
                    421: }
                    422: 
                    423: /*
                    424: **     Redirection AFTER filter
                    425: **     ------------------------
                    426: **     The redirection handler only handles redirections
                    427: **     on the GET or HEAD method (or any other safe method)
                    428: */
2.15    ! frystyk   429: PUBLIC int HTRedirectFilter (HTRequest * request, HTResponse * response,
        !           430:                             void * param, int status)
2.1       frystyk   431: {
                    432:     HTMethod method = HTRequest_method(request); 
2.15    ! frystyk   433:     HTAnchor * new_anchor = HTResponse_redirection(response); 
2.7       frystyk   434:     if (!new_anchor) {
                    435:        if (PROT_TRACE) HTTrace("Redirection. No destination\n");
                    436:        return HT_OK;
                    437:     }
                    438: 
2.1       frystyk   439:     /*
                    440:     ** Only do redirect on GET and HEAD
                    441:     */
2.7       frystyk   442:     if (!HTMethod_isSafe(method)) { 
2.4       frystyk   443:        HTAlertCallback * prompt = HTAlert_find(HT_A_CONFIRM);
                    444:        if (prompt) {
                    445:            if ((*prompt)(request, HT_A_CONFIRM, HT_MSG_REDIRECTION,
                    446:                          NULL, NULL, NULL) != YES)
                    447:                return HT_ERROR;
                    448:        }
2.1       frystyk   449:     } 
                    450:  
                    451:     /*
                    452:     **  Start new request with the redirect anchor found in the headers.
                    453:     ** Note that we reuse the same request object which means that we must
                    454:     **  keep this around until the redirected request has terminated. It also
                    455:     **  allows us in an easy way to keep track of the number of redirections
                    456:     ** so that we can detect endless loops.
                    457:     */ 
2.4       frystyk   458:     if (HTRequest_doRetry(request)) { 
2.1       frystyk   459:        HTLoadAnchor(new_anchor, request);
2.9       frystyk   460:     } else {
                    461:        HTRequest_addError(request, ERR_FATAL, NO, HTERR_MAX_REDIRECT,
                    462:                           NULL, 0, "HTRedirectFilter");
                    463:     }
                    464: 
                    465:     /*
                    466:     **  By returning HT_ERROR we make sure that this is the last handler to be
                    467:     **  called. We do this as we don't want any other filter to delete the 
                    468:     **  request object now when we have just started a new one ourselves
                    469:     */
                    470:     return HT_ERROR;
                    471: } 
                    472: 
                    473: /*
2.15    ! frystyk   474: **     Retry through Proxy AFTER Filter
        !           475: **     --------------------------------
2.9       frystyk   476: **     This filter handles a 305 Use Proxy response and retries the request
                    477: **     through the proxy
                    478: */
2.15    ! frystyk   479: PUBLIC int HTUseProxyFilter (HTRequest * request, HTResponse * response,
        !           480:                             void * param, int status)
2.9       frystyk   481: {
2.15    ! frystyk   482:     HTAnchor * proxy_anchor = HTResponse_redirection(response); 
2.9       frystyk   483:     if (!proxy_anchor) {
                    484:        if (PROT_TRACE) HTTrace("Use Proxy... No proxy location\n");
                    485:        return HT_OK;
                    486:     }
                    487: 
                    488:     /*
                    489:     **  Add the proxy to the list. Assume HTTP access method only!
                    490:     */
                    491:     {
                    492:        char * addr = HTAnchor_address(proxy_anchor);
                    493:        HTProxy_add("http", addr);
                    494:        HT_FREE(addr);
                    495:     } 
                    496:  
                    497:     /*
                    498:     **  Start new request through the proxy if we haven't reached the max
                    499:     **  number of redirections for this request
                    500:     */ 
                    501:     if (HTRequest_doRetry(request)) { 
                    502:        HTLoadAnchor(proxy_anchor, request);
2.1       frystyk   503:     } else {
                    504:        HTRequest_addError(request, ERR_FATAL, NO, HTERR_MAX_REDIRECT,
                    505:                           NULL, 0, "HTRedirectFilter");
                    506:     }
                    507: 
                    508:     /*
                    509:     **  By returning HT_ERROR we make sure that this is the last handler to be
                    510:     **  called. We do this as we don't want any other filter to delete the 
                    511:     **  request object now when we have just started a new one ourselves
                    512:     */
                    513:     return HT_ERROR;
                    514: } 
                    515: 
                    516: /*
                    517: **     Client side authentication BEFORE filter
                    518: **     ----------------------------------------
                    519: **     The filter generates the credentials required to access a document
                    520: **     Getting the credentials may involve asking the user
                    521: */
2.15    ! frystyk   522: PUBLIC int HTCredentialsFilter (HTRequest * request, void * param, int mode)
2.1       frystyk   523: {
                    524:     /*
                    525:     ** Ask the authentication module to call the right credentials generator
                    526:     ** that understands this scheme
                    527:     */
2.15    ! frystyk   528:     if (HTAA_beforeFilter(request, param, mode) == HT_OK) {
2.1       frystyk   529:        if (PROT_TRACE) HTTrace("Credentials. verified\n");
                    530:        return HT_OK;
                    531:     } else {
                    532:        HTRequest_addError(request, ERR_FATAL, NO, HTERR_UNAUTHORIZED,
                    533:                           NULL, 0, "HTCredentialsFilter");
                    534:        return HT_ERROR;
                    535:     }
                    536: }
                    537: 
                    538: /*
                    539: **     Client side authentication AFTER filter
                    540: **     ---------------------------------------
                    541: **     The client side authentication filter uses the 
                    542: **     user dialog messages registered in the HTAlert module.
                    543: **     By default these are the ones used by the line mode browser but you can
                    544: **     just register something else.
                    545: */
2.15    ! frystyk   546: PUBLIC int HTAuthFilter (HTRequest * request, HTResponse * response,
        !           547:                         void * param, int status)
2.1       frystyk   548: {
                    549:     /*
                    550:     ** Ask the authentication module to call the right challenge parser
                    551:     ** that understands this scheme
                    552:     */
2.15    ! frystyk   553:     if (HTAA_afterFilter(request, response, param, status) == HT_OK) {
2.1       frystyk   554: 
                    555:        /*
                    556:        ** Start request with new credentials. As with the redirection filter
                    557:        ** we reuse the same request object which means that we must
                    558:        ** keep this around until the redirected request has terminated
                    559:        */
                    560:        HTLoad(request, NO);
                    561: 
                    562:        /*
                    563:        **  We return HT_ERROR to make sure that this is the last handler to be
                    564:        **  called. We do this as we don't want any other filter to delete the 
                    565:        **  request object now when we have just started a new one ourselves
                    566:        */
                    567:        return HT_ERROR;
                    568:     }
                    569:     return HT_OK;
                    570: }
                    571: 
                    572: /*
                    573: **     Request Loggin AFTER filter
                    574: **     ---------------------------
                    575: **     Default Logging filter using the log manager provided by HTLog.c
                    576: */
2.15    ! frystyk   577: PUBLIC int HTLogFilter (HTRequest * request, HTResponse * response,
        !           578:                        void * param, int status)
2.1       frystyk   579: {
                    580:     if (request) {
                    581:        if (HTLog_isOpen()) HTLog_add(request, status);
                    582:        return HT_OK;
                    583:     }
                    584:     return HT_ERROR;
                    585: }

Webmaster