/**
    * Copyright 2011-2013 The Kuali Foundation Licensed under the Educational
    * Community 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.osedu.org/licenses/ECL-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.kuali.mobility.util;
  
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import javax.annotation.Resource;
  import javax.servlet.http.HttpServletRequest;
  
  import org.springframework.context.annotation.DependsOn;
  import org.springframework.stereotype.Component;
  
  /**
   * A bean used to help with localisation
   * @author Kuali Mobility Team (mobility.collab@kuali.org)
   * @since 
   */
  @Component(value="localisationUtil")
  @DependsOn(value={"supportedLanguages"})
  public class LocalisationUtil {
  
  	/**
  	 * A reference to the list of supported languages
  	 */
  	@Resource(name="supportedLanguages")
  	private List<String> supportedLanguages;
  	
  	/**
  	 * Returns a map of language code to String for that language
  	 * @param fieldName
  	 * @param request
  	 * @return
  	 */
  	public Map<String, String> getLocalisedString(String fieldName, HttpServletRequest request){
  		Map<String, String> fieldMap = new HashMap<String, String>();
  		
  		String value;
  		for(String language : this.supportedLanguages){
  			value = request.getParameter(fieldName + "." + language);
  			if(value != null){
  				fieldMap.put(language, value);
  			}
  		}
  		return fieldMap;
  	}
  	
  	/**
  	 * Gets the localised code for a field.
  	 * This is the code that is used in localised properties files, or as a key
  	 * for the database.
  	 * @param fieldName
  	 * @param request
  	 * @return
  	 */
  	public String getLocalisedStringCode(String fieldName, HttpServletRequest request){
  		String code = request.getParameter(fieldName + ".code");
  		return code == null ? generateNewCode() : code;
  	}
  	
  	/**
  	 * Gets the list of supported languages
  	 * @return
  	 */
  	public List<String> getSupportedLanguages(){
  		return Collections.unmodifiableList(supportedLanguages);
  	}
  	
  	/**
  	 * Returns true if the language is a language that we support.
  	 * @param language
  	 * @return
  	 */
  	public boolean isSupportedLanguage(String language){
  		return supportedLanguages.contains(language);
  	}
  	
  	/**
  	 * Generate a new
  	 * @return
  	 */
  	private String generateNewCode(){
  		// TODO use something better
  		return System.currentTimeMillis() + "";
  	}
 }