/*
 * #!
 * Ontopia Navigator
 * #-
 * Copyright (C) 2001 - 2013 The Ontopia Project
 * #-
 * Licensed 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 net.ontopia.topicmaps.nav.conf;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** 
 * PUBLIC: Provides model, view and skin information for the application
 * 
 * <p>Implementors wanting to provide special models, view or skins
 * can implement their own version which may use the controller.xml
 * configuration file. The new class must implement ControlConfigIF.
 */
public class ControlConfig implements ControlConfigIF {

  // Define a logging category.
  static Logger log = LoggerFactory.getLogger(ControlConfig.class.getName());

  // defaults designed to be overriden by implementors
  String model = "simple";
  String view = "no_frames";
  String skin = "blue";
  
  // the get and set variables used by the jsp
  String modelPath;
  String viewPath;
  String skinPath;
  
  // derived from the M,V,S
  String behaviour;
  String contentType;
  
  // others
  String resource;

  /**
   * Constructor which takes a path to the configuration file.
   */
  public ControlConfig(String resource) {
    // should set the defaults from the file
    this.resource = resource;
    makePaths();
  }
  
  /**
   * Updates the state of the object to include user preferences.
   *
   * The application makes its own default model, view and skin for a particular
   * request. <code>userUpdate</code> allows the user preferences to be 
   * incorporated
   *
   * @param model   a string representing the model choice
   * @param view    a string representing the view choice
   * @param skin    a string representing the skin choice   
   */
  public void update(String model, String view, String skin) {
    if (model != null && !model.equals("")) this.model = model;
    if (view  != null && !view.equals(""))  this.view = view;
    if (skin  != null && !skin.equals(""))  this.skin = skin; 
    makePaths();
  }

  /**
   * Provides the internal logic for the object by making paths to the correct
   * model, view and skin given the application and user inputs. Called on 
   * construction and through ControlServlet when user updates preferences.
   */
  private void makePaths() {

    // fix dodgy path
    if (resource == null || resource.equals("/index.html")) 
      resource = "/index.jsp"; 
                
    // ModelPath
    if (resource.equals("/topic.jsp"))
      modelPath = "/models/topic_" + model + ".jsp";
    else if (resource.equals("/topicmap.jsp"))
      modelPath = "/models/topicmap_" + model + ".jsp";
    else
      modelPath = "/models" + resource;
   
    // ViewPath
    if (resource.equals("/def_topic_occ.jsp") || 
        resource.equals("/def_topicmap_occ.jsp") || 
        resource.equals("/blank.jsp"))
      viewPath = "/views/template_plain.jsp";
    else 
      viewPath = "/views/template_" + view + ".jsp";

    // SkinPath
    skinPath = "skins/" + skin + ".css";

    // Behaviour
    behaviour = "no_frames";
    if (view.equals("frames"))
      behaviour = "frames"; 
    
    // ContentType
    contentType = "text/html";
    if (view.equals("xml"))
      contentType = "text/xml";
  }

  
  // --- get methods
  public String getModelPath() { return modelPath; }
  public String getViewPath() { return viewPath; }
  public String getSkinPath() { return skinPath; }
  public String getBehaviour() { return behaviour; }
  public String getContentType() { return contentType; }  

  public String getModel() { return model; }
  public String getView() { return view; }
  public String getSkin() { return skin; }

}