class-tei-dom.php

<?php

define('TEI', 'http://www.tei-c.org/ns/1.0');
define('HTML', 'http://www.w3.org/1999/xhtml');
define('ANTH', 'http://www.anthologize.org/ns');

class TeiDom {

	public $includeStructuredSubjects = true;
	public $includeItemSubjects = true;
	public $includeCreatorData = true;
	public $includeStructuredCreatorData = true;
	public $includeOriginalPostData = true;
	public $includeDeepDocumentData = true;
	public $doShortcodes = true;
	public $checkImgSrcs = true;

	public $front1Title = "Dedication";
	public $front2Title = "Acknowledgements";

	public $dom;
	public $xpath;
	public $tidy = false;

	public $bodyNode;
	public $projectData;
	public $knownPersons = array();
	public $knownSubjects = array();


	function __construct($sessionArray, $ops = array()) {
		@apply_filters('init');
		//the anthologize filter echos content, which clobbers exports
		remove_filter('the_content', 'anthologize_filter_post_content');
		if(class_exists('Tidy')) {
			$this->tidy = new Tidy();
		}

		foreach($ops as $op=>$value) {
			$this->$op = $value;
		}
		$this->projectData = $sessionArray;

		if(isset($this->outputParams['gravatar-default'])) {
			$this->avatarDefault = $this->outputParams['gravatar-default'];
		}

		//projectMeta has subtitle
		$projectMeta = get_post_meta($this->projectData['project_id'], 'anthologize_meta', true );
		$this->projectData['subtitle'] = $projectMeta['subtitle'];

		$projectWPData = get_post($this->projectData['project_id']); // has date info
		$this->projectData['post_date'] = $projectWPData->post_date;
		$this->projectData['post_date_gmt'] = $projectWPData->post_date_gmt;
		$this->projectData['post_modified'] = $projectWPData->post_modified;
		$this->projectData['post_modified_gmt'] = $projectWPData->post_modified_gmt;
		$this->projectData['guid'] = $projectWPData->guid;


		if( isset($this->projectData['outputParams']['do-shortcodes']) && $this->projectData['outputParams']['do-shortcodes'] == false ) {
			$this->doShortcodes = false;
		}

		$this->dom = new DOMDocument('1.0', 'UTF-8');
		$templatePath = WP_PLUGIN_DIR . DIRECTORY_SEPARATOR . "anthologize" .
		DIRECTORY_SEPARATOR . 'templates' . DIRECTORY_SEPARATOR . 'tei' . DIRECTORY_SEPARATOR .'teiEmpty.xml';
		$this->dom->load($templatePath);
		$this->dom->preserveWhiteSpace = false;
		$this->setXPath();

		$this->bodyNode = $this->xpath->query("//tei:body")->item(0);
		$this->frontNode = $this->xpath->query("//tei:front")->item(0);
		$this->backNode = $this->xpath->query("//tei:back")->item(0);
		$this->structuredSubjectList = $this->xpath->query("//tei:list[@xml:id='subjects']")->item(0);
		$this->structuredPersonList = $this->xpath->query("//tei:sourceDesc/tei:listPerson")->item(0);

		$this->buildProjectData();
		$this->addOutputDesc();
		$this->addPublicationStmt();
		$this->addFileDesc();
		$this->addTitlePageBibl();
		$this->addFrontMatter();

		$this->sanitizeMedia();
		$this->addBackMatter();
		//all done filtering, so add anthologize filter back in
		add_filter('the_content', 'anthologize_filter_post_content');
	}
	public function setXPath() {
		$this->xpath = new DOMXPath($this->dom);
		$this->xpath->registerNamespace('tei', TEI);
		$this->xpath->registerNamespace('html', HTML);
		$this->xpath->registerNamespace('anth', ANTH);
	}


