de.knowwe.defi.time.TimeTableUtilities.java Source code

Introduction

Here is the source code for de.knowwe.defi.time.TimeTableUtilities.java

Source

/*
 * Copyright (C) 2013 University Wuerzburg, Computer Science VI
 * 
 * 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 3 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 de.knowwe.defi.time;

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

import org.apache.commons.lang.time.DateUtils;
import org.apache.wiki.WikiEngine;
import org.apache.wiki.auth.NoSuchPrincipalException;
import org.apache.wiki.auth.user.UserDatabase;
import org.apache.wiki.auth.user.UserProfile;

import de.knowwe.core.ArticleManager;
import de.knowwe.core.Environment;
import de.knowwe.core.kdom.Article;
import de.knowwe.core.kdom.parsing.Section;
import de.knowwe.core.kdom.parsing.Sections;
import de.knowwe.core.utils.KnowWEUtils;
import de.knowwe.core.wikiConnector.WikiConnector;
import de.knowwe.defi.menu.MenuUtilities;
import de.knowwe.defi.user.UserUtilities;

/**
 * 
 * @author dupke
 * @created 05.02.2013
 */
public class TimeTableUtilities {

    /**
     * Get a user's timetable. If not exists, build it.
     */
    public static List<Date> getPersonalTimeTable(String user) {
        WikiEngine eng = WikiEngine.getInstance(Environment.getInstance().getContext(), null);
        UserDatabase udb = eng.getUserManager().getUserDatabase();
        UserProfile userProfile;
        List<Date> dates = new ArrayList<>();
        ArticleManager mgr = KnowWEUtils.getArticleManager(Environment.DEFAULT_WEB);
        Article article = mgr.getArticle(getTimeTablePageForUser(user));
        Section<TimeTableMarkup> timetable = null;

        if (article != null)
            timetable = Sections.successor(article.getRootSection(), TimeTableMarkup.class);

        try {
            userProfile = udb.find(user);
        } catch (NoSuchPrincipalException e) {
            e.printStackTrace();
            return null;
        }

        if (article == null || timetable == null || TimeTableMarkup.getDates(timetable).isEmpty()) {
            article = buildPersonalTimeTable(userProfile);
            timetable = Sections.successor(article.getRootSection(), TimeTableMarkup.class);
        }

        dates = TimeTableMarkup.getDates(timetable);

        return dates;
    }

    /**
     * Get the timetable template.
     */
    public static List<Integer> getTimeTableTemplate() {
        List<Integer> numOfDays = new ArrayList<>();
        Article article = Environment.getInstance().getArticle(Environment.DEFAULT_WEB,
                getTimeTableTemplatePagename());
        int numOfUnits = MenuUtilities.getRootUnits().size();

        if (article != null) {
            Section<TimeTableTemplateMarkup> timeTableTemplate = Sections.successor(article.getRootSection(),
                    TimeTableTemplateMarkup.class);
            if (timeTableTemplate != null) {
                numOfDays = TimeTableTemplateMarkup.getNumbersOfDays(timeTableTemplate);
            }

            for (int i = numOfDays.size(); i < numOfUnits; i++) {
                numOfDays.add(0);
            }
        } else {
            for (int i = 0; i < numOfUnits; i++) {
                numOfDays.add(0);
            }
        }

        return numOfDays;
    }

    /**
     * Build an article with a personal timetable for user.
     * 
     * @return
     */
    public static Article buildPersonalTimeTable(UserProfile user) {
        WikiConnector wikiConnector = Environment.getInstance().getWikiConnector();
        ArticleManager mgr = KnowWEUtils.getArticleManager(Environment.DEFAULT_WEB);
        String pageName = getTimeTablePageForUser(user.getFullname());
        String timetable = generatePersonalTimeTableContent(user);
        Article article = mgr.getArticle(pageName);

        if (article != null) {
            timetable += System.getProperty("line.separator") + article.getRootSection().getText();
            mgr.deleteArticle(mgr.getArticle(pageName));
        }

        wikiConnector.createArticle(pageName, "Defi-system", timetable);
        article = Article.createArticle(timetable, pageName, Environment.DEFAULT_WEB);
        mgr.registerArticle(article);

        return article;
    }

    /**
     * Get the timetable template's pagename.
     */
    public static String getTimeTableTemplatePagename() {
        return ResourceBundle.getBundle("KnowWE_Defi_config").getString("defi.timetable.pagename");
    }

    /**
     * Get the user's timetable pagename.
     */
    public static String getTimeTablePageForUser(String user) {
        return user + "_" + getTimeTableTemplatePagename();
    }

    /**
     * Generate timetable content for user.
     */
    private static String generatePersonalTimeTableContent(UserProfile user) {
        // TODO: Zeitzone englisch deutsch: CET <> MEZ, eventuell
        // Userdatabase anpassen, Server: CET, Lokal: MEZ
        Date created = UserUtilities.getCreated(user);
        if (created == null)
            throw new NullPointerException("Create date is null or couldn't be read");

        String content = "%%Zeitplan" + System.getProperty("line.separator");
        created = DateUtils.truncate(created, Calendar.DAY_OF_MONTH);
        for (Integer days : getTimeTableTemplate()) {
            Date d = DateUtils.addDays(created, days);
            content += DateT.dateFormat.format(d) + System.getProperty("line.separator");
        }
        content += "%";
        content += System.getProperty("line.separator");

        return content;
    }
}