Examples with IRequestParamContainer com.helger.web.scope.IRequestParamContainer used on opensource projects

Example 1 with IRequestParamContainer

use of com.helger.web.scope.IRequestParamContainer in project ph-web by phax.

the class RequestWebScope method initScope.

public final void initScope() {
    // Avoid double initialization of a scope, because for file uploads, the
    // parameters can only be extracted once!
    // As the parameters are stored directly in the HTTP request, we're not
    // loosing any data here!
    final IAttributeContainerAny<String> aAttrs = attrs();
    if (aAttrs.getAndSetFlag(REQUEST_ATTR_SCOPE_INITED)) {
        if (LOGGER.isWarnEnabled())
            LOGGER.warn("Scope was already inited: " + toString());
        return;
    }
    final IRequestParamContainer aParams = params();
    // where some extra items (like file items) handled?
    final boolean bAddedSpecialRequestParams = addSpecialRequestParams().isChanged();
    // Retrieve once (because locked)
    final IParamValueCleanser aParamValueCleanser = getParamValueCleanser();
    // set parameters as attributes (handles GET and POST parameters)
    // This may throw an exception, if the payload is invalid
    Enumeration<String> aEnum;
    try {
        aEnum = m_aHttpRequest.getParameterNames();
    } catch (final Exception ex) {
        aEnum = new EmptyEnumeration<>();
    }
    while (aEnum.hasMoreElements()) {
        final String sParamName = aEnum.nextElement();
        // String again
        if (bAddedSpecialRequestParams && aParams.containsKey(sParamName))
            continue;
        // Check if it is a single value or not
        final String[] aParamValues = m_aHttpRequest.getParameterValues(sParamName);
        final int nParamValues = aParamValues.length;
        if (nParamValues == 1) {
            // Convert from String[] to String
            String sValue = aParamValues[0];
            if (aParamValueCleanser != null) {
                // Adopt value if needed
                sValue = aParamValueCleanser.getCleanedValue(sParamName, 0, sValue);
            }
            aParams.putIn(sParamName, sValue);
        } else {
            // Use String[] as is
            final String[] aPreProcessedValues = new String[nParamValues];
            for (int i = 0; i < nParamValues; ++i) {
                String sValue = aParamValues[i];
                if (aParamValueCleanser != null) {
                    // Adopt value if needed
                    sValue = aParamValueCleanser.getCleanedValue(sParamName, i, sValue);
                }
                aPreProcessedValues[i] = sValue;
            }
            aParams.putIn(sParamName, aPreProcessedValues);
        }
    }
    // done initialization
    if (ScopeHelper.isDebugRequestScopeLifeCycle(LOGGER))
        if (LOGGER.isInfoEnabled())
            LOGGER.info("Initialized request web scope '" + getID() + "' of class " + ClassHelper.getClassLocalName(this), ScopeHelper.getDebugStackTrace());
}

Example 2 with IRequestParamContainer

use of com.helger.web.scope.IRequestParamContainer in project phoss-directory by phax.

the class PublicSearchXServletHandler method handleRequest.

