gameServer/HWProtoCore.hs
author unc0rr
Mon, 28 Dec 2015 21:21:02 +0300
changeset 11465 0ae2e4c13bd1
parent 11054 6e575b29881c
child 11466 4b5c7a5c49fd
permissions -rw-r--r--
Allow toggling registration requirement on live server
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10460
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
     1
{-
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
     2
 * Hedgewars, a free turn based strategy game
11046
47a8c19ecb60 more copyright fixes
sheepluva
parents: 11033
diff changeset
     3
 * Copyright (c) 2004-2015 Andrey Korotaev <unC0Rr@gmail.com>
10460
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
     4
 *
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
     6
 * it under the terms of the GNU General Public License as published by
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
     7
 * the Free Software Foundation; version 2 of the License
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
     8
 *
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    12
 * GNU General Public License for more details.
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    13
 *
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    14
 * You should have received a copy of the GNU General Public License
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    15
 * along with this program; if not, write to the Free Software
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    16
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    17
 \-}
8dcea9087d75 Added copyrights to gameServer directory
Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
parents: 10212
diff changeset
    18
4295
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
    19
{-# LANGUAGE OverloadedStrings #-}
1804
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    20
module HWProtoCore where
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    21
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
    22
import Control.Monad.Reader
4295
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
    23
import Data.Maybe
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
    24
import qualified Data.ByteString.Char8 as B
1804
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    25
--------------------------------------
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    26
import CoreTypes
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    27
import HWProtoNEState
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    28
import HWProtoLobbyState
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    29
import HWProtoInRoomState
8479
8d71109b04d2 Some work on loading replay and interaction with checker
unc0rr
parents: 8478
diff changeset
    30
import HWProtoChecker
4295
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
    31
import HandlerUtils
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
    32
import RoomsAndClients
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
    33
import Utils
1804
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    34
4989
4771fed9272e - Write server config into .ini file on change
unc0rr
parents: 4975
diff changeset
    35
handleCmd, handleCmd_loggedin :: CmdHandler
1804
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    36
4295
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
    37
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
    38
handleCmd ["PING"] = answerClient ["PONG"]
1804
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    39
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    40
4295
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
    41
handleCmd ("QUIT" : xs) = return [ByeClient msg]
2867
9be6693c78cb - Unbreak support for client versions prior to 0.9.13-dev
unc0rr
parents: 2706
diff changeset
    42
    where
8401
87410ae372f6 Server messages localization using Qt's l10n subsystem:
unc0rr
parents: 8396
diff changeset
    43
        msg = if not $ null xs then head xs else loc "bye"
1804
4e78ad846fb6 New game server:
unc0rr
parents:
diff changeset
    44
4568
f85243bf890e Ok. This should pull 0.9.14.1 server into default
nemo
parents: 4337
diff changeset
    45
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
    46
handleCmd ["PONG"] = do
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
    47
    cl <- thisClient
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
    48
    if pingsQueue cl == 0 then
8897
d6c310c65c91 - Revert server workaround over desync from r98e2dbdda8c0
unc0rr
parents: 8547
diff changeset
    49
        return [ProtocolError "Protocol violation"]
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
    50
        else
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
    51
        return [ModifyClient (\c -> c{pingsQueue = pingsQueue c - 1})]
4568
f85243bf890e Ok. This should pull 0.9.14.1 server into default
nemo
parents: 4337
diff changeset
    52
11054
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    53
handleCmd cmd = do
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    54
    (ci, irnc) <- ask
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    55
    let cl = irnc `client` ci
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    56
    if logonPassed cl then
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    57
        if isChecker cl then
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    58
            handleCmd_checker cmd
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    59
            else
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    60
            handleCmd_loggedin cmd
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    61
        else
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    62
        handleCmd_NotEntered cmd
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    63
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    64
6e575b29881c Check for CMD message a bit further down the control flow
unc0rr
parents: 11046
diff changeset
    65
handleCmd_loggedin ["CMD", parameters] = uncurry h $ extractParameters parameters
8396
5123eac2f9d6 - Pass unknown chat commands to server
unc0rr
parents: 7766
diff changeset
    66
    where
9105
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    67
        h "DELEGATE" n | not $ B.null n = handleCmd ["DELEGATE", n]
10195
d1c23bb73346 - Room save/load into/from file
unc0rr
parents: 10194
diff changeset
    68
        h "SAVEROOM" n | not $ B.null n = handleCmd ["SAVEROOM", n]
d1c23bb73346 - Room save/load into/from file
unc0rr
parents: 10194
diff changeset
    69
        h "LOADROOM" n | not $ B.null n = handleCmd ["LOADROOM", n]
10194
7025bd3c3131 Allow to save and delete room config in room
unc0rr
parents: 10061
diff changeset
    70
        h "SAVE" n | not $ B.null n = handleCmd ["SAVE", n]
7025bd3c3131 Allow to save and delete room config in room
unc0rr
parents: 10061
diff changeset
    71
        h "DELETE" n | not $ B.null n = handleCmd ["DELETE", n]
9105
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    72
        h "STATS" _ = handleCmd ["STATS"]
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    73
        h "PART" m | not $ B.null m = handleCmd ["PART", m]
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    74
                   | otherwise = handleCmd ["PART"]
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    75
        h "QUIT" m | not $ B.null m = handleCmd ["QUIT", m]
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    76
                   | otherwise = handleCmd ["QUIT"]
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    77
        h "RND" p = handleCmd ("RND" : B.words p)
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    78
        h "GLOBAL" p = do
9035
e84d42a4311c '/rnd' command. Pass it a (possibly empty) list of items.
unc0rr
parents: 9034
diff changeset
    79
            cl <- thisClient
8547
6898be8aa261 Global notice with /global command. Can now warn users when doing server restart.
unc0rr
parents: 8519
diff changeset
    80
            rnc <- liftM snd ask
6898be8aa261 Global notice with /global command. Can now warn users when doing server restart.
unc0rr
parents: 8519
diff changeset
    81
            let chans = map (sendChan . client rnc) $ allClients rnc
9105
18ebb59c89fe Proper parameters handling of chat commands
unc0rr
parents: 9061
diff changeset
    82
            return [AnswerClients chans ["CHAT", "[global notice]", p] | isAdministrator cl]
9448
04e0acfa7c2c /watch works in testing environment
unc0rr
parents: 9446
diff changeset
    83
        h "WATCH" f = return [QueryReplay f]
9753
9579596cf471 - Special rooms which stay even when last player quits. Not useful for now, and can't be removed at all.
unc0rr
parents: 9448
diff changeset
    84
        h "FIX" _ = handleCmd ["FIX"]
9770
5706b637bae2 - Restrict game config changes in special rooms
unc0rr
parents: 9753
diff changeset
    85
        h "UNFIX" _ = handleCmd ["UNFIX"]
10882
ed7717f659ae - Fix ping timeouts after incorrect "/vote" commands (protocol violation)
unc0rr
parents: 10881
diff changeset
    86
        h "GREETING" msg | not $ B.null msg = handleCmd ["GREETING", msg]
10039
58cf89284115 Halfplement voting
unc0rr
parents: 9787
diff changeset
    87
        h "CALLVOTE" msg | B.null msg = handleCmd ["CALLVOTE"]
58cf89284115 Halfplement voting
unc0rr
parents: 9787
diff changeset
    88
                         | otherwise = let (c, p) = extractParameters msg in
58cf89284115 Halfplement voting
unc0rr
parents: 9787
diff changeset
    89
                                           if B.null p then handleCmd ["CALLVOTE", c] else handleCmd ["CALLVOTE", c, p]
10882
ed7717f659ae - Fix ping timeouts after incorrect "/vote" commands (protocol violation)
unc0rr
parents: 10881
diff changeset
    90
        h "VOTE" msg | not $ B.null msg = handleCmd ["VOTE", upperCase msg]
ed7717f659ae - Fix ping timeouts after incorrect "/vote" commands (protocol violation)
unc0rr
parents: 10881
diff changeset
    91
        h "FORCE" msg | not $ B.null msg = handleCmd ["VOTE", upperCase msg, "FORCE"]
ed7717f659ae - Fix ping timeouts after incorrect "/vote" commands (protocol violation)
unc0rr
parents: 10881
diff changeset
    92
        h "MAXTEAMS" n | not $ B.null n = handleCmd ["MAXTEAMS", n]
ed7717f659ae - Fix ping timeouts after incorrect "/vote" commands (protocol violation)
unc0rr
parents: 10881
diff changeset
    93
        h "INFO" n | not $ B.null n = handleCmd ["INFO", n]
11033
2a5520837036 Make RESTART_SERVER invokable
unc0rr
parents: 10882
diff changeset
    94
        h "RESTART_SERVER" "YES" = handleCmd ["RESTART_SERVER"]
11465
0ae2e4c13bd1 Allow toggling registration requirement on live server
unc0rr
parents: 11054
diff changeset
    95
        h "REGISTERED_ONLY" _ = do
0ae2e4c13bd1 Allow toggling registration requirement on live server
unc0rr
parents: 11054
diff changeset
    96
            cl <- thisClient
0ae2e4c13bd1 Allow toggling registration requirement on live server
unc0rr
parents: 11054
diff changeset
    97
            return [ModifyServerInfo(\s -> s{isRegisteredUsersOnly = not $ isRegisteredUsersOnly s})
0ae2e4c13bd1 Allow toggling registration requirement on live server
unc0rr
parents: 11054
diff changeset
    98
                , AnswerClients [sendChan cl] ["CHAT", "[server]", "'Registered only' state toggled"]
0ae2e4c13bd1 Allow toggling registration requirement on live server
unc0rr
parents: 11054
diff changeset
    99
                ]
10195
d1c23bb73346 - Room save/load into/from file
unc0rr
parents: 10194
diff changeset
   100
        h c p = return [Warning $ B.concat ["Unknown cmd: /", c, " ", p]]
8396
5123eac2f9d6 - Pass unknown chat commands to server
unc0rr
parents: 7766
diff changeset
   101
10039
58cf89284115 Halfplement voting
unc0rr
parents: 9787
diff changeset
   102
        extractParameters p = let (a, b) = B.break (== ' ') p in (upperCase a, B.dropWhile (== ' ') b)
58cf89284115 Halfplement voting
unc0rr
parents: 9787
diff changeset
   103
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   104
handleCmd_loggedin ["INFO", asknick] = do
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   105
    (_, rnc) <- ask
4614
26661bf28dd5 Reimplement some more protocol commands
unc0rr
parents: 4612
diff changeset
   106
    maybeClientId <- clientByNick asknick
5060
7d0f6e5b1c1c Hide last two octets of IP address from usual users
unc0rr
parents: 5030
diff changeset
   107
    isAdminAsking <- liftM isAdministrator thisClient
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   108
    let noSuchClient = isNothing maybeClientId
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   109
    let clientId = fromJust maybeClientId
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   110
    let cl = rnc `client` fromJust maybeClientId
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   111
    let roomId = clientRoom rnc clientId
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   112
    let clRoom = room rnc roomId
9061
38e8787483db '@' for server admin status, '+' for room admins
unc0rr
parents: 9035
diff changeset
   113
    let roomMasterSign = if isMaster cl then "+" else ""
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   114
    let adminSign = if isAdministrator cl then "@" else ""
9061
38e8787483db '@' for server admin status, '+' for room admins
unc0rr
parents: 9035
diff changeset
   115
    let rInfo = if roomId /= lobbyId then B.concat [adminSign, roomMasterSign, "room ", name clRoom] else adminSign `B.append` "lobby"
5996
2c72fe81dd37 Convert boolean variable + a bunch of fields which make sense only while game is going on into Maybe + structure
unc0rr
parents: 5060
diff changeset
   116
    let roomStatus = if isJust $ gameInfo clRoom then
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   117
            if teamsInGame cl > 0 then "(playing)" else "(spectating)"
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   118
            else
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   119
            ""
10061
b7161f00a6ca hide complete IP of other users, when non-admin requests player info. showing the first two parts of the IP was kinda pointless to begin with (what for?) and has recently lead to increased abuse and lobby flooding due to bots collecting/posting IP tracking information
sheepluva
parents: 10039
diff changeset
   120
    let hostStr = if isAdminAsking then host cl else B.empty
2867
9be6693c78cb - Unbreak support for client versions prior to 0.9.13-dev
unc0rr
parents: 2706
diff changeset
   121
    if noSuchClient then
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   122
        return []
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   123
        else
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   124
        answerClient [
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   125
            "INFO",
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   126
            nick cl,
5060
7d0f6e5b1c1c Hide last two octets of IP address from usual users
unc0rr
parents: 5030
diff changeset
   127
            B.concat ["[", hostStr, "]"],
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   128
            protoNumber2ver $ clientProto cl,
7766
98edc0724a28 Fix most of server warnings
unc0rr
parents: 5996
diff changeset
   129
            B.concat ["[", rInfo, "]", roomStatus]
4612
e82758d6f924 - Reactivate pings timer, reimplement PING handler
unc0rr
parents: 4337
diff changeset
   130
            ]
1862
7f303aa066da Implement kick from server by administrator
unc0rr
parents: 1841
diff changeset
   131
7f303aa066da Implement kick from server by administrator
unc0rr
parents: 1841
diff changeset
   132
4295
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
   133
handleCmd_loggedin cmd = do
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
   134
    (ci, rnc) <- ask
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
   135
    if clientRoom rnc ci == lobbyId then
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
   136
        handleCmd_lobby cmd
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
   137
        else
1f5604cd99be This revision should, in theory, correctly merge 0.9.14 and tip, so that future merges of 0.9.14 should work properly
nemo
parents: 4242
diff changeset
   138
        handleCmd_inRoom cmd