Skip to content

Home

Jump to bottom
dim5x edited this page Jan 19, 2022 · 3 revisions

<!doctype html>

<title>web_view API documentation</title> <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#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:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;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:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.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> <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</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:1px 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> <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script> <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>

Module web_view

Модуль для отображения текущего состояния, лога, управления маками.

Expand source code 
# This Python file uses the following encoding: utf-8
"""Модуль для отображения текущего состояния, лога, управления маками."""
import pdoc
from configparser import ConfigParser
import hashlib
from flask import Flask, render_template, request, redirect, session
import test
import db_management

app = Flask(name)
app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'  # для работы session


login: str = ''


Страница логина.


@app.route('/', methods=['POST', 'GET'])
def login_admin():
"""
Обрабатывает логин в систему. Считывает с формы логин/пароль (index.html).


Проверяет в базе наличие хэша пароля. В случае успеха делает редирект на основную страницу.
Помечает успешный залогин в кукисе session[login] = login.
В противном случае - пишет Fail и отображает страницу ввода пароля снова.
&#34;&#34;&#34;
session.clear()
global login
if request.method == &#39;POST&#39;:
    login = request.form.get(&#39;login&#39;)
    password = request.form.get(&#39;password&#39;)

    password_hash = hashlib.sha3_384(bytes(password, encoding=&#39;UTF-8&#39;)).hexdigest()

    if db_management.flask_logon(login, password_hash):
        session[login] = login
        return redirect(&#39;/alerter.html&#39;)
    else:
        return render_template(&#39;index.html&#39;, message=&#39;Fail.&#39;)
return render_template(&#39;index.html&#39;)



Главная страница.


@app.route('/alerter.html', methods=['POST', 'GET'])
def hello_world():
"""Отображает информацию из БД, в том случае, если осуществлен удачный логин."""
if login in session:
data = db_management.get_events()
state = db_management.get_current_state()


    allow_mac = db_management.get_mac(&#39;wellknown&#39;)
    disallow_mac = db_management.get_mac(&#39;unknown&#39;)

    return render_template(&#39;alerter.html&#39;, data=data, state=state, allow_mac=allow_mac,
                           disallow_mac=disallow_mac, login=login)
return &#34;&#34;&#34;
&lt;style&gt; * {background: black; text-align:center; color: white;} a {color:blue;}&lt;/style&gt;
&lt;h2&gt;You are not &lt;a href=&#34;/&#34;&gt;logged in.&lt;/a&gt;&lt;/h2&gt;
&#34;&#34;&#34;



Заглушка страницы добавления хороших маков.


@app.route('/add_allow_mac.html', methods=['POST', 'GET'])
def add_allow_mac():
"""
Добавляет мак в доверенные, в том случае, если успешен залогин.


