Module: RWBUtilities

Includes:
RWBErrors
Included in:
RWikiBot
Defined in:
lib/utilities.rb

Instance Method Summary (collapse)

Instance Method Details

- (Boolean) is_redirect?(title)

Tests to see if a given page title is redirected to another page. Very Ruby.

Returns:

  • (Boolean) 


17
18
19
20
21
 
# File 'lib/utilities.rb', line 17

def is_redirect?(title)
  post_me = {'titles' => title, 'redirects'=>'', 'prop' => 'info'}
  result = make_request('query', post_me)
  (result['result'] == "Success") && result.has_key?("redirects")
end

- (Boolean) logged_in?

A quick (and public) method of checking whether or not we're logged in, since I don't want @config exposed

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/utilities.rb', line 24

def logged_in?
  @config['logged_in']
end

- (Object) make_request(action, post_this)

Make Request is a method that actually handles making the request to the API. Since the API is somewhat standardized, this method is able to accept the action and a hash of variables, and it handles all the fun things MediaWiki likes to be weird over, like cookies and limits and actions. Its very solid, but I didn't want it public because it also does some post processing, and that's not very OO.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/utilities.rb', line 63

def make_request (action, post_this)
  post_this['format'] = 'xml'
  post_this['action'] = action

  cookies = []
  if (@config['_session'])
    cookies << "#{@config['cookieprefix']}_session=#{@config['_session']}"
  end
  if (@config['logged_in'])
    cookies << "#{@config['cookieprefix']}UserName=#{@config['lgusername']}"
    cookies << "#{@config['cookieprefix']}UserID=#{@config['lguserid']}"
    cookies << "#{@config['cookieprefix']}Token=#{@config['lgtoken']}"
  end
  cookies = cookies.join("; ")

  headers =  {
    'User-agent'=>'bot-RWikiBot/2.0-rc1',
    'Cookie' => cookies
  }

  r = Hash.new
  until post_this.nil?
    return_result, post_this = raw_call(headers, post_this)
    unless return_result.has_key? action
      raise "No result found for action #{action.inspect} in result #{return_result.inspect}"
    end
    r.deep_merge(return_result.fetch(action))
  end

  r
end

- (Object) make_unique(array)

The point of this method is to iterate through an array of hashes, which most of the other methods return, and remove multiple instances of the same wiki page. We're more than often only concerned with the most recent revision, so we'll delete old ones.

Hashes don't respond to the the Array.uniq method. So this is the same-ish



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/utilities.rb', line 33

def make_unique(array)
  test_array = array
  count = 0

  array.reverse.each do |current_item|
    test_array.each do |test_item|
      if (current_item.fetch('title') == test_item.fetch('title') && current_item.fetch('revid') > test_item.fetch('revid') )
        # At this point, current is the same article as test, and current is newer. Delete test
        array.delete(test_item)
        count += 1
      end
    end
  end

  array
end

- (Object) meets_version_requirement(maj, min) 



6
7
8
9
10
11
12
13
14
 
# File 'lib/utilities.rb', line 6

def meets_version_requirement(maj, min)
  major, minor = @config['api_version'].to_s.split('.')
#    puts "#{major} > #{maj}"
  if ( major.to_i > maj.to_i ) || ( (major.to_i == maj.to_i) && (minor.to_i >= min.to_i) )
    return true
  else 
    return false
  end
end

- (Object) raw_call(headers, post_this)

Raw Call handles actually, physically talking to the wiki. It is broken out to handle query-continues where applicable. So, all the methods call make_request, and it calls raw_call until raw_call returns a nil post_this.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/utilities.rb', line 98

def raw_call(headers, post_this)
  request = Net::HTTP::Post.new(@config.fetch('uri').path, headers)
  request.set_form_data(post_this)
  net = Net::HTTP.new(@config.fetch('uri').host, @config.fetch('uri').port)
  net.use_ssl = (@config.fetch('uri').scheme == 'https')
  response = net.start { |http| http.request(request) }

  # Extra cookie handling. Because editing will be based on session IDs and it generates
  # a new one each time until you start responding. I doubt this will change.
  cookie = response.header['set-cookie']
  if (cookie != nil)
    if cookie =~ /(\w+)_session=([\d\w]+);/
      @config['cookieprefix'] = $1
      @config['_session'] = $2
    end
  end

  return_result = XmlSimple.xml_in(response.body, { 'ForceArray' => false })

  if return_result.has_key?('error')
    raise RWikiBotError, "#{return_result.fetch('error').fetch('code').capitalize}: #{return_result.fetch('error').fetch('info')}"
  end

  if !post_this.keys.any?{|k| k.include?('limit')} && return_result.has_key?('query-continue')
    return_result.fetch('query-continue').each do |key, value|
      return_result.fetch('query-continue').fetch(key).each do |x,y|
        post_this[x] = y
      end
    end
  else
    post_this = nil
  end

  [return_result, post_this]
end

- (Object) version

This method will return the version of the MediaWiki server. This is done by parsing the version number from the generator attribute of the the site_info method. Useful? Yes

  • maybe yout bot is only compatible with MediaWiki 1.9.0 depending on what methods you

use. I like it, anwyay.



54
55
56
 
# File 'lib/utilities.rb', line 54

def version
  site_info.fetch('generator').split(' ')[1]
end