/**
 *                                  Apache License
 *                            Version 2.0, January 2004
 *                         http://www.apache.org/licenses/
 *
 *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *    1. Definitions.
 *
 *       "License" shall mean the terms and conditions for use, reproduction,
 *       and distribution as defined by Sections 1 through 9 of this document.
 *
 *       "Licensor" shall mean the copyright owner or entity authorized by
 *       the copyright owner that is granting the License.
 *
 *       "Legal Entity" shall mean the union of the acting entity and all
 *       other entities that control, are controlled by, or are under common
 *       control with that entity. For the purposes of this definition,
 *       "control" means (i) the power, direct or indirect, to cause the
 *       direction or management of such entity, whether by contract or
 *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *       outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *       "You" (or "Your") shall mean an individual or Legal Entity
 *       exercising permissions granted by this License.
 *
 *       "Source" form shall mean the preferred form for making modifications,
 *       including but not limited to software source code, documentation
 *       source, and configuration files.
 *
 *       "Object" form shall mean any form resulting from mechanical
 *       transformation or translation of a Source form, including but
 *       not limited to compiled object code, generated documentation,
 *       and conversions to other media types.
 *
 *       "Work" shall mean the work of authorship, whether in Source or
 *       Object form, made available under the License, as indicated by a
 *       copyright notice that is included in or attached to the work
 *       (an example is provided in the Appendix below).
 *
 *       "Derivative Works" shall mean any work, whether in Source or Object
 *       form, that is based on (or derived from) the Work and for which the
 *       editorial revisions, annotations, elaborations, or other modifications
 *       represent, as a whole, an original work of authorship. For the purposes
 *       of this License, Derivative Works shall not include works that remain
 *       separable from, or merely link (or bind by name) to the interfaces of,
 *       the Work and Derivative Works thereof.
 *
 *       "Contribution" shall mean any work of authorship, including
 *       the original version of the Work and any modifications or additions
 *       to that Work or Derivative Works thereof, that is intentionally
 *       submitted to Licensor for inclusion in the Work by the copyright owner
 *       or by an individual or Legal Entity authorized to submit on behalf of
 *       the copyright owner. For the purposes of this definition, "submitted"
 *       means any form of electronic, verbal, or written communication sent
 *       to the Licensor or its representatives, including but not limited to
 *       communication on electronic mailing lists, source code control systems,
 *       and issue tracking systems that are managed by, or on behalf of, the
 *       Licensor for the purpose of discussing and improving the Work, but
 *       excluding communication that is conspicuously marked or otherwise
 *       designated in writing by the copyright owner as "Not a Contribution."
 *
 *       "Contributor" shall mean Licensor and any individual or Legal Entity
 *       on behalf of whom a Contribution has been received by Licensor and
 *       subsequently incorporated within the Work.
 *
 *    2. Grant of Copyright License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       copyright license to reproduce, prepare Derivative Works of,
 *       publicly display, publicly perform, sublicense, and distribute the
 *       Work and such Derivative Works in Source or Object form.
 *
 *    3. Grant of Patent License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       (except as stated in this section) patent license to make, have made,
 *       use, offer to sell, sell, import, and otherwise transfer the Work,
 *       where such license applies only to those patent claims licensable
 *       by such Contributor that are necessarily infringed by their
 *       Contribution(s) alone or by combination of their Contribution(s)
 *       with the Work to which such Contribution(s) was submitted. If You
 *       institute patent litigation against any entity (including a
 *       cross-claim or counterclaim in a lawsuit) alleging that the Work
 *       or a Contribution incorporated within the Work constitutes direct
 *       or contributory patent infringement, then any patent licenses
 *       granted to You under this License for that Work shall terminate
 *       as of the date such litigation is filed.
 *
 *    4. Redistribution. You may reproduce and distribute copies of the
 *       Work or Derivative Works thereof in any medium, with or without
 *       modifications, and in Source or Object form, provided that You
 *       meet the following conditions:
 *
 *       (a) You must give any other recipients of the Work or
 *           Derivative Works a copy of this License; and
 *
 *       (b) You must cause any modified files to carry prominent notices
 *           stating that You changed the files; and
 *
 *       (c) You must retain, in the Source form of any Derivative Works
 *           that You distribute, all copyright, patent, trademark, and
 *           attribution notices from the Source form of the Work,
 *           excluding those notices that do not pertain to any part of
 *           the Derivative Works; and
 *
 *       (d) If the Work includes a "NOTICE" text file as part of its
 *           distribution, then any Derivative Works that You distribute must
 *           include a readable copy of the attribution notices contained
 *           within such NOTICE file, excluding those notices that do not
 *           pertain to any part of the Derivative Works, in at least one
 *           of the following places: within a NOTICE text file distributed
 *           as part of the Derivative Works; within the Source form or
 *           documentation, if provided along with the Derivative Works; or,
 *           within a display generated by the Derivative Works, if and
 *           wherever such third-party notices normally appear. The contents
 *           of the NOTICE file are for informational purposes only and
 *           do not modify the License. You may add Your own attribution
 *           notices within Derivative Works that You distribute, alongside
 *           or as an addendum to the NOTICE text from the Work, provided
 *           that such additional attribution notices cannot be construed
 *           as modifying the License.
 *
 *       You may add Your own copyright statement to Your modifications and
 *       may provide additional or different license terms and conditions
 *       for use, reproduction, or distribution of Your modifications, or
 *       for any such Derivative Works as a whole, provided Your use,
 *       reproduction, and distribution of the Work otherwise complies with
 *       the conditions stated in this License.
 *
 *    5. Submission of Contributions. Unless You explicitly state otherwise,
 *       any Contribution intentionally submitted for inclusion in the Work
 *       by You to the Licensor shall be under the terms and conditions of
 *       this License, without any additional terms or conditions.
 *       Notwithstanding the above, nothing herein shall supersede or modify
 *       the terms of any separate license agreement you may have executed
 *       with Licensor regarding such Contributions.
 *
 *    6. Trademarks. This License does not grant permission to use the trade
 *       names, trademarks, service marks, or product names of the Licensor,
 *       except as required for reasonable and customary use in describing the
 *       origin of the Work and reproducing the content of the NOTICE file.
 *
 *    7. Disclaimer of Warranty. Unless required by applicable law or
 *       agreed to in writing, Licensor provides the Work (and each
 *       Contributor provides its Contributions) on an "AS IS" BASIS,
 *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *       implied, including, without limitation, any warranties or conditions
 *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *       PARTICULAR PURPOSE. You are solely responsible for determining the
 *       appropriateness of using or redistributing the Work and assume any
 *       risks associated with Your exercise of permissions under this License.
 *
 *    8. Limitation of Liability. In no event and under no legal theory,
 *       whether in tort (including negligence), contract, or otherwise,
 *       unless required by applicable law (such as deliberate and grossly
 *       negligent acts) or agreed to in writing, shall any Contributor be
 *       liable to You for damages, including any direct, indirect, special,
 *       incidental, or consequential damages of any character arising as a
 *       result of this License or out of the use or inability to use the
 *       Work (including but not limited to damages for loss of goodwill,
 *       work stoppage, computer failure or malfunction, or any and all
 *       other commercial damages or losses), even if such Contributor
 *       has been advised of the possibility of such damages.
 *
 *    9. Accepting Warranty or Additional Liability. While redistributing
 *       the Work or Derivative Works thereof, You may choose to offer,
 *       and charge a fee for, acceptance of support, warranty, indemnity,
 *       or other liability obligations and/or rights consistent with this
 *       License. However, in accepting such obligations, You may act only
 *       on Your own behalf and on Your sole responsibility, not on behalf
 *       of any other Contributor, and only if You agree to indemnify,
 *       defend, and hold each Contributor harmless for any liability
 *       incurred by, or claims asserted against, such Contributor by reason
 *       of your accepting any such warranty or additional liability.
 *
 *    END OF TERMS AND CONDITIONS
 *
 *    APPENDIX: How to apply the Apache License to your work.
 *
 *       To apply the Apache License to your work, attach the following
 *       boilerplate notice, with the fields enclosed by brackets "{}"
 *       replaced with your own identifying information. (Don't include
 *       the brackets!)  The text should be enclosed in the appropriate
 *       comment syntax for the file format. We also recommend that a
 *       file or class name and description of purpose be included on the
 *       same "printed page" as the copyright notice for easier
 *       identification within third-party archives.
 *
 *    Copyright 2014 Edgar Espina
 *
 *    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 org.jooby.filewatcher;

import com.google.common.collect.ImmutableList;
import com.google.inject.Binder;
import com.google.inject.multibindings.Multibinder;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import org.jooby.Env;
import org.jooby.Jooby.Module;
import org.jooby.funzy.Throwing;
import org.jooby.spi.WatchEventModifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.nio.file.FileSystems;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardWatchEventKinds;
import java.nio.file.WatchService;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;

/**
 * <h1>file watcher</h1>
 * <p>
 * Watches for file system changes or event. It uses a watch service to monitor a directory for
 * changes so that it can update its display of the list of files when files are created or deleted.
 * </p>
 *
 * <h2>usage</h2>
 * <p>
 * Watch <code>mydir</code> and listen for create, modify or delete event on all files under it:
 * </p>
 *
 * <pre>{@code
 * {
 *   use(new FileWatcher()
 *     .register(Paths.get("mydir"), (kind, path) -> {
 *       log.info("found {} on {}", kind, path);
 *     });
 *   );
 * }
 * }</pre>
 *
 * <h2>file handler</h2>
 * <p>
 * You can specify a {@link FileEventHandler} instance or class while registering a path:
 * </p>
 *
 * <p>
 * Instance:
 * </p>
 * <pre>{@code
 * {
 *   use(new FileWatcher()
 *     .register(Paths.get("mydir"), (kind, path) -> {
 *       log.info("found {} on {}", kind, path);
 *     });
 *   );
 * }
 * }</pre>
 *
 * <p>
 * Class reference:
 * </p>
 *
 * <pre>{@code
 * {
 *   use(new FileWatcher()
 *     .register(Paths.get("mydir"), MyFileEventHandler.class)
 *   );
 * }
 * }</pre>
 *
 * <p>
 * Worth to mention that <code>MyFileEventHandler</code> will be provided by Guice.
 * </p>
 *
 * <h2>options</h2>
 * <p>
 * You can specify a couple of options at registration time:
 * </p>
 * <pre>{@code
 * {
 *   use(new FileWatcher(
 *     .register(Paths.get("mydir"), MyFileEventHandler.class, options -> {
 *       options.kind(StandardWatchEventKinds.ENTRY_MODIFY)
 *              .recursive(false)
 *              .includes("*.java");
 *     });
 *   ));
 * }
 * }</pre>
 *
 * <p>
 * 1. Here we listen for {@link StandardWatchEventKinds#ENTRY_MODIFY} (we don't care about create or
 * delete).
 * </p>
 * <p>
 * 2. We turn off recursive watching, only direct files are detected.
 * </p>
 * <p>
 * 3. We want <code>.java</code> files and we ignore any other files.
 * </p>
 *
 * <h2>configuration file</h2>
 * <p>
 * In addition to do it programmatically, you can do it via configuration properties:
 * </p>
 *
 * <pre>{@code
 * {
 *   use(new FileWatcher()
 *     .register("mydirproperty", MyEventHandler.class)
 *   );
 * }
 * }</pre>
 *
 * <p>
 * The <code>mydirproperty</code> property must be present in your <code>.conf</code> file.
 * </p>
 *
 * <p>
 * But of course, you can entirely register paths from <code>.conf</code> file:
 * </p>
 *
 * <pre>{@code
 * filewatcher {
 *   register {
 *     path: "mydir"
 *     handler: "org.example.MyFileEventHandler"
 *     kind: "ENTRY_MODIFY"
 *     includes: "*.java"
 *     recursive: false
 *   }
 * }
 * }</pre>
 *
 * <p>
 * Multiple paths are supported using array notation:
 * </p>
 *
 * <pre>{@code
 * filewatcher {
 *   register: [{
 *     path: "mydir1"
 *     handler: "org.example.MyFileEventHandler"
 *   }, {
 *     path: "mydir2"
 *     handler: "org.example.MyFileEventHandler"
 *   }]
 * }
 * }</pre>
 *
 * <p>
 * Now use the module:
 * </p>
 * <pre>{@code
 * {
 *   use(new FileWatcher());
 * }
 * }</pre>
 *
 * <p>
 * The {@link FileWatcher} module read the <code>filewatcher.register</code> property and setup
 * everything.
 * </p>
 *
 * @author edgar
 */
