Replaced/improved Linux install and uninstall scripts. #3226

fiechr · 2015-05-25T10:29:08Z

This install script adds a menu item, desktop icon and file association (mime type) for the current user on Linux - even if the Arduino installation is placed outside of the user's home dir (such as in /opt or /usr/local) - which didn't worked before.

If the xdg-utils aren't available on the target system, a more basic approach is used (just generate and copy the file).

The uninstall script is a simple wrapper and calls the install script to undo the changes.

Also added three more icon resolutions (64px, 72px, 96px) - by using the 256px file - maybe there is a better (vector based) source available for exporting to these resolutions...

Modified build.xml for copying the existing/added icons and existing mime.xml file, both changed/added scripts and adjusted file permissions (ugo+x) for all *.sh files to be executable by others by default after archive extraction. A more conservative approach would be to set only install/uninstall.sh ugo+x.

I tested this on different machines and it works fine so far.

Install script adds menu item, desktop icon, file association for the current user - even if the Arduino installation was placed outside of the user's home dir (such as in /opt or /usr/local). Added three more icon resolutions (64px, 72px, 96px) - by using the 256px file - maybe there is a better source available for this... Modified build.xml for copying the existing icons and mime.xml file, both scripts and adjusted file permissions (ugo+x) for *.sh files to be executable by others by default.

ffissore · 2015-05-25T14:44:55Z

@ArduinoBot build this please

ArduinoBot · 2015-05-25T17:58:35Z

Build successful. Please test this code using one of the following:
http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-3226-BUILD-283-linux32.tar.xz
http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-3226-BUILD-283-linux64.tar.xz
http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-3226-BUILD-283-windows.zip
http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-3226-BUILD-283-macosx.zip

fiechr · 2015-05-26T09:57:32Z

Tested the 32bit and 64bit Linux builds in- and outside the users home dir. Works as expected.

NicoHood · 2015-06-01T18:08:27Z

Is there any documenation on how to run those scripts?
Do I have to call the 1.6.3 uninstall script if I have 1.6.3 installed or can I use the 1.6.4 uninstall script or even run the install script without uninstalling?

fiechr · 2015-06-01T18:30:44Z

Basically install.sh will add entries and icons for the current user, uninstall.sh will remove them. There shouldn't be any way to break anything which can't be restored by the script itself.

There is no need to uninstall first, because these these functions are called anyway when installing.
If there is an existing menu entry created by the current install script, it will be removed, too.

NicoHood · 2015-06-02T15:25:34Z

I've downloaded the PR and only added those two .sh files to my current nightly built (from today).
It deleted my menu bar icon which I created on my own. It added a desktop icon which cannot be executed and has no icon.

Before I added a .desktop entry into the application dir of ubuntu myself. It worked and I could pin it to the menu bar. It opened another instance which wasnt perfect but it worked.

Not sure what I am doing wrong.

fiechr · 2015-06-02T15:50:21Z

To copy the scripts won't be enough. You also need the icon dir and the desktop.template file in the lib/ subdir. Both are in the pull request, too.
I only tested the complete build with all changes applied, so I can't guarantee if it will work this way - but it should.

NicoHood · 2015-06-02T18:37:49Z

Used the full PR now. The desktop icon is now working. I moved this to the menu bar as well.

The menu item is opening another instance of the IDE once again.
So I have the shortcut and the actual instance in my menu bar, 2 icons.

How do I fix this?

fiechr · 2015-06-02T20:36:21Z

The install script adds two independent links. One in the general apps menu (Unity Dash menu for Ubuntu) and an additional one onto the desktop.

The script does not create a shortcut in the launcher. If the user wants it there, he/she has to start the app via the menu and then choose "lock to launcher" (or similar). This part is entirely distribution depended (in this case Ubuntu Unity).

If you drop the desktop icon into the launcher, its like adding a second app with the same name. So the behavior you describe is no surprise.

Personally I already thought of not adding the desktop icon at all, because it's kind of redundant anyway.

NicoHood · 2015-06-04T19:48:50Z

There is no "lock to launcher" option. I can only drag an drop and this opens a second icon.

Conflicts: build/linux/dist/install.sh

fiechr · 2015-06-05T12:19:16Z

You have to right click on the icon after you opened the program from the Dash menu:

NicoHood · 2015-06-05T15:53:19Z

