├── var
    ├── mynoxon
    │   └── .keep
    ├── podcasts
    │   └── .keep
    ├── .mt-single
    │   └── .keep
    └── internetradio
    │   └── .keep
├── data
    ├── login-camelcase.xml
    ├── lighttpd-rewrite.conf
    ├── list-test.xml
    └── config.php.dist
├── docs
    └── screenshots
    │   └── browsing.png
├── .gitignore
├── www
    ├── .htaccess
    ├── deredirect.php
    ├── proxy.php
    ├── transcode-nocache.php
    ├── transcode-cache.php
    ├── html.xsl
    └── index.php
├── src
    ├── header.php
    ├── podcasts.php
    └── mediatomb.php
├── README.rst
└── LICENSE


/var/mynoxon/.keep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/var/podcasts/.keep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/var/.mt-single/.keep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/var/internetradio/.keep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/data/login-camelcase.xml:
--------------------------------------------------------------------------------
1 | <EncryptedToken>a6703ded78821be5</EncryptedToken>


--------------------------------------------------------------------------------
/docs/screenshots/browsing.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cweiske/noxon-gateway/master/docs/screenshots/browsing.png


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /var/internetradio/*
2 | /var/mynoxon/*
3 | /var/podcasts/*
4 | /README.html
5 | /data/config.php
6 | /www/cache/
7 | 


--------------------------------------------------------------------------------
/data/lighttpd-rewrite.conf:
--------------------------------------------------------------------------------
1 | # include this into your lighttpd host configuration
2 | url.rewrite-if-not-file = (
3 |     "^(.*)$" => "index.php/$1"
4 | )
5 | 


--------------------------------------------------------------------------------
/www/.htaccess:
--------------------------------------------------------------------------------
1 | RewriteEngine On
2 | RewriteBase /
3 | RewriteCond %{REQUEST_FILENAME} !-f
4 | RewriteCond %{REQUEST_FILENAME} !-d
5 | RewriteRule ^.*$ index.php
6 | 


--------------------------------------------------------------------------------
/data/list-test.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="iso-8859-1" standalone="yes" ?>
 2 | <ListOfItems>
 3 |   <ItemCount>-1</ItemCount>
 4 |   <Item>
 5 |     <ItemType>Dir</ItemType>
 6 |     <Title>Hallo!</Title>
 7 |     <UrlDir>http://radio567.vtuner.com/test</UrlDir>
 8 |     <UrlDirBackUp>http://radio5672.vtuner.com/test</UrlDirBackUp>
 9 |   </Item>
10 | </ListOfItems>
11 | 


--------------------------------------------------------------------------------
/data/config.php.dist:
--------------------------------------------------------------------------------
 1 | <?php
 2 | //$host1 = 'http://example.org/';
 3 | //$host2 = 'http://example.org/';
 4 | $mediatomb = array(
 5 |     'user' => 'fixme',
 6 |     'pass' => 'fixme',
 7 |     'host' => 'fixme',
 8 |     'port' => '49152',
 9 |     'singleFileDirectories' => array(
10 |         'internetradio/Kindergeschichten/'
11 |     ),
12 | );
13 | 
14 | //MIME types in addition to MP3 files that the clients
15 | //support (and do not need transcoding for)
16 | $clientSupport = [
17 |     '127.0.0.1' => [
18 |         'audio/ogg' => true,
19 |     ],
20 | ];
21 | 
22 | //if this is set, transcode caching is activated
23 | $enableCache = false;
24 | 
25 | //if this is true, podcast URLs are proxied
26 | $enablePodcastProxy = false;
27 | ?>
28 | 


--------------------------------------------------------------------------------
/src/header.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | set_include_path(get_include_path() . PATH_SEPARATOR . __DIR__ . '/../src/');
 3 | 
 4 | $requestUriNoQuery = explode('?', $_SERVER['REQUEST_URI'])[0];
 5 | $path = urldecode($requestUriNoQuery);
 6 | 
 7 | $dataDir = __DIR__ . '/../data/';
 8 | $varDir  = realpath(__DIR__ . '/../var') . '/';
 9 | $cacheDir = __DIR__ . '/../www/cache/';
10 | $host1 = 'http://radio567.vtuner.com/';
11 | $host2 = 'http://radio5672.vtuner.com/';
12 | if ($_SERVER['HTTP_HOST'] !== '') {
13 |     $host1 = 'http://' . $_SERVER['HTTP_HOST'] . '/';
14 |     $host2 = 'http://' . $_SERVER['HTTP_HOST'] . '/';
15 | }
16 | $cacheDirUrl = $host1 . 'cache/';
17 | $cfgFile = $dataDir . 'config.php';
18 | if (file_exists($cfgFile)) {
19 |     include $cfgFile;
20 | }
21 | ?>
22 | 


--------------------------------------------------------------------------------
/www/deredirect.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Follow all location redirects of a given URL and redirect to the final URL.
 4 |  *
 5 |  * Noxon iRadio Cube does not like too many redirections
 6 |  * 3 redirects did not work.
 7 |  */
 8 | $url = $_GET['url'];
 9 | header('HTTP/1.0 301 Moved Permanently');
10 | header('Location: ' . getFinalUrl($url));
11 | 
12 | function getFinalUrl($url)
13 | {
14 |     $ctx = stream_context_set_default(
15 |         array('http' => array('method' => 'HEAD'))
16 |     );
17 |     //get_headers follows redirects automatically
18 |     $headers = get_headers($url, 1);
19 |     if ($headers !== false && isset($headers['Location'])) {
20 |         if (is_array($headers['Location'])) {
21 |             return end($headers['Location']);
22 |         }
23 |         return $headers['Location'];
24 |     }
25 |     return $url;
26 | }
27 | ?>


--------------------------------------------------------------------------------
/www/proxy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * PHP proxy script that proxies the URL given in the "url" parameter.
 4 |  *
 5 |  * Sends all incoming headers, and also returns all remote headers.
 6 |  * Streams the response, so that large responses should work fine.
 7 |  *
 8 |  * @author Christian Weiske <cweiske@cweiske.de>
 9 |  */
10 | require_once __DIR__ . '/../data/config.php';
11 | if (!isset($enablePodcastProxy) || $enablePodcastProxy == false) {
12 |     header('HTTP/1.0 403 Forbidden');
13 |     echo "Proxying is not enabled in config.php\n";
14 |     exit(1);
15 | }
16 | 
17 | if (!isset($_GET['url']) || $_GET['url'] == '') {
18 |     header('HTTP/1.0 400 Bad Request');
19 |     echo "url parameter missing\n";
20 |     exit(1);
21 | }
22 | if (substr($_GET['url'], 0, 7) != 'http://'
23 |     && substr($_GET['url'], 0, 8) != 'https://'
24 | ) {
25 |     header('HTTP/1.0 400 Bad Request');
26 |     echo "Only http and https URLs supported\n";
27 |     exit(1);
28 | }
29 | 
30 | $url = $_GET['url'];
31 | 
32 | //send original http headers
33 | $headers = [];
34 | foreach (apache_request_headers() as $name => $value) {
35 |     if (strtolower($name) == 'host') {
36 |         continue;
37 |     }
38 |     $headers[] = $name . ': ' . $value;
39 | }
40 | $context = stream_context_create(
41 |     ['http' => ['header' => $headers, 'ignore_errors' => true]]
42 | );
43 | 
44 | $fp = fopen($url, 'r', false, $context);
45 | if (!$fp) {
46 |     header('HTTP/1.0 400 Bad Request');
47 |     echo "Error fetching URL\n";
48 |     exit(1);
49 | }
50 | 
51 | //send original headers
52 | if (is_array($http_response_header)) {
53 |     foreach ($http_response_header as $header) {
54 |         header($header);
55 |     }
56 | }
57 | 
58 | //stream the data in 1kiB blocks
59 | while(!feof($fp)) {
60 |     echo fread($fp, 1024);
61 |     flush();
62 | }
63 | fclose($fp);
64 | ?>
65 | 


