friendica/object/Conversation.php

<?php
if(class_exists('Conversation'))
	return;

require_once('object/Item.php');
require_once('include/text.php');

/**
 * A list of threads
 *
 * We should think about making this a SPL Iterator
 */
class Conversation {
	private $threads = array();

	/**
	 * Add a thread to the conversation
	 *
	 * Returns:
	 * 		_ The inserted item on success
	 * 		_ false on failure
	 */
	public function add_thread($item) {
		$item_id = $item->get_id();
		if(!$item_id) {
			logger('[ERROR] Conversation::add_thread : Item has no ID!!', LOGGER_DEBUG);
			return false;
		}
		if($this->get_thread($item->get_id())) {
			logger('[WARN] Conversation::add_thread : Thread already exists ('. $item->get_id() .').', LOGGER_DEBUG);
			return false;
		}
		$this->threads[] = $item;
		return end($this->threads);
	}

	/**
	 * Get data in a form usable by a conversation template
	 *
	 * We should find a way to avoid using those arguments (at least most of them)
	 *
	 * Returns:
	 * 		_ The data requested on success
	 * 		_ false on failure
	 */
	public function get_template_data($a, $cmnt_tpl, $page_writeable, $mode, $profile_owner) {
		$result = array();

		/*foreach($this->threads as $item) {
			$item_data = $item->get_template_data();
			if(!$item_data) {
				logger('[ERROR] Conversation::get_template_data : Failed to get item template data ('. $item->get_id() .').', LOGGER_DEBUG);
				return false;
			}
			$result[] = $item_data;
		}*/

		/*
		 * This should be moved on the item object;
		 */
		$threads = array();
		foreach($this->threads as $item) {
			$threads[] = $item->get_data();
		}
		return $this->prepare_threads_body($a, $threads, $cmnt_tpl, $page_writeable, $mode, $profile_owner);

		return $result;
	}

	/**
	 * Get a thread based on its item id
	 *
	 * Returns:
	 * 		_ The found item on success
	 * 		_ false on failure
	 */
	private function get_thread($id) {
	foreach($this->threads as $item) {
		if($item->get_id() == $id)
			return $item;
	}

	return false;
	}

	/**
	 * Recursively prepare a thread for HTML
	 */

