Ticket #23625: 23625.7.diff

wp-includes/post-formats.php

@@ -420 +420 @@
 
         return $output;
 }
+
+/**
+ * Deliberately interpret passed content as a chat transcript that is optionally
+ * followed by commentary
+ *
+ * If the content does not contain username syntax, assume that it does not contain
+ * chat logs and return
+ *
+ * @since 3.6.0
+ *
+ * Example:
+ *
+ * One stanza of chat:
+ * Scott: Hey, let's chat!
+ * Helen: No.
+ *
+ * $stanzas = array(
+ *     array(
+ *         array(
+ *             'time' => '',
+ *             'author' => 'Scott',
+ *             'messsage' => "Hey, let's chat!"
+ *         ),
+ *         array(
+ *             'time' => '',
+ *             'author' => 'Helen',
+ *             'message' => 'No.'
+ *         )
+ *     )
+ * )
+ * @param string $content A string which might contain chat data.
+ * @param boolean $remove Whether to remove the found data from the passed content.
+ * @return array A chat log as structured data
+ */
+function get_content_chat( &$content, $remove = false ) {
+        $trimmed = trim( $content );
+        $newline_regex = '#^(\[.+?\])?\s?(?:(?:([^:<>]+):)|(?:<([^>\s]+)>))#';
+
+        if ( empty( $trimmed ) || ! preg_match( $newline_regex, $trimmed ) )
+                return array();
+
+        $last_index = 0;
+        $stanzas = array();
+        $lines = explode( "\n", make_clickable( $trimmed ) );
+
+        $author = $time = '';
+        $data = array();
+        $stanza = array();
+
+        foreach ( $lines as $index => $line ) {
+                $line = trim( $line );
+
+                if ( empty( $line ) ) {
+                        if ( ! empty( $author ) ) {
+                                $stanza[] = array(
+                                        'time' => $time,
+                                        'author' => $author,
+                                        'message' => join( ' ', $data )
+                                );
+                        }
+
+                        $stanzas[] = $stanza;
+                        $last_index = $index;
+                        $stanza = array();
+                        $author = $time = '';
+                        $data = array();
+                        $commentary = ! preg_match( '#[:]#', $lines[$index + 1] ) && ! preg_match( '#<[^>\s]+>#', $lines[$index + 1] );
+                        if ( ! empty( $lines[$index + 1] ) && $commentary )
+                                break;
+                }
+
+                $matches = array();
+                $matched = preg_match( $newline_regex, $line, $matches );
+                // assume username syntax if no whitespace is present
+                $no_ws = $matched && ! preg_match( '#\s#', $matches[2] );
+                // allow script-like stanzas
+                $has_ws = $matched && preg_match( '#\s#', $matches[2] ) && empty( $lines[$index + 1] ) && empty( $lines[$index - 1] );
+                if ( $matched && ( ! empty( $matches[1] ) || ( ! empty( $matches[3] ) || $no_ws || $has_ws ) ) ) {
+                        if ( ! empty( $author ) ) {
+                                $stanza[] = array(
+                                        'time' => $time,
+                                        'author' => $author,
+                                        'message' => join( ' ', $data )
+                                );
+                                $data = array();
+                        }
+
+                        $time = $matches[1];
+                        $author = empty( $matches[3] ) ? $matches[2] : $matches[3];
+                        $data[] = trim( str_replace( $matches[0], '', $line ) );
+                } elseif ( preg_match( '#\S#', $line ) ) {
+                        $data[] = $line;
+                }
+        }
+
+        if ( ! empty( $author ) ) {
+                $stanza[] = array(
+                        'time' => $time,
+                        'author' => $author,
+                        'message' => trim( join( ' ', $data ) )
+                );
+        }
+
+        if ( ! empty( $stanza ) )
+                $stanzas[] = $stanza;
+
+        if ( $remove )
+                $content = trim( join( "\n", array_slice( $lines, $last_index ) ) );
+
+        return $stanzas;
+}
+
+/**
+ * Retrieve structured chat data from the current or passed post
+ *
+ * @since 3.6.0
+ *
+ * @param int $id Optional. Post ID
+ * @return array
+ */
+function get_the_chat( $id = 0 ) {
+        $post = empty( $id ) ? get_post() : get_post( $id );
+        if ( empty( $post ) )
+                return array();
+
+        $data = get_content_chat( $post->post_content );
+        if ( empty( $data ) )
+                return array();
+
+        return $data;
+}