Adding search files functionality in Paperless from Nextcloud by Jin-Di · Pull Request #49 · nextcloud/integration_paperless

Jin-Di · 2024-12-13T06:22:23Z

#10. Adding search files functionality in Paperless from Nextcloud. The function is similar from Zulip's integration.

provokateurin · 2024-12-13T07:24:07Z

Thanks for your PR, I will take a look next week!

provokateurin

The indentation is very inconsistent, please fix by running composer cs:fix

provokateurin · 2024-12-16T07:49:01Z

lib/Service/NetworkService.php

This looks very much like you copied it from another integration app without the appropriate copyright.
I'm not a fan of this code, but you have to at least add the copyright of the original authors.

provokateurin · 2024-12-16T07:56:46Z

lib/Controller/SearchController.php

This makes no sense, there is no route to this controller method and the frontend never tries to call any API

provokateurin · 2024-12-16T07:57:30Z

package.json

Changing the frontend dependencies is not necessary at all.
You're also adding some new ones that are never used.

provokateurin · 2024-12-16T07:57:35Z

package-lock.json

Revert this as well.

provokateurin · 2024-12-16T07:59:23Z

lib/Service/ApiService.php

+	public function request(string $userId, string $endPoint, array $params = [], string $method = 'GET',
+		bool $jsonResponse = true, bool $paperlessApiRequest = true) {
+		return $this->networkService->request($userId, $endPoint, $params, $method, $jsonResponse, $paperlessApiRequest);
+	}


Please don't do this and add the NetworkService.
You can just implement the call directly like it is done in sendFile().

lib/Service/ApiService.php

provokateurin · 2024-12-16T08:02:48Z

lib/Service/ApiService.php

+		// Sort by most recent
+		// $messages = array_reverse($result['document'] ?? []);
+		return array_slice($result, $offset, $limit);


This endpoint seems to use pagination, so that needs to be implemented for the offset and limit to work properly.

provokateurin · 2024-12-16T08:04:03Z

lib/Search/SearchProvider.php

