[HOWTO] EventScripter Script to Re-Apply Dark Theme After Updates

[andrewjmetzger]

Why this exists

After installing the rather excellent dark theme, I was frustrated that updates temporarily broke the theme until JDownloader 2 was restarted again. So, I looked up the API calls, and created a script for the Event Scripter plugin to work around the bug. This Event Scripter script will check for updates periodically, apply them if JDownloader 2 if it is idle, and then automatically restart JDownloader2 again to fix the dark theme.

To use this, enable Event Scripter from Settings -> Plugins. Then, add a new script with an Interval trigger. Set the trigger to a much longer delay, enable synchronous execution by checking the box, and paste the script from below. Scroll down for detailed instructions.

/*
    Name: Update and Re-Apply Theme
    
    Version: 1.0.1
    
    Author: https://github.com/andrewjmetzger
    
    Description: Check for and apply updates periodically if JDownloader 2 is idle, 
                 and then restart JDownloader 2 one more time to apply the dark theme properly.
                 
    Trigger Required: "Interval" (Recommended: 600000 (10 mins.) or more)
    
    Synchronous execution: Yes (checked)
*/

if (
        callAPI("update", "isUpdateAvailable") &&       // an update is available, and
        !callAPI("linkcrawler", "isCrawling") &&        // LinkCrawler is idle, and
        !callAPI("linkgrabberv2", "isCollecting") &&    // LinkGrabber is idle, and
        !callAPI("extraction", "getQueue").length &&    // nothing is being extracted, then
        isDownloadControllerIdle()                      // if no downloads are running...
) {
    callAPI("update", "restartAndUpdate");              // Check for and apply an update, then
    callAPI("system", "restartJD");                     // restart JDownloader 2 again to fix the theme
}

Headless users only -- here is the same script with no line breaks:

[ {
  "eventTrigger" : "INTERVAL",
  "enabled" : true,
  "name" : "Update: Reapply Theme",
  "script" : "/*\n    Name: Update and Re-Apply Theme\n    \n    Version: 1.0.1\n    \n    Author: https://github.com/andrewjmetzger\n    \n    Description: Check for and apply updates periodically if JDownloader 2 is idle, \n                 and then restart JDownloader 2 one more time to apply the dark theme properly.\n                 \n    Trigger Required: \"Interval\" (Recommended: 600000 (10 mins.) or more)\n    \n    Synchronous execution: Yes (checked)\n*/\n\nif (\n        callAPI(\"update\", \"isUpdateAvailable\") &&       // an update is available, and\n        !callAPI(\"linkcrawler\", \"isCrawling\") &&        // LinkCrawler is idle, and\n        !callAPI(\"linkgrabberv2\", \"isCollecting\") &&    // LinkGrabber is idle, and\n        !callAPI(\"extraction\", \"getQueue\").length &&    // nothing is being extracted, then\n        isDownloadControllerIdle()                      // if no downloads are running...\n) {\n    callAPI(\"update\", \"restartAndUpdate\");              // Check for and apply an update, then\n    callAPI(\"system\", \"restartJD\");                     // restart JDownloader 2 again to fix the theme\n}",
  "eventTriggerSettings" : {
    "lastFire" : 1616161911463,
    "interval" : 600000,
    "isSynchronous" : true
  },
  "id" : 1616156482823
} ]

---

Detailed Instructions

IMPORTANT: For the first time run, you must allow the script to use the Interval permission. Afterwards, the script will run automatically.

1. In the Event Scripter settings, click Add to create a blank script
2. Give the script a name, such as Update and Re-apply theme
3. Change the Trigger for the script to Interval
4. Open the blank script by clicking Edit
5. Change the script interval to something long, like 600000 milliseconds (10 minutes)
6. Check the box to Enable Synchronous execution
7. Copy the first block of code above, and paste it in the Editor
8. Save the script, then in the Event Scripter list click Edit again.
9. Click Test Compile, and dismiss the "Success" message. (Note: If you do not see "Success", make sure to copy/paste the whole script.)
10. Click Test Run to display a permission dialog
11. In the permission dialog, make sure to check Don't show this again, then click Allow
12. To apply the new permissions and close the script editor, click Save

---

@Vinylwalk3r if you like this script and want to include it in the repo, the JSON "headless" script can be added to ./cfg/org.jdownloader.extensions.eventscripter.EventScripterExtension.scripts.json under the JDownloader 2 installation directory. Note that this still requires the user to install and enable Event Scripter beforehand. Let me know and I'm happy to create a PR.

Hope this helps!
@andrewjmetzger

---

Changelog:

