diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/cms/servlet/request/QueryReq.java')
| -rw-r--r-- | pki/base/common/src/com/netscape/cms/servlet/request/QueryReq.java | 558 |
1 files changed, 0 insertions, 558 deletions
diff --git a/pki/base/common/src/com/netscape/cms/servlet/request/QueryReq.java b/pki/base/common/src/com/netscape/cms/servlet/request/QueryReq.java deleted file mode 100644 index f6ae634f4..000000000 --- a/pki/base/common/src/com/netscape/cms/servlet/request/QueryReq.java +++ /dev/null @@ -1,558 +0,0 @@ -// --- BEGIN COPYRIGHT BLOCK --- -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; version 2 of the License. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License along -// with this program; if not, write to the Free Software Foundation, Inc., -// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -// -// (C) 2007 Red Hat, Inc. -// All rights reserved. -// --- END COPYRIGHT BLOCK --- -package com.netscape.cms.servlet.request; - -import java.io.IOException; -import java.util.Enumeration; -import java.util.Locale; -import java.util.Vector; -import java.math.BigInteger; - -import javax.servlet.ServletConfig; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import com.netscape.certsrv.apps.CMS; -import com.netscape.certsrv.authentication.IAuthToken; -import com.netscape.certsrv.authorization.AuthzToken; -import com.netscape.certsrv.authorization.EAuthzAccessDenied; -import com.netscape.certsrv.base.EBaseException; -import com.netscape.certsrv.base.IArgBlock; -import com.netscape.certsrv.logging.ILogger; -import com.netscape.certsrv.request.IRequest; -import com.netscape.certsrv.request.IRequestQueue; -import com.netscape.certsrv.request.IRequestVirtualList; -import com.netscape.certsrv.request.RequestId; -import com.netscape.cms.servlet.base.CMSServlet; -import com.netscape.cms.servlet.common.CMSRequest; -import com.netscape.cms.servlet.common.CMSTemplate; -import com.netscape.cms.servlet.common.CMSTemplateParams; -import com.netscape.cms.servlet.common.ECMSGWException; - -/** - * Show paged list of requests matching search criteria - * - * @version $Revision$, $Date$ - */ -public class QueryReq extends CMSServlet { - /** - * - */ - private static final long serialVersionUID = -8729364426329835378L; - // constants - private final static String INFO = "QueryReq"; - private final static String IN_SHOW_ALL = "showAll"; - private final static String IN_SHOW_WAITING = "showWaiting"; - private final static String IN_SHOW_IN_SERVICE = "showInService"; - private final static String IN_SHOW_PENDING = "showPending"; - private final static String IN_SHOW_CANCELLED = "showCancelled"; - private final static String IN_SHOW_REJECTED = "showRejected"; - private final static String IN_SHOW_COMPLETED = "showCompleted"; - private final static String IN_MAXCOUNT = "maxCount"; - private final static String IN_TOTALCOUNT = "totalRecordCount"; - private final static String ON = "on"; - private final static String PROP_PARSER = "parser"; - - private final static String TPL_FILE = "queryReq.template"; - - private final static String OUT_SERVICE_URL = "serviceURL"; - private final static String OUT_OP = "op"; - private final static String OUT_MAXCOUNT = IN_MAXCOUNT; - private final static String OUT_TOTALCOUNT = IN_TOTALCOUNT; - private final static String OUT_CURRENTCOUNT = "currentRecordCount"; - private final static String OUT_SENTINEL_DOWN = "querySentinelDown"; - private final static String OUT_SHOW_COMPLETED = IN_SHOW_COMPLETED; - private final static String OUT_SEQNUM = "seqNum"; - private final static String OUT_STATUS = "status"; - private final static String OUT_CREATE_ON = "createdOn"; - private final static String OUT_UPDATE_ON = "updatedOn"; - private final static String OUT_UPDATE_BY = "updatedBy"; - private final static String OUT_REQUESTING_USER = "requestingUser"; - //keeps track of where to begin if page down - private final static String OUT_FIRST_ENTRY_ON_PAGE = "firstEntryOnPage"; - //keeps track of where to begin if page up - private final static String OUT_LAST_ENTRY_ON_PAGE = "lastEntryOnPage"; - private final static String OUT_SUBJECT = "subject"; - private final static String OUT_REQUEST_TYPE = "requestType"; - private final static String OUT_COMMENTS = "requestorComments"; - private final static String OUT_SERIALNO = "serialNumber"; - private final static String OUT_OWNER_NAME = "ownerName"; - private final static String OUT_PUBLIC_KEY_INFO = - "subjectPublicKeyInfo"; - private final static String OUT_ERROR = "error"; - private final static String OUT_AUTHORITY_ID = "authorityid"; - - // variables - private IReqParser mParser = null; - private IRequestQueue mQueue = null; - private String mFormPath = null; - private int mMaxReturns = 2000; - - public CMSRequest newCMSRequest() { - return new CMSRequest(); - } - - /** - * Constructor - */ - public QueryReq() { - super(); - } - - /** - * initialize the servlet. This servlet uses the template file - * "queryReq.template" to process the response. - * - * @param sc servlet configuration, read from the web.xml file - */ - public void init(ServletConfig sc) throws ServletException { - super.init(sc); - mQueue = mAuthority.getRequestQueue(); - mFormPath = "/" + mAuthority.getId() + "/" + TPL_FILE; - - try { - mMaxReturns = Integer.parseInt(sc.getInitParameter("maxResults")); - } catch (Exception e) { - /* do nothing, just use the default if integer parsing failed */ - } - - String tmp = sc.getInitParameter(PROP_PARSER); - - if (tmp != null) { - if (tmp.trim().equals("CertReqParser.NODETAIL_PARSER")) - mParser = CertReqParser.NODETAIL_PARSER; - else if (tmp.trim().equals("CertReqParser.DETAIL_PARSER")) - mParser = CertReqParser.DETAIL_PARSER; - else if (tmp.trim().equals("KeyReqParser.PARSER")) - mParser = KeyReqParser.PARSER; - } - - // override success and error templates to null - - // handle templates locally. - mTemplates.remove(CMSRequest.SUCCESS); - mTemplates.remove(CMSRequest.ERROR); - - if (mOutputTemplatePath != null) - mFormPath = mOutputTemplatePath; - } - - private String getRequestType(String p) { - String filter = "(requestType=*)"; - - if (p == null) - return filter; - if (p.equals(IRequest.ENROLLMENT_REQUEST)) { - filter = "(requestType=" + IRequest.ENROLLMENT_REQUEST + ")"; - } else if (p.equals(IRequest.RENEWAL_REQUEST)) { - filter = "(requestType=" + IRequest.RENEWAL_REQUEST + ")"; - } else if (p.equals(IRequest.REVOCATION_REQUEST)) { - filter = "(requestType=" + IRequest.REVOCATION_REQUEST + ")"; - } else if (p.equals(IRequest.UNREVOCATION_REQUEST)) { - filter = "(requestType=" + IRequest.UNREVOCATION_REQUEST + ")"; - } else if (p.equals(IRequest.KEYARCHIVAL_REQUEST)) { - filter = "(requestType=" + IRequest.KEYARCHIVAL_REQUEST + ")"; - } else if (p.equals(IRequest.KEYRECOVERY_REQUEST)) { - filter = "(requestType=" + IRequest.KEYRECOVERY_REQUEST + ")"; - } else if (p.equals(IRequest.GETCACHAIN_REQUEST)) { - filter = "(requestType=" + IRequest.GETCACHAIN_REQUEST + ")"; - } else if (p.equals(IRequest.GETREVOCATIONINFO_REQUEST)) { - filter = "(requestType=" + IRequest.GETREVOCATIONINFO_REQUEST + ")"; - } else if (p.equals(IRequest.GETCRL_REQUEST)) { - filter = "(requestType=" + IRequest.GETCRL_REQUEST + ")"; - } else if (p.equals(IRequest.GETCERTS_REQUEST)) { - filter = "(requestType=" + IRequest.GETCERTS_REQUEST + ")"; - } else if (p.equals(IRequest.NETKEY_KEYGEN_REQUEST)) { - filter = "(requestType=" + IRequest.NETKEY_KEYGEN_REQUEST + ")"; - } else if (p.equals(IN_SHOW_ALL)) { - filter = "(requestType=*)"; - } - return filter; - } - - private String getRequestState(String p) { - String filter = "(requeststate=*)"; - - if (p == null) - return filter; - if (p.equals(IN_SHOW_WAITING)) { - filter = "(requeststate=pending)"; - } else if (p.equals(IN_SHOW_IN_SERVICE)) { - filter = "(requeststate=svc_pending)"; - } else if (p.equals(IN_SHOW_PENDING)) { - filter = "(requeststate=pending)"; - } else if (p.equals(IN_SHOW_CANCELLED)) { - filter = "(requeststate=canceled)"; - } else if (p.equals(IN_SHOW_REJECTED)) { - filter = "(requeststate=rejected)"; - } else if (p.equals(IN_SHOW_COMPLETED)) { - filter = "(requeststate=complete)"; - } else if (p.equals(IN_SHOW_ALL)) { - filter = "(requeststate=*)"; - } - return filter; - } - - /** - * Process the HTTP request. - * <ul> - * <li>http.param reqState request state (one of showAll, showWaiting, showInService, showCancelled, showRejected, - * showCompleted) - * <li>http.param reqType - * <li>http.param seqNumFromDown request ID to start at (decimal, or hex if when paging down seqNumFromDown starts - * with 0x) - * <li>http.param seqNumFromUp request ID to start at (decimal, or hex if when paging up seqNumFromUp starts with - * 0x) - * <li>http.param maxCount maximum number of records to show - * <li>http.param totalCount total number of records in set of pages - * <li>http.param direction "up", "down", "begin", or "end" - * </ul> - * - * @param cmsReq the object holding the request and response information - */ - - public void process(CMSRequest cmsReq) throws EBaseException { - CMS.debug("in QueryReq servlet"); - - // Authentication / Authorization - - HttpServletRequest req = cmsReq.getHttpReq(); - IAuthToken authToken = authenticate(cmsReq); - AuthzToken authzToken = null; - - try { - authzToken = authorize(mAclMethod, authToken, - mAuthzResourceName, "list"); - } catch (EAuthzAccessDenied e) { - log(ILogger.LL_FAILURE, - CMS.getLogMessage("ADMIN_SRVLT_AUTH_FAILURE", e.toString())); - } catch (Exception e) { - log(ILogger.LL_FAILURE, - CMS.getLogMessage("ADMIN_SRVLT_AUTH_FAILURE", e.toString())); - } - if (authzToken == null) { - cmsReq.setStatus(CMSRequest.UNAUTHORIZED); - return; - } - - CMSTemplate form = null; - Locale[] locale = new Locale[1]; - - try { - // if get a EBaseException we just throw it. - form = getTemplate(mFormPath, req, locale); - } catch (IOException e) { - log(ILogger.LL_FAILURE, - CMS.getLogMessage("CMSGW_ERR_GET_TEMPLATE", mFormPath, e.toString())); - throw new ECMSGWException( - CMS.getUserMessage("CMS_GW_DISPLAY_TEMPLATE_ERROR")); - } - - /** - * WARNING: - * - * PLEASE DO NOT TOUCH THE FILTER HERE. ALL FILTERS ARE INDEXED. - * - **/ - String filter = null; - String reqState = req.getParameter("reqState"); - String reqType = req.getParameter("reqType"); - - if (reqState == null || reqType == null) { - filter = "(requeststate=*)"; - } else if (reqState.equals(IN_SHOW_ALL) && - reqType.equals(IN_SHOW_ALL)) { - filter = "(requeststate=*)"; - } else if (reqState.equals(IN_SHOW_ALL)) { - filter = getRequestType(reqType); - } else if (reqType.equals(IN_SHOW_ALL)) { - filter = getRequestState(reqState); - } else { - filter = "(&" + getRequestState(reqState) + - getRequestType(reqType) + ")"; - } - - String direction = "begin"; - if (req.getParameter("direction") != null) { - direction = req.getParameter("direction").trim(); - } - - BigInteger top = BigInteger.ZERO; - BigInteger bottom = BigInteger.ZERO; - - try { - String top_s = req.getParameter(OUT_FIRST_ENTRY_ON_PAGE); - if (top_s == null) - top_s = "0"; - - String bottom_s = req.getParameter(OUT_LAST_ENTRY_ON_PAGE); - if (bottom_s == null) - bottom_s = "0"; - - if (top_s.trim().startsWith("0x")) { - top = new BigInteger(top_s.trim().substring(2), 16); - } else { - top = new BigInteger(top_s.trim()); - } - if (bottom_s.trim().startsWith("0x")) { - bottom = new BigInteger(bottom_s.trim().substring(2), 16); - } else { - bottom = new BigInteger(bottom_s.trim()); - } - - } catch (NumberFormatException e) { - - } - - // avoid NumberFormatException to the user interface - int maxCount = 10; - try { - maxCount = Integer.parseInt(req.getParameter(IN_MAXCOUNT)); - } catch (Exception e) { - } - if (maxCount > mMaxReturns) { - CMS.debug("Resetting page size from " + maxCount + " to " + mMaxReturns); - maxCount = mMaxReturns; - } - - HttpServletResponse resp = cmsReq.getHttpResp(); - CMSTemplateParams argset = doSearch(locale[0], filter, maxCount, direction, top, bottom); - - argset.getFixed().addStringValue("reqType", reqType); - argset.getFixed().addStringValue("reqState", reqState); - argset.getFixed().addIntegerValue("maxCount", maxCount); - - try { - form.getOutput(argset); - resp.setContentType("text/html"); - form.renderOutput(resp.getOutputStream(), argset); - } catch (IOException e) { - log(ILogger.LL_FAILURE, - CMS.getLogMessage("CMSGW_ERR_STREAM_TEMPLATE", e.toString())); - throw new ECMSGWException( - CMS.getUserMessage("CMS_GW_DISPLAY_TEMPLATE_ERROR")); - } - cmsReq.setStatus(CMSRequest.SUCCESS); - return; - } - - /** - * Perform search based on direction button pressed - * - * @param filter ldap filter indicating which VLV to search through. This can be - * 'all requests', 'pending', etc - * @param count the number of requests to show per page - * @param direction either 'begin', 'end', 'previous' or 'next' (defaults to end) - * @param top the number of the request shown on at the top of the current page - * @param bottom the number of the request shown on at the bottom of the current page - * @return - */ - - private CMSTemplateParams doSearch(Locale l, String filter, - int count, String direction, BigInteger top, BigInteger bottom) { - CMSTemplateParams ctp = null; - if (direction.equals("previous")) { - ctp = doSearch(l, filter, -count, top); - } else if (direction.equals("next")) { - bottom = bottom.add(BigInteger.ONE); - ctp = doSearch(l, filter, count, bottom); - } else if (direction.equals("begin")) { - ctp = doSearch(l, filter, count, BigInteger.ZERO); - } else if (direction.equals("first")) { - ctp = doSearch(l, filter, count, bottom); - } else { // if 'direction is 'end', default here - ctp = doSearch(l, filter, -count, BigInteger.ONE.negate()); - } - return ctp; - } - - /** - * - * @param locale - * @param filter the types of requests to return - this must match the VLV index - * @param count maximum number of records to return - * @param marker indication of the request ID where the page is anchored - * @return - */ - - private CMSTemplateParams doSearch( - Locale locale, - String filter, - int count, - BigInteger marker) { - - IArgBlock header = CMS.createArgBlock(); - IArgBlock context = CMS.createArgBlock(); - CMSTemplateParams argset = new CMSTemplateParams(header, context); - - try { - long startTime = CMS.getCurrentDate().getTime(); - // preserve the type of request that we are - // requesting. - - header.addStringValue(OUT_AUTHORITY_ID, mAuthority.getId()); - header.addStringValue(OUT_REQUESTING_USER, "admin"); - - boolean jumptoend = false; - if (marker.toString().equals("-1")) { - marker = BigInteger.ZERO; // I think this is inconsequential - jumptoend = true; // override to '99' during search - } - - RequestId id = new RequestId(marker); - IRequestVirtualList list = mQueue.getPagedRequestsByFilter( - id, - jumptoend, - filter, - ((count < 0) ? count - 1 : count + 1), - "requestId"); - - int maxCount = 0; - if (count < 0 && jumptoend) { - maxCount = -count; - } else if (count < 0) { - maxCount = -count + 1; - } else { - maxCount = count; - } - int totalCount = (jumptoend) ? maxCount : - (list.getSize() - list.getCurrentIndex()); - header.addIntegerValue(OUT_TOTALCOUNT, totalCount); - header.addIntegerValue(OUT_CURRENTCOUNT, list.getSize()); - - Vector<IRequest> v = fetchRecords(list, maxCount); - v = normalizeOrder(v); - trim(v, id); - - int currentCount = 0; - BigInteger curNum = BigInteger.ZERO; - BigInteger firstNum = BigInteger.ONE.negate(); - Enumeration<IRequest> requests = v.elements(); - - while (requests.hasMoreElements()) { - IRequest request = null; - try { - request = requests.nextElement(); - } catch (Exception e) { - CMS.debug("Error displaying request:" + e.getMessage()); - // handled below - } - if (request == null) { - log(ILogger.LL_WARN, "Error display request on page"); - continue; - } - - curNum = new BigInteger(request.getRequestId().toString()); - - if (firstNum.equals(BigInteger.ONE.negate())) { - firstNum = curNum; - } - - IArgBlock rec = CMS.createArgBlock(); - mParser.fillRequestIntoArg(locale, request, argset, rec); - mQueue.releaseRequest(request); - argset.addRepeatRecord(rec); - - currentCount++; - - }// while - long endTime = CMS.getCurrentDate().getTime(); - - header.addIntegerValue(OUT_CURRENTCOUNT, currentCount); - header.addStringValue("time", Long.toString(endTime - startTime)); - header.addBigIntegerValue(OUT_FIRST_ENTRY_ON_PAGE, firstNum, 10); - header.addBigIntegerValue(OUT_LAST_ENTRY_ON_PAGE, curNum, 10); - - } catch (EBaseException e) { - header.addStringValue(OUT_ERROR, e.toString(locale)); - } catch (Exception e) { - } - return argset; - } - - /** - * If the vector contains the marker element at the end, remove it. - * - * @param v The vector to trim - * @param marker the marker to look for. - */ - private void trim(Vector<IRequest> v, RequestId marker) { - int i = v.size() - 1; - if (v.elementAt(i).getRequestId().toString().equals( - marker.toString())) { - v.remove(i); - } - } - - /** - * Sometimes the list comes back from LDAP in reverse order. This function makes - * sure the results are in 'forward' order. - * - * @param list - * @return - */ - private Vector<IRequest> fetchRecords(IRequestVirtualList list, int maxCount) { - - Vector<IRequest> v = new Vector<IRequest>(); - int count = list.getSize(); - int c = 0; - for (int i = 0; i < count; i++) { - IRequest request = list.getElementAt(i); - if (request != null) { - v.add(request); - c++; - } - if (c >= maxCount) - break; - } - - return v; - - } - - /** - * If the requests are in backwards order, reverse the list - * - * @param list - * @return - */ - private Vector<IRequest> normalizeOrder(Vector<IRequest> list) { - - BigInteger firstrequestnum = new BigInteger(list.elementAt(0) - .getRequestId().toString()); - BigInteger lastrequestnum = new BigInteger(list.elementAt(list - .size() - 1).getRequestId().toString()); - boolean reverse = false; - if (firstrequestnum.compareTo(lastrequestnum) > 0) { - reverse = true; // if the order is backwards, place items at the beginning - } - Vector<IRequest> v = new Vector<IRequest>(); - int count = list.size(); - for (int i = 0; i < count; i++) { - IRequest request = list.elementAt(i); - if (request != null) { - if (reverse) - v.add(0, request); - else - v.add(request); - } - } - - return v; - } -} |