refinements

jekyll-export.php

@@ -1,17 +1,16 @@
 <?php
 /*
-Plugin Name: Name Of The Plugin
-Plugin URI: http://URI_Of_Page_Describing_Plugin_and_Updates
-Description: A brief description of the Plugin.
-Version: The Plugin's Version Number, e.g.: 1.0
-Author: Name Of The Plugin Author
-Author URI: http://URI_Of_The_Plugin_Author
-License: A "Slug" license name e.g. GPL2
+Plugin Name: WordPress to Jekyll Exporter
+Description: Exports WordPress posts, pages, and options as YAML files parsable by Jekyll
+Version: 1.0
+Author: Benjamin J. Balter
+Author URI: http://ben.balter.com
+License: GPLv3 or Later
 
-Copyright YEAR  PLUGIN_AUTHOR_NAME  (email : PLUGIN AUTHOR EMAIL)
+Copyright 2012  Benjamin J. Balter  (email : Ben@Balter.com)
 
 This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License, version 2, as 
+it under the terms of the GNU General Public License, version 2, as
 published by the Free Software Foundation.
 
 This program is distributed in the hope that it will be useful,
@@ -26,130 +25,220 @@
 
 class Jekyll_Export {
 
-	private $zip_folder = 'jekyll-export/';
-
+	private $zip_folder = 'jekyll-export/'; //folder zip file extracts to
+	public $rename_options = array( 'site', 'blog' ); //strings to strip from option keys on export
+
+	/**
+	 * Hook into WP Core
+	 */
 	function __construct() {
-
-		if ( !class_exists( 'spyc' ) )
-			require_once( dirname( __FILE__ ) . '/spyc.php' );
-
-		if ( !class_exists( 'Markdownify' ) )
-			require_once( dirname( __FILE__ ) . '/markdownify/markdownify.php' );
-
-		$this->dir = sys_get_temp_dir() . '/wp-jekyll-' . md5( time() ) . '/';
-		$this->zip = sys_get_temp_dir() . '/wp-jekyll.zip';
-		mkdir( $this->dir );
-		mkdir( $this->dir . '_posts/' );
-
+
+		add_action( 'admin_menu', array( &$this, 'register_menu' ) );
+		add_action( 'current_screen', array( &$this, 'callback' ) );
+
 	}
-
+
+
+	/**
+	 * Listens for page callback, intercepts and runs export
+	 */
+	function callback() {
+
+		if ( get_current_screen()->id != 'jekyll-export' )
+			return;
+
+		if ( !current_user_can( 'manage_options' ) )
+			return;
+
+		$this->export();
+		exit();
+
+	}
+
+
+	/**
+	 * Add menu option to tools list
+	 */
+	function register_menu() {
+
+		add_submenu_page( 'tools.php', __( 'Export to Jekyll', 'jekyll-export' ), __( 'Export to Jekyll', 'jekyll-export' ), 'manage_options', 'jekyll-export', null );
+
+	}
+
+
+	/**
+	 * Get an array of all post and page IDs
+	 * Note: We don't use core's get_posts as it doesn't scale as well on large sites
+	 */
 	function get_posts() {
-		
+
 		global $wpdb;
 		return $wpdb->get_col( "SELECT ID FROM $wpdb->posts WHERE post_status IN ( 'publish', 'draft' ) AND post_type IN ('post', 'page' )" );
-		
+
 	}
