├── index.php
├── wpml-config.xml
├── .eslintrc.js
├── .editorconfig
├── phpcs.xml
├── src
    ├── admin-notice-install-deps.php
    ├── functions.php
    ├── Admin.php
    └── Bar.php
├── assets
    └── src
    │   ├── js
    │       ├── cookies.js
    │       ├── admin.js
    │       ├── loader.js
    │       └── script.js
    │   └── css
    │       └── bar.css
├── .github
    └── workflows
    │   └── check-php-syntax.yml
├── webpack.config.js
├── README.md
├── mailchimp-top-bar.php
├── create-version.sh
├── composer.lock
├── CHANGELOG.md
├── readme.txt
├── views
    └── settings-page.php
└── LICENSE


/index.php:
--------------------------------------------------------------------------------
1 | <?php
2 | // Silence is golden.
3 | 


--------------------------------------------------------------------------------
/wpml-config.xml:
--------------------------------------------------------------------------------
 1 | <wpml-config>
 2 | 	<admin-texts>
 3 | 		<key name="mailchimp_top_bar">
 4 | 			<key name="text_email_placeholder" />
 5 | 			<key name="text_bar" />
 6 | 			<key name="text_button" />
 7 | 		</key>
 8 | 	</admin-texts>
 9 | </wpml-config>
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/.eslintrc.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |   env: {
 3 |     browser: true,
 4 |     commonjs: true,
 5 |     es6: true
 6 |   },
 7 |   extends: [
 8 |     'standard'
 9 |   ],
10 |   globals: {
11 |     Atomics: 'readonly',
12 |     SharedArrayBuffer: 'readonly'
13 |   },
14 |   parserOptions: {
15 |     ecmaVersion: 2018
16 |   },
17 |   rules: {
18 |     'no-prototype-builtins': 'off'
19 |   }
20 | }
21 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | # This file is for unifying the coding style for different editors and IDEs
 2 | # editorconfig.org
 3 | 
 4 | # WordPress Coding Standards
 5 | # https://make.wordpress.org/core/handbook/coding-standards/
 6 | 
 7 | root = true
 8 | 
 9 | [*]
10 | charset = utf-8
11 | end_of_line = lf
12 | insert_final_newline = true
13 | trim_trailing_whitespace = true
14 | indent_style = space
15 | indent_size = 4
16 | 
17 | [*.{yaml,yml}]
18 | indent_style = space
19 | indent_size = 2
20 | 
21 | [*.js]
22 | indent_style = space
23 | indent_size = 2
24 | 
25 | [*.md]
26 | trim_trailing_whitespace = false
27 | 
28 | [{*.txt,wp-config-sample.php}]
29 | end_of_line = crlf
30 | 


--------------------------------------------------------------------------------
/phpcs.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <ruleset name="rules">
 3 |     <description>rules</description>
 4 |     <arg name="colors"/>
 5 |     <file>src/</file>
 6 |     <file>mailchimp-top-bar.php</file>
 7 |     <exclude-pattern>*\.(html|css|js)</exclude-pattern>
 8 |     <rule ref="Generic.Arrays.DisallowLongArraySyntax.Found"/>
 9 |     <rule ref="PSR12">
10 |         <exclude name="Squiz.Classes.ValidClassName.NotCamelCaps" />
11 |         <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps" />
12 |         <exclude name="PSR1.Files.SideEffects.FoundWithSymbols" />
13 |         <exclude name="Generic.Files.LineLength.TooLong" />
14 |     </rule>
15 | </ruleset>
16 | 


--------------------------------------------------------------------------------
/src/admin-notice-install-deps.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Show notice to user
 4 | add_action('admin_notices', function () {
 5 |     // only show to user with caps
 6 |     if (! current_user_can('install_plugins')) {
 7 |         return;
 8 |     }
 9 | 
10 |     add_thickbox();
11 |     $url = network_admin_url('plugin-install.php?tab=plugin-information&plugin=mailchimp-for-wp&TB_iframe=true&width=600&height=550');
12 |     ?>
13 |     <div class="notice notice-warning is-dismissible">
14 |         <p><?php printf(__('Please install or activate <a href="%s" class="thickbox">%s</a> in order to use %s.', 'mailchimp-top-bar'), $url, '<strong>MailChimp for WordPress</strong>', 'MailChimp Top Bar'); ?></p>
15 |     </div>
16 |     <?php
17 | });
18 | 


--------------------------------------------------------------------------------
/assets/src/js/cookies.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Creates a cookie
 3 |  *
 4 |  * @param {string} name
 5 |  * @param {mixed} value
 6 |  * @param {int|undefined} days
 7 |  */
 8 | function create (name, value, days) {
 9 |   const expires = days ? ';max-age=' + days * 24 * 60 * 60 : ''
10 |   document.cookie = encodeURIComponent(name) + '=' + encodeURIComponent(value) + expires + ';path=/;SameSite=lax'
11 | }
12 | 
13 | /**
14 |  * Checks for existence of a cookie without checking its value
15 |  *
16 |  * @param {string} name
17 |  * @returns {boolean}
18 |  */
19 | function exists (name) {
20 |   return (new RegExp(name + '=')).test(document.cookie)
21 | }
22 | 
23 | /**
24 |  * Erases a cookie
25 |  *
26 |  * @param {string} name
27 |  */
28 | function erase (name) {
29 |   create(name, '', -1)
30 | }
31 | 
32 | export default { exists, create, erase }
33 | 


--------------------------------------------------------------------------------
/.github/workflows/check-php-syntax.yml:
--------------------------------------------------------------------------------
 1 | name: Check PHP syntax
 2 | 
 3 | on: [ push, pull_request ]
 4 | 
 5 | jobs:
 6 |   build:
 7 |     runs-on: ubuntu-latest
 8 |     strategy:
 9 |       matrix:
10 |         php-version: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
11 |     steps:
12 |       # Install PHP interpreter
13 |       - name: Setup PHP
14 |         uses: shivammathur/setup-php@v2
15 |         with:
16 |           php-version: ${{ matrix.php-version }}
17 |           ini-file: development
18 | 
19 |       # Checkout source repository
20 |       - name: checkout repo
21 |         uses: actions/checkout@v3
22 | 
23 |       # Lint every PHP source file using PHP interpreter
24 |       - name: Check PHP syntax
25 |         run: composer run check-syntax
26 | 
27 |       - name: composer install
28 |         if: ${{ matrix.php-version == '8.3' }}
29 |         run: composer install --no-progress
30 | 
31 |       - name: PHPCodeSniffer
32 |         if: ${{ matrix.php-version == '8.3' }}
33 |         run: ./vendor/bin/phpcs -s
34 | 


--------------------------------------------------------------------------------
/webpack.config.js:
--------------------------------------------------------------------------------
 1 | const path = require('path')
 2 | const CopyWebpackPlugin = require('copy-webpack-plugin')
 3 | const cssnano = require('cssnano')
 4 | const postcss = require('postcss')
 5 | 
 6 | module.exports = {
 7 |   entry: {
 8 |     script: './assets/src/js/script.js',
 9 |     admin: './assets/src/js/admin.js'
10 |   },
11 |   output: {
12 |     filename: '[name].js',
13 |     path: path.resolve(__dirname, 'assets')
14 |   },
15 |   module: {
16 |     rules: [
17 |       {
18 |         test: /\.m?js$/,
19 |         exclude: /(node_modules|bower_components)/,
20 |         use: {
21 |           loader: 'babel-loader',
22 |           options: {
23 |             presets: ['@babel/preset-env']
24 |           }
25 |         }
26 |       },
27 |       {
28 |         test: /\.css$/i,
29 |         use: ['style-loader', 'css-loader']
30 |       }
31 |     ]
32 |   },
33 |   plugins: [
34 |     new CopyWebpackPlugin({
35 |       patterns: [
36 |         {
37 |           from: 'assets/src/css/*.css',
38 |           to: path.resolve(__dirname, 'assets') + '/[name].css',
39 |           transform: (content, path) => {
40 |             return postcss([cssnano])
41 |               .process(content, {
42 |                 from: path
43 |               })
44 |               .then((result) => {
45 |                 return result.css
46 |               })
47 |           }
48 |         }
49 |       ]
50 |     })
51 |   ]
52 | }
53 | 


--------------------------------------------------------------------------------
/assets/src/js/admin.js:
--------------------------------------------------------------------------------
 1 | const elSelectList = document.getElementById('select-mailchimp-list')
 2 | const msgRequiresFields = document.getElementById('message-list-requires-fields')
 3 | 
 4 | /*
 5 |  * Functions
 6 |  */
 7 | function maybeShowRequiredFieldsNotice () {
 8 |   msgRequiresFields.style.display = 'none'
 9 |   const listId = elSelectList.value
10 |   const xhr = new XMLHttpRequest()
11 |   xhr.open('GET', window.ajaxurl + '?action=mc4wp_get_list_details&ids=' + listId, true)
12 |   xhr.onload = function () {
13 |     if (this.status >= 400) {
14 |       console.error('Error retrieving list details')
15 |       return
16 |     }
17 |     const lists = JSON.parse(this.responseText)
18 |     // iterate over selected lists
19 |     for (let i = 0; i < lists.length; i++) {
20 |       const list = lists[i]
21 | 
22 |       // iterate over list fields
23 |       for (let j = 0; j < list.merge_fields.length; j++) {
24 |         const field = list.merge_fields[j]
25 | 
26 |         // if field other than EMAIL is required, show notice and stop loop
27 |         if (field.tag !== 'EMAIL' && field.required) {
28 |           msgRequiresFields.style.display = ''
29 |           return
30 |         }
31 |       }
32 |     }
33 |   }
34 |   xhr.send(null)
35 | }
36 | 
37 | // init colorpickers
38 | window.jQuery('.mc4wp-color').wpColorPicker()
39 | 
40 | // if a list changes, check which fields are required
41 | elSelectList.addEventListener('change', maybeShowRequiredFieldsNotice)
42 | 
43 | // check right away
44 | maybeShowRequiredFieldsNotice()
45 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | MC4WP: Mailchimp Top Bar
 2 | ==============
 3 | 
 4 | Adds a beautiful and customizable Mailchimp opt-in bar to the top of your WordPress site. 
 5 | 
 6 | Requirements
 7 | ------------
 8 | 
 9 | - WordPress version 4.9 or later
