/ - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 2312

Added by Matt Jones almost 20 years ago

Added in servlet action 'buildindex' for building the XML_index table entries
for either a set of documents (if one or more docid params are provided) or
for the whole set of documents in the xml_documents table. The buildindex
action is restricted to only be accessible by users who are listed in the
metacat.properties file as 'administrators'. So this is a new category of
users that we can use to control administrative actions. In addition, I
restricted access to the 'getlog' action of metacat to the administrative
users.

     import java.text.SimpleDateFormat;
     import java.util.Enumeration;
     import java.util.Hashtable;
     import java.util.Iterator;
     import java.util.PropertyResourceBundle;
     import java.util.Vector;
     import java.util.regex.PatternSyntaxException;
     import java.util.zip.ZipEntry;
     import java.util.zip.ZipOutputStream;
-...
         private String htmlpath = null;
         private String[] administrators = null;
         private PropertyResourceBundle options = null;
         private MetaCatUtil util = null;
-...
                 dataDirectory = new File(datafilepath);
                 servletpath = MetaCatUtil.getOption("servletpath");
                 htmlpath = MetaCatUtil.getOption("htmlpath");
                 String adminList = MetaCatUtil.getOption("administrators");
                 try {
                     administrators = adminList.split(":");
                 } catch (PatternSyntaxException pse) {
                     administrators = null;
                     MetaCatUtil.debugMessage("Error in MetacatServlet.init: "
                         + pse.getMessage(), 20);
+                }
                 System.out.println("Metacat (" + Version.getVersion()
                         + ") initialized.");
-...
                     out.println(Version.getVersionAsXml());
                     out.close();
                 } else if (action.equals("getlog")) {
                     handleGetLogAction(params, request, response);
                     handleGetLogAction(params, request, response, username);
                 } else if (action.equals("buildindex")) {
                     handleBuildIndexAction(params, request, response, username);
                 } else if (action.equals("login") || action.equals("logout")) {
                     /*
                 } else if (action.equals("protocoltest")) {
                     String testURL = "metacat://dev.nceas.ucsb.edu/NCEAS.897766.9";
                     try {
-...
                         mue.printStackTrace(out);
                         out.close();
+                    }
                     */
                 } else {
                     PrintWriter out = response.getWriter();
                     out.println("<?xml version=\"1.0\"?>");
-...
          * Print a report from the event log based on filter parameters passed in
          * from the web.
+         *
          * TODO: make sure urlencoding of timestamp params is working
+         *
          * @param params the parameters from the web request
          * @param request the http request object for getting request details
          * @param response the http response object for writing output
          */
         private void handleGetLogAction(Hashtable params, HttpServletRequest request,
                 HttpServletResponse response)
                 HttpServletResponse response, String username)
