HelpContext.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * 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 in the hope that it will be useful,
 * but 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/>.
 */
 
package org.turro.help;
 
import java.io.IOException;
import java.nio.file.DirectoryStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.string.Strings;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.ElephantProperties;
import org.turro.elephant.web.ElContext;
import org.turro.elephant.web.ElContextMap;
 
public class HelpContext {
  
  public static String helpLink(String current) {
    ElContext ctx = help(current);
    if(ctx != null && ctx.getFile().exists()) {
      String webPath = ctx.getWebPath();
      if(webPath.startsWith("/")) { 
        try(DirectoryStream<Path> stream = Files.newDirectoryStream(Paths.get(ElephantContext.getRealPath(ctx.getPath())), "*.html")) {
          if(stream.iterator().hasNext()) {
            return webPath;
          }
        } catch (IOException ex) {
          Logger.getLogger(HelpContext.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(current), ex);
        }
      } else {
        return webPath;
      }
    }
    return null;
  }
 
  public static String helpLink(ElContext current) {
    return current != null ? helpLink(current.getPath()) : null;
  }
 
  public static ElContext help(String path) {
    return !Strings.isBlank(path) ? ElContextMap.getContext(getHelpContextAttribute("root", "/docs/contextual") + path) : null;
  }
 
  public static ElContext help(ElContext current) {
    return current != null ? ElContextMap.getContext(getHelpContextAttribute("root", "/docs/contextual") + current.getPath()) : null;
  }
  
  public static boolean exists(ElContext current) {
    return help(current)!= null;
  }
  
  /* Help context */
  
  private static final String HELP_CONTEXT = "help-context";
  
  public static String getHelpContextAttribute(String attribute, String defaultValue) {
    return ElephantProperties.getContextProperty(HELP_CONTEXT, attribute, defaultValue);
  }
  
}