mirakurun 3.9.0-beta.9 → 3.9.0-rc.2

package/CHANGELOG.md

@@ -2,13 +2,14 @@
 
 see [Commit Logs](https://github.com/Chinachu/Mirakurun/commits/master) to check all.
 
-## 3.9.0 (2021-xx-xx)
+## 3.9.0 (2022-xx-xx)
 
 Performance improvements, fixes for memory leaks and bugs related to EPG processing, etc.
 
 ### Server Changes
 
 - **config/server**: Add `disableWebUI` (Env: `DISABLE_WEB_UI` for Docker) to disable Web UI.
+- **config/server**: Add `allowIPv4CidrRanges`, `allowIPv6CidrRanges` (Env: `ALLOW_IPV4_CIDR_RANGES`, `ALLOW_IPV6_CIDR_RANGES` for Docker) to allow optional IP range.
 - **config/server**: Change several default values based on typical usage.
   - `programGCInterval`: `900000` (15 mins) → `3600000` (1 hour)
   - `epgGatheringInterval`: `900000` (15 mins) → `1800000` (30 mins)
@@ -24,12 +25,15 @@ Performance improvements, fixes for memory leaks and bugs related to EPG process
 - **epg**: Add support for event relay.
 - **epg**: Add support for multi track audios.
 - **epg**: Improve performance of parsing start_time of events.
-- **epg**: Change to run asynchronously to reduce load.
 - **program**: Add event group type as `type` to `db.ProgramRelatedItem` of `db.Program`.
 - **program**: Fixed a problem in the implementation of conflict detection. (bug)
 - **program**: Reduced the frequent repeated update events.
 - **program**: Removed the `audio` property and added the `audios` property to support multi track audios. (**breaking change**)
+- **program**: Fix program overlapping when re-scheduled. (bug)
+- **program**: Removed the `redefine` event and added the `remove` event. (**breaking change**)
 - **api/iptv**: Fixed a problem with Kodi 19's IPTV feature that caused channel selection to take a long time. [#101](https://github.com/Chinachu/Mirakurun/pull/101)
+- **api/iptv**: Add category (genre) info.
+- **api/iptv**: Add timezone offset explicitly.
 - **api/getLogoImage**: Add `Cache-Control` header to cache logo images.
 - **api/restart**: Improved the restart speed on Docker. (approx. 2 secs)
 - **rpc**: Added a WebSocket RPC interface. (experimental)
@@ -37,18 +41,31 @@ Performance improvements, fixes for memory leaks and bugs related to EPG process
 - **ui/status**: Fix "EPG Gathering Network IDs" hex strings to upper case.
 - **ui/status**: Fix handle tuner updates to correctly. (bug) [#109](https://github.com/Chinachu/Mirakurun/pull/109)
 - **ui/config**: Add "EPG Gathering Interval" setting in Config/Server.
+- **ui/config**: Add "Allow IPv4 CIDR Ranges", "Allow IPv6 CIDR Ranges" setting in Config/Server.
 - **ui/heart**: Add confirmation before accessing opencollective. [#106](https://github.com/Chinachu/Mirakurun/issues/106)
 
+### Client Changes
+
+- Add [AbortSignal](https://nodejs.org/api/globals.html#class-abortsignal) option for `getChannelStream()`, `getServiceStreamByChannel()` `getServiceStream()`, `getProgramStream()`.
+- Fix set priority correctly. (bug)
+- Fix unexpected `postinstall` execution on npm@7 and later. (bug) [#116](https://github.com/Chinachu/Mirakurun/issues/116)
+
 ### Docker Changes
 
-- Update base image to `node:16.9.1-buster-slim`.
+- Update base image to `node:16.13.1-buster-slim`.
 - Fixed the exit signal handling properly.
 - When a `SIGHUP` is received in a container, only the node process can be restarted quickly.
+- Add startup script (it runs `/opt/bin/startup`) support.
+- default `docker-compose.yml` volumes has been changed:
+  - `/usr/local/mirakurun/*` → `/opt/mirakurun/*`
+- default `docker-compose.yml` network_mode has been changed to `host`.
+  - it enables IPv6 options.
 
 ### Other Changes
 
+- **package**: Drop engine support `node@12`.
 - **package**: Update dependencies.
-- Reimplemented certain processes in C++.
+- remove `colors` package for urgent security reasons.
 
 ## 3.8.0 (2021-08-10)
 

package/CONTRIBUTING.md

@@ -2,6 +2,11 @@
 
 ## Report an Issue (問題の報告)
 
+All issues that are not bugs or cannot be reproduced will be closed due to the limited moderating capacity at the moment.
+If you have any comments or requests, please send them to the Discord.<br>
+現在、管理体制が限定的なため、バグではないか、バグが再現できない Issue は全てクローズされます。
+ご意見・ご要望については、是非 Discord にお寄せください。
+
 * https://github.com/Chinachu/Mirakurun/issues
 
 When reporting an issue we also need as much information about your environment
@@ -20,13 +25,14 @@ that you can include. We never know what is your environment.<br>
 git clone git@github.com:Chinachu/Mirakurun.git
 cd Mirakurun
 git checkout <branch>
+git submodule update --init
 ```
 
 ### Build
 
 ```sh
 # Docker on Linux
-npm run docker-build
+npm run docker:build
 
 # Linux / Win32
 npm install
@@ -37,7 +43,7 @@ npm run build
 
 ```sh
 # Docker on Linux
-npm run docker-run
+npm run docker:run
 
 # Linux
 sudo npm run start
@@ -50,7 +56,7 @@ npm run start.win32
 
 ```sh
 # Docker on Linux
-npm run docker-debug
+npm run docker:debug
 
 # Linux
 sudo npm run debug

package/README.md

@@ -2,13 +2,11 @@
 
 # Mirakurun
 
-DVR Tuner Server Service for **[Chinachu](https://chinachu.moe/)** Air.
+DVR Tuner Server for Japanese TV which designed for the "Air" (in development codename).
 
 [![npm version][npm-img]][npm-url]
 [![npm downloads][downloads-image]][downloads-url]
 [![Linux Build][azure-pipelines-img]][azure-pipelines-url]
-[![Dependency Status][dep-img]][dep-url]
-[![devDependency Status][devdep-img]][devdep-url]
 [![tip for next commit](https://tip4commit.com/projects/43158.svg)](https://tip4commit.com/github/Chinachu/Mirakurun)
 [![Backers on Open Collective](https://opencollective.com/Mirakurun/backers/badge.svg)](#backers)
 [![Sponsors on Open Collective](https://opencollective.com/Mirakurun/sponsors/badge.svg)](#sponsors)
@@ -58,7 +56,7 @@ see: [doc/Platforms.md](doc/Platforms.md)
 
 ## Requirements / Supported Platforms
 
-* [Node.js](http://nodejs.org/) 12, 14, 16
+* [Node.js](http://nodejs.org/) 14, 16
 * Linux w/ [PM2](http://pm2.keymetrics.io/) or [Docker](https://hub.docker.com/r/chinachu/mirakurun)
 
 see: [doc/Platforms.md](doc/Platforms.md)
@@ -88,6 +86,7 @@ You can use PM2 Plus to realtime monitoring if running by PM2.
 * [Rivarun](https://github.com/Chinachu/Rivarun)
 * [BonDriver_Mirakurun](https://github.com/Chinachu/BonDriver_Mirakurun)
 * Mirakurun Client ([Built-in](https://github.com/Chinachu/Mirakurun/blob/master/src/client.ts))
+  * "Air" (in development codename)
   * [Chinachu γ](https://github.com/Chinachu/Chinachu/wiki/Gamma-Installation-V2)
   * [EPGStation](https://github.com/l3tnun/EPGStation)
 
@@ -145,9 +144,5 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 [downloads-image]: https://img.shields.io/npm/dm/mirakurun.svg?style=flat
 [downloads-url]: https://npmjs.org/package/mirakurun
 [azure-pipelines-img]: https://dev.azure.com/chinachu/Mirakurun/_apis/build/status/Chinachu.Mirakurun?branchName=master
-[azure-pipelines-url]: hhttps://dev.azure.com/chinachu/Mirakurun/_build/latest?definitionId=1&branchName=master
-[dep-img]: https://david-dm.org/Chinachu/Mirakurun.svg
-[dep-url]: https://david-dm.org/Chinachu/Mirakurun
-[devdep-img]: https://david-dm.org/Chinachu/Mirakurun/dev-status.svg
-[devdep-url]: https://david-dm.org/Chinachu/Mirakurun#info=devDependencies
+[azure-pipelines-url]: https://dev.azure.com/chinachu/Mirakurun/_build/latest?definitionId=1&branchName=master
 [docker-url]: https://hub.docker.com/r/chinachu/mirakurun

package/api.d.ts

@@ -220,7 +220,7 @@ export interface Event {
 
 export type EventResource = "program" | "service" | "tuner";
 
-export type EventType = "create" | "update" | "redefine";
+export type EventType = "create" | "update" | "remove";
 
 export interface ConfigServer {
     path?: string;
@@ -237,6 +237,8 @@ export interface ConfigServer {
     logoDataInterval?: number;
     disableEITParsing?: boolean;
     disableWebUI?: boolean;
+    allowIPv4CidrRanges?: string[];
+    allowIPv6CidrRanges?: string[];
 }
 
 export enum LogLevel {

package/api.yml

@@ -2,10 +2,10 @@ swagger: '2.0'
 info:
   title: Mirakurun
   version: ~
-  description: DVR Tuner Server Service for Chinachu Air.
+  description: DVR Tuner Server for Japanese TV.
   contact:
-    name: kanreisa
-    url: https://github.com/kanreisa
+    name: Chinachu Project
+    url: https://chinachu.moe/
 basePath: /api
 consumes:
   - application/json
@@ -448,7 +448,7 @@ definitions:
     enum:
       - create
       - update
-      - redefine
+      - remove
 
   # config --------------------------------------------------------------------
 
@@ -489,6 +489,14 @@ definitions:
         type: boolean
       disableWebUI:
         type: boolean
+      allowIPv4CidrRanges:
+        type: array
+        items:
+          type: string
+      allowIPv6CidrRanges:
+        type: array
+        items:
+          type: string
 
   ConfigTuners:
     type: array

package/bin/postinstall.js

@@ -15,7 +15,7 @@
 */
 "use strict";
 
-if (process.env["npm_config_global"] !== undefined && process.env["npm_config_global"] !== "true") {
+if (process.env["npm_config_global"] !== "true") {
     process.exit(0);
 }
 
@@ -23,14 +23,13 @@ const fs = require("fs");
 const path = require("path");
 const child_process = require("child_process");
 const semver = require("semver");
-const colors = require("colors");
 const pkg = require("../package.json");
 
 // node check
 if (semver.satisfies(process.version, pkg.engines.node) === true) {
-    console.log("Version:", `node@${process.version}`.green, "[OK]".bgGreen);
+    console.log("Version:", `node@${process.version}`, "[OK]");
 } else {
-    console.error("Version:", `node@${process.version}`.red, "[NG]".bgRed, "Expected:", pkg.engines.node);
+    console.error("Version:", `node@${process.version}`, "[NG]", "Expected:", pkg.engines.node);
     process.exit(1);
 }
 
@@ -57,9 +56,9 @@ if (process.platform === "linux" || process.platform === "darwin") {
     const pm2Version = child_process.execSync("pm2 -v", { encoding: "utf8" }).trim();
     const pm2Expected = ">=2.4.0";
     if (semver.satisfies(pm2Version, pm2Expected) === true) {
-        console.log("Version:", `pm2@${pm2Version}`.green, "[OK]".bgGreen);
+        console.log("Version:", `pm2@${pm2Version}`, "[OK]");
     } else {
-        console.error("Version:", `pm2@${pm2Version}`.red, "[NG]".bgRed, "Expected:", pm2Expected);
+        console.error("Version:", `pm2@${pm2Version}`, "[NG]", "Expected:", pm2Expected);
         process.exit(1);
     }
 
@@ -72,7 +71,7 @@ if (process.platform === "linux" || process.platform === "darwin") {
             ]
         });
     } catch (e) {
-        console.log("Caution: `pm2 startup` has failed. you can try fix yourself.".bgYellow);
+        console.log("Caution: `pm2 startup` has failed. you can try fix yourself.");
     }
 
     child_process.execSync("pm2 start processes.json", {
@@ -95,9 +94,9 @@ if (process.platform === "linux" || process.platform === "darwin") {
     const winserVersion = child_process.execSync("winser -v", { encoding: "utf8" }).replace(/^[a-z]+ /, "").trim();
     const winserExpected = ">=1.0.3 <2.0.0";
     if (semver.satisfies(winserVersion, winserExpected) === true) {
-        console.log("Version:", `winser@${winserVersion}`.green, "[OK]".bgGreen);
+        console.log("Version:", `winser@${winserVersion}`, "[OK]");
     } else {
-        console.error("Version:", `winser@${winserVersion}`.red, "[NG]".bgRed, "Expected:", winserExpected);
+        console.error("Version:", `winser@${winserVersion}`, "[NG]", "Expected:", winserExpected);
         process.exit(1);
     }
 

package/bin/preuninstall.js

@@ -15,7 +15,7 @@
 */
 "use strict";
 
-if (process.env["npm_config_global"] !== undefined && process.env["npm_config_global"] !== "true") {
+if (process.env["npm_config_global"] !== "true") {
     process.exit(0);
 }
 

package/config/dvbconf-for-isdb/conf/dvbv5_channels_isdbs.conf

@@ -141,15 +141,15 @@
 [BS23_1]
 	DELIVERY_SYSTEM = ISDBS
 	FREQUENCY = 1471440
-	STREAM_ID = 18289
+	STREAM_ID = 18801
 [BS23_2]
 	DELIVERY_SYSTEM = ISDBS
 	FREQUENCY = 1471440
-	STREAM_ID = 18290
+	STREAM_ID = 18802
 [BS23_3]
 	DELIVERY_SYSTEM = ISDBS
 	FREQUENCY = 1471440
-	STREAM_ID = 18291
+	STREAM_ID = 18803
 [CS2]
 	DELIVERY_SYSTEM = ISDBS
 	FREQUENCY = 1613000

package/doc/Configuration.md

@@ -27,6 +27,8 @@ epgRetrievalTime: 600000 # integer (ms)
 logoDataInterval: 604800000 # integer (ms)
 disableEITParsing: false # boolean
 disableWebUI: false # boolean
+allowIPv4CidrRanges: ["10.0.0.0/8", "127.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] # array of string
+allowIPv6CidrRanges: ["fc00::/7"] # array of string
 ```
 
 ### Environment Values (Docker)
@@ -43,6 +45,8 @@ EPG_RETRIEVAL_TIME
 LOGO_DATA_INTERVAL
 DISABLE_EIT_PARSING
 DISABLE_WEB_UI
+ALLOW_IPV4_CIDR_RANGES
+ALLOW_IPV6_CIDR_RANGES
 ```
 
 ## tuners.yml

package/doc/Platforms.md

@@ -2,17 +2,17 @@
 
 ## Overview
 
-**Bold** is the recommended. also, **Node.js** `^12 || ^14 || ^16` needed.
+**Bold** is the recommended. also, **Node.js** `^14.17.0 || ^16` needed.
 
 * [**Docker on Linux**](#docker-on-linux)
   * [Docker Engine](https://docs.docker.com/engine/install/) `>=18.06.0`
   * [Docker Compose](https://docs.docker.com/compose/install/) `>=1.22.0`
-  * **x64**
+  * **x64** / arm32v7 / **arm64v8**
   * **Ubuntu Server 20.04** / Debian 9 / CentOS 8.1
   * ⚠ Note: Desktop Environment / VM is not supported and unstable!
 * [Linux](#linux)
   * [PM2](http://pm2.keymetrics.io/) `>=2.4.0`
-  * x86 / **x64** / ARMv7 / **ARMv8**
+  * x86 / x64 / arm64v8
   * **Debian** / **Ubuntu Server** / CentOS / Gentoo
   * SystemV / OpenRC / **SystemD**
   * ⚠ Note: Desktop Environment / VM is not supported and unstable!
@@ -39,6 +39,10 @@ curl -sSL https://get.docker.com/ | CHANNEL=stable sh
 ### Install / Uninstall / Update
 
 ```sh
+# Create: /opt/mirakurun/
+sudo mv -vf /usr/local/mirakurun /opt/mirakurun
+sudo mkdir -p /opt/mirakurun/run /opt/mirakurun/opt /opt/mirakurun/config /opt/mirakurun/data
+
 # Install
 mkdir ~/mirakurun/
 cd ~/mirakurun/
@@ -80,20 +84,50 @@ docker-compose logs [-f]
 ### Config
 
 ```
-vim /usr/local/mirakurun/config/server.yml
-vim /usr/local/mirakurun/config/tuners.yml
-vim /usr/local/mirakurun/config/channels.yml
+vim /opt/mirakurun/config/server.yml
+vim /opt/mirakurun/config/tuners.yml
+vim /opt/mirakurun/config/channels.yml
 ```
 
 see: [Configuration.md](Configuration.md)
 
 ### 💡 How to Use: Non-DVB Devices
 
+#### option: **using custom startup script**
+
+```sh
+mkdir -p /opt/mirakurun/opt/bin
+vim /opt/mirakurun/opt/bin/startup # example ↓
+chmod +x /opt/mirakurun/opt/bin/startup
+```
+```bash
+#!/bin/bash
+
+if !(type "recpt1" > /dev/null 2>&1); then
+  apt-get update
+  apt-get install -y --no-install-recommends git autoconf automake
+
+  cd /tmp
+  git clone https://github.com/stz2012/recpt1.git
+  cd recpt1/recpt1
+  ./autogen.sh
+  ./configure --prefix /opt
+  make
+  make install
+fi
+
+recpt1 -v
+```
+```sh
+docker-compose down
+docker-compose run --rm -e SETUP=true mirakurun
+docker-compose up -d
+```
+
+#### option: **using static build**
+
 ```sh
-$ which recpt1
-/usr/local/bin/recpt1
-$ cp /usr/local/bin/recpt1 /usr/local/mirakurun/opt/bin/
-$ vim /usr/local/mirakurun/config/tuners.yml
+$ cp /usr/local/bin/something-static /opt/mirakurun/opt/bin/
 ```
 
 ### 💡 Locations (Container)
@@ -108,19 +142,21 @@ $ vim /usr/local/mirakurun/config/tuners.yml
   * `programs.json`
 * Opt: `/opt/`
   * `bin/`
+  * `bin/startup` - custom startup script (optional)
 
 ### 💡 Locations (Host)
 
-* Socket: `/usr/local/mirakurun/run/mirakurun.sock`
-* Config: `/usr/local/mirakurun/config/`
+* Socket: `/opt/mirakurun/run/mirakurun.sock`
+* Config: `/opt/mirakurun/config/`
   * `server.yml`
   * `tuners.yml`
   * `channels.yml`
-* Data: `/usr/local/mirakurun/data/`
+* Data: `/opt/mirakurun/data/`
   * `services.json`
   * `programs.json`
-* Opt: `/usr/local/mirakurun/opt/`
+* Opt: `/opt/mirakurun/opt/`
   * `bin/`
+  * `bin/startup` - custom startup script (optional)
 
 ## Linux
 
@@ -151,7 +187,7 @@ sudo apt install build-essential
 sudo npm install pm2 -g
 
 # Quick
-sudo npm install mirakurun -g --unsafe-perm --production
+sudo npm install mirakurun -g --unsafe-perm --foreground-scripts --production
 
 # Advanced
 sudo npm install mirakurun -g --production
@@ -239,7 +275,7 @@ npm install winser@1.0.3 -g
 **use Windows PowerShell as Admin.**
 
 ```
-npm install mirakurun@latest -g --production
+npm install mirakurun@latest -g --foreground-scripts --production
 ```
 
 ### Uninstall

package/docker/container-init.sh

@@ -37,6 +37,13 @@ if [ -f "/app-data/programs.yml" -a ! -f "$PROGRAMS_DB_PATH" ]; then
   cp -v "/app-data/programs.yml" "$PROGRAMS_DB_PATH"
 fi
 
+# custom startup script
+if [ -e "/opt/bin/startup" ]; then
+  echo "executing /opt/bin/startup..."
+  /opt/bin/startup
+  echo "done."
+fi
+
 # only for test purpose
 if !(type "arib-b25-stream-test" > /dev/null 2>&1); then
   npm --prefix /opt install arib-b25-stream-test

package/docker/docker-compose.yml

@@ -1,7 +1,4 @@
 version: "3.7"
-networks:
-  default:
-    name: mirakurun
 services:
   mirakurun:
     build:
@@ -14,19 +11,32 @@ services:
       - SYS_NICE
     environment:
       TZ: Asia/Tokyo
+      DOCKER_NETWORK: host
       # LOG_LEVEL: "3"
       # DEBUG: "true"
-    ports:
-      - 40772:40772
-      # - 9229:9229
+    network_mode: host
     devices:
       - /dev/bus:/dev/bus
       - /dev/dvb:/dev/dvb
     volumes:
-      - /usr/local/mirakurun/run/:/var/run/
-      - /usr/local/mirakurun/opt/:/opt/
-      - /usr/local/mirakurun/config/:/app-config/
-      - /usr/local/mirakurun/data/:/app-data/
+      # ** CAUTION **
+      # (default) `/usr/local/mirakurun/*` has been moved to `/opt/mirakurun/*`
+      # try:
+      #   sudo mv -vf /usr/local/mirakurun /opt/mirakurun
+      #   sudo mkdir -p /opt/mirakurun/run /opt/mirakurun/opt /opt/mirakurun/config /opt/mirakurun/data
+      # you can change to any location if required.
+      - type: bind
+        source: /opt/mirakurun/run/
+        target: /var/run/
+      - type: bind
+        source: /opt/mirakurun/opt/
+        target: /opt/
+      - type: bind
+        source: /opt/mirakurun/config/
+        target: /app-config/
+      - type: bind
+        source: /opt/mirakurun/data/
+        target: /app-data/
     restart: always
     logging:
       driver: json-file

package/lib/Mirakurun/EPG.d.ts

@@ -1,10 +1,6 @@
 import { EIT } from "@chinachu/aribts/lib/table/eit";
 export default class EPG {
     private _epg;
-    private _queue;
-    private _running;
-    private _end;
     write(eit: EIT): void;
     end(): void;
-    private _run;
 }