	public function buildProjectData() {

		$args = array(
			'post_parent'=>$this->projectData['project_id'],
			'post_type'=>'anth_part',
			'orderby' => 'menu_order',
			'posts_per_page' => -1,
			'order' => 'ASC' );

		$partsData = new WP_Query($args);
		$partObjectsArray = $partsData->posts;


		$partNumber = 0;
		foreach($partObjectsArray as $partObject) {
			$newPart = $this->newPart($partObject);
			$newPart->setAttribute('n', $partNumber);
			$newPart->setAttribute('xml:id', "body-$partNumber");

			$args = array(
				'post_parent'=>$partObject->ID,
				'post_type'=>'anth_library_item',
				'posts_per_page'=> -1,
				'orderby' => 'menu_order',
				'order' => 'ASC' );

			$libraryItemsData = new WP_Query( $args );
			$libraryItemObjectsArray = $libraryItemsData->posts;

			$itemNumber = 0;

			foreach($libraryItemObjectsArray as $libraryItemObject) {

				$origPostData = get_post_meta($libraryItemObject->ID, 'anthologize_meta', true );
				$libraryItemObject->original_post_id = $origPostData['original_post_id'];

				$newItem = $this->newItem($libraryItemObject);
				$newItem->setAttribute('xml:id', "body-$partNumber-$itemNumber");
				if($this->includeStructuredSubjects) {
					$this->addStructuredSubjects($libraryItemObject->original_post_id);
				}

				$newItem->setAttribute('n', $itemNumber);
				$newPart->appendChild($newItem);
				$itemNumber++;
			}
			$this->bodyNode->appendChild($newPart);
			$partNumber++;
		}
	}

	public function addOutputDesc() {

		$outParamsNode = $this->xpath->query("//anth:outputParams")->item(0);

		foreach($this->projectData['outputParams'] as $name=>$value) {
			$newParam = $this->dom->createElementNS(ANTH, 'param', $value);
			$newParam->setAttribute('name', $name);
			$outParamsNode->appendChild($newParam);
			if($name == 'page-size') {
				$widthParam = $this->dom->createElementNS(ANTH, 'param');
				$widthParam->setAttribute('name', 'page-width');
				$heightParam = $this->dom->createElementNS(ANTH, 'param');
				$heightParam->setAttribute('name', 'page-height');
				switch($value) {
					case 'A4':
					case 'a4':
						$widthParam->nodeValue = '210mm';
						$heightParam->nodeValue = '297mm';
					break;

					case 'letter':
					case 'Letter':
						$widthParam->nodeValue = '8.5in';
						$heightParam->nodeValue = '11in';
					break;
				}
				$outParamsNode->appendChild($widthParam);
				$outParamsNode->appendChild($heightParam);
			}
		}
	}

	public function addPublicationStmt() {

		//cr

		$litAvailNode = $this->xpath->query("//tei:publicationStmt/tei:availability[@rend='literal']")->item(0);
		$litAvailNode->appendChild($this->sanitizeString("Creative Commons - " . strtoupper( $this->projectData['cctype'] )));
		$litAvailNode->setAttribute('status', $this->projectData['ctype']);

		$strAvailNode = $this->xpath->query("//tei:publicationStmt//tei:ab[@rend='structured']")->item(0);
		$strAvailNode->appendChild($this->dom->createTextNode("cc-" . $this->projectData['cctype']) );
		$strAvailNode->parentNode->setAttribute('status', $this->projectData['ctype']);

		//date
		$pubDateNode = $this->xpath->query("//tei:publicationStmt/tei:date")->item(0);
		$pubDateNode->appendChild($this->dom->createTextNode($this->projectData['cyear']));

	}

	public function addFileDesc() {

		$titleNode = $this->xpath->query('/tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:title')->item(0);
		$titleNode->appendChild($this->sanitizeString($project->post_title));

		//edition
		$edNode = $this->xpath->query("//tei:editionStmt/tei:ab[@rend='literal']")->item(0);
		$edNode->appendChild($this->sanitizeString($this->projectData['edition']));

	}

	public function addTitlePageBibl() {

		$projectBibl = $this->xpath->query("//tei:head[@type='titlePage']/tei:bibl")->item(0);

		$identNode = $this->xpath->query("tei:ident", $projectBibl)->item(0);
		$identNode->appendChild($this->dom->createCDATASection($this->projectData['guid']) );
		$titleNode = $this->xpath->query("tei:title[@type='main']", $projectBibl)->item(0);
		$titleNode->appendChild($this->sanitizeString($this->projectData['post-title']));

		$subTitleNode = $this->xpath->query("tei:title[@type='sub']", $projectBibl)->item(0);
		$subTitleNode->appendChild($this->sanitizeString($this->projectData['subtitle']));

		if($this->includeDeepDocumentData) {
			$projectPostData = get_post($this->projectData['project_id']);
			$userData = get_userdata($projectPostData->post_author);

			$projectBibl->appendChild($this->newAuthor($userData, 'projectCreator') );
			$createdNode = $this->dom->createElementNS(TEI, 'date');
			$createdNode->setAttribute('type', 'created');
			$projectBibl->appendChild($createdNode);
			$createdNode->appendChild($this->dom->createTextNode($this->projectData['post_date']));
		}
	}


