UpgradePermission.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library 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 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library 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.
 */

package com.liferay.announcements.web.internal.upgrade.v1_0_2;

import com.liferay.portal.kernel.dao.jdbc.DataAccess;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.ResourceAction;
import com.liferay.portal.kernel.model.ResourceConstants;
import com.liferay.portal.kernel.model.ResourcePermission;
import com.liferay.portal.kernel.security.permission.ActionKeys;
import com.liferay.portal.kernel.upgrade.UpgradeProcess;
import com.liferay.portal.kernel.util.StringBundler;
import com.liferay.portal.kernel.util.StringPool;

import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

import java.util.HashSet;
import java.util.Set;

/**
 * @author Roberto Díaz
 */
public class UpgradePermission extends UpgradeProcess {

	public UpgradePermission() {
		this(false);
	}

	public UpgradePermission(boolean ignoreMissingAddEntryResourceAction) {
		_ignoreMissingAddEntryResourceAction =
			ignoreMissingAddEntryResourceAction;
	}

	protected void addAnnouncementsAdminResourceActions() {
		addResourceAction(
			ActionKeys.ACCESS_IN_CONTROL_PANEL,
			_BITWISE_VALUE_ACCESS_IN_CONTROL_PANEL);
		addResourceAction(ActionKeys.VIEW, _BITWISE_VALUE_VIEW);
	}

	protected void addAnnouncementsAdminViewResourcePermission(
			long companyId, int scope, String primKey, long primKeyId,
			long roleId)
		throws Exception {

		String key = getKey(companyId, scope, primKey, roleId);

		if (_resourcePermissions.contains(key)) {
			return;
		}

		_resourcePermissions.add(key);

		PreparedStatement ps = null;

		try {
			long resourcePermissionId = increment(
				ResourcePermission.class.getName());

			long actionBitwiseValue =
				_BITWISE_VALUE_VIEW | _BITWISE_VALUE_ACCESS_IN_CONTROL_PANEL;

			String name =
				"com_liferay_announcements_web_portlet_" +
					"AnnouncementsAdminPortlet";
			long ownerId = 0;

			StringBundler sb = new StringBundler(4);

			sb.append("insert into ResourcePermission (mvccVersion, ");
			sb.append("resourcePermissionId, companyId, name, scope, ");
			sb.append("primKey, primKeyId, roleId, ownerId, actionIds, ");
			sb.append("viewActionId) values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)");

			String sql = sb.toString();

			ps = connection.prepareStatement(sql);

			ps.setLong(1, 0);
			ps.setLong(2, resourcePermissionId);
			ps.setLong(3, companyId);
			ps.setString(4, name);
			ps.setInt(5, scope);
			ps.setString(6, primKey);
			ps.setLong(7, primKeyId);
			ps.setLong(8, roleId);
			ps.setLong(9, ownerId);
			ps.setLong(10, actionBitwiseValue);
			ps.setBoolean(11, true);

			ps.executeUpdate();
		}
		catch (Exception e) {
			if (_log.isWarnEnabled()) {
				_log.warn("Unable to add resource permission", e);
			}
		}
		finally {
			DataAccess.cleanUp(ps);
		}
	}

	protected void addResourceAction(String actionId, long bitwiseValue) {
		PreparedStatement ps = null;

		try {
			long resourceActionId = increment(ResourceAction.class.getName());

			StringBundler sb = new StringBundler(4);

			sb.append("insert into ResourceAction (mvccVersion, ");
			sb.append("resourceActionId, name, actionId, bitwiseValue) ");
			sb.append("values (?, ?, ?, ?, ?)");

			String sql = sb.toString();

			ps = connection.prepareStatement(sql);

			ps.setLong(1, 0);
			ps.setLong(2, resourceActionId);
			ps.setString(
				3,
				"com_liferay_announcements_web_portlet_" +
					"AnnouncementsAdminPortlet");
			ps.setString(4, actionId);
			ps.setLong(5, bitwiseValue);

			ps.executeUpdate();
		}
		catch (Exception e) {
			if (_log.isWarnEnabled()) {
				_log.warn("Unable to add resource action", e);
			}
		}
		finally {
			DataAccess.cleanUp(ps);
		}
	}

	protected void deleteResourceAction(long resourceActionId)
		throws SQLException {

		PreparedStatement ps = connection.prepareStatement(
			"delete from ResourceAction where resourceActionId = ?");

		ps.setLong(1, resourceActionId);

		ps.executeUpdate();
	}

