/* ======================================================================
The Bodington System Software License, Version 1.0
Copyright (c) 2001 The University of Leeds. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any,
must include the following acknowledgement: "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)." Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.
4. The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.
5. The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, TITLE, THE IMPLIED WARRANTIES
OF QUALITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
=========================================================
This software was originally created by the University of Leeds and may contain voluntary
contributions from others. For more information on the Bodington Open Source Project, please
see http://bodington.org/
====================================================================== */
package org.bodington.servlet.facilities;
import java.util.logging.*;
import org.bodington.servlet.*;
import java.awt.Color;
import java.awt.color.*;
import java.rmi.RemoteException;
import java.lang.reflect.InvocationTargetException;
import java.math.*;
import java.io.*;
import java.util.*;
import java.util.zip.*;
import java.text.*;
import java.sql.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.net.URLEncoder;
import java.net.URL;
import java.net.HttpURLConnection;
//import java.security.*;
import java.security.cert.*;
import java.security.spec.*;
import java.math.BigInteger;
import javax.security.auth.x500.X500Principal;
import org.bodington.database.*;
import org.bodington.server.*;
import org.bodington.server.events.*;
import org.bodington.server.realm.*;
import org.bodington.server.realm.User;
import org.bodington.server.resources.*;
import org.bodington.servlet.*;
import org.bodington.servlet.template.GifTemplateProcessor;
import org.bodington.servlet.template.GifColourStatement;
import org.bodington.text.*;
import org.bodington.sqldatabase.SqlDatabase;
import org.bodington.servlet.template.Template;
import org.bodington.xml.XMLRepository;
import org.bodington.xml.XMLQuery;
import org.bodington.xml.XMLObjectRecord;
import org.bodington.util.ColourPreferenceMapper;
import org.bodington.util.DateFormatter;
import org.bodington.util.ResourceBundleHelper;
public class Facility extends java.lang.Object
{
static final int MAX_FILENAME_LENGTH = 48;
static final int MAX_FILE_SIZE = 10;
static final int MAX_ZIP_SIZE = 10;
private static String file_store=null;
private static String published=null;
static final int LISTSTYLE_NORMAL=0;
static final int LISTSTYLE_DELETE=1;
static final int LISTSTYLE_SID=2;
static final int LISTSTYLE_UID=3;
static final int LISTSTYLE_SURNAME=4;
static final int LISTSTYLE_MODULE=5;
Vector bigvector;
X509CertificateBuilder x509_cert_builder=null;
static boolean copy_in_progress=false;
static Object copy_synch = new Object();
//Hashtable templates;
Integer id;
public String facilityname;
//Facility deffacility;
public Facility()
{
int i;
facilityname="building";
//templates=new Hashtable();
}
public void logException( PrintWriter out, String sourceClassName, String sourceMethodName, String message, Throwable th )
{
BuildingServerException bsex=null;
if ( th instanceof BuildingServerException )
bsex = (BuildingServerException)th;
LogRecord lrec = new LogRecord( Level.SEVERE, th.getMessage() );
lrec.setSourceClassName( sourceClassName );
lrec.setSourceMethodName( sourceMethodName );
lrec.setThrown( th );
Logger.getLogger( "org.bodington" ).log( lrec );
String strdate=null;
try
{
strdate = DateFormatter.formatDate( new java.util.Date( lrec.getMillis() ), 2 );
}
catch ( IOException ioex ) {}
if ( out!=null )
{
out.println( "
" );
}
}
public String getTitle()
{
return null;
}
public String getTitle( boolean capital, boolean article )
{
return getTitle( capital, article, false );
}
public String getTitle( boolean capital, boolean article, boolean plural )
{
String t = getTitle();
if ( t==null ) return null;
StringBuffer buffer = new StringBuffer( t.length() + 4 );
char first = Character.toLowerCase( t.charAt( 0 ) );
if ( article )
{
buffer.append( capital?"A":"a" );
if ( first == 'a' || first == 'e' || first == 'i' || first == 'o' || first == 'u' )
buffer.append( "n" );
buffer.append( " " );
}
if ( capital && !article )
first = Character.toUpperCase( first );
buffer.append( first );
buffer.append( t.substring( 1 ) );
if ( plural )
buffer.append( "s" );
return buffer.toString();
}
public Resource newResource()
{
return new Resource();
}
public boolean initResource( Request breq, Resource new_resource )
throws Exception
{
return true;
}
/**
* Facility subclasses can refuse copying of resources.
* @return True if resources that use this facility can be copied.
*/
public boolean canCopy( Resource resource )
{
// if here then resource is either served by Facility or by a subclass
// that doesn't override this method.
FacilityList facilityList = FacilityList.getFacilities();
Facility facility = facilityList.get( new Integer( resource.getHttpFacilityNo() ) );
// if resource is served by Facility itself then allow copy
if ( facility instanceof Facility )
return true;
// if resource is served by subclass of Facility but that subclass doesn't
// overide this method then refuse copy operation. Subclass must override
// this method to allow copying.
return false;
}
/**
* Looks through resource children.....
* @return True if resources that use this facility can be copied.
*/
public boolean canCopyWithChildren( Resource resource )
throws BuildingServerException
{
if ( !canCopy( resource ) )
return false;
if ( !resource.checkPermission( Permission.MANAGE ) )
return false;
FacilityList facilityList = FacilityList.getFacilities();
Facility facility = null;
Resource child;
Enumeration enum = resource.findChildren();
while ( enum.hasMoreElements() )
{
child = (Resource)enum.nextElement();
facility = facilityList.get( new Integer( child.getHttpFacilityNo() ) );
if ( !facility.canCopyWithChildren( child ) )
return false;
}
return true;
}
/**
* Use the properties of an existing Resource to initialise a newly created Resource.
* (WebLearn modification (method added): 02/12/2003 Colin Tatham)
* @param original The resource with properties to copy.
* @param new_resource The resource to initialise.
* @return True if initialisation was OK.
* @exception BuildingServerException Thrown if there is any problem initialising the resource.
*
*/
public boolean initResource( Resource original, Resource new_resource)
throws BuildingServerException
{
//default init routine does nothing but
//other facilities can check/copy specific properties.
return true;
}
/**
*
* Copy the authored content of an existing Resource to another Resource.
* (WebLearn modification (method added): 02/12/2003 Colin Tatham)
* @param original The resource with content to copy.
* @param new_resource The resource to copy content to.
* @param breq The building HTTP request, which is used to determine which type of content to copy.
* @exception BuildingServerException Thrown if there is any problem copying the resource content.
*
*/
public void copyContent( Resource original, Resource new_resource, Request breq )
throws BuildingServerException
{
//default routine does nothing but
//other facilities can copy specific content.
}
public void userevent( Request req, PrintWriter out )
throws IOException
{
String user_message, notify;
user_message=req.getParameter( "user_message" );
if ( user_message!=null )
user_message = user_message.trim();
if ( user_message==null || user_message.length()==0 )
{
out.println( "You have to enter a message to generate an event." );
return;
}
if ( user_message.length()>250 )
{
user_message = user_message.substring( 0, 250 );
out.println( "
Your message will be truncated because it is too long.
" );
}
}
if ( command.equalsIgnoreCase( "perftest" ) )
{
rt=Runtime.getRuntime();
if ( out!=null )
{
out.println( "
Runtime Total Memory: " + rt.totalMemory() );
out.println( "Runtime Free Memory: " + rt.freeMemory() );
out.print( "Start 1 million sin( rand() ): " );
DateFormatter.outputDate( out, new java.util.Date(), 0 );
out.println( "" );
out.flush();
}
for ( int i=0; i<1000000; i++ )
Math.cos( Math.random() );
if ( out!=null )
{
out.print( " End: " );
DateFormatter.outputDate( out, new java.util.Date(), 0 );
out.println( "
" );
}
return;
}
if ( command.equalsIgnoreCase( "CREATE" ) )
{
if ( out!=null )
createconfirm( req, out, insertname );
return;
}
if ( command.equalsIgnoreCase( "modify" ) )
{
if ( out!=null )
confirmmodify( req, out );
return;
}
if ( command.equalsIgnoreCase( "MOVE" ) )
{
if ( out!=null )
moveconfirm( req, out );
return;
}
if ( command.equalsIgnoreCase( "copy" ) )
{
if ( out!=null )
copyconfirm( req, out );
return;
}
if ( command.equalsIgnoreCase( "delete" ) )
{
if ( out!=null )
deleteconfirm( req, out );
return;
}
if ( command.equalsIgnoreCase( "VARIABLE" ) )
{
if ( out!=null )
variable( req, out, insertname, false );
return;
}
if ( command.equalsIgnoreCase( "VARIABLEF" ) )
{
if ( out!=null )
variable( req, out, insertname, true );
return;
}
if ( command.equalsIgnoreCase( "NAVIGATION" ) )
{
if ( out!=null )
{
navigation( req, out, insertname );
}
return;
}
if ( command.equalsIgnoreCase( "resourcemenu" ) )
{
if ( out!=null )
{
resourceMenu( req, out );
}
return;
}
if ( command.equalsIgnoreCase( "stylesheet" ) )
{
if ( out!=null )
stylesheet( req, out );
return;
}
/*
if ( command.equalsIgnoreCase( "NOTIFYFORM" ) )
{
if ( out!=null )
notifyform( req, out );
return;
}
if ( command.equalsIgnoreCase( "CONFIRMNOTIFY" ) )
{
if ( out!=null )
confirmnotify( req, out );
return;
}
*/
if ( command.equalsIgnoreCase( "userevent" ) )
{
if ( out!=null )
userevent( req, out );
return;
}
if ( command.equalsIgnoreCase( "eventlog" ) )
{
if ( out!=null )
eventlog( req, out );
return;
}
/*
if ( command.equalsIgnoreCase("templateeditform") )
{
if ( out!=null )
templateeditform( req, out, insertname );
return;
}
if ( command.equalsIgnoreCase("templateeditconfirm") )
{
if ( out!=null )
templateeditconfirm( req, out );
return;
}
*/
if ( command.equalsIgnoreCase("reorder") )
{
if ( out!=null )
reorder( req, out );
return;
}
if ( command.equalsIgnoreCase("reordercontrol") )
{
if ( out!=null )
reordercontrol( req, out );
return;
}
if ( command.equalsIgnoreCase( "ifcanreorder" ) )
{
ifcanreorder( req );
return;
}
if ( command.equalsIgnoreCase( "ifloggedin" ) )
{
ifloggedin( req );
return;
}
if ( command.equalsIgnoreCase( "IFACCESS" ) )
{
ifaccess( req, insertname );
return;
}
if ( command.equalsIgnoreCase( "ELSE" ) )
{
req.setSwitchedOff( !req.isSwitchedOff() );
return;
}
if ( command.equalsIgnoreCase( "ENDIF" ) )
{
req.setSwitchedOff( false );
return;
}
if ( command.equalsIgnoreCase( "parentaclform" ) )
{
if ( out!=null )
parentaclform( req, out );
return;
}
if ( command.equalsIgnoreCase( "acl" ) )
{
if ( out!=null )
acl( req, out );
return;
}
if ( command.equalsIgnoreCase( "aclentry" ) )
{
if ( out!=null )
aclentry( req, out );
return;
}
if ( command.equalsIgnoreCase( "addaclentry" ) )
{
if ( out!=null )
addaclentry( req, out );
return;
}
if ( command.equalsIgnoreCase( "accessoperation" ) )
{
if ( out!=null )
accessoperation( req, out );
return;
}
if ( command.equalsIgnoreCase( "groupmenu" ) )
{
if ( out!=null )
groupmenu( req, out );
return;
}
if ( command.equalsIgnoreCase( "groupoperation" ) )
{
if ( out!=null )
groupoperation( req, out );
return;
}
if ( command.equalsIgnoreCase( "rawfileindex" ) )
{
if ( out!=null )
{
rawfileindex( req, out );
}
return;
}
if ( command.equalsIgnoreCase( "fileindex" ) )
{
if ( out!=null )
{
boolean show_root = req.getInsertAttribute( "root", "no" ).equalsIgnoreCase( "yes" );
boolean hide_deleted = req.getInsertAttribute( "hidedeleted", "yes" ).equalsIgnoreCase( "yes" );
int link_type = 0;
if ( req.getInsertAttribute( "link", "download" ).equalsIgnoreCase( "info" ) )
link_type=1;
fileindex( req, out, null, show_root, hide_deleted, link_type );
}
return;
}
if ( command.equalsIgnoreCase( "fileinfo" ) )
{
if ( out!=null )
fileinfo( req, out );
return;
}
if ( command.equalsIgnoreCase( "filerename" ) )
{
if ( out!=null )
filerename( req, out );
return;
}
if ( command.equalsIgnoreCase( "fileisdeleted" ) )
{
req.setSwitchedOff( !fileisdeleted( req ) );
return;
}
if ( command.equalsIgnoreCase( "foldercreate" ) )
{
if ( out!=null )
foldercreate( req, out );
return;
}
if ( command.equalsIgnoreCase( "upload" ) )
{
if ( out!=null )
upload( req, out, (insertname!=null && insertname.equalsIgnoreCase( "raw" ) ) );
return;
}
if ( command.equalsIgnoreCase( "uploadzip" ) )
{
if ( out!=null )
uploadzip( req, out );
return;
}
if ( command.equalsIgnoreCase( "bytesuploaded" ) )
{
if ( out!=null )
bytesuploaded( req, out );
return;
}
if ( command.equalsIgnoreCase( "filedelete" ) )
{
if ( out!=null )
filedelete( req, out, true );
return;
}
if ( command.equalsIgnoreCase( "fileundelete" ) )
{
if ( out!=null )
filedelete( req, out, false );
return;
}
if ( command.equalsIgnoreCase( "metadata" ) )
{
if ( out!=null )
metadata( req, out );
return;
}
if ( command.equalsIgnoreCase( "metadataupload" ) )
{
if ( out!=null )
metadataupload( req, out );
return;
}
if ( command.equalsIgnoreCase( "metadatasearch" ) )
{
if ( out!=null )
metadatasearch( req, out );
return;
}
if ( command.equalsIgnoreCase( "importresource" ) )
{
if ( out!=null )
importresource( req, out, insertname );
return;
}
if ( command.equalsIgnoreCase( "generatemanifest" ) )
{
if ( out!=null )
generatemanifest( req, out );
return;
}
if ( command.equalsIgnoreCase( "zonecontrol" ) )
{
if ( out!=null )
zonecontrol( req, out );
return;
}
if ( command.equalsIgnoreCase( "zoneconfirm" ) )
{
if ( out!=null )
zoneconfirm( req, out );
return;
}
// uhi:awc: added insert command to return username
if ( command.equalsIgnoreCase( "username" ) )
{
if ( out!=null )
{
String username = getUsername(req);
if ( username == null )
username = "anonymous";
out.print( username );
}
return;
}
// uhi:awc: added insert command to return url with username appended to query - url supplied by insertname
if ( command.equalsIgnoreCase( "usernameloginurl" ) )
{
if ( out!=null )
{
String loginUrl = getUsernameLoginUrl(req, insertname);
out.print( loginUrl );
}
return;
}
/*
* WebLearn inserted code; A Corfield 02/12/2003.
*/
if (command.equalsIgnoreCase("releasedate")) {
if (out != null)
releaseDate(req, out, insertname);
return;
}
/*
* WebLearn inserted code; A Corfield 02/12/2003.
*/
if ( command.equalsIgnoreCase( "fileparse" ) )
{
// not yet implemented
if ( out!=null )
out.println("
Sorry, parsing bodington links in html files is not yet available!
");
// check mime type - must be html
// fileparse( req, out );
return;
}
if ( out!=null )
out.println( "\n" );
}
private java.util.Random random = new java.util.Random();
public boolean test( Request req, HttpServletResponse res, String op )
throws ServletException, IOException
{
//String op = req.getInsertAttribute( "command", "" );
if ( "random".equals( op ) )
{
return random.nextBoolean();
}
throw new ServletException( "Unknown test command." );
}
public void header( Request req, HttpServletResponse res )
throws ServletException, IOException
{
String op = req.getInsertAttribute( "name", "" );
}
public boolean isMatchingUserAgent( Request request, String regex )
throws ServletException
{
String agent = request.getHeader( "user-agent" );
if ( regex == null || agent == null )
return false;
try
{
java.util.regex.Pattern p = java.util.regex.Pattern.compile( regex );
java.util.regex.Matcher m = p.matcher( agent );
return m.matches();
}
catch ( Exception e )
{
Logger.getLogger( "org.bodington" ).logp(
Level.SEVERE,
"Facility",
"isMatchingUserAgent",
e.getMessage(),
e );
throw new ServletException( e.getMessage() );
}
}
// Just print out the url of the original link - based on loginOriginalLink
// Weblearn: Added by Paul T 11/05/04
public void loginOriginalLinkUrlOnly ( Request req, PrintWriter out, String label )
{
String original_path = loginEntryPath( req );
out.print( original_path );
}
// end addition by Paul T
public void loginSendAuthenticationChallenge( Response response )
{
response.setStatus( response.SC_UNAUTHORIZED );
response.setHeader( "WWW-authenticate", "Basic realm=\"Bodington Web Site\"" );
}
private String loginEntryPath( Request request )
{
// look for a form field first
String original_path = request.getParameter( "org_bodington_servlet_entry_path" );
if ( original_path!=null && original_path.length()>0 )
return original_path;
// then see if it is set in the session object
org.bodington.servlet.HttpSession session =
(org.bodington.servlet.HttpSession)request.getSession( false );
if ( session != null )
{
original_path = (String)session.getAttribute( "org.bodington.servlet.entry_path" );
if ( original_path != null )
return original_path;
}
// otherwise use the requested URL
StringBuffer path = new StringBuffer();
path.append( "http" );
if ( request.isSecure() )
path.append( "s" );
path.append( "://" );
path.append( request.getServerName() );
if ( (request.isSecure() && request.getServerPort() != 443) ||
(!request.isSecure() && request.getServerPort() != 80) )
{
path.append( ":" );
path.append( request.getServerPort() );
}
String uri = request.getRequestURI();
// if someone actually tried to link to a login page
// change the link to the site entrance
if ( uri.indexOf( "bs_template_login_" ) >=0 )
{
path.append( request.getContextPath() );
path.append( request.getServletPath() );
path.append( "/" );
}
else
{
path.append( uri );
String query = request.getQueryString();
if ( query!=null && query.length()>0 )
{
path.append( '?' );
path.append( query );
}
}
return path.toString();
}
public void loginInitCookie( Request request, Response response )
{
// send a cookie for a new session regardless
// of whether any cookie was received from user
// this should only be called from the first login page.
// get a (possibly new) session
org.bodington.servlet.HttpSession session = (org.bodington.servlet.HttpSession)request.getSession( true );
// make a record in it of the entry URL
String entry_path = loginEntryPath( request );
session.setAttribute( "org.bodington.servlet.entry_path", entry_path );
// create a new cookie (although it may end up identical to
// one sent a previous time.)
Cookie session_cookie = new Cookie( Request.SESSION_ID_COOKIE_NAME, session.getId() );
String cookie_path = request.getContextPath();
// Mozilla and derived browsers don't like empty cookie path and will assume
// wrongly that cookie path matches request path. So, fix path if the Bodington
// web app is at the root of the server
if ( cookie_path.length() == 0 )
cookie_path = "/";
session_cookie.setPath( cookie_path );
// send the cookie to the user
response.addCookie( session_cookie );
// if this cookie is returned by client it will be processed when
// the next page request is initialised in
// org.bodington.servlet.Request.initSession
}
public boolean loginHasCookie( Request request )
{
Cookie[] cookies = request.getCookies();
Cookie session_id_cookie = null;
for ( int i=0; cookies!=null && i< cookies.length; i++ )
if ( cookies[i].getName().equals( Request.SESSION_ID_COOKIE_NAME ) )
session_id_cookie = cookies[i];
return session_id_cookie != null;
}
public void loginShowPathField( Request req, PrintWriter out )
throws IOException
{
String original_path = loginEntryPath( req );
out.print( "0 )
out.print( original_path );
else
{
StringBuffer path = new StringBuffer();
path.append( "http" );
if ( req.isSecure() )
path.append( "s" );
path.append( "://" );
path.append( req.getServerName() );
if ( (req.isSecure() && req.getServerPort() != 443) ||
(!req.isSecure() && req.getServerPort() != 80) )
{
path.append( ":" );
path.append( req.getServerPort() );
}
// if someone actually tried to link to a login page or if the
// form data was lost somehow change the link to the site entrance
if ( req.getPageName()!=null && req.getPageName().startsWith( "login_" ) )
{
path.append( req.getContextPath() );
path.append( req.getServletPath() );
path.append( "/" );
}
else
path.append( req.getRequestURI() );
out.print( path );
}
out.println( "\">" );
}
public void loginShowFormTag( Request req, PrintWriter out, String protocol, String action )
{
// target="_top" ensures that following login page fills window
// may be important if user ends up in sub frame by accident when they
// log in.
out.print( "" );
for ( i=0; i" );
}
return;
}
catch ( Exception ex )
{
out.println( "
" + ex + "
" );
return;
}
}
private void accessoperation( Request breq, PrintWriter out )
throws IOException
{
String op=breq.getParameter( "operation" );
if ( op==null ) return;
op=op.trim();
if ( op.length()==0 ) return;
if ( op.equalsIgnoreCase( "parentacl" ) )
{
out.println( "
" );
out.println( "
" );
out.println( "Change to use of containing location: " );
String str = breq.getParameter( "parentacl" );
try
{
breq.getResource().setUseParentAcl( str!=null && str.equalsIgnoreCase( "yes" ) );
breq.getResource().save();
out.println( "CONFIRMED" );
}
catch ( BuildingServerException bsex )
{
out.println( "Technical problem trying to save option change: " + bsex.toString() );
}
out.println( ".
" + acl.toString() );
AclEntry aclentry;
aclentry=acl.getAclEntry( group_id, false );
if ( aclentry==null )
{
out.println( "The selected access control entry no longer exists." );
return;
}
is_owners = aclentry.getGroup().getName().equals(
"localgroup." + resource.getResourceId() + ".owners" );
if ( is_owners )
{
out.println( "You can't remove the owners group from the access control." );
return;
}
acl.removeEntry( aclentry );
acl.save();
out.println( " CONFIRMED." );
return;
}
catch ( Exception ex )
{
out.println( " Problem:
" + ex + "
" );
return;
}
}
private void groupmenu( Request breq, PrintWriter out )
throws IOException
{
boolean is_owners, is_local;
String g, name, gname;
PrimaryKey group_id;
org.bodington.server.realm.Group group;
g=breq.getParameter( "group_id" );
if ( g==null )
{
out.println( "Problem: no group_id was specified." );
return;
}
try
{
group_id = new PrimaryKey( Integer.parseInt( g ) );
}
catch ( NumberFormatException nfex )
{
out.println( "Problem: invalid group_id was specified." );
return;
}
if ( !breq.isAuthenticated() )
{
out.println( "You haven't checked in to the building so you can't work with this group." );
return;
}
try
{
group = org.bodington.server.realm.Group.findGroup( group_id );
if ( group==null )
{
out.println( "Problem: the specified group wasn't found." );
return;
}
//There will be more access checking on the groups when
//the user tries to edit them.
if ( !group.checkPermission( Permission.forName( "see" ) ) )
{
out.println( "You lack the see access right for this group." );
return;
}
out.println( "
You can select the " );
out.println( "group in your access control lists" );
if ( group.checkPermission( Permission.forName( "view" ) ) )
out.println( ", list membership of the group" );
if ( group.checkPermission( Permission.forName( "edit" ) ) )
out.println( ", edit membership of the group" );
if ( group.checkPermission( Permission.forName( "manage" ) ) )
out.println( ", control the rights of others to access the group" );
out.println( ".
\n" );
return;
}
}
// Puts in a table and form input fields for searching for users.
// Doesn't put in
public void userSearchFields( Request breq, PrintWriter out, boolean withGroups, boolean withOutputOpts )
throws IOException
{
int i;
Group group;
User user;
user=(User)BuildingContext.getContext().getUser();
try
{
out.println( "
" );
}
catch ( BuildingServerException bsex )
{
out.println( "Technical error trying to produce form: " );
logException( out, "Facility", "userSearchFields",
"Technical error trying to produce form: ",
bsex );
}
}
/**
* Creates a table and form input fields for searching for users.
* Groups are sorted by the various nodes so that it loads quickly.
* Method derived from {@link #addaclentry(Request, PrintWriter)}.
* (WebLearn; A Corfield 02/12/2003)
*/
private void userSearchFields( Request breq, PrintWriter out, PrimaryKey group_id, boolean withGroups, boolean withOutputOpts )
throws IOException
{
int i;
Group group;
User user;
String gname;
user=(User)BuildingContext.getContext().getUser();
try
{
out.println( "
" );
out.println( "
Find Users
" );
if ( withGroups )
{
if (!breq.isAuthenticated()) {
out.println("
You haven't checked in to the building so you can't change access rights.
");
return;
}
if (!BuildingContext.getContext().checkPermission("manage")) {
out.println(
"
You need manage access rights to view access rights.
");
return;
}
String base = breq.getParameter("category");
if (base == null)
base = "*";
base = base.trim();
if (!base.endsWith("*"))
base = null;
else
base = base.substring(0, base.length() - 1);
try {
Resource resource = breq.getResource();
org.bodington.server.realm.Acl acl = resource.getAcl();
//out.println( "
" + acl.toString() );
//Enumeration enum = acl.entries();
AclEntry aclentry;
Vector groups = new Vector();
Vector headings = new Vector();
Enumeration enum;
if (base == null || base.length() == 0) {
enum = org.bodington.server.realm.Group.findGroups(
"name LIKE 'localgroup." + resource.getResourceId() + ".%'", "name");
while (enum.hasMoreElements())
groups.addElement(enum.nextElement());
}
if (base == null || base.length() == 0)
enum = org.bodington.server.realm.Group.findGroups(
"name NOT LIKE 'localgroup.%'", "name");
else
enum = org.bodington.server.realm.Group.findGroups(
"name LIKE '" + base + "%'", "name");
String name;
int dot_offset;
while (enum.hasMoreElements()) {
if (base == null)
groups.addElement(enum.nextElement());
else {
group = (org.bodington.server.realm.Group) enum.nextElement();
name = group.getName();
if (!name.startsWith(base))
continue;
dot_offset = name.indexOf('.', base.length());
if (dot_offset < 0 ||
(base.length() == 0 && name.startsWith("localgroup.")))
groups.addElement(group);
else {
name = base + name.substring(base.length(), dot_offset) + ".*";
if (!headings.contains(name))
headings.addElement(name);
}
}
}
out.println("
Search within group:
");
out.print("
");
out.println("
");
out.println("
");
}
catch (Exception ex) {
out.println("
" + ex + "
");
return;
}
}
else {
out.println("");
}
catch (BuildingServerException bsex) {
out.println("Technical error trying to produce form: ");
logException(out, "Facility", "userSearchFields",
"Technical error trying to produce form: ",
bsex);
}
}
public boolean createCheck( Request breq, PrintWriter out )
{
//default creation does nothing but other facilities can
//check user input print errors and prevent resource creation
//by returning false.
return true;
}
public boolean create( Request breq, Connection con, Resource new_resource )
throws Exception
{
//default creation routine does nothing but
//other facilities can do more setting up
//if it goes wrong returning false will roll
//back all database transactions including the
//generic ones.
return true;
}
private void createconfirm( Request breq, PrintWriter out, String name )
throws IOException
{
FacilityList fl;
Facility f;
Connection con=null;
Group group;
String notify=null;
ResourceTree tree=null;
Resource new_resource=null;
boolean completed=false;
BuildingContext context = BuildingContext.getContext();
if ( !BuildingContext.getContext().checkPermission( "create" ) )
{
out.println( "
You don't have permission to create resources here.
\n" );
return;
}
// if ( !name.equalsIgnoreCase( "communication" ) )
// {
// out.println( "Unable to create requested type of facility." );
// return;
// }
if ( !breq.isAuthenticated() )
{
out.println( "Problem finding user." );
return;
}
fl=FacilityList.getFacilities();
if ( fl==null )
{
out.println( "Problem finding facilities." );
return;
}
f=fl.get( name );
if ( f==null )
{
out.println( "Unable to create this type of resource." );
return;
}
try
{
String url, title, description, introduction, str;
boolean parentacl;
url=breq.getParameter( "url" );
if ( url == null || url.length()<1 )
{
out.println( "Unable to create new location - you must supply a name." );
out.println( "Please use the backtrack facility of your browser to return to the form." );
return;
}
if ( url.length()>12 )
{
out.println( "Unable to create new location - name is more than 12 characters." );
out.println( "Please use the backtrack facility of your browser to return to the form." );
return;
}
if (url.charAt(0) == '_')
{
out.println("The first character of the resource name cannot be an underscore");
out.println( "Please use the backtrack facility of your browser to return to the form." );
return;
}
for ( int i=0; i='0' && c<='9' )
continue;
if ( c>='a' && c<='z' )
continue;
if ( c != '_' )
{
out.println( "Unable to create new location - the name contains invalid characters." );
out.println( "Please use the backtrack facility of your browser to return to the form." );
return;
}
}
title=breq.getParameter( "title" );
description=breq.getParameter( "description" );
introduction=breq.getParameter( "introduction" );
notify=breq.getParameter( "notify" );
if ( title==null || description==null || introduction==null )
{
out.println( "Unable to create new location - one or more of the boxes was left blank." );
out.println( "Please use the backtrack facility of your browser to return to the form." );
return;
}
title=title.trim();
description=description.trim();
introduction=introduction.trim();
if ( title.length()==0 || description.length()==0 || introduction.length()==0 )
{
out.println( "Unable to create new location - one or more of the boxes was left blank." );
out.println( "Please use the backtrack facility of your browser to return to the form." );
return;
}
str = breq.getParameter( "parentacl" );
parentacl = str!=null && str.equalsIgnoreCase( "yes" );
if ( !f.createCheck( breq, out ) )
{
out.println( " Please use the backtrack facility of your browser to return to the form." );
return;
}
Enumeration enum = breq.getResource().findChildren();
Resource child;
while ( enum.hasMoreElements() )
{
child = (Resource) enum.nextElement();
if ( child.getName().equals( url ) )
{
out.println( "Unable to create new location - an item already exists here with the a name the same as the one you specified for the new item." );
out.println( " Please use the backtrack facility of your browser to return to the form." );
return;
}
}
//do general location creation stuff
tree = ResourceTree.getInstance();
synchronized ( tree )
{
new_resource=f.newResource();
new_resource.setName( url );
new_resource.setTitle( title );
new_resource.setDescription( description );
new_resource.setIntroduction( introduction );
new_resource.setHttpFacilityNo( f.id.intValue() );
new_resource.setUseParentAcl( parentacl );
if ( !f.initResource( breq, new_resource ) )
{
out.println( "Unable to initialise new resource." );
out.println( " Please use the backtrack facility of your browser to return to the form and try again." );
return;
}
con=context.getConnection();
//may need to rollback after several
//operations
con.setAutoCommit( false );
tree.addResource( breq.getResource(), new_resource );
//tree.updateIndices();
//tree.saveAll();
//specific creation stuff
if ( !f.create( breq, con, new_resource ) )
{
out.println( "Unable to create supporting data for new resource." );
throw new BuildingServerException( "Problem creating resource specific data in database." );
}
con.commit();
completed=true;
out.println( "
New resource created O.K.
" );
con.setAutoCommit( true );
}
// mustn't attempt to get a session inside the synchronized section because
// this could cause deadlock.
// create metadata record
try
{
BuildingSession session = BuildingSessionManagerImpl.getSession( new_resource );
session.updateBasicMetadata( title, description );
}
catch ( BuildingServerException bsex )
{
logException( out, "Facility", "createConfirm",
"Unable to save the associated metadata for the newly created item.",
bsex );
}
}
catch ( Exception ex )
{
out.println( "Unable to create resource." + ex );
logException( out, "Facility", "createConfirm",
"Unable to create resource.",
ex );
//just drop through;
}
if ( !completed )
{
try
{
if ( tree!=null && new_resource!=null )
{
tree.removeResource( new_resource );
//tree.updateIndices();
//tree.saveAll();
}
}
catch ( Exception ex )
{
out.println( "A problem occured cleaning up after the failure to create the resource. " +
"A 'phantom' resource may appear in the list of resources." + ex );
//just drop through;
}
try
{
if ( con!=null )
con.rollback();
}
catch ( SQLException sqlex )
{
out.println( "Unable to roll back database operations." + sqlex );
//just drop through;
}
}
}
private void confirmmodify( Request breq, PrintWriter out )
throws IOException
{
int n;
//Connection con=null;
//Statement statement;
Resource resource, parent, otherresource;
ResourceTree tree;
String serv, sql;
if ( breq.getTemplateParameterCount() > 0 )
{
out.println( "The resource was NOT modified because the web address of the 'modify resource' " +
"page you came from is invalid. This may have happened because you already changed " +
"the resource and you backtracked to an out-of-date page. Please use the navigation " +
"bar to exit from here and review what changes have been made." );
return;
}
if ( !BuildingContext.getContext().checkPermission( "manage" ) )
{
out.println( "
You don't have permission to modify this location.
\n" );
return;
}
if ( !breq.isAuthenticated() )
{
out.println( "Problem finding user." );
return;
}
try
{
resource = BuildingContext.getContext().getResource();
tree = ResourceTree.getInstance();
String url, title, description, introduction;
url=breq.getParameter( "url" );
if ( url==null ) url="";
else url=url.trim();
if ( url.length()<1 )
{
out.println( "Unable to modify location - you must supply a name." );
return;
}
if ( url.length()>12 )
{
out.println( "Unable to modify location - name is more than 12 characters." );
return;
}
for ( int i=0; i='0' && c<='9' )
continue;
if ( c>='a' && c<='z' )
continue;
if ( c != '_' )
{
out.println( "Unable to modify location - the name contains invalid characters." );
return;
}
}
//test new url to see if it exists
parent = resource.getParent();
if ( parent!=null )
{
String new_full_name = parent.getFullName() + url + "/";
otherresource = tree.findResource( new_full_name );
if ( otherresource!=null && otherresource!=resource )
{
out.println( "Unable to modify location - the name is already in use." );
return;
}
}
title=breq.getParameter( "title" ).trim();
description=breq.getParameter( "description" ).trim();
introduction=breq.getParameter( "introduction" ).trim();
if ( title.length()==0 || description.length()==0 || introduction.length()==0 )
{
out.println( "Unable to modify location - there must be text for title, description and introduction." );
return;
}
resource.setName( url );
resource.setTitle( title );
resource.setIntroduction( introduction );
resource.setDescription( description );
resource.save();
// modify metadata record
try
{
BuildingSession session = BuildingSessionManagerImpl.getSession( breq.getResource() );
session.updateBasicMetadata( title, description );
}
catch ( BuildingServerException bsex )
{
logException( out, "Facility", "confirmmodify",
"Unable to save the metadata: " +bsex.getMessage(),
bsex );
}
out.print(
"
Location modified O.K. The pages " +
"you are looking at may not reflect the new URL of the " +
" location. To be safe select this link to reload all frames.
" );
return;
}
catch ( BuildingServerException bex )
{
out.println( "Unable to modify resource due to technical problem." );
}
catch ( NumberFormatException nfex )
{
out.println( "Unable to modify resource due to invalid ordinal." );
}
/*
try
{
if ( con!=null )
con.rollback();
}
catch ( SQLException sqlex )
{
out.println( "Unable to roll back edits." + sqlex );
//just drop through;
}
*/
}
/**
* Gets and sets release date properties and fields for this resource via the insert method.
Unable to modify resource due to technical problem - resource not found");
return;
}
if (name.equalsIgnoreCase("open_field")) {
openDate = resource.getOpenDate();
if (openDate == null)
open_date = "none";
else
open_date = org.bodington.util.DateFormatter.formatDate(openDate, 2);
out.print("");
return;
}
if (name.equalsIgnoreCase("close_field")) {
closeDate = resource.getCloseDate();
if (closeDate == null)
close_date = "none";
else
close_date = org.bodington.util.DateFormatter.formatDate(closeDate, 2);
out.print("");
return;
}
if (name.equalsIgnoreCase("set")) {
if (!BuildingContext.getContext().checkPermission("manage")) {
out.println(
"
You don't have permission to modify this location.
\n");
return;
}
if (!breq.isAuthenticated()) {
out.println("Problem finding user.");
return;
}
try {
boolean openOk = false, closeOk = false;
java.sql.Timestamp openTimestamp = null, closeTimestamp = null;
open_date = breq.getParameter("open_date");
if (open_date != null && open_date.length() > 0) {
open_date = open_date.trim();
if (open_date.equalsIgnoreCase("none"))
openOk = true;
else {
openDate = org.bodington.servlet.DateParser.parseDateAndTime(
open_date);
if (openDate != null) {
openTimestamp = new java.sql.Timestamp(openDate.getTime());
open_date = org.bodington.util.DateFormatter.formatDate(openDate,
2);
openOk = true;
}
}
}
close_date = breq.getParameter("close_date");
if (close_date != null && close_date.length() > 0) {
close_date = close_date.trim();
if (close_date.equalsIgnoreCase("none"))
closeOk = true;
else {
closeDate = org.bodington.servlet.DateParser.parseDateAndTime(
close_date);
if (closeDate != null) {
closeTimestamp = new java.sql.Timestamp(closeDate.getTime());
close_date = org.bodington.util.DateFormatter.formatDate(
closeDate, 2);
closeOk = true;
}
}
}
if (openTimestamp != null && closeTimestamp != null &&
closeTimestamp.compareTo(openTimestamp) < 1) {
openOk = false;
closeOk = false;
}
if (! (openOk && closeOk)) {
if (openTimestamp != null && closeTimestamp != null)
out.print("Unable to modify location - the close date and time must be later than the open date");
else
out.print("Unable to modify location - the date and time may not have been formatted corectly");
if (!openOk)
out.print(" open date: " + open_date);
if (!closeOk)
out.print(" close date: " + close_date);
out.print(" Enter the date and time as dd/mm/yy hh:mm or \"none\" if no date is set");
return;
}
resource.setOpenTimestamp(openTimestamp);
resource.setCloseTimestamp(closeTimestamp);
resource.save();
out.print(
"
Location modified O.K. Select this link to reload all frames.
");
if (openTimestamp == null && closeTimestamp == null) {
out.print(" This resource will always be available - neither an open time nor a close time has been set.");
}
else {
if (closeTimestamp == null)
out.print(" This resource will be available from " + open_date +
" - no close time has been set.");
else if (openTimestamp == null)
out.print(" This resource is available until " + close_date +
" - no open time has been set.");
else
out.print(" This resource will be available from " + open_date +
" until " + close_date + ".");
if (openTimestamp != null &&
openTimestamp.getTime() <= System.currentTimeMillis())
out.print(" N.B. The open date has already passed.");
if (closeTimestamp != null &&
closeTimestamp.getTime() <= System.currentTimeMillis())
out.print(" N.B. The close date has already passed.");
}
}
catch (BuildingServerException bex) {
out.println(
"Unable to modify resource due to technical problem.");
}
catch (NumberFormatException nfex) {
out.println("Unable to modify resource due to invalid ordinal.");
}
}
}
/*
private void notifyform( Request breq, PrintWriter out )
throws IOException
{
String sql;
ResultSet results;
if ( !breq.isAuthenticated() )
{
out.println( "You haven't checked in to the building so you can't choose notification settings." );
return;
}
UserEventLocation ueloc=new UserEventLocation( breq.string_user_id, breq.getResource().getResourceId().intValue(), 0 );
sql="SELECT id, user_id, location, detail FROM " + DBObject.schema + "user_event_locations " +
"WHERE (user_id = '" +
breq.string_user_id +
"' AND location = (" +
breq.getResource().getResourceId() +
") )";
try
{
results=db.select( sql );
if ( results!=null )
if ( results.next() )
ueloc.load( results );
out.println( "" );
}
catch ( Exception ex )
{
out.println( "There was a technical problem trying to read the current setting." + ex );
}
}
private void confirmnotify( Request breq, PrintWriter out )
throws IOException
{
String sql;
String strdetail=breq.getParameter( "detail" );
ResultSet results;
if ( !breq.isAuthenticated() )
{
out.println( "You haven't checked in to the building so you can't view notification settings." );
return;
}
UserEventLocation ueloc=new UserEventLocation( breq.string_user_id, breq.getResource().getResourceId().intValue(), 0 );
sql="SELECT id, user_id, location, detail FROM " + DBObject.schema + "user_event_locations " +
"WHERE (user_id = '" +
breq.string_user_id +
"' AND location = (" +
breq.getResource().getResourceId().intValue() +
") )";
try
{
results=db.select( sql );
if ( results!=null )
if ( results.next() )
ueloc.load( results );
if ( strdetail==null )
{
out.print( "Current setting: " );
if ( ueloc.detail==0 )
out.print( "No Notification" );
if ( ueloc.detail==1 )
out.print( "Notification of Important Events" );
if ( ueloc.detail>=2 )
out.print( "Detailed Notification" );
return;
}
ueloc.detail=Integer.parseInt( strdetail );
Connection con=db.getConnection();
con.setAutoCommit( true );
if ( ueloc.id==0 )
ueloc.insert( con );
else
ueloc.update( con );
out.print( "Notification Setting Changed." );
}
catch ( Exception ex )
{
out.println( "There was a technical problem trying to read the current setting." + ex );
}
}
*/
/*
private void templateeditform( Request breq, PrintWriter out, String link )
throws IOException
{
String sql;
ResultSet results;
String url=breq.getParameter( "url" );
if ( !breq.isAuthenticated() )
{
out.println( "You haven't checked in to the building so you can't choose notification settings." );
return;
}
if ( !BuildingContext.getContext().checkPermission( "sysadmin" ) )
{
out.println( "You need sysadmin access to edit templates." );
return;
}
if ( url==null || url.length()==0 )
{
out.println( "You need to specify the name of the template." );
return;
}
HtmlTemplate template;
try
{
template = HtmlTemplate.findHtmlTemplate(
"http_facility_no = " + breq.getResource().getHttpFacilityNo() +
" AND name = '" + url +
"' AND resource_id = " + breq.getResource().getResourceId().toString() );
if ( template==null )
template = HtmlTemplate.findHtmlTemplate(
"http_facility_no = " + breq.getResource().getHttpFacilityNo() +
" AND name = '" + url + "'" );
if ( template==null )
template = HtmlTemplate.findHtmlTemplate(
"http_facility_no = 1" +
" AND name = '" + url + "'" );
if ( template==null )
{
out.println( "The specified template wasn't found." );
return;
}
out.println( "Facility ID: " + template.getHttpFacilityNo() + " " );
out.println( "Name: " + template.getName() + " " );
if ( template.getResourceId()!=null )
out.println( "Resource ID: " + template.getResourceId() + " " );
out.print( "" );
}
catch ( BuildingServerException bsex )
{
out.println( "Technical problem fetching template" + bsex.toString() );
return;
}
}
private void templateeditconfirm( Request breq, PrintWriter out )
throws IOException
{
String sql, oldhtml;
String url=breq.getParameter( "url" );
String html=breq.getParameter( "html" );
if ( !breq.isAuthenticated() )
{
out.println( "You haven't checked in to the building so you can't choose notification settings." );
return;
}
if ( !BuildingContext.getContext().checkPermission( "sysadmin" ) )
{
out.println( "You need sysadmin access to edit templates." );
return;
}
if ( url==null || url.length()==0 )
{
out.println( "You need to specify the name of the template." );
return;
}
if ( html==null )
{
out.println( "No HTML was specified." );
return;
}
HtmlTemplate template;
try
{
template = HtmlTemplate.findHtmlTemplate(
"http_facility_no = " + breq.getResource().getHttpFacilityNo() +
" AND name = '" + url +
"' AND resource_id = " + breq.getResource().getResourceId().toString() );
if ( template==null )
template = HtmlTemplate.findHtmlTemplate(
"http_facility_no = " + breq.getResource().getHttpFacilityNo() +
" AND name = '" + url + "'" );
if ( template==null )
template = HtmlTemplate.findHtmlTemplate(
"http_facility_no = 1" +
" AND name = '" + url + "'" );
if ( template==null )
{
out.println( "The specified template wasn't found." );
return;
}
template.setString( html );
template.save();
out.print( "Template edits saved." );
}
catch ( BuildingServerException bsex )
{
out.println( "Technical problem fetching template" + bsex.toString() );
return;
}
}
*/
public boolean willAcceptFacility( Facility f )
{
return false;
}
private void moveconfirm( Request breq, PrintWriter out )
throws IOException
{
String item, dst;
Resource srcres, itemres;
int n;
Connection con=null;
ResourceTree tree;
Resource dstres;
if ( breq.getTemplateParameterCount() > 0 )
{
out.println( "The resource was NOT moved because it seems the destination resource has been " +
"changed while you were filling in the form. Please use the navigation bar to reset " +
"your view onto the location where you want to move resources." );
return;
}
try
{
tree = ResourceTree.getInstance();
dstres = BuildingContext.getContext().getResource();
Logger.getLogger("org.bodington").fine( "moveconfirm() A" );
Logger.getLogger("org.bodington").fine( "moveconfirm() A" );
item=breq.getParameter( "source" );
dst=breq.getParameter( "destination" );
if ( dst!=null )
{
out.println( "Moving objects by pushing is no longer supported." );
return;
}
if ( item==null )
{
out.println( "Item to be moved must be specified." );
return;
}
if ( !item.endsWith( "/" ) )
item= item + "/";
if ( !item.startsWith( "/" ) )
item= "/" + item;
if ( item.length() < 3 )
{
out.println( "Name too short." );
return;
}
Logger.getLogger("org.bodington").fine( "moveconfirm() B" );
itemres=tree.findResource( item );
if ( itemres==null )
{
out.println( "The item you want to move wasn't found." );
return;
}
srcres=itemres.getParent();
if ( srcres==null )
{
out.println( "The source location you specified wasn't found." );
return;
}
if ( dstres==null )
{
out.println( "The destination location you specified wasn't found." );
return;
}
// does the destination facility accept this type of facility?
// (e.g. you can't put a discussion room inside an MCQ test paper)
FacilityList fl = FacilityList.getFacilities();
Facility dstfac = fl.get( new Integer( dstres.getHttpFacilityNo() ) );
Facility itemfac = fl.get( new Integer( itemres.getHttpFacilityNo() ) );
if ( !dstfac.willAcceptFacility( itemfac ) )
{
out.println( "The destination location cannot contain the type of resource you want to move." );
return;
}
if ( !itemres.checkPermission( Permission.MANAGE ) )
{
out.println( "You don't have management permission for the item to be moved.\n" );
return;
}
if ( !dstres.checkPermission( Permission.CREATE ) )
{
out.println( "You don't have creation permission for the destination location.\n" );
return;
}
// we have to check whether dstloc is 'inside' itemloc
if ( dstres.isInside( itemres ) )
{
out.println( "The destination location you specified is inside the item being moved." );
return;
}
Enumeration enum = dstres.findChildren();
Resource child;
while ( enum.hasMoreElements() )
{
child=(Resource)enum.nextElement();
if ( child.getName().equals( itemres.getName() ) )
{
out.println( "The destination location already contains an item with the same name as the item you are trying to move." );
return;
}
}
tree.moveResource( dstres, itemres );
out.println( "The requested item was moved." );
return;
}
catch ( BuildingServerException bex )
{
out.println( "There was an unexpected problem moving the item.\n" + bex );
}
return;
}
/**
* Makes a copy of an existing Resource.
* It is possible to copy a resource to the same location as the original, and multiple copies can be made.
* If a resource already exists at the destination location with the same name as the resource to be copied,
* a number is appended to the duplicated resource name (which is truncated if necessary).
* Request parameters are used to set the number of copies to be made, and whether to copy child resources,
* access permissions, content and uploaded files.
* (WebLearn modification (method added): 02/12/2003 Colin Tatham)
* @param breq The building HTTP request, which is used to determine which type of content to copy.
* @param out A Print writer, to display messages to the user interface.
*/
private void copyconfirm( Request breq, PrintWriter out )
// throws IOException
{
if ( breq.getTemplateParameterCount() > 0 )
{
out.println( "
The resource was NOT copied because it seems the destination resource has been " +
"changed while you were filling in the form. Please use the navigation bar to reset " +
"your view onto the location where you want to copy resources." );
return;
}
if ( copy_in_progress )
{
out.println( "
A copy operation is in progress on this web site and another cannot be started until it has completed.
" );
return;
}
String sourceURL;
Resource original, new_resource, destination;
ResourceTree tree;
FacilityList facilityList;
Facility facility;
int multiple_copies;
Logger.getLogger("org.bodington").fine( "starting copyconfirm()" );
sourceURL=breq.getParameter( "source" );
if ( breq.getParameter( "destination" )!=null )
{
out.println( "Moving objects by pushing is no longer supported." );
return;
}
if ( sourceURL==null )
{
out.println( "Item to be copied must be specified." );
return;
}
if ( !sourceURL.endsWith( "/" ) )
sourceURL= sourceURL + "/";
if ( !sourceURL.startsWith( "/" ) )
sourceURL= "/" + sourceURL;
if ( sourceURL.length() < 3 )
{
out.println( "Name too short." );
return;
}
try
{
BuildingContext context = BuildingContext.getContext();
destination = context.getResource();
facilityList = FacilityList.getFacilities();
if ( facilityList==null )
{
out.println( "Problem finding facilities." );
return;
}
tree = ResourceTree.getInstance();
original=tree.findResource( sourceURL );
if ( original==null )
{
out.println( "The item you want to copy wasn't found." );
return;
}
if ( destination==null )
{
out.println( "The destination location wasn't found." );
return;
}
if ( destination.isInside( original ) )
{
out.println( "The destination location you specified is inside the item being copied." );
return;
}
if ( destination.equals( original ) )
{
out.println( "The destination location you specified is inside the item being copied and is not allowed. ");
out.println( " If you have a query about this, then please contact the Administrator or Help Desk for this web site." );
return;
}
Facility dstfac = facilityList.get( new Integer( destination.getHttpFacilityNo() ) );
facility = facilityList.get( new Integer( original.getHttpFacilityNo() ) );
if ( !dstfac.willAcceptFacility( facility ) )
{
out.println( "The destination location cannot contain the type of resource you want to copy." );
return;
}
if ( !original.checkPermission( Permission.MANAGE ) )
{
out.println( "You don't have management permission for the item to be copied.\n" );
return;
}
if ( !destination.checkPermission( Permission.CREATE ) )
{
out.println( "You don't have creation permission for the destination location.\n" );
return;
}
// JRM added check for resources that can't be copied.
if ( !facility.canCopy( original ) )
{
out.println( "The selected resource is of a type that cannot be copied." );
return;
}
if ( "true".equalsIgnoreCase( breq.getParameter("recursive") ) &&
!facility.canCopyWithChildren( original ) )
{
out.println( "The selected resource contains one or more resources that cannot be copied because you don't have manage access or they are of a type that cannot be copied." );
return;
}
// JRM added sanity check for resource to be copied
if ( "true".equalsIgnoreCase( breq.getParameter("recursive") ) )
{
int descendents = tree.countDescendents( original.getResourceId() );
if ( descendents<0 )
{
out.println( "Error determining how many resources need to be copied." );
return;
}
if ( descendents>100 )
{
out.println( "You opted to copy resources inside the selected resource but there are too many (>100)." );
return;
}
}
}
catch ( BuildingServerException ex )
{
out.println( "Unable to copy resource (Copying not started)" + ex );
logException( out, "Facility", "copyConfirm",
"Unable to copy resource.", ex );
return;
}
try
{
Logger.getLogger("org.bodington").fine( "copyconfirm(), starting to copy resources... " );
Vector names = new Vector();
String name = original.getName();
String append = "";
int start = 2;
// JRM - added checks to user input here in case a different template
// form is used in the future and in case some user puts together their
// own form to make a denial of service attack.
try
{
multiple_copies=Integer.parseInt(breq.getParameter( "multiple" ));
}
catch ( NumberFormatException nfe )
{
out.println( "Unable to determine the number of copies of resource to make." );
logException( out, "Facility", "copyConfirm",
"Unable to determine the number of copies of resource to make.", nfe );
return;
}
if ( multiple_copies<1 )
{
out.println( "Unable to determine the number of copies of resource to make." );
Logger.getLogger( "org.bodington" ).severe( "Unable to determine the number of copies of resource to make." );
return;
}
if ( multiple_copies>20 )
{
out.println( "Unable to make that many copies." );
Logger.getLogger( "org.bodington" ).severe( "Unable to make that many copies." );
return;
}
Enumeration enum = destination.findChildren();
while ( enum.hasMoreElements() )
names.add( ((Resource)enum.nextElement()).getName() );
for ( int i = 1; i <= multiple_copies; i++ )
{
while ( names.contains( name + append ) )
{
append = Integer.toString( start++ );
if ( (name+append).length() > 12 )
name = name.substring( 0, 12-append.length() );
}
// impossible for two threads to enter this block of code
synchronized ( copy_synch )
{
try
{
copy_in_progress = true;
copyResource( original, destination, breq, name + append, out );
}
finally
{
copy_in_progress = false;
}
}
append = Integer.toString( start++ );
if ( (name+append).length() > 12 )
name = name.substring( 0, 12-append.length() );
if ( multiple_copies>1 )
{
out.println( "
" );
logException( out, "Facility", "copyConfirm",
"Error in attempting to copy resource.", ex );
}
}
/**
* Recursively creates a new Resource and copies required properties,
* children, content, etc. Used by {@link #copyconfirm(Request, PrintWriter)}.
* (WebLearn modification (method added): 02/12/2003 Colin Tatham)
* (WebLearn modification. Modified: 16/02/2004 Colin Tatham)
* @param original The resource to be copied.
* @param destination The resource which will be the parent of the newly created resource.
* @param breq The building HTTP request, which is used to determine which type of content to copy.
* @param name The name to be used for the new resource (or null if the name is to be copied from the original.)
* @param out A Print writer, to display messages to the user interface.
* @exception BuildingServerException Thrown if there is any problem copying the resource.
*/
private void copyResource( Resource original, Resource destination, Request breq, String name, PrintWriter out )
throws BuildingServerException
{
ResourceTree tree = null;
BuildingContext context = BuildingContext.getContext();
FacilityList facilityList = FacilityList.getFacilities();
Facility facility = facilityList.get( new Integer( original.getHttpFacilityNo() ) );
Resource new_resource = null;
Connection con = null;
String message;
try
{
tree = ResourceTree.getInstance();
synchronized ( tree ) // some comments copied from createconfirm() method...
{
new_resource = facility.newResource();
new_resource.setZoneId( original.getZoneId() ); // added JRM
if ( name==null )
name = original.getName();
new_resource.setName( name );
new_resource.setTitle( original.getTitle() );
new_resource.setDescription( original.getDescription() );
new_resource.setIntroduction( original.getIntroduction() );
new_resource.setHttpFacilityNo( original.getHttpFacilityNo() );
new_resource.setHttpUIStyle( original.getHttpUIStyle() );
new_resource.setHasCustomMenu( original.getHasCustomMenu() ); // added JRM
// initResource sets fields in subclass of Resource BEFORE saving it.
//new version of initResource(), takes original as arg:
facility.initResource( original, new_resource );
con = context.getConnection();
//may need to rollback after several operations
con.setAutoCommit( false );
tree.addResource( destination, new_resource );
//tree.updateIndices();
//tree.saveAll();
//specific creation stuff
/** @todo OK to take this out? Only used by PermissionFacility.
* May be needed for other facilities. This is called after resource
* record has been saved and is used to create other supporting records
* that are specific to the facility subclass.
*/
if ( !facility.create( breq, con, new_resource ) )
out.println( "
Unable to create supporting data for new resource." );
con.commit();
con.setAutoCommit( true );
}
}
catch ( Exception ex )
{
message = "Resource creation failed, ";
try
{
tree.removeResource( new_resource );
//tree.updateIndices();
//tree.saveAll();
con.rollback();
}
catch ( Exception ex2 )
{
message += "unable to roll back database operations.";
Logger.getLogger( "org.bodington" ).severe( message );
throw new BuildingServerException(ex.getMessage(), message );
}
message += "database rolled back.";
Logger.getLogger( "org.bodington" ).severe( message );
throw new BuildingServerException(ex.getMessage(), message );
}
if ( breq.getParameter("permissions") != null )
copyAccessPermissions( original, new_resource, out );
if ( breq.getParameter("uploaded") != null )
copyUploadedContent( original, new_resource, out);
// copy authored content and user data:
try
{
facility.copyContent( original, new_resource, breq );
}
catch (BuildingServerException ex)
{
message = "Error copying content for: "+ new_resource.getName();
// using getFullName() could throw another exception...
out.print( ""+ message +" "+ ex.getMessage());
Logger.getLogger( "org.bodington" ).warning( message + ex.getMessage() );
}
// create metadata record
try
{
BuildingSession session = BuildingSessionManagerImpl.getSession( new_resource );
session.updateBasicMetadata( new_resource.getTitle(), new_resource.getDescription() );
}
catch ( Exception ex )// BuildingServerException, RemoteException
{
out.print( "Unable to save the associated metadata for the newly created item.");
}
if ( breq.getParameter("recursive").equalsIgnoreCase("true") )
{
Enumeration enum = original.findChildren();
while ( enum.hasMoreElements() )
{
Resource child = (Resource)enum.nextElement();
if ( !child.equals(new_resource) )
try
{
copyResource( child, new_resource, breq, null, out );
}
catch (BuildingServerException ex)
{
message = "Error copying child resource: "+ child.getName();
out.print( ""+ message +" "+ ex.friendlyMessage());
Logger.getLogger( "org.bodington" ).severe( message + ex.getMessage() );
}
}
}
}
/**
* Copies uploaded files from one resource to another. Used by
* {@link #copyconfirm(Request, PrintWriter)}.
* (WebLearn modification (method added): 02/12/2003 Colin Tatham)
* (WebLearn modification. Modified: 16/02/2004 Colin Tatham)
* @param original The resource with uploaded files to be copied.
* @param new_resource The resource to add the uploaded files to.
* @param out A Print writer, to display messages to the user interface.
*/
private void copyUploadedContent( Resource original, Resource new_resource, PrintWriter out )
{
try
{
BuildingSession orig_session = BuildingSessionManagerImpl.getSession( original );
BuildingSession new_session = BuildingSessionManagerImpl.getSession( new_resource );
UploadedFileSummary[] summaries = orig_session.getFileAndDescendentSummaries( null, true );
UploadedFile f;
String path_to_source_in_os, name_rel_to_res, mime_type;
File source_filestore = original.getWebPublishFolder();
File source;
// better to fix the fault in BuildingSessionImpl - done
//createRootFolder( new_resource );//shouldn't be necessary, see method for notes:
// there a simpler way to work out the paths using
// convenient methods in UploadedFile and Resource
for ( int i = 0; i < summaries.length; i++ )
{
f = UploadedFile.findUploadedFile(summaries[i].getUploadedFileId());
// don't copy deleted files and folders!
if ( f==null || f.isDeleted() )
continue;
mime_type = f.getMimeType();
// this is the actual file
source = new File( source_filestore, f.getRealNameInResource() );
path_to_source_in_os = source.getAbsolutePath();
// Bodington style relative name is same for source and destination
name_rel_to_res = f.getNameInResource();
if ( f.isFolder() )
new_session.createFolder( name_rel_to_res );
else
new_session.copyFile( path_to_source_in_os, name_rel_to_res, mime_type );
}
// don't forget to copy custom menu file if there is one.....
if ( original.getHasCustomMenu() )
{
String source_gen_path = original.getGeneratedFileAddress();
new_session.transferResourceMenu( source_gen_path + "menu.xml" );
}
}
catch ( Exception ex ) // BuildingServerException and RemoteException
{
Logger.getLogger( "org.bodington" ).logp(
Level.SEVERE,
"Facility",
"copyUploadedContent",
ex.getMessage(),
ex );
String message = "Error copying uploaded files for : "+ new_resource.getName();
out.print( "
"+ message +" "+ ex.getMessage());
}
}
/**
* Copies the access permissions from one resource to another. Used by
* {@link #copyconfirm(Request, PrintWriter)}.
* (WebLearn modification (method added): 02/12/2003 Colin Tatham)
* @param original The resource with permissions to be copied.
* @param new_resource The resource whose premissions are to be modified.
* @param out A Print writer, to display messages to the user interface.
*/
private void copyAccessPermissions( Resource original, Resource new_resource, PrintWriter out )
{
try
{
Acl acl, new_acl;
AclEntry entry, new_entry;
Group group, new_group, owner_group, new_ownergroup;
String name, local_name, new_name;
int offset;
User user;
Enumeration members;
new_resource.setUseParentAcl( original.getUseParentAcl() );
new_resource.save();
acl = original.getAcl();
new_acl = new_resource.getAcl();
// copy local groups if not already done
Vector copy_groups = new Vector();
Enumeration groups = Group.findGroups( "resource_id = " + original.getResourceId() );
while ( groups.hasMoreElements() )
{
group = (Group)groups.nextElement();
name = group.getName();
if ( !name.startsWith( "localgroup." ) ) continue;
offset = name.indexOf( '.' );
offset = name.indexOf( '.', offset+1 );
local_name = name.substring( offset+1 );
new_name = "localgroup." + new_resource.getResourceId() + "." + local_name;
// exists already?
new_group = Group.findGroup( "resource_id = " + new_resource.getResourceId() + " AND name = " + SqlDatabase.quotedSQL( new_name ) );
// no, needs to be created.
if ( new_group == null )
{
new_group = new Group();
new_group.setResourceId( new_resource.getResourceId() );
new_group.setName( new_name );
new_group.setDescription( group.getDescription() );
new_group.save();
}
if ( !"owners".equals( local_name ) )
{
copy_groups.addElement( group );
copy_groups.addElement( new_group );
}
}
// copy members of local groups but exluding owners group
for ( int i=0; i"+ message +" "+ ex.getMessage());
Logger.getLogger( "org.bodington" ).warning( message + ex.getMessage() );
}
}
private void deleteconfirm( Request breq, PrintWriter out )
throws IOException
{
//String item, dst;
Resource srcres, itemres;
int n;
Connection con=null;
ResourceTree tree;
Resource dstres;
String confirm1, confirm2;
if ( breq.getTemplateParameterCount() > 0 )
{
out.println( "No resource was deleted because the web address of the 'delete resource' " +
"page you came from is invalid. This may have happened because you already deleted " +
"the resource and you backtracked to an out-of-date page. Please use the navigation " +
"bar to exit from here." );
return;
}
confirm1 = breq.getParameter( "confirm1" );
confirm2 = breq.getParameter( "confirm2" );
if ( confirm1==null || !confirm1.equalsIgnoreCase( "yes" ) ||
(confirm2!=null && confirm2.equalsIgnoreCase( "yes" ) ) )
{
out.println( "Resource was not deleted because you didn't confirm without doubt your intention to delete." );
return;
}
out.flush();
try
{
Enumeration enum = Resource.findResources( "http_facility_no = 30", "left_index" );
if ( !enum.hasMoreElements() || (dstres=(Resource)enum.nextElement())==null )
{
out.println( "Unable to locate the recycling building." );
return;
}
itemres = breq.getResource();
srcres = itemres.getParent();
if ( srcres == null )
{
out.println( "Unable to delete resource because it is the root resource of the site." );
return;
}
tree = ResourceTree.getInstance();
Logger.getLogger("org.bodington").fine( "moveconfirm() A" );
Logger.getLogger("org.bodington").fine( "moveconfirm() B" );
if ( !itemres.checkPermission( Permission.MANAGE ) )
{
out.println( "You don't have management permission for the item to be deleted.\n" );
return;
}
if ( !dstres.checkPermission( Permission.CREATE ) )
{
out.println( "You don't have permission to put things in the recycle building so you can't delete resources.\n" );
return;
}
// we have to check whether dstloc is 'inside' itemloc
if ( dstres.isInside( itemres ) )
{
out.println( "The resource you want to delete contains the recycle building to you can't delete it.." );
return;
}
//change name to avoid clashes
itemres.setName( itemres.getResourceId().toString() );
itemres.save();
//To do...
//remove all groups other than owners from ACL
//remove all "notification" flags so noone gets events anymore?????
//check for clashes anyway
enum = dstres.findChildren();
Resource child;
while ( enum.hasMoreElements() )
{
child=(Resource)enum.nextElement();
if ( child.getName().equals( itemres.getName() ) )
{
out.println( "The destination location already contains an item with the same name as the item you are trying to move." );
return;
}
}
tree.moveResource( dstres, itemres );
out.println( "The current resource was moved and so its web address has changed." );
out.print(
"
Location deleted O.K. The pages " +
"you are looking at are now no longer valid." +
" Select this link to move out to the containing resource. " +
"Please DO NOT use the backtrack facility of your browser.
" );
return;
}
catch ( BuildingServerException bex )
{
out.println( "There was an unexpected problem deleting the item.\n" + bex );
}
return;
}
private void ifloggedin( Request breq )
throws IOException
{
breq.setSwitchedOff( !breq.isAuthenticated() );
return;
}
private void ifaccess( Request breq, String name )
throws IOException
{
breq.setSwitchedOff( !BuildingContext.getContext().checkPermission( name ) );
}
public boolean hasPermission( String name )
throws IOException
{
return BuildingContext.getContext().checkPermission( name );
}
private void ifcanreorder( Request breq )
throws IOException
{
BuildingContext context;
Resource resource;
context = BuildingContext.getContext();
int i;
if ( !BuildingContext.getContext().checkPermission( "manage" ) )
{
breq.setSwitchedOff( true );
return;
}
try
{
resource = context.getResource();
Enumeration enum=resource.findChildren();
for ( i=0; enum.hasMoreElements(); i++ )
{
enum.nextElement();
}
breq.setSwitchedOff( (i<2) );
}
catch ( BuildingServerException bsex )
{
breq.setSwitchedOff( true );
}
return;
}
public void variable( Request breq, PrintWriter out, String name )
throws IOException
{
variable( breq, out, name, false );
}
private void variable( Request breq, PrintWriter out, String name, boolean form )
throws IOException
{
if ( out == null )
return;
Resource resource;
try
{
resource = BuildingContext.getContext().getResource();
TextareaWriter t_out = new TextareaWriter( out );
if ( name.equalsIgnoreCase( "url" ) )
{
if ( resource.getName()!=null )
out.print( resource.getName() );
return;
}
if ( name.equalsIgnoreCase( "ordinal" ) )
{
//if ( breq.location.ordinal!=null )
// out.print( breq.location.ordinal.toString() );
return;
}
if ( name.equalsIgnoreCase( "title" ) )
{
/*
NavigationSessionImpl session = (NavigationSessionImpl)BuildingSessionManagerImpl.getSession( NavigationSessionImpl.class );
if ( session.resourceTitle()!=null )
{
session.setResource( breq.getResource() );
out.print( session.resourceTitle() );
}
*/
if ( resource.getTitle()!=null )
{
if ( form )
t_out.print( resource.getTitle() );
else
out.print( resource.getTitle() );
}
return;
}
if ( name.equalsIgnoreCase( "description" ) )
{
if ( resource.getDescription()!=null )
{
if ( form )
t_out.print( resource.getDescription() );
else
out.print( resource.getDescription() );
}
return;
}
if ( name.equalsIgnoreCase( "introduction" ) )
{
if ( resource.getIntroduction()!=null )
{
if ( form )
t_out.print( resource.getIntroduction() );
else
out.print( resource.getIntroduction() );
}
return;
}
if ( name.equalsIgnoreCase( "nameofuser" ) && breq.isAuthenticated() )
{
User user = (User)BuildingContext.getContext().getUser();
if ( user!=null && user.getName()!=null )
{
out.print( user.getName() );
}
return;
}
if ( name.equalsIgnoreCase( "resource_id" ) )
{
if ( breq.getResource().getResourceId()==null )
out.print( "No resource id for this location." );
else
out.print( "Resource id = " + breq.getResource().getResourceId() );
return;
}
if ( name.substring( 0, 4 ).equalsIgnoreCase( "type" ) )
{
if ( name.equalsIgnoreCase( "typeca" ) )
{
out.print( getTitle( true, true ) );
return;
}
if ( name.equalsIgnoreCase( "typea" ) )
{
out.print( getTitle( false, true ) );
return;
}
if ( name.equalsIgnoreCase( "typec" ) )
{
out.print( getTitle( true, false ) );
return;
}
out.print( getTitle( false, false ) );
return;
}
if ( name.equalsIgnoreCase( "zone_name" ) )
{
Zone zone = breq.getResource().getEffectiveZone();
if ( zone == null )
out.print( "(undefined)" );
else
out.print( zone.getName() );
return;
}
}
catch ( BuildingServerException bsex )
{
return;
}
out.print( "" );
}
private void reordercontrol( Request breq, PrintWriter out )
throws IOException
{
BuildingContext context;
Resource resource, current;
context = BuildingContext.getContext();
try
{
resource = context.getResource();
Enumeration enum=resource.findChildren();
for ( int i=0; enum.hasMoreElements(); i++ )
{
current=(Resource)enum.nextElement();
if ( !current.checkPermission( Permission.SEE ) )
continue;
out.print( "" );
}
}
catch ( BuildingServerException bsex )
{
return;
}
}
private void reorder( Request breq, PrintWriter out )
throws IOException
{
BuildingContext context;
Resource resource, current;
context = BuildingContext.getContext();
Vector key_list = new Vector();
String strrid;
int r;
PrimaryKey key;
String list=breq.getParameter( "thelist" );
StringTokenizer tok = new StringTokenizer( list, "," );
while ( tok.hasMoreTokens() )
{
strrid = tok.nextToken();
try
{
r = Integer.parseInt( strrid );
}
catch ( Exception ex )
{
continue;
}
key = new PrimaryKey( r );
key_list.addElement( key );
}
try
{
resource = context.getResource();
resource.sortChildren( key_list );
ResourceTree tree = ResourceTree.getInstance();
//tree.updateIndices();
//tree.saveAll();
out.println( "
Confirmation
" );
out.println( "
Resources have been put in the following order:
" );
out.println( "
" );
for ( int i=0; i" );
out.print( current.getTitle() );
out.println( "" );
}
out.println( "
There was a technical problem attempting to reorder resources
" );
out.println( bsex.toString() );
return;
}
}
/*
private void reorder_old_nbb( Request breq, PrintWriter out, Resource resource )
throws IOException
{
BuildingContext context;
Resource current;
context = BuildingContext.getContext();
Vector key_list = new Vector();
PrimaryKey key;
try
{
Connection con = context.getConnection();
Statement st = con.createStatement();
ResultSet r = st.executeQuery(
"SELECT resource_id FROM resources r, building.dbo.locations l " +
"WHERE r.resource_id *= (l.id + 10097637) AND parent_resource_id = " +
resource.getResourceId().toString() +
" ORDER BY ordinal, l.title" );
while ( r.next() )
{
key = new PrimaryKey( r.getInt( 1 ) );
key_list.addElement( key );
}
r.close();
st.close();
resource.sortChildren( key_list );
ResourceTree tree = resource.getResourceTree();
tree.updateIndices();
tree.saveAll();
out.println( "
Confirmation
" );
out.println( "
Resources have be put in the following order:
" );
out.println( "
" );
for ( int i=0; i" );
out.print( current.getTitle() );
out.println( "" );
}
out.println( "
" );
//now recurse into children.....
for ( int i=0; iThere was a technical problem attempting to reorder resources
" );
out.println( bsex.toString() );
return;
}
}
*/
public void enableStylesheets( Request breq, boolean enable )
throws ServletException
{
org.bodington.servlet.HttpSession http_session = (org.bodington.servlet.HttpSession)breq.getSession( false );
if ( http_session == null )
return;
StyleSheetSessionData sss_data = this.getStyleSheetSessionData( http_session );
sss_data.enable_style_sheets = enable;
}
private void stylesheet( Request breq, PrintWriter out )
throws IOException, ServletException
{
out.print( "" );
}
protected void resourceMenuItem( Object gen_item, Request breq, PrintWriter out, ResourceMenuOutputState state, int depth, int highlight )
throws IOException, BuildingServerException {
if (gen_item instanceof MenuItem) {
MenuItem item = (MenuItem) gen_item;
resourceMenuItem(item, breq, out, state, depth, highlight);
}
else if (gen_item instanceof Resource) {
Resource resource = (Resource) gen_item;
Facility facility = state.fl.get(new Integer(resource.getHttpFacilityNo()));
facility.resourceMenuItem(resource, breq, out, state, depth, highlight);
}
// else ?
}
protected void resourceMenuItem(MenuItem menu_item, Request breq, PrintWriter out, ResourceMenuOutputState state, int depth, int highlight)
throws IOException, BuildingServerException
{
// MenuItem item=null;
// Resource resource=null;
// Facility facility;
// Template template;
String href=null, icon_src=null, title=null, target=null;
boolean italic=false; // should really use a redefinable style
boolean is_heading = false;
boolean manage = false;
boolean deny = false;
// if ( gen_item instanceof MenuItem )
// item = (MenuItem)gen_item;
// if ( gen_item instanceof Resource )
// resource = (Resource)gen_item;
// determine href
if ( menu_item!=null )
{
href = menu_item.getHRef();
target = state.target;
if ( menu_item.getType().equals( "container" ) )
icon_src = state.folder_url;
else
icon_src = state.file_url;
title = menu_item.getTitle();
}
// heading level for title line matches depth but there are only
// six heading levels in HTML so stop there.
int hlevel = (depth>6)?6:depth;
int level = ((depth-1)%10)+1;
// title in heading with appropriate class attribute
out.print( " " );
else
{
out.print( " class=\"" + state.css_class_prefix + "_node_title_lev" );
out.print( level );
out.print( "\">" );
}
// optional link around whole title (inc. icon)
if ( href != null && !is_heading )
{
out.print( "" );
}
if ( is_heading )
out.print( "" );
else
{
/*
* WebLearn modification [26/01/05] Alexis O'Connor.
* Renders more accurate / accessible value for alt attribute.
*/
out.print( "" );
else
out.print( "class=\"" + state.css_class_prefix + "_node_icon_no_expander\" />" );
// span is used to get everything on one line in browsers that
// lack CSS but CSS redfines as block.
out.print( "" );
}
if ( italic )
out.print( "" );
if ( title != null )
out.print( title );
else
if ( href != null )
out.print( href );
else
out.print( "{untitled item}" );
if ( italic )
out.print( "" );
// headings have link after title
if ( href != null && is_heading && manage )
{
out.print( ">" );
}
if ( is_heading )
out.print( "" );
else
out.print( "" );
if ( href != null && !is_heading )
out.print( "" );
out.print( "" );
// files have no further content in the node.
// but resources have descriptions or introductions
// amendment - if big icons files have an empty content section
// to take up space next to icon and prevent next (floating)
// icon coming up next to current one.
// if ( resource != null || state.big_icons )
if ( state.big_icons )
{
String content;
// if ( resource != null )
// {
// if ( !state.rootless && depth==1 )
// content = resource.getIntroduction();
// else
// content = resource.getDescription();
// if ( deny )
// content = "You are not included on the access list for this item. " + content;
// }
// else
content = " ";
if ( content.length()>0 )
{
out.print( "
" );
out.print( content );
out.print( "
" );
}
}
out.print( "
\n");
}
protected void resourceMenuItem(Resource resource, Request breq, PrintWriter out, ResourceMenuOutputState state, int depth, int highlight)
throws IOException, BuildingServerException
{
MenuItem item=null;
// Resource resource=null;
Facility facility;
Template template;
String href=null, icon_src=null, title=null, target=null;
boolean italic=false; // should really use a redefinable style
boolean is_heading = false;
boolean manage = false;
boolean deny = false;
java.util.Date openDate, closeDate;
String available_date;
// if ( gen_item instanceof MenuItem )
// item = (MenuItem)gen_item;
// if ( gen_item instanceof Resource )
// resource = (Resource)gen_item;
// determine href
if ( item!=null )
{
href = item.getHRef();
target = state.target;
if ( item.getType().equals( "container" ) )
icon_src = state.folder_url;
else
icon_src = state.file_url;
title = item.getTitle();
}
else if ( resource!=null )
{
is_heading = resource.getResourceType() == Resource.RESOURCE_HEADING;
if ( is_heading )
manage = resource.checkPermission( Permission.MANAGE );
href = ( !state.rootless && depth==1 )?null:
( breq.getContextPath() +breq.getServletPath() + resource.getFullName() );
target = "_top";
// using getTemplateGifUrl doesn't work for descendant resources - need to
// reference proper resource.
facility = state.fl.get( new Integer( resource.getHttpFacilityNo() ) );
if ( facility!=null )
{
template = Template.get( facility.facilityname, resource.getImplicitHttpUIStyle(), resource.getResourceId(), state.big_icons?"icon.gif":"iconsmall.gif" );
if ( template != null )
icon_src = breq.getContextPath() + state.gif_url + template.getUrl() + state.colour_code;
}
title = resource.getTitle();
if ( !resource.checkPermission( Permission.VIEW ) )
{
if ( state.anon )
// anonymous users are allowed to see link because
// they get a message about logging in if they enter
italic=true;
else
{
// logged in but no access - don't give link
href=null;
deny = true;
}
}
}
// heading level for title line matches depth but there are only
// six heading levels in HTML so stop there.
int hlevel = (depth>6)?6:depth;
int level = ((depth-1)%10)+1;
// title in heading with appropriate class attribute
out.print( " " );
else
{
out.print( " class=\"" + state.css_class_prefix + "_node_title_lev" );
out.print( level );
out.print( "\">" );
}
// optional link around whole title (inc. icon)
if ( href != null && !is_heading )
{
out.print( "" );
}
if ( is_heading )
out.print( "" );
else
{
/*
* WebLearn modification [26/01/05] Alexis O'Connor.
* Renders more accurate / accessible value for alt attribute.
*/
out.print( "" );
else
out.print( "class=\"" + state.css_class_prefix + "_node_icon_no_expander\" />" );
// span is used to get everything on one line in browsers that
// lack CSS but CSS redfines as block.
out.print( "" );
}
if ( italic )
out.print( "" );
if ( title != null )
out.print( title );
else
if ( href != null )
out.print( href );
else
out.print( "{untitled item}" );
if ( italic )
out.print( "" );
// headings have link after title
if ( href != null && is_heading && manage )
{
out.print( ">" );
}
if ( is_heading )
out.print( "" );
else
out.print( "" );
if ( href != null && !is_heading )
out.print( "" );
out.print( "" );
// files have no further content in the node.
// but resources have descriptions or introductions
// amendment - if big icons files have an empty content section
// to take up space next to icon and prevent next (floating)
// icon coming up next to current one.
if ( resource != null || state.big_icons )
{
String content;
if ( resource != null )
{
if ( !state.rootless && depth==1 )
content = resource.getIntroduction();
else
content = resource.getDescription();
if ( deny )
content = "You are not included on the access list for this item. " + content;
}
else
content = " ";
if ( content.length()>0 )
{
out.print( "
" );
out.print( content );
openDate = resource.getOpenDate();
closeDate = resource.getCloseDate();
if (! (openDate == null && closeDate == null)) {
available_date = " This resource is available";
if (openDate != null)
available_date += " from " +
org.bodington.util.DateFormatter.formatDate(openDate, 2);
if (closeDate != null)
available_date += " until " +
org.bodington.util.DateFormatter.formatDate(closeDate, 2);
out.println(available_date);
}
out.print( "
" );
out.print( "
\n");
}
}
}
protected void resourceMenuItemChildren( Object gen_item, Request breq, PrintWriter out, ResourceMenuOutputState state, int depth, int parent_highlight )
throws IOException, BuildingServerException {
if (gen_item instanceof MenuItem) {
MenuItem item = (MenuItem) gen_item;
resourceMenuItemChildren(item, breq, out, state, depth, parent_highlight);
}
else if (gen_item instanceof Resource) {
Resource resource = (Resource) gen_item;
Facility facility = state.fl.get(new Integer(resource.getHttpFacilityNo()));
facility.resourceMenuItemChildren(resource, breq, out, state, depth,
parent_highlight);
}
// else ?
}
protected void resourceMenuItemChildren( Resource resource, Request breq, PrintWriter out, ResourceMenuOutputState state, int depth, int parent_highlight )
throws IOException, BuildingServerException
{
int i, highlight, level = ((depth-1)%10)+1;
Menu menu;
MenuItem item=null;
// Resource resource=null, resource_child=null;
Resource resource_child=null;
Object gen_child=null;
MenuItem child; //, sibling;
Vector children=null, grandchildren=null;
boolean child_has_visible_child_resources = false;
boolean is_heading = false;
// if ( gen_item instanceof MenuItem )
// item = (MenuItem)gen_item;
// if ( gen_item instanceof Resource )
// resource = (Resource)gen_item;
// start with interactive resource children
if ( state.full && resource != null && (level<=state.recursion_depth) )
children = getVisibleChildResourcesForMenu( resource );
else
children = new Vector();
// menuitems for root only
if ( resource != null && (state.rootless?depth==1:depth==2) )
{
menu = state.session.getResourceMenu();
item = (MenuItem)menu.getRoot();
}
for ( i=0; item!=null && i" );
if ( state.detached_root )
{
out.println( "
" );
out.println( "
" );
out.println( "Where you can go from here" );
out.println( "
" );
out.println( "
" );
}
}
else
{
out.print( indent );
out.print( "
" );
}
for ( i=0; istate.recursion_depth )
child_has_visible_child_resources=false;
else
{
grandchildren = getVisibleChildResourcesForMenu( resource_child );
child_has_visible_child_resources = grandchildren.size()>0;
}
}
//highlight = (((state.root_highlight-1) ^ (depth-1) ^ i) & 1) + 1;
highlight = (((parent_highlight-1) ^ (i+1)) & 1) + 1;
// put every child in a branch
// (every branch in branch border)
out.print( indent );
out.print( "
" );
out.print( indent );
out.print( "
" );
// put every child other than headings in a node too
if ( !is_heading )
{
out.print( indent );
out.print( "
"); // end of node
if (resource_child != null && (depth + 1) <= state.recursion_depth)
resourceMenuItemChildren(resource_child, breq, out, state, depth + 1,
highlight);
if (child != null && child.getChildCount() > 0)
resourceMenuItemChildren(child, breq, out, state, depth + 1, highlight);
out.println("
"); // end of branch
out.println("
"); // end of branch border
}
if ( !state.rootless || level != 1 )
out.print( " " );
out.println( "
" ); // end siblings or tree
}
// inner class used to pass some state information through recursive methods
class ResourceMenuOutputState
{
int root_highlight;
boolean rootless;
boolean detached_root;
boolean full;
boolean anon;
boolean big_icons;
String css_class_prefix;
int recursion_depth;
String target;
String gif_url;
String file_url;
String folder_url;
String colour_code;
NavigationSession session;
FacilityList fl;
}
private Vector getVisibleChildResourcesForMenu( Resource resource )
throws BuildingServerException
{
Vector children = new Vector();
// can't see children if can't enter parent
if ( !resource.checkPermission( Permission.VIEW ) )
return children;
Enumeration enum = resource.findChildren();
while ( enum.hasMoreElements() )
{
resource = (Resource)enum.nextElement();
if ( resource.checkPermission( Permission.SEE ) )
children.addElement( resource );
}
return children;
}
public void fullResourceMenu( Request breq, PrintWriter out )
throws IOException
{
fullResourceMenu( breq, out, null );
}
// outputs integrated menu of interactive resources and uploaded files
// including introductory text of requested resource
public void fullResourceMenu( Request breq, PrintWriter out, String target )
throws IOException
{
try
{
resourceMenu( breq, out, true, target );
}
catch ( BuildingServerException e )
{
Logger.getLogger( "org.bodington" ).logp(
Level.SEVERE,
"Facility",
"resourceMenu",
e.getMessage(),
e );
throw new IOException( e.getMessage() );
}
}
// For compatibility with old templates this outputs just uploaded files.
public void resourceMenu( Request breq, PrintWriter out )
throws IOException
{
try
{
resourceMenu( breq, out, false, null );
}
catch ( BuildingServerException e )
{
Logger.getLogger( "org.bodington" ).logp(
Level.SEVERE,
"Facility",
"resourceMenu",
e.getMessage(),
e );
throw new IOException( e.getMessage() );
}
}
// outputs menu of uploaded files and optionally interactive resources
// so far output of interactive resources isn't implemented so full is
// ignored.
public void resourceMenu( Request breq, PrintWriter out, boolean full, String target )
throws IOException, BuildingServerException
{
int i, max_depth=1;
Menu menu;
MenuItem item, child;
Vector visible_children;
try
{
ResourceMenuOutputState state = new ResourceMenuOutputState();
state.full = full;
state.root_highlight = 1;
state.target = target;
state.colour_code = this.getTemplateGifColourMapperCode( breq, "bodington_navigation_page" );
state.gif_url = "/processedgif/templates";
state.session = breq.getServerNavigationSession();
String big_icons = state.session.getProperty( "ui_navigation_menu_big_icons", "no" );
String prefered_big_icons = getAutomaticPreferenceByScreenSize(
breq, "preference.navigation.menu.big_icons", "no", big_icons );
state.big_icons = "yes".equalsIgnoreCase( prefered_big_icons );
state.file_url = this.getTemplateGifUrl( breq, "bodington_navigation_page", state.big_icons?"bs_template_file.gif":"bs_template_file-small.gif", false );
state.folder_url = this.getTemplateGifUrl( breq, "bodington_navigation_page", state.big_icons?"bs_template_folder.gif":"bs_template_folder-small.gif", false );
state.css_class_prefix = state.big_icons?"res_tree_big":"res_tree";
state.fl = FacilityList.getFacilities();
state.anon = state.session.isAnonymous();
String type = state.session.getProperty( "ui_navigation_menu_type", "plain" );
String prefered_type = getPreference( breq, "preference.navigation.menu.type" );
if ( "plain".equalsIgnoreCase( prefered_type ) ||
"attached".equalsIgnoreCase( prefered_type ) ||
"detached".equalsIgnoreCase( prefered_type ) )
type = prefered_type;
//boolean tree = "tree".equalsIgnoreCase( getPreference( breq, "preference.navigation.menu.tree" ) );
boolean tree = "attached".equals( type );
state.detached_root = "detached".equals( type );
// resource property switches on recursion
max_depth=1;
try
{
String prop = state.session.getProperty( "ui_navigation_menu_ancestors", "1" );
max_depth = Integer.parseInt( prop );
if ( max_depth<1 ) max_depth = 1;
if ( max_depth>5 ) max_depth = 5;
}
catch ( NumberFormatException nfe )
{
max_depth=1;
}
// but user can switch off
if ( "suppress".equalsIgnoreCase( getPreference( breq, "preference.navigation.menu.ancestors" ) ) )
max_depth=1;
// suppress tree if old style files only menu
if ( !full ) {tree = false; max_depth=1;}
// actually this is just the uploaded files in the form of an
// IMS style contents page or full file listing
// it doesn't include interactive resources - should be integrated
// some time.
menu = state.session.getResourceMenu();
item = (MenuItem)menu.getRoot();
visible_children = getVisibleChildResourcesForMenu( breq.getResource() );
// in tree mode the node representing the resource itself is shown.
if ( tree )
{
state.recursion_depth = max_depth+1; // add 1 to include root
state.rootless = false;
out.println( "
" );
out.println( "
" );
out.print( "
" );
out.print( "Where you are" );
if ( item.getChildCount() > 0 || visible_children.size() > 0 )
out.print( " and where you can go from here" );
out.println( "
" );
// method will only output div elements if there is at least
// one node to display
resourceMenuItemChildren( breq.getResource(), breq, out, state, 2, 1 );
out.println( "
" );
out.println( "
" );
out.println( "
" );
}
else
// otherwise each top level item is output in its own tree.
{
state.recursion_depth = max_depth;
if ( full )
{
if ( state.detached_root )
{
out.println( "
" );
out.println( "
" );
out.println( "
" );
out.println( "Where you are" );
out.println( "