Skip to content

Commit

Permalink
0001 Fixed various typos, harmonized naming and revised textual layou…
Browse files Browse the repository at this point in the history 
…ts.patch
  • Loading branch information
Markus Ehrnsperger committed Jul 29, 2024
1 parent 7a612d3 commit c6344d4
Show file tree
Hide file tree
Showing 64 changed files with 548 additions and 479 deletions.
80 changes: 40 additions & 40 deletions README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,18 @@ PCRE2 >= 10.38 - https://github.com/PhilipHazel/pcre2/releases
Tntnet >= 2.2.1 - http://www.tntnet.org/download.hms // https://web.archive.org/web/20160314183814/http://www.tntnet.org/download.html
Cxxtools >= 2.2.1 - http://www.tntnet.org/download.hms // https://web.archive.org/web/20160314183814/http://www.tntnet.org/download.html

Tntnet provides basic webserver functions for live and needs cxxtools.
Tntnet provides basic Web server functions for live and needs cxxtools.
Boost provides some data structures we need. While currently relying on the
full blown package we might provide a stripped down version in the future.

PCRE2 provides filtering for recordings using perl regexp language.
PCRE2 provides filtering for recordings using Perl regexp language.
If you don't need filtering, PCRE2 is optional.

If you optionaly want to regenerate the i18n-generated.h header file
If you optionally want to regenerate the i18n-generated.h header file
for backward compatible i18n (VDR version prior to 1.5.7) you also
need: (See also the Internationalization section below)

Locale::PO - perl module from CPAN www.cpan.org
Locale::PO - Perl module from CPAN www.cpan.org

The default i18n-generated.h header contains all
translations from GIT. Users that just want to stay on bleeding development
Expand All @@ -77,7 +77,7 @@ copy the resulting binary to VDRs directory where the other plugins
are expected.

In order to work correctly you must copy the subdirectory 'live' from
the source distribution to the directory where the vdr plugins look
the source distribution to the directory where the VDR plugins look
for their resource files. The pure VDR default for this config
directory is: /video/plugins, but this depends also from the
parameters -c or -v (see 'vdr --help' for details).
Expand All @@ -95,7 +95,7 @@ the internet. The default username and password are:

The default port is 8008.

You can also specifiy this parameter via commandline:
You can also specify this parameter via command line:

-p PORT, --port=PORT use PORT to listen for incoming connections
(default: 8008)
Expand All @@ -104,7 +104,7 @@ You can also specifiy this parameter via commandline:
(default: 0.0.0.0, ::0)

Additional SSL options are available now. See "How to make LIVE listen
for ssl connections" section below on hints how to setup SSL.
for SSL connections" section below on hints how to setup SSL.

To display images or channel logos, you can use:

Expand All @@ -122,47 +122,47 @@ interface.
The password is stored as a MD5 hash.
"Last Channel" is the last channel in the channels list, that live displays.
This is especially useful if you have VDR's automatic channel update active.
For example, you can add a group seperator ":@1000 Found automatically" to
For example, you can add a group separator ":@1000 Found automatically" to
channels.conf and set this parameter to "1000". Thus, everything VDR finds
during scanning (which can after a few months be well more than 3000
channels) won't be displayed.


How to make LIVE listen for ssl connections:
How to make LIVE listen for SSL connections:
============================================

To make LIVE listen for incoming ssl connections you`ll have to use a
To make LIVE listen for incoming SSL connections you`ll have to use a
Tntnet version > 1.6.0.6. By default it will listen on port 8443.

* Example: https://localhost:8443

In order to start the SslListener LIVE requires a SSL certificate. If
no SSL certificate is specified via commandline option, LIVE will try
no SSL certificate is specified via command-line option, LIVE will try
to use the default certificate location
'$VDRDIR/plugins/live/live.pem'.

If neither the default nor the custom certificate (given by the
commandline option) could be found, LIVE will only start the default
command-line option) could be found, LIVE will only start the default
HTTP Listener (default: 8008)

