FlagTaxonomyTermAction.java

/*
 * Copyright (c) 2006-2013 by Public Library of Science
 *
 * http://plos.org
 * http://ambraproject.org
 *
 * 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.ambraproject.action.taxonomy;

import org.ambraproject.action.BaseActionSupport;
import org.ambraproject.views.ArticleCategoryPair;
import org.ambraproject.web.Cookies;
import org.ambraproject.service.taxonomy.TaxonomyService;
import org.ambraproject.views.TaxonomyCookie;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Required;
import java.util.ArrayList;
import java.util.List;

/**
 * Flag a particular taxonomy term applied to an article
 */
public class FlagTaxonomyTermAction extends BaseActionSupport {
  private static final Logger log = LoggerFactory.getLogger(FlagTaxonomyTermAction.class);

  private TaxonomyService taxonomyService;

  private Long articleID;
  private Long categoryID;

  /**
   * Flag a particular taxonomy term applied to an article
   *
   * Check the user's cookies to make an attempt at stopping spamming one article/category with a lot of flags
   *
   * @return INPUT or SUCCESS
   *
   * @throws Exception
   */
  @Override
  public String execute() throws Exception {
    String cookieValue = Cookies.getCookieValue(Cookies.COOKIE_ARTICLE_CATEGORY_FLAGS);
    List<ArticleCategoryPair> valuePairs = new ArrayList<ArticleCategoryPair>();

    if(articleID != null && categoryID != null) {
      boolean flaggedAlready = false;

      if(cookieValue != null) {
        TaxonomyCookie taxonomyCookie = new TaxonomyCookie(cookieValue);

        for(ArticleCategoryPair articleCategory : taxonomyCookie.getArticleCategories()) {
          //Add existing values to the set to use for the new cookie
          valuePairs.add(articleCategory);

          long storedArticleID = articleCategory.getArticleID();
          long storedCategoryID = articleCategory.getCategoryID();

          if(articleID.equals(storedArticleID) && categoryID.equals(storedCategoryID)) {
            flaggedAlready = true;
          }
        }
      }

      if(!flaggedAlready) {
        //Here add new value to the first in the list.  This way if cookie limit is reached, the oldest values will
        // get lost.
        List<ArticleCategoryPair> temp = new ArrayList<ArticleCategoryPair>();
        temp.add(new ArticleCategoryPair(articleID, categoryID));
        temp.addAll(valuePairs);
        valuePairs = temp;

        this.taxonomyService.flagTaxonomyTerm(articleID, categoryID, this.getAuthId());
        log.debug("Article/Category Flagged. ArticleID: {}, CategoryID: {}, AuthID: '{}'", new Object[] { articleID, categoryID, this.getAuthId() });
      } else {
        log.debug("Article/Category Flagged already. {}/{}", articleID, categoryID);
      }

      TaxonomyCookie newCookie = new TaxonomyCookie(valuePairs);
      Cookies.setCookieValue(Cookies.COOKIE_ARTICLE_CATEGORY_FLAGS, newCookie.toCookieString());

      return SUCCESS;
    }

    addActionError("ArticleID or CategoryID not specified.");

    return INPUT;
  }

  public void setArticleID(Long articleID) {
    this.articleID = articleID;
  }

  public void setCategoryID(Long categoryID) {
    this.categoryID = categoryID;
  }

  @Required
  public void setTaxonomyService(TaxonomyService taxonomyService) {
    this.taxonomyService = taxonomyService;
  }
}