loader.py 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021
  1. #
  2. # Metrix++, Copyright 2009-2013, Metrix++ Project
  3. # Link: http://metrixplusplus.sourceforge.net
  4. #
  5. # This file is a part of Metrix++ Tool.
  6. #
  7. # Metrix++ is free software: you can redistribute it and/or modify
  8. # it under the terms of the GNU General Public License as published by
  9. # the Free Software Foundation, version 3 of the License.
  10. #
  11. # Metrix++ is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. # GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with Metrix++. If not, see <http://www.gnu.org/licenses/>.
  18. #
  19. import logging
  20. import os.path
  21. import core.api
  22. import core.db.sqlite
  23. ####################################
  24. # Data Interface
  25. ####################################
  26. class Data(object):
  27. def __init__(self):
  28. self.data = {}
  29. def get_data(self, namespace, field):
  30. if namespace not in self.data.keys():
  31. return None
  32. if field not in self.data[namespace].keys():
  33. return None
  34. return self.data[namespace][field]
  35. def set_data(self, namespace, field, value):
  36. if namespace not in self.data:
  37. self.data[namespace] = {}
  38. self.data[namespace][field] = value
  39. def iterate_namespaces(self):
  40. for namespace in self.data.keys():
  41. yield namespace
  42. def iterate_fields(self, namespace):
  43. for field in self.data[namespace].keys():
  44. yield (field, self.data[namespace][field])
  45. def get_data_tree(self, namespaces=None):
  46. return self.data
  47. def __repr__(self):
  48. return object.__repr__(self) + " with data " + self.data.__repr__()
  49. class LoadableData(Data):
  50. def __init__(self, loader, file_id, region_id):
  51. Data.__init__(self)
  52. self.loader = loader
  53. self.file_id = file_id
  54. self.region_id = region_id
  55. self.loaded_namespaces = []
  56. self.changed_namespaces = []
  57. def load_namespace(self, namespace):
  58. try:
  59. row = self.loader.db.get_row(namespace, self.file_id, self.region_id)
  60. except Exception:
  61. logging.debug("No data in the database for namespace: " + namespace)
  62. return
  63. if row == None:
  64. return
  65. for column_name in row.keys():
  66. packager = self.loader.get_namespace(namespace).get_field_packager(column_name)
  67. if packager == None:
  68. continue
  69. if row[column_name] == None:
  70. continue
  71. Data.set_data(self, namespace, column_name, packager.unpack(row[column_name]))
  72. def set_data(self, namespace, field, value):
  73. if namespace not in self.changed_namespaces:
  74. self.changed_namespaces.append(namespace)
  75. return Data.set_data(self, namespace, field, value)
  76. def get_data(self, namespace, field):
  77. if namespace not in self.loaded_namespaces:
  78. self.loaded_namespaces.append(namespace)
  79. self.load_namespace(namespace)
  80. return Data.get_data(self, namespace, field)
  81. def is_namespace_updated(self, namespace):
  82. return namespace in self.changed_namespaces
  83. def is_namespace_loaded(self, namespace):
  84. return namespace in self.loaded_namespaces
  85. def get_data_tree(self, namespaces=None):
  86. if namespaces == None:
  87. namespaces = self.loader.iterate_namespace_names()
  88. for each in namespaces:
  89. self.load_namespace(each)
  90. return Data.get_data_tree(self)
  91. class FileRegionData(LoadableData):
  92. class T(object):
  93. NONE = 0x00
  94. GLOBAL = 0x01
  95. CLASS = 0x02
  96. STRUCT = 0x04
  97. NAMESPACE = 0x08
  98. FUNCTION = 0x10
  99. INTERFACE = 0x20
  100. ANY = 0xFF
  101. def to_str(self, group):
  102. if group == self.NONE:
  103. return "none"
  104. elif group == self.GLOBAL:
  105. return "global"
  106. elif group == self.CLASS:
  107. return "class"
  108. elif group == self.STRUCT:
  109. return "struct"
  110. elif group == self.NAMESPACE:
  111. return "namespace"
  112. elif group == self.FUNCTION:
  113. return "function"
  114. elif group == self.INTERFACE:
  115. return "interface"
  116. else:
  117. assert(False)
  118. def __init__(self, loader, file_id, region_id, region_name, offset_begin, offset_end, line_begin, line_end, cursor_line, group, checksum):
  119. LoadableData.__init__(self, loader, file_id, region_id)
  120. self.name = region_name
  121. self.begin = offset_begin
  122. self.end = offset_end
  123. self.line_begin = line_begin
  124. self.line_end = line_end
  125. self.cursor = cursor_line
  126. self.group = group
  127. self.checksum = checksum
  128. self.children = []
  129. def get_id(self):
  130. return self.region_id
  131. def get_name(self):
  132. return self.name
  133. def get_offset_begin(self):
  134. return self.begin
  135. def get_offset_end(self):
  136. return self.end
  137. def get_line_begin(self):
  138. return self.line_begin
  139. def get_line_end(self):
  140. return self.line_end
  141. def get_cursor(self):
  142. return self.cursor
  143. def get_type(self):
  144. return self.group
  145. def get_checksum(self):
  146. return self.checksum
  147. def register_subregion_id(self, child_id):
  148. self.children.append(child_id)
  149. def iterate_subregion_ids(self):
  150. return self.children
  151. class Marker(object):
  152. class T(object):
  153. NONE = 0x00
  154. COMMENT = 0x01
  155. STRING = 0x02
  156. PREPROCESSOR = 0x04
  157. CODE = 0x08
  158. ALL_EXCEPT_CODE = 0x07
  159. ANY = 0xFF
  160. def to_str(self, group):
  161. if group == self.NONE:
  162. return "none"
  163. elif group == self.COMMENT:
  164. return "comment"
  165. elif group == self.STRING:
  166. return "string"
  167. elif group == self.PREPROCESSOR:
  168. return "preprocessor"
  169. elif group == self.CODE:
  170. return "code"
  171. else:
  172. assert(False)
  173. def __init__(self, offset_begin, offset_end, group):
  174. self.begin = offset_begin
  175. self.end = offset_end
  176. self.group = group
  177. def get_offset_begin(self):
  178. return self.begin
  179. def get_offset_end(self):
  180. return self.end
  181. def get_type(self):
  182. return self.group
  183. class FileData(LoadableData):
  184. def __init__(self, loader, path, file_id, checksum, content):
  185. LoadableData.__init__(self, loader, file_id, None)
  186. self.path = path
  187. self.checksum = checksum
  188. self.content = content
  189. self.regions = None
  190. self.markers = None
  191. self.loader = loader
  192. self.loading_tmp = []
  193. def get_id(self):
  194. return self.file_id
  195. def get_path(self):
  196. return self.path
  197. def get_checksum(self):
  198. return self.checksum
  199. def get_content(self, exclude = Marker.T.NONE):
  200. if exclude == Marker.T.NONE:
  201. return self.content
  202. if exclude == (Marker.T.COMMENT | Marker.T.STRING | Marker.T.PREPROCESSOR):
  203. # optimise frequent queries of this type
  204. if hasattr(self, 'content_cache'):
  205. return self.content_cache
  206. last_pos = 0
  207. content = ""
  208. for marker in self.iterate_markers(exclude):
  209. content += self.content[last_pos:marker.begin]
  210. content += " " * (marker.end - marker.begin)
  211. last_pos = marker.end
  212. content += self.content[last_pos:]
  213. if exclude == (Marker.T.COMMENT | Marker.T.STRING | Marker.T.PREPROCESSOR):
  214. self.content_cache = content
  215. assert(len(content) == len(self.content))
  216. return content
  217. def internal_append_region(self, region):
  218. # here we apply some magic - we rely on special ordering of coming regions,
  219. # which is supported by code parsers
  220. prev_id = None
  221. while True:
  222. if len(self.loading_tmp) == 0:
  223. break
  224. prev_id = self.loading_tmp.pop()
  225. if self.get_region(prev_id).get_offset_end() > region.get_offset_begin():
  226. self.loading_tmp.append(prev_id) # return back
  227. break
  228. self.loading_tmp.append(region.get_id())
  229. if prev_id != None:
  230. self.get_region(prev_id).register_subregion_id(region.get_id())
  231. self.regions.append(region)
  232. def load_regions(self):
  233. if self.regions == None:
  234. self.regions = []
  235. for each in self.loader.db.iterate_regions(self.get_id()):
  236. self.internal_append_region(FileRegionData(self.loader,
  237. self.get_id(),
  238. each.region_id,
  239. each.name,
  240. each.begin,
  241. each.end,
  242. each.line_begin,
  243. each.line_end,
  244. each.cursor,
  245. each.group,
  246. each.checksum))
  247. assert(len(self.regions) == each.region_id)
  248. def add_region(self, region_name, offset_begin, offset_end, line_begin, line_end, cursor_line, group, checksum):
  249. if self.regions == None:
  250. self.regions = [] # do not load in time of collection
  251. new_id = len(self.regions) + 1
  252. self.internal_append_region(FileRegionData(self.loader, self.get_id(), new_id, region_name, offset_begin, offset_end, line_begin, line_end, cursor_line, group, checksum))
  253. self.loader.db.create_region(self.file_id, new_id, region_name, offset_begin, offset_end, line_begin, line_end, cursor_line, group, checksum)
  254. return new_id
  255. def get_region(self, region_id):
  256. self.load_regions()
  257. return self.regions[region_id - 1]
  258. def get_region_types(self):
  259. return FileRegionData.T
  260. def iterate_regions(self, filter_group = FileRegionData.T.ANY):
  261. self.load_regions()
  262. for each in self.regions:
  263. if each.group & filter_group:
  264. yield each
  265. def are_regions_loaded(self):
  266. return self.regions != None
  267. def load_markers(self):
  268. if self.markers == None:
  269. self.markers = []
  270. for each in self.loader.db.iterate_markers(self.get_id()):
  271. self.markers.append(Marker(each.begin, each.end, each.group))
  272. def add_marker(self, offset_begin, offset_end, group):
  273. if self.markers == None:
  274. self.markers = [] # do not load in time of collection
  275. self.markers.append(Marker(offset_begin, offset_end, group))
  276. self.loader.db.create_marker(self.file_id, offset_begin, offset_end, group)
  277. def iterate_markers(self, filter_group = Marker.T.COMMENT |
  278. Marker.T.STRING | Marker.T.PREPROCESSOR,
  279. region_id = None, exclude_children = True, merge = False):
  280. self.load_markers()
  281. if merge == True:
  282. next_marker = None
  283. for marker in self.iterate_markers(filter_group, region_id, exclude_children, merge = False):
  284. if next_marker != None:
  285. if next_marker.get_offset_end() == marker.get_offset_begin():
  286. # sequential markers
  287. next_marker = Marker(next_marker.get_offset_begin(),
  288. marker.get_offset_end(),
  289. next_marker.get_type() | marker.get_type())
  290. else:
  291. yield next_marker
  292. next_marker = None
  293. if next_marker == None:
  294. next_marker = Marker(marker.get_offset_begin(),
  295. marker.get_offset_end(),
  296. marker.get_type())
  297. if region_id == None:
  298. next_code_marker_start = 0
  299. for marker in self.markers:
  300. if Marker.T.CODE & filter_group and next_code_marker_start < marker.get_offset_begin():
  301. yield Marker(next_code_marker_start, marker.get_offset_begin(), Marker.T.CODE)
  302. if marker.group & filter_group:
  303. yield marker
  304. next_code_marker_start = marker.get_offset_end()
  305. if Marker.T.CODE & filter_group and next_code_marker_start < len(self.get_content()):
  306. yield Marker(next_code_marker_start, len(self.get_content()), Marker.T.CODE)
  307. else:
  308. # per region
  309. region = self.get_region(region_id)
  310. if region != None:
  311. # code parsers and database know about non-code markers
  312. # clients want to iterate code as markers as well
  313. # so, we embed code markers in run-time
  314. class CodeMarker(Marker):
  315. pass
  316. # cache markers for all regions if it does not exist
  317. if hasattr(region, '_markers_list') == False:
  318. # subroutine to populate _markers_list attribute
  319. # _markers_list does include code markers
  320. def cache_markers_list_rec(data, region_id, marker_start_ind, next_code_marker_start):
  321. region = data.get_region(region_id)
  322. region._markers_list = []
  323. region._first_marker_ind = marker_start_ind
  324. #next_code_marker_start = region.get_offset_begin()
  325. for sub_id in region.iterate_subregion_ids():
  326. subregion = data.get_region(sub_id)
  327. # cache all markers before the subregion
  328. while len(data.markers) > marker_start_ind and \
  329. subregion.get_offset_begin() > data.markers[marker_start_ind].get_offset_begin():
  330. if next_code_marker_start < data.markers[marker_start_ind].get_offset_begin():
  331. # append code markers coming before non-code marker
  332. region._markers_list.append(CodeMarker(next_code_marker_start,
  333. data.markers[marker_start_ind].get_offset_begin(),
  334. Marker.T.CODE))
  335. next_code_marker_start = data.markers[marker_start_ind].get_offset_end()
  336. region._markers_list.append(marker_start_ind)
  337. marker_start_ind += 1
  338. # cache all code markers before the subregion but after the last marker
  339. if next_code_marker_start < subregion.get_offset_begin():
  340. region._markers_list.append(CodeMarker(next_code_marker_start,
  341. subregion.get_offset_begin(),
  342. Marker.T.CODE))
  343. next_code_marker_start = subregion.get_offset_begin()
  344. # here is the recursive call for all sub-regions
  345. (marker_start_ind, next_code_marker_start) = cache_markers_list_rec(data,
  346. sub_id,
  347. marker_start_ind,
  348. next_code_marker_start)
  349. # cache all markers after the last subregion
  350. while len(data.markers) > marker_start_ind and \
  351. region.get_offset_end() > data.markers[marker_start_ind].get_offset_begin():
  352. # append code markers coming before non-code marker
  353. if next_code_marker_start < data.markers[marker_start_ind].get_offset_begin():
  354. region._markers_list.append(CodeMarker(next_code_marker_start,
  355. data.markers[marker_start_ind].get_offset_begin(),
  356. Marker.T.CODE))
  357. next_code_marker_start = data.markers[marker_start_ind].get_offset_end()
  358. region._markers_list.append(marker_start_ind)
  359. marker_start_ind += 1
  360. # cache the last code segment after the last marker
  361. if next_code_marker_start < region.get_offset_end():
  362. region._markers_list.append(CodeMarker(next_code_marker_start,
  363. region.get_offset_end(),
  364. Marker.T.CODE))
  365. next_code_marker_start = region.get_offset_end()
  366. # return the starting point for the next call of this function
  367. return (marker_start_ind, next_code_marker_start)
  368. # append markers list to all regions recursively
  369. (next_marker_pos, next_code_marker_start) = cache_markers_list_rec(self, 1, 0, 0)
  370. assert(next_marker_pos == len(self.markers))
  371. # excluding subregions
  372. if exclude_children == True:
  373. for marker_ind in region._markers_list:
  374. if isinstance(marker_ind, int):
  375. marker = self.markers[marker_ind]
  376. else:
  377. marker = marker_ind # CodeMarker
  378. if marker.group & filter_group:
  379. yield marker
  380. # including subregions
  381. else:
  382. next_code_marker_start = region.get_offset_begin()
  383. for marker in self.markers[region._first_marker_ind:]:
  384. if marker.get_offset_begin() >= region.get_offset_end():
  385. break
  386. if region.get_offset_begin() > marker.get_offset_begin():
  387. continue
  388. if Marker.T.CODE & filter_group and next_code_marker_start < marker.get_offset_begin():
  389. yield Marker(next_code_marker_start, marker.get_offset_begin(), Marker.T.CODE)
  390. if marker.group & filter_group:
  391. yield marker
  392. next_code_marker_start = marker.get_offset_end()
  393. if Marker.T.CODE & filter_group and next_code_marker_start < region.get_offset_end():
  394. yield Marker(next_code_marker_start, region.get_offset_end(), Marker.T.CODE)
  395. def get_marker_types(self):
  396. return Marker.T
  397. def are_markers_loaded(self):
  398. return self.markers != None
  399. def __repr__(self):
  400. return Data.__repr__(self) + " and regions " + self.regions.__repr__()
  401. class AggregatedData(Data):
  402. def __init__(self, loader, path):
  403. Data.__init__(self)
  404. self.path = path
  405. self.loader = loader
  406. self.subdirs = None
  407. self.subfiles = None
  408. def get_subdirs(self):
  409. if self.subdirs != None:
  410. return self.subdirs
  411. self.subdirs = []
  412. if self.path != None:
  413. for subdir in self.loader.db.iterate_dircontent(self.path, include_subdirs = True, include_subfiles = False):
  414. self.subdirs.append(subdir)
  415. return self.subdirs
  416. def get_subfiles(self):
  417. if self.subfiles != None:
  418. return self.subfiles
  419. self.subfiles = []
  420. if self.path != None:
  421. for subfile in self.loader.db.iterate_dircontent(self.path, include_subdirs = False, include_subfiles = True):
  422. self.subfiles.append(subfile)
  423. return self.subfiles
  424. class SelectData(Data):
  425. def __init__(self, loader, path, file_id, region_id):
  426. Data.__init__(self)
  427. self.loader = loader
  428. self.path = path
  429. self.file_id = file_id
  430. self.region_id = region_id
  431. self.region = None
  432. def get_path(self):
  433. return self.path
  434. def get_region(self):
  435. if self.region == None and self.region_id != None:
  436. row = self.loader.db.get_region(self.file_id, self.region_id)
  437. if row != None:
  438. self.region = FileRegionData(self.loader,
  439. self.file_id,
  440. self.region_id,
  441. row.name,
  442. row.begin,
  443. row.end,
  444. row.line_begin,
  445. row.line_end,
  446. row.cursor,
  447. row.group,
  448. row.checksum)
  449. return self.region
  450. class DiffData(Data):
  451. def __init__(self, new_data, old_data):
  452. Data.__init__(self)
  453. self.new_data = new_data
  454. self.old_data = old_data
  455. def get_data(self, namespace, field):
  456. new_data = self.new_data.get_data(namespace, field)
  457. old_data = self.old_data.get_data(namespace, field)
  458. if new_data == None:
  459. return None
  460. if old_data == None:
  461. # non_zero fields has got zero value by default if missed
  462. # the data can be also unavailable,
  463. # because previous collection does not include that
  464. # but external tools (like limit.py) should warn about this,
  465. # using list of registered database properties
  466. old_data = 0
  467. return new_data - old_data
  468. ####################################
  469. # Packager Interface
  470. ####################################
  471. class PackagerError(Exception):
  472. def __init__(self):
  473. Exception.__init__(self, "Failed to pack or unpack.")
  474. class PackagerFactory(object):
  475. def create(self, python_type, non_zero):
  476. if python_type == None:
  477. return PackagerFactory.SkipPackager()
  478. if python_type == int:
  479. if non_zero == False:
  480. return PackagerFactory.IntPackager()
  481. else:
  482. return PackagerFactory.IntNonZeroPackager()
  483. if python_type == float and non_zero == False:
  484. return PackagerFactory.FloatPackager()
  485. if python_type == str:
  486. return PackagerFactory.StringPackager()
  487. class PackagerFactoryError(Exception):
  488. def __init__(self, python_type):
  489. Exception.__init__(self, "Python type '" + str(python_type) + "' is not supported by the factory.")
  490. raise PackagerFactoryError(python_type)
  491. def get_python_type(self, sql_type):
  492. if sql_type == "integer":
  493. return int
  494. if sql_type == "real":
  495. return float
  496. if sql_type == "text":
  497. return str
  498. class PackagerFactoryError(Exception):
  499. def __init__(self, sql_type):
  500. Exception.__init__(self, "SQL type '" + str(sql_type) + "' is not supported by the factory.")
  501. raise PackagerFactoryError(sql_type)
  502. class IPackager(object):
  503. def pack(self, unpacked_data):
  504. raise core.api.InterfaceNotImplemented(self)
  505. def unpack(self, packed_data):
  506. raise core.api.InterfaceNotImplemented(self)
  507. def get_sql_type(self):
  508. raise core.api.InterfaceNotImplemented(self)
  509. def get_python_type(self):
  510. raise core.api.InterfaceNotImplemented(self)
  511. def is_non_zero(self):
  512. return False
  513. class IntPackager(IPackager):
  514. def pack(self, unpacked_data):
  515. if not isinstance(unpacked_data, int):
  516. raise PackagerError()
  517. return str(unpacked_data)
  518. def unpack(self, packed_data):
  519. try:
  520. return int(packed_data)
  521. except ValueError:
  522. raise PackagerError()
  523. def get_sql_type(self):
  524. return "integer"
  525. def get_python_type(self):
  526. return int
  527. class IntNonZeroPackager(IntPackager):
  528. def pack(self, unpacked_data):
  529. if unpacked_data == 0:
  530. raise PackagerError()
  531. return PackagerFactory.IntPackager.pack(self, unpacked_data)
  532. def is_non_zero(self):
  533. return True
  534. class FloatPackager(IPackager):
  535. def pack(self, unpacked_data):
  536. if not isinstance(unpacked_data, float):
  537. raise PackagerError()
  538. return str(unpacked_data)
  539. def unpack(self, packed_data):
  540. try:
  541. return float(packed_data)
  542. except ValueError:
  543. raise PackagerError()
  544. def get_sql_type(self):
  545. return "real"
  546. def get_python_type(self):
  547. return float
  548. class FloatNonZeroPackager(FloatPackager):
  549. def pack(self, unpacked_data):
  550. if unpacked_data == 0:
  551. raise PackagerError()
  552. return PackagerFactory.FloatPackager.pack(self, unpacked_data)
  553. def is_non_zero(self):
  554. return True
  555. class StringPackager(IPackager):
  556. def pack(self, unpacked_data):
  557. if not isinstance(unpacked_data, str):
  558. raise PackagerError()
  559. return str(unpacked_data)
  560. def unpack(self, packed_data):
  561. try:
  562. return str(packed_data)
  563. except ValueError:
  564. raise PackagerError()
  565. def get_sql_type(self):
  566. return "text"
  567. def get_python_type(self):
  568. return str
  569. class SkipPackager(IPackager):
  570. def pack(self, unpacked_data):
  571. return None
  572. def unpack(self, packed_data):
  573. return None
  574. def get_sql_type(self):
  575. return None
  576. def get_python_type(self):
  577. return None
  578. ####################################
  579. # Loader
  580. ####################################
  581. class NamespaceError(Exception):
  582. def __init__(self, namespace, reason):
  583. Exception.__init__(self, "Namespace '"
  584. + namespace
  585. + "': '"
  586. + reason
  587. + "'")
  588. class FieldError(Exception):
  589. def __init__(self, field, reason):
  590. Exception.__init__(self, "Field '"
  591. + field
  592. + "': '"
  593. + reason
  594. + "'")
  595. class Namespace(object):
  596. def __init__(self, db_handle, name, support_regions = False, version='1.0'):
  597. if not isinstance(name, str):
  598. raise NamespaceError(name, "name not a string")
  599. self.name = name
  600. self.support_regions = support_regions
  601. self.fields = {}
  602. self.db = db_handle
  603. if self.db.check_table(name) == False:
  604. self.db.create_table(name, support_regions, version)
  605. else:
  606. for column in self.db.iterate_columns(name):
  607. self.add_field(column.name, PackagerFactory().get_python_type(column.sql_type), non_zero=column.non_zero)
  608. def get_name(self):
  609. return self.name
  610. def are_regions_supported(self):
  611. return self.support_regions
  612. def add_field(self, field_name, python_type, non_zero=False):
  613. if not isinstance(field_name, str):
  614. raise FieldError(field_name, "field_name not a string")
  615. packager = PackagerFactory().create(python_type, non_zero)
  616. if field_name in self.fields.keys():
  617. raise FieldError(field_name, "double used")
  618. self.fields[field_name] = packager
  619. if self.db.check_column(self.get_name(), field_name) == False:
  620. # - False if cloned
  621. # - True if created
  622. return self.db.create_column(self.name, field_name, packager.get_sql_type(), non_zero=non_zero)
  623. return None # if double request
  624. def iterate_field_names(self):
  625. for name in self.fields.keys():
  626. yield name
  627. def get_field_packager(self, field_name):
  628. if field_name in self.fields.keys():
  629. return self.fields[field_name]
  630. else:
  631. return None
  632. def get_field_sql_type(self, field_name):
  633. return self.get_field_packager(field_name).get_sql_type()
  634. def get_field_python_type(self, field_name):
  635. return self.get_field_packager(field_name).get_python_type()
  636. class DataNotPackable(Exception):
  637. def __init__(self, namespace, field, value, packager, extra_message):
  638. Exception.__init__(self, "Data '"
  639. + str(value)
  640. + "' of type "
  641. + str(value.__class__)
  642. + " referred by '"
  643. + namespace
  644. + "=>"
  645. + field
  646. + "' is not packable by registered packager '"
  647. + str(packager.__class__)
  648. + "': " + extra_message)
  649. class Loader(object):
  650. def __init__(self):
  651. self.namespaces = {}
  652. self.db = None
  653. self.last_file_data = None # for performance boost reasons
  654. def create_database(self, dbfile, previous_db = None):
  655. self.db = core.db.sqlite.Database()
  656. if os.path.exists(dbfile):
  657. logging.warn("Removing existing file: " + dbfile)
  658. # TODO can reuse existing db file to speed up the processing?
  659. # TODO add option to choose to remove or to overwrite?
  660. os.unlink(dbfile)
  661. if previous_db != None and os.path.exists(previous_db) == False:
  662. raise core.api.ExitError(None, "Database file '" + previous_db + "' does not exist")
  663. self.db.create(dbfile, clone_from=previous_db)
  664. def open_database(self, dbfile, read_only = True):
  665. self.db = core.db.sqlite.Database()
  666. if os.path.exists(dbfile) == False:
  667. raise core.api.ExitError(None, "Database file '" + dbfile + "' does not exist")
  668. self.db.connect(dbfile, read_only=read_only)
  669. for table in self.db.iterate_tables():
  670. self.create_namespace(table.name, table.support_regions)
  671. def set_property(self, property_name, value):
  672. if self.db == None:
  673. return None
  674. return self.db.set_property(property_name, value)
  675. def get_property(self, property_name):
  676. if self.db == None:
  677. return None
  678. return self.db.get_property(property_name)
  679. def iterate_properties(self):
  680. if self.db == None:
  681. return None
  682. return self.db.iterate_properties()
  683. def create_namespace(self, name, support_regions = False, version='1.0'):
  684. if self.db == None:
  685. return None
  686. if name in self.namespaces.keys():
  687. raise NamespaceError(name, "double used")
  688. new_namespace = Namespace(self.db, name, support_regions, version)
  689. self.namespaces[name] = new_namespace
  690. return new_namespace
  691. def iterate_namespace_names(self):
  692. for name in self.namespaces.keys():
  693. yield name
  694. def get_namespace(self, name):
  695. if name in self.namespaces.keys():
  696. return self.namespaces[name]
  697. else:
  698. return None
  699. def create_file_data(self, path, checksum, content):
  700. if self.db == None:
  701. return None
  702. (new_id, is_updated) = self.db.create_file(path, checksum)
  703. result = FileData(self, path, new_id, checksum, content)
  704. self.last_file_data = result
  705. return (result, is_updated)
  706. def load_file_data(self, path):
  707. if self.db == None:
  708. return None
  709. if self.last_file_data != None and self.last_file_data.get_path() == path:
  710. return self.last_file_data
  711. data = self.db.get_file(path)
  712. if data == None:
  713. return None
  714. result = FileData(self, data.path, data.id, data.checksum, None)
  715. self.last_file_data = result
  716. return result
  717. def save_file_data(self, file_data):
  718. if self.db == None:
  719. return None
  720. class DataIterator(object):
  721. def iterate_packed_values(self, data, namespace, support_regions = False):
  722. for each in data.iterate_fields(namespace):
  723. space = self.loader.get_namespace(namespace)
  724. if space == None:
  725. raise DataNotPackable(namespace, each[0], each[1], None, "The namespace has not been found")
  726. packager = space.get_field_packager(each[0])
  727. if packager == None:
  728. raise DataNotPackable(namespace, each[0], each[1], None, "The field has not been found")
  729. if space.support_regions != support_regions:
  730. raise DataNotPackable(namespace, each[0], each[1], packager, "Incompatible support for regions")
  731. try:
  732. packed_data = packager.pack(each[1])
  733. if packed_data == None:
  734. continue
  735. except PackagerError:
  736. raise DataNotPackable(namespace, each[0], each[1], packager, "Packager raised exception")
  737. yield (each[0], packed_data)
  738. def __init__(self, loader, data, namespace, support_regions = False):
  739. self.loader = loader
  740. self.iterator = self.iterate_packed_values(data, namespace, support_regions)
  741. def __iter__(self):
  742. return self.iterator
  743. for namespace in file_data.iterate_namespaces():
  744. if file_data.is_namespace_updated(namespace) == False:
  745. continue
  746. self.db.add_row(namespace,
  747. file_data.get_id(),
  748. None,
  749. DataIterator(self, file_data, namespace))
  750. if file_data.are_regions_loaded():
  751. for region in file_data.iterate_regions():
  752. for namespace in region.iterate_namespaces():
  753. if region.is_namespace_updated(namespace) == False:
  754. continue
  755. self.db.add_row(namespace,
  756. file_data.get_id(),
  757. region.get_id(),
  758. DataIterator(self, region, namespace, support_regions = True))
  759. def iterate_file_data(self, path = None, path_like_filter = "%"):
  760. if self.db == None:
  761. return None
  762. final_path_like = path_like_filter
  763. if path != None:
  764. if self.db.check_dir(path) == False and self.db.check_file(path) == False:
  765. return None
  766. final_path_like = path + path_like_filter
  767. class FileDataIterator(object):
  768. def iterate_file_data(self, loader, final_path_like):
  769. for data in loader.db.iterate_files(path_like=final_path_like):
  770. yield FileData(loader, data.path, data.id, data.checksum, None)
  771. def __init__(self, loader, final_path_like):
  772. self.iterator = self.iterate_file_data(loader, final_path_like)
  773. def __iter__(self):
  774. return self.iterator
  775. if self.db == None:
  776. return None
  777. return FileDataIterator(self, final_path_like)
  778. def load_aggregated_data(self, path = None, path_like_filter = "%", namespaces = None):
  779. if self.db == None:
  780. return None
  781. final_path_like = path_like_filter
  782. if path != None:
  783. if self.db.check_dir(path) == False and self.db.check_file(path) == False:
  784. return None
  785. final_path_like = path + path_like_filter
  786. if namespaces == None:
  787. namespaces = self.namespaces.keys()
  788. result = AggregatedData(self, path)
  789. for name in namespaces:
  790. namespace = self.get_namespace(name)
  791. data = self.db.aggregate_rows(name, path_like = final_path_like)
  792. for field in data.keys():
  793. if namespace.get_field_packager(field).get_python_type() == str:
  794. continue
  795. if namespace.get_field_packager(field).is_non_zero() == True:
  796. data[field]['min'] = None
  797. data[field]['avg'] = None
  798. distribution = self.db.count_rows(name, path_like = final_path_like, group_by_column = field)
  799. data[field]['distribution-bars'] = []
  800. for each in distribution:
  801. if each[0] == None:
  802. continue
  803. assert(float(data[field]['count'] != 0))
  804. data[field]['distribution-bars'].append({'metric': each[0],
  805. 'count': each[1],
  806. 'ratio': round((float(each[1]) / float(data[field]['count'])), 4)})
  807. result.set_data(name, field, data[field])
  808. return result
  809. def load_selected_data(self, namespace, fields = None, path = None, path_like_filter = "%", filters = [],
  810. sort_by = None, limit_by = None):
  811. if self.db == None:
  812. return None
  813. final_path_like = path_like_filter
  814. if path != None:
  815. if self.db.check_dir(path) == False and self.db.check_file(path) == False:
  816. return None
  817. final_path_like = path + path_like_filter
  818. namespace_obj = self.get_namespace(namespace)
  819. if namespace_obj == None:
  820. return None
  821. class SelectDataIterator(object):
  822. def iterate_selected_values(self, loader, namespace_obj, final_path_like, fields, filters, sort_by, limit_by):
  823. for row in loader.db.select_rows(namespace_obj.get_name(), path_like=final_path_like, filters=filters,
  824. order_by=sort_by, limit_by=limit_by):
  825. region_id = None
  826. if namespace_obj.are_regions_supported() == True:
  827. region_id = row['region_id']
  828. data = SelectData(loader, row['path'], row['id'], region_id)
  829. field_names = fields
  830. if fields == None:
  831. field_names = namespace_obj.iterate_field_names()
  832. for field in field_names:
  833. data.set_data(namespace, field, row[field])
  834. yield data
  835. def __init__(self, loader, namespace_obj, final_path_like, fields, filters, sort_by, limit_by):
  836. self.iterator = self.iterate_selected_values(loader, namespace_obj, final_path_like, fields, filters, sort_by, limit_by)
  837. def __iter__(self):
  838. return self.iterator
  839. return SelectDataIterator(self, namespace_obj, final_path_like, fields, filters, sort_by, limit_by)