PNG
IHDR x sBIT|d pHYs + tEXtSoftware www.inkscape.org< ,tEXtComment
File Manager
File Manager
Viewing File: lsapi.py
# coding=utf-8
#
# Copyright © Cloud Linux GmbH & Cloud Linux Software, Inc 2010-2021 All Rights Reserved
#
# Licensed under CLOUD LINUX LICENSE AGREEMENT
# http://cloudlinux.com/docs/LICENCE.TXT
#
from dataclasses import dataclass
import os
from contextlib import contextmanager
from typing import Any, Dict, List # NOQA
from clcommon.const import Feature
from clcommon.utils import ExternalProgramFailed, is_ea4, is_litespeed_running, is_testing_enabled_repo, is_ubuntu
from cldetectlib import get_apache_modules, get_boolean_param, is_da
from clwizard.constants import MODULES_LOGS_DIR
from clwizard.exceptions import InstallationFailedException
from .base import WizardInstaller
_DA_CUSTOMBUILD = "/usr/local/directadmin/custombuild/build"
# LSAPI package naming schemes differ between normal CL and Ubuntu.
# This is why we define two sets of package names here.
@dataclass
class LsapiPackageSet:
general: List[str] # general LSAPI-related packages
general_lsapi: str # LSAPI package for systems without EA4 (not cPanel)
ea4_lsapi: str # EA4 lsapi package
cl_lsapi_set = LsapiPackageSet(
general=["liblsapi", "liblsapi-devel"],
general_lsapi="mod_lsapi",
ea4_lsapi="ea-apache24-mod_lsapi",
)
ubuntu_lsapi_set = LsapiPackageSet(
general=["liblsapi", "liblsapi-dev"],
general_lsapi="mod-lsapi",
ea4_lsapi="ea-apache24-mod-lsapi",
)
class LsapiInstaller(WizardInstaller):
LOG_FILE = os.path.join(MODULES_LOGS_DIR, "lsapi.log")
UTILITY = "/usr/bin/switch_mod_lsapi"
_REQUIRED_CL_COMPONENT_SUPPORT = Feature.LSAPI
def __init__(self):
super().__init__()
self._prepare_lsapi_packages()
self.apache_modules = get_apache_modules() or [] # type: List[str]
def _prepare_lsapi_packages(self):
package_set = ubuntu_lsapi_set if is_ubuntu() else cl_lsapi_set
self.lsapi_packages = package_set.general[:]
if is_ea4():
self.lsapi_packages.append(package_set.ea4_lsapi)
else:
self.lsapi_packages.append(package_set.general_lsapi)
def _install_lsapi_packages(self):
"""
Install lsapi packages if needed
:return: None
"""
packages_to_install = []
for package in self.lsapi_packages:
if not self._is_package_installed(package):
packages_to_install.append(package)
if packages_to_install:
try:
out = self._install_package(*packages_to_install)
except ExternalProgramFailed as err:
self.app_logger.error("Package installation failed with error: %s", str(err))
raise InstallationFailedException() from err
self.app_logger.info("Package was installed successfully: %s", out)
else:
self.app_logger.info("Skip package installation, all packages are already installed")
def _initialize_lsapi(self):
"""
Configure lsapi on base package installation.
:return: None
"""
try:
self._run_command([self.UTILITY, "--setup"])
except ExternalProgramFailed as err:
raise InstallationFailedException() from err
@contextmanager
def use_cl_beta_on_da(self, use_beta: bool):
"""
Context manager to set the option `cloudlinux_beta` in DA custombuild options.
@param use_beta: True == `cloudlinux_beta=yes`, False == `cloudlinux_beta=no`
"""
inital_state = get_boolean_param("/usr/local/directadmin/custombuild/options.conf", "cloudlinux_beta")
if use_beta and not inital_state:
self._run_command([_DA_CUSTOMBUILD, "set", "cloudlinux_beta", "yes"])
try:
yield
finally:
if use_beta and not inital_state:
self._run_command([_DA_CUSTOMBUILD, "set", "cloudlinux_beta", "no"])
def _install_lsapi_on_da(self, use_beta: bool) -> None:
"""
Configure and build lsapi on DirectAdmin.
:param use_beta: Whether to use the beta version of CloudLinux packages.
:return: None
"""
try:
with self.use_cl_beta_on_da(use_beta=use_beta):
self._run_command([_DA_CUSTOMBUILD, "update"])
self._run_command([_DA_CUSTOMBUILD, "set", "php1_mode", "lsphp"])
self._run_command([_DA_CUSTOMBUILD, "php", "n"])
self._run_command([_DA_CUSTOMBUILD, "apache"])
except ExternalProgramFailed as err:
raise InstallationFailedException() from err
def run_installation(self, options):
"""
Install the lsapi module on the system.
:return: None
"""
if is_da():
if "use_beta_for_da" in options:
use_beta_for_da = options["use_beta_for_da"]
else:
use_beta_for_da = is_testing_enabled_repo()
self._install_lsapi_on_da(use_beta_for_da)
else:
self._install_lsapi_packages()
self._initialize_lsapi()
@classmethod
def supported_options(cls):
return {"use_beta_for_da"}
def _get_warnings(self) -> List[Dict[str, str | dict[str, str]]]:
"""
Get a list of warnings that should be shown in Wizard before the module installation.
:return: List of warnings to be shown in UI.
Warning is a dictionary with the following keys and values:
- message: str - warning message with placeholders for additional context
- context: dict - additional context for the message
"""
warnings: List[Dict[str, str | dict[str, str]]] = []
if is_da():
warnings.append({"message": "Installation will be performed via DirectAdmin CustomBuild tool"})
if "suexec_module" not in self.apache_modules:
warnings.append(
{
"message": (
"mod_suexec is not installed."
" It is recommended to use mod_suexec with mod_lsapi."
" It is also required for CRIU to work."
" Please see %(url)s for more information."
),
"context": {"url": "https://docs.cloudlinux.com/apache_mod_lsapi.html"},
}
)
return warnings
def _get_blockers(self) -> List[Dict[str, str | dict[str, str]]]:
"""
Get a list of possible blockers that may disable module in Wizard UI.
:return: List of blockers to be shown in UI.
Blocker is a dictionary with the following keys and values:
- message: str - blocker message with placeholders for additional context
- context: dict - additional context for the message
"""
blockers = []
if is_litespeed_running():
blockers.append(
{
"message": "The server is running under Litespeed."
" mod_lsapi works with the Apache server only."
" Please see %(url)s for the requirements.",
"context": {"url": "https://docs.cloudlinux.com/apache_mod_lsapi.html"},
}
)
if "ruid2_module" in self.apache_modules:
blockers.append(
{
"message": "mod_ruid2 is enabled, it is not compatible with mod_lsapi."
" Please see %(url)s for the requirements.",
"context": {
"url": "https://docs.cloudlinux.com/apache_mod_lsapi.html",
},
}
)
if "mpm_itk_module" in self.apache_modules:
blockers.append(
{
"message": "MPM ITK is enabled, it is not compatible with mod_lsapi."
" Please see %(url)s for the requirements.",
"context": {
"url": "https://docs.cloudlinux.com/apache_mod_lsapi.html",
},
}
)
return blockers
def initial_status(self):
result: Dict[str, Any] = {
"already_configured": all(self._is_package_installed(pkg) for pkg in self.lsapi_packages),
}
warnings = self._get_warnings()
if warnings:
result.update({"warnings": warnings})
blockers = self._get_blockers()
if blockers:
result.update({"blockers": blockers})
return result
b IDATxytVսϓ22 A@IR :hCiZ[v*E:WũZA ^dQeQ @ !jZ'>gsV仿$|?g)&x-E IENT ; @x T.i%-X} SvS5.r/ UHz^_$-W" w)Ɗ/ @Z &IoX P$K} JzX:;` &, ŋui,e6mX
Եr Kb1ԗ) D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A D A ݀!I*]R;I2$eZ#ORZSrr 6mteffu*((Pu'v{ DIߔ4^pIm '77WEEE;vƎ 4- $]'RI{\I&G :IHJ
DWBB=\WRm
o$K(V 9 ABB.}jѢv `^?IOȅ} ڶmG }T#FJ`5 6$- ھ}FI&v;0(h; Б 38CӧOWf!; A
i:F _m9s&|q%=# wZprrrla
A & P\\СC[A#! { olF}
`E2} MK/vV )i{ 4BffV\|ۭX `b@kɶ@%i$K z5zhmX [IXZ ` 'b%$r5 M4º /l
ԃ ߖ xhʔ)[@=}
K6IM}^ 5k㏷݆z
ΗÿO:gdGBmyT/@+Vɶ纽zl.yit뭷zV 0[Y^>Wsqs}\/@$(T7f.Inݺi R$푔n.~?H))\Z RW'Mo~v
Ov6oԃ xz! S,&xm/yɞԟ?'uaSѽb, 8GלKboi&3 t7Y,)JJ c[nzӳdE&KsZLӄ I ?@ & %ӟ۶mSMMњ0 iؐSZ, |J+N
~,0A 0!5%Q-YQQa 3 }$_vVr f9f?S 8` z D A D A D A D A D A D A D A D A D A dqP,تmMmg 1V?rSI꒟]u|l
RCyEf٢9 jURbztѰ!m5~tGj2DhG*{H9)꒟ר3:(+3\?/;TUݭʴ~S6lڧUJ*i$d(#=Yݺd{,p|3B)) q:vN0Y.jkק6;SɶVzHJJЀ-utѹսk>QUU \~]fFnK?&ߡ5b=z9)^|u_k-[ y%ZNU6 7Mi:]ۦ tk[n
X(e6 Bb."8cۭ|~teuuw|ήI-5"~Uk;ZicEmN/:]M>
cQ^uiƞ??Ң pc# TUU3UakNwA`:Y_V-8.KKfRi tv*
9S6ֿj,ՃNOMߤ]z^fOh|<>@Å5 _/Iu?{SY4hK/2]4%it5q]GGe2%iR|
W&f*^]??vq[LgE_3f}Fxu~}qd-ږFxu~I N >\;͗O֊:̗WJ@ Bh W=y|GgwܷH_NY?)Tdi'?խwhlmQi !SUUsw4kӺe4rfxu-[nHtMFj}H_u~w>)oV}(T'ebʒv3_[+vn @Ȭ\S}ot}w=k HFnxg S 0eޢm~l}uqZfF oZuuEg
`zt~? b;t%>WTkķh[ 2eG8LIWx,^\thrl^Ϊ{=dž<}qV@ ⠨Wy^LF_>0UkD uʫuCs$)I v:IK; 6ֲ4{^6 եm+l 3>݆uM 9u ?>Zc }g~qhKwڭ e FMM~pМuqǿz6Tb@8 @Y|jx](^]gf}M"tG
-w.@ vOqh~/HII` S[l.6nØXL9vU cOoB\xoǤ'T&I ǍQw_wpv[kmO{w~>#=P1Pɞa-we:iǏlHo꒟f9SzH?+shk%Fs:q VhqY `jvO'ρ?PyX3lх]˾uV{ݞ]1,MzYNW~̈́ joYn}ȚF߾mS]F z+EDxm/d{F{-W-4wY듏:??_gPf
^3ecg ҵs8R2מz@TA NGj)}CNi/R~}c:5{! ZHӋӾ6}T] G]7W6^n
9*,YqOZj :P?Q D FL|?-^.Ɵ7}fFhxe2Ps cz1&5\cn[=Vn[ĶE鎀uˌd3GII k;lNmشOuuRVfBE]ۣe Ӷu
:X-[(er4~LHi6:Ѻ@ԅr ST0 trk%$Č0 ez" *z " T/X9|8.C5Feg} C Q%͞ˣJvL/? j^ h & 9xF`њZ( & yF&Iݻfg #W;3^{Wo^4'v V[[K';+mӍִ] AC @ W?1^{එyh +^]fm~iԵ] AB @WTk̏t uR?l.OIHiYyԶ] Aˀ 7c:q}ힽaf6Z~қm(+sK4{^6}T *UUu]n.:kx{:2 _m=sAߤU@? Z-Vކе z왍Nэ{|5 pڶn b
p-@sPg]0G7fy-M{GCF'%{4` =$-Ge\ eU:m+Zt'WjO!OAF @ik&t݆ϥ_
e}=]" Wz_.͜E3leW Fih|t-wZۍ-uw=6 YN {6|} | *={Ѽn.S .z1z jۻTH]흾 D uDvmvK .` V]yY~sI@t?/ϓ. m&[ " +P?MzovVЫG3- G RR[(!!\_,^%?v@ ҵő
m`Y)tem8GM x.))A]Y i`ViW`?^~! S#^+ѽGZj?Vģ 0.))AlzL*]OXrY `DBBLOj{-MH'ii-ϰ ok7^
)쭡b]UXSְmռY|5 *cֽk0B7镹%ڽP# 8nȎq}mJr23_>lE5$iwui+ H~F`IjƵ@q
\ @#qG 0" . 0" l ` . 0! , AQHN6qzkKJ#o;`Xv2>,tێJJ7Z/*A .@fفjMzkg @TvZH3Zxu6Ra'%O?/d Q5x YkU]Rֽkق@ DaS^RSּ5|BeHNN͘p
HvcYcC5:y
#`οb; z2 .!kr}gUWkyZn=f Pvsn3p~;4p˚=ē~NmI] ¾ 0lH[_L hs h_ ғߤc_њe c) g 7VIZ5 yrgk̞W#IjӪv>՞y睝M8[ |]\շ 8M 6%|@P ZڨI-m>=k= 'aiRo-x?>Q. }`Ȏ:Wsmu u >
.@,&;+!!˱tﭧD QwRW\vF\~Q7>sp Yw$%A~;~}6 ¾ g &if_=j,v+U L1(tW ake:@Ș>j$Gq2t7S?vL|]u/ .(0 E 6Mk6hiۺzښOrifޱxm/Gx> Lal%%~{lBsR4* }{0Z/ tNIɚpV ^# Lf:u@k#RSu
=S^ZyuR/.@n&z~B=0eg뺆#,Þ[ B/?H uUf7y
Wy}Bwegל`Wh(||`l`.;Ws?V@" c:iɍL֯PGv6zctM̠':wuW;d=;EveD}9J@ B(0iհ bvP1{\P&G7DIy_$-Q jm~Yrr&]CDv%bh|Yzni _ R ;kg}nJOIIwy uL}{ЌNj}:+3Y?:WJ/N+Rzd=hb;dj͒suݔ@NKMԄ jqzC5 @y°hL m;*5ezᕏ=ep
XL n?מ:r`۵tŤZ|1v`V뽧_csج'ߤ%oTuumk%%%h)uy]Nk[n
'b2 l.=͜E%gf$[c;s:V-͞WߤWh-j7]4=F-X]>ZLSi[Y*We; Zan(Ӈ W|e(HNNP5[=
r4tP
&0< pc# `vTNV
GFqvTi * Tyam$ߏWyE* VJKMTfFw >'$-ؽ.Ho.8c"@ D A D A D A D A D A D A D A D A D A~j*֘, N;Pi3599h=g oض L giJ5փy~}&Zd9 p֚
e:|hL``b/d9 p? fgg+%%hMg Xosج, ΩOl0Zh=x djL mhݻo O [g_l, 8a]٭+ӧ0 $I] c]:粹:Teꢢ"5a^Kgh,&= =՟ ^߶ߢE ܹS J}I%:8
IDAT~,9/ʃ PW'Mo }zNƍ쨓zPb NZ~^z=4mswg;5 Y~SVMR XUյڱRf?s:w
; 6H:º i 5 -maM &O3; 1IKeam Zh͛7+##v+c ~u~ca] GnF'ټL~ PPPbn
v oC 4R,ӟgg %hq} @#M4IÇ Oy^xM Zx
) yO w @HkN˖-Sǎ mb]X@n+i͖ !++K3gd\$mt$^ YfJ \8PRF )77Wא!Cl $i: @@_oG I{$# 8磌ŋ9 1A (Im7 ֭>}ߴJq7ޗt^ -[ԩSj*}%]&'
- ɓ'ꫯVzzvB#; a
7@GxI{jƌ.LÇWBB7 `O"I$ /@R @ eee@۷ >}0 ,ɒ2$53Xs|cS~r pTYYY} k Hc %&k.], @ A D A D A D A D A D A D A D A D A @lT<%''*Lo^={رc5h %$+CnܸQ3fҥK}vUVVs9G
R,_{ xˇ3 o߾;TTTd}馛]uuuG~iԩ@4 bnvmvfϞ /Peeeq}}z a
I~,誫{UWW뮻}_~YƍSMMMYχ ֝waw \ ď cxꩧtEƍկ_?۷5@u ?1kNׯWzz/wy>}zj3 k (ٺu q_Zvf̘:~ AB Q&r| ! %KҥKg Ԟ={<_X-z ! CyFUUz~ AB QIIIjݺW $ UXXDٳZ~ AB QƍecW $<(~<RSSvZujjjԧO ZQu@4 8m&&&jԩg $ ď 1h ͟?_{768@ g
=@ `)))5o6m 3 ) ѣƌJ;wҿUTT /KZR{~a=@ 0o<*狔iFɶ[ˎ ;T]] OX@ ?K.ۈxN p p p p p p p p p p p p p p p p pP fl߾] ,{ｧk۶mڿo5 BTӦMӴiӴ|r D B2e |An!D y'tkΝ[A $***t5'
" !駟oaD nΝ:t֭[gD ШQ0 6qD;@ x M6v( PiizmZ 4ew" @ ̴ixf [~-F ٱc&IZ 2|n!?$ @{[HTɏ #@h Ȏ I# _m (F /6Z3 z'\r, r!;w2Z3j=~G Y 7"I$i I. p_" ? p N` y D D ?: _ G ÿa b7 J ! Bx @0 Bo
cG @`1C [ @0G
@`0C _ u V1 aC X > W ` | `! < S `" <. `# c `? cA C 4
? c p# ~ @0 ?: 0 8& _ M Q1 J h# ? /` 7; I q 7 a w Q A 1 H p
! #< 8/# @1Ul7 =S=K.4Z?E _$i@ ! 1!E 4? ` P_ @B ă 1 0# : " aU,xb F Y1
[n |n
#' v EH:`x b
# v D 4 Y hi.i& EΖv# O H 4IŶ}:Ik h @tZRF # (tXҙzZ ? I3l7 q@õ|ۍ 1,GpuY Ꮿ@ hJv# x xk$
v# 9 5 }_$ c S#=+"K {F*m7`# %H:NRS p6I?sIՖ{Ap$I$I:QRv2$Z @UJ*$]<FO4 IENDB`