rbmediawiki 0.2.2 → 0.2.4

data/lib/rbmediawiki/page_generator.rb

@@ -0,0 +1,149 @@
+class Page_generator
+    def initialize(site)
+        @site = site
+    end
+
+    #gets pages alphabetically from a certain start point
+    # * from: starting point (Default starts from the beginning)
+    # * limit: pages to get per query (default: 500)
+    # * prefix: Only list titles that start with this value
+    # * namespace: The namespace to enumerate. By default, the main namespace will be enumerated
+    # * How to filter redirects
+    #   * all: List all pages regardless of their redirect flag (default)
+    #   * redirects: Only list redirects
+    #   * nonredirects: Don't list redirects
+    # * minsize: Only list pages that are at least this many bytes in size
+    # * maxsize: Only list pages that are at most this many bytes in size
+    # * prtype: Only list pages that have been protected from this type of action
+    #   * edit: Only list edit-protected pages
+    #   * move: Only list move-protected pages
+    # * prleve: Only list pages that have been protected at this level. Cannot be used without prtype
+    #   * autoconfirmed: Only autoconfirmed users can edit/move/whatever
+    #   * sysop: Only sysops can edit/move/whatever
+    #   * Empty: Everyone can edit/move/whatever
+    # * prfiltercascade: Filter protections based on cascadingness (ignored when apprtype isn't set) 
+    #   * One value: cascading, noncascading, all
+    #   * Default: all
+    # *filterlanglinks: Filter based on whether a page has langlinks
+    #   * One value: withlanglinks, withoutlanglinks, all
+    #   * Default: all
+    def all_pages(from = "!", limit = "500", prefix = nil, namespace = nil, filterredir = nil, minsize = nil, maxsize = nil, prtype = nil, prlevel = nil, prfiltercascade = nil, filterlanglinks = nil)
+        pages = Hash.new
+        count = 0
+        finish = false
+        while !finish
+            result = @site.query_list_allpages(nil, from, prefix, namespace, filterredir, minsize, maxsize, prtype, prlevel, prfiltercascade, limit, nil, filterlanglinks)
+            result['query']['allpages']['p'].each {|page|
+                yield Page.new(page['title'], @site)
+            }
+            if result.key?('query-continue') 
+                from = result['query-continue']['allpages']['apfrom']
+            else
+                finish = true
+            end
+        end
+    end
+
+    def linksearch(euquery, eulimit = 500, eunamespace = 0)
+        pages = Hash.new
+        count = 0
+        finish = false
+        euoffset = nil
+        while !finish
+            result = @site.query_list_exturlusage(nil, nil, euoffset, nil, euquery, eunamespace, eulimit)
+            result['query']['exturlusage']['eu'].each {|page|
+                yield Page.new(page['title'], @site)
+            }
+            if result.key?('query-continue') 
+                euoffset = result['query-continue']['exturlusage']['euoffset']
+            else
+                finish = true
+            end
+        end
+    end
+
+    #Returns pages where eititle is transcluded in.
+    #eilimit is the max results for query (default: 500)
+    #einamespace is the namespace to work in
+    def templateusage(eititle, eilimit = 500, einamespace = nil)
+        pages = Hash.new
+        finish = false
+        eioffset = nil
+        while !finish
+            result = @site.query_list_embeddedin(nil, eititle, eioffset, einamespace, nil, eilimit)
+            result['query']['embeddedin']['ei'].each {|page|
+                yield Page.new(page['title'], @site)
+            }
+            if result.key?('query-continue') 
+                eioffset = result['query-continue']['embeddedin']['eicontinue']
+            else
+                finish = true
+            end
+        end
+    end
+    def alllinks(alprefix, allimit = 500, alnamespace = nil)
+        pages = Hash.new
+        finish = false
+        aloffset = nil
+        while !finish
+            result = @site.query_list_alllinks(nil, aloffset, nil, alprefix, nil, nil, nil, alnamespace, allimit, nil, nil, true)
+            result['query']['alllinks']['l'].each {|page|
+                yield Page.new(page['title'], @site)
+            }
+            if result.key?('query-continue') 
+                euoffset = result['query-continue']['alllinks']['alcontinue']
+            else
+                finish = true
+            end
+        end
+    end
+    def backlinks(bltitle, bllimit = 500, blnamespace = nil, blfilterredir = nil)
+        pages = Hash.new
+        finish = false
+        bloffset = nil
+        while !finish
+            result = @site.query_list_backlinks(nil, bltitle, bloffset, blnamespace, blfilterredir, bllimit, true )
+            result['query']['backlinks']['bl'].each {|page|
+                if page.key?('redirect')
+                    page['redirlinks']['bl'].each {|page2|
+                        yield Page.new(page2['title'], @site)
+                    }
+                else
+                    yield Page.new(page['title'], @site)
+                end
+            }
+            if result.key?('query-continue') 
+                euoffset = result['query-continue']['backlinks']['blcontinue']
+            else
+                finish = true
+            end
+        end
+     
+    end
+
+    #TODO
+    #opensearch
+    #prop links
+    #prop langlinks?
+    #prop images
+    #prop templates
+    #prop categories
+    #prop extlinks
+    #list allimages
+    #list allcategories
+    #list allusers
+    #list blocks
+    #list categorymembers
+    #list deletedrevs
+    #list imageusage
+    #list logevents
+    #list recentchanges
+    #list search
+    #list usercontribs
+    #list watchlist
+    #list exturlusage
+    #list users
+    #list random
+    #list protectedtitles
+    #list globalblocks
+end

