1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990 |
- /*********************************************************************
- *
- * File : $Source: /cvsroot/ijbswa/current/actions.c,v $
- *
- * Purpose : Declares functions to work with actions files
- *
- * Copyright : Written by and Copyright (C) 2001-2016 the
- * Privoxy team. https://www.privoxy.org/
- *
- * Based on the Internet Junkbuster originally written
- * by and Copyright (C) 1997 Anonymous Coders and
- * Junkbusters Corporation. http://www.junkbusters.com
- *
- * 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
- * your option) any later version.
- *
- * This program is distributed in the hope that it will
- * be useful, but WITHOUT ANY WARRANTY; without even the
- * implied warranty of MERCHANTABILITY or FITNESS FOR A
- * PARTICULAR PURPOSE. See the GNU General Public
- * License for more details.
- *
- * The GNU General Public License should be included with
- * this file. If not, you can view it at
- * http://www.gnu.org/copyleft/gpl.html
- * or write to the Free Software Foundation, Inc., 59
- * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- *********************************************************************/
- #include "config.h"
- #include <stdio.h>
- #include <string.h>
- #include <assert.h>
- #include <stdlib.h>
- #ifdef FEATURE_PTHREAD
- #include <pthread.h>
- #endif
- #include "project.h"
- #include "jcc.h"
- #include "list.h"
- #include "actions.h"
- #include "miscutil.h"
- #include "errlog.h"
- #include "loaders.h"
- #include "encode.h"
- #include "urlmatch.h"
- #include "cgi.h"
- #include "ssplit.h"
- #include "filters.h"
- /*
- * We need the main list of options.
- *
- * First, we need a way to tell between boolean, string, and multi-string
- * options. For string and multistring options, we also need to be
- * able to tell the difference between a "+" and a "-". (For bools,
- * the "+"/"-" information is encoded in "add" and "mask"). So we use
- * an enumerated type (well, the preprocessor equivalent). Here are
- * the values:
- */
- enum action_value_type {
- AV_NONE = 0, /* +opt -opt */
- AV_ADD_STRING = 1, /* +stropt{string} */
- AV_REM_STRING = 2, /* -stropt */
- AV_ADD_MULTI = 3, /* +multiopt{string} +multiopt{string2} */
- AV_REM_MULTI = 4 /* -multiopt{string} -multiopt */
- };
- /*
- * We need a structure to hold the name, flag changes,
- * type, and string index.
- */
- struct action_name
- {
- const char * name;
- unsigned long mask; /* a bit set to "0" = remove action */
- unsigned long add; /* a bit set to "1" = add action */
- enum action_value_type value_type; /* an AV_... constant */
- int index; /* index into strings[] or multi[] */
- };
- /*
- * And with those building blocks in place, here's the array.
- */
- static const struct action_name action_names[] =
- {
- /*
- * Well actually there's no data here - it's in actionlist.h
- * This keeps it together to make it easy to change.
- *
- * Here's the macros used to format it:
- */
- #define DEFINE_ACTION_MULTI(name,index) \
- { "+" name, ACTION_MASK_ALL, 0, AV_ADD_MULTI, index }, \
- { "-" name, ACTION_MASK_ALL, 0, AV_REM_MULTI, index },
- #define DEFINE_ACTION_STRING(name,flag,index) \
- { "+" name, ACTION_MASK_ALL, flag, AV_ADD_STRING, index }, \
- { "-" name, ~flag, 0, AV_REM_STRING, index },
- #define DEFINE_ACTION_BOOL(name,flag) \
- { "+" name, ACTION_MASK_ALL, flag }, \
- { "-" name, ~flag, 0 },
- #define DEFINE_ACTION_ALIAS 1 /* Want aliases please */
- #include "actionlist.h"
- #undef DEFINE_ACTION_MULTI
- #undef DEFINE_ACTION_STRING
- #undef DEFINE_ACTION_BOOL
- #undef DEFINE_ACTION_ALIAS
- { NULL, 0, 0 } /* End marker */
- };
- #ifndef FUZZ
- static
- #endif
- int load_one_actions_file(struct client_state *csp, int fileid);
- /*********************************************************************
- *
- * Function : merge_actions
- *
- * Description : Merge two actions together.
- * Similar to "dest += src".
- *
- * Parameters :
- * 1 : dest = Actions to modify.
- * 2 : src = Action to add.
- *
- * Returns : JB_ERR_OK or JB_ERR_MEMORY
- *
- *********************************************************************/
- jb_err merge_actions (struct action_spec *dest,
- const struct action_spec *src)
- {
- int i;
- jb_err err;
- dest->mask &= src->mask;
- dest->add &= src->mask;
- dest->add |= src->add;
- for (i = 0; i < ACTION_STRING_COUNT; i++)
- {
- char * str = src->string[i];
- if (str)
- {
- freez(dest->string[i]);
- dest->string[i] = strdup_or_die(str);
- }
- }
- for (i = 0; i < ACTION_MULTI_COUNT; i++)
- {
- if (src->multi_remove_all[i])
- {
- /* Remove everything from dest */
- list_remove_all(dest->multi_remove[i]);
- dest->multi_remove_all[i] = 1;
- err = list_duplicate(dest->multi_add[i], src->multi_add[i]);
- }
- else if (dest->multi_remove_all[i])
- {
- /*
- * dest already removes everything, so we only need to worry
- * about what we add.
- */
- list_remove_list(dest->multi_add[i], src->multi_remove[i]);
- err = list_append_list_unique(dest->multi_add[i], src->multi_add[i]);
- }
- else
- {
- /* No "remove all"s to worry about. */
- list_remove_list(dest->multi_add[i], src->multi_remove[i]);
- err = list_append_list_unique(dest->multi_remove[i], src->multi_remove[i]);
- if (!err) err = list_append_list_unique(dest->multi_add[i], src->multi_add[i]);
- }
- if (err)
- {
- return err;
- }
- }
- return JB_ERR_OK;
- }
- /*********************************************************************
- *
- * Function : copy_action
- *
- * Description : Copy an action_specs.
- * Similar to "dest = src".
- *
- * Parameters :
- * 1 : dest = Destination of copy.
- * 2 : src = Source for copy.
- *
- * Returns : JB_ERR_OK or JB_ERR_MEMORY
- *
- *********************************************************************/
- jb_err copy_action (struct action_spec *dest,
- const struct action_spec *src)
- {
- int i;
- jb_err err = JB_ERR_OK;
- free_action(dest);
- memset(dest, '\0', sizeof(*dest));
- dest->mask = src->mask;
- dest->add = src->add;
- for (i = 0; i < ACTION_STRING_COUNT; i++)
- {
- char * str = src->string[i];
- if (str)
- {
- str = strdup_or_die(str);
- dest->string[i] = str;
- }
- }
- for (i = 0; i < ACTION_MULTI_COUNT; i++)
- {
- dest->multi_remove_all[i] = src->multi_remove_all[i];
- err = list_duplicate(dest->multi_remove[i], src->multi_remove[i]);
- if (err)
- {
- return err;
- }
- err = list_duplicate(dest->multi_add[i], src->multi_add[i]);
- if (err)
- {
- return err;
- }
- }
- return err;
- }
- /*********************************************************************
- *
- * Function : free_action_spec
- *
- * Description : Frees an action_spec and the memory used by it.
- *
- * Parameters :
- * 1 : src = Source to free.
- *
- * Returns : N/A
- *
- *********************************************************************/
- void free_action_spec(struct action_spec *src)
- {
- free_action(src);
- freez(src);
- }
- /*********************************************************************
- *
- * Function : free_action
- *
- * Description : Destroy an action_spec. Frees memory used by it,
- * except for the memory used by the struct action_spec
- * itself.
- *
- * Parameters :
- * 1 : src = Source to free.
- *
- * Returns : N/A
- *
- *********************************************************************/
- void free_action (struct action_spec *src)
- {
- int i;
- if (src == NULL)
- {
- return;
- }
- for (i = 0; i < ACTION_STRING_COUNT; i++)
- {
- freez(src->string[i]);
- }
- for (i = 0; i < ACTION_MULTI_COUNT; i++)
- {
- destroy_list(src->multi_remove[i]);
- destroy_list(src->multi_add[i]);
- }
- memset(src, '\0', sizeof(*src));
- }
- /*********************************************************************
- *
- * Function : get_action_token
- *
- * Description : Parses a line for the first action.
- * Modifies its input array, doesn't allocate memory.
- * e.g. given:
- * *line=" +abc{def} -ghi "
- * Returns:
- * *line=" -ghi "
- * *name="+abc"
- * *value="def"
- *
- * Parameters :
- * 1 : line = [in] The line containing the action.
- * [out] Start of next action on line, or
- * NULL if we reached the end of line before
- * we found an action.
- * 2 : name = [out] Start of action name, null
- * terminated. NULL on EOL
- * 3 : value = [out] Start of action value, null
- * terminated. NULL if none or EOL.
- *
- * Returns : JB_ERR_OK => Ok
- * JB_ERR_PARSE => Mismatched {} (line was trashed anyway)
- *
- *********************************************************************/
- jb_err get_action_token(char **line, char **name, char **value)
- {
- char * str = *line;
- char ch;
- /* set default returns */
- *line = NULL;
- *name = NULL;
- *value = NULL;
- /* Eat any leading whitespace */
- while ((*str == ' ') || (*str == '\t'))
- {
- str++;
- }
- if (*str == '\0')
- {
- return 0;
- }
- if (*str == '{')
- {
- /* null name, just value is prohibited */
- return JB_ERR_PARSE;
- }
- *name = str;
- /* parse option */
- while (((ch = *str) != '\0') &&
- (ch != ' ') && (ch != '\t') && (ch != '{'))
- {
- if (ch == '}')
- {
- /* error, '}' without '{' */
- return JB_ERR_PARSE;
- }
- str++;
- }
- *str = '\0';
- if (ch != '{')
- {
- /* no value */
- if (ch == '\0')
- {
- /* EOL - be careful not to run off buffer */
- *line = str;
- }
- else
- {
- /* More to parse next time. */
- *line = str + 1;
- }
- return JB_ERR_OK;
- }
- str++;
- *value = str;
- /* The value ends with the first non-escaped closing curly brace */
- while ((str = strchr(str, '}')) != NULL)
- {
- if (str[-1] == '\\')
- {
- /* Overwrite the '\' so the action doesn't see it. */
- string_move(str-1, str);
- continue;
- }
- break;
- }
- if (str == NULL)
- {
- /* error */
- *value = NULL;
- return JB_ERR_PARSE;
- }
- /* got value */
- *str = '\0';
- *line = str + 1;
- chomp(*value);
- return JB_ERR_OK;
- }
- /*********************************************************************
- *
- * Function : action_used_to_be_valid
- *
- * Description : Checks if unrecognized actions were valid in earlier
- * releases.
- *
- * Parameters :
- * 1 : action = The string containing the action to check.
- *
- * Returns : True if yes, otherwise false.
- *
- *********************************************************************/
- static int action_used_to_be_valid(const char *action)
- {
- static const char * const formerly_valid_actions[] = {
- "inspect-jpegs",
- "kill-popups",
- "send-vanilla-wafer",
- "send-wafer",
- "treat-forbidden-connects-like-blocks",
- "vanilla-wafer",
- "wafer"
- };
- unsigned int i;
- for (i = 0; i < SZ(formerly_valid_actions); i++)
- {
- if (0 == strcmpic(action, formerly_valid_actions[i]))
- {
- return TRUE;
- }
- }
- return FALSE;
- }
- /*********************************************************************
- *
- * Function : get_actions
- *
- * Description : Parses a list of actions.
- *
- * Parameters :
- * 1 : line = The string containing the actions.
- * Will be written to by this function.
- * 2 : alias_list = Custom alias list, or NULL for none.
- * 3 : cur_action = Where to store the action. Caller
- * allocates memory.
- *
- * Returns : JB_ERR_OK => Ok
- * JB_ERR_PARSE => Parse error (line was trashed anyway)
- * nonzero => Out of memory (line was trashed anyway)
- *
- *********************************************************************/
- jb_err get_actions(char *line,
- struct action_alias * alias_list,
- struct action_spec *cur_action)
- {
- jb_err err;
- init_action(cur_action);
- cur_action->mask = ACTION_MASK_ALL;
- while (line)
- {
- char * option = NULL;
- char * value = NULL;
- err = get_action_token(&line, &option, &value);
- if (err)
- {
- return err;
- }
- if (option)
- {
- /* handle option in 'option' */
- /* Check for standard action name */
- const struct action_name * action = action_names;
- while ((action->name != NULL) && (0 != strcmpic(action->name, option)))
- {
- action++;
- }
- if (action->name != NULL)
- {
- /* Found it */
- cur_action->mask &= action->mask;
- cur_action->add &= action->mask;
- cur_action->add |= action->add;
- switch (action->value_type)
- {
- case AV_NONE:
- if (value != NULL)
- {
- log_error(LOG_LEVEL_ERROR,
- "Action %s does not take parameters but %s was given.",
- action->name, value);
- return JB_ERR_PARSE;
- }
- break;
- case AV_ADD_STRING:
- {
- /* add single string. */
- if ((value == NULL) || (*value == '\0'))
- {
- if (0 == strcmpic(action->name, "+block"))
- {
- /*
- * XXX: Temporary backwards compatibility hack.
- * XXX: should include line number.
- */
- value = "No reason specified.";
- log_error(LOG_LEVEL_ERROR,
- "block action without reason found. This may "
- "become a fatal error in future versions.");
- }
- else
- {
- return JB_ERR_PARSE;
- }
- }
- #ifdef FEATURE_EXTENDED_STATISTICS
- if (0 == strcmpic(action->name, "+block"))
- {
- register_block_reason_for_statistics(value);
- }
- #endif
- /* FIXME: should validate option string here */
- freez (cur_action->string[action->index]);
- cur_action->string[action->index] = strdup(value);
- if (NULL == cur_action->string[action->index])
- {
- return JB_ERR_MEMORY;
- }
- break;
- }
- case AV_REM_STRING:
- {
- /* remove single string. */
- freez (cur_action->string[action->index]);
- break;
- }
- case AV_ADD_MULTI:
- {
- /* append multi string. */
- struct list * remove_p = cur_action->multi_remove[action->index];
- struct list * add_p = cur_action->multi_add[action->index];
- if ((value == NULL) || (*value == '\0'))
- {
- return JB_ERR_PARSE;
- }
- list_remove_item(remove_p, value);
- err = enlist_unique(add_p, value, 0);
- if (err)
- {
- return err;
- }
- break;
- }
- case AV_REM_MULTI:
- {
- /* remove multi string. */
- struct list * remove_p = cur_action->multi_remove[action->index];
- struct list * add_p = cur_action->multi_add[action->index];
- if ((value == NULL) || (*value == '\0')
- || ((*value == '*') && (value[1] == '\0')))
- {
- /*
- * no option, or option == "*".
- *
- * Remove *ALL*.
- */
- list_remove_all(remove_p);
- list_remove_all(add_p);
- cur_action->multi_remove_all[action->index] = 1;
- }
- else
- {
- /* Valid option - remove only 1 option */
- if (!cur_action->multi_remove_all[action->index])
- {
- /* there isn't a catch-all in the remove list already */
- err = enlist_unique(remove_p, value, 0);
- if (err)
- {
- return err;
- }
- }
- list_remove_item(add_p, value);
- }
- break;
- }
- default:
- /* Shouldn't get here unless there's memory corruption. */
- assert(0);
- return JB_ERR_PARSE;
- }
- }
- else
- {
- /* try user aliases. */
- const struct action_alias * alias = alias_list;
- while ((alias != NULL) && (0 != strcmpic(alias->name, option)))
- {
- alias = alias->next;
- }
- if (alias != NULL)
- {
- /* Found it */
- merge_actions(cur_action, alias->action);
- }
- else if (((size_t)2 < strlen(option)) && action_used_to_be_valid(option+1))
- {
- log_error(LOG_LEVEL_ERROR, "Action '%s' is no longer valid "
- "in this Privoxy release. Ignored.", option+1);
- }
- else if (((size_t)2 < strlen(option)) && 0 == strcmpic(option+1, "hide-forwarded-for-headers"))
- {
- log_error(LOG_LEVEL_FATAL, "The action 'hide-forwarded-for-headers' "
- "is no longer valid in this Privoxy release. "
- "Use 'change-x-forwarded-for' instead.");
- }
- else
- {
- /* Bad action name */
- /*
- * XXX: This is a fatal error and Privoxy will later on exit
- * in load_one_actions_file() because of an "invalid line".
- *
- * It would be preferable to name the offending option in that
- * error message, but currently there is no way to do that and
- * we have to live with two error messages for basically the
- * same reason.
- */
- log_error(LOG_LEVEL_ERROR, "Unknown action or alias: %s", option);
- return JB_ERR_PARSE;
- }
- }
- }
- }
- return JB_ERR_OK;
- }
- /*********************************************************************
- *
- * Function : init_current_action
- *
- * Description : Zero out an action.
- *
- * Parameters :
- * 1 : dest = An uninitialized current_action_spec.
- *
- * Returns : N/A
- *
- *********************************************************************/
- void init_current_action (struct current_action_spec *dest)
- {
- memset(dest, '\0', sizeof(*dest));
- dest->flags = ACTION_MOST_COMPATIBLE;
- }
- /*********************************************************************
- *
- * Function : init_action
- *
- * Description : Zero out an action.
- *
- * Parameters :
- * 1 : dest = An uninitialized action_spec.
- *
- * Returns : N/A
- *
- *********************************************************************/
- void init_action (struct action_spec *dest)
- {
- memset(dest, '\0', sizeof(*dest));
- }
- /*********************************************************************
- *
- * Function : merge_current_action
- *
- * Description : Merge two actions together.
- * Similar to "dest += src".
- * Differences between this and merge_actions()
- * is that this one doesn't allocate memory for
- * strings (so "src" better be in memory for at least
- * as long as "dest" is, and you'd better free
- * "dest" using "free_current_action").
- * Also, there is no mask or remove lists in dest.
- * (If we're applying it to a URL, we don't need them)
- *
- * Parameters :
- * 1 : dest = Current actions, to modify.
- * 2 : src = Action to add.
- *
- * Returns 0 : no error
- * !=0 : error, probably JB_ERR_MEMORY.
- *
- *********************************************************************/
- jb_err merge_current_action (struct current_action_spec *dest,
- const struct action_spec *src)
- {
- int i;
- jb_err err = JB_ERR_OK;
- dest->flags &= src->mask;
- dest->flags |= src->add;
- for (i = 0; i < ACTION_STRING_COUNT; i++)
- {
- char * str = src->string[i];
- if (str)
- {
- str = strdup_or_die(str);
- freez(dest->string[i]);
- dest->string[i] = str;
- }
- }
- for (i = 0; i < ACTION_MULTI_COUNT; i++)
- {
- if (src->multi_remove_all[i])
- {
- /* Remove everything from dest, then add src->multi_add */
- err = list_duplicate(dest->multi[i], src->multi_add[i]);
- if (err)
- {
- return err;
- }
- }
- else
- {
- list_remove_list(dest->multi[i], src->multi_remove[i]);
- err = list_append_list_unique(dest->multi[i], src->multi_add[i]);
- if (err)
- {
- return err;
- }
- }
- }
- return err;
- }
- /*********************************************************************
- *
- * Function : update_action_bits_for_tag
- *
- * Description : Updates the action bits based on the action sections
- * whose tag patterns match a provided tag.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : tag = The tag on which the update should be based on
- *
- * Returns : 0 if no tag matched, or
- * 1 otherwise
- *
- *********************************************************************/
- int update_action_bits_for_tag(struct client_state *csp, const char *tag)
- {
- struct file_list *fl;
- struct url_actions *b;
- int updated = 0;
- int i;
- assert(tag);
- assert(list_contains_item(csp->tags, tag));
- /* Run through all action files, */
- for (i = 0; i < MAX_AF_FILES; i++)
- {
- if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
- {
- /* Skip empty files */
- continue;
- }
- /* and through all the action patterns, */
- for (b = b->next; NULL != b; b = b->next)
- {
- /* skip everything but TAG patterns, */
- if (!(b->url->flags & PATTERN_SPEC_TAG_PATTERN))
- {
- continue;
- }
- /* and check if one of the tag patterns matches the tag, */
- if (0 == regexec(b->url->pattern.tag_regex, tag, 0, NULL, 0))
- {
- /* if it does, update the action bit map, */
- if (merge_current_action(csp->action, b->action))
- {
- log_error(LOG_LEVEL_ERROR,
- "Out of memory while changing action bits");
- }
- /* and signal the change. */
- updated = 1;
- }
- }
- }
- return updated;
- }
- /*********************************************************************
- *
- * Function : check_negative_tag_patterns
- *
- * Description : Updates the action bits based on NO-*-TAG patterns.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : flag = The tag pattern type
- *
- * Returns : JB_ERR_OK in case off success, or
- * JB_ERR_MEMORY on out-of-memory error.
- *
- *********************************************************************/
- jb_err check_negative_tag_patterns(struct client_state *csp, unsigned int flag)
- {
- struct list_entry *tag;
- struct file_list *fl;
- struct url_actions *b = NULL;
- int i;
- for (i = 0; i < MAX_AF_FILES; i++)
- {
- fl = csp->actions_list[i];
- if ((fl == NULL) || ((b = fl->f) == NULL))
- {
- continue;
- }
- for (b = b->next; NULL != b; b = b->next)
- {
- int tag_found = 0;
- if (0 == (b->url->flags & flag))
- {
- continue;
- }
- for (tag = csp->tags->first; NULL != tag; tag = tag->next)
- {
- if (0 == regexec(b->url->pattern.tag_regex, tag->str, 0, NULL, 0))
- {
- /*
- * The pattern matches at least one tag, thus the action
- * section doesn't apply and we don't need to look at the
- * other tags.
- */
- tag_found = 1;
- break;
- }
- }
- if (!tag_found)
- {
- /*
- * The pattern doesn't match any tags,
- * thus the action section applies.
- */
- if (merge_current_action(csp->action, b->action))
- {
- log_error(LOG_LEVEL_ERROR,
- "Out of memory while changing action bits");
- return JB_ERR_MEMORY;
- }
- log_error(LOG_LEVEL_HEADER, "Updated action bits based on: %s",
- b->url->spec);
- }
- }
- }
- return JB_ERR_OK;
- }
- /*********************************************************************
- *
- * Function : free_current_action
- *
- * Description : Free memory used by a current_action_spec.
- * Does not free the current_action_spec itself.
- *
- * Parameters :
- * 1 : src = Source to free.
- *
- * Returns : N/A
- *
- *********************************************************************/
- void free_current_action(struct current_action_spec *src)
- {
- int i;
- for (i = 0; i < ACTION_STRING_COUNT; i++)
- {
- freez(src->string[i]);
- }
- for (i = 0; i < ACTION_MULTI_COUNT; i++)
- {
- destroy_list(src->multi[i]);
- }
- memset(src, '\0', sizeof(*src));
- }
- static struct file_list *current_actions_file[MAX_AF_FILES] = {
- NULL, NULL, NULL, NULL, NULL,
- NULL, NULL, NULL, NULL, NULL
- };
- #ifdef FEATURE_GRACEFUL_TERMINATION
- /*********************************************************************
- *
- * Function : unload_current_actions_file
- *
- * Description : Unloads current actions file - reset to state at
- * beginning of program.
- *
- * Parameters : None
- *
- * Returns : N/A
- *
- *********************************************************************/
- void unload_current_actions_file(void)
- {
- int i;
- for (i = 0; i < MAX_AF_FILES; i++)
- {
- if (current_actions_file[i])
- {
- current_actions_file[i]->unloader = unload_actions_file;
- current_actions_file[i] = NULL;
- }
- }
- }
- #endif /* FEATURE_GRACEFUL_TERMINATION */
- /*********************************************************************
- *
- * Function : unload_actions_file
- *
- * Description : Unloads an actions module.
- *
- * Parameters :
- * 1 : file_data = the data structure associated with the
- * actions file.
- *
- * Returns : N/A
- *
- *********************************************************************/
- void unload_actions_file(void *file_data)
- {
- struct url_actions * next;
- struct url_actions * cur = (struct url_actions *)file_data;
- while (cur != NULL)
- {
- next = cur->next;
- free_pattern_spec(cur->url);
- if ((next == NULL) || (next->action != cur->action))
- {
- /*
- * As the action settings might be shared,
- * we can only free them if the current
- * url pattern is the last one, or if the
- * next one is using different settings.
- */
- free_action_spec(cur->action);
- }
- freez(cur);
- cur = next;
- }
- }
- /*********************************************************************
- *
- * Function : free_alias_list
- *
- * Description : Free memory used by a list of aliases.
- *
- * Parameters :
- * 1 : alias_list = Linked list to free.
- *
- * Returns : N/A
- *
- *********************************************************************/
- void free_alias_list(struct action_alias *alias_list)
- {
- while (alias_list != NULL)
- {
- struct action_alias * next = alias_list->next;
- alias_list->next = NULL;
- freez(alias_list->name);
- free_action(alias_list->action);
- free(alias_list);
- alias_list = next;
- }
- }
- /*********************************************************************
- *
- * Function : load_action_files
- *
- * Description : Read and parse all the action files and add to files
- * list.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- *
- * Returns : 0 => Ok, everything else is an error.
- *
- *********************************************************************/
- int load_action_files(struct client_state *csp)
- {
- int i;
- int result;
- for (i = 0; i < MAX_AF_FILES; i++)
- {
- if (csp->config->actions_file[i])
- {
- result = load_one_actions_file(csp, i);
- if (result)
- {
- return result;
- }
- }
- else if (current_actions_file[i])
- {
- current_actions_file[i]->unloader = unload_actions_file;
- current_actions_file[i] = NULL;
- }
- }
- return 0;
- }
- /*********************************************************************
- *
- * Function : filter_type_to_string
- *
- * Description : Converts a filter type enum into a string.
- *
- * Parameters :
- * 1 : filter_type = filter_type as enum
- *
- * Returns : Pointer to static string.
- *
- *********************************************************************/
- static const char *filter_type_to_string(enum filter_type filter_type)
- {
- switch (filter_type)
- {
- case FT_CONTENT_FILTER:
- return "content filter";
- case FT_CLIENT_HEADER_FILTER:
- return "client-header filter";
- case FT_SERVER_HEADER_FILTER:
- return "server-header filter";
- case FT_CLIENT_HEADER_TAGGER:
- return "client-header tagger";
- case FT_SERVER_HEADER_TAGGER:
- return "server-header tagger";
- #ifdef FEATURE_EXTERNAL_FILTERS
- case FT_EXTERNAL_CONTENT_FILTER:
- return "external content filter";
- #endif
- case FT_INVALID_FILTER:
- return "invalid filter type";
- }
- return "unknown filter type";
- }
- /*********************************************************************
- *
- * Function : referenced_filters_are_missing
- *
- * Description : Checks if any filters of a certain type referenced
- * in an action spec are missing.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : cur_action = The action spec to check.
- * 3 : multi_index = The index where to look for the filter.
- * 4 : filter_type = The filter type the caller is interested in.
- *
- * Returns : 0 => All referenced filters exist, everything else is an error.
- *
- *********************************************************************/
- static int referenced_filters_are_missing(const struct client_state *csp,
- const struct action_spec *cur_action, int multi_index, enum filter_type filter_type)
- {
- struct list_entry *filtername;
- for (filtername = cur_action->multi_add[multi_index]->first;
- filtername; filtername = filtername->next)
- {
- if (NULL == get_filter(csp, filtername->str, filter_type))
- {
- log_error(LOG_LEVEL_ERROR, "Missing %s '%s'",
- filter_type_to_string(filter_type), filtername->str);
- return 1;
- }
- }
- return 0;
- }
- /*********************************************************************
- *
- * Function : action_spec_is_valid
- *
- * Description : Should eventually figure out if an action spec
- * is valid, but currently only checks that the
- * referenced filters are accounted for.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : cur_action = The action spec to check.
- *
- * Returns : 0 => No problems detected, everything else is an error.
- *
- *********************************************************************/
- static int action_spec_is_valid(struct client_state *csp, const struct action_spec *cur_action)
- {
- struct {
- int multi_index;
- enum filter_type filter_type;
- } filter_map[] = {
- {ACTION_MULTI_FILTER, FT_CONTENT_FILTER},
- {ACTION_MULTI_CLIENT_HEADER_FILTER, FT_CLIENT_HEADER_FILTER},
- {ACTION_MULTI_SERVER_HEADER_FILTER, FT_SERVER_HEADER_FILTER},
- {ACTION_MULTI_CLIENT_HEADER_TAGGER, FT_CLIENT_HEADER_TAGGER},
- {ACTION_MULTI_SERVER_HEADER_TAGGER, FT_SERVER_HEADER_TAGGER}
- };
- int errors = 0;
- int i;
- for (i = 0; i < SZ(filter_map); i++)
- {
- errors += referenced_filters_are_missing(csp, cur_action,
- filter_map[i].multi_index, filter_map[i].filter_type);
- }
- return errors;
- }
- /*********************************************************************
- *
- * Function : load_one_actions_file
- *
- * Description : Read and parse a action file and add to files
- * list.
- *
- * Parameters :
- * 1 : csp = Current client state (buffers, headers, etc...)
- * 2 : fileid = File index to load.
- *
- * Returns : 0 => Ok, everything else is an error.
- *
- *********************************************************************/
- #ifndef FUZZ
- static
- #endif
- int load_one_actions_file(struct client_state *csp, int fileid)
- {
- /*
- * Parser mode.
- * Note: Keep these in the order they occur in the file, they are
- * sometimes tested with <=
- */
- enum {
- MODE_START_OF_FILE = 1,
- MODE_SETTINGS = 2,
- MODE_DESCRIPTION = 3,
- MODE_ALIAS = 4,
- MODE_ACTIONS = 5
- } mode;
- FILE *fp;
- struct url_actions *last_perm;
- struct url_actions *perm;
- char *buf;
- struct file_list *fs;
- struct action_spec * cur_action = NULL;
- int cur_action_used = 0;
- struct action_alias * alias_list = NULL;
- unsigned long linenum = 0;
- mode = MODE_START_OF_FILE;
- if (!check_file_changed(current_actions_file[fileid], csp->config->actions_file[fileid], &fs))
- {
- /* No need to load */
- csp->actions_list[fileid] = current_actions_file[fileid];
- return 0;
- }
- if (!fs)
- {
- log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': %E. "
- "Note that beginning with Privoxy 3.0.7, actions files have to be specified "
- "with their complete file names.", csp->config->actions_file[fileid]);
- return 1; /* never get here */
- }
- fs->f = last_perm = zalloc_or_die(sizeof(*last_perm));
- if ((fp = fopen(csp->config->actions_file[fileid], "r")) == NULL)
- {
- log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': error opening file: %E",
- csp->config->actions_file[fileid]);
- return 1; /* never get here */
- }
- log_error(LOG_LEVEL_INFO, "Loading actions file: %s", csp->config->actions_file[fileid]);
- while (read_config_line(fp, &linenum, &buf) != NULL)
- {
- if (*buf == '{')
- {
- /* It's a header block */
- if (buf[1] == '{')
- {
- /* It's {{settings}} or {{alias}} */
- size_t len = strlen(buf);
- char * start = buf + 2;
- char * end = buf + len - 1;
- if ((len < (size_t)5) || (*end-- != '}') || (*end-- != '}'))
- {
- /* too short */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': invalid line (%lu): %s",
- csp->config->actions_file[fileid], linenum, buf);
- return 1; /* never get here */
- }
- /* Trim leading and trailing whitespace. */
- end[1] = '\0';
- chomp(start);
- if (*start == '\0')
- {
- /* too short */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': invalid line (%lu): {{ }}",
- csp->config->actions_file[fileid], linenum);
- return 1; /* never get here */
- }
- /*
- * An actionsfile can optionally contain the following blocks.
- * They *MUST* be in this order, to simplify processing:
- *
- * {{settings}}
- * name=value...
- *
- * {{description}}
- * ...free text, format TBD, but no line may start with a '{'...
- *
- * {{alias}}
- * name=actions...
- *
- * The actual actions must be *after* these special blocks.
- * None of these special blocks may be repeated.
- *
- */
- if (0 == strcmpic(start, "settings"))
- {
- /* it's a {{settings}} block */
- if (mode >= MODE_SETTINGS)
- {
- /* {{settings}} must be first thing in file and must only
- * appear once.
- */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': line %lu: {{settings}} must only appear once, and it must be before anything else.",
- csp->config->actions_file[fileid], linenum);
- }
- mode = MODE_SETTINGS;
- }
- else if (0 == strcmpic(start, "description"))
- {
- /* it's a {{description}} block */
- if (mode >= MODE_DESCRIPTION)
- {
- /* {{description}} is a singleton and only {{settings}} may proceed it
- */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': line %lu: {{description}} must only appear once, and only a {{settings}} block may be above it.",
- csp->config->actions_file[fileid], linenum);
- }
- mode = MODE_DESCRIPTION;
- }
- else if (0 == strcmpic(start, "alias"))
- {
- /* it's an {{alias}} block */
- if (mode >= MODE_ALIAS)
- {
- /* {{alias}} must be first thing in file, possibly after
- * {{settings}} and {{description}}
- *
- * {{alias}} must only appear once.
- *
- * Note that these are new restrictions introduced in
- * v2.9.10 in order to make actionsfile editing simpler.
- * (Otherwise, reordering actionsfile entries without
- * completely rewriting the file becomes non-trivial)
- */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': line %lu: {{alias}} must only appear once, and it must be before all actions.",
- csp->config->actions_file[fileid], linenum);
- }
- mode = MODE_ALIAS;
- }
- else
- {
- /* invalid {{something}} block */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': invalid line (%lu): {{%s}}",
- csp->config->actions_file[fileid], linenum, start);
- return 1; /* never get here */
- }
- }
- else
- {
- /* It's an actions block */
- char *actions_buf;
- char * end;
- /* set mode */
- mode = MODE_ACTIONS;
- /* free old action */
- if (cur_action)
- {
- if (!cur_action_used)
- {
- free_action_spec(cur_action);
- }
- cur_action = NULL;
- }
- cur_action_used = 0;
- cur_action = zalloc_or_die(sizeof(*cur_action));
- init_action(cur_action);
- /*
- * Copy the buffer before messing with it as we may need the
- * unmodified version in for the fatal error messages. Given
- * that this is not a common event, we could instead simply
- * read the line again.
- *
- * buf + 1 to skip the leading '{'
- */
- actions_buf = end = strdup_or_die(buf + 1);
- /* check we have a trailing } and then trim it */
- if (strlen(actions_buf))
- {
- end += strlen(actions_buf) - 1;
- }
- if (*end != '}')
- {
- /* No closing } */
- fclose(fp);
- freez(actions_buf);
- log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
- "Missing trailing '}' in action section starting at line (%lu): %s",
- csp->config->actions_file[fileid], linenum, buf);
- return 1; /* never get here */
- }
- *end = '\0';
- /* trim any whitespace immediately inside {} */
- chomp(actions_buf);
- if (get_actions(actions_buf, alias_list, cur_action))
- {
- /* error */
- fclose(fp);
- freez(actions_buf);
- log_error(LOG_LEVEL_FATAL, "can't load actions file '%s': "
- "can't completely parse the action section starting at line (%lu): %s",
- csp->config->actions_file[fileid], linenum, buf);
- return 1; /* never get here */
- }
- if (action_spec_is_valid(csp, cur_action))
- {
- log_error(LOG_LEVEL_ERROR, "Invalid action section in file '%s', "
- "starting at line %lu: %s",
- csp->config->actions_file[fileid], linenum, buf);
- }
- freez(actions_buf);
- }
- }
- else if (mode == MODE_SETTINGS)
- {
- /*
- * Part of the {{settings}} block.
- * For now only serves to check if the file's minimum Privoxy
- * version requirement is met, but we may want to read & check
- * permissions when we go multi-user.
- */
- if (!strncmp(buf, "for-privoxy-version=", 20))
- {
- char *version_string, *fields[3];
- int num_fields;
- version_string = strdup_or_die(buf + 20);
- num_fields = ssplit(version_string, ".", fields, SZ(fields));
- if (num_fields < 1 || atoi(fields[0]) == 0)
- {
- log_error(LOG_LEVEL_ERROR,
- "While loading actions file '%s': invalid line (%lu): %s",
- csp->config->actions_file[fileid], linenum, buf);
- }
- else if ( (atoi(fields[0]) > VERSION_MAJOR)
- || ((num_fields > 1) && (atoi(fields[1]) > VERSION_MINOR))
- || ((num_fields > 2) && (atoi(fields[2]) > VERSION_POINT)))
- {
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "Actions file '%s', line %lu requires newer Privoxy version: %s",
- csp->config->actions_file[fileid], linenum, buf);
- return 1; /* never get here */
- }
- free(version_string);
- }
- }
- else if (mode == MODE_DESCRIPTION)
- {
- /*
- * Part of the {{description}} block.
- * Ignore for now.
- */
- }
- else if (mode == MODE_ALIAS)
- {
- /*
- * define an alias
- */
- char actions_buf[BUFFER_SIZE];
- struct action_alias * new_alias;
- char * start = strchr(buf, '=');
- char * end = start;
- if ((start == NULL) || (start == buf))
- {
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': invalid alias line (%lu): %s",
- csp->config->actions_file[fileid], linenum, buf);
- return 1; /* never get here */
- }
- new_alias = zalloc_or_die(sizeof(*new_alias));
- /* Eat any the whitespace before the '=' */
- end--;
- while ((*end == ' ') || (*end == '\t'))
- {
- /*
- * we already know we must have at least 1 non-ws char
- * at start of buf - no need to check
- */
- end--;
- }
- end[1] = '\0';
- /* Eat any the whitespace after the '=' */
- start++;
- while ((*start == ' ') || (*start == '\t'))
- {
- start++;
- }
- if (*start == '\0')
- {
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': invalid alias line (%lu): %s",
- csp->config->actions_file[fileid], linenum, buf);
- return 1; /* never get here */
- }
- new_alias->name = strdup_or_die(buf);
- strlcpy(actions_buf, start, sizeof(actions_buf));
- if (get_actions(actions_buf, alias_list, new_alias->action))
- {
- /* error */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': invalid alias line (%lu): %s = %s",
- csp->config->actions_file[fileid], linenum, buf, start);
- return 1; /* never get here */
- }
- /* add to list */
- new_alias->next = alias_list;
- alias_list = new_alias;
- }
- else if (mode == MODE_ACTIONS)
- {
- /* it's an URL pattern */
- /* allocate a new node */
- perm = zalloc_or_die(sizeof(*perm));
- perm->action = cur_action;
- cur_action_used = 1;
- /* Save the URL pattern */
- if (create_pattern_spec(perm->url, buf))
- {
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': line %lu: cannot create URL or TAG pattern from: %s",
- csp->config->actions_file[fileid], linenum, buf);
- return 1; /* never get here */
- }
- /* add it to the list */
- last_perm->next = perm;
- last_perm = perm;
- }
- else if (mode == MODE_START_OF_FILE)
- {
- /* oops - please have a {} line as 1st line in file. */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': line %lu should begin with a '{': %s",
- csp->config->actions_file[fileid], linenum, buf);
- return 1; /* never get here */
- }
- else
- {
- /* How did we get here? This is impossible! */
- fclose(fp);
- log_error(LOG_LEVEL_FATAL,
- "can't load actions file '%s': INTERNAL ERROR - mode = %d",
- csp->config->actions_file[fileid], mode);
- return 1; /* never get here */
- }
- freez(buf);
- }
- fclose(fp);
- if (!cur_action_used)
- {
- free_action_spec(cur_action);
- }
- free_alias_list(alias_list);
- /* the old one is now obsolete */
- if (current_actions_file[fileid])
- {
- current_actions_file[fileid]->unloader = unload_actions_file;
- }
- fs->next = files->next;
- files->next = fs;
- current_actions_file[fileid] = fs;
- csp->actions_list[fileid] = fs;
- return(0);
- }
- /*********************************************************************
- *
- * Function : actions_to_text
- *
- * Description : Converts a actionsfile entry from the internal
- * structure into a text line. The output is split
- * into one line for each action with line continuation.
- *
- * Parameters :
- * 1 : action = The action to format.
- *
- * Returns : A string. Caller must free it.
- * NULL on out-of-memory error.
- *
- *********************************************************************/
- char * actions_to_text(const struct action_spec *action)
- {
- unsigned long mask = action->mask;
- unsigned long add = action->add;
- char *result = strdup_or_die("");
- struct list_entry * lst;
- /* sanity - prevents "-feature +feature" */
- mask |= add;
- #define DEFINE_ACTION_BOOL(__name, __bit) \
- if (!(mask & __bit)) \
- { \
- string_append(&result, " -" __name " \\\n"); \
- } \
- else if (add & __bit) \
- { \
- string_append(&result, " +" __name " \\\n"); \
- }
- #define DEFINE_ACTION_STRING(__name, __bit, __index) \
- if (!(mask & __bit)) \
- { \
- string_append(&result, " -" __name " \\\n"); \
- } \
- else if (add & __bit) \
- { \
- string_append(&result, " +" __name "{"); \
- string_append(&result, action->string[__index]); \
- string_append(&result, "} \\\n"); \
- }
- #define DEFINE_ACTION_MULTI(__name, __index) \
- if (action->multi_remove_all[__index]) \
- { \
- string_append(&result, " -" __name " \\\n"); \
- } \
- else \
- { \
- lst = action->multi_remove[__index]->first; \
- while (lst) \
- { \
- string_append(&result, " -" __name "{"); \
- string_append(&result, lst->str); \
- string_append(&result, "} \\\n"); \
- lst = lst->next; \
- } \
- } \
- lst = action->multi_add[__index]->first; \
- while (lst) \
- { \
- string_append(&result, " +" __name "{"); \
- string_append(&result, lst->str); \
- string_append(&result, "} \\\n"); \
- lst = lst->next; \
- }
- #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
- #include "actionlist.h"
- #undef DEFINE_ACTION_MULTI
- #undef DEFINE_ACTION_STRING
- #undef DEFINE_ACTION_BOOL
- #undef DEFINE_ACTION_ALIAS
- return result;
- }
- /*********************************************************************
- *
- * Function : actions_to_html
- *
- * Description : Converts a actionsfile entry from numeric form
- * ("mask" and "add") to a <br>-separated HTML string
- * in which each action is linked to its chapter in
- * the user manual.
- *
- * Parameters :
- * 1 : csp = Client state (for config)
- * 2 : action = Action spec to be converted
- *
- * Returns : A string. Caller must free it.
- * NULL on out-of-memory error.
- *
- *********************************************************************/
- char * actions_to_html(const struct client_state *csp,
- const struct action_spec *action)
- {
- unsigned long mask = action->mask;
- unsigned long add = action->add;
- char *result = strdup_or_die("");
- struct list_entry * lst;
- /* sanity - prevents "-feature +feature" */
- mask |= add;
- #define DEFINE_ACTION_BOOL(__name, __bit) \
- if (!(mask & __bit)) \
- { \
- string_append(&result, "\n<br>-"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- } \
- else if (add & __bit) \
- { \
- string_append(&result, "\n<br>+"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- }
- #define DEFINE_ACTION_STRING(__name, __bit, __index) \
- if (!(mask & __bit)) \
- { \
- string_append(&result, "\n<br>-"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- } \
- else if (add & __bit) \
- { \
- string_append(&result, "\n<br>+"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- string_append(&result, "{"); \
- string_join(&result, html_encode(action->string[__index])); \
- string_append(&result, "}"); \
- }
- #define DEFINE_ACTION_MULTI(__name, __index) \
- if (action->multi_remove_all[__index]) \
- { \
- string_append(&result, "\n<br>-"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- } \
- else \
- { \
- lst = action->multi_remove[__index]->first; \
- while (lst) \
- { \
- string_append(&result, "\n<br>-"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- string_append(&result, "{"); \
- string_join(&result, html_encode(lst->str)); \
- string_append(&result, "}"); \
- lst = lst->next; \
- } \
- } \
- lst = action->multi_add[__index]->first; \
- while (lst) \
- { \
- string_append(&result, "\n<br>+"); \
- string_join(&result, add_help_link(__name, csp->config)); \
- string_append(&result, "{"); \
- string_join(&result, html_encode(lst->str)); \
- string_append(&result, "}"); \
- lst = lst->next; \
- }
- #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
- #include "actionlist.h"
- #undef DEFINE_ACTION_MULTI
- #undef DEFINE_ACTION_STRING
- #undef DEFINE_ACTION_BOOL
- #undef DEFINE_ACTION_ALIAS
- /* trim leading <br> */
- if (result && *result)
- {
- char * s = result;
- result = strdup(result + 5);
- free(s);
- }
- return result;
- }
- /*********************************************************************
- *
- * Function : current_actions_to_html
- *
- * Description : Converts a current action spec to a <br> separated HTML
- * text in which each action is linked to its chapter in
- * the user manual.
- *
- * Parameters :
- * 1 : csp = Client state (for config)
- * 2 : action = Current action spec to be converted
- *
- * Returns : A string. Caller must free it.
- * NULL on out-of-memory error.
- *
- *********************************************************************/
- char *current_action_to_html(const struct client_state *csp,
- const struct current_action_spec *action)
- {
- unsigned long flags = action->flags;
- struct list_entry * lst;
- char *result = strdup_or_die("");
- char *active = strdup_or_die("");
- char *inactive = strdup_or_die("");
- #define DEFINE_ACTION_BOOL(__name, __bit) \
- if (flags & __bit) \
- { \
- string_append(&active, "\n<br>+"); \
- string_join(&active, add_help_link(__name, csp->config)); \
- } \
- else \
- { \
- string_append(&inactive, "\n<br>-"); \
- string_join(&inactive, add_help_link(__name, csp->config)); \
- }
- #define DEFINE_ACTION_STRING(__name, __bit, __index) \
- if (flags & __bit) \
- { \
- string_append(&active, "\n<br>+"); \
- string_join(&active, add_help_link(__name, csp->config)); \
- string_append(&active, "{"); \
- string_join(&active, html_encode(action->string[__index])); \
- string_append(&active, "}"); \
- } \
- else \
- { \
- string_append(&inactive, "\n<br>-"); \
- string_join(&inactive, add_help_link(__name, csp->config)); \
- }
- #define DEFINE_ACTION_MULTI(__name, __index) \
- lst = action->multi[__index]->first; \
- if (lst == NULL) \
- { \
- string_append(&inactive, "\n<br>-"); \
- string_join(&inactive, add_help_link(__name, csp->config)); \
- } \
- else \
- { \
- while (lst) \
- { \
- string_append(&active, "\n<br>+"); \
- string_join(&active, add_help_link(__name, csp->config)); \
- string_append(&active, "{"); \
- string_join(&active, html_encode(lst->str)); \
- string_append(&active, "}"); \
- lst = lst->next; \
- } \
- }
- #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
- #include "actionlist.h"
- #undef DEFINE_ACTION_MULTI
- #undef DEFINE_ACTION_STRING
- #undef DEFINE_ACTION_BOOL
- #undef DEFINE_ACTION_ALIAS
- if (active != NULL)
- {
- string_append(&result, active);
- freez(active);
- }
- string_append(&result, "\n<br>");
- if (inactive != NULL)
- {
- string_append(&result, inactive);
- freez(inactive);
- }
- return result;
- }
- /*********************************************************************
- *
- * Function : action_to_line_of_text
- *
- * Description : Converts a action spec to a single text line
- * listing the enabled actions.
- *
- * Parameters :
- * 1 : action = Current action spec to be converted
- *
- * Returns : A string. Caller must free it.
- * Out-of-memory errors are fatal.
- *
- *********************************************************************/
- char *actions_to_line_of_text(const struct current_action_spec *action)
- {
- char buffer[200];
- struct list_entry *lst;
- char *active;
- const unsigned long flags = action->flags;
- active = strdup_or_die("");
- #define DEFINE_ACTION_BOOL(__name, __bit) \
- if (flags & __bit) \
- { \
- snprintf(buffer, sizeof(buffer), "+%s ", __name); \
- string_append(&active, buffer); \
- } \
- #define DEFINE_ACTION_STRING(__name, __bit, __index) \
- if (flags & __bit) \
- { \
- snprintf(buffer, sizeof(buffer), "+%s{%s} ", \
- __name, action->string[__index]); \
- string_append(&active, buffer); \
- } \
- #define DEFINE_ACTION_MULTI(__name, __index) \
- lst = action->multi[__index]->first; \
- while (lst != NULL) \
- { \
- snprintf(buffer, sizeof(buffer), "+%s{%s} ", \
- __name, lst->str); \
- string_append(&active, buffer); \
- lst = lst->next; \
- } \
- #define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
- #include "actionlist.h"
- #undef DEFINE_ACTION_MULTI
- #undef DEFINE_ACTION_STRING
- #undef DEFINE_ACTION_BOOL
- #undef DEFINE_ACTION_ALIAS
- if (active == NULL)
- {
- log_error(LOG_LEVEL_FATAL, "Out of memory in action_to_line_of_text()");
- }
- return active;
- }
|