[aur-dev] [PATCH v4 2/2] Implement capability to pin comments above others
Mark Weiman
mark.weiman at markzz.com
Sat Dec 12 00:01:31 UTC 2015
Adds capability to pin comments before others.
Implements FS#10863
Signed-off-by: Mark Weiman <mark.weiman at markzz.com>
---
schema/aur-schema.sql | 1 +
upgrading/4.2.0.txt | 6 +++
web/html/css/aurweb.css | 6 +--
web/html/images/pin.min.svg | 1 +
web/html/images/pin.svg | 3 ++
web/html/images/unpin.min.svg | 1 +
web/html/images/unpin.svg | 4 ++
web/html/index.php | 2 +
web/html/pkgbase.php | 4 ++
web/lib/credentials.inc.php | 2 +
web/lib/pkgbasefuncs.inc.php | 85 ++++++++++++++++++++++++++++++++++++++++---
web/lib/pkgfuncs.inc.php | 51 +++++++++++++++++++++++++-
web/template/pkg_comments.php | 40 +++++++++++++++++---
13 files changed, 191 insertions(+), 15 deletions(-)
create mode 100644 web/html/images/pin.min.svg
create mode 100644 web/html/images/pin.svg
create mode 100644 web/html/images/unpin.min.svg
create mode 100644 web/html/images/unpin.svg
diff --git a/schema/aur-schema.sql b/schema/aur-schema.sql
index 315a75c..5561278 100644
--- a/schema/aur-schema.sql
+++ b/schema/aur-schema.sql
@@ -261,6 +261,7 @@ CREATE TABLE PackageComments (
EditedTS BIGINT UNSIGNED NULL DEFAULT NULL,
EditedUsersID INTEGER UNSIGNED NULL DEFAULT NULL,
DelUsersID INTEGER UNSIGNED NULL DEFAULT NULL,
+ PinnedTS BIGINT UNSIGNED NOT NULL DEFAULT 0,
PRIMARY KEY (ID),
INDEX (UsersID),
INDEX (PackageBaseID),
diff --git a/upgrading/4.2.0.txt b/upgrading/4.2.0.txt
index 1f92ec5..1450d5e 100644
--- a/upgrading/4.2.0.txt
+++ b/upgrading/4.2.0.txt
@@ -15,3 +15,9 @@ CREATE UNIQUE INDEX ProviderNameProvides ON OfficialProviders (Name, Provides);
----
ALTER TABLE Users MODIFY Email VARCHAR(254) NOT NULL;
----
+
+3. Add new column in PackageComments for pinning system.
+
+----
+ALTER TABLE PackageComments ADD COLUMN PinnedTS BIGINT UNSIGNED NOT NULL DEFAULT 0;
+----
diff --git a/web/html/css/aurweb.css b/web/html/css/aurweb.css
index 11af747..82b83d9 100644
--- a/web/html/css/aurweb.css
+++ b/web/html/css/aurweb.css
@@ -101,7 +101,7 @@
color: #999;
}
-.delete-comment-form, .edit-comment {
+.delete-comment-form, .pin-comment-form, .edit-comment {
float: right;
margin-left: 8px;
}
@@ -112,13 +112,13 @@
top: 1px;
}
-.delete-comment, .edit-comment {
+.delete-comment, .edit-comment, .pin-comment {
-webkit-filter: grayscale(100%);
filter: grayscale(100%);
opacity: 0.6;
}
-.delete-comment:hover, .edit-comment:hover {
+.delete-comment:hover, .edit-comment:hover, .pin-comment:hover {
-webkit-filter: none;
filter: none;
opacity: 1;
diff --git a/web/html/images/pin.min.svg b/web/html/images/pin.min.svg
new file mode 100644
index 0000000..ac08903
--- /dev/null
+++ b/web/html/images/pin.min.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8"><path style="fill:#3366aa;fill-opacity:1" d="M1.34 0a.5.5 0 0 0 .16 1h.5v2h-1c-.55 0-1 .45-1 1h3v3l.44 1 .56-1v-3h3c0-.55-.45-1-1-1h-1v-2h.5a.5.5 0 1 0 0-1h-4a.5.5 0 0 0-.09 0 .5.5 0 0 0-.06 0z" /></svg>
diff --git a/web/html/images/pin.svg b/web/html/images/pin.svg
new file mode 100644
index 0000000..b4ee9eb
--- /dev/null
+++ b/web/html/images/pin.svg
@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
+ <path style="fill:#3366aa;fill-opacity:1" d="M1.34 0a.5.5 0 0 0 .16 1h.5v2h-1c-.55 0-1 .45-1 1h3v3l.44 1 .56-1v-3h3c0-.55-.45-1-1-1h-1v-2h.5a.5.5 0 1 0 0-1h-4a.5.5 0 0 0-.09 0 .5.5 0 0 0-.06 0z" />
+</svg>
diff --git a/web/html/images/unpin.min.svg b/web/html/images/unpin.min.svg
new file mode 100644
index 0000000..3cf2413
--- /dev/null
+++ b/web/html/images/unpin.min.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8"><path style="fill:#3366aa;fill-opacity:1" d="M1.34 0a.5.5 0 0 0 .16 1h.5v2h-1c-.55 0-1 .45-1 1h3v3l.44 1 .56-1v-3h3c0-.55-.45-1-1-1h-1v-2h.5a.5.5 0 1 0 0-1h-4a.5.5 0 0 0-.09 0 .5.5 0 0 0-.06 0z" /><path style="fill:#3366aa;fill-opacity:1" d="m6.4 0l1 1-6.4 6.8-1-1z" /></svg>
diff --git a/web/html/images/unpin.svg b/web/html/images/unpin.svg
new file mode 100644
index 0000000..de89715
--- /dev/null
+++ b/web/html/images/unpin.svg
@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
+ <path style="fill:#3366aa;fill-opacity:1" d="M1.34 0a.5.5 0 0 0 .16 1h.5v2h-1c-.55 0-1 .45-1 1h3v3l.44 1 .56-1v-3h3c0-.55-.45-1-1-1h-1v-2h.5a.5.5 0 1 0 0-1h-4a.5.5 0 0 0-.09 0 .5.5 0 0 0-.06 0z" />
+ <path style="fill:#3366aa;fill-opacity:1" d="m6.4 0l1 1 -6.4 6.8 -1 -1z" />
+</svg>
diff --git a/web/html/index.php b/web/html/index.php
index ec99bb7..e99d22f 100644
--- a/web/html/index.php
+++ b/web/html/index.php
@@ -182,6 +182,8 @@ if (!empty($tokens[1]) && '/' . $tokens[1] == get_pkg_route()) {
break;
case "/images/x.min.svg":
case "/images/pencil.min.svg":
+ case "/images/pin.min.svg":
+ case "/images/unpin.min.svg":
header("Content-Type: image/svg+xml");
readfile("./$path");
break;
diff --git a/web/html/pkgbase.php b/web/html/pkgbase.php
index cbbf3cc..45b8084 100644
--- a/web/html/pkgbase.php
+++ b/web/html/pkgbase.php
@@ -99,6 +99,10 @@ if (check_token()) {
list($ret, $output) = pkgbase_notify($ids, false);
} elseif (current_action("do_DeleteComment")) {
list($ret, $output) = pkgbase_delete_comment();
+ } elseif (current_action("do_PinComment")) {
+ list($ret, $output) = pkgbase_pin_comment();
+ } elseif (current_action("do_UnpinComment")) {
+ list($ret, $output) = pkgbase_pin_comment(true);
} elseif (current_action("do_SetKeywords")) {
list($ret, $output) = pkgbase_set_keywords($base_id, preg_split("/[\s,;]+/", $_POST['keywords'], -1, PREG_SPLIT_NO_EMPTY));
} elseif (current_action("do_FileRequest")) {
diff --git a/web/lib/credentials.inc.php b/web/lib/credentials.inc.php
index 648d78c..71bf5ff 100644
--- a/web/lib/credentials.inc.php
+++ b/web/lib/credentials.inc.php
@@ -8,6 +8,7 @@ define("CRED_ACCOUNT_SEARCH", 5);
define("CRED_COMMENT_DELETE", 6);
define("CRED_COMMENT_VIEW_DELETED", 22);
define("CRED_COMMENT_EDIT", 25);
+define("CRED_COMMENT_PIN", 26);
define("CRED_PKGBASE_ADOPT", 7);
define("CRED_PKGBASE_SET_KEYWORDS", 8);
define("CRED_PKGBASE_DELETE", 9);
@@ -60,6 +61,7 @@ function has_credential($credential, $approved_users=array()) {
case CRED_COMMENT_DELETE:
case CRED_COMMENT_VIEW_DELETED:
case CRED_COMMENT_EDIT:
+ case CRED_COMMENT_PIN:
case CRED_PKGBASE_ADOPT:
case CRED_PKGBASE_SET_KEYWORDS:
case CRED_PKGBASE_DELETE:
diff --git a/web/lib/pkgbasefuncs.inc.php b/web/lib/pkgbasefuncs.inc.php
index afccc7d..91160d3 100644
--- a/web/lib/pkgbasefuncs.inc.php
+++ b/web/lib/pkgbasefuncs.inc.php
@@ -7,10 +7,11 @@ include_once("pkgreqfuncs.inc.php");
*
* @param string $base_id The package base ID to get comment count for
* @param bool $include_deleted True if deleted comments should be included
+ * @param bool $only_pinned True if only pinned comments should be included
*
* @return string The number of comments left for a specific package
*/
-function pkgbase_comments_count($base_id, $include_deleted) {
+function pkgbase_comments_count($base_id, $include_deleted, $only_pinned=false) {
$base_id = intval($base_id);
if (!$base_id) {
return null;
@@ -20,7 +21,10 @@ function pkgbase_comments_count($base_id, $include_deleted) {
$q = "SELECT COUNT(*) FROM PackageComments ";
$q.= "WHERE PackageBaseID = " . $base_id . " ";
if (!$include_deleted) {
- $q.= "AND DelUsersID IS NULL";
+ $q.= "AND DelUsersID IS NULL ";
+ }
+ if ($only_pinned) {
+ $q.= "AND NOT PinnedTS = 0";
}
$result = $dbh->query($q);
if (!$result) {
@@ -36,10 +40,11 @@ function pkgbase_comments_count($base_id, $include_deleted) {
* @param int $base_id The package base ID to get comments for
* @param int $limit Maximum number of comments to return (0 means unlimited)
* @param bool $include_deleted True if deleted comments should be included
+ * @param bool $only_pinned True when only pinned comments are to be included
*
* @return array All package comment information for a specific package base
*/
-function pkgbase_comments($base_id, $limit, $include_deleted) {
+function pkgbase_comments($base_id, $limit, $include_deleted, $only_pinned=false) {
$base_id = intval($base_id);
$limit = intval($limit);
if (!$base_id) {
@@ -48,12 +53,17 @@ function pkgbase_comments($base_id, $limit, $include_deleted) {
$dbh = DB::connect();
$q = "SELECT PackageComments.ID, A.UserName AS UserName, UsersID, Comments, ";
- $q.= "CommentTS, EditedTS, B.UserName AS EditUserName, ";
- $q.= "DelUsersID, C.UserName AS DelUserName FROM PackageComments ";
+ $q.= "PackageBaseID, CommentTS, EditedTS, B.UserName AS EditUserName, ";
+ $q.= "DelUsersID, C.UserName AS DelUserName, ";
+ $q.= "PinnedTS FROM PackageComments ";
$q.= "LEFT JOIN Users A ON PackageComments.UsersID = A.ID ";
$q.= "LEFT JOIN Users B ON PackageComments.EditedUsersID = B.ID ";
$q.= "LEFT JOIN Users C ON PackageComments.DelUsersID = C.ID ";
$q.= "WHERE PackageBaseID = " . $base_id . " ";
+
+ if ($only_pinned) {
+ $q.= "AND NOT PinnedTS = 0 ";
+ }
if (!$include_deleted) {
$q.= "AND DelUsersID IS NULL ";
}
@@ -111,6 +121,61 @@ function pkgbase_add_comment($base_id, $uid, $comment) {
}
/**
+ * Pin/unpin a package comment
+ *
+ * @param bool $unpin True if unpinning rather than pinning
+ *
+ * @return array Tuple of success/failure indicator and error message
+ */
+function pkgbase_pin_comment($unpin=false) {
+ $uid = uid_from_sid($_COOKIE["AURSID"]);
+
+ if (!$uid) {
+ return array(false, __("You must be logged in before you can edit package information."));
+ }
+
+ if (isset($_POST["comment_id"])) {
+ $comment_id = $_POST["comment_id"];
+ } else {
+ return array(false, __("Missing comment ID."));
+ }
+
+ if (!$unpin) {
+ if (pkgbase_comments_count($_POST['package_base'], false, true) >= 5){
+ return array(false, __("No more than 5 comments can be pinned."));
+ }
+ }
+
+ if (!can_pin_comment($comment_id)) {
+ if (!$unpin) {
+ return array(false, __("You are not allowed to pin this comment."));
+ }
+ else {
+ return array(false, __("You are not allowed to unpin this comment."));
+ }
+ }
+
+ $dbh = DB::connect();
+ $q = "UPDATE PackageComments ";
+ if (!$unpin) {
+ $q.= "SET PinnedTS = UNIX_TIMESTAMP() ";
+ }
+ else {
+ $q.= "SET PinnedTS = 0 ";
+ }
+ $q.= "WHERE ID = ".intval($comment_id);
+ $dbh->exec($q);
+
+ if (!$unpin) {
+ return array(true, __("Comment has been pinned."));
+ }
+ else {
+ return array(true, __("Comment has been unpinned."));
+ }
+}
+
+/**
+
* Get a list of all packages a logged-in user has voted for
*
* @param string $sid The session ID of the visitor
@@ -197,8 +262,16 @@ function pkgbase_display_details($base_id, $row, $SID="") {
include('pkg_comment_box.php');
}
- $limit = isset($_GET['comments']) ? 0 : 10;
$include_deleted = has_credential(CRED_COMMENT_VIEW_DELETED);
+
+ $limit_pinned = isset($_GET['pinned']) ? 0 : 5;
+ $pinned = pkgbase_comments($base_id, $limit_pinned, false, true);
+ if (!empty($pinned)) {
+ include('pkg_comments.php');
+ unset($pinned);
+ }
+
+ $limit = isset($_GET['comments']) ? 0 : 10;
$comments = pkgbase_comments($base_id, $limit, $include_deleted);
if (!empty($comments)) {
include('pkg_comments.php');
diff --git a/web/lib/pkgfuncs.inc.php b/web/lib/pkgfuncs.inc.php
index cedc360..c2bbe38 100644
--- a/web/lib/pkgfuncs.inc.php
+++ b/web/lib/pkgfuncs.inc.php
@@ -83,6 +83,47 @@ function can_edit_comment_array($comment) {
}
/**
+ * Determine if the user can pin a specific package comment
+ *
+ * Only the Package Maintainer, Trusted Users, and Developers can pin
+ * comments. This function is used for the backend side of comment pinning.
+ *
+ * @param string $comment_id The comment ID in the database
+ *
+ * @return bool True if the user can pin the comment, otherwise false
+ */
+function can_pin_comment($comment_id=0) {
+ $dbh = DB::connect();
+
+ $q = "SELECT MaintainerUID FROM PackageBases AS pb ";
+ $q.= "LEFT JOIN PackageComments AS pc ON pb.ID = pc.PackageBaseID ";
+ $q.= "WHERE pc.ID = " . intval($comment_id);
+ $result = $dbh->query($q);
+
+ if (!$result) {
+ return false;
+ }
+
+ $uid = $result->fetch(PDO::FETCH_COLUMN, 0);
+
+ return has_credential(CRED_COMMENT_PIN, array($uid));
+}
+
+/**
+ * Determine if the user can edit a specific package comment using an array
+ *
+ * Only the Package Maintainer, Trusted Users, and Developers can pin
+ * comments. This function is used for the frontend side of comment pinning.
+ *
+ * @param array $comment All database information relating a specific comment
+ *
+ * @return bool True if the user can edit the comment, otherwise false
+ */
+function can_pin_comment_array($comment) {
+ return can_pin_comment($comment['ID']);
+}
+
+/**
* Check to see if the package name already exists in the database
*
* @param string $name The package name to check
@@ -582,8 +623,16 @@ function pkg_display_details($id=0, $row, $SID="") {
include('pkg_comment_box.php');
}
- $limit = isset($_GET['comments']) ? 0 : 10;
$include_deleted = has_credential(CRED_COMMENT_VIEW_DELETED);
+
+ $limit_pinned = isset($_GET['pinned']) ? 0 : 5;
+ $pinned = pkgbase_comments($base_id, $limit_pinned, false, true);
+ if (!empty($pinned)) {
+ include('pkg_comments.php');
+ unset($pinned);
+ }
+
+ $limit = isset($_GET['comments']) ? 0 : 10;
$comments = pkgbase_comments($base_id, $limit, $include_deleted);
if (!empty($comments)) {
include('pkg_comments.php');
diff --git a/web/template/pkg_comments.php b/web/template/pkg_comments.php
index 15547ce..2046364 100644
--- a/web/template/pkg_comments.php
+++ b/web/template/pkg_comments.php
@@ -1,11 +1,18 @@
<?php
-$include_deleted = has_credential(CRED_COMMENT_VIEW_DELETED);
-$count = pkgbase_comments_count($base_id, $include_deleted);
+if (!isset($count)) {
+ $count = pkgbase_comments_count($base_id, $include_deleted);
+}
?>
<div id="news">
<h3>
- <a href="<?= htmlentities(get_pkgbase_uri($pkgbase_name), ENT_QUOTES) . '?' . mkurl('comments=all') ?>" title="<?= __('View all comments' , $count) ?> (<?= $count ?>)"><?= __('Latest Comments') ?></a>
- <span class="arrow"></span>
+ <?php if (!isset($comments)): ?>
+ <?php $comments = $pinned ?>
+ <a href="<?= htmlentities(get_pkgbase_uri($pkgbase_name), ENT_QUOTES) . '?' . mkurl('comments=all') ?>" title="<?= __('View all comments' , $count) ?> (<?= $count ?>)"><?= __('Pinned Comments') ?></a>
+ <span class="arrow"></span>
+ <?php else: ?>
+ <a href="<?= htmlentities(get_pkgbase_uri($pkgbase_name), ENT_QUOTES) . '?' . mkurl('comments=all') ?>" title="<?= __('View all comments' , $count) ?> (<?= $count ?>)"><?= __('Latest Comments') ?></a>
+ <span class="arrow"></span>
+ <?php endif; ?>
</h3>
<?php while (list($indx, $row) = each($comments)): ?>
@@ -49,6 +56,29 @@ $count = pkgbase_comments_count($base_id, $include_deleted);
<?php if (!$row['DelUsersID'] && can_edit_comment_array($row)): ?>
<a href="<?= htmlspecialchars(get_pkgbase_uri($pkgbase_name) . 'edit-comment/?comment_id=' . $row['ID'], ENT_QUOTES) ?>" class="edit-comment" title="<?= __('Edit comment') ?>"><img src="/images/pencil.min.svg" alt="<?= __('Edit comment') ?>" width="11" height="11"></a>
<?php endif; ?>
+
+ <?php if (!$row['DelUsersID'] && !$row['PinnedTS'] && can_pin_comment_array($row) && !(pkgbase_comments_count($base_id, false, true) >= 5)): ?>
+ <form class="pin-comment-form" method="post" action="<?= htmlspecialchars(get_pkgbase_uri($pkgbase_name), ENT_QUOTES); ?>">
+ <fieldset style="display:inline;">
+ <input type="hidden" name="action" value="do_PinComment" />
+ <input type="hidden" name="comment_id" value="<?= $row['ID'] ?>" />
+ <input type="hidden" name="package_base" value="<?= $base_id ?>" />
+ <input type="hidden" name="token" value="<?= htmlspecialchars($_COOKIE['AURSID']) ?>" />
+ <input type="image" class="pin-comment" src="/images/pin.min.svg" width="11" height="11" alt="<?= __('Pin comment') ?>" title="<?= __('Pin comment') ?>" name="submit" value="1" />
+ </fieldset>
+ </form>
+ <?php endif; ?>
+
+ <?php if (!$row['DelUsersID'] && $row['PinnedTS'] && can_pin_comment_array($row)): ?>
+ <form class="pin-comment-form" method="post" action="<?= htmlspecialchars(get_pkgbase_uri($pkgbase_name), ENT_QUOTES); ?>">
+ <fieldset style="display:inline;">
+ <input type="hidden" name="action" value="do_UnpinComment" />
+ <input type="hidden" name="comment_id" value="<?= $row['ID'] ?>" />
+ <input type="hidden" name="token" value="<?= htmlspecialchars($_COOKIE['AURSID']) ?>" />
+ <input type="image" class="pin-comment" src="/images/unpin.min.svg" width="11" height="11" alt="<?= __('Unpin comment') ?>" title="<?= __('Unpin comment') ?>" name="submit" value="1" />
+ </fieldset>
+ </form>
+ <?php endif; ?>
</h4>
<div class="article-content<?php if ($row['DelUsersID']): ?> comment-deleted<?php endif; ?>">
<p>
@@ -57,7 +87,7 @@ $count = pkgbase_comments_count($base_id, $include_deleted);
</div>
<?php endwhile; ?>
-<?php if ($count > 10 && !isset($_GET['comments'])): ?>
+<?php if ($count > 10 && !isset($_GET['comments']) && !isset($pinned)): ?>
<h3>
<a href="<?= htmlentities(get_pkgbase_uri($pkgbase_name), ENT_QUOTES) . '?' . mkurl('comments=all') ?>" title="<?= __('View all comments') ?> (<?= $count ?>)"><?= __('All comments', $count) ?></a>
</h3>
--
2.6.4
More information about the aur-dev
mailing list