1 /*
2 * Copyright (c) 2002-2019, 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.botpress.service;
35
36 import fr.paris.lutece.plugins.botpress.business.BPBot;
37 import fr.paris.lutece.plugins.botpress.business.BPBotHome;
38 import fr.paris.lutece.plugins.chatbot.service.BotService;
39 import fr.paris.lutece.plugins.chatbot.service.bot.ChatBot;
40 import fr.paris.lutece.portal.service.i18n.I18nService;
41 import fr.paris.lutece.util.ReferenceList;
42 import java.util.Locale;
43
44 /**
45 * BotRegistrationService
46 */
47 public class BotRegistrationService
48 {
49
50 private static final String MESSAGE_STATUS_ENABLED = "botpress.bot_status.enabled";
51 private static final String MESSAGE_STATUS_DISABLED = "botpress.bot_status.disabled";
52 private static final String MESSAGE_MODE_STANDARD = "botpress.mode.standard";
53 private static final String MESSAGE_MODE_STANDALONE = "botpress.mode.standalone";
54
55 private static final int STATUS_ENABLED = 1;
56 private static final int STATUS_DISABLED = 0;
57 private static final int MODE_STANDARD = 0;
58 private static final int MODE_STANDALONE = 1;
59
60 private static ReferenceList _listStatus;
61
62 /** private constructor */
63 private BotRegistrationService()
64 {
65 }
66
67 /**
68 * Register all bots
69 */
70 public static void registerAllBots( )
71 {
72 for ( BPBot bot : BPBotHome.getBPBotsList( ) )
73 {
74 ChatBot chatbot = new BotInstance( bot );
75 BotService.register( chatbot );
76 }
77 }
78
79 /**
80 * Returns the list of available bot status
81 *
82 * @param locale
83 * The locale
84 * @return The list
85 */
86 public static synchronized ReferenceList getBotsStatusList( Locale locale )
87 {
88 if ( _listStatus == null )
89 {
90 _listStatus = new ReferenceList( );
91 _listStatus.addItem( STATUS_DISABLED, I18nService.getLocalizedString( MESSAGE_STATUS_DISABLED, locale ) );
92 _listStatus.addItem( STATUS_ENABLED, I18nService.getLocalizedString( MESSAGE_STATUS_ENABLED, locale ) );
93 }
94 return _listStatus;
95 }
96
97 /**
98 * Register the bot
99 *
100 * @param botInstance
101 * The bot instance
102 * @param nStatus
103 * The status
104 */
105 public static void register( BotInstance botInstance, int nStatus )
106 {
107 if ( nStatus == STATUS_ENABLED )
108 {
109 BotService.register( botInstance );
110 }
111 }
112
113 /**
114 * Un register the bot
115 *
116 * @param strBotKey
117 * The bot key
118 */
119 public static void unregister( String strBotKey )
120 {
121 BotService.unregister( strBotKey );
122 }
123
124 /**
125 * Return the list of mode
126 * @param locale The locale to translate mode
127 * @return The list
128 */
129 public static ReferenceList getModes( Locale locale )
130 {
131 ReferenceList list = new ReferenceList( );
132
133 list.addItem( MODE_STANDARD, I18nService.getLocalizedString( MESSAGE_MODE_STANDARD, locale ) );
134 list.addItem( MODE_STANDALONE, I18nService.getLocalizedString( MESSAGE_MODE_STANDALONE, locale ) );
135
136 return list;
137 }
138 }