File size: 15,325 Bytes
afbb33a |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 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 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 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 133 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 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 210 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 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 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 |
from librouteros import connect
from librouteros.query import Key
import logging
from typing import Optional
from datetime import datetime
from ..schema import *
from ..schema import UserListData
from .helperfx import PhoneValidator
from .Config import RouterConfig
from time import sleep
class MikrotikAPI:
"""Class to handle MikroTik router API operations, inherits VPNManager."""
def __init__(
self,
config: RouterConfig,
):
"""Initialize with router configuration and VPN configuration."""
self.config = config
self.api = None
self.logger = self._setup_logging()
self.phone_validator = PhoneValidator()
def connect(self) -> bool:
"""Establish connection to VPN and MikroTik router."""
try:
self.api = connect(
username=self.config.username,
password=self.config.password,
host=self.config.host,
port=8728,
)
self.logger.info("Successfully connected to MikroTik router.")
return True
except Exception as e:
self.logger.error(f"Failed to connect to MikroTik router: {e}")
return False
def close(self):
"""Close the router connection and disconnect VPN."""
if self.api:
self.api.close()
self.logger.info("Router connection closed.")
def add_hotspot_user(
self, phone: str, password: str, profile: str = "default"
) -> BaseResponse:
"""Add a hotspot user to the router"""
if not self.api:
return ResponseBuilder.error(
BaseResponse, "Registration failed", "Not connected to router"
)
# Validate phone number
is_valid, formatted_phone = self.phone_validator.validate_and_format(phone)
if not is_valid:
return ResponseBuilder.error(
BaseResponse,
"Registration failed",
f"Invalid phone number format: {phone}",
)
users = self.api.path("ip", "hotspot", "user")
existing_users = users.select(Key("name"))
# Check if user already exists
if any(str(user["name"]) == formatted_phone for user in existing_users):
return ResponseBuilder.error(
BaseResponse,
"Registration failed",
f"User {formatted_phone} already exists",
)
try:
# Add user to router
users.add(
name=formatted_phone,
password=password,
profile=profile,
disabled=True,
)
return ResponseBuilder.success(BaseResponse, "User registered successfully")
except Exception as e:
self.logger.error(f"Failed to add user {formatted_phone}: {e}")
return ResponseBuilder.error(BaseResponse, "Registration failed", str(e))
def login_hotspot_user(
self, phone: str, password: str, mac_address: str, ip_address: str
) -> LoginResponse:
"""Login a hotspot user"""
if not self.api:
return ResponseBuilder.error(
LoginResponse, "Login failed", "Not connected to router"
)
is_valid, formatted_phone = self.phone_validator.validate_and_format(phone)
if not is_valid:
return ResponseBuilder.error(
LoginResponse, "Login failed", f"Invalid phone number format: {phone}"
)
try:
users = self.api.path("ip", "hotspot", "user")
active = self.api.path("ip", "hotspot", "active")
# Verify if user exists and password is correct
existing_users = users.select(Key("name"), Key("password"), Key("profile"))
user_data = next(
(
user
for user in existing_users
if str(user["name"]) == formatted_phone
and user["password"] == password
),
None,
)
if not user_data:
return ResponseBuilder.error(
LoginResponse, "Login failed", "Invalid credentials"
)
# Check if already logged in
active_users = active.select(Key("user"))
if any(str(user["user"]) == formatted_phone for user in active_users):
return ResponseBuilder.error(
LoginResponse,
"Login failed",
f"User {formatted_phone} is already logged in",
)
# Perform the login
self.api.path("ip", "hotspot", "host").call(
"login",
user=formatted_phone,
password=password,
mac_address=mac_address,
ip_address=ip_address,
)
login_time = datetime.now()
return LoginResponse(
code=200, message="Login successful", login_time=login_time
)
except Exception as e:
self.logger.error(f"Login failed for {formatted_phone}: {e}")
return ResponseBuilder.error(LoginResponse, "Login failed", str(e))
def logout_hotspot_user(self, phone: str) -> LogoutResponse:
"""Logout a hotspot user"""
if not self.api:
return ResponseBuilder.error(
LogoutResponse, "Logout failed", "Not connected to router"
)
is_valid, formatted_phone = self.phone_validator.validate_and_format(phone)
if not is_valid:
return ResponseBuilder.error(
LogoutResponse, "Logout failed", f"Invalid phone number format: {phone}"
)
active = self.api.path("ip", "hotspot", "active")
try:
active_users = active.select(Key("user"), Key(".id"))
user_session = next(
(
session
for session in active_users
if str(session["user"]) == formatted_phone
),
None,
)
if not user_session:
return ResponseBuilder.error(
LogoutResponse,
"Logout failed",
f"User {formatted_phone} is not logged in",
)
# Logout the user
active.remove(user_session[".id"])
logout_time = datetime.now()
return LogoutResponse(
code=200, message="Logout successful", logout_time=logout_time
)
except Exception as e:
self.logger.error(f"Logout failed for user {formatted_phone}: {e}")
return ResponseBuilder.error(LogoutResponse, "Logout failed", str(e))
def get_active_users(self) -> ActiveUsersResponse:
"""Get list of active hotspot users"""
if not self.api:
return ResponseBuilder.error(
ActiveUsersResponse,
"Failed to get active users",
"Not connected to router",
)
try:
active = self.api.path("ip", "hotspot", "active")
active_users = active.select(
Key("user"),
Key("uptime"),
Key("mac-address"),
Key("address"),
Key("bytes-in"),
Key("bytes-out"),
# Key("profile"),
)
users_list = [
UserSessionData(
phone=str(user["user"]),
uptime=user["uptime"],
mac_address=user["mac-address"],
ip_address=user["address"],
bytes_in=int(user["bytes-in"]),
bytes_out=int(user["bytes-out"]),
status="active",
profile=str("2mbps_profile"),
)
for user in active_users
]
print(users_list)
return ActiveUsersResponse(
code=200,
message="Active users retrieved successfully",
active_users=users_list,
)
except Exception as e:
self.logger.error(f"Failed to get active users: {e}")
return ResponseBuilder.error(
ActiveUsersResponse, "Failed to get active users", str(e)
)
def get_user_stats(self, phone: Optional[str] = None) -> UserStatsResponse:
"""Get statistics for all users or a specific user"""
if not self.api:
return ResponseBuilder.error(
UserStatsResponse,
"Failed to get user statistics",
"Not connected to router",
)
try:
users = self.api.path("ip", "hotspot", "user")
all_users = users.select(
Key("name"),
Key("profile"),
Key("disabled"),
Key("uptime"),
Key("bytes-in"),
Key("bytes-out"),
)
user_stats = [
UserStats(
phone=str(user["name"]),
profile=user.get("profile", "default"),
status=(
"disabled"
if user.get("disabled", "false") == "true"
else "enabled"
),
uptime=user.get("uptime", "0s"),
bytes_in=int(user.get("bytes-in", 0)),
bytes_out=int(user.get("bytes-out", 0)),
)
for user in all_users
if not phone or str(user["name"]) == phone
]
if phone and not user_stats:
return ResponseBuilder.error(
UserStatsResponse, "User not found", f"User {phone} does not exist"
)
return UserStatsResponse(
code=200,
message="User statistics retrieved successfully",
user_stats=user_stats,
)
except Exception as e:
self.logger.error(f"Failed to get user statistics: {e}")
return ResponseBuilder.error(
UserStatsResponse, "Failed to get user statistics", str(e)
)
# Existing initialization, connect, and other methods...
def set_user_status(self, phone: str, disabled: bool) -> UserStatusResponse:
"""Enable or disable a hotspot user."""
if not self.api:
return ResponseBuilder.error(
UserStatusResponse, "Status update failed", "Not connected to router"
)
# Validate phone number
is_valid, formatted_phone = self.phone_validator.validate_and_format(phone)
if not is_valid:
return ResponseBuilder.error(
UserStatusResponse,
"Status update failed",
f"Invalid phone number format: {phone}",
)
users = self.api.path("ip", "hotspot", "user")
try:
# Find the user
existing_users = users.select(
Key("name"),
Key(".id"),
Key("mbonea"),
)
for user in existing_users:
if str(user["name"]) == formatted_phone:
user_data = user
break
if not user_data:
return ResponseBuilder.error(
UserStatusResponse,
"Status update failed",
f"User {formatted_phone} does not exist",
)
user_id = user_data[".id"]
status_value = "true" if disabled else "false"
users.update(**{".id": user_id, "disabled": status_value})
status = "disabled" if disabled else "enabled"
self.logger.info(f"User {formatted_phone} successfully {status}")
# If disabling the user, log them out of any active session
if disabled:
self.logout_hotspot_user(formatted_phone)
return UserStatusResponse(
code=200, message=f"User successfully {status}", user_status=status
)
except Exception as e:
print(f"Failed to update status for user {formatted_phone}: {e}")
self.logger.error(
f"Failed to update status for user {formatted_phone}: {e}"
)
return ResponseBuilder.error(
UserStatusResponse, "Status update failed", str(e)
)
def activate_user(self, phone: str) -> UserStatusResponse:
"""Activate a user (set disabled to false)."""
return self.set_user_status(phone, disabled=False)
def deactivate_user(self, phone: str) -> UserStatusResponse:
"""Deactivate a user (set disabled to true and log them out)."""
return self.set_user_status(phone, disabled=True)
def get_users_list(self) -> UsersListResponse:
"""Get list of all hotspot users (both active and inactive)"""
if not self.api:
return UsersListResponse(
success=False,
message="Failed to get users list",
error="Not connected to router",
)
try:
users = self.api.path("ip", "hotspot", "user")
active = self.api.path("ip", "hotspot", "active")
# Retrieve all users
all_users = users.select(
Key("name"),
Key("profile"),
Key("disabled"),
Key("comment"),
Key("limit-bytes-total"),
Key("bytes-in"),
Key("bytes-out"),
)
# Retrieve active users to check statuses
active_users = active.select(Key("user"))
active_phones = [str(user.get("user", "")) for user in active_users]
# Format the response
users_list = []
for user in all_users:
phone_number = str(user["name"])
bytes_in = int(user.get("bytes-in", 0))
bytes_out = int(user.get("bytes-out", 0))
data_limit = (
int(user.get("limit-bytes-total", 0))
if user.get("limit-bytes-total")
else None
)
user_data = UserListData(
phoneNumber=phone_number,
profile=user.get("profile", "default"),
status="active" if phone_number in active_phones else "inactive",
disabled=user.get("disabled", "false") == "true",
comment=user.get("comment", ""),
data_limit=data_limit,
)
users_list.append(user_data)
return UsersListResponse(
code=200,
message=f"Retrieved {len(users_list)} users",
data=users,
)
except Exception as e:
return UsersListResponse(
success=False, message="Failed to get users list", error=str(e)
)
|