Changeset 7588

Timestamp:

08/02/2018 07:12:19 PM (6 years ago)

Author:

coreymckrill

Message:

WordCamp Reports: Updates to WordCamp Status and WordCamp Details reports

• Simplify the Details report, making all criteria optional, and adding a parameter so specific WordCamp IDs can be submitted.
• Rework the UI of the Status report so that it utilizes the Details report for exporting data about WordCamps that appear in the results.

Location:

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports

Files:

• assets/js/wordcamp-status.js (modified) (1 diff)
• classes/report/class-wordcamp-details.php (modified) (29 diffs)
• classes/report/class-wordcamp-status.php (modified) (19 diffs)
• includes/validation.php (modified) (3 diffs)
• index.php (modified) (1 diff)
• views/html/wordcamp-status.php (modified) (7 diffs)
• views/public/wordcamp-status.php (modified) (2 diffs)
• views/report/wordcamp-details.php (modified) (2 diffs)
• views/report/wordcamp-status.php (modified) (4 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/assets/js/wordcamp-status.js

@@ -18 +18 @@
             };
 
+            this.setupFieldsToggle();
             this.setupSingleToggles();
             this.setupBulkToggles();
 
+            $( '#status' ).select2();
+
             $( document ).ready( function() {
                 self.cache.$hideAll.trigger( 'click' );
+            } );
+        },
+
+        setupFieldsToggle: function() {
+            var self = this;
+
+            self.cache.$fieldsToggle = $( '#fields-toggle' );
+            self.cache.$fieldsContainer = $( '#fields-section' );
+
+            self.cache.$fieldsToggle.on( 'click', function( event ) {
+                event.preventDefault();
+
+                if ( self.cache.$fieldsContainer.hasClass( 'hidden' ) ) {
+                    self.cache.$fieldsContainer.removeClass( 'hidden' );
+                } else {
+                    self.cache.$fieldsContainer.addClass( 'hidden' );
+                }
             } );
         },

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/classes/report/class-wordcamp-details.php

@@ -9 +9 @@
 use Exception;
 use DateTime;
-use WP_Post, WP_Query;
+use WP_Post, WP_Query, WP_Error;
 use function WordCamp\Reports\{get_assets_url, get_assets_dir_path, get_views_dir_path};
 use WordCamp\Reports\Utility\Date_Range;
-use function WordCamp\Reports\Validation\{validate_date_range, validate_wordcamp_id, validate_wordcamp_status};
+use function WordCamp\Reports\Validation\{validate_date_range, validate_wordcamp_id};
 use WordCamp_Admin, WordCamp_Loader;
 use WordCamp\Utilities\Export_CSV;
@@ -21 +21 @@
  * A report class for exporting a spreadsheet of WordCamps.
  *
+ * Note that this report does not use caching because it is only used in WP Admin and has a large number of
+ * optional parameters.
+ *
  * @package WordCamp\Reports\Report
  */
@@ -43 +46 @@
      * @var string
      */
-    public static $description = 'Details about WordCamps occurring within a specified date range.';
+    public static $description = 'Create a spreadsheet of details about WordCamps that match optional criteria.';
 
     /**
@@ -52 +55 @@
     public static $methodology = "
         <ol>
-            <li>Retrieve WordCamp posts that fit within the date range and other optional criteria.</li>
+            <li>Retrieve WordCamp posts that fit within the criteria.</li>
             <li>Extract the data for each post that match the fields requested.</li>
-            <li>Walk all of the extracted data and format it for display.</li>
+            <li>Walk through all of the extracted data and format it for display.</li>
         </ol>
     ";
@@ -66 +69 @@
 
     /**
-     * The date range that defines the scope of the report data.
+     * A date range that WordCamp events must fall within.
      *
      * @var null|Date_Range
@@ -73 +76 @@
 
     /**
-     * The status to filter for in the report.
-     *
-     * @var string
-     */
-    public $status = '';
-
-    /**
-     * Whether to include data for WordCamps that don't have a date set.
+     * A list of WordCamp post IDs.
+     *
+     * @var array
+     */
+    public $wordcamp_ids = [];
+
+    /**
+     * Whether to include counts of various post types for each WordCamp.
      *
      * @var bool
      */
-    public $include_dateless = false;
-
-    /**
-     * Whether to include counts of various post types for each WordCamp.
-     *
-     * @var bool
-     */
     public $include_counts = false;
 
@@ -110 +106 @@
      * WordCamp_Details constructor.
      *
