adding config option console_theme

Author: s-n-g

README.md

@@ -141,11 +141,11 @@ This will display the program's window with a list of predefined radio stations
 
 - Press "**+**" (or "**.**") and "**-**" (or "**,**") to adjust the volume, and "**v**" to save it.
 
-- Pressing "**?**" will give you access to the help screens; "**\\h**" will give you access to the help pages.
+- Pressing "**?**" will give you access to the help screens; "**\\h**" will give you access to the HTML help pages.
 
 - "**Esc**" or "**q**" will exit the program.
 
-In case the list of predefined stations are not enough for you, you can press "**O**" (capital "**o**") to access **RadioBrowser** online directory; you will probably have to read [this page](docs/radio-browser.md) to learn how to navigate the interface.
+In case the list of predefined stations is not enough for you, you can press "**O**" (capital "**o**") to access **RadioBrowser** online directory; you will probably have to read [this page](docs/radio-browser.md) to learn how to navigate the interface.
 
 **PyRadio** comes with a number of themes; press "**t**" to get a list of themes, and
 
@@ -211,4 +211,5 @@ If you are a packager and would like to produce a package for your distribution
 ## Special thanks
 
 1. [edunfelt](https://github.com/edunfelt), for her wonderful work on [base16 themes](https://github.com/edunfelt/base16-pyradio), and ideas regarding theming and such.
+
 2. [amano-kenji](https://github.com/amano-kenji), for his valuable suggestions and bug reports.

devel/pre-commit

@@ -121,7 +121,7 @@ cd docs
 # update brew link in macos.md
 [ -z "$RUN_ALL_PROGRAMS" ] ||  update_brew_link
 
-echo -ne "Updating files ... "
+echo -ne "Updating ${cBlue}HTML${cReset} files "
 
 # Create HTML file from md files
 for afile in index.md \
@@ -140,6 +140,7 @@ for afile in index.md \
     headless.md \
     rec-dir.md
 do
+    echo -ne '.'
 #[ -z "$(git status | grep ${afile})" ] || {
     out=${afile/%.md/.html}
     if [ "$afile" = "index.md" ];then
@@ -311,8 +312,7 @@ cd ..
 #     git add pyradio/win.py
 #     git add devel/update_win_mplayer
 # }
-
-echo -e "${cGreen}done${sReset}
+echo -e "${cGreen} done${sReset}
 "
 
 echo -e "${cBlue}Version:${cReset}"
@@ -340,6 +340,9 @@ then
     echo -e "${cReset}
 You should also run
     ${cGreen}${0} -a${cReset}
-when you are ready to publish a new release"
+when you are ready to publish a new release
+"
+else
+    echo
 fi
 

docs/packaging.md

@@ -12,6 +12,7 @@
     * [pyradio/\_\_pycache\_\_](#pyradio/\_\_pycache\_\_)
 * [Recordings Directory](#recordings-directory)
 * [MKVToolNix cli installation](#mkvtoolnix-cli-installation)
+* [Resource opener (Linux only)](#resource-opener-(linux-only))
 
 <!-- vim-markdown-toc -->
 
@@ -36,11 +37,6 @@ Then you have to add the following python modules to the relevant section of you
 5. netifaces
 6. dateutil
 
-Linux users will have to install the "**xdg-utils**" package (may be named differently in your distro) which will provide "**xdg-open**", the utility to open directories, html pages, etc.
-
-Linux and macOS users will have to have installed a font that supports the "**Unicode Geometric Shapes Block**". Any font mentioned in the [Font Support for Unicode Block 'Geometric Shapes'](https://www.fileformat.info/info/unicode/block/geometric_shapes/fontsupport.htm) page will do; as you can see these include **DejaVu**, **FreeMono**, **Unifont**, etc, some of which will fopefully be installed by default.
-
-
 ## Files to change
 
 You will have to modify a couple of files to tailor **PyRadio**' to your needs and liking.
@@ -139,4 +135,20 @@ I would suggest to do so, in order to provide your users the best experience pos
 
 In case you decide to do so, please make sure you mark as a dependency the **command line utilities**, not the GUI program, if that's on a different package on your distro. For examle, Arch Linux provides both a *mkvtoolnix-cli* and a *mkvtoolnix-gui* package; the first one should be used. Same thing with Debian Linux; it provides both a *mkvtoolnix* and a *mkvtoolnix-gui* package; in which case you'd use the later.
 
+## Resource opener (Linux only)
+
+A [resource opener](https://wiki.archlinux.org/title/default_applications#Resource_openers) is a utility to open directories, html pages, etc.
+
+**PyRadio** running on Linux will look for *xdg-open*, *gio*, *mimeopen*, *mimeo* or *handlr*, in that order of detection.
+
+If none of the above if found, the requested file will simply not open.
+
+Most Linux distros will probably have *xdg-open* (from *xdg-utils* package) installed or available (or any of the ones in the list above), so no action will be nesesary.
+
+In case a different *resource opener* is to be used, one can declare it like so:
+
+    sed -i 's/resource_opener = auto/resource_opener = MY_RESOURCE_OPENER/' config
+
+This will instruct **PyRadio** to use the file **MY_RESOURCE_OPENER** as a *resource opener*.
 
+**MY_RESOURCE_OPENER** can be just the name of the file (if it is in the *PATH*), or an absolute path to a file, it it's not.

pyradio/config

@@ -11,7 +11,7 @@ player = mpv, mplayer, vlc
 
 # Default playlist
 # This is the playlist to open if none is specified
-# You can scecify full path to CSV file, or if the playlist is in the config
+# You can specify full path to CSV file, or if the playlist is in the config
 # directory, playlist name (filename without extension or playlist number (as
 # reported by -ls command line option)
 #
@@ -98,7 +98,7 @@ connection_timeout = 10
 force_http = False
 
 # Default theme
-# Hardcooded themes:
+# Hard coded themes:
 #   dark (default) (8 colors)
 #   light (8 colors)
 #   dark_16_colors (16 colors dark theme alternative)
@@ -131,7 +131,7 @@ use_transparency = False
 force_transparency = False
 
 # Calculated color factor
-# This is to produce Secondary Windows background color. A value of 0 dissables
+# This is to produce Secondary Windows background color. A value of 0 disables
 # it, otherwise it is the factor to change (lighten or darken) the base color.
 # For more info, please refer to
 # https://github.com/coderholic/pyradio#secondary-windows-background
@@ -140,6 +140,14 @@ force_transparency = False
 # Default value: 0
 calculated_color_factor = 0
 
+# Console theme
+# This is the theme to be used when a PyRasio is executed either in a linux
+# virtual console, or on a terminal that does not support color change.
+# Possible values: dark / light
+#
+# Default value: dark
+console_theme = dark
+
 
 # Playlist management
 #
@@ -186,7 +194,7 @@ remote_control_server_auto_start = False
 # Packagers should set this paramater as resired!
 #
 # Default value: False
-xdg_compliant = False
+xdg_compliant = True
 
 # The name of the distribution providing the package. If this parameter is set
 # to anything other than "None" PyRadio will not permit updating (-U command

pyradio/config.py

@@ -1295,6 +1295,7 @@ class PyRadioConfig(PyRadioStations):
     opts['use_transparency'] = ['Use transparency: ', False]
     opts['force_transparency'] = ['  Force transparency: ', False]
     opts['calculated_color_factor'] = ['Calculated color: ', '0']
+    opts['console_theme'] = ['Console theme: ', 'dark']
     opts['playlist_manngement_title'] = ['Playlist Management Options', '']
     opts['confirm_station_deletion'] = ['Confirm station deletion: ', True]
     opts['confirm_playlist_reload'] = ['Confirm playlist reload: ', True]
@@ -1657,6 +1658,17 @@ def theme(self, val):
             self.opts['auto_update_theme'][1] = False
         self.opts['dirty_config'][1] = True
 
+    @property
+    def console_theme(self):
+        return self.opts['console_theme'][1]
+
+    @console_theme.setter
+    def console_theme(self, val):
+        if val in ('dark', 'light'):
+            if val != self.opts['console_theme'][1]:
+                self.opts['dirty_config'][1] = True
+            self.opts['console_theme'][1] = val
+
     @property
     def theme_path(self):
         return path.join(self.stations_dir, 'themes', self.opts['theme'][1] + '.pyradio-theme')
@@ -1939,21 +1951,38 @@ def remove_session_lock_file(self):
                 return -1, self._session_lock_file
 
     def change_to_no_theme_mode(self, show_colors_cannot_change):
-        curses.init_pair(1, curses.COLOR_CYAN, curses.COLOR_BLACK)
-        curses.init_pair(2, curses.COLOR_BLUE, curses.COLOR_BLACK)
-        curses.init_pair(3, curses.COLOR_YELLOW, curses.COLOR_BLACK)
-        curses.init_pair(4, curses.COLOR_GREEN, curses.COLOR_BLACK)
-        curses.init_pair(5, curses.COLOR_WHITE, curses.COLOR_BLACK)
-        curses.init_pair(6, curses.COLOR_BLACK, curses.COLOR_MAGENTA)
-        curses.init_pair(7, curses.COLOR_BLACK, curses.COLOR_GREEN)
-        curses.init_pair(8, curses.COLOR_WHITE, curses.COLOR_BLACK)
-        curses.init_pair(9, curses.COLOR_BLACK, curses.COLOR_GREEN)
-        curses.init_pair(10, curses.COLOR_WHITE, curses.COLOR_BLACK)
-        curses.init_pair(11, curses.COLOR_GREEN, curses.COLOR_BLACK)
-        curses.init_pair(12, curses.COLOR_WHITE, curses.COLOR_BLACK)
-        curses.init_pair(13, curses.COLOR_WHITE, curses.COLOR_BLACK)
-        curses.init_pair(14, curses.COLOR_WHITE, curses.COLOR_BLACK)
-        curses.init_pair(15, curses.COLOR_WHITE, curses.COLOR_BLACK)
+        if self.console_theme == 'light':
+            curses.init_pair(1, curses.COLOR_MAGENTA, curses.COLOR_WHITE )
+            curses.init_pair(2, curses.COLOR_BLUE, curses.COLOR_WHITE)
+            curses.init_pair(3, curses.COLOR_RED, curses.COLOR_WHITE)
+            curses.init_pair(4, curses.COLOR_RED, curses.COLOR_WHITE)
+            curses.init_pair(5, curses.COLOR_BLACK, curses.COLOR_WHITE)
+            curses.init_pair(6, curses.COLOR_WHITE, curses.COLOR_MAGENTA)
+            curses.init_pair(7, curses.COLOR_WHITE, curses.COLOR_BLUE)
+            curses.init_pair(8, curses.COLOR_BLACK, curses.COLOR_WHITE)
+            curses.init_pair(9, curses.COLOR_WHITE, curses.COLOR_BLUE)
+            curses.init_pair(10, curses.COLOR_BLACK, curses.COLOR_WHITE)
+            curses.init_pair(11, curses.COLOR_RED, curses.COLOR_WHITE)
+            curses.init_pair(12, curses.COLOR_BLACK, curses.COLOR_WHITE)
+            curses.init_pair(13, curses.COLOR_BLACK, curses.COLOR_WHITE)
+            curses.init_pair(14, curses.COLOR_BLACK, curses.COLOR_WHITE)
+            curses.init_pair(15, curses.COLOR_BLACK, curses.COLOR_WHITE)
+        else:
+            curses.init_pair(1, curses.COLOR_CYAN, curses.COLOR_BLACK)
+            curses.init_pair(2, curses.COLOR_BLUE, curses.COLOR_BLACK)
+            curses.init_pair(3, curses.COLOR_YELLOW, curses.COLOR_BLACK)
+            curses.init_pair(4, curses.COLOR_GREEN, curses.COLOR_BLACK)
+            curses.init_pair(5, curses.COLOR_WHITE, curses.COLOR_BLACK)
+            curses.init_pair(6, curses.COLOR_BLACK, curses.COLOR_MAGENTA)
+            curses.init_pair(7, curses.COLOR_BLACK, curses.COLOR_GREEN)
+            curses.init_pair(8, curses.COLOR_WHITE, curses.COLOR_BLACK)
+            curses.init_pair(9, curses.COLOR_BLACK, curses.COLOR_GREEN)
+            curses.init_pair(10, curses.COLOR_WHITE, curses.COLOR_BLACK)
+            curses.init_pair(11, curses.COLOR_GREEN, curses.COLOR_BLACK)
+            curses.init_pair(12, curses.COLOR_WHITE, curses.COLOR_BLACK)
+            curses.init_pair(13, curses.COLOR_WHITE, curses.COLOR_BLACK)
+            curses.init_pair(14, curses.COLOR_WHITE, curses.COLOR_BLACK)
+            curses.init_pair(15, curses.COLOR_WHITE, curses.COLOR_BLACK)
         ''' Theme values backup '''
         self.bck_opts['use_transparency'] = self.opts['use_transparency'][1]
         self.bck_opts['force_transparency'] = self.opts['force_transparency'][1]
@@ -1963,7 +1992,7 @@ def change_to_no_theme_mode(self, show_colors_cannot_change):
         ''' No theme values '''
         self.opts['use_transparency'][1] = False
         self.opts['force_transparency'][1] = False
-        self.opts['theme'][1] = 'dark'
+        self.opts['theme'][1] = self.console_theme
         self.opts['auto_update_theme'][1] = False
         self.opts['calculated_color_factor'][1] = "0"
         self._show_colors_cannot_change = show_colors_cannot_change
@@ -2107,6 +2136,12 @@ def _read_config(self, distro_config=False):
                     self.opts['auto_update_theme'][1] = True
                 else:
                     self.opts['auto_update_theme'][1] = False
+            elif sp[0] == 'console_theme':
+                tmp = sp[1].strip()
+                if not tmp in ('dark', 'light'):
+                    self.opts['console_theme'][1] = 'dark'
+                else:
+                    self.opts['console_theme'][1] = tmp
             elif sp[0] == 'default_playlist':
                 self.opts['default_playlist'][1] = sp[1].strip()
             elif sp[0] == 'default_station':
@@ -2598,9 +2633,9 @@ def save_config(self, from_command_line=False):
         if self.use_themes:
             theme = self.opts['theme'][1] if not self.opts['auto_update_theme'][1] else '*' + self.opts['theme'][1]
             trnsp = self.opts['use_transparency'][1]
-            f_trnsp = self.opts['force_transparency']
+            f_trnsp = self.opts['force_transparency'][1]
             calcf = self.opts['calculated_color_factor'][1]
-            auto = self.opts['auto_update_theme']
+            auto = self.opts['auto_update_theme'][1]
         else:
             theme = self.bck_opts['theme'] if not self.bck_opts['auto_update_theme'] else '*' + self.bck_opts['theme']
             trnsp = self.bck_opts['use_transparency']

pyradio/config_window.py

@@ -88,6 +88,7 @@ class PyRadioConfigWindow(object):
     "If True and a compositor is running, the stations' window background will be transparent.", '|', "If True and a compositor is not running, the terminal's background color will be used.", '|', 'Default value: False'])
     _help_text.append(['This option, when enabled, will make all themes behave as if their transparency setting was set to 2 (Obey config setting), in which case the windows\'s transparency will depend entirely on the value of the "Use transparency" setting (the option above this one).', '|', 'Default value: False'])
     _help_text.append(['Pyradio can calculate and use an alternative color for secondary windows.', '|', 'This option will determine if this color will be used (value > 0) or not (value = 0), provided that the theme used does not already provide it.', '|', 'The value of this option is actually the factor to darken or lighten the main (stations) background color.', '|', 'You can get more info on this at https://github.com/coderholic/pyradio#secondary-windows-background', '|', 'Valid Values: 0-0.2', 'Default value: 0'])
+    _help_text.append(['The console theme is the one used when PyRadio is executed either from the Linux Virtual Console or the terminal used does not support color changes.', '|', 'This change will take effect after PyRadio is restarted.', '|', 'Default value: dark'])
     _help_text.append(None)
     _help_text.append(['Specify whether you will be asked to confirm every station deletion action.',
     '|', 'Default value: True'])
@@ -882,6 +883,17 @@ def keypress(self, char):
                 self._win.refresh()
                 return -1, []
 
+        elif val[0] == 'console_theme':
+            if char in (
+                    curses.KEY_RIGHT, ord('l'), ord(' ')
+                        ):
+                if self._config_options['console_theme'][1] == 'dark':
+                    self._config_options['console_theme'][1] = 'light'
+                else:
+                    self._config_options['console_theme'][1] = 'dark'
+            self.refresh_selection()
+            return -1, []
+
         elif val[0] == 'connection_timeout':
             if char in (curses.KEY_RIGHT, ord('l')):
                 t = int(val[1][1])

pyradio/html_help.py

@@ -2,7 +2,7 @@
 import subprocess
 import logging
 from sys import platform
-from os import path, environ
+from os import path, environ, listdir
 from shutil import which
 from .install import get_a_linux_resource_opener
 try:
@@ -16,22 +16,36 @@
 import locale
 locale.setlocale(locale.LC_ALL, "")
 
+'''
+    0 : perform detection
+    1 : Graphical Environment running
+    2 : Graphical Environment not running
+'''
+HAS_GRAPHICAL_ENV = 0
+
 def convert_to_md(a_file):
     tmp_file = a_file[:-4] + 'md'
     return tmp_file if path.exists(tmp_file) else a_file
 
 def is_graphical_environment_running():
+    global HAS_GRAPHICAL_ENV
+    if HAS_GRAPHICAL_ENV == 1:
+        return True
+    elif HAS_GRAPHICAL_ENV == 2:
+        return False
     if which('pgrep'):
         # Check if Xorg is running
         xorg_process = subprocess.run(['pgrep', '-x', 'Xorg'], stdout=subprocess.PIPE)
         if xorg_process.returncode == 0:
+            HAS_GRAPHICAL_ENV = 1
             return True
         # Check if Wayland is running
         wayland_process = subprocess.run(['pgrep', '-x', 'wayland'], stdout=subprocess.PIPE)
         if wayland_process.returncode == 0:
+            HAS_GRAPHICAL_ENV = 1
             return True
     elif path.exists('/proc'):
-        for pid in os.listdir('/proc'):
+        for pid in listdir('/proc'):
             if pid.isdigit():
                 try:
                     with open(f'/proc/{pid}/cmdline', 'rb') as f:
@@ -45,12 +59,15 @@ def is_graphical_environment_running():
         for proc in psutil.process_iter(['pid', 'name']):
             if proc.info['name'] == 'Xorg' \
                     or proc.info['name'] == 'wayland':
+                HAS_GRAPHICAL_ENV = 1
                 return True
 
     # Check if DISPLAY environment variable is set
     if 'DISPLAY' in environ:
+        HAS_GRAPHICAL_ENV = 1
         return True
 
+    HAS_GRAPHICAL_ENV = 2
     return False
 
 class HtmlHelp(object):

pyradio/main.py

@@ -23,6 +23,7 @@
 from .common import StationsChanges
 from .schedule import PyRadioScheduleList
 from .install import get_a_linux_resource_opener
+from .html_help import is_graphical_environment_running
 import locale
 locale.setlocale(locale.LC_ALL, "")
 
@@ -952,7 +953,18 @@ def shell():
                     upd.user = is_pyradio_user_installed()
                     upd.update_pyradio()
             else:
-                print('\nThank you for using [magenta]PyRadio[/magenta]. Cheers!')
+                st = en = ''
+                if platform.startswith('win') or \
+                        platform.lower().startswith('dar'):
+                    st = '\n'
+                else:
+                    if is_graphical_environment_running():
+                        st = '\n'
+                    else:
+                        import subprocess
+                        subprocess.call('clear')
+                        en = '\n'
+                print(st + 'Thank you for using [magenta]PyRadio[/magenta]. Cheers!' + en)
         else:
             print('\nThis terminal can not display colors.\nPyRadio cannot function in such a terminal.\n')