	private function prepare_threads_body($a, $items, $cmnt_tpl, $page_writeable, $mode, $profile_owner, $thread_level=1) {
		$result = array();

		$wall_template = 'wall_thread.tpl';
		$wallwall_template = 'wallwall_thread.tpl';
		$items_seen = 0;
		$nb_items = count($items);
		
		$total_children = $nb_items;
		
		foreach($items as $item) {
			// prevent private email reply to public conversation from leaking.
			if($item['network'] === NETWORK_MAIL && local_user() != $item['uid']) {
				// Don't count it as a visible item
				$nb_items--;
				continue;
			}
			
			$items_seen++;
			
			$alike = array();
			$dlike = array();
			$comment = '';
			$template = $wall_template;
			$commentww = '';
			$sparkle = '';
			$owner_url = $owner_photo = $owner_name = '';
			$buttons = '';
			$dropping = false;
			$star = false;
			$isstarred = "unstarred";
			$photo = $item['photo'];
			$thumb = $item['thumb'];
			$indent = '';
			$osparkle = '';
			$lastcollapsed = false;
			$firstcollapsed = false;
			$total_children += count_descendants($item);

			$toplevelpost = (($item['id'] == $item['parent']) ? true : false);
			$item_writeable = (($item['writable'] || $item['self']) ? true : false);
			$show_comment_box = ((($page_writeable) && ($item_writeable)) ? true : false);
			$lock = ((($item['private'] == 1) || (($item['uid'] == local_user()) && (strlen($item['allow_cid']) || strlen($item['allow_gid']) 
				|| strlen($item['deny_cid']) || strlen($item['deny_gid']))))
				? t('Private Message')
				: false);
			$redirect_url = $a->get_baseurl($ssl_state) . '/redir/' . $item['cid'] ;
			$shareable = ((($profile_owner == local_user()) && ($item['private'] != 1)) ? true : false);
			if(local_user() && link_compare($a->contact['url'],$item['author-link']))
				$edpost = array($a->get_baseurl($ssl_state)."/editpost/".$item['id'], t("Edit"));
			else
				$edpost = false;
			if((intval($item['contact-id']) && $item['contact-id'] == remote_user()) || ($item['uid'] == local_user()))
				$dropping = true;

			$drop = array(
				'dropping' => $dropping,
				'select' => t('Select'), 
				'delete' => t('Delete'),
			);
			
			$filer = (($profile_owner == local_user()) ? t("save to folder") : false);

			$diff_author    = ((link_compare($item['url'],$item['author-link'])) ? false : true);
			$profile_name   = (((strlen($item['author-name']))   && $diff_author) ? $item['author-name']   : $item['name']);
			if($item['author-link'] && (! $item['author-name']))
				$profile_name = $item['author-link'];

			$sp = false;
			$profile_link = best_link_url($item,$sp);
			if($profile_link === 'mailbox')
				$profile_link = '';
			if($sp)
				$sparkle = ' sparkle';
			else
				$profile_link = zrl($profile_link);					

			$normalised = normalise_link((strlen($item['author-link'])) ? $item['author-link'] : $item['url']);
			if(($normalised != 'mailbox') && (x($a->contacts,$normalised)))
				$profile_avatar = $a->contacts[$normalised]['thumb'];
			else
				$profile_avatar = (((strlen($item['author-avatar'])) && $diff_author) ? $item['author-avatar'] : $a->get_cached_avatar_image($thumb));

			$locate = array('location' => $item['location'], 'coord' => $item['coord'], 'html' => '');
			call_hooks('render_location',$locate);
			$location = ((strlen($locate['html'])) ? $locate['html'] : render_location_google($locate));

			$tags=array();
			foreach(explode(',',$item['tag']) as $tag){
				$tag = trim($tag);
				if ($tag!="") $tags[] = bbcode($tag);
			}
			
			like_puller($a,$item,$alike,'like');
			like_puller($a,$item,$dlike,'dislike');

			$like    = ((x($alike,$item['uri'])) ? format_like($alike[$item['uri']],$alike[$item['uri'] . '-l'],'like',$item['uri']) : '');
			$dislike = ((x($dlike,$item['uri'])) ? format_like($dlike[$item['uri']],$dlike[$item['uri'] . '-l'],'dislike',$item['uri']) : '');

			if($toplevelpost) {
				if((! $item['self']) && ($mode !== 'profile')) {
					if($item['wall']) {

						// On the network page, I am the owner. On the display page it will be the profile owner.
						// This will have been stored in $a->page_contact by our calling page.
						// Put this person as the wall owner of the wall-to-wall notice.

						$owner_url = zrl($a->page_contact['url']);
						$owner_photo = $a->page_contact['thumb'];
						$owner_name = $a->page_contact['name'];
						$template = $wallwall_template;
						$commentww = 'ww';	
					}
				}
				else if($item['owner-link']) {

					$owner_linkmatch = (($item['owner-link']) && link_compare($item['owner-link'],$item['author-link']));
					$alias_linkmatch = (($item['alias']) && link_compare($item['alias'],$item['author-link']));
					$owner_namematch = (($item['owner-name']) && $item['owner-name'] == $item['author-name']);
					if((! $owner_linkmatch) && (! $alias_linkmatch) && (! $owner_namematch)) {

						// The author url doesn't match the owner (typically the contact)
						// and also doesn't match the contact alias. 
						// The name match is a hack to catch several weird cases where URLs are 
						// all over the park. It can be tricked, but this prevents you from
						// seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
						// well that it's the same Bob Smith. 

						// But it could be somebody else with the same name. It just isn't highly likely. 
						

						$owner_url = $item['owner-link'];
						$owner_photo = $item['owner-avatar'];
						$owner_name = $item['owner-name'];
						$template = $wallwall_template;
						$commentww = 'ww';
						// If it is our contact, use a friendly redirect link
						if((link_compare($item['owner-link'],$item['url'])) 
							&& ($item['network'] === NETWORK_DFRN)) {
							$owner_url = $redirect_url;
							$osparkle = ' sparkle';
						}
						else
							$owner_url = zrl($owner_url);
					}
				}
				if($profile_owner == local_user()) {
					$isstarred = (($item['starred']) ? "starred" : "unstarred");

					$star = array(
						'do' => t("add star"),
						'undo' => t("remove star"),
						'toggle' => t("toggle star status"),
						'classdo' => (($item['starred']) ? "hidden" : ""),
						'classundo' => (($item['starred']) ? "" : "hidden"),
						'starred' =>  t('starred'),
						'tagger' => t("add tag"),
						'classtagger' => "",
					);
				}
			} else {
				$indent = 'comment';
				// Collapse comments
				if(($nb_items > 2) || ($thread_level > 2)) {
					if($items_seen == 1) {
						$firstcollapsed = true;
					}
					if($thread_level > 2) {
						if($items_seen == $nb_items)
							$lastcollapsed = true;
					}
					else if($items_seen == ($nb_items - 2)) {
						$lastcollapsed = true;
					}
				}
			}

			if($page_writeable) {
				$buttons = array(
					'like' => array( t("I like this \x28toggle\x29"), t("like")),
					'dislike' => array( t("I don't like this \x28toggle\x29"), t("dislike")),
				);
				if ($shareable) $buttons['share'] = array( t('Share this'), t('share'));


				if($show_comment_box) {
					$qc = $qcomment =  null;

					if(in_array('qcomment',$a->plugins)) {
						$qc = ((local_user()) ? get_pconfig(local_user(),'qcomment','words') : null);
						$qcomment = (($qc) ? explode("\n",$qc) : null);
					}
					$comment = replace_macros($cmnt_tpl,array(
						'$return_path' => '', 
						'$jsreload' => (($mode === 'display') ? $_SESSION['return_url'] : ''),
						'$type' => (($mode === 'profile') ? 'wall-comment' : 'net-comment'),
						'$id' => $item['item_id'],
						'$parent' => $item['item_id'],
						'$qcomment' => $qcomment,
						'$profile_uid' =>  $profile_owner,
						'$mylink' => $a->contact['url'],
						'$mytitle' => t('This is you'),
						'$myphoto' => $a->contact['thumb'],
						'$comment' => t('Comment'),
						'$submit' => t('Submit'),
						'$edbold' => t('Bold'),
						'$editalic' => t('Italic'),
						'$eduline' => t('Underline'),
						'$edquote' => t('Quote'),
						'$edcode' => t('Code'),
						'$edimg' => t('Image'),
						'$edurl' => t('Link'),
						'$edvideo' => t('Video'),
						'$preview' => t('Preview'),
						'$sourceapp' => t($a->sourcename),
						'$ww' => (($mode === 'network') ? $commentww : '')
					));
				}
			}

			if(strcmp(datetime_convert('UTC','UTC',$item['created']),datetime_convert('UTC','UTC','now - 12 hours')) > 0)
				$indent .= ' shiny';

			localize_item($item);

			$body = prepare_body($item,true);

			$tmp_item = array(
				// collapse comments in template. I don't like this much...
				'comment_firstcollapsed' => $firstcollapsed,
				'comment_lastcollapsed' => $lastcollapsed,
				// template to use to render item (wall, walltowall, search)
				'template' => $template,
				
				'type' => implode("",array_slice(explode("/",$item['verb']),-1)),
				'tags' => $tags,
				'body' => template_escape($body),
				'text' => strip_tags(template_escape($body)),
				'id' => $item['item_id'],
				'linktitle' => sprintf( t('View %s\'s profile @ %s'), $profile_name, ((strlen($item['author-link'])) ? $item['author-link'] : $item['url'])),
				'olinktitle' => sprintf( t('View %s\'s profile @ %s'), $owner_name, ((strlen($item['owner-link'])) ? $item['owner-link'] : $item['url'])),
				'to' => t('to'),
				'wall' => t('Wall-to-Wall'),
				'vwall' => t('via Wall-To-Wall:'),
				'profile_url' => $profile_link,
				'item_photo_menu' => item_photo_menu($item),
				'name' => template_escape($profile_name),
				'thumb' => $profile_avatar,
				'osparkle' => $osparkle,
				'sparkle' => $sparkle,
				'title' => template_escape($item['title']),
				'ago' => (($item['app']) ? sprintf( t('%s from %s'),relative_date($item['created']),$item['app']) : relative_date($item['created'])),
				'lock' => $lock,
				'location' => template_escape($location),
				'indent' => $indent,
				'owner_url' => $owner_url,
				'owner_photo' => $owner_photo,
				'owner_name' => template_escape($owner_name),
				'plink' => get_plink($item),
				'edpost' => $edpost,
				'isstarred' => $isstarred,
				'star' => $star,
				'filer' => $filer,
				'drop' => $drop,
				'vote' => $buttons,
				'like' => $like,
				'dislike' => $dislike,
				'comment' => $comment,
				'previewing' => $previewing,
				'wait' => t('Please wait'),
			);

			$arr = array('item' => $item, 'output' => $tmp_item);
			call_hooks('display_item', $arr);

			$item_result = $arr['output'];
			if($firstcollapsed) {
				$item_result['num_comments'] = sprintf( tt('%d comment','%d comments',$total_children),$total_children );
				$item_result['hide_text'] = t('show more');
			}

			$item_result['children'] = array();
			if(count($item['children'])) {
				$item_result['children'] = prepare_threads_body($a, $item['children'], $cmnt_tpl, $page_writeable, $mode, $profile_owner, ($thread_level + 1));
			}
			$item_result['private'] = $item['private'];
			$item_result['toplevel'] = ($toplevelpost ? 'toplevel_item' : '');

			/*
			 * I don't like this very much...
			 */
			if(get_config('system','thread_allow')) {
				$item_result['flatten'] = false;
				$item_result['threaded'] = true;
			}
			else {
				$item_result['flatten'] = true;
				$item_result['threaded'] = false;
				if(!$toplevelpost) {
					$item_result['comment'] = false;
				}
			}
			
			$result[] = $item_result;
		}

		return $result;
	}
}
?>