--------------------------------------------------------------------------------
/www/transcode-nocache.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Transcode audio file URLs to .mp3 and stream it while
 4 |  * transcoding is in progress.
 5 |  */
 6 | //require_once __DIR__ . '/../src/header.php';
 7 | 
 8 | if (!isset($_GET['url'])) {
 9 |     errorOut('url parameter missing');
10 | }
11 | $parts = parse_url($_GET['url']);
12 | if ($parts === false || !isset($parts['scheme'])) {
13 |     errorOut('Invalid URL');
14 | }
15 | if ($parts['scheme'] !== 'http' && $parts['scheme'] !== 'https') {
16 |     errorOut('URL is neither http nor https');
17 | }
18 | $url = $_GET['url'];
19 | 
20 | $cmd = 'ffmpeg'
21 |     . ' -loglevel error'
22 |     . ' -i ' . escapeshellarg($url)
23 |     . ' -f mp3'
24 |     . ' -';
25 | 
26 | $descriptorspec = array(
27 |     1 => array('pipe', 'w'),// stdout is a pipe that the child will write to
28 |     2 => array('pipe', 'w')//stderr
29 | );
30 | 
31 | register_shutdown_function('shutdown');
32 | 
33 | $process = proc_open($cmd, $descriptorspec, $pipes);
34 | if (is_resource($process)) {
35 |     header('Content-type: audio/mpeg');
36 |     while ($data = fread($pipes[1], 10000)) {
37 |         //output to browser
38 |         echo $data;
39 |         //TODO: maybe flush() and ob_flush();
40 |     }
41 | 
42 |     $errors = stream_get_contents($pipes[2]);
43 |     fclose($pipes[1]);
44 |     fclose($pipes[2]);
45 |     $retval = proc_close($process);
46 | 
47 |     if ($retval !== 0) {
48 |         header('HTTP/1.0 500 Internal Server Error');
49 |         header('Content-type: text/plain');
50 |         echo "Error transcoding\n";
51 |         echo $errors . "\n";
52 |     }
53 | }
54 | 
55 | function shutdown()
56 | {
57 |     global $process, $pipes;
58 | 
59 |     if (connection_aborted()) {
60 |         //end ffmpeg and clean temp file
61 |         fclose($pipes[1]);
62 |         fclose($pipes[2]);
63 |         proc_terminate($process);
64 |     }
65 | }
66 | 
67 | function errorOut($msg)
68 | {
69 |     header('HTTP/1.0 400 Bad request');
70 |     header('Content-type: text/plain');
71 |     echo $msg . "\n";
72 |     exit(1);
73 | }
74 | ?>
75 | 


--------------------------------------------------------------------------------
/src/podcasts.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | function sendPodcast($path)
 3 | {
 4 |     global $varDir, $host1, $enablePodcastProxy;
 5 | 
 6 |     $file = urldecode($path);
 7 |     if (strpos($file, '..') !== false) {
 8 |         sendMessage('No');
 9 |         return;
10 |     }
11 | 
12 |     $fullPath = $varDir . $path;
13 |     if (!file_exists($fullPath)) {
14 |         return sendMessage('File does not exist: ' . $path);
15 |     }
16 | 
17 |     $url = trim(file_get_contents($fullPath));
18 | 
19 |     $cacheFile = '/tmp/podcast-' . md5($path) . '.xml';
20 |     downloadIfNewer($url, $cacheFile);
21 |     
22 |     $sx = simplexml_load_file($cacheFile);
23 |     $listItems = array();
24 | 
25 |     $urlHandler = $host1 . 'deredirect.php';
26 |     if ($enablePodcastProxy) {
27 |         $urlHandler = $host1 . 'proxy.php';
28 |     }
29 | 
30 |     foreach ($sx->channel->item as $item) {
31 |         $title = (string) $item->title;
32 |         $desc = (string) $item->description;
33 |         $url = $item->enclosure['url'];
34 | 
35 |         $listItems[] = getEpisodeItem(
36 |             $title,
37 |             $urlHandler . '?url=' . urlencode($url),
38 |             $desc,
39 |             'MP3'
40 |         );
41 |     }
42 |     sendListItems($listItems, buildPreviousItem($path));
43 | }
44 | 
45 | 
46 | function downloadIfNewer($url, $file)
47 | {
48 |     $lastModified = 0;
49 |     if (file_exists($file)) {
50 |         $lastModified = filemtime($file);
51 |     }
52 | 
53 |     $ctx = stream_context_create(
54 |         array(
55 |             'http' => array(
56 |                 'header' => 'If-Modified-Since: ' . date('r', $lastModified)
57 |             )
58 |         )
59 |     );
60 |     $content = file_get_contents($url, false, $ctx);
61 |     //unfortunately, redirects require manual parsing of this array
62 |     for ($n = count($http_response_header) - 1; $n >= 0; --$n) {
63 |         if (substr($http_response_header[$n], 0, 5) == 'HTTP/') {
64 |             list(, $code) = explode(' ', $http_response_header[$n]);
65 |             break;
66 |         }
67 |     }
68 |     if ($code == 200) {
69 |         file_put_contents($file, $content);
70 |     }
71 | }
72 | 
73 | ?>
74 | 


--------------------------------------------------------------------------------
/www/transcode-cache.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Transcode audio file URLs to .mp3, cache them and stream them while
  4 |  * transcoding is in progress.
  5 |  */
  6 | require_once __DIR__ . '/../src/header.php';
  7 | 
  8 | if (!isset($_GET['url'])) {
  9 |     errorOut('url parameter missing');
 10 | }
 11 | $parts = parse_url($_GET['url']);
 12 | if ($parts === false || !isset($parts['scheme'])) {
 13 |     errorOut('Invalid URL');
 14 | }
 15 | if ($parts['scheme'] !== 'http' && $parts['scheme'] !== 'https') {
 16 |     errorOut('URL is neither http nor https');
 17 | }
 18 | $url = $_GET['url'];
 19 | 
 20 | if (!is_dir($cacheDir)) {
 21 |     errorOut('Cache dir does not exist');
 22 | }
 23 | if (!is_writable($cacheDir)) {
 24 |     errorOut('Cache dir not writable');
 25 | }
 26 | 
 27 | $cacheFileName = str_replace(array(':', '/'), '-', $url) . '.mp3';
 28 | $cacheFilePath = $cacheDir . $cacheFileName;
 29 | 
 30 | if (file_exists($cacheFilePath)) {
 31 |     header('HTTP/1.0 302 Moved Temporarily');
 32 |     header('Location: ' . $cacheDirUrl . urlencode($cacheFileName));
 33 |     exit(1);
 34 | }
 35 | 
 36 | $cmd = 'ffmpeg'
 37 |     . ' -loglevel error'
 38 |     . ' -i ' . escapeshellarg($url)
 39 |     . ' -f mp3'
 40 |     . ' -';
 41 | 
 42 | $descriptorspec = array(
 43 |     1 => array('pipe', 'w'),// stdout is a pipe that the child will write to
 44 |     2 => array('pipe', 'w')//stderr
 45 | );
 46 | 
 47 | register_shutdown_function('shutdown');
 48 | 
 49 | $process = proc_open($cmd, $descriptorspec, $pipes);
 50 | if (is_resource($process)) {
 51 |     $tmpCacheFile = tempnam(sys_get_temp_dir(), 'transcode-cache-');
 52 |     $cacheHdl = fopen($tmpCacheFile, 'wb');
 53 |     header('Content-type: audio/mpeg');
 54 |     while ($data = fread($pipes[1], 1000)) {
 55 |         //write cache
 56 |         fwrite($cacheHdl, $data);
 57 |         //output to browser
 58 |         echo $data;
 59 |         //TODO: maybe flush() and ob_flush();
 60 |     }
 61 | 
 62 |     $errors = stream_get_contents($pipes[2]);
 63 |     fclose($pipes[1]);
 64 |     fclose($pipes[2]);
 65 |     $retval = proc_close($process);
 66 | 
 67 |     fclose($cacheHdl);
 68 |     if ($retval === 0) {
 69 |         rename($tmpCacheFile, $cacheFilePath);
 70 |     } else {
 71 |         header('HTTP/1.0 500 Internal Server Error');
 72 |         header('Content-type: text/plain');
 73 |         echo "Error transcoding\n";
 74 |         echo $errors . "\n";
 75 |         unlink($tmpCacheFile);
 76 |     }
 77 | }
 78 | 
 79 | function shutdown()
 80 | {
 81 |     global $process, $pipes, $tmpCacheFile;
 82 | 
 83 |     if (connection_aborted()) {
 84 |         //end ffmpeg and clean temp file
 85 |         fclose($pipes[1]);
 86 |         fclose($pipes[2]);
 87 |         proc_terminate($process);
 88 |         unlink($tmpCacheFile);
 89 |     }
 90 | }
 91 | 
 92 | function errorOut($msg)
 93 | {
 94 |     header('HTTP/1.0 400 Bad request');
 95 |     header('Content-type: text/plain');
 96 |     echo $msg . "\n";
 97 |     exit(1);
 98 | }
 99 | ?>
