bbbctl 0.0.4__tar.gz → 0.2.0__tar.gz

{bbbctl-0.0.4/src/bbbctl.egg-info → bbbctl-0.2.0}/PKG-INFO

@@ -1,13 +1,11 @@
 Metadata-Version: 2.1
 Name: bbbctl
-Version: 0.0.4
+Version: 0.2.0
 Summary: BigBlueButton API command-line client
 Home-page: https://github.com/defnull/bbbctl
 Author: Marcel Hellkamp
 Author-email: marc@gsites.de
-License: UNKNOWN
 Project-URL: Bug Tracker, https://github.com/defnull/bbbctl/issues
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -17,9 +15,9 @@ License-File: LICENSE
 
 # BigBlueButton REST API command-line client
 
-This is a small but useful command-line client for controlling meetings and recordings on a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight), [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and directly access the backing BBB servers for administative tasks, monitoring or testing.
+This is a small but useful command-line client for controlling meetings and recordings on a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight), [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and directly access the backing BBB servers for administrative tasks, monitoring or testing.
 
-The module can also be imported as a python library, but please note that this project is not yet considered stable in any way. A stable and more usable API for python skripting might follow.
+The module can also be imported as a python library, but please note that this project is not yet considered stable in any way. A stable and more usable API for python scripting might follow.
 
 ## Install
 
@@ -28,7 +26,7 @@ The module can also be imported as a python library, but please note that this p
 sudo pip install -U bbbctl
 # or manually:
 sudo curl -L https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py -o /usr/local/bin/bbbctl
-sudo chmos +x /usr/local/bin/bbbctl
+sudo chmod +x /usr/local/bin/bbbctl
 ```
 
 ## Usage
@@ -60,15 +58,15 @@ You can get detailed help and a list of all parameters with `bbbctl -h` or `bbbc
   - `info <recordID>` Show info about a recording
   - `publish <recordID>` Publish an unpublished recording
   - `unpublish <recordID>` Unpublish (hide) recording)
-  - `delete <recordID>` Delete a recording
+  - `delete <recordID>` Delete a recording (be careful)
 
 ## Output format
 
-The default output format is currently a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats (e.g. `json`, `yaml` or `xml`) may be supported in the future.
+The default output format is a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats that are better suited for scripted usage are also supported: `json`, `jsonline` or `xml`
 
 # License
 
-Copyright (c) 2020-2021, Marcel Hellkamp.
+Copyright (c) 2020-2022, Marcel Hellkamp.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -87,5 +85,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
-
-

{bbbctl-0.0.4 → bbbctl-0.2.0}/README.md

@@ -1,8 +1,8 @@
 # BigBlueButton REST API command-line client
 
-This is a small but useful command-line client for controlling meetings and recordings on a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight), [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and directly access the backing BBB servers for administative tasks, monitoring or testing.
+This is a small but useful command-line client for controlling meetings and recordings on a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight), [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and directly access the backing BBB servers for administrative tasks, monitoring or testing.
 
-The module can also be imported as a python library, but please note that this project is not yet considered stable in any way. A stable and more usable API for python skripting might follow.
+The module can also be imported as a python library, but please note that this project is not yet considered stable in any way. A stable and more usable API for python scripting might follow.
 
 ## Install
 
@@ -11,7 +11,7 @@ The module can also be imported as a python library, but please note that this p
 sudo pip install -U bbbctl
 # or manually:
 sudo curl -L https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py -o /usr/local/bin/bbbctl
-sudo chmos +x /usr/local/bin/bbbctl
+sudo chmod +x /usr/local/bin/bbbctl
 ```
 
 ## Usage
@@ -43,15 +43,15 @@ You can get detailed help and a list of all parameters with `bbbctl -h` or `bbbc
   - `info <recordID>` Show info about a recording
   - `publish <recordID>` Publish an unpublished recording
   - `unpublish <recordID>` Unpublish (hide) recording)
-  - `delete <recordID>` Delete a recording
+  - `delete <recordID>` Delete a recording (be careful)
 
 ## Output format
 
-The default output format is currently a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats (e.g. `json`, `yaml` or `xml`) may be supported in the future.
+The default output format is a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats that are better suited for scripted usage are also supported: `json`, `jsonline` or `xml`
 
 # License
 
