OsgiController.java

/*******************************************************************************
 * Copyright (c) 2015 IBH SYSTEMS GmbH.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBH SYSTEMS GmbH - initial API and implementation
 *******************************************************************************/
package org.eclipse.packagedrone.repo.osgi.web;

import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;

import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.eclipse.packagedrone.repo.MetaKey;
import org.eclipse.packagedrone.repo.aspect.common.osgi.OsgiAspectFactory;
import org.eclipse.packagedrone.repo.channel.ArtifactInformation;
import org.eclipse.packagedrone.repo.channel.ChannelInformation;
import org.eclipse.packagedrone.repo.channel.ChannelService;
import org.eclipse.packagedrone.repo.channel.ReadableChannel;
import org.eclipse.packagedrone.repo.channel.web.breadcrumbs.Breadcrumbs;
import org.eclipse.packagedrone.repo.channel.web.breadcrumbs.Breadcrumbs.Entry;
import org.eclipse.packagedrone.repo.utils.osgi.bundle.BundleInformation;
import org.eclipse.packagedrone.repo.utils.osgi.feature.FeatureInformation;
import org.eclipse.packagedrone.repo.web.utils.Channels;
import org.eclipse.packagedrone.web.Controller;
import org.eclipse.packagedrone.web.LinkTarget;
import org.eclipse.packagedrone.web.ModelAndView;
import org.eclipse.packagedrone.web.RequestMapping;
import org.eclipse.packagedrone.web.ViewResolver;
import org.eclipse.packagedrone.web.common.InterfaceExtender;
import org.eclipse.packagedrone.web.common.Modifier;
import org.eclipse.packagedrone.web.common.menu.MenuEntry;
import org.eclipse.packagedrone.web.controller.binding.PathVariable;

@Controller
@RequestMapping ( "/osgi.info" )
@ViewResolver ( "/WEB-INF/views/%s.jsp" )
public class OsgiController implements InterfaceExtender
{
    private ChannelService service;

    public void setService ( final ChannelService service )
    {
        this.service = service;
    }

    @Override
    public List<MenuEntry> getViews ( final HttpServletRequest request, final Object object )
    {
        if ( object instanceof ChannelInformation )
        {
            return getChannelViews ( (ChannelInformation)object );
        }
        return null;
    }

    private List<MenuEntry> getChannelViews ( final ChannelInformation channel )
    {
        if ( !channel.hasAspect ( "osgi" ) )
        {
            return null;
        }

        final List<MenuEntry> result = new LinkedList<> ();

        final Map<String, Object> model = new HashMap<> ( 1 );

        model.put ( "channelId", channel.getId () );

        result.add ( new MenuEntry ( "OSGi", 500, "Bundles", 500, LinkTarget.createFromController ( OsgiController.class, "infoBundles" ).expand ( model ), Modifier.DEFAULT, null, false, 0 ) );
        result.add ( new MenuEntry ( "OSGi", 500, "Features", 600, LinkTarget.createFromController ( OsgiController.class, "infoFeatures" ).expand ( model ), Modifier.DEFAULT, null, false, 0 ) );

        return result;
    }

    public static class ArtifactBundleInformation extends BundleInformation
    {
        private String channelId;

        private String artifactId;

        public void setChannelId ( final String channelId )
        {
            this.channelId = channelId;
        }

        public String getChannelId ()
        {
            return this.channelId;
        }

        public void setArtifactId ( final String artifactId )
        {
            this.artifactId = artifactId;
        }

        public String getArtifactId ()
        {
            return this.artifactId;
        }
    }

    public static class ArtifactFeatureInformation extends FeatureInformation
    {
        private String channelId;

        private String artifactId;

        public void setChannelId ( final String channelId )
        {
            this.channelId = channelId;
        }

        public String getChannelId ()
        {
            return this.channelId;
        }

        public void setArtifactId ( final String artifactId )
        {
            this.artifactId = artifactId;
        }

        public String getArtifactId ()
        {
            return this.artifactId;
        }
    }

    @RequestMapping ( "/channel/{channelId}/infoBundles" )
    public ModelAndView infoBundles ( @PathVariable ( "channelId" ) final String channelId)
    {
        return Channels.withChannel ( this.service, channelId, ReadableChannel.class, channel -> {
            final Map<String, Object> model = new HashMap<> ( 2 );
            model.put ( "channel", channel.getInformation () );

            final List<ArtifactBundleInformation> bundles = new LinkedList<> ();

            for ( final ArtifactInformation art : channel.getArtifacts () )
            {
                final ArtifactBundleInformation bi = OsgiAspectFactory.fetchBundleInformation ( art.getMetaData (), ArtifactBundleInformation.class );
                if ( bi != null )
                {
                    bi.setChannelId ( channel.getId ().getId () );
                    bi.setArtifactId ( art.getId () );
                    bundles.add ( bi );
                }
            }

            bundles.sort ( ( i1, i2 ) -> {
                final int rc = i1.getId ().compareTo ( i2.getId () );
                if ( rc != 0 )
                {
                    return rc;
                }
                return i1.getVersion ().compareTo ( i2.getVersion () );
            } );

            model.put ( "bundles", bundles );

            return new ModelAndView ( "infoBundles", model );
        } );
    }