В качестве автора - проставляется тот, кто залогинился в систему.
&#34;&#34;&#34;
editing_mac = request.args.get(&#39;editing_mac&#39;, &#39;&#39;)
allow_mac = db_management.get_mac(&#39;wellknown&#39;)
if login in session:
    if request.method == &#39;POST&#39;:
        if request.form[&#39;button&#39;] == &#39;Добавить&#39;:
            mac = request.form[&#39;field&#39;]
            description = request.form[&#39;description&#39;]
            db_management.set_mac_to_wellknown(mac, login, description)
            allow_mac = db_management.get_mac(&#39;wellknown&#39;)
            return render_template(&#39;add_allow_mac.html&#39;, allow_mac=allow_mac)
            # return redirect(&#39;/alerter&#39;)
else:
    return redirect(&#39;/&#39;)
return render_template(&#39;add_allow_mac.html&#39;, allow_mac=allow_mac, editing_mac=editing_mac)



Заглушка страницы добавления плохих маков.


@app.route('/add_disallow_mac.html', methods=['POST', 'GET'])
def add_disallow_mac():
"""
Добавляет плохие маки, если успешен залогин.


Функционал сомнителен - ибо всё то же делается автоматически в БД.
Вероятно, будет удалено/изменено просто на просмотр списка.
&#34;&#34;&#34;
editing_mac = request.args.get(&#39;editing_mac&#39;, &#39;&#39;)
disallow_mac = db_management.get_mac(&#39;unknown&#39;)
if login in session:
    if request.method == &#39;POST&#39;:
        if request.form[&#39;button&#39;] == &#39;Добавить&#39;:
            mac = request.form[&#39;field&#39;]
            db_management.set_mac_to_unknown(mac, login)
            disallow_mac = db_management.get_mac(&#39;unknown&#39;)
            return render_template(&#39;add_disallow_mac.html&#39;, disallow_mac=disallow_mac)
            # return redirect(&#39;/alerter&#39;)
else:
    return redirect(&#39;/&#39;)
return render_template(&#39;add_disallow_mac.html&#39;, disallow_mac=disallow_mac,
                       editing_mac=editing_mac)



Страница регистрации нового пользователя.


@app.route('/registration', methods=['POST', 'GET'])
def registration():
"""
Осуществляет ригистрацию нового пользователя в системе.


Фунционал работы с почтой не дописан. Под вопросом.
&#34;&#34;&#34;
message = &#39;&#39;
if request.method == &#39;POST&#39;:
    # name = request.form.get(&#39;name&#39;)
    # surname = request.form.get(&#39;surname&#39;)
    wanted_login = request.form.get(&#39;wanted_login&#39;)
    # email = request.form.get(&#39;wanted_login&#39;)
    if not db_management.login_exists(wanted_login):
        return &#39;&#39;&#39;&lt;h2 style=&#34;text-align: center&#34;&gt;Отослано. Ждите и усё будет!&lt;/h2&gt;&#39;&#39;&#39;
    else:
        message = &#39;Логин занят.&#39;
        return render_template(&#39;registration.html&#39;, message=message)
return render_template(&#39;registration.html&#39;, message=message)



@app.route('/test')
def txt():
"""Для тестов."""
data = db_management.get_events()
print(data)
print(type(data))
return data


@app.route('/unit_test')
def unit_test():
"""Для юнит-теста."""
return 'Hello World!'


Страница 404.


@app.errorhandler(404)
def page_not_found(error):
"""Отображает страницу ошибки в случае перехода на несуществующую страницу."""
return render_template('404.html', error=error), 404


if name == 'main':
config = ConfigParser()
config.read('options.ini')
app.run(debug=config['FLASK']['debug'],
host=config['FLASK']['host'],
use_reloader=config['FLASK']['use_reloader'])

Functions

def add_allow_mac()

Добавляет мак в доверенные, в том случае, если успешен залогин.

В качестве автора - проставляется тот, кто залогинился в систему.

Expand source code 
@app.route('/add_allow_mac.html', methods=['POST', 'GET'])
def add_allow_mac():
    """
    Добавляет мак в доверенные, в том случае, если успешен залогин.

В качестве автора - проставляется тот, кто залогинился в систему.
&#34;&#34;&#34;
editing_mac = request.args.get(&#39;editing_mac&#39;, &#39;&#39;)
allow_mac = db_management.get_mac(&#39;wellknown&#39;)
if login in session:
    if request.method == &#39;POST&#39;:
        if request.form[&#39;button&#39;] == &#39;Добавить&#39;:
            mac = request.form[&#39;field&#39;]
            description = request.form[&#39;description&#39;]
            db_management.set_mac_to_wellknown(mac, login, description)
            allow_mac = db_management.get_mac(&#39;wellknown&#39;)
            return render_template(&#39;add_allow_mac.html&#39;, allow_mac=allow_mac)
            # return redirect(&#39;/alerter&#39;)
else:
    return redirect(&#39;/&#39;)
return render_template(&#39;add_allow_mac.html&#39;, allow_mac=allow_mac, editing_mac=editing_mac)</code></pre>
def add_disallow_mac()

Добавляет плохие маки, если успешен залогин.

Функционал сомнителен - ибо всё то же делается автоматически в БД. Вероятно, будет удалено/изменено просто на просмотр списка.

Expand source code 
@app.route('/add_disallow_mac.html', methods=['POST', 'GET'])
def add_disallow_mac():
    """
    Добавляет плохие маки, если успешен залогин.

Функционал сомнителен - ибо всё то же делается автоматически в БД.
Вероятно, будет удалено/изменено просто на просмотр списка.
&#34;&#34;&#34;
editing_mac = request.args.get(&#39;editing_mac&#39;, &#39;&#39;)
disallow_mac = db_management.get_mac(&#39;unknown&#39;)
if login in session:
    if request.method == &#39;POST&#39;:
        if request.form[&#39;button&#39;] == &#39;Добавить&#39;:
            mac = request.form[&#39;field&#39;]
            db_management.set_mac_to_unknown(mac, login)
            disallow_mac = db_management.get_mac(&#39;unknown&#39;)
            return render_template(&#39;add_disallow_mac.html&#39;, disallow_mac=disallow_mac)
            # return redirect(&#39;/alerter&#39;)
else:
    return redirect(&#39;/&#39;)
return render_template(&#39;add_disallow_mac.html&#39;, disallow_mac=disallow_mac,
                       editing_mac=editing_mac)</code></pre>
def hello_world()

Отображает информацию из БД, в том случае, если осуществлен удачный логин.

Expand source code 
@app.route('/alerter.html', methods=['POST', 'GET'])
def hello_world():
    """Отображает информацию из БД, в том случае, если осуществлен удачный логин."""
    if login in session:
        data = db_management.get_events()
        state = db_management.get_current_state()

    allow_mac = db_management.get_mac(&#39;wellknown&#39;)
    disallow_mac = db_management.get_mac(&#39;unknown&#39;)

    return render_template(&#39;alerter.html&#39;, data=data, state=state, allow_mac=allow_mac,
                           disallow_mac=disallow_mac, login=login)
return &#34;&#34;&#34;
&lt;style&gt; * {background: black; text-align:center; color: white;} a {color:blue;}&lt;/style&gt;
&lt;h2&gt;You are not &lt;a href=&#34;/&#34;&gt;logged in.&lt;/a&gt;&lt;/h2&gt;
&#34;&#34;&#34;</code></pre>
def login_admin()

Обрабатывает логин в систему. Считывает с формы логин/пароль (index.html).

Проверяет в базе наличие хэша пароля. В случае успеха делает редирект на основную страницу. Помечает успешный залогин в кукисе session[login] = login. В противном случае - пишет Fail и отображает страницу ввода пароля снова.

Expand source code 
@app.route('/', methods=['POST', 'GET'])
def login_admin():
    """
    Обрабатывает логин в систему. Считывает с формы логин/пароль (index.html).

Проверяет в базе наличие хэша пароля. В случае успеха делает редирект на основную страницу.
Помечает успешный залогин в кукисе session[login] = login.
В противном случае - пишет Fail и отображает страницу ввода пароля снова.
&#34;&#34;&#34;
session.clear()
global login
if request.method == &#39;POST&#39;:
    login = request.form.get(&#39;login&#39;)
    password = request.form.get(&#39;password&#39;)

    password_hash = hashlib.sha3_384(bytes(password, encoding=&#39;UTF-8&#39;)).hexdigest()

    if db_management.flask_logon(login, password_hash):
        session[login] = login
        return redirect(&#39;/alerter.html&#39;)
    else:
        return render_template(&#39;index.html&#39;, message=&#39;Fail.&#39;)
return render_template(&#39;index.html&#39;)</code></pre>
def page_not_found(error)

Отображает страницу ошибки в случае перехода на несуществующую страницу.

Expand source code 
@app.errorhandler(404)
def page_not_found(error):
    """Отображает страницу ошибки в случае перехода на несуществующую страницу."""
    return render_template('404.html', error=error), 404
def registration()

Осуществляет ригистрацию нового пользователя в системе.

Фунционал работы с почтой не дописан. Под вопросом.

Expand source code 
@app.route('/registration', methods=['POST', 'GET'])
def registration():
    """
    Осуществляет ригистрацию нового пользователя в системе.

Фунционал работы с почтой не дописан. Под вопросом.
&#34;&#34;&#34;
message = &#39;&#39;
if request.method == &#39;POST&#39;:
    # name = request.form.get(&#39;name&#39;)
    # surname = request.form.get(&#39;surname&#39;)
    wanted_login = request.form.get(&#39;wanted_login&#39;)
    # email = request.form.get(&#39;wanted_login&#39;)
    if not db_management.login_exists(wanted_login):
        return &#39;&#39;&#39;&lt;h2 style=&#34;text-align: center&#34;&gt;Отослано. Ждите и усё будет!&lt;/h2&gt;&#39;&#39;&#39;
    else:
        message = &#39;Логин занят.&#39;
        return render_template(&#39;registration.html&#39;, message=message)
return render_template(&#39;registration.html&#39;, message=message)</code></pre>
def txt()

Для тестов.

Expand source code 
@app.route('/test')
def txt():
    """Для тестов."""
    data = db_management.get_events()
    print(data)
    print(type(data))
    return data
def unit_test()

Для юнит-теста.

Expand source code 
@app.route('/unit_test')
def unit_test():
    """Для юнит-теста."""
    return 'Hello World!'

Index

    Generated by pdoc 0.10.0.

    klklklklklkl6767

    lk\kk

    Clone this wiki locally