Merge pull request #180 from pfefferle/feature-guidance

add some guidance

Author: pfefferle

.github/workflows/deploy.yml

@@ -10,7 +10,7 @@ jobs:
     steps:
     - uses: actions/checkout@master
     - name: WordPress Plugin Deploy
-      uses: 10up/action-wordpress-plugin-deploy@master
+      uses: 10up/action-wordpress-plugin-deploy@stable
       env:
         SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
         SVN_USERNAME: ${{ secrets.SVN_USERNAME }}

.github/workflows/phpunit.yml

@@ -1,5 +1,5 @@
 name: Unit Testing
-on: 
+on:
     push:
     pull_request:
 jobs:
@@ -15,7 +15,7 @@ jobs:
        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=10s --health-retries=10
     strategy:
       matrix:
-        php-versions: ['5.6', '7.2', '7.3', '7.4', '8.0', '8.1']
+        php-versions: ['5.6', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -24,7 +24,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-versions }}
           coverage: none
-          tools: composer, phpunit-polyfills    
+          tools: composer, phpunit-polyfills
           extensions: mysql
       - name: Install Composer dependencies for PHP
         uses: "ramsey/composer-install@v1"

.github/workflows/update-assets.yml

@@ -10,7 +10,7 @@ jobs:
     steps:
     - uses: actions/checkout@master
     - name: WordPress.org plugin asset/readme update
-      uses: 10up/action-wordpress-plugin-asset-update@master
+      uses: 10up/action-wordpress-plugin-asset-update@stable
       env:
         SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
         SVN_USERNAME: ${{ secrets.SVN_USERNAME }}

.gitignore

@@ -5,5 +5,5 @@ composer.lock
 .DS_Store
 .idea/
 .php_cs.cache
+.vscode/settings.json
 .phpunit.result.cache
-

README.md

@@ -1,5 +1,5 @@
 # ActivityPub #
