WebBox Klassenbibliothek
view | history | commit | commitdiff
ulrich
2018-04-01 320c6e7085128d2196edb552c2076c72af789443
commit | author | age
c583a8 1
U 2 package de.uhilger.wbx.web;
3
4 import de.vogella.rss.model.Feed;
5 import de.vogella.rss.model.FeedMessage;
6 import java.io.File;
7 import java.io.FileReader;
8 import java.io.IOException;
9 import java.io.Reader;
10 import java.text.SimpleDateFormat;
11 import java.util.ArrayList;
12 import java.util.Calendar;
13 import java.util.Collections;
14 import java.util.Comparator;
15 import java.util.Date;
16 import java.util.GregorianCalendar;
17 import java.util.Iterator;
18 import java.util.List;
19 import java.util.Locale;
20 import java.util.logging.Level;
21 import java.util.logging.Logger;
22 import javax.naming.Context;
23 import javax.naming.InitialContext;
24 import javax.naming.NamingException;
25 import javax.servlet.ServletException;
26 import javax.servlet.ServletOutputStream;
27 import javax.servlet.http.HttpServlet;
28 import javax.servlet.http.HttpServletRequest;
29 import javax.servlet.http.HttpServletResponse;
30
31 /**
320c6e 32  * <p>Das FeedServlet erstellt Feeds von Ordnern der WebBox</p>
c583a8 33  * 
320c6e 34  * <p>Annahmen:</p>
U 35  * <ul>
36  * <li>Der JNDI-Parameter <code>wbxFileBase</code> enthaelt den absoluten Pfad 
37  * zur Dateiablage</li>
38  * <li>Der Parameter 'wbxPubDir' enthaelt den Namen des Ordners mit 
39  * oeffentlichen Inhalten und dieser Ordner liegt direkt unterhalb von 
40  * <code>wbxFileBase</code></li>
41  * <li>Der Ordner mit dem oeffentlichen Inhalt wird von Tomcat als Context 
42  * 1:1 ausgeliefert sodass bei einem URL wie 
43  * <code>http://example.com/[Context]/weitere/pfad/angaben/datei.html</code> 
44  * die Pfadangabe hinter <code>[Context]/</code> die Inhalte innerhalb von 
45  * <code>wbxFileBase/wbxPubDir</code> 1:1 wiedergibt.</li>
c583a8 46  * 
320c6e 47  * <p>Der JNDI-Parameter <code>wbxMaxFeedDepth</code> regelt, wie viele Ebenen der 
U 48  * Ordnerstruktur maximal nach Eintraegen durchsucht werden. Dabei haben die 
49  * tiefsten Ebenen Vorrang vor hoeher gelegenen Ebenen, d.h. Dateien auf 
50  * tieferen Ebenen werden vor Dateien auf hoeheren Ebenen in den Feed 
51  * aufgenommen.</p>
52  * 
53  * <p>Der JNDI-Parameter <code>wbxMaxFeedEntries</code> regelt, wie viele Beitraege 
54  * maximal im Feed erscheinen. Der Standardwert ist fuenf Beitraege, d.h., die 
55  * ersten fuenf gefundenen Beitraege werden chronologisch absteigend sortiert 
56  * nach ihrem letzten Aenderungsdatum ausgegeben.</p>
57  * 
58  * <p>Die Datei <code>CATALINA_BASE/conf/context.xml</code> muss also die 
59  * folgenden Eintraege enthalten:</p>
60  * <pre>
61  * <Environment name="wbxFileBase" type="java.lang.String" value="absoluter/pfad/zur/dateiablage" override="false" />
62  * <Environment name="wbxPubDir" type="java.lang.String" value="/www" override="false" />
63  * <Environment name="wbxFeedTitle" type="java.lang.String" value="Newsfeed" override="false" />
64  * <Environment name="wbxFeedSubtitle" type="java.lang.String" value="Text des Untertitels" override="false" />
65  * <Environment name="wbxFeedCopyright" type="java.lang.String" value="Text des Copyright-Hinweises" override="false" />
66  * <Environment name="wbxFeedDomain" type="java.lang.String" value="http://example.com" override="false" />
67  * <Environment name="wbxFeedAuthor" type="java.lang.String" value="Name des Autors" override="false" />
68  * </pre>
c583a8 69  */
U 70 public class FeedServlet extends HttpServlet {
71   
72   private static final Logger logger = Logger.getLogger(FeedServlet.class.getName());
73   
74   public static final String JNDI_CTX_NAME = "java:comp/env";
75   public static final String WBX_FILE_BASE = "wbxFileBase";
320c6e 76   public static final String WBX_PUB_DIR = "wbxPubDir";
c583a8 77   public static final String WBX_MAX_FEED_DEPTH = "wbxMaxFeedDepth";
U 78   public static final String WBX_MAX_FEED_ENTRIES = "wbxMaxFeedEntries";
320c6e 79   public static final String WBX_FEED_TITLE = "wbxFeedTitle";
U 80   public static final String WBX_FEED_SUBTITLE = "wbxFeedSubtitle";
81   public static final String WBX_FEED_COPYRIGHT = "wbxFeedCopyright";
82   public static final String WBX_FEED_DOMAIN = "wbxFeedDomain";
83   public static final String WBX_FEED_AUTHOR = "wbxFeedAuthor";
c583a8 84   
U 85   public static final int WBX_DEF_MAX_FEED_DEPTH = 3;
86   public static final int WBX_DEF_MAX_FEED_ENTRIES = 5;
87   
88   public static final String NOT_FOUND = " nicht gefunden";
89   public static final String NO_STRING = " ist kein String";  
90   
91   @Override
92   protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException {
93     ServletOutputStream out = response.getOutputStream();
94     response.setContentType("text/xml");
95     String url = request.getRequestURL().toString();
96     logger.fine("requestURL: " + url);
320c6e 97     String contextPath = request.getContextPath();
U 98     logger.fine("contextPath: " + contextPath);
99     String zielPfad = url.substring(url.indexOf(contextPath));
c583a8 100     logger.fine(zielPfad);
U 101     String basis = getJNDIParameter(WBX_FILE_BASE);
320c6e 102     logger.fine("basis: " + basis);
U 103     StringBuffer pfad = new StringBuffer();
104     pfad.append(basis);
105     pfad.append(zielPfad.replace(contextPath, getJNDIParameter(WBX_PUB_DIR)));
106     logger.fine("pfad: " + pfad);
107     String dirStr = pfad.toString().substring(0, pfad.lastIndexOf("/"));
108     logger.fine("dirStr: " + dirStr);
109     File dir = new File(dirStr);
110     if (dir.isDirectory()) {
111       List beitraege = new ArrayList();
112       int maxBeitraege = getJNDIInt(WBX_MAX_FEED_ENTRIES, WBX_DEF_MAX_FEED_ENTRIES);
113       int maxTiefe = getJNDIInt(WBX_MAX_FEED_DEPTH, WBX_DEF_MAX_FEED_DEPTH);
114       collectFiles(dir, 0, beitraege, maxTiefe, maxBeitraege);
115       Iterator i = beitraege.iterator();
116       while (i.hasNext()) {
117         File f = (File) i.next();
118         logger.fine(f.getAbsolutePath() + " " + f.lastModified());
c583a8 119       }
320c6e 120       writeFeed(getJNDIParameter(WBX_FEED_TITLE), 
U 121               getJNDIParameter(WBX_FEED_SUBTITLE), out, beitraege, 
122               basis, pfad.toString(), contextPath);
123     } else {
124       logger.fine(dir.getAbsolutePath() + " ist kein Ordner.");
125     }
c583a8 126   }
U 127   
128   /**
129    * Diese Methode funktioniert nur, wenn entweder ein Ordner uebergeben 
130    * wird, der keine Unterordner enthaelt wie zum Beispiel der Ordner 'neu' 
131    * der Bildersammlung oder ein Ordner, dessen Unterordner 
132    * nach dem Schema Jahr, Monat benannt sind wie bei einem Journal, das 
133    * die Beitraege wie folgt enthaelt:
134    * Journal-Ordner
135    *   2018
136    *     12
137    *     11
138    *     10
139    *     usw.
140    *   2017
141    *     12
142    *     11
143    *     10
144    *     usw.
145    * 
146    * @param out
147    * @param dir
148    * @param tiefe
149    * @param dateizaehler 
150    */
151   private void collectFiles(File dir, int tiefe, List beitraege, int maxTiefe, int maxBeitraege) {
152     List dirs = new ArrayList();
153     List beitraegeHier = new ArrayList();
154     File[] files = dir.listFiles();
155     for(int i = 0; i < files.length; i++) {
156       if(files[i].isDirectory()) {
157         if(tiefe < maxTiefe) {
158           dirs.add(files[i]);
159         }
160       } else {
161         beitraegeHier.add(files[i]);
162       }
163     }
164       
165     if(dirs.size() > 0) {
166       // hier zuvor die Verzeichnissse absteigend nach Name sortieren      
167       Collections.sort(dirs, new Comparator<File>() {
168         @Override
169         public int compare(File o1, File o2) {
170           return o2.getName().compareTo(o1.getName());
171         }
172       });
173       
174       Iterator i = dirs.iterator();
175       while(i.hasNext() && beitraege.size() < maxBeitraege) {
176         collectFiles((File) i.next(), tiefe+1, beitraege, maxTiefe, maxBeitraege);
177       }
178     } 
179     if(beitraegeHier.size() > 0) {
180       // hier zuvor die Liste der Beitraege dieses Ordners nach lastModified absteigend sortieren
181       // dann die neuesten in beitraege aufnehmen, bis die maximale Zahl gesuchter 
182       // neuer Beitraege erreicht ist.
183       
184       Collections.sort(beitraegeHier, new Comparator<File>() {
185         @Override
186         public int compare(File o1, File o2) {
187           int ergebnis;
188           if(o1.lastModified() > o2.lastModified()) {
189             ergebnis = -1;
190           } else if(o2.lastModified() > o1.lastModified()) {
191             ergebnis = 1;
192           } else {
193             ergebnis = 0;
194           }
195           return ergebnis;
196         }
197       });
198       
199       Iterator i = beitraegeHier.iterator();
200       while(i.hasNext() && beitraege.size() < maxBeitraege) {
201         File bf = (File) i.next();
202         String nm = bf.getName().toLowerCase();
203         if(nm.endsWith(".htmi") || nm.endsWith(".html") || nm.endsWith(".htm") || 
204            nm.endsWith(".jpg") || nm.endsWith(".jpeg") || nm.endsWith(".png") || 
205            nm.endsWith(".txt")) {
206           beitraege.add(bf);
207         }
208       }
209       
210     }
211   }
212   
320c6e 213   public void writeFeed(String feedTitel, String beschr, ServletOutputStream s, 
U 214           List beitraege, String basis, String pfad, String contextPath) {
215     String copyright = getJNDIParameter(WBX_FEED_COPYRIGHT);
216     String domain = getJNDIParameter(WBX_FEED_DOMAIN);
c583a8 217     String title = feedTitel;
U 218     String description = beschr;
219     String language = "de";
320c6e 220     String link = domain;
c583a8 221     Calendar cal = new GregorianCalendar();
U 222     Date creationDate = cal.getTime();
223     SimpleDateFormat date_format = new SimpleDateFormat(
224             "EEE', 'dd' 'MMM' 'yyyy' 'HH:mm:ss' 'Z", Locale.US);
225     String pubdate = date_format.format(creationDate);
226     Feed rssFeed = new Feed(title, link, description, language,
227             copyright, pubdate);
228
229     Iterator i = beitraege.iterator();
230     while (i.hasNext()) {
231       File f = (File) i.next();
232       FeedMessage feedEintrag = new FeedMessage();
233       feedEintrag.setTitle(f.getName());
234       //feedEintrag.setDescription("Beschreibung hier");
320c6e 235       feedEintrag.setAuthor(getJNDIParameter(WBX_FEED_AUTHOR));
c583a8 236
U 237       String urlStr = f.getAbsolutePath();
320c6e 238       urlStr = urlStr.replace(basis, domain);
U 239       urlStr = urlStr.replace(getJNDIParameter(WBX_PUB_DIR), contextPath);
c583a8 240
U 241       logger.fine(urlStr);
242
243       feedEintrag.setGuid(urlStr);
244       feedEintrag.setLink(urlStr);
245       logger.fine(f.getName());
246       feedEintrag.setDescription(readFilePart(f, urlStr));
247       rssFeed.getMessages().add(feedEintrag);
248     }
249
250     FeedStreamWriter writer = new FeedStreamWriter(rssFeed, s);
251     try {
252       writer.write();
253     } catch (Exception e) {
254       logger.log(Level.SEVERE, e.getMessage(), e);
255     }
256   }
257   
258   private String readFilePart(File f, String urlStr) {
259     StringBuffer buf = new StringBuffer();
260     Reader reader = null;
261     try {
262       String fn = f.getName().toLowerCase();
263       if(fn.endsWith(".jpg") || fn.endsWith(".jpeg") || fn.endsWith(".png")) {
264         String noExt;
265         String ext;
266         int dotpos = urlStr.lastIndexOf('.');
267         if(dotpos > -1) {
268           noExt = urlStr.substring(0, dotpos);
269           ext = urlStr.substring(dotpos);
270         } else {
271           noExt = "";
272           ext = "";
273         }
274         buf.append("<a href='");
275         buf.append(urlStr);
276         buf.append("'><img src='");
277         buf.append(noExt);
278         buf.append("_kl");
279         buf.append(ext);
280         buf.append("'></a>");
281       } else {
282         reader = new FileReader(f);
283         char[] readBuffer = new char[1024];
284         int charsRead = reader.read(readBuffer);
285         buf.append(readBuffer);
286         reader.close();
287       }
288       return buf.toString();
289     } catch (Exception ex) {
290       logger.log(Level.SEVERE, null, ex);
291       return buf.toString();
292     }
293   }
294   
295   private int getJNDIInt(String paramName, int defaultVal) {
296     String jndiStr = getJNDIParameter(paramName);
297     try {
298       return Integer.parseInt(jndiStr);
299     } catch(NumberFormatException ex) {
300       return defaultVal;
301     }
302   }
303   
304   private String getJNDIParameter(String pname) {
305     try {
306       // unseren environment naming context ermitteln
307       Context initCtx = new InitialContext();
308       Context envCtx = (Context) initCtx.lookup(JNDI_CTX_NAME);
309       
310       // unseren Parameter lesen
311       Object o = envCtx.lookup(pname);
312       if(o instanceof String) {
313         return o.toString();      
314       } else {
315         return NO_STRING;
316       }
317     } catch (NamingException ex) {
318       logger.log(Level.SEVERE, ex.getMessage());
319       return NOT_FOUND;
320     }
321   }  
322   
323 }