wp-print-friendly.php 31 KB
Newer Older
1 2 3 4 5
<?php
/*
Plugin Name: WP Print Friendly
Plugin URI: http://www.thinkoomph.com/plugins-modules/wp-print-friendly/
Description: Extends WordPress' template system to support printer-friendly templates. Works with permalink structures to support nice URLs.
6 7
Author: Erick Hitter, Steven K Word & Oomph, Inc.
Version: 0.5.3
8
Author URI: http://www.thinkoomph.com/
Erick Hitter's avatar
Erick Hitter committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

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
23 24 25 26
*/

class wp_print_friendly {
	var $query_var = 'print';
27

28
	var $ns = 'wp_print_friendly';
29

30 31 32 33 34 35 36 37 38 39 40 41
	var $settings_key = 'wpf';
	var $settings_defaults = array(
		'auto' => false,
		'placement' => 'below',
		'post_types' => array( 'post', 'page' ),
		'print_text' => 'Print this entry',
		'print_text_page' => 'Print this page',
		'css_class' => 'print_link',
		'link_target' => 'same',
		'endnotes' => true,
		'endnotes_label' => 'Endnotes:'
	);
42

43
	var $notice_key = 'wpf_admin_notice_dismissed';
44

Erick Hitter's avatar
Erick Hitter committed
45
	/**
46
	 * Register deactivation hook and filter.
Erick Hitter's avatar
Erick Hitter committed
47
	 *
48 49 50
	 * @uses register_deactivation_hook, add_filter
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
51
	public function __construct() {
52 53 54
		register_deactivation_hook( __FILE__, array( $this, 'deactivation_hook' ) );
		add_action( 'plugins_loaded', array( $this, 'action_plugins_loaded' ) );
	}
55

Erick Hitter's avatar
Erick Hitter committed
56
	/**
57
	 * Clean up after plugin deactivation.
Erick Hitter's avatar
Erick Hitter committed
58
	 *
59 60 61 62
	 * @uses flush_rewrite_rules, delete_option
	 * @action register_deactivation_hook
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
63
	public function deactivation_hook() {
64
		flush_rewrite_rules();
65

66 67 68
		delete_option( $this->settings_key );
		delete_option( $this->notice_key );
	}
69

Erick Hitter's avatar
Erick Hitter committed
70
	/**
71
	 * Register actions and filters.
Erick Hitter's avatar
Erick Hitter committed
72
	 *
73 74 75 76
	 * @uses add_action, add_filter, get_option
	 * @action plugins_loaded
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
77
	public function action_plugins_loaded() {
78 79 80 81 82 83
		add_action( 'init', array( $this, 'action_init' ), 20 );
		add_action( 'admin_init', array( $this, 'action_admin_init' ) );
		add_action( 'admin_menu', array( $this, 'action_admin_menu' ) );
		add_filter( 'request', array( $this, 'filter_request' ) );
		add_action( 'pre_get_posts', array( $this, 'action_pre_get_posts' ) );
		add_filter( 'template_include', array( $this, 'filter_template_include' ) );
Erick Hitter's avatar
Erick Hitter committed
84
		add_filter( 'redirect_canonical', array( $this, 'filter_redirect_canonical' ) );
85 86 87 88
		add_filter( 'body_class', array( $this, 'filter_body_class' ) );
		add_filter( 'the_content', array( $this, 'filter_the_content' ), 0 );
		add_filter( 'the_content', array( $this, 'filter_the_content_auto' ) );
		add_filter( 'the_content', array( $this, 'filter_the_content_late' ), 99 );
89

Erick Hitter's avatar
Erick Hitter committed
90
		if ( ! get_option( $this->notice_key ) )
91 92
			add_action( 'admin_notices', array( $this, 'action_admin_notices_activation' ) );
	}
93

Erick Hitter's avatar
Erick Hitter committed
94
	/**
95
	 * Add print endpoint and rewrite rules for term taxonomy archives
Erick Hitter's avatar
Erick Hitter committed
96 97
	 *
	 * @uses add_rewrite_endpoint, $wp_rewrite, get_taxonomies, add_rewrite_rule, trailingslashit
98 99 100
	 * @action init
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
101
	public function action_init() {
102
		add_rewrite_endpoint( $this->query_var, EP_ALL );
103

104
		global $wp_rewrite;
105 106

		//Taxonomies, since they aren't covered by add_rewrite_endpoint
Erick Hitter's avatar
Erick Hitter committed
107
		if ( $wp_rewrite->permalink_structure ) {
108
			$taxonomies = get_taxonomies( array(), 'objects' );
Erick Hitter's avatar
Erick Hitter committed
109 110
			foreach ( $taxonomies as $taxonomy => $args ) {
				if ( $args->rewrite == false || 'post_format' == $taxonomy )
111
					continue;
112

113
				$taxonomy_slug = '';
Erick Hitter's avatar
Erick Hitter committed
114
				if ( $args->rewrite[ 'with_front' ] && $wp_rewrite->front != '/' ) $taxonomy_slug .= $wp_rewrite->front;
115
				$taxonomy_slug .= $args->rewrite[ 'slug' ];
116

117
				$query_var = $args->query_var ? $args->query_var : 'taxonomy=' . $taxonomy . '&term';
118 119

				add_rewrite_rule( $taxonomy_slug . '/(.+)/' . $this->query_var . '(/([0-9]*))?/?$', $wp_rewrite->index . '?' . $query_var . '=$matches[1]&' . $this->query_var . '=$matches[3]', 'top' );
120 121
			}
		}
122 123 124

		//Extra rules needed if verbose page rules are requested
		if ( $wp_rewrite->use_verbose_page_rules ) {
125
			//Build regex
126 127 128 129
			$regex = substr( str_replace( $wp_rewrite->rewritecode, $wp_rewrite->rewritereplace, $wp_rewrite->permalink_structure ), 1 );
			$regex = trailingslashit( $regex );
			$regex .= $this->query_var . '(/([0-9]*))?/?$';

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
			//Build corresponding query string
			$query = substr( str_replace( $wp_rewrite->rewritecode, $wp_rewrite->queryreplace, $wp_rewrite->permalink_structure ), 1 );
			$query = explode( '/', $query );
			$query = array_filter( $query );

			$i = 1;
			foreach ( $query as $key => $qv ) {
				$query[ $key ] .= '$matches[' . $i . ']';
				$i++;
			}

			$query[] = $this->query_var . '=$matches[' . ( $i + 1 ) . ']';

			$query = implode( '&', $query );

			//Add rule
			add_rewrite_rule( $regex, $wp_rewrite->index . '?' . $query, 'top' );
147
		}
148
	}
149

Erick Hitter's avatar
Erick Hitter committed
150
	/**
151
	 * Register plugin option and disable rewrite rule flush warning.
Erick Hitter's avatar
Erick Hitter committed
152
	 *
153 154 155 156
	 * @uses register_setting, update_option
	 * @action admin_init
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
157
	public function action_admin_init() {
158
		register_setting( $this->settings_key, $this->settings_key, array( $this, 'admin_options_validate' ) );
159

Erick Hitter's avatar
Erick Hitter committed
160
		if ( isset( $_GET[ $this->notice_key ] ) )
161 162
			update_option( $this->notice_key, 1 );
	}
163

Erick Hitter's avatar
Erick Hitter committed
164
	/**
165
	 * Determine if print template is being requested.
Erick Hitter's avatar
Erick Hitter committed
166
	 *
167 168
	 * If WordPress determined this request is a 404, do nothing and let the main theme handle things.
	 *
169
	 * @global $wp_query
170
	 * @uses is_404
171 172
	 * @return bool
	 */
Erick Hitter's avatar
Erick Hitter committed
173
	public function is_print() {
174
		global $wp_query;
175
		return is_array( $wp_query->query ) && array_key_exists( $this->query_var, $wp_query->query ) && ! is_404();
176
	}
177

Erick Hitter's avatar
Erick Hitter committed
178
	/**
179 180
	 * Select appropriate template based on post type and available templates.
	 * Returns an array with name and path keys for available template or false if no template is found.
Erick Hitter's avatar
Erick Hitter committed
181
	 *
182 183 184
	 * @uses get_queried_object, is_home, is_front_page, locate_template
	 * @return array or false
	 */
Erick Hitter's avatar
Erick Hitter committed
185
	public function template_chooser() {
186 187
		//Get queried object to check post type
		$queried_object = get_queried_object();
188

189 190
		//Get plugin path
		$pluginpath = dirname( __FILE__ );
191

Erick Hitter's avatar
Erick Hitter committed
192
		if ( ( is_home() || is_front_page() ) && ( '' !== ( $path = locate_template( 'wpf-home.php', false ) ) ) ) {
193 194 195 196
			$template = array(
				'name' => 'wpf-home',
				'path' => $path
			);
197
		} elseif (
198 199 200
			is_object( $queried_object ) &&
			property_exists( $queried_object, 'taxonomy' ) &&
			property_exists( $queried_object, 'slug' ) &&
201
			( '' !== ( $path = locate_template( array( 'wpf-' . $queried_object->taxonomy . '-' . $queried_object->slug . '.php', 'wpf-' . $queried_object->taxonomy . '.php' ), false ) ) )
202
		) {
203 204 205 206
			$template = array(
				'name' => 'wpf-' . $queried_object->taxonomy,
				'path' => $path
			);
207
		} elseif (
208 209 210 211
			is_object( $queried_object ) &&
			property_exists( $queried_object, 'post_type' ) &&
			property_exists( $queried_object, 'post_name' ) &&
			( '' !== ( $path = locate_template( array( 'wpf-' . $queried_object->post_type . '-' . $queried_object->post_name . '.php', 'wpf-' . $queried_object->post_type . '.php' ), false ) ) )
212
		) {
213 214 215 216
			$template = array(
				'name' => 'wpf-' . $queried_object->post_type,
				'path' => $path
			);
217
		} elseif (
218 219 220
			is_object( $queried_object ) &&
			property_exists( $queried_object, 'post_name' ) &&
			( '' !== ( $path = locate_template( 'wpf-' . $queried_object->post_name . '.php', false ) ) )
221
		) {
222 223 224 225
			$template = array(
				'name' => 'wpf-' . $queried_object->post_name,
				'path' => $path
			);
226
		} elseif ( '' !== ( $path = locate_template( 'wpf.php', false ) ) ) {
227 228 229 230
			$template = array(
				'name' => 'wpf-default',
				'path' => $path
			);
231
		} elseif ( file_exists( $pluginpath . '/default-template.php' ) ) {
232 233 234 235
			$template = array(
				'name' => 'wpf-plugin-default',
				'path' => $pluginpath . '/default-template.php'
			);
236
		}
237

238 239
		return isset( $template ) ? $template : false;
	}
240

Erick Hitter's avatar
Erick Hitter committed
241 242 243
	/**
	 * Detect request for print stylesheet on the homepage and reset query variables.
	 *
244 245 246 247
	 * @param array $qv
	 * @filter request
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
248 249
	public function filter_request( $qv ) {
		if ( array_key_exists( 'pagename', $qv ) && $qv[ 'pagename' ] == $this->query_var ) {
250 251 252 253
			$qv[ $this->query_var ] = '';
			unset( $qv[ 'page' ] );
			unset( $qv[ 'pagename' ] );
		}
254

Erick Hitter's avatar
Erick Hitter committed
255
		if ( array_key_exists( $this->query_var, $qv ) && is_numeric( $qv[ $this->query_var ] ) )
256
			$qv[ 'page' ] = intval( $qv[ $this->query_var ] );
257

258 259
		return $qv;
	}
260

Erick Hitter's avatar
Erick Hitter committed
261
	/**
262
	 * Filter query when request to print specific page is made.
Erick Hitter's avatar
Erick Hitter committed
263
	 *
264 265 266 267
	 * @param object $query
	 * @action pre_get_posts
	 * @return object
	 */
Erick Hitter's avatar
Erick Hitter committed
268 269
	public function action_pre_get_posts( $query ) {
		if ( array_key_exists( $this->query_var, $query->query_vars ) && ! empty( $query->query_vars[ $this->query_var ] ) ) {
270
			$qv = explode( '/', $query->query_vars[ $this->query_var ] );
271

Erick Hitter's avatar
Erick Hitter committed
272
			if ( array_key_exists( 1, $qv ) && is_numeric( $qv[ 1 ] ) )
273 274
				$query->query_vars[ 'page' ] = (int)$qv[ 1 ];
		}
275

276 277
		return $query;
	}
278

Erick Hitter's avatar
Erick Hitter committed
279
	/**
280
	 * Filter template include to return print template if requested.
Erick Hitter's avatar
Erick Hitter committed
281
	 *
282 283 284 285
	 * @param string $template
	 * @filter template_include
	 * @return string
	 */
Erick Hitter's avatar
Erick Hitter committed
286
	public function filter_template_include( $template ) {
287
		if ( $this->is_print() && ( $print_template = $this->template_chooser() ) )
288
			$template = $print_template[ 'path' ];
289

290 291
		return $template;
	}
292

Erick Hitter's avatar
Erick Hitter committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
	/**
	 * Prevent canonical redirect if print URL is requested.
	 *
	 * @param string $url
	 * @uses this::is_print
	 * @filter redirect_canonical
	 * @return string or false
	 */
	public function filter_redirect_canonical( $url ) {
		if ( $this->is_print() )
			$url = false;

		return $url;
	}

