content: /*
   * Copyright (C) 2013 4th Line GmbH, Switzerland
   *
   * The contents of this file are subject to the terms of either the GNU
   * Lesser General Public License Version 2 or later ("LGPL") or the
   * Common Development and Distribution License Version 1 or later
   * ("CDDL") (collectively, the "License"). You may not use this file
   * except in compliance with the License. See LICENSE.txt for more
   * information.
   *
   * 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.
   */
  
  package org.fourthline.cling.support.contentdirectory.callback;
  
  import org.fourthline.cling.controlpoint.ActionCallback;
  import org.fourthline.cling.model.action.ActionException;
  import org.fourthline.cling.model.action.ActionInvocation;
  import org.fourthline.cling.model.meta.Service;
  import org.fourthline.cling.model.types.ErrorCode;
  import org.fourthline.cling.model.types.UnsignedIntegerFourBytes;
  import org.fourthline.cling.support.contentdirectory.DIDLParser;
  import org.fourthline.cling.support.model.DIDLContent;
  import org.fourthline.cling.support.model.SearchResult;
  import org.fourthline.cling.support.model.SortCriterion;
  
  import java.util.logging.Logger;
  
  /**
   * Invokes a "Search" action, parses the result.
   *
   * @author TK Kocheran &lt;rfkrocktk@gmail.com&gt;
   */
  public abstract class Search extends ActionCallback {
  
      public static final String CAPS_WILDCARD = "*";
  
      public enum Status {
          NO_CONTENT("No Content"),
          LOADING("Loading..."),
          OK("OK");
  
          private String defaultMessage;
  
          Status(String defaultMessage) {
              this.defaultMessage = defaultMessage;
          }
  
          public String getDefaultMessage() {
              return this.defaultMessage;
          }
      }
  
      private static Logger log = Logger.getLogger(Search.class.getName());
  
      /**
       * Search with first result 0 and {@link #getDefaultMaxResults()}, filters with {@link #CAPS_WILDCARD}.
       */
      public Search(Service service, String containerId, String searchCriteria) {
          this(service, containerId, searchCriteria, CAPS_WILDCARD, 0, null);
      }
  
      /**
       * @param maxResults Can be <code>null</code>, then {@link #getDefaultMaxResults()} is used.
       */
      public Search(Service service, String containerId, String searchCriteria, String filter,
                    long firstResult, Long maxResults, SortCriterion... orderBy) {
          super(new ActionInvocation(service.getAction("Search")));
  
          log.fine("Creating browse action for container ID: " + containerId);
  
          getActionInvocation().setInput("ContainerID", containerId);
          getActionInvocation().setInput("SearchCriteria", searchCriteria);
          getActionInvocation().setInput("Filter", filter);
          getActionInvocation().setInput("StartingIndex", new UnsignedIntegerFourBytes(firstResult));
          getActionInvocation().setInput(
                  "RequestedCount",
                  new UnsignedIntegerFourBytes(maxResults == null ? getDefaultMaxResults() : maxResults)
          );
          getActionInvocation().setInput("SortCriteria", SortCriterion.toString(orderBy));
      }
  
      @Override
      public void run() {
          updateStatus(Status.LOADING);
          super.run();
      }
  
      @Override
      public void success(ActionInvocation actionInvocation) {
          log.fine("Successful search action, reading output argument values");
  
          SearchResult result = new SearchResult(
                  actionInvocation.getOutput("Result").getValue().toString(),
                  (UnsignedIntegerFourBytes) actionInvocation.getOutput("NumberReturned").getValue(),
                  (UnsignedIntegerFourBytes) actionInvocation.getOutput("TotalMatches").getValue(),
                  (UnsignedIntegerFourBytes) actionInvocation.getOutput("UpdateID").getValue());
  
          boolean proceed = receivedRaw(actionInvocation, result);
  
          if (proceed && result.getCountLong() > 0 && result.getResult().length() > 0) {
              try {
                  DIDLParser didlParser = new DIDLParser();
                  DIDLContent didl = didlParser.parse(result.getResult());
                  received(actionInvocation, didl);
                  updateStatus(Status.OK);
              } catch (Exception ex) {
                  actionInvocation.setFailure(
                          new ActionException(ErrorCode.ACTION_FAILED, "Can't parse DIDL XML response: " + ex, ex)
                  );
                  failure(actionInvocation, null);
              }
          } else {
              received(actionInvocation, new DIDLContent());
              updateStatus(Status.NO_CONTENT);
          }
      }
  
      /**
       * Some media servers will crash if there is no limit on the maximum number of results.
       *
       * @return The default limit, 999.
       */
      public Long getDefaultMaxResults() {
          return 999L;
      }
  
      public boolean receivedRaw(ActionInvocation actionInvocation, SearchResult searchResult) {
          return true;
      }
  
      public abstract void received(ActionInvocation actionInvocation, DIDLContent didl);
  
      public abstract void updateStatus(Status status);
  }
  