- * Typical use of the context object will involve constructing one, and setting
- * the current user if one is authenticated. Several operations may be performed
- * using the context object. If all goes well, complete is called
- * to commit the changes and free up any resources used by the context. If
- * anything has gone wrong, abort is called to roll back any
- * changes and free up the resources.
- *
- * The context object is also used as a cache for CM API objects.
- *
- *
- * @version $Revision$
- */
-public class Context
-{
- private static final Logger log = Logger.getLogger(Context.class);
-
- /** Database connection */
- private Connection connection;
-
- /** Current user - null means anonymous access */
- private EPerson currentUser;
-
- /** Current Locale */
- private Locale currentLocale;
-
- /** Extra log info */
- private String extraLogInfo;
-
- /** Indicates whether authorisation subsystem should be ignored */
- private boolean ignoreAuth;
-
- /** A stack with the history of authoritation system check modify */
- private Stack
- * null if no user is
- * authenticated
- */
- public void setCurrentUser(EPerson user)
- {
- currentUser = user;
- }
-
- /**
- * Get the current (authenticated) user
- *
- * @return the current user, or null if no user is
- * authenticated
- */
- public EPerson getCurrentUser()
- {
- return currentUser;
- }
-
- /**
- * Gets the current Locale
- *
- * @return Locale
- * the current Locale
- */
- public Locale getCurrentLocale()
- {
- return currentLocale;
- }
-
- /**
- * set the current Locale
- *
- * @param locale
- * the current Locale
- */
- public void setCurrentLocale(Locale locale)
- {
- currentLocale = locale;
- }
-
- /**
- * Find out if the authorisation system should be ignored for this context.
- *
- * @return true if authorisation should be ignored for this
- * session.
- */
- public boolean ignoreAuthorization()
- {
- return ignoreAuth;
- }
-
- /**
- * Turn Off the Authorisation System for this context and store this change
- * in a history for future use.
- */
- public void turnOffAuthorisationSystem()
- {
- authStateChangeHistory.push(ignoreAuth);
- if (log.isDebugEnabled())
- {
- Thread currThread = Thread.currentThread();
- StackTraceElement[] stackTrace = currThread.getStackTrace();
- String caller = stackTrace[3].getClassName();
-
- authStateClassCallHistory.push(caller);
- }
- ignoreAuth = true;
- }
-
- /**
- * Restore the previous Authorisation System State. If the state was not
- * changed by the current caller a warning will be displayed in log. Use:
- *
- * mycontext.turnOffAuthorisationSystem();
- * some java code that require no authorisation check
- * mycontext.restoreAuthSystemState();
- * If Context debug is enabled, the correct sequence calling will be
- * checked and a warning will be displayed if not.
- */
- public void restoreAuthSystemState()
- {
- Boolean previousState;
- try
- {
- previousState = authStateChangeHistory.pop();
- }
- catch (EmptyStackException ex)
- {
- log.warn(LogManager.getHeader(this, "restore_auth_sys_state",
- "not previous state info available "
- + ex.getLocalizedMessage()));
- previousState = new Boolean(false);
- }
- if (log.isDebugEnabled())
- {
- Thread currThread = Thread.currentThread();
- StackTraceElement[] stackTrace = currThread.getStackTrace();
- String caller = stackTrace[3].getClassName();
-
- String previousCaller = (String) authStateClassCallHistory.pop();
-
- // if previousCaller is not the current caller *only* log a warning
- if (!previousCaller.equals(caller))
- {
- log
- .warn(LogManager
- .getHeader(
- this,
- "restore_auth_sys_state",
- "Class: "
- + caller
- + " call restore but previous state change made by "
- + previousCaller));
- }
- }
- ignoreAuth = previousState.booleanValue();
- }
-
-
- /**
- * Specify whether the authorisation system should be ignored for this
- * context. This should be used sparingly.
- *
- * @deprecated use turnOffAuthorisationSystem() for make the change and
- * restoreAuthSystemState() when change are not more required
- * @param b
- * if true, authorisation should be ignored for this
- * session.
- */
- public void setIgnoreAuthorization(boolean b)
- {
- ignoreAuth = b;
- }
-
- /**
- * Set extra information that should be added to any message logged in the
- * scope of this context. An example of this might be the session ID of the
- * current Web user's session:
- * setExtraLogInfo("session_id="+request.getSession().getId());
- *
- * @param info
- * the extra information to log
- */
- public void setExtraLogInfo(String info)
- {
- extraLogInfo = info;
- }
-
- /**
- * Get extra information to be logged with message logged in the scope of
- * this context.
- *
- * @return the extra log info - guaranteed non- null
- */
- public String getExtraLogInfo()
- {
- return extraLogInfo;
- }
-
-
- /**
- * Close the context object after all of the operations performed in the
- * context have completed succesfully. Any transaction with the database is
- * committed.
- *
- * @exception SQLException
- * if there was an error completing the database transaction
- * or closing the connection
- */
- public void complete() throws SQLException
- {
- // FIXME: Might be good not to do a commit() if nothing has actually
- // been written using this connection
- try
- {
- // Commit any changes made as part of the transaction
- commit();
- }
- finally
- {
- // Free the connection
- DatabaseManager.freeConnection(connection);
- connection = null;
- }
- }
-
- /**
- * Commit any transaction that is currently in progress, but do not close
- * the context.
- *
- * @exception SQLException
- * if there was an error completing the database transaction
- * or closing the connection
- */
- public void commit() throws SQLException {
- // Commit any changes made as part of the transaction
- Dispatcher dispatcher = null;
-
- try
- {
- if (events != null)
- {
-
- if (dispName == null)
- {
- dispName = EventManager.DEFAULT_DISPATCHER;
- }
-
- dispatcher = EventManager.getDispatcher(dispName);
- connection.commit();
- dispatcher.dispatch(this);
- }
- else
- {
- connection.commit();
- }
-
- }
- finally
- {
- events = null;
- if(dispatcher != null)
- {
- EventManager.returnDispatcher(dispName, dispatcher);
- }
- }
-
- }
-
- /**
- * Select an event dispatcher, null selects the default
- *
- */
- public void setDispatcher(String dispatcher)
- {
- if (log.isDebugEnabled())
- {
- log.debug(this.toString() + ": setDispatcher(\"" + dispatcher + "\")");
- }
- dispName = dispatcher;
- }
-
- /**
- * Add an event to be dispatched when this context is committed.
- *
- * @param event
- */
- public void addEvent(Event event)
- {
- if (events == null)
- {
- events = new ArrayListfalse if this
- * context has been aborted or completed.
- *
- * @return true if the context is still valid, otherwise
- * false
- */
- public boolean isValid()
- {
- // Only return true if our DB connection is live
- return (connection != null);
- }
-
- /**
- * Store an object in the object cache.
- *
- * @param objectClass
- * Java Class of object to check for in cache
- * @param id
- * ID of object in cache
- *
- * @return the object from the cache, or null if it's not
- * cached.
- */
- public Object fromCache(Class objectClass, int id)
- {
- String key = objectClass.getName() + id;
-
- return objectCache.get(key);
- }
-
- /**
- * Store an object in the object cache.
- *
- * @param o
- * the object to store
- * @param id
- * the object's ID
- */
- public void cache(Object o, int id)
- {
- String key = o.getClass().getName() + id;
- objectCache.put(key, o);
- }
-
- /**
- * Remove an object from the object cache.
- *
- * @param o
- * the object to remove
- * @param id
- * the object's ID
- */
- public void removeCached(Object o, int id)
- {
- String key = o.getClass().getName() + id;
- objectCache.remove(key);
- }
-
- /**
- * Remove all the objects from the object cache
- */
- public void clearCache()
- {
- objectCache.clear();
- }
-
- /**
- * Get the count of cached objects, which you can use to instrument
- * an application to track whether it is "leaking" heap space by
- * letting cached objects build up. We recommend logging a cache
- * count periodically or episodically at the INFO or DEBUG level,
- * but ONLY when you are diagnosing cache leaks.
- * @return count of entries in the cache.
- *
- * @return the number of items in the cache
- */
- public int getCacheSize()
- {
- return objectCache.size();
- }
-
- /**
- * set membership in a special group
- *
- * @param groupID
- * special group's ID
- */
- public void setSpecialGroup(int groupID)
- {
- specialGroups.add(new Integer(groupID));
-
- // System.out.println("Added " + groupID);
- }
-
- /**
- * test if member of special group
- *
- * @param groupID
- * ID of special group to test
- * @return true if member
- */
- public boolean inSpecialGroup(int groupID)
- {
- if (specialGroups.contains(new Integer(groupID)))
- {
- // System.out.println("Contains " + groupID);
- return true;
- }
-
- return false;
- }
-
- /**
- * gets an array of all of the special groups that current user is a member
- * of
- *
- * @return
- * @throws SQLException
- */
- public Group[] getSpecialGroups() throws SQLException
- {
- List myGroups = new ArrayList();
-
- Iterator i = specialGroups.iterator();
-
- while (i.hasNext())
- {
- myGroups.add(Group.find(this, ((Integer) i.next()).intValue()));
- }
-
- return (Group[]) myGroups.toArray(new Group[0]);
- }
-
- protected void finalize()
- {
- /*
- * If a context is garbage-collected, we roll back and free up the
- * database connection if there is one.
- */
- if (connection != null)
- {
- abort();
- }
- }
-}