Sadly i cannot create a screenshot when the sebmenu is opened.
Where you have "Arduino IDE" I have "sketch_jun05a [...]" like the name in the opened window. And if O lock this icon the IDE wont start on a click. If I move the desktop icon there it works but opens another instance as described in my last post.

fiechr · 2015-06-05T20:03:44Z

Hmm... this is interesting. This seems to be a Java related issue, like it is described here:
http://askubuntu.com/a/367851

Many Java-based applications have the problem where the windows created by the application are not associated with the shortcut used to start the application (so the dock contains multiple copies of the same icon).

"Unfortunately" my Arduino windows already get automatically grouped by Unity if I open more than one sketch. Maybe because I use the Sun JDK instead of the OpenJDK? I'm using Ubuntu 14.04.

Using xprop on the Arduino window gives me:

$ xprop WM_CLASS
WM_CLASS(STRING) = "sun-awt-X11-XFramePeer", "processing-app-Base"

You could try adding

StartupWMClass=processing-app-Base

to the arduino-arduinoide.desktop file in ~/.local/share/applications

If this helps, I could add this to the .desktop file.

NicoHood · 2015-06-06T12:40:22Z

I am using java 8 due to this bug (used the linked installation instructions) #3174
I am also using the stable Ubuntu release which you can download from the website. I thinks it has a lower version number than yours.

 xprop WM_CLASS
WM_CLASS(STRING) = "sun-awt-X11-XFramePeer", "processing-app-Base"

StartupWMClass=processing-app-Base

This helps!
So if you add this it should be fine. +1 to merge this!

Edit: By the way: I think the new IDE nightly already has some new high res pictures somewhere. Because the icon in the menu bar is also better now. Not sure about that, just want to say it to not dupe the pics.

This should group all open Arduino IDE windows together under one icon (i.e. Ubuntu Unity launcher)

NicoHood · 2015-06-07T17:53:14Z

.ino files now open with the IDE, it would be nice to add the icon to the file as well (if possible).
Is there also a recommended location where the IDE should be placed? I have it somewhere in my home folder.

fiechr · 2015-06-07T18:15:55Z

AFAIK file icons can only be changed by writing to a dir outside the user's home dir - which I wanted to avoid, because everything else works fine without root access. Also I would need a scalable image file (SVG) of the used IDE icon for this.

I guess most people put it in the home folder - which is absolutely fine. I like to put additional "external" software in /opt - but that's mostly a matter of taste.

NicoHood · 2015-06-07T19:16:43Z

So I have to put the arduino folder there and run the script from this location again?
/opt makes totally sense. Thanks

So the script now works fine. I havent checked the script itself since I dont know enough about scripts. But it works and should be added to the IDE.

fiechr · 2015-06-07T21:25:18Z

So I have to put the arduino folder there and run the script from this location again?

Yes, that should do it.

NicoHood · 2015-06-11T10:44:30Z

@ffissore can you please review this so we see it in the new 1.6.5 release?

NicoHood · 2015-10-29T07:32:18Z

Cant anyone review this?

matthijskooijman · 2015-10-29T09:59:55Z

I just reviewed the code, looks ok to me. I wonder if the "legacy" code really needs to be kept around in this script? I'd say that if you want to use XDG-style shortcuts, it is ok to just require xdg-utils to be installed. If you really don't want xdg-utils, you can still just create the .desktop manually. @cmaglie, any view on this?

Regarding the startup wmclass thing, having that set to "processing" probably isn't ideal, since it might conflict with the actual processing. Any idea if we can change that? Or is that tied to the main class name perhaps?

Finally, I think the script should support the -h and --help options. When I have an unknown script, I usually run it with --help to see what it will be doing exactly and I expect either help output, or an error that --help isn't supported. Right now, the script just proceeds with installing, which isn't so great.

I just tested the current build on Debian Jessie, which works as expected :-)

NicoHood · 2015-10-29T12:05:25Z

I aggree with the -h option.

The script works perfectly for me. Ive used it once and the shortcut just keeps working since then, even with newer builds. I used Elementary OS here, based on ubuntu, based on debian.

fiechr · 2015-10-29T13:29:59Z

Regarding the startup wmclass thing, having that set to "processing" probably isn't ideal, since it might conflict with the actual processing. Any idea if we can change that? Or is that tied to the main class name perhaps?

Yeah, I agree, that bothered me a little bit, too - it's definitely not ideal. But it seems the only reliable ID a (Java) window/app can be identified by. I have no idea how much effort it would be to change this.

