To add or edit an entry, you’re provided with a simple form with 5 fields.

• Name: The name of the entry. Digg, Google, Yahoo… are good names.
• URL: The URL of the site where your users come from. For this to work, the URL must not contain those prefix and suffix like “http:/www” and “/?q=etc.”. To be clear, it should be “digg.com” instead of “http://digg.com”, and “google.com” instead of “http://www.google.com/search?hl=en&q=some+keywords”. Furthermore, the domain and subdomain are treated differently, which means different greeting boxes (if any) will be shown for “yahoo.com” and “search.yahoo.com” users.
• Message: The greeting text for this entry. These HTML tags are allowed: <div><h1><h2><h3><p><span><a><ul><ol><li><hr><br><table><thead><tbody><tfoot><tr><td><th><strong><em> Also, these tags may be used:
  • {url} - Full URL to your WordPress post, for example http://yousite.com/2008/10/my-first-post. Very handy if you want to ask your users to digg your post.
  • {title} - Title of the post, for example My First Post.
  • {link} - Link to the post, for example My First Post. It’s just an combination of {url} and {title}.
  • {categorynames} - Names of the categories under which the post is listed, separated by a comma. Example: Cats, Dogs, Pets.
  • {categorylinks} - Links to the categories under which the post is listed, separated by a comma. Example: Cats, Dogs, Pets
  • {authorname} - Name of the author of the post, for example Mr. Cool.
  • {authorurl} - URL of the author, for example http://mrcool.com.
  • {authorlink} - Link to the author, for example Mr. Cool
  • NEW: {search-terms} - The search terms that user uses to find your blog, seperated by commas
• Icon: The URL of the icon to display beside the greeting text. If this is left blank, a default RSS icon will be shown. Though any image will do, it’s recommended to use a small one (48×48 px should be perfect).
• This entry is active: The name says it all. Naturally, this should be checked.

Those options are used to specify if you want to show the greeting box on every post, page, before or after… Notice that if you can include a {referrer_detector} anywhere in your post to show the welcome text. If the visitor didn’t come from any of the referrers, don’t worry, the plugin is smart enough to hide that ugly tag from your post.

