Skip to content

cocorum.servicephp

The primary use from this module is the ServicePHP class, a wrapper for Rumble's internal service.php API. Login is performed via this API, as well as most Rumble functions other than chat messaging and video upload. All other classes are supporting sub-classes.

Service.PHP interactions

Control Rumble via Service.PHP

Copyright 2025 Wilbur Jaywright.

This file is part of Cocorum.

Cocorum is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Cocorum 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with Cocorum. If not, see https://www.gnu.org/licenses/.

S.D.G.

APIComment

Bases: JSONObj, BaseComment

A comment on a video as returned by a successful attempt to make it

Source code in cocorum/servicephp.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class APIComment(JSONObj, BaseComment):
    """A comment on a video as returned by a successful attempt to make it"""
    def __init__(self, jsondata, servicephp):
        """A comment on a video as returned by a successful attempt to make it

    Args:
        jsondata (dict): The JSON block for a single comment.
        servicephp (ServicePHP): The ServicePHP object that spawned us.
        """

        JSONObj.__init__(self, jsondata)
        self.servicephp = servicephp

        # Badges of the user who commented if we have them
        if self.get("comment_user_badges"):
            self.user_badges = {slug : APIUserBadge(slug, data) for slug, data in self["comment_user_badges"].items()}

    @property
    def comment_id(self):
        """The numeric ID of the comment"""
        return int(self["comment_id"])

    @property
    def text(self):
        """The text of the comment"""
        return self["comment_text"]

    @property
    def user_display(self):
        """The display name of the user who commented"""
        return self["comment_user_display"]

    @property
    def tree_size(self):
        """TODO"""
        return self["comment_tree_size"]

comment_id property

The numeric ID of the comment

text property

The text of the comment

tree_size property

TODO

user_display property

The display name of the user who commented

__init__(jsondata, servicephp)

A comment on a video as returned by a successful attempt to make it

Parameters:

Name Type Description Default
jsondata dict

The JSON block for a single comment.

 required
servicephp ServicePHP

The ServicePHP object that spawned us.

 required
Source code in cocorum/servicephp.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def __init__(self, jsondata, servicephp):
    """A comment on a video as returned by a successful attempt to make it

Args:
    jsondata (dict): The JSON block for a single comment.
    servicephp (ServicePHP): The ServicePHP object that spawned us.
    """

    JSONObj.__init__(self, jsondata)
    self.servicephp = servicephp

    # Badges of the user who commented if we have them
    if self.get("comment_user_badges"):
        self.user_badges = {slug : APIUserBadge(slug, data) for slug, data in self["comment_user_badges"].items()}

APIContentVotes

Bases: JSONObj, BaseContentVotes

Votes made on content

Source code in cocorum/servicephp.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
class APIContentVotes(JSONObj, BaseContentVotes):
    """Votes made on content"""

    def __str__(self):
        """The string form of the content votes"""
        return self.score_formatted

    @property
    def num_votes_up(self):
        """Upvotes on the content"""
        return self._jsondata.get("num_votes_up", 0)

    @property
    def num_votes_down(self):
        """Downvotes on the content"""
        return self._jsondata.get("num_votes_down", 0)

    @property
    def score(self):
        """Summed score of the content"""
        return self["score"]

    @property
    def votes(self):
        """The total number of votes on the content"""
        if not self["votes"]:
            return 0
        return self["votes"]

    @property
    def num_votes_up_formatted(self):
        """The upvotes on the content, formatted into a string"""
        return self._jsondata.get("num_votes_up_formatted", "0")

    @property
    def num_votes_down_formatted(self):
        """The downvotes on the content, formatted into a string"""
        return self._jsondata.get("num_votes_down_formatted", "0")

    @property
    def score_formatted(self):
        """The total votes on the content, formatted into a string"""
        return self._jsondata.get("score_formatted", "0")

    @property
    def content_type(self):
        """The type of content being voted on"""
        return self["content_type"]

    @property
    def content_id(self):
        """The numerical ID of the content being voted on"""
        return self["content_id"]

content_id property

The numerical ID of the content being voted on

content_type property

The type of content being voted on

num_votes_down property

Downvotes on the content

num_votes_down_formatted property

The downvotes on the content, formatted into a string

num_votes_up property

Upvotes on the content

num_votes_up_formatted property

The upvotes on the content, formatted into a string

score property

Summed score of the content

score_formatted property

The total votes on the content, formatted into a string

votes property

The total number of votes on the content

__str__()

The string form of the content votes

Source code in cocorum/servicephp.py 
90
91
92
def __str__(self):
    """The string form of the content votes"""
    return self.score_formatted

APIPlaylist

Bases: JSONObj, BasePlaylist

Playlist as returned by the API

Source code in cocorum/servicephp.py 
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
class APIPlaylist(JSONObj, BasePlaylist):
    """Playlist as returned by the API"""
    def __init__(self, jsondata, servicephp):
        """Playlist as returned by the API.

    Args:
        jsondata (dict): The JSON data block of a playlist.
        servicephp (ServicePHP): The ServicePHP object that spawned us.
        """

        JSONObj.__init__(self, jsondata)
        self.servicephp = servicephp
        self.user = APIUser(jsondata["user"], self.servicephp)

    @property
    def playlist_id(self):
        """The numeric playlist ID in base 64"""
        return self["id"]

    @property
    def title(self):
        """The title of the playlist"""
        return self["title"]

    @property
    def description(self):
        """The description of the playlist"""
        return self["description"]

    @property
    def visibility(self):
        """The visibility of the playlist"""
        return self["visibility"]

    @property
    def url(self):
        """The URL of the playlist"""
        return self["url"]

    @property
    def channel(self):
        """The channel the playlist is under, can be None"""
        return self["channel"]

    @property
    def created_on(self):
        """The time the playlist was created in seconds since epoch"""
        return utils.parse_timestamp(self["created_on"])

    @property
    def updated_on(self):
        """The time the playlist was last updated in seconds since epoch"""
        return utils.parse_timestamp(self["updated_on"])

    @property
    def permissions(self):
        """The permissions the ServicePHP user has on this playlist"""
        return self["permissions"]

    @property
    def num_items(self):
        """The number of items in the playlist"""
        return self["num_items"]

    @property
    def is_following(self):
        """TODO -> Bool"""
        return self["is_following"]

    @property
    def items(self):
        """The items of the playlist. TODO"""
        return self["items"]

    @property
    def extra(self):
        """TODO -> None, unknown"""
        return self["extra"]

channel property

The channel the playlist is under, can be None

created_on property

The time the playlist was created in seconds since epoch

description property

The description of the playlist

extra property

TODO -> None, unknown

is_following property

TODO -> Bool

items property

The items of the playlist. TODO

num_items property

The number of items in the playlist

permissions property

The permissions the ServicePHP user has on this playlist

playlist_id property

The numeric playlist ID in base 64

title property

The title of the playlist

updated_on property

The time the playlist was last updated in seconds since epoch

url property

The URL of the playlist

visibility property

The visibility of the playlist

__init__(jsondata, servicephp)

Playlist as returned by the API.

Parameters:

Name Type Description Default
jsondata dict

The JSON data block of a playlist.

 required
servicephp ServicePHP

The ServicePHP object that spawned us.

 required
Source code in cocorum/servicephp.py 
213
214
215
216
217
218
219
220
221
222
223
def __init__(self, jsondata, servicephp):
    """Playlist as returned by the API.

Args:
    jsondata (dict): The JSON data block of a playlist.
    servicephp (ServicePHP): The ServicePHP object that spawned us.
    """

    JSONObj.__init__(self, jsondata)
    self.servicephp = servicephp
    self.user = APIUser(jsondata["user"], self.servicephp)

