3 * @copyright Copyright (C) 2010-2022, 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\Core\Session;
30 use Friendica\Database\DBA;
32 use Friendica\Model\Contact;
33 use Friendica\Model\Group;
34 use Friendica\Model\Item;
35 use Friendica\Model\Post;
36 use Friendica\Model\Profile;
37 use Friendica\Util\DateTimeFormat;
38 use Friendica\Util\Temporal;
43 * Return the follow widget
45 * @param string $value optional, default empty
47 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
49 public static function follow(string $value = ''): string
51 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/follow.tpl'), array(
52 '$connect' => DI::l10n()->t('Add New Contact'),
53 '$desc' => DI::l10n()->t('Enter address or web location'),
54 '$hint' => DI::l10n()->t('Example: bob@example.com, http://example.com/barbara'),
56 '$follow' => DI::l10n()->t('Connect')
61 * Return Find People widget
63 * @return string HTML code respresenting "People Widget"
65 public static function findPeople(): string
67 $global_dir = Search::getGlobalDirectory();
69 if (DI::config()->get('system', 'invitation_only')) {
70 $x = intval(DI::pConfig()->get(Session::getLocalUser(), 'system', 'invites_remaining'));
71 if ($x || DI::app()->isSiteAdmin()) {
72 DI::page()['aside'] .= '<div class="side-link widget" id="side-invite-remain">'
73 . DI::l10n()->tt('%d invitation available', '%d invitations available', $x)
79 $nv['findpeople'] = DI::l10n()->t('Find People');
80 $nv['desc'] = DI::l10n()->t('Enter name or interest');
81 $nv['label'] = DI::l10n()->t('Connect/Follow');
82 $nv['hint'] = DI::l10n()->t('Examples: Robert Morgenstein, Fishing');
83 $nv['findthem'] = DI::l10n()->t('Find');
84 $nv['suggest'] = DI::l10n()->t('Friend Suggestions');
85 $nv['similar'] = DI::l10n()->t('Similar Interests');
86 $nv['random'] = DI::l10n()->t('Random Profile');
87 $nv['inv'] = DI::l10n()->t('Invite Friends');
88 $nv['directory'] = DI::l10n()->t('Global Directory');
89 $nv['global_dir'] = Profile::zrl($global_dir, true);
90 $nv['local_directory'] = DI::l10n()->t('Local Directory');
95 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/peoplefind.tpl'), $aside);
99 * Return unavailable networks as array
101 * @return array Unsupported networks
103 public static function unavailableNetworks(): array
105 // Always hide content from these networks
106 $networks = [Protocol::PHANTOM, Protocol::FACEBOOK, Protocol::APPNET, Protocol::ZOT];
108 if (!Addon::isEnabled("discourse")) {
109 $networks[] = Protocol::DISCOURSE;
112 if (!Addon::isEnabled("statusnet")) {
113 $networks[] = Protocol::STATUSNET;
116 if (!Addon::isEnabled("pumpio")) {
117 $networks[] = Protocol::PUMPIO;
120 if (!Addon::isEnabled("twitter")) {
121 $networks[] = Protocol::TWITTER;
124 if (DI::config()->get("system", "ostatus_disabled")) {
125 $networks[] = Protocol::OSTATUS;
128 if (!DI::config()->get("system", "diaspora_enabled")) {
129 $networks[] = Protocol::DIASPORA;
132 if (!Addon::isEnabled("pnut")) {
133 $networks[] = Protocol::PNUT;
139 * Display a generic filter widget based on a list of options
141 * The options array must be the following format:
144 * 'ref' => {filter value},
145 * 'name' => {option name}
150 * @param string $type The filter query string key
151 * @param string $title
152 * @param string $desc
153 * @param string $all The no filter label
154 * @param string $baseUrl The full page request URI
155 * @param array $options
156 * @param string $selected The currently selected filter option value
160 private static function filter(string $type, string $title, string $desc, string $all, string $baseUrl, array $options, string $selected = null): string
162 $queryString = parse_url($baseUrl, PHP_URL_QUERY);
166 parse_str($queryString, $queryArray);
167 unset($queryArray[$type]);
169 if (count($queryArray)) {
170 $baseUrl = substr($baseUrl, 0, strpos($baseUrl, '?')) . '?' . http_build_query($queryArray) . '&';
172 $baseUrl = substr($baseUrl, 0, strpos($baseUrl, '?')) . '?';
175 $baseUrl = trim($baseUrl, '?') . '?';
178 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/filter.tpl'), [
182 '$selected' => $selected,
183 '$all_label' => $all,
184 '$options' => $options,
190 * Return group membership widget
192 * @param string $baseurl
193 * @param string $selected
197 public static function groups(string $baseurl, string $selected = ''): string
199 if (!Session::getLocalUser()) {
203 $options = array_map(function ($group) {
205 'ref' => $group['id'],
206 'name' => $group['name']
208 }, Group::getByUserId(Session::getLocalUser()));
212 DI::l10n()->t('Groups'),
214 DI::l10n()->t('Everyone'),
222 * Return contact relationship widget
224 * @param string $baseurl baseurl
225 * @param string $selected optional, default empty
229 public static function contactRels(string $baseurl, string $selected = ''): string
231 if (!Session::getLocalUser()) {
236 ['ref' => 'followers', 'name' => DI::l10n()->t('Followers')],
237 ['ref' => 'following', 'name' => DI::l10n()->t('Following')],
238 ['ref' => 'mutuals', 'name' => DI::l10n()->t('Mutual friends')],
243 DI::l10n()->t('Relationships'),
245 DI::l10n()->t('All Contacts'),
253 * Return networks widget
255 * @param string $baseurl baseurl
256 * @param string $selected optional, default empty
258 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
260 public static function networks(string $baseurl, string $selected = ''): string
262 if (!Session::getLocalUser()) {
266 $networks = self::unavailableNetworks();
267 $query = "`uid` = ? AND NOT `deleted` AND `network` != '' AND NOT `network` IN (" . substr(str_repeat("?, ", count($networks)), 0, -2) . ")";
268 $condition = array_merge([$query], array_merge([Session::getLocalUser()], $networks));
270 $r = DBA::select('contact', ['network'], $condition, ['group_by' => ['network'], 'order' => ['network']]);
273 while ($rr = DBA::fetch($r)) {
274 $nets[] = ['ref' => $rr['network'], 'name' => ContactSelector::networkToName($rr['network'])];
278 if (count($nets) < 2) {
284 DI::l10n()->t('Protocols'),
286 DI::l10n()->t('All Protocols'),
294 * Return file as widget
296 * @param string $baseurl baseurl
297 * @param string $selected optional, default empty
301 public static function fileAs(string $baseurl, string $selected = ''): string
303 if (!Session::getLocalUser()) {
308 foreach (Post\Category::getArray(Session::getLocalUser(), Post\Category::FILE) as $savedFolderName) {
309 $terms[] = ['ref' => $savedFolderName, 'name' => $savedFolderName];
314 DI::l10n()->t('Saved Folders'),
316 DI::l10n()->t('Everything'),
324 * Return categories widget
326 * @param int $uid Id of the user owning the categories
327 * @param string $baseurl Base page URL
328 * @param string $selected Selected category
330 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
332 public static function categories(int $uid, string $baseurl, string $selected = ''): string
334 if (!Feature::isEnabled($uid, 'categories')) {
339 foreach (Post\Category::getArray($uid, Post\Category::CATEGORY) as $savedFolderName) {
340 $terms[] = ['ref' => $savedFolderName, 'name' => $savedFolderName];
345 DI::l10n()->t('Categories'),
347 DI::l10n()->t('Everything'),
355 * Show a random selection of five common contacts between the visitor and the viewed profile user.
357 * @param int $uid Viewed profile user ID
358 * @param string $nickname Viewed profile user nickname
360 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
361 * @throws \ImagickException
363 public static function commonFriendsVisitor(int $uid, string $nickname): string
365 if (Session::getLocalUser() == $uid) {
369 $visitorPCid = Session::getLocalUser() ? Contact::getPublicIdByUserId(Session::getLocalUser()) : Session::getRemoteUser();
374 $localPCid = Contact::getPublicIdByUserId($uid);
377 'NOT `self` AND NOT `blocked` AND NOT `hidden` AND `id` != ?',
381 $total = Contact\Relation::countCommon($localPCid, $visitorPCid, $condition);
386 $commonContacts = Contact\Relation::listCommon($localPCid, $visitorPCid, $condition, 0, 5, true);
387 if (!DBA::isResult($commonContacts)) {
392 foreach ($commonContacts as $contact) {
394 'url' => Contact::magicLinkByContact($contact),
395 'name' => $contact['name'],
396 'photo' => Contact::getThumb($contact),
400 $tpl = Renderer::getMarkupTemplate('widget/remote_friends_common.tpl');
401 return Renderer::replaceMacros($tpl, [
402 '$desc' => DI::l10n()->tt("%d contact in common", "%d contacts in common", $total),
403 '$base' => DI::baseUrl(),
404 '$nickname' => $nickname,
405 '$linkmore' => $total > 5 ? 'true' : '',
406 '$more' => DI::l10n()->t('show more'),
407 '$contacts' => $entries
412 * Insert a tag cloud widget for the present profile.
414 * @param int $uid User ID
415 * @param int $limit Max number of displayed tags.
416 * @return string HTML formatted output.
417 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
418 * @throws \ImagickException
420 public static function tagCloud(int $uid, int $limit = 50): string
426 if (Feature::isEnabled($uid, 'tagadelic')) {
427 $owner_id = Contact::getPublicIdByUserId($uid);
432 return Widget\TagCloud::getHTML($uid, $limit, $owner_id, 'wall');
439 * @param string $url Base page URL
440 * @param int $uid User ID consulting/publishing posts
441 * @param bool $wall True: Posted by User; False: Posted to User (network timeline)
443 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
445 public static function postedByYear(string $url, int $uid, bool $wall): string
449 $visible_years = DI::pConfig()->get($uid, 'system', 'archive_visible_years', 5);
451 /* arrange the list in years */
452 $dnow = DateTimeFormat::localNow('Y-m-d');
456 $cachekey = 'Widget::postedByYear' . $uid . '-' . (int)$wall;
457 $dthen = DI::cache()->get($cachekey);
459 $dthen = Item::firstPostDate($uid, $wall);
460 DI::cache()->set($cachekey, $dthen, Duration::HOUR);
464 // Set the start and end date to the beginning of the month
465 $dnow = substr($dnow, 0, 8) . '01';
466 $dthen = substr($dthen, 0, 8) . '01';
469 * Starting with the current month, get the first and last days of every
470 * month down to and including the month of the first post
472 while (substr($dnow, 0, 7) >= substr($dthen, 0, 7)) {
473 $dyear = intval(substr($dnow, 0, 4));
474 $dstart = substr($dnow, 0, 8) . '01';
475 $dend = substr($dnow, 0, 8) . Temporal::getDaysInMonth(intval($dnow), intval(substr($dnow, 5)));
476 $start_month = DateTimeFormat::utc($dstart, 'Y-m-d');
477 $end_month = DateTimeFormat::utc($dend, 'Y-m-d');
478 $str = DI::l10n()->getDay(DateTimeFormat::utc($dnow, 'F'));
480 if (empty($ret[$dyear])) {
484 $ret[$dyear][] = [$str, $end_month, $start_month];
485 $dnow = DateTimeFormat::utc($dnow . ' -1 month', 'Y-m-d');
489 if (!DBA::isResult($ret)) {
494 $cutoff_year = intval(DateTimeFormat::localNow('Y')) - $visible_years;
495 $cutoff = array_key_exists($cutoff_year, $ret);
497 $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/posted_date.tpl'),[
498 '$title' => DI::l10n()->t('Archives'),
499 '$size' => $visible_years,
500 '$cutoff_year' => $cutoff_year,
501 '$cutoff' => $cutoff,
504 '$showless' => DI::l10n()->t('show less'),
505 '$showmore' => DI::l10n()->t('show more')
512 * Display the account types sidebar
513 * The account type value is added as a parameter to the url
515 * @param string $base Basepath
516 * @param string $accounttype Account type
519 public static function accountTypes(string $base, string $accounttype): string
522 ['ref' => 'person', 'name' => DI::l10n()->t('Persons')],
523 ['ref' => 'organisation', 'name' => DI::l10n()->t('Organisations')],
524 ['ref' => 'news', 'name' => DI::l10n()->t('News')],
525 ['ref' => 'community', 'name' => DI::l10n()->t('Forums')],
528 return self::filter('accounttype', DI::l10n()->t('Account Types'), '',
529 DI::l10n()->t('All'), $base, $accounts, $accounttype);