Implementing playlist rename and updating docs

Author: s-n-g

Changelog

@@ -1,6 +1,9 @@
-2020-07-16 s-n-g
-    * 0.8.8-beta2
+2020-09-29 s-n-g
+    * Version 0.8.7.3 (0.8.8-beta2)
     * Adding PASTE MODE in editing windows
+    * Finalizing alternative modes (registers, register mode,
+      extra commands, yank i.e. copy) - implementation
+      started in 0.8.8-beta1
     * Toggling transparency enabled in theme selection window
     * Pyradio respects global encoding
     * Info window gets updated as data are read
@@ -12,6 +15,16 @@
     * Build script will clean up previous installation files (not on Windows)
     * Fixing volume saving on Windows
 
+    Implemented in 0.8.8-beta1
+    * Connection timeout counter
+    * Station info window
+    * Main help window has 3 pages now
+    * Fixing playback restart when encoding changed
+
+    Not implemented yet
+    * /p - Select playlist/register to paste station
+    * /n - Create new playlist
+
 2020-03-16 s-n-g
     * Version 0.8.7.2
     * Fixing macOS Catalina installation
@@ -29,7 +42,7 @@
     * g prefixed by a number jumps to it (same as G)
     * Dead keys (alternative mode and jump number) are
       now displayed at the bottom right corner of the window
-    * Main help window has 3 pages nows
+    * Main help window has 3 pages now
     * Fixing playback restart when encoding changed
     * Replacing widechar.py with cjkwrap.py and adding its
       update script in devel/

README.html

@@ -352,7 +352,7 @@ <h2 id="pyradio-themes">PyRadio Themes <span style="padding-left: 10px;"><sup st
 </ol>
 <p>The visual result of an applied theme greatly depends on the terminal settings (e.g. foreground and background color settings, palette used, number of colors supported, real or pseudo-transparency support, etc.)</p>
 <p>Pressing “<strong>t</strong>” will bring up the <em>Theme selection window</em>, which can be used to activate a theme and set the default one.</p>
-<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> Themes that use more colors than those supported by the terminal in use, will not be present in the <em>Theme selection window</em>. Furthermore, if a such at theme is set as default (or requested using the “<strong>-t</strong>” command line option), <strong>PyRadio</strong> will silently fall-back to the “<strong>dark</strong>” theme (or the “<strong>light</strong>” theme, if the terminal supports 8 colors and default theme is set to “<em>light_16_colors</em>”).</p>
+<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> Themes that use more colors than those supported by the terminal in use, will not be present in the <em>Theme selection window</em>. Furthermore, if a such at theme is set as default (or requested using the “<strong>-t</strong>” command line option), <strong>PyRadio</strong> will fall-back to the “<strong>dark</strong>” theme (or the “<strong>light</strong>” theme, if the terminal supports 8 colors and default theme is set to “<em>light_16_colors</em>”), and will display a relevant message at program startup.</p>
 <p>The <em>Theme selection window</em> will remain open after activating a theme, so that the user can inspect the visual result and easily change it, if desired. Then, when he is satisfied with the activated theme, the window will have to be manually closed (by pressing “<strong>q</strong>” or any other relevant key - pressing “<strong>?</strong>” will bring up its help).</p>
 <p>The use of custom themes and theme editing is not implemented yet; these are features for future releases.</p>
 <h3 id="using-transparency">Using transparency</h3>
@@ -384,6 +384,18 @@ <h2 id="cleaning-up">Cleaning up <span style="padding-left: 10px;"><sup style="f
 <p>As we see, previous versions still exist in this system: <strong>0.7.6.2</strong> and <strong>0.7.7</strong>. These files (actually directories) can safely be removed:</p>
 <pre>$ sudo rm -rf /usr/lib/python3.7/site-packages/pyradio-.7.6.2-py3.7.egg
 $ sudo rm -rf /usr/lib/python3.7/site-packages/pyradio-0.7.7-py3.7.egg</pre>
