<?php
namespace PressForward\Controllers;

use PressForward\Interfaces\SystemMeta;
use PressForward\Interfaces\System;
use Intraxia\Jaxion\Contract\Core\HasFilters;
use Intraxia\Jaxion\Contract\Core\HasActions;
/**
 * Functionality related to nominations
 */
class Metas implements HasFilters, HasActions {

	function __construct( SystemMeta $metas, System $system ) {
		$this->meta_interface = $metas;
		$this->system = $system;
		$this->master_field = 'pf_meta';

	}

	public function filter_hooks() {
		$filters = array(
			array(
				'hook' => 'get_post_metadata',
				'method' => 'usable_forward_to_origin_status',
				'priority'  => 10,
				'args' => 4,
			),
		);

		return $filters;
	}

	public function action_hooks() {
		$filters = array(
			array(
				'hook' => 'init',
				'method' => 'register_pf_metas',
				'priority'  => 10,
			),
		);

		return $filters;
	}

	public function setup_source_statement_on_content($content){
		$content = pressforward('utility.forward_tools')->append_source_statement($post_id, $content, true);
	}

	/**
	 * Take an array of objects describing post_metas and set them to the id of a post.
	 *
	 * @since 3.x
	 *
	 * @param int   $id A post object ID number.
	 * @param array $args {
	 * 			An array of objects containing post_meta data.
	 *
	 * 			@var array {
	 *						@var string $name The post_meta slug.
	 * 						@var string $value The post_meta's value.
	 *			}
	 * }
	 */
	function establish_post( $id, $args ) {
		foreach ( $args as $arg ) {
			$this->add_pf_meta( $id, $arg['name'], $arg['value'], true );
		}
	}

	/**
	 * Takes a post_meta name and a post_meta value and turns it into an for use.
	 *
	 * @return array An array useful in thevarious parts of the post_meta setting process.
	 */
	function meta_for_entry( $key, $value ) {
		return array(
			'name'	=> $key,
			'value'	=> $value,
		);
	}

	/**
	 * With two post IDs copy all the standard PressForward meta from one post to another.
	 *
	 * @param int $idA The ID of the post that has all the meta info already set.
	 * @param int $idB The ID of the post that needs to have the meta info attached to it.
	 */
	function transition_post_meta( $idA, $idB, $term_transition = false ) {
		if ( ( ! is_string( $idA ) || ! is_string( $idB ) ) && ( ! is_numeric( $idA ) || ! is_numeric( $idB ) ) ) {
			pf_log( 'Post meta transition failed.' );
			pf_log( $idA );
			pf_log( $idB );
			pf_log( $term_transition );
			return;
		}
		pf_log( 'Transition post ' . $idA . ' to ' . $idB );
		foreach ( $this->structure() as $meta ) {
			$post_types = apply_filters( 'pf_transition_post_meta', array( 'item', 'nomination', 'post' ) );
			$level_check = false;
			foreach ( $meta['level'] as $level ) {
				if ( in_array( $level, $post_types ) ) {
					$level_check = true;
				}
			}
			if ( $level_check ) {
			    $this->transition_meta( $this->get_name( $meta ), $idA, $idB );
			} else {
				return;
			}
		}
		if ( $term_transition ) {
			pf_log( 'Transitioning Terms.' );
			$this->transition_meta_terms( $idA, $idB );
		}
	}

	function transition_meta_terms( $idA, $idB ) {
		$parent = wp_get_post_parent_id( $idA );
		$ids = array( $idA );
		if ( ! empty( $parent ) && ! is_wp_error( $parent ) ) {
			$ids[] = $parent;
		}
		$item_id = $this->get_post_pf_meta( $idA, 'pf_item_post_id' );
		if ( ! empty( $item_id ) && ! is_wp_error( $item_id ) ) {
			$ids[] = $item_id;
		}

		$term_objects = wp_get_object_terms( $ids, array( pressforward( 'schema.feeds' )->tag_taxonomy, 'post_tag', 'category' ) );
		$item_tags = $this->get_post_pf_meta( $idA, 'item_tags' );
		if ( ! empty( $term_objects ) ) {
			foreach ( $term_objects as $term ) {
				wp_set_object_terms( $idB, $term->term_id, $term->taxonomy, true );
				if ( pressforward( 'schema.feeds' )->tag_taxonomy == $term->taxonomy ) {
					$check = $this->cascade_taxonomy_tagging( $idB, $term->slug, 'slug' );
					if ( ! $check ) {
						$this->build_and_assign_new_taxonomy_tag( $idB, $term->name );
					}
				}
			}
		}
		$this->handle_item_tags( $idB, $item_tags );
	}

