Add WebAPI for managing torrent WebSeeds #21043

Piccirello · 2024-07-09T21:34:43Z

src/webui/api/apicontroller.cpp

Piccirello · 2024-07-09T21:41:13Z

src/webui/api/torrentscontroller.cpp

+        // sanity check before parsing to prevent QUrl from checking for the existence of files on the filesystem
+        if (!supportedWebseedSchemes.contains(urlStr.section(u"://"_s, 0, 0)))
+            return nonstd::make_unexpected(TorrentsController::tr("URL scheme must be one of [%1]").arg(supportedWebseedSchemes.join(u",")));
+
+        const QUrl url(urlStr, QUrl::StrictMode);
+        if (!url.isValid())
+            return nonstd::make_unexpected(TorrentsController::tr("\"%1\" is not a valid url").arg(urlStr));
+
+        // sanity check after parsing in case QUrl interpereted a different scheme than intended
+        if (!supportedWebseedSchemes.contains(url.scheme()))
+            return nonstd::make_unexpected(TorrentsController::tr("URL scheme must be one of [%1]").arg(supportedWebseedSchemes.join(u",")));


QUrl has support for reading local files, without (unfortunately) any explicit way to disable it. It appears that the only way to prevent QUrl from searching for files on the local filesystem is to ensure that a scheme is explicitly provided. I've taken the approach of supporting http, https, and ftp. This appears to align with BEP 19 and BEP 17, but wanted to call it out in case there are any other opinions. We can of course always modify this later if we run into issues.

src/webui/api/torrentscontroller.cpp

Piccirello · 2024-07-11T16:55:35Z

I pushed up a change to handle url encoded URLs. URLs sent to this API must be url-encoded to allow for the safe usage of the | separator. This will prevent the issue from #19074 from further spreading.

Piccirello · 2024-07-29T22:21:46Z

@qbittorrent/web-developers this PR is no longer dependent on the custom status code commits from #21015 and is ready for review.

src/webui/api/torrentscontroller.cpp

src/webui/webapplication.h

src/webui/api/torrentscontroller.cpp

Chocobo1 · 2024-08-11T07:59:03Z

@Piccirello
Thank you!

Closes qbittorrent#18465. PR qbittorrent#21043.

Piccirello added the WebAPI WebAPI-related issues/changes label Jul 9, 2024

Piccirello requested review from glassez and a team July 9, 2024 21:34

Piccirello commented Jul 9, 2024

View reviewed changes

src/webui/api/apicontroller.cpp Outdated Show resolved Hide resolved

Piccirello commented Jul 9, 2024

View reviewed changes

Chocobo1 reviewed Jul 10, 2024

View reviewed changes

src/webui/api/torrentscontroller.cpp Outdated Show resolved Hide resolved

src/webui/api/torrentscontroller.cpp Outdated Show resolved Hide resolved

src/webui/api/torrentscontroller.cpp Outdated Show resolved Hide resolved

Piccirello force-pushed the api-webseeds branch 2 times, most recently from 3e3b253 to 1a2de33 Compare July 11, 2024 16:53

Piccirello mentioned this pull request Jul 11, 2024

WebUI: Support managing web seeds #21055

Merged

Piccirello force-pushed the api-webseeds branch 2 times, most recently from 26960a1 to da2d59b Compare July 15, 2024 20:51

Piccirello requested a review from Chocobo1 July 24, 2024 06:06

Piccirello force-pushed the api-webseeds branch from da2d59b to 7d1b596 Compare July 29, 2024 22:19

Piccirello force-pushed the api-webseeds branch from 7d1b596 to aff2cce Compare July 29, 2024 22:51

glassez reviewed Jul 30, 2024

View reviewed changes

src/webui/api/torrentscontroller.cpp Outdated Show resolved Hide resolved

src/webui/api/torrentscontroller.cpp Outdated Show resolved Hide resolved

src/webui/api/torrentscontroller.cpp Outdated Show resolved Hide resolved

src/webui/api/torrentscontroller.cpp Outdated Show resolved Hide resolved

Piccirello force-pushed the api-webseeds branch 2 times, most recently from d9e112d to fe9b52e Compare August 4, 2024 20:58

glassez reviewed Aug 5, 2024

View reviewed changes