org.shredzone.cilla.plugin.social.manager.SocialHandlerManager.java Source code

Introduction

Here is the source code for org.shredzone.cilla.plugin.social.manager.SocialHandlerManager.java

Source

/*
 * cilla - Blog Management System
 *
 * Copyright (C) 2012 Richard "Shred" Krber
 *   http://cilla.shredzone.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.shredzone.cilla.plugin.social.manager;

import static java.util.stream.Collectors.toList;

import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.stream.Collectors;

import javax.annotation.PostConstruct;
import javax.annotation.Resource;

import org.shredzone.cilla.core.model.Page;
import org.shredzone.cilla.plugin.social.annotation.SocialBookmark;
import org.shredzone.cilla.plugin.social.annotation.SocialHandler;
import org.shredzone.cilla.web.plugin.annotation.Priority;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.ApplicationContext;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

/**
 * A service that manages social bookmark services.
 *
 * @author Richard "Shred" Krber
 */
@Component
public class SocialHandlerManager {
    private final Logger log = LoggerFactory.getLogger(getClass());

    private @Value("${socials.blacklist}") String blacklist;

    private @Resource ApplicationContext applicationContext;

    private SortedSet<SocialHandlerInvoker> invokers = new TreeSet<>();

    /**
     * Fetches all {@link SocialLink} to a {@link Page}.
     *
     * @param page
     *            {@link Page} to get all {@link SocialLink} to
     * @return List of {@link SocialLink}, may be empty but never {@code null}
     */
    public List<SocialLink> fetchLinksToPage(Page page) {
        return invokers.stream().map(it -> it.invoke(page)).filter(it -> it != null).collect(toList());
    }

    /**
     * Sets up the manager. All beans are scanned for {@link SocialHandler} annotations.
     * If found, {@link SocialBookmark} annotations will further describe the social
     * bookmark service.
     */
    @PostConstruct
    public void setup() {
        Set<String> blacklistSet = Arrays.stream(blacklist.split("[,;]+")).map(String::trim)
                .filter(it -> !it.isEmpty()).collect(Collectors.toSet());

        Collection<Object> beans = applicationContext.getBeansWithAnnotation(SocialHandler.class).values();
        for (Object bean : beans) {
            SocialHandler shAnno = bean.getClass().getAnnotation(SocialHandler.class);
            if (shAnno != null) {
                for (Method method : bean.getClass().getMethods()) {
                    SocialBookmark bookmarkAnno = AnnotationUtils.findAnnotation(method, SocialBookmark.class);
                    if (bookmarkAnno != null) {
                        processBookmarkHandler(bean, method, bookmarkAnno, blacklistSet);
                    }
                }
            }
        }
    }

    /**
     * Process a bookmark handler.
     *
     * @param bean
     *            Spring bean of the {@link SocialHandler}
     * @param method
     *            Method annotated with {@link SocialBookmark}
     * @param bookmarkAnno
     *            the {@link SocialBookmark} annotation itself
     * @param blacklistSet
     *            Set of blacklisted social handlers
     */
    private void processBookmarkHandler(Object bean, Method method, SocialBookmark bookmarkAnno,
            Set<String> blacklistSet) {
        SocialHandlerInvoker invoker = applicationContext.getBean(SocialHandlerInvoker.class);
        invoker.setBean(bean);
        invoker.setMethod(method);

        Priority priorityAnno = AnnotationUtils.findAnnotation(method, Priority.class);
        if (priorityAnno != null) {
            invoker.setPriority(priorityAnno.value());
        }

        String name = bookmarkAnno.name();
        if (!StringUtils.hasText(name)) {
            name = method.getName();
            if (name.endsWith("SocialBookmark")) {
                name = name.substring(0, name.length() - "SocialBookmark".length());
            }
        }
        invoker.setName(name);

        if (StringUtils.hasText(bookmarkAnno.icon())) {
            invoker.setIcon(bookmarkAnno.icon());
        }

        if (!blacklistSet.contains(invoker.getIdentifier())) {
            if (invokers.contains(invoker)) {
                throw new IllegalStateException("Invoker '" + invoker.getIdentifier() + "' defined twice");
            }

            invokers.add(invoker);
            log.info("Registered Social Bookmark {} (priority {})", invoker.getIdentifier(), invoker.getPriority());
        } else {
            log.info("Ignored blacklisted Social Bookmark {}", invoker.getIdentifier());
        }
    }

}