WordPoints / importer

src/includes/importers/cubepoints.php

Indentation +668 added lines, -668 removed lines

@@ -14,702 +14,702 @@
  */
 class WordPoints_CubePoints_Importer extends WordPoints_Importer {
 
-	/**
-	 * Reversible log types indexed by the reversing log type.
-	 *
-	 * This information is used to set the `auto_reversed` and `original_log_id`
-	 * points log metadata for the imported logs.
-	 *
-	 * @since 1.2.0
-	 *
-	 * @see WordPoints_CubePoints_Importer::import_points_log()
-	 *
-	 * @var array
-	 */
-	protected $reversible_log_types = array(
-		'comment_remove'      => 'comment',
-		'post_comment_remove' => 'post_comment',
-	);
-
-	/**
-	 * Primary entity slugs for each imported log type.
-	 *
-	 * These are points log meta keys under which to save the entity ID in the
-	 * CubePoints `data` log field.
-	 *
-	 * @since 1.2.0
-	 *
-	 * @see WordPoints_CubePoints_Importer::import_points_log()
-	 *
-	 * @var array
-	 */
-	protected $log_type_entities = array(
-		'comment'             => 'comment',
-		'comment_remove'      => 'comment',
-		'post'                => 'post',
-		'post_comment'        => 'comment',
-		'post_comment_remove' => 'comment',
-		'register'            => 'user',
-	);
-
-	/**
-	 * IDs of reversible logs, indexed by CubePoints log type and object ID.
-	 *
-	 * @since 1.2.0
-	 *
-	 * @see WordPoints_CubePoints_Importer::import_points_log()
-	 *
-	 * @var int[][]
-	 */
-	protected $reversible_log_ids;
-
-	/**
-	 * @since 1.0.0
-	 */
-	public function __construct( $name ) {
-
-		parent::__construct( $name );
-
-		$this->components = array(
-			'points' => array(
-				'excluded_users' => array(
-					'label' => __( 'Excluded users', 'wordpoints-importer' ),
-					'function' => array( $this, 'import_excluded_users' ),
-				),
-				'settings'    => array(
-					'label' => __( 'Points Reactions', 'wordpoints-importer' ),
-					'description' => __( 'If checked, the settings for the number of points to award for posts, comments, etc. are imported.', 'wordpoints-importer' ),
-					'function' => array( $this, 'import_points_settings' ),
-				),
-				'user_points' => array(
-					'label' => __( 'User points', 'wordpoints-importer' ),
-					'function' => array( $this, 'import_user_points' ),
-				),
-				'logs' => array(
-					'label' => __( 'Points logs', 'wordpoints-importer' ),
-					'function' => array( $this, 'import_points_logs' ),
-					'can_import' => array( $this, 'can_import_points_logs' ),
-				),
-			),
-			'ranks' => array(
-				'ranks' => array(
-					'label' => __( 'Rank settings', 'wordpoints-importer' ),
-					'description' => __( 'If checked, the list of ranks is imported, and users will have the correct ranks assigned to them.', 'wordpoints-importer' ),
-					'function' => array( $this, 'import_ranks' ),
-				),
-			),
-		);
-	}
-
-	/**
-	 * @since 1.0.0
-	 */
-	public function is_available() {
-
-		if ( ! $this->is_cubepoints_installed() ) {
-			return new WP_Error(
-				'cubepoints_not_installed'
-				, __( 'CubePoints is not installed', 'wordpoints-importer' )
-			);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if CubePoints is installed.
-	 *
-	 * @since 1.0.0
-	 */
-	public function is_cubepoints_installed() {
-
-		return (bool) get_option( 'cp_db_version' );
-	}
-
-	/**
-	 * Check if CubePoints is active.
-	 *
-	 * @since 1.0.0
-	 */
-	public function is_cubepoints_active() {
-
-		return function_exists( 'cp_ready' );
-	}
-
-	/**
-	 * Import the excluded users.
-	 *
-	 * @since 1.0.0
-	 */
-	protected function import_excluded_users() {
-
-		$this->feedback->info( __( 'Importing excluded users…', 'wordpoints-importer' ) );
-
-		$excluded_users = get_option( 'cp_topfilter' );
-
-		if ( ! is_array( $excluded_users ) ) {
-			$this->feedback->warning( __( 'No excluded users found.', 'wordpoints-importer' ) );
-			return;
-		}
-
-		$user_ids = array();
-
-		foreach ( $excluded_users as $user_login ) {
-
-			$user = get_user_by( 'login', $user_login );
-
-			if ( $user instanceof WP_User ) {
-				$user_ids[] = $user->ID;
-			}
-		}
-
-		$excluded_user_ids = wordpoints_get_maybe_network_array_option(
-			'wordpoints_excluded_users'
-		);
-
-		$excluded_user_ids = array_unique(
-			array_merge( $excluded_user_ids, $user_ids )
-		);
-
-		wordpoints_update_maybe_network_option(
-			'wordpoints_excluded_users'
-			, $excluded_user_ids
-		);
-
-		$this->feedback->success(
-			sprintf(
-				__( 'Imported %s excluded users.', 'wordpoints-importer' )
-				, count( $user_ids )
-			)
-		);
-	}
-
-	/**
-	 * Import the points settings to the points hooks.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @param array $settings The settings for the points component import.
-	 */
-	protected function import_points_settings( $settings ) {
-
-		$this->feedback->info( __( 'Importing points reactions…', 'wordpoints-importer' ) );
-
-		$options = array(
-			'cp_comment_points'     => array(
-				'event' => 'comment_leave\post',
-				'target' => array( 'comment\post', 'author', 'user' ),
-				/* translators: The post type name */
-				'log_text' => __( 'Comment on a %s.', 'wordpoints-importer' ),
-				/* translators: The post type name */
-				'description' => __( 'Commenting on a %s.', 'wordpoints-importer' ),
-				'legacy_log_type' => 'cubepoints-comment',
-				'legacy_meta_key' => 'comment',
-			),
-			'cp_post_points'        => array(
-				'event' => 'post_publish\post',
-				'target' => array( 'post\post', 'author', 'user' ),
-				/* translators: The post type name */
-				'log_text' => __( 'Published a Post.', 'wordpoints-importer' ),
-				/* translators: The post type name */
-				'description' => __( 'Publishing a Post.', 'wordpoints-importer' ),
-				'legacy_log_type' => 'cubepoints-post',
-				'legacy_meta_key' => 'post',
-				// CubePoints doesn't remove points when a post is deleted.
-				'blocker' => array( 'toggle_off' => true ),
-				'points_legacy_repeat_blocker' => array( 'toggle_on' => true ),
-			),
-			'cp_reg_points'         => array(
-				'event' => 'user_register',
-				'log_text' => __( 'Registration.', 'wordpoints-importer' ),
-				'description' => __( 'Registration.', 'wordpoints-importer' ),
-				'legacy_log_type' => 'cubepoints-register',
-			),
-			'cp_post_author_points' => array(
-				'event' => 'comment_leave\post',
-				'target' => array( 'comment\post', 'post\post', 'post\post', 'author', 'user' ),
-				/* translators: The post type name */
-				'log_text' => __( 'Received a comment on a %s.', 'wordpoints-importer' ),
-				/* translators: The post type name */
-				'description' => __( 'Receiving a comment on a %s.', 'wordpoints-importer' ),
-				'legacy_log_type' => 'cubepoints-post_author',
-				'legacy_meta_key' => 'comment',
-			),
-		);
-
-		// Don't import this module setting if the module isn't active.
-		if ( function_exists( 'cp_module_activated' ) && ! cp_module_activated( 'post_author_points' ) ) {
-			unset( $options['cp_post_author_points'] );
-		}
-
-		$imported = 0;
-
-		foreach ( $options as $option => $hook_settings ) {
-
-			$points = get_option( $option );
-
-			if ( wordpoints_posint( $points ) ) {
-
-				$hook_settings['points'] = $points;
-				$hook_settings['points_type'] = $settings['points_type'];
-
-				if (
-					// The CubePoints post points were only awarded for Posts.
-					'post_publish\post' !== $hook_settings['event']
-					&& strpos( $hook_settings['event'], '\post' )
-				) {
-
-					$post_type_slugs = get_post_types( array( 'public' => true ) );
-
-					foreach ( $post_type_slugs as $post_type_slug ) {
-
-						$added = $this->add_points_hook(
-							$this->format_settings_for_post_type(
-								$post_type_slug
-								, $hook_settings
-							)
-						);
-
-						if ( $added ) {
-							$imported++;
-						}
-					}
-
-				} else {
-					if ( $this->add_points_hook( $hook_settings ) ) {
-						$imported++;
-					}
-				}
-			}
-
-		} // End foreach ( $options ).
-
-		if ( $this->import_daily_points_hook( $settings ) ) {
-			$imported++;
-		}
-
-		$this->feedback->success(
-			sprintf( __( 'Imported %s points reactions.', 'wordpoints-importer' ), $imported )
-		);
-	}
-
-	/**
-	 * Import the settings for the Daily Points module to a points hook.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @param array $settings The settings for the points component import.
-	 *
-	 * @return bool True if the settings were imported, false otherwise.
-	 */
-	protected function import_daily_points_hook( $settings ) {
-
-		// Don't import this module setting if the module isn't active.
-		if ( function_exists( 'cp_module_activated' ) && ! cp_module_activated( 'dailypoints' ) ) {
-			return false;
-		}
-
-		$points = get_option( 'cp_module_dailypoints_points' );
-		$period = get_option( 'cp_module_dailypoints_time' );
-
-		if ( ! wordpoints_int( $points ) || ! wordpoints_posint( $period ) ) {
-			return false;
-		}
-
-		return $this->add_points_hook(
-			array(
-				'event' => 'user_visit',
-				'target' => array( 'current:user' ),
-				'reactor' => 'points_legacy',
-				'points' => $points,
-				'points_type' => $settings['points_type'],
-				'points_legacy_periods' => array(
-					'fire' => array(
-						array(
-							'length' => $period,
-							'args' => array( array( 'current:user' ) ),
-							'relative' => true,
-						),
-					),
-				),
-				'log_text' => __( 'Visiting the site.', 'wordpoints-importer' ),
-				'description' => __( 'Visiting the site.', 'wordpoints-importer' ),
-				'points_legacy_reversals' => array(),
-				'legacy_log_type' => 'cubepoints-dailypoints',
-			)
-		);
-	}
-
-	/**
-	 * Programmatically create a new instance of a points hook.
-	 *
-	 * @since 1.0.0
-	 * @since 1.2.0 Now just accepts a single argument, $settings.
-	 *
-	 * @param array $settings The settings for this hook.
-	 *
-	 * @return bool True if added successfully, or false on failure.
-	 */
-	private function add_points_hook( $settings = array() ) {
-
-		$reaction_store = wordpoints_hooks()->get_reaction_store( 'points' );
-
-		$settings = array_merge(
-			array(
-				'target' => array( 'user' ),
-				'reactor' => 'points_legacy',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-			)
-			, $settings
-		);
-
-		$reaction = $reaction_store->create_reaction( $settings );
-
-		if ( ! $reaction instanceof WordPoints_Hook_ReactionI ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Format the settings for a reaction for a particular post type.
-	 *
-	 * @since 1.2.0
-	 *
-	 * @param string $post_type The slug of the post type to format the settings for.
-	 * @param array  $settings  The reaction settings.
-	 *
-	 * @return array The settings modified for this particular post type.
-	 */
-	protected function format_settings_for_post_type( $post_type, $settings ) {
-
-		$settings['event'] = str_replace(
-			'\post'
-			, '\\' . $post_type
-			, $settings['event']
-		);
-
-		$settings['target'] = str_replace(
-			'\post'
-			, '\\' . $post_type
-			, $settings['target']
-		);
-
-		$labels = get_post_type_labels( get_post_type_object( $post_type ) );
-
-		$settings['log_text'] = sprintf( $settings['log_text'], $labels->singular_name );
-		$settings['description'] = sprintf( $settings['description'], $labels->singular_name );
-
-		return $settings;
-	}
-
-	/**
-	 * Import the user points.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $settings The settings for the points component import.
-	 */
-	protected function import_user_points( $settings ) {
-
-		$this->feedback->info( __( 'Importing users' points…', 'wordpoints-importer' ) );
-
-		// We don't log the import transactions.
-		add_filter( 'wordpoints_points_log', '__return_false' );
-
-		$start = 0;
-
-		// We do the import in batches.
-		while ( $rows = $this->get_next_user_points_batch( $start ) ) {
-
-			$start += count( $rows );
-
-			foreach ( $rows as $row ) {
-
-				wordpoints_alter_points(
-					$row->user_id
-					, $row->points
-					, $settings['points_type']
-					, 'cubepoints_import' // This is only for the hooks, it isn't being logged.
-				);
-			}
-
-			unset( $rows );
-		}
-
-		remove_filter( 'wordpoints_points_log', '__return_false' );
-
-		$this->feedback->success( sprintf( __( 'Imported points for %s users…', 'wordpoints-importer' ), $start ) );
-	}
-
-	/**
-	 * Get a batch of user points to import.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param int $start The offset number to begin counting at.
-	 *
-	 * @return object[]|false The rows, or false.
-	 */
-	protected function get_next_user_points_batch( $start ) {
-
-		global $wpdb;
-
-		$rows = $wpdb->get_results(
-			$wpdb->prepare(
-				"
+    /**
+     * Reversible log types indexed by the reversing log type.
+     *
+     * This information is used to set the `auto_reversed` and `original_log_id`
+     * points log metadata for the imported logs.
+     *
+     * @since 1.2.0
+     *
+     * @see WordPoints_CubePoints_Importer::import_points_log()
+     *
+     * @var array
+     */
+    protected $reversible_log_types = array(
+        'comment_remove'      => 'comment',
+        'post_comment_remove' => 'post_comment',
+    );
+
+    /**
+     * Primary entity slugs for each imported log type.
+     *
+     * These are points log meta keys under which to save the entity ID in the
+     * CubePoints `data` log field.
+     *
+     * @since 1.2.0
+     *
+     * @see WordPoints_CubePoints_Importer::import_points_log()
+     *
+     * @var array
+     */
+    protected $log_type_entities = array(
+        'comment'             => 'comment',
+        'comment_remove'      => 'comment',
+        'post'                => 'post',
+        'post_comment'        => 'comment',
+        'post_comment_remove' => 'comment',
+        'register'            => 'user',
+    );
+
+    /**
+     * IDs of reversible logs, indexed by CubePoints log type and object ID.
+     *
+     * @since 1.2.0
+     *
+     * @see WordPoints_CubePoints_Importer::import_points_log()
+     *
+     * @var int[][]
+     */
+    protected $reversible_log_ids;
+
+    /**
+     * @since 1.0.0
+     */
+    public function __construct( $name ) {
+
+        parent::__construct( $name );
+
+        $this->components = array(
+            'points' => array(
+                'excluded_users' => array(
+                    'label' => __( 'Excluded users', 'wordpoints-importer' ),
+                    'function' => array( $this, 'import_excluded_users' ),
+                ),
+                'settings'    => array(
+                    'label' => __( 'Points Reactions', 'wordpoints-importer' ),
+                    'description' => __( 'If checked, the settings for the number of points to award for posts, comments, etc. are imported.', 'wordpoints-importer' ),
+                    'function' => array( $this, 'import_points_settings' ),
+                ),
+                'user_points' => array(
+                    'label' => __( 'User points', 'wordpoints-importer' ),
+                    'function' => array( $this, 'import_user_points' ),
+                ),
+                'logs' => array(
+                    'label' => __( 'Points logs', 'wordpoints-importer' ),
+                    'function' => array( $this, 'import_points_logs' ),
+                    'can_import' => array( $this, 'can_import_points_logs' ),
+                ),
+            ),
+            'ranks' => array(
+                'ranks' => array(
+                    'label' => __( 'Rank settings', 'wordpoints-importer' ),
+                    'description' => __( 'If checked, the list of ranks is imported, and users will have the correct ranks assigned to them.', 'wordpoints-importer' ),
+                    'function' => array( $this, 'import_ranks' ),
+                ),
+            ),
+        );
+    }
+
+    /**
+     * @since 1.0.0
+     */
+    public function is_available() {
+
+        if ( ! $this->is_cubepoints_installed() ) {
+            return new WP_Error(
+                'cubepoints_not_installed'
+                , __( 'CubePoints is not installed', 'wordpoints-importer' )
+            );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if CubePoints is installed.
+     *
+     * @since 1.0.0
+     */
+    public function is_cubepoints_installed() {
+
+        return (bool) get_option( 'cp_db_version' );
+    }
+
+    /**
+     * Check if CubePoints is active.
+     *
+     * @since 1.0.0
+     */
+    public function is_cubepoints_active() {
+
+        return function_exists( 'cp_ready' );
+    }
+
+    /**
+     * Import the excluded users.
+     *
+     * @since 1.0.0
+     */
+    protected function import_excluded_users() {
+
+        $this->feedback->info( __( 'Importing excluded users…', 'wordpoints-importer' ) );
+
+        $excluded_users = get_option( 'cp_topfilter' );
+
+        if ( ! is_array( $excluded_users ) ) {
+            $this->feedback->warning( __( 'No excluded users found.', 'wordpoints-importer' ) );
+            return;
+        }
+
+        $user_ids = array();
+
+        foreach ( $excluded_users as $user_login ) {
+
+            $user = get_user_by( 'login', $user_login );
+
+            if ( $user instanceof WP_User ) {
+                $user_ids[] = $user->ID;
+            }
+        }
+
+        $excluded_user_ids = wordpoints_get_maybe_network_array_option(
+            'wordpoints_excluded_users'
+        );
+
+        $excluded_user_ids = array_unique(
+            array_merge( $excluded_user_ids, $user_ids )
+        );
+
+        wordpoints_update_maybe_network_option(
+            'wordpoints_excluded_users'
+            , $excluded_user_ids
+        );
+
+        $this->feedback->success(
+            sprintf(
+                __( 'Imported %s excluded users.', 'wordpoints-importer' )
+                , count( $user_ids )
+            )
+        );
+    }
+
+    /**
+     * Import the points settings to the points hooks.
+     *
+     * @since 1.1.0
+     *
+     * @param array $settings The settings for the points component import.
+     */
+    protected function import_points_settings( $settings ) {
+
+        $this->feedback->info( __( 'Importing points reactions…', 'wordpoints-importer' ) );
+
+        $options = array(
+            'cp_comment_points'     => array(
+                'event' => 'comment_leave\post',
+                'target' => array( 'comment\post', 'author', 'user' ),
+                /* translators: The post type name */
+                'log_text' => __( 'Comment on a %s.', 'wordpoints-importer' ),
+                /* translators: The post type name */
+                'description' => __( 'Commenting on a %s.', 'wordpoints-importer' ),
+                'legacy_log_type' => 'cubepoints-comment',
+                'legacy_meta_key' => 'comment',
+            ),
+            'cp_post_points'        => array(
+                'event' => 'post_publish\post',
+                'target' => array( 'post\post', 'author', 'user' ),
+                /* translators: The post type name */
+                'log_text' => __( 'Published a Post.', 'wordpoints-importer' ),
+                /* translators: The post type name */
+                'description' => __( 'Publishing a Post.', 'wordpoints-importer' ),
+                'legacy_log_type' => 'cubepoints-post',
+                'legacy_meta_key' => 'post',
+                // CubePoints doesn't remove points when a post is deleted.
+                'blocker' => array( 'toggle_off' => true ),
+                'points_legacy_repeat_blocker' => array( 'toggle_on' => true ),
+            ),
+            'cp_reg_points'         => array(
+                'event' => 'user_register',
+                'log_text' => __( 'Registration.', 'wordpoints-importer' ),
+                'description' => __( 'Registration.', 'wordpoints-importer' ),
+                'legacy_log_type' => 'cubepoints-register',
+            ),
+            'cp_post_author_points' => array(
+                'event' => 'comment_leave\post',
+                'target' => array( 'comment\post', 'post\post', 'post\post', 'author', 'user' ),
+                /* translators: The post type name */
+                'log_text' => __( 'Received a comment on a %s.', 'wordpoints-importer' ),
+                /* translators: The post type name */
+                'description' => __( 'Receiving a comment on a %s.', 'wordpoints-importer' ),
+                'legacy_log_type' => 'cubepoints-post_author',
+                'legacy_meta_key' => 'comment',
+            ),
+        );
+
+        // Don't import this module setting if the module isn't active.
+        if ( function_exists( 'cp_module_activated' ) && ! cp_module_activated( 'post_author_points' ) ) {
+            unset( $options['cp_post_author_points'] );
+        }
+
+        $imported = 0;
+
+        foreach ( $options as $option => $hook_settings ) {
+
+            $points = get_option( $option );
+
+            if ( wordpoints_posint( $points ) ) {
+
+                $hook_settings['points'] = $points;
+                $hook_settings['points_type'] = $settings['points_type'];
+
+                if (
+                    // The CubePoints post points were only awarded for Posts.
+                    'post_publish\post' !== $hook_settings['event']
+                    && strpos( $hook_settings['event'], '\post' )
+                ) {
+
+                    $post_type_slugs = get_post_types( array( 'public' => true ) );
+
+                    foreach ( $post_type_slugs as $post_type_slug ) {
+
+                        $added = $this->add_points_hook(
+                            $this->format_settings_for_post_type(
+                                $post_type_slug
+                                , $hook_settings
+                            )
+                        );
+
+                        if ( $added ) {
+                            $imported++;
+                        }
+                    }
+
+                } else {
+                    if ( $this->add_points_hook( $hook_settings ) ) {
+                        $imported++;
+                    }
+                }
+            }
+
+        } // End foreach ( $options ).
+
+        if ( $this->import_daily_points_hook( $settings ) ) {
+            $imported++;
+        }
+
+        $this->feedback->success(
+            sprintf( __( 'Imported %s points reactions.', 'wordpoints-importer' ), $imported )
+        );
+    }
+
+    /**
+     * Import the settings for the Daily Points module to a points hook.
+     *
+     * @since 1.1.0
+     *
+     * @param array $settings The settings for the points component import.
+     *
+     * @return bool True if the settings were imported, false otherwise.
+     */
+    protected function import_daily_points_hook( $settings ) {
+
+        // Don't import this module setting if the module isn't active.
+        if ( function_exists( 'cp_module_activated' ) && ! cp_module_activated( 'dailypoints' ) ) {
+            return false;
+        }
+
+        $points = get_option( 'cp_module_dailypoints_points' );
+        $period = get_option( 'cp_module_dailypoints_time' );
+
+        if ( ! wordpoints_int( $points ) || ! wordpoints_posint( $period ) ) {
+            return false;
+        }
+
+        return $this->add_points_hook(
+            array(
+                'event' => 'user_visit',
+                'target' => array( 'current:user' ),
+                'reactor' => 'points_legacy',
+                'points' => $points,
+                'points_type' => $settings['points_type'],
+                'points_legacy_periods' => array(
+                    'fire' => array(
+                        array(
+                            'length' => $period,
+                            'args' => array( array( 'current:user' ) ),
+                            'relative' => true,
+                        ),
+                    ),
+                ),
+                'log_text' => __( 'Visiting the site.', 'wordpoints-importer' ),
+                'description' => __( 'Visiting the site.', 'wordpoints-importer' ),
+                'points_legacy_reversals' => array(),
+                'legacy_log_type' => 'cubepoints-dailypoints',
+            )
+        );
+    }
+
+    /**
+     * Programmatically create a new instance of a points hook.
+     *
+     * @since 1.0.0
+     * @since 1.2.0 Now just accepts a single argument, $settings.
+     *
+     * @param array $settings The settings for this hook.
+     *
+     * @return bool True if added successfully, or false on failure.
+     */
+    private function add_points_hook( $settings = array() ) {
+
+        $reaction_store = wordpoints_hooks()->get_reaction_store( 'points' );
+
+        $settings = array_merge(
+            array(
+                'target' => array( 'user' ),
+                'reactor' => 'points_legacy',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+            )
+            , $settings
+        );
+
+        $reaction = $reaction_store->create_reaction( $settings );
+
+        if ( ! $reaction instanceof WordPoints_Hook_ReactionI ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Format the settings for a reaction for a particular post type.
+     *
+     * @since 1.2.0
+     *
+     * @param string $post_type The slug of the post type to format the settings for.
+     * @param array  $settings  The reaction settings.
+     *
+     * @return array The settings modified for this particular post type.
+     */
+    protected function format_settings_for_post_type( $post_type, $settings ) {
+
+        $settings['event'] = str_replace(
+            '\post'
+            , '\\' . $post_type
+            , $settings['event']
+        );
+
+        $settings['target'] = str_replace(
+            '\post'
+            , '\\' . $post_type
+            , $settings['target']
+        );
+
+        $labels = get_post_type_labels( get_post_type_object( $post_type ) );
+
+        $settings['log_text'] = sprintf( $settings['log_text'], $labels->singular_name );
+        $settings['description'] = sprintf( $settings['description'], $labels->singular_name );
+
+        return $settings;
+    }
+
+    /**
+     * Import the user points.
+     *
+     * @since 1.0.0
+     *
+     * @param array $settings The settings for the points component import.
+     */
+    protected function import_user_points( $settings ) {
+
+        $this->feedback->info( __( 'Importing users' points…', 'wordpoints-importer' ) );
+
+        // We don't log the import transactions.
+        add_filter( 'wordpoints_points_log', '__return_false' );
+
+        $start = 0;
+
+        // We do the import in batches.
+        while ( $rows = $this->get_next_user_points_batch( $start ) ) {
+
+            $start += count( $rows );
+
+            foreach ( $rows as $row ) {
+
+                wordpoints_alter_points(
+                    $row->user_id
+                    , $row->points
+                    , $settings['points_type']
+                    , 'cubepoints_import' // This is only for the hooks, it isn't being logged.
+                );
+            }
+
+            unset( $rows );
+        }
+
+        remove_filter( 'wordpoints_points_log', '__return_false' );
+
+        $this->feedback->success( sprintf( __( 'Imported points for %s users…', 'wordpoints-importer' ), $start ) );
+    }
+
+    /**
+     * Get a batch of user points to import.
+     *
+     * @since 1.0.0
+     *
+     * @param int $start The offset number to begin counting at.
+     *
+     * @return object[]|false The rows, or false.
+     */
+    protected function get_next_user_points_batch( $start ) {
+
+        global $wpdb;
+
+        $rows = $wpdb->get_results(
+            $wpdb->prepare(
+                "
 					SELECT `user_id`, `meta_value` as points
 					FROM {$wpdb->usermeta}
 					WHERE `meta_key` = 'cpoints'
 					ORDER BY `umeta_id`
 					LIMIT %d,500
 				"
-				, $start
-			)
-		); // WPCS: cache OK.
-
-		if ( ! is_array( $rows ) ) {
-			return false;
-		}
-
-		return $rows;
-	}
-
-	/**
-	 * Check if the points logs can be imported.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @return true|WP_Error True on success or a WP_Error on failure.
-	 */
-	public function can_import_points_logs() {
-
-		if ( ! $this->is_cubepoints_active() ) {
-
-			return new WP_Error(
-				'wordpoints_import_points_logs_cubepoints_inactive'
-				, __( 'CubePoints must be active.', 'wordpoints-importer' )
-			);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Import the points logs.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array $settings The import settings for the points component.
-	 */
-	protected function import_points_logs( $settings ) {
-
-		$this->feedback->info( __( 'Importing points logs…', 'wordpoints-importer' ) );
-
-		$start = 0;
-
-		while ( $logs = $this->get_next_points_logs_batch( $start ) ) {
-
-			$start += count( $logs );
-
-			foreach ( $logs as $log ) {
-
-				$this->import_points_log(
-					$log->uid
-					, $log->points
-					, $settings['points_type']
-					, "cubepoints-{$log->type}"
-					, array(
-						'cubepoints_type' => $log->type,
-						'cubepoints_data' => $log->data,
-					)
-					, date( 'Y-m-d H:i:s', $log->timestamp )
-				);
-			}
-
-			unset( $logs );
-		}
-
-		$this->feedback->success( sprintf( __( 'Imported %s points log entries.', 'wordpoints-importer' ), $start ) );
-	}
-
-	/**
-	 * Import a points log.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param int    $user_id     The ID of the user the log is for.
-	 * @param int    $points      The number of points awarded.
-	 * @param string $points_type The points type.
-	 * @param string $log_type    The log type.
-	 * @param array  $meta        The metadata for this log.
-	 * @param int    $date        The date the transaction took place.
-	 */
-	protected function import_points_log( $user_id, $points, $points_type, $log_type, $meta, $date ) {
-
-		global $wpdb;
-
-		$result = $wpdb->insert(
-			$wpdb->wordpoints_points_logs,
-			array(
-				'user_id'     => $user_id,
-				'points'      => $points,
-				'points_type' => $points_type,
-				'log_type'    => $log_type,
-				'text'        => $this->render_points_log_text( '', $user_id, $points, $points_type, $log_type, $meta ),
-				'date'        => $date,
-				'site_id'     => $wpdb->siteid,
-				'blog_id'     => $wpdb->blogid,
-			),
-			array( '%d', '%d', '%s', '%s', '%s', '%s', '%d', '%d' )
-		);
-
-		if ( false !== $result ) {
-
-			$log_id = (int) $wpdb->insert_id;
-
-			// Set auto_reversed and original_log_id metadata for reversed logs.
-			foreach ( $this->reversible_log_types as $reverse_type => $type ) {
-
-				if ( $meta['cubepoints_type'] === $type ) {
-
-					// Save this log ID for later, in case this log was reversed.
-					// cubepoints_data will contain the entity ID.
-					$this->reversible_log_ids[ $type ][ $meta['cubepoints_data'] ] = $log_id;
-
-				} elseif (
-					$meta['cubepoints_type'] === $reverse_type
-					&& isset( $this->reversible_log_ids[ $type ][ $meta['cubepoints_data'] ] )
-				) {
-
-					// This log was reverses another one. Set the original log ID.
-					$meta['original_log_id'] = $this->reversible_log_ids[ $type ][ $meta['cubepoints_data'] ];
-
-					// And mark the original as auto_reversed.
-					wordpoints_add_points_log_meta( $meta['original_log_id'], 'auto_reversed', $log_id );
-
-					// No need to keep this info anymore.
-					unset( $this->reversible_log_ids[ $type ][ $meta['cubepoints_data'] ] );
-				}
-			}
-
-			// Set the entity IDs to their own meta keys, for the sake of reversals.
-			if ( isset( $this->log_type_entities[ $meta['cubepoints_type'] ] ) ) {
-				$meta[ $this->log_type_entities[ $meta['cubepoints_type'] ] ] = $meta['cubepoints_data'];
-			}
-
-			foreach ( $meta as $meta_key => $meta_value ) {
-
-				wordpoints_add_points_log_meta( $log_id, $meta_key, $meta_value );
-			}
-
-			do_action( 'wordpoints_points_log', $user_id, $points, $points_type, $log_type, $meta, $log_id );
-
-		} // End if ( inserted successfully ).
-	}
-
-	/**
-	 * Generate the log text when importing a points log.
-	 *
-	 * @since 1.0.0
-	 */
-	public function render_points_log_text( $text, $user_id, $points, $points_type, $log_type, $meta ) {
-
-		ob_start();
-		do_action( 'cp_logs_description', $meta['cubepoints_type'], $user_id, $points, $meta['cubepoints_data'] );
-		return ob_get_clean();
-	}
-
-	/**
-	 * Get the next 500 points logs from CubePoints.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param int $start The offset number to begin counting the 500 at.
-	 *
-	 * @return object[]|false The rows from the database.
-	 */
-	protected function get_next_points_logs_batch( $start ) {
-
-		global $wpdb;
-
-		$logs = $wpdb->get_results( // WPCS: unprepared SQL OK.
-			$wpdb->prepare( // WPCS: unprepared SQL OK.
-				'
+                , $start
+            )
+        ); // WPCS: cache OK.
+
+        if ( ! is_array( $rows ) ) {
+            return false;
+        }
+
+        return $rows;
+    }
+
+    /**
+     * Check if the points logs can be imported.
+     *
+     * @since 1.0.0
+     *
+     * @return true|WP_Error True on success or a WP_Error on failure.
+     */
+    public function can_import_points_logs() {
+
+        if ( ! $this->is_cubepoints_active() ) {
+
+            return new WP_Error(
+                'wordpoints_import_points_logs_cubepoints_inactive'
+                , __( 'CubePoints must be active.', 'wordpoints-importer' )
+            );
+        }
+
+        return true;
+    }
+
+    /**
+     * Import the points logs.
+     *
+     * @since 1.0.0
+     *
+     * @param array $settings The import settings for the points component.
+     */
+    protected function import_points_logs( $settings ) {
+
+        $this->feedback->info( __( 'Importing points logs…', 'wordpoints-importer' ) );
+
+        $start = 0;
+
+        while ( $logs = $this->get_next_points_logs_batch( $start ) ) {
+
+            $start += count( $logs );
+
+            foreach ( $logs as $log ) {
+
+                $this->import_points_log(
+                    $log->uid
+                    , $log->points
+                    , $settings['points_type']
+                    , "cubepoints-{$log->type}"
+                    , array(
+                        'cubepoints_type' => $log->type,
+                        'cubepoints_data' => $log->data,
+                    )
+                    , date( 'Y-m-d H:i:s', $log->timestamp )
+                );
+            }
+
+            unset( $logs );
+        }
+
+        $this->feedback->success( sprintf( __( 'Imported %s points log entries.', 'wordpoints-importer' ), $start ) );
+    }
+
+    /**
+     * Import a points log.
+     *
+     * @since 1.0.0
+     *
+     * @param int    $user_id     The ID of the user the log is for.
+     * @param int    $points      The number of points awarded.
+     * @param string $points_type The points type.
+     * @param string $log_type    The log type.
+     * @param array  $meta        The metadata for this log.
+     * @param int    $date        The date the transaction took place.
+     */
+    protected function import_points_log( $user_id, $points, $points_type, $log_type, $meta, $date ) {
+
+        global $wpdb;
+
+        $result = $wpdb->insert(
+            $wpdb->wordpoints_points_logs,
+            array(
+                'user_id'     => $user_id,
+                'points'      => $points,
+                'points_type' => $points_type,
+                'log_type'    => $log_type,
+                'text'        => $this->render_points_log_text( '', $user_id, $points, $points_type, $log_type, $meta ),
+                'date'        => $date,
+                'site_id'     => $wpdb->siteid,
+                'blog_id'     => $wpdb->blogid,
+            ),
+            array( '%d', '%d', '%s', '%s', '%s', '%s', '%d', '%d' )
+        );
+
+        if ( false !== $result ) {
+
+            $log_id = (int) $wpdb->insert_id;
+
+            // Set auto_reversed and original_log_id metadata for reversed logs.
+            foreach ( $this->reversible_log_types as $reverse_type => $type ) {
+
+                if ( $meta['cubepoints_type'] === $type ) {
+
+                    // Save this log ID for later, in case this log was reversed.
+                    // cubepoints_data will contain the entity ID.
+                    $this->reversible_log_ids[ $type ][ $meta['cubepoints_data'] ] = $log_id;
+
+                } elseif (
+                    $meta['cubepoints_type'] === $reverse_type
+                    && isset( $this->reversible_log_ids[ $type ][ $meta['cubepoints_data'] ] )
+                ) {
+
+                    // This log was reverses another one. Set the original log ID.
+                    $meta['original_log_id'] = $this->reversible_log_ids[ $type ][ $meta['cubepoints_data'] ];
+
+                    // And mark the original as auto_reversed.
+                    wordpoints_add_points_log_meta( $meta['original_log_id'], 'auto_reversed', $log_id );
+
+                    // No need to keep this info anymore.
+                    unset( $this->reversible_log_ids[ $type ][ $meta['cubepoints_data'] ] );
+                }
+            }
+
+            // Set the entity IDs to their own meta keys, for the sake of reversals.
+            if ( isset( $this->log_type_entities[ $meta['cubepoints_type'] ] ) ) {
+                $meta[ $this->log_type_entities[ $meta['cubepoints_type'] ] ] = $meta['cubepoints_data'];
+            }
+
+            foreach ( $meta as $meta_key => $meta_value ) {
+
+                wordpoints_add_points_log_meta( $log_id, $meta_key, $meta_value );
+            }
+
+            do_action( 'wordpoints_points_log', $user_id, $points, $points_type, $log_type, $meta, $log_id );
+
+        } // End if ( inserted successfully ).
+    }
+
+    /**
+     * Generate the log text when importing a points log.
+     *
+     * @since 1.0.0
+     */
+    public function render_points_log_text( $text, $user_id, $points, $points_type, $log_type, $meta ) {
+
+        ob_start();
+        do_action( 'cp_logs_description', $meta['cubepoints_type'], $user_id, $points, $meta['cubepoints_data'] );
+        return ob_get_clean();
+    }
+
+    /**
+     * Get the next 500 points logs from CubePoints.
+     *
+     * @since 1.0.0
+     *
+     * @param int $start The offset number to begin counting the 500 at.
+     *
+     * @return object[]|false The rows from the database.
+     */
+    protected function get_next_points_logs_batch( $start ) {
+
+        global $wpdb;
+
+        $logs = $wpdb->get_results( // WPCS: unprepared SQL OK.
+            $wpdb->prepare( // WPCS: unprepared SQL OK.
+                '
 					SELECT *
 					FROM `' . CP_DB . '`
 					ORDER BY `id`
 					LIMIT %d,500
 				'
-				, $start
-			)
-		); // WPCS: cache OK.
+                , $start
+            )
+        ); // WPCS: cache OK.
 
-		if ( ! is_array( $logs ) ) {
-			$this->feedback->error( __( 'Unable to retrieve the logs from CubePoints…', 'wordpoints-importer' ) );
-			return false;
-		}
+        if ( ! is_array( $logs ) ) {
+            $this->feedback->error( __( 'Unable to retrieve the logs from CubePoints…', 'wordpoints-importer' ) );
+            return false;
+        }
 
-		return $logs;
-	}
+        return $logs;
+    }
 
-	/**
-	 * Import ranks.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @param array $settings The import settings for the ranks component.
-	 */
-	public function import_ranks( $settings ) {
+    /**
+     * Import ranks.
+     *
+     * @since 1.1.0
+     *
+     * @param array $settings The import settings for the ranks component.
+     */
+    public function import_ranks( $settings ) {
 
-		$this->feedback->info( __( 'Importing ranks…', 'wordpoints-importer' ) );
+        $this->feedback->info( __( 'Importing ranks…', 'wordpoints-importer' ) );
 
-		$ranks_data = get_option( 'cp_module_ranks_data' );
+        $ranks_data = get_option( 'cp_module_ranks_data' );
 
-		if ( empty( $ranks_data ) || ! is_array( $ranks_data ) ) {
-			$this->feedback->error( __( 'No ranks found.', 'wordpoints-importer' ) );
-			return;
-		}
+        if ( empty( $ranks_data ) || ! is_array( $ranks_data ) ) {
+            $this->feedback->error( __( 'No ranks found.', 'wordpoints-importer' ) );
+            return;
+        }
 
-		$i = 0;
+        $i = 0;
 
-		// The base rank already exists, so we just update it.
-		if ( isset( $ranks_data[0] ) ) {
+        // The base rank already exists, so we just update it.
+        if ( isset( $ranks_data[0] ) ) {
 
-			wordpoints_update_rank(
-				WordPoints_Rank_Groups::get_group( $settings['rank_group'] )->get_rank( 0 )
-				, $ranks_data[0]
-				, 'base'
-				, $settings['rank_group']
-				, 0
-			);
+            wordpoints_update_rank(
+                WordPoints_Rank_Groups::get_group( $settings['rank_group'] )->get_rank( 0 )
+                , $ranks_data[0]
+                , 'base'
+                , $settings['rank_group']
+                , 0
+            );
 
-			$i++;
+            $i++;
 
-			unset( $ranks_data[0] );
-		}
+            unset( $ranks_data[0] );
+        }
 
-		$points_type = substr( $settings['rank_group'], strlen( 'points_type-' ) );
-		$rank_type = 'points-' . $points_type;
+        $points_type = substr( $settings['rank_group'], strlen( 'points_type-' ) );
+        $rank_type = 'points-' . $points_type;
 
-		ksort( $ranks_data );
+        ksort( $ranks_data );
 
-		foreach ( $ranks_data as $points => $rank_name ) {
+        foreach ( $ranks_data as $points => $rank_name ) {
 
-			wordpoints_add_rank(
-				$rank_name
-				, $rank_type
-				, $settings['rank_group']
-				, $i
-				, array( 'points' => $points, 'points_type' => $points_type )
-			);
+            wordpoints_add_rank(
+                $rank_name
+                , $rank_type
+                , $settings['rank_group']
+                , $i
+                , array( 'points' => $points, 'points_type' => $points_type )
+            );
 
-			$i++;
-		}
+            $i++;
+        }
 
-		$this->feedback->success( sprintf( __( 'Imported %s ranks.', 'wordpoints-importer' ), $i ) );
-	}
+        $this->feedback->success( sprintf( __( 'Imported %s ranks.', 'wordpoints-importer' ), $i ) );
+    }
 }
 
 // EOF

src/includes/class-importer.php

Indentation +365 added lines, -365 removed lines

@@ -14,138 +14,138 @@ 
  */
 final class WordPoints_Importers {
 
-	//
-	// Private Vars.
-	//
-
-	/**
-	 * The registered importers.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @type array $importers
-	 */
-	private static $importers = array();
-
-	/**
-	 * Whether the class has been initialized yet.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @type bool $initialized
-	 */
-	private static $initialized = false;
-
-	//
-	// Private Functions.
-	//
-
-	/**
-	 * Initialize the class.
-	 *
-	 * @since 1.0.0
-	 */
-	private static function init() {
-
-		// We do this first so we avoid infinite loops if this class is called by a
-		// function hooked to the below action.
-		self::$initialized = true;
-
-		/**
-		 * Register importers.
-		 *
-		 * @since 1.0.0
-		 */
-		do_action( 'wordpoints_register_importers' );
-	}
-
-	//
-	// Public Functions.
-	//
-
-	/**
-	 * Get all of the registered importers.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @return array All of the registered importers.
-	 */
-	public static function get() {
-
-		if ( ! self::$initialized ) {
-			self::init();
-		}
-
-		return self::$importers;
-	}
-
-	/**
-	 * Register an importer.
-	 *
-	 * If the importer is already registered, it will be overwritten.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $slug The unique identifier for this importer.
-	 * @param array  $args {
-	 *        Other importer arguments.
-	 *
-	 *        @type string $class The Importer class.
-	 *        @type string $name  The name of this importer.
-	 * }
-	 */
-	public static function register( $slug, array $args ) {
-		self::$importers[ $slug ] = $args;
-	}
-
-	/**
-	 * Deregister an importer.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $slug The slug of the importer to deregister.
-	 */
-	public static function deregister( $slug ) {
-		unset( self::$importers[ $slug ] );
-	}
-
-	/**
-	 * Check if an importer is registered.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $slug The slug of the importer.
-	 *
-	 * @return bool True if the importer is registered, otherwise false.
-	 */
-	public static function is_registered( $slug ) {
-
-		if ( ! self::$initialized ) {
-			self::init();
-		}
-
-		return isset( self::$importers[ $slug ] );
-	}
-
-	/**
-	 * Get an instance of an importer.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $slug The slug of the importer to get an instance of.
-	 *
-	 * @return WordPoints_Importer|false The importer, or false if it isn't registered.
-	 */
-	public static function get_importer( $slug ) {
-
-		if ( ! self::is_registered( $slug ) ) {
-			return false;
-		}
-
-		$importer = self::$importers[ $slug ];
-
-		return new $importer['class']( $importer['name'] );
-	}
+    //
+    // Private Vars.
+    //
+
+    /**
+     * The registered importers.
+     *
+     * @since 1.0.0
+     *
+     * @type array $importers
+     */
+    private static $importers = array();
+
+    /**
+     * Whether the class has been initialized yet.
+     *
+     * @since 1.0.0
+     *
+     * @type bool $initialized
+     */
+    private static $initialized = false;
+
+    //
+    // Private Functions.
+    //
+
+    /**
+     * Initialize the class.
+     *
+     * @since 1.0.0
+     */
+    private static function init() {
+
+        // We do this first so we avoid infinite loops if this class is called by a
+        // function hooked to the below action.
+        self::$initialized = true;
+
+        /**
+         * Register importers.
+         *
+         * @since 1.0.0
+         */
+        do_action( 'wordpoints_register_importers' );
+    }
+
+    //
+    // Public Functions.
+    //
+
+    /**
+     * Get all of the registered importers.
+     *
+     * @since 1.0.0
+     *
+     * @return array All of the registered importers.
+     */
+    public static function get() {
+
+        if ( ! self::$initialized ) {
+            self::init();
+        }
+
+        return self::$importers;
+    }
+
+    /**
+     * Register an importer.
+     *
+     * If the importer is already registered, it will be overwritten.
+     *
+     * @since 1.0.0
+     *
+     * @param string $slug The unique identifier for this importer.
+     * @param array  $args {
+     *        Other importer arguments.
+     *
+     *        @type string $class The Importer class.
+     *        @type string $name  The name of this importer.
+     * }
+     */
+    public static function register( $slug, array $args ) {
+        self::$importers[ $slug ] = $args;
+    }
+
+    /**
+     * Deregister an importer.
+     *
+     * @since 1.0.0
+     *
+     * @param string $slug The slug of the importer to deregister.
+     */
+    public static function deregister( $slug ) {
+        unset( self::$importers[ $slug ] );
+    }
+
+    /**
+     * Check if an importer is registered.
+     *
+     * @since 1.0.0
+     *
+     * @param string $slug The slug of the importer.
+     *
+     * @return bool True if the importer is registered, otherwise false.
+     */
+    public static function is_registered( $slug ) {
+
+        if ( ! self::$initialized ) {
+            self::init();
+        }
+
+        return isset( self::$importers[ $slug ] );
+    }
+
+    /**
+     * Get an instance of an importer.
+     *
+     * @since 1.0.0
+     *
+     * @param string $slug The slug of the importer to get an instance of.
+     *
+     * @return WordPoints_Importer|false The importer, or false if it isn't registered.
+     */
+    public static function get_importer( $slug ) {
+
+        if ( ! self::is_registered( $slug ) ) {
+            return false;
+        }
+
+        $importer = self::$importers[ $slug ];
+
+        return new $importer['class']( $importer['name'] );
+    }
 }
 
 /**
@@ -155,239 +155,239 @@ 
  */
 abstract class WordPoints_Importer {
 
-	/**
-	 * The name of the importer.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @type string $name
-	 */
-	protected $name;
-
-	/**
-	 * The components supported by this importer.
-	 *
-	 * The keys are the component slugs, the values arrays of options for importing
-	 * to that component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @type array[] $components
-	 */
-	protected $components = array();
-
-	/**
-	 * The feedback provider object.
-	 *
-	 * This is only set by self::do_import().
-	 *
-	 * @since 1.0.0
-	 *
-	 * @type WordPoints_Importer_Feedback $feedback
-	 */
-	protected $feedback;
-
-	/**
-	 * Check if this importer is available.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @return true|WP_Error A WP_Error if the importer is not available.
-	 */
-	abstract public function is_available();
-
-	/**
-	 * Construct the importer.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $name The name of the importer.
-	 */
-	public function __construct( $name ) {
-
-		$this->name = $name;
-	}
-
-	/**
-	 * Check if this importer supports a specific component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $component The slug of a component.
-	 *
-	 * @return bool True if the component is supported, otherwise false.
-	 */
-	public function supports_component( $component ) {
-
-		return isset( $this->components[ $component ] );
-	}
-
-	/**
-	 * Get the import options for a component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $component The slug of a component.
-	 *
-	 * @return array[] The options for this component.
-	 */
-	public function get_options_for_component( $component ) {
-
-		if ( ! $this->supports_component( $component ) ) {
-			return array();
-		}
-
-		return $this->components[ $component ];
-	}
-
-	/**
-	 * Run the import.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param array                        $args     The settings for the import.
-	 * @param WordPoints_Importer_Feedback $feedback The feedback object.
-	 */
-	public function do_import( array $args, $feedback = null ) {
-
-		if ( ! ( $feedback instanceof WordPoints_Importer_Feedback ) ) {
-			$feedback = new WordPoints_Importer_Feedback;
-		}
-
-		$this->feedback = $feedback;
-
-		$this->feedback->info( sprintf( __( 'Importing from %s…', 'wordpoints-importer' ), $this->name ) );
-
-		$this->no_interruptions();
-
-		foreach ( $args as $component => $options ) {
-			$this->do_import_for_component( $component, $options );
-		}
-
-		$this->feedback->info( __( 'Import complete.', 'wordpoints-importer' ) );
-	}
-
-	/**
-	 * Prevent any interruptions from occurring during the import.
-	 *
-	 * @since 1.2.1
-	 */
-	protected function no_interruptions() {
-
-		ignore_user_abort( true );
-
-		if (
-			// Back-compat with WordPoints 2.1.
-			function_exists( 'wordpoints_is_function_disabled' )
-			&& ! wordpoints_is_function_disabled( 'set_time_limit' )
-		) {
-			set_time_limit( 0 );
-		}
-	}
-
-	/**
-	 * Validate the import settings for a component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $component The slug of the component.
-	 * @param array  $settings  The settings supplied for this component.
-	 *
-	 * @return bool Whether the settings are valid.
-	 */
-	protected function validate_import_settings( $component, $settings ) {
-
-		/**
-		 * Filter whether the settings are valid before importing.
-		 *
-		 * @since 1.0.0
-		 *
-		 * @param bool  $valid    Whether the settings are valid.
-		 * @param array $settings The settings for this component.
-		 * @param WordPoints_Importer_Feedback $feedback The feedback object.
-		 */
-		return apply_filters( "wordpoints_import_settings_valid-{$component}", true, $settings, $this->feedback );
-	}
-
-	/**
-	 * Run the import for a component.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $component The component to run the import for.
-	 * @param array  $options   The selected options of what to import.
-	 */
-	protected function do_import_for_component( $component, $options ) {
-
-		$component_data = WordPoints_Components::instance()->get_component(
-			$component
-		);
-
-		if ( false === $component_data ) {
-			$this->feedback->warning( sprintf( __( 'Skipping %s component—not installed.', 'wordpoints-importer' ), esc_html( $component ) ) );
-			return;
-		}
-
-		if ( true !== $this->supports_component( $component ) ) {
-			$this->feedback->warning( sprintf( __( 'Skipping the %s component—not supported.', 'wordpoints-importer' ), $component_data['name'] ) );
-			return;
-		}
-
-		$settings = array();
-
-		if ( isset( $options['_data'] ) ) {
-			$settings = $options['_data'];
-			unset( $options['_data'] );
-		}
-
-		if ( empty( $options ) || ! $this->validate_import_settings( $component, $settings ) ) {
-			return;
-		}
-
-		$this->feedback->info( sprintf( __( 'Importing data to the %s component…', 'wordpoints-importer' ), $component_data['name'] ) );
-
-		foreach ( $options as $option => $unused ) {
-			$this->do_import_for_option( $option, $component, $settings );
-		}
-	}
-
-	/**
-	 * Run the import for an option.
-	 *
-	 * The import is split up into different options which the user can select (these
-	 * are displayed to the user as checkboxes in the form). This handles the import
-	 * for each of the individual things the user has selected to import. These are
-	 * all optional, so each is just termed an import "option" here.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $option    An import option that has been selected.
-	 * @param string $component The component this option is for.
-	 * @param array  $settings  Other settings for this component.
-	 */
-	protected function do_import_for_option( $option, $component, $settings ) {
-
-		if ( ! isset( $this->components[ $component ][ $option ] ) ) {
-			$this->feedback->warning( sprintf( __( 'Skipping unrecognized import option “%s”…', 'wordpoints-importer' ), $option ) );
-			return;
-		}
-
-		$option_data = $this->components[ $component ][ $option ];
-
-		// Check if we can actually run this option.
-		if ( isset( $option_data['can_import'] ) ) {
-
-			$cant_import = call_user_func( $option_data['can_import'], $settings );
-
-			if ( is_wp_error( $cant_import ) ) {
-				$this->feedback->warning( sprintf( __( 'Skipping importing %1$s. Reason: %2$s', 'wordpoints-importer' ), $option_data['label'], $cant_import->get_error_message() ) );
-				return;
-			}
-		}
-
-		// OK, we can run the import method for this option.
-		call_user_func( $option_data['function'], $settings );
-	}
+    /**
+     * The name of the importer.
+     *
+     * @since 1.0.0
+     *
+     * @type string $name
+     */
+    protected $name;
+
+    /**
+     * The components supported by this importer.
+     *
+     * The keys are the component slugs, the values arrays of options for importing
+     * to that component.
+     *
+     * @since 1.0.0
+     *
+     * @type array[] $components
+     */
+    protected $components = array();
+
+    /**
+     * The feedback provider object.
+     *
+     * This is only set by self::do_import().
+     *
+     * @since 1.0.0
+     *
+     * @type WordPoints_Importer_Feedback $feedback
+     */
+    protected $feedback;
+
+    /**
+     * Check if this importer is available.
+     *
+     * @since 1.0.0
+     *
+     * @return true|WP_Error A WP_Error if the importer is not available.
+     */
+    abstract public function is_available();
+
+    /**
+     * Construct the importer.
+     *
+     * @since 1.0.0
+     *
+     * @param string $name The name of the importer.
+     */
+    public function __construct( $name ) {
+
+        $this->name = $name;
+    }
+
+    /**
+     * Check if this importer supports a specific component.
+     *
+     * @since 1.0.0
+     *
+     * @param string $component The slug of a component.
+     *
+     * @return bool True if the component is supported, otherwise false.
+     */
+    public function supports_component( $component ) {
+
+        return isset( $this->components[ $component ] );
+    }
+
+    /**
+     * Get the import options for a component.
+     *
+     * @since 1.0.0
+     *
+     * @param string $component The slug of a component.
+     *
+     * @return array[] The options for this component.
+     */
+    public function get_options_for_component( $component ) {
+
+        if ( ! $this->supports_component( $component ) ) {
+            return array();
+        }
+
+        return $this->components[ $component ];
+    }
+
+    /**
+     * Run the import.
+     *
+     * @since 1.0.0
+     *
+     * @param array                        $args     The settings for the import.
+     * @param WordPoints_Importer_Feedback $feedback The feedback object.
+     */
+    public function do_import( array $args, $feedback = null ) {
+
+        if ( ! ( $feedback instanceof WordPoints_Importer_Feedback ) ) {
+            $feedback = new WordPoints_Importer_Feedback;
+        }
+
+        $this->feedback = $feedback;
+
+        $this->feedback->info( sprintf( __( 'Importing from %s…', 'wordpoints-importer' ), $this->name ) );
+
+        $this->no_interruptions();
+
+        foreach ( $args as $component => $options ) {
+            $this->do_import_for_component( $component, $options );
+        }
+
+        $this->feedback->info( __( 'Import complete.', 'wordpoints-importer' ) );
+    }
+
+    /**
+     * Prevent any interruptions from occurring during the import.
+     *
+     * @since 1.2.1
+     */
+    protected function no_interruptions() {
+
+        ignore_user_abort( true );
+
+        if (
+            // Back-compat with WordPoints 2.1.
+            function_exists( 'wordpoints_is_function_disabled' )
+            && ! wordpoints_is_function_disabled( 'set_time_limit' )
+        ) {
+            set_time_limit( 0 );
+        }
+    }
+
+    /**
+     * Validate the import settings for a component.
+     *
+     * @since 1.0.0
+     *
+     * @param string $component The slug of the component.
+     * @param array  $settings  The settings supplied for this component.
+     *
+     * @return bool Whether the settings are valid.
+     */
+    protected function validate_import_settings( $component, $settings ) {
+
+        /**
+         * Filter whether the settings are valid before importing.
+         *
+         * @since 1.0.0
+         *
+         * @param bool  $valid    Whether the settings are valid.
+         * @param array $settings The settings for this component.
+         * @param WordPoints_Importer_Feedback $feedback The feedback object.
+         */
+        return apply_filters( "wordpoints_import_settings_valid-{$component}", true, $settings, $this->feedback );
+    }
+
+    /**
+     * Run the import for a component.
+     *
+     * @since 1.0.0
+     *
+     * @param string $component The component to run the import for.
+     * @param array  $options   The selected options of what to import.
+     */
+    protected function do_import_for_component( $component, $options ) {
+
+        $component_data = WordPoints_Components::instance()->get_component(
+            $component
+        );
+
+        if ( false === $component_data ) {
+            $this->feedback->warning( sprintf( __( 'Skipping %s component—not installed.', 'wordpoints-importer' ), esc_html( $component ) ) );
+            return;
+        }
+
+        if ( true !== $this->supports_component( $component ) ) {
+            $this->feedback->warning( sprintf( __( 'Skipping the %s component—not supported.', 'wordpoints-importer' ), $component_data['name'] ) );
+            return;
+        }
+
+        $settings = array();
+
+        if ( isset( $options['_data'] ) ) {
+            $settings = $options['_data'];
+            unset( $options['_data'] );
+        }
+
+        if ( empty( $options ) || ! $this->validate_import_settings( $component, $settings ) ) {
+            return;
+        }
+
+        $this->feedback->info( sprintf( __( 'Importing data to the %s component…', 'wordpoints-importer' ), $component_data['name'] ) );
+
+        foreach ( $options as $option => $unused ) {
+            $this->do_import_for_option( $option, $component, $settings );
+        }
+    }
+
+    /**
+     * Run the import for an option.
+     *
+     * The import is split up into different options which the user can select (these
+     * are displayed to the user as checkboxes in the form). This handles the import
+     * for each of the individual things the user has selected to import. These are
+     * all optional, so each is just termed an import "option" here.
+     *
+     * @since 1.0.0
+     *
+     * @param string $option    An import option that has been selected.
+     * @param string $component The component this option is for.
+     * @param array  $settings  Other settings for this component.
+     */
+    protected function do_import_for_option( $option, $component, $settings ) {
+
+        if ( ! isset( $this->components[ $component ][ $option ] ) ) {
+            $this->feedback->warning( sprintf( __( 'Skipping unrecognized import option “%s”…', 'wordpoints-importer' ), $option ) );
+            return;
+        }
+
+        $option_data = $this->components[ $component ][ $option ];
+
+        // Check if we can actually run this option.
+        if ( isset( $option_data['can_import'] ) ) {
+
+            $cant_import = call_user_func( $option_data['can_import'], $settings );
+
+            if ( is_wp_error( $cant_import ) ) {
+                $this->feedback->warning( sprintf( __( 'Skipping importing %1$s. Reason: %2$s', 'wordpoints-importer' ), $option_data['label'], $cant_import->get_error_message() ) );
+                return;
+            }
+        }
+
+        // OK, we can run the import method for this option.
+        call_user_func( $option_data['function'], $settings );
+    }
 }
 
 // EOF

src/admin/admin.php

Indentation +106 added lines, -106 removed lines

@@ -14,23 +14,23 @@ 
  */
 function wordpoints_importer_admin_menu() {
 
-	add_submenu_page(
-		wordpoints_get_main_admin_menu()
-		,__( 'WordPoints — Import', 'wordpoints-importer' )
-		,__( 'Import', 'wordpoints-importer' )
-		,'manage_options'
-		,'wordpoints_import'
-		,'wordpoints_import_admin_screen'
-	);
-
-	add_submenu_page(
-		'_wordpoints_import' // Fake.
-		,__( 'WordPoints — Importing', 'wordpoints-importer' )
-		,__( 'Importing', 'wordpoints-importer' )
-		,'manage_options'
-		,'wordpoints_importing'
-		,'wordpoints_importing_admin_screen'
-	);
+    add_submenu_page(
+        wordpoints_get_main_admin_menu()
+        ,__( 'WordPoints — Import', 'wordpoints-importer' )
+        ,__( 'Import', 'wordpoints-importer' )
+        ,'manage_options'
+        ,'wordpoints_import'
+        ,'wordpoints_import_admin_screen'
+    );
+
+    add_submenu_page(
+        '_wordpoints_import' // Fake.
+        ,__( 'WordPoints — Importing', 'wordpoints-importer' )
+        ,__( 'Importing', 'wordpoints-importer' )
+        ,'manage_options'
+        ,'wordpoints_importing'
+        ,'wordpoints_importing_admin_screen'
+    );
 }
 add_action( 'admin_menu', 'wordpoints_importer_admin_menu' );
 add_action( 'network_admin_menu', 'wordpoints_importer_admin_menu' );
@@ -42,12 +42,12 @@ 
  */
 function wordpoints_import_admin_screen() {
 
-	/**
-	 * The importer admin screen.
-	 *
-	 * @since 1.0.0
-	 */
-	require( dirname( __FILE__ ) . '/screens/import.php' );
+    /**
+     * The importer admin screen.
+     *
+     * @since 1.0.0
+     */
+    require( dirname( __FILE__ ) . '/screens/import.php' );
 }
 
 /**
@@ -57,12 +57,12 @@ 
  */
 function wordpoints_importing_admin_screen() {
 
-	/**
-	 * The importer admin screen.
-	 *
-	 * @since 1.0.0
-	 */
-	require( dirname( __FILE__ ) . '/screens/importing.php' );
+    /**
+     * The importer admin screen.
+     *
+     * @since 1.0.0
+     */
+    require( dirname( __FILE__ ) . '/screens/importing.php' );
 }
 
 /**
@@ -72,15 +72,15 @@ 
  */
 function wordpoints_importer_register_admin_scripts() {
 
-	$assets_url = wordpoints_modules_url(
-		'admin/assets'
-		, dirname( dirname( __FILE__ ) ) . '/importer.php'
-	);
+    $assets_url = wordpoints_modules_url(
+        'admin/assets'
+        , dirname( dirname( __FILE__ ) ) . '/importer.php'
+    );
 
-	wp_register_style(
-		'wordpoints-importer-feedback'
-		, $assets_url . '/css/feedback.css'
-	);
+    wp_register_style(
+        'wordpoints-importer-feedback'
+        , $assets_url . '/css/feedback.css'
+    );
 }
 add_action( 'init', 'wordpoints_importer_register_admin_scripts' );
 
@@ -91,41 +91,41 @@ 
  */
 function wordpoints_importer_do_import() {
 
-	if ( ! defined( 'IFRAME_REQUEST' ) ) {
-		define( 'IFRAME_REQUEST', true );
-	}
+    if ( ! defined( 'IFRAME_REQUEST' ) ) {
+        define( 'IFRAME_REQUEST', true );
+    }
 
-	if ( ! current_user_can( 'manage_options' ) ) {
-		wp_die( esc_html__( 'Sorry, you are not allowed to import to WordPoints.', 'wordpoints-importer' ) );
-	}
+    if ( ! current_user_can( 'manage_options' ) ) {
+        wp_die( esc_html__( 'Sorry, you are not allowed to import to WordPoints.', 'wordpoints-importer' ) );
+    }
 
-	check_admin_referer( 'wordpoints_import' );
+    check_admin_referer( 'wordpoints_import' );
 
-	if ( ! isset( $_GET['importer'] ) ) {
-		wp_die( esc_html__( 'No importer selected.', 'wordpoints-importer' ) );
-	}
+    if ( ! isset( $_GET['importer'] ) ) {
+        wp_die( esc_html__( 'No importer selected.', 'wordpoints-importer' ) );
+    }
 
-	$importer = WordPoints_Importers::get_importer(
-		sanitize_key( $_GET['importer'] )
-	);
+    $importer = WordPoints_Importers::get_importer(
+        sanitize_key( $_GET['importer'] )
+    );
 
-	if ( ! ( $importer instanceof WordPoints_Importer ) ) {
-		wp_die( esc_html__( 'Importer not installed.', 'wordpoints-importer' ) );
-	}
+    if ( ! ( $importer instanceof WordPoints_Importer ) ) {
+        wp_die( esc_html__( 'Importer not installed.', 'wordpoints-importer' ) );
+    }
 
-	wp_enqueue_style( 'wordpoints-importer-feedback' );
+    wp_enqueue_style( 'wordpoints-importer-feedback' );
 
-	$args = array();
+    $args = array();
 
-	if ( isset( $_GET['wordpoints_import'] ) && is_array( $_GET['wordpoints_import'] ) ) {
-		$args = wp_unslash( $_GET['wordpoints_import'] ); // WPCS: sanitization OK.
-	}
+    if ( isset( $_GET['wordpoints_import'] ) && is_array( $_GET['wordpoints_import'] ) ) {
+        $args = wp_unslash( $_GET['wordpoints_import'] ); // WPCS: sanitization OK.
+    }
 
-	iframe_header();
+    iframe_header();
 
-	$importer->do_import( $args );
+    $importer->do_import( $args );
 
-	iframe_footer();
+    iframe_footer();
 }
 add_action( 'update-custom_wordpoints_import', 'wordpoints_importer_do_import' );
 
@@ -136,9 +136,9 @@ 
  */
 function wordpoints_importer_admin_screen_points_type_select() {
 
-	$args = array( 'name' => 'wordpoints_import[points][_data][points_type]' );
+    $args = array( 'name' => 'wordpoints_import[points][_data][points_type]' );
 
-	?>
+    ?>
 
 	<p>
 		<label for="wordpoints_import[points][_data][points_type]">
@@ -150,8 +150,8 @@ 
 	<?php
 }
 add_action(
-	'wordpoints_importer_before_component_options-points'
-	, 'wordpoints_importer_admin_screen_points_type_select'
+    'wordpoints_importer_before_component_options-points'
+    , 'wordpoints_importer_admin_screen_points_type_select'
 );
 
 /**
@@ -167,24 +167,24 @@ 
  */
 function wordpoints_importer_validate_points_type_setting( $valid, $settings, $feedback ) {
 
-	if ( $valid ) {
+    if ( $valid ) {
 
-		if ( ! isset( $settings['points_type'] ) ) {
-			$feedback->warning( __( 'Skipping Points component—no points type specified.', 'wordpoints-importer' ) );
-			$valid = false;
-		} elseif ( ! wordpoints_is_points_type( $settings['points_type'] ) ) {
-			$feedback->warning( __( 'Skipping Points component—invalid points type selected.', 'wordpoints-importer' ) );
-			$valid = false;
-		}
-	}
+        if ( ! isset( $settings['points_type'] ) ) {
+            $feedback->warning( __( 'Skipping Points component—no points type specified.', 'wordpoints-importer' ) );
+            $valid = false;
+        } elseif ( ! wordpoints_is_points_type( $settings['points_type'] ) ) {
+            $feedback->warning( __( 'Skipping Points component—invalid points type selected.', 'wordpoints-importer' ) );
+            $valid = false;
+        }
+    }
 
-	return $valid;
+    return $valid;
 }
 add_action(
-	'wordpoints_import_settings_valid-points'
-	, 'wordpoints_importer_validate_points_type_setting'
-	, 10
-	, 3
+    'wordpoints_import_settings_valid-points'
+    , 'wordpoints_importer_validate_points_type_setting'
+    , 10
+    , 3
 );
 
 /**
@@ -194,20 +194,20 @@ 
  */
 function wordpoints_importer_admin_screen_rank_group_select() {
 
-	$rank_groups = WordPoints_Rank_Groups::get();
+    $rank_groups = WordPoints_Rank_Groups::get();
 
-	// See https://github.com/WordPoints/wordpoints/issues/310.
-	$options = array();
-	foreach ( $rank_groups as $rank_group ) {
-		$options[ $rank_group->slug ] = $rank_group->name;
-	}
+    // See https://github.com/WordPoints/wordpoints/issues/310.
+    $options = array();
+    foreach ( $rank_groups as $rank_group ) {
+        $options[ $rank_group->slug ] = $rank_group->name;
+    }
 
-	$dropdown = new WordPoints_Dropdown_Builder(
-		$options
-		, array( 'name' => 'wordpoints_import[ranks][_data][rank_group]' )
-	);
+    $dropdown = new WordPoints_Dropdown_Builder(
+        $options
+        , array( 'name' => 'wordpoints_import[ranks][_data][rank_group]' )
+    );
 
-	?>
+    ?>
 
 	<p>
 		<label for="wordpoints_import[ranks][_data][rank_group]">
@@ -219,8 +219,8 @@ 
 <?php
 }
 add_action(
-	'wordpoints_importer_before_component_options-ranks'
-	, 'wordpoints_importer_admin_screen_rank_group_select'
+    'wordpoints_importer_before_component_options-ranks'
+    , 'wordpoints_importer_admin_screen_rank_group_select'
 );
 
 /**
@@ -236,24 +236,24 @@ 
  */
 function wordpoints_importer_validate_rank_group_setting( $valid, $settings, $feedback ) {
 
-	if ( $valid ) {
+    if ( $valid ) {
 
-		if ( ! isset( $settings['rank_group'] ) ) {
-			$feedback->warning( __( 'Skipping Ranks component—no rank group specified.', 'wordpoints-importer' ) );
-			$valid = false;
-		} elseif ( ! WordPoints_Rank_Groups::is_group_registered( $settings['rank_group'] ) ) {
-			$feedback->warning( __( 'Skipping Ranks component—invalid rank group selected.', 'wordpoints-importer' ) );
-			$valid = false;
-		}
-	}
+        if ( ! isset( $settings['rank_group'] ) ) {
+            $feedback->warning( __( 'Skipping Ranks component—no rank group specified.', 'wordpoints-importer' ) );
+            $valid = false;
+        } elseif ( ! WordPoints_Rank_Groups::is_group_registered( $settings['rank_group'] ) ) {
+            $feedback->warning( __( 'Skipping Ranks component—invalid rank group selected.', 'wordpoints-importer' ) );
+            $valid = false;
+        }
+    }
 
-	return $valid;
+    return $valid;
 }
 add_action(
-	'wordpoints_import_settings_valid-ranks'
-	, 'wordpoints_importer_validate_rank_group_setting'
-	, 10
-	, 3
+    'wordpoints_import_settings_valid-ranks'
+    , 'wordpoints_importer_validate_rank_group_setting'
+    , 10
+    , 3
 );
 
 // EOF

tests/phpunit/includes/functions.php

Indentation +31 added lines, -31 removed lines

@@ -19,22 +19,22 @@ 
 // Back-compat with WordPoints 2.1.
 if ( class_exists( 'WordPoints_PHPUnit_Bootstrap_Loader' ) ) {
 
-	$loader = WordPoints_PHPUnit_Bootstrap_Loader::instance();
-	$loader->add_plugin( 'cubepoints/cubepoints.php' );
-	$loader->add_php_file(
-		WORDPOINTS_IMPORTER_TESTS_DIR . '/includes/activate-cubepoints-components.php'
-		, 'after'
-		, array( 'dailypoints', 'post_author_points' )
-	);
+    $loader = WordPoints_PHPUnit_Bootstrap_Loader::instance();
+    $loader->add_plugin( 'cubepoints/cubepoints.php' );
+    $loader->add_php_file(
+        WORDPOINTS_IMPORTER_TESTS_DIR . '/includes/activate-cubepoints-components.php'
+        , 'after'
+        , array( 'dailypoints', 'post_author_points' )
+    );
 
 } elseif ( ! defined( 'WORDPOINTS_MODULE_TESTS_LOADER' ) ) {
 
-	/**
-	 * The function that loads the module for the tests.
-	 *
-	 * @since 1.0.0
-	 */
-	define( 'WORDPOINTS_MODULE_TESTS_LOADER', 'wordpoints_importer_tests_manually_load_module' );
+    /**
+     * The function that loads the module for the tests.
+     *
+     * @since 1.0.0
+     */
+    define( 'WORDPOINTS_MODULE_TESTS_LOADER', 'wordpoints_importer_tests_manually_load_module' );
 }
 
 /**
@@ -45,10 +45,10 @@ 
  */
 function wordpoints_importer_tests_manually_load_module() {
 
-	require( WORDPOINTS_IMPORTER_TESTS_DIR . '/../../src/importer.php' );
-	require( WORDPOINTS_IMPORTER_TESTS_DIR . '/../../src/admin/admin.php' );
+    require( WORDPOINTS_IMPORTER_TESTS_DIR . '/../../src/importer.php' );
+    require( WORDPOINTS_IMPORTER_TESTS_DIR . '/../../src/admin/admin.php' );
 
-	wordpoints_importer_tests_manually_load_cubepoints();
+    wordpoints_importer_tests_manually_load_cubepoints();
 }
 
 /**
@@ -59,25 +59,25 @@ 
  */
 function wordpoints_importer_tests_manually_load_cubepoints() {
 
-	require( WP_PLUGIN_DIR . '/cubepoints/cubepoints.php' );
+    require( WP_PLUGIN_DIR . '/cubepoints/cubepoints.php' );
 
-	cp_activate();
+    cp_activate();
 
-	// We activate these now so that they will be fully loaded. Otherwise only part
-	// of their functions will be loaded, as the rest are defined in a conditional.
-	// Because of some of the functions are defined outside of the conditional, there
-	// is no way for us to load the functions later without a fatal error from
-	// "already defined function".
-	cp_module_activation_set( 'dailypoints', 'active' );
-	cp_module_activation_set( 'post_author_points', 'active' );
+    // We activate these now so that they will be fully loaded. Otherwise only part
+    // of their functions will be loaded, as the rest are defined in a conditional.
+    // Because of some of the functions are defined outside of the conditional, there
+    // is no way for us to load the functions later without a fatal error from
+    // "already defined function".
+    cp_module_activation_set( 'dailypoints', 'active' );
+    cp_module_activation_set( 'post_author_points', 'active' );
 
-	// We have to do this manually here after WordPress 4.7.
-	// https://core.trac.wordpress.org/ticket/38011#comment:3
-	global $wp_version;
+    // We have to do this manually here after WordPress 4.7.
+    // https://core.trac.wordpress.org/ticket/38011#comment:3
+    global $wp_version;
 
-	if ( version_compare( $wp_version, '4.6', '>' ) ) {
-		cp_modules_include();
-	}
+    if ( version_compare( $wp_version, '4.6', '>' ) ) {
+        cp_modules_include();
+    }
 }
 
 // EOF

tests/phpunit/includes/activate-cubepoints-components.php

Indentation +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  */
 
 foreach ( $data as $module_slug ) {
-	cp_module_activation_set( $module_slug, 'active' );
+    cp_module_activation_set( $module_slug, 'active' );
 }
 
 // EOF

tests/phpunit/tests/importers/cubepoints.php

Indentation +845 added lines, -845 removed lines

@@ -17,856 +17,856 @@
  */
 class WordPoints_CubePoints_Importer_Test extends WordPoints_Points_UnitTestCase {
 
-	/**
-	 * The importer used in the tests.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @var WordPoints_CubePoints_Importer
-	 */
-	protected $importer;
-
-	/**
-	 * @since 1.0.0
-	 */
-	public function setUp() {
-
-		parent::setUp();
-
-		// These are usually inactive by default. We activate them in the tests
-		// bootstrap so that they will be fully loaded, but deactivate them here to
-		// restore default behavior.
-		cp_module_activation_set( 'post_author_points', false );
-		cp_module_activation_set( 'dailypoints', false );
-
-		$this->importer = new WordPoints_CubePoints_Importer( 'Test CubePoints' );
-	}
-
-	/**
-	 * @since 1.1.0
-	 */
-	public function tearDown() {
-
-		WordPoints_Rank_Groups::deregister_group( 'points_type-points' );
-		WordPoints_Rank_Types::deregister_type( 'points-points' );
-
-		parent::tearDown();
-	}
-
-	/**
-	 * Test that it returns true when CubePoints is installed.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::is_cubepoints_installed
-	 */
-	public function test_is_cubepoints_installed() {
-
-		$this->assertTrue( $this->importer->is_cubepoints_installed() );
-	}
-
-	/**
-	 * Test that it returns false when CubePoints is not installed.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::is_cubepoints_installed
-	 */
-	public function test_is_cubepoints_not_installed() {
-
-		delete_option( 'cp_db_version' );
-
-		$this->assertFalse( $this->importer->is_cubepoints_installed() );
-	}
-
-	/**
-	 * Test that it returns true when CubePoints is installed.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::is_available
-	 */
-	public function test_is_cubepoints_is_available() {
-
-		$this->assertTrue( $this->importer->is_available() );
-	}
-
-	/**
-	 * Test that it returns a WP_Error when CubePoints is not installed.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::is_available
-	 */
-	public function test_is_cubepoints_not_available() {
-
-		delete_option( 'cp_db_version' );
-
-		$this->assertWPError( $this->importer->is_available() );
-	}
-
-	/**
-	 * Test that it returns true when CubePoints is active.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::is_cubepoints_active
-	 */
-	public function test_is_cubepoints_active() {
-
-		$this->assertEquals(
-			function_exists( 'cp_ready' )
-			, $this->importer->is_cubepoints_active()
-		);
-	}
-
-	/**
-	 * Test importing the excluded users.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_excluded_users
-	 */
-	public function test_import_excluded_users() {
-
-		$user_ids = $this->factory->user->create_many( 3 );
-		$user_logins = array();
-
-		foreach ( $user_ids as $user_id ) {
-			$user_logins[] = get_userdata( $user_id )->user_login;
-		}
-
-		update_option( 'cp_topfilter', $user_logins );
-
-		$this->do_points_import( 'excluded_users' );
-
-		$this->assertEquals(
-			$user_ids
-			, wordpoints_get_excluded_users( 'tests' )
-		);
-	}
-
-	/**
-	 * Test importing the excluded users gives a warning if there are none.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_excluded_users
-	 */
-	public function test_import_excluded_users_none() {
-
-		delete_option( 'cp_topfilter' );
-
-		$feedback = new WordPoints_Importer_Tests_Feedback();
-
-		$this->importer->do_import(
-			array(
-				'points' => array(
-					'excluded_users' => '1',
-					'_data' => array( 'points_type' => 'points' ),
-				),
-			)
-			, $feedback
-		);
-
-		$this->assertCount( 1, $feedback->messages['warning'] );
-	}
-
-	/**
-	 * Test importing the points settings to points hooks.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_points_settings
-	 * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
-	 * @covers WordPoints_CubePoints_Importer::format_settings_for_post_type
-	 */
-	public function test_import_points_settings() {
-
-		update_option( 'cp_comment_points',     10 );
-		update_option( 'cp_post_points',        20 );
-		update_option( 'cp_reg_points',         50 );
-
-		$this->do_points_import( 'settings' );
-
-		$this->assertHookImported(
-			array(
-				'event' => 'comment_leave\post',
-				'target' => array( 'comment\post', 'author', 'user' ),
-				'reactor' => 'points_legacy',
-				'points' => 10,
-				'points_type' => 'points',
-				'log_text' => 'Comment on a Post.',
-				'description' => 'Commenting on a Post.',
-				'legacy_log_type' => 'cubepoints-comment',
-				'legacy_meta_key' => 'comment',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-			)
-		);
-
-		$this->assertHookImported(
-			array(
-				'event' => 'comment_leave\page',
-				'target' => array( 'comment\page', 'author', 'user' ),
-				'reactor' => 'points_legacy',
-				'points' => 10,
-				'points_type' => 'points',
-				'log_text' => 'Comment on a Page.',
-				'description' => 'Commenting on a Page.',
-				'legacy_log_type' => 'cubepoints-comment',
-				'legacy_meta_key' => 'comment',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-			)
-		);
-
-		$this->assertHookImported(
-			array(
-				'event' => 'comment_leave\attachment',
-				'target' => array( 'comment\attachment', 'author', 'user' ),
-				'reactor' => 'points_legacy',
-				'points' => 10,
-				'points_type' => 'points',
-				'log_text' => 'Comment on a Media.',
-				'description' => 'Commenting on a Media.',
-				'legacy_log_type' => 'cubepoints-comment',
-				'legacy_meta_key' => 'comment',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-			)
-		);
-
-		$this->assertHookImported(
-			array(
-				'event' => 'post_publish\post',
-				'target' => array( 'post\post', 'author', 'user' ),
-				'reactor' => 'points_legacy',
-				'points' => 20,
-				'points_type' => 'points',
-				'log_text' => 'Published a Post.',
-				'description' => 'Publishing a Post.',
-				'blocker' => array( 'toggle_off' => true ),
-				'legacy_log_type' => 'cubepoints-post',
-				'legacy_meta_key' => 'post',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-				'points_legacy_repeat_blocker' => array( 'toggle_on' => true ),
-			)
-		);
-
-		$reaction_store = wordpoints_hooks()->get_reaction_store( 'points' );
-
-		$this->assertEmpty(
-			$reaction_store->get_reactions_to_event( 'post_publish\page' )
-		);
-
-		$this->assertEmpty(
-			$reaction_store->get_reactions_to_event( 'post_publish\attachment' )
-		);
-
-		$this->assertEmpty(
-			$reaction_store->get_reactions_to_event( 'media_upload' )
-		);
-
-		$this->assertHookImported(
-			array(
-				'event' => 'user_register',
-				'target' => array( 'user' ),
-				'reactor' => 'points_legacy',
-				'points' => 50,
-				'points_type' => 'points',
-				'log_text' => 'Registration.',
-				'description' => 'Registration.',
-				'legacy_log_type' => 'cubepoints-register',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-			)
-		);
-	}
-
-	/**
-	 * Test that it imports legacy points hooks on install.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @coversNothing
-	 */
-	public function test_imported_post_points_hook_does_not_refire() {
-
-		update_option( 'cp_post_points', 20 );
-
-		$user_id = $this->factory->user->create();
-		$post_id = $this->factory->post->create(
-			array(
-				'post_author' => $user_id,
-				'post_type'   => 'post',
-			)
-		);
-
-		$this->assertEquals( 120, cp_getPoints( $user_id ) );
-
-		$this->factory->post->update_object(
-			$post_id
-			, array( 'post_status' => 'draft' )
-		);
-
-		$this->assertEquals( 120, cp_getPoints( $user_id ) );
-
-		$this->do_points_import( 'settings' );
-		$this->do_points_import( 'user_points' );
-		$this->do_points_import( 'logs' );
-
-		$this->assertEquals(
-			120
-			, wordpoints_get_points( $user_id, 'points' )
-		);
-
-		$this->factory->post->update_object(
-			$post_id
-			, array( 'post_status' => 'publish' )
-		);
-
-		$this->assertEquals(
-			120
-			, wordpoints_get_points( $user_id, 'points' )
-		);
-	}
-
-	/**
-	 * Test importing the settings from the post author points module to points hooks.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_points_settings
-	 * @covers WordPoints_CubePoints_Importer::format_settings_for_post_type
-	 */
-	public function test_import_post_author_points() {
-
-		cp_module_activation_set( 'post_author_points', 'active' );
-
-		update_option( 'cp_post_author_points', 15 );
-
-		$this->do_points_import( 'settings' );
-
-		$this->assertHookImported(
-			array(
-				'event' => 'comment_leave\post',
-				'target' => array( 'comment\post', 'post\post', 'post\post', 'author', 'user' ),
-				'reactor' => 'points_legacy',
-				'points' => 15,
-				'points_type' => 'points',
-				'log_text' => 'Received a comment on a Post.',
-				'description' => 'Receiving a comment on a Post.',
-				'legacy_log_type' => 'cubepoints-post_author',
-				'legacy_meta_key' => 'comment',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-			)
-		);
-
-		$this->assertHookImported(
-			array(
-				'event' => 'comment_leave\page',
-				'target' => array( 'comment\page', 'post\page', 'post\page', 'author', 'user' ),
-				'reactor' => 'points_legacy',
-				'points' => 15,
-				'points_type' => 'points',
-				'log_text' => 'Received a comment on a Page.',
-				'description' => 'Receiving a comment on a Page.',
-				'legacy_log_type' => 'cubepoints-post_author',
-				'legacy_meta_key' => 'comment',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-			)
-		);
-
-		$this->assertHookImported(
-			array(
-				'event' => 'comment_leave\attachment',
-				'target' => array( 'comment\attachment', 'post\attachment', 'post\attachment', 'author', 'user' ),
-				'reactor' => 'points_legacy',
-				'points' => 15,
-				'points_type' => 'points',
-				'log_text' => 'Received a comment on a Media.',
-				'description' => 'Receiving a comment on a Media.',
-				'legacy_log_type' => 'cubepoints-post_author',
-				'legacy_meta_key' => 'comment',
-				'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
-			)
-		);
-	}
-
-	/**
-	 * Test importing the settings from the daily points module to points hooks.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_points_settings
-	 * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
-	 */
-	public function test_import_periodic_points() {
-
-		cp_module_activation_set( 'dailypoints', 'active' );
-
-		update_option( 'cp_module_dailypoints_points', 30 );
-		update_option( 'cp_module_dailypoints_time', DAY_IN_SECONDS );
-
-		$this->do_points_import( 'settings' );
-
-		$this->assertHookImported(
-			array(
-				'event' => 'user_visit',
-				'target' => array( 'current:user' ),
-				'reactor' => 'points_legacy',
-				'points' => 30,
-				'points_type' => 'points',
-				'log_text' => 'Visiting the site.',
-				'description' => 'Visiting the site.',
-				'points_legacy_periods' => array(
-					'fire' => array(
-						array(
-							'length' => DAY_IN_SECONDS,
-							'args' => array( array( 'current:user' ) ),
-							'relative' => true,
-						),
-					),
-				),
-				'points_legacy_reversals' => array(),
-				'legacy_log_type' => 'cubepoints-dailypoints',
-			)
-		);
-	}
-
-	/**
-	 * Test that the imported user visit hook respects CubePoints's started periods.
-	 *
-	 * @since 1.2.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_points_settings
-	 * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
-	 */
-	public function test_import_periodic_points_respect_old_periods() {
-
-		if ( version_compare( $GLOBALS['wp_version'], '4.5', '>=' ) ) {
-			$this->setExpectedDeprecated( 'get_currentuserinfo' );
-		}
-
-		cp_module_activation_set( 'dailypoints', 'active' );
-
-		update_option( 'cp_module_dailypoints_points', 30 );
-		update_option( 'cp_module_dailypoints_time', DAY_IN_SECONDS );
-
-		$user_id = $this->factory->user->create();
-
-		wp_set_current_user( $user_id );
-
-		$this->assertEquals( 100, cp_getPoints( $user_id ) );
-
-		cp_module_dailypoints_checkTimer();
-
-		$this->assertEquals( 130, cp_getPoints( $user_id ) );
-
-		// Running again shouldn't hit again.
-		cp_module_dailypoints_checkTimer();
-
-		$this->assertEquals( 130, cp_getPoints( $user_id ) );
-
-		$this->do_points_import( 'settings' );
-		$this->do_points_import( 'user_points' );
-		$this->do_points_import( 'logs' );
-
-		$this->assertEquals( 130, wordpoints_get_points( $user_id, 'points' ) );
-
-		wordpoints_hooks()->get_sub_app( 'router' )->{'wp,10'}();
-
-		$this->assertEquals( 130, wordpoints_get_points( $user_id, 'points' ) );
-
-		// Fast-forward and try again.
-		global $wpdb;
-
-		$id = $wpdb->get_var(
-			"
+    /**
+     * The importer used in the tests.
+     *
+     * @since 1.0.0
+     *
+     * @var WordPoints_CubePoints_Importer
+     */
+    protected $importer;
+
+    /**
+     * @since 1.0.0
+     */
+    public function setUp() {
+
+        parent::setUp();
+
+        // These are usually inactive by default. We activate them in the tests
+        // bootstrap so that they will be fully loaded, but deactivate them here to
+        // restore default behavior.
+        cp_module_activation_set( 'post_author_points', false );
+        cp_module_activation_set( 'dailypoints', false );
+
+        $this->importer = new WordPoints_CubePoints_Importer( 'Test CubePoints' );
+    }
+
+    /**
+     * @since 1.1.0
+     */
+    public function tearDown() {
+
+        WordPoints_Rank_Groups::deregister_group( 'points_type-points' );
+        WordPoints_Rank_Types::deregister_type( 'points-points' );
+
+        parent::tearDown();
+    }
+
+    /**
+     * Test that it returns true when CubePoints is installed.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::is_cubepoints_installed
+     */
+    public function test_is_cubepoints_installed() {
+
+        $this->assertTrue( $this->importer->is_cubepoints_installed() );
+    }
+
+    /**
+     * Test that it returns false when CubePoints is not installed.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::is_cubepoints_installed
+     */
+    public function test_is_cubepoints_not_installed() {
+
+        delete_option( 'cp_db_version' );
+
+        $this->assertFalse( $this->importer->is_cubepoints_installed() );
+    }
+
+    /**
+     * Test that it returns true when CubePoints is installed.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::is_available
+     */
+    public function test_is_cubepoints_is_available() {
+
+        $this->assertTrue( $this->importer->is_available() );
+    }
+
+    /**
+     * Test that it returns a WP_Error when CubePoints is not installed.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::is_available
+     */
+    public function test_is_cubepoints_not_available() {
+
+        delete_option( 'cp_db_version' );
+
+        $this->assertWPError( $this->importer->is_available() );
+    }
+
+    /**
+     * Test that it returns true when CubePoints is active.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::is_cubepoints_active
+     */
+    public function test_is_cubepoints_active() {
+
+        $this->assertEquals(
+            function_exists( 'cp_ready' )
+            , $this->importer->is_cubepoints_active()
+        );
+    }
+
+    /**
+     * Test importing the excluded users.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_excluded_users
+     */
+    public function test_import_excluded_users() {
+
+        $user_ids = $this->factory->user->create_many( 3 );
+        $user_logins = array();
+
+        foreach ( $user_ids as $user_id ) {
+            $user_logins[] = get_userdata( $user_id )->user_login;
+        }
+
+        update_option( 'cp_topfilter', $user_logins );
+
+        $this->do_points_import( 'excluded_users' );
+
+        $this->assertEquals(
+            $user_ids
+            , wordpoints_get_excluded_users( 'tests' )
+        );
+    }
+
+    /**
+     * Test importing the excluded users gives a warning if there are none.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_excluded_users
+     */
+    public function test_import_excluded_users_none() {
+
+        delete_option( 'cp_topfilter' );
+
+        $feedback = new WordPoints_Importer_Tests_Feedback();
+
+        $this->importer->do_import(
+            array(
+                'points' => array(
+                    'excluded_users' => '1',
+                    '_data' => array( 'points_type' => 'points' ),
+                ),
+            )
+            , $feedback
+        );
+
+        $this->assertCount( 1, $feedback->messages['warning'] );
+    }
+
+    /**
+     * Test importing the points settings to points hooks.
+     *
+     * @since 1.1.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_points_settings
+     * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
+     * @covers WordPoints_CubePoints_Importer::format_settings_for_post_type
+     */
+    public function test_import_points_settings() {
+
+        update_option( 'cp_comment_points',     10 );
+        update_option( 'cp_post_points',        20 );
+        update_option( 'cp_reg_points',         50 );
+
+        $this->do_points_import( 'settings' );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'comment_leave\post',
+                'target' => array( 'comment\post', 'author', 'user' ),
+                'reactor' => 'points_legacy',
+                'points' => 10,
+                'points_type' => 'points',
+                'log_text' => 'Comment on a Post.',
+                'description' => 'Commenting on a Post.',
+                'legacy_log_type' => 'cubepoints-comment',
+                'legacy_meta_key' => 'comment',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+            )
+        );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'comment_leave\page',
+                'target' => array( 'comment\page', 'author', 'user' ),
+                'reactor' => 'points_legacy',
+                'points' => 10,
+                'points_type' => 'points',
+                'log_text' => 'Comment on a Page.',
+                'description' => 'Commenting on a Page.',
+                'legacy_log_type' => 'cubepoints-comment',
+                'legacy_meta_key' => 'comment',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+            )
+        );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'comment_leave\attachment',
+                'target' => array( 'comment\attachment', 'author', 'user' ),
+                'reactor' => 'points_legacy',
+                'points' => 10,
+                'points_type' => 'points',
+                'log_text' => 'Comment on a Media.',
+                'description' => 'Commenting on a Media.',
+                'legacy_log_type' => 'cubepoints-comment',
+                'legacy_meta_key' => 'comment',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+            )
+        );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'post_publish\post',
+                'target' => array( 'post\post', 'author', 'user' ),
+                'reactor' => 'points_legacy',
+                'points' => 20,
+                'points_type' => 'points',
+                'log_text' => 'Published a Post.',
+                'description' => 'Publishing a Post.',
+                'blocker' => array( 'toggle_off' => true ),
+                'legacy_log_type' => 'cubepoints-post',
+                'legacy_meta_key' => 'post',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+                'points_legacy_repeat_blocker' => array( 'toggle_on' => true ),
+            )
+        );
+
+        $reaction_store = wordpoints_hooks()->get_reaction_store( 'points' );
+
+        $this->assertEmpty(
+            $reaction_store->get_reactions_to_event( 'post_publish\page' )
+        );
+
+        $this->assertEmpty(
+            $reaction_store->get_reactions_to_event( 'post_publish\attachment' )
+        );
+
+        $this->assertEmpty(
+            $reaction_store->get_reactions_to_event( 'media_upload' )
+        );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'user_register',
+                'target' => array( 'user' ),
+                'reactor' => 'points_legacy',
+                'points' => 50,
+                'points_type' => 'points',
+                'log_text' => 'Registration.',
+                'description' => 'Registration.',
+                'legacy_log_type' => 'cubepoints-register',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+            )
+        );
+    }
+
+    /**
+     * Test that it imports legacy points hooks on install.
+     *
+     * @since 1.0.0
+     *
+     * @coversNothing
+     */
+    public function test_imported_post_points_hook_does_not_refire() {
+
+        update_option( 'cp_post_points', 20 );
+
+        $user_id = $this->factory->user->create();
+        $post_id = $this->factory->post->create(
+            array(
+                'post_author' => $user_id,
+                'post_type'   => 'post',
+            )
+        );
+
+        $this->assertEquals( 120, cp_getPoints( $user_id ) );
+
+        $this->factory->post->update_object(
+            $post_id
+            , array( 'post_status' => 'draft' )
+        );
+
+        $this->assertEquals( 120, cp_getPoints( $user_id ) );
+
+        $this->do_points_import( 'settings' );
+        $this->do_points_import( 'user_points' );
+        $this->do_points_import( 'logs' );
+
+        $this->assertEquals(
+            120
+            , wordpoints_get_points( $user_id, 'points' )
+        );
+
+        $this->factory->post->update_object(
+            $post_id
+            , array( 'post_status' => 'publish' )
+        );
+
+        $this->assertEquals(
+            120
+            , wordpoints_get_points( $user_id, 'points' )
+        );
+    }
+
+    /**
+     * Test importing the settings from the post author points module to points hooks.
+     *
+     * @since 1.1.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_points_settings
+     * @covers WordPoints_CubePoints_Importer::format_settings_for_post_type
+     */
+    public function test_import_post_author_points() {
+
+        cp_module_activation_set( 'post_author_points', 'active' );
+
+        update_option( 'cp_post_author_points', 15 );
+
+        $this->do_points_import( 'settings' );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'comment_leave\post',
+                'target' => array( 'comment\post', 'post\post', 'post\post', 'author', 'user' ),
+                'reactor' => 'points_legacy',
+                'points' => 15,
+                'points_type' => 'points',
+                'log_text' => 'Received a comment on a Post.',
+                'description' => 'Receiving a comment on a Post.',
+                'legacy_log_type' => 'cubepoints-post_author',
+                'legacy_meta_key' => 'comment',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+            )
+        );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'comment_leave\page',
+                'target' => array( 'comment\page', 'post\page', 'post\page', 'author', 'user' ),
+                'reactor' => 'points_legacy',
+                'points' => 15,
+                'points_type' => 'points',
+                'log_text' => 'Received a comment on a Page.',
+                'description' => 'Receiving a comment on a Page.',
+                'legacy_log_type' => 'cubepoints-post_author',
+                'legacy_meta_key' => 'comment',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+            )
+        );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'comment_leave\attachment',
+                'target' => array( 'comment\attachment', 'post\attachment', 'post\attachment', 'author', 'user' ),
+                'reactor' => 'points_legacy',
+                'points' => 15,
+                'points_type' => 'points',
+                'log_text' => 'Received a comment on a Media.',
+                'description' => 'Receiving a comment on a Media.',
+                'legacy_log_type' => 'cubepoints-post_author',
+                'legacy_meta_key' => 'comment',
+                'points_legacy_reversals' => array( 'toggle_off' => 'toggle_on' ),
+            )
+        );
+    }
+
+    /**
+     * Test importing the settings from the daily points module to points hooks.
+     *
+     * @since 1.1.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_points_settings
+     * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
+     */
+    public function test_import_periodic_points() {
+
+        cp_module_activation_set( 'dailypoints', 'active' );
+
+        update_option( 'cp_module_dailypoints_points', 30 );
+        update_option( 'cp_module_dailypoints_time', DAY_IN_SECONDS );
+
+        $this->do_points_import( 'settings' );
+
+        $this->assertHookImported(
+            array(
+                'event' => 'user_visit',
+                'target' => array( 'current:user' ),
+                'reactor' => 'points_legacy',
+                'points' => 30,
+                'points_type' => 'points',
+                'log_text' => 'Visiting the site.',
+                'description' => 'Visiting the site.',
+                'points_legacy_periods' => array(
+                    'fire' => array(
+                        array(
+                            'length' => DAY_IN_SECONDS,
+                            'args' => array( array( 'current:user' ) ),
+                            'relative' => true,
+                        ),
+                    ),
+                ),
+                'points_legacy_reversals' => array(),
+                'legacy_log_type' => 'cubepoints-dailypoints',
+            )
+        );
+    }
+
+    /**
+     * Test that the imported user visit hook respects CubePoints's started periods.
+     *
+     * @since 1.2.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_points_settings
+     * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
+     */
+    public function test_import_periodic_points_respect_old_periods() {
+
+        if ( version_compare( $GLOBALS['wp_version'], '4.5', '>=' ) ) {
+            $this->setExpectedDeprecated( 'get_currentuserinfo' );
+        }
+
+        cp_module_activation_set( 'dailypoints', 'active' );
+
+        update_option( 'cp_module_dailypoints_points', 30 );
+        update_option( 'cp_module_dailypoints_time', DAY_IN_SECONDS );
+
+        $user_id = $this->factory->user->create();
+
+        wp_set_current_user( $user_id );
+
+        $this->assertEquals( 100, cp_getPoints( $user_id ) );
+
+        cp_module_dailypoints_checkTimer();
+
+        $this->assertEquals( 130, cp_getPoints( $user_id ) );
+
+        // Running again shouldn't hit again.
+        cp_module_dailypoints_checkTimer();
+
+        $this->assertEquals( 130, cp_getPoints( $user_id ) );
+
+        $this->do_points_import( 'settings' );
+        $this->do_points_import( 'user_points' );
+        $this->do_points_import( 'logs' );
+
+        $this->assertEquals( 130, wordpoints_get_points( $user_id, 'points' ) );
+
+        wordpoints_hooks()->get_sub_app( 'router' )->{'wp,10'}();
+
+        $this->assertEquals( 130, wordpoints_get_points( $user_id, 'points' ) );
+
+        // Fast-forward and try again.
+        global $wpdb;
+
+        $id = $wpdb->get_var(
+            "
 				SELECT `id`
 				FROM `{$wpdb->wordpoints_points_logs}`
 				ORDER BY `id` DESC
 				LIMIT 1
 			"
-		);
-
-		// Don't go all the way yet.
-		$updated = $wpdb->update(
-			$wpdb->wordpoints_points_logs
-			, array( 'date' => date( 'Y-m-d H:i:s', current_time( 'timestamp', true ) - DAY_IN_SECONDS + HOUR_IN_SECONDS ) )
-			, array( 'id' => $id )
-			, array( '%s' )
-			, array( '%d' )
-		);
-
-		$this->assertEquals( 1, $updated );
-
-		// The periods cache will still hold the old date.
-		$this->flush_cache();
-
-		wordpoints_hooks()->get_sub_app( 'router' )->{'wp,10'}();
-
-		// Points should have been awarded again yet.
-		$this->assertEquals( 130, wordpoints_get_points( $user_id, 'points' ) );
-
-		// This time go all the way.
-		$updated = $wpdb->update(
-			$wpdb->wordpoints_points_logs
-			, array( 'date' => date( 'Y-m-d H:i:s', current_time( 'timestamp', true ) - DAY_IN_SECONDS - 1 ) )
-			, array( 'id' => $id )
-			, array( '%s' )
-			, array( '%d' )
-		);
-
-		$this->assertEquals( 1, $updated );
-
-		// The periods cache will still hold the old date.
-		$this->flush_cache();
-
-		wordpoints_hooks()->get_sub_app( 'router' )->{'wp,10'}();
-
-		// Points should have been awarded again.
-		$this->assertEquals( 160, wordpoints_get_points( $user_id, 'points' ) );
-	}
-
-	/**
-	 * Test the imported periods when the site has a positive GMT offset.
-	 *
-	 * @since 1.2.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_points_settings
-	 * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
-	 */
-	public function test_import_periods_positive_gmt_offset() {
-
-		update_option( 'gmt_offset', 5 );
-
-		$this->test_import_periodic_points_respect_old_periods();
-	}
-
-	/**
-	 * Test the imported periods when the site has a negative GMT offset.
-	 *
-	 * @since 1.2.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_points_settings
-	 * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
-	 */
-	public function test_import_periods_negative_gmt_offset() {
-
-		update_option( 'gmt_offset', -5 );
-
-		$this->test_import_periodic_points_respect_old_periods();
-	}
-
-	/**
-	 * Test importing the user's points.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_user_points
-	 * @covers WordPoints_CubePoints_Importer::get_next_user_points_batch
-	 */
-	public function test_import_user_points() {
-
-		$user_points = array();
-
-		foreach ( array( 20, 10, 45 ) as $points ) {
-
-			$user_id = $this->factory->user->create();
-			cp_updatePoints( $user_id, $points );
-			$user_points[ $user_id ] = $points;
-		}
-
-		$this->do_points_import( 'user_points' );
-
-		foreach ( $user_points as $user_id => $points ) {
-			$this->assertEquals( $points, wordpoints_get_points( $user_id, 'points' ) );
-		}
-	}
-
-	/**
-	 * Test importing the points logs.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_points_logs
-	 * @covers WordPoints_CubePoints_Importer::import_points_log
-	 * @covers WordPoints_CubePoints_Importer::get_next_points_logs_batch
-	 * @covers WordPoints_CubePoints_Importer::render_points_log_text
-	 */
-	public function test_import_points_logs() {
-
-		remove_action( 'publish_post', 'cp_newPost' );
-
-		$user_id = $this->factory->user->create();
-		cp_points( 'misc', $user_id, 10, 'Testing things.' );
-
-		$user_id_2 = $this->factory->user->create();
-		$post_id = $this->factory->post->create();
-		cp_points( 'post', $user_id_2, 25, $post_id );
-
-		$this->do_points_import( 'logs' );
-
-		$query = new WordPoints_Points_Logs_Query( array( 'orderby' => 'id' ) );
-		$logs = $query->get();
-
-		$this->assertCount( 4, $logs );
-
-		$log = $logs[2];
-
-		$this->assertEquals( $user_id, $log->user_id );
-		$this->assertEquals( 10, $log->points );
-		$this->assertEquals( 'Testing things.', $log->text );
-		$this->assertEquals( 'cubepoints-misc', $log->log_type );
-		$this->assertEquals( 'points', $log->points_type );
-		$this->assertEquals( 'misc', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
-		$this->assertEquals( 'Testing things.', wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
-
-		$log = $logs[0];
-
-		$this->assertEquals( $user_id_2, $log->user_id );
-		$this->assertEquals( 25, $log->points );
-		$this->assertStringMatchesFormat( 'Post on "<a href="%s">Post title %s</a>"', $log->text );
-		$this->assertEquals( 'cubepoints-post', $log->log_type );
-		$this->assertEquals( 'points', $log->points_type );
-		$this->assertEquals( 'post', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
-		$this->assertEquals( $post_id, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
-		$this->assertEquals( $post_id, wordpoints_get_points_log_meta( $log->id, 'post', true ) );
-	}
-
-	/**
-	 * Test importing points logs that have been reversed.
-	 *
-	 * @since 1.2.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_points_logs
-	 * @covers WordPoints_CubePoints_Importer::import_points_log
-	 * @covers WordPoints_CubePoints_Importer::get_next_points_logs_batch
-	 * @covers WordPoints_CubePoints_Importer::render_points_log_text
-	 */
-	public function test_import_points_logs_reversals() {
-
-		remove_action( 'publish_post', 'cp_newPost' );
-		remove_action( 'cp_comment_add', 'cp_module_post_author_points_comment_add' );
-		remove_action( 'cp_comment_remove', 'cp_module_post_author_points_comment_remove' );
-
-		update_option( 'cp_comment_points', 10 );
-		update_option( 'cp_del_comment_points', 10 );
-
-		$user_id = $this->factory->user->create();
-		$post_id = $this->factory->post->create();
-
-		$comment_id = $this->factory->comment->create(
-			array( 'user_id' => $user_id, 'comment_post_ID' => $post_id, 'comment_approved' => 0 )
-		);
-
-		wp_update_comment(
-			array( 'comment_ID' => $comment_id, 'comment_approved' => 1 )
-		);
-
-		$user_id_2 = $this->factory->user->create();
-		$comment_id_2 = $this->factory->comment->create(
-			array( 'user_id' => $user_id_2, 'comment_post_ID' => $post_id, 'comment_approved' => 0 )
-		);
-
-		wp_update_comment(
-			array( 'comment_ID' => $comment_id_2, 'comment_approved' => 1 )
-		);
-
-		// Now reverse the two transactions.
-		wp_update_comment(
-			array( 'comment_ID' => $comment_id, 'comment_approved' => 0 )
-		);
-
-		wp_update_comment(
-			array( 'comment_ID' => $comment_id_2, 'comment_approved' => 0 )
-		);
-
-		$this->do_points_import( 'logs' );
-
-		$query = new WordPoints_Points_Logs_Query(
-			array( 'orderby' => 'id', 'order' => 'ASC' )
-		);
-
-		$logs = $query->get();
-
-		$this->assertCount( 6, $logs );
-
-		// The first log will be for when the first user was created, so we skip it.
-		$log = $logs[1];
-
-		$this->assertEquals( $user_id, $log->user_id );
-		$this->assertEquals( 10, $log->points );
-		$this->assertEquals( 'cubepoints-comment', $log->log_type );
-		$this->assertEquals( 'points', $log->points_type );
-		$this->assertEquals( 'comment', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
-		$this->assertEquals( $comment_id, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
-		$this->assertEquals( $comment_id, wordpoints_get_points_log_meta( $log->id, 'comment', true ) );
-		$this->assertEquals( $logs[4]->id, wordpoints_get_points_log_meta( $log->id, 'auto_reversed', true ) );
-
-		// The third log is for when the second user was created, so we skip it, too.
-		$log = $logs[3];
-
-		$this->assertEquals( $user_id_2, $log->user_id );
-		$this->assertEquals( 10, $log->points );
-		$this->assertEquals( 'cubepoints-comment', $log->log_type );
-		$this->assertEquals( 'points', $log->points_type );
-		$this->assertEquals( 'comment', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
-		$this->assertEquals( $comment_id_2, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
-		$this->assertEquals( $comment_id_2, wordpoints_get_points_log_meta( $log->id, 'comment', true ) );
-		$this->assertEquals( $logs[5]->id, wordpoints_get_points_log_meta( $log->id, 'auto_reversed', true ) );
-
-		$log = $logs[4];
-
-		$this->assertEquals( $user_id, $log->user_id );
-		$this->assertEquals( -10, $log->points );
-		$this->assertEquals( 'cubepoints-comment_remove', $log->log_type );
-		$this->assertEquals( 'points', $log->points_type );
-		$this->assertEquals( 'comment_remove', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
-		$this->assertEquals( $comment_id, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
-		$this->assertEquals( $comment_id, wordpoints_get_points_log_meta( $log->id, 'comment', true ) );
-		$this->assertEquals( $logs[1]->id, wordpoints_get_points_log_meta( $log->id, 'original_log_id', true ) );
-
-		$log = $logs[5];
-
-		$this->assertEquals( $user_id_2, $log->user_id );
-		$this->assertEquals( -10, $log->points );
-		$this->assertEquals( 'cubepoints-comment_remove', $log->log_type );
-		$this->assertEquals( 'points', $log->points_type );
-		$this->assertEquals( 'comment_remove', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
-		$this->assertEquals( $comment_id_2, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
-		$this->assertEquals( $comment_id_2, wordpoints_get_points_log_meta( $log->id, 'comment', true ) );
-		$this->assertEquals( $logs[3]->id, wordpoints_get_points_log_meta( $log->id, 'original_log_id', true ) );
-	}
-
-	/**
-	 * Test that ranks are imported.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_ranks
-	 */
-	public function test_ranks_import() {
-
-		update_option(
-			'cp_module_ranks_data'
-			, array( 0 => 'Newbie', 1000 => 'Biggie', 5000 => 'Oldie' )
-		);
-
-		wordpoints_register_points_ranks();
-
-		$feedback = new WordPoints_Importer_Tests_Feedback();
-
-		$this->importer->do_import(
-			array(
-				'ranks' => array(
-					'ranks' => '1',
-					'_data' => array( 'rank_group' => 'points_type-points' ),
-				),
-			)
-			, $feedback
-		);
-
-		$this->assertCount( 4, $feedback->messages['info'] );
-		$this->assertCount( 1, $feedback->messages['success'] );
-
-		$group = WordPoints_Rank_Groups::get_group( 'points_type-points' );
-
-		$base_rank = wordpoints_get_rank( $group->get_rank( 0 ) );
-		$this->assertEquals( 'base', $base_rank->type );
-		$this->assertEquals( 'Newbie', $base_rank->name );
-
-		$second_rank = wordpoints_get_rank( $group->get_rank( 1 ) );
-		$this->assertEquals( 1000, $second_rank->points );
-		$this->assertEquals( 'Biggie', $second_rank->name );
-
-		$third_rank = wordpoints_get_rank( $group->get_rank( 2 ) );
-		$this->assertEquals( 5000, $third_rank->points );
-		$this->assertEquals( 'Oldie', $third_rank->name );
-	}
-
-	/**
-	 * Test that there is an error if there are no ranks import.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @covers WordPoints_CubePoints_Importer::import_ranks
-	 */
-	public function test_error_if_no_ranks_to_import() {
-
-		wordpoints_register_points_ranks();
-
-		$feedback = new WordPoints_Importer_Tests_Feedback();
-
-		$this->importer->do_import(
-			array(
-				'ranks' => array(
-					'ranks' => '1',
-					'_data' => array( 'rank_group' => 'points_type-points' ),
-				),
-			)
-			, $feedback
-		);
-
-		$this->assertCount( 4, $feedback->messages['info'] );
-		$this->assertCount( 1, $feedback->messages['error'] );
-
-	}
-
-	//
-	// Helpers.
-	//
-
-	/**
-	 * Do the import for the points settings.
-	 *
-	 * @since 1.1.0
-	 *
-	 * @param string $type The type of points import.
-	 */
-	protected function do_points_import( $type ) {
-
-		$feedback = new WordPoints_Importer_Tests_Feedback();
-
-		$this->importer->do_import(
-			array(
-				'points' => array(
-					$type => '1',
-					'_data' => array( 'points_type' => 'points' ),
-				),
-			)
-			, $feedback
-		);
-
-		$this->assertCount( 4, $feedback->messages['info'] );
-		$this->assertCount( 1, $feedback->messages['success'] );
-	}
-
-	/**
-	 * Assert that a hook was imported.
-	 *
-	 * Actually just checks that the hook exists.
-	 *
-	 * @since 1.1.0
-	 * @since 1.2.0 Now just accepts a single parameter, $settings.
-	 *
-	 * @param array $settings The expected reaction settings.
-	 */
-	protected function assertHookImported( $settings ) {
-
-		$reaction_store = wordpoints_hooks()->get_reaction_store( 'points' );
-
-		$reactions = $reaction_store->get_reactions_to_event( $settings['event'] );
-
-		$this->assertNotEmpty( $reactions );
-
-		foreach ( $reactions as $reaction ) {
-			if ( $settings === $reaction->get_all_meta() ) {
-				$this->assertEquals( $settings, $reaction->get_all_meta() );
-				return;
-			}
-		}
-
-		$this->assertEquals( $settings, $reaction->get_all_meta() );
-	}
+        );
+
+        // Don't go all the way yet.
+        $updated = $wpdb->update(
+            $wpdb->wordpoints_points_logs
+            , array( 'date' => date( 'Y-m-d H:i:s', current_time( 'timestamp', true ) - DAY_IN_SECONDS + HOUR_IN_SECONDS ) )
+            , array( 'id' => $id )
+            , array( '%s' )
+            , array( '%d' )
+        );
+
+        $this->assertEquals( 1, $updated );
+
+        // The periods cache will still hold the old date.
+        $this->flush_cache();
+
+        wordpoints_hooks()->get_sub_app( 'router' )->{'wp,10'}();
+
+        // Points should have been awarded again yet.
+        $this->assertEquals( 130, wordpoints_get_points( $user_id, 'points' ) );
+
+        // This time go all the way.
+        $updated = $wpdb->update(
+            $wpdb->wordpoints_points_logs
+            , array( 'date' => date( 'Y-m-d H:i:s', current_time( 'timestamp', true ) - DAY_IN_SECONDS - 1 ) )
+            , array( 'id' => $id )
+            , array( '%s' )
+            , array( '%d' )
+        );
+
+        $this->assertEquals( 1, $updated );
+
+        // The periods cache will still hold the old date.
+        $this->flush_cache();
+
+        wordpoints_hooks()->get_sub_app( 'router' )->{'wp,10'}();
+
+        // Points should have been awarded again.
+        $this->assertEquals( 160, wordpoints_get_points( $user_id, 'points' ) );
+    }
+
+    /**
+     * Test the imported periods when the site has a positive GMT offset.
+     *
+     * @since 1.2.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_points_settings
+     * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
+     */
+    public function test_import_periods_positive_gmt_offset() {
+
+        update_option( 'gmt_offset', 5 );
+
+        $this->test_import_periodic_points_respect_old_periods();
+    }
+
+    /**
+     * Test the imported periods when the site has a negative GMT offset.
+     *
+     * @since 1.2.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_points_settings
+     * @covers WordPoints_CubePoints_Importer::import_daily_points_hook
+     */
+    public function test_import_periods_negative_gmt_offset() {
+
+        update_option( 'gmt_offset', -5 );
+
+        $this->test_import_periodic_points_respect_old_periods();
+    }
+
+    /**
+     * Test importing the user's points.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_user_points
+     * @covers WordPoints_CubePoints_Importer::get_next_user_points_batch
+     */
+    public function test_import_user_points() {
+
+        $user_points = array();
+
+        foreach ( array( 20, 10, 45 ) as $points ) {
+
+            $user_id = $this->factory->user->create();
+            cp_updatePoints( $user_id, $points );
+            $user_points[ $user_id ] = $points;
+        }
+
+        $this->do_points_import( 'user_points' );
+
+        foreach ( $user_points as $user_id => $points ) {
+            $this->assertEquals( $points, wordpoints_get_points( $user_id, 'points' ) );
+        }
+    }
+
+    /**
+     * Test importing the points logs.
+     *
+     * @since 1.0.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_points_logs
+     * @covers WordPoints_CubePoints_Importer::import_points_log
+     * @covers WordPoints_CubePoints_Importer::get_next_points_logs_batch
+     * @covers WordPoints_CubePoints_Importer::render_points_log_text
+     */
+    public function test_import_points_logs() {
+
+        remove_action( 'publish_post', 'cp_newPost' );
+
+        $user_id = $this->factory->user->create();
+        cp_points( 'misc', $user_id, 10, 'Testing things.' );
+
+        $user_id_2 = $this->factory->user->create();
+        $post_id = $this->factory->post->create();
+        cp_points( 'post', $user_id_2, 25, $post_id );
+
+        $this->do_points_import( 'logs' );
+
+        $query = new WordPoints_Points_Logs_Query( array( 'orderby' => 'id' ) );
+        $logs = $query->get();
+
+        $this->assertCount( 4, $logs );
+
+        $log = $logs[2];
+
+        $this->assertEquals( $user_id, $log->user_id );
+        $this->assertEquals( 10, $log->points );
+        $this->assertEquals( 'Testing things.', $log->text );
+        $this->assertEquals( 'cubepoints-misc', $log->log_type );
+        $this->assertEquals( 'points', $log->points_type );
+        $this->assertEquals( 'misc', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
+        $this->assertEquals( 'Testing things.', wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
+
+        $log = $logs[0];
+
+        $this->assertEquals( $user_id_2, $log->user_id );
+        $this->assertEquals( 25, $log->points );
+        $this->assertStringMatchesFormat( 'Post on "<a href="%s">Post title %s</a>"', $log->text );
+        $this->assertEquals( 'cubepoints-post', $log->log_type );
+        $this->assertEquals( 'points', $log->points_type );
+        $this->assertEquals( 'post', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
+        $this->assertEquals( $post_id, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
+        $this->assertEquals( $post_id, wordpoints_get_points_log_meta( $log->id, 'post', true ) );
+    }
+
+    /**
+     * Test importing points logs that have been reversed.
+     *
+     * @since 1.2.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_points_logs
+     * @covers WordPoints_CubePoints_Importer::import_points_log
+     * @covers WordPoints_CubePoints_Importer::get_next_points_logs_batch
+     * @covers WordPoints_CubePoints_Importer::render_points_log_text
+     */
+    public function test_import_points_logs_reversals() {
+
+        remove_action( 'publish_post', 'cp_newPost' );
+        remove_action( 'cp_comment_add', 'cp_module_post_author_points_comment_add' );
+        remove_action( 'cp_comment_remove', 'cp_module_post_author_points_comment_remove' );
+
+        update_option( 'cp_comment_points', 10 );
+        update_option( 'cp_del_comment_points', 10 );
+
+        $user_id = $this->factory->user->create();
+        $post_id = $this->factory->post->create();
+
+        $comment_id = $this->factory->comment->create(
+            array( 'user_id' => $user_id, 'comment_post_ID' => $post_id, 'comment_approved' => 0 )
+        );
+
+        wp_update_comment(
+            array( 'comment_ID' => $comment_id, 'comment_approved' => 1 )
+        );
+
+        $user_id_2 = $this->factory->user->create();
+        $comment_id_2 = $this->factory->comment->create(
+            array( 'user_id' => $user_id_2, 'comment_post_ID' => $post_id, 'comment_approved' => 0 )
+        );
+
+        wp_update_comment(
+            array( 'comment_ID' => $comment_id_2, 'comment_approved' => 1 )
+        );
+
+        // Now reverse the two transactions.
+        wp_update_comment(
+            array( 'comment_ID' => $comment_id, 'comment_approved' => 0 )
+        );
+
+        wp_update_comment(
+            array( 'comment_ID' => $comment_id_2, 'comment_approved' => 0 )
+        );
+
+        $this->do_points_import( 'logs' );
+
+        $query = new WordPoints_Points_Logs_Query(
+            array( 'orderby' => 'id', 'order' => 'ASC' )
+        );
+
+        $logs = $query->get();
+
+        $this->assertCount( 6, $logs );
+
+        // The first log will be for when the first user was created, so we skip it.
+        $log = $logs[1];
+
+        $this->assertEquals( $user_id, $log->user_id );
+        $this->assertEquals( 10, $log->points );
+        $this->assertEquals( 'cubepoints-comment', $log->log_type );
+        $this->assertEquals( 'points', $log->points_type );
+        $this->assertEquals( 'comment', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
+        $this->assertEquals( $comment_id, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
+        $this->assertEquals( $comment_id, wordpoints_get_points_log_meta( $log->id, 'comment', true ) );
+        $this->assertEquals( $logs[4]->id, wordpoints_get_points_log_meta( $log->id, 'auto_reversed', true ) );
+
+        // The third log is for when the second user was created, so we skip it, too.
+        $log = $logs[3];
+
+        $this->assertEquals( $user_id_2, $log->user_id );
+        $this->assertEquals( 10, $log->points );
+        $this->assertEquals( 'cubepoints-comment', $log->log_type );
+        $this->assertEquals( 'points', $log->points_type );
+        $this->assertEquals( 'comment', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
+        $this->assertEquals( $comment_id_2, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
+        $this->assertEquals( $comment_id_2, wordpoints_get_points_log_meta( $log->id, 'comment', true ) );
+        $this->assertEquals( $logs[5]->id, wordpoints_get_points_log_meta( $log->id, 'auto_reversed', true ) );
+
+        $log = $logs[4];
+
+        $this->assertEquals( $user_id, $log->user_id );
+        $this->assertEquals( -10, $log->points );
+        $this->assertEquals( 'cubepoints-comment_remove', $log->log_type );
+        $this->assertEquals( 'points', $log->points_type );
+        $this->assertEquals( 'comment_remove', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
+        $this->assertEquals( $comment_id, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
+        $this->assertEquals( $comment_id, wordpoints_get_points_log_meta( $log->id, 'comment', true ) );
+        $this->assertEquals( $logs[1]->id, wordpoints_get_points_log_meta( $log->id, 'original_log_id', true ) );
+
+        $log = $logs[5];
+
+        $this->assertEquals( $user_id_2, $log->user_id );
+        $this->assertEquals( -10, $log->points );
+        $this->assertEquals( 'cubepoints-comment_remove', $log->log_type );
+        $this->assertEquals( 'points', $log->points_type );
+        $this->assertEquals( 'comment_remove', wordpoints_get_points_log_meta( $log->id, 'cubepoints_type', true ) );
+        $this->assertEquals( $comment_id_2, wordpoints_get_points_log_meta( $log->id, 'cubepoints_data', true ) );
+        $this->assertEquals( $comment_id_2, wordpoints_get_points_log_meta( $log->id, 'comment', true ) );
+        $this->assertEquals( $logs[3]->id, wordpoints_get_points_log_meta( $log->id, 'original_log_id', true ) );
+    }
+
+    /**
+     * Test that ranks are imported.
+     *
+     * @since 1.1.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_ranks
+     */
+    public function test_ranks_import() {
+
+        update_option(
+            'cp_module_ranks_data'
+            , array( 0 => 'Newbie', 1000 => 'Biggie', 5000 => 'Oldie' )
+        );
+
+        wordpoints_register_points_ranks();
+
+        $feedback = new WordPoints_Importer_Tests_Feedback();
+
+        $this->importer->do_import(
+            array(
+                'ranks' => array(
+                    'ranks' => '1',
+                    '_data' => array( 'rank_group' => 'points_type-points' ),
+                ),
+            )
+            , $feedback
+        );
+
+        $this->assertCount( 4, $feedback->messages['info'] );
+        $this->assertCount( 1, $feedback->messages['success'] );
+
+        $group = WordPoints_Rank_Groups::get_group( 'points_type-points' );
+
+        $base_rank = wordpoints_get_rank( $group->get_rank( 0 ) );
+        $this->assertEquals( 'base', $base_rank->type );
+        $this->assertEquals( 'Newbie', $base_rank->name );
+
+        $second_rank = wordpoints_get_rank( $group->get_rank( 1 ) );
+        $this->assertEquals( 1000, $second_rank->points );
+        $this->assertEquals( 'Biggie', $second_rank->name );
+
+        $third_rank = wordpoints_get_rank( $group->get_rank( 2 ) );
+        $this->assertEquals( 5000, $third_rank->points );
+        $this->assertEquals( 'Oldie', $third_rank->name );
+    }
+
+    /**
+     * Test that there is an error if there are no ranks import.
+     *
+     * @since 1.1.0
+     *
+     * @covers WordPoints_CubePoints_Importer::import_ranks
+     */
+    public function test_error_if_no_ranks_to_import() {
+
+        wordpoints_register_points_ranks();
+
+        $feedback = new WordPoints_Importer_Tests_Feedback();
+
+        $this->importer->do_import(
+            array(
+                'ranks' => array(
+                    'ranks' => '1',
+                    '_data' => array( 'rank_group' => 'points_type-points' ),
+                ),
+            )
+            , $feedback
+        );
+
+        $this->assertCount( 4, $feedback->messages['info'] );
+        $this->assertCount( 1, $feedback->messages['error'] );
+
+    }
+
+    //
+    // Helpers.
+    //
+
+    /**
+     * Do the import for the points settings.
+     *
+     * @since 1.1.0
+     *
+     * @param string $type The type of points import.
+     */
+    protected function do_points_import( $type ) {
+
+        $feedback = new WordPoints_Importer_Tests_Feedback();
+
+        $this->importer->do_import(
+            array(
+                'points' => array(
+                    $type => '1',
+                    '_data' => array( 'points_type' => 'points' ),
+                ),
+            )
+            , $feedback
+        );
+
+        $this->assertCount( 4, $feedback->messages['info'] );
+        $this->assertCount( 1, $feedback->messages['success'] );
+    }
+
+    /**
+     * Assert that a hook was imported.
+     *
+     * Actually just checks that the hook exists.
+     *
+     * @since 1.1.0
+     * @since 1.2.0 Now just accepts a single parameter, $settings.
+     *
+     * @param array $settings The expected reaction settings.
+     */
+    protected function assertHookImported( $settings ) {
+
+        $reaction_store = wordpoints_hooks()->get_reaction_store( 'points' );
+
+        $reactions = $reaction_store->get_reactions_to_event( $settings['event'] );
+
+        $this->assertNotEmpty( $reactions );
+
+        foreach ( $reactions as $reaction ) {
+            if ( $settings === $reaction->get_all_meta() ) {
+                $this->assertEquals( $settings, $reaction->get_all_meta() );
+                return;
+            }
+        }
+
+        $this->assertEquals( $settings, $reaction->get_all_meta() );
+    }
 }
 
 // EOF

tests/codeception/_support/AcceptanceTester.php

Indentation +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
  * @since 1.0.0
  */
 class AcceptanceTester extends \WordPoints\Tests\Codeception\AcceptanceTester {
-	// Add any methods here that you want.
+    // Add any methods here that you want.
 }
 
 // EOF