*

* Part of the InfoGlue Content Management Platform (www.infoglue.org)

*

* ===============================================================================

*

*  Copyright (C)

*

* This program is free software; you can redistribute it and/or modify it under

* the terms of the GNU General Public License version 2, as published by the

* Free Software Foundation. See the file LICENSE.html for more information.

*

* This program is distributed in the hope that it will be useful, but WITHOUT

* ANY WARRANTY, including 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. / 59 Temple

* Place, Suite 330 / Boston, MA 02111-1307 / USA.

*

* ===============================================================================

*/

    private final static Logger logger = Logger.getLogger(NodeDeliveryController.class.getName());

  private URLComposer urlComposer = null;

    protected static final String META_INFO_BINDING_NAME         = "Meta information";

    protected static final String NAV_TITLE_ATTRIBUTE_NAME          = "NavigationTitle";

  private static final boolean USE_INHERITANCE = true;

  private static final boolean DO_NOT_USE_INHERITANCE = false; 

 

  protected static final Integer NO       = new Integer(0);

  protected static final Integer YES       = new Integer(1);

  protected static final Integer INHERITED   = new Integer(2);

  private Integer siteNodeId = null;

  private Integer languageId = null;

  private Integer contentId   = null;

 

  protected DeliveryContext deliveryContext = null;

 

  public void setDeliveryContext(DeliveryContext deliveryContext)

  {

    this.deliveryContext = deliveryContext;

  }

 

  /**

   * Private constructor to enforce factory-use

   */

 

  private NodeDeliveryController(Integer siteNodeId, Integer languageId, Integer contentId, DeliveryContext deliveryContext) throws SystemException, Exception

  {

    this.siteNodeId = siteNodeId;

    this.languageId = languageId;

    this.contentId  = contentId;

    this.urlComposer = URLComposer.getURLComposer();

    this.deliveryContext = deliveryContext;

  }

 

  /**

   * Factory method

   */

  public static NodeDeliveryController getNodeDeliveryController(Integer siteNodeId, Integer languageId, Integer contentId) throws SystemException, Exception

  {

    return new NodeDeliveryController(siteNodeId, languageId, contentId, null);

  }

  public static NodeDeliveryController getNodeDeliveryController(Integer siteNodeId, Integer languageId, Integer contentId, DeliveryContext deliveryContext) throws SystemException, Exception

  {

    return new NodeDeliveryController(siteNodeId, languageId, contentId, deliveryContext);

  }

  /**

   * Factory method

   */

 

  public static NodeDeliveryController getNodeDeliveryController(DeliveryContext deliveryContext) throws SystemException, Exception

  {

    return new NodeDeliveryController(deliveryContext.getSiteNodeId(), deliveryContext.getLanguageId(), deliveryContext.getContentId(), deliveryContext);

  }

  /**

   * This method returns which mode the delivery-engine is running in.

   * The mode is important to be able to show working, preview and published data separate.

   */

 

  private Integer getOperatingMode()

  {

    Integer operatingMode = new Integer(0); //Default is working

    try

    {

      operatingMode = new Integer(CmsPropertyHandler.getOperatingMode());

      //logger.info("Operating mode is:" + operatingMode);

    }

    catch(Exception e)

    {

      logger.warn("We could not get the operating mode from the propertyFile:" + e.getMessage(), e);

    }

    return operatingMode;

  }

 

  /**

   * This method gets the appropriate siteNodeVersion

   */

  public SiteNodeVersionVO getActiveSiteNodeVersionVO(Database db, Integer siteNodeId) throws Exception

  {

    SiteNodeVersionVO siteNodeVersionVO = null;

   

    SiteNodeVersion siteNodeVersion = getActiveSiteNodeVersion(siteNodeId, db);

    if(siteNodeVersion != null)

      siteNodeVersionVO = siteNodeVersion.getValueObject();

   

    return siteNodeVersionVO;

  }

 

  /**

   * This method gets the appropriate siteNodeVersion

   */

 

  public SiteNodeVersion getActiveSiteNodeVersion(Integer siteNodeId, Database db) throws Exception

  {

    SiteNodeVersion siteNodeVersion = null;

   

    SiteNode siteNode = (SiteNode)this.getObjectWithId(SiteNodeImpl.class, siteNodeId, db);

    logger.info("Loaded siteNode " + siteNode.getName());

    Collection siteNodeVersions = siteNode.getSiteNodeVersions();

    logger.info("Loaded versions " + siteNodeVersions.size());

   

    Iterator versionIterator = siteNodeVersions.iterator();

    while(versionIterator.hasNext())

    {

      SiteNodeVersion siteNodeVersionCandidate = (SiteNodeVersion)versionIterator.next(); 

      logger.info("SiteNodeVersionCandidate " + siteNodeVersionCandidate.getId());

      if(siteNodeVersionCandidate.getIsActive().booleanValue() && siteNodeVersionCandidate.getStateId().intValue() >= getOperatingMode().intValue())

      {

        if(siteNodeVersionCandidate.getOwningSiteNode().getSiteNodeId().intValue() == siteNodeId.intValue())

        {

          if(siteNodeVersion == null || siteNodeVersion.getSiteNodeVersionId().intValue() < siteNodeVersionCandidate.getId().intValue())

          {

            siteNodeVersion = siteNodeVersionCandidate;

          }

        }

      }

    }

   

    return siteNodeVersion;

  }

 

  /**

   * This method checks if there is a serviceBinding with the name on this or any parent node.

   */

 

  public ServiceDefinitionVO getInheritedServiceDefinition(List qualifyerList, Integer siteNodeId, AvailableServiceBindingVO availableServiceBindingVO, Database db, boolean inheritParentBindings) throws SystemException, Exception

  {

    ServiceDefinitionVO serviceDefinitionVO = null;

   

    if(siteNodeId == null || siteNodeId.intValue() <= 0)

      return serviceDefinitionVO;

    logger.info("Trying to find binding " + availableServiceBindingVO + " on siteNodeId:" + siteNodeId);

    SiteNode siteNode = (SiteNode)this.getObjectWithId(SmallSiteNodeImpl.class, siteNodeId, db);

    logger.info("Loaded siteNode " + siteNode.getName());

    serviceDefinitionVO = getServiceDefinitionVO(qualifyerList, siteNode, availableServiceBindingVO, db);

    logger.info("Loaded serviceDefinitionVO " + serviceDefinitionVO);

   

    if(serviceDefinitionVO == null)

    {

      //We check if the available service definition state that this is a inheritable binding             

      //AvailableServiceBinding availableServiceBinding = getAvailableServiceBindingRecursive(siteNodeVersion.getOwningSiteNode(), availableServiceBindingName, inheritParentBindings);

      if(availableServiceBindingVO != null && availableServiceBindingVO.getIsInheritable().booleanValue() && inheritParentBindings)

          {

              logger.info("No binding found - lets try the parent.");

              SiteNode parent = siteNode.getParentSiteNode();

              if(parent != null)

                  serviceDefinitionVO = getInheritedServiceDefinition(qualifyerList, parent.getSiteNodeId(), availableServiceBindingVO, db, inheritParentBindings);

          }

    }

   

    logger.info("Loaded serviceDefinitionVO end...");

   

    return serviceDefinitionVO;

  }

 

  private ServiceDefinitionVO getServiceDefinitionVO(List qualifyerList, SiteNode siteNode, AvailableServiceBindingVO availableServiceBindingVO, Database db) throws Exception

  {

      ServiceDefinitionVO serviceDefinitionVO = null;

      //ServiceBinding serviceBinding = null;

   

      String key = "" + siteNode.getSiteNodeId() + "_" + availableServiceBindingVO.getId();

    logger.info("key:" + key);

    Object object = CacheController.getCachedObject("serviceDefinitionCache", key);

    Object object2 = CacheController.getCachedObject("qualifyerListCache", key);

    if(object != null && object2 != null)

    {

      logger.info("There was an cached ServiceDefinitionVO:" + object);

      if(object instanceof ServiceDefinitionVO)

          serviceDefinitionVO = (ServiceDefinitionVO)object;

      if(object2 instanceof List)

          qualifyerList.addAll((List)object2);

    }

    else

    {

        OQLQuery oql = db.getOQLQuery( "SELECT sb FROM org.infoglue.cms.entities.structure.impl.simple.ServiceBindingImpl sb WHERE sb.siteNodeVersion.owningSiteNode = $1 AND sb.availableServiceBinding = $2 AND sb.siteNodeVersion.isActive = $3 AND sb.siteNodeVersion.stateId >= $4 order by sb.siteNodeVersion.siteNodeVersionId DESC");

      oql.bind(siteNode);

      oql.bind(availableServiceBindingVO.getId());

      oql.bind(new Boolean(true));

      oql.bind(getOperatingMode());

     

        QueryResults results = oql.execute(Database.READONLY);

      if (results.hasMore())

          {

        ServiceBinding serviceBinding = (ServiceBinding)results.next();

        SiteNodeVersionVO latestSiteNodeVersionVO = getLatestActiveSiteNodeVersionVO(db, siteNode.getId());

        logger.info("serviceBinding sitenodeVersion:" + serviceBinding.getSiteNodeVersion().getId() + ":" + latestSiteNodeVersionVO.getId());

        if(serviceBinding.getSiteNodeVersion().getId().equals(latestSiteNodeVersionVO.getId()))

        {

          serviceDefinitionVO = serviceBinding.getServiceDefinition().getValueObject();

              Collection qualifyers = serviceBinding.getBindingQualifyers();

         

          qualifyers = sortQualifyers(qualifyers);

         

          Iterator iterator = qualifyers.iterator();

          while(iterator.hasNext())

          {

            Qualifyer qualifyer = (Qualifyer)iterator.next();

            HashMap argument = new HashMap();

            argument.put(qualifyer.getName(), qualifyer.getValue());

            qualifyerList.add(argument);

          }

             

              object = serviceDefinitionVO;

              object2 = qualifyerList;

        }

          }

      else

      {

          object = new NullObject();

          object2 = new NullObject();

      }

     

     

      results.close();

      oql.close();

      CacheController.cacheObject("serviceDefinitionCache", key, object);

      CacheController.cacheObject("qualifyerListCache", key, object2);

    }

     

     

    /*

      Collection serviceBindings = siteNodeVersion.getServiceBindings();

    Iterator serviceBindingIterator = serviceBindings.iterator();

    while(serviceBindingIterator.hasNext())

    {

      ServiceBinding serviceBindingCandidate = (ServiceBinding)serviceBindingIterator.next();

      //logger.warn("siteNodeVersion " + siteNodeVersion.getId());

      if(serviceBindingCandidate.getAvailableServiceBinding().getAvailableServiceBindingId().intValue() == availableServiceBindingVO.getId().intValue())

      //if(serviceBindingCandidate.getValueObject().getAvailableServiceBindingId().intValue() == availableServiceBindingVO.getId().intValue())

      {

        serviceBinding = serviceBindingCandidate;

      }

    }

    */

   

    return serviceDefinitionVO;

  }

 

  /**

   * This method fetches an available service binding as long as there is one associated with this site nodes type definition or any

   * of the parent site node type definitions.

   */

 

  private AvailableServiceBinding getAvailableServiceBindingRecursive(SiteNode siteNode, String availableServiceBindingName, boolean inheritParentBindings)

  {

    if(siteNode == null || availableServiceBindingName == null)

      return null;

   

    AvailableServiceBinding availableServiceBinding = null;

   

    SiteNodeTypeDefinition siteNodeTypeDefinition = siteNode.getSiteNodeTypeDefinition();

    if(siteNodeTypeDefinition != null)

    {

      Collection availableServiceBindings = siteNodeTypeDefinition.getAvailableServiceBindings();

     

      Iterator availableServiceBindingsIterator = availableServiceBindings.iterator();

      while(availableServiceBindingsIterator.hasNext())

      {

        AvailableServiceBinding currentAvailableServiceBinding = (AvailableServiceBinding)availableServiceBindingsIterator.next();

        if(currentAvailableServiceBinding.getName().equalsIgnoreCase(availableServiceBindingName))

        {

          availableServiceBinding = currentAvailableServiceBinding;

        }

      }

    }

       

    if(availableServiceBinding == null)

      availableServiceBinding = getAvailableServiceBindingRecursive(siteNode.getParentSiteNode(), availableServiceBindingName, inheritParentBindings);

     

    return availableServiceBinding;

  } 

 

  /**

   * This method returns the SiteNodeVO that is sent in.

   */

  /*

  public SiteNode getSiteNode(Database db, Integer siteNodeId) throws SystemException

  {

    if(siteNodeId == null || siteNodeId.intValue() < 1)

      return null;

   

    SiteNode siteNode = null;

   

    siteNode = (SiteNode)getObjectWithId(SiteNodeImpl.class, siteNodeId, db);

   

    if(siteNode != null && deliveryContext != null)

      deliveryContext.addUsedSiteNode(CacheController.getPooledString(3, siteNode.getId()));

    return siteNode;

  }

  */

  /**

   * This method returns the SiteNodeVO that is sent in.

   */

 

  public SiteNodeVO getSiteNodeVO(Database db, Integer siteNodeId) throws SystemException, Exception

  {

    if(siteNodeId == null || siteNodeId.intValue() < 1)

      return null;

    if(deliveryContext != null)

      deliveryContext.addUsedSiteNode(CacheController.getPooledString(3, siteNodeId));

    SiteNodeVO siteNodeVO = SiteNodeController.getController().getSiteNodeVOWithId(siteNodeId, db);

   

    if(siteNodeVO.getIsDeleted())

      return null;

   

    return siteNodeVO;

  }

  /**

   * This method returns the latest sitenodeVersion there is for the given siteNode.

   */

 

  public SiteNodeVersionVO getLatestActiveSiteNodeVersionVO(Database db, Integer siteNodeId) throws SystemException, Exception

  {

    String key = "" + siteNodeId;

    logger.info("key:" + key);

    SiteNodeVersionVO siteNodeVersionVO = (SiteNodeVersionVO)CacheController.getCachedObjectFromAdvancedCache("latestSiteNodeVersionCache", key);