	public function handle_item_tags( $idB, $item_tags ) {
		if ( ! empty( $item_tags ) ) {
			pf_log( 'Attempting to attach item_tags.' );
			if ( ! is_array( $item_tags ) ) {
				pf_log( $item_tags );
				$item_tags = explode( ',',$item_tags );
			}
			foreach ( $item_tags as $key=>$tag ) {
				$tag = trim( $tag );
				$item_tags[$key] = $tag;
				$check = $this->cascade_taxonomy_tagging( $idB, $tag, 'name' );
				if ( ! $check ) {
					$this->build_and_assign_new_taxonomy_tag( $idB, $tag );
				}
			}
			return $item_tags;
		} else {
			return array();
		}
	}

	/**
	 * If term exists among current categories or terms, assign it.
	 *
	 * @param  [type] $idB          [description]
	 * @param  [type] $term_id      [description]
	 * @param  string $term_id_type [description]
	 * @return [type]               [description]
	 */
	function cascade_taxonomy_tagging( $idB, $term_id, $term_id_type = 'slug' ) {
		pf_log( 'Trying to assign taxonomy for ' . $idB );
		$term_object = get_term_by( $term_id_type, $term_id, 'category' );
		if ( empty( $term_object ) ) {
			pf_log( 'No category match.' );
			$term_object = get_term_by( $term_id_type, $term_id, 'post_tag' );
			if ( empty( $term_object ) ) {
				pf_log( 'No post_tag match.' );
				return false;
			} else {
				return wp_set_object_terms( $idB, intval( $term_object->term_id ), 'post_tag', true );

			}
		} else {
			return wp_set_object_terms( $idB, intval( $term_object->term_id ), 'category', true );
		}
		return true;
	}

	/**
	 * When no tag exists, PF will use this function to build and assign a new
	 * post tag.
	 *
	 * @param  [type] $idB           [description]
	 * @param  [type] $full_tag_name [description]
	 * @return [type]                [description]
	 */
	function build_and_assign_new_taxonomy_tag( $idB, $full_tag_name ) {
		pf_log( 'Attaching new tag to ' . $idB . ' with a name of ' . $full_tag_name );
		$term_args = array(
							'description'	=> 'Added by PressForward',
							'parent'		=> 0,
							'slug'			=> pf_slugger( $full_tag_name ),
						);
		$r = wp_insert_term( $full_tag_name, 'post_tag', $term_args );
		if ( ! is_wp_error( $r ) && ! empty( $r['term_id'] ) ) {
			pf_log( 'Making a new post_tag, ID:' . $r['term_id'] );
			wp_set_object_terms( $idB, intval( $r['term_id'] ), 'post_tag', true );
		} else {
			pf_log( 'Failed making a new post_tag' );
			pf_log( $r );
		}
	}

	/**
	 * With a post_meta slug and two post IDs copy a post_meta from one post to another.
	 *
	 * @param string $name The post_meta slug.
	 * @param int    $idA The post which already has the post_meta data.
	 * @param int    $idB The post which needs the post_meta copied to it.
	 *
	 * @return int The result of the update_post_meta function.
	 */
	function transition_meta( $name, $idA, $idB ) {
		//pf_log( 'Transition ' . $idA . ' meta field ' . $name );
		$meta_value = $this->meta_interface->get_meta( $idA, $name, true );
		$result = $this->check_for_and_transfer_depreciated_meta( $name, $meta_value, $idA, $idB );
		if ( ! $result ) {
			//pf_log( $name . ' not depreciated, updating on post ' . $idB );
			$result = $this->meta_interface->update_meta( $idB, $name, $meta_value );
		}

		return $result;
	}

	/**
	 * Check a post_meta slug and insure that the correct post_meta is being set.
	 *
	 * Considers a post_meta slug and checkes it against a list for depreciation.
	 * If the post_meta slug has been depreciated update the new slug and the old one.
	 *
	 * Based on http://seoserpent.com/wordpress/custom-author-byline
	 *
	 * @since 3.x
	 *
	 * @param string $name The post_meta slug.
	 * @param string $value The post_meta value.
	 * @param int    $idA The id of the post that already has the post_meta set.
	 * @param int    $idB The id of the post that needs the post_meta set.
	 *
	 * @return bool True if the post_meta is supported by PressForward.
	 */
	function check_for_and_transfer_depreciated_meta( $name, $value, $idA, $idB ) {
		foreach ( $this->structure() as $meta ) {
			if ( $meta['name'] == $name ) {
				if ( in_array( 'dep', $meta['type'] ) ) {
					pf_log( $name . ' is a depreciated meta type. Prepping to transfer to ' . $meta['move'] );
					if ( ( ! isset( $value )) || (false == $value) || ('' == $value) || (0 == $value) || (empty( $value )) ) {
						pf_log( 'No value was passed. Get meta data from new meta key.' );
						$value = $this->meta_interface->get_meta( $idA, $meta['move'], true );
					}
					$this->meta_interface->update_meta( $idB, $meta['move'], $value );
					return true;
				}
			}
		}
		return false;
	}