100 | 


--------------------------------------------------------------------------------
/www/html.xsl:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <xsl:stylesheet version="1.0"
  3 |   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  4 |   xmlns="http://www.w3.org/1999/xhtml">
  5 |   <xsl:template match="ListOfItems">
  6 |     <html>
  7 |       <head>
  8 |        <meta name="viewport" content="width=device-width, initial-scale=1"/>
  9 |       </head>
 10 |       <body>
 11 |        <xsl:for-each select="Item[ItemType='Previous']">
 12 |         <pre>
 13 |          <a>
 14 |           <xsl:attribute name="href">
 15 |            <xsl:value-of select="UrlPrevious"/>
 16 |           </xsl:attribute>
 17 |           <xsl:text>&lt; back</xsl:text>
 18 |          </a>
 19 |         </pre>
 20 |        </xsl:for-each>
 21 | 
 22 |        <xsl:if test="NoCache">
 23 |         <p>Caching disabled by <tt>NoCache</tt></p>
 24 |        </xsl:if>
 25 | 
 26 |        <xsl:if test="Item[ItemType='Message']">
 27 |         <h2>Messages</h2>
 28 |         <xsl:for-each select="Item[ItemType='Message']">
 29 |          <p>
 30 |           <xsl:value-of select="Message"/>
 31 |          </p>
 32 |         </xsl:for-each>
 33 |        </xsl:if>
 34 | 
 35 |        <pre style="border: 1px solid black">
 36 | 
 37 |         <xsl:for-each select="Item">
 38 |          <xsl:if test="ItemType='Display'">
 39 |           <xsl:text>[d] </xsl:text>
 40 |           <xsl:value-of select="Display"/><xsl:text>
 41 | </xsl:text>
 42 |          </xsl:if>
 43 | 
 44 |          <xsl:if test="ItemType='Dir'">
 45 |           <xsl:text>[D] </xsl:text>
 46 |           <a>
 47 |            <xsl:attribute name="href">
 48 |             <xsl:value-of select="UrlDir"/>
 49 |            </xsl:attribute>
 50 |            <xsl:value-of select="Title"/>
 51 |           </a>
 52 |           <xsl:text>
 53 | </xsl:text>
 54 |          </xsl:if>
 55 | 
 56 |          <xsl:if test="ItemType='ShowOnDemand'">
 57 |           <xsl:text>[S] </xsl:text>
 58 |            <a>
 59 |             <xsl:attribute name="href">
 60 |              <xsl:value-of select="ShowOnDemandURL"/>
 61 |             </xsl:attribute>
 62 |             <xsl:value-of select="ShowOnDemandName"/>
 63 |            </a>
 64 |            <xsl:text>
 65 | </xsl:text>
 66 |          </xsl:if>
 67 | 
 68 |          <xsl:if test="ItemType='ShowEpisode'">
 69 |           <xsl:text>[E] </xsl:text>
 70 |           <a>
 71 |            <xsl:attribute name="href">
 72 |             <xsl:value-of select="ShowEpisodeURL"/>
 73 |            </xsl:attribute>
 74 |            <xsl:value-of select="ShowEpisodeName"/>
 75 |           </a>
 76 |            <xsl:text>
 77 | </xsl:text>
 78 |          </xsl:if>
 79 | 
 80 |         </xsl:for-each>
 81 |        </pre>
 82 | 
 83 |        <xsl:if test="Item[ItemType='ShowEpisode']">
 84 |         <h2>Show episodes</h2>
 85 |         <xsl:for-each select="Item[ItemType='ShowEpisode']">
 86 |          <h3>
 87 |           <a>
 88 |            <xsl:attribute name="href">
 89 |             <xsl:value-of select="ShowEpisodeURL"/>
 90 |            </xsl:attribute>
 91 |            <xsl:value-of select="ShowEpisodeName"/>
 92 |           </a>
 93 |          </h3>
 94 |          <p>
 95 |           <xsl:value-of select="ShowDesc"/>
 96 |           (<xsl:value-of select="ShowMime"/>)
 97 |          </p>
 98 |         </xsl:for-each>
 99 |        </xsl:if>
100 | 
101 |        <xsl:if test="Item[ItemType='Station']">
102 |         <h2>Internet radio stations</h2>
103 |         <xsl:for-each select="Item[ItemType='Station']">
104 |          <h3>
105 |           #<xsl:value-of select="StationId"/>:
106 |           <a>
107 |            <xsl:attribute name="href">
108 |             <xsl:value-of select="StationUrl"/>
109 |            </xsl:attribute>
110 |            <xsl:value-of select="StationName"/>
111 |           </a>
112 |          </h3>
113 |          <p>
114 |           <xsl:value-of select="StationDesc"/>
115 |           (<xsl:value-of select="ShowMime"/>)
116 |          </p>
117 |         </xsl:for-each>
118 |        </xsl:if>
119 | 
120 |       </body>
121 |     </html>
122 |   </xsl:template>
123 | </xsl:stylesheet>
124 | 


