<?php
/**
 * +--------------------------------------------------------------------------+
 * | Copyright (c) 2008-2016 AddThis, LLC                                     |
 * +--------------------------------------------------------------------------+
 * | This program is free software; you can redistribute it and/or modify     |
 * | it under the terms of the GNU General Public License as published by     |
 * | the Free Software Foundation; either version 2 of the License, or        |
 * | (at your option) any later version.                                      |
 * |                                                                          |
 * | This program is distributed in the hope that it will be useful,          |
 * | but WITHOUT ANY WARRANTY; without even the implied warranty of           |
 * | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            |
 * | GNU General Public License for more details.                             |
 * |                                                                          |
 * | You should have received a copy of the GNU General Public License        |
 * | along with this program; if not, write to the Free Software              |
 * | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
 * +--------------------------------------------------------------------------+
 */

require_once 'AddThisFeature.php';
require_once 'AddThisGlobalOptionsTool.php';
require_once 'AddThisGlobalOptionsWidget.php';

if (!class_exists('AddThisGlobalOptionsFeature')) {
    /**
     * Class for adding AddThis global options to WordPress, such as whether to
     * load addthis_widget.js asyncronously, in the header or footer, custom
     * settings to addthis_config and addthis_share, etc.
     *
     * @category   GlobalOptions
     * @package    AddThisWordPress
     * @subpackage Features
     * @author     AddThis <help@addthis.com>
     * @license    GNU General Public License, version 2
     * @link       http://addthis.com AddThis website
     */
    class AddThisGlobalOptionsFeature extends AddThisFeature
    {
        protected $oldConfigVariableName = 'addthis_settings';
        protected $settingsVariableName = 'addthis_shared_settings';
        protected $settingsPageId = 'addthis_advanced_settings';
        protected $name = 'Advanced Settings';
        protected $GlobalOptionsToolObject = null;
        public $publicJavaScriptAction = 'addthis_global_options_settings';

        public static $anonymousProfileIdPrefix = 'wp';

        // a list of all settings fields used for this feature that aren't tool
        // specific
        protected $settingsFields = array(
            // general
            'addthis_anonymous_profile',
            'addthis_asynchronous_loading',
            'addthis_per_post_enabled',
            'addthis_profile',
            'addthis_rate_us',
            'addthis_rate_us_timestamp',
            'profile_edition',
            'api_key',
            'ajax_support',
            'credential_validation_status',
            'filter_get_the_excerpt',
            'filter_the_excerpt',
            'filter_wp_trim_excerpt',
            'script_location',
            'startUpgradeAt',
            'wpfooter',
            'xmlns_attrs',
            'follow_buttons_feature_enabled',
            'recommended_content_feature_enabled',
            'sharing_buttons_feature_enabled',
            'trending_content_feature_enabled',
            // debug settings
            'debug_enable',
            'addthis_plugin_controls',
            'addthis_environment',
            'darkseid_environment',
            'settings_ui_base_url',
            // addthis_share
            'addthis_twitter_template',
            'addthis_bitly',
            'addthis_share_json',
            'addthis_share_follow_json',
            'addthis_share_recommended_json',
            'addthis_share_trending_json',
            'addthis_share_welcome_json',
            // addthis_layers
            'addthis_layers_json',
            'addthis_layers_follow_json',
            'addthis_layers_recommended_json',
            'addthis_layers_trending_json',
            'addthis_layers_welcome_json',
            'smart_layers_bad_json',
            // addthis_config
            'data_ga_property',
            'addthis_language',
            'atversion',
            'addthis_append_data',
            'addthis_addressbar',
            'addthis_508',
            'addthis_config_json',
            'addthis_config_follow_json',
            'addthis_config_recommended_json',
            'addthis_config_trending_json',
            'addthis_config_welcome_json',
        );

        protected $defaultConfigs = array(
            // general
            'addthis_asynchronous_loading'          => false,
            'addthis_per_post_enabled'              => true,
            'addthis_profile'                       => '',
            'addthis_rate_us'                       => '',
            'profile_edition'                       => 'anonymous',
            'api_key'                               => '',
            'ajax_support'                          => false,
            'credential_validation_status'          => 0,
            'filter_get_the_excerpt'                => true,
            'filter_the_excerpt'                    => true,
            'filter_wp_trim_excerpt'                => true,
            'wpfooter'                              => true,
            'xmlns_attrs'                           => true,
            'follow_buttons_feature_enabled'        => false,
            'recommended_content_feature_enabled'   => false,
            'sharing_buttons_feature_enabled'       => false,
            'trending_content_feature_enabled'      => false,
            // debug settings
            'debug_enable'                          => false,
            'addthis_environment'                   => '',
            'addthis_plugin_controls'               => 'WordPress',
            'darkseid_environment'                  => '',
            'settings_ui_base_url'                  => '',
            // addthis_share
            'addthis_twitter_template'              => '',
            'addthis_bitly'                         => false,
            'addthis_share_json'                    => '',
            'addthis_share_follow_json'             => '',
            'addthis_share_recommended_json'        => '',
            'addthis_share_trending_json'           => '',
            'addthis_share_welcome_json'            => '',
            // addthis_layers
            'addthis_layers_json'                   => '',
            'addthis_layers_follow_json'            => '',
            'addthis_layers_recommended_json'       => '',
            'addthis_layers_trending_json'          => '',
            'addthis_layers_welcome_json'           => '',
            // addthis_config
            'data_ga_property'                      => '',
            'addthis_language'                      => '',
            'atversion'                             => 300,
            'addthis_append_data'                   => true,
            'addthis_addressbar'                    => false,
            'addthis_508'                           => '',
            'addthis_config_json'                   => '',
            'addthis_config_follow_json'            => '',
            'addthis_config_recommended_json'       => '',
            'addthis_config_trending_json'          => '',
            'addthis_config_welcome_json'           => '',
        );

        // require the files with the tool and widget classes at the top of this
        // file for each tool
        // make a protected variable matching the name for each
        // tool + ToolObject
        protected $tools = array(
            'GlobalOptions',
        );

        /**
         * The constructor.
         *
         * @param AddThisGlobalOptionsFeature $globalOptionsObject the object
         * for the Global Options feature. Optional.
         *
         * @return null
         */
        public function __construct($globalOptionsObject = null)
        {
            $this->globalOptionsObject = $this;
        }

        /**
         * Determines if the Profile ID used on this website is for a PRO
         * account or a basic one.
         *
         * @return boolean true for PRO, false for BASIC
         */
        public function isProProfile()
        {
            if (!empty($this->configs['profile_edition'])
                && $this->configs['profile_edition'] == 'pro'
            ) {
                return true;
            }

            return false;
        }

        /**
         * Goes out to AddThis' darkseid API and updates the profile edition for
         * the profile on this site.
         *
         * @return true is changed, false if it stayed the same (so that the
         * thing calling it knows when to save a settings change)
         */
        public function updateProfileEdition()
        {
            $oldEdition = $this->configs['profile_edition'];

            $profileId = $this->getProfileId();
            if (empty($profileId) || !$this->inRegisteredMode()) {
                $newEdition = 'anonymous';
            } else {
                $boost = $this->getBoostConfig();

                if (isset($boost['subscription']['edition'])) {
                    if ($boost['subscription']['edition'] == 'PRO') {
                        $newEdition = 'pro';
                    } else {
                        $newEdition = 'basic';
                    }
                } else {
                    $newEdition = 'anonymous';
                }
            }

            if ($oldEdition != $newEdition) {
                $this->configs['profile_edition'] = $newEdition;
                return true;
            }

            return false;
        }

        /**
         * This must be public as it's used in a callback for add_action
         *
         * Prints out a JSON payload with settings for a profile ID. Requires a
         * profile id.
         *
         * @return null
         */
        public function getBoostConfig()
        {
            $profileId = $this->getProfileId();

            if (!empty($profileId) && $this->inRegisteredMode()) {
                $url = $this->getDarkseidBaseUrl() . 'wordpress/site/'.$profileId;
                $response = wp_remote_get($url);

                if (!is_wp_error($response)
                    && isset($response['response']['code'])
                    && $response['response']['code'] == 200
                ) {
                    $config = json_decode($response['body'], true);
                    return $config;
                }
            }

            return false;
        }

        /**
         * Determines whether to use layers API code
         *
         * @return boolean true for layers API, false for lojson/boost
         */
        public function inAnonymousMode()
        {
            if (isset($this->configs['addthis_plugin_controls'])
                && $this->configs['addthis_plugin_controls'] != 'AddThis'
            ) {
                return true;
            }

            return false;
        }

        /**
         * Determines whether to use lojson/boost code
         *
         * @return boolean true for lojson/boost, false for layers API
         */
        public function inRegisteredMode()
        {
            return !$this->inAnonymousMode();
        }

        /**
         * The profile ID that should be used when loading addthis_widget.js
         *
         * @return string a profile ID
         */
        public function getUsableProfileId()
        {
            if ($this->getProfileId()) {
                $profileId = $this->getProfileId();
            } else {
                $profileId = $this->getAnonymousProfileId();
            }

            return $profileId;
        }

        /**
         * Returns the users Profile ID, if they set one. A blank string
         * otherwise.
         *
         * @return string
         */
        public function getProfileId()
        {
            if (isset($this->configs['addthis_profile'])
               && !empty($this->configs['addthis_profile'])
            ) {
                return $this->configs['addthis_profile'];
            }

            return '';
        }

        /**
         * Returns the anonymous profile ID to use for this site. If the user
         * upgrades in the future to not be anonymous, we can use this to grab
         * their historical share data and associate it with their AddThis
         * account
         *
         * @return string
         */
        public function getAnonymousProfileId()
        {
            if (!isset($this->configs['addthis_anonymous_profile'])
               || !$this->configs['addthis_anonymous_profile']
            ) {
                $prefix = $this->getAnonymousProfileIdPrefix();
                $postfix = $this->getAnonymousProfileHash();
                $profileId = $prefix . '-' . $postfix;
                $this->configs['addthis_anonymous_profile'] = $profileId;
                $this->saveConfigs();
            }

            return $this->configs['addthis_anonymous_profile'];
        }

        /**
         * Returns the anonymous profile has for this site based on the homepage
         * URL
         *
         * @return string
         */
        public function getAnonymousProfileHash()
        {
            $url = $this->getHomepageUrl();
            $hash = hash_hmac('md5', $url, 'addthis');
            return $hash;
        }

        /**
         * Returns the prefix to use on anonmyous profile IDs.
         *
         * @return string
         */
        private static function getAnonymousProfileIdPrefix()
        {
            return self::$anonymousProfileIdPrefix;
        }

        /**
         * Returns the URL for this sites homepage
         *
         * @return string
         */
        public function getHomepageUrl()
        {
            $url = get_option('home');
            return $url;
        }

        /**
         * This must be public as it's used in a callback for register_setting,
         * which is essentially a filter
         *
         * This takes form input for a settings variable, manipulates it, and
         * returns the variables that should be saved to the database.
         *
         * Sadly, this must match (at least functionally) the global options
         * sanitizer for the sharing buttons plugin, at least until we bring
         * that plugin into the fold.
         *
         * @param array $input An associative array of values input for this
         * feature's settings
         *
         * @return array A cleaned up associative array of settings specific to
         *               this feature.
         */
        public function sanitizeSettings($input)
        {
            if (!is_array($input) || empty($input)) {
                return $this->configs;
            }

            $output = $this->configs;

            if (empty($input['wpfooter'])) {
                $output['wpfooter'] = false;
                $output['script_location'] = 'header';
            } else {
                $output['wpfooter'] = true;
                $output['script_location'] = 'footer';
            }

            if (isset($input['script_location'])
                && $input['script_location'] == 'footer'
            ) {
                $output['wpfooter'] = true;
                $output['script_location'] = 'footer';
            } elseif (isset($input['script_location'])) {
                $output['wpfooter'] = false;
                $output['script_location'] = 'header';
            }

            $checkboxFields = array(
                'addthis_508',
                'addthis_addressbar',
                'addthis_append_data',
                'addthis_asynchronous_loading',
                'addthis_bitly',
                'addthis_per_post_enabled',
                'ajax_support',
                'debug_enable',
                'filter_get_the_excerpt',
                'filter_the_excerpt',
                'filter_wp_trim_excerpt',
                'xmlns_attrs',
            );

            foreach ($checkboxFields as $field) {
                if (isset($input[$field]) && $input[$field]) {
                    $output[$field] = true;
                } else {
                    $output[$field] = false;
                }
            }

            $checkAndSanitize = array(
                'addthis_config_json',
                'addthis_environment',
                'addthis_language',
                'addthis_layers_json',
                'addthis_plugin_controls',
                'addthis_profile',
                'addthis_rate_us',
                'addthis_rate_us_timestamp',
                'addthis_share_json',
                'addthis_twitter_template',
                'api_key',
                'atversion',
                'credential_validation_status',
                'darkseid_environment',
                'data_ga_property',
                'profile_edition',
                'script_location',
                'settings_ui_base_url',
            );

            foreach ($checkAndSanitize as $field) {
                if (isset($input[$field])) {
                    $output[$field] = sanitize_text_field($input[$field]);
                }
            }

            $output = $this->addDefaultConfigs($output);
            return $output;
        }

        /**
         * Creates feature specific settings for the JavaScript variable
         * addthis_share
         *
         * @return array an associative array
         */
        public function getAddThisShare()
        {
            $featureShare = array();

            if (!empty($this->configs['addthis_twitter_template'])) {
                $featureShare['passthrough']['twitter']['via'] = esc_js($this->configs['addthis_twitter_template']);
            }

            if (!empty($this->configs['addthis_bitly'])) {
                $featureShare['url_transforms']['shorten']['twitter'] = 'bitly';
                $featureShare['shorteners']['bitly'] = new stdClass();
            }

            return $featureShare;
        }

        /**
         * Creates feature specific settings for the JavaScript variable
         * addthis_config
         *
         * @return array an associative array
         */
        public function getAddThisConfig()
        {
            $featureConfig = array(
                'data_track_clickback' => false,
            );

            if ($this->inAnonymousMode()) {
                $featureConfig['ignore_server_config'] = true;
            }


            if (!empty($this->configs['data_ga_property'])) {
                $featureConfig['data_ga_property'] = $this->configs['data_ga_property'];
                $featureConfig['data_ga_social'] = true;
            }

            if (isset($this->configs['addthis_language'])
                && strlen($this->configs['addthis_language']) == 2
            ) {
                $featureConfig['ui_language'] = $this->configs['addthis_language'];
            }

            if (isset($this->configs['atversion'])) {
                $featureConfig['ui_atversion'] = $this->configs['atversion'];
            }

            $simpleCheckboxOptions = array(
                array(
                    'wpSetting'      => 'addthis_append_data',
                    'clientSetting' => 'data_track_clickback',
                ),
                array(
                    'wpSetting'      => 'addthis_addressbar',
                    'clientSetting' => 'data_track_addressbar',
                ),
                array(
                    'wpSetting'      => 'addthis_508',
                    'clientSetting' => 'ui_508_compliant',
                ),
            );

            foreach ($simpleCheckboxOptions as $option) {
                if (!empty($this->configs[$option['wpSetting']])) {
                    $featureConfig[$option['clientSetting']] = true;
                }
            }

            return $featureConfig;
        }

        /**
         * Creates feature specific settings for the JavaScript variable
         * addthis_layers, used to bootstrap layers
         *
         * @return array an associative array
         */
        public function getAddThisLayers()
        {
            $featureLayers = array();
            return $featureLayers;
        }

        /**
         * Determines if this feature is enabled by any plugin, not necessarily
         * the plugin that boostrapped this object. Global options is always
         * enabled.
         *
         * @return boolean
         */
        public function isEnabled()
        {
            return true;
        }

        /**
         * Returns the URL to use for addthis_widget.js. Based on the
         * enviornment variable
         *
         * @return string
         */
        public function getAddThisWidgetJavaScriptUrl()
        {
            $urlRoot = 'https://s7.addthis.com/js/';

            if (!empty($this->configs['debug_enable'])
                && !empty($this->configs['addthis_environment'])
            ) {
                $env = $this->configs['addthis_environment'];
                $urlRoot = '//cache-' . $env . '.addthis.com/js/';
            }

            $url = $urlRoot .
                '300/addthis_widget.js#pubid=' .
                urlencode($this->getUsableProfileId());

            return $url;
        }

        /**
         * Gets the base URL for the settings UI angular app
         *
         * @return string
         */
        public function getSettingsUiBaseUrl()
        {
            if (!empty($this->configs['debug_enable'])
                && !empty($this->configs['settings_ui_base_url'])
            ) {
                $dirtyUrl = trim($this->configs['settings_ui_base_url']);
                if (substr($dirtyUrl, -1) !== '/') {
                    $dirtyUrl .= '/';
                }
                $settingsUiRoot = $dirtyUrl;
            } else {
                $settingsUiRoot = $this->getPluginUrl() . '/frontend/';
            }

            return $settingsUiRoot;
        }

        /**
         * Gives you the base URL for AddThis API calls (to darkseid)
         *
         * @return string
         */
        public function getDarkseidBaseUrl()
        {
            if (!empty($this->configs['debug_enable'])
                && !empty($this->configs['darkseid_environment'])
            ) {
                $env = $this->configs['darkseid_environment'];
                $url = 'https://www-'. $env .'.addthis.com/darkseid/';
            } else {
                $url = 'https://www.addthis.com/darkseid/';
            }

            return $url;
        }

        /**
         * Upgrade from old addthis_settings format to
         * new addthis_shared_settings
         *
         * @return null
         */
        protected function upgradeIterative1()
        {
            $oldSettings = get_option('addthis_settings');
            $newSettings = array();

            if (!is_array($oldSettings)) {
                return null;
            }

            if (is_array($this->configs)) {
                $newSettings = $this->configs;
            }

            if (!isset($newSettings['wpfooter'])
                && isset($oldSettings['wpfooter'])
            ) {
                $newSettings['wpfooter'] = (boolean)$oldSettings['wpfooter'];
                if ($newSettings['wpfooter']) {
                    $newSettings['script_location'] = 'footer';
                } else {
                    $newSettings['script_location'] = 'header';
                }
            }

            $anonProfileHash = $this->getAnonymousProfileHash();
            $anonProfileId = $this->getAnonymousProfileId();

            if (!isset($newSettings['addthis_profile'])) {
                if (isset($oldSettings['profile'])) {
                    $profileId = $oldSettings['profile'];
                } elseif (isset($oldSettings['pubid'])) {
                    $profileId = $oldSettings['pubid'];
                }

                if (isset($profileId)) {
                    if ($profileId == $anonProfileId
                        || $profileId == $anonProfileHash
                    ) {
                        $newSettings['addthis_anonymous_profile'] = $profileId;
                    } else {
                        $newSettings['addthis_profile'] = $profileId;
                    }
                }
            } elseif ($newSettings['addthis_profile'] == $anonProfileId
                || $newSettings['addthis_profile'] == $anonProfileHash
            ) {
                $newSettings['addthis_anonymous_profile'] = $newSettings['addthis_profile'];
                unset($newSettings['addthis_profile']);
            }

            if (!isset($newSettings['addthis_anonymous_profile'])) {
                $newSettings['addthis_anonymous_profile'] = $anonProfileId;
            }

            if (isset($this->configs['addthis_for_wordpress'])
                && $this->configs['addthis_for_wordpress']
                && !isset($this->configs['addthis_plugin_controls'])
            ) {
                $newSettings['addthis_plugin_controls'] = 'AddThis';
            }

            foreach ($oldSettings as $field => $value) {
                if (!isset($newField[$field])
                    && in_array($field, $this->settingsFields)
                ) {
                    $newSettings[$field] = $value;
                }
            }

            foreach ($newSettings as $field => $value) {
                if (!in_array($field, $this->settingsFields)) {
                    unset($newSettings[$field]);
                }
            }

            $this->configs = $newSettings;
        }

        /**
         * Registering AJAX endpoints with WordPress
         *
         * @return null
         */
        protected function registerAjaxEndpoints()
        {
            parent::registerAjaxEndpoints();

            // nonce stuff for the UI
            add_action('wp_ajax_addthis_nonce', array($this, 'printGetJsonNonce'));
        }

        /**
         * This must be public as it's used in a callback for add_action
         *
         * Prints a JSON payload with a nonce value for the current user for
         * use with addthis_settings_update actions
         *
         * @return null
         */
        public function printGetJsonNonce()
        {
            $this->jsonSetup();
            $nonce = wp_create_nonce('addthis_settings_update');
            $results = array('nonce' => $nonce);
            $this->printJsonResults($results);
        }

        /**
         * Does special stuff for the minimal plugin then calls the parent
         * version of this function
         *
         * @param array $configs The current configs.
         *
         * @return array
         */
        protected function addDefaultConfigs($configs)
        {
            // if the mode isn't set yet, and this is the minimal plugin
            // the default mode should be AddThis
            if (!isset($configs['addthis_plugin_controls'])
                && isset($configs['follow_buttons_feature_enabled'])
                && $configs['follow_buttons_feature_enabled'] === false
                && isset($configs['recommended_content_feature_enabled'])
                && $configs['recommended_content_feature_enabled'] === false
                && isset($configs['sharing_buttons_feature_enabled'])
                && $configs['sharing_buttons_feature_enabled'] === false
                && isset($configs['trending_content_feature_enabled'])
                && $configs['trending_content_feature_enabled'] === false
            ) {
                $configs['addthis_plugin_controls'] === 'AddThis';
            }

            $output = parent::addDefaultConfigs($configs);
            return $output;
        }
    }
}