X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=list.c;h=b98bf6c09c1e8d52dd7dc6ea4254fd39188440db;hp=0625e660f40a918b7dbfa7ed08c15f533bd7ba0c;hb=36b7381311cfb84104619fd8bead33aa3186081d;hpb=20b6fe1c584e105f529d0fc92c02d62c214a29d3 diff --git a/list.c b/list.c index 0625e660..b98bf6c0 100644 --- a/list.c +++ b/list.c @@ -1,4 +1,4 @@ -const char list_rcs[] = "$Id: list.c,v 1.9 2001/09/16 13:20:29 jongfoster Exp $"; +const char list_rcs[] = "$Id: list.c,v 1.19 2007/04/17 18:14:06 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/list.c,v $ @@ -7,14 +7,14 @@ const char list_rcs[] = "$Id: list.c,v 1.9 2001/09/16 13:20:29 jongfoster Exp $" * Functions declared include: * `destroy_list', `enlist' and `list_to_text' * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General * Public License as published by the Free Software * Foundation; either version 2 of the License, or (at @@ -34,6 +34,48 @@ const char list_rcs[] = "$Id: list.c,v 1.9 2001/09/16 13:20:29 jongfoster Exp $" * * Revisions : * $Log: list.c,v $ + * Revision 1.19 2007/04/17 18:14:06 fabiankeil + * Add list_contains_item(). + * + * Revision 1.18 2006/12/28 19:21:23 fabiankeil + * Fixed gcc43 warning and enabled list_is_valid()'s loop + * detection again. It was ineffective since the removal of + * the arbitrary list length limit two years ago. + * + * Revision 1.17 2006/07/18 14:48:46 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.15.2.2 2004/05/25 02:04:23 david__schmidt + * Removed the "arbitrary" 1000 filter limit in file.c. See tracker #911950. + * + * Revision 1.15.2.1 2002/11/28 18:14:54 oes + * Added unmap function that removes all items with a given + * name from a map. + * + * Revision 1.15 2002/03/26 22:29:55 swa + * we have a new homepage! + * + * Revision 1.14 2002/03/24 13:25:43 swa + * name change related issues + * + * Revision 1.13 2002/03/07 03:46:17 oes + * Fixed compiler warnings + * + * Revision 1.12 2001/10/25 03:40:48 david__schmidt + * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple + * threads to call select() simultaneously. So, it's time to do a real, live, + * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__ + * (native). Both versions will work, but using __OS2__ offers multi-threading. + * + * Revision 1.11 2001/10/23 21:21:03 jongfoster + * New error handling - error codes are now jb_errs, not ints. + * Changed the way map() handles out-of-memory, to dramatically + * reduce the amount of error-checking clutter needed. + * + * Revision 1.10 2001/09/16 17:30:24 jongfoster + * Fixing a compiler warning. + * * Revision 1.9 2001/09/16 13:20:29 jongfoster * Rewrite of list library. Now has seperate header and list_entry * structures. Also added a large sprinking of assert()s to the list @@ -102,7 +144,7 @@ const char list_rcs[] = "$Id: list.c,v 1.9 2001/09/16 13:20:29 jongfoster Exp $" #endif #include -#ifndef _WIN32 +#if !defined(_WIN32) && !defined(__OS2__) #include #endif @@ -120,15 +162,15 @@ static int list_is_valid (const struct list *the_list); /********************************************************************* * - * Function : list_init + * Function : init_list * * Description : Create a new, empty list in user-allocated memory. * Caller should allocate a "struct list" variable, * then pass it to this function. * (Implementation note: Rather than calling this * function, you can also just memset the memory to - * zero, e.g. if you have a larger structure you - * want to initialize quickly. However, that isn't + * zero, e.g. if you have a larger structure you + * want to initialize quickly. However, that isn't * really good design.) * * Parameters : @@ -154,9 +196,9 @@ void init_list(struct list *the_list) * calling list_init(). * * (Implementation note: You *can* reuse the_list - * without calling list_init(), but please don't. + * without calling list_init(), but please don't. * If you want to remove all entries from a list - * and still have a usable list, then use + * and still have a usable list, then use * list_remove_all().) * * Parameters : @@ -174,7 +216,7 @@ void destroy_list (struct list *the_list) for (cur_entry = the_list->first; cur_entry ; cur_entry = next_entry) { next_entry = cur_entry->next; - freez((char *)cur_entry->str); + freez(cur_entry->str); free(cur_entry); } @@ -190,7 +232,7 @@ void destroy_list (struct list *the_list) * Description : Check that a string list is valid. The intended * usage is "assert(list_is_valid(the_list))". * Currently this checks that "the_list->last" - * is correct, and that the list dosn't contain + * is correct, and that the list dosn't contain * circular references. It is likely to crash if * it's passed complete garbage. * @@ -209,7 +251,7 @@ static int list_is_valid (const struct list *the_list) #if 1 const struct list_entry *cur_entry; const struct list_entry *last_entry = NULL; - int length = 0; + int entry = 0; assert(the_list); @@ -220,27 +262,32 @@ static int list_is_valid (const struct list *the_list) if (cur_entry->str) { /* - * Just check that this string can be accessed - i.e. it's a valid + * Just check that this string can be accessed - i.e. it's a valid * pointer. */ - strlen(cur_entry->str); + (void)strlen(cur_entry->str); } /* * Check for looping back to first */ - if ((length != 0) && (cur_entry == the_list->first)) + if ((entry++ != 0) && (cur_entry == the_list->first)) { return 0; } /* - * Arbitrarily limit length to prevent infinite loops. - */ - if (++length > 1000) - { + * Arbitrarily limit list length to prevent infinite loops. + * Note that the 1000 limit was hit by a real user in tracker 911950; + * removing it for now. Real circular references should eventually + * be caught by the check above, anyway. + */ + /* + if (entry > 1000) + { return 0; - } + } + */ /* * Check this isn't marked as the last entry, unless of course it's @@ -269,11 +316,12 @@ static int list_is_valid (const struct list *the_list) * 1 : the_list = pointer to list * 2 : str = string to add to the list (maybe NULL) * - * Returns : 0 on success, nonzero on out-of-memory error. On - * error, the_list will be unchanged. + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * On error, the_list will be unchanged. * *********************************************************************/ -int enlist(struct list *the_list, const char *str) +jb_err enlist(struct list *the_list, const char *str) { struct list_entry *cur; @@ -282,7 +330,7 @@ int enlist(struct list *the_list, const char *str) if (NULL == (cur = (struct list_entry *)zalloc(sizeof(*cur)))) { - return 1; + return JB_ERR_MEMORY; } if (str) @@ -290,7 +338,7 @@ int enlist(struct list *the_list, const char *str) if (NULL == (cur->str = strdup(str))) { free(cur); - return 1; + return JB_ERR_MEMORY; } } /* else { cur->str = NULL; } - implied by zalloc */ @@ -309,7 +357,7 @@ int enlist(struct list *the_list, const char *str) } assert(list_is_valid(the_list)); - return 0; + return JB_ERR_OK; } @@ -324,11 +372,12 @@ int enlist(struct list *the_list, const char *str) * 1 : the_list = pointer to list * 2 : str = string to add to the list (maybe NULL) * - * Returns : 0 on success, nonzero on out-of-memory error. On - * error, the_list will be unchanged. + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * On error, the_list will be unchanged. * *********************************************************************/ -int enlist_first(struct list *the_list, const char *str) +jb_err enlist_first(struct list *the_list, const char *str) { struct list_entry *cur; @@ -337,7 +386,7 @@ int enlist_first(struct list *the_list, const char *str) if (NULL == (cur = (struct list_entry *)zalloc(sizeof(*cur)))) { - return 1; + return JB_ERR_MEMORY; } if (str) @@ -345,11 +394,11 @@ int enlist_first(struct list *the_list, const char *str) if (NULL == (cur->str = strdup(str))) { free(cur); - return 1; + return JB_ERR_MEMORY; } } /* else { cur->str = NULL; } - implied by zalloc */ - + cur->next = the_list->first; the_list->first = cur; @@ -359,7 +408,7 @@ int enlist_first(struct list *the_list, const char *str) } assert(list_is_valid(the_list)); - return 0; + return JB_ERR_OK; } @@ -370,7 +419,7 @@ int enlist_first(struct list *the_list, const char *str) * Description : Append a string into a specified string list, * if & only if it's not there already. * If the num_significant_chars argument is nonzero, - * only compare up to the nth character. + * only compare up to the nth character. * * Parameters : * 1 : the_list = pointer to list @@ -378,14 +427,15 @@ int enlist_first(struct list *the_list, const char *str) * 3 : num_significant_chars = number of chars to use * for uniqueness test, or 0 to require an exact match. * - * Returns : 0 on success, nonzero on out-of-memory error. On - * error, the_list will be unchanged. "Success" - * does not indicate whether or not the item was - * already in the list. + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * On error, the_list will be unchanged. + * "Success" does not indicate whether or not the + * item was already in the list. * *********************************************************************/ -int enlist_unique(struct list *the_list, const char *str, - int num_significant_chars) +jb_err enlist_unique(struct list *the_list, const char *str, + size_t num_significant_chars) { struct list_entry *cur_entry; @@ -393,7 +443,7 @@ int enlist_unique(struct list *the_list, const char *str, assert(list_is_valid(the_list)); assert(str); assert(num_significant_chars >= 0); - assert((size_t)num_significant_chars <= strlen(str)); + assert(num_significant_chars <= strlen(str)); if (num_significant_chars > 0) { @@ -403,7 +453,7 @@ int enlist_unique(struct list *the_list, const char *str, && (0 == strncmp(str, cur_entry->str, num_significant_chars))) { /* Already there */ - return 0; + return JB_ERR_OK; } } } @@ -415,7 +465,7 @@ int enlist_unique(struct list *the_list, const char *str, if ( (cur_entry->str != NULL) && (0 == strcmp(str, cur_entry->str))) { /* Already there */ - return 0; + return JB_ERR_OK; } } } @@ -437,40 +487,41 @@ int enlist_unique(struct list *the_list, const char *str, * 2 : name = HTTP header name (e.g. "Content-type") * 3 : value = HTTP header value (e.g. "text/html") * - * Returns : 0 on success, nonzero on out-of-memory error. On - * error, the_list will be unchanged. "Success" - * does not indicate whether or not the header was - * already in the list. + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * On error, the_list will be unchanged. + * "Success" does not indicate whether or not the + * header was already in the list. * *********************************************************************/ -int enlist_unique_header(struct list *the_list, const char *name, const char *value) +jb_err enlist_unique_header(struct list *the_list, const char *name, + const char *value) { - int length; - int result; - char *str; + jb_err result = JB_ERR_MEMORY; + char *header; + size_t header_size; assert(the_list); assert(list_is_valid(the_list)); assert(name); assert(value); - length = strlen(name) + 2; - if (NULL == (str = (char *)malloc(length + strlen(value) + 1))) - { - return 1; - } - strcpy(str, name); - str[length - 2] = ':'; - str[length - 1] = ' '; - strcpy(str + length, value); - - result = enlist_unique(the_list, str, length); + /* + 2 for the ': ', + 1 for the \0 */ + header_size = strlen(name) + 2 + strlen(value) + 1; + header = (char *)malloc(header_size); - free(str); + if (NULL != header) + { + const size_t bytes_to_compare = strlen(name) + 2; - assert(list_is_valid(the_list)); + snprintf(header, header_size, "%s: %s", name, value); + result = enlist_unique(the_list, header, bytes_to_compare); + free(header); + assert(list_is_valid(the_list)); + } return result; + } @@ -481,7 +532,7 @@ int enlist_unique_header(struct list *the_list, const char *name, const char *va * Description : Remove all entries from a list. On return, the_list * is a valid, empty list. Note that this is similar * to destroy_list(), but the difference is that this - * function guarantees that the list structure is still + * function guarantees that the list structure is still * valid after the call. * * Parameters : @@ -501,7 +552,7 @@ void list_remove_all(struct list *the_list) for (cur_entry = the_list->first; cur_entry ; cur_entry = next_entry) { next_entry = cur_entry->next; - freez((char *)cur_entry->str); + freez(cur_entry->str); free(cur_entry); } @@ -519,6 +570,9 @@ void list_remove_all(struct list *the_list) * adding an empty line at the end. NULL entries are ignored. * This function does not change the_list. * + * XXX: Should probably be renamed as it's only + * useful (and used) to flatten header lists. + * * Parameters : * 1 : the_list = pointer to list * @@ -529,42 +583,62 @@ void list_remove_all(struct list *the_list) char *list_to_text(const struct list *the_list) { struct list_entry *cur_entry; - char *ret = NULL; - char *s; - int size = 2; + char *text; + size_t text_length; + char *cursor; + size_t bytes_left; assert(the_list); assert(list_is_valid(the_list)); - for (cur_entry = the_list->first; cur_entry ; cur_entry = cur_entry->next) + /* + * Calculate the lenght of the final text. + * '2' because of the '\r\n' at the end of + * each string and at the end of the text. + */ + text_length = 2; + for (cur_entry = the_list->first; cur_entry; cur_entry = cur_entry->next) { if (cur_entry->str) { - size += strlen(cur_entry->str) + 2; + text_length += strlen(cur_entry->str) + 2; } } - if ((ret = (char *)malloc(size + 1)) == NULL) + bytes_left = text_length + 1; + + text = (char *)malloc(bytes_left); + if (NULL == text) { - return(NULL); + return NULL; } - ret[size] = '\0'; - - s = ret; + cursor = text; - for (cur_entry = the_list->first; cur_entry ; cur_entry = cur_entry->next) + for (cur_entry = the_list->first; cur_entry; cur_entry = cur_entry->next) { if (cur_entry->str) { - strcpy(s, cur_entry->str); - s += strlen(s); - *s++ = '\r'; *s++ = '\n'; + const int written = snprintf(cursor, bytes_left, "%s\r\n", cur_entry->str); + + assert(written > 0); + assert(written < bytes_left); + + bytes_left -= (size_t)written; + cursor += (size_t)written; } } - *s++ = '\r'; *s++ = '\n'; - return(ret); + assert(bytes_left == 3); + + *cursor++ = '\r'; + *cursor++ = '\n'; + *cursor = '\0'; + + assert(text_length == cursor - text); + assert(text[text_length] == '\0'); + + return text; } @@ -679,11 +753,12 @@ int list_remove_list(struct list *dest, const struct list *src) * All existing entries will be removed. * 1 : src = pointer to source list for copy. * - * Returns : 0 on success, nonzero on error. On error, dest - * will be empty. + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * On error, dest will be empty. * *********************************************************************/ -int list_duplicate(struct list *dest, const struct list *src) +jb_err list_duplicate(struct list *dest, const struct list *src) { struct list_entry * cur_src; struct list_entry * cur_dest; @@ -707,7 +782,7 @@ int list_duplicate(struct list *dest, const struct list *src) assert(list_is_valid(src)); assert(list_is_valid(dest)); - return 1; + return JB_ERR_MEMORY; } if (cur_src->str) @@ -720,7 +795,7 @@ int list_duplicate(struct list *dest, const struct list *src) assert(list_is_valid(src)); assert(list_is_valid(dest)); - return 1; + return JB_ERR_MEMORY; } } /* else { cur_dest->str = NULL; } - implied by zalloc */ @@ -736,7 +811,7 @@ int list_duplicate(struct list *dest, const struct list *src) assert(list_is_valid(src)); assert(list_is_valid(dest)); - return 1; + return JB_ERR_MEMORY; } if (cur_src->str) { @@ -748,7 +823,7 @@ int list_duplicate(struct list *dest, const struct list *src) assert(list_is_valid(src)); assert(list_is_valid(dest)); - return 1; + return JB_ERR_MEMORY; } } /* else { cur_dest->str = NULL; } - implied by zalloc */ @@ -760,7 +835,7 @@ int list_duplicate(struct list *dest, const struct list *src) assert(list_is_valid(src)); assert(list_is_valid(dest)); - return 0; + return JB_ERR_OK; } @@ -775,12 +850,13 @@ int list_duplicate(struct list *dest, const struct list *src) * 1 : dest = pointer to destination list for merge. * 2 : src = pointer to source for merge. * - * Returns : 0 on success, nonzero on out-of-memory error. + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * On error, some (but not all) of src might have * been copied into dest. * *********************************************************************/ -int list_append_list_unique(struct list *dest, const struct list *src) +jb_err list_append_list_unique(struct list *dest, const struct list *src) { struct list_entry * cur; @@ -798,7 +874,7 @@ int list_append_list_unique(struct list *dest, const struct list *src) assert(list_is_valid(src)); assert(list_is_valid(dest)); - return 1; + return JB_ERR_MEMORY; } } } @@ -806,7 +882,7 @@ int list_append_list_unique(struct list *dest, const struct list *src) assert(list_is_valid(src)); assert(list_is_valid(dest)); - return 0; + return JB_ERR_OK; } @@ -819,18 +895,64 @@ int list_append_list_unique(struct list *dest, const struct list *src) * Parameters : * 1 : the_list = pointer to list to test. * - * Returns : Nonzero iff the list contains no entries. + * Returns : Nonzero if the list contains no entries. * *********************************************************************/ int list_is_empty(const struct list *the_list) { assert(the_list); assert(list_is_valid(the_list)); - + return (the_list->first == NULL); } +/********************************************************************* + * + * Function : list_contains_item + * + * Description : Tests whether a list item is already set. + * Does not change the list. + * + * Parameters : + * 1 : the_list = list to search in + * 2 : str = string to search for + * + * Returns : TRUE if the item was found, + * FALSE otherwise. + * + *********************************************************************/ +int list_contains_item(const struct list *the_list, const char *str) +{ + struct list_entry *entry; + + assert(the_list); + assert(list_is_valid(the_list)); + assert(str); + + for (entry = the_list->first; entry != NULL; entry = entry->next) + { + if (entry->str == NULL) + { + /* + * NULL pointers are allowed in some lists. + * For example for csp->headers in case a + * header was removed. + */ + continue; + } + + if (0 == strcmp(str, entry->str)) + { + /* Item found */ + return TRUE; + } + } + + return FALSE; +} + + /********************************************************************* * * Function : new_map @@ -871,10 +993,10 @@ void free_map(struct map *the_map) return; } - for (cur_entry = the_map->first; cur_entry != NULL; cur_entry = next_entry) + for (cur_entry = the_map->first; cur_entry != NULL; cur_entry = next_entry) { - freez((char *)cur_entry->name); - freez((char *)cur_entry->value); + freez(cur_entry->name); + freez(cur_entry->value); next_entry = cur_entry->next; free(cur_entry); @@ -897,6 +1019,27 @@ void free_map(struct map *the_map) * later, set the copy flags for constants or * strings that will be independantly free()d. * + * Note2: This function allows NULL parameters - it + * returns JB_ERR_MEMORY in that case. + * + * Note3: If this function returns JB_ERR_MEMORY, + * it will free(name) unless you specify + * name_needs_copying, and similarly it will + * free(value) unless you specify + * value_needs_copying. + * + * Due to Note2 and Note3 above, the following code + * is legal, and will never crash or leak memory even + * if the system runs out of memory: + * + * err = map(mymap, "xyz", 1, html_encode(somestring), 0); + * + * err will be set to JB_ERR_MEMORY if either call runs + * out-of-memory. Without these features, you would + * need to check the return value of html_encode in the + * above example for NULL, which (at least) doubles the + * amount of error-checking code needed. + * * Parameters : * 1 : the_map = map to add to * 2 : name = name to add @@ -904,22 +1047,31 @@ void free_map(struct map *the_map) * 4 : value = value to add * 5 : value_needs_copying = flag set if a copy of value should be used * - * Returns : 0 on success, nonzero on out-of-memory error. + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -int map(struct map *the_map, - const char *name, int name_needs_copying, - const char *value, int value_needs_copying) +jb_err map(struct map *the_map, + const char *name, int name_needs_copying, + const char *value, int value_needs_copying) { struct map_entry *new_entry; assert(the_map); - assert(name); - assert(value); - if (NULL == (new_entry = zalloc(sizeof(*new_entry)))) + if ( (NULL == value) + || (NULL == name) + || (NULL == (new_entry = zalloc(sizeof(*new_entry)))) ) { - return 1; + if ((name != NULL) && (!name_needs_copying)) + { + free((char *)name); + } + if ((value != NULL) && (!value_needs_copying)) + { + free((char *)value); + } + return JB_ERR_MEMORY; } if (name_needs_copying) @@ -927,7 +1079,11 @@ int map(struct map *the_map, if (NULL == (name = strdup(name))) { free(new_entry); - return 1; + if (!value_needs_copying) + { + free((char *)value); + } + return JB_ERR_MEMORY; } } @@ -935,12 +1091,9 @@ int map(struct map *the_map, { if (NULL == (value = strdup(value))) { - if (name_needs_copying) - { - free((char *)name); - } + free((char *)name); free(new_entry); - return 1; + return JB_ERR_MEMORY; } } @@ -959,7 +1112,72 @@ int map(struct map *the_map, the_map->last = new_entry; } - return 0; + return JB_ERR_OK; +} + + +/********************************************************************* + * + * Function : unmap + * + * Description : Remove all map_entry structs with a given name from + * a given map. + * + * Parameters : + * 1 : the_map = map to look in + * 2 : name = name to unmap + * + * Returns : JB_ERR_OK + * + *********************************************************************/ +jb_err unmap(struct map *the_map, const char *name) +{ + struct map_entry *cur_entry, *last_entry; + + assert(the_map); + assert(name); + + last_entry = the_map->first; + + for (cur_entry = the_map->first; cur_entry != NULL; cur_entry = cur_entry->next) + { + if (!strcmp(name, cur_entry->name)) + { + /* + * Update the incoming pointer + */ + if (cur_entry == the_map->first) + { + the_map->first = cur_entry->next; + } + else + { + last_entry->next = cur_entry->next; + } + + /* + * Update the map's last pointer + */ + if (cur_entry == the_map->last) + { + the_map->last = last_entry; + } + + /* + * Free the map_entry + */ + freez(cur_entry->name); + freez(cur_entry->value); + freez(cur_entry); + + cur_entry = last_entry; + } + else + { + last_entry = cur_entry; + } + } + return JB_ERR_OK; }