ProductContentIterator.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 Lluis Turró Cutiller <http://www.turro.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 Affero 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.turro.financials.content;
 
import java.io.Writer;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import org.turro.string.Strings;
import org.turro.attach.www.AttachCtrl;
import org.turro.describeit.DescribeItUtil;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.db.WhereClause;
import org.turro.elephant.impl.repository.Repository;
import org.turro.elephant.impl.repository.RepositoryFile;
import org.turro.elephant.web.SocialImageMap;
import org.turro.elephant.web.SocialNet;
import org.turro.entities.Entities;
import org.turro.file.util.FileAttach;
import org.turro.financials.cart.ShopContext;
import org.turro.financials.cart.ShoppingCart;
import org.turro.financials.db.FinancialsPU;
import org.turro.financials.entity.Product;
import org.turro.groupit.GroupItUtil;
import org.turro.jpa.DaoUtil;
import org.turro.jpa.content.EntityDaoContentIterator;
import org.turro.jpa.search.DaoHtmlSearch;
import org.turro.jpa.search.DaoSearchKey;
import org.turro.marker.ElephantMarker;
import org.turro.plugin.contacts.IContact;
import org.turro.polls.PollsCtrl;
import org.turro.www.commentit.CommentItCtrl;
import org.turro.www.describeit.DescribeItCtrl;
import org.turro.www.starit.StarItCtrl;
import org.turro.www.voteit.VoteItCtrl;
 
public class ProductContentIterator extends EntityDaoContentIterator<Product, Long> {
 
  private boolean exact, allowGroups, onlyPromoted, publishable, fullSearch;
  
  public ProductContentIterator(IConstructor constructor, Writer writer, IContact contact, boolean mail, String pubPath) {
    super(new FinancialsPU(), constructor, writer, contact, mail, pubPath);
  }
 
  public boolean isExact() {
    return exact;
  }
 
  public void setExact(boolean exact) {
    this.exact = exact;
  }
 
  public void setAllowGroups(boolean allowGroups) {
    this.allowGroups = allowGroups;
  }
 
  public boolean isOnlyPromoted() {
    return onlyPromoted;
  }
 
  public void setOnlyPromoted(boolean onlyPromoted) {
    this.onlyPromoted = onlyPromoted;
  }
 
  public boolean isPublishable() {
    return publishable;
  }
 
  public void setPublishable(boolean publishable) {
    this.publishable = publishable;
  }
 
  public boolean isFullSearch() {
    return fullSearch;
  }
 
  public void setFullSearch(boolean fullSearch) {
    this.fullSearch = fullSearch;
  }
 
  @Override
  protected WhereClause getWhereClause() {
    WhereClause wc = new WhereClause();
    wc.addClause("select distinct {p} from Product as p");
    addCriteria(wc);
    if(!wc.isUseNative()) wc.addClause("order by p.description");
    wc.setResultClass(Product.class);
    return wc;
  }
 
  @Override
  protected WhereClause getCountClause() {
    WhereClause wc = new WhereClause();
    wc.addClause("select count({distinct p}) from Product as p");
    addCriteria(wc);
    return wc;
  }
 
  @Override
  protected void renderSummary(ElephantMarker marker, Product e, int page) {
    if(e != null) {
      marker.put("product", e);
      prepareValues(e, page);
    }
    marker.process(getTemplateRoot(), getSummaryTemplate(), getWriter());
  }
 
  @Override
  protected void renderItem(ElephantMarker marker, Product e, int page) {
    marker.put("product", e);
    prepareValues(e, page);
    marker.process(getTemplateRoot(), getFullTemplate(), getWriter());
  }
 
  @Override
  protected String entityRoot() {
    return "product";
  }
 
  @Override
  protected Product entity(Long value) {
    return dao.find(Product.class, value);
  }
 
  @Override
  protected boolean isValid(Product e) {
    return super.isValid(e);
  }
  
