Merge branch 'alpha/origin_2022_JAL-3066_Jalview_212_slivka-integration' into spike...
[jalview.git] / src / jalview / util / HttpUtils.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.util;
22
23 import java.io.BufferedInputStream;
24 import java.io.File;
25 import java.io.FileOutputStream;
26 import java.io.IOException;
27 import java.io.InputStream;
28 import java.net.HttpURLConnection;
29 import java.net.ProtocolException;
30 import java.net.URL;
31 import java.util.List;
32
33 import javax.ws.rs.HttpMethod;
34
35 public class HttpUtils
36 {
37
38   /**
39    * Returns true if it is possible to open an input stream at the given URL,
40    * else false. The input stream is closed.
41    * 
42    * @param url
43    * @return
44    */
45   public static boolean isValidUrl(String url)
46   {
47     InputStream is = null;
48     try
49     {
50       is = new URL(url).openStream();
51       if (is != null)
52       {
53         return true;
54       }
55     } catch (IOException x)
56     {
57       // MalformedURLException, FileNotFoundException
58       return false;
59     } finally
60     {
61       if (is != null)
62       {
63         try
64         {
65           is.close();
66         } catch (IOException e)
67         {
68           // ignore
69         }
70       }
71     }
72     return false;
73   }
74   public static boolean startsWithHttpOrHttps(String file)
75   {
76     return file.startsWith("http://") || file.startsWith("https://");
77   }
78   
79   /**
80    * wrapper to get/post to a URL or check headers
81    * @param url
82    * @param ids
83    * @param readTimeout
84    * @return
85    * @throws IOException
86    * @throws ProtocolException
87    */
88   public static boolean checkUrlAvailable(URL url,
89           int readTimeout) throws IOException, ProtocolException
90   {
91     // System.out.println(System.currentTimeMillis() + " " + url);
92
93     HttpURLConnection connection = (HttpURLConnection) url.openConnection();
94
95     connection.setRequestMethod(HttpMethod.HEAD);
96
97     connection.setDoInput(true);
98
99     connection.setUseCaches(false);
100     connection.setConnectTimeout(300);
101     connection.setReadTimeout(readTimeout);
102     return connection.getResponseCode() == 200;
103   }
104
105   /**
106    * download from given URL and return a pointer to temporary file
107    */
108   public static File fetchURLToTemp(String url) throws OutOfMemoryError,
109           IOException
110   {
111     long time = System.currentTimeMillis();
112     URL rcall = new URL(url);
113
114     InputStream is = new BufferedInputStream(rcall.openStream());
115     File outFile = null;
116     try
117     {
118       outFile = File.createTempFile("jalview", ".xml");
119       outFile.deleteOnExit();
120       if (outFile.length() == 0)
121       {
122         outFile.delete();
123         return null;
124       }
125     } catch (Exception ex)
126     {
127     }
128
129     if (outFile != null)
130     {
131       FileOutputStream fio = new FileOutputStream(outFile);
132       byte[] bb = new byte[32 * 1024];
133       int l;
134       while ((l = is.read(bb)) > 0)
135       {
136         fio.write(bb, 0, l);
137       }
138       fio.close();
139       is.close();
140       return outFile;
141     }
142     else
143     {
144       return null;
145     }
146   }
147 }