Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-present Open Networking Laboratory |
| 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 | |
Thomas Vachuska | 04059f9 | 2017-03-07 15:16:23 -0800 | [diff] [blame] | 17 | package org.onosproject.yang.gui; |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 18 | |
Thomas Vachuska | cde197c | 2017-03-23 17:51:08 -0700 | [diff] [blame] | 19 | import com.fasterxml.jackson.databind.node.ArrayNode; |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 20 | import com.fasterxml.jackson.databind.node.ObjectNode; |
| 21 | import com.google.common.collect.ImmutableSet; |
| 22 | import org.onlab.osgi.ServiceDirectory; |
| 23 | import org.onosproject.ui.RequestHandler; |
| 24 | import org.onosproject.ui.UiConnection; |
| 25 | import org.onosproject.ui.UiMessageHandler; |
| 26 | import org.onosproject.ui.table.TableModel; |
| 27 | import org.onosproject.ui.table.TableRequestHandler; |
Thomas Vachuska | 04059f9 | 2017-03-07 15:16:23 -0800 | [diff] [blame] | 28 | import org.onosproject.yang.model.YangModel; |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 29 | import org.onosproject.yang.model.YangModule; |
Thomas Vachuska | 0cb73f4 | 2017-03-22 10:57:34 -0700 | [diff] [blame] | 30 | import org.onosproject.yang.model.YangModuleId; |
Thomas Vachuska | 04059f9 | 2017-03-07 15:16:23 -0800 | [diff] [blame] | 31 | import org.onosproject.yang.runtime.YangModelRegistry; |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 32 | import org.slf4j.Logger; |
| 33 | import org.slf4j.LoggerFactory; |
| 34 | |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 35 | import java.io.BufferedReader; |
| 36 | import java.io.IOException; |
| 37 | import java.io.InputStream; |
| 38 | import java.io.InputStreamReader; |
| 39 | import java.net.URLEncoder; |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 40 | import java.util.Collection; |
Thomas Vachuska | 0cb73f4 | 2017-03-22 10:57:34 -0700 | [diff] [blame] | 41 | import java.util.Set; |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 42 | |
| 43 | /** |
Thomas Vachuska | 04059f9 | 2017-03-07 15:16:23 -0800 | [diff] [blame] | 44 | * ONOS UI YANG Models message handler. |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 45 | */ |
| 46 | public class YangModelMessageHandler extends UiMessageHandler { |
| 47 | |
| 48 | private static final String TABLE_REQ = "yangModelDataRequest"; |
| 49 | private static final String TABLE_RESP = "yangModelDataResponse"; |
Simon Hunt | 7d5e984 | 2017-02-23 11:37:02 -0800 | [diff] [blame] | 50 | private static final String MODELS = "yangModels"; |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 51 | |
| 52 | private static final String DETAILS_REQ = "yangModelDetailsRequest"; |
| 53 | private static final String DETAILS_RESP = "yangModelDetailsResponse"; |
| 54 | private static final String DETAILS = "details"; |
| 55 | |
| 56 | // Table Column IDs |
| 57 | private static final String ID = "id"; |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 58 | private static final String MODULE = "module"; |
| 59 | private static final String REVISION = "revision"; |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 60 | // TODO: fill out table columns as needed |
| 61 | |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 62 | private static final String SOURCE = "source"; |
| 63 | |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 64 | private static final String[] COL_IDS = { |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 65 | ID, MODULE, REVISION |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 66 | }; |
| 67 | |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 68 | private static final String UTF8 = "UTF-8"; |
| 69 | |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 70 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 71 | |
Thomas Vachuska | 04059f9 | 2017-03-07 15:16:23 -0800 | [diff] [blame] | 72 | private YangModelRegistry modelRegistry; |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 73 | // TODO: fill out other fields as necessary |
| 74 | |
| 75 | |
| 76 | // ===============-=-=-=-=-=-==================-=-=-=-=-=-=-=========== |
| 77 | |
| 78 | @Override |
| 79 | public void init(UiConnection connection, ServiceDirectory directory) { |
| 80 | super.init(connection, directory); |
Thomas Vachuska | 04059f9 | 2017-03-07 15:16:23 -0800 | [diff] [blame] | 81 | modelRegistry = directory.get(YangModelRegistry.class); |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | @Override |
| 85 | public void destroy() { |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 86 | super.destroy(); |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 87 | } |
| 88 | |
| 89 | @Override |
| 90 | protected Collection<RequestHandler> createRequestHandlers() { |
| 91 | return ImmutableSet.of( |
Simon Hunt | 7d5e984 | 2017-02-23 11:37:02 -0800 | [diff] [blame] | 92 | new TableDataHandler(), |
| 93 | new DetailRequestHandler() |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 94 | ); |
| 95 | } |
| 96 | |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 97 | // Handler for table requests |
| 98 | private final class TableDataHandler extends TableRequestHandler { |
| 99 | private static final String NO_ROWS_MESSAGE = "No YANG Models found"; |
| 100 | |
| 101 | private TableDataHandler() { |
| 102 | super(TABLE_REQ, TABLE_RESP, MODELS); |
| 103 | } |
| 104 | |
| 105 | @Override |
| 106 | protected String[] getColumnIds() { |
| 107 | return COL_IDS; |
| 108 | } |
| 109 | |
| 110 | @Override |
| 111 | protected String noRowsMessage(ObjectNode payload) { |
| 112 | return NO_ROWS_MESSAGE; |
| 113 | } |
| 114 | |
| 115 | @Override |
| 116 | protected void populateTable(TableModel tm, ObjectNode payload) { |
Thomas Vachuska | 04059f9 | 2017-03-07 15:16:23 -0800 | [diff] [blame] | 117 | for (YangModel model : modelRegistry.getModels()) { |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 118 | for (YangModuleId id : model.getYangModulesId()) { |
| 119 | populateRow(tm.addRow(), model.hashCode(), id); |
| 120 | } |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 121 | } |
| 122 | } |
| 123 | |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 124 | private void populateRow(TableModel.Row row, int modelId, YangModuleId moduleId) { |
| 125 | row.cell(ID, "YM" + modelId) |
| 126 | .cell(MODULE, moduleId.moduleName()) |
| 127 | .cell(REVISION, moduleId.revision()); |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 128 | } |
| 129 | } |
| 130 | |
| 131 | |
| 132 | // handler for selected model detail requests (selected table row) |
| 133 | private final class DetailRequestHandler extends RequestHandler { |
| 134 | private DetailRequestHandler() { |
| 135 | super(DETAILS_REQ); |
| 136 | } |
| 137 | |
| 138 | @Override |
| 139 | public void process(ObjectNode payload) { |
| 140 | String id = string(payload, ID); |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 141 | String name = string(payload, MODULE); |
| 142 | YangModule module = getModule(id, name); |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 143 | |
| 144 | ObjectNode data = objectNode(); |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 145 | data.put(ID, id); |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 146 | if (module != null) { |
| 147 | data.put(MODULE, module.getYangModuleId().moduleName()); |
| 148 | data.put(REVISION, module.getYangModuleId().revision()); |
Thomas Vachuska | cde197c | 2017-03-23 17:51:08 -0700 | [diff] [blame] | 149 | |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 150 | ArrayNode source = arrayNode(); |
| 151 | data.set(SOURCE, source); |
| 152 | |
| 153 | addSource(source, module.getYangSource()); |
Thomas Vachuska | cde197c | 2017-03-23 17:51:08 -0700 | [diff] [blame] | 154 | } |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 155 | |
| 156 | ObjectNode rootNode = objectNode(); |
| 157 | rootNode.set(DETAILS, data); |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 158 | sendMessage(DETAILS_RESP, rootNode); |
| 159 | } |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 160 | |
| 161 | private void addSource(ArrayNode source, InputStream yangSource) { |
| 162 | try (InputStreamReader isr = new InputStreamReader(yangSource); |
| 163 | BufferedReader br = new BufferedReader(isr)) { |
| 164 | String line; |
| 165 | while ((line = br.readLine()) != null) { |
| 166 | source.add(line); |
| 167 | } |
| 168 | |
| 169 | } catch (IOException e) { |
| 170 | log.warn("Unable to read YANG source", e); |
| 171 | return; |
| 172 | } |
| 173 | } |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 174 | } |
Thomas Vachuska | cde197c | 2017-03-23 17:51:08 -0700 | [diff] [blame] | 175 | |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 176 | |
| 177 | private YangModule getModule(String id, String name) { |
| 178 | int nid = Integer.parseInt(id.substring(2)); |
| 179 | log.info("Got {}; {}", id, nid); |
| 180 | YangModel model = modelRegistry.getModels().stream() |
| 181 | .filter(m -> m.hashCode() == nid) |
Thomas Vachuska | cde197c | 2017-03-23 17:51:08 -0700 | [diff] [blame] | 182 | .findFirst().orElse(null); |
Thomas Vachuska | e0792f1 | 2017-03-31 00:15:06 -0700 | [diff] [blame^] | 183 | if (model != null) { |
| 184 | log.info("Got model"); |
| 185 | return model.getYangModules().stream() |
| 186 | .filter(m -> m.getYangModuleId().moduleName().contentEquals(name)) |
| 187 | .findFirst().orElse(null); |
| 188 | } |
| 189 | return null; |
Thomas Vachuska | cde197c | 2017-03-23 17:51:08 -0700 | [diff] [blame] | 190 | } |
Simon Hunt | cc035c5 | 2017-02-22 21:12:51 -0800 | [diff] [blame] | 191 | } |