Changeset 677 for sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

Timestamp:

06/05/2014 09:46:52 PM (11 years ago)

Author:

coffee2code

Message:

Code Reference: Improvements to inline source code display. Fixes #176

• More efficient implementation of get_source_code()
• Add get_source_code_root_dir() which gets 'wp_parser_root_import_dir' option value if set by parser, else ABSPATH
• Add post_type_has_source_code()
• Use 'wporg' as the text domain
• Slight tweak to JS height comparison to ensure functions that just fit don't trigger expansion handling
• Allow x scrollbar for .source-code-container and adjust heights to account for its possible display
• Add extra height to collapsed state of .source-code-container to partially show the first hidden line to better indicate there is more code
• Add right border to .source-code-container so it is easier to tell if code is being clipped
• Change 'View source' link to 'View source code:' label with explicit links to inline source and/or WP Trac code browser
• Source code is stored in post meta; parse and store it as requested if it isn't
• Sanity check to ensure proper conditions exist for parsing
• Add optional 'force_parse' arg to get_source_code() to force reparsing of source file

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

@@ -640 +640 @@
 
     /**
-     * Retrieve source code for a function
-     *
-     * @param int $post_id
-     *
-     * @return string The sourc
-     */
-    function get_source_code( $post_id = null ) {
+     * Does the post type have source code?
+     *
+     * @param  string  Optional. The post type name. If blank, assumes current post type.
+     *
+     * @return boolean
+     */
+    function post_type_has_source_code( $post_type = null ) {
+        $post_type                   = $post_type ? $post_type : get_post_type();
+        $post_types_with_source_code = array( 'wp-parser-method', 'wp-parser-function' );
+
+        return in_array( $post_type, $post_types_with_source_code );
+    }
+
+    /**
+     * Retrieve the root directory of the parsed WP code.
+     *
+     * If the option 'wp_parser_root_import_dir' (as set by the parser) is not
+     * set, then assume ABSPATH.
+     *
+     * @return string
+     */
+    function get_source_code_root_dir() {
+        $root_dir = get_option( 'wp_parser_root_import_dir' );
+
+        return $root_dir ? trailingslashit( $root_dir ) : ABSPATH;
+    }
+
+    /**
+     * Retrieve source code for a function or method.
+     *
+     * @param int  $post_id     Optional. The post ID.
+     * @param bool $force_parse Optional. Ignore potential value in post meta and reparse source file for source code?
+     *
+     * @return string The source code.
+     */
+    function get_source_code( $post_id = null, $force_parse = false ) {
 
         if ( empty( $post_id ) ) {
@@ -652 +681 @@
         }
 
-        // Get the total file sourcecode.
+        // Get the source code stored in post meta.
+        $meta_key = '_wp-parser_source_code';
+        if ( ! $force_parse && $source_code = get_post_meta( $post_id, $meta_key, true ) ) {
+            return $source_code;
+        }
+
+        /* Source code hasn't been stored in post meta, so parse source file to get it. */
+
+        // Get the name of the source file.
         $source_file = get_source_file( $post_id );
 
-        // Put the total source code in an array.
-        $total_source_code = file_get_contents( ABSPATH . $source_file );
-        $total_source_code = explode( "\n", $total_source_code );
-
         // Get the start and end lines.
-        $start_line = get_post_meta( $post_id, '_wp-parser_line_num', true ) - 1;
-        $end_line =   get_post_meta( $post_id, '_wp-parser_end_line_num', true );
-
-        // Get the correct source code.
-        $source_code = array_slice( $total_source_code, $start_line, $end_line - $start_line );
-
-        return implode( "\n", $source_code );
+        $start_line = intval( get_post_meta( $post_id, '_wp-parser_line_num', true ) ) - 1;
+        $end_line   = intval( get_post_meta( $post_id, '_wp-parser_end_line_num', true ) );
+
+        // Sanity check to ensure proper conditions exist for parsing
+        if ( ! $source_file || ! $start_line || ! $end_line || ( $start_line > $end_line ) ) {
+            return '';
+        }
+
+        // Find just the relevant source code
+        $source_code = '';
+        $handle = @fopen( get_source_code_root_dir() . $source_file, 'r' );
+        if ( $handle ) {
+            $line = -1;
+            while ( ! feof( $handle ) ) {
+                $line++;
+                $source_line = fgets( $handle );
+                if ( $line > $end_line ) {
+                    break;
+                }
+                if ( $line < $start_line ) {
+                    continue;
+                }
+                $source_code .= $source_line;
+            }
+            fclose( $handle );
+        }
+
+        update_post_meta( $post_id, $meta_key, $source_code );
+
+        return $source_code;
     }