1 /*
2 * Copyright (c) 2002-2023, City of 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.document.service.autoarchiving;
35
36 import fr.paris.lutece.plugins.document.business.Document;
37 import fr.paris.lutece.plugins.document.business.autopublication.DocumentAutoPublication;
38 import fr.paris.lutece.plugins.document.business.portlet.DocumentListPortletHome;
39 import fr.paris.lutece.plugins.document.business.workflow.DocumentState;
40 import fr.paris.lutece.plugins.document.service.DocumentException;
41 import fr.paris.lutece.plugins.document.service.DocumentService;
42 import fr.paris.lutece.plugins.document.service.publishing.PublishingService;
43 import fr.paris.lutece.portal.business.portlet.Portlet;
44 import fr.paris.lutece.portal.business.portlet.PortletHome;
45 import fr.paris.lutece.portal.service.util.AppLogService;
46
47
48 /**
49 *
50 * AutoArchiving Service
51 */
52 public class AutoArchivingService
53 {
54 private static AutoArchivingService _singleton;
55
56 /**
57 * Get the unique instance of AutoArchivingService
58 * @return The unique AutoArchivingService instance
59 */
60 public static AutoArchivingService getInstance( )
61 {
62 if ( _singleton == null )
63 {
64 _singleton = new AutoArchivingService( );
65 }
66
67 return _singleton;
68 }
69
70 /**
71 * Initialize the {@link AutoArchivingService} service
72 *
73 */
74 public void init( )
75 {
76 DocumentAutoPublication.init( );
77 }
78
79 /**
80 * Execute the auto archiving process
81 * @return The logs
82 */
83 public String processAutoArchiving( )
84 {
85 StringBuffer sbLogs = new StringBuffer( );
86
87 sbLogs.append( "\r\n[Start] Starting Auto archiving daemon...\r\n" );
88
89 long lDuration = System.currentTimeMillis( );
90
91 for ( Portlet portlet : PortletHome.findByType( DocumentListPortletHome.getInstance( ).getPortletTypeId( ) ) )
92 {
93 for ( Document document : PublishingService.getInstance( )
94 .getPublishedDocumentsByPortletId( portlet.getId( ) ) )
95 {
96 if ( document.isOutOfDate( ) )
97 {
98 sbLogs.append( "\r\nArchiving Document " + document.getId( ) + " : '" + document.getTitle( ) +
99 "'...\r\n" );
100
101 try
102 {
103 DocumentService.getInstance( ).archiveDocument( document, null, DocumentState.STATE_ARCHIVED );
104 }
105 catch ( DocumentException e )
106 {
107 AppLogService.error( "[AutoArchivingDaemon] Error when archiving document (id:" +
108 document.getId( ) + "). " + e.getMessage( ) );
109 }
110 }
111 }
112 }
113
114 sbLogs.append( "\r\n[End] Duration : " + ( System.currentTimeMillis( ) - lDuration ) + " milliseconds\r\n" );
115
116 return sbLogs.toString( );
117 }
118 }