/**
    * This file Copyright (c) 2013 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.i18nsystem.tools;
  
  import info.magnolia.i18nsystem.I18nable;
  import info.magnolia.i18nsystem.I18nText;
  import info.magnolia.i18nsystem.proxytoys.MethodsAnnotatedWith;
  import info.magnolia.i18nsystem.proxytoys.ProxytoysI18nizer;
  import info.magnolia.i18nsystem.proxytoys.ReturnsAnnotatedTypeArgument;
  
  import java.lang.reflect.InvocationTargetException;
  import java.lang.reflect.Method;
  import java.util.Collection;
  import java.util.Locale;
  import java.util.Map;
  import java.util.Set;
  
  import net.sf.cglib.proxy.Enhancer;
  
  import org.reflections.ReflectionUtils;
  
  /**
   * THIS IS A PROTOTYPE.
   * Sample usage in Groovy:
   * <pre>
   * g = new info.magnolia.i18nsystem.tools.GenerateTranslationFilesImpl()
   * manClass = info.magnolia.ui.api.app.registry.AppDescriptorRegistry.class
   * man = info.magnolia.objectfactory.Components.getSingleton(manClass)
   *
   * apps = man.getAppDescriptors()
   * apps.each { app -> res = g.generateFor(app,null,null); res.actions.each { println it.dump() }; println '' }
   * </pre>
   *
   * Tools could also (potentially) do:
   * * manage bootstrap files (load objects off of them, modify them, ...)
   * * inspect objects and report duplicate keys, unused keys, ...
   */
  public class GenerateTranslationFilesImpl {
      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(GenerateTranslationFilesImpl.class);
  
      /**
       * @param o
       * @param jcrPath
       * @param jcrPathForBootstrapFile if the bootstrap file contains parent objects
       */
      public GeneratorResults generateFor(Locale locale, Object o) throws InvocationTargetException, IllegalAccessException {
          final GeneratorResults genRes = new GeneratorResults(locale);
  
          // inspect object
          final ProxytoysI18nizer i18nizer = new ToolingProxytoysI18nizer(genRes, locale, new NullTranslationService());
          final Object root = i18nizer.decorate(o);
          inspect(root);
  
          // modify bootstrap file (or reexport)
          // generate update task (code or config file ?)
          return genRes;
      }
  
      private void inspect(Collection c) throws InvocationTargetException, IllegalAccessException {
          for (Object o : c) {
              inspect(o);
          }
      }
  
      private void inspect(Object obj) throws InvocationTargetException, IllegalAccessException {
          Class clazz = obj.getClass();
          while (Enhancer.isEnhanced(clazz)) {
              clazz = clazz.getSuperclass();
         }
 
         final Set<Method> textMethods = ReflectionUtils.getMethods(clazz, new MethodsAnnotatedWith(I18nText.class));
         final Set<Method> childMethods = ReflectionUtils.getMethods(clazz, new ReturnsAnnotatedTypeArgument(I18nable.class));
         for (Method textMethod : textMethods) {
             log.info("Visiting textMethod: " + textMethod.getDeclaringClass().getSimpleName() + "." + textMethod.getName());
             textMethod.invoke(obj);
         }
 
         for (Method childMethod : childMethods) {
             // Currently we only support "single", collection and map-values. Anything else isn't going through the proxies anyway.
             // TODO Treat null entries in maps, collections and "simple" getters ?
             final Class<?> returnType = childMethod.getReturnType();
             if (Map.class.isAssignableFrom(returnType)) {
                 log.info("Visiting map values of child method " + childMethod.getDeclaringClass().getSimpleName() + "." + childMethod.getName() + "()");
                 inspect(((Map) childMethod.invoke(obj)).values());
             } else if (Collection.class.isAssignableFrom(returnType)) {
                 log.info("Visiting items of child method " + childMethod.getDeclaringClass().getSimpleName() + "." + childMethod.getName() + "()");
                 inspect((Collection) childMethod.invoke(obj));
             } else {
                 log.info("Visiting child method " + childMethod.getDeclaringClass().getSimpleName() + "." + childMethod.getName() + "()");
                 final Object child = childMethod.invoke(obj);
                 if (child == null) {
                     log.info("# null returned for " + childMethod);
                 } else {
                     inspect(child);
                 }
             }
         }
     }
 }