| Current File : //home/quantums/gsc-ltd.net/wp-content/plugins/newsletter/includes/module.php |
<?php
defined('ABSPATH') || exit;
require_once __DIR__ . '/logger.php';
require_once __DIR__ . '/store.php';
require_once __DIR__ . '/composer.php';
require_once __DIR__ . '/addon.php';
require_once __DIR__ . '/mailer.php';
require_once __DIR__ . '/themes.php';
class TNP_Media {
var $id;
var $url;
var $width;
var $height;
var $alt;
var $link;
var $align = 'center';
/** Sets the width recalculating the height */
public function set_width($width) {
$width = (int) $width;
if (empty($width))
return;
if ($this->width < $width)
return;
$this->height = floor(($width / $this->width) * $this->height);
$this->width = $width;
}
/** Sets the height recalculating the width */
public function set_height($height) {
$height = (int) $height;
$this->width = floor(($height / $this->height) * $this->width);
$this->height = $height;
}
}
/**
* @property int $id The list unique identifier
* @property string $name The list name
* @property bool $forced If the list must be added to every new subscriber
* @property int $status When and how the list is visible to the subscriber - see constants
* @property bool $checked If it must be pre-checked on subscription form
* @property array $languages The list of language used to pre-assign this list
*/
class TNP_List {
const STATUS_PRIVATE = 0;
const STATUS_PUBLIC = 1;
const SUBSCRIPTION_HIDE = 0;
const SUBSCRIPTION_SHOW = 1;
const SUBSCRIPTION_SHOW_CHECKED = 2;
const PROFILE_HIDE = 0;
const PROFILE_SHOW = 1;
var $id;
var $name;
var $status;
var $forced;
var $checked;
var $show_on_subscription;
var $show_on_profile;
function is_private() {
return $this->status == self::STATUS_PRIVATE;
}
}
/**
* @property int $id The list unique identifier
* @property string $name The list name
* @property int $status When and how the list is visible to the subscriber - see constants
* @property string $type Field type: text or select
* @property array $options Field options (usually the select items)
*/
class TNP_Profile {
const STATUS_PRIVATE = 0;
const STATUS_PUBLIC = 2;
const STATUS_PROFILE_ONLY = 1;
const STATUS_HIDDEN = 3; // Public but never shown (can be set with a hidden form field)
const TYPE_TEXT = 'text';
const TYPE_SELECT = 'select';
public $id;
public $name;
public $status;
public $type;
public $options;
public $placeholder;
public $rule;
public function __construct($id, $name, $status, $type, $options, $placeholder, $rule) {
$this->id = $id;
$this->name = $name;
$this->status = $status;
$this->type = $type;
$this->options = $options;
$this->placeholder = $placeholder;
$this->rule = $rule;
}
function is_select() {
return $this->type == self::TYPE_SELECT;
}
function is_text() {
return $this->type == self::TYPE_TEXT;
}
function is_required() {
return $this->rule == 1;
}
function is_private() {
return $this->status == self::STATUS_PRIVATE;
}
function show_on_profile() {
return $this->status == self::STATUS_PROFILE_ONLY || $this->status == self::STATUS_PUBLIC;
}
}
class TNP_Profile_Service {
/**
*
* @param string $language
* @param string $type
* @return TNP_Profile[]
*/
static function get_profiles($language = '', $type = '') {
static $profiles = [];
$k = $language . $type;
if (isset($profiles[$k])) {
return $profiles[$k];
}
$profiles[$k] = [];
$profile_options = NewsletterSubscription::instance()->get_options('profile', $language);
for ($i = 1; $i <= NEWSLETTER_PROFILE_MAX; $i++) {
if (empty($profile_options['profile_' . $i])) {
continue;
}
$profile = self::create_profile_from_options($profile_options, $i);
if (empty($type) ||
( $type == TNP_Profile::TYPE_SELECT && $profile->is_select() ) ||
( $type == TNP_Profile::TYPE_TEXT && $profile->is_text() )) {
$profiles[$k]['' . $i] = $profile;
}
}
return $profiles[$k];
}
static function get_profile_by_id($id, $language = '') {
$profiles = self::get_profiles($language);
if (isset($profiles[$id]))
return $profiles[$id];
return null;
}
/**
* @return TNP_Profile
*/
private static function create_profile_from_options($options, $id) {
return new TNP_Profile(
$id,
$options['profile_' . $id],
(int) $options['profile_' . $id . '_status'],
$options['profile_' . $id . '_type'],
self::string_db_options_to_array($options['profile_' . $id . '_options']),
$options['profile_' . $id . '_placeholder'],
$options['profile_' . $id . '_rules']
);
}
/**
* Returns a list of strings which are the items for the select field.
* @return array
*/
private static function string_db_options_to_array($string_options) {
$items = array_map('trim', explode(',', $string_options));
$items = array_combine($items, $items);
return $items;
}
}
/**
* Represents the set of data collected by a subscription interface (form, API, ...). Only a valid
* email is mandatory.
*/
class TNP_Subscription_Data {
var $email = null;
var $name = null;
var $surname = null;
var $sex = null;
var $language = null;
var $referrer = null;
var $http_referrer = null;
var $ip = null;
var $country = null;
var $region = null;
var $city = null;
/**
* Associative array id=>value of lists chosen by the subscriber. A list can be set to
* 0 meaning the subscriber does not want to be in that list.
* The lists must be public: non public lists are filtered.
* @var array
*/
var $lists = [];
var $profiles = [];
function merge_in($subscriber) {
if (!$subscriber)
$subscriber = new TNP_User();
if (!empty($this->email))
$subscriber->email = $this->email;
if (!empty($this->name))
$subscriber->name = $this->name;
if (!empty($this->surname))
$subscriber->surname = $this->surname;
if (!empty($this->sex))
$subscriber->sex = $this->sex;
if (!empty($this->language))
$subscriber->language = $this->language;
if (!empty($this->ip))
$subscriber->ip = $this->ip;
if (!empty($this->referrer))
$subscriber->referrer = $this->referrer;
if (!empty($this->http_referrer))
$subscriber->http_referrer = $this->http_referrer;
if (!empty($this->country))
$subscriber->country = $this->country;
if (!empty($this->region))
$subscriber->region = $this->region;
if (!empty($this->city))
$subscriber->city = $this->city;
foreach ($this->lists as $id => $value) {
$key = 'list_' . $id;
$subscriber->$key = $value;
}
// Profile
foreach ($this->profiles as $id => $value) {
$key = 'profile_' . $id;
$subscriber->$key = $value;
}
}
/** Sets to active a set of lists. Accepts incorrect data (and ignores it).
*
* @param array $list_ids Array of list IDs
*/
function add_lists($list_ids) {
if (empty($list_ids) || !is_array($list_ids))
return;
foreach ($list_ids as $list_id) {
$list_id = (int) $list_id;
if ($list_id < 0 || $list_id > NEWSLETTER_LIST_MAX)
continue;
$this->lists[$list_id] = 1;
}
}
}
/**
* Represents a subscription request with the subscriber data and actions to be taken by
* the subscription engine (spam check, notifications, ...).
*/
class TNP_Subscription {
const EXISTING_ERROR = 1;
const EXISTING_MERGE = 0;
const EXISTING_SINGLE_OPTIN = 2;
/**
* Subscriber's data following the syntax of the TNP_User
* @var TNP_Subscription_Data
*/
var $data;
var $spamcheck = true;
// The optin to use, empty for the plugin default. It's a string to facilitate the use by addons (which have a selector for the desired
// optin as empty (for default), 'single' or 'double'.
var $optin = null;
// What to do with an existing subscriber???
var $if_exists = self::EXISTING_MERGE;
/**
* Determines if the welcome or activation email should be sent. Note: sometime an activation email is sent disregarding
* this setting.
* @var boolean
*/
var $send_emails = true;
public function __construct() {
$this->data = new TNP_Subscription_Data();
}
public function is_single_optin() {
return $this->optin == 'single';
}
public function is_double_optin() {
return $this->optin == 'double';
}
}
/**
* @property int $id The subscriber unique identifier
* @property string $email The subscriber email
* @property string $name The subscriber name or first name
* @property string $surname The subscriber last name
* @property string $status The subscriber status
* @property string $language The subscriber language code 2 chars lowercase
* @property string $token The subscriber secret token
* @property string $country The subscriber country code 2 chars uppercase
*/
class TNP_User {
const STATUS_CONFIRMED = 'C';
const STATUS_NOT_CONFIRMED = 'S';
const STATUS_UNSUBSCRIBED = 'U';
const STATUS_BOUNCED = 'B';
const STATUS_COMPLAINED = 'P';
var $ip = '';
public static function get_status_label($status) {
switch ($status) {
case self::STATUS_NOT_CONFIRMED: return __('NOT CONFIRMED', 'newsletter');
break;
case self::STATUS_CONFIRMED: return __('CONFIRMED', 'newsletter');
break;
case self::STATUS_UNSUBSCRIBED: return __('UNSUBSCRIBED', 'newsletter');
break;
case self::STATUS_BOUNCED: return __('BOUNCED', 'newsletter');
break;
case self::STATUS_COMPLAINED: return __('COMPLAINED', 'newsletter');
break;
default:
return __('Unknown', 'newsletter');
}
}
}
/**
* @property int $id The email unique identifier
* @property string $subject The email subject
* @property string $message The email html message
* @property int $track Check if the email stats should be active
* @property array $options Email options
* @property int $total Total emails to send
* @property int $sent Total sent emails by now
* @property int $open_count Total opened emails
* @property int $click_count Total clicked emails
* */
class TNP_Email {
const STATUS_DRAFT = 'new';
const STATUS_SENT = 'sent';
const STATUS_SENDING = 'sending';
const STATUS_PAUSED = 'paused';
const STATUS_ERROR = 'error';
}
class NewsletterModule {
/**
* @var NewsletterLogger
*/
var $logger;
/**
* @var NewsletterLogger
*/
var $admin_logger;
/**
* @var NewsletterStore
*/
var $store;
/**
* The main module options
* @var array
*/
var $options;
/**
* @var string The module name
*/
var $module;
/**
* The module version
* @var string
*/
var $version;
var $old_version;
/**
* Prefix for all options stored on WordPress options table.
* @var string
*/
var $prefix;
/**
* @var NewsletterThemes
*/
var $themes;
var $components;
static $current_language = '';
function __construct($module, $version, $module_id = null, $components = array()) {
$this->module = $module;
$this->version = $version;
$this->prefix = 'newsletter_' . $module;
array_unshift($components, '');
$this->components = $components;
$this->logger = new NewsletterLogger($module);
$this->options = $this->get_options();
$this->store = NewsletterStore::singleton();
//$this->logger->debug($module . ' constructed');
// Version check
if (is_admin()) {
$this->admin_logger = new NewsletterLogger($module . '-admin');
$this->old_version = get_option($this->prefix . '_version', '0.0.0');
if ($this->old_version == '0.0.0') {
require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
$this->first_install();
update_option($this->prefix . "_first_install_time", time(), FALSE);
}
if (strcmp($this->old_version, $this->version) != 0) {
require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
$this->logger->info('Version changed from ' . $this->old_version . ' to ' . $this->version);
// Do all the stuff for this version change
$this->upgrade();
update_option($this->prefix . '_version', $this->version);
}
add_action('admin_menu', array($this, 'admin_menu'));
}
}
/**
*
* @global wpdb $wpdb
* @param string $query
*/
function query($query) {
global $wpdb;
$this->logger->debug($query);
//$start = microtime(true);
$r = $wpdb->query($query);
//$this->logger->debug($wpdb->last_query);
//$this->logger->debug('Execution time: ' . (microtime(true)-$start));
//$this->logger->debug('Result: ' . $r);
if ($r === false) {
$this->logger->fatal($query);
$this->logger->fatal($wpdb->last_error);
}
return $r;
}
function get_results($query) {
global $wpdb;
$r = $wpdb->get_results($query);
if ($r === false) {
$this->logger->fatal($query);
$this->logger->fatal($wpdb->last_error);
}
return $r;
}
/**
*
* @global wpdb $wpdb
* @param string $table
* @param array $data
*/
function insert($table, $data) {
global $wpdb;
$this->logger->debug("inserting into table $table");
$r = $wpdb->insert($table, $data);
if ($r === false) {
$this->logger->fatal($wpdb->last_error);
}
}
function first_install() {
$this->logger->debug('First install');
}
/**
* Does a basic upgrade work, checking if the options is already present and if not (first
* installation), recovering the defaults, saving them on database and initializing the
* internal $options.
*/
function upgrade() {
foreach ($this->components as $component) {
$this->logger->debug('Upgrading component ' . $component);
$this->init_options($component);
}
}
function init_options($component = '', $autoload = true) {
global $wpdb;
$default_options = $this->get_default_options($component);
$options = $this->get_options($component);
$options = array_merge($default_options, $options);
$this->save_options($options, $component, $autoload);
}
function upgrade_query($query) {
global $wpdb, $charset_collate;
$this->logger->info('upgrade_query> Executing ' . $query);
$suppress_errors = $wpdb->suppress_errors(true);
$wpdb->query($query);
if ($wpdb->last_error) {
$this->logger->debug($wpdb->last_error);
}
$wpdb->suppress_errors($suppress_errors);
}
/** Returns a prefix to be used for option names and other things which need to be uniquely named. The parameter
* "sub" should be used when a sub name is needed for another set of options or like.
*
* @param string $sub
* @return string The prefix for names
*/
function get_prefix($sub = '', $language = '') {
return $this->prefix . (!empty($sub) ? '_' : '') . $sub . (!empty($language) ? '_' : '') . $language;
}
/**
* Returns the options of a module, if not found an empty array.
*/
function get_options($sub = '', $language = '') {
$options = get_option($this->get_prefix($sub, $language), array());
// Protection against scarmled database...
if (!is_array($options)) {
$options = array();
}
if ($language) {
$main_options = get_option($this->get_prefix($sub));
// Protection against scarmled database...
if (!is_array($main_options))
$main_options = array();
//$options = array_merge($main_options, array_filter($options));
$options = array_merge($main_options, $options);
}
return $options;
}
function get_default_options($sub = '') {
if (!empty($sub)) {
$sub = '-' . $sub;
}
$file = NEWSLETTER_DIR . '/' . $this->module . '/defaults' . $sub . '.php';
if (file_exists($file)) {
@include $file;
}
if (!isset($options) || !is_array($options)) {
return array();
}
return $options;
}
function reset_options($sub = '') {
$this->save_options(array_merge($this->get_options($sub), $this->get_default_options($sub)), $sub);
return $this->get_options($sub);
}
/**
* Saves the module options (or eventually a subset names as per parameter $sub). $options
* should be an array (even if it can work with non array options.
* The internal module options variable IS initialized with those new options only for the main
* options (empty $sub parameter).
* If the options contain a "theme" value, the theme-related options contained are saved as well
* (used by some modules).
*
* @param array $options
* @param string $sub
*/
function save_options($options, $sub = '', $autoload = null, $language = '') {
update_option($this->get_prefix($sub, $language), $options, $autoload);
if (empty($sub) && empty($language)) {
$this->options = $options;
if (isset($this->themes) && isset($options['theme'])) {
$this->themes->save_options($options['theme'], $options);
}
}
}
function delete_options($sub = '') {
delete_option($this->get_prefix($sub));
if (empty($sub)) {
$this->options = array();
}
}
function merge_options($options, $sub = '', $language = '') {
if (!is_array($options)) {
$options = array();
}
$old_options = $this->get_options($sub, $language);
$this->save_options(array_merge($old_options, $options), $sub, null, $language);
}
function backup_options($sub) {
$options = $this->get_options($sub);
update_option($this->get_prefix($sub) . '_backup', $options, false);
}
function get_last_run($sub = '') {
return get_option($this->get_prefix($sub) . '_last_run', 0);
}
/**
* Save the module last run value. Used to store a timestamp for some modules,
* for example the Feed by Mail module.
*
* @param int $time Unix timestamp (as returned by time() for example)
* @param string $sub Sub module name (default empty)
*/
function save_last_run($time, $sub = '') {
update_option($this->get_prefix($sub) . '_last_run', $time);
}
/**
* Sums $delta seconds to the last run time.
* @param int $delta Seconds
* @param string $sub Sub module name (default empty)
*/
function add_to_last_run($delta, $sub = '') {
$time = $this->get_last_run($sub);
$this->save_last_run($time + $delta, $sub);
}
/**
* Checks if the semaphore of that name (for this module) is still red. If it is active the method
* returns false. If it is not active, it will be activated for $time seconds.
*
* Since this method activate the semaphore when called, it's name is a bit confusing.
*
* @param string $name Sempahore name (local to this module)
* @param int $time Max time in second this semaphore should stay red
* @return boolean False if the semaphore is red and you should not proceed, true is it was not active and has been activated.
*/
function check_transient($name, $time) {
if ($time < 60)
$time = 60;
//usleep(rand(0, 1000000));
if (($value = get_transient($this->get_prefix() . '_' . $name)) !== false) {
list($t, $v) = explode(';', $value, 2);
$this->logger->error('Blocked by transient ' . $this->get_prefix() . '_' . $name . ' set ' . (time() - $t) . ' seconds ago by ' . $v);
return false;
}
//$ip = ''; //gethostbyname(gethostname());
$value = time() . ";" . ABSPATH . ';' . gethostname();
set_transient($this->get_prefix() . '_' . $name, $value, $time);
return true;
}
function delete_transient($name = '') {
delete_transient($this->get_prefix() . '_' . $name);
}
/** Returns a random token of the specified size (or 10 characters if size is not specified).
*
* @param int $size
* @return string
*/
static function get_token($size = 10) {
return substr(md5(rand()), 0, $size);
}
/**
* Adds query string parameters to an URL checing id there are already other parameters.
*
* @param string $url
* @param string $qs The part of query-string to add (param1=value1¶m2=value2...)
* @param boolean $amp If the method must use the & instead of the plain & (default true)
* @return string
*/
static function add_qs($url, $qs, $amp = true) {
if (strpos($url, '?') !== false) {
if ($amp)
return $url . '&' . $qs;
else
return $url . '&' . $qs;
} else
return $url . '?' . $qs;
}
/**
* Returns the email address normalized, lowercase with no spaces. If it's not a valid email
* returns false.
*/
static function normalize_email($email) {
if (!is_string($email)) {
return false;
}
$email = strtolower(trim($email));
if (!is_email($email)) {
return false;
}
//$email = apply_filters('newsletter_normalize_email', $email);
return $email;
}
static function normalize_name($name) {
$name = html_entity_decode($name, ENT_QUOTES);
$name = str_replace(';', ' ', $name);
$name = strip_tags($name);
return $name;
}
static function normalize_sex($sex) {
$sex = trim(strtolower($sex));
if ($sex != 'f' && $sex != 'm') {
$sex = 'n';
}
return $sex;
}
static function is_email($email, $empty_ok = false) {
if (!is_string($email)) {
return false;
}
$email = strtolower(trim($email));
if ($email == '') {
return $empty_ok;
}
if (!is_email($email)) {
return false;
}
return true;
}
/**
* Converts a GMT date from mysql (see the posts table columns) into a timestamp.
*
* @param string $s GMT date with format yyyy-mm-dd hh:mm:ss
* @return int A timestamp
*/
static function m2t($s) {
// TODO: use the wordpress function I don't remember the name
$s = explode(' ', $s);
$d = explode('-', $s[0]);
$t = explode(':', $s[1]);
return gmmktime((int) $t[0], (int) $t[1], (int) $t[2], (int) $d[1], (int) $d[2], (int) $d[0]);
}
static function format_date($time) {
if (empty($time)) {
return '-';
}
return gmdate(get_option('date_format') . ' ' . get_option('time_format'), $time + get_option('gmt_offset') * 3600);
}
static function format_time_delta($delta) {
$days = floor($delta / (3600 * 24));
$hours = floor(($delta % (3600 * 24)) / 3600);
$minutes = floor(($delta % 3600) / 60);
$seconds = floor(($delta % 60));
$buffer = $days . ' days, ' . $hours . ' hours, ' . $minutes . ' minutes, ' . $seconds . ' seconds';
return $buffer;
}
/**
* Formats a scheduler returned "next execution" time, managing negative or false values. Many times
* used in conjuction with "last run".
*
* @param string $name The scheduler name
* @return string
*/
static function format_scheduler_time($name) {
$time = wp_next_scheduled($name);
if ($time === false) {
return 'No next run scheduled';
}
$delta = $time - time();
// If less 10 minutes late it can be a cron problem but now it is working
if ($delta < 0 && $delta > -600) {
return 'Probably running now';
} else if ($delta <= -600) {
return 'It seems the cron system is not working. Reload the page to see if this message change.';
}
return 'Runs in ' . self::format_time_delta($delta);
}
static function date($time = null, $now = false, $left = false) {
if (is_null($time)) {
$time = time();
}
if ($time == false) {
$buffer = 'none';
} else {
$buffer = gmdate(get_option('date_format') . ' ' . get_option('time_format'), $time + get_option('gmt_offset') * 3600);
}
if ($now) {
$buffer .= ' (now: ' . gmdate(get_option('date_format') . ' ' .
get_option('time_format'), time() + get_option('gmt_offset') * 3600);
$buffer .= ')';
}
if ($left) {
$buffer .= ', ' . gmdate('H:i:s', $time - time()) . ' left';
}
return $buffer;
}
/**
* Return an array of array with on first element the array of recent post and on second element the array
* of old posts.
*
* @param array $posts
* @param int $time
*/
static function split_posts(&$posts, $time = 0) {
if ($time < 0) {
return array_chunk($posts, ceil(count($posts) / 2));
}
$result = array(array(), array());
if (empty($posts))
return $result;
foreach ($posts as &$post) {
if (self::is_post_old($post, $time))
$result[1][] = $post;
else
$result[0][] = $post;
}
return $result;
}
static function is_post_old(&$post, $time = 0) {
return self::m2t($post->post_date_gmt) <= $time;
}
static function get_post_image($post_id = null, $size = 'thumbnail', $alternative = null) {
global $post;
if (empty($post_id))
$post_id = $post->ID;
if (empty($post_id))
return $alternative;
$image_id = function_exists('get_post_thumbnail_id') ? get_post_thumbnail_id($post_id) : false;
if ($image_id) {
$image = wp_get_attachment_image_src($image_id, $size);
return $image[0];
} else {
$attachments = get_children(array('post_parent' => $post_id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => 'ASC', 'orderby' => 'menu_order ID'));
if (empty($attachments)) {
return $alternative;
}
foreach ($attachments as $id => $attachment) {
$image = wp_get_attachment_image_src($id, $size);
return $image[0];
}
}
}
/**
* Cleans up a text containing url tags with appended the absolute URL (due to
* the editor behavior) moving back them to the simple form.
*/
static function clean_url_tags($text) {
$text = str_replace('%7B', '{', $text);
$text = str_replace('%7D', '}', $text);
// Only tags which are {*_url}
$text = preg_replace("/[\"']http[^\"']+(\\{[^\\}]+_url\\})[\"']/i", "\"\\1\"", $text);
return $text;
}
function admin_menu() {
}
function add_menu_page($page, $title, $capability = '') {
if (!Newsletter::instance()->is_allowed())
return;
$name = 'newsletter_' . $this->module . '_' . $page;
add_submenu_page('newsletter_main_index', $title, $title, 'exist', $name, array($this, 'menu_page'));
}
function add_admin_page($page, $title) {
if (!Newsletter::instance()->is_allowed()) {
return;
}
$name = 'newsletter_' . $this->module . '_' . $page;
add_submenu_page(null, $title, $title, 'exist', $name, array($this, 'menu_page'));
}
function sanitize_file_name($name) {
return preg_replace('/[^a-z_\\-]/i', '', $name);
}
function menu_page() {
global $plugin_page, $newsletter, $wpdb;
$parts = explode('_', $plugin_page, 3);
$module = $this->sanitize_file_name($parts[1]);
$page = $this->sanitize_file_name($parts[2]);
$page = str_replace('_', '-', $page);
$file = NEWSLETTER_DIR . '/' . $module . '/' . $page . '.php';
require $file;
}
function get_admin_page_url($page) {
return admin_url('admin.php') . '?page=newsletter_' . $this->module . '_' . $page;
}
/** Returns all the emails of the give type (message, feed, followup, ...) and in the given format
* (default as objects). Return false on error or at least an empty array. Errors should never
* occur.
*
* @global wpdb $wpdb
* @param string $type
* @return boolean|array
*/
function get_emails($type = null, $format = OBJECT) {
global $wpdb;
if ($type == null) {
$list = $wpdb->get_results("select * from " . NEWSLETTER_EMAILS_TABLE . " order by id desc", $format);
} else {
$type = (string) $type;
$list = $wpdb->get_results($wpdb->prepare("select * from " . NEWSLETTER_EMAILS_TABLE . " where type=%s order by id desc", $type), $format);
}
if ($wpdb->last_error) {
$this->logger->error($wpdb->last_error);
return false;
}
if (empty($list)) {
return [];
}
return $list;
}
function get_emails_by_status($status) {
global $wpdb;
$list = $wpdb->get_results($wpdb->prepare("select * from " . NEWSLETTER_EMAILS_TABLE . " where status=%s order by id desc", $status));
array_walk($list, function ($email) {
$email->options = maybe_unserialize($email->options);
if (!is_array($email->options)) {
$email->options = [];
}
});
return $list;
}
/**
* @param string $key
* @param mixed $value
* @return TNP_Email[]
*/
// function get_emails_by_field($key, $value) {
// global $wpdb;
//
// $value_placeholder = is_int($value) ? '%d' : '%s';
//
// $key = '`' . str_replace('`', '', $key) . '`';
//
// $query = $wpdb->prepare("SELECT * FROM " . NEWSLETTER_EMAILS_TABLE . " WHERE $key=$value_placeholder ORDER BY id DESC", $value);
// //die($query);
//
// $email_list = $wpdb->get_results($query);
//
// if ($wpdb->last_error) {
// $this->logger->error($wpdb->last_error);
//
// return [];
// }
//
// //Unserialize options
// array_walk($email_list, function ($email) {
// $email->options = maybe_unserialize($email->options);
// if (!is_array($email->options)) {
// $email->options = [];
// }
// });
//
// return $email_list;
// }
/**
* Retrieves an email from DB and unserialize the options.
*
* @param mixed $id
* @param string $format
* @return TNP_Email An object with the same fields of TNP_Email, but not actually of that type
*/
function get_email($id, $format = OBJECT) {
$email = $this->store->get_single(NEWSLETTER_EMAILS_TABLE, $id, $format);
if (!$email) {
return null;
}
if ($format == OBJECT) {
$email->options = maybe_unserialize($email->options);
if (!is_array($email->options)) {
$email->options = array();
}
if (empty($email->query)) {
$email->query = "select * from " . NEWSLETTER_USERS_TABLE . " where status='C'";
}
} else if ($format == ARRAY_A) {
$email['options'] = maybe_unserialize($email['options']);
if (!is_array($email['options'])) {
$email['options'] = array();
}
if (empty($email['query'])) {
$email['query'] = "select * from " . NEWSLETTER_USERS_TABLE . " where status='C'";
}
}
return $email;
}
/**
* Save an email and provide serialization, if needed, of $email['options'].
* @return TNP_Email
*/
function save_email($email, $return_format = OBJECT) {
if (is_object($email)) {
$email = (array) $email;
}
if (isset($email['subject'])) {
if (mb_strlen($email['subject'], 'UTF-8') > 250) {
$email['subject'] = mb_substr($email['subject'], 0, 250, 'UTF-8');
}
}
if (isset($email['options']) && is_array($email['options'])) {
$email['options'] = serialize($email['options']);
}
$email = $this->store->save(NEWSLETTER_EMAILS_TABLE, $email, $return_format);
if ($return_format == OBJECT) {
$email->options = maybe_unserialize($email->options);
if (!is_array($email->options)) {
$email->options = [];
}
} else if ($return_format == ARRAY_A) {
$email['options'] = maybe_unserialize($email['options']);
if (!is_array($email['options'])) {
$email['options'] = [];
}
}
return $email;
}
function get_email_from_request() {
if (isset($_REQUEST['nek'])) {
list($id, $token) = @explode('-', $_REQUEST['nek'], 2);
} else if (isset($_COOKIE['tnpe'])) {
list($id, $token) = @explode('-', $_COOKIE['tnpe'], 2);
} else {
return null;
}
$email = $this->get_email($id);
// TODO: Check the token? It's really useful?
return $email;
}
/**
* Delete one or more emails identified by ID (single value or array of ID)
*
* @global wpdb $wpdb
* @param int|array $id Single numeric ID or an array of IDs to be deleted
* @return boolean
*/
function delete_email($id) {
global $wpdb;
$r = $this->store->delete(NEWSLETTER_EMAILS_TABLE, $id);
if ($r !== false) {
// $id could be an array if IDs
$id = (array) $id;
foreach ($id as $email_id) {
$wpdb->delete(NEWSLETTER_STATS_TABLE, ['email_id' => $email_id]);
$wpdb->delete(NEWSLETTER_SENT_TABLE, ['email_id' => $email_id]);
}
}
return $r;
}
function get_email_field($id, $field_name) {
return $this->store->get_field(NEWSLETTER_EMAILS_TABLE, $id, $field_name);
}
function get_email_status_slug($email) {
$email = (object) $email;
if ($email->status == 'sending' && $email->send_on > time()) {
return 'scheduled';
}
return $email->status;
}
function get_email_status_label($email) {
$email = (object) $email;
$status = $this->get_email_status_slug($email);
switch ($status) {
case 'sending':
return __('Sending', 'newsletter');
case 'scheduled':
return __('Scheduled', 'newsletter');
case 'sent':
return __('Sent', 'newsletter');
case 'paused':
return __('Paused', 'newsletter');
case 'new':
return __('Draft', 'newsletter');
default:
return ucfirst($email->status);
}
}
function show_email_status_label($email) {
echo '<span class="tnp-email-status tnp-email-status--', $this->get_email_status_slug($email), '">', esc_html($this->get_email_status_label($email)), '</span>';
}
function get_email_progress($email, $format = 'percent') {
return $email->total > 0 ? intval($email->sent / $email->total * 100) : 0;
}
function show_email_progress_bar($email, $attrs = []) {
$email = (object) $email;
$attrs = array_merge(array('format' => 'percent', 'numbers' => false, 'scheduled' => false), $attrs);
if ($email->status == 'sending' && $email->send_on > time()) {
if ($attrs['scheduled']) {
echo '<span class="tnp-progress-date">', $this->format_date($email->send_on), '</span>';
}
return;
} else if ($email->status == 'new') {
echo '';
return;
} else if ($email->status == 'sent') {
$percent = 100;
} else {
$percent = $this->get_email_progress($email);
}
echo '<div class="tnp-progress tnp-progress--' . $email->status . '">';
echo '<div class="tnp-progress-bar" role="progressbar" style="width: ', $percent, '%;"> ', $percent, '% </div>';
echo '</div>';
if ($attrs['numbers']) {
if ($email->status == 'sent') {
echo '<div class="tnp-progress-numbers">', $email->total, ' ', __('of', 'newsletter'), ' ', $email->total, '</div>';
} else {
echo '<div class="tnp-progress-numbers">', $email->sent, ' ', __('of', 'newsletter'), ' ', $email->total, '</div>';
}
}
}
function get_email_type_label($type) {
// Is an email?
if (is_object($type))
$type = $type->type;
$label = apply_filters('newsletter_email_type', '', $type);
if (!empty($label))
return $label;
switch ($type) {
case 'followup':
return 'Followup';
case 'message':
return 'Standard Newsletter';
case 'feed':
return 'Feed by Mail';
}
if (strpos($type, 'automated') === 0) {
list($a, $id) = explode('_', $type);
return 'Automated Channel ' . $id;
}
return ucfirst($type);
}
function get_email_progress_label($email) {
if ($email->status == 'sent' || $email->status == 'sending') {
return $email->sent . ' ' . __('of', 'newsletter') . ' ' . $email->total;
}
return '-';
}
/**
* Returns the email unique key
* @param TNP_User $user
* @return string
*/
function get_email_key($email) {
if (!isset($email->token)) {
return $email->id . '-';
}
return $email->id . '-' . $email->token;
}
/** Searches for a user using the nk parameter or the ni and nt parameters. Tries even with the newsletter cookie.
* If found, the user object is returned or null.
* The user is returned without regards to his status that should be checked by caller.
*
* DO NOT REMOVE EVEN IF OLD
*
* @return TNP_User
*/
function check_user($context = '') {
global $wpdb;
$user = null;
if (isset($_REQUEST['nk'])) {
list($id, $token) = @explode('-', $_REQUEST['nk'], 2);
} else if (isset($_COOKIE['newsletter'])) {
list ($id, $token) = @explode('-', $_COOKIE['newsletter'], 2);
}
if (isset($id)) {
$user = $this->get_user($id);
if ($user) {
if ($context == 'preconfirm') {
if ($token != md5($user->token)) {
$user = null;
}
} else {
if ($token != $user->token) {
$user = null;
}
}
}
}
if ($user == null && is_user_logged_in()) {
$user = $this->get_user_by_wp_user_id(get_current_user_id());
}
return $user;
}
/** Returns the user identify by an id or an email. If $id_or_email is an object or an array, it is assumed it contains
* the "id" attribute or key and that is used to load the user.
*
* @global type $wpdb
* @param string|int|object|array $id_or_email
* @param string $format
* @return TNP_User|null
*/
function get_user($id_or_email, $format = OBJECT) {
global $wpdb;
if (empty($id_or_email))
return null;
// To simplify the reaload of a user passing the user it self.
if (is_object($id_or_email)) {
$id_or_email = $id_or_email->id;
} else if (is_array($id_or_email)) {
$id_or_email = $id_or_email['id'];
}
$id_or_email = strtolower(trim($id_or_email));
if (is_numeric($id_or_email)) {
$r = $wpdb->get_row($wpdb->prepare("select * from " . NEWSLETTER_USERS_TABLE . " where id=%d limit 1", $id_or_email), $format);
} else {
$r = $wpdb->get_row($wpdb->prepare("select * from " . NEWSLETTER_USERS_TABLE . " where email=%s limit 1", $id_or_email), $format);
}
if ($wpdb->last_error) {
$this->logger->error($wpdb->last_error);
return null;
}
return $r;
}
/**
*
* @global wpdb $wpdb
* @param string $email
* @return TNP_User
*/
function get_user_by_email($email) {
global $wpdb;
$r = $wpdb->get_row($wpdb->prepare("select * from " . NEWSLETTER_USERS_TABLE . " where email=%s limit 1", $email));
if ($wpdb->last_error) {
$this->logger->error($wpdb->last_error);
return null;
}
return $r;
}
/**
* Accepts a user ID or a TNP_User object. Does not check if the user really exists.
*
* @param type $user
*/
function get_user_edit_url($user) {
$id = $this->to_int_id($user);
return admin_url('admin.php') . '?page=newsletter_users_edit&id=' . $id;
}
/**
* Returns the user unique key
* @param TNP_User $user
* @return string
*/
function get_user_key($user, $context = '') {
if (empty($user->token)) {
$this->refresh_user_token($user);
}
if ($context == 'preconfirm') {
return $user->id . '-' . md5($user->token);
}
return $user->id . '-' . $user->token;
}
function get_user_status_label($user, $html = false) {
if (!$html)
return TNP_User::get_status_label($user->status);
$label = TNP_User::get_status_label($user->status);
$class = 'unknown';
switch ($user->status) {
case TNP_User::STATUS_NOT_CONFIRMED: $class = 'not-confirmed';
break;
case TNP_User::STATUS_CONFIRMED: $class = 'confirmed';
break;
case TNP_User::STATUS_UNSUBSCRIBED: $class = 'unsubscribed';
break;
case TNP_User::STATUS_BOUNCED: $class = 'bounced';
break;
case TNP_User::STATUS_COMPLAINED: $class = 'complained';
break;
}
return '<span class="' . $class . '">' . esc_html($label) . '</span>';
}
/**
* Return the user identified by the "nk" parameter (POST or GET).
* If no user can be found or the token is not matching, returns null.
* If die_on_fail is true it dies instead of return null.
*
* @param bool $die_on_fail
* @return TNP_User
*/
function get_user_from_request($die_on_fail = false, $context = '') {
$id = 0;
if (isset($_REQUEST['nk'])) {
list($id, $token) = @explode('-', $_REQUEST['nk'], 2);
}
$user = $this->get_user($id);
if ($user == null) {
if ($die_on_fail) {
die(__('No subscriber found.', 'newsletter'));
} else {
return $this->get_user_from_logged_in_user();
}
}
if ($context == 'preconfirm') {
$user_token = md5($user->token);
} else {
$user_token = $user->token;
}
if ($token != $user_token) {
if ($die_on_fail) {
die(__('No subscriber found.', 'newsletter'));
} else {
return $this->get_user_from_logged_in_user();
}
}
return $user;
}
function get_user_from_logged_in_user() {
if (is_user_logged_in()) {
return $this->get_user_by_wp_user_id(get_current_user_id());
}
return null;
}
function get_user_count($refresh = false) {
global $wpdb;
$user_count = get_transient('newsletter_user_count');
if ($user_count === false || $refresh) {
$user_count = $wpdb->get_var("select count(*) from " . NEWSLETTER_USERS_TABLE . " where status='C'");
set_transient('newsletter_user_count', $user_count, DAY_IN_SECONDS);
}
return $user_count;
}
function get_profile($id, $language = '') {
return TNP_Profile_Service::get_profile_by_id($id, $language);
}
/**
* @param string $language The language for the list labels (it does not affect the lists returned)
* @return TNP_Profile[]
*/
function get_profiles($language = '') {
return TNP_Profile_Service::get_profiles($language);
}
/**
* Returns a list of TNP_Profile which are public.
*
* @staticvar array $profiles
* @param string $language
* @return TNP_Profile[]
*/
function get_profiles_public($language = '') {
static $profiles = [];
if (isset($profiles[$language])) {
return $profiles[$language];
}
$profiles[$language] = [];
$all = $this->get_profiles($language);
foreach ($all as $profile) {
if ($profile->is_private())
continue;
$profiles[$language]['' . $profile->id] = $profile;
}
return $profiles[$language];
}
/**
* Really bad name!
* @staticvar array $profiles
* @param type $language
* @return array
*/
function get_profiles_for_profile($language = '') {
static $profiles = [];
if (isset($profiles[$language])) {
return $profiles[$language];
}
$profiles[$language] = [];
$all = $this->get_profiles($language);
foreach ($all as $profile) {
if (!$profile->show_on_profile())
continue;
$profiles[$language]['' . $profile->id] = $profile;
}
return $profiles[$language];
}
/**
* @param string $language The language for the list labels (it does not affect the lists returned)
* @return TNP_List[]
*/
function get_lists($language = '') {
static $lists = array();
if (isset($lists[$language])) {
return $lists[$language];
}
$lists[$language] = array();
$data = NewsletterSubscription::instance()->get_options('lists', $language);
for ($i = 1; $i <= NEWSLETTER_LIST_MAX; $i++) {
if (empty($data['list_' . $i])) {
continue;
}
$list = $this->create_tnp_list_from_db_lists_array($data, $i);
$lists[$language]['' . $list->id] = $list;
}
return $lists[$language];
}
public function create_tnp_list_from_db_lists_array($db_lists_array, $list_id) {
$list = new TNP_List();
$list->name = $db_lists_array['list_' . $list_id];
$list->id = $list_id;
// New format
if (isset($db_lists_array['list_' . $list_id . '_subscription'])) {
$list->forced = !empty($db_lists_array['list_' . $list_id . '_forced']);
$list->status = empty($db_lists_array['list_' . $list_id . '_status']) ? TNP_List::STATUS_PRIVATE : TNP_List::STATUS_PUBLIC;
$list->checked = $db_lists_array['list_' . $list_id . '_subscription'] == 2;
$list->show_on_subscription = $list->status != TNP_List::STATUS_PRIVATE && !empty($db_lists_array['list_' . $list_id . '_subscription']) && !$list->forced;
$list->show_on_profile = $list->status != TNP_List::STATUS_PRIVATE && !empty($db_lists_array['list_' . $list_id . '_profile']);
} else {
$list->forced = !empty($db_lists_array['list_' . $list_id . '_forced']);
$list->status = empty($db_lists_array['list_' . $list_id . '_status']) ? TNP_List::STATUS_PRIVATE : TNP_List::STATUS_PUBLIC;
$list->checked = !empty($db_lists_array['list_' . $list_id . '_checked']);
$list->show_on_subscription = $db_lists_array['list_' . $list_id . '_status'] == 2 && !$list->forced;
$list->show_on_profile = $db_lists_array['list_' . $list_id . '_status'] == 1 || $db_lists_array['list_' . $list_id . '_status'] == 2;
}
if (empty($db_lists_array['list_' . $list_id . '_languages'])) {
$list->languages = array();
} else {
$list->languages = $db_lists_array['list_' . $list_id . '_languages'];
}
return $list;
}
/**
* Returns an array of TNP_List objects of lists that are public.
* @return TNP_List[]
*/
function get_lists_public($language = '') {
static $lists = array();
if (isset($lists[$language])) {
return $lists[$language];
}
$lists[$language] = array();
$all = $this->get_lists($language);
foreach ($all as $list) {
if ($list->status == TNP_List::STATUS_PRIVATE) {
continue;
}
$lists[$language]['' . $list->id] = $list;
}
return $lists[$language];
}
/**
* Lists to be shown on subscription form.
*
* @return TNP_List[]
*/
function get_lists_for_subscription($language = '') {
static $lists = array();
if (isset($lists[$language])) {
return $lists[$language];
}
$lists[$language] = array();
$all = $this->get_lists($language);
foreach ($all as $list) {
if (!$list->show_on_subscription) {
continue;
}
$lists[$language]['' . $list->id] = $list;
}
return $lists[$language];
}
/**
* Returns the lists to be shown in the profile page. The list is associative with
* the list ID as key.
*
* @return TNP_List[]
*/
function get_lists_for_profile($language = '') {
static $lists = array();
if (isset($lists[$language])) {
return $lists[$language];
}
$lists[$language] = array();
$all = $this->get_lists($language);
foreach ($all as $list) {
if (!$list->show_on_profile) {
continue;
}
$lists[$language]['' . $list->id] = $list;
}
return $lists[$language];
}
/**
* Returns the list object or null if not found.
*
* @param int $id
* @return TNP_List
*/
function get_list($id, $language = '') {
$lists = $this->get_lists($language);
if (!isset($lists['' . $id])) {
return null;
}
return $lists['' . $id];
}
/**
* NEVER CHANGE THIS METHOD SIGNATURE, USER BY THIRD PARTY PLUGINS.
*
* Saves a new user on the database. Return false if the email (that must be unique) is already
* there. For a new users set the token and creation time if not passed.
*
* @param array $user
* @return TNP_User|array|boolean Returns the subscriber reloaded from DB in the specified format. Flase on failure (duplicate email).
*/
function save_user($user, $return_format = OBJECT) {
if (is_object($user)) {
$user = (array) $user;
}
if (empty($user['id'])) {
$existing = $this->get_user($user['email']);
if ($existing != null) {
return false;
}
if (empty($user['token'])) {
$user['token'] = NewsletterModule::get_token();
}
}
// We still don't know when it happens but under some conditions, matbe external, lists are passed as NULL
foreach ($user as $key => $value) {
if (strpos($key, 'list_') !== 0) {
continue;
}
if (is_null($value)) {
unset($user[$key]);
} else {
$user[$key] = (int) $value;
}
}
// Due to the unique index on email field, this can fail.
return $this->store->save(NEWSLETTER_USERS_TABLE, $user, $return_format);
}
/**
* Updates the user last activity timestamp.
*
* @global wpdb $wpdb
* @param TNP_User $user
*/
function update_user_last_activity($user) {
global $wpdb;
$this->query($wpdb->prepare("update " . NEWSLETTER_USERS_TABLE . " set last_activity=%d where id=%d limit 1", time(), $user->id));
}
function update_user_ip($user, $ip) {
global $wpdb;
// Only if changed
$r = $this->query($wpdb->prepare("update " . NEWSLETTER_USERS_TABLE . " set ip=%s, geo=0 where ip<>%s and id=%d limit 1", $ip, $ip, $user->id));
}
/**
* Finds single style blocks and adds a style attribute to every HTML tag with a class exactly matching the rules in the style
* block. HTML tags can use the attribute "inline-class" to exact match a style rules if they need a composite class definition.
*
* @param string $content
* @param boolean $strip_style_blocks
* @return string
*/
function inline_css($content, $strip_style_blocks = false) {
$matches = array();
// "s" skips line breaks
$styles = preg_match('|<style>(.*?)</style>|s', $content, $matches);
if (isset($matches[1])) {
$style = str_replace(array("\n", "\r"), '', $matches[1]);
$rules = array();
preg_match_all('|\s*\.(.*?)\{(.*?)\}\s*|s', $style, $rules);
for ($i = 0; $i < count($rules[1]); $i++) {
$class = trim($rules[1][$i]);
$value = trim($rules[2][$i]);
$value = preg_replace('|\s+|', ' ', $value);
$content = str_replace(' class="' . $class . '"', ' class="' . $class . '" style="' . $value . '"', $content);
$content = str_replace(' inline-class="' . $class . '"', ' style="' . $value . '"', $content);
}
}
if ($strip_style_blocks) {
return trim(preg_replace('|<style>.*?</style>|s', '', $content));
} else {
return $content;
}
}
/**
* Returns a list of users marked as "test user".
* @return TNP_User[]
*/
function get_test_users() {
return $this->store->get_all(NEWSLETTER_USERS_TABLE, "where test=1 and status in ('C', 'S')");
}
/**
* Deletes a subscriber and cleans up all the stats table with his correlated data.
*
* @global wpdb $wpdb
* @param int|id[] $id
*/
function delete_user($id) {
global $wpdb;
$id = (array) $id;
foreach ($id as $user_id) {
$user = $this->get_user($user_id);
if ($user) {
$r = $this->store->delete(NEWSLETTER_USERS_TABLE, $user_id);
$wpdb->delete(NEWSLETTER_STATS_TABLE, array('user_id' => $user_id));
$wpdb->delete(NEWSLETTER_SENT_TABLE, array('user_id' => $user_id));
do_action('newsletter_user_deleted', $user);
}
}
return count($id);
}
/**
* Add to a destination URL the parameters to identify the user, the email and to show
* an alert message, if required. The parameters are then managed by the [newsletter] shortcode.
*
* @param string $url If empty the standard newsletter page URL is used (usually it is empty, but sometime a custom URL has been specified)
* @param string $message_key The message identifier
* @param TNP_User|int $user
* @param TNP_Email|int $email
* @param string $alert An optional alter message to be shown. Does not work with custom URLs
* @return string The final URL with parameters
*/
function build_message_url($url = '', $message_key = '', $user = null, $email = null, $alert = '') {
$params = 'nm=' . urlencode($message_key);
$language = '';
if ($user) {
if (!is_object($user)) {
$user = $this->get_user($user);
}
if ($message_key == 'confirmation') {
$params .= '&nk=' . urlencode($this->get_user_key($user, 'preconfirm'));
} else {
$params .= '&nk=' . urlencode($this->get_user_key($user));
}
$language = $this->get_user_language($user);
}
if ($email) {
if (!is_object($email)) {
$email = $this->get_email($email);
}
$params .= '&nek=' . urlencode($this->get_email_key($email));
}
if ($alert) {
$params .= '&alert=' . urlencode($alert);
}
if (empty($url)) {
$url = Newsletter::instance()->get_newsletter_page_url($language);
}
return self::add_qs($url, $params, false);
}
/**
* Builds a standard Newsletter action URL for the specified action.
*
* @param string $action
* @param TNP_User $user
* @param TNP_Email $email
* @return string
*/
function build_action_url($action, $user = null, $email = null) {
$url = $this->add_qs($this->get_home_url(), 'na=' . urlencode($action));
//$url = $this->add_qs(admin_url('admin-ajax.php'), 'action=newsletter&na=' . urlencode($action));
if ($user) {
$url .= '&nk=' . urlencode($this->get_user_key($user));
}
if ($email) {
$url .= '&nek=' . urlencode($this->get_email_key($email));
}
return $url;
}
function get_subscribe_url() {
return $this->build_action_url('s');
}
function clean_stats_table() {
global $wpdb;
$this->logger->info('Cleaning up stats table');
$this->query("delete s from `{$wpdb->prefix}newsletter_stats` s left join `{$wpdb->prefix}newsletter` u on s.user_id=u.id where u.id is null");
$this->query("delete s from `{$wpdb->prefix}newsletter_stats` s left join `{$wpdb->prefix}newsletter_emails` e on s.email_id=e.id where e.id is null");
}
function clean_sent_table() {
global $wpdb;
$this->logger->info('Cleaning up sent table');
$this->query("delete s from `{$wpdb->prefix}newsletter_sent` s left join `{$wpdb->prefix}newsletter` u on s.user_id=u.id where u.id is null");
$this->query("delete s from `{$wpdb->prefix}newsletter_sent` s left join `{$wpdb->prefix}newsletter_emails` e on s.email_id=e.id where e.id is null");
}
function clean_user_logs_table() {
//global $wpdb;
}
function clean_tables() {
$this->clean_sent_table();
$this->clean_stats_table();
$this->clean_user_logs_table();
}
function anonymize_ip($ip) {
if (empty($ip)) {
return $ip;
}
$parts = explode('.', $ip);
array_pop($parts);
return implode('.', $parts) . '.0';
}
function process_ip($ip) {
$option = Newsletter::instance()->options['ip'];
if (empty($option)) {
return $ip;
}
if ($option == 'anonymize') {
return $this->anonymize_ip($ip);
}
return '';
}
function anonymize_user($id) {
global $wpdb;
$user = $this->get_user($id);
if (!$user) {
return null;
}
$user->name = '';
$user->surname = '';
$user->ip = $this->anonymize_ip($user->ip);
for ($i = 1; $i <= NEWSLETTER_PROFILE_MAX; $i++) {
$field = 'profile_' . $i;
$user->$field = '';
}
// [TODO] Status?
$user->status = TNP_User::STATUS_UNSUBSCRIBED;
$user->email = $user->id . '@anonymi.zed';
$user = $this->save_user($user);
return $user;
}
/**
* Changes a user status. Accept a user object, user id or user email.
*
* @param TNP_User $user
* @param string $status
* @return TNP_User
*/
function set_user_status($user, $status) {
global $wpdb;
$this->logger->debug('Status change to ' . $status . ' of subscriber ' . $user->id . ' from ' . $_SERVER['REQUEST_URI']);
$this->query($wpdb->prepare("update " . NEWSLETTER_USERS_TABLE . " set status=%s where id=%d limit 1", $status, $user->id));
$user->status = $status;
return $this->get_user($user);
}
/**
*
* @global wpdb $wpdb
* @param TNP_User $user
* @return TNP_User
*/
function refresh_user_token($user) {
global $wpdb;
$token = $this->get_token();
$this->query($wpdb->prepare("update " . NEWSLETTER_USERS_TABLE . " set token=%s where id=%d limit 1", $token, $user->id));
$user->token = $token;
}
/**
* Create a log entry with the meaningful user data.
*
* @global wpdb $wpdb
* @param TNP_User $user
* @param string $source
* @return type
*/
function add_user_log($user, $source = '') {
global $wpdb;
$lists = $this->get_lists_public();
foreach ($lists as $list) {
$field_name = 'list_' . $list->id;
$data[$field_name] = $user->$field_name;
}
$data['status'] = $user->status;
$ip = $this->get_remote_ip();
$ip = $this->process_ip($ip);
$this->store->save($wpdb->prefix . 'newsletter_user_logs', array('ip' => $ip, 'user_id' => $user->id, 'source' => $source, 'created' => time(), 'data' => json_encode($data)));
}
/**
*
* @global wpdb $wpdb
* @param TNP_User $user
* @param int $list
* @param type $value
*/
function set_user_list($user, $list, $value) {
global $wpdb;
$list = (int) $list;
$value = $value ? 1 : 0;
$r = $wpdb->update(NEWSLETTER_USERS_TABLE, array('list_' . $list => $value), array('id' => $user->id));
}
function set_user_field($id, $field, $value) {
$this->store->set_field(NEWSLETTER_USERS_TABLE, $id, $field, $value);
}
function set_user_wp_user_id($user_id, $wp_user_id) {
$this->store->set_field(NEWSLETTER_USERS_TABLE, $user_id, 'wp_user_id', $wp_user_id);
}
/**
*
* @param int $wp_user_id
* @param string $format
* @return TNP_User
*/
function get_user_by_wp_user_id($wp_user_id, $format = OBJECT) {
return $this->store->get_single_by_field(NEWSLETTER_USERS_TABLE, 'wp_user_id', $wp_user_id, $format);
}
/**
* Returns the user language IF there is a supported mutilanguage plugin installed.
* @param TNP_User $user
* @return string Language code or empty
*/
function get_user_language($user) {
if ($user && $this->is_multilanguage()) {
return $user->language;
}
return '';
}
/**
* Replaces every possible Newsletter tag ({...}) in a piece of text or HTML.
*
* @global wpdb $wpdb
* @param string $text
* @param mixed $user Can be an object, associative array or id
* @param mixed $email Can be an object, associative array or id
* @param type $referrer
* @return type
*/
function replace($text, $user = null, $email = null, $referrer = null) {
global $wpdb;
if (strpos($text, '<p') !== false) {
$esc_html = true;
} else {
$esc_html = false;
}
static $home_url = false;
if (!$home_url) {
$home_url = home_url('/');
}
//$this->logger->debug('Replace start');
if ($user !== null && !is_object($user)) {
if (is_array($user)) {
$user = (object) $user;
} else if (is_numeric($user)) {
$user = $this->get_user($user);
} else {
$user = null;
}
}
if ($email !== null && !is_object($email)) {
if (is_array($email)) {
$email = (object) $email;
} else if (is_numeric($email)) {
$email = $this->get_email($email);
} else {
$email = null;
}
}
$initial_language = $this->get_current_language();
if ($user && $user->language) {
$this->switch_language($user->language);
}
$text = apply_filters('newsletter_replace', $text, $user, $email, $esc_html);
$text = $this->replace_url($text, 'blog_url', $home_url);
$text = $this->replace_url($text, 'home_url', $home_url);
$text = str_replace('{blog_title}', html_entity_decode(get_bloginfo('name')), $text);
$text = str_replace('{blog_description}', get_option('blogdescription'), $text);
$text = $this->replace_date($text);
if ($user) {
//$this->logger->debug('Replace with user ' . $user->id);
$nk = $this->get_user_key($user);
$options_profile = NewsletterSubscription::instance()->get_options('profile', $this->get_user_language($user));
$text = str_replace('{email}', $user->email, $text);
$name = apply_filters('newsletter_replace_name', $user->name, $user);
if (empty($name)) {
$text = str_replace(' {name}', '', $text);
$text = str_replace('{name}', '', $text);
} else {
$text = str_replace('{name}', esc_html($name), $text);
}
switch ($user->sex) {
case 'm': $text = str_replace('{title}', $options_profile['title_male'], $text);
break;
case 'f': $text = str_replace('{title}', $options_profile['title_female'], $text);
break;
//case 'n': $text = str_replace('{title}', $options_profile['title_none'], $text);
// break;
default:
$text = str_replace('{title}', $options_profile['title_none'], $text);
//$text = str_replace('{title}', '', $text);
}
// Deprecated
$text = str_replace('{surname}', esc_html($user->surname), $text);
$text = str_replace('{last_name}', esc_html($user->surname), $text);
$full_name = esc_html(trim($user->name . ' ' . $user->surname));
if (empty($full_name)) {
$text = str_replace(' {full_name}', '', $text);
$text = str_replace('{full_name}', '', $text);
} else {
$text = str_replace('{full_name}', $full_name, $text);
}
$text = str_replace('{token}', $user->token, $text);
$text = str_replace('%7Btoken%7D', $user->token, $text);
$text = str_replace('{id}', $user->id, $text);
$text = str_replace('%7Bid%7D', $user->id, $text);
$text = str_replace('{ip}', $user->ip, $text);
$text = str_replace('{key}', $nk, $text);
$text = str_replace('%7Bkey%7D', $nk, $text);
for ($i = 1; $i <= NEWSLETTER_PROFILE_MAX; $i++) {
$p = 'profile_' . $i;
$text = str_replace('{profile_' . $i . '}', $user->$p, $text);
}
$base = (empty($this->options_main['url']) ? get_option('home') : $this->options_main['url']);
$id_token = '&ni=' . $user->id . '&nt=' . $user->token;
$text = $this->replace_url($text, 'subscription_confirm_url', $this->build_action_url('c', $user));
$text = $this->replace_url($text, 'activation_url', $this->build_action_url('c', $user));
// Obsolete.
$text = $this->replace_url($text, 'FOLLOWUP_SUBSCRIPTION_URL', self::add_qs($base, 'nm=fs' . $id_token));
$text = $this->replace_url($text, 'FOLLOWUP_UNSUBSCRIPTION_URL', self::add_qs($base, 'nm=fu' . $id_token));
$text = $this->replace_url($text, 'UNLOCK_URL', $this->build_action_url('ul', $user));
} else {
//$this->logger->debug('Replace without user');
$text = $this->replace_url($text, 'subscription_confirm_url', '#');
$text = $this->replace_url($text, 'activation_url', '#');
}
if ($email) {
//$this->logger->debug('Replace with email ' . $email->id);
$nek = $this->get_email_key($email);
$text = str_replace('{email_id}', $email->id, $text);
$text = str_replace('{email_key}', $nek, $text);
$text = str_replace('{email_subject}', $email->subject, $text);
// Deprecated
$text = str_replace('{subject}', $email->subject, $text);
$text = $this->replace_url($text, 'email_url', $this->build_action_url('v', $user) . '&id=' . $email->id);
} else {
//$this->logger->debug('Replace without email');
$text = $this->replace_url($text, 'email_url', '#');
}
if (strpos($text, '{subscription_form}') !== false) {
$text = str_replace('{subscription_form}', NewsletterSubscription::instance()->get_subscription_form($referrer), $text);
} else {
for ($i = 1; $i <= 10; $i++) {
if (strpos($text, "{subscription_form_$i}") !== false) {
$text = str_replace("{subscription_form_$i}", NewsletterSubscription::instance()->get_form($i), $text);
break;
}
}
}
// Company info
// TODO: Move to another module
$options = Newsletter::instance()->get_options('info');
$text = str_replace('{company_address}', $options['footer_contact'], $text);
$text = str_replace('{company_name}', $options['footer_title'], $text);
$text = str_replace('{company_legal}', $options['footer_legal'], $text);
$this->switch_language($initial_language);
//$this->logger->debug('Replace end');
return $text;
}
function replace_date($text) {
$text = str_replace('{date}', date_i18n(get_option('date_format')), $text);
// Date processing
$x = 0;
while (($x = strpos($text, '{date_', $x)) !== false) {
$y = strpos($text, '}', $x);
if ($y === false)
continue;
$f = substr($text, $x + 6, $y - $x - 6);
$text = substr($text, 0, $x) . date_i18n($f) . substr($text, $y + 1);
}
return $text;
}
function replace_url($text, $tag, $url) {
static $home = false;
if (!$home) {
$home = trailingslashit(home_url());
}
$tag_lower = strtolower($tag);
$text = str_replace('http://{' . $tag_lower . '}', $url, $text);
$text = str_replace('https://{' . $tag_lower . '}', $url, $text);
$text = str_replace($home . '{' . $tag_lower . '}', $url, $text);
$text = str_replace($home . '%7B' . $tag_lower . '%7D', $url, $text);
$text = str_replace('{' . $tag_lower . '}', $url, $text);
$text = str_replace('%7B' . $tag_lower . '%7D', $url, $text);
$url_encoded = urlencode($url);
$text = str_replace('%7B' . $tag_lower . '_encoded%7D', $url_encoded, $text);
$text = str_replace('{' . $tag_lower . '_encoded}', $url_encoded, $text);
// for compatibility
$text = str_replace($home . $tag, $url, $text);
return $text;
}
public static function antibot_form_check($captcha = false) {
if (defined('NEWSLETTER_ANTIBOT') && !NEWSLETTER_ANTIBOT) {
return true;
}
if (strtolower($_SERVER['REQUEST_METHOD']) != 'post') {
return false;
}
if (!isset($_POST['ts']) || time() - $_POST['ts'] > 60) {
return false;
}
if ($captcha) {
$n1 = (int) $_POST['n1'];
if (empty($n1)) {
return false;
}
$n2 = (int) $_POST['n2'];
if (empty($n2)) {
return false;
}
$n3 = (int) $_POST['n3'];
if ($n1 + $n2 != $n3) {
return false;
}
}
return true;
}
public static function request_to_antibot_form($submit_label = 'Continue...', $captcha = false) {
header('Content-Type: text/html;charset=UTF-8');
header('X-Robots-Tag: noindex,nofollow,noarchive');
header('Cache-Control: no-cache,no-store,private');
echo "<!DOCTYPE html>\n";
echo '<html><head>'
. '<style type="text/css">'
. '.tnp-captcha {text-align: center; margin: 200px auto 0 auto !important; max-width: 300px !important; padding: 10px !important; font-family: "Open Sans", sans-serif; background: #ECF0F1; border-radius: 5px; padding: 50px !important; border: none !important;}'
. 'p {text-align: center; padding: 10px; color: #7F8C8D;}'
. 'input[type=text] {width: 50px; padding: 10px 10px; border: none; border-radius: 2px; margin: 0px 5px;}'
. 'input[type=submit] {text-align: center; border: none; padding: 10px 15px; font-family: "Open Sans", sans-serif; background-color: #27AE60; color: white; cursor: pointer;}'
. '</style>'
. '</head><body>';
echo '<form method="post" action="https://www.domain.tld" id="form">';
echo '<div style="width: 1px; height: 1px; overflow: hidden">';
foreach ($_REQUEST as $name => $value) {
if ($name == 'submit')
continue;
if (is_array($value)) {
foreach ($value as $element) {
echo '<input type="text" name="';
echo esc_attr($name);
echo '[]" value="';
echo esc_attr(stripslashes($element));
echo '">';
}
} else {
echo '<input type="hidden" name="', esc_attr($name), '" value="', esc_attr(stripslashes($value)), '">';
}
}
if (isset($_SERVER['HTTP_REFERER'])) {
echo '<input type="hidden" name="nhr" value="' . esc_attr($_SERVER['HTTP_REFERER']) . '">';
}
echo '<input type="hidden" name="ts" value="' . time() . '">';
echo '</div>';
if ($captcha) {
echo '<div class="tnp-captcha">';
echo '<p>', __('Math question', 'newsletter'), '</p>';
echo '<input type="text" name="n1" value="', rand(1, 9), '" readonly style="width: 50px">';
echo '+';
echo '<input type="text" name="n2" value="', rand(1, 9), '" readonly style="width: 50px">';
echo '=';
echo '<input type="text" name="n3" value="?" style="width: 50px">';
echo '<br><br>';
echo '<input type="submit" value="', esc_attr($submit_label), '">';
echo '</div>';
}
echo '<noscript><input type="submit" value="';
echo esc_attr($submit_label);
echo '"></noscript></form>';
echo '<script>';
echo 'document.getElementById("form").action="' . home_url('/') . '";';
if (!$captcha) {
echo 'document.getElementById("form").submit();';
}
echo '</script>';
echo '</body></html>';
die();
}
static function extract_body($html) {
$x = stripos($html, '<body');
if ($x !== false) {
$x = strpos($html, '>', $x);
$y = strpos($html, '</body>');
return substr($html, $x + 1, $y - $x - 1);
} else {
return $html;
}
}
/** Returns a percentage as string */
static function percent($value, $total) {
if ($total == 0)
return '-';
return sprintf("%.2f", $value / $total * 100) . '%';
}
/** Returns a percentage as integer value */
static function percentValue($value, $total) {
if ($total == 0)
return 0;
return round($value / $total * 100);
}
/**
* Takes in a variable and checks if object, array or scalar and return the integer representing
* a database record id.
*
* @param mixed $var
* @return in
*/
static function to_int_id($var) {
if (is_object($var)) {
return (int) $var->id;
}
if (is_array($var)) {
return (int) $var['id'];
}
return (int) $var;
}
static function to_array($text) {
$text = trim($text);
if (empty($text)) {
return array();
}
$text = preg_split("/\\r\\n/", $text);
$text = array_map('trim', $text);
$text = array_map('strtolower', $text);
$text = array_filter($text);
return $text;
}
static function sanitize_ip($ip) {
if (empty($ip)) {
return '';
}
$ip = preg_replace('/[^0-9a-fA-F:., ]/', '', trim($ip));
if (strlen($ip) > 50)
$ip = substr($ip, 0, 50);
// When more than one IP is present due to firewalls, proxies, and so on. The first one should be the origin.
if (strpos($ip, ',') !== false) {
list($ip, $tail) = explode(',', $ip, 2);
}
return $ip;
}
static function get_remote_ip() {
$ip = '';
if (!empty($_SERVER['HTTP_X_REAL_IP'])) {
$ip = $_SERVER['HTTP_X_REAL_IP'];
} elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
$ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
} elseif (isset($_SERVER['REMOTE_ADDR'])) {
$ip = $_SERVER['REMOTE_ADDR'];
}
return self::sanitize_ip($ip);
}
static function get_signature($text) {
$key = NewsletterStatistics::instance()->options['key'];
return md5($text . $key);
}
static function check_signature($text, $signature) {
if (empty($signature)) {
return false;
}
$key = NewsletterStatistics::instance()->options['key'];
return md5($text . $key) === $signature;
}
static function get_home_url() {
static $url = false;
if (!$url) {
$url = home_url('/');
}
return $url;
}
static function clean_eol($text) {
$text = str_replace("\r\n", "\n", $text);
$text = str_replace("\r", "\n", $text);
$text = str_replace("\n", "\r\n", $text);
return $text;
}
function set_current_language($language) {
self::$current_language = $language;
}
/**
* Return the current language code. Optionally, if a user is passed and it has a language
* the user language is returned.
* If there is no language available, an empty string is returned.
*
* @param TNP_User $user
* @return string The language code
*/
function get_current_language($user = null) {
if ($user && $user->language) {
return $user->language;
}
if (!empty(self::$current_language)) {
return self::$current_language;
}
// WPML
if (class_exists('SitePress')) {
$current_language = apply_filters('wpml_current_language', '');
if ($current_language == 'all') {
$current_language = '';
}
return $current_language;
}
// Polylang
if (function_exists('pll_current_language')) {
return pll_current_language();
}
// Trnslatepress and/or others
$current_language = apply_filters('newsletter_current_language', '');
return $current_language;
}
function get_default_language() {
if (class_exists('SitePress')) {
return $current_language = apply_filters('wpml_current_language', '');
} else if (function_exists('pll_default_language')) {
return pll_default_language();
} else if (class_exists('TRP_Translate_Press')) {
// TODO: Find the default language
}
return '';
}
function is_all_languages() {
return $this->get_current_language() == '';
}
function is_default_language() {
return $this->get_current_language() == $this->get_default_language();
}
/**
* Returns an array of languages with key the language code and value the language name.
* An empty array is returned if no language is available.
*/
function get_languages() {
$language_options = array();
if (class_exists('SitePress')) {
$languages = apply_filters('wpml_active_languages', null, ['skip_missing' => 0]);
foreach ($languages as $language) {
$language_options[$language['language_code']] = $language['translated_name'];
}
return $language_options;
} else if (function_exists('icl_get_languages')) {
$languages = icl_get_languages();
foreach ($languages as $code => $language) {
$language_options[$code] = $language['native_name'];
}
return $language_options;
}
return apply_filters('newsletter_languages', $language_options);
}
function get_language_label($language) {
$languages = $this->get_languages();
if (isset($languages[$language])) {
return $languages[$language];
}
return '';
}
/**
* Changes the current language usually before extracting the posts since WPML
* does not support the language filter in the post query (or at least we didn't
* find it).
*
* @param string $language
*/
function switch_language($language) {
if (class_exists('SitePress')) {
if (empty($language)) {
$language = 'all';
}
do_action('wpml_switch_language', $language);
return;
}
}
function is_multilanguage() {
return apply_filters('newsletter_is_multilanguage', class_exists('SitePress') || function_exists('pll_default_language') || class_exists('TRP_Translate_Press'));
}
function get_posts($filters = array(), $language = '') {
$current_language = $this->get_current_language();
// Language switch for WPML
if ($language) {
if (class_exists('SitePress')) {
$this->switch_language($language);
$filters['suppress_filters'] = false;
}
if (class_exists('Polylang')) {
$filters['lang'] = $language;
}
}
$posts = get_posts($filters);
if ($language) {
if (class_exists('SitePress')) {
$this->switch_language($current_language);
}
}
return $posts;
}
function get_wp_query($filters, $langiage = '') {
if ($language) {
if (class_exists('SitePress')) {
$this->switch_language($language);
$filters['suppress_filters'] = false;
}
if (class_exists('Polylang')) {
$filters['lang'] = $language;
}
}
$posts = new WP_Query($filters);
if ($language) {
if (class_exists('SitePress')) {
$this->switch_language($current_language);
}
}
return $posts;
}
protected function generate_admin_notification_message($user) {
$message = file_get_contents(__DIR__ . '/notification.html');
$message = $this->replace($message, $user);
$message = str_replace('{user_admin_url}', admin_url('admin.php?page=newsletter_users_edit&id=' . $user->id), $message);
return $message;
}
protected function generate_admin_notification_subject($subject) {
$blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
return '[' . $blogname . '] ' . $subject;
}
function dienow($message, $admin_message = null, $http_code = 200) {
if ($admin_message && current_user_can('administrator')) {
$message .= '<br><br><strong>Text below only visibile to administrators</strong><br>';
$message .= $admin_message;
}
wp_die($message, $http_code);
}
function dump($var) {
if (NEWSLETTER_DEBUG) {
var_dump($var);
}
}
function dump_die($var) {
if (NEWSLETTER_DEBUG) {
var_dump($var);
die();
}
}
}
/**
* Kept for compatibility.
*
* @param type $post_id
* @param type $size
* @param type $alternative
* @return type
*/
function nt_post_image($post_id = null, $size = 'thumbnail', $alternative = null) {
return NewsletterModule::get_post_image($post_id, $size, $alternative);
}
function newsletter_get_post_image($post_id = null, $size = 'thumbnail', $alternative = null) {
echo NewsletterModule::get_post_image($post_id, $size, $alternative);
}
/**
* Accepts a post or a post ID.
*
* @param WP_Post $post
*/
function newsletter_the_excerpt($post, $words = 30) {
$post = get_post($post);
$excerpt = $post->post_excerpt;
if (empty($excerpt)) {
$excerpt = $post->post_content;
$excerpt = strip_shortcodes($excerpt);
$excerpt = wp_strip_all_tags($excerpt, true);
}
echo '<p>' . wp_trim_words($excerpt, $words) . '</p>';
}