New feature: shareable user query #6052

Alkarex · 2024-01-21T22:49:49Z

Share the output of a user query by RSS / HTML / OPML with other people through unique URLs.

Replaces the global admin token, which was the only option (but unsafe) to share RSS outputs with other people.

Also add a new HTML output for people without an RSS reader.

Share the output of a user query by RSS / HTML / OPML with other people through unique URLs. Replaces the global admin token, which was the only option (but unsafe) to share RSS outputs with other people. Also add a new HTML output for people without an RSS reader. fix FreshRSS#3066 (comment) fix FreshRSS#3178 (comment)

Alkarex · 2024-01-25T07:49:20Z

Not completely done, but ready for tests and comments.
Lacking in particular:

checkbox to enable/disable sharing of a given user query (will also fix the fact that existing user queries need to be saved once before sharing works)
paging in HTML outputs
OPML sharing
~~Display user labels?~~
Fix article tags
Additional user search
a bit of documentation (help welcome)
HTTP Conditional requests (HTTP 304, caching)

…r queries

Alkarex · 2024-01-25T22:22:19Z

I realised that the current implementation of the user queries was doing lots of redundant SQL queries, also when the user queries were not used. So I did some more refactoring to fix that.

Alkarex · 2024-02-25T17:06:36Z

I have addressed the latest details, so all done here for now (several improvements in particular of the HTML output view are left to future work).
Any comment? Otherwise I will merge shortly.

math-GH · 2024-02-27T20:01:44Z

docs/en/users/user_queries.md

+## Share your user queries
+
+A prerequisite is that the FreshRSS API(s) must be enabled in FreshRSS authentication settings.
+
+From the configuration page of the user queries,
+it is possible to share the output of the user queries with external users,
+in the formats HTML, RSS, and OPML:
+
+![Share user query](../img/users/user-query-share.png)
+
+> ℹ️ Note that the sharing as OPML is only available for user queries based on all feeds, a category, or a feed.
+> Sharing by OPML is **not** available for queries based on user labels or favourites or important feeds,
+> to avoid leaking some feed details in an unintended manner.
+


Let us think to give a note here, that this feature will be available with 1.24 (it will note, that it is not yet available)

math-GH · 2024-02-27T20:16:04Z

app/views/helpers/configure/query.phtml

+		<div class="form-group">
+			<div class="group-controls">
+				<label class="checkbox" for="shareRss">
+					<input type="checkbox" name="query[shareRss]" id="shareRss" value="1" <?= $this->query->shareRss() ? 'checked="checked"' : ''?> />
+					<?= _t('conf.query.filter.shareRss') ?>
+				</label>
+				<?php if ($this->query->sharedUrlRss() !== ''): ?>
+				<ul>
+					<li><a href="<?= $this->query->sharedUrlHtml() ?>"><?= _i('link') ?> <?= _t('conf.query.share.html') ?></a></li>
+					<li><a href="<?= $this->query->sharedUrlRss() ?>"><?= _i('link') ?> <?= _t('conf.query.share.rss') ?></a></li>
+				</ul>
+				<?php endif; ?>
+			</div>
+			<div class="group-controls">
+				<label class="checkbox" for="shareOpml">
+					<input type="checkbox" name="query[shareOpml]" id="shareOpml" value="1" <?= $this->query->shareOpml() && $this->query->safeForOpml() ? 'checked="checked"' : '' ?>
+						<?= $this->query->safeForOpml() ? '' : 'disabled="disabled"' ?> />
+					<?= _t('conf.query.filter.shareOpml') ?>
+				</label>
+				<?php if ($this->query->sharedUrlOpml() !== ''): ?>
+				<ul>
+					<li><a href="<?= $this->query->sharedUrlOpml() ?>"><?= _i('link') ?> <?= _t('conf.query.share.opml') ?></a></li>
+				</ul>
+				<?php endif; ?>
+			</div>
+			<p class="help"><?= _i('help') ?> <?= _t('conf.query.share.help') ?></a></p>
+			<p class="help"><?= _i('help') ?> <?= _t('conf.query.help') ?></a></p>
+		</div>


could we add a check here, if the API is disabled?

(btw: the text in the settings needs an update, while it is not only used for the API)