public class FileWatcher implements Module {
  private static final Consumer<FileEventOptions> EMPTY = it -> {
  };

  /**
   * The logging system.
   */
  private final Logger log = LoggerFactory.getLogger(getClass());

  private final List<Throwing.Function2<Config, Binder, FileEventOptions>> bindings = new ArrayList<>();

  private WatchService watcher;

  /**
   * Register the given directory tree and execute the given handler whenever a file/folder has been
   * created, modified or delete.
   *
   * @param path Directory to register.
   * @param handler Handler to execute.
   * @return This module.
   */
  public FileWatcher register(final Path path, final Class<? extends FileEventHandler> handler) {
    return register(path, handler, EMPTY);
  }

  /**
   * Register the given directory tree and execute the given handler whenever a file/folder has been
   * created, modified or delete. The configurer callback allow you to customize default event
   * kinds, filter specific file types and restrict the watch scope lookup to direct files.
   *
   * @param path Directory to register.
   * @param handler Handler to execute.
   * @param configurer Configurer callback.
   * @return This module.
   * @see FileEventOptions
   */
  public FileWatcher register(final Path path, final Class<? extends FileEventHandler> handler,
      final Consumer<FileEventOptions> configurer) {
    return register(c -> path, p -> new FileEventOptions(p, handler), configurer);
  }

