/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
    *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  package org.apache.chemistry.opencmis.server.impl.atompub;
  
  import static org.apache.chemistry.opencmis.commons.impl.CollectionsHelper.isNullOrEmpty;
  
  import java.util.List;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  import org.apache.chemistry.opencmis.commons.data.ObjectData;
  import org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException;
  import org.apache.chemistry.opencmis.commons.impl.Constants;
  import org.apache.chemistry.opencmis.commons.impl.UrlBuilder;
  import org.apache.chemistry.opencmis.commons.server.CallContext;
  import org.apache.chemistry.opencmis.commons.server.CmisService;
  import org.apache.chemistry.opencmis.commons.server.ObjectInfo;
  import org.apache.chemistry.opencmis.commons.spi.Holder;
  import org.apache.chemistry.opencmis.server.shared.TempStoreOutputStreamFactory;
  
  /**
   * Versioning Service operations.
   */
  public class VersioningService {
  
      /**
       * Check Out.
       */
      public static class CheckOut extends AbstractAtomPubServiceCall {
          @Override
          public void serve(CallContext context, CmisService service, String repositoryId, HttpServletRequest request,
                  HttpServletResponse response) throws Exception {
              assert context != null;
              assert service != null;
              assert repositoryId != null;
              assert request != null;
              assert response != null;
  
              // get parameters
              TempStoreOutputStreamFactory streamFactory = (TempStoreOutputStreamFactory) context
                      .get(CallContext.STREAM_FACTORY);
              AtomEntryParser parser = new AtomEntryParser(streamFactory);
              parser.setIgnoreAtomContentSrc(true); // needed for some clients
              parser.parse(request.getInputStream());
  
              // execute
              Holder<String> checkOutId = new Holder<String>(parser.getId());
              try {
                  if (stopBeforeService(service)) {
                      return;
                  }
  
                  service.checkOut(repositoryId, checkOutId, null, null);
  
                  if (stopAfterService(service)) {
                      return;
                  }
              } finally {
                  parser.release();
              }
  
              ObjectInfo objectInfo = service.getObjectInfo(repositoryId, checkOutId.getValue());
              if (objectInfo == null) {
                  throw new CmisRuntimeException("Object Info is missing!");
              }
  
              ObjectData object = objectInfo.getObject();
              if (object == null) {
                  throw new CmisRuntimeException("Object is null!");
              }
  
              if (object.getId() == null) {
                  throw new CmisRuntimeException("Object Id is null!");
              }
  
              // set headers
              UrlBuilder baseUrl = compileBaseUrl(request, repositoryId);
              String location = compileUrl(baseUrl, RESOURCE_ENTRY, object.getId());
  
              response.setStatus(HttpServletResponse.SC_CREATED);
              response.setContentType(Constants.MEDIATYPE_ENTRY);
              response.setHeader("Content-Location", location);
             response.setHeader("Location", location);
 
             // write XML
             AtomEntry entry = new AtomEntry();
             entry.startDocument(response.getOutputStream(), getNamespaces(service));
             writeObjectEntry(service, entry, object, null, repositoryId, null, null, baseUrl, true,
                     context.getCmisVersion());
             entry.endDocument();
         }
     }
 
     /**
      * Get all versions.
      */
     public static class GetAllVersions extends AbstractAtomPubServiceCall {
         @Override
         public void serve(CallContext context, CmisService service, String repositoryId, HttpServletRequest request,
                 HttpServletResponse response) throws Exception {
             assert context != null;
             assert service != null;
             assert repositoryId != null;
             assert request != null;
             assert response != null;
 
             // get parameters
             String objectId = getStringParameter(request, Constants.PARAM_ID);
             String versionSeriesId = getStringParameter(request, Constants.PARAM_VERSION_SERIES_ID);
             String filter = getStringParameter(request, Constants.PARAM_FILTER);
             Boolean includeAllowableActions = getBooleanParameter(request, Constants.PARAM_ALLOWABLE_ACTIONS);
 
             // execute
             if (stopBeforeService(service)) {
                 return;
             }
 
             List<ObjectData> versions = service.getAllVersions(repositoryId, objectId, versionSeriesId, filter,
                     includeAllowableActions, null);
 
             if (stopAfterService(service)) {
                 return;
             }
 
             if (isNullOrEmpty(versions)) {
                 throw new CmisRuntimeException("Version list is null or empty!");
             }
 
             // set headers
             response.setStatus(HttpServletResponse.SC_OK);
             response.setContentType(Constants.MEDIATYPE_FEED);
 
             // write XML
             AtomFeed feed = new AtomFeed();
             feed.startDocument(response.getOutputStream(), getNamespaces(service));
             feed.startFeed(true);
 
             // write basic Atom feed elements
             ObjectInfo latestObjectInfo = service.getObjectInfo(repositoryId, versions.get(0).getId());
             ObjectInfo firstObjectInfo = service.getObjectInfo(repositoryId, versions.get(versions.size() - 1).getId());
 
             feed.writeFeedElements(versionSeriesId, null, firstObjectInfo.getCreatedBy(), latestObjectInfo.getName(),
                     latestObjectInfo.getLastModificationDate(), null, null);
 
             // write links
             UrlBuilder baseUrl = compileBaseUrl(request, repositoryId);
 
             feed.writeServiceLink(baseUrl.toString(), repositoryId);
 
             if (objectId != null) {
                 feed.writeViaLink(compileUrl(baseUrl, RESOURCE_ENTRY, objectId));
             }
 
             // write entries
             AtomEntry entry = new AtomEntry(feed.getWriter());
             for (ObjectData object : versions) {
                 if (object == null) {
                     continue;
                 }
                 writeObjectEntry(service, entry, object, null, repositoryId, null, null, baseUrl, false,
                         context.getCmisVersion());
             }
 
             // we are done
             feed.endFeed();
             feed.endDocument();
         }
     }
 
     /**
      * Delete object.
      */
     public static class DeleteAllVersions extends AbstractAtomPubServiceCall {
         @Override
         public void serve(CallContext context, CmisService service, String repositoryId, HttpServletRequest request,
                 HttpServletResponse response) throws Exception {
             assert context != null;
             assert service != null;
             assert repositoryId != null;
             assert request != null;
             assert response != null;
 
             // get parameters
             String objectId = getStringParameter(request, Constants.PARAM_ID);
 
             // execute
             if (stopBeforeService(service)) {
                 return;
             }
 
             service.deleteObjectOrCancelCheckOut(repositoryId, objectId, Boolean.TRUE, null);
 
             if (stopAfterService(service)) {
                 return;
             }
 
             // set headers
             response.setStatus(HttpServletResponse.SC_NO_CONTENT);
         }
     }
 }