	@Override
	protected void doUpgrade() throws Exception {
		addAnnouncementsAdminResourceActions();

		upgradeAlertsResourcePermission();
		upgradeAnnouncementsResourcePermission();
	}

	protected String getKey(
		long companyId, int scope, String primKey, long roleId) {

		StringBundler sb = new StringBundler(7);

		sb.append(companyId);
		sb.append(StringPool.PERIOD);
		sb.append(scope);
		sb.append(StringPool.PERIOD);
		sb.append(primKey);
		sb.append(StringPool.PERIOD);
		sb.append(roleId);

		return sb.toString();
	}

	protected void updateResourcePermission(
			long resourcePermissionId, long bitwiseValue)
		throws Exception {

		PreparedStatement ps = connection.prepareStatement(
			"update ResourcePermission set actionIds = ? where " +
				"resourcePermissionId = ?");

		ps.setLong(1, bitwiseValue);
		ps.setLong(2, resourcePermissionId);

		ps.executeUpdate();
	}

	protected void upgradeAlertsResourcePermission() throws Exception {
		upgradeResourcePermission(
			"com_liferay_announcements_web_portlet_AlertsPortlet");
	}

	protected void upgradeAnnouncementsResourcePermission() throws Exception {
		upgradeResourcePermission(
			"com_liferay_announcements_web_portlet_AnnouncementsPortlet");
	}

	protected void upgradeResourcePermission(String name) throws Exception {
		StringBundler sb1 = new StringBundler(4);

		sb1.append("select resourceActionId, bitwiseValue from ");
		sb1.append("ResourceAction where actionId = 'ADD_ENTRY' and name = '");
		sb1.append(name);
		sb1.append("'");

		StringBundler sb2 = new StringBundler(5);

		sb2.append("select resourcePermissionId, companyId, scope, primKey, ");
		sb2.append("primKeyId, roleId, actionIds from ");
		sb2.append("ResourcePermission where name = '");
		sb2.append(name);
		sb2.append("'");

		try (PreparedStatement ps1 = connection.prepareStatement(
				sb1.toString());

			ResultSet rs1 = ps1.executeQuery()) {

			if (!rs1.next()) {
				if (!_ignoreMissingAddEntryResourceAction) {
					_log.error(
						"Unable to upgrade ADD_ENTRY action, ResourceAction " +
							"for " + name + " is not initialized");
				}

				return;
			}

			long resourceActionId = rs1.getLong("resourceActionId");
			long bitwiseValue = rs1.getLong("bitwiseValue");

			try (PreparedStatement ps2 = connection.prepareStatement(
					sb2.toString());

				ResultSet rs = ps2.executeQuery()) {

				while (rs.next()) {
					long resourcePermissionId = rs.getLong(
						"resourcePermissionId");
					long companyId = rs.getLong("companyId");
					int scope = rs.getInt("scope");
					String primKey = rs.getString("primKey");
					long primKeyId = rs.getLong("primKeyId");
					long roleId = rs.getLong("roleId");
					long actionIds = rs.getLong("actionIds");

					if ((bitwiseValue & actionIds) == 0) {
						continue;
					}

					updateResourcePermission(
						resourcePermissionId, actionIds - bitwiseValue);

					if (scope == ResourceConstants.SCOPE_INDIVIDUAL) {
						if (primKey.contains("_LAYOUT_")) {
							primKey = String.valueOf(companyId);
							primKeyId = companyId;
							scope = ResourceConstants.SCOPE_COMPANY;
						}
						else {
							continue;
						}
					}

					addAnnouncementsAdminViewResourcePermission(
						companyId, scope, primKey, primKeyId, roleId);
				}
			}

			deleteResourceAction(resourceActionId);
		}
	}

	/**
	 * @see com.liferay.portal.service.impl.ResourceActionLocalServiceImpl#checkResourceActions
	 */
	private static final long _BITWISE_VALUE_ACCESS_IN_CONTROL_PANEL = 1 << 1;

	private static final long _BITWISE_VALUE_VIEW = 1;

	private static final Log _log = LogFactoryUtil.getLog(
		UpgradePermission.class);

	private final boolean _ignoreMissingAddEntryResourceAction;
	private final Set<String> _resourcePermissions = new HashSet<>();

}