--------------------------------------------------------------------------------
/src/mediatomb.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | require_once 'Services/MediaTomb.php';
  3 | 
  4 | function handleMediatomb($action, $fullPath, $prefix)
  5 | {
  6 |     global $mediatomb;
  7 | 
  8 |     extract($mediatomb);
  9 |     try {
 10 |         $smt = new Services_MediaTomb($user, $pass, $host, $port);
 11 |         if ($action == 'browse') {
 12 |             mediatombBrowse($smt, $fullPath, $prefix);
 13 |         } else if ($action == 'single') {
 14 |             mediatombSingle($smt, $fullPath, $prefix);
 15 |         }
 16 |     } catch (Exception $e) {
 17 |         sendMessage('Mediatomb error: ' . $e->getMessage());
 18 |         return;
 19 |     }
 20 | }
 21 | 
 22 | function mediatombBrowse(Services_MediaTomb $smt, $fullPath, $prefix)
 23 | {
 24 |     global $mediatomb;
 25 | 
 26 |     $path = substr($fullPath, strlen($prefix));
 27 |     $container = $smt->getContainerByPath($path);
 28 |     if ($container === null) {
 29 |         sendMessage('Error accessing ' . $fullPath);
 30 |         return;
 31 |     }
 32 | 
 33 |     $listItems = array();
 34 | 
 35 |     $it = $container->getItemIterator(false);
 36 |     $it->rewind();
 37 |     $hasFiles = $it->valid();
 38 |     if ($hasFiles && is_array($mediatomb['singleFileDirectories'])) {
 39 |         $enableSingle = false;
 40 |         foreach ($mediatomb['singleFileDirectories'] as $dir) {
 41 |             if (substr($fullPath, 0, strlen($dir)) == $dir) {
 42 |                 $enableSingle = true;
 43 |             }
 44 |         }
 45 |         if ($enableSingle) {
 46 |             $listItems[] = getDirItem(
 47 |                 'Einzeln',
 48 |                 pathEncode('.mt-single/' . $path)
 49 |             );
 50 |         }
 51 |     }
 52 | 
 53 |     foreach ($container->getContainers() as $subContainer) {
 54 |         $listItems[] = getDirItem(
 55 |             $subContainer->title,
 56 |             pathEncode($fullPath . $subContainer->title) . '/'
 57 |         );
 58 |     }
 59 | 
 60 |     foreach ($container->getItemIterator(false) as $item) {
 61 |         mediatombAddFile($listItems, $item);
 62 |     }
 63 | 
 64 |     sendListItems($listItems, buildPreviousItem($fullPath));
 65 | }
 66 | 
 67 | function mediatombAddFile(&$listItems, $item)
 68 | {
 69 |     global $host1;
 70 | 
 71 |     $di = $item->getDetailedItem();
 72 |     $itemUrl = $item->url;
 73 |     if (!clientSupportsType($di->mimetype)) {
 74 |         //client wants transcoded file
 75 |         //noxon iRadio cube does not want to play .ogg files
 76 |         if (isset($GLOBALS['enableCache']) && $GLOBALS['enableCache']) {
 77 |             $itemUrl = $host1 . 'transcode-cache.php'
 78 |                 . '?url=' . urlencode($itemUrl);
 79 |         } else {
 80 |             $itemUrl = $host1 . 'transcode-nocache.php'
 81 |                 . '?url=' . urlencode($itemUrl);
 82 |         }
 83 |     }
 84 |     $listItems[] = getEpisodeItem(
 85 |         $item->title,
 86 |         $itemUrl,
 87 |         '',
 88 |         'MP3'
 89 |     );
 90 | }
 91 | 
 92 | function clientSupportsType($mimetype)
 93 | {
 94 |     if ($mimetype === 'audio/mpeg') {
 95 |         return true;
 96 |     }
 97 |     $ip = $_SERVER['REMOTE_ADDR'];
 98 |     if (isset($GLOBALS['clientSupport'][$ip][$mimetype])
 99 |         && $GLOBALS['clientSupport'][$ip][$mimetype] === true
100 |     ) {
101 |         return true;
102 |     }
103 |     return false;
104 | }
105 | 
106 | /**
107 |  * Single file mode - shows directories that only have a single file in them.
108 |  * Each audio file gets its own virtual directory, containing only the
109 |  * audio file itself.
110 |  *
111 |  * Useful children who want to listen a single story before sleeping,
112 |  * but the noxon's auto switch-off timer is not exactly at the end of
113 |  * the story. So the next story starts already, and the kid complains
114 |  * that it wanted to listen to that as well...
115 |  */
116 | function mediatombSingle(Services_MediaTomb $smt, $fullPath, $prefix)
117 | {
118 |     $path = substr($fullPath, strlen($prefix));
119 | 
120 |     $parts = explode('/', $path);
121 |     $fileMode = false;
122 |     if (substr(end($parts), 0, 5) == 'file-') {
123 |         $fileMode = true;
124 |         $fileTitle = substr(end($parts), 5);
125 |         $path = substr($path, 0, -strlen($fileTitle) - 5);
126 |     }
127 | 
128 |     $container = $smt->getContainerByPath($path);
129 |     $listItems = array();
130 | 
131 |     $previous = null;
132 |     if ($fileMode) {
133 |         //show single file to play
134 |         $previous = buildPreviousItem(pathEncode($fullPath));
135 |         $item = $smt->getSingleItem($container, $fileTitle, false);
136 |         mediatombAddFile($listItems, $item);
137 |     } else {
138 |         $previous = buildPreviousItem(pathEncode('internetradio/' . $path . '/dummy'));
139 | 
140 |         //browse directory
141 |         foreach ($container->getItemIterator(false) as $item) {
142 |             $listItems[] = getDirItem(
143 |                 $item->title,
144 |                 pathEncode($fullPath . 'file-' . $item->title)
145 |             );
146 |         }
147 |     }
148 | 
149 |     sendListItems($listItems, $previous);
150 | }
151 | ?>
152 | 


