Files
sysPass/lib/SP/Repositories/Notification/NotificationRepository.php
Rubén D 6197c52af1 * [MOD] Update copyright date
* [MOD] Code cleanup

Signed-off-by: Rubén D <nuxsmin@syspass.org>
2019-04-27 02:48:18 +02:00

620 lines
18 KiB
PHP

<?php
/**
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2019, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Repositories\Notification;
use RuntimeException;
use SP\Core\Exceptions\ConstraintException;
use SP\Core\Exceptions\QueryException;
use SP\DataModel\ItemSearchData;
use SP\DataModel\NotificationData;
use SP\Mvc\Model\QueryCondition;
use SP\Repositories\Repository;
use SP\Repositories\RepositoryItemInterface;
use SP\Repositories\RepositoryItemTrait;
use SP\Storage\Database\QueryData;
use SP\Storage\Database\QueryResult;
/**
* Class NotificationRepository
*
* @package SP\Repositories\Notification
*/
final class NotificationRepository extends Repository implements RepositoryItemInterface
{
use RepositoryItemTrait;
/**
* Creates an item
*
* @param NotificationData $itemData
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function create($itemData)
{
$query = /** @lang SQL */
'INSERT INTO Notification
SET type = ?,
component = ?,
description = ?,
`date` = UNIX_TIMESTAMP(),
checked = 0,
userId = ?,
sticky = ?,
onlyAdmin = ?';
$queryData = new QueryData();
$queryData->setQuery($query);
$queryData->setParams([
$itemData->getType(),
$itemData->getComponent(),
$itemData->getDescription(),
$itemData->getUserId() ?: null,
$itemData->isSticky(),
$itemData->isOnlyAdmin()
]);
$queryData->setOnErrorMessage(__u('Error while adding the notification'));
return $this->db->doQuery($queryData);
}
/**
* Updates an item
*
* @param NotificationData $itemData
*
* @return int
* @throws ConstraintException
* @throws QueryException
*/
public function update($itemData)
{
$query = /** @lang SQL */
'UPDATE Notification
SET type = ?,
component = ?,
description = ?,
`date` = UNIX_TIMESTAMP(),
checked = ?,
userId = ?,
sticky = ?,
onlyAdmin = ?
WHERE id = ? LIMIT 1';
$queryData = new QueryData();
$queryData->setQuery($query);
$queryData->setParams([
$itemData->getType(),
$itemData->getComponent(),
$itemData->getDescription(),
$itemData->isChecked(),
$itemData->getUserId() ?: null,
$itemData->isSticky(),
$itemData->isOnlyAdmin(),
$itemData->getId()
]);
$queryData->setOnErrorMessage(__u('Error while updating the notification'));
return $this->db->doQuery($queryData)->getAffectedNumRows();
}
/**
* Deletes an item
*
* @param $id
*
* @return int
* @throws ConstraintException
* @throws QueryException
*/
public function delete($id)
{
$queryData = new QueryData();
$queryData->setQuery('DELETE FROM Notification WHERE id = ? AND sticky = 0 LIMIT 1');
$queryData->addParam($id);
$queryData->setOnErrorMessage(__u('Error while deleting the notification'));
return $this->db->doQuery($queryData)->getAffectedNumRows();
}
/**
* Deletes an item
*
* @param $id
*
* @return int
* @throws ConstraintException
* @throws QueryException
*/
public function deleteAdmin($id)
{
$queryData = new QueryData();
$queryData->setQuery('DELETE FROM Notification WHERE id = ? LIMIT 1');
$queryData->addParam($id);
$queryData->setOnErrorMessage(__u('Error while deleting the notification'));
return $this->db->doQuery($queryData)->getAffectedNumRows();
}
/**
* Deletes an item
*
* @param array $ids
*
* @return int
* @throws ConstraintException
* @throws QueryException
*/
public function deleteAdminBatch(array $ids)
{
if (empty($ids)) {
return 0;
}
$queryData = new QueryData();
$queryData->setQuery('DELETE FROM Notification WHERE id IN (' . $this->getParamsFromArray($ids) . ')');
$queryData->setParams($ids);
$queryData->setOnErrorMessage(__u('Error while deleting the notifications'));
return $this->db->doQuery($queryData)->getAffectedNumRows();
}
/**
* Returns the item for given id
*
* @param int $id
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function getById($id)
{
$query = /** @lang SQL */
'SELECT id,
type,
component,
description,
`date`,
userId,
checked,
sticky,
onlyAdmin
FROM Notification
WHERE id = ? LIMIT 1';
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setQuery($query);
$queryData->addParam($id);
$queryData->setOnErrorMessage(__u('Error while retrieving notification'));
return $this->db->doSelect($queryData);
}
/**
* Returns all the items
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function getAll()
{
$query = /** @lang SQL */
'SELECT id,
type,
component,
description,
`date`,
userId,
checked,
sticky,
onlyAdmin
FROM Notification
ORDER BY id';
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setQuery($query);
$queryData->setOnErrorMessage(__u('Error while retrieving the notifications'));
return $this->db->doSelect($queryData);
}
/**
* Returns all the items for given ids
*
* @param array $ids
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function getByIdBatch(array $ids)
{
if (empty($ids)) {
return new QueryResult();
}
$query = /** @lang SQL */
'SELECT id,
type,
component,
description,
`date`,
userId,
checked,
sticky,
onlyAdmin
FROM Notification
WHERE id IN (' . $this->getParamsFromArray($ids) . ')
ORDER BY id';
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setQuery($query);
$queryData->setParams($ids);
return $this->db->doSelect($queryData);
}
/**
* Deletes all the items for given ids
*
* @param array $ids
*
* @return int
* @throws ConstraintException
* @throws QueryException
*/
public function deleteByIdBatch(array $ids)
{
if (empty($ids)) {
return 0;
}
$queryData = new QueryData();
$queryData->setQuery('DELETE FROM Notification WHERE id IN (' . $this->getParamsFromArray($ids) . ') AND sticky = 0');
$queryData->setParams($ids);
$queryData->setOnErrorMessage(__u('Error while deleting the notifications'));
return $this->db->doQuery($queryData)->getAffectedNumRows();
}
/**
* Checks whether the item is in use or not
*
* @param $id int
*/
public function checkInUse($id)
{
throw new RuntimeException('Not implemented');
}
/**
* Checks whether the item is duplicated on updating
*
* @param mixed $itemData
*/
public function checkDuplicatedOnUpdate($itemData)
{
throw new RuntimeException('Not implemented');
}
/**
* Checks whether the item is duplicated on adding
*
* @param mixed $itemData
*/
public function checkDuplicatedOnAdd($itemData)
{
throw new RuntimeException('Not implemented');
}
/**
* Searches for items by a given filter
*
* @param ItemSearchData $itemSearchData
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function search(ItemSearchData $itemSearchData)
{
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setSelect('id, type, component, description, `date`, checked, userId, sticky, onlyAdmin');
$queryData->setFrom('Notification');
$queryData->setOrder('`date` DESC');
if ($itemSearchData->getSeachString() !== '') {
$queryData->setWhere('type LIKE ? OR component LIKE ? OR description LIKE ?');
$search = '%' . $itemSearchData->getSeachString() . '%';
$queryData->addParam($search);
$queryData->addParam($search);
$queryData->addParam($search);
}
$queryData->setLimit(
'?,?',
[$itemSearchData->getLimitStart(), $itemSearchData->getLimitCount()]
);
return $this->db->doSelect($queryData, true);
}
/**
* Searches for items by a given filter
*
* @param ItemSearchData $itemSearchData
* @param int $userId
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function searchForUserId(ItemSearchData $itemSearchData, $userId)
{
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setSelect('id, type, component, description, `date`, checked, userId, sticky, onlyAdmin');
$queryData->setFrom('Notification');
$queryData->setOrder('`date` DESC');
$queryCondition = new QueryCondition();
$queryCondition->addFilter('userId = ?', [$userId]);
$queryCondition->addFilter('(userId IS NULL AND onlyAdmin = 0)');
$queryCondition->addFilter('sticky = 1');
if ($itemSearchData->getSeachString() !== '') {
$queryData->setWhere(
'(type LIKE ? OR component LIKE ? OR description LIKE ?) AND '
. $queryCondition->getFilters(QueryCondition::CONDITION_OR)
);
$search = '%' . $itemSearchData->getSeachString() . '%';
$queryData->setParams(array_merge([$search, $search, $search], $queryCondition->getParams()));
} else {
$queryData->setWhere($queryCondition->getFilters(QueryCondition::CONDITION_OR));
$queryData->setParams($queryCondition->getParams());
}
$queryData->setLimit(
'?,?',
[$itemSearchData->getLimitStart(), $itemSearchData->getLimitCount()]
);
return $this->db->doSelect($queryData, true);
}
/**
* Searches for items by a given filter
*
* @param ItemSearchData $itemSearchData
* @param int $userId
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function searchForAdmin(ItemSearchData $itemSearchData, $userId)
{
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setSelect('id, type, component, description, `date`, checked, userId, sticky, onlyAdmin');
$queryData->setFrom('Notification');
$queryData->setOrder('`date` DESC');
$queryCondition = new QueryCondition();
$queryCondition->addFilter('userId = ?', [$userId]);
$queryCondition->addFilter('onlyAdmin = 1');
$queryCondition->addFilter('sticky = 1');
if ($itemSearchData->getSeachString() !== '') {
$queryData->setWhere(
'(type LIKE ? OR component LIKE ? OR description LIKE ?) AND '
. $queryCondition->getFilters(QueryCondition::CONDITION_OR)
);
$search = '%' . $itemSearchData->getSeachString() . '%';
$queryData->setParams(array_merge([$search, $search, $search], $queryCondition->getParams()));
} else {
$queryData->setWhere($queryCondition->getFilters(QueryCondition::CONDITION_OR));
$queryData->setParams($queryCondition->getParams());
}
$queryData->setLimit(
'?,?',
[$itemSearchData->getLimitStart(), $itemSearchData->getLimitCount()]
);
return $this->db->doSelect($queryData, true);
}
/**
* Marcar una notificación como leída
*
* @param $id
*
* @return int
* @throws ConstraintException
* @throws QueryException
*/
public function setCheckedById($id)
{
$query = /** @lang SQL */
'UPDATE Notification SET checked = 1 WHERE id = ? LIMIT 1';
$queryData = new QueryData();
$queryData->setQuery($query);
$queryData->addParam($id);
$queryData->setOnErrorMessage(__u('Error while updating the notification'));
return $this->db->doQuery($queryData)->getAffectedNumRows();
}
/**
* Devolver las notificaciones de un usuario para una fecha y componente determinados
*
* @param $component
* @param $userId
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function getForUserIdByDate($component, $userId)
{
$query = /** @lang SQL */
'SELECT id,
type,
component,
description,
`date`,
userId,
checked,
sticky,
onlyAdmin
FROM Notification
WHERE component = ?
AND (UNIX_TIMESTAMP() - `date`) <= 86400
AND userId = ?
ORDER BY id';
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setQuery($query);
$queryData->setParams([$component, $userId]);
$queryData->setOnErrorMessage(__u('Error while retrieving the notifications'));
return $this->db->doSelect($queryData);
}
/**
* @param $id
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function getAllForUserId($id)
{
$query = /** @lang SQL */
'SELECT id,
type,
component,
description,
`date`,
userId,
checked,
sticky,
onlyAdmin
FROM Notification
WHERE (userId = ? OR (userId IS NULL AND sticky = 1))
AND onlyAdmin = 0
ORDER BY `date` DESC ';
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setQuery($query);
$queryData->addParam($id);
$queryData->setOnErrorMessage(__u('Error while retrieving the notifications'));
return $this->db->doSelect($queryData);
}
/**
* @param $id
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function getAllActiveForUserId($id)
{
$query = /** @lang SQL */
'SELECT id,
type,
component,
description,
`date`,
userId,
checked,
sticky,
onlyAdmin
FROM Notification
WHERE (userId = ? OR sticky = 1)
AND onlyAdmin = 0
AND checked = 0
ORDER BY `date` DESC ';
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setQuery($query);
$queryData->addParam($id);
$queryData->setOnErrorMessage(__u('Error while retrieving the notifications'));
return $this->db->doSelect($queryData);
}
/**
* @param $id
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function getAllActiveForAdmin($id)
{
$query = /** @lang SQL */
'SELECT id,
type,
component,
description,
`date`,
userId,
checked,
sticky,
onlyAdmin
FROM Notification
WHERE (userId = ? OR sticky = 1 OR userId IS NULL)
AND checked = 0
ORDER BY `date` DESC ';
$queryData = new QueryData();
$queryData->setMapClassName(NotificationData::class);
$queryData->setQuery($query);
$queryData->addParam($id);
$queryData->setOnErrorMessage(__u('Error while retrieving the notifications'));
return $this->db->doSelect($queryData);
}
}