← All changes | taboola_widget.php +159 -33 1.0.1 → 1.0.15 View file →

		@@ -1,14 +1,24 @@
1	1	<?php
2	2	/**
3	3	* Plugin Name: Taboola
4		- * Plugin URI: http://taboola.com
	4	+ * Plugin URI: https://developers.taboola.com/web-integrations/discuss
5	5	* Description: Taboola
6		- * Version: 1.0.1
	6	+ * Version: 1.0.15
7	7	* Author: Taboola
8	8	*/
9	9
	10	+define ("XPATH_MARKER","/");
	11	+define ("JS_INDICATOR","{JS}");
	12	+define ("JS_MARKER","{");
	13	+define ("TABOOLA_CONTENT_FORMAT_STRING",'string');
	14	+define ("TABOOLA_CONTENT_FORMAT_SCRIPT",'script');
	15	+define ("TABOOLA_CONTENT_FORMAT_HTML",'html');
	16	+define ("TABOOLA_PLUGIN_VERSION","1.0.15");
	17	+
	18	+
10	19	include_once('widget.php');
	20	+require_once('JavaScriptWrapper.php');
11	21
12	22	if (!class_exists('TaboolaWP')) {
13	23	class TaboolaWP
14	24	{
		@@ -16,9 +26,10 @@
16	26	public $data = array();
17	27	public $_is_widget_on_page;
18	28	public $_is_head_script_loaded = false;
19	29
20		- function TaboolaWP()
	30	+
	31	+ function __construct()
21	32	{
22	33	global $wpdb;
23	34
24	35	//initialize plugin constant
		@@ -40,12 +51,16 @@
40	51	// Enable sidebar widgets
41	52	if($this->settings != NULL && !empty($this->settings->publisher_id)){
42	53	//register Taboola widget
43	54	add_action('widgets_init',
44		- create_function('', 'return register_widget("WP_Widget_Taboola");')
	55	+ function(){
	56	+ return register_widget("WP_Widget_Taboola");
	57	+ }
45	58	);
46	59	}
47	60
	61	+ //$this->should_place_tag_outside_of_content = $this->settings->out_of_content_enabled;
	62	+
48	63	if (is_admin()) {
49	64	//add menu for plugin
50	65	add_action( 'admin_menu', array(&$this, 'admin_generate_menu') );
51	66	add_filter('plugin_action_links', array(&$this, 'plugin_action_links'), 10, 2 );
		@@ -105,15 +120,22 @@
105	120	// return the head loader script
106	121	function taboola_header_loader_js() {
107	122	$head_string = "";
108	123
109		- // Only adding Script1 if a widget is going to be placed on the page.
	124	+ // Only adding the loader if a widget is going to be placed on the page.
110	125	if ($this->is_widget_on_page()){
111	126
112		- $script1_content = str_replace('{{PUBLISHER_ID}}', $this->settings->publisher_id, file_get_contents($this->plugin_directory.'js/script1.js'));
113		- $script1_content = str_replace('{{PAGE_TYPE}}',$this->get_page_type(),$script1_content);
	127	+ $stringParams = array(
	128	+ '{{PUBLISHER_ID}}' => $this->settings->publisher_id,
	129	+ '{{PAGE_TYPE}}' => $this->get_page_type(),
	130	+ '{{WORDPRESS_VERSION}}' => get_bloginfo('version'),
	131	+ '{{PHP_VERSION}}' => phpversion(),
	132	+ '{{PLUGIN_VERSION}}' => TABOOLA_PLUGIN_VERSION,
	133	+ '{{LOCATION}}' => $this->settings->location_string
	134	+ );
114	135
115		- $head_string = '<script type="text/javascript">'.$script1_content.'</script>';
	136	+ $scriptWrapper = new JavaScriptWrapper("loaderInjectionScript.js",$stringParams);
	137	+ $head_string = $scriptWrapper->getScripMarkupString();
116	138	}
117	139
118	140	return $head_string;
119	141	}
		@@ -127,43 +149,134 @@
127	149
128	150
129	151	function taboola_footer_loader_js() {
130	152
131		- // Only adding Script1 if a widget is going to be placed on the page.
	153	+ // Only adding flush script if a widget is going to be placed on the page.
132	154	if ( $this->is_widget_on_page() ){
133		- $script3_content = file_get_contents($this->plugin_directory.'js/script3.js');
134		- echo '<script type="text/javascript">'.$script3_content.'</script>';
	155	+ $flushInjectionScript = new JavaScriptWrapper('flushInjectionScript.js',array());
	156	+ echo $flushInjectionScript->getScripMarkupString();
135	157	}
136	158	}
137	159
138	160	function load_taboola_content($content)
139	161	{
140		-
	162	+ $taboola_content = array();
141	163	if ($this->should_show_content_widget()){
142	164
143		- $script2_content = str_replace('{{WIDGET_ID}}', $this->settings->first_bc_widget_id, file_get_contents($this->plugin_directory.'js/script2.js'));
144		- $script2_content = str_replace('{{CONTAINER}}', 'taboola-below-article', $script2_content);
145		- $script2_content = str_replace('{{PLACEMENT}}', 'below-article', $script2_content);
	165	+ $firstWidgetParams = array('{{WIDGET_ID}}' => $this->settings->first_bc_widget_id,
	166	+ '{{CONTAINER}}' => 'taboola-below-article',
	167	+ '{{PLACEMENT}}' => 'below-article');
146	168
147		- $content = $content .
148		- '<div id="taboola-below-article"></div>' .
149		- '<script type="text/javascript">'.$script2_content.'</script>';
	169	+ $firstWidgetScript = new JavaScriptWrapper("widgetInjectionScript.js",$firstWidgetParams);
	170	+ $taboola_content[TABOOLA_CONTENT_FORMAT_HTML][] = "<div id='taboola-below-article'></div>";
	171	+ $taboola_content[TABOOLA_CONTENT_FORMAT_SCRIPT][] = $firstWidgetScript;
150	172
151	173	// Adding the 2nd widget if needed
152	174	if($this->settings->second_bc_enabled && trim($this->settings->second_bc_widget_id) != ''){
153		- $script2_content = str_replace('{{WIDGET_ID}}', $this->settings->second_bc_widget_id, file_get_contents($this->plugin_directory.'js/script2.js'));
154		- $script2_content = str_replace('{{CONTAINER}}', 'taboola-below-article-second', $script2_content);
155		- $script2_content = str_replace('{{PLACEMENT}}', 'below-article-2nd', $script2_content);
156	175
157		- $content = $content .
158		- '<div id="taboola-below-article-second"></div>' .
159		- '<script type="text/javascript">'.$script2_content.'</script>';
	176	+ $secondWidgetParams = array('{{WIDGET_ID}}' => $this->settings->second_bc_widget_id,
	177	+ '{{CONTAINER}}' => 'taboola-below-article-second',
	178	+ '{{PLACEMENT}}' => 'below-article-2nd');
	179	+ $secondWidgetScript = new JavaScriptWrapper("widgetInjectionScript.js",$secondWidgetParams);
	180	+
	181	+ $taboola_content[TABOOLA_CONTENT_FORMAT_HTML][] = "<div id='taboola-below-article-second'></div>";
	182	+ $taboola_content[TABOOLA_CONTENT_FORMAT_SCRIPT][] = $secondWidgetScript;
160	183	}
	184	+
	185	+ $content = $this->embed_taboola_content_location($content,$taboola_content,trim($this->settings->location_string));
161	186	}
162	187
163	188	return $content;
164	189	}
165	190
	191	+
	192	+ // Extract the taboola content in the required format:
	193	+ // String - for injecting on the servr side
	194	+ // Script or HTML - for injecting on the client side
	195	+ function format_taboola_content($taboola_content,$format){
	196	+ $ret_val = null;
	197	+
	198	+ switch($format){
	199	+ case TABOOLA_CONTENT_FORMAT_STRING:
	200	+ $result_string = join("",$taboola_content[TABOOLA_CONTENT_FORMAT_HTML]).
	201	+ "<script type='text/javascript'>".join("\n",$taboola_content[TABOOLA_CONTENT_FORMAT_SCRIPT])."</script>";
	202	+ $ret_val = $result_string;
	203	+ break;
	204	+
	205	+ // script or html
	206	+ default:
	207	+ $ret_val = str_replace("\n","",join("",$taboola_content[$format]));
	208	+ break;
	209	+ }
	210	+
	211	+ return $ret_val;
	212	+ }
	213	+
	214	+
	215	+ // Do the actual logic of choosing where to place the taboola content based on the "location" attribute
	216	+ function embed_taboola_content_location($content, $taboola_content, $location){
	217	+ $do_default = true;
	218	+
	219	+ if (isset($location) && $location != ''){
	220	+ $first_char = substr($location,0,1);
	221	+
	222	+ // DIV/XPATH provided for JS handling
	223	+ if ($first_char == JS_MARKER){
	224	+ $full_indicator = substr($location,0,strlen(JS_INDICATOR));
	225	+
	226	+ if ($full_indicator == JS_INDICATOR){
	227	+
	228	+ $xpath = substr($location,strlen(JS_INDICATOR));
	229	+ $scriptWrapper = new JavaScriptWrapper("js_inject.min.js",array(
	230	+ "{{HTML}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_HTML),
	231	+ "{{SCRIPT}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_SCRIPT))
	232	+ );
	233	+ $scriptWrapper->appendScript("injectWidgetByXpath('".$xpath."');");
	234	+ $content = $content."<span id='tbdefault'></span><script type='text/javascript'>".$scriptWrapper."</script>";
	235	+
	236	+ $do_default = false;
	237	+ }
	238	+
	239	+ // server side selector provided (see simple_html_dom selectors https://simplehtmldom.sourceforge.net/manual.htm)
	240	+ // basically it's CSS selectors like in jQuery
	241	+ } else{
	242	+
	243	+ require_once('simple_html_dom.php');
	244	+
	245	+ $html_doc = str_get_html($content);
	246	+ $target_location = $html_doc->find($location,0);
	247	+
	248	+ // if the location was found within the html content
	249	+ if (isset($target_location) && is_object($target_location)){
	250	+
	251	+ // adding taboola content AFTER the target location
	252	+ $target_location->outertext = $target_location->outertext.$this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_STRING);
	253	+ $content = $html_doc;
	254	+ $do_default = false;
	255	+ }
	256	+ }
	257	+
	258	+ // tag is placed outside of content in order to allow "read more" functionality.
	259	+ }elseif ($this->settings->out_of_content_enabled){
	260	+
	261	+ $scriptWrapper = new JavaScriptWrapper("js_inject.min.js",array(
	262	+ "{{HTML}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_HTML),
	263	+ "{{SCRIPT}}" => $this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_SCRIPT))
	264	+ );
	265	+ $scriptWrapper->appendScript("injectWidgetByMarker('tbmarker');");
	266	+ $content = $content."<span id='tbmarker'></span><script type='text/javascript'>".$scriptWrapper."</script>";
	267	+ $do_default = false;
	268	+ }
	269	+
	270	+ // Default - add to the end of the content
	271	+ if ($do_default){
	272	+ $content = $content.$this->format_taboola_content($taboola_content,TABOOLA_CONTENT_FORMAT_STRING);
	273	+ }
	274	+
	275	+ return $content;
	276	+ }
	277	+
	278	+
166	279	function admin_generate_menu(){
167	280	global $current_user;
168	281	add_menu_page('Taboola', 'Taboola', 'manage_options', 'taboola_widget', array(&$this, 'admin_taboola_settings'), $this->plugin_url.'img/taboola_icon.png', 110);
169	282	}
		@@ -176,22 +289,28 @@
176	289
177	290	if(trim($_POST['publisher_id']) == ''){
178	291	$taboola_errors[] = "Please add a 'Publisher ID' in order to apply changes to your widgets";
179	292	}
180		- if(($_POST['first_bc_enabled'] == 'on' && trim($_POST['first_bc_widget_id']) == '') ||
181		- ($_POST['second_bc_enabled'] == 'on' && trim($_POST['second_bc_widget_id']) == '')
	293	+ if((isset($_POST['first_bc_enabled']) && trim($_POST['first_bc_widget_id']) == '') ||
	294	+ (isset($_POST['second_bc_enabled']) && trim($_POST['second_bc_widget_id']) == '')
182	295	){
183	296	$taboola_errors[] = "Please add a 'Widget ID' in order to apply changes to your widgets";
184	297	}
	298	+ if (trim($_POST['location_string']) != '' && !$this->is_location_string_valid($_POST['location_string'])){
	299	+ $taboola_errors[] = "Location string not valid, please contact your Taboola account manager to get a valid location string";
	300	+ }
185	301	if(count($taboola_errors) == 0){
186	302
187	303	$data = array(
188	304	"publisher_id" => trim($_POST['publisher_id']),
189		- "first_bc_enabled" => $_POST['first_bc_enabled'] == 'on' ? true : false,
	305	+ "first_bc_enabled" => isset($_POST['first_bc_enabled']) ? true : false,
190	306	"first_bc_widget_id" => trim($_POST['first_bc_widget_id']),
191		- "second_bc_enabled" => $_POST['second_bc_enabled'] == 'on' ? true : false,
	307	+ "second_bc_enabled" => isset($_POST['second_bc_enabled']) ? true : false,
192	308	"second_bc_widget_id" => trim($_POST['second_bc_widget_id']),
	309	+ "location_string" => trim($_POST['location_string']),
	310	+ "out_of_content_enabled" => isset($_POST['out_of_content_enabled']) ? true : false
193	311	);
	312	+
194	313	//var_dump($settings);
195	314	if($settings == NULL){
196	315	$wpdb->insert($this->tbl_taboola_settings, $data, null, null);
197	316	} else {
		@@ -203,8 +322,13 @@
203	322
204	323
205	324	include_once('settings.php');
206	325	}
	326	+
	327	+ function is_location_string_valid($location_string){
	328	+ // TODO:: validate the location string
	329	+ return true;
	330	+ }
207	331	function activate(){
208	332	global $wpdb;
209	333
210	334	require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
		@@ -211,9 +335,9 @@
211	335
212	336	$settings_table = $this->tbl_taboola_settings;
213	337
214	338	//check mysql version
215		- if (version_compare(mysql_get_server_info(), '4.1.0', '>=')) {
	339	+ if (function_exists('mysql_get_server_info') && version_compare(mysql_get_server_info(), '4.1.0', '>=')) {
216	340	if (!empty($wpdb->charset))
217	341	$charset_collate = "DEFAULT CHARACTER SET $wpdb->charset";
218	342	if (!empty($wpdb->collate))
219	343	$charset_collate .= " COLLATE $wpdb->collate";
		@@ -229,17 +353,19 @@
229	353	`first_bc_custom_css` TEXT DEFAULT NULL,
230	354	`second_bc_enabled` TINYINT(1) NOT NULL DEFAULT FALSE,
231	355	`second_bc_widget_id` VARCHAR(255) DEFAULT NULL,
232	356	`second_bc_custom_css` TEXT DEFAULT NULL,
	357	+ `location_string` TEXT DEFAULT NULL,
	358	+ `out_of_content_enabled` TINYINT(1) NOT NULL DEFAULT TRUE,
233	359	PRIMARY KEY (`id`)
234	360	)" . $charset_collate . ";";
235	361
236		- //check if table exists
237		- if ($wpdb->get_var("show tables like '" . $settings_table . "'") != $settings_table) {
	362	+ // create/update the table
238	363	dbDelta($sql_table_settings);
239		- }
240	364	}
241	365	}
242	366	}
243	367
244	368	global $taboolaWP;
245		-$taboolaWP = new TaboolaWP();
	369	+$taboolaWP = new TaboolaWP();
	370	+
	371	+//