/*
* Copyright 2010-2011 Ning, Inc.
*
* Ning licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package com.ning.billing.entitlement.engine.dao;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.List;
import java.util.UUID;
import org.joda.time.DateTime;
import org.skife.jdbi.v2.IDBI;
import org.skife.jdbi.v2.Transaction;
import org.skife.jdbi.v2.TransactionStatus;
import org.skife.jdbi.v2.sqlobject.mixins.Transmogrifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.base.Predicate;
import com.google.common.collect.Collections2;
import com.google.inject.Inject;
import com.ning.billing.ErrorCode;
import com.ning.billing.account.api.Account;
import com.ning.billing.account.dao.AccountSqlDao;
import com.ning.billing.catalog.api.Plan;
import com.ning.billing.catalog.api.Product;
import com.ning.billing.catalog.api.ProductCategory;
import com.ning.billing.entitlement.api.migration.AccountMigrationData;
import com.ning.billing.entitlement.api.migration.AccountMigrationData.BundleMigrationData;
import com.ning.billing.entitlement.api.migration.AccountMigrationData.SubscriptionMigrationData;
import com.ning.billing.entitlement.api.user.Subscription;
import com.ning.billing.entitlement.api.user.SubscriptionBundle;
import com.ning.billing.entitlement.api.user.SubscriptionBundleData;
import com.ning.billing.entitlement.api.user.SubscriptionData;
import com.ning.billing.entitlement.api.user.SubscriptionFactory;
import com.ning.billing.entitlement.api.user.SubscriptionFactory.SubscriptionBuilder;
import com.ning.billing.entitlement.engine.addon.AddonUtils;
import com.ning.billing.entitlement.engine.core.Engine;
import com.ning.billing.entitlement.events.EntitlementEvent;
import com.ning.billing.entitlement.events.EntitlementEvent.EventType;
import com.ning.billing.entitlement.events.user.ApiEvent;
import com.ning.billing.entitlement.events.user.ApiEventBuilder;
import com.ning.billing.entitlement.events.user.ApiEventCancel;
import com.ning.billing.entitlement.events.user.ApiEventChange;
import com.ning.billing.entitlement.events.user.ApiEventType;
import com.ning.billing.entitlement.exceptions.EntitlementError;
import com.ning.billing.util.clock.Clock;
import com.ning.billing.util.customfield.CustomField;
import com.ning.billing.util.customfield.dao.FieldStoreDao;
import com.ning.billing.util.notificationq.NotificationKey;
import com.ning.billing.util.notificationq.NotificationQueue;
import com.ning.billing.util.notificationq.NotificationQueueService;
import com.ning.billing.util.notificationq.NotificationQueueService.NoSuchNotificationQueue;
public class EntitlementSqlDao implements EntitlementDao {
private final static Logger log = LoggerFactory.getLogger(EntitlementSqlDao.class);
private final Clock clock;
private final SubscriptionSqlDao subscriptionsDao;
private final BundleSqlDao bundlesDao;
private final EventSqlDao eventsDao;
private final SubscriptionFactory factory;
private final NotificationQueueService notificationQueueService;
private final AddonUtils addonUtils;
@Inject
public EntitlementSqlDao(final IDBI dbi, final Clock clock, final SubscriptionFactory factory,
final AddonUtils addonUtils, final NotificationQueueService notificationQueueService) {
this.clock = clock;
this.factory = factory;
this.subscriptionsDao = dbi.onDemand(SubscriptionSqlDao.class);
this.eventsDao = dbi.onDemand(EventSqlDao.class);
this.bundlesDao = dbi.onDemand(BundleSqlDao.class);
this.notificationQueueService = notificationQueueService;
this.addonUtils = addonUtils;
}
@Override
public SubscriptionBundle getSubscriptionBundleFromKey(final String bundleKey) {
return bundlesDao.getBundleFromKey(bundleKey);
}
@Override
public List<SubscriptionBundle> getSubscriptionBundleForAccount(
final UUID accountId) {
return bundlesDao.getBundleFromAccount(accountId.toString());
}
@Override
public SubscriptionBundle getSubscriptionBundleFromId(final UUID bundleId) {
return bundlesDao.getBundleFromId(bundleId.toString());
}
@Override
public SubscriptionBundle createSubscriptionBundle(final SubscriptionBundleData bundle) {
return bundlesDao.inTransaction(new Transaction<SubscriptionBundle, BundleSqlDao>() {
@Override
public SubscriptionBundle inTransaction(BundleSqlDao bundlesDao, TransactionStatus status) {
bundlesDao.insertBundle(bundle);
return bundle;
}
});
}
@Override
public UUID getAccountIdFromSubscriptionId(final UUID subscriptionId) {
Subscription subscription = subscriptionsDao.getSubscriptionFromId(subscriptionId.toString());
if (subscription == null) {
log.error(String.format(ErrorCode.ENT_INVALID_SUBSCRIPTION_ID.getFormat(), subscriptionId.toString()));
return null;
}
UUID bundleId = subscription.getBundleId();
if (bundleId == null) {
log.error(String.format(ErrorCode.ENT_GET_NO_BUNDLE_FOR_SUBSCRIPTION.getFormat(), subscriptionId.toString()));
return null;
}
SubscriptionBundle bundle = bundlesDao.getBundleFromId(bundleId.toString());
if (bundle == null) {
log.error(String.format(ErrorCode.ENT_GET_INVALID_BUNDLE_ID.getFormat(), bundleId.toString()));
return null;
}
return bundle.getAccountId();
}
@Override
public Subscription getBaseSubscription(final UUID bundleId) {
return getBaseSubscription(bundleId, true);
}
@Override
public Subscription getSubscriptionFromId(final UUID subscriptionId) {
return buildSubscription(subscriptionsDao.getSubscriptionFromId(subscriptionId.toString()));
}
@Override
public List<Subscription> getSubscriptions(UUID bundleId) {
return buildBundleSubscriptions(subscriptionsDao.getSubscriptionsFromBundleId(bundleId.toString()));
}
@Override
public List<Subscription> getSubscriptionsForKey(String bundleKey) {
SubscriptionBundle bundle = bundlesDao.getBundleFromKey(bundleKey);
if (bundle == null) {
return Collections.emptyList();
}
return getSubscriptions(bundle.getId());
}
@Override
public void updateSubscription(final SubscriptionData subscription) {
final Date ctd = (subscription.getChargedThroughDate() != null) ? subscription.getChargedThroughDate().toDate() : null;
final Date ptd = (subscription.getPaidThroughDate() != null) ? subscription.getPaidThroughDate().toDate() : null;
subscriptionsDao.inTransaction(new Transaction<Void, SubscriptionSqlDao>() {
@Override
public Void inTransaction(SubscriptionSqlDao transactionalDao,
TransactionStatus status) throws Exception {
transactionalDao.updateSubscription(subscription.getId().toString(), subscription.getActiveVersion(), ctd, ptd);
return null;
}
});
}
@Override
public void createNextPhaseEvent(final UUID subscriptionId, final EntitlementEvent nextPhase) {
eventsDao.inTransaction(new Transaction<Void, EventSqlDao>() {
@Override
public Void inTransaction(EventSqlDao dao,
TransactionStatus status) throws Exception {
cancelNextPhaseEventFromTransaction(subscriptionId, dao);
dao.insertEvent(nextPhase);
recordFutureNotificationFromTransaction(dao,
nextPhase.getEffectiveDate(),
new NotificationKey() {
@Override
public String toString() {
return nextPhase.getId().toString();
}
});
return null;
}
});
}
@Override
public EntitlementEvent getEventById(UUID eventId) {
return eventsDao.getEventById(eventId.toString());
}
@Override
public List<EntitlementEvent> getEventsForSubscription(UUID subscriptionId) {
List<EntitlementEvent> events = eventsDao.getEventsForSubscription(subscriptionId.toString());
return events;
}
@Override
public List<EntitlementEvent> getPendingEventsForSubscription(UUID subscriptionId) {
Date now = clock.getUTCNow().toDate();
List<EntitlementEvent> results = eventsDao.getFutureActiveEventForSubscription(subscriptionId.toString(), now);
return results;
}
@Override
public void createSubscription(final SubscriptionData subscription,
final List<EntitlementEvent> initialEvents) {
subscriptionsDao.inTransaction(new Transaction<Void, SubscriptionSqlDao>() {
@Override
public Void inTransaction(SubscriptionSqlDao dao,
TransactionStatus status) throws Exception {
dao.insertSubscription(subscription);
// STEPH batch as well
EventSqlDao eventsDaoFromSameTransaction = dao.become(EventSqlDao.class);
for (final EntitlementEvent cur : initialEvents) {
eventsDaoFromSameTransaction.insertEvent(cur);
recordFutureNotificationFromTransaction(dao,
cur.getEffectiveDate(),
new NotificationKey() {
@Override
public String toString() {
return cur.getId().toString();
}
});
}
return null;
}
});
}
@Override
public void recreateSubscription(final UUID subscriptionId,
final List<EntitlementEvent> recreateEvents) {
eventsDao.inTransaction(new Transaction<Void, EventSqlDao>() {
@Override
public Void inTransaction(EventSqlDao dao,
TransactionStatus status) throws Exception {
for (final EntitlementEvent cur : recreateEvents) {
dao.insertEvent(cur);
recordFutureNotificationFromTransaction(dao,
cur.getEffectiveDate(),
new NotificationKey() {
@Override
public String toString() {
return cur.getId().toString();
}
});
}
return null;
}
});
}
@Override
public void cancelSubscription(final UUID subscriptionId, final EntitlementEvent cancelEvent) {
eventsDao.inTransaction(new Transaction<Void, EventSqlDao>() {
@Override
public Void inTransaction(EventSqlDao dao,
TransactionStatus status) throws Exception {
cancelNextCancelEventFromTransaction(subscriptionId, dao);
cancelNextChangeEventFromTransaction(subscriptionId, dao);
cancelNextPhaseEventFromTransaction(subscriptionId, dao);
dao.insertEvent(cancelEvent);
recordFutureNotificationFromTransaction(dao,
cancelEvent.getEffectiveDate(),
new NotificationKey() {
@Override
public String toString() {
return cancelEvent.getId().toString();
}
});
return null;
}
});
}
@Override
public void uncancelSubscription(final UUID subscriptionId, final List<EntitlementEvent> uncancelEvents) {
eventsDao.inTransaction(new Transaction<Void, EventSqlDao>() {
@Override
public Void inTransaction(EventSqlDao dao,
TransactionStatus status) throws Exception {
UUID existingCancelId = null;
Date now = clock.getUTCNow().toDate();
List<EntitlementEvent> events = dao.getFutureActiveEventForSubscription(subscriptionId.toString(), now);
for (EntitlementEvent cur : events) {
if (cur.getType() == EventType.API_USER && ((ApiEvent) cur).getEventType() == ApiEventType.CANCEL) {
if (existingCancelId != null) {
throw new EntitlementError(String.format("Found multiple cancel active events for subscriptions %s", subscriptionId.toString()));
}
existingCancelId = cur.getId();
}
}
if (existingCancelId != null) {
dao.unactiveEvent(existingCancelId.toString(), now);
for (final EntitlementEvent cur : uncancelEvents) {
dao.insertEvent(cur);
recordFutureNotificationFromTransaction(dao,
cur.getEffectiveDate(),
new NotificationKey() {
@Override
public String toString() {
return cur.getId().toString();
}
});
}
}
return null;
}
});
}
@Override
public void changePlan(final UUID subscriptionId, final List<EntitlementEvent> changeEvents) {
eventsDao.inTransaction(new Transaction<Void, EventSqlDao>() {
@Override
public Void inTransaction(EventSqlDao dao,
TransactionStatus status) throws Exception {
cancelNextChangeEventFromTransaction(subscriptionId, dao);
cancelNextPhaseEventFromTransaction(subscriptionId, dao);
for (final EntitlementEvent cur : changeEvents) {
dao.insertEvent(cur);
recordFutureNotificationFromTransaction(dao,
cur.getEffectiveDate(),
new NotificationKey() {
@Override
public String toString() {
return cur.getId().toString();
}
});
}
return null;
}
});
}
private void cancelNextPhaseEventFromTransaction(final UUID subscriptionId, final EventSqlDao dao) {
cancelFutureEventFromTransaction(subscriptionId, dao, EventType.PHASE, null);
}
private void cancelNextChangeEventFromTransaction(final UUID subscriptionId, final EventSqlDao dao) {
cancelFutureEventFromTransaction(subscriptionId, dao, EventType.API_USER, ApiEventType.CHANGE);
}
private void cancelNextCancelEventFromTransaction(final UUID subscriptionId, final EventSqlDao dao) {
cancelFutureEventFromTransaction(subscriptionId, dao, EventType.API_USER, ApiEventType.CANCEL);
}
private void cancelFutureEventFromTransaction(final UUID subscriptionId, final EventSqlDao dao, EventType type, ApiEventType apiType) {
UUID futureEventId = null;
Date now = clock.getUTCNow().toDate();
List<EntitlementEvent> events = dao.getFutureActiveEventForSubscription(subscriptionId.toString(), now);
for (EntitlementEvent cur : events) {
if (cur.getType() == type &&
(apiType == null || apiType == ((ApiEvent) cur).getEventType() )) {
if (futureEventId != null) {
throw new EntitlementError(
String.format("Found multiple future events for type %s for subscriptions %s",
type, subscriptionId.toString()));
}
futureEventId = cur.getId();
}
}
if (futureEventId != null) {
dao.unactiveEvent(futureEventId.toString(), now);
}
}
private void updateCustomFieldsFromTransaction(SubscriptionSqlDao transactionalDao, final SubscriptionData subscription) {
String subscriptionId = subscription.getId().toString();
String objectType = subscription.getObjectName();
FieldStoreDao fieldStoreDao = transactionalDao.become(FieldStoreDao.class);
fieldStoreDao.clear(subscriptionId, objectType);
List<CustomField> fieldList = subscription.getFieldList();
if (fieldList != null) {
fieldStoreDao.batchSaveFromTransaction(subscriptionId, objectType, fieldList);
}
}
private Subscription buildSubscription(Subscription input) {
if (input == null) {
return null;
}
List<Subscription> bundleInput = new ArrayList<Subscription>();
Subscription baseSubscription = null;
if (input.getCategory() == ProductCategory.ADD_ON) {
baseSubscription = getBaseSubscription(input.getBundleId(), false);
bundleInput.add(baseSubscription);
bundleInput.add(input);
} else {
bundleInput.add(input);
}
List<Subscription> reloadedSubscriptions = buildBundleSubscriptions(bundleInput);
for (Subscription cur : reloadedSubscriptions) {
if (cur.getId().equals(input.getId())) {
return cur;
}
}
throw new EntitlementError(String.format("Unexpected code path in buildSubscription"));
}
private List<Subscription> buildBundleSubscriptions(List<Subscription> input) {
// Make sure BasePlan -- if exists-- is first
Collections.sort(input, new Comparator<Subscription>() {
@Override
public int compare(Subscription o1, Subscription o2) {
if (o1.getCategory() == ProductCategory.BASE) {
return -1;
} else if (o2.getCategory() == ProductCategory.BASE) {
return 1;
} else {
return o1.getStartDate().compareTo(o2.getStartDate());
}
}
});
EntitlementEvent futureBaseEvent = null;
List<Subscription> result = new ArrayList<Subscription>(input.size());
for (Subscription cur : input) {
List<EntitlementEvent> events = eventsDao.getEventsForSubscription(cur.getId().toString());
Subscription reloaded = factory.createSubscription(new SubscriptionBuilder((SubscriptionData) cur), events);
switch (cur.getCategory()) {
case BASE:
Collection<EntitlementEvent> futureApiEvents = Collections2.filter(events, new Predicate<EntitlementEvent>() {
@Override
public boolean apply(EntitlementEvent input) {
return (input.getEffectiveDate().isAfter(clock.getUTCNow()) &&
((input instanceof ApiEventCancel) || (input instanceof ApiEventChange)));
}
});
futureBaseEvent = (futureApiEvents.size() == 0) ? null : futureApiEvents.iterator().next();
break;
case ADD_ON:
Plan targetAddOnPlan = reloaded.getCurrentPlan();
String baseProductName = (futureBaseEvent instanceof ApiEventChange) ?
((ApiEventChange) futureBaseEvent).getEventPlan() : null;
boolean createCancelEvent = (futureBaseEvent != null) &&
((futureBaseEvent instanceof ApiEventCancel) ||
((! addonUtils.isAddonAvailable(baseProductName, futureBaseEvent.getEffectiveDate(), targetAddOnPlan)) ||
(addonUtils.isAddonIncluded(baseProductName, futureBaseEvent.getEffectiveDate(), targetAddOnPlan))));
if (createCancelEvent) {
DateTime now = clock.getUTCNow();
EntitlementEvent addOnCancelEvent = new ApiEventCancel(new ApiEventBuilder()
.setSubscriptionId(reloaded.getId())
.setActiveVersion(((SubscriptionData) reloaded).getActiveVersion())
.setProcessedDate(now)
.setEffectiveDate(futureBaseEvent.getEffectiveDate())
.setRequestedDate(now)
// This event is only there to indicate the ADD_ON is future canceled, but it is not there
// on disk until the base plan cancellation becomes effective
.setFromDisk(false));
events.add(addOnCancelEvent);
// Finally reload subscription with full set of events
reloaded = factory.createSubscription(new SubscriptionBuilder((SubscriptionData) cur), events);
}
break;
default:
break;
}
loadCustomFields((SubscriptionData) reloaded);
result.add(reloaded);
}
return result;
}
@Override
public void migrate(final UUID accountId, final AccountMigrationData accountData) {
eventsDao.inTransaction(new Transaction<Void, EventSqlDao>() {
@Override
public Void inTransaction(EventSqlDao transEventDao,
TransactionStatus status) throws Exception {
SubscriptionSqlDao transSubDao = transEventDao.become(SubscriptionSqlDao.class);
BundleSqlDao transBundleDao = transEventDao.become(BundleSqlDao.class);
// First get rid of any data from account
undoMigrationFromTransaction(accountId, transEventDao, transBundleDao, transSubDao);
for (BundleMigrationData curBundle : accountData.getData()) {
SubscriptionBundleData bundleData = curBundle.getData();
for (SubscriptionMigrationData curSubscription : curBundle.getSubscriptions()) {
SubscriptionData subData = curSubscription.getData();
for (final EntitlementEvent curEvent : curSubscription.getInitialEvents()) {
transEventDao.insertEvent(curEvent);
recordFutureNotificationFromTransaction(transEventDao,
curEvent.getEffectiveDate(),
new NotificationKey() {
@Override
public String toString() {
return curEvent.getId().toString();
}
});
}
transSubDao.insertSubscription(subData);
}
transBundleDao.insertBundle(bundleData);
}
return null;
}
});
}
public Subscription getBaseSubscription(final UUID bundleId, boolean rebuildSubscription) {
List<Subscription> subscriptions = subscriptionsDao.getSubscriptionsFromBundleId(bundleId.toString());
for (Subscription cur : subscriptions) {
if (((SubscriptionData)cur).getCategory() == ProductCategory.BASE) {
return rebuildSubscription ? buildSubscription(cur) : cur;
}
}
return null;
}
@Override
public void undoMigration(final UUID accountId) {
eventsDao.inTransaction(new Transaction<Void, EventSqlDao>() {
@Override
public Void inTransaction(EventSqlDao transEventDao,
TransactionStatus status) throws Exception {
SubscriptionSqlDao transSubDao = transEventDao.become(SubscriptionSqlDao.class);
BundleSqlDao transBundleDao = transEventDao.become(BundleSqlDao.class);
undoMigrationFromTransaction(accountId, transEventDao, transBundleDao, transSubDao);
return null;
}
});
}
private void undoMigrationFromTransaction(final UUID accountId, EventSqlDao transEventDao, BundleSqlDao transBundleDao, SubscriptionSqlDao transSubDao) {
final List<SubscriptionBundle> bundles = transBundleDao.getBundleFromAccount(accountId.toString());
for (SubscriptionBundle curBundle : bundles) {
List<Subscription> subscriptions = transSubDao.getSubscriptionsFromBundleId(curBundle.getId().toString());
for (Subscription cur : subscriptions) {
eventsDao.removeEvents(cur.getId().toString());
transSubDao.removeSubscription(cur.getId().toString());
}
transBundleDao.removeBundle(curBundle.getId().toString());
}
}
private void recordFutureNotificationFromTransaction(final Transmogrifier transactionalDao, final DateTime effectiveDate, final NotificationKey notificationKey) {
try {
NotificationQueue subscriptionEventQueue = notificationQueueService.getNotificationQueue(Engine.ENTITLEMENT_SERVICE_NAME,
Engine.NOTIFICATION_QUEUE_NAME);
subscriptionEventQueue.recordFutureNotificationFromTransaction(transactionalDao, effectiveDate, notificationKey);
} catch (NoSuchNotificationQueue e) {
throw new RuntimeException(e);
}
}
@Override
public void saveCustomFields(final SubscriptionData subscription) {
subscriptionsDao.inTransaction(new Transaction<Void, SubscriptionSqlDao>() {
@Override
public Void inTransaction(SubscriptionSqlDao transactionalDao,
TransactionStatus status) throws Exception {
updateCustomFieldsFromTransaction(transactionalDao, subscription);
return null;
}
});
}
private void loadCustomFields(final SubscriptionData subscription) {
FieldStoreDao fieldStoreDao = subscriptionsDao.become(FieldStoreDao.class);
List<CustomField> fields = fieldStoreDao.load(subscription.getId().toString(), subscription.getObjectName());
subscription.clearFieldsInternal(false);
if (fields != null) {
subscription.addFieldsInternal(fields, false);
}
}
}