Skip to content

Commit a871910

Browse files
andrey18106andrey18106
committed
feat: maintenance update, basic object storage support, minor cleanup
Signed-off-by: Andrey Borysenko <andrey18106x@gmail.com>
1 parent 31b4ea2 commit a871910

File tree

17 files changed

+7827
-8084
lines changed

17 files changed

+7827
-8084
lines changed

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [0.2.0 - 2024-10-20]
6+
7+
Maintenance update. Update NC versions to support NC30+ only.
8+
9+
### Added
10+
11+
- Added basic ObjectStorage support (/tmp folder used to execute binary scripts)
12+
513
## [0.1.9 - 2023-12-14]
614

715
Maintenance update.

‎appinfo/info.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Nextcloud Python API Framework
2222
- [MediaDC](https://apps.nextcloud.com/apps/mediadc) - Nextcloud Media Duplicate Collector app
2323
]]>
2424
</description>
25-
<version>0.1.9</version>
25+
<version>0.2.0</version>
2626
<licence>agpl</licence>
2727
<author mail="andrey18106x@gmail.com" homepage="https://github.com/andrey18106">Andrey Borysenko</author>
2828
<author mail="bigcat88@icloud.com" homepage="https://github.com/bigcat88">Alexander Piskun</author>
@@ -37,7 +37,7 @@ Nextcloud Python API Framework
3737
<repository type="git">https://github.com/cloud-py-api/cloud_py_api</repository>
3838
<dependencies>
3939
<php min-version="7.4" min-int-size="64" />
40-
<nextcloud min-version="28" max-version="29" />
40+
<nextcloud min-version="30" max-version="31" />
4141
</dependencies>
4242
<repair-steps>
4343
<post-migration>

