[TIC-CORE] change the license from apache 2.0 to flora 1.1
[archive/20170607/tools/tic-core.git] / tic / parser / view_parser.py
1 #!/usr/bin/python
2 # Copyright (c) 2016 Samsung Electronics Co., Ltd
3 #
4 # Licensed under the Flora License, Version 1.1 (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://floralicense.org/license/
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 # Contributors:
17 # - S-Core Co., Ltd
18
19 import logging
20 import requests
21 import re
22 from operator import itemgetter
23 from tic.utils.rpmmisc import meetRequireVersion
24
25
26 def make_view_data(pkg_group):
27     logger = logging.getLogger(__name__)
28     
29     def _select_provide_rpm(capability, require):
30         provide_list = []
31         if require.get('ver') is not None:
32             for provide in capability:
33                 ver_data = provide['data']
34                 if not ver_data.get('ver'):
35                     ver_data = pkg_dict.get(provide['name']).get('version')
36                 if meetRequireVersion(require, ver_data):
37                     provide_list.append(provide)
38         else:
39             provide_list = capability
40             
41         result = []
42         for provide in provide_list:
43             result.append(pkg_dict[provide['name']])
44             
45         return result
46     
47     def set_meta_require(meta_info):
48         meta_nodes = meta_info.get('nodes')
49         children = set()
50         for child_meta in meta_nodes:
51             set_meta_require(child_meta)
52             children.add(child_meta['metaname'])
53         
54         duplicate = set()
55         pkg_info = pkg_dict[meta_info['metaname']]
56         for dep_tag in ['requires', 'recommends', 'suggests']:
57             if pkg_info.get(dep_tag):
58                 for req in pkg_info.get(dep_tag):
59                     targets = []
60                     if req['name'] in provides:
61                         targets = _select_provide_rpm(provides[req['name']], req)
62                     elif req['name'] in files:
63                         for fname in files[req['name']]:
64                             targets.append(pkg_dict.get(fname))
65                     elif req['name'] in pkg_dict:
66                         targets.append(pkg_dict.get(req['name']))
67                     else:
68                         # the dependent package does not exist.
69                         pass
70                         
71                     for pkg in targets:
72                         # The meta-pkg of the other group are excluded.
73                         if pkg['name'] not in duplicate:
74                             refer_count[pkg['id']] += 1
75                             duplicate.add(pkg['name'])
76
77                             if pkg.get('meta'):
78                                 if not pkg['name'] in children:
79                                     meta_nodes.append(make_linked_meta_node(pkg['name'], pkg['summary']))
80                             else:
81                                 meta_nodes.append(make_node(pkg, meta_info.get('category')))
82         # Added 'zz' to non meta-package because they are to be listed last
83         meta_nodes = sorted(meta_nodes, key = lambda k: 'aa'+k['metaname'] if 'metaname' in k else 'zz'+k['text'])
84         meta_info['nodes'] = meta_nodes
85
86         if meta_info['metaname'] =='building-blocks-sub2-Preset_iot-examples-3_RPI3_headless_devboard':
87             print(pkg_info)
88     def make_node(pkg_info, category=None):
89         n = dict(text=pkg_info['name'], nodes=[])
90         if category: n['category'] = category
91         return n
92     def make_meta_node(pkgname, viewtext):
93         return dict(text=viewtext, metaname=pkgname, nodes=[])
94     def make_linked_meta_node(pkgname, viewtext):
95         return dict(text='<i>'+viewtext+'</i>', metaname=pkgname, nodes=[])
96     def is_blank_ui_meta_node(pkgname):
97         return (pkgname[-8:-2] == '__UI__')
98     def handle_ui_meta_node(tag, node):
99         node['selectable'] = False
100         node['hideCheckbox'] = True
101         if tag == 'BR' or tag == 'br':
102             node['text'] = ''
103         elif tag == 'HR' or tag == 'hr':
104             node['text'] = '<hr style="margin-bottom: 0px; margin-top: 0px; border-style: inset; border-width: 3px" />'
105         elif tag == 'SD' or tag == 'sd':
106             node['text'] = ''
107             node['backColor'] = '#101010'
108         elif tag == 'SM' or tag == 'sm':
109             # Keep the summary text
110             node['text'] = node['text']
111         elif tag == 'HT' or tag == 'ht':
112             # Keep the summary (TODO: verify the usage of HTML tags.)
113             node['text'] = node['text'] # Do we need conversion?
114         else:
115             node['text'] = ''
116         return node
117     def handle_description(node):
118         if 'metaname' in node:
119             name = node['metaname']
120             pkg_info = pkg_dict[name]
121             desc = pkg_info.get('description')
122             if desc[0:10] == '__KS_URL__':
123                 logger.info("Processing "+name+" for its description: "+pkg_info.get('description'))
124                 # Extract URL from __KS_URL__
125                 ksURL = desc[11:].splitlines()[0].strip()
126                 # Omit the first line with __KS_URL__ from showing.
127                 pkg_info['description'] = desc[len(desc.splitlines(True)[0]):]
128
129                 # Search for filename if directory is given
130                 # e.g., Convert http://a.com/a/ to https://a.com/a/blahblah.ks
131                 # Works for file-indexing html
132                 if ksURL[-3:].lower() != ".ks":
133                     if ksURL[-1:] != "/":
134                         ksURL += "/"
135                     r = requests.get(ksURL)
136                     m = re.search('>([^<]*\\.ks)\\s*<', r.text)
137                     if not m.group(1):
138                         m = re.search('"([^"]*\\.ks)\\s*"', r.text)
139                         if not m.group(1):
140                             m = re.search("'([^']*\\.ks)\\s*'", r.text)
141                             if not m.group(1):
142                                 node['icon'] = 'glyphicon glyphicon-remove-sign'
143                                 node['tooltip'] = 'Cannot find image base from' + ksURL
144                                 return node
145                     ksURL += m.group(1)
146                 node['tooltip'] = 'Image base from '+ksURL
147                 node['ks'] = ksURL
148             elif desc[0:10] == '__EXPAND__':
149                 # Omit the first line with __EXPAND__ from showing.
150                 pkg_info['description'] = desc[len(desc.splitlines(True)[0]):]
151                 node['state'] = { 'expanded': True }
152         return node
153
154     # view_data for tree view on web-ui
155     view_data = []
156     # temporary dictionary for referencing meta
157     view_ref = {}
158     
159     if not pkg_group:
160         return view_data
161       
162     pkg_dict = pkg_group['pkg_dict']
163     provides = pkg_group['provides']
164     files = pkg_group['files']
165     refer_count = [0] * len(pkg_dict)
166     
167     # sort meta-pkg by pkt_name in ascending order
168     meta_info = pkg_group.get('meta_info')
169     meta_info['root'] = sorted(meta_info['root'], key=itemgetter(0))
170     meta_info['sub1'] = sorted(meta_info['sub1'], key=itemgetter(0))
171     meta_info['sub2'] = sorted(meta_info['sub2'], key=itemgetter(0))
172     
173     # make category rpms
174     category_dict = {}
175     if meta_info.get('category'):
176         for category in meta_info['category']:
177             c_rpm = pkg_dict[category[0]]
178             if hasattr(c_rpm.get('suggests'), '__iter__'):
179                 for suggest in c_rpm.get('suggests'):
180                     category_dict[suggest['name']] = category[1]
181             else:
182                 logger.info(c_rpm.get('suggests'))
183                 logger.info(c_rpm.get('name'))
184
185     
186     # make tree of meta
187     for root in meta_info['root']:
188         root_node = make_meta_node(root[0], root[1])
189         view_ref[root[0]] = root_node
190         if root[0] in category_dict:
191             root_node['category'] = category_dict[root[0]]
192         if is_blank_ui_meta_node(root[0]):
193             name = root[0]
194             sub1_node = handle_ui_meta_node(name[-2:], root_node)
195         root_node = handle_description(root_node)
196         view_data.append(root_node)
197         
198     for sub1 in meta_info['sub1']:
199         sub1_node = make_meta_node(sub1[0], sub1[2])
200         view_ref[sub1[0]] = sub1_node
201         if is_blank_ui_meta_node(sub1[0]):
202             name = sub1[0]
203             sub1_node = handle_ui_meta_node(name[-2:], sub1_node)
204         sub1_node = handle_description(sub1_node)
205         # search root
206         if sub1[1] in view_ref:
207             # add to root node
208             if 'category' in view_ref[sub1[1]] and view_ref[sub1[1]]['category']:
209                 sub1_node['category'] = view_ref[sub1[1]]['category']
210             view_ref[sub1[1]]['nodes'].append(sub1_node)
211         else:
212             # If root-meta does not exist, sub1 is added to top-level
213             view_data.append(sub1_node)
214             
215     for sub2 in meta_info['sub2']:
216         sub2_node = make_meta_node(sub2[0], sub2[3])
217         view_ref[sub2[0]] = sub2_node
218         if is_blank_ui_meta_node(sub2[0]):
219             name = sub2[0]
220             sub1_node = handle_ui_meta_node(name[-2:], sub2_node)
221         sub2_node = handle_description(sub2_node)
222         # search sub1
223         if sub2[2] in view_ref:
224             if 'category' in view_ref[sub2[2]] and view_ref[sub2[2]]['category']:
225                 sub2_node['category'] = view_ref[sub2[2]]['category']
226             view_ref[sub2[2]]['nodes'].append(sub2_node)
227         # search root    
228         elif sub2[1] in view_ref: 
229             if view_ref[sub2[1]]['category']:
230                 sub2_node['category'] = view_ref[sub2[1]]['category']
231             # If sub1-meta does not exist, sub2 is added to child of root-meta
232             view_ref[sub2[1]]['nodes'].append(sub2_node)
233         else:
234             # If root-meta/sub1-meta does not exist, sub1 is added to top-level
235             view_data.append(sub2_node)
236     
237     # configure meta dependency tree (requires)
238     for meta_pkg in view_data:
239         set_meta_require(meta_pkg)
240         
241     #The remaining rpms are grouped into a MISC tree
242     misc_info = {}
243     misc_info['text'] = 'Advanced (individual packages)'
244     misc_info['nodes'] = []
245     for k, v in pkg_dict.iteritems():
246         # Pkg is not referenced from Meta-pkg
247         if not v.get('meta') and refer_count[v['id']] == 0:
248             misc_info['nodes'].append(make_node(v))
249     misc_info['nodes'] = sorted(misc_info['nodes'], key = lambda k: k['metaname'] if 'metaname' in k else k['text'])
250
251     view_data.append(misc_info)
252     logger.info('meta: %d, misc: %d', len(view_ref), len(misc_info['nodes']))
253     return view_data