commit 2d73779fbaf2f799b578c3817ee7217f161514d2 Author: Carl Kittelberger Date: Thu May 5 18:37:18 2016 +0200 Initial commit. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..daf913b --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# Compiled Object files, Static and Dynamic libs (Shared Objects) +*.o +*.a +*.so + +# Folders +_obj +_test + +# Architecture specific extensions/prefixes +*.[568vq] +[568vq].out + +*.cgo1.go +*.cgo2.c +_cgo_defun.c +_cgo_gotypes.go +_cgo_export.* + +_testmain.go + +*.exe +*.test +*.prof diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d446ff --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# go-q3net + +go-q3net is a library that allows interacting with servers that use a compatible variation of the network protocol that Quake III Arena uses. + +## Work in progress + +This library is mainly work in progress due to missing documentation. If you already know how to use it, please go ahead and do so! + +## License + +This project is licensed under the **GNU General Public License Version 2 or any later version**. For more info, see the [COPYING](COPYING) text file. diff --git a/errors.go b/errors.go new file mode 100644 index 0000000..06f11ac --- /dev/null +++ b/errors.go @@ -0,0 +1,6 @@ +package quake + +import "errors" + +var ErrNoMatchingType error = errors.New("No matching type") +var ErrCorruptedMessage error = errors.New("Corrupted message") diff --git a/header.go b/header.go new file mode 100644 index 0000000..a291621 --- /dev/null +++ b/header.go @@ -0,0 +1,64 @@ +package quake + +import ( + "bytes" + "encoding/binary" +) + +const ( + FRAGMENT_BIT = uint32(1) << 31 + MAX_MSGSEQNUM = ^FRAGMENT_BIT +) + +var ( + endianness = binary.LittleEndian + + OOBHeader = &Header{ + Fragmented: true, + MessageSequenceNumber: MAX_MSGSEQNUM, + } +) + +type Header struct { + Fragmented bool + MessageSequenceNumber uint32 +} + +func (h *Header) IsOOB() bool { + return h.Fragmented && h.MessageSequenceNumber == MAX_MSGSEQNUM +} + +func (h *Header) Marshal() []byte { + // Fragmented is first bit + // Message sequence number is the last 31 bits + finalHeader := h.MessageSequenceNumber + if h.Fragmented { + finalHeader |= FRAGMENT_BIT + } + + buf := new(bytes.Buffer) + binary.Write(buf, endianness, finalHeader) + bytes := buf.Bytes() + + return bytes +} + +func UnmarshalHeader(data []byte) (*Header, error) { + if len(data) < 4 { + return nil, ErrCorruptedMessage + } + + // Sequence number + seqNum := endianness.Uint32(data) + + // First bit = Fragmented? + fragmented := seqNum&FRAGMENT_BIT != 0 + if fragmented { + seqNum &= ^FRAGMENT_BIT + } + + return &Header{ + Fragmented: fragmented, + MessageSequenceNumber: seqNum, + }, nil +} diff --git a/header_test.go b/header_test.go new file mode 100644 index 0000000..4dddf89 --- /dev/null +++ b/header_test.go @@ -0,0 +1,71 @@ +package quake + +import ( + "bytes" + "strconv" + "strings" + "testing" +) + +func TestNetchanConstants(t *testing.T) { + binaryConst := strings.TrimLeft(strconv.FormatUint(uint64(FRAGMENT_BIT), 2), "0") + if binaryConst != "1"+strings.Repeat("0", 31) { + t.Fatalf("FRAGMENT_BIT is incorrect (value currently is %v as binary)", binaryConst) + } + + binaryConst = strings.TrimLeft(strconv.FormatUint(uint64(MAX_MSGSEQNUM), 2), "0") + if binaryConst != strings.Repeat("1", 31) { + t.Fatalf("MAX_MSGSEQNUM is incorrect (value currently is %v as binary)", binaryConst) + } +} + +func TestHeaderIsOOB(t *testing.T) { + h := &Header{ + Fragmented: true, + MessageSequenceNumber: MAX_MSGSEQNUM, + } + if !h.IsOOB() { + t.Fatal("Header unexpectedly does not report itself as out of band header") + } +} + +func TestHeaderIsOOBConst(t *testing.T) { + h := OOBHeader + if !h.IsOOB() { + t.Fatal("Header unexpectedly does not report itself as out of band header") + } +} + +func TestHeaderUnmarshalOOB(t *testing.T) { + h, err := UnmarshalHeader([]byte{0xFF, 0xFF, 0xFF, 0xFF}) + if err != nil { + t.Fatalf("Unexpected error: %v", err) + } + if !h.IsOOB() { + t.Fatal("Header unexpectedly does not report itself as out of band header") + } +} + +func TestHeaderUnmarshal(t *testing.T) { + h, err := UnmarshalHeader([]byte{0x01, 0x00, 0x00, 0x00}) + if err != nil { + t.Fatalf("Unexpected error: %v", err) + } + if h.Fragmented { + t.Fatal("Header unexpectedly does report fragmented") + } + if h.MessageSequenceNumber != 1 { + t.Fatal("Message sequence number mismatch") + } +} + +func TestHeaderMarshal(t *testing.T) { + h := &Header{ + Fragmented: false, + MessageSequenceNumber: 1, + } + data := h.Marshal() + if !bytes.Equal(data, []byte{0x01, 0x00, 0x00, 0x00}) { + t.Fatalf("Marshaled data is invalid, result is %x", data) + } +} diff --git a/message.go b/message.go new file mode 100644 index 0000000..710c538 --- /dev/null +++ b/message.go @@ -0,0 +1,212 @@ +package quake + +import ( + "bytes" + "io" + "strings" +) + +type Message struct { + Header *Header + Name string + FragmentOffset uint32 + FragmentLength uint32 + Data []byte +} + +func UnmarshalMessage(data []byte) (*Message, error) { + // Is there even a full header? + if len(data) < 4 { + return nil, ErrCorruptedMessage + } + + header, err := UnmarshalHeader(data[0:4]) + if err != nil { + return nil, err + } + + // netchan UDP packets are structured differently + if !header.IsOOB() { + /* + Original commentary from https://github.com/id-Software/Quake-III-Arena/blob/master/code/qcommon/net_chan.c#L30-L33: + + packet header + ------------- + 4 outgoing sequence. high bit will be set if this is a fragmented message + [2 qport (only for client to server)] + [2 fragment start byte] + [2 fragment length. if < FRAGMENT_SIZE, this is the last fragment] + + if the sequence number is -1, the packet should be handled as an out-of-band + message instead of as part of a netcon. + + All fragments will have the same sequence numbers. + + The qport field is a workaround for bad address translating routers that + sometimes remap the client's source port on a packet during gameplay. + + If the base part of the net address matches and the qport matches, then the + channel matches even if the IP port differs. The IP port should be updated + to the new value before sending out any replies. + + */ + + // TODO - if packet is from client to server then 16 bits client's port number here + + if header.Fragmented { + // TODO + + // 16 bits fragment offset + + // 16 bits fragment length + } + } + + splitPos := bytes.IndexAny(data[4:], " \n\r\t\x00\\") + if splitPos < 0 { + splitPos = len(data) - 4 + } + commandName := string(data[4 : 4+splitPos]) + + //log.Printf("Got message with command name %q", commandName) + + extra := []byte(nil) + if data[4+splitPos] == 92 { + splitPos-- + } + if len(data) > 4+splitPos { + extra = data[4+splitPos+1:] + } + for len(extra) > 0 && extra[len(extra)-1] == 0 { + extra = extra[0 : len(extra)-1] + } + + return &Message{ + Name: commandName, + Data: extra, + Header: header, + }, nil +} + +func (m *Message) SetArguments(argv []string) { + m.Data = make([]byte, 0) + + for _, arg := range argv { + if strings.Contains(arg, " ") { + arg = "\"" + strings.Replace(arg, "\"", "\\\"", -1) + "\"" + } + + if len(m.Data) > 0 { + // separate with space + m.Data = append(m.Data, 0x20) + } + + // add argument in binary form + m.Data = append(m.Data, []byte(arg)...) + } + + //m.Data = append(m.Data, 0x0A) +} + +func (m *Message) GetArguments() []string { + // All matches, extract arguments + buffer := m.Data + argv := []string{} + for len(buffer) > 0 { + c := rune(buffer[0]) + + switch c { + case '"', '\'': + // quoted string + searchPos := 1 + for { + pos := bytes.IndexByte(buffer[searchPos:], byte(c)) + if pos < 0 { + // found quote start without a matching end + return nil + } + + pos += searchPos + + if rune(buffer[pos-1]) != '\\' { + // found end of quoted string + searchPos = pos + break + } + + // that's an escaped quote char, skip that + searchPos = pos + 1 + } + + // append what's inside the quotes to the arguments list + arg := string(buffer[1:searchPos]) + arg = strings.Replace(arg, "\\"+string(c), string(c), -1) + argv = append(argv, arg) + + if searchPos+1 < len(buffer) { + buffer = buffer[searchPos+1:] + } else { + buffer = []byte{} + } + case ' ', '\t', '\n', '\r': + buffer = buffer[1:] + default: + // search for next space + pos := bytes.IndexByte(buffer, 0x20) + if pos < 0 { + pos = bytes.IndexByte(buffer, 0x0A) + } + if pos < 0 { + pos = bytes.IndexByte(buffer, 0x00) + } + if pos < 0 { + pos = len(buffer) + } + arg := string(buffer[0:pos]) + argv = append(argv, arg) + + if pos+1 < len(buffer) { + buffer = buffer[pos+1:] + } else { + buffer = []byte{} + } + } + + } + + return argv +} + +func (m *Message) Marshal(w io.Writer) error { + // Buffer + buf := new(bytes.Buffer) + + // Header + if _, err := buf.Write(m.Header.Marshal()); err != nil { + return err + } + + // Command name + if _, err := buf.Write([]byte(m.Name)); err != nil { + return err + } + + // Data + if m.Data != nil && len(m.Data) > 0 { + if _, err := buf.Write([]byte{0x20}); err != nil { + return err + } + } + if _, err := buf.Write(m.Data); err != nil { + return err + } + + // Separator, IW code expects this to be there, however our + // implementation doesn't require it. + buf.Write([]byte{0x00}) + + // And now write as one message + w.Write(buf.Bytes()) + + return nil +} diff --git a/message_test.go b/message_test.go new file mode 100644 index 0000000..f2e7096 --- /dev/null +++ b/message_test.go @@ -0,0 +1,58 @@ +package quake + +import ( + "bytes" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestGenerateMessage(t *testing.T) { + actualMsgInstance := &Message{ + Header: OOBHeader, + Name: "getinfo", + } + actualMsgInstance.SetArguments([]string{"x\" y\"z"}) + actualMsgBuf := new(bytes.Buffer) + if err := actualMsgInstance.Marshal(actualMsgBuf); err != nil { + t.Fatal(err) + return + } + actualMsg := actualMsgBuf.Bytes() + + expectedMsg := append([]byte{0xff, 0xff, 0xff, 0xff}, []byte("getinfo")...) + expectedMsg = append(expectedMsg, 0x20) + expectedMsg = append(expectedMsg, []byte("\"x\\\" y\\\"z\"")...) + expectedMsg = append(expectedMsg, 0x00) // delimiter + + assert.EqualValues(t, expectedMsg, actualMsg) +} + +func TestParseMessage(t *testing.T) { + msg := append([]byte{0xff, 0xff, 0xff, 0xff}, []byte("getinfo")...) + msg = append(msg, 0x20) + msg = append(msg, []byte("xxx")...) + msg = append(msg, 0x20) + msg = append(msg, []byte("\"yy\\\"y\"")...) + msg = append(msg, 0x20) + msg = append(msg, []byte("'yz\"y'")...) + msg = append(msg, 0x0A) + + parsedMsg, err := UnmarshalMessage(msg) + if err != nil { + t.Errorf("Parser threw an error: %v", err) + } + switch parsedMsg.Name { + case "getinfo": + args := parsedMsg.GetArguments() + if !assert.Equal(t, 3, len(args)) { + t.Fail() + return + } + assert.Equal(t, "xxx", args[0]) + assert.Equal(t, "yy\"y", args[1]) + assert.Equal(t, "yz\"y", args[2]) + default: + t.Errorf("Unexpected parsed command name: %v", parsedMsg.Name) + } +} diff --git a/recvmessage.go b/recvmessage.go new file mode 100644 index 0000000..0a420c9 --- /dev/null +++ b/recvmessage.go @@ -0,0 +1,8 @@ +package quake + +type ReceivedMessage struct { + *Message + writer *Writer +} + +func (m *ReceivedMessage) Writer() *Writer { return m.writer } diff --git a/writer.go b/writer.go new file mode 100644 index 0000000..b9d1fa8 --- /dev/null +++ b/writer.go @@ -0,0 +1,26 @@ +package quake + +import ( + "bytes" + "net" +) + +type Writer struct { + socket *net.UDPConn + addr *net.UDPAddr +} + +/*func (w *Writer) Socket() *net.UDPConn { + return w.socket +}*/ + +func (w *Writer) Addr() *net.UDPAddr { + return w.addr +} + +func (w *Writer) Write(msg *Message) error { + buf := new(bytes.Buffer) + msg.Marshal(buf) + _, err := w.socket.WriteToUDP(buf.Bytes(), w.addr) + return err +}