app/src/main/java/org/apache/roller/weblogger/ui/struts2/admin/PingTargets.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  The ASF licenses this file to You
 * 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.  For additional information regarding
 * copyright in this work, please see the NOTICE file in the top level
 * directory of this distribution.
 */

package org.apache.roller.weblogger.ui.struts2.admin;

import java.util.Collections;
import java.util.List;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.roller.weblogger.WebloggerException;
import org.apache.roller.weblogger.business.WebloggerFactory;
import org.apache.roller.weblogger.business.pings.PingTargetManager;
import org.apache.roller.weblogger.pojos.PingTarget;
import org.apache.roller.weblogger.ui.struts2.util.UIAction;
import org.apache.struts2.convention.annotation.AllowedMethods;

/**
 * Admin action for managing global ping targets.
 */
// TODO: make this work @AllowedMethods({"execute","enable","disable","delete","deleteConfirm"})
public class PingTargets extends UIAction {
    
    private static Log log = LogFactory.getLog(PingTargets.class);
    
    public PingTargets() {
        this.actionName = "commonPingTargets";
        this.desiredMenu = "admin";
        this.pageTitle = "commonPingTargets.commonPingTargets";
    }

    // list of available ping targets
    private List<PingTarget> pingTargets = Collections.emptyList();

    // ping target we are working on, if any
    private PingTarget pingTarget = null;

    // id of the ping target to work on
    private String pingTargetId = null;

    // no weblog required
    @Override
    public boolean isWeblogRequired() {
        return false;
    }

    public void loadPingTargets() {
        try {
            PingTargetManager pingTargetMgr = WebloggerFactory.getWeblogger().getPingTargetManager();
            setPingTargets(pingTargetMgr.getCommonPingTargets());
        } catch (WebloggerException ex) {
            log.error("Error loading common ping targets", ex);
            addError("commonPingTargets.error.loading");
        }
    }

    // prepare method needs to set ping targets list
    @Override
    public void myPrepare() {

        // load list of ping targets
        loadPingTargets();

        // load specified ping target if possible
        if(!StringUtils.isEmpty(getPingTargetId())) {
            try {
                PingTargetManager pingTargetMgr = WebloggerFactory.getWeblogger().getPingTargetManager();
                setPingTarget(pingTargetMgr.getPingTarget(getPingTargetId()));
            } catch (WebloggerException ex) {
                log.error("Error looking up ping target - " + getPingTargetId(), ex);
            }
        }
    }

    /**
     * Display the ping targets.
     */
    @Override
    public String execute() {
        return LIST;
    }

    /**
     * Set a ping target auto enabled to true.
     */
    public String enable() {
        
        if(getPingTarget() != null) {
            try {
                getPingTarget().setAutoEnabled(true);
                
                PingTargetManager pingTargetMgr = WebloggerFactory.getWeblogger().getPingTargetManager();
                pingTargetMgr.savePingTarget(getPingTarget());
                WebloggerFactory.getWeblogger().flush();
            } catch (Exception ex) {
                log.error("Error saving ping target", ex);
                addError("commonPingTargets.error.saving");
            }
        } else {
            addError("commonPingTargets.error.enabling");
        }
        
        return LIST;
    }
    
    
    /**
     * Set a ping target auto-enable to false.
     */
    public String disable() {
        
        if(getPingTarget() != null) {
            try {
                getPingTarget().setAutoEnabled(false);
                
                PingTargetManager pingTargetMgr = WebloggerFactory.getWeblogger().getPingTargetManager();
                pingTargetMgr.savePingTarget(getPingTarget());
                WebloggerFactory.getWeblogger().flush();
            } catch (Exception ex) {
                log.error("Error saving ping target", ex);
                addError("commonPingTargets.error.saving");
            }
        } else {
            addError("commonPingTargets.error.disabling");
        }
        
        return LIST;
    }

    /**
     * Delete a ping target (load delete confirmation view).
     */
    public String deleteConfirm() {

        if(getPingTarget() != null) {
            setPageTitle("pingTarget.confirmRemoveTitle");

            return "confirm";
        } else {
            addError("pingTarget.notFound",getPingTargetId());
        }

        return LIST;
    }


    /**
     * Delete a ping target.
     */
    public String delete() {
        if(getPingTarget() != null) {
            try {
                PingTargetManager pingTargetMgr = WebloggerFactory.getWeblogger().getPingTargetManager();
                pingTargetMgr.removePingTarget(getPingTarget());
                WebloggerFactory.getWeblogger().flush();

                // remove deleted target from list
                getPingTargets().remove(getPingTarget());
                addMessage("pingTarget.deleted", getPingTarget().getName());
            } catch (WebloggerException ex) {
                log.error("Error deleting ping target - " + getPingTargetId(), ex);
                addError("generic.error.check.logs", getPingTargetId());
            }
        } else {
            addError("pingTarget.notFound", getPingTargetId());
        }
        return LIST;
    }

    public List<PingTarget> getPingTargets() {
        return pingTargets;
    }

    public void setPingTargets(List<PingTarget> pingTargets) {
        this.pingTargets = pingTargets;
    }

    public PingTarget getPingTarget() {
        return pingTarget;
    }

    public void setPingTarget(PingTarget pingTarget) {
        this.pingTarget = pingTarget;
    }

    public String getPingTargetId() {
        return pingTargetId;
    }

    public void setPingTargetId(String pingTargetId) {
        this.pingTargetId = pingTargetId;
    }
}