tec3/five-for-the-future
tec3/five-for-the-future
1
0
Fork 0
mirror of https://github.com/WordPress/five-for-the-future.git synced 2025-04-19 01:43:44 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add contributors report, and allow data to be downloaded. (#267)

Browse source 
* Add contributors report, and allow data to be downloaded.
This commit is contained in:
Paul Kevan 2024-07-03 14:03:23 +01:00 committed by GitHub
parent c880f28a63
commit b584bf354e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 141 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

121
plugins/wporg-5ftf/includes/reports.php
View file

@ -17,6 +17,7 @@ defined( 'WPINC' ) || die();
add_action( 'admin_menu', __NAMESPACE__ . '\add_admin_pages' );
add_action( 'admin_enqueue_scripts', __NAMESPACE__ . '\enqueue_assets' );
add_action( 'admin_init', __NAMESPACE__ . '\export_csv' );
add_action( 'admin_init', __NAMESPACE__ . '\export_contributors_csv' );
/**
* Register admin page.
@ -30,6 +31,15 @@ function add_admin_pages() {
'5ftf_company_report',
__NAMESPACE__ . '\render_company_report_page'
);
add_submenu_page(
'edit.php?post_type=5ftf_pledge',
'Contributor Report',
'Contributor Report',
'manage_options',
'5ftf_contributor_report',
__NAMESPACE__ . '\render_contributor_report_page'
);
}
/**
@ -150,6 +160,91 @@ function render_company_report_page() {
set_transient( 'wporg_5ftf_company_report_' . $status, $export_data, 60 );
}
/**
* Render results and download button.
*/
function render_contributor_report_page() {
$status = sanitize_title( $_GET['status'] ?? '' );
$contributor_limit = 1500;
if ( ! in_array( $status, array( 'pending', 'trash', 'publish' ) ) ) {
$status = 'all';
}
$contributors = get_posts( array(
'post_type' => '5ftf_contributor',
'post_status' => $status,
'posts_per_page' => $contributor_limit, // set to avoid unexpected memory overuse.
'orderby' => 'post_title',
'order' => 'ASC',
) );
// Add visible warning on page if we hit the upper limit of the query.
if ( count( $contributors ) === $contributor_limit ) {
echo '<p>WARNING: Contributor limit reached, check the code query.</p>';
}
$all_contributor_data = XProfile\get_all_xprofile_contributors_indexed();
?>
<p>
<b>Total:</b><?php echo count( $contributors ); ?>
<b>Status:</b>
<a href="edit.php?post_type=5ftf_pledge&page=5ftf_contributor_report">All</a>
<a href="edit.php?post_type=5ftf_pledge&page=5ftf_contributor_report&status=pending">Pending</a>
<a href="edit.php?post_type=5ftf_pledge&page=5ftf_contributor_report&status=publish">Publish</a>
<a href="edit.php?post_type=5ftf_pledge&page=5ftf_contributor_report&status=trash">Trash</a>
</p>
<form action="#" method="post">
<input type="hidden" name="wporg-5ftf-contr" value="1">
<input type="hidden" name="status" value="<?php echo esc_attr( $status ); ?>">
<input type="submit" value="Export">
<?php wp_nonce_field( '5ftf_download_contributor_report' ); ?>
</form>
<table id="wporg-5ftf-company-report">
<tr>
<th>User id</th>
<th>Username</th>
<th>Company</th>
<th>Hours</th>
<th>Teams</th>
<th>Full Name</th>
<th>Email</th>
<th>Last login</th>
<th>Status</th>
</tr>
<?php
$export_data = array();
foreach ( $contributors as $c ) {
$pledge_company = get_post( $c->post_parent );
$pledge_company_title = get_the_title( $pledge_company ) ?? 'unattached';
$user_id = get_post_meta( $c->ID, 'wporg_user_id', true );
$xprofile = $all_contributor_data[ $user_id ] ?? [
'team_names' => [],
'hours_per_week' => 0,
];
$xprofile_teams = $xprofile['team_names'] ?? [];
$user = get_user_by( 'ID', $user_id );
$last_login = get_user_meta( $user_id, 'last_logged_in', true );
$teams = str_replace( ' Team', '', implode( ',', $xprofile_teams ) );
echo '<tr>';
echo '<td>' . absint( $user_id ) . '</td>';
echo '<td>' . esc_html( $c->post_title ) . '</td>';
echo '<td>' . esc_html( $pledge_company_title ) . '</td>';
echo '<td>' . esc_html( $xprofile['hours_per_week'] ) . '</td>';
echo '<td>' . esc_html( $teams ) . '</td>';
echo '<td>' . esc_html( $user->display_name ) . '</td>';
echo '<td>' . esc_html( $user->user_email ) . '</td>';
echo '<td>' . esc_html( $last_login ) . '</td>';
echo '<td>' . esc_html( $c->post_status ) . '</td>';
echo '</tr>';
$export_data[] = array( $user_id, $c->post_title, $pledge_company_title, $xprofile['hours_per_week'], $teams, $user->display_name, $user->user_email, $last_login, $c->post_status );
}
echo '</table>';
set_transient( 'wporg_5ftf_contributor_report_' . $status, $export_data, 2 * MINUTE_IN_SECONDS );
}
/**
* CSV export runner, grabs data lazily from a transient.
*/
@ -175,3 +270,29 @@ function export_csv() {
$exporter->emit_file();
}
/**
* Export contributors as a CSV, also from transient.
*/
function export_contributors_csv() {
if (
! isset( $_POST['wporg-5ftf-contr'] ) ||
! current_user_can( 'manage_options' ) ||
! wp_verify_nonce( $_POST['_wpnonce'], '5ftf_download_contributor_report' )
) {
return;
}
$status = $_POST['status'];
$data = get_transient( 'wporg_5ftf_contributor_report_' . $status );
$exporter = new Export_CSV( array(
'filename' => 'contributor-report-' . $status,
'headers' => array( 'User id', 'Username', 'Company', 'Hours', 'Teams', 'Full Name', 'Email', 'Last Login', 'Status' ),
'data' => $data,
) );
$exporter->emit_file();
}

20
plugins/wporg-5ftf/includes/xprofile.php
View file

@ -69,6 +69,26 @@ function get_all_xprofile_contributor_hours_teams(): array {
return $users;
}
/**
*
* Reconfigures xprofile data to be in indexed array.
*
* @return array
*/
function get_all_xprofile_contributors_indexed(): array {
$all_data = get_all_xprofile_contributor_hours_teams();
$newdata = array();
foreach ( $all_data as $contributor ) {
$newdata[ $contributor->user_id ] = [
'hours_per_week' => $contributor->hours_per_week,
'team_names' => $contributor->team_names,
];
}
return $newdata;
}
/**
* Pull relevant data from profiles.wordpress.org.
*