	/**
	 * Get the meta by its name, if it is supported by PressForward.
	 *
	 * @since 3.x
	 *
	 * @param string $name The meta name we're checking to see if it is an
	 *						an official PF meta.
	 *
	 * @return string|bool 	Returns PF meta object, false if not.
	 */
	function by_name( $name ) {
		foreach ( $this->structure() as $meta ) {
			if ( $name == $meta['name'] ) {
				return $meta;
			} else {
				pf_log( $name . ' is not a PF meta type.' );
				return false;
			}
		}
	}

	/**
	 * Return a PF Meta Object that is assuredly not depreciated.
	 *
	 * @param  [type] $name [description]
	 * @return [type]       [description]
	 */
	public function assure_key( $name ) {
		$meta = $this->by_name( $name );
		// pf_log('Assuring '.$name.' is PF meta.');
		if ( ( false !== $meta ) && ! empty( $meta['move'] ) ) {
			return $this->by_name( $meta['move'] );
		} else {
			pf_log( $name . ' is not PF meta.' );
			return array( 'name' => $name, 'error' => 'not_pf_meta' );
		}
	}

	/**
	 * Return the meta database key.
	 *
	 * @param  [type] $name [description]
	 * @return [type]       [description]
	 */
	public function get_key( $name ) {
		$meta = $this->assure_key( $name );
		return $this->get_name( $meta );
	}

	/**
	 * Get the name (database key) out of the meta object.
	 */
	function get_name( $meta ) {
		return $meta['name'];
	}