Version 1.0.1 - 2021-03-19:

• Updated informational comments
• Added top-level heading ("Why this exists")

Version 1.0.0 - 2021-03-19:

• Initial release

[Vinylwalk3r]

Wow, @andrewjmetzger I godda say, thats not bad work your done here! Way above my head for sure!
You could most certainly make a PR for it, sounds like a awesome idea!

[andrewjmetzger]

Thanks! Would you mind testing it first, please? I only have one system running JD2, and more proof that everything works is always welcome. 😉

Note: If you do any testing, use a super short interval like 60000 milliseconds (1 minute) or something to avoid waiting so long for a restart.

[leeuniverse]

So... I'm dunce, but why do I not see anything related to the actual "files" that are needed to "reapply" the Theme?

After every update, I have to drag and drop the syntheticaBlackEye.jar into the folder structure of JDownloader.

[andrewjmetzger]

Hey @leeuniverse, great question! Normally, to reapply the theme after an update, all you need to do is restart JDownloader 2 (JD2) a second time -- once by clicking the update button, and once more from the File menu. You shouldn't have to reinsert any JARs unless you completely wipe your settings or reinstall the program.

The "trick" discussed in this issue doesn't rely on modifying JD2 files at all. Instead, it uses the built-in Event Scripter plugin to:

1. Detect an update (automatically restarting once if so)
2. If an update was applied in the last step, wait a few seconds and restart JD2 again. The second restart (hopefully) "fixes" the theme.

To add this to your JD2 install, you only need to enable the Event Scripter and add the scripts at the top of this issue.

For more information on the Event Scripter plugin, check out the official docs and this list of curated community scrips.

Let me know if there is anything I can do to further explain or assist you. 😃

[leeuniverse]

Hummm.... Now I think I realize what's happening.

The author has Two install instructions. One in which you change a backup file and I guess it's just one and done? And then another which has an already fully edited .JAR file. Now that I think about it, the first one I guess would work with your method.
I realize I've been using the second install method because the first method doesn't include the "Green Progress Bars" which I like.

So, I guess that's why I was confused. LOL
Thanks for the info....

P.S., since you are on the ball, I figure I'll just ask you. ;)
How the flip do you do his "Terminal" thing to make the Top Bar of JDownloader black like the rest of the program?
I'm guessing Terminal is the Command Prompt right? When I put his code into it nothing happens?
I'm guessing there are "other" steps needed to do this? I don't get why he wasn't clear with this for us non-programers. LOL

[andrewjmetzger]

Both instructions work with this script. You can absolutely use a backup as the author directs, then unzip that and add the green progress bars to the JAR. The steps in this thread should only be followed AFTER the black theme is installed to your satisfaction, including any tweaks such as green progress bars.

Edit: Fixed typos.

[andrewjmetzger]

Apologies, I did not mean to close this issue. 🙃

[andrewjmetzger]

As for the system bar command, you are correct, that is intended to go in the Mac terminal. if the command in the wiki doesn't work, are you using Windows?

On Windows 10, change the accent color in Settings -> Personalization -> Colors:

1. Choose the Dark overall color
2. Uncheck Automatically pick an accent color
3. Choose a dark grey or black or something else as desired
4. Check Show the accent color on ... Title bars and window borders

Otherwise, please post your macOS version (Check this using the Apple menu on the top left of the system bar -> About this Mac).

[leeuniverse]

Thanks... That sort of works. For some reason, it is also changing the color of the Windows Text Links on the Right of that Setting page. So, unfortunately, can't use too much of a dark color, otherwise can't read the links. LOL

BTW, the script you created above, is there also one you can make that will automatically transfer over the JAR file from one location to replace the one that's replaced on Update?

So, as you might know, his download includes already a fully edited (or near to it) Theme JAR file which we can just use to replace the program's theme JAR (save the Title Bar sadly). So on most updates, we have to replace that JAR file again because it gets overwritten on the update to be the default dark Black_Eye theme again.

Thus, it would be nice for the replacing of that file to be done automatically for us like your script does after updating on restart or whatever. Thanks.

[andrewjmetzger]

is there also one you can make that will automatically transfer over the JAR file from one location to replace the one that's replaced on Update?

To clarify, the script in this thread does NOT touch any JARs. Assuming the green progress bars are installed correctly, these things happen when JD2 updates:

1. JD2 looks good, but an update is available. You click the update button.
2. Temporarily the dark theme is broken. Is this when you would replace the JAR?
3. Restart JD2 again using the File menu option. The theme fixes itself and you should NOT need to replace any files.

If the advanced settings are configured correctly, you only have to replace files once per system.