PluginProbe
Taboola / 2.2.2
Taboola v2.2.2
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 +599 -99 1.0.12 → 2.2.2 View file →
@@ -1,25 +1,31 @@
1 1 <?php
2 2 /**
3 3 * Plugin Name: Taboola
4 - * Plugin URI: https://developers.taboola.com/web-integrations/discuss
4 + * Plugin URI: https://developers.taboola.com/web-integrations/docs/wordpress-plugin
5 5 * Description: Taboola
6 - * Version: 1.0.12
6 + * Version: 2.2.2
7 7 * Author: Taboola
8 8 */
9 9
10 -define ("XPATH_MARKER","/");
11 -define ("JS_INDICATOR","{JS}");
12 -define ("JS_MARKER","{");
10 +define ("TABOOLA_PLUGIN_VERSION","2.2.2"); // => 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 +
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 +
16 +define ("TABOOLA_XPATH_MARKER","/");
17 +define ("TABOOLA_JS_INDICATOR","{JS}");
18 +define ("TABOOLA_JS_MARKER","{");
13 19 define ("TABOOLA_CONTENT_FORMAT_STRING",'string');
14 20 define ("TABOOLA_CONTENT_FORMAT_SCRIPT",'script');
15 21 define ("TABOOLA_CONTENT_FORMAT_HTML",'html');
16 -define ("TABOOLA_PLUGIN_VERSION","1.0.12");
17 22
18 23
19 24 include_once('widget.php');
20 25 require_once('JavaScriptWrapper.php');
21 26
27 +
22 28 if (!class_exists('TaboolaWP')) {
23 29 class TaboolaWP
24 30 {
25 31 //save internal data
@@ -25,11 +31,28 @@
25 31 //save internal data
26 32 public $data = array();
27 33 public $_is_widget_on_page;
28 34 public $_is_head_script_loaded = false;
35 + private $tpl_sw = 'importScripts("https://cdn.taboola.com/webpush/tsw.js");';
29 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>
42 + <pre><code>{{SW}}</code></pre>
43 + <p>
44 + Also make sure that the file is accessible at {{DOMAIN}}/sw.js
45 + </p>
46 + SWE;
30 47
31 - function __construct()
48 + public $plugin_name;
49 + public $plugin_directory;
50 + public $plugin_url;
51 + public $settings;
52 + public $tbl_taboola_settings;
53 +
54 + public function __construct()
32 55 {
33 56 global $wpdb;
34 57
35 58 //initialize plugin constant
@@ -45,38 +68,54 @@
45 68
46 69 $this->tbl_taboola_settings = $wpdb->prefix . '_taboola_settings';
47 70
48 71 //activation function
49 - register_activation_hook($this->plugin_name, array(&$this, 'activate'));
72 + register_activation_hook($this->plugin_name, array(&$this, 'update_db'));
73 + add_action('admin_init', array(&$this, 'update_db'));
50 74
51 75 // Enable sidebar widgets
52 - if($this->settings != NULL && !empty($this->settings->publisher_id)){
76 + if ($this->settings != NULL && !empty($this->settings->publisher_id)){
53 77 //register Taboola widget
54 78 add_action('widgets_init',
55 - function(){
56 - return register_widget("WP_Widget_Taboola");
79 + function(){
80 + return register_widget("WP_Widget_Taboola");
57 81 }
58 82 );
59 83 }
60 84
61 - $this->should_place_tag_outside_of_content = $this->settings->out_of_content_enabled;
85 + //$this->should_place_tag_outside_of_content = $this->settings->out_of_content_enabled;
62 86
63 87 if (is_admin()) {
64 88 //add menu for plugin
65 89 add_action( 'admin_menu', array(&$this, 'admin_generate_menu') );
66 90 add_filter('plugin_action_links', array(&$this, 'plugin_action_links'), 10, 2 );
67 - } else {
68 - if($this->settings != NULL){
91 + }elseif ($this->settings != NULL){
69 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);
104 + }
105 + $content = $this->tpl_sw . PHP_EOL . $content;
106 + if (file_put_contents($sw_path, $content) === false) {
107 + return $this->notice($this->msg_sw_error);
108 + }
109 + }
110 + }
70 111 add_action('wp_footer', array(&$this, 'taboola_footer_loader_js'));
71 112 add_filter('the_content', array(&$this, 'load_taboola_content'));
72 - }
73 - }
74 - }
113 + add_filter('the_content', array(&$this, 'load_taboola_content_mid'));
114 + add_filter('the_content', array(&$this, 'load_taboola_content_home'));
115 + }
116 + }
75 117
76 -
77 -
78 -
79 118 function plugin_action_links($links, $file) {
80 119 static $this_plugin;
81 120
82 121 if (!$this_plugin) {
@@ -95,8 +134,24 @@
95 134 $retVal = ((trim($this->settings->publisher_id) != '') && is_single() && $this->settings->first_bc_enabled && trim($this->settings->first_bc_widget_id) != '');
96 135 return $retVal;
97 136 }
98 137
138 + private function should_show_content_widget_mid(){
139 + // PC - only if v2 was installed:
140 + if (!$this->is_db_updated_for_min_ver("2.0.0"))
141 + return false;
142 + $retVal1 = ((trim($this->settings->publisher_id) != '') && is_single() && $this->settings->mid_enabled && trim($this->settings->mid_widget_id) != '');
143 + return $retVal1;
144 + }
145 +
146 + private function should_show_content_widget_home(){
147 + // PC - only if v2 was installed:
148 + if (!$this->is_db_updated_for_min_ver("2.0.0"))
149 + return false;
150 + $retVal2 = ((trim($this->settings->publisher_id) != '') && (is_front_page() || is_home()) && $this->settings->home_enabled && trim($this->settings->home_widget_id) != '');
151 + return $retVal2;
152 + }
153 +
99 154 private function should_show_sidebar_widget(){
100 155 $retVal = ((trim($this->settings->publisher_id) != '') && is_active_widget( false, false, TABOOLA_WIDGET_BASE_ID, true ));
101 156 return $retVal;
102 157 }
@@ -102,16 +157,15 @@
102 157 }
103 158
104 159 // Determine if a taboola widget should be added somewhere on the current page (content or sidebar)
105 160 function is_widget_on_page(){
106 - return $this->should_show_content_widget() || $this->should_show_sidebar_widget();
161 + return $this->should_show_content_widget() || $this->should_show_content_widget_mid() || $this->should_show_content_widget_home() || $this->should_show_sidebar_widget();
107 162 }
108 163
109 164 function get_page_type(){
110 -
111 165 $page_type='article';
112 166 if (is_front_page()){
113 - $page_type='home';
167 + $page_type='home';
114 168 }else if (is_category() || is_archive() || is_search()){
115 169 $page_type='category';
116 170 }
117 171 return $page_type;
@@ -122,20 +176,23 @@
122 176 $head_string = "";
123 177
124 178 // Only adding the loader if a widget is going to be placed on the page.
125 179 if ($this->is_widget_on_page()){
126 -
180 + // PC - since these params will be inserted in 'loaderInjectionScript.js' via search and replace,
181 + // double brackets are used to ensure that each key is a unique string.
127 182 $stringParams = array(
128 183 '{{PUBLISHER_ID}}' => $this->settings->publisher_id,
129 184 '{{PAGE_TYPE}}' => $this->get_page_type(),
130 185 '{{WORDPRESS_VERSION}}' => get_bloginfo('version'),
131 - '{{PLUGIN_VERSION}}' => TABOOLA_PLUGIN_VERSION
186 + '{{PHP_VERSION}}' => phpversion(),
187 + '{{PLUGIN_VERSION}}' => TABOOLA_PLUGIN_VERSION,
188 + '{{LOC_MID}}' => $this->settings->mid_location_string,
189 + '{{LOC_HOME}}' => $this->settings->home_location_string
132 190 );
133 191
134 192 $scriptWrapper = new JavaScriptWrapper("loaderInjectionScript.js",$stringParams);
135 - $head_string = $scriptWrapper->getScripMarkupString();
193 + $head_string = $scriptWrapper->getScriptMarkupString();
136 194 }
137 -
138 195 return $head_string;
139 196 }
140 197
141 198
@@ -140,53 +197,96 @@
140 197
141 198
142 199 // This function is used for the hook action, injects the header content to the <head> tag.
143 200 function taboola_header_loader_inject(){
144 -
145 201 echo $this->taboola_header_loader_js();
146 202 }
147 203
204 + // adding webpush loader
205 + function taboola_webpush_loader_js() {
206 + if(is_single() || is_home() || is_category() || is_front_page()){
207 + $stringParamsWeb = array(
208 + '{{PUBLISHER_ID}}' => $this->settings->publisher_id_push
209 + );
210 + $webpushInjectionScript = new JavaScriptWrapper("webPush.js",$stringParamsWeb);
211 + echo $webpushInjectionScript;
212 + }
213 + }
148 214
149 215 function taboola_footer_loader_js() {
150 216
151 217 // Only adding flush script if a widget is going to be placed on the page.
152 - if ( $this->is_widget_on_page() ){
218 + if ($this->is_widget_on_page()){
153 219 $flushInjectionScript = new JavaScriptWrapper('flushInjectionScript.js',array());
154 - echo $flushInjectionScript->getScripMarkupString();
220 + echo $flushInjectionScript->getScriptMarkupString();
155 221 }
156 222 }
157 223
224 + // Below-article widget
158 225 function load_taboola_content($content)
159 226 {
160 227 $taboola_content = array();
161 228 if ($this->should_show_content_widget()){
162 229
163 - $firstWidgetParams = array('{{WIDGET_ID}}' => $this->settings->first_bc_widget_id,
164 - '{{CONTAINER}}' => 'taboola-below-article',
165 - '{{PLACEMENT}}' => 'below-article');
230 + $firstWidgetParams = array(
231 + '{{WIDGET_ID}}' => $this->settings->first_bc_widget_id,
232 + '{{CONTAINER}}' => 'taboola-below-article-thumbnails',
233 + // PC - If v2 was not installed, then use v1 logic
234 + '{{PLACEMENT}}' => (!empty($this->settings->first_bc_placement)) ? $this->settings->first_bc_placement : 'below-article' // In case v1 upgrade has not run yet
235 + );
166 236
167 237 $firstWidgetScript = new JavaScriptWrapper("widgetInjectionScript.js",$firstWidgetParams);
168 - $taboola_content[TABOOLA_CONTENT_FORMAT_HTML][] = "<div id='taboola-below-article'></div>";
238 + $taboola_content[TABOOLA_CONTENT_FORMAT_HTML][] = "<div id='taboola-below-article-thumbnails'></div>";
169 239 $taboola_content[TABOOLA_CONTENT_FORMAT_SCRIPT][] = $firstWidgetScript;
170 240
171 - // Adding the 2nd widget if needed
172 - if($this->settings->second_bc_enabled && trim($this->settings->second_bc_widget_id) != ''){
241 + $content = $this->embed_taboola_content_location($content,$taboola_content);
242 + }
173 243
174 - $secondWidgetParams = array('{{WIDGET_ID}}' => $this->settings->second_bc_widget_id,
175 - '{{CONTAINER}}' => 'taboola-below-article-second',
176 - '{{PLACEMENT}}' => 'below-article-2nd');
244 + return $content;
245 + }
246 +
247 + // Mid-article-widget
248 + function load_taboola_content_mid($content)
249 + {
250 + $taboola_content_mid = array();
251 + if ($this->should_show_content_widget_mid()){
252 +
253 + $secondWidgetParams = array('{{WIDGET_ID}}' => $this->settings->mid_widget_id,
254 + '{{CONTAINER}}' => 'taboola-mid-article-thumbnails',
255 + '{{PLACEMENT}}' => $this->settings->mid_placement);
256 +
177 257 $secondWidgetScript = new JavaScriptWrapper("widgetInjectionScript.js",$secondWidgetParams);
258 + $taboola_content_mid[TABOOLA_CONTENT_FORMAT_HTML][] = "<div id='taboola-mid-article-thumbnails'></div>";
259 + $taboola_content_mid[TABOOLA_CONTENT_FORMAT_SCRIPT][] = $secondWidgetScript;
178 260
179 - $taboola_content[TABOOLA_CONTENT_FORMAT_HTML][] = "<div id='taboola-below-article-second'></div>";
180 - $taboola_content[TABOOLA_CONTENT_FORMAT_SCRIPT][] = $secondWidgetScript;
181 - }
261 + $content = $this->embed_taboola_content_location_mid($content,$taboola_content_mid,trim($this->settings->mid_location_string));
262 + }
182 263
183 - $content = $this->embed_taboola_content_location($content,$taboola_content,trim($this->settings->location_string));
184 - }
264 + return $content;
265 + }
185 266
267 + // Homepage widget
268 + function load_taboola_content_home($content)
269 + {
270 +
271 + $taboola_content_home = array();
272 + if ($this->should_show_content_widget_home()){
273 +
274 + $homeWidgetParams = array('{{WIDGET_ID}}' => $this->settings->home_widget_id,
275 + '{{CONTAINER}}' => 'taboola-homepage-thumbnails',
276 + '{{PLACEMENT}}' => $this->settings->home_placement);
277 +
278 + $homeWidgetScript = new JavaScriptWrapper("widgetInjectionScript.js",$homeWidgetParams);
279 + $taboola_content_home[TABOOLA_CONTENT_FORMAT_HTML][] = "<div id='taboola-homepage-thumbnails'></div>";
280 + $taboola_content_home[TABOOLA_CONTENT_FORMAT_SCRIPT][] = $homeWidgetScript;
281 +
282 + $content = $this->embed_taboola_content_location_home($content,$taboola_content_home,trim($this->settings->home_location_string));
283 + }
186 284 return $content;
285 +
187 286 }
188 287
288 + // Below-article widget
189 289
190 290 // Extract the taboola content in the required format:
191 291 // String - for injecting on the servr side
192 292 // Script or HTML - for injecting on the client side
@@ -209,26 +309,95 @@
209 309 return $ret_val;
210 310 }
211 311
212 312
213 - // Do the actual logic of choosing where to place the taboola content based on the "location" attribute
214 - function embed_taboola_content_location($content, $taboola_content, $location){
313 + // Mid-article widget
314 + function format_taboola_content_mid($taboola_content_mid,$format){
315 + $ret_val = null;
316 +
317 + switch($format){
318 + case TABOOLA_CONTENT_FORMAT_STRING:
319 + $result_string = join("",$taboola_content_mid[TABOOLA_CONTENT_FORMAT_HTML]).
320 + "<script type='text/javascript'>".join("\n",$taboola_content_mid[TABOOLA_CONTENT_FORMAT_SCRIPT])."</script>";
321 + $ret_val = $result_string;
322 + break;
323 +
324 + // script or html
325 + default:
326 + $ret_val = str_replace("\n","",join("",$taboola_content_mid[$format]));
327 + break;
328 + }
329 +
330 + return $ret_val;
331 + }
332 +
333 +
334 + // Homepage widget
335 + function format_taboola_content_home($taboola_content_home,$format){
336 +
337 + $ret_val = null;
338 +
339 + switch($format){
340 + case TABOOLA_CONTENT_FORMAT_STRING:
341 + $result_string = join("",$taboola_content_home[TABOOLA_CONTENT_FORMAT_HTML]).
342 + "<script type='text/javascript'>".join("\n",$taboola_content_home[TABOOLA_CONTENT_FORMAT_SCRIPT])."</script>";
343 + $ret_val = $result_string;
344 + break;
345 +
346 + // script or html
347 + default:
348 + $ret_val = str_replace("\n","",join("",$taboola_content_home[$format]));
349 + break;
350 + }
351 +
352 + return $ret_val;
353 +
354 + }
355 +
356 + // Below-article widget
357 + // Do the actual logic of choosing where to place the taboola content.
358 + function embed_taboola_content_location($content, $taboola_content){
215 359 $do_default = true;
216 360
361 + // tag is placed outside of content in order to allow "read more" functionality.
362 + if ($this->settings->out_of_content_enabled){
363 +
364 + $scriptWrapper = new JavaScriptWrapper("js_inject.min.js",array(
365 + "{{HTML}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_HTML),
366 + "{{SCRIPT}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_SCRIPT))
367 + );
368 + $scriptWrapper->appendScript("injectWidgetByMarker('tbmarker');");
369 + $content = $content."<span id='tbmarker'></span><script type='text/javascript'>".$scriptWrapper."</script>";
370 + $do_default = false;
371 + }
372 +
373 + // Default for below-article widget - add to the end of the content
374 + if ($do_default){
375 + $content = $content.$this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_STRING);
376 + }
377 +
378 + return $content;
379 + }
380 +
381 + // Mid-article widget
382 + // Do the actual logic of choosing where to place the taboola content based on the "location" attribute
383 + function embed_taboola_content_location_mid($content, $taboola_content_mid, $location){
384 + $do_default = true;
385 +
217 386 if (isset($location) && $location != ''){
218 387 $first_char = substr($location,0,1);
219 388
220 389 // DIV/XPATH provided for JS handling
221 - if ($first_char == JS_MARKER){
222 - $full_indicator = substr($location,0,strlen(JS_INDICATOR));
390 + if ($first_char == TABOOLA_JS_MARKER){
391 + $full_indicator = substr($location,0,strlen(TABOOLA_JS_INDICATOR));
223 392
224 - if ($full_indicator == JS_INDICATOR){
393 + if ($full_indicator == TABOOLA_JS_INDICATOR){
225 394
226 - $xpath = substr($location,strlen(JS_INDICATOR));
227 - $scriptWrapper = new JavaScriptWrapper("js_inject.min.js",array(
228 - "{{HTML}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_HTML),
229 - "{{SCRIPT}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_SCRIPT))
230 - );
395 + $xpath = substr($location,strlen(TABOOLA_JS_INDICATOR));
396 + $scriptWrapper = new JavaScriptWrapper("js_inject.min.js",array(
397 + "{{HTML}}" => $this->format_taboola_content_mid($taboola_content_mid,TABOOLA_CONTENT_FORMAT_HTML),
398 + "{{SCRIPT}}" => $this->format_taboola_content_mid($taboola_content_mid,TABOOLA_CONTENT_FORMAT_SCRIPT))
399 + );
231 400 $scriptWrapper->appendScript("injectWidgetByXpath('".$xpath."');");
232 401 $content = $content."<span id='tbdefault'></span><script type='text/javascript'>".$scriptWrapper."</script>";
233 402
234 403 $do_default = false;
@@ -233,51 +402,89 @@
233 402
234 403 $do_default = false;
235 404 }
236 405
237 - // server side selector provided (see simple_html_dom selectors https://simplehtmldom.sourceforge.net/manual.htm)
406 + // server side selector provided (see simple_html_dom selectors http://simplehtmldom.sourceforge.net/manual.htm)
238 407 // basically it's CSS selectors like in jQuery
239 408 } else{
240 -
241 409 require_once('simple_html_dom.php');
242 410
243 411 $html_doc = str_get_html($content);
244 - $target_location = $html_doc->find($location,0);
412 + $target_location = $html_doc->find($location,($this->settings->mid_location_string_occurrence)-1);
245 413
246 414 // if the location was found within the html content
247 415 if (isset($target_location) && is_object($target_location)){
248 416
249 417 // adding taboola content AFTER the target location
250 - $target_location->outertext = $target_location->outertext.$this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_STRING);
418 + $target_location->outertext = $target_location->outertext.$this->format_taboola_content_mid($taboola_content_mid,TABOOLA_CONTENT_FORMAT_STRING);
251 419 $content = $html_doc;
252 420 $do_default = false;
253 421 }
254 422 }
423 + }
424 + // Default for below-article widget - add to the end of the content
425 + // if ($do_default){
426 + // $content = $content.$this->format_taboola_content_mid($taboola_content_mid,TABOOLA_CONTENT_FORMAT_STRING);
427 + // }
255 428
256 - // tag is placed outside of content in order to allow "read more" functionality.
257 - }elseif ($this->should_place_tag_outside_of_content){
429 + return $content;
430 + }
258 431
259 - $scriptWrapper = new JavaScriptWrapper("js_inject.min.js",array(
260 - "{{HTML}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_HTML),
261 - "{{SCRIPT}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_SCRIPT))
262 - );
263 - $scriptWrapper->appendScript("injectWidgetByMarker('tbmarker');");
264 - $content = $content."<span id='tbmarker'></span><script type='text/javascript'>".$scriptWrapper."</script>";
265 - $do_default = false;
266 - }
432 + // Homepage widget
433 + // Do the actual logic of choosing where to place the taboola content based on the "location" attribute
434 + function embed_taboola_content_location_home($content, $taboola_content_home, $location){
267 435
268 - // Default - add to the end of the content
269 - if ($do_default){
270 - $content = $content.$this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_STRING);
271 - }
436 + $do_default = true;
272 437
273 - return $content;
438 + if (isset($location) && $location != ''){
439 + $first_char = substr($location,0,1);
440 +
441 + // DIV/XPATH provided for JS handling
442 + if ($first_char == TABOOLA_JS_MARKER){
443 + $full_indicator = substr($location,0,strlen(TABOOLA_JS_INDICATOR));
444 +
445 + if ($full_indicator == TABOOLA_JS_INDICATOR){
446 +
447 + $xpath = substr($location,strlen(TABOOLA_JS_INDICATOR));
448 + $scriptWrapper = new JavaScriptWrapper("js_inject.min.js",array(
449 + "{{HTML}}" => $this->format_taboola_content_home($taboola_content_home,TABOOLA_CONTENT_FORMAT_HTML),
450 + "{{SCRIPT}}" => $this->format_taboola_content_home($taboola_content_home,TABOOLA_CONTENT_FORMAT_SCRIPT))
451 + );
452 + $scriptWrapper->appendScript("injectWidgetByXpath('".$xpath."');");
453 + $content = $content."<span id='tbdefault'></span><script type='text/javascript'>".$scriptWrapper."</script>";
454 +
455 + $do_default = false;
456 + }
457 +
458 + // server side selector provided (see simple_html_dom selectors http://simplehtmldom.sourceforge.net/manual.htm)
459 + // basically it's CSS selectors like in jQuery
460 + } else{
461 + require_once('simple_html_dom.php');
462 +
463 + $html_doc = str_get_html($content);
464 + $target_location = $html_doc->find($location,($this->settings->home_location_string_occurrence)-1);
465 +
466 + // if the location was found within the html content
467 + if (isset($target_location) && is_object($target_location)){
468 +
469 + // adding taboola content AFTER the target location
470 + $target_location->outertext = $target_location->outertext.$this->format_taboola_content_home($taboola_content_home,TABOOLA_CONTENT_FORMAT_STRING);
471 + $content = $html_doc;
472 + $do_default = false;
473 + }
474 + }
475 + }
476 + // Default for below-article widget - add to the end of the content
477 + // if ($do_default){
478 + // $content = $content.$this->format_taboola_content_home($taboola_content_home,TABOOLA_CONTENT_FORMAT_STRING);
479 + // }
480 + return $content;
481 +
274 482 }
275 483
276 -
277 484 function admin_generate_menu(){
278 485 global $current_user;
279 - add_menu_page('Taboola', 'Taboola', 'manage_options', 'taboola_widget', array(&$this, 'admin_taboola_settings'), $this->plugin_url.'img/taboola_icon.png', 110);
486 + add_menu_page(__('Taboola','taboola_widget'), __('Taboola','taboola_widget'), 'manage_options', 'taboola_widget', array(&$this, 'admin_taboola_settings'), $this->plugin_url.'img/taboola_icon.png', 110);
280 487 }
281 488
282 489 function admin_taboola_settings(){
283 490 global $wpdb;
@@ -284,57 +491,282 @@
284 491 $settings = $wpdb->get_row("select * from ".$wpdb->prefix."_taboola_settings limit 1");
285 492 $taboola_errors = array();
286 493 if($_SERVER['REQUEST_METHOD'] == 'POST'){
287 494
288 - if(trim($_POST['publisher_id']) == ''){
289 - $taboola_errors[] = "Please add a 'Publisher ID' in order to apply changes to your widgets";
495 + if(trim(strip_tags($_POST['publisher_id'])) == ''){
496 + $taboola_errors[] = "Publisher ID";
290 497 }
291 - if((isset($_POST['first_bc_enabled']) && trim($_POST['first_bc_widget_id']) == '') ||
292 - (isset($_POST['second_bc_enabled']) && trim($_POST['second_bc_widget_id']) == '')
293 - ){
294 - $taboola_errors[] = "Please add a 'Widget ID' in order to apply changes to your widgets";
498 +
499 + if(isset($_POST['web_push_enabled'])) {
500 + if (trim(strip_tags($_POST['publisher_id_push'])) == '') {
501 + $taboola_errors[] = "Publisher Push ID";
502 + }
295 503 }
296 - if (trim($_POST['location_string']) != '' && !$this->is_location_string_valid($_POST['location_string'])){
297 - $taboola_errors[] = "Location string not valid, please contact your Taboola account manager to get a valid location string";
504 +
505 + if(isset($_POST['first_bc_enabled'])) {
506 + if (trim(strip_tags($_POST['first_bc_widget_id'])) == '') {
507 + $taboola_errors[] = "Below-article > Widget ID";
508 + }
509 + if (trim(strip_tags($_POST['first_bc_placement'])) == '') {
510 + $taboola_errors[] = "Below-article > Placement Name";
511 + }
298 512 }
513 +
514 + if(isset($_POST['mid_enabled'])) {
515 + if (trim(strip_tags($_POST['mid_widget_id'])) == '') {
516 + $taboola_errors[] = "Mid-article > Widget ID";
517 + }
518 + if (trim(strip_tags($_POST['mid_placement'])) == '') {
519 + $taboola_errors[] = "Mid-article > Placement Name";
520 + }
521 + if (trim(strip_tags($_POST['mid_location_string'])) == '') {
522 + $taboola_errors[] = "Mid-article > CSS selector";
523 + }
524 + else {
525 + // If the 'location' WAS filled in, then...
526 +
527 + // 1) Check for a valid 'location':
528 +
529 + // Validation method has not been implemented
530 + // mid_if (!$this->is_locaton_string_valid1($_POST['mid_location_string'])) {
531 + // $taboola_errors[] = "Mid-article > CSS Selector (invalid value)";
532 + // }
533 +
534 + // 2) Validate the 'occurrence':
535 + if (!$this->is_mid_location_string_occurrence_valid($_POST['mid_location_string_occurrence'])) {
536 + $taboola_errors[] = "Mid-article > Occurance (must be >= 1)";
537 + }
538 + }
539 +
540 + }
541 +
542 + if(isset($_POST['home_enabled'])) {
543 + if (trim(strip_tags($_POST['home_widget_id'])) == '') {
544 + $taboola_errors[] = "Homepage > Widget ID";
545 + }
546 + if (trim(strip_tags($_POST['home_placement'])) == '') {
547 + $taboola_errors[] = "Homepage > Placement Name";
548 + }
549 +
550 + if (trim(strip_tags($_POST['home_location_string'])) == '') {
551 + $taboola_errors[] = "Homepage > CSS selector";
552 + }
553 + else {
554 + // If the 'location' WAS filled in, then...
555 +
556 + // 1) Check for a valid 'location':
557 +
558 + // Validation method has not been implemented
559 + // if (!$this->is_home_location_string_valid($_POST['home_location_string'])) {
560 + // $taboola_errors[] = "Homepage > CSS Selector (invalid value)";
561 + // }
562 +
563 + // 2) Validate the 'occurrence':
564 + if (!empty($_POST['home_location_string']) && !$this->is_home_location_string_occurrence_valid($_POST['home_location_string_occurrence'])) {
565 + $taboola_errors[] = "Homepage > Occurance (must be >= 1)";
566 + }
567 + }
568 + }
569 +
299 570 if(count($taboola_errors) == 0){
300 -
301 571 $data = array(
302 572 "publisher_id" => trim($_POST['publisher_id']),
573 +
574 + "web_push_enabled" => isset($_POST['web_push_enabled']) ? true : false,
575 + "publisher_id_push" => !empty($_POST['publisher_id_push']) ? trim($_POST['publisher_id_push']) : '',
576 +
303 577 "first_bc_enabled" => isset($_POST['first_bc_enabled']) ? true : false,
304 - "first_bc_widget_id" => trim($_POST['first_bc_widget_id']),
305 - "second_bc_enabled" => isset($_POST['second_bc_enabled']) ? true : false,
306 - "second_bc_widget_id" => trim($_POST['second_bc_widget_id']),
307 - "location_string" => trim($_POST['location_string']),
308 - "out_of_content_enabled" => isset($_POST['out_of_content_enabled']) ? true : false
578 + "first_bc_widget_id" => !empty($_POST['first_bc_widget_id']) ? trim($_POST['first_bc_widget_id']) : '',
579 + "first_bc_placement" => !empty($_POST['first_bc_placement']) ? trim($_POST['first_bc_placement']) : '',
580 +
581 + "out_of_content_enabled" => isset($_POST['out_of_content_enabled']) ? true : false,
582 +
583 + "mid_enabled" => isset($_POST['mid_enabled']) ? true : false,
584 + "mid_widget_id" => !empty($_POST['mid_widget_id']) ? trim($_POST['mid_widget_id']) : '',
585 + "mid_placement" => !empty($_POST['mid_placement']) ? trim($_POST['mid_placement']) : '',
586 + "mid_paragraph_ui_mode" => !empty($_POST['mid_paragraph_ui_mode']) ? trim($_POST['mid_paragraph_ui_mode']) : '',
587 +
588 + "mid_location_string_occurrence" => !empty($_POST['mid_location_string_occurrence']) ? $_POST['mid_location_string_occurrence'] : '',
589 + "mid_location_string" => !empty($_POST['mid_location_string']) ? trim($_POST['mid_location_string']) : '',
590 +
591 + "home_enabled" => isset($_POST['home_enabled']) ? true : false,
592 + "home_widget_id" => !empty($_POST['home_widget_id']) ? trim($_POST['home_widget_id']) : '',
593 + "home_placement" => !empty($_POST['home_placement']) ? trim($_POST['home_placement']) : '',
594 +
595 + "home_location_string_occurrence" => !empty($_POST['home_location_string_occurrence']) ? $_POST['home_location_string_occurrence'] : '',
596 + "home_location_string" => !empty($_POST['home_location_string']) ? trim($_POST['home_location_string']) : ''
309 597 );
310 598
311 599 //var_dump($settings);
312 - if($settings == NULL){
313 - $wpdb->insert($this->tbl_taboola_settings, $data, null, null);
314 - } else {
315 - $wpdb->update($this->tbl_taboola_settings, $data, array('id' => $settings->id));
600 +
601 + $is_valid_nonce = false;
602 +
603 + if (isset( $_POST['my_plugin_nonce']) && wp_verify_nonce( $_POST['my_plugin_nonce'], 'my_plugin_update_field_action' ) ) {
604 + $is_valid_nonce = true;
316 605 }
606 +
607 + if ($is_valid_nonce) {
608 + if($settings == NULL){
609 + $wpdb->insert($this->tbl_taboola_settings, $data, null, null);
610 + } else {
611 + $wpdb->update($this->tbl_taboola_settings, $data, array('id' => $settings->id));
612 + }
613 + }
317 614 }
318 615 $settings = $wpdb->get_row("select * from ".$wpdb->prefix."_taboola_settings limit 1");
319 616 }
617 + include_once('settings.php');
618 + }
619 +
620 + function is_mid_location_string_valid($mid_location_string){
621 + // TODO:: validate the location string
622 + return true;
623 + }
320 624
625 + function is_mid_location_string_occurrence_valid($mid_location_string_occurrence){
321 626
322 - include_once('settings.php');
627 + if ((int)$mid_location_string_occurrence >= 1) {
628 + return true;
629 + }
630 + return false;
323 631 }
324 632
325 - function is_location_string_valid($location_string){
633 + function is_home_location_string_valid($home_location_string){
326 634 // TODO:: validate the location string
327 635 return true;
328 636 }
329 - function activate(){
637 +
638 + function is_home_location_string_occurrence_valid($home_location_string_occurrence){
639 +
640 + if ((int)$home_location_string_occurrence >= 1) {
641 + return true;
642 + }
643 + return false;
644 + }
645 +
646 + function columnExists($column_name) {
330 647 global $wpdb;
648 + $table_name = $wpdb->prefix . "_taboola_settings";
649 + tb_write_log("table name : " . $table_name);
650 + tb_write_log("column name : " . $column_name);
331 651
652 + $column_exists = $wpdb->get_var("SHOW COLUMNS FROM $table_name LIKE '$column_name'") !== null;
653 +
654 + if ($column_exists) {
655 + tb_write_log("Yes - column " . $column_name . " DOES exist!"); //PC
656 + return true;
657 + } else {
658 + tb_write_log("No - column " . $column_name . " does NOT exist!"); //PC
659 + return false;
660 + }
661 + }
662 +
663 + function is_upgrade_from_v1() {
664 +
665 + if($this->columnExists("first_bc_widget_id") && !$this->columnExists("first_bc_placement")){
666 + tb_write_log("This IS a v1 upgrade!"); //PC
667 + return true;
668 + }
669 + else {
670 + tb_write_log("This is NOT a v1 upgrade!"); //PC
671 + return false;
672 + }
673 + }
674 +
675 + function is_db_updated_for_min_ver($min_ver) {
676 + /**
677 + * Checks if the DB was *previously* updated for the minimum version specified.
678 + * $min_ver should be passed in a format like this: "2.1.0"
679 + */
680 +
681 + global $wpdb;
682 +
683 + // PC - Temporary patch for v2.1.0
684 +
685 + // START patch ===============================================
686 + // Check if the `_taboola` table exists.
687 + // If not, then return false.
688 +
689 + $table_name = $wpdb->prefix . "_taboola_settings";
690 +
691 + if($wpdb->get_var("SHOW TABLES LIKE '$table_name'") != $table_name) {
692 + tb_write_log("Table NOT FOUND");
693 + return false;
694 + }
695 + else {
696 + tb_write_log("Table EXISTS");
697 + }
698 + // END patch =================================================
699 +
700 + // Check the saved version in wp_options. Default to '1.0.0' if the option is not found.
701 + $saved_version = get_option(TABOOLA_OPTION_NAME, '1.0.0');
702 +
703 + $db_is_up_to_date = version_compare($saved_version, $min_ver, '>=');
704 + //tb_write_log($db_is_up_to_date);
705 + return $db_is_up_to_date;
706 +
707 + }
708 +
709 + function is_db_updated_for_current_ver() {
710 + /**
711 + * DEPRECATED
712 + * Checks if the DB was *previously* updated for the version currently loaded.
713 + */
714 + global $wpdb;
715 +
716 + // Check the saved version in wp_options. Default to '1.0.0' if the option is not found.
717 + $saved_version = get_option(TABOOLA_OPTION_NAME, '1.0.0');
718 +
719 + // Get the currently loaded plugin version.
720 + $plugin_version = $this->get_loaded_plugin_version();
721 +
722 + $db_is_up_to_date = version_compare($saved_version, $plugin_version, '>=');
723 + //tb_write_log($db_is_up_to_date);
724 + return $db_is_up_to_date;
725 +
726 + }
727 +
728 + function get_loaded_plugin_version() {
729 +
730 + $plugin_data = get_plugin_data( __FILE__ ); // Can be invoked from Admin page only
731 + $loaded_plugin_version = $plugin_data['Version'];
732 + return $loaded_plugin_version;
733 +
734 + }
735 +
736 + function save_taboola_version($min_ver) {
737 + /**
738 + * Checks for the saved version in wp_options.
739 + * If not found - adds it. Else - updates it.
740 + */
741 +
742 +
743 + tb_write_log("SAVING NEW MIN VERSION: " . $min_ver); // PC
744 +
745 + $saved_version = get_option(TABOOLA_OPTION_NAME, '');
746 + if ($saved_version == '') {
747 + add_option(TABOOLA_OPTION_NAME, $min_ver);
748 + }
749 + else {
750 + update_option(TABOOLA_OPTION_NAME, $min_ver);
751 + }
752 + }
753 +
754 + function update_db(){
755 +
756 + // If we are up to date, then skip this method...
757 + if ($this->is_db_updated_for_min_ver(TABOOLA_MIN_VER)) {
758 + //tb_write_log("All up to date!");
759 + return;
760 + }
761 +
762 + $this->save_taboola_version(TABOOLA_MIN_VER);
763 +
764 + global $wpdb;
332 765 require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
766 +
333 767
334 - $settings_table = $this->tbl_taboola_settings;
335 -
336 - //check mysql version
768 + // Handling for older MySQL versions
337 769 if (function_exists('mysql_get_server_info') && version_compare(mysql_get_server_info(), '4.1.0', '>=')) {
338 770 if (!empty($wpdb->charset))
339 771 $charset_collate = "DEFAULT CHARACTER SET $wpdb->charset";
340 772 if (!empty($wpdb->collate))
@@ -340,23 +772,45 @@
340 772 if (!empty($wpdb->collate))
341 773 $charset_collate .= " COLLATE $wpdb->collate";
342 774 }
343 775
776 + // Check if this is an upgrade from v1
777 + $is_upgrade_from_v1 = $this->is_upgrade_from_v1();
778 +
779 + // tb_write_log("Is upgrade from v1: " . ($is_upgrade_from_v1 ? 'true' : 'false'));
780 +
781 +
344 782 //settings table structure
345 783 $sql_table_settings = "
346 784 CREATE TABLE `" . $wpdb->prefix . "_taboola_settings` (
347 785 `id` INT NOT NULL AUTO_INCREMENT ,
348 786 `publisher_id` VARCHAR(255) DEFAULT NULL,
787 + `web_push_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
788 + `publisher_id_push` INT(15) DEFAULT NULL,
349 789 `first_bc_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
350 790 `first_bc_widget_id` VARCHAR(255) DEFAULT NULL,
791 + `first_bc_placement` VARCHAR(255) DEFAULT " . ($is_upgrade_from_v1 ? "'below-article'" : "NULL") .",
351 792 `first_bc_custom_css` TEXT DEFAULT NULL,
352 793 `second_bc_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
353 794 `second_bc_widget_id` VARCHAR(255) DEFAULT NULL,
354 795 `second_bc_custom_css` TEXT DEFAULT NULL,
355 796 `location_string` TEXT DEFAULT NULL,
797 + `mid_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
798 + `mid_widget_id` VARCHAR(255) DEFAULT NULL,
799 + `mid_placement` VARCHAR(255) DEFAULT NULL,
356 800 `out_of_content_enabled` TINYINT(1) NOT NULL DEFAULT TRUE,
801 + `mid_location_string` TEXT DEFAULT NULL,
802 + `mid_location_string_occurrence` SMALLINT DEFAULT NULL,
803 + `mid_paragraph_ui_mode` VARCHAR(255) DEFAULT NULL,
804 + `home_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
805 + `home_widget_id` VARCHAR(255) DEFAULT NULL,
806 + `home_placement` VARCHAR(255) DEFAULT NULL,
807 + `home_location_string` TEXT DEFAULT NULL,
808 + `home_location_string_occurrence` SMALLINT DEFAULT NULL,
357 809 PRIMARY KEY (`id`)
358 810 )" . $charset_collate . ";";
811 +
812 + // tb_write_log($sql_table_settings);
359 813
360 814 // create/update the table
361 815 dbDelta($sql_table_settings);
362 816 }
@@ -364,6 +818,52 @@
364 818 }
365 819
366 820 global $taboolaWP;
367 821 $taboolaWP = new TaboolaWP();
822 +
823 +/*
824 +A few utility methods for logging
825 +*/
826 +
827 +// Writes debugging messages to 'logs/debug.log'.
828 +// The exact file location depends on *where* you trigger the function.
829 +// In this script, we trigger the function from the admin dashboard.
830 +// So the log file is located under 'wp-admin/logs'.
831 +function tb_write_log($log_msg)
832 +{
833 + $log_filename = "logs";
834 + if (!file_exists($log_filename))
835 + {
836 + mkdir($log_filename, 0777, true);
837 + }
838 + $log_file_data = $log_filename.'/debug.log';
839 +
840 + // Add date/time
841 + $date = date('Y-m-d H:i:s');
842 + $log_msg_with_date = $date." : ".$log_msg;
843 +
844 + if (TABOOLA_DEBUG_MODE)
845 + file_put_contents($log_file_data, $log_msg_with_date . "\n", FILE_APPEND);
846 +
847 +}
848 +
849 +// Write to console
850 +function tb_console_log( $data ){
851 +
852 + If(wp_get_environment_type() === 'development') {
853 +
854 + echo '<script>';
855 + echo 'console.log('. json_encode( $data ) .')';
856 + echo '</script>';
857 +
858 + }
859 +}
860 +
861 +// Write to webpage and stop
862 +function tb_print_to_page($data) {
863 + If(wp_get_environment_type() === 'development') {
864 + print_r($data);
865 + die;
866 + }
867 +}
368 868
369 869 //