Provide a dialog to change the engine version of an existing container

[madoar]

Currently it is not possible to change the engine version of an existing container from inside the container tab. Therefore I propose to provide a dialog which allows changing the engine version of an existing container.

Reaching the dialog

The dialog can be reached via a new button on the overview tab in the container information panel.

Content of the dialog

I propose to design the new dialog similar to the already existing engines tab. This means that the new dialog should consist of the following areas:

• a sidebar on the left side which contains a search box, a list of all available engine types (engine categories) and a list widget selector
• a TabPane for each engine subcategory of the selected engine type in the sidebar.
  Each tab in the TabPane contains a combined list widget with the corresponding engine versions
• a details panel which contains a confirmation panel to apply a selected engine version for the previously selected container

Screenshot of the mentioned engines tab:

Changing the engine version of a container

The engine version change itself should be performed in a new changeVersion version, that should be added to the Engine interface. The changeVersion method could be defined as:

boolean changeVersion(String containerName, Map<String, Object> version);

or if we want to define it analogous to createContainer:

boolean changeVersion(String subCategory, String version, String containerName);

Implementing changeVersion for the wine engine

For the wine engine the following method needs to be implemented in https://github.com/PhoenicisOrg/scripts/blob/master/Engines/Wine/Engine/Implementation/script.js:

changeVersion: function (containerName, subCategory, version) {
    // run wineserver -k
    this.install(subCategory, version);
    // update phoenicis.cfg
    // run wineserver -k
}

Implementing changeVersion for engine types that don't support version changes

For engine types that don't support version changes a dummy implementation needs to be added to their engine implementation. Such a dummy implementation could look like the following:

function changeVersion(container, version) {
   // do nothing
}

or if we want to do provide an implementation which allows for a once only execution:

function changeVersion(container, version) {
   if (!hasEngineInstalled(container)) {
      // install the engine
   }
}

Selecting all allowed engine versions for a container

Containers are often only compatible with a subset of the engine versions. If you try to apply an incompatible engine version on a container, it is possible that the container breaks. To prevent this additionally a selectCompatibleEngineVersions method should be added for the engines. This method then returns a list of all compatible engine versions for a given container.

For more information see the discussion in #1829

[ImperatorS79]

For wine it would simply be:

changeVersion: function (containerName, subCategory, version) {
    this.kill();
    this.install(subCategory, version);
    var parts = subCategory.split("-");
    var distribution = parts[0];
    var architecture = parts[2];

    var containerNameCleaned = containerName.replace(this._containerRegex, '');
    var containerDirectory = this._winePrefixesDirectory + "/" + containerNameCleaned + "/";

    var containerConfiguration = this._configFactory.open(containerDirectory + "/phoenicis.cfg");

    containerConfiguration.writeValue("wineVersion", version);
    containerConfiguration.writeValue("wineDistribution", distribution);
    containerConfiguration.writeValue("wineArchitecture", architecture);
    this.kill();
}

But I do not know how to do the GUI part ^^.

[plata]

Just thinking: we could also make

changeVersion: function (containerName)

and open a wizard from Javascript (like e.g. the custom installer script).

Maybe this would even be the cleaner solution because we could get rid of the subcategory and version which might not be applicable for other engines at all anyways.

[ImperatorS79]

Ok, how would you ask the user for the required wine version (There is the distribution plus the version that you can change) ?

EDIT: something like this ?

changeVersion: function (containerName) {
    var wizard = this.getWizard();
	
    this.kill();
    var architecture = containerConfiguration.readValue("wineArchitecture", "x86");
    var operatingSystem = this._operatingSystemFetcher.fetchCurrentOperationSystem().getWinePackage();
    
    var wineJson = JSON.parse(this.getAvailableVersions());
    var distributions = new Array();
    var versions = new Array();
    wineJson.forEach(function (subPart) {
        var parts = subPart.split("-");
        if(parts[2] == architecture) {
            distributions.push(parts[0]);
            versions.push(new Array()); 
            subPart.packages.forEach(function (winePackage) {
        	versions[distributions.size()].push(winePackage.version);
            });
        }
    });
    
    var selectedDistribution = wizard.menu(tr("Please select the distribution of wine."), distributions);
    var selectedVersion = wizard.menu(tr("Please select the version of wine."), versions[distributions.indexOf(selectedDistribution)]);
    subCategory = selectedDistribution + "-" + operatingSystem + "-" + architecture;
    
    this.install(subCategory, version);

    var containerNameCleaned = containerName.replace(this._containerRegex, '');
    var containerDirectory = this._winePrefixesDirectory + "/" + containerNameCleaned + "/";

    var containerConfiguration = this._configFactory.open(containerDirectory + "/phoenicis.cfg");

    containerConfiguration.writeValue("wineVersion", selectedVersion);
    containerConfiguration.writeValue("wineDistribution", selectedDistribution);
    containerConfiguration.writeValue("wineArchitecture", architecture);
    this.kill();
}

[plata]