+	        $formattedResults = array_map(function (array $entry) use ($url): SearchResultEntry {
+			$finalThumbnailUrl = $this->getThumbnailUrl($entry);
+			$title = $entry['title'] ?? 'Untitled';
+        		$context = $entry['__search_hit__']['highlights'] ?? '';


I think this can return HTML (see https://docs.paperless-ngx.com/api/#searching-for-documents), so the result will be quite ugly because it will not be rendered.

May I know which one does you mean?

This contains raw HTML

The strip_tags function at the return will remove the HTML tag, so it won't return any raw HTML.

Ah my bad I didn't see that. Can you already call it when initializing the variable? I feel like it is harder to miss then.

provokateurin · 2024-12-16T08:04:34Z

lib/Search/SearchProvider.php

+				$title,
+            			strip_tags($context),
+			        $link,
+				$finalThumbnailUrl === '' ? 'icon-paperless-search-fallback' : '',


This fallback icon doesn't exist

I think I mislook on this one, will remove it since I don't think thumbnail is required.

provokateurin · 2024-12-16T08:05:18Z

lib/Search/SearchProvider.php

+	 * @return string
+	 */
+	protected function getThumbnailUrl(array $entry): string {
+		return '';


Not implemented?

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

…original authors Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

…in sendFile(). Remove the NetworkService.php Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Jin-Di · 2024-12-18T09:10:53Z

I have fixed issues above, please check @provokateurin.

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

provokateurin

Have you tried running this code against a paperless-ngx instance? I doubt that currently works at all because it doesn't even parse the output correctly.

lib/Service/ApiService.php

provokateurin · 2024-12-18T09:33:27Z

lib/Service/ApiService.php

+				'headers' => array_merge(
+					$this->getAuthorizationHeaders(),
+					[
+						'Content-Type' => 'application/json',


Suggested change

'Content-Type' => 'application/json',

You're not actually sending any data in the body, so this is not correct

provokateurin · 2024-12-18T09:35:11Z

lib/Service/ApiService.php

+		$paperlessURL = rtrim($this->config->url, '/') . '/api/documents/?' . http_build_query($arguments);
+		$result = $this->client->get($paperlessURL,


Suggested change

$paperlessURL = rtrim($this->config->url, '/') . '/api/documents/?' . http_build_query($arguments);

$result = $this->client->get($paperlessURL,

$result = $this->client->get($this->config->url . '/api/documents/?' . http_build_query($arguments),

Just do it like in the sendFile() method. Trimming is not necessary

Just my two cents here. I think users usually input the URL including a trailing slash, especially when they copy-paste them from documentation or browser address bars. This was also one of the issues I faced when testing the code, as I didn't realize that I have a trailing slash behind the URL entered. So, this approach will reduce the chances of errors caused by duplicate slashes or incorrect URLs. Let me know your final decision on which approach you'd like to go with.

lib/Service/ApiService.php

provokateurin · 2024-12-18T09:38:13Z

lib/Service/ApiService.php

+		if (isset($json_body['error'])) {
+			return (array)$json_body;
+		}


I don't see anything like this in the API docs. Please check in the source code of paperless-ngx how an error response will look like and adjust it here.

I don't find any explicit error key in the API responses. However, I noticed that the API returns an HTML response when the URL is incorrect.

So, I’m checking for an HTML key in the JSON. Let me know if you have different ideas.

lib/Search/SearchProvider.php

provokateurin · 2024-12-18T09:42:03Z

lib/Search/SearchProvider.php

+ * This file contains code derived from Nextcloud - Zulip
+ * @copyright Copyright (c) 2024, Edward Ly
+ *
+ * @author Edward Ly <contact@edward.ly>


Also add yourself to this authors list

provokateurin · 2024-12-18T09:42:23Z

lib/Controller/SearchController.php

This Controller is still not used at all, please remove it

My bad, I mislooked.

lib/Service/ApiService.php

Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com> Signed-off-by: Jin-Di <jdgoh334@gmail.com>

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

…m:Jin-Di/integration_paperless into feature/add-search-function-for-nextcloud

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com> Signed-off-by: Jin-Di <jdgoh334@gmail.com>

Modify author list

…m:Jin-Di/integration_paperless into feature/add-search-function-for-nextcloud

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

…xtcloud

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Jin-Di · 2024-12-23T03:30:18Z

I think the pagination is fixed, please check @provokateurin. I believe the Unified Search result is limited to 25 by default. It is hardcoded in the application, the way I exceed it is modifying the code in core/Controller/UnifiedSearchController.php. I didn't find other workarounds, so maybe it is intended to be max 25?

github-actions · 2024-12-28T02:30:40Z

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

pktiuk · 2025-10-01T21:28:52Z

@provokateurin

What is this PR waiting for?

Jin-Di force-pushed the feature/add-search-function-for-nextcloud branch from e8cab4f to 6ad6b89 Compare December 13, 2024 06:34

provokateurin requested changes Dec 16, 2024

View reviewed changes

Jin-Di added 5 commits December 18, 2024 03:33

Adding search files functionality in Paperless from Nextcloud

0e90eb5

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Fix indentation and apply coding standards, add the copyright of the …

0b2be22

…original authors Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Reverted package.json and package-lock.json to original state

d9f6a88

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Modified ApiService.php, implement the call directly like it is done …

80c192c

…in sendFile(). Remove the NetworkService.php Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Remove thumbnail URL function.

49254f7

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Jin-Di force-pushed the feature/add-search-function-for-nextcloud branch from a9ad6b1 to 49254f7 Compare December 18, 2024 03:35

Fix pagination feature

feb3dc7

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Move strip_tag to initialization

72bea30

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

provokateurin requested changes Dec 18, 2024

View reviewed changes

Jin-Di and others added 16 commits December 19, 2024 10:29

Update lib/Service/ApiService.php

f6b0bd1

Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com> Signed-off-by: Jin-Di <jdgoh334@gmail.com>

Update lib/Service/ApiService.php

e392558

Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com> Signed-off-by: Jin-Di <jdgoh334@gmail.com>

Remove controller and change the limit

96dd592

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Merge branch 'feature/add-search-function-for-nextcloud' of github.co…

dcb65fa

…m:Jin-Di/integration_paperless into feature/add-search-function-for-nextcloud

Fix error handling

2e576db

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Update ApiService.php

a636dfe

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Update lib/Search/SearchProvider.php

6f597e6

Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com> Signed-off-by: Jin-Di <jdgoh334@gmail.com>

Update lib/Search/SearchProvider.php

559302b

Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com> Signed-off-by: Jin-Di <jdgoh334@gmail.com>

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

f22e30f

Modify author list

Merge branch 'feature/add-search-function-for-nextcloud' of github.co…

b46d32b

…m:Jin-Di/integration_paperless into feature/add-search-function-for-nextcloud

Update function name and params

78fcaa2

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Unified indentation

4efb291

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Fix pagination

3fb8924

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Some changes

e2028b3

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

Merge branch 'nextcloud:main' into feature/add-search-function-for-ne…

19eb4b8

…xtcloud

Fix pagination

c045eb6

Signed-off-by: Goh Jin Di <jdgoh334@gmail.com>

github-actions bot added the feedback-requested label Dec 28, 2024

		$paperlessURL = rtrim($this->config->url, '/') . '/api/documents/?' . http_build_query($arguments);
		$result = $this->client->get($paperlessURL,

	$paperlessURL = rtrim($this->config->url, '/') . '/api/documents/?' . http_build_query($arguments);
	$result = $this->client->get($paperlessURL,
	$result = $this->client->get($this->config->url . '/api/documents/?' . http_build_query($arguments),

Conversation

Jin-Di commented Dec 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

provokateurin commented Dec 13, 2024

Uh oh!

provokateurin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jin-Di Dec 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jin-Di commented Dec 18, 2024

Uh oh!

provokateurin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Jin-Di commented Dec 23, 2024

Uh oh!

github-actions bot commented Dec 28, 2024

Uh oh!

pktiuk commented Oct 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Jin-Di commented Dec 13, 2024 •

edited

Loading

Jin-Di Dec 18, 2024 •

edited

Loading