/*
JSPWiki - a JSP-based WikiWiki clone.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
package com.ecyrd.jspwiki;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import com.ecyrd.jspwiki.auth.acl.Acl;
import com.ecyrd.jspwiki.auth.acl.AclEntry;
import com.ecyrd.jspwiki.auth.acl.AclImpl;
import com.ecyrd.jspwiki.providers.WikiPageProvider;
/**
* Simple wrapper class for the Wiki page attributes. The Wiki page
* content is moved around in Strings, though.
*/
// FIXME: We need to rethink how metadata is being used - probably the
// author, date, etc. should also be part of the metadata. We also
// need to figure out the metadata lifecycle.
public class WikiPage
implements Cloneable,
Comparable
{
private static final long serialVersionUID = 1L;
private String m_name;
private WikiEngine m_engine;
private String m_wiki;
private Date m_lastModified;
private long m_fileSize = -1;
private int m_version = WikiPageProvider.LATEST_VERSION;
private String m_author = null;
private final HashMap<String,Object> m_attributes = new HashMap<String,Object>();
/**
* "Summary" is a short summary of the page. It is a String.
*/
public static final String DESCRIPTION = "summary";
/** A special variable name for storing a page alias. */
public static final String ALIAS = "alias";
/** A special variable name for storing a redirect note */
public static final String REDIRECT = "redirect";
/** A special variable name for storing a changenote. */
public static final String CHANGENOTE = "changenote";
private Acl m_accessList = null;
/**
* Create a new WikiPage using a given engine and name.
*
* @param engine The WikiEngine that owns this page.
* @param name The name of the page.
*/
public WikiPage( WikiEngine engine, String name )
{
m_engine = engine;
m_name = name;
m_wiki = engine.getApplicationName();
}
/**
* Returns the name of the page.
*
* @return The page name.
*/
public String getName()
{
return m_name;
}
/**
* A WikiPage may have a number of attributes, which might or might not be
* available. Typically attributes are things that do not need to be stored
* with the wiki page to the page repository, but are generated
* on-the-fly. A provider is not required to save them, but they
* can do that if they really want.
*
* @param key The key using which the attribute is fetched
* @return The attribute. If the attribute has not been set, returns null.
*/
public Object getAttribute( String key )
{
return m_attributes.get( key );
}
/**
* Sets an metadata attribute.
*
* @see #getAttribute(String)
* @param key The key for the attribute used to fetch the attribute later on.
* @param attribute The attribute value
*/
public void setAttribute( String key, Object attribute )
{
m_attributes.put( key, attribute );
}
/**
* Returns the full attributes Map, in case external code needs
* to iterate through the attributes.
*
* @return The attribute Map. Please note that this is a direct
* reference, not a copy.
*/
public Map getAttributes()
{
return m_attributes;
}
/**
* Removes an attribute from the page, if it exists.
*
* @param key The key for the attribute
* @return If the attribute existed, returns the object.
* @since 2.1.111
*/
public Object removeAttribute( String key )
{
return m_attributes.remove( key );
}
/**
* Returns the date when this page was last modified.
*
* @return The last modification date
*/
public Date getLastModified()
{
return m_lastModified;
}
/**
* Sets the last modification date. In general, this is only
* changed by the provider.
*
* @param date The date
*/
public void setLastModified( Date date )
{
m_lastModified = date;
}
/**
* Sets the page version. In general, this is only changed
* by the provider.
*
* @param version The version number
*/
public void setVersion( int version )
{
m_version = version;
}
/**
* Returns the version that this WikiPage instance represents.
*
* @return the version number of this page.
*/
public int getVersion()
{
return m_version;
}
/**
* Returns the size of the page.
*
* @return the size of the page.
* @since 2.1.109
*/
public long getSize()
{
return m_fileSize;
}
/**
* Sets the size. Typically called by the provider only.
*
* @param size The size of the page.
* @since 2.1.109
*/
public void setSize( long size )
{
m_fileSize = size;
}
/**
* Returns the Acl for this page. May return <code>null</code>,
* in case there is no Acl defined, or it has not
* yet been set by {@link #setAcl(Acl)}.
*
* @return The access control list. May return null, if there is
* no acl.
*/
public Acl getAcl()
{
return m_accessList;
}
/**
* Sets the Acl for this page. Note that method does <em>not</em>
* persist the Acl itself to back-end storage or in page markup;
* it merely sets the internal field that stores the Acl. To
* persist the Acl, callers should invoke
* {@link com.ecyrd.jspwiki.auth.acl.AclManager#setPermissions(WikiPage, Acl)}.
* @param acl The Acl to set
*/
public void setAcl( Acl acl )
{
m_accessList = acl;
}
/**
* Sets the author of the page. Typically called only by the provider.
*
* @param author The author name.
*/
public void setAuthor( String author )
{
m_author = author;
}
/**
* Returns author name, or null, if no author has been defined.
*
* @return Author name, or possibly null.
*/
public String getAuthor()
{
return m_author;
}
/**
* Returns the wiki nanme for this page
*
* @return The name of the wiki.
*/
public String getWiki()
{
return m_wiki;
}
/**
* This method will remove all metadata from the page.
*/
public void invalidateMetadata()
{
m_hasMetadata = false;
setAcl( null );
m_attributes.clear();
}
private boolean m_hasMetadata = false;
/**
* Returns <code>true</code> if the page has valid metadata; that is, it has been parsed.
* Note that this method is a kludge to support our pre-3.0 metadata system, and as such
* will go away with the new API.
*
* @return true, if the page has metadata.
*/
public boolean hasMetadata()
{
return m_hasMetadata;
}
/**
* Sets the metadata flag to true. Never call.
*/
public void setHasMetadata()
{
m_hasMetadata = true;
}
/**
* Returns a debug-suitable version of the page.
*
* @return A debug string.
*/
public String toString()
{
return "WikiPage ["+m_wiki+":"+m_name+",ver="+m_version+",mod="+m_lastModified+"]";
}
/**
* Creates a deep clone of a WikiPage. Strings are not cloned, since
* they're immutable. Attributes are not cloned, only the internal
* HashMap (so if you modify the contents of a value of an attribute,
* these will reflect back to everyone).
*
* @return A deep clone of the WikiPage
*/
public Object clone()
{
WikiPage p = new WikiPage( m_engine, m_name );
p.m_wiki = m_wiki;
p.m_author = m_author;
p.m_version = m_version;
p.m_lastModified = m_lastModified != null ? (Date)m_lastModified.clone() : null;
p.m_fileSize = m_fileSize;
for( Map.Entry<String,Object> entry : m_attributes.entrySet() )
{
p.m_attributes.put( entry.getKey(),
entry.getValue() );
}
if( m_accessList != null )
{
p.m_accessList = new AclImpl();
for( Enumeration entries = m_accessList.entries(); entries.hasMoreElements(); )
{
AclEntry e = (AclEntry)entries.nextElement();
p.m_accessList.addEntry( e );
}
}
return p;
}
/**
* Compares a page with another using the defined PageNameComparator. See com.ecyrd.jspwiki.util.PageSorter.
*
* @param page The object to compare against
* @return -1, 0 or 1
*/
public int compareTo( Object page )
{
return m_engine.getPageSorter().compare( this, (WikiPage) page );
}
/**
* A page is equal to another page if its name and version are equal.
*
* {@inheritDoc}
*/
// TODO: I have a suspicion that defining this method causes some problems
// with page attributes and caching. So as of 2.7.32, it's disabled.
/*
public boolean equals( Object o )
{
if( o != null && o instanceof WikiPage )
{
WikiPage oo = (WikiPage) o;
if( oo.getName().equals( getName() ) )
{
if( oo.getVersion() == getVersion() )
{
return true;
}
}
}
return false;
}
*/
/**
* {@inheritDoc}
*/
public int hashCode()
{
return m_name.hashCode() * m_version;
}
}