PublicationEntities.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2017 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.entities;
 
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.turro.string.Strings;
import org.turro.action.IElephantSendable;
import org.turro.action.IEntityCtrl;
import org.turro.action.queue.NotificationCategory;
import org.turro.action.queue.Notifications;
import org.turro.annotation.ElephantEntity;
import org.turro.attach.www.AttachCtrl;
import org.turro.collections.KeyValueMap;
import org.turro.command.LabelControl;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.db.WhereClause;
import org.turro.file.util.FileAttach;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.path.Path;
import org.turro.plugin.contacts.IContact;
import org.turro.polls.PollsCtrl;
import org.turro.publication.db.PublicationPU;
import org.turro.publication.entity.Newsletter;
import org.turro.publication.entity.Publication;
import org.turro.publication.entity.PublicationCategory;
import org.turro.publication.zul.menu.PublicationMenu;
import org.turro.www.commentit.CommentItCtrl;
import org.turro.www.starit.StarItCtrl;
 
@ElephantEntity
public class PublicationEntities extends DefaultElephantEntity {
 
  public PublicationEntities() {
  }
 
  public PublicationEntities(String entityPath) {
    super(entityPath);
  }
 
  public PublicationEntities(Object entity) {
    super(entity);
  }
 
  @Override
  public Object getEntity() {
    if(entity == null) {
      if(getPath() != null) {
        if(isValidLongEntity()) {
          if(null != path.getRoot()) switch (path.getRoot()) {
            case "publication":
              entity = getDao().find(Publication.class, path.getNodeAs(1, Long.class));
              break;
            case "pub-category":
              entity = getDao().find(PublicationCategory.class, path.getNodeAs(1, Long.class));
              break;
            case "newsletter":
              entity = getDao().find(Newsletter.class, path.getNodeAs(1, Long.class));
              break;
            case "mail-category":
              entity = Notifications.getCategory(path.getPath());
              break;
            default:
              break;
          }
        }
      }
    }
    return entity;
  }
 
  @Override
  public String getName() {
    if(getEntity() != null) {
      if(entity instanceof Publication) {
        return ((Publication) entity).getTitle();
      } else if(entity instanceof PublicationCategory) {
        return ((PublicationCategory) entity).getName();
      } else if(entity instanceof Newsletter) {
        return ((Newsletter) entity).getTitle();
      } else if(entity instanceof NotificationCategory) {
        return ((NotificationCategory) entity).getCategory();
      }
    }
    return null;
  }
 
  @Override
  public String getLabel() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "publication":
          return I_.get("Publication");
        case "pub-category":
          return I_.get("Category");
        case "newsletter":
          return I_.get("Newsletter");
        case "mail-category":
          return I_.get("Category");
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getDescription() {
    if(getEntity() != null) {
      if(entity instanceof PublicationCategory) {
        return ((PublicationCategory) entity).getDescription();
      } else if(entity instanceof NotificationCategory) {
        return ((NotificationCategory) entity).getDescription();
      }
    }
    return null;
  }
 
  @Override
  public Object getLabelCtrl() {
    if(getEntity() != null) {
      if(entity instanceof Publication) {
        return new LabelControl(entity);
      } else if(entity instanceof PublicationCategory) {
        return new LabelControl(entity);
      } else if(entity instanceof Newsletter) {
        return new LabelControl(entity);
      } else if(entity instanceof NotificationCategory) {
        return new LabelControl(entity);
      }
    }
    return null;
  }
 
  @Override
  public String getImage() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "publication":
          return "/_zul/images/publication.png";
        case "pub-category":
          return "/_zul/images/group.png";
        case "newsletter":
          return "/_zul/images/newsletter.png";
        case "mail-category":
          return "/_zul/images/group.png";
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getHierarchicalPath() {
    if(getEntity() != null) {
      if(entity instanceof Publication) {
        return PublicationPU.getObjectPath(
                ((Publication) entity).getPublicationCategory()) +
                PATH_SEPARATOR + getPath();
      } else if(entity instanceof Newsletter) {
        return "/mail-category/" + ((Newsletter) entity).getIdCategory() +
                PATH_SEPARATOR + getPath();
      }
    }
    return getPath();
  }
 
  @Override
  public IElephantEntity getParent() {
    if(getEntity() != null) {
      if(entity instanceof Publication) {
        return Entities.getController(((Publication) entity).getPublicationCategory());
      }
    }
    return null;
  }
 
  @Override
  public List<IElephantEntity> getChildren() {
    if(getEntity() != null) {
      if(entity instanceof PublicationCategory) {
        return new EntityListAdapter(((PublicationCategory) entity).getPublications());
      }
    }
    return Collections.EMPTY_LIST;
  }
 
  @Override
  public String getExtendedPath() {
    return "";
  }
 
