Changeset 489019

Timestamp:

01/12/2012 09:24:22 PM (14 years ago)

Author:

divinenephron

Message:

Added an install/uninstall procedure. Removed filters that interfered
with Latex rendering.

Location:

latex-everything/trunk

Files:

• article-to-latex.php (modified) (10 diffs)
• default-template.php (modified) (2 diffs)
• html-to-latex.php (modified) (2 diffs)
• uninstall.php (added)

latex-everything/trunk/article-to-latex.php

@@ -10 +10 @@
 */
 
- /* http://codex.wordpress.org/Function_Reference#Post.2C_Custom_Post_Type.2C_Page.2C_Attachment_and_Bookmarks_Functions
- * Probably want to create a rewrite rule so that the pdf attachment is at 
- * "/pdf" under the post itself. Use rewrite API 
- * (http://codex.wordpress.org/Rewrite_API)
- */
+// TODO: Make documentation of API and install process.
+// TODO: Extend generation to object other than posts - pages? categories? You'd just need to extend the
+//       templating and the "get latex stuff" API. You might also have to use WP-Cron more (more PDF 
+//       being written at once), and hence improve the error handling to actually save error messages.
+         
 
 define( 'PLUGIN_DIR', plugin_dir_path( __FILE__ ) );            // Plugin directory with trailing slash
@@ -32 +32 @@
     var $error;
 
+    var $unwanted_filter_functions = Array( 'wptexturize', 'convert_chars', 'esc_html', 'ent2ncr', '_wp_specialchars', 'sanitize_text_field', 'capital_P_dangit' );
+    var $removed_filters;
 
     function __construct ( $post_id ) {
@@ -39 +41 @@
     function __destruct () {
         // Unlink temporary files
+        /*
         unlink( $this->latex_file );
         unlink( $this->pdf_file );
         unlink( $this->latex_file . '.aux' );
         unlink( $this->latex_file . '.log' );
+        */
+    }
+
+    function activate () {
+        // Create cron-jobs to re-create the pdf for every post.
+        $args = Array( 'post-type' => 'post',
+                      'numberposts' => -1,
+                      'orderby' => 'post_date',
+                      'order' => 'DESC',
+                      'post_status' => null,
+                    );
+        $all_posts = get_posts( $args );
+        foreach ( $all_posts as $post )
+            wp_schedule_single_event( time(), 'a2l_activation_update_post', Array( $post->ID ) );
+    }
+
+    function deactivate () {
+        // Remove all cron jobs.
+        wp_clear_scheduled_hook('a2l_activation_update_post');
     }
 
@@ -69 +91 @@
     function make_latex_file () {
 
-        $template = $this->get_latex_template();
+        $template = $this->_get_latex_template();
 
         // Render the template        
         query_posts( 'p=' . $this->post->ID );
+        $this->_set_up_latex_filters();
         ob_start();
         include( $template );
         $latex = ob_get_clean();
+        $this->_undo_latex_filters();
         wp_reset_query();
 
@@ -102 +126 @@
     }
 
-    function get_latex_template () {
+    function _get_latex_template () {
         $template = get_query_template('latex');
         if ( empty( $template) ) {
@@ -108 +132 @@
         }
         return $template;
+    }
+
+    /* Removes filters that interfere with Latex while processing Latex templates.
+     * Records which filters were removed so that they can be added again later.
+     */
+    function _set_up_latex_filters() {
+        global $wp_filter;
+        foreach(         $wp_filter  as $tag      => $priorities ) {
+            foreach(     $priorities as $priority => $filters ) {
+                foreach( $filters    as $name     => $filter ) {
+                    if ( in_array( $filter['function'], $this->unwanted_filter_functions ) ) {
+                        $this->removed_filters[$tag][$priority][$name] = $filter;
+                        unset( $wp_filter[$tag][$priority][$name] );
+                    }
+                }
+            }
+        }
+        return;
+    }
+    
+    /* Add the filters back in again once Latex template processing has finished.
+     */
+    function _undo_latex_filters() {
+        global $wp_filter;
+        // (Doesn't quite get priorities right)
+        $wp_filter = array_merge_recursive( $wp_filter, $this->removed_filters );
+        return;
     }
     
@@ -169 +220 @@
             return WP_Error( 'wp_insert_attachment', 'Could not attach generated pdf' );
         }
+        add_post_meta( $attach_id, '_a2l_is_latex', 1, true );
         return $attach_id;
     }
@@ -197 +249 @@
 }
 