	/**
309
	 * Filter body classes to include references to print template.
Erick Hitter's avatar
Erick Hitter committed
310
	 *
311 312 313 314
	 * @param array $classes
	 * @filter body_class
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
315 316 317
	public function filter_body_class( $classes ) {
		if ( $this->is_print() && ( $print_template = $this->template_chooser() ) ) {
			if ( $print_template[ 'name' ] == 'default' )
318 319 320 321
				$classes[] = 'wpf';
			else
				$classes[] = $print_template[ 'name' ];
		}
322

323 324
		return $classes;
	}
325

Erick Hitter's avatar
Erick Hitter committed
326
	/**
327
	 * Filter post content to support printing entire post on one page.
Erick Hitter's avatar
Erick Hitter committed
328
	 *
329
	 * @param string $content
330
	 * @uses post_password_required
331 332 333 334
	 * @uses get_query_var
	 * @filter the_content
	 * @return string
	 */
Erick Hitter's avatar
Erick Hitter committed
335
	public function filter_the_content( $content ) {
336
		if ( $this->is_print() && ! post_password_required() ) {
337
			$print = get_query_var( $this->query_var );
338

Erick Hitter's avatar
Erick Hitter committed
339
			if ( $print == 'all' || $print == '/all' || empty( $print ) ) {
340
				global $post;
341

342 343 344 345 346 347 348
				$content = $post->post_content;
				$content = str_replace("\n<!--nextpage-->\n", "\n\n", $content);
				$content = str_replace("\n<!--nextpage-->", "\n", $content);
				$content = str_replace("<!--nextpage-->\n", "\n", $content);
				$content = str_replace("<!--nextpage-->", ' ', $content);
			}
		}
349

350 351
		return $content;
	}
352

Erick Hitter's avatar
Erick Hitter committed
353 354 355
	/**
	 * Filter the content if automatic inclusion is selected.
	 *
356
	 * @param string $content
357
	 * @uses $this::get_options, $post, $this::print_url, get_query_var, apply_filters
358 359 360
	 * @filter the_content
	 * @return string
	 */
Erick Hitter's avatar
Erick Hitter committed
361
	public function filter_the_content_auto( $content ) {
362
		$options = $this->get_options();
363

364
		global $post;
365

Erick Hitter's avatar
Erick Hitter committed
366
		if ( is_array( $options ) && array_key_exists( 'auto', $options ) && $options[ 'auto' ] == true && in_array( $post->post_type, $options[ 'post_types' ] ) && ! $this->is_print() ) {
367
			extract( $options );
368

369 370
			//Basic URL
			$print_url = $this->print_url();
371

372
			//Page URL, if necessary
Erick Hitter's avatar
Erick Hitter committed
373
			if ( ! empty( $print_text_page ) && strpos( $post->post_content, '<!--nextpage-->' ) !== false ) {
374 375
				$page = get_query_var( 'page' );
				$page = $page ? $page : 1;
376

377 378
				$print_url_page = $this->print_url( false, $page );
			}
379

380 381
			//Build link(s)
			$link = '<p class="wpf_wrapper"><a class="' . $css_class . '" href="' . $print_url . '"' . ( $link_target == 'new' ? ' target="_blank"' : '' ) . '>' . $print_text . '</a>';
382

Erick Hitter's avatar
Erick Hitter committed
383
			if ( isset( $print_url_page ) ) {
384 385 386
				$link .= ' | ';
				$link .= '<a class="' . $css_class . ' ' . $css_class . '_cur" href="' . $print_url_page . '"' . ( $link_target == 'new' ? ' target="_blank"' : '' ) . '>' . $print_text_page . '</a>';
			}
387

388
			$link .= '</p><!-- .wpf_wrapper -->';
389

390
			//Place link(s)
Erick Hitter's avatar
Erick Hitter committed
391
			if ( $placement == 'above' )
392
				$content = $link . $content;
Erick Hitter's avatar
Erick Hitter committed
393
			elseif ( $placement == 'below' )
394
				$content = $content . $link;
Erick Hitter's avatar
Erick Hitter committed
395
			elseif ( $placement == 'both' )
396 397
				$content = $link . $content . $link;
		}
398

399 400
		return $content;
	}
401

Erick Hitter's avatar
Erick Hitter committed
402 403 404
	/**
	 * Convert links to endnotes if desired.
	 *
405
	 * @param string $content
406 407 408
	 * @uses this::is_print
	 * @uses post_password_required
	 * @uses this::get_options
409 410 411
	 * @filter the_content
	 * @return string
	 */
Erick Hitter's avatar
Erick Hitter committed
412
	public function filter_the_content_late( $content ) {
413
		if ( $this->is_print() && ! post_password_required() ) {
414
			global $post;
415

416
			$options = $this->get_options();
417

418
			//Endnotes
Erick Hitter's avatar
Erick Hitter committed
419
			if ( $options[ 'endnotes' ] ) {
420 421
				$links = array();
				$i = 1;
422

423 424
				//Build array of links
				preg_match_all( '#<a href=(["\'{1}])([^"\']+)(["\'{1}])([^>]*)>(.*?)</a>#i', $content, $matches );
425

Erick Hitter's avatar
Erick Hitter committed
426
				if (
427
					isset( $matches ) && is_array( $matches ) &&
Erick Hitter's avatar
Erick Hitter committed
428 429 430
					array_key_exists( 0, $matches ) && ! empty( $matches[ 0 ] ) &&
					array_key_exists( 2, $matches ) && ! empty( $matches[ 2 ] ) &&
					array_key_exists( 5, $matches ) && ! empty( $matches[ 5 ] )
431 432 433
				) {
					//Format matches for replacement in content
					$replacements = array();
Erick Hitter's avatar
Erick Hitter committed
434
					foreach ( $matches[ 0 ] as $key => $match ) {
435 436 437 438 439
						$replacements[ $match ] = array(
							'url' => $matches[ 2 ][ $key ],
							'title' => $matches[ 5 ][ $key ]
						);
					}
440

441
					//Replace links with endnote markers
Erick Hitter's avatar
Erick Hitter committed
442
					foreach ( $replacements as $match => $args ) {
443 444 445 446
						$content = str_replace( $match, $args[ 'title' ] . '[' . $i . ']', $content );
						$links[ $i ] = $args;
						$i++;
					}
447

448 449 450 451
					//Output endnotes
					$endnotes = '<div class="wpf-endnotes">';
					$endnotes .= '<strong>' . $options[ 'endnotes_label' ] . '</strong>';
					$endnotes .= '<ol>';
Erick Hitter's avatar
Erick Hitter committed
452
					foreach ( $links as $link ) {
453 454 455 456 457
						$endnotes .= '<li>';
						$endnotes .=  preg_replace( '#<img(.*)>#', '[Image]', $link[ 'title' ] ) . ': ' . esc_url( $link[ 'url' ] );
						$endnotes .= '</li>';
					}
					$endnotes .= '</ol></div><!-- .wpf-endnotes -->';
458

459 460 461 462
					$content .= $endnotes;
				}
			}
		}
463

464 465
		return $content;
	}
466

Erick Hitter's avatar
Erick Hitter committed
467 468 469
	/**
	 * Generate URL for post's printer-friendly format.
	 *
470 471 472 473 474
	 * @param int $post_id
	 * @param int $page
	 * @uses is_view_all, is_home, is_front_page, home_url, $post, get_permalink, is_category, get_category_link, is_tag, get_tag_link, is_date, get_query_var, get_day_link, get_month_link, get_year_link, is_tax, get_queried_object, get_term_link, $wp_rewrite, path_join, trailingslashit, add_query_arg
	 * @return string or bool
	 */
Erick Hitter's avatar
Erick Hitter committed
475 476
	public function print_url( $post_id = false, $page = false ) {
		if ( $page === true )
477
			return false;
478

Erick Hitter's avatar
Erick Hitter committed
479
		if ( function_exists( 'is_view_all' ) && is_view_all() )
480
			$page = false;
481

482
		$link = false;
483

484
		//Get link base specific to page type being viewed
Erick Hitter's avatar
Erick Hitter committed
485 486
		if ( is_singular() || in_the_loop() ) {
			if ( $post_id == false ) {
487 488 489
				global $post;
				$post_id = $post->ID;
			}
490

Erick Hitter's avatar
Erick Hitter committed
491
			if ( ! $post_id )
492
				return false;
493

494 495
			$link = get_permalink( $post_id );
		}
Erick Hitter's avatar
Erick Hitter committed
496
		elseif ( is_home() || is_front_page() )
497
			$link = home_url( '/' );
Erick Hitter's avatar
Erick Hitter committed
498
		elseif ( is_category() )
499
			$link = get_category_link( get_query_var( 'cat' ) );
Erick Hitter's avatar
Erick Hitter committed
500
		elseif ( is_tag() )
501 502
			$link = get_tag_link( get_query_var( 'tag_id' ) );
		/* DISABLED FOR NOW AS PRINTING OF DATE-BASED ARCHIVES DOESN'T WORK YET
Erick Hitter's avatar
Erick Hitter committed
503
		elseif ( is_date() ) {
504 505 506
			$year = get_query_var( 'year' );
			$monthnum = get_query_var( 'monthnum' );
			$day = get_query_var( 'day' );
507

Erick Hitter's avatar
Erick Hitter committed
508
			if ( $day )
509
				$link = get_day_link( $year, $monthnum, $day );
Erick Hitter's avatar
Erick Hitter committed
510
			elseif ( $monthnum )
511 512 513 514
				$link = get_month_link( $year, $monthnum );
			else
				$link = get_year_link( $year );
		}*/
Erick Hitter's avatar
Erick Hitter committed
515
		elseif ( is_tax() ) {
516
			$queried_object = get_queried_object();
517

Erick Hitter's avatar
Erick Hitter committed
518
			if ( is_object( $queried_object ) && property_exists( $queried_object, 'taxonomy' ) && property_exists( $queried_object, 'term_id' ) )
519 520
				$link = get_term_link( (int)$queried_object->term_id, $queried_object->taxonomy );
		}
521

522
		//If link base is set, build link
Erick Hitter's avatar
Erick Hitter committed
523
		if ( $link !== false ) {
524
			global $wp_rewrite;
525

526
			$page = intval( $page );
527

Erick Hitter's avatar
Erick Hitter committed
528
			if ( $wp_rewrite->using_permalinks() ) {
529
				$link = path_join( $link, $this->query_var );
530

Erick Hitter's avatar
Erick Hitter committed
531
				if ( $page )
532
					$link = path_join( $link, intval( $page ) );
533

Erick Hitter's avatar
Erick Hitter committed
534
				if ( $wp_rewrite->use_trailing_slashes )
535 536 537 538
					$link = trailingslashit( $link );
			}
			else {
				$link = add_query_arg( $this->query_var, is_numeric( $page ) ? intval( $page ) : 'all', $link );
539

Erick Hitter's avatar
Erick Hitter committed
540
				if ( $page )
541 542 543
					$link = add_query_arg( 'page', is_numeric( $page ) ? intval( $page ) : 'all', $link );
			}
		}
544

545 546
		return $link;
	}
547

Erick Hitter's avatar
Erick Hitter committed
548 549 550
	/**
	 * Add menu item for options page.
	 *
551 552 553 554
	 * @uses add_options_page
	 * @action admin_menu
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
555
	public function action_admin_menu() {
556 557
		add_options_page( 'WP Print Friendly Options', 'WP Print Friendly', 'manage_options', $this->ns, array( $this, 'admin_options' ) );
	}
558

Erick Hitter's avatar
Erick Hitter committed
559 560 561
	/**
	 * Render options page.
	 *
562 563 564
	 * @uses settings_fields, $this::get_options, _e, checked, esc_attr
	 * @return html
	 */
Erick Hitter's avatar
Erick Hitter committed
565
	public function admin_options() {
566 567 568
	?>
		<div class="wrap">
			<h2>WP Print Friendly</h2>
569

570 571 572 573
			<form action="options.php" method="post">
				<?php
					settings_fields( $this->settings_key );
					$options = $this->get_options();
574

575 576
					$post_types = $this->post_types_array();
				?>
577

578
				<h3>Display Options</h3>
579

580 581
				<table class="form-table">
					<tr>
Erick Hitter's avatar
Erick Hitter committed
582
						<th scope="row"><?php _e( 'Automatically add print links based on settings below?', 'wp_print_friendly' ); ?></th>
583
						<td>
Erick Hitter's avatar
Erick Hitter committed
584 585
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[auto]" id="auto-true" value="1"<?php checked( $options[ 'auto' ], true, true ); ?> /> <label for="auto-true"><?php _e( 'Yes', 'wp_print_friendly' ); ?></label><br />
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[auto]" id="auto-false" value="0"<?php checked( $options[ 'auto' ], false, true ); ?> /> <label for="auto-false"><?php _e( 'No', 'wp_print_friendly' ); ?></label>
586 587 588
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
589
						<th scope="row"><?php _e( 'Automatically place link:', 'wp_print_friendly' ); ?></th>
590
						<td>
Erick Hitter's avatar
Erick Hitter committed
591 592 593
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[placement]" id="placement-above" value="above"<?php checked( $options[ 'placement' ], 'above', true ); ?> /> <label for="placement-above"><?php _e( 'Above content', 'wp_print_friendly' ); ?></label><br />
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[placement]" id="placement-below" value="below"<?php checked( $options[ 'placement' ], 'below', true ); ?> /> <label for="placement-below"><?php _e( 'Below content', 'wp_print_friendly' ); ?></label><br />
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[placement]" id="placement-both" value="both"<?php checked( $options[ 'placement' ], 'both', true ); ?> /> <label for="placement-both"><?php _e( 'Above and below content', 'wp_print_friendly' ); ?></label>
594 595 596
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
597
						<th scope="row"><?php _e( 'Display automatically on:', 'wp_print_friendly' ); ?></th>
598
						<td>
Erick Hitter's avatar
Erick Hitter committed
599 600
							<?php foreach ( $post_types as $post_type ): ?>
								<input type="checkbox" name="<?php echo esc_attr( $this->settings_key ); ?>[post_types][]" id="pt-<?php echo $post_type->name; ?>" value="<?php echo $post_type->name; ?>"<?php if ( in_array( $post_type->name, $options[ 'post_types' ] ) ) echo ' checked="checked"'; ?> /> <label for="pt-<?php echo $post_type->name; ?>"><?php echo $post_type->labels->name; ?></label><br />
601 602 603 604
							<?php endforeach; ?>
						</td>
					</tr>
				</table>
605

606
				<h3>Link Options</h3>
607

608 609
				<table class="form-table">
					<tr>
Erick Hitter's avatar
Erick Hitter committed
610
						<th scope="row"><?php _e( 'Text for link to print entire item:', 'wp_print_friendly' ); ?></th>
611
						<td>
612
							<input type="text" name="<?php echo esc_attr( $this->settings_key ); ?>[print_text]" id="print_text" value="<?php echo esc_attr( $options[ 'print_text' ] ); ?>" style="width: 40%;" />
613 614 615
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
616
						<th scope="row"><?php _e( 'Text for link to print current page:', 'wp_print_friendly' ); ?></th>
617
						<td>
618 619
							<input type="text" name="<?php echo esc_attr( $this->settings_key ); ?>[print_text_page]" id="print_text_page" value="<?php echo esc_attr( $options[ 'print_text_page' ] ); ?>" style="width: 40%;" />

Erick Hitter's avatar
Erick Hitter committed
620 621
							<p class="description"><?php _e( 'If viewing a multipage post (set by using the &lt;!--nextpage--&gt; tag), the text above is used for a link to print just the current page.', 'wp_print_friendly' ); ?></p>
							<p class="description"><?php _e( '<strong>To hide this link,</strong> clear the field\'s contents.', 'wp_print_friendly' ); ?></p>
622 623 624
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
625
						<th scope="row"><?php _e( 'CSS for print links:', 'wp_print_friendly' ); ?></th>
626
						<td>
627 628
							<input type="text" name="<?php echo esc_attr( $this->settings_key ); ?>[css_class]" id="css_class" value="<?php echo esc_attr( $options[ 'css_class' ] ); ?>" style="width: 40%;" />

Erick Hitter's avatar
Erick Hitter committed
629 630
							<p class="description"><?php _e( 'For page-specific print links, a second class, created by appending <strong>_cur</strong> to the above text, is added to each link.', 'wp_print_friendly' ); ?></p>
							<p class="description"><?php _e( 'Be aware that Internet Explorer will only interpret the first two CSS classes, so if multiple classes are entered above, the page-specific class may not be available in IE.', 'wp_print_friendly' ); ?></p>
631 632 633
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
634
						<th scope="row"><?php _e( 'Open print-friendly views:', 'wp_print_friendly' ); ?></th>
635
						<td>
Erick Hitter's avatar
Erick Hitter committed
636 637
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[link_target]" id="target-same" value="same"<?php checked( $options[ 'link_target' ], 'same', true ); ?> /> <label for="target-same"><?php _e( 'In the same window', 'wp_print_friendly' ); ?></label><br />
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[link_target]" id="target-new" value="new"<?php checked( $options[ 'link_target' ], 'new', true ); ?> /> <label for="target-new"><?php _e( 'In a new window', 'wp_print_friendly' ); ?></label>
638 639 640
						</td>
					</tr>
				</table>
641

642
				<h3>Endnote Options</h3>
643

644 645
				<table class="form-table">
					<tr>
Erick Hitter's avatar
Erick Hitter committed
646
						<th scope="row"><?php _e( 'Include endnotes for links found in content?', 'wp_print_friendly' ); ?></th>
647
						<td>
Erick Hitter's avatar
Erick Hitter committed
648
							<input type="checkbox" name="<?php echo esc_attr( $this->settings_key ); ?>[endnotes]" id="endnotes" value="1"<?php checked( $options[ 'endnotes' ], true, true ); ?> /> <label for="endnotes"><?php _e( 'Yes', 'wp_print_friendly' ); ?></label>
649

Erick Hitter's avatar
Erick Hitter committed
650
							<p class="description"><?php _e( 'If enabled, content is automatically scanned for links and an endnote is added for each link found. This can be helpful for users if your content includes many links.', 'wp_print_friendly' ); ?></p>
651 652 653
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
654
						<th scope="row"><label for="endnotes-label"><?php _e( 'Endnotes heading:', 'wp_print_friendly' ); ?></label></th>
655
						<td>
656 657
							<input type="text" name="<?php echo esc_attr( $this->settings_key ); ?>[endnotes_label]" class="regular-text code" id="endnotes-label" value="<?php echo esc_attr( $options[ 'endnotes_label' ] ); ?>" />

Erick Hitter's avatar
Erick Hitter committed
658
							<p class="description"><?php _e( 'If endnotes are enabled, the text entered above will be output above the list of links.', 'wp_print_friendly' ); ?></p>
659 660 661
						</td>
					</tr>
				</table>
662

663 664 665 666
				<p class="submit">
					<input type="submit" class="button-primary" value="Save Changes" />
				</p>
			</form>
667

668 669 670
		</div><!-- .wrap -->
	<?php
	}
671

Erick Hitter's avatar
Erick Hitter committed
672
	/**
673
	 * Validate options
Erick Hitter's avatar
Erick Hitter committed
674
	 *
675 676 677 678
	 * @param array $options
	 * @uses $this::get_options, $this::post_types_array, delete_option, sanitize_text_field
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
679
	public function admin_options_validate( $options ) {
680 681 682
		$new_options = array(
			'endnotes' => false
		);
683

Erick Hitter's avatar
Erick Hitter committed
684 685
		if ( is_array( $options ) ) {
			foreach ( $options as $key => $value ) {
686 687 688 689 690
				switch( $key ) {
					case 'auto':
					case 'endnotes':
						$new_options[ $key ] = (bool)$value;
					break;
691

692 693 694 695 696 697
					case 'placement':
						$placements = array(
							'above',
							'below',
							'both'
						);
698

699 700
						$new_options[ $key ] = in_array( $value, $placements ) ? $value : 'below';
					break;
701

702 703
					case 'post_types':
						$post_types = $this->post_types_array();
704

705
						$new_options[ $key ] = array();
706

Erick Hitter's avatar
Erick Hitter committed
707 708 709
						if ( is_array( $value ) && is_array( $post_types ) ) {
							foreach ( $post_types as $post_type ) {
								if ( in_array( $post_type->name, $value ) )
710 711 712 713
									$new_options[ $key ][] = $post_type->name;
							}
						}
					break;
714

715 716 717 718 719
					case 'print_text':
					case 'print_text_page':
					case 'css_class':
					case 'endnotes_label':
						$value = sanitize_text_field( $value );
720

Erick Hitter's avatar
Erick Hitter committed
721
						if ( $key == 'print_text' && empty( $value ) )
722
							$value = 'Print this entry';
723

724 725
						$new_options[ $key ] = $value;
					break;
726

727 728 729
					case 'link_target':
						$new_options[ $key ] = $value == 'new' ? 'new' : 'same';
					break;
730

731 732 733 734 735 736
					default:
						continue;
					break;
				}
			}
		}
737

738 739
		return $new_options;
	}
740

Erick Hitter's avatar
Erick Hitter committed
741 742 743
	/**
	 * Return plugin options array parsed with default options.
	 *
744 745 746
	 * @uses wp_parse_args, get_option
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
747
	public function get_options() {
748
		$options = get_option( $this->settings_key, $this->settings_defaults );
749

Erick Hitter's avatar
Erick Hitter committed
750
		if ( ! array_key_exists( 'post_types', $options ) )
751
			$options[ 'post_types' ] = array();
752

753 754
		return wp_parse_args( $options, $this->settings_defaults );
	}
755

Erick Hitter's avatar
Erick Hitter committed
756 757 758
	/**
	 * Build array of available post types, excluding all builtin ones except 'post' and 'page'.
	 *
759 760 761
	 * @uses get_post_types
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
762
	public function post_types_array() {
763
		$post_types = array();
Erick Hitter's avatar
Erick Hitter committed
764 765
		foreach ( get_post_types( array(), 'objects' ) as $post_type ) {
			if ( $post_type->_builtin == false || $post_type->name == 'post' || $post_type->name == 'page' )
766 767
				$post_types[] = $post_type;
		}
768

769 770
		return $post_types;
	}
771

Erick Hitter's avatar
Erick Hitter committed
772
	/**
773
	 * Display admin notice regarding rewrite rules flush.
Erick Hitter's avatar
Erick Hitter committed
774
	 *
775 776 777 778
	 * @uses get_option, _e, __, admin_url, add_query_arg
	 * @action admin_notices
	 * @return html or null
	 */
Erick Hitter's avatar
Erick Hitter committed
779 780
	public function action_admin_notices_activation() {
		if ( ! get_option( $this->notice_key ) ):
781
		?>
782

783
		<div id="wpf-rewrite-flush-warning" class="error fade">
Erick Hitter's avatar
Erick Hitter committed
784
			<p><strong><?php _e( 'WP Print Friendly', 'wp_print_friendly' ); ?></strong></p>
785

Erick Hitter's avatar
Erick Hitter committed
786
			<p><?php printf( __( 'You must refresh your site\'s permalinks before WP Print Friendly is fully activated. To do so, go to <a href="%s">Permalinks</a> and click the <strong><em>Save Changes</em></strong> button at the bottom of the screen.', 'wp_print_friendly' ), admin_url( 'options-permalink.php' ) ); ?></p>
787

Erick Hitter's avatar
Erick Hitter committed
788
			<p><?php printf( __( 'When finished, click <a href="%s">here</a> to hide this message.', 'wp_print_friendly' ), admin_url( add_query_arg( $this->notice_key, 1, 'index.php' ) ) ); ?></p>
789
		</div>
790

791 792 793
		<?php
		endif;
	}
794

Erick Hitter's avatar
Erick Hitter committed
795
	/**
796
	 * Render page numbers, such as "Page 1 of 5."
Erick Hitter's avatar
Erick Hitter committed
797
	 *
798 799 800 801
	 * @param int $post_id
	 * @param string $before
	 * @param string $separator
	 * @param string $after
802 803 804 805
	 * @uses this::is_print
	 * @uses post_password_required
	 * @uses get_query_var
	 * @uses get_post_field
806 807
	 * @return string or false
	 */
Erick Hitter's avatar
Erick Hitter committed
808
	public function page_numbers( $post_id = false, $before = 'Page ', $separator = ' of ', $after = '' ) {
809
		if ( ! $this->is_print() || post_password_required() )
810
			return false;
811

812 813
		//Don't display on views that include all pages of a post
		$print = get_query_var( $this->query_var );
Erick Hitter's avatar
Erick Hitter committed
814
		if ( $print == 'all' || $print == '/all' || empty( $print ) )
815
			return false;
816

817 818
		//Get post ID and post content, or return false it either fails validation
		$post_id = intval( $post_id );
819

Erick Hitter's avatar
Erick Hitter committed
820
		if ( ! $post_id ) {
821 822 823 824
			global $post;
			$post_id = $post->ID;
			$post_content = $post->post_content;
		}
825

826
		$post_id = intval( $post_id );
827

Erick Hitter's avatar
Erick Hitter committed
828
		if ( ! $post_id )
829
			return false;
830

Erick Hitter's avatar
Erick Hitter committed
831
		if ( ! isset( $post_content ) || empty( $post_content ) )
832
			$post_content = get_post_field( 'post_content', $post_id );
833

Erick Hitter's avatar
Erick Hitter committed
834
		if ( ! is_string( $post_content ) || empty( $post_content ) || strpos( $post_content, '<!--nextpage-->' ) === false )
835
			return false;
836

837 838 839
		//Get current page
		$page = get_query_var( $this->query_var );
		$page = $page ? $page : 1;
840

841 842
		//Get total number of pages, or return false if total cannot be determined
		$num_pages = substr_count( $post_content, '<!--nextpage-->' );
843

Erick Hitter's avatar
Erick Hitter committed
844
		if ( is_int( $num_pages ) && $num_pages > 0 )
845 846 847
			$num_pages = $num_pages + 1;
		else
			return false;
848

849 850 851 852 853 854 855
		//Having made it this far, return the specified string
		return $before . $page . $separator . $num_pages . $after;
	}
}
global $wpf;
$wpf = new wp_print_friendly;

