Coverage Report

Coverage Report - net.sf.webphotos.Album

Classes in this File
Line Coverage
Branch Coverage
Complexity
Album
0/264
0/102
2,811
 /**
  * Copyright 2008 WebPhotos
  *
  * 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 net.sf.webphotos;
 
 import java.io.File;
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.text.SimpleDateFormat;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
 import javax.swing.JOptionPane;
 import net.sf.webphotos.dao.jpa.AlbumDAO;
 import net.sf.webphotos.entity.IsPhoto;
 import net.sf.webphotos.model.AlbumVO;
 import net.sf.webphotos.model.PhotoVO;
 import net.sf.webphotos.util.ApplicationContextResource;
 import net.sf.webphotos.util.Util;
 import net.sf.webphotos.util.legacy.CacheFTP;
 import org.apache.log4j.Logger;
 
 /**
  * A classe Album mantém uma coleçao de fotos em um ArrayList de PhotoDTO, que
  * pode ser manipulada através das funções da própria classe. Classe do tipo
  * Singleton, é permitido apenas uma instância da classe. O objeto é acessível
  * unicamente através da classe. Também manipula dados dos IDs, nome do albúm,
  * descrição, data de inserção e categoria.
  */
 public class Album {
 
     private static final Album instanciaAlbum = new Album();
     /**
      * variáveis do álbum
      */
     private int albumID = 0;
     private int categoriaID = 0;
     private int usuarioID = 0;
     private String nmAlbum = null;
     private String descricao = null;
     private String dtInsercao = null;
     /**
      * variáveis utilizadas nessa classe
      */
     private Set<PhotoVO> fotos = new HashSet<PhotoVO>();
     /**
      *
      */
     private Set<PhotoDTO> fotosNovas = new HashSet<PhotoDTO>();
     private String[][] categorias = null;
     private Logger log = Logger.getLogger(this.getClass().getName());
     private static AlbumDAO albunsDAO = (AlbumDAO) ApplicationContextResource.getBean("albunsDAO");
 
     /**
      * nunca usado publicamente (construtor private)
      */
     private Album() {
     }
 
     /**
      * Retorna o objeto Album instanciado na própria classe.
      *
      * @return Retorna um objeto Album.
      */
     public static Album getAlbum() {
         return instanciaAlbum;
     }
 
     /**
      * Seta um valor para o ID do albúm.
      *
      * @param aID ID do álbum.
      */
     public void setAlbumID(int aID) {
         albumID = aID;
     }
 
     /**
      * Seta um valor para o ID do usuário.
      *
      * @param uID ID do usuário.
      */
     public void setUsuarioID(int uID) {
         usuarioID = uID;
     }
 
     /**
      * Seta um valor para o ID de categoria.
      *
      * @param cID ID da categoria.
      */
     public void setCategoriaID(int cID) {
         categoriaID = cID;
     }
 
     /**
      * Seta um valor para o nome do albúm.
      *
      * @param nm Nome do albúm.
      */
     public void setNmAlbum(String nm) {
         nmAlbum = nm;
     }
 
     /**
      * Seta um valor para a descrição do albúm.
      *
      * @param d Descrição do albúm.
      */
     public void setDescricao(String d) {
         descricao = d;
     }
 
     /**
      * Seta um valor para a data de inserção do albúm.
      *
      * @param dt Data de inserção do albúm.
      */
     public void setDtInsercao(String dt) {
         dtInsercao = dt;
     }
 
     /**
      * Retorna o ID do albúm.
      *
      * @return Retorna um ID.
      */
     public int getAlbumID() {
         return albumID;
     }
 
     /**
      * Retorna o ID do usuário.
      *
      * @return Retorna um ID.
      */
     public int getUsuarioID() {
         return usuarioID;
     }
 
     /**
      * Retorna o ID da categoria.
      *
      * @return Retorna um ID.
      */
     public int getCategoriaID() {
         return categoriaID;
     }
 
     /**
      * Retorna o nome do albúm.
      *
      * @return Retorna um nome.
      */
     public String getNmAlbum() {
         return nmAlbum;
     }
 
     /**
      * Retorna a descrição do albúm.
      *
      * @return Retorna uma descrição.
      */
     public String getDescricao() {
         return descricao;
     }
 
     /**
      * Retorna a data de inserção do albúm.
      *
      * @return Retorna uma data.
      */
     public String getDtInsercao() {
         return dtInsercao;
     }
 
     /**
      * Retorna uma foto deste album ou null se não existir. Faz a busca da foto
      * através de um ID enviado como parâmetro.
      *
      * @param fotoID ID da foto.
      * @return Retorna uma foto.
      */
     public PhotoDTO getFoto(int fotoID) {
         Iterator<PhotoVO> iter = fotos.iterator();
 
         while (iter.hasNext()) {
             PhotoVO f = iter.next();
             if (f.getFotoid() == fotoID) {
                 return new PhotoDTO(f);
             }
         }
         return null;
     }
 
     /**
      * Retorna uma foto deste album ou null se não existir. Faz a busca da foto
      * através do caminho do arquivo que foi enviado como parâmetro.
      *
      * @param caminho Caminho do arquivo foto.
      * @return Retorna uma foto.
      */
     public PhotoDTO getFoto(String caminho) {
         Iterator<PhotoDTO> iter = fotosNovas.iterator();
 
         while (iter.hasNext()) {
             PhotoDTO f = iter.next();
             if (caminho.equals(f.getCaminhoArquivo())) {
                 return f;
             }
         }
         return null;
     }
 
     /**
      * Retorna toda a coleção encontrada no ArrayList fotos.
      *
      * @return Retorna a coleção de fotos.
      */
     public PhotoDTO[] getFotos() {
         final Set<IsPhoto> allPhotos = getAllPhotos();
         return allPhotos.toArray(new PhotoDTO[allPhotos.size()]);
     }
 
     /**
      * Retorna uma matriz com as fotos e seus dados específicos. Armazena para
      * cada foto o seu ID ou caminho, legenda e crédito.
      *
      * @return Retorna todas as fotos e seus valores específicos.
      */
     public Object[][] getFotosArray() {
         Set<IsPhoto> joined = getAllPhotos();
 
         Object[][] resultado = new Object[joined.size()][3];
         Iterator<IsPhoto> iter = joined.iterator();
         int ct = 0;
 
         while (iter.hasNext()) {
             IsPhoto photo = iter.next();
             resultado[ct][0] = photo.getKey();
             resultado[ct][1] = photo.getLegenda();
             resultado[ct][2] = photo.getCreditos().getNome();
             ct++;
         }
         return resultado;
     }
 
     /**
      * Retorna um vetor que armazenará os dados de ID, legenda e crédito da
      * foto.
      *
      * @return Retorna dados de ID, legenda e crédito da foto.
      */
     public String[] getFotosColunas() {
         return new String[]{"ID", "Legenda", "Credito"};
     }
 
     /**
      *
      * @return
      */
     public String[] getCategoriasArray() {
         return getCategoriasArray(Boolean.FALSE);
     }
 
     /**
      * Retorna um vetor que armazena as categorias. Checa se categoria é
      * diferente de null. Caso afirmativo, armazena seus valores no vetor criado
      * para retorno.
      *
      * @return Retorna as categorias do albúm.
      */
     public String[] getCategoriasArray(Boolean force) {
         int tamanho;
         if (categorias == null || force == true) {
             try {
                 log.info("Populando Categorias");
                 populaCategorias();
                 tamanho = categorias.length;
             } catch (SQLException ex) {
                 log.error("Impossível popular categorias", ex);
                 tamanho = 0;
             }
         } else {
             tamanho = categorias.length;
         }
 
         String[] nomesCategorias = new String[tamanho];
         for (int i = 0; i < tamanho; i++) {
             nomesCategorias[i] = categorias[i][1];
         }
 
         return nomesCategorias;
     }
 
     /**
      * Retorna um índice da matriz categorias. Faz a busca através de um nome
      * enviado como parâmetro. Caso não seja encontrado pelo nome, retorna o
      * valor 0.
      *
      * @param nomeCategoria Nome da categoria pesquisada.
      * @return Retorna um índice de posição.
      */
     public int getLstCategoriasIndex(String nomeCategoria) {
         for (int i = 0; i < categorias.length; i++) {
             if (nomeCategoria.equals(categorias[i][1])) {
                 return i;
             }
         }
         return 0;
     }
 
     /**
      * Retorna um índice da matriz categorias. Faz a busca através de um ID
      * enviado como parâmetro. Caso não seja encontrado pelo ID, retorna o valor
      * 0.
      *
      * @param categoriaID ID da categoria pesquisada.
      * @return Retorna um índice de posição.
      */
     public int getLstCategoriasIndex(int categoriaID) {
         for (int i = 0; i < categorias.length; i++) {
             if (categoriaID == Integer.parseInt(categorias[i][0])) {
                 return i;
             }
         }
         return 0;
     }
 
     /**
      * Retorna o ID dado um nome de categoria.
      *
      * @param nomeCategoria Nome de categoria pesquisada.
      * @return Retorna um ID.
      */
     public int getLstCategoriasID(String nomeCategoria) {
         for (int i = 0; i < categorias.length; i++) {
             if (nomeCategoria.equals(categorias[i][1])) {
                 return Integer.parseInt(categorias[i][0]);
             }
         }
         return -1;
     }
 
     /**
      * Limpa o ArrayList fotos. Seta o valor 0 para as variáveis numéricas e
      * vazio para variáveis de tipo String.
      */
     public void clear() {
         albumID = 0;
         usuarioID = 0;
         categoriaID = 0;
         nmAlbum = "";
         descricao = "";
         dtInsercao = "";
         if (fotos != null) {
             fotos.clear();
         }
     }
 
     /**
      * Carrega um albúm no ArrayList fotos que anteriormente foi salvo no banco
      * de dados. Após limpar os valores em fotos, faz uma busca ao banco de
      * dados para carregar informações do albúm especificado. A comparação no
      * banco de dados é feita através do ID do albúm, passado como parâmetro.
      *
      * @param aID ID do albúm.
      */
     public void loadAlbum(int aID) {
 
         fotos.clear();
 
         AlbumVO album = ((AlbumDAO) ApplicationContextResource.getBean("albunsDAO")).findBy(aID);
 
         if (album != null) {
             albumID = aID;
             categoriaID = album.getCategoriasVO().getCategoriaID();
             usuarioID = 0;
             nmAlbum = album.getNmalbum();
             descricao = album.getDescricao();
             dtInsercao = new SimpleDateFormat("dd/MM/yyyy").format(album.getDtInsercao());
         }
 
         try {
 
             /**
              * Popula a collection fotos
              */
             fotos = album.getPhotos();
 
         } catch (Exception e) {
             log.error("Ocorreu um erro durante a leitura do álbum no banco de dados", e);
             int selecao = JOptionPane.showConfirmDialog(null,
                     "ERRO durante leitura do álbum no banco de dados.\n\nTentar Novamente?",
                     "Aviso!",
                     JOptionPane.YES_NO_OPTION,
                     JOptionPane.WARNING_MESSAGE);
             if (selecao == JOptionPane.YES_OPTION) {
                 /**
                  * TODO: extrair para um método
                  */
                 loadAlbum(aID);
 
             } else {
                 log.error("Ocorreu um erro inexperado durante a leitura do álbum", e);
                 JOptionPane.showMessageDialog(null, "ERRO inexperado durante leitura do álbum - " + e.getMessage(), "Erro!", JOptionPane.ERROR_MESSAGE);
                 throw new RuntimeException(e);
             }
         }
     }
 
     /**
      * Recebe um vetor com IDs de albúns a serem excluídos. Adiciona os albúns
      * no arquivo FTP, exclui os albúns do banco de dados e por último exclui os
      * arquivos da pasta local ou rede.
      *
      * @param albunsID IDs dos albúns.
      */
     public void excluirAlbuns(int[] albunsID) {
         Statement st = null;
         boolean sucesso = true;
 
         // passo 1 - adiciona o álbum no arquivoFTP
         for (int i = 0; i < albunsID.length; i++) {
             CacheFTP.getCache().addCommand(CacheFTP.DELETE, albunsID[i], 0);
         }
 
         // passo 2 - remover do banco de dados
         try {
             for (int i = 0; i < albunsID.length; i++) {
                 albunsDAO.remove(albunsDAO.findBy(i));
             }
             log.info("Exclusão dos álbuns e fotos no banco de dados efetuada com sucesso !");
         } catch (Exception e) {
             log.error("Houve um erro na exclusao de albuns no banco de dados", e);
             sucesso = false;
         } finally {
             try {
                 if (st != null) {
                     st.close();
                 }
             } catch (Exception e) {
                 log.debug("Can't Close Statement", e);
             }
         }
 
 
         // passo 3 - remover os arquivos local ou rede
         for (int i = 0; i < albunsID.length; i++) {
             File diretorio = new File(BancoImagem.getLocalPath(albunsID[i]));
             if (diretorio.isDirectory() == true) {
                 // provavelmente tem fotos nesse diretorio
                 String[] arquivos = diretorio.list();
                 if (arquivos.length > 0) {
                     // apagamos os arquivos desse diretorio
                     for (int j = 0; j < arquivos.length; j++) {
                         File arquivo = new File(BancoImagem.getLocalPath(albunsID[i]) + File.separator + arquivos[j]);
                         if (arquivo.delete() == true) {
                             log.info(BancoImagem.getLocalPath(albunsID[i]) + File.separator + arquivos[j] + " excluído com sucesso");
                         } else {
                             log.error("Erro na exclusão de " + BancoImagem.getLocalPath(albunsID[i]) + File.separator + arquivos[j]);
                             sucesso = false;
                         }
                     }
                 }
                 if (diretorio.delete() == true) {
                     log.info(BancoImagem.getLocalPath(albunsID[i]) + " excluído com sucesso");
                 } else {
                     log.error("Erro na exclusão de " + BancoImagem.getLocalPath(albunsID[i]));
                     sucesso = false;
                 }
             }
         } // fim for
         if (sucesso) {
             log.info("Álbum(ns) excluído(s) com sucesso.");
         } else {
             log.warn("Finalizando com erros na exclusão.");
         }
     }
 
     /**
      * Recebe uma lista com nomes de fotos e faz uma busca no ArrayList fotos,
      * caso encontre, exclui a foto específica. Essa função exclui fotos da
      * coleção que ainda não estejam cadastradas no DB nem feito thumbnails
      * (usuário adicionou e quer excluir essas fotos).
      *
      * @param nomes Lista de nomes de fotos.
      */
     public void excluirFotos(String[] nomes) {
         String nome;
         PhotoVO foto;
 
         for (int i = 0; i < nomes.length; i++) {
             Iterator<PhotoVO> iter = fotos.iterator();
             nome = nomes[i];
 
             while (iter.hasNext()) {
                 foto = iter.next();
                 if (nome.equals(foto.getCaminhoArquivo())) {
                     iter.remove();
                     break;
                 }
             } // fim while
         } // fim for
     } // fim metodo
 
     /**
      * Recebe uma lista com IDs das fotos e faz uma busca para excluir as fotos
      * específicas do DB, FTP e FS.
      *
      * @param fotosID Lista de IDs de fotos.
      */
     public void excluirFotos(int[] fotosID) {
         Statement st = null;
         boolean sucesso = true;
         int aID = getAlbum().albumID;
         AlbumVO albumVO = albunsDAO.findBy(aID);
         String sql;
 
         // passo 1 - adicionar o arquivo em ArquivoFTP
         for (int i = 0; i < fotosID.length; i++) {
             CacheFTP.getCache().addCommand(CacheFTP.DELETE, aID, fotosID[i]);
         }
 
         // passo 2 - remover do banco de dados
         try {
             for (int i = 0; i < fotosID.length; i++) {
                 albumVO.getPhotos().remove(albumVO.getPhotoBy(fotosID[i]));
             }
             albunsDAO.getEntityManager().merge(albumVO);
         } catch (Exception e) {
             log.error("Erro na exclusão no banco de dados ", e);
             sucesso = false;
         } finally {
             try {
                 if (st != null) {
                     st.close();
                 }
             } catch (Exception e) {
                 log.warn("Can't close statement", e);
             }
         }
 
         // passo 3 - remover arquivos do fs (original e _a, _b, _c e _d)
         String[] prefixos = {"", "_a", "_b", "_c", "_d"};
         String nomeArquivo;
         boolean encontrou;
 
         for (int i = 0; i < fotosID.length; i++) {
             // pesquisa a foto na coleção deste álbum e remove da colecao
             encontrou = false;
             Iterator<PhotoVO> iter = fotos.iterator();
             while (iter.hasNext() && !encontrou) {
                 PhotoVO f = iter.next();
                 if (f.getFotoid() == fotosID[i]) {
                     encontrou = true;
                     iter.remove();
                 }
             }
 
             for (int j = 0; j < prefixos.length; j++) {
                 nomeArquivo = BancoImagem.getLocalPath(aID) + File.separator + prefixos[j] + fotosID[i] + ".jpg";
                 File arqFoto = new File(nomeArquivo);
 
                 if (arqFoto.isFile()) {
                     if (arqFoto.delete()) {
                         log.info(nomeArquivo + " excluído com sucesso");
                     } else {
                         log.error(nomeArquivo + " não pode ser excluído ");
                         sucesso = false;
                     }
                 } else {
                     log.warn(nomeArquivo + " não é arquivo ou não existe");
                     sucesso = false;
                 }
             }
         }
 
         //passo 4 - removendo do site remoto
         if (Util.getConfig().getBoolean("autoTransferir")) {
             Thread t = new Thread(new net.sf.webphotos.gui.util.FtpClient());
             t.start();
         }
 
 
         if (sucesso) {
             log.info("Exclusão de fotos finalizada com sucesso.");
         } else {
             log.warn("Exclusão de fotos finalizada com erros.");
         }
     }
 
     /**
      * Inclui fotos na coleção. Recebe uma lista de arquivos de fotos, que serão
      * implantados no ArrayList fotos.
      *
      * @param photo Lista de arquivos.
      */
     public void adicionarFotos(File[] f) {
         if (f.length == 0) {
             return;
         }
 
         for (int i = 0; i < f.length; i++) {
             File novaFoto = f[i];
             fotosNovas.add(new PhotoDTO(novaFoto.getAbsolutePath()));
         }
     }
 
     // popula a matriz de creditos, normalmente feito somente na primeira vez
     // ou na ocasião de um novo crédito adicionado ao banco de dados
     private void populaCategorias() throws SQLException {
         String sql = Util.getConfig().getString("sql2");
 
         List<Object[]> tableData = albunsDAO.findByNativeQuery(sql);
 
         categorias = new String[tableData.size()][2];
 
         int ct = 0;
         for (Object[] objects : tableData) {
             categorias[ct][0] = objects[0].toString();
             categorias[ct][1] = objects[1].toString();
             ct++;
         }
     }
 
     /**
      * Retorna a categoria específica. Faz a busca na matriz categorias,
      * comparando com o ID recebido como parãmetro.
      *
      * @param categoriaID ID da categoria.
      * @return Retorna uma categoria.
      */
     public String getCategoria(int categoriaID) {
         int tamanho;
         if (categorias == null) {
             try {
                 populaCategorias();
                 tamanho = categorias.length;
             } catch (SQLException ex) {
                 tamanho = 0;
             }
         } else {
             tamanho = categorias.length;
         }
 
         for (int i = 0; i < tamanho; i++) {
             if (categorias[i][0].equals(Integer.toString(categoriaID))) {
                 return categorias[i][1];
             }
         }
         return "categoria nao encontrada";
     }
 
     /**
      * Retorna uma String contendo todos os dados do albúm.
      *
      * @return Retorna dados do albúm.
      */
     @Override
     public String toString() {
         Iterator<PhotoVO> iter = fotos.iterator();
 
         String msg = "--------------------------------------"
                 + "\nalbumID    : " + albumID
                 + "\nusuarioID  : " + usuarioID
                 + "\ncategoriaID: " + categoriaID
                 + "\nAlbum      : " + nmAlbum
                 + "\nDescricao  : " + descricao
                 + "\ndtInsercao : " + dtInsercao
                 + "\nnum.fotos  : " + fotos.size()
                 + "\n--------------------------------------";
 
         while (iter.hasNext()) {
             PhotoVO f = iter.next();
             msg = msg + "\n" + f.toString() + "\n--------------------------------------";
         }
 
         return msg;
     }
 
     /**
      * Retorna uma String contendo todos os dados do albúm no formato XML.
      *
      * @return Retorna dados do albúm.
      */
     public String toXML() {
 
         String r = "<?xml version=\"1.0\" encoding=\"ISO8859-1\"?>"
                 + "\n<album id=\"" + albumID + "\">"
                 + "\n\t<titulo>" + nmAlbum + "</titulo>"
                 + "\n\t<categoria id=\"" + categoriaID + "\">" + getCategoria(categoriaID) + "</categoria>"
                 + "\n\t<descricao>" + descricao + "</descricao>"
                 + "\n\t<data>" + dtInsercao + "</data>"
                 + "\n"
                 + "\n\t<fotos>";
 
         Iterator<PhotoVO> iter = fotos.iterator();
         while (iter.hasNext()) {
             PhotoVO f = iter.next();
             r += "\n\t\t<foto id=\"" + f.getFotoid() + "\">"
                     + "\n\t\t\t<legenda>" + f.getLegenda() + "</legenda>"
                     + "\n\t\t\t<credito>" + f.getCreditos().getNome() + "</credito>"
                     + "\n\t\t\t<altura>" + f.getAltura() + "</altura>"
                     + "\n\t\t\t<largura>" + f.getLargura() + "</largura>"
                     + "\n\t\t</foto>";
         }
 
         r += "\n\t</fotos>"
                 + "\n</album>\n";
 
         return r;
 
     }
 
     /**
      * Retorna uma String contendo todos os dados do albúm no formato js.
      *
      * @return Retorna dados do albúm.
      */
     public String toJavaScript() {
 
         String r = "albumID=" + albumID + ";\n"
                 + "categoria='" + getCategoria(categoriaID) + "';\n"
                 + "titulo=" + Util.stringToHtm(nmAlbum) + ";\n"
                 + "data='" + dtInsercao + "';\n"
                 + "descricao=" + Util.stringToHtm(descricao) + ";\n\n"
                 + "fotos = new Array (";
 
         Iterator<PhotoVO> iter = fotos.iterator();
         String cc = "";
 
         while (iter.hasNext()) {
             PhotoVO f = iter.next();
             r += cc + "\n\tnew Foto(" + f.getFotoid() + "," + Util.stringToHtm(f.getLegenda()) + ",'" + f.getCreditos().getNome() + "')";
             cc = ",";
         }
 
         r += "\n\t);\n";
 
         return r;
 
     }
 
     @Override
     public Object clone() throws CloneNotSupportedException {
         throw new CloneNotSupportedException("Singleton Object");
     }
 
     private Set<IsPhoto> getAllPhotos() {
         Set<IsPhoto> joined = new HashSet<IsPhoto>();
         joined.addAll(fotos);
         joined.addAll(fotosNovas);
         return joined;
     }
 }