loader.py 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999
  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):
  280. self.load_markers()
  281. if region_id == None:
  282. # TODO bug here - does not handle CODE markers
  283. for each in self.markers:
  284. if each.group & filter_group:
  285. yield each
  286. else:
  287. # per region
  288. region = self.get_region(region_id)
  289. if region != None:
  290. # code parsers and database know about non-code markers
  291. # clients want to iterate code as markers as well
  292. # so, we embed code markers in run-time
  293. class CodeMarker(Marker):
  294. pass
  295. # cache markers for all regions if it does not exist
  296. if hasattr(region, '_markers_list') == False:
  297. # subroutine to populate _markers_list attribute
  298. # _markers_list does include code markers
  299. def cache_markers_list_rec(data, region_id, marker_start_ind, next_code_marker_start):
  300. region = data.get_region(region_id)
  301. region._markers_list = []
  302. region._first_marker_ind = marker_start_ind
  303. #next_code_marker_start = region.get_offset_begin()
  304. for sub_id in region.iterate_subregion_ids():
  305. subregion = data.get_region(sub_id)
  306. # cache all markers before the subregion
  307. while len(data.markers) > marker_start_ind and \
  308. subregion.get_offset_begin() > data.markers[marker_start_ind].get_offset_begin():
  309. if next_code_marker_start < data.markers[marker_start_ind].get_offset_begin():
  310. # append code markers coming before non-code marker
  311. region._markers_list.append(CodeMarker(next_code_marker_start,
  312. data.markers[marker_start_ind].get_offset_begin(),
  313. Marker.T.CODE))
  314. next_code_marker_start = data.markers[marker_start_ind].get_offset_end()
  315. region._markers_list.append(marker_start_ind)
  316. marker_start_ind += 1
  317. # cache all code markers before the subregion but after the last marker
  318. if next_code_marker_start < subregion.get_offset_begin():
  319. region._markers_list.append(CodeMarker(next_code_marker_start,
  320. subregion.get_offset_begin(),
  321. Marker.T.CODE))
  322. next_code_marker_start = subregion.get_offset_begin()
  323. # here is the recursive call for all sub-regions
  324. (marker_start_ind, next_code_marker_start) = cache_markers_list_rec(data,
  325. sub_id,
  326. marker_start_ind,
  327. next_code_marker_start)
  328. # cache all markers after the last subregion
  329. while len(data.markers) > marker_start_ind and \
  330. region.get_offset_end() > data.markers[marker_start_ind].get_offset_begin():
  331. # append code markers coming before non-code marker
  332. if next_code_marker_start < data.markers[marker_start_ind].get_offset_begin():
  333. region._markers_list.append(CodeMarker(next_code_marker_start,
  334. data.markers[marker_start_ind].get_offset_begin(),
  335. Marker.T.CODE))
  336. next_code_marker_start = data.markers[marker_start_ind].get_offset_end()
  337. region._markers_list.append(marker_start_ind)
  338. marker_start_ind += 1
  339. # cache the last code segment after the last marker
  340. if next_code_marker_start < region.get_offset_end():
  341. region._markers_list.append(CodeMarker(next_code_marker_start,
  342. region.get_offset_end(),
  343. Marker.T.CODE))
  344. next_code_marker_start = region.get_offset_end()
  345. # return the starting point for the next call of this function
  346. return (marker_start_ind, next_code_marker_start)
  347. # append markers list to all regions recursively
  348. (next_marker_pos, next_code_marker_start) = cache_markers_list_rec(self, 1, 0, 0)
  349. assert(next_marker_pos == len(self.markers))
  350. # excluding subregions
  351. if exclude_children == True:
  352. for marker_ind in region._markers_list:
  353. if isinstance(marker_ind, int):
  354. marker = self.markers[marker_ind]
  355. else:
  356. marker = marker_ind # CodeMarker
  357. if marker.group & filter_group:
  358. yield marker
  359. # including subregions
  360. else:
  361. next_code_marker_start = region.get_offset_begin() #TODO bug here global region does not start at 0
  362. for marker in self.markers[region._first_marker_ind:]:
  363. if marker.get_offset_begin() >= region.get_offset_end():
  364. break
  365. if region.get_offset_begin() > marker.get_offset_begin():
  366. continue
  367. if Marker.T.CODE & filter_group and next_code_marker_start < marker.get_offset_begin():
  368. yield Marker(next_code_marker_start, marker.get_offset_begin(), Marker.T.CODE)
  369. if marker.group & filter_group:
  370. yield marker
  371. next_code_marker_start = marker.get_offset_end()
  372. if Marker.T.CODE & filter_group and next_code_marker_start < region.get_offset_end():
  373. yield Marker(next_code_marker_start, region.get_offset_end(), Marker.T.CODE)
  374. def get_marker_types(self):
  375. return Marker.T
  376. def are_markers_loaded(self):
  377. return self.markers != None
  378. def __repr__(self):
  379. return Data.__repr__(self) + " and regions " + self.regions.__repr__()
  380. class AggregatedData(Data):
  381. def __init__(self, loader, path):
  382. Data.__init__(self)
  383. self.path = path
  384. self.loader = loader
  385. self.subdirs = None
  386. self.subfiles = None
  387. def get_subdirs(self):
  388. if self.subdirs != None:
  389. return self.subdirs
  390. self.subdirs = []
  391. if self.path != None:
  392. for subdir in self.loader.db.iterate_dircontent(self.path, include_subdirs = True, include_subfiles = False):
  393. self.subdirs.append(subdir)
  394. return self.subdirs
  395. def get_subfiles(self):
  396. if self.subfiles != None:
  397. return self.subfiles
  398. self.subfiles = []
  399. if self.path != None:
  400. for subfile in self.loader.db.iterate_dircontent(self.path, include_subdirs = False, include_subfiles = True):
  401. self.subfiles.append(subfile)
  402. return self.subfiles
  403. class SelectData(Data):
  404. def __init__(self, loader, path, file_id, region_id):
  405. Data.__init__(self)
  406. self.loader = loader
  407. self.path = path
  408. self.file_id = file_id
  409. self.region_id = region_id
  410. self.region = None
  411. def get_path(self):
  412. return self.path
  413. def get_region(self):
  414. if self.region == None and self.region_id != None:
  415. row = self.loader.db.get_region(self.file_id, self.region_id)
  416. if row != None:
  417. self.region = FileRegionData(self.loader,
  418. self.file_id,
  419. self.region_id,
  420. row.name,
  421. row.begin,
  422. row.end,
  423. row.line_begin,
  424. row.line_end,
  425. row.cursor,
  426. row.group,
  427. row.checksum)
  428. return self.region
  429. class DiffData(Data):
  430. def __init__(self, new_data, old_data):
  431. Data.__init__(self)
  432. self.new_data = new_data
  433. self.old_data = old_data
  434. def get_data(self, namespace, field):
  435. new_data = self.new_data.get_data(namespace, field)
  436. old_data = self.old_data.get_data(namespace, field)
  437. if new_data == None:
  438. return None
  439. if old_data == None:
  440. # non_zero fields has got zero value by default if missed
  441. # the data can be also unavailable,
  442. # because previous collection does not include that
  443. # but external tools (like limit.py) should warn about this,
  444. # using list of registered database properties
  445. old_data = 0
  446. return new_data - old_data
  447. ####################################
  448. # Packager Interface
  449. ####################################
  450. class PackagerError(Exception):
  451. def __init__(self):
  452. Exception.__init__(self, "Failed to pack or unpack.")
  453. class PackagerFactory(object):
  454. def create(self, python_type, non_zero):
  455. if python_type == None:
  456. return PackagerFactory.SkipPackager()
  457. if python_type == int:
  458. if non_zero == False:
  459. return PackagerFactory.IntPackager()
  460. else:
  461. return PackagerFactory.IntNonZeroPackager()
  462. if python_type == float and non_zero == False:
  463. return PackagerFactory.FloatPackager()
  464. if python_type == str:
  465. return PackagerFactory.StringPackager()
  466. class PackagerFactoryError(Exception):
  467. def __init__(self, python_type):
  468. Exception.__init__(self, "Python type '" + str(python_type) + "' is not supported by the factory.")
  469. raise PackagerFactoryError(python_type)
  470. def get_python_type(self, sql_type):
  471. if sql_type == "integer":
  472. return int
  473. if sql_type == "real":
  474. return float
  475. if sql_type == "text":
  476. return str
  477. class PackagerFactoryError(Exception):
  478. def __init__(self, sql_type):
  479. Exception.__init__(self, "SQL type '" + str(sql_type) + "' is not supported by the factory.")
  480. raise PackagerFactoryError(sql_type)
  481. class IPackager(object):
  482. def pack(self, unpacked_data):
  483. raise core.api.InterfaceNotImplemented(self)
  484. def unpack(self, packed_data):
  485. raise core.api.InterfaceNotImplemented(self)
  486. def get_sql_type(self):
  487. raise core.api.InterfaceNotImplemented(self)
  488. def get_python_type(self):
  489. raise core.api.InterfaceNotImplemented(self)
  490. def is_non_zero(self):
  491. return False
  492. class IntPackager(IPackager):
  493. def pack(self, unpacked_data):
  494. if not isinstance(unpacked_data, int):
  495. raise PackagerError()
  496. return str(unpacked_data)
  497. def unpack(self, packed_data):
  498. try:
  499. return int(packed_data)
  500. except ValueError:
  501. raise PackagerError()
  502. def get_sql_type(self):
  503. return "integer"
  504. def get_python_type(self):
  505. return int
  506. class IntNonZeroPackager(IntPackager):
  507. def pack(self, unpacked_data):
  508. if unpacked_data == 0:
  509. raise PackagerError()
  510. return PackagerFactory.IntPackager.pack(self, unpacked_data)
  511. def is_non_zero(self):
  512. return True
  513. class FloatPackager(IPackager):
  514. def pack(self, unpacked_data):
  515. if not isinstance(unpacked_data, float):
  516. raise PackagerError()
  517. return str(unpacked_data)
  518. def unpack(self, packed_data):
  519. try:
  520. return float(packed_data)
  521. except ValueError:
  522. raise PackagerError()
  523. def get_sql_type(self):
  524. return "real"
  525. def get_python_type(self):
  526. return float
  527. class FloatNonZeroPackager(FloatPackager):
  528. def pack(self, unpacked_data):
  529. if unpacked_data == 0:
  530. raise PackagerError()
  531. return PackagerFactory.FloatPackager.pack(self, unpacked_data)
  532. def is_non_zero(self):
  533. return True
  534. class StringPackager(IPackager):
  535. def pack(self, unpacked_data):
  536. if not isinstance(unpacked_data, str):
  537. raise PackagerError()
  538. return str(unpacked_data)
  539. def unpack(self, packed_data):
  540. try:
  541. return str(packed_data)
  542. except ValueError:
  543. raise PackagerError()
  544. def get_sql_type(self):
  545. return "text"
  546. def get_python_type(self):
  547. return str
  548. class SkipPackager(IPackager):
  549. def pack(self, unpacked_data):
  550. return None
  551. def unpack(self, packed_data):
  552. return None
  553. def get_sql_type(self):
  554. return None
  555. def get_python_type(self):
  556. return None
  557. ####################################
  558. # Loader
  559. ####################################
  560. class NamespaceError(Exception):
  561. def __init__(self, namespace, reason):
  562. Exception.__init__(self, "Namespace '"
  563. + namespace
  564. + "': '"
  565. + reason
  566. + "'")
  567. class FieldError(Exception):
  568. def __init__(self, field, reason):
  569. Exception.__init__(self, "Field '"
  570. + field
  571. + "': '"
  572. + reason
  573. + "'")
  574. class Namespace(object):
  575. def __init__(self, db_handle, name, support_regions = False, version='1.0'):
  576. if not isinstance(name, str):
  577. raise NamespaceError(name, "name not a string")
  578. self.name = name
  579. self.support_regions = support_regions
  580. self.fields = {}
  581. self.db = db_handle
  582. if self.db.check_table(name) == False:
  583. self.db.create_table(name, support_regions, version)
  584. else:
  585. for column in self.db.iterate_columns(name):
  586. self.add_field(column.name, PackagerFactory().get_python_type(column.sql_type), non_zero=column.non_zero)
  587. def get_name(self):
  588. return self.name
  589. def are_regions_supported(self):
  590. return self.support_regions
  591. def add_field(self, field_name, python_type, non_zero=False):
  592. if not isinstance(field_name, str):
  593. raise FieldError(field_name, "field_name not a string")
  594. packager = PackagerFactory().create(python_type, non_zero)
  595. if field_name in self.fields.keys():
  596. raise FieldError(field_name, "double used")
  597. self.fields[field_name] = packager
  598. if self.db.check_column(self.get_name(), field_name) == False:
  599. # - False if cloned
  600. # - True if created
  601. return self.db.create_column(self.name, field_name, packager.get_sql_type(), non_zero=non_zero)
  602. return None # if double request
  603. def iterate_field_names(self):
  604. for name in self.fields.keys():
  605. yield name
  606. def get_field_packager(self, field_name):
  607. if field_name in self.fields.keys():
  608. return self.fields[field_name]
  609. else:
  610. return None
  611. def get_field_sql_type(self, field_name):
  612. return self.get_field_packager(field_name).get_sql_type()
  613. def get_field_python_type(self, field_name):
  614. return self.get_field_packager(field_name).get_python_type()
  615. class DataNotPackable(Exception):
  616. def __init__(self, namespace, field, value, packager, extra_message):
  617. Exception.__init__(self, "Data '"
  618. + str(value)
  619. + "' of type "
  620. + str(value.__class__)
  621. + " referred by '"
  622. + namespace
  623. + "=>"
  624. + field
  625. + "' is not packable by registered packager '"
  626. + str(packager.__class__)
  627. + "': " + extra_message)
  628. class Loader(object):
  629. def __init__(self):
  630. self.namespaces = {}
  631. self.db = None
  632. self.last_file_data = None # for performance boost reasons
  633. def create_database(self, dbfile, previous_db = None):
  634. self.db = core.db.sqlite.Database()
  635. if os.path.exists(dbfile):
  636. logging.warn("Removing existing file: " + dbfile)
  637. # TODO can reuse existing db file to speed up the processing?
  638. # TODO add option to choose to remove or to overwrite?
  639. os.unlink(dbfile)
  640. if previous_db != None and os.path.exists(previous_db) == False:
  641. raise core.api.ExitError(None, "Database file '" + previous_db + "' does not exist")
  642. self.db.create(dbfile, clone_from=previous_db)
  643. def open_database(self, dbfile, read_only = True):
  644. self.db = core.db.sqlite.Database()
  645. if os.path.exists(dbfile) == False:
  646. raise core.api.ExitError(None, "Database file '" + dbfile + "' does not exist")
  647. self.db.connect(dbfile, read_only=read_only)
  648. for table in self.db.iterate_tables():
  649. self.create_namespace(table.name, table.support_regions)
  650. def set_property(self, property_name, value):
  651. if self.db == None:
  652. return None
  653. return self.db.set_property(property_name, value)
  654. def get_property(self, property_name):
  655. if self.db == None:
  656. return None
  657. return self.db.get_property(property_name)
  658. def iterate_properties(self):
  659. if self.db == None:
  660. return None
  661. return self.db.iterate_properties()
  662. def create_namespace(self, name, support_regions = False, version='1.0'):
  663. if self.db == None:
  664. return None
  665. if name in self.namespaces.keys():
  666. raise NamespaceError(name, "double used")
  667. new_namespace = Namespace(self.db, name, support_regions, version)
  668. self.namespaces[name] = new_namespace
  669. return new_namespace
  670. def iterate_namespace_names(self):
  671. for name in self.namespaces.keys():
  672. yield name
  673. def get_namespace(self, name):
  674. if name in self.namespaces.keys():
  675. return self.namespaces[name]
  676. else:
  677. return None
  678. def create_file_data(self, path, checksum, content):
  679. if self.db == None:
  680. return None
  681. (new_id, is_updated) = self.db.create_file(path, checksum)
  682. result = FileData(self, path, new_id, checksum, content)
  683. self.last_file_data = result
  684. return (result, is_updated)
  685. def load_file_data(self, path):
  686. if self.db == None:
  687. return None
  688. if self.last_file_data != None and self.last_file_data.get_path() == path:
  689. return self.last_file_data
  690. data = self.db.get_file(path)
  691. if data == None:
  692. return None
  693. result = FileData(self, data.path, data.id, data.checksum, None)
  694. self.last_file_data = result
  695. return result
  696. def save_file_data(self, file_data):
  697. if self.db == None:
  698. return None
  699. class DataIterator(object):
  700. def iterate_packed_values(self, data, namespace, support_regions = False):
  701. for each in data.iterate_fields(namespace):
  702. space = self.loader.get_namespace(namespace)
  703. if space == None:
  704. raise DataNotPackable(namespace, each[0], each[1], None, "The namespace has not been found")
  705. packager = space.get_field_packager(each[0])
  706. if packager == None:
  707. raise DataNotPackable(namespace, each[0], each[1], None, "The field has not been found")
  708. if space.support_regions != support_regions:
  709. raise DataNotPackable(namespace, each[0], each[1], packager, "Incompatible support for regions")
  710. try:
  711. packed_data = packager.pack(each[1])
  712. if packed_data == None:
  713. continue
  714. except PackagerError:
  715. raise DataNotPackable(namespace, each[0], each[1], packager, "Packager raised exception")
  716. yield (each[0], packed_data)
  717. def __init__(self, loader, data, namespace, support_regions = False):
  718. self.loader = loader
  719. self.iterator = self.iterate_packed_values(data, namespace, support_regions)
  720. def __iter__(self):
  721. return self.iterator
  722. for namespace in file_data.iterate_namespaces():
  723. if file_data.is_namespace_updated(namespace) == False:
  724. continue
  725. self.db.add_row(namespace,
  726. file_data.get_id(),
  727. None,
  728. DataIterator(self, file_data, namespace))
  729. if file_data.are_regions_loaded():
  730. for region in file_data.iterate_regions():
  731. for namespace in region.iterate_namespaces():
  732. if region.is_namespace_updated(namespace) == False:
  733. continue
  734. self.db.add_row(namespace,
  735. file_data.get_id(),
  736. region.get_id(),
  737. DataIterator(self, region, namespace, support_regions = True))
  738. def iterate_file_data(self, path = None, path_like_filter = "%"):
  739. if self.db == None:
  740. return None
  741. final_path_like = path_like_filter
  742. if path != None:
  743. if self.db.check_dir(path) == False and self.db.check_file(path) == False:
  744. return None
  745. final_path_like = path + path_like_filter
  746. class FileDataIterator(object):
  747. def iterate_file_data(self, loader, final_path_like):
  748. for data in loader.db.iterate_files(path_like=final_path_like):
  749. yield FileData(loader, data.path, data.id, data.checksum, None)
  750. def __init__(self, loader, final_path_like):
  751. self.iterator = self.iterate_file_data(loader, final_path_like)
  752. def __iter__(self):
  753. return self.iterator
  754. if self.db == None:
  755. return None
  756. return FileDataIterator(self, final_path_like)
  757. def load_aggregated_data(self, path = None, path_like_filter = "%", namespaces = None):
  758. if self.db == None:
  759. return None
  760. final_path_like = path_like_filter
  761. if path != None:
  762. if self.db.check_dir(path) == False and self.db.check_file(path) == False:
  763. return None
  764. final_path_like = path + path_like_filter
  765. if namespaces == None:
  766. namespaces = self.namespaces.keys()
  767. result = AggregatedData(self, path)
  768. for name in namespaces:
  769. namespace = self.get_namespace(name)
  770. data = self.db.aggregate_rows(name, path_like = final_path_like)
  771. for field in data.keys():
  772. if namespace.get_field_packager(field).get_python_type() == str:
  773. continue
  774. if namespace.get_field_packager(field).is_non_zero() == True:
  775. data[field]['min'] = None
  776. data[field]['avg'] = None
  777. distribution = self.db.count_rows(name, path_like = final_path_like, group_by_column = field)
  778. data[field]['distribution-bars'] = []
  779. for each in distribution:
  780. if each[0] == None:
  781. continue
  782. assert(float(data[field]['count'] != 0))
  783. data[field]['distribution-bars'].append({'metric': each[0],
  784. 'count': each[1],
  785. 'ratio': round((float(each[1]) / float(data[field]['count'])), 4)})
  786. result.set_data(name, field, data[field])
  787. return result
  788. def load_selected_data(self, namespace, fields = None, path = None, path_like_filter = "%", filters = [],
  789. sort_by = None, limit_by = None):
  790. if self.db == None:
  791. return None
  792. final_path_like = path_like_filter
  793. if path != None:
  794. if self.db.check_dir(path) == False and self.db.check_file(path) == False:
  795. return None
  796. final_path_like = path + path_like_filter
  797. namespace_obj = self.get_namespace(namespace)
  798. if namespace_obj == None:
  799. return None
  800. class SelectDataIterator(object):
  801. def iterate_selected_values(self, loader, namespace_obj, final_path_like, fields, filters, sort_by, limit_by):
  802. for row in loader.db.select_rows(namespace_obj.get_name(), path_like=final_path_like, filters=filters,
  803. order_by=sort_by, limit_by=limit_by):
  804. region_id = None
  805. if namespace_obj.are_regions_supported() == True:
  806. region_id = row['region_id']
  807. data = SelectData(loader, row['path'], row['id'], region_id)
  808. field_names = fields
  809. if fields == None:
  810. field_names = namespace_obj.iterate_field_names()
  811. for field in field_names:
  812. data.set_data(namespace, field, row[field])
  813. yield data
  814. def __init__(self, loader, namespace_obj, final_path_like, fields, filters, sort_by, limit_by):
  815. self.iterator = self.iterate_selected_values(loader, namespace_obj, final_path_like, fields, filters, sort_by, limit_by)
  816. def __iter__(self):
  817. return self.iterator
  818. return SelectDataIterator(self, namespace_obj, final_path_like, fields, filters, sort_by, limit_by)