Erick Hitter's avatar
Erick Hitter committed
856
/**
857
 * Shortcut to function for generating post's printer-friendly format URL
Erick Hitter's avatar
Erick Hitter committed
858
 *
859 860 861 862 863 864 865
 * @param int $post_id
 * @param int $page
 * @uses $wpf
 * @return string or bool
 */
function wpf_get_print_url( $post_id = false, $page = false ) {
	global $wpf;
Erick Hitter's avatar
Erick Hitter committed
866
	if ( ! is_a( $wpf, 'wp_print_friendly' ) )
867
		$wpf = new wp_print_friendly;
868

869 870 871
	return $wpf->print_url( intval( $post_id ), intval( $page ) );
}

Erick Hitter's avatar
Erick Hitter committed
872
/**
873
 * Output link to printer-friendly post format.
Erick Hitter's avatar
Erick Hitter committed
874
 *
875 876 877 878 879 880 881 882 883 884 885 886 887
 * @param string $link_text
 * @param string $class
 * @param int $post_id
 * @param bool $page_link
 * @param string $page_link_separator
 * @param string $page_link_text
 * @param string $link_target
 * @uses $post, wpf_get_print_url, esc_attr, esc_url, get_query_var
 * @return string or null
 */
function wpf_the_print_link( $page_link = false, $link_text = 'Print this post', $class = 'print_link', $page_link_separator = ' | ', $page_link_text = 'Print this page', $link_target = 'same' ) {
	global $post;
	$url = wpf_get_print_url( $post->ID );
888

889
	$page_link = (bool)$page_link;
890

Erick Hitter's avatar
Erick Hitter committed
891
	if ( function_exists( 'is_view_all' ) && is_view_all() )
892
		$page_link = false;
893

Erick Hitter's avatar
Erick Hitter committed
894
	if ( $url ) {
895
		$link = '<a ' . ( $class ? 'class="' . esc_attr( $class ) . '"' : '' ) . ' href="' . esc_url( $url ) . '"' . ( $link_target == 'new' ? ' target="_blank"' : '' ) . '>' . $link_text . '</a>';
896

Erick Hitter's avatar
Erick Hitter committed
897
		if ( $page_link && strpos( $post->post_content, '<!--nextpage-->' ) !== false ) {
898 899 900 901
			$page = get_query_var( 'page' );
			$page = $page ? $page : 1;
			$link .= $page_link_separator . '<a ' . ( $class ? 'class="' . esc_attr( $class ) . '_cur ' . esc_attr( $class ) . '"' : '' ) . ' href="' . esc_url( wpf_get_print_url( $post->ID, $page ) ) . '"' . ( $link_target == 'new' ? ' target="_blank"' : '' ) . '>' . $page_link_text . '</a>';
		}
902

903 904 905 906
		echo $link;
	}
}

