-/*\r
- * Copyright (C) 2001, 2002 The Mir-coders group\r
- *\r
- * This file is part of Mir.\r
- *\r
- * Mir is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * Mir is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with Mir; if not, write to the Free Software\r
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\r
- *\r
- * In addition, as a special exception, The Mir-coders gives permission to link\r
- * the code of this program with the com.oreilly.servlet library, any library\r
- * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
- * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
- * the above that use the same license as the above), and distribute linked\r
- * combinations including the two. You must obey the GNU General Public\r
- * License in all respects for all of the code used other than the above\r
- * mentioned libraries. If you modify this file, you may extend this exception\r
- * to your version of the file, but you are not obligated to do so. If you do\r
- * not wish to do so, delete this exception statement from your version.\r
- */\r
-package mir.storage;\r
-\r
-import java.io.IOException;\r
-import java.io.InputStreamReader;\r
-\r
-import java.sql.Connection;\r
-import java.sql.PreparedStatement;\r
-import java.sql.ResultSet;\r
-import java.sql.ResultSetMetaData;\r
-import java.sql.SQLException;\r
-import java.sql.Statement;\r
-import java.sql.Timestamp;\r
-\r
-import java.text.ParseException;\r
-import java.text.SimpleDateFormat;\r
-\r
-import java.util.ArrayList;\r
-import java.util.List;\r
-import java.util.Calendar;\r
-import java.util.GregorianCalendar;\r
-import java.util.HashMap;\r
-\r
-import com.codestudio.util.SQLManager;\r
-\r
-import freemarker.template.SimpleHash;\r
-import freemarker.template.SimpleList;\r
-\r
-import mir.config.MirPropertiesConfiguration;\r
-\r
-import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;\r
-\r
-import mir.entity.Entity;\r
-import mir.entity.EntityList;\r
-import mir.entity.StorableObjectEntity;\r
-\r
-import mir.log.LoggerWrapper;\r
-\r
-import mir.misc.HTMLTemplateProcessor;\r
-import mir.misc.StringUtil;\r
-\r
-import mir.storage.store.ObjectStore;\r
-import mir.storage.store.StorableObject;\r
-import mir.storage.store.StoreContainerType;\r
-import mir.storage.store.StoreIdentifier;\r
-import mir.storage.store.StoreUtil;\r
-\r
-import mir.util.JDBCStringRoutines;\r
-\r
-\r
-/**\r
- * Diese Klasse implementiert die Zugriffsschicht auf die Datenbank.\r
- * Alle Projektspezifischen Datenbankklassen erben von dieser Klasse.\r
- * In den Unterklassen wird im Minimalfall nur die Tabelle angegeben.\r
- * Im Konfigurationsfile findet sich eine Verweis auf den verwendeten\r
- * Treiber, Host, User und Passwort, ueber den der Zugriff auf die\r
- * Datenbank erfolgt.\r
- *\r
- * @version $Id: Database.java,v 1.33 2003/02/20 16:05:33 zapata Exp $\r
- * @author rk\r
- *\r
- */\r
-public class Database implements StorageObject {\r
- private static Class GENERIC_ENTITY_CLASS = mir.entity.StorableObjectEntity.class;\r
- private static Class STORABLE_OBJECT_ENTITY_CLASS = mir.entity.StorableObjectEntity.class;\r
-\r
-\r
- private static SimpleHash POPUP_EMPTYLINE = new SimpleHash();\r
- protected static final ObjectStore o_store = ObjectStore.getInstance();\r
- private static final int _millisPerHour = 60 * 60 * 1000;\r
- private static final int _millisPerMinute = 60 * 1000;\r
-\r
- static {\r
- // always same object saves a little space\r
- POPUP_EMPTYLINE.put("key", "");\r
- POPUP_EMPTYLINE.put("value", "--");\r
- }\r
-\r
- protected LoggerWrapper logger;\r
- protected MirPropertiesConfiguration configuration;\r
- protected String theTable;\r
- protected String theCoreTable = null;\r
- protected String thePKeyName = "id";\r
- protected int thePKeyType;\r
- protected int thePKeyIndex;\r
- protected boolean evaluatedMetaData = false;\r
- protected ArrayList metadataFields;\r
- protected ArrayList metadataLabels;\r
- protected ArrayList metadataNotNullFields;\r
- protected int[] metadataTypes;\r
- protected Class theEntityClass;\r
- protected StorageObject myselfDatabase;\r
- protected SimpleList popupCache = null;\r
- protected boolean hasPopupCache = false;\r
- protected SimpleHash hashCache = null;\r
- protected boolean hasTimestamp = true;\r
- private String database_driver;\r
- private String database_url;\r
- private int defaultLimit;\r
- protected DatabaseAdaptor theAdaptor;\r
- private SimpleDateFormat _dateFormatterOut =\r
- new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");\r
- private SimpleDateFormat _dateFormatterIn =\r
- new SimpleDateFormat("yyyy-MM-dd HH:mm");\r
- private Calendar _cal = new GregorianCalendar();\r
-\r
- /**\r
- * Kontruktor bekommt den Filenamen des Konfigurationsfiles ?bergeben.\r
- * Aus diesem file werden <code>Database.Logfile</code>,\r
- * <code>Database.Username</code>,<code>Database.Password</code>,\r
- * <code>Database.Host</code> und <code>Database.Adaptor</code>\r
- * ausgelesen und ein Broker f?r die Verbindugen zur Datenbank\r
- * erzeugt.\r
- *\r
- * @param String confFilename Dateiname der Konfigurationsdatei\r
- */\r
- public Database() throws StorageObjectFailure {\r
- try {\r
- configuration = MirPropertiesConfiguration.instance();\r
- }\r
- catch (PropertiesConfigExc e) {\r
- throw new StorageObjectFailure(e);\r
- }\r
- logger = new LoggerWrapper("Database");\r
-\r
- String theAdaptorName = configuration.getString("Database.Adaptor");\r
- defaultLimit = Integer.parseInt(configuration.getString("Database.Limit"));\r
-\r
- try {\r
- theEntityClass = GENERIC_ENTITY_CLASS;\r
- theAdaptor = (DatabaseAdaptor) Class.forName(theAdaptorName).newInstance();\r
- }\r
- catch (Throwable e) {\r
- logger.error("Error in Database() constructor with " + theAdaptorName + " -- " + e.getMessage());\r
- throw new StorageObjectFailure("Error in Database() constructor.", e);\r
- }\r
- }\r
-\r
- /**\r
- * Liefert die Entity-Klasse zur?ck, in der eine Datenbankzeile gewrappt\r
- * wird. Wird die Entity-Klasse durch die erbende Klasse nicht ?berschrieben,\r
- * wird eine mir.entity.GenericEntity erzeugt.\r
- *\r
- * @return Class-Objekt der Entity\r
- */\r
- public java.lang.Class getEntityClass() {\r
- return theEntityClass;\r
- }\r
-\r
- /**\r
- * Liefert die Standardbeschr?nkung von select-Statements zur?ck, also\r
- * wieviel Datens?tze per Default selektiert werden.\r
- *\r
- * @return Standard-Anzahl der Datens?tze\r
- */\r
- public int getLimit() {\r
- return defaultLimit;\r
- }\r
-\r
- /**\r
- * Liefert den Namen des Primary-Keys zur?ck. Wird die Variable nicht von\r
- * der erbenden Klasse ?berschrieben, so ist der Wert <code>PKEY</code>\r
- * @return Name des Primary-Keys\r
- */\r
- public String getIdName() {\r
- return thePKeyName;\r
- }\r
-\r
- /**\r
- * Liefert den Namen der Tabelle, auf das sich das Datenbankobjekt bezieht.\r
- *\r
- * @return Name der Tabelle\r
- */\r
- public String getTableName() {\r
- return theTable;\r
- }\r
-\r
- /*\r
- * Dient dazu vererbte Tabellen bei objectrelationalen DBMS\r
- * zu speichern, wenn die id einer Tabelle in der parenttabelle verwaltet\r
- * wird.\r
- * @return liefert theCoreTabel als String zurueck, wenn gesetzt, sonst\r
- * the Table\r
- */\r
- public String getCoreTable() {\r
- if (theCoreTable != null) {\r
- return theCoreTable;\r
- } else {\r
- return theTable;\r
- }\r
- }\r
-\r
- /**\r
- * Liefert Feldtypen der Felder der Tabelle zurueck (s.a. java.sql.Types)\r
- * @return int-Array mit den Typen der Felder\r
- * @exception StorageObjectException\r
- */\r
- public int[] getTypes() throws StorageObjectFailure {\r
- if (metadataTypes == null) {\r
- get_meta_data();\r
- }\r
-\r
- return metadataTypes;\r
- }\r
-\r
- /**\r
- * Liefert eine Liste der Labels der Tabellenfelder\r
- * @return ArrayListe mit Labeln\r
- * @exception StorageObjectException\r
- */\r
- public List getLabels() throws StorageObjectFailure {\r
- if (metadataLabels == null) {\r
- get_meta_data();\r
- }\r
-\r
- return metadataLabels;\r
- }\r
-\r
- /**\r
- * Liefert eine Liste der Felder der Tabelle\r
- * @return ArrayList mit Feldern\r
- * @exception StorageObjectException\r
- */\r
- public List getFields() throws StorageObjectFailure {\r
- if (metadataFields == null) {\r
- get_meta_data();\r
- }\r
-\r
- return metadataFields;\r
- }\r
-\r
- /*\r
- * Gets value out of ResultSet according to type and converts to String\r
- * @param inValue Wert aus ResultSet.\r
- * @param aType Datenbanktyp.\r
- * @return liefert den Wert als String zurueck. Wenn keine Umwandlung moeglich\r
- * dann /unsupported value/\r
- */\r
- private String getValueAsString(ResultSet rs, int valueIndex, int aType)\r
- throws StorageObjectFailure {\r
- String outValue = null;\r
-\r
- if (rs != null) {\r
- try {\r
- switch (aType) {\r
- case java.sql.Types.BIT:\r
- outValue = (rs.getBoolean(valueIndex) == true) ? "1" : "0";\r
-\r
- break;\r
-\r
- case java.sql.Types.INTEGER:\r
- case java.sql.Types.SMALLINT:\r
- case java.sql.Types.TINYINT:\r
- case java.sql.Types.BIGINT:\r
-\r
- int out = rs.getInt(valueIndex);\r
-\r
- if (!rs.wasNull()) {\r
- outValue = new Integer(out).toString();\r
- }\r
-\r
- break;\r
-\r
- case java.sql.Types.NUMERIC:\r
-\r
- /** @todo Numeric can be float or double depending upon\r
- * metadata.getScale() / especially with oracle */\r
- long outl = rs.getLong(valueIndex);\r
-\r
- if (!rs.wasNull()) {\r
- outValue = new Long(outl).toString();\r
- }\r
-\r
- break;\r
-\r
- case java.sql.Types.REAL:\r
-\r
- float tempf = rs.getFloat(valueIndex);\r
-\r
- if (!rs.wasNull()) {\r
- tempf *= 10;\r
- tempf += 0.5;\r
-\r
- int tempf_int = (int) tempf;\r
- tempf = (float) tempf_int;\r
- tempf /= 10;\r
- outValue = "" + tempf;\r
- outValue = outValue.replace('.', ',');\r
- }\r
-\r
- break;\r
-\r
- case java.sql.Types.DOUBLE:\r
-\r
- double tempd = rs.getDouble(valueIndex);\r
-\r
- if (!rs.wasNull()) {\r
- tempd *= 10;\r
- tempd += 0.5;\r
-\r
- int tempd_int = (int) tempd;\r
- tempd = (double) tempd_int;\r
- tempd /= 10;\r
- outValue = "" + tempd;\r
- outValue = outValue.replace('.', ',');\r
- }\r
-\r
- break;\r
-\r
- case java.sql.Types.CHAR:\r
- case java.sql.Types.VARCHAR:\r
- case java.sql.Types.LONGVARCHAR:\r
- outValue = rs.getString(valueIndex);\r
-\r
- break;\r
-\r
- case java.sql.Types.LONGVARBINARY:\r
- outValue = rs.getString(valueIndex);\r
-\r
- break;\r
-\r
- case java.sql.Types.TIMESTAMP:\r
-\r
- // it's important to use Timestamp here as getting it\r
- // as a string is undefined and is only there for debugging\r
- // according to the API. we can make it a string through formatting.\r
- // -mh\r
- Timestamp timestamp = (rs.getTimestamp(valueIndex));\r
-\r
- if (!rs.wasNull()) {\r
- java.util.Date date = new java.util.Date(timestamp.getTime());\r
- outValue = _dateFormatterOut.format(date);\r
- _cal.setTime(date);\r
-\r
- int offset =\r
- _cal.get(Calendar.ZONE_OFFSET) + _cal.get(Calendar.DST_OFFSET);\r
- String tzOffset =\r
- StringUtil.zeroPaddingNumber(offset / _millisPerHour, 2, 2);\r
- outValue = outValue + "+" + tzOffset;\r
- }\r
-\r
- break;\r
-\r
- default:\r
- outValue = "<unsupported value>";\r
- logger.warn( "Unsupported Datatype: at " + valueIndex + " (" + aType + ")");\r
- }\r
- } catch (SQLException e) {\r
- throw new StorageObjectFailure("Could not get Value out of Resultset -- ",\r
- e);\r
- }\r
- }\r
-\r
- return outValue;\r
- }\r
-\r
- /*\r
- * select-Operator um einen Datensatz zu bekommen.\r
- * @param id Primaerschluessel des Datensatzes.\r
- * @return liefert EntityObject des gefundenen Datensatzes oder null.\r
- */\r
- public Entity selectById(String id) throws StorageObjectExc {\r
- if ((id == null) || id.equals("")) {\r
- throw new StorageObjectExc("Database.selectById: Missing id");\r
- }\r
-\r
- // ask object store for object\r
- if (StoreUtil.implementsStorableObject(theEntityClass)) {\r
- String uniqueId = id;\r
-\r
- if (theEntityClass.equals(StorableObjectEntity.class)) {\r
- uniqueId += ("@" + theTable);\r
- }\r
-\r
- StoreIdentifier search_sid = new StoreIdentifier(theEntityClass, uniqueId);\r
- logger.debug("CACHE: (dbg) looking for sid " + search_sid.toString());\r
-\r
- Entity hit = (Entity) o_store.use(search_sid);\r
-\r
- if (hit != null) {\r
- return hit;\r
- }\r
- }\r
-\r
- Statement stmt = null;\r
- Connection con = getPooledCon();\r
- Entity returnEntity = null;\r
-\r
- try {\r
- ResultSet rs;\r
-\r
- /** @todo better prepared statement */\r
- String selectSql =\r
- "select * from " + theTable + " where " + thePKeyName + "=" + id;\r
- stmt = con.createStatement();\r
- rs = executeSql(stmt, selectSql);\r
-\r
- if (rs != null) {\r
- if (evaluatedMetaData == false) {\r
- evalMetaData(rs.getMetaData());\r
- }\r
-\r
- if (rs.next()) {\r
- returnEntity = makeEntityFromResultSet(rs);\r
- }\r
- else {\r
- logger.debug("No data for id: " + id + " in table " + theTable);\r
- }\r
-\r
- rs.close();\r
- }\r
- else {\r
- logger.debug("No Data for Id " + id + " in Table " + theTable);\r
- }\r
- }\r
- catch (SQLException sqe) {\r
- throwSQLException(sqe, "selectById");\r
- return null;\r
- }\r
- catch (NumberFormatException e) {\r
- logger.error("ID is no number: " + id);\r
- }\r
- finally {\r
- freeConnection(con, stmt);\r
- }\r
-\r
- return returnEntity;\r
- }\r
-\r
- /**\r
- * select-Operator um Datensaetze zu bekommen, die key = value erfuellen.\r
- * @param key Datenbankfeld der Bedingung.\r
- * @param value Wert die der key anehmen muss.\r
- * @return EntityList mit den gematchten Entities\r
- */\r
- public EntityList selectByFieldValue(String aField, String aValue) throws StorageObjectFailure {\r
- return selectByFieldValue(aField, aValue, 0);\r
- }\r
-\r
- /**\r
- * select-Operator um Datensaetze zu bekommen, die key = value erfuellen.\r
- * @param key Datenbankfeld der Bedingung.\r
- * @param value Wert die der key anehmen muss.\r
- * @param offset Gibt an ab welchem Datensatz angezeigt werden soll.\r
- * @return EntityList mit den gematchten Entities\r
- */\r
- public EntityList selectByFieldValue(String aField, String aValue, int offset) throws StorageObjectFailure {\r
- return selectByWhereClause(aField + "=" + aValue, offset);\r
- }\r
-\r
- /**\r
- * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.\r
- * Also offset wird der erste Datensatz genommen.\r
- *\r
- * @param wc where-Clause\r
- * @return EntityList mit den gematchten Entities\r
- * @exception StorageObjectException\r
- */\r
- public EntityList selectByWhereClause(String where)\r
- throws StorageObjectFailure {\r
- return selectByWhereClause(where, 0);\r
- }\r
-\r
- /**\r
- * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.\r
- * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.\r
- *\r
- * @param wc where-Clause\r
- * @param offset ab welchem Datensatz.\r
- * @return EntityList mit den gematchten Entities\r
- * @exception StorageObjectException\r
- */\r
- public EntityList selectByWhereClause(String whereClause, int offset)\r
- throws StorageObjectFailure {\r
- return selectByWhereClause(whereClause, null, offset);\r
- }\r
-\r
- /**\r
- * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.\r
- * Also offset wird der erste Datensatz genommen.\r
- * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.\r
- *\r
- * @param wc where-Clause\r
- * @param ob orderBy-Clause\r
- * @return EntityList mit den gematchten Entities\r
- * @exception StorageObjectException\r
- */\r
- public EntityList selectByWhereClause(String where, String order)\r
- throws StorageObjectFailure {\r
- return selectByWhereClause(where, order, 0);\r
- }\r
-\r
- /**\r
- * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.\r
- * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.\r
- *\r
- * @param wc where-Clause\r
- * @param ob orderBy-Clause\r
- * @param offset ab welchem Datensatz\r
- * @return EntityList mit den gematchten Entities\r
- * @exception StorageObjectException\r
- */\r
- public EntityList selectByWhereClause(String whereClause, String orderBy,\r
- int offset) throws StorageObjectFailure {\r
- return selectByWhereClause(whereClause, orderBy, offset, defaultLimit);\r
- }\r
-\r
- /**\r
- * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.\r
- * @param wc where-Clause\r
- * @param ob orderBy-Clause\r
- * @param offset ab welchem Datensatz\r
- * @param limit wieviele Datens?tze\r
- * @return EntityList mit den gematchten Entities\r
- * @exception StorageObjectException\r
- */\r
- public EntityList selectByWhereClause(String wc, String ob, int offset,\r
- int limit) throws StorageObjectFailure {\r
- // check o_store for entitylist\r
- if (StoreUtil.implementsStorableObject(theEntityClass)) {\r
- StoreIdentifier search_sid =\r
- new StoreIdentifier(theEntityClass,\r
- StoreContainerType.STOC_TYPE_ENTITYLIST,\r
- StoreUtil.getEntityListUniqueIdentifierFor(theTable, wc, ob, offset,\r
- limit));\r
- EntityList hit = (EntityList) o_store.use(search_sid);\r
-\r
- if (hit != null) {\r
- logger.debug("CACHE (hit): " + search_sid.toString());\r
-\r
- return hit;\r
- }\r
- }\r
-\r
- // local\r
- EntityList theReturnList = null;\r
- Connection con = null;\r
- Statement stmt = null;\r
- ResultSet rs;\r
- int offsetCount = 0;\r
- int count = 0;\r
-\r
- // build sql-statement\r
-\r
- /** @todo count sql string should only be assembled if we really count\r
- * see below at the end of method //rk */\r
- if ((wc != null) && (wc.length() == 0)) {\r
- wc = null;\r
- }\r
-\r
- StringBuffer countSql =\r
- new StringBuffer("select count(*) from ").append(theTable);\r
- StringBuffer selectSql =\r
- new StringBuffer("select * from ").append(theTable);\r
-\r
- if (wc != null) {\r
- selectSql.append(" where ").append(wc);\r
- countSql.append(" where ").append(wc);\r
- }\r
-\r
- if ((ob != null) && !(ob.length() == 0)) {\r
- selectSql.append(" order by ").append(ob);\r
- }\r
-\r
- if (theAdaptor.hasLimit()) {\r
- if ((limit > -1) && (offset > -1)) {\r
- selectSql.append(" LIMIT ").append(limit).append(" OFFSET ").append(offset);\r
- }\r
- }\r
-\r
- // execute sql\r
- try {\r
- con = getPooledCon();\r
- stmt = con.createStatement();\r
-\r
- // selecting...\r
- rs = executeSql(stmt, selectSql.toString());\r
-\r
- if (rs != null) {\r
- if (!evaluatedMetaData) {\r
- evalMetaData(rs.getMetaData());\r
- }\r
-\r
- theReturnList = new EntityList();\r
-\r
- Entity theResultEntity;\r
-\r
- while (rs.next()) {\r
- theResultEntity = makeEntityFromResultSet(rs);\r
- theReturnList.add(theResultEntity);\r
- offsetCount++;\r
- }\r
-\r
- rs.close();\r
- }\r
-\r
- // making entitylist infos\r
- if (!(theAdaptor.hasLimit())) {\r
- count = offsetCount;\r
- }\r
-\r
- if (theReturnList != null) {\r
- // now we decide if we have to know an overall count...\r
- count = offsetCount;\r
-\r
- if ((limit > -1) && (offset > -1)) {\r
- if (offsetCount == limit) {\r
- /** @todo counting should be deffered to entitylist\r
- * getSize() should be used */\r
- rs = executeSql(stmt, countSql.toString());\r
-\r
- if (rs != null) {\r
- if (rs.next()) {\r
- count = rs.getInt(1);\r
- }\r
-\r
- rs.close();\r
- }\r
- else {\r
- logger.error("Could not count: " + countSql);\r
- }\r
- }\r
- }\r
-\r
- theReturnList.setCount(count);\r
- theReturnList.setOffset(offset);\r
- theReturnList.setWhere(wc);\r
- theReturnList.setOrder(ob);\r
- theReturnList.setStorage(this);\r
- theReturnList.setLimit(limit);\r
-\r
- if (offset >= limit) {\r
- theReturnList.setPrevBatch(offset - limit);\r
- }\r
-\r
- if ((offset + offsetCount) < count) {\r
- theReturnList.setNextBatch(offset + limit);\r
- }\r
-\r
- if (StoreUtil.implementsStorableObject(theEntityClass)) {\r
- StoreIdentifier sid = theReturnList.getStoreIdentifier();\r
- logger.debug("CACHE (add): " + sid.toString());\r
- o_store.add(sid);\r
- }\r
- }\r
- } catch (SQLException sqe) {\r
- throwSQLException(sqe, "selectByWhereClause");\r
- } finally {\r
- try {\r
- if (con != null) {\r
- freeConnection(con, stmt);\r
- }\r
- } catch (Throwable t) {\r
- }\r
- }\r
-\r
- return theReturnList;\r
- }\r
-\r
- /**\r
- * Bastelt aus einer Zeile der Datenbank ein EntityObjekt.\r
- *\r
- * @param rs Das ResultSetObjekt.\r
- * @return Entity Die Entity.\r
- */\r
- private Entity makeEntityFromResultSet(ResultSet rs)\r
- throws StorageObjectFailure {\r
- /** @todo OS: get Pkey from ResultSet and consult ObjectStore */\r
- HashMap theResultHash = new HashMap();\r
- String theResult = null;\r
- int theType;\r
- Entity returnEntity = null;\r
-\r
- try {\r
- int size = metadataFields.size();\r
-\r
- for (int i = 0; i < size; i++) {\r
- // alle durchlaufen bis nix mehr da\r
- theType = metadataTypes[i];\r
-\r
- if (theType == java.sql.Types.LONGVARBINARY) {\r
- InputStreamReader is =\r
- (InputStreamReader) rs.getCharacterStream(i + 1);\r
-\r
- if (is != null) {\r
- char[] data = new char[32768];\r
- StringBuffer theResultString = new StringBuffer();\r
- int len;\r
-\r
- while ((len = is.read(data)) > 0) {\r
- theResultString.append(data, 0, len);\r
- }\r
-\r
- is.close();\r
- theResult = theResultString.toString();\r
- } else {\r
- theResult = null;\r
- }\r
- } else {\r
- theResult = getValueAsString(rs, (i + 1), theType);\r
- }\r
-\r
- if (theResult != null) {\r
- theResultHash.put(metadataFields.get(i), theResult);\r
- }\r
- }\r
-\r
- if (theEntityClass != null) {\r
- returnEntity = (Entity) theEntityClass.newInstance();\r
- returnEntity.setValues(theResultHash);\r
- returnEntity.setStorage(myselfDatabase);\r
-\r
- if (returnEntity instanceof StorableObject) {\r
- logger.debug("CACHE: ( in) " + returnEntity.getId() + " :" + theTable);\r
- o_store.add(((StorableObject) returnEntity).getStoreIdentifier());\r
- }\r
- } else {\r
- throwStorageObjectException("Internal Error: theEntityClass not set!");\r
- }\r
- } catch (IllegalAccessException e) {\r
- throwStorageObjectException("No access! -- " + e.getMessage());\r
- } catch (IOException e) {\r
- throwStorageObjectException("IOException! -- " + e.getMessage());\r
- } catch (InstantiationException e) {\r
- throwStorageObjectException("No Instatiation! -- " + e.getMessage());\r
- } catch (SQLException sqe) {\r
- throwSQLException(sqe, "makeEntityFromResultSet");\r
-\r
- return null;\r
- }\r
-\r
- return returnEntity;\r
- }\r
-\r
- /**\r
- * insert-Operator: f?gt eine Entity in die Tabelle ein. Eine Spalte WEBDB_CREATE\r
- * wird automatisch mit dem aktuellen Datum gefuellt.\r
- *\r
- * @param theEntity\r
- * @return der Wert des Primary-keys der eingef?gten Entity\r
- */\r
- public String insert(Entity theEntity) throws StorageObjectFailure {\r
- //cache\r
- invalidatePopupCache();\r
-\r
- // invalidating all EntityLists corresponding with theEntityClass\r
- if (StoreUtil.implementsStorableObject(theEntityClass)) {\r
- StoreContainerType stoc_type =\r
- StoreContainerType.valueOf(theEntityClass,\r
- StoreContainerType.STOC_TYPE_ENTITYLIST);\r
- o_store.invalidate(stoc_type);\r
- }\r
-\r
- String returnId = null;\r
- Connection con = null;\r
- PreparedStatement pstmt = null;\r
-\r
- try {\r
- List streamedInput = theEntity.streamedInput();\r
- StringBuffer f = new StringBuffer();\r
- StringBuffer v = new StringBuffer();\r
- String aField;\r
- String aValue;\r
- boolean firstField = true;\r
-\r
- // make sql-string\r
- for (int i = 0; i < getFields().size(); i++) {\r
- aField = (String) getFields().get(i);\r
-\r
- if (!aField.equals(thePKeyName)) {\r
- aValue = null;\r
-\r
- // exceptions\r
- if (aField.equals("webdb_create") ||\r
- aField.equals("webdb_lastchange")) {\r
- aValue = "NOW()";\r
- } else {\r
- if ((streamedInput != null) && streamedInput.contains(aField)) {\r
- aValue = "?";\r
- } else {\r
- if (theEntity.hasValueForField(aField)) {\r
- aValue =\r
- "'" +\r
- JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(\r
- aField)) + "'";\r
- }\r
- }\r
- }\r
-\r
- // wenn Wert gegeben, dann einbauen\r
- if (aValue != null) {\r
- if (firstField == false) {\r
- f.append(",");\r
- v.append(",");\r
- }\r
- else {\r
- firstField = false;\r
- }\r
-\r
- f.append(aField);\r
- v.append(aValue);\r
- }\r
- }\r
- }\r
- // end for\r
-\r
- // insert into db\r
- StringBuffer sqlBuf =\r
- new StringBuffer("insert into ").append(theTable).append("(").append(f)\r
- .append(") values (").append(v).append(")");\r
- String sql = sqlBuf.toString();\r
-\r
- //theLog.printInfo("INSERT: " + sql);\r
- con = getPooledCon();\r
- con.setAutoCommit(false);\r
- pstmt = con.prepareStatement(sql);\r
-\r
- if (streamedInput != null) {\r
- for (int i = 0; i < streamedInput.size(); i++) {\r
- String inputString =\r
- (String) theEntity.getValue((String) streamedInput.get(i));\r
- pstmt.setBytes(i + 1, inputString.getBytes());\r
- }\r
- }\r
-\r
- int ret = pstmt.executeUpdate();\r
-\r
- if (ret == 0) {\r
- //insert failed\r
- return null;\r
- }\r
-\r
- pstmt =\r
- con.prepareStatement(theAdaptor.getLastInsertSQL(\r
- (Database) myselfDatabase));\r
-\r
- ResultSet rs = pstmt.executeQuery();\r
- rs.next();\r
- returnId = rs.getString(1);\r
- theEntity.setId(returnId);\r
- }\r
- catch (SQLException sqe) {\r
- throwSQLException(sqe, "insert");\r
- }\r
- finally {\r
- try {\r
- con.setAutoCommit(true);\r
- }\r
- catch (Exception e) {\r
- }\r
-\r
- freeConnection(con, pstmt);\r
- }\r
-\r
- /** @todo store entity in o_store */\r
- return returnId;\r
- }\r
-\r
- /**\r
- * update-Operator: aktualisiert eine Entity. Eine Spalte WEBDB_LASTCHANGE\r
- * wird automatisch mit dem aktuellen Datum gefuellt.\r
- *\r
- * @param theEntity\r
- */\r
- public void update(Entity theEntity) throws StorageObjectFailure {\r
- Connection con = null;\r
- PreparedStatement pstmt = null;\r
-\r
- /** @todo this is stupid: why do we prepare statement, when we\r
- * throw it away afterwards. should be regular statement\r
- * update/insert could better be one routine called save()\r
- * that chooses to either insert or update depending if we\r
- * have a primary key in the entity. i don't know if we\r
- * still need the streamed input fields. // rk */\r
- /** @todo extension: check if Entity did change, otherwise we don't need\r
- * the roundtrip to the database */\r
- /** invalidating corresponding entitylists in o_store*/\r
- if (StoreUtil.implementsStorableObject(theEntityClass)) {\r
- StoreContainerType stoc_type =\r
- StoreContainerType.valueOf(theEntityClass,\r
- StoreContainerType.STOC_TYPE_ENTITYLIST);\r
- o_store.invalidate(stoc_type);\r
- }\r
-\r
- List streamedInput = theEntity.streamedInput();\r
- String id = theEntity.getId();\r
- String aField;\r
- StringBuffer fv = new StringBuffer();\r
- boolean firstField = true;\r
-\r
- //cache\r
- invalidatePopupCache();\r
-\r
- // build sql statement\r
- for (int i = 0; i < getFields().size(); i++) {\r
- aField = (String) metadataFields.get(i);\r
-\r
- // only normal cases\r
- if ( !(aField.equals(thePKeyName) ||\r
- aField.equals("webdb_create") ||\r
- aField.equals("webdb_lastchange") ||\r
- ((streamedInput != null) && streamedInput.contains(aField)))) {\r
- if (theEntity.hasValueForField(aField)) {\r
- if (firstField == false) {\r
- fv.append(", ");\r
- }\r
- else {\r
- firstField = false;\r
- }\r
-\r
- fv.append(aField).append("='").append(JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField))).append("'");\r
-\r
- // fv.append(aField).append("='").append(StringUtil.quote((String)theEntity.getValue(aField))).append("'");\r
- }\r
- }\r
- }\r
-\r
- StringBuffer sql =\r
- new StringBuffer("update ").append(theTable).append(" set ").append(fv);\r
-\r
- // exceptions\r
- if (metadataFields.contains("webdb_lastchange")) {\r
- sql.append(",webdb_lastchange=NOW()");\r
- }\r
-\r
- // special case: the webdb_create requires the field in yyyy-mm-dd HH:mm\r
- // format so anything extra will be ignored. -mh\r
- if (metadataFields.contains("webdb_create") &&\r
- theEntity.hasValueForField("webdb_create")) {\r
- // minimum of 10 (yyyy-mm-dd)...\r
- if (theEntity.getValue("webdb_create").length() >= 10) {\r
- String dateString = theEntity.getValue("webdb_create");\r
-\r
- // if only 10, then add 00:00 so it doesn't throw a ParseException\r
- if (dateString.length() == 10) {\r
- dateString = dateString + " 00:00";\r
- }\r
-\r
- // TimeStamp stuff\r
- try {\r
- java.util.Date d = _dateFormatterIn.parse(dateString);\r
- Timestamp tStamp = new Timestamp(d.getTime());\r
- sql.append(",webdb_create='" + tStamp.toString() + "'");\r
- } catch (ParseException e) {\r
- throw new StorageObjectFailure(e);\r
- }\r
- }\r
- }\r
-\r
- if (streamedInput != null) {\r
- for (int i = 0; i < streamedInput.size(); i++) {\r
- sql.append(",").append(streamedInput.get(i)).append("=?");\r
- }\r
- }\r
-\r
- sql.append(" where id=").append(id);\r
-\r
- //theLog.printInfo("UPDATE: " + sql);\r
- // execute sql\r
- try {\r
- con = getPooledCon();\r
- con.setAutoCommit(false);\r
- pstmt = con.prepareStatement(sql.toString());\r
-\r
- if (streamedInput != null) {\r
- for (int i = 0; i < streamedInput.size(); i++) {\r
- String inputString =\r
- theEntity.getValue((String) streamedInput.get(i));\r
- pstmt.setBytes(i + 1, inputString.getBytes());\r
- }\r
- }\r
-\r
- pstmt.executeUpdate();\r
- } catch (SQLException sqe) {\r
- throwSQLException(sqe, "update");\r
- } finally {\r
- try {\r
- con.setAutoCommit(true);\r
- } catch (Exception e) {\r
- ;\r
- }\r
-\r
- freeConnection(con, pstmt);\r
- }\r
- }\r
-\r
- /*\r
- * delete-Operator\r
- * @param id des zu loeschenden Datensatzes\r
- * @return boolean liefert true zurueck, wenn loeschen erfolgreich war.\r
- */\r
- public boolean delete(String id) throws StorageObjectFailure {\r
- invalidatePopupCache();\r
-\r
- // ostore send notification\r
- if (StoreUtil.implementsStorableObject(theEntityClass)) {\r
- String uniqueId = id;\r
-\r
- if (theEntityClass.equals(StorableObjectEntity.class)) {\r
- uniqueId += ("@" + theTable);\r
- }\r
-\r
- logger.debug("CACHE: (del) " + id);\r
-\r
- StoreIdentifier search_sid =\r
- new StoreIdentifier(theEntityClass,\r
- StoreContainerType.STOC_TYPE_ENTITY, uniqueId);\r
- o_store.invalidate(search_sid);\r
- }\r
-\r
- /** @todo could be prepared Statement */\r
- Statement stmt = null;\r
- Connection con = null;\r
- int res = 0;\r
- String sql =\r
- "delete from " + theTable + " where " + thePKeyName + "='" + id + "'";\r
-\r
- //theLog.printInfo("DELETE " + sql);\r
- try {\r
- con = getPooledCon();\r
- stmt = con.createStatement();\r
- res = stmt.executeUpdate(sql);\r
- } catch (SQLException sqe) {\r
- throwSQLException(sqe, "delete");\r
- } finally {\r
- freeConnection(con, stmt);\r
- }\r
-\r
- return (res > 0) ? true : false;\r
- }\r
-\r
- /* noch nicht implementiert.\r
- * @return immer false\r
- */\r
- public boolean delete(EntityList theEntityList) {\r
- invalidatePopupCache();\r
-\r
- return false;\r
- }\r
-\r
- /**\r
- * Diese Methode sollte ueberschrieben werden, wenn fuer die abgeleitete Database-Klasse\r
- * eine SimpleList mit Standard-Popupdaten erzeugt werden koennen soll.\r
- * @return null\r
- */\r
- public SimpleList getPopupData() throws StorageObjectFailure {\r
- return null;\r
- }\r
-\r
- /**\r
- * Holt Daten fuer Popups.\r
- * @param name Name des Feldes.\r
- * @param hasNullValue Wenn true wird eine leerer Eintrag fuer die Popups erzeugt.\r
- * @return SimpleList Gibt freemarker.template.SimpleList zurueck.\r
- */\r
- public SimpleList getPopupData(String name, boolean hasNullValue)\r
- throws StorageObjectFailure {\r
- return getPopupData(name, hasNullValue, null);\r
- }\r
-\r
- /**\r
- * Holt Daten fuer Popups.\r
- * @param name Name des Feldes.\r
- * @param hasNullValue Wenn true wird eine leerer Eintrag fuer die Popups erzeugt.\r
- * @param where Schraenkt die Selektion der Datensaetze ein.\r
- * @return SimpleList Gibt freemarker.template.SimpleList zurueck.\r
- */\r
- public SimpleList getPopupData(String name, boolean hasNullValue, String where)\r
- throws StorageObjectFailure {\r
- return getPopupData(name, hasNullValue, where, null);\r
- }\r
-\r
- /**\r
- * Holt Daten fuer Popups.\r
- * @param name Name des Feldes.\r
- * @param hasNullValue Wenn true wird eine leerer Eintrag fuer die Popups erzeugt.\r
- * @param where Schraenkt die Selektion der Datensaetze ein.\r
- * @param order Gibt ein Feld als Sortierkriterium an.\r
- * @return SimpleList Gibt freemarker.template.SimpleList zurueck.\r
- */\r
- public SimpleList getPopupData(String name, boolean hasNullValue,\r
- String where, String order) throws StorageObjectFailure {\r
- // caching\r
- if (hasPopupCache && (popupCache != null)) {\r
- return popupCache;\r
- }\r
-\r
- SimpleList simpleList = null;\r
- Connection con = null;\r
- Statement stmt = null;\r
-\r
- // build sql\r
- StringBuffer sql =\r
- new StringBuffer("select ").append(thePKeyName).append(",").append(name)\r
- .append(" from ").append(theTable);\r
-\r
- if ((where != null) && !(where.length() == 0)) {\r
- sql.append(" where ").append(where);\r
- }\r
-\r
- sql.append(" order by ");\r
-\r
- if ((order != null) && !(order.length() == 0)) {\r
- sql.append(order);\r
- } else {\r
- sql.append(name);\r
- }\r
-\r
- // execute sql\r
- try {\r
- con = getPooledCon();\r
- } catch (Exception e) {\r
- throw new StorageObjectFailure(e);\r
- }\r
-\r
- try {\r
- stmt = con.createStatement();\r
-\r
- ResultSet rs = executeSql(stmt, sql.toString());\r
-\r
- if (rs != null) {\r
- if (!evaluatedMetaData) {\r
- get_meta_data();\r
- }\r
-\r
- simpleList = new SimpleList();\r
-\r
- // if popup has null-selector\r
- if (hasNullValue) {\r
- simpleList.add(POPUP_EMPTYLINE);\r
- }\r
-\r
- SimpleHash popupDict;\r
-\r
- while (rs.next()) {\r
- popupDict = new SimpleHash();\r
- popupDict.put("key", getValueAsString(rs, 1, thePKeyType));\r
- popupDict.put("value", rs.getString(2));\r
- simpleList.add(popupDict);\r
- }\r
-\r
- rs.close();\r
- }\r
- }\r
- catch (Exception e) {\r
- logger.error("getPopupData: " + e.getMessage());\r
- throw new StorageObjectFailure(e);\r
- } finally {\r
- freeConnection(con, stmt);\r
- }\r
-\r
- if (hasPopupCache) {\r
- popupCache = simpleList;\r
- }\r
-\r
- return simpleList;\r
- }\r
-\r
- /**\r
- * Liefert alle Daten der Tabelle als SimpleHash zurueck. Dies wird verwandt,\r
- * wenn in den Templates ein Lookup-Table benoetigt wird. Sollte nur bei kleinen\r
- * Tabellen Verwendung finden.\r
- * @return SimpleHash mit den Tabellezeilen.\r
- */\r
- public SimpleHash getHashData() {\r
- /** @todo dangerous! this should have a flag to be enabled, otherwise\r
- * very big Hashes could be returned */\r
- if (hashCache == null) {\r
- try {\r
- hashCache =\r
- HTMLTemplateProcessor.makeSimpleHash(selectByWhereClause("", -1));\r
- }\r
- catch (StorageObjectFailure e) {\r
- logger.debug(e.getMessage());\r
- }\r
- }\r
-\r
- return hashCache;\r
- }\r
-\r
- /* invalidates the popupCache\r
- */\r
- protected void invalidatePopupCache() {\r
- /** @todo invalidates toooo much */\r
- popupCache = null;\r
- hashCache = null;\r
- }\r
-\r
- /**\r
- * Diese Methode fuehrt den Sqlstring <i>sql</i> aus und timed im Logfile.\r
- * @param stmt Statemnt\r
- * @param sql Sql-String\r
- * @return ResultSet\r
- * @exception StorageObjectException\r
- */\r
- public ResultSet executeSql(Statement stmt, String sql)\r
- throws StorageObjectFailure, SQLException {\r
- ResultSet rs;\r
- long startTime = System.currentTimeMillis();\r
-\r
- try {\r
- rs = stmt.executeQuery(sql);\r
-\r
- logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);\r
- }\r
- catch (SQLException e) {\r
- logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);\r
- throw e;\r
- }\r
-\r
- return rs;\r
- }\r
-\r
- /**\r
- * returns the number of rows in the table\r
- */\r
- public int getSize(String where) throws SQLException, StorageObjectFailure {\r
- long startTime = System.currentTimeMillis();\r
- String sql = "SELECT Count(*) FROM " + theTable;\r
-\r
- if ((where != null) && !(where.length() == 0)) {\r
- sql = sql + " where " + where;\r
- }\r
-\r
- Connection con = null;\r
- Statement stmt = null;\r
- int result = 0;\r
-\r
- try {\r
- con = getPooledCon();\r
- stmt = con.createStatement();\r
-\r
- ResultSet rs = executeSql(stmt, sql);\r
-\r
- while (rs.next()) {\r
- result = rs.getInt(1);\r
- }\r
- }\r
- catch (SQLException e) {\r
- logger.error("Database.getSize: " + e.getMessage());\r
- }\r
- finally {\r
- freeConnection(con, stmt);\r
- }\r
-\r
- //theLog.printInfo(theTable + " has "+ result +" rows where " + where);\r
- logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);\r
-\r
- return result;\r
- }\r
-\r
- public int executeUpdate(Statement stmt, String sql)\r
- throws StorageObjectFailure, SQLException {\r
- int rs;\r
- long startTime = System.currentTimeMillis();\r
-\r
- try {\r
- rs = stmt.executeUpdate(sql);\r
-\r
- logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);\r
- }\r
- catch (SQLException e) {\r
- logger.debug("Failed: " + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);\r
- throw e;\r
- }\r
-\r
- return rs;\r
- }\r
-\r
- public int executeUpdate(String sql)\r
- throws StorageObjectFailure, SQLException {\r
- int result = -1;\r
- long startTime = System.currentTimeMillis();\r
- Connection con = null;\r
- PreparedStatement pstmt = null;\r
-\r
- try {\r
- con = getPooledCon();\r
- pstmt = con.prepareStatement(sql);\r
- result = pstmt.executeUpdate();\r
- }\r
- catch (Throwable e) {\r
- logger.error("Database.executeUpdate(" + sql + "): " + e.getMessage());\r
- throw new StorageObjectFailure("Database.executeUpdate(" + sql + "): " + e.getMessage(), e);\r
- }\r
- finally {\r
- freeConnection(con, pstmt);\r
- }\r
-\r
- logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);\r
- return result;\r
- }\r
-\r
- /**\r
- * Wertet ResultSetMetaData aus und setzt interne Daten entsprechend\r
- * @param md ResultSetMetaData\r
- * @exception StorageObjectException\r
- */\r
- private void evalMetaData(ResultSetMetaData md) throws StorageObjectFailure {\r
- this.evaluatedMetaData = true;\r
- this.metadataFields = new ArrayList();\r
- this.metadataLabels = new ArrayList();\r
- this.metadataNotNullFields = new ArrayList();\r
-\r
- try {\r
- int numFields = md.getColumnCount();\r
- this.metadataTypes = new int[numFields];\r
-\r
- String aField;\r
- int aType;\r
-\r
- for (int i = 1; i <= numFields; i++) {\r
- aField = md.getColumnName(i);\r
- metadataFields.add(aField);\r
- metadataLabels.add(md.getColumnLabel(i));\r
- aType = md.getColumnType(i);\r
- metadataTypes[i - 1] = aType;\r
-\r
- if (aField.equals(thePKeyName)) {\r
- thePKeyType = aType;\r
- thePKeyIndex = i;\r
- }\r
-\r
- if (md.isNullable(i) == ResultSetMetaData.columnNullable) {\r
- metadataNotNullFields.add(aField);\r
- }\r
- }\r
- }\r
- catch (SQLException e) {\r
- throwSQLException(e, "evalMetaData");\r
- }\r
- }\r
-\r
- /**\r
- * Wertet die Metadaten eines Resultsets fuer eine Tabelle aus,\r
- * um die alle Columns und Typen einer Tabelle zu ermitteln.\r
- */\r
- private void get_meta_data() throws StorageObjectFailure {\r
- Connection con = null;\r
- PreparedStatement pstmt = null;\r
- String sql = "select * from " + theTable + " where 0=1";\r
-\r
- try {\r
- con = getPooledCon();\r
- pstmt = con.prepareStatement(sql);\r
-\r
- logger.debug("METADATA: " + sql);\r
- ResultSet rs = pstmt.executeQuery();\r
- evalMetaData(rs.getMetaData());\r
- rs.close();\r
- }\r
- catch (SQLException e) {\r
- throwSQLException(e, "get_meta_data");\r
- }\r
- finally {\r
- freeConnection(con, pstmt);\r
- }\r
- }\r
-\r
- public Connection getPooledCon() throws StorageObjectFailure {\r
- Connection con = null;\r
-\r
- try {\r
- con = SQLManager.getInstance().requestConnection();\r
- }\r
- catch (SQLException e) {\r
- logger.error("could not connect to the database " + e.getMessage());\r
- System.err.println("could not connect to the database " + e.getMessage());\r
- throw new StorageObjectFailure("Could not connect to the database", e);\r
- }\r
-\r
- return con;\r
- }\r
-\r
- public void freeConnection(Connection con, Statement stmt)\r
- throws StorageObjectFailure {\r
- SQLManager.closeStatement(stmt);\r
- SQLManager.getInstance().returnConnection(con);\r
- }\r
-\r
- /**\r
- * Wertet SQLException aus und wirft dannach eine StorageObjectException\r
- * @param sqe SQLException\r
- * @param wo Funktonsname, in der die SQLException geworfen wurde\r
- * @exception StorageObjectException\r
- */\r
- protected void throwSQLException(SQLException sqe, String aFunction)\r
- throws StorageObjectFailure {\r
- String state = "";\r
- String message = "";\r
- int vendor = 0;\r
-\r
- if (sqe != null) {\r
- state = sqe.getSQLState();\r
- message = sqe.getMessage();\r
- vendor = sqe.getErrorCode();\r
- }\r
-\r
- String information =\r
- "SQL Error: " +\r
- "state= " + state +\r
- ", vendor= " + vendor +\r
- ", message=" + message +\r
- ", function= " + aFunction;\r
-\r
- logger.error(information);\r
-\r
- throw new StorageObjectFailure(information, sqe);\r
- }\r
-\r
- protected void _throwStorageObjectException(Exception e, String aFunction)\r
- throws StorageObjectFailure {\r
-\r
- if (e != null) {\r
- logger.error(e.getMessage() + aFunction);\r
- throw new StorageObjectFailure(aFunction, e);\r
- }\r
- }\r
-\r
- /**\r
- * Loggt Fehlermeldung mit dem Parameter Message und wirft dannach\r
- * eine StorageObjectException\r
- * @param message Nachricht mit dem Fehler\r
- * @exception StorageObjectException\r
- */\r
- void throwStorageObjectException(String aMessage) throws StorageObjectFailure {\r
- logger.error(aMessage);\r
- throw new StorageObjectFailure(aMessage, null);\r
- }\r
-}\r
+/*
+ * Copyright (C) 2001-2006 The Mir-coders group
+ *
+ * This file is part of Mir.
+ *
+ * Mir 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
+ * (at your option) any later version.
+ *
+ * Mir 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 Mir; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * In addition, as a special exception, The Mir-coders gives permission to link
+ * the code of this program with any library licensed under the Apache Software License,
+ * and distribute linked combinations including the two. You must obey the
+ * GNU General Public License in all respects for all of the code used other than
+ * the above mentioned libraries. If you modify this file, you may extend this
+ * exception to your version of the file, but you are not obligated to do so.
+ * If you do not wish to do so, delete this exception statement from your version.
+ */
+package mir.storage;
+
+import mir.config.MirPropertiesConfiguration;
+import mir.entity.AbstractEntity;
+import mir.entity.Entity;
+import mir.entity.EntityList;
+import mir.entity.StorableObjectEntity;
+import mir.log.LoggerWrapper;
+import mir.storage.store.*;
+import mir.util.JDBCStringRoutines;
+import mir.util.StreamCopier;
+import mircoders.global.MirGlobal;
+import org.apache.commons.dbcp.DelegatingConnection;
+import org.postgresql.PGConnection;
+import org.postgresql.largeobject.LargeObject;
+import org.postgresql.largeobject.LargeObjectManager;
+
+import java.io.ByteArrayOutputStream;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.sql.*;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.*;
+
+/**
+ * Implements database access.
+ *
+ * @version $Id: Database.java,v 1.44.2.37 2006/12/25 20:10:22 zapata Exp $
+ * @author rk
+ * @author Zapata
+ *
+ */
+public class Database {
+ private static final int DEFAULT_LIMIT = 20;
+ private static final Class GENERIC_ENTITY_CLASS = StorableObjectEntity.class;
+ protected static final ObjectStore o_store = ObjectStore.getInstance();
+
+ protected LoggerWrapper logger;
+
+ protected String mainTable;
+ protected String primaryKeyField = "id";
+
+ private List fieldNames;
+ private int[] fieldTypes;
+ private Map fieldNameToType;
+
+ protected Class entityClass;
+
+ //
+ private Set binaryFields;
+
+ private TimeZone timezone;
+ private SimpleDateFormat userInputDateFormat;
+
+ public Database() throws DatabaseFailure {
+ MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
+ logger = new LoggerWrapper("Database");
+ timezone = TimeZone.getTimeZone(configuration.getString("Mir.DefaultTimezone"));
+
+ userInputDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");
+ userInputDateFormat.setTimeZone(timezone);
+
+ binaryFields = new HashSet();
+
+ String adapterName = configuration.getString("Database.Adaptor");
+
+ try {
+ entityClass = GENERIC_ENTITY_CLASS;
+ }
+ catch (Throwable e) {
+ logger.error("Error in Database() constructor with " + adapterName + " -- " + e.getMessage());
+ throw new DatabaseFailure("Error in Database() constructor.", e);
+ }
+ }
+
+ public Class getEntityClass() {
+ return entityClass;
+ }
+
+ public Entity createNewEntity() throws DatabaseFailure {
+ try {
+ AbstractEntity result = (AbstractEntity) entityClass.newInstance();
+ result.setStorage(this);
+
+ return result;
+ }
+ catch (Throwable t) {
+ throw new DatabaseFailure(t);
+ }
+ }
+
+ public String getIdFieldName() {
+ return primaryKeyField;
+ }
+
+ public String getTableName() {
+ return mainTable;
+ }
+
+ /**
+ * Returns a list of field names for this <code>Database</code>
+ */
+ public List getFieldNames() throws DatabaseFailure {
+ if (fieldNames == null) {
+ acquireMetaData();
+ }
+
+ return fieldNames;
+ }
+
+ public boolean hasField(String aFieldName) {
+ return getFieldNames().contains(aFieldName);
+ }
+
+ /**
+ * Gets value out of ResultSet according to type and converts to String
+ *
+ * @param aResultSet ResultSet.
+ * @param aType a type from java.sql.Types.*
+ * @param aFieldIndex index in ResultSet
+ * @return returns the value as String. If no conversion is possible
+ * /unsupported value/ is returned
+ */
+ private String getValueAsString(ResultSet aResultSet, int aFieldIndex, int aType)
+ throws DatabaseFailure {
+ String outValue = null;
+
+ if (aResultSet != null) {
+ try {
+ switch (aType) {
+ case java.sql.Types.BIT:
+ outValue = (aResultSet.getBoolean(aFieldIndex) == true) ? "1" : "0";
+
+ break;
+
+ case java.sql.Types.INTEGER:
+ case java.sql.Types.SMALLINT:
+ case java.sql.Types.TINYINT:
+ case java.sql.Types.BIGINT:
+
+ int out = aResultSet.getInt(aFieldIndex);
+
+ if (!aResultSet.wasNull()) {
+ outValue = new Integer(out).toString();
+ }
+
+ break;
+
+ case java.sql.Types.NUMERIC:
+ long outl = aResultSet.getLong(aFieldIndex);
+
+ if (!aResultSet.wasNull()) {
+ outValue = new Long(outl).toString();
+ }
+
+ break;
+
+ case java.sql.Types.REAL:
+
+ float tempf = aResultSet.getFloat(aFieldIndex);
+
+ if (!aResultSet.wasNull()) {
+ tempf *= 10;
+ tempf += 0.5;
+
+ int tempf_int = (int) tempf;
+ tempf = (float) tempf_int;
+ tempf /= 10;
+ outValue = "" + tempf;
+ outValue = outValue.replace('.', ',');
+ }
+
+ break;
+
+ case java.sql.Types.DOUBLE:
+
+ double tempd = aResultSet.getDouble(aFieldIndex);
+
+ if (!aResultSet.wasNull()) {
+ tempd *= 10;
+ tempd += 0.5;
+
+ int tempd_int = (int) tempd;
+ tempd = (double) tempd_int;
+ tempd /= 10;
+ outValue = "" + tempd;
+ outValue = outValue.replace('.', ',');
+ }
+
+ break;
+
+ case java.sql.Types.CHAR:
+ case java.sql.Types.VARCHAR:
+ case java.sql.Types.LONGVARCHAR:
+ outValue = aResultSet.getString(aFieldIndex);
+
+ break;
+
+ case java.sql.Types.LONGVARBINARY:
+ outValue = aResultSet.getString(aFieldIndex);
+
+ break;
+
+ case java.sql.Types.TIMESTAMP:
+
+ // it's important to use Timestamp here as getting it
+ // as a string is undefined and is only there for debugging
+ // according to the API. we can make it a string through formatting.
+ // -mh
+ Timestamp timestamp = (aResultSet.getTimestamp(aFieldIndex));
+
+ if (!aResultSet.wasNull()) {
+ java.util.Date date = new java.util.Date(timestamp.getTime());
+ outValue = DatabaseHelper.convertDateToInternalRepresenation(date);
+ }
+
+ break;
+
+ default:
+ outValue = "<unsupported value>";
+ logger.warn("Unsupported Datatype: at " + aFieldIndex + " (" + aType + ")");
+ }
+ }
+ catch (SQLException e) {
+ throw new DatabaseFailure("Could not get Value out of Resultset -- ",
+ e);
+ }
+ }
+
+ return outValue;
+ }
+
+ /**
+ * Return an entity specified by id, or <code>null</code> if no such
+ * entity exists.
+ */
+ public Entity selectById(String anId) throws DatabaseExc {
+ if ((anId == null) || anId.equals("")) {
+ throw new DatabaseExc("Database.selectById: Missing id");
+ }
+
+ // ask object store for object
+ if (StoreUtil.extendsStorableEntity(entityClass)) {
+ String uniqueId = anId;
+
+ if (entityClass.equals(StorableObjectEntity.class)) {
+ uniqueId += ("@" + mainTable);
+ }
+
+ StoreIdentifier search_sid = new StoreIdentifier(entityClass, uniqueId);
+ logger.debug("CACHE: (dbg) looking for sid " + search_sid.toString());
+
+ Entity hit = (Entity) o_store.use(search_sid);
+
+ if (hit != null) {
+ return hit;
+ }
+ }
+
+ Connection con = obtainConnection();
+ Entity returnEntity = null;
+ PreparedStatement statement = null;
+
+ try {
+ ResultSet rs;
+ String query = "select * from " + mainTable + " where " + primaryKeyField + " = ?";
+
+ statement = con.prepareStatement(query);
+ statement.setString(1, anId);
+
+ logQueryBefore(query);
+
+ long startTime = System.currentTimeMillis();
+ try {
+ rs = statement.executeQuery();
+
+ logQueryAfter(query, (System.currentTimeMillis() - startTime));
+ }
+ catch (SQLException e) {
+ logQueryError(query, (System.currentTimeMillis() - startTime), e);
+ throw e;
+ }
+
+ if (rs != null) {
+ if (rs.next()) {
+ returnEntity = makeEntityFromResultSet(rs);
+ }
+ else {
+ logger.warn("No data for id: " + anId + " in table " + mainTable);
+ }
+
+ rs.close();
+ }
+ else {
+ logger.warn("No Data for Id " + anId + " in Table " + mainTable);
+ }
+ }
+ catch (Throwable e) {
+ throw new DatabaseFailure(e);
+ }
+ finally {
+ freeConnection(con, statement);
+ }
+
+ return returnEntity;
+ }
+
+ public EntityList selectByWhereClauseWithExtraTables(String mainTablePrefix, List extraTables, String aWhereClause) throws DatabaseExc, DatabaseFailure {
+ return selectByWhereClause( mainTablePrefix, extraTables, aWhereClause, "", 0, DEFAULT_LIMIT);
+ }
+
+ public EntityList selectByFieldValue(String aField, String aValue) throws DatabaseExc, DatabaseFailure {
+ return selectByFieldValue(aField, aValue, 0);
+ }
+
+ public EntityList selectByFieldValue(String aField, String aValue, int offset) throws DatabaseExc, DatabaseFailure {
+ return selectByWhereClause(aField + "='" + JDBCStringRoutines.escapeStringLiteral(aValue)+"'", offset);
+ }
+
+ public EntityList selectByWhereClause(String where) throws DatabaseExc, DatabaseFailure {
+ return selectByWhereClause(where, 0);
+ }
+
+ public EntityList selectByWhereClause(String whereClause, int offset) throws DatabaseExc, DatabaseFailure {
+ return selectByWhereClause(whereClause, null, offset);
+ }
+
+ public EntityList selectByWhereClause(String mainTablePrefix, List extraTables, String where, String order) throws DatabaseExc, DatabaseFailure {
+ return selectByWhereClause(mainTablePrefix, extraTables, where, order, 0, DEFAULT_LIMIT);
+ }
+
+ public EntityList selectByWhereClause(String whereClause, String orderBy, int offset) throws DatabaseExc, DatabaseFailure {
+ return selectByWhereClause(whereClause, orderBy, offset, DEFAULT_LIMIT);
+ }
+
+ public EntityList selectByWhereClause(String aWhereClause, String anOrderByClause,
+ int offset, int limit) throws DatabaseExc, DatabaseFailure {
+ return selectByWhereClause("", null, aWhereClause, anOrderByClause, offset, limit);
+ }
+
+ public EntityList selectByWhereClause(
+ String aMainTablePrefix, List anExtraTables,
+ String aWhereClause, String anOrderByClause,
+ int anOffset, int aLimit) throws DatabaseExc, DatabaseFailure {
+
+ if (anExtraTables!=null && ((String) anExtraTables.get(0)).trim().equals("")){
+ anExtraTables=null;
+ }
+
+ // check o_store for entitylist
+ // only if no relational select
+ if (anExtraTables==null) {
+ if (StoreUtil.extendsStorableEntity(entityClass)) {
+ StoreIdentifier searchSid = new StoreIdentifier(entityClass,
+ StoreContainerType.STOC_TYPE_ENTITYLIST,
+ StoreUtil.getEntityListUniqueIdentifierFor(mainTable,
+ aWhereClause, anOrderByClause, anOffset, aLimit));
+ EntityList hit = (EntityList) o_store.use(searchSid);
+
+ if (hit != null) {
+ return hit;
+ }
+ }
+ }
+
+ RecordRetriever retriever = new RecordRetriever(mainTable, aMainTablePrefix);
+
+ EntityList result = null;
+ Connection connection = null;
+
+ if (anExtraTables!=null) {
+ Iterator i = anExtraTables.iterator();
+ while (i.hasNext()) {
+ String table = (String) i.next();
+ if (!"".equals(table)) {
+ retriever.addExtraTable(table);
+ }
+ }
+ }
+
+ if (aWhereClause != null) {
+ retriever.appendWhereClause(aWhereClause);
+ }
+
+ if ((anOrderByClause != null) && !(anOrderByClause.trim().length() == 0)) {
+ retriever.appendOrderByClause(anOrderByClause);
+ }
+
+ if (anOffset>-1 && aLimit>-1) {
+ retriever.setLimit(aLimit+1);
+ retriever.setOffset(anOffset);
+ }
+
+ Iterator i = getFieldNames().iterator();
+ while (i.hasNext()) {
+ retriever.addField((String) i.next());
+ }
+
+ // execute sql
+ try {
+ connection = obtainConnection();
+ ResultSet resultSet = retriever.execute(connection);
+
+ boolean hasMore = false;
+
+ if (resultSet != null) {
+ result = new EntityList();
+ Entity entity;
+ int position = 0;
+
+ while (((aLimit == -1) || (position<aLimit)) && resultSet.next()) {
+ entity = makeEntityFromResultSet(resultSet);
+ result.add(entity);
+ position++;
+ }
+
+ hasMore = resultSet.next();
+ resultSet.close();
+ }
+
+ if (result != null) {
+ result.setOffset(anOffset);
+ result.setWhere(aWhereClause);
+ result.setOrder(anOrderByClause);
+ result.setStorage(this);
+ result.setLimit(aLimit);
+
+ if (hasMore) {
+ result.setNextBatch(anOffset + aLimit);
+ }
+
+ if (anExtraTables==null && StoreUtil.extendsStorableEntity(entityClass)) {
+ StoreIdentifier sid = result.getStoreIdentifier();
+ logger.debug("CACHE (add): " + sid.toString());
+ o_store.add(sid);
+ }
+ }
+ }
+ catch (Throwable e) {
+ throw new DatabaseFailure(e);
+ }
+ finally {
+ try {
+ if (connection != null) {
+ freeConnection(connection);
+ }
+ } catch (Throwable t) {
+ }
+ }
+
+ return result;
+ }
+
+ private Entity makeEntityFromResultSet(ResultSet rs) {
+ Map fields = new HashMap();
+ String theResult = null;
+ int type;
+ Entity returnEntity = null;
+
+ try {
+ if (StoreUtil.extendsStorableEntity(entityClass)) {
+ StoreIdentifier searchSid = StorableObjectEntity.getStoreIdentifier(this,
+ entityClass, rs);
+ Entity hit = (Entity) o_store.use(searchSid);
+ if (hit != null) return hit;
+ }
+
+ for (int i = 0; i < getFieldNames().size(); i++) {
+ type = fieldTypes[i];
+
+ if (type == java.sql.Types.LONGVARBINARY) {
+ InputStreamReader is =
+ (InputStreamReader) rs.getCharacterStream(i + 1);
+
+ if (is != null) {
+ char[] data = new char[32768];
+ StringBuffer theResultString = new StringBuffer();
+ int len;
+
+ while ((len = is.read(data)) > 0) {
+ theResultString.append(data, 0, len);
+ }
+
+ is.close();
+ theResult = theResultString.toString();
+ }
+ else {
+ theResult = null;
+ }
+ }
+ else {
+ theResult = getValueAsString(rs, (i + 1), type);
+ }
+
+ if (theResult != null) {
+ fields.put(getFieldNames().get(i), theResult);
+ }
+ }
+
+ if (entityClass != null) {
+ returnEntity = createNewEntity();
+ returnEntity.setFieldValues(fields);
+
+ if (returnEntity instanceof StorableObject) {
+ logger.debug("CACHE: ( in) " + returnEntity.getId() + " :" + mainTable);
+ o_store.add(((StorableObject) returnEntity).getStoreIdentifier());
+ }
+ }
+ else {
+ throw new DatabaseExc("Internal Error: entityClass not set!");
+ }
+ }
+ catch (Throwable e) {
+ throw new DatabaseFailure(e);
+ }
+
+ return returnEntity;
+ }
+
+ /**
+ * Inserts an entity into the database.
+ *
+ * @param anEntity
+ * @return the value of the primary key of the inserted record
+ */
+ public String insert(Entity anEntity) throws DatabaseFailure {
+ invalidateStore();
+
+ RecordInserter inserter =
+ new RecordInserter(mainTable, getPrimaryKeySequence());
+
+ String returnId = null;
+ Connection con = null;
+
+ try {
+ String fieldName;
+
+ // make sql-string
+ for (int i = 0; i < getFieldNames().size(); i++) {
+ fieldName = (String) getFieldNames().get(i);
+
+ if (!fieldName.equals(primaryKeyField)) {
+ // exceptions
+ if (!anEntity.hasFieldValue(fieldName) && (
+ fieldName.equals("webdb_create") ||
+ fieldName.equals("webdb_lastchange"))) {
+ inserter.assignVerbatim(fieldName, "now()");
+ }
+ else {
+ if (anEntity.hasFieldValue(fieldName)) {
+ inserter.assignString(fieldName, anEntity.getFieldValue(fieldName));
+ }
+ }
+ }
+ }
+
+ con = obtainConnection();
+ returnId = inserter.execute(con);
+
+ anEntity.setId(returnId);
+ }
+ finally {
+ freeConnection(con);
+ }
+
+ return returnId;
+ }
+
+ /**
+ * Updates an entity in the database
+ *
+ * @param theEntity
+ */
+ public void update(Entity theEntity) throws DatabaseFailure {
+ invalidateStore();
+
+ RecordUpdater generator = new RecordUpdater(getTableName(), theEntity.getId());
+
+ // build sql statement
+ for (int i = 0; i < getFieldNames().size(); i++) {
+ String field = (String) getFieldNames().get(i);
+
+ if (!(field.equals(primaryKeyField) ||
+ "webdb_create".equals(field) ||
+ "webdb_lastchange".equals(field) ||
+ binaryFields.contains(field))) {
+
+ if (theEntity.hasFieldValue(field)) {
+ generator.assignString(field, theEntity.getFieldValue(field));
+ }
+ }
+ }
+
+ // exceptions
+ if (hasField("webdb_lastchange")) {
+ generator.assignVerbatim("webdb_lastchange", "now()");
+ }
+
+ // special case: the webdb_create requires the field in yyyy-mm-dd HH:mm
+ // format so anything extra will be ignored. -mh
+ if (hasField("webdb_create") &&
+ theEntity.hasFieldValue("webdb_create")) {
+ // minimum of 10 (yyyy-mm-dd)...
+ if (theEntity.getFieldValue("webdb_create").length() >= 10) {
+ String dateString = theEntity.getFieldValue("webdb_create");
+
+ // if only 10, then add 00:00 so it doesn't throw a ParseException
+ if (dateString.length() == 10) {
+ dateString = dateString + " 00:00";
+ }
+
+ // TimeStamp stuff
+ try {
+ java.util.Date d = userInputDateFormat.parse(dateString);
+ generator.assignDateTime("webdb_create", d);
+ }
+ catch (ParseException e) {
+ throw new DatabaseFailure(e);
+ }
+ }
+ }
+ Connection connection = null;
+
+ try {
+ connection = obtainConnection();
+ generator.execute(connection);
+ }
+ finally {
+ freeConnection(connection);
+ }
+ }
+
+ private void invalidateObject(String anId) {
+ // ostore send notification
+ if (StoreUtil.extendsStorableEntity(entityClass)) {
+ String uniqueId = anId;
+
+ if (entityClass.equals(StorableObjectEntity.class)) {
+ uniqueId += ("@" + mainTable);
+ }
+
+ logger.debug("CACHE: (del) " + anId);
+
+ StoreIdentifier search_sid =
+ new StoreIdentifier(entityClass,
+ StoreContainerType.STOC_TYPE_ENTITY, uniqueId);
+ o_store.invalidate(search_sid);
+ }
+ }
+
+ /*
+ * delete-Operator
+ * @param id des zu loeschenden Datensatzes
+ * @return boolean liefert true zurueck, wenn loeschen erfolgreich war.
+ */
+ public boolean delete(String id) throws DatabaseFailure {
+ invalidateObject(id);
+
+ int resultCode = 0;
+ Connection connection = obtainConnection();
+ PreparedStatement statement = null;
+
+ try {
+ statement = connection.prepareStatement("delete from " + mainTable + " where " + primaryKeyField + "=?");
+ statement.setInt(1, Integer.parseInt(id));
+ logQueryBefore("delete from " + mainTable + " where " + primaryKeyField + "=" + id + "");
+ resultCode = statement.executeUpdate();
+ }
+ catch (SQLException e) {
+ logger.warn("Can't delete record", e);
+ }
+ finally {
+ freeConnection(connection, statement);
+ }
+
+ invalidateStore();
+
+ return (resultCode > 0) ? true : false;
+ }
+
+ /**
+ * Deletes entities based on a where clause
+ */
+ public int deleteByWhereClause(String aWhereClause) throws DatabaseFailure {
+ invalidateStore();
+
+ Statement stmt = null;
+ Connection con = null;
+ int res = 0;
+ String sql =
+ "delete from " + mainTable + " where " + aWhereClause;
+
+ //theLog.printInfo("DELETE " + sql);
+ try {
+ con = obtainConnection();
+ stmt = con.createStatement();
+ res = stmt.executeUpdate(sql);
+ }
+ catch (Throwable e) {
+ throw new DatabaseFailure(e);
+ }
+ finally {
+ freeConnection(con, stmt);
+ }
+
+ return res;
+ }
+
+ /* noch nicht implementiert.
+ * @return immer false
+ */
+ public boolean delete(EntityList theEntityList) {
+ return false;
+ }
+
+ public ResultSet executeSql(Statement stmt, String sql)
+ throws DatabaseFailure, SQLException {
+ ResultSet rs;
+ logQueryBefore(sql);
+ long startTime = System.currentTimeMillis();
+ try {
+ rs = stmt.executeQuery(sql);
+
+ logQueryAfter(sql, (System.currentTimeMillis() - startTime));
+ }
+ catch (SQLException e) {
+ logQueryError(sql, (System.currentTimeMillis() - startTime), e);
+ throw e;
+ }
+
+ return rs;
+ }
+
+ private Map processRow(ResultSet aResultSet) throws DatabaseFailure {
+ try {
+ Map result = new HashMap();
+ ResultSetMetaData metaData = aResultSet.getMetaData();
+ int nrColumns = metaData.getColumnCount();
+ for (int i=0; i<nrColumns; i++) {
+ result.put(metaData.getColumnName(i+1), getValueAsString(aResultSet, i+1, metaData.getColumnType(i+1)));
+ }
+
+ return result;
+ }
+ catch (Throwable e) {
+ throw new DatabaseFailure(e);
+ }
+ }
+
+ /**
+ * Executes 1 sql statement and returns the results as a <code>List</code> of
+ * <code>Map</code>s
+ */
+ public List executeFreeSql(String sql, int aLimit) throws DatabaseFailure, DatabaseExc {
+ Connection connection = null;
+ Statement statement = null;
+ try {
+ List result = new ArrayList();
+ connection = obtainConnection();
+ statement = connection.createStatement();
+ ResultSet resultset = executeSql(statement, sql);
+ try {
+ while (resultset.next() && result.size() < aLimit) {
+ result.add(processRow(resultset));
+ }
+ }
+ finally {
+ resultset.close();
+ }
+
+ return result;
+ }
+ catch (Throwable e) {
+ throw new DatabaseFailure(e);
+ }
+ finally {
+ if (connection!=null) {
+ freeConnection(connection, statement);
+ }
+ }
+ }
+
+ /**
+ * Executes 1 sql statement and returns the first result row as a <code>Map</code>s
+ * (<code>null</code> if there wasn't any row)
+ */
+ public Map executeFreeSingleRowSql(String anSqlStatement) throws DatabaseFailure, DatabaseExc {
+ try {
+ List resultList = executeFreeSql(anSqlStatement, 1);
+ try {
+ if (resultList.size()>0)
+ return (Map) resultList.get(0);
+ return null;
+ }
+ finally {
+ }
+ }
+ catch (Throwable t) {
+ throw new DatabaseFailure(t);
+ }
+ }
+
+ /**
+ * Executes 1 sql statement and returns the first column of the first result row as a <code>String</code>s
+ * (<code>null</code> if there wasn't any row)
+ */
+ public String executeFreeSingleValueSql(String sql) throws DatabaseFailure, DatabaseExc {
+ Map row = executeFreeSingleRowSql(sql);
+
+ if (row==null)
+ return null;
+
+ Iterator i = row.values().iterator();
+ if (i.hasNext())
+ return (String) i.next();
+ return null;
+ }
+
+ public int getSize(String where) throws SQLException, DatabaseFailure {
+ return getSize("", null, where);
+ }
+ /**
+ * returns the number of rows in the table
+ */
+ public int getSize(String mainTablePrefix, List extraTables, String where) throws SQLException, DatabaseFailure {
+
+ String useTable = mainTable;
+ if (mainTablePrefix!=null && mainTablePrefix.trim().length()>0) {
+ useTable+=" "+mainTablePrefix;
+ }
+ StringBuffer countSql =
+ new StringBuffer("select count(*) from ").append(useTable);
+ // append extratables, if necessary
+ if (extraTables!=null) {
+ for (int i=0;i < extraTables.size();i++) {
+ if (!extraTables.get(i).equals("")) {
+ countSql.append( ", " + extraTables.get(i));
+ }
+ }
+ }
+
+ if ((where != null) && (where.length() != 0)) {
+ countSql.append( " where " + where);
+ }
+
+ Connection con = null;
+ Statement stmt = null;
+ int result = 0;
+ logQueryBefore(countSql.toString());
+ long startTime = System.currentTimeMillis();
+
+ try {
+ con = obtainConnection();
+ stmt = con.createStatement();
+
+ ResultSet rs = executeSql(stmt, countSql.toString());
+
+ while (rs.next()) {
+ result = rs.getInt(1);
+ }
+ }
+ catch (SQLException e) {
+ logger.error("Database.getSize: " + e.getMessage());
+ }
+ finally {
+ freeConnection(con, stmt);
+ }
+ logQueryAfter(countSql.toString(), (System.currentTimeMillis() - startTime));
+
+ return result;
+ }
+
+ public int executeUpdate(Statement stmt, String sql)
+ throws DatabaseFailure, SQLException {
+ int rs;
+
+ logQueryBefore(sql);
+ long startTime = System.currentTimeMillis();
+
+ try {
+ rs = stmt.executeUpdate(sql);
+
+ logQueryAfter(sql, (System.currentTimeMillis() - startTime));
+ }
+ catch (SQLException e) {
+ logQueryError(sql, (System.currentTimeMillis() - startTime), e);
+ throw e;
+ }
+
+ return rs;
+ }
+
+ public int executeUpdate(String sql)
+ throws DatabaseFailure, SQLException {
+ int result = -1;
+ Connection con = null;
+ PreparedStatement pstmt = null;
+
+ logQueryBefore(sql);
+ long startTime = System.currentTimeMillis();
+ try {
+ con = obtainConnection();
+ pstmt = con.prepareStatement(sql);
+ result = pstmt.executeUpdate();
+ logQueryAfter(sql, System.currentTimeMillis() - startTime);
+ }
+ catch (Throwable e) {
+ logQueryError(sql, System.currentTimeMillis() - startTime, e);
+ throw new DatabaseFailure("Database.executeUpdate(" + sql + "): " + e.getMessage(), e);
+ }
+ finally {
+ freeConnection(con, pstmt);
+ }
+ return result;
+ }
+
+ /**
+ * Processes the metadata for the table this Database object is responsible for.
+ */
+ private void processMetaData(ResultSetMetaData aMetaData) throws DatabaseFailure {
+ fieldNames = new ArrayList();
+ fieldNameToType = new HashMap();
+
+ try {
+ int numFields = aMetaData.getColumnCount();
+ fieldTypes = new int[numFields];
+
+ for (int i = 1; i <= numFields; i++) {
+ fieldNames.add(aMetaData.getColumnName(i));
+ fieldTypes[i - 1] = aMetaData.getColumnType(i);
+ fieldNameToType.put(aMetaData.getColumnName(i), new Integer(aMetaData.getColumnType(i)));
+ }
+ }
+ catch (Throwable e) {
+ throw new DatabaseFailure(e);
+ }
+ }
+
+ /**
+ * Retrieves metadata from the table this Database object represents
+ */
+ private void acquireMetaData() throws DatabaseFailure {
+ Connection connection = null;
+ PreparedStatement statement = null;
+ String sql = "select * from " + mainTable + " where 0=1";
+
+ try {
+ connection = obtainConnection();
+ statement = connection.prepareStatement(sql);
+
+ logger.debug("METADATA: " + sql);
+ ResultSet resultSet = statement.executeQuery();
+ try {
+ processMetaData(resultSet.getMetaData());
+ }
+ finally {
+ resultSet.close();
+ }
+ }
+ catch (Throwable e) {
+ throw new DatabaseFailure(e);
+ }
+ finally {
+ freeConnection(connection, statement);
+ }
+ }
+
+ public Connection obtainConnection() throws DatabaseFailure {
+ try {
+ return MirGlobal.getDatabaseEngine().obtainConnection();
+ }
+ catch (Exception e) {
+ throw new DatabaseFailure(e);
+ }
+ }
+
+ public void freeConnection(Connection aConnection) throws DatabaseFailure {
+ try {
+ MirGlobal.getDatabaseEngine().releaseConnection(aConnection);
+ }
+ catch (Throwable t) {
+ logger.warn("Can't release connection: " + t.toString());
+ }
+ }
+
+ public void freeConnection(Connection aConnection, Statement aStatement) throws DatabaseFailure {
+ try {
+ aStatement.close();
+ }
+ catch (Throwable t) {
+ logger.warn("Can't close statement", t);
+ }
+
+ freeConnection(aConnection);
+ }
+
+ protected void _throwStorageObjectException(Exception e, String aFunction)
+ throws DatabaseFailure {
+
+ if (e != null) {
+ logger.error(e.getMessage() + aFunction);
+ throw new DatabaseFailure(aFunction, e);
+ }
+ }
+
+
+ /**
+ * Invalidates any cached entity list
+ */
+ private void invalidateStore() {
+ // invalidating all EntityLists corresponding with entityClass
+ if (StoreUtil.extendsStorableEntity(entityClass)) {
+ StoreContainerType stoc_type =
+ StoreContainerType.valueOf(entityClass, StoreContainerType.STOC_TYPE_ENTITYLIST);
+ o_store.invalidate(stoc_type);
+ }
+ }
+
+ /**
+ * Retrieves a binary value
+ */
+ public byte[] getBinaryField(String aQuery) throws DatabaseFailure, SQLException {
+ Connection connection=null;
+ Statement statement=null;
+ InputStream inputStream;
+
+ try {
+ connection = obtainConnection();
+ try {
+ connection.setAutoCommit(false);
+ statement = connection.createStatement();
+ ResultSet resultSet = executeSql(statement, aQuery);
+
+ if(resultSet!=null) {
+ if (resultSet.next()) {
+ if (resultSet.getMetaData().getColumnType(1) == java.sql.Types.BINARY) {
+ return resultSet.getBytes(1);
+ }
+ else {
+ inputStream = resultSet.getBlob(1).getBinaryStream();
+ ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+ StreamCopier.copy(inputStream, outputStream);
+ return outputStream.toByteArray();
+ }
+ }
+ resultSet.close();
+ }
+ }
+ finally {
+ try {
+ connection.setAutoCommit(true);
+ }
+ catch (Throwable e) {
+ logger.error("EntityImages.getImage resetting transaction mode failed: " + e.toString());
+ e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
+ }
+
+ try {
+ freeConnection(connection, statement);
+ }
+ catch (Throwable e) {
+ logger.error("EntityImages.getImage freeing connection failed: " +e.toString());
+ }
+
+ }
+ }
+ catch (Throwable t) {
+ logger.error("EntityImages.getImage failed: " + t.toString());
+ t.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
+
+ throw new DatabaseFailure(t);
+ }
+
+ return new byte[0];
+ }
+
+ /**
+ * Sets a binary value for a particular field in a record specified by its identifier
+ */
+ public void setBinaryField(String aFieldName, String anObjectId, byte aData[]) throws DatabaseFailure, SQLException {
+ PreparedStatement statement = null;
+ Connection connection = obtainConnection();
+
+ try {
+ connection.setAutoCommit(false);
+ try {
+ // are we using bytea ?
+ if (getFieldType(aFieldName) == java.sql.Types.BINARY) {
+ statement = connection.prepareStatement(
+ "update " + mainTable + " set " + aFieldName + " = ? where " + getIdFieldName() + "=" + Integer.parseInt(anObjectId));
+ statement.setBytes(1, aData);
+ statement.execute();
+ connection.commit();
+ }
+ // or the old oid's
+ else {
+ PGConnection postgresqlConnection = (org.postgresql.PGConnection) ((DelegatingConnection) connection).getDelegate();
+ LargeObjectManager lobManager = postgresqlConnection.getLargeObjectAPI();
+ int oid = lobManager.create(LargeObjectManager.READ | LargeObjectManager.WRITE);
+ LargeObject obj = lobManager.open(oid, LargeObjectManager.WRITE); // Now open the file File file =
+ obj.write(aData);
+ obj.close();
+ statement = connection.prepareStatement(
+ "update " + mainTable + " set " + aFieldName + " = ? where " + getIdFieldName() + "=" + Integer.parseInt(anObjectId));
+ statement.setInt(1, oid);
+ statement.execute();
+ connection.commit();
+ }
+ }
+ finally {
+ connection.setAutoCommit(true);
+ }
+ }
+ finally {
+ freeConnection(connection, statement);
+ }
+ }
+
+ /**
+ * Can be overridden to specify a primary key sequence name not named according to
+ * the convention (tablename _id_seq)
+ */
+ protected String getPrimaryKeySequence() {
+ return mainTable+"_id_seq";
+ }
+
+ /**
+ * Can be called by subclasses to specify fields that are binary, and that shouldn't
+ * be updated outside of {@link #setBinaryField}
+ *
+ * @param aBinaryField The field name of the binary field
+ */
+ protected void markBinaryField(String aBinaryField) {
+ binaryFields.add(aBinaryField);
+ }
+
+ private void logQueryBefore(String aQuery) {
+ logger.debug("about to perform QUERY " + aQuery);
+// (new Throwable()).printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
+ }
+
+ private void logQueryAfter(String aQuery, long aTime) {
+ logger.info("QUERY " + aQuery + " took " + aTime + "ms.");
+ }
+
+ private void logQueryError(String aQuery, long aTime, Throwable anException) {
+ logger.error("QUERY " + aQuery + " took " + aTime + "ms, but threw exception " + anException.toString());
+ }
+
+ private int getFieldType(String aFieldName) {
+ if (fieldNameToType == null) {
+ acquireMetaData();
+ }
+
+ return ((Integer) fieldNameToType.get(aFieldName)).intValue();
+ }
+}