	public function addFrontMatter() {
		//TODO: sanitize content and regularize the mode of adding.
		//TODO: reconcile with UX team.

		//front1
		$f1Node = $this->xpath->query("//tei:front/tei:div[@n='0']")->item(0);

		$f1TitleNode = $this->xpath->query("tei:head/tei:title", $f1Node )->item(0);
		//currently, f1 is hardcoded to be Dedication
		//TODO: change this when UI changes
		$f1TitleNode->appendChild($this->sanitizeString(htmlspecialchars($this->front1Title)));
		$f1Node->appendChild($this->sanitizeString($this->projectData['dedication'], true));

		//front2
		$f2Node = $this->xpath->query("//tei:front/tei:div[@n='1']")->item(0);
		$f2TitleNode = $this->xpath->query("tei:head/tei:title", $f2Node )->item(0);
		//TODO: change when UI changes currently hardcoded as acknowledgements
		$f2TitleNode->appendChild($this->sanitizeString(htmlspecialchars($this->front2Title)));


		$f2Node->appendChild($this->sanitizeString($this->projectData['acknowledgements'], true));
	}

	public function addBackMatter() {
		if($this->projectData['outputParams']['colophon'] && $this->projectData['outputParams']['colophon'] == 'on') {
			$this->backNode->appendChild( $this->newColophon() );
		}
		$this->doIndexing();
	}
	public function sanitizeMedia() {
		$this->sanitizeImages();

		if($this->linkToEmbeddedObjects) {
			$this->sanitizeEmbeds();
		}
	}

	public function sanitizeImages() {

		//strip out <a rel="nofollow"> (wordpress feeds)
		$aNoFollowNodes = $this->xpath->query('//a[@rel="nofollow"]');
		foreach($aNoFollowNodes as $aNode) {
			$aNode->parentNode->removeChild($aNode);
		}

		//strip out feedburner links
		$aFeedBurnerLinkNodes = $this->xpath->query('//a[contains(@href, "http://feeds.feedburner.com")]');
		foreach($aFeedBurnerLinkNodes as $aNode) {
			$aNode->parentNode->removeChild($aNode);
		}

		//strip out feedburner invisible images
		$imgNodes = $this->xpath->query('//img[contains(@src, "http://feeds.feedburner.com")]');
		foreach($imgNodes as $imgNode) {
			$imgNode->parentNode->removeChild($imgNode);
		}

		//strip out wordpress stats invisible images
		$imgNodes = $this->xpath->query('//img[contains(@src, "http://stats.wordpress.com")]');
		foreach($imgNodes as $imgNode) {
			$imgNode->parentNode->removeChild($imgNode);
		}
		//strip out blogger tracker
		$imgNodes = $this->xpath->query('//img[contains(@src, "blogger.googleusercontent.com/tracker")]');
		foreach($imgNodes as $imgNode) {
			$imgNode->parentNode->removeChild($imgNode);
		}

	}

	public function addStructuredPerson($wpUserObj) {

		$newPerson = $this->newStructuredPerson($wpUserObj);
		if($newPerson) {
			$this->structuredPersonList->appendChild($newPerson);
		}

	}

	public function newStructuredPerson($wpUserObj) {

		$id = $wpUserObj->user_login;

		if( array_key_exists($id, $this->knownPersons)) {
			$this->knownPersons[$id] = $this->knownPersons[$id] + 1;

			//since the node is added to the TEI at 1st occurance, update the node already in the TEI
			$personCountNode = $this->xpath->query("//tei:person[@xml:id = '$id']/tei:persName/tei:num")->item(0);
			$personCountNode->nodeValue = $this->knownPersons[$id];
			return false;
		}
		$this->knownPersons[$id] = 1;

		$person = $this->dom->createElementNS(TEI, 'person');
		$person->setAttribute('xml:id', $id );
		$persName = $this->dom->createElementNS(TEI, 'persName');
		$name = $this->dom->createElementNS(TEI, 'name');
		$name->appendChild($this->sanitizeString($wpUserObj->display_name));
		$firstname = $this->dom->createElementNS(TEI, 'forename');
		$firstname->appendChild($this->sanitizeString($wpUserObj->first_name));
		$surname = $this->dom->createElementNS(TEI, 'surname');
		$surname->appendChild($this->sanitizeString($wpUserObj->last_name));
		$count = $this->dom->createElementNS(TEI, 'num');
		$count->setAttribute('type', 'count');
		$count->appendChild($this->dom->createTextNode('1'));


		$desc = $this->dom->createElementNS(TEI, 'note');
		$desc->setAttribute('type', 'description');
		$desc->appendChild($this->sanitizeString($wpUserObj->description, true));

		$email = $this->dom->createElementNS(TEI, 'email');
		$email->appendChild($this->sanitizeString($wpUserObj->user_email));

		$grav_url = "http://www.gravatar.com/avatar/" . md5( strtolower( trim( $wpUserObj->user_email ) ) ) ;

		//building it myself rather using WP's function so I build a node in the right document
		$grav = $this->dom->createElementNS(HTML, 'img');
		$src = $grav->setAttribute('src', $grav_url);

		//adding the nodes to the TEI as I build them because otherwise funky and wrong xmlns:defaults are added

		$figure = $this->dom->createElementNS(TEI, 'figure');
		$person->appendChild($figure);
		$graphic = $this->dom->createElementNS(TEI, 'graphic');
		$graphic->setAttribute('type', 'gravatar');
		$graphic->setAttribute('url', $grav_url);
		$figure->appendChild($graphic);
		$graphic->appendChild($grav);

		$persName->appendChild($name);
		$persName->appendChild($firstname);
		$persName->appendChild($surname);
		$persName->appendChild($firstname);
		$persName->appendChild($email);
		$persName->appendChild($count);

		$person->appendChild($persName);

		$person->appendChild($desc);
		return $person;

	}

	public function newAuthor($userData, $role='') {

		$author = $this->dom->createElementNS(TEI, 'author');
		$author->setAttribute('role', $role);

		if(is_string($userData)) {
			$displayNameSpan = $this->sanitizeString($userData);
		} else {
			$author->setAttribute('ref', $userData->user_login);
			$displayNameSpan = $this->sanitizeString($userData->display_name);
		}
		$author->appendChild($displayNameSpan);
		return $author;
	}

	public function newSubjectStructuredItem($subject) {

		//if a tag and category have same slug, differentiate in id
		$id = $subject->taxonomy . '-' . $subject->slug;
		if( array_key_exists($id, $this->knownSubjects) ) {
			$this->knownSubjects[$id] = $this->knownSubjects[$id] + 1;
			$subjectCountNode = $this->xpath->query("//tei:item[@xml:id = '$id']/tei:num")->item(0);
			$subjectCountNode->nodeValue = $this->knownSubjects[$id];
			return false;
		}
		$this->knownSubjects[$id] = 1;
		$item = $this->dom->createElementNS(TEI, 'item');
		$item->setAttribute('xml:id', $id );
		$item->setAttribute('type', $subject->taxonomy);

		switch ($subject->taxonomy) {

			case 'post_tag':
				$subject->guid = get_tag_link($subject->term_id);
				$subject->taxonomy = "tag";
			break;

			case 'category':
				$subject->guid = get_category_link($subject->term_id);
			break;
		}


		$ident = $this->dom->createElementNS(TEI, 'ident');
		$ident->setAttribute('type', 'guid');
		$ident->appendChild($this->dom->createCDATASection($subject->guid));

		$desc = $this->dom->createElementNS(TEI, 'desc');
		$desc->appendChild($this->sanitizeString($subject->description, true));

		$num = $this->dom->createElementNS(TEI, 'num');
		$num->setAttribute('type', 'count');
		$num->appendChild($this->dom->createTextNode('1'));

		$item->appendChild($ident);
		$item->appendChild($desc);
		$item->appendChild($num);
		$item->appendChild($this->sanitizeString($subject->name));

		return $item;
	}

	public function newSubjectRefString($subject) {
		$rs = $this->dom->createElementNS(TEI, 'rs');
		$rs->setAttribute('ref', $subject->taxonomy . '-' . $subject->slug);
		$rs->setAttribute('type', $subject->taxonomy);
		$rs->appendChild($this->sanitizeString($subject->name));
		return $rs;
	}

	public function newNote($commentObj) {
		$note = $this->dom->createElementNS(TEI, 'note');
		$bibl = $this->dom->createElementNS(TEI, 'bibl');
		$note->appendChild($bibl);
		//TODO: figure out commenter data structures
		$commenterObj = new StdClass();
		$bibl->appendChild($this->newCommenter($commenterObj));
		$note->appendChild($this->sanitizeString($commentObj->comment_content, true));
	}


