DefaultModelBridge.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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 software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.notifications.internal;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import javax.inject.Inject;
import javax.inject.Provider;
import javax.inject.Singleton;

import org.xwiki.component.annotation.Component;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.model.reference.SpaceReference;
import org.xwiki.model.reference.WikiReference;
import org.xwiki.notifications.NotificationException;
import org.xwiki.notifications.NotificationPreference;

import com.xpn.xwiki.XWiki;
import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.XWikiException;
import com.xpn.xwiki.doc.XWikiDocument;
import com.xpn.xwiki.objects.BaseObject;

/**
 * Default implementation for {@link ModelBridge}.
 *
 * @version $Id: 5fc752f25a60026ad54f6e9a4f815329c08aa115 $
 */
@Component
@Singleton
public class DefaultModelBridge implements ModelBridge
{
    private static final SpaceReference NOTIFICATION_CODE_SPACE = new SpaceReference("Code",
        new SpaceReference("Notifications",
            new SpaceReference("XWiki", new WikiReference("toChange"))
        )
    );

    private static final DocumentReference NOTIFICATION_PREFERENCE_CLASS = new DocumentReference(
            "NotificationPreferenceClass", NOTIFICATION_CODE_SPACE
    );

    private static final DocumentReference NOTIFICATION_START_DATE_CLASS = new DocumentReference(
            "NotificationsStartDateClass", NOTIFICATION_CODE_SPACE
    );

    private static final String START_DATE = "startDate";

    @Inject
    private Provider<XWikiContext> contextProvider;

    @Override
    public List<NotificationPreference> getNotificationsPreferences(DocumentReference userReference)
            throws NotificationException
    {
        XWikiContext context = contextProvider.get();
        XWiki xwiki = context.getWiki();

        final DocumentReference notificationPreferencesClass
                = NOTIFICATION_PREFERENCE_CLASS.setWikiReference(userReference.getWikiReference());

        List<NotificationPreference> preferences = new ArrayList<>();

        try {
            XWikiDocument doc = xwiki.getDocument(userReference, context);
            List<BaseObject> preferencesObj = doc.getXObjects(notificationPreferencesClass);
            if (preferencesObj != null) {
                for (BaseObject obj : preferencesObj) {
                    if (obj != null) {
                        preferences.add(new NotificationPreference(
                                obj.getStringValue("eventType"),
                                obj.getStringValue("applicationId"),
                                obj.getIntValue("notificationEnabled", 0) == 1
                        ));
                    }
                }
            }
        } catch (Exception e) {
            throw new NotificationException(
                    String.format("Failed to get the notification preferences for the user [%s].", userReference), e);
        }

        return preferences;
    }

    @Override
    public Date getUserStartDate(DocumentReference userReference) throws NotificationException
    {
        try {
            XWikiContext context = contextProvider.get();
            XWiki xwiki = context.getWiki();
            XWikiDocument document =  xwiki.getDocument(userReference, context);

            final DocumentReference notificationStartDateClass
                    = NOTIFICATION_START_DATE_CLASS.setWikiReference(userReference.getWikiReference());

            BaseObject obj = document.getXObject(notificationStartDateClass);
            if (obj != null) {
                Date date = obj.getDateValue(START_DATE);
                if (date != null) {
                    return date;
                }
            }

            // Fallback to the creation date of the user
            return document.getCreationDate();
        } catch (XWikiException e) {
            throw new NotificationException(
                    String.format("Failed to get the document [%s].", userReference), e);
        }
    }

    @Override
    public void setStartDateForUser(DocumentReference userReference, Date startDate)
            throws NotificationException
    {
        try {
            XWikiContext context = contextProvider.get();
            XWiki xwiki = context.getWiki();
            XWikiDocument document =  xwiki.getDocument(userReference, context);

            final DocumentReference notificationStartDateClass
                    = NOTIFICATION_START_DATE_CLASS.setWikiReference(userReference.getWikiReference());

            BaseObject obj = document.getXObject(notificationStartDateClass, true, context);
            obj.setDateValue(START_DATE, startDate);

            xwiki.saveDocument(document, "Update start date for the notifications.", context);

        } catch (Exception e) {
            throw new NotificationException(
                    String.format("Failed to set the user start date for [%s].", userReference), e);
        }
    }
}