  private void addCriteria(WhereClause wc) {
    boolean searching = false;
    wc.addClause("where p.publishable = :publishable");
    wc.addNamedValue("publishable", publishable);
    wc.setUseNative(fullSearch);
    if(isSearchOption()) {
      DaoHtmlSearch dhs = DaoHtmlSearch.getInstance(constructor, ElephantContext.getContextVariable(constructor));
      if(dhs != null) {
        DaoSearchKey dsk = dhs.get("search-value");
        if(dsk != null) {
          if(fullSearch) {
            searching = dsk.applyToQueryFull(wc, "p.description, p.keywords", true);
          } else {
            searching = dsk.applyToQuery(wc, Arrays.asList("p.description", "p.keywords"), true);
          }
        }
      }
    }
    if(allowGroups) {
      if(!searching) {
        String selectedGroup = GroupItUtil.getSelectedGroup(constructor, getContextPath());
        String selectedCategory = GroupItUtil.getCategory(constructor, getContextPath());
        if(!Strings.isBlank(selectedGroup)) {
          List<String> list = (List<String>) GroupItUtil.getPathsFromGroup("/product", selectedGroup, selectedCategory, exact);
          if(list != null && !list.isEmpty()) {
            if(fullSearch) {
              wc.addClause("and p.identifier in (" + DaoUtil.getInClauseFromPaths(list, false) + ")");
            } else {
              wc.addClause("and p.id in (" + DaoUtil.getInClauseFromPaths(list, false) + ")");
            }
          } else {
            wc.addClause("and 1=2");
          }
        }
      } else {
        String selectedCategory = GroupItUtil.getCategory(constructor, getContextPath());
        if(!Strings.isBlank(selectedCategory)) {
          List<String> list = (List<String>) GroupItUtil.getPathsFromCategory("/product", selectedCategory);
          if(list != null && !list.isEmpty()) {
            if(fullSearch) {
              wc.addClause("and p.identifier in (" + DaoUtil.getInClauseFromPaths(list, false) + ")");
            } else {
              wc.addClause("and p.id in (" + DaoUtil.getInClauseFromPaths(list, false) + ")");
            }
          } else {
            wc.addClause("and 1=2");
          }
        }
      }      
    }
    if(onlyPromoted) {
      wc.addClause("and p.promoted = :promoted");
      wc.addNamedValue("promoted", true);
    }
  }
  
  private void prepareValues(Product product, int page) {
    prepareControls(product, page);
    
    if(product == null) return;
    
    marker.put("product", product);
    
    if(ShopContext.getInstance().isValid()) {
      marker.put("cart", getCartExacton(product));
      marker.put("stock", getCartStock(product));
      marker.put("action", ElephantContext.getRootWebPath() + ShopContext.getInstance().getCartPath());
    }
    
    // Legacy
    marker.put("description", product.getDescription());
    if(!Strings.isBlank(getContextPath())) {
      marker.put("path", getItemLink(product));
      marker.put("all", getReadAllLink());
      marker.put("readall", getItemLink(product));
    }
  }
  
  private String getCartExacton(Product product) {
    return ShoppingCart.getAddToCart(product.getId() + "", "1", product.getProductPrice() + "");
  }
  
  private Double getCartStock(Product product) {
    if(product.isService()) {
      return 0.0;
    }
    return ShoppingCart.getStockForProduct(constructor, product);
  }
 
  @Override
  protected String title(Product e) {
    return e.getDescription();
  }
 
  @Override
  protected Collection<String> metas(Product e) {
    ArrayList<RepositoryFile> files = new ArrayList<>();
    String path = getItemLink(e);
    if(!SocialImageMap.hasImage(path)) {
      FileAttach fa = new FileAttach(FinancialsPU.getObjectPath(e));
      Repository repository = fa.getPublishableRepository(constructor);
      files.addAll(repository.getRepositoryFiles("*_social.png,*_social.jpg"));
      files.addAll(repository.getRepositoryFiles("*.png,*.jpg"));
    }
    String desc = DescribeItUtil.descriptionString(DescribeItUtil.DEFAULT_ID, FinancialsPU.getObjectPath(e));
    if(desc == null) desc = e.getKeywords();
    SocialNet sn = new SocialNet(path, e.getDescription(), desc, files);
    return sn.getMetas();
  }
  
  @Override
  protected String getTemplateRoot() {
    return isMail() ? "content/newsletter/sections/products" : "product";
  }
 
  @Override
  protected Object doVotesCtrl(Product e) {
    return Entities.getController(e).configureCtrl(
            new VoteItCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doInterestCtrl(Product e) {
    return Entities.getController(e).configureCtrl(
            new StarItCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doCommentsCtrl(Product e) {
    return Entities.getController(e).configureCtrl(
            new CommentItCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doAttachmentsCtrl(Product e) {
    return Entities.getController(e).configureCtrl(
            new AttachCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doFilesCtrl(Product e) {
    return Entities.getController(e).configureCtrl(
            new FileAttach(FinancialsPU.getObjectPath(e)), getContact());
  }
 
  @Override
  protected Object doDescriptionsCtrl(Product e) {
    return Entities.getController(e).configureCtrl(
            new DescribeItCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doPollsCtrl(Product e) {
    return Entities.getController(e).configureCtrl(
            new PollsCtrl(constructor), getContact());
  }
 
  @Override
  protected String getItemLink(Product e) {
    return doItemLink(e, e.getId(), true);
  }
 
  @Override
  protected String getReadAllLink() {
    String path = getContextPath();
    if(Strings.isBlank(path)) {
      return getRestrictedLink();
    }
    return path;
  }
 
  @Override
  protected String getRestrictedLink() {
    return "/user/products";
  }
  
}