/* * Copyright (C) 2010 Google Inc. * * 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 com.google.doclava; import com.google.clearsilver.jsilver.JSilver; import com.google.clearsilver.jsilver.data.Data; import java.io.BufferedWriter; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStreamWriter; import java.io.Writer; import java.util.ArrayList; import java.util.List; import java.util.Arrays; public class ClearPage { /* * public ClearPage() { String templ = "templates/index.cs"; String filename = "docs/index.html"; * * data.setValue("A.B.C", "1"); data.setValue("A.B.D", "2"); } */ private static ArrayList mTemplateDirs = new ArrayList(); private static boolean mTemplateDirSet = false; private static ArrayList mBundledTemplateDirs = new ArrayList(); public static String outputDir = "docs"; public static List htmlDirs = new ArrayList(); public static String toroot = null; public static void addTemplateDir(String dir) { mTemplateDirSet = true; mTemplateDirs.add(dir); } public static List getTemplateDirs() { return mTemplateDirs; } public static void addBundledTemplateDir(String dir) { mTemplateDirSet = true; mBundledTemplateDirs.add(dir); } public static List getBundledTemplateDirs() { return mBundledTemplateDirs; } private static int countSlashes(String s) { final int N = s.length(); int slashcount = 0; for (int i = 0; i < N; i++) { if (s.charAt(i) == '/') { slashcount++; } } return slashcount; } public static void write(Data data, String templ, String filename, JSilver cs) { write(data, templ, filename, false, cs); } public static void write(Data data, String templ, String filename) { write(data, templ, filename, false, Doclava.jSilver); } public static void write(Data data, String templ, String filename, boolean fullPath) { write(data, templ, filename, false, Doclava.jSilver); } public static void write(Data data, String templ, String filename, boolean fullPath, JSilver cs) { if (!htmlDirs.isEmpty()) { data.setValue("hasindex", "true"); } String toroot; if (ClearPage.toroot != null) { toroot = ClearPage.toroot; } else { int slashcount = countSlashes(filename); if (slashcount > 0) { toroot = ""; for (int i = 0; i < slashcount; i++) { toroot += "../"; } } else { toroot = "./"; } } data.setValue("toroot", toroot); if (Doclava.USE_UPDATED_TEMPLATES) { data.setValue("useUpdatedTemplates", "true"); } data.setValue("filename", filename); if (!fullPath) { filename = outputDir + "/" + filename; } int i = 0; if (!htmlDirs.isEmpty()) { for (String dir : htmlDirs) { data.setValue("hdf.loadpaths." + i, dir); i++; } } if (mTemplateDirSet) { for (String dir : mTemplateDirs) { data.setValue("hdf.loadpaths." + i, dir); i++; } } else { data.setValue("hdf.loadpaths." + i, "templates"); } File file = new File(outputFilename(filename)); ensureDirectory(file); Writer stream = null; try { stream = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), "UTF-8")); String rendered = cs.render(templ, data); stream.write(rendered, 0, rendered.length()); } catch (IOException e) { System.out.println("error: " + e.getMessage() + "; when writing file: " + filename); } finally { if (stream != null) { try { stream.close(); } catch (IOException e) {} } } } // recursively create the directories to the output public static void ensureDirectory(File f) { File parent = f.getParentFile(); if (parent != null) { parent.mkdirs(); } } public static void copyFile(boolean allowExcepted, File from, String toPath, Boolean append) { File to = new File(outputDir + "/" + toPath); FileInputStream in; FileOutputStream out; try { if (!from.exists()) { throw new IOException(); } in = new FileInputStream(from); } catch (IOException e) { System.err.println(from.getAbsolutePath() + ": Error opening file"); return; } ensureDirectory(to); try { out = new FileOutputStream(to, append); } catch (IOException e) { System.err.println(to.getAbsolutePath() + ": Error opening file"); return; } if (!isValidContentType(allowExcepted, toPath, DROIDDOC_VALID_CONTENT_TYPES)) { Errors.error(Errors.INVALID_CONTENT_TYPE, null, "Failed to process " + from + ": Invalid file type. Please move the file to frameworks/base/docs/image_sources/... or docs/downloads/..."); return; } long sizel = from.length(); final int maxsize = 64 * 1024; int size = sizel > maxsize ? maxsize : (int) sizel; byte[] buf = new byte[size]; while (true) { try { size = in.read(buf); } catch (IOException e) { System.err.println(from.getAbsolutePath() + ": error reading file"); break; } if (size > 0) { try { out.write(buf, 0, size); } catch (IOException e) { System.err.println(from.getAbsolutePath() + ": error writing file"); } } else { break; } } try { in.close(); } catch (IOException e) {} try { out.close(); } catch (IOException e) {} } /** Takes a string that ends w/ .html and changes the .html to htmlExtension */ public static String outputFilename(String htmlFile) { if (!Doclava.htmlExtension.equals(".html") && htmlFile.endsWith(".html")) { return htmlFile.substring(0, htmlFile.length() - 5) + Doclava.htmlExtension; } else { return htmlFile; } } public static ArrayList DROIDDOC_VALID_CONTENT_TYPES = new ArrayList(Arrays.asList(".txt", ".css", ".js", ".html", ".ico", ".png", ".jpg", ".gif", ".svg", ".webm", ".ogv","mp4", ".java", ".xml", ".aidl", ".rs",".zip", ".yaml")); /* Setting excepted types to allow everything. Leaving it this way in in case we want to explicitly * specify file types later. This adds unneeded checking though since it lets everything through */ public static ArrayList DROIDDOC_EXCEPTED_CONTENT_TYPES = new ArrayList(Arrays.asList("")); public static boolean isValidContentType(boolean allowExcepted, String s, ArrayList list) { if(allowExcepted){ list.addAll(DROIDDOC_EXCEPTED_CONTENT_TYPES); } for (String t : list) { if (s.endsWith(t)) { return true; } } return false; } }