Skip to content

feat: add custom apps #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Joly0 wants to merge 1 commit into
base: develop
Choose a base branch
from
+621 −21
Open

feat: add custom apps #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 201 additions & 0 deletions root/app/www/public/ajax/customapps.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
<?php

/*
----------------------------------
------ Created: 022426 ------
------ Custom Apps ------
----------------------------------
*/

error_reporting(E_ERROR | E_PARSE);

if (!$_SESSION) {
session_start();
}

if (!$_SESSION['IN_UI']) {
exit('Invalid session, refresh the page');
}

require '../loader.php';

const CUSTOM_APP_ICON_TYPES = [IMAGETYPE_PNG => 'png', IMAGETYPE_JPEG => 'jpg', IMAGETYPE_WEBP => 'webp'];
const CUSTOM_APP_ICON_MAX_SIZE = 262144;

if ($_POST['m'] == 'getCustomApps') {
$customApps = $proxyDb->getCustomApps();

?>
<table class="table table-bordered table-hover">
<thead>
<tr>
<th>Icon</th>
<th>Name</th>
<th>Label</th>
<th>API Version</th>
<th>OpenAPI URL</th>
<th>Actions</th>
</tr>
</thead>
<tbody>
<?php
if ($customApps) {
foreach ($customApps as $customApp) {
$icon = $customApp['icon'] ? 'images/custom/' . $customApp['icon'] : 'images/logo-16.png';
?>
<tr>
<td><img src="<?= htmlspecialchars($icon) ?>" style="height: 24px;"></td>
<td><?= htmlspecialchars($customApp['name']) ?></td>
<td><?= htmlspecialchars($customApp['label']) ?></td>
<td><?= htmlspecialchars($customApp['api_version']) ?></td>
<td class="text-small"><?= htmlspecialchars($customApp['openapi_url']) ?: '<span class="text-muted">None (manual endpoints only)</span>' ?></td>
<td>
<button class="btn btn-sm btn-outline-info" onclick="openCustomAppForm(<?= intval($customApp['id']) ?>)"><i class="far fa-edit"></i></button>
<button class="btn btn-sm btn-outline-danger" onclick="deleteCustomApp(<?= intval($customApp['id']) ?>)"><i class="far fa-trash-alt"></i></button>
</td>
</tr>
<?php
}
} else {
?><tr><td colspan="6" class="text-center text-muted">No custom apps yet. Add one below.</td></tr><?php
}
?>
</tbody>
</table>
<?php
}

if ($_POST['m'] == 'openCustomAppForm') {
$existing = $_POST['id'] ? $proxyDb->getCustomApp($_POST['id']) : [];

?>
<table class="table table-bordered table-hover">
<tr>
<td class="w-50">
Name<br>
<span class="text-small">Internal identifier: lowercase letters and digits, starting with a letter, like "myapp". Cannot be changed later.</span>
</td>
<td><input type="text" class="form-control" id="custom-app-name" placeholder="myapp" value="<?= htmlspecialchars($existing['name']) ?>" <?= $existing ? 'readonly' : '' ?>></td>
</tr>
<tr>
<td>
Display Label<br>
<span class="text-small">Shown in the navigation bar</span>
</td>
<td><input type="text" class="form-control" id="custom-app-label" placeholder="My App" value="<?= htmlspecialchars($existing['label']) ?>"></td>
</tr>
<tr>
<td>
API Version<br>
<span class="text-small">The API version prefix (e.g. v1, v3)</span>
</td>
<td><input type="text" class="form-control" id="custom-app-api-version" placeholder="v1" value="<?= htmlspecialchars($existing['api_version'] ?: 'v1') ?>"></td>
</tr>
<tr>
<td>
OpenAPI URL (optional)<br>
<span class="text-small">http(s) URL to an openapi.json for endpoint discovery. Leave blank to manage endpoints manually.</span>
</td>
<td><input type="text" class="form-control" id="custom-app-openapi-url" placeholder="https://example.com/openapi.json" value="<?= htmlspecialchars($existing['openapi_url']) ?>"></td>
</tr>
<tr>
<td>
Icon (optional)<br>
<span class="text-small">PNG, JPEG or WebP image for the nav bar. Max 256KB.</span>
<?php if ($existing['icon']) { ?>
<br><br>Current: <img src="images/custom/<?= htmlspecialchars($existing['icon']) ?>" style="height: 24px;">
<?php } ?>
</td>
<td>
<input type="file" class="form-control" id="custom-app-icon" accept="image/png,image/jpeg,image/webp">
</td>
</tr>
</table>
<?php
}

