Add monthly active users (#530)

* Add monthly active users for better stats on FediDB

* use more optimized query

thanks @mattwiebe

* use transients, improve logic

---------

Co-authored-by: Matt Wiebe <[email protected]>

Author: pfefferle

includes/functions.php

@@ -5,6 +5,7 @@
 use Activitypub\Http;
 use Activitypub\Activity\Activity;
 use Activitypub\Collection\Followers;
+use Activitypub\Collection\Users;
 
 /**
  * Returns the ActivityPub default JSON-context
@@ -474,3 +475,75 @@ function is_json( $data ) {
 function is_blog_public() {
 	return (bool) apply_filters( 'activitypub_is_blog_public', \get_option( 'blog_public', 1 ) );
 }
+
+/**
+ * Get active users based on a given duration
+ *
+ * @param int $duration The duration to check in month(s)
+ *
+ * @return int The number of active users
+ */
+function get_active_users( $duration = 1 ) {
+
+	$duration = intval( $duration );
+	$transient_key = sprintf( 'monthly_active_users_%d', $duration );
+	$count = get_transient( $transient_key );
+
+	if ( false === $count ) {
+		global $wpdb;
+		$query = "SELECT COUNT( DISTINCT post_author ) FROM {$wpdb->posts} WHERE post_type = 'post' AND post_status = 'publish' AND post_date <= DATE_SUB( NOW(), INTERVAL %d MONTH )";
+		$query = $wpdb->prepare( $query, $duration );
+		$count = $wpdb->get_var( $query ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
+
+		set_transient( $transient_key, $count, DAY_IN_SECONDS );
+	}
+
+	// if 0 authors where active
+	if ( 0 === $count ) {
+		return 0;
+	}
+
+	// if single user mode
+	if ( is_single_user() ) {
+		return 1;
+	}
+
+	// if blog user is disabled
+	if ( is_user_disabled( Users::BLOG_USER_ID ) ) {
+		return $count;
+	}
+
+	// also count blog user
+	return $count + 1;
+}
+
+/**
+ * Get the total number of users
+ *
+ * @return int The total number of users
+ */
+function get_total_users() {
+	// if single user mode
+	if ( is_single_user() ) {
+		return 1;
+	}
+
+	$users = \get_users(
+		array(
+			'capability__in' => array( 'publish_posts' ),
+		)
+	);
+
+	if ( is_array( $users ) ) {
+		$users = count( $users );
+	} else {
+		$users = 1;
+	}
+
+	// if blog user is disabled
+	if ( is_user_disabled( Users::BLOG_USER_ID ) ) {
+		return $users;
+	}
+
+	return $users + 1;
+}

includes/rest/class-nodeinfo.php

@@ -3,6 +3,8 @@
 
 use WP_REST_Response;
 
+use function Activitypub\get_total_users;
+use function Activitypub\get_active_users;
 use function Activitypub\get_rest_url_by_path;
 
 /**
@@ -82,24 +84,14 @@ public static function nodeinfo( $request ) {
 			'version' => \get_bloginfo( 'version' ),
 		);
 
-		$users = \get_users(
-			array(
-				'capability__in' => array( 'publish_posts' ),
-			)
-		);
-
-		if ( is_countable( $users ) ) {
-			$users = count( $users );
-		} else {
-			$users = 1;
-		}
-
 		$posts = \wp_count_posts();
 		$comments = \wp_count_comments();
 
 		$nodeinfo['usage'] = array(
 			'users' => array(
-				'total' => $users,
+				'total'          => get_total_users(),
+				'activeMonth'    => get_active_users( '1 month ago' ),
+				'activeHalfyear' => get_active_users( '6 month ago' ),
 			),
 			'localPosts' => (int) $posts->publish,
 			'localComments' => (int) $comments->approved,
@@ -139,24 +131,14 @@ public static function nodeinfo2( $request ) {
 			'version' => \get_bloginfo( 'version' ),
 		);
 
-		$users = \get_users(
-			array(
-				'capability__in' => array( 'publish_posts' ),
-			)
-		);
-
-		if ( is_countable( $users ) ) {
-			$users = count( $users );
-		} else {
-			$users = 1;
-		}
-
 		$posts = \wp_count_posts();
 		$comments = \wp_count_comments();
 
 		$nodeinfo['usage'] = array(
 			'users' => array(
-				'total' => (int) $users,
+				'total'          => get_total_users(),
+				'activeMonth'    => get_active_users( 1 ),
+				'activeHalfyear' => get_active_users( 6 ),
 			),
 			'localPosts' => (int) $posts->publish,
 			'localComments' => (int) $comments->approved,

integration/class-nodeinfo.php

@@ -1,6 +1,9 @@
 <?php
 namespace Activitypub\Integration;
 
+use function Activitypub\get_total_users;
+use function Activitypub\get_active_users;
+
 /**
  * Compatibility with the NodeInfo plugin
  *
@@ -31,6 +34,12 @@ public static function add_nodeinfo_discovery( $nodeinfo, $version ) {
 			$nodeinfo['protocols']['outbound'][] = 'activitypub';
 		}
 
+		$nodeinfo['usage']['users'] = array(
+			'total'          => get_total_users(),
+			'activeMonth'    => get_active_users( '1 month ago' ),
+			'activeHalfyear' => get_active_users( '6 month ago' ),
+		);
+
 		return $nodeinfo;
 	}
 
@@ -44,6 +53,12 @@ public static function add_nodeinfo_discovery( $nodeinfo, $version ) {
 	public static function add_nodeinfo2_discovery( $nodeinfo ) {
 		$nodeinfo['protocols'][] = 'activitypub';
 
+		$nodeinfo['usage']['users'] = array(
+			'total'          => get_total_users(),
+			'activeMonth'    => get_active_users( '1 month ago' ),
+			'activeHalfyear' => get_active_users( '6 month ago' ),
+		);
+
 		return $nodeinfo;
 	}
 }