Add date column to the built-in search engine #20703

ducalex · 2024-04-14T16:53:13Z

This PR adds a date column to the built-in search engine to show when a torrent was published/uploaded on the torrent site.

When a plugin wants to show a date, it can now add a date entry to its result dict. The value format is a unix timestamp (an integer representing seconds since epoch).

This commit adds the date column to both the Qt UI and the WebUI and updates the nova3 prettyPrinter.

Plugins with no date support will keep working.

If this PR is accepted, I will send a PR to the plugins repo to update as many plugins as I can! Here's the updated thepiratebay for testing the PR: https://github.com/ducalex/qbittorrent-search-plugins/blob/ducalex/add-date-field-tpb/nova3/engines/piratebay.py

Related open issues: #1463

Still to do are translations (a single additional string "Date"), am I expected to update all translations?

The guidelines suggest I include a screenshot (desktop top, webui bottom):

src/base/search/searchhandler.cpp

Piccirello · 2024-04-18T06:50:34Z

This is a nice addition! I think a more descriptive name could be useful, like "Uploaded On" or "Created On".

I'll note that I personally prefer "At" to "On" (i.e. "Uploaded At") since this field includes the time, however the Transfers table already uses On for this use case (e.g. "Added On', "Completed On").

ducalex · 2024-04-18T18:41:50Z

This is a nice addition! I think a more descriptive name could be useful, like "Uploaded On" or "Created On".

I'll note that I personally prefer "At" to "On" (i.e. "Uploaded At") since this field includes the time, however the Transfers table already uses On for this use case (e.g. "Added On', "Completed On").

I struggled to choose a name! I've considered Added, Uploaded, Created, and Published. I quickly dismissed Created because the torrent itself also has a creation date that is unrelated to when i twas sent to the website so it might be misleading (Though if you think Created is best, I'll still go with it of course). I've looked at what the torrent websites usually name that column and "Added" or "Added On" seemed the most common, followed by simply "Date" or "Time".

There's also the question of all the other symbols added by this PR:

SearchResultColumn enum name (currently PL_DATE)
SearchResult member variable name (currently date)
SearchSortModel SearchColumn enum name (currently DATE)
The key used in json serialization for the WebUI (currently date)
The key used in the search plugins (currently date)

Do you foresee a future where more than one "date" might be returned by a search result? If so maybe I should rename all of them to something better, but what?

glassez · 2024-04-19T03:28:57Z

I struggled to choose a name! I've considered Added, Uploaded, Created, and Published

I would vote for Published.

glassez · 2024-04-19T03:35:02Z

maybe I should rename all of them to something better, but what?

Accordingly to chosen name, e.g. PL_PUBLICATION_DATE.

Piccirello · 2024-04-19T03:35:45Z

My personal choice is for Uploaded On. If we do go with Published instead, I'd strongly push for appending "On" to make clear that it's a date.

Do you foresee a future where more than one "date" might be returned by a search result? If so maybe I should rename all of them to something better, but what?

It's unlikely that there will be, but it's also notoriously difficult to predict future improvements. I never would have predicted this date field! The safest option would be to rename the relevant symbols once you decide on a new column name (e.g. uploaded_on).

glassez · 2024-04-19T03:51:41Z

If we do go with Published instead, I'd strongly push for appending "On" to make clear that it's a date.

It was implied that any of the suggested options would have been used with the addition of "On", wasn't it? At least that's how I thought of it. So yes, I vote for "Published On".

ducalex · 2024-04-19T16:42:28Z

"Published On" and "Uploaded On" are both good options. Neither seem to have an edge when it comes to translations.

So what do we do? Wait for others to chime in? Am I the tie breaker? Flip a coin?

glassez · 2024-04-19T17:35:17Z

src/gui/search/searchjobwidget.cpp

@@ -533,6 +534,7 @@ void SearchJobWidget::appendSearchResults(const QVector<SearchResult> &results)
        setModelData(SearchSortModel::SIZE, Utils::Misc::friendlyUnit(result.fileSize), result.fileSize, (Qt::AlignRight | Qt::AlignVCenter));
        setModelData(SearchSortModel::SEEDS, QString::number(result.nbSeeders), result.nbSeeders, (Qt::AlignRight | Qt::AlignVCenter));
        setModelData(SearchSortModel::LEECHES, QString::number(result.nbLeechers), result.nbLeechers, (Qt::AlignRight | Qt::AlignVCenter));