if ($_POST['m'] == 'saveCustomApp') {
$id = intval($_POST['id']);
$name = trim($_POST['name']);
$label = trim($_POST['label']);
$apiVersion = trim($_POST['api_version']) ?: 'v1';
$openapiUrl = trim($_POST['openapi_url']);

//-- PAGE NAMES ARE RESERVED BECAUSE ?app= IS ROUTED BEFORE ?page=
$reservedNames = array_merge(StarrApps::LIST, array_map(fn($page) => basename($page, '.php'), glob(ABSOLUTE_PATH . 'pages/*.php')), ['api', 'feed', 'backup']);

if (!$id && !preg_match('/^[a-z][a-z0-9]{1,31}$/', $name)) {
$error = 'Name must be 2 to 32 lowercase letters or digits, starting with a letter';
} elseif (!$id && in_array($name, $reservedNames)) {
$error = 'The name "' . $name . '" is reserved, pick another one';
} elseif ($label === '' || mb_strlen($label) > 64) {
$error = 'Label is required, max 64 characters';
} elseif (!preg_match('/^v\d+$/', $apiVersion)) {
$error = 'API version must look like v1 or v3';
} elseif ($openapiUrl && !$starr->isHttpUrl($openapiUrl)) {
$error = 'OpenAPI URL must be an http or https URL';
} else {
$fields = ['label' => $label, 'api_version' => $apiVersion, 'openapi_url' => $openapiUrl];

if ($id) {
$error = $proxyDb->updateCustomApp($id, $fields);
} else {
$error = $proxyDb->addCustomApp($fields + ['name' => $name]);
$id = $proxyDb->insertId();

if (!$error) {
$proxyDb->setCustomAppNavSetting($name, true);
}
}
}

echo json_encode($error ? ['error' => $error] : ['id' => $id]);
}

if ($_POST['m'] == 'uploadCustomAppIcon') {
$customApp = $proxyDb->getCustomApp($_POST['id']);
$iconType = $_FILES['icon']['tmp_name'] ? (getimagesize($_FILES['icon']['tmp_name'])[2] ?? 0) : 0;

if (!$customApp) {
$error = 'App not found';
} elseif ($_FILES['icon']['error'] != UPLOAD_ERR_OK) {
$error = 'No file uploaded or upload error';
} elseif ($_FILES['icon']['size'] > CUSTOM_APP_ICON_MAX_SIZE) {
$error = 'File too large, max 256KB';
} elseif (!isset(CUSTOM_APP_ICON_TYPES[$iconType])) { //-- CHECK THE ACTUAL IMAGE CONTENT, NOT THE CLIENT FILENAME
$error = 'Icon must be a PNG, JPEG or WebP image';
} else {
$iconDir = ABSOLUTE_PATH . 'images/custom/';
$filename = $customApp['name'] . '.' . CUSTOM_APP_ICON_TYPES[$iconType];

if (!move_uploaded_file($_FILES['icon']['tmp_name'], $iconDir . $filename)) {
$error = 'Could not store the icon';
} else {
if ($customApp['icon'] && $customApp['icon'] != $filename && file_exists($iconDir . $customApp['icon'])) {
unlink($iconDir . $customApp['icon']);
}

$error = $proxyDb->updateCustomApp($customApp['id'], ['icon' => $filename]);
}
}

echo json_encode($error ? ['error' => $error] : ['icon' => $filename]);
}

