kamishibai 0.6.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 989fed21e0f1b3aa868e8d7e3ddb847764941731
+  data.tar.gz: 9a5df75a8f7c271101ae73e96182dca1cdd7b6c8
+SHA512:
+  metadata.gz: 76e19f834f866ee87a3ff77f94779a3042ff159311b10a787470a805faf56c0898b33605a9cf9b07648ec9852d255d3fb4d2a9ea5628ee2d8aa45e61523c5035
+  data.tar.gz: 222aa7bc8838901953ef419fc68876580a7721db6dc0f95973a0bf0a4d90297919d15d0d69cb8f76d7966ad7c3b87f8a4244c78a8e66d244758a798bdd3dd025

data/.gitignore

@@ -0,0 +1 @@
+.idea/*

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2013, 
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,91 @@
+Kamishibai
+=========================
+> pronounce kami-shi-bye
+
+Remote manga reader. Read manga anywhere using a web browser.  
+
+It remember where the manga is read upto, so you can resume reading with ease.
+
+Support basic tagging in filenaming, please read file naming convention below. 
+
+Settings can change image quality to conserve bandwidth.  
+
+Zipped (CBZ) books are supported.  
+
+Screenshots:
+--------------------------  
+Directory view
+![Directory view](/images/view_browse.jpg)
+
+Tablet Browse view
+![Tablet Browse view](/images/view_browse.jpg)
+
+Reading
+![Reading](/images/reading.jpg)
+
+Settings
+![Settings](/images/settings.jpg)
+
+Update:
+--------------------------  
+Didn't touch the code for years, had a quick touchup to make sure it works. Found lots of old/bad code, but that was written in 2013, so please don't judge too harshly.
+
+Installation:
+--------------------------
+gem install kamishibai
+  
+
+Installation (extra info):
+--------------------------
+
+Mac OS X:  
+1. Install [MacPorts](http://www.macports.org/)  
+2. sudo port install ruby25 rb-rubygems gd2  
+3. sudo gem install kamishibai
+  
+Linux (Ubuntu/Debian):  
+1. sudo apt-get install ruby ruby-dev  
+2. sudo gem install kamishibai
+
+Windows:
+1. Install the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
+2. Choose Ubuntu install
+2. Follow instruction for Linux above
+
+Access:
+--------------------------
+Run program   kamishibai
+Open browser and type  http://127.0.0.1:9999
+Default username and password is admin/admin, please change it for security purpose.
+
+Configuration:
+--------------------------
+Config file is written in JSON format. The config file will be located at ~/etc/kamishibai.conf. The config file can also manually selected by appending the config path after the program.  
+
+There is also web configuration panel, goto http://host_ip:host_port/config to configure.
+
+
+  
+Start:  
+--------------------------
+kamishibai [config_file.conf]
+  
+File Format:
+--------------------------
+Only CBZ is supported and it should be zero compressed zip file. This will reduce the burden on the system when reading as well as making the experience more responsive. The file name will determind how it will be organized by the program.
+
+File naming convention:
+--------------------------
+Ideally, the CBZ file name should be in such format.  
+  
+(genre|meta data) [Author] Book Title Volume|chapter|v|ch 1.  
+  
+For example  
+(Manga) [Yamada Taro] World of Sakura Volume 01.cbz  
+(一般コミック) [山田太郎] 桜の世界 第01巻.cbz  
+  
+  
+License:
+--------------------------
+BSD 3-clause
+Mac Ma gitmac at runbox.com (C) 2013-2018 Copyright

data/bin/kamishibai

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# License: refer to LICENSE file
+
+# making sure program runs in UTF-8 encoding in any environment
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+require 'rbconfig'
+require 'getoptlong'
+require 'json/ext' # load early to use good quality json library instead of crappy one
+
+opts = GetoptLong.new(
+	[ "--debug",   "-d", GetoptLong::NO_ARGUMENT ]
+)
+
+$debug = false
+opts.each do |opt, arg|
+	if opt == '--debug'
+		$debug = true
+	end
+end
+$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../lib' )
+
+
+
+
+require 'kamishibai/config'
+
+# load config file, auto create if it doesn't exists
+if ARGV[0]
+	$settings = Kamishibai::Config.new( ARGV[0] )
+else
+	$settings = Kamishibai::Config.new
+end
+
+
+
+require 'kamishibai'
+
+# flag to restart the webserver if shutdown
+$RERUN = false
+
+at_exit do
+	if $RERUN
+		puts 'restarting...'
+		opt_d = $debug ? '--debug' : ''
+		
+		if RbConfig::CONFIG['host_os'] =~ /ming/
+			exe = "ruby #{__FILE__}"
+		else
+			exe = __FILE__
+		end
+		`#{exe} #{opt_d} "#{$KAMISHIBAI_CONFIG_PATH}"`
+	end
+end
+
+Kamishibai::Webserver.run!

data/changelogs.txt

@@ -0,0 +1,6 @@
+Change log:
+
+0.6.2
+Updated year for copyright
+Update documentation
+Add screenshots

data/kamishibai.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/kamishibai/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'kamishibai'
+  s.version     = Kamishibai::VERSION
+  s.description = "Remote manga reader. Read manga anywhere using a web browser."
+  s.summary     = s.description
+  s.authors     = ["Mac Ma"]
+  s.email       = 'gitmac@etneko.info'
+  s.homepage    = 'http://rubygems.org/gems/kamishibai'
+  s.license     = 'BSD 3-clause'
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = 'kamishibai'
+
+  s.add_dependency 'addressable', '>= 2.3.5'
+  s.add_dependency 'haml',      '>= 4.0.3'
+  s.add_dependency 'thin',      '>= 1.6.0'
+  s.add_dependency 'ffi',       '>= 1.9.0'
+  s.add_dependency 'gd2-ffij',  '>= 0.1.1'
+  s.add_dependency 'json',      '>= 1.7.7'
+  s.add_dependency 'rubyzip',   '>= 1.0.0'
+  s.add_dependency 'sinatra',   '>= 1.4.4'
+  s.add_dependency 'sinatra-reloader', '>= 1.0'
+  
+  s.require_paths = ['lib']
+  s.files = `git ls-files`.split($\)
+  s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+end

data/lib/kamishibai.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+# License: refer to LICENSE file
+
+require 'kamishibai/book'
+require 'kamishibai/functions'
+require 'kamishibai/database'
+require 'kamishibai/webserver'
+require 'kamishibai/workers'
+require 'kamishibai/patches'
+
+
+if $settings.srcs.length <= 0
+	puts "No directory source loaded, please configure at (user/pass is user/pass) http://127.0.0.1:#{$settings.port}/config"
+end	
+
+# function for initialize database
+def init_database(extra_dirs=[])
+	puts 'initializing database... this may take some time to run on first time...'
+
+	# load or create new db
+	$db = Kamishibai::Database.new( $settings.db_path, $settings.bookmarks_path )
+	
+	# add new files to db
+	$db.add_books( $settings.srcs )
+end
+
+# initialize whole database and bookmarks
+init_database
+
+# worker thread for saving bookmarks
+start_auto_save
+
+# worker thread for generating thumbnails
+start_auto_gen_thumbnail

data/lib/kamishibai/book.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+# License: refer to LICENSE file
+
+# book class
+module Kamishibai
+	module CBZFilename
+		def self.author(s)
+			parse(s)[0]
+		end
+
+		def self.title(s)
+			parse(s)[1]
+		end
+
+		def self.parse(s)
+			s = File.basename(s)
+			s.gsub!(/_/,' ')
+			s.gsub!(/　/u,' ')
+			s.gsub!(/\(.+?\)/,'')
+			author = s.scan(/\[(.+?)\]/)[0][0] if s.scan(/\[(.+?)\]/)[0] and s.scan(/\[(.+?)\]/)[0][0]
+			s.gsub!(/\[.+?\]/,'')
+			#s.gsub!(/ \S\d+.*/,'')
+			s.gsub!(/ \d{4}\S[\d\.]+.+/,'')
+			s.gsub!(/ (v|c|第)[\d\.]+.*/iu,'')
+			s.gsub!(/ vol.{0,2}[\d\.]+.*/i,'')
+			s.gsub!(/ (上|中|下)\.cbz/iu,'.cbz')
+			s.gsub!(/ \#[\d\.]+.*/i,'')
+			s.gsub!(/ ch.{0,2}[\d\.]+.*/i,'')
+			s.gsub!(/ +/,' ')
+			s.gsub!(/^ /,'')
+			s.gsub!(/\.cbz$/,'')
+			s.gsub!(/ $/,'')
+			s.gsub!(/ [\d\.]+$/,'')
+			title = s
+
+			[author, title]
+		end
+
+		private_class_method :parse
+	end
+		
+	class Book
+		attr_reader :bookcode, :title, :author, :fullpath, :mtime, :itime, :rtime, :size, :inode, :page, :pages, :fullpath_valid
+		attr_writer :bookcode, :title, :author,            :mtime, :itime, :rtime, :size, :inode, :page, :pages, :fullpath_valid
+
+		def initialize(bookcode=nil, fullpath=nil)
+			if bookcode and fullpath
+				@bookcode = bookcode
+				@fullpath = fullpath
+				if File.exists?( fullpath )
+					fs = File.stat( fullpath )
+					@mtime = fs.mtime.to_i
+
+					# mark the path as valid, aka book exists in path
+					@fullpath_valid = true
+				end
+
+				# create book title
+				title = File.basename( fullpath )
+				title.gsub!(/_/,' ')
+				title.gsub!(/　/u,' ')
+				title.gsub!(/\(.+?\)/,'')
+				@author = title.scan(/\[(.+?)\]/)[0][0] if title.scan(/\[(.+?)\]/)[0] and title.scan(/\[(.+?)\]/)[0][0]
+				title.gsub!(/\[.+?\]/,'')
+				#title.gsub!(/ \S\d+.*/,'')
+				title.gsub!(/ \d{4}\S[\d\.]+.+/,'')
+				title.gsub!(/ (v|c|第)[\d\.]+.*/iu,'')
+				title.gsub!(/ vol.{0,2}[\d\.]+.*/i,'')
+				title.gsub!(/ (上|中|下)\.cbz/iu,'.cbz')
+				title.gsub!(/ \#[\d\.]+.*/i,'')
+				title.gsub!(/ ch.{0,2}[\d\.]+.*/i,'')
+				title.gsub!(/ +/,' ')
+				title.gsub!(/^ /,'')
+				title.gsub!(/\.cbz$/,'')
+				title.gsub!(/ $/,'')
+				title.gsub!(/ [\d\.]+$/,'')
+				@title = title
+
+				@itime = Time.now.to_i
+				@pages = cbz_pages?( @fullpath )
+
+				unless @pages
+					puts "Book contain no images! #{fullpath}"
+				end
+			end
+		end
+
+		def fullpath=(newfullpath)
+			@fullpath = newfullpath
+
+			if File.exists?(newfullpath)
+				@fullpath_valid = true
+			end
+		end
+	end
+end

data/lib/kamishibai/config.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+# License: refer to LICENSE file
+
+require 'json'
+
+#
+# Handle global Kamishibal configuration
+#
+module Kamishibai
+	class Config
+		attr_reader :config_path, :srcs, :image_resize, :default_image_quality, :username, :password, :bind, :port, :db_path, :bookmarks_path, :cache_path, :new_book_days
+		attr_writer :config_path, :srcs, :image_resize, :default_image_quality, :username, :password, :bind, :port, :db_path, :bookmarks_path, :cache_path, :new_book_days
+
+		def initialize( path = '~/etc/kamishibai.conf' )
+			@config_path = File.expand_path( path )
+
+			if File.exists?( @config_path )
+				load
+			else
+				# settings template
+				@srcs = []
+				@image_resize = true
+				@default_image_quality = 60
+				@username = 'admin'
+				@password = 'admin'
+				@bind     = '0.0.0.0'
+				@port     = 9999
+
+				@db_path        = '~/var/kamishibai/db.json'
+				@bookmarks_path = '~/var/kamishibai/bookmarks.json'
+				@cache_path     = '~/var/kamishibai/cache/'
+
+				@new_book_days = 7
+
+				save_config
+			end
+		end
+
+		def save
+			unless FileTest.exists?( File.dirname( @config_path ) )
+				FileUtils.mkdir_p( File.dirname( @config_path ) )
+			end
+
+			t = {}
+			t[:srcs]         = @srcs.collect { |src| File.expand_path(src) }
+			t[:image_resize] = @image_resize
+			t[:default_image_quality] = @default_image_quality
+			t[:username] = @username
+			t[:password] = @password
+			t[:bind]     = @bind
+			t[:port]     = @port
+
+			t[:db_path]        = File.expand_path( @db_path )
+			t[:bookmarks_path] = File.expand_path( @bookmarks_path )
+			t[:cache_path]     = File.expand_path( @cache_path )
+
+			t[:new_book_days] = @new_book_days
+
+			File.binwrite( @config_path, JSON.pretty_generate( t ) )
+
+			puts "config created at #{@config_path}" if $debug
+		end
+
+		alias_method :save_config, :save
+		
+		private
+
+		# load settings from json config file
+		def load
+			json = JSON.parse( File.binread( @config_path ) )
+
+			@srcs         = json['srcs'].collect { |src| File.expand_path(src) }
+			@image_resize = json['image_resize']
+			@default_image_quality = json['default_image_quality']
+			@username = json['username']
+			@password = json['password']
+			@bind     = json['bind']
+			@port     = json['port']
+
+			@db_path         = File.expand_path( json['db_path'] )
+			@bookmarks_path  = File.expand_path( json['bookmarks_path'] )
+			@cache_path      = File.expand_path( json['cache_path'] )
+
+			@new_book_days   = json['new_book_days']
+
+			puts "config loaded at #{@config_path}" if $debug
+		end
+	end
+end