--------------------------------------------------------------------------------
/www/index.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | require_once __DIR__ . '/../src/header.php';
  3 | 
  4 | $radioPodcastLogin = isset($_GET['token']) && $_GET['token'] == '0'
  5 |     && strtolower($path) == '/setupapp/radio567/asp/browsexpa/loginxml.asp';
  6 | $myNoxonLogin = $path == '/RadioNativeLogin.php';
  7 | 
  8 | if ($radioPodcastLogin || $myNoxonLogin) {
  9 |     //initial login for "internet radio", podcasts and "my noxon"
 10 |     header('Content-type: text/html');
 11 |     readfile($dataDir . 'login-camelcase.xml');
 12 |     exit();
 13 | } else if ($path == '/setupapp/radio567/asp/BrowseXPA/LoginXML.asp') {
 14 |     //"Internet Radio"
 15 |     $path = '/internetradio/';
 16 | } else if ($path == '/setupapp/radio567/asp/BrowseXPA/navXML.asp') {
 17 |     //"Podcasts"
 18 |     $path = '/podcasts/';
 19 | } else if ($path == '/RadioNative.php') {
 20 |     //"My Noxon"
 21 |     $path = '/mynoxon/';
 22 | } else if ($path == '/setupapp/radio567/asp/BrowseXML/FavXML.asp') {
 23 |     //Internet Radio Station favorites favorited on device
 24 |     sendMessage('Unsupported');
 25 | } else if ($path == '/RadioNativeFavorites.php') {
 26 |     //Favorites, defined via web interface
 27 |     sendMessage('Unsupported');
 28 | }
 29 | 
 30 | handleRequest(ltrim($path, '/'));
 31 | 
 32 | function handleRequest($path)
 33 | {
 34 |     global $varDir;
 35 |     if (strpos($path, '/../') !== false) {
 36 |         sendMessage('No');
 37 |         return;
 38 |     }
 39 | 
 40 |     if (substr($path, 0, 14) == 'internetradio/') {
 41 |         require_once 'mediatomb.php';
 42 |         handleMediatomb('browse', $path, 'internetradio/');
 43 |         return;
 44 |     } else if (substr($path, 0, 11) == '.mt-single/') {
 45 |         require_once 'mediatomb.php';
 46 |         handleMediatomb('single', $path, '.mt-single/');
 47 |         return;
 48 |     }
 49 | 
 50 | 
 51 |     $fullPath = $varDir . $path;
 52 |     if (!file_exists($fullPath)) {
 53 |         sendMessage('Not found: ' . $path);
 54 |         return;
 55 |     }
 56 | 
 57 |     $ext = pathinfo($path, PATHINFO_EXTENSION);
 58 |     if (is_dir($fullPath)) {
 59 |         sendDir($path);
 60 |     } else if ($ext == 'url') {
 61 |         require_once 'podcasts.php';
 62 |         sendPodcast($path);
 63 |     } else if ($ext == 'txt') {
 64 |         sendTextFile($path);
 65 |     } else if (is_executable($fullPath)) {
 66 |         sendScript($path);
 67 |     } else {
 68 |         sendMessage('Unknown file type');
 69 |     }
 70 | }
 71 | 
 72 | function pathEncode($urlPath)
 73 | {
 74 |     return str_replace('%2F', '/', rawurlencode($urlPath));
 75 | }
 76 | 
 77 | function sendDir($path)
 78 | {
 79 |     global $varDir;
 80 | 
 81 |     $listItems = array();
 82 |     $enablePaging = true;
 83 | 
 84 |     $entries = glob(str_replace('//', '/', $varDir . rtrim($path, '/') . '/*'));
 85 |     $count = 0;
 86 |     $noCache = false;
 87 |     foreach ($entries as $entry) {
 88 |         $urlPath = pathEncode(substr($entry, strlen($varDir)));
 89 |         $ext = pathinfo($entry, PATHINFO_EXTENSION);
 90 | 
 91 |         $titleBase = basename($entry);
 92 |         $titleBase = preg_replace('#^[0-9]+_#', '', $titleBase);
 93 |         if (is_dir($entry)) {
 94 |             ++$count;
 95 |             $listItems[] = getDirItem($titleBase, $urlPath . '/');
 96 |         } else if ($ext == 'url') {
 97 |             //podcast
 98 |             ++$count;
 99 |             $listItems[] = getPodcastItem(basename($titleBase, '.url'), $urlPath);
100 |         } else if (is_executable($entry)
101 |             && strpos(basename($entry), '.auto') !== false
102 |         ) {
103 |             //automatically execute script while listing this directory
104 |             addScriptOutput($listItems, $entry);
105 |             $enablePaging = false;
106 |         } else if ($ext == 'txt' || is_executable($entry)) {
107 |             //plain text file
108 |             ++$count;
109 |             $listItems[] = getDirItem(basename($titleBase, '.' . $ext), $urlPath);
110 |         } else  if (basename($entry) == 'nocache') {
111 |             $noCache = true;
112 |         }
113 |     }
114 |     if (!$count) {
115 |         $listItems[] = getMessageItem('No files or folders');
116 |     }
117 |     sendListItems(
118 |         $listItems, buildPreviousItem($path),
119 |         $enablePaging, $noCache
120 |     );
121 | }
122 | 
123 | function sendScript($path)
124 | {
125 |     global $varDir;
126 | 
127 |     $listItems = array();
128 | 
129 |     $fullPath = $varDir . $path;
130 |     addScriptOutput($listItems, $fullPath);
131 |     sendListItems($listItems, buildPreviousItem($path), false);
132 | }
133 | 
134 | function addScriptOutput(&$listItems, $fullPath)
135 | {
136 |     exec($fullPath . ' 2>&1', $output, $retVal);
137 | 
138 |     if ($retVal == 0) {
139 |         addTextLines($listItems, $output);
140 |     } else {
141 |         $listItems[] = getMessageItem('Error executing script');
142 |         addTextLines($listItems, $output);
143 |     }
144 | }
145 | 
146 | function sendTextFile($path)
147 | {
148 |     global $varDir;
149 |     $listItems = array();
150 | 
151 |     $lines = file($varDir . $path);
152 |     addTextLines($listItems, $lines);
153 |     sendListItems($listItems, buildPreviousItem($path));
154 | }
155 | 
156 | function addTextLines(&$listItems, $lines)
157 | {
158 |     foreach ($lines as $line) {
159 |         $line = trim($line);
160 |         if ($line != '') {
161 |             $listItems[] = getDisplayItem($line);
162 |         }
163 |     }
164 | }
165 | 
166 | function getDisplayItem($line)
167 | {
168 |     $line = preg_replace('#\s+#', ' ', $line);
169 |     return '<Item>'
170 |         . '<ItemType>Display</ItemType>'
171 |         . '<Display>' . nox_esc($line) . '</Display>'
172 |         . '</Item>';
173 | }
174 | 
175 | function getDirItem($title, $urlPath)
176 | {
177 |     global $host1, $host2;
178 |     return '<Item>'
179 |         . '<ItemType>Dir</ItemType>'
180 |         . '<Title>' . nox_esc($title) . '</Title>'
181 |         . '<UrlDir>' . $host1 . nox_esc($urlPath) . '</UrlDir>'
182 |         . '<UrlDirBackUp>' . $host2 . nox_esc($urlPath) . '</UrlDirBackUp>'
183 |         . '</Item>';
184 | }
185 | 
186 | function getEpisodeItem($title, $fullUrl, $desc, $type)
187 | {
188 |     return '<Item>'
189 |         . '<ItemType>ShowEpisode</ItemType>'
190 |         . '<ShowEpisodeName>' . nox_esc($title) . '</ShowEpisodeName>'
191 |         . '<ShowEpisodeURL>' . htmlspecialchars($fullUrl) . '</ShowEpisodeURL>'
192 |         . '<ShowDesc>' . nox_esc($desc) . '</ShowDesc>'
193 |         . '<ShowMime>' . $type . '</ShowMime>'
194 |         . '</Item>';
195 | }
196 | 
197 | function getPodcastItem($title, $urlPath)
198 | {
199 |     global $host1;
200 |     return '<Item>'
201 |         . '<ItemType>ShowOnDemand</ItemType>'
202 |         . '<ShowOnDemandName>' . nox_esc($title) . '</ShowOnDemandName>'
203 |         . '<ShowOnDemandURL>' . $host1 . nox_esc($urlPath) . '</ShowOnDemandURL>'
204 |         . '</Item>';
205 | }
206 | 
207 | function getMessageItem($msg)
208 | {
209 |     return '<Item>'
210 |         . '<ItemType>Message</ItemType>'
211 |         . '<Message>' . nox_esc($msg) . '</Message>'
212 |         . '</Item>';
213 | }
214 | 
215 | function getPreviousItem($urlPath)
216 | {
217 |     global $host1, $host2;
218 |     return '<Item>'
219 |         . '<ItemType>Previous</ItemType>'
220 |         . '<UrlPrevious>' . $host1 . nox_esc($urlPath) . '</UrlPrevious>'
221 |         . '<UrlPreviousBackUp>' . $host1 . nox_esc($urlPath) . '</UrlPreviousBackUp>'
222 |         . '</Item>';
223 | }
224 | 
225 | function buildPreviousItem($urlPath)
226 | {
227 |     $parentDir = dirname($urlPath) . '/';
228 |     if ($parentDir == '/') {
229 |         return null;
230 |     }
231 |     return getPreviousItem($parentDir);
232 | }
233 | 
234 | function nox_esc($string)
235 | {
236 |     return utf8_decode(htmlspecialchars($string));
237 | }
238 | 
239 | function sendMessage($msg)
240 | {
241 |     sendListItems(array(getMessageItem($msg)));
242 | }
243 | 
244 | function sendListItems(
245 |     $listItems, $previous = null, $enablePaging = true, $noCache = false
246 | ) {
247 |     $startitems = 1;
248 |     $enditems   = 100000;
249 |     if (isset($_GET['startitems'])) {
250 |         $startitems = (int) $_GET['startitems'];
251 |     }
252 |     if (isset($_GET['enditems'])) {
253 |         $enditems = (int) $_GET['enditems'];
254 |     }
255 | 
256 |     if ($enablePaging) {
257 |         $itemCount = count($listItems);
258 |     } else {
259 |         $itemCount = -1;
260 |     }
261 |     if ($previous !== null) {
262 |         $previous .= "\n";
263 |     }
264 | 
265 |     $xml = '<?xml version="1.0" encoding="iso-8859-1"?>' . "\n";
266 |     $xml .= '<?xml-stylesheet type="text/xsl" href="/html.xsl"?>' . "\n";
267 |     $xml .= '<ListOfItems>' . "\n";
268 |     if ($noCache) {
269 |         $xml .= "<NoCache>1</NoCache>\n";
270 |     }
271 |     $xml .= '<ItemCount>' . $itemCount . '</ItemCount>' . "\n";
272 |     $xml .= $previous;
273 | 
274 |     $num = 0;
275 |     foreach ($listItems as $item) {
276 |         ++$num;
277 |         if (!$enablePaging || ($num >= $startitems && $num <= $enditems)) {
278 |             $xml .= $item . "\n";
279 |         }
280 |     }
281 |     $xml .= "</ListOfItems>\n";
282 | 
283 |     header('Content-type: text/xml; charset=iso-8859-1');
284 |     echo $xml;
285 | }
286 | ?>
287 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
  1 | ********************
  2 | Noxon iRadio gateway
  3 | ********************
  4 | Push your own content onto `Noxon iRadio`__ devices:
  5 | RSS feeds, text files and MediaTomb server structures.
  6 | 
  7 | This tool makes it possible to push own data into the menu
  8 | entries "Internet Radio", "Podcasts" and "My Noxon" without relying
  9 | on the official Terratec servers.
 10 | 
 11 | __ http://www.noxonradio.de/
 12 | 
 13 | 
 14 | .. contents::
 15 | 
 16 | 
 17 | ========
 18 | Features
 19 | ========
 20 | - Customize the Noxon iRadio menus "Internet Radio", "Podcasts" and "My Noxon"
 21 | - Show Mediatomb UPnP server content in "Internet Radio", so that you
 22 |   don't have to restart your iRadio because it does not find the UPnP server
 23 |   after a day of standby
 24 | - Display text files and run shell scripts from the menu (home automation)
 25 | - Podcast RSS feed support
 26 | - Discoverable with your web browser
 27 | - Transcoding of non-mp3 file types to ``.mp3`` that iRadios can play
 28 | - Single file mode for children that want to listen to a single story
 29 |   before sleeping
 30 | - Paging results with ``?startitems=1&enditems=10`` GET parameters
 31 | 
 32 | 
 33 | RSS feed support
 34 | ================
 35 | Simpy write a podcast's mp3 RSS feed URL into a  ``.url`` file in
 36 | the ``var/`` directory structure, and your radio will show you a
 37 | folder with all episodes.
 38 | Enter an episode to play it.
 39 | 
 40 | The Noxon iRadios do only allow a single HTTP redirect when they access a URL
 41 | to play, but many podcast feeds send you for tracking purposes through 3 or
 42 | more redirects until you reach the final mp3 URL.
 43 | 
 44 | noxon-gateway resolves the redirections for the iRadio, so that this will
 45 | not be a problem.
 46 | 
 47 | 
 48 | Creating an RSS feed
 49 | --------------------
 50 | You have to know the URL to the podcast's mp3 RSS feed, e.g.
 51 | ``http://cast.example.org/news.rss``.
 52 | 
 53 | Create a file ``Cast News.url`` in ``var/podcasts/`` and write the RSS URL
 54 | into it.
 55 | That's all.
 56 | 
 57 | When accessing the "Podcasts" menu from your noxon iRadio, you'll see a
 58 | directory ``Cast News`` that contains all podcast episodes.
 59 | 
 60 | 
 61 | Single file mode
 62 | ================
 63 | Your kid only wants to listen to this one single story before sleeping.
 64 | You start it, set the 15 minute sleep timer and leave the room.
 65 | 
 66 | After 15 minutes the child comes out and complains that the radio switched
 67 | off within the second story and it wants to hear it to the end.
 68 | 
 69 | To get around such issues, you can enable "single file directories"
 70 | for certain folders.
 71 | 
 72 | Each folder with audio files within this configured paths have a special
 73 | directory "Einzeln" (single), which have separate folders for each audio
 74 | file. Each of this separate folders only have the single audio file in them.
 75 | 
 76 | When playing this file, the iRadio will stop playing after the one file
 77 | is over.
 78 | 
 79 | 
 80 | Supported radios
 81 | ================
 82 | This is the list of iRadios known to work with ``noxon-gateway``:
 83 | 
 84 | - `Noxon iRadio`__ (original white version)
 85 | - `Noxon iRadio cube`__
 86 | 
 87 | Others should work.
 88 | If you know of unlisted radios that do work with this tool, please tell me.
 89 | 
 90 | __ http://ftp.noxonradio.de/index.php?dir=NOXON%2FNOXON_iRadio%2F
 91 | __ http://ftp.noxonradio.de/index.php?dir=NOXON%2FNOXON_iRadio_Cube%2F
 92 | 
 93 | 
 94 | Web browser support
 95 | ===================
 96 | You can discover the noxon-gateway contents with your web browser.
 97 | Point your browser to the gateway's domain and start browsing:
 98 | 
 99 | .. image:: docs/screenshots/browsing.png
