Importing pdfs will now always ask for permission to send file to Grobid #9291

DunkDoge · 2022-10-23T14:56:54Z

This fix makes it so that the dialogue box below appears everytime you import a pdf if it has been enabled in preferences. Previously it only asked the first time. However, since this involves privacy it's important to ask everytime.

Previously the code would check whether Grobid was enabled. If it was, it would return true before showing the dialogue box. However now it checks whether it is not enabled and returns false if it isn't.

Fixes koppor#566

Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

tobiasdiez

Thanks a lot for your contribution. Very much appreciated!

I don't think its very user friendly to ask every time.

The confusing part seems to be the "Do not ask again" checkbox, since by design this dialog is only a single-instance confirmation. So I would propose to:

remove the "do not ask again" checkbox
disable grobid by default (this is probably already the default)
add a short privacy statement in the prefs under "enable grobid"

DunkDoge · 2022-10-29T04:09:07Z

@tobiasdiez Hi I've modified the dialogue box according to your dot points. Before I push, I wanted to make sure the "enable grobid" in prefs your talking about is the checkbox in Import and Export (in preferences) where it says "Allow sending PDF files and raw citation strings to a JabRef online service (Grobid)...."

tobiasdiez · 2022-10-29T08:07:20Z

Yes, that's the correct one. Thanks!

tobiasdiez · 2022-10-29T18:33:49Z

src/main/java/org/jabref/gui/importer/GrobidOptInDialogHelper.java

@@ -23,14 +23,15 @@ public static boolean showAndWaitIfUserIsUndecided(DialogService dialogService,
            return true;
        }
        if (preferences.isGrobidOptOut()) {
-            return false;
+            return preferences.isGrobidEnabled();


Can we not completely remove the isGrobidOptOut check and everything else related to the opt-out?

Hi I've removed all the opt out stuff from the dialoghelper. Could you have another look? The only thing I'm confused about though is that the dialog is meant to be single instance. Wouldn't removing opt out cause it to show the box everytime import if Grobid is disabled in prefs?

calixtus · 2022-10-30T20:01:16Z

We should define a general rule how to deal with do-not-ask-agains to avoid inconsistencies in the UI. Let's talk about this in the next devcall.

tobiasdiez · 2022-10-30T21:16:44Z

I agree, a general strategy would be good. But please also keep in mind that the Grobid confirmation is special (at least if I understood it correctly) in that you have a global preference and the dialog in itself is a confirmation that you want to send the information even though the preference is not yet enabled.

calixtus · 2022-10-30T21:39:13Z

Yes of course grobid is special (at least when it works from time to time). But I believe this is a question concerning just the UI.

koppor

The answer to "Do not ask again" should be

stored in the preferences
be customizable in the preference dialog (so that the user can choose whether he wants to be asked again)
handled in this "section" of the code

That way, one gains:

Users are enabled that JabRef always asks
Users are enabled to skip that JabRef asks
Users can re-enable that JabRef always asks.

Thus, please rewrite your code and add new code.

koppor · 2022-11-07T19:58:16Z

src/main/java/org/jabref/gui/importer/GrobidOptInDialogHelper.java

                Localization.lang("Remote services"),
                Localization.lang("Allow sending PDF files and raw citation strings to a JabRef online service (Grobid) to determine Metadata. This produces better results."),
-                Localization.lang("Do not ask again"),


Please keep this!

tobiasdiez · 2022-11-07T20:22:47Z

@koppor as a general strategy, I agree with this. But how is this helping in this special setting where there is already a preference that is controlling if the feature is enabled or not? Having two preference options "Enabling Grobid" and "Ask again for confirmation for Grobid" is not user friendly in my opinion and only confusing.

What I could imagine is to change the global preference to a radio button with the options: enable grobid, disable grobid, always asks for confirm. But to be honest, I don't see the point of "always ask for confirm". Either a user trusts us or not.

Siedlerchr · 2022-11-07T20:38:09Z

The Do not ask again is synced to the preferences so that you can disable this behavior again without resetting all your prefs

koppor · 2022-11-07T21:32:19Z

@tobiasdiez I like your three-state preference. Then, we still keep the "Do not ask again" setting, which then sets the three-state preference to one of the first two (according to the user's choice). Then, "Do not ask again" is persisted "somehow". -- The default preference is "always ask" so that the dialog starts at the first run.

tobiasdiez · 2022-11-07T21:41:39Z

But what are you "asking again" in this situation?
Should choosing "Yes" in the dialog enable the grobid globally? If yes, what's the point of "asking again"?

There are other confusing scenarios:
For example, if you select "don't ask again" in the dialog and click on "No". Later you enable Grobid in the preferences. Should the dialog be displayed again if you invoke the feature? The same if the user selects first "Yes" and then later disables grobid globally. Should the dialog be displayed at all if you enable grobid in the preferences?

I think it is less complex without the "ask again":

grobid enabled globally: no dialog shown
grobid not enabled globally: show dialog

koppor · 2022-11-09T21:27:49Z

But what are you "asking again" in this situation? Should choosing "Yes" in the dialog enable the grobid globally? If yes, what's the point of "asking again"?

DoNotAskAgain(yes) + Grobid(yes): Preference enable grobid
DoNotAskAgain(no) + Grobid(yes): Preference "always ask for confirm"
DoNotAskAgain(yes) + Grobid(no): Preference disable grobid
DoNotAskAgain(no) + Grobid(no): Preference "always ask for confirm"

I see that for case 2 and 4, there is the same setting stored. This has only impact to the button default (which I would say can be ignored) --> the "Yes" button is always the default.

When checking that the dialog is called:

Preference enable grobid --> do not show dialog, use Grobid
Preference disable grobid --> do not show dialog, do not use Grobid
Preference "always ask" --> show dialog

There are other confusing scenarios: For example, if you select "don't ask again" in the dialog and click on "No". Later you enable Grobid in the preferences. Should the dialog be displayed again if you invoke the feature?

No, because the user chose "Enable grobid" and not "always ask"

The same if the user selects first "Yes" and then later disables grobid globally.

No, because the user chose "Disable grobid" and not "always ask"

Should the dialog be displayed at all if you enable grobid in the preferences?

No, because the user chose "Enable grobid" and not "always ask"

I think it is less complex without the "ask again":

The "aks again" has IMHO the benefit that the user does not need to open the preferences. JabRef should be usable "knob-less". This is always a trade-off. We should, however, avoid to send the users ever to the preferences. With "always ask", they are not send to the preferences.

tobiasdiez · 2022-11-09T23:13:20Z

The "aks again" has IMHO the benefit that the user does not need to open the preferences.

That you could also have without the "always ask" option. Upon the first use of the feature (if grobid is not explicitly enabled already), ask the user. Depending on the answer, set the preference to "enable" or "disabled".

koppor · 2022-11-10T21:46:05Z

That you could also have without the "always ask" option. Upon the first use of the feature (if grobid is not explicitly enabled already), ask the user. Depending on the answer, set the preference to "enable" or "disabled".

What about the second usage? If I want to be asked every time? How can I do that? If JabRef stores the preference (use or don't use), it does not ask again.

tobiasdiez · 2022-11-10T21:56:25Z

That wouldn't be possible of course. But as I said above, I don't see the real use case for this. Why would a user want to be asked every time?

koppor · 2023-01-03T23:38:29Z

Closing this issue due to inactivity 💤

Please ping us if you intend to resume work on this one.

Fixes koppor#566

2b1ae49

tobiasdiez requested changes Oct 23, 2022

View reviewed changes

ThiloteE added import preferences labels Oct 24, 2022

Changed dialogue box

a52fb39

DunkDoge marked this pull request as draft October 29, 2022 05:19

Finished dialogue box. Need to add privacy statement

8e2f8fb

Alan Biju and others added 4 commits October 29, 2022 20:16

Added privacy statement in prefs

041fca2

Changelog

b5ff8b8

Removed print lines

ae6234b

Merge branch 'main' into fix-for-issue-koppor566

79e703c

DunkDoge marked this pull request as ready for review October 29, 2022 09:35

DunkDoge requested a review from tobiasdiez October 29, 2022 09:37

tobiasdiez reviewed Oct 29, 2022

View reviewed changes

DunkDoge marked this pull request as draft October 30, 2022 05:22

Update GrobidOptInDialogHelper.java

4a93c85

DunkDoge marked this pull request as ready for review October 30, 2022 05:45

DunkDoge requested a review from tobiasdiez October 30, 2022 05:49

calixtus added the status: devcall label Oct 30, 2022

koppor requested changes Nov 7, 2022

View reviewed changes

koppor added status: devcall status: changes required Pull requests that are not yet complete and removed status: devcall labels Nov 7, 2022

koppor mentioned this pull request Jan 3, 2023

Unchecked "Do not ask again" does not work koppor/jabref#566

Closed

koppor closed this Jan 3, 2023

koppor mentioned this pull request Apr 26, 2023

Grobid config panel with check box #9801

Closed

hanachaari mentioned this pull request Apr 28, 2023

Grobid config panel without checkbox #9802

Closed

koppor mentioned this pull request Oct 20, 2024

Fixed Grobid Preference Dialog Logic, Removed Checkbox #12034

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Importing pdfs will now always ask for permission to send file to Grobid #9291

Importing pdfs will now always ask for permission to send file to Grobid #9291

DunkDoge commented Oct 23, 2022 •

edited

Loading

tobiasdiez left a comment •

edited

Loading

DunkDoge commented Oct 29, 2022

tobiasdiez commented Oct 29, 2022

tobiasdiez Oct 29, 2022

DunkDoge Oct 30, 2022

calixtus commented Oct 30, 2022

tobiasdiez commented Oct 30, 2022

calixtus commented Oct 30, 2022

koppor left a comment

koppor Nov 7, 2022

tobiasdiez commented Nov 7, 2022

Siedlerchr commented Nov 7, 2022

koppor commented Nov 7, 2022

tobiasdiez commented Nov 7, 2022

koppor commented Nov 9, 2022

tobiasdiez commented Nov 9, 2022

koppor commented Nov 10, 2022

tobiasdiez commented Nov 10, 2022

koppor commented Jan 3, 2023

Importing pdfs will now always ask for permission to send file to Grobid #9291

Importing pdfs will now always ask for permission to send file to Grobid #9291

Conversation

DunkDoge commented Oct 23, 2022 • edited Loading

tobiasdiez left a comment • edited Loading

Choose a reason for hiding this comment

DunkDoge commented Oct 29, 2022

tobiasdiez commented Oct 29, 2022

tobiasdiez Oct 29, 2022

Choose a reason for hiding this comment

DunkDoge Oct 30, 2022

Choose a reason for hiding this comment

calixtus commented Oct 30, 2022

tobiasdiez commented Oct 30, 2022

calixtus commented Oct 30, 2022

koppor left a comment

Choose a reason for hiding this comment

koppor Nov 7, 2022

Choose a reason for hiding this comment

tobiasdiez commented Nov 7, 2022

Siedlerchr commented Nov 7, 2022

koppor commented Nov 7, 2022

tobiasdiez commented Nov 7, 2022

koppor commented Nov 9, 2022

tobiasdiez commented Nov 9, 2022

koppor commented Nov 10, 2022

tobiasdiez commented Nov 10, 2022

koppor commented Jan 3, 2023

DunkDoge commented Oct 23, 2022 •

edited

Loading

tobiasdiez left a comment •

edited

Loading