	/**
	 * Get an array representing all the approved post_meta objects for PressForward.
	 *
	 * @since 3.x
	 *
	 * @return array An object describing all the post_metas used by PressForward.
	 */
	function structure() {
		// Inspired by http://www.loc.gov/standards/metable.html
		// Adm=Administrative, Struc=Structural, Desc=Descriptive, Req=Required, Rep=Repeatable, Set=Set, Aggr=Aggregate, Dep = Depreciated
		$metas = array(
			'item_id' => array(
				'name' => 'item_id',
				'definition' => __( 'Unique PressForward ID', 'pf' ),
				'function'	=> __( 'Stores hashed ID based on title and URL of retrieved item', 'pf' ),
				'type'	=> array( 'struc' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'pf_meta' => array(
				'name' => 'pf_meta',
				'definition' => __( 'Serialized PF data', 'pf' ),
				'function'	=> __( 'Array of PF data that can be serialized', 'pf' ),
				'type'	=> array( 'struc' ),
				'use'	=> array( 'req' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'origin_item_ID' => array(
				'name' => 'origin_item_ID',
				'definition' => __( 'DUPE Soon to be depreciated version of item_id', 'pf' ),
				'function'	=> __( 'Stores hashed ID based on title and URL of retrieved item', 'pf' ),
				'type'	=> array( 'struc', 'dep' ),
				'use'	=> array( 'req' ),
				'move'	=> 'item_id',
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'pf_item_post_id' => array(
				'name' => 'pf_item_post_id',
				'definition' => __( 'The WordPress postID associated with the original item', 'pf' ),
				'function'	=> __( 'Stores hashed WP post_ID associated with the original item', 'pf' ),
				'type'	=> array( 'struc' ),
				'use'	=> array( 'req' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'nom_id' => array(
				'name' => 'nom_id',
				'definition' => __( 'The WordPress postID associated with the nomination item', 'pf' ),
				'function'	=> __( 'Stores nomination id', 'pf' ),
				'type'	=> array( 'struc' ),
				'use'	=> array( 'req' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'pf_final_step_id' => array(
				'name' => 'pf_final_step_id',
				'definition' => __( 'The WordPress postID associated with the post on the final step', 'pf' ),
				'function'	=> __( 'Stores postID associated with the last step item', 'pf' ),
				'type'	=> array( 'struc' ),
				'use'	=> array(),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'item_feed_post_id' => array(
				'name' => 'item_feed_post_id',
				'definition' => __( 'DUPE Soon to be depreciated version of pf_item_post_id', 'pf' ),
				'function'	=> __( 'Stores hashed ID based on title and URL of retrieved item', 'pf' ),
				'type'	=> array( 'struc', 'dep' ),
				'use'	=> array( 'req' ),
				'move'	=> 'pf_item_post_id',
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'source_title' => array(
				'name' => 'source_title',
				'definition' => __( 'Title of the item\'s source', 'pf' ),
				'function'	=> __( 'Stores the title retrieved from the feed.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'pf_source_link' => array(
				'name' => 'pf_source_link',
				'definition' => __( 'URL of the item\'s source', 'pf' ),
				'function'	=> __( 'Stores the url of feed source.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'pf_feed_item_source' => array(
				'name' => 'pf_feed_item_source',
				'definition' => __( 'DUPE Soon to be depreciate version of source_title.', 'pf' ),
				'function'	=> __( 'Stores the title retrieved from the feed.', 'pf' ),
				'type'	=> array( 'desc','dep' ),
				'use'	=> array( 'req' ),
				'move'	=> 'source_title',
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'item_date' => array(
				'name' => 'item_date',
				'definition' => __( 'Date posted on the original site', 'pf' ),
				'function'	=> __( 'Stores the date the item was posted on the original site', 'pf' ),
				'type'	=> array( 'desc' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'posted_date' => array(
				'name' => 'posted_date',
				'definition' => __( 'DUPE The soon to be depreciated version of item_date', 'pf' ),
				'function'	=> __( 'Stores the date given by the source.', 'pf' ),
				'type'	=> array( 'struc', 'dep' ),
				'use'	=> array( 'req' ),
				'move'	=> 'item_date',
				'level'	=> array( 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'item_author' => array(
				'name' => 'item_author',
				'definition' => __( 'Author(s) listed on the original site', 'pf' ),
				'function'	=> __( 'Stores array value containing authors listed in the source feed.', 'pf' ),
				'type'	=> array( 'struc' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'authors' => array(
				'name' => 'authors',
				'definition' => __( 'DUPE The soon to be depreciated version of item_author', 'pf' ),
				'function'	=> __( 'Stores a comma-separated set of authors as listed in the source feed', 'pf' ),
				'type'	=> array( 'struc','dep' ),
				'use'	=> array(),
				'move'	=> 'item_author',
				'level'	=> array( 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'item_link' => array(
				'name' => 'item_link',
				'definition' => __( 'Source link', 'pf' ),
				'function'	=> __( 'Stores link to the origonal post.', 'pf' ),
				'type'	=> array( 'struc' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'nomination_permalink' => array(
				'name' => 'item_link',
				'definition' => __( 'Source link', 'pf' ),
				'function'	=> __( 'DUPE Soon to be depreciated version of item_link', 'pf' ),
				'type'	=> array( 'struc','dep' ),
				'use'	=> array( 'req' ),
				'move'	=> 'item_link',
				'level'	=> array( 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'item_feat_img' => array(
				'name' => 'item_feat_img',
				'definition' => __( 'Featured image from source', 'pf' ),
				'function'	=> __( 'A featured image associated with the item, when it is available', 'pf' ),
				'type'	=> array( 'struc' ),
				'use'	=> array(),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'item_wp_date' => array(
				'name' => 'item_wp_date',
				'definition' => __( 'Time item was retrieved', 'pf' ),
				'function'	=> __( 'The datetime an item was added to WordPress via PressForward', 'pf' ),
				'type'	=> array( 'desc' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'date_nominated' => array(
				'name' => 'date_nominated',
				'definition' => __( 'Time nominated', 'pf' ),
				'function'	=> __( 'The datetime the item was made a nomination', 'pf' ),
				'type'	=> array( 'desc' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'item_tags' => array(
				'name' => 'item_tags',
				'definition' => __( 'Tags associated with the item by source', 'pf' ),
				'function'	=> __( 'An array of tags associated with the item, as created in the feed', 'pf' ),
				'type'	=> array( 'desc' ),
				'use'	=> array(),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'source_repeat' => array(
				'name' => 'source_repeat',
				'definition' => __( 'Times retrieved', 'pf' ),
				'function'	=> __( 'Counts number of times the item has been collected from the multiple feeds (Ex: from origin feed and Twitter)', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'nomination_count' => array(
				'name' => 'nomination_count',
				'definition' => __( 'Nominations', 'pf' ),
				'function'	=> __( 'Counts number of times users have nominated an item', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'submitted_by' => array(
				'name' => 'submitted_by',
				'definition' => __( 'The user who submitted the nomination', 'pf' ),
				'function'	=> __( 'The first user who submitted the nomination (if it has been nominated). User ID number', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'nominator_array' => array(
				'name' => 'nominator_array',
				'definition' => __( 'Users who nominated this item', 'pf' ),
				'function'	=> __( 'Stores and array of all userIDs that nominated the item in an array', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'sortable_item_date' => array(
				'name' => 'sortable_item_date',
				'definition' => __( 'Timestamp for the item', 'pf' ),
				'function'	=> __( 'A version of the item_date meta that\'s ready for sorting. Should be a Unix timestamp', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'req' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,

			),
			'readable_status' => array(
				'name' => 'readable_status',
				'definition' => __( 'If the content is readable', 'pf' ),
				'function'	=> __( 'A check to determine if the content of the item has been made readable', 'pf' ),
				'type'	=> array( 'desc' ),
				'use'	=> array( 'req', 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'revertible_feed_text' => array(
				'name' => 'revertible_feed_text',
				'definition' => __( 'The originally retrieved description', 'pf' ),
				'function'	=> __( 'The original description, excerpt or content text given by the feed', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array(),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'pf_feed_item_word_count' => array(
				'name' => 'pf_feed_item_word_count',
				'definition' => __( 'Word count of original item text', 'pf' ),
				'function'	=> __( 'Stores the count of the original words retrieved with the feed item', 'pf' ),
				'type'	=> array( 'desc' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> true,
			),
			'pf_word_count' => array(
				'name' => 'pf_word_count',
				'definition' => __( 'Word count of text', 'pf' ),
				'function'	=> __( 'Stores the count of the words on the last save managed by PF.', 'pf' ),
				'type'	=> array( 'desc' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'pf_archive' => array(
				'name' => 'pf_archive',
				'definition' => __( 'Archive state of the item', 'pf' ),
				'function'	=> __( 'Stores if the item has been archived', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array(),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'_thumbnail_id' => array(
				'name' => '_thumbnail_id',
				'definition' => __( 'Thumbnail id', 'pf' ),
				'function'	=> __( 'The ID of the featured item', 'pf' ),
				'type'	=> array( 'adm','struc' ),
				'use'	=> array(),
				'level'	=> array( 'item', 'nomination', 'post' ),
				'serialize'	=> false,
			),
			'archived_by_user_status' => array(
				'name' => 'archived_by_user_status',
				'definition' => __( 'Users who have archived', 'pf' ),
				'function'	=> __( 'Stores users who have archived.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array(),
				'level'	=> array( 'item', 'nomination' ),
				'serialize'	=> true,
			),
			'pf_feed_error_count' => array(
				'name' => 'pf_feed_error_count',
				'definition' => __( 'Count of feed errors', 'pf' ),
				'function'	=> __( 'Stores a count of the number of errors a feed has experianced', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array(),
				'level'	=> array( 'feed', 'post' ),
				'serialize'	=> true,
			),
			'pf_forward_to_origin'  => array(
				'name' => 'pf_forward_to_origin',
				'definition' => __( 'User override for forwarding to origin of link', 'pf' ),
				'function'	=> __( 'Stores forwarding override for posts', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'post' ),
				'serialize'	=> false,
			),
			'pf_feed_last_retrieved' => array(
				'name' => 'pf_feed_last_retrieved',
				'definition' => __( 'Last time feed was retrieved', 'pf' ),
				'function'	=> __( 'Stores last timestamp feed was retrieved.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'pf_nominations_in_feed' => array(
				'name' => 'pf_nominations_in_feed',
				'definition' => __( 'Nominations received by items supplied by this feed', 'pf' ),
				'function'	=> __( 'Number of nominations for this feed', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'pf_feed_last_retrieved' => array(
				'name' => 'pf_feed_last_retrieved',
				'definition' => __( 'Last time feed was retrieved', 'pf' ),
				'function'	=> __( 'Stores last timestamp feed was retrieved.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'feedUrl' => array(
				'name' => 'feedUrl',
				'definition' => __( 'URL for a feed', 'pf' ),
				'function'	=> __( 'Stores location online for feed.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'pf_feed_last_checked' => array(
				'name' => 'pf_feed_last_checked',
				'definition' => __( 'Last time feed was checked', 'pf' ),
				'function'	=> __( 'Stores last timestamp feed was checked.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array(),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'pf_no_feed_alert' => array(
				'name' => 'pf_no_feed_alert',
				'definition' => __( 'Feed Alert Status', 'pf' ),
				'function'	=> __( 'A check to see if an alert is on the feed.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array(),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'feed_type' => array(
				'name' => 'feed_type',
				'definition' => __( 'Type of feed', 'pf' ),
				'function'	=> __( 'Field stores the type of feed (like RSS or OPML) the object holds.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'htmlUrl'	=> array(
				'name' => 'htmlUrl',
				'definition' => __( 'Site URL of a feed.', 'pf' ),
				'function'	=> __( 'The home URL of a feed.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'user_added'	=> array(
				'name' => 'user_added',
				'definition' => __( 'User who added a feed..', 'pf' ),
				'function'	=> __( 'Track who added a subscribed or under review feed.', 'pf' ),
				'type'	=> array( 'adm','struc' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'module_added'	=> array(
				'name' => 'module_added',
				'definition' => __( 'Module to process a feed.', 'pf' ),
				'function'	=> __( 'The feed should be processed with this module.', 'pf' ),
				'type'	=> array( 'adm','struc' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'ab_alert_msg'	=> array(
				'name' => 'ab_alert_msg',
				'definition' => __( 'Alert Message processing and storage.', 'pf' ),
				'function'	=> __( 'Stores a feed alert to be processed.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array( 'api' ),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
			'pf_meta_data_check' => array(
				'name' => 'pf_meta_data_check',
				'definition' => __( 'Has metadata been compleatly added to a feed?', 'pf' ),
				'function'	=> __( 'Store a value to indicate the meta-processing of a feed has completed.', 'pf' ),
				'type'	=> array( 'adm' ),
				'use'	=> array(),
				'level'	=> array( 'feed' ),
				'serialize'	=> false,
			),
		);

		$metas = apply_filters( 'pf_meta_terms',$metas );
		return $metas;
	}

	/**
	 * Register metas to prevent core from breaking when adding them to API
	 *
	 * https://developer.wordpress.org/reference/functions/register_meta/
	 * and WP_REST_Term_Meta_Fields.
	 *
	 * @return [type] [description]
	 */
	function register_pf_metas() {
		$metas = array();
		foreach ( $this->structure() as $key => $meta ) {
			if ( $meta['serialize'] ) {
				continue;
			}
			if ( ! in_array( 'api', $meta['use'] ) ) {
				continue;
			}
			$metas[ $key ] = array();
			$metas[ $key ]['show_in_rest'] = true;
			$metas[ $key ]['single'] = true;
			$metas[ $key ]['type'] = 'string';
			$metas[ $key ]['show_in_rest'] = false;
			$metas[ $key ]['description'] = $meta['function'];
			foreach ( $meta['level'] as $level ) {
				switch ( $level ) {
					case 'item':
						register_meta( pressforward( 'schema.feed_item' )->post_type, $key, $metas[ $key ] );
						break;
					case 'nomination':
						register_meta( pressforward( 'schema.nominations' )->post_type, $key, $metas[ $key ] );
						break;
					case 'post':
						register_meta( 'post', $key, $metas[ $key ] );
						break;
					case 'feed':
						register_meta( pressforward( 'schema.feeds' )->post_type, $key, $metas[ $key ] );
						break;
					default:
						// code...
						break;
				}
			}
		}
		return true;
	}

	/*
	 * A function to check and retrieve the right meta field for a post.
	 */
	function pass_meta( $field, $id = false, $value = '', $single = true ) {
	    $metas = $this->structure();
	    // Check if it exists.
	    if ( empty( $metas[ $field ] ) ) {
	        pf_log( 'The field ' . $field . ' is not supported.' );
					return $field;
	    }
		// Check if it has been depreciated (dep). If so retrieve
	    if ( in_array( 'dep',$metas[ $field ]['type'] ) ) {
			$new_field = $metas[ $field ]['move'];
			pf_log( 'You tried to use depreciated field ' . $field . ' it was moved to ' . $new_field );
			$this->transition_depreciated_meta( $field, $id, $value, $single, $new_field );
	        $field = $new_field;
	    }

		if ( $metas[ $field ]['serialize'] ) {
			return array( 'field' => $field, 'master_field' => $this->master_field );
		}
	    return $field;

	}

	/**
	 * Transitions meta values from old depreciated meta_slugs to new ones.
	 */
	function transition_depreciated_meta( $field, $id, $value, $single, $new_field ) {
		$result = false;
		// Note - empty checks for FALSE
		$old = $this->meta_interface->get_meta( $id, $field, $single );
		$new = $this->meta_interface->get_meta( $id, $new_field, $single );
		if ( (false != $id) && ! empty( $old ) && empty( $new ) ) {
			if ( empty( $value ) ) {
				$result = $this->meta_interface->update_meta( $id, $new_field, $old );
			} else {
				$result = $this->meta_interface->update_meta( $id, $new_field, $value );
			}
		}
		return $result;
	}

	/**
	 * Retrieve post_meta data in a way that insures the correct value is pulled.
	 *
	 * Function allows users to retrieve the post_meta in a safe way standerdizing against
	 * the list of accepted PressForward meta_slugs. It deals with depreciated post_meta.
	 *
	 * @since 3.x
	 *
	 * @param int    $id Post ID.
	 * @param string $field The post_meta field to retrieve.
	 * @param bool   $obj If the user wants to return a PressForward post_meta description object. Default false.
	 * @param bool   $single If the user wants to use the WordPress post_meta Single decleration. Default true.
	 *
	 * @return string|array Returns the result of retrieving the post_meta or the self-descriptive meta-object with value.
	 */
	function retrieve_meta( $id, $field, $obj = false, $single = true ) {
	    $field = $this->pass_meta( $field, $id );
		$serialized = false;
		if ( is_array( $field ) ) {
			$key = $field['field'];
			$field = $field['master_field'];
			$serialized = true;
			$single = true;
		}
	    $meta = $this->meta_interface->get_meta( $id, $field, $single );
		if ( $serialized ) {
			if ( empty( $meta ) || ! array_key_exists( $key, $meta ) ) {
				$old_meta = $this->meta_interface->get_meta( $id, $key, $single );
				$meta[ $key ] = $old_meta;
				$this->meta_interface->update_meta( $id, $field, $meta );
				$this->meta_interface->delete_meta( $id, $key, $old_meta );
				$meta = $old_meta;
			} else {
				$meta = $meta[ $key ];
			}
			// pf_log($key);
			// pf_log($meta);
			$meta = $this->check_value( $meta, $id, $key );
		} else {
			$meta = $this->check_value( $meta, $id, $field );
		}
		// pf_log($field);
		// pf_log($meta);
	    if ( $obj ) {
	        $metas = $this->structure();
	        $meta_obj = $metas[ $field ];
	        $meta_obj['value'] = $meta;
	        return $meta_obj;
	    }
	    return $meta;

	}

	public function check_value( $meta_value, $id, $field ) {
		switch ( $field ) {
			case 'item_link':
				if ( empty( $meta_value ) ) {
					$meta_value = pressforward( 'controller.system' )->get_the_guid( $id );
				}
				break;

			case 'source_title':
				if ( empty( $meta_value ) || is_wp_error( $meta_value ) ) {
					$meta_value = get_the_source_title( $id );
				}

			default:
				// code...
				break;
		}
		return $meta_value;
	}

	/**
	 * An alias for $this->retrieve_meta that allows you to use the standard argument set from get_post_meta.
	 */
	function get_post_pf_meta( $id, $field, $single = true, $obj = false ) {

			return $this->retrieve_meta( $id, $field, $obj, $single );

	}

	function get_all_meta_keys() {
		$meta_keys = array();
		foreach ( $this->structure() as $meta ) {
			$meta_keys[] = $this->get_name( $meta );
		}
		return $meta_keys;
	}

	public function get_all_metas( $post_id ) {
		$all_metas = $this->meta_interface->get_metas( $post_id );
		$structure = $this->structure();
		foreach ( $all_metas as $key => $meta ) {
			if ( isset( $structure[ $key ] ) && $structure[ $key ]['serialize'] ) {
				$all_metas[ $key ] = $this->get_post_pf_meta( $post_id, $key );
			}
		}
		return $all_metas;

	}

	/**
	 * Update post_meta on a post using PressForward post_meta standardization.
	 *
	 * @param int|string $id The post ID.
	 * @param string     $field The post_meta field slug.
	 * @param string     $value The post_meta value.
	 * @param string     $prev_value The previous value to insure proper replacement.
	 *
	 * @return int The check value from update_post_meta.
	 */
	function update_pf_meta( $id, $field, $value = '', $prev_value = null ) {
	    $field = $this->pass_meta( $field, $id, $value );
	    $check = $this->apply_pf_meta( $id, $field, $value, $prev_value );
	    return $check;

	}

	function get_author_from_url( $url ) {
		$response = pf_file_get_html( $url );
		$possibles = array();
		if ( empty( $response ) ) {
			return false;
		}
		$possibles[] = $response->find( 'meta[name=author]', 0 );
		$possibles[] = $response->find( 'meta[name=Author]', 0 );
		$possibles[] = $response->find( 'meta[property=author]', 0 );
		$possibles[] = $response->find( 'meta[property=Author]', 0 );
		$possibles[] = $response->find( 'meta[name=parsely-author]', 0 );
		$possibles[] = $response->find( 'meta[name=sailthru.author]', 0 );

		foreach ( $possibles as $possible ) {
			if ( false != $possible ) {
				$author_meta = $possible;
				break;
			}
		}

		if ( empty( $author_meta ) ) {
			return false;
		}

		$author = $author_meta->content;
		$author = trim( str_replace( 'by','',$author ) );
		$author = trim( str_replace( 'By','',$author ) );
		return $author;
	}

	/**
	 * Add post_meta on a post using PressForward post_meta standardization.
	 *
	 * @param int|string $id The post ID.
	 * @param string     $field The post_meta field slug.
	 * @param string     $value The post_meta value.
	 * @param string     $unique If the post_meta is unique.
	 *
	 * @return int The check value from add_post_meta.
	 */
	function add_pf_meta( $id, $field, $value = '', $unique = true ) {
	    $field = $this->pass_meta( $field, $id, $value, $unique );
	    $check = $this->apply_pf_meta( $id, $field, $value, $unique, 'add' );
		if (!$check){
			$this->apply_pf_meta( $id, $field, $value, $unique, 'update' );
		}
	    return $check;

	}

	function apply_pf_meta( $id, $field, $value = '', $state = null, $apply_type = 'update' ) {
		$serialized = false;
		if ( is_array( $field ) ) {
			$key = $field['field'];
			$field = $field['master_field'];
			$serialized = true;
			// pf_log($key);
		}
		// pf_log($field.': ');
		// pf_log($value);
		if ( $serialized ) {
			$switch_value = $key;
		} else {
			$switch_value = $field;
		}
		switch ( $switch_value ) {
			case 'pf_feed_item_word_count':
				$latest_count = $this->get_post_pf_meta( $id, 'pf_word_count' );
				if ( ($latest_count < $value ) ) {
					$this->update_pf_meta( $id, 'pf_word_count', $value, $state );
				} elseif ( empty( $latest_count ) ) {
					$this->add_pf_meta( $id, 'pf_word_count', $value, $state );
				}
				break;
			default:
				// code...
				break;
		}
		if ( $serialized ) {
			$master_meta = $this->meta_interface->get_meta( $id, $field, true );
			// pf_log($master_meta);
			if ( empty( $master_meta ) ) {
				$master_meta = array();
				$apply_type = 'add';
				$state = true;
			} else {
				$apply_type = 'update';
				$state = $master_meta;
			}
			$master_meta[ $key ] = $value;
			$value = $master_meta;
			// pf_log($value);
		}
		if ( 'update' == $apply_type ) {
			if ( $serialized ) {
				// pf_log($key);
				$this->meta_interface->delete_meta( $id, $key, '' );
			}
			$check = $this->meta_interface->update_meta( $id, $field, $value, $state );
			if ( ! $check ) {
				$check = $this->meta_interface->update_meta( $id, $field, $value, $state );
			}
		} elseif ( 'add' == $apply_type ) {
			$check = $this->meta_interface->add_meta( $id, $field, $value, $state );
		}
		// pf_log($field);
		// pf_log($value);
		// pf_log($check);
		return $check;
	}

	public function forward_to_origin_status( $ID, $check = true, $the_value = false ) {
		if ( $check ) {
			$value = pressforward( 'controller.metas' )->get_post_pf_meta( $ID, 'pf_forward_to_origin', true );
		} else {
			$value = $the_value;
		}
		if ( empty( $value ) ) {

			$option_value = get_option( 'pf_link_to_source' );
			if ( empty( $option_value ) ) {
				$value = 'no-forward';
			} else {
				$value = 'forward';
			}
		}

		return $value;
	}

	public function usable_forward_to_origin_status( $null, $object_id, $meta_key, $single ) {
		if ( $meta_key !== 'pf_forward_to_origin' ) {
			return $null;
		}
		remove_filter( 'get_post_metadata', array( $this, 'usable_forward_to_origin_status' ), 10 );
		$value = $this->forward_to_origin_status( $object_id );
		add_filter( 'get_post_metadata', array( $this, 'usable_forward_to_origin_status' ), 10, 4 );
		return $value;
	}

}