Applying SF patch #2462293 - Enable Google Sitemaps for XMLUI

git-svn-id: http://scm.dspace.org/svn/repo/branches/dspace-1_5_x@3344 9c30dcfa-912a-0410-8fc2-9e0234be79fd

dspace-xmlui/dspace-xmlui-api/src/main/java/org/dspace/app/xmlui/cocoon/SitemapReader.java

@@ -0,0 +1,223 @@
+/*
+ * SitemapReader.java
+ *
+ * Version: $Revision: 1.2 $
+ *
+ * Date: $Date: 2006/04/25 15:24:23 $
+ *
+ * Copyright (c) 2002, Hewlett-Packard Company and Massachusetts
+ * Institute of Technology.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - 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.
+ *
+ * - Neither the name of the Hewlett-Packard Company nor the name of the
+ * Massachusetts Institute of Technology nor the names of their
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDERS OR 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.
+ */
+package org.dspace.app.xmlui.cocoon;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Map;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletResponse;
+
+import org.apache.avalon.excalibur.pool.Recyclable;
+import org.apache.avalon.framework.parameters.Parameters;
+import org.apache.cocoon.ProcessingException;
+import org.apache.cocoon.ResourceNotFoundException;
+import org.apache.cocoon.environment.ObjectModelHelper;
+import org.apache.cocoon.environment.Request;
+import org.apache.cocoon.environment.Response;
+import org.apache.cocoon.environment.SourceResolver;
+import org.apache.cocoon.environment.http.HttpEnvironment;
+import org.apache.cocoon.reading.AbstractReader;
+import org.dspace.core.ConfigurationManager;
+import org.xml.sax.SAXException;
+
+import org.apache.log4j.Logger;
+import org.dspace.core.Utils;
+
+/**
+ * Class will read a generated Sitemap (www.sitemaps.org or HTML sitemap)
+ * from [dspace]/sitemaps/ and serve it up to the requesting Search Engine.
+ *
+ * Sitemaps are generated by running the [dspace]/bin/generate-sitemaps script.
+ *
+ * There are essentially two types of Sitemaps:
+ *
+ * (1) Basic HTML Sitemaps
+ *
+ * path = "/htmlmap"
+ *
+ *  <map:read type="SitemapReader">
+ *    <map:parameter name="type" value="html"/>
+ *  </map:read>
+ *
+ * (2) Sitemaps.org XML Sitemaps
+ *
+ * path = "/sitemap"
+ *
+ *  <map:read type="SitemapReader">
+ *    <map:parameter name="type" value="sitemaps.org"/>
+ *  </map:read>
+ *
+ * @author Tim Donohue
+ */
+public class SitemapReader extends AbstractReader implements Recyclable
+{
+    private static Logger log = Logger.getLogger(SitemapReader.class);
+    
+    /** The Cocoon response */
+    protected Response response;
+
+    /** The Cocoon request */
+    protected Request request;
+
+    /** The sitemap's mime-type */
+    protected String sitemapMimeType;
+
+    /** true if we are for serving sitemap.org sitemaps, false otherwise */
+    private boolean forSitemapsOrg = false;
+
+    /**
+     * Set up the bitstream reader.
+     *
+     * See the class description for information on configuration options.
+     */
+    public void setup(SourceResolver resolver, Map objectModel, String src,
+            Parameters par) throws ProcessingException, SAXException,
+            IOException
+    {
+        super.setup(resolver, objectModel, src, par);
+
+        this.request = ObjectModelHelper.getRequest(objectModel);
+        this.response = ObjectModelHelper.getResponse(objectModel);
+        this.forSitemapsOrg = false;
+           
+        // Get our parameter that identifies type of sitemap (default to HTML sitemap)
+        String type = par.getParameter("type", "html");
+
+        if (type != null && type.equalsIgnoreCase("sitemaps.org"))
+        {
+            this.forSitemapsOrg = true;
+        }
+        else if (type == null || !type.equalsIgnoreCase("html"))
+        {
+            log.warn("Invalid initialization parameter for sitemapReader: assuming basic HTML");
+        }
+    }
+
+    /**
+	 * Generate the output.  Determine which type of sitemap is being
+     * requested and setup the main request parameters
+	 */
+    public void generate() throws IOException, ProcessingException
+    {
+        String param = this.request.getParameter("map");
+
+        String ext = (this.forSitemapsOrg ? ".xml.gz" : ".html");
+        this.sitemapMimeType = (this.forSitemapsOrg ? "text/xml" : "text/html");
+        String fileStem = (param == null ? "sitemap_index" : "sitemap" + param);
+
+        sendFile(fileStem + ext, this.forSitemapsOrg);
+    }
+
+    /**
+	 * Write the actual pre-generated Sitemap data out to the response.
+     *
+     * @param file  the actual file to send
+     * @param compressed  true if file should be compressed
+     */
+    private void sendFile(String file, 
+            boolean compressed) throws IOException, ResourceNotFoundException
+    {
+        File f = new File(ConfigurationManager.getProperty("dspace.dir")
+                + File.separator + "sitemaps", file);
+
+        HttpServletResponse httpResponse = (HttpServletResponse) objectModel.get(HttpEnvironment.HTTP_RESPONSE_OBJECT);
+
+        if (!f.exists())
+        {
+            httpResponse.setStatus(HttpServletResponse.SC_NOT_FOUND);
+            throw new ResourceNotFoundException("Unable to locate sitemap");
+        }
+
+        long lastMod = f.lastModified();
+        this.response.setDateHeader("Last-Modified", lastMod);
+
+        // Check for if-modified-since header
+        long modSince = this.request.getDateHeader("If-Modified-Since");
+
+        if (modSince != -1 && lastMod < modSince)
+        {
+            // Sitemap file has not been modified since requested date,
+            // hence bitstream has not; return 304
+            httpResponse.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
+            return;
+        }
+
+        if (compressed)
+        {
+            this.response.setHeader("Content-Encoding", "gzip");
+        }
+
+        // Pipe the bits
+        InputStream is = new FileInputStream(f);
+
+        // Set the response MIME type
+        response.setHeader("Content-Type", this.sitemapMimeType);
+
+        // Response length
+        this.response.setHeader("Content-Length", String.valueOf(f.length()));
+
+        Utils.bufferedCopy(is, this.out);
+        is.close();
+        this.out.flush();
+    }
+
+    
+    /**
+     * Returns the mime-type of the sitemap
+     */
+    public String getMimeType()
+    {
+        return this.sitemapMimeType;
+    }
+
+    /**
+	 * Recycle
+	 */
+    public void recycle() {
+        this.response = null;
+        this.request = null;
+        this.sitemapMimeType = null;
+        this.forSitemapsOrg = false;
+    }
+}

dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/sitemap.xmap

@@ -159,6 +159,7 @@
 			</map:reader>
 			<map:reader name="BitstreamReader" src="org.dspace.app.xmlui.cocoon.BitstreamReader"/>
 			<map:reader name="ExportReader" src="org.dspace.app.xmlui.cocoon.ItemExportDownloadReader"/>
+      <map:reader name="SitemapReader" src="org.dspace.app.xmlui.cocoon.SitemapReader"/>
 		</map:readers>
 		<map:actions>
 			<map:action name="locale" src="org.dspace.app.xmlui.cocoon.DSpaceLocaleAction"/>
@@ -329,6 +330,18 @@
 				<map:serialize type="xml"/>
 			</map:match>
 			
+      <!-- HTML Sitemaps and Sitemaps.org Sitemaps for whole repo -->
+      <map:match pattern="htmlmap">
+        <map:read type="SitemapReader">
+					<map:parameter name="type" value="html"/>
+				</map:read>
+      </map:match>
+      <map:match pattern="sitemap">
+        <map:read type="SitemapReader">
+					<map:parameter name="type" value="sitemaps.org"/>
+				</map:read>
+      </map:match>
+
 			<!-- handle common theme resources, such as dri2xhtml -->
 			<map:match pattern="themes/*">
 				<map:read src="themes/{1}"/>

dspace/CHANGES

@@ -28,6 +28,7 @@
 
 (Tim Donohue)
  - [2433852] Add File Format Descriptions to XMLUI 1.5.x
+ - [2462293] Enable Google Sitemaps for XMLUI
 
 1.5.1 final
 ===========