Changeset 8776

Timestamp:

05/10/2019 06:43:32 PM (7 years ago)

Author:

coffee2code

Message:

Markdown Importer: Support relative paths for per-page markdown source.

The markdown_source values defined in manifests can continue to be fully qualified URLs, but now they can alternatively also be paths relative to the URL path for the manifest file. Parent path notation can be used (e.g. "../file.md"), but attempts to refer to higher level paths (e.g. "../../file.md") will not be honored beyond the parent.

Fixes #4244.
See #4388.
See ​https://github.com/WordPress/gutenberg/pull/14739.
See ​https://github.com/WordPress/gutenberg/pull/15254.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-markdown/inc/class-importer.php (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-markdown/inc/class-importer.php

@@ -234 +234 @@
             WP_CLI::log( "Created post {$post_id} for {$doc['slug']}." );
         }
-        update_post_meta( $post_id, $this->meta_key, esc_url_raw( $doc['markdown_source'] ) );
+        update_post_meta( $post_id, $this->meta_key, esc_url_raw( $this->generate_markdown_source_url( $doc['markdown_source'] ) ) );
         update_post_meta( $post_id, $this->manifest_entry_meta_key, $doc );
         return get_post( $post_id );
@@ -249 +249 @@
         update_post_meta( $post_id, $this->manifest_entry_meta_key, $doc );
 
-        $did_update = update_post_meta( $post_id, $this->meta_key, esc_url_raw( $doc['markdown_source'] ) );
+        $did_update = update_post_meta( $post_id, $this->meta_key, esc_url_raw( $this->generate_markdown_source_url( $doc['markdown_source'] ) ) );
         if ( ! $did_update ) {
             return false;
@@ -422 +422 @@
 
     /**
+     * Generates a fully qualified markdown source URL in the event a relative
+     * path was defined.
+     *
+     * @param string $markdown_source The markdwon_source value defined for a
+     *                                document in the manifest.
+     * @return string
+     */
+    public function generate_markdown_source_url( $markdown_source ) {
+        // If source is not explicit URL, then it is relative.
+        if ( false === strpos( $markdown_source, 'https://' ) ) {
+            // Base URL is the location of the manifest.
+            $base = $this->get_manifest_url();
+            $base = rtrim( dirname( $base ), '/' );
+
+            // Markdown source can relatively refer to manifest's parent directory,
+            // but no higher.
+            if ( false !== strpos( $markdown_source, '../' ) ) {
+                $base = rtrim( dirname( $base ), '/' );
+                $markdown_source = str_replace( '../', '/', $markdown_source );
+            }
+
+            $markdown_source = $base . '/' . ltrim( $markdown_source, '/' );
+        }
+
+        return $markdown_source;
+    }
+
+    /**
      * Retrieve the markdown source URL for a given post.
      */