	public function addStructuredSubjects($postID) {

		$subjects = $this->fetchPostSubjects($postID);
		foreach($subjects as $subject) {
			$newSubject = $this->newSubjectStructuredItem($subject);
			if($newSubject) {
				$this->structuredSubjectList->appendChild($newSubject);
			}
		}
	}

	public function addItemSubjects($postID, $node) {
		$subjects = $this->fetchPostSubjects($postID);
		$list = $this->dom->createElementNS(TEI, 'list');
		$list->setAttribute('type', 'subjects');
		foreach($subjects as $subject) {
			$item = $this->dom->createElementNS(TEI, 'item');
			$item->appendChild($this->newSubjectRefString($subject));
			$list->appendChild($item);
		}
		$node->appendChild($list);
	}

	public function fetchPostSubjects($postID) {
		$subjects = wp_get_post_tags($postID);
		$catIds = wp_get_post_categories($postID);

		foreach($catIds as $catId) {
			$cat = get_category($catId);
			//category and term data structures don't align, so duplicate category data so I can use same code later
			$cat->description = $cat->category_description;
			$subjects[] = $cat;
		}

		return $subjects;
	}

	public function sanitizeEmbeds() {
		$objects = $this->xpath->query("//object");

		foreach($objects as $object) {
			$link = $this->xpath->evaluate("embed/@src", $object)->item(0)->nodeValue;
			$aNode = $this->dom->createElement('a', "[Link to embedded object]");
			$aNode->setAttribute('href', $link);
			$object->parentNode->replaceChild($aNode, $object);
		}
	}


	public function newPart($partObject) {
		$newPart = $this->dom->createElementNS(TEI, 'div');
		$newPart->setAttribute('type', 'part');
		$newPart->appendChild($this->newHead($partObject));
		return $newPart;
	}

	public function newItem($libraryItemObject) {

		$newItem = $this->dom->createElementNS(TEI, 'div');
		$newItem->setAttribute('type', 'libraryItem');
		$newItem->setAttribute('subtype', 'html');
		$newItem->appendChild($this->newHead($libraryItemObject));

		/*
		 *
		 * planning ahead toward revised tei to include comments
		$div = $this->dom->createElementNS(TEI, 'div');
		$div->setAttribute('type', 'itemContent');
		*/

		$content = $libraryItemObject->post_content;

		$contentImport = $this->sanitizeString($content, true);
		$newItem->appendChild($contentImport);

		if($this->includeComments) {
			$commentsDiv = $this->dom->createElementNS(TEI, 'div');
			$commentsDiv->setAttribute('type', 'comments');
			$comments = array(); //for me and boone to figure out
			foreach($comments as $comment) {
				$commentsDiv->appendChild($this->newNote($comment));
			}
		}

		return $newItem;
	}

	public function newHead($postObject) {

		$newHead = $this->dom->createElementNS(TEI, 'head');
		$title = $this->dom->createElementNS(TEI, 'title');
		$title->appendChild($this->sanitizeString($postObject->post_title));

		$guid = $this->dom->createElementNS(TEI, 'ident');
		$guid->appendChild($this->dom->createCDataSection($postObject->guid));
		$guid->setAttribute('type', 'guid');
		$newHead->appendChild($title);
		$newHead->appendChild($guid);

		//TODO: check if content is native, based on the GUID. if content native, dig up author info
		//from userID. Otherwise/and, go with info from boones
		// $author_name = get_post_meta( $item_id, 'author_name', true );

		//TODO: above might be old. Check nativeness by looking at whether dissplay name is set for username

		switch($postObject->post_type) {
			case 'anth_part':

			break;

			case 'anth_library_item':
				//gets the wordpress author info
				$itemCreator = get_userdata($postObject->post_author);

				$bibl = $this->dom->createElementNS(TEI, 'bibl');
				$newHead->appendChild($bibl);
				if($itemCreator) {
					$bibl->appendChild($this->newAuthor($itemCreator, 'anthologizer') );
					if($this->includeStructuredCreatorData) {
						$this->addStructuredPerson($itemCreator);
					}
				}

				//work with the anthologize data
				$meta = get_post_meta($postObject->ID, 'anthologize_meta', true );

				if($meta && isset($meta['author_name'])) {
						$authorName = $meta['author_name'];
						$bibl->appendChild($this->newAuthor($authorName, 'assertedAuthor') );
				}

				if($this->includeOriginalPostData) {
					//TODO: include date created and modified data
					$origPostData = get_post($postObject->original_post_id);
					$permalinkURL = get_permalink($postObject->original_post_id);

					$permalink = $this->dom->createElementNS(TEI, 'ident');
					$permalink->setAttribute('type', 'permalink');
					$permalink->appendChild($this->dom->createCDataSection($permalinkURL));
					$newHead->appendChild($permalink);

					$origGuid = $this->dom->createElementNS(TEI, 'ident');
					$origGuid->appendChild($this->dom->createCDataSection($origPostData->guid));
					$origGuid->setAttribute('type', 'origGuid');
					$newHead->appendChild($origGuid);

					$origCreator = get_userdata($origPostData->post_author);
					$bibl->appendChild($this->newAuthor($origCreator, 'originalAuthor') );
					if($this->includeStructuredCreatorData) {
						$this->addStructuredPerson($origCreator);
					}
				}

				if($this->includeItemSubjects) {
					$this->addItemSubjects($postObject->original_post_id, $newHead);
				}


			break;
		}

		return $newHead;
	}

	public function sanitizeString($content, $isMultiline = false) {

		$content = $this->sanitizeEntities($content);

		if ($isMultiline) {
			//TODO: check if this is redundant now that I'm using apply_filters()'
			//$content = wpautop($content);
			//$content = $this->sanitizeShortCodes($content);

			$content = apply_filters('the_content', $content);
			if($this->tidy) {
				$this->tidy->parseString($content, array(), 'utf8');
				$this->tidy->cleanRepair();

				//Tidy makes a full html document, with head section, so get just the body
				//then strip out the body tag
				$content = tidy_get_body( $this->tidy );
				$content = rtrim($content, '</body>');
				$content = ltrim($content, '<body>');
			}
			$element = "div";

		} else {
			$element = "span";
		}
		$content = trim($content);

		//using loadHTML because it is more forgiving than loadXML
		$tmpHTML = new DOMDocument('1.0', 'UTF-8');
		//conceal the Warning about bad html with @
		//loadHTML adds head and body tags silently
		@$tmpHTML->loadHTML("<?xml version='1.0' encoding='UTF-8' ?><$element xmlns='http://www.w3.org/1999/xhtml'>$content</$element>" );
		if($this->checkImgSrcs) {
			$this->checkImageSources($tmpHTML);
		}
		$contentDiv = $tmpHTML->getElementsByTagName($element)->item(0);
		$imported = $this->dom->importNode($contentDiv, true);
		return $imported;
	}


	public function sanitizeShortCodes($content) {

		if($this->doShortcodes) {
			$content = do_shortcode($content);
		    $pattern = get_shortcode_regex();

			return preg_replace_callback('/'.$pattern.'/s', array('TeiDom', 'sanitizeShortCode'), $content);
		} else {
			return strip_shortcodes($content);
		}

	}

	public function sanitizeEntities($content) {
		//TODO: sort out the best order to convert characters and sanitizing stuff.

		return str_replace("&nbsp;", " ", $content);
	}

	public function sanitizeShortCode($m) {
		//modified from WP do_shortcode_tag() wp_includes/shortcodes.php

		$tag = $m[2];
		$html = "<span class='anthologize-shortcode'>***";
		$html .= "Anthologize warning: This section contains a WordPress 'shortcode', which can result in errors in some output formats.";
		$html .= "The shortcode [$tag] has been removed to prevent such errors. You can rectify this by editing the library item in the HTML view, ";
		$html .= "look for the [$tag] in the HTML, and replacing it with the proper HTML. You can find the proper HTML by viewing the item in your browser, ";
		$html .= "and viewing the source. More help will be posted to the Anthologize forums in the future.";
		$html .= "***</span>";
		return $html;
	}

	public function checkImageSources($tmpHTML) {
		//TODO: check for net connectivity
		//TODO: improve pseudo-error message and feedback
		$xpath = new DOMXPath($tmpHTML);
		$srcs = $xpath->evaluate("//img/@src");
		foreach($srcs as $srcNode) {

			$imgNode = $srcNode->parentNode;
			$src = $srcNode->nodeValue;
			$ch = curl_init();
			curl_setopt($ch, CURLOPT_URL, $src);
			curl_setopt($ch, CURLOPT_NOBODY, true);
			curl_exec($ch);
			$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
			curl_close($ch);
			if($code != 200) {
				$noImgSpan = $tmpHTML->createElement('span', 'Image not found');
				$noImgSpan->setAttribute('class', 'anthologize-error');
				$imgNode->parentNode->replaceChild($noImgSpan, $imgNode);
			}
		}
	}

