Coverage Report

Coverage Report - net.sf.webphotos.util.Util

Classes in this File

Line Coverage

Branch Coverage

Complexity

Util

23%

28/121

2/42

3,077

 /**
  * 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.util;
 
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.PrintStream;
 import java.util.StringTokenizer;
 import javax.swing.JOptionPane;
 import javax.swing.JTable;
 import javax.swing.JTextArea;
 import javax.swing.table.DefaultTableColumnModel;
 import javax.swing.table.TableColumn;
 import javax.swing.table.TableColumnModel;
 import org.apache.commons.configuration.CombinedConfiguration;
 import org.apache.commons.configuration.Configuration;
 import org.apache.commons.configuration.DefaultConfigurationBuilder;
 import org.apache.commons.configuration.XMLConfiguration;
 import org.apache.log4j.Logger;
 
 /**
  * Esta classe armazena alguns métodos de utilidade para o funcionamento de todo
  * o programa.
  * <PRE>
  * Exemplo: PrintStream out que desvia a saída padrão de texto.
  * </PRE>
  */
 @SuppressWarnings("StaticNonFinalUsedInInitialization")
 public class Util {
 
     private static final String WEBPHOTOS_USER_CONFIG = "webphotos.xml";
     /**
      *
      */
     public static final String WEBPHOTOS_DEFAULT_CONFIG = "webphotos.dat";
     private static Util instancia = new Util();
     /**
      * caixa de texto para dar saída ao log
      */
     private static JTextArea saida;
     private static File albunsRoot = null;
     private static Configuration config;
     /**
      * Para desviar a saída padrão de texto (em produção).
      */
     public static PrintStream out;
     /**
      * Para desviar a saída padrão de texto (em produção).
      */
     public static PrintStream err;
     private static final Logger log;
 
     static {
         out = System.out;
         err = System.err;
         log = Logger.getLogger(Util.class);
 
         DefaultConfigurationBuilder configurationBuilder = new DefaultConfigurationBuilder();
         String userHome = "";
         try {
             configurationBuilder.setFileName("Configuration.xml");
             CombinedConfiguration auxConfig = configurationBuilder.getConfiguration(true);
             config = auxConfig.interpolatedConfiguration();
             userHome = config.getString("user.home");
         } catch (Exception e) {
             log.error("Can't load preferences");
             log.debug("Stack Trace : ", e);
             System.exit(-1);
         }
         configurationBuilder = new DefaultConfigurationBuilder();
         try {
             configurationBuilder.setFileName("SavedConfiguration.xml");
             final CombinedConfiguration configuration = configurationBuilder.getConfiguration(true);
             XMLConfiguration savedUserPrefs = new XMLConfiguration();
             savedUserPrefs.append(configuration);
             savedUserPrefs.setEncoding("ISO-8859-1");
             savedUserPrefs.save(new FileOutputStream(userHome + File.separatorChar + WEBPHOTOS_USER_CONFIG));
         } catch (Exception e) {
             log.warn("Can't save preferences");
             log.debug("Stack Trace : ", e);
         }
     }
 
     /**
      *
      * @return
      */
     public static Configuration getConfig() {
         return config;
     }
 
     private Util() {
     }
 
     /**
      * Retorna a instância da própria classe.
      *
      * @return Retorna a instância de Util.
      */
     public static Util getInstance() {
         return instancia;
     }
 
     /**
      * Retorna o diretório raiz de albuns. Checa se a variável albunsRoot já
      * possui o valor, caso não, busca o arquivo nas propriedades através do
      * método
      * {@link net.sf.webphotos.util.Util#getProperty(String) getProperty}(String
      * chave) e faz um teste para checar se é um diretório mesmo. Caso tudo
      * esteja correto, retorna o diretório.
      *
      * @return Retorna um diretório.
      */
     public static File getAlbunsRoot() {
         if (albunsRoot == null) {
             albunsRoot = new File(getProperty("albunsRoot"));
             if (!albunsRoot.isDirectory()) {
                 StringBuilder errMsg = new StringBuilder();
                 errMsg.append("O diretório fornecido no parâmetro albunsRoot (arquivo de configuração)\n");
                 errMsg.append("não pode ser utilizado, ou não existe.\n");
                 errMsg.append("O programa será encerrado.");
                 JOptionPane.showMessageDialog(null, errMsg.toString(), "Erro no arquivo de configuração", JOptionPane.ERROR_MESSAGE);
                 //throw new RuntimeException(errMsg.toString());
                 System.exit(-1);
             }
         }
         return albunsRoot;
     }
 
     /**
      * Retorna o diretório raiz de albuns. Checa se a variável albunsRoot já
      * possui o valor, caso não, busca o arquivo nas propriedades através do
      * método
      * {@link net.sf.webphotos.util.Util#getProperty(String) getProperty}(String
      * chave) e faz um teste para checar se é um diretório mesmo. Caso tudo
      * esteja correto, retorna o diretório.
      *
      * @return Retorna um diretório.
      */
     public static File getFolder(String param) {
         File folder = new File(getProperty(param));
         if (!folder.isDirectory()) {
             StringBuilder errMsg = new StringBuilder();
             errMsg.append("O diretório fornecido no parâmetro albunsRoot (arquivo de configuração)\n");
             errMsg.append("não pode ser utilizado, ou não existe.\n");
             errMsg.append("O programa será encerrado.");
             JOptionPane.showMessageDialog(null, errMsg.toString(), "Erro no arquivo de configuração", JOptionPane.ERROR_MESSAGE);
             //throw new RuntimeException(errMsg.toString());
             System.exit(-1);
         }
         return folder;
     }
 
     /**
      * Trabalha o texto recebido para impressão do log. Se existir algum erro
      * contido no texto, separa o erro e imprime separado do resto da saída.
      * TODO: enviar o log para arquivo e um componente swing. Eliminar esse
      * método com o Log4J ou semelhante.
      *
      * @param texto Texto para impressão.
      */
     public static void log(String texto) {
         if (texto == null) {
             saida = null;
         }
         if (saida == null) {
             log.info("LOG: " + texto);
         } else {
             if (texto.startsWith("[")) {
                 Util.err.println(texto);
                 texto = texto.substring(texto.indexOf('/') + 1);
             }
             saida.append(texto);
             saida.append("\n");
             saida.setCaretPosition(saida.getText().length() - 1);
         }
     }
 
     /**
      * Retorna uma String que substitui alguns caracteres especiais em Java
      * pelos do formato HTM.
      *
      * @param valor Texto a ser formatado.
      * @return Retorna texto formatado em HTM.
      */
     public static String stringToHtm(String valor) {
         valor = valor.replaceAll("\n", "<br>");
         valor = valor.replaceAll("\"", "&quot;");
         valor = valor.replaceAll("\'", "&quot;");
         return "\'" + valor + "\'";
     }
 
     /**
      * Recebe um textarea e seta esse valor na variável saida.
      *
      * @param saidaGUI textarea para indicar a saída.
      */
     public static void setLoggingTextArea(JTextArea saidaGUI) {
         saida = saidaGUI;
     }
 
     /**
      * Retorna uma String contendo a propriedade. Testa se é necessário carregar
      * o arquivo de propriedades, então busca a propriedade no arquivo através
      * da variável passada como parâmetro.
      *
      * @param chave Propriedade.
      * @return Retorna o valor da propriedade.
      */
     public static String getProperty(String chave) {
         try {
             return (config.getString(chave) == null || config.getString(chave).isEmpty()) ? null : config.getString(chave);
         } catch (Exception e) {
             log.error("Error trying to get a property", e);
             return null;
         }
     }
 
     /**
      * Ajusta a largura das colunas do modelo.
      *
      * @param tabela Tabela que deseja ajustar as colunas.
      * @param parametros Tamanhos das colunas separadas por vírgula.
      */
     public static void ajustaLargura(JTable tabela, String parametros) {
         int temR = -1;
         TableColumnModel modeloColunas = tabela.getColumnModel();
         if (parametros == null) {
             return;
         }
         if (parametros.length() > 0) {
             StringTokenizer tok = new StringTokenizer(parametros, ",");
             int ct = 0;
             String l;
             while (tok.hasMoreTokens()) {
                 l = tok.nextToken();
                 try {
                     modeloColunas.getColumn(ct).setPreferredWidth(Integer.parseInt(l));
                 } catch (NumberFormatException nE) {
                     if (l.equals("*")) {
                         log.info("Packing column " + ct);
                         packColumn(tabela, ct, 1);
                     } else if (l.equals("R")) {
                         temR = ct;
                     }
                 } catch (Exception e) {
                 }
                 ct++;
             }
 
             if (temR > 0) {
                 modeloColunas.getColumn(temR).setPreferredWidth(modeloColunas.getColumn(temR).getPreferredWidth() + tabela.getWidth() - modeloColunas.getTotalColumnWidth());
                 log.debug("Tamanho da tabela: " + (modeloColunas.getColumn(temR).getPreferredWidth() + tabela.getWidth() - modeloColunas.getTotalColumnWidth()));
             }
 
             //Testes
             log.debug("Tamanho Total: " + modeloColunas.getTotalColumnWidth());
             log.debug("Tamanho da tabela: " + tabela.getWidth());
         }
     }
 
     /**
      * PackColumn sets the preferred width of the visible column specified by
      * vColIndex. The column will be just wide enough to show the column head
      * and the widest cell in the column. margin pixels are added to the left
      * and right (resulting in an additional width of 2*margin pixels).
      *
      * @param table The table you want to resize a column.
      * @param vColIndex The column number.
      * @param margin Extra spaces for each side of column.
      */
     public static void packColumn(JTable table, int vColIndex, int margin) {
         DefaultTableColumnModel colModel = (DefaultTableColumnModel) table.getColumnModel();
         TableColumn col = colModel.getColumn(vColIndex);
         int width;
 
         // Get width of column header
         javax.swing.table.TableCellRenderer renderer = col.getHeaderRenderer();
         if (renderer == null) {
             renderer = table.getTableHeader().getDefaultRenderer();
         }
         java.awt.Component comp = renderer.getTableCellRendererComponent(
                 table, col.getHeaderValue(), false, false, 0, 0);
         width = comp.getPreferredSize().width;
 
         // Get maximum width of column data
         for (int r = 0; r < table.getRowCount(); r++) {
             renderer = table.getCellRenderer(r, vColIndex);
             comp = renderer.getTableCellRendererComponent(
                     table, table.getValueAt(r, vColIndex), false, false, r, vColIndex);
             width = Math.max(width, comp.getPreferredSize().width);
         }
 
         // Add margin
         width += 2 * margin;
 
         // Set the width
         col.setPreferredWidth(width);
     }
 
     @Override
     public Object clone() throws CloneNotSupportedException {
         throw new CloneNotSupportedException("Singleton Object");
     }
 
     /**
      *
      */
     public static void loadSocksProxy() {
         String socksHost = getConfig().getString("socks.host");
         int socksPort = 0;
         if (getConfig().containsKey("socks.port")) {
             socksPort = getConfig().getInt("socks.port");
         }
         //Prepara as conexões para usar Socks Proxy (se configurado)
         if (socksHost != null && !socksHost.isEmpty()) {
             System.getProperties().put("socksProxyHost", socksHost);
             if (socksPort > 0 && socksPort < 65534) {
                 System.getProperties().put("socksProxyPort", socksPort);
             }
         }
     }
 }

