wbx-stile aufgenommen

ulrich

2021-01-28 96dfd62fbfe771616045a253bbeb1415538e815f

 src/de/uhilger/wbx/web/FeedServlet.java

@@ -1,7 +1,7 @@

package de.uhilger.wbx.web;

import de.uhilger.wbx.web.FeedStreamWriter;
import de.uhilger.wbx.WbxUtils;
import de.vogella.rss.model.Feed;
import de.vogella.rss.model.FeedMessage;
import java.io.File;
@@ -11,8 +11,6 @@
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Iterator;
@@ -20,10 +18,6 @@
import java.util.Locale;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServlet;
@@ -31,160 +25,118 @@
import javax.servlet.http.HttpServletResponse;

/**
 * Das FeedServlet erstellt Feeds von Ordnern der WebBox
 * <p>Das FeedServlet erstellt Feeds von Ordnern der WebBox</p>
 * 
 * Eine Maximaltiefe als Parameter soll regeln, wie viele Ordner tief 
 * Dateien gesucht werden
 * <p>Annahmen:</p>
 * <ul>
 * <li>Der JNDI-Parameter <code>wbxFileBase</code> enthaelt den absoluten Pfad 
 * zur Dateiablage</li>
 * <li>Der Parameter 'wbxPubDir' enthaelt den Namen des Ordners mit 
 * oeffentlichen Inhalten und dieser Ordner liegt direkt unterhalb von 
 * <code>wbxFileBase</code></li>
 * <li>Der Ordner mit dem oeffentlichen Inhalt wird von Tomcat als Context 
 * 1:1 ausgeliefert sodass bei einem URL wie 
 * <code>http://example.com/[Context]/weitere/pfad/angaben/datei.html</code> 
 * die Pfadangabe hinter <code>[Context]/</code> die Inhalte innerhalb von 
 * <code>wbxFileBase/wbxPubDir</code> 1:1 wiedergibt.</li>
 * 
 * <p>Der JNDI-Parameter <code>wbxMaxFeedDepth</code> regelt, wie viele Ebenen der 
 * Ordnerstruktur maximal nach Eintraegen durchsucht werden. Dabei haben die 
 * tiefsten Ebenen Vorrang vor hoeher gelegenen Ebenen, d.h. Dateien auf 
 * tieferen Ebenen werden vor Dateien auf hoeheren Ebenen in den Feed 
 * aufgenommen.</p>
 * 
 * <p>Der JNDI-Parameter <code>wbxMaxFeedEntries</code> regelt, wie viele Beitraege 
 * maximal im Feed erscheinen. Der Standardwert ist fuenf Beitraege, d.h., die 
 * ersten fuenf gefundenen Beitraege werden chronologisch absteigend sortiert 
 * nach ihrem letzten Aenderungsdatum ausgegeben.</p>
 * 
 * <p>Die Datei <code>CATALINA_BASE/conf/context.xml</code> muss also die 
 * folgenden Eintraege enthalten:</p>
 * <pre>
 * <Environment name="wbxFileBase" type="java.lang.String" value="absoluter/pfad/zur/dateiablage" override="false" />
 * <Environment name="wbxPubDirName" type="java.lang.String" value="/www" override="false" />
 * <Environment name="wbxFeedTitle" type="java.lang.String" value="Newsfeed" override="false" />
 * <Environment name="wbxFeedSubtitle" type="java.lang.String" value="Text des Untertitels" override="false" />
 * <Environment name="wbxFeedCopyright" type="java.lang.String" value="Text des Copyright-Hinweises" override="false" />
 * <Environment name="wbxFeedDomain" type="java.lang.String" value="http://example.com" override="false" />
 * <Environment name="wbxFeedAuthor" type="java.lang.String" value="Name des Autors" override="false" />
 * </pre>
 */
public class FeedServlet extends HttpServlet {
  
  private static final Logger logger = Logger.getLogger(FeedServlet.class.getName());
  
  public static final String JNDI_CTX_NAME = "java:comp/env";
  public static final String WBX_FILE_BASE = "wbxFileBase";
  //public static final String JNDI_CTX_NAME = "java:comp/env";
  //public static final String WBX_FILE_BASE = "wbxFileBase";
  //public static final String WBX_PUB_DIR = "wbxPubDir";
  public static final String WBX_MAX_FEED_DEPTH = "wbxMaxFeedDepth";
  public static final String WBX_MAX_FEED_ENTRIES = "wbxMaxFeedEntries";
  public static final String WBX_FEED_TITLE = "wbxFeedTitle";
  public static final String WBX_FEED_SUBTITLE = "wbxFeedSubtitle";
  public static final String WBX_FEED_COPYRIGHT = "wbxFeedCopyright";
  public static final String WBX_FEED_DOMAIN = "wbxFeedDomain";
  public static final String WBX_FEED_AUTHOR = "wbxFeedAuthor";
  
  public static final int WBX_DEF_MAX_FEED_DEPTH = 3;
  public static final int WBX_DEF_MAX_FEED_ENTRIES = 5;
  
  public static final String NOT_FOUND = " nicht gefunden";
  public static final String NO_STRING = " ist kein String";  
  
    
  @Override
  protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException {
    ServletOutputStream out = response.getOutputStream();
    response.setContentType("text/xml");
    String url = request.getRequestURL().toString();
    logger.fine("requestURL: " + url);
    String dataUrl = url.replace("feed/", "data/");
    logger.fine("dataUrl: " + dataUrl);
    int pos = dataUrl.indexOf("data/");
    String zielPfad = dataUrl.substring(pos);
    String contextPath = request.getContextPath();
    logger.fine("contextPath: " + contextPath);
    String zielPfad = url.substring(url.indexOf(contextPath));
    logger.fine(zielPfad);
    //ServletContext ctx = request.getServletContext();
    //Object o = ctx.getAttribute(FILE_BASE);
    String basis = getJNDIParameter(WBX_FILE_BASE);
    //if(o instanceof String) {
      //String basis = o.toString();
      logger.fine("basis: " + basis);
      StringBuffer pfad = new StringBuffer();
      pfad.append(basis);
      pfad.append(zielPfad.replace("data/", "/www/"));
      logger.fine("pfad: " + pfad);
      String dirStr = pfad.toString().substring(0, pfad.lastIndexOf("/"));
      logger.fine("dirStr: " + dirStr);
      File dir = new File(dirStr);
      if(dir.isDirectory()) {
        List beitraege = new ArrayList();
        int maxBeitraege = getJNDIInt(WBX_MAX_FEED_ENTRIES, WBX_DEF_MAX_FEED_ENTRIES);
        int maxTiefe = getJNDIInt(WBX_MAX_FEED_DEPTH, WBX_DEF_MAX_FEED_DEPTH);
        collectFiles(dir, 0, beitraege, maxTiefe, maxBeitraege);
        Iterator i = beitraege.iterator();
        while(i.hasNext()) {
          File f = (File) i.next();
          logger.fine(f.getAbsolutePath() + " " + f.lastModified());
        }
        writeFeed("Newsfeed", "Neueste Inhalte von Ulrich Hilger", out, beitraege, basis, pfad.toString());
      } else {
        logger.fine(dir.getAbsolutePath() + " ist kein Ordner.");
      }
    //}    
  }
  