  /**
   * Register the given directory tree and execute the given handler whenever a file/folder has been
   * created, modified or delete.
   *
   * @param path Directory to register.
   * @param handler Handler to execute.
   * @return This module.
   */
  public FileWatcher register(final Path path, final FileEventHandler handler) {
    return register(c -> path, p -> new FileEventOptions(p, handler), EMPTY);
  }

  /**
   * Register the given directory tree and execute the given handler whenever a file/folder has been
   * created, modified or delete. The configurer callback allow you to customize default event
   * kinds, filter specific file types and restrict the watch scope lookup to direct files.
   *
   * @param path Directory to register.
   * @param handler Handler to execute.
   * @param configurer Configurer callback.
   * @return This module.
   * @see FileEventOptions
   */
  public FileWatcher register(final Path path, final FileEventHandler handler,
      final Consumer<FileEventOptions> configurer) {
    return register(c -> path, p -> new FileEventOptions(p, handler), configurer);
  }

  /**
   * Register the given directory tree and execute the given handler whenever a file/folder has been
   * created, modified or delete.
   *
   * @param property Directory to register.
   * @param handler Handler to execute.
   * @return This module.
   */
  public FileWatcher register(final String property, final FileEventHandler handler) {
    return register(c -> Paths.get(c.getString(property)), p -> new FileEventOptions(p, handler),
        EMPTY);
  }

