dokuwiki 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 063c8012a01a44893ac209de95730fc6c1791544a303790a789d208f0085cbc3
+  data.tar.gz: aa12c6b4182d2dbaf2f7cc14d6aed64260e138775ed9be7fd03098ed54632896
+SHA512:
+  metadata.gz: 3dd8743a3a31682f78d436ca2018602e175f49fe0f2365e7accdc4ab82a5de1cfcfe45235f1a3b803659821688ad4ace8dd9b8f6cae9615fff9a42db47de22cd
+  data.tar.gz: f3f401e9630ccc90c75e2a659e9fafe909a4a33ee69faf47fc1e230813c1c1f9e3ff75998f37fb6236fc1ba1dcec74815c63514209865993b635d06a15bc676d

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from: .rubocop_todo.yml
+
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBrackets.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBrackets: space, no_space
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: space
+  Exclude:
+    - 'dokuwiki.gemspec'
+
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceInsideParens:
+  EnforcedStyle: space
+
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBrackets.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBrackets: space, no_space
+Layout/SpaceInsideReferenceBrackets:
+  EnforcedStyle: space
+
+# URISchemes: http, https
+Metrics/LineLength:
+  Exclude:
+    - 'dokuwiki.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0 (2019-09-16)
+
+  - Initial Release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dokuwiki.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018-2019 Dirk Meyer
+
+MIT License
+
+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/README.md

@@ -0,0 +1,56 @@
+# DokuWiki
+
+The DokuWiki library is used for automating interaction with a DokuWiki Server.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'dokuwiki'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dokuwiki
+
+## Usage
+
+    ########################
+    # Example 1 Download
+    ########################
+
+    # Initialize and access the wiki at http://www.example.org/dokuwiki/
+    dokuwiki = DokuWiki::DokuWikiAccess.new( 'www.example.org', '/dokuwiki' )
+
+    # Login at specific Namespace
+    dokuwiki.login( 'dir:index', username, password )
+
+    # Download a specific Namespace
+    dokuwiki.save_wiki_path( 'dir:page' )
+
+    ########################
+    # Example 2 Upload
+    ########################
+
+    # Initialize and access the wiki at http://www.example.org/
+    dokuwiki = DokuWiki::DokuWikiAccess.new( 'www.example.org' )
+
+    # Login at specific Namespace
+    dokuwiki.login( 'dir:index', username, password )
+
+    # create the cache dir
+    dokuwiki.upload_dir = 'UPLOAD'
+    File.mkdir( dokuwiki.upload_dir )
+
+    # Upload a specific Namespace
+    dokuwiki.upload_file( 'dir:page', 'result.pdf' )
+
+### File formats
+
+The extensions decides the Format used.
+ '.wiki': Page in DokuWiki source
+ '.txt', '.css', '.jpg', '.png', 'pdf': MediaManager file.
+

data/lib/dokuwiki.rb

