467 lines
15 KiB
PHP
467 lines
15 KiB
PHP
<?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\Entity;
|
|
|
|
|
|
use Carbon\Carbon;
|
|
use Slim\Http\ServerRequest;
|
|
use Symfony\Component\Filesystem\Filesystem;
|
|
use Xibo\Factory\MediaFactory;
|
|
use Xibo\Factory\PlayerVersionFactory;
|
|
use Xibo\Helper\DateFormatHelper;
|
|
use Xibo\Helper\HttpsDetect;
|
|
use Xibo\Service\ConfigServiceInterface;
|
|
use Xibo\Service\LogServiceInterface;
|
|
use Xibo\Storage\StorageServiceInterface;
|
|
use Xibo\Support\Exception\DuplicateEntityException;
|
|
use Xibo\Support\Exception\GeneralException;
|
|
use Xibo\Support\Exception\InvalidArgumentException;
|
|
use Xibo\Support\Exception\NotFoundException;
|
|
|
|
/**
|
|
* Class PlayerVersion
|
|
* @package Xibo\Entity
|
|
*
|
|
* @SWG\Definition()
|
|
*/
|
|
class PlayerVersion implements \JsonSerializable
|
|
{
|
|
use EntityTrait;
|
|
|
|
/**
|
|
* @SWG\Property(description="Version ID")
|
|
* @var int
|
|
*/
|
|
public $versionId;
|
|
|
|
/**
|
|
* @SWG\Property(description="Player type")
|
|
* @var string
|
|
*/
|
|
public $type;
|
|
|
|
/**
|
|
* @SWG\Property(description="Version number")
|
|
* @var string
|
|
*/
|
|
public $version;
|
|
|
|
/**
|
|
* @SWG\Property(description="Code number")
|
|
* @var int
|
|
*/
|
|
public $code;
|
|
|
|
/**
|
|
* @SWG\Property(description="Player version to show")
|
|
* @var string
|
|
*/
|
|
public $playerShowVersion;
|
|
|
|
/**
|
|
* @SWG\Property(description="The Player Version created date")
|
|
* @var string
|
|
*/
|
|
public $createdAt;
|
|
|
|
/**
|
|
* @SWG\Property(description="The Player Version modified date")
|
|
* @var string
|
|
*/
|
|
public $modifiedAt;
|
|
|
|
/**
|
|
* @SWG\Property(description="The name of the user that modified this Player Version last")
|
|
* @var string
|
|
*/
|
|
public $modifiedBy;
|
|
|
|
/**
|
|
* @SWG\Property(description="The Player Version file name")
|
|
* @var string
|
|
*/
|
|
public $fileName;
|
|
|
|
/**
|
|
* @SWG\Property(description="The Player Version file size in bytes")
|
|
* @var int
|
|
*/
|
|
public $size;
|
|
|
|
/**
|
|
* @SWG\Property(description="A MD5 checksum of the stored Player Version file")
|
|
* @var string
|
|
*/
|
|
public $md5;
|
|
|
|
/**
|
|
* @var ConfigServiceInterface
|
|
*/
|
|
private $config;
|
|
|
|
/**
|
|
* @var PlayerVersionFactory
|
|
*/
|
|
private $playerVersionFactory;
|
|
|
|
/**
|
|
* Entity constructor.
|
|
* @param StorageServiceInterface $store
|
|
* @param LogServiceInterface $log
|
|
* @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
|
|
* @param ConfigServiceInterface $config
|
|
* @param MediaFactory $mediaFactory
|
|
* @param PlayerVersionFactory $playerVersionFactory
|
|
*/
|
|
public function __construct($store, $log, $dispatcher, $config, $playerVersionFactory)
|
|
{
|
|
$this->setCommonDependencies($store, $log, $dispatcher);
|
|
|
|
$this->config = $config;
|
|
$this->playerVersionFactory = $playerVersionFactory;
|
|
}
|
|
|
|
/**
|
|
* Add
|
|
*/
|
|
private function add()
|
|
{
|
|
$this->versionId = $this->getStore()->insert('
|
|
INSERT INTO `player_software` (`player_type`, `player_version`, `player_code`, `playerShowVersion`,`createdAt`, `modifiedAt`, `modifiedBy`, `fileName`, `size`, `md5`)
|
|
VALUES (:type, :version, :code, :playerShowVersion, :createdAt, :modifiedAt, :modifiedBy, :fileName, :size, :md5)
|
|
', [
|
|
'type' => $this->type,
|
|
'version' => $this->version,
|
|
'code' => $this->code,
|
|
'playerShowVersion' => $this->playerShowVersion,
|
|
'createdAt' => Carbon::now()->format(DateFormatHelper::getSystemFormat()),
|
|
'modifiedAt' => Carbon::now()->format(DateFormatHelper::getSystemFormat()),
|
|
'modifiedBy' => $this->modifiedBy,
|
|
'fileName' => $this->fileName,
|
|
'size' => $this->size,
|
|
'md5' => $this->md5
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Edit
|
|
*/
|
|
private function edit()
|
|
{
|
|
$sql = '
|
|
UPDATE `player_software`
|
|
SET `player_version` = :version,
|
|
`player_code` = :code,
|
|
`playerShowVersion` = :playerShowVersion,
|
|
`modifiedAt` = :modifiedAt,
|
|
`modifiedBy` = :modifiedBy
|
|
WHERE versionId = :versionId
|
|
';
|
|
|
|
$params = [
|
|
'version' => $this->version,
|
|
'code' => $this->code,
|
|
'playerShowVersion' => $this->playerShowVersion,
|
|
'modifiedAt' => Carbon::now()->format(DateFormatHelper::getSystemFormat()),
|
|
'modifiedBy' => $this->modifiedBy,
|
|
'versionId' => $this->versionId
|
|
];
|
|
|
|
$this->getStore()->update($sql, $params);
|
|
}
|
|
|
|
|
|
/**
|
|
* Delete
|
|
*/
|
|
public function delete()
|
|
{
|
|
$this->load();
|
|
|
|
// delete record
|
|
$this->getStore()->update('DELETE FROM `player_software` WHERE `versionId` = :versionId', [
|
|
'versionId' => $this->versionId
|
|
]);
|
|
|
|
// Library location
|
|
$libraryLocation = $this->config->getSetting('LIBRARY_LOCATION');
|
|
|
|
// delete file
|
|
if (file_exists($libraryLocation . 'playersoftware/' . $this->fileName)) {
|
|
unlink($libraryLocation . 'playersoftware/' . $this->fileName);
|
|
}
|
|
|
|
// delete unpacked file
|
|
if (is_dir($libraryLocation . 'playersoftware/chromeos/' . $this->versionId)) {
|
|
(new Filesystem())->remove($libraryLocation . 'playersoftware/chromeos/' . $this->versionId);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @throws \Xibo\Support\Exception\InvalidArgumentException
|
|
*/
|
|
public function unpack(string $libraryFolder, ServerRequest $request): static
|
|
{
|
|
// ChromeOS
|
|
// Unpack the `.chrome` file as a tar/gz, validate its signature, extract it into the library folder
|
|
if ($this->type === 'chromeOS') {
|
|
$this->getLog()->debug('add: handling chromeOS upload');
|
|
|
|
$fullFileName = $libraryFolder . 'playersoftware/' . $this->fileName;
|
|
|
|
// Check the signature of the file to make sure it comes from a verified source.
|
|
try {
|
|
$this->getLog()->debug('unpack: loading gnupg to verify the signature');
|
|
|
|
$gpg = new \gnupg();
|
|
$gpg->seterrormode(\gnupg::ERROR_EXCEPTION);
|
|
$info = $gpg->verify(
|
|
file_get_contents($fullFileName),
|
|
false,
|
|
);
|
|
|
|
if ($info === false
|
|
|| $info[0]['fingerprint'] !== '10415C506BE63E70BAF1D58BC1EF165A0F880F75'
|
|
|| $info[0]['status'] !== 0
|
|
|| $info[0]['summary'] !== 0
|
|
) {
|
|
$this->getLog()->error('unpack: unable to verify GPG. file = ' . $this->fileName);
|
|
throw new GeneralException();
|
|
}
|
|
|
|
$this->getLog()->debug('unpack: signature verified');
|
|
|
|
// Signature verified, move the file, so we can decrypt it.
|
|
rename($fullFileName, $libraryFolder . 'playersoftware/' . $this->versionId . '.gpg');
|
|
|
|
$this->getLog()->debug('unpack: using the shell to decrypt the file');
|
|
|
|
// Go to the shell to decrypt it.
|
|
shell_exec('gpg --decrypt --output ' . $libraryFolder . 'playersoftware/' . $this->versionId
|
|
. ' ' . $libraryFolder . 'playersoftware/' . $this->versionId . '.gpg');
|
|
|
|
// Was this successful?
|
|
if (!file_exists($libraryFolder . 'playersoftware/' . $this->versionId)) {
|
|
throw new NotFoundException('Not found after decryption');
|
|
}
|
|
|
|
// Rename the GPG file back to its original name.
|
|
rename($libraryFolder . 'playersoftware/' . $this->versionId . '.gpg', $fullFileName);
|
|
} catch (\Exception $e) {
|
|
$this->getLog()->error('unpack: ' . $e->getMessage());
|
|
throw new InvalidArgumentException(__('Package file unsupported or invalid'));
|
|
}
|
|
|
|
$zip = new \ZipArchive();
|
|
if (!$zip->open($libraryFolder . 'playersoftware/' . $this->versionId)) {
|
|
throw new InvalidArgumentException(__('Unable to open ZIP'));
|
|
}
|
|
|
|
// Make sure the ZIP file contains a manifest.json file.
|
|
if ($zip->locateName('manifest.json') === false) {
|
|
throw new InvalidArgumentException(__('Software package does not contain a manifest'));
|
|
}
|
|
|
|
// Make a folder for this
|
|
$folder = $libraryFolder . 'playersoftware/chromeos/' . $this->versionId;
|
|
if (is_dir($folder)) {
|
|
unlink($folder);
|
|
}
|
|
mkdir($folder);
|
|
|
|
// Extract to that folder
|
|
$zip->extractTo($folder);
|
|
$zip->close();
|
|
|
|
// Update manifest.json
|
|
$manifest = json_decode(file_get_contents($folder . '/manifest.json'), true);
|
|
|
|
$isXiboThemed = $this->config->getThemeConfig('app_name', 'Xibo') === 'Xibo';
|
|
if (!$isXiboThemed) {
|
|
$manifest['id'] = $this->config->getThemeConfig('theme_url');
|
|
$manifest['name'] = $this->config->getThemeConfig('theme_name');
|
|
$manifest['description'] = $this->config->getThemeConfig('theme_title');
|
|
$manifest['short_name'] = $this->config->getThemeConfig('app_name') . '-chromeos';
|
|
}
|
|
|
|
// Start URL if we're running in a sub-folder.
|
|
$manifest['start_url'] = (new HttpsDetect())->getBaseUrl($request) . '/pwa';
|
|
|
|
// Update asset URLs
|
|
for ($i = 0; $i < count($manifest['icons']); $i++) {
|
|
if ($manifest['icons'][$i]['sizes'] == '512x512') {
|
|
$manifest['icons'][$i]['src'] = $this->config->uri('img/512x512.png');
|
|
} else {
|
|
$manifest['icons'][$i]['src'] = $this->config->uri('img/192x192.png');
|
|
}
|
|
}
|
|
|
|
file_put_contents($folder . '/manifest.json', json_encode($manifest));
|
|
|
|
// Unlink our decrypted file
|
|
unlink($libraryFolder . 'playersoftware/' . $this->versionId);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setActive(): static
|
|
{
|
|
if ($this->type === 'chromeOS') {
|
|
$this->getLog()->debug('setActive: set this version to be the latest');
|
|
|
|
$chromeLocation = $this->config->getSetting('LIBRARY_LOCATION') . 'playersoftware/chromeos';
|
|
if (is_link($chromeLocation . '/latest')) {
|
|
unlink($chromeLocation . '/latest');
|
|
}
|
|
symlink($chromeLocation . '/' . $this->versionId, $chromeLocation . '/latest');
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Load
|
|
*/
|
|
public function load()
|
|
{
|
|
if ($this->loaded || $this->versionId == null)
|
|
return;
|
|
|
|
$this->loaded = true;
|
|
}
|
|
|
|
/**
|
|
* Save this media
|
|
* @param array $options
|
|
*/
|
|
public function save($options = [])
|
|
{
|
|
$options = array_merge([
|
|
'validate' => true
|
|
], $options);
|
|
|
|
if ($options['validate']) {
|
|
$this->validate();
|
|
}
|
|
|
|
if ($this->versionId == null || $this->versionId == 0) {
|
|
$this->add();
|
|
} else {
|
|
$this->edit();
|
|
}
|
|
}
|
|
|
|
public function validate() {
|
|
// do we already have a file with the same exact name?
|
|
$params = [];
|
|
$checkSQL = 'SELECT `fileName` FROM `player_software` WHERE `fileName` = :fileName';
|
|
|
|
if ($this->versionId != null) {
|
|
$checkSQL .= ' AND `versionId` <> :versionId ';
|
|
$params['versionId'] = $this->versionId;
|
|
}
|
|
|
|
$params['fileName'] = $this->fileName;
|
|
|
|
$result = $this->getStore()->select($checkSQL, $params);
|
|
|
|
if (count($result) > 0) {
|
|
throw new DuplicateEntityException(__('You already own Player Version file with this name.'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return $this
|
|
*/
|
|
public function decorateRecord(): static
|
|
{
|
|
$version = '';
|
|
$code = null;
|
|
$type = '';
|
|
$explode = explode('_', $this->fileName);
|
|
$explodeExt = explode('.', $this->fileName);
|
|
$playerShowVersion = $explodeExt[0];
|
|
|
|
// standard releases
|
|
if (count($explode) === 5) {
|
|
if (str_contains($explode[4], '.')) {
|
|
$explodeExtension = explode('.', $explode[4]);
|
|
$explode[4] = $explodeExtension[0];
|
|
}
|
|
|
|
if (str_contains($explode[3], 'v')) {
|
|
$version = strtolower(substr(strrchr($explode[3], 'v'), 1, 3)) ;
|
|
}
|
|
if (str_contains($explode[4], 'R')) {
|
|
$code = strtolower(substr(strrchr($explode[4], 'R'), 1, 3)) ;
|
|
}
|
|
$playerShowVersion = $version . ' Revision ' . $code;
|
|
// for DSDevices specific apk
|
|
} elseif (count($explode) === 6) {
|
|
if (str_contains($explode[5], '.')) {
|
|
$explodeExtension = explode('.', $explode[5]);
|
|
$explode[5] = $explodeExtension[0];
|
|
}
|
|
if (str_contains($explode[3], 'v')) {
|
|
$version = strtolower(substr(strrchr($explode[3], 'v'), 1, 3)) ;
|
|
}
|
|
if (str_contains($explode[4], 'R')) {
|
|
$code = strtolower(substr(strrchr($explode[4], 'R'), 1, 3)) ;
|
|
}
|
|
$playerShowVersion = $version . ' Revision ' . $code . ' ' . $explode[5];
|
|
// for white labels
|
|
} elseif (count($explode) === 3) {
|
|
if (str_contains($explode[2], '.')) {
|
|
$explodeExtension = explode('.', $explode[2]);
|
|
$explode[2] = $explodeExtension[0];
|
|
}
|
|
if (str_contains($explode[1], 'v')) {
|
|
$version = strtolower(substr(strrchr($explode[1], 'v'), 1, 3)) ;
|
|
}
|
|
if (str_contains($explode[2], 'R')) {
|
|
$code = strtolower(substr(strrchr($explode[2], 'R'), 1, 3)) ;
|
|
}
|
|
$playerShowVersion = $version . ' Revision ' . $code . ' ' . $explode[0];
|
|
}
|
|
|
|
$extension = strtolower(substr(strrchr($this->fileName, '.'), 1));
|
|
|
|
if ($extension == 'apk') {
|
|
$type = 'android';
|
|
} else if ($extension == 'ipk') {
|
|
$type = 'lg';
|
|
} else if ($extension == 'wgt') {
|
|
$type = 'sssp';
|
|
} else if ($extension == 'chrome') {
|
|
$type = 'chromeOS';
|
|
}
|
|
|
|
$this->version = $version;
|
|
$this->code = $code;
|
|
$this->playerShowVersion = $playerShowVersion;
|
|
$this->type = $type;
|
|
|
|
return $this;
|
|
}
|
|
}
|