+        {
             // Get all of the parameters in the correct formats
             String[] ipAddress = (String[])params.get("ipaddress");
             String[] principal = (String[])params.get("principal");
             String[] docid = (String[])params.get("docid");
             String[] event = (String[])params.get("event");
             String[] startArray = (String[]) params.get("start");
             String[] endArray = (String[]) params.get("end");
             String start = null;
             String end = null;
             if (startArray != null) {
                 start = startArray[0];
+            }
             if (endArray != null) {
                 end = endArray[0];
+            }
             Timestamp startDate = null;
             Timestamp endDate = null;
             SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
             try {
                 if (start != null) {
                     startDate = new Timestamp((format.parse(start)).getTime());
                 response.setContentType("text/xml");
                 PrintWriter out = response.getWriter();
                 // Check that the user is authenticated as an administrator account
                 boolean adminIsAuthenticated = false;
                 for (int i = 0; i < administrators.length; i++) {
                     if (username.equals(administrators[i])) {
                             adminIsAuthenticated = true;
+                    }
+                }
                 if (end != null) {
                     endDate = new Timestamp((format.parse(end)).getTime());
                 if (!adminIsAuthenticated) {
                     out.print("<error>");
                     out.print("The user \"" + username +
                             "\" is not authorized for this action.");
                     out.print("</error>");
                     return;
+                }
             } catch (ParseException e) {
                 System.out.println("Failed to created Timestamp from input.");
                 // Get all of the parameters in the correct formats
                 String[] ipAddress = (String[])params.get("ipaddress");
                 String[] principal = (String[])params.get("principal");
                 String[] docid = (String[])params.get("docid");
                 String[] event = (String[])params.get("event");
                 String[] startArray = (String[]) params.get("start");
                 String[] endArray = (String[]) params.get("end");
                 String start = null;
                 String end = null;
                 if (startArray != null) {
                     start = startArray[0];
+                }
                 if (endArray != null) {
                     end = endArray[0];
+                }
                 Timestamp startDate = null;
                 Timestamp endDate = null;
                 SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
                 try {
                     if (start != null) {
                         startDate = new Timestamp((format.parse(start)).getTime());
+                    }
                     if (end != null) {
                         endDate = new Timestamp((format.parse(end)).getTime());
+                    }
                 } catch (ParseException e) {
                     System.out.println("Failed to created Timestamp from input.");
+                }
                 // Request the report by passing the filter parameters
                 out.println(EventLog.getInstance().getReport(ipAddress, principal,
                         docid, event, startDate, endDate));
                 out.close();
             } catch (IOException e) {
                 MetaCatUtil.debugMessage(
                         "Could not open http response for writing: " + e.getMessage(), 5);
+            }
+        }
             // Request the report by passing the filter parameters
         /**
          * Rebuild the index for one or more documents. If the docid parameter is
          * provided, rebuild for just that one document or list of documents. If
          * not, then rebuild the index for all documents in the xml_documents
          * table.
+         *
          * @param params the parameters from the web request
          * @param request the http request object for getting request details
          * @param response the http response object for writing output
          * @param username the username of the authenticated user
          */
         private void handleBuildIndexAction(Hashtable params,
                 HttpServletRequest request, HttpServletResponse response,
                 String username)
+        {
             // Get all of the parameters in the correct formats
             String[] docid = (String[])params.get("docid");
             // Rebuild the indices for appropriate documents
             try {
                 response.setContentType("text/xml");
                 PrintWriter out = response.getWriter();
                 out.println(EventLog.getInstance().getReport(ipAddress, principal,
                         docid, event, startDate, endDate));
                 // Check that the user is authenticated as an administrator account
                 boolean adminIsAuthenticated = false;
                 for (int i = 0; i < administrators.length; i++) {
                     if (username.equals(administrators[i])) {
                             adminIsAuthenticated = true;
+                    }
+                }
                 if (!adminIsAuthenticated) {
                     out.print("<error>");
                     out.print("The user \"" + username +
                             "\" is not authorized for this action.");
                     out.print("</error>");
                     return;
+                }
                 // Process the documents
                 out.println("<success>");
                 if (docid == null || docid.length == 0) {
                     // Process all of the documents
                     try {
                         Vector documents = getDocumentList();
                         Iterator it = documents.iterator();
                         while (it.hasNext()) {
                             String id = (String) it.next();
                             buildDocumentIndex(id, out);
+                        }
                     } catch (SQLException se) {
                         out.print("<error>");
                         out.print(se.getMessage());
                         out.println("</error>");
+                    }
                 } else {
                     // Only process the requested documents
                     for (int i = 0; i < docid.length; i++) {
                         buildDocumentIndex(docid[i], out);
+                    }
+                }
                 out.println("</success>");
                 out.close();
             } catch (IOException e) {
                 MetaCatUtil.debugMessage(
-...
+        }
         /**
          * Build the index for one document by reading the document and
          * calling its buildIndex() method.
+         *
          * @param docid the document (with revision) to rebuild
          * @param out the PrintWriter to which output is printed
          */
         private void buildDocumentIndex(String docid, PrintWriter out)
+        {
             try {
                 DocumentImpl doc = new DocumentImpl(docid, false);
                 doc.buildIndex();
                 out.print("<docid>" + docid);
                 out.println("</docid>");
             } catch (McdbException me) {
                 out.print("<error>");
                 out.print(me.getMessage());
                 out.println("</error>");
+            }
+        }
         /**
          * Handle documents passed to metacat that are encoded using the
          * "multipart/form-data" mime type. This is typically used for uploading
          * data files which may be binary and large.
-...
+        }
         /*
          * Get the list of documents from the database and return the list in an
          * Vector of identifiers.
+         *
          * @ returns the array of identifiers
          */
         private Vector getDocumentList() throws SQLException
+        {
             Vector docList = new Vector();
             PreparedStatement pstmt = null;
             ResultSet rs = null;
             DBConnection conn = null;
             int serialNumber = -1;
             try {
                 //check out DBConnection
                 conn = DBConnectionPool
                         .getDBConnection("MetaCatServlet.getDocumentList");
                 serialNumber = conn.getCheckOutSerialNumber();
                 pstmt = conn.prepareStatement("SELECT docid, rev"
                         + " FROM xml_documents ");
                 pstmt.execute();
                 rs = pstmt.getResultSet();
                 while (rs.next()) {
                     String docid = rs.getString(1);
                     String rev = rs.getString(2);
                     docList.add(docid + "." + rev);
+                }
             } catch (SQLException e) {
                 MetaCatUtil.debugMessage(
                         "Exception in MetacatServlet.getDocumentList: "
                                 + e.getMessage(), 30);
                 throw e;
             } finally {
                 try {
                     rs.close();
                     pstmt.close();
                 } catch (SQLException se) {
                     MetaCatUtil.debugMessage(
                         "Exception in MetacatServlet.getDocumentList: "
                                 + se.getMessage(), 30);
                     throw se;
                 } finally {
                     DBConnectionPool.returnDBConnection(conn, serialNumber);
+                }
+            }
             return docList;
+        }
         /*
          * A method to output setAccess action result
          */
         private void outputResponse(Vector successList, Vector errorList,

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 2312

Added by Matt Jones almost 20 years ago