-Copyright (c) 2020-2021, Marcel Hellkamp.
+Copyright (c) 2020-2022, Marcel Hellkamp.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{bbbctl-0.0.4 → bbbctl-0.2.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = bbbctl
-version = 0.0.4
+version = 0.2.0
 author = Marcel Hellkamp
 author_email = marc@gsites.de
 description = BigBlueButton API command-line client

{bbbctl-0.0.4 → bbbctl-0.2.0/src/bbbctl.egg-info}/PKG-INFO

@@ -1,13 +1,11 @@
 Metadata-Version: 2.1
 Name: bbbctl
-Version: 0.0.4
+Version: 0.2.0
 Summary: BigBlueButton API command-line client
 Home-page: https://github.com/defnull/bbbctl
 Author: Marcel Hellkamp
 Author-email: marc@gsites.de
-License: UNKNOWN
 Project-URL: Bug Tracker, https://github.com/defnull/bbbctl/issues
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -17,9 +15,9 @@ License-File: LICENSE
 
 # BigBlueButton REST API command-line client
 
-This is a small but useful command-line client for controlling meetings and recordings on a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight), [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and directly access the backing BBB servers for administative tasks, monitoring or testing.
+This is a small but useful command-line client for controlling meetings and recordings on a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight), [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and directly access the backing BBB servers for administrative tasks, monitoring or testing.
 
-The module can also be imported as a python library, but please note that this project is not yet considered stable in any way. A stable and more usable API for python skripting might follow.
+The module can also be imported as a python library, but please note that this project is not yet considered stable in any way. A stable and more usable API for python scripting might follow.
 
 ## Install
 
@@ -28,7 +26,7 @@ The module can also be imported as a python library, but please note that this p
 sudo pip install -U bbbctl
 # or manually:
 sudo curl -L https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py -o /usr/local/bin/bbbctl
-sudo chmos +x /usr/local/bin/bbbctl
+sudo chmod +x /usr/local/bin/bbbctl
 ```
 
 ## Usage
@@ -60,15 +58,15 @@ You can get detailed help and a list of all parameters with `bbbctl -h` or `bbbc
   - `info <recordID>` Show info about a recording
   - `publish <recordID>` Publish an unpublished recording
   - `unpublish <recordID>` Unpublish (hide) recording)
-  - `delete <recordID>` Delete a recording
+  - `delete <recordID>` Delete a recording (be careful)
 
 ## Output format
 
-The default output format is currently a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats (e.g. `json`, `yaml` or `xml`) may be supported in the future.
+The default output format is a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats that are better suited for scripted usage are also supported: `json`, `jsonline` or `xml`
 
 # License
 
-Copyright (c) 2020-2021, Marcel Hellkamp.
+Copyright (c) 2020-2022, Marcel Hellkamp.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -87,5 +85,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
-
-

{bbbctl-0.0.4 → bbbctl-0.2.0}/src/bbbctl.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
 bbbctl = bbbctl:main
-

{bbbctl-0.0.4 → bbbctl-0.2.0}/src/bbbctl.py

@@ -6,9 +6,9 @@ import urllib.parse
 import hashlib
 import sys, os
 import xml.etree.ElementTree as ET
-from xml.dom import minidom
 import json
 import datetime
+import ssl
 
 __all__ = ["BBBApiClient", "ApiError"]
 
@@ -22,9 +22,10 @@ class ApiError(RuntimeError):
 
 
 class BBBApiClient:
-    def __init__(self, api, secret):
+    def __init__(self, api, secret, ssl_context=None):
         self.api = api.rstrip("/")
         self.secret = secret
+        self.ssl = ssl_context or ssl.create_default_context()
 
     def makeurl(self, command, **query):
         query = urllib.parse.urlencode(query)
@@ -38,7 +39,7 @@ class BBBApiClient:
 
     def call(self, command, **query):
         url = self.makeurl(command, **query)
-        with urllib.request.urlopen(url) as f:
+        with urllib.request.urlopen(url, context=self.ssl) as f:
             xml = f.read().decode("utf8")
         root = ET.fromstring(xml)
         if root.find("./returncode").text != "SUCCESS":