-     * @param string $start_date       The start of the date range for the report.
-     * @param string $end_date         The end of the date range for the report.
-     * @param string $status           Optional. The status ID to filter for in the report.
-     * @param bool   $include_dateless Optional. True to include data for WordCamps that don't have a date set. Default false.
-     * @param bool   $include_counts   Optional. True to include counts of various post types for each WordCamp. Default false.
-     * @param array  $options          {
+     * @param Date_Range $date_range       Optional. A date range that WordCamp events must fall within.
+     * @param array      $wordcamp_ids     Optional. A list of WordCamp post IDs to include in the results.
+     * @param bool       $include_counts   Optional. True to include counts of various post types for each WordCamp.
+     *                                     Default false.
+     * @param array      $options          {
      *     Optional. Additional report parameters.
      *     See Base::__construct and the functions in WordCamp\Reports\Validation for additional parameters.
@@ -123 +118 @@
      * }
      */
-    public function __construct( $start_date, $end_date, $status = '', $include_dateless = false, $include_counts = false, array $options = [] ) {
+    public function __construct( Date_Range $date_range = null, array $wordcamp_ids = [], $include_counts = false, array $options = [] ) {
         // Report-specific options.
         $options = wp_parse_args( $options, [
-            'status_subset' => [],
-            'fields'        => [],
+            'fields' => [],
         ] );
 
         parent::__construct( $options );
 
-        try {
-            $this->range = validate_date_range( $start_date, $end_date, $options );
-        } catch ( Exception $e ) {
-            $this->error->add(
-                self::$slug . '-date-error',
-                $e->getMessage()
-            );
-        }
-
-        if ( $status && 'any' !== $status ) {
-            try {
-                $this->status = validate_wordcamp_status( $status, $options );
-            } catch ( Exception $e ) {
-                $this->error->add(
-                    self::$slug . '-status-error',
-                    $e->getMessage()
-                );
-            }
-        }
-
-        $this->include_dateless = wp_validate_boolean( $include_dateless );
-        $this->include_counts   = wp_validate_boolean( $include_counts );
+        if ( $date_range instanceof Date_Range ) {
+            $this->range = $date_range;
+        }
+
+        if ( ! empty( $wordcamp_ids ) ) {
+            foreach ( $wordcamp_ids as $wordcamp_id ) {
+                try {
+                    $this->wordcamp_ids[] = validate_wordcamp_id( $wordcamp_id, [ 'require_site' => false ] )->post_id;
+                } catch ( Exception $e ) {
+                    $this->error->add(
+                        self::$slug . '-wordcamp-id-error',
+                        $e->getMessage()
+                    );
+
+                    break;
+                }
+            }
+        }
+
+        $this->include_counts = wp_validate_boolean( $include_counts );
 
         $public_data_field_keys = array_merge(
             [
                 'Name',
-                'Status',
             ],
             WordCamp_Loader::get_public_meta_keys()
@@ -167 +158 @@
             [
                 'ID',
+                'Created',
+                'Status',
                 'Tickets',
                 'Speakers',
@@ -211 +204 @@
 
     /**
-     * Generate a cache key.
-     *
-     * @return string
-     */
-    protected function get_cache_key() {
-        $cache_key_segments = [
-            parent::get_cache_key(),
-            $this->range->generate_cache_key_segment(),
-        ];
-
-        if ( $this->status ) {
-            $cache_key_segments[] = $this->status;
-        }
-
-        if ( $this->include_dateless ) {
-            $cache_key_segments[] = '+dateless';
-        }
-
-        if ( $this->include_counts ) {
-            $cache_key_segments[] = '+counts';
-        }
-
-        return implode( '_', $cache_key_segments );
-    }
-
-    /**
-     * Generate a cache expiration interval.
-     *
-     * @return int A time interval in seconds.
-     */
-    protected function get_cache_expiration() {
-        return $this->range->generate_cache_duration( parent::get_cache_expiration() );
-    }
-
-    /**
      * Query and parse the data for the report.
      *
@@ -254 +212 @@
         if ( ! empty( $this->error->get_error_messages() ) ) {
             return array();
-        }
-
-        // Maybe use cached data.
-        $data = $this->maybe_get_cached_data();
-        if ( is_array( $data ) ) {
-            return $data;
         }
 
@@ -277 +229 @@
             $row = array_intersect_key( array_replace( $field_order, $row ), $row );
         } );
-
-        $this->maybe_cache_data( $data );
 
         return $data;
@@ -312 +262 @@
             array_keys( $wordcamp_admin->meta_keys( 'wordcamp' ) ),
             [
+                'Created',
                 'Status',
                 'Tickets',
@@ -339 +290 @@
      * @return array
      */
-    protected function prepare_data_for_display( array $data ) {
+    public function prepare_data_for_display( array $data ) {
         $all_statuses = WordCamp_Loader::get_post_statuses();
 
@@ -381 +332 @@
 
     /**
-     * Get all current WordCamp posts.
-     *
-     * @return array
+     * Get WordCamp posts that fit the report criteria.
+     *
+     * @return array An array of WP_Post objects.
      */
     protected function get_wordcamp_posts() {
@@ -393 +344 @@
             'no_found_rows'       => false,
             'ignore_sticky_posts' => true,
-            'orderby'             => 'meta_value_num title',
+            'orderby'             => 'id',
             'order'               => 'ASC',
-            'meta_query'          => [
+        );
+
+        if ( $this->range instanceof Date_Range ) {
+            // This replaces the default meta query.
+            $post_args['meta_query'] = [
                 [
                     'key'      => 'Start Date (YYYY-mm-dd)',
@@ -402 +357 @@
                     'type'     => 'NUMERIC',
                 ],
-            ],
-        );
-
-        if ( $this->include_dateless ) {
-            $post_args['meta_query'] = array_merge( $post_args['meta_query'], [
-                'relation' => 'OR',
-                [
-                    'key'     => 'Start Date (YYYY-mm-dd)',
-                    'compare' => 'NOT EXISTS',
-                ],
-                [
-                    'key'     => 'Start Date (YYYY-mm-dd)',
-                    'compare' => '=',
-                    'value'   => '',
-                ],
-            ] );
-
-            // Don't include really old camps with no date or ones that didn't exist during the date range.
-            $post_args['date_query'] = [
-                [
-                    'before' => $this->range->end->format( 'Y-m-d' ),
-                    'after'  => $this->range->start->format( 'Y-m-d' ) . ' - 1 year',
-                ],
             ];
+            $post_args['orderby'] = 'meta_value_num title';
+        }
+
+        if ( ! empty( $this->wordcamp_ids ) ) {
+            $post_args['post__in'] = $this->wordcamp_ids;
         }
 
@@ -432 +369 @@
         }
 
-        if ( $this->status ) {
-            $status_report = new WordCamp_Status(
-                $this->range->start->format( 'Y-m-d' ),
-                $this->range->end->format( 'Y-m-d' ),
-                $this->status,
-                $this->options
-            );
-
-            $post_ids = array_keys( $status_report->get_data() );
-
-            if ( empty( $post_ids ) ) {
-                return [];
-            }
-
-            $post_args['post__in'] = $post_ids;
-        }
-
         return get_posts( $post_args );
     }
@@ -463 +383 @@
 
         $row = [
-            'ID'     => $wordcamp->ID,
-            'Name'   => $wordcamp->post_title,
-            'Status' => $wordcamp->post_status,
+            'ID'      => $wordcamp->ID,
+            'Name'    => $wordcamp->post_title,
+            'Created' => get_the_date( 'Y-m-d', $wordcamp->ID ),
+            'Status'  => $wordcamp->post_status,
         ];
 
@@ -502 +423 @@
      * Count the number of various post types for a WordCamp.
      *
+     * If the WordCamp doesn't have a site yet, the counts will all be zero.
+     *
      * @param WP_Post $wordcamp
      *
@@ -515 +438 @@
 
         try {
-            $ids = validate_wordcamp_id( $wordcamp->ID, [ 'require_site' => true ] );
+            $id = validate_wordcamp_id( $wordcamp->ID, [ 'require_site' => false ] );
         } catch ( Exception $e ) {
+            return $counts;
+        }
+
+        if ( ! $id->site_id ) {
             return $counts;
         }
@@ -530 +457 @@
         };
 
-        switch_to_blog( $ids['site_id'] );
+        switch_to_blog( $id->site_id );
 
         // Tickets
@@ -549 +476 @@
 
     /**
+     * Render HTML form inputs for the fields that are available for inclusion in the spreadsheet.
+     *
+     * @param string $context        'public' or 'private'. Default 'public'.
+     * @param array  $field_defaults Optional. An associative array where the keys are field keys and the values
+     *                               are extra attributes for those field inputs. Examples: checked or required.
+     */
+    public static function render_available_fields( $context = 'public', array $field_defaults = [] ) {
+        $field_order      = array_fill_keys( self::get_field_order(), '' );
+        $field_defaults   = array_replace( $field_order, $field_defaults );
+
+        $shadow_report = new self( null, [], false, [ 'public' => ( 'private' === $context ) ? false : true ] );
+
+        $available_fields = array_intersect_key( $field_defaults, $shadow_report->get_data_fields_safelist() );
+        ?>
+        <fieldset class="fields-container">
+            <legend class="fields-label">Available Fields</legend>
+
+            <?php foreach ( $available_fields as $field_name => $extra_props ) : ?>
+                <div class="field-checkbox">
+                    <input
+                        type="checkbox"
+                        id="fields-<?php echo esc_attr( $field_name ); ?>"
+                        name="fields[]"
+                        value="<?php echo esc_attr( $field_name ); ?>"
+                        <?php if ( $extra_props && is_string( $extra_props ) ) echo esc_html( $extra_props ); ?>
+                    />
+                    <label for="fields-<?php echo esc_attr( $field_name ); ?>">
+                        <?php echo esc_attr( $field_name ); ?>
+                    </label>
+                </div>
+            <?php endforeach; ?>
+        </fieldset>
+        <?php
+    }
+
+    /**
      * Register all assets used by this report.
      *
      * @return void
      */
-    protected static function register_assets() {
+    public static function register_assets() {
         wp_register_script(
             self::$slug,
@@ -589 +552 @@
      */
     public static function render_admin_page() {
-        $start_date       = filter_input( INPUT_POST, 'start-date' );
-        $end_date         = filter_input( INPUT_POST, 'end-date' );
-        $include_dateless = filter_input( INPUT_POST, 'include_dateless', FILTER_VALIDATE_BOOLEAN );
-        $status           = filter_input( INPUT_POST, 'status' );
-        $refresh          = filter_input( INPUT_POST, 'refresh', FILTER_VALIDATE_BOOLEAN );
-        $action           = filter_input( INPUT_POST, 'action' );
-        $nonce            = filter_input( INPUT_POST, self::$slug . '-nonce' );
-        $statuses         = WordCamp_Loader::get_post_statuses();
-
-        $field_order      = array_fill_keys( self::get_field_order(), '' );
-        $field_defaults   = array_replace( $field_order, [
+        $field_defaults = [
             'ID'                      => 'checked',
             'Name'                    => 'checked disabled',
@@ -606 +559 @@
             'Location'                => 'checked',
             'URL'                     => 'checked',
-        ] );
-
-        $shadow_report    = new self( '', '', '', false, false, [ 'public' => false ] );
-        $available_fields = array_intersect_key( $field_defaults, $shadow_report->get_data_fields_safelist() );
+        ];
 
         include get_views_dir_path() . 'report/wordcamp-details.php';
@@ -622 +572 @@
         $start_date       = filter_input( INPUT_POST, 'start-date' );
         $end_date         = filter_input( INPUT_POST, 'end-date' );
-        $include_dateless = filter_input( INPUT_POST, 'include_dateless', FILTER_VALIDATE_BOOLEAN );
-        $status           = filter_input( INPUT_POST, 'status' );
         $fields           = filter_input( INPUT_POST, 'fields', FILTER_SANITIZE_STRING, [ 'flags' => FILTER_REQUIRE_ARRAY ] );
-        $refresh          = filter_input( INPUT_POST, 'refresh', FILTER_VALIDATE_BOOLEAN );
         $action           = filter_input( INPUT_POST, 'action' );
         $nonce            = filter_input( INPUT_POST, self::$slug . '-nonce' );
@@ -636 +583 @@
 
         if ( wp_verify_nonce( $nonce, 'run-report' ) && current_user_can( 'manage_network' ) ) {
+            $error = null;
+            $range = null;
+
+            if ( $start_date || $end_date ) {
+                try {
+                    $range = validate_date_range( $start_date, $end_date, [
+                        'allow_future_start' => true,
+                        'earliest_start'     => new DateTime( '2006-01-01' ), // No WordCamp posts before 2006.,
+                    ] );
+                } catch ( Exception $e ) {
+                    $error = new WP_Error(
+                        self::$slug . '-date-range-error',
+                        $e->getMessage()
+                    );
+                }
+            }
+
             $include_counts = false;
             if ( ! empty( array_intersect( $fields, [ 'Tickets', 'Speakers', 'Sponsors', 'Organizers' ] ) ) ) {
@@ -646 +610 @@
 
             $options = array(
-                'fields'         => $fields,
-                'public'         => false,
-                'earliest_start' => new DateTime( '2006-01-01' ), // No WordCamp posts before 2006.
+                'fields' => $fields,
+                'public' => false,
             );
 
-            if ( $status ) {
-                $options['earliest_start'] = new DateTime( '2015-01-01' ); // No status log data before 2015.
-            }
-
-            if ( $refresh ) {
-                $options['flush_cache'] = true;
-            }
-
-            $report = new self( $start_date, $end_date, $status, $include_dateless, $include_counts, $options );
+            $report = new self( $range, [], $include_counts, $options );
 
             $filename = [ $report::$name ];
-            $filename[] = $report->range->start->format( 'Y-m-d' );
-            $filename[] = $report->range->end->format( 'Y-m-d' );
-            if ( $report->status ) {
-                $filename[] = $report->status;
-            }
-            if ( $report->include_dateless ) {
-                $filename[] = 'include-dateless';
+            if ( $report->range instanceof Date_Range ) {
+                $filename[] = $report->range->start->format( 'Y-m-d' );
+                $filename[] = $report->range->end->format( 'Y-m-d' );
             }
             if ( $report->include_counts ) {
@@ -688 +639 @@
             }
 
+            if ( $error instanceof WP_Error ) {
+                $exporter->error = $report->merge_errors( $error, $exporter->error );
+            }
+
             $exporter->emit_file();
         } // End if().

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/classes/report/class-wordcamp-status.php

@@ -8 +8 @@
 
 use Exception;
-use WordCamp\Reports;
-use function WordCamp\Reports\Validation\validate_wordcamp_status;
+use DateTime;
+use WP_Error, WP_Post;
+use function WordCamp\Reports\{get_assets_url, get_assets_dir_path, get_views_dir_path};
+use WordCamp\Reports\Utility\Date_Range;
+use function WordCamp\Reports\Validation\{validate_date_range, validate_wordcamp_status};
+use function WordCamp\Reports\Time\{year_array, quarter_array, month_array, convert_time_period_to_date_range};
 use WordCamp_Loader;
+use WordCamp\Utilities\Export_CSV;
 
 /**
@@ -19 +24 @@
  * @package WordCamp\Reports\Report
  */
-class WordCamp_Status extends Date_Range {
+class WordCamp_Status extends Base {
     /**
      * Report name.
@@ -69 +74 @@
 
     /**
+     * The date range that defines the scope of the report data.
+     *
+     * @var null|Date_Range
+     */
+    public $range = null;
+
+    /**
      * The status to filter for in the report.
      *
@@ -106 +118 @@
         ) );
 
-        parent::__construct( $start_date, $end_date, $options );
+        parent::__construct( $options );
+
+        try {
+            $this->range = validate_date_range( $start_date, $end_date, $options );
+        } catch ( Exception $e ) {
+            $this->error->add(
+                self::$slug . '-date-error',
+                $e->getMessage()
+            );
+        }
 
         if ( $status && 'any' !== $status ) {
@@ -139 +160 @@
      */
     protected function get_cache_key() {
-        $cache_key = parent::get_cache_key();
+        $cache_key_segments = [
+            parent::get_cache_key(),
+            $this->range->generate_cache_key_segment(),
+        ];
 
         if ( $this->status ) {
-            $cache_key .= '_' . $this->status;
-        }
-
-        return $cache_key;
+            $cache_key_segments[] = $this->status;
+        }
+
+        return implode( '_', $cache_key_segments );
+    }
+
+    /**
+     * Generate a cache expiration interval.
+     *
+     * @return int A time interval in seconds.
+     */
+    protected function get_cache_expiration() {
+        return $this->range->generate_cache_duration( parent::get_cache_expiration() );
     }
 
@@ -177 +210 @@
             // Trim log entries occurring after the date range.
             $logs = array_filter( $logs, function( $entry ) {
-                if ( $entry['timestamp'] > $this->end_date->getTimestamp() ) {
+                if ( $entry['timestamp'] > $this->range->end->getTimestamp() ) {
                     return false;
                 }
@@ -195 +228 @@
             // Trim log entries occurring before the date range.
             $logs = array_filter( $logs, function( $entry ) {
-                if ( $entry['timestamp'] < $this->start_date->getTimestamp() ) {
+                if ( $entry['timestamp'] < $this->range->start->getTimestamp() ) {
                     return false;
                 }
@@ -300 +333 @@
                     'key'     => 'Start Date (YYYY-mm-dd)',
                     'compare' => '>=',
-                    'value'   => strtotime( '-3 months', $this->start_date->getTimestamp() ),
+                    'value'   => strtotime( '-3 months', $this->range->start->getTimestamp() ),
                     'type'    => 'NUMERIC',
                 ),
@@ -312 +345 @@
      * Retrieve the log of status changes for a particular WordCamp.
      *
-     * @param \WP_Post $wordcamp A WordCamp post.
+     * @param WP_Post $wordcamp A WordCamp post.
      *
      * @return array
      */
-    protected function get_wordcamp_status_logs( \WP_Post $wordcamp ) {
+    protected function get_wordcamp_status_logs( WP_Post $wordcamp ) {
         $log_entries = get_post_meta( $wordcamp->ID, '_status_change' );
 
@@ -398 +431 @@
     public function render_html() {
         $data       = $this->compile_report_data( $this->get_data() );
-        $start_date = $this->start_date;
-        $end_date   = $this->end_date;
+        $start_date = $this->range->start;
+        $end_date   = $this->range->end;
         $status     = $this->status;
 
@@ -407 +440 @@
 
         if ( ! empty( $this->error->get_error_messages() ) ) {
-            ?>
-            <div class="notice notice-error">
-                <?php foreach ( $this->error->get_error_messages() as $message ) : ?>
-                    <?php echo wpautop( wp_kses_post( $message ) ); ?>
-                <?php endforeach; ?>
-            </div>
-        <?php
+            $this->render_error_html();
         } else {
-            include Reports\get_views_dir_path() . 'html/wordcamp-status.php';
+            include get_views_dir_path() . 'html/wordcamp-status.php';
         }
     }
@@ -427 +454 @@
         wp_register_script(
             self::$slug,
-            Reports\get_assets_url() . 'js/' . self::$slug . '.js',
-            array( 'jquery' ),
-            Reports\JS_VERSION,
+            get_assets_url() . 'js/' . self::$slug . '.js',
+            array( 'jquery', 'select2' ),
+            filemtime( get_assets_dir_path() . 'js/' . self::$slug . '.js' ),
             true
         );
@@ -435 +462 @@
         wp_register_style(
             self::$slug,
-            Reports\get_assets_url() . 'css/' . self::$slug . '.css',
-            array(),
-            Reports\CSS_VERSION,
+            get_assets_url() . 'css/' . self::$slug . '.css',
+            array( 'select2' ),
+            filemtime( get_assets_dir_path() . 'css/' . self::$slug . '.css' ),
             'screen'
         );
@@ -449 +476 @@
     public static function enqueue_admin_assets() {
         self::register_assets();
-
+        WordCamp_Details::register_assets();
+
+        wp_enqueue_style( WordCamp_Details::$slug );
         wp_enqueue_script( self::$slug );
         wp_enqueue_style( self::$slug );
@@ -468 +497 @@
         $statuses   = WordCamp_Loader::get_post_statuses();
 
+        $field_defaults = [
+            'ID'                      => 'checked',
+            'Name'                    => 'checked disabled',
+            'Start Date (YYYY-mm-dd)' => 'checked',
+            'End Date (YYYY-mm-dd)'   => 'checked',
+            'Location'                => 'checked',
+            'URL'                     => 'checked',
+            'Created'                 => 'checked',
+            'Status'                  => 'checked',
+        ];
+
         $report = null;
 
-        if ( 'run-report' === $action && wp_verify_nonce( $nonce, 'run-report' ) ) {
+        if ( 'Show results' === $action
+             && wp_verify_nonce( $nonce, 'run-report' )
+             && current_user_can( 'manage_network' )
+        ) {
             $options = array(
-                'earliest_start' => new \DateTime( '2015-01-01' ), // No status log data before 2015.
+                'public'         => false,
+                'earliest_start' => new DateTime( '2015-01-01' ), // No status log data before 2015.
             );
 
@@ -480 +524 @@
 
             $report = new self( $start_date, $end_date, $status, $options );
-
-            // The report adjusts the end date in some circumstances.
-            if ( empty( $report->error->get_error_messages() ) ) {
-                $end_date = $report->end_date->format( 'Y-m-d' );
-            }
-        }
-
-        include Reports\get_views_dir_path() . 'report/wordcamp-status.php';
+        }
+
+        include get_views_dir_path() . 'report/wordcamp-status.php';
+    }
+
+    /**
+     * Export the report data to a file.
+     *
+     * @return void
+     */
+    public static function export_to_file() {
+        $start_date = filter_input( INPUT_POST, 'start-date' );
+        $end_date   = filter_input( INPUT_POST, 'end-date' );
+        $status     = filter_input( INPUT_POST, 'status' );
+        $fields     = filter_input( INPUT_POST, 'fields', FILTER_SANITIZE_STRING, [ 'flags' => FILTER_REQUIRE_ARRAY ] );
+        $refresh    = filter_input( INPUT_POST, 'refresh', FILTER_VALIDATE_BOOLEAN );
+        $action     = filter_input( INPUT_POST, 'action' );
+        $nonce      = filter_input( INPUT_POST, self::$slug . '-nonce' );
+
+        if ( 'Export CSV' !== $action ) {
+            return;
+        }
+
+        if ( wp_verify_nonce( $nonce, 'run-report' ) && current_user_can( 'manage_network' ) ) {
+            $error = null;
+
+            $options = array(
+                'public'         => false,
+                'earliest_start' => new DateTime( '2015-01-01' ), // No status log data before 2015.
+            );
+
+            if ( $refresh ) {
+                $options['flush_cache'] = true;
+            }
+
+            $status_report = new self( $start_date, $end_date, $status, $options );
+            $wordcamp_ids  = array_keys( $status_report->get_data() );
+
+            if ( ! empty( $status_report->error->get_error_messages() ) ) {
+                $error = $status_report->error;
+            } elseif ( empty( $wordcamp_ids ) ) {
+                $error = new WP_Error(
+                    self::$slug . '-export-error',
+                    'No status data available for the given criteria.'
+                );
+            }
+
+            $include_counts = false;
+            if ( ! empty( array_intersect( $fields, [ 'Tickets', 'Speakers', 'Sponsors', 'Organizers' ] ) ) ) {
+                $include_counts = true;
+            }
+
+            // The "Name" field should always be included, but does not get submitted because the input is disabled,
+            // so add it in here.
+            $fields[] = 'Name';
+
+            $options = array(
+                'fields' => $fields,
+                'public' => false,
+            );
+
+            $details_report = new WordCamp_Details( null, $wordcamp_ids, $include_counts, $options );
+
+            $filename = [ $status_report::$name ];
+            $filename[] = $status_report->range->start->format( 'Y-m-d' );
+            $filename[] = $status_report->range->end->format( 'Y-m-d' );
+            if ( $status_report->status ) {
+                $filename[] = $status_report->status;
+            }
+            if ( $details_report->include_counts ) {
+                $filename[] = 'include-counts';
+            }
+
+            $data = $details_report->prepare_data_for_display( $details_report->get_data() );
+
+            $headers = ( ! empty( $data ) ) ? array_keys( $data[0] ) : [];
+
+            $exporter = new Export_CSV( array(
+                'filename' => $filename,
+                'headers'  => $headers,
+                'data'     => $data,
+            ) );
+
+            if ( ! empty( $details_report->error->get_error_messages() ) ) {
+                $exporter->error = $details_report->merge_errors( $details_report->error, $exporter->error );
+            }
+
+            if ( $error instanceof WP_Error ) {
+                $exporter->error = $details_report->merge_errors( $error, $exporter->error );
+            }
+
+            $exporter->emit_file();
+        } // End if().
     }
 
@@ -503 +632 @@
             self::register_assets();
 
+            wp_enqueue_style( 'select2' );
             wp_enqueue_script( self::$slug );
 
@@ -525 +655 @@
         $action = filter_input( INPUT_GET, 'action' );
 
-        $years    = self::year_array( absint( date( 'Y' ) ), 2015 );
-        $months   = self::month_array();
+        $years    = year_array( absint( date( 'Y' ) ), 2015 );
+        $quarters = quarter_array();
+        $months   = month_array();
         $statuses = WordCamp_Loader::get_post_statuses();
 
@@ -540 +671 @@
 
         if ( 'Show results' === $action ) {
-            $range = self::convert_time_period_to_date_range( $year, $period );
+            try {
+                $range = convert_time_period_to_date_range( $year, $period );
+            } catch ( Exception $e ) {
+                $error = new WP_Error(
+                    self::$slug . '-time-period-error',
+                    $e->getMessage()
+                );
+            }
 
             $options = array(
-                'earliest_start' => new \DateTime( '2015-01-01' ), // No status log data before 2015.
+                'earliest_start' => new DateTime( '2015-01-01' ), // No status log data before 2015.
             );
 
-            $report = new self( $range['start_date'], $range['end_date'], $status, $options );
-        }
-
-        include Reports\get_views_dir_path() . 'public/wordcamp-status.php';
+            $report = new self( $range->start, $range->end, $status, $options );
+        }
+
+        include get_views_dir_path() . 'public/wordcamp-status.php';
     }
 }

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/includes/validation.php

@@ -5 +5 @@
 
 use Exception;
+use stdClass;
 use DateTime, DateTimeImmutable, DateInterval;
 use WP_Post;
@@ -121 +122 @@
  * }
  *
- * @return array An associative array containing valid post ID and site ID integers for the WordCamp.
+ * @return object An object containing properties for valid post ID and site ID integers for the WordCamp.
  * @throws Exception
  */
@@ -140 +141 @@
 
     if ( ! $wordcamp_post instanceof WP_Post || WCPT_POST_TYPE_ID !== get_post_type( $wordcamp_post ) ) {
-        throw new Exception( 'Please enter a valid WordCamp ID.' );
-    }
-
-    $valid = [
-        'post_id' => $post_id,
-        'site_id' => 0,
-    ];
-
-    if ( $config['require_site'] ) {
-        $site_id = get_wordcamp_site_id( $wordcamp_post );
-
-        if ( ! $site_id ) {
-            throw new Exception( 'The specified WordCamp does not have a site yet.' );
-        }
-
-        $valid['site_id'] = $site_id;
-    }
+        throw new Exception( sprintf(
+            'Invalid WordCamp ID: %s',
+            esc_html( $post_id )
+        ) );
+    }
+
+    $valid = new stdClass();
+
+    $valid->post_id = $post_id;
+    $valid->site_id = get_wordcamp_site_id( $wordcamp_post );
 
     if ( $switched ) {
         restore_current_blog();
+    }
+
+    if ( $config['require_site'] && ! $valid->site_id ) {
+        throw new Exception( sprintf(
+            'The WordCamp with ID %d does not have a site.',
+            absint( $post_id )
+        ) );
     }
 

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/index.php

@@ -134 +134 @@
         __NAMESPACE__ . '\Report\Payment_Activity',
         __NAMESPACE__ . '\Report\Sponsorship_Grants',
+        __NAMESPACE__ . '\Report\WordCamp_Status',
         __NAMESPACE__ . '\Report\WordCamp_Details',
-        __NAMESPACE__ . '\Report\WordCamp_Status',
         __NAMESPACE__ . '\Report\Meetup_Groups',
         __NAMESPACE__ . '\Report\Meetup_Events',

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/views/html/wordcamp-status.php

@@ -7 +7 @@
 defined( 'WPINC' ) || die();
 
-/** @var \DateTime $start_date */
-/** @var \DateTime $end_date */
+use DateTime;
+
+/** @var DateTime $start_date */
+/** @var DateTime $end_date */
 /** @var string $status */
 /** @var array $active_camps */
@@ -15 +17 @@
 ?>
 
-<?php if ( ! empty( $active_camps ) ) : ?>
+<?php if ( count( $active_camps ) ) : ?>
     <h3 id="active-heading">
         <?php if ( $status ) : ?>
@@ -28 +30 @@
         <?php endif; ?>
     </h3>
+
+    <table class="striped widefat but-not-too-wide">
+        <tr>
+            <td>Active WordCamps</td>
+            <td class="number"><?php echo number_format_i18n( count( $active_camps ) ); ?></td>
+        </tr>
+    </table>
 
     <?php foreach ( $active_camps as $active_camp ) : ?>
@@ -43 +52 @@
 <?php endif; ?>
 
-<?php if ( ! empty( $inactive_camps ) ) : ?>
+<?php if ( count( $inactive_camps ) ) : ?>
     <h3 id="inactive-heading">
         WordCamps
@@ -57 +66 @@
     </h3>
 
+    <table class="striped widefat but-not-too-wide">
+        <tr>
+            <td>Inactive WordCamps</td>
+            <td class="number"><?php echo number_format_i18n( count( $inactive_camps ) ); ?></td>
+        </tr>
+    </table>
+
     <ul>
     <?php foreach ( $inactive_camps as $inactive_camp ) : ?>
@@ -69 +85 @@
 
 <?php if ( empty( $active_camps ) && empty( $inactive_camps ) ) : ?>
-    <h3 id="no-data-heading">
+    <p>
         No data
         <?php if ( $status ) : ?>
@@ -79 +95 @@
             between <?php echo esc_html( $start_date->format( 'M jS, Y' ) ); ?> and <?php echo esc_html( $end_date->format( 'M jS, Y' ) ); ?>
         <?php endif; ?>
-    </h3>
+    </p>
 <?php endif; ?>

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/views/public/wordcamp-status.php

@@ -13 +13 @@
 /** @var string $status */
 /** @var array  $years */
+/** @var array  $quarters */
 /** @var array  $months */
 /** @var array  $statuses */
@@ -37 +38 @@
             <select id="period" name="period">
                 <option value="all"<?php selected( 'all' === $period ); ?>>Entire year</option>
-                <option value="q1"<?php selected( 'q1' === $period ); ?>>1st quarter</option>
-                <option value="q2"<?php selected( 'q2' === $period ); ?>>2nd quarter</option>
-                <option value="q3"<?php selected( 'q3' === $period ); ?>>3rd quarter</option>
-                <option value="q4"<?php selected( 'q4' === $period ); ?>>4th quarter</option>
+                <?php foreach ( $quarters as $quarter_value => $quarter_label ) : ?>
+                    <option value="<?php echo esc_attr( $quarter_value ); ?>"<?php selected( $quarter_value, $period ); ?>><?php echo esc_html( $quarter_label ); ?></option>
+                <?php endforeach; ?>
                 <?php foreach ( $months as $month_value => $month_label ) : ?>
                     <option value="<?php echo esc_attr( $month_value ); ?>"<?php selected( $month_value, $period ); ?>><?php echo esc_html( $month_label ); ?></option>

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/views/report/wordcamp-details.php

@@ -10 +10 @@
 use WordCamp\Reports\Report;
 
-/** @var string $start_date */
-/** @var string $end_date */
-/** @var bool   $include_dateless */
-/** @var string $status */
-/** @var array  $statuses */
-/** @var array  $available_fields */
+/** @var array $field_defaults */
 ?>
 
@@ -38 +33 @@
             <tbody>
             <tr>
-                <th scope="row"><label for="start-date">Start Date</label></th>
-                <td><input type="date" id="start-date" name="start-date" value="<?php echo esc_attr( $start_date ) ?>" required /></td>
+                <th scope="row"><label for="start-date">Start Date (optional)</label></th>
+                <td><input type="date" id="start-date" name="start-date" value="" /></td>
             </tr>
             <tr>
-                <th scope="row"><label for="end-date">End Date</label></th>
-                <td><input type="date" id="end-date" name="end-date" value="<?php echo esc_attr( $end_date ) ?>" required /></td>
-            </tr>
-            <tr>
-                <th scope="row"><label for="include_dateless">Include WordCamps without a date</label></th>
-                <td><input type="checkbox" id="include_dateless" name="include_dateless"<?php checked( $include_dateless ); ?> /></td>
-            </tr>
-            <tr>
-                <th scope="row"><label for="status">Status (optional)</label></th>
-                <td>
-                    <select id="status" name="status">
-                        <option value="any"<?php selected( ( ! $status || 'any' === $status ) ); ?>>Any</option>
-                        <?php foreach ( $statuses as $value => $label ) : ?>
-                            <option value="<?php echo esc_attr( $value ); ?>"<?php selected( $value, $status ); ?>><?php echo esc_attr( $label ); ?></option>
-                        <?php endforeach; ?>
-                    </select>
-                </td>
-            </tr>
-            <tr>
-                <th scope="row"><label for="refresh">Refresh results</label></th>
-                <td><input type="checkbox" id="refresh" name="refresh" /></td>
+                <th scope="row"><label for="end-date">End Date (optional)</label></th>
+                <td><input type="date" id="end-date" name="end-date" value="" /></td>
             </tr>
             </tbody>
         </table>
 
-        <fieldset class="fields-container">
-            <legend class="fields-label">Available Fields</legend>
-
-            <?php foreach ( $available_fields as $field_name => $extra_props ) : ?>
-                <div class="field-checkbox">
-                    <input
-                        type="checkbox"
-                        id="fields-<?php echo esc_attr( $field_name ); ?>"
-                        name="fields[]"
-                        value="<?php echo esc_attr( $field_name ); ?>"
-                        <?php if ( $extra_props && is_string( $extra_props ) ) echo esc_html( $extra_props ); ?>
-                    />
-                    <label for="fields-<?php echo esc_attr( $field_name ); ?>">
-                        <?php echo esc_attr( $field_name ); ?>
-                    </label>
-                </div>
-            <?php endforeach; ?>
-        </fieldset>
+        <?php Report\WordCamp_Details::render_available_fields( 'private', $field_defaults ) ?>
 
         <?php submit_button( 'Export CSV', 'primary', 'action', false ); ?>

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-reports/views/report/wordcamp-status.php

@@ -14 +14 @@
 /** @var string $status */
 /** @var array  $statuses */
+/** @var array  $field_defaults */
 /** @var Report\WordCamp_Status|null $report */
 ?>
@@ -38 +39 @@
                 <tr>
                     <th scope="row"><label for="start-date">Start Date</label></th>
-                    <td><input type="date" id="start-date" name="start-date" value="<?php echo esc_attr( $start_date ) ?>" /></td>
+                    <td><input type="date" id="start-date" name="start-date" value="<?php echo esc_attr( $start_date ) ?>" required /></td>
                 </tr>
                 <tr>
                     <th scope="row"><label for="end-date">End Date</label></th>
-                    <td><input type="date" id="end-date" name="end-date" value="<?php echo esc_attr( $end_date ) ?>" /></td>
+                    <td><input type="date" id="end-date" name="end-date" value="<?php echo esc_attr( $end_date ) ?>" required /></td>
                 </tr>
                 <tr>
                     <th scope="row"><label for="status">Status (optional)</label></th>
                     <td>
-                        <select id="status" name="status">
+                        <select id="status" name="status" class="select2-container">
                             <option value="any"<?php selected( ( ! $status || 'any' === $status ) ); ?>>Any</option>
                             <?php foreach ( $statuses as $value => $label ) : ?>
@@ -53 +54 @@
                             <?php endforeach; ?>
                         </select>
+                        <p class="description">
+                            This will select all WordCamps that had this status at any time during the date range.
+                        </p>
                     </td>
                 </tr>
@@ -62 +66 @@
         </table>
 
-        <?php submit_button( 'Show results', 'primary', '' ); ?>
+        <?php submit_button( 'Show results', 'primary', 'action', false ); ?>
+
+        <button id="fields-toggle" class="secondary button-secondary">Export resulting WordCamps as a CSV</button>
+
+        <section id="fields-section" class="hidden">
+            <?php Report\WordCamp_Details::render_available_fields( 'private', $field_defaults ); ?>
+            <?php submit_button( 'Export CSV', 'primary', 'action', false ); ?>
+        </section>
     </form>