summaryrefslogtreecommitdiff
path: root/src/main/java/com/android/vts/servlet/ShowGcsLogServlet.java
blob: 7921ba664a225b68122ac58bd372fe594c852c94 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/*
 * Copyright (c) 2018 Google Inc. All Rights Reserved.
 *
 * 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.android.vts.servlet;

import com.google.appengine.api.memcache.ErrorHandlers;
import com.google.appengine.api.memcache.MemcacheService;
import com.google.appengine.api.memcache.MemcacheServiceFactory;
import com.google.auth.oauth2.ServiceAccountCredentials;
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.Bucket;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.Storage.BlobListOption;
import com.google.cloud.storage.StorageOptions;
import com.google.gson.Gson;
import org.apache.commons.io.IOUtils;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.*;
import java.util.logging.Level;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

/**
 * A GCS log servlet read log zip file from Google Cloud Storage bucket and show the content in it
 * from the zip file by unarchiving it
 */
@SuppressWarnings("serial")
public class ShowGcsLogServlet extends BaseServlet {

    private static final String GCS_LOG_JSP = "WEB-INF/jsp/show_gcs_log.jsp";

    /** Google Cloud Storage project ID */
    private static final String GCS_PROJECT_ID = System.getProperty("GCS_PROJECT_ID");
    /** Google Cloud Storage project's key file to access the storage */
    private static final String GCS_KEY_FILE = System.getProperty("GCS_KEY_FILE");
    /** Google Cloud Storage project's default bucket name for vtslab log files */
    private static final String GCS_BUCKET_NAME = System.getProperty("GCS_BUCKET_NAME");

    /**
     * This is the key file to access vtslab-gcs project. It will allow the dashboard to have a full
     * control of the bucket.
     */
    private InputStream keyFileInputStream;

    /** This is the instance of java google storage library */
    private Storage storage;

    /** This is the instance of App Engine memcache service java library */
    private MemcacheService syncCache = MemcacheServiceFactory.getMemcacheService();

    @Override
    public void init(ServletConfig cfg) throws ServletException {
        super.init(cfg);
        keyFileInputStream =
                this.getServletContext().getResourceAsStream("/WEB-INF/keys/" + GCS_KEY_FILE);

        if (keyFileInputStream == null) {
            logger.log(Level.SEVERE, "Error GCS key file is not exiting. Check key file!");
        } else {
            try {
                storage =
                        StorageOptions.newBuilder()
                                .setProjectId(GCS_PROJECT_ID)
                                .setCredentials(
                                        ServiceAccountCredentials.fromStream(keyFileInputStream))
                                .build()
                                .getService();
            } catch (IOException e) {
                logger.log(Level.SEVERE, "Error on creating storage instance!");
            }
        }
        syncCache.setErrorHandler(ErrorHandlers.getConsistentLogAndContinue(Level.INFO));
    }

    @Override
    public PageType getNavParentType() {
        return PageType.TOT;
    }

    @Override
    public List<Page> getBreadcrumbLinks(HttpServletRequest request) {
        return null;
    }