Erick Hitter's avatar
Erick Hitter committed
907
/**
908
 * Display page numbers, such as "Page 1 of 5."
Erick Hitter's avatar
Erick Hitter committed
909
 *
910 911 912 913 914 915 916 917 918
 * @param int $post_id
 * @param string $before
 * @param string $separator
 * @param string $after
 * @uses $wpf
 * @return string or false
 */
function wpf_the_page_numbers( $post_id = false, $before = 'Page ', $separator = ' of ', $after = '' ) {
	global $wpf;
Erick Hitter's avatar
Erick Hitter committed
919
	if ( ! is_a( $wpf, 'wp_print_friendly' ) )
920
		$wpf = new wp_print_friendly;
921

922 923 924
	echo $wpf->page_numbers( intval( $post_id ), $before, $separator, $after );
}

Erick Hitter's avatar
Erick Hitter committed
925 926
if ( ! function_exists( 'is_print' ) ) {
	/**
927
	 * Conditional tag indicating if printer-friendly format was requested.
Erick Hitter's avatar
Erick Hitter committed
928
	 *
929 930 931 932 933
	 * @uses $wpf
	 * @return bool
	 */
	function is_print() {
		global $wpf;
Erick Hitter's avatar
Erick Hitter committed
934
		if ( ! is_a( $wpf, 'wp_print_friendly' ) )
935
			$wpf = new wp_print_friendly;
936

937 938 939
		return $wpf->is_print();
	}
}
940
?>