/*
    * Copyright 2013-2023 Medical Information Systems Research Group (https://medical.zcu.cz),
    * Department of Computer Science and Engineering, University of West Bohemia.
    * Address: Univerzitni 8, 306 14 Plzen, Czech Republic.
    *
    * This file is part of Sparkle project.
    *
    * Sparkle is free software: you can redistribute it and/or modify
    * it under the terms of the GNU General Public License as published by
   * the Free Software Foundation, either version 3 of the License.
   *
   * Sparkle is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with Sparkle. If not, see <http://www.gnu.org/licenses/>.
   */
  package cz.zcu.mre.sparkle.gui.mainForm;
  
  import cz.zcu.mre.sparkle.data.*;
  import cz.zcu.mre.sparkle.data.resourceStorage.ResourcesStorage;
  import cz.zcu.mre.sparkle.gui.mainForm.mainMenu.MainMenuAction;
  import cz.zcu.mre.sparkle.gui.mainForm.mainMenu.MainMenuBar;
  import cz.zcu.mre.sparkle.gui.mainForm.mainMenu.MainToolBar;
  import cz.zcu.mre.sparkle.gui.mainForm.mainMenu.menuItems.MenuItemsQuery;
  import cz.zcu.mre.sparkle.gui.mainForm.mainTabPane.MainTabPane;
  import cz.zcu.mre.sparkle.gui.mainForm.mainTabPane.MainTabPaneListener;
  import cz.zcu.mre.sparkle.gui.mainForm.mainTabPane.TabContextMenu;
  import cz.zcu.mre.sparkle.gui.query.QueryFormPane;
  import cz.zcu.mre.sparkle.gui.query.QueryTab;
  import cz.zcu.mre.sparkle.gui.tools.AbstractFormController;
  import cz.zcu.mre.sparkle.tools.Changeable;
  import javafx.beans.InvalidationListener;
  import javafx.beans.property.IntegerProperty;
  import javafx.beans.property.ReadOnlyStringWrapper;
  import javafx.beans.property.SimpleIntegerProperty;
  import javafx.beans.value.ChangeListener;
  import javafx.fxml.FXML;
  import javafx.scene.control.Tab;
  import javafx.scene.control.TabPane;
  import javafx.scene.layout.GridPane;
  import javafx.scene.layout.StackPane;
  import java.io.IOException;
  import java.sql.SQLException;
  import java.util.HashSet;
  import java.util.Properties;
  import java.util.Set;
  import java.util.logging.Logger;
  
  /**
   * Kontroler hlavního okna aplikace.
   *
   * @author Jan Smucr
   * @author Klara Hlavacova
   * @author Petr Vcelak (vcelak@kiv.zcu.cz)
   */
  public final class MainForm
          extends AbstractFormController
          implements Changeable {
  
      private final Set<InvalidationListener> observers = new HashSet<>();
      private static final Logger LOG = Logger.getLogger(MainForm.class.getName());
  
      private static final String DEFAULT_TITLE = "Sparkle"; //$NON-NLS-1$
  
      // Názvy souborů, kam se serializují lokální seznamy
      static final String PREFIXES = "prefixes"; //$NON-NLS-1$
      static final String FUNCTIONS = "functions"; //$NON-NLS-1$
      static final String DATATYPES = "datatypes"; //$NON-NLS-1$
      static final String RESOURCES = "resources"; //$NON-NLS-1$
      public static final String SPARQL_ENDPOINTS = "sparql_endpoints"; //$NON-NLS-1$
  
      /**
       * Uchovává počet záložek s neuloženými změnami. Pokud je 0, lze zablokovat
       * tlačítko Save all.
       */
      private final IntegerProperty unsavedTabsProperty = new SimpleIntegerProperty(0);
  
      /**
       * Posluchač pro každou záložku hlídající, zda jsou v ní neuložené změny.
       */
      private final ChangeListener<? super Boolean> tabHasChangesListener
              = (observable, oldValue, newValue) -> {
                  final int n = newValue ? 1 : -1;
                  unsavedTabsProperty.set(unsavedTabsProperty.get() + n);
              };
  
      /**
       * Umožňuje nastavit titulek okna podle aktuálně vybrané záložky.
       */
      private final InvalidationListener currentTabTextListener = observable -> updateTitle();
  
      @FXML
      private TabPane mainTabPane;
  
      @FXML
      private MainMenuBar mainMenuBar;
 
     @FXML
     private MainToolBar mainToolBar;
 
     @FXML
     private GridPane welcomePane;
     @FXML
     private StackPane stackPane;
 
     private DataAgent dataAgent = null;
 
     private PrefixesStorage appPrefixesStorage;
     private ResourcesStorage appResourcesStorage;
     private DataTypesStorage appDataTypesStorage;
     private FunctionsStorage appFunctionsStorage;
 
     private String defaultTitle;
     private int depth = 3;
     private boolean loading = false;
 
     private final ReadOnlyStringWrapper titleProperty = new ReadOnlyStringWrapper();
 
     /**
      * Zablokuje tlačítko Save, pokud nejsou v aktuální záložce neuložené změny.
      */
     private final ChangeListener<? super Boolean> currentTabHasChangesListener
             = (observable, oldValue, newValue)
             -> mainMenuBar.getMenuItemsQuery().get(MenuItemsQuery.getSaveOrdinal()).setDisable(oldValue);
 
     @Override
     protected final void setup(final Object... args) {
         dataAgent = (DataAgent) args[0];
         watch(dataAgent);
         titleProperty.addListener((observable) -> setTitle());
         titleProperty.set(dataAgent.getStorageName());
 
         mainToolBar.initialize(this);
         mainMenuBar.initialize(this);
 
         MainTabPaneListener.setupListeners(this);
         MainTabPaneListener.onCurrentTabChanged(null, null, this);
 
         LocalStorageAction.loadStorages(this);
         MainFormSetting.loadFormSettings(this);
 
     }
 
     /**
      * Nastavi titulek okna na jmeno (adresu) uloziste
      */
     private void setTitle() {
         defaultTitle = DEFAULT_TITLE + " (" + titleProperty.get() + ")"; //$NON-NLS-1$
         updateTitle();
     }
 
     /**
      * It stores window size, maximization state and selected language into
      * {@link Properties}. If the window is maximized size value is not stored.
      */
     public void saveFormSettings() {
         MainFormSetting.saveFormSettings(this);
     }
 
     /**
      * The method creates context menu for the tab in parameter.
      *
      * @param ownerTab Owner tab of created context menu.
      */
     public void getContextMenu(Tab ownerTab) {
         new TabContextMenu().getContextMenu(ownerTab, this);
     }
 
     /**
      * Serializuje seznamy do výchozího umístění.
      *
      * @throws IOException IO Exception.
      */
     public void storeObjects() throws IOException {
         LocalStorageAction.storeObjects(this);
     }
 
     /**
      * Akce pri uzavreni aplikace
      *
      * @return false - chyba, true - ok
      */
     @Override
     protected final boolean onCloseRequest() {
         return ((MainTabPane) getMainTabPane()).onCloseRequest(this);
     }
 
     /**
      * Složí titulek okna ze standardní části {@link #defaultTitle} a titulku
      * aktuálně vybrané záložky.
      */
     public void updateTitle() {
         final Tab currentTab = ((MainTabPane) mainTabPane).getCurrentTab();
         if (currentTab == null) {
             setTitle(defaultTitle);
             return;
         }
         setTitle(currentTab.getText() + " - " + defaultTitle); //$NON-NLS-1$
     }
 
     /**
      * Provede odpojení. Voláno paralelně z {@link #onCloseRequest()}.
      *
      * @throws SQLException SQL Exception.
      */
     public void disconnect() throws SQLException {
         dataAgent.close();
     }
 
     @FXML
     private void open() {
         MainMenuAction.open(this);
     }
 
     /**
      * Nastavi stav nacitani dotazu
      *
      * @param value true x false
      */
     public void setLoading(boolean value) {
         this.loading = value;
     }
 
     /**
      * It returns relevant {@link QueryTab} due to parameter
      * ({@link QueryFormPane}).
      *
      * @param queryFormPane {@link QueryFormPane} of wanted {@link QueryTab}.
      *
      * @return Relevant {@link QueryTab}.
      */
     public QueryTab getQueryTab(QueryFormPane queryFormPane) {
         return ((MainTabPane) getMainTabPane()).getQueryTab(queryFormPane);
     }
 
     /**
      * It makes new SUBSELECT.
      *
      * @return New SUBSELECT.
      */
     public Tab createNewSubSelectQuery() {
         return ((MainTabPane) getMainTabPane()).createQueryTab(MainTabPane.QueryType.SUBSELECT, this);
     }
 
     @FXML
     private void createNewSelectQuery() {
         mainMenuBar.createNewSelectQueryOnAction();
     }
 
     @FXML
     private void createNewAskQuery() {
         mainMenuBar.createNewAskQueryOnAction();
     }
 
     @FXML
     private void createNewConstructQuery() {
         mainMenuBar.createNewConstructQueryOnAction();
     }
 
     @FXML
     private void createNewDescribeQuery() {
         mainMenuBar.createNewDescribeQueryOnAction();
     }
 
     @FXML
     private void createNewDeleteInsertQuery() {
         mainMenuBar.createNewDeleteInsertQueryOnAction();
     }
 
     @FXML
     private void createNewInsertQuery() {
         mainMenuBar.createNewInsertQueryOnAction();
     }
 
     @FXML
     private void createNewDeleteQuery() {
         mainMenuBar.createNewDeleteQueryOnAction();
     }
 
     /**
      * @return Aktivní {@link QueryTab} nebo <code>null</code>.
      */
     public QueryTab<?> getCurrentQueryTab() {
         return ((MainTabPane) getMainTabPane()).getCurrentQueryTab();
     }
 
     public void setDepth(int depth) {
         this.depth = depth;
     }
 
     public int getDepth() {
         return this.depth;
     }
 
     public TabPane getMainTabPane() {
         return this.mainTabPane;
     }
 
     public DataAgent getDataAgent() {
         return dataAgent;
     }
 
     public PrefixesStorage getAppPrefixesStorage() {
         return appPrefixesStorage;
     }
 
     public ResourcesStorage getAppResourcesStorage() {
         return appResourcesStorage;
     }
 
     public DataTypesStorage getAppDataTypesStorage() {
         return appDataTypesStorage;
     }
 
     public FunctionsStorage getAppFunctionsStorage() {
         return appFunctionsStorage;
     }
 
     public int getUnsavedTabsProperty() {
         return unsavedTabsProperty.get();
     }
 
     public IntegerProperty unsavedTabsPropertyProperty() {
         return unsavedTabsProperty;
     }
 
     public ChangeListener<? super Boolean> getTabHasChangesListener() {
         return tabHasChangesListener;
     }
 
     public InvalidationListener getCurrentTabTextListener() {
         return currentTabTextListener;
     }
 
     public GridPane getWelcomePane() {
         return welcomePane;
     }
 
     public StackPane getStackPane() {
         return stackPane;
     }
 
     public boolean isLoading() {
         return loading;
     }
 
     public ChangeListener<? super Boolean> getCurrentTabHasChangesListener() {
         return currentTabHasChangesListener;
     }
 
     void setAppPrefixesStorage(PrefixesStorage appPrefixesStorage) {
         this.appPrefixesStorage = appPrefixesStorage;
     }
 
     void setAppResourcesStorage(ResourcesStorage appResourcesStorage) {
         this.appResourcesStorage = appResourcesStorage;
     }
 
     void setAppDataTypesStorage(DataTypesStorage appDataTypesStorage) {
         this.appDataTypesStorage = appDataTypesStorage;
     }
 
     void setAppFunctionsStorage(FunctionsStorage appFunctionsStorage) {
         this.appFunctionsStorage = appFunctionsStorage;
     }
 
     public MainMenuBar getMainMenuBar() {
         return mainMenuBar;
     }
 
     public MainToolBar getMainToolBar() {
         return mainToolBar;
     }
 
     public void setDataAgent(DataAgent dataAgent) {
         this.dataAgent = dataAgent;
         titleProperty.set(dataAgent.getStorageName());
         MainMenuAction.reInitBinding(this);
 
     }
 
     @Override
     public Set<InvalidationListener> getObservers() {
         return observers;
     }
 
 }