data/lib/rbmediawiki/user.rb

@@ -0,0 +1,111 @@
+#coding: utf-8
+
+class User
+    attr_reader :name
+    def initialize(name = nil, site = nil)
+        @username = name.gsub(" ","_")
+        @site = site
+    end
+
+    #blocks the user with the given reason
+    #the params are the usual block options
+    def block(expiry, reason, anononly = true, nocreate = true, autoblock = true, noemail = false, allowusertalk = true, reblock = false)
+        #require login
+        @site.login
+        result = @site.query_prop_info(@username, nil, 'block') 
+        token = result['query']['pages']['page']['blocktoken']
+        result = @site.block(@username, token, nil, expiry, reason, anononly, nocreate, autoblock, noemail, nil, allowusertalk, reblock)
+        if result.key?('error')
+            raise RbykimediaError, "#{@username}: "+result['error']['code']
+        else
+            return true
+        end
+    end
+
+    #unblocks the user
+    def unblock(reason)
+        #require login
+        @site.login
+        result = @site.query_prop_info(@username, nil, 'unblock') 
+        token = result['query']['pages']['page']['unblocktoken']
+        result = @site.unblock(nil, @username, token, nil, reason)
+        if result.key?('error')
+            raise RbykimediaError, "#{@username}: "+result['error']['code']
+        else
+            return true
+        end
+    end
+
+    #write a message in the user's talk page
+    def write_msg(msg, summary = nil)
+        page = Page.new("User talk:"+@username, @site)
+        return page.append(msg, summary, false)
+    end
+
+    #write an email to the user
+    def write_email(subject, text, ccme = nil)
+        #require login
+        @site.login
+        result = @site.query_prop_info(@username, nil, 'email') 
+        puts result
+        token = result['query']['pages']['page']['emailtoken']
+        result = @site.emailuser(@username, subject, text, token, ccme) 
+        if result.key?('error')
+            raise RbykimediaError, "#{@username}: "+result['error']['code']
+        else
+            return true
+        end
+    end
+
+    #info about the user
+    def info
+        result = @site.query_list_users(nil, "blockinfo|groups|editcount|registration|emailable", @username)
+        if result.key?('error')
+            raise RbykimediaError, "#{@username}: "+result['error']['code']
+        else
+            return result
+        end
+    end
+
+    #get user contributions
+    #returns false if there aren't any
+    def get_usercontribs(uclimit = 500, ucstart = nil, ucnamespace = nil)
+        uccontinue = nil
+        ucs = Hash.new
+        puts ucstart
+        loop {
+            result = @site.query_list_usercontribs(nil, uclimit, ucstart, nil, uccontinue, @username, nil, "newer", ucnamespace)
+            ucs.deep_merge!(result['query'])
+            if result.key?('query-continue')
+                ucstart = result['query-continue']['usercontribs']['ucstart']
+            else
+                break
+            end
+        }
+        if ucs['usercontribs'].key?('item')
+            return ucs['usercontribs']['item']
+        else 
+            return false
+        end
+    end
+
+    #rollbacks (reverts) all edits by the user since a given time.
+    #"since" is a timestamp. Default will rollback everything.
+    #"namespace", if set, restricts the rollback to the given namespace
+    def rollback(since = nil, namespace = nil)
+        contribs = get_usercontribs(nil, since, nil)
+        array_c = Array.new
+        puts array_c
+        contribs.each{|c| array_c.push(c['title'])}
+        array_c.uniq!
+        puts array_c
+        array_c.each{|p| 
+            page = Page.new(p, @site)
+            begin
+            page.rollback(@username, "desde aquí", false)
+            rescue RbykimediaError => error
+                puts error
+            end
+        }
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rbmediawiki
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors: 
 - Chabacano
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-23 00:00:00 +02:00
+date: 2009-05-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +25,8 @@ dependencies:
 description: Framework for developing bots and mediawiki tools in ruby.
 email: 
 - Chabacano@chabawiki.com
-executables: 
-- rbmediawiki
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
@@ -38,8 +38,14 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- bin/rbmediawiki
 - lib/rbmediawiki.rb
+- lib/rbmediawiki/api.rb
+- lib/rbmediawiki/category.rb
+- lib/rbmediawiki/config.yml
+- lib/rbmediawiki/misc_generator.rb
+- lib/rbmediawiki/page.rb
+- lib/rbmediawiki/page_generator.rb
+- lib/rbmediawiki/user.rb
 - test/test_rbmediawiki.rb
 has_rdoc: true
 homepage: http://rbmediawiki.rubyforge.com

data/bin/rbmediawiki

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-abort "you need to write me"