org.alfresco.module.vti.web.fp.GetDocsMetaInfoMethod.java Source code

Introduction

Here is the source code for org.alfresco.module.vti.web.fp.GetDocsMetaInfoMethod.java

Source

/*
 * #%L
 * Alfresco Sharepoint Protocol
 * %%
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 * %%
 * This file is part of the Alfresco software. 
 * If the software was purchased under a paid Alfresco license, the terms of 
 * the paid license agreement will prevail.  Otherwise, the software is 
 * provided under the following open source license terms:
 * 
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Alfresco 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */
package org.alfresco.module.vti.web.fp;

import java.io.IOException;
import java.net.URI;
import java.util.LinkedList;
import java.util.List;

import org.alfresco.module.vti.handler.VtiHandlerException;
import org.alfresco.module.vti.metadata.model.DocMetaInfo;
import org.alfresco.module.vti.metadata.model.DocsMetaInfo;
import org.alfresco.module.vti.web.VtiEncodingUtils;
import org.apache.commons.httpclient.URIException;
import org.apache.commons.httpclient.util.URIUtil;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Class for handling "getDocsMetaInfo" method
 *
 * @author PavelYur
 */
public class GetDocsMetaInfoMethod extends AbstractMethod {
    private static Log logger = LogFactory.getLog(GetDocsMetaInfoMethod.class);

    /**
     * Provides the meta-information for the files in the current Web site
     *
     * @param request Vti Frontpage request ({@link VtiFpRequest})
     * @param response Vti Frontpage response ({@link VtiFpResponse}) 
     */
    protected void doExecute(VtiFpRequest request, VtiFpResponse response) throws VtiMethodException, IOException {
        if (logger.isDebugEnabled()) {
            logger.debug("Start method execution. Method name: " + getName());
        }

        String serviceName = request.getParameter("service_name", "");
        boolean listHiddenDocs = request.getParameter("listHiddenDocs", false);
        boolean listLinkInfo = request.getParameter("listLinkInfo", false);
        boolean validateWelcomeNames = request.getParameter("validateWelcomeNames", false);
        List<String> urlList = request.getParameter("url_list", new LinkedList<String>());
        String context = request.getAlfrescoContextName();

        String uri = request.getRequestURI();
        int pos = uri.indexOf("/_vti_bin");
        if (pos != -1 && (context.length() + 1) < pos) {
            serviceName = uri.substring(context.length() + 1, pos);
        } else {
            serviceName = "";
        }

        for (int i = 0; i < urlList.size(); ++i) {
            String url = urlList.get(i);
            String path = URIUtil.getPath(url);
            if (urlIsAbsolute(url)) {
                // Remove context path
                path = path.substring(context.length());

                if (path.length() > 1 && path.startsWith("/")) {
                    // Remove preceding slash if one exists.
                    path = path.substring(1);
                }
                if (path.startsWith(serviceName)) {
                    path = path.substring(serviceName.length());
                }
                if (path.length() > 1 && path.startsWith("/")) {
                    // ALF-19851 fix, remove preceding slash if one exists after removing serviceName.
                    path = path.substring(1);
                }
                urlList.set(i, path);
            }
        }
        DocsMetaInfo docsMetaInfoList;
        try {
            docsMetaInfoList = vtiHandler.getDocsMetaInfo(serviceName, listLinkInfo, validateWelcomeNames,
                    listHiddenDocs, urlList);
        } catch (VtiHandlerException e) {
            throw new VtiMethodException(e);
        }

        response.beginVtiAnswer(getName(), ServerVersionMethod.version);

        List<DocMetaInfo> fileMetaInfoList = docsMetaInfoList.getFileMetaInfoList();
        response.beginList("document_list");
        for (DocMetaInfo docMetaInfo : fileMetaInfoList) {
            response.beginList();
            response.addParameter("document_name", VtiEncodingUtils.encode(docMetaInfo.getPath()));
            response.beginList("meta_info");
            processDocMetaInfo(docMetaInfo, request, response);
            response.endList();
            response.endList();
        }
        response.endList();

        List<DocMetaInfo> folderMetaInfoList = docsMetaInfoList.getFolderMetaInfoList();
        response.beginList("urldirs");
        for (DocMetaInfo docMetaInfo : folderMetaInfoList) {
            response.beginList();
            response.addParameter("url", VtiEncodingUtils.encode(docMetaInfo.getPath()));
            response.beginList("meta_info");
            processDocMetaInfo(docMetaInfo, request, response);
            response.endList();
            response.endList();
        }
        response.endList();

        List<DocMetaInfo> failedUrls = docsMetaInfoList.getFailedUrls();
        if (!failedUrls.isEmpty()) {
            response.beginList("failedUrls");
            for (DocMetaInfo docMetaInfo : failedUrls) {
                response.addParameter(VtiEncodingUtils.encode(docMetaInfo.getPath()));
            }
            response.endList();
        }
        response.endVtiAnswer();

        if (logger.isDebugEnabled()) {
            logger.debug("End of method execution. Method name: " + getName());
        }
    }

    private boolean urlIsAbsolute(String url) {
        String pathEncodedURL;
        try {
            // Encode the path part of since this may have spaces in it, for example. 
            pathEncodedURL = URIUtil.encodePath(url, "UTF-8");
        } catch (URIException error) {
            throw new IllegalArgumentException("Invalid URL: " + url, error);
        }
        URI uriObj = URI.create(pathEncodedURL);
        return uriObj.isAbsolute();
    }

    /**
     * returns methods name
     */
    public String getName() {
        return "getDocsMetaInfo";
    }

}