3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Content;
24 use Friendica\Core\Addon;
25 use Friendica\Core\Cache\Enum\Duration;
26 use Friendica\Core\Protocol;
27 use Friendica\Core\Renderer;
28 use Friendica\Core\Search;
29 use Friendica\Database\DBA;
31 use Friendica\Model\Contact;
32 use Friendica\Model\Circle;
33 use Friendica\Model\Item;
34 use Friendica\Model\Post;
35 use Friendica\Model\Profile;
36 use Friendica\Util\DateTimeFormat;
37 use Friendica\Util\Temporal;
42 * Return the follow widget
44 * @param string $value optional, default empty
46 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
48 public static function follow(string $value = ''): string
50 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/follow.tpl'), array(
51 '$connect' => DI::l10n()->t('Add New Contact'),
52 '$desc' => DI::l10n()->t('Enter address or web location'),
53 '$hint' => DI::l10n()->t('Example: bob@example.com, http://example.com/barbara'),
55 '$follow' => DI::l10n()->t('Connect')
60 * Return Find People widget
62 * @return string HTML code representing "People Widget"
64 public static function findPeople(): string
66 $global_dir = Search::getGlobalDirectory();
68 if (DI::config()->get('system', 'invitation_only')) {
69 $x = intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'invites_remaining'));
70 if ($x || DI::app()->isSiteAdmin()) {
71 DI::page()['aside'] .= '<div class="side-link widget" id="side-invite-remain">'
72 . DI::l10n()->tt('%d invitation available', '%d invitations available', $x)
78 $nv['findpeople'] = DI::l10n()->t('Find People');
79 $nv['desc'] = DI::l10n()->t('Enter name or interest');
80 $nv['label'] = DI::l10n()->t('Connect/Follow');
81 $nv['hint'] = DI::l10n()->t('Examples: Robert Morgenstein, Fishing');
82 $nv['findthem'] = DI::l10n()->t('Find');
83 $nv['suggest'] = DI::l10n()->t('Friend Suggestions');
84 $nv['similar'] = DI::l10n()->t('Similar Interests');
85 $nv['random'] = DI::l10n()->t('Random Profile');
86 $nv['inv'] = DI::l10n()->t('Invite Friends');
87 $nv['directory'] = DI::l10n()->t('Global Directory');
88 $nv['global_dir'] = Profile::zrl($global_dir, true);
89 $nv['local_directory'] = DI::l10n()->t('Local Directory');
94 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/peoplefind.tpl'), $aside);
98 * Return unavailable networks as array
100 * @return array Unsupported networks
102 public static function unavailableNetworks(): array
104 // Always hide content from these networks
105 $networks = [Protocol::PHANTOM, Protocol::FACEBOOK, Protocol::APPNET, Protocol::ZOT];
107 if (!Addon::isEnabled("discourse")) {
108 $networks[] = Protocol::DISCOURSE;
111 if (!Addon::isEnabled("statusnet")) {
112 $networks[] = Protocol::STATUSNET;
115 if (!Addon::isEnabled("pumpio")) {
116 $networks[] = Protocol::PUMPIO;
119 if (!Addon::isEnabled("twitter")) {
120 $networks[] = Protocol::TWITTER;
123 if (!Addon::isEnabled("tumblr")) {
124 $networks[] = Protocol::TUMBLR;
127 if (DI::config()->get("system", "ostatus_disabled")) {
128 $networks[] = Protocol::OSTATUS;
131 if (!DI::config()->get("system", "diaspora_enabled")) {
132 $networks[] = Protocol::DIASPORA;
135 if (!Addon::isEnabled("pnut")) {
136 $networks[] = Protocol::PNUT;
142 * Display a generic filter widget based on a list of options
144 * The options array must be the following format:
147 * 'ref' => {filter value},
148 * 'name' => {option name}
153 * @param string $type The filter query string key
154 * @param string $title
155 * @param string $desc
156 * @param string $all The no filter label
157 * @param string $baseUrl The full page request URI
158 * @param array $options
159 * @param string $selected The currently selected filter option value
163 private static function filter(string $type, string $title, string $desc, string $all, string $baseUrl, array $options, string $selected = null): string
165 $queryString = parse_url($baseUrl, PHP_URL_QUERY);
169 parse_str($queryString, $queryArray);
170 unset($queryArray[$type]);
172 if (count($queryArray)) {
173 $baseUrl = substr($baseUrl, 0, strpos($baseUrl, '?')) . '?' . http_build_query($queryArray) . '&';
175 $baseUrl = substr($baseUrl, 0, strpos($baseUrl, '?')) . '?';
178 $baseUrl = trim($baseUrl, '?') . '?';
181 array_walk($options, function (&$value) {
182 $value['ref'] = rawurlencode($value['ref']);
185 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/filter.tpl'), [
189 '$selected' => $selected,
190 '$all_label' => $all,
191 '$options' => $options,
197 * Return circle membership widget
199 * @param string $baseurl
200 * @param string $selected
204 public static function circles(string $baseurl, string $selected = ''): string
206 if (!DI::userSession()->getLocalUserId()) {
210 $options = array_map(function ($circle) {
212 'ref' => $circle['id'],
213 'name' => $circle['name']
215 }, Circle::getByUserId(DI::userSession()->getLocalUserId()));
219 DI::l10n()->t('Circles'),
221 DI::l10n()->t('Everyone'),
229 * Return contact relationship widget
231 * @param string $baseurl baseurl
232 * @param string $selected optional, default empty
236 public static function contactRels(string $baseurl, string $selected = ''): string
238 if (!DI::userSession()->getLocalUserId()) {
243 ['ref' => 'followers', 'name' => DI::l10n()->t('Followers')],
244 ['ref' => 'following', 'name' => DI::l10n()->t('Following')],
245 ['ref' => 'mutuals', 'name' => DI::l10n()->t('Mutual friends')],
246 ['ref' => 'nothing', 'name' => DI::l10n()->t('No relationship')],
251 DI::l10n()->t('Relationships'),
253 DI::l10n()->t('All Contacts'),
261 * Return networks widget
263 * @param string $baseurl baseurl
264 * @param string $selected optional, default empty
266 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
268 public static function networks(string $baseurl, string $selected = ''): string
270 if (!DI::userSession()->getLocalUserId()) {
274 $networks = self::unavailableNetworks();
275 $query = "`uid` = ? AND NOT `deleted` AND `network` != '' AND NOT `network` IN (" . substr(str_repeat("?, ", count($networks)), 0, -2) . ")";
276 $condition = array_merge([$query], array_merge([DI::userSession()->getLocalUserId()], $networks));
278 $r = DBA::select('contact', ['network'], $condition, ['group_by' => ['network'], 'order' => ['network']]);
281 while ($rr = DBA::fetch($r)) {
282 $nets[] = ['ref' => $rr['network'], 'name' => ContactSelector::networkToName($rr['network'])];
286 if (count($nets) < 2) {
292 DI::l10n()->t('Protocols'),
294 DI::l10n()->t('All Protocols'),
302 * Return file as widget
304 * @param string $baseurl baseurl
305 * @param string $selected optional, default empty
309 public static function fileAs(string $baseurl, string $selected = ''): string
311 if (!DI::userSession()->getLocalUserId()) {
316 foreach (Post\Category::getArray(DI::userSession()->getLocalUserId(), Post\Category::FILE) as $savedFolderName) {
317 $terms[] = ['ref' => $savedFolderName, 'name' => $savedFolderName];
322 DI::l10n()->t('Saved Folders'),
324 DI::l10n()->t('Everything'),
332 * Return categories widget
334 * @param int $uid Id of the user owning the categories
335 * @param string $baseurl Base page URL
336 * @param string $selected Selected category
338 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
340 public static function categories(int $uid, string $baseurl, string $selected = ''): string
342 if (!Feature::isEnabled($uid, 'categories')) {
347 foreach (Post\Category::getArray($uid, Post\Category::CATEGORY) as $savedFolderName) {
348 $terms[] = ['ref' => $savedFolderName, 'name' => $savedFolderName];
353 DI::l10n()->t('Categories'),
355 DI::l10n()->t('Everything'),
363 * Show a random selection of five common contacts between the visitor and the viewed profile user.
365 * @param int $uid Viewed profile user ID
366 * @param string $nickname Viewed profile user nickname
368 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
369 * @throws \ImagickException
371 public static function commonFriendsVisitor(int $uid, string $nickname): string
373 if (DI::userSession()->getLocalUserId() == $uid) {
377 $visitorPCid = DI::userSession()->getPublicContactId() ?: DI::userSession()->getRemoteUserId();
382 $localPCid = Contact::getPublicIdByUserId($uid);
385 'NOT `self` AND NOT `blocked` AND NOT `hidden` AND `id` != ?',
389 $total = Contact\Relation::countCommon($localPCid, $visitorPCid, $condition);
394 $commonContacts = Contact\Relation::listCommon($localPCid, $visitorPCid, $condition, 0, 5, true);
395 if (!DBA::isResult($commonContacts)) {
400 foreach ($commonContacts as $contact) {
402 'url' => Contact::magicLinkByContact($contact),
403 'name' => $contact['name'],
404 'photo' => Contact::getThumb($contact),
408 $tpl = Renderer::getMarkupTemplate('widget/remote_friends_common.tpl');
409 return Renderer::replaceMacros($tpl, [
410 '$desc' => DI::l10n()->tt("%d contact in common", "%d contacts in common", $total),
411 '$base' => DI::baseUrl(),
412 '$nickname' => $nickname,
413 '$linkmore' => $total > 5 ? 'true' : '',
414 '$more' => DI::l10n()->t('show more'),
415 '$contacts' => $entries
420 * Insert a tag cloud widget for the present profile.
422 * @param int $uid User ID
423 * @param int $limit Max number of displayed tags.
424 * @return string HTML formatted output.
425 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
426 * @throws \ImagickException
428 public static function tagCloud(int $uid, int $limit = 50): string
434 if (Feature::isEnabled($uid, 'tagadelic')) {
435 $owner_id = Contact::getPublicIdByUserId($uid);
440 return Widget\TagCloud::getHTML($uid, $limit, $owner_id, 'wall');
447 * @param string $url Base page URL
448 * @param int $uid User ID consulting/publishing posts
449 * @param bool $wall True: Posted by User; False: Posted to User (network timeline)
451 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
453 public static function postedByYear(string $url, int $uid, bool $wall): string
457 $visible_years = DI::pConfig()->get($uid, 'system', 'archive_visible_years', 5);
459 /* arrange the list in years */
460 $dnow = DateTimeFormat::localNow('Y-m-d');
464 $cachekey = 'Widget::postedByYear' . $uid . '-' . (int)$wall;
465 $dthen = DI::cache()->get($cachekey);
467 $dthen = Item::firstPostDate($uid, $wall);
468 DI::cache()->set($cachekey, $dthen, Duration::HOUR);
472 // Set the start and end date to the beginning of the month
473 $dnow = substr($dnow, 0, 8) . '01';
474 $dthen = substr($dthen, 0, 8) . '01';
477 * Starting with the current month, get the first and last days of every
478 * month down to and including the month of the first post
480 while (substr($dnow, 0, 7) >= substr($dthen, 0, 7)) {
481 $dyear = intval(substr($dnow, 0, 4));
482 $dstart = substr($dnow, 0, 8) . '01';
483 $dend = substr($dnow, 0, 8) . Temporal::getDaysInMonth(intval($dnow), intval(substr($dnow, 5)));
484 $start_month = DateTimeFormat::utc($dstart, 'Y-m-d');
485 $end_month = DateTimeFormat::utc($dend, 'Y-m-d');
486 $str = DI::l10n()->getDay(DateTimeFormat::utc($dnow, 'F'));
488 if (empty($ret[$dyear])) {
492 $ret[$dyear][] = [$str, $end_month, $start_month];
493 $dnow = DateTimeFormat::utc($dnow . ' -1 month', 'Y-m-d');
497 if (!DBA::isResult($ret)) {
502 $cutoff_year = intval(DateTimeFormat::localNow('Y')) - $visible_years;
503 $cutoff = array_key_exists($cutoff_year, $ret);
505 $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/posted_date.tpl'),[
506 '$title' => DI::l10n()->t('Archives'),
507 '$size' => $visible_years,
508 '$cutoff_year' => $cutoff_year,
509 '$cutoff' => $cutoff,
512 '$showless' => DI::l10n()->t('show less'),
513 '$showmore' => DI::l10n()->t('show more')
520 * Display the account types sidebar
521 * The account type value is added as a parameter to the url
523 * @param string $base Basepath
524 * @param string $accounttype Account type
527 public static function accountTypes(string $base, string $accounttype): string
530 ['ref' => 'person', 'name' => DI::l10n()->t('Persons')],
531 ['ref' => 'organisation', 'name' => DI::l10n()->t('Organisations')],
532 ['ref' => 'news', 'name' => DI::l10n()->t('News')],
533 ['ref' => 'community', 'name' => DI::l10n()->t('Groups')],
536 return self::filter('accounttype', DI::l10n()->t('Account Types'), '',
537 DI::l10n()->t('All'), $base, $accounts, $accounttype);