Add stats page and stub admin tools page.

doc/notes/TODO

@@ -74,12 +74,15 @@
 
 # Alpha 6
 
-- [D] Optimize queries
+- [D] Optimize lookups (round 1)
 - [D] Optimize store
 - [D] Stats page
 - [W] Refactor for Python API
-- [ ] Basic admin tools
+- [D] Basic admin tools
+  - [D] Stats page
+  - [D] Stub admin tools page
 - [ ] Better management of path segments
+- [ ] Optimize SPARQL
 
 # Alpha 7
 

lakesuperior/endpoints/admin.py

@@ -0,0 +1,53 @@
+import logging
+
+from flask import Blueprint, current_app, g, request, render_template
+
+from lakesuperior.store_layouts.ldp_rs.lmdb_store import TxnManager
+
+# Admin interface and API.
+
+logger = logging.getLogger(__name__)
+
+admin = Blueprint('admin', __name__)
+
+
+@admin.route('/stats', methods=['GET'])
+def stats():
+    '''
+    Get repository statistics.
+    '''
+    def fsize_fmt(num, suffix='B'):
+        '''
+        Format an integer into 1024-block file size format.
+
+        Adapted from Python 2 code on
+        https://stackoverflow.com/a/1094933/3758232
+
+        @param num (int) Size value in bytes.
+        @param suffix (string) Suffix label (defaults to `B`).
+
+        @return string Formatted size to largest fitting unit.
+        '''
+        for unit in ['','K','M','G','T','P','E','Z']:
+            if abs(num) < 1024.0:
+                return "{:3.1f} {}{}".format(num, unit, suffix)
+            num /= 1024.0
+        return "{:.1f} {}{}".format(num, 'Y', suffix)
+
+    store = current_app.rdfly.store
+    with TxnManager(store) as txn:
+        store_stats = store.stats()
+    rsrc_stats = current_app.rdfly.count_rsrc()
+    return render_template(
+            'stats.html', rsrc_stats=rsrc_stats, store_stats=store_stats,
+            fsize_fmt=fsize_fmt)
+
+
+@admin.route('/tools', methods=['GET'])
+def admin_tools():
+    '''
+    Admin tools.
+
+    @TODO stub.
+    '''
+    return render_template('admin_tools.html')

lakesuperior/endpoints/templates/admin_tools.html

@@ -0,0 +1,14 @@
+{% extends 'base.html' %}
+{% block extra_js %}
+{% endblock %}
+{% block title %}Administrative Tools{% endblock %}
+{% block content %}
+    <p>This is a stub page which will contain administrative tools in the future.</p>
+    <p>Examples of tools may include:</p>
+    <p><ul>
+        <li>Health checks: fixity, consistency, etc.</li>
+        <li>Backup &amp; restore utilities</li>
+        <li>Import &amp; export utilities</li>
+    </ul></p>
+    <p>See you later.</p>
+{% endblock %}

lakesuperior/endpoints/templates/stats.html

@@ -0,0 +1,57 @@
+{% extends 'base.html' %}
+{% block extra_js %}
+{% endblock %}
+{% block title %}System Statistics{% endblock %}
+{% block content %}
+    <h2>Repository</h2>
+    <p>Current resources: <strong>{{ '{:,}'.format(rsrc_stats['main']) }}</strong></p>
+    <p>Historic snapshots: <strong>{{ '{:,}'.format(rsrc_stats['hist']) }}</strong></p>
+    <p>Triples: <strong>{{ '{:,}'.format(store_stats['num_triples']) }}</strong></p>
+    <h2>LMDB Store</h2>
+    <p>Overall size on disk: <strong>{{ fsize_fmt(
+        store_stats['idx_db_size'] + store_stats['data_db_size']
+    )}}</strong></p>
+    <h3>Data</h3>
+    <p>Size on disk: <strong>{{ fsize_fmt(store_stats['data_db_size']) }}</strong></p>
+    <p>Refer to the <a href="http://lmdb.readthedocs.io/en/release/#lmdb.Environment.stat">LMDB API documentation</a> for details about the parameters below.</p>
+    {% for db_label, db in store_stats['data_db_stats'].items() %}
+    <h4>{{ db_label }}</h4>
+    <table class="table table-striped">
+        <thead>
+            <tr>
+                <td>Property</td>
+                <td>Value</td>
+            </tr>
+        </thead>
+        <tbody>
+        {% for p, v in db.items() | sort %}
+            <tr>
+                <td>{{ p }}</td>
+                <td>{{ v }}</td>
+            </tr>
+        {% endfor %}
+        </tbody>
+    </table>
+    {% endfor %}
+    <h3>Indices</h3>
+    <p>Size on disk: <strong>{{ fsize_fmt(store_stats['idx_db_size']) }}</strong></p>
+    {% for db_label, db in store_stats['idx_db_stats'].items() %}
+    <h4>{{ db_label }}</h4>
+    <table class="table table-striped">
+        <thead>
+            <tr>
+                <td>Property</td>
+                <td>Value</td>
+            </tr>
+        </thead>
+        <tbody>
+        {% for p, v in db.items() | sort %}
+            <tr>
+                <td>{{ p }}</td>
+                <td>{{ v }}</td>
+            </tr>
+        {% endfor %}
+        </tbody>
+    </table>
+    {% endfor %}
+{% endblock %}