From b615b015e91266ba0a79d7d1eba4bd4a4f73929d Mon Sep 17 00:00:00 2001 From: Stefan Auditor Date: Wed, 2 Mar 2016 23:42:02 +0100 Subject: [PATCH] Initial import --- .gitignore | 1 + .travis.yml | 13 + LICENSE | 339 +++++++++++ README.md | 71 +++ composer.json | 22 + src/BigBlueButton.php | 67 +++ src/BigBlueButton/Attendee.php | 64 ++ src/BigBlueButton/BigBlueButtonException.php | 9 + src/BigBlueButton/Client.php | 284 +++++++++ src/BigBlueButton/Meeting.php | 601 +++++++++++++++++++ src/BigBlueButton/Recording.php | 165 +++++ src/BigBlueButton/Server.php | 396 ++++++++++++ 12 files changed, 2032 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 composer.json create mode 100644 src/BigBlueButton.php create mode 100644 src/BigBlueButton/Attendee.php create mode 100644 src/BigBlueButton/BigBlueButtonException.php create mode 100644 src/BigBlueButton/Client.php create mode 100644 src/BigBlueButton/Meeting.php create mode 100644 src/BigBlueButton/Recording.php create mode 100644 src/BigBlueButton/Server.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..22d0d82 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +vendor diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..e66b257 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +language: php + +php: + - 5.4 + - 5.5 + - 5.6 + - hhvm + +before_script: + - composer self-update + - composer install --prefer-source --no-interaction --dev + +script: phpunit \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -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..164db8a --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +# PHP BigBlueButton API Library + +> BigBlueButton is an open source web conferencing system for on-line learning. – http://www.bigbluebutton.org + +This is a php library to interface with a BigBlueButton server instance. + +## Installation + +Get [Composer](https://getcomposer.org/) and install it. +Then clone the repository and run: + + composer install + +## Usage + +To get your API URL and secret login to your BigBlueButton server and run: + + $ bbb-conf --secret + URL: http://example.org/bigbluebutton/ + Secret: aiShaiteih6nahchie1quaiyul8ce4Zu + +Initialize a BigBlueButton object: + + server->getVersion(); + print "$version\n"; + +Add a meeting: + + $meeting = $bbb->server->addMeeting( + '123-456-789-000', + 'Guphei4i', + 'ioy9Xep9', + [ + 'name' => 'A BigBlueButton meeting', + 'welcome' => 'Welcome to %%CONFNAME%%.', + 'logoutURL' => 'https://example.org/', + 'record' = true, + 'autoStartRecording' = true, + ] + ); + +Get meeting join URL for a moderator: + + $full_name = 'Martin Moderator'; + $url = $meeting->join($full_name, true); + +Get meeting join URL for an attendee: + + $full_name = 'Anton Attendee'; + $url = $meeting->join($full_name); + +## Tests + + ./vendor/bin/phpunit + +## License +GNU GENERAL PUBLIC LICENSE (GPL) diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..028b276 --- /dev/null +++ b/composer.json @@ -0,0 +1,22 @@ +{ + "name": "sanduhrs/php-bigbluebutton", + "type": "library", + "license": "GPL", + "authors": [ + { + "name": "Stefan Auditor", + "email": "stefan.auditor@erdfisch.de" + } + ], + "require": { + "guzzlehttp/guzzle": "^6.1" + }, + "require-dev": { + "phpunit/phpunit": "^5.2" + }, + "autoload": { + "psr-4": { + "sanduhrs\\": "src/" + } + } +} diff --git a/src/BigBlueButton.php b/src/BigBlueButton.php new file mode 100644 index 0000000..1459910 --- /dev/null +++ b/src/BigBlueButton.php @@ -0,0 +1,67 @@ +client = new Client($url, $secret, $endpoint); + $this->server = new Server($this->client); + } +} diff --git a/src/BigBlueButton/Attendee.php b/src/BigBlueButton/Attendee.php new file mode 100644 index 0000000..5efa816 --- /dev/null +++ b/src/BigBlueButton/Attendee.php @@ -0,0 +1,64 @@ +userID = $userID; + $this->fullName = $fullName; + $this->role = $role; + $this->customdata = $customdata; + } +} diff --git a/src/BigBlueButton/BigBlueButtonException.php b/src/BigBlueButton/BigBlueButtonException.php new file mode 100644 index 0000000..3c51d23 --- /dev/null +++ b/src/BigBlueButton/BigBlueButtonException.php @@ -0,0 +1,9 @@ +url = $url; + $this->secret = $secret; + $this->endpoint = $endpoint; + $this->HTTPClient = new HTTPClient(); + } + + /** + * Generate checksum. + * + * @param string $call + * the API call identifier. + * @param array $options + * The API call options. + * + * @return string + * The generated checksum. + */ + public function checksum($call, $options) + { + // Generate query string. + $query_string = $this->generateQueryString($options); + // Generate the checksum. + $checksum = sha1($call . $query_string . $this->secret); + return $checksum; + } + + /** + * Convert raw response XML to response Object. + * + * @param string $raw_response + * + * @return object + */ + public function xml2object($raw_response) + { + $xml = simplexml_load_string($raw_response); + return json_decode(json_encode($xml)); + } + + /** + * Clean response object from unwanted messages. + * + * @param object $response + * + * @return object + */ + public function clean($response) + { + if (isset($response->returncode)) { + unset($response->returncode); + } + if (isset($response->message)) { + unset($response->message); + } + if (isset($response->messageKey)) { + unset($response->messageKey); + } + return $response; + } + + /** + * Generate call URL. + * + * @params array $options + * The query parameters. + * + * @return string + * A properly formatted call URL. + */ + public function generateURL($call, $options = []) + { + $this->prepareQueryOptions($options); + $url = implode('', [ + $this->url, + $this->endpoint, + $call, + '?', + $this->generateQueryString($options), + '&checksum=' . $this->checksum($call, $options), + ]); + return $url; + } + + /** + * Generate Querystring. + * + * @param array $options + * The query parameters. + * + * @return string + */ + public function generateQueryString($options = []) + { + $query = array(); + // Encode the options. + foreach ($options as $key => $value) { + $query[] = $key . '=' . str_replace(['/', ' '], ['%2F', '+'], rawurlencode($value)); + } + // Generate the querystring. + return implode('&', $query); + } + + /** + * Prepare query options. + * + * @param array $options + * + * @return array + */ + public function prepareQueryOptions($options) + { + foreach ($options as $key => $option) { + if (is_bool($option)) { + $options[$key] = $option ? 'true' : 'false'; + } + } + return $options; + } + + /** + * GET request to API endpoint. + * + * @param string $call + * The API call string. + * @param array $options + * The API call options. + * + * @return string + * The xml formatted server response string. + */ + public function getRaw($call, $options = []) + { + $options = $this->prepareQueryOptions($options); + $options += [ + 'checksum' => $this->checksum($call, $options), + ]; + $response = $this->HTTPClient->request( + 'GET', + $this->url . $this->endpoint . $call, + ['query' => $options] + ); + return $response->getBody(); + } + + /** + * GET request to API endpoint. + * + * @param string $call + * The API call string. + * @param array $options + * The API call options. + * + * @throws \Exception + * + * @return object + * The response data as object. + */ + public function get($call, $options = []) + { + $raw_response = $this->getRaw($call, $options); + $response = $this->xml2object($raw_response); + + if ($response->returncode === 'SUCCESS') { + $response = $this->clean($response); + } elseif (isset($response->message)) { + throw new BigBlueButtonException($response->message); + } else { + throw new BigBlueButtonException('An unknown error occured while communicating with the server.'); + } + return $response; + } + + /** + * POST request to API endpoint. + * + * @param string $call + * The API call string. + * @param array $options + * The API call options. + * + * @return string + * The xml formatted server response string. + */ + public function postRaw($call, $options = []) + { + array_unique($options, SORT_STRING); + $options = $this->prepareQueryOptions($options); + $options += [ + 'checksum' => $this->checksum($call, $options), + ]; + $response = $this->HTTPClient->request( + 'POST', + $this->url . $this->endpoint . $call, + ['form_params' => $options] + ); + return $response->getBody(); + } + + /** + * POST request to API endpoint. + * + * @param string $call + * The API call string. + * @param array $options + * The API call options. + * + * @throws \Exception + * + * @return string + * The json formatted server response string. + */ + public function post($call, $options = []) + { + $raw = $this->postRaw($call, $options); + $xml = simplexml_load_string($raw); + + list($element) = $xml->xpath('/*/returncode'); + // @todo Throw exception if $element[0] != 'SUCCESS' + if (isset($element[0])) { + unset($element[0]); + } + // Reformat as json. + return json_decode(json_encode($xml)); + } +} diff --git a/src/BigBlueButton/Meeting.php b/src/BigBlueButton/Meeting.php new file mode 100644 index 0000000..d2e4ed0 --- /dev/null +++ b/src/BigBlueButton/Meeting.php @@ -0,0 +1,601 @@ +meetingID = $meetingID; + $this->attendeePW = $attendeePW; + $this->moderatorPW = $moderatorPW; + $this->client = $client; + $this->createTime = 0; + $this->createDate = ''; + $this->hasUserJoined = null; + $this->duration = 0; + $this->hasBeenForciblyEnded = null; + $this->meetingName = ''; + $this->voiceBridge = ''; + $this->dialNumber = ''; + $this->running = null; + $this->recording = null; + $this->startTime = 0; + $this->endTime = ''; + $this->participantCount = 0; + $this->maxUsers = 0; + $this->moderatorCount = 0; + $this->attendees = []; + $this->metadata = []; + $this->recordings = []; + if (isset($options['createTime'])) { + $this->createTime = $options['createTime']; + } + if (isset($options['createDate'])) { + $this->createDate = $options['createDate']; + } + if (isset($options['hasUserJoined'])) { + $this->hasUserJoined = $options['hasUserJoined']; + } + if (isset($options['duration'])) { + $this->duration = $options['duration']; + } + if (isset($options['hasBeenForciblyEnded'])) { + $this->hasBeenForciblyEnded = $options['hasBeenForciblyEnded']; + } + if (isset($options['name'])) { + $this->meetingName = $options['name']; + } + if (isset($options['voiceBridge'])) { + $this->voiceBridge = $options['voiceBridge']; + } + if (isset($options['dialNumber'])) { + $this->dialNumber = $options['dialNumber']; + } + if (isset($options['running'])) { + $this->running = $options['running']; + } + if (isset($options['recording'])) { + $this->recording = $options['recording']; + } + if (isset($options['startTime'])) { + $this->startTime = $options['startTime']; + } + if (isset($options['endTime'])) { + $this->endTime = $options['endTime']; + } + if (isset($options['participantCount'])) { + $this->participantCount = $options['participantCount']; + } + if (isset($options['maxUsers'])) { + $this->maxUsers = $options['maxUsers']; + } + if (isset($options['moderatorCount'])) { + $this->moderatorCount = $options['moderatorCount']; + } + if (isset($options['attendees'])) { + $this->attendees = $options['attendees']; + } + if (isset($options['metadata'])) { + $this->metadata = (array) $options['metadata']; + } + } + + /** + * Create meeting. + * + * Creates a BigBlueButton meeting. + * The create call is idempotent: you can call it multiple times with the same + * parameters without side effects. This simplifies the logic for joining a + * user into a session, your application can always call create before + * returning the join URL. This way, regardless of the order in which users + * join, the meeting will always exist but won’t be empty. The BigBlueButton + * server will automatically remove empty meetings that were created but have + * never had any users after a number of minutes specified by + * defaultMeetingCreateJoinDurationdefined in bigbluebutton.properties. + * + * @param array $options + * - name (string): A name for the meeting. + * - welcome (string): A welcome message that gets displayed on the chat + * window when the participant joins. You can include keywords + * (%%CONFNAME%%, %%DIALNUM%%, %%CONFNUM%%) which will be substituted + * automatically. You can set a default welcome message on + * bigbluebutton.properties + * - dialNumber (string): The dial access number that participants can call + * in using regular phone. You can set a default dial number on + * bigbluebutton.properties + * - voiceBridge (string): Voice conference number that participants enter + * to join the voice conference. The default pattern for this is a 5-digit + * number. This is the PIN that a dial-in user must enter to join the + * conference. If you want to change this pattern, you have to edit + * FreeSWITCH dialplan and defaultNumDigitsForTelVoice of + * bigbluebutton.properties. When using the default setup, we recommend + * you always pass a 5-digit voiceBridge parameter. Finally, if you don’t + * pass a value for voiceBridge, then users will not be able to join a + * voice conference for the session. + * - webVoice (string): Voice conference alphanumberic that participants + * enter to join the voice conference. + * - logoutURL (string): The URL that the BigBlueButton client will go to + * after users click the OK button on the ‘You have been logged out + * message’. This overrides, the value for bigbluebutton.web.loggedOutURL + * if defined in bigbluebutton.properties + * - record (boolean): Setting ‘record=true’ instructs the BigBlueButton + * server to record the media and events in the session for later + * playback. Available values are true or false. Default value is false. + * - duration (number): The maximum length (in minutes) for the meeting. + * Normally, the BigBlueButton server will end the meeting when either the + * last person leaves (it takes a minute or two for the server to clear + * the meeting from memory) or when the server receives an end API request + * with the associated meetingID (everyone is kicked and the meeting is + * immediately cleared from memory). BigBlueButton begins tracking the + * length of a meeting when the first person joins. If duration contains a + * non-zero value, then when the length of the meeting exceeds the + * duration value the server will immediately end the meeting (same as + * receiving an end API request). + * - meta (string): You can pass one or more metadata values for create a + * meeting. These will be stored by BigBlueButton and later retrievable + * via the getMeetingInfo call and getRecordings. Examples of meta + * parameters are meta_Presenter, meta_category, meta_LABEL, etc. All + * parameters are converted to lower case, so meta_Presenter would be the + * same as meta_PRESENTER. + * - moderatorOnlyMessage (string): Display a message to all moderators in + * the public chat. + * - autoStartRecording (boolean): Automatically starts recording when first + * user joins. NOTE: Don’t set to autoStartRecording =false and + * allowStartStopRecording=false as the user won’t be able to record. + * - allowStartStopRecording (boolean): Allow the user to start/stop + * recording. This means the meeting can start recording automatically + * (autoStartRecording=true) with the user able to stop/start recording + * from the client. + * + * @return string + * The xml formatted server response string. + * + * @todo http://docs.bigbluebutton.org/dev/api.html#preupload-slides + */ + public function create($options = []) + { + $options += [ + 'meetingID' => $this->meetingID, + 'attendeePW' => $this->attendeePW, + 'moderatorPW' => $this->moderatorPW, + ]; + $response = $this->client->get('create', $options); + return new Meeting( + $response->meetingID, + $response->attendeePW, + $response->moderatorPW, + (array) $response, + $this->client + ); + } + + /** + * Join meeting. + * + * Joins a user to the meeting. + * + * @param string $fullName + * The full name that is to be used to identify this user to other + * conference attendees. + * @param array $options + * - createTime (string): Third-party apps using the API can now pass + * createTime parameter (which was created in the create call), + * BigBlueButton will ensure it matches the ‘createTime’ for the session. + * If they differ, BigBlueButton will not proceed with the join request. + * This prevents a user from reusing their join URL for a subsequent + * session with the same meetingID. + * - userID (string): An identifier for this user that will help your + * application to identify which person this is. This user ID will be + * returned for this user in the getMeetingInfo API call so that you can + * check. + * - webVoiceConf (string): If you want to pass in a custom voice-extension + * when a user joins the voice conference using voip. This is useful if + * you want to collect more info in you Call Detail Records about the user + * joining the conference. You need to modify your + * /etc/asterisk/bbb-extensions.conf to handle this new extensions. + * - configToken (string): The token returned by a setConfigXML API call. + * This causes the BigBlueButton client to load the config.xml associated + * with the token (not the default config.xml) + * - avatarURL (string): The link for the user’s avatar to be displayed when + * displayAvatar in config.xml is set to true. + * - redirect (string): The default behaviour of the JOIN API is to redirect + * the browser to the Flash client when the JOIN call succeeds. There have + * been requests if it’s possible to embed the Flash client in a + * “container” page and that the client starts as a hidden DIV tag which + * becomes visible on the successful JOIN. Setting this variable to FALSE + * will not redirect the browser but returns an XML instead whether the + * JOIN call has succeeded or not. The third party app is responsible for + * displaying the client to the user. + * - clientURL (string): Some third party apps what to display their own + * custom client. These apps can pass the URL containing the custom client + * and when redirect is not set to false, the browser will get redirected + * to the value of clientURL. + * + * @return string + * The meeting join URL to redirect to. + */ + public function join($fullName, $moderator = false, $options = []) + { + $options += [ + 'fullName' => $fullName, + 'meetingID' => $this->meetingID, + 'password' => $moderator ? $this->moderatorPW : $this->attendeePW, + ]; + $url = $this->client->generateURL('join', $options); + return $url; + } + + /** + * Check meeting status. + * + * This call enables you to simply check on whether or not a meeting is + * running by looking it up with your meeting ID. + * + * @return boolean + * The running status of the meeting TRUE for running. + */ + public function isRunning() + { + $options = [ + 'meetingID' => $this->meetingID, + ]; + $response = $this->client->get('isMeetingRunning', $options); + return $response->running === 'true'; + } + + /** + * End Meeting. + * + * Use this to forcibly end a meeting and kick all participants out of the + * meeting. + * + * @return boolean + * The boolean TRUE if the end request has been sent. + */ + public function end() + { + $options = [ + 'meetingID' => $this->meetingID, + 'password' => $this->moderatorPW, + ]; + $this->client->get('end', $options); + return true; + } + + /** + * Get Meeting Info + * + * This call will return all of a meeting’s information, including the list of + * attendees as well as start and end times. + * + * @return \sanduhrs\BigBlueButton\Meeting + * The meeting object. + */ + public function getInfo() + { + $options = [ + 'meetingID' => $this->meetingID, + 'password' => $this->moderatorPW, + ]; + $info = $this->client->get('getMeetingInfo', $options); + foreach ($info as $key => $value) { + if (isset($this->{$key})) { + if ($key === 'attendees') { + foreach ($value as $attendee) { + $this->{$key}[$attendee->userID] = new Attendee( + (string) $attendee->userID, + (string) $attendee->fullName, + (string) $attendee->role, + isset($attendee->customData) ? (array) $attendee->customData : [] + ); + } + } else { + $this->{$key} = $value; + } + } + } + return $this; + } + + /** + * Get recording. + * + * Retrieves a recording that is available for playback. + * + * @param string $recordingID + * The recording ID. + * + * @return \sanduhrs\BigBlueButton\Recording|FALSE + * An recording object or FALSE. + */ + public function getRecording($recordingID) + { + $recordings = $this->getRecordings(); + if (isset($recordings[$recordingID])) { + return $recordings[$recordingID]; + } + return false; + } + + /** + * Get recordings. + * + * Retrieves the recordings that are available for playback. + * + * @return array + * An array of \sanduhrs\BigBlueButton\Recording. + */ + public function getRecordings() + { + $options = [ + 'meetingID' => $this->meetingID, + ]; + $response = $this->client->get('getRecordings', $options); + + $recordings = []; + if (isset($response->recordings->recording) && + is_object($response->recordings->recording)) { + $recordings[] = $response->recordings->recording; + } elseif (isset($response->recordings->recording)) { + $recordings = $response->recordings->recording; + } + foreach ($recordings as $recording) { + $this->recordings[$recording->recordingID] = new Recording( + $recording->recordingID, + (array) $recording, + $this->client + ); + } + return $this->recordings; + } + + /** + * Publish recording. + * + * Publish a recording for a given recordID. + * + * @param string $recordID + * A record ID to apply the publish action to. + * + * @return boolean + * The success status as TRUE. + */ + public function publishRecording($recordID) + { + return $this->publishRecordings([$recordID]); + } + + /** + * Publish recordings. + * + * Publish recordings for a set of record IDs. + * + * @param array $recordIDs + * A set of record IDs to apply the publish action to. + * + * @return boolean + * The success status as TRUE. + */ + public function publishRecordings($recordIDs) + { + $options = [ + 'recordID' => implode(',', $recordIDs), + 'publish' => 'true', + ]; + $this->client->get('publishRecordings', $options); + return true; + } + + /** + * Delete recording. + * + * Delete a recording for a given recordID. + * + * @param string $recordID + * A record ID to apply the delete action to. + * + * @return boolean + * The success status as TRUE. + */ + public function deleteRecording($recordID) + { + return $this->deleteRecordings([$recordID]); + } + + /** + * Delete recordings. + * + * Delete recordings for a set of record IDs. + * + * @param array $recordIDs + * A set of record IDs to apply the delete action to. + * + * @return boolean + * The success status as TRUE. + */ + public function deleteRecordings($recordIDs) + { + $options = [ + 'recordID' => implode(',', $recordIDs), + ]; + $this->client->get('deleteRecordings', $options); + return true; + } + + /** + * Set config xml. + * + * Associate a custom config.xml file with the current session. This call + * returns a token that can later be passed as a parameter to a join URL. When + * passed as a parameter, the BigBlueButton client will use the associated + * config.xml for the user instead of using the default config.xml. This + * enables 3rd party applications to provide user-specific config.xml files. + * + * @return string + * The xml formatted server response string. + */ + public function setConfigXML($configXML) + { + $options = [ + 'meetingID' => $this->meetingID, + 'configXML' => $configXML, + ]; + $this->client->postRaw('setConfigXML', $options); + return true; + } +} diff --git a/src/BigBlueButton/Recording.php b/src/BigBlueButton/Recording.php new file mode 100644 index 0000000..c39e69c --- /dev/null +++ b/src/BigBlueButton/Recording.php @@ -0,0 +1,165 @@ +recordID = $recordID; + $this->client = $client; + $this->meetingID = ''; + $this->name = ''; + $this->published = null; + $this->startTime = 0; + $this->endTime = 0; + $this->metadata = []; + $this->playback = []; + if (isset($options['meetingID'])) { + $this->meetingID = $options['meetingID']; + } + if (isset($options['name'])) { + $this->name = $options['name']; + } + if (isset($options['published'])) { + $this->published = $options['published']; + } + if (isset($options['startTime'])) { + $this->startTime = $options['startTime']; + } + if (isset($options['endTime'])) { + $this->endTime = $options['endTime']; + } + if (isset($options['metadata'])) { + $this->metadata = $options['metadata']; + } + if (isset($options['playback'])) { + $this->playback = $options['playback']; + } + } + + /** + * Publish recording. + * + * @return mixed + */ + public function publish() + { + $options = [ + 'recordID' => $this->recordID, + 'publish' => 'true', + ]; + return $this->client->get('isMeetingRunning', $options); + } + + /** + * Unpublish recording. + * + * @return mixed + */ + public function unpublish() + { + $options = [ + 'recordID' => $this->recordID, + 'publish' => 'false', + ]; + return $this->client->get('publishRecordings', $options); + } + + /** + * Delete recording. + * + * @return mixed + */ + public function delete() + { + $options = [ + 'recordID' => $this->recordID, + ]; + return $this->client->get('deleteRecordings', $options); + } +} diff --git a/src/BigBlueButton/Server.php b/src/BigBlueButton/Server.php new file mode 100644 index 0000000..0f340c2 --- /dev/null +++ b/src/BigBlueButton/Server.php @@ -0,0 +1,396 @@ +client = $client; + $this->meetings = []; + $this->recordings = []; + } + + /** + * Get version. + * + * Check the remote server for the BigBlueButton API version. + * + * @return string + * The version of the BigBlueButton server instance. + */ + public function getVersion() + { + $xml = $this->client->get(''); + return (string) $xml->version; + } + + /** + * Add meeting. + * + * Creates a BigBlueButton meeting. + * The create call is idempotent: you can call it multiple times with the same + * parameters without side effects. This simplifies the logic for joining a + * user into a session, your application can always call create before + * returning the join URL. This way, regardless of the order in which users + * join, the meeting will always exist but won’t be empty. The BigBlueButton + * server will automatically remove empty meetings that were created but have + * never had any users after a number of minutes specified by + * defaultMeetingCreateJoinDurationdefined in bigbluebutton.properties. + * + * @param string $meetingID + * The meeting ID. + * + * @param string $attendeePW + * The attendee password. + * + * @param string $moderatorPW + * The moderator password. + * + * @param array $options + * - name (string): A name for the meeting. + * - welcome (string): A welcome message that gets displayed on the chat + * window when the participant joins. You can include keywords + * (%%CONFNAME%%, %%DIALNUM%%, %%CONFNUM%%) which will be substituted + * automatically. You can set a default welcome message on + * bigbluebutton.properties + * - dialNumber (string): The dial access number that participants can call + * in using regular phone. You can set a default dial number on + * bigbluebutton.properties + * - voiceBridge (string): Voice conference number that participants enter + * to join the voice conference. The default pattern for this is a 5-digit + * number. This is the PIN that a dial-in user must enter to join the + * conference. If you want to change this pattern, you have to edit + * FreeSWITCH dialplan and defaultNumDigitsForTelVoice of + * bigbluebutton.properties. When using the default setup, we recommend + * you always pass a 5-digit voiceBridge parameter. Finally, if you don’t + * pass a value for voiceBridge, then users will not be able to join a + * voice conference for the session. + * - webVoice (string): Voice conference alphanumberic that participants + * enter to join the voice conference. + * - logoutURL (string): The URL that the BigBlueButton client will go to + * after users click the OK button on the ‘You have been logged out + * message’. This overrides, the value for bigbluebutton.web.loggedOutURL + * if defined in bigbluebutton.properties + * - record (string): Setting ‘record=true’ instructs the BigBlueButton + * server to record the media and events in the session for later + * playback. Available values are true or false. Default value is false. + * - duration (number): The maximum length (in minutes) for the meeting. + * Normally, the BigBlueButton server will end the meeting when either the + * last person leaves (it takes a minute or two for the server to clear + * the meeting from memory) or when the server receives an end API request + * with the associated meetingID (everyone is kicked and the meeting is + * immediately cleared from memory). BigBlueButton begins tracking the + * length of a meeting when the first person joins. If duration contains a + * non-zero value, then when the length of the meeting exceeds the + * duration value the server will immediately end the meeting (same as + * receiving an end API request). + * - meta (string): You can pass one or more metadata values for create a + * meeting. These will be stored by BigBlueButton and later retrievable + * via the getMeetingInfo call and getRecordings. Examples of meta + * parameters are meta_Presenter, meta_category, meta_LABEL, etc. All + * parameters are converted to lower case, so meta_Presenter would be the + * same as meta_PRESENTER. + * - moderatorOnlyMessage (string): Display a message to all moderators in + * the public chat. + * - autoStartRecording (boolean): Automatically starts recording when first + * user joins. NOTE: Don’t set to autoStartRecording =false and + * allowStartStopRecording=false as the user won’t be able to record. + * - allowStartStopRecording (boolean): Allow the user to start/stop + * recording. This means the meeting can start recording automatically + * (autoStartRecording=true) with the user able to stop/start recording + * from the client. + * + * @return \sanduhrs\BigBlueButton\Meeting + * A meeting object. + */ + public function addMeeting($meetingID, $attendeePW, $moderatorPW, $options = []) + { + $meeting = new Meeting( + $meetingID, + $attendeePW, + $moderatorPW, + $options, + $this->client + ); + $this->meetings[$meetingID] = $meeting->create($options); + return $this->meetings[$meetingID]; + } + + /** + * Get meeting. + * + * This call will return a meeting from the list found on this server. + * + * @param string $meetingID + * The meeting ID. + * + * @return \sanduhrs\BigBlueButton\Meeting|FALSE + * A meeting object or FALSE. + */ + public function getMeeting($meetingID) + { + $meetings = $this->getMeetings(); + if (isset($meetings[$meetingID])) { + return $meetings[$meetingID]; + } + return false; + } + + /** + * Get meetings. + * + * This call will return a list of all the meetings found on this server. + * + * @return array + * An array of \sanduhrs\BigBlueButton\Meetings. + */ + public function getMeetings() + { + $meetings = []; + $response = $this->client->get('getMeetings'); + + if (isset($response->meetings->meeting) && is_object($response->meetings->meeting)) { + $meetings[] = $response->meetings->meeting; + } else { + $meetings = $response->meetings->meeting; + } + + foreach ($meetings as $meeting) { + $this->meetings[$meeting->meetingID] = new Meeting( + $meeting->meetingID, + $meeting->attendeePW, + $meeting->moderatorPW, + (array) $meeting, + $this->client + ); + } + return $this->meetings; + } + + /** + * Get recording. + * + * Retrieves a recording that is available for playback. + * + * @param string $recordingID + * The recording ID. + * + * @return \sanduhrs\BigBlueButton\Recording|FALSE + * An recording object or FALSE. + */ + public function getRecording($recordingID) + { + $recordings = $this->getRecordings(); + if (isset($recordings[$recordingID])) { + return $recordings[$recordingID]; + } + return false; + } + + /** + * Get recordings. + * + * Retrieves the recordings that are available for playback. + * + * @return array + * An array of \sanduhrs\BigBlueButton\Recording. + */ + public function getRecordings() + { + $response = $this->client->get('getRecordings'); + + $recordings = []; + if (isset($response->recordings->recording) && + is_object($response->recordings->recording)) { + $recordings[] = $response->recordings->recording; + } elseif (isset($response->recordings->recording)) { + $recordings = $response->recordings->recording; + } + foreach ($recordings as $recording) { + $this->recordings[$recording->recordingID] = new Recording( + $recording->recordingID, + (array) $recording, + $this->client + ); + } + return $this->recordings; + } + + /** + * Publish recording. + * + * Publish a recording for a given recordID. + * + * @param string $recordID + * A record ID to apply the publish action to. + * + * @return boolean + * The success status as TRUE. + */ + public function publishRecording($recordID) + { + return $this->publishRecordings([$recordID]); + } + + /** + * Publish recordings. + * + * Publish recordings for a set of record IDs. + * + * @param array $recordIDs + * A set of record IDs to apply the publish action to. + * + * @return boolean + * The success status as TRUE. + */ + public function publishRecordings($recordIDs) + { + $options = [ + 'recordID' => implode(',', $recordIDs), + 'publish' => 'true', + ]; + $this->client->get('publishRecordings', $options); + return true; + } + + /** + * Unpublish recording. + * + * Unpublish a recording for a given recordID. + * + * @param string $recordID + * A record ID to apply the unpublish action to. + * + * @return boolean + * The success status as TRUE. + */ + public function unpublishRecording($recordID) + { + return $this->unpublishRecordings([$recordID]); + } + + /** + * Unpublish recordings. + * + * Unpublish recordings for a set of record IDs. + * + * @param array $recordIDs + * A set of record IDs to apply the unpublish action to. + * + * @return boolean + * The success status as TRUE. + */ + public function unpublishRecordings($recordIDs) + { + $options = [ + 'recordID' => implode(',', $recordIDs), + 'publish' => 'false', + ]; + $this->client->get('unpublishRecordings', $options); + return true; + } + + /** + * Delete recording. + * + * Delete a recording for a given recordID. + * + * @param string $recordID + * A record ID to apply the delete action to. + * + * @return boolean + * The success status as TRUE. + */ + public function deleteRecording($recordID) + { + return $this->deleteRecordings([$recordID]); + } + + /** + * Delete recordings. + * + * Delete recordings for a set of record IDs. + * + * @param array $recordIDs + * A set of record IDs to apply the delete action to. + * + * @return boolean + * The success status as TRUE. + */ + public function deleteRecordings($recordIDs) + { + $options = [ + 'recordID' => implode(',', $recordIDs), + ]; + $this->client->get('deleteRecordings', $options); + return true; + } + + /** + * Get default config xml. + * + * Retrieve the default config.xml. This call enables a 3rd party application + * to get the current config.xml, modify it’s parameters, and use setConfigXML + * to store it on the BigBlueButton server (getting a reference token to the + * new config.xml), then using the token in as a parameter in the join URL to + * override the default config.xml. + * + * @return string + * The default config xml retrieved from the server. + * + * @throws \sanduhrs\BigBlueButton\BigBlueButtonException + */ + public function getDefaultConfigXML() + { + $result = $this->client->getRaw('getDefaultConfigXML'); + $xml = simplexml_load_string($result); + + // Check for success + if (!isset($xml->version)) { + throw new BigBlueButtonException('Could not retrieve default config xml.'); + } + return $result; + } +}