	public function getID($node) {
		//if its in the HTML, check if it already has an id

		if($node->hasAttribute('id')) {
			return $node->getAttribute('id');
		}
		if($node->hasAttribute('xml:id')) {
			return $node->getAttribute('xml:id');
		}
		$parentItem = $this->getParentItem($node);
		$itemId = $parentItem->getAttribute('xml:id');
		$nameMatches = $parentItem->getElementsByTagname($node->nodeName);
		$index = 0;
		foreach($nameMatches as $nameMatch) {
			if ($node === $nameMatch) {
				$id =  $itemId . "-$node->nodeName-$index";
				$node->setAttribute('xml:id', $id);
				return $id;
			}
			$index ++;
		}
	}

	public function newColophon() {

		$colophonNode = $this->dom->createElementNS(TEI, 'div');
		$colophonNode->setAttribute('xml:id', 'colophon');
		$colophonNode->setAttribute('n', '0');
		$colophonNode->setAttribute('type', 'colophon');

		$day   = date(jS);
		$month = date(F);
	 	$year  = date(Y);
		$date  = "the " . $day . " of " . $month . ", " . $year;

		$logo  = WP_PLUGIN_URL . '/anthologize/images/anthologize-logo.gif';

		$horace_quote = "Omne tulit punctum qui miscuit utile dulci -- Horace";

		$colophon = "<div style=\"text-align: center;\"><em>This Document was Generated on<br/>" . $date . "<br/>using<br/><br/><a href=\"http://www.anthologize.org/\"><img src=\"" . $logo . "\"\></a></em><br/><br/>" . $horace_quote . "</div>";

		$colophonNode->appendChild( $this->sanitizeString($colophon, true) );
		return $colophonNode;
	}

	public function doIndexing() {
		if($this->indexSubjects) {
			$this->backNode->appendChild($this->indexSubjects());
		}

		if($this->indexCategories) {
			$this->backNode->appendChild($this->indexCategories());
		}

		if($this->indexTags) {
			$this->backNode->appendChild($this->indexTags());
		}

		if($this->indexPeople) {
			$this->backNode->appendChild($this->indexPersons());
		}

		if($this->indexImages) {
			$this->backNode->appendChild($this->indexImages());
		}
	}

	public function newIndex($type, $ops = false) {
		$indexDiv = $this->dom->createElementNS(TEI, 'div');
		$indexDiv->setAttribute('type', 'index');
		$indexDiv->setAttribute('subtype', $type);
		$indexCount = $this->xpath->evaluate("count(//tei:div[@type='index'])");
		$indexDiv->setAttribute('n', $indexCount);
		return $indexDiv;

	}

	public function newIndexListItem($data) {

		$item = $this->dom->createElement('item');


		//$targetNodes is poorly named. the name makes sense for the actual index targets, but not so much for other $types
		foreach($data as $type=>$targetNodes) {

			switch ($type) {

				case 'node':
				case 'ref':
					continue;
				break;

				case 'label':
					$labelNode = $targetNodes; //really just the one node, and not really a target per se

					$teiRSNode = $this->dom->createElement('rs');
					if($data['ref'] != '') {
						$teiRSNode->setAttribute('ref', $data['ref']);
					}
					$item->appendChild($teiRSNode);
					$teiRSNode->appendChild($labelNode);
				break;



				//default goes throught whatever arbitrary index types are passed along
				default:
					$listRef = $this->dom->createElement('listRef');
					$item->appendChild($listRef);
					$listRef->setAttribute('type', $type);
					$n=0;
					foreach($targetNodes as $targetNodeData) {
						$targetNode = $this->getNodeTargetData($targetNodeData['target']);
						$rs = $this->dom->createElement('rs');
						$rs->setAttribute('n', $n);
						$listRef->appendChild($rs);
						if($targetNodeData['role'] != '') {
							$rs->setAttribute('role', $targetNodeData['role']);
						}
						$rs->setAttribute('ref', $targetNode['id']);
						$rs->appendChild($this->sanitizeString($targetNode['title']));
						$n++;
					}

				break;
			}

		}

		return $item;
	}