APIUser

Bases: JSONObj, BaseUser

User data as returned by the API

Source code in cocorum/servicephp.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
class APIUser(JSONObj, BaseUser):
    """User data as returned by the API"""
    def __init__(self, jsondata, servicephp):
        """User data as returned by the API.

    Args:
        jsondata (dict): The JSON data block of a single user.
        servicephp (ServicePHP): The ServicePHP object that spawned us.
        """

        JSONObj.__init__(self, jsondata)
        self.servicephp = servicephp

        # Our profile picture data
        self.__picture = None

    @property
    def user_id(self):
        """The numeric ID of the user in base 10"""
        return self["id"]

    @property
    def user_id_b10(self):
        """The numeric ID of the user in base 10"""
        return self.user_id

    @property
    def user_id_b36(self):
        """The numeric ID of the user in base 36"""
        return utils.base_10_to_36(self.user_id)

    @property
    def username(self):
        """The username of the user"""
        return self["username"]

    @property
    def picture_url(self):
        """The URL of the user's profile picture"""
        return self["picture"]

    @property
    def picture(self):
        """The user's profile picture as a bytes string"""
        if not self.picture_url: # The profile picture is blank
            return b''

        if not self.__picture: # We never queried the profile pic before
            response = requests.get(self.picture_url, timeout = static.Delays.request_timeout)
            assert response.status_code == 200, "Status code " + str(response.status_code)

            self.__picture = response.content

        return self.__picture

    @property
    def verified_badge(self):
        """Is the user verified?"""
        return self["verified_badge"]

    @property
    def followers(self):
        """The number of followers this user has"""
        return self["followers"]

    @property
    def followed(self):
        """TODO -> Bool"""
        return self["followed"]

followed property

TODO -> Bool

followers property

The number of followers this user has

picture property

The user's profile picture as a bytes string

picture_url property

The URL of the user's profile picture

user_id property

The numeric ID of the user in base 10

user_id_b10 property

The numeric ID of the user in base 10

user_id_b36 property

The numeric ID of the user in base 36

username property

The username of the user

verified_badge property

Is the user verified?

__init__(jsondata, servicephp)

User data as returned by the API.

Parameters:

Name Type Description Default
jsondata dict

The JSON data block of a single user.

 required
servicephp ServicePHP

The ServicePHP object that spawned us.

 required
Source code in cocorum/servicephp.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
def __init__(self, jsondata, servicephp):
    """User data as returned by the API.

Args:
    jsondata (dict): The JSON data block of a single user.
    servicephp (ServicePHP): The ServicePHP object that spawned us.
    """

    JSONObj.__init__(self, jsondata)
    self.servicephp = servicephp

    # Our profile picture data
    self.__picture = None

APIUserBadge

Bases: JSONObj, BaseUserBadge

A badge of a user as returned by the API

Source code in cocorum/servicephp.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class APIUserBadge(JSONObj, BaseUserBadge):
    """A badge of a user as returned by the API"""
    def __init__(self, slug, jsondata):
        """A badge of a user as returned by the API.

    Args:
        slug (str): The string identifier of the badge.
        jsondata (dict): The JSON data block of the badge.
        """

        JSONObj.__init__(self, jsondata)
        self.slug = slug # The unique identification for this badge
        self.__icon = None

    @property
    def label(self):
        """A dictionary of lang:label pairs"""
        return self["label"]

    @property
    def icon_url(self):
        """The URL of the badge's icon"""
        return static.URI.rumble_base + self["icons"][static.Misc.badge_icon_size]

icon_url property

The URL of the badge's icon

label property

A dictionary of lang:label pairs

__init__(slug, jsondata)

A badge of a user as returned by the API.

Parameters:

Name Type Description Default
slug str

The string identifier of the badge.

 required
jsondata dict

The JSON data block of the badge.

 required
Source code in cocorum/servicephp.py 
28
29
30
31
32
33
34
35
36
37
38
def __init__(self, slug, jsondata):
    """A badge of a user as returned by the API.

Args:
    slug (str): The string identifier of the badge.
    jsondata (dict): The JSON data block of the badge.
    """

    JSONObj.__init__(self, jsondata)
    self.slug = slug # The unique identification for this badge
    self.__icon = None

BaseComment

A comment on a Rumble video

Source code in cocorum/basehandles.py 
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
class BaseComment:
    """A comment on a Rumble video"""
    def __int__(self):
        """The comment in integer form (its ID)"""
        return self.comment_id

    def __str__(self):
        """The comment as a string (its text)"""
        return self.text

    @property
    def comment_id_b10(self):
        """The base 10 ID of the comment"""
        return self.comment_id

    @property
    def comment_id_b36(self):
        """The base 36 ID of the comment"""
        return utils.base_10_to_36(self.comment_id)

    def __eq__(self, other):
        """Determine if this comment is equal to another.

    Args:
        other (int, str, HTMLComment, APIComment): Object to compare to.

    Returns:
        Comparison (bool, None): Did it fit the criteria?
        """

        # Check for direct matches first
        if isinstance(other, int):
            return self.comment_id_b10 == other
        if isinstance(other, str):
            return str(self) == other

        # Check for object attributes to match to
        if hasattr(other, "comment_id_b10"):
            return self.comment_id_b10 == other.comment_id_b10

        # Check conversion to integer last
        if hasattr(other, "__int__"):
            return self.comment_id_b10 == int(other)

        return False

    def pin(self, unpin: bool = False):
        """Pin or unpin this comment.

    Args:
        unpin (bool): If true, unpins instead of pinning comment.
        """

        return self.servicephp.comment_pin(self, unpin)

    def delete(self):
        """Delete this comment"""

        return self.servicephp.comment_delete(self)

    def restore(self):
        """Un-delete this comment"""

        return self.servicephp.comment_restore(self)

    def set_rumbles(self, vote: int):
        """Post a like or dislike on this comment.

    Args:
        vote (int): -1, 0, or 1 (0 means clear vote).
        """

        return self.servicephp.rumbles(vote, self, item_type = 2)

comment_id_b10 property

The base 10 ID of the comment

comment_id_b36 property

The base 36 ID of the comment

__eq__(other)

Determine if this comment is equal to another.

Parameters:

Name Type Description Default
other (int, str, HTMLComment, APIComment)

Object to compare to.

 required

Returns:

Name Type Description
Comparison (bool, None)

Did it fit the criteria?
Source code in cocorum/basehandles.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def __eq__(self, other):
    """Determine if this comment is equal to another.

Args:
    other (int, str, HTMLComment, APIComment): Object to compare to.

Returns:
    Comparison (bool, None): Did it fit the criteria?
    """

    # Check for direct matches first
    if isinstance(other, int):
        return self.comment_id_b10 == other
    if isinstance(other, str):
        return str(self) == other

    # Check for object attributes to match to
    if hasattr(other, "comment_id_b10"):
        return self.comment_id_b10 == other.comment_id_b10

    # Check conversion to integer last
    if hasattr(other, "__int__"):
        return self.comment_id_b10 == int(other)

    return False

__int__()

The comment in integer form (its ID)

Source code in cocorum/basehandles.py 
62
63
64
def __int__(self):
    """The comment in integer form (its ID)"""
    return self.comment_id

__str__()

The comment as a string (its text)

Source code in cocorum/basehandles.py 
66
67
68
def __str__(self):
    """The comment as a string (its text)"""
    return self.text

delete()

Delete this comment

Source code in cocorum/basehandles.py 
115
116
117
118
def delete(self):
    """Delete this comment"""

    return self.servicephp.comment_delete(self)

pin(unpin=False)

Pin or unpin this comment.

