Class: Protocol

Inherits:
Object
  • Object
show all
Includes:
Logging, REXML::StreamListener
Defined in:
lib/software_challenge_client/protocol.rb

Overview

This class handles communication to the server over the XML communication protocol. Messages from the server are parsed and moves are serialized and send back.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logging

#logger, logger

Constructor Details

#initialize(network, client) ⇒ Protocol

Returns a new instance of Protocol.



32
33
34
35
36
37
38
 
# File 'lib/software_challenge_client/protocol.rb', line 32

def initialize(network, client)
  @gamestate = GameState.new
  @network = network
  @client = client
  @context = {} # for saving context when stream-parsing the XML
  @client.gamestate = @gamestate
end

Instance Attribute Details

#client ⇒ ClientInterface (readonly)

Returns current client.

Returns:



30
31
32
 
# File 'lib/software_challenge_client/protocol.rb', line 30

def client
  @client
end

#gamestate ⇒ Gamestate (readonly)

Returns current gamestate.

Returns:

  • (Gamestate) —

    current gamestate



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

def gamestate
  @gamestate
end

#roomId ⇒ String

Returns current room id.

Returns:

  • (String) —

    current room id



27
28
29
 
# File 'lib/software_challenge_client/protocol.rb', line 27

def roomId
  @roomId
end

Instance Method Details

#move_to_xml(move) ⇒ Object

Converts a move to XML for sending to the server.

Parameters:

  • move (Move) —

    The move to convert to XML.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/software_challenge_client/protocol.rb', line 223

def move_to_xml(move)
  builder = Builder::XmlMarkup.new(indent: 2)
  # Converting every the move here instead of requiring the Move
  # class interface to supply a method which returns the XML
  # because XML-generation should be decoupled from internal data
  # structures.
  case move
  when SetMove
    builder.data(class: 'setmove') do |data|
      data.piece(owner: move.piece.owner.key, type: move.piece.type.key)
      d = move.destination
      data.destination(x: d.x, y: d.y, z: d.z)
      move.hints.each do |hint|
        data.hint(content: hint.content)
      end
    end
  when DragMove
    builder.data(class: 'dragmove') do |data|
      s = move.start
      data.start(x: s.x, y: s.y, z: s.z)
      d = move.destination
      data.destination(x: d.x, y: d.y, z: d.z)
      move.hints.each do |hint|
        data.hint(content: hint.content)
      end
    end
  when SkipMove
    builder.data(class: 'skipmove') do |data|
      move.hints.each do |hint|
        data.hint(content: hint.content)
      end
    end
  end
  builder.target!
end

#parsePlayer(attributes) ⇒ Player

Converts XML attributes for a Player to a new Player object

Parameters:

  • attributes (Hash) —

    Attributes for the new Player.

Returns:

  • (Player) —

    The created Player object.



192
193
194
195
196
197
 
# File 'lib/software_challenge_client/protocol.rb', line 192

def parsePlayer(attributes)
  Player.new(
    PlayerColor.find_by_key(attributes['color'].to_sym),
    attributes['displayName']
  )
end

#process_string(text) ⇒ Object

starts xml-string parsing

Parameters:

  • text (String) —

    the xml-string that will be parsed



43
44
45
46
47
48
49
50
51
 
# File 'lib/software_challenge_client/protocol.rb', line 43

def process_string(text)
  logger.debug "Parse XML:\n#{text}\n----END XML"
  begin
    REXML::Document.parse_stream(text, self)
  rescue REXML::ParseException => e
    # to parse incomplete xml, ignore missing end tag exceptions
    raise e unless e.message =~ /Missing end tag/
  end
end

#sendString(string) ⇒ Object

send a string

Parameters:

  • string (String) —

    The string that will be send to the connected server.



209
210
211
 
# File 'lib/software_challenge_client/protocol.rb', line 209

def sendString(string)
  @network.sendString("<room roomId=\"#{@roomId}\">#{string}</room>")
end

#sendXml(document) ⇒ Object

send a xml document

Parameters:

  • document (REXML::Document) —

    the document, that will be send to the connected server



202
203
204
 
# File 'lib/software_challenge_client/protocol.rb', line 202

def sendXml(document)
  @network.sendXML(document)
end

#snake_case_to_lower_camel_case(string) ⇒ Object

converts “this_snake_case” to “thisSnakeCase”



214
215
216
217
218
 
# File 'lib/software_challenge_client/protocol.rb', line 214

def snake_case_to_lower_camel_case(string)
  string.split('_').inject([]) do |result, e|
    result + [result.empty? ? e : e.capitalize]
  end.join
end

#tag_end(name) ⇒ Object

called if an end-tag is read

Parameters:

  • name (String) —

    the end-tag name, that was read



62
63
64
65
66
67
 
# File 'lib/software_challenge_client/protocol.rb', line 62

def tag_end(name)
  case name
  when 'board'
    logger.debug @gamestate.board.to_s
  end
end

#tag_start(name, attrs) ⇒ Object

