{

public $template = NULL;

public $template_content = NULL;

public $options = array();

public $shortcodes = NULL;

public $use_custom_permalink = FALSE;

public $permalink_structure = NULL;

public $custom_permalink_structure = NULL;

public $keyword = NULL;

public $notice = NULL;

public $notice_iserror = FALSE;

public $menu_slug = NULL;

public $category_slug = NULL;

public $hide_post_id = FALSE;

private $is_virtual_page = FALSE;

private $blog_path = '/';

public $categories = array();

public $always_search_virtual = TRUE; # option to search virtual page first

const ERR_URL = 1;

const ERR_TEMPLATE = 2;

const ERR_CATEGORY = 3;

public function __construct()

{

if ( ! is_admin() )

{

add_filter('the_posts', array(&$this, 'create_virtual'));

add_action('template_redirect', array($this, 'virtual_page_redirect'));

remove_action('wp_head', 'rel_canonical');

add_action('wp_head', array($this, 'vpt_rel_canonical'),10);

remove_action( 'wp_head', 'wp_shortlink_wp_head', 10, 0 ); // Remove WordPress shortlink on wp_head hook

add_action('wp_head', array($this, 'vpt_shortlink_wp_head'), 10, 0); // custom shortlink

add_filter('body_class', array($this, 'vpt_body_class'), 20, 2);

add_filter('post_class', array($this, 'vpt_post_class'), 20, 2);

add_action('wp_head', array($this,'buffer_start'));

add_action('wp_footer', array($this,'buffer_end'));

add_filter('widget_display_callback', array(&$this, 'replace_widget_keywords'));

add_filter('user_trailingslashit', array($this, 'fix_trailing_slash'), 9999,2);

add_filter('wp_get_nav_menu_items', array($this, 'custom_nav_items'));

}else{

add_action( 'admin_menu', array($this, 'display_menu') );

add_action('admin_print_scripts', array($this,'loadJS'));

add_action('admin_head-nav-menus.php', array($this, 'vpt_metabox' ));

register_uninstall_hook(__FILE__, array('VirtualPagesTemplates','vpt_uninstall_plugin'));

}

$this->permalink_structure = get_option('permalink_structure');

}

function vpt_metabox() {

add_meta_box( 'vpt-menu-metabox', 'Virtual Pages', array($this, 'vpt_render_menu_metabox'), 'nav-menus', 'side', 'high', $custom_param );

}

function vpt_render_menu_metabox( $object, $args ) {

global $_nav_menu_placeholder, $nav_menu_selected_id;

$_nav_menu_placeholder = 0 > $_nav_menu_placeholder ? $_nav_menu_placeholder - 1 : -1;

?>

<div class="customlinkdivVpt" id="customlinkdivVpt">

<input type="hidden" value="custom" name="vpt-menu-item[<?php echo $_nav_menu_placeholder; ?>][vpt-menu-item-type]" />

<input id="custom-vpt-menu-item-url" name="vpt-menu-item[<?php echo $_nav_menu_placeholder; ?>][vpt-menu-item-url]" type="hidden" value="*" />

<input id="custom-vpt-menu-item-custom-type" name="vpt-menu-item[<?php echo $_nav_menu_placeholder; ?>][vpt-menu-item-custom-type]" type="hidden" />

<p id="menu-item-name-wrap">

<label class="howto" for="custom-vpt-menu-item-titles">

<span><?php _e( 'Titles' ); ?></span>

<textarea rows="8" id="custom-vpt-menu-item-titles" name="vpt-menu-item[<?php echo $_nav_menu_placeholder; ?>][vpt-menu-item-titles]" class="regular-text vpt-menu-item-textbox input-with-default-title" title="<?php esc_attr_e('Titles'); ?>" style = "margin-left:40px;width:180px;">

</textarea>

<span>* separate Titles using a new line.</span>

</label>

</p>

<p class="button-controls">

<span class="add-to-menu">

<input type="submit"<?php wp_nav_menu_disabled_check( $nav_menu_selected_id ); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e('Add to Menu'); ?>" name="add-custom-vpt-menu-item" id="submit-customlinkdivVpt" />

<span class="spinner"></span>

</span>

</p>

</div><!-- /.customlinkdivVpt -->

<?php

}

/**

* custom_nav_items

*

* Updates the menu items with virtual urls if URL specified is either one of the folowing (`http://*`, `/*`, `*`)

*

* @access public

* @param object $items

* @return $items

*/

public function custom_nav_items($items){

$structure = $this->permalink_structure;

if ($this->use_custom_permalink){

$structure = $this->options['virtualpageurl'];

}

foreach ($items as $item)

{

if ($item->url == 'http://*' || $item->url == '/*' || $item->url == '*')

{

$url = strtolower(str_replace(array(" ","\"","/"),array("-","","-"),$item->title));

$url = str_replace('%postname%', $url, $structure);

$url = rtrim($this->get_blog_path(), '/') . $url;

$item->url = $url;

}

}

return $items;

}

/**

* allow use of %vpt-keyword% in sidebar widget

*

*

* @access public

* @param array $widget

* @return $widget

*/

public function replace_widget_keywords($widget)

{

$keyword = str_replace('-', ' ', $this->keyword);

array_walk_recursive($widget, function(&$value, $key) use ($keyword){

// Don't alter non-strings or empty ones

if(!is_string($value) or empty($value)) return;

// We found a string, replace stuff in it and return the altered value

$value = str_replace('%vpt-keyword%', $keyword, $value);

});

// Return the possible altered $instance array

return $widget;

}

/**

* fix_trailing_slash

*

* adds / removes the trailing slash on virtual pages depending on to what is set on the virtual page custom permalink

* overrides the WP permalink settings, where automatically removes / adds trailing slashes depending on the WP permalink

*

* @access public

* @param string $s the string url

* @return $s

*/

public function fix_trailing_slash($s=''){

if ($this->is_virtual_page())

{

if ($this->use_custom_permalink && !empty($this->options))

{

$revvurl = strrev($this->options['virtualpageurl']);

$rev_s = strrev($s);

if ($revvurl){

if ($revvurl{0} == '/' && $rev_s{0} != '/')

{

return $s . '/';

}

// remove slash if the custom permalink doesn't have a trailing slash

elseif ($revvurl{0} != '/' && $rev_s{0} == '/')

{

return substr($s, 0, -1);

}

// use as it is

else

{

return $s;

}

}

else{

return $s;

}

// add slash if the custom permalink has slash

}else{

return $s;

}

}else{

return $s;

}

}

/**

* overrides the WP rel_canonical - use the correct canonical tags for virtual pages

*

*/

public function vpt_rel_canonical()

{

if ( !is_singular() )

return;

global $wp_the_query;

if ( !$id = $wp_the_query->get_queried_object_id() )

return;

if ($this->is_virtual_page() && $id == $this->template->ID)

{

global $wp_rewrite;

$link = $wp_rewrite->get_page_permastruct();

$link = str_replace('%pagename%', get_page_uri( $GLOBALS['post'] ), $link);

$link = home_url($link);

$revvurl = strrev($this->options['virtualpageurl']);

$revlink = strrev($link);

if ($revvurl)

{

// add slash if the custom permalink has slash

if ($revvurl{0} == '/' && $revlink{0} != '/')

{

$link = $link . '/';

}

// remove slash if the custom permalink doesn't have a trailing slash

elseif ($revvurl{0} != '/' && $revlink{0} == '/')

{

$link = substr($link, 0, -1);

}

}

//$link = user_trailingslashit($link, $GLOBALS['post']->post_type);

}else

$link = get_permalink( $id );

if ( $page = get_query_var('cpage') )

$link = get_comments_pagenum_link( $page );

echo "<link rel='canonical' href='{$link}' />\n";

}

/**

* overrides the WP wp_get_shortlink - only display the shortlink for normal pages

*

* Attached to the wp_head action.

*

* @uses vpt_shortlink_wp_head()

*/

public function vpt_shortlink_wp_head()

{

if (!$this->is_virtual_page())

{

$shortlink = wp_get_shortlink( 0, 'query' );

if ( empty( $shortlink ) )

return;

echo "<link rel='shortlink' href='" . esc_url( $shortlink ) . "' />\n";

}

}

/**

* deletes the body classes e.g. page-id-4 or postid-4 if a virtual post/page

*

*/

public function vpt_body_class($wp_classes)

{

if ($this->is_virtual_page() && $this->hide_post_id)

{

foreach ($wp_classes as $k => $v)

{

if ($GLOBALS['post']->post_type == 'page')

{

if ($v == 'page-id-' . $GLOBALS['post']->ID) unset($wp_classes[$k]);

}

else

{

if ($v == 'postid-' . $GLOBALS['post']->ID) unset($wp_classes[$k]);

}

}

}

return $wp_classes;

}

public function vpt_post_class($wp_classes)

{

if ($this->is_virtual_page() && $this->hide_post_id)

{

foreach ($wp_classes as $k => $v)

{

if ($v == 'post-' . $GLOBALS['post']->ID) unset($wp_classes[$k]);

}

}

return $wp_classes;

}

/**

* vpt_uninstall_plugin

*

* completely removes the plugin installation

*

* @access public

* @return void

*/

public function vpt_uninstall_plugin(){

delete_option('vpt_options');

}

/**

* virtual_page_redirect

*

* redirects to a virtual page/post if data being searched is not existing (posts/pages)

*

* @access public

* @return void

*/

public function virtual_page_redirect() {

if (is_search()) {

global $wp_query;

if (!empty($this->options) && isset($this->options['affect_search']) && $this->options['affect_search'] && (!is_null($this->template) && $this->template->ID))

{

if ((isset($wp_query->posts) && count($wp_query->posts) == 0) || !is_null($this->is_virtual_page()) && $wp_query->post->ID == $this->template->ID || $this->always_search_virtual)

{

$structure = $this->permalink_structure;

if ($this->use_custom_permalink){

$structure = $this->options['virtualpageurl'];

}

if (strpos($structure, '%postname%')){

//seo search conversion for affect_search keywords

$wp_query->query['s'] = $this->seoUrl($wp_query->query['s']);

$structure = rtrim( $this->get_blog_path(), '/').$structure;

$structure = str_replace('%postname%', $wp_query->query['s'] , $structure) ;

if (!is_null($this->category_slug))

$structure = str_replace('%category%', $this->category_slug , $structure) ;

else

$structure = str_replace('%category%', 'uncategorized' , $structure) ;

$wp_query->is_search = FALSE;

if ($structure != $_SERVER['REQUEST_URI'] )

wp_redirect( $structure );

}

}

}

}

}

/**

* seoUrl

*

* Convert a string to seo friendly string

*

* @access public

* @return string

*/

public function seoUrl($string) {

//Lower case everything

$string = strtolower($string);

//Make alphanumeric (removes all other characters)

$string = preg_replace("/[^a-z0-9_\s-]/", "", $string);

//Clean up multiple dashes or whitespaces

$string = preg_replace("/[\s-]+/", " ", $string);

//Convert whitespaces and underscore to dash

$string = preg_replace("/[\s_]/", "-", $string);

return $string;

}

/**

* display_menu

*

* add's the menu to the admin / dashboard

*

* @access public

* @return NONE

*/

public function display_menu()

{

$this->menu_slug = add_options_page( 'Virtual Page Settings', 'Virtual Page Settings', 'manage_options', dirname(__FILE__) . '/form.php' );

$this->menu_slug = str_replace('settings_page_', '', $this->menu_slug) . '.php';

// use `admin_print_scripts` instead of `admin_enqueue_scripts` so this only loads on this specific form and NOT on all admin pages

add_action('admin_print_scripts-' . $this->menu_slug, array($this, 'admin_includes') );

// load on checking of $_POSTs when on this page

add_action('load-'.$this->menu_slug, array($this,'check_posts'));

}

/**

* check_posts

*

* used in the dashboard, checks if there's an update and save into DB - wp_options

*

* @access public

* @return NONE

*/

public function check_posts()

{

if(isset($_POST['vpt_hidden']) && $_POST['vpt_hidden'] == 'Y') {

unset($_POST['vpt_hidden']);

unset($_POST['submit']);

$extra = '';

if (isset($_POST['use_custom_permalink_structure']) && empty($_POST['virtualpageurl']))

{

$extra = '&error=' . self::ERR_URL ;

}

elseif (!isset($_POST['page_template']))

{

$extra = '&error=' . self::ERR_TEMPLATE ;

}

elseif (isset($_POST['use_custom_permalink_structure']) && strpos($_POST['virtualpageurl'],'%category%') !== false && get_post($_POST['page_template'])->post_type == 'page')

{

$extra = '&error=' . self::ERR_CATEGORY ;

}

else

{

$_POST['use_custom_permalink_structure'] = isset($_POST['use_custom_permalink_structure']) ? $_POST['use_custom_permalink_structure'] : '0';

$_POST['affect_search'] = isset($_POST['affect_search']) ? $_POST['affect_search'] : '0';

$_POST['hide_post_id'] = isset($_POST['hide_post_id']) ? $_POST['hide_post_id'] : '0';

$_POST['always_virtual'] = isset($_POST['always_virtual']) ? $_POST['always_virtual'] : '0';

update_option('vpt_options', $_POST);

$extra = '&settings-updated=true';

}

wp_redirect(admin_url('options-general.php?page=' . $this->menu_slug . $extra));

}

if ( ! empty( $_GET['settings-updated'] ) )

{

$this->notice = 'Settings saved.';

add_action('admin_notices', array($this, 'display_notification'));

}

if ( ! empty( $_GET['error'] ) )

{

$this->set_error_message($_GET['error']);

$this->notice_iserror = TRUE;

add_action('admin_notices', array($this, 'display_notification'));

}

}

/**

* set_error_message

*

* sets the error message based on the given error code

*

* @access public

* @return NONE

*/

private function set_error_message($error){

switch ($error) {

case self::ERR_URL:

$this->notice = 'Please indicate the custom Virtual Page URL.';

break;

case self::ERR_TEMPLATE:

$this->notice = 'Page template is required. You can make a template by creating a <a href="'.admin_url('post-new.php').'">post</a> or a <a href="'.admin_url('post-new.php?post_type=page').'">page</a> as save it as draft.';

break;

case self::ERR_CATEGORY:

$this->notice = 'The `%category%` tag will not work on pages.';

break;

default:

# code...

break;

}

}

/**

* init_keyord

*

* initialize the keyword

*

* @access public

* @return void

*/

public function init_keyword($current_url_trimmed, $virtualpageurl_trimmed){

global $wp,$wp_query;

if (isset($wp_query->query['s']) && $wp_query->query['s'])

{

$this->keyword = $wp_query->query['s'];

}

else

{

$needles = array('%postname%');

// replace the category

if ($this->category_slug)

$virtualpageurl_trimmed = str_replace('%category%', $this->category_slug, $virtualpageurl_trimmed);

$virtualpageurl_trimmed = str_replace('?', '\?', $virtualpageurl_trimmed);

$replacements_regex = array(

'(?<postname>[^/]+)',

);

$regex = str_replace($needles, $replacements_regex, $virtualpageurl_trimmed);

$regex = str_replace('/', "\/", $regex);

$match = preg_match('/(?Ji)^' . $regex.'/', $current_url_trimmed, $matches);

if ($match && isset($matches['postname']))

$this->keyword = $matches['postname'];

}

}

/**

* create_virtual

*

* creates the virtual page / post based on the template used

*

* @access public

* @param object $posts - the wp posts

* @return $posts

*/

public function create_virtual($posts)

{

global $wp,$wp_query, $wp_rewrite;

$this->options = get_option('vpt_options');

$current_url = $_SERVER['REQUEST_URI'];

if (!isset($this->options['use_custom_permalink_structure']))

$this->options['use_custom_permalink_structure'] = 0;

$this->use_custom_permalink = (BOOL) $this->options['use_custom_permalink_structure'];

if (!isset($this->options['hide_post_id']))

$this->options['hide_post_id'] = 0;

$this->hide_post_id = (BOOL) $this->options['hide_post_id'];

if (!isset($this->options['always_virtual']))

$this->options['always_virtual'] = 0;

$this->always_search_virtual = (BOOL) $this->options['always_virtual'];

if (!$this->use_custom_permalink){

$virtualpageurl = $this->permalink_structure;

}

else{

$virtualpageurl = $this->options['virtualpageurl'];

//$wp_rewrite->permalink_structure = $this->options['virtualpageurl'];

}

// trim slashes

$virtualpageurl_trimmed = ltrim($this->get_blog_path(), '/').trim($virtualpageurl, '/');

$current_url_trimmed = trim($current_url, '/');

// get the template details

$this->template_content = $this->get_template_content();

$this->init_keyword($current_url_trimmed, $virtualpageurl_trimmed);

$virtual_url = str_replace('%postname%', $this->keyword, $virtualpageurl_trimmed);

$virtual_url = str_replace('%category%', $this->category_slug, $virtual_url);

//$wp_rewrite->permalink_structure

$num_posts = count($wp_query->posts);

$allow_virtual = FALSE;

//empty($wp_rewrite->permalink_structure) &&

if (!is_home())

{

if (empty($wp->query_vars) && !isset($wp_query->post) && ($current_url_trimmed != '' && empty($posts)) )

{

$allow_virtual = TRUE;

}

elseif ($num_posts == 0)

{

$allow_virtual = TRUE;

}

}

if ($virtual_url == $current_url_trimmed && ($allow_virtual || (isset($wp_query->query['error']) && $wp_query->query['error'] == '404')) )

{

if (!is_null($this->template))

{

$this->set_is_virtual_page( TRUE );

$this->keyword = str_replace('-', ' ', $this->keyword);

$post = $this->template;

$post->post_name = $wp->request;

//$post->guid = get_home_url('/' . $this->keyword);

$post->post_title = $this->get_post_title($this->keyword);

//put your custom content here

$post->post_content = str_replace('%vpt-keyword%', $this->keyword, $this->template_content);

//just needs to be a number - negatives are fine

$post->post_status = 'publish';

$post->comment_status = 'closed';

$post->ping_status = 'open';

$post->comment_count = 0;

//dates may need to be overwritten if you have a "recent posts" widget or similar - set to whatever you want

$post->post_parent = 0;

$post->menu_order = 0;

$post->filter ='raw';

$posts = NULL;

$posts[] = $post;

$wp_query->is_singular = TRUE;

$wp_query->is_home = FALSE;

$wp_query->is_archive = FALSE;

if (!is_null($this->category_slug))

$wp_query->is_category = FALSE;

unset($wp_query->query['error']);

$wp_query->query_vars['error']='';

$wp_query->is_404 = FALSE;

$wp_query->found_posts = TRUE;

$wp_query->is_attachment = FALSE;

$wp_query->query_vars['page'] = 0;

$wp_query->query_vars['attachment'] = NULL;

unset($wp_query->query['attachment']);

if ($post->post_type == 'post')

{

// add the uncateegorized class to the article

add_filter('post_class',array($this, 'add_uncategorized_class'));

$wp_query->query['name'] = $this->keyword;

$wp_query->is_page = FALSE;

$wp_query->is_single = TRUE;

}

else

{

$wp_query->query['pagename'] = $this->keyword;

$wp_query->query_vars['pagename'] = $this->keyword;

$wp_query->is_page = TRUE;

$wp_query->is_single = FALSE;

}

// remove these values so that virtual page will work normally

if (isset($wp_query->query['category_name']))

unset($wp_query->query['category_name']);

if (isset($wp_query->query_vars['category_name']))

unset($wp_query->query_vars['category_name']);

$wp_query->query['name'] = $this->keyword;

$wp_query->query['page'] = NULL;

}

}

return $posts;

}

/**

* get_post_title

*

* use the template's page_title when %vpt-keyword% is in it, otherwise its value would be the current keyword

* example: if the template's page title is : `The best %vpt-keyword%` and the keyword is `KEYWORD`, the page's page title would be `The best KEYWORD`

* if the template's page title is : `Some title` and the keyword is `KEYWORD`, the page's page title would be `KEYWORD`

*

* @access public

* @param array $classes

* @return arrat $classes

*/

public function get_post_title(){

$post_title = $this->keyword;

if (strpos($this->template->post_title, '%vpt-keyword%'))

{

$post_title = str_replace('%vpt-keyword%', $this->keyword, $this->template->post_title);

}

return $post_title;

}

/**

* add_uncategorized_class

*

* add the uncategorized class to the article the same as the normal posts does on uncategorized posts

*

* @access public

* @param array $classes

* @return arrat $classes

*/

public function add_uncategorized_class($classes){

$classes[] = 'category-uncategorized';

return $classes;

}

/**

* get_template_content

*

* gets the template content and update the data e.g. converts %keyword% and spin texts

*

* @access public

* @param object $posts - the wp posts

* @return $posts

*/

public function get_template_content()

{

global $wp,$wp_query, $wp_rewrite;

if (isset($this->options['page_template']))

{

$this->template = get_post($this->options['page_template']);

if (empty($this->template))

return;

$this->template_content = $this->template->post_content;

$this->categories = get_the_category($this->template->ID);

$slug = $this->get_category_slug(rtrim($_SERVER['REQUEST_URI'], '/'));

if ($slug)

{

$this->category_slug = $slug;

$got_custom = TRUE;

}

}

return $this->template_content;

}

/**

* start buffer to get the html content and remove the `id` attribute in the <article/> tag if virtual page

*

* @access public

* @return void

*/

public function buffer_start()

{

if ($this->is_virtual_page() && $this->hide_post_id)

ob_start(array($this,'remove_article_id'));

}

/**

* end the buffer / flush

*

* @access public

* @return void

*/

public function buffer_end()

{

if ($this->is_virtual_page() && $this->hide_post_id)

ob_end_flush();

}

/**

* remove the `id` attribute in the <article/> tag if virtual page

*

* @access public

* @param html $buffer

* @return html $buffer

*/

public function remove_article_id($buffer)

{

// modify buffer here, and then return the updated code

if ($this->is_virtual_page() && $this->hide_post_id)

return (str_replace('<article id="post-' . $this->template->ID.'"', '<article', $buffer));

else return $buffer;

}

/**

* gets the category slug from the given file / name / object

*

*

* @access public

* @param string / object $path

* @param string $category_slug

* @return string $category_slug

*/

public function get_category_slug($path = NULL)

{

$slug_string = NULL;

// explode the path and check vs all categories

$paths = explode('/', $path);

$paths = array_reverse($paths);

$categories = array();

foreach ($this->categories as $category)

{

$categories[$category->slug] = $category;

}

$slug_arr = array();

foreach($paths as $path){

if (array_key_exists($path, $categories))

{

$slug_arr []= $categories[$path]->slug;

}

}

if (!empty($slug_arr))

{

$slug_arr = array_reverse($slug_arr);

$slug_string = implode('/', $slug_arr);

}

else

{

if (!empty($categories))

$slug_string = current($categories)->slug;

}

return $slug_string;

}

/**

* gets the current blog's path

*

*

* @access public

* @param BOOL $get_new

* @return string $blog_path

*/

public function get_blog_path()

{

if (function_exists('get_current_blog_id') && function_exists('get_blog_details'))

{

$this->blog_path = str_replace('http://'.$_SERVER['HTTP_HOST'], '', site_url()) . '/';

$this->blog_path = str_replace('https://'.$_SERVER['HTTP_HOST'], '', $this->blog_path);

}

return $this->blog_path;

}

/**

* sets the current blog's path

*

*

* @access public

* @return void

*/

public function set_blog_path($blog_path = '/')

{

$this->blog_path = $blog_path;

}

/**

* Include required admin files.

*

* @access public

* @return void

*/

public function admin_includes()

{

// do admin includes here

wp_enqueue_script('vpt-scripts',plugins_url( '/js/scripts.js' , __FILE__ ),array( 'jquery' ));

}

/**

* Include required frontend files.

*

* @access public

* @return void

*/

public function frontend_includes()

{

// do site includes here

}

public function display_notification()

{

if ($this->notice_iserror) {

echo '<div id="message" class="error">';

}

else {

echo '<div id="message" class="updated fade">';

}

echo '<p><strong>' . $this->notice . '</strong></p></div>';

}

/**

* gets whether the current page is a virtual url or not

*

*

* @access public

* @return BOOL $is_virtual_page

*/

public function is_virtual_page()

{

return $this->is_virtual_page;

}

/**

* sets whether the current page is a virtual url or not

*

*

* @access public

* @param BOOL $is_virtual_page

* @return void

*/

public function set_is_virtual_page($is_virtual_page = FALSE)

{

$this->is_virtual_page = $is_virtual_page;

}

/**

* loads the JS files (admin)

*

*

* @access public

* @return void

*/

public function loadJS()

{

wp_register_script( 'vpt.metabox.js', plugins_url( '/js/metabox.js' , __FILE__ ));

wp_enqueue_script( 'vpt.metabox.js' );

}