It is indeed now used for more than the mobile apps.
Note that WebSub, which is also an API, has its own internal option

math-GH · 2024-02-27T20:36:05Z

HTML:

There is a pagination. When I click on "Next"

an "empty" page appears

math-GH · 2024-02-27T20:43:44Z

There is no log entry if the user query is not available for sharing (Service Unavailable! nor if the token is wrong ('User query not found!')

Alkarex · 2024-02-27T23:17:42Z

an "empty" page appears

Inded (Edit: Now that I think about it, what I did in the main page is to fetch 1 article more than demanded to know whether there is more or not)

There is no log entry if the user query is not available for sharing

Yes, this is by design as this can better be seen and reacted upon from the Web server logs (e.g. with Fail2Ban or similar) as I would rather avoid giving the possibility to an external client to too easily flood the FreshRSS user logs. We return different HTTP status codes (404, 422, 503...), which are visible in the Web server logs.

* OPML regression due to *shared user queries* (the XPath attributes were not exported anymore) FreshRSS#6052 * Add master token to HTML Meta RSS link and OPML link FreshRSS#6159 (reply in thread)

* OPML regression due to *shared user queries* (the XPath attributes were not exported anymore) #6052 * Add master token to HTML Meta RSS link and OPML link #6159 (reply in thread)

math-GH · 2024-04-16T21:44:47Z

app/i18n/en/conf.php

 			'state' => 'State',
 			'tags' => 'Display by label',
 			'type' => 'Type',
 		),
 		'get_all' => 'Display all articles',
+		'get_all_labels' => 'Display articles with any label',


Is it obsolete? I cannot find any place where it is used

Strange, I cannot find all this "get_...." labels used somewhere....
@Alkarex Could you help me please?

It is because they are used by string concatenation (which I would like to get rid of precisely because it makes validation and maintenance quite challenging). And there is another layer of property with another name for the getter, which makes it even more difficult to search:

FreshRSS/app/views/configure/queries.phtml

Line 57 in 0ffcf41

<li class="item"><?= _t('conf.query.get_' . $query->getGetType(), $query->getGetName()) ?></li>

math-GH · 2024-11-11T22:21:14Z

app/views/helpers/index/tags.phtml

+	<?php if (!empty($remainingTags)): // more than 7 tags: show dropdown menu ?>
+		<li class="item tag">
+			<div class="dropdown">
+				<div id="dropdown-tags2-<?= $this->entry->id() ?>" class="dropdown-target"></div>


This makes an regression :/
If the tags are shown above and below an article the ID needs to be different from eachother (above: tags and below tags2).
With tags.html, It is always tags2. Any idea how to handle it?

ping @Alkarex

Quick suggestion: #6990

It would fix it but it does not make me happy because of the very large number that is added.

It would be useful if a variable could be set in normal.html (i.e. $foo = 1 for header tags and $foo = 2 for footer tags). And in tags.html $foo is used. But I cannot find a solution that makes it possible to have the variable setter in normal.phtml

What is the issue with the number? It is rarely used

fix FreshRSS#6052 (comment)

* Fix tag ID uniqueness fix #6052 (comment) * Update app/views/helpers/index/tags.phtml Co-authored-by: maTh <[email protected]> --------- Co-authored-by: maTh <[email protected]>

Alkarex added 2 commits January 21, 2024 23:47

Remove unused method

532a751

Alkarex added Security 🛡️ API 🤝 API for other clients labels Jan 21, 2024

Alkarex added this to the 1.24.0 milestone Jan 21, 2024

This was referenced Jan 21, 2024

Share feeds between users? #3066

Closed

Making a feed public? #3178

Closed

Alkarex added 3 commits January 22, 2024 17:27

Fix token saving

683538e

Implement HTML view

6993784

Merge branch 'edge' into share-query

3ecf861

Alkarex mentioned this pull request Jan 23, 2024

Add a Notes Field #6059

Open

Alkarex added 14 commits January 24, 2024 11:50

Merge branch 'edge' into share-query

6e598a2

Update i18n for master token

c19dd00

Revert i18n get_favorite

04caa7a

Fix missing i18n for user queries from before this PR

fab7789

Remove irrelevant tests

e541a2c

Add link to RSS version

7fcc8e8

Fix getGet

a44fe79

Fix getState

39af573

