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