@@ -83,11 +84,15 @@ def build_parser():
         "--secret",
         help="API secretd (default: BBBCTL_SECRET or local config)",
     )
+    parser.add_argument(
+        "--insecure",
+        help="Skip TLS verification and accept self-signed or invalid SSL certificates as if they were valid",
+    )
 
     parser.add_argument(
         "--format",
         help="Change output format.",
-        choices=["human", "compact", "xml"],
+        choices=["human", "compact", "xml", "json", "jsonline"],
         default="human",
     )
 
@@ -175,6 +180,7 @@ config_paths = [
     "/etc/bigbluebutton/bbb-web.properties",
     "/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties",
     "/var/lib/tomcat7/webapps/bigbluebutton/WEB-INF/classes/bigbluebutton.properties",
+    "./bbbctl.conf",
 ]
 
 
@@ -212,10 +218,17 @@ def main():
     )
 
     server = server.rstrip("/")
+    if "://" not in server:
+        server = "https://" + server
     if not server.endswith("/bigbluebutton/api"):
         server += "/bigbluebutton/api"
 
-    client = BBBApiClient(server, secret)
+    ctx = ssl.create_default_context()
+    if args.insecure:
+        ctx.check_hostname = False
+        ctx.verify_mode = ssl.CERT_NONE
+
+    client = BBBApiClient(server, secret, ssl_context=ctx)
 
     try:
         args.cmd(client, args)
@@ -228,6 +241,10 @@ def format(element, args):
         return format_compact(element)
     if args.format == "xml":
         return format_xml(element)
+    if args.format == "json":
+        return format_json(element, indent=2)
+    if args.format == "jsonline":
+        return format_json(element)
     return format_human(element)
 
 
@@ -242,7 +259,7 @@ def format_human(e, indent=""):
     result = indent + e.tag + ":"
     if e.tag.lower() in ("starttime", "endtime"):
         value = "%s (%s)" % (
-            datetime.datetime.utcfromtimestamp(float(value) / 1000),
+            datetime.datetime.fromtimestamp(float(value) / 1000, datetime.timezone.utc),
             value,
         )
     if value:
@@ -266,6 +283,40 @@ def format_xml(e):
     return ET.tostring(e, encoding="unicode")
 
 
+def format_json(e, *a, **ka):
+    return json.dumps(_unpack_xml(e), *a, **ka)
+
+
+_should_be_list = ["attendees"]
+_should_be_number = [
+    "createTime",
+    "duration",
+    "startTime",
+    "endTime",
+    "participantCount",
+    "listenerCount",
+    "voiceParticipantCount",
+    "videoCount",
+    "maxUsers",
+    "moderatorCount",
+]
+
+
+def _unpack_xml(e):
+    if e.tag in _should_be_list:
+        return [_unpack_xml(c) for c in e if e.tag]
+    if len(e):
+        return {c.tag: _unpack_xml(c) for c in e if c.tag}
+    value = e.text and e.text.strip()
+    if e.tag in _should_be_number:
+        return int(value)
+    if not value:
+        return None
+    if value in ("true", "false"):
+        return value == "true"
+    return value
+
+
 def cmd_rec_list(api, args):
     opts = {}
     if args.meeting:
@@ -322,23 +373,17 @@ def cmd_meet_create(api, args):
             link = api.getJoinLink(
                 meetingID=args.id,
                 fullName=name,
+                createTime=created.find("createTime").text,
                 password=created.find("moderatorPW").text,
             )
         print(name + ":", link)
 
 
 def cmd_meet_join(api, args):
+    meeting = api.getMeetingInfo(meetingID=args.id)
     query = {"meetingID": args.id, "fullName": args.name}
-
-    if args.mod:
-        query["password"] = (
-            api.getMeetingInfo(meetingID=args.id).find("moderatorPW").text
-        )
-    else:
-        query["password"] = (
-            api.getMeetingInfo(meetingID=args.id).find("attendeePW").text
-        )
-
+    query["createTime"] = meeting.find("createTime").text
+    query["role"] = "MODERATOR" if args.mod else "VIEWER"
     link = api.getJoinLink(**query)
 
     if args.open: