View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.childpages.business.portlet;
35  
36  import java.util.ArrayList;
37  import java.util.List;
38  
39  import fr.paris.lutece.portal.business.page.Page;
40  import fr.paris.lutece.portal.business.page.PageHome;
41  import fr.paris.lutece.portal.business.portlet.Portlet;
42  import fr.paris.lutece.portal.business.portlet.PortletHome;
43  import fr.paris.lutece.portal.service.page.PageEvent;
44  import fr.paris.lutece.portal.service.page.PageEventListener;
45  import fr.paris.lutece.portal.service.page.PageService;
46  
47  /**
48   * Listener to invalidate the portlets on page events
49   */
50  public class EventListener implements PageEventListener
51  {
52      /**
53       * flag to detect event processing reentry
54       */
55      private final ThreadLocal<Boolean> secondaryEvent;
56  
57      /**
58       * Constructor; registers the listener
59       */
60      public EventListener( )
61      {
62          secondaryEvent = new ThreadLocal<Boolean>( ) {
63  
64              @Override
65              protected Boolean initialValue( )
66              {
67                  return false;
68              }
69              
70          };
71          PageService.addPageEventListener( this );
72      }
73  
74      /**
75       * Invalidate childpages portlets if a relevant page is changed
76       * @param event the page event
77       */
78      @Override
79      public void processPageEvent( PageEvent event )
80      {
81          if ( secondaryEvent.get( ) )
82          {
83              // this event was generated by us invalidating a portlet;
84              // ignore
85              return;
86          }
87          // from now on, events processed on this thread are generated by
88          // us invalidating portlets
89          secondaryEvent.set( true );
90          try {
91              int parentPageId = event.getPage( ).getParentPageId( );
92              if ( parentPageId == 0 )
93              {
94                  // we reached the root
95                  return;
96              }
97              List<Integer> parentPageIds = new ArrayList<Integer>( 2 );
98              parentPageIds.add( parentPageId );
99              if ( parentPageId != event.getPage( ).getOrigParentPageId( ) )
100             {
101                 parentPageIds.add( event.getPage( ).getOrigParentPageId( ) );
102             }
103             for ( Integer pageId : parentPageIds )
104             {
105                 // invalidate portlets with the default parent page
106                 Page parentPage = PageHome.findByPrimaryKey( pageId );
107                 List<Portlet> portlets = parentPage.getPortlets( );
108                 String childPagesPortletId = ChildPagesPortletHome.getInstance( ).getPortletTypeId( );
109                 for ( Portlet aPortlet : portlets )
110                 {
111                     if ( aPortlet.getPortletTypeId( ).equals( childPagesPortletId ) )
112                     {
113                         ChildPagesPortlet../../fr/paris/lutece/plugins/childpages/business/portlet/ChildPagesPortlet.html#ChildPagesPortlet">ChildPagesPortlet cpPortlet = ( ChildPagesPortlet ) aPortlet;
114                         if ( cpPortlet.getParentPageId( ) == 0 )
115                         {
116                             PortletHome.invalidate( aPortlet );
117                         }
118                     }
119                 }
120                 // invalidate portlets with custom parent page
121                 List<ChildPagesPortlet> childPagesportlets = ChildPagesPortletHome.getChildPagesPortlets( pageId );
122                 for ( ChildPagesPortlet aPortlet : childPagesportlets )
123                 {
124                     PortletHome.invalidate( aPortlet );
125                 }
126             }
127         } finally
128         {
129             // we've finished processing the event
130             secondaryEvent.set( false );
131         }
132     }
133 }