If you want do disable the SslListener for any reason, specify ssl port
number 0 with the commandline option.
If you want do disable the SslListener for any reason, specify SSL port
number 0 with the command-line option.

Note: Since the gnutls SslListener was broken in Tntnet versions prior
Note: Since the GNU TLS SslListener was broken in Tntnet versions prior
to SVN revision 1035 you will have to recompile Tntnet with
"./configure --with-ssl=openssl" to make it work. Alternatively
install version 1.6.2 or higher of tntnet on your system.
install version 1.6.2 or higher of Tntnet on your system.


SSL Commandline options:
========================
SSL Command-line options:
=========================

-s PORT, --sslport=PORT use PORT to listen for incoming ssl connections
-s PORT, --sslport=PORT use PORT to listen for incoming SSL connections
(default: 8443)
use PORT 0 to disable incoming ssl connections
-c CERT, --cert=CERT path to a custom ssl certificate file
use PORT 0 to disable incoming SSL connections
-c CERT, --cert=CERT path to a custom SSL certificate file
(default: $CONFIGDIR/live.pem)
-k KEY, --cert=CERT path to a custom ssl certificate key file
-k KEY, --cert=CERT path to a custom SSL certificate key file
(default: $CONFIGDIR/live-key.pem)


Expand All @@ -175,25 +175,25 @@ command.
$> cd /put/your/path/here/vdr/plugins/live
$> openssl req -new -x509 -keyout live-key.pem -out live.pem -days 365 -nodes

While generating the certifcate you`ll be asked to answer a couple of
While generating the certificate you`ll be asked to answer a couple of
questions. When it prompts to enter the "Common Name" you`ll have to
specify the full qualified dns server name of the machine LIVE is
running on (eg. vdr.example.com). If your vdr doesn`t have a full
qualified dns name, you should use the ip LIVE is listening on.
specify the full qualified DNS server name of the machine LIVE is
running on (e.g. vdr.example.com). If your VDR doesn't have a full
qualified DNS name, you should use the IP Live is listening on.

Note: This is just a quick'n dirty way to create a SSL self-signed
certicate. Recent browsers (like Firefox 3) will complain about it
because the certificate wasn´t signed by a known Certificate Authority
Note: This is just a quick-and-dirty way to create a SSL self-signed
certificate. Recent browsers (like Firefox 3) will complain about it
because the certificate wasn't signed by a known Certificate Authority
(CA).


So how does LIVE work?
======================

Basically, Live itself is a Tntnet webserver integrated into the
Basically, Live itself is a Tntnet Web server integrated into the
plugin structure VDR needs.

This webserver, running in VDR's environment, is provided with all
This Web server, running in VDR's environment, is provided with all
public data structures VDR provides for plugins and thus has very fast
access to information like the EPG, timers or recordings.

Expand All @@ -208,8 +208,8 @@ If you would like to contribute, please read doc/dev-contribute.txt
and doc/TODO.txt.


Internationalization (i18n)
===========================
Internationalization (i18n):
============================

LIVE uses the same i18n support like VDR does since version 1.5.7.
This version of LIVE can not support i18n compatible with VDR versions
Expand All @@ -219,8 +219,8 @@ All localization files are found in the po subdirectory of the LIVE
plugin source.


Security consideratios
======================
Security considerations:
========================

Please use live in a controlled environment only, like your home network
or a save VPN of your home network.
Expand All @@ -230,12 +230,12 @@ Of course, better security is always appreciated, so please send
patches increasing security.

One possible security issue (there might be others ...):
Live uses the tntnet MapUrl mechanism to map different request urls to
tntnet components. One component 'content.ecpp' delivers files found
Live uses the Tntnet MapUrl mechanism to map different request URLs to
Tntnet components. One component 'content.ecpp' delivers files found
in the file system. When given the wrong 'path' it could retrieve any
file from the server where live runs on. Therefore content.ecpp has
beem enhanced to check the paths before returning files. A second
measure against missuse is to limit the mappings from MapUrl to only
been enhanced to check the paths before returning files. A second
measure against misuse is to limit the mappings from MapUrl to only
valid files. In the current version this approach has been taken. But
due to the 'difficulty' to fully understand regular expressions, this
might get spoiled again by 'unchecked' code contribution.
Expand All @@ -248,6 +248,6 @@ If VDR crashes on start with these journal messages:
terminate called after throwing an instance of 'std::runtime_error'
what(): locale::facet::_S_create_c_locale name not valid

