ruby-mediawiki 0.1

data/apps/localization_sync.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+=begin
+    This file is part of Ruby-MediaWiki.
+
+    Ruby-MediaWiki is free software: you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    Ruby-MediaWiki is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Ruby-MediaWiki.  If not, see
+    <http://www.gnu.org/licenses/>.
+=end
+
+
+# this bot expects a fully functional local pentabarf installation
+
+$:.unshift('../lib')
+
+require 'mediawiki/dotfile'
+require 'mediawiki/table'
+require 'momomoto/momomoto'
+require 'momomoto/tables'
+require 'momomoto/bot_login'
+
+class Localization_Sync
+
+  def initialize
+    @wiki = MediaWiki.dotfile
+
+    db_config = YAML.load_file('db_config.yml')['development']
+    Momomoto::Base.connect(db_config)
+    Momomoto::Bot_login.authorize('ui_tagger')
+
+    @lang = {}
+    Momomoto::Language.find({:f_localized=>'t'},nil,"lower(tag)").each do | l | @lang[l.tag] = l.language_id end
+
+    @@syncable = [
+                    ['Attachment_type', :attachment_type_id, :tag, Momomoto::Attachment_type, Momomoto::Attachment_type_localized],
+                    ['Conference_phase', :conference_phase_id, :tag, Momomoto::Conference_phase, Momomoto::Conference_phase_localized],
+                    ['Conflict', :conflict_id, :tag, Momomoto::Conflict, Momomoto::Conflict_localized],
+                    ['Conflict_level', :conflict_level_id, :tag, Momomoto::Conflict_level, Momomoto::Conflict_level_localized],
+                    ['Country', :country_id, :iso_3166_code, Momomoto::Country, Momomoto::Country_localized],
+                    ['Currency', :currency_id, :iso_4217_code, Momomoto::Currency, Momomoto::Currency_localized],
+                    ['Event_origin', :event_origin_id, :tag, Momomoto::Event_origin, Momomoto::Event_origin_localized],
+                    ['Event_role', :event_role_id, :tag, Momomoto::Event_role, Momomoto::Event_role_localized],
+                    ['Event_state', :event_state_id, :tag, Momomoto::Event_state, Momomoto::Event_state_localized],
+                    ['Event_type', :event_type_id, :tag, Momomoto::Event_type, Momomoto::Event_type_localized],
+                    ['Im_type', :im_type_id, :tag, Momomoto::Im_type, Momomoto::Im_type_localized],
+                    ['Language', :language_id, :iso_639_code, Momomoto::Language, Momomoto::Language_localized, :translated_id],
+                    ['Mime_type', :mime_type_id, :mime_type, Momomoto::Mime_type, Momomoto::Mime_type_localized],
+                    ['Phone_type', :phone_type_id, :tag, Momomoto::Phone_type, Momomoto::Phone_type_localized],
+                    ['Role', :role_id, :tag, Momomoto::Role, Momomoto::Role_localized],
+                    ['Transport', :transport_id, :tag, Momomoto::Transport, Momomoto::Transport_localized],
+                    ['Ui_message', :ui_message_id, :tag, Momomoto::Ui_message, Momomoto::Ui_message_localized]
+                 ]
+
+  end
+
+  # creates wiki pages from the data in the database
+  def update_wiki
+    @@syncable.each do | row |
+      make_table( *row )
+    end
+    page = @wiki.article('Localization', 1)
+    page.text = "=Localizable Tables=\n"
+    @@syncable.each do | row |
+      page.text += "*[[Localization/#{row[0]}|#{row[0]}]]\n"
+    end
+    page.submit('updating localization page')
+  end
+
+  # reads wiki pages and updates the database according to the data in the wiki
+  def update_database
+    @@syncable.each do | row |
+      read_table( *row )
+    end
+  end
+
+  def read_table(table, tag_id, tag_name, tag_class, local_class, lang_id = :language_id)
+    page = @wiki.article("Localization/#{table}")
+    return if page.text == ''
+    t = MediaWiki::Table.parse( page.text )
+    header = t.shift
+    header.shift
+
+    local_class.new.begin
+
+    t.each do | row |
+      header.each_with_index do | lang_tag, index |
+        cur_tag = tag_class.find({tag_name=>row[0]})
+        next unless cur_tag.length == 1
+        cur_loc = local_class.find({lang_id=>@lang[header[index]],tag_id=>cur_tag[tag_id]})
+        next if row[index + 1] == ''
+        unless cur_loc.length == 1
+          cur_loc.create
+          cur_loc[lang_id] = @lang[header[index]]
+          cur_loc[tag_id] = cur_tag[tag_id]
+        end
+        cur_loc[:name] = row[index + 1].strip
+        cur_loc.write
+      end
+    end
+
+    local_class.new.commit
+
+  end
+
+  def make_table(table, tag_id, tag_name, tag_class, local_class, lang_id = :language_id)
+    tags = {}
+    tag_class.find().each do | tc | tags[tc[tag_name]] = tc[tag_id] end
+    local = local_class.find({lang_id=>@lang.values})
+
+    page = @wiki.article("Localization/#{table}")
+
+    t = MediaWiki::Table.new
+    t.style = 'border="1" cellspacing="0" cellpadding="3" style="border-collapse: collapse;"'
+    t.header_style = 'bgcolor="lightblue"'
+    t.header = ['']
+    @lang.each do | tag, id | t.header.push( tag ) end
+    tags.keys.sort.each do | tag |
+      row = [tag]
+      @lang.each do | key, language_id |
+        row.push(local.find_by_value({tag_id=>tags[tag],lang_id=>language_id}) ? local.name : '')
+      end
+      t.data.push( row )
+    end
+
+    page.text = "[[Localization|<< Localization]]\n" + t.text + "\n[[Category:Localization]]"
+    page.submit("updating localization pages")
+  end
+
+end
+
+s = Localization_Sync.new
+s.update_database
+s.update_wiki
+

data/apps/rdoc_to_wiki.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+=begin
+    This file is part of Ruby-MediaWiki.
+
+    Ruby-MediaWiki is free software: you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    Ruby-MediaWiki is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Ruby-MediaWiki.  If not, see
+    <http://www.gnu.org/licenses/>.
+=end
+
+
+require 'yaml'
+require 'rdoc/ri/ri_reader'
+
+$:.unshift('../lib')
+require 'mediawiki/dotfile'
+
+
+def find(dir, &block)
+  Dir.foreach(dir) { |file|
+    next if file =~ /^\./
+
+    path = "#{dir}/#{file}"
+    if File.directory?(path)
+      find(path) { |f| yield f }
+    else
+      yield path
+    end
+  }
+end
+
+def wiki_format(flow)
+  s = ''
+  case flow
+    when Array
+      flow.each { |subflow|
+        s += wiki_format(subflow)
+      }
+    when SM::Flow::LIST
+      flow.contents.each { |subflow|
+        s += wiki_format(subflow)
+      }
+      s += "\n"
+    when SM::Flow::LI
+      if flow.label =~ /:$/
+        s += "; #{flow.label}\n: #{flow.body}\n"
+      elsif flow.label =~ /^[ \*]$/
+        s += "#{flow.label} #{flow.body}\n"
+      else
+        s += "* '''#{flow.label}:''' #{flow.body}\n"
+      end
+    when SM::Flow::P
+      s += "#{flow.body}\n\n"
+    else
+      puts "Unknown Flow: #{flow.inspect}"
+  end
+  s.gsub!(/&quot;/, '"')
+  s.gsub!(/<b>(.+?)<\/b>/, '\'\'\'\1\'\'\'')
+  s.gsub!(/<i>(.+?)<\/i>/, '\'\'\1\'\'')
+  s.gsub!(/<tt>(.+?)<\/tt>/, '<em>\1</em>')
+  s
+end
+
+
+classes = []
+methods = {}
+
+find("../rdoc-ri") { |file|
+  next unless file =~ /\.yaml$/
+  ri = YAML::load(File.new(file))
+  case ri
+    when RI::ClassDescription
+      classes << ri
+    when RI::MethodDescription
+      methods[ri.full_name] = ri
+    else
+      puts "Unknown Description: #{ri.inspect}"
+  end
+}
+
+classes.sort! { |a,b|
+  a.full_name <=> b.full_name
+}
+
+text = ''
+classes.each { |klass|
+  text += "==#{klass.full_name}==\n\n"
+  text += "Inherited from '''#{klass.superclass}'''\n\n" if klass.superclass
+  text += wiki_format(klass.comment || [])
+  klass.attributes.each { |attribute|
+    text += "===#{klass.full_name}##{attribute.name} (#{attribute.rw})===\n\n"
+    text += wiki_format(attribute.comment || [])
+    text += "\n"
+  }
+  klass.class_methods.each { |methodname|
+    method = methods["#{klass.full_name}::#{methodname.name}"]
+    text += "===#{method.full_name}#{method.params}===\n\n"
+    text += wiki_format(method.comment || [])
+    text += "\n"
+  }
+  klass.instance_methods.each { |methodname|
+    method = methods["#{klass.full_name}##{methodname.name}"]
+    text += "===#{method.full_name}#{method.params}===\n\n"
+    text += wiki_format(method.comment || [])
+    text += "\n"
+  }
+}
+
+if false # Dry run?
+  puts text
+  exit
+end
+
+wiki, conf = MediaWiki.dotfile('rdoc to wiki')
+article = wiki.article(conf['page'])
+article.text = "=#{conf['title']}=\n\n" + text
+article.submit("I can even document myself :-)")