I just reviewed the code, looks ok to me. I wonder if the "legacy" code really needs to be kept around in this script?

The main reason I put this in in the first place, is for removing existing links/symbols created by the existing install script.
But I also don't know how many distributions come with XDG tools (installed), so I wanted to make sure that a least something useful is created - which, I guess, is better than giving an error message or do nothing.

About the --help / -h option:
I also think that's a good idea - I will add this. :-)

(First I thought about asking the user before doing anything - but then user interaction would be required - and I also don't wanted it to be too complicated.)

matthijskooijman · 2015-10-29T13:35:07Z

The main reason I put this in in the first place, is for removing existing links/symbols created by the existing install script.
It doesn't seem unreasonable to expect people to uninstall the old version before installing this one, though it might be good to also uninstall it before installing, indeed.

But I also don't know how many distributions come with XDG tools (installed), so I wanted to make sure that a least something useful is created - which, I guess, is better than giving an error message or do nothing.

Having an error message that says "please install xdg-utils" seems reasonable to me? The end result is actually better than falling back to a short-cut-only install.

matthijskooijman · 2015-10-29T13:35:36Z

About the --help / -h option:
I also think that's a good idea - I will add this. :-)

It's probably a good idea to also error out when any unknown options are given?

fiechr · 2015-11-02T11:45:40Z

I added a help option:

$ ./install -h

This script will add an Arduino IDE menu entry, icons and
file associations for the current user.

Optional arguments are:

    -u, --uninstall          Removes icons and menu item.

    -h, --help               Shows this help again.

All other arguments will produce an error:

$ ./install.sh --unknown

Invalid option -- '--unknown'

(and after this show the help above)

If xdg-utils isn't found on the system the help will also show a note that they are recommended.

matthijskooijman · 2015-11-03T08:35:39Z

Help option looks good to me!

jonnius · 2015-11-17T20:24:23Z

Please fix issue #4168, too! In your PR it still persists.

fiechr · 2015-11-18T17:11:17Z

Thanks! I will look into it!

…older locations.

fiechr · 2015-11-20T14:45:05Z

I changed the script so it will (basically) use the following method to find the correct Desktop directory:
http://www.freedesktop.org/wiki/Software/xdg-user-dirs/
This should also work for different languages/names of this folder.
If nothing is found this way, it will fall back to ~/Desktop (if it exists).

This change only affects the "simple install" mode, because the default install using the xdg-utils should already figure out the correct target directory by itself.

It would be nice if someone could test this on a system where the desktop folder's name isn't "Desktop" (and/or isn't placed in $HOME).

If you already have xdg-utils installed and also want to test the script without it, just edit the install.sh script file and replace
return 0
with
return 1
on line 182.

jonnius · 2015-11-20T17:24:12Z

The path is correct now. But the created desktop file on desktop is empty. Here is the output: https://gist.github.com/jonnius/1a4c75ba012b8baab090

fiechr · 2015-11-21T10:27:30Z

Just to be sure: Can you shortly describe how you tested this? Did you just take the script files or rebuild the whole package including all changes? Because there are other files included which are needed.

For example:
sed claims "[...]/Arduino/build/linux/dist/lib/desktop.template" can't be found. But it's part of the Arduino package/archive (of this PR) - so it has to be there.

The same is true for all the icon files and the mime xml file.

jonnius · 2015-11-21T12:17:11Z

I cloned this branch and just started the script.

The icons seem to be located in build/shared/icons, but it is looking for it in build/linux/dist/lib/icons.
The desktop.template is located in build/linux/dist/desktop.template, but it is looking for build/linux/dist/lib/desktop.template.
I cannot find any arduino-arduinoide.xml in the branch at all...

fiechr · 2015-11-21T12:31:31Z

Ok, that explains it. You need to build the dist package first!

Go to Arduino/build in the cloned repo/branch and start the provided build-all-dist.bash script. This will create two archives in the Arduino dir (32 and 64bit) which are the archives you want to install/extract (like the official ones you can download on the website). You only need one of these - depending on your system.
The script will also try to build the Windows version, which will most likely fail - just ignore that.

jonnius · 2015-11-21T15:07:49Z

I ran the build-all script and as you mentioned, linux build was successful and windows build was not. But after that I still have the same issue as before.

fiechr · 2015-11-21T16:27:28Z

Where exactly did you extract the created archive? If it's really the exact same error as before, then it seems you are still starting the script from within the repository structure.

jonnius · 2015-11-21T23:19:00Z

Sorry, i was in the wrong directory. I can confirm that it works as expected! Thanks!

ffissore · 2015-11-23T15:34:31Z

@fiechr I've rebased your PR and pushed it to master. It will be available in next hourly build http://www.arduino.cc/en/Main/Software#hourly. Thank you very much for your time and patience

NicoHood · 2015-12-04T22:08:28Z

Except that my raspberry pi (arm) IDE doesnt start at all the install script adds a few warnings:

pi@raspberrypi ~/Documents/Arduino/Arduino/build $ ./linux/work/install.sh 
Adding desktop shortcut, menu item and file associations for Arduino IDE...touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
touch: cannot touch ‘/home/pi/.local/share/icons/hicolor/.xdg-icon-resource-dummy’: No such file or directory
 done!

Might be related to the LXDE desktop, idk. Just want to mention it here. Hope I can get #3549 running some day.

ffissore self-assigned this May 25, 2015

ffissore added the Component: IDE The Arduino IDE label May 25, 2015

ffissore added this to the Release 1.6.5 milestone May 25, 2015

fiechr added 2 commits June 5, 2015 13:48

Merge branch 'master' into linuxinstall

b2e9403

Conflicts: build/linux/dist/install.sh

Minor improvement for new Linux install.sh script

95d745d

Added StartupWMClass=processing-app-Base to Linux .desktop file.

8f37455

This should group all open Arduino IDE windows together under one icon (i.e. Ubuntu Unity launcher)

ffissore modified the milestones: Release 1.6.5, Release 1.6.6 Jun 15, 2015

fiechr added 2 commits November 1, 2015 11:32

Merge branch 'master' into linuxinstall

e7ea19e

Added help option for install.sh and changed some texts and comments.

9a3574f

ffissore mentioned this pull request Nov 17, 2015

Linux installer fails creating a desktop shortcut because it uses a hardcoded path to desktop #4168

Closed

fiechr added 2 commits November 20, 2015 15:19

Updated Linux install script to be flexible about different desktop f…

ffc446a

…older locations.

Merge branch 'master' into linuxinstall

c54ce4b

ffissore closed this Nov 23, 2015

ffissore added this to the Release 1.6.7 milestone Nov 23, 2015

NicoHood mentioned this pull request May 20, 2016

Installation script error #4973

Closed

NicoHood unassigned ffissore Jun 27, 2016

NicoHood mentioned this pull request Jun 27, 2016

Arch AUR package help request #5082

Closed

Replaced/improved Linux install and uninstall scripts. #3226

Replaced/improved Linux install and uninstall scripts. #3226

Conversation

fiechr commented May 25, 2015

ffissore commented May 25, 2015

ArduinoBot commented May 25, 2015

fiechr commented May 26, 2015

NicoHood commented Jun 1, 2015

fiechr commented Jun 1, 2015

NicoHood commented Jun 2, 2015

fiechr commented Jun 2, 2015

NicoHood commented Jun 2, 2015

fiechr commented Jun 2, 2015

NicoHood commented Jun 4, 2015

fiechr commented Jun 5, 2015

NicoHood commented Jun 5, 2015

fiechr commented Jun 5, 2015

NicoHood commented Jun 6, 2015

NicoHood commented Jun 7, 2015

fiechr commented Jun 7, 2015

NicoHood commented Jun 7, 2015

fiechr commented Jun 7, 2015

NicoHood commented Jun 11, 2015

NicoHood commented Oct 29, 2015

matthijskooijman commented Oct 29, 2015

NicoHood commented Oct 29, 2015

fiechr commented Oct 29, 2015

matthijskooijman commented Oct 29, 2015

matthijskooijman commented Oct 29, 2015

fiechr commented Nov 2, 2015

matthijskooijman commented Nov 3, 2015

jonnius commented Nov 17, 2015

fiechr commented Nov 18, 2015

fiechr commented Nov 20, 2015

jonnius commented Nov 20, 2015

fiechr commented Nov 21, 2015

jonnius commented Nov 21, 2015

fiechr commented Nov 21, 2015

jonnius commented Nov 21, 2015

fiechr commented Nov 21, 2015

jonnius commented Nov 21, 2015

ffissore commented Nov 23, 2015

NicoHood commented Dec 4, 2015