Merge pull request #322 from getmango/rc/0.27.0

v0.27.0

.ameba.yml

@@ -12,3 +12,4 @@ Layout/LineLength:
   MaxLength: 80
   Excluded:
     - src/routes/api.cr
+    - spec/plugin_spec.cr

README.md

@@ -51,7 +51,7 @@ The official docker images are available on [Dockerhub](https://hub.docker.com/r
 ### CLI
 
 ```
-  Mango - Manga Server and Web Reader. Version 0.26.2
+  Mango - Manga Server and Web Reader. Version 0.27.0
 
   Usage:
 

public/js/plugin-download.js

@@ -1,6 +1,7 @@
 const component = () => {
 	return {
 		plugins: [],
+		subscribable: false,
 		info: undefined,
 		pid: undefined,
 		chapters: undefined, // undefined: not searched yet, []: empty
@@ -60,6 +61,7 @@ const component = () => {
 				.then((data) => {
 					if (!data.success) throw new Error(data.error);
 					this.info = data.info;
+					this.subscribable = data.subscribable;
 					this.pid = pid;
 				})
 				.catch((e) => {
@@ -70,6 +72,9 @@ const component = () => {
 				});
 		},
 		pluginChanged() {
+			this.manga = undefined;
+			this.chapters = undefined;
+			this.mid = undefined;
 			this.loadPlugin(this.pid);
 			localStorage.setItem("plugin", this.pid);
 		},
@@ -140,6 +145,7 @@ const component = () => {
 			if (!query) return;
 
 			this.manga = undefined;
+			this.mid = undefined;
 			if (this.info.version === 1) {
 				this.searchChapters(query);
 			} else {

public/js/reader.js

@@ -14,6 +14,7 @@ const readerComponent = () => {
 		margin: 30,
 		preloadLookahead: 3,
 		enableRightToLeft: false,
+		fitType: 'vert',
 
 		/**
 		 * Initialize the component by fetching the page dimensions
@@ -65,6 +66,11 @@ const readerComponent = () => {
 						this.preloadImage(this.items[idx - 1].url);
 					}
 
+					const savedFitType = localStorage.getItem('fitType');
+					if (savedFitType) {
+						this.fitType = savedFitType;
+						$('#fit-select').val(savedFitType);
+					}
 					const savedFlipAnimation = localStorage.getItem('enableFlipAnimation');
 					this.enableFlipAnimation = savedFlipAnimation === null || savedFlipAnimation === 'true';
 
@@ -335,6 +341,11 @@ const readerComponent = () => {
 			this.toPage(this.selectedIndex);
 		},
 
+		fitChanged(){
+			this.fitType = $('#fit-select').val();
+			localStorage.setItem('fitType', this.fitType);
+		},
+
 		preloadLookaheadChanged() {
 			localStorage.setItem('preloadLookahead', this.preloadLookahead);
 		},

shard.yml

@@ -1,5 +1,5 @@
 name: mango
-version: 0.26.2
+version: 0.27.0
 
 authors:
   - Alex Ling <hkalexling@gmail.com>

spec/asset/plugins/plugin/info.json

@@ -0,0 +1,6 @@
+{
+	"id": "test",
+	"title": "Test Plugin",
+	"placeholder": "placeholder",
+	"wait_seconds": 1
+}

spec/config_spec.cr

@@ -1,14 +1,31 @@
 require "./spec_helper"
 
 describe Config do
-  it "creates config if it does not exist" do
+  it "creates default config if it does not exist" do
-    with_default_config do |_, path|
+    with_default_config do |config, path|
       File.exists?(path).should be_true
+      config.port.should eq 9000
     end
   end
 
   it "correctly loads config" do
     config = Config.load "spec/asset/test-config.yml"
     config.port.should eq 3000
+    config.base_url.should eq "/"
+  end
+
+  it "correctly reads config defaults from ENV" do
+    ENV["LOG_LEVEL"] = "debug"
+    config = Config.load "spec/asset/test-config.yml"
+    config.log_level.should eq "debug"
+    config.base_url.should eq "/"
+  end
+
+  it "correctly handles ENV truthiness" do
+    ENV["CACHE_ENABLED"] = "false"
+    config = Config.load "spec/asset/test-config.yml"
+    config.cache_enabled.should be_false
+    config.cache_log_enabled.should be_true
+    config.disable_login.should be_false
   end
 end

spec/plugin_spec.cr

@@ -0,0 +1,70 @@
+require "./spec_helper"
+
+describe Plugin do
+  describe "helper functions" do
+    it "mango.text" do
+      with_plugin do |plugin|
+        res = plugin.eval <<-JS
+        mango.text('<a href="https://github.com">Click Me<a>');
+      JS
+        res.should eq "Click Me"
+      end
+    end
+
+    it "mango.text returns empty string when no text" do
+      with_plugin do |plugin|
+        res = plugin.eval <<-JS
+        mango.text('<img src="https://github.com" />');
+        JS
+        res.should eq ""
+      end
+    end
+
+    it "mango.css" do
+      with_plugin do |plugin|
+        res = plugin.eval <<-JS
+        mango.css('<ul><li class="test">A</li><li class="test">B</li><li>C</li></ul>', 'li.test');
+
+        JS
+        res.should eq ["<li class=\"test\">A</li>", "<li class=\"test\">B</li>"]
+      end
+    end
+
+    it "mango.css returns empty array when no match" do
+      with_plugin do |plugin|
+        res = plugin.eval <<-JS
+        mango.css('<ul><li class="test">A</li><li class="test">B</li><li>C</li></ul>', 'li.noclass');
+        JS
+        res.should eq [] of String
+      end
+    end
+
+    it "mango.attribute" do
+      with_plugin do |plugin|
+        res = plugin.eval <<-JS
+        mango.attribute('<a href="https://github.com">Click Me<a>', 'href');
+        JS
+        res.should eq "https://github.com"
+      end
+    end
+
+    it "mango.attribute returns undefined when no match" do
+      with_plugin do |plugin|
+        res = plugin.eval <<-JS
+        mango.attribute('<div />', 'href') === undefined;
+        JS
+        res.should be_true
+      end
+    end
+
+    # https://github.com/hkalexling/Mango/issues/320
+    it "mango.attribute handles tags in attribute values" do
+      with_plugin do |plugin|
+        res = plugin.eval <<-JS
+        mango.attribute('<div data-a="<img />" data-b="test" />', 'data-b');
+        JS
+        res.should eq "test"
+      end
+    end
+  end
+end

spec/spec_helper.cr

@@ -3,6 +3,7 @@ require "../src/queue"
 require "../src/server"
 require "../src/config"
 require "../src/main_fiber"
+require "../src/plugin/plugin"
 
 class State
   @@hash = {} of String => String
@@ -54,3 +55,10 @@ def with_storage
     end
   end
 end
+
+def with_plugin
+  with_default_config do
+    plugin = Plugin.new "test", "spec/asset/plugins"
+    yield plugin
+  end
+end

src/config.cr

@@ -1,31 +1,51 @@
 require "yaml"
 
 class Config
+  private OPTIONS = {
+    "host"                                => "0.0.0.0",
+    "port"                                => 9000,
+    "base_url"                            => "/",
+    "session_secret"                      => "mango-session-secret",
+    "library_path"                        => "~/mango/library",
+    "library_cache_path"                  => "~/mango/library.yml.gz",
+    "db_path"                             => "~/mango.db",
+    "queue_db_path"                       => "~/mango/queue.db",
+    "scan_interval_minutes"               => 5,
+    "thumbnail_generation_interval_hours" => 24,
+    "log_level"                           => "info",
+    "upload_path"                         => "~/mango/uploads",
+    "plugin_path"                         => "~/mango/plugins",
+    "download_timeout_seconds"            => 30,
+    "cache_enabled"                       => true,
+    "cache_size_mbs"                      => 50,
+    "cache_log_enabled"                   => true,
+    "disable_login"                       => false,
+    "default_username"                    => "",
+    "auth_proxy_header_name"              => "",
+    "plugin_update_interval_hours"        => 24,
+  }
+
   include YAML::Serializable
 
   @[YAML::Field(ignore: true)]
-  property path = ""
+  property path : String = ""
-  property host = "0.0.0.0"
+
-  property port : Int32 = 9000
+  # Go through the options constant above and define them as properties.
-  property base_url = "/"
+  #   Allow setting the default values through environment variables.
-  property session_secret = "mango-session-secret"
+  # Overall precedence: config file > environment variable > default value
-  property library_path = "~/mango/library"
+  {% begin %}
-  property library_cache_path = "~/mango/library.yml.gz"
+    {% for k, v in OPTIONS %}
-  property db_path = "~/mango/mango.db"
+        {% if v.is_a? StringLiteral %}
-  property queue_db_path = "~/mango/queue.db"
+          property {{k.id}} : String = ENV[{{k.upcase}}]? || {{ v }}
-  property scan_interval_minutes : Int32 = 5
+        {% elsif v.is_a? NumberLiteral %}
-  property thumbnail_generation_interval_hours : Int32 = 24
+          property {{k.id}} : Int32 = (ENV[{{k.upcase}}]? || {{ v.id }}).to_i
-  property log_level = "info"
+        {% elsif v.is_a? BoolLiteral %}
-  property upload_path = "~/mango/uploads"
+          property {{k.id}} : Bool = env_is_true? {{ k.upcase }}, {{ v.id }}
-  property plugin_path = "~/mango/plugins"
+        {% else %}
-  property download_timeout_seconds : Int32 = 30
+          raise "Unknown type in config option: {{ v.class_name.id }}"
-  property cache_enabled = true
+        {% end %}
-  property cache_size_mbs = 50
+    {% end %}
-  property cache_log_enabled = true
+  {% end %}
-  property disable_login = false
-  property default_username = ""
-  property auth_proxy_header_name = ""
-  property plugin_update_interval_hours : Int32 = 24
 
   @@singlet : Config?
 
@@ -38,7 +58,7 @@ class Config
   end
 
   def self.load(path : String?)
-    path = "~/.config/mango/config.yml" if path.nil?
+    path = (ENV["CONFIG_PATH"]? || "~/.config/mango/config.yml") if path.nil?
     cfg_path = File.expand_path path, home: true
     if File.exists? cfg_path
       config = self.from_yaml File.read cfg_path

src/logger.cr

@@ -38,6 +38,7 @@ class Logger
     Log.setup do |c|
       c.bind "*", @@severity, @backend
       c.bind "db.*", :error, @backend
+      c.bind "duktape", :none, @backend
     end
   end
 

src/mango.cr

@@ -7,7 +7,7 @@ require "option_parser"
 require "clim"
 require "tallboy"
 
-MANGO_VERSION = "0.26.2"
+MANGO_VERSION = "0.27.0"
 
 # From http://www.network-science.de/ascii/
 BANNER = %{

src/plugin/plugin.cr

@@ -105,9 +105,10 @@ class Plugin
   getter js_path = ""
   getter storage_path = ""
 
-  def self.build_info_ary
+  def self.build_info_ary(dir : String? = nil)
     @@info_ary.clear
-    dir = Config.current.plugin_path
+    dir ||= Config.current.plugin_path
+
     Dir.mkdir_p dir unless Dir.exists? dir
 
     Dir.each_child dir do |f|
@@ -160,8 +161,8 @@ class Plugin
     list.save
   end
 
-  def initialize(id : String)
+  def initialize(id : String, dir : String? = nil)
-    Plugin.build_info_ary
+    Plugin.build_info_ary dir
 
     @info = @@info_ary.find &.id.== id
     if @info.nil?
@@ -223,6 +224,10 @@ class Plugin
     raise Error.new "Missing required fields in the Page type"
   end
 
+  def can_subscribe? : Bool
+    info.version > 1 && eval_exists?("newChapters")
+  end
+
   def search_manga(query : String)
     if info.version == 1
       raise Error.new "Manga searching is only available for plugins " \
@@ -315,7 +320,7 @@ class Plugin
     json
   end
 
-  private def eval(str)
+  def eval(str)
     @rt.eval str
   rescue e : Duktape::SyntaxError
     raise SyntaxError.new e.message
@@ -327,6 +332,15 @@ class Plugin
     JSON.parse eval(str).as String
   end
 
+  private def eval_exists?(str) : Bool
+    @rt.eval str
+    true
+  rescue e : Duktape::ReferenceError
+    false
+  rescue e : Duktape::Error
+    raise Error.new e.message
+  end
+
   private def def_helper_functions(sbx)
     sbx.push_object
 
@@ -435,9 +449,15 @@ class Plugin
       env = Duktape::Sandbox.new ptr
       html = env.require_string 0
 
-      str = XML.parse(html).inner_text
+      begin
+        parser = Myhtml::Parser.new html
+        str = parser.body!.children.first.inner_text
+
+        env.push_string str
+      rescue
+        env.push_string ""
+      end
 
-      env.push_string str
       env.call_success
     end
     sbx.put_prop_string -2, "text"
@@ -448,8 +468,9 @@ class Plugin
       name = env.require_string 1
 
       begin
-        attr = XML.parse(html).first_element_child.not_nil![name]
+        parser = Myhtml::Parser.new html
-        env.push_string attr
+        attr = parser.body!.children.first.attribute_by name
+        env.push_string attr.not_nil!
       rescue
         env.push_undefined
       end

src/routes/api.cr

@@ -871,13 +871,15 @@ struct APIRouter
         "version"      => Int32,
         "settings"     => {} of String => String,
       },
+      "subscribable" => Bool,
     }
     get "/api/admin/plugin/info" do |env|
       begin
         plugin = Plugin.new env.params.query["plugin"].as String
         send_json env, {
-          "success" => true,
+          "success"      => true,
-          "info"    => plugin.info,
+          "info"         => plugin.info,
+          "subscribable" => plugin.can_subscribe?,
         }.to_json
       rescue e
         Logger.error e

src/util/signature.cr

@@ -64,11 +64,12 @@ class Dir
         path = File.join dirname, fn
         if File.directory? path
           signatures << Dir.contents_signature path, cache
-          signatures << fn if DirEntry.is_valid? path
         else
           # Only add its signature value to `signatures` when it is a
           #   supported file
-          signatures << fn if ArchiveEntry.is_valid? fn
+          if ArchiveEntry.is_valid?(fn) || is_supported_image_file(fn)
+            signatures << fn
+          end
         end
         Fiber.yield
       end

src/util/util.cr

@@ -1,9 +1,10 @@
 IMGS_PER_PAGE            = 5
 ENTRIES_IN_HOME_SECTIONS = 8
 UPLOAD_URL_PREFIX        = "/uploads"
-STATIC_DIRS              = %w(/css /js /img /webfonts /favicon.ico /robots.txt)
+STATIC_DIRS              = %w(/css /js /img /webfonts /favicon.ico /robots.txt
-SUPPORTED_FILE_EXTNAMES  = [".zip", ".cbz", ".rar", ".cbr"]
+  /manifest.json)
-SUPPORTED_IMG_TYPES      = %w(
+SUPPORTED_FILE_EXTNAMES = [".zip", ".cbz", ".rar", ".cbr"]
+SUPPORTED_IMG_TYPES     = %w(
   image/jpeg
   image/png
   image/webp
@@ -95,9 +96,9 @@ class String
   end
 end
 
-def env_is_true?(key : String) : Bool
+def env_is_true?(key : String, default : Bool = false) : Bool
   val = ENV[key.upcase]? || ENV[key.downcase]?
-  return false unless val
+  return default unless val
   val.downcase.in? "1", "true"
 end
 

src/views/plugin-download.html.ecr

@@ -133,8 +133,10 @@
           </template>
           <button class="uk-button uk-button-primary" @click.prevent="applyFilters()">Apply</button>
           <button class="uk-button uk-button-default" @click.prevent="clearFilters()">Clear</button>
-          <span class="uk-divider-vertical uk-margin-left uk-margin-right"></span>
+          <span x-show="subscribable">
-          <button class="uk-button uk-button-default" @click.prevent="UIkit.modal($refs.modal).show()" :disable="subscribing">Subscribe</button>
+            <span class="uk-divider-vertical uk-margin-left uk-margin-right"></span>
+            <button class="uk-button uk-button-default" @click.prevent="UIkit.modal($refs.modal).show()" :disable="subscribing">Subscribe</button>
+          </span>
         </form>
 
         <p class="uk-text-meta" x-show="chapters && chapters.length > chaptersLimit" x-text="`The manga has ${chapters ? chapters.length : 0} chapters, but Mango can only list up to ${chaptersLimit}. Please use the filters to narrow down your search.`"></p>

src/views/reader.html.ecr

@@ -5,7 +5,7 @@
   <%= render_component "head" %>
 
   <body style="position:relative;" x-data="readerComponent()" x-init="init($nextTick)" @resize.window="resized()">
-    <div class="uk-section uk-section-default uk-section-small reader-bg" :style="mode === 'continuous' ? '' : 'padding:0'">
+    <div class="uk-section uk-section-default uk-section-small reader-bg" :style="mode === 'continuous' ? '' : 'padding:0; position: relative;'">
 
       <div @keydown.window.debounce="keyHandler($event)"></div>
 
@@ -19,7 +19,7 @@
       </div>
 
       <div
-        :class="{'uk-container': true, 'uk-container-small': mode === 'continuous', 'uk-container-expand': mode !== 'continuous'}">
+        :class="{'uk-container': true, 'uk-container-small': mode === 'continuous', 'uk-container-expand': mode !== 'continuous'}" style="width: fit-content;">
         <div x-show="!loading && mode === 'continuous'" x-cloak>
           <template x-if="!loading && mode === 'continuous'" x-for="item in items">
             <img
@@ -40,18 +40,18 @@
           <%- end -%>
         </div>
 
-        <div x-cloak x-show="!loading && mode !== 'continuous'" class="uk-flex uk-flex-middle" style="height:100vh">
+        <div x-cloak x-show="!loading && mode !== 'continuous'" class="uk-flex uk-flex-middle" :style="`height:${fitType === 'vert' ? '100vh' : ''}; min-width: fit-content;`">
 
           <img uk-img :class="{
                                'uk-align-center': true, 
                                'uk-animation-slide-left': flipAnimation === 'left', 
                                'uk-animation-slide-right': flipAnimation === 'right'
                                }" :data-src="curItem.url" :width="curItem.width" :height="curItem.height" :id="curItem.id" @click="clickImage($event)" :style="`
-                                                                                                                                                                 width:${mode === 'width' ? '100vw' : 'auto'}; 
+                                                                                                                                                                 width:${fitType === 'horz' ? '100vw' : 'auto'}; 
-                                                                                                                                                                 height:${mode === 'height' ? '100vh' : 'auto'}; 
+                                                                                                                                                                 height:${fitType === 'vert' ? '100vh' : 'auto'}; 
                                                                                                                                                                  margin-bottom:0;
-                                                                                                                                                                 max-width:100%;
+                                                                                                                                                                 max-width:${fitType === 'horz' ? '100%' : fitType === 'vert' ? '' : 'none' };
-                                                                                                                                                                 max-height:100%;
+                                                                                                                                                                 max-height:${fitType === 'vert' ? '100%' : fitType === 'horz' ? '' : 'none'};
                                                                                                                                                                  object-fit: contain;
                                                                                                                                                                  `" />
 
@@ -94,6 +94,17 @@
             </div>
           </div>
 
+          <div class="uk-margin" x-show="mode !== 'continuous'">
+            <label class="uk-form-label" for="mode-select">Page fit</label>
+            <div class="uk-form-controls">
+              <select id="fit-select" class="uk-select" @change="fitChanged()">
+                <option value="vert">Fit height</option>
+                <option value="horz">Fit width</option>
+                <option value="real">Real size</option>
+              </select>
+            </div>
+          </div>
+
           <div class="uk-margin" x-show="mode === 'continuous'">
             <label class="uk-form-label" for="margin-range" x-text="`Page Margin: ${margin}px`"></label>
             <div class="uk-form-controls">