SkylineToolsStoreModule.java

/*
 * Copyright (c) 2013 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.skylinetoolsstore;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.labkey.api.data.Container;
import org.labkey.api.data.ContainerManager;
import org.labkey.api.module.DefaultModule;
import org.labkey.api.module.ModuleContext;
import org.labkey.api.security.SecurityManager;
import org.labkey.api.view.BaseWebPartFactory;
import org.labkey.api.view.Portal;
import org.labkey.api.view.ViewContext;
import org.labkey.api.view.WebPartConfigurationException;
import org.labkey.api.view.WebPartFactory;
import org.labkey.api.view.WebPartView;
import org.labkey.skylinetoolsstore.model.SkylineTool;
import org.labkey.skylinetoolsstore.view.SkylineToolsStoreWebPart;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;
import java.util.Set;

public class SkylineToolsStoreModule extends DefaultModule
{
    public static final String CONTROLLER_NAME = "skyts";

    @Override
    public String getName()
    {
        return "SkylineToolsStore";
    }

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

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

    @Override
    @NotNull
    protected Collection<WebPartFactory> createWebPartFactories()
    {
        return new ArrayList<>(
                Arrays.asList(
                        new BaseWebPartFactory("Skyline Tool Store")
                        {
                            {
                                addLegacyNames("Skyline Tools Store");
                            }

                            @Override
                            public WebPartView getWebPartView(@NotNull ViewContext portalCtx, Portal.@NotNull WebPart webPart) throws WebPartConfigurationException
                            {
                                return new SkylineToolsStoreWebPart();
                            }
                        }
                ));
    }

    @Override
    protected void init()
    {
        addController(CONTROLLER_NAME, SkylineToolsStoreController.class, "skylinets", "skylinetoolsstore");
    }

    @Override
    public void doStartup(ModuleContext moduleContext)
    {
        // add a container listener so we'll know when our container is deleted:
        ContainerManager.addContainerListener(new SkylineToolsStoreContainerListener());
        SecurityManager.registerAllowedConnectionSource("jquery-ui", "https://code.jquery.com/ui/1.13.2/jquery-ui.min.js");
    }

    @Override
    @NotNull
    public Collection<String> getSummary(Container c)
    {
        SkylineTool[] tools = SkylineToolsStoreManager.get().getTools(c);
        if (tools != null && tools.length > 0)
        {
            Collection<String> list = new LinkedList<>();
            list.add("SkylineToolStore Module: " + tools.length + " tool records.");
            return list;
        }
        return Collections.emptyList();
    }

    @Override
    @NotNull
    public Set<String> getSchemaNames()
    {
        return Collections.singleton("skylinetoolsstore");
    }
}