Fix getSearch

397cfe2

Alternative getSearch

c75100c

Merge branch 'edge' into share-query

46fc369

Default getOrder

7687992

Explicit default state

450dfed

Fix test

1ece7e9

Alkarex marked this pull request as ready for review January 25, 2024 07:49

Alkarex added 2 commits January 25, 2024 18:57

Add OPML sharing

0673bdf

Remove many redundant SQL queries from original implementation of use…

f4babab

…r queries

Alkarex added 6 commits February 25, 2024 17:35

Fix explicit order ASC

73faa34

Add documentation

1b27db6

Help links i18n

3e84769

Note about deprecated master token

e7a9719

Typo

7537560

Doc about format

830f7e0

ColonelMoutarde approved these changes Feb 25, 2024

View reviewed changes

Alkarex merged commit 39cc1c1 into FreshRSS:edge Feb 26, 2024
2 checks passed

Alkarex deleted the share-query branch February 26, 2024 08:01

Alkarex mentioned this pull request Feb 26, 2024

General layout improvement: Top level navigation + structure #6047

Draft

49 tasks

Alkarex linked an issue Feb 26, 2024 that may be closed by this pull request

[Feature] Anonymous reading from the API #6097

Closed

math-GH reviewed Feb 27, 2024

View reviewed changes

math-GH mentioned this pull request Feb 27, 2024

Fix: delete rss view shortcut #6131

Merged

2 tasks

Alkarex mentioned this pull request Mar 5, 2024

Fix OPML export regression and add token in RSS link #6160

Merged

math-GH mentioned this pull request Mar 21, 2024

Fix: dir=rtl #6221

Merged

math-GH reviewed Apr 16, 2024

View reviewed changes

math-GH mentioned this pull request Apr 17, 2024

i18n: Query strings (refactoring) #6315

Open

math-GH mentioned this pull request Apr 24, 2024

Fix: left side border of search bar input #6376

Merged

2 tasks

Alkarex mentioned this pull request May 2, 2024

how to filter feed #2988

Closed

math-GH reviewed Nov 11, 2024

View reviewed changes

Alkarex added a commit to Alkarex/FreshRSS that referenced this pull request Nov 11, 2024

Fix tag ID uniqueness

0eeeb3e

fix FreshRSS#6052 (comment)

Alkarex mentioned this pull request Nov 11, 2024

Fix tag ID uniqueness #6990

Merged

Alkarex added a commit that referenced this pull request Nov 25, 2024

Fix tag ID uniqueness (#6990)

3d8dd6e

* Fix tag ID uniqueness fix #6052 (comment) * Update app/views/helpers/index/tags.phtml Co-authored-by: maTh <[email protected]> --------- Co-authored-by: maTh <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New feature: shareable user query #6052

New feature: shareable user query #6052

Alkarex commented Jan 21, 2024 •

edited

Loading

Alkarex commented Jan 25, 2024 •

edited

Loading

Alkarex commented Jan 25, 2024

Alkarex commented Feb 25, 2024

math-GH Feb 27, 2024

math-GH Feb 27, 2024

Alkarex Feb 27, 2024 •

edited

Loading

math-GH commented Feb 27, 2024

math-GH commented Feb 27, 2024

Alkarex commented Feb 27, 2024 •

edited

Loading

math-GH Apr 16, 2024

math-GH Apr 16, 2024

Alkarex Apr 17, 2024

math-GH Nov 11, 2024

Alkarex Nov 11, 2024

math-GH Nov 14, 2024

Alkarex Nov 18, 2024

New feature: shareable user query #6052

New feature: shareable user query #6052

Conversation

Alkarex commented Jan 21, 2024 • edited Loading

Alkarex commented Jan 25, 2024 • edited Loading

Alkarex commented Jan 25, 2024

Alkarex commented Feb 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alkarex Feb 27, 2024 • edited Loading

Choose a reason for hiding this comment

math-GH commented Feb 27, 2024

math-GH commented Feb 27, 2024

Alkarex commented Feb 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alkarex commented Jan 21, 2024 •

edited

Loading

Alkarex commented Jan 25, 2024 •

edited

Loading

Alkarex Feb 27, 2024 •

edited

Loading

Alkarex commented Feb 27, 2024 •

edited

Loading