Most likely, the locale is not installed correctly. On debian based systems, use:
Most likely, the locale is not installed correctly. On Debian based systems, use:
dpkg-reconfigure locales
and restart VDR.
2 changes: 1 addition & 1 deletion StringMatch.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#ifdef HAVE_PCRE2
#include <string>
#if TNTVERSION >= 30000
#include <cxxtools/log.h> // must be loaded before any vdr include because of duplicate macros (LOG_ERROR, LOG_DEBUG, LOG_INFO)
#include <cxxtools/log.h> // must be loaded before any VDR include because of duplicate macros (LOG_ERROR, LOG_DEBUG, LOG_INFO)
#endif
#include <vdr/channels.h>
#include "stringhelpers.h"
Expand Down
2 changes: 1 addition & 1 deletion buildutil/version-util
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# repository versions. For CVS repositories the string contains the
# date and time of the commit that lead to the current version of
# files. For git repositories the output contains the git-id of the
# current tree. An indication if localy modified files exist is
# current tree. An indication if locally modified files exist is
# added currently only for CVS.
# -----------------------------------------------------------------------------

Expand Down
40 changes: 20 additions & 20 deletions doc/ChangeLog
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@
* buildutil/version-util*: Added a shell and an awk script to
calculate a version suffix string out of CVS current working dir
status. This was a request bei jo01 and helps distinguish if
newer versions are awailable. It should not break builds if
newer versions are available. It should not break builds if
something goes wrong in the script. At least it was my
intention. The script also supports git repositories. But it
has not been tested if it determines the correct git commit id
based on current workdir contents. The caluculated version
based on current workdir contents. The calculated version
suffix is appended to the LIVE version string visible in the
about box (?-Menu entry).

Expand All @@ -82,7 +82,7 @@

