Initial Upload
This commit is contained in:
Matt Batchelder
642
lib/Factory/DisplayProfileFactory.php
Normal file
642
lib/Factory/DisplayProfileFactory.php
Normal file
@@ -0,0 +1,642 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (C) 2025 Xibo Signage Ltd
|
||||
*
|
||||
* Xibo - Digital Signage - https://xibosignage.com
|
||||
*
|
||||
* This file is part of Xibo.
|
||||
*
|
||||
* Xibo is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* any later version.
|
||||
*
|
||||
* Xibo 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 Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with Xibo. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
namespace Xibo\Factory;
|
||||
|
||||
use Xibo\Entity\DisplayProfile;
|
||||
use Xibo\Service\ConfigServiceInterface;
|
||||
use Xibo\Support\Exception\GeneralException;
|
||||
use Xibo\Support\Exception\InvalidArgumentException;
|
||||
use Xibo\Support\Exception\NotFoundException;
|
||||
use Xibo\Support\Sanitizer\SanitizerInterface;
|
||||
|
||||
/**
|
||||
* Class DisplayProfileFactory
|
||||
* @package Xibo\Factory
|
||||
*/
|
||||
class DisplayProfileFactory extends BaseFactory
|
||||
{
|
||||
private $customProfileSettings = [];
|
||||
/**
|
||||
* @var ConfigServiceInterface
|
||||
*/
|
||||
private $config;
|
||||
|
||||
/**
|
||||
* @var CommandFactory
|
||||
*/
|
||||
private $commandFactory;
|
||||
|
||||
/**
|
||||
* Construct a factory
|
||||
* @param ConfigServiceInterface $config
|
||||
* @param CommandFactory $commandFactory
|
||||
*/
|
||||
public function __construct($config, $commandFactory)
|
||||
{
|
||||
$this->config = $config;
|
||||
$this->commandFactory = $commandFactory;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return DisplayProfile
|
||||
*/
|
||||
public function createEmpty()
|
||||
{
|
||||
$displayProfile = new DisplayProfile(
|
||||
$this->getStore(),
|
||||
$this->getLog(),
|
||||
$this->getDispatcher(),
|
||||
$this->config,
|
||||
$this->commandFactory,
|
||||
$this
|
||||
);
|
||||
$displayProfile->config = [];
|
||||
|
||||
return $displayProfile;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $displayProfileId
|
||||
* @return DisplayProfile
|
||||
* @throws NotFoundException
|
||||
*/
|
||||
public function getById($displayProfileId)
|
||||
{
|
||||
$profiles = $this->query(null, ['disableUserCheck' => 1, 'displayProfileId' => $displayProfileId]);
|
||||
|
||||
if (count($profiles) <= 0) {
|
||||
throw new NotFoundException();
|
||||
}
|
||||
|
||||
$profile = $profiles[0];
|
||||
/* @var DisplayProfile $profile */
|
||||
|
||||
$profile->load([]);
|
||||
return $profile;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $type
|
||||
* @return DisplayProfile
|
||||
* @throws NotFoundException
|
||||
*/
|
||||
public function getDefaultByType(string $type): DisplayProfile
|
||||
{
|
||||
$profiles = $this->query(null, ['disableUserCheck' => 1, 'type' => $type, 'isDefault' => 1]);
|
||||
|
||||
if (count($profiles) <= 0) {
|
||||
throw new NotFoundException(sprintf(__('No default display profile for %s'), $type));
|
||||
}
|
||||
|
||||
$profile = $profiles[0];
|
||||
$profile->load();
|
||||
return $profile;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $clientType
|
||||
* @return DisplayProfile
|
||||
* @throws NotFoundException
|
||||
*/
|
||||
public function getUnknownProfile($clientType): DisplayProfile
|
||||
{
|
||||
$profile = $this->createEmpty();
|
||||
$profile->type = 'unknown';
|
||||
$profile->setClientType($clientType);
|
||||
$profile->isCustom = 0;
|
||||
$profile->config = [];
|
||||
$profile->configDefault = [];
|
||||
// We shoud not call load as it would be recursive due to unknown also being an unknown profile
|
||||
// $profile->load();
|
||||
return $profile;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get by Command Id
|
||||
* @param $commandId
|
||||
* @return DisplayProfile[]
|
||||
* @throws NotFoundException
|
||||
*/
|
||||
public function getByCommandId($commandId)
|
||||
{
|
||||
return $this->query(null, ['disableUserCheck' => 1, 'commandId' => $commandId]);
|
||||
}
|
||||
|
||||
public function getByOwnerId($ownerId)
|
||||
{
|
||||
return $this->query(null, ['disableUserCheck' => 1, 'userId' => $ownerId]);
|
||||
}
|
||||
|
||||
public function createCustomProfile($options)
|
||||
{
|
||||
$params = $this->getSanitizer($options);
|
||||
$displayProfile = $this->createEmpty();
|
||||
$displayProfile->name = $params->getString('name');
|
||||
$displayProfile->type = $params->getString('type');
|
||||
$displayProfile->isDefault = $params->getCheckbox('isDefault');
|
||||
$displayProfile->userId = $params->getInt('userId');
|
||||
$displayProfile->isCustom = 1;
|
||||
|
||||
return $displayProfile;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the config from the file
|
||||
*/
|
||||
public function loadForType($type)
|
||||
{
|
||||
$config = [
|
||||
'unknown' => [],
|
||||
'windows' => [
|
||||
['name' => 'collectInterval', 'default' => 300, 'type' => 'int'],
|
||||
['name' => 'downloadStartWindow', 'default' => '00:00', 'type' => 'string'],
|
||||
['name' => 'downloadEndWindow', 'default' => '00:00', 'type' => 'string'],
|
||||
['name' => 'dayPartId', 'default' => null],
|
||||
['name' => 'xmrNetworkAddress', 'default' => '', 'type' => 'string'],
|
||||
['name' => 'xmrWebSocketAddress', 'default' => '', 'type' => 'string'],
|
||||
[
|
||||
'name' => 'statsEnabled',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_STATS_DEFAULT', 0),
|
||||
'type' => 'checkbox',
|
||||
],
|
||||
[
|
||||
'name' => 'aggregationLevel',
|
||||
'default' => $this->config->getSetting('DISPLAY_PROFILE_AGGREGATION_LEVEL_DEFAULT'),
|
||||
'type' => 'string',
|
||||
],
|
||||
['name' => 'powerpointEnabled', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'sizeX', 'default' => 0, 'type' => 'double'],
|
||||
['name' => 'sizeY', 'default' => 0, 'type' => 'double'],
|
||||
['name' => 'offsetX', 'default' => 0, 'type' => 'double'],
|
||||
['name' => 'offsetY', 'default' => 0, 'type' => 'double'],
|
||||
['name' => 'clientInfomationCtrlKey', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'clientInformationKeyCode', 'default' => 'I', 'type' => 'string'],
|
||||
['name' => 'logLevel', 'default' => 'error', 'type' => 'string'],
|
||||
['name' => 'elevateLogsUntil', 'default' => 0, 'type' => 'int'],
|
||||
['name' => 'logToDiskLocation', 'default' => '', 'type' => 'string'],
|
||||
['name' => 'showInTaskbar', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'cursorStartPosition', 'default' => 'Unchanged', 'type' => 'string'],
|
||||
['name' => 'doubleBuffering', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'emptyLayoutDuration', 'default' => 10, 'type' => 'int'],
|
||||
['name' => 'enableMouse', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'enableShellCommands', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'expireModifiedLayouts', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'maxConcurrentDownloads', 'default' => 2, 'type' => 'int'],
|
||||
['name' => 'shellCommandAllowList', 'default' => '', 'type' => 'string'],
|
||||
['name' => 'sendCurrentLayoutAsStatusUpdate', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'screenShotRequestInterval', 'default' => 0, 'type' => 'int'],
|
||||
[
|
||||
'name' => 'screenShotSize',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_SCREENSHOT_SIZE_DEFAULT', 200),
|
||||
'type' => 'int',
|
||||
],
|
||||
['name' => 'maxLogFileUploads', 'default' => 3, 'type' => 'int'],
|
||||
['name' => 'embeddedServerPort', 'default' => 9696, 'type' => 'int'],
|
||||
['name' => 'preventSleep', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'forceHttps', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'authServerWhitelist', 'default' => null, 'type' => 'string'],
|
||||
['name' => 'edgeBrowserWhitelist', 'default' => null, 'type' => 'string'],
|
||||
['name' => 'embeddedServerAllowWan', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'isRecordGeoLocationOnProofOfPlay', 'default' => 0, 'type' => 'checkbox']
|
||||
],
|
||||
'android' => [
|
||||
['name' => 'emailAddress', 'default' => ''],
|
||||
['name' => 'settingsPassword', 'default' => ''],
|
||||
['name' => 'collectInterval', 'default' => 300],
|
||||
['name' => 'downloadStartWindow', 'default' => '00:00'],
|
||||
['name' => 'downloadEndWindow', 'default' => '00:00'],
|
||||
['name' => 'xmrNetworkAddress', 'default' => ''],
|
||||
['name' => 'xmrWebSocketAddress', 'default' => ''],
|
||||
[
|
||||
'name' => 'statsEnabled',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_STATS_DEFAULT', 0),
|
||||
'type' => 'checkbox',
|
||||
],
|
||||
[
|
||||
'name' => 'aggregationLevel',
|
||||
'default' => $this->config->getSetting('DISPLAY_PROFILE_AGGREGATION_LEVEL_DEFAULT'),
|
||||
'type' => 'string',
|
||||
],
|
||||
['name' => 'orientation', 'default' => 0],
|
||||
['name' => 'screenDimensions', 'default' => ''],
|
||||
['name' => 'blacklistVideo', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'storeHtmlOnInternal', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'useSurfaceVideoView', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'logLevel', 'default' => 'error'],
|
||||
['name' => 'elevateLogsUntil', 'default' => 0, 'type' => 'int'],
|
||||
['name' => 'versionMediaId', 'default' => null],
|
||||
['name' => 'startOnBoot', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'actionBarMode', 'default' => 1],
|
||||
['name' => 'actionBarDisplayDuration', 'default' => 30],
|
||||
['name' => 'actionBarIntent', 'default' => ''],
|
||||
['name' => 'autoRestart', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'startOnBootDelay', 'default' => 60],
|
||||
['name' => 'sendCurrentLayoutAsStatusUpdate', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'screenShotRequestInterval', 'default' => 0],
|
||||
['name' => 'expireModifiedLayouts', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'screenShotIntent', 'default' => ''],
|
||||
[
|
||||
'name' => 'screenShotSize',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_SCREENSHOT_SIZE_DEFAULT', 200),
|
||||
],
|
||||
['name' => 'updateStartWindow', 'default' => '00:00'],
|
||||
['name' => 'updateEndWindow', 'default' => '00:00'],
|
||||
['name' => 'dayPartId', 'default' => null],
|
||||
['name' => 'restartWifiOnConnectionFailure', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'webViewPluginState', 'default' => 'DEMAND'],
|
||||
['name' => 'hardwareAccelerateWebViewMode', 'default' => '2'],
|
||||
['name' => 'timeSyncFromCms', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'webCacheEnabled', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'serverPort', 'default' => 9696],
|
||||
['name' => 'installWithLoadedLinkLibraries', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'forceHttps', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'isUseMultipleVideoDecoders', 'default' => 'default', 'type' => 'string'],
|
||||
['name' => 'maxRegionCount', 'default' => 0],
|
||||
['name' => 'embeddedServerAllowWan', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'isRecordGeoLocationOnProofOfPlay', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'videoEngine', 'default' => 'exoplayer', 'type' => 'string'],
|
||||
['name' => 'isTouchEnabled', 'default' => 0, 'type' => 'checkbox']
|
||||
],
|
||||
'linux' => [
|
||||
['name' => 'collectInterval', 'default' => 300],
|
||||
['name' => 'downloadStartWindow', 'default' => '00:00'],
|
||||
['name' => 'downloadEndWindow', 'default' => '00:00'],
|
||||
['name' => 'dayPartId', 'default' => null],
|
||||
['name' => 'xmrNetworkAddress', 'default' => ''],
|
||||
['name' => 'xmrWebSocketAddress', 'default' => ''],
|
||||
[
|
||||
'name' => 'statsEnabled',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_STATS_DEFAULT', 0),
|
||||
'type' => 'checkbox',
|
||||
],
|
||||
[
|
||||
'name' => 'aggregationLevel',
|
||||
'default' => $this->config->getSetting('DISPLAY_PROFILE_AGGREGATION_LEVEL_DEFAULT'),
|
||||
'type' => 'string',
|
||||
],
|
||||
['name' => 'sizeX', 'default' => 0],
|
||||
['name' => 'sizeY', 'default' => 0],
|
||||
['name' => 'offsetX', 'default' => 0],
|
||||
['name' => 'offsetY', 'default' => 0],
|
||||
['name' => 'logLevel', 'default' => 'error'],
|
||||
['name' => 'elevateLogsUntil', 'default' => 0, 'type' => 'int'],
|
||||
['name' => 'enableShellCommands', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'expireModifiedLayouts', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'maxConcurrentDownloads', 'default' => 2],
|
||||
['name' => 'shellCommandAllowList', 'default' => ''],
|
||||
['name' => 'sendCurrentLayoutAsStatusUpdate', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'screenShotRequestInterval', 'default' => 0],
|
||||
[
|
||||
'name' => 'screenShotSize',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_SCREENSHOT_SIZE_DEFAULT', 200),
|
||||
],
|
||||
['name' => 'maxLogFileUploads', 'default' => 3],
|
||||
['name' => 'embeddedServerPort', 'default' => 9696],
|
||||
['name' => 'preventSleep', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'forceHttps', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'embeddedServerAllowWan', 'default' => 0, 'type' => 'checkbox']
|
||||
],
|
||||
'lg' => [
|
||||
['name' => 'emailAddress', 'default' => ''],
|
||||
['name' => 'collectInterval', 'default' => 300],
|
||||
['name' => 'downloadStartWindow', 'default' => '00:00'],
|
||||
['name' => 'downloadEndWindow', 'default' => '00:00'],
|
||||
['name' => 'dayPartId', 'default' => null],
|
||||
['name' => 'xmrNetworkAddress', 'default' => ''],
|
||||
['name' => 'xmrWebSocketAddress', 'default' => ''],
|
||||
[
|
||||
'name' => 'statsEnabled',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_STATS_DEFAULT', 0),
|
||||
'type' => 'checkbox',
|
||||
],
|
||||
[
|
||||
'name' => 'aggregationLevel',
|
||||
'default' => $this->config->getSetting('DISPLAY_PROFILE_AGGREGATION_LEVEL_DEFAULT'),
|
||||
'type' => 'string',
|
||||
],
|
||||
['name' => 'orientation', 'default' => 0],
|
||||
['name' => 'logLevel', 'default' => 'error'],
|
||||
['name' => 'elevateLogsUntil', 'default' => 0, 'type' => 'int'],
|
||||
['name' => 'versionMediaId', 'default' => null],
|
||||
['name' => 'actionBarMode', 'default' => 1],
|
||||
['name' => 'actionBarDisplayDuration', 'default' => 30],
|
||||
['name' => 'sendCurrentLayoutAsStatusUpdate', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'mediaInventoryTimer', 'default' => 0],
|
||||
['name' => 'screenShotRequestInterval', 'default' => 0, 'type' => 'int'],
|
||||
['name' => 'screenShotSize', 'default' => 1],
|
||||
['name' => 'timers', 'default' => '{}'],
|
||||
['name' => 'pictureOptions', 'default' => '{}'],
|
||||
['name' => 'lockOptions', 'default' => '{}'],
|
||||
['name' => 'forceHttps', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'updateStartWindow', 'default' => '00:00'],
|
||||
['name' => 'updateEndWindow', 'default' => '00:00'],
|
||||
['name' => 'embeddedServerAllowWan', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'serverPort', 'default' => 9696],
|
||||
['name' => 'isUseMultipleVideoDecoders', 'default' => 'default', 'type' => 'string'],
|
||||
],
|
||||
'sssp' => [
|
||||
['name' => 'emailAddress', 'default' => ''],
|
||||
['name' => 'collectInterval', 'default' => 300],
|
||||
['name' => 'downloadStartWindow', 'default' => '00:00'],
|
||||
['name' => 'downloadEndWindow', 'default' => '00:00'],
|
||||
['name' => 'dayPartId', 'default' => null],
|
||||
['name' => 'xmrNetworkAddress', 'default' => ''],
|
||||
['name' => 'xmrWebSocketAddress', 'default' => ''],
|
||||
[
|
||||
'name' => 'statsEnabled',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_STATS_DEFAULT', 0),
|
||||
'type' => 'checkbox',
|
||||
],
|
||||
[
|
||||
'name' => 'aggregationLevel',
|
||||
'default' => $this->config->getSetting('DISPLAY_PROFILE_AGGREGATION_LEVEL_DEFAULT'),
|
||||
'type' => 'string',
|
||||
],
|
||||
['name' => 'orientation', 'default' => 0],
|
||||
['name' => 'logLevel', 'default' => 'error'],
|
||||
['name' => 'elevateLogsUntil', 'default' => 0, 'type' => 'int'],
|
||||
['name' => 'versionMediaId', 'default' => null],
|
||||
['name' => 'actionBarMode', 'default' => 1],
|
||||
['name' => 'actionBarDisplayDuration', 'default' => 30],
|
||||
['name' => 'sendCurrentLayoutAsStatusUpdate', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'mediaInventoryTimer', 'default' => 0],
|
||||
['name' => 'screenShotRequestInterval', 'default' => 0, 'type' => 'int'],
|
||||
['name' => 'screenShotSize', 'default' => 1],
|
||||
['name' => 'timers', 'default' => '{}'],
|
||||
['name' => 'pictureOptions', 'default' => '{}'],
|
||||
['name' => 'lockOptions', 'default' => '{}'],
|
||||
['name' => 'forceHttps', 'default' => 1, 'type' => 'checkbox'],
|
||||
['name' => 'updateStartWindow', 'default' => '00:00'],
|
||||
['name' => 'updateEndWindow', 'default' => '00:00'],
|
||||
['name' => 'embeddedServerAllowWan', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'serverPort', 'default' => 9696],
|
||||
['name' => 'isUseMultipleVideoDecoders', 'default' => 'default', 'type' => 'string'],
|
||||
],
|
||||
'chromeOS' => [
|
||||
['name' => 'licenceCode', 'default' => ''],
|
||||
['name' => 'collectInterval', 'default' => 300],
|
||||
['name' => 'xmrNetworkAddress', 'default' => ''],
|
||||
['name' => 'xmrWebSocketAddress', 'default' => ''],
|
||||
[
|
||||
'name' => 'statsEnabled',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_STATS_DEFAULT', 0),
|
||||
'type' => 'checkbox',
|
||||
],
|
||||
[
|
||||
'name' => 'aggregationLevel',
|
||||
'default' => $this->config->getSetting('DISPLAY_PROFILE_AGGREGATION_LEVEL_DEFAULT'),
|
||||
'type' => 'string',
|
||||
],
|
||||
['name' => 'playerVersionId', 'default' => null],
|
||||
['name' => 'dayPartId', 'default' => null],
|
||||
['name' => 'logLevel', 'default' => 'error'],
|
||||
['name' => 'elevateLogsUntil', 'default' => 0, 'type' => 'int'],
|
||||
['name' => 'sendCurrentLayoutAsStatusUpdate', 'default' => 0, 'type' => 'checkbox'],
|
||||
['name' => 'screenShotRequestInterval', 'default' => 0, 'type' => 'int'],
|
||||
[
|
||||
'name' => 'screenShotSize',
|
||||
'default' => (int)$this->config->getSetting('DISPLAY_PROFILE_SCREENSHOT_SIZE_DEFAULT', 200),
|
||||
],
|
||||
]
|
||||
];
|
||||
|
||||
// get array keys (player types) from the default config
|
||||
// called by getAvailableTypes function, to ensure the default types are always available for selection
|
||||
if ($type === 'defaultTypes') {
|
||||
// remove unknown from the array
|
||||
array_shift($config);
|
||||
|
||||
// build key value array to merge with distinct types from database
|
||||
$defaultTypes = [];
|
||||
foreach (array_keys($config) as $type) {
|
||||
$defaultTypes[]['type'] = $type;
|
||||
}
|
||||
return $defaultTypes;
|
||||
}
|
||||
|
||||
if (!isset($config[$type])) {
|
||||
try {
|
||||
$config[$type] = $this->getCustomProfileConfig($type);
|
||||
} catch (GeneralException $exception) {
|
||||
$this->getLog()->error('loadForType: error with ' . $type . ', e = ' . $exception->getMessage());
|
||||
$config[$type] = $this->getUnknownProfile($type)->getProfileConfig();
|
||||
}
|
||||
}
|
||||
|
||||
return $config[$type];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $sortOrder
|
||||
* @param array $filterBy
|
||||
* @return DisplayProfile[]
|
||||
* @throws NotFoundException
|
||||
*/
|
||||
public function query($sortOrder = null, $filterBy = [])
|
||||
{
|
||||
$profiles = [];
|
||||
$parsedFilter = $this->getSanitizer($filterBy);
|
||||
|
||||
if ($sortOrder === null) {
|
||||
$sortOrder = ['name'];
|
||||
}
|
||||
|
||||
|
||||
$params = [];
|
||||
$select = 'SELECT displayProfileId, name, type, config, isDefault, userId, isCustom ';
|
||||
|
||||
$body = ' FROM `displayprofile` WHERE 1 = 1 ';
|
||||
|
||||
if ($parsedFilter->getInt('displayProfileId') !== null) {
|
||||
$body .= ' AND displayProfileId = :displayProfileId ';
|
||||
$params['displayProfileId'] = $parsedFilter->getInt('displayProfileId');
|
||||
}
|
||||
|
||||
if ($parsedFilter->getInt('isDefault') !== null) {
|
||||
$body .= ' AND isDefault = :isDefault ';
|
||||
$params['isDefault'] = $parsedFilter->getInt('isDefault');
|
||||
}
|
||||
|
||||
// Filter by DisplayProfile Name?
|
||||
if ($parsedFilter->getString('displayProfile') != null) {
|
||||
$terms = explode(',', $parsedFilter->getString('displayProfile'));
|
||||
$logicalOperator = $parsedFilter->getString('logicalOperatorName', ['default' => 'OR']);
|
||||
$this->nameFilter(
|
||||
'displayprofile',
|
||||
'name',
|
||||
$terms,
|
||||
$body,
|
||||
$params,
|
||||
($parsedFilter->getCheckbox('useRegexForName') == 1),
|
||||
$logicalOperator
|
||||
);
|
||||
}
|
||||
|
||||
if ($parsedFilter->getString('type') != null) {
|
||||
$body .= ' AND type = :type ';
|
||||
$params['type'] = $parsedFilter->getString('type');
|
||||
}
|
||||
|
||||
if ($parsedFilter->getInt('commandId') !== null) {
|
||||
$body .= '
|
||||
AND `displayprofile`.displayProfileId IN (
|
||||
SELECT `lkcommanddisplayprofile`.displayProfileId
|
||||
FROM `lkcommanddisplayprofile`
|
||||
WHERE `lkcommanddisplayprofile`.commandId = :commandId
|
||||
)
|
||||
';
|
||||
|
||||
$params['commandId'] = $parsedFilter->getInt('commandId');
|
||||
}
|
||||
|
||||
if ($parsedFilter->getInt('userId') !== null) {
|
||||
$body .= ' AND `displayprofile`.userId = :userId ';
|
||||
$params['userId'] = $parsedFilter->getInt('userId');
|
||||
}
|
||||
|
||||
// Sorting?
|
||||
$order = '';
|
||||
if (is_array($sortOrder)) {
|
||||
$order .= 'ORDER BY ' . implode(',', $sortOrder);
|
||||
}
|
||||
|
||||
$limit = '';
|
||||
// Paging
|
||||
if ($filterBy !== null && $parsedFilter->getInt('start') !== null && $parsedFilter->getInt('length') !== null) {
|
||||
$limit = ' LIMIT ' . $parsedFilter->getInt('start', ['default' => 0]) .
|
||||
', ' . $parsedFilter->getInt('length', ['default' => 10]);
|
||||
}
|
||||
|
||||
$sql = $select . $body . $order . $limit;
|
||||
|
||||
foreach ($this->getStore()->select($sql, $params) as $row) {
|
||||
$profile = $this->createEmpty()->hydrate($row, ['intProperties' => ['isDefault', 'isCustom']]);
|
||||
|
||||
$profile->excludeProperty('configDefault');
|
||||
$profile->excludeProperty('configTabs');
|
||||
$profiles[] = $profile;
|
||||
}
|
||||
|
||||
// Paging
|
||||
if ($limit != '' && count($profiles) > 0) {
|
||||
$results = $this->getStore()->select('SELECT COUNT(*) AS total ' . $body, $params);
|
||||
$this->_countLast = intval($results[0]['total']);
|
||||
}
|
||||
|
||||
return $profiles;
|
||||
}
|
||||
|
||||
/**
|
||||
* Called by the Display Profile page and Add form
|
||||
* @return array
|
||||
*/
|
||||
public function getAvailableTypes(): array
|
||||
{
|
||||
// get distinct player types from the displayprofile table, this will include any custom profile types as well
|
||||
$dbTypes = $this->getStore()->select('SELECT DISTINCT type FROM `displayprofile` ORDER BY type', []);
|
||||
// get an array of default player types from default config,
|
||||
// this is to ensure we will always have the default types available for add form
|
||||
$defaultTypes = $this->loadForType('defaultTypes');
|
||||
|
||||
// merge arrays removing any duplicates
|
||||
$types = array_unique(array_merge($dbTypes, $defaultTypes), SORT_REGULAR);
|
||||
|
||||
$entries = [];
|
||||
foreach ($types as $row) {
|
||||
$sanitizedRow = $this->getSanitizer($row);
|
||||
if ($sanitizedRow->getString('type') === 'sssp') {
|
||||
$typeName = 'Tizen';
|
||||
} elseif ($sanitizedRow->getString('type') === 'lg') {
|
||||
$typeName = 'webOS';
|
||||
} else {
|
||||
$typeName = ucfirst($sanitizedRow->getString('type'));
|
||||
}
|
||||
|
||||
$entries[] = ['typeId' => $sanitizedRow->getString('type'), 'type' => $typeName];
|
||||
}
|
||||
|
||||
return $entries;
|
||||
}
|
||||
|
||||
public function registerCustomDisplayProfile($type, $class, $template, $defaultConfig, $handleCustomFields)
|
||||
{
|
||||
if (!array_key_exists($type, $this->customProfileSettings)) {
|
||||
$this->customProfileSettings[$type] = [
|
||||
'class' => $class,
|
||||
'template' => $template,
|
||||
'defaultConfig' => $defaultConfig,
|
||||
'handleCustomFields' => $handleCustomFields
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
public function getCustomEditTemplate($type)
|
||||
{
|
||||
if (!array_key_exists($type, $this->customProfileSettings)) {
|
||||
throw new InvalidArgumentException(sprintf(__('Custom Display Profile not registered correctly for type %s'), $type));
|
||||
}
|
||||
|
||||
if (!array_key_exists('template', $this->customProfileSettings[$type])) {
|
||||
throw new InvalidArgumentException(sprintf(__('Custom template not registered correctly for type %s'), $type));
|
||||
}
|
||||
|
||||
$function = $this->customProfileSettings[$type]['template'];
|
||||
return $this->customProfileSettings[$type]['class']::$function();
|
||||
}
|
||||
|
||||
public function getCustomProfileConfig($type)
|
||||
{
|
||||
if (!array_key_exists($type, $this->customProfileSettings)) {
|
||||
throw new InvalidArgumentException(sprintf(__('Custom Display Profile not registered correctly for type %s'), $type));
|
||||
}
|
||||
|
||||
if (!array_key_exists('defaultConfig', $this->customProfileSettings[$type])) {
|
||||
throw new InvalidArgumentException(sprintf(__('Custom config not registered correctly for type %s'), $type));
|
||||
}
|
||||
|
||||
$function = $this->customProfileSettings[$type]['defaultConfig'];
|
||||
return $this->customProfileSettings[$type]['class']::$function($this->config);
|
||||
}
|
||||
|
||||
public function isCustomType($type)
|
||||
{
|
||||
$results = $this->getStore()->select('SELECT displayProfileId FROM `displayprofile` WHERE isCustom = 1 AND type = :type', [
|
||||
'type' => $type
|
||||
]);
|
||||
|
||||
return (count($results) >= 1) ? 1 : 0;
|
||||
}
|
||||
|
||||
public function handleCustomFields(DisplayProfile $displayProfile, SanitizerInterface $sanitizedParams, $config, $display)
|
||||
{
|
||||
if (!array_key_exists($displayProfile->getClientType(), $this->customProfileSettings)) {
|
||||
throw new InvalidArgumentException(sprintf(__('Custom Display Profile not registered correctly for type %s'), $displayProfile->getClientType()));
|
||||
}
|
||||
|
||||
if (!array_key_exists('handleCustomFields', $this->customProfileSettings[$displayProfile->getClientType()])) {
|
||||
throw new InvalidArgumentException(sprintf(__('Custom fields handling not registered correctly for type %s'), $displayProfile->getClientType()));
|
||||
}
|
||||
|
||||
$function = $this->customProfileSettings[$displayProfile->getClientType()]['handleCustomFields'];
|
||||
return $this->customProfileSettings[$displayProfile->getClientType()]['class']::$function($displayProfile, $sanitizedParams, $config, $display, $this->getLog());
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user