Parameters:

Name Type Description Default
unpin bool

If true, unpins instead of pinning comment.

 False
Source code in cocorum/basehandles.py 
106
107
108
109
110
111
112
113
def pin(self, unpin: bool = False):
    """Pin or unpin this comment.

Args:
    unpin (bool): If true, unpins instead of pinning comment.
    """

    return self.servicephp.comment_pin(self, unpin)

restore()

Un-delete this comment

Source code in cocorum/basehandles.py 
120
121
122
123
def restore(self):
    """Un-delete this comment"""

    return self.servicephp.comment_restore(self)

set_rumbles(vote)

Post a like or dislike on this comment.

Parameters:

Name Type Description Default
vote int

-1, 0, or 1 (0 means clear vote).

 required
Source code in cocorum/basehandles.py 
125
126
127
128
129
130
131
132
def set_rumbles(self, vote: int):
    """Post a like or dislike on this comment.

Args:
    vote (int): -1, 0, or 1 (0 means clear vote).
    """

    return self.servicephp.rumbles(vote, self, item_type = 2)

BaseContentVotes

Likes and dislikes on a video or comment

Source code in cocorum/basehandles.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
class BaseContentVotes:
    """Likes and dislikes on a video or comment"""

    def __int__(self):
        """The integer form of the content votes"""
        return self.score

    def __eq__(self, other):
        """Determine if this content votes is equal to another.

    Args:
        other (int, str, HTMLContentVotes): Object to compare to.

    Returns:
        Comparison (bool, None): Did it fit the criteria?
        """

        # Check for direct matches first
        if isinstance(other, int):
            return self.score == other
        if isinstance(other, str):
            return str(self) == other

        # Check for object attributes to match to
        if hasattr(other, "score"):
            return self.score == other.score

        # Check conversion to integer last
        if hasattr(other, "__int__"):
            return self.score == int(other)

        return False

__eq__(other)

Determine if this content votes is equal to another.

Parameters:

Name Type Description Default
other (int, str, HTMLContentVotes)

Object to compare to.

 required

Returns:

Name Type Description
Comparison (bool, None)

Did it fit the criteria?
Source code in cocorum/basehandles.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def __eq__(self, other):
    """Determine if this content votes is equal to another.

Args:
    other (int, str, HTMLContentVotes): Object to compare to.

Returns:
    Comparison (bool, None): Did it fit the criteria?
    """

    # Check for direct matches first
    if isinstance(other, int):
        return self.score == other
    if isinstance(other, str):
        return str(self) == other

    # Check for object attributes to match to
    if hasattr(other, "score"):
        return self.score == other.score

    # Check conversion to integer last
    if hasattr(other, "__int__"):
        return self.score == int(other)

    return False

__int__()

The integer form of the content votes

Source code in cocorum/basehandles.py 
137
138
139
def __int__(self):
    """The integer form of the content votes"""
    return self.score

BasePlaylist

A playlist of Rumble videos

Source code in cocorum/basehandles.py 
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
class BasePlaylist:
    """A playlist of Rumble videos"""

    def __int__(self):
        """The playlist as an integer (it's ID in base 10)"""
        return self.playlist_id_b10

    def __str__(self):
        """The playlist as a string (it's ID in base 64)"""
        return self.playlist_id_b64

    def __eq__(self, other):
        """Determine if this playlist is equal to another.

    Args:
        other (int, str, HTMLPlaylist): Object to compare to.

    Returns:
        Comparison (bool, None): Did it fit the criteria?
        """

        # Check for direct matches first
        if isinstance(other, int):
            return self.playlist_id_b64 == other
        if isinstance(other, str):
            return str(other) == self.playlist_id_b64

        # # Check for object attributes to match to
        # if hasattr(other, "playlist_id_b10"):
        #     return self.playlist_id_b10 == other.playlist_id_b10

        # # Check conversion to integer last, in case another ID or something happens to match
        # if hasattr(other, "__int__"):
        #     return self.playlist_id_b10 == int(other)

        return False

    @property
    def playlist_id_b64(self):
        """The numeric ID of the playlist in base 64"""
        return self.playlist_id

    @property
    def playlist_id_b10(self):
        """The numeric ID of the playlist in base 10"""
        raise NotImplementedError("See Cocorum issue #22")
        # return utils.base_36_to_10(self.playlist_id)

    def add_video(self, video_id):
        """Add a video to this playlist

    Args:
        video_id (int, str): The numeric ID of the video to add, in base 10 or 36.
        """

        return self.servicephp.playlist_add_video(self.playlist_id, video_id)

    def delete_video(self, video_id):
        """Remove a video from this playlist

    Args:
        video_id (int, str): The numeric ID of the video to remove, in base 10 or 36.
        """

        self.servicephp.playlist_delete_video(self.playlist_id, video_id)

    def edit(self, title: str = None, description: str = None, visibility: str = None, channel_id = None):
        """Edit the details of this playlist. WARNING: The original object will probably be stale after this operation.

    Args:
        title (str): The title of the playlist.
            Defaults to staying the same.
        description (str): Describe the playlist.
            Defaults to staying the same.
        visibility (str): Set to public, unlisted, or private via string.
            Defaults to staying the same.
        channel_id (int | str | None): The ID of the channel to have the playlist under. TODO: Cannot be retrieved!
            Defaults to resetting to None.

    Returns:
        playlist (APIPlaylist): The edit result.
        """

        if title is None:
            title = self.title
        if description is None:
            description = self.description
        if visibility is None:
            visibility = self.visibility
        # if channel_id is False:
        #     channel_id = self.channel_id

        return self.servicephp.playlist_edit(self.playlist_id, title, description, visibility, channel_id)

    def delete(self):
        """Delete this playlist"""

        self.servicephp.playlist_delete(self)

playlist_id_b10 property

The numeric ID of the playlist in base 10

playlist_id_b64 property

The numeric ID of the playlist in base 64

__eq__(other)

Determine if this playlist is equal to another.

Parameters:

Name Type Description Default
other (int, str, HTMLPlaylist)

Object to compare to.

 required

Returns:

Name Type Description
Comparison (bool, None)

Did it fit the criteria?
Source code in cocorum/basehandles.py 
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
def __eq__(self, other):
    """Determine if this playlist is equal to another.

Args:
    other (int, str, HTMLPlaylist): Object to compare to.

Returns:
    Comparison (bool, None): Did it fit the criteria?
    """

    # Check for direct matches first
    if isinstance(other, int):
        return self.playlist_id_b64 == other
    if isinstance(other, str):
        return str(other) == self.playlist_id_b64

    # # Check for object attributes to match to
    # if hasattr(other, "playlist_id_b10"):
    #     return self.playlist_id_b10 == other.playlist_id_b10

    # # Check conversion to integer last, in case another ID or something happens to match
    # if hasattr(other, "__int__"):
    #     return self.playlist_id_b10 == int(other)

    return False

__int__()

