2019-09-23 23:20:14 +00:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1, minimum-scale=1" / >
2020-02-04 20:46:17 +00:00
< meta name = "generator" content = "pdoc 0.7.4" / >
< title > src.onionrblocks.blockimporter API documentation< / title >
2019-09-23 23:20:14 +00:00
< meta name = "description" content = "Onionr - Private P2P Communication …" / >
< link href = 'https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel = 'stylesheet' >
< link href = 'https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel = 'stylesheet' >
< link href = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel = "stylesheet" >
2020-02-04 20:46:17 +00:00
< style > . flex { display : flex !important } body { line-height : 1.5 em } # content { padding : 20 px } # sidebar { padding : 30 px ; overflow : hidden } . http-server-breadcrumbs { font-size : 130 % ; margin : 0 0 15 px 0 } # footer { font-size : .75 em ; padding : 5 px 30 px ; border-top : 1 px solid #ddd ; text-align : right } # footer p { margin : 0 0 0 1 em ; display : inline-block } # footer p : last-child { margin-right : 30 px } h1 , h2 , h3 , h4 , h5 { font-weight : 300 } h1 { font-size : 2.5 em ; line-height : 1.1 em } h2 { font-size : 1.75 em ; margin : 1 em 0 .50 em 0 } h3 { font-size : 1.4 em ; margin : 25 px 0 10 px 0 } h4 { margin : 0 ; font-size : 105 % } a { color : #058 ; text-decoration : none ; transition : color .3 s ease-in-out } a : hover { color : #e82 } . title code { font-weight : bold } h2 [ id ^ = "header-" ] { margin-top : 2 em } . ident { color : #900 } pre code { background : #f8f8f8 ; font-size : .8 em ; line-height : 1.4 em } code { background : #f2f2f1 ; padding : 1 px 4 px ; overflow-wrap : break-word } h1 code { background : transparent } pre { background : #f8f8f8 ; border : 0 ; border-top : 1 px solid #ccc ; border-bottom : 1 px solid #ccc ; margin : 1 em 0 ; padding : 1 ex } # http-server-module-list { display : flex ; flex-flow : column } # http-server-module-list div { display : flex } # http-server-module-list dt { min-width : 10 % } # http-server-module-list p { margin-top : 0 } . toc ul , # index { list-style-type : none ; margin : 0 ; padding : 0 } # index code { background : transparent } # index h3 { border-bottom : 1 px solid #ddd } # index ul { padding : 0 } # index h4 { font-weight : bold } # index h4 + ul { margin-bottom : .6 em } @ media ( min-width : 200ex ) { # index . two-column { column-count : 2 } } @ media ( min-width : 300ex ) { # index . two-column { column-count : 3 } } dl { margin-bottom : 2 em } dl dl : last-child { margin-bottom : 4 em } dd { margin : 0 0 1 em 3 em } # header-classes + dl > dd { margin-bottom : 3 em } dd dd { margin-left : 2 em } dd p { margin : 10 px 0 } . name { background : #eee ; font-weight : bold ; font-size : .85 em ; padding : 5 px 10 px ; display : inline-block ; min-width : 40 % } . name : hover { background : #e0e0e0 } . name > span : first-child { white-space : nowrap } . name . class > span : nth-child ( 2 ) { margin-left : .4 em } . inherited { color : #999 ; border-left : 5 px solid #eee ; padding-left : 1 em } . inheritance em { font-style : normal ; font-weight : bold } . desc h2 { font-weight : 400 ; font-size : 1.25 em } . desc h3 { font-size : 1 em } . desc dt code { background : inherit } . source summary , . git-link-div { color : #666 ; text-align : right ; font-weight : 400 ; font-size : .8 em ; text-transform : uppercase } . source summary > * { white-space : nowrap ; cursor : pointer } . git-link { color : inherit ; margin-left : 1 em } . source pre { max-height : 500 px ; overflow : auto ; margin : 0 } . source pre code { font-size : 12 px ; overflow : visible } . hlist { list-style : none } . hlist li { display : inline } . hlist li : after { content : ',\2002' } . hlist li : last-child : after { content : none } . hlist . hlist { display : inline ; padding-left : 1 em } img { max-width : 100 % } . admonition { padding : .1 em .5 em ; margin-bottom : 1 em } . admonition-title { font-weight : bold } . admonition . note , . admonition . info , . admonition . important { background : #aef } . admonition . todo , . admonition . versionadded , . admonition . tip , . admonition . hint { background : #dfd } . admonition . warning , . admonition . versionchanged , . admonition . deprecated { background : #fd4 } . admonition . error , . admonition . danger , . admonition . caution { background : lightpink } < / style >
2019-09-23 23:20:14 +00:00
< style media = "screen and (min-width: 700px)" > @ media screen and ( min-width : 700px ) { # sidebar { width : 30 % } # content { width : 70 % ; max-width : 100 ch ; padding : 3 em 4 em ; border-left : 1 px solid #ddd } pre code { font-size : 1 em } . item . name { font-size : 1 em } main { display : flex ; flex-direction : row-reverse ; justify-content : flex-end } . toc ul ul , # index ul { padding-left : 1.5 em } . toc > ul > li { margin-top : .5 em } } < / style >
< style media = "print" > @ media print { # sidebar h1 { page-break-before : always } . source { display : none } } @ media print { * { background : transparent !important ; color : #000 !important ; box-shadow : none !important ; text-shadow : none !important } a [ href ] : after { content : " (" attr ( href ) ")" ; font-size : 90 % } a [ href ] [ title ] : after { content : none } abbr [ title ] : after { content : " (" attr ( title ) ")" } . ir a : after , a [ href ^ = "javascript:" ] : after , a [ href ^ = "#" ] : after { content : "" } pre , blockquote { border : 1 px solid #999 ; page-break-inside : avoid } thead { display : table-header-group } tr , img { page-break-inside : avoid } img { max-width : 100 % !important } @ page { margin : 0 . 5cm } p , h2 , h3 { orphans : 3 ; widows : 3 } h1 , h2 , h3 , h4 , h5 , h6 { page-break-after : avoid } } < / style >
< / head >
< body >
< main >
< article id = "content" >
< header >
2020-02-04 20:46:17 +00:00
< h1 class = "title" > Module < code > src.onionrblocks.blockimporter< / code > < / h1 >
2019-09-23 23:20:14 +00:00
< / header >
< section id = "section-intro" >
< p > Onionr - Private P2P Communication< / p >
< p > Import block data and save it< / p >
< details class = "source" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
2019-09-23 23:20:14 +00:00
< pre > < code class = "python" > ' ' '
Onionr - Private P2P Communication
Import block data and save it
' ' '
2020-02-04 20:46:17 +00:00
from onionrexceptions import BlacklistedBlock
from onionrexceptions import DiskAllocationReached
from onionrexceptions import InvalidProof
from onionrexceptions import InvalidMetadata
import logger
from onionrutils import validatemetadata
from onionrutils import blockmetadata
from coredb import blockmetadb
import onionrstorage
import onionrcrypto as crypto
from . import onionrblacklist
2019-09-23 23:20:14 +00:00
' ' '
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see < https://www.gnu.org/licenses/> .
' ' '
2020-02-04 20:46:17 +00:00
def import_block_from_data(content):
2019-09-23 23:20:14 +00:00
blacklist = onionrblacklist.OnionrBlackList()
2020-02-04 20:46:17 +00:00
ret_data = False
2019-09-23 23:20:14 +00:00
try:
content = content.encode()
except AttributeError:
pass
2020-02-04 20:46:17 +00:00
data_hash = crypto.hashers.sha3_hash(content)
2019-09-23 23:20:14 +00:00
2020-02-04 20:46:17 +00:00
if blacklist.inBlacklist(data_hash):
raise BlacklistedBlock(f' %s is a blacklisted block {data_hash}' )
2019-09-23 23:20:14 +00:00
2020-02-04 20:46:17 +00:00
# returns tuple(metadata, meta), meta is also in metadata
metas = blockmetadata.get_block_metadata_from_data(content)
2019-09-23 23:20:14 +00:00
metadata = metas[0]
2020-02-04 20:46:17 +00:00
# check if metadata is valid
if validatemetadata.validate_metadata(metadata, metas[2]):
# check if POW is enough/correct
if crypto.cryptoutils.verify_POW(content):
logger.info(f' Imported block passed proof, saving: {data_hash}.' ,
terminal=True)
2019-09-23 23:20:14 +00:00
try:
blockHash = onionrstorage.set_data(content)
2020-02-04 20:46:17 +00:00
except DiskAllocationReached:
2019-09-23 23:20:14 +00:00
logger.warn(' Failed to save block due to full disk allocation' )
2020-02-04 20:46:17 +00:00
raise
2019-09-23 23:20:14 +00:00
else:
blockmetadb.add_to_block_DB(blockHash, dataSaved=True)
2020-02-04 20:46:17 +00:00
# caches block metadata values to block database
blockmetadata.process_block_metadata(blockHash)
ret_data = blockHash
2019-09-23 23:20:14 +00:00
else:
2020-02-04 20:46:17 +00:00
raise InvalidProof
else:
raise InvalidMetadata
return ret_data< / code > < / pre >
2019-09-23 23:20:14 +00:00
< / details >
< / section >
< section >
< / section >
< section >
< / section >
< section >
< h2 class = "section-title" id = "header-functions" > Functions< / h2 >
< dl >
2020-02-04 20:46:17 +00:00
< dt id = "src.onionrblocks.blockimporter.import_block_from_data" > < code class = "name flex" >
< span > def < span class = "ident" > import_block_from_data< / span > < / span > (< span > content)< / span >
2019-09-23 23:20:14 +00:00
< / code > < / dt >
< dd >
< section class = "desc" > < / section >
< details class = "source" >
2020-02-04 20:46:17 +00:00
< summary >
< span > Expand source code< / span >
< / summary >
< pre > < code class = "python" > def import_block_from_data(content):
2019-09-23 23:20:14 +00:00
blacklist = onionrblacklist.OnionrBlackList()
2020-02-04 20:46:17 +00:00
ret_data = False
2019-09-23 23:20:14 +00:00
try:
content = content.encode()
except AttributeError:
pass
2020-02-04 20:46:17 +00:00
data_hash = crypto.hashers.sha3_hash(content)
2019-09-23 23:20:14 +00:00
2020-02-04 20:46:17 +00:00
if blacklist.inBlacklist(data_hash):
raise BlacklistedBlock(f' %s is a blacklisted block {data_hash}' )
2019-09-23 23:20:14 +00:00
2020-02-04 20:46:17 +00:00
# returns tuple(metadata, meta), meta is also in metadata
metas = blockmetadata.get_block_metadata_from_data(content)
2019-09-23 23:20:14 +00:00
metadata = metas[0]
2020-02-04 20:46:17 +00:00
# check if metadata is valid
if validatemetadata.validate_metadata(metadata, metas[2]):
# check if POW is enough/correct
if crypto.cryptoutils.verify_POW(content):
logger.info(f' Imported block passed proof, saving: {data_hash}.' ,
terminal=True)
2019-09-23 23:20:14 +00:00
try:
blockHash = onionrstorage.set_data(content)
2020-02-04 20:46:17 +00:00
except DiskAllocationReached:
2019-09-23 23:20:14 +00:00
logger.warn(' Failed to save block due to full disk allocation' )
2020-02-04 20:46:17 +00:00
raise
2019-09-23 23:20:14 +00:00
else:
blockmetadb.add_to_block_DB(blockHash, dataSaved=True)
2020-02-04 20:46:17 +00:00
# caches block metadata values to block database
blockmetadata.process_block_metadata(blockHash)
ret_data = blockHash
2019-09-23 23:20:14 +00:00
else:
2020-02-04 20:46:17 +00:00
raise InvalidProof
else:
raise InvalidMetadata
return ret_data< / code > < / pre >
2019-09-23 23:20:14 +00:00
< / details >
< / dd >
< / dl >
< / section >
< section >
< / section >
< / article >
< nav id = "sidebar" >
< h1 > Index< / h1 >
< div class = "toc" >
< ul > < / ul >
< / div >
< ul id = "index" >
< li > < h3 > Super-module< / h3 >
< ul >
2020-02-04 20:46:17 +00:00
< li > < code > < a title = "src.onionrblocks" href = "index.html" > src.onionrblocks< / a > < / code > < / li >
2019-09-23 23:20:14 +00:00
< / ul >
< / li >
< li > < h3 > < a href = "#header-functions" > Functions< / a > < / h3 >
< ul class = "" >
2020-02-04 20:46:17 +00:00
< li > < code > < a title = "src.onionrblocks.blockimporter.import_block_from_data" href = "#src.onionrblocks.blockimporter.import_block_from_data" > import_block_from_data< / a > < / code > < / li >
2019-09-23 23:20:14 +00:00
< / ul >
< / li >
< / ul >
< / nav >
< / main >
< footer id = "footer" >
2020-02-04 20:46:17 +00:00
< p > Generated by < a href = "https://pdoc3.github.io/pdoc" > < cite > pdoc< / cite > 0.7.4< / a > .< / p >
2019-09-23 23:20:14 +00:00
< / footer >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js" > < / script >
< script > hljs . initHighlightingOnLoad ( ) < / script >
< / body >
< / html >