data/apps/speed_metal_bot.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+=begin
+    This file is part of Ruby-MediaWiki.
+
+    Ruby-MediaWiki is free software: you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    Ruby-MediaWiki is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Ruby-MediaWiki.  If not, see
+    <http://www.gnu.org/licenses/>.
+=end
+
+
+$:.unshift('../lib')
+require 'mediawiki/dotfile'
+
+wiki, conf = MediaWiki.dotfile('speed metal bot')
+category_name = conf['category']
+user_prefix = conf['user prefix']
+template_name = conf['template']
+
+category = wiki.category(category_name)
+template = wiki.article("Template:#{template_name}")
+
+puts "Category #{category_name}: #{category.articles.inspect}"
+
+users = []
+projects = []
+category.articles.each { |name|
+  if name.index(user_prefix) and name.index('/').nil?
+    prefix, name = name.split(/:/, 2)
+    users << name
+  else
+    projects << name
+  end
+}
+
+### Construct template ###
+newtemplate = "<div align=\"center\" style=\"border: 1px solid black; clear: right;\">\n" +
+              "<div style=\"float: left; width: 64px; height: 64px;>[[Bild:Speed metal coding 64x64.jpg|left]]</div>\n" +
+              "<div style=\"margin-left: 70px; background-color: #e64200; font-size: large; height: 1.5em;\">'''Rübÿ Spëëd Mëtäl Cödïng'''</div>\n" +
+              "<div style=\"margin-left: 70px;\">'''Coders:''' "
+users.each_with_index { |user,i|
+  newtemplate += " | " if i > 0
+  newtemplate += "[[User:#{user}|#{user}]]"
+}
+
+newtemplate += "</div>\n" +
+               "<div style=\"margin-left: 70px;\">'''Projects:''' "
+projects.each_with_index { |project,i|
+  newtemplate += " | " if i > 0
+  newtemplate += "[[#{project}]]"
+}
+newtemplate += "<br/></div>\n" +
+               "</div>\n"
+
+### Submit template ###
+if template.text != newtemplate
+  template.text = newtemplate
+  template.submit("Speed metal bot run", true)
+end
+
+### Let template be used by all in category ###
+category.articles.each { |name|
+  article = wiki.article(name)
+  unless article.text.index("{{#{template_name}}}")
+    puts "#{article.name} is in category but doesn't use template"
+    article.text.gsub!(/\n+$/, '')
+    article.text += "\n\n\n\n{{#{template_name}}}"
+    article.submit("This page must use the #{template_name} template!!!111")
+  end
+}

data/apps/wikicat.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+=begin
+    This file is part of Ruby-MediaWiki.
+
+    Ruby-MediaWiki is free software: you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    Ruby-MediaWiki is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Ruby-MediaWiki.  If not, see
+    <http://www.gnu.org/licenses/>.
+=end
+
+
+$:.unshift('../lib')
+require 'mediawiki/dotfile'
+
+if ARGV.size != 1
+  puts "Usage: #{$0} <Article name>"
+  exit
+end
+
+wiki = MediaWiki.dotfile
+puts wiki.article(ARGV[0]).text

data/apps/wikipost.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+=begin
+    This file is part of Ruby-MediaWiki.
+
+    Ruby-MediaWiki is free software: you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    Ruby-MediaWiki is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Ruby-MediaWiki.  If not, see
+    <http://www.gnu.org/licenses/>.
+=end
+
+
+$:.unshift('../lib')
+require 'mediawiki/dotfile'
+
+if ARGV.size != 3
+  puts "Usage: #{$0} <Article name> <file> <comment>"
+  exit
+end
+
+wiki = MediaWiki.dotfile
+a = wiki.article(ARGV[0])
+a.text = File.new(ARGV[1]).readlines.to_s
+a.submit(ARGV[2])

data/lib/mediawiki.rb