  /**
   * Diese Methode funktioniert nur, wenn entweder ein Ordner uebergeben 
   * wird, der keine Unterordner enthaelt wie zum Beispiel der Ordner 'neu' 
   * der Bildersammlung oder ein Ordner, dessen Unterordner 
   * nach dem Schema Jahr, Monat benannt sind wie bei einem Journal, das 
   * die Beitraege wie folgt enthaelt:
   * Journal-Ordner
   *   2018
   *     12
   *     11
   *     10
   *     usw.
   *   2017
   *     12
   *     11
   *     10
   *     usw.
   * 
   * @param out
   * @param dir
   * @param tiefe
   * @param dateizaehler 
   */
  private void collectFiles(File dir, int tiefe, List beitraege, int maxTiefe, int maxBeitraege) {
    List dirs = new ArrayList();
    List beitraegeHier = new ArrayList();
    File[] files = dir.listFiles();
    for(int i = 0; i < files.length; i++) {
      if(files[i].isDirectory()) {
        if(tiefe < maxTiefe) {
          dirs.add(files[i]);
        }
      } else {
        beitraegeHier.add(files[i]);
      }
    WbxUtils wu = new WbxUtils();
    String basis = wu.getJNDIParameter(WbxUtils.WBX_FILE_BASE, WbxUtils.EMPTY_STRING);
    logger.fine("basis: " + basis);
    if(basis.equals(WbxUtils.EMPTY_STRING)) {
      basis = wu.getWbxDataDir().getAbsolutePath();
    }
      
    if(dirs.size() > 0) {
      // hier zuvor die Verzeichnissse absteigend nach Name sortieren      
      Collections.sort(dirs, new Comparator<File>() {
        @Override
        public int compare(File o1, File o2) {
          return o2.getName().compareTo(o1.getName());
        }
      });
      
      Iterator i = dirs.iterator();
      while(i.hasNext() && beitraege.size() < maxBeitraege) {
        collectFiles((File) i.next(), tiefe+1, beitraege, maxTiefe, maxBeitraege);
    StringBuffer pfad = new StringBuffer();
    pfad.append(basis);
    pfad.append(zielPfad.replace(contextPath, wu.getJNDIParameter(WbxUtils.WBX_PUB_DIR_NAME, WbxUtils.WBX_DEFAULT_PUB_DIR_NAME)));
    logger.fine("pfad: " + pfad);
    String dirStr = pfad.toString().substring(0, pfad.lastIndexOf("/"));
    logger.fine("dirStr: " + dirStr);
    File dir = new File(dirStr);
    if (dir.isDirectory()) {
      List beitraege = new ArrayList();
      int maxBeitraege = wu.getJNDIInt(WBX_MAX_FEED_ENTRIES, WBX_DEF_MAX_FEED_ENTRIES);
      int maxTiefe = wu.getJNDIInt(WBX_MAX_FEED_DEPTH, WBX_DEF_MAX_FEED_DEPTH);
      wu.collectFiles(dir, 0, beitraege, maxTiefe, maxBeitraege);
      Iterator i = beitraege.iterator();
      while (i.hasNext()) {
        File f = (File) i.next();
        logger.fine(f.getAbsolutePath() + " " + f.lastModified());
      }
    } 
    if(beitraegeHier.size() > 0) {
      // hier zuvor die Liste der Beitraege dieses Ordners nach lastModified absteigend sortieren
      // dann die neuesten in beitraege aufnehmen, bis die maximale Zahl gesuchter 
      // neuer Beitraege erreicht ist.
      
      Collections.sort(beitraegeHier, new Comparator<File>() {
        @Override
        public int compare(File o1, File o2) {
          int ergebnis;
          if(o1.lastModified() > o2.lastModified()) {
            ergebnis = -1;
          } else if(o2.lastModified() > o1.lastModified()) {
            ergebnis = 1;
          } else {
            ergebnis = 0;
          }
          return ergebnis;
        }
      });
      
      Iterator i = beitraegeHier.iterator();
      while(i.hasNext() && beitraege.size() < maxBeitraege) {
        File bf = (File) i.next();
        String nm = bf.getName().toLowerCase();
        if(nm.endsWith(".htmi") || nm.endsWith(".html") || nm.endsWith(".htm") || 
           nm.endsWith(".jpg") || nm.endsWith(".jpeg") || nm.endsWith(".png") || 
           nm.endsWith(".txt")) {
          beitraege.add(bf);
        }
      }
      
      writeFeed(wu.getJNDIParameter(WBX_FEED_TITLE, WbxUtils.EMPTY_STRING), 
              wu.getJNDIParameter(WBX_FEED_SUBTITLE, WbxUtils.EMPTY_STRING), out, beitraege, 
              basis, pfad.toString(), contextPath, wu);
    } else {
      logger.fine(dir.getAbsolutePath() + " ist kein Ordner.");
    }
  }
  
  public void writeFeed(String feedTitel, String beschr, ServletOutputStream s, List beitraege, String basis, String pfad) {
    String copyright = "Copyright (c) 2018 Ulrich Hilger";
    
  public void writeFeed(String feedTitel, String beschr, ServletOutputStream s, 
          List beitraege, String basis, String pfad, String contextPath, WbxUtils wu) {
    
    long newest = -1;
    String copyright = wu.getJNDIParameter(WBX_FEED_COPYRIGHT, WbxUtils.EMPTY_STRING);
    String domain = wu.getJNDIParameter(WBX_FEED_DOMAIN, WbxUtils.EMPTY_STRING);
    String title = feedTitel;
    String description = beschr;
    String language = "de";
    String link = "https://www.uhilger.de";
    String link = domain;
    
    newest = ((File) beitraege.get(0)).lastModified();
    
    Calendar cal = new GregorianCalendar();
    cal.setTime(new Date(newest));
    Date creationDate = cal.getTime();
    SimpleDateFormat date_format = new SimpleDateFormat(
            "EEE', 'dd' 'MMM' 'yyyy' 'HH:mm:ss' 'Z", Locale.US);
@@ -198,11 +150,11 @@
      FeedMessage feedEintrag = new FeedMessage();
      feedEintrag.setTitle(f.getName());
      //feedEintrag.setDescription("Beschreibung hier");
      feedEintrag.setAuthor("ulrich Punkt hilger bei web Punkt de (Ulrich Hilger)");
      feedEintrag.setAuthor(wu.getJNDIParameter(WBX_FEED_AUTHOR, WbxUtils.EMPTY_STRING));

      String urlStr = f.getAbsolutePath();
      urlStr = urlStr.replace(basis, "https://uhilger.de");
      urlStr = urlStr.replace("www/", "data/");
      urlStr = urlStr.replace(basis, domain);
      urlStr = urlStr.replace(wu.getJNDIParameter(WbxUtils.WBX_PUB_DIR_NAME, WbxUtils.WBX_DEFAULT_PUB_DIR_NAME), contextPath);

      logger.fine(urlStr);

@@ -214,12 +166,8 @@
    }

    FeedStreamWriter writer = new FeedStreamWriter(rssFeed, s);
    //RSSFeedWriter writer = new RSSFeedWriter(rssFeed, pfad + "/articles.rss");
    //ByteArrayOutputStream bs = new ByteArrayOutputStream();
    //RSSByteFeedWriter wr = new RSSByteFeedWriter(rssFeed, bs);
    try {
      writer.write();
      //s.print(bs.toString());
    } catch (Exception e) {
      logger.log(Level.SEVERE, e.getMessage(), e);
    }
@@ -261,33 +209,5 @@
      return buf.toString();
    }
  }
  
  private int getJNDIInt(String paramName, int defaultVal) {
    String jndiStr = getJNDIParameter(paramName);
    try {
      return Integer.parseInt(jndiStr);
    } catch(NumberFormatException ex) {
      return defaultVal;
    }
  }
  
  private String getJNDIParameter(String pname) {
    try {
      // unseren environment naming context ermitteln
      Context initCtx = new InitialContext();
      Context envCtx = (Context) initCtx.lookup(JNDI_CTX_NAME);
      
      // unseren Parameter lesen
      Object o = envCtx.lookup(pname);
      if(o instanceof String) {
        return o.toString();      
      } else {
        return NO_STRING;
      }
    } catch (NamingException ex) {
      logger.log(Level.SEVERE, ex.getMessage());
      return NOT_FOUND;
    }
  }  
  
}