1		/**
2		* Copyright 2008 WebPhotos
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16		package net.sf.webphotos.util;
17
18		import java.io.File;
19		import java.io.FileOutputStream;
20		import java.io.PrintStream;
21		import java.util.StringTokenizer;
22		import javax.swing.JOptionPane;
23		import javax.swing.JTable;
24		import javax.swing.JTextArea;
25		import javax.swing.table.DefaultTableColumnModel;
26		import javax.swing.table.TableColumn;
27		import javax.swing.table.TableColumnModel;
28		import org.apache.commons.configuration.CombinedConfiguration;
29		import org.apache.commons.configuration.Configuration;
30		import org.apache.commons.configuration.DefaultConfigurationBuilder;
31		import org.apache.commons.configuration.XMLConfiguration;
32		import org.apache.log4j.Logger;
33
34		/**
35		* Esta classe armazena alguns métodos de utilidade para o funcionamento de todo
36		* o programa.
37		* <PRE>
38		* Exemplo: PrintStream out que desvia a saída padrão de texto.
39		* </PRE>
40		*/
41		@SuppressWarnings("StaticNonFinalUsedInInitialization")
42		public class Util {
43
44		private static final String WEBPHOTOS_USER_CONFIG = "webphotos.xml";
45		/**
46		*
47		*/
48		public static final String WEBPHOTOS_DEFAULT_CONFIG = "webphotos.dat";
49	3	private static Util instancia = new Util();
50		/**
51		* caixa de texto para dar saída ao log
52		*/
53		private static JTextArea saida;
54	3	private static File albunsRoot = null;
55		private static Configuration config;
56		/**
57		* Para desviar a saída padrão de texto (em produção).
58		*/
59		public static PrintStream out;
60		/**
61		* Para desviar a saída padrão de texto (em produção).
62		*/
63		public static PrintStream err;
64		private static final Logger log;
65
66		static {
67	3	out = System.out;
68	3	err = System.err;
69	3	log = Logger.getLogger(Util.class);
70
71	3	DefaultConfigurationBuilder configurationBuilder = new DefaultConfigurationBuilder();
72	3	String userHome = "";
73		try {
74	3	configurationBuilder.setFileName("Configuration.xml");
75	3	CombinedConfiguration auxConfig = configurationBuilder.getConfiguration(true);
76	3	config = auxConfig.interpolatedConfiguration();
77	3	userHome = config.getString("user.home");
78	0	} catch (Exception e) {
79	0	log.error("Can't load preferences");
80	0	log.debug("Stack Trace : ", e);
81	0	System.exit(-1);
82	3	}
83	3	configurationBuilder = new DefaultConfigurationBuilder();
84		try {
85	3	configurationBuilder.setFileName("SavedConfiguration.xml");
86	3	final CombinedConfiguration configuration = configurationBuilder.getConfiguration(true);
87	3	XMLConfiguration savedUserPrefs = new XMLConfiguration();
88	3	savedUserPrefs.append(configuration);
89	3	savedUserPrefs.setEncoding("ISO-8859-1");
90	3	savedUserPrefs.save(new FileOutputStream(userHome + File.separatorChar + WEBPHOTOS_USER_CONFIG));
91	0	} catch (Exception e) {
92	0	log.warn("Can't save preferences");
93	0	log.debug("Stack Trace : ", e);
94	3	}
95	3	}
96
97		/**
98		*
99		* @return
100		*/
101		public static Configuration getConfig() {
102	24	return config;
103		}
104
105	3	private Util() {
106	3	}
107
108		/**
109		* Retorna a instância da própria classe.
110		*
111		* @return Retorna a instância de Util.
112		*/
113		public static Util getInstance() {
114	0	return instancia;
115		}
116
117		/**
118		* Retorna o diretório raiz de albuns. Checa se a variável albunsRoot já
119		* possui o valor, caso não, busca o arquivo nas propriedades através do
120		* método
121		* {@link net.sf.webphotos.util.Util#getProperty(String) getProperty}(String
122		* chave) e faz um teste para checar se é um diretório mesmo. Caso tudo
123		* esteja correto, retorna o diretório.
124		*
125		* @return Retorna um diretório.
126		*/
127		public static File getAlbunsRoot() {
128	0	if (albunsRoot == null) {
129	0	albunsRoot = new File(getProperty("albunsRoot"));
130	0	if (!albunsRoot.isDirectory()) {
131	0	StringBuilder errMsg = new StringBuilder();
132	0	errMsg.append("O diretório fornecido no parâmetro albunsRoot (arquivo de configuração)\n");
133	0	errMsg.append("não pode ser utilizado, ou não existe.\n");
134	0	errMsg.append("O programa será encerrado.");
135	0	JOptionPane.showMessageDialog(null, errMsg.toString(), "Erro no arquivo de configuração", JOptionPane.ERROR_MESSAGE);
136		//throw new RuntimeException(errMsg.toString());
137	0	System.exit(-1);
138		}
139		}
140	0	return albunsRoot;
141		}
142
143		/**
144		* Retorna o diretório raiz de albuns. Checa se a variável albunsRoot já
145		* possui o valor, caso não, busca o arquivo nas propriedades através do
146		* método
147		* {@link net.sf.webphotos.util.Util#getProperty(String) getProperty}(String
148		* chave) e faz um teste para checar se é um diretório mesmo. Caso tudo
149		* esteja correto, retorna o diretório.
150		*
151		* @return Retorna um diretório.
152		*/
153		public static File getFolder(String param) {
154	0	File folder = new File(getProperty(param));
155	0	if (!folder.isDirectory()) {
156	0	StringBuilder errMsg = new StringBuilder();
157	0	errMsg.append("O diretório fornecido no parâmetro albunsRoot (arquivo de configuração)\n");
158	0	errMsg.append("não pode ser utilizado, ou não existe.\n");
159	0	errMsg.append("O programa será encerrado.");
160	0	JOptionPane.showMessageDialog(null, errMsg.toString(), "Erro no arquivo de configuração", JOptionPane.ERROR_MESSAGE);
161		//throw new RuntimeException(errMsg.toString());
162	0	System.exit(-1);
163		}
164	0	return folder;
165		}
166
167		/**
168		* Trabalha o texto recebido para impressão do log. Se existir algum erro
169		* contido no texto, separa o erro e imprime separado do resto da saída.
170		* TODO: enviar o log para arquivo e um componente swing. Eliminar esse
171		* método com o Log4J ou semelhante.
172		*
173		* @param texto Texto para impressão.
174		*/
175		public static void log(String texto) {
176	69	if (texto == null) {
177	0	saida = null;
178		}
179	69	if (saida == null) {
180	69	log.info("LOG: " + texto);
181		} else {
182	0	if (texto.startsWith("[")) {
183	0	Util.err.println(texto);
184	0	texto = texto.substring(texto.indexOf('/') + 1);
185		}
186	0	saida.append(texto);
187	0	saida.append("\n");
188	0	saida.setCaretPosition(saida.getText().length() - 1);
189		}
190	69	}
191
192		/**
193		* Retorna uma String que substitui alguns caracteres especiais em Java
194		* pelos do formato HTM.
195		*
196		* @param valor Texto a ser formatado.
197		* @return Retorna texto formatado em HTM.
198		*/
199		public static String stringToHtm(String valor) {
200	0	valor = valor.replaceAll("\n", "<br>");
201	0	valor = valor.replaceAll("\"", """);
202	0	valor = valor.replaceAll("\'", """);
203	0	return "\'" + valor + "\'";
204		}
205
206		/**
207		* Recebe um textarea e seta esse valor na variável saida.
208		*
209		* @param saidaGUI textarea para indicar a saída.
210		*/
211		public static void setLoggingTextArea(JTextArea saidaGUI) {
212	0	saida = saidaGUI;
213	0	}
214
215		/**
216		* Retorna uma String contendo a propriedade. Testa se é necessário carregar
217		* o arquivo de propriedades, então busca a propriedade no arquivo através
218		* da variável passada como parâmetro.
219		*
220		* @param chave Propriedade.
221		* @return Retorna o valor da propriedade.
222		*/
223		public static String getProperty(String chave) {
224		try {
225	0	return (config.getString(chave) == null \|\| config.getString(chave).isEmpty()) ? null : config.getString(chave);
226	0	} catch (Exception e) {
227	0	log.error("Error trying to get a property", e);
228	0	return null;
229		}
230		}
231
232		/**
233		* Ajusta a largura das colunas do modelo.
234		*
235		* @param tabela Tabela que deseja ajustar as colunas.
236		* @param parametros Tamanhos das colunas separadas por vírgula.
237		*/
238		public static void ajustaLargura(JTable tabela, String parametros) {
239	0	int temR = -1;
240	0	TableColumnModel modeloColunas = tabela.getColumnModel();
241	0	if (parametros == null) {
242	0	return;
243		}
244	0	if (parametros.length() > 0) {
245	0	StringTokenizer tok = new StringTokenizer(parametros, ",");
246	0	int ct = 0;
247		String l;
248	0	while (tok.hasMoreTokens()) {
249	0	l = tok.nextToken();
250		try {
251	0	modeloColunas.getColumn(ct).setPreferredWidth(Integer.parseInt(l));
252	0	} catch (NumberFormatException nE) {
253	0	if (l.equals("*")) {
254	0	log.info("Packing column " + ct);
255	0	packColumn(tabela, ct, 1);
256	0	} else if (l.equals("R")) {
257	0	temR = ct;
258		}
259	0	} catch (Exception e) {
260	0	}
261	0	ct++;
262		}
263
264	0	if (temR > 0) {
265	0	modeloColunas.getColumn(temR).setPreferredWidth(modeloColunas.getColumn(temR).getPreferredWidth() + tabela.getWidth() - modeloColunas.getTotalColumnWidth());
266	0	log.debug("Tamanho da tabela: " + (modeloColunas.getColumn(temR).getPreferredWidth() + tabela.getWidth() - modeloColunas.getTotalColumnWidth()));
267		}
268
269		//Testes
270	0	log.debug("Tamanho Total: " + modeloColunas.getTotalColumnWidth());
271	0	log.debug("Tamanho da tabela: " + tabela.getWidth());
272		}
273	0	}
274
275		/**
276		* PackColumn sets the preferred width of the visible column specified by
277		* vColIndex. The column will be just wide enough to show the column head
278		* and the widest cell in the column. margin pixels are added to the left
279		* and right (resulting in an additional width of 2*margin pixels).
280		*
281		* @param table The table you want to resize a column.
282		* @param vColIndex The column number.
283		* @param margin Extra spaces for each side of column.
284		*/
285		public static void packColumn(JTable table, int vColIndex, int margin) {
286	0	DefaultTableColumnModel colModel = (DefaultTableColumnModel) table.getColumnModel();
287	0	TableColumn col = colModel.getColumn(vColIndex);
288		int width;
289
290		// Get width of column header
291	0	javax.swing.table.TableCellRenderer renderer = col.getHeaderRenderer();
292	0	if (renderer == null) {
293	0	renderer = table.getTableHeader().getDefaultRenderer();
294		}
295	0	java.awt.Component comp = renderer.getTableCellRendererComponent(
296		table, col.getHeaderValue(), false, false, 0, 0);
297	0	width = comp.getPreferredSize().width;
298
299		// Get maximum width of column data
300	0	for (int r = 0; r < table.getRowCount(); r++) {
301	0	renderer = table.getCellRenderer(r, vColIndex);
302	0	comp = renderer.getTableCellRendererComponent(
303		table, table.getValueAt(r, vColIndex), false, false, r, vColIndex);
304	0	width = Math.max(width, comp.getPreferredSize().width);
305		}
306
307		// Add margin
308	0	width += 2 * margin;
309
310		// Set the width
311	0	col.setPreferredWidth(width);
312	0	}
313
314		@Override
315		public Object clone() throws CloneNotSupportedException {
316	0	throw new CloneNotSupportedException("Singleton Object");
317		}
318
319		/**
320		*
321		*/
322		public static void loadSocksProxy() {
323	0	String socksHost = getConfig().getString("socks.host");
324	0	int socksPort = 0;
325	0	if (getConfig().containsKey("socks.port")) {
326	0	socksPort = getConfig().getInt("socks.port");
327		}
328		//Prepara as conexões para usar Socks Proxy (se configurado)
329	0	if (socksHost != null && !socksHost.isEmpty()) {
330	0	System.getProperties().put("socksProxyHost", socksHost);
331	0	if (socksPort > 0 && socksPort < 65534) {
332	0	System.getProperties().put("socksProxyPort", socksPort);
333		}
334		}
335	0	}
336		}