Files
sysPass/lib/SP/Mgmt/CustomFields/CustomField.php
nuxsmin 407a3f0694 * [ADD] Password reset module. Work in progress
* [ADD] Mail provider. Work in progress
* [MOD] Updated copyright
* [MOD] Improved tracking module
2018-02-27 00:06:59 +01:00

372 lines
11 KiB
PHP

<?php
/**
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2018, 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\Mgmt\CustomFields;
defined('APP_ROOT') || die();
use SP\Core\Crypt\Crypt;
use SP\Core\Crypt\Session as CryptSession;
use SP\Core\Exceptions\QueryException;
use SP\Core\Exceptions\SPException;
use SP\DataModel\CustomFieldData;
use SP\DataModel\CustomFieldDefinitionData;
use SP\Mgmt\ItemInterface;
use SP\Storage\DbWrapper;
use SP\Storage\QueryData;
use SP\Util\Util;
/**
* Class CustomFields para la gestión de campos personalizados de los módulos
*
* @package SP\Mgmt\CustomFields
* @property CustomFieldData $itemData
*/
class CustomField extends CustomFieldBase implements ItemInterface
{
/**
* @return mixed
* @throws \SP\Core\Exceptions\QueryException
* @throws \SP\Core\Exceptions\ConstraintException
* @throws \Defuse\Crypto\Exception\EnvironmentIsBrokenException
* @throws \Defuse\Crypto\Exception\BadFormatException
* @throws \Defuse\Crypto\Exception\CryptoException
* @throws \SP\Core\Exceptions\SPException
*/
public function update()
{
$exists = $this->checkExists();
if (!$exists && $this->itemData->getValue() !== '') {
return $this->add();
} elseif ($exists && $this->itemData->getValue() === '') {
return $this->delete($this->itemData->getId());
}
$sessionKey = CryptSession::getSessionKey();
$securedKey = Crypt::makeSecuredKey($sessionKey);
if (strlen($securedKey) > 1000) {
throw new QueryException(SPException::ERROR, __('Error interno', false));
}
$query = /** @lang SQL */
'UPDATE CustomFieldData SET
customfielddata_data = ?,
customfielddata_key = ?
WHERE customfielddata_moduleId = ?
AND customfielddata_itemId = ?
AND customfielddata_defId = ?';
$Data = new QueryData();
$Data->setQuery($query);
$Data->addParam(Crypt::encrypt($this->itemData->getValue(), $securedKey, $sessionKey));
$Data->addParam($securedKey);
$Data->addParam($this->itemData->getModule());
$Data->addParam($this->itemData->getId());
$Data->addParam($this->itemData->getDefinitionId());
return DbWrapper::getQuery($Data);
}
/**
* Comprueba si el elemento tiene campos personalizados con datos
*
* @return bool
* @throws \SP\Core\Exceptions\SPException
*/
protected function checkExists()
{
$query = /** @lang SQL */
'SELECT customfielddata_id
FROM CustomFieldData
WHERE customfielddata_moduleId = ?
AND customfielddata_itemId = ?
AND customfielddata_defId = ?';
$Data = new QueryData();
$Data->setQuery($query);
$Data->addParam($this->itemData->getModule());
$Data->addParam($this->itemData->getId());
$Data->addParam($this->itemData->getDefinitionId());
DbWrapper::getQuery($Data);
return ($Data->getQueryNumRows() >= 1);
}
/**
* @return mixed
* @throws \Defuse\Crypto\Exception\CryptoException
* @throws \SP\Core\Exceptions\QueryException
* @throws \SP\Core\Exceptions\ConstraintException
* @throws \Defuse\Crypto\Exception\BadFormatException
* @throws \Defuse\Crypto\Exception\EnvironmentIsBrokenException
* @throws \SP\Core\Exceptions\SPException
*/
public function add()
{
if ($this->itemData->getValue() === '') {
return true;
}
$sessionKey = CryptSession::getSessionKey();
$securedKey = Crypt::makeSecuredKey($sessionKey);
if (strlen($securedKey) > 1000) {
throw new QueryException(SPException::ERROR, __('Error interno', false));
}
$query = /** @lang SQL */
'INSERT INTO CustomFieldData SET
customfielddata_itemId = ?,
customfielddata_moduleId = ?,
customfielddata_defId = ?,
customfielddata_data = ?,
customfielddata_key = ?';
$Data = new QueryData();
$Data->setQuery($query);
$Data->addParam($this->itemData->getId());
$Data->addParam($this->itemData->getModule());
$Data->addParam($this->itemData->getDefinitionId());
$Data->addParam(Crypt::encrypt($this->itemData->getValue(), $securedKey, $sessionKey));
$Data->addParam($securedKey);
return DbWrapper::getQuery($Data);
}
/**
* @param $id int
* @return mixed
* @throws \SP\Core\Exceptions\SPException
*/
public function delete($id)
{
$query = /** @lang SQL */
'DELETE FROM CustomFieldData
WHERE customfielddata_itemId = ?
AND customfielddata_moduleId = ? LIMIT 1';
$Data = new QueryData();
$Data->setQuery($query);
$Data->addParam($id);
$Data->addParam($this->itemData->getCustomfielddataModuleId());
return DbWrapper::getQuery($Data);
}
/**
* @param $id int
* @return CustomFieldData[]
*/
public function getById($id)
{
$query = /** @lang SQL */
'SELECT customfielddata_id,
customfielddef_id,
customfielddata_data,
customfielddata_key,
customfielddef_field
FROM CustomFieldData
JOIN CustomFieldDefinition ON customfielddata_defId = customfielddef_id
WHERE customfielddef_module = ?
AND customfielddata_itemId = ?
UNION
SELECT
0 as customfielddata_id,
customfielddef_id,
"" as customfielddata_data,
"" as customfielddata_key,
customfielddef_field
FROM CustomFieldDefinition
WHERE customfielddef_module = ?
AND customfielddef_id NOT IN
(SELECT customfielddef_id
FROM CustomFieldData
JOIN CustomFieldDefinition ON customfielddata_defId = customfielddef_id
WHERE customfielddef_module = ?
AND customfielddata_itemId = ?)
ORDER BY customfielddef_id';
$Data = new QueryData();
$Data->setMapClassName($this->getDataModel());
$Data->setQuery($query);
$Data->addParam($this->itemData->getModule());
$Data->addParam($id);
$Data->addParam($this->itemData->getModule());
$Data->addParam($this->itemData->getModule());
$Data->addParam($id);
/** @var CustomFieldData[] $queryRes */
$queryRes = DbWrapper::getResultsArray($Data);
$customFields = [];
foreach ($queryRes as $CustomFieldData) {
/** @var CustomFieldDefinitionData $fieldDef */
$fieldDef = Util::unserialize(CustomFieldDefinitionData::class, $CustomFieldData->getCustomfielddefField());
$CustomFieldData->setDefinition($fieldDef);
$CustomFieldData->setDefinitionId($CustomFieldData->getCustomfielddefId());
$CustomFieldData->setTypeName(CustomFieldTypes::getFieldsTypes($fieldDef->getType()));
$CustomFieldData->setValue($this->unencryptData($CustomFieldData));
$customFields[] = $CustomFieldData;
}
return $customFields;
}
/**
* Desencriptar y formatear los datos del campo
*
* @param CustomFieldData $CustomFieldData
* @return string
* @throws \Defuse\Crypto\Exception\CryptoException
*/
protected function unencryptData(CustomFieldData $CustomFieldData)
{
if ($CustomFieldData->getCustomfielddataData() !== '') {
$securedKey = Crypt::unlockSecuredKey($CustomFieldData->getCustomfielddataKey(), CryptSession::getSessionKey());
return $this->formatValue(Crypt::decrypt($CustomFieldData->getCustomfielddataData(), $securedKey));
}
return '';
}
/**
* Formatear el valor del campo
*
* @param $value string El valor del campo
* @return string
*/
protected function formatValue($value)
{
if (preg_match('#https?://#', $value)) {
return '<a href="' . $value . '" target="_blank">' . $value . '</a>';
}
return $value;
}
/**
* @return CustomFieldDefinitionData[]|array
*/
public function getAll()
{
$query = /** @lang SQL */
'SELECT customfielddef_id,
customfielddef_field
FROM CustomFieldDefinition
WHERE customfielddef_module = ?';
$Data = new QueryData();
$Data->setMapClassName(CustomFieldDefinitionData::class);
$Data->setQuery($query);
$Data->addParam($this->itemData->getModule());
/** @var CustomFieldDefinitionData[] $queryRes */
$queryRes = DbWrapper::getResultsArray($Data);
if (count($queryRes) === 0) {
return ['hash' => ''];
}
foreach ($queryRes as $CustomFieldDef) {
/** @var CustomFieldDefinitionData $fieldDef */
$fieldDef = Util::unserialize(CustomFieldDefinitionData::class, $CustomFieldDef->getCustomfielddefField());
$CustomFieldData = new CustomFieldData();
$CustomFieldData->setDefinition($fieldDef);
$CustomFieldData->setId($CustomFieldDef->getCustomfielddefId());
$CustomFieldData->setTypeName(CustomFieldTypes::getFieldsTypes($fieldDef->getType()));
$fields[] = $fieldDef;
}
$customFields['hash'] = '';
return $customFields;
}
/**
* @param $id int
* @return mixed
*/
public function checkInUse($id)
{
// TODO: Implement checkInUse() method.
}
/**
* @return bool
*/
public function checkDuplicatedOnUpdate()
{
// TODO: Implement checkDuplicatedOnUpdate() method.
}
/**
* @return bool
*/
public function checkDuplicatedOnAdd()
{
// TODO: Implement checkDuplicatedOnAdd() method.
}
/**
* Eliminar elementos en lote
*
* @param array $ids
* @return $this
*/
public function deleteBatch(array $ids)
{
// TODO: Implement deleteBatch() method.
}
/**
* Devolver los elementos con los ids especificados
*
* @param array $ids
* @return mixed
*/
public function getByIdBatch(array $ids)
{
// TODO: Implement getByIdBatch() method.
}
/**
* Inicializar la clase
*
* @return void
* @throws \SP\Core\Exceptions\InvalidClassException
*/
protected function init()
{
$this->setDataModel(CustomFieldData::class);
}
}