Merge pull request #24 from circuscode/develop

Develop

Author: circuscode

readme.md

@@ -54,6 +54,7 @@ Following toot objects are supported.
 
 * Text
 * Images
+* Galleries
 * URLs
 * Hashtags
 * Mentions
@@ -62,7 +63,6 @@ Following toot objects are supported.
 
 Following toot objects are not supported.
 
-* Galleries
 * Audio
 * Video
 * Poll
@@ -131,6 +131,10 @@ TootPress does not modify the existing canonical url handling in WordPress. If y
 
 The length of the cron period in combination with the configuration of caching determines how early a toot will be displayed within the blog. If a toot should be displayed as early as possible, the caching must be deactivated for the page containing the toots. Another possibility is removing the affected page from the cache, if new toots have been loaded. For this, a WordPress Action is fired by the plugin, which then must be processed by your caching plugin.
 
+### How are backlinks to Mastodon displayed?
+
+Backlinks to Mastodon can be activated in the plugin settings. In this case, the Mastodon Logo, which is shown for each toot, will be extended with an link to the original toot on the corresponding Mastodon instance. Recommendation is not activating the backlinks as this could cause an negative impact on SEO rating.
+
 ### Does TootPress support WordPress Multisite?
 
 No. TootPress does not support the WordPress Multisite Feature. The plugin is working on the master-site, but is not working on all other child sites within the wordpress network.
@@ -139,8 +143,7 @@ No. TootPress does not support the WordPress Multisite Feature. The plugin is wo
 
 * Low maturity level
 * Early stage of development
-* Future updates may require a complete reload of the toots. 
-* To avoid data inconsistancy and process errors 
+* Future updates may require a complete reload of the toots
 
 ## Branches
 
@@ -174,6 +177,18 @@ This project is licensed under the GPL3 License.
 
 ## Changelog
 
+### 0.3 "Deadpool"
+
+* April 2024
+* Feature: Support of Gallery Toots
+* Feature: Amount of Toots will be shown in WordPress Dashboard
+* Feature: Option to activate Backlinks to Mastodon
+* Changed: Label of User Interface Section in Plugin Options
+* Bugfix: Plugin CSS will now really be activated
+* Bugfix: Rewrite Rules will be updated after changed settings 
+* Bugfix: Internal Plugin Version will be set corretly
+* Bugfix: CSS Option will be set correctly with Restore of default Settings
+
 ### 0.2.1
 
 * April 2023

readme.txt

@@ -2,8 +2,8 @@
 Contributors: unmus
 Tags: mastodon, toots, microblogging, blog, fediverse
 Requires at least: 6.1
-Tested up to: 6.2
-Stable tag: 0.2.1
+Tested up to: 6.5
+Stable tag: 0.3
 License: GNU General Public License v3 or later
 License URI: https://www.gnu.org/licenses/gpl-3.0.html
 
@@ -60,6 +60,7 @@ Following toot objects are supported.
 
 * Text
 * Images
+* Galleries
 * URLs
 * Hashtags
 * Mentions
@@ -68,7 +69,6 @@ Following toot objects are supported.
 
 Following toot objects are not supported.
 
-* Galleries
 * Audio
 * Video
 * Poll
@@ -132,12 +132,28 @@ TootPress does not modify the existing canonical url handling in WordPress. If y
 
 The length of the cron period in combination with the configuration of caching determines how early a toot will be displayed within the blog. If a toot should be displayed as early as possible, the caching must be deactivated for the page containing the toots. Another possibility is removing the affected page from the cache, if new toots have been loaded. For this, a WordPress Action is fired by the plugin, which then must be processed by your caching plugin.
 
+= How are backlinks to Mastodon displayed? =
+
+Backlinks to Mastodon can be activated in the plugin settings. In this case, the Mastodon Logo, which is shown for each toot, will be extended with an link to the original toot on the corresponding Mastodon instance. Recommendation is not activating the backlinks as this could cause an negative impact on SEO rating.
+
 = Does TootPress support WordPress Multisite? =
 
 No. TootPress does not support the WordPress Multisite Feature. The plugin is working on the master-site, but is not working on all other child sites within the wordpress network.
 
 == Changelog ==
 
+= 0.3 "Deadpool" =
+
+* April 2024
+* Feature: Support of Gallery Toots
+* Feature: Amount of Toots will be shown in WordPress Dashboard
+* Feature: Option to activate Backlinks to Mastodon
+* Changed: Label of User Interface Section in Plugin Options
+* Bugfix: Plugin CSS will now really be activated
+* Bugfix: Rewrite Rules will be updated after changed settings 
+* Bugfix: Internal Plugin Version will be set corretly
+* Bugfix: CSS Option will be set correctly with Restore of default Settings
+
 = 0.2.1 =
 
 * April 2023
@@ -156,5 +172,8 @@ No. TootPress does not support the WordPress Multisite Feature. The plugin is wo
 
 == Upgrade Notice ==
 
+= 0.3 =
+This version brings gallery support and contains major bugfixes.
+
 = 0.2.1 =
 This version includes bugfixing only.

tootpress.php

