package fi.otavanopisto.pyramus.views.reports;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import org.apache.commons.lang3.StringUtils;
import fi.internetix.smvc.controllers.PageRequestContext;
import fi.otavanopisto.pyramus.I18N.Messages;
import fi.otavanopisto.pyramus.breadcrumbs.Breadcrumbable;
import fi.otavanopisto.pyramus.dao.DAOFactory;
import fi.otavanopisto.pyramus.dao.base.MagicKeyDAO;
import fi.otavanopisto.pyramus.dao.reports.ReportContextDAO;
import fi.otavanopisto.pyramus.dao.reports.ReportDAO;
import fi.otavanopisto.pyramus.domainmodel.base.MagicKey;
import fi.otavanopisto.pyramus.domainmodel.base.MagicKeyScope;
import fi.otavanopisto.pyramus.domainmodel.reports.Report;
import fi.otavanopisto.pyramus.domainmodel.reports.ReportContext;
import fi.otavanopisto.pyramus.domainmodel.users.Role;
import fi.otavanopisto.pyramus.framework.PyramusViewController;
import fi.otavanopisto.pyramus.framework.UserRole;
import fi.otavanopisto.pyramus.util.ReportUtils;
/**
* The controller responsible of the List Reports view.
*/
public class ViewReportParametersViewController extends PyramusViewController implements Breadcrumbable {
/**
* Processes the page request by including the corresponding JSP page to the response.
*
* @param pageRequestContext Page request context
*/
public void process(PageRequestContext pageRequestContext) {
MagicKeyDAO magicKeyDAO = DAOFactory.getInstance().getMagicKeyDAO();
ReportDAO reportDAO = DAOFactory.getInstance().getReportDAO();
Long reportId = pageRequestContext.getLong("reportId");
Report report = reportDAO.findById(reportId);
StringBuilder magicKeyBuilder = new StringBuilder()
.append(Long.toHexString(reportId))
.append('-')
.append(Long.toHexString(System.currentTimeMillis()))
.append('-')
.append(Long.toHexString(Thread.currentThread().getId()));
MagicKey magicKey = magicKeyDAO.create(magicKeyBuilder.toString(), MagicKeyScope.REQUEST);
String localeAdd = "";
Locale locale = pageRequestContext.getRequest().getLocale();
if (locale != null) {
localeAdd = "&__locale=";
localeAdd += locale.getLanguage();
if (!StringUtils.isEmpty(locale.getCountry())) {
localeAdd += "_";
localeAdd += locale.getCountry();
}
}
StringBuilder urlBuilder = new StringBuilder()
.append(ReportUtils.getReportsUrl(pageRequestContext.getRequest()))
.append("/parameter?magicKey=")
.append(magicKey.getName())
.append(localeAdd)
.append("&__report=reports/").append(reportId).append(".rptdesign")
.append("&__masterpage=true&__nocache");
handleContextParameters(pageRequestContext, report, urlBuilder);
pageRequestContext.setIncludeUrl(urlBuilder.toString());
}
private void handleContextParameters(PageRequestContext pageRequestContext, Report report, StringBuilder urlBuilder) {
ReportContextDAO reportContextDAO = DAOFactory.getInstance().getReportContextDAO();
List<ReportContext> contexts = reportContextDAO.listByReport(report);
for (ReportContext ctx : contexts) {
switch (ctx.getContext()) {
case Student:
Long studentId = pageRequestContext.getLong("studentId");
if (studentId != null)
urlBuilder.append("&studentId=").append(studentId);
break;
case Course:
Long courseId = pageRequestContext.getLong("courseId");
if (courseId != null)
urlBuilder.append("&courseId=").append(courseId);
break;
}
}
SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd");
Date startDate = pageRequestContext.getDateByFormat("startDate", "yyyy-MM-dd");
if (startDate != null)
urlBuilder.append("&startDate=").append(df.format(startDate));
Date endDate = pageRequestContext.getDateByFormat("endDate", "yyyy-MM-dd");
if (endDate != null)
urlBuilder.append("&endDate=").append(df.format(endDate));
}
/**
* Returns the roles allowed to access this page. Reports are available for users with
* {@link Role#USER}, {@link Role#MANAGER} and {@link Role#ADMINISTRATOR} privileges.
*
* @return The roles allowed to access this page
*/
public UserRole[] getAllowedRoles() {
return new UserRole[] { UserRole.USER, UserRole.MANAGER, UserRole.STUDY_PROGRAMME_LEADER, UserRole.ADMINISTRATOR };
}
/**
* Returns the localized name of this page. Used e.g. for breadcrumb navigation.
*
* @param locale The locale to be used for the name
*
* @return The localized name of this page
*/
public String getName(Locale locale) {
return Messages.getInstance().getText(locale, "reports.viewReport.pageTitle");
}
}