net.sourceforge.squirrel_sql.plugins.firebirdmanager.FirebirdManagerPlugin Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2008 Michael Romankiewicz
* microm at users.sourceforge.net
*
* This program 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 2
* of the License, or any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package net.sourceforge.squirrel_sql.plugins.firebirdmanager;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.*;
import java.beans.PropertyVetoException;
import java.sql.SQLException;
import javax.swing.JInternalFrame;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import net.sourceforge.squirrel_sql.client.IApplication;
import net.sourceforge.squirrel_sql.client.gui.mainframe.MainFrame.IMenuIDs;
import net.sourceforge.squirrel_sql.client.gui.session.ObjectTreeInternalFrame;
import net.sourceforge.squirrel_sql.client.gui.session.SQLInternalFrame;
import net.sourceforge.squirrel_sql.client.gui.desktopcontainer.IWidget;
import net.sourceforge.squirrel_sql.client.gui.desktopcontainer.DialogWidget;
import net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin;
import net.sourceforge.squirrel_sql.client.plugin.PluginException;
import net.sourceforge.squirrel_sql.client.plugin.PluginSessionCallback;
import net.sourceforge.squirrel_sql.client.preferences.IGlobalPreferencesPanel;
import net.sourceforge.squirrel_sql.client.session.IObjectTreeAPI;
import net.sourceforge.squirrel_sql.client.session.ISession;
import net.sourceforge.squirrel_sql.fw.gui.GUIUtils;
import net.sourceforge.squirrel_sql.fw.sql.DatabaseObjectType;
import net.sourceforge.squirrel_sql.fw.util.StringManager;
import net.sourceforge.squirrel_sql.fw.util.StringManagerFactory;
import net.sourceforge.squirrel_sql.fw.util.log.ILogger;
import net.sourceforge.squirrel_sql.fw.util.log.LoggerController;
import net.sourceforge.squirrel_sql.plugins.firebirdmanager.gui.FirebirdManagerBackupRestoreFrame;
import net.sourceforge.squirrel_sql.plugins.firebirdmanager.gui.FirebirdManagerCreateDatabaseFrame;
import net.sourceforge.squirrel_sql.plugins.firebirdmanager.gui.FirebirdManagerGlobalPreferencesTab;
import net.sourceforge.squirrel_sql.plugins.firebirdmanager.gui.FirebirdManagerGrantFrame;
import net.sourceforge.squirrel_sql.plugins.firebirdmanager.gui.FirebirdManagerRoleFrame;
import net.sourceforge.squirrel_sql.plugins.firebirdmanager.gui.FirebirdManagerUserManagerFrame;
import net.sourceforge.squirrel_sql.plugins.firebirdmanager.gui.IFirebirdManagerFrame;
import net.sourceforge.squirrel_sql.plugins.firebirdmanager.pref.PreferencesManager;
import org.firebirdsql.jdbc.FBDriver;
/**
* Plugin start class for firebird management
*
* @author Michael Romankiewicz
*/
public class FirebirdManagerPlugin extends DefaultSessionPlugin {
// variables
// ========================================================================
// non visible
// Logger for this class
private final static ILogger log = LoggerController
.createLogger(FirebirdManagerPlugin.class);
private static final StringManager stringManager = StringManagerFactory
.getStringManager(FirebirdManagerPlugin.class);
// sheet types
private final int FB_SHEET_TYPE_CREATE = 1;
private final int FB_SHEET_TYPE_BACKUP = 2;
private final int FB_SHEET_TYPE_USER = 3;
private final int FB_SHEET_TYPE_ROLE = 4;
private final int FB_SHEET_TYPE_GRANT =5;
// result of checking for jaybird driver with major version >= 2
private boolean jaybird2Driver = false;
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.client.plugin.IPlugin#getAuthor()
*/
public String getAuthor() {
return "Michael Romankiewicz";
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.client.plugin.IPlugin#getDescriptiveName()
*/
public String getDescriptiveName() {
return "Firebird Manager Plugin";
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.client.plugin.IPlugin#getInternalName()
*/
public String getInternalName() {
return "firebirdmanager";
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.client.plugin.IPlugin#getVersion()
*/
public String getVersion() {
return "1.0";
}
/**
* Returns the name of the Help file for the plugin. This should
* be a text or HTML file residing in the getPluginAppSettingsFolder
* directory.
*
* @return the Help file name or null if plugin doesn't have
* a help file.
*/
public String getHelpFileName()
{
return "readme.html";
}
/**
* Returns the name of the change log for the plugin. This should
* be a text or HTML file residing in the getPluginAppSettingsFolder
* directory.
*
* @return the changelog file name or null if plugin doesn't have
* a change log.
*/
public String getChangeLogFileName()
{
return "changes.txt";
}
/**
* @see net.sourceforge.squirrel_sql.client.plugin.IPlugin#getLicenceFileName()
*/
public String getLicenceFileName()
{
return "licence.txt";
}
/**
* Create preferences panel for the Global Preferences dialog.
*
* @return Preferences panel.
*/
public IGlobalPreferencesPanel[] getGlobalPreferencePanels() {
FirebirdManagerGlobalPreferencesTab tab = new FirebirdManagerGlobalPreferencesTab();
return new IGlobalPreferencesPanel[] { tab };
}
/**
* Initialize this plugin.
*/
public synchronized void initialize() throws PluginException {
jaybird2Driver = isJaybird2DriverInstalled();
PreferencesManager.initialize(this);
IApplication application = getApplication();
application.addToMenu(IMenuIDs.PLUGINS_MENU,
getFirebirdManagerMenu(getApplication(), null, false));
}
public void unload() {
super.unload();
PreferencesManager.unload();
}
/**
* Called when a session started. Add commands to popup menu in object tree.
*
* @param session
* The session that is starting.
* @return An implementation of PluginSessionCallback or null to indicate
* the plugin does not work with this session
*/
public PluginSessionCallback sessionStarted(final ISession session) {
if (isFirebirdDB(session)) {
try {
// Add context menu items to the object tree's session node.
// as popup menu
IObjectTreeAPI objectTreeApi = session
.getSessionInternalFrame().getObjectTreeAPI();
objectTreeApi.addToPopup(DatabaseObjectType.SESSION,
getFirebirdManagerMenu(getApplication(), session, true));
return new PluginSessionCallback() {
public void sqlInternalFrameOpened(
SQLInternalFrame sqlInternalFrame, ISession sess) {
// plugin supports Session main window only
}
public void objectTreeInternalFrameOpened(
ObjectTreeInternalFrame objectTreeInternalFrame,
ISession sess) {
// plugin supports Session main window only
}
};
} catch (Exception e) {
throw new RuntimeException(e);
}
} else {
return null;
}
}
/**
* Interface with the text resources of I18NStrings.properties
*/
private interface i18n {
String MENU_TITLE_FIREBIRDMANAGER = stringManager
.getString("firebirdmanager.menu.title");
String MENU_TITLE_FIREBIRDMANAGER_CREATE_DATABASE = stringManager
.getString("firebirdmanager.menu.createdatabase.title");
String MENU_TITLE_FIREBIRDMANAGER_USER_MANAGER = stringManager
.getString("firebirdmanager.menu.usermanager.title");
String MENU_TITLE_FIREBIRDMANAGER_BACKUP_RESTORE_MANAGER = stringManager
.getString("firebirdmanager.menu.backuprestoremanager.title");
String MENU_TITLE_FIREBIRDMANAGER_ROLE_MANAGER = stringManager
.getString("firebirdmanager.menu.rolemanager.title");
String MENU_TITLE_FIREBIRDMANAGER_GRANT_MANAGER = stringManager
.getString("firebirdmanager.menu.grantmanager.title");
String ERROR_DRIVER_NOT_INSTALLED = stringManager
.getString("firebirdmanager.error.driver.not.installed");
String ERROR_GET_DATABASE_PRODUCT_NAME = stringManager
.getString("firebirdmanager.error.get.database.product.name");
}
/**
* Return the menu for the plugin
*
* @param session session
* @return menu
*/
private JMenu getFirebirdManagerMenu(final IApplication application,
ISession session, boolean forPopupMenu) {
JMenu menu = new JMenu(i18n.MENU_TITLE_FIREBIRDMANAGER);
if (jaybird2Driver) {
menu.add(addMenuItem(application,
i18n.MENU_TITLE_FIREBIRDMANAGER_BACKUP_RESTORE_MANAGER,
FB_SHEET_TYPE_BACKUP, session));
menu.add(addMenuItem(application,
i18n.MENU_TITLE_FIREBIRDMANAGER_CREATE_DATABASE,
FB_SHEET_TYPE_CREATE, session));
menu.add(addMenuItem(application,
i18n.MENU_TITLE_FIREBIRDMANAGER_USER_MANAGER,
FB_SHEET_TYPE_USER, session));
}
if (forPopupMenu) {
menu.add(addMenuItem(application,
i18n.MENU_TITLE_FIREBIRDMANAGER_ROLE_MANAGER,
FB_SHEET_TYPE_ROLE, session));
menu.add(addMenuItem(application,
i18n.MENU_TITLE_FIREBIRDMANAGER_GRANT_MANAGER,
FB_SHEET_TYPE_GRANT, session));
}
return menu;
}
/**
* Creates a menuitem for a new firebird management function
*
* @param application application
* @param title title of the menu item
* @param sheetType type to identifier the frame which will be created
* @param session session
* @return menu item
*/
private JMenuItem addMenuItem(final IApplication application, String title,
final int sheetType, final ISession session) {
JMenuItem menuItem = new JMenuItem(title);
menuItem.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent evt) {
DialogWidget frame = (DialogWidget) isInternalFrameUsed(application, sheetType);
if (frame == null) {
if (sheetType == FB_SHEET_TYPE_ROLE) {
frame = new FirebirdManagerRoleFrame(session);
} else if (sheetType == FB_SHEET_TYPE_GRANT) {
frame = new FirebirdManagerGrantFrame(session);
} else if (sheetType == FB_SHEET_TYPE_BACKUP){
frame = new FirebirdManagerBackupRestoreFrame(session.getApplication());
} else if (sheetType == FB_SHEET_TYPE_CREATE){
frame = new FirebirdManagerCreateDatabaseFrame(session.getApplication());
} else if (sheetType == FB_SHEET_TYPE_USER){
frame = new FirebirdManagerUserManagerFrame(session.getApplication());
}
application.getMainFrame().addWidget(frame);
frame.pack();
if (frame instanceof FirebirdManagerBackupRestoreFrame) {
frame.setSize(new Dimension(650, frame.getHeight()));
} else if (frame instanceof FirebirdManagerUserManagerFrame) {
frame.setSize(new Dimension(frame.getWidth(), 500));
}
DialogWidget.centerWithinDesktop(frame);
} else {
frame.setVisible(true);
frame.moveToFront();
}
try {
frame.setSelected(true);
if (frame instanceof IFirebirdManagerFrame) {
((IFirebirdManagerFrame)frame).setFocusToFirstEmptyInputField();
}
} catch (PropertyVetoException e) {
log.error(e.getLocalizedMessage());
}
}
});
return menuItem;
}
private IWidget isInternalFrameUsed(IApplication application,
int sheetType) {
IWidget[] frames = application.getMainFrame().getDesktopContainer().getAllWidgets();
for (int i = 0; i < frames.length; i++) {
if ((sheetType == FB_SHEET_TYPE_CREATE && frames[i] instanceof FirebirdManagerCreateDatabaseFrame)
|| (sheetType == FB_SHEET_TYPE_USER && frames[i] instanceof FirebirdManagerUserManagerFrame)
|| (sheetType == FB_SHEET_TYPE_BACKUP && frames[i] instanceof FirebirdManagerBackupRestoreFrame)
|| (sheetType == FB_SHEET_TYPE_GRANT && frames[i] instanceof FirebirdManagerGrantFrame)
|| (sheetType == FB_SHEET_TYPE_ROLE && frames[i] instanceof FirebirdManagerRoleFrame)
) {
return frames[i];
}
}
return null;
}
@Override
public void sessionEnding(ISession session) {
super.sessionEnding(session);
IWidget[] frames = session.getApplication().getMainFrame().getDesktopContainer().getAllWidgets();
for (int i = 0; i < frames.length; i++) {
if (frames[i] instanceof FirebirdManagerGrantFrame
|| frames[i] instanceof FirebirdManagerRoleFrame) {
frames[i].dispose();
}
}
}
/**
* Return true if jaybird driver with major version of 2 or later is installed
*
* @return true / false
*/
private boolean isJaybird2DriverInstalled() {
try {
Class.forName("org.firebirdsql.jdbc.FBDriver");
FBDriver fb = new FBDriver();
return fb.getMajorVersion() >= 2;
} catch (ClassNotFoundException e) {
log.error(i18n.ERROR_DRIVER_NOT_INSTALLED, e);
// This was shown at application start up. The message box did hide behind the splash screen.
// In general it is not a good idea to pop up message boxes at start up from within Plugin intializations.
// JOptionPane.showMessageDialog(null, i18n.ERROR_DRIVER_NOT_INSTALLED);
return false;
}
}
/**
* Returns true if session is for firebird dbms
*
* @param session
* session
* @return true / false
*/
private boolean isFirebirdDB(ISession session) {
try {
return session.getSQLConnection().getSQLMetaData()
.getDatabaseProductName().toLowerCase().startsWith(
"firebird");
} catch (SQLException e) {
log.error(i18n.ERROR_GET_DATABASE_PRODUCT_NAME);
JOptionPane.showMessageDialog(null, i18n.ERROR_GET_DATABASE_PRODUCT_NAME);
}
return false;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy