Merge pull request #7823 from annando/pin

We can now pin posts

src/Model/Item.php

@@ -58,7 +58,7 @@ class Item extends BaseObject
 		'author-id', 'author-link', 'author-name', 'author-avatar', 'author-network',
 		'owner-id', 'owner-link', 'owner-name', 'owner-avatar', 'owner-network',
 		'contact-id', 'contact-uid', 'contact-link', 'contact-name', 'contact-avatar',
-		'writable', 'self', 'cid', 'alias',
+		'writable', 'self', 'cid', 'alias', 'pinned',
 		'event-id', 'event-created', 'event-edited', 'event-start', 'event-finish',
 		'event-summary', 'event-desc', 'event-location', 'event-type',
 		'event-nofinish', 'event-adjust', 'event-ignore', 'event-id',
@@ -114,6 +114,60 @@ class Item extends BaseObject
 		return self::$legacy_mode;
 	}
 
+	/**
+	 * Set the pinned state of an item
+	 *
+	 * @param integer $iid    Item ID
+	 * @param integer $uid    User ID
+	 * @param boolean $pinned Pinned state
+	 */
+	public static function setPinned(int $iid, int $uid, bool $pinned)
+	{
+		DBA::update('user-item', ['pinned' => $pinned], ['iid' => $iid, 'uid' => $uid], true);
+	}
+
+	/**
+	 * Get the pinned state
+	 *
+	 * @param integer $iid Item ID
+	 * @param integer $uid User ID
+	 *
+	 * @return boolean pinned state
+	 */
+	public static function getPinned(int $iid, int $uid)
+	{
+		$useritem = DBA::selectFirst('user-item', ['pinned'], ['iid' => $iid, 'uid' => $uid]);
+		if (!DBA::isResult($useritem)) {
+			return false;
+		}
+		return (bool)$useritem['pinned'];
+	}
+
+	/**
+	 * @brief Select pinned rows from the item table for a given user
+	 *
+	 * @param integer $uid       User ID
+	 * @param array   $selected  Array of selected fields, empty for all
+	 *
+	 * @return boolean|object
+	 * @throws \Exception
+	 */
+	public static function selectPinned(int $uid, array $selected = [])
+	{
+		$useritems = DBA::select('user-item', ['iid'], ['uid' => $uid, 'pinned' => true]);
+		if (!DBA::isResult($useritems)) {
+			return $useritems;
+		}
+
+		$pinned = [];
+		while ($useritem = self::fetch($useritems)) {
+			$pinned[] = $useritem['iid'];
+		}
+		DBA::close($useritems);
+
+		return self::selectThreadForUser($uid, $selected, ['iid' => $pinned]);
+	}
+
 	/**
 	 * @brief returns an activity index from an activity string
 	 *
@@ -585,7 +639,7 @@ class Item extends BaseObject
 			'iaid' => 'internal-iaid'];
 
 		if ($usermode) {
-			$fields['user-item'] = ['ignored' => 'internal-user-ignored'];
+			$fields['user-item'] = ['pinned', 'ignored' => 'internal-user-ignored'];
 		}
 
 		$fields['item-activity'] = ['activity', 'activity' => 'internal-activity'];

src/Module/Profile.php

@@ -177,7 +177,7 @@ class Profile extends BaseModule
 		}
 
 		if (!$update) {
-            $tab = Strings::escapeTags(trim($_GET['tab'] ?? ''));
+			$tab = Strings::escapeTags(trim($_GET['tab'] ?? ''));
 
 			$o .= ProfileModel::getTabs($a, $tab, $is_owner, $a->profile['nickname']);
 
@@ -349,7 +349,13 @@ class Profile extends BaseModule
 
 		$items = DBA::toArray($items_stmt);
 
-		$o .= conversation($a, $items, $pager, 'profile', $update, false, 'received', $a->profile['profile_uid']);
+		if ($pager->getStart() == 0) {
+			$pinned_items = Item::selectPinned($a->profile['profile_uid'], ['uri']);
+			$pinned = Item::inArray($pinned_items);
+			$items = array_merge($items, $pinned);
+		}
+
+		$o .= conversation($a, $items, $pager, 'profile', $update, false, 'pinned_received', $a->profile['profile_uid']);
 
 		if (!$update) {
 			$o .= $pager->renderMinimal(count($items));

src/Object/Post.php

@@ -140,8 +140,11 @@ class Post extends BaseObject
 		$sparkle = '';
 		$buttons = '';
 		$dropping = false;
+		$pinned = '';
+		$pin = false;
 		$star = false;
 		$ignore = false;
+		$ispinned = "unpinned";
 		$isstarred = "unstarred";
 		$indent = '';
 		$shiny = '';
@@ -284,6 +287,23 @@ class Post extends BaseObject
 				}
 
 				if ($conv->getProfileOwner() == local_user() && ($item['uid'] != 0)) {
+					if ($origin) {
+						if ($item['pinned']) {
+							$pinned = L10n::t('pinned item');
+						}
+
+						$ispinned = ($item['pinned'] ? 'pinned' : 'unpinned');
+
+						$pin = [
+							'do'        => L10n::t('pin'),
+							'undo'      => L10n::t('unpin'),
+							'toggle'    => L10n::t('toggle pin status'),
+							'classdo'   => $item['pinned'] ? 'hidden' : '',
+							'classundo' => $item['pinned'] ? '' : 'hidden',
+							'pinned'   => L10n::t('pinned'),
+						];
+					}
+
 					$isstarred = (($item['starred']) ? "starred" : "unstarred");
 
 					$star = [
@@ -407,6 +427,9 @@ class Post extends BaseObject
 			'owner_name'      => $owner_name_e,
 			'plink'           => Item::getPlink($item),
 			'edpost'          => $edpost,
+			'ispinned'        => $ispinned,
+			'pin'             => $pin,
+			'pinned'          => $pinned,
 			'isstarred'       => $isstarred,
 			'star'            => $star,
 			'ignore'          => $ignore,