  /**
   * Register the given directory tree and execute the given handler whenever a file/folder has been
   * created, modified or delete. The configurer callback allow you to customize default event
   * kinds, filter specific file types and restrict the watch scope lookup to direct files.
   *
   * @param property Directory to register.
   * @param handler Handler to execute.
   * @param configurer Configurer callback.
   * @return This module.
   * @see FileEventOptions
   */
  public FileWatcher register(final String property, final FileEventHandler handler,
      final Consumer<FileEventOptions> configurer) {
    return register(c -> Paths.get(c.getString(property)), p -> new FileEventOptions(p, handler),
        configurer);
  }

  /**
   * Register the given directory tree and execute the given handler whenever a file/folder has been
   * created, modified or delete.
   *
   * @param property Directory to register.
   * @param handler Handler to execute.
   * @return This module.
   */
  public FileWatcher register(final String property,
      final Class<? extends FileEventHandler> handler) {
    return register(property, handler, EMPTY);
  }

  /**
   * Register the given directory tree and execute the given handler whenever a file/folder has been
   * created, modified or delete. The configurer callback allow you to customize default event
   * kinds, filter specific file types and restrict the watch scope lookup to direct files.
   *
   * @param property Directory to register.
   * @param handler Handler to execute.
   * @param configurer Configurer callback.
   * @return This module.
   * @see FileEventOptions
   */
  public FileWatcher register(final String property,
      final Class<? extends FileEventHandler> handler,
      final Consumer<FileEventOptions> configurer) {
    return register(c -> Paths.get(c.getString(property)),
        path -> new FileEventOptions(path, handler), configurer);
  }

