- finalizing session locking

- update notification will happen every 10 days
- added "M" command
- docs updated
- done a bit of refactoring

Author: s-n-g

Changelog

@@ -1,24 +1,25 @@
-2019-06-21
+2019-06-23 s-n-g
     * mpv now uses a dedicated socket file. This way multiple instances of
       PyRadio can be executed.
-	* Introducing session locking.
+    * Introducing session locking.
     * Added the "--unlock" command line parameter, to force sessions' unlock.
+    * Added "M" command, which will jump to the middle of the list.
     * PyRadio can load external theme files.
     * Three more themes added. These are system themes (actual files).
     * Theme selection window reworked - themes are separated by location,
       theme selection is remembered when resizing, and loading default or
       saved theme (in config window).
     * PyRadio will check and report when a new release is available.
     * Added good bye message.
-	* Theme editor implementation started (disabled for this release).
+    * Theme editor implementation started (disabled for this release).
     * Minor other fixes.
 
-2019-06-06
+2019-06-06 s-n-g
     * Verion 0.7.6.2
       This is a BUG FIX release, fixing config status (indicating whether 
       config is modified or not)
 
-2019-06-02
+2019-06-02 s-n-g
     * Version 0.7.6.1
       This is a BUG FIX release, fixing regression: config not saved when
       changing themes

README.html

@@ -40,6 +40,8 @@ <h2 id="table-of-contents">Table of contents</h2>
 <li><a href="#player-detection-selection">Player detection / selection</a></li>
 <li><a href="#player-default-volume-level">Player default volume level</a></li>
 <li><a href="#pyradio-themes">PyRadio Themes</a></li>
+<li><a href="#session-locking">Session Locking</a></li>
+<li><a href="#update-notification">Update notification</a></li>
 <li><a href="#debug-mode">Debug mode</a></li>
 </ul>
 <h2 id="requirements">Requirements</h2>
@@ -112,7 +114,7 @@ <h2 id="controls">Controls</h2>
 Esc/q             Quit                                      -                                  -
 Esc/q/Left/h      -                                         Cancel / close window              Cancel / close window</pre>
 <p>The same logic applies to all <strong>PyRadio</strong> windows.</p>
-<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> All windows support changing the volume and muting / unmuting the player (provided that it is actually connected to a station).</p>
+<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> All windows support changing the volume and muting / unmuting the player (provided that <strong>PyRadio</strong> is actually connected to a station).</p>
 <h2 id="config-file">Config file</h2>
 <p><strong>PyRadio</strong> upon its execution tries to read its configuration file (i.e. <em>~/.config/pyradio/config</em>). If this file is not found, it will be created. If an error occurs while parsing it, an error message will be displayed and <strong><em>PyRadio</em></strong> will terminate.</p>
 <p>The file contains parameters such as the player to use, the playlist to load etc. It is heavily commented (as you can see <a href="pyradio/config">here</a>), so that manual editing is really easy. The best practice to manually edit this file is executing <strong><em>PyRadio</em></strong> with the <strong>-ocd</strong> command line option, which will open the configuration directory in your file manager, and then edit it using your preferable text editor.</p>
@@ -244,6 +246,14 @@ <h3 id="using-transparency">Using transparency</h3>
 <p>Pressing “<strong>T</strong>” will toggle the transparency setting and save this state in <strong>PyRadio</strong>’s configuration file (transparency is off by default).</p>
 <p>Setting transparency on, will actually force <strong>PyRadio</strong> to not use its own background color, effectively making it to display whatever is on the terminal (color/picture/transparency). The visual result depends on terminal settings and whether a compositor is running.</p>
 <p>When the <em>Theme selection window</em> is visible, a “<strong>[T]</strong>” string displayed at its bottom right corner will indicate that transparency is <em>on</em>.</p>
+<h2 id="session-locking">Session Locking</h2>
+<p><strong>PyRadio</strong> uses session locking, which actually means that only the first instance executed within a given session will be able to write to the configuration file.</p>
+<p>Subsequent instances will be “<em>locked</em>”. This means that the user can still play stations, load and edit playlists, load and test themes, but any changes will <strong>not</strong> be recorded in the configuration file.</p>
+<h3 id="seeeion-unlocking">Seeeion unlocking</h3>
+<p>If for any reason <strong>PyRadio</strong> always starts in <em>locked mode</em>, one can <strong>unclock</strong> the session, using the “<em>–unlock</em>” command line paremater.</p>
+<h2 id="update-notification">Update notification</h2>
+<p><strong>PyRadio</strong> will periodically (once every 10 days) check whether a new version has been released.</p>
+<p>If so, a notification message will be displayed, informing the user about it.</p>
 <h2 id="debug-mode">Debug mode</h2>
 <p>Adding the <strong><em>-d</em></strong> option to the command line will instruct <strong>PyRadio</strong> to enter <em>Debug mode</em>, which means that it will print debug messages to a file. This file will always reside in the user’s home directory and will be named <em>pyradio.log</em>.</p>
 <p>In case of a bug or a glitch, please include this file to the issue you will <a href="https://github.com/coderholic/pyradio/issues">open in github</a>.</p>

README.md

@@ -16,6 +16,8 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
 * [Player detection / selection](#player-detection-selection)
 * [Player default volume level](#player-default-volume-level)
 * [PyRadio Themes](#pyradio-themes)
+* [Session Locking](#session-locking)
+* [Update notification](#update-notification)
 * [Debug mode](#debug-mode)
 
 ## Requirements
@@ -100,7 +102,7 @@ Esc/q/Left/h      -                                         Cancel / close windo
 
 The same logic applies to all **PyRadio** windows.
 
-**Note:** All windows support changing the volume and muting / unmuting the player (provided that it is actually connected to a station).
+**Note:** All windows support changing the volume and muting / unmuting the player (provided that **PyRadio** is actually connected to a station).
 
 
 ## Config file
@@ -354,6 +356,22 @@ Setting transparency on, will actually force **PyRadio** to not use its own back
 
 When the *Theme selection window* is visible, a "**[T]**" string displayed  at  its  bottom right corner will indicate that transparency is *on*.
 
+## Session Locking
+
+**PyRadio** uses session locking, which actually means that only the first instance executed within a given session will be able to write to the configuration file.
+
+Subsequent instances will be "*locked*". This means that the user can still play stations, load and edit playlists, load and test themes, but any changes will **not** be recorded in the configuration file.  
+
+### Seeeion unlocking
+
+If for any reason **PyRadio** always starts in *locked mode*, one can **unclock** the session, using the "*--unlock*" command line paremater.
+
+## Update notification
+
+**PyRadio** will periodically (once every 10 days) check whether a new version has been released.
+
+If so, a notification message will be displayed, informing the user about it.
+
 ## Debug mode
 
 Adding the ***-d*** option to the command line will instruct **PyRadio** to enter *Debug mode*, which means that it will print debug messages to a file. This file will always reside in the user's home directory and will be named *pyradio.log*.

pyradio.1

@@ -384,6 +384,22 @@ Setting transparency on, will actually force \fBpyradio\fR to not use its own ba
 
 When the \fITheme selection window\fR is visible, a "\fI[T]\fR" string displayed at its bottom right corner will indicate that transparency is \fIon\fR.
 
+.SH SESSION LOCKING
+
+\fBpyradio\fR uses session locking, which actually means that only the first instance executed within a given session will be able to write to the configuration file.
+
+Subsequent instances will be "\fIlocked\fR. This means that the user can still play stations, load and edit playlists, load and test themes, but any changes will \fBnot\fR be recorded in the configuration file.  
+
+\fBSeeeion unlocking\fR
+
+If for any reason \fBpyradio\fR always starts in \fIlocked mode\fR, one can \fBunclock\fR the session, using the "\fB--unlock\fR" command line paremater.
+
+.SH UPDATE NOTIFICATION
+.PP
+\fBpyradio\fR will periodically (once every 10 days) check whether a new version has been released.
+
+If so, a notification message will be displayed, informing the user about it.
+
 .SH DEBUG MODE
 .PP
 Adding the \fB-d\fR option to the command line will instruct \fBpyradio\fR to enter \fBDebug mode\fR, which means that it will print debug messages to a file. This file will always reside in the user's home directory and will be named \fIpyradio.log\fR.

pyradio/common.py

@@ -44,7 +44,78 @@
 CONFIG_SAVE_ERROR_MODE = 303
 THEME_MODE = 400
 UPDATE_NOTIFICATION_MODE = 1000
-NOT_IMPLEMENTED_YET_MODE = 1001
+SESSION_LOCKED_MODE = 1001
+NOT_IMPLEMENTED_YET_MODE = 1002
+
+MODE_NAMES = {
+NO_PLAYER_ERROR_MODE: 'NO_PLAYER_ERROR_MODE',
+NORMAL_MODE: 'NORMAL_MODE',
+PLAYLIST_MODE: 'PLAYLIST_MODE',
+SEARCH_NORMAL_MODE: 'SEARCH_NORMAL_MODE',
+SEARCH_PLAYLIST_MODE: 'SEARCH_PLAYLIST_MODE',
+CONFIG_MODE: 'CONFIG_MODE',
+SELECT_PLAYER_MODE: 'SELECT_PLAYER_MODE',
+SELECT_ENCODING_MODE: 'SELECT_ENCODING_MODE',
+SELECT_PLAYLIST_MODE: 'SELECT_PLAYLIST_MODE',
+SELECT_STATION_MODE: 'SELECT_STATION_MODE',
+SELECT_STATION_ENCODING_MODE: 'SELECT_STATION_ENCODING_MODE',
+NEW_THEME_MODE: 'NEW_THEME_MODE',
+EDIT_THEME_MODE: 'EDIT_THEME_MODE',
+REMOVE_STATION_MODE: 'REMOVE_STATION_MODE',
+SAVE_PLAYLIST_MODE: 'SAVE_PLAYLIST_MODE',
+ASK_TO_SAVE_PLAYLIST_WHEN_OPENING_PLAYLIST_MODE: 'ASK_TO_SAVE_PLAYLIST_WHEN_OPENING_PLAYLIST_MODE',
+ASK_TO_SAVE_PLAYLIST_WHEN_EXITING_MODE: 'ASK_TO_SAVE_PLAYLIST_WHEN_EXITING_MODE',
+MAIN_HELP_MODE: 'MAIN_HELP_MODE',
+PLAYLIST_HELP_MODE: 'PLAYLIST_HELP_MODE',
+CONFIG_HELP_MODE: 'CONFIG_HELP_MODE',
+THEME_HELP_MODE: 'THEME_HELP_MODE',
+SELECT_PLAYER_HELP_MODE: 'SELECT_PLAYER_HELP_MODE',
+SELECT_ENCODING_HELP_MODE: 'SELECT_ENCODING_HELP_MODE',
+SELECT_PLAYLIST_HELP_MODE: 'SELECT_PLAYLIST_HELP_MODE',
+SELECT_STATION_HELP_MODE: 'SELECT_STATION_HELP_MODE',
+NEW_THEME_HELP_MODE: 'NEW_THEME_HELP_MODE',
+EDIT_THEME_HELP_MODE: 'EDIT_THEME_HELP_MODE',
+ASK_TO_CREATE_NEW_THEME_MODE: 'ASK_TO_CREATE_NEW_THEME_MODE',
+PLAYLIST_RECOVERY_ERROR_MODE: 'PLAYLIST_RECOVERY_ERROR_MODE',
+PLAYLIST_NOT_FOUND_ERROR_MODE: 'PLAYLIST_NOT_FOUND_ERROR_MODE',
+PLAYLIST_LOAD_ERROR_MODE: 'PLAYLIST_LOAD_ERROR_MODE',
+PLAYLIST_RELOAD_ERROR_MODE: 'PLAYLIST_RELOAD_ERROR_MODE',
+PLAYLIST_RELOAD_CONFIRM_MODE: 'PLAYLIST_RELOAD_CONFIRM_MODE',
+PLAYLIST_DIRTY_RELOAD_CONFIRM_MODE: 'PLAYLIST_DIRTY_RELOAD_CONFIRM_MODE',
+PLAYLIST_SCAN_ERROR_MODE: 'PLAYLIST_SCAN_ERROR_MODE',
+SAVE_PLAYLIST_ERROR_1_MODE: 'SAVE_PLAYLIST_ERROR_1_MODE',
+SAVE_PLAYLIST_ERROR_2_MODE: 'SAVE_PLAYLIST_ERROR_2_MODE',
+FOREIGN_PLAYLIST_ASK_MODE: 'FOREIGN_PLAYLIST_ASK_MODE',
+FOREIGN_PLAYLIST_MESSAGE_MODE: 'FOREIGN_PLAYLIST_MESSAGE_MODE',
+FOREIGN_PLAYLIST_COPY_ERROR_MODE: 'FOREIGN_PLAYLIST_COPY_ERROR_MODE',
+CONFIG_SAVE_ERROR_MODE: 'CONFIG_SAVE_ERROR_MODE',
+THEME_MODE: 'THEME_MODE',
+UPDATE_NOTIFICATION_MODE: 'UPDATE_NOTIFICATION_MODE',
+SESSION_LOCKED_MODE: 'SESSION_LOCKED_MODE',
+NOT_IMPLEMENTED_YET_MODE: 'NOT_IMPLEMENTED_YET_MODE',
+}
+
+''' When PASSIVE_WINDOWS target is one of them,
+    also set window_mode '''
+MAIN_MODES = ( NORMAL_MODE, PLAYLIST_MODE, CONFIG_MODE )
+
+PASSIVE_WINDOWS = {
+SESSION_LOCKED_MODE: NORMAL_MODE,
+UPDATE_NOTIFICATION_MODE: NORMAL_MODE,
+MAIN_HELP_MODE: NORMAL_MODE,
+CONFIG_HELP_MODE: CONFIG_MODE,
+SELECT_PLAYER_HELP_MODE: SELECT_PLAYER_MODE,
+SELECT_PLAYLIST_HELP_MODE: SELECT_PLAYLIST_MODE,
+SELECT_STATION_HELP_MODE: SELECT_STATION_MODE,
+PLAYLIST_RELOAD_ERROR_MODE: NORMAL_MODE,
+SAVE_PLAYLIST_ERROR_1_MODE: NORMAL_MODE,
+SAVE_PLAYLIST_ERROR_2_MODE: NORMAL_MODE,
+FOREIGN_PLAYLIST_MESSAGE_MODE: NORMAL_MODE,
+FOREIGN_PLAYLIST_COPY_ERROR_MODE: NORMAL_MODE,
+PLAYLIST_HELP_MODE: PLAYLIST_MODE,
+PLAYLIST_LOAD_ERROR_MODE: PLAYLIST_MODE,
+PLAYLIST_NOT_FOUND_ERROR_MODE: PLAYLIST_MODE,
+}
 
 """ Theming constants """
 def FOREGROUND(): return 0