    @RequestMapping ( "/channel/{channelId}/artifact/{artifactId}/viewBundle" )
    public ModelAndView viewBundle ( @PathVariable ( "channelId" ) final String channelId, @PathVariable ( "artifactId" ) final String artifactId)
    {
        return Channels.withArtifact ( this.service, channelId, artifactId, ReadableChannel.class, ( channel, artifact ) -> {

            final Map<String, Object> model = new HashMap<> ();
            model.put ( "artifact", artifact );

            final BundleInformation bi = OsgiAspectFactory.fetchBundleInformation ( artifact.getMetaData () );
            model.put ( "bundle", bi );

            final String aid = artifact.getId ();
            final String cid = artifact.getChannelId ().getId ();

            final List<Entry> breadcrumbs = new LinkedList<> ();
            breadcrumbs.add ( new Entry ( "Home", "/" ) );
            breadcrumbs.add ( new Entry ( "Channel", "/osgi.info/channel/" + urlPathSegmentEscaper ().escape ( cid ) + "/infoBundles" ) );
            breadcrumbs.add ( new Entry ( "Artifact", "/channel/" + urlPathSegmentEscaper ().escape ( cid ) + "/artifacts/" + urlPathSegmentEscaper ().escape ( aid ) + "/view" ) );
            breadcrumbs.add ( new Entry ( "Bundle Information" ) );
            model.put ( "breadcrumbs", new Breadcrumbs ( breadcrumbs ) );

            model.put ( "fullManifest", artifact.getMetaData ().get ( new MetaKey ( "osgi", "fullManifest" ) ) );

            return new ModelAndView ( "viewBundle", model );
        } );

    }

    @RequestMapping ( "/channel/{channelId}/artifact/{artifactId}/viewFeature" )
    public ModelAndView viewFeature ( @PathVariable ( "channelId" ) final String channelId, @PathVariable ( "artifactId" ) final String artifactId)
    {
        return Channels.withArtifact ( this.service, channelId, artifactId, ReadableChannel.class, ( channel, artifact ) -> {

            final Map<String, Object> model = new HashMap<> ();
            model.put ( "artifact", artifact );

            final FeatureInformation bi = OsgiAspectFactory.fetchFeatureInformation ( artifact.getMetaData () );
            model.put ( "feature", bi );

            final String aid = artifact.getId ();
            final String cid = artifact.getChannelId ().getId ();

            final List<Entry> breadcrumbs = new LinkedList<> ();
            breadcrumbs.add ( new Entry ( "Home", "/" ) );
            breadcrumbs.add ( new Entry ( "Channel", "/osgi.info/channel/" + urlPathSegmentEscaper ().escape ( cid ) + "/infoFeatures" ) );
            breadcrumbs.add ( new Entry ( "Artifact", "/channel/" + urlPathSegmentEscaper ().escape ( cid ) + "/artifacts/" + urlPathSegmentEscaper ().escape ( aid ) + "/view" ) );
            breadcrumbs.add ( new Entry ( "Feature Information" ) );
            model.put ( "breadcrumbs", new Breadcrumbs ( breadcrumbs ) );

            return new ModelAndView ( "viewFeature", model );
        } );
    }

    @RequestMapping ( "/channel/{channelId}/infoFeatures" )
    public ModelAndView infoFeatures ( @PathVariable ( "channelId" ) final String channelId)
    {
        return Channels.withChannel ( this.service, channelId, ReadableChannel.class, channel -> {

            final Map<String, Object> model = new HashMap<> ( 2 );
            model.put ( "channel", channel.getInformation () );

            final List<FeatureInformation> features = new LinkedList<> ();

            for ( final ArtifactInformation art : channel.getArtifacts () )
            {
                final ArtifactFeatureInformation fi = OsgiAspectFactory.fetchFeatureInformation ( art.getMetaData (), ArtifactFeatureInformation.class );
                if ( fi != null )
                {
                    fi.setChannelId ( channel.getId ().getId () );
                    fi.setArtifactId ( art.getId () );
                    features.add ( fi );
                }
            }

            features.sort ( ( i1, i2 ) -> {
                final int rc = i1.getId ().compareTo ( i2.getId () );
                if ( rc != 0 )
                {
                    return rc;
                }
                return i1.getVersion ().compareTo ( i2.getVersion () );
            } );

            model.put ( "features", features );

            return new ModelAndView ( "infoFeatures", model );
        } );
    }

}