Not completely sure about the way the wizard is retrieved (might be required to create a new one) but yeah something in that direction.

[ImperatorS79]

How could I add a button for that in the container information tab ? (next to delete container for example)

[plata]

See

phoenicis/phoenicis-javafx/src/main/java/org/phoenicis/javafx/components/container/skin/ContainerOverviewPanelSkin.java

Line 68 in bd9af0c

private HBox createManagementButtonContainer() {

@madoar do you think this stuff would be easier to find if it was in https://github.com/PhoenicisOrg/phoenicis/tree/master/phoenicis-javafx/src/main/java/org/phoenicis/javafx/views/mainwindow/containers ?

[ImperatorS79]

Okay, but how do I generate a "callback" that will call the javascript changeVersion method when the button is clicked ?

[madoar]

I'm still planning to remove the old org.phoenicis.javafx.views.mainwindow and org.phoenicis.javafx.views.common packages. I just don't have a lot of time to continue working on this currently.

About how to add a new button:
This is quite simple actually. Like @plata mentioned you need to add a new Button object to

phoenicis/phoenicis-javafx/src/main/java/org/phoenicis/javafx/components/container/skin/ContainerOverviewPanelSkin.java

Line 77 in bd9af0c

return new HBox(deleteButton, openFileBrowserButton);

This can be done similar to the other buttons, for example the delete button:

phoenicis/phoenicis-javafx/src/main/java/org/phoenicis/javafx/components/container/skin/ContainerOverviewPanelSkin.java

Lines 69 to 71 in bd9af0c

	final Button deleteButton = new Button(tr("Delete container"));
	deleteButton.setOnMouseClicked(event -> Optional.ofNullable(getControl().getOnDeleteContainer())
	.ifPresent(onDeleteContainer -> onDeleteContainer.accept(getControl().getContainer())));

When implementing a new button you should be aware that the container overview has already been modularized by me. This means it has been split into three components:

• a view (skin) containing the actual visual components. This is the class you're adding the new Button object to
• a controller (behavior). This class doesn't exist for the container overview
• a model (control). This class contains all the internal fields the component knows of for the container overview this is https://github.com/PhoenicisOrg/phoenicis/blob/bd9af0cd71e4f7a2a111684603e51cd9ee8abe20/phoenicis-javafx/src/main/java/org/phoenicis/javafx/components/container/control/ContainerOverviewPanel.java

To add behavior to your new Button object you need to add a callback method to the onMouseClicked listener (for an example see the other buttons inside the component).
Whenever the button has been clicked with the mouse the callback method is executed.

[ImperatorS79]

But how do I ask the callback to execute a javascript method ?

[plata]

Check where this is used:

phoenicis/phoenicis-engines/src/main/java/org/phoenicis/engines/EnginesManager.java

Line 64 in 8061ef2

public void getEngine(String engineId, Consumer<Engine> doneCallback, Consumer<Exception> errorCallback) {

The javascript engine object can be used like a Java object.

[madoar]

@ImperatorS79 To get an EnginesManager instance in the ContainerOverviewPanel you need to pass it through from ContainerInformationPanel#containerEngineController. For this purpose you need to do the following:

• add a getter method for EnginesManager to ContainerEngineController
• add a private final ObjectProperty<ContainerEngineController> containerEngineController; field to ContainerOverviewPanel, including an initialization command in the constructor and a property and getter method (see the other properties for an example)
• Pass the containerEngineController to the ContainerOverviewPanel in
  

  phoenicis/phoenicis-javafx/src/main/java/org/phoenicis/javafx/components/container/skin/ContainerInformationPanelSkin.java

  Lines 81 to 94 in bd9af0c

  	private Tab createContainerOverviewTab() {
  	final ContainerOverviewPanel containerOverviewPanel = new ContainerOverviewPanel();
  	containerOverviewPanel.containerProperty().bind(
  	ObjectBindings.map(getControl().containerProperty(), container -> (WinePrefixContainerDTO) container));
  	containerOverviewPanel.onDeleteContainerProperty().bind(getControl().onDeleteContainerProperty());
  	containerOverviewPanel.onOpenFileBrowserProperty().bind(getControl().onOpenFileBrowserProperty());
  	final Tab containerOverviewTab = new Tab(tr("Information"), containerOverviewPanel);
  	containerOverviewTab.setClosable(false);
  	return containerOverviewTab;
  	}

Afterwards you should be able to access the EngineManager instance via your getControl().getContainerEngineController().getEngineManager() in ContainerOverviewPanelSkin.

If you have additional questions feel free to ask!

[ImperatorS79]

That's above my java skills ^^. I see a little bit what you mean (the general flow), but the implementation details are too difficult for me and I do not have time currently for such things.

[madoar]

@ImperatorS79 what do you require to continue? If you just require a button calling a method inside an interface, implemented by a script, I can implement that for you.

[ImperatorS79]

Just a button that call the changeVersion function in the container panel ^^.

[ImperatorS79]

The superseded issue was alpha-3.

[ImperatorS79]

Solved by #1970.