@@ -3,7 +3,7 @@
 /*
 Plugin Name:  TootPress
 Description:  TootPress copies your Toots from Mastodon to WordPress.
-Version:	  0.2.1
+Version:	  0.3
 Author:       Marco Hitschler
 Author URI:   https://www.unmus.de/
 License:      GPL3
@@ -35,6 +35,7 @@
 require_once('tootpress_loop.php');
 require_once('tootpress_blog.php');
 require_once('tootpress_menu.php');
+require_once('tootpress_widgets.php');
 require_once('tootpress_notification.php');
 require_once('tootpress_get.php');
 require_once('tootpress_set.php');

tootpress_blog.php

@@ -19,10 +19,13 @@
  * @param date Toot Date
  * @param string Toot Content
  * @param int Media Flag
+ * @param string Mastodon Instance
+ * @param string Mastodon Account
+ * @param int Backlink Flag
  * @return string html
  */
 
-function tootpress_paint_toot( $mastodon_id, $date, $content, $media )
+function tootpress_paint_toot( $mastodon_id, $date, $content, $media , $instance, $account, $backlink)
 {
 
 	$toot_html='';
@@ -33,8 +36,8 @@ function tootpress_paint_toot( $mastodon_id, $date, $content, $media )
 	// Toot Start
 	$toot_html.='<div class="tootpress-toot"/>';
 
-	// Toot Symbol
-	$toot_html.='<img class="tootpress-toot-symbol" src="'.esc_url(plugins_url()).'/tootpress/tootpress_toot.png" alt="Toot Symbol" width="35" height="37"/>';
+	// Toot Elephant
+	$toot_html.=tootpress_paint_elephant( $instance, $account, $mastodon_id,$backlink);
 
 	// Toot Date
 	if(tootpress_is_language_german()) {
@@ -71,30 +74,84 @@ function tootpress_paint_toot( $mastodon_id, $date, $content, $media )
 
 function tootpress_paint_image($tootid){
 
-	// Get Image from Database
+	// Get Images from Database
 	$toot_image=array();
 	$toot_image=tootpress_get_media_from_database($tootid);
 	$image_html='';
 
-	// Image Content
-	$image_html.='<div class="toot-image">';
-	$image_html.='<img ';
-	$image_html.='src="';
-	$image_html.=tootpress_get_url_image_directory();
-	$image_html.=$toot_image[0]['attachment_file'];
-	$image_html.='" ';
-	$image_html.='alt="';
-	$image_html.=$toot_image[0]['attachment_description'];
-	//$image_html.='" ';
-	//$image_html.='width="';
-	//$image_html.=$toot_image[0]['attachment_width'];
-	//$image_html.='" ';
-	//$image_html.='height="';
-	//$image_html.=$toot_image[0]['attachment_height'];
-	$image_html.='" />';
-	$image_html.='</div>';
+	// Amount of Images
+	$amount_of_images=sizeof($toot_image);
+
+	for($i=0;$i<$amount_of_images;$i++) {
+
+		// Image Content
+		$image_html.='<div class="toot-image ';
+
+		// Classes
+		if($amount_of_images>1) {
+			// Galleries
+			$image_html.='toot-image-gallery ';
+			$image_html.='toot-image-gallery-'.$amount_of_images.' ';
+			$image_html.='toot-image-'.($i+1);
+		} else {
+			// Single Images
+			$image_html.='toot-image-single ';
+		}
+		
+		$image_html.='">';
+		$image_html.='<img ';
+		$image_html.='src="';
+		$image_html.=tootpress_get_url_image_directory();
+		$image_html.=$toot_image[$i]['attachment_file'];
+		$image_html.='" ';
+		$image_html.='alt="';
+		$image_html.=$toot_image[$i]['attachment_description'];
+		//$image_html.='" ';
+		//$image_html.='width="';
+		//$image_html.=$toot_image[0]['attachment_width'];
+		//$image_html.='" ';
+		//$image_html.='height="';
+		//$image_html.=$toot_image[0]['attachment_height'];
+		$image_html.='" />';
+		$image_html.='</div>';
+
+	}
 
 	return $image_html;
 }
 
+/**
+ * Creates the Elephant
+ * 
+ * @since 0.3
+ * 
+ * @param string Mastodon Instance
+ * @param string Mastodon Account
+ * @param int Mastodon Toot ID
+ * @param int Backlink Option
+ * @return string html
+ */
+
+function tootpress_paint_elephant( $instance, $account, $mastodon_id, $backlink) {
+
+	$elephant_html='';
+	$url='https://'.$instance.'/@'.$account.'/'.$mastodon_id;
+
+	if($backlink) {
+		$elephant_html.='<a href="';
+		$elephant_html.=esc_url($url);
+		$elephant_html.='" class="toot-backlink"/>';
+	}
+
+	// The Elephant
+	$elephant_html.='<img class="tootpress-toot-symbol" src="'.esc_url(plugins_url()).'/tootpress/tootpress_toot.png" alt="Toot Symbol" width="35" height="37"/>';
+
+	if($backlink) {
+		$elephant_html.='</a>';
+	}
+
+	return $elephant_html;
+
+}
+
 ?>

tootpress_database.php

@@ -110,12 +110,13 @@ function tootpress_clear_data() {
 
 function tootpress_restore_factory_settings() {
 
-    update_option('tootpress_plugin_version', "1");
+    update_option('tootpress_plugin_version', "4");
     update_option('tootpress_database_version', "1");
 	update_option('tootpress_active', "1");
     update_option('tootpress_mastodon_instance',"");
     update_option('tootpress_mastodon_oauth_access_token',"");
     update_option('tootpress_mastodon_account_id',"");
+	update_option('tootpress_mastodon_account_name',"");
     update_option('tootpress_mastodon_amount_of_requests',"0");
     update_option('tootpress_latest_toot',"");
     update_option('tootpress_oldest_toot',"");
@@ -127,9 +128,12 @@ function tootpress_restore_factory_settings() {
     update_option('tootpress_page_id', "");
     update_option('tootpress_amount_toots_page',"50");
 	update_option('tootpress_navigation',"standard");
-	update_option('tootpress_css',"1");
+	// CSS Option requires an inverse value (please do not ask why)
+	update_option('tootpress_css',"0");
+	update_option('tootpress_backlink','0');
+	update_option('tootpress_rewrite_update','0');
     update_option('tootpress_developer',"0");
-	
+
 	global $wpdb;
 	$table_name=$wpdb->prefix . 'tootpress_toots';
 	$wpdb->get_var( "DELETE FROM $table_name" );

tootpress_get.php

@@ -49,6 +49,19 @@ function tootpress_get_mastodon_account_id() {
     return $mastodon_account_id;
 }
 
+/**
+ * Get Mastodon Account Name
+ * 
+ * @since 0.3
+ * 
+ * @return string Mastodon Account Name
+ */
+
+ function tootpress_get_mastodon_account_name() {
+    $mastodon_account_name=get_option('tootpress_mastodon_account_name');
+    return $mastodon_account_name;
+}
+
 /**
  * Get latest Toot
  * 
@@ -145,6 +158,22 @@ function tootpress_get_css_option() {
 
 }
 
+/**
+ * Get Backlink Option
+ * 
+ * @since 0.3
+ * 
+ * @return int Backlink Option
+ */
+
+ function tootpress_get_backlink_option() {
+
+	$backlink=get_option('tootpress_backlink');
+
+	return $backlink;
+
+}
+
 /**
  * Get Page Slug of TootPress Page
  * 

tootpress_healthy.php

@@ -121,6 +121,16 @@ function tootpress_healthy_check() {
   	} else {
 		$output.='<span class="mathilda-healtycheck-error">&nbsp;Error:&nbsp;</span> PHP option allow_url_fopen is set to FALSE (0) on the webhosting environment. Please change to TRUE (1).';
   	}
+	$output.='<br/>';
+
+	// Check: Mastodon Account Name received
+	// Required to build the backlinks
+	$mastodon_account_name=tootpress_get_mastodon_account_name();
+	if ($mastodon_account_name) {
+		$output.='Mastodon Account Name has been retrieved: @'.$mastodon_account_name;
+  	} else {
+		$output.='<span class="tootpress-healtycheck-warning">&nbsp;Warning:&nbsp;</span> Mastodon Account Name could not be retrieved.';
+  	}
 	$output.='</p>';
 
 	/* 

tootpress_install.php

@@ -24,12 +24,13 @@ function tootpress_activate () {
 
 	// Initialize Settings
 
-    add_option('tootpress_plugin_version', "1");
+    add_option('tootpress_plugin_version', "4");
     add_option('tootpress_database_version', "1");
 	add_option('tootpress_active', "1");
     add_option('tootpress_mastodon_instance',"");
     add_option('tootpress_mastodon_oauth_access_token',"");
     add_option('tootpress_mastodon_account_id',"");
+    add_option('tootpress_mastodon_account_name',"");
     add_option('tootpress_mastodon_amount_of_requests',"0");
     add_option('tootpress_latest_toot',"");
     add_option('tootpress_oldest_toot',"");
@@ -42,6 +43,8 @@ function tootpress_activate () {
     add_option('tootpress_amount_toots_page',"50");
     add_option('tootpress_navigation',"standard");
     add_option('tootpress_css','1');
+    add_option('tootpress_backlink','0');
+    add_option('tootpress_rewrite_update','0');
     add_option('tootpress_developer',"0");
     }
 
@@ -75,6 +78,7 @@ function tootpress_delete () {
     delete_option('tootpress_mastodon_instance');
     delete_option('tootpress_mastodon_oauth_access_token');
     delete_option('tootpress_mastodon_account_id');
+    delete_option('tootpress_mastodon_account_name');
     delete_option('tootpress_mastodon_amount_of_requests');
     delete_option('tootpress_latest_toot');
     delete_option('tootpress_oldest_toot');
@@ -87,6 +91,8 @@ function tootpress_delete () {
     delete_option('tootpress_amount_toots_page');
     delete_option('tootpress_navigation');
     delete_option('tootpress_css');
+    delete_option('tootpress_backlink');
+    delete_option('tootpress_rewrite_update');
     delete_option('tootpress_developer');
     }