Changeset 10775

Timestamp:

03/05/2021 12:40:59 AM (4 years ago)

Author:

coffee2code

Message:

Handbooks: Add ability to import handbook content from a remote source.

• Add WPorg_Handbook_Importer class, incorporating related functionality from DevHub theme
• Add 'cron_interval' and 'manifest' handbook config options
• Add get_importer() and init_importer() to handbook object

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook

Files:

• handbook.php (modified) (2 diffs)
• inc/handbook.php (modified) (5 diffs)
• inc/importer.php (added)
• phpunit/includes/utils.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/handbook.php

@@ -3 +3 @@
  * Plugin Name: Handbook
  * Description: Features for a handbook, complete with glossary and table of contents
+ * Version:     2.0
  * Author:      WordPress.org
  * Author URI:  https://wordpress.org/
@@ -25 +26 @@
 require_once __DIR__ . '/inc/blocks.php';
 
+add_action( 'plugins_loaded', function () {
+    if ( class_exists( 'WordPressdotorg\\Markdown\\Importer' ) ) {
+        require_once __DIR__ . '/inc/importer.php';
+    }
+}, 1 );

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php

@@ -35 +35 @@
      */
     protected $label = '';
+
+    /**
+     * The associated importer object, if warranted.
+     */
+    protected $importer;
 
     /**
@@ -78 +83 @@
          *     Associative array of handbook configuration.
          *
+         *     @type string $cron_interval The cron interval for which an imported handbook gets
+         *                                 imported, e.g. 'hourly', 'daily'. If defined as an
+         *                                 unrecognized interval, 'hourly' will be used.
+         *                                 Default '15_minutes'.
          *     @type string $label The label for the handbook. Default is the
          *                         post type slug converted to titlecase (e.g.
          *                         plugin-handbok => "Plugin Handbook").
+         *     @type string manifest       The URL to the manifest JSON file for an imported
+         *                                 handbook.
          *     @type string $slug  The slug for the post type. Default is the
          *                         post type.
@@ -86 +97 @@
          */
         return (array) apply_filters( 'handbook_default_handbook_config', [
+            'cron_interval' => '15_minutes',
             'label'         => '',
+            'manifest'      => '',
             'slug'          => '',
         ] );
@@ -142 +155 @@
         $this->setting_name = $this->post_type . '_name';
 
+        add_action( 'after_handbooks_init',               [ $this, 'init_importer' ] );
         add_filter( 'user_has_cap',                       [ $this, 'grant_handbook_caps' ] );
         add_action( 'widgets_init',                       [ $this, 'register_post_type' ] );
@@ -171 +185 @@
     public function get_config() {
         return $this->config;
+    }
+
+    /**
+     * Returns the handbook's importer object, if applicable.
+     *
+     * @return WPorg_Handbook_Importer|null
+     */
+    public function get_importer() {
+        return $this->importer;
+    }
+
+    /**
+     * Initializes the importer, if applicable.
+     */
+    public function init_importer() {
+        $config = $this->get_config();
+
+        if ( class_exists( 'WPorg_Handbook_Importer' ) ) {
+            if ( WPorg_Handbook_Importer::is_handbook_imported( $this->post_type ) ) {
+                $this->importer = new WPorg_Handbook_Importer( $this );
+            }
+        } elseif ( is_admin() && ( $config['manifest'] ?: false ) ) {
+            add_action( 'admin_notices', function () {
+                echo '<div class="notice notice-error"><p>' . __( 'Error: The <strong>WPORG Markdown Importer</strong> plugin needs to be activated in order to allow importing of handbooks.', 'wporg' ) . '</p></div>';
+            } );
+        }
     }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/includes/utils.php

@@ -32 +32 @@
 function dataprovider_get_default_config() {
     return [
+        [ 'cron_interval', '15_minutes' ],
         [ 'label', '' ],
+        [ 'manifest', '' ],
         [ 'slug', '' ],
     ];