Plugin: update freewebnovel & add LibRead | Fix: svg generation (#975)

* freewebnovel:
 - removed freewebnovel signature
 - better error management
 - added genres
 - added filters

* Added LibRead

* fix: update svg locally

* fix: svg path

* fix: inline svg content

---------

Co-authored-by: nyagami <hoangquan05112002@gmail.com>

plugins/english/LibRead.ts

@@ -0,0 +1,216 @@
+import { Plugin } from '@typings/plugin';
+import { fetchApi, fetchFile } from '@libs/fetch';
+import { CheerioAPI, load as parseHTML } from 'cheerio';
+import qs from 'qs';
+import { Filters, FilterTypes } from '@libs/filterInputs';
+
+class LibReadPlugin implements Plugin.PluginBase {
+  id = 'libread';
+  name = 'Lib Read';
+  icon = 'src/en/libread/icon.png';
+  site = 'https://libread.org';
+  version = '1.0.0';
+
+  async getCheerio(url: string): Promise<CheerioAPI> {
+    const r = await fetchApi(url);
+    if (!r.ok)
+      throw new Error(
+        `Could not reach site (${r.status}: ${r.statusText}) try to open in webview.`,
+      );
+    return parseHTML(await r.text());
+  }
+
+  parseNovels(loadedCheerio: CheerioAPI): Plugin.NovelItem[] {
+    return loadedCheerio('.li-row')
+      .map((index, element) => ({
+        name: loadedCheerio(element).find('.tit').text() || '',
+        cover: loadedCheerio(element).find('img').attr('src'),
+        path: loadedCheerio(element).find('h3 > a').attr('href') || '',
+      }))
+      .get()
+      .filter(novel => novel.name && novel.path);
+  }
+
+  async popularNovels(
+    page: number,
+    {
+      showLatestNovels,
+      filters,
+    }: Plugin.PopularNovelsOptions<typeof this.filters>,
+  ): Promise<Plugin.NovelItem[]> {
+    let url = this.site;
+    if (showLatestNovels) url += '/sort/latest-novels/';
+    else {
+      if (
+        filters &&
+        filters.type_genre &&
+        filters.type_genre.value !== 'all' &&
+        filters.type_genre.value !== 'genre'
+      )
+        url += filters.type_genre.value;
+      else {
+        url += '/most-popular/';
+        if (page != 1) return [];
+        page = 0;
+      }
+    }
+    url += page;
+
+    const $ = await this.getCheerio(url);
+    return this.parseNovels($);
+  }
+
+  async parseNovel(novelPath: string): Promise<Plugin.SourceNovel> {
+    const loadedCheerio = await this.getCheerio(this.site + novelPath);
+
+    const novel: Plugin.SourceNovel = {
+      path: novelPath,
+      name: loadedCheerio('h1.tit').text(),
+      cover: loadedCheerio('.pic > img').attr('src'),
+      summary: loadedCheerio('.inner').text().trim(),
+    };
+
+    novel.genres = loadedCheerio('[title=Genre]')
+      .next()
+      .text()
+      .replace(/[\t\n]/g, '');
+
+    novel.author = loadedCheerio('[title=Author]')
+      .next()
+      .text()
+      .replace(/[\t\n]/g, '');
+
+    novel.status = loadedCheerio('[title=Status]')
+      .next()
+      .text()
+      .replace(/[\t\n]/g, '');
+
+    novel.genres = loadedCheerio('[title=Genre]')
+      .next()
+      .text()
+      .trim()
+      .replace(/[\t\n]/g, ',')
+      .replace(/, /g, ',');
+
+    const chapters: Plugin.ChapterItem[] = loadedCheerio('#idData > li > a')
+      .map((chapterIndex, element) => ({
+        name:
+          loadedCheerio(element).attr('title') ||
+          'Chapter ' + (chapterIndex + 1),
+        path:
+          loadedCheerio(element).attr('href') ||
+          novelPath.replace(
+            '.html',
+            '/chapter-' + (chapterIndex + 1) + '.html',
+          ),
+        releaseTime: null,
+        chapterNumber: chapterIndex + 1,
+      }))
+      .get();
+
+    novel.chapters = chapters;
+    return novel;
+  }
+
+  async parseChapter(chapterPath: string): Promise<string> {
+    const loadedCheerio = await this.getCheerio(this.site + chapterPath);
+
+    // remove freewebnovel signature
+    if (loadedCheerio('style').text().includes('p:nth-last-child(1)'))
+      loadedCheerio('div.txt').find('p:last-child').remove();
+
+    const chapterText = loadedCheerio('div.txt').html() || '';
+    return chapterText;
+  }
+
+  async searchNovels(searchTerm: string): Promise<Plugin.NovelItem[]> {
+    const r = await fetchApi(this.site + '/search/', {
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded',
+        Referer: this.site,
+        Origin: this.site,
+      },
+      method: 'POST',
+      body: qs.stringify({ searchkey: searchTerm }),
+    });
+    if (!r.ok)
+      throw new Error(
+        'Could not reach site (' + r.status + ') try to open in webview.',
+      );
+
+    const loadedCheerio = parseHTML(await r.text());
+    const alertText =
+      loadedCheerio('script')
+        .text()
+        .match(/alert\((.*?)\)/)?.[1] || '';
+    if (alertText) throw new Error(alertText);
+
+    return this.parseNovels(loadedCheerio);
+  }
+
+  fetchImage = fetchFile;
+
+  filters = {
+    type_genre: {
+      type: FilterTypes.Picker,
+      label: 'Novel Type/Genre',
+      value: 'all',
+      options: [
+        { label: 'Tous', value: 'all' },
+        { label: '═══NOVEL TYPES═══', value: '/sort/latest-release/' },
+        {
+          label: 'Chinese Novel',
+          value: '/sort/latest-release/chinese-novel/',
+        },
+        { label: 'Korean Novel', value: '/sort/latest-release/korean-novel/' },
+        {
+          label: 'Japanese Novel',
+          value: '/sort/latest-release/japanese-novel/',
+        },
+        {
+          label: 'English Novel',
+          value: '/sort/latest-release/english-novel/',
+        },
+        { label: '═══GENRES═══', value: 'genre' },
+        { label: 'Action', value: '/genre/Action/' },
+        { label: 'Adult', value: '/genre/Adult/' },
+        { label: 'Adventure', value: '/genre/Adventure/' },
+        { label: 'Comedy', value: '/genre/Comedy/' },
+        { label: 'Drama', value: '/genre/Drama/' },
+        { label: 'Eastern', value: '/genre/Eastern/' },
+        { label: 'Ecchi', value: '/genre/Ecchi/' },
+        { label: 'Fantasy', value: '/genre/Fantasy/' },
+        { label: 'Game', value: '/genre/Game/' },
+        { label: 'Gender Bender', value: '/genre/Gender+Bender/' },
+        { label: 'Harem', value: '/genre/Harem/' },
+        { label: 'Historical', value: '/genre/Historical/' },
+        { label: 'Horror', value: '/genre/Horror/' },
+        { label: 'Josei', value: '/genre/Josei/' },
+        { label: 'Martial Arts', value: '/genre/Martial+Arts/' },
+        { label: 'Mature', value: '/genre/Mature/' },
+        { label: 'Mecha', value: '/genre/Mecha/' },
+        { label: 'Mystery', value: '/genre/Mystery/' },
+        { label: 'Psychological', value: '/genre/Psychological/' },
+        { label: 'Reincarnation', value: '/genre/Reincarnation/' },
+        { label: 'Romance', value: '/genre/Romance/' },
+        { label: 'School Life', value: '/genre/School+Life/' },
+        { label: 'Sci-fi', value: '/genre/Sci-fi/' },
+        { label: 'Seinen', value: '/genre/Seinen/' },
+        { label: 'Shoujo', value: '/genre/Shoujo/' },
+        { label: 'Shounen Ai', value: '/genre/Shounen+Ai/' },
+        { label: 'Shounen', value: '/genre/Shounen/' },
+        { label: 'Slice of Life', value: '/genre/Slice+of+Life/' },
+        { label: 'Smut', value: '/genre/Smut/' },
+        { label: 'Sports', value: '/genre/Sports/' },
+        { label: 'Supernatural', value: '/genre/Supernatural/' },
+        { label: 'Tragedy', value: '/genre/Tragedy/' },
+        { label: 'Wuxia', value: '/genre/Wuxia/' },
+        { label: 'Xianxia', value: '/genre/Xianxia/' },
+        { label: 'Xuanhuan', value: '/genre/Xuanhuan/' },
+        { label: 'Yaoi', value: '/genre/Yaoi/' },
+      ],
+    },
+  } satisfies Filters;
+}
+
+export default new LibReadPlugin();