-
+
+
+	/**
+	 * Convert a posts meta data (both post_meta and the fields in wp_posts) to key value pairs for export
+	 */
 	function convert_meta( $post ) {
-
-		foreach( $post as $key => $value ) {
-
+
+		//convert non-content columns in wp_posts table
+		foreach ( $post as $key => $value ) {
+
 			if ( $key == 'post_content' )
 				continue;
-
+
+			//strip post_ from the key, as it will be page.foo in jekyll
 			$key = str_replace( 'post_', '', $key );
 			$output[ strtolower( $key)  ] = $value;
-			
+
 		}
-
+
+		//convert traditional post_meta values, hide hidden values
 		foreach ( get_post_custom( $post ) as $key => $value ) {
-			
+
 			if ( substr( $key, 0, 1 ) == '_' )
 				continue;
-		
+
 			$output[ $key ] = $value;
-			
+
 		}
-		
+
 		return $output;
-		
+
 	}
-
+
+
+	/**
+	 * Convert post taxonomies for export
+	 */
 	function convert_terms( $post ) {
 
 		$output = array();
-		foreach( get_taxonomies( array( 'object_type' => array( get_post_type( $post ) ) ) ) as $tax ) { 
+		foreach ( get_taxonomies( array( 'object_type' => array( get_post_type( $post ) ) ) ) as $tax ) {
 			$terms = wp_get_post_terms( $post, $tax );
 			$output[ $tax ] = wp_list_pluck( $terms, 'name' );
 		}
-		
+
 		return $output;
-		
+
 	}
-
-	function convert() {
 
-		$this->convert_options();
-
+
+	/**
+	 * Loop through and convert all posts to MD files with YAML headers
+	 */
+	function convert_posts() {
+
 		foreach ( $this->get_posts() as $postID ) {
-			$md = new Markdownify;
+			$md = new Markdownify_Extra();
 			$post = get_post( $postID );
-			$meta = $this->convert_meta( $post );
-			$meta = array_merge( $meta, $this->convert_terms( $postID ) );
+			$meta = array_merge( $this->convert_meta( $post ), $this->convert_terms( $postID ) );
 			$output = Spyc::YAMLDump($meta);
-			$output .= "\n---\n";
+			$output .= "---\n";
 			$output .= $md->parseString( apply_filters( 'the_content', $post->post_content ) );
 			$this->write( $output, $post );
 		}
-
+
+	}
+
+
+	/**
+	 * Main function, bootstraps, converts, and cleans up
+	 */
+	function export() {
+
+		if ( !class_exists( 'spyc' ) )
+			require_once dirname( __FILE__ ) . '/includes/spyc.php';
+
+		if ( !function_exists( 'Markdown' ) )
+			require_once dirname( __FILE__ ) . '/includes/markdownify/markdownify_extra.php';
+
+		$this->dir = sys_get_temp_dir() . '/wp-jekyll-' . md5( time() ) . '/';
+		$this->zip = sys_get_temp_dir() . '/wp-jekyll.zip';
+		mkdir( $this->dir );
+		mkdir( $this->dir . '_posts/' );
+
+		$this->convert_options();
+		$this->convert_posts();
 		$this->zip();
 		$this->send();
-
+		$this->cleanup();
+
 	}
-
+
+
+	/**
+	 * Convert options table to _config.yml file
+	 */
 	function convert_options() {
-		
+
 		$options = wp_load_alloptions();
 		foreach ( $options as $key => &$option ) {
 
 			if ( substr( $key, 0, 1 ) == '_' )
 				unset( $options[$key] );
-
+
+			//strip site and blog from key names, since it will become site. when in Jekyll
+			foreach ( $this->rename_options as $rename ) {
+
+				$len = strlen( $rename );
+				if ( substr( $key, 0, $len ) != $rename )
+					continue;
+
+				$this->rename_key( $options, $key, substr( $key, $len ) );
+
+			}
+
 			$option = maybe_unserialize( $option );
 
 		}
-		
+
 		$output = Spyc::YAMLDump( $options );
-		$output .= '---';
-
-		file_put_contents( $this->dir . '_config.yml', $output );
 
+		//strip starting "---"
+		$output = substr( $output, 4 );
+
+		file_put_contents( $this->dir . '_config.yml', $output );
 
 	}
-
+
+
+	/**
+	 * Write file to temp dir
+	 */
 	function write( $output, $post ) {
-		
+
 		$filename = ( get_post_type( $post ) == 'post' ) ? date( 'Y-m-d' ) . '-' . $post->post_name . '.md': $post->post_name . '.md';
 		$prefix = ( get_post_type( $post ) == 'post' ) ? '_posts/' : '';
 		file_put_contents( $this->dir . $prefix . $filename, $output );
-		
+
 	}
-
+
+
+	/**
+	 * Zip temp dir
+	 */
 	function zip() {
-		
+
 		//create zip
 		$zip = new ZipArchive();
 		$zip->open( $this->zip, ZIPARCHIVE::CREATE );
-		
+
 		$this->_zip( $this->dir . '_config.yml', $zip );
 		$this->_zip( $this->dir . '*.md', $zip );
-		$this->_zip( $this->dir . '_posts/*.md', $zip );			
+		$this->_zip( $this->dir . '_posts/*.md', $zip );
 		$zip->close();
-		
+
 	}
-
+
+
+	/**
+	 * Helper function to add a file to the zip
+	 */
 	function _zip( $q, &$zip ) {
-		
+
 		//loop through all files in directory
 		foreach ( glob( $q ) as $path ) {
 
@@ -158,35 +247,66 @@ function _zip( $q, &$zip ) {
 
 			//add file
 			$zip->addFile( realpath( $path ), $local_path );
-		
+
 		}
-		
+
 	}
-
+
+
+	/**
+	 * Send headers and zip file to user
+	 */
 	function send() {
-		
+
 		//send headers
 		header( 'Content-Type: application/zip' );
 		header( "Content-Disposition: attachment; filename=jekyll-export.zip" );
 		header( 'Content-Length: ' . filesize( $this->zip ) );
-		
+
 		//read file
 		readfile( $this->zip );
-		    	
+
 	}
-
-	function __destruct( ) {
+
+
+	/**
+	 * Clear temp files
+	 */
+	function cleanup( ) {
+
+		foreach ( glob( $this->dir . '_posts/*' ) as $file )
+			unlink( $file );
 
 		foreach ( glob( $this->dir . '*' ) as $file )
 			unlink( $file );
-
+
+		rmdir( $this->dir . '_posts/' );
 		rmdir( $this->dir );
+
 		unlink( $this->zip );
 
 	}
 
-
+
+	/**
+	 * Rename an assoc. array's key without changing the order
+	 */
+	function rename_key( &$array, $from, $to ) {
+
+		$keys = array_keys( $array );
+		$index = array_search( $from, $keys );
+
+		if ( $index === false )
+			return;
+
+		$keys[ $index ] = $to;
+		$array = array_combine( $keys, $array );
+
+
+	}
+
+
 }
 
-$je = new Jekyll_Export();
-$je->convert();
+
+$je = new Jekyll_Export();