public void handleRequest(@Nonnull final IRequestWebScopeWithoutResponse aRequestScope, @Nonnull final UnifiedResponse aUnifiedResponse) throws Exception {
    if (SearchRateLimit.INSTANCE.rateLimiter() != null) {
        final String sRateLimitKey = "ip:" + aRequestScope.getRemoteAddr();
        final boolean bOverLimit = SearchRateLimit.INSTANCE.rateLimiter().overLimitWhenIncremented(sRateLimitKey);
        if (bOverLimit) {
            // Too Many Requests
            if (LOGGER.isDebugEnabled())
                LOGGER.debug("REST search rate limit exceeded for " + sRateLimitKey);
            aUnifiedResponse.setStatus(CHttp.HTTP_TOO_MANY_REQUESTS);
            return;
        }
    }
    final IRequestParamContainer aParams = aRequestScope.params();
    // http://127.0.0.1:8080/search -> null
    // http://127.0.0.1:8080/search/ -> "/"
    // http://127.0.0.1:8080/search/x -> "/x"
    final String sPathInfo = StringHelper.getNotNull(aRequestScope.getPathInfo(), "");
    final ESearchVersion eSearchVersion = ESearchVersion.getFromPathInfoOrNull(sPathInfo);
    if (eSearchVersion == ESearchVersion.V1) {
        // Version 1.0
        // Determine output format
        final ICommonsList<String> aParts = StringHelper.getExploded('/', sPathInfo.substring(1));
        final String sFormat = aParts.getAtIndex(1);
        final EPDOutputFormat eOutputFormat = EPDOutputFormat.getFromIDCaseInsensitiveOrDefault(sFormat, EPDOutputFormat.XML);
        if (LOGGER.isDebugEnabled())
            LOGGER.debug("Using REST query API 1.0 with output format " + eOutputFormat + " (" + sPathInfo + ") from '" + aRequestScope.getUserAgent().getAsString() + "'");
        // Determine result offset and count
        final int nResultPageIndex = aParams.getAsInt(PARAM_RESULT_PAGE_INDEX, aParams.getAsInt("rpi", DEFAULT_RESULT_PAGE_INDEX));
        if (nResultPageIndex < 0) {
            LOGGER.error("ResultPageIndex " + nResultPageIndex + " is invalid. It must be >= 0.");
            aUnifiedResponse.setStatus(CHttp.HTTP_BAD_REQUEST);
            return;
        }
        final int nResultPageCount = aParams.getAsInt(PARAM_RESULT_PAGE_COUNT, aParams.getAsInt("rpc", DEFAULT_RESULT_PAGE_COUNT));
        if (nResultPageCount <= 0) {
            LOGGER.error("ResultPageCount " + nResultPageCount + " is invalid. It must be > 0.");
            aUnifiedResponse.setStatus(CHttp.HTTP_BAD_REQUEST);
            return;
        }
        final int nFirstResultIndex = nResultPageIndex * nResultPageCount;
        final int nLastResultIndex = (nResultPageIndex + 1) * nResultPageCount - 1;
        if (nFirstResultIndex > MAX_RESULTS) {
            LOGGER.error("The first result index " + nFirstResultIndex + " is invalid. It must be <= " + MAX_RESULTS + ".");
            aUnifiedResponse.setStatus(CHttp.HTTP_BAD_REQUEST);
            return;
        }
        if (nLastResultIndex > MAX_RESULTS) {
            LOGGER.error("The last result index " + nLastResultIndex + " is invalid. It must be <= " + MAX_RESULTS + ".");
            aUnifiedResponse.setStatus(CHttp.HTTP_BAD_REQUEST);
            return;
        }
        // Format output?
        final boolean bBeautify = aParams.getAsBoolean(PARAM_BEAUTIFY, false);
        // Determine query terms
        final StringBuilder aSBQueryString = new StringBuilder();
        final ICommonsMap<EPDSearchField, ICommonsList<String>> aQueryValues = new CommonsHashMap<>();
        for (final EPDSearchField eSF : EPDSearchField.values()) {
            final String sFieldName = eSF.getFieldName();
            // Check if one or more request parameters are present for the current
            // search field
            final ICommonsList<String> aValues = aParams.getAsStringList(sFieldName);
            if (aValues != null && aValues.isNotEmpty()) {
                aQueryValues.put(eSF, aValues);
                for (final String sValue : aValues) {
                    if (aSBQueryString.length() > 0)
                        aSBQueryString.append('&');
                    aSBQueryString.append(sFieldName).append('=').append(sValue);
                }
            }
        }
        if (aQueryValues.isEmpty()) {
            LOGGER.error("No valid query term provided!");
            aUnifiedResponse.setStatus(CHttp.HTTP_BAD_REQUEST);
            return;
        }
        if (LOGGER.isDebugEnabled())
            LOGGER.debug("Using the following query terms: " + aQueryValues);
        final ICommonsList<Query> aQueries = new CommonsArrayList<>();
        for (final Map.Entry<EPDSearchField, ICommonsList<String>> aEntry : aQueryValues.entrySet()) {
            final EPDSearchField eField = aEntry.getKey();
            for (final String sQuery : aEntry.getValue()) {
                final Query aQuery = eField.getQuery(sQuery);
                if (aQuery != null)
                    aQueries.add(aQuery);
                else
                    LOGGER.error("Failed to create query '" + sQuery + "' of field " + eField + " - ignoring term!");
            }
        }
        if (aQueries.isEmpty()) {
            LOGGER.error("No valid queries could be created!");
            aUnifiedResponse.setStatus(CHttp.HTTP_BAD_REQUEST);
            return;
        }
        // Build final query term
        Query aLuceneQuery;
        if (aQueries.size() == 1) {
            aLuceneQuery = aQueries.getFirst();
        } else {
            // Connect all with "AND"
            final BooleanQuery.Builder aBuilder = new BooleanQuery.Builder();
            for (final Query aQuery : aQueries) aBuilder.add(aQuery, Occur.MUST);
            aLuceneQuery = aBuilder.build();
        }
        // Only-non deleted
        aLuceneQuery = PDQueryManager.andNotDeleted(aLuceneQuery);
        // How many results to deliver at most
        final int nMaxResults = nLastResultIndex + 1;
        // Search all documents
        final PDStorageManager aStorageMgr = PDMetaManager.getStorageMgr();
        final ICommonsList<PDStoredBusinessEntity> aResultDocs = aStorageMgr.getAllDocuments(aLuceneQuery, nMaxResults);
        // Also get the total hit count for UI display. May be < 0 in case of
        // error
        final int nTotalBEs = aStorageMgr.getCount(aLuceneQuery);
        if (LOGGER.isDebugEnabled())
            LOGGER.debug("  Result for <" + aLuceneQuery + "> (max=" + nMaxResults + ") " + (nTotalBEs == 1 ? "is 1 document" : "are " + nTotalBEs + " documents"));
        // Filter by index/count
        final int nEffectiveLastIndex = Math.min(nLastResultIndex, aResultDocs.size() - 1);
        final List<PDStoredBusinessEntity> aResultView = nFirstResultIndex >= aResultDocs.size() ? Collections.emptyList() : aResultDocs.subList(nFirstResultIndex, nEffectiveLastIndex + 1);
        // Group results by participant ID
        final ICommonsMap<IParticipantIdentifier, ICommonsList<PDStoredBusinessEntity>> aGroupedDocs = PDStorageManager.getGroupedByParticipantID(aResultView);
        final ZonedDateTime aNow = PDTFactory.getCurrentZonedDateTimeUTC();
        // build result
        switch(eOutputFormat) {
            case XML:
                {
                    final XMLWriterSettings aXWS = new XMLWriterSettings().setIndent(bBeautify ? EXMLSerializeIndent.INDENT_AND_ALIGN : EXMLSerializeIndent.NONE);
                    final IMicroDocument aDoc = new MicroDocument();
                    final IMicroElement eRoot = aDoc.appendElement("resultlist");
                    eRoot.setAttribute(RESPONSE_VERSION, eSearchVersion.getVersion());
                    eRoot.setAttribute(RESPONSE_TOTAL_RESULT_COUNT, nTotalBEs);
                    eRoot.setAttribute(RESPONSE_USED_RESULT_COUNT, aResultView.size());
                    eRoot.setAttribute(RESPONSE_RESULT_PAGE_INDEX, nResultPageIndex);
                    eRoot.setAttribute(RESPONSE_RESULT_PAGE_COUNT, nResultPageCount);
                    eRoot.setAttribute(RESPONSE_FIRST_RESULT_INDEX, nFirstResultIndex);
                    eRoot.setAttribute(RESPONSE_LAST_RESULT_INDEX, nEffectiveLastIndex);
                    eRoot.setAttribute(RESPONSE_QUERY_TERMS, aSBQueryString.toString());
                    eRoot.setAttribute(RESPONSE_CREATION_DT, PDTWebDateHelper.getAsStringXSD(aNow));
                    for (final ICommonsList<PDStoredBusinessEntity> aPerParticipant : aGroupedDocs.values()) {
                        final IMicroElement eItem = PDStoredBusinessEntity.getAsSearchResultMicroElement(aPerParticipant);
                        eRoot.appendChild(eItem);
                    }
                    if (false) {
                        // Demo validation
                        final CollectingSAXErrorHandler aErrHdl = new CollectingSAXErrorHandler();
                        final Validator v = new XMLSchemaCache(aErrHdl).getValidator(new ClassPathResource("/schema/directory-search-result-list-v1.xsd"));
                        v.validate(TransformSourceFactory.create(MicroWriter.getNodeAsBytes(aDoc, aXWS)));
                        for (final IError aError : aErrHdl.getErrorList()) LOGGER.error(aError.getAsString(AppCommonUI.DEFAULT_LOCALE));
                    }
                    aUnifiedResponse.disableCaching();
                    aUnifiedResponse.setMimeType(eOutputFormat.getMimeType());
                    aUnifiedResponse.setContent(MicroWriter.getNodeAsBytes(aDoc, aXWS));
                    break;
                }
            case JSON:
                final JsonWriterSettings aJWS = new JsonWriterSettings().setIndentEnabled(bBeautify);
                final IJsonObject aDoc = new JsonObject();
                aDoc.add(RESPONSE_VERSION, eSearchVersion.getVersion());
                aDoc.add(RESPONSE_TOTAL_RESULT_COUNT, nTotalBEs);
                aDoc.add(RESPONSE_USED_RESULT_COUNT, aResultView.size());
                aDoc.add(RESPONSE_RESULT_PAGE_INDEX, nResultPageIndex);
                aDoc.add(RESPONSE_RESULT_PAGE_COUNT, nResultPageCount);
                aDoc.add(RESPONSE_FIRST_RESULT_INDEX, nFirstResultIndex);
                aDoc.add(RESPONSE_LAST_RESULT_INDEX, nEffectiveLastIndex);
                aDoc.add(RESPONSE_QUERY_TERMS, aSBQueryString.toString());
                aDoc.add(RESPONSE_CREATION_DT, PDTWebDateHelper.getAsStringXSD(aNow));
                final IJsonArray aMatches = new JsonArray();
                for (final ICommonsList<PDStoredBusinessEntity> aPerParticipant : aGroupedDocs.values()) {
                    final IJsonObject aItem = PDStoredBusinessEntity.getAsSearchResultJsonObject(aPerParticipant);
                    aMatches.add(aItem);
                }
                aDoc.addJson("matches", aMatches);
                aUnifiedResponse.disableCaching();
                aUnifiedResponse.setMimeType(eOutputFormat.getMimeType());
                aUnifiedResponse.setContentAndCharset(aDoc.getAsJsonString(aJWS), StandardCharsets.UTF_8);
                break;
            default:
                throw new IllegalStateException("Unsupported output format: " + eOutputFormat);
        }
    } else {
        LOGGER.error("Unsupported version provided (" + sPathInfo + ")");
        aUnifiedResponse.setStatus(CHttp.HTTP_NOT_FOUND);
    }
}