@@ -0,0 +1,170 @@
+=begin
+    This file is part of Ruby-MediaWiki.
+
+    Ruby-MediaWiki is free software: you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    Ruby-MediaWiki is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Ruby-MediaWiki.  If not, see
+    <http://www.gnu.org/licenses/>.
+=end
+
+
+require 'uri'
+require 'logger'
+
+
+# Logger is required by article.rb
+module MediaWiki
+  def self.logger
+    if defined? @@logger
+      @@logger
+    else
+      @@logger = Logger.new(STDERR)
+    end
+  end
+end
+
+require 'mediawiki/article'
+require 'mediawiki/specialpage'
+require 'mediawiki/category'
+require 'mediawiki/minibrowser'
+
+##
+# =Ruby-MediaWiki - manipulate MediaWiki pages from Ruby.
+#
+# Please note that documents spit out by MediaWiki *must* be valid
+# XHTML (or XML)!
+#
+# You may not want to use MediaWiki::Wiki directly but let MediaWiki.dotfile
+# create your instance. This gives you the power of the dotfile
+# infrastructure. See sample apps and <tt>mediawikirc.sample</tt>.
+module MediaWiki
+  ##
+  # There's no need for any language attribute, the "Special:" prefix
+  # works in any MediaWiki, regardless of localization settings.
+  class Wiki
+    ##
+    # The MiniBrowser instance used by this Wiki.
+    # This must be readable as it's used by Article and Category
+    # to fetch themselves.
+    attr_reader :browser 
+    
+    ##
+    # The URL-Path to index.php (without index.php) as given 
+    # to Wiki#initialize
+    attr_reader :url
+    
+    ##
+    # Initialize a new Wiki instance.
+    # url:: [String] URL-Path to index.php (without index.php), may containt <tt>user:password</tt> combination.
+    # user:: [String] If not nil, log in with that MediaWiki username (see Wiki#login)
+    # password:: [String] If not nil, log in with that MediaWiki password (see Wiki#login)
+    # loglevel:: [Integer] Loglevel, default is to log all messages >= Logger::WARN = 2
+    def initialize(url, user = nil, password = nil, loglevel = Logger::WARN)
+      if ENV['MEDIAWIKI_DEBUG']
+        MediaWiki::logger.level = Logger::DEBUG
+      else 
+        MediaWiki::logger.level = loglevel
+      end
+      
+      @url = URI.parse( url.match(/\/$/) ? url : url + '/' )
+      @browser = MiniBrowser.new(@url)
+
+      login( user, password ) if user and password
+    end
+
+    ##
+    # Log in into MediaWiki
+    #
+    # This is *not* HTTP authentication
+    # (put HTTP-Auth into [url] of Wiki#initialize!)
+    # user:: [String] MediaWiki username
+    # password:: [String] MediaWiki password
+    #
+    # May raise an exception if cannot authenticate
+    def login( username, password )
+      data = {'wpName' => username, 'wpPassword' => password, 'wpLoginattempt' => 'Log in'}
+      data = @browser.post_content( @url.path + 'index.php?title=Special:Userlogin&action=submitlogin', data )
+      if data =~ /<p class='error'>/
+        raise "Unable to authenticate as #{username}"
+      end
+    end
+
+    ##
+    # Return a new Category instance with given name,
+    # will be constructed with [self] (for MiniBrowser usage)
+    # name:: [String] Category name (to be prepended with "Category:")
+    def category(name)
+      Category.new(self, name)
+    end
+
+    ##
+    # Return a new Article instance with given name,
+    # will be constructed with [self] (for MiniBrowser usage)
+    # name:: [String] Article name
+    # section:: [Fixnum] Optional section number
+    def article(name, section = nil)
+      Article.new(self, name, section)
+    end
+
+    ##
+    # Retrieve all namespaces and their IDs, which could be used for Wiki#allpages
+    # result:: [Hash] String => Fixnum
+    def namespace_ids
+      ids = {}
+      SpecialPage.new( self, 'Special:Allpages', nil, false ).xhtml.each_element('//select[@name=\'namespace\']/option') do | o |
+        ids[o.text] = o.attributes['value'].to_i
+      end
+      ids
+    end
+
+    ##
+    # Returns the pages listed on "Special:Allpages"
+    #
+    # TODO: Handle big wikis with chunked Special:Allpages
+    # namespace_id:: Optional namespace for article index (see Wiki#namespace_ids to retrieve id)
+    # result:: [Array] of [String] Articlenames
+    def allpages(namespace_id=nil)
+      # Dirty, but works
+      article_name = 'Special:Allpages'
+      article_name += "&namespace=#{namespace_id}" if namespace_id
+
+      pages = []
+      SpecialPage.new( self, article_name, nil, false ).xhtml.each_element('table[2]/tr/td/a') do | a |
+        pages.push( a.text )
+      end
+      pages
+    end
+
+    ##
+    # Construct the URL to a specific article
+    #
+    # Uses the [url] the Wiki instance was constructed with,
+    # appends "index.php", the name parameter and, optionally,
+    # the section.
+    #
+    # Often called by Article, Category, ...
+    # name:: [String] Article name
+    # section:: [Fixnum] Optional section number
+    def article_url(name, section = nil)
+      "#{@url.path}index.php?title=#{CGI::escape(name.gsub(' ', '_'))}#{section ? "&section=#{CGI::escape(section.to_s)}" : ''}"
+    end
+
+    def full_article_url(name, section=nil)
+      uri = @url.dup
+      uri.path, uri.query = article_url(name, section).split(/\?/, 2)
+      uri.to_s
+    end
+
+  end
+
+end
+