user-specific file directory should show user name #13380

pranav0510s · 2025-06-19T10:45:40Z

Closes Issue #12269

In this PR, I’ve refactored the CLI preferences to expose getUsername() and getHostname() default methods on CliPreferences, updated JabRefCliPreferences to implement the public getUserAndHost() interface method, and wired the General tab’s “User‐specific file directory” tooltip to display user@host instead of the old String-array approach.

Steps to test

Build and launch JabRef.
Open Options → Library properties and switch to the General tab.
Hover over the User-specific file directory label or text field. You should see your OS username and hostname in the format username@hostname.
Verify that hovering over LaTeX file directory still shows the directory description as before.

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
[/] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
[/] Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
[/] Screenshots added in PR description (if change is visible to the user)
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.

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

jabgui/src/main/java/org/jabref/gui/libraryproperties/general/GeneralPropertiesView.java

Siedlerchr · 2025-06-19T11:08:49Z

jabgui/src/main/java/org/jabref/gui/libraryproperties/general/GeneralPropertiesView.java

+        userSpecificFileDirectoryTooltip.setText(userHost);
+        laTexFileDirectoryTooltip.textProperty().bind(
+                viewModel.laTexFileDirectoryProperty().map(path ->
+                        Localization.lang(path.isEmpty() ? "Directory for LaTeX files: (not set)" : "Directory for LaTeX files: %0", path)


This won't work this way, I think. You need to put the path.isEmpty check before and then have two separate Locallization.lang(...) calls

Siedlerchr · 2025-06-19T11:09:11Z

jablib/src/main/java/org/jabref/logic/util/UserAndHost.java

@@ -0,0 +1,23 @@
+package org.jabref.logic.util;
+
+public class UserAndHost {


This can be made a recod

can i know what do you mean by record?

Google for Java record

Or do Ctrl+Shift+F record in Intellij to see other record code.

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

# Conflicts: # .github/workflows/pr-comment.yml

koppor · 2025-06-19T12:49:53Z

.github/workflows/pr-comment.yml

@@ -76,7 +76,7 @@ jobs:
            echo "workflow_run_id=${{ github.event.workflow_run.id }}" >> $GITHUB_OUTPUT
          fi

-      - name: Check if PR has 'dev: no-bot-comments' label


Why was there a need to touch the workflow file?

koppor · 2025-06-19T12:52:45Z

jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java

    FieldPreferences getFieldPreferences();
-


I think it was intentional to have each method separated by an empty line

koppor · 2025-06-19T12:53:24Z

jablib/src/main/java/org/jabref/logic/util/UserAndHost.java

@@ -0,0 +1,23 @@
+package org.jabref.logic.util;
+
+public class UserAndHost {


Google for Java record

Or do Ctrl+Shift+F record in Intellij to see other record code.

koppor · 2025-06-19T12:53:55Z

jablib/src/main/java/org/jabref/logic/util/UserAndHost.java

+    private final String host;
+
+    public UserAndHost(String user, String host) {
+        this.user = Objects.requireNonNull(user, "user must not be null");


Use JSpecify annotations instead of requireNonNull

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

koppor · 2025-06-22T11:43:25Z

@pranav0510s Please check your CHANGELOG.md modifications. You seem to have modified a section describing changes of a released version. See also the output of our tests.

Siedlerchr · 2025-06-23T19:31:43Z

CHANGELOG.md

@@ -107,6 +107,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added path validation to file directories in library properties dialog. [#11840](https://github.com/JabRef/jabref/issues/11840)
 - We now support usage of custom CSL styles in the Open/LibreOffice integration. [#12337](https://github.com/JabRef/jabref/issues/12337)
 - We added support for citation-only CSL styles which don't specify bibliography formatting. [#12996](https://github.com/JabRef/jabref/pull/12996)
+- We added tooltips to the "User-specific file directory" and "LaTeX file directory" fields of the library properties window. [#12269](https://github.com/JabRef/jabref/issues/12269)


This must be put in the Unreleased section

trag-bot · 2025-06-23T19:36:02Z

@trag-bot didn't find any issues in the code! ✅✨

jabref-machine · 2025-06-23T19:36:06Z

Your pull request needs to link an issue correctly.

To ease organizational workflows, please link this pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue:

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message.

Examples

✅ Fixes #xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
❌ Fixes [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the issue.

jabref-machine · 2025-06-23T19:43:14Z

You modified Markdown (*.md) files and did not meet JabRef's rules for consistently formatted Markdown files. To ensure consistent styling, we have markdown-lint in place. Markdown lint's rules help to keep our Markdown files consistent within this repository and consistent with the Markdown files outside here.

You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "Markdown".

calixtus · 2025-06-23T20:09:23Z

jabgui/src/main/java/org/jabref/gui/libraryproperties/general/GeneralPropertiesView.java

@@ -108,6 +110,18 @@ public void initialize() {
            laTexSpecificFileDirSwitchTooltip.setText(isAbsolute ? switchToRelativeText : switchToAbsoluteText);
        });

+        String userHost = preferences.getUsername() + "@" + preferences.getHostname();


Should be part of record, maybe call method "getCanonicalForm()".

calixtus · 2025-06-23T20:10:28Z

jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java

+    UserAndHost getUserAndHost();
+
+    /** Shortcut for getUserAndHost().getUser() */
+    default String getUsername() {
+        return getUserAndHost().user();
+    }
+
+    /** Shortcut for getUserAndHost().getHost() */
+    default String getHostname() {
+        return getUserAndHost().host();
+    }
+


YAGNI. This clutters CliPreferences. Too much noise. getUserAndHost().host() is simple enough.

calixtus · 2025-06-23T20:10:58Z

jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java

@@ -1456,7 +1457,7 @@ public InternalPreferences getInternalPreferences() {
                Version.parse(get(VERSION_IGNORED_UPDATE)),
                getBoolean(VERSION_CHECK_ENABLED),
                getPath(PREFS_EXPORT_PATH, getDefaultPath()),
-                getUserAndHost(),
+                getUserAndHost().toString(),


toString returns internal jdk string representation. this is outside of your control, use custom getCanonnicalForm() method instead.

calixtus · 2025-06-23T20:17:39Z

jabgui/src/main/java/org/jabref/gui/libraryproperties/general/GeneralPropertiesView.java

+        laTexFileDirectoryTooltip.textProperty().bind(
+                viewModel.laTexFileDirectoryProperty().map(path -> {
+                    if (path.isEmpty()) {
+                        return Localization.lang("Directory for LaTeX files: (not set)");
+                    } else {
+                        return Localization.lang("Directory for LaTeX files: %0", path);
+                    }
+                })
+                );


Validation should go into the viewmodel. See
https://github.com/JabRef/jabref/blob/main/jabgui/src/main/java/org/jabref/gui/shared/SharedDatabaseLoginDialogViewModel.java
and
https://github.com/JabRef/jabref/blob/main/jabgui/src/main/java/org/jabref/gui/shared/SharedDatabaseLoginDialogView.java

henmesh and others added 11 commits June 17, 2025 10:14

Added tooltips for user-specific file directory and LaTeX directory

f98f73a

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Removed unused metadata variable from earlier version

0e9031e

Added changes to CHANGELOG.md

cb04787

Merged upstream, fixed conflicts

0be84ae

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Fixed OS variable import issue

9b08e71

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Fixed GeneralProperties.fxml

80497e2

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

refactor: expose username and hostname via default methods

e1c798a

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

feat: wire user-specific directory tooltip to show user@host

a4d645f

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

fix: make getUserAndHost() public to implement interface

c8b26d2

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Update pr-comment.yml

75b2c92

Merge branch 'main' into issue-12269

a8d24fe

trag-bot bot reviewed Jun 19, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/libraryproperties/general/GeneralPropertiesView.java Outdated Show resolved Hide resolved

pranav0510s marked this pull request as draft June 19, 2025 11:05

Siedlerchr reviewed Jun 19, 2025

View reviewed changes

pranav0510s added 3 commits June 19, 2025 21:31

Fixed the "null" issues

a2052cb

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Fixed the "null" issues

3481df7

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Merge remote-tracking branch 'origin/issue-12269' into issue-12269

b2deaea

# Conflicts: # .github/workflows/pr-comment.yml

koppor reviewed Jun 19, 2025

View reviewed changes

pranav0510s and others added 5 commits June 19, 2025 22:37

Fixed the the space issue issues

42002c5

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Merge branch 'main' into issue-12269

88dff39

Merge remote-tracking branch 'origin/issue-12269' into issue-12269

7c3d3ad

invoked a distinct Localization.lang call

b38061e

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

resolved few conflicts

2fb2e59

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

trag-bot bot reviewed Jun 19, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java Show resolved Hide resolved

trag-bot bot reviewed Jun 19, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java Show resolved Hide resolved

pranav0510s added 2 commits June 20, 2025 01:47

fixed space

e04dfc9

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

fixed space

343e8ba

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Siedlerchr changed the title ~~Issue 12269~~ user-specific file directory should show user name Jun 19, 2025

fixed space

c063060

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

pranav0510s and others added 2 commits June 20, 2025 02:41

fixed localization.lang

ebfdbb5

Signed-off-by: pranavdikshith <dikshithpranav@gmail.com>

Merge branch 'main' into issue-12269

0d44e4d

pranav0510s marked this pull request as ready for review June 19, 2025 17:20

Merge branch 'main' into issue-12269

0741516

koppor and others added 2 commits June 22, 2025 14:02

Discard changes to .github/workflows/pr-comment.yml

9b86cc1

Merge branch 'main' into issue-12269

a39ff62

Siedlerchr reviewed Jun 23, 2025

View reviewed changes

move changelog

3eb74c4

calixtus requested changes Jun 23, 2025

View reviewed changes

calixtus reviewed Jun 23, 2025

View reviewed changes

		@@ -0,0 +1,23 @@
		package org.jabref.logic.util;

		public class UserAndHost {

Uh oh!

user-specific file directory should show user name #13380

Are you sure you want to change the base?

user-specific file directory should show user name #13380

Uh oh!

Conversation

pranav0510s commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Mandatory checks

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!

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!

Uh oh!

koppor commented Jun 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trag-bot bot commented Jun 23, 2025

Uh oh!

jabref-machine commented Jun 23, 2025

Linking a pull request to an issue using a keyword

Examples

Uh oh!

jabref-machine commented Jun 23, 2025

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!

pranav0510s commented Jun 19, 2025 •

edited

Loading