plugins/english/freewebnovel.ts

@@ -1,30 +1,28 @@
 import { Plugin } from '@typings/plugin';
 import { fetchApi, fetchFile } from '@libs/fetch';
 import { NovelStatus } from '@libs/novelStatus';
-import { load as parseHTML } from 'cheerio';
+import { CheerioAPI, load as parseHTML } from 'cheerio';
 import qs from 'qs';
+import { Filters, FilterTypes } from '@libs/filterInputs';
 
 class FreeWebNovel implements Plugin.PluginBase {
   id = 'FWN.com';
   name = 'Free Web Novel';
   site = 'https://freewebnovel.com';
-  version = '1.0.0';
+  version = '1.0.1';
   icon = 'src/en/freewebnovel/icon.png';
 
-  async popularNovels(
+  async getCheerio(url: string): Promise<CheerioAPI> {
-    page: number,
+    const r = await fetchApi(url);
-    { showLatestNovels }: Plugin.PopularNovelsOptions,
+    if (!r.ok)
-  ): Promise<Plugin.NovelItem[]> {
+      throw new Error(
-    const sort = showLatestNovels
+        `Could not reach site (${r.status}: ${r.statusText}) try to open in webview.`,
-      ? '/latest-release-novels/'
+      );
-      : '/completed-novels/';
+    return parseHTML(await r.text());
+  }
 
-    const body = await fetchApi(this.site + sort + page).then(res =>
+  parseNovels(loadedCheerio: CheerioAPI): Plugin.NovelItem[] {
-      res.text(),
+    return loadedCheerio('.li-row')
-    );
-    const loadedCheerio = parseHTML(body);
-
-    const novels: Plugin.NovelItem[] = loadedCheerio('.li-row')
       .map((index, element) => ({
         name: loadedCheerio(element).find('.tit').text() || '',
         cover: loadedCheerio(element).find('img').attr('src'),
@@ -32,13 +30,34 @@ class FreeWebNovel implements Plugin.PluginBase {
       }))
       .get()
       .filter(novel => novel.name && novel.path);
+  }
 
-    return novels;
+  async popularNovels(
+    page: number,
+    {
+      showLatestNovels,
+      filters,
+    }: Plugin.PopularNovelsOptions<typeof this.filters>,
+  ): Promise<Plugin.NovelItem[]> {
+    let url = this.site;
+    if (showLatestNovels) url += '/latest-release-novels/';
+    else {
+      if (filters && filters.genres && filters.genres.value !== 'all')
+        url += filters.genres.value;
+      else {
+        url += '/most-popular-novels/';
+        if (page != 1) return [];
+        page = 0;
+      }
+    }
+    url += page;
+
+    const $ = await this.getCheerio(url);
+    return this.parseNovels($);
   }
 
   async parseNovel(novelPath: string): Promise<Plugin.SourceNovel> {
-    const body = await fetchApi(this.site + novelPath).then(res => res.text());
+    const loadedCheerio = await this.getCheerio(this.site + novelPath);
-    const loadedCheerio = parseHTML(body);
 
     const novel: Plugin.SourceNovel = {
       path: novelPath,
@@ -62,6 +81,13 @@ class FreeWebNovel implements Plugin.PluginBase {
       .text()
       .replace(/[\t\n]/g, '');
 
+    novel.genres = loadedCheerio('[title=Genre]')
+      .next()
+      .text()
+      .trim()
+      .replace(/[\t\n]/g, ',')
+      .replace(/, /g, ',');
+
     const chapters: Plugin.ChapterItem[] = loadedCheerio('#idData > li > a')
       .map((chapterIndex, element) => ({
         name:
@@ -83,17 +109,18 @@ class FreeWebNovel implements Plugin.PluginBase {
   }
 
   async parseChapter(chapterPath: string): Promise<string> {
-    const body = await fetchApi(this.site + chapterPath).then(res =>
+    const loadedCheerio = await this.getCheerio(this.site + chapterPath);
-      res.text(),
+
-    );
+    // remove freewebnovel signature
-    const loadedCheerio = parseHTML(body);
+    if (loadedCheerio('style').text().includes('p:nth-last-child(1)'))
+      loadedCheerio('div.txt').find('p:last-child').remove();
 
     const chapterText = loadedCheerio('div.txt').html() || '';
     return chapterText;
   }
 
   async searchNovels(searchTerm: string): Promise<Plugin.NovelItem[]> {
-    const body = await fetchApi(this.site + '/search/', {
+    const r = await fetchApi(this.site + '/search/', {
       headers: {
         'Content-Type': 'application/x-www-form-urlencoded',
         Referer: this.site,
@@ -101,22 +128,69 @@ class FreeWebNovel implements Plugin.PluginBase {
       },
       method: 'POST',
       body: qs.stringify({ searchkey: searchTerm }),
-    }).then(res => res.text());
+    });
+    if (!r.ok)
+      throw new Error(
+        'Could not reach site (' + r.status + ') try to open in webview.',
+      );
 
-    const loadedCheerio = parseHTML(body);
+    const loadedCheerio = parseHTML(await r.text());
-    const novels: Plugin.NovelItem[] = loadedCheerio('.li-row > .li > .con')
+    const alertText =
-      .map((index, element) => ({
+      loadedCheerio('script')
-        name: loadedCheerio(element).find('.tit').text() || '',
+        .text()
-        cover: loadedCheerio(element).find('.pic > a > img').attr('src'),
+        .match(/alert\((.*?)\)/)?.[1] || '';
-        path: loadedCheerio(element).find('h3 > a').attr('href') || '',
+    if (alertText) throw new Error(alertText);
-      }))
-      .get()
-      .filter(novel => novel.name && novel.path);
 
-    return novels;
+    return this.parseNovels(loadedCheerio);
   }
 
   fetchImage = fetchFile;
+
+  filters = {
+    genres: {
+      type: FilterTypes.Picker,
+      label: 'Genre',
+      value: 'all',
+      options: [
+        { label: 'Action', value: '/genres/Action/' },
+        { label: 'Adult', value: '/genres/Adult/' },
+        { label: 'Adventure', value: '/genres/Adventure/' },
+        { label: 'Comedy', value: '/genres/Comedy/' },
+        { label: 'Drama', value: '/genres/Drama/' },
+        { label: 'Eastern', value: '/genres-novel/Eastern' },
+        { label: 'Ecchi', value: '/genres/Ecchi/' },
+        { label: 'Fantasy', value: '/genres/Fantasy/' },
+        { label: 'Gender Bender', value: '/genres/Gender+Bender/' },
+        { label: 'Harem', value: '/genres/Harem/' },
+        { label: 'Historical', value: '/genres/Historical/' },
+        { label: 'Horror', value: '/genres/Horror/' },
+        { label: 'Josei', value: '/genres/Josei/' },
+        { label: 'Game', value: '/genres/Game/' },
+        { label: 'Martial Arts', value: '/genres/Martial+Arts/' },
+        { label: 'Mature', value: '/genres/Mature/' },
+        { label: 'Mecha', value: '/genres/Mecha/' },
+        { label: 'Mystery', value: '/genres/Mystery/' },
+        { label: 'Psychological', value: '/genres/Psychological/' },
+        { label: 'Reincarnation', value: '/genres-novel/Reincarnation' },
+        { label: 'Romance', value: '/genres/Romance/' },
+        { label: 'School Life', value: '/genres/School+Life/' },
+        { label: 'Sci-fi', value: '/genres/Sci-fi/' },
+        { label: 'Seinen', value: '/genres/Seinen/' },
+        { label: 'Shoujo', value: '/genres/Shoujo/' },
+        { label: 'Shounen Ai', value: '/genres/Shounen+Ai/' },
+        { label: 'Shounen', value: '/genres/Shounen/' },
+        { label: 'Slice of Life', value: '/genres/Slice+of+Life/' },
+        { label: 'Smut', value: '/genres/Smut/' },
+        { label: 'Sports', value: '/genres/Sports/' },
+        { label: 'Supernatural', value: '/genres/Supernatural/' },
+        { label: 'Tragedy', value: '/genres/Tragedy/' },
+        { label: 'Wuxia', value: '/genres/Wuxia/' },
+        { label: 'Xianxia', value: '/genres/Xianxia/' },
+        { label: 'Xuanhuan', value: '/genres/Xuanhuan/' },
+        { label: 'Yaoi', value: '/genres/Yaoi/' },
+      ],
+    },
+  } satisfies Filters;
 }
 
 export default new FreeWebNovel();

scripts/json_plugins.ts

@@ -87,14 +87,12 @@ json.sort((a, b) => {
 
 fs.writeFileSync(jsonMinPath, JSON.stringify(json));
 fs.writeFileSync(jsonPath, JSON.stringify(json, null, '\t'));
-fetch(`https://img.shields.io/badge/Plugins-${totalPlugins}-blue`)
+fs.writeFileSync(
-  .then(res => res.text())
+  'total.svg',
-  .then(data => {
+  `
-    fs.writeFileSync('total.svg', data, { encoding: 'utf-8' });
+  <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="80" height="20" role="img" aria-label="Plugins: ${totalPlugins}"><title>Plugins: ${totalPlugins}</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="80" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="49" height="20" fill="#555"/><rect x="49" width="31" height="20" fill="#007ec6"/><rect width="80" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="255" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="390">Plugins</text><text x="255" y="140" transform="scale(.1)" fill="#fff" textLength="390">Plugins</text><text aria-hidden="true" x="635" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">161</text><text x="635" y="140" transform="scale(.1)" fill="#fff" textLength="210">${totalPlugins}</text></g></svg>
-  })
+  `,
-  .catch(error => {
+);
-    fs.writeFileSync('total.svg', '', { encoding: 'utf-8' });
-  });
 
 // check for broken plugins
 for (let language in languages) {