    @Override
    public void doGetHandler(HttpServletRequest request, HttpServletResponse response)
            throws IOException {
        if (keyFileInputStream == null) {
            request.setAttribute("error_title", "GCS Key file Error");
            request.setAttribute("error_message", "The GCS Key file is not existed!");
            RequestDispatcher dispatcher = request.getRequestDispatcher(ERROR_MESSAGE_JSP);
            try {
                dispatcher.forward(request, response);
            } catch (ServletException e) {
                logger.log(Level.SEVERE, "Servlet Excpetion caught : ", e);
            }
        } else {

            String action =
                    request.getParameter("action") == null
                            ? "read"
                            : request.getParameter("action");
            String path = request.getParameter("path") == null ? "/" : request.getParameter("path");
            String entry =
                    request.getParameter("entry") == null ? "" : request.getParameter("entry");
            Path pathInfo = Paths.get(path);

            Bucket vtsReportBucket = storage.get(GCS_BUCKET_NAME);

            List<String> dirList = new ArrayList<>();
            List<String> fileList = new ArrayList<>();
            List<String> entryList = new ArrayList<>();
            Map<String, Object> resultMap = new HashMap<>();
            String entryContent = "";

            if (pathInfo.toString().endsWith(".zip")) {

                Blob blobFile = (Blob) this.syncCache.get(path.toString());
                if (blobFile == null) {
                    blobFile = vtsReportBucket.get(path);
                    this.syncCache.put(path.toString(), blobFile);
                }

                if (action.equalsIgnoreCase("read")) {
                    InputStream blobInputStream = new ByteArrayInputStream(blobFile.getContent());
                    ZipInputStream zipInputStream = new ZipInputStream(blobInputStream);

                    ZipEntry zipEntry;
                    while ((zipEntry = zipInputStream.getNextEntry()) != null) {
                        if (zipEntry.isDirectory()) {

                        } else {
                            if (entry.length() > 0) {
                                logger.log(Level.INFO, "param entry => " + entry);
                                if (zipEntry.getName().equals(entry)) {
                                    logger.log(Level.INFO, "matched !!!! " + zipEntry.getName());
                                    entryContent =
                                            IOUtils.toString(
                                                    zipInputStream, StandardCharsets.UTF_8.name());
                                }
                            } else {
                                entryList.add(zipEntry.getName());
                            }
                        }
                    }
                    resultMap.put("entryList", entryList);
                    resultMap.put("entryContent", entryContent);

                    String json = new Gson().toJson(resultMap);
                    response.setContentType("application/json");
                    response.setCharacterEncoding("UTF-8");
                    response.getWriter().write(json);
                } else {
                    response.setContentType("application/octet-stream");
                    response.setContentLength(blobFile.getSize().intValue());
                    response.setHeader(
                            "Content-Disposition",
                            "attachment; filename=\"" + pathInfo.getFileName() + "\"");

                    response.getOutputStream().write(blobFile.getContent());
                }

            } else {

                logger.log(Level.INFO, "path info => " + pathInfo);
                logger.log(Level.INFO, "path name count => " + pathInfo.getNameCount());

                BlobListOption[] listOptions;
                if (pathInfo.getNameCount() == 0) {
                    listOptions = new BlobListOption[] {BlobListOption.currentDirectory()};
                } else {
                    if (pathInfo.getNameCount() <= 1) {
                        dirList.add("/");
                    } else {
                        dirList.add(pathInfo.getParent().toString());
                    }
                    listOptions =
                            new BlobListOption[] {
                                BlobListOption.currentDirectory(),
                                BlobListOption.prefix(pathInfo.toString() + "/")
                            };
                }

                Iterator<Blob> blobIterator = vtsReportBucket.list(listOptions).iterateAll();
                while (blobIterator.hasNext()) {
                    Blob blob = blobIterator.next();
                    logger.log(Level.INFO, "blob name => " + blob);
                    if (blob.isDirectory()) {
                        logger.log(Level.INFO, "directory name => " + blob.getName());
                        dirList.add(blob.getName());
                    } else {
                        logger.log(Level.INFO, "file name => " + blob.getName());
                        fileList.add(Paths.get(blob.getName()).getFileName().toString());
                    }
                }

                response.setStatus(HttpServletResponse.SC_OK);
                request.setAttribute("entryList", entryList);
                request.setAttribute("dirList", dirList);
                request.setAttribute("fileList", fileList);
                request.setAttribute("path", path);
                RequestDispatcher dispatcher = request.getRequestDispatcher(GCS_LOG_JSP);
                try {
                    dispatcher.forward(request, response);
                } catch (ServletException e) {
                    logger.log(Level.SEVERE, "Servlet Excpetion caught : ", e);
                }
            }
        }
    }
}