summaryrefslogtreecommitdiff
blob: 3778b9f4a4cfe641b202e26ddded7269bad8d19f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
<?php
/*
Plugin Name: WP-Syntax
Plugin URI: http://www.connections-pro.com
Description: Syntax highlighting using <a href="http://qbnz.com/highlighter/">GeSHi</a> supporting a wide range of popular languages.
Version: 1.1
Author: Steven A. Zahm
Author URI: http://www.connections-pro.com
License: GPL2
Text Domain: wp_syntax
Domain Path: /lang

Original Author: Ryan McGeary

Copyright 2013  Steven A. Zahm  (email : helpdesk@connections-pro.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
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

/*
@todo integrate TinyMCE button support using one of these as a base:
	http://wordpress.org/extend/plugins/wp-syntax-integration/
	http://wordpress.org/extend/plugins/wp-syntax-button/
@todo Merge this add-on plugin functionality:  http://wordpress.org/extend/plugins/wp-syntax-download-extension/

Look at these:	http://wordpress.org/extend/plugins/wp-synhighlight/
				http://wordpress.org/extend/plugins/wp-codebox/
 */

if ( ! class_exists( 'WP_Syntax' ) ) {

	class WP_Syntax {

		/**
		 * @var  WP_Syntax stores the instance of this class.
		 */
		private static $instance;

		private static $token;

		private static $matches;

		// Used for caching
		private static $cache = array();
		private static $cache_generate = false;
		private static $cache_match_num = 0;

		/**
		 * A dummy constructor to prevent WP_Syntax from being loaded more than once.
		 *
		 * @access private
		 * @since 1.0
		 * @see WP_Syntax::instance()
		 * @see WP_Syntax();
		 */
		private function __construct() { /* Do nothing here */ }

		/**
		 * Main WP_Syntax Instance
		 *
		 * Insures that only one instance of WP_Syntax exists in memory at any one time.
		 *
		 * @access public
		 * @since  1.0
		 *
		 * @return WP_Syntax
		 */
		public static function getInstance() {
			if ( ! isset( self::$instance ) ) {
				self::$instance = new self;
				self::$instance->init();
			}
			return self::$instance;
		}

		/**
		 * Initiate the plugin.
		 *
		 * @access private
		 * @since 1.0
		 * @return void
		 */
		private function init() {

			self::defineConstants();
			self::inludeDependencies();

			self::$token = md5( uniqid( rand() ) );

			self::$matches = array();

			// Nothing to do during activation/deactivation yet...
			// register_activation_hook( dirname(__FILE__) . '/wp-syntax.php', array( __CLASS__, 'activate' ) );
			// register_deactivation_hook( dirname(__FILE__) . '/wp-syntax.php', array( __CLASS__, 'deactivate' ) );

			// Nothing to translate presently.
			// load_plugin_textdomain( 'wp_syntax' , false , WPS__DIR_NAME . 'lang' );

			//Invalidate cache whenever new/updated posts/comments are made
			add_action( 'save_post', array( __CLASS__, 'invalidatePostCache' ) );
			add_action( 'comment_post', array( __CLASS__, 'invalidateCommentCache' ) );
			add_action( 'edit_comment', array( __CLASS__, 'invalidateCommentCache' ) );

			add_action( 'wp_enqueue_scripts', array( __CLASS__, 'enqueueScripts' ) );

			// Update config for WYSIWYG editor to accept the pre tag and its attributes.
			add_filter( 'tiny_mce_before_init', array( __CLASS__,'tinyMCEConfig') );

			// We want to run before other filters; hence, a priority of 0 was chosen.
			// The lower the number, the higher the priority.  10 is the default and
			// several formatting filters run at or around 6.
			add_filter( 'the_content', array( __CLASS__, 'beforeFilter' ), 0 );
			add_filter( 'the_excerpt', array( __CLASS__, 'beforeFilter' ), 0 );
			add_filter( 'comment_text', array( __CLASS__, 'beforeFilter' ), 0 );

			// We want to run after other filters; hence, a priority of 99.
			add_filter( 'the_content', array( __CLASS__, 'afterFilterContent' ), 99 );
			add_filter( 'the_excerpt', array( __CLASS__, 'afterFilterExcerpt' ), 99 );
			add_filter( 'comment_text', array( __CLASS__, 'afterFilterComment' ), 99 );
		}

		/**
		 * Define the constants.
		 *
		 * @access private
		 * @since 1.0
		 * @return void
		 */
		private static function defineConstants() {

			define( 'WPS_VERSION', '1.1' );

			define( 'WPS_DIR_NAME', plugin_basename( dirname( __FILE__ ) ) );
			define( 'WPS_BASE_NAME', plugin_basename( __FILE__ ) );
			define( 'WPS_BASE_PATH', plugin_dir_path( __FILE__ ) );
			define( 'WPS_BASE_URL', plugin_dir_url( __FILE__ ) );

		}

		public static function invalidatePostCache( $post_id ) {

			delete_post_meta( $post_id, 'wp-syntax-cache-content' );
			delete_post_meta( $post_id, 'wp-syntax-cache-excerpt' );
		}

		public static function invalidateCommentCache( $comment_id ) {

			delete_comment_meta( $comment_id, 'wp-syntax-cache-comment' );
		}

		private static function inludeDependencies() {

			include_once( 'geshi/geshi.php' );

		}

		/**
		 * Called when activating  via the activation hook.
		 *
		 * @access private
		 * @since 1.0
		 * @return void
		 */
		public static function activate() {

		}

		/**
		 * Called when deactivating via the deactivation hook.
		 *
		 * @access private
		 * @since 1.0
		 * @return void
		 */
		public static function deactivate() {

		}

		/**
		 * Enqueue the CSS and JavaScripts.
		 *
		 * @access private
		 * @since 1.0
		 * @return void
		 */
		public static function enqueueScripts() {

			// If a wp-syntax.css file exists in the theme folder use it instead.
			$url = file_exists( STYLESHEETPATH . '/wp-syntax.css' ) ? get_bloginfo( 'stylesheet_directory' ) . '/wp-syntax.css' : WPS_BASE_URL . 'css/wp-syntax.css';

			// Enqueue the CSS
			wp_enqueue_style( 'wp-syntax-css', $url, array(), WPS_VERSION );

			// Enqueue the Adobe Source Code Pro font
			//wp_enqueue_style( 'source-code-font', 'http://fonts.googleapis.com/css?family=Source+Code+Pro');

			// Enqueue the JavaScript
			wp_enqueue_script( 'wp-syntax-js', WPS_BASE_URL . 'js/wp-syntax.js', array( 'jquery' ), WPS_VERSION, TRUE );

		}

		/**
		 * Update the TinyMCE config to add support for the pre tag and its attributes.
		 *
		 * @access private
		 * @since 0.9.13
		 * @param  array $init The TinyMCE config.
		 * @return array
		 */
		public static function tinyMCEConfig( $init ) {

			$ext = 'pre[id|name|class|style|lang|line|escaped|highlight|src]';

			if ( isset( $init['extended_valid_elements'] ) ) {
				$init['extended_valid_elements'] .= "," . $ext;
			} else {
				$init['extended_valid_elements'] = $ext;
			}

			return $init;
		}

		// special ltrim b/c leading whitespace matters on 1st line of content
		public static function trimCode( $code ) {
			$code = preg_replace("/^\s*\n/siU", '', $code);
			$code = rtrim ($code );
			return $code;
		}

		public static function substituteToken( &$match ) {
			// global $wp_syntax_token, $wp_syntax_matches;

			$i = count( self::$matches );
			self::$matches[ $i ] = $match;

			return "\n\n<p>" . self::$token . sprintf( '%03d', $i ) . "</p>\n\n";
		}

		public static function lineNumbers( $code, $start ) {

			$line_count = count( explode( "\n", $code ) );
			$output = '<pre>';

			for ( $i = 0; $i < $line_count; $i++ ) {
				$output .= ( $start + $i ) . "\n";
			}

			$output .= '</pre>';

			return $output;
		}

		public static function caption( $url ) {

			$parsed = parse_url( $url );
			$path = pathinfo( $parsed['path'] );
			$caption = '';

			if ( ! isset( $path['filename'] ) ) {
				return '';
			}

			if ( isset( $parsed['scheme'] ) ) {
				$caption .= '<a href="' . $url . '">';
			}

			if ( isset( $parsed["host"] ) && $parsed["host"] == 'github.com' )
			{
				$caption .= substr( $parsed['path'], strpos( $parsed['path'], '/', 1 ) ); /* strip github.com username */
			} else {
				$caption .= $parsed['path'];
			}

			/* $caption . $path["filename"];
			if (isset($path["extension"])) {
				$caption .= "." . $path["extension"];
			}*/

			if ( isset($parsed['scheme']) ) {
				$caption .= '</a>';
			}

			return $caption;
		}

		public static function highlight( $match ) {
			// global $wp_syntax_matches;

			// Keep track of which <pre> tag we're up to
			self::$cache_match_num++;

			// Do we have cache? Serve it!
			if ( isset( self::$cache[ self::$cache_match_num ] ) ) {
				return self::$cache[ self::$cache_match_num ];
			}

			$i = intval( $match[1] );
			$match = self::$matches[ $i ];

			$language = strtolower( trim( $match[1] ) );
			$line = trim( $match[2] );
			$escaped = trim( $match[3] );
			$caption = self::caption( $match[5] );
			$code = self::trimCode( $match[6] );

			if ( $escaped == 'true' ) $code = htmlspecialchars_decode( $code );

			$geshi = new GeSHi( $code, $language );
			$geshi->enable_keyword_links( FALSE );

			do_action_ref_array( 'wp_syntax_init_geshi', array( &$geshi ) );

			if ( ! empty( $match[4] ) ) {

				$linespecs = strpos( $match[4], ",") == FALSE ? array( $match[4] ) : explode( ',', $match[4] );
				$lines = array();

				foreach ( $linespecs as $spec ) {
					$range = explode( '-', $spec );
					$lines = array_merge( $lines, ( count( $range ) == 2) ? range( $range[0], $range[1]) : $range );
				}

				$geshi->highlight_lines_extra( $lines );
			}

			$output = "\n" . '<div class="wp_syntax" style="position:relative;">';
			$output .= '<table>';

			if ( ! empty( $caption ) ) {
				$output .= '<caption>' . $caption . '</caption>';
			}

			$output .= '<tr>';

			if ( $line ) {
				$output .='<td class="line_numbers">' . self::lineNumbers( $code, $line ) . '</td>';
			}

			$output .= '<td class="code">';
			$output .= $geshi->parse_code();
			$output .= '</td></tr></table>';
			$output .= '<p class="theCode" style="display:none;">'.htmlspecialchars($code).'</p>';
			$output .= '</div>' . "\n";

			if ( self::$cache_generate ) {
				self::$cache[ self::$cache_match_num ] = $output;
			}

			return $output;
		}

		/**
		 * @param string $content
		 *
		 * @return string
		 */
		public static function beforeFilter( $content ) {

			/*
			 * Run this only after the page head has been rendered.
			 * This is to make it compatible with Yoast SEO. Unfortunately if this filter is run any sooner, any shortcodes
			 * which may exist in the post/page content is stripped by Yoast SEO so when code blocks are cached, they will be
			 * cached without the shortcodes in the code blocks. Other than this it seems to work correctly.
			 *
			 * NOTE: Yoast seems to do this as part of rendering the opengraph in the page head.
			 */
			if ( did_action( 'wp_print_scripts' ) ) {

				return preg_replace_callback(
					"/\s*<pre(?:lang=[\"']([\w-]+)[\"']|line=[\"'](\d*)[\"']|escaped=[\"'](true|false)?[\"']|highlight=[\"']((?:\d+[,-])*\d+)[\"']|src=[\"']([^\"']+)[\"']|\s)+>(.*)<\/pre>\s*/siU",
					array( __CLASS__, 'substituteToken' ),
					$content
				);
			}

			return $content;
		}

		public static function afterFilterContent( $content ) {

			global $post;

			$the_post    = $post;
			$the_post_id = $post->ID;

			//Reset cache settings on each filter - we might be showing
			//multiple posts on the one page
			self::$cache           = array();
			self::$cache_match_num = 0;
			self::$cache_generate  = FALSE;

			if ( is_object( $the_post ) ) {
				self::$cache = get_post_meta( $the_post_id, 'wp-syntax-cache-content', TRUE );

				if ( ! self::$cache ) {
					//Make sure self::$cache is an array
					self::$cache = array();
					//Inform the highlight() method that we're regenning
					self::$cache_generate = TRUE;
				}
			}

			$content = self::afterFilter( $content );

			//Update cache if we're generating and were there <pre> tags generated
			if ( is_object( $the_post ) && self::$cache_generate && self::$cache ) {
				update_post_meta( $the_post_id, 'wp-syntax-cache-content', wp_slash( self::$cache ) );
			}

			return $content;
		}

		public static function afterFilterExcerpt( $content ) {

			global $post;
			$the_post    = $post;
			$the_post_id = $post->ID;

			//Reset cache settings on each filter - we might be showing
			//multiple posts on the one page
			self::$cache           = array();
			self::$cache_match_num = 0;
			self::$cache_generate  = FALSE;

			if ( is_object( $the_post ) ) {
				self::$cache = get_post_meta( $the_post_id, 'wp-syntax-cache-excerpt', TRUE );

				if ( ! self::$cache ) {
					//Make sure self::$cache is an array
					self::$cache = array();
					//Inform the highlight() method that we're regenning
					self::$cache_generate = TRUE;
				}
			}

			$content = self::afterFilter( $content );

			//Update cache if we're generating and were there <pre> tags generated
			if ( is_object( $the_post ) && self::$cache_generate && self::$cache ) {
				update_post_meta( $the_post_id, 'wp-syntax-cache-excerpt', self::$cache );
			}

			return $content;
		}

		public static function afterFilterComment( $content ) {

			global $comment;
			$the_post    = $comment;
			$the_post_id = $comment->comment_ID;

			if ( is_object( $the_post ) ) {
				self::$cache = get_comment_meta( $the_post_id, 'wp-syntax-cache-comment', TRUE );

				if ( ! self::$cache ) {
					//Make sure self::$cache is an array
					self::$cache = array();
					//Inform the highlight() method that we're regenning
					self::$cache_generate = TRUE;
				}
			}

			$content = self::afterFilter( $content );

			//Update cache if we're generating and were there <pre> tags generated
			if ( is_object( $the_post ) && self::$cache_generate && self::$cache ) {
				update_comment_meta( $the_post_id, 'wp-syntax-cache-comment', self::$cache );
			}

			return $content;
		}

		public static function afterFilter( $content ) {
			// global $wp_syntax_token;

			$content = preg_replace_callback(
				'/<p>\s*' . self::$token . '(\d{3})\s*<\/p>/si',
				array( __CLASS__, 'highlight' ),
				$content
			);

			return $content;
		}

	}

	/**
	 * The main function responsible for returning the WP_Syntax instance
	 * to functions everywhere.
	 *
	 * Use this function like you would a global variable, except without needing
	 * to declare the global.
	 *
	 * Example: <?php $wp_syntex = WP_Syntax(); ?>
	 *
	 * @access public
	 * @since 1.0
	 * @return WP_Syntax
	 */
	function WP_Syntax() {
		return WP_Syntax::getInstance();
	}

	/**
	 * Start the plugin.
	 */
	add_action( 'plugins_loaded', 'WP_Syntax' );

}