-**Contributors:** [pfefferle](https://profiles.wordpress.org/pfefferle), [mediaformat](https://profiles.wordpress.org/mediaformat)  
+**Contributors:** [pfefferle](https://profiles.wordpress.org/pfefferle/), [mediaformat](https://profiles.wordpress.org/mediaformat/)  
 **Donate link:** https://notiz.blog/donate/  
 **Tags:** OStatus, fediverse, activitypub, activitystream  
 **Requires at least:** 4.7  

activitypub.php

@@ -22,9 +22,13 @@ function init() {
 	\defined( 'ACTIVITYPUB_HASHTAGS_REGEXP' ) || \define( 'ACTIVITYPUB_HASHTAGS_REGEXP', '(?:(?<=\s)|(?<=<p>)|(?<=<br>)|^)#([A-Za-z0-9_]+)(?:(?=\s|[[:punct:]]|$))' );
 	\defined( 'ACTIVITYPUB_ALLOWED_HTML' ) || \define( 'ACTIVITYPUB_ALLOWED_HTML', '<strong><a><p><ul><ol><li><code><blockquote><pre><img>' );
 	\defined( 'ACTIVITYPUB_CUSTOM_POST_CONTENT' ) || \define( 'ACTIVITYPUB_CUSTOM_POST_CONTENT', "<p><strong>%title%</strong></p>\n\n%content%\n\n<p>%hashtags%</p>\n\n<p>%shortlink%</p>" );
+	\define( 'ACTIVITYPUB_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
+	\define( 'ACTIVITYPUB_PLUGIN_BASENAME', plugin_basename( __FILE__ ) );
+	\define( 'ACTIVITYPUB_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) );
 
 	require_once \dirname( __FILE__ ) . '/includes/table/followers-list.php';
 	require_once \dirname( __FILE__ ) . '/includes/class-signature.php';
+	require_once \dirname( __FILE__ ) . '/includes/class-webfinger.php';
 	require_once \dirname( __FILE__ ) . '/includes/peer/class-followers.php';
 	require_once \dirname( __FILE__ ) . '/includes/functions.php';
 
@@ -107,7 +111,7 @@ function add_rewrite_rules() {
 		\add_rewrite_rule( '^.well-known/webfinger', 'index.php?rest_route=/activitypub/1.0/webfinger', 'top' );
 	}
 
-	if ( ! \class_exists( 'Nodeinfo' ) ) {
+	if ( ! \class_exists( 'Nodeinfo' ) || ! (bool) \get_option( 'blog_public', 1 ) ) {
 		\add_rewrite_rule( '^.well-known/nodeinfo', 'index.php?rest_route=/activitypub/1.0/nodeinfo/discovery', 'top' );
 		\add_rewrite_rule( '^.well-known/x-nodeinfo2', 'index.php?rest_route=/activitypub/1.0/nodeinfo2', 'top' );
 	}

assets/css/activitypub-admin.css

@@ -0,0 +1,140 @@
+.settings_page_activitypub .notice {
+	max-width: 800px;
+	margin: 0 auto;
+}
+
+.activitypub-settings-header {
+	text-align: center;
+	margin: 0 0 1rem;
+	background: #fff;
+	border-bottom: 1px solid #dcdcde;
+}
+
+.activitypub-settings-title-section {
+	display: flex;
+	align-items: center;
+	justify-content: center;
+	clear: both;
+	padding-top: 8px;
+}
+
+.settings_page_activitypub #wpcontent {
+	padding-left: 0;
+}
+
+.activitypub-settings-tabs-wrapper {
+	display: -ms-inline-grid;
+	-ms-grid-columns: 1fr 1fr;
+	vertical-align: top;
+	display: inline-grid;
+	grid-template-columns: 1fr 1fr;
+}
+
+.activitypub-settings-tab.active {
+	box-shadow: inset 0 -3px #3582c4;
+	font-weight: 600;
+}
+
+.activitypub-settings-tab {
+	display: block;
+	text-decoration: none;
+	color: inherit;
+	padding: .5rem 1rem 1rem;
+	margin: 0 1rem;
+	transition: box-shadow .5s ease-in-out;
+}
+
+.wp-header-end {
+	visibility: hidden;
+	margin: -2px 0 0;
+}
+
+summary {
+	cursor: pointer;
+	text-decoration: underline;
+	color: #2271b1;
+}
+
+.activitypub-settings-accordion {
+	border: 1px solid #c3c4c7;
+}
+
+.activitypub-settings-accordion-heading {
+	margin: 0;
+	border-top: 1px solid #c3c4c7;
+	font-size: inherit;
+	line-height: inherit;
+	font-weight: 600;
+	color: inherit;
+}
+
+.activitypub-settings-accordion-heading:first-child {
+	border-top: none;
+}
+
+.activitypub-settings-accordion-panel {
+	margin: 0;
+	padding: 1em 1.5em;
+	background: #fff;
+}
+
+.activitypub-settings-accordion-trigger {
+	background: #fff;
+	border: 0;
+	color: #2c3338;
+	cursor: pointer;
+	display: flex;
+	font-weight: 400;
+	margin: 0;
+	padding: 1em 3.5em 1em 1.5em;
+	min-height: 46px;
+	position: relative;
+	text-align: left;
+	width: 100%;
+	align-items: center;
+	justify-content: space-between;
+	-webkit-user-select: auto;
+	user-select: auto;
+}
+
+.activitypub-settings-accordion-trigger {
+	color: #2c3338;
+	cursor: pointer;
+	font-weight: 400;
+	text-align: left;
+}
+
+.activitypub-settings-accordion-trigger .title {
+	pointer-events: none;
+	font-weight: 600;
+	flex-grow: 1;
+}
+
+.activitypub-settings-accordion-trigger .icon, .activitypub-settings-accordion-viewed .icon {
+	border: solid #50575e medium;
+	border-width: 0 2px 2px 0;
+	height: .5rem;
+	pointer-events: none;
+	position: absolute;
+	right: 1.5em;
+	top: 50%;
+	transform: translateY(-70%) rotate(45deg);
+	width: .5rem;
+}
+
+.activitypub-settings-accordion-trigger[aria-expanded="true"] .icon {
+	transform: translateY(-30%) rotate(-135deg);
+}
+
+.activitypub-settings-accordion-trigger:active, .activitypub-settings-accordion-trigger:hover {
+	background: #f6f7f7;
+}
+
+.activitypub-settings-accordion-trigger:focus {
+	color: #1d2327;
+	border: none;
+	box-shadow: none;
+	outline-offset: -1px;
+	outline: 2px solid #2271b1;
+	background-color: #f6f7f7;
+}

assets/js/activitypub-admin.js

@@ -0,0 +1,20 @@
+jQuery( function( $ ) {
+	// Accordion handling in various areas.
+	$( '.activitypub-settings-accordion' ).on( 'click', '.activitypub-settings-accordion-trigger', function() {
+		var isExpanded = ( 'true' === $( this ).attr( 'aria-expanded' ) );
+
+		if ( isExpanded ) {
+			$( this ).attr( 'aria-expanded', 'false' );
+			$( '#' + $( this ).attr( 'aria-controls' ) ).attr( 'hidden', true );
+		} else {
+			$( this ).attr( 'aria-expanded', 'true' );
+			$( '#' + $( this ).attr( 'aria-controls' ) ).attr( 'hidden', false );
+		}
+	} );
+	
+	$(document).on( 'wp-plugin-install-success', function( event, response ) {
+		setTimeout( function() {
+			$( '.activate-now' ).removeClass( 'thickbox open-plugin-details-modal' );
+		}, 1200 );
+	} );	
+} );

includes/class-admin.php

@@ -14,14 +14,15 @@ public static function init() {
 		\add_action( 'admin_menu', array( '\Activitypub\Admin', 'admin_menu' ) );
 		\add_action( 'admin_init', array( '\Activitypub\Admin', 'register_settings' ) );
 		\add_action( 'show_user_profile', array( '\Activitypub\Admin', 'add_fediverse_profile' ) );
+		\add_action( 'admin_enqueue_scripts', array( '\Activitypub\Admin', 'enqueue_scripts' ) );
 	}
 
 	/**
 	 * Add admin menu entry
 	 */
 	public static function admin_menu() {
 		$settings_page = \add_options_page(
-			'ActivityPub',
+			'Welcome',
 			'ActivityPub',
 			'manage_options',
 			'activitypub',
@@ -39,7 +40,27 @@ public static function admin_menu() {
 	 * Load settings page
 	 */
 	public static function settings_page() {
-		\load_template( \dirname( __FILE__ ) . '/../templates/settings.php' );
+		// phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( empty( $_GET['tab'] ) ) {
+			$tab = 'welcome';
+		} else {
+			// phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			$tab = sanitize_key( $_GET['tab'] );
+		}
+
+		switch ( $tab ) {
+			case 'settings':
+				\load_template( \dirname( __FILE__ ) . '/../templates/settings.php' );
+				break;
+			case 'welcome':
+			default:
+				wp_enqueue_script( 'plugin-install' );
+				add_thickbox();
+				wp_enqueue_script( 'updates' );
+
+				\load_template( \dirname( __FILE__ ) . '/../templates/welcome.php' );
+				break;
+		}
 	}
 
 	/**
@@ -122,23 +143,7 @@ public static function register_settings() {
 	}
 
 	public static function add_settings_help_tab() {
-		\get_current_screen()->add_help_tab(
-			array(
-				'id'      => 'overview',
-				'title'   => \__( 'Overview', 'activitypub' ),
-				'content' =>
-					'<p>' . \__( 'ActivityPub is a decentralized social networking protocol based on the ActivityStreams 2.0 data format. ActivityPub is an official W3C recommended standard published by the W3C Social Web Working Group. It provides a client to server API for creating, updating and deleting content, as well as a federated server to server API for delivering notifications and subscribing to content.', 'activitypub' ) . '</p>',
-			)
-		);
-
-		\get_current_screen()->set_help_sidebar(
-			'<p><strong>' . \__( 'For more information:', 'activitypub' ) . '</strong></p>' .
-			'<p>' . \__( '<a href="https://activitypub.rocks/">Test Suite</a>', 'activitypub' ) . '</p>' .
-			'<p>' . \__( '<a href="https://www.w3.org/TR/activitypub/">W3C Spec</a>', 'activitypub' ) . '</p>' .
-			'<p>' . \__( '<a href="https://github.com/pfefferle/wordpress-activitypub/issues">Give us feedback</a>', 'activitypub' ) . '</p>' .
-			'<hr />' .
-			'<p>' . \__( '<a href="https://notiz.blog/donate">Donate</a>', 'activitypub' ) . '</p>'
-		);
+		require_once \dirname( __FILE__ ) . '/help.php';
 	}
 
 	public static function add_followers_list_help_tab() {
@@ -147,8 +152,15 @@ public static function add_followers_list_help_tab() {
 
 	public static function add_fediverse_profile( $user ) {
 		?>
-		<h2><?php \esc_html_e( 'Fediverse', 'activitypub' ); ?></h2>
+		<h2 id="activitypub"><?php \esc_html_e( 'ActivityPub', 'activitypub' ); ?></h2>
 		<?php
 		\Activitypub\get_identifier_settings( $user->ID );
 	}
+
+	public static function enqueue_scripts( $hook_suffix ) {
+		if ( false !== strpos( $hook_suffix, 'activitypub' ) ) {
+			wp_enqueue_style( 'activitypub-admin-styles', plugins_url( 'assets/css/activitypub-admin.css', ACTIVITYPUB_PLUGIN_FILE ), array(), '1.0.0' );
+			wp_enqueue_script( 'activitypub-admin-styles', plugins_url( 'assets/js/activitypub-admin.js', ACTIVITYPUB_PLUGIN_FILE ), array( 'jquery' ), '1.0.0', false );
+		}
+	}
 }

includes/class-debug.php

@@ -17,13 +17,16 @@ public static function init() {
 	}
 
 	public static function log_remote_post_responses( $response, $url, $body, $user_id ) {
+		// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log, WordPress.PHP.DevelopmentFunctions.error_log_print_r
 		\error_log( "Request to: {$url} with response: " . \print_r( $response, true ) );
 	}
 
 	public static function write_log( $log ) {
 		if ( \is_array( $log ) || \is_object( $log ) ) {
+			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log, WordPress.PHP.DevelopmentFunctions.error_log_print_r
 			\error_log( \print_r( $log, true ) );
 		} else {
+			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
 			\error_log( $log );
 		}
 	}