1 /*
2 * Copyright (c) 2002-2018, 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.appstore.service;
35
36 import fr.paris.lutece.plugins.appstore.business.Icon;
37 import fr.paris.lutece.plugins.appstore.business.IconHome;
38 import fr.paris.lutece.portal.service.image.ImageResource;
39 import fr.paris.lutece.portal.service.image.ImageResourceManager;
40 import fr.paris.lutece.portal.service.image.ImageResourceProvider;
41 import fr.paris.lutece.portal.service.plugin.Plugin;
42 import fr.paris.lutece.portal.service.plugin.PluginService;
43 import fr.paris.lutece.portal.web.constants.Parameters;
44 import fr.paris.lutece.util.url.UrlItem;
45
46 /**
47 * Service for Url entry types. Provide ImageResource managemenent
48 *
49 */
50 public class IconService implements ImageResourceProvider
51 {
52 private static final String PLUGIN_NAME = "appstore";
53 private static IconService _singleton = new IconService( );
54 private static final String IMAGE_RESOURCE_TYPE_ID = "appstore_icon_img";
55
56 /**
57 * Creates a new instance of IconService
58 */
59 IconService( )
60 {
61 }
62
63 /**
64 * Initializes the service
65 */
66 public void register( )
67 {
68 ImageResourceManager.registerProvider( this );
69 }
70
71 /**
72 * Get the unique instance of the service
73 *
74 * @return The unique instance
75 */
76 public static IconService getInstance( )
77 {
78 return _singleton;
79 }
80
81 /**
82 * Return the Resource id
83 *
84 * @param nIdResource
85 * The resource identifier
86 * @return The Resource Image
87 */
88 @Override
89 public ImageResource getImageResource( int nIdResource )
90 {
91 Plugin plugin = PluginService.getPlugin( PLUGIN_NAME );
92 Icon icon = IconHome.findByPrimaryKey( nIdResource, plugin );
93
94 if ( icon != null )
95 {
96 ImageResource imageResource = new ImageResource( );
97 imageResource.setImage( icon.getValue( ) );
98 imageResource.setMimeType( icon.getMimeType( ) );
99
100 return imageResource;
101 }
102
103 return null;
104 }
105
106 /**
107 * Return the Resource Type id
108 *
109 * @return The Resource Type Id
110 */
111 @Override
112 public String getResourceTypeId( )
113 {
114 return IMAGE_RESOURCE_TYPE_ID;
115 }
116
117 /**
118 * Management of the image associated to the {@link EntryUrl}
119 *
120 * @param nEntryUrl
121 * The {@link EntryUrl} identifier
122 * @return The url of the resource
123 */
124 public static String getResourceImageEntryUrl( int nEntryUrl )
125 {
126 String strResourceType = IconService.getInstance( ).getResourceTypeId( );
127 UrlItem url = new UrlItem( Parameters.IMAGE_SERVLET );
128 url.addParameter( Parameters.RESOURCE_TYPE, strResourceType );
129 url.addParameter( Parameters.RESOURCE_ID, Integer.toString( nEntryUrl ) );
130
131 return url.getUrlWithEntity( );
132 }
133 }