if ($_POST['m'] == 'deleteCustomApp') {
$customApp = $proxyDb->getCustomApp($_POST['id']);

if (!$customApp) {
$error = 'App not found';
} elseif (array_filter($starrsTable ?: [], fn($starrInstance) => $starrInstance['starr'] == $customApp['id'] + StarrApps::CUSTOM_ID_OFFSET)) {
$error = 'Cannot delete: there are starr instances using this custom app. Remove them first.';
} elseif (!$error = $proxyDb->deleteCustomApp($customApp['id'])) {
$proxyDb->deleteCustomAppNavSetting($customApp['name']);

if ($customApp['icon'] && file_exists(ABSOLUTE_PATH . 'images/custom/' . $customApp['icon'])) {
unlink(ABSOLUTE_PATH . 'images/custom/' . $customApp['icon']);
}
}

echo json_encode($error ? ['error' => $error] : []);
}
6 changes: 3 additions & 3 deletions root/app/www/public/ajax/starr.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
if (!is_array($test['response']) && str_contains($test['response'], 'doctype')) {
$error = 'The starr app returned HTML, this typically happens with a bad base URL.';
} else {
$name = $test['response']['instanceName'];
$name = $test['response']['instanceName'] ?: ucfirst($app);
}
}

Expand Down Expand Up @@ -187,7 +187,7 @@

?>
<tr class="table-primary">
<td><?= $endpointInfo['label'] ?><br><span class="text-small"><?= $endpoint ?></span></td>
<td><?= htmlspecialchars($endpointInfo['label']) ?><br><span class="text-small"><?= htmlspecialchars($endpoint) ?></span></td>
<td>
<?php
foreach ($endpointInfo['methods'] as $method) {
Expand All @@ -198,7 +198,7 @@
$checked = is_array($existing['endpoints']) && is_array($existing['endpoints'][$endpoint]) && in_array($method, $existing['endpoints'][$endpoint]) ? 'checked' : '';
?>
<div class="form-check form-switch">
<input <?= $checked ?> id="endpoint-counter-<?= $counter ?>" data-endpoint="<?= $endpoint ?>" data-method="<?= $method ?>" type="checkbox" class="form-check-input endpoint-<?= $method ?>">
<input <?= $checked ?> id="endpoint-counter-<?= $counter ?>" data-endpoint="<?= htmlspecialchars($endpoint) ?>" data-method="<?= $method ?>" type="checkbox" class="form-check-input endpoint-<?= $method ?>">
<label for="endpoint-counter-<?= $counter ?>"><?= $method ?></label>
</div>
<?php
Expand Down
6 changes: 3 additions & 3 deletions root/app/www/public/api/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@
if (!$request['name']) {
$requestError = 'name field is required, should be the name of the 3rd party app/script';
} elseif (!$request['starr']) {
$requestError = 'starr field is required, should be one of: ' . implode(', ', StarrApps::LIST);
} elseif (!in_array($request['starr'], StarrApps::LIST)) {
$requestError = 'starr field is not valid, should be one of: ' . implode(', ', StarrApps::LIST);
$requestError = 'starr field is required, should be one of: ' . implode(', ', $starr->getAllAppsList());
} elseif (!in_array($request['starr'], $starr->getAllAppsList())) {
$requestError = 'starr field is not valid, should be one of: ' . implode(', ', $starr->getAllAppsList());
} elseif (!$request['url']) {
$requestError = 'url field is required, should be the local url to the starr app';
} elseif (!$request['apikey']) {
Expand Down
1 change: 1 addition & 0 deletions root/app/www/public/classes/Database.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ class Database
use Settings;
use Starrs;
use Usage;
use CustomApps;

public $db;
public $dbName;
Expand Down
Loading