‎lib/Command/GetFileContentsCommand.php‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,11 @@ class GetFileContentsCommand extends Command {
4545
public const ARGUMENT_FILE_ID = 'fileid';
4646
public const ARGUMENT_USER_ID = 'userid';
4747

48-
/** @var IRootFolder */
49-
private $rootFolder;
50-
51-
/** @var LoggerInterface */
52-
private $logger;
53-
54-
public function __construct(IRootFolder $rootFolder, LoggerInterface $logger) {
48+
public function __construct(
49+
private readonly IRootFolder $rootFolder,
50+
private readonly LoggerInterface $logger
51+
) {
5552
parent::__construct();
56-
57-
$this->rootFolder = $rootFolder;
58-
$this->logger = $logger;
5953
}
6054

6155
protected function configure(): void {

‎lib/Controller/SettingsController.php‎

Lines changed: 11 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828

2929
namespace OCA\Cloud_Py_API\Controller;
3030

31+
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
32+
use OCP\AppFramework\Http\Attribute\PasswordConfirmationRequired;
3133
use OCP\IRequest;
3234
use OCP\AppFramework\Controller;
3335
use OCP\AppFramework\Http;
@@ -38,80 +40,37 @@
3840
use OCA\Cloud_Py_API\Service\UtilsService;
3941

4042
class SettingsController extends Controller {
41-
/** @var SettingsService */
42-
private $service;
43-
44-
/** @var UtilsService */
45-
private $utils;
46-
4743
public function __construct(
4844
IRequest $request,
49-
SettingsService $service,
50-
UtilsService $utils
45+
private readonly SettingsService $service,
46+
private readonly UtilsService $utils
5147
) {
5248
parent::__construct(Application::APP_ID, $request);
53-
54-
$this->service = $service;
55-
$this->utils = $utils;
5649
}
5750

58-
/**
59-
* @NoAdminRequired
60-
* @NoCSRFRequired
61-
*
62-
* @return JSONResponse array of all settings
63-
*/
64-
public function index() {
51+
#[NoAdminRequired]
52+
public function index(): JSONResponse {
6553
return new JSONResponse($this->service->getSettings(), Http::STATUS_OK);
6654
}
6755

68-
/**
69-
* @NoCSRFRequired
70-
*
71-
* @param array $settings
72-
*
73-
* @return JSONResponse
74-
*/
75-
public function update($settings) {
56+
#[PasswordConfirmationRequired]
57+
public function update(array $settings): JSONResponse {
7658
return new JSONResponse($this->service->updateSettings($settings), Http::STATUS_OK);
7759
}
7860

79-
/**
80-
* @NoCSRFRequired
81-
*
82-
* @param array $setting
83-
*
84-
* @return JSONResponse
85-
*/
86-
public function updateSetting($setting) {
61+
#[PasswordConfirmationRequired]
62+
public function updateSetting(array $setting): JSONResponse {
8763
return new JSONResponse($this->service->updateSetting($setting), Http::STATUS_OK);
8864
}
8965

90-
/**
91-
* @NoAdminRequired
92-
* @NoCSRFRequired
93-
*
94-
* @param int $id
95-
*/
96-
public function getSettingById($id): JSONResponse {
66+
public function getSettingById(int $id): JSONResponse {
9767
return new JSONResponse($this->service->getSettingById($id), Http::STATUS_OK);
9868
}
9969

100-
/**
101-
* @NoAdminRequired
102-
* @NoCSRFRequired
103-
*
104-
* @param string $name
105-
*/
10670
public function getSettingByName($name): JSONResponse {
10771
return new JSONResponse($this->service->getSettingByName($name), Http::STATUS_OK);
10872
}
10973

110-
/**
111-
* @NoCSRFRequired
112-
*
113-
* @return JSONResponse array of system configuration
114-
*/
11574
public function systemInfo() {
11675
return new JSONResponse($this->utils->getSystemInfo(), Http::STATUS_OK);
11776
}

‎lib/Db/SettingMapper.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public function __construct(IDBConnection $db) {
4444
* @throws \OCP\AppFramework\Db\DoesNotExistException if not found
4545
* @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException if more than one result
4646
*/
47-
public function find(int $id): Entity {
47+
public function find(int $id): Setting {
4848
$qb = $this->db->getQueryBuilder();
4949

5050
$qb->select('*')

‎lib/Migration/AppDataInitializationStep.php‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,10 @@
3737
use OCA\Cloud_Py_API\Service\UtilsService;
3838

3939
class AppDataInitializationStep implements IRepairStep {
40-
/** @var SettingsMapper */
41-
private $settingMapper;
42-
43-
/** @var UtilsService */
44-
private $utils;
45-
46-
public function __construct(SettingMapper $settingMapper, UtilsService $utils) {
47-
$this->settingMapper = $settingMapper;
48-
$this->utils = $utils;
40+
public function __construct(
41+
private readonly SettingMapper $settingMapper,
42+
private readonly UtilsService $utils,
43+
) {
4944
}
5045

5146
public function getName(): string {

‎lib/Migration/AppUpdateStep.php‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,9 @@
3535
use OCA\Cloud_Py_API\Service\UtilsService;
3636

3737
class AppUpdateStep implements IRepairStep {
38-
/** @var UtilsService */
39-
private $utils;
40-
41-
public function __construct(UtilsService $utils) {
42-
$this->utils = $utils;
38+
public function __construct(
39+
private readonly UtilsService $utils,
40+
) {
4341
}
4442

4543
public function getName(): string {

‎lib/Service/PythonService.php‎

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,29 @@
3232

3333
use OCA\Cloud_Py_API\Db\SettingMapper;
3434
use OCP\AppFramework\Db\DoesNotExistException;
35+
use OCP\ITempManager;
3536

3637
class PythonService {
37-
/** @var string */
38-
private $pythonCommand;
39-
40-
/** @var string */
41-
private $ncInstanceId;
42-
43-
/** @var string */
44-
private $ncDataFolder;
45-
46-
/** @var UtilsService */
47-
private $utils;
38+
private string $pythonCommand;
39+
private string $ncInstanceId;
40+
private string $ncDataFolder;
41+
private bool $isObjectStorage;
4842

4943
public function __construct(
50-
IConfig $config,
44+
private readonly IConfig $config,
5145
SettingMapper $settingMapper,
52-
UtilsService $utils
46+
private readonly UtilsService $utils,
47+
private readonly ITempManager $tempManager,
5348
) {
5449
try {
5550
$pythonCommand = $settingMapper->findByName('python_command');
5651
$this->pythonCommand = $pythonCommand->getValue();
5752
} catch (DoesNotExistException $e) {
5853
$this->pythonCommand = '/usr/bin/python3';
5954
}
60-
$this->utils = $utils;
61-
$this->ncInstanceId = $config->getSystemValue('instanceid');
62-
$this->ncDataFolder = $config->getSystemValue('datadirectory');
55+
$this->ncInstanceId = $this->config->getSystemValue('instanceid');
56+
$this->ncDataFolder = $this->config->getSystemValue('datadirectory');
57+
$this->isObjectStorage = $this->config->getSystemValue('objectstore', null) !== null;
6358
}
6459

6560
/**
@@ -84,10 +79,14 @@ public function run(
8479
array $scriptParams = [],
8580
bool $nonBlocking = false,
8681
array $env = [],
87-
bool $binary = false
82+
bool $binary = false,
8883
) {
8984
if ($binary) {
90-
$cwd = $this->ncDataFolder . '/appdata_' . $this->ncInstanceId . '/' . $appId . '/';
85+
if ($this->isObjectStorage) {
86+
$cwd = ''; // scriptName should already include absolute path (/tmp/...)
87+
} else {
88+
$cwd = $this->ncDataFolder . '/appdata_' . $this->ncInstanceId . '/' . $appId . '/';
89+
}
9190
} else {
9291
$cwd = $this->utils->getCustomAppsDirectory() . $appId . '/';
9392
}
@@ -111,7 +110,15 @@ public function run(
111110
}
112111
if ($nonBlocking) {
113112
if ($binary) {
114-
$logFile = $cwd . 'logs/' . date('d-m-Y_H-i-s', time()) . '.log';
113+
if (!$this->isObjectStorage) {
114+
$logFile = $cwd . 'logs/' . date('d-m-Y_H-i-s', time()) . '.log';
115+
} else {
116+
$tempLogsDir = $this->tempManager->getTempBaseDir() . '/' . $appId . '/logs/';
117+
if (!file_exists($tempLogsDir)) {
118+
mkdir($tempLogsDir, 0700, true);
119+
}
120+
$logFile = $tempLogsDir . $appId . '_' . date('d-m-Y_H-i-s', time()) . '.log';
121+
}
115122
} else {
116123
$appDataDir = $this->ncDataFolder . '/appdata_' . $this->ncInstanceId . '/' . $appId . '/';
117124
$pyBitecodeEnvVar = 'PYTHONBYTECODEBASE="' . $appDataDir . '" ';

‎lib/Service/SettingsService.php‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,9 @@
3535
use OCA\Cloud_Py_API\Db\SettingMapper;
3636

3737
class SettingsService {
38-
/** @var SettingMapper */
39-
private $mapper;
40-
41-
public function __construct(SettingMapper $settingMapper) {
42-
$this->mapper = $settingMapper;
38+
public function __construct(
39+
private readonly SettingMapper $mapper
40+
) {
4341
}
4442

4543
/**

0 commit comments

Comments
 (0)