PluginProbe
Taboola / 2.2.3
Taboola v2.2.3
1.0.4 1.0.5 1.0.6 1.0.8 2.0.1 2.0.2 2.1.0 2.1.1 2.2.2 2.2.3 3.0.0 3.0.1 3.0.2 3.1.0 trunk 1.0 1.0.1 1.0.10 1.0.11 1.0.12 1.0.13 1.0.14 1.0.15 1.0.2 1.0.3
← All changes | taboola_widget.php +280 -325 3.0.2 → 2.2.3 View file →
@@ -1,208 +1,155 @@
1 1 <?php
2 2 /**
3 - * Plugin Name: Taboola
4 - * Plugin URI: https://developers.taboola.com/web-integrations/docs/wordpress-plugin
5 - * Description: Taboola
6 - * Version: 3.0.2
7 - * Author: Taboola
3 + * Plugin Name: Taboola
4 + * Plugin URI: https://developers.taboola.com/web-integrations/docs/wordpress-plugin
5 + * Description: Taboola
6 + * Version: 2.2.3
7 + * Author: Taboola
8 8 */
9 9
10 -define( 'TABOOLA_PLUGIN_VERSION', '3.0.2' ); // track every release
11 -define( 'TABOOLA_MIN_VER', '3.0' ); // bump only when DB changes
12 -define( 'TABOOLA_DEBUG_MODE', false );
10 +define ("TABOOLA_PLUGIN_VERSION","2.2.3"); // => UPDATE THIS FOR *EVERY* RELEASE (USED FOR TRACKING)
11 +define ("TABOOLA_MIN_VER","2.2.2"); // => UPDATE THIS *ONLY* IF THIS RELEASE HAS *DB CHANGES*
12 +define ("TABOOLA_DEBUG_MODE", false); // => SET THIS TO 'FALSE' FOR *EVERY* RELEASE (USED TO SUPRESS DEBUGGING LOGS)
13 13
14 -define( 'TABOOLA_OPTION_NAME', 'taboola_plugin_version' );
14 +define ("TABOOLA_OPTION_NAME","taboola_plugin_version"); // Note: if this release has DB changes, then the min version will be saved under 'taboola_plugin_version' in 'wp_options'.
15 15
16 -define( 'TABOOLA_XPATH_MARKER', '/' );
17 -define( 'TABOOLA_JS_INDICATOR', '{JS}' );
18 -define( 'TABOOLA_JS_MARKER', '{' );
19 -define( 'TABOOLA_CONTENT_FORMAT_STRING', 'string' );
20 -define( 'TABOOLA_CONTENT_FORMAT_SCRIPT', 'script' );
21 -define( 'TABOOLA_CONTENT_FORMAT_HTML', 'html' );
16 +define ("TABOOLA_XPATH_MARKER","/");
17 +define ("TABOOLA_JS_INDICATOR","{JS}");
18 +define ("TABOOLA_JS_MARKER","{");
19 +define ("TABOOLA_CONTENT_FORMAT_STRING",'string');
20 +define ("TABOOLA_CONTENT_FORMAT_SCRIPT",'script');
21 +define ("TABOOLA_CONTENT_FORMAT_HTML",'html');
22 22
23 -include_once 'widget.php';
24 -require_once 'JavaScriptWrapper.php';
25 -if ( ! class_exists( 'simple_html_dom' ) ) {
26 - require_once plugin_dir_path( __FILE__ ) . 'simple_html_dom.php'; // ← NEW
27 -}
28 23
29 -if ( ! class_exists( 'TaboolaWP' ) ) {
30 -class TaboolaWP {
24 +include_once('widget.php');
25 +require_once('JavaScriptWrapper.php');
31 26
32 - /* ─────────────────────────── properties ─────────────────────────── */
33 - public $data = [];
34 - public $_is_widget_on_page;
35 - public $_is_head_script_loaded = false;
36 27
37 - private $tpl_sw = 'importScripts("https://cdn.taboola.com/webpush/tsw.js");';
38 - private $msg_sw_error = <<<SWE
39 - <p>The file <code>sw.js</code> in the WP root is not writable.
40 - Please change its permissions or paste the code below manually:</p>
28 +if (!class_exists('TaboolaWP')) {
29 + class TaboolaWP
30 + {
31 + //save internal data
32 + public $data = array();
33 + public $_is_widget_on_page;
34 + public $_is_head_script_loaded = false;
35 + private $tpl_sw = 'importScripts("https://cdn.taboola.com/webpush/tsw.js");';
36 +
37 + private $msg_sw_error = <<<SWE
38 + <p>
39 + The file sw.js in the root directory of Wordpress is not writable.
40 + Please change its permissions and try again. Otherwise replace its contents manually:
41 + </p>
41 42 <pre><code>{{SW}}</code></pre>
42 - <p>Also make sure it's reachable at <code>{{DOMAIN}}/sw.js</code></p>
43 -SWE;
43 + <p>
44 + Also make sure that the file is accessible at {{DOMAIN}}/sw.js
45 + </p>
46 + SWE;
44 47
45 - public $plugin_name;
46 - public $plugin_directory;
47 - public $plugin_url;
48 - public $settings;
49 - public $tbl_taboola_settings;
48 + public $plugin_name;
49 + public $plugin_directory;
50 + public $plugin_url;
51 + public $settings;
52 + public $tbl_taboola_settings;
50 53
51 - /* ─────────────────────────── constructor ─────────────────────────── */
52 - public function __construct() {
53 - global $wpdb;
54 - //initialize plugin constant
55 - define( 'TaboolaWP', true );
54 + public function __construct()
55 + {
56 + global $wpdb;
56 57
57 - $this->_is_widget_on_page = false;
58 - $this->_is_head_script_loaded = false;
58 + //initialize plugin constant
59 + DEFINE('TaboolaWP', true);
59 60
60 - $this->plugin_name = plugin_basename( __FILE__ );
61 - $this->plugin_directory = plugin_dir_path( __FILE__ );
62 - $this->plugin_url = trailingslashit(
63 - WP_PLUGIN_URL . '/' . dirname( plugin_basename( __FILE__ ) )
64 - );
65 - $this->tbl_taboola_settings = $wpdb->prefix . '_taboola_settings';
66 - $this->settings = $wpdb->get_row(
67 - "SELECT * FROM {$this->tbl_taboola_settings} LIMIT 1"
68 - );
61 + $this->_is_widget_on_page = false;
62 + $this->_is_head_script_loaded = false;
69 63
70 - /* activation / upgrade */
71 - register_activation_hook( $this->plugin_name, [ $this, 'update_db' ] );
72 - add_action( 'admin_init', [ $this, 'update_db' ] );
64 + $this->plugin_name = plugin_basename(__FILE__);
65 + $this->plugin_directory = plugin_dir_path(__FILE__);
66 + $this->plugin_url = trailingslashit(WP_PLUGIN_URL . '/' . dirname(plugin_basename(__FILE__)));
67 + $this->settings = $wpdb->get_row("select * from ".$wpdb->prefix."_taboola_settings limit 1");
73 68
74 - /* widgets */
75 - if ( $this->settings && ! empty( $this->settings->publisher_id ) ) {
76 - add_action(
77 - 'widgets_init',
78 - static fn() => register_widget( 'WP_Widget_Taboola' )
79 - );
80 - }
69 + $this->tbl_taboola_settings = $wpdb->prefix . '_taboola_settings';
81 70
82 - /* admin vs front-end hooks */
83 - if ( is_admin() ) {
84 - add_action( 'admin_menu', [ $this, 'admin_generate_menu' ] );
85 - add_filter( 'plugin_action_links',
86 - [ $this, 'plugin_action_links' ], 10, 2 );
87 - }
88 -
89 -
90 -
91 -
92 - elseif ( $this->settings ) {
93 - /* loader & flush */
94 - add_action( 'wp_head', [ $this, 'taboola_header_loader_inject' ] );
95 - if ( ! empty( $this->settings->publisher_id_push ) ) {
96 - add_action( 'wp_head', [ $this, 'taboola_webpush_loader_js' ] );
71 + //activation function
72 + register_activation_hook($this->plugin_name, array(&$this, 'update_db'));
73 + add_action('admin_init', array(&$this, 'update_db'));
97 74
98 - $sw = 'sw.js';
99 - $sw_path = ABSPATH . $sw;
75 + // Enable sidebar widgets
76 + if ($this->settings != NULL && !empty($this->settings->publisher_id)){
77 + //register Taboola widget
78 + add_action('widgets_init',
79 + function(){
80 + return register_widget("WP_Widget_Taboola");
81 + }
82 + );
83 + }
100 84
101 - $content = file_exists( $sw_path ) ? file_get_contents( $sw_path ) : '';
85 + //$this->should_place_tag_outside_of_content = $this->settings->out_of_content_enabled;
102 86
103 - if ( strpos( $content, $this->tpl_sw ) === false ) {
104 - if ( ! is_writable( ABSPATH ) || ( file_exists( $sw_path ) && ! is_writable( $sw_path ) ) ) {
105 - return $this->notice( $this->msg_sw_error );
87 + if (is_admin()) {
88 + //add menu for plugin
89 + add_action( 'admin_menu', array(&$this, 'admin_generate_menu') );
90 + add_filter('plugin_action_links', array(&$this, 'plugin_action_links'), 10, 2 );
91 + }elseif ($this->settings != NULL){
92 + add_action('wp_head', array(&$this, 'taboola_header_loader_inject'));
93 + if (!empty($this->settings->publisher_id_push)) {
94 + add_action('wp_head', array(&$this, 'taboola_webpush_loader_js'));
95 +
96 + $sw = 'sw.js';
97 + $sw_path = ABSPATH . $sw;
98 +
99 + $content = file_exists($sw_path) ? file_get_contents($sw_path) : '';
100 +
101 + if (strpos($content, $this->tpl_sw) === false) {
102 + if (!is_writable(ABSPATH) || (file_exists($sw_path) && !is_writable($sw_path))) {
103 + return $this->notice($this->msg_sw_error);
106 104 }
107 105 $content = $this->tpl_sw . PHP_EOL . $content;
108 - if ( file_put_contents( $sw_path, $content ) === false ) {
109 - return $this->notice( $this->msg_sw_error );
106 + if (file_put_contents($sw_path, $content) === false) {
107 + return $this->notice($this->msg_sw_error);
110 108 }
111 109 }
112 110 }
113 - add_action( 'wp_footer', [ $this, 'taboola_footer_loader_js' ] );
111 + add_action('wp_footer', array(&$this, 'taboola_footer_loader_js'));
112 + add_filter('the_content', array(&$this, 'load_taboola_content'));
113 + add_filter('the_content', array(&$this, 'load_taboola_content_mid'));
114 + //add_filter('the_content', array(&$this, 'load_taboola_content_home'));
115 + // add_filter('the_excerpt', array(&$this, 'load_taboola_content_home'));
116 + // Homepage widget – capture the full page, inject once.
117 + // Homepage widget – start buffering *before* anything else renders
118 + add_action( 'template_redirect', [ $this, 'tb_home_buffer_start' ], 0 );
114 119
115 - /* content widgets */
116 - add_filter( 'the_content', [ $this, 'load_taboola_content' ] );
117 - add_filter( 'the_content', [ $this, 'load_taboola_content_mid' ] );
120 + // Homepage widget – flush the buffer *after* literally everything else
121 + add_action( 'shutdown', [ $this, 'tb_home_buffer_flush' ], PHP_INT_MAX );
118 122
119 - /* full-page buffer – home & category */
120 - add_action( 'template_redirect', [ $this, 'tb_home_buffer_start' ], 0 );
121 - add_action( 'shutdown', [ $this, 'tb_home_buffer_flush' ], PHP_INT_MAX );
122 -
123 - add_action( 'template_redirect', [ $this, 'tb_cat_buffer_start' ], 0 );
124 - add_action( 'shutdown', [ $this, 'tb_cat_buffer_flush' ], PHP_INT_MAX );
125 - }
126 - } // __construct
127 -
128 -
129 -/* ======================================================================
130 - CATEGORY ▸ should we show the widget?
131 - ====================================================================== */
132 -private function should_show_content_widget_category(): bool {
133 - return (
134 - trim( $this->settings->publisher_id ) !== '' &&
135 - ( is_category() || is_archive() || is_search() ) &&
136 - $this->settings->category_enabled &&
137 - trim( $this->settings->category_widget_id ) !== ''
138 - );
139 -}
140 -
141 -/* ----------------------------------------------------------------------
142 - HOMEPAGE ▸ full-page buffer
143 - -------------------------------------------------------------------- */
123 +
124 + }
125 +
126 + }
127 +
128 + /* ------------------------------------------------------------------
129 + * HOMEPAGE WIDGET – full-page buffer
130 + * ----------------------------------------------------------------*/
144 131 public function tb_home_buffer_start() {
132 +
133 + // Use the plug-in’s own logic to decide if the home widget is enabled
145 134 if ( $this->should_show_content_widget_home() ) {
146 135 ob_start( [ $this, 'tb_home_buffer_inject' ] );
147 136 }
148 137 }
138 +
149 139 public function tb_home_buffer_inject( $html ) {
140 + //error_log( '🟢 Taboola buffer inject ran. HTML length = ' . strlen( $html ) ); // LOG #1
141 + // error_log( 'TB-DEBUG ① buffer inject, html len='.strlen($html) );
142 +
143 + /*
144 + * load_taboola_content_home() already:
145 + * – reads your saved widget-ID, placement, selector & occurrence
146 + * – builds the HTML + JS
147 + * – calls embed_taboola_content_location_home() to place it
148 + */
150 149 return $this->load_taboola_content_home( $html );
151 150 }
152 151
153 -/* ----------------------------------------------------------------------
154 - CATEGORY ▸ buffer hooks
155 - -------------------------------------------------------------------- */
156 -public function tb_cat_buffer_start() {
157 - if ( $this->should_show_content_widget_category() ) {
158 - ob_start( [ $this, 'tb_cat_buffer_inject' ] );
159 - }
160 -}
161 -public function tb_cat_buffer_inject( $html ) {
162 - return $this->load_taboola_content_category( $html );
163 -}
164 -public function tb_cat_buffer_flush() {
165 - if ( ob_get_length() ) {
166 - echo ob_get_clean();
167 - }
168 -}
169 -
170 -/* ----------------------------------------------------------------------
171 - CATEGORY ▸ choose where to inject
172 - -------------------------------------------------------------------- */
173 -private function embed_taboola_content_location_category(
174 - string $html,
175 - array $taboola_content,
176 - string $selector ) : string {
177 -
178 - $formatted = $this->format_taboola_content_category( $taboola_content );
179 -
180 - /* A. no selector → bottom of page */
181 - if ( $selector === '' ) {
182 - return str_ireplace( '</body>', $formatted . '</body>', $html );
183 - }
184 -
185 - /* B. selector given → try server-side injection */
186 - $doc = str_get_html( $html );
187 - if ( ! $doc ) {
188 - // parser failed → graceful fallback
189 - return str_ireplace( '</body>', $formatted . '</body>', $html );
190 - }
191 -
192 - $occurrence = max( 0, $this->settings->category_location_string_occurrence - 1 );
193 - $target = $doc->find( $selector, $occurrence );
194 -
195 - if ( $target ) { // selector found
196 - $target->outertext .= $formatted;
197 - return (string) $doc; // done – no duplicate
198 - }
199 -
200 - /* C. selector not found → bottom of page */
201 - return str_ireplace( '</body>', $formatted . '</body>', $html );
202 -}
203 -
204 -/* ------------------------------------------------------------------ */
205 152 public function tb_home_buffer_flush() {
206 153 if ( ob_get_length() ) {
207 154 echo ob_get_clean();
208 155 }
@@ -207,12 +154,9 @@
207 154 echo ob_get_clean();
208 155 }
209 156 }
210 157
211 -
212 -
213 -
214 -function plugin_action_links($links, $file) {
158 + function plugin_action_links($links, $file) {
215 159 static $this_plugin;
216 160
217 161 if (!$this_plugin) {
218 162 $this_plugin = plugin_basename(__FILE__);
@@ -234,9 +178,9 @@
234 178 private function should_show_content_widget_mid(){
235 179 // PC - only if v2 was installed:
236 180 if (!$this->is_db_updated_for_min_ver("2.0.0"))
237 181 return false;
238 - $retVal1 = ((trim($this->settings->publisher_id) != '') && is_single() && !empty($this->settings->mid_enabled));
182 + $retVal1 = ((trim($this->settings->publisher_id) != '') && is_single() && $this->settings->mid_enabled && trim($this->settings->mid_widget_id) != '');
239 183 return $retVal1;
240 184 }
241 185
242 186 private function should_show_content_widget_home(){
@@ -256,9 +200,9 @@
256 200 }
257 201
258 202 // Determine if a taboola widget should be added somewhere on the current page (content or sidebar)
259 203 function is_widget_on_page(){
260 - return $this->should_show_content_widget() || $this->should_show_content_widget_mid() || $this->should_show_content_widget_home() || $this->should_show_sidebar_widget() || $this->should_show_content_widget_category() ;
204 + return $this->should_show_content_widget() || $this->should_show_content_widget_mid() || $this->should_show_content_widget_home() || $this->should_show_sidebar_widget();
261 205 }
262 206
263 207 function get_page_type(){
264 208 $page_type='article';
@@ -270,21 +214,15 @@
270 214 return $page_type;
271 215 }
272 216
273 217 // return the head loader script
274 - function taboola_header_loader_js() {
218 + function taboola_header_loader_js() {
219 + $head_string = "";
220 +
221 + // Only adding the loader if a widget is going to be placed on the page.
275 222 if ($this->is_widget_on_page()){
276 -
277 - // New logic to get all mid-article locations
278 - $mid_locations_string = '';
279 - if (!empty($this->settings->mid_widgets)) {
280 - $mid_widgets_array = json_decode($this->settings->mid_widgets, true);
281 - if (is_array($mid_widgets_array)) {
282 - $locations = array_column($mid_widgets_array, 'location_string');
283 - $mid_locations_string = implode(', ', $locations);
284 - }
285 - }
286 -
223 + // PC - since these params will be inserted in 'loaderInjectionScript.js' via search and replace,
224 + // double brackets are used to ensure that each key is a unique string.
287 225 $stringParams = array(
288 226 '{{PUBLISHER_ID}}' => $this->settings->publisher_id,
289 227 '{{PAGE_TYPE}}' => $this->get_page_type(),
290 228 '{{WORDPRESS_VERSION}}' => get_bloginfo('version'),
@@ -289,18 +227,19 @@
289 227 '{{PAGE_TYPE}}' => $this->get_page_type(),
290 228 '{{WORDPRESS_VERSION}}' => get_bloginfo('version'),
291 229 '{{PHP_VERSION}}' => phpversion(),
292 230 '{{PLUGIN_VERSION}}' => TABOOLA_PLUGIN_VERSION,
293 - '{{LOC_MID}}' => $mid_locations_string,
294 - '{{LOC_HOME}}' => $this->settings->home_location_string ?? ''
231 + '{{LOC_MID}}' => $this->settings->mid_location_string,
232 + '{{LOC_HOME}}' => $this->settings->home_location_string
295 233 );
296 234
297 235 $scriptWrapper = new JavaScriptWrapper("loaderInjectionScript.js",$stringParams);
298 - return $scriptWrapper->getScriptMarkupString();
236 + $head_string = $scriptWrapper->getScriptMarkupString();
299 237 }
300 - return "";
238 + return $head_string;
301 239 }
302 240
241 +
303 242 // This function is used for the hook action, injects the header content to the <head> tag.
304 243 function taboola_header_loader_inject(){
305 244 echo $this->taboola_header_loader_js();
306 245 }
@@ -348,37 +287,24 @@
348 287 return $content;
349 288 }
350 289
351 290 // Mid-article-widget
352 - function load_taboola_content_mid($content) {
291 + function load_taboola_content_mid($content)
292 + {
293 + $taboola_content_mid = array();
353 294 if ($this->should_show_content_widget_mid()){
354 - $mid_widgets = json_decode($this->settings->mid_widgets ?? '[]');
355 295
356 - if (is_array($mid_widgets) && !empty($mid_widgets)) {
357 - foreach ($mid_widgets as $index => $widget) {
358 - $container_id = 'taboola-mid-article-thumbnails-' . $index;
359 -
360 - $widgetParams = array(
361 - '{{WIDGET_ID}}' => $widget->widget_id,
362 - '{{CONTAINER}}' => $container_id,
363 - '{{PLACEMENT}}' => $widget->placement
364 - );
296 + $secondWidgetParams = array('{{WIDGET_ID}}' => $this->settings->mid_widget_id,
297 + '{{CONTAINER}}' => 'taboola-mid-article-thumbnails',
298 + '{{PLACEMENT}}' => $this->settings->mid_placement);
299 +
300 + $secondWidgetScript = new JavaScriptWrapper("widgetInjectionScript.js",$secondWidgetParams);
301 + $taboola_content_mid[TABOOLA_CONTENT_FORMAT_HTML][] = "<div id='taboola-mid-article-thumbnails'></div>";
302 + $taboola_content_mid[TABOOLA_CONTENT_FORMAT_SCRIPT][] = $secondWidgetScript;
365 303
366 - $widgetScript = new JavaScriptWrapper("widgetInjectionScript.js", $widgetParams);
367 - $taboola_content_mid = array(
368 - TABOOLA_CONTENT_FORMAT_HTML => array("<div id='{$container_id}'></div>"),
369 - TABOOLA_CONTENT_FORMAT_SCRIPT => array($widgetScript),
370 - );
304 + $content = $this->embed_taboola_content_location_mid($content,$taboola_content_mid,trim($this->settings->mid_location_string));
305 + }
371 306
372 - $content = $this->embed_taboola_content_location_mid(
373 - $content,
374 - $taboola_content_mid,
375 - $widget->location_string,
376 - $widget->occurrence
377 - );
378 - }
379 - }
380 - }
381 307 return $content;
382 308 }
383 309
384 310 // Homepage widget
@@ -400,33 +326,9 @@
400 326 }
401 327 return $content;
402 328
403 329 }
404 - /* ------------------------------------------------------------------
405 - * CATEGORY ▸ build widget & inject
406 - * ------------------------------------------------------------------*/
407 -public function load_taboola_content_category( $content ) {
408 330
409 - // 1) Build the DIV that Taboola will fill
410 - $taboola[TABOOLA_CONTENT_FORMAT_HTML][] =
411 - "<div id='taboola-category-thumbnails'></div>";
412 -
413 - // 2) Build the JS that loads the feed (reuse the wrapper)
414 - $taboola[TABOOLA_CONTENT_FORMAT_SCRIPT][] =
415 - new JavaScriptWrapper( 'widgetInjectionScript.js', [
416 - '{{WIDGET_ID}}' => $this->settings->category_widget_id,
417 - '{{CONTAINER}}' => 'taboola-category-thumbnails',
418 - '{{PLACEMENT}}' => $this->settings->category_placement,
419 - ]);
420 -
421 - // 3) Decide where to insert (selector or end of <body>)
422 - return $this->embed_taboola_content_location_category(
423 - $content,
424 - $taboola,
425 - trim( $this->settings->category_location_string )
426 - );
427 -}
428 -
429 331 // Below-article widget
430 332
431 333 // Extract the taboola content in the required format:
432 334 // String - for injecting on the servr side
@@ -493,18 +395,8 @@
493 395 return $ret_val;
494 396
495 397 }
496 398
497 -
498 - // ► CATEGORY formatter ◄
499 -private function format_taboola_content_category( $arr ) {
500 - return implode( "\n", [
501 - implode( "\n", $arr[TABOOLA_CONTENT_FORMAT_HTML] ?? [] ),
502 - '<script type="text/javascript">' .
503 - implode( "\n", $arr[TABOOLA_CONTENT_FORMAT_SCRIPT] ?? [] ) .
504 - '</script>',
505 - ]);
506 -}
507 399 // Below-article widget
508 400 // Do the actual logic of choosing where to place the taboola content.
509 401 function embed_taboola_content_location($content, $taboola_content){
510 402 $do_default = true;
@@ -530,9 +422,9 @@
530 422 }
531 423
532 424 // Mid-article widget
533 425 // Do the actual logic of choosing where to place the taboola content based on the "location" attribute
534 - function embed_taboola_content_location_mid($content, $taboola_content_mid, $location, $occurrence = 1){
426 + function embed_taboola_content_location_mid($content, $taboola_content_mid, $location){
535 427 $do_default = true;
536 428
537 429 if (isset($location) && $location != ''){
538 430 $first_char = substr($location,0,1);
@@ -556,14 +448,12 @@
556 448
557 449 // server side selector provided (see simple_html_dom selectors http://simplehtmldom.sourceforge.net/manual.htm)
558 450 // basically it's CSS selectors like in jQuery
559 451 } else{
560 - if ( ! class_exists( 'simple_html_dom' ) ) {
561 - require_once('simple_html_dom.php');
562 - }
452 + require_once('simple_html_dom.php');
563 453
564 454 $html_doc = str_get_html($content);
565 - $target_location = $html_doc->find($location, ($occurrence) - 1);
455 + $target_location = $html_doc->find($location,($this->settings->mid_location_string_occurrence)-1);
566 456
567 457 // if the location was found within the html content
568 458 if (isset($target_location) && is_object($target_location)){
569 459
@@ -573,8 +463,12 @@
573 463 $do_default = false;
574 464 }
575 465 }
576 466 }
467 + // Default for below-article widget - add to the end of the content
468 + // if ($do_default){
469 + // $content = $content.$this->format_taboola_content_mid($taboola_content_mid,TABOOLA_CONTENT_FORMAT_STRING);
470 + // }
577 471
578 472 return $content;
579 473 }
580 474
@@ -619,12 +513,10 @@
619 513 }
620 514
621 515 // server side selector provided (see simple_html_dom selectors http://simplehtmldom.sourceforge.net/manual.htm)
622 516 // basically it's CSS selectors like in jQuery
623 - } else{
624 - if ( ! class_exists( 'simple_html_dom' ) ) {
517 + } else{
625 518 require_once('simple_html_dom.php');
626 - }
627 519
628 520 $html_doc = str_get_html($content);
629 521 $target_location = $html_doc->find($location,($this->settings->home_location_string_occurrence)-1);
630 522
@@ -677,18 +569,33 @@
677 569 }
678 570 }
679 571
680 572 if(isset($_POST['mid_enabled'])) {
681 - if(isset($_POST['mid_widget_id']) && is_array($_POST['mid_widget_id'])) {
682 - foreach ($_POST['mid_widget_id'] as $index => $widget_id) {
683 - if(trim($widget_id) == '') {
684 - $taboola_errors[] = "Mid-article Widget #".($index + 1)." > Widget ID";
685 - }
686 - if(trim($_POST['mid_placement'][$index]) == '') {
687 - $taboola_errors[] = "Mid-article Widget #".($index + 1)." > Placement Name";
688 - }
573 + if (trim(strip_tags($_POST['mid_widget_id'])) == '') {
574 + $taboola_errors[] = "Mid-article > Widget ID";
575 + }
576 + if (trim(strip_tags($_POST['mid_placement'])) == '') {
577 + $taboola_errors[] = "Mid-article > Placement Name";
578 + }
579 + if (trim(strip_tags($_POST['mid_location_string'])) == '') {
580 + $taboola_errors[] = "Mid-article > CSS selector";
581 + }
582 + else {
583 + // If the 'location' WAS filled in, then...
584 +
585 + // 1) Check for a valid 'location':
586 +
587 + // Validation method has not been implemented
588 + // mid_if (!$this->is_locaton_string_valid1($_POST['mid_location_string'])) {
589 + // $taboola_errors[] = "Mid-article > CSS Selector (invalid value)";
590 + // }
591 +
592 + // 2) Validate the 'occurrence':
593 + if (!$this->is_mid_location_string_occurrence_valid($_POST['mid_location_string_occurrence'])) {
594 + $taboola_errors[] = "Mid-article > Occurance (must be >= 1)";
689 595 }
690 596 }
597 +
691 598 }
692 599
693 600 if(isset($_POST['home_enabled'])) {
694 601 if (trim(strip_tags($_POST['home_widget_id'])) == '') {
@@ -701,45 +608,25 @@
701 608 if (trim(strip_tags($_POST['home_location_string'])) == '') {
702 609 $taboola_errors[] = "Homepage > CSS selector";
703 610 }
704 611 else {
612 + // If the 'location' WAS filled in, then...
613 +
614 + // 1) Check for a valid 'location':
615 +
616 + // Validation method has not been implemented
617 + // if (!$this->is_home_location_string_valid($_POST['home_location_string'])) {
618 + // $taboola_errors[] = "Homepage > CSS Selector (invalid value)";
619 + // }
620 +
621 + // 2) Validate the 'occurrence':
705 622 if (!empty($_POST['home_location_string']) && !$this->is_home_location_string_occurrence_valid($_POST['home_location_string_occurrence'])) {
706 623 $taboola_errors[] = "Homepage > Occurance (must be >= 1)";
707 624 }
708 625 }
709 - }
710 - if ( isset($_POST['category_enabled']) ) {
711 - if ( trim(strip_tags($_POST['category_widget_id'])) == '' )
712 - $taboola_errors[] = "Category > Widget ID";
713 - if ( trim(strip_tags($_POST['category_placement'])) == '' )
714 - $taboola_errors[] = "Category > Placement Name";
715 - }
626 + }
716 627
717 628 if(count($taboola_errors) == 0){
718 -
719 - $mid_widgets_data = array();
720 - if (isset($_POST['mid_widget_id']) && is_array($_POST['mid_widget_id'])) {
721 - foreach ($_POST['mid_widget_id'] as $index => $widget_id) {
722 - if (!empty(trim($widget_id))) {
723 -
724 - $location_string = 'p';
725 - if (isset($_POST['mid_paragraph_ui_mode'][$index]) && $_POST['mid_paragraph_ui_mode'][$index] === 'Other') {
726 - if (isset($_POST['mid_location_string'][$index])) {
727 - $location_string = sanitize_text_field($_POST['mid_location_string'][$index]);
728 - }
729 - }
730 -
731 - $mid_widgets_data[] = array(
732 - 'widget_id' => sanitize_text_field($widget_id),
733 - 'placement' => sanitize_text_field($_POST['mid_placement'][$index]),
734 - 'location_string' => $location_string,
735 - 'occurrence' => intval($_POST['mid_location_string_occurrence'][$index]),
736 - );
737 - }
738 - }
739 - }
740 - $mid_widgets_json = json_encode($mid_widgets_data);
741 -
742 629 $data = array(
743 630 "publisher_id" => trim($_POST['publisher_id']),
744 631
745 632 "web_push_enabled" => isset($_POST['web_push_enabled']) ? true : false,
@@ -751,23 +638,24 @@
751 638
752 639 "out_of_content_enabled" => isset($_POST['out_of_content_enabled']) ? true : false,
753 640
754 641 "mid_enabled" => isset($_POST['mid_enabled']) ? true : false,
755 - "mid_widgets" => $mid_widgets_json,
756 -
642 + "mid_widget_id" => !empty($_POST['mid_widget_id']) ? trim($_POST['mid_widget_id']) : '',
643 + "mid_placement" => !empty($_POST['mid_placement']) ? trim($_POST['mid_placement']) : '',
644 + "mid_paragraph_ui_mode" => !empty($_POST['mid_paragraph_ui_mode']) ? trim($_POST['mid_paragraph_ui_mode']) : '',
645 +
646 + "mid_location_string_occurrence" => !empty($_POST['mid_location_string_occurrence']) ? $_POST['mid_location_string_occurrence'] : '',
647 + "mid_location_string" => !empty($_POST['mid_location_string']) ? trim($_POST['mid_location_string']) : '',
648 +
757 649 "home_enabled" => isset($_POST['home_enabled']) ? true : false,
758 650 "home_widget_id" => !empty($_POST['home_widget_id']) ? trim($_POST['home_widget_id']) : '',
759 651 "home_placement" => !empty($_POST['home_placement']) ? trim($_POST['home_placement']) : '',
760 652
761 653 "home_location_string_occurrence" => !empty($_POST['home_location_string_occurrence']) ? $_POST['home_location_string_occurrence'] : '',
762 - "home_location_string" => !empty($_POST['home_location_string']) ? trim($_POST['home_location_string']) : '',
763 - "category_enabled" => isset($_POST['category_enabled']) ? true : false,
764 - "category_widget_id" => !empty($_POST['category_widget_id']) ? trim($_POST['category_widget_id']) : '',
765 - "category_placement" => !empty($_POST['category_placement']) ? trim($_POST['category_placement']) : '',
766 - "category_location_string_occurrence" => !empty($_POST['category_location_string_occurrence']) ? $_POST['category_location_string_occurrence'] : '',
767 - "category_location_string" => !empty($_POST['category_location_string']) ? trim($_POST['category_location_string']) : '',
654 + "home_location_string" => !empty($_POST['home_location_string']) ? trim($_POST['home_location_string']) : ''
655 + );
768 656
769 - );
657 + //var_dump($settings);
770 658
771 659 $is_valid_nonce = false;
772 660
773 661 if (isset( $_POST['my_plugin_nonce']) && wp_verify_nonce( $_POST['my_plugin_nonce'], 'my_plugin_update_field_action' ) ) {
@@ -775,9 +663,9 @@
775 663 }
776 664
777 665 if ($is_valid_nonce) {
778 666 if($settings == NULL){
779 - $wpdb->insert($this->tbl_taboola_settings, $data);
667 + $wpdb->insert($this->tbl_taboola_settings, $data, null, null);
780 668 } else {
781 669 $wpdb->update($this->tbl_taboola_settings, $data, array('id' => $settings->id));
782 670 }
783 671 }
@@ -842,9 +730,21 @@
842 730 }
843 731 }
844 732
845 733 function is_db_updated_for_min_ver($min_ver) {
734 + /**
735 + * Checks if the DB was *previously* updated for the minimum version specified.
736 + * $min_ver should be passed in a format like this: "2.1.0"
737 + */
738 +
846 739 global $wpdb;
740 +
741 + // PC - Temporary patch for v2.1.0
742 +
743 + // START patch ===============================================
744 + // Check if the `_taboola` table exists.
745 + // If not, then return false.
746 +
847 747 $table_name = $wpdb->prefix . "_taboola_settings";
848 748
849 749 if($wpdb->get_var("SHOW TABLES LIKE '$table_name'") != $table_name) {
850 750 tb_write_log("Table NOT FOUND");
@@ -852,31 +752,55 @@
852 752 }
853 753 else {
854 754 tb_write_log("Table EXISTS");
855 755 }
756 + // END patch =================================================
757 +
758 + // Check the saved version in wp_options. Default to '1.0.0' if the option is not found.
856 759 $saved_version = get_option(TABOOLA_OPTION_NAME, '1.0.0');
857 760
858 761 $db_is_up_to_date = version_compare($saved_version, $min_ver, '>=');
762 + //tb_write_log($db_is_up_to_date);
859 763 return $db_is_up_to_date;
860 764
861 765 }
862 766
863 767 function is_db_updated_for_current_ver() {
768 + /**
769 + * DEPRECATED
770 + * Checks if the DB was *previously* updated for the version currently loaded.
771 + */
864 772 global $wpdb;
773 +
774 + // Check the saved version in wp_options. Default to '1.0.0' if the option is not found.
865 775 $saved_version = get_option(TABOOLA_OPTION_NAME, '1.0.0');
776 +
777 + // Get the currently loaded plugin version.
866 778 $plugin_version = $this->get_loaded_plugin_version();
779 +
867 780 $db_is_up_to_date = version_compare($saved_version, $plugin_version, '>=');
781 + //tb_write_log($db_is_up_to_date);
868 782 return $db_is_up_to_date;
783 +
869 784 }
870 785
871 786 function get_loaded_plugin_version() {
872 - $plugin_data = get_plugin_data( __FILE__ );
787 +
788 + $plugin_data = get_plugin_data( __FILE__ ); // Can be invoked from Admin page only
873 789 $loaded_plugin_version = $plugin_data['Version'];
874 790 return $loaded_plugin_version;
791 +
875 792 }
876 793
877 794 function save_taboola_version($min_ver) {
795 + /**
796 + * Checks for the saved version in wp_options.
797 + * If not found - adds it. Else - updates it.
798 + */
799 +
800 +
878 801 tb_write_log("SAVING NEW MIN VERSION: " . $min_ver); // PC
802 +
879 803 $saved_version = get_option(TABOOLA_OPTION_NAME, '');
880 804 if ($saved_version == '') {
881 805 add_option(TABOOLA_OPTION_NAME, $min_ver);
882 806 }
@@ -885,9 +809,12 @@
885 809 }
886 810 }
887 811
888 812 function update_db(){
813 +
814 + // If we are up to date, then skip this method...
889 815 if ($this->is_db_updated_for_min_ver(TABOOLA_MIN_VER)) {
816 + //tb_write_log("All up to date!");
890 817 return;
891 818 }
892 819
893 820 $this->save_taboola_version(TABOOLA_MIN_VER);
@@ -894,17 +821,24 @@
894 821
895 822 global $wpdb;
896 823 require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
897 824
898 - $charset_collate = '';
899 - if ( ! empty( $wpdb->charset ) ) {
900 - $charset_collate = "DEFAULT CHARACTER SET {$wpdb->charset}";
825 +
826 + // Handling for older MySQL versions
827 + if (function_exists('mysql_get_server_info') && version_compare(mysql_get_server_info(), '4.1.0', '>=')) {
828 + if (!empty($wpdb->charset))
829 + $charset_collate = "DEFAULT CHARACTER SET $wpdb->charset";
830 + if (!empty($wpdb->collate))
831 + $charset_collate .= " COLLATE $wpdb->collate";
901 832 }
902 - if ( ! empty( $wpdb->collate ) ) {
903 - $charset_collate .= " COLLATE {$wpdb->collate}";
904 - }
905 833
834 + // Check if this is an upgrade from v1
906 835 $is_upgrade_from_v1 = $this->is_upgrade_from_v1();
836 +
837 + // tb_write_log("Is upgrade from v1: " . ($is_upgrade_from_v1 ? 'true' : 'false'));
838 +
839 +
840 + //settings table structure
907 841 $sql_table_settings = "
908 842 CREATE TABLE `" . $wpdb->prefix . "_taboola_settings` (
909 843 `id` INT NOT NULL AUTO_INCREMENT ,
910 844 `publisher_id` VARCHAR(255) DEFAULT NULL,
@@ -912,23 +846,31 @@
912 846 `publisher_id_push` INT(15) DEFAULT NULL,
913 847 `first_bc_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
914 848 `first_bc_widget_id` VARCHAR(255) DEFAULT NULL,
915 849 `first_bc_placement` VARCHAR(255) DEFAULT " . ($is_upgrade_from_v1 ? "'below-article'" : "NULL") .",
850 + `first_bc_custom_css` TEXT DEFAULT NULL,
851 + `second_bc_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
852 + `second_bc_widget_id` VARCHAR(255) DEFAULT NULL,
853 + `second_bc_custom_css` TEXT DEFAULT NULL,
854 + `location_string` TEXT DEFAULT NULL,
855 + `mid_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
856 + `mid_widget_id` VARCHAR(255) DEFAULT NULL,
857 + `mid_placement` VARCHAR(255) DEFAULT NULL,
916 858 `out_of_content_enabled` TINYINT(1) NOT NULL DEFAULT TRUE,
917 - `mid_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
918 - `mid_widgets` TEXT DEFAULT NULL,
859 + `mid_location_string` TEXT DEFAULT NULL,
860 + `mid_location_string_occurrence` SMALLINT DEFAULT NULL,
861 + `mid_paragraph_ui_mode` VARCHAR(255) DEFAULT NULL,
919 862 `home_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
920 863 `home_widget_id` VARCHAR(255) DEFAULT NULL,
921 864 `home_placement` VARCHAR(255) DEFAULT NULL,
922 865 `home_location_string` TEXT DEFAULT NULL,
923 866 `home_location_string_occurrence` SMALLINT DEFAULT NULL,
924 - `category_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
925 - `category_widget_id` VARCHAR(255) DEFAULT NULL,
926 - `category_placement` VARCHAR(255) DEFAULT NULL,
927 - `category_location_string` TEXT DEFAULT NULL,
928 - `category_location_string_occurrence` SMALLINT DEFAULT NULL,
929 867 PRIMARY KEY (`id`)
930 - ) $charset_collate;";
868 + )" . $charset_collate . ";";
869 +
870 + // tb_write_log($sql_table_settings);
871 +
872 + // create/update the table
931 873 dbDelta($sql_table_settings);
932 874 }
933 875 }
934 876 }
@@ -935,11 +877,19 @@
935 877
936 878 global $taboolaWP;
937 879 $taboolaWP = new TaboolaWP();
938 880
881 +/*
882 +A few utility methods for logging
883 +*/
884 +
885 +// Writes debugging messages to 'logs/debug.log'.
886 +// The exact file location depends on *where* you trigger the function.
887 +// In this script, we trigger the function from the admin dashboard.
888 +// So the log file is located under 'wp-admin/logs'.
939 889 function tb_write_log($log_msg)
940 890 {
941 - if (!TABOOLA_DEBUG_MODE)
891 + if (!TABOOLA_DEBUG_MODE) // If not debug mode, do nothing
942 892 return;
943 893
944 894 $log_filename = "logs";
945 895 if (!file_exists($log_filename))
@@ -947,8 +897,9 @@
947 897 mkdir($log_filename, 0777, true);
948 898 }
949 899 $log_file_data = $log_filename.'/debug.log';
950 900
901 + // Add date/time
951 902 $date = date('Y-m-d H:i:s');
952 903 $log_msg_with_date = $date." : ".$log_msg;
953 904
954 905 file_put_contents($log_file_data, $log_msg_with_date . "\n", FILE_APPEND);
@@ -953,8 +904,9 @@
953 904
954 905 file_put_contents($log_file_data, $log_msg_with_date . "\n", FILE_APPEND);
955 906 }
956 907
908 +// Write to console
957 909 function tb_console_log( $data ){
958 910
959 911 If(wp_get_environment_type() === 'development') {
960 912
@@ -964,8 +916,9 @@
964 916
965 917 }
966 918 }
967 919
920 +// Write to webpage and stop
968 921 function tb_print_to_page($data) {
969 922 If(wp_get_environment_type() === 'development') {
970 923 print_r($data);
971 924 die;
@@ -970,17 +923,19 @@
970 923 print_r($data);
971 924 die;
972 925 }
973 926 }
927 +//
974 928
929 +// Enqueue js_inject.min.js script for XPath injection
975 930 function enqueue_taboola_scripts() {
976 931 wp_register_script(
977 932 'taboola-injector',
978 933 plugins_url('js/js_inject.min.js', __FILE__),
979 - array(),
980 - null,
981 - true
934 + array(), // No dependencies
935 + null, // No version specified
936 + true // Load in footer
982 937 );
983 938
984 939 wp_enqueue_script('taboola-injector');
985 940 }
986 -add_action('wp_enqueue_scripts', 'enqueue_taboola_scripts');
941 +add_action('wp_enqueue_scripts', 'enqueue_taboola_scripts');