  @Override
  public File getFile() {
    return null;
  }
 
  @Override
  public boolean showPath() {
    return false;
  }
 
  @Override
  public boolean showEntity() {
    if(getEntity() != null) {
      if(entity instanceof Publication) {
        PublicationMenu.showPublication(((Publication) entity).getId());
        return true;
      } else if(entity instanceof Newsletter) {
        PublicationMenu.showNewsletter(((Newsletter) entity).getId());
        return true;
      }
    }
    return false;
  }
 
  @Override
  public boolean canEdit(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Publication) {
        return contact.getPermissions().isInRole("publication:edit") && (contact.getPermissions().isInRole("publication:all") || 
                ((Publication) entity).getIdContact().equals(contact.getId()));
      } else if(entity instanceof Newsletter) {
        return contact.getPermissions().isInRole("publication:edit");
      }
    }
    return false;
  }
 
  @Override
  public boolean canPublish(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Publication) {
        return true;
      } else if(entity instanceof Newsletter) {
        return true;
      }
    }
    return false;
  }
 
  @Override
  public Collection getEntitites(String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    list.addAll(searchPublications(search, maxResults, kvm));
    list.addAll(searchCategories(search, maxResults, kvm));
    list.addAll(searchNewsletters(search, maxResults, kvm));
    return list;
  }
 
  @Override
  public Collection getEntitites(String root, String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    if(null != root) switch (root) {
      case "publication":
        list.addAll(searchPublications(search, maxResults, kvm));
        break;
      case "pub-category":
        list.addAll(searchCategories(search, maxResults, kvm));
        break;  
      case "newsletter":
        list.addAll(searchNewsletters(search, maxResults, kvm));
        break;  
      default:
        break;
    }
    return list;
  }
 
  @Override
  public IElephantSendable getSendable() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "publication":
          return new PublicationSendable(getPath());
        case "newsletter":
          return new NewsletterSendable(getPath());
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public Object configureCtrl(Object ctrl, IContact contact) {
    if(ctrl instanceof StarItCtrl) {
      StarItCtrl ictrl = (StarItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof CommentItCtrl) {
      CommentItCtrl ictrl = (CommentItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof AttachCtrl) {
      AttachCtrl ictrl = (AttachCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      ictrl.setPublicOnly(true);
      return ictrl;
    } else if(ctrl instanceof FileAttach) {
      FileAttach ictrl = (FileAttach) ctrl;
      return ictrl;
    } else if(ctrl instanceof PollsCtrl) {
      PollsCtrl ictrl = (PollsCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof IEntityCtrl) {
      IEntityCtrl ictrl = (IEntityCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    }
    return ctrl;
  }
 
  @Override
  public boolean canShowInContext(IContact contact, Object relatedEntity) {
    return true;
  }
 
  @Override
  public String getExtendedWebPath() {
    if(getEntity() != null) {
      if(entity instanceof Publication) {
        Publication publication = (Publication) entity;
        return "/" + publication.getId() + 
                "/" + Strings.unpunctuate(publication.getTitle()).toLowerCase();
      } else if(entity instanceof Newsletter) {
        Newsletter newsletter = (Newsletter) entity;
        return "/" + newsletter.getId() + 
                "/" + Strings.unpunctuate(newsletter.getTitle()).toLowerCase();
      }
    }
    return null;
  }
 
  @Override
  public String getUserContext() {
    getPath();
    if(path.getRoot().equals("publication")) {
      return ElephantContext.getEntityWebContext("/publication");
    } else if(path.getRoot().equals("newsletter")) {
      return "/user/newsletter";
    }
    return null;
  }
 
  @Override
  protected Dao createDao() {
    return new PublicationPU();
  }
 
  @Override
  protected boolean itsMine(Object entity) {
    return (entity instanceof Publication) || (entity instanceof PublicationCategory) || 
            (entity instanceof Newsletter) || (entity instanceof NotificationCategory);
  }
 
  @Override
  public Collection<String> getAllowedRoots() {
    return Arrays.asList("publication", "pub-category", "newsletter", "mail-category");
  }
 
  @Override
  protected IElephantEntity createInstance(String entityPath) {
    return new PublicationEntities(entityPath);
  }
 
  @Override
  protected IElephantEntity createInstance(Object entity) {
    return new PublicationEntities(entity);
  }
 
  @Override
  protected Path createPath() {
    return new Path(PublicationPU.getObjectPath(entity));
  }
 
  private List<Object> searchPublications(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Publication c");
    wc.addClause("where c.title like :search");
    wc.addClause("order by c.title");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchCategories(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from PublicationCategory c");
    wc.addClause("where c.name like :search");
    wc.addClause("order by c.name");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchNewsletters(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Newsletter c");
    wc.addClause("where c.title like :search");
    wc.addClause("order by c.title");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
}