sascha
/
nextcloud-server
mirror of https://github.com/nextcloud/server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9129 from nextcloud/feature/noid/proper-comments-offset 

Add proper comment offset support
pull/9272/head
Roeland Jago Douma 2018-04-22 20:47:30 +07:00 committed by GitHub
parent 9f4e928c0f cccdfaa6e9
commit 0ed6f9c2da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 185 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
lib/private/Comments/Manager.php
Unescape Escape View File

@ -376,6 +376,123 @@ class Manager implements ICommentsManager {
return $comments;
}
/**
* @param string $objectType the object type, e.g. 'files'
* @param string $objectId the id of the object
* @param int $lastKnownCommentId the last known comment (will be used as offset)
* @param string $sortDirection direction of the comments (`asc` or `desc`)
* @param int $limit optional, number of maximum comments to be returned. if
* set to 0, all comments are returned.
* @return IComment[]
* @return array
*/
public function getForObjectSince(
string $objectType,
string $objectId,
int $lastKnownCommentId,
string $sortDirection = 'asc',
int $limit = 30
): array {
$comments = [];
$query = $this->dbConn->getQueryBuilder();
$query->select('*')
->from('comments')
->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType)))
->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)))
->orderBy('creation_timestamp', $sortDirection === 'desc' ? 'DESC' : 'ASC')
->addOrderBy('id', $sortDirection === 'desc' ? 'DESC' : 'ASC');
if ($limit > 0) {
$query->setMaxResults($limit);
}
$lastKnownComment = $this->getLastKnownComment(
$objectType,
$objectId,
$lastKnownCommentId
);
if ($lastKnownComment instanceof IComment) {
$lastKnownCommentDateTime = $lastKnownComment->getCreationDateTime();
if ($sortDirection === 'desc') {
$query->andWhere(
$query->expr()->orX(
$query->expr()->lt(
'creation_timestamp',
$query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
IQueryBuilder::PARAM_DATE
),
$query->expr()->andX(
$query->expr()->eq(
'creation_timestamp',
$query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
IQueryBuilder::PARAM_DATE
),
$query->expr()->lt('id', $query->createNamedParameter($lastKnownCommentId))
)
)
);
} else {
$query->andWhere(
$query->expr()->orX(
$query->expr()->gt(
'creation_timestamp',
$query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
IQueryBuilder::PARAM_DATE
),
$query->expr()->andX(
$query->expr()->eq(
'creation_timestamp',
$query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
IQueryBuilder::PARAM_DATE
),
$query->expr()->gt('id', $query->createNamedParameter($lastKnownCommentId))
)
)
);
}
}
$resultStatement = $query->execute();
while ($data = $resultStatement->fetch()) {
$comment = new Comment($this->normalizeDatabaseData($data));
$this->cache($comment);
$comments[] = $comment;
}
$resultStatement->closeCursor();
return $comments;
}
/**
* @param string $objectType the object type, e.g. 'files'
* @param string $objectId the id of the object
* @param int $id the comment to look for
* @return Comment|null
*/
protected function getLastKnownComment(string $objectType,
string $objectId,
int $id) {
$query = $this->dbConn->getQueryBuilder();
$query->select('*')
->from('comments')
->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType)))
->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)))
->andWhere($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
$result = $query->execute();
$row = $result->fetch();
$result->closeCursor();
if ($row) {
$comment = new Comment($this->normalizeDatabaseData($row));
$this->cache($comment);
return $comment;
}
return null;
}
/**
* @param $objectType string the object type, e.g. 'files'
* @param $objectId string the id of the object

18
lib/public/Comments/ICommentsManager.php
Unescape Escape View File

@ -120,6 +120,24 @@ interface ICommentsManager {
\DateTime $notOlderThan = null
);
/**
* @param string $objectType the object type, e.g. 'files'
* @param string $objectId the id of the object
* @param int $lastKnownCommentId the last known comment (will be used as offset)
* @param string $sortDirection direction of the comments (`asc` or `desc`)
* @param int $limit optional, number of maximum comments to be returned. if
* set to 0, all comments are returned.
* @return IComment[]
* @since 14.0.0
*/
public function getForObjectSince(
string $objectType,
string $objectId,
int $lastKnownCommentId,
string $sortDirection = 'asc',
int $limit = 30
): array;
/**
* @param $objectType string the object type, e.g. 'files'
* @param $objectId string the id of the object

8
tests/lib/Comments/FakeManager.php
Unescape Escape View File

@ -22,6 +22,14 @@ class FakeManager implements ICommentsManager {
\DateTime $notOlderThan = null
) {}
public function getForObjectSince(
string $objectType,
string $objectId,
int $lastKnownCommentId,
string $sortDirection = 'asc',
int $limit = 30
): array { return []; }
public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {}
public function create($actorType, $actorId, $objectType, $objectId) {}

42
tests/lib/Comments/ManagerTest.php
Unescape Escape View File

@ -354,6 +354,48 @@ class ManagerTest extends TestCase {
], $amount);
}
/**
* @dataProvider dataGetForObjectSince
* @param $lastKnown
* @param $order
* @param $limit
* @param $resultFrom
* @param $resultTo
*/
public function testGetForObjectSince($lastKnown, $order, $limit, $resultFrom, $resultTo) {
$ids = [];
$ids[] = $this->addDatabaseEntry(0, 0);
$ids[] = $this->addDatabaseEntry(0, 0);
$ids[] = $this->addDatabaseEntry(0, 0);
$ids[] = $this->addDatabaseEntry(0, 0);
$ids[] = $this->addDatabaseEntry(0, 0);
$manager = $this->getManager();
$comments = $manager->getForObjectSince('files', 'file64', ($lastKnown === null ? 0 : $ids[$lastKnown]), $order, $limit);
$expected = array_slice($ids, $resultFrom, $resultTo - $resultFrom + 1);
if ($order === 'desc') {
$expected = array_reverse($expected);
}
$this->assertSame($expected, array_map(function(IComment $c) {
return (int) $c->getId();
}, $comments));
}
public function dataGetForObjectSince() {
return [
[null, 'asc', 20, 0, 4],
[null, 'asc', 2, 0, 1],
[null, 'desc', 20, 0, 4],
[null, 'desc', 2, 3, 4],
[1, 'asc', 20, 2, 4],
[1, 'asc', 2, 2, 3],
[3, 'desc', 20, 0, 2],
[3, 'desc', 2, 1, 2],
];
}
public function invalidCreateArgsProvider() {
return [
['', 'aId-1', 'oType-1', 'oId-1'],