Starting from version 2.0, a template tag <?php if (function_exists(\'referrer_detector\')) referrer_detector(); ?> can be placed somewhere in the theme files (most likely index.php) to display a greet box too.

Here you can specify a list of urls (comma-seperated). If the visitor is comming from one of these urls, the welcome box will not be show.
For example, by adding google.com/reader into the list, you make sure that the readers won\'t see the box, which is good since they should have registered to your feed already.

%s

• %s
• %s
• %s
• %s
• %s

', wp_create_nonce(RDETECTOR_NONCE_ACTION), __('Referrer Detector Options', $rdetector_text_domain), __('Entry List', $rdetector_text_domain), __('Add Entry', $rdetector_text_domain), __('Edit Entry', $rdetector_text_domain), __('Excluded URLs', $rdetector_text_domain), __('Generic Options', $rdetector_text_domain)); // the current entries printf('

%s

%s

', rdetector_get_entry_table(), __('Warning: This will delete ALL of your custom entries (if any)! Are you sure?'), __('Restore default entries'), $rdetector_plugin_dir); // the edit div printf('

%s

%s

%s

', __('Click "View/Edit" on the entry list to edit.', $rdetector_text_domain), __('Get help with this', $rdetector_text_domain), __($rdetector_add_help, $rdetector_text_domain), $rdetector_plugin_dir); // the Add div printf('

%s

%s

%s

%s

%s

%s
(%s)

%s

', __('Get help with this', $rdetector_text_domain), __($rdetector_add_help, $rdetector_text_domain), __('Name', $rdetector_text_domain), __('Url', $rdetector_text_domain), __('Welcome message', $rdetector_text_domain), __('Icon', $rdetector_text_domain), __('Optional', $rdetector_text_domain), __('This entry is active', $rdetector_text_domain), __('Add this!', $rdetector_text_domain), $rdetector_plugin_dir ); // the exluded urls printf('

%s

%s

%s

', __('Get help with this', $rdetector_text_domain), __($rdetector_exclude_help, $rdetector_text_domain), get_option('rdetector_excluded_urls'), __('Exclude these out!', $rdetector_text_domain)); // the generic options div printf('

%s

%s

', __('Get help with this', $rdetector_text_domain), __($rdetector_generic_help, $rdetector_text_domain)); global $rdetector_options; foreach ($rdetector_options as $key => $config) { $value = get_option($key); if (!$value) $value = $config['default_value']; $select_options = ''; foreach ($config['options'] as $o) { $select_options .= sprintf(' %s ', $o, $o == $value ? 'selected="selected"' : '', $o); } printf('

%s
%s

', $key, $config['label'], $key, $key, $select_options); } printf('

%s

', __("(*) If set to No, you may use a custom tag to manually display the welcome message on your posts.
Alternatively, you may put a template tag in your template files (most likely index.php)."), __('Save these options', $rdetector_text_domain)); printf('

%s

• %s

', $errors)); return false; } function rdetector_format_entry_html($id, $name, $url, $icon, $welcome_text, $enabled) { global $rdetector_plugin_dir, $rdetector_text_domain; return sprintf(' %s %s %s %s | %s | %s %s', $enabled ? __('active', $rdetector_text_domain) : __('inactive', $rdetector_text_domain), $id, stripslashes($name), $url, $icon ? $icon : "{$rdetector_plugin_dir}images/icons/default.png", stripslashes($welcome_text), $id, $enabled ? 'deactivate' : 'activate', $enabled ? __('Deactivate', $rdetector_text_domain) : __('Activate', $rdetector_text_domain), $id, __('Edit/View', $rdetector_text_domain), $id, __('Are you sure you want to delete this entry?', $rdetector_text_domain), __('Delete', $rdetector_text_domain), $id, $rdetector_plugin_dir, PHP_EOL); } /** * @desc (De)Activates an entry */ function rdetector_activate_entry($is_activating) { global $wpdb, $rdetector_table_name; $sql = sprintf('UPDATE `%s` SET `enabled`=%s WHERE `id`=%s', $rdetector_table_name, $is_activating ? 1 : 0, intval($_POST['id'])); $wpdb->query($sql); if (!mysql_affected_rows()) { rdetector_send_fake_error(); } rdetector_generate_js_data(); $is_activating ? _e('Deactivate', $rdetector_text_domain) : _e('Activate', $rdetector_text_domain); } /** * @desc Edits an entry */ function rdetector_edit_entry($is_updating = false) { global $wpdb, $rdetector_table_name; $id = intval($_POST['id']); if (!$is_updating) { $sql = "SELECT * FROM `$rdetector_table_name` WHERE `id`=$id"; $entry = $wpdb->get_row($sql); if (empty($entry)) { rdetector_send_fake_error(); } printf('

%s

%s

%s
%s

%s
(%s)

%s

', __('Name', $rdetector_text_domain), addslashes($entry->name), __('Url', $rdetector_text_domain), $entry->url, __('Welcome message', $rdetector_text_domain), stripslashes(htmlentities($entry->welcome_text)), __('Icon', $rdetector_text_domain), $entry->icon, __('Optional', $rdetector_text_domain), $entry->enabled == 1 ? 'checked="checked"' : '', __('This entry is active', $rdetector_text_domain), $entry->id, __('Save it!', $rdetector_text_domain), __('Cancel', $rdetector_text_domain)); } else { if (!$errors = rdetector_validate_post_data(true)) { return false; } global $wpdb, $rdetector_table_name; $message = rdetector_strip_tags($_POST['message']); $sql = $wpdb->prepare("UPDATE `$rdetector_table_name` SET `name`=%s, `url`=%s, `icon`=%s, `welcome_text`=%s, `enabled`=%d WHERE `id`=%d", $_POST['name'], $_POST['url'], $_POST['icon'], $message, isset($_POST['enabled']), intval($_POST['id'])); $result = $wpdb->query($sql); rdetector_generate_js_data(); echo rdetector_format_entry_html(intval($_POST['id']), $_POST['name'], $_POST['url'], $_POST['icon'], $message, isset($_POST['enabled'])); } } function redetector_delete_entry() { if (!isset($_POST['id']) || trim($_POST['id']) == '') { rdetector_send_fake_error(); } global $wpdb, $rdetector_table_name; $sql = $wpdb->prepare("DELETE FROM `$rdetector_table_name` WHERE `id`=%d LIMIT 1", intval($_POST['id'])); $wpdb->query($sql); if (!mysql_affected_rows()) { rdetector_send_fake_error(); } rdetector_generate_js_data(); } /** * @desc Restore the default entries */ function redetector_restore_default_entries() { global $wpdb, $rdetector_table_name; $wpdb->query("TRUNCATE $rdetector_table_name"); rdetector_add_default_entries(); rdetector_generate_js_data(); echo rdetector_get_entry_table(); } /** * @desc Saves the generic options of the plugin */ function redetector_save_generic_options() { // we have 2 cases if (isset($_POST['rdetector_excluded_urls'])) { // 1. Excluded URLS $urls = explode(',', $_POST['rdetector_excluded_urls']); array_walk($urls, 'rdetector_trim_value'); update_option('rdetector_excluded_urls', implode(',', $urls)); } else { // 2. "Real" generic options global $rdetector_options, $rdetector_text_domain; foreach ($rdetector_options as $key => $config) { if (isset($_POST[$key])) { update_option($key, $_POST[$key]); } } } rdetector_generate_js_data(); _e("Settings saved.", $rdetector_text_domain); } function rdetector_trim_value(&$value) { $value = trim($value); } /** * @desc (Re)Generates the data in JS format */ function rdetector_generate_js_data() { // if ($_SERVER['REMOTE_ADDR'] == '127.0.0.1') return true; global $wpdb, $rdetector_table_name, $rdetector_options, $rdetector_plugin_dir, $rdetector_text_domain; $sql = "SELECT * FROM `$rdetector_table_name` WHERE `enabled`=1"; $entries = $wpdb->get_results($sql); // the entries $data[] = 'var rdetector_entries = new Array();'; foreach ($entries as $entry) { if (empty($entry->icon)) $entry->icon = "{$rdetector_plugin_dir}images/icons/default.png"; $key = base64_encode($entry->url); $data[] = sprintf('rdetector_entries["%s"] = new Array();', $key); $data[] = sprintf('rdetector_entries["%s"]["message"] = "%s";', $key, base64_encode(stripslashes($entry->welcome_text))); $data[] = sprintf('rdetector_entries["%s"]["icon"] = "%s";', $key, base64_encode($entry->icon)); } // the options $data[] = 'var rdetector_options = new Array();'; foreach ($rdetector_options as $key => $config) { $value = get_option($key); $data[] = sprintf('rdetector_options["%s"] = "%s";', $key, empty($value) ? $config['default_value'] : $value); } // don't forget the excluded URLs $data[] = sprintf('rdetector_options["rdetector_excluded_urls"] = "%s";', base64_encode(get_option('rdetector_excluded_urls'))); // save if (!$handle = fopen("../wp-content/plugins/referrer-detector/js/data.js", 'w')) { exit(__("Error: Could not open wp-content/plugins/referrer-detector/js/data.js for writing, please check file permission.", $rdetector_text_domain)); } fwrite($handle, implode(PHP_EOL, $data)); fclose($handle); } /** * @desc Strips unallowed tags from the welcome message */ function rdetector_strip_tags($message) { $allowable_tags = '

1. ---

   
   

   '; return $message = strip_tags(html_entity_decode($message), $allowable_tags); } /** * @desc Sends a fake error (for AJAX purpose) */ function rdetector_send_fake_error() { header('HTTP/1.0 404 Not Found'); exit(); } function rdetector_prepare_post_data($post_content) { // don't display the greeting if it's a feed if (is_feed()) { return str_replace(RDETECTOR_CUSTOM_TAG, '', $post_content); } $url = get_permalink($post->ID); $title = get_the_title(); $author_name = get_the_author(); $author_url = get_the_author_url(); $category_names = array(); $category_links = array(); foreach((get_the_category()) as $category) { $category_names[] = $category->cat_name; $category_links[] = sprintf('%s', get_category_link($category->cat_ID), $category->cat_name); } $tags = array( 'url' => $url, 'title' => $title, 'link' => sprintf('%s', $url, $title), 'categorynames' => implode(', ', $category_names), 'categorylinks' => implode(', ', $category_links), 'authorname' => $author_name, 'authorurl' => $author_url, 'authorlink' => sprintf('%s', $author_url, $author_name), ); // merge all the data into a hidden input's value $data = ''; foreach ($tags as $key => $value) { $data .= "$key:" . base64_encode($value) . ','; } $data = sprintf('', rtrim($data, ',')); $data .= sprintf('', is_page() ? 'page' : 'post'); $post_content .= $data; $post_content = str_replace(RDETECTOR_CUSTOM_TAG, '', $post_content); return '' . $post_content . ''; } add_filter('the_content', 'rdetector_prepare_post_data', 5); /** * @desc Includes the stylesheet for the greet box */ function rdetector_head() { global $rdetector_plugin_dir; printf('', $rdetector_plugin_dir); print(''); printf('', $rdetector_plugin_dir); printf('', $rdetector_plugin_dir); printf('', $rdetector_plugin_dir); } add_action('wp_head', 'rdetector_head'); /** * @desc */ function referrer_detector() { echo ' '; }