+        setModelData(SearchSortModel::DATE, QLocale().toString(result.date.toLocalTime(), QLocale::ShortFormat), result.date);


How does it look like if the plugin does not provide a date?

It's blank when not set. I think it's also blank on any invalid QDateTime (which shouldn't happen, but who knows).

Would you prefer it shows Unknown? Perhaps we should add a new helper Utils::Misc::friendlyDate to handle it?

Would you prefer it shows Unknown?

I would keep it blank for now.

xavier2k6 · 2024-04-20T07:46:09Z

I struggled to choose a name! I've considered Added, Uploaded, Created, and Published

I would vote for Published.

Another vote in favor of Published On.

Pentaphon · 2024-04-20T10:02:04Z

Another vote in favor of Published On.

This is the only right solution for the new column.

ducalex · 2024-04-21T18:05:25Z

I've made the changes for "Published On" and renamed struct/enum members to pubDate/PUB_DATE (I went with abbreviation because other sibling members also used abbreviation, like DESC. but let me know if you want a full publicationDate/PUBLICATION_DATE).

src/base/search/searchhandler.cpp

src/webui/api/searchcontroller.cpp

This adds a date column to the built-in search engine to show when a torrent was published/uploaded on the engine site. When a plugin wants to show a date, it can now add a `pub_date` entry to its result dict. The value format is a unix timestamp (an integer representing seconds since epoch). This commit adds the date column to both the Qt UI and the WebUI. Plugins with no date support will keep working. Still to do are translation (a single additional string "Published On")

stalkerok · 2024-04-24T20:25:59Z

Published On

Very strange decision to choose this particular name, it is not used anywhere on trackers, usually it is “Added” “Uploaded”

Pentaphon · 2024-04-24T22:49:38Z

Very strange decision to choose this particular name, it is not used anywhere on trackers, usually it is “Added” “Uploaded”

The search engine is not a tracker so "published on" works for all sources regardless of what they use and best of all, makes the most sense.

src/searchengine/nova3/novaprinter.py

stalkerok · 2024-04-25T07:00:31Z

The search engine is not a tracker so "published on" works for all sources regardless of what they use and best of all, makes the most sense.

Nevertheless, you search by trackers and the displayed date is also taken from the tracker. IMO, I would not deviate from the variant used by trackers.

Pentaphon · 2024-04-25T08:13:15Z

Nevertheless, you search by trackers and the displayed date is also taken from the tracker. IMO, I would not deviate from the variant used by trackers.

What they use varies. It's best to pick one thing for our application that makes sense. A torrent is published on a site so "published on" makes sense. If you can come up with a column name that people think is better than "published on", I'd like to see it.

stalkerok · 2024-04-25T08:19:22Z

Don't have to make anything up, most often it's “Added” with or without “On”.
(I don't insist, we can leave it as it is.)

ducalex · 2024-04-25T17:11:16Z

He just didn't change it accordingly. It works if you change 'date' to 'pub_date'.

That's my bad, I've updated the link in the description to point to the branch head.

There's a few more plugins available (you'll have to pick the appropriate file from each branch): https://github.com/ducalex/qbittorrent-search-plugins/branches though some are still WIP like EZTV.

As for the name of the column I don't have much of an opinion, I changed it to Published On (perhaps prematurely) because it seemed to go in that direction in the comments.

glassez · 2024-04-29T18:10:36Z

@ducalex
Thank you!

luzpaz added Search engine Issues related to the search engine/search plugins functionality PR waiting review labels Apr 14, 2024

glassez reviewed Apr 18, 2024

View reviewed changes

src/base/search/searchhandler.cpp Outdated Show resolved Hide resolved

src/base/search/searchhandler.cpp Outdated Show resolved Hide resolved

glassez removed the PR waiting review label Apr 18, 2024

glassez requested a review from a team April 18, 2024 06:08

glassez reviewed Apr 19, 2024

View reviewed changes

ducalex force-pushed the ducalex/add-date-to-search branch from 4e79f02 to f2d09b8 Compare April 21, 2024 18:03

glassez requested changes Apr 22, 2024

View reviewed changes

src/base/search/searchhandler.cpp Outdated Show resolved Hide resolved

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

glassez requested a review from a team April 23, 2024 04:45

glassez added this to the 5.0 milestone Apr 23, 2024

glassez self-requested a review April 23, 2024 07:20

glassez previously approved these changes Apr 23, 2024

View reviewed changes

xavier2k6 previously approved these changes Apr 23, 2024

View reviewed changes

ducalex force-pushed the ducalex/add-date-to-search branch 2 times, most recently from 3fc91c9 to 4a24097 Compare April 23, 2024 13:59

ducalex force-pushed the ducalex/add-date-to-search branch from 4a24097 to da1b847 Compare April 23, 2024 14:03

This comment was marked as resolved.

Sign in to view

Chocobo1 reviewed Apr 25, 2024

View reviewed changes

src/searchengine/nova3/novaprinter.py Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

This comment was marked as duplicate.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

Bump novaprinter.py version number

fb7015d

ducalex dismissed stale reviews from xavier2k6 and glassez via fb7015d April 25, 2024 17:17

glassez approved these changes Apr 25, 2024

View reviewed changes

glassez merged commit 42b8796 into qbittorrent:master Apr 29, 2024
9 of 14 checks passed

ducalex mentioned this pull request Apr 29, 2024

Add date to PirateBay results qbittorrent/search-plugins#277

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add date column to the built-in search engine #20703

Add date column to the built-in search engine #20703

ducalex commented Apr 14, 2024 •

edited

Piccirello commented Apr 18, 2024

ducalex commented Apr 18, 2024

glassez commented Apr 19, 2024

glassez commented Apr 19, 2024

Piccirello commented Apr 19, 2024

glassez commented Apr 19, 2024

ducalex commented Apr 19, 2024

glassez Apr 19, 2024

ducalex Apr 19, 2024 •

edited

ducalex Apr 21, 2024

glassez Apr 22, 2024

xavier2k6 commented Apr 20, 2024

Pentaphon commented Apr 20, 2024

ducalex commented Apr 21, 2024

This comment was marked as resolved.

This comment was marked as resolved.

stalkerok commented Apr 24, 2024

Pentaphon commented Apr 24, 2024 •

edited

stalkerok commented Apr 25, 2024

Pentaphon commented Apr 25, 2024

stalkerok commented Apr 25, 2024 •

edited

This comment was marked as outdated.

This comment was marked as duplicate.

This comment was marked as outdated.

This comment was marked as resolved.

This comment was marked as outdated.

ducalex commented Apr 25, 2024 •

edited

glassez commented Apr 29, 2024

Add date column to the built-in search engine #20703

Add date column to the built-in search engine #20703

Conversation

ducalex commented Apr 14, 2024 • edited

Piccirello commented Apr 18, 2024

ducalex commented Apr 18, 2024

glassez commented Apr 19, 2024

glassez commented Apr 19, 2024

Piccirello commented Apr 19, 2024

glassez commented Apr 19, 2024

ducalex commented Apr 19, 2024

glassez Apr 19, 2024

Choose a reason for hiding this comment

ducalex Apr 19, 2024 • edited

Choose a reason for hiding this comment

ducalex Apr 21, 2024

Choose a reason for hiding this comment

glassez Apr 22, 2024

Choose a reason for hiding this comment

xavier2k6 commented Apr 20, 2024

Pentaphon commented Apr 20, 2024

ducalex commented Apr 21, 2024

This comment was marked as resolved.

This comment was marked as resolved.

stalkerok commented Apr 24, 2024

Pentaphon commented Apr 24, 2024 • edited

stalkerok commented Apr 25, 2024

Pentaphon commented Apr 25, 2024

stalkerok commented Apr 25, 2024 • edited

This comment was marked as outdated.

This comment was marked as duplicate.

This comment was marked as outdated.

This comment was marked as resolved.

This comment was marked as outdated.

ducalex commented Apr 25, 2024 • edited

glassez commented Apr 29, 2024

ducalex commented Apr 14, 2024 •

edited

ducalex Apr 19, 2024 •

edited

Pentaphon commented Apr 24, 2024 •

edited

stalkerok commented Apr 25, 2024 •

edited

ducalex commented Apr 25, 2024 •

edited