IssuesModule.java

/*
 * Copyright (c) 2005-2018 Fred Hutchinson Cancer Research Center
 *
 * Licensed 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 org.labkey.issue;

import org.jetbrains.annotations.NotNull;
import org.json.JSONObject;
import org.labkey.api.admin.notification.NotificationService;
import org.labkey.api.attachments.AttachmentService;
import org.labkey.api.data.Container;
import org.labkey.api.data.ContainerManager;
import org.labkey.api.data.DataRegion;
import org.labkey.api.data.SqlExecutor;
import org.labkey.api.data.SqlSelector;
import org.labkey.api.exp.property.PropertyService;
import org.labkey.api.issues.IssueService;
import org.labkey.api.issues.IssuesListDefService;
import org.labkey.api.issues.IssuesSchema;
import org.labkey.api.migration.DatabaseMigrationService;
import org.labkey.api.module.DefaultModule;
import org.labkey.api.module.ModuleContext;
import org.labkey.api.query.QueryService;
import org.labkey.api.query.QuerySettings;
import org.labkey.api.query.QueryView;
import org.labkey.api.query.UserSchema;
import org.labkey.api.search.SearchService;
import org.labkey.api.security.SecurityManager;
import org.labkey.api.security.User;
import org.labkey.api.security.UserManager;
import org.labkey.api.services.ServiceRegistry;
import org.labkey.api.usageMetrics.UsageMetricsService;
import org.labkey.api.util.StringUtilsLabKey;
import org.labkey.api.util.emailTemplate.EmailTemplateService;
import org.labkey.api.view.ActionURL;
import org.labkey.api.view.BaseWebPartFactory;
import org.labkey.api.view.Portal;
import org.labkey.api.view.ViewContext;
import org.labkey.api.view.WebPartFactory;
import org.labkey.api.view.WebPartView;
import org.labkey.api.writer.ContainerUser;
import org.labkey.issue.model.GeneralIssuesListDefProvider;
import org.labkey.issue.model.IssueCommentType;
import org.labkey.issue.model.IssueManager;
import org.labkey.issue.model.IssueObject;
import org.labkey.issue.model.IssuesListDefServiceImpl;
import org.labkey.issue.query.IssueDefDomainKind;
import org.labkey.issue.query.IssuesQuerySchema;
import org.labkey.issue.view.IssuesSummaryWebPartFactory;
import org.labkey.issue.view.IssuesWebPartFactory;

import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static org.labkey.api.issues.IssuesSchema.ISSUE_DEF_SCHEMA_NAME;

public class IssuesModule extends DefaultModule implements SearchService.DocumentProvider
{
    public static final String NAME = "Issues";

    @Override
    public String getName()
    {
        return NAME;
    }

    @Override
    public Double getSchemaVersion()
    {
        return 26.000;
    }

    @Override
    protected void init()
    {
        addController("issues", IssuesController.class);
        IssuesQuerySchema.register(this);

        EmailTemplateService.get().registerTemplate(IssueUpdateEmailTemplate.class);
        PropertyService.get().registerDomainKind(new IssueDefDomainKind());

        IssuesListDefService.setInstance(new IssuesListDefServiceImpl());
        IssuesListDefService.get().registerIssuesListDefProvider(new GeneralIssuesListDefProvider());

        NotificationService.get().registerNotificationType(IssueObject.class.getName(), "Issues", "fa-bug");
        AttachmentService.get().registerAttachmentParentType(IssueCommentType.get());
    }

    @Override
    @NotNull
    protected Collection<WebPartFactory> createWebPartFactories()
    {
        return List.of(
            new BaseWebPartFactory("Issue Definitions")
            {
                @Override
                public WebPartView<?> getWebPartView(@NotNull ViewContext portalCtx, @NotNull Portal.WebPart webPart)
                {
                    UserSchema schema = QueryService.get().getUserSchema(portalCtx.getUser(), portalCtx.getContainer(), IssuesQuerySchema.SCHEMA_NAME);
                    QuerySettings settings = schema.getSettings(portalCtx, IssuesQuerySchema.TableType.IssueListDef.name(), IssuesQuerySchema.TableType.IssueListDef.name());

                    QueryView view = schema.createView(portalCtx, settings, null);
                    view.setFrame(WebPartView.FrameType.PORTAL);
                    view.setTitle("Issue Definitions");

                    return view;
                }
            },
            new IssuesWebPartFactory(),
            new IssuesSummaryWebPartFactory()
        );
    }

    @Override
    public boolean hasScripts()
    {
        return true;
    }


    @Override
    public void doStartup(ModuleContext moduleContext)
    {
        ContainerManager.addContainerListener(new IssueContainerListener());
        SecurityManager.addGroupListener(new IssueGroupListener());
        UserManager.addUserListener(new IssueUserListener());
        ServiceRegistry.get().registerService(IssueService.class, new IssueServiceImpl());

        SearchService ss = SearchService.get();

        ss.addSearchCategory(IssueManager.searchCategory);
        ss.addResourceResolver("issue", IssueManager.getSearchResolver());
        ss.addDocumentProvider(this);
        ss.addSearchResultTemplate(new IssuesController.IssueSearchResultTemplate());

        UsageMetricsService svc = UsageMetricsService.get();
        if (svc != null)
        {
            svc.registerUsageMetrics(getName(), () -> {
                Map<String, Object> metric = new HashMap<>();

                metric.put("issueDefCount", new SqlSelector(IssuesSchema.getInstance().getSchema(), "SELECT COUNT(*) FROM issues.issueListDef").getObject(Long.class));
                metric.put("issuesCount", new SqlSelector(IssuesSchema.getInstance().getSchema(), "SELECT COUNT(*) FROM issues.issues").getObject(Long.class));

                return metric;
            });
        }

        DatabaseMigrationService.get().registerSchemaHandler(new IssueMigrationSchemaHandler());
    }

    @NotNull
    @Override
    public Collection<String> getSummary(Container c)
    {
        Collection<String> list = new LinkedList<>();
        long count = IssueManager.getIssueCount(c);
        if (count > 0)
            list.add(StringUtilsLabKey.pluralize(count, " Issue"));
        return list;
    }

    @Override
    public ActionURL getTabURL(Container c, User user)
    {
        return new ActionURL(IssuesController.BeginAction.class, c).addParameter(DataRegion.LAST_FILTER_PARAM, true);
    }

    @Override
    public @NotNull Set<Class<?>> getIntegrationTests()
    {
        return Collections.singleton(org.labkey.issue.model.IssueManager.TestCase.class);
    }

    @Override
    @NotNull
    public List<String> getSchemaNames()
    {
        return List.of(
            IssuesSchema.getInstance().getSchemaName(),
            ISSUE_DEF_SCHEMA_NAME
        );
    }

    @Override
    public @NotNull Collection<String> getProvisionedSchemaNames()
    {
        return Set.of(
            ISSUE_DEF_SCHEMA_NAME
        );
    }

    @Override
    public void enumerateDocuments(SearchService.TaskIndexingQueue queue, final Date modifiedSince)
    {
        queue.addRunnable((q) ->
                IssueManager.indexIssues(q, modifiedSince));
    }

    @Override
    public void indexDeleted()
    {
        new SqlExecutor(IssuesSchema.getInstance().getSchema()).execute("UPDATE issues.issues SET lastIndexed=NULL");
    }

    @Override
    public JSONObject getPageContextJson(ContainerUser context)
    {
        JSONObject json = new JSONObject(getDefaultPageContextJson(context.getContainer()));
        json.put("hasRestrictedIssueList", IssuesListDefService.get().getRestrictedIssueProvider() != null);
        return json;
    }
}