@@ -0,0 +1,268 @@
+#!/usr/local/bin/ruby -w
+
+# = dokuwiki.rb
+#
+# Author::    Dirk Meyer
+# Copyright:: Copyright (c) 2018 - 2019 Dirk Meyer
+# License::   Distributes under the same terms as Ruby
+#
+# == module DokuWiki
+#
+# Namespace for accessing DokuWiki
+#
+
+require 'rubygems'
+require 'http-cookie'
+require 'mechanize'
+require 'pp'
+
+# Module for accessing DokuWiki
+module DokuWiki
+  # === Class Functions
+  #
+  #   require 'dokuwiki"
+  #
+  #   DokuWiki.new( hostname, urlpath = nil )
+  #   DokuWiki.media_dir
+  #   DokuWiki.upload_dir
+  #   DokuWiki.wait_second
+  #   DokuWiki.namespace( wikipath )
+  #   DokuWiki.edit_url( wikipath )
+  #   DokuWiki.get( url )
+  #   DokuWiki.login( wikipath, user, pass )
+  #   DokuWiki.downloaded?( filename, buffer )
+  #   DokuWiki.file_put_contents( filename, line, mode = 'w+' )
+  #   DokuWiki.save_wiki_source( page, filename )
+  #   DokuWiki.save_wiki_body( filename, url )
+  #   DokuWiki.save_wiki_media( filename, url )
+  #   DokuWiki.save_wiki_path( wikipath )
+  #   DokuWiki.uploaded?( filename, buffer )
+  #   DokuWiki.save_uploaded( filename )
+  #   DokuWiki.upload_media_file?( wikipath, filename )
+  #   DokuWiki.upload_wiki_file( wikipath, filename )
+  #   DokuWiki.upload_file( wikipath, filename )
+  #
+  class DokuWikiAccess
+    # extension for files in dokuwiki syntax
+    EXTENSION = 'wiki'.freeze
+    # filename for cookie cache
+    COOKIES = 'cookies.txt'.freeze
+
+    # directory for media download cache
+    attr_accessor :media_dir
+    # directory for upload cache
+    attr_accessor :upload_dir
+
+    # define server location
+    def initialize( hostname, urlpath = nil )
+      @site = "https://#{hostname}"
+      @site << urlpath unless urlpath.nil?
+      @site.freeze
+      @dokuwiki_page_url = "#{@site}/doku.php?id=".freeze
+      @dokuwiki_css_url = "#{@site}/lib/exe/css.php?t=".freeze
+      @dokuwiki_media_url = "#{@site}/lib/exe/fetch.php?cache=&media=".freeze
+      @dokuwiki_media_upload_url = "#{@site}/lib/exe/ajax.php?" \
+        'tab_files=files&tab_details=view&do=media&ns='.freeze
+      @media_dir = nil
+      @upload_dir = nil
+      @lastpage = nil
+      @cookies = nil
+      @sectok = nil
+      @agent = nil
+    end
+
+    # be nice to the server
+    def wait_second
+      now = Time.now.to_i
+      # p [ 'wait_second', now, $lastpage ]
+      unless @lastpage.nil?
+        if now <= @lastpage + 2
+          sleep 2
+          now = Time.now.to_i
+        end
+      end
+      @lastpage = now
+    end
+
+    # convert path to namesape
+    def namespace( wikipath )
+      wikipath.gsub( ':', '%3A' ).freeze
+    end
+
+    # make edit url
+    def edit_url( wikipath )
+      "#{@dokuwiki_page_url}#{wikipath}&do=edit"
+    end
+
+    # make upload url
+    def upload_url( wikipath, filename )
+      namespace = namespace( wikipath )
+      url = "#{@dokuwiki_media_upload_url}#{namespace}&sectok=#{@sectok}"
+      url << '&mediaid=&call=mediaupload'
+      url << "&qqfile=#{filename}&ow=true"
+      url
+    end
+
+    # get url
+    def get( url )
+      p url
+      wait_second
+      @agent.get( url )
+    end
+
+    # login into DokuWiki at given path
+    def login( wikipath, user, pass )
+      Timeout.timeout( 300 ) do
+        @agent = Mechanize.new
+        @agent.agent.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        @agent.agent.http.reuse_ssl_sessions = false
+        # @agent.agent.http.ca_file = ca_path
+        if @cookies.nil?
+          url = @dokuwiki_page_url + wikipath
+          page = get( url )
+          # Submit the login form
+          wait_second
+          page = page.form_with( id: 'dw__login' ) do |f|
+            f.field_with( name: 'u' ).value = user
+            f.field_with( name: 'p' ).value = pass
+            f.checkbox_with( name: 'r' ).check
+          end.click_button
+          f = page.forms[ 1 ]
+          @sectok = f.field_with( name: 'sectok' ).value
+          @agent.cookie_jar.save( COOKIES )
+        else
+          @agent.cookie_jar.load( COOKIES )
+        end
+      end
+    end
+
+    # check if downloaded file has changed
+    def downloaded?( filename, buffer )
+      return false unless File.exist?( filename )
+
+      old = File.read( filename, encoding: buffer.encoding )
+      return true if buffer == old
+
+      false
+    end
+
+    # write buffer to file
+    def file_put_contents( filename, buffer, mode = 'w+' )
+      return if downloaded?( filename, buffer )
+
+      File.open( filename, mode ) do |f|
+        f.write( buffer )
+        f.close
+      end
+    end
+
+    # save wiki source to file
+    def save_wiki_source( page, filename )
+      f = page.form_with( id: 'dw__editform' )
+      wikitext = f.field_with( name: 'wikitext' ).value.delete( "\r" )
+      file_put_contents( filename, wikitext )
+      button = f.button_with( name: 'do[draftdel]' )
+      @agent.submit( f, button )
+    end
+
+    # save wiki body to file
+    def save_wiki_body( filename, url )
+      page = get( url )
+      file_put_contents( filename, page.body )
+    end
+
+    # save wiki media body to file
+    def save_wiki_media( filename, url )
+      path =
+        if @media_dir.nil?
+          filename
+        else
+          "#{MEDIA_DIR}/#{filename}"
+        end
+      save_wiki_body( path, url )
+    end
+
+    # save wiki path to file
+    def save_wiki_path( wikipath )
+      filename = wikipath.split( ':' ).last
+      case wikipath
+      when /[.]jpe?g$/, /[.]png$/, /[.]pdf$/
+        url = @dokuwiki_media_url + wikipath
+        save_wiki_media( filename, url )
+      when /[.]css$/
+        url = @dokuwiki_css_url + wikipath.sub( /[.]css$/, '' )
+        save_wiki_media( filename, url )
+      when /[.]html$/
+        url = @dokuwiki_page_url + wikipath.sub( /[.]html$/, '' )
+        save_wiki_body( filename, url )
+      else
+        url = edit_url( wikipath )
+        filename << ".#{EXTENSION}"
+        page = get( url )
+        save_wiki_source( page, filename )
+      end
+    end
+
+    # check if uploaded file has changed
+    def uploaded?( filename, buffer )
+      return false if @upload_dir.nil?
+
+      savedfile = "#{@upload_dir}/#{filename}"
+      return false unless File.exist?( savedfile )
+
+      old = File.read( savedfile, encoding: buffer.encoding )
+      return true if buffer == old
+
+      false
+    end
+
+    # save content to avoid useless edits
+    def save_uploaded( filename )
+      print system( "cp -pv '#{filename}' '#{@upload_dir}/'" )
+    end
+
+    # upload media file at path
+    def upload_media_file( wikipath, filename, raw )
+      p filename
+      headers = {
+        'Content-Type' => 'application/octet-stream',
+        'X-File-Name' => filename
+      }
+      url = upload_url( wikipath, filename )
+      p url
+      wait_second
+      pp @agent.post( url, raw, headers )
+      save_uploaded( filename )
+    end
+
+    # edit wiki source at path
+    def upload_wiki_file( wikipath, filename )
+      raw = File.read( filename ).gsub( "\n", "\r\n" )
+      basename = filename.sub( /[.]#{EXTENSION}$/, '' )
+      finalpath = "#{wikipath}:#{basename}"
+      page = get( edit_url( finalpath ) )
+      f = page.form_with( id: 'dw__editform' )
+      f.field_with( name: 'wikitext' ).value = raw
+      f.field_with( name: 'summary' ).value = 'automated by qscript'
+      button = f.button_with( name: 'do[save]' )
+      pp @agent.submit( f, button )
+      save_uploaded( filename )
+    end
+
+    # upload a file at given path
+    def upload_file( wikipath, filename )
+      p filename
+      raw = File.read( filename )
+      return if uploaded?( filename, raw )
+
+      case filename
+      when /[.]#{EXTENSION}$/
+        upload_wiki_file( wikipath, filename )
+      else
+        upload_media_file( wikipath, filename, raw )
+      end
+    end
+  end
+end
+
+# eof

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: dokuwiki
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Dirk Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+description: The DokuWiki library is used for automating interaction with a DokuWiki
+  server.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/dokuwiki.rb
+homepage: https://rubygems.org/gems/dokuwiki
+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.0.6
+signing_key: 
+specification_version: 4
+summary: access DokuWiki server
+test_files: []