|
1
15 package com.openedit;
16
17 import java.io.IOException  ;
18 import java.io.OutputStream ;
19 import java.io.Writer ;
20 import java.util.Enumeration ;
21 import java.util.HashMap ;
22 import java.util.HashSet ;
23 import java.util.Iterator ;
24 import java.util.Map ;
25 import java.util.Set ;
26
27 import javax.servlet.http.HttpServletRequest ;
28 import javax.servlet.http.HttpServletResponse ;
29 import javax.servlet.http.HttpSession ;
30
31 import org.apache.commons.logging.Log;
32 import org.apache.commons.logging.LogFactory;
33
34 import com.openedit.page.Page;
35 import com.openedit.page.PageAction;
36 import com.openedit.page.PageRequestKeys;
37 import com.openedit.page.PageStreamer;
38 import com.openedit.users.User;
39 import com.openedit.util.PathUtilities;
40 import com.openedit.util.SessionMap;
41 import com.openedit.util.URLUtilities;
42 import com.openedit.web.Browser;
43
44
47 public class BaseWebPageRequest implements WebPageRequest, PageRequestKeys
48 {
49 private static final Log log = LogFactory.getLog(BaseWebPageRequest.class);
50
51 protected HttpServletRequest fieldHttpServletRequest;
52 protected HttpServletResponse fieldHttpServletResponse;
53 protected HttpSession fieldHttpSession;
54
55 protected WebPageRequest fieldParent;
56 protected Map fieldVariables;
57 protected Set fieldProtectedFields;
58 protected Map fieldParameters;
59 protected Map fieldBackUpSession;
60 protected boolean fieldHasRedirected;
61 protected boolean fieldHasForwarded;
62 protected boolean fieldEditable;
63 public BaseWebPageRequest(WebPageRequest parent)
64 {
65 fieldParent = parent;
66 setEditable(parent.isEditable());
67 while( parent != null)
68 {
69 if (parent == this)
70 {
71 throw new OpenEditRuntimeException("can't set parent to self");
72 }
73 parent = parent.getParent();
74 }
75 }
76
77 public BaseWebPageRequest()
78 {
79 }
80
81 protected Set getProtectedFields()
82 {
83 if (fieldProtectedFields == null )
84 {
85 fieldProtectedFields = new HashSet ();
86 }
87 return fieldProtectedFields;
88 }
89
90 public WebPageRequest getParent()
91 {
92 return fieldParent;
93 }
94
95 public HttpServletRequest getRequest()
96 {
97 if (fieldHttpServletRequest == null && getParent() != null)
98 {
99 return getParent().getRequest();
100 }
101 return fieldHttpServletRequest;
102 }
103
104 public HttpServletResponse getResponse()
105 {
106 if (fieldHttpServletResponse == null && getParent() != null)
107 {
108 return getParent().getResponse();
109 }
110 return fieldHttpServletResponse;
111 }
112
113 public HttpSession getSession()
114 {
115 if (fieldHttpSession == null && getParent() != null)
116 {
117 return getParent().getSession();
118 }
119 return fieldHttpSession;
120 }
121
122 public void forward(String inUrl) throws OpenEditException
123 {
124 getPageStreamer().forward(inUrl, this);
126 }
127
128 public String getRequestParameter(String inKey)
129 {
130 if (getLocalParameters().containsKey(inKey) || getRequest() == null)
131 {
132 return (String ) getLocalParameters().get(inKey);
133 }
134 String value = getRequest().getParameter(inKey);
135 if ( value == null && getParent() != null)
136 {
137 value = getParent().getRequestParameter(inKey);
138 return value;
139 }
140 else
141 {
142 if ( value != null && value.length() == 0)
143 {
144 value = null; }
146 return value;
147 }
148 }
149
150
153 public Map getParameterMap()
154 {
155 if (getRequest() != null)
156 {
157 Map combinedparams = new HashMap ();
158 Enumeration enumeration = getRequest().getParameterNames();
159 while (enumeration.hasMoreElements())
160 {
161 String key = (String ) enumeration.nextElement();
162 String [] allv = getRequest().getParameterValues(key);
163 if( allv != null && allv.length == 1)
164 {
165 combinedparams.put(key, allv[0]);
166 }
167 else
168 {
169 combinedparams.put(key, allv);
170 }
171 }
172 combinedparams.putAll(getLocalParameters());
173 return combinedparams;
174 }
175 else
176 {
177 return getLocalParameters();
178 }
179 }
180
181 protected Map getLocalParameters()
182 {
183 if (fieldParameters == null)
184 {
185 fieldParameters = new HashMap ();
186 }
187 return fieldParameters;
188 }
189
190
193 public String getRequiredParameter(String inParameterName) throws OpenEditException
194 {
195 String req = getRequestParameter(inParameterName);
196 if (req == null)
197 {
198 throw new OpenEditException("Required parameter not found " + inParameterName);
199 }
200 return req;
201 }
202
203
206 public void put(String inKey, Object inValue) throws OpenEditException
207 {
208 putPageValue(inKey, inValue);
209 }
210
211 public Object get(String inKey)
212 {
213 return getPageValue(inKey);
214 }
215
216 public Object getPageValue(String inKey)
217 {
218 Object ret = getVariables().get(inKey);
219 if (ret == null && getParent() != null)
220 {
221 return getParent().getPageValue(inKey);
222 }
223 return ret;
224 }
225
226
229 public void redirect(String inUrl)
230 {
231 boolean alreadyRedirected = getPageValue("redirect") != null;
232 String home = (String ) getPageValue("home");
233 if (alreadyRedirected)
234 {
235 log.debug("Previous redirect to " + getPageValue("redirect")
236 + " requested, cannot redirect to " + inUrl);
237 return;
238 }
239
240 try
241 {
242 if (inUrl != null)
243 {
244 if (!inUrl.startsWith("http"))
245 {
246 if( inUrl.contains("./"))
247 {
248 inUrl = PathUtilities.resolveRelativePath(inUrl, getPath() );
249 }
250 inUrl = home + inUrl;
251 }
252 log.debug("Redirecting to: " + inUrl);
253 putPageValue("redirect", inUrl);
254 if (getResponse() != null)
255 {
256 getResponse().sendRedirect(inUrl);
257 }
258 else
259 {
260 log.error("No response set");
261 }
262 setHasRedirected(true);
263 }
264 }
265 catch (IOException e)
266 {
267 throw new OpenEditRuntimeException(e);
268 }
269 }
270
275 public void redirectPermanently( String inPath)
276 {
277 String home = (String ) getPageValue("home");
278 try
279 {
280 if (inPath != null)
281 {
282 log.debug("Perma redirect to: " + inPath);
283 if (!inPath.startsWith("http"))
284 {
285 inPath = home + inPath;
286 }
287 putPageValue("redirect", inPath);
288 if (getResponse() != null)
289 {
290 getResponse().setStatus(HttpServletResponse.SC_MOVED_PERMANENTLY);
291 getResponse().setHeader("Location", inPath);
292 getResponse().flushBuffer();
293 }
294 else
295 {
296 log.error("No response set");
297 }
298 setHasRedirected(true);
299 }
300 }
301 catch (IOException e)
302 {
303 throw new OpenEditRuntimeException(e);
304 }
305
306 }
307 protected Map getVariables()
308 {
309 if (fieldVariables == null)
310 {
311 fieldVariables = new HashMap ();
312 fieldVariables.put("context", this);
313 }
314 return fieldVariables;
315 }
316
317
320 public void putPageValue(String inKey, Object inObject)
321 {
322 if (getProtectedFields().contains(inKey) && getParent() != null)
323 {
324 throw new RuntimeException ("Restricted variables can only be set at the root level");
325 }
326 if (inObject == null)
327 {
328 getVariables().remove(inKey);
329 }
330 else
331 {
332 getVariables().put(inKey, inObject);
333 }
334 }
335
336 public void putProtectedPageValue(String inKey, Object inObject)
337 {
338 getProtectedFields().remove(inKey);
339 putPageValue(inKey, inObject);
340 getProtectedFields().add(inKey);
341 }
342
343
346 public void removePageValue(String inKey)
347 {
348 getVariables().remove(inKey);
349 }
350
351 public void setRequest(HttpServletRequest inReq)
352 {
353 fieldHttpServletRequest = inReq;
354 }
355
356 public void setResponse(HttpServletResponse inRes)
357 {
358 fieldHttpServletResponse = inRes;
359 }
360
361 public void setSession(HttpSession inS)
362 {
363 fieldHttpSession = inS;
364 }
365
366
369 public void setRequestParameter(String inKey, String inValue)
370 {
371 getLocalParameters().put(inKey, inValue);
372 }
373
374 public void setRequestParameter(String inKey, String [] inValue)
375 {
376 getLocalParameters().put(inKey, inValue);
377 }
378
379
382 public Map getPageMap()
383 {
384 Map combined = new HashMap ();
385 if (getParent() != null)
386 {
387 combined.putAll(getParent().getPageMap());
388 }
389 combined.putAll(getVariables());
390 return combined;
391 }
392
393
396 public String [] getRequestParameters(String inKey)
397 {
398 Object parameter = null;
399 if (getLocalParameters().containsKey(inKey))
400 {
401 parameter = getLocalParameters().get(inKey);
402 }
403 else if ( getRequest() != null)
404 {
405 parameter = getRequest().getParameterValues(inKey);
406 }
407 if( parameter == null && getParent() != null)
408 {
409 return getParent().getRequestParameters(inKey);
410 }
411 if (parameter instanceof String [] || parameter == null)
412 {
413 return (String []) parameter;
414 }
415 return new String []{(String ) parameter};
416 }
417
418
421 public Object getSessionValue(String inKey)
422 {
423 if (getSession() == null)
424 {
425 return getSessionValues().get(inKey);
426 }
427 return getSession().getAttribute(inKey);
428 }
429
430
433 public void putSessionValue(String inKey, Object inObject)
434 {
435 if (getSession() == null)
436 {
437 if( inObject == null)
438 {
439 getSessionValues().remove(inKey);
440 }
441 else
442 {
443 getSessionValues().put(inKey, inObject);
444 }
445 return;
446 }
447 if( inObject == null)
448 {
449 getSession().removeAttribute(inKey);
450 }
451 else
452 {
453 getSession().setAttribute(inKey, inObject);
454 }
455 putPageValue(inKey, inObject);
457 }
458
459
462 public void removeSessionValue(String inKey)
463 {
464 if (getSession() != null)
465 {
466 getSession().removeAttribute(inKey);
467 }
468 else
469 {
470 getSessionValues().remove(inKey);
471 }
472 }
473
474 public String getPath()
475 {
476 if ( getPage() == null)
477 {
478 return null;
479 }
480 return getPage().getPath();
481 }
482
483
487 public void putSessionValues(SessionMap inMap)
488 {
489 for (Iterator iter = inMap.keySet().iterator(); iter.hasNext();)
490 {
491 String key = (String ) iter.next();
492 putSessionValue(key, inMap.get(key));
493 }
494 }
495
496
500 public void putPageValues(SessionMap inMap)
501 {
502 getVariables().putAll(inMap);
503 }
504
505
508 public String getPathUrl()
509 {
510 URLUtilities util = (URLUtilities) get(URL_UTILITIES);
511 return util.requestPathWithArguments();
512 }
513
514 public OutputStream getOutputStream()
515 {
516 return getPageStreamer().getOutput().getStream();
517 }
518
519 public Writer getWriter()
520 {
521 return getPageStreamer().getOutput().getWriter();
522 }
523
524 public PageStreamer getPageStreamer()
525 {
526 return (PageStreamer) getPageValue(PAGES);
527 }
528
529 public void putPageStreamer(PageStreamer inStreamer)
530 {
531 putPageValue(PAGES, inStreamer);
532 }
533
534 public Page getPage()
535 {
536 Page content = (Page) getPageValue(PAGE);
537 return content;
538 }
539 public void setPage(Page inPage)
540 {
541 putPageValue(PAGE,inPage);
542 }
543
544 public Page getContentPage()
545 {
546 Page content = (Page) getPageValue(CONTENT);
547 return content;
548 }
549
550
554 protected Map getSessionValues()
555 {
556 if (fieldBackUpSession == null)
557 {
558 fieldBackUpSession = new HashMap ();
559 }
560 return fieldBackUpSession;
561 }
562
563
566 public boolean hasRedirected()
567 {
568 return fieldHasRedirected;
569 }
570 public void setHasRedirected( boolean inBol)
571 {
572 fieldHasRedirected = inBol;
573 }
574
575
578 public void setWriter(Writer inOutputStream)
579 {
580 putProtectedPageValue(OUTPUT_WRITER, inOutputStream);
581 }
582
583
607 public boolean isEditable()
608 {
609 return fieldEditable;
610 }
611 public void setEditable( boolean inEditable)
612 {
613 fieldEditable = inEditable;
614 }
615
616 public String [] getRequestActions()
617 {
618 String [] actions = getRequestParameters( "oe-action" );
619 if ( actions == null)
620 {
621 actions = getRequestParameters( "wsp-action" ); }
623 return actions;
624 }
625
626
629 public WebPageRequest copy()
630 {
631 return new BaseWebPageRequest(this);
632 }
633
634
637 public WebPageRequest copy(Page inPage)
638 {
639 BaseWebPageRequest req = new BaseWebPageRequest(this);
640 req.putProtectedPageValue(PageRequestKeys.PAGE,inPage);
641 return req;
642 }
643
644
647 public void setUser(User inUser)
648 {
649 if( inUser == null)
650 {
651 getVariables().remove(USER);
652 if (getParent() != null)
653 {
654 getParent().setUser(null);
655 }
656 }
657 else
658 {
659 putPageValue(USER,inUser);
660 }
661 }
662
663
664 public User getUser()
665 {
666 return (User) getPageValue(USER);
667 }
668
669
672 public void setContentPage(Page inPage)
673 {
674 putPageValue(CONTENT,inPage);
675 }
676
677
680 public void setCurrentAction(PageAction inAction)
681 {
682 putPageValue("exec-action",inAction);
683 }
684
685
688 public PageAction getCurrentAction()
689 {
690 return (PageAction)getPageValue("exec-action");
691 }
692 public String toString()
693 {
694 Object ret = getVariables().get("page");
695 if ( ret != null)
696 {
697 return "page="+ ret.toString();
698 }
699 else if ( getParent() != null)
700 {
701 return "child of " + getParent().toString();
702 }
703 return "no parent";
704 }
705
706 public String getContentProperty(String inKey)
707 {
708 Page page = getContentPage();
709 String locale = getLocale();
710 String prop = page.getProperty(inKey, locale );
711 return prop;
712 }
713
714 public String getPageProperty(String inKey)
715 {
716 Page page = getPage();
717 String locale = getLocale();
718 String prop = page.getProperty(inKey, locale );
719 return prop;
720 }
721
722 public String getLocale()
723 {
724 String locale = (String )getPageValue("sessionlocale");
725 if( locale == null || locale.length() == 0)
726 {
727 User user = getUser();
728 if( user != null)
729 {
730 locale = (String )user.get("locale");
731 }
732 }
733 if( locale == null || locale.length() == 0)
734 {
735 Browser browser = (Browser)getPageValue("browser");
736 if( browser != null && browser.getLocale() != null)
737 {
738 locale = browser.getLocale().toString();
739 }
740 }
741
742 return locale;
743 }
744
745 public String getLanguage()
746 {
747 String language = getLocale();
748 if( language != null)
749 {
750 int unds = language.indexOf('_');
751 if( unds > -1)
752 {
753 language = language.substring(0,unds);
754 }
755 }
756 return language;
757 }
758
759 public boolean hasForwarded()
760 {
761 return fieldHasForwarded;
762 }
763
764 public void setHasForwarded(boolean inB)
765 {
766 fieldHasForwarded = inB;
767 }
768
769 public String getUserName()
770 {
771 User user = getUser();
772 if( user != null)
773 {
774 return user.getUserName();
775 }
776 return "none";
777 }
778
779 }
780
|
Popular Tags
|
Java API By Example, From Geeks To Geeks.