100 | 
101 | This works because the XML files delivered by noxon-gateway contain the
102 | link to an XSLT__ file that converts the XML structure to HTML that
103 | browsers understand.
104 | 
105 | Works at least with Firefox 42 and Chromium 45.
106 | 
107 | __ http://www.w3.org/TR/xslt
108 | 
109 | 
110 | ===================================
111 | Customizing the directory structure
112 | ===================================
113 | The ``var/`` directory contains three directories you can fill with
114 | your own content.
115 | 
116 | ================ ==================
117 | Menu item        ``var/`` Directory
118 | ================ ==================
119 | Internet Radio   ``internetradio``
120 | Podcasts         ``podcasts``
121 | My Noxon         ``mynoxon``
122 | ================ ==================
123 | 
124 | You can put folders and files into this directories.
125 | 
126 | The ``internetradio`` directory is hard-coded to display the contents
127 | of a MediaTomb UPnP server.
128 | You can remove the check in ``index.php#handleRequest()`` if you do not
129 | want this.
130 | 
131 | 
132 | File types
133 | ==========
134 | Directory
135 |   A directory is browsable by your Noxon radio
136 | ``.txt`` file
137 |   Text files are rendered as un-actionable lists, one list item per line.
138 | 
139 |   Empty lines get removed, consecutive spaces get collapsed.
140 | ``.url`` file
141 |   Podcast feed URL file.
142 | 
143 |   Simply contains the URL to the podcast's MP3 RSS feed.
144 | executable file
145 |   Script is shown as directory and gets executed when navigating
146 |   into it.
147 |   Output is shown as it is for ``.txt`` files.
148 | 
149 |   I use it to control my house's heating system from the radio.
150 | ``*.auto*`` (executable)
151 |   Script gets executed when browsing the folder.
152 |   The output is integrated into the directory listing with the same
153 |   rules as for ``.txt`` files.
154 | 
155 |   You can use this to show the current time within the directory listing.
156 | ``nocache``
157 |   Disables menu caching.
158 | 
159 | File extensions get removed for display purposes.
160 | 
161 | 
162 | Sorting
163 | =======
164 | Files and directory are sorted alphabetically and get listed
165 | in this order.
166 | 
167 | You can prefix your files and directories with ``[0-9]+_``,
168 | which lets you influence sorting and gets removed in the
169 | listings.
170 | 
171 | Consider the following files::
172 | 
173 |     01_temp.auto.sh
174 |     02_warmer.sh
175 |     03_colder.sh
176 | 
177 | Would render as::
178 | 
179 |     Temperature: 23°C
180 |     warmer
181 |     colder
182 | 
183 | (given that ``01_temp.auto.sh`` outputs the temperature string)
184 | 
185 | 
186 | Caching
187 | =======
188 | When going back in the menu strucutre with the left arrow button,
189 | Noxon iRadios display a cached version of the menu.
190 | 
191 | If you do not want this - because a script modified values that are
192 | displayed in the parent menu, or because the script that displays
193 | the time should always be run - you may disable caching.
194 | 
195 | Caching is disabled when a file named ``nocache`` is found in the directory.
196 | 
197 | 
198 | =====
199 | Setup
200 | =====
201 | 
202 | Basic setup
203 | ===========
204 | #. You need a web server (Apache) with PHP.
205 | 
206 |    Using nginx, lighttpd or others is possible, but you need to translate
207 |    the redirects in the ``www/.htaccess`` file into their respective format.
208 | 
209 | #. Clone the Git repository of this noxon-gateway software::
210 | 
211 |      $ git clone https://git.cweiske.de/noxon-gateway.git
212 | 
213 | #. Configure your network's DNS server/router, see the "Hosts" section.
214 | 
215 | #. Point your web server's (virtual host) document root to the ``www``
216 |    directory.
217 | 
218 |    Let your web server handle the domain names.
219 | 
220 | #. Open http://gatekeeper.my-noxon.net/ in your browser.
221 |    You should see the noxon gateway software.
222 | 
223 |    If your browser supports XSLT, you will not see XML, but clickable HTML
224 |    links.
225 | 
226 | 
227 | Hosts
228 | =====
229 | The following hosts must point to your server and be handled
230 | by this tool::
231 | 
232 |     radio567.vtuner.com
233 |     radio5672.vtuner.com
234 |     gatekeeper.my-noxon.net
235 | 
236 | 
237 | Configure this in your router or the DNS server your iRadio devices use.
238 | 
239 | 
240 | MediaTomb
241 | =========
242 | To be able to browse a MediaTomb server, copy ``data/config.php.dist`` to
243 | ``data/config.php`` and fill it with mediatomb web interface credentials.
244 | 
245 | You also have to install the `Services_Mediatomb`__ library via `PEAR`__::
246 | 
247 |     $ pear channel-discover zustellzentrum.cweiske.de
248 |     $ pear install zz/services_mediatomb-alpha
249 | 
250 | __ http://zustellzentrum.cweiske.de/index.php?package=Services_MediaTomb
251 | __ http://pear.php.net/
252 | 
253 | 
254 | Transcoding
255 | ===========
256 | If you have non-mp3 files in your audio collection, install `ffmpeg`__
257 | on the noxon-gateway server.
258 | Transcoding will start automatically when the player accesses a file
259 | that is not in ``audio/mpeg`` format.
260 | 
261 | __ http://ffmpeg.org/
262 | 
263 | 
264 | ===================
265 | About noxon-gateway
266 | ===================
267 | 
268 | Homepage
269 | ========
270 | ``noxon-gateway`` lives at http://cweiske.de/noxon-gateway.htm
271 | 
272 | The source code is available at http://git.cweiske.de/noxon-gateway.git/
273 | and mirrored at https://github.com/cweiske/noxon-gateway.
274 | 
275 | 
276 | License
277 | =======
278 | This application is available under the `AGPL v3`__ or later.
279 | 
280 | __ http://www.gnu.org/licenses/agpl.html
281 | 
282 | 
283 | Author
284 | ======
285 | Written by `Christian Weiske`__, cweiske@cweiske.de
286 | 
287 | __ http://cweiske.de/
288 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU AFFERO GENERAL PUBLIC LICENSE
  2 |                        Version 3, 19 November 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU Affero General Public License is a free, copyleft license for
 11 | software and other kinds of works, specifically designed to ensure
 12 | cooperation with the community in the case of network server software.
 13 | 
 14 |   The licenses for most software and other practical works are designed
 15 | to take away your freedom to share and change the works.  By contrast,
 16 | our General Public Licenses are intended to guarantee your freedom to
 17 | share and change all versions of a program--to make sure it remains free
 18 | software for all its users.
 19 | 
 20 |   When we speak of free software, we are referring to freedom, not
 21 | price.  Our General Public Licenses are designed to make sure that you
 22 | have the freedom to distribute copies of free software (and charge for
 23 | them if you wish), that you receive source code or can get it if you
 24 | want it, that you can change the software or use pieces of it in new
 25 | free programs, and that you know you can do these things.
 26 | 
 27 |   Developers that use our General Public Licenses protect your rights
 28 | with two steps: (1) assert copyright on the software, and (2) offer
 29 | you this License which gives you legal permission to copy, distribute
 30 | and/or modify the software.
 31 | 
 32 |   A secondary benefit of defending all users' freedom is that
 33 | improvements made in alternate versions of the program, if they
 34 | receive widespread use, become available for other developers to
 35 | incorporate.  Many developers of free software are heartened and
 36 | encouraged by the resulting cooperation.  However, in the case of
 37 | software used on network servers, this result may fail to come about.
 38 | The GNU General Public License permits making a modified version and
 39 | letting the public access it on a server without ever releasing its
 40 | source code to the public.
 41 | 
 42 |   The GNU Affero General Public License is designed specifically to
 43 | ensure that, in such cases, the modified source code becomes available
 44 | to the community.  It requires the operator of a network server to
 45 | provide the source code of the modified version running there to the
 46 | users of that server.  Therefore, public use of a modified version, on
 47 | a publicly accessible server, gives the public access to the source
 48 | code of the modified version.
 49 | 
 50 |   An older license, called the Affero General Public License and
 51 | published by Affero, was designed to accomplish similar goals.  This is
 52 | a different license, not a version of the Affero GPL, but Affero has
 53 | released a new version of the Affero GPL which permits relicensing under
 54 | this license.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                        TERMS AND CONDITIONS
 60 | 
 61 |   0. Definitions.
 62 | 
 63 |   "This License" refers to version 3 of the GNU Affero General Public License.
 64 | 
 65 |   "Copyright" also means copyright-like laws that apply to other kinds of
 66 | works, such as semiconductor masks.
 67 | 
 68 |   "The Program" refers to any copyrightable work licensed under this
 69 | License.  Each licensee is addressed as "you".  "Licensees" and
 70 | "recipients" may be individuals or organizations.
 71 | 
 72 |   To "modify" a work means to copy from or adapt all or part of the work
 73 | in a fashion requiring copyright permission, other than the making of an
 74 | exact copy.  The resulting work is called a "modified version" of the
 75 | earlier work or a work "based on" the earlier work.
 76 | 
 77 |   A "covered work" means either the unmodified Program or a work based
 78 | on the Program.
 79 | 
 80 |   To "propagate" a work means to do anything with it that, without
 81 | permission, would make you directly or secondarily liable for
 82 | infringement under applicable copyright law, except executing it on a
 83 | computer or modifying a private copy.  Propagation includes copying,
 84 | distribution (with or without modification), making available to the
 85 | public, and in some countries other activities as well.
 86 | 
 87 |   To "convey" a work means any kind of propagation that enables other
 88 | parties to make or receive copies.  Mere interaction with a user through
 89 | a computer network, with no transfer of a copy, is not conveying.
 90 | 
 91 |   An interactive user interface displays "Appropriate Legal Notices"
 92 | to the extent that it includes a convenient and prominently visible
 93 | feature that (1) displays an appropriate copyright notice, and (2)
 94 | tells the user that there is no warranty for the work (except to the
 95 | extent that warranties are provided), that licensees may convey the
 96 | work under this License, and how to view a copy of this License.  If
 97 | the interface presents a list of user commands or options, such as a
 98 | menu, a prominent item in the list meets this criterion.
 99 | 
