friendica-github/src/Object/Thread.php

220 lines
4.7 KiB
PHP
Raw Normal View History

2012-08-10 15:46:39 +00:00
<?php
/**
* @file src/Object/Thread.php
*/
namespace Friendica\Object;
use Friendica\BaseObject;
2018-10-29 21:20:46 +00:00
use Friendica\Core\Logger;
use Friendica\Core\Protocol;
use Friendica\Protocol\Activity;
use Friendica\Util\Security;
2012-08-10 15:46:39 +00:00
/**
* A list of threads
*
* We should think about making this a SPL Iterator
*/
class Thread extends BaseObject
{
private $parents = [];
2012-08-10 17:57:39 +00:00
private $mode = null;
2012-08-17 14:40:41 +00:00
private $writable = false;
2012-08-11 16:12:35 +00:00
private $profile_owner = 0;
private $preview = false;
2012-08-10 17:57:39 +00:00
/**
* Constructor
*
2019-01-06 21:06:53 +00:00
* @param string $mode The mode
* @param boolean $preview Are we in the preview mode?
2017-12-20 10:34:42 +00:00
* @param boolean $writable Override the writable check
2019-01-06 21:06:53 +00:00
* @throws \Exception
*/
public function __construct($mode, $preview, $writable = false)
{
$this->setMode($mode, $writable);
$this->preview = $preview;
2012-08-11 16:12:35 +00:00
}
/**
* Set the mode we'll be displayed on
*
2019-01-06 21:06:53 +00:00
* @param string $mode The mode to set
2017-12-20 10:34:42 +00:00
* @param boolean $writable Override the writable check
*
* @return void
2019-01-06 21:06:53 +00:00
* @throws \Exception
2012-08-11 16:12:35 +00:00
*/
private function setMode($mode, $writable)
{
if ($this->getMode() == $mode) {
2012-08-11 16:12:35 +00:00
return;
}
2012-08-11 16:12:35 +00:00
$a = self::getApp();
2012-08-11 16:12:35 +00:00
switch ($mode) {
2012-08-11 16:12:35 +00:00
case 'network':
case 'notes':
$this->profile_owner = local_user();
2012-08-17 14:40:41 +00:00
$this->writable = true;
2012-08-11 16:12:35 +00:00
break;
case 'profile':
$this->profile_owner = $a->profile['profile_uid'];
$this->writable = Security::canWriteToUserWall($this->profile_owner);
2012-08-11 16:12:35 +00:00
break;
case 'display':
$this->profile_owner = $a->profile['uid'];
$this->writable = Security::canWriteToUserWall($this->profile_owner) || $writable;
2012-08-11 16:12:35 +00:00
break;
case 'community':
$this->profile_owner = 0;
$this->writable = $writable;
break;
case 'contacts':
$this->profile_owner = 0;
$this->writable = $writable;
break;
2012-08-11 16:12:35 +00:00
default:
Logger::log('[ERROR] Conversation::setMode : Unhandled mode ('. $mode .').', Logger::DEBUG);
2012-08-11 16:12:35 +00:00
return false;
break;
}
2012-08-12 13:39:21 +00:00
$this->mode = $mode;
2012-08-11 16:12:35 +00:00
}
/**
* Get mode
*
* @return string
2012-08-11 16:12:35 +00:00
*/
public function getMode()
{
2012-08-11 16:12:35 +00:00
return $this->mode;
}
/**
2012-08-17 14:40:41 +00:00
* Check if page is writable
*
* @return boolean
2012-08-11 16:12:35 +00:00
*/
public function isWritable()
{
2012-08-17 14:40:41 +00:00
return $this->writable;
2012-08-11 16:12:35 +00:00
}
/**
* Check if page is a preview
*
* @return boolean
*/
public function isPreview()
{
return $this->preview;
}
2012-08-11 16:12:35 +00:00
/**
* Get profile owner
*
* @return integer
2012-08-11 16:12:35 +00:00
*/
public function getProfileOwner()
{
2012-08-11 16:12:35 +00:00
return $this->profile_owner;
2012-08-10 17:57:39 +00:00
}
2012-08-10 15:46:39 +00:00
/**
* Add a thread to the conversation
*
2019-01-06 21:06:53 +00:00
* @param Post $item The item to insert
*
* @return mixed The inserted item on success
* false on failure
2019-01-06 21:06:53 +00:00
* @throws \Exception
2012-08-10 15:46:39 +00:00
*/
public function addParent(Post $item)
{
$item_id = $item->getId();
if (!$item_id) {
Logger::log('[ERROR] Conversation::addThread : Item has no ID!!', Logger::DEBUG);
2012-08-10 15:46:39 +00:00
return false;
}
if ($this->getParent($item->getId())) {
Logger::log('[WARN] Conversation::addThread : Thread already exists ('. $item->getId() .').', Logger::DEBUG);
2012-08-10 15:46:39 +00:00
return false;
}
/*
* Only add will be displayed
*/
if ($item->getDataValue('network') === Protocol::MAIL && local_user() != $item->getDataValue('uid')) {
Logger::log('[WARN] Conversation::addThread : Thread is a mail ('. $item->getId() .').', Logger::DEBUG);
return false;
}
if ($item->getDataValue('verb') === Activity::LIKE || $item->getDataValue('verb') === Activity::DISLIKE) {
Logger::log('[WARN] Conversation::addThread : Thread is a (dis)like ('. $item->getId() .').', Logger::DEBUG);
return false;
}
$item->setThread($this);
$this->parents[] = $item;
return end($this->parents);
2012-08-10 15:46:39 +00:00
}
/**
* 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)
*
2019-01-21 16:36:01 +00:00
* @param array $conv_responses data
*
* @return mixed The data requested on success
* false on failure
2019-01-06 21:06:53 +00:00
* @throws \Exception
2012-08-10 15:46:39 +00:00
*/
public function getTemplateData($conv_responses)
{
$result = [];
foreach ($this->parents as $item) {
if ($item->getDataValue('network') === Protocol::MAIL && local_user() != $item->getDataValue('uid')) {
2012-08-10 17:57:39 +00:00
continue;
}
$item_data = $item->getTemplateData($conv_responses);
if (!$item_data) {
Logger::log('[ERROR] Conversation::getTemplateData : Failed to get item template data ('. $item->getId() .').', Logger::DEBUG);
2012-08-10 15:46:39 +00:00
return false;
}
$result[] = $item_data;
}
return $result;
}
/**
* Get a thread based on its item id
*
* @param integer $id Item id
*
* @return mixed The found item on success
* false on failure
2012-08-10 15:46:39 +00:00
*/
private function getParent($id)
{
foreach ($this->parents as $item) {
if ($item->getId() == $id) {
2012-08-10 17:57:39 +00:00
return $item;
}
2012-08-10 15:46:39 +00:00
}
2012-08-10 17:57:39 +00:00
return false;
2012-08-10 15:46:39 +00:00
}
}