]> git.mxchange.org Git - friendica.git/blob - src/Object/Post.php
Merge remote-tracking branch 'upstream/develop' into push-pull
[friendica.git] / src / Object / Post.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2020, Friendica
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as
9  * published by the Free Software Foundation, either version 3 of the
10  * License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  *
20  */
21
22 namespace Friendica\Object;
23
24 use Friendica\Content\ContactSelector;
25 use Friendica\Content\Feature;
26 use Friendica\Core\Addon;
27 use Friendica\Core\Hook;
28 use Friendica\Core\Logger;
29 use Friendica\Core\Protocol;
30 use Friendica\Core\Renderer;
31 use Friendica\Core\Session;
32 use Friendica\Database\DBA;
33 use Friendica\DI;
34 use Friendica\Model\Contact;
35 use Friendica\Model\Item;
36 use Friendica\Model\Term;
37 use Friendica\Model\User;
38 use Friendica\Protocol\Activity;
39 use Friendica\Util\Crypto;
40 use Friendica\Util\DateTimeFormat;
41 use Friendica\Util\Proxy as ProxyUtils;
42 use Friendica\Util\Strings;
43 use Friendica\Util\Temporal;
44
45 /**
46  * An item
47  */
48 class Post
49 {
50         private $data = [];
51         private $template = null;
52         private $available_templates = [
53                 'wall' => 'wall_thread.tpl',
54                 'wall2wall' => 'wallwall_thread.tpl'
55         ];
56         private $comment_box_template = 'comment_item.tpl';
57         private $toplevel = false;
58         private $writable = false;
59         /**
60          * @var Post[]
61          */
62         private $children = [];
63         private $parent = null;
64
65         /**
66          * @var Thread
67          */
68         private $thread = null;
69         private $redirect_url = null;
70         private $owner_url = '';
71         private $owner_photo = '';
72         private $owner_name = '';
73         private $wall_to_wall = false;
74         private $threaded = false;
75         private $visiting = false;
76
77         /**
78          * Constructor
79          *
80          * @param array $data data array
81          * @throws \Exception
82          */
83         public function __construct(array $data)
84         {
85                 $this->data = $data;
86                 $this->setTemplate('wall');
87                 $this->toplevel = $this->getId() == $this->getDataValue('parent');
88
89                 if (!empty(Session::getUserIDForVisitorContactID($this->getDataValue('contact-id')))) {
90                         $this->visiting = true;
91                 }
92
93                 $this->writable = $this->getDataValue('writable') || $this->getDataValue('self');
94                 $author = ['uid' => 0, 'id' => $this->getDataValue('author-id'),
95                         'network' => $this->getDataValue('author-network'),
96                         'url' => $this->getDataValue('author-link')];
97                 $this->redirect_url = Contact::magicLinkByContact($author);
98                 if (!$this->isToplevel()) {
99                         $this->threaded = true;
100                 }
101
102                 // Prepare the children
103                 if (!empty($data['children'])) {
104                         foreach ($data['children'] as $item) {
105                                 // Only add will be displayed
106                                 if ($item['network'] === Protocol::MAIL && local_user() != $item['uid']) {
107                                         continue;
108                                 } elseif (!visible_activity($item)) {
109                                         continue;
110                                 }
111
112                                 // You can always comment on Diaspora and OStatus items
113                                 if (in_array($item['network'], [Protocol::OSTATUS, Protocol::DIASPORA]) && (local_user() == $item['uid'])) {
114                                         $item['writable'] = true;
115                                 }
116
117                                 $item['pagedrop'] = $data['pagedrop'];
118                                 $child = new Post($item);
119                                 $this->addChild($child);
120                         }
121                 }
122         }
123
124         /**
125          * Get data in a form usable by a conversation template
126          *
127          * @param array   $conv_responses conversation responses
128          * @param integer $thread_level   default = 1
129          *
130          * @return mixed The data requested on success
131          *               false on failure
132          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
133          * @throws \ImagickException
134          */
135         public function getTemplateData(array $conv_responses, $thread_level = 1)
136         {
137                 $a = DI::app();
138
139                 $item = $this->getData();
140                 $edited = false;
141                 // If the time between "created" and "edited" differs we add
142                 // a notice that the post was edited.
143                 // Note: In some networks reshared items seem to have (sometimes) a difference
144                 // between creation time and edit time of a second. Thats why we add the notice
145                 // only if the difference is more than 1 second.
146                 if (strtotime($item['edited']) - strtotime($item['created']) > 1) {
147                         $edited = [
148                                 'label'    => DI::l10n()->t('This entry was edited'),
149                                 'date'     => DateTimeFormat::local($item['edited'], 'r'),
150                                 'relative' => Temporal::getRelativeDate($item['edited'])
151                         ];
152                 }
153                 $sparkle = '';
154                 $buttons = [
155                         'like'    => null,
156                         'dislike' => null,
157                         'share'   => null,
158                 ];
159                 $dropping = false;
160                 $pinned = '';
161                 $pin = false;
162                 $star = false;
163                 $ignore = false;
164                 $ispinned = "unpinned";
165                 $isstarred = "unstarred";
166                 $indent = '';
167                 $shiny = '';
168                 $osparkle = '';
169                 $total_children = $this->countDescendants();
170
171                 $conv = $this->getThread();
172
173                 $lock = ((($item['private'] == Item::PRIVATE) || (($item['uid'] == local_user()) && (strlen($item['allow_cid']) || strlen($item['allow_gid'])
174                         || strlen($item['deny_cid']) || strlen($item['deny_gid']))))
175                         ? DI::l10n()->t('Private Message')
176                         : false);
177
178                 $shareable = in_array($conv->getProfileOwner(), [0, local_user()]) && $item['private'] != Item::PRIVATE;
179
180                 $edpost = false;
181
182                 if (local_user()) {
183                         if (Strings::compareLink($a->contact['url'], $item['author-link'])) {
184                                 if ($item["event-id"] != 0) {
185                                         $edpost = ["events/event/" . $item['event-id'], DI::l10n()->t("Edit")];
186                                 } else {
187                                         $edpost = ["editpost/" . $item['id'], DI::l10n()->t("Edit")];
188                                 }
189                         }
190                         $dropping = in_array($item['uid'], [0, local_user()]);
191                 }
192
193                 // Editing on items of not subscribed users isn't currently possible
194                 // There are some issues on editing that prevent this.
195                 // But also it is an issue of the supported protocols that doesn't allow editing at all.
196                 if ($item['uid'] == 0) {
197                         $edpost = false;
198                 }
199
200                 if (($this->getDataValue('uid') == local_user()) || $this->isVisiting()) {
201                         $dropping = true;
202                 }
203
204                 $origin = $item['origin'];
205
206                 if (!$origin) {
207                         /// @todo This shouldn't be done as query here, but better during the data creation.
208                         // it is now done here, since during the RC phase we shouldn't make to intense changes.
209                         $parent = Item::selectFirst(['origin'], ['id' => $item['parent']]);
210                         if (DBA::isResult($parent)) {
211                                 $origin = $parent['origin'];
212                         }
213                 } elseif ($item['pinned']) {
214                         $pinned = DI::l10n()->t('pinned item');
215                 }
216
217                 if ($origin && ($item['id'] != $item['parent']) && ($item['network'] == Protocol::ACTIVITYPUB)) {
218                         // ActivityPub doesn't allow removal of remote comments
219                         $delete = DI::l10n()->t('Delete locally');
220                 } else {
221                         // Showing the one or the other text, depending upon if we can only hide it or really delete it.
222                         $delete = $origin ? DI::l10n()->t('Delete globally') : DI::l10n()->t('Remove locally');
223                 }
224
225                 $drop = [
226                         'dropping' => $dropping,
227                         'pagedrop' => $item['pagedrop'],
228                         'select'   => DI::l10n()->t('Select'),
229                         'delete'   => $delete,
230                 ];
231
232                 if (!local_user()) {
233                         $drop = false;
234                 }
235
236                 $filer = (($conv->getProfileOwner() == local_user() && ($item['uid'] != 0)) ? DI::l10n()->t("save to folder") : false);
237
238                 $profile_name = $item['author-name'];
239                 if (!empty($item['author-link']) && empty($item['author-name'])) {
240                         $profile_name = $item['author-link'];
241                 }
242
243                 $author = ['uid' => 0, 'id' => $item['author-id'],
244                         'network' => $item['author-network'], 'url' => $item['author-link']];
245
246                 if (Session::isAuthenticated()) {
247                         $profile_link = Contact::magicLinkByContact($author);
248                 } else {
249                         $profile_link = $item['author-link'];
250                 }
251
252                 if (strpos($profile_link, 'redir/') === 0) {
253                         $sparkle = ' sparkle';
254                 }
255
256                 $locate = ['location' => $item['location'], 'coord' => $item['coord'], 'html' => ''];
257                 Hook::callAll('render_location', $locate);
258                 $location = ((strlen($locate['html'])) ? $locate['html'] : render_location_dummy($locate));
259
260                 // process action responses - e.g. like/dislike/attend/agree/whatever
261                 $response_verbs = ['like', 'dislike', 'announce'];
262
263                 $isevent = false;
264                 $attend = [];
265                 if ($item['object-type'] === Activity\ObjectType::EVENT) {
266                         $response_verbs[] = 'attendyes';
267                         $response_verbs[] = 'attendno';
268                         $response_verbs[] = 'attendmaybe';
269                         if ($conv->isWritable()) {
270                                 $isevent = true;
271                                 $attend = [DI::l10n()->t('I will attend'), DI::l10n()->t('I will not attend'), DI::l10n()->t('I might attend')];
272                         }
273                 }
274
275                 $responses = [];
276                 foreach ($response_verbs as $value => $verb) {
277                         $responses[$verb] = [
278                                 'self'   => $conv_responses[$verb][$item['uri'] . '-self'] ?? 0,
279                                 'output' => !empty($conv_responses[$verb][$item['uri']]) ? format_like($conv_responses[$verb][$item['uri']], $conv_responses[$verb][$item['uri'] . '-l'], $verb, $item['uri']) : '',
280                         ];
281                 }
282
283                 /*
284                  * We should avoid doing this all the time, but it depends on the conversation mode
285                  * And the conv mode may change when we change the conv, or it changes its mode
286                  * Maybe we should establish a way to be notified about conversation changes
287                  */
288                 $this->checkWallToWall();
289
290                 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
291                         $osparkle = ' sparkle';
292                 }
293
294                 $tagger = '';
295
296                 if ($this->isToplevel()) {
297                         if(local_user()) {
298                                 $thread = Item::selectFirstThreadForUser(local_user(), ['ignored'], ['iid' => $item['id']]);
299                                 if (DBA::isResult($thread)) {
300                                         $ignore = [
301                                                 'do'        => DI::l10n()->t("ignore thread"),
302                                                 'undo'      => DI::l10n()->t("unignore thread"),
303                                                 'toggle'    => DI::l10n()->t("toggle ignore status"),
304                                                 'classdo'   => $thread['ignored'] ? "hidden" : "",
305                                                 'classundo' => $thread['ignored'] ? "" : "hidden",
306                                                 'ignored'   => DI::l10n()->t('ignored'),
307                                         ];
308                                 }
309
310                                 if ($conv->getProfileOwner() == local_user() && ($item['uid'] != 0)) {
311                                         if ($origin) {
312                                                 $ispinned = ($item['pinned'] ? 'pinned' : 'unpinned');
313
314                                                 $pin = [
315                                                         'do'        => DI::l10n()->t('pin'),
316                                                         'undo'      => DI::l10n()->t('unpin'),
317                                                         'toggle'    => DI::l10n()->t('toggle pin status'),
318                                                         'classdo'   => $item['pinned'] ? 'hidden' : '',
319                                                         'classundo' => $item['pinned'] ? '' : 'hidden',
320                                                         'pinned'   => DI::l10n()->t('pinned'),
321                                                 ];
322                                         }
323
324                                         $isstarred = (($item['starred']) ? "starred" : "unstarred");
325
326                                         $star = [
327                                                 'do'        => DI::l10n()->t("add star"),
328                                                 'undo'      => DI::l10n()->t("remove star"),
329                                                 'toggle'    => DI::l10n()->t("toggle star status"),
330                                                 'classdo'   => $item['starred'] ? "hidden" : "",
331                                                 'classundo' => $item['starred'] ? "" : "hidden",
332                                                 'starred'   => DI::l10n()->t('starred'),
333                                         ];
334
335                                         $tagger = [
336                                                 'add'   => DI::l10n()->t("add tag"),
337                                                 'class' => "",
338                                         ];
339                                 }
340                         }
341                 } else {
342                         $indent = 'comment';
343                 }
344
345                 if ($conv->isWritable()) {
346                         $buttons['like']    = [DI::l10n()->t("I like this \x28toggle\x29")      , DI::l10n()->t("like")];
347                         $buttons['dislike'] = [DI::l10n()->t("I don't like this \x28toggle\x29"), DI::l10n()->t("dislike")];
348                         if ($shareable) {
349                                 $buttons['share'] = [DI::l10n()->t('Share this'), DI::l10n()->t('share')];
350                         }
351                 }
352
353                 $comment = $this->getCommentBox($indent);
354
355                 if (strcmp(DateTimeFormat::utc($item['created']), DateTimeFormat::utc('now - 12 hours')) > 0) {
356                         $shiny = 'shiny';
357                 }
358
359                 localize_item($item);
360
361                 $body = Item::prepareBody($item, true);
362
363                 list($categories, $folders) = DI::contentItem()->determineCategoriesTerms($item);
364
365                 $body_e       = $body;
366                 $text_e       = strip_tags($body);
367                 $name_e       = $profile_name;
368
369                 if (!empty($item['content-warning']) && DI::pConfig()->get(local_user(), 'system', 'disable_cw', false)) {
370                         $title_e = ucfirst($item['content-warning']);
371                 } else {
372                         $title_e = $item['title'];
373                 }
374
375                 $location_e   = $location;
376                 $owner_name_e = $this->getOwnerName();
377
378                 if (DI::pConfig()->get(local_user(), 'system', 'hide_dislike')) {
379                         $buttons['dislike'] = false;
380                 }
381
382                 // Disable features that aren't available in several networks
383                 if ($buttons["dislike"] && !in_array($item["network"], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA])) {
384                         $buttons["dislike"] = false;
385                         $isevent = false;
386                         $tagger = '';
387                 }
388
389                 if ($buttons["like"] && in_array($item["network"], [Protocol::FEED, Protocol::MAIL])) {
390                         $buttons["like"] = false;
391                 }
392
393                 $tags = Term::populateTagsFromItem($item);
394
395                 $ago = Temporal::getRelativeDate($item['created']);
396                 $ago_received = Temporal::getRelativeDate($item['received']);
397                 if (DI::config()->get('system', 'show_received') && (abs(strtotime($item['created']) - strtotime($item['received'])) > DI::config()->get('system', 'show_received_seconds')) && ($ago != $ago_received)) {
398                         $ago = DI::l10n()->t('%s (Received %s)', $ago, $ago_received);
399                 }
400
401                 // Fetching of Diaspora posts doesn't always work. There are issues with reshares and possibly comments
402                 if (($item['network'] != Protocol::DIASPORA) && empty($comment) && !empty(Session::get('remote_comment'))) {
403                         $remote_comment = [DI::l10n()->t('Comment this item on your system'), DI::l10n()->t('remote comment'),
404                                 str_replace('{uri}', urlencode($item['uri']), Session::get('remote_comment'))];
405                 } else {
406                         $remote_comment = '';
407                 }
408
409                 $tmp_item = [
410                         'template'        => $this->getTemplate(),
411                         'type'            => implode("", array_slice(explode("/", $item['verb']), -1)),
412                         'suppress_tags'   => DI::config()->get('system', 'suppress_tags'),
413                         'tags'            => $tags['tags'],
414                         'hashtags'        => $tags['hashtags'],
415                         'mentions'        => $tags['mentions'],
416                         'implicit_mentions' => $tags['implicit_mentions'],
417                         'txt_cats'        => DI::l10n()->t('Categories:'),
418                         'txt_folders'     => DI::l10n()->t('Filed under:'),
419                         'has_cats'        => ((count($categories)) ? 'true' : ''),
420                         'has_folders'     => ((count($folders)) ? 'true' : ''),
421                         'categories'      => $categories,
422                         'folders'         => $folders,
423                         'body'            => $body_e,
424                         'text'            => $text_e,
425                         'id'              => $this->getId(),
426                         'guid'            => urlencode($item['guid']),
427                         'isevent'         => $isevent,
428                         'attend'          => $attend,
429                         'linktitle'       => DI::l10n()->t('View %s\'s profile @ %s', $profile_name, $item['author-link']),
430                         'olinktitle'      => DI::l10n()->t('View %s\'s profile @ %s', $this->getOwnerName(), $item['owner-link']),
431                         'to'              => DI::l10n()->t('to'),
432                         'via'             => DI::l10n()->t('via'),
433                         'wall'            => DI::l10n()->t('Wall-to-Wall'),
434                         'vwall'           => DI::l10n()->t('via Wall-To-Wall:'),
435                         'profile_url'     => $profile_link,
436                         'item_photo_menu' => item_photo_menu($item),
437                         'name'            => $name_e,
438                         'thumb'           => DI::baseUrl()->remove(ProxyUtils::proxifyUrl($item['author-avatar'], false, ProxyUtils::SIZE_THUMB)),
439                         'osparkle'        => $osparkle,
440                         'sparkle'         => $sparkle,
441                         'title'           => $title_e,
442                         'localtime'       => DateTimeFormat::local($item['created'], 'r'),
443                         'ago'             => $item['app'] ? DI::l10n()->t('%s from %s', $ago, $item['app']) : $ago,
444                         'app'             => $item['app'],
445                         'created'         => $ago,
446                         'lock'            => $lock,
447                         'location'        => $location_e,
448                         'indent'          => $indent,
449                         'shiny'           => $shiny,
450                         'owner_self'      => $item['author-link'] == Session::get('my_url'),
451                         'owner_url'       => $this->getOwnerUrl(),
452                         'owner_photo'     => DI::baseUrl()->remove(ProxyUtils::proxifyUrl($item['owner-avatar'], false, ProxyUtils::SIZE_THUMB)),
453                         'owner_name'      => $owner_name_e,
454                         'plink'           => Item::getPlink($item),
455                         'edpost'          => $edpost,
456                         'ispinned'        => $ispinned,
457                         'pin'             => $pin,
458                         'pinned'          => $pinned,
459                         'isstarred'       => $isstarred,
460                         'star'            => $star,
461                         'ignore'          => $ignore,
462                         'tagger'          => $tagger,
463                         'filer'           => $filer,
464                         'drop'            => $drop,
465                         'vote'            => $buttons,
466                         'like'            => $responses['like']['output'],
467                         'dislike'         => $responses['dislike']['output'],
468                         'responses'       => $responses,
469                         'switchcomment'   => DI::l10n()->t('Comment'),
470                         'reply_label'     => DI::l10n()->t('Reply to %s', $name_e),
471                         'comment'         => $comment,
472                         'remote_comment'  => $remote_comment,
473                         'menu'            => DI::l10n()->t('More'),
474                         'previewing'      => $conv->isPreview() ? ' preview ' : '',
475                         'wait'            => DI::l10n()->t('Please wait'),
476                         'thread_level'    => $thread_level,
477                         'edited'          => $edited,
478                         'network'         => $item["network"],
479                         'network_name'    => ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']),
480                         'network_icon'    => ContactSelector::networkToIcon($item['network'], $item['author-link']),
481                         'received'        => $item['received'],
482                         'commented'       => $item['commented'],
483                         'created_date'    => $item['created'],
484                         'return'          => (DI::args()->getCommand()) ? bin2hex(DI::args()->getCommand()) : '',
485                         'delivery'        => [
486                                 'queue_count'       => $item['delivery_queue_count'],
487                                 'queue_done'        => $item['delivery_queue_done'] + $item['delivery_queue_failed'], /// @todo Possibly display it separately in the future
488                                 'notifier_pending'  => DI::l10n()->t('Notifier task is pending'),
489                                 'delivery_pending'  => DI::l10n()->t('Delivery to remote servers is pending'),
490                                 'delivery_underway' => DI::l10n()->t('Delivery to remote servers is underway'),
491                                 'delivery_almost'   => DI::l10n()->t('Delivery to remote servers is mostly done'),
492                                 'delivery_done'     => DI::l10n()->t('Delivery to remote servers is done'),
493                         ],
494                 ];
495
496                 $arr = ['item' => $item, 'output' => $tmp_item];
497                 Hook::callAll('display_item', $arr);
498
499                 $result = $arr['output'];
500
501                 $result['children'] = [];
502                 $children = $this->getChildren();
503                 $nb_children = count($children);
504                 if ($nb_children > 0) {
505                         foreach ($children as $child) {
506                                 $result['children'][] = $child->getTemplateData($conv_responses, $thread_level + 1);
507                         }
508
509                         // Collapse
510                         if (($nb_children > 2) || ($thread_level > 1)) {
511                                 $result['children'][0]['comment_firstcollapsed'] = true;
512                                 $result['children'][0]['num_comments'] = DI::l10n()->tt('%d comment', '%d comments', $total_children);
513                                 $result['children'][0]['show_text'] = DI::l10n()->t('Show more');
514                                 $result['children'][0]['hide_text'] = DI::l10n()->t('Show fewer');
515                                 if ($thread_level > 1) {
516                                         $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
517                                 } else {
518                                         $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
519                                 }
520                         }
521                 }
522
523                 if ($this->isToplevel()) {
524                         $result['total_comments_num'] = "$total_children";
525                         $result['total_comments_text'] = DI::l10n()->tt('comment', 'comments', $total_children);
526                 }
527
528                 $result['private'] = $item['private'];
529                 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
530
531                 if ($this->isThreaded()) {
532                         $result['flatten'] = false;
533                         $result['threaded'] = true;
534                 } else {
535                         $result['flatten'] = true;
536                         $result['threaded'] = false;
537                 }
538
539                 return $result;
540         }
541
542         /**
543          * @return integer
544          */
545         public function getId()
546         {
547                 return $this->getDataValue('id');
548         }
549
550         /**
551          * @return boolean
552          */
553         public function isThreaded()
554         {
555                 return $this->threaded;
556         }
557
558         /**
559          * Add a child item
560          *
561          * @param Post $item The child item to add
562          *
563          * @return mixed
564          * @throws \Exception
565          */
566         public function addChild(Post $item)
567         {
568                 $item_id = $item->getId();
569                 if (!$item_id) {
570                         Logger::log('[ERROR] Post::addChild : Item has no ID!!', Logger::DEBUG);
571                         return false;
572                 } elseif ($this->getChild($item->getId())) {
573                         Logger::log('[WARN] Post::addChild : Item already exists (' . $item->getId() . ').', Logger::DEBUG);
574                         return false;
575                 }
576
577                 $activity = DI::activity();
578
579                 /*
580                  * Only add what will be displayed
581                  */
582                 if ($item->getDataValue('network') === Protocol::MAIL && local_user() != $item->getDataValue('uid')) {
583                         return false;
584                 } elseif ($activity->match($item->getDataValue('verb'), Activity::LIKE) ||
585                           $activity->match($item->getDataValue('verb'), Activity::DISLIKE)) {
586                         return false;
587                 }
588
589                 $item->setParent($this);
590                 $this->children[] = $item;
591
592                 return end($this->children);
593         }
594
595         /**
596          * Get a child by its ID
597          *
598          * @param integer $id The child id
599          *
600          * @return mixed
601          */
602         public function getChild($id)
603         {
604                 foreach ($this->getChildren() as $child) {
605                         if ($child->getId() == $id) {
606                                 return $child;
607                         }
608                 }
609
610                 return null;
611         }
612
613         /**
614          * Get all our children
615          *
616          * @return Post[]
617          */
618         public function getChildren()
619         {
620                 return $this->children;
621         }
622
623         /**
624          * Set our parent
625          *
626          * @param Post $item The item to set as parent
627          *
628          * @return void
629          */
630         protected function setParent(Post $item)
631         {
632                 $parent = $this->getParent();
633                 if ($parent) {
634                         $parent->removeChild($this);
635                 }
636
637                 $this->parent = $item;
638                 $this->setThread($item->getThread());
639         }
640
641         /**
642          * Remove our parent
643          *
644          * @return void
645          */
646         protected function removeParent()
647         {
648                 $this->parent = null;
649                 $this->thread = null;
650         }
651
652         /**
653          * Remove a child
654          *
655          * @param Post $item The child to be removed
656          *
657          * @return boolean Success or failure
658          * @throws \Exception
659          */
660         public function removeChild(Post $item)
661         {
662                 $id = $item->getId();
663                 foreach ($this->getChildren() as $key => $child) {
664                         if ($child->getId() == $id) {
665                                 $child->removeParent();
666                                 unset($this->children[$key]);
667                                 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
668                                 $this->children = array_values($this->children);
669                                 return true;
670                         }
671                 }
672                 Logger::log('[WARN] Item::removeChild : Item is not a child (' . $id . ').', Logger::DEBUG);
673                 return false;
674         }
675
676         /**
677          * Get parent item
678          *
679          * @return object
680          */
681         protected function getParent()
682         {
683                 return $this->parent;
684         }
685
686         /**
687          * Set conversation thread
688          *
689          * @param Thread $thread
690          *
691          * @return void
692          */
693         public function setThread(Thread $thread = null)
694         {
695                 $this->thread = $thread;
696
697                 // Set it on our children too
698                 foreach ($this->getChildren() as $child) {
699                         $child->setThread($thread);
700                 }
701         }
702
703         /**
704          * Get conversation
705          *
706          * @return Thread
707          */
708         public function getThread()
709         {
710                 return $this->thread;
711         }
712
713         /**
714          * Get raw data
715          *
716          * We shouldn't need this
717          *
718          * @return array
719          */
720         public function getData()
721         {
722                 return $this->data;
723         }
724
725         /**
726          * Get a data value
727          *
728          * @param string $name key
729          *
730          * @return mixed value on success
731          *               false on failure
732          */
733         public function getDataValue($name)
734         {
735                 if (!isset($this->data[$name])) {
736                         // Logger::log('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".', Logger::DEBUG);
737                         return false;
738                 }
739
740                 return $this->data[$name];
741         }
742
743         /**
744          * Set template
745          *
746          * @param string $name template name
747          * @return bool
748          * @throws \Exception
749          */
750         private function setTemplate($name)
751         {
752                 if (empty($this->available_templates[$name])) {
753                         Logger::log('[ERROR] Item::setTemplate : Template not available ("' . $name . '").', Logger::DEBUG);
754                         return false;
755                 }
756
757                 $this->template = $this->available_templates[$name];
758
759                 return true;
760         }
761
762         /**
763          * Get template
764          *
765          * @return object
766          */
767         private function getTemplate()
768         {
769                 return $this->template;
770         }
771
772         /**
773          * Check if this is a toplevel post
774          *
775          * @return boolean
776          */
777         private function isToplevel()
778         {
779                 return $this->toplevel;
780         }
781
782         /**
783          * Check if this is writable
784          *
785          * @return boolean
786          */
787         private function isWritable()
788         {
789                 $conv = $this->getThread();
790
791                 if ($conv) {
792                         // This will allow us to comment on wall-to-wall items owned by our friends
793                         // and community forums even if somebody else wrote the post.
794                         // bug #517 - this fixes for conversation owner
795                         if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == local_user()) {
796                                 return true;
797                         }
798
799                         // this fixes for visitors
800                         return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
801                 }
802                 return $this->writable;
803         }
804
805         /**
806          * Count the total of our descendants
807          *
808          * @return integer
809          */
810         private function countDescendants()
811         {
812                 $children = $this->getChildren();
813                 $total = count($children);
814                 if ($total > 0) {
815                         foreach ($children as $child) {
816                                 $total += $child->countDescendants();
817                         }
818                 }
819
820                 return $total;
821         }
822
823         /**
824          * Get the template for the comment box
825          *
826          * @return string
827          */
828         private function getCommentBoxTemplate()
829         {
830                 return $this->comment_box_template;
831         }
832
833         /**
834          * Get default text for the comment box
835          *
836          * @return string
837          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
838          */
839         private function getDefaultText()
840         {
841                 $a = DI::app();
842
843                 if (!local_user()) {
844                         return '';
845                 }
846
847                 $owner = User::getOwnerDataById($a->user['uid']);
848
849                 if (!Feature::isEnabled(local_user(), 'explicit_mentions')) {
850                         return '';
851                 }
852
853                 $item = Item::selectFirst(['author-addr'], ['id' => $this->getId()]);
854                 if (!DBA::isResult($item) || empty($item['author-addr'])) {
855                         // Should not happen
856                         return '';
857                 }
858
859                 if ($item['author-addr'] != $owner['addr']) {
860                         $text = '@' . $item['author-addr'] . ' ';
861                 } else {
862                         $text = '';
863                 }
864
865                 $terms = Term::tagArrayFromItemId($this->getId(), [Term::MENTION, Term::IMPLICIT_MENTION]);
866                 foreach ($terms as $term) {
867                         $profile = Contact::getDetailsByURL($term['url']);
868                         if (!empty($profile['addr']) && ((($profile['contact-type'] ?? '') ?: Contact::TYPE_UNKNOWN) != Contact::TYPE_COMMUNITY) &&
869                                 ($profile['addr'] != $owner['addr']) && !strstr($text, $profile['addr'])) {
870                                 $text .= '@' . $profile['addr'] . ' ';
871                         }
872                 }
873
874                 return $text;
875         }
876
877         /**
878          * Get the comment box
879          *
880          * @param string $indent Indent value
881          *
882          * @return mixed The comment box string (empty if no comment box)
883          *               false on failure
884          * @throws \Exception
885          */
886         private function getCommentBox($indent)
887         {
888                 $a = DI::app();
889
890                 $comment_box = '';
891                 $conv = $this->getThread();
892                 $ww = '';
893                 if (($conv->getMode() === 'network') && $this->isWallToWall()) {
894                         $ww = 'ww';
895                 }
896
897                 if ($conv->isWritable() && $this->isWritable()) {
898                         $qcomment = null;
899
900                         /*
901                          * Hmmm, code depending on the presence of a particular addon?
902                          * This should be better if done by a hook
903                          */
904                         if (Addon::isEnabled('qcomment')) {
905                                 $qc = ((local_user()) ? DI::pConfig()->get(local_user(), 'qcomment', 'words') : null);
906                                 $qcomment = (($qc) ? explode("\n", $qc) : null);
907                         }
908
909                         // Fetch the user id from the parent when the owner user is empty
910                         $uid = $conv->getProfileOwner();
911                         $parent_uid = $this->getDataValue('uid');
912
913                         $default_text = $this->getDefaultText();
914
915                         if (!is_null($parent_uid) && ($uid != $parent_uid)) {
916                                 $uid = $parent_uid;
917                         }
918
919                         $template = Renderer::getMarkupTemplate($this->getCommentBoxTemplate());
920                         $comment_box = Renderer::replaceMacros($template, [
921                                 '$return_path' => DI::args()->getQueryString(),
922                                 '$threaded'    => $this->isThreaded(),
923                                 '$jsreload'    => '',
924                                 '$wall'        => ($conv->getMode() === 'profile'),
925                                 '$id'          => $this->getId(),
926                                 '$parent'      => $this->getId(),
927                                 '$qcomment'    => $qcomment,
928                                 '$default'     => $default_text,
929                                 '$profile_uid' => $uid,
930                                 '$mylink'      => DI::baseUrl()->remove($a->contact['url']),
931                                 '$mytitle'     => DI::l10n()->t('This is you'),
932                                 '$myphoto'     => DI::baseUrl()->remove($a->contact['thumb']),
933                                 '$comment'     => DI::l10n()->t('Comment'),
934                                 '$submit'      => DI::l10n()->t('Submit'),
935                                 '$loading'     => DI::l10n()->t('Loading...'),
936                                 '$edbold'      => DI::l10n()->t('Bold'),
937                                 '$editalic'    => DI::l10n()->t('Italic'),
938                                 '$eduline'     => DI::l10n()->t('Underline'),
939                                 '$edquote'     => DI::l10n()->t('Quote'),
940                                 '$edcode'      => DI::l10n()->t('Code'),
941                                 '$edimg'       => DI::l10n()->t('Image'),
942                                 '$edurl'       => DI::l10n()->t('Link'),
943                                 '$edattach'    => DI::l10n()->t('Link or Media'),
944                                 '$prompttext'  => DI::l10n()->t('Please enter a image/video/audio/webpage URL:'),
945                                 '$preview'     => DI::l10n()->t('Preview'),
946                                 '$indent'      => $indent,
947                                 '$sourceapp'   => DI::l10n()->t($a->sourcename),
948                                 '$ww'          => $conv->getMode() === 'network' ? $ww : '',
949                                 '$rand_num'    => Crypto::randomDigits(12)
950                         ]);
951                 }
952
953                 return $comment_box;
954         }
955
956         /**
957          * @return string
958          */
959         private function getRedirectUrl()
960         {
961                 return $this->redirect_url;
962         }
963
964         /**
965          * Check if we are a wall to wall item and set the relevant properties
966          *
967          * @return void
968          * @throws \Exception
969          */
970         protected function checkWallToWall()
971         {
972                 $a = DI::app();
973                 $conv = $this->getThread();
974                 $this->wall_to_wall = false;
975
976                 if ($this->isToplevel()) {
977                         if ($conv->getMode() !== 'profile') {
978                                 if ($this->getDataValue('wall') && !$this->getDataValue('self')) {
979                                         // On the network page, I am the owner. On the display page it will be the profile owner.
980                                         // This will have been stored in $a->page_contact by our calling page.
981                                         // Put this person as the wall owner of the wall-to-wall notice.
982
983                                         $this->owner_url = Contact::magicLink($a->page_contact['url']);
984                                         $this->owner_photo = $a->page_contact['thumb'];
985                                         $this->owner_name = $a->page_contact['name'];
986                                         $this->wall_to_wall = true;
987                                 } elseif ($this->getDataValue('owner-link')) {
988                                         $owner_linkmatch = (($this->getDataValue('owner-link')) && Strings::compareLink($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
989                                         $alias_linkmatch = (($this->getDataValue('alias')) && Strings::compareLink($this->getDataValue('alias'), $this->getDataValue('author-link')));
990                                         $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
991
992                                         if (!$owner_linkmatch && !$alias_linkmatch && !$owner_namematch) {
993                                                 // The author url doesn't match the owner (typically the contact)
994                                                 // and also doesn't match the contact alias.
995                                                 // The name match is a hack to catch several weird cases where URLs are
996                                                 // all over the park. It can be tricked, but this prevents you from
997                                                 // seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
998                                                 // well that it's the same Bob Smith.
999                                                 // But it could be somebody else with the same name. It just isn't highly likely.
1000
1001
1002                                                 $this->owner_photo = $this->getDataValue('owner-avatar');
1003                                                 $this->owner_name = $this->getDataValue('owner-name');
1004                                                 $this->wall_to_wall = true;
1005
1006                                                 $owner = ['uid' => 0, 'id' => $this->getDataValue('owner-id'),
1007                                                         'network' => $this->getDataValue('owner-network'),
1008                                                         'url' => $this->getDataValue('owner-link')];
1009                                                 $this->owner_url = Contact::magicLinkByContact($owner);
1010                                         }
1011                                 }
1012                         }
1013                 }
1014
1015                 if (!$this->wall_to_wall) {
1016                         $this->setTemplate('wall');
1017                         $this->owner_url = '';
1018                         $this->owner_photo = '';
1019                         $this->owner_name = '';
1020                 }
1021         }
1022
1023         /**
1024          * @return boolean
1025          */
1026         private function isWallToWall()
1027         {
1028                 return $this->wall_to_wall;
1029         }
1030
1031         /**
1032          * @return string
1033          */
1034         private function getOwnerUrl()
1035         {
1036                 return $this->owner_url;
1037         }
1038
1039         /**
1040          * @return string
1041          */
1042         private function getOwnerName()
1043         {
1044                 return $this->owner_name;
1045         }
1046
1047         /**
1048          * @return boolean
1049          */
1050         private function isVisiting()
1051         {
1052                 return $this->visiting;
1053         }
1054 }