-/* Every time a post is saved run the converter.
- */
-function a2l_save_post ( $post_id ) {
+/* Update the post. Run when a post is saved, and when the plugin is activated.
+ */
+function a2l_update_post ( $post_id ) {
     if ( get_post_type( $post_id ) == 'post' && !wp_is_post_revision( $post_id ) ) {
         global $a2l;
@@ -206 +258 @@
     }
 }
-add_action('save_post', 'a2l_save_post');
+add_action('save_post', 'a2l_update_post');
+add_action('a2l_activation_update_post', 'a2l_update_post');
 
 /* If a2l_error is in the query, a previous post save created an error
@@ -223 +276 @@
 add_action( 'admin_head', 'a2l_show_errors' );
 
-
-
+register_activation_hook( __FILE__, Array( 'A2l_Article_To_Latex', 'activate' ) );
+register_deactivation_hook( __FILE__, Array( 'A2l_Article_To_Latex', 'deactivate' ) );
+
+/* API */
+
+/* Display the permalink to the Latex attachment page for the current post.
+ * (not a direct link to the pdf, use get_latex_url() for that).
+ */
+function the_latex_permalink() {
+        echo apply_filters('the_latex_permalink', get_latex_permalink());
+}
+
+
+/* Get the permalink for the current post or a post ID (not a direct link
+ * to the pdf, use get_latex_url() for that).
+ */
+function get_latex_permalink($id = 0) {
+    $attachment = get_latex_attachment( $post->ID );
+
+    if( !$attachment )
+        return '';
+    
+    return get_attachment_link($attachment->ID);
+}
+
+/* Returns a direct link to the Latex pdf for the current post or a post
+ * ID.
+ */
+function get_latex_url( $id = 0 ) {
+    $attachment = get_latex_attachment( $id );
+
+    if( !$attachment )
+        return false;
+
+    return wp_get_attachment_url( $attachment->ID );
+}
+
+/* Returns the latex attachment for the current post or a 
+ * post ID. Return false if this doesn't have one.
+ */
+function get_latex_attachment( $id=0 ) {
+    if ( is_object($id) ) {
+            $post = $id;
+    } else {
+            $post = &get_post($id);
+    }
+    if ( empty($post->ID) )
+            return false;
+
+    $args = array( 'post_type' => 'attachment',
+                   'numberposts' => 1,
+                   'post_parent' => $post->ID,
+                   'meta_key' => '_a2l_is_latex',
+                   'meta_value' => 1,
+                   ); 
+    $attachments = get_posts($args);
+    
+    if (!$attachments)
+        return false;
+
+    return $attachments[0];
+}
+?>

latex-everything/trunk/default-template.php

@@ -8 +8 @@
 <?php the_post() ?>
 
-\date{<?php the_date() ?>}
-\title{<?php the_title() ?>}
-\author{<?php the_author() ?>}
+\date{<?php h2l( get_the_date() ) ?>}
+\title{<?php h2l( get_the_title() ) ?>}
+\author{<?php h2l( get_the_author() ) ?>}
 
 \begin{document}
@@ -16 +16 @@
 \maketitle
 
-<?php html_to_latex( apply_filters('the_content',get_the_content( $more_link_text, $stripteaser, $more_file ))) ?>
+<?php h2l( apply_filters( 'the_content', get_the_content() ) ) ?>
 
 \end{document}

latex-everything/trunk/html-to-latex.php

@@ -287 +287 @@
     }
 
-    // Run on html text nodes before output
-    function quote_expansion_filter ( $text ) {
-        $text = preg_replace( '/([^\s\[\{\)~])"/', "$1''", $text );
-        $text = preg_replace( '/"/', '``', $text );
-        return $text;
-    }
-
-    // Run on html text nodes before output
-    function urlify_filter ( $text ) {
-        // Wraps urls in \url{}
-        // Lovingly stolen from http://daringfireball.net/2010/07/improved_regex_for_matching_urls
-        $pattern = '/(?i)\b((?:[a-z][\w-]+:(?:\/{1,3}|[a-z0-9%])|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}\/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:\'".,<>?«»“”‘’]))/';
-        return preg_replace( $pattern,
-                '\url{$0}',
-                $text );
-    }
-
-    // Run on <img> and <table> nodes before output
-    function float_filter ( $latex, $element ) {
-        return "\\begin{figure}[htbp]\n{$latex}\n\\end{figure}\n";
-    }
+
 }
 
 // API functions.
+function h2l ( $html ) {
+    html_to_latex( $html );
+}
 function html_to_latex ( $html ) {
     echo get_html_to_latex( $html );
@@ -321 +304 @@
 }
 
+// Filters.
+// Run on html text nodes before output
+function quote_expansion_filter ( $text ) {
+    $text = preg_replace( '/([^\s\[\{\)~])"/', "$1''", $text );
+    $text = preg_replace( '/"/', '``', $text );
+    return $text;
+}
+
+// Run on html text nodes before output
+function urlify_filter ( $text ) {
+    // Wraps urls in \url{}
+    // Lovingly stolen from http://daringfireball.net/2010/07/improved_regex_for_matching_urls
+    $pattern = '/(?i)\b((?:[a-z][\w-]+:(?:\/{1,3}|[a-z0-9%])|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}\/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:\'".,<>?«»“”‘’]))/';
+    return preg_replace( $pattern,
+            '\url{$0}',
+            $text );
+}
+
+// Run on <img> and <table> nodes before output
+function float_filter ( $latex ) {
+    return "\\begin{figure}[htbp]\n{$latex}\n\\end{figure}\n";
+}
+
 // Register filters
-add_filter('a2l_img_element', array('A2l_Html_To_Latex', 'float_filter'), 98);
-add_filter('a2l_table_element', array('A2l_Html_To_Latex', 'float_filter'), 98);
-add_filter('a2l_text', array('A2l_Html_To_Latex', 'urlify_filter'), 98);
-add_filter('a2l_text', array('A2l_Html_To_Latex', 'quote_expansion_filter'), 99);
+add_filter('a2l_img_element', 'float_filter', 98);
+add_filter('a2l_table_element', 'float_filter', 98);
+add_filter('a2l_text', 'urlify_filter', 98);
+add_filter('a2l_text','quote_expansion_filter', 99);
 
 ?>
-