a44b9b972df8a6a1dc0388dfc017306d5d77cf9e
[jalview.git] / IdentifiersUrlProvider.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
22 package jalview.urls;
23
24 import static jalview.util.UrlConstants.DB_ACCESSION;
25 import static jalview.util.UrlConstants.DELIM;
26 import static jalview.util.UrlConstants.SEP;
27
28 import jalview.util.JSONUtils;
29 import jalview.util.UrlLink;
30
31 import java.io.FileReader;
32 import java.io.IOException;
33 import java.util.ArrayList;
34 import java.util.HashMap;
35 import java.util.Iterator;
36 import java.util.List;
37 import java.util.Map;
38 import java.util.StringTokenizer;
39
40 import org.json.simple.parser.ParseException;
41
42 /**
43  * 
44  * Implements the UrlProviderI interface for a UrlProvider object which serves
45  * URLs from identifiers.org
46  * 
47  * @author $author$
48  * @version $Revision$
49  */
50 public class IdentifiersUrlProvider extends UrlProviderImpl
51 {
52
53   private static final String LOCAL_KEY = "Local";
54
55   private static final String ID_ORG_KEY = "identifiers.org";
56
57   // map of string ids to urls
58   private HashMap<String, UrlLink> urls;
59
60   // list of selected urls
61   private ArrayList<String> selectedUrls;
62
63   public IdentifiersUrlProvider(String cachedUrlList)
64   {
65     urls = readIdentifiers(IdOrgSettings.getDownloadLocation());
66     selectedUrls = new ArrayList<>();
67     checkSelectionMatchesUrls(cachedUrlList);
68   }
69
70   /**
71    * Read data from an identifiers.org download file
72    * 
73    * @param idFileName
74    *          name of identifiers.org download file
75    * @return hashmap of identifiers.org data, keyed by MIRIAM id
76    */
77   @SuppressWarnings("unchecked")
78 private HashMap<String, UrlLink> readIdentifiers(String idFileName)
79   {
80     // identifiers.org data
81     HashMap<String, UrlLink> idData = new HashMap<>();
82
83     String errorMessage = null;
84     try
85     {
86         // NOTE: THIS WILL FAIL IN SWINGJS BECAUSE IT INVOLVES A FILE READER
87     
88       System.out.println("IDentifiersURL " + idFileName);
89       FileReader reader = new FileReader(idFileName);
90       String key = "";
91       Map<String, Object> obj = (Map<String, Object>) JSONUtils.parse(reader);
92       if (obj.containsKey(ID_ORG_KEY))
93       {
94         key = ID_ORG_KEY;
95       }
96       else if (obj.containsKey(LOCAL_KEY))
97       {
98         key = LOCAL_KEY;
99       }
100       else
101       {
102         System.out.println(
103                 "Unexpected key returned from identifiers jalview service");
104         return idData;
105       }
106
107       List<Object> jsonarray = (List<Object>) obj.get(key);
108
109       // loop over each entry in JSON array and build HashMap entry
110       for (int i = 0; i < jsonarray.size(); i++)
111       {
112         Map<String, Object> item = (Map<String, Object>) jsonarray.get(i);
113
114         String url = (String) item.get("url") + "/" + DELIM + DB_ACCESSION
115                 + DELIM;
116         UrlLink link = new UrlLink((String) item.get("name"), url,
117                 (String) item.get("prefix"));
118         idData.put((String) item.get("id"), link);
119       }
120     } catch (IOException | ParseException e)
121     {
122       // unnecessary 
123       e.printStackTrace();
124       // Note how in JavaScript we can grab the first bytes from any file reader. 
125       // Typical report here is "NetworkError" because the file does not exist.
126       // "https://." is coming from System.getProperty("user.home"), but this could
127       // be set by the page developer to anything, of course.
128       errorMessage = e.toString();
129       idData.clear();
130     }
131     // BH 2018 -- added more valuable report
132     if (errorMessage != null)
133     {
134       System.err.println("IdentifiersUrlProvider: cannot read " + idFileName + ": " + errorMessage);
135     }
136     return idData;
137   }
138
139   private void checkSelectionMatchesUrls(String cachedUrlList)
140   {
141     StringTokenizer st = new StringTokenizer(cachedUrlList, SEP);
142     while (st.hasMoreElements())
143     {
144       String id = st.nextToken();
145
146       if (isMiriamId(id))
147       {
148         // this is an identifiers.org MIRIAM id
149         if (urls.containsKey(id))
150         {
151           selectedUrls.add(id);
152         }
153       }
154     }
155
156     // reset defaultUrl in case it is no longer selected
157     setPrimaryUrl(primaryUrl);
158   }
159
160   @Override
161   public boolean setPrimaryUrl(String id)
162   {
163     if (urls.containsKey(id))
164     {
165       primaryUrl = id;
166     }
167     else
168     {
169       primaryUrl = null;
170     }
171
172     return urls.containsKey(id);
173   }
174
175   @Override
176   public String writeUrlsAsString(boolean selected)
177   {
178     if (!selected)
179     {
180       return ""; // we don't cache unselected identifiers.org urls
181     }
182
183     StringBuffer links = new StringBuffer();
184     if (!selectedUrls.isEmpty())
185     {
186       for (String k : selectedUrls)
187       {
188         links.append(k);
189         links.append(SEP);
190       }
191       // remove last SEP
192       links.setLength(links.length() - 1);
193     }
194     return links.toString();
195   }
196
197   @Override
198   public List<String> getLinksForMenu()
199   {
200     List<String> links = new ArrayList<>();
201     for (String key : selectedUrls)
202     {
203       links.add(urls.get(key).toStringWithTarget());
204     }
205     return links;
206   }
207
208   @Override
209   public List<UrlLinkDisplay> getLinksForTable()
210   {
211     return super.getLinksForTable(urls, selectedUrls, false);
212   }
213
214   @Override
215   public void setUrlData(List<UrlLinkDisplay> links)
216   {
217     selectedUrls = new ArrayList<>();
218
219     Iterator<UrlLinkDisplay> it = links.iterator();
220     while (it.hasNext())
221     {
222       UrlLinkDisplay link = it.next();
223
224       // Handle links with MIRIAM ids only
225       if (isMiriamId(link.getId()))
226       {
227         // select/deselect links accordingly and set default url
228         if (urls.containsKey(link.getId()))
229         {
230           if (link.getIsSelected())
231           {
232             selectedUrls.add(link.getId());
233           }
234           if (link.getIsPrimary())
235           {
236             setPrimaryUrl(link.getId());
237           }
238         }
239       }
240     }
241   }
242
243   @Override
244   public String getPrimaryUrl(String seqid)
245   {
246     return super.getPrimaryUrl(seqid, urls);
247   }
248
249   @Override
250   public String getPrimaryUrlId()
251   {
252     return primaryUrl;
253   }
254
255   @Override
256   public String getPrimaryTarget(String seqid)
257   {
258     return null;
259   }
260
261   @Override
262   public String choosePrimaryUrl()
263   {
264     return null;
265   }
266
267   @Override
268   public boolean contains(String id)
269   {
270     return (urls.containsKey(id));
271   }
272 }