Skip to content

feat: file id selection #6365

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

Merged
vitormattos merged 2 commits into from
Jan 7, 2026
Merged

feat: file id selection #6365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
380b7b0
feat: add fileId listing support
vitormattos Jan 7, 2026
00613d7
fix: align frontend with file ids
vitormattos Jan 7, 2026
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
63 changes: 62 additions & 1 deletion lib/Controller/FileController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,8 @@ private function validate(?string $type = null, $identifier = null): DataRespons
* List identification documents that need to be approved
*
* @param string|null $signer_uuid Signer UUID
* @param list<string>|null $nodeIds The list of nodeIds (also called fileIds). It's the ids of files at Nextcloud
* @param list<int>|null $fileIds The list of fileIds (database file IDs). It's the ids of LibreSign files
* @param list<int>|null $nodeIds The list of nodeIds (also called fileIds). It's the ids of files at Nextcloud
* @param list<int>|null $status Status could be none or many of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted.
* @param int|null $page the number of page to return
* @param int|null $length Total of elements to return
Expand All @@ -266,6 +267,7 @@ public function list(
?int $page = null,
?int $length = null,
?string $signer_uuid = null,
?array $fileIds = null,
?array $nodeIds = null,
?array $status = null,
?int $start = null,
Expand All @@ -276,6 +278,7 @@ public function list(
): DataResponse {
$filter = array_filter([
'signer_uuid' => $signer_uuid,
'fileIds' => $fileIds,
'nodeIds' => $nodeIds,
'status' => $status,
'start' => $start,
Expand Down Expand Up @@ -355,6 +358,64 @@ public function getThumbnail(
return $this->fetchPreview($node, $x, $y, $a, $forceIcon, $mode, $mimeFallback);
}

/**
* Return the thumbnail of a LibreSign file by fileId
*
* @param integer $fileId The LibreSign fileId (database id)
* @param integer $x Width of generated file
* @param integer $y Height of generated file
* @param boolean $a Crop, boolean value, default false
* @param boolean $forceIcon Force to generate a new thumbnail
* @param string $mode To force a given mimetype for the file
* @param boolean $mimeFallback If we have no preview enabled, we can redirect to the mime icon if any
* @return FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, array<empty>, array{}>|RedirectResponse<Http::STATUS_SEE_OTHER, array{}>
*
* 200: OK
* 303: Redirect
* 400: Bad request
* 403: Forbidden
* 404: Not found
*/
#[NoAdminRequired]
#[NoCSRFRequired]
#[ApiRoute(verb: 'GET', url: '/api/{apiVersion}/file/thumbnail/file_id/{fileId}', requirements: ['apiVersion' => '(v1)'])]
public function getThumbnailByFileId(
int $fileId = -1,
int $x = 32,
int $y = 32,
bool $a = false,
bool $forceIcon = true,
string $mode = 'fill',
bool $mimeFallback = false,
) {
if ($fileId === -1 || $x === 0 || $y === 0) {
return new DataResponse([], Http::STATUS_BAD_REQUEST);
}

try {
$libreSignFile = $this->fileMapper->getById($fileId);
if ($libreSignFile->getUserId() !== $this->userSession->getUser()->getUID()) {
return new DataResponse([], Http::STATUS_FORBIDDEN);
}

if ($libreSignFile->getNodeType() === 'envelope') {
if ($mimeFallback) {
$url = $this->mimeIconProvider->getMimeIconUrl('folder');
if ($url) {
return new RedirectResponse($url);
}
}
return new DataResponse([], Http::STATUS_NOT_FOUND);
}

$node = $this->accountService->getPdfByUuid($libreSignFile->getUuid());
} catch (DoesNotExistException) {
return new DataResponse([], Http::STATUS_NOT_FOUND);
}

return $this->fetchPreview($node, $x, $y, $a, $forceIcon, $mode, $mimeFallback);
}

/**
* @return FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, array<empty>, array{}>|RedirectResponse<Http::STATUS_SEE_OTHER, array{}>
*/
Expand Down
10 changes: 9 additions & 1 deletion lib/Db/SignRequestMapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,15 @@ private function getFilesAssociatedFilesWithMeQueryBuilder(string $userId, array
}
if (!empty($filter['nodeIds'])) {
$qb->andWhere(
$qb->expr()->in('f.node_id', $qb->createNamedParameter($filter['nodeIds'], IQueryBuilder::PARAM_STR_ARRAY))
$qb->expr()->orX(
$qb->expr()->in('f.node_id', $qb->createNamedParameter($filter['nodeIds'], IQueryBuilder::PARAM_INT_ARRAY)),
$qb->expr()->in('f.signed_node_id', $qb->createNamedParameter($filter['nodeIds'], IQueryBuilder::PARAM_INT_ARRAY))
)
);
}
if (!empty($filter['fileIds'])) {
$qb->andWhere(
$qb->expr()->in('f.id', $qb->createNamedParameter($filter['fileIds'], IQueryBuilder::PARAM_INT_ARRAY))
);
}
if (!empty($filter['status'])) {
Expand Down
243 changes: 242 additions & 1 deletion openapi-full.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4456,6 +4456,19 @@
"nullable": true
}
},
{
"name": "fileIds[]",
"in": "query",
"description": "The list of fileIds (database file IDs). It's the ids of LibreSign files",
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "nodeIds[]",
"in": "query",
Expand All @@ -4464,7 +4477,8 @@
"type": "array",
"nullable": true,
"items": {
"type": "string"
"type": "integer",
"format": "int64"
}
}
},
Expand Down Expand Up @@ -4819,6 +4833,233 @@
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/file/thumbnail/file_id/{fileId}": {
"get": {
"operationId": "file-get-thumbnail-by-file-id",
"summary": "Return the thumbnail of a LibreSign file by fileId",
"tags": [
"file"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "apiVersion",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"v1"
],
"default": "v1"
}
},
{
"name": "fileId",
"in": "path",
"description": "The LibreSign fileId (database id)",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"default": -1
}
},
{
"name": "x",
"in": "query",
"description": "Width of generated file",
"schema": {
"type": "integer",
"format": "int64",
"default": 32
}
},
{
"name": "y",
"in": "query",
"description": "Height of generated file",
"schema": {
"type": "integer",
"format": "int64",
"default": 32
}
},
{
"name": "a",
"in": "query",
"description": "Crop, boolean value, default false",
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
},
{
"name": "forceIcon",
"in": "query",
"description": "Force to generate a new thumbnail",
"schema": {
"type": "integer",
"default": 1,
"enum": [
0,
1
]
}
},
{
"name": "mode",
"in": "query",
"description": "To force a given mimetype for the file",
"schema": {
"type": "string",
"default": "fill"
}
},
{
"name": "mimeFallback",
"in": "query",
"description": "If we have no preview enabled, we can redirect to the mime icon if any",
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
},
{
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
"required": true,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"303": {
"description": "Redirect",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/file": {
"post": {
"operationId": "file-save",
Expand Down
Loading
Loading