001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.plugins;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.io.File;
007import java.io.FileInputStream;
008import java.io.FilenameFilter;
009import java.io.IOException;
010import java.util.ArrayList;
011import java.util.Collection;
012import java.util.HashMap;
013import java.util.List;
014import java.util.Map;
015
016import org.openstreetmap.josm.Main;
017import org.openstreetmap.josm.gui.PleaseWaitRunnable;
018import org.openstreetmap.josm.gui.progress.ProgressMonitor;
019import org.openstreetmap.josm.io.OsmTransferException;
020import org.openstreetmap.josm.tools.ImageProvider;
021import org.xml.sax.SAXException;
022
023/**
024 * This is an asynchronous task for reading plugin information from the files
025 * in the local plugin repositories.
026 *
027 * It scans the files in the local plugins repository (see {@link org.openstreetmap.josm.data.Preferences#getPluginsDirectory()}
028 * and extracts plugin information from three kind of files:
029 * <ul>
030 *   <li>.jar files, assuming that they represent plugin jars</li>
031 *   <li>.jar.new files, assuming that these are downloaded but not yet installed plugins</li>
032 *   <li>cached lists of available plugins, downloaded for instance from
033 *   <a href="https://josm.openstreetmap.de/pluginicons">https://josm.openstreetmap.de/pluginicons</a></li>
034 * </ul>
035 *
036 */
037public class ReadLocalPluginInformationTask extends PleaseWaitRunnable {
038    private Map<String, PluginInformation> availablePlugins;
039    private boolean canceled;
040
041    /**
042     * Constructs a new {@code ReadLocalPluginInformationTask}.
043     */
044    public ReadLocalPluginInformationTask() {
045        super(tr("Reading local plugin information.."), false);
046        availablePlugins = new HashMap<>();
047    }
048
049    public ReadLocalPluginInformationTask(ProgressMonitor monitor) {
050        super(tr("Reading local plugin information.."),monitor, false);
051        availablePlugins = new HashMap<>();
052    }
053
054    @Override
055    protected void cancel() {
056        canceled = true;
057    }
058
059    @Override
060    protected void finish() {}
061
062    protected void processJarFile(File f, String pluginName) throws PluginException{
063        PluginInformation info = new PluginInformation(
064                f,
065                pluginName
066        );
067        if (!availablePlugins.containsKey(info.getName())) {
068            info.updateLocalInfo(info);
069            availablePlugins.put(info.getName(), info);
070        } else {
071            PluginInformation current = availablePlugins.get(info.getName());
072            current.updateFromJar(info);
073        }
074    }
075
076    private File[] listFiles(File pluginsDirectory, final String regex) {
077        return pluginsDirectory.listFiles(
078                new FilenameFilter() {
079                    @Override
080                    public boolean accept(File dir, String name) {
081                        return name.matches(regex);
082                    }
083                }
084        );
085    }
086
087    protected void scanSiteCacheFiles(ProgressMonitor monitor, File pluginsDirectory) {
088        File[] siteCacheFiles = listFiles(pluginsDirectory, "^([0-9]+-)?site.*\\.txt$");
089        if (siteCacheFiles == null || siteCacheFiles.length == 0)
090            return;
091        monitor.subTask(tr("Processing plugin site cache files..."));
092        monitor.setTicksCount(siteCacheFiles.length);
093        for (File f: siteCacheFiles) {
094            String fname = f.getName();
095            monitor.setCustomText(tr("Processing file ''{0}''", fname));
096            try {
097                processLocalPluginInformationFile(f);
098            } catch(PluginListParseException e) {
099                Main.warn(tr("Failed to scan file ''{0}'' for plugin information. Skipping.", fname));
100                Main.error(e);
101            }
102            monitor.worked(1);
103        }
104    }
105
106    protected void scanPluginFiles(ProgressMonitor monitor, File pluginsDirectory) {
107        File[] pluginFiles = pluginsDirectory.listFiles(
108                new FilenameFilter() {
109                    @Override
110                    public boolean accept(File dir, String name) {
111                        return name.endsWith(".jar") || name.endsWith(".jar.new");
112                    }
113                }
114        );
115        if (pluginFiles == null || pluginFiles.length == 0)
116            return;
117        monitor.subTask(tr("Processing plugin files..."));
118        monitor.setTicksCount(pluginFiles.length);
119        for (File f: pluginFiles) {
120            String fname = f.getName();
121            monitor.setCustomText(tr("Processing file ''{0}''", fname));
122            try {
123                if (fname.endsWith(".jar")) {
124                    String pluginName = fname.substring(0, fname.length() - 4);
125                    processJarFile(f, pluginName);
126                } else if (fname.endsWith(".jar.new")) {
127                    String pluginName = fname.substring(0, fname.length() - 8);
128                    processJarFile(f, pluginName);
129                }
130            } catch (PluginException e){
131                Main.warn("PluginException: "+e.getMessage());
132                Main.warn(tr("Failed to scan file ''{0}'' for plugin information. Skipping.", fname));
133            }
134            monitor.worked(1);
135        }
136    }
137
138    protected void scanLocalPluginRepository(ProgressMonitor monitor, File pluginsDirectory) {
139        if (pluginsDirectory == null) return;
140        try {
141            monitor.beginTask("");
142            scanSiteCacheFiles(monitor, pluginsDirectory);
143            scanPluginFiles(monitor, pluginsDirectory);
144        } finally {
145            monitor.setCustomText("");
146            monitor.finishTask();
147        }
148    }
149
150    protected void processLocalPluginInformationFile(File file) throws PluginListParseException{
151        try (FileInputStream fin = new FileInputStream(file)) {
152            List<PluginInformation> pis = new PluginListParser().parse(fin);
153            for (PluginInformation pi : pis) {
154                // we always keep plugin information from a plugin site because it
155                // includes information not available in the plugin jars Manifest, i.e.
156                // the download link or localized descriptions
157                //
158                availablePlugins.put(pi.name, pi);
159            }
160        } catch(IOException e) {
161            throw new PluginListParseException(e);
162        }
163    }
164
165    protected void analyseInProcessPlugins() {
166        for (PluginProxy proxy : PluginHandler.pluginList) {
167            PluginInformation info = proxy.getPluginInformation();
168            if (canceled)return;
169            if (!availablePlugins.containsKey(info.name)) {
170                availablePlugins.put(info.name, info);
171            } else {
172                availablePlugins.get(info.name).localversion = info.localversion;
173            }
174        }
175    }
176
177    protected void filterOldPlugins() {
178        for (PluginHandler.DeprecatedPlugin p : PluginHandler.DEPRECATED_PLUGINS) {
179            if (canceled)return;
180            if (availablePlugins.containsKey(p.name)) {
181                availablePlugins.remove(p.name);
182            }
183        }
184    }
185
186    @Override
187    protected void realRun() throws SAXException, IOException, OsmTransferException {
188        Collection<String> pluginLocations = PluginInformation.getPluginLocations();
189        getProgressMonitor().setTicksCount(pluginLocations.size() + 2);
190        if (canceled) return;
191        for (String location : pluginLocations) {
192            scanLocalPluginRepository(
193                    getProgressMonitor().createSubTaskMonitor(1, false),
194                    new File(location)
195            );
196            getProgressMonitor().worked(1);
197            if (canceled)return;
198        }
199        analyseInProcessPlugins();
200        getProgressMonitor().worked(1);
201        if (canceled)return;
202        filterOldPlugins();
203        getProgressMonitor().worked(1);
204    }
205
206    /**
207     * Replies information about available plugins detected by this task.
208     *
209     * @return information about available plugins detected by this task.
210     */
211    public List<PluginInformation> getAvailablePlugins() {
212        return new ArrayList<>(availablePlugins.values());
213    }
214
215    /**
216     * Replies true if the task was canceled by the user
217     *
218     * @return true if the task was canceled by the user
219     */
220    public boolean isCanceled() {
221        return canceled;
222    }
223}