WebBox Klassenbibliothek
ulrich
2018-04-01 320c6e7085128d2196edb552c2076c72af789443
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
package de.uhilger.wbx.web;
 
import de.vogella.rss.model.Feed;
import de.vogella.rss.model.FeedMessage;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
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;
import java.util.List;
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.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
/**
 * <p>Das FeedServlet erstellt Feeds von Ordnern der WebBox</p>
 * 
 * <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="wbxPubDir" 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 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 contextPath = request.getContextPath();
    logger.fine("contextPath: " + contextPath);
    String zielPfad = url.substring(url.indexOf(contextPath));
    logger.fine(zielPfad);
    String basis = getJNDIParameter(WBX_FILE_BASE);
    logger.fine("basis: " + basis);
    StringBuffer pfad = new StringBuffer();
    pfad.append(basis);
    pfad.append(zielPfad.replace(contextPath, getJNDIParameter(WBX_PUB_DIR)));
    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(getJNDIParameter(WBX_FEED_TITLE), 
              getJNDIParameter(WBX_FEED_SUBTITLE), out, beitraege, 
              basis, pfad.toString(), contextPath);
    } 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]);
      }
    }
      
    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);
      }
    } 
    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);
        }
      }
      
    }
  }
  
  public void writeFeed(String feedTitel, String beschr, ServletOutputStream s, 
          List beitraege, String basis, String pfad, String contextPath) {
    String copyright = getJNDIParameter(WBX_FEED_COPYRIGHT);
    String domain = getJNDIParameter(WBX_FEED_DOMAIN);
    String title = feedTitel;
    String description = beschr;
    String language = "de";
    String link = domain;
    Calendar cal = new GregorianCalendar();
    Date creationDate = cal.getTime();
    SimpleDateFormat date_format = new SimpleDateFormat(
            "EEE', 'dd' 'MMM' 'yyyy' 'HH:mm:ss' 'Z", Locale.US);
    String pubdate = date_format.format(creationDate);
    Feed rssFeed = new Feed(title, link, description, language,
            copyright, pubdate);
 
    Iterator i = beitraege.iterator();
    while (i.hasNext()) {
      File f = (File) i.next();
      FeedMessage feedEintrag = new FeedMessage();
      feedEintrag.setTitle(f.getName());
      //feedEintrag.setDescription("Beschreibung hier");
      feedEintrag.setAuthor(getJNDIParameter(WBX_FEED_AUTHOR));
 
      String urlStr = f.getAbsolutePath();
      urlStr = urlStr.replace(basis, domain);
      urlStr = urlStr.replace(getJNDIParameter(WBX_PUB_DIR), contextPath);
 
      logger.fine(urlStr);
 
      feedEintrag.setGuid(urlStr);
      feedEintrag.setLink(urlStr);
      logger.fine(f.getName());
      feedEintrag.setDescription(readFilePart(f, urlStr));
      rssFeed.getMessages().add(feedEintrag);
    }
 
    FeedStreamWriter writer = new FeedStreamWriter(rssFeed, s);
    try {
      writer.write();
    } catch (Exception e) {
      logger.log(Level.SEVERE, e.getMessage(), e);
    }
  }
  
  private String readFilePart(File f, String urlStr) {
    StringBuffer buf = new StringBuffer();
    Reader reader = null;
    try {
      String fn = f.getName().toLowerCase();
      if(fn.endsWith(".jpg") || fn.endsWith(".jpeg") || fn.endsWith(".png")) {
        String noExt;
        String ext;
        int dotpos = urlStr.lastIndexOf('.');
        if(dotpos > -1) {
          noExt = urlStr.substring(0, dotpos);
          ext = urlStr.substring(dotpos);
        } else {
          noExt = "";
          ext = "";
        }
        buf.append("<a href='");
        buf.append(urlStr);
        buf.append("'><img src='");
        buf.append(noExt);
        buf.append("_kl");
        buf.append(ext);
        buf.append("'></a>");
      } else {
        reader = new FileReader(f);
        char[] readBuffer = new char[1024];
        int charsRead = reader.read(readBuffer);
        buf.append(readBuffer);
        reader.close();
      }
      return buf.toString();
    } catch (Exception ex) {
      logger.log(Level.SEVERE, null, ex);
      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;
    }
  }  
  
}