Files
nc_bot_webhooks/lib/Settings/Admin.php
T
kyle 005f76701e docs: update documentation, add future tasks, and fix debug endpoint security
- **Documentation Overhaul**:
  - **README.md**: Restructured installation guide to align with Nextcloud 33+ paths (e.g., "Personal Settings → Security"), added curl examples, updated known limitations, and added a "Future Features" section.
  - **agent.md**: Updated architecture documentation to reflect `TalkService.php` growth (1138 to 1904 lines), updated constructor parameters, and corrected method documentation (e.g., `buildRichObject` now creates TYPE_ROOM shares, `postToRoom` uses query params).
  - **architecture.md**: Added notes regarding the admin gate for the debug endpoint.

- **New Files**:
  - Added `Future to-do.md` to track planned features (inbound messages, filtering, etc.).
  - Added `TODO.md` to track pending tasks and code cleanup.

- **Code Fixes**:
  - **lib/Controller/WebhookController.php**: Re-applied `#[AdminRequired]` attribute to the `debug()` method to enforce admin authentication.
  - **lib/Service/TalkService.php**: Updated docblock for `buildRichObject` to clarify it creates TYPE_ROOM shares.
  - **lib/Settings/Admin.php** & **templates/adminSettings.php**: Corrected bot password generation instructions to point to the correct Nextcloud settings path.

- **Configuration**:
  - **appinfo/info.xml**: Bumped version to 1.2.1 and updated `max-version` to 35.
2026-06-16 13:23:31 -07:00

75 lines
3.4 KiB
PHP

<?php
namespace OCA\Ncbotwebhooks\Settings;
use OCA\Ncbotwebhooks\Service\TalkService;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\IL10N;
use OCP\Settings\ISettings;
class Admin implements ISettings {
private TalkService $talkService;
private IL10N $l10n;
public function __construct(TalkService $talkService, IL10N $l10n) {
$this->talkService = $talkService;
$this->l10n = $l10n;
}
public function getForm(): TemplateResponse {
\OCP\Util::addStyle('nc_bot_webhooks', 'adminSettings');
\OCP\Util::addScript('nc_bot_webhooks', 'settings');
$params = [
'hasBotPassword' => $this->talkService->hasBotPassword(),
'retentionDays' => $this->talkService->getRetentionDays(),
'rooms' => $this->talkService->getRooms(),
'authTokens' => $this->talkService->getAuthTokens(),
'configuredRooms' => $this->talkService->getRooms(),
'serverUrl' => $this->talkService->getBaseUrl(),
'senderName' => $this->talkService->getSenderNameDefault(),
// CLI commands for setup (user copies these to their server)
'l10n' => [
'fetch_rooms' => $this->l10n->t('Fetch Rooms'),
'error_fetching' => $this->l10n->t('Error fetching rooms'),
'save_config' => $this->l10n->t('Save Configuration'),
'config_saved' => $this->l10n->t('Configuration saved'),
'save_failed' => $this->l10n->t('Configuration save failed'),
'generate_token' => $this->l10n->t('Generate Token'),
'revoke_token' => $this->l10n->t('Revoke'),
'no_rooms' => $this->l10n->t('No rooms found'),
'no_rooms_msg' => $this->l10n->t('No Talk rooms are available or you don\'t have permission to view them.'),
'bot_password' => $this->l10n->t('Bot App Password'),
'bot_password_desc' => $this->l10n->t('App password for the "talk-bot" bot user account (not a regular user). Create one in Personal Settings → Security → Devices & sessions.'),
'sender_name' => $this->l10n->t('Default Sender Name'),
'sender_name_desc' => $this->l10n->t('Name used when posting messages as the bot.'),
'image_retention' => $this->l10n->t('Image Retention (days)'),
'image_retention_desc' => $this->l10n->t('How long to keep uploaded images before cleanup.'),
'room_selection' => $this->l10n->t('Room Selection'),
'room_selection_desc' => $this->l10n->t('Select which Talk rooms should accept webhooks. Enable the bot for a room by checking it.'),
'auth_tokens' => $this->l10n->t('Auth Tokens'),
'auth_tokens_desc' => $this->l10n->t('Auth tokens for this room. Used to validate incoming webhook requests.'),
'no_password' => $this->l10n->t('Enter bot password to enable configuration.'),
],
];
$response = new TemplateResponse('nc_bot_webhooks', 'adminSettings', $params);
return $response;
}
public function getPriority(): int {
return 10;
}
public function getSection(): string {
return 'additional';
}
public function getIcons(): array {
$urlGenerator = \OC::$server->get(\OCP\IURLGenerator::class);
return [
$urlGenerator->imagePath('nc_bot_webhooks', 'app.svg'),
];
}
}