<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" /> <meta name="generator" content="pdoc 0.6.3" /> <title>onionr.httpapi.miscclientapi.staticfiles API documentation</title> <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"> <style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.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%}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{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@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}.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{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.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%}.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%}#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> </head> <body> <main> <article id="content"> <header> <h1 class="title">Module <code>onionr.httpapi.miscclientapi.staticfiles</code></h1> </header> <section id="section-intro"> <p>Onionr - Private P2P Communication</p> <p>Register static file routes</p> <details class="source"> <summary>Source code</summary> <pre><code class="python">''' Onionr - Private P2P Communication Register static file routes ''' ''' 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/>. ''' import os import mimetypes from flask import Blueprint, send_from_directory # Was having some mime type issues on windows, this appeared to fix it. # we have no-sniff set, so if the mime types are invalid sripts can't load. mimetypes.add_type('application/javascript', '.js') mimetypes.add_type('text/css', '.css') static_files_bp = Blueprint('staticfiles', __name__) root = os.path.dirname(os.path.realpath(__file__)) + '/../../../static-data/www/' # should be set to onionr install directory from onionr startup @static_files_bp.route('/chat/', endpoint='chatIndex') def chat_index(): return send_from_directory(root + 'chat/', "index.html") @static_files_bp.route('/chat/<path:path>', endpoint='chat') def load_chat(path): return send_from_directory(root + 'chat/', path) @static_files_bp.route('/board/', endpoint='board') def loadBoard(): return send_from_directory(root + 'board/', "index.html") @static_files_bp.route('/mail/<path:path>', endpoint='mail') def loadMail(path): return send_from_directory(root + 'mail/', path) @static_files_bp.route('/mail/', endpoint='mailindex') def loadMailIndex(): return send_from_directory(root + 'mail/', 'index.html') @static_files_bp.route('/friends/<path:path>', endpoint='friends') def loadContacts(path): return send_from_directory(root + 'friends/', path) @static_files_bp.route('/friends/', endpoint='friendsindex') def loadContacts(): return send_from_directory(root + 'friends/', 'index.html') @static_files_bp.route('/profiles/<path:path>', endpoint='profiles') def loadContacts(path): return send_from_directory(root + 'profiles/', path) @static_files_bp.route('/profiles/', endpoint='profilesindex') def loadContacts(): return send_from_directory(root + 'profiles/', 'index.html') @static_files_bp.route('/board/<path:path>', endpoint='boardContent') def boardContent(path): return send_from_directory(root + 'board/', path) @static_files_bp.route('/shared/<path:path>', endpoint='sharedContent') def sharedContent(path): return send_from_directory(root + 'shared/', path) @static_files_bp.route('/', endpoint='onionrhome') def hello(): # ui home return send_from_directory(root + 'private/', 'index.html') @static_files_bp.route('/private/<path:path>', endpoint='homedata') def homedata(path): return send_from_directory(root + 'private/', path)</code></pre> </details> </section> <section> </section> <section> </section> <section> <h2 class="section-title" id="header-functions">Functions</h2> <dl> <dt id="onionr.httpapi.miscclientapi.staticfiles.boardContent"><code class="name flex"> <span>def <span class="ident">boardContent</span></span>(<span>path)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/board/<path:path>', endpoint='boardContent') def boardContent(path): return send_from_directory(root + 'board/', path)</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.chat_index"><code class="name flex"> <span>def <span class="ident">chat_index</span></span>(<span>)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/chat/', endpoint='chatIndex') def chat_index(): return send_from_directory(root + 'chat/', "index.html")</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.hello"><code class="name flex"> <span>def <span class="ident">hello</span></span>(<span>)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/', endpoint='onionrhome') def hello(): # ui home return send_from_directory(root + 'private/', 'index.html')</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.homedata"><code class="name flex"> <span>def <span class="ident">homedata</span></span>(<span>path)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/private/<path:path>', endpoint='homedata') def homedata(path): return send_from_directory(root + 'private/', path)</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.loadBoard"><code class="name flex"> <span>def <span class="ident">loadBoard</span></span>(<span>)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/board/', endpoint='board') def loadBoard(): return send_from_directory(root + 'board/', "index.html")</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.loadContacts"><code class="name flex"> <span>def <span class="ident">loadContacts</span></span>(<span>)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/profiles/', endpoint='profilesindex') def loadContacts(): return send_from_directory(root + 'profiles/', 'index.html')</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.loadMail"><code class="name flex"> <span>def <span class="ident">loadMail</span></span>(<span>path)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/mail/<path:path>', endpoint='mail') def loadMail(path): return send_from_directory(root + 'mail/', path)</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.loadMailIndex"><code class="name flex"> <span>def <span class="ident">loadMailIndex</span></span>(<span>)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/mail/', endpoint='mailindex') def loadMailIndex(): return send_from_directory(root + 'mail/', 'index.html')</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.load_chat"><code class="name flex"> <span>def <span class="ident">load_chat</span></span>(<span>path)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/chat/<path:path>', endpoint='chat') def load_chat(path): return send_from_directory(root + 'chat/', path)</code></pre> </details> </dd> <dt id="onionr.httpapi.miscclientapi.staticfiles.sharedContent"><code class="name flex"> <span>def <span class="ident">sharedContent</span></span>(<span>path)</span> </code></dt> <dd> <section class="desc"></section> <details class="source"> <summary>Source code</summary> <pre><code class="python">@static_files_bp.route('/shared/<path:path>', endpoint='sharedContent') def sharedContent(path): return send_from_directory(root + 'shared/', path)</code></pre> </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> <li><code><a title="onionr.httpapi.miscclientapi" href="index.html">onionr.httpapi.miscclientapi</a></code></li> </ul> </li> <li><h3><a href="#header-functions">Functions</a></h3> <ul class="two-column"> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.boardContent" href="#onionr.httpapi.miscclientapi.staticfiles.boardContent">boardContent</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.chat_index" href="#onionr.httpapi.miscclientapi.staticfiles.chat_index">chat_index</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.hello" href="#onionr.httpapi.miscclientapi.staticfiles.hello">hello</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.homedata" href="#onionr.httpapi.miscclientapi.staticfiles.homedata">homedata</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.loadBoard" href="#onionr.httpapi.miscclientapi.staticfiles.loadBoard">loadBoard</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.loadContacts" href="#onionr.httpapi.miscclientapi.staticfiles.loadContacts">loadContacts</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.loadMail" href="#onionr.httpapi.miscclientapi.staticfiles.loadMail">loadMail</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.loadMailIndex" href="#onionr.httpapi.miscclientapi.staticfiles.loadMailIndex">loadMailIndex</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.load_chat" href="#onionr.httpapi.miscclientapi.staticfiles.load_chat">load_chat</a></code></li> <li><code><a title="onionr.httpapi.miscclientapi.staticfiles.sharedContent" href="#onionr.httpapi.miscclientapi.staticfiles.sharedContent">sharedContent</a></code></li> </ul> </li> </ul> </nav> </main> <footer id="footer"> <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.3</a>.</p> </footer> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script> <script>hljs.initHighlightingOnLoad()</script> </body> </html>