mirror of
https://github.com/beetbox/beets.git
synced 2025-12-17 22:23:16 +01:00
a28f930c52
In an attempt to finally address the longstanding SQLite locking issues, I'm introducing a way to explicitly, lexically scope transactions. The Transaction class is a context manager that always fully fetches after SELECTs and automatically commits on exit. No direct access to the library is allowed, so all changes will eventually be committed and all queries will be completed. This will also provide a debugging mechanism to show where concurrent transactions are beginning and ending. To support composition (transaction reentrancy), an internal, per-Library stack of transactions is maintained. Commits only happen when the outermost transaction exits. This means that, while it's possible to introduce atomicity bugs by invoking Library methods outside of a transaction, you can conveniently call them *without* a currently-active transaction to get a single atomic action. Note that this "transaction stack" concepts assumes a single Library object per thread. Because we need to duplicate Library objects for concurrent access due to sqlite3 limitation already, this is fine for now. Later, the interface should provide one transaction stack per thread for shared Library objects.
129 lines
3.5 KiB
Python
129 lines
3.5 KiB
Python
# This file is part of beets.
|
|
# Copyright 2011, Adrian Sampson.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
"""A Web interface to beets."""
|
|
from beets.plugins import BeetsPlugin
|
|
from beets import ui
|
|
from beets.importer import _reopen_lib
|
|
import beets.library
|
|
import flask
|
|
from flask import g
|
|
|
|
DEFAULT_HOST = ''
|
|
DEFAULT_PORT = 8337
|
|
|
|
|
|
# Utilities.
|
|
|
|
def _rep(obj):
|
|
if isinstance(obj, beets.library.Item):
|
|
out = dict(obj.record)
|
|
del out['path']
|
|
return out
|
|
elif isinstance(obj, beets.library.Album):
|
|
out = dict(obj._record)
|
|
del out['artpath']
|
|
out['items'] = [_rep(item) for item in obj.items()]
|
|
return out
|
|
|
|
|
|
# Flask setup.
|
|
|
|
app = flask.Flask(__name__)
|
|
|
|
@app.before_request
|
|
def before_request():
|
|
g.lib = _reopen_lib(app.config['lib'])
|
|
@app.teardown_request
|
|
def teardown_request(req):
|
|
g.lib.conn.close()
|
|
|
|
|
|
# Items.
|
|
|
|
@app.route('/item/<int:item_id>')
|
|
def single_item(item_id):
|
|
item = g.lib.get_item(item_id)
|
|
return flask.jsonify(_rep(item))
|
|
|
|
@app.route('/item/')
|
|
def all_items():
|
|
with g.lib.transaction() as tx:
|
|
rows = tx.query("SELECT id FROM items")
|
|
all_ids = [row[0] for row in rows]
|
|
return flask.jsonify(item_ids=all_ids)
|
|
|
|
@app.route('/item/<int:item_id>/file')
|
|
def item_file(item_id):
|
|
item = g.lib.get_item(item_id)
|
|
return flask.send_file(item.path)
|
|
|
|
@app.route('/item/query/<path:query>')
|
|
def item_query(query):
|
|
parts = query.split('/')
|
|
items = g.lib.items(parts)
|
|
return flask.jsonify(results=[_rep(item) for item in items])
|
|
|
|
|
|
# Albums.
|
|
|
|
@app.route('/album/<int:album_id>')
|
|
def single_album(album_id):
|
|
album = g.lib.get_album(album_id)
|
|
return flask.jsonify(_rep(album))
|
|
|
|
@app.route('/album/')
|
|
def all_albums():
|
|
with g.lib.transaction() as tx:
|
|
rows = tx.query("SELECT id FROM albums")
|
|
all_ids = [row[0] for row in rows]
|
|
return flask.jsonify(album_ids=all_ids)
|
|
|
|
@app.route('/album/query/<path:query>')
|
|
def album_query(query):
|
|
parts = query.split('/')
|
|
albums = g.lib.albums(parts)
|
|
return flask.jsonify(results=[_rep(album) for album in albums])
|
|
|
|
@app.route('/album/<int:album_id>/art')
|
|
def album_art(album_id):
|
|
album = g.lib.get_album(album_id)
|
|
return flask.send_file(album.artpath)
|
|
|
|
|
|
# UI.
|
|
|
|
@app.route('/')
|
|
def home():
|
|
return flask.render_template('index.html')
|
|
|
|
|
|
# Plugin hook.
|
|
|
|
class WebPlugin(BeetsPlugin):
|
|
def commands(self):
|
|
cmd = ui.Subcommand('web', help='start a Web interface')
|
|
cmd.parser.add_option('-d', '--debug', action='store_true',
|
|
default=False, help='debug mode')
|
|
def func(lib, config, opts, args):
|
|
host = args.pop(0) if args else \
|
|
beets.ui.config_val(config, 'web', 'host', DEFAULT_HOST)
|
|
port = args.pop(0) if args else \
|
|
beets.ui.config_val(config, 'web', 'port', str(DEFAULT_PORT))
|
|
port = int(port)
|
|
|
|
app.config['lib'] = lib
|
|
app.run(host=host, port=port, debug=opts.debug, threaded=True)
|
|
cmd.func = func
|
|
return [cmd]
|