/*
 * RiskScape™ Copyright New Zealand Institute for Earth Science Limited
 * (Earth Sciences New Zealand) is distributed for research purposes only
 * under the terms of AGPLv3.
 *
 * RiskScape™ Copyright 2026 New Zealand Institute for Earth Science
 * Limited (Earth Sciences New Zealand). All rights reserved. Source code
 * available under the AGPLv3.
 * 
 * This program is free software: you can redistribute it and/or modify it under
 *  the terms of the GNU Affero General Public License as published by the Free
 *  Software Foundation, either version 3 of the License, or (at your option) any
 *  later version.
 * 
 * This program is distributed for RESEARCH PURPOSES ONLY, in the hope that it will
 * be useful for research and education initiatives.
 * 
 * If you are not a researcher, or you are a researcher who wishes to use this
 * program on terms other than AGPLv3 (including those who wish to restrict the
 * distribution of any source code created using this program), please contact:
 * https://riskscape.org.nz
 * 
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Affero General Public License for more details.  You should have received a copy
 * of the GNU Affero General Public License along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * By way of summary only, under the AGPLv3:
 *     • Permissions of this strongest copyleft license are conditioned
 *       on making available complete source code of licensed works and
 *       modifications, which include larger works using a licensed work,
 *       under the same license.
 *     • Copyright and license notices must be preserved.
 *     • Contributors provide an express grant of patent rights.
 *     • When a modified version is used to provide a service over a
 *       network, the complete source code of the modified version must be made
 *       available.
 */
package nz.org.riskscape.engine.bind;

import nz.org.riskscape.engine.data.Bookmark;
import nz.org.riskscape.engine.data.BookmarkFactory;
import nz.org.riskscape.engine.data.ResolvedBookmark;
import nz.org.riskscape.engine.pipeline.ExecutionContext;
import nz.org.riskscape.problem.ResultOrProblems;

/**
 * ExecutionContext specific binding to bind to a ResolvedBookmark. This functionality was removed from the engine's
 * general purpose binding, because resolving bookmarks needs (wants) an ExecutionContext.  Many parts of the
 * application carry around an ExecutionContext, which we can give to the binder, and so support binding straight to
 * ResolvedBookmark (but in a much simpler form than we had in the old BookmarkBinder).
 */
public class ResolvedBookmarkBinder extends TypeSafeBinder<Object, ResolvedBookmark> {

  public ResolvedBookmarkBinder(ExecutionContext executionContext) {
    super(Object.class, ResolvedBookmark.class);

    this.executionContext = executionContext;
  }

  // will be needed once binding uses execution context
  private final ExecutionContext executionContext;

  @Override
  protected ResultOrProblems<ResolvedBookmark> bindTypedValue(BindingContext context, Object value) {
    ResultOrProblems<Bookmark> bookmarkOr;
    if (value instanceof Bookmark) {
      bookmarkOr = ResultOrProblems.of((Bookmark) value);
    } else {
      String bookmarkId = value.toString();
      bookmarkOr = context.bind(bookmarkId, Bookmark.class);

      if (bookmarkOr.hasErrors()) {
        if (!context.getProject().getBookmarks().containsKey(bookmarkId)) {
          // binding has failed and there is no bookmark with that id, try and resolve a URI instead (The platform makes
          // it easy for users to supply a uri, whereas the CLI does not)
          bookmarkOr = BookmarkFactory
              .uriFromLocation(bookmarkId, context.getRelativeTo()).map(Bookmark::fromURI);
        }
      }
    }

    return bookmarkOr.flatMap(bookmark -> {
      return context.getEngine().getBookmarkResolvers().resolve(bookmark, executionContext);
    });
  }
}
