LDKModule.java

/*
 * Copyright (c) 2012 LabKey Corporation
 *
 * 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.ldk;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.labkey.api.data.Container;
import org.labkey.api.data.DbScope;
import org.labkey.api.data.bigiron.ClrAssemblyManager;
import org.labkey.api.ldk.ExtendedSimpleModule;
import org.labkey.api.ldk.LDKService;
import org.labkey.api.ldk.notification.NotificationService;
import org.labkey.api.module.ModuleContext;
import org.labkey.api.query.DetailsURL;
import org.labkey.api.security.permissions.AdminOperationsPermission;
import org.labkey.api.security.permissions.AdminPermission;
import org.labkey.api.security.permissions.ReadPermission;
import org.labkey.api.settings.AdminConsole;
import org.labkey.api.util.PageFlowUtil;
import org.labkey.api.view.DeveloperMenu;
import org.labkey.api.view.DeveloperMenuNavTrees;
import org.labkey.api.view.NavTree;
import org.labkey.api.view.WebPartFactory;
import org.labkey.ldk.notification.NotificationServiceImpl;
import org.labkey.ldk.notification.SiteSummaryNotification;
import org.labkey.ldk.query.LookupSetTable;
import org.labkey.ldk.query.LookupsUserSchema;
import org.labkey.ldk.query.MssqlUtilsUserSchema;
import org.labkey.ldk.sql.LDKNaturalizeInstallationManager;

import java.util.Collection;
import java.util.Collections;
import java.util.Set;

public class LDKModule extends ExtendedSimpleModule
{
    public static final String NAME = "LDK";

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

    @Override
    public @Nullable Double getSchemaVersion()
    {
        return 12.39;
    }

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

    @NotNull
    @Override
    protected Collection<WebPartFactory> createWebPartFactories()
    {
        return Collections.emptyList();
    }

    @Override
    protected void init()
    {
        addController("ldk", LDKController.class);
        LDKService.setInstance(new LDKServiceImpl());
        NotificationService.setInstance(new NotificationServiceImpl());
    }

    @Override
    protected void doStartupAfterSpringConfig(ModuleContext moduleContext)
    {
        AdminConsole.addLink(AdminConsole.SettingsLinkType.Management, "notification service admin", DetailsURL.fromString("/ldk/notificationSiteAdmin.view").getActionURL(), AdminOperationsPermission.class);
        DeveloperMenu.registerMenuProvider((c, user, trees) -> {
            if (c.isRoot() & user.hasSiteAdminPermission())
            {
                trees.add(DeveloperMenuNavTrees.Section.tools, new NavTree("Notification Service Admin", DetailsURL.fromString("ldk/notificationSiteAdmin.view", c).getActionURL()));
            }
            else if (!c.isRoot() & c.hasPermission(user, AdminPermission.class))
            {
                trees.add(DeveloperMenuNavTrees.Section.tools, new NavTree("Notification Service Admin", DetailsURL.fromString("ldk/notificationAdmin.view", c).getActionURL()));
            }
        });

        AdminConsole.addLink(AdminConsole.SettingsLinkType.Management, "file root usage summary", DetailsURL.fromString("/ldk/folderSizeSummary.view").getActionURL(), ReadPermission.class);

        if (isSqlServer())
        {
            AdminConsole.addLink(AdminConsole.SettingsLinkType.Management, "sql server DB index usage", DetailsURL.fromString("/query/executeQuery.view?schemaName=mssqlutils&query.queryName=index_stats").getActionURL(), AdminPermission.class);

            ClrAssemblyManager.registerInstallationManager(LDKNaturalizeInstallationManager.get());
        }

        NotificationService.get().registerNotification(new SiteSummaryNotification());
    }

    @Override
    public void afterUpdate(ModuleContext moduleContext)
    {
        if (isSqlServer())
            LDKNaturalizeInstallationManager.get().ensureInstalled(moduleContext);
    }

    @NotNull
    @Override
    public Collection<String> getSummary(Container c)
    {
        return Collections.emptyList();
    }

    @Override
    @NotNull
    public Set<String> getSchemaNames()
    {
        return PageFlowUtil.set(LDKSchema.getInstance().getSchemaName());
    }

    @Override
    protected void registerSchemas()
    {
        super.registerSchemas();

        if (isSqlServer())
        {
            MssqlUtilsUserSchema.register(this);
        }

        LookupsUserSchema.register(this);
    }

    public static boolean isSqlServer()
    {
        return DbScope.getLabKeyScope().getSqlDialect().isSqlServer();
    }

    @Override
    public @NotNull Set<Class<?>> getIntegrationTests()
    {
        return PageFlowUtil.set(LookupSetTable.TestCase.class);
    }
}