100 |   1. Source Code.
101 | 
102 |   The "source code" for a work means the preferred form of the work
103 | for making modifications to it.  "Object code" means any non-source
104 | form of a work.
105 | 
106 |   A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 | 
111 |   The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form.  A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 | 
122 |   The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities.  However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work.  For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 | 
135 |   The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 | 
139 |   The Corresponding Source for a work in source code form is that
140 | same work.
141 | 
142 |   2. Basic Permissions.
143 | 
144 |   All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met.  This License explicitly affirms your unlimited
147 | permission to run the unmodified Program.  The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work.  This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 | 
152 |   You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force.  You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright.  Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 | 
163 |   Conveying under any other circumstances is permitted solely under
164 | the conditions stated below.  Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 | 
167 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 | 
169 |   No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 | 
175 |   When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 | 
183 |   4. Conveying Verbatim Copies.
184 | 
185 |   You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 | 
193 |   You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 | 
196 |   5. Conveying Modified Source Versions.
197 | 
198 |   You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 | 
202 |     a) The work must carry prominent notices stating that you modified
203 |     it, and giving a relevant date.
204 | 
205 |     b) The work must carry prominent notices stating that it is
206 |     released under this License and any conditions added under section
207 |     7.  This requirement modifies the requirement in section 4 to
208 |     "keep intact all notices".
209 | 
210 |     c) You must license the entire work, as a whole, under this
211 |     License to anyone who comes into possession of a copy.  This
212 |     License will therefore apply, along with any applicable section 7
213 |     additional terms, to the whole of the work, and all its parts,
214 |     regardless of how they are packaged.  This License gives no
215 |     permission to license the work in any other way, but it does not
216 |     invalidate such permission if you have separately received it.
217 | 
218 |     d) If the work has interactive user interfaces, each must display
219 |     Appropriate Legal Notices; however, if the Program has interactive
220 |     interfaces that do not display Appropriate Legal Notices, your
221 |     work need not make them do so.
222 | 
223 |   A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit.  Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 | 
233 |   6. Conveying Non-Source Forms.
234 | 
235 |   You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 | 
240 |     a) Convey the object code in, or embodied in, a physical product
241 |     (including a physical distribution medium), accompanied by the
242 |     Corresponding Source fixed on a durable physical medium
243 |     customarily used for software interchange.
244 | 
245 |     b) Convey the object code in, or embodied in, a physical product
246 |     (including a physical distribution medium), accompanied by a
247 |     written offer, valid for at least three years and valid for as
248 |     long as you offer spare parts or customer support for that product
249 |     model, to give anyone who possesses the object code either (1) a
250 |     copy of the Corresponding Source for all the software in the
251 |     product that is covered by this License, on a durable physical
252 |     medium customarily used for software interchange, for a price no
253 |     more than your reasonable cost of physically performing this
254 |     conveying of source, or (2) access to copy the
255 |     Corresponding Source from a network server at no charge.
256 | 
257 |     c) Convey individual copies of the object code with a copy of the
258 |     written offer to provide the Corresponding Source.  This
259 |     alternative is allowed only occasionally and noncommercially, and
260 |     only if you received the object code with such an offer, in accord
261 |     with subsection 6b.
262 | 
263 |     d) Convey the object code by offering access from a designated
264 |     place (gratis or for a charge), and offer equivalent access to the
265 |     Corresponding Source in the same way through the same place at no
266 |     further charge.  You need not require recipients to copy the
267 |     Corresponding Source along with the object code.  If the place to
268 |     copy the object code is a network server, the Corresponding Source
269 |     may be on a different server (operated by you or a third party)
270 |     that supports equivalent copying facilities, provided you maintain
271 |     clear directions next to the object code saying where to find the
272 |     Corresponding Source.  Regardless of what server hosts the
273 |     Corresponding Source, you remain obligated to ensure that it is
274 |     available for as long as needed to satisfy these requirements.
275 | 
276 |     e) Convey the object code using peer-to-peer transmission, provided
277 |     you inform other peers where the object code and Corresponding
278 |     Source of the work are being offered to the general public at no
279 |     charge under subsection 6d.
280 | 
281 |   A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 | 
285 |   A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling.  In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage.  For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product.  A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 | 
298 |   "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source.  The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 | 
306 |   If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information.  But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 | 
317 |   The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed.  Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 | 
325 |   Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 | 
331 |   7. Additional Terms.
332 | 
333 |   "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law.  If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 | 
342 |   When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it.  (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.)  You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 | 
349 |   Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 | 
353 |     a) Disclaiming warranty or limiting liability differently from the
354 |     terms of sections 15 and 16 of this License; or
355 | 
356 |     b) Requiring preservation of specified reasonable legal notices or
357 |     author attributions in that material or in the Appropriate Legal
358 |     Notices displayed by works containing it; or
359 | 
360 |     c) Prohibiting misrepresentation of the origin of that material, or
361 |     requiring that modified versions of such material be marked in
362 |     reasonable ways as different from the original version; or
363 | 
364 |     d) Limiting the use for publicity purposes of names of licensors or
365 |     authors of the material; or
366 | 
367 |     e) Declining to grant rights under trademark law for use of some
368 |     trade names, trademarks, or service marks; or
369 | 
370 |     f) Requiring indemnification of licensors and authors of that
371 |     material by anyone who conveys the material (or modified versions of
372 |     it) with contractual assumptions of liability to the recipient, for
373 |     any liability that these contractual assumptions directly impose on
374 |     those licensors and authors.
375 | 
376 |   All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10.  If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term.  If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 | 
386 |   If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 | 
391 |   Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 | 
395 |   8. Termination.
396 | 
397 |   You may not propagate or modify a covered work except as expressly
398 | provided under this License.  Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 | 
403 |   However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 | 
410 |   Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 | 
417 |   Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License.  If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 | 
423 |   9. Acceptance Not Required for Having Copies.
424 | 
425 |   You are not required to accept this License in order to receive or
426 | run a copy of the Program.  Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance.  However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work.  These actions infringe copyright if you do
431 | not accept this License.  Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 | 
434 |   10. Automatic Licensing of Downstream Recipients.
435 | 
436 |   Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License.  You are not responsible
439 | for enforcing compliance by third parties with this License.
440 | 
441 |   An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations.  If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 | 
451 |   You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License.  For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 | 
459 |   11. Patents.
460 | 
461 |   A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based.  The
463 | work thus licensed is called the contributor's "contributor version".
464 | 
465 |   A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version.  For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 | 
475 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 | 
480 |   In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement).  To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 | 
487 |   If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients.  "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 | 
501 |   If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 | 
509 |   A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License.  You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 | 
524 |   Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 | 
528 |   12. No Surrender of Others' Freedom.
529 | 
530 |   If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License.  If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all.  For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 | 
540 |   13. Remote Network Interaction; Use with the GNU General Public License.
541 | 
542 |   Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software.  This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 | 
553 |   Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work.  The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 | 
561 |   14. Revised Versions of this License.
562 | 
563 |   The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time.  Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 | 
568 |   Each version is given a distinguishing version number.  If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation.  If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 | 
577 |   If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 | 
582 |   Later license versions may give you additional or different
583 | permissions.  However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 | 
587 |   15. Disclaimer of Warranty.
588 | 
589 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 | 
598 |   16. Limitation of Liability.
599 | 
600 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 | 
610 |   17. Interpretation of Sections 15 and 16.
611 | 
612 |   If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 | 
619 |                      END OF TERMS AND CONDITIONS
620 | 
621 |             How to Apply These Terms to Your New Programs
622 | 
623 |   If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 | 
627 |   To do so, attach the following notices to the program.  It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 | 
632 |     <one line to give the program's name and a brief idea of what it does.>
633 |     Copyright (C) <year>  <name of author>
634 | 
635 |     This program is free software: you can redistribute it and/or modify
636 |     it under the terms of the GNU Affero General Public License as published by
637 |     the Free Software Foundation, either version 3 of the License, or
638 |     (at your option) any later version.
639 | 
640 |     This program is distributed in the hope that it will be useful,
641 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
642 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
643 |     GNU Affero General Public License for more details.
644 | 
645 |     You should have received a copy of the GNU Affero General Public License
646 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
647 | 
648 | Also add information on how to contact you by electronic and paper mail.
649 | 
650 |   If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source.  For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code.  There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 | 
658 |   You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | <http://www.gnu.org/licenses/>.
662 | 


--------------------------------------------------------------------------------