markita 1.0.210828

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a93274ab77ea3d606b0c0c696c73914786ee9baf0c7c880bdceec4cb1ae4cb6e
+  data.tar.gz: 7395b0d8d21fb98e929f5ca68548129fd6ccb713f8ef383504bbc59d0bd36436
+SHA512:
+  metadata.gz: 90097792167ea98b81bad5a4682d680c323ed23c7507b355c53c05127b4f1a7177fe04f5df68522d432d4b84fa623c0e620b2f3dfdab44a72e7f07d5b6740180
+  data.tar.gz: 41d9d9716c26f65dc41f183e6d0bbf3ba93bdfe00690ce60fd2282958165ba5074cb641125d9dedfcabed4347ace94fca09c591d1d7382c0390fe5f433b5d333

data/README.md

@@ -0,0 +1,159 @@
+# Markita
+
+* [VERSION 1.0.210828](https://github.com/carlosjhr64/markita/releases)
+* [github](https://www.github.com/carlosjhr64/markita)
+* [rubygems](https://rubygems.org/gems/markita)
+
+## DESCRIPTION
+
+A [Sinatra](http://sinatrarb.com) Markdown server.
+
+Uses [Kramdown](https://kramdown.gettalong.org/index.html) for the Markdown to
+HTML conversion.
+
+## INSTALL
+```shell
+$ gem install markita
+```
+## HELP
+```shell
+$ markita --help
+Usage:
+  markita [:options+]
+Options:
+  --root=DIRECTORY 	 ~/vimwiki
+  --bind=BIND      	 0.0.0.0
+  --port=PORT      	 8080
+  --allowed=IPS
+  --no_about
+  --no_favicon
+  --no_highlight
+  --no_login
+  --no_plugs
+Types:
+  DIRECTORY /^~?[\/\w\.]+$/
+  BIND      /^[\w\.]+$/
+  PORT      /^\d+$/
+  THEME     /^[\w\.]+$/
+  IPS       /^[\d\.\,]+$/
+# NOTE:
+# Assuming site is in ~/vimwiki,
+# when ~/vimwiki/.valid-id is set with a sha256sum of a password,
+# that password will restrict the site.
+# Allowed IPs bypass the need for site password
+# when the site is accessed from those locations.
+```
+## FEATURES
+
+* Check(Ballot) boxes for task lists
+* Image placement hints
+* One line forms
+* Template substitutions
+* ONLY SERVES MARKDOWN PAGES:`/**/*.md`(omit extension `.md` in the url)
+* ONLY SERVES PNG and GIF IMAGES: `/**/*.png`, and `/**/*.gif`
+* See [`lib/markita/plug`](lib/markita/plug) for examples of plugins
+
+Optionally:
+
+* Place your custom `/favicon.ico`
+* Place your custom `/highlight.css`
+* Place `/.cert.crt` and `/.pkey.pem` for SSL(https)
+* Place `sha256sum` of site's password in `/.valid-id`
+
+## HOW-TOs
+
+### Set site password:
+```shell
+$ # Assuming ~/vimwiki is your site's root...
+$ echo -n '<SitePasswordHere>' | sha256sum | grep -o '^\w*' > ~/vimwiki/.valid-id
+```
+### Set site custom favicon, css, not found page, and login form and fail page:
+```shell
+$ # Assuming ~/vimwiki is your site's root...
+$ # Note that you'll have to restart the server on any change to these:
+$ cp /path-to/custom/favicon.ico ~/vimwiki/favicon.ico
+$ cp /path-to/custom/highlight.css ~/vimwiki/highlight.css
+$ cp /path-to/custom/not_found.html ~/vimwiki/not_found.html
+$ cp /path-to/custom/login_form.html ~/vimwiki/login_form.html
+$ cp /path-to/custom/login_fail.html ~/vimwiki/login_fail.html
+```
+### Run site in https:
+```
+$ # Assuming ~/vimwiki is your site's root...
+$ openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout pkey.pem -out cert.crt
+$ # Stuff happens... Answer all the dumb questions... then:
+$ mv cert.crt ~/vimwiki/.cert.crt
+$ mv pkey.pem ~/vimwiki/.pkey.pem
+```
+### Allow localhost to bypass password:
+```shell
+$ # Assuming ~/vimwiki with a site password set...
+$ markita --allowed=127.0.0.1
+./bin/markita-1.0.210826
+== Sinatra (v2.1.0) has taken the stage on 8080 for development with backup from Thin
+```
+### Ballot boxes
+```txt
+- [ ] This is an emty ballot box
+- [x] This is a checked ballot box
+```
+### Image placement hints:
+```txt
+Left and right spaces of the alternate text of an image hints placement.
+The following image will be placed centered.
+
+![ Centered Image ](/img/image.png)
+
+![Left Floating ](/img/image.png)
+The above specified image will float left.
+
+![ Right Floating](/img/image.png)
+The above specified image will float right.
+```
+### One line forms
+```txt
+This will do a get method form:
+
+Google:[q](https://www.google.com/search)
+
+Due to the password field, this will do a post method form:
+
+Username:[user] Password:[*pwd](/login.html)
+```
+### Template substitutions
+```txt
+In the template string, uppercase keys are CGI escaped:
+
+<!-- template: "* [&query;](https://www.google.com/search?q=&QUERY;)" -->
+<!-- regx: /^\* (?<query>.*)$/ -->
+* Grumpy Cat
+* It's over 9000!
+
+The substitutions are active until the end of the block.
+If template is not provided, the line itself will be the template.
+```
+## LICENSE
+
+Copyright 2021 CarlosJHR64
+
+Permission is hereby granted, free of charge,
+to any person obtaining a copy of this software and
+associated documentation files (the "Software"),
+to deal in the Software without restriction,
+including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and
+to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS",
+WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
+THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/markita

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+require 'help_parser'
+require 'markita'
+
+OPTIONS = HelpParser[Markita::VERSION, <<HELP]
+Usage:
+  markita [:options+]
+Options:
+  --root=DIRECTORY \t ~/vimwiki
+  --bind=BIND      \t 0.0.0.0
+  --port=PORT      \t 8080
+  --allowed=IPS
+  --no_about
+  --no_favicon
+  --no_highlight
+  --no_login
+  --no_plugs
+Types:
+  DIRECTORY /^~?[\\/\\w\\.]+$/
+  BIND      /^[\\w\\.]+$/
+  PORT      /^\\d+$/
+  THEME     /^[\\w\\.]+$/
+  IPS       /^[\\d\\.\\,]+$/
+# NOTE:
+# Assuming site is in ~/vimwiki,
+# when ~/vimwiki/.valid-id is set with a sha256sum of a password,
+# that password will restrict the site.
+# Allowed IPs bypass the need for site password
+# when the site is accessed from those locations.
+HELP
+begin
+  Markita.run!
+rescue LoadError
+  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
+  exit 72
+rescue RuntimeError
+  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
+  exit 65
+rescue Exception
+  $stderr.puts $!.backtrace
+  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
+  exit 70
+end

data/data/highlight.css

@@ -0,0 +1,81 @@
+/* Ruby Gem Rouge's base16.light  */
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight, .highlight .w {
+  color: #303030;
+}
+.highlight .err {
+  color: #151515;
+  background-color: #ac4142;
+}
+.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs {
+  color: #505050;
+}
+.highlight .cp {
+  color: #f4bf75;
+}
+.highlight .nt {
+  color: #f4bf75;
+}
+.highlight .o, .highlight .ow {
+  color: #d0d0d0;
+}
+.highlight .p, .highlight .pi {
+  color: #d0d0d0;
+}
+.highlight .gi {
+  color: #90a959;
+}
+.highlight .gd {
+  color: #ac4142;
+}
+.highlight .gh {
+  color: #6a9fb5;
+  background-color: #151515;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {
+  color: #aa759f;
+}
+.highlight .kc {
+  color: #d28445;
+}
+.highlight .kt {
+  color: #d28445;
+}
+.highlight .kd {
+  color: #d28445;
+}
+.highlight .s, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {
+  color: #90a959;
+}
+.highlight .sa {
+  color: #aa759f;
+}
+.highlight .sr {
+  color: #75b5aa;
+}
+.highlight .si {
+  color: #8f5536;
+}
+.highlight .se {
+  color: #8f5536;
+}
+.highlight .nn {
+  color: #f4bf75;
+}
+.highlight .nc {
+  color: #f4bf75;
+}
+.highlight .no {
+  color: #f4bf75;
+}
+.highlight .na {
+  color: #6a9fb5;
+}
+.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {
+  color: #90a959;
+}
+.highlight .ss {
+  color: #90a959;
+}

data/data/login_failed.html

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html>
+<head><title>login</title></head>
+<body>
+<h1>Bad Password</h1>
+</body>
+</html>

data/data/login_form.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head><title>login</title></head>
+<body>
+<h1>Markita</h1>
+<form method="post">
+Password:<input type="password" name="id">
+</form>
+</body>
+</html>

data/data/not_found.html

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html>
+<head><title>error</title></head>
+<body>
+<h1>Not Found (404)</h1>
+</body>
+</html>

data/lib/markita/base.rb

@@ -0,0 +1,129 @@
+module Markita
+class Base < Sinatra::Base
+  set bind: OPTIONS&.bind || '0.0.0.0'
+  set port: OPTIONS&.port || '8080'
+  set sessions: true
+
+  def Base.run!
+    puts "#{$0}-#{VERSION}"
+    super do |server|
+      if ['.cert.crt', '.pkey.pem'].all?{ File.exist? File.join(ROOT, _1)}
+        server.ssl = true
+        server.ssl_options = {
+          :cert_chain_file  => File.join(ROOT, '.cert.crt'),
+          :private_key_file => File.join(ROOT, '.pkey.pem'),
+          :verify_peer      => false,
+        }
+      end
+    end
+  end
+
+  def Base.header(key)
+    <<-HEADER
+<!DOCTYPE html>
+<html>
+<head>
+  <title>#{key}</title>
+#{HEADER_LINKS}</head>
+<body>
+
+    HEADER
+  end
+
+  def Base.footer
+    <<-FOOTER
+
+</body>
+</html>
+    FOOTER
+  end
+
+  def Base.pre_process(text)
+    val,string,_ = {},'',nil
+    text.each_line do |line|
+      line.chomp!
+      case line
+      when ''
+        val.clear
+      when val[:regx]
+        # Template/Substitutions
+        line=_ if _=val[:template]
+        $~.named_captures.each do |name, value|
+          line = line.gsub("&#{name};", value)
+          line = line.gsub("&#{name.upcase};", CGI.escape(value))
+        end
+      when %r(^<!-- (.*) -->$)
+        directive = $1
+        case directive
+        when %r(^(\w+): "(.*)"$)
+          val[$1.to_sym] = $2
+        when %r(^(\w+): /(.*)/)
+          val[$1.to_sym] = Regexp.new $2
+        else
+          $stderr.puts "Unrecognized directive: "+directive
+        end
+        next
+      end
+      string << line << "\n"
+    end
+    return string
+  end
+
+  def Base.post_process(text)
+    string,_ = '',nil
+    text.each_line do |line|
+      line.chomp!
+      case line
+      when %r(^(\s*)<li>\[(x| )\] (.*)</li>$)
+        # Task Lists
+        s,x,item = $1,$2,$3
+        li = (x=='x')?
+          %q{<li style="list-style-type: '&#9745; '">} :
+          %q{<li style="list-style-type: '&#9744; '">}
+        line = s+li+item+"</li>"
+      when %r(^<p>(\w+:\[\*?\w+\] )+\((\S+)\)</p>$)
+        # One Line Forms
+        action,method,form = $2,'get',''
+        line.scan(/(\w+):\[(\*)?(\w+)\] /).each do |field, pwd, name|
+          type = (pwd)? 'password' : 'text'
+          method = 'post' if pwd
+          form << %Q{  #{field}:<input type="#{type}" name="#{name}">\n}
+        end
+        line = %Q(<form action="#{action}" method="#{method}">\n) +
+          form + %Q(  <input type="submit">\n</form>)
+      when %r(^<p><img (src="[^"]*" alt=" [^"]* ") /></p>$)
+        line = %Q(<img style="display: block; margin-left: auto; margin-right: auto;" #{$1} />)
+      when %r(^<p><img (src="[^"]*" alt=" [^"]*") />$)
+        line = %Q(<p><img style="float: left;" #{$1} />)
+      when %r(^<p><img (src="[^"]*" alt="[^"]* ") />$)
+        line = %Q(<p><img style="float: right;" #{$1} />)
+      end
+      string << line << "\n"
+    end
+    return string
+  end
+
+  def Base.page(key)
+    Base.header(key) + yield + Base.footer
+  end
+
+  get PAGE_KEY do |key|
+    filepath = File.join ROOT, key+'.md'
+    raise Sinatra::NotFound  unless File.exist? filepath
+    text = File.read(filepath).force_encoding('utf-8')
+    Base.page(key){ Base.post_process markdown Base.pre_process text}
+  end
+
+  get IMAGE_PATH do |path, *_|
+    send_file File.join(ROOT, path)
+  end
+
+  get '/' do
+    redirect '/index'
+  end
+
+  not_found do
+    NOT_FOUND
+  end
+end
+end

data/lib/markita/config.rb

@@ -0,0 +1,18 @@
+module Markita
+  OPTIONS ||= nil
+
+  HEADER_LINKS = ''
+
+  ROOT = File.expand_path OPTIONS&.root || '~/vimwiki'
+  raise "Missing site root directory: "+ROOT  unless File.directory? ROOT
+  APPDATA = File.join File.dirname(File.dirname __dir__), 'data'
+  PATH = lambda do |basename|
+    [ROOT, APPDATA].map{ File.join _1, basename}.detect{ File.exist? _1}
+  end
+  NOT_FOUND = File.read PATH['not_found.html']
+
+  PAGE_KEY   = %r{/(\w[\w\/\-]*\w)}
+  IMAGE_PATH = %r{/(\w[\w\/\-]*\w\.((png)|(gif)))}
+
+  START_TIME = Time.now
+end

data/lib/markita/plug/about.rb

@@ -0,0 +1,31 @@
+module Markita
+class Base
+  module About
+    def self.page
+      text = <<~TEXT
+        # [Markita](https://github.com/carlosjhr64/markita)
+
+        * VERSION: #{VERSION}
+        * ROOT: #{ROOT.sub(%r{^/home/\w+/},'~/')}
+        * ARGV: #{ARGV.join(' ')}
+        * START_TIME: #{START_TIME}
+
+        ## Plug.html routes:
+
+      TEXT
+      Base.routes['GET'].each do |route|
+        path = route[0].to_s
+        next  unless %r{^/\w+\.html$}.match? path
+        basename = File.basename(path, '.*')
+        text << "* [#{basename}](#{path})\n"
+      end
+      text << "\n![Favicon](/favicon.ico)\n"  if defined? Favicon
+      text
+    end
+  end
+
+  get '/about.html' do
+    Base.page('about') { markdown About.page}
+  end
+end
+end

data/lib/markita/plug/favicon.rb

@@ -0,0 +1,13 @@
+module Markita
+class Base < Sinatra::Base
+  HEADER_LINKS << %Q(  <link rel="icon" type="image/x-icon" href="/favicon.ico">\n)
+  module Favicon
+    ICO = File.read PATH['favicon.ico']
+  end
+
+  get '/favicon.ico' do
+    headers 'Content-Type' => 'image/x-icon'
+    Favicon::ICO
+  end
+end
+end

data/lib/markita/plug/highlight.rb

@@ -0,0 +1,13 @@
+module Markita
+class Base < Sinatra::Base
+  HEADER_LINKS << %Q(  <link rel="stylesheet" href="/highlight.css" type="text/css">\n)
+  module Highlight
+    CSS = File.read PATH['highlight.css']
+  end
+
+  get '/highlight.css' do
+    headers 'Content-Type' => 'text/css'
+    Highlight::CSS
+  end
+end
+end

data/lib/markita/plug/login.rb

@@ -0,0 +1,37 @@
+module Markita
+class Base
+  module Login
+    ID = File.exist?(_=File.join(ROOT, '.valid-id')) ?
+         File.read(_).strip :
+         nil
+    IPS = (_=OPTIONS&.allowed)? _.split(',') : nil
+    if IPS and not ID
+      raise "Allowed ips without site password does not make sense."
+    end
+    FORM   = File.read PATH['login_form.html']
+    FAILED = File.read PATH['login_failed.html']
+  end
+
+  before do
+    unless Login::ID.nil? or Login::IPS&.include?(request.ip)
+      if id = params[:id]
+        session[:id] = Digest::SHA256.hexdigest id
+      end
+      if session[:id] == Login::ID
+        redirect '/' if request.path_info == '/login.html'
+      else
+        redirect '/login.html' unless request.path_info == '/login.html'
+      end
+    end
+    puts "#{request.ip} #{request.path_info}"
+  end
+
+  get '/login.html' do
+    Login::FORM
+  end
+
+  post '/login.html' do
+    Login::FAILED
+  end
+end
+end

data/lib/markita/plug/plugs.rb

@@ -0,0 +1 @@
+Dir.glob(File.join Markita::ROOT, 'plug', '*.rb').each{ require _1}

data/lib/markita.rb

@@ -0,0 +1,24 @@
+module Markita
+  VERSION = '1.0.210828'
+
+  def self.run!
+    # Standard libraries
+    require 'digest'
+    require 'cgi'
+    # Gems
+    require 'sinatra/base'
+    require 'kramdown'
+    require 'thin'
+    Tilt.register Tilt::KramdownTemplate, 'md'
+    # Local
+    require_relative 'markita/config.rb'
+    require_relative 'markita/base.rb'
+    # Plugs
+    require_relative 'markita/plug/favicon.rb'    unless OPTIONS&.no_favicon
+    require_relative 'markita/plug/highlight.rb'  unless OPTIONS&.no_highlight
+    require_relative 'markita/plug/login.rb'      unless OPTIONS&.no_login
+    require_relative 'markita/plug/about.rb'      unless OPTIONS&.no_about
+    require_relative 'markita/plug/plugs.rb'      unless OPTIONS&.no_plugs
+    Base.run!
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: markita
+version: !ruby/object:Gem::Version
+  version: 1.0.210828
+platform: ruby
+authors:
+- CarlosJHR64
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: help_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.200907
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.200907
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: |
+  A [Sinatra](http://sinatrarb.com) Markdown server.
+
+  Uses [Kramdown](https://kramdown.gettalong.org/index.html) for the Markdown to
+  HTML conversion.
+email: carlosjhr64@gmail.com
+executables:
+- markita
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/markita
+- data/favicon.ico
+- data/highlight.css
+- data/login_failed.html
+- data/login_form.html
+- data/not_found.html
+- lib/markita.rb
+- lib/markita/base.rb
+- lib/markita/config.rb
+- lib/markita/plug/about.rb
+- lib/markita/plug/favicon.rb
+- lib/markita/plug/highlight.rb
+- lib/markita/plug/login.rb
+- lib/markita/plug/plugs.rb
+homepage: https://github.com/carlosjhr64/markita
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A [Sinatra](http://sinatrarb.com) Markdown server.
+test_files: []