The playlist as an integer (it's ID in base 10)

Source code in cocorum/basehandles.py 
229
230
231
def __int__(self):
    """The playlist as an integer (it's ID in base 10)"""
    return self.playlist_id_b10

__str__()

The playlist as a string (it's ID in base 64)

Source code in cocorum/basehandles.py 
233
234
235
def __str__(self):
    """The playlist as a string (it's ID in base 64)"""
    return self.playlist_id_b64

add_video(video_id)

Add a video to this playlist

Parameters:

Name Type Description Default
video_id (int, str)

The numeric ID of the video to add, in base 10 or 36.

 required
Source code in cocorum/basehandles.py 
274
275
276
277
278
279
280
281
def add_video(self, video_id):
    """Add a video to this playlist

Args:
    video_id (int, str): The numeric ID of the video to add, in base 10 or 36.
    """

    return self.servicephp.playlist_add_video(self.playlist_id, video_id)

delete()

Delete this playlist

Source code in cocorum/basehandles.py 
320
321
322
323
def delete(self):
    """Delete this playlist"""

    self.servicephp.playlist_delete(self)

delete_video(video_id)

Remove a video from this playlist

Parameters:

Name Type Description Default
video_id (int, str)

The numeric ID of the video to remove, in base 10 or 36.

 required
Source code in cocorum/basehandles.py 
283
284
285
286
287
288
289
290
def delete_video(self, video_id):
    """Remove a video from this playlist

Args:
    video_id (int, str): The numeric ID of the video to remove, in base 10 or 36.
    """

    self.servicephp.playlist_delete_video(self.playlist_id, video_id)

edit(title=None, description=None, visibility=None, channel_id=None)

Edit the details of this playlist. WARNING: The original object will probably be stale after this operation.

Parameters:

Name Type Description Default
title str

The title of the playlist. Defaults to staying the same.

 None
description str

Describe the playlist. Defaults to staying the same.

 None
visibility str

Set to public, unlisted, or private via string. Defaults to staying the same.

 None
channel_id int | str | None

The ID of the channel to have the playlist under. TODO: Cannot be retrieved! Defaults to resetting to None.

 None

Returns:

Name Type Description
playlist APIPlaylist

The edit result.
Source code in cocorum/basehandles.py 
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
def edit(self, title: str = None, description: str = None, visibility: str = None, channel_id = None):
    """Edit the details of this playlist. WARNING: The original object will probably be stale after this operation.

Args:
    title (str): The title of the playlist.
        Defaults to staying the same.
    description (str): Describe the playlist.
        Defaults to staying the same.
    visibility (str): Set to public, unlisted, or private via string.
        Defaults to staying the same.
    channel_id (int | str | None): The ID of the channel to have the playlist under. TODO: Cannot be retrieved!
        Defaults to resetting to None.

Returns:
    playlist (APIPlaylist): The edit result.
    """

    if title is None:
        title = self.title
    if description is None:
        description = self.description
    if visibility is None:
        visibility = self.visibility
    # if channel_id is False:
    #     channel_id = self.channel_id

    return self.servicephp.playlist_edit(self.playlist_id, title, description, visibility, channel_id)

BaseUser

A Rumble user

Source code in cocorum/basehandles.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
class BaseUser:
    """A Rumble user"""

    def __int__(self):
        """The user as an integer (it's ID in base 10)"""
        return self.user_id_b10

    def __eq__(self, other):
        """Determine if this user is equal to another.

    Args:
        other (int, str, APIUser): Object to compare to.

    Returns:
        Comparison (bool, None): Did it fit the criteria?
        """

        #Check for direct matches first
        if isinstance(other, int):
            return self.user_id_b10 == other
        if isinstance(other, str):
            return str(other) in (self.user_id_b36, self.username)

        #Check for object attributes to match to
        if hasattr(other, "user_id"):
            return self.user_id_b10 == utils.ensure_b10(other.user_id)

        #Check conversion to integer last, in case another ID or something happens to match
        if hasattr(other, "__int__"):
            return self.user_id_b10 == int(other)

        return False

    @property
    def user_id_b10(self):
        """The numeric ID of the user in base 10"""
        return self.user_id

    @property
    def user_id_b36(self):
        """The numeric ID of the user in base 36"""
        return utils.base_10_to_36(self.user_id)

    def mute(self, duration: int = None, total: bool = False):
        """Mute this user.

    Args:
        duration (int): How long to mute the user in seconds.
            Defaults to infinite.
        total (bool): Wether or not they are muted across all videos.
            Defaults to False, just this video.
            """

        self.servicephp.mute(self, self.username, duration, total)

    def unmute(self):
        """Unmute this user."""
        self.servicephp.unmute(self.username)

user_id_b10 property

The numeric ID of the user in base 10

user_id_b36 property

The numeric ID of the user in base 36

__eq__(other)

Determine if this user is equal to another.

Parameters:

Name Type Description Default
other (int, str, APIUser)

Object to compare to.

 required

Returns:

Name Type Description
Comparison (bool, None)

Did it fit the criteria?
Source code in cocorum/basehandles.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
def __eq__(self, other):
    """Determine if this user is equal to another.

Args:
    other (int, str, APIUser): Object to compare to.

Returns:
    Comparison (bool, None): Did it fit the criteria?
    """

    #Check for direct matches first
    if isinstance(other, int):
        return self.user_id_b10 == other
    if isinstance(other, str):
        return str(other) in (self.user_id_b36, self.username)

    #Check for object attributes to match to
    if hasattr(other, "user_id"):
        return self.user_id_b10 == utils.ensure_b10(other.user_id)

    #Check conversion to integer last, in case another ID or something happens to match
    if hasattr(other, "__int__"):
        return self.user_id_b10 == int(other)

    return False

__int__()

The user as an integer (it's ID in base 10)

Source code in cocorum/basehandles.py 
170
171
172
def __int__(self):
    """The user as an integer (it's ID in base 10)"""
    return self.user_id_b10

mute(duration=None, total=False)

Mute this user.

Parameters:

Name Type Description Default
duration int

How long to mute the user in seconds. Defaults to infinite.

 None
total bool

Wether or not they are muted across all videos. Defaults to False, just this video.

 False
Source code in cocorum/basehandles.py 
210
211
212
213
214
215
216
217
218
219
220
def mute(self, duration: int = None, total: bool = False):
    """Mute this user.

Args:
    duration (int): How long to mute the user in seconds.
        Defaults to infinite.
    total (bool): Wether or not they are muted across all videos.
        Defaults to False, just this video.
        """

    self.servicephp.mute(self, self.username, duration, total)

unmute()

Unmute this user.

Source code in cocorum/basehandles.py 
222
223
224
def unmute(self):
    """Unmute this user."""
    self.servicephp.unmute(self.username)

BaseUserBadge

A badge on a username

Source code in cocorum/basehandles.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
class BaseUserBadge:
    """A badge on a username"""
    def __eq__(self, other):
        """Check if this badge is equal to another.

    Args:
        other (str, HTMLUserBadge): Object to compare to.

    Returns:
        Comparison (bool, None): Did it fit the criteria?
        """

        # Check if the string is either our slug or our label in any language
        if isinstance(other, str):
            return other in (self.slug, self.label.values())

        # Check if the compared object has the same slug, if it has one
        if hasattr(other, "slug"):
            return self.slug == other.slug

        return False

    def __str__(self):
        """The chat user badge in string form"""
        return self.slug

    @property
    def icon(self):
        """The badge's icon as a bytestring"""
        if not self.__icon:  # We never queried the icon before
            # TODO make the timeout configurable
            response = requests.get(self.icon_url, timeout = static.Delays.request_timeout)
            assert response.status_code == 200, "Status code " + str(response.status_code)

            self.__icon = response.content

        return self.__icon

icon property

The badge's icon as a bytestring

__eq__(other)

Check if this badge is equal to another.

Parameters:

Name Type Description Default
other (str, HTMLUserBadge)

Object to compare to.

 required

Returns:

Name Type Description
Comparison (bool, None)

Did it fit the criteria?
Source code in cocorum/basehandles.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def __eq__(self, other):
    """Check if this badge is equal to another.

Args:
    other (str, HTMLUserBadge): Object to compare to.

Returns:
    Comparison (bool, None): Did it fit the criteria?
    """

    # Check if the string is either our slug or our label in any language
    if isinstance(other, str):
        return other in (self.slug, self.label.values())

    # Check if the compared object has the same slug, if it has one
    if hasattr(other, "slug"):
        return self.slug == other.slug

    return False

__str__()

The chat user badge in string form

Source code in cocorum/basehandles.py 
44
45
46
def __str__(self):
    """The chat user badge in string form"""
    return self.slug

ServicePHP

Interact with Rumble's service.php API

Source code in cocorum/servicephp.py 
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
class ServicePHP:
    """Interact with Rumble's service.php API"""
    def __init__(self, username: str, password: str = None, session = None):
        """Interact with Rumble's service.php API.

    Args:
        username (str): The username we will be under.
        password (str): The password to use at login.
            Defaults to using the session token/cookie instead.
        session (str, dict): The session token or cookie dict to authenticate with.
            Defaults to using the password instead.
            """

        # Save the username
        self.username = username

        # Session is the token directly
        if isinstance(session, str):
            self.session_cookie = {static.Misc.session_token_key, session}

        # Session is a cookie dict
        elif isinstance(session, dict):
            assert session.get(static.Misc.session_token_key), f"Session cookie dict must have '{static.Misc.session_token_key}' as key."
            self.session_cookie = session

        # Session was passed but it is not anything we can use
        elif session is not None:
            raise ValueError(f"Session must be a token str or cookie dict, got {type(session)}")

        # Session was not passed, but credentials were
        elif username and password:
            self.session_cookie = self.login(username, password)

        # Neither session nor credentials were passed:
        else:
            raise ValueError("Must pass either userame and password, or a session token")

        assert utils.test_session_cookie(self.session_cookie), "Session cookie is invalid."

        # Stored ID of the logged in user
        self.__user_id = None

    @property
    def user_id(self):
        """The numeric ID of the logged in user in base 10"""
        # We do not have a user ID, extract it from the unread notifications response
        if self.__user_id is None:
            j = self.sphp_request(
                "user.has_unread_notifications",
                method = "GET",
                ).json()
            self.__user_id = utils.base_36_to_10(j["user"]["id"].removeprefix("_"))

        return self.__user_id

    @property
    def user_id_b10(self):
        """The numeric ID of the logged in user in base 10"""
        return self.user_id

    @property
    def user_id_b36(self):
        """The numeric ID of the logged in user in base 36"""
        return utils.base_10_to_36(self.user_id)

    def sphp_request(self, service_name: str, data: dict = {}, additional_params: dict = {}, logged_in = True, method = "POST"):
        """Make a request to Service.PHP with common settings
        service_name: The name parameter of the specific PHP service
        data: Form data
        additional_params: Any additional query string parameters
        logged_in: The request should use the session cookie"""
        params = {"name" : service_name}
        params.update(additional_params)
        r = requests.request(
                method,
                static.URI.servicephp,
                params = params,
                data = data,
                headers = static.RequestHeaders.user_agent,
                cookies = self.session_cookie if logged_in else None,
                timeout = static.Delays.request_timeout,
                )
        assert r.status_code == 200, f"Service.PHP request for {service_name} failed: {r}\n{r.text}"
        # If the request json has a data -> success value, make sure it is True
        d = r.json().get("data")
        if isinstance(d, dict):
            assert d.get("success", True), f"Service.PHP request for {service_name} failed: \n{r.text}"
        # Data was not a dict but was not empty
        elif d:
            print(f"Service.PHP request for {service_name} did not fail but returned unknown data type {type(d)}: {d}")

        return r

    def login(self, username: str, password: str):
        """Log in to Rumble

    Args:
        username (str): Username to sign in with.
        password (str): Password to sign in with.

    Returns:
        Cookie (dict): Cookie dict to be passed with requests, which authenticates them.
        """

        # Get salts
        r = self.sphp_request(
                "user.get_salts",
                data = {"username": username},
                logged_in = False,
                )
        salts = r.json()["data"]["salts"]

        # Get session token
        r = self.sphp_request(
                "user.login",
                data = {
                    "username": username,

                    # Hash the password using the salts
                    "password_hashes": ",".join(utils.calc_password_hashes(password, salts)),
                    },
                logged_in = False,
                )
        j = r.json()
        session_token = j["data"]["session"]
        assert session_token, f"Login failed: No token returned\n{r.json()}"

        return {static.Misc.session_token_key: session_token}

    def chat_pin(self, stream_id, message, unpin: bool = False):
        """Pin or unpin a message in a chat.

    Args:
        stream_id (int, str): ID of the stream in base 10 or 36.
        message (int): Converting this to int must return a chat message ID.
        unpin (bool): If true, unpins a message instead of pinning it.
        """

        self.sphp_request(
            f"chat.message.{"un" * unpin}pin",
            data = {
                "video_id": utils.ensure_b10(stream_id),
                "message_id": int(message),
                },
            )

    def mute_user(self, username: str, is_channel: bool = False, video: int = None, duration: int = None, total: bool = False):
        """Mute a user or channel by name.

    Args:
        username (str): The user to mute.
        is_channel (bool): Is this a channel name rather than a username?
        video (int): The video to mute the user on.
            Defaults to None.
        duration (int): How long the user will be muted for, in seconds.
            Defaults to infinity.
        total (bool): Is this a mute across all videos?
            Defaults to False, requires video if False.
            """

        self.sphp_request(
            "moderation.mute",
            data = {
                "user_to_mute": username,
                "entity_type": ("user", "channel")[is_channel],
                "video": int(video),
                "duration": duration,
                "type": ("video", "total")[total],
                },
            )

    def unmute_user(self, record_id: int):
        """Unmute a user.

    Args:
        record_id: The numeric ID of the mute record to undo.
        """

        self.sphp_request(
            "moderation.unmute",
            data = {
                "record_id" : record_id,
                }
            )

    def _is_comment_elem(self, e):
        """Check if a beautifulsoup element is a comment.

    Args:
        e (bs4.Tag): The BeautifulSoup element to test.

    Returns:
        Result (bool): Did the element fit the criteria for being a comment?
        """

        return e.name == "li" and "comment-item" in e.get("class") and "comments-create" not in e.get("class")

    def comment_list(self, video_id):
        """Get the list of comments under a video.

    Args:
        video_id (str, int): The numeric ID of a video in base 10 or 36.

    Returns:
        Comments (list): A list of scraping.HTMLComment objects.
        """

        r = self.sphp_request(
            "comment.list",
            additional_params = {
                "video" : utils.ensure_b36(video_id),
                },
            method = "GET",
            )
        soup = bs4.BeautifulSoup(r.json()["html"], features = "html.parser")
        comment_elems = soup.find_all(self._is_comment_elem)
        return [scraping.HTMLComment(e, self) for e in comment_elems]

    def comment_add(self, video_id, comment: str, reply_id: int = 0):
        """Post a comment on a video.

    Args:
        video_id (int, str): The numeric ID of a video / stream in base 10 or 36.
        comment (str): What to say.
        reply_id (int): The ID of the comment to reply to.
            Defaults to zero (don't reply to anybody).

    Returns:
        Comment (APIComment): The comment, as parsed from the response data.
        """

        r = self.sphp_request(
                "comment.add",
                data = {
                    "video": int(utils.ensure_b10(video_id)),
                    "reply_id": int(reply_id),
                    "comment": str(comment),
                    "target": "comment-create-1",
                    },
                )
        return APIComment(r.json()["data"], self)

    def comment_pin(self, comment_id: int, unpin: bool = False):
        """Pin or unpin a comment by ID.

    Args:
        comment_id (int): The numeric ID of the comment to pin/unpin.
        unpin (bool): If true, unpins instead of pinning comment.
        """

        self.sphp_request(
            f"comment.{"un" * unpin}pin",
            data = {"comment_id": int(comment_id)},
            )

    def comment_delete(self, comment_id: int):
        """Delete a comment by ID.

    Args:
        comment_id (int): The numeric ID of the comment to delete.
        """

        self.sphp_request(
            "comment.delete",
            data = {"comment_id": int(comment_id)},
            )

    def comment_restore(self, comment_id: int):
        """Restore a deleted comment by ID.

    Args:
        comment_id (int): The numeric ID of the comment to restore.
        """

        r = self.sphp_request(
            "comment.restore",
            data = {"comment_id": int(comment_id)},
            )
        return APIComment(r.json()["data"], self)

    def rumbles(self, vote: int, item_id, item_type: int):
        """Post a like or dislike.

    Args:
        vote (int): -1, 0, or 1 (0 means clear vote).
        item_id (int): The numeric ID of whatever we are liking or disliking.
        item_type (int): 1 for video, 2 for comment.
        """

        r = self.sphp_request(
            "user.rumbles",
            data = {
                "type" : int(item_type),
                "id" : utils.ensure_b10(item_id),
                "vote" : int(vote),
                },
            )
        return APIContentVotes(r.json()["data"])

    def get_video_url(self, video_id):
        """Get the URL of a Rumble video.

    Args:
        video_id (int, str): The numeric ID of the video.

    Returns:
        URL (str): The URL of the video.
        """

        r = self.sphp_request(
            "media.share",
            additional_params = {
                "video" : utils.ensure_b36(video_id),
                "start" : 0,
                },
            method = "GET",
            )
        soup = bs4.BeautifulSoup(r.json()["html"], features = "html.parser")
        elem = soup.find("div", attrs = {"class" : "fb-share-button share-fb"})
        return elem.attrs["data-url"]

    def playlist_add_video(self, playlist_id: str, video_id):
        """Add a video to a playlist.

    Args:
        playlist_id (str): The numeric ID of the playlist in base 64.
        video_id (int, str): The numeric ID of the video to add, in base 10 or 36.
        """

        print(self.sphp_request(
            "playlist.add_video",
            data = {
                "playlist_id": str(playlist_id),
                "video_id": utils.ensure_b10(video_id),
                }
            ).text)

    def playlist_delete_video(self, playlist_id: str, video_id):
        """Remove a video from a playlist.

    Args:
        playlist_id (str): The numeric ID of the playlist in base 64.
        video_id (int, str): The numeric ID of the video to remove, in base 10 or 36.
        """

        print(self.sphp_request(
            "playlist.delete_video",
            data = {
                "playlist_id": str(playlist_id),
                "video_id": utils.ensure_b10(video_id),
                }
            ).text)

    def playlist_add(self, title: str, description: str = "", visibility: str = "public", channel_id = None):
        """Create a new playlist.

    Args:
        title (str): The title of the playlist.
        description (str): Describe the playlist.
            Defaults to nothing.
        visibility (str): Set to public, unlisted, or private via string.
            Defaults to 'public'.
        channel_id (int, str): The ID of the channel to create the playlist under.
            Defaults to none.

    Returns:
        Playlist (APIPlaylist): The playlist as parsed from the response data.
        """

        r = self.sphp_request(
            "playlist.add",
            data = {
                "title": str(title),
                "description": str(description),
                "visibility": str(visibility),
                "channel_id": str(utils.ensure_b10(channel_id)) if channel_id else None,
            }
        )
        return APIPlaylist(r.json()["data"], self)

    def playlist_edit(self, playlist_id: str, title: str, description: str = "", visibility: str = "public", channel_id = None):
        """Edit the details of an existing playlist

    Args:
        playlist_id (str): The numeric ID of the playlist to edit in base 64.
        title (str): The title of the playlist.
        description (str): Describe the playlist.
            Defaults to nothing.
        visibility (str): Set to public, unlisted, or private via string.
            Defaults to 'public'.
        channel_id (int, str): The ID of the channel to have the playlist under.
            Defaults to none.

    Returns:
        Playlist (APIPlaylist): The playlist as parsed from the response data.
        """

        r = self.sphp_request(
            "playlist.edit",
            data = {
                "title": str(title),
                "description": str(description),
                "visibility": str(visibility),
                "channel_id": str(utils.ensure_b10(channel_id)) if channel_id else None,
                "playlist_id": str(playlist_id),
            }
        )
        return APIPlaylist(r.json()["data"], self)

    def playlist_delete(self, playlist_id: str):
        """Delete a playlist.

    Args:
        playlist_id (str): The numeric ID of the playlist to delete in base 64.
        """

        print(self.sphp_request(
            "playlist.delete",
            data = {"playlist_id" : str(playlist_id)},
            ).text)

    def raid_confirm(self, stream_id):
        """Confirm a raid, previously set up by command.

    Args:
        stream_id (int, str): The numeric ID of the stream to confirm the raid from, in base 10 or 36.
        """

        self.sphp_request(
            "raid.confirm",
            data = {"video_id" : utils.ensure_b10(stream_id)},
            )

user_id property

The numeric ID of the logged in user in base 10

user_id_b10 property

The numeric ID of the logged in user in base 10

user_id_b36 property

The numeric ID of the logged in user in base 36

__init__(username, password=None, session=None)

Interact with Rumble's service.php API.

Parameters:

Name Type Description Default
username str

The username we will be under.

 required
password str

The password to use at login. Defaults to using the session token/cookie instead.

 None
session (str, dict)

The session token or cookie dict to authenticate with. Defaults to using the password instead.

 None
Source code in cocorum/servicephp.py 
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
def __init__(self, username: str, password: str = None, session = None):
    """Interact with Rumble's service.php API.

Args:
    username (str): The username we will be under.
    password (str): The password to use at login.
        Defaults to using the session token/cookie instead.
    session (str, dict): The session token or cookie dict to authenticate with.
        Defaults to using the password instead.
        """

    # Save the username
    self.username = username

    # Session is the token directly
    if isinstance(session, str):
        self.session_cookie = {static.Misc.session_token_key, session}

    # Session is a cookie dict
    elif isinstance(session, dict):
        assert session.get(static.Misc.session_token_key), f"Session cookie dict must have '{static.Misc.session_token_key}' as key."
        self.session_cookie = session

    # Session was passed but it is not anything we can use
    elif session is not None:
        raise ValueError(f"Session must be a token str or cookie dict, got {type(session)}")

    # Session was not passed, but credentials were
    elif username and password:
        self.session_cookie = self.login(username, password)

    # Neither session nor credentials were passed:
    else:
        raise ValueError("Must pass either userame and password, or a session token")

    assert utils.test_session_cookie(self.session_cookie), "Session cookie is invalid."

    # Stored ID of the logged in user
    self.__user_id = None

chat_pin(stream_id, message, unpin=False)

Pin or unpin a message in a chat.

Parameters:

Name Type Description Default
stream_id (int, str)

ID of the stream in base 10 or 36.

 required
message int

Converting this to int must return a chat message ID.

 required
unpin bool

If true, unpins a message instead of pinning it.

 False
Source code in cocorum/servicephp.py 
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
def chat_pin(self, stream_id, message, unpin: bool = False):
    """Pin or unpin a message in a chat.

Args:
    stream_id (int, str): ID of the stream in base 10 or 36.
    message (int): Converting this to int must return a chat message ID.
    unpin (bool): If true, unpins a message instead of pinning it.
    """

    self.sphp_request(
        f"chat.message.{"un" * unpin}pin",
        data = {
            "video_id": utils.ensure_b10(stream_id),
            "message_id": int(message),
            },
        )

comment_add(video_id, comment, reply_id=0)

Post a comment on a video.

Parameters:

Name Type Description Default
video_id (int, str)

The numeric ID of a video / stream in base 10 or 36.

 required
comment str

What to say.

 required
reply_id int

The ID of the comment to reply to. Defaults to zero (don't reply to anybody).

 0

Returns:

Name Type Description
Comment APIComment

The comment, as parsed from the response data.
Source code in cocorum/servicephp.py 
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
def comment_add(self, video_id, comment: str, reply_id: int = 0):
    """Post a comment on a video.

Args:
    video_id (int, str): The numeric ID of a video / stream in base 10 or 36.
    comment (str): What to say.
    reply_id (int): The ID of the comment to reply to.
        Defaults to zero (don't reply to anybody).

Returns:
    Comment (APIComment): The comment, as parsed from the response data.
    """

    r = self.sphp_request(
            "comment.add",
            data = {
                "video": int(utils.ensure_b10(video_id)),
                "reply_id": int(reply_id),
                "comment": str(comment),
                "target": "comment-create-1",
                },
            )
    return APIComment(r.json()["data"], self)

comment_delete(comment_id)

Delete a comment by ID.

Parameters:

Name Type Description Default
comment_id int

The numeric ID of the comment to delete.

 required
Source code in cocorum/servicephp.py 
545
546
547
548
549
550
551
552
553
554
555
def comment_delete(self, comment_id: int):
    """Delete a comment by ID.

Args:
    comment_id (int): The numeric ID of the comment to delete.
    """

    self.sphp_request(
        "comment.delete",
        data = {"comment_id": int(comment_id)},
        )

comment_list(video_id)

Get the list of comments under a video.

Parameters:

Name Type Description Default
video_id (str, int)

The numeric ID of a video in base 10 or 36.

 required

Returns:

Name Type Description
Comments list

A list of scraping.HTMLComment objects.
Source code in cocorum/servicephp.py 
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
def comment_list(self, video_id):
    """Get the list of comments under a video.

Args:
    video_id (str, int): The numeric ID of a video in base 10 or 36.

Returns:
    Comments (list): A list of scraping.HTMLComment objects.
    """

    r = self.sphp_request(
        "comment.list",
        additional_params = {
            "video" : utils.ensure_b36(video_id),
            },
        method = "GET",
        )
    soup = bs4.BeautifulSoup(r.json()["html"], features = "html.parser")
    comment_elems = soup.find_all(self._is_comment_elem)
    return [scraping.HTMLComment(e, self) for e in comment_elems]

comment_pin(comment_id, unpin=False)

Pin or unpin a comment by ID.

Parameters:

Name Type Description Default
comment_id int

The numeric ID of the comment to pin/unpin.

 required
unpin bool

If true, unpins instead of pinning comment.

 False
Source code in cocorum/servicephp.py 
532
533
534
535
536
537
538
539
540
541
542
543
def comment_pin(self, comment_id: int, unpin: bool = False):
    """Pin or unpin a comment by ID.

Args:
    comment_id (int): The numeric ID of the comment to pin/unpin.
    unpin (bool): If true, unpins instead of pinning comment.
    """

    self.sphp_request(
        f"comment.{"un" * unpin}pin",
        data = {"comment_id": int(comment_id)},
        )

comment_restore(comment_id)

Restore a deleted comment by ID.

Parameters:

Name Type Description Default
comment_id int

The numeric ID of the comment to restore.

 required
Source code in cocorum/servicephp.py 
557
558
559
560
561
562
563
564
565
566
567
568
def comment_restore(self, comment_id: int):
    """Restore a deleted comment by ID.

Args:
    comment_id (int): The numeric ID of the comment to restore.
    """

    r = self.sphp_request(
        "comment.restore",
        data = {"comment_id": int(comment_id)},
        )
    return APIComment(r.json()["data"], self)

get_video_url(video_id)

Get the URL of a Rumble video.

Parameters:

Name Type Description Default
video_id (int, str)

The numeric ID of the video.

 required

Returns:

Name Type Description
URL str

The URL of the video.
Source code in cocorum/servicephp.py 
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
def get_video_url(self, video_id):
    """Get the URL of a Rumble video.

Args:
    video_id (int, str): The numeric ID of the video.

Returns:
    URL (str): The URL of the video.
    """

    r = self.sphp_request(
        "media.share",
        additional_params = {
            "video" : utils.ensure_b36(video_id),
            "start" : 0,
            },
        method = "GET",
        )
    soup = bs4.BeautifulSoup(r.json()["html"], features = "html.parser")
    elem = soup.find("div", attrs = {"class" : "fb-share-button share-fb"})
    return elem.attrs["data-url"]

login(username, password)

Log in to Rumble

Parameters:

Name Type Description Default
username str

Username to sign in with.

 required
password str

Password to sign in with.

 required

Returns:

Name Type Description
Cookie dict

Cookie dict to be passed with requests, which authenticates them.
Source code in cocorum/servicephp.py 
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
def login(self, username: str, password: str):
    """Log in to Rumble

Args:
    username (str): Username to sign in with.
    password (str): Password to sign in with.

Returns:
    Cookie (dict): Cookie dict to be passed with requests, which authenticates them.
    """

    # Get salts
    r = self.sphp_request(
            "user.get_salts",
            data = {"username": username},
            logged_in = False,
            )
    salts = r.json()["data"]["salts"]

    # Get session token
    r = self.sphp_request(
            "user.login",
            data = {
                "username": username,

                # Hash the password using the salts
                "password_hashes": ",".join(utils.calc_password_hashes(password, salts)),
                },
            logged_in = False,
            )
    j = r.json()
    session_token = j["data"]["session"]
    assert session_token, f"Login failed: No token returned\n{r.json()}"

    return {static.Misc.session_token_key: session_token}

mute_user(username, is_channel=False, video=None, duration=None, total=False)

Mute a user or channel by name.

Parameters:

Name Type Description Default
username str

The user to mute.

 required
is_channel bool

Is this a channel name rather than a username?

 False
video int

The video to mute the user on. Defaults to None.

 None
duration int

How long the user will be muted for, in seconds. Defaults to infinity.

 None
total bool

Is this a mute across all videos? Defaults to False, requires video if False.

 False
Source code in cocorum/servicephp.py 
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
def mute_user(self, username: str, is_channel: bool = False, video: int = None, duration: int = None, total: bool = False):
    """Mute a user or channel by name.

Args:
    username (str): The user to mute.
    is_channel (bool): Is this a channel name rather than a username?
    video (int): The video to mute the user on.
        Defaults to None.
    duration (int): How long the user will be muted for, in seconds.
        Defaults to infinity.
    total (bool): Is this a mute across all videos?
        Defaults to False, requires video if False.
        """

    self.sphp_request(
        "moderation.mute",
        data = {
            "user_to_mute": username,
            "entity_type": ("user", "channel")[is_channel],
            "video": int(video),
            "duration": duration,
            "type": ("video", "total")[total],
            },
        )

playlist_add(title, description='', visibility='public', channel_id=None)

Create a new playlist.

Parameters:

Name Type Description Default
title str

The title of the playlist.

 required
description str

Describe the playlist. Defaults to nothing.

 ''
visibility str

Set to public, unlisted, or private via string. Defaults to 'public'.

 'public'
channel_id (int, str)

The ID of the channel to create the playlist under. Defaults to none.

 None

Returns:

Name Type Description
Playlist APIPlaylist

The playlist as parsed from the response data.
Source code in cocorum/servicephp.py 
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
def playlist_add(self, title: str, description: str = "", visibility: str = "public", channel_id = None):
    """Create a new playlist.

Args:
    title (str): The title of the playlist.
    description (str): Describe the playlist.
        Defaults to nothing.
    visibility (str): Set to public, unlisted, or private via string.
        Defaults to 'public'.
    channel_id (int, str): The ID of the channel to create the playlist under.
        Defaults to none.

Returns:
    Playlist (APIPlaylist): The playlist as parsed from the response data.
    """

    r = self.sphp_request(
        "playlist.add",
        data = {
            "title": str(title),
            "description": str(description),
            "visibility": str(visibility),
            "channel_id": str(utils.ensure_b10(channel_id)) if channel_id else None,
        }
    )
    return APIPlaylist(r.json()["data"], self)

playlist_add_video(playlist_id, video_id)

Add a video to a playlist.

Parameters:

Name Type Description Default
playlist_id str

The numeric ID of the playlist in base 64.

 required
video_id (int, str)

The numeric ID of the video to add, in base 10 or 36.

 required
Source code in cocorum/servicephp.py 
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
def playlist_add_video(self, playlist_id: str, video_id):
    """Add a video to a playlist.

Args:
    playlist_id (str): The numeric ID of the playlist in base 64.
    video_id (int, str): The numeric ID of the video to add, in base 10 or 36.
    """

    print(self.sphp_request(
        "playlist.add_video",
        data = {
            "playlist_id": str(playlist_id),
            "video_id": utils.ensure_b10(video_id),
            }
        ).text)

playlist_delete(playlist_id)

Delete a playlist.

Parameters:

Name Type Description Default
playlist_id str

The numeric ID of the playlist to delete in base 64.

 required
Source code in cocorum/servicephp.py 
699
700
701
702
703
704
705
706
707
708
709
def playlist_delete(self, playlist_id: str):
    """Delete a playlist.

Args:
    playlist_id (str): The numeric ID of the playlist to delete in base 64.
    """

    print(self.sphp_request(
        "playlist.delete",
        data = {"playlist_id" : str(playlist_id)},
        ).text)

playlist_delete_video(playlist_id, video_id)

Remove a video from a playlist.

Parameters:

Name Type Description Default
playlist_id str

The numeric ID of the playlist in base 64.

 required
video_id (int, str)

The numeric ID of the video to remove, in base 10 or 36.

 required
Source code in cocorum/servicephp.py 
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
def playlist_delete_video(self, playlist_id: str, video_id):
    """Remove a video from a playlist.

Args:
    playlist_id (str): The numeric ID of the playlist in base 64.
    video_id (int, str): The numeric ID of the video to remove, in base 10 or 36.
    """

    print(self.sphp_request(
        "playlist.delete_video",
        data = {
            "playlist_id": str(playlist_id),
            "video_id": utils.ensure_b10(video_id),
            }
        ).text)

playlist_edit(playlist_id, title, description='', visibility='public', channel_id=None)

Edit the details of an existing playlist

Parameters:

Name Type Description Default
playlist_id str

The numeric ID of the playlist to edit in base 64.

 required
title str

The title of the playlist.

 required
description str

Describe the playlist. Defaults to nothing.

 ''
visibility str

Set to public, unlisted, or private via string. Defaults to 'public'.

 'public'
channel_id (int, str)

The ID of the channel to have the playlist under. Defaults to none.

 None

Returns:

Name Type Description
Playlist APIPlaylist

The playlist as parsed from the response data.
Source code in cocorum/servicephp.py 
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
def playlist_edit(self, playlist_id: str, title: str, description: str = "", visibility: str = "public", channel_id = None):
    """Edit the details of an existing playlist

Args:
    playlist_id (str): The numeric ID of the playlist to edit in base 64.
    title (str): The title of the playlist.
    description (str): Describe the playlist.
        Defaults to nothing.
    visibility (str): Set to public, unlisted, or private via string.
        Defaults to 'public'.
    channel_id (int, str): The ID of the channel to have the playlist under.
        Defaults to none.

Returns:
    Playlist (APIPlaylist): The playlist as parsed from the response data.
    """

    r = self.sphp_request(
        "playlist.edit",
        data = {
            "title": str(title),
            "description": str(description),
            "visibility": str(visibility),
            "channel_id": str(utils.ensure_b10(channel_id)) if channel_id else None,
            "playlist_id": str(playlist_id),
        }
    )
    return APIPlaylist(r.json()["data"], self)

raid_confirm(stream_id)

Confirm a raid, previously set up by command.

Parameters:

Name Type Description Default
stream_id (int, str)

The numeric ID of the stream to confirm the raid from, in base 10 or 36.

 required
Source code in cocorum/servicephp.py 
711
712
713
714
715
716
717
718
719
720
721
def raid_confirm(self, stream_id):
    """Confirm a raid, previously set up by command.

Args:
    stream_id (int, str): The numeric ID of the stream to confirm the raid from, in base 10 or 36.
    """

    self.sphp_request(
        "raid.confirm",
        data = {"video_id" : utils.ensure_b10(stream_id)},
        )

rumbles(vote, item_id, item_type)

Post a like or dislike.

Parameters:

Name Type Description Default
vote int

-1, 0, or 1 (0 means clear vote).

 required
item_id int

The numeric ID of whatever we are liking or disliking.

 required
item_type int

1 for video, 2 for comment.

 required
Source code in cocorum/servicephp.py 
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
def rumbles(self, vote: int, item_id, item_type: int):
    """Post a like or dislike.

Args:
    vote (int): -1, 0, or 1 (0 means clear vote).
    item_id (int): The numeric ID of whatever we are liking or disliking.
    item_type (int): 1 for video, 2 for comment.
    """

    r = self.sphp_request(
        "user.rumbles",
        data = {
            "type" : int(item_type),
            "id" : utils.ensure_b10(item_id),
            "vote" : int(vote),
            },
        )
    return APIContentVotes(r.json()["data"])

sphp_request(service_name, data={}, additional_params={}, logged_in=True, method='POST')

Make a request to Service.PHP with common settings service_name: The name parameter of the specific PHP service data: Form data additional_params: Any additional query string parameters logged_in: The request should use the session cookie

Source code in cocorum/servicephp.py 
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
def sphp_request(self, service_name: str, data: dict = {}, additional_params: dict = {}, logged_in = True, method = "POST"):
    """Make a request to Service.PHP with common settings
    service_name: The name parameter of the specific PHP service
    data: Form data
    additional_params: Any additional query string parameters
    logged_in: The request should use the session cookie"""
    params = {"name" : service_name}
    params.update(additional_params)
    r = requests.request(
            method,
            static.URI.servicephp,
            params = params,
            data = data,
            headers = static.RequestHeaders.user_agent,
            cookies = self.session_cookie if logged_in else None,
            timeout = static.Delays.request_timeout,
            )
    assert r.status_code == 200, f"Service.PHP request for {service_name} failed: {r}\n{r.text}"
    # If the request json has a data -> success value, make sure it is True
    d = r.json().get("data")
    if isinstance(d, dict):
        assert d.get("success", True), f"Service.PHP request for {service_name} failed: \n{r.text}"
    # Data was not a dict but was not empty
    elif d:
        print(f"Service.PHP request for {service_name} did not fail but returned unknown data type {type(d)}: {d}")

    return r

unmute_user(record_id)

Unmute a user.

Parameters:

Name Type Description Default
record_id int

The numeric ID of the mute record to undo.

 required
Source code in cocorum/servicephp.py 
461
462
463
464
465
466
467
468
469
470
471
472
473
def unmute_user(self, record_id: int):
    """Unmute a user.

Args:
    record_id: The numeric ID of the mute record to undo.
    """

    self.sphp_request(
        "moderation.unmute",
        data = {
            "record_id" : record_id,
            }
        )

S.D.G.