called if a start tag is read Depending on the tag the gamestate is updated or the client will be asked for a move

Parameters:

  • name (String) —

    the start-tag, that was read

  • attrs (Dictionary<String, String>) —

    Attributes attached to the tag



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/software_challenge_client/protocol.rb', line 75

def tag_start(name, attrs)
  case name
  when 'room'
    @roomId = attrs['roomId']
    logger.info 'roomId : ' + @roomId
  when 'data'
    logger.debug "data(class) : #{attrs['class']}"
    @context[:data_class] = attrs['class']
    if attrs['class'] == 'sc.framework.plugins.protocol.MoveRequest'
      @client.gamestate = gamestate
      move = @client.move_requested
      sendString(move_to_xml(move))
    end
    if attrs['class'] == 'error'
      logger.info "Game ended - ERROR: #{attrs['message']}"
      @network.disconnect
    end
    if attrs['class'] == 'result'
      logger.info 'Got game result'
      @network.disconnect
      @gamestate.condition = Condition.new(nil, '')
    end
  when 'state'
    logger.debug 'new gamestate'
    @gamestate = GameState.new
    @gamestate.turn = attrs['turn'].to_i
    @gamestate.start_player_color = attrs['startPlayerColor'] == 'RED' ? PlayerColor::RED : PlayerColor::BLUE
    @gamestate.current_player_color = attrs['currentPlayerColor'] == 'RED' ? PlayerColor::RED : PlayerColor::BLUE
    logger.debug "Turn: #{@gamestate.turn}"
  when 'red'
    logger.debug 'new red player'
    player = parsePlayer(attrs)
    if player.color != PlayerColor::RED
      throw new IllegalArgumentException("expected #{PlayerColor::RED} Player but got #{player.color}")
    end
    @gamestate.add_player(player)
    @context[:player] = player
  when 'blue'
    logger.debug 'new blue player'
    player = parsePlayer(attrs)
    if player.color != PlayerColor::BLUE
      throw new IllegalArgumentException("expected #{PlayerColor::BLUE} Player but got #{player.color}")
    end
    @gamestate.add_player(player)
    @context[:player] = player
  when 'board'
    logger.debug 'new board'
    @gamestate.board = Board.new
  when 'field'
    x = attrs['x'].to_i
    y = attrs['y'].to_i
    obstructed = attrs['isObstructed'] == 'true'
    field = Field.new(x, y, [], obstructed)
    @gamestate.board.add_field(field)
    @context[:piece_target] = :field
    @context[:field] = field
  when 'piece'
    owner = PlayerColor.find_by_key(attrs['owner'].to_sym)
    type = PieceType.find_by_key(attrs['type'].to_sym)
    piece = Piece.new(owner, type)
    case @context[:piece_target]
    when :field
      @context[:field].add_piece(piece)
    when :undeployed_red_pieces
      @gamestate.undeployed_red_pieces << piece
    when :undeployed_blue_pieces
      @gamestate.undeployed_blue_pieces << piece
    when :last_move
      @context[:last_move_piece] = piece
    else
      raise "unknown piece target #{@context[:piece_target]}"
    end
  when 'undeployedRedPieces'
    @context[:piece_target] = :undeployed_red_pieces
    @gamestate.undeployed_red_pieces = []
  when 'undeployedBluePieces'
    @context[:piece_target] = :undeployed_blue_pieces
    @gamestate.undeployed_blue_pieces = []
  when 'lastMove'
    type = attrs['class']
    if type == 'skipmove'
      @gamestate.last_move = SkipMove.new
    else
      @context[:last_move_type] = type
      @context[:piece_target] = :last_move
    end
  when 'start'
    @context[:last_move_start] = CubeCoordinates.new(attrs['x'].to_i, attrs['y'].to_i, attrs['z'].to_i)
  when 'destination'
    destination = CubeCoordinates.new(attrs['x'].to_i, attrs['y'].to_i, attrs['z'].to_i)
    case @context[:last_move_type]
    when 'setmove'
      @gamestate.last_move = SetMove.new(@context[:last_move_piece], destination)
    when 'dragmove'
      @gamestate.last_move = SetMove.new(@context[:last_move_start], destination)
    end
  when 'winner'
  # TODO
    #winning_player = parsePlayer(attrs)
    #@gamestate.condition = Condition.new(winning_player, @gamestate.condition.reason)
  when 'score'
    # TODO
    # there are two score tags in the result, but reason attribute should be equal on both
    #@gamestate.condition = Condition.new(@gamestate.condition.winner, attrs['reason'])
  when 'left'
    logger.debug 'got left event, terminating'
    @network.disconnect
  when 'sc.protocol.responses.CloseConnection'
    logger.debug 'got left close connection event, terminating'
    @network.disconnect
  end
end

#text(text) ⇒ Object

called when text is encountered



55
56
57
 
# File 'lib/software_challenge_client/protocol.rb', line 55

def text(text)
  @context[:last_text] = text
end