- Added configuration option to disable the creation of IMDb URLs
in the epg-info sections. This was done upon of feature
reqest (Bug #401).
request (Bug #401).
Some minor fixes for the IMDb URLs in recordings.

2007-12-23 Dieter Hametner <dh+vdr at gekrumbel dot de>
Expand All @@ -94,14 +94,14 @@
Changed top level Makefile to not create headers in live.pot
file. This prevents creation of new date header in .po file at
fresh translations after updates from CVS and should avoid
continous conflicts at every cvs update even if no changes took
continuous conflicts at every CVS update even if no changes took
place in the local files.

2007-12-22 Dieter Hametner <dh+vdr at gekrumbel dot de>

* live/js/live/vlc.js
Added an own mootools based implementation of a controlling
class for the vlc plugin as proposed by Rolf Ahrenberg.
class for the VLC plugin as proposed by Rolf Ahrenberg.
Features currently supported are:
- start/stop play (pause is left out because it provides no
timeshift functionality).
Expand Down Expand Up @@ -165,19 +165,19 @@

2007-08-19 Dieter Hametner <dh+vdr at gekrumbel dot de>

- Adapted (but not tested) live for the new localisation scheme
- Adapted (but not tested) live for the new localization scheme
since VDR 1.5.7
Might need some additional tweaking...

2007-07-29 Dieter Hametner <dh+vdr at gekrumbel dot de>

- Implemented status notification popup if ajax is active.
- Without Ajax it is now possible to request actions from vdr via
- Implemented status notification popup if AJAX is active.
- Without Ajax it is now possible to request actions from VDR via
a static page.

2007-07-22 Dieter Hametner <dh+vdr at gekrumbel dot de>

Added toolbox buttons to epg info popup windows.
Added toolbox buttons to EPG info popup windows.
Some style fixes for this.
* pages/whats_on.ecpp: Use new pageelems.epg_tool_box component.
* pages/pageelems.ecpp: new epg_tool_box component.
Expand All @@ -186,31 +186,31 @@

* live/js/live/pageenhance.js: Enhance a normal web page with
nifty web 2.0 features.
* live/js/live/infowin.js: stand alone class. Used by pageenhance.js
* live/js/live/hinttips.js: stand alone class. Used by pageenhance.js
* live/js/live/infowin.js: standalone class. Used by pageenhance.js
* live/js/live/hinttips.js: standalone class. Used by pageenhance.js

2007-07-21 Dieter Hametner <dh+vdr at gekrumbel dot de>

Made epgimages better styleable. Displaying them as floats right
of the epg description text.
Made EPG images better style-able. Displaying them as floats right
of the EPG description text.

2007-07-20 Christian Wieninger <cwieninger at gmx dot de>

Added support for EPG images: Specify the directory with your
EPG images via the new commandline option '-e <dir>' or
EPG images via the new command-line option '-e <dir>' or
'--epgimages=<dir> like
-P'live -e /video/epgimages'

2007-07-12 Dieter Hametner <dh+vdr at gekrumbel dot de>

Changed the javascript base of live. We now use the 'mootools'
framework (see http://www.mootools.net for infos) to handle
javascript in a browser independend fashion and for nifty Web 2.0
javascript in a browser independent fashion and for nifty Web 2.0
features.

Based on this framework we have now tooltips that use the XHTML
standard 'title' attribute and Web-2.0 popup windows for epg
information. This Epg information is loaded on demand and once
standard 'title' attribute and Web-2.0 popup windows for EPG
information. This EPG information is loaded on demand and once
loaded, they are cached in the page for further viewing.

On the other hand this also provides us with a solution to have
Expand Down Expand Up @@ -250,7 +250,7 @@
2007-06-13 Dieter Hametner <dh+vdr at gekrumbel dot de>

* pages/schedule.ecpp: If no channel is given, and a current
channel is known to vdr, select it when calling the schedule
channel is known to VDR, select it when calling the schedule
page in live.

2007-06-12 Dieter Hametner <dh+vdr at gekrumbel dot de>
Expand Down Expand Up @@ -290,7 +290,7 @@
doc/css-themeing.txt and doc/dev-conventions.txt.
* setup.h, setup.cpp, setup.ecpp: added setup for theme and
selection of theme.
* pages/*.ecpp: added support for themable images.
* pages/*.ecpp: added support for themeable images.
* tntconfig.cpp: cascaded search for images, to support themeing.

2007-06-03 Christian Wieninger <cwieninger at gmx dot de>
Expand Down Expand Up @@ -325,5 +325,5 @@
unrecorded Sascha Volkenandt <sascha at akv-soft dot de>

Due to the introduction of a uniform header for C++ standard
extenstions, the boost library is now only necessary if the used
extensions, the boost library is now only necessary if the used
g++ compiler version is less than 4.0
10 changes: 5 additions & 5 deletions doc/TODO.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ This is a list of ideas and TODO-Items for live plugin.
splitting style files in a similar way like it is done for YAML
(http://www.yaml.de)

- Create a CSS-themeing friendly url scheme. I.E. something like
- Create a CSS-themeing friendly URL scheme. I.E. something like
img/<theme>/button.png. Where default as theme is always taken if
<theme> is not found.
- Give users the chance to override the selected style with some
user-override settings.
- Deliver truely static content, like images, styles, ECMAscript
with tntnets sendfile functionality after resolving user selected
- Deliver truly static content, like images, styles, ECMAscript
with Tntnet's send-file functionality after resolving user selected
themes paths. Take care to support browser cache optimization.

- Deliver epg box infos through AJAX. This would make a ECMAScript
- Deliver EPG box information through AJAX. This would make a ECMAScript
capable browser mandatory.
- Provide a way to get the infos on extra 'static' pages.
- Provide a way to get the information on extra 'static' pages.


Loading

0 comments on commit c6344d4

Please sign in to comment.