-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.134 2016/02/26 12:32:09 fabiankeil Exp $";
+const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.147 2017/02/20 13:47:04 fabiankeil Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
* Purpose : Simple CGIs to get information about Privoxy's
* status.
*
- * Copyright : Written by and Copyright (C) 2001-2016 the
+ * Copyright : Written by and Copyright (C) 2001-2017 the
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
#include "parsers.h"
#include "urlmatch.h"
#include "errlog.h"
+#ifdef FEATURE_CLIENT_TAGS
+#include "client-tags.h"
+#endif
const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
}
+#ifdef FEATURE_CLIENT_TAGS
+/*********************************************************************
+ *
+ * Function : cgi_create_client_tag_form
+ *
+ * Description : Creates a HTML form to enable or disable a given
+ * client tag.
+ * XXX: Could use a template.
+ *
+ * Parameters :
+ * 1 : form = Buffer to fill with the generated form
+ * 2 : size = Size of the form buffer
+ * 3 : tag = Name of the tag this form should affect
+ * 4 : toggle_state = Desired state after the button pressed 0
+ * 5 : expires = Whether or not the tag should be enabled.
+ * Only checked if toggle_state is 1.
+ *
+ * Returns : void
+ *
+ *********************************************************************/
+static void cgi_create_client_tag_form(char *form, size_t size,
+ const char *tag, int toggle_state, int expires)
+{
+ char *button_name;
+
+ if (toggle_state == 1)
+ {
+ button_name = (expires == 1) ? "Enable" : "Enable temporarily";
+ }
+ else
+ {
+ assert(toggle_state == 0);
+ button_name = "Disable";
+ }
+
+ snprintf(form, size,
+ "<form method=\"GET\" action=\""CGI_PREFIX"toggle-client-tag\" style=\"display: inline\">\n"
+ " <input type=\"hidden\" name=\"tag\" value=\"%s\">\n"
+ " <input type=\"hidden\" name=\"toggle-state\" value=\"%u\">\n"
+ " <input type=\"hidden\" name=\"expires\" value=\"%u\">\n"
+ " <input type=\"submit\" value=\"%s\">\n"
+ "</form>", tag, toggle_state, !expires, button_name);
+}
+
+/*********************************************************************
+ *
+ * Function : cgi_show_client_tags
+ *
+ * Description : Shows the tags that can be set based on the client
+ * address (opt-in).
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters : none
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_show_client_tags(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ struct map *exports;
+ struct client_tag_spec *this_tag;
+ jb_err err = JB_ERR_OK;
+ char *client_tag_status;
+ char buf[1000];
+ time_t refresh_delay;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ if (NULL == (exports = default_exports(csp, "client-tags")))
+ {
+ return JB_ERR_MEMORY;
+ }
+ assert(csp->client_address != NULL);
+
+ this_tag = csp->config->client_tags;
+ if (this_tag->name == NULL)
+ {
+ client_tag_status = strdup_or_die("<p>No tags available.</p>\n");
+ }
+ else
+ {
+ client_tag_status = strdup_or_die("<table border=\"1\">\n"
+ "<tr><th>Tag name</th>\n"
+ "<th>Current state</th><th>Change state</th><th>Description</th></tr>\n");
+ while ((this_tag != NULL) && (this_tag->name != NULL))
+ {
+ int tag_state;
+
+ privoxy_mutex_lock(&client_tags_mutex);
+ tag_state = client_has_requested_tag(csp->client_address, this_tag->name);
+ privoxy_mutex_unlock(&client_tags_mutex);
+ if (!err) err = string_append(&client_tag_status, "<tr><td>");
+ if (!err) err = string_append(&client_tag_status, this_tag->name);
+ if (!err) err = string_append(&client_tag_status, "</td><td>");
+ if (!err) err = string_append(&client_tag_status, tag_state == 1 ? "Enabled" : "Disabled");
+ if (!err) err = string_append(&client_tag_status, "</td><td>");
+ cgi_create_client_tag_form(buf, sizeof(buf), this_tag->name, !tag_state, 1);
+ if (!err) err = string_append(&client_tag_status, buf);
+ if (tag_state == 0)
+ {
+ cgi_create_client_tag_form(buf, sizeof(buf), this_tag->name, !tag_state, 0);
+ if (!err) err = string_append(&client_tag_status, buf);
+ }
+ if (!err) err = string_append(&client_tag_status, "</td><td>");
+ if (!err) err = string_append(&client_tag_status, this_tag->description);
+ if (!err) err = string_append(&client_tag_status, "</td></tr>\n");
+ if (err)
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ this_tag = this_tag->next;
+ }
+ if (!err) err = string_append(&client_tag_status, "</table>\n");
+ }
+ refresh_delay = get_next_tag_timeout_for_client(csp->client_address);
+ if (refresh_delay != 0)
+ {
+ snprintf(buf, sizeof(buf), "%d", csp->config->client_tag_lifetime);
+ if (map(exports, "refresh-delay", 1, buf, 1))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+ }
+ else
+ {
+ err = map_block_killer(exports, "tags-expire");
+ if (err != JB_ERR_OK)
+ {
+ return err;
+ }
+ }
+
+ if (map(exports, "client-tags", 1, client_tag_status, 0))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+
+ if (map(exports, "client-ip-addr", 1, csp->client_address, 1))
+ {
+ free_map(exports);
+ return JB_ERR_MEMORY;
+ }
+
+ return template_fill_for_cgi(csp, "client-tags", exports, rsp);
+}
+
+
+/*********************************************************************
+ *
+ * Function : cgi_toggle_client_tag
+ *
+ * Description : Toggles a client tag and redirects to the show-tags
+ * page
+ *
+ * Parameters :
+ * 1 : csp = Current client state (buffers, headers, etc...)
+ * 2 : rsp = http_response data structure for output
+ * 3 : parameters = map of cgi parameters
+ *
+ * CGI Parameters : none
+ * 1 : tag = Name of the tag to enable or disable
+ * 2 : toggle-state = How to toggle the tag (0/1)
+ * 3 : expires = Set to 1 if the tag should be enabled
+ * temporarily, otherwise set to 0
+ *
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ *
+ *********************************************************************/
+jb_err cgi_toggle_client_tag(struct client_state *csp,
+ struct http_response *rsp,
+ const struct map *parameters)
+{
+ const char *toggled_tag;
+ const char *toggle_state;
+ const char *tag_expires;
+ time_t time_to_live;
+
+ assert(csp);
+ assert(rsp);
+ assert(parameters);
+
+ toggled_tag = lookup(parameters, "tag");
+ if (*toggled_tag == '\0')
+ {
+ log_error(LOG_LEVEL_ERROR, "Received tag toggle request without tag");
+ }
+ else
+ {
+ tag_expires = lookup(parameters, "expires");
+ if (*tag_expires == '0')
+ {
+ time_to_live = 0;
+ }
+ else
+ {
+ time_to_live = csp->config->client_tag_lifetime;
+ }
+ toggle_state = lookup(parameters, "toggle-state");
+ if (*toggle_state == '1')
+ {
+ enable_client_specific_tag(csp, toggled_tag, time_to_live);
+ }
+ else
+ {
+ disable_client_specific_tag(csp, toggled_tag);
+ }
+ }
+ rsp->status = strdup_or_die("302 Done dealing with toggle request");
+ if (enlist_unique_header(rsp->headers,
+ "Location", CGI_PREFIX "client-tags"))
+ {
+ return JB_ERR_MEMORY;
+ }
+ return JB_ERR_OK;
+
+}
+#endif /* def FEATURE_CLIENT_TAGS */
+
+
/*********************************************************************
*
* Function : cgi_send_banner
};
static const struct feature features[] = {
+ {
+ "FEATURE_64_BIT_TIME_T",
+#if (SIZEOF_TIME_T == 8)
+ 1,
+#else
+ 0,
+#endif
+ },
{
"FEATURE_ACCEPT_FILTER",
#ifdef FEATURE_ACCEPT_FILTER
1,
#else
0,
+#endif
+ },
+ {
+ "FEATURE_CLIENT_TAGS",
+#ifdef FEATURE_CLIENT_TAGS
+ 1,
+#else
+ 0,
#endif
},
{
1,
#else
0,
-#endif
- },
- {
- "FEATURE_IMAGE_DETECT_MSIE",
-#ifdef FEATURE_IMAGE_DETECT_MSIE
- 1,
-#else
- 0,
#endif
},
{
#endif /* def FEATURE_CGI_EDIT_ACTIONS */
SHOW_RCS(cgisimple_h_rcs)
SHOW_RCS(cgisimple_rcs)
-#ifdef __MINGW32__
- SHOW_RCS(cygwin_h_rcs)
-#endif
SHOW_RCS(deanimate_h_rcs)
SHOW_RCS(deanimate_rcs)
SHOW_RCS(encode_h_rcs)