/*!
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* Copyright (c) 2002-2016 Pentaho Corporation.. All rights reserved.
*/
package org.pentaho.platform.web.http.api.resources;
import org.codehaus.enunciate.Facet;
import org.pentaho.platform.api.engine.IPentahoSession;
import org.pentaho.platform.api.usersettings.IUserSettingService;
import org.pentaho.platform.api.usersettings.pojo.IUserSetting;
import org.pentaho.platform.engine.core.system.PentahoSessionHolder;
import org.pentaho.platform.engine.core.system.PentahoSystem;
import org.pentaho.platform.web.http.api.resources.utils.EscapeUtils;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Response;
import java.util.ArrayList;
import java.util.List;
import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
import static javax.ws.rs.core.MediaType.APPLICATION_XML;
/**
* This resource manages the user settings of the platform
*
*
*/
@Path( "/user-settings" )
@Facet( name = "Unsupported" )
public class UserSettingsResource extends AbstractJaxRSResource {
public UserSettingsResource() {
}
private IPentahoSession getPentahoSession() {
return PentahoSessionHolder.getSession();
}
/**
* Retrieve the global settings and the user settings for the current user
*
* @return list of settings for the platform
*/
@GET
@Path( "/list" )
@Produces( { APPLICATION_JSON, APPLICATION_XML } )
@Facet ( name = "Unsupported" )
public ArrayList<Setting> getUserSettings() {
try {
IUserSettingService settingsService = getUserSettingService();
List<IUserSetting> userSettings = settingsService.getUserSettings();
ArrayList<Setting> settings = new ArrayList<Setting>();
for ( IUserSetting userSetting : userSettings ) {
settings.add( new Setting( userSetting.getSettingName(), userSetting.getSettingValue() ) );
}
return settings;
} catch ( Exception e ) {
e.printStackTrace();
}
return null;
}
/**
* Retrieve a particular user setting for the current user
*
* @param setting (Name of the setting)
*
* @return value of the setting for the user
*/
@GET
@Path( "{setting : .+}" )
@Facet ( name = "Unsupported" )
public Response getUserSetting( @PathParam( "setting" ) String setting ) {
IUserSettingService settingsService = getUserSettingService();
IUserSetting userSetting = settingsService.getUserSetting( setting, null );
return Response.ok( userSetting != null ? userSetting.getSettingValue() : null ).build();
}
/**
* Save the value of a particular setting for the current user
*
* @param setting (Setting name)
* @param settingValue (Value of the setting)
*
* @return
*/
@POST
@Path( "{setting : .+}" )
@Facet ( name = "Unsupported" )
public Response setUserSetting( @PathParam( "setting" ) String setting, String settingValue ) {
IUserSettingService settingsService = getUserSettingService();
//preventing stored XSS(PPP-3464)
settingValue = EscapeUtils.escapeJsonOrRaw( settingValue );
settingsService.setUserSetting( setting, settingValue );
return Response.ok( settingValue ).build();
}
IUserSettingService getUserSettingService() {
return PentahoSystem.get( IUserSettingService.class, getPentahoSession() );
}
}