├── .gitignore
├── .travis.yml
├── LICENSE
├── MANIFEST.in
├── README.rst
├── mopidy_websettings
├── __init__.py
├── ext.conf
├── index.html
├── js
│ ├── mopidy.min.js
│ └── simple.js
└── settingsspec.ini
├── setup.cfg
├── setup.py
├── tests
├── __init__.py
└── test_extension.py
├── tox.ini
└── xunit-py27.xml
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_store
2 | *.pyc
3 | *.swp
4 | .coverage
5 | .idea
6 | .noseids
7 | .tox
8 | MANIFEST
9 | build/
10 | cover/
11 | coverage.xml
12 | dist/
13 | docs/_build/
14 | mopidy.log*
15 | node_modules/
16 | nosetests.xml
17 | .project
18 | *.pbxproj
19 | *.egg-info
20 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | sudo: required
2 | dist: trusty
3 |
4 | language: python
5 |
6 | python:
7 | - "2.7_with_system_site_packages"
8 |
9 | env:
10 | - TOX_ENV=py27
11 | - TOX_ENV=flake8
12 |
13 | before_install:
14 | - "sudo apt-get update -qq"
15 | - "sudo apt-get install -y gir1.2-gst-plugins-base-1.0 gir1.2-gstreamer-1.0 python-gst-1.0"
16 |
17 | install:
18 | - "pip install tox"
19 |
20 | script:
21 | - "tox -e $TOX_ENV"
22 |
23 | after_success:
24 | - "if [ $TOX_ENV == 'py27' ]; then pip install coveralls; coveralls; fi"
25 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include .coveragerc
2 | include .travis.yml
3 | include LICENSE
4 | include MANIFEST.in
5 | include README.rst
6 | include mopidy_websettings/*
7 | include mopidy_websettings/js/ *
8 |
9 | recursive-include tests *.py
10 |
--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
1 | ****************************
2 | Mopidy-WebSettings
3 | ****************************
4 |
5 | .. image:: https://img.shields.io/pypi/v/Mopidy-WebSettings.svg?style=flat
6 | :target: https://pypi.python.org/pypi/Mopidy-WebSettings/
7 | :alt: Latest PyPI version
8 |
9 | .. image:: https://img.shields.io/pypi/dm/Mopidy-WebSettings.svg?style=flat
10 | :target: https://pypi.python.org/pypi/Mopidy-WebSettings/
11 | :alt: Number of PyPI downloads
12 |
13 | .. image:: https://img.shields.io/travis/pimusicbox/mopidy-websettings/develop.svg?style=flat
14 | :target: https://travis-ci.org/pimusicbox/mopidy-websettings
15 | :alt: Travis CI build status
16 |
17 | .. image:: https://img.shields.io/coveralls/pimusicbox/mopidy-websettings/develop.svg?style=flat
18 | :target: https://coveralls.io/r/pimusicbox/mopidy-websettings?branch=develop
19 | :alt: Test coverage
20 |
21 | Mopidy extension for editing settings in a webinterface. Used by Pi MusicBox, but also usable for personal installations or other projects, since MusicBox-only settings are hidden automatically.
22 |
23 |
24 | This project is no longer maintained.
25 | ============
26 |
27 | There will be no more releases and no more support from myself.
28 |
29 |
30 | Installation
31 | ============
32 |
33 | Install by running::
34 |
35 | sudo pip install Mopidy-WebSettings
36 |
37 | Or, if available, install the Debian/Ubuntu package from `apt.mopidy.com
38 | `_.
39 |
40 |
41 | Configuration
42 | =============
43 |
44 | Before starting Mopidy, you can add configuration for
45 | Mopidy-WebSettings to your Mopidy configuration file::
46 |
47 | [websettings]
48 | enabled = true
49 | musicbox = false
50 | config_file = /etc/mopidy/mopidy.conf
51 |
52 | Make sure the config file is writable by the user under which mopidy is running! And make sure the http extension is working. Go to the ip or url of your mopidy computer and add /settings (e.g. http://musicbox.local/settings or http://192.168.1.10:6680/settings )
53 |
54 | For now, the settings are only applied after a reboot, which this extension will try to do. If it doesn't work, a (manual) restart of mopidy is needed.
55 |
56 | Project resources
57 | =================
58 |
59 | - `Source code `_
60 | - `Issue tracker `_
61 | - `Development branch tarball `_
62 |
63 |
64 | Changelog
65 | =========
66 |
67 | v0.2.3 (25/2/2018)
68 | ------------------
69 |
70 | - Support for AudioInjector stereo and octo cards.
71 |
72 |
73 | v0.2.2 (14/1/2018)
74 | ------------------
75 |
76 | - Updated wording for the new required Spotify credentials.
77 |
78 |
79 | v0.2.1 (12/1/2018)
80 | ------------------
81 |
82 | - Moved spotify_web's client_id and client_secret to spotify section.
83 | - Added support for Allo DigiOne and Mini Boss HiFi DAC.
84 | - Added support for the latest confusingly named HiFiBerry products (cummon, guys).
85 |
86 | v0.2.0 (18/7/2017)
87 | ------------------
88 |
89 | - Added Mopidy logging configuration setting.
90 |
91 | v0.1.7 (18/7/2017)
92 | ------------------
93 |
94 | - Added WiFi country setting.
95 | - Added MPD Watchdog setting.
96 | - Increased WiFi password input to support 64 character hex keys.
97 | - Added Spotify Connect setting.
98 |
99 | v0.1.6.2 (21/4/2017)
100 | --------------------
101 |
102 | - Added firewall setting.
103 | - Updated support for IQ Audio and Allo DAC soundcards.
104 | - Updated podcast settings.
105 | - Fixed missing javascript files from previous release.
106 |
107 | v0.1.6.1 (18/3/2017)
108 | --------------------
109 |
110 | - Added JustBoom audio cards.
111 |
112 | v0.1.6 (18/3/2017)
113 | ------------------
114 |
115 | - Updated and improved explanations for settings.
116 | - Removed development-orientated resize_once option.
117 | - Fixed corrupt settings when expected subsections missing from settings.ini.
118 | - Fixed webclient not changing.
119 | - Changing the webclient requires a Mopidy restart rather than a reboot.
120 | - Fixed outdated Exception syntax.
121 | - Option to populate autoplay with currently playing track.
122 |
123 | v0.1.5 (2/3/2016)
124 | -----------------
125 |
126 | - Fixed password field length restrictions.
127 | - Apply changes with Mopidy service restart rather than system reboot where possible.
128 | - Added/updated options as required for integration with PiMusicbox v0.7.
129 |
130 | v0.1.4.2 (26/3/2015)
131 | --------------------
132 |
133 | - Fixed length of Autoplay URL input box.
134 |
135 | v0.1.4.1
136 | --------
137 |
138 | - Small fix for passwords not updated well
139 |
140 | v0.1.4
141 | ------
142 |
143 | - AudioAddict added (by Nilicule)
144 | - Passwords mask same size as password
145 |
146 | v0.1.3
147 | ------
148 |
149 | - Added YouTube and local support (on or off)
150 | - Enabled YouTube, SomaFM, Local, Internetarchive, Podcast by default when not in ini-file (the default of the extensions)
151 | - Settings for enabling streaming services shairport and upmpdcli (for MusicBox only)
152 | - Writing the config is more reliable
153 | - Better layout
154 |
155 | v0.1.2
156 | ------
157 |
158 | - Fixes for writing ini file
159 |
160 |
161 | v0.1.1
162 | ------
163 |
164 | - Fixed missing template files in dist
165 | - Fixed template
166 | - Reboot after settings are updated (if mopidy instance has the permission to do that, like on musicbox)
167 |
168 | v0.1.0
169 | ------
170 |
171 | - Initial release
172 |
--------------------------------------------------------------------------------
/mopidy_websettings/__init__.py:
--------------------------------------------------------------------------------
1 | from __future__ import unicode_literals
2 |
3 | import logging
4 | import os
5 | import sys
6 |
7 |
8 | from configobj import ConfigObj, ConfigObjError
9 |
10 | import jinja2
11 |
12 | from mopidy import config, ext
13 |
14 | import tornado.web
15 |
16 | __version__ = '0.2.3'
17 |
18 | logger = logging.getLogger(__name__)
19 |
20 | spec_file = os.path.join(os.path.dirname(__file__), 'settingsspec.ini')
21 | template_file = os.path.join(os.path.dirname(__file__), 'index.html')
22 |
23 |
24 | def can_change_root_password(ini):
25 | root_password = ini.get('musicbox', {}).get('root_password', '')
26 | return len(root_password)
27 |
28 |
29 | def get_name(item, subitem):
30 | return item + '__' + subitem
31 |
32 |
33 | def restart_program():
34 | """
35 | DOES NOT WORK WELL WITH MOPIDY
36 | Hack from
37 | https://www.daniweb.com/software-development/python/code/260268/restart-your-python-program
38 | to support updating the settings, since mopidy is not able to do that yet
39 | Restarts the current program
40 | Note: this function does not return. Any cleanup action (like
41 | saving data) must be done before calling this function
42 | """
43 |
44 | python = sys.executable
45 | os.execl(python, python, * sys.argv)
46 |
47 |
48 | class Extension(ext.Extension):
49 | dist_name = 'Mopidy-WebSettings'
50 | ext_name = 'websettings'
51 | version = __version__
52 |
53 | def get_default_config(self):
54 | conf_file = os.path.join(os.path.dirname(__file__), 'ext.conf')
55 | return config.read(conf_file)
56 |
57 | def get_config_schema(self):
58 | schema = super(Extension, self).get_config_schema()
59 | schema['musicbox'] = config.Boolean()
60 | schema['config_file'] = config.String()
61 | return schema
62 |
63 | def setup(self, registry):
64 | registry.add('http:app', {
65 | # 'name': self.ext_name,
66 | 'name': 'settings',
67 | 'factory': websettings_app_factory,
68 | })
69 |
70 |
71 | class WebSettingsRequestHandler(tornado.web.RequestHandler):
72 |
73 | def initialize(self, config):
74 | self.config_file = config['websettings']['config_file']
75 |
76 | def get(self):
77 | templateLoader = jinja2.FileSystemLoader(searchpath="/")
78 | templateEnv = jinja2.Environment(loader=templateLoader)
79 | template = templateEnv.get_template(template_file)
80 |
81 | # Read config file
82 | try:
83 | iniconfig = ConfigObj(self.config_file, configspec=spec_file,
84 | file_error=True, encoding='utf8')
85 | except (ConfigObjError, IOError) as e:
86 | error = 'Could not load ini file! %s' % e
87 | logger.error(error)
88 | self.write(error)
89 | return
90 |
91 | templateVars = {
92 | 'change_root_password': can_change_root_password(iniconfig)
93 | }
94 | # Read values of valid items (in the spec-file)
95 | validItems = ConfigObj(spec_file, encoding='utf8')
96 | # Iterate over the valid items to get them into the template
97 | for item in validItems:
98 | for subitem in validItems[item]:
99 | configValue = iniconfig.get(item, {}).get(subitem, None)
100 | if configValue is not None:
101 | itemName = get_name(item, subitem)
102 | templateVars[itemName] = configValue
103 |
104 | self.write(template.render(templateVars))
105 |
106 |
107 | class WebPostRequestHandler(tornado.web.RequestHandler):
108 |
109 | def initialize(self, config):
110 | self.config_file = config.get('websettings')['config_file']
111 |
112 | def needs_reboot(self, item, subItem):
113 | reboot_sections = ['network', 'musicbox']
114 | restart_subsections = ['webclient']
115 | if item in reboot_sections:
116 | # Restarting Mopidy is sufficient for some subsections.
117 | if subItem not in restart_subsections:
118 | return True
119 | return False
120 |
121 | def post(self):
122 | apply_html = ''
123 | apply_string = 'restart Mopidy'
124 | status = ''
125 | try:
126 | iniconfig = ConfigObj(self.config_file, configspec=spec_file,
127 | file_error=True, encoding='utf8')
128 | validItems = ConfigObj(spec_file, encoding='utf8')
129 | # Iterate over the items, so that only valid items are processed
130 | for item in validItems:
131 | for subitem in validItems[item]:
132 | itemName = get_name(item, subitem)
133 |
134 | if itemName == get_name('musicbox', 'root_password') and \
135 | not can_change_root_password(iniconfig):
136 | continue
137 |
138 | value = self.get_argument(itemName, default='')
139 | if value:
140 | # Create default entry if it doesn't already exist
141 | oldItem = iniconfig.setdefault(item, {}).setdefault(
142 | subitem, '')
143 | # Does changing the setting requires a system reboot.
144 | if oldItem != value and \
145 | self.needs_reboot(item, subitem):
146 | apply_string = 'reboot system'
147 | iniconfig[item][subitem] = value
148 | # Ensure that some of the settings are consistent.
149 | try:
150 | if iniconfig['audio']['mixer'] == 'alsamixer':
151 | iniconfig['alsamixer']['enabled'] = 'true'
152 | else:
153 | iniconfig['alsamixer']['enabled'] = 'false'
154 | # spotify and spotify_web should have the same values here.
155 | for subitem in ['client_id', 'client_secret']:
156 | iniconfig['spotify'][subitem] = (
157 | iniconfig['spotify'][subitem] or
158 | iniconfig['spotify_web'][subitem])
159 | iniconfig['spotify_web'][subitem] = (
160 | iniconfig['spotify'][subitem])
161 | except KeyError as e:
162 | logger.error('Error making config consistent %s', e)
163 |
164 | iniconfig.write()
165 | status = 'Settings Saved!'
166 | apply_html = ('