• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2010 Google Inc.
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 
17 package com.google.doclava;
18 
19 import com.google.clearsilver.jsilver.JSilver;
20 import com.google.clearsilver.jsilver.data.Data;
21 
22 import java.io.BufferedWriter;
23 import java.io.File;
24 import java.io.FileInputStream;
25 import java.io.FileOutputStream;
26 import java.io.IOException;
27 import java.io.OutputStreamWriter;
28 import java.io.Writer;
29 import java.util.ArrayList;
30 import java.util.List;
31 import java.util.Arrays;
32 
33 public class ClearPage {
34   /*
35    * public ClearPage() { String templ = "templates/index.cs"; String filename = "docs/index.html";
36    *
37    * data.setValue("A.B.C", "1"); data.setValue("A.B.D", "2"); }
38    */
39 
40   private static ArrayList<String> mTemplateDirs = new ArrayList<String>();
41   private static boolean mTemplateDirSet = false;
42 
43   private static ArrayList<String> mBundledTemplateDirs = new ArrayList<String>();
44 
45   public static String outputDir = "docs";
46   public static List<String> htmlDirs = new ArrayList<String>();
47   public static String toroot = null;
48 
addTemplateDir(String dir)49   public static void addTemplateDir(String dir) {
50     mTemplateDirSet = true;
51     mTemplateDirs.add(dir);
52   }
53 
getTemplateDirs()54   public static List<String> getTemplateDirs() {
55     return mTemplateDirs;
56   }
57 
addBundledTemplateDir(String dir)58   public static void addBundledTemplateDir(String dir) {
59     mTemplateDirSet = true;
60     mBundledTemplateDirs.add(dir);
61   }
62 
getBundledTemplateDirs()63   public static List<String> getBundledTemplateDirs() {
64     return mBundledTemplateDirs;
65   }
66 
countSlashes(String s)67   private static int countSlashes(String s) {
68     final int N = s.length();
69     int slashcount = 0;
70     for (int i = 0; i < N; i++) {
71       if (s.charAt(i) == '/') {
72         slashcount++;
73       }
74     }
75     return slashcount;
76   }
77 
write(Data data, String templ, String filename, JSilver cs)78   public static void write(Data data, String templ, String filename, JSilver cs) {
79     write(data, templ, filename, false, cs);
80   }
81 
write(Data data, String templ, String filename)82   public static void write(Data data, String templ, String filename) {
83     write(data, templ, filename, false, Doclava.jSilver);
84   }
85 
write(Data data, String templ, String filename, boolean fullPath)86   public static void write(Data data, String templ, String filename, boolean fullPath) {
87     write(data, templ, filename, false, Doclava.jSilver);
88   }
89 
write(Data data, String templ, String filename, boolean fullPath, JSilver cs)90   public static void write(Data data, String templ, String filename, boolean fullPath, JSilver cs) {
91     if (!htmlDirs.isEmpty()) {
92       data.setValue("hasindex", "true");
93     }
94 
95     String toroot;
96     if (ClearPage.toroot != null) {
97       toroot = ClearPage.toroot;
98     } else {
99       int slashcount = countSlashes(filename);
100       if (slashcount > 0) {
101         toroot = "";
102         for (int i = 0; i < slashcount; i++) {
103           toroot += "../";
104         }
105       } else {
106         toroot = "./";
107       }
108     }
109     data.setValue("toroot", toroot);
110     data.setValue("filename", filename);
111 
112     if (!fullPath) {
113       filename = outputDir + "/" + filename;
114     }
115 
116     int i = 0;
117     if (!htmlDirs.isEmpty()) {
118         for (String dir : htmlDirs) {
119           data.setValue("hdf.loadpaths." + i, dir);
120           i++;
121         }
122     }
123     if (mTemplateDirSet) {
124       for (String dir : mTemplateDirs) {
125         data.setValue("hdf.loadpaths." + i, dir);
126         i++;
127       }
128     } else {
129       data.setValue("hdf.loadpaths." + i, "templates");
130     }
131 
132     File file = new File(outputFilename(filename));
133 
134     ensureDirectory(file);
135     Writer stream = null;
136     try {
137       stream = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), "UTF-8"));
138       String rendered = cs.render(templ, data);
139       stream.write(rendered, 0, rendered.length());
140     } catch (IOException e) {
141       System.out.println("error: " + e.getMessage() + "; when writing file: " + filename);
142     } finally {
143       if (stream != null) {
144         try {
145           stream.close();
146         } catch (IOException e) {}
147       }
148     }
149   }
150 
151   // recursively create the directories to the output
ensureDirectory(File f)152   public static void ensureDirectory(File f) {
153     File parent = f.getParentFile();
154     if (parent != null) {
155       parent.mkdirs();
156     }
157   }
158 
copyFile(boolean allowExcepted, File from, String toPath, Boolean append)159   public static void copyFile(boolean allowExcepted, File from, String toPath, Boolean append) {
160     File to = new File(outputDir + "/" + toPath);
161     FileInputStream in;
162     FileOutputStream out;
163     try {
164       if (!from.exists()) {
165         throw new IOException();
166       }
167       in = new FileInputStream(from);
168     } catch (IOException e) {
169       System.err.println(from.getAbsolutePath() + ": Error opening file");
170       return;
171     }
172     ensureDirectory(to);
173     try {
174       out = new FileOutputStream(to, append);
175     } catch (IOException e) {
176       System.err.println(to.getAbsolutePath() + ": Error opening file");
177       return;
178     }
179     if (!isValidContentType(allowExcepted, toPath, DROIDDOC_VALID_CONTENT_TYPES)) {
180       Errors.error(Errors.INVALID_CONTENT_TYPE, (SourcePositionInfo) null, "Failed to process "
181           + from + ": Invalid file type. Please move the file to "
182           + "frameworks/base/docs/image_sources/... or docs/downloads/...");
183       return;
184     }
185 
186     long sizel = from.length();
187     final int maxsize = 64 * 1024;
188     int size = sizel > maxsize ? maxsize : (int) sizel;
189     byte[] buf = new byte[size];
190     while (true) {
191       try {
192         size = in.read(buf);
193       } catch (IOException e) {
194         System.err.println(from.getAbsolutePath() + ": error reading file");
195         break;
196       }
197       if (size > 0) {
198         try {
199           out.write(buf, 0, size);
200         } catch (IOException e) {
201           System.err.println(from.getAbsolutePath() + ": error writing file");
202         }
203       } else {
204         break;
205       }
206     }
207     try {
208       in.close();
209     } catch (IOException e) {}
210     try {
211       out.close();
212     } catch (IOException e) {}
213   }
214 
215   /** Takes a string that ends w/ .html and changes the .html to htmlExtension */
outputFilename(String htmlFile)216   public static String outputFilename(String htmlFile) {
217     if (!Doclava.htmlExtension.equals(".html") && htmlFile.endsWith(".html")) {
218       return htmlFile.substring(0, htmlFile.length() - 5) + Doclava.htmlExtension;
219     } else {
220       return htmlFile;
221     }
222   }
223 
224   public static ArrayList<String> DROIDDOC_VALID_CONTENT_TYPES = new ArrayList<String>(Arrays.asList(".txt", ".css",
225     ".js", ".html", ".ico", ".png", ".jpg", ".gif", ".svg", ".webm", ".ogv","mp4", ".java", ".xml", ".aidl", ".rs",".zip", ".yaml"));
226   /* Setting excepted types to allow everything. Leaving it this way in in case we want to explicitly
227    * specify file types later. This adds unneeded checking though since it lets everything through
228    */
229   public static ArrayList<String> DROIDDOC_EXCEPTED_CONTENT_TYPES = new ArrayList<String>(Arrays.asList(""));
230 
isValidContentType(boolean allowExcepted, String s, ArrayList<String> list)231   public static boolean isValidContentType(boolean allowExcepted, String s, ArrayList<String> list) {
232     if(allowExcepted){
233       list.addAll(DROIDDOC_EXCEPTED_CONTENT_TYPES);
234     }
235     for (String t : list) {
236       if (s.endsWith(t)) {
237         return true;
238       }
239     }
240     return false;
241   }
242 }
243