	public function indexNodeList($nodes, $targetTypes) {
		$nodesArray = array();

		foreach($nodes as $node) {
			$nodeClone = $node->cloneNode(true);
			$key = $this->getNodeKeyForIndex($node);
			$labelNode = $this->getNodeLabelForIndex($node);
			$role = $node->getAttribute('role');
			foreach($targetTypes as $targetType) {
				switch($targetType) {
					case 'items':
						$target = $this->getParentItem($node);
					break;

					case 'direct':
						$target = $node;
					break;
				}

				if(array_key_exists($key, $nodesArray)) {
					$nodesArray[$key][$targetType][] = array('target'=>$target, 'role'=>$role );
				} else {
					$ref = $node->getAttribute('ref');

					$nodesArray[$key] = array(
						'label'=>$labelNode,
						'ref'=>$ref,
						'node'=>$nodeClone,
						$targetType=>array( array('target'=>$target, 'role'=>$role)) );
				}
			}

		}


		ksort($nodesArray, SORT_STRING);
		$list = $this->dom->createElement('list');


		$n=0;
		foreach($nodesArray as $key=>$data) {
			$newItem = $this->newIndexListItem($data);
			$newItem->setAttribute('n', $n);
			$list->appendChild($newItem);
			$n++;
		}

		return $list;
	}

	public function indexPersons() {
		$nodes = $this->xpath->query("//tei:body//tei:author");
		$list = $this->indexNodeList($nodes, array('items'));
		$index = $this->newIndex('persons');
		$index->appendChild($list);
		return $index;
	}

	public function indexCategories() {
		$nodes = $this->xpath->query("//tei:list[@type='subjects']/tei:item/tei:rs[@type='category']/span");
		$list = $this->indexNodeList($nodes, array('items'));
		$index = $this->newIndex('categories');
		$index->appendChild($list);
		return $index;
	}

	public function indexTags() {
		$nodes = $this->xpath->query("//tei:list[@type='subjects']/tei:item/tei:rs[@type='tag']/span");
		$list = $this->indexNodeList($nodes, array('items'));
		$index = $this->newIndex('tags');
		$index->appendChild($list);
		return $index;
	}

	public function indexSubjects() {
		$nodes = $this->xpath->query("//tei:list[@type='subjects']/tei:item/tei:rs/span");
		$list = $this->indexNodeList($nodes, array('items'));
		$index = $this->newIndex('subjects');
		$index->appendChild($list);
		return $index;
	}

	public function indexImages() {
		$nodes = $this->xpath->query("//tei:body//img");
		$list = $this->indexNodeList($nodes, array('items', 'direct') );
		$index = $this->newIndex('images');
		$index->appendChild($list);
		return $index;
	}




	public function getFileName($sessionArray) {

        $text = strtolower($sessionArray['post-title']);
        $fileName = preg_replace('/\s/', "_", $text);
        $fileName = mb_ereg_replace('/[^\w\-]/', '', $fileName);
        $fileName = trim($fileName, "_");
        $fileName = rtrim($fileName, ".");

        return $fileName;
	}

	public function getNodeTargetData($node) {
		//get id and a label/title

		//make sure that HTML targets have an ID
		$id = $this->getID($node);

		//TODO: switch approach to finding labels based on node type
		$titleNodes = $this->xpath->query("tei:head/tei:title", $node);
		if($titleNodes->length == 0) {
			$title = $node->nodeName;
		} else {
			$title = $titleNodes->item(0)->firstChild->nodeValue;
		}

		return array('id'=>$id, 'title'=>$title);
	}

	public function getParentItem($node) {
		while( $node->getAttribute('type') != 'libraryItem') {
			$node = $node->parentNode;
		}
		return $node;
	}

	public function getNodeLabelForIndex($node) {

		if ($node->firstChild->nodeName == 'span') {
			return $node->firstChild->cloneNode(true);
		}

		return $node->cloneNode(true);

	}

	public function getNodeKeyForIndex($node, $keyBy = false) {

		switch($node->nodeName) {
			case 'img':
				$keyBy = 'titleAtt';
			break;
		}

		switch ($keyBy) {
			case 'titleAtt':
				return $node->getAttribute('title');
			break;


			default:
				return strtolower($node->firstChild->nodeValue);
			break;
		}


	}

	public function getTeiString() {
		return $this->dom->saveXML();
	}

	public function getTeiDom() {
		return $this->dom;
	}
}