From f45a6174bd973a321cf8da0293b59cb24c5097f7 Mon Sep 17 00:00:00 2001 From: Adam Mertzenich Date: Fri, 26 Jan 2024 23:38:29 -0600 Subject: [PATCH] Initial commit --- .gitignore | 13 ++ LICENSE | 280 +++++++++++++++++++++++++++++ README.org | 63 +++++++ project.clj | 7 + src/halo_query/core.clj | 388 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 751 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.org create mode 100644 project.clj create mode 100644 src/halo_query/core.clj diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d956ab0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +/target +/classes +/checkouts +profiles.clj +pom.xml +pom.xml.asc +*.jar +*.class +/.lein-* +/.nrepl-port +/.prepl-port +.hgignore +.hg/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2315126 --- /dev/null +++ b/LICENSE @@ -0,0 +1,280 @@ +Eclipse Public License - v 2.0 + + THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE + PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION + OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. + +1. DEFINITIONS + +"Contribution" means: + + a) in the case of the initial Contributor, the initial content + Distributed under this Agreement, and + + b) in the case of each subsequent Contributor: + i) changes to the Program, and + ii) additions to the Program; + where such changes and/or additions to the Program originate from + and are Distributed by that particular Contributor. A Contribution + "originates" from a Contributor if it was added to the Program by + such Contributor itself or anyone acting on such Contributor's behalf. + Contributions do not include changes or additions to the Program that + are not Modified Works. + +"Contributor" means any person or entity that Distributes the Program. + +"Licensed Patents" mean patent claims licensable by a Contributor which +are necessarily infringed by the use or sale of its Contribution alone +or when combined with the Program. + +"Program" means the Contributions Distributed in accordance with this +Agreement. + +"Recipient" means anyone who receives the Program under this Agreement +or any Secondary License (as applicable), including Contributors. + +"Derivative Works" shall mean any work, whether in Source Code or other +form, that is based on (or derived from) the Program and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. + +"Modified Works" shall mean any work in Source Code or other form that +results from an addition to, deletion from, or modification of the +contents of the Program, including, for purposes of clarity any new file +in Source Code form that contains any contents of the Program. Modified +Works shall not include works that contain only declarations, +interfaces, types, classes, structures, or files of the Program solely +in each case in order to link to, bind by name, or subclass the Program +or Modified Works thereof. + +"Distribute" means the acts of a) distributing or b) making available +in any manner that enables the transfer of a copy. + +"Source Code" means the form of a Program preferred for making +modifications, including but not limited to software source code, +documentation source, and configuration files. + +"Secondary License" means either the GNU General Public License, +Version 2.0, or any later versions of that license, including any +exceptions or additional permissions as identified by the initial +Contributor. + +2. GRANT OF RIGHTS + + a) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free copyright + license to reproduce, prepare Derivative Works of, publicly display, + publicly perform, Distribute and sublicense the Contribution of such + Contributor, if any, and such Derivative Works. + + b) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free patent + license under Licensed Patents to make, use, sell, offer to sell, + import and otherwise transfer the Contribution of such Contributor, + if any, in Source Code or other form. This patent license shall + apply to the combination of the Contribution and the Program if, at + the time the Contribution is added by the Contributor, such addition + of the Contribution causes such combination to be covered by the + Licensed Patents. The patent license shall not apply to any other + combinations which include the Contribution. No hardware per se is + licensed hereunder. + + c) Recipient understands that although each Contributor grants the + licenses to its Contributions set forth herein, no assurances are + provided by any Contributor that the Program does not infringe the + patent or other intellectual property rights of any other entity. + Each Contributor disclaims any liability to Recipient for claims + brought by any other entity based on infringement of intellectual + property rights or otherwise. As a condition to exercising the + rights and licenses granted hereunder, each Recipient hereby + assumes sole responsibility to secure any other intellectual + property rights needed, if any. For example, if a third party + patent license is required to allow Recipient to Distribute the + Program, it is Recipient's responsibility to acquire that license + before distributing the Program. + + d) Each Contributor represents that to its knowledge it has + sufficient copyright rights in its Contribution, if any, to grant + the copyright license set forth in this Agreement. + + e) Notwithstanding the terms of any Secondary License, no + Contributor makes additional grants to any Recipient (other than + those set forth in this Agreement) as a result of such Recipient's + receipt of the Program under the terms of a Secondary License + (if permitted under the terms of Section 3). + +3. REQUIREMENTS + +3.1 If a Contributor Distributes the Program in any form, then: + + a) the Program must also be made available as Source Code, in + accordance with section 3.2, and the Contributor must accompany + the Program with a statement that the Source Code for the Program + is available under this Agreement, and informs Recipients how to + obtain it in a reasonable manner on or through a medium customarily + used for software exchange; and + + b) the Contributor may Distribute the Program under a license + different than this Agreement, provided that such license: + i) effectively disclaims on behalf of all other Contributors all + warranties and conditions, express and implied, including + warranties or conditions of title and non-infringement, and + implied warranties or conditions of merchantability and fitness + for a particular purpose; + + ii) effectively excludes on behalf of all other Contributors all + liability for damages, including direct, indirect, special, + incidental and consequential damages, such as lost profits; + + iii) does not attempt to limit or alter the recipients' rights + in the Source Code under section 3.2; and + + iv) requires any subsequent distribution of the Program by any + party to be under a license that satisfies the requirements + of this section 3. + +3.2 When the Program is Distributed as Source Code: + + a) it must be made available under this Agreement, or if the + Program (i) is combined with other material in a separate file or + files made available under a Secondary License, and (ii) the initial + Contributor attached to the Source Code the notice described in + Exhibit A of this Agreement, then the Program may be made available + under the terms of such Secondary Licenses, and + + b) a copy of this Agreement must be included with each copy of + the Program. + +3.3 Contributors may not remove or alter any copyright, patent, +trademark, attribution notices, disclaimers of warranty, or limitations +of liability ("notices") contained within the Program from any copy of +the Program which they Distribute, provided that Contributors may add +their own appropriate notices. + +4. COMMERCIAL DISTRIBUTION + +Commercial distributors of software may accept certain responsibilities +with respect to end users, business partners and the like. While this +license is intended to facilitate the commercial use of the Program, +the Contributor who includes the Program in a commercial product +offering should do so in a manner which does not create potential +liability for other Contributors. Therefore, if a Contributor includes +the Program in a commercial product offering, such Contributor +("Commercial Contributor") hereby agrees to defend and indemnify every +other Contributor ("Indemnified Contributor") against any losses, +damages and costs (collectively "Losses") arising from claims, lawsuits +and other legal actions brought by a third party against the Indemnified +Contributor to the extent caused by the acts or omissions of such +Commercial Contributor in connection with its distribution of the Program +in a commercial product offering. The obligations in this section do not +apply to any claims or Losses relating to any actual or alleged +intellectual property infringement. In order to qualify, an Indemnified +Contributor must: a) promptly notify the Commercial Contributor in +writing of such claim, and b) allow the Commercial Contributor to control, +and cooperate with the Commercial Contributor in, the defense and any +related settlement negotiations. The Indemnified Contributor may +participate in any such claim at its own expense. + +For example, a Contributor might include the Program in a commercial +product offering, Product X. That Contributor is then a Commercial +Contributor. If that Commercial Contributor then makes performance +claims, or offers warranties related to Product X, those performance +claims and warranties are such Commercial Contributor's responsibility +alone. Under this section, the Commercial Contributor would have to +defend claims against the other Contributors related to those performance +claims and warranties, and if a court requires any other Contributor to +pay any damages as a result, the Commercial Contributor must pay +those damages. + +5. NO WARRANTY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" +BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR +IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF +TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR +PURPOSE. Each Recipient is solely responsible for determining the +appropriateness of using and distributing the Program and assumes all +risks associated with its exercise of rights under this Agreement, +including but not limited to the risks and costs of program errors, +compliance with applicable laws, damage to or loss of data, programs +or equipment, and unavailability or interruption of operations. + +6. DISCLAIMER OF LIABILITY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS +SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST +PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE +EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +7. GENERAL + +If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this Agreement, and without further +action by the parties hereto, such provision shall be reformed to the +minimum extent necessary to make such provision valid and enforceable. + +If Recipient institutes patent litigation against any entity +(including a cross-claim or counterclaim in a lawsuit) alleging that the +Program itself (excluding combinations of the Program with other software +or hardware) infringes such Recipient's patent(s), then such Recipient's +rights granted under Section 2(b) shall terminate as of the date such +litigation is filed. + +All Recipient's rights under this Agreement shall terminate if it +fails to comply with any of the material terms or conditions of this +Agreement and does not cure such failure in a reasonable period of +time after becoming aware of such noncompliance. If all Recipient's +rights under this Agreement terminate, Recipient agrees to cease use +and distribution of the Program as soon as reasonably practicable. +However, Recipient's obligations under this Agreement and any licenses +granted by Recipient relating to the Program shall continue and survive. + +Everyone is permitted to copy and distribute copies of this Agreement, +but in order to avoid inconsistency the Agreement is copyrighted and +may only be modified in the following manner. The Agreement Steward +reserves the right to publish new versions (including revisions) of +this Agreement from time to time. No one other than the Agreement +Steward has the right to modify this Agreement. The Eclipse Foundation +is the initial Agreement Steward. The Eclipse Foundation may assign the +responsibility to serve as the Agreement Steward to a suitable separate +entity. Each new version of the Agreement will be given a distinguishing +version number. The Program (including Contributions) may always be +Distributed subject to the version of the Agreement under which it was +received. In addition, after a new version of the Agreement is published, +Contributor may elect to Distribute the Program (including its +Contributions) under the new version. + +Except as expressly stated in Sections 2(a) and 2(b) above, Recipient +receives no rights or licenses to the intellectual property of any +Contributor under this Agreement, whether expressly, by implication, +estoppel or otherwise. All rights in the Program not expressly granted +under this Agreement are reserved. Nothing in this Agreement is intended +to be enforceable by any entity that is not a Contributor or Recipient. +No third-party beneficiary rights are created under this Agreement. + +Exhibit A - Form of Secondary Licenses Notice + +"This Source Code may also be made available under the following +Secondary Licenses when the conditions for such availability set forth +in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public +License as published by the Free Software Foundation, either version 2 +of the License, or (at your option) any later version, with the GNU +Classpath Exception which is available at +https://www.gnu.org/software/classpath/license.html." + + Simply including a copy of this Agreement, including this Exhibit A + is not sufficient to license the Source Code under Secondary Licenses. + + If it is not possible or desirable to put the notice in a particular + file, then You may include the notice in a location (such as a LICENSE + file in a relevant directory) where a recipient would be likely to + look for such a notice. + + You may add additional accurate notices of copyright ownership. diff --git a/README.org b/README.org new file mode 100644 index 0000000..453b4e9 --- /dev/null +++ b/README.org @@ -0,0 +1,63 @@ +* Halo Server Query + +A Clojure library designed to query Halo Custom Edition servers. + +* Usage + +#+begin_src clojure +(require '[halo-query.core :as halo]) + +(halo/query "216.128.147.196" 2302) +=> {:maxplayers 16, + :game_classic false, + :nextmode "", + :vehicle-flags + {:vehicle-respawn 60, :red-vehicle-set "Custom", :blue-vehicle-set "Default"}, + :password false, + :queryid "1.1", + :fraglimit 50, + :numplayers 1, + :gamemode "openplaying", + :hostname "Halo", + :sapp_flags "1", + :final "Sapp", + :gametype "Slayer", + :player-flags + {:friendly-fire-penalty 0, + :auto-team-balance false, + :invisible-players false, + :friend-indicators true, + :starting-equipment "Custom", + :infinite-grenades false, + :suicide-penalty 0, + :respawn-growth 0, + :respawn-time 0, + :friendly-fire "On", + :indicator "Motion Tracker", + :other-players-on-radar "All", + :maximum-health "100%", + :lives ##Inf, + :weapon-set "Normal", + :odd-man-out false, + :shields true}, + :gamevariant "Slayer", + :hostport 2302, + :teamplay false, + :game-flags + {:game-type "Slayer", + :death-bonus false, + :kill-penalty false, + :kill-in-order false}, + :mapname "bloodgulch", + :nextmap "", + :players [{:name "New001", :score 0, :ping 32, :team 0}], + :gamever "01.00.10.0621", + :dedicated true, + :sapp "10.1 RC1 CE"} +#+end_src + +* License + +Copyright © 2024 Adam Mertzenich + +Available under the terms of the Eclipse Public License 2.0, see `LICENSE`. diff --git a/project.clj b/project.clj new file mode 100644 index 0000000..e8a4362 --- /dev/null +++ b/project.clj @@ -0,0 +1,7 @@ +(defproject ch.mertzeni/halo-query "1.0.0-SNAPSHOT" + :description "Query Halo Custom Edition servers" + :url "https://github.com/Mertzenich/halo-query-clj" + :license {:name "EPL-2.0" + :url "https://www.eclipse.org/legal/epl-2.0/"} + :dependencies [[org.clojure/clojure "1.11.1"]] + :repl-options {:init-ns halo-query.core}) diff --git a/src/halo_query/core.clj b/src/halo_query/core.clj new file mode 100644 index 0000000..db25623 --- /dev/null +++ b/src/halo_query/core.clj @@ -0,0 +1,388 @@ +(ns halo-query.core + (:require [clojure.string :as str]) + (:import [java.net DatagramSocket DatagramPacket InetSocketAddress])) + +(def ^:private flags + "Flag string lookup table for decoding game and player flags" + {;; Player Flags + :lives [##Inf 1 3 5] + :maximum-health ["50%" "100%" "150%" "200%" "300%" "400%"] + :shields [true false] + :respawn-time [0 5 10 15] + :respawn-growth [0 5 10 15] + :odd-man-out [false true] + :invisible-players [false true] + :suicide-penalty [0 5 10 15] + :infinite-grenades [false true] + :weapon-set ["Normal" + "Pistols" + "Assault Rifles" + "Plasma" + "Sniper" + "No Sniping" + "Rocket Launchers" + "Shotguns" + "Short Range" + "Human" + "Covenant" + "Classic" + "Heavy Weapons"] + :starting-equipment ["Custom" "Generic"] + :indicator ["Motion Tracker" "Nav Points" "None"] + :other-players-on-radar ["No" "All" "" "Friends"] + :friend-indicators [false true] + :friendly-fire ["Off" "On" "Shields Only" "Explosives Only"] + :friendly-fire-penalty [0 5 10 15] + :auto-team-balance [false true] + ;; Vehicle Flags + :vehicle-respawn [0 30 60 90 120 180 300] + :red-vehicle-set ["Default" + "No vehicles" + "Warthogs" + "Ghosts" + "Scorpions" + "Rocket Warthogs" + "Banshees" + "Shades" + "Custom"] + :blue-vehicle-set ["Default" + "No vehicles" + "Warthogs" + "Ghosts" + "Scorpions" + "Rocket Warthogs" + "Banshees" + "Shades" + "Custom"] + ;; Game Falgs + :game-type ["" + "Capture the Flag" + "Slayer" + "Oddball" + "King of the Hill" + "Race"] + ;; CTF + :assault [false true] + :flag-must-reset [false true] + :flag-at-home-to-score [false true] + :single-flag [0 60 120 180 300 600] + ;; Slayer + :death-bonus [true false] + :kill-penalty [false true] + :kill-in-order [false true] + ;; Oddball + :random-start [false true] + :speed-with-ball ["Slow" "Normal" "Fast"] + :trait-with-ball ["None" "Invisible" "Extra Damage" "Damage Resistant"] + :trait-without-ball ["None" "Invisible" "Extra Damage" "Damage Resistant"] + :ball-type ["Normal" "Reverse Tag" "Juggernaut"] + :ball-spawn-count [1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16] + ;; KOTH + :moving-hill [false true] + ;; Race + :race-type ["Normal" "Any Order" "Rally"] + :team-scoring ["Minimum" "Maximum" "Sum"]}) + +(defn- to-int + [s] + (if (str/blank? s) + (Integer. 0) + (Integer. s))) + +(defn- to-bool + [s] + (if (= s "1") + true + false)) + +(defn- get-flags + "Takes keys and values, returns an array map where + each key has been mapped to the associated value + in `flags` + + ```clojure + (get-flags :lives (bit-and 63 3) + :shields (-> (bit-shift-right 63 5) + (bit-and 1))) + ;; => {:lives 5, :shields false} + ```" + [& kvs] + (let [pairs (partition 2 kvs)] + (into {} + (map #(vector (first %) + (get-in flags [(first %) (second %)])) + pairs)))) + +(defn- request + "Takes a `host` string and `port` integer, + returns a vector containing keywords + and values. + + ```clojure + (request \"216.128.147.196\" 2302) + ;; => [:hostname \"Halo\" :gamever \"01.00.10.0621\" :hostport \"2302\" ...] + ```" + [host port] + (with-open [socket (DatagramSocket.)] + (let [address (InetSocketAddress. host port) + packet-out (DatagramPacket. (.getBytes "\\query") 6 address) + packet-in (DatagramPacket. (byte-array 2048) 2048)] + (.send socket packet-out) + (.receive socket packet-in) + (let [result (String. (.getData packet-in) 0 (.getLength packet-in)) + split (str/split result #"\\")] + (->> (rest (if (= (last split) "nextmode") + (conj split "") + split)) + (map-indexed #(if (even? %1) + (keyword %2) + %2)) + (vec)))))) + +(defn- offsets + "Takes a [[request]] `req`, returns an array map + of offsets for locating player names, scores, pings, + teams, and the end of player data. + + ```clojure + (let [req (request \"216.128.147.196\" 2302)] + (offsets req)) + ;; => {:player-offset 32, + :score-offset 34, + :ping-offset 36, + :team-offset 38, + :end-offset 40} + ```" + [req] + (let [player-count (Integer. (nth req 19)) + player-offset (.indexOf req :player_0) + score-offset (+ player-offset (* player-count 2)) + ping-offset (+ player-offset (* player-count 4)) + team-offset (+ player-offset (* player-count 6)) + end-offset (+ player-offset (* player-count 8))] + (array-map :player-offset player-offset + :score-offset score-offset + :ping-offset ping-offset + :team-offset team-offset + :end-offset end-offset))) + +(defn- server-empty? + "Takes a [[request]] `req`, returns `true` if + the server is empty and `false` if it has players" + [req] + (not (pos? (Integer. (get req 19))))) + +(defn- cast-players-map + "Takes a [[players]] `players` array map, + returns a new map with values cast to + appropriate types." + [players-map] + (-> players-map + (update :score to-int) + (update :ping to-int) + (update :team to-int))) + +(defn- get-players + "Takes a [[request]] `req` and [[offsets]] `offsets`, + returns a vector of array maps holding player data. + + ```clojure + (let [req (request \"216.128.147.196\" 2302) + offsets (offsets req)] + (get-players req offsets)) + ;; => [{:name \"New001\", :score \"0\", :ping \"33\", :team \"0\"}] + ```" + [req offsets] + (if (server-empty? req) + [] + (let [player-count (Integer. (nth req 19)) + {player-offset :player-offset + score-offset :score-offset + ping-offset :ping-offset + team-offset :team-offset + end-offset :end-offset} offsets + player-parts (vector (partition 2 (subvec req player-offset score-offset)) + (partition 2 (subvec req score-offset ping-offset)) + (partition 2 (subvec req ping-offset team-offset)) + (partition 2 (subvec req team-offset end-offset)))] + (vec (for [i (range player-count)] + (->> player-parts + (map #(second (nth % i))) + (zipmap [:name :score :ping :team]) + (cast-players-map))))))) + +(defn- decode-player-flags + "Takes `i` integer player flags, + returns an array map containing the + keys mapped to their decoded values. + + See: [[get-flags]]" + [i] + (get-flags + :lives (bit-and i 3) + :maximum-health (-> (bit-shift-right i 2) + (bit-and 7)) + :shields (-> (bit-shift-right i 5) + (bit-and 1)) + :respawn-time (-> (bit-shift-right i 6) + (bit-and 3)) + :respawn-growth (-> (bit-shift-right i 8) + (bit-and 3)) + :odd-man-out (-> (bit-shift-right i 10) + (bit-and 1)) + :invisible-players (-> (bit-shift-right i 11) + (bit-and 1)) + :suicide-penalty (-> (bit-shift-right i 12) + (bit-and 3)) + :infinite-grenades (-> (bit-shift-right i 14) + (bit-and 1)) + :weapon-set (-> (bit-shift-right i 15) + (bit-and 15)) + :starting-equipment (-> (bit-shift-right i 19) + (bit-and 1)) + :indicator (-> (bit-shift-right i 20) + (bit-and 3)) + :other-players-on-radar (-> (bit-shift-right i 22) + (bit-and 3)) + :friend-indicators (-> (bit-shift-right i 24) + (bit-and 1)) + :friendly-fire (-> (bit-shift-right i 25) + (bit-and 3)) + :friendly-fire-penalty (-> (bit-shift-right i 27) + (bit-and 3)) + :auto-team-balance (-> (bit-shift-right i 29) + (bit-and 1)))) + +(defn- decode-vehicle-flags + "Takes `i` integer vehicle flags, + returns an array map containing the + keys mapped to their decoded values. + + See: [[get-flags]]" + [i] + (get-flags + :vehicle-respawn (bit-and i 7) + :red-vehicle-set (-> (bit-shift-right i 3) + (bit-and 15)) + :blue-vehicle-set (-> (bit-shift-right i 7) + (bit-and 15)))) + +(defn- decode-game-flags + "Takes `i` integer game flags, + returns an array map containing the + keys mapped to their decoded values. + + See: [[get-flags]]" + [i] + (let [game-flags (get-flags :game-type + (bit-and i 7)) + game-type (:game-type game-flags)] + (merge + game-flags + (case game-type + "Capture the Flag" + (get-flags + :assault (-> (bit-shift-right i 3) + (bit-and 1)) + :flag-must-reset (-> (bit-shift-right i 5) + (bit-and 1)) + :flag-at-home-to-score (-> (bit-shift-right i 6) + (bit-and 1)) + :single-flag (-> (bit-shift-right i 7) + (bit-and 7))) + "Slayer" + (get-flags + :death-bonus (-> (bit-shift-right i 3) + (bit-and 1)) + :kill-penalty (-> (bit-shift-right i 5) + (bit-and 1)) + :kill-in-order (-> (bit-shift-right i 6) + (bit-and 1))) + "Oddball" + (get-flags + :random-start (-> (bit-shift-right i 3) + (bit-and 1)) + :speed-with-ball (-> (bit-shift-right i 5) + (bit-and 3)) + :trait-with-ball (-> (bit-shift-right i 7) + (bit-and 3)) + :trait-without-ball (-> (bit-shift-right i 9) + (bit-and 3)) + :ball-type (-> (bit-shift-right i 11) + (bit-and 3)) + :ball-spawn-count (-> (bit-shift-right i 13) + (bit-and 31))) + "King of the Hill" + (get-flags + :moving-hill (-> (bit-shift-right i 3) + (bit-and 1))) + "Race" + (get-flags + :race-type (-> (bit-shift-right i 3) + (bit-and 3)) + :team-scoring (-> (bit-shift-right i 5) + (bit-and 3))))))) + +(defn- clean-request + "Takes a [[request]] `req` and [[offsets]] `offsets`, + returns the request vector stripped of player and flag + data." + [req offsets] + (if (server-empty? req) + ;; If the server is empty, just strip out flags + (into (subvec req 0 28) + (subvec req 32)) + ;; If players are present, strip both flags and players + (into (subvec req 0 28) + (subvec req (:end-offset offsets))))) + +(defn- cast-cleaned-map + "Takes `cleaned-map` (result of [[clean-request]] put into an array map), + returns a new map with values cast to appropriate types." + [cleaned-map] + (-> cleaned-map + (update :maxplayers to-int) + (update :game_classic to-bool) + (update :password to-bool) + (update :fraglimit to-int) + (update :numplayers to-int) + (update :hostport to-int) + (update :teamplay to-bool) + (update :dedicated to-bool))) + +(defn query + "Query a Halo Custom Edition Server, + returns an array map containing the + server information. + + ```clojure + (query \"216.128.147.196\" 2302) + ;; => {:maxplayers 16, + :numplayers 1, + :hostname \"Halo\", + :gametype \"Slayer\", + :hostport 2302, + :mapname \"bloodgulch\", + :players [{:name \"New001\", :score 0, :ping 32, :team 0}], + :dedicated true, + ...} + ```" + [host port] + (let [req (request host port) + offsets (offsets req) + players (get-players req offsets) + pv-flags-str (get req 29) + [p-flags v-flags] (map #(Integer. %) + (str/split pv-flags-str #",")) + player-flags (decode-player-flags p-flags) + vehicle-flags (decode-vehicle-flags v-flags) + game-flags (decode-game-flags (Integer. (get req 31))) + cleaned (apply array-map + (clean-request req offsets))] + (assoc (cast-cleaned-map cleaned) + :players players + :player-flags player-flags + :vehicle-flags vehicle-flags + :game-flags game-flags))) + +query