  private FileWatcher register(final Function<Config, Path> provider,
      final Throwing.Function<Path, FileEventOptions> handler,
      final Consumer<FileEventOptions> configurer) {
    bindings.add((conf, binder) -> {
      Path path = provider.apply(conf);
      FileEventOptions options = handler.apply(path);
      configurer.accept(options);
      return register(binder, options);
    });
    return this;
  }

  private FileEventOptions register(final Binder binder, final FileEventOptions options) {
    Multibinder.newSetBinder(binder, FileEventOptions.class)
        .addBinding()
        .toInstance(options);
    return options;
  }

  @Override
  public void configure(final Env env, final Config conf, final Binder binder) throws Throwable {
    this.watcher = FileSystems.getDefault().newWatchService();
    binder.bind(WatchService.class).toInstance(watcher);
    List<FileEventOptions> paths = new ArrayList<>();
    paths(env.getClass().getClassLoader(), conf, "filewatcher.register", options -> paths.add(register(binder, options)));
    for (Throwing.Function2<Config, Binder, FileEventOptions> binding : bindings) {
      paths.add(binding.apply(conf, binder));
    }
    binder.bind(FileMonitor.class).asEagerSingleton();
    paths.forEach(it -> log.info("Watching: {}", it));
  }

  protected boolean empty() {
    return bindings.isEmpty();
  }

  @SuppressWarnings({"unchecked", "rawtypes"})
  private void paths(final ClassLoader loader, final Config conf, final String name,
      final Consumer<FileEventOptions> callback) {
    list(conf, name, value -> {
      Config coptions = ConfigFactory.parseMap((Map) value);
      Class handler = loader.loadClass(coptions.getString("handler"));
      Path path = Paths.get(coptions.getString("path"));
      FileEventOptions options = new FileEventOptions(path, handler);
      list(coptions, "kind", it -> options.kind(new WatchEventKind(it.toString())));
      list(coptions, "modifier", it -> options.modifier(WatchEventModifier.modifier(it.toString())));
      list(coptions, "includes", it -> options.includes(it.toString()));
      list(coptions, "recursive", it -> options.recursive(Boolean.valueOf(it.toString())));
      callback.accept(options);
    });
  }

  @SuppressWarnings("rawtypes")
  private void list(final Config conf, final String name, final Throwing.Consumer<Object> callback) {
    if (conf.hasPath(name)) {
      Object value = conf.getAnyRef(name);
      List values = value instanceof List ? (List) value : ImmutableList.of(value);
      for (Object it : values) {
        callback.accept(it);
      }
    }
  }

}
