org.sonar.db.property.PropertiesDao Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-db Show documentation
Show all versions of sonar-db Show documentation
Create and request SonarQube schema
/*
* SonarQube
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* 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.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.db.property;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.apache.commons.dbutils.DbUtils;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.resources.Scopes;
import org.sonar.db.Dao;
import org.sonar.db.DatabaseUtils;
import org.sonar.db.DbSession;
import org.sonar.db.MyBatis;
public class PropertiesDao implements Dao {
private static final String NOTIFICATION_PREFIX = "notification.";
private MyBatis mybatis;
public PropertiesDao(MyBatis mybatis) {
this.mybatis = mybatis;
}
/**
* Returns the logins of users who have subscribed to the given notification dispatcher with the given notification channel.
* If a resource ID is passed, the search is made on users who have specifically subscribed for the given resource.
*
* @return the list of logins (maybe be empty - obviously)
*/
public List selectUsersForNotification(String notificationDispatcherKey, String notificationChannelKey,
@Nullable String projectUuid) {
DbSession session = mybatis.openSession(false);
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
try {
return mapper.findUsersForNotification(NOTIFICATION_PREFIX + notificationDispatcherKey + "." + notificationChannelKey, projectUuid);
} finally {
MyBatis.closeQuietly(session);
}
}
public List selectNotificationSubscribers(String notificationDispatcherKey, String notificationChannelKey, @Nullable String componentKey) {
DbSession session = mybatis.openSession(false);
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
try {
return mapper.findNotificationSubscribers(NOTIFICATION_PREFIX + notificationDispatcherKey + "." + notificationChannelKey, componentKey);
} finally {
MyBatis.closeQuietly(session);
}
}
public boolean hasProjectNotificationSubscribersForDispatchers(String projectUuid, Collection dispatcherKeys) {
DbSession session = mybatis.openSession(false);
Connection connection = session.getConnection();
PreparedStatement pstmt = null;
ResultSet rs = null;
String sql = "SELECT count(1) FROM properties pp " +
"left outer join projects pj on pp.resource_id = pj.id " +
"where pp.user_id is not null and (pp.resource_id is null or pj.uuid=?) " +
"and (" + DatabaseUtils.repeatCondition("pp.prop_key like ?", dispatcherKeys.size(), "or") + ")";
try {
pstmt = connection.prepareStatement(sql);
pstmt.setString(1, projectUuid);
int index = 2;
for (String dispatcherKey : dispatcherKeys) {
pstmt.setString(index, "notification." + dispatcherKey + ".%");
index++;
}
rs = pstmt.executeQuery();
return rs.next() && rs.getInt(1) > 0;
} catch (SQLException e) {
throw new IllegalStateException("Fail to execute SQL request: " + sql, e);
} finally {
DbUtils.closeQuietly(connection, pstmt, rs);
MyBatis.closeQuietly(session);
}
}
public List selectGlobalProperties() {
DbSession session = mybatis.openSession(false);
try {
return selectGlobalProperties(session);
} finally {
MyBatis.closeQuietly(session);
}
}
public List selectGlobalProperties(DbSession session) {
return session.getMapper(PropertiesMapper.class).selectGlobalProperties();
}
@CheckForNull
public PropertyDto selectGlobalProperty(DbSession session, String propertyKey) {
return session.getMapper(PropertiesMapper.class).selectByKey(new PropertyDto().setKey(propertyKey));
}
@CheckForNull
public PropertyDto selectGlobalProperty(String propertyKey) {
DbSession session = mybatis.openSession(false);
try {
return selectGlobalProperty(session, propertyKey);
} finally {
MyBatis.closeQuietly(session);
}
}
public List selectProjectProperties(DbSession session, String projectKey) {
return session.getMapper(PropertiesMapper.class).selectProjectProperties(projectKey);
}
public List selectProjectProperties(String resourceKey) {
DbSession session = mybatis.openSession(false);
try {
return selectProjectProperties(session, resourceKey);
} finally {
MyBatis.closeQuietly(session);
}
}
public List selectEnabledDescendantModuleProperties(String moduleUuid, DbSession session) {
return session.getMapper(PropertiesMapper.class).selectDescendantModuleProperties(moduleUuid, Scopes.PROJECT, true);
}
@CheckForNull
public PropertyDto selectProjectProperty(long resourceId, String propertyKey) {
DbSession session = mybatis.openSession(false);
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
try {
return mapper.selectByKey(new PropertyDto().setKey(propertyKey).setResourceId(resourceId));
} finally {
MyBatis.closeQuietly(session);
}
}
public List selectByQuery(PropertyQuery query, DbSession session) {
return session.getMapper(PropertiesMapper.class).selectByQuery(query);
}
public void insertProperty(DbSession session, PropertyDto property) {
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
PropertyDto persistedProperty = mapper.selectByKey(property);
if (persistedProperty != null && !StringUtils.equals(persistedProperty.getValue(), property.getValue())) {
persistedProperty.setValue(property.getValue());
mapper.update(persistedProperty);
} else if (persistedProperty == null) {
mapper.insert(property);
}
}
public void insertProperty(PropertyDto property) {
DbSession session = mybatis.openSession(false);
try {
insertProperty(session, property);
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
public void deleteById(DbSession dbSession, long id) {
dbSession.getMapper(PropertiesMapper.class).deleteById(id);
}
public void deleteProjectProperty(String key, Long projectId) {
DbSession session = mybatis.openSession(false);
try {
deleteProjectProperty(key, projectId, session);
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
public void deleteProjectProperty(String key, Long projectId, DbSession session) {
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
mapper.deleteProjectProperty(key, projectId);
}
public void deleteProjectProperties(String key, String value, DbSession session) {
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
mapper.deleteProjectProperties(key, value);
}
public void deleteProjectProperties(String key, String value) {
DbSession session = mybatis.openSession(false);
try {
deleteProjectProperties(key, value, session);
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
public void deleteGlobalProperties() {
DbSession session = mybatis.openSession(false);
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
try {
mapper.deleteGlobalProperties();
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
public void deleteGlobalProperty(String key, DbSession session) {
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
mapper.deleteGlobalProperty(key);
}
public void deleteGlobalProperty(String key) {
DbSession session = mybatis.openSession(false);
try {
deleteGlobalProperty(key, session);
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
public void deleteAllProperties(String key) {
DbSession session = mybatis.openSession(false);
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
try {
mapper.deleteAllProperties(key);
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
public void insertGlobalProperties(Map properties) {
DbSession session = mybatis.openSession(true);
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
try {
for (Map.Entry entry : properties.entrySet()) {
mapper.deleteGlobalProperty(entry.getKey());
}
for (Map.Entry entry : properties.entrySet()) {
mapper.insert(new PropertyDto().setKey(entry.getKey()).setValue(entry.getValue()));
}
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
public void renamePropertyKey(String oldKey, String newKey) {
Preconditions.checkArgument(!Strings.isNullOrEmpty(oldKey), "Old property key must not be empty");
Preconditions.checkArgument(!Strings.isNullOrEmpty(newKey), "New property key must not be empty");
if (!newKey.equals(oldKey)) {
DbSession session = mybatis.openSession(false);
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
try {
mapper.renamePropertyKey(oldKey, newKey);
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
}
/**
* Update all properties (global and projects ones) with a given key and value to a new value
*/
public void updateProperties(String key, String oldValue, String newValue) {
DbSession session = mybatis.openSession(false);
try {
updateProperties(key, oldValue, newValue, session);
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
public void updateProperties(String key, String oldValue, String newValue, DbSession session) {
PropertiesMapper mapper = session.getMapper(PropertiesMapper.class);
mapper.updateProperties(key, oldValue, newValue);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy