├── .gitattributes
├── .gitignore
├── LICENSE
├── MumblePing.php
└── README.md


/.gitattributes:
--------------------------------------------------------------------------------
 1 | # Auto detect text files and perform LF normalization
 2 | * text=auto
 3 | 
 4 | # Custom for Visual Studio
 5 | *.cs     diff=csharp
 6 | 
 7 | # Standard to msysgit
 8 | *.doc	 diff=astextplain
 9 | *.DOC	 diff=astextplain
10 | *.docx diff=astextplain
11 | *.DOCX diff=astextplain
12 | *.dot  diff=astextplain
13 | *.DOT  diff=astextplain
14 | *.pdf  diff=astextplain
15 | *.PDF	 diff=astextplain
16 | *.rtf	 diff=astextplain
17 | *.RTF	 diff=astextplain
18 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Windows image file caches
 2 | Thumbs.db
 3 | ehthumbs.db
 4 | 
 5 | # Folder config file
 6 | Desktop.ini
 7 | 
 8 | # Recycle Bin used on file shares
 9 | $RECYCLE.BIN/
10 | 
11 | # Windows Installer files
12 | *.cab
13 | *.msi
14 | *.msm
15 | *.msp
16 | 
17 | # Windows shortcuts
18 | *.lnk
19 | 
20 | # =========================
21 | # Operating System Files
22 | # =========================
23 | 
24 | # OSX
25 | # =========================
26 | 
27 | .DS_Store
28 | .AppleDouble
29 | .LSOverride
30 | 
31 | # Thumbnails
32 | ._*
33 | 
34 | # Files that might appear on external disk
35 | .Spotlight-V100
36 | .Trashes
37 | 
38 | # Directories potentially created on remote AFP share
39 | .AppleDB
40 | .AppleDesktop
41 | Network Trash Folder
42 | Temporary Items
43 | .apdisk
44 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | This is free and unencumbered software released into the public domain.
 2 | 
 3 | Anyone is free to copy, modify, publish, use, compile, sell, or
 4 | distribute this software, either in source code form or as a compiled
 5 | binary, for any purpose, commercial or non-commercial, and by any
 6 | means.
 7 | 
 8 | In jurisdictions that recognize copyright laws, the author or authors
 9 | of this software dedicate any and all copyright interest in the
10 | software to the public domain. We make this dedication for the benefit
11 | of the public at large and to the detriment of our heirs and
12 | successors. We intend this dedication to be an overt act of
13 | relinquishment in perpetuity of all present and future rights to this
14 | software under copyright law.
15 | 
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 | IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 | OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 | ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 | OTHER DEALINGS IN THE SOFTWARE.
23 | 
24 | For more information, please refer to <http://unlicense.org>
25 | 


--------------------------------------------------------------------------------
/MumblePing.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * A simple function to execute UDP Ping on Mumble servers.
 4 |  *
 5 |  * Author: xPaw
 6 |  * Website: http://xpaw.me
 7 |  * GitHub: https://github.com/xPaw/MumblePing
 8 |  * License: Unlicense, public domain
 9 |  */
10 | 
11 | namespace xPaw\Mumble;
12 | 
13 | /**
14 |  * Sends a UDP ping to a Mumble server and returns info back.
15 |  *
16 |  * @param string $Address IP address of the server.
17 |  * @param int    $Port    Port of the server.
18 |  * @param int    $Timeout Seconds before socket times out.
19 |  *
20 |  * @return array|false Array with info on success, false on failure.
21 |  */
22 | function MumblePing( $Address, $Port = 64738, $Timeout = 3 )
23 | {
24 | 	$Socket = @fsockopen( 'udp://' . $Address, $Port, $ErrNo, $ErrStr, $Timeout );
25 | 	
26 | 	if( $ErrNo || $Socket === false )
27 | 	{
28 | 		return false;
29 | 	}
30 | 	
31 | 	stream_set_timeout( $Socket, $Timeout );
32 | 	stream_set_blocking( $Socket, true );
33 | 	
34 | 	// 4 bytes = request type
35 | 	// 8 bytes = request ident
36 | 	$Command = "\x00\x00\x00\x00\x00\x78\x50\x61\x77\x2e\x6d\x65";
37 | 	
38 | 	fwrite( $Socket, $Command, 12 );
39 | 	
40 | 	// 4 bytes = version (e.g., \x0\x1\x2\x3 for 1.2.3.)
41 | 	// 8 bytes = request ident
42 | 	// 4 bytes = current users
43 | 	// 4 bytes = max users
44 | 	// 4 bytes = allowed bandwidth (in bytes)
45 | 	$Data = fread( $Socket, 24 );
46 | 	
47 | 	if( $Data === false || strlen( $Data ) < 24 )
48 | 	{
49 | 		return false;
50 | 	}
51 | 	
52 | 	$Info =
53 | 	[
54 | 		'Version'   => '',
55 | 		'Users'     => unpack( 'N', substr( $Data, 12, 4 ) )[ 1 ],
56 | 		'MaxUsers'  => unpack( 'N', substr( $Data, 16, 4 ) )[ 1 ],
57 | 		'Bandwidth' => unpack( 'N', substr( $Data, 20, 4 ) )[ 1 ],
58 | 	];
59 | 	
60 | 	for( $i = 0; $i < 4; $i++ )
61 | 	{
62 | 		if( $Data[ $i ] !== "\x00" )
63 | 		{
64 | 			$Info[ 'Version' ] .= ord( $Data[ $i ] );
65 | 			
66 | 			if( $Data[ $i + 1 ] !== "\x00" )
67 | 			{
68 | 				$Info[ 'Version' ] .= '.';
69 | 			}
70 | 		}
71 | 	}
72 | 	
73 | 	return $Info;
74 | }
75 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # PHP Mumble Ping
 2 | 
 3 | Mumble supports querying server information by sending a ping
 4 | packet to the target server. This includes: server version,
 5 | currently connected users, max users allowed, allowed bandwidth.
 6 | This implementation doesn't require anything on the server side,
 7 | and will work on any server.
 8 | 
 9 | Read more about it [here](http://wiki.mumble.info/wiki/Protocol#UDP_Ping_packet).
10 | 
11 | ### How to use it
12 | 
13 | ```php
14 | <?php
15 | 
16 | use xPaw\Mumble;
17 | 
18 | // require or your favourite autoloader
19 | require __DIR__ . '/MumblePing.php';
20 | 
21 | $Info = MumblePing( 'example.com', 64738 );
22 | 
23 | if( $Info === false )
24 | {
25 | 	echo 'Ping failed.';
26 | }
27 | else
28 | {
29 | 	echo 'Users: ' . $Info[ 'Users' ] . ' / ' . $Info[ 'MaxUsers' ] . '<br>';
30 | 	echo 'Version: ' . $Info[ 'Version' ] . '<br>';
31 | 	echo 'Bandwidth: ' . $Info[ 'Bandwidth' ] . ' (bytes)<br>';
32 | }
33 | ```
34 | 


--------------------------------------------------------------------------------