10 | - PHP version 7.3 or later
11 | 
12 | 
13 | Installation
14 | ------------
15 | 
16 | If you just want to install this plugin on your WordPress site, please download and install the latest version from WordPress.org: [Mailchimp Top Bar plugin on WordPress.org](https://wordpress.org/plugins/mailchimp-top-bar/installation/).
17 | 
18 | To install the development version, take the following steps:
19 | 
20 | 1. Clone the GitHub repository:
21 | 
22 | ```
23 | git clone https://github.com/ibericode/mailchimp-top-bar.git
24 | ```
25 | 
26 | 2. Install NPM dependencies:
27 | 
28 | ```
29 | npm install
30 | ```
31 | 
32 | 3. Generate plugin asset files:
33 | 
34 | ```
35 | npm run build
36 | ```
37 | 
38 | 5. Activate the plugin in your WordPress admin.
39 | 
40 | Bugs
41 | ----
42 | If you think you've found a bug, [please open an issue here](https://github.com/ibericode/mailchimp-top-bar/issues?state=open)!
43 | 
44 | Support
45 | -------
46 | This is a developer's portal for the Mailchimp Top Bar plugin and should not be used for support. Please visit the
47 | [Mailchimp Top Bar support forum on WordPress.org](https://wordpress.org/support/plugin/mailchimp-top-bar).
48 | 
49 | If you need priority support, please purchase a [Mailchimp for WordPress Premium](https://www.mc4wp.com/) plugin license.
50 | 
51 | License
52 | -------
53 | GPLv3 or later
54 | 


--------------------------------------------------------------------------------
/src/functions.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | function mctb_get_options()
 4 | {
 5 |     static $options = null;
 6 |     if (is_array($options)) {
 7 |         return $options;
 8 |     }
 9 | 
10 |     $defaults = [
11 |         'list' => '',
12 |         'enabled' => 1,
13 |         'show_to_administrators' => 1,
14 |         'cookie_length' => 365,
15 |         'color_bar' => '#ffcc00',
16 |         'color_text' => '#222222',
17 |         'color_button' => '#222222',
18 |         'color_button_text' => '#ffffff',
19 |         'disable_after_use' => 1,
20 |         'size' => 'medium',
21 |         'sticky' => 1,
22 |         'text_email_placeholder' => __('Your email address..', 'mailchimp-top-bar'),
23 |         'text_bar' => __('Sign-up now - don\'t miss the fun!', 'mailchimp-top-bar'),
24 |         'text_button' => __('Subscribe', 'mailchimp-top-bar'),
25 |         'redirect' => '',
26 |         'position' => 'top',
27 |         'double_optin' => 1,
28 |         'send_welcome' => 0,
29 |         'update_existing' => 0,
30 |         'text_subscribed' => __("Thanks, you're in! Please check your email inbox for a confirmation.", 'mailchimp-top-bar'),
31 |         'text_error' => __("Oops. Something went wrong.", 'mailchimp-top-bar'),
32 |         'text_invalid_email' => __('That email seems to be invalid.', 'mailchimp-top-bar'),
33 |         'text_already_subscribed' => __("You are already subscribed. Thank you!", 'mailchimp-top-bar'),
34 |         'disable_on_pages' => '',
35 |     ];
36 | 
37 |     $options = (array) get_option('mailchimp_top_bar', []);
38 |     $options = array_merge($defaults, $options);
39 | 
40 |     // for BC with MailChimp Top Bar v1.2.3, always fill text option keys
41 |     $text_keys = [
42 |         'text_subscribed',
43 |         'text_error',
44 |         'text_invalid_email',
45 |         'text_already_subscribed'
46 |     ];
47 | 
48 |     foreach ($text_keys as $text_key) {
49 |         if (empty($options[ $text_key ]) && ! empty($defaults[ $text_key ])) {
50 |             $options[ $text_key ] = $defaults[ $text_key ];
51 |         }
52 |     }
53 | 
54 |     return $options;
55 | }
56 | 


--------------------------------------------------------------------------------
/mailchimp-top-bar.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 | Plugin Name: MC4WP: Mailchimp Top Bar
 5 | Plugin URI: https://www.mc4wp.com/
 6 | Description: Adds a Mailchimp opt-in bar to the top of your site.
 7 | Version: 1.7.3
 8 | Author: ibericode
 9 | Author URI: https://www.ibericode.com/
10 | Text Domain: mailchimp-top-bar
11 | Domain Path: /languages
12 | License: GPL-3.0-or-later
13 | License URI: http://www.gnu.org/licenses/gpl-3.0.html
14 | 
15 | Mailchimp Top Bar
16 | Copyright (C) 2015, Danny van Kooten, hi@dannyvankooten.com
17 | 
18 | This program is free software: you can redistribute it and/or modify
19 | it under the terms of the GNU General Public License as published by
20 | the Free Software Foundation, either version 3 of the License, or
21 | (at your option) any later version.
22 | 
23 | This program is distributed in the hope that it will be useful,
24 | but WITHOUT ANY WARRANTY; without even the implied warranty of
25 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26 | GNU General Public License for more details.
27 | 
28 | You should have received a copy of the GNU General Public License
29 | along with this program.  If not, see <https://www.gnu.org/licenses/>.
30 | */
31 | 
32 | 
33 | defined('ABSPATH') or exit;
34 | 
35 | add_action('plugins_loaded', function () {
36 |     // check for PHP 7.3 or higher
37 |     if (PHP_VERSION_ID < 70300) {
38 |         return;
39 |     }
40 | 
41 |     // check for MailChimp for WordPress (version 3.0 or higher)
42 |     if (!defined('MC4WP_VERSION') || version_compare(MC4WP_VERSION, '3.0', '<')) {
43 |         require __DIR__ . '/src/admin-notice-install-deps.php';
44 |         return;
45 |     }
46 | 
47 | 
48 |     define('MAILCHIMP_TOP_BAR_FILE', __FILE__);
49 |     define('MAILCHIMP_TOP_BAR_DIR', __DIR__);
50 |     define('MAILCHIMP_TOP_BAR_VERSION', '1.7.3');
51 | 
52 |     require __DIR__ . '/src/functions.php';
53 | 
54 |     if (is_admin()) {
55 |         require __DIR__ . '/src/Admin.php';
56 |         $admin = new Mailchimp\TopBar\Admin();
57 |         $admin->add_hooks();
58 |     } else {
59 |         require __DIR__ . '/src/Bar.php';
60 |         $bar = new MailChimp\TopBar\Bar();
61 |         add_action('wp', [$bar, 'init']);
62 |     }
63 | }, 30);
64 | 


--------------------------------------------------------------------------------
/assets/src/js/loader.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * @param {HTMLElement} button
 3 |  */
 4 | function getButtonText (button) {
 5 |   return button.innerHTML ? button.innerHTML : button.value
 6 | }
 7 | 
 8 | /**
 9 |  * @param {HTMLElement} button
10 |  * @param {string} text
11 |  */
12 | function setButtonText (button, text) {
13 |   button.innerHTML ? button.innerHTML = text : button.value = text
14 | }
15 | 
16 | /**
17 |  * @param {HTMLFormElement} formElement
18 |  */
19 | function Loader (formElement) {
20 |   this.form = formElement
21 |   this.button = formElement.querySelector('input[type="submit"],button[type="submit"]')
22 |   this.char = '\u00B7'
23 | 
24 |   if (this.button) {
25 |     this.originalButton = this.button.cloneNode(true)
26 |   }
27 | 
28 |   this.start()
29 | }
30 | 
31 | /**
32 |  * @param {string} c
33 |  */
34 | Loader.prototype.setCharacter = function (c) {
35 |   this.char = c
36 | }
37 | 
38 | /**
39 |  * Start the loading indicator
40 |  */
41 | Loader.prototype.start = function () {
42 |   if (this.button) {
43 |     // loading text
44 |     const loadingText = this.button.getAttribute('data-loading-text')
45 |     if (loadingText) {
46 |       setButtonText(this.button, loadingText)
47 |       return
48 |     }
49 | 
50 |     // Show AJAX loader
51 |     const styles = window.getComputedStyle(this.button)
52 |     this.button.style.width = styles.width
53 |     setButtonText(this.button, this.char)
54 |     this.loadingInterval = window.setInterval(this.tick.bind(this), 500)
55 |   } else {
56 |     this.form.style.opacity = '0.5'
57 |   }
58 | }
59 | 
60 | /**
61 |  * Single step in the loading indicator's "animation"
62 |  */
63 | Loader.prototype.tick = function () {
64 |   // count chars, start over at 5
65 |   const text = getButtonText(this.button)
66 |   const loadingChar = this.char
67 |   setButtonText(this.button, text.length >= 5 ? loadingChar : text + ' ' + loadingChar)
68 | }
69 | 
70 | /**
71 |  * Stops the loading indicator
72 |  */
73 | Loader.prototype.stop = function () {
74 |   if (this.button) {
75 |     this.button.style.width = this.originalButton.style.width
76 |     const text = getButtonText(this.originalButton)
77 |     setButtonText(this.button, text)
78 |     window.clearInterval(this.loadingInterval)
79 |   } else {
80 |     this.form.style.opacity = ''
81 |   }
82 | }
83 | 
84 | export default Loader
85 | 


--------------------------------------------------------------------------------
/create-version.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash 
 2 | 
 3 | set -euo pipefail
 4 | 
 5 | # Check if VERSION argument was supplied
 6 | if [ "$#" -lt 1 ]; then
 7 |     echo "1 parameters expected, $# found"
 8 |     echo "Usage: package.sh <VERSION>"
 9 |     exit 1
10 | fi
11 | 
12 | PLUGIN_SLUG=$(basename "$PWD")
13 | PLUGIN_FILE="$PLUGIN_SLUG.php"
14 | VERSION=$1
15 | PACKAGE_FILE="$PWD/../$PLUGIN_SLUG-$VERSION.zip"
16 | 
17 | # Check if we're inside plugin directory
18 | if [ ! -e "$PLUGIN_FILE" ]; then
19 |   echo "Plugin entry file not found. Please run this command from inside the $PLUGIN_SLUG directory."
20 |   exit 1
21 | fi
22 | 
23 | # Check if there are uncommitted changes
24 | if [ -n "$(git status --porcelain)" ]; then
25 |   echo "There are uncommitted changes. Please commit those changes before initiating a release."
26 |   exit 1
27 | fi
28 | 
29 | # Check if there is an existing file for this release already
30 | rm -f "$PACKAGE_FILE"
31 | 
32 | # Build (optimized) client-side assets
33 | npm run build
34 | 
35 | # Update version numbers in code
36 | sed -i "s/^Version: .*$/Version: $VERSION/g" "$PLUGIN_FILE"
37 | sed -i "s/define('\(.*_VERSION\)', '.*');/define('\1', '$VERSION');/g" "$PLUGIN_FILE"
38 | sed -i "s/^Stable tag: .*$/Stable tag: $VERSION/g" "readme.txt"
39 | 
40 | # Copy over changelog from CHANGELOG.md to readme.txt
41 | # Ref: https://git.sr.ht/~dvko/dotfiles/tree/master/item/bin/wp-update-changelog
42 | wp-update-changelog
43 | 
44 | # Move up one directory level because we need plugin directory in ZIP file
45 | cd ..
46 | 
47 | # Create archive (excl. development files)
48 | zip -r "$PACKAGE_FILE" "$PLUGIN_SLUG" \
49 | 	-x "$PLUGIN_SLUG/.*" \
50 | 	-x "$PLUGIN_SLUG/vendor/*" \
51 | 	-x "$PLUGIN_SLUG/node_modules/*" \
52 | 	-x "$PLUGIN_SLUG/tests/*" \
53 | 	-x "$PLUGIN_SLUG/webpack.config*.js" \
54 |     -x "$PLUGIN_SLUG/*.json" \
55 | 	-x "$PLUGIN_SLUG/*.lock" \
56 | 	-x "$PLUGIN_SLUG/phpcs.xml" \
57 | 	-x "$PLUGIN_SLUG/phpunit.xml.dist" \
58 | 	-x "$PLUGIN_SLUG/*.sh" \
59 | 	-x "$PLUGIN_SLUG/assets/src/*"	\
60 | 	-x "$PLUGIN_SLUG/sample-code-snippets/*"
61 | 
62 | cd "$PLUGIN_SLUG"
63 | 
64 | SIZE=$(ls -lh "$PACKAGE_FILE" | cut -d' ' -f5)
65 | echo "$(basename "$PACKAGE_FILE") created ($SIZE)"
66 | 
67 | # # Create tag in Git and push to remote
68 | git add . -A
69 | git commit -m "v$VERSION"
70 | git tag "$VERSION"
71 | git push origin main
72 | git push origin "tags/$VERSION"
73 | 


--------------------------------------------------------------------------------
/composer.lock:
--------------------------------------------------------------------------------
  1 | {
  2 |     "_readme": [
  3 |         "This file locks the dependencies of your project to a known state",
  4 |         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
  5 |         "This file is @generated automatically"
  6 |     ],
  7 |     "content-hash": "460ae9ad90b58faf96aef91fa960724f",
  8 |     "packages": [],
  9 |     "packages-dev": [
 10 |         {
 11 |             "name": "squizlabs/php_codesniffer",
 12 |             "version": "3.11.2",
 13 |             "source": {
 14 |                 "type": "git",
 15 |                 "url": "https://github.com/PHPCSStandards/PHP_CodeSniffer.git",
 16 |                 "reference": "1368f4a58c3c52114b86b1abe8f4098869cb0079"
 17 |             },
 18 |             "dist": {
 19 |                 "type": "zip",
 20 |                 "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/1368f4a58c3c52114b86b1abe8f4098869cb0079",
 21 |                 "reference": "1368f4a58c3c52114b86b1abe8f4098869cb0079",
 22 |                 "shasum": ""
 23 |             },
 24 |             "require": {
 25 |                 "ext-simplexml": "*",
 26 |                 "ext-tokenizer": "*",
 27 |                 "ext-xmlwriter": "*",
 28 |                 "php": ">=5.4.0"
 29 |             },
 30 |             "require-dev": {
 31 |                 "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.3.4"
 32 |             },
 33 |             "bin": [
 34 |                 "bin/phpcbf",
 35 |                 "bin/phpcs"
 36 |             ],
 37 |             "type": "library",
 38 |             "extra": {
 39 |                 "branch-alias": {
 40 |                     "dev-master": "3.x-dev"
 41 |                 }
 42 |             },
 43 |             "notification-url": "https://packagist.org/downloads/",
 44 |             "license": [
 45 |                 "BSD-3-Clause"
 46 |             ],
 47 |             "authors": [
 48 |                 {
 49 |                     "name": "Greg Sherwood",
 50 |                     "role": "Former lead"
 51 |                 },
 52 |                 {
 53 |                     "name": "Juliette Reinders Folmer",
 54 |                     "role": "Current lead"
 55 |                 },
 56 |                 {
 57 |                     "name": "Contributors",
 58 |                     "homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer/graphs/contributors"
 59 |                 }
 60 |             ],
 61 |             "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.",
 62 |             "homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer",
 63 |             "keywords": [
 64 |                 "phpcs",
 65 |                 "standards",
 66 |                 "static analysis"
 67 |             ],
 68 |             "support": {
 69 |                 "issues": "https://github.com/PHPCSStandards/PHP_CodeSniffer/issues",
 70 |                 "security": "https://github.com/PHPCSStandards/PHP_CodeSniffer/security/policy",
 71 |                 "source": "https://github.com/PHPCSStandards/PHP_CodeSniffer",
 72 |                 "wiki": "https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki"
 73 |             },
 74 |             "funding": [
 75 |                 {
 76 |                     "url": "https://github.com/PHPCSStandards",
 77 |                     "type": "github"
 78 |                 },
 79 |                 {
 80 |                     "url": "https://github.com/jrfnl",
 81 |                     "type": "github"
 82 |                 },
 83 |                 {
 84 |                     "url": "https://opencollective.com/php_codesniffer",
 85 |                     "type": "open_collective"
 86 |                 }
 87 |             ],
 88 |             "time": "2024-12-11T16:04:26+00:00"
 89 |         }
 90 |     ],
 91 |     "aliases": [],
 92 |     "minimum-stability": "stable",
 93 |     "stability-flags": {},
 94 |     "prefer-stable": false,
 95 |     "prefer-lowest": false,
 96 |     "platform": {
 97 |         "php": ">=7.2"
 98 |     },
 99 |     "platform-dev": {},
100 |     "plugin-api-version": "2.6.0"
101 | }
102 | 


--------------------------------------------------------------------------------
/assets/src/css/bar.css:
--------------------------------------------------------------------------------
  1 | #mailchimp-top-bar form,
  2 | #mailchimp-top-bar input,
  3 | #mailchimp-top-bar label {
  4 |     vertical-align: middle;
  5 |     margin: 0;
  6 |     padding: 0;
  7 |     box-shadow: none;
  8 |     text-shadow: none;
  9 |     font-size: 100%;
 10 |     outline: 0;
 11 |     height: auto;
 12 |     line-height: initial;
 13 |     float: none;
 14 |     box-sizing: border-box;
 15 | }
 16 | 
 17 | #mailchimp-top-bar input,
 18 | #mailchimp-top-bar label {
 19 |     display: inline-block !important;
 20 |     vertical-align: middle !important;
 21 |     width: auto;
 22 | }
 23 | 
 24 | #mailchimp-top-bar form {
 25 |     text-align: center;
 26 |     margin: 0 !important;
 27 |     padding: 0 !important;
 28 | }
 29 | 
 30 | #mailchimp-top-bar label {
 31 |     margin: 0 6px 0 0;
 32 | }
 33 | 
 34 | #mailchimp-top-bar input,
 35 | #mailchimp-top-bar input[type="text"],
 36 | #mailchimp-top-bar input[type="email"],
 37 | #mailchimp-top-bar .mctb-email,
 38 | #mailchimp-top-bar .mctb-button {
 39 |     margin: 0 0 0 6px;
 40 |     border: 1px solid white;
 41 |     background: white;
 42 |     height: auto;
 43 | }
 44 | 
 45 | #mailchimp-top-bar .mctb-email {
 46 |     width: 100%;
 47 |     /* this is important because otherwise the field will stack horizontally */
 48 |     max-width: 240px !important;
 49 | }
 50 | 
 51 | #mailchimp-top-bar .mctb-button {
 52 |     margin-left: 0;
 53 |     cursor: pointer;
 54 | }
 55 | 
 56 | #mailchimp-top-bar .mctb-email-confirm {
 57 |     display: none !important;
 58 | }
 59 | 
 60 | #mailchimp-top-bar.mctb-small {
 61 |     font-size: 10px;
 62 | }
 63 | 
 64 | #mailchimp-top-bar.mctb-small .mctb-bar {
 65 |     padding: 5px 6px;
 66 | }
 67 | 
 68 | #mailchimp-top-bar.mctb-small .mctb-button {
 69 |     padding: 4px 12px;
 70 | }
 71 | 
 72 | #mailchimp-top-bar.mctb-small input,
 73 | #mailchimp-top-bar.mctb-small .mctb-email,
 74 | #mailchimp-top-bar.mctb-small .mctb-label {
 75 |     padding: 4px 6px !important;
 76 | }
 77 | 
 78 | #mailchimp-top-bar.mctb-small label,
 79 | #mailchimp-top-bar.mctb-small input {
 80 |     font-size: 12px;
 81 | }
 82 | 
 83 | #mailchimp-top-bar.mctb-small .mctb-close {
 84 |     padding: 4px 12px;
 85 |     font-size: 16px;
 86 | }
 87 | 
 88 | #mailchimp-top-bar.mctb-medium {
 89 |     font-size: 12.5px;
 90 | }
 91 | 
 92 | #mailchimp-top-bar.mctb-medium .mctb-bar {
 93 |     padding: 6.25px 7.5px;
 94 | }
 95 | 
 96 | #mailchimp-top-bar.mctb-medium .mctb-button {
 97 |     padding: 5px 15px;
 98 | }
 99 | 
100 | #mailchimp-top-bar.mctb-medium input,
101 | #mailchimp-top-bar.mctb-medium .mctb-email,
102 | #mailchimp-top-bar.mctb-medium .mctb-label {
103 |     padding: 5px 7.5px !important;
104 | }
105 | 
106 | #mailchimp-top-bar.mctb-medium label,
107 | #mailchimp-top-bar.mctb-medium input {
108 |     font-size: 15px;
109 | }
110 | 
111 | #mailchimp-top-bar.mctb-medium .mctb-close {
112 |     padding: 5px 15px;
113 |     font-size: 20px;
114 | }
115 | 
116 | #mailchimp-top-bar.mctb-big {
117 |     font-size: 15px;
118 | }
119 | 
120 | #mailchimp-top-bar.mctb-big .mctb-bar {
121 |     padding: 7.5px 9px;
122 | }
123 | 
124 | #mailchimp-top-bar.mctb-big .mctb-button {
125 |     padding: 6px 18px;
126 | }
127 | 
128 | #mailchimp-top-bar.mctb-big input,
129 | #mailchimp-top-bar.mctb-big .mctb-email,
130 | #mailchimp-top-bar.mctb-big .mctb-label {
131 |     padding: 6px 9px !important;
132 | }
133 | 
134 | #mailchimp-top-bar.mctb-big label,
135 | #mailchimp-top-bar.mctb-big input {
136 |     font-size: 18px;
137 | }
138 | 
139 | #mailchimp-top-bar.mctb-big .mctb-close {
140 |     padding: 6px 18px;
141 |     font-size: 24px;
142 | }
143 | 
144 | @media (max-width: 580px) {
145 |     #mailchimp-top-bar input,
146 |     #mailchimp-top-bar label,
147 |     #mailchimp-top-bar .mctb-email,
148 |     #mailchimp-top-bar .mctb-label {
149 |         width: 100%;
150 |         max-width: 100% !important;
151 |     }
152 | 
153 |     #mailchimp-top-bar input,
154 |     #mailchimp-top-bar .mctb-email {
155 |         margin: 6px 0 0 !important;
156 |     }
157 | }
158 | 
159 | @media (max-width: 860px) {
160 |     #mailchimp-top-bar.multiple-input-fields .mctb-label {
161 |         display: block !important;
162 |         margin: 0 0 6px;
163 |     }
164 | }
165 | 
166 | /* make sure z-index is slightly below that of admin bar (for dropdown items) */
167 | .admin-bar .mctb {
168 |     z-index: 99998;
169 | }
170 | 
171 | .admin-bar .mctb-position-top {
172 |     top: 32px;
173 | }
174 | 
175 | @media screen and (max-width: 782px) {
176 |     .admin-bar .mctb-position-top {
177 |         top: 46px;
178 |     }
179 | }
180 | 
181 | /* admin bar is non-sticky on small screens */
182 | @media screen and (max-width: 600px) {
183 |     .admin-bar .mctb-position-top.mctb-sticky {
184 |         top: 0;
185 |     }
186 | }
187 | 
188 | .mctb {
189 |     position: absolute;
190 |     top: 0;
191 |     left: 0;
192 |     right: 0;
193 |     width: 100%;
194 |     margin: 0;
195 |     background: transparent;
196 |     text-align: center;
197 |     z-index: 100000;
198 | }
199 | 
200 | .mctb-bar {
201 | 	overflow: hidden;
202 |     position: relative;
203 |     width: 100%;
204 | }
205 | 
206 | .mctb-sticky {
207 |     position: fixed;
208 | }
209 | 
210 | .mctb-position-bottom {
211 |     position: fixed;
212 |     bottom: 0;
213 |     top: auto;
214 | }
215 | 
216 | .mctb-position-bottom .mctb-bar {
217 |     clear: both;
218 | }
219 | 
220 | .mctb-response {
221 |     position: absolute;
222 |     z-index: 100;
223 |     top: 0;
224 |     left: 0;
225 |     width: 100%;
226 |     transition-duration: 800ms;
227 | }
228 | 
229 | .mctb-close {
230 |     display: inline-block;
231 |     float: right;
232 |     margin-right: 12px;
233 |     cursor: pointer;
234 |     clear: both;
235 |     z-index: 10;
236 |     line-height: initial;
237 | }
238 | 
239 | .mctb-icon-inside-bar.mctb-position-bottom .mctb-bar {
240 |     position: absolute;
241 |     bottom: 0;
242 | }
243 | 
244 | .mctb-icon-inside-bar .mctb-close {
245 |     float: none;
246 |     position: absolute;
247 |     top: 0;
248 |     right: 0;
249 | }
250 | 


--------------------------------------------------------------------------------
/src/Admin.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 | Mailchimp Top Bar
  5 | Copyright (C) 2015, Danny van Kooten, hi@dannyvankooten.com
  6 | 
  7 | This program is free software: you can redistribute it and/or modify
  8 | it under the terms of the GNU General Public License as published by
  9 | the Free Software Foundation, either version 3 of the License, or
 10 | (at your option) any later version.
 11 | 
 12 | This program is distributed in the hope that it will be useful,
 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of
 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 15 | GNU General Public License for more details.
 16 | 
 17 | You should have received a copy of the GNU General Public License
 18 | along with this program.  If not, see <https://www.gnu.org/licenses/>.
 19 | */
 20 | namespace MailChimp\TopBar;
 21 | 
 22 | class Admin
 23 | {
 24 |     /**
 25 |      * Add plugin hooks
 26 |      */
 27 |     public function add_hooks()
 28 |     {
 29 |         add_action('admin_init', [ $this, 'init' ], 10, 0);
 30 |         add_action('admin_footer_text', [ $this, 'footer_text' ], 11, 1);
 31 |         add_filter('mc4wp_admin_menu_items', [ $this, 'add_menu_item' ], 10, 1);
 32 |         add_action('mc4wp_admin_enqueue_assets', [ $this, 'load_assets' ], 10, 2);
 33 |     }
 34 | 
 35 |     /**
 36 |      * Runs on `admin_init`
 37 |      */
 38 |     public function init()
 39 |     {
 40 |         // only run for administrators
 41 |         // TODO: Use mc4wp capability here
 42 |         if (! current_user_can('manage_options')) {
 43 |             return;
 44 |         }
 45 | 
 46 |         // register settings
 47 |         register_setting('mailchimp_top_bar', 'mailchimp_top_bar', [ $this, 'sanitize_settings' ]);
 48 | 
 49 |         // add link to settings page from plugins page
 50 |         add_filter('plugin_action_links_' . plugin_basename(MAILCHIMP_TOP_BAR_FILE), [ $this, 'add_plugin_settings_link' ]);
 51 |         add_filter('plugin_row_meta', [ $this, 'add_plugin_meta_links'], 10, 2);
 52 |     }
 53 | 
 54 |     /**
 55 |      * Register menu pages
 56 |      *
 57 |      * @param array $items
 58 |      *
 59 |      * @return array
 60 |      */
 61 |     public function add_menu_item(array $items)
 62 |     {
 63 |             $item = [
 64 |                 'title' => esc_html__('Mailchimp Top Bar', 'mailchimp-top-bar'),
 65 |                 'text' => esc_html__('Top Bar', 'mailchimp-top-bar'),
 66 |                 'slug' => 'top-bar',
 67 |                 'callback' => [$this, 'show_settings_page']
 68 |             ];
 69 | 
 70 |             // insert item before the last menu item
 71 |             \array_splice($items, \count($items) - 1, 0, [ $item ]);
 72 |             return $items;
 73 |     }
 74 | 
 75 |     /**
 76 |      * Add the settings link to the Plugins overview
 77 |      *
 78 |      * @param array $links
 79 |      * @return array
 80 |      */
 81 |     public function add_plugin_settings_link(array $links)
 82 |     {
 83 |         $link_href = esc_attr(admin_url('admin.php?page=mailchimp-for-wp-top-bar'));
 84 |         $link_title = esc_html__('Settings', 'mailchimp-for-wp');
 85 |         $settings_link = "<a href=\"{$link_href}\">{$link_title}</a>";
 86 |         \array_unshift($links, $settings_link);
 87 |         return $links;
 88 |     }
 89 | 
 90 |     /**
 91 |      * Adds meta links to the plugin in the WP Admin > Plugins screen
 92 |      *
 93 |      * @param array $links
 94 |      * @param string $file
 95 |      * @return array
 96 |      */
 97 |     public function add_plugin_meta_links(array $links, $file)
 98 |     {
 99 |         if ($file !== plugin_basename(MAILCHIMP_TOP_BAR_FILE)) {
100 |             return $links;
101 |         }
102 | 
103 |         $links[] = \sprintf(esc_html__('An add-on for %s', 'mailchimp-top-bar'), '<a href="https://www.mc4wp.com/">Mailchimp for WordPress</a>');
104 |         return $links;
105 |     }
106 | 
107 |     /**
108 |      * Load assets if we're on the settings page of this plugin
109 |      *
110 |      * @param string $suffix
111 |      * @param string $page
112 |      * @return void
113 |      */
114 |     public function load_assets($suffix, $page)
115 |     {
116 |         if ($page !== 'top-bar') {
117 |             return;
118 |         }
119 | 
120 |         wp_enqueue_style('wp-color-picker');
121 |         wp_enqueue_script('mailchimp-top-bar-admin', $this->asset_url("/admin.js"), [ 'jquery', 'wp-color-picker' ], MAILCHIMP_TOP_BAR_VERSION, true);
122 |     }
123 | 
124 |     /**
125 |      * Outputs the settings page
126 |      */
127 |     public function show_settings_page()
128 |     {
129 |         $current_tab = isset($_GET['tab']) ? $_GET['tab'] : 'settings';
130 |         $options = mctb_get_options();
131 |         $mailchimp = new \MC4WP_MailChimp();
132 |         $lists = $mailchimp->get_lists();
133 | 
134 |         require MAILCHIMP_TOP_BAR_DIR . '/views/settings-page.php';
135 |     }
136 | 
137 |     /**
138 |      * @param string $url
139 |      * @return string
140 |      */
141 |     protected function asset_url($url)
142 |     {
143 |         return plugins_url('/assets' . $url, MAILCHIMP_TOP_BAR_FILE);
144 |     }
145 | 
146 |     /**
147 |      * @param string $option_name
148 |      * @return string
149 |      */
150 |     protected function name_attr($option_name)
151 |     {
152 |         return "mailchimp_top_bar[{$option_name}]";
153 |     }
154 | 
155 |     /**
156 |      * @param array $dirty
157 |      * @return array $clean
158 |      */
159 |     public function sanitize_settings(array $dirty)
160 |     {
161 |         $unfiltered_html = current_user_can('unfiltered_html');
162 |         $clean = $dirty;
163 |         $safe_attributes = [
164 |             'class' => [],
165 |             'id' => [],
166 |             'title' => [],
167 |             'tabindex' => [],
168 |         ];
169 |         $unsafe_attributes = \array_merge($safe_attributes, ['href' => []]);
170 |         $allowed_html = [
171 |             'strong' => $safe_attributes,
172 |             'b' => $safe_attributes,
173 |             'em' => $safe_attributes,
174 |             'i' => $safe_attributes,
175 |             'u' => $safe_attributes,
176 |             // only allow href attribute on <a> elements if user has unfiltered_html capability
177 |             'a' => $unfiltered_html ? $unsafe_attributes : $safe_attributes,
178 |             'span' => $safe_attributes,
179 |         ];
180 | 
181 |         foreach ($clean as $key => $value) {
182 |             // make sure colors start with `#`
183 |             if (\strpos($key, 'color_') === 0) {
184 |                 $value = \strip_tags($value);
185 |                 if ('' !== $value && $value[0] !== '#') {
186 |                     $clean[$key] = '#' . $value;
187 |                 }
188 |             }
189 | 
190 |             // only allow certain HTML elements inside all text settings
191 |             if (\strpos($key, 'text_') === 0) {
192 |                 $clean[$key] = wp_kses(\strip_tags($value, '<strong><b><em><i><u><a><span>'), $allowed_html);
193 |             }
194 |         }
195 | 
196 | 
197 |         // make sure size is either `small`, `medium` or `big`
198 |         if (! in_array($dirty['size'], ['small', 'medium', 'big'])) {
199 |             $clean['size'] = 'medium';
200 |         }
201 | 
202 |         if (! in_array($dirty['position'], ['top', 'bottom'])) {
203 |             $clean['position'] = 'top';
204 |         }
205 | 
206 |         // button & email placeholders can have no HTML at all
207 |         $clean['text_button'] = \strip_tags($dirty['text_button']);
208 |         $clean['text_email_placeholder'] = \strip_tags($dirty['text_email_placeholder']);
209 | 
210 |         return $clean;
211 |     }
212 | 
213 |     /**
214 |      * Ask for a plugin review in the WP Admin footer, if this is one of the plugin pages.
215 |      *
216 |      * @param string $text
217 |      * @return string
218 |      */
219 |     public function footer_text($text)
220 |     {
221 |         if (( isset($_GET['page']) && strpos($_GET['page'], 'mailchimp-for-wp-top-bar') === 0 )) {
222 |             $text = 'If you enjoy using <strong>Mailchimp Top Bar</strong>, please leave us a <a href="https://wordpress.org/support/view/plugin-reviews/mailchimp-top-bar?rate=5#postform" target="_blank">★★★★★</a> rating. A <strong style="text-decoration: underline;">huge</strong> thank you in advance!';
223 |         }
224 | 
225 |         return $text;
226 |     }
227 | }
228 | 


--------------------------------------------------------------------------------
/assets/src/js/script.js:
--------------------------------------------------------------------------------
  1 | import cookies from './cookies.js'
  2 | import Loader from './loader.js'
  3 | const COOKIE_NAME = 'mctb_bar_hidden'
  4 | 
  5 | /**
  6 |  * @param {function} fn callback
  7 |  * @param {int} delay in ms
  8 |  */
  9 | function debounce (fn, delay) {
 10 |   let timeout
 11 |   return function () {
 12 |     clearTimeout(timeout)
 13 |     timeout = setTimeout(fn, delay)
 14 |   }
 15 | }
 16 | 
 17 | function Bar () {
 18 |   const wrapperEl = document.getElementById('mailchimp-top-bar')
 19 |   const config = window.mctb
 20 |   const barEl = wrapperEl.querySelector('.mctb-bar')
 21 |   const iconEl = document.createElement('span')
 22 |   const formEl = barEl.querySelector('form')
 23 |   let barHeight
 24 |   let barPadding
 25 |   let responseEl = wrapperEl.querySelector('.mctb-response')
 26 |   let visible = !cookies.exists(COOKIE_NAME)
 27 |   let originalBodyPadding = 0
 28 |   let bodyPadding = 0
 29 |   const isBottomBar = (config.position === 'bottom')
 30 |   const state = config.state
 31 | 
 32 |   // remove "no_js" field (which is used to detect bots and prevent spam)
 33 |   const noJsField = barEl.querySelector('input[name="_mctb_no_js"]')
 34 |   noJsField.parentElement.removeChild(noJsField)
 35 | 
 36 |   formEl.addEventListener('submit', submitForm)
 37 | 
 38 |   // save original bodyPadding
 39 |   if (isBottomBar) {
 40 |     wrapperEl.insertBefore(iconEl, barEl)
 41 |     originalBodyPadding = (parseInt(document.body.style.paddingBottom) || 0)
 42 |   } else {
 43 |     wrapperEl.insertBefore(iconEl, barEl.nextElementSibling)
 44 |     originalBodyPadding = (parseInt(document.body.style.paddingTop) || 0)
 45 |   }
 46 | 
 47 |   // configure icon
 48 |   iconEl.className = 'mctb-close'
 49 |   iconEl.innerHTML = visible ? config.icons.hide : config.icons.show
 50 |   iconEl.addEventListener('click', toggle)
 51 | 
 52 |   // count input fields (3 because of hidden input honeypot)
 53 |   if (barEl.querySelectorAll('input:not([type="hidden"])').length > 3) {
 54 |     wrapperEl.className += ' multiple-input-fields'
 55 |   }
 56 | 
 57 |   // calculate bar size whenever layout shifts or window is resized
 58 |   window.requestAnimationFrame(calculateDimensions)
 59 |   window.addEventListener('load', calculateDimensions)
 60 |   window.addEventListener('resize', debounce(calculateDimensions, 100))
 61 | 
 62 |   // fade response 4 seconds after showing bar
 63 |   if (responseEl) {
 64 |     window.setTimeout(fadeResponse, 4000)
 65 |   }
 66 | 
 67 |   function submitForm (evt) {
 68 |     evt.preventDefault()
 69 | 
 70 |     const loader = new Loader(formEl)
 71 |     const data = new FormData(formEl)
 72 |     const request = new XMLHttpRequest()
 73 |     request.onload = function () {
 74 |       // remove loading indicator
 75 |       loader.stop()
 76 | 
 77 |       // parse json response
 78 |       let response
 79 |       if (this.status >= 200 && this.status < 400) {
 80 |         try {
 81 |           response = JSON.parse(this.responseText)
 82 |         } catch (error) {
 83 |           console.log('MailChimp Top Bar: failed to parse AJAX response.\n\nError: "' + error + '"')
 84 |           return
 85 |         }
 86 | 
 87 |         state.success = !!response.success
 88 |         state.submitted = true
 89 | 
 90 |         // maybe redirect to url from settings
 91 |         if (response.success && response.redirect_url) {
 92 |           window.location.href = response.redirect_url
 93 |           return
 94 |         }
 95 | 
 96 |         showResponseMessage(response.message)
 97 | 
 98 |         // clear form
 99 |         if (state.success) {
100 |           formEl.reset()
101 |         }
102 |       } else {
103 |         // Server error :(
104 |         console.log(this.responseText)
105 |       }
106 |     }
107 |     request.open('POST', window.location.href, true)
108 |     request.setRequestHeader('X-Requested-With', 'XMLHttpRequest')
109 |     request.send(data)
110 |   }
111 | 
112 |   function showResponseMessage (msg) {
113 |     if (responseEl && responseEl.parentElement) {
114 |       responseEl.parentElement.removeChild(responseEl)
115 |     }
116 | 
117 |     responseEl = document.createElement('div')
118 |     responseEl.className = 'mctb-response'
119 | 
120 |     const labelEl = document.createElement('label')
121 |     labelEl.className = 'mctb-response-label'
122 |     labelEl.innerText = msg
123 |     responseEl.appendChild(labelEl)
124 |     formEl.parentElement.insertBefore(responseEl, formEl.nextElementSibling)
125 | 
126 |     calculateDimensions()
127 |     window.setTimeout(fadeResponse, 4000)
128 |   }
129 | 
130 |   function iconFitsInsideBar () {
131 |     // would the close icon fit inside the bar?
132 |     let elementsWidth = 0
133 |     for (let i = 0; i < barEl.firstElementChild.children.length; i++) {
134 |       elementsWidth += barEl.firstElementChild.children[i].clientWidth
135 |     }
136 | 
137 |     return (elementsWidth + iconEl.clientWidth + 200) < barEl.clientWidth
138 |   }
139 | 
140 |   function calculateDimensions () {
141 |     // make sure bar is visible
142 |     if (!visible) {
143 |       barEl.style.visibility = 'hidden'
144 |     }
145 |     barEl.style.display = ''
146 |     barEl.style.height = ''
147 |     barEl.style.paddingTop = ''
148 |     barEl.style.paddingBottom = ''
149 | 
150 |     // measure bar padding and height
151 |     // we use this as our animation target values
152 |     const styles = window.getComputedStyle(barEl)
153 |     barHeight = styles.height
154 |     barPadding = styles.paddingTop
155 | 
156 |     // calculate & set new body padding if bar is currently visible
157 |     bodyPadding = (originalBodyPadding + barEl.clientHeight) + 'px'
158 |     if (visible) {
159 |       document.body.style[isBottomBar ? 'paddingBottom' : 'paddingTop'] = bodyPadding
160 |     }
161 | 
162 |     wrapperEl.className = wrapperEl.className.replace('mctb-icon-inside-bar', '')
163 |     if (iconFitsInsideBar()) {
164 |       wrapperEl.className += ' mctb-icon-inside-bar'
165 | 
166 |       // since icon is now absolutely positioned, we need to set a min height
167 |       if (isBottomBar) {
168 |         wrapperEl.style.minHeight = iconEl.clientHeight + 'px'
169 |       }
170 |     }
171 | 
172 |     // fix response height
173 |     if (responseEl) {
174 |       responseEl.style.height = barEl.clientHeight + 'px'
175 |       responseEl.style.lineHeight = barEl.clientHeight + 'px'
176 |     }
177 | 
178 |     // reset bar again, we're done measuring
179 |     barEl.style.visibility = ''
180 |     barEl.style.height = visible ? barHeight : 0
181 |     barEl.style.paddingTop = visible ? barPadding : 0
182 |     barEl.style.paddingBottom = visible ? barPadding : 0
183 |   }
184 | 
185 |   /**
186 |    * @param {Event} evt
187 |    */
188 |   function removeTransition (evt) {
189 |     evt.target.style.transition = ''
190 |     evt.target.removeEventListener('transitionend', removeTransition)
191 |   }
192 |   /**
193 |    * @param {HTMLElement} el
194 |    * @param {object} styles
195 |    */
196 |   function animate (el, styles) {
197 |     el.style.transition = 'all 0.6s ease'
198 |     el.addEventListener('transitionend', removeTransition)
199 |     window.requestAnimationFrame(() => css(el, styles))
200 |   }
201 | 
202 |   /**
203 |    * @param {HTMLElement} el
204 |    * @param {object} styles
205 |    */
206 |   function css (el, styles) {
207 |     for (const prop in styles) {
208 |       el.style[prop] = styles[prop]
209 |     }
210 |   }
211 | 
212 |   /**
213 |    * Show the bar
214 |    * @param {boolean} manual
215 |    * @returns {boolean}
216 |    */
217 |   function show (manual) {
218 |     if (visible) {
219 |       return false
220 |     }
221 | 
222 |     const barStyles = {
223 |       height: barHeight,
224 |       paddingTop: barPadding,
225 |       paddingBottom: barPadding
226 |     }
227 |     const bodyStyles = {}
228 |     bodyStyles[isBottomBar ? 'paddingBottom' : 'paddingTop'] = bodyPadding
229 |     if (manual) {
230 |       animate(barEl, barStyles)
231 |       animate(document.body, bodyStyles)
232 |       cookies.erase(COOKIE_NAME)
233 |     } else {
234 |       css(barEl, barStyles)
235 |       css(document.body, bodyStyles)
236 |     }
237 | 
238 |     iconEl.innerHTML = config.icons.hide
239 |     visible = true
240 |     return true
241 |   }
242 | 
243 |   /**
244 |    * Hide the bar
245 |    *
246 |    * @returns {boolean}
247 |    */
248 |   function hide (manual) {
249 |     if (!visible) {
250 |       return false
251 |     }
252 | 
253 |     const barStyles = {
254 |       height: 0,
255 |       paddingBottom: 0,
256 |       paddingTop: 0
257 |     }
258 |     const bodyStyles = {}
259 |     bodyStyles[isBottomBar ? 'paddingBottom' : 'paddingTop'] = originalBodyPadding + 'px'
260 |     if (manual) {
261 |       animate(barEl, barStyles)
262 |       animate(document.body, bodyStyles)
263 |       cookies.create(COOKIE_NAME, state.success ? 'used' : 'hidden', config.cookieLength)
264 |     } else {
265 |       css(barEl, barStyles)
266 |       css(document.body, bodyStyles)
267 |     }
268 | 
269 |     visible = false
270 |     iconEl.innerHTML = config.icons.show
271 |     return true
272 |   }
273 | 
274 |   /**
275 |    * Fade out the response message
276 |    */
277 |   function fadeResponse () {
278 |     if (!responseEl) {
279 |       return
280 |     }
281 | 
282 |     responseEl.style.opacity = '0'
283 |     window.setTimeout(() => {
284 |       // remove response element so form is usable again
285 |       responseEl.parentElement.removeChild(responseEl)
286 | 
287 |       // hide bar if sign-up was successful
288 |       if (state.submitted && state.success) {
289 |         hide(true)
290 |       }
291 |     }, 1000)
292 |   }
293 | 
294 |   /**
295 |    * Toggle visibility of the bar
296 |    *
297 |    * @returns {boolean}
298 |    */
299 |   function toggle () {
300 |     return visible ? hide(true) : show(true)
301 |   }
302 | 
303 |   // Return values
304 |   return {
305 |     element: wrapperEl,
306 |     toggle,
307 |     show,
308 |     hide
309 |   }
310 | }
311 | 
312 | document.addEventListener('DOMContentLoaded', function () {
313 |   window.MailChimpTopBar = new Bar()
314 | })
315 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | Changelog
  2 | ==========
  3 | 
  4 | ### 1.7.3 - Oct 1, 2025
  5 | 
  6 | - Minor performance or memory usage related improvements.
  7 | - Compatibility check with latest WordPress version.
  8 | 
  9 | 
 10 | ### 1.7.1 - Jul 2, 2025
 11 | 
 12 | - Update dependencies and WordPress compatibility.
 13 | - Decrease timestamp check to one second ago.
 14 | 
 15 | 
 16 | ### 1.7.0 - Jan 27, 2025
 17 | 
 18 | - Bump required PHP version to 7.3 or higher.
 19 | - Bump required WordPress version to 4.9 or higher.
 20 | - Remove compatibility code for Mailchimp for WordPress versions before 3.0.
 21 | - Add visitor IP to sign-ups through Top Bar.
 22 | - Fix response not showing up after first trying with an invalid email address.
 23 | - Minor performance improvements troughout the code by explicitly specifying the global namespace on core PHP functions.
 24 | 
 25 | 
 26 | ### 1.6.2 - Oct 3, 2024
 27 | 
 28 | - Fix button text setting not updating after saving settings.
 29 | 
 30 | 
 31 | ### 1.6.1 - Oct 1, 2024
 32 | 
 33 | - Escape return value of `add_query_arg` before outputting, fixing a potential XSS issue. Thanks to vgo0 for the responsible disclosure.
 34 | - Escape or kses return values of all gettext calls.
 35 | - Improved sanitization of all plugin settings.
 36 | - Minor server side performance improvements by getting rid of some unneccessary string copies or sprintf calls.
 37 | 
 38 | 
 39 | ### 1.6.0 - Jan 4, 2023
 40 | 
 41 | - JS file now has `defer` attribute so it is not render blocking.
 42 | - Stylesheet is now inserted through JS, so it is not render blocking.
 43 | - Animations now entirely handled using CSS.
 44 | - JS file is now 20% smaller because of the above (2.6 kB gzipped).
 45 | 
 46 | 
 47 | ### 1.5.6 - Dec 1, 2022
 48 | 
 49 | - Minor JS improvements to shrink ~500 bytes off script file.
 50 | - Prepare admin tab navigation for upcoming [Mailchimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) release.
 51 | 
 52 | 
 53 | #### 1.5.5 - May 14, 2021
 54 | 
 55 | - Always use minified asset file, regardless of `SCRIPT_DEBUG` setting.
 56 | - Add nonce to all URL's using `_mc4wp_action` parameter.
 57 | 
 58 | 
 59 | #### 1.5.4 - May 7, 2021
 60 | 
 61 | - Update classnames to work with MailChimp for WordPress version 4.8.4 (and up).
 62 | - Minor JS optimizations.
 63 | 
 64 | 
 65 | #### 1.5.3 - Mar 30, 2021
 66 | 
 67 | - Fix typo in help text.
 68 | - Show bar server-side to speed-up height calculation.
 69 | 
 70 | 
 71 | #### 1.5.2 - Mar 9, 2020
 72 | 
 73 | - Add setting to disable bar (stop loading it altogether) after it is used.
 74 | - Increase default cookie lifetime to 1 year.
 75 | 
 76 | 
 77 | #### 1.5.1 - Jan 21, 2020
 78 | 
 79 | - Fade response element using CSS animations for better performance.
 80 | - Various minor performance improvements.
 81 | 
 82 | 
 83 | #### 1.5.0 - Oct 7, 2019
 84 | 
 85 | Compatibility with [Mailchimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) version 4.6.
 86 | 
 87 | 
 88 | #### 1.4.1 - Sep 11, 2019
 89 | 
 90 | **Changes**
 91 | 
 92 | - Change name to MC4WP: Mailchimp Top Bar.
 93 | 
 94 | 
 95 | #### 1.4.0 - Sep 4, 2019
 96 | 
 97 | **Improvements**
 98 | 
 99 | - Add (advanced) setting to quickly disable the top bar on certain pages.
100 | 
101 | 
102 | #### 1.3.2 - Aug 8, 2018
103 | 
104 | **Fixes**
105 | 
106 | - Required fields notice on selected list was not showing because of invalid list property.
107 | 
108 | **Improvements**
109 | 
110 | - Prefix internal CSS classes for improved compatibility with other themes or plugins applying global admin styles.
111 | 
112 | 
113 | #### 1.3.1 - May 29, 2018
114 | 
115 | **Improvements**
116 | 
117 | - 30% reduction in script file size because of removed JS dependency.
118 | - Stop setting unused cookie when Top Bar form is used to subscribe.
119 | - Add mctb_after_submit_button action hook.
120 | - Improve animation performance.
121 | 
122 | 
123 | #### 1.3 - November 1, 2017
124 | 
125 | **Improvements**
126 | 
127 | - Form now submits over AJAX, no longer reloading the entire page.
128 | - Added `for` attribute to label elements, thanks [gabriel-kaam](https://github.com/gabriel-kaam).
129 | - Added `mctb_replace_interests` filter hook.
130 | 
131 | #### 1.2.16 - January 19, 2017
132 | 
133 | Various minor code improvements.
134 | 
135 | 
136 | #### 1.2.15 - September 8, 2016
137 | 
138 | **Improvements**
139 | 
140 | - Improved responsiveness when bar has additional input fields.
141 | - Add `required` attribute to email input.
142 | 
143 | 
144 | #### 1.2.14 - August 29, 2016
145 | 
146 | **Fixes**
147 | 
148 | - Top padding for small screens with admin bar.
149 | 
150 | **Improvements**
151 | 
152 | - Better bar responsiveness when window dimensions change on the fly (eg resizing a window or changing device orientation mode). (Thanks [tech4him1](https://github.com/tech4him1)!)
153 | 
154 | 
155 | #### 1.2.13 - August 2, 2016
156 | 
157 | **Fixes**
158 | 
159 | - Error in animating body padding back to its original value.
160 | 
161 | 
162 | #### 1.2.12 - July 21, 2016
163 | 
164 | **Fixes**
165 | 
166 | - Bar would crash when clicking toggle icon during bar animation.
167 | 
168 | **Improvements**
169 | 
170 | - Function scope generated JavaScript file to prevent Browserify clashes with other loaded scripts.
171 | - Make sure script works even though it's loaded in the head section.
172 | - Preparations for upcoming Mailchimp for WordPress v4.0 release.
173 | 
174 | **Additions**
175 | 
176 | - Added Spanish language files, thanks to [Ángel Guzmán Maeso](http://shakaran.net/)
177 | - Added `mctb_data` filter, to filter form data before it is processed.
178 | 
179 | **Deprecated**
180 | 
181 | - Deprecated `mctb_merge_vars` filter.
182 | 
183 | 
184 | #### 1.2.11 - July 8, 2016
185 | 
186 | **Improvements**
187 | 
188 | - Completely removed optional jQuery dependency. The plugin now uses JavaScript animations, resulting in a much smoother experience.
189 | 
190 | #### 1.2.10 - April 12, 2016
191 | 
192 | **Fixes**
193 | 
194 | - Closed bar would still overlap underlying elements (like fixed top menu's).
195 | 
196 | 
197 | #### 1.2.9 - March 16, 2016
198 | 
199 | **Fixes**
200 | 
201 | Top Bar was invisible on some themes because of `z-index` being too low.
202 | 
203 | 
204 | #### 1.2.8 - March 15, 2016
205 | 
206 | **Improvements**
207 | 
208 | - Make sure top bar doesn't appear on top of WP admin bar.
209 | - Hardened CSS styles for improved theme compatability.
210 | 
211 | 
212 | #### 1.2.7 - January 26, 2016
213 | 
214 | **Improvements**
215 | 
216 | - Miscellaneous code improvements
217 | 
218 | **Additions**
219 | 
220 | - Add support for new [debug log](https://www.mc4wp.com/kb/how-to-enable-log-debugging/) in Mailchimp for WordPress 3.1
221 | 
222 | 
223 | #### 1.2.6 - January 4, 2016
224 | 
225 |  **Additions**
226 | 
227 |  - Option to "update existing subscribers" in Mailchimp, which is useful if you have added fields.
228 | 
229 |  **Improvements**
230 | 
231 |  - Toggle icon now has a background color, for increased visibility.
232 |  - Toggle icon now stacks above or below bar on small screens.
233 | 
234 | #### 1.2.5 - December 10, 2015
235 | 
236 | The plugin now requires [Mailchimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) version 3.0 or higher.
237 | 
238 | **Fixes**
239 | 
240 | - Fixed column alignment in Appearance tab, thanks [Chantal Coolsma](https://github.com/chantalcoolsma)!
241 | 
242 | **Improvements**
243 | 
244 | - Improved admin notice when dependencies are not installed.
245 | 
246 | 
247 | #### 1.2.4 - November 22, 2015
248 | 
249 | - Compatibility for [the upcoming Mailchimp for WordPress 3.0 release](https://www.mc4wp.com/blog/breaking-backwards-compatibility-in-version-3-0/) tomorrow.
250 | - Added `mctb_subscribed` filter.
251 | 
252 | #### 1.2.3 - November 13, 2015
253 | 
254 | **Improvements**
255 | 
256 | - Minor refactoring in the way the plugin is bootstrapped.
257 | 
258 | #### 1.2.2 - September 10, 2015
259 | 
260 | **Fixes**
261 | 
262 | - Honeypot field being auto-completed in some browsers.
263 | - Honeypot field was accessible by pressing "tab" key.
264 | - Hardened security for cookie that tracks sign-up attempts.
265 | 
266 | #### 1.2.1 - September 8, 2015
267 | 
268 | **Fixes**
269 | 
270 | - Response message was not showing for some themes.
271 | 
272 | **Improvements**
273 | 
274 | - Better mobile responsiveness
275 | 
276 | 
277 | #### 1.2 - September 3, 2015
278 | 
279 | **Improvements**
280 | 
281 | - The bar will now auto-dismiss after every successful sign-up.
282 | - Placeholders will now work in Internet Explorer 7, 8 & 9 as well.
283 | 
284 | **Additions**
285 | 
286 | - Added options for double opt-in and sending Mailchimp's "welcome email".
287 | - Added `mctb_before_label` action allowing you to add HTML before the label-element.
288 | - Added `mctb_before_email_field` action allowing you to add HTML before the email field.
289 | - Added `mctb_before_submit_button` action allowing you to add HTML before the submit button.
290 | - Added `mctb_form_action` filter allowing you to set a custom form action.
291 | 
292 | #### 1.1.3 - June 23, 2015
293 | 
294 | **Fixes**
295 | 
296 | - Fixes fatal error when visiting settings page on some servers
297 | 
298 | #### 1.1.2 - June 18, 2015
299 | 
300 | **Improvements**
301 | 
302 | - Fixes height of response message
303 | - CSS improvements for compatibility with various popular themes
304 | 
305 | #### 1.1.1 - June 12, 2015
306 | 
307 | **Fixes**
308 | 
309 | - Fixes unclickable admin bar (or fixed navigation menu's).
310 | 
311 | **Improvements**
312 | 
313 | - Various improvements to bar CSS so it can be easily overridden.
314 | - Fix vertical alignment of toggle icon.
315 | 
316 | #### 1.1 - June 10, 2015
317 | 
318 | **Improvements**
319 | 
320 | - Bar no longer requires jQuery script, saving an additional HTTP request and 100kb
321 | 
322 | **Additions**
323 | 
324 | - Position option: top or bottom
325 | - New filter: `mctb_mailchimp_list` (set lists to subscribe to)
326 | - Lithuanian translation, thanks to [Aleksandr Charkov](https://github.com/dec0n)
327 | 
328 | #### 1.0.8 - May 6, 2015
329 | 
330 | **Fixes**
331 | 
332 | - Compatibility with [Mailchimp for WordPress Lite v2.3](https://wordpress.org/plugins/mailchimp-for-wp/) and [Mailchimp for WordPress Pro v2.7](https://www.mc4wp.com/).
333 | 
334 | #### 1.0.7 - April 15, 2015
335 | 
336 | **Fixes**
337 | 
338 | - `mctb_show_bar` filter was not functioning properly with some themes.
339 | - Form always errored when using WPML with String Translations.
340 | 
341 | **Improvements**
342 | 
343 | - Toggle icon is no longer shown for users without JavaScript.
344 | 
345 | #### 1.0.6 - March 17, 2015
346 | 
347 | **Fixes**
348 | 
349 | - Compatibility issues with latest version of Enfold theme
350 | - Conflict with other plugins shipping _very old_ versions of Composer
351 | 
352 | **Improvements**
353 | 
354 | - Allow simple inline tags in the bar text
355 | 
356 | 
357 | #### 1.0.5 - February 25, 2015
358 | 
359 | **Fixes**
360 | 
361 | - Bar not loading in some themes after latest update
362 | - Colors not working because of missing leading `#` value. Color settings are now validated before saving them.
363 | 
364 | #### 1.0.4 - February 23, 2015
365 | 
366 | **Fixes**
367 | 
368 | - Styling issues with Enfold theme.
369 | 
370 | **Additions**
371 | 
372 | - Settings page now uses a tabbed interface.
373 | - You can now set a "redirect url" in the bar settings
374 | - All form response messages can now be customised for the bar form
375 | 
376 | #### 1.0.3 - February 17, 2015
377 | 
378 | **Improvements**
379 | 
380 | - Bar will now show "already subscribed" message from Mailchimp for WordPress when a person is already on the selected list.
381 | - Response message will now show and fadeout after 3 seconds.
382 | - Various usability improvements for the settings screen.
383 | - Improved spam detection.
384 | - Major JS performance improvements.
385 | 
386 | **Additions**
387 | 
388 | - Multiple new anti-spam measures
389 | - WPML compatibility
390 | 
391 | 
392 | #### 1.0.2 - February 12, 2015
393 | 
394 | **Improvements**
395 | 
396 | - Better CSS reset for elements inside the bar
397 | - Other minor CSS improvements
398 | 
399 | **Additions**
400 | 
401 | - Top Bar sign-ups are now shown in the log for [Mailchimp for WordPress Pro](https://www.mc4wp.com/).
402 | 
403 | #### 1.0.1 - February 4, 2015
404 | 
405 | **Fixes**
406 | 
407 | - The plugin will no longer overlap header menu's or other elements
408 | 
409 | **Additions**
410 | 
411 | - You can now set the bar as "sticky", meaning it will stick to the op your window, even when scrolling.
412 | - You can now choose the size of the bar, small/medium/big.
413 | - Added Dutch translation files.
414 | 
415 | **Improvements**
416 | 
417 | - The menu item will now show above the item asking you to upgrade to Mailchimp for WordPress Pro.
418 | 
419 | Please update the [Mailchimp for WordPress plugin](https://wordpress.org/plugins/mailchimp-for-wp/) before updating to this version.
420 | 
421 | #### 1.0 - January 28, 2015
422 | 
423 | Initial release
424 | 


--------------------------------------------------------------------------------
/src/Bar.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 | Mailchimp Top Bar
  5 | Copyright (C) 2015, Danny van Kooten, hi@dannyvankooten.com
  6 | 
  7 | This program is free software: you can redistribute it and/or modify
  8 | it under the terms of the GNU General Public License as published by
  9 | the Free Software Foundation, either version 3 of the License, or
 10 | (at your option) any later version.
 11 | 
 12 | This program is distributed in the hope that it will be useful,
 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of
 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 15 | GNU General Public License for more details.
 16 | 
 17 | You should have received a copy of the GNU General Public License
 18 | along with this program.  If not, see <https://www.gnu.org/licenses/>.
 19 |  */
 20 | 
 21 | namespace MailChimp\TopBar;
 22 | 
 23 | use Exception;
 24 | use MC4WP_MailChimp;
 25 | use MC4WP_Debug_Log;
 26 | use MC4WP_MailChimp_Subscriber;
 27 | use MC4WP_List_Data_Mapper;
 28 | 
 29 | class Bar
 30 | {
 31 |     /**
 32 |      * @var bool
 33 |      */
 34 |     private $success = false;
 35 | 
 36 |     /**
 37 |      * @var string
 38 |      */
 39 |     private $error_type = '';
 40 | 
 41 |     /**
 42 |      * @var bool
 43 |      */
 44 |     private $submitted = false;
 45 | 
 46 |     /**
 47 |      *
 48 |      */
 49 |     public function init()
 50 |     {
 51 |         if (! $this->should_show_bar()) {
 52 |             return;
 53 |         }
 54 | 
 55 |         add_action('wp_enqueue_scripts', [ $this, 'load_assets' ]);
 56 |         add_action('wp_head', [ $this, 'output_css' ], 90);
 57 |         add_action('wp_footer', [ $this, 'output_html' ], 1);
 58 | 
 59 |         $this->listen();
 60 |     }
 61 | 
 62 |     /**
 63 |      * Should the bar be shown?
 64 |      *
 65 |      * @return bool
 66 |      */
 67 |     public function should_show_bar()
 68 |     {
 69 |         $options = mctb_get_options();
 70 | 
 71 |         // don't show if bar is disabled
 72 |         if (! $options['enabled']) {
 73 |             return false;
 74 |         }
 75 | 
 76 |         $show_bar = true;
 77 | 
 78 |         if (! empty($options['disable_on_pages'])) {
 79 |             $disable_on_pages = \explode(',', $options['disable_on_pages']);
 80 |             $disable_on_pages = \array_map('trim', $disable_on_pages);
 81 |             $show_bar         = ! is_page($disable_on_pages);
 82 |         }
 83 | 
 84 |         if ($options['disable_after_use'] && isset($_COOKIE['mctb_bar_hidden']) && $_COOKIE['mctb_bar_hidden'] === 'used') {
 85 |             $show_bar = false;
 86 |         }
 87 | 
 88 |         /**
 89 |          * @deprecated 1.1
 90 |          * @use `mctb_show_bar`
 91 |          */
 92 |         $show_bar = apply_filters('mctp_show_bar', $show_bar);
 93 | 
 94 | 
 95 |         /**
 96 |          * @filter `mctb_show_bar`
 97 |          * @expects boolean
 98 |          *
 99 |          * Set to true if the bar should be loaded for this request, false if not.
100 |          */
101 |         return apply_filters('mctb_show_bar', $show_bar);
102 |     }
103 | 
104 |     /**
105 |      * Listens for actions to take
106 |      */
107 |     public function listen()
108 |     {
109 | 
110 |         if (! isset($_POST['_mctb']) || $_POST['_mctb'] != 1) {
111 |             return;
112 |         }
113 | 
114 |         $options       = mctb_get_options();
115 |         $this->success = $this->process();
116 | 
117 |         if (! empty($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest') {
118 |             $data = [
119 |                 'message'      => $this->get_response_message(),
120 |                 'success'      => $this->success,
121 |                 'redirect_url' => $this->success ? $options['redirect'] : '',
122 |             ];
123 | 
124 |             wp_send_json($data);
125 |             exit;
126 |         }
127 | 
128 |         if ($this->success) {
129 |             // should we redirect
130 |             $redirect_url = $options['redirect'];
131 |             if (! empty($redirect_url)) {
132 |                 wp_redirect($redirect_url);
133 |                 exit;
134 |             }
135 |         }
136 |     }
137 | 
138 |     /**
139 |      * Process a form submission
140 |      * @return boolean
141 |      */
142 |     private function process()
143 |     {
144 |         $options         = mctb_get_options();
145 |         $this->submitted = true;
146 |         $log             = $this->get_log();
147 | 
148 |         /** @var MC4WP_MailChimp_Subscriber $subscriber_data */
149 |         $subscriber = null;
150 |         $result     = false;
151 | 
152 |         if (! $this->validate()) {
153 |             if ($log) {
154 |                 $log->info(sprintf('Top Bar > Submitted with errors: %s', $this->error_type));
155 |             }
156 | 
157 |             return false;
158 |         }
159 | 
160 |         /**
161 |          * Filters the list to which Mailchimp Top Bar subscribes.
162 |          *
163 |          * @param string $list_id
164 |          */
165 |         $mailchimp_list_id = apply_filters('mctb_mailchimp_list', $options['list']);
166 | 
167 |         // check if a Mailchimp list was given
168 |         if (empty($mailchimp_list_id)) {
169 |             $this->error_type = 'error';
170 | 
171 |             if ($log) {
172 |                 $log->warning('Top Bar > No Mailchimp lists were selected');
173 |             }
174 | 
175 |             return false;
176 |         }
177 | 
178 |         $email_address = sanitize_text_field($_POST['email']);
179 |         $data          = [
180 |             'EMAIL' => $email_address,
181 |         ];
182 | 
183 |         /**
184 |          * Filters the data received by Mailchimp Top Bar, before it is further processed.
185 |          *
186 |          * @param $data
187 |          */
188 |         $data = apply_filters('mctb_data', $data);
189 | 
190 |         /** @ignore */
191 |         $data       = apply_filters('mctb_merge_vars', $data);
192 |         $email_type = apply_filters('mctb_email_type', 'html');
193 | 
194 |         $replace_interests = true;
195 | 
196 |         /**
197 |          * Filters whether interests should be replaced or appended to.
198 |          *
199 |          * @param bool $replace_interests
200 |          */
201 |         $replace_interests = apply_filters('mctb_replace_interests', $replace_interests);
202 |         $mailchimp = new MC4WP_MailChimp();
203 | 
204 |         $mapper = new MC4WP_List_Data_Mapper($data, [ $mailchimp_list_id ]);
205 |         $map    = $mapper->map();
206 | 
207 |         foreach ($map as $list_id => $subscriber) {
208 |             $subscriber->email_type = $email_type;
209 |             $subscriber->status     = $options['double_optin'] ? 'pending' : 'subscribed';
210 |             $subscriber->ip_signup = mc4wp_get_request_ip_address();
211 | 
212 |             /** @ignore (documented elsewhere) */
213 |             $subscriber = apply_filters('mc4wp_subscriber_data', $subscriber);
214 | 
215 |             /**
216 |              * Filter subscriber data before it is sent to Mailchimp. Runs only for Mailchimp Top Bar requests.
217 |              *
218 |              * @param MC4WP_MailChimp_Subscriber
219 |              */
220 |             $subscriber = apply_filters('mctb_subscriber_data', $subscriber);
221 | 
222 |             $result = $mailchimp->list_subscribe($mailchimp_list_id, $subscriber->email_address, $subscriber->to_array(), $options['update_existing'], $replace_interests);
223 |             $result = is_object($result) && ! empty($result->id);
224 |         }
225 | 
226 | 
227 |         // return true if success..
228 |         if ($result) {
229 | 
230 |             /**
231 |              * Fires for every successful sign-up using Top Bar.
232 |              *
233 |              * @param string $mailchimp_list_id
234 |              * @param string $email
235 |              * @param array $data
236 |              */
237 |             do_action('mctb_subscribed', $mailchimp_list_id, $email_address, $data);
238 | 
239 |             // log sign-up attempt
240 |             if ($log) {
241 |                 $log->info(sprintf('Top Bar > Successfully subscribed %s', $email_address));
242 |             }
243 | 
244 |             return true;
245 |         }
246 | 
247 |         // An API error occured... Oh noes!
248 |         if ($mailchimp->get_error_code() === 214) {
249 |             $this->error_type = 'already_subscribed';
250 | 
251 |             if ($log) {
252 |                 $log->warning(sprintf('Top Bar > %s is already subscribed to the selected list(s)', $email_address));
253 |             }
254 |         } else {
255 |             $this->error_type = 'error';
256 | 
257 |             if ($log) {
258 |                 $log->error(sprintf('Top Bar > Mailchimp API error: %s', $mailchimp->get_error_message()));
259 |             }
260 |         }
261 | 
262 |         return false;
263 |     }
264 | 
265 |     /**
266 |      * Validate the form submission
267 |      * @return boolean
268 |      */
269 |     private function validate()
270 |     {
271 | 
272 |         // make sure `email_confirm` field is given but not filled (honeypot)
273 |         if (! isset($_POST['email_confirm']) || '' !== $_POST['email_confirm']) {
274 |             $this->error_type = 'spam';
275 |             return false;
276 |         }
277 | 
278 |         // make sure `_mctb_timestamp` is at least 1 seconds ago
279 |         if (empty($_POST['_mctb_timestamp']) || time() < ( intval($_POST['_mctb_timestamp']) + 1 )) {
280 |             $this->error_type = 'spam';
281 |             return false;
282 |         }
283 | 
284 |         // don't work for users without JavaScript (since bar is hidden anyway, must be a bot)
285 |         if (isset($_POST['_mctb_no_js'])) {
286 |             $this->error_type = 'spam';
287 |             return false;
288 |         }
289 | 
290 |         // simple user agent check
291 |         $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : '';
292 |         if (strlen($user_agent) < 2) {
293 |             $this->error_type = 'spam';
294 |             return false;
295 |         }
296 | 
297 |         // check if email is given and valid
298 |         if (empty($_POST['email']) || ! is_string($_POST['email']) || ! is_email($_POST['email'])) {
299 |             $this->error_type = 'invalid_email';
300 |             return false;
301 |         }
302 | 
303 |         return apply_filters('mctb_validate', true);
304 |     }
305 | 
306 |     /**
307 |      * Loads the required scripts & styles
308 |      */
309 |     public function load_assets()
310 |     {
311 |         $options = mctb_get_options();
312 |         wp_enqueue_script('mailchimp-top-bar', $this->asset_url("/script.js"), [], MAILCHIMP_TOP_BAR_VERSION, true);
313 |         add_filter('script_loader_tag', [ $this, 'add_defer_attribute' ], 10, 2);
314 |         $bottom = $options['position'] === 'bottom';
315 | 
316 |         $data = [
317 |             'cookieLength' => $options['cookie_length'],
318 |             'icons'        => [
319 |                 'hide' => ( $bottom ) ? '&#x25BC;' : '&#x25B2;',
320 |                 'show' => ( $bottom ) ? '&#x25B2;' : '&#x25BC;'
321 |             ],
322 |             'position'     => $options['position'],
323 |             'state'        => [
324 |                 'submitted' => $this->submitted,
325 |                 'success'   => $this->success,
326 |             ],
327 |         ];
328 | 
329 |         /**
330 |          * @filter `mctb_bar_config`
331 |          * @expects array
332 |          *
333 |          * Can be used to filter the following values
334 |          *  - cookieLength: The length of the cookie
335 |          *  - icons: Array with `hide` and `show` keys. Holds the hide/show icon strings.
336 |          */
337 |         $data = apply_filters('mctb_bar_config', $data);
338 | 
339 |         wp_localize_script('mailchimp-top-bar', 'mctb', $data);
340 |     }
341 | 
342 |     /**
343 |      * Adds defer attribute to our <script> element
344 |      */
345 |     public function add_defer_attribute($tag, $handle)
346 |     {
347 |         if ($handle !== 'mailchimp-top-bar') {
348 |             return $tag;
349 |         }
350 | 
351 |         return \str_replace(' src=', ' defer src=', $tag);
352 |     }
353 | 
354 |     /**
355 |      * @return string
356 |      */
357 |     private function get_css_class()
358 |     {
359 |         $options = mctb_get_options();
360 |         $classes = [ 'mctb' ];
361 | 
362 |         // add class when bar is sticky
363 |         if ($options['position'] === 'top' && $options['sticky']) {
364 |             $classes[] = 'mctb-sticky';
365 |         }
366 | 
367 |         // add unique css class for position (bottom|top)
368 |         $classes[] = \sprintf('mctb-position-%s', $options['position']);
369 | 
370 |         // add class describing size of the bar
371 |         $classes[] = "mctb-{$options['size']}";
372 | 
373 |         return \join(' ', $classes);
374 |     }
375 | 
376 |     /**
377 |      * Output the CSS settings for the bar
378 |      */
379 |     public function output_css()
380 |     {
381 |         $options           = mctb_get_options();
382 |         $bar_color         = $options['color_bar'];
383 |         $button_color      = $options['color_button'];
384 |         $text_color        = $options['color_text'];
385 |         $button_text_color = $options['color_button_text'];
386 | 
387 |         echo '<style>';
388 |         include MAILCHIMP_TOP_BAR_DIR . '/assets/bar.css';
389 | 
390 |         if (! empty($bar_color)) {
391 |             echo ".mctb-bar,.mctb-response,.mctb-close{background:{$bar_color}!important;}";
392 |         }
393 | 
394 |         if (! empty($text_color)) {
395 |             echo ".mctb-bar,.mctb-label,.mctb-close{color:{$text_color}!important;}";
396 |         }
397 | 
398 |         if (! empty($button_color)) {
399 |             echo ".mctb-button{background:{$button_color}!important;border-color:{$button_color}!important;}";
400 |             echo ".mctb-email:focus{outline-color:{$button_color}!important;}";
401 |         }
402 | 
403 |         if (! empty($button_text_color)) {
404 |             echo ".mctb-button{color: {$button_text_color}!important;}";
405 |         }
406 | 
407 |         echo '</style>', PHP_EOL;
408 |     }
409 | 
410 | 
411 |     /**
412 |      * Output the HTML for the opt-in bar
413 |      */
414 |     public function output_html()
415 |     {
416 |         $hide = isset($_COOKIE['mctb_bar_hidden']);
417 |         $form_action = apply_filters('mctb_form_action', null);
418 |         $options     = mctb_get_options();
419 |         ?>
420 |         <!-- Mailchimp Top Bar v<?php echo MAILCHIMP_TOP_BAR_VERSION; ?> - https://wordpress.org/plugins/mailchimp-top-bar/ -->
421 |         <div id="mailchimp-top-bar" class="<?php echo $this->get_css_class(); ?>">
422 |         <div class="mctb-bar" <?php if ($hide) {
423 |             echo 'style="display: none;"';
424 |                               } ?>>
425 |             <form method="post" <?php if (is_string($form_action)) {
426 |                 echo "action=\"", esc_attr($form_action), "\"";
427 |                                 } ?>>
428 |                     <?php do_action('mctb_before_label'); ?>
429 |                     <label class="mctb-label" for="mailchimp-top-bar__email"><?php echo $options['text_bar']; ?></label>
430 |                     <?php do_action('mctb_before_email_field'); ?>
431 |                     <input type="email" name="email"
432 |                            placeholder="<?php echo esc_attr($options['text_email_placeholder']); ?>"
433 |                            class="mctb-email" required id="mailchimp-top-bar__email"/>
434 |                     <input type="text" name="email_confirm" placeholder="Confirm your email" value="" autocomplete="off"
435 |                            tabindex="-1" class="mctb-email-confirm"/>
436 |                     <?php do_action('mctb_before_submit_button'); ?>
437 |                     <input type="submit" value="<?php echo esc_attr($options['text_button']); ?>"
438 |                            class="mctb-button"/>
439 |                     <?php do_action('mctb_after_submit_button'); ?>
440 |                     <input type="hidden" name="_mctb" value="1"/>
441 |                     <input type="hidden" name="_mctb_no_js" value="1"/>
442 |                     <input type="hidden" name="_mctb_timestamp" value="<?php echo time(); ?>"/>
443 |                 </form>
444 |                 <?php echo $this->get_response_message_html(); ?>
445 |             </div>
446 |         </div>
447 |         <!-- / Mailchimp Top Bar -->
448 |         <?php
449 |     }
450 | 
451 |     /**
452 |      * @return string
453 |      */
454 |     protected function get_response_message()
455 |     {
456 |         if (! $this->submitted) {
457 |             return '';
458 |         }
459 | 
460 |         $options = mctb_get_options();
461 | 
462 |         if ($this->success) {
463 |             $message = $options['text_subscribed'];
464 |         } elseif ($this->error_type === 'already_subscribed') {
465 |             $message = $options['text_already_subscribed'];
466 |         } elseif ($this->error_type === 'invalid_email') {
467 |             $message = $options['text_invalid_email'];
468 |         } else {
469 |             $message = $options['text_error'];
470 |         }
471 | 
472 |         return $message;
473 |     }
474 | 
475 |     protected function get_response_message_html()
476 |     {
477 |         $message = $this->get_response_message();
478 |         if (empty($message)) {
479 |             return '';
480 |         }
481 | 
482 |         return \sprintf('<div class="mctb-response"><label class="mctb-response-label">%s</label></div>', $message);
483 |     }
484 | 
485 | 
486 |     /**
487 |      * @param $url
488 |      *
489 |      * @return string
490 |      */
491 |     protected function asset_url($url)
492 |     {
493 |         return plugins_url('/assets' . $url, MAILCHIMP_TOP_BAR_FILE);
494 |     }
495 | 
496 |     /**
497 |      * Returns the debug logger or null, if Mailchimp for WordPress 3.1 is not installed.
498 |      *
499 |      * @return MC4WP_Debug_Log|null
500 |      */
501 |     protected function get_log()
502 |     {
503 | 
504 |         try {
505 |             $log = mc4wp('log');
506 |         } catch (Exception $e) {
507 |             return null;
508 |         }
509 | 
510 |         return $log;
511 |     }
512 | }
513 | 


--------------------------------------------------------------------------------
/readme.txt:
--------------------------------------------------------------------------------
  1 | === MC4WP: Mailchimp Top Bar ===
  2 | Contributors: Ibericode, DvanKooten, hchouhan, lapzor
  3 | Donate link: https://www.mc4wp.com/
  4 | Tags: mailchimp, form, top bar, call to action, subscribe
  5 | Requires at least: 4.9
  6 | Tested up to: 6.9
  7 | Stable tag: 1.7.3
  8 | License: GPL-3.0-or-later
  9 | License URI: http://www.gnu.org/licenses/gpl-3.0.html
 10 | Requires PHP: 7.3
 11 | 
 12 | Adds a Mailchimp opt-in form to the top or bottom of your WordPress site.
 13 | 
 14 | == Description ==
 15 | 
 16 | Adds a beautiful, customizable sign-up bar to the top or bottom of your WordPress site. This bar is guaranteed to get the attention of your visitor and
 17 | increase your Mailchimp subscribers.
 18 | 
 19 | This plugin is an add-on for the [Mailchimp for WordPress plugin](https://wordpress.org/plugins/mailchimp-for-wp/).
 20 | 
 21 | = Features =
 22 | 
 23 | Mailchimp Top Bar adds a simple yet beautiful & customizable opt-in bar to the top or bottom of your WordPress site.
 24 | 
 25 | Using this bar, people can subscribe to a Mailchimp audience of your choice.
 26 | 
 27 | - Guaranteed to boost conversions.
 28 | - Unobtrusive, visitors can easily dismiss the bar.
 29 | - Easy to install & configure, just select a Mailchimp audience and you're good to.
 30 | - Customizable, you can edit the bar text and colors from the plugin settings.
 31 | - The bar can be at the top or bottom of the visitor's screen
 32 | - Lightweight, the plugin consists of just a single 2.6 kB JavaScript file.
 33 | 
 34 | = More information =
 35 | 
 36 | - [MC4WP: Mailchimp for WordPress on WordPress.org](https://wordpress.org/plugins/mailchimp-for-wp/)
 37 | - [MC4WP: Mailchimp for WordPress website](https://www.mc4wp.com/)
 38 | 
 39 | = About the author =
 40 | 
 41 | Mailchimp Top Bar is a plugin by [ibericode](https:/www.ibericode.com/), a company from The Netherlands that you may know from other plugins like [Mailchimp for WordPress](https://www.mc4wp.com/), [Boxzilla Pop-ups](https://www.boxzillaplugin.com) and [Koko Analytics](https://www.kokoanalytics.com/).
 42 | 
 43 | 
 44 | == Installation ==
 45 | 
 46 | = Mailchimp for WordPress =
 47 | 
 48 | Since this plugin depends on the [Mailchimp for WordPress plugin](https://wordpress.org/plugins/mailchimp-for-wp/), you will need to install that first.
 49 | 
 50 | = Installing Mailchimp Top Bar =
 51 | 
 52 | 1. In your WordPress admin panel, go to *Plugins > New Plugin*, search for **Mailchimp Top Bar** and click "*Install now*"
 53 | 1. Alternatively, download the plugin and upload the contents of `mailchimp-top-bar.zip` to your plugins directory, which usually is `/wp-content/plugins/`.
 54 | 1. Activate the plugin
 55 | 1. Set [your Mailchimp API key](https://admin.mailchimp.com/account/api) in **Mailchimp for WP > Mailchimp Settings**.
 56 | 1. Select a Mailchimp audience to subscribe to in **Mailchimp for WP > Top Bar**.
 57 | 1. _(Optional)_ Customize the look & position of your opt-in bar.
 58 | 
 59 | == Frequently Asked Questions ==
 60 | 
 61 | = How to disable the bar on certain pages? =
 62 | 
 63 | For now, you will have to use a filter to disable the bar on certain pages. The following example only loads the Top Bar on your blog post pages.
 64 | 
 65 | `
 66 | add_filter( 'mctb_show_bar', function( $show ) {
 67 |     return is_single();
 68 | } );
 69 | `
 70 | 
 71 | Another example, this only loads the bar on your "contact" page.
 72 | 
 73 | `
 74 | add_filter( 'mctb_show_bar', function( $show ) {
 75 |     return is_page('contact');
 76 | } );
 77 | `
 78 | 
 79 | Have a look at the [Conditional Tags](https://codex.wordpress.org/Conditional_Tags) page for all accepted functions.
 80 | 
 81 | = How to add a name field to the bar? =
 82 | 
 83 | You can use the following code snippet to show a "NAME" field in your bar.
 84 | 
 85 | `
 86 | add_action( 'mctb_before_submit_button', function() {
 87 |     echo '<input type="text" name="NAME" placeholder="Your name" />';
 88 | });
 89 | 
 90 | add_filter( 'mctb_subscriber_data', function( $subscriber ) {
 91 |     if( ! empty( $_POST['NAME'] ) ) {
 92 |         $subscriber->merge_fields['NAME'] = sanitize_text_field( $_POST['NAME'] );
 93 |     }
 94 | 
 95 |     return $subscriber;
 96 | });
 97 | `
 98 | 
 99 | **KB:** [Add name field to Mailchimp Top Bar](https://www.mc4wp.com/kb/add-name-field-to-mailchimp-top-bar/)
100 | 
101 | = How to hide the bar on small screens? =
102 | 
103 | Adding the following CSS to your site should hide the bar on all screens smaller than 600px. The [Simple Custom CSS](https://wordpress.org/plugins/simple-custom-css/) plugin is great for adding custom CSS.
104 | 
105 | `
106 | @media( max-width: 600px ) {
107 |     &#35;mailchimp-top-bar { display: none !important; }
108 | }
109 | `
110 | 
111 | = I think I found a bug. What now? =
112 | 
113 | Please report it on [GitHub issues](https://github.com/ibericode/mailchimp-top-bar/issues) if it's not in the list of known issues.
114 | 
115 | = I have another question =
116 | 
117 | Please open a topic on the [WordPress.org plugin support forums](https://wordpress.org/support/plugin/mailchimp-top-bar).
118 | 
119 | 
120 | == Screenshots ==
121 | 
122 | 1. The Mailchimp Top Bar in action on the [Mailchimp for WordPress site](https://www.mc4wp.com/).
123 | 2. The settings page of the Mailchimp Top Bar plugin.
124 | 
125 | == Changelog ==
126 | 
127 | 
128 | ### 1.7.3 - Oct 1, 2025
129 | 
130 | - Minor performance or memory usage related improvements.
131 | - Compatibility check with latest WordPress version.
132 | 
133 | 
134 | ### 1.7.1 - Jul 2, 2025
135 | 
136 | - Update dependencies and WordPress compatibility.
137 | - Decrease timestamp check to one second ago.
138 | 
139 | 
140 | ### 1.7.0 - Jan 27, 2025
141 | 
142 | - Bump required PHP version to 7.3 or higher.
143 | - Bump required WordPress version to 4.9 or higher.
144 | - Remove compatibility code for Mailchimp for WordPress versions before 3.0.
145 | - Add visitor IP to sign-ups through Top Bar.
146 | - Fix response not showing up after first trying with an invalid email address.
147 | - Minor performance improvements troughout the code by explicitly specifying the global namespace on core PHP functions.
148 | 
149 | 
150 | ### 1.6.2 - Oct 3, 2024
151 | 
152 | - Fix button text setting not updating after saving settings.
153 | 
154 | 
155 | ### 1.6.1 - Oct 1, 2024
156 | 
157 | - Escape return value of `add_query_arg` before outputting, fixing a potential XSS issue. Thanks to vgo0 for the responsible disclosure.
158 | - Escape or kses return values of all gettext calls.
159 | - Improved sanitization of all plugin settings.
160 | - Minor server side performance improvements by getting rid of some unneccessary string copies or sprintf calls.
161 | 
162 | 
163 | ### 1.6.0 - Jan 4, 2023
164 | 
165 | - JS file now has `defer` attribute so it is not render blocking.
166 | - Stylesheet is now inserted through JS, so it is not render blocking.
167 | - Animations now entirely handled using CSS.
168 | - JS file is now 20% smaller because of the above (2.6 kB gzipped).
169 | 
170 | 
171 | ### 1.5.6 - Dec 1, 2022
172 | 
173 | - Minor JS improvements to shrink ~500 bytes off script file.
174 | - Prepare admin tab navigation for upcoming [Mailchimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) release.
175 | 
176 | 
177 | #### 1.5.5 - May 14, 2021
178 | 
179 | - Always use minified asset file, regardless of `SCRIPT_DEBUG` setting.
180 | - Add nonce to all URL's using `_mc4wp_action` parameter.
181 | 
182 | 
183 | #### 1.5.4 - May 7, 2021
184 | 
185 | - Update classnames to work with MailChimp for WordPress version 4.8.4 (and up).
186 | - Minor JS optimizations.
187 | 
188 | 
189 | #### 1.5.3 - Mar 30, 2021
190 | 
191 | - Fix typo in help text.
192 | - Show bar server-side to speed-up height calculation.
193 | 
194 | 
195 | #### 1.5.2 - Mar 9, 2020
196 | 
197 | - Add setting to disable bar (stop loading it altogether) after it is used.
198 | - Increase default cookie lifetime to 1 year.
199 | 
200 | 
201 | #### 1.5.1 - Jan 21, 2020
202 | 
203 | - Fade response element using CSS animations for better performance.
204 | - Various minor performance improvements.
205 | 
206 | 
207 | #### 1.5.0 - Oct 7, 2019
208 | 
209 | Compatibility with [Mailchimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) version 4.6.
210 | 
211 | 
212 | #### 1.4.1 - Sep 11, 2019
213 | 
214 | **Changes**
215 | 
216 | - Change name to MC4WP: Mailchimp Top Bar.
217 | 
218 | 
219 | #### 1.4.0 - Sep 4, 2019
220 | 
221 | **Improvements**
222 | 
223 | - Add (advanced) setting to quickly disable the top bar on certain pages.
224 | 
225 | 
226 | #### 1.3.2 - Aug 8, 2018
227 | 
228 | **Fixes**
229 | 
230 | - Required fields notice on selected list was not showing because of invalid list property.
231 | 
232 | **Improvements**
233 | 
234 | - Prefix internal CSS classes for improved compatibility with other themes or plugins applying global admin styles.
235 | 
236 | 
237 | #### 1.3.1 - May 29, 2018
238 | 
239 | **Improvements**
240 | 
241 | - 30% reduction in script file size because of removed JS dependency.
242 | - Stop setting unused cookie when Top Bar form is used to subscribe.
243 | - Add mctb_after_submit_button action hook.
244 | - Improve animation performance.
245 | 
246 | 
247 | #### 1.3 - November 1, 2017
248 | 
249 | **Improvements**
250 | 
251 | - Form now submits over AJAX, no longer reloading the entire page.
252 | - Added `for` attribute to label elements, thanks [gabriel-kaam](https://github.com/gabriel-kaam).
253 | - Added `mctb_replace_interests` filter hook.
254 | 
255 | #### 1.2.16 - January 19, 2017
256 | 
257 | Various minor code improvements.
258 | 
259 | 
260 | #### 1.2.15 - September 8, 2016
261 | 
262 | **Improvements**
263 | 
264 | - Improved responsiveness when bar has additional input fields.
265 | - Add `required` attribute to email input.
266 | 
267 | 
268 | #### 1.2.14 - August 29, 2016
269 | 
270 | **Fixes**
271 | 
272 | - Top padding for small screens with admin bar.
273 | 
274 | **Improvements**
275 | 
276 | - Better bar responsiveness when window dimensions change on the fly (eg resizing a window or changing device orientation mode). (Thanks [tech4him1](https://github.com/tech4him1)!)
277 | 
278 | 
279 | #### 1.2.13 - August 2, 2016
280 | 
281 | **Fixes**
282 | 
283 | - Error in animating body padding back to its original value.
284 | 
285 | 
286 | #### 1.2.12 - July 21, 2016
287 | 
288 | **Fixes**
289 | 
290 | - Bar would crash when clicking toggle icon during bar animation.
291 | 
292 | **Improvements**
293 | 
294 | - Function scope generated JavaScript file to prevent Browserify clashes with other loaded scripts.
295 | - Make sure script works even though it's loaded in the head section.
296 | - Preparations for upcoming Mailchimp for WordPress v4.0 release.
297 | 
298 | **Additions**
299 | 
300 | - Added Spanish language files, thanks to [Ángel Guzmán Maeso](http://shakaran.net/)
301 | - Added `mctb_data` filter, to filter form data before it is processed.
302 | 
303 | **Deprecated**
304 | 
305 | - Deprecated `mctb_merge_vars` filter.
306 | 
307 | 
308 | #### 1.2.11 - July 8, 2016
309 | 
310 | **Improvements**
311 | 
312 | - Completely removed optional jQuery dependency. The plugin now uses JavaScript animations, resulting in a much smoother experience.
313 | 
314 | #### 1.2.10 - April 12, 2016
315 | 
316 | **Fixes**
317 | 
318 | - Closed bar would still overlap underlying elements (like fixed top menu's).
319 | 
320 | 
321 | #### 1.2.9 - March 16, 2016
322 | 
323 | **Fixes**
324 | 
325 | Top Bar was invisible on some themes because of `z-index` being too low.
326 | 
327 | 
328 | #### 1.2.8 - March 15, 2016
329 | 
330 | **Improvements**
331 | 
332 | - Make sure top bar doesn't appear on top of WP admin bar.
333 | - Hardened CSS styles for improved theme compatability.
334 | 
335 | 
336 | #### 1.2.7 - January 26, 2016
337 | 
338 | **Improvements**
339 | 
340 | - Miscellaneous code improvements
341 | 
342 | **Additions**
343 | 
344 | - Add support for new [debug log](https://www.mc4wp.com/kb/how-to-enable-log-debugging/) in Mailchimp for WordPress 3.1
345 | 
346 | 
347 | #### 1.2.6 - January 4, 2016
348 | 
349 |  **Additions**
350 | 
351 |  - Option to "update existing subscribers" in Mailchimp, which is useful if you have added fields.
352 | 
353 |  **Improvements**
354 | 
355 |  - Toggle icon now has a background color, for increased visibility.
356 |  - Toggle icon now stacks above or below bar on small screens.
357 | 
358 | #### 1.2.5 - December 10, 2015
359 | 
360 | The plugin now requires [Mailchimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) version 3.0 or higher.
361 | 
362 | **Fixes**
363 | 
364 | - Fixed column alignment in Appearance tab, thanks [Chantal Coolsma](https://github.com/chantalcoolsma)!
365 | 
366 | **Improvements**
367 | 
368 | - Improved admin notice when dependencies are not installed.
369 | 
370 | 
371 | #### 1.2.4 - November 22, 2015
372 | 
373 | - Compatibility for [the upcoming Mailchimp for WordPress 3.0 release](https://www.mc4wp.com/blog/breaking-backwards-compatibility-in-version-3-0/) tomorrow.
374 | - Added `mctb_subscribed` filter.
375 | 
376 | #### 1.2.3 - November 13, 2015
377 | 
378 | **Improvements**
379 | 
380 | - Minor refactoring in the way the plugin is bootstrapped.
381 | 
382 | #### 1.2.2 - September 10, 2015
383 | 
384 | **Fixes**
385 | 
386 | - Honeypot field being auto-completed in some browsers.
387 | - Honeypot field was accessible by pressing "tab" key.
388 | - Hardened security for cookie that tracks sign-up attempts.
389 | 
390 | #### 1.2.1 - September 8, 2015
391 | 
392 | **Fixes**
393 | 
394 | - Response message was not showing for some themes.
395 | 
396 | **Improvements**
397 | 
398 | - Better mobile responsiveness
399 | 
400 | 
401 | #### 1.2 - September 3, 2015
402 | 
403 | **Improvements**
404 | 
405 | - The bar will now auto-dismiss after every successful sign-up.
406 | - Placeholders will now work in Internet Explorer 7, 8 & 9 as well.
407 | 
408 | **Additions**
409 | 
410 | - Added options for double opt-in and sending Mailchimp's "welcome email".
411 | - Added `mctb_before_label` action allowing you to add HTML before the label-element.
412 | - Added `mctb_before_email_field` action allowing you to add HTML before the email field.
413 | - Added `mctb_before_submit_button` action allowing you to add HTML before the submit button.
414 | - Added `mctb_form_action` filter allowing you to set a custom form action.
415 | 
416 | #### 1.1.3 - June 23, 2015
417 | 
418 | **Fixes**
419 | 
420 | - Fixes fatal error when visiting settings page on some servers
421 | 
422 | #### 1.1.2 - June 18, 2015
423 | 
424 | **Improvements**
425 | 
426 | - Fixes height of response message
427 | - CSS improvements for compatibility with various popular themes
428 | 
429 | #### 1.1.1 - June 12, 2015
430 | 
431 | **Fixes**
432 | 
433 | - Fixes unclickable admin bar (or fixed navigation menu's).
434 | 
435 | **Improvements**
436 | 
437 | - Various improvements to bar CSS so it can be easily overridden.
438 | - Fix vertical alignment of toggle icon.
439 | 
440 | #### 1.1 - June 10, 2015
441 | 
442 | **Improvements**
443 | 
444 | - Bar no longer requires jQuery script, saving an additional HTTP request and 100kb
445 | 
446 | **Additions**
447 | 
448 | - Position option: top or bottom
449 | - New filter: `mctb_mailchimp_list` (set lists to subscribe to)
450 | - Lithuanian translation, thanks to [Aleksandr Charkov](https://github.com/dec0n)
451 | 
452 | #### 1.0.8 - May 6, 2015
453 | 
454 | **Fixes**
455 | 
456 | - Compatibility with [Mailchimp for WordPress Lite v2.3](https://wordpress.org/plugins/mailchimp-for-wp/) and [Mailchimp for WordPress Pro v2.7](https://www.mc4wp.com/).
457 | 
458 | #### 1.0.7 - April 15, 2015
459 | 
460 | **Fixes**
461 | 
462 | - `mctb_show_bar` filter was not functioning properly with some themes.
463 | - Form always errored when using WPML with String Translations.
464 | 
465 | **Improvements**
466 | 
467 | - Toggle icon is no longer shown for users without JavaScript.
468 | 
469 | #### 1.0.6 - March 17, 2015
470 | 
471 | **Fixes**
472 | 
473 | - Compatibility issues with latest version of Enfold theme
474 | - Conflict with other plugins shipping _very old_ versions of Composer
475 | 
476 | **Improvements**
477 | 
478 | - Allow simple inline tags in the bar text
479 | 
480 | 
481 | #### 1.0.5 - February 25, 2015
482 | 
483 | **Fixes**
484 | 
485 | - Bar not loading in some themes after latest update
486 | - Colors not working because of missing leading `#` value. Color settings are now validated before saving them.
487 | 
488 | #### 1.0.4 - February 23, 2015
489 | 
490 | **Fixes**
491 | 
492 | - Styling issues with Enfold theme.
493 | 
494 | **Additions**
495 | 
496 | - Settings page now uses a tabbed interface.
497 | - You can now set a "redirect url" in the bar settings
498 | - All form response messages can now be customised for the bar form
499 | 
500 | #### 1.0.3 - February 17, 2015
501 | 
502 | **Improvements**
503 | 
504 | - Bar will now show "already subscribed" message from Mailchimp for WordPress when a person is already on the selected list.
505 | - Response message will now show and fadeout after 3 seconds.
506 | - Various usability improvements for the settings screen.
507 | - Improved spam detection.
508 | - Major JS performance improvements.
509 | 
510 | **Additions**
511 | 
512 | - Multiple new anti-spam measures
513 | - WPML compatibility
514 | 
515 | 
516 | #### 1.0.2 - February 12, 2015
517 | 
518 | **Improvements**
519 | 
520 | - Better CSS reset for elements inside the bar
521 | - Other minor CSS improvements
522 | 
523 | **Additions**
524 | 
525 | - Top Bar sign-ups are now shown in the log for [Mailchimp for WordPress Pro](https://www.mc4wp.com/).
526 | 
527 | #### 1.0.1 - February 4, 2015
528 | 
529 | **Fixes**
530 | 
531 | - The plugin will no longer overlap header menu's or other elements
532 | 
533 | **Additions**
534 | 
535 | - You can now set the bar as "sticky", meaning it will stick to the op your window, even when scrolling.
536 | - You can now choose the size of the bar, small/medium/big.
537 | - Added Dutch translation files.
538 | 
539 | **Improvements**
540 | 
541 | - The menu item will now show above the item asking you to upgrade to Mailchimp for WordPress Pro.
542 | 
543 | Please update the [Mailchimp for WordPress plugin](https://wordpress.org/plugins/mailchimp-for-wp/) before updating to this version.
544 | 
545 | #### 1.0 - January 28, 2015
546 | 
547 | Initial release
548 | 
549 | == Upgrade Notice ==
550 | 
551 | = 1.2.6 =
552 | 
553 | Improvements to toggle icon for small screens & dark backgrounds.
554 | 


--------------------------------------------------------------------------------
/views/settings-page.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | use MailChimp\TopBar\Options;
  3 | use MailChimp\TopBar\Plugin;
  4 | 
  5 | defined('ABSPATH') or exit;
  6 | 
  7 | $tabs = array(
  8 |     'settings'      => esc_html__("Bar Setting", "mailchimp-top-bar"),
  9 |     'appearance'    => esc_html__("Appearance", "mailchimp-top-bar"),
 10 |     'messages'      => esc_html__("Messages", "mailchimp-top-bar"),
 11 |     'advanced'      => esc_html__("Advanced", "mailchimp-top-bar"),
 12 | );
 13 | ?>
 14 | <?php /* ensure wp-picker does not push other elements around */ ?>
 15 | <style type="text/css">
 16 | .wp-picker-holder,
 17 | .wp-picker-input-wrap {
 18 |     position: absolute;
 19 | }
 20 | </style>
 21 | <div class="wrap" id="mc4wp-admin">
 22 | 
 23 |     <h1 class="page-title">Mailchimp Top Bar</h1>
 24 | 
 25 |     <h2 class="nav-tab-wrapper" id="mctb-tabs">
 26 |         <?php foreach ($tabs as $tab => $title) {
 27 |             $class = ( $current_tab === $tab ) ? 'nav-tab-active' : '';
 28 |             echo sprintf('<a class="nav-tab nav-tab-%s %s" data-tab="%s" href="%s">%s</a>', $tab, $class, $tab, admin_url('admin.php?page=mailchimp-for-wp-top-bar&tab=' . $tab), $title);
 29 |         } ?>
 30 |     </h2>
 31 | 
 32 |     <form method="post" action="<?php echo esc_attr(admin_url('options.php')); ?>">
 33 | 
 34 |         <h2 style="display: none;"></h2>
 35 |         <?php settings_fields('mailchimp_top_bar'); ?>
 36 |         <?php settings_errors(); ?>
 37 | 
 38 |         <div id="message-list-requires-fields" class="notice notice-warning" style="display: none;">
 39 |             <p><?php printf(wp_kses(__('The selected Mailchimp audience requires more fields than just an <strong>%s</strong> field. Please <a href="%s">log into your Mailchimp account</a> and make sure only the <strong>%s</strong> field is marked as required.', 'mailchimp-top-bar'), array( 'a' => array( 'href' => array()), 'strong' => array())), 'EMAIL', 'https://admin.mailchimp.com/audience/', 'EMAIL'); ?></p>
 40 |             <p class="description"><?php printf(wp_kses(__('After making changes to your Mailchimp audience, <a href="%s">click here</a> to renew your list configuration.', 'mailchimp-top-bar'), array('a' => array('href' => array()))), esc_attr(add_query_arg(array( '_mc4wp_action' => 'empty_lists_cache', '_wpnonce' => wp_create_nonce('_mc4wp_action') )))); ?></p>
 41 |         </div>
 42 | 
 43 |         <?php $config = array( 'element' => $this->name_attr('enabled'), 'value' => 0 ); ?>
 44 |         <div id="message-bar-is-disabled" class="notice notice-warning" data-showif="<?php echo esc_attr(json_encode($config)); ?>">
 45 |             <p>
 46 |                 <?php esc_html_e('You have disabled the bar. It will not show up on your site until you enable it again.', 'mailchimp-top-bar'); ?>
 47 |             </p>
 48 |         </div>
 49 | 
 50 |         <!-- Bar Settings -->
 51 |         <div class="mc4wp-tab <?php if ($current_tab === 'settings') {
 52 |             echo 'mc4wp-tab-active';
 53 |                               } ?>" id="tab-settings">
 54 | 
 55 |             <h2><?php esc_html_e('Bar Settings', 'mailchimp-for-wp'); ?></h2>
 56 | 
 57 |             <table class="form-table">
 58 | 
 59 |                 <tr valign="top">
 60 |                     <th scope="mc4wp-row">
 61 |                         <label>
 62 |                             <?php esc_html_e('Enable Bar?', 'mailchimp-top-bar'); ?>
 63 |                         </label>
 64 |                     </th>
 65 |                     <td>
 66 |                         <label>
 67 |                             <input type="radio" name="<?php echo $this->name_attr('enabled'); ?>" value="1" <?php checked($options[ 'enabled' ], 1); ?> /> <?php esc_html_e('Yes'); ?>
 68 |                         </label> &nbsp;
 69 |                         <label>
 70 |                             <input type="radio" name="<?php echo $this->name_attr('enabled'); ?>" value="0" <?php checked($options[ 'enabled' ], 0); ?> /> <?php esc_html_e('No'); ?>
 71 |                         </label>
 72 |                         <p class="description"><?php esc_html_e('A quick way to completely disable the bar.', 'mailchimp-top-bar'); ?></p>
 73 | 
 74 |                     </td>
 75 |                 </tr>
 76 | 
 77 |                 <tr valign="top">
 78 |                     <th scope="mc4wp-row"><label><?php esc_html_e('Mailchimp Audience', 'mailchimp-for-wp'); ?></label></th>
 79 |                     <td>
 80 |                         <?php if (empty($lists)) {
 81 |                             printf(wp_kses(__('No audiences found, <a href="%s">are you connected to Mailchimp</a>?', 'mailchimp-for-wp'), array('a' => array('href' => array()))), admin_url('admin.php?page=mailchimp-for-wp')); ?>
 82 |                         <?php } ?>
 83 | 
 84 |                         <select name="<?php echo $this->name_attr('list'); ?>" class="mc4wp-list-input" id="select-mailchimp-list">
 85 |                             <option disabled <?php selected($options[ 'list' ], ''); ?>><?php esc_html_e('Select a list..', 'mailchimp-top-bar'); ?></option>
 86 |                             <?php foreach ($lists as $list) { ?>
 87 |                                 <option value="<?php echo esc_attr($list->id); ?>" <?php selected($options[ 'list' ], $list->id); ?>><?php echo esc_html($list->name); ?></option>
 88 |                             <?php } ?>
 89 |                         </select>
 90 |                         <p class="description"><?php esc_html_e('Select the Mailchimp audience to which visitors should be subscribed.', 'mailchimp-top-bar'); ?></p>
 91 |                     </td>
 92 |                 </tr>
 93 | 
 94 |                 <tr valign="top">
 95 |                     <th scope="mc4wp-row">
 96 |                         <label>
 97 |                             <?php esc_html_e('Bar Text', 'mailchimp-top-bar'); ?>
 98 |                         </label>
 99 |                     </th>
100 |                     <td>
101 |                         <input type="text" name="<?php echo $this->name_attr('text_bar'); ?>" value="<?php echo esc_attr($options[ 'text_bar' ]); ?>" class="widefat" />
102 |                         <p class="description"><?php esc_html_e('The text to appear before the email field.', 'mailchimp-top-bar'); ?></p>
103 |                     </td>
104 |                 </tr>
105 | 
106 |                 <tr valign="top">
107 |                     <th scope="mc4wp-row">
108 |                         <label>
109 |                             <?php esc_html_e('Button Text', 'mailchimp-top-bar'); ?>
110 |                         </label>
111 |                     </th>
112 |                     <td>
113 |                         <input type="text" name="<?php echo $this->name_attr('text_button'); ?>" value="<?php echo esc_attr($options[ 'text_button' ]); ?>" class="regular-text" />
114 |                         <p class="description"><?php esc_html_e('The text on the submit button.', 'mailchimp-top-bar'); ?></p>
115 |                     </td>
116 |                 </tr>
117 | 
118 |                 <tr valign="top">
119 |                     <th scope="mc4wp-row">
120 |                         <label>
121 |                             <?php esc_html_e('Email Placeholder Text', 'mailchimp-top-bar'); ?>
122 |                         </label>
123 |                     </th>
124 |                     <td>
125 |                         <input type="text" name="<?php echo $this->name_attr('text_email_placeholder'); ?>" value="<?php echo esc_attr($options[ 'text_email_placeholder' ]); ?>" class="regular-text" />
126 |                         <p class="description"><?php esc_html_e('The initial placeholder text to appear in the email field.', 'mailchimp-top-bar'); ?></p>
127 |                     </td>
128 |                 </tr>
129 |             </table>
130 |         </div>
131 | 
132 |         <!-- Appearance Tab -->
133 |         <div class="mc4wp-tab <?php if ($current_tab === 'appearance') {
134 |             echo 'mc4wp-tab-active';
135 |                               } ?>" id="tab-appearance">
136 | 
137 |             <h2><?php esc_html_e('Appearance', 'mailchimp-top-bar'); ?></h2>
138 | 
139 |             <div class="mc4wp-row">
140 |                 <div class="mc4wp-col mc4wp-col-2">
141 |                     <table class="form-table">
142 | 
143 |                         <tr valign="top">
144 |                             <th scope="mc4wp-row">
145 |                                 <label>
146 |                                     <?php esc_html_e('Bar Position', 'mailchimp-top-bar'); ?>
147 |                                 </label>
148 |                             </th>
149 |                             <td>
150 |                                 <select name="<?php echo $this->name_attr('position'); ?>" id="select-bar-position">
151 |                                     <option value="top" <?php selected($options[ 'position' ], 'top'); ?>><?php esc_html_e('Top', 'mailchimp-top-bar'); ?></option>
152 |                                     <option value="bottom" <?php selected($options[ 'position' ], 'bottom'); ?>><?php esc_html_e('Bottom', 'mailchimp-top-bar'); ?></option>
153 |                                 </select>
154 |                             </td>
155 |                         </tr>
156 | 
157 |                         <tr valign="top" class="bar-size-options">
158 |                             <th scope="mc4wp-row">
159 |                                 <label>
160 |                                     <?php esc_html_e('Bar Size', 'mailchimp-top-bar'); ?>
161 |                                 </label>
162 |                             </th>
163 |                             <td>
164 |                                 <select name="<?php echo $this->name_attr('size'); ?>">
165 |                                     <option value="small" <?php selected($options[ 'size' ], 'small'); ?>><?php esc_html_e('Small', 'mailchimp-top-bar'); ?></option>
166 |                                     <option value="medium" <?php selected($options[ 'size' ], 'medium'); ?>><?php esc_html_e('Medium', 'mailchimp-top-bar'); ?></option>
167 |                                     <option value="big" <?php selected($options[ 'size' ], 'big'); ?>><?php esc_html_e('Big', 'mailchimp-top-bar'); ?></option>
168 |                                 </select>
169 |                             </td>
170 |                         </tr>
171 | 
172 |                         <tr valign="top">
173 |                             <th scope="mc4wp-row">
174 |                                 <label>
175 |                                     <?php esc_html_e('Bar Color', 'mailchimp-top-bar'); ?>
176 |                                 </label>
177 |                             </th>
178 |                             <td>
179 |                                 <input type="text" name="<?php echo $this->name_attr('color_bar'); ?>" value="<?php echo esc_attr($options[ 'color_bar' ]); ?>" class="mc4wp-color">
180 |                             </td>
181 |                         </tr>
182 | 
183 |                         <tr valign="top">
184 |                             <th scope="mc4wp-row">
185 |                                 <label>
186 |                                     <?php esc_html_e('Text Color', 'mailchimp-top-bar'); ?>
187 |                                 </label>
188 |                             </th>
189 |                             <td>
190 |                                 <input type="text" name="<?php echo $this->name_attr('color_text'); ?>" value="<?php echo esc_attr($options[ 'color_text' ]); ?>" class="mc4wp-color">
191 |                             </td>
192 |                         </tr>
193 | 
194 |                     </table>
195 |                 </div>
196 |                 <div class="mc4wp-col mc4wp-col-2">
197 |                     <table class="form-table">
198 | 
199 |                         <?php $config = array( 'element' =>  $this->name_attr('position'), 'value' => 'top' ); ?>
200 |                         <tr valign="top" class="sticky-bar-options" data-showif="<?php echo esc_attr(json_encode($config)); ?>">
201 |                             <th scope="mc4wp-row">
202 |                                 <label>
203 |                                     <?php esc_html_e('Sticky Bar?', 'mailchimp-top-bar'); ?>
204 |                                 </label>
205 |                             </th>
206 |                             <td>
207 |                                 <label>
208 |                                     <input type="radio" name="<?php echo $this->name_attr('sticky'); ?>" value="1" <?php checked($options[ 'sticky' ], 1); ?> /> <?php esc_html_e('Yes'); ?>
209 |                                 </label> &nbsp;
210 |                                 <label>
211 |                                     <input type="radio" name="<?php echo $this->name_attr('sticky'); ?>" value="0" <?php checked($options[ 'sticky' ], 0); ?> /> <?php esc_html_e('No'); ?>
212 |                                 </label>
213 |                             </td>
214 |                         </tr>
215 | 
216 |                         <tr valign="top">
217 |                             <th scope="mc4wp-row">
218 |                                 <label>
219 |                                     <?php esc_html_e('Button Color', 'mailchimp-top-bar'); ?>
220 |                                 </label>
221 |                             </th>
222 |                             <td>
223 |                                 <input type="text" name="<?php echo $this->name_attr('color_button'); ?>" value="<?php echo esc_attr($options[ 'color_button' ]); ?>" class="mc4wp-color">
224 |                             </td>
225 |                         </tr>
226 | 
227 |                         <tr valign="top">
228 |                             <th scope="mc4wp-row">
229 |                                 <label>
230 |                                     <?php esc_html_e('Button Text Color', 'mailchimp-top-bar'); ?>
231 |                                 </label>
232 |                             </th>
233 |                             <td>
234 |                                 <input type="text" name="<?php echo $this->name_attr('color_button_text'); ?>" value="<?php echo esc_attr($options[ 'color_button_text' ]); ?>" class="mc4wp-color">
235 |                             </td>
236 |                         </tr>
237 | 
238 |                     </table>
239 |                 </div>
240 |             </div>
241 |             <br style="clear: both;" />
242 |         </div>
243 | 
244 |         <!-- Form Messages -->
245 |         <div class="mc4wp-tab <?php if ($current_tab === 'messages') {
246 |             echo 'mc4wp-tab-active';
247 |                               } ?>" id="tab-messages">
248 | 
249 |             <h2><?php esc_html_e('Messages', 'mailchimp-top-bar'); ?></h2>
250 | 
251 |             <table class="form-table">
252 |                 <tr valign="top">
253 |                     <th scope="mc4wp-row"><label><?php esc_html_e('Success', 'mailchimp-for-wp'); ?></label></th>
254 |                     <td><input type="text" class="widefat" name="<?php echo $this->name_attr('text_subscribed'); ?>" placeholder="<?php echo esc_attr($options[ 'text_subscribed' ]); ?>"  value="<?php echo esc_attr($options[ 'text_subscribed' ]); ?>" /></td>
255 |                 </tr>
256 |                 <tr valign="top">
257 |                     <th scope="mc4wp-row"><label><?php esc_html_e('Invalid email address', 'mailchimp-for-wp'); ?></label></th>
258 |                     <td><input type="text" class="widefat" name="<?php echo $this->name_attr('text_invalid_email'); ?>" placeholder="<?php echo esc_attr($options[ 'text_invalid_email' ]); ?>"  value="<?php echo esc_attr($options[ 'text_invalid_email' ]); ?>" /></td>
259 |                 </tr>
260 |                 <tr valign="top">
261 |                     <th scope="mc4wp-row"><label><?php esc_html_e('Already subscribed', 'mailchimp-for-wp'); ?></label></th>
262 |                     <td><input type="text" class="widefat" name="<?php echo $this->name_attr('text_already_subscribed'); ?>" placeholder="<?php echo esc_attr($options[ 'text_already_subscribed' ]); ?>"  value="<?php echo esc_attr($options[ 'text_already_subscribed' ]); ?>" /></td>
263 |                 </tr>
264 |                 <tr valign="top">
265 |                     <th scope="mc4wp-row"><label><?php esc_html_e('Other errors', 'mailchimp-for-wp'); ?></label></th>
266 |                     <td><input type="text" class="widefat" name="<?php echo $this->name_attr('text_error'); ?>" placeholder="<?php echo esc_attr($options[ 'text_error' ]); ?>"  value="<?php echo esc_attr($options[ 'text_error' ]); ?>" /></td>
267 |                 </tr>
268 |                 <tr>
269 |                     <th></th>
270 |                     <td>
271 |                         <p class="description"><?php printf(esc_html__('HTML tags like %s are allowed in the message fields.', 'mailchimp-for-wp'), '<code>' . esc_html('<strong><em><a>') . '</code>'); ?></p>
272 |                     </td>
273 |                 </tr>
274 |                 <tr valign="top">
275 |                     <th scope="mc4wp-row">
276 |                         <label>
277 |                             <?php esc_html_e('Redirect to URL after successful sign-ups', 'mailchimp-for-wp'); ?>
278 |                         </label>
279 |                     </th>
280 |                     <td>
281 |                         <input type="text" name="<?php echo $this->name_attr('redirect'); ?>" placeholder="<?php echo esc_attr($options[ 'redirect' ]); ?>" value="<?php echo esc_attr($options[ 'redirect' ]); ?>" class="widefat" />
282 |                         <p class="description"><?php echo wp_kses(__('Leave empty for no redirect. Otherwise, use complete (absolute) URLs, including <code>http://</code>.', 'mailchimp-for-wp'), array('code' => array())); ?></p>
283 |                     </td>
284 |                 </tr>
285 | 
286 |             </table>
287 |         </div>
288 | 
289 |         <!-- Advanced -->
290 |         <div class="mc4wp-tab <?php if ($current_tab === 'advanced') {
291 |             echo 'mc4wp-tab-active';
292 |                               } ?>" id="tab-advanced">
293 |             <h2><?php esc_html_e('Advanced', 'mailchimp-top-bar'); ?></h2>
294 | 
295 |             <table class="form-table">
296 |                 <tr valign="top" class="double-optin-options">
297 |                     <th scope="mc4wp-row">
298 |                         <label>
299 |                             <?php esc_html_e('Double opt-in?', 'mailchimp-for-wp'); ?>
300 |                         </label>
301 |                     </th>
302 |                     <td>
303 |                         <label>
304 |                             <input type="radio" name="<?php echo $this->name_attr('double_optin'); ?>" value="1" <?php checked($options[ 'double_optin' ], 1); ?> /> <?php esc_html_e('Yes'); ?>
305 |                         </label> &nbsp;
306 |                         <label>
307 |                             <input type="radio" name="<?php echo $this->name_attr('double_optin'); ?>" value="0" <?php checked($options[ 'double_optin' ], 0); ?> /> <?php esc_html_e('No'); ?>
308 |                         </label>
309 |                         <p class="description">
310 |                             <?php esc_html_e('Select "yes" if you want people to confirm their email address before being subscribed (recommended)', 'mailchimp-for-wp'); ?>
311 |                         </p>
312 |                     </td>
313 |                 </tr>
314 | 
315 |                 <?php if (! class_exists('MC4WP_API_V3')) { ?>
316 |                     <?php $config = array( 'element' => $this->name_attr('double_optin'), 'value' => 0 ); ?>
317 |                     <tr valign="top" class="send-welcome-options" data-showif="<?php echo esc_attr(json_encode($config)); ?>">
318 |                         <th scope="mc4wp-row">
319 |                             <label>
320 |                                 <?php esc_html_e('Send Welcome Email?', 'mailchimp-for-wp'); ?>
321 |                             </label>
322 |                         </th>
323 |                         <td>
324 |                             <label>
325 |                                 <input type="radio" name="<?php echo $this->name_attr('send_welcome'); ?>" value="1" <?php checked($options[ 'send_welcome' ], 1); ?> /> <?php esc_html_e('Yes'); ?>
326 |                             </label> &nbsp;
327 |                             <label>
328 |                                 <input type="radio" name="<?php echo $this->name_attr('send_welcome'); ?>" value="0" <?php checked($options[ 'send_welcome' ], 0); ?> /> <?php esc_html_e('No'); ?>
329 |                             </label>
330 |                             <p class="description">
331 |                                 <?php esc_html_e('Select "yes" if you want to send your lists Welcome Email if a subscribe succeeds (only when double opt-in is disabled).', 'mailchimp-for-wp'); ?>
332 |                             </p>
333 |                         </td>
334 |                     </tr>
335 |                 <?php } // end if MC4WP_API_v3 exists ?>
336 | 
337 |                 <tr valign="top">
338 |                     <th scope="mc4wp-row">
339 |                         <label>
340 |                             <?php esc_html_e('Update existing subscribers?', 'mailchimp-for-wp'); ?>
341 |                         </label>
342 |                     </th>
343 |                     <td>
344 |                         <label>
345 |                             <input type="radio" name="<?php echo $this->name_attr('update_existing'); ?>" value="1" <?php checked($options[ 'update_existing' ], 1); ?> /> <?php esc_html_e('Yes'); ?>
346 |                         </label> &nbsp;
347 |                         <label>
348 |                             <input type="radio" name="<?php echo $this->name_attr('update_existing'); ?>" value="0" <?php checked($options[ 'update_existing' ], 0); ?> /> <?php esc_html_e('No'); ?>
349 |                         </label>
350 |                         <p class="description">
351 |                             <?php esc_html_e('Select "yes" if you want to update existing subscribers.', 'mailchimp-for-wp'); ?>
352 |                             <?php printf(wp_kses(__('This is really only useful if you have <a href="%s">added additional fields (besides just email)</a>.', 'mailchimp-top-bar'), array('a' => array('href' => array()))), 'https://www.mc4wp.com/kb/add-name-field-to-mailchimp-top-bar/'); ?>
353 |                         </p>
354 |                     </td>
355 |                 </tr>
356 | 
357 |                 <tr valign="top">
358 |                     <th scope="mc4wp-row">
359 |                         <label>
360 |                             <?php esc_html_e('Stop loading bar after it is used?', 'mailchimp-top-bar'); ?>
361 |                         </label>
362 |                     </th>
363 |                     <td>
364 |                         <label>
365 |                             <input type="radio" name="<?php echo $this->name_attr('disable_after_use'); ?>" value="1" <?php checked($options[ 'disable_after_use' ], 1); ?> /> <?php esc_html_e('Yes'); ?>
366 |                         </label> &nbsp;
367 |                         <label>
368 |                             <input type="radio" name="<?php echo $this->name_attr('disable_after_use'); ?>" value="0" <?php checked($options[ 'disable_after_use' ], 0); ?> /> <?php esc_html_e('No'); ?>
369 |                         </label>
370 |                         <p class="description">
371 |                             <?php esc_html_e('Select "yes" if you want to completely stop loading the bar after it is successfully used to subscribe.', 'mailchimp-for-wp'); ?>
372 |                         </p>
373 |                     </td>
374 |                 </tr>
375 | 
376 |                 <tr valign="top">
377 |                     <th scope="mc4wp-row">
378 |                         <label>
379 |                             <?php esc_html_e('Do not show on pages', 'mailchimp-top-bar'); ?>
380 |                         </label>
381 |                     </th>
382 |                     <td>
383 |                         <input type="text" name="<?php echo $this->name_attr('disable_on_pages'); ?>" value="<?php echo esc_attr($options[ 'disable_on_pages' ]); ?>" class="regular-text" placeholder="<?php esc_html_e('Example: checkout, contact'); ?>" />
384 |                         <p class="description"><?php esc_html_e("Enter a comma separated list of pages to hide the bar on. Accepts page ID's or slugs.", 'mailchimp-top-bar'); ?></p>
385 |                     </td>
386 |                 </tr>
387 |             </table>
388 |         </div>
389 | 
390 | 
391 |         <?php submit_button(); ?>
392 |     </form>
393 | 
394 |     <?php
395 |     /**
396 |      * @ignore
397 |      */
398 |     do_action('mc4wp_admin_footer');
399 |     ?>
400 | 
401 | </div>
402 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | 										GNU GENERAL PUBLIC LICENSE
  2 | 											 Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 | 														Preamble
  9 | 
 10 | 	The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 | 	The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 | 	When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 | 	To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 | 	For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 | 	Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 | 	For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 | 	Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 | 	Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 | 	The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 | 											 TERMS AND CONDITIONS
 72 | 
 73 | 	0. Definitions.
 74 | 
 75 | 	"This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 | 	"Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 | 	"The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 | 	To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 | 	A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 | 	To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 | 	To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 | 	An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 | 	1. Source Code.
113 | 
114 | 	The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 | 	A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 | 	The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 | 	The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 | 	The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 | 	The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 | 	2. Basic Permissions.
155 | 
156 | 	All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 | 	You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 | 	Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 | 	3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 | 	No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 | 	When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 | 	4. Conveying Verbatim Copies.
196 | 
197 | 	You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 | 	You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 | 	5. Conveying Modified Source Versions.
209 | 
210 | 	You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 | 		a) The work must carry prominent notices stating that you modified
215 | 		it, and giving a relevant date.
216 | 
217 | 		b) The work must carry prominent notices stating that it is
218 | 		released under this License and any conditions added under section
219 | 		7.  This requirement modifies the requirement in section 4 to
220 | 		"keep intact all notices".
221 | 
222 | 		c) You must license the entire work, as a whole, under this
223 | 		License to anyone who comes into possession of a copy.  This
224 | 		License will therefore apply, along with any applicable section 7
225 | 		additional terms, to the whole of the work, and all its parts,
226 | 		regardless of how they are packaged.  This License gives no
227 | 		permission to license the work in any other way, but it does not
228 | 		invalidate such permission if you have separately received it.
229 | 
230 | 		d) If the work has interactive user interfaces, each must display
231 | 		Appropriate Legal Notices; however, if the Program has interactive
232 | 		interfaces that do not display Appropriate Legal Notices, your
233 | 		work need not make them do so.
234 | 
235 | 	A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 | 	6. Conveying Non-Source Forms.
246 | 
247 | 	You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 | 		a) Convey the object code in, or embodied in, a physical product
253 | 		(including a physical distribution medium), accompanied by the
254 | 		Corresponding Source fixed on a durable physical medium
255 | 		customarily used for software interchange.
256 | 
257 | 		b) Convey the object code in, or embodied in, a physical product
258 | 		(including a physical distribution medium), accompanied by a
259 | 		written offer, valid for at least three years and valid for as
260 | 		long as you offer spare parts or customer support for that product
261 | 		model, to give anyone who possesses the object code either (1) a
262 | 		copy of the Corresponding Source for all the software in the
263 | 		product that is covered by this License, on a durable physical
264 | 		medium customarily used for software interchange, for a price no
265 | 		more than your reasonable cost of physically performing this
266 | 		conveying of source, or (2) access to copy the
267 | 		Corresponding Source from a network server at no charge.
268 | 
269 | 		c) Convey individual copies of the object code with a copy of the
270 | 		written offer to provide the Corresponding Source.  This
271 | 		alternative is allowed only occasionally and noncommercially, and
272 | 		only if you received the object code with such an offer, in accord
273 | 		with subsection 6b.
274 | 
275 | 		d) Convey the object code by offering access from a designated
276 | 		place (gratis or for a charge), and offer equivalent access to the
277 | 		Corresponding Source in the same way through the same place at no
278 | 		further charge.  You need not require recipients to copy the
279 | 		Corresponding Source along with the object code.  If the place to
280 | 		copy the object code is a network server, the Corresponding Source
281 | 		may be on a different server (operated by you or a third party)
282 | 		that supports equivalent copying facilities, provided you maintain
283 | 		clear directions next to the object code saying where to find the
284 | 		Corresponding Source.  Regardless of what server hosts the
285 | 		Corresponding Source, you remain obligated to ensure that it is
286 | 		available for as long as needed to satisfy these requirements.
287 | 
288 | 		e) Convey the object code using peer-to-peer transmission, provided
289 | 		you inform other peers where the object code and Corresponding
290 | 		Source of the work are being offered to the general public at no
291 | 		charge under subsection 6d.
292 | 
293 | 	A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 | 	A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 | 	"Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 | 	If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 | 	The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 | 	Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 | 	7. Additional Terms.
344 | 
345 | 	"Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 | 	When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 | 	Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 | 		a) Disclaiming warranty or limiting liability differently from the
366 | 		terms of sections 15 and 16 of this License; or
367 | 
368 | 		b) Requiring preservation of specified reasonable legal notices or
369 | 		author attributions in that material or in the Appropriate Legal
370 | 		Notices displayed by works containing it; or
371 | 
372 | 		c) Prohibiting misrepresentation of the origin of that material, or
373 | 		requiring that modified versions of such material be marked in
374 | 		reasonable ways as different from the original version; or
375 | 
376 | 		d) Limiting the use for publicity purposes of names of licensors or
377 | 		authors of the material; or
378 | 
379 | 		e) Declining to grant rights under trademark law for use of some
380 | 		trade names, trademarks, or service marks; or
381 | 
382 | 		f) Requiring indemnification of licensors and authors of that
383 | 		material by anyone who conveys the material (or modified versions of
384 | 		it) with contractual assumptions of liability to the recipient, for
385 | 		any liability that these contractual assumptions directly impose on
386 | 		those licensors and authors.
387 | 
388 | 	All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 | 	If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 | 	Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 | 	8. Termination.
408 | 
409 | 	You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 | 	However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 | 	Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 | 	Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 | 	9. Acceptance Not Required for Having Copies.
436 | 
437 | 	You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 | 	10. Automatic Licensing of Downstream Recipients.
447 | 
448 | 	Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 | 	An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 | 	You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 | 	11. Patents.
472 | 
473 | 	A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 | 	A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 | 	Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 | 	In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 | 	If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 | 	If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 | 	A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 | 	Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 | 	12. No Surrender of Others' Freedom.
541 | 
542 | 	If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 | 	13. Use with the GNU Affero General Public License.
553 | 
554 | 	Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 | 	14. Revised Versions of this License.
564 | 
565 | 	The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 | 	Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 | 	If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 | 	Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 | 	15. Disclaimer of Warranty.
590 | 
591 | 	THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 | 	16. Limitation of Liability.
601 | 
602 | 	IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 | 	17. Interpretation of Sections 15 and 16.
613 | 
614 | 	If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 | 										 END OF TERMS AND CONDITIONS
622 | 
623 | 						How to Apply These Terms to Your New Programs
624 | 
625 | 	If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 | 	To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 | 		<one line to give the program's name and a brief idea of what it does.>
635 | 		Copyright (C) <year>  <name of author>
636 | 
637 | 		This program is free software: you can redistribute it and/or modify
638 | 		it under the terms of the GNU General Public License as published by
639 | 		the Free Software Foundation, either version 3 of the License, or
640 | 		(at your option) any later version.
641 | 
642 | 		This program is distributed in the hope that it will be useful,
643 | 		but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | 		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 | 		GNU General Public License for more details.
646 | 
647 | 		You should have received a copy of the GNU General Public License
648 | 		along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 | 	If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 | 		<program>  Copyright (C) <year>  <name of author>
656 | 		This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | 		This is free software, and you are welcome to redistribute it
658 | 		under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 | 	You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 | 	The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------