src/Content/Widget.php

   1 <?php
   2 /**
   3  * @file src/Content/Widget.php
   4  */
   5 namespace Friendica\Content;
   6
   7 use Friendica\Core\Addon;
   8 use Friendica\Core\Config;
   9 use Friendica\Core\L10n;
  10 use Friendica\Core\PConfig;
  11 use Friendica\Core\Protocol;
  12 use Friendica\Core\Renderer;
  13 use Friendica\Core\System;
  14 use Friendica\Core\Session;
  15 use Friendica\Database\DBA;
  16 use Friendica\Model\Contact;
  17 use Friendica\Model\FileTag;
  18 use Friendica\Model\GContact;
  19 use Friendica\Model\Item;
  20 use Friendica\Model\Profile;
  21 use Friendica\Util\DateTimeFormat;
  22 use Friendica\Util\Proxy as ProxyUtils;
  23 use Friendica\Util\Strings;
  24 use Friendica\Util\Temporal;
  25 use Friendica\Util\XML;
  26
  27 class Widget
  28 {
  29         /**
  30          * Return the follow widget
  31          *
  32          * @param string $value optional, default empty
  33          * @return string
  34          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  35          */
  36         public static function follow($value = "")
  37         {
  38                 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/follow.tpl'), array(
  39                         '$connect' => L10n::t('Add New Contact'),
  40                         '$desc' => L10n::t('Enter address or web location'),
  41                         '$hint' => L10n::t('Example: bob@example.com, http://example.com/barbara'),
  42                         '$value' => $value,
  43                         '$follow' => L10n::t('Connect')
  44                 ));
  45         }
  46
  47         /**
  48          * Return Find People widget
  49          */
  50         public static function findPeople()
  51         {
  52                 $a = \get_app();
  53                 $global_dir = Config::get('system', 'directory');
  54
  55                 if (Config::get('system', 'invitation_only')) {
  56                         $x = intval(PConfig::get(local_user(), 'system', 'invites_remaining'));
  57                         if ($x || is_site_admin()) {
  58                                 $a->page['aside'] .= '<div class="side-link widget" id="side-invite-remain">'
  59                                         . L10n::tt('%d invitation available', '%d invitations available', $x)
  60                                         . '</div>';
  61                         }
  62                 }
  63
  64                 $nv = [];
  65                 $nv['findpeople'] = L10n::t('Find People');
  66                 $nv['desc'] = L10n::t('Enter name or interest');
  67                 $nv['label'] = L10n::t('Connect/Follow');
  68                 $nv['hint'] = L10n::t('Examples: Robert Morgenstein, Fishing');
  69                 $nv['findthem'] = L10n::t('Find');
  70                 $nv['suggest'] = L10n::t('Friend Suggestions');
  71                 $nv['similar'] = L10n::t('Similar Interests');
  72                 $nv['random'] = L10n::t('Random Profile');
  73                 $nv['inv'] = L10n::t('Invite Friends');
  74                 $nv['directory'] = L10n::t('Global Directory');
  75                 $nv['global_dir'] = $global_dir;
  76                 $nv['local_directory'] = L10n::t('Local Directory');
  77
  78                 $aside = [];
  79                 $aside['$nv'] = $nv;
  80
  81                 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/peoplefind.tpl'), $aside);
  82         }
  83
  84         /**
  85          * Return unavailable networks
  86          */
  87         public static function unavailableNetworks()
  88         {
  89                 // Always hide content from these networks
  90                 $networks = ['face', 'apdn'];
  91
  92                 if (!Addon::isEnabled("statusnet")) {
  93                         $networks[] = Protocol::STATUSNET;
  94                 }
  95
  96                 if (!Addon::isEnabled("pumpio")) {
  97                         $networks[] = Protocol::PUMPIO;
  98                 }
  99
 100                 if (!Addon::isEnabled("twitter")) {
 101                         $networks[] = Protocol::TWITTER;
 102                 }
 103
 104                 if (Config::get("system", "ostatus_disabled")) {
 105                         $networks[] = Protocol::OSTATUS;
 106                 }
 107
 108                 if (!Config::get("system", "diaspora_enabled")) {
 109                         $networks[] = Protocol::DIASPORA;
 110                 }
 111
 112                 if (!Addon::isEnabled("pnut")) {
 113                         $networks[] = Protocol::PNUT;
 114                 }
 115
 116                 if (!sizeof($networks)) {
 117                         return "";
 118                 }
 119
 120                 $network_filter = implode("','", $networks);
 121
 122                 $network_filter = "AND `network` NOT IN ('$network_filter')";
 123
 124                 return $network_filter;
 125         }
 126
 127         /**
 128          * Display a generic filter widget based on a list of options
 129          *
 130          * The options array must be the following format:
 131          * [
 132          *    [
 133          *      'ref' => {filter value},
 134          *      'name' => {option name}
 135          *    ],
 136          *    ...
 137          * ]
 138          *
 139          * @param string $type The filter query string key
 140          * @param string $title
 141          * @param string $desc
 142          * @param string $all The no filter label
 143          * @param string $baseUrl The full page request URI
 144          * @param array  $options
 145          * @param string $selected The currently selected filter option value
 146          * @return string
 147          * @throws \Exception
 148          */
 149         private static function filter($type, $title, $desc, $all, $baseUrl, array $options, $selected = null)
 150         {
 151                 $queryString = parse_url($baseUrl, PHP_URL_QUERY);
 152                 $queryArray = [];
 153
 154                 if ($queryString) {
 155                         parse_str($queryString, $queryArray);
 156                         unset($queryArray[$type]);
 157
 158                         if (count($queryArray)) {
 159                                 $baseUrl = substr($baseUrl, 0, strpos($baseUrl, '?')) . '?' . http_build_query($queryArray) . '&';
 160                         } else {
 161                                 $baseUrl = substr($baseUrl, 0, strpos($baseUrl, '?')) . '?';
 162                         }
 163                 } else {
 164                         $baseUrl = trim($baseUrl, '?') . '?';
 165                 }
 166
 167                 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/filter.tpl'), [
 168                         '$type'      => $type,
 169                         '$title'     => $title,
 170                         '$desc'      => $desc,
 171                         '$selected'  => $selected,
 172                         '$all_label' => $all,
 173                         '$options'   => $options,
 174                         '$base'      => $baseUrl,
 175                 ]);
 176         }
 177
 178         /**
 179          * Return networks widget
 180          *
 181          * @param string $baseurl  baseurl
 182          * @param string $selected optional, default empty
 183          * @return string
 184          * @throws \Exception
 185          */
 186         public static function contactRels($baseurl, $selected = '')
 187         {
 188                 if (!local_user()) {
 189                         return '';
 190                 }
 191
 192                 $options = [
 193                         ['ref' => 'followers', 'name' => L10n::t('Followers')],
 194                         ['ref' => 'following', 'name' => L10n::t('Following')],
 195                         ['ref' => 'mutuals', 'name' => L10n::t('Mutual friends')],
 196                 ];
 197
 198                 return self::filter(
 199                         'rel',
 200                         L10n::t('Relationships'),
 201                         '',
 202                         L10n::t('All Contacts'),
 203                         $baseurl,
 204                         $options,
 205                         $selected
 206                 );
 207         }
 208
 209         /**
 210          * Return networks widget
 211          *
 212          * @param string $baseurl  baseurl
 213          * @param string $selected optional, default empty
 214          * @return string
 215          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 216          */
 217         public static function networks($baseurl, $selected = '')
 218         {
 219                 if (!local_user()) {
 220                         return '';
 221                 }
 222
 223                 if (!Feature::isEnabled(local_user(), 'networks')) {
 224                         return '';
 225                 }
 226
 227                 $extra_sql = self::unavailableNetworks();
 228
 229                 $r = DBA::p("SELECT DISTINCT(`network`) FROM `contact` WHERE `uid` = ? AND NOT `deleted` AND `network` != '' $extra_sql ORDER BY `network`",
 230                         local_user()
 231                 );
 232
 233                 $nets = array();
 234                 while ($rr = DBA::fetch($r)) {
 235                         $nets[] = ['ref' => $rr['network'], 'name' => ContactSelector::networkToName($rr['network'])];
 236                 }
 237                 DBA::close($r);
 238
 239                 if (count($nets) < 2) {
 240                         return '';
 241                 }
 242
 243                 return self::filter(
 244                         'nets',
 245                         L10n::t('Protocols'),
 246                         '',
 247                         L10n::t('All Protocols'),
 248                         $baseurl,
 249                         $nets,
 250                         $selected
 251                 );
 252         }
 253
 254         /**
 255          * Return file as widget
 256          *
 257          * @param string $baseurl  baseurl
 258          * @param string $selected optional, default empty
 259          * @return string|void
 260          * @throws \Exception
 261          */
 262         public static function fileAs($baseurl, $selected = '')
 263         {
 264                 if (!local_user()) {
 265                         return '';
 266                 }
 267
 268                 $saved = PConfig::get(local_user(), 'system', 'filetags');
 269                 if (!strlen($saved)) {
 270                         return;
 271                 }
 272
 273                 $terms = [];
 274                 foreach (FileTag::fileToArray($saved) as $savedFolderName) {
 275                         $terms[] = ['ref' => $savedFolderName, 'name' => $savedFolderName];
 276                 }
 277
 278                 return self::filter(
 279                         'file',
 280                         L10n::t('Saved Folders'),
 281                         '',
 282                         L10n::t('Everything'),
 283                         $baseurl,
 284                         $terms,
 285                         $selected
 286                 );
 287         }
 288
 289         /**
 290          * Return categories widget
 291          *
 292          * @param string $baseurl  baseurl
 293          * @param string $selected optional, default empty
 294          * @return string|void
 295          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 296          */
 297         public static function categories($baseurl, $selected = '')
 298         {
 299                 $a = \get_app();
 300
 301                 $uid = intval($a->profile['profile_uid']);
 302
 303                 if (!Feature::isEnabled($uid, 'categories')) {
 304                         return '';
 305                 }
 306
 307                 $saved = PConfig::get($uid, 'system', 'filetags');
 308                 if (!strlen($saved)) {
 309                         return;
 310                 }
 311
 312                 $terms = array();
 313                 foreach (FileTag::fileToArray($saved, 'category') as $savedFolderName) {
 314                         $terms[] = ['ref' => $savedFolderName, 'name' => $savedFolderName];
 315                 }
 316
 317                 return self::filter(
 318                         'category',
 319                         L10n::t('Categories'),
 320                         '',
 321                         L10n::t('Everything'),
 322                         $baseurl,
 323                         $terms,
 324                         $selected
 325                 );
 326         }
 327
 328         /**
 329          * Return common friends visitor widget
 330          *
 331          * @param string $profile_uid uid
 332          * @return string|void
 333          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 334          */
 335         public static function commonFriendsVisitor($profile_uid)
 336         {
 337                 if (local_user() == $profile_uid) {
 338                         return;
 339                 }
 340
 341                 $zcid = 0;
 342
 343                 $cid = Session::getRemoteContactID($profile_uid);
 344
 345                 if (!$cid) {
 346                         if (Profile::getMyURL()) {
 347                                 $contact = DBA::selectFirst('contact', ['id'],
 348                                                 ['nurl' => Strings::normaliseLink(Profile::getMyURL()), 'uid' => $profile_uid]);
 349                                 if (DBA::isResult($contact)) {
 350                                         $cid = $contact['id'];
 351                                 } else {
 352                                         $gcontact = DBA::selectFirst('gcontact', ['id'], ['nurl' => Strings::normaliseLink(Profile::getMyURL())]);
 353                                         if (DBA::isResult($gcontact)) {
 354                                                 $zcid = $gcontact['id'];
 355                                         }
 356                                 }
 357                         }
 358                 }
 359
 360                 if ($cid == 0 && $zcid == 0) {
 361                         return;
 362                 }
 363
 364                 if ($cid) {
 365                         $t = GContact::countCommonFriends($profile_uid, $cid);
 366                 } else {
 367                         $t = GContact::countCommonFriendsZcid($profile_uid, $zcid);
 368                 }
 369
 370                 if (!$t) {
 371                         return;
 372                 }
 373
 374                 if ($cid) {
 375                         $r = GContact::commonFriends($profile_uid, $cid, 0, 5, true);
 376                 } else {
 377                         $r = GContact::commonFriendsZcid($profile_uid, $zcid, 0, 5, true);
 378                 }
 379
 380                 if (!DBA::isResult($r)) {
 381                         return;
 382                 }
 383
 384                 $entries = [];
 385                 foreach ($r as $rr) {
 386                         $entry = [
 387                                 'url'   => Contact::magicLink($rr['url']),
 388                                 'name'  => $rr['name'],
 389                                 'photo' => ProxyUtils::proxifyUrl($rr['photo'], false, ProxyUtils::SIZE_THUMB),
 390                         ];
 391                         $entries[] = $entry;
 392                 }
 393
 394                 $tpl = Renderer::getMarkupTemplate('widget/remote_friends_common.tpl');
 395                 return Renderer::replaceMacros($tpl, [
 396                         '$desc'     => L10n::tt("%d contact in common", "%d contacts in common", $t),
 397                         '$base'     => System::baseUrl(),
 398                         '$uid'      => $profile_uid,
 399                         '$cid'      => (($cid) ? $cid : '0'),
 400                         '$linkmore' => (($t > 5) ? 'true' : ''),
 401                         '$more'     => L10n::t('show more'),
 402                         '$items'    => $entries
 403                 ]);
 404         }
 405
 406         /**
 407          * Insert a tag cloud widget for the present profile.
 408          *
 409          * @brief Insert a tag cloud widget for the present profile.
 410          * @param int $limit Max number of displayed tags.
 411          * @return string HTML formatted output.
 412          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 413          * @throws \ImagickException
 414          */
 415         public static function tagCloud($limit = 50)
 416         {
 417                 $a = \get_app();
 418
 419                 $uid = intval($a->profile['profile_uid']);
 420
 421                 if (!$uid || !$a->profile['url']) {
 422                         return '';
 423                 }
 424
 425                 if (Feature::isEnabled($uid, 'tagadelic')) {
 426                         $owner_id = Contact::getIdForURL($a->profile['url'], 0, true);
 427
 428                         if (!$owner_id) {
 429                                 return '';
 430                         }
 431                         return Widget\TagCloud::getHTML($uid, $limit, $owner_id, 'wall');
 432                 }
 433
 434                 return '';
 435         }
 436
 437         /**
 438          * @param string $url Base page URL
 439          * @param int    $uid User ID consulting/publishing posts
 440          * @param bool   $wall True: Posted by User; False: Posted to User (network timeline)
 441          * @return string
 442          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 443          */
 444         public static function postedByYear(string $url, int $uid, bool $wall)
 445         {
 446                 $o = '';
 447
 448                 if (!Feature::isEnabled($uid, 'archives')) {
 449                         return $o;
 450                 }
 451
 452                 $visible_years = PConfig::get($uid, 'system', 'archive_visible_years', 5);
 453
 454                 /* arrange the list in years */
 455                 $dnow = DateTimeFormat::localNow('Y-m-d');
 456
 457                 $ret = [];
 458
 459                 $dthen = Item::firstPostDate($uid, $wall);
 460                 if ($dthen) {
 461                         // Set the start and end date to the beginning of the month
 462                         $dnow = substr($dnow, 0, 8) . '01';
 463                         $dthen = substr($dthen, 0, 8) . '01';
 464
 465                         /*
 466                          * Starting with the current month, get the first and last days of every
 467                          * month down to and including the month of the first post
 468                          */
 469                         while (substr($dnow, 0, 7) >= substr($dthen, 0, 7)) {
 470                                 $dyear = intval(substr($dnow, 0, 4));
 471                                 $dstart = substr($dnow, 0, 8) . '01';
 472                                 $dend = substr($dnow, 0, 8) . Temporal::getDaysInMonth(intval($dnow), intval(substr($dnow, 5)));
 473                                 $start_month = DateTimeFormat::utc($dstart, 'Y-m-d');
 474                                 $end_month = DateTimeFormat::utc($dend, 'Y-m-d');
 475                                 $str = L10n::getDay(DateTimeFormat::utc($dnow, 'F'));
 476
 477                                 if (empty($ret[$dyear])) {
 478                                         $ret[$dyear] = [];
 479                                 }
 480
 481                                 $ret[$dyear][] = [$str, $end_month, $start_month];
 482                                 $dnow = DateTimeFormat::utc($dnow . ' -1 month', 'Y-m-d');
 483                         }
 484                 }
 485
 486                 if (!DBA::isResult($ret)) {
 487                         return $o;
 488                 }
 489
 490
 491                 $cutoff_year = intval(DateTimeFormat::localNow('Y')) - $visible_years;
 492                 $cutoff = array_key_exists($cutoff_year, $ret);
 493
 494                 $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/posted_date.tpl'),[
 495                         '$title' => L10n::t('Archives'),
 496                         '$size' => $visible_years,
 497                         '$cutoff_year' => $cutoff_year,
 498                         '$cutoff' => $cutoff,
 499                         '$url' => $url,
 500                         '$dates' => $ret,
 501                         '$showmore' => L10n::t('show more')
 502                 ]);
 503
 504                 return $o;
 505         }
 506 }