+<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> Since version 0.8.7.3 (0.8.8-beta2), it is not necessary to follow the previous procedure any more; <strong>PyRadio</strong> will search and remove any previously installed files when the “<strong>-u</strong>” (uninstall) parameter is used.</p>
+<p>Example:</p>
+<pre>$ devel/build_install_pyradio -u
+Uninstalling PyRadio
+** Removing executable ... done
+** Removing help files ... done
+Looking for python installed files
+** Removing &quot;pyradio-0.8.8-py3.8.egg&quot; ... done
+** Removing &quot;pyradio-0.8.6-py2.7.egg&quot; ... done
+** Removing &quot;pyradio-0.8.8-py3.8.egg&quot; ... done
+PyRadio successfully uninstalled</pre>
+<p>In this example, running <em>devel/build_install_pyradio -u</em> has removed <strong>PyRadio</strong> python 3.8 system wide installation files, <strong>PyRadio</strong> python 2.7 system wide installation files, and <strong>PyRadio</strong> python 3.8 user installation files, found in the system.</p>
 <h2 id="debug-mode">Debug mode <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
 <p>Adding the “<strong>-d</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 target="_blank" href="https://github.com/coderholic/pyradio/issues">open at github</a>.</p>

README.md

@@ -500,7 +500,7 @@ The visual result of an applied theme greatly depends on the terminal settings (
 
 Pressing "**t**" will bring up the *Theme selection window*, which can be used to activate a theme and set the default one.
 
-**Note:** Themes that use more colors than those supported by the terminal in use, will not be present in the *Theme selection window*. Furthermore, if a such at theme is set as default (or requested using the "**-t**" command line option), **PyRadio** will silently fall-back to the "**dark**" theme (or the "**light**" theme, if the terminal supports 8 colors and default theme is set to "*light_16_colors*").
+**Note:** Themes that use more colors than those supported by the terminal in use, will not be present in the *Theme selection window*. Furthermore, if a such at theme is set as default (or requested using the "**-t**" command line option), **PyRadio** will fall-back to the "**dark**" theme (or the "**light**" theme, if the terminal supports 8 colors and default theme is set to "*light_16_colors*"), and will display a relevant message at program startup.
 
 The  *Theme selection window* will remain open after activating a theme, so that the user can inspect the visual result and easily change it, if desired. Then, when he is satisfied with the activated theme, the window will have to be manually closed (by pressing "**q**" or any other relevant key - pressing "**?**" will bring up its help).
 
@@ -558,6 +558,21 @@ As we see, previous versions still exist in this system: **0.7.6.2** and **0.7.7
     $ sudo rm -rf /usr/lib/python3.7/site-packages/pyradio-.7.6.2-py3.7.egg
     $ sudo rm -rf /usr/lib/python3.7/site-packages/pyradio-0.7.7-py3.7.egg
 
+**Note:** Since version 0.8.7.3 (0.8.8-beta2), it is not necessary to follow the previous procedure any more; **PyRadio** will search and remove any previously installed files when the "**-u**" (uninstall) parameter is used.
+
+Example:
+
+    $ devel/build_install_pyradio -u
+    Uninstalling PyRadio
+    ** Removing executable ... done
+    ** Removing help files ... done
+    Looking for python installed files
+    ** Removing "pyradio-0.8.8-py3.8.egg" ... done
+    ** Removing "pyradio-0.8.6-py2.7.egg" ... done
+    ** Removing "pyradio-0.8.8-py3.8.egg" ... done
+    PyRadio successfully uninstalled
+
+In this example, running *devel/build_install_pyradio -u* has removed **PyRadio** python 3.8 system wide installation files, **PyRadio** python 2.7 system wide installation files,  and **PyRadio** python 3.8 user installation files, found in the system.
 
 ## Debug mode
 

devel/build_install_pyradio

@@ -42,6 +42,7 @@ APATH=$(python3 -m site --user-site 2>/dev/null) && echo "$APATH"
 }
 
 function remove_paths(){
+echo "Looking for python installed files..."
 find_paths | sort -u > /tmp/pyradio-uninstall.$$
 while read line;do
     [ -d "$line" ] && {
@@ -64,7 +65,7 @@ function uninstall(){
         echo "PyRadio is not installed..."
         exit
     }
-    echo 'Uninstalling PyRadio'
+    sudo echo 'Uninstalling PyRadio'
     user=$(which pyradio | grep '\.local')
     [ -z "$user" ] && {
         echo -n '** Removing executable ... '

pyradio.1

@@ -1,7 +1,7 @@
 .\" Copyright (C) 2011 Ben Dowling <http://www.coderholic.com/pyradio>
 .\" This manual is freely distributable under the terms of the GPL.
 .\"
-.TH PYRADIO 1 "January 2020"
+.TH PYRADIO 1 "September 2020"
 
 .SH NAME
 .PP
@@ -595,13 +595,14 @@ The visual result of an applied theme greatly depends on the terminal settings (
 Pressing "\fBt\fR" will bring up the \fITheme selection window\fR, which can be used to activate a theme and set the default one.
 
 .IP \fBNote\fR
-Themes that use more colors than those supported by the terminal in use, will not be present in the \fITheme selection window\fR. Furthermore, if a such a theme is set as default (or requested using the "\fB-t\fR" command line option), \fBpyradio\fR will silently fall-back to the "\fBdark\fR" theme. (or the "\fBlight\fR" theme, if the terminal supports 8 colors and default theme is set to "\fIlight_16_colors\fR").
+Themes that use more colors than those supported by the terminal in use, will not be present in the \fITheme selection window\fR. Furthermore, if a such a theme is set as default (or requested using the "\fB-t\fR" command line option), \fBpyradio\fR will fall-back to the "\fBdark\fR" theme, (or the "\fBlight\fR" theme, if the terminal supports 8 colors and default theme is set to "\fIlight_16_colors\fR"), and will display a relevant messages at program startup.
 
 .PP
 The \fITheme selection window\fR will remain open after activating a theme, so that the user can inspect the visual result and easily change it, if desired. Then, when he is satisfied with the activated theme, the window will have to be manually closed (by pressing "\fBq\fR" or any other relevant key - pressing "\fB?\fR" will bring up its help).
 
 The use of custom themes and theme editing is not implemented yet; theses are features for future releases.
 
+.PP
 \fBUSING TRANSPARENCY\fR
 
 \fBpyradio\fR themes are able to be used with a transparent background.
@@ -666,6 +667,24 @@ As we see, previous versions still exist in this system: \fB0.7.6.2\fR and \fB0.
 .br
 \fI$ \fBsudo rm -rf /usr/lib/python3.7/site-packages/pyradio-\fI0.7.7\fB-py3.7.egg
 
+
+.IP \fBNote:
+Since version 0.8.7.3 (0.8.8-beta2), it is not necessary to follow the previous procedure any more; \fBpyradio\fR will search and remove any previously installed files when the "\fB-u\fR" (uninstall) parameter is used.
+
+Example:
+
+    \fI$ \fBdevel/build_install_pyradio -u\fI
+    Uninstalling PyRadio
+    ** Removing executable ... done
+    ** Removing help files ... done
+    Looking for python installed files
+    ** Removing "pyradio-\fB0.8.8-py3.8\fI.egg" ... done
+    ** Removing "pyradio-\fB0.8.6-py2.7\fI.egg" ... done
+    ** Removing "pyradio-\fB0.8.8-py3.8\fI.egg" ... done
+    PyRadio successfully uninstalled\fR
+
+In this example, running \fIdevel/build_install_pyradio -u\fR has removed \fBpyradio\fR python 3.8 system wide installation files, \fBpyradio\fR python 2.7 system wide installation files,  and \fBpyradio\fR python 3.8 user installation files, found in the system.
+
 .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/config.py

@@ -807,9 +807,10 @@ def switch_stations(self, source, target):
         return True, self.number_of_stations
 
     def registers_exist(self):
-        if glob.glob(path.join(self.registers_dir, '*.csv')):
-            return True
-        return False
+        return True if glob.glob(path.join(self.registers_dir, '*.csv')) else False
+
+    def just_read_playlists(self):
+        self.playlists = glob.glob(path.join(self.stations_dir, '*.csv'))
 
     def read_playlists(self):
         self.playlists = []
@@ -900,6 +901,18 @@ def history_item(self, an_item=-1):
         logger.error('DE /// history_item = {}'.format(self._ps._p[an_item]))
         return self._ps._p[an_item][:]
 
+    def find_history_by_station_path(self, a_path):
+        return self._ps._find_history_by_id(a_path, 'path')
+
+    def find_history_by_station_name(self, a_name):
+        return self._ps._find_history_by_id(a_name, 'file_name')
+
+    def find_history_by_station_title(self, a_title):
+        ret, ret_index, rev_ret_index = self._ps._find_history_by_id(a_title, 'title')
+        if not ret:
+            ret, ret_index, rev_ret_index = self._ps._find_history_by_id(a_title.replace('_', ' '), 'title')
+        return ret, ret_index, rev_ret_index
+
 class PyRadioConfig(PyRadioStations):
 
     theme_not_supported = False
@@ -1326,6 +1339,7 @@ class PyRadioPlaylistStack(object):
     _id = {'station_path': 0,
            'path': 0,
            'station_file_name': 1,
+           'file_name': 1,
            'filename': 1,
            'station_title': 2,
            'title': 2,
@@ -1462,9 +1476,11 @@ def add(self, station_path='',
             is_register=False,
             browsing_station_service=False):
         if len(self._p) > 1 and station_path:
-            if self._p[-2][self._id['station_path']] == station_path:
+            if self._p[-1][self._id['station_path']] == station_path:
                 if logger.isEnabledFor(logging.DEBUG):
-                    logger.debug('PyRadioPlaylistStack.add(): Refusing to add duplicate entry: "{}"'.format(station_path))
+                    logger.debug('PyRadioPlaylistStack.add(): Refusing to add duplicate entry: "{}"\nUpdating selections instead'.format(station_path))
+                    logger.debug('                            Updating selections instead')
+                self._p[-1][3:6] = [startPos, selection, playing]
                 return
         if is_register:
             while self._p[-1][self._id['is_register']]:
@@ -1483,6 +1499,27 @@ def get_item_member(self, member, item_id=-1):
         else:
             raise ValueError('member "{}" does not exist'.format(member))
 
+    def _find_history_by_id(self, a_search, it_id, start=0):
+        """ Find a history item
+
+            Parameters
+            ==========
+            a_search search term
+            it_id    one of the _id strings
+            start    return id if >0 start
+
+            Returns
+            =======
+            history item,
+            index,
+            reversed index (len - id - 1)
+        """
+        logger.error('DE looking for: ' + a_search + ' with id: ' + it_id)
+        for i, n in enumerate(self._p):
+            if (n[self._id[it_id]] == a_search) and (i >= start):
+                return n, i, len(self._p) - i - 1
+        return None, -1, -1
+
     def pop(self):
         if len(self._p) > 1:
             return self._p.pop()

pyradio/edit.py

@@ -5,6 +5,7 @@
 import logging
 from sys import version_info
 from os import path, remove
+from string import punctuation as string_punctuation
 try:
     # python 3
     from urllib.parse import urlparse
@@ -593,6 +594,7 @@ class PyRadioRenameFile(object):
     """ PyRadio copy file dialog """
 
     def __init__(self, filename, parent, create=False, open_afterwards=True, title='', opened_from_editor = False):
+        self._invalid_chars = '<>|:"\\/?*'
         self.maxY = self.maxX = 0
         self._win = self._parent_win = self._line_editor = None
         self._focus = 0
@@ -677,16 +679,32 @@ def set_parent(self, val, refresh=True):
             self.show()
 
     def _string_changed(self):
-        stripped_string = self._widgets[0].string.strip()
         self._error_string = ''
-        if stripped_string:
-            check_file = path.join(self._to_path, stripped_string + '.csv')
-            if check_file == self.filename:
-                self._error_string = 'You must be joking!!!'
-            elif path.exists(check_file):
-                self._error_string = 'File already exists!!!'
-            elif check_file.startswith('register_'):
+        first_char = ''
+        if self._widgets[0].string != '':
+            first_char = self._widgets[0].string[0]
+            if first_char in string_punctuation + ' ':
                 self._error_string = 'Invalid filename!!!'
+        stripped_string = self._widgets[0].string.strip()
+        if self._error_string == '':
+            if stripped_string:
+                check_file = path.join(self._to_path, stripped_string + '.csv')
+                if check_file == self.filename:
+                    self._error_string = 'You must be joking!!!'
+                elif path.exists(check_file):
+                    self._error_string = 'File already exists!!!'
+                elif stripped_string.startswith('register_'):
+                    self._error_string = 'Register token inserted!!!'
+                else:
+                    for inv in self._invalid_chars:
+                        if inv in stripped_string:
+                            self._error_string = 'Invalid filename!!!'
+                            logger.error('DE inv = ' + inv)
+                            break
+                    #if self._error_string == '':
+                    #    for inv in range(1, 32):
+                    #        if str(inv) in stripped_string:
+                    #            self._error_string = 'Invalid filename!!!'
         self._widgets[-2].enabled = False
         if stripped_string and self._error_string == '':
             self._widgets[-2].enabled = True
@@ -807,6 +825,11 @@ def show(self):
                 curses.color_pair(5)
                 )
             self._win.addstr(2, 2, 'To:', curses.color_pair(4))
+            inv_tit = 'Invalid chars: '
+            inv_chars = self._invalid_chars
+            invX = self.maxX - len(inv_tit) - len(inv_chars) - 2
+            self._win.addstr(4, invX, inv_tit, curses.color_pair(4))
+            self._